@orval/query 8.12.3 → 8.14.0

package/dist/index.mjs

@@ -23,6 +23,7 @@ const normalizeQueryOptions = (queryOptions = {}, outputWorkspace) => {
 		...queryOptions.signal ? { signal: true } : {},
 		...queryOptions.shouldExportMutatorHooks ? { shouldExportMutatorHooks: true } : {},
 		...queryOptions.shouldExportQueryKey ? { shouldExportQueryKey: true } : {},
+		...queryOptions.shouldFilterQueryKey ? { shouldFilterQueryKey: true } : {},
 		...queryOptions.shouldExportHttpClient ? { shouldExportHttpClient: true } : {},
 		...queryOptions.shouldSplitQueryKey ? { shouldSplitQueryKey: true } : {},
 		...queryOptions.useOperationIdAsQueryKey ? { useOperationIdAsQueryKey: true } : {}
@@ -1794,6 +1795,10 @@ const getMutationInvalidatesConflictWarning = ({ operationName, isMutation, isQu
 	if (!mutationInvalidates.find((rule) => rule.onMutations.includes(operationName))) return void 0;
 	return `mutationInvalidates rule references '${operationName}', but that operation is generated as a ${isQuery ? "Query hook" : "plain function (no hook)"}, not a Mutation. The invalidation will not fire. Either remove '${operationName}' from the rule's onMutations list, or configure '${operationName}' so that it is generated as a Mutation hook.`;
 };
+const hasQueryParam = (queryParams, queryParam) => {
+	if (!queryParam || !queryParams) return false;
+	return queryParams.paramNames?.includes(queryParam) ?? true;
+};
 const escapeRegExpMetaChars = (value) => value.replaceAll(/[.*+?^${}()|[\]\\]/g, String.raw`\$&`);
 /**
 * Wraps the body parameter's type in a property string with the mutator's
@@ -1928,7 +1933,7 @@ const generatePrefetch = ({ usePrefetch, type, useQuery, useInfinite, operationN
   return queryClient;
 }\n`;
 };
-const generateQueryImplementation = ({ queryOption: { name, queryParam, options, type, queryKeyFnName }, operationName, queryProperties, queryKeyProperties, queryParams, params, props, body, mutator, queryOptionsMutator, queryKeyMutator, isRequestOptions, response, httpClient, isExactOptionalPropertyTypes, hasSignal, useRuntimeFetcher, route, doc, usePrefetch, useQuery, useInfinite, useInvalidate, useSetQueryData, useGetQueryData, adapter }) => {
+const generateQueryImplementation = ({ queryOption: { name, queryParam, options, type, queryKeyFnName }, operationId, operationName, queryProperties, queryKeyProperties, queryParams, params, props, body, mutator, queryOptionsMutator, queryKeyMutator, isRequestOptions, response, httpClient, isExactOptionalPropertyTypes, hasSignal, useRuntimeFetcher, route, doc, usePrefetch, useQuery, useInfinite, useInvalidate, useSetQueryData, useGetQueryData, adapter }) => {
 	const { hasQueryV5, hasQueryV5WithDataTagError, hasQueryV5WithInfiniteQueryOptionsError } = adapter;
 	const hasSignalParam = props.some((prop) => prop.name === "signal");
 	const queryPropDefinitions = wrapPropsBodyWithMutatorBodyType({
@@ -1954,7 +1959,8 @@ const generateQueryImplementation = ({ queryOption: { name, queryParam, options,
 		body,
 		mutator
 	});
-	const hasInfiniteQueryParam = queryParam && queryParams?.schema.name;
+	const infiniteQueryParamType = hasQueryParam(queryParams, queryParam) && queryParams && queryParam ? `${queryParams.schema.name}['${queryParam}']` : "";
+	const hasInfiniteQueryParam = !!infiniteQueryParamType;
 	const httpFunctionProps = queryParam ? adapter.getInfiniteQueryHttpProps(props, queryParam, httpClient, !!mutator) : adapter.getHttpFunctionQueryProps(queryProperties, httpClient, !!mutator);
 	const definedInitialDataReturnType = adapter.getQueryReturnType({
 		type,
@@ -2062,7 +2068,7 @@ const generateQueryImplementation = ({ queryOption: { name, queryParam, options,
 	const queryOptionsFnName = camel(queryKeyMutator || queryOptionsMutator || mutator?.isHook ? `use-${name}-queryOptions` : `get-${name}-queryOptions`);
 	const queryOptionsVarName = isRequestOptions ? "queryOptions" : "options";
 	const queryResultVarName = props.some((prop) => prop.name === "query") ? "_query" : "query";
-	const infiniteParam = queryParams && queryParam ? `, ${queryParams.schema.name}['${queryParam}']` : "";
+	const infiniteParam = infiniteQueryParamType ? `, ${infiniteQueryParamType}` : "";
 	const TData = hasQueryV5 && (type === QueryType.INFINITE || type === QueryType.SUSPENSE_INFINITE) ? `InfiniteData<Awaited<ReturnType<${dataType}>>${infiniteParam}>` : `Awaited<ReturnType<${dataType}>>`;
 	const queryOptionsFn = `export const ${queryOptionsFnName} = <TData = ${TData}, TError = ${errorType}>(${adapter.getHttpFirstParam(mutator)}${queryProps} ${queryArgumentsForOptions}) => {
 
@@ -2072,11 +2078,11 @@ ${hookOptions}
 
   ${mutator?.isHook ? `const ${operationName} =  use${pascal(operationName)}Hook();` : ""}
 
-    const queryFn: QueryFunction<Awaited<ReturnType<${mutator?.isHook ? `ReturnType<typeof use${pascal(operationName)}Hook>` : `typeof ${operationName}`}>>${hasQueryV5 && hasInfiniteQueryParam ? `, QueryKey, ${queryParams.schema.name}['${queryParam}']` : ""}> = (${queryFnArguments}) => ${operationName}(${httpFunctionProps}${httpFunctionProps ? ", " : ""}${queryOptions});
+    const queryFn: QueryFunction<Awaited<ReturnType<${mutator?.isHook ? `ReturnType<typeof use${pascal(operationName)}Hook>` : `typeof ${operationName}`}>>${hasQueryV5 && hasInfiniteQueryParam ? `, QueryKey, ${infiniteQueryParamType}` : ""}> = (${queryFnArguments}) => ${operationName}(${httpFunctionProps}${httpFunctionProps ? ", " : ""}${queryOptions});
 
       ${adapter.getUnrefStatements(props)}
 
-      ${queryOptionsMutator ? `const customOptions = ${queryOptionsMutator.name}({ queryKey, queryFn, ${queryOptionsImp}}${queryOptionsMutator.hasSecondArg ? `, { ${queryProperties} }` : ""}${queryOptionsMutator.hasThirdArg ? `, { url: \`${route}\` }` : ""});` : ""}
+      ${queryOptionsMutator ? `const customOptions = ${queryOptionsMutator.name}({ queryKey, queryFn, ${queryOptionsImp}}${queryOptionsMutator.hasSecondArg ? `, { ${queryProperties} }` : ""}${queryOptionsMutator.hasThirdArg ? `, { url: \`${route}\`, operationId: '${operationId}', operationName: '${operationName}' }` : ""});` : ""}
 
    return  ${queryOptionsMutator ? "customOptions" : `{ queryKey, queryFn, ${queryOptionsImp}}`}${adapter.shouldCastQueryOptions?.() === false ? "" : ` as ${queryOptionFnReturnType} ${adapter.shouldAnnotateQueryKey() ? `& { queryKey: ${hasQueryV5 ? `DataTag<QueryKey, TData${hasQueryV5WithDataTagError ? ", TError" : ""}>` : "QueryKey"} }` : ""}`}
 }`;
@@ -2107,7 +2113,7 @@ export function ${queryHookName}<TData = ${TData}, TError = ${errorType}>(\n ${q
 	const prefetch = adapter.generatePrefetch ? adapter.generatePrefetch(prefetchContext) : generatePrefetch(prefetchContext);
 	const isPrimaryQueryType = type === QueryType.QUERY || type === QueryType.INFINITE || type === QueryType.SUSPENSE_QUERY && !useQuery || type === QueryType.SUSPENSE_INFINITE && !useInfinite;
 	const buildBaseQueryKeyExpr = () => queryKeyMutator ? `${queryKeyMutator.name}({ ${queryProperties} }${queryKeyMutator.hasSecondArg ? `, { url: \`${route}\` }` : ""})` : `${queryKeyFnName}(${queryKeyProperties})`;
-	const applyQueryOptionsMutator = (baseExpr) => queryOptionsMutator && !queryOptionsMutator.isHook ? `${queryOptionsMutator.name}({ queryKey: ${baseExpr} }${queryOptionsMutator.hasSecondArg ? `, { ${queryProperties} }` : ""}${queryOptionsMutator.hasThirdArg ? `, { url: \`${route}\` }` : ""}).queryKey` : baseExpr;
+	const applyQueryOptionsMutator = (baseExpr) => queryOptionsMutator && !queryOptionsMutator.isHook ? `${queryOptionsMutator.name}({ queryKey: ${baseExpr} }${queryOptionsMutator.hasSecondArg ? `, { ${queryProperties} }` : ""}${queryOptionsMutator.hasThirdArg ? `, { url: \`${route}\`, operationId: '${operationId}', operationName: '${operationName}' }` : ""}).queryKey` : baseExpr;
 	const hasHookMutator = !!queryOptionsMutator?.isHook;
 	if (hasHookMutator && (useSetQueryData || useGetQueryData)) logWarning(`'${name}' has a hook-based queryOptions mutator, so the requested set/get-query-data helpers were skipped to avoid a cache-key mismatch with the query hook.`);
 	const shouldGenerateInvalidate = useInvalidate && isPrimaryQueryType;
@@ -2215,8 +2221,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 effectiveUseInfinite = operationQueryOptions?.useInfinite ?? globalSuspenseOrInfiniteOnlyForGet(override.query.useInfinite);
-	const effectiveUseSuspenseInfiniteQuery = operationQueryOptions?.useSuspenseInfiniteQuery ?? globalSuspenseOrInfiniteOnlyForGet(override.query.useSuspenseInfiniteQuery);
+	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;
 	let isQuery = effectiveUseQuery || effectiveUseSuspenseQuery || effectiveUseInfinite || effectiveUseSuspenseInfiniteQuery;
 	let isMutation = effectiveUseMutation;
 	if (verb !== Verbs.GET && isQuery) isMutation = false;
@@ -2303,7 +2310,7 @@ ${override.query.shouldExportQueryKey ? "export " : ""}const ${queryOption.query
 				queryKeyParams,
 				body.implementation
 			].filter((x) => !!x).join(", ")}
-    ] as const;
+    ]${override.query.shouldFilterQueryKey ? ".filter(Boolean)" : " as const"};
     }
 `;
 		}
@@ -2312,6 +2319,7 @@ ${queryKeyFns}`;
 		let queryImplementations = "";
 		for (const queryOption of queries) queryImplementations += generateQueryImplementation({
 			queryOption,
+			operationId,
 			operationName,
 			queryProperties,
 			queryKeyProperties,