@orval/query 8.23.0 → 8.24.0

package/dist/index.mjs

@@ -1914,6 +1914,24 @@ const hasQueryParam = (queryParams, queryParam) => {
 	if (!queryParam || !queryParams) return false;
 	return queryParams.paramNames?.includes(queryParam) ?? true;
 };
+/**
+* When nothing is configured, infinite hooks stay allowed, just without a
+* page param. When candidates are configured but the operation declares none
+* of them, the infinite hook is suppressed so orval does not emit a useless
+* one for a non-paginated `GET`.
+*/
+const resolveInfiniteQueryParam = (queryParams, useInfiniteQueryParam) => {
+	const candidates = (Array.isArray(useInfiniteQueryParam) ? useInfiniteQueryParam : [useInfiniteQueryParam]).filter((name) => !!name);
+	if (candidates.length === 0) return {
+		queryParam: void 0,
+		infiniteHookAllowed: true
+	};
+	const queryParam = candidates.find((name) => hasQueryParam(queryParams, name));
+	return {
+		queryParam,
+		infiniteHookAllowed: queryParam !== void 0
+	};
+};
 const escapeRegExpMetaChars = (value) => value.replaceAll(/[.*+?^${}()|[\]\\]/g, String.raw`\$&`);
 /**
 * Wraps the body parameter's type in a property string with the mutator's
@@ -1983,7 +2001,8 @@ const renderSetQueryDataHelper = ({ doc, isReactQuery, fnName, propsSig, body })
 };
 /**
 * Renders the prop list shared by `getXxxQueryKey`, `setXxxQueryData` and
-* `getXxxQueryData` helpers: headers are dropped, path params stay required,
+* `getXxxQueryData` helpers: headers are dropped (unless `includeHeaders`
+* is set — key-mutator factories need them), path params stay required,
 * non-path params (query params, body) are passed through `widenNonPath`
 * (defaults to identity — pass `makeOptionalParam` or `allowUndefinedParam`
 * to relax the signature).
@@ -1991,8 +2010,8 @@ const renderSetQueryDataHelper = ({ doc, isReactQuery, fnName, propsSig, body })
 * Centralising this prevents the three call sites from drifting apart on
 * how they treat the same props.
 */
-const buildKeyShapedProps = ({ props, body, mutator, widenNonPath = (impl) => impl }) => wrapPropsBodyWithMutatorBodyType({
-	propsString: toObjectString(props.filter((prop) => prop.type !== GetterPropType.HEADER).map((prop) => ({
+const buildKeyShapedProps = ({ props, body, mutator, widenNonPath = (impl) => impl, includeHeaders = false }) => wrapPropsBodyWithMutatorBodyType({
+	propsString: toObjectString(props.filter((prop) => includeHeaders || prop.type !== GetterPropType.HEADER).map((prop) => ({
 		...prop,
 		implementation: prop.type === GetterPropType.PARAM || prop.type === GetterPropType.NAMED_PATH_PARAMS ? prop.implementation : widenNonPath(prop.implementation)
 	})), "implementation"),
@@ -2336,9 +2355,9 @@ const generateQueryHook = async (verbOptions, options, outputClient, adapter) =>
 	const effectiveUseMutation = operationQueryOptions?.useMutation ?? override.query.useMutation ?? verb !== Verbs.GET;
 	const globalSuspenseOrInfiniteOnlyForGet = (flag) => flag === true && verb === Verbs.GET;
 	const effectiveUseSuspenseQuery = operationQueryOptions?.useSuspenseQuery ?? globalSuspenseOrInfiniteOnlyForGet(override.query.useSuspenseQuery);
-	const hasConfiguredInfiniteQueryParam = !query.useInfiniteQueryParam || hasQueryParam(queryParams, query.useInfiniteQueryParam);
-	const effectiveUseInfinite = (operationQueryOptions?.useInfinite ?? globalSuspenseOrInfiniteOnlyForGet(override.query.useInfinite)) && hasConfiguredInfiniteQueryParam;
-	const effectiveUseSuspenseInfiniteQuery = (operationQueryOptions?.useSuspenseInfiniteQuery ?? globalSuspenseOrInfiniteOnlyForGet(override.query.useSuspenseInfiniteQuery)) && hasConfiguredInfiniteQueryParam;
+	const { queryParam: infiniteQueryParam, infiniteHookAllowed } = resolveInfiniteQueryParam(queryParams, operationQueryOptions?.useInfiniteQueryParam ?? query.useInfiniteQueryParam);
+	const effectiveUseInfinite = (operationQueryOptions?.useInfinite ?? globalSuspenseOrInfiniteOnlyForGet(override.query.useInfinite)) && infiniteHookAllowed;
+	const effectiveUseSuspenseInfiniteQuery = (operationQueryOptions?.useSuspenseInfiniteQuery ?? globalSuspenseOrInfiniteOnlyForGet(override.query.useSuspenseInfiniteQuery)) && infiniteHookAllowed;
 	let isQuery = effectiveUseQuery || effectiveUseSuspenseQuery || effectiveUseInfinite || effectiveUseSuspenseInfiniteQuery;
 	let isMutation = effectiveUseMutation;
 	if (verb !== Verbs.GET && isQuery) isMutation = false;
@@ -2377,7 +2396,7 @@ const generateQueryHook = async (verbOptions, options, outputClient, adapter) =>
 				typeName: camel(`${typeName}-infinite`),
 				options: query.options,
 				type: QueryType.INFINITE,
-				queryParam: query.useInfiniteQueryParam,
+				queryParam: infiniteQueryParam,
 				queryKeyFnName: camel(`get-${operationName}-infinite-query-key`)
 			}] : [],
 			...effectiveUseQuery ? [{
@@ -2399,7 +2418,7 @@ const generateQueryHook = async (verbOptions, options, outputClient, adapter) =>
 				typeName: camel(`${typeName}-suspense-infinite`),
 				options: query.options,
 				type: QueryType.SUSPENSE_INFINITE,
-				queryParam: query.useInfiniteQueryParam,
+				queryParam: infiniteQueryParam,
 				queryKeyFnName: camel(`get-${operationName}-infinite-query-key`)
 			}] : []
 		];
@@ -2431,6 +2450,19 @@ ${override.query.shouldExportQueryKey ? "export " : ""}const ${queryOption.query
 			].filter((x) => !!x).join(", ")}
     ]${override.query.shouldFilterQueryKey ? `.filter(${override.query.queryKeyFilter ?? "q => q !== undefined"})` : " as const"};
     }
+`;
+		}
+		else if (override.query.shouldExportQueryKey) for (const queryOption of uniqueQueryOptionsByKeys) {
+			const queryKeyProps = buildKeyShapedProps({
+				props,
+				body,
+				mutator,
+				widenNonPath: makeOptionalParam,
+				includeHeaders: true
+			});
+			queryKeyFns += `
+export const ${queryOption.queryKeyFnName} = (${queryKeyProps}) =>
+    ${queryKeyMutator.name}({ ${queryProperties} }${queryKeyMutator.hasSecondArg ? `, { url: \`${route}\` }` : ""});
 `;
 		}
 		implementation += `