@orval/query 8.19.0 → 8.21.0

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { GetterPropType, OutputClient, OutputHttpClient, Verbs, camel, compareVersions, generateFormDataAndUrlEncodedFunction, generateMutator, generateMutatorConfig, generateMutatorRequestOptions, generateOptions, generateVerbImports, getAngularFilteredParamsCallExpression, getAngularFilteredParamsHelperBody, getFullRoute, getRouteAsArray, getSuccessResponseType, isObject, isOperationInTagBucket, isString, isSyntheticDefaultImportsAllow, jsDoc, 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, getRoute, getRouteAsArray, getSuccessResponseType, isObject, isOperationInTagBucket, isString, isSyntheticDefaultImportsAllow, jsDoc, 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";
@@ -48,24 +48,6 @@ const normalizeMutator = (workspace, mutator) => {
 		default: true
 	};
 };
-function vueWrapTypeWithMaybeRef(props) {
-	return props.map((prop) => {
-		const [paramName, paramType] = prop.implementation.split(":");
-		if (!paramType) return prop;
-		const name = prop.type === GetterPropType.NAMED_PATH_PARAMS ? prop.name : paramName;
-		const [type, defaultValue] = paramType.split("=");
-		return {
-			...prop,
-			implementation: `${name}: MaybeRef<${type.trim()}>${defaultValue ? ` = ${defaultValue}` : ""}`
-		};
-	});
-}
-const vueUnRefParams = (props) => {
-	return props.map((prop) => {
-		if (prop.type === GetterPropType.NAMED_PATH_PARAMS) return `const ${prop.destructured} = unref(${prop.name});`;
-		return `${prop.name} = unref(${prop.name});`;
-	}).join("\n");
-};
 const getQueryTypeForFramework = (type) => {
 	switch (type) {
 		case "suspenseQuery": return "query";
@@ -688,15 +670,20 @@ const VUE_QUERY_DEPENDENCIES = [{
 	dependency: "@tanstack/vue-query"
 }, {
 	exports: [
+		{
+			name: "computed",
+			values: true
+		},
 		{
 			name: "unref",
 			values: true
 		},
-		{ name: "MaybeRef" },
 		{
-			name: "computed",
+			name: "toValue",
 			values: true
-		}
+		},
+		{ name: "MaybeRef" },
+		{ name: "MaybeRefOrGetter" }
 	],
 	dependency: "vue"
 }];
@@ -1294,6 +1281,33 @@ const createSvelteAdapter = ({ hasSvelteQueryV4, hasSvelteQueryV6, hasQueryV5, h
 };
 //#endregion
 //#region src/frameworks/vue.ts
+const getVueReactivity = (hasQueryV5) => hasQueryV5 ? {
+	wrapper: "MaybeRefOrGetter",
+	resolve: "toValue"
+} : {
+	wrapper: "MaybeRef",
+	resolve: "unref"
+};
+function vueWrapTypeWithMaybeRef(props, hasQueryV5) {
+	const { wrapper } = getVueReactivity(hasQueryV5);
+	return props.map((prop) => {
+		const [paramName, paramType] = prop.implementation.split(":");
+		if (!paramType) return prop;
+		const name = prop.type === GetterPropType.NAMED_PATH_PARAMS ? prop.name : paramName;
+		const [type, defaultValue] = paramType.split("=");
+		return {
+			...prop,
+			implementation: `${name}: ${wrapper}<${type.trim()}>${defaultValue ? ` = ${defaultValue}` : ""}`
+		};
+	});
+}
+const vueUnRefParams = (props, hasQueryV5) => {
+	const { resolve } = getVueReactivity(hasQueryV5);
+	return props.map((prop) => {
+		if (prop.type === GetterPropType.NAMED_PATH_PARAMS) return `const ${prop.destructured} = ${resolve}(${prop.name});`;
+		return `${prop.name} = ${resolve}(${prop.name});`;
+	}).join("\n");
+};
 const createVueAdapter = ({ hasVueQueryV4, hasQueryV5, hasQueryV5WithDataTagError, hasQueryV5WithInfiniteQueryOptionsError, hasQueryV5WithMutationContextOnSuccess, hasQueryV5WithRequiredContextOnSuccess }) => ({
 	outputClient: OutputClient.VUE_QUERY,
 	hookPrefix: "use",
@@ -1303,19 +1317,23 @@ const createVueAdapter = ({ hasVueQueryV4, hasQueryV5, hasQueryV5WithDataTagErro
 	hasQueryV5WithMutationContextOnSuccess,
 	hasQueryV5WithRequiredContextOnSuccess,
 	transformProps(props) {
-		return vueWrapTypeWithMaybeRef(props);
+		return vueWrapTypeWithMaybeRef(props, hasQueryV5);
 	},
 	shouldDestructureNamedPathParams() {
 		return false;
 	},
 	getHttpFunctionQueryProps(queryProperties, httpClient) {
-		if (httpClient === OutputHttpClient.FETCH && queryProperties) return queryProperties.split(",").map((prop) => `unref(${prop})`).join(",");
+		if (httpClient === OutputHttpClient.FETCH && queryProperties) {
+			const { resolve } = getVueReactivity(hasQueryV5);
+			return queryProperties.split(",").map((prop) => `${resolve}(${prop})`).join(",");
+		}
 		return queryProperties;
 	},
 	getInfiniteQueryHttpProps(props, queryParam, httpClient) {
+		const { resolve } = getVueReactivity(hasQueryV5);
 		return props.map((param) => {
-			if (param.name === "params") return `{...unref(params), '${queryParam}': pageParam ?? unref(params)?.['${queryParam}']}`;
-			return httpClient === OutputHttpClient.FETCH ? `unref(${param.name})` : param.name;
+			if (param.name === "params") return `{...${resolve}(params), '${queryParam}': pageParam ?? ${resolve}(params)?.['${queryParam}']}`;
+			return httpClient === OutputHttpClient.FETCH ? `${resolve}(${param.name})` : param.name;
 		}).join(",");
 	},
 	getQueryReturnType({ type }) {
@@ -1343,17 +1361,20 @@ const createVueAdapter = ({ hasVueQueryV4, hasQueryV5, hasQueryV5WithDataTagErro
 		return false;
 	},
 	getRequestUnrefStatements(props) {
-		return vueUnRefParams(props);
+		return vueUnRefParams(props, hasQueryV5);
 	},
 	getQueryOptionsUnrefStatements(props) {
-		return vueUnRefParams(props.filter((prop) => prop.type === GetterPropType.NAMED_PATH_PARAMS));
+		return vueUnRefParams(props.filter((prop) => prop.type === GetterPropType.NAMED_PATH_PARAMS), hasQueryV5);
 	},
 	wrapHookMutatorCallback(callback) {
 		return callback;
 	},
 	generateEnabledOption(params, options) {
 		if (params.length === 0) return "";
-		if (!isObject(options) || !Object.hasOwn(options, "enabled")) return `enabled: computed(() => ${params.map(({ name }) => `unref(${name}) !== null && unref(${name}) !== undefined`).join(" && ")}),`;
+		if (!isObject(options) || !Object.hasOwn(options, "enabled")) {
+			const { resolve } = getVueReactivity(hasQueryV5);
+			return `enabled: computed(() => ${params.map(({ name }) => `${resolve}(${name}) !== null && ${resolve}(${name}) !== undefined`).join(" && ")}),`;
+		}
 		return "";
 	},
 	getQueryKeyPrefix() {
@@ -1723,7 +1744,7 @@ const createGenerateInvalidateCall = (spec, shouldSplitQueryKey, useOperationIdA
 		if (info?.hasRequiredPathParams) {
 			const prefix = getStaticRoutePrefix(info.route);
 			if (prefix !== void 0) {
-				const prefixWithBase = getFullRoute(prefix, servers, baseUrl);
+				const prefixWithBase = getFullRoute(getRoute(prefix), servers, baseUrl);
 				const verbPrefix = getQueryKeyVerbPrefix({
 					verb: info.method,
 					useOperationIdAsQueryKey
@@ -1741,7 +1762,7 @@ const createGenerateInvalidateCall = (spec, shouldSplitQueryKey, useOperationIdA
 	};
 };
 const generateMutationHook = async ({ verbOptions, options, isRequestOptions, httpClient, doc, adapter }) => {
-	const { operationName, body, props, mutator, response, operationId, route: pathRoute, override } = verbOptions;
+	const { operationName, typeName, body, props, mutator, response, operationId, route: pathRoute, override } = verbOptions;
 	const { route, context, output } = options;
 	const query = override.query;
 	const mutationOptionsMutator = query.mutationOptions ? await generateMutator({
@@ -1756,7 +1777,7 @@ const generateMutationHook = async ({ verbOptions, options, isRequestOptions, ht
 	const properties = props.map(({ name, type }) => type === GetterPropType.BODY ? "data" : name).join(",");
 	const operationLocalNames = new Set(MUTATION_OPERATION_LOCAL_NAMES);
 	for (const { name, type } of props) operationLocalNames.add(type === GetterPropType.BODY ? "data" : name);
-	const errorType = getQueryErrorType(operationName, response, httpClient, mutator, override.fetch.forceSuccessResponse);
+	const errorType = getQueryErrorType(typeName, response, httpClient, mutator, override.fetch.forceSuccessResponse);
 	const operationReferenceName = getMutationOperationReferenceName(operationName, operationLocalNames);
 	const dataType = mutator?.isHook ? `ReturnType<typeof use${pascal(operationName)}Hook>` : `typeof ${operationReferenceName}`;
 	const operationTypeReferenceName = mutator?.isHook ? operationName : operationReferenceName;
@@ -1854,9 +1875,9 @@ ${hasInvalidation ? adapter.generateMutationOnSuccess({
 ${!mutator?.isHook && operationReferenceName !== operationName ? `const ${operationReferenceName} = ${operationName};` : ""}
 ${mutationOptionsFn}
 
-    export type ${pascal(operationName)}MutationResult = NonNullable<Awaited<ReturnType<${dataType}>>>
-    ${body.definition ? `export type ${pascal(operationName)}MutationBody = ${mutator?.bodyTypeName ? `${mutator.bodyTypeName}<${body.definition}>` : body.definition}${body.isOptional ? " | undefined" : ""}` : ""}
-    export type ${pascal(operationName)}MutationError = ${errorType}
+    export type ${pascal(typeName)}MutationResult = NonNullable<Awaited<ReturnType<${dataType}>>>
+    ${body.definition ? `export type ${pascal(typeName)}MutationBody = ${mutator?.bodyTypeName ? `${mutator.bodyTypeName}<${body.definition}>` : body.definition}${body.isOptional ? " | undefined" : ""}` : ""}
+    export type ${pascal(typeName)}MutationError = ${errorType}
 
     ${doc}export const ${camel(`${operationPrefix}-${operationName}`)} = <TError = ${errorType},
     TContext = unknown>(${mutationArguments} ${optionalQueryClientArgument})${mutationReturnType} => {
@@ -2027,7 +2048,7 @@ const generatePrefetch = ({ usePrefetch, type, useQuery, useInfinite, operationN
   return queryClient;
 }\n`;
 };
-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, forceSuccessResponse, route, doc, usePrefetch, useQuery, useInfinite, useInvalidate, useSetQueryData, useGetQueryData, adapter }) => {
+const generateQueryImplementation = ({ queryOption: { name, typeName: optionTypeName, queryParam, options, type, queryKeyFnName }, operationId, operationName, typeName, queryProperties, queryKeyProperties, queryParams, params, props, body, mutator, queryOptionsMutator, queryKeyMutator, isRequestOptions, response, httpClient, isExactOptionalPropertyTypes, hasSignal, useRuntimeFetcher, forceSuccessResponse, 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({
@@ -2071,7 +2092,7 @@ const generateQueryImplementation = ({ queryOption: { name, queryParam, options,
 		hasQueryV5,
 		hasQueryV5WithDataTagError
 	});
-	const errorType = getQueryErrorType(operationName, response, httpClient, mutator, forceSuccessResponse);
+	const errorType = getQueryErrorType(typeName, response, httpClient, mutator, forceSuccessResponse);
 	const dataType = mutator?.isHook ? `ReturnType<typeof use${pascal(operationName)}Hook>` : `typeof ${operationName}`;
 	const definedInitialDataQueryArguments = adapter.generateQueryArguments({
 		operationName,
@@ -2251,8 +2272,8 @@ export function ${queryHookName}<TData = ${TData}, TError = ${errorType}>(\n ${q
 	return `
 ${queryOptionsFn}
 
-export type ${pascal(name)}QueryResult = NonNullable<Awaited<ReturnType<${dataType}>>>
-export type ${pascal(name)}QueryError = ${errorType}
+export type ${pascal(optionTypeName)}QueryResult = NonNullable<Awaited<ReturnType<${dataType}>>>
+export type ${pascal(optionTypeName)}QueryError = ${errorType}
 
 ${adapter.shouldGenerateOverrideTypes() ? overrideTypes : ""}
 ${doc}
@@ -2297,7 +2318,7 @@ ${shouldGenerateGetQueryData ? isReactQuery ? `${doc}export const ${getQueryData
 };
 const generateQueryHook = async (verbOptions, options, outputClient, adapter) => {
 	if (!adapter) throw new Error("FrameworkAdapter is required for generateQueryHook");
-	const { queryParams, operationName, body, props: _props, verb, params, override, mutator, response, operationId, summary, deprecated } = verbOptions;
+	const { queryParams, operationName, typeName, body, props: _props, verb, params, override, mutator, response, operationId, summary, deprecated } = verbOptions;
 	const { route, override: { operations }, context, output } = options;
 	const props = adapter.transformProps(_props);
 	const query = override.query;
@@ -2353,6 +2374,7 @@ const generateQueryHook = async (verbOptions, options, outputClient, adapter) =>
 		const queries = [
 			...effectiveUseInfinite ? [{
 				name: camel(`${operationName}-infinite`),
+				typeName: camel(`${typeName}-infinite`),
 				options: query.options,
 				type: QueryType.INFINITE,
 				queryParam: query.useInfiniteQueryParam,
@@ -2360,18 +2382,21 @@ const generateQueryHook = async (verbOptions, options, outputClient, adapter) =>
 			}] : [],
 			...effectiveUseQuery ? [{
 				name: operationName,
+				typeName,
 				options: query.options,
 				type: QueryType.QUERY,
 				queryKeyFnName: camel(`get-${operationName}-query-key`)
 			}] : [],
 			...effectiveUseSuspenseQuery ? [{
 				name: camel(`${operationName}-suspense`),
+				typeName: camel(`${typeName}-suspense`),
 				options: query.options,
 				type: QueryType.SUSPENSE_QUERY,
 				queryKeyFnName: camel(`get-${operationName}-query-key`)
 			}] : [],
 			...effectiveUseSuspenseInfiniteQuery ? [{
 				name: camel(`${operationName}-suspense-infinite`),
+				typeName: camel(`${typeName}-suspense-infinite`),
 				options: query.options,
 				type: QueryType.SUSPENSE_INFINITE,
 				queryParam: query.useInfiniteQueryParam,
@@ -2415,6 +2440,7 @@ ${queryKeyFns}`;
 			queryOption,
 			operationId,
 			operationName,
+			typeName,
 			queryProperties,
 			queryKeyProperties,
 			params,