@robohall/react-query-factory 2.1.0 → 2.1.2

package/README.md

@@ -9,7 +9,7 @@
   <a href="https://roberth26.github.io/react-query-factory/"><strong>Visit the Sandbox</strong></a>
 </p>
 
-TanStack Query handles caching, syncing, and invalidation. What it doesn't do is crawl paginated APIs for you. This library adds that — a factory function that wraps your `queryFn` with a configurable crawl loop so `useQuery` can return accumulated results instead of a single page. The same factory produces `useInfiniteQuery` options, composes into child factories that share the cache, and exposes scope-aware invalidation keys. TanStack's API stays fully exposed at every call site.
+TanStack Query handles caching, syncing, and invalidation. What it doesn't do is crawl paginated APIs for you. This library adds that — a factory function that wraps your `queryFn` with a configurable crawl loop so `useQuery` can return accumulated results instead of a single page. The `queryFn` can be a plain async function or an async iterable (e.g. an AWS SDK paginator), with no cursor wiring required in the latter case. The same factory produces `useInfiniteQuery` options, composes into child factories that share the cache, and exposes scope-aware invalidation keys. TanStack's API stays fully exposed at every call site.
 
 Zero runtime dependencies.
 
@@ -30,7 +30,30 @@ function useInstances(params: DescribeInstancesCommandInput) {
 }
 ```
 
-Works, but the key only exists inside the hook. Prefetching in a route loader, invalidating after a mutation, or fetching imperatively all require knowing `['instances', params]` without calling the hook.
+Works, until requirements grow. You need a `select` option — so the hook grows a generic. You need a `useInfiniteQuery` variant — so you write a second hook with a key differentiator to avoid a cache collision. You need to prefetch in a route loader — but the key is trapped inside the hook.
+
+```typescript
+function useInstances<TSelected = Instance[]>(
+  params: DescribeInstancesCommandInput,
+  options?: { select?: (data: Instance[]) => TSelected },
+) {
+  return useQuery({
+    queryKey: ['instances', params],
+    queryFn: () => fetchInstances(params),
+    select: options?.select,
+  });
+}
+
+// separate hook, duplicated key and queryFn, must stay in sync manually
+function useInstancesInfinite(params: DescribeInstancesCommandInput) {
+  return useInfiniteQuery({
+    queryKey: ['instances', 'infinite', params],
+    // ...
+  });
+}
+```
+
+The generics multiply with every new transform. The key is still trapped — prefetching and invalidation still can't reach it from outside.
 
 ### Step 2 — `queryOptions` for colocation
 
@@ -126,7 +149,7 @@ Now you have two separate factories that duplicate the key and queryFn and need
 ### What's missing
 
 - Define the query **once**: key, queryFn, pagination config
-- Let each **call site** decide how much to crawl (e.g. 50 records or all of them)
+- Let each **call site** decide how much to crawl (e.g. 50 records, all of them, or none)
 - Optionally have `useQuery` crawl and return the **accumulated result** instead of a single page
 - Use **async iterables** as `queryFn` — pass a paginator function directly, no cursor wiring required
 - Have `.infinite()` available on the **same factory**, no duplication
@@ -144,7 +167,10 @@ const describeInstances = queryFactory({
   queryKey: ['ec2:DescribeInstances'],
   queryFn: (params: DescribeInstancesCommandInput, ctx) =>
     ec2.send(
-      new DescribeInstancesCommand({ ...params, NextToken: ctx.pageParam }),
+      new DescribeInstancesCommand({
+        ...params,
+        NextToken: ctx.pageParam ?? params.NextToken,
+      }),
       {
         abortSignal: ctx.signal,
       },
@@ -156,7 +182,7 @@ const describeInstances = queryFactory({
     ...(page.Reservations?.flatMap(r => r.Instances ?? []) ?? []),
   ],
   shouldFetchNextPage: (instances, opts: { minResults?: number }) =>
-    opts.minResults == null || instances.length < opts.minResults,
+    opts.minResults != null && instances.length < opts.minResults,
 });
 
 // useQuery — crawls all pages, data is Instance[]
@@ -211,7 +237,7 @@ The `crawlOptions` argument passed at call time is forwarded to `shouldFetchNext
 const describeInstances = queryFactory({
   // ...
   shouldFetchNextPage: (instances, opts: { minResults?: number }) =>
-    opts.minResults == null || instances.length < opts.minResults,
+    opts.minResults != null && instances.length < opts.minResults,
 });
 
 // two separate cache entries — crawl independently
