RFC: feat(query): add shouldExportMutatorHooks option

docs/src/pages/reference/configuration/output.md

@@ -727,6 +727,14 @@ Type: `Boolean`.
 
 Use to remove the generation of the abort signal provided by <a href="https://react-query.tanstack.com/" target="_blank">query</a>
 
+##### shouldExportMutatorHooks
+
+Type: `Boolean`.
+
+Default Value: `true`.
+
+Use to stop the export of mutator hooks. Useful if you want to rely soley on useQuery, useSuspenseQuery, etc.
+
 #### angular
 
 Type: `Object`.

packages/core/src/types.ts

@@ -332,6 +332,7 @@ export type NormalizedQueryOptions = {
   queryKey?: NormalizedMutator;
   queryOptions?: NormalizedMutator;
   mutationOptions?: NormalizedMutator;
+  shouldExportMutatorHooks?: boolean;
   signal?: boolean;
   version?: 3 | 4 | 5;
 };
@@ -348,6 +349,7 @@ export type QueryOptions = {
   queryKey?: Mutator;
   queryOptions?: Mutator;
   mutationOptions?: Mutator;
+  shouldExportMutatorHooks?: boolean;
   signal?: boolean;
   version?: 3 | 4 | 5;
 };

packages/orval/src/utils/options.ts

@@ -201,6 +201,7 @@ export const normalizeOptions = async (
           useQuery: true,
           useMutation: true,
           signal: true,
+          shouldExportMutatorHooks: true,
           ...normalizeQueryOptions(outputOptions.override?.query, workspace),
         },
         swr: {
@@ -440,6 +441,9 @@ const normalizeQueryOptions = (
           ),
         }
       : {}),
+    ...(!isUndefined(queryOptions.shouldExportMutatorHooks)
+      ? { shouldExportMutatorHooks: queryOptions.shouldExportMutatorHooks }
+      : {}),
     ...(!isUndefined(queryOptions.signal)
       ? { signal: queryOptions.signal }
       : {}),

packages/query/src/index.ts

@@ -437,7 +437,9 @@ const generateQueryRequestFunction = (
       : '';
 
     if (mutator.isHook) {
-      return `export const use${pascal(operationName)}Hook = () => {
+      return `${
+        override.query.shouldExportMutatorHooks ? 'export ' : ''
+      }const use${pascal(operationName)}Hook = () => {
         const ${operationName} = ${mutator.name}<${
         response.definition.success || 'unknown'
       }>();

packages/query/src/utils.ts

@@ -47,6 +47,9 @@ export const normalizeQueryOptions = (
           ),
         }
       : {}),
+    ...(queryOptions.shouldExportMutatorHooks
+      ? { shouldExportMutatorHooks: true }
+      : {}),
     ...(queryOptions.signal ? { signal: true } : {}),
   };
 };