@orval/query 8.16.0 → 8.18.0

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { GetterPropType, OutputClient, OutputHttpClient, Verbs, camel, compareVersions, generateFormDataAndUrlEncodedFunction, generateMutator, generateMutatorConfig, generateMutatorRequestOptions, generateOptions, generateVerbImports, getAngularFilteredParamsCallExpression, getAngularFilteredParamsHelperBody, getRouteAsArray, getSuccessResponseType, isObject, isString, isSyntheticDefaultImportsAllow, jsDoc, kebab, logWarning, makeRouteSafe, mergeDeep, pascal, stringify, toObjectString } from "@orval/core";
+import { GetterPropType, OutputClient, OutputHttpClient, Verbs, camel, compareVersions, generateFormDataAndUrlEncodedFunction, generateMutator, generateMutatorConfig, generateMutatorRequestOptions, generateOptions, generateVerbImports, getAngularFilteredParamsCallExpression, getAngularFilteredParamsHelperBody, getFullRoute, getRouteAsArray, getSuccessResponseType, isObject, isString, isSyntheticDefaultImportsAllow, jsDoc, kebab, logWarning, makeRouteSafe, mergeDeep, pascal, stringify, toObjectString } from "@orval/core";
 import { generateFetchHeader, generateRequestFunction } from "@orval/fetch";
 import nodePath from "node:path";
 import { styleText } from "node:util";
