feat(query): add shouldExportMutatorHooks option (#1105)

anymaniax · Jan 31, 2024 · e602232 · e602232
1 parent 2a77a04
commit e602232
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 1 deletion.
diff --git a/docs/src/pages/reference/configuration/output.md b/docs/src/pages/reference/configuration/output.md
@@ -746,6 +746,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`.

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -333,6 +333,7 @@ export type NormalizedQueryOptions = {
   queryKey?: NormalizedMutator;
   queryOptions?: NormalizedMutator;
   mutationOptions?: NormalizedMutator;
+  shouldExportMutatorHooks?: boolean;
   signal?: boolean;
   version?: 3 | 4 | 5;
 };
@@ -349,6 +350,7 @@ export type QueryOptions = {
   queryKey?: Mutator;
   queryOptions?: Mutator;
   mutationOptions?: Mutator;
+  shouldExportMutatorHooks?: boolean;
   signal?: boolean;
   version?: 3 | 4 | 5;
 };

diff --git a/packages/orval/src/utils/options.ts b/packages/orval/src/utils/options.ts
@@ -206,6 +206,7 @@ export const normalizeOptions = async (
           useQuery: true,
           useMutation: true,
           signal: true,
+          shouldExportMutatorHooks: true,
           ...normalizeQueryOptions(outputOptions.override?.query, workspace),
         },
         swr: {
@@ -450,6 +451,9 @@ const normalizeQueryOptions = (
           ),
         }
       : {}),
+    ...(!isUndefined(queryOptions.shouldExportMutatorHooks)
+      ? { shouldExportMutatorHooks: queryOptions.shouldExportMutatorHooks }
+      : {}),
     ...(!isUndefined(queryOptions.signal)
       ? { signal: queryOptions.signal }
       : {}),

diff --git a/packages/query/src/index.ts b/packages/query/src/index.ts
@@ -438,7 +438,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'
         }>();

diff --git a/packages/query/src/utils.ts b/packages/query/src/utils.ts
@@ -47,6 +47,9 @@ export const normalizeQueryOptions = (
           ),
         }
       : {}),
+    ...(queryOptions.shouldExportMutatorHooks
+      ? { shouldExportMutatorHooks: true }
+      : {}),
     ...(queryOptions.signal ? { signal: true } : {}),
   };
 };