@hairy/react-lib 1.35.0 → 1.36.0

package/dist/index.cjs

@@ -704,6 +704,13 @@ function setupStatus($actions, $status) {
 // src/storage/defineStoreAsync.ts
 var import_utils12 = require("valtio/utils");
 function defineStoreAsync(fetch, options = {}) {
+  let persist;
+  if (typeof options.persist === "string") {
+    persist = { id: options.persist, pick: ["value"] };
+  }
+  if (typeof options.persist === "object") {
+    persist = { ...options.persist, pick: ["value"] };
+  }
   const store = defineStore(
     {
       state: () => ({
@@ -713,18 +720,18 @@ function defineStoreAsync(fetch, options = {}) {
         finished: false
       }),
       actions: {
-        async fetch(...args) {
+        async refetch(...args) {
           return this.value = await fetch(...args);
         },
-        refresh(value) {
+        reset(value) {
           this.value = value || options.initial;
         }
       }
     },
-    { persist: options.persist ? { id: options.persist, pick: ["value"] } : void 0 }
+    { persist }
   );
   (0, import_utils12.watch)((get) => {
-    const status = get(store.$status.fetch);
+    const status = get(store.$status.refetch);
     store.$state.error = status.error;
     store.$state.loading = status.loading;
     store.$state.finished = status.finished;

package/dist/index.d.ts

@@ -256,37 +256,70 @@ type Store<S, A extends Actions<S>, G extends Getters<S>> = {
     $signal: StoreSignal<S, A, G>;
 } & ActionsOmitThisParameter<A>;
 
+/**
+ * @description Define a store
+ * @example
+ * ```tsx
+ * const store = defineStore({
+ *   state: () => ({ count: 0 }),
+ *   actions: {
+ *     increment() {
+ *       this.count++
+ *     },
+ *   },
+ * })
+ *
+ * store.increment()
+ * console.log(store.$state.count) // 1
+ *
+ * function Component() {
+ *   const store = useStore(store)
+ *   return (
+ *     <div>
+ *       <button onClick={store.increment}>Increment</button>
+ *       <div>{store.count}</div>
+ *     </div>
+ *   )
+ * }
+ *
+ * ```
+ */
 declare function defineStore<S extends object, A extends Actions<S>, G extends Getters<S>>(store: StoreDefine<S, A, G>, options?: StoreOptions): Store<S, A, G>;
 
+type StoreAsyncInitial<T extends AnyFn> = ReturnType<T> extends Promise<infer U> ? U : ReturnType<T>;
 interface StoreAsyncOptions<T extends AnyFn> {
-    initial?: ReturnType<T> extends Promise<infer U> ? U : undefined;
-    persist?: string;
+    initial?: StoreAsyncInitial<T>;
+    persist?: string | Omit<PersistantOptions, 'pick'> | undefined;
     immediate?: boolean;
 }
-declare function defineStoreAsync<T extends AnyFn>(fetch: T, options?: StoreAsyncOptions<T>): Store<{
-    value: (ReturnType<T> extends Promise<infer U> ? U : undefined) | undefined;
+interface StoreAsyncInitialOptions<T extends AnyFn> extends StoreAsyncOptions<T> {
+    initial: StoreAsyncInitial<T>;
+}
+type StoreAsync<T extends AnyFn, Initial = StoreAsyncInitial<T> | undefined> = Store<{
+    value: Initial;
     error: Error | null | undefined;
     loading: boolean;
     finished: boolean;
 }, {
-    fetch(this: {
-        value: (ReturnType<T> extends Promise<infer U> ? U : undefined) | undefined;
-        error: Error | null | undefined;
-        loading: boolean;
-        finished: boolean;
-    }, ...args: Parameters<T>): Promise<any>;
-    refresh(this: {
-        value: (ReturnType<T> extends Promise<infer U> ? U : undefined) | undefined;
-        error: Error | null | undefined;
-        loading: boolean;
-        finished: boolean;
-    }, value?: (ReturnType<T> extends Promise<infer U_1> ? U_1 : undefined)): void;
-}, Getters<{
-    value: (ReturnType<T> extends Promise<infer U> ? U : undefined) | undefined;
-    error: Error | null | undefined;
-    loading: boolean;
-    finished: boolean;
-}>>;
+    refetch: (...args: Parameters<T>) => ReturnType<T>;
+    reset: (value?: StoreAsyncInitial<T>) => void;
+}, {}>;
+/**
+ * @description Define a store async
+ * @example
+ * ```tsx
+ * const store = defineStoreAsync(
+ *   () => fetch('https://api.example.com/data').then(response => response.json()),
+ *   {
+ *     initial: [],
+ *     // data will be obtained immediately upon defining the store
+ *     immediate: true,
+ *   },
+ * )
+ * ```
+ */
+declare function defineStoreAsync<T extends AnyFn>(fetch: T, options: StoreAsyncInitialOptions<T>): StoreAsync<T, StoreAsyncInitial<T>>;
+declare function defineStoreAsync<T extends AnyFn>(fetch: T, options?: StoreAsyncOptions<T>): StoreAsync<T>;
 /**
  * @deprecated
  * use defineStoreAsync instead
@@ -299,4 +332,4 @@ declare function useStore<S extends object, A extends Actions<S>, G extends Gett
 
 type PropsWithDetailedHTML<T = HTMLDivElement> = DetailedHTMLProps<HTMLAttributes<T>, T>;
 
-export { type Argument, type ArgumentArray, Case, type CaseProps, Default, type DefaultProps, Else, type ElseProps, type EventBusListener, type Exposer, type FetchRequestInterceptCallback, type FetchResponseInterceptCallback, If, type IfProps, type InjectComponent, Injector, type InjectorProps, type Mapping, type PersistantOptions, type PropsWithDetailedHTML, type ReadonlyArgumentArray, type StoreAsyncOptions, Switch, type SwitchProps, Then, type ThenProps, Trigger, Unless, type UnlessProps, type UseAsyncStateOptions, type UseWatchCallback, type UseWatchOptions, type Value, type WrapperProps, type WrapperTag, cls, defienAsyncStore, defineStore, defineStoreAsync, proxyWithPersistant, track, tryUseCallback, tryUseEffect, tryUseInsertionEffect, tryUseReducer, tryUseRef, tryUseState, tryUseUpdate, useAsyncCallback, useAsyncState, useDebounce, useEventBus, useFetchRequestIntercept, useFetchResponseIntercept, useMounted, useStatus, useStore, useUpdate, useWatch, useWhenever, wrapper };
+export { type Argument, type ArgumentArray, Case, type CaseProps, Default, type DefaultProps, Else, type ElseProps, type EventBusListener, type Exposer, type FetchRequestInterceptCallback, type FetchResponseInterceptCallback, If, type IfProps, type InjectComponent, Injector, type InjectorProps, type Mapping, type PersistantOptions, type PropsWithDetailedHTML, type ReadonlyArgumentArray, type StoreAsync, type StoreAsyncInitial, type StoreAsyncInitialOptions, type StoreAsyncOptions, Switch, type SwitchProps, Then, type ThenProps, Trigger, Unless, type UnlessProps, type UseAsyncStateOptions, type UseWatchCallback, type UseWatchOptions, type Value, type WrapperProps, type WrapperTag, cls, defienAsyncStore, defineStore, defineStoreAsync, proxyWithPersistant, track, tryUseCallback, tryUseEffect, tryUseInsertionEffect, tryUseReducer, tryUseRef, tryUseState, tryUseUpdate, useAsyncCallback, useAsyncState, useDebounce, useEventBus, useFetchRequestIntercept, useFetchResponseIntercept, useMounted, useStatus, useStore, useUpdate, useWatch, useWhenever, wrapper };

package/dist/index.global.js

@@ -1431,6 +1431,13 @@ var LibReact = (() => {
 
   // src/storage/defineStoreAsync.ts
   function defineStoreAsync(fetch, options = {}) {
+    let persist;
+    if (typeof options.persist === "string") {
+      persist = { id: options.persist, pick: ["value"] };
+    }
+    if (typeof options.persist === "object") {
+      persist = { ...options.persist, pick: ["value"] };
+    }
     const store = defineStore(
       {
         state: () => ({
@@ -1440,18 +1447,18 @@ var LibReact = (() => {
           finished: false
         }),
         actions: {
-          async fetch(...args) {
+          async refetch(...args) {
             return this.value = await fetch(...args);
           },
-          refresh(value) {
+          reset(value) {
             this.value = value || options.initial;
           }
         }
       },
-      { persist: options.persist ? { id: options.persist, pick: ["value"] } : void 0 }
+      { persist }
     );
     watch((get) => {
-      const status = get(store.$status.fetch);
+      const status = get(store.$status.refetch);
       store.$state.error = status.error;
       store.$state.loading = status.loading;
       store.$state.finished = status.finished;

package/dist/index.js

@@ -634,6 +634,13 @@ function setupStatus($actions, $status) {
 // src/storage/defineStoreAsync.ts
 import { watch } from "valtio/utils";
 function defineStoreAsync(fetch, options = {}) {
+  let persist;
+  if (typeof options.persist === "string") {
+    persist = { id: options.persist, pick: ["value"] };
+  }
+  if (typeof options.persist === "object") {
+    persist = { ...options.persist, pick: ["value"] };
+  }
   const store = defineStore(
     {
       state: () => ({
@@ -643,18 +650,18 @@ function defineStoreAsync(fetch, options = {}) {
         finished: false
       }),
       actions: {
-        async fetch(...args) {
+        async refetch(...args) {
           return this.value = await fetch(...args);
         },
-        refresh(value) {
+        reset(value) {
           this.value = value || options.initial;
         }
       }
     },
-    { persist: options.persist ? { id: options.persist, pick: ["value"] } : void 0 }
+    { persist }
   );
   watch((get) => {
-    const status = get(store.$status.fetch);
+    const status = get(store.$status.refetch);
     store.$state.error = status.error;
     store.$state.loading = status.loading;
     store.$state.finished = status.finished;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hairy/react-lib",
   "type": "module",
-  "version": "1.35.0",
+  "version": "1.36.0",
   "description": "Library for react",
   "author": "Hairyf <wwu710632@gmail.com>",
   "license": "MIT",
@@ -38,7 +38,7 @@
     "react-dom": "^19.1.0",
     "react-i18next": "^14.1.2",
     "react-use": "^17.6.0",
-    "@hairy/utils": "1.35.0"
+    "@hairy/utils": "1.36.0"
   },
   "scripts": {
     "build": "tsup",