Merge remote-tracking branch 'pmndrs/v5' into v5-use-sync-external-store-peer-dep

Author: charkour

.github/workflows/test-multiple-builds.yml

@@ -12,24 +12,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        build: [cjs, umd] # [cjs, esm, umd, system]
-        env: [development, production]
-        devtools-skip:
-          - CI-MATRIX-NOSKIP
-        include:
-          - devtools-skip: CI-MATRIX-[2345]
-            build: umd
-          - devtools-skip: CI-MATRIX-[1345]
-            build: umd
-          - devtools-skip: CI-MATRIX-[1245]
-            build: umd
-          - devtools-skip: CI-MATRIX-[1235]
-            build: umd
-          - devtools-skip: CI-MATRIX-[1234]
-            build: umd
-        exclude:
-          - devtools-skip: CI-MATRIX-NOSKIP
-            build: umd
+        build: [cjs, esm, umd] # [cjs, esm, umd, system]
+        env: [development] # [development, production]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
@@ -39,10 +23,6 @@ jobs:
       - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
       - run: yarn install --frozen-lockfile --check-files
       - run: yarn build
-      - name: Use React 17 for production test
-        if: ${{ matrix.env == 'production' }}
-        run: |
-          yarn add -D [email protected] [email protected] @testing-library/[email protected]
       - name: Patch for DEV-ONLY
         if: ${{ matrix.env == 'development' }}
         run: |
@@ -60,24 +40,18 @@ jobs:
       - name: Patch for ESM
         if: ${{ matrix.build == 'esm' }}
         run: |
-          sed -i~ "s/<rootDir>\/src\(.*\)\.ts/<rootDir>\/dist\/esm\1.js" package.json
+          sed -i~ "s/<rootDir>\/src\(.*\)\.ts/<rootDir>\/dist\/esm\1.js/" package.json
           sed -i~ "1s/^/import.meta.env=import.meta.env||{};import.meta.env.MODE='${NODE_ENV}';/" tests/*.tsx
         env:
           NODE_ENV: ${{ matrix.env }}
       - name: Patch for UMD (DEV)
         if: ${{ matrix.build == 'umd' && matrix.env == 'development' }}
         run: |
           sed -i~ "s/<rootDir>\/src\(.*\)\.ts/<rootDir>\/dist\/umd\1.development.js/" package.json
-          sed -i~ "s/it('\[${DEVTOOLS_SKIP}\]/it.skip('/" tests/devtools.test.tsx
-        env:
-          DEVTOOLS_SKIP: ${{ matrix.devtools-skip }}
       - name: Patch for UMD (PRD)
         if: ${{ matrix.build == 'umd' && matrix.env == 'production' }}
         run: |
           sed -i~ "s/<rootDir>\/src\(.*\)\.ts/<rootDir>\/dist\/umd\1.production.js/" package.json
-          sed -i~ "s/it('\[${DEVTOOLS_SKIP}\]/it.skip('/" tests/devtools.test.tsx
-        env:
-          DEVTOOLS_SKIP: ${{ matrix.devtools-skip }}
       - name: Patch for SystemJS
         if: ${{ matrix.build == 'system' }}
         run: |

.github/workflows/test-multiple-versions.yml

@@ -28,29 +28,11 @@ jobs:
       fail-fast: false
       matrix:
         react:
-          - 16.8.0
-          - 17.0.0
           - 18.0.0
           - 18.1.0
           - 18.2.0
           - 18.3.0-canary-6c7b41da3-20231123
           - 0.0.0-experimental-6c7b41da3-20231123
-        devtools-skip:
-          - CI-MATRIX-NOSKIP
-        include:
-          - devtools-skip: CI-MATRIX-[2345]
-            react: 16.8.0
-          - devtools-skip: CI-MATRIX-[1345]
-            react: 16.8.0
-          - devtools-skip: CI-MATRIX-[1245]
-            react: 16.8.0
-          - devtools-skip: CI-MATRIX-[1235]
-            react: 16.8.0
-          - devtools-skip: CI-MATRIX-[1234]
-            react: 16.8.0
-        exclude:
-          - devtools-skip: CI-MATRIX-NOSKIP
-            react: 16.8.0
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
@@ -59,19 +41,7 @@ jobs:
           cache: yarn
       - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
       - run: yarn install --frozen-lockfile --check-files
-      - name: Install legacy testing-library
-        if: ${{ startsWith(matrix.react, '16.') || startsWith(matrix.react, '17.') }}
-        run: yarn add -D @testing-library/[email protected]
-      - name: Patch for React 16
-        if: ${{ startsWith(matrix.react, '16.') }}
-        run: |
-          sed -i~ '1s/^/import React from "react";/' tests/*.tsx
-          sed -i~ 's/"jsx": "react-jsx"/"jsx": "react"/' tsconfig.json
-          sed -i~ 's/import\.meta\.env[?]\.MODE/"DEVELOPMENT".toLowerCase()/' src/*.ts src/*/*.ts
-          sed -i~ "s/it('\[${DEVTOOLS_SKIP}\]/it.skip('/" tests/devtools.test.tsx
-        env:
-          DEVTOOLS_SKIP: ${{ matrix.devtools-skip }}
-      - name: Test ${{ matrix.react }} ${{ matrix.devtools-skip }}
+      - name: Test ${{ matrix.react }}
         run: |
           yarn add -D react@${{ matrix.react }} react-dom@${{ matrix.react }}
           yarn test:ci

