@ahoo-wang/fetcher-react 3.9.3 → 3.9.6

package/dist/api/createQueryApiHooks.d.ts

@@ -0,0 +1,97 @@
+import { UseQueryReturn, UseQueryOptions } from '../core';
+import { FetcherError } from '@ahoo-wang/fetcher';
+import { CreateQueryApiHooksOptions } from './createExecuteApiHooks';
+import { HookName, QueryMethod, OnBeforeExecuteCallback } from './apiHooks';
+/**
+ * Options for useApiMethodQuery hook.
+ * @template Q - The query type.
+ * @template TData - The return type of the API method (resolved).
+ * @template E - The error type.
+ */
+export interface UseApiMethodQueryOptions<Q, TData = any, E = FetcherError> extends Omit<UseQueryOptions<Q, TData, E>, 'execute'> {
+    /**
+     * Callback executed before query execution.
+     * Allows users to handle abortController and inspect/modify query parameters.
+     * Note: Query parameters can be modified in place for objects.
+     * @param abortController - The AbortController for the request.
+     * @param query - The query parameters passed to the API method (type-safe).
+     *
+     * @example
+     * onBeforeExecute: (abortController, query) => {
+     *   // query is now typed as Q
+     *   if (query && typeof query === 'object') {
+     *     query.timestamp = Date.now();
+     *   }
+     * }
+     */
+    onBeforeExecute?: OnBeforeExecuteCallback<Q>;
+}
+/**
+ * The return type of createQueryApiHooks.
+ * Creates a hook for each function method in the API object, prefixed with 'use' and capitalized.
+ * Each hook accepts query options and returns the useQuery interface with type-safe query management.
+ * @template API - The API object type.
+ * @template E - The error type for all hooks (defaults to FetcherError).
+ */
+export type QueryAPIHooks<API extends Record<string, any>, E = FetcherError> = {
+    [K in keyof API as API[K] extends QueryMethod ? HookName<string & K> : never]: API[K] extends QueryMethod<infer Q, infer R> ? (options?: UseApiMethodQueryOptions<Q, R, E>) => UseQueryReturn<Q, R, E> : never;
+};
+/**
+ * Creates type-safe React hooks for API query methods.
+ * Each API method that follows the query pattern is wrapped into a hook that extends useQuery.
+ * The generated hooks provide automatic query state management, auto-execution, and error handling.
+ *
+ * @template API - The API object type containing query methods.
+ * @param options - Configuration options including the API object.
+ * @returns An object containing hooks for each API query method.
+ *
+ * @example
+ * ```typescript
+ * // Define your API service using decorators
+ * import { api, get, post, patch, path, body, autoGeneratedError } from '@ahoo-wang/fetcher-decorator';
+ *
+ * @api('/users')
+ * class UserApi {
+ *   @get('')
+ *   getUsers(query: UserListQuery, attributes?: Record<string, any>): Promise<User[]> {
+ *     throw autoGeneratedError(query, attributes);
+ *   }
+ *
+ *   @get('/{id}')
+ *   getUser(query: { id: string }, attributes?: Record<string, any>): Promise<User> {
+ *     throw autoGeneratedError(query, attributes);
+ *   }
+ * }
+ *
+ * const apiHooks = createQueryApiHooks({ api: new UserApi() });
+ *
+ * function UserListComponent() {
+ *   const { loading, result, error, execute, setQuery, getQuery } = apiHooks.useGetUsers({
+ *     initialQuery: { page: 1, limit: 10 },
+ *     autoExecute: true,
+ *     onBeforeExecute: (abortController, query) => {
+ *       // query is fully typed as UserListQuery
+ *       console.log('Executing query:', query);
+ *     },
+ *   });
+ *
+ *   const handlePageChange = (page: number) => {
+ *     setQuery({ ...getQuery(), page }); // Automatically executes
+ *   };
+ *
+ *   if (loading) return <div>Loading...</div>;
+ *   if (error) return <div>Error: {error.message}</div>;
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={() => handlePageChange(2)}>Go to page 2</button>
+ *       {result?.map(user => (
+ *         <div key={user.id}>{user.name}</div>
+ *       ))}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+export declare function createQueryApiHooks<API extends Record<string, any>, E = FetcherError>(options: CreateQueryApiHooksOptions<API>): QueryAPIHooks<API, E>;
+//# sourceMappingURL=createQueryApiHooks.d.ts.map

package/dist/api/createQueryApiHooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createQueryApiHooks.d.ts","sourceRoot":"","sources":["../../src/api/createQueryApiHooks.ts"],"names":[],"mappings":"AAcA,OAAO,EAAY,cAAc,EAAE,eAAe,EAAa,MAAM,SAAS,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,0BAA0B,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,EAGL,QAAQ,EACR,WAAW,EACX,uBAAuB,EACxB,MAAM,YAAY,CAAC;AAEpB;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB,CACvC,CAAC,EACD,KAAK,GAAG,GAAG,EACX,CAAC,GAAG,YAAY,CAChB,SAAQ,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,SAAS,CAAC;IACrD;;;;;;;;;;;;;;OAcG;IACH,eAAe,CAAC,EAAE,uBAAuB,CAAC,CAAC,CAAC,CAAC;CAC9C;AAED;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,CAAC,GAAG,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,IAAI;KAC5E,CAAC,IAAI,MAAM,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,SAAS,WAAW,GACzC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GACpB,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GACpD,CAAC,OAAO,CAAC,EAAE,wBAAwB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GACxE,KAAK;CACV,CAAC;AAyCF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,wBAAgB,mBAAmB,CACjC,GAAG,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC/B,CAAC,GAAG,YAAY,EAChB,OAAO,EAAE,0BAA0B,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,CAAC,CAAC,CAoBjE"}

package/dist/api/index.d.ts

@@ -1,2 +1,4 @@
+export * from './apiHooks';
 export * from './createExecuteApiHooks';
+export * from './createQueryApiHooks';
 //# sourceMappingURL=index.d.ts.map

package/dist/api/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAaA,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAaA,cAAc,YAAY,CAAC;AAC3B,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC"}