@robohall/react-query-factory 1.0.4 → 1.0.5

package/README.md

@@ -92,7 +92,7 @@ const describeInstances = queryFactory({
   // ...
   reduce: (acc, page): Instance[] => [...(acc ?? []), ...page.Reservations.flatMap(r => r.Instances)],
   shouldFetchNextPage: (instances, opts: { minResults?: number }) =>
-    opts.minResults != null && instances.length < opts.minResults,  // instances: Instance[], not Instance[] | undefined
+    opts.minResults != null && instances.length < opts.minResults,
 });
 
 // stop after accumulating at least 50 instances

package/dist/index.d.mts

@@ -27,7 +27,9 @@ type QueryFactoryConfig<TParams = void, TData = unknown, TError = Error, TSelect
     /** Namespace segments. Params are appended as the final element at call time,
      *  giving a full key of [...namespace, 'infinite'?, params, crawlOptions?]. */
     queryKey: QueryKey;
-    queryFn?: (params: TParams, context: QueryFunctionContext<QueryKey, [unknown] extends [TPageParam] ? never : TPageParam>) => TData | Promise<TData>;
+    queryFn?: (params: TParams, context: QueryFunctionContext<QueryKey, [
+        unknown
+    ] extends [TPageParam] ? never : TPageParam>) => TData | Promise<TData>;
     select?: (data: TData) => TSelected;
 } & ({
     /** TanStack v5 generic order: GetNextPageParamFunction<TPageParam, TData> */
@@ -106,7 +108,9 @@ interface QueryFactory<TParams = void, TData = unknown, TError = Error, TSelecte
  */
 declare function queryFactory<TParams = void, TData = unknown, TError = Error, TSelected = TData, TPageParam = unknown, TCrawlOptions extends Record<string, unknown> = Record<string, unknown>>(config: StandardQueryOptions<TError, TData> & {
     queryKey: QueryKey;
-    queryFn?: (params: TParams, context: QueryFunctionContext<QueryKey, [unknown] extends [TPageParam] ? never : TPageParam>) => TData | Promise<TData>;
+    queryFn?: (params: TParams, context: QueryFunctionContext<QueryKey, [
+        unknown
+    ] extends [TPageParam] ? never : TPageParam>) => TData | Promise<TData>;
     select?: (data: TData) => TSelected;
     getNextPageParam: GetNextPageParamFunction<TPageParam, TData>;
     initialPageParam: TPageParam;

package/dist/index.d.ts

@@ -27,7 +27,9 @@ type QueryFactoryConfig<TParams = void, TData = unknown, TError = Error, TSelect
     /** Namespace segments. Params are appended as the final element at call time,
      *  giving a full key of [...namespace, 'infinite'?, params, crawlOptions?]. */
     queryKey: QueryKey;
-    queryFn?: (params: TParams, context: QueryFunctionContext<QueryKey, [unknown] extends [TPageParam] ? never : TPageParam>) => TData | Promise<TData>;
+    queryFn?: (params: TParams, context: QueryFunctionContext<QueryKey, [
+        unknown
+    ] extends [TPageParam] ? never : TPageParam>) => TData | Promise<TData>;
     select?: (data: TData) => TSelected;
 } & ({
     /** TanStack v5 generic order: GetNextPageParamFunction<TPageParam, TData> */
@@ -106,7 +108,9 @@ interface QueryFactory<TParams = void, TData = unknown, TError = Error, TSelecte
  */
 declare function queryFactory<TParams = void, TData = unknown, TError = Error, TSelected = TData, TPageParam = unknown, TCrawlOptions extends Record<string, unknown> = Record<string, unknown>>(config: StandardQueryOptions<TError, TData> & {
     queryKey: QueryKey;
-    queryFn?: (params: TParams, context: QueryFunctionContext<QueryKey, [unknown] extends [TPageParam] ? never : TPageParam>) => TData | Promise<TData>;
+    queryFn?: (params: TParams, context: QueryFunctionContext<QueryKey, [
+        unknown
+    ] extends [TPageParam] ? never : TPageParam>) => TData | Promise<TData>;
     select?: (data: TData) => TSelected;
     getNextPageParam: GetNextPageParamFunction<TPageParam, TData>;
     initialPageParam: TPageParam;

package/dist/index.js

@@ -26,30 +26,39 @@ module.exports = __toCommonJS(index_exports);
 
 // src/queryFactory.ts
 var FACTORY_CONFIG = /* @__PURE__ */ Symbol("factoryConfig");
+var getEnvelopeNextPageParam = (envelope) => envelope.nextPageParam;
+var noNextPage = () => void 0;
 function resolveKey(namespace, params, crawlOptions) {
   const base = Array.isArray(namespace) ? namespace : [namespace];
   const withParams = params === void 0 ? base : [...base, params];
   if (!crawlOptions) return withParams;
-  const defined = Object.fromEntries(Object.entries(crawlOptions).filter(([, v]) => v !== void 0));
-  return Object.keys(defined).length > 0 ? [...withParams, defined] : withParams;
+  let defined;
+  for (const key in crawlOptions) {
+    if (crawlOptions[key] !== void 0) {
+      (defined != null ? defined : defined = {})[key] = crawlOptions[key];
+    }
+  }
+  return defined ? [...withParams, defined] : withParams;
 }
-function wrapGetNextPageParam(getNextPageParam, shouldFetchNextPage, crawlOptions, reduce) {
+function wrapGetNextPageParam(getNextPageParam, shouldFetchNextPage, crawlOptions) {
   return (lastPage, allPages, lastPageParam, allPageParams) => {
-    const combined = reduce ? allPages.reduce((acc, page) => reduce(acc, page), void 0) : lastPage;
-    if (!shouldFetchNextPage(combined, crawlOptions)) return void 0;
+    if (!shouldFetchNextPage(lastPage, crawlOptions))
+      return void 0;
     return getNextPageParam(lastPage, allPages, lastPageParam, allPageParams);
   };
 }
-function buildCrawlingQueryFn(queryFn, getNextPageParam, initialPageParam, shouldFetchNextPage, reduce, crawlOptions) {
-  return async (context) => {
+function buildCrawlingQueryFn(queryFn, getNextPageParam, initialPageParam, shouldFetchNextPage, reduce) {
+  return async (params, crawlOptions, context) => {
     var _a, _b;
     const pages = [];
     const pageParams = [];
     let currentParam = initialPageParam;
     let acc = void 0;
+    const ctx = { ...context, pageParam: currentParam };
     while (true) {
       if ((_a = context.signal) == null ? void 0 : _a.aborted) break;
-      const page = await queryFn({ ...context, pageParam: currentParam });
+      ctx.pageParam = currentParam;
+      const page = await queryFn(params, ctx);
       pages.push(page);
       pageParams.push(currentParam);
       if (reduce) acc = reduce(acc, page);
@@ -66,17 +75,19 @@ function buildCrawlingQueryFn(queryFn, getNextPageParam, initialPageParam, shoul
     return pages;
   };
 }
-function buildInfiniteCrawlingQueryFn(queryFn, getNextPageParam, shouldFetchNextPage, reduce, crawlOptions) {
-  return async (context) => {
+function buildInfiniteCrawlingQueryFn(queryFn, getNextPageParam, shouldFetchNextPage, reduce) {
+  return async (params, crawlOptions, context) => {
     var _a, _b;
     const pages = [];
     const pageParams = [];
     let currentParam = context.pageParam;
     let acc = void 0;
     let nextBatchParam = null;
+    const ctx = { ...context, pageParam: currentParam };
     while (true) {
       if ((_a = context.signal) == null ? void 0 : _a.aborted) break;
-      const page = await queryFn({ ...context, pageParam: currentParam });
+      ctx.pageParam = currentParam;
+      const page = await queryFn(params, ctx);
       pages.push(page);
       pageParams.push(currentParam);
       acc = reduce(acc, page);
@@ -105,10 +116,31 @@ function buildFactory(cfg) {
   } = cfg;
   const hasCrawling = rawQueryFn !== void 0 && getNextPageParam !== void 0;
   const hasInfiniteCrawling = hasCrawling && reduce !== void 0;
+  const crawlingFn = hasCrawling ? buildCrawlingQueryFn(
+    rawQueryFn,
+    getNextPageParam,
+    initialPageParam,
+    shouldFetchNextPage,
+    reduce
+  ) : void 0;
+  const infiniteCrawlingFn = hasInfiniteCrawling ? buildInfiniteCrawlingQueryFn(
+    rawQueryFn,
+    getNextPageParam,
+    shouldFetchNextPage,
+    reduce
+  ) : void 0;
+  const infiniteNamespace = [...resolveKey(namespace, void 0), "infinite"];
+  const envelopeSelect = infiniteCrawlingFn ? (data) => ({
+    ...data,
+    pages: data.pages.map((e) => select ? select(e.data) : e.data)
+  }) : void 0;
+  const infiniteSelect = !infiniteCrawlingFn && select ? (data) => ({
+    ...data,
+    pages: data.pages.map(select)
+  }) : void 0;
   const factory = function(params, crawlOptions = {}) {
     const queryKey = resolveKey(namespace, params, crawlOptions);
-    const boundQueryFn = rawQueryFn ? (ctx) => rawQueryFn(params, ctx) : void 0;
-    const resolvedQueryFn = hasCrawling ? buildCrawlingQueryFn(boundQueryFn, getNextPageParam, initialPageParam, shouldFetchNextPage, reduce, crawlOptions) : boundQueryFn;
+    const resolvedQueryFn = crawlingFn ? (ctx) => crawlingFn(params, crawlOptions, ctx) : rawQueryFn ? (ctx) => rawQueryFn(params, ctx) : void 0;
     return {
       ...standardOptions,
       queryKey,
@@ -118,37 +150,25 @@ function buildFactory(cfg) {
     };
   };
   factory.infinite = function(params, crawlOptions = {}) {
-    const queryKey = resolveKey([...resolveKey(namespace, void 0), "infinite"], params, crawlOptions);
-    const boundQueryFn = rawQueryFn ? (ctx) => rawQueryFn(params, ctx) : void 0;
-    if (hasInfiniteCrawling) {
-      const crawlingQueryFn = buildInfiniteCrawlingQueryFn(
-        boundQueryFn,
-        getNextPageParam,
-        shouldFetchNextPage,
-        reduce,
-        crawlOptions
-      );
-      const envelopeGetNextPageParam = (envelope) => envelope.nextPageParam;
-      const envelopeSelect = (data) => ({
-        ...data,
-        pages: data.pages.map((e) => select ? select(e.data) : e.data)
-      });
+    const queryKey = resolveKey(infiniteNamespace, params, crawlOptions);
+    if (infiniteCrawlingFn) {
       return {
         ...standardOptions,
         queryKey,
-        queryFn: crawlingQueryFn,
-        getNextPageParam: envelopeGetNextPageParam,
+        queryFn: (ctx) => infiniteCrawlingFn(params, crawlOptions, ctx),
+        getNextPageParam: getEnvelopeNextPageParam,
         initialPageParam,
         select: envelopeSelect,
         ...getPreviousPageParam !== void 0 && { getPreviousPageParam },
         [FACTORY_CONFIG]: cfg
       };
     }
-    const infiniteGetNextPageParam = getNextPageParam && shouldFetchNextPage ? wrapGetNextPageParam(getNextPageParam, shouldFetchNextPage, crawlOptions, reduce) : getNextPageParam != null ? getNextPageParam : (() => void 0);
-    const infiniteSelect = select ? (data) => ({
-      ...data,
-      pages: data.pages.map(select)
-    }) : void 0;
+    const boundQueryFn = rawQueryFn ? (ctx) => rawQueryFn(params, ctx) : void 0;
+    const infiniteGetNextPageParam = getNextPageParam && shouldFetchNextPage ? wrapGetNextPageParam(
+      getNextPageParam,
+      shouldFetchNextPage,
+      crawlOptions
+    ) : getNextPageParam != null ? getNextPageParam : noNextPage;
     return {
       ...standardOptions,
       queryKey,
@@ -168,11 +188,16 @@ function queryFactory(configOrParent, childConfig) {
     const result = configOrParent();
     const parentCfg = result == null ? void 0 : result[FACTORY_CONFIG];
     if (!parentCfg) {
-      throw new Error("queryFactory: first argument must be a factory created by queryFactory()");
+      throw new Error(
+        "queryFactory: first argument must be a factory created by queryFactory()"
+      );
     }
     const hasNewQueryFn = childConfig.queryFn !== void 0;
     const childNamespace = childConfig.queryKey ? Array.isArray(childConfig.queryKey) ? childConfig.queryKey : [childConfig.queryKey] : [];
-    const composedNamespace = [...parentCfg.queryKey, ...childNamespace];
+    const composedNamespace = [
+      ...parentCfg.queryKey,
+      ...childNamespace
+    ];
     let resolvedSelect;
     if (hasNewQueryFn) {
       resolvedSelect = childConfig.select;
@@ -212,7 +237,10 @@ function queryFactory(configOrParent, childConfig) {
       queryFn: hasNewQueryFn ? childConfig.queryFn : parentCfg.queryFn,
       select: resolvedSelect,
       ...crawling,
-      standardOptions: { ...parentCfg.standardOptions, ...childStandardOptions }
+      standardOptions: {
+        ...parentCfg.standardOptions,
+        ...childStandardOptions
+      }
     });
   }
   const {

package/dist/index.mjs

@@ -1,29 +1,38 @@
 // src/queryFactory.ts
 var FACTORY_CONFIG = /* @__PURE__ */ Symbol("factoryConfig");
+var getEnvelopeNextPageParam = (envelope) => envelope.nextPageParam;
+var noNextPage = () => void 0;
 function resolveKey(namespace, params, crawlOptions) {
   const base = Array.isArray(namespace) ? namespace : [namespace];
   const withParams = params === void 0 ? base : [...base, params];
   if (!crawlOptions) return withParams;
-  const defined = Object.fromEntries(Object.entries(crawlOptions).filter(([, v]) => v !== void 0));
-  return Object.keys(defined).length > 0 ? [...withParams, defined] : withParams;
+  let defined;
+  for (const key in crawlOptions) {
+    if (crawlOptions[key] !== void 0) {
+      (defined != null ? defined : defined = {})[key] = crawlOptions[key];
+    }
+  }
+  return defined ? [...withParams, defined] : withParams;
 }
-function wrapGetNextPageParam(getNextPageParam, shouldFetchNextPage, crawlOptions, reduce) {
+function wrapGetNextPageParam(getNextPageParam, shouldFetchNextPage, crawlOptions) {
   return (lastPage, allPages, lastPageParam, allPageParams) => {
-    const combined = reduce ? allPages.reduce((acc, page) => reduce(acc, page), void 0) : lastPage;
-    if (!shouldFetchNextPage(combined, crawlOptions)) return void 0;
+    if (!shouldFetchNextPage(lastPage, crawlOptions))
+      return void 0;
     return getNextPageParam(lastPage, allPages, lastPageParam, allPageParams);
   };
 }
-function buildCrawlingQueryFn(queryFn, getNextPageParam, initialPageParam, shouldFetchNextPage, reduce, crawlOptions) {
-  return async (context) => {
+function buildCrawlingQueryFn(queryFn, getNextPageParam, initialPageParam, shouldFetchNextPage, reduce) {
+  return async (params, crawlOptions, context) => {
     var _a, _b;
     const pages = [];
     const pageParams = [];
     let currentParam = initialPageParam;
     let acc = void 0;
+    const ctx = { ...context, pageParam: currentParam };
     while (true) {
       if ((_a = context.signal) == null ? void 0 : _a.aborted) break;
-      const page = await queryFn({ ...context, pageParam: currentParam });
+      ctx.pageParam = currentParam;
+      const page = await queryFn(params, ctx);
       pages.push(page);
       pageParams.push(currentParam);
       if (reduce) acc = reduce(acc, page);
@@ -40,17 +49,19 @@ function buildCrawlingQueryFn(queryFn, getNextPageParam, initialPageParam, shoul
     return pages;
   };
 }
-function buildInfiniteCrawlingQueryFn(queryFn, getNextPageParam, shouldFetchNextPage, reduce, crawlOptions) {
-  return async (context) => {
+function buildInfiniteCrawlingQueryFn(queryFn, getNextPageParam, shouldFetchNextPage, reduce) {
+  return async (params, crawlOptions, context) => {
     var _a, _b;
     const pages = [];
     const pageParams = [];
     let currentParam = context.pageParam;
     let acc = void 0;
     let nextBatchParam = null;
+    const ctx = { ...context, pageParam: currentParam };
     while (true) {
       if ((_a = context.signal) == null ? void 0 : _a.aborted) break;
-      const page = await queryFn({ ...context, pageParam: currentParam });
+      ctx.pageParam = currentParam;
+      const page = await queryFn(params, ctx);
       pages.push(page);
       pageParams.push(currentParam);
       acc = reduce(acc, page);
@@ -79,10 +90,31 @@ function buildFactory(cfg) {
   } = cfg;
   const hasCrawling = rawQueryFn !== void 0 && getNextPageParam !== void 0;
   const hasInfiniteCrawling = hasCrawling && reduce !== void 0;
+  const crawlingFn = hasCrawling ? buildCrawlingQueryFn(
+    rawQueryFn,
+    getNextPageParam,
+    initialPageParam,
+    shouldFetchNextPage,
+    reduce
+  ) : void 0;
+  const infiniteCrawlingFn = hasInfiniteCrawling ? buildInfiniteCrawlingQueryFn(
+    rawQueryFn,
+    getNextPageParam,
+    shouldFetchNextPage,
+    reduce
+  ) : void 0;
+  const infiniteNamespace = [...resolveKey(namespace, void 0), "infinite"];
+  const envelopeSelect = infiniteCrawlingFn ? (data) => ({
+    ...data,
+    pages: data.pages.map((e) => select ? select(e.data) : e.data)
+  }) : void 0;
+  const infiniteSelect = !infiniteCrawlingFn && select ? (data) => ({
+    ...data,
+    pages: data.pages.map(select)
+  }) : void 0;
   const factory = function(params, crawlOptions = {}) {
     const queryKey = resolveKey(namespace, params, crawlOptions);
-    const boundQueryFn = rawQueryFn ? (ctx) => rawQueryFn(params, ctx) : void 0;
-    const resolvedQueryFn = hasCrawling ? buildCrawlingQueryFn(boundQueryFn, getNextPageParam, initialPageParam, shouldFetchNextPage, reduce, crawlOptions) : boundQueryFn;
+    const resolvedQueryFn = crawlingFn ? (ctx) => crawlingFn(params, crawlOptions, ctx) : rawQueryFn ? (ctx) => rawQueryFn(params, ctx) : void 0;
     return {
       ...standardOptions,
       queryKey,
@@ -92,37 +124,25 @@ function buildFactory(cfg) {
     };
   };
   factory.infinite = function(params, crawlOptions = {}) {
-    const queryKey = resolveKey([...resolveKey(namespace, void 0), "infinite"], params, crawlOptions);
-    const boundQueryFn = rawQueryFn ? (ctx) => rawQueryFn(params, ctx) : void 0;
-    if (hasInfiniteCrawling) {
-      const crawlingQueryFn = buildInfiniteCrawlingQueryFn(
-        boundQueryFn,
-        getNextPageParam,
-        shouldFetchNextPage,
-        reduce,
-        crawlOptions
-      );
-      const envelopeGetNextPageParam = (envelope) => envelope.nextPageParam;
-      const envelopeSelect = (data) => ({
-        ...data,
-        pages: data.pages.map((e) => select ? select(e.data) : e.data)
-      });
+    const queryKey = resolveKey(infiniteNamespace, params, crawlOptions);
+    if (infiniteCrawlingFn) {
       return {
         ...standardOptions,
         queryKey,
-        queryFn: crawlingQueryFn,
-        getNextPageParam: envelopeGetNextPageParam,
+        queryFn: (ctx) => infiniteCrawlingFn(params, crawlOptions, ctx),
+        getNextPageParam: getEnvelopeNextPageParam,
         initialPageParam,
         select: envelopeSelect,
         ...getPreviousPageParam !== void 0 && { getPreviousPageParam },
         [FACTORY_CONFIG]: cfg
       };
     }
-    const infiniteGetNextPageParam = getNextPageParam && shouldFetchNextPage ? wrapGetNextPageParam(getNextPageParam, shouldFetchNextPage, crawlOptions, reduce) : getNextPageParam != null ? getNextPageParam : (() => void 0);
-    const infiniteSelect = select ? (data) => ({
-      ...data,
-      pages: data.pages.map(select)
-    }) : void 0;
+    const boundQueryFn = rawQueryFn ? (ctx) => rawQueryFn(params, ctx) : void 0;
+    const infiniteGetNextPageParam = getNextPageParam && shouldFetchNextPage ? wrapGetNextPageParam(
+      getNextPageParam,
+      shouldFetchNextPage,
+      crawlOptions
+    ) : getNextPageParam != null ? getNextPageParam : noNextPage;
     return {
       ...standardOptions,
       queryKey,
@@ -142,11 +162,16 @@ function queryFactory(configOrParent, childConfig) {
     const result = configOrParent();
     const parentCfg = result == null ? void 0 : result[FACTORY_CONFIG];
     if (!parentCfg) {
-      throw new Error("queryFactory: first argument must be a factory created by queryFactory()");
+      throw new Error(
+        "queryFactory: first argument must be a factory created by queryFactory()"
+      );
     }
     const hasNewQueryFn = childConfig.queryFn !== void 0;
     const childNamespace = childConfig.queryKey ? Array.isArray(childConfig.queryKey) ? childConfig.queryKey : [childConfig.queryKey] : [];
-    const composedNamespace = [...parentCfg.queryKey, ...childNamespace];
+    const composedNamespace = [
+      ...parentCfg.queryKey,
+      ...childNamespace
+    ];
     let resolvedSelect;
     if (hasNewQueryFn) {
       resolvedSelect = childConfig.select;
@@ -186,7 +211,10 @@ function queryFactory(configOrParent, childConfig) {
       queryFn: hasNewQueryFn ? childConfig.queryFn : parentCfg.queryFn,
       select: resolvedSelect,
       ...crawling,
-      standardOptions: { ...parentCfg.standardOptions, ...childStandardOptions }
+      standardOptions: {
+        ...parentCfg.standardOptions,
+        ...childStandardOptions
+      }
     });
   }
   const {

package/package.json

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