@orval/query 8.25.0 → 8.27.0

package/dist/index.mjs

@@ -40,7 +40,8 @@ const normalizeMutator = (workspace, mutator) => {
 			default: m.default ?? !m.name,
 			alias: m.alias,
 			external: m.external,
-			extension: m.extension
+			extension: m.extension,
+			useHooks: m.useHooks
 		};
 	}
 	if (isString(mutator)) return {
@@ -48,6 +49,10 @@ const normalizeMutator = (workspace, mutator) => {
 		default: true
 	};
 };
+const shouldUseOptionsHook = ({ optionsMutator, queryKeyMutator, mutator }) => {
+	if (optionsMutator) return optionsMutator.useHooks ?? true;
+	return !!queryKeyMutator || !!mutator?.isHook;
+};
 const getQueryTypeForFramework = (type) => {
 	switch (type) {
 		case "suspenseQuery": return "query";
@@ -377,10 +382,15 @@ const getQueryErrorType = (operationName, response, httpClient, mutator, forceSu
 	if (forceSuccessResponse) return `globalThis.Error & { info?: ${errorsType}; status?: number }`;
 	return errorsType;
 };
-const getHooksOptionImplementation = (isRequestOptions, httpClient, operationName, mutator, useRuntimeFetcher) => {
+/**
+* Options destructuring at the top of `get/useXxxMutationOptions`. The mutation
+* key is read from the hoisted `getXxxMutationKey()` getter emitted by the
+* mutation generator.
+*/
+const getHooksOptionImplementation = (isRequestOptions, httpClient, mutationKeyFnName, mutator, useRuntimeFetcher) => {
 	const fetcherOption = httpClient === OutputHttpClient.FETCH && useRuntimeFetcher ? ", fetcher: fetcherFn" : "";
 	const options = httpClient === OutputHttpClient.AXIOS ? ", axios: axiosOptions" : `, fetch: fetchOptions${fetcherOption}`;
-	return isRequestOptions ? `const mutationKey = ['${operationName}'];
+	return isRequestOptions ? `const mutationKey = ${mutationKeyFnName}();
 const {mutation: mutationOptions${mutator ? mutator.hasSecondArg ? ", request: requestOptions" : "" : options}} = options ?
       options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
       options
@@ -968,7 +978,7 @@ const resolveUserQueryOptionsConstraint = (adapter, type, options) => {
 * constraint reshapes the type without requiring anything, so it does not count.
 */
 const requiresUserSuppliedQueryOptions = (adapter, type, options) => !!type && !!resolveUserQueryOptionsConstraint(adapter, type, options)?.require?.length;
-const getQueryOptionsDefinition = ({ operationName, mutator, definitions, type, prefix, hasQueryV5, hasQueryV5WithInfiniteQueryOptionsError, queryParams, queryParam, isReturnType, initialData, adapter, options }) => {
+const getQueryOptionsDefinition = ({ operationName, mutator, definitions, mutationVariablesType, type, prefix, hasQueryV5, hasQueryV5WithInfiniteQueryOptionsError, queryParams, queryParam, isReturnType, initialData, adapter, options }) => {
 	const isMutatorHook = mutator?.isHook;
 	const partialOptions = !isReturnType && hasQueryV5;
 	if (type) {
@@ -1001,7 +1011,8 @@ const getQueryOptionsDefinition = ({ operationName, mutator, definitions, type,
 		return `${partialOptions ? "Partial<" : ""}${optionType}${partialOptions ? ">" : ""}${optionTypeInitialDataPostfix}`;
 	}
 	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>`;
+	const variablesType = mutationVariablesType ?? (definitions ? `{${definitions}}` : "void");
+	return mutationOptionsTypeName ? `${mutationOptionsTypeName}<Awaited<ReturnType<${isMutatorHook ? `ReturnType<typeof use${pascal(operationName)}Hook>` : `typeof ${operationName}`}>>, TError,${variablesType}, TContext>` : `${prefix}MutationOptions<Awaited<ReturnType<${isMutatorHook ? `ReturnType<typeof use${pascal(operationName)}Hook>` : `typeof ${operationName}`}>>, TError,${variablesType}, TContext>`;
 };
 //#endregion
 //#region src/frameworks/angular.ts
@@ -1082,11 +1093,12 @@ const createAngularAdapter = ({ hasQueryV5, hasQueryV5WithDataTagError, hasQuery
 		getQueryOptionsDefinitionPrefix() {
 			return prefix;
 		},
-		generateQueryArguments({ operationName, definitions, mutator, isRequestOptions, type, queryParams, queryParam, initialData, httpClient, forQueryOptions = false, hasInvalidation, useRuntimeFetcher }) {
+		generateQueryArguments({ operationName, definitions, mutationVariablesType, mutator, isRequestOptions, type, queryParams, queryParam, initialData, httpClient, forQueryOptions = false, hasInvalidation, useRuntimeFetcher }) {
 			const definition = getQueryOptionsDefinition({
 				operationName,
 				mutator,
 				definitions,
+				mutationVariablesType,
 				type,
 				prefix,
 				hasQueryV5,
@@ -1326,11 +1338,12 @@ const createSvelteAdapter = ({ hasSvelteQueryV4, hasSvelteQueryV6, hasQueryV5, h
 		getQueryOptionsDefinitionPrefix() {
 			return prefix;
 		},
-		generateQueryArguments({ operationName, definitions, mutator, isRequestOptions, type, queryParams, queryParam, initialData, httpClient, forQueryOptions = false, hasInvalidation, useRuntimeFetcher }) {
+		generateQueryArguments({ operationName, definitions, mutationVariablesType, mutator, isRequestOptions, type, queryParams, queryParam, initialData, httpClient, forQueryOptions = false, hasInvalidation, useRuntimeFetcher }) {
 			const definition = getQueryOptionsDefinition({
 				operationName,
 				mutator,
 				definitions,
+				mutationVariablesType,
 				type,
 				prefix,
 				hasQueryV5,
@@ -1470,27 +1483,28 @@ const createVueAdapter = ({ hasVueQueryV4, hasQueryV5, hasQueryV5WithDataTagErro
 	supportsMutationInvalidation() {
 		return hasQueryV5;
 	},
-	generateMutationOnSuccess({ operationName, definitions, isRequestOptions, generateInvalidateCall, uniqueInvalidates }) {
+	generateMutationOnSuccess({ operationName, definitions, mutationVariablesType, isRequestOptions, generateInvalidateCall, uniqueInvalidates }) {
 		const invalidateCalls = uniqueInvalidates.map((t) => generateInvalidateCall(t)).join("\n");
+		const variablesType = mutationVariablesType ?? (definitions ? `{${definitions}}` : "void");
 		if (hasQueryV5WithMutationContextOnSuccess) {
-			if (isRequestOptions) return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${definitions ? `{${definitions}}` : "void"}, onMutateResult: TContext, context: MutationFunctionContext) => {
+			if (isRequestOptions) return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${variablesType}, 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) => {
+			return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${variablesType}, 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 (isRequestOptions) return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${variablesType}, 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"}) => {
+		return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${variablesType}, context: TContext${hasQueryV5WithRequiredContextOnSuccess ? "" : " | undefined"}) => {
     ${invalidateCalls}
         unref(unref(typeof mutationOptions === 'function' ? mutationOptions() : mutationOptions)?.onSuccess)?.(data, variables, context);
       };`;
@@ -1556,12 +1570,13 @@ const withDefaults = (adapter) => {
 		getOptionalQueryClientArgument() {
 			return composed.hasQueryV5 ? ", queryClient?: QueryClient" : "";
 		},
-		generateQueryArguments({ operationName, definitions, mutator, isRequestOptions, type, queryParams, queryParam, initialData, httpClient, hasInvalidation, useRuntimeFetcher, options }) {
+		generateQueryArguments({ operationName, definitions, mutationVariablesType, mutator, isRequestOptions, type, queryParams, queryParam, initialData, httpClient, hasInvalidation, useRuntimeFetcher, options }) {
 			const prefix = composed.getQueryOptionsDefinitionPrefix();
 			const definition = getQueryOptionsDefinition({
 				operationName,
 				mutator,
 				definitions,
+				mutationVariablesType,
 				type,
 				prefix,
 				hasQueryV5: composed.hasQueryV5,
@@ -1580,27 +1595,28 @@ const withDefaults = (adapter) => {
 			const optionsType = `{ ${type ? "query" : "mutation"}${isQueryRequired ? "" : "?"}:${definition}, ${!type && hasInvalidation ? "skipInvalidation?: boolean, " : ""}${requestType}}`;
 			return `options${isQueryRequired ? "" : "?"}: ${optionsType}\n`;
 		},
-		generateMutationOnSuccess({ operationName, definitions, isRequestOptions, generateInvalidateCall, uniqueInvalidates }) {
+		generateMutationOnSuccess({ operationName, definitions, mutationVariablesType, isRequestOptions, generateInvalidateCall, uniqueInvalidates }) {
 			const invalidateCalls = uniqueInvalidates.map((t) => generateInvalidateCall(t)).join("\n");
+			const variablesType = mutationVariablesType ?? (definitions ? `{${definitions}}` : "void");
 			if (composed.hasQueryV5WithMutationContextOnSuccess) {
-				if (isRequestOptions) return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${definitions ? `{${definitions}}` : "void"}, onMutateResult: TContext, context: MutationFunctionContext) => {
+				if (isRequestOptions) return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${variablesType}, onMutateResult: TContext, context: MutationFunctionContext) => {
         if (!options?.skipInvalidation) {
     ${invalidateCalls}
         }
         mutationOptions?.onSuccess?.(data, variables, onMutateResult, context);
       };`;
-				return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${definitions ? `{${definitions}}` : "void"}, onMutateResult: TContext, context: MutationFunctionContext) => {
+				return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${variablesType}, onMutateResult: TContext, context: MutationFunctionContext) => {
     ${invalidateCalls}
         mutationOptions?.onSuccess?.(data, variables, onMutateResult, context);
       };`;
 			} else {
-				if (isRequestOptions) return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${definitions ? `{${definitions}}` : "void"}, context: TContext${composed.hasQueryV5WithRequiredContextOnSuccess ? "" : " | undefined"}) => {
+				if (isRequestOptions) return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${variablesType}, context: TContext${composed.hasQueryV5WithRequiredContextOnSuccess ? "" : " | undefined"}) => {
         if (!options?.skipInvalidation) {
     ${invalidateCalls}
         }
         mutationOptions?.onSuccess?.(data, variables, context);
       };`;
-				return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${definitions ? `{${definitions}}` : "void"}, context: TContext${composed.hasQueryV5WithRequiredContextOnSuccess ? "" : " | undefined"}) => {
+				return `  const onSuccess = (data: Awaited<ReturnType<typeof ${operationName}>>, variables: ${variablesType}, context: TContext${composed.hasQueryV5WithRequiredContextOnSuccess ? "" : " | undefined"}) => {
     ${invalidateCalls}
         mutationOptions?.onSuccess?.(data, variables, context);
       };`;
@@ -1872,6 +1888,8 @@ const generateMutationHook = async ({ verbOptions, options, isRequestOptions, ht
 	}) : void 0;
 	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 variablesTypeName = definitions ? `${pascal(typeName)}MutationVariables` : void 0;
+	const mutationVariablesType = variablesTypeName ?? "void";
 	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);
@@ -1883,6 +1901,7 @@ const generateMutationHook = async ({ verbOptions, options, isRequestOptions, ht
 		operationName: operationTypeReferenceName,
 		mutator,
 		definitions,
+		mutationVariablesType,
 		prefix: adapter.getQueryOptionsDefinitionPrefix(),
 		hasQueryV5: adapter.hasQueryV5,
 		hasQueryV5WithInfiniteQueryOptionsError: adapter.hasQueryV5WithInfiniteQueryOptionsError,
@@ -1902,6 +1921,7 @@ const generateMutationHook = async ({ verbOptions, options, isRequestOptions, ht
 	const mutationArguments = adapter.generateQueryArguments({
 		operationName: operationTypeReferenceName,
 		definitions,
+		mutationVariablesType,
 		mutator,
 		isRequestOptions,
 		httpClient,
@@ -1911,6 +1931,7 @@ const generateMutationHook = async ({ verbOptions, options, isRequestOptions, ht
 	const mutationArgumentsForOptions = adapter.generateQueryArguments({
 		operationName: operationTypeReferenceName,
 		definitions,
+		mutationVariablesType,
 		mutator,
 		isRequestOptions,
 		httpClient,
@@ -1918,8 +1939,13 @@ const generateMutationHook = async ({ verbOptions, options, isRequestOptions, ht
 		hasInvalidation,
 		useRuntimeFetcher
 	});
-	const mutationOptionsFnName = camel(mutationOptionsMutator || mutator?.isHook ? `use-${operationName}-mutationOptions` : `get-${operationName}-mutationOptions`);
-	const hooksOptionImplementation = getHooksOptionImplementation(isRequestOptions, httpClient, camel(operationName), mutator, useRuntimeFetcher);
+	const mutationOptionsFnName = camel(shouldUseOptionsHook({
+		optionsMutator: mutationOptionsMutator,
+		mutator
+	}) ? `use-${operationName}-mutationOptions` : `get-${operationName}-mutationOptions`);
+	const mutationKeyFnName = camel(`get-${operationName}-mutation-key`);
+	const mutationKeyFn = query.shouldExportQueryKey || isRequestOptions ? `${query.shouldExportQueryKey ? "export " : ""}const ${mutationKeyFnName} = () => ['${camel(operationName)}'] as const;` : "";
+	const hooksOptionImplementation = getHooksOptionImplementation(isRequestOptions, httpClient, mutationKeyFnName, mutator, useRuntimeFetcher);
 	const mutationOptionsFn = `export const ${mutationOptionsFnName} = <TError = ${errorType},
     TContext = unknown>(${adapter.getHttpFirstParam(mutator)}${hasInvalidation ? "queryClient: QueryClient, " : ""}${mutationArgumentsForOptions}): ${mutationOptionFnReturnType} => {
 
@@ -1928,7 +1954,7 @@ ${hooksOptionImplementation}
       ${mutator?.isHook ? `const ${operationReferenceName} =  use${pascal(operationName)}Hook()` : ""}
 
 
-      const mutationFn: MutationFunction<Awaited<ReturnType<${dataType}>>, ${definitions ? `{${definitions}}` : "void"}> = (${properties ? "props" : ""}) => {
+      const mutationFn: MutationFunction<Awaited<ReturnType<${dataType}>>, ${mutationVariablesType}> = (${properties ? "props" : ""}) => {
           ${properties ? `const {${properties}} = props ?? {};` : ""}
 
           return  ${operationReferenceName}(${adapter.getMutationHttpPrefix(mutator)}${properties}${properties ? "," : ""}${getMutationRequestArgs(isRequestOptions, httpClient, mutator, useRuntimeFetcher)})
@@ -1937,6 +1963,7 @@ ${hooksOptionImplementation}
 ${hasInvalidation ? adapter.generateMutationOnSuccess({
 		operationName,
 		definitions,
+		mutationVariablesType,
 		isRequestOptions,
 		generateInvalidateCall: createGenerateInvalidateCall(context.spec, !!query.shouldSplitQueryKey, !!query.useOperationIdAsQueryKey, context.output.baseUrl, context.spec.servers),
 		uniqueInvalidates
@@ -1956,7 +1983,7 @@ ${hasInvalidation ? adapter.generateMutationOnSuccess({
 	const mutationOptionsVarName = camel(`${operationName}-mutation-options`);
 	const mutationReturnType = adapter.getMutationReturnType({
 		dataType,
-		variableType: definitions ? `{${definitions}}` : "void"
+		variableType: mutationVariablesType
 	});
 	const mutationHookBody = adapter.generateMutationHookBody({
 		operationPrefix,
@@ -1971,11 +1998,14 @@ ${hasInvalidation ? adapter.generateMutationOnSuccess({
 	return {
 		implementation: `
 ${!mutator?.isHook && operationReferenceName !== operationName ? `const ${operationReferenceName} = ${operationName};` : ""}
+${mutationKeyFn}
+
 ${mutationOptionsFn}
 
     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}
+    ${variablesTypeName ? `export type ${variablesTypeName} = {${definitions}}` : ""}
 
     ${doc}export const ${camel(`${operationPrefix}-${operationName}`)} = <TError = ${errorType},
     TContext = unknown>(${mutationArguments} ${optionalQueryClientArgument})${mutationReturnType} => {
@@ -2320,7 +2350,11 @@ const generateQueryImplementation = ({ queryOption: { name, typeName: optionType
 		type,
 		adapter
 	});
-	const queryOptionsFnName = camel(queryKeyMutator || queryOptionsMutator || mutator?.isHook ? `use-${name}-queryOptions` : `get-${name}-queryOptions`);
+	const queryOptionsFnName = camel(shouldUseOptionsHook({
+		optionsMutator: queryOptionsMutator,
+		queryKeyMutator,
+		mutator
+	}) ? `use-${name}-queryOptions` : `get-${name}-queryOptions`);
 	const queryOptionsVarName = isRequestOptions ? "queryOptions" : "options";
 	const queryResultVarName = props.some((prop) => prop.name === "query") ? "_query" : "query";
 	const infiniteParam = infiniteQueryParamType ? `, ${infiniteQueryParamType}` : "";