@@ -235,7 +261,7 @@ const describeInstances = queryFactory({
   queryFn: (params: DescribeInstancesCommandInput) =>
     paginateDescribeInstances({ client: ec2 }, params),
   shouldFetchNextPage: (instances, opts: { minResults?: number }) =>
-    opts.minResults == null || instances.length < opts.minResults,
+    opts.minResults != null && instances.length < opts.minResults,
   reduce: (acc, page: DescribeInstancesResponse): Instance[] => [
     ...(acc ?? []),
     ...(page.Reservations?.flatMap(r => r.Instances ?? []) ?? []),
@@ -258,7 +284,7 @@ const describeInstances = queryFactory({
   getNextPageParam: page => page.NextToken,
   initialPageParam: undefined as string | undefined,
   shouldFetchNextPage: (instances, opts: { minResults?: number }) =>
-    opts.minResults == null || instances.length < opts.minResults,
+    opts.minResults != null && instances.length < opts.minResults,
   reduce: (acc, page): Instance[] => [
     ...(acc ?? []),
     ...(page.Instances ?? []),

package/dist/index.js

@@ -122,13 +122,16 @@ function buildInfiniteCrawlingQueryFn(queryFn, getNextPageParam, shouldFetchNext
     const initialResult = queryFn(params, ctx);
     if (isAsyncIterable(initialResult)) {
       const pages2 = [];
+      const startParam = context.pageParam;
       let acc2 = void 0;
       let nextBatchParam2 = null;
       for await (const page of initialResult) {
         if ((_b = context.signal) == null ? void 0 : _b.aborted) break;
         pages2.push(page);
         acc2 = reduce(acc2, page);
-        const nextParam = getNextPageParam(page, pages2, void 0, []);
+        const nextParam = getNextPageParam(page, pages2, startParam, [
+          startParam
+        ]);
         nextBatchParam2 = nextParam != null ? nextParam : null;
         if (nextParam == null) break;
         if (!shouldFetchNextPage(acc2, crawlOptions)) break;
@@ -147,9 +150,9 @@ function buildInfiniteCrawlingQueryFn(queryFn, getNextPageParam, shouldFetchNext
       pages.push(page);
       pageParams.push(currentParam);
       acc = reduce(acc, page);
-      if ((_c = context.signal) == null ? void 0 : _c.aborted) break;
       const nextParam = getNextPageParam(page, pages, currentParam, pageParams);
       nextBatchParam = nextParam != null ? nextParam : null;
+      if ((_c = context.signal) == null ? void 0 : _c.aborted) break;
       if (nextParam == null) break;
       if (!shouldFetchNextPage(acc, crawlOptions)) break;
       currentParam = nextParam;
@@ -279,7 +282,7 @@ function queryFactory(configOrParent, childConfig) {
     } : {
       getNextPageParam: (_b = childConfig.getNextPageParam) != null ? _b : parentCfg.getNextPageParam,
       getPreviousPageParam: (_c = childConfig.getPreviousPageParam) != null ? _c : parentCfg.getPreviousPageParam,
-      initialPageParam: childConfig.initialPageParam !== void 0 ? childConfig.initialPageParam : parentCfg.initialPageParam,
+      initialPageParam: "initialPageParam" in childConfig ? childConfig.initialPageParam : parentCfg.initialPageParam,
       shouldFetchNextPage: (_d = childConfig.shouldFetchNextPage) != null ? _d : parentCfg.shouldFetchNextPage,
       reduce: (_e = childConfig.reduce) != null ? _e : parentCfg.reduce
     };

package/dist/index.mjs

@@ -96,13 +96,16 @@ function buildInfiniteCrawlingQueryFn(queryFn, getNextPageParam, shouldFetchNext
     const initialResult = queryFn(params, ctx);
     if (isAsyncIterable(initialResult)) {
       const pages2 = [];
+      const startParam = context.pageParam;
       let acc2 = void 0;
       let nextBatchParam2 = null;
       for await (const page of initialResult) {
         if ((_b = context.signal) == null ? void 0 : _b.aborted) break;
         pages2.push(page);
         acc2 = reduce(acc2, page);
-        const nextParam = getNextPageParam(page, pages2, void 0, []);
+        const nextParam = getNextPageParam(page, pages2, startParam, [
+          startParam
+        ]);
         nextBatchParam2 = nextParam != null ? nextParam : null;
         if (nextParam == null) break;
         if (!shouldFetchNextPage(acc2, crawlOptions)) break;
@@ -121,9 +124,9 @@ function buildInfiniteCrawlingQueryFn(queryFn, getNextPageParam, shouldFetchNext
       pages.push(page);
       pageParams.push(currentParam);
       acc = reduce(acc, page);
-      if ((_c = context.signal) == null ? void 0 : _c.aborted) break;
       const nextParam = getNextPageParam(page, pages, currentParam, pageParams);
       nextBatchParam = nextParam != null ? nextParam : null;
+      if ((_c = context.signal) == null ? void 0 : _c.aborted) break;
       if (nextParam == null) break;
       if (!shouldFetchNextPage(acc, crawlOptions)) break;
       currentParam = nextParam;
@@ -253,7 +256,7 @@ function queryFactory(configOrParent, childConfig) {
     } : {
       getNextPageParam: (_b = childConfig.getNextPageParam) != null ? _b : parentCfg.getNextPageParam,
       getPreviousPageParam: (_c = childConfig.getPreviousPageParam) != null ? _c : parentCfg.getPreviousPageParam,
-      initialPageParam: childConfig.initialPageParam !== void 0 ? childConfig.initialPageParam : parentCfg.initialPageParam,
+      initialPageParam: "initialPageParam" in childConfig ? childConfig.initialPageParam : parentCfg.initialPageParam,
       shouldFetchNextPage: (_d = childConfig.shouldFetchNextPage) != null ? _d : parentCfg.shouldFetchNextPage,
       reduce: (_e = childConfig.reduce) != null ? _e : parentCfg.reduce
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robohall/react-query-factory",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "description": "A factory abstraction for TanStack Query (React Query) with composable keys, crawling support, and automatic infinite query generation",
   "author": "Robert Hall",
   "license": "MIT",