@robohall/react-query-factory 2.1.2 → 2.1.4

package/README.md

@@ -258,8 +258,12 @@ import { paginateDescribeInstances } from '@aws-sdk/client-ec2';
 
 const describeInstances = queryFactory({
   queryKey: ['ec2:DescribeInstances'],
-  queryFn: (params: DescribeInstancesCommandInput) =>
-    paginateDescribeInstances({ client: ec2 }, params),
+  queryFn: (params: DescribeInstancesCommandInput, ctx) =>
+    paginateDescribeInstances(
+      { client: ec2, startingToken: ctx.pageParam ?? params.NextToken },
+      params,
+    ),
+  initialPageParam: undefined as string | undefined,
   shouldFetchNextPage: (instances, opts: { minResults?: number }) =>
     opts.minResults != null && instances.length < opts.minResults,
   reduce: (acc, page: DescribeInstancesResponse): Instance[] => [
@@ -278,8 +282,8 @@ const describeInstances = queryFactory({
   queryKey: ['ec2:DescribeInstances'],
   queryFn: (params: DescribeInstancesCommandInput, ctx) =>
     paginateDescribeInstances(
-      { client: ec2 },
-      { ...params, StartingToken: ctx.pageParam },
+      { client: ec2, startingToken: ctx.pageParam ?? params.NextToken },
+      params,
     ),
   getNextPageParam: page => page.NextToken,
   initialPageParam: undefined as string | undefined,

package/dist/index.d.mts

@@ -128,6 +128,23 @@ declare function queryFactory<TParams = void, TData = unknown, TError = Error, T
  * // useQuery(usersFactory({ page: 1 }))
  */
 declare function queryFactory<TParams = void, TData = unknown, TError = Error, TSelected = TData, TPageParam = unknown, TCrawlOptions extends Record<string, unknown> = Record<string, unknown>>(config: QueryFactoryConfig<TParams, TData, TError, TSelected, TPageParam, TCrawlOptions>): QueryFactory<TParams, TData, TError, TSelected, TPageParam, TCrawlOptions, false>;
+/**
+ * Creates a child factory whose queryFn returns an AsyncIterable (e.g. an AWS SDK v3
+ * paginator). Inherits the parent's key namespace. Use this overload when switching
+ * to a paginator-based fetch while keeping the same result shape and crawl options.
+ */
+declare function queryFactory<TChildParams extends TParentParams, TData = unknown, TError = Error, TParentSelected = TData, TChildSelected = TParentSelected, TParentParams = TChildParams, TPageParam = unknown, TCrawlOptions extends Record<string, unknown> = Record<string, unknown>>(parent: QueryFactory<TParentParams, any, any, TParentSelected, any, any, any>, config: StandardQueryOptions<TError, TData> & {
+    queryKey?: QueryKey;
+    queryFn: (params: TChildParams, context: QueryFunctionContext<QueryKey, [
+        unknown
+    ] extends [TPageParam] ? never : TPageParam>) => AsyncIterable<TData>;
+    select?: (data: TData) => TChildSelected;
+    reduce?: (accumulator: TChildSelected | undefined, page: TData) => TChildSelected;
+    shouldFetchNextPage?: (combined: TChildSelected | undefined, crawlOptions: TCrawlOptions) => boolean;
+    getNextPageParam?: GetNextPageParamFunction<TPageParam, TData>;
+    getPreviousPageParam?: GetPreviousPageParamFunction<TPageParam, TData>;
+    initialPageParam?: TPageParam;
+}): QueryFactory<TChildParams, TData, TError, TChildSelected, TPageParam, TCrawlOptions, boolean>;
 /**
  * Creates a child factory that inherits the query key and standard options from
  * `parent` and introduces a new `queryFn`. The child's query key is appended to

package/dist/index.d.ts

@@ -128,6 +128,23 @@ declare function queryFactory<TParams = void, TData = unknown, TError = Error, T
  * // useQuery(usersFactory({ page: 1 }))
  */
 declare function queryFactory<TParams = void, TData = unknown, TError = Error, TSelected = TData, TPageParam = unknown, TCrawlOptions extends Record<string, unknown> = Record<string, unknown>>(config: QueryFactoryConfig<TParams, TData, TError, TSelected, TPageParam, TCrawlOptions>): QueryFactory<TParams, TData, TError, TSelected, TPageParam, TCrawlOptions, false>;
+/**
+ * Creates a child factory whose queryFn returns an AsyncIterable (e.g. an AWS SDK v3
+ * paginator). Inherits the parent's key namespace. Use this overload when switching
+ * to a paginator-based fetch while keeping the same result shape and crawl options.
+ */
+declare function queryFactory<TChildParams extends TParentParams, TData = unknown, TError = Error, TParentSelected = TData, TChildSelected = TParentSelected, TParentParams = TChildParams, TPageParam = unknown, TCrawlOptions extends Record<string, unknown> = Record<string, unknown>>(parent: QueryFactory<TParentParams, any, any, TParentSelected, any, any, any>, config: StandardQueryOptions<TError, TData> & {
+    queryKey?: QueryKey;
+    queryFn: (params: TChildParams, context: QueryFunctionContext<QueryKey, [
+        unknown
+    ] extends [TPageParam] ? never : TPageParam>) => AsyncIterable<TData>;
+    select?: (data: TData) => TChildSelected;
+    reduce?: (accumulator: TChildSelected | undefined, page: TData) => TChildSelected;
+    shouldFetchNextPage?: (combined: TChildSelected | undefined, crawlOptions: TCrawlOptions) => boolean;
+    getNextPageParam?: GetNextPageParamFunction<TPageParam, TData>;
+    getPreviousPageParam?: GetPreviousPageParamFunction<TPageParam, TData>;
+    initialPageParam?: TPageParam;
+}): QueryFactory<TChildParams, TData, TError, TChildSelected, TPageParam, TCrawlOptions, boolean>;
 /**
  * Creates a child factory that inherits the query key and standard options from
  * `parent` and introduces a new `queryFn`. The child's query key is appended to

package/dist/index.js

@@ -248,7 +248,7 @@ function buildFactory(cfg) {
   return factory;
 }
 function queryFactory(configOrParent, childConfig) {
-  var _a, _b, _c, _d, _e;
+  var _a, _b, _c, _d, _e, _f, _g;
   if (childConfig !== void 0 && typeof configOrParent === "function") {
     const result = configOrParent();
     const parentCfg = result == null ? void 0 : result[FACTORY_CONFIG];
@@ -277,20 +277,23 @@ function queryFactory(configOrParent, childConfig) {
       getNextPageParam: childConfig.getNextPageParam,
       getPreviousPageParam: childConfig.getPreviousPageParam,
       initialPageParam: childConfig.initialPageParam,
-      shouldFetchNextPage: childConfig.shouldFetchNextPage,
-      reduce: childConfig.reduce
+      // Fall back to parent's crawling logic when child doesn't override —
+      // useful when the child only changes how pages are fetched (e.g. switching
+      // to a paginator queryFn) but accumulates the same result shape.
+      shouldFetchNextPage: (_b = childConfig.shouldFetchNextPage) != null ? _b : parentCfg.shouldFetchNextPage,
+      reduce: (_c = childConfig.reduce) != null ? _c : parentCfg.reduce
     } : {
-      getNextPageParam: (_b = childConfig.getNextPageParam) != null ? _b : parentCfg.getNextPageParam,
-      getPreviousPageParam: (_c = childConfig.getPreviousPageParam) != null ? _c : parentCfg.getPreviousPageParam,
+      getNextPageParam: (_d = childConfig.getNextPageParam) != null ? _d : parentCfg.getNextPageParam,
+      getPreviousPageParam: (_e = childConfig.getPreviousPageParam) != null ? _e : parentCfg.getPreviousPageParam,
       initialPageParam: "initialPageParam" in childConfig ? childConfig.initialPageParam : parentCfg.initialPageParam,
-      shouldFetchNextPage: (_d = childConfig.shouldFetchNextPage) != null ? _d : parentCfg.shouldFetchNextPage,
-      reduce: (_e = childConfig.reduce) != null ? _e : parentCfg.reduce
+      shouldFetchNextPage: (_f = childConfig.shouldFetchNextPage) != null ? _f : parentCfg.shouldFetchNextPage,
+      reduce: (_g = childConfig.reduce) != null ? _g : parentCfg.reduce
     };
     const {
       queryKey: _k,
-      queryFn: _f,
+      queryFn: _f2,
       select: _s,
-      getNextPageParam: _g,
+      getNextPageParam: _g2,
       getPreviousPageParam: _gp,
       initialPageParam: _ip,
       shouldFetchNextPage: _sfnp,

package/dist/index.mjs

@@ -222,7 +222,7 @@ function buildFactory(cfg) {
   return factory;
 }
 function queryFactory(configOrParent, childConfig) {
-  var _a, _b, _c, _d, _e;
+  var _a, _b, _c, _d, _e, _f, _g;
   if (childConfig !== void 0 && typeof configOrParent === "function") {
     const result = configOrParent();
     const parentCfg = result == null ? void 0 : result[FACTORY_CONFIG];
@@ -251,20 +251,23 @@ function queryFactory(configOrParent, childConfig) {
       getNextPageParam: childConfig.getNextPageParam,
       getPreviousPageParam: childConfig.getPreviousPageParam,
       initialPageParam: childConfig.initialPageParam,
-      shouldFetchNextPage: childConfig.shouldFetchNextPage,
-      reduce: childConfig.reduce
+      // Fall back to parent's crawling logic when child doesn't override —
+      // useful when the child only changes how pages are fetched (e.g. switching
+      // to a paginator queryFn) but accumulates the same result shape.
+      shouldFetchNextPage: (_b = childConfig.shouldFetchNextPage) != null ? _b : parentCfg.shouldFetchNextPage,
+      reduce: (_c = childConfig.reduce) != null ? _c : parentCfg.reduce
     } : {
-      getNextPageParam: (_b = childConfig.getNextPageParam) != null ? _b : parentCfg.getNextPageParam,
-      getPreviousPageParam: (_c = childConfig.getPreviousPageParam) != null ? _c : parentCfg.getPreviousPageParam,
+      getNextPageParam: (_d = childConfig.getNextPageParam) != null ? _d : parentCfg.getNextPageParam,
+      getPreviousPageParam: (_e = childConfig.getPreviousPageParam) != null ? _e : parentCfg.getPreviousPageParam,
       initialPageParam: "initialPageParam" in childConfig ? childConfig.initialPageParam : parentCfg.initialPageParam,
-      shouldFetchNextPage: (_d = childConfig.shouldFetchNextPage) != null ? _d : parentCfg.shouldFetchNextPage,
-      reduce: (_e = childConfig.reduce) != null ? _e : parentCfg.reduce
+      shouldFetchNextPage: (_f = childConfig.shouldFetchNextPage) != null ? _f : parentCfg.shouldFetchNextPage,
+      reduce: (_g = childConfig.reduce) != null ? _g : parentCfg.reduce
     };
     const {
       queryKey: _k,
-      queryFn: _f,
+      queryFn: _f2,
       select: _s,
-      getNextPageParam: _g,
+      getNextPageParam: _g2,
       getPreviousPageParam: _gp,
       initialPageParam: _ip,
       shouldFetchNextPage: _sfnp,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robohall/react-query-factory",
-  "version": "2.1.2",
+  "version": "2.1.4",
   "description": "A factory abstraction for TanStack Query (React Query) with composable keys, crawling support, and automatic infinite query generation",
   "author": "Robert Hall",
   "license": "MIT",
@@ -33,6 +33,7 @@
     "build": "tsup src/index.ts --format cjs,esm --dts --clean",
     "typecheck": "tsc --noEmit",
     "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
     "test:watch": "vitest",
     "prepublishOnly": "npm run build && npm test",
     "sandbox": "cd sandbox && npm run dev",
@@ -43,6 +44,7 @@
   },
   "devDependencies": {
     "@tanstack/react-query": "^5.0.0",
+    "@vitest/coverage-v8": "^2.1.9",
     "prettier": "^3.8.3",
     "tsup": "^8.0.0",
     "typescript": "^5.0.0",