@@ -680,11 +680,16 @@ const VUE_QUERY_DEPENDENCIES = [{
 			name: "useMutation",
 			values: true
 		},
+		{
+			name: "useQueryClient",
+			values: true
+		},
 		{ name: "UseQueryOptions" },
 		{ name: "UseInfiniteQueryOptions" },
 		{ name: "UseMutationOptions" },
 		{ name: "QueryFunction" },
 		{ name: "MutationFunction" },
+		{ name: "MutationFunctionContext" },
 		{ name: "QueryKey" },
 		{ name: "UseQueryReturnType" },
 		{ name: "UseInfiniteQueryReturnType" },
@@ -1122,7 +1127,7 @@ const createReactAdapter = ({ hasQueryV5, hasQueryV5WithDataTagError, hasQueryV5
       >`;
 	},
 	getQueryReturnStatement({ queryResultVarName, queryOptionsVarName }) {
-		return `return { ...${queryResultVarName}, queryKey: ${queryOptionsVarName}.queryKey };`;
+		return `return withQueryKey(${queryResultVarName}, ${queryOptionsVarName}.queryKey);`;
 	},
 	shouldGenerateOverrideTypes() {
 		return hasQueryV5;
@@ -1371,17 +1376,39 @@ const createVueAdapter = ({ hasVueQueryV4, hasQueryV5, hasQueryV5WithDataTagErro
 	getQueryKeyPrefix() {
 		return hasVueQueryV4 ? "" : "queryOptions?.queryKey ?? ";
 	},
-	generateMutationImplementation({ mutationOptionsFnName, isRequestOptions }) {
-		return `${mutationOptionsFnName}(${isRequestOptions ? "options" : "mutationOptions"})`;
+	generateMutationImplementation({ mutationOptionsFnName, hasInvalidation, isRequestOptions }) {
+		return `${mutationOptionsFnName}(${hasInvalidation ? `queryClient ?? backupQueryClient, ` : ""}${isRequestOptions ? "options" : "mutationOptions"})`;
 	},
 	supportsMutationInvalidation() {
-		return false;
+		return hasQueryV5;
 	},
-	generateMutationOnSuccess() {
-		return "";
+	generateMutationOnSuccess({ operationName, definitions, isRequestOptions, generateInvalidateCall, uniqueInvalidates }) {
+		const invalidateCalls = uniqueInvalidates.map((t) => generateInvalidateCall(t)).join("\n");
+		if (hasQueryV5WithMutationContextOnSuccess) {
+			if (isRequestOptions) return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${definitions ? `{${definitions}}` : "void"}, onMutateResult: TContext, context: MutationFunctionContext) => {
+        if (!options?.skipInvalidation) {
+    ${invalidateCalls}
+        }
+        unref(unref(typeof mutationOptions === 'function' ? mutationOptions() : mutationOptions)?.onSuccess)?.(data, variables, onMutateResult, context);
+      };`;
+			return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${definitions ? `{${definitions}}` : "void"}, onMutateResult: TContext, context: MutationFunctionContext) => {
+    ${invalidateCalls}
+        unref(unref(typeof mutationOptions === 'function' ? mutationOptions() : mutationOptions)?.onSuccess)?.(data, variables, onMutateResult, context);
+      };`;
+		}
+		if (isRequestOptions) return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${definitions ? `{${definitions}}` : "void"}, context: TContext${hasQueryV5WithRequiredContextOnSuccess ? "" : " | undefined"}) => {
+        if (!options?.skipInvalidation) {
+    ${invalidateCalls}
+        }
+        unref(unref(typeof mutationOptions === 'function' ? mutationOptions() : mutationOptions)?.onSuccess)?.(data, variables, context);
+      };`;
+		return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${definitions ? `{${definitions}}` : "void"}, context: TContext${hasQueryV5WithRequiredContextOnSuccess ? "" : " | undefined"}) => {
+    ${invalidateCalls}
+        unref(unref(typeof mutationOptions === 'function' ? mutationOptions() : mutationOptions)?.onSuccess)?.(data, variables, context);
+      };`;
 	},
-	generateMutationHookBody({ operationPrefix, mutationImplementation, optionalQueryClientArgument }) {
-		return `      return ${operationPrefix}Mutation(${mutationImplementation}${optionalQueryClientArgument ? `, queryClient` : ""});`;
+	generateMutationHookBody({ operationPrefix, mutationImplementation, hasInvalidation, optionalQueryClientArgument }) {
+		return `      ${hasInvalidation ? `const backupQueryClient = useQueryClient();\n      ` : ""}return ${operationPrefix}Mutation(${mutationImplementation}${optionalQueryClientArgument ? `, queryClient` : ""});`;
 	},
 	generateRequestFunction(verbOptions, options) {
 		return options.context.output.httpClient === OutputHttpClient.AXIOS ? generateAxiosRequestFunction(verbOptions, options, true) : generateRequestFunction(verbOptions, options);
@@ -1661,10 +1688,18 @@ const generateParamArgs = (params) => {
 	return Object.values(params).map((v) => generateParamArg(v)).join(", ");
 };
 /**
+* Build the code-literal form of a static route prefix for use inside a
+* `.startsWith(...)` predicate. A prefix derived from a runtime `baseUrl`
+* contains a `${...}` interpolation, so it must be emitted as a template
+* literal; otherwise a plain single-quoted string is enough and keeps the
+* output byte-identical to the no-baseUrl case.
+*/
+const toPrefixLiteral = (prefix) => prefix.includes("${") ? `\`${prefix}\`` : `'${prefix}'`;
+/**
 * Create a generateInvalidateCall function that has access to the OpenAPI spec
 * for intelligent route-based invalidation when params are not specified.
 */
-const createGenerateInvalidateCall = (spec, shouldSplitQueryKey, useOperationIdAsQueryKey) => {
+const createGenerateInvalidateCall = (spec, shouldSplitQueryKey, useOperationIdAsQueryKey, baseUrl, servers) => {
 	return (target) => {
 		const method = target.invalidateMode === "reset" ? "resetQueries" : "invalidateQueries";
 		const queryKeyFn = camel(`get-${target.query}-query-key`);
@@ -1673,16 +1708,18 @@ const createGenerateInvalidateCall = (spec, shouldSplitQueryKey, useOperationIdA
 		if (info?.hasRequiredPathParams) {
 			const prefix = getStaticRoutePrefix(info.route);
 			if (prefix !== void 0) {
+				const prefixWithBase = getFullRoute(prefix, servers, baseUrl);
 				const verbPrefix = getQueryKeyVerbPrefix({
 					verb: info.method,
 					useOperationIdAsQueryKey
 				});
 				if (shouldSplitQueryKey) {
-					const segments = prefix.split("/").filter((s) => s !== "").map((s) => `'${s}'`).join(", ");
+					const segments = getRouteAsArray(prefixWithBase);
 					return `    queryClient.${method}({ queryKey: ${verbPrefix ? `['${verbPrefix}', ${segments}]` : `[${segments}]`} });`;
 				}
-				if (verbPrefix) return `    queryClient.${method}({ predicate: (query) => query.queryKey[0] === '${verbPrefix}' && typeof query.queryKey[1] === 'string' && query.queryKey[1].startsWith('${prefix}') });`;
-				return `    queryClient.${method}({ predicate: (query) => typeof query.queryKey[0] === 'string' && query.queryKey[0].startsWith('${prefix}') });`;
+				const prefixLiteral = toPrefixLiteral(prefixWithBase);
+				if (verbPrefix) return `    queryClient.${method}({ predicate: (query) => query.queryKey[0] === '${verbPrefix}' && typeof query.queryKey[1] === 'string' && query.queryKey[1].startsWith(${prefixLiteral}) });`;
+				return `    queryClient.${method}({ predicate: (query) => typeof query.queryKey[0] === 'string' && query.queryKey[0].startsWith(${prefixLiteral}) });`;
 			}
 		}
 		return `    queryClient.${method}({ queryKey: ${queryKeyFn}() });`;
@@ -1763,7 +1800,7 @@ ${hasInvalidation ? adapter.generateMutationOnSuccess({
 		operationName,
 		definitions,
 		isRequestOptions,
-		generateInvalidateCall: createGenerateInvalidateCall(context.spec, !!query.shouldSplitQueryKey, !!query.useOperationIdAsQueryKey),
+		generateInvalidateCall: createGenerateInvalidateCall(context.spec, !!query.shouldSplitQueryKey, !!query.useOperationIdAsQueryKey, context.output.baseUrl, context.spec.servers),
 		uniqueInvalidates
 	}) : ""}
 
@@ -2414,12 +2451,27 @@ ${queryKeyFns}`;
 };
 //#endregion
 //#region src/index.ts
+const WITH_QUERY_KEY_HELPER = `const withQueryKey = <T extends object, K>(query: T, queryKey: K): T & { queryKey: K } => {
+  const result = { queryKey } as T & { queryKey: K };
+  for (const key of Object.keys(query)) {
+    // The explicit queryKey always wins, matching the previous
+    // \`{ ...query, queryKey }\` spread where it was set last.
+    if (key === 'queryKey') continue;
+    Object.defineProperty(result, key, {
+      enumerable: true,
+      configurable: true,
+      get: () => (query as Record<string, unknown>)[key],
+    });
+  }
+  return result;
+};`;
 const generateQueryHeader = (params) => {
+	const needsWithQueryKey = params.clientImplementation.includes("withQueryKey(");
 	return `${params.hasAwaitedType ? "" : `type AwaitedInput<T> = PromiseLike<T> | T;\n
       type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;\n\n`}
 ${params.isRequestOptions && params.isMutator ? `type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];\n\n` : ""}
 ${getQueryHeader(params)}
-`;
+${needsWithQueryKey ? `${WITH_QUERY_KEY_HELPER}\n\n` : ""}`;
 };
 const generateQuery = async (verbOptions, options, outputClient) => {
 	const isZodOutput = typeof options.context.output.schemas === "object" && options.context.output.schemas.type === "zod";