CONTRIBUTING.md

@@ -70,7 +70,7 @@ you can use this suggested workflow:
 - Create failing tests for your fix or new feature;
 - Implement your changes and confirm that all test are passing.
   You can run the tests continuously during development
-  with the `yarn test:dev` command.
+  with the `yarn test` command.
 - If you want to test it in a React project:
   - Either use `yarn link`, or
   - Use the `yalc` package.

docs/guides/typescript.md

@@ -443,15 +443,9 @@ const bearStore = createStore<BearState>()((set) => ({
 }))
 
 function useBearStore(): BearState
-function useBearStore<T>(
-  selector: (state: BearState) => T,
-  equals?: (a: T, b: T) => boolean,
-): T
-function useBearStore<T>(
-  selector?: (state: BearState) => T,
-  equals?: (a: T, b: T) => boolean,
-) {
-  return useStore(bearStore, selector!, equals)
+function useBearStore<T>(selector: (state: BearState) => T): T
+function useBearStore<T>(selector?: (state: BearState) => T) {
+  return useStore(bearStore, selector!)
 }
 ```
 
@@ -471,15 +465,13 @@ const bearStore = createStore<BearState>()((set) => ({
   increase: (by) => set((state) => ({ bears: state.bears + by })),
 }))
 
-const createBoundedUseStore = ((store) => (selector, equals) =>
-  useStore(store, selector as never, equals)) as <S extends StoreApi<unknown>>(
+const createBoundedUseStore = ((store) => (selector) => useStore(store)) as <
+  S extends StoreApi<unknown>,
+>(
   store: S,
 ) => {
   (): ExtractState<S>
-  <T>(
-    selector: (state: ExtractState<S>) => T,
-    equals?: (a: T, b: T) => boolean,
-  ): T
+  <T>(selector: (state: ExtractState<S>) => T): T
 }
 
 type ExtractState<S> = S extends { getState: () => infer X } ? X : never

docs/integrations/immer-middleware.md

@@ -125,5 +125,5 @@ Zustand will skip calling the subscriptions.
 
 ## CodeSandbox Demo
 
-- [Basic](https://codesandbox.io/s/zustand-updating-draft-states-basic-demo-zkp22g),
-- [Advanced](https://codesandbox.io/s/zustand-updating-draft-states-advanced-demo-3znqzk).
+- [Basic](https://codesandbox.io/p/sandbox/zustand-updating-draft-states-basic-demo-forked-96mkdw),
+- [Advanced](https://codesandbox.io/p/sandbox/zustand-updating-draft-states-advanced-demo-forked-phkzzg).

docs/integrations/persisting-store-data.md

@@ -630,7 +630,7 @@ export const useBoundStore = create(
 )
 ```
 
-If you're using a type that JSON.stringify() doesn't support, you'll need to write your own serialization/deserialization code. However, if this is tedious, you can use third-party libraries to serialize and deserialize different types of data.
+If you're using a type that `JSON.stringify()` doesn't support, you'll need to write your own serialization/deserialization code. However, if this is tedious, you can use third-party libraries to serialize and deserialize different types of data.
 
 For example, [Superjson](https://github.com/blitz-js/superjson) can serialize data along with its type, allowing the data to be parsed back to its original type upon deserialization
 
@@ -735,15 +735,10 @@ export const useBearStore = create<MyState>()(
 
 ### How do I use it with Map and Set
 
-With the previous persist API, you would use `serialize`/`deserialize`
-to deal with `Map` and `Set` and convert them into
-an Array so they could be parsed into proper JSON.
+In order to persist object types such as `Map` and `Set`, they will need to be converted to JSON-serializable types such as an `Array` which can be done by defining a custom `storage` engine.
 
-The new persist API has deprecated `serialize`/`deserialize`.
-
-Now, you will need to use the `storage` prop.
 Let's say your state uses `Map` to handle a list of `transactions`,
-then you can convert the Map into an Array in the storage prop:
+then you can convert the `Map` into an `Array` in the `storage` prop which is shown below:
 
 ```ts
 

package.json

@@ -134,20 +134,6 @@
         "types": "./traditional.d.ts",
         "default": "./traditional.js"
       }
-    },
-    "./context": {
-      "import": {
-        "types": "./esm/context.d.mts",
-        "default": "./esm/context.mjs"
-      },
-      "module": {
-        "types": "./esm/context.d.ts",
-        "default": "./esm/context.js"
-      },
-      "default": {
-        "types": "./context.d.ts",
-        "default": "./context.js"
-      }
     }
   },
   "sideEffects": false,
@@ -162,7 +148,6 @@
     "build:vanilla:shallow": "rollup -c --config-vanilla_shallow",
     "build:react:shallow": "rollup -c --config-react_shallow",
     "build:traditional": "rollup -c --config-traditional",
-    "build:context": "rollup -c --config-context",
     "postbuild": "yarn patch-d-ts && yarn copy && yarn patch-esm-ts",
     "prettier": "prettier \"*.{js,json,md}\" \"{examples,src,tests,docs}/**/*.{js,jsx,ts,tsx,md,mdx}\" --write",
     "prettier:ci": "prettier '*.{js,json,md}' '{examples,src,tests,docs}/**/*.{js,jsx,ts,tsx,md,mdx}' --list-different",
@@ -264,6 +249,9 @@
     "immer": {
       "optional": true
     },
+    "immer": {
+      "optional": true
+    },
     "react": {
       "optional": true
     },

rollup.config.js

@@ -78,22 +78,13 @@ function createESMConfig(input, output) {
   }
 }
 
-function createCommonJSConfig(input, output, options) {
+function createCommonJSConfig(input, output) {
   return {
     input,
     output: {
       file: `${output}.js`,
       format: 'cjs',
       esModule: false,
-      outro: options.addModuleExport
-        ? [
-            `module.exports = ${options.addModuleExport.default};`,
-            ...Object.entries(options.addModuleExport)
-              .filter(([key]) => key !== 'default')
-              .map(([key, value]) => `module.exports.${key} = ${value};`),
-            `exports.default = module.exports;`,
-          ].join('\n')
-        : '',
     },
     external,
     plugins: [
@@ -176,18 +167,7 @@ module.exports = function (args) {
   }
   return [
     ...(c === 'index' ? [createDeclarationConfig(`src/${c}.ts`, 'dist')] : []),
-    createCommonJSConfig(`src/${c}.ts`, `dist/${c}`, {
-      addModuleExport: {
-        index: {
-          default: 'react',
-          create: 'create',
-          useStore: 'useStore',
-          createStore: 'vanilla.createStore',
-        },
-        vanilla: { default: 'vanilla', createStore: 'createStore' },
-        shallow: { default: 'shallow', shallow: 'shallow$1' },
-      }[c],
-    }),
+    createCommonJSConfig(`src/${c}.ts`, `dist/${c}`),
     createESMConfig(`src/${c}.ts`, `dist/esm/${c}.js`),
     createESMConfig(`src/${c}.ts`, `dist/esm/${c}.mjs`),
     createUMDConfig(`src/${c}.ts`, `dist/umd/${c}`, 'development'),

src/context.ts

@@ -1,3 +1,2 @@
 export * from './vanilla.ts'
 export * from './react.ts'
-export { default } from './react.ts'