@ahoo-wang/fetcher-react 2.6.15 → 2.6.18

package/dist/wow/useSingleQuery.d.ts

@@ -1,66 +1,45 @@
-import { SingleQuery, Condition, Projection, FieldSort } from '@ahoo-wang/fetcher-wow';
-import { UsePromiseStateOptions, UseExecutePromiseReturn } from '../core';
-import { AttributesCapable, FetcherError } from '@ahoo-wang/fetcher';
-import { AutoExecuteCapable } from './types';
+import { SingleQuery } from '@ahoo-wang/fetcher-wow';
+import { FetcherError } from '@ahoo-wang/fetcher';
+import { UseQueryOptions, UseQueryReturn } from './useQuery';
 /**
  * Options for the useSingleQuery hook.
- * @template R - The type of the result.
- * @template FIELDS - The type of the fields used in conditions and projections.
- * @template E - The type of the error.
+ * Extends UseQueryOptions with SingleQuery as query key and custom result type.
+ *
+ * @template R - The result type of the query
+ * @template FIELDS - The fields type for the single query
+ * @template E - The error type, defaults to FetcherError
  */
-export interface UseSingleQueryOptions<R, FIELDS extends string = string, E = FetcherError> extends UsePromiseStateOptions<R, E>, AttributesCapable, AutoExecuteCapable {
-    /**
-     * The initial single query configuration.
-     */
-    initialQuery: SingleQuery<FIELDS>;
-    /**
-     * The function to execute the single query.
-     * @param singleQuery - The single query object.
-     * @param attributes - Optional additional attributes.
-     * @returns A promise that resolves to the result.
-     */
-    query: (singleQuery: SingleQuery<FIELDS>, attributes?: Record<string, any>) => Promise<R>;
+export interface UseSingleQueryOptions<R, FIELDS extends string = string, E = FetcherError> extends UseQueryOptions<SingleQuery<FIELDS>, R, E> {
 }
 /**
  * Return type for the useSingleQuery hook.
- * @template R - The type of the result.
- * @template FIELDS - The type of the fields used in conditions and projections.
- * @template E - The type of the error.
+ * Extends UseQueryReturn with SingleQuery as query key and custom result type.
+ *
+ * @template R - The result type of the query
+ * @template FIELDS - The fields type for the single query
+ * @template E - The error type, defaults to FetcherError
  */
-export interface UseSingleQueryReturn<R, FIELDS extends string = string, E = FetcherError> extends UseExecutePromiseReturn<R, E> {
-    /**
-     * Executes the single query.
-     * @returns A promise that resolves to the result or an error.
-     */
-    execute: () => Promise<E | R>;
-    /**
-     * Sets the condition for the query.
-     * @param condition - The new condition.
-     */
-    setCondition: (condition: Condition<FIELDS>) => void;
-    /**
-     * Sets the projection for the query.
-     * @param projection - The new projection.
-     */
-    setProjection: (projection: Projection<FIELDS>) => void;
-    /**
-     * Sets the sort order for the query.
-     * @param sort - The new sort array.
-     */
-    setSort: (sort: FieldSort<FIELDS>[]) => void;
+export interface UseSingleQueryReturn<R, FIELDS extends string = string, E = FetcherError> extends UseQueryReturn<SingleQuery<FIELDS>, R, E> {
 }
 /**
- * A React hook for managing single queries with state management for conditions, projections, and sorting.
- * @template R - The type of the result.
- * @template FIELDS - The type of the fields used in conditions and projections.
- * @template E - The type of the error.
- * @param options - The options for the hook.
- * @returns An object containing the query state and methods to update it.
+ * Hook for querying a single item with conditions, projection, and sorting.
+ * Wraps useQuery to provide type-safe single item queries.
+ *
+ * @template R - The result type of the query
+ * @template FIELDS - The fields type for the single query
+ * @template E - The error type, defaults to FetcherError
+ * @param options - The query options including single query configuration
+ * @returns The query result with single item data
+ *
  * @example
  * ```typescript
- * const { data, loading, error, execute, setCondition, setProjection } = useSingleQuery({
- *   initialQuery: { condition: {}, projection: {}, sort: [] },
- *   query: async (singleQuery) => fetchSingleData(singleQuery),
+ * const { data, isLoading } = useSingleQuery<{ id: number; name: string }, 'id' | 'name'>({
+ *   initialQuery: {
+ *     condition: all(),
+ *     projection: { include: ['id', 'name'] },
+ *     sort: [{ field: 'id', direction: SortDirection.ASC }],
+ *   },
+ *   execute: async (query) => fetchSingleItem(query),
  * });
  * ```
  */

package/dist/wow/useSingleQuery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useSingleQuery.d.ts","sourceRoot":"","sources":["../../src/wow/useSingleQuery.ts"],"names":[],"mappings":"AAaA,OAAO,EACL,WAAW,EACX,SAAS,EACT,KAAK,UAAU,EAEf,SAAS,EACV,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAEL,sBAAsB,EAEtB,uBAAuB,EACxB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB,CACpC,CAAC,EACD,MAAM,SAAS,MAAM,GAAG,MAAM,EAC9B,CAAC,GAAG,YAAY,CAChB,SAAQ,sBAAsB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,iBAAiB,EAAE,kBAAkB;IAC3E;;OAEG;IACH,YAAY,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAClC;;;;;OAKG;IACH,KAAK,EAAE,CACL,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,EAChC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC7B,OAAO,CAAC,CAAC,CAAC,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB,CACnC,CAAC,EACD,MAAM,SAAS,MAAM,GAAG,MAAM,EAC9B,CAAC,GAAG,YAAY,CAChB,SAAQ,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC;IACrC;;;OAGG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9B;;;OAGG;IACH,YAAY,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC;IACrD;;;OAGG;IACH,aAAa,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC;IACxD;;;OAGG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,IAAI,CAAC;CAC9C;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,cAAc,CAC5B,CAAC,EACD,MAAM,SAAS,MAAM,GAAG,MAAM,EAC9B,CAAC,GAAG,YAAY,EAEhB,OAAO,EAAE,qBAAqB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,GAC3C,oBAAoB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAyCpC"}
+{"version":3,"file":"useSingleQuery.d.ts","sourceRoot":"","sources":["../../src/wow/useSingleQuery.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAY,eAAe,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEvE;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB,CACpC,CAAC,EACD,MAAM,SAAS,MAAM,GAAG,MAAM,EAC9B,CAAC,GAAG,YAAY,CAChB,SAAQ,eAAe,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;CACnD;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB,CACnC,CAAC,EACD,MAAM,SAAS,MAAM,GAAG,MAAM,EAC9B,CAAC,GAAG,YAAY,CAChB,SAAQ,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;CAClD;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,cAAc,CAC5B,CAAC,EACD,MAAM,SAAS,MAAM,GAAG,MAAM,EAC9B,CAAC,GAAG,YAAY,EAEhB,OAAO,EAAE,qBAAqB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,GAC3C,oBAAoB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAEpC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahoo-wang/fetcher-react",
-  "version": "2.6.15",
+  "version": "2.6.18",
   "description": "React integration for Fetcher HTTP client. Provides React Hooks and components for seamless data fetching with automatic re-rendering and loading states.",
   "keywords": [
     "fetch",
@@ -55,7 +55,7 @@
     "globals": "^16.4.0",
     "prettier": "^3.6.2",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.45.0",
+    "typescript-eslint": "^8.46.0",
     "eslint-plugin-react-hooks": "^5.2.0",
     "unplugin-dts": "1.0.0-beta.6",
     "vite": "^7.1.9",

package/dist/wow/useListQueryState.d.ts

@@ -1,66 +0,0 @@
-import { ListQuery, Condition, Projection, FieldSort } from '@ahoo-wang/fetcher-wow';
-/**
- * Options for the useListQueryState hook.
- * @template FIELDS - The type of the fields used in conditions and projections.
- */
-export interface UseListQueryStateOptions<FIELDS extends string = string> {
-    /**
-     * The initial list query configuration.
-     */
-    initialQuery: ListQuery<FIELDS>;
-}
-/**
- * Return type for the useListQueryState hook.
- * @template FIELDS - The type of the fields used in conditions and projections.
- */
-export interface UseListQueryStateReturn<FIELDS extends string = string> {
-    /**
-     * The current condition.
-     */
-    condition: Condition<FIELDS>;
-    /**
-     * The current projection.
-     */
-    projection?: Projection<FIELDS>;
-    /**
-     * The current sort order.
-     */
-    sort?: FieldSort<FIELDS>[];
-    /**
-     * The current limit.
-     */
-    limit?: number;
-    /**
-     * Sets the condition for the query.
-     * @param condition - The new condition.
-     */
-    setCondition: (condition: Condition<FIELDS>) => void;
-    /**
-     * Sets the projection for the query.
-     * @param projection - The new projection.
-     */
-    setProjection: (projection: Projection<FIELDS>) => void;
-    /**
-     * Sets the sort order for the query.
-     * @param sort - The new sort array.
-     */
-    setSort: (sort: FieldSort<FIELDS>[]) => void;
-    /**
-     * Sets the limit for the query.
-     * @param limit - The new limit.
-     */
-    setLimit: (limit: number) => void;
-    /**
-     * Builds the list query object from current state.
-     * @returns The list query object.
-     */
-    buildQuery: () => ListQuery<FIELDS>;
-}
-/**
- * A React hook for managing query state (condition, projection, sort, limit).
- * @template FIELDS - The type of the fields used in conditions and projections.
- * @param options - The options for the hook.
- * @returns An object containing the query state and methods to update it.
- */
-export declare function useListQueryState<FIELDS extends string = string>(options: UseListQueryStateOptions<FIELDS>): UseListQueryStateReturn<FIELDS>;
-//# sourceMappingURL=useListQueryState.d.ts.map

package/dist/wow/useListQueryState.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useListQueryState.d.ts","sourceRoot":"","sources":["../../src/wow/useListQueryState.ts"],"names":[],"mappings":"AAaA,OAAO,EACL,SAAS,EACT,SAAS,EACT,KAAK,UAAU,EAEf,SAAS,EACV,MAAM,wBAAwB,CAAC;AAGhC;;;GAGG;AACH,MAAM,WAAW,wBAAwB,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM;IACtE;;OAEG;IACH,YAAY,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM;IACrE;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,YAAY,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC;IACrD;;;OAGG;IACH,aAAa,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC;IACxD;;;OAGG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,IAAI,CAAC;IAC7C;;;OAGG;IACH,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC;;;OAGG;IACH,UAAU,EAAE,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;CACrC;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM,EAC9D,OAAO,EAAE,wBAAwB,CAAC,MAAM,CAAC,GACxC,uBAAuB,CAAC,MAAM,CAAC,CAwCjC"}