@orval/query 8.10.0 → 8.11.0

package/dist/index.mjs

@@ -704,8 +704,11 @@ const VUE_QUERY_DEPENDENCIES = [{
 	],
 	dependency: "vue"
 }];
-const getSolidQueryImports = (prefix) => {
+const getSolidQueryImports = (prefix, hasRenamedOptionsTypes) => {
 	const capitalized = prefix === "use" ? "Use" : "Create";
+	const queryOptionsTypeName = hasRenamedOptionsTypes ? "QueryOptions" : "SolidQueryOptions";
+	const infiniteQueryOptionsTypeName = hasRenamedOptionsTypes ? "InfiniteQueryOptions" : "SolidInfiniteQueryOptions";
+	const mutationOptionsTypeName = hasRenamedOptionsTypes ? "MutationOptions" : "SolidMutationOptions";
 	return [{
 		exports: [
 			{
@@ -722,10 +725,9 @@ const getSolidQueryImports = (prefix) => {
 			},
 			{ name: `${capitalized}QueryOptions` },
 			{ name: `${capitalized}InfiniteQueryOptions` },
-			{ name: `${capitalized}MutationOptions` },
-			{ name: "SolidQueryOptions" },
-			{ name: "SolidInfiniteQueryOptions" },
-			{ name: "SolidMutationOptions" },
+			{ name: queryOptionsTypeName },
+			{ name: infiniteQueryOptionsTypeName },
+			{ name: mutationOptionsTypeName },
 			{ name: "QueryFunction" },
 			{ name: "MutationFunction" },
 			{ name: `${capitalized}QueryResult` },
@@ -806,7 +808,7 @@ const getSolidQueryDependencies = (hasGlobalMutator, hasParamsSerializerOptions,
 	return [
 		...!hasGlobalMutator && httpClient === OutputHttpClient.AXIOS ? AXIOS_DEPENDENCIES : [],
 		...hasParamsSerializerOptions ? PARAMS_SERIALIZER_DEPENDENCIES : [],
-		...getSolidQueryImports(isSolidQueryWithUsePrefix(packageJson) ? "use" : "create")
+		...getSolidQueryImports(isSolidQueryWithUsePrefix(packageJson) ? "use" : "create", isSolidQueryWithRenamedOptionsTypes(packageJson))
 	];
 };
 const getAngularQueryDependencies = (hasGlobalMutator, hasParamsSerializerOptions, packageJson, httpClient) => {
@@ -864,6 +866,25 @@ const isSolidQueryWithUsePrefix = (packageJson) => {
 	const withoutRc = version.split("-")[0];
 	return compareVersions(withoutRc, "5.71.5");
 };
+/**
+* Solid Query renamed its plain options interfaces in v5.100.6, dropping the
+* `Solid` prefix:
+*   - `SolidQueryOptions` → `QueryOptions`
+*   - `SolidInfiniteQueryOptions` → `InfiniteQueryOptions`
+*   - `SolidMutationOptions` → `MutationOptions`
+*
+* The Accessor wrappers `UseQueryOptions` / `UseInfiniteQueryOptions` /
+* `UseMutationOptions` keep the same names but reference the renamed
+* interfaces internally.
+*
+* https://github.com/TanStack/query/commit/<rename-commit>
+*/
+const isSolidQueryWithRenamedOptionsTypes = (packageJson) => {
+	const version = getPackageByQueryClient(packageJson, "solid-query");
+	if (!version) return false;
+	const withoutRc = version.split("-")[0];
+	return compareVersions(withoutRc, "5.100.6");
+};
 const getPackageByQueryClient = (packageJson, queryClient) => {
 	switch (queryClient) {
 		case "react-query": {
@@ -925,7 +946,7 @@ const getQueryOptionsDefinition = ({ operationName, mutator, definitions, type,
 		const optionType = optionsTypeName ? `${optionsTypeName}<${funcReturnType}, TError, TData${hasQueryV5 && (type === QueryType.INFINITE || type === QueryType.SUSPENSE_INFINITE) && queryParam && queryParams ? `, QueryKey, ${queryParams.schema.name}['${queryParam}']` : ""}>` : `${prefix}${pascal(type)}Options<${funcReturnType}, TError, TData${hasQueryV5 && (type === QueryType.INFINITE || type === QueryType.SUSPENSE_INFINITE) && queryParam && queryParams ? hasQueryV5WithInfiniteQueryOptionsError ? `, QueryKey, ${queryParams.schema.name}['${queryParam}']` : `, ${funcReturnType}, QueryKey, ${queryParams.schema.name}['${queryParam}']` : ""}>`;
 		return `${partialOptions ? "Partial<" : ""}${optionType}${partialOptions ? ">" : ""}${optionTypeInitialDataPostfix}`;
 	}
-	const mutationOptionsTypeName = isReturnType && adapter?.getOptionsReturnTypeName ? adapter.getOptionsReturnTypeName("mutation") : void 0;
+	const mutationOptionsTypeName = adapter?.getOptionsReturnTypeName ? adapter.getOptionsReturnTypeName("mutation") : void 0;
 	return mutationOptionsTypeName ? `${mutationOptionsTypeName}<Awaited<ReturnType<${isMutatorHook ? `ReturnType<typeof use${pascal(operationName)}Hook>` : `typeof ${operationName}`}>>, TError,${definitions ? `{${definitions}}` : "void"}, TContext>` : `${prefix}MutationOptions<Awaited<ReturnType<${isMutatorHook ? `ReturnType<typeof use${pascal(operationName)}Hook>` : `typeof ${operationName}`}>>, TError,${definitions ? `{${definitions}}` : "void"}, TContext>`;
 };
 //#endregion
@@ -1110,7 +1131,7 @@ const createReactAdapter = ({ hasQueryV5, hasQueryV5WithDataTagError, hasQueryV5
 });
 //#endregion
 //#region src/frameworks/solid.ts
-const createSolidAdapter = ({ hasQueryV5, hasQueryV5WithDataTagError, hasQueryV5WithInfiniteQueryOptionsError, hasQueryV5WithMutationContextOnSuccess, hasQueryV5WithRequiredContextOnSuccess, hasSolidQueryUsePrefix }) => ({
+const createSolidAdapter = ({ hasQueryV5, hasQueryV5WithDataTagError, hasQueryV5WithInfiniteQueryOptionsError, hasQueryV5WithMutationContextOnSuccess, hasQueryV5WithRequiredContextOnSuccess, hasSolidQueryUsePrefix, hasSolidQueryRenamedOptionsTypes }) => ({
 	outputClient: OutputClient.SOLID_QUERY,
 	hookPrefix: hasSolidQueryUsePrefix ? "use" : "create",
 	hasQueryV5,
@@ -1122,9 +1143,9 @@ const createSolidAdapter = ({ hasQueryV5, hasQueryV5WithDataTagError, hasQueryV5
 		return hasSolidQueryUsePrefix ? "Use" : "Create";
 	},
 	getOptionsReturnTypeName(type) {
-		if (type === "mutation") return "SolidMutationOptions";
-		if (type === "infiniteQuery") return "SolidInfiniteQueryOptions";
-		return "SolidQueryOptions";
+		if (type === "mutation") return hasSolidQueryRenamedOptionsTypes ? "MutationOptions" : "SolidMutationOptions";
+		if (type === "infiniteQuery") return hasSolidQueryRenamedOptionsTypes ? "InfiniteQueryOptions" : "SolidInfiniteQueryOptions";
+		return hasSolidQueryRenamedOptionsTypes ? "QueryOptions" : "SolidQueryOptions";
 	},
 	getQueryKeyPrefix() {
 		return "";
@@ -1417,7 +1438,8 @@ const withDefaults = (adapter) => ({
 			queryParams,
 			queryParam,
 			isReturnType: false,
-			initialData
+			initialData,
+			adapter
 		});
 		if (!isRequestOptions) return `${type ? "queryOptions" : "mutationOptions"}${initialData === "defined" ? "" : "?"}: ${definition}`;
 		const requestType = getQueryArgumentsRequestType(httpClient, mutator, useRuntimeFetcher);
@@ -1495,7 +1517,8 @@ const createFrameworkAdapter = ({ outputClient, packageJson, queryVersion }) =>
 			hasQueryV5WithInfiniteQueryOptionsError: _hasQueryV5WithInfiniteQueryOptionsError,
 			hasQueryV5WithMutationContextOnSuccess: _hasQueryV5WithMutationContextOnSuccess,
 			hasQueryV5WithRequiredContextOnSuccess: _hasQueryV5WithRequiredContextOnSuccess,
-			hasSolidQueryUsePrefix: isSolidQueryWithUsePrefix(packageJson)
+			hasSolidQueryUsePrefix: isSolidQueryWithUsePrefix(packageJson),
+			hasSolidQueryRenamedOptionsTypes: isSolidQueryWithRenamedOptionsTypes(packageJson)
 		}));
 		default: return withDefaults(createReactAdapter({
 			hasQueryV5: _hasQueryV5,
@@ -1802,6 +1825,62 @@ const wrapPropsBodyWithMutatorBodyType = ({ propsString, body, mutator }) => {
 	return propsString.replace(new RegExp(String.raw`(\w+\??:\s*(?:undefined\s*\|\s*)?)${bodyDefinitionPattern}`), `$1${mutator.bodyTypeName}<${body.definition}>`);
 };
 /**
+* Widens a parameter signature to be optional. Skips params that already
+* carry a default value (`= ...`), since those are syntactically optional
+* and adding `?` on top would be a TypeScript error.
+*/
+const makeOptionalParam = (impl) => {
+	if (impl.includes("=")) return impl;
+	return impl.replace(/^(\w+):\s*/, "$1?: ");
+};
+/**
+* Widens a parameter type to also accept `undefined`. Already-optional
+* (`?:`) signatures are normalized to required-with-undefined, and params
+* with a default value pass through unchanged.
+*/
+const allowUndefinedParam = (impl) => {
+	if (impl.includes("=")) return impl;
+	const optional = /^(\w+)\?:\s*(.+)$/.exec(impl);
+	if (optional) return `${optional[1]}: ${optional[2]} | undefined`;
+	return impl.replace(/^(\w+):\s*(.+)$/, "$1: $2 | undefined");
+};
+/**
+* Renders the `setXxxQueryData` helper as either a React hook (returns a
+* setter) or a plain function taking `queryClient`. Both shapes share the
+* same body and signature, so this collapses what would otherwise be two
+* near-identical template literals.
+*/
+const renderSetQueryDataHelper = ({ doc, isReactQuery, fnName, propsSig, body }) => {
+	const docPrefix = doc ?? "";
+	if (isReactQuery) return `${docPrefix}export const ${fnName} = () => {
+  const queryClient = useQueryClient();
+  return (${propsSig}) => {
+    ${body}
+  };
+}\n`;
+	return `${docPrefix}export const ${fnName} = (queryClient: QueryClient, ${propsSig}) => {
+  ${body}
+}\n`;
+};
+/**
+* Renders the prop list shared by `getXxxQueryKey`, `setXxxQueryData` and
+* `getXxxQueryData` helpers: headers are dropped, 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).
+*
+* 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) => ({
+		...prop,
+		implementation: prop.type === GetterPropType.PARAM || prop.type === GetterPropType.NAMED_PATH_PARAMS ? prop.implementation : widenNonPath(prop.implementation)
+	})), "implementation"),
+	body,
+	mutator
+});
+/**
 * Computes a verb prefix segment for query keys when a non-GET operation is
 * routed to a Query hook. Without this prefix, two operations sharing a path
 * (e.g. `GET /pets` and `POST /pets`) would generate cache keys that both
@@ -2030,22 +2109,28 @@ export function ${queryHookName}<TData = ${TData}, TError = ${errorType}>(\n ${q
 	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 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;
 	const invalidateFnName = camel(`invalidate-${name}`);
 	const invalidateQueryKeyExpr = applyQueryOptionsMutator(buildBaseQueryKeyExpr());
-	const shouldGenerateSetQueryData = useSetQueryData && isPrimaryQueryType;
+	const shouldGenerateSetQueryData = useSetQueryData && isPrimaryQueryType && !hasHookMutator;
 	const isReactQuery = adapter.outputClient === OutputClient.REACT_QUERY;
 	const setQueryDataFnName = isReactQuery ? camel(`use-set-${name}-query-data`) : camel(`set-${name}-query-data`);
-	const setQueryDataKeyExpr = buildBaseQueryKeyExpr();
-	const setQueryDataProps = wrapPropsBodyWithMutatorBodyType({
-		propsString: toObjectString(props.filter((prop) => prop.type !== GetterPropType.HEADER), "implementation").replaceAll("?:", ":"),
+	const setQueryDataKeyExpr = applyQueryOptionsMutator(buildBaseQueryKeyExpr());
+	const setQueryDataProps = buildKeyShapedProps({
+		props,
 		body,
-		mutator
+		mutator,
+		widenNonPath: allowUndefinedParam
 	});
-	const shouldGenerateGetQueryData = useGetQueryData && isPrimaryQueryType;
+	const shouldGenerateGetQueryData = useGetQueryData && isPrimaryQueryType && !hasHookMutator;
 	const getQueryDataFnName = isReactQuery ? camel(`use-get-${name}-query-data`) : camel(`get-${name}-query-data`);
-	const getQueryDataKeyExpr = setQueryDataKeyExpr;
-	const getQueryDataProps = setQueryDataProps;
+	const getQueryDataProps = buildKeyShapedProps({
+		props,
+		body,
+		mutator
+	});
 	const queryInit = adapter.generateQueryInit({
 		queryOptionsFnName,
 		queryProperties,
@@ -2096,20 +2181,19 @@ ${shouldGenerateInvalidate ? `${doc}export const ${invalidateFnName} = async (\n
 
   return queryClient;
 }\n` : ""}
-${shouldGenerateSetQueryData ? isReactQuery ? `${doc}export const ${setQueryDataFnName} = () => {
-  const queryClient = useQueryClient();
-  return (${setQueryDataProps}updater: ${TData} | undefined | ((old: ${TData} | undefined) => ${TData} | undefined)) => {
-    queryClient.setQueryData(${setQueryDataKeyExpr}, updater);
-  };
-}\n` : `${doc}export const ${setQueryDataFnName} = (queryClient: QueryClient, ${setQueryDataProps}updater: ${TData} | undefined | ((old: ${TData} | undefined) => ${TData} | undefined)) => {
-  queryClient.setQueryData(${setQueryDataKeyExpr}, updater);
-}\n` : ""}
+${shouldGenerateSetQueryData ? renderSetQueryDataHelper({
+		doc,
+		isReactQuery,
+		fnName: setQueryDataFnName,
+		propsSig: `${setQueryDataProps}updater: ${TData} | undefined | ((old: ${TData} | undefined) => ${TData} | undefined)`,
+		body: `queryClient.setQueriesData<${TData}>({ queryKey: ${setQueryDataKeyExpr} }, updater);`
+	}) : ""}
 ${shouldGenerateGetQueryData ? isReactQuery ? `${doc}export const ${getQueryDataFnName} = () => {
   const queryClient = useQueryClient();
   return (${getQueryDataProps}) =>
-    queryClient.getQueryData<${TData}>(${getQueryDataKeyExpr});
+    queryClient.getQueryData<${TData}>(${setQueryDataKeyExpr});
 }\n` : `${doc}export const ${getQueryDataFnName} = (queryClient: QueryClient, ${getQueryDataProps}) =>
-  queryClient.getQueryData<${TData}>(${getQueryDataKeyExpr});\n` : ""}
+  queryClient.getQueryData<${TData}>(${setQueryDataKeyExpr});\n` : ""}
 `;
 };
 const generateQueryHook = async (verbOptions, options, outputClient, adapter) => {
@@ -2135,7 +2219,7 @@ const generateQueryHook = async (verbOptions, options, outputClient, adapter) =>
 	const effectiveUseInfinite = operationQueryOptions?.useInfinite ?? globalSuspenseOrInfiniteOnlyForGet(override.query.useInfinite);
 	const effectiveUseSuspenseInfiniteQuery = operationQueryOptions?.useSuspenseInfiniteQuery ?? globalSuspenseOrInfiniteOnlyForGet(override.query.useSuspenseInfiniteQuery);
 	let isQuery = effectiveUseQuery || effectiveUseSuspenseQuery || effectiveUseInfinite || effectiveUseSuspenseInfiniteQuery;
-	let isMutation = effectiveUseMutation && verb !== Verbs.GET;
+	let isMutation = effectiveUseMutation;
 	if (verb !== Verbs.GET && isQuery) isMutation = false;
 	if (verb === Verbs.GET && isMutation) isQuery = false;
 	const conflictWarning = getMutationInvalidatesConflictWarning({
@@ -2197,17 +2281,11 @@ const generateQueryHook = async (verbOptions, options, outputClient, adapter) =>
 		const uniqueQueryOptionsByKeys = queries.filter((obj, index, self) => index === self.findIndex((t) => t.queryKeyFnName === obj.queryKeyFnName));
 		let queryKeyFns = "";
 		if (!queryKeyMutator) for (const queryOption of uniqueQueryOptionsByKeys) {
-			const makeOptionalParam = (impl) => {
-				if (impl.includes("=")) return impl;
-				return impl.replace(/^(\w+):\s*/, "$1?: ");
-			};
-			const queryKeyProps = wrapPropsBodyWithMutatorBodyType({
-				propsString: toObjectString(props.filter((prop) => prop.type !== GetterPropType.HEADER).map((prop) => ({
-					...prop,
-					implementation: prop.type === GetterPropType.PARAM || prop.type === GetterPropType.NAMED_PATH_PARAMS ? prop.implementation : makeOptionalParam(prop.implementation)
-				})), "implementation"),
+			const queryKeyProps = buildKeyShapedProps({
+				props,
 				body,
-				mutator
+				mutator,
+				widenNonPath: makeOptionalParam
 			});
 			const routeString = adapter.getQueryKeyRouteString(route, !!override.query.shouldSplitQueryKey);
 			const queryKeyIdentifier = override.query.useOperationIdAsQueryKey ? `"${operationName}"` : routeString;