@orval/query 8.14.0 → 8.16.0

package/dist/index.mjs

@@ -24,6 +24,7 @@ const normalizeQueryOptions = (queryOptions = {}, outputWorkspace) => {
 		...queryOptions.shouldExportMutatorHooks ? { shouldExportMutatorHooks: true } : {},
 		...queryOptions.shouldExportQueryKey ? { shouldExportQueryKey: true } : {},
 		...queryOptions.shouldFilterQueryKey ? { shouldFilterQueryKey: true } : {},
+		...queryOptions.queryKeyFilter ? { queryKeyFilter: queryOptions.queryKeyFilter } : {},
 		...queryOptions.shouldExportHttpClient ? { shouldExportHttpClient: true } : {},
 		...queryOptions.shouldSplitQueryKey ? { shouldSplitQueryKey: true } : {},
 		...queryOptions.useOperationIdAsQueryKey ? { useOperationIdAsQueryKey: true } : {}
@@ -129,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;
@@ -143,6 +146,7 @@ const generateAngularHttpRequestFunction = ({ headers, queryParams, operationNam
 		isFormUrlEncoded
 	});
 	if (mutator) {
+		const isExactOptionalPropertyTypes = !!context.output.tsconfig?.compilerOptions?.exactOptionalPropertyTypes;
 		const mutatorConfig = generateMutatorConfig({
 			route,
 			body,
@@ -154,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
 		});
@@ -391,10 +395,12 @@ const dedupeUnionTypes = (types) => {
 	if (!types) return types;
 	return [...new Set(types.split("|").map((t) => t.trim()).filter(Boolean))].join(" | ");
 };
-const getQueryErrorType = (operationName, response, httpClient, mutator) => {
+const getQueryErrorType = (operationName, response, httpClient, mutator, forceSuccessResponse) => {
 	const errorsType = dedupeUnionTypes(response.definition.errors || "unknown");
 	if (mutator) return mutator.hasErrorType ? `${mutator.default ? pascal(operationName) : ""}ErrorType<${errorsType}>` : errorsType;
-	else return httpClient === OutputHttpClient.AXIOS ? `AxiosError<${errorsType}>` : errorsType;
+	if (httpClient === OutputHttpClient.AXIOS) return `AxiosError<${errorsType}>`;
+	if (forceSuccessResponse) return `globalThis.Error & { info?: ${errorsType}; status?: number }`;
+	return errorsType;
 };
 const getHooksOptionImplementation = (isRequestOptions, httpClient, operationName, mutator, useRuntimeFetcher) => {
 	const fetcherOption = httpClient === OutputHttpClient.FETCH && useRuntimeFetcher ? ", fetcher: fetcherFn" : "";
@@ -739,6 +745,12 @@ const getSolidQueryImports = (prefix, hasRenamedOptionsTypes) => {
 			{ name: "InvalidateOptions" }
 		],
 		dependency: "@tanstack/solid-query"
+	}, {
+		exports: [{
+			name: "mergeProps",
+			values: true
+		}],
+		dependency: "solid-js"
 	}];
 };
 const ANGULAR_QUERY_DEPENDENCIES = [{
@@ -1173,7 +1185,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";
@@ -1597,6 +1609,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
@@ -1652,7 +1689,7 @@ const createGenerateInvalidateCall = (spec, shouldSplitQueryKey, useOperationIdA
 	};
 };
 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({
@@ -1665,7 +1702,7 @@ const generateMutationHook = async ({ verbOptions, options, isRequestOptions, ht
 	const bodyOptionalMark = body.isOptional ? "?" : "";
 	const definitions = props.map(({ definition, type }) => type === GetterPropType.BODY ? mutator?.bodyTypeName ? `data${bodyOptionalMark}: ${mutator.bodyTypeName}<${body.definition}>` : `data${bodyOptionalMark}: ${body.definition}` : definition).join(";");
 	const properties = props.map(({ name, type }) => type === GetterPropType.BODY ? "data" : name).join(",");
-	const errorType = getQueryErrorType(operationName, response, httpClient, mutator);
+	const errorType = getQueryErrorType(operationName, response, httpClient, mutator, override.fetch.forceSuccessResponse);
 	const dataType = mutator?.isHook ? `ReturnType<typeof use${pascal(operationName)}Hook>` : `typeof ${operationName}`;
 	const mutationOptionFnReturnType = getQueryOptionsDefinition({
 		operationName,
@@ -1730,7 +1767,7 @@ ${hasInvalidation ? adapter.generateMutationOnSuccess({
 		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 }"}}`;
@@ -1933,7 +1970,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, 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, 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({
@@ -1977,7 +2014,7 @@ const generateQueryImplementation = ({ queryOption: { name, queryParam, options,
 		hasQueryV5,
 		hasQueryV5WithDataTagError
 	});
-	const errorType = getQueryErrorType(operationName, response, httpClient, mutator);
+	const errorType = getQueryErrorType(operationName, response, httpClient, mutator, forceSuccessResponse);
 	const dataType = mutator?.isHook ? `ReturnType<typeof use${pascal(operationName)}Hook>` : `typeof ${operationName}`;
 	const definedInitialDataQueryArguments = adapter.generateQueryArguments({
 		operationName,
@@ -2310,7 +2347,7 @@ ${override.query.shouldExportQueryKey ? "export " : ""}const ${queryOption.query
 				queryKeyParams,
 				body.implementation
 			].filter((x) => !!x).join(", ")}
-    ]${override.query.shouldFilterQueryKey ? ".filter(Boolean)" : " as const"};
+    ]${override.query.shouldFilterQueryKey ? `.filter(${override.query.queryKeyFilter ?? "q => q !== undefined"})` : " as const"};
     }
 `;
 		}
@@ -2334,6 +2371,7 @@ ${queryKeyFns}`;
 			isExactOptionalPropertyTypes,
 			hasSignal: getHasSignal({ overrideQuerySignal: override.query.signal }),
 			useRuntimeFetcher: override.fetch.useRuntimeFetcher,
+			forceSuccessResponse: override.fetch.forceSuccessResponse,
 			queryOptionsMutator,
 			queryKeyMutator,
 			route,