@ahoo-wang/fetcher-react 3.6.1 → 3.6.2

package/dist/core/useQuery.d.ts

@@ -1,16 +1,14 @@
-import { UseExecutePromiseReturn, UseExecutePromiseOptions } from './index';
+import { UseExecutePromiseReturn, UseExecutePromiseOptions, QueryOptions } from './index';
 import { AttributesCapable, FetcherError } from '@ahoo-wang/fetcher';
 import { UseQueryStateReturn } from './useQueryState';
-import { AutoExecuteCapable, DepsCapable } from '../types';
+import { AutoExecuteCapable } from '../types';
 /**
  * Configuration options for the useQuery hook
  * @template Q - The type of the query parameters
  * @template R - The type of the result value
  * @template E - The type of the error value
  */
-export interface UseQueryOptions<Q, R, E = FetcherError> extends UseExecutePromiseOptions<R, E>, AttributesCapable, AutoExecuteCapable, DepsCapable {
-    /** The initial query parameters */
-    initialQuery: Q;
+export interface UseQueryOptions<Q, R, E = FetcherError> extends UseExecutePromiseOptions<R, E>, QueryOptions<Q>, AttributesCapable, AutoExecuteCapable {
     /** Function to execute the query with given parameters and optional attributes */
     execute: (query: Q, attributes?: Record<string, any>, abortController?: AbortController) => Promise<R>;
 }

package/dist/core/useQuery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useQuery.d.ts","sourceRoot":"","sources":["../../src/core/useQuery.ts"],"names":[],"mappings":"AAaA,OAAO,EAGL,uBAAuB,EACvB,wBAAwB,EAEzB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,EAAiB,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,CACrD,SAAQ,wBAAwB,CAAC,CAAC,EAAE,CAAC,CAAC,EACpC,iBAAiB,EACjB,kBAAkB,EAAE,WAAW;IACjC,mCAAmC;IACnC,YAAY,EAAE,CAAC,CAAC;IAEhB,kFAAkF;IAClF,OAAO,EAAE,CACP,KAAK,EAAE,CAAC,EACR,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAChC,eAAe,CAAC,EAAE,eAAe,KAC9B,OAAO,CAAC,CAAC,CAAC,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAC7B,CAAC,EACD,CAAC,EACD,CAAC,GAAG,YAAY,CAChB,SAAQ,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAC7D,4DAA4D;IAC5D,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAGD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,EAC7C,OAAO,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAChC,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CA+DzB"}
+{"version":3,"file":"useQuery.d.ts","sourceRoot":"","sources":["../../src/core/useQuery.ts"],"names":[],"mappings":"AAaA,OAAO,EAGL,uBAAuB,EACvB,wBAAwB,EACP,YAAY,EAC9B,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,EAAiB,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,CACrD,SAAQ,wBAAwB,CAAC,CAAC,EAAE,CAAC,CAAC,EACpC,YAAY,CAAC,CAAC,CAAC,EACf,iBAAiB,EACjB,kBAAkB;IAEpB,kFAAkF;IAClF,OAAO,EAAE,CACP,KAAK,EAAE,CAAC,EACR,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAChC,eAAe,CAAC,EAAE,eAAe,KAC9B,OAAO,CAAC,CAAC,CAAC,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAC7B,CAAC,EACD,CAAC,EACD,CAAC,GAAG,YAAY,CAChB,SAAQ,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAC7D,4DAA4D;IAC5D,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAGD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,EAC7C,OAAO,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAChC,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CA+DzB"}

package/dist/core/useQueryState.d.ts

@@ -1,11 +1,15 @@
-import { AutoExecuteCapable, DepsCapable } from '../types';
+import { AutoExecuteCapable } from '../types';
+export interface QueryOptions<Q> {
+    /** The initial query parameters to be stored and managed */
+    initialQuery?: Q;
+    /** The current query parameters. If provided, overrides initialQuery and updates the state. */
+    query?: Q;
+}
 /**
  * Configuration options for the useQueryState hook
  * @template Q - The type of the query parameters
  */
-export interface UseQueryStateOptions<Q> extends AutoExecuteCapable, DepsCapable {
-    /** The initial query parameters to be stored and managed */
-    initialQuery: Q;
+export interface UseQueryStateOptions<Q> extends QueryOptions<Q>, AutoExecuteCapable {
     /** Function to execute with the current query parameters. Called when autoExecute is true */
     execute: (query: Q) => Promise<void>;
 }
@@ -26,9 +30,15 @@ export interface UseQueryStateReturn<Q> {
  * getting and setting the current query, and optionally automatically executing
  * queries when the query changes or on component mount.
  *
- * @template Q - The type of the query parameters
+ * @template Q - The type of the query parameters, which can be any object type representing query data
  * @param options - Configuration options for the hook
- * @returns An object containing getQuery and setQuery functions
+ * @param options.initialQuery - Optional initial query parameters to be stored and managed. Used if no query is provided.
+ * @param options.query - Optional current query parameters. If provided, overrides initialQuery and updates the state.
+ * @param options.autoExecute - Boolean flag indicating whether to automatically execute the query on mount or when query changes. Defaults to true.
+ * @param options.execute - Function to execute with the current query parameters. Called when autoExecute is true and query changes.
+ * @returns An object containing functions to manage the query state
+ * @returns getQuery - Function that returns the current query parameters of type Q
+ * @returns setQuery - Function that updates the query parameters and triggers execution if autoExecute is enabled
  *
  * @example
  * ```typescript
@@ -65,8 +75,20 @@ export interface UseQueryStateReturn<Q> {
  * }
  * ```
  *
- * @throws This hook does not throw exceptions directly, but the execute function
- * may throw exceptions that should be handled by the caller.
+ * @example
+ * // Example with autoExecute disabled
+ * const { getQuery, setQuery } = useQueryState<UserQuery>({
+ *   initialQuery: { id: '1' },
+ *   autoExecute: false,
+ *   execute: executeQuery,
+ * });
+ *
+ * // Manually trigger execution
+ * setQuery({ id: '2' });
+ * executeQuery(getQuery());
+ *
+ * @throws {Error} Throws an error if neither initialQuery nor query is provided in the options.
+ * @throws Exceptions may also be thrown by the execute function if it encounters errors during query execution.
  */
 export declare function useQueryState<Q>(options: UseQueryStateOptions<Q>): UseQueryStateReturn<Q>;
 //# sourceMappingURL=useQueryState.d.ts.map

package/dist/core/useQueryState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useQueryState.d.ts","sourceRoot":"","sources":["../../src/core/useQueryState.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAc,MAAM,UAAU,CAAC;AAEvE;;;GAGG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,CAAE,SAAQ,kBAAkB,EAAE,WAAW;IAC9E,4DAA4D;IAC5D,YAAY,EAAE,CAAC,CAAC;IAChB,6FAA6F;IAC7F,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC;IACpC,wDAAwD;IACxD,QAAQ,EAAE,MAAM,CAAC,CAAC;IAClB,yFAAyF;IACzF,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAC/B,mBAAmB,CAAC,CAAC,CAAC,CA0BxB"}
+{"version":3,"file":"useQueryState.d.ts","sourceRoot":"","sources":["../../src/core/useQueryState.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAE9C,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,4DAA4D;IAC5D,YAAY,CAAC,EAAE,CAAC,CAAC;IACjB,+FAA+F;IAC/F,KAAK,CAAC,EAAE,CAAC,CAAC;CACX;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,CACrC,SAAQ,YAAY,CAAC,CAAC,CAAC,EAAE,kBAAkB;IAC3C,6FAA6F;IAC7F,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC;IACpC,wDAAwD;IACxD,QAAQ,EAAE,MAAM,CAAC,CAAC;IAClB,yFAAyF;IACzF,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAC/B,mBAAmB,CAAC,CAAC,CAAC,CAiCxB"}

package/dist/fetcher/useFetcherQuery.d.ts

@@ -1,18 +1,16 @@
 import { UseFetcherOptions, UseFetcherReturn } from './index';
 import { FetcherError } from '@ahoo-wang/fetcher';
-import { UseQueryStateReturn } from '../core';
-import { AutoExecuteCapable, DepsCapable } from '../types';
+import { QueryOptions, UseQueryStateReturn } from '../core';
+import { AutoExecuteCapable } from '../types';
 /**
  * Configuration options for the useFetcherQuery hook
  * @template Q - The type of the query parameters
  * @template R - The type of the result value
  * @template E - The type of the error value
  */
-export interface UseFetcherQueryOptions<Q, R, E = FetcherError> extends UseFetcherOptions<R, E>, AutoExecuteCapable, DepsCapable {
+export interface UseFetcherQueryOptions<Q, R, E = FetcherError> extends UseFetcherOptions<R, E>, QueryOptions<Q>, AutoExecuteCapable {
     /** The URL endpoint to send the POST request to */
     url: string;
-    /** The initial query parameters to be sent as the request body */
-    initialQuery: Q;
 }
 /**
  * Return type of the useFetcherQuery hook

package/dist/fetcher/useFetcherQuery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useFetcherQuery.d.ts","sourceRoot":"","sources":["../../src/fetcher/useFetcherQuery.ts"],"names":[],"mappings":"AAaA,OAAO,EAAc,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAqC,MAAM,oBAAoB,CAAC;AACrF,OAAO,EAA4B,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAExE,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,CAC5D,SAAQ,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,kBAAkB,EAAE,WAAW;IAChE,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAC;IACZ,kEAAkE;IAClE,YAAY,EAAE,CAAC,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,CAC3D,SAAQ,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC;IACtD,4DAA4D;IAC5D,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6EG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,EACpD,OAAO,EAAE,sBAAsB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GACvC,qBAAqB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CA8DhC"}
+{"version":3,"file":"useFetcherQuery.d.ts","sourceRoot":"","sources":["../../src/fetcher/useFetcherQuery.ts"],"names":[],"mappings":"AAaA,OAAO,EAAc,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAqC,MAAM,oBAAoB,CAAC;AACrF,OAAO,EAAE,YAAY,EAA4B,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAEtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,CAC5D,SAAQ,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,kBAAkB;IACpE,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,CAC3D,SAAQ,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC;IACtD,4DAA4D;IAC5D,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6EG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,YAAY,EACpD,OAAO,EAAE,sBAAsB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GACvC,qBAAqB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CA8DhC"}