define-zustand 3.0.3 → 3.1.0

package/README.md

@@ -0,0 +1,66 @@
+# define-zustand
+
+> Quickly define [zustand](https://github.com/pmndrs/zustand) state
+
+## Install
+
+```shell
+pnpm i define-zustand
+npm i define-zustand
+```
+
+## Use
+
+```tsx
+import { defineStore, defineContext, defineStateFactory } from 'define-zustand'
+
+const stateFatory = defineStateFactory({
+    state: () => ({
+        a: 1,
+        b: 1
+    }),
+    action: () => ({}),
+    getter: {
+        count: state => state.a + state.b
+    }
+}) 
+/**
+ * @return zustand hooks
+ */
+const useStore = defineStore(stateFatory())
+const { Provider, useContext } = defineContext(stateFatory())
+
+function Child() {
+    const count = useContext(state => state.count)
+    return <div>{count}</div>
+}
+function ReactComponent() {
+    const count = useStore(state => state.count)
+    const setState = useStore(state => state.setState)
+    const reset = useStore(state => state.reset)
+
+    useEffect(() => {
+        return () => {
+            reset()
+        }
+    }, [])
+
+    return (
+        <Provider>
+            <div>
+                <button onClick={() => setState({ a: 2 })}>setA</button>
+                <button
+                    onClick={() =>
+                        setState(state => {
+                            state.b += 1
+                        })
+                    }>
+                    setB
+                </button>
+                <div>{count}</div>
+            </div>
+            <Child />
+        </Provider>
+    )
+}
+```

package/dist/index.js

@@ -1 +1 @@
-export { creator, defineContext, defineStore } from './utils.js';
+export { creator, defineContext, defineStateFactory, defineStore } from './utils.js';

package/dist/utils.d.ts

@@ -1,11 +1,12 @@
 import { FunctionComponent, ReactNode } from 'react';
 import { StateCreator } from 'zustand';
 import { defGetterStateType, optionsType, ExtraGetterState, insideActionsType } from './types';
-export declare function creator<S extends Record<string, any>, G extends defGetterStateType<S>, OptionActions extends Record<string, any>>(options: optionsType<S, G, OptionActions>): StateCreator<S & ExtraGetterState<S, G> & insideActionsType<S>>;
-export declare function defineStore<S extends Record<string, any>, G extends defGetterStateType<S>, OptionActions extends Record<string, any>>(options: optionsType<S, G, OptionActions>): import("zustand").UseBoundStore<import("zustand").StoreApi<S & ExtraGetterState<S, G> & insideActionsType<S>>>;
+export declare function defineStateFactory<Options extends optionsType<any, any, any>>(options: Options): () => Options;
+export declare function creator<S extends Record<string, any>, G extends defGetterStateType<S>, OptionActions extends Record<string, any>>(options: optionsType<S, G, OptionActions>): StateCreator<S & ExtraGetterState<S, G> & insideActionsType<S> & OptionActions>;
+export declare function defineStore<S extends Record<string, any>, G extends defGetterStateType<S>, OptionActions extends Record<string, any>>(options: optionsType<S, G, OptionActions>): import("zustand").UseBoundStore<import("zustand").StoreApi<S & ExtraGetterState<S, G> & insideActionsType<S> & OptionActions>>;
 export declare function defineContext<S extends Record<string, any>, G extends defGetterStateType<S>, OptionActions extends Record<string, any>>(options: optionsType<S, G, OptionActions>): {
     Provider: FunctionComponent<{
         children?: ReactNode;
     }>;
-    useContext: <T>(selector: (state: S & ExtraGetterState<S, G> & insideActionsType<S>) => T) => T;
+    useContext: <T>(selector: (state: S & ExtraGetterState<S, G> & insideActionsType<S> & OptionActions) => T) => T;
 };

package/dist/utils.js

@@ -4,6 +4,9 @@ import { produce } from 'immer';
 import { keys, isEqualWith, omit, some, pick, forEach, isEqual } from 'lodash-es';
 import { jsx } from 'react/jsx-runtime';
 
+function defineStateFactory(options) {
+  return () => options;
+}
 function creator(options) {
   function createDefState() {
     const state = options.state();
@@ -77,4 +80,4 @@ function defineContext(options) {
   };
 }
 
-export { creator, defineContext, defineStore };
+export { creator, defineContext, defineStateFactory, defineStore };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "define-zustand",
-  "version": "3.0.3",
+  "version": "3.1.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",