@orval/query 8.26.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
@@ -1929,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} => {
 
@@ -1983,6 +1998,8 @@ ${hasInvalidation ? adapter.generateMutationOnSuccess({
 	return {
 		implementation: `
 ${!mutator?.isHook && operationReferenceName !== operationName ? `const ${operationReferenceName} = ${operationName};` : ""}
+${mutationKeyFn}
+
 ${mutationOptionsFn}
 
     export type ${pascal(typeName)}MutationResult = NonNullable<Awaited<ReturnType<${dataType}>>>
@@ -2333,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}` : "";