@orval/query 8.15.0 → 8.17.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";
@@ -130,7 +130,9 @@ const ANGULAR_HTTP_DEPENDENCIES = [
 		dependency: "rxjs/operators"
 	}
 ];
-const generateAngularHttpRequestFunction = ({ headers, queryParams, operationName, response, mutator, body, props, verb, formData, formUrlEncoded, override }, { route, context }) => {
+const generateAngularHttpRequestFunction = ({ headers, queryParams, operationName, response, mutator, body, props, verb, formData, formUrlEncoded, override }, { route: _route, context }) => {
+	let route = _route;
+	if (context.output.urlEncodeParameters) route = makeRouteSafe(route);
 	const isRequestOptions = override.requestOptions !== false;
 	const isFormData = !override.formData.disabled;
 	const isFormUrlEncoded = override.formUrlEncoded !== false;
@@ -144,6 +146,7 @@ const generateAngularHttpRequestFunction = ({ headers, queryParams, operationNam
 		isFormUrlEncoded
 	});
 	if (mutator) {
+		const isExactOptionalPropertyTypes = !!context.output.tsconfig?.compilerOptions?.exactOptionalPropertyTypes;
 		const mutatorConfig = generateMutatorConfig({
 			route,
 			body,
@@ -155,7 +158,7 @@ const generateAngularHttpRequestFunction = ({ headers, queryParams, operationNam
 			isFormUrlEncoded,
 			hasSignal,
 			hasSignalParam,
-			isExactOptionalPropertyTypes: !!context.output.tsconfig?.compilerOptions?.exactOptionalPropertyTypes,
+			isExactOptionalPropertyTypes,
 			isVue: false,
 			isAngular: context.output.httpClient === OutputHttpClient.ANGULAR
 		});
@@ -677,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" },
@@ -742,6 +750,12 @@ const getSolidQueryImports = (prefix, hasRenamedOptionsTypes) => {
 			{ name: "InvalidateOptions" }
 		],
 		dependency: "@tanstack/solid-query"
+	}, {
+		exports: [{
+			name: "mergeProps",
+			values: true
+		}],
+		dependency: "solid-js"
 	}];
 };
 const ANGULAR_QUERY_DEPENDENCIES = [{
@@ -1176,7 +1190,7 @@ const createSolidAdapter = ({ hasQueryV5, hasQueryV5WithDataTagError, hasQueryV5
       >`;
 	},
 	getQueryReturnStatement({ queryResultVarName, queryOptionsVarName }) {
-		return `return Object.assign(${queryResultVarName}, { queryKey: ${queryOptionsVarName}.queryKey }) as any;`;
+		return `return mergeProps(${queryResultVarName}, { queryKey: ${queryOptionsVarName}.queryKey }) as any;`;
 	},
 	generateQueryInvocationArgs({ queryOptionsFnName, queryProperties, isRequestOptions, optionalQueryClientArgument }) {
 		const optionsArg = isRequestOptions ? "options" : "queryOptions";
@@ -1362,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);
@@ -1600,6 +1636,31 @@ const getStaticRoutePrefix = (route) => {
 	const prefix = route.slice(0, idx);
 	return prefix.split("/").some((segment) => segment.length > 0) ? prefix : void 0;
 };
+const getMutationOptionsUrl = (route, pathParamNames, pathRoute) => {
+	const pathParams = new Set(pathParamNames);
+	if (pathParams.size === 0) return route;
+	const formatPathRoute = (value) => value.replace(/\$\{([^}]+)\}/g, (match, expression) => pathParams.has(expression) ? `{${expression}}` : match);
+	if (pathRoute) {
+		if (route.endsWith(pathRoute)) return `${route.slice(0, -pathRoute.length)}${formatPathRoute(pathRoute)}`;
+		const routeWithoutLeadingSlash = pathRoute.startsWith("/") ? pathRoute.slice(1) : void 0;
+		if (routeWithoutLeadingSlash && route.endsWith(routeWithoutLeadingSlash)) return `${route.slice(0, -routeWithoutLeadingSlash.length)}${formatPathRoute(routeWithoutLeadingSlash)}`;
+	}
+	return pathRoute ? route : formatPathRoute(route);
+};
+const getMutationOptionsNamedPathParamName = (param) => {
+	const trimmedParam = param.trim();
+	if (!trimmedParam || trimmedParam.startsWith("...")) return void 0;
+	const [name] = trimmedParam.split(/[=:]/);
+	return name?.trim() || void 0;
+};
+const getMutationOptionsPathParamNames = (props) => props.flatMap((prop) => {
+	if (prop.type === GetterPropType.PARAM) return [prop.name];
+	if (prop.type === GetterPropType.NAMED_PATH_PARAMS) return prop.destructured.replace(/^\{\s*|\s*\}$/g, "").split(",").flatMap((param) => {
+		const name = getMutationOptionsNamedPathParamName(param);
+		return name ? [name] : [];
+	});
+	return [];
+});
 /**
 * Check whether the target invalidation needs to call the query key function.
 * Returns false when no params are specified and the route has required path
@@ -1627,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`);
@@ -1639,23 +1708,25 @@ 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}() });`;
 	};
 };
 const generateMutationHook = async ({ verbOptions, options, isRequestOptions, httpClient, doc, adapter }) => {
-	const { operationName, body, props, mutator, response, operationId, override } = verbOptions;
+	const { operationName, body, props, mutator, response, operationId, route: pathRoute, override } = verbOptions;
 	const { route, context, output } = options;
 	const query = override.query;
 	const mutationOptionsMutator = query.mutationOptions ? await generateMutator({
@@ -1729,11 +1800,11 @@ ${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
 	}) : ""}
 
-        ${mutationOptionsMutator ? `const customOptions = ${mutationOptionsMutator.name}({...mutationOptions, mutationFn}${mutationOptionsMutator.hasSecondArg ? `, { url: \`${route.replaceAll("/${", "/{")}\` }` : ""}${mutationOptionsMutator.hasThirdArg ? `, { operationId: '${operationId}', operationName: '${operationName}' }` : ""});` : ""}
+        ${mutationOptionsMutator ? `const customOptions = ${mutationOptionsMutator.name}({...mutationOptions, mutationFn}${mutationOptionsMutator.hasSecondArg ? `, { url: \`${getMutationOptionsUrl(route, getMutationOptionsPathParamNames(props), pathRoute)}\` }` : ""}${mutationOptionsMutator.hasThirdArg ? `, { operationId: '${operationId}', operationName: '${operationName}' }` : ""});` : ""}
 
 
   return  ${mutationOptionsMutator ? "customOptions" : hasInvalidation ? "{ ...mutationOptions, mutationFn, onSuccess }" : "{ mutationFn, ...mutationOptions }"}}`;