Feat: Add shouldSplitQueryKey property

packages/core/src/types.ts

@@ -465,6 +465,7 @@ export type NormalizedQueryOptions = {
   shouldExportMutatorHooks?: boolean;
   shouldExportHttpClient?: boolean;
   shouldExportQueryKey?: boolean;
+  shouldSplitQueryKey?: boolean;
   signal?: boolean;
   version?: 3 | 4 | 5;
 };
@@ -484,6 +485,7 @@ export type QueryOptions = {
   shouldExportMutatorHooks?: boolean;
   shouldExportHttpClient?: boolean;
   shouldExportQueryKey?: boolean;
+  shouldSplitQueryKey?: boolean;
   signal?: boolean;
   version?: 3 | 4 | 5;
 };

packages/query/src/index.ts

@@ -1182,9 +1182,10 @@ const generateQueryHook = async (
       'implementation',
     );
 
-    const routeString = isVue(outputClient)
-      ? getRouteAsArray(route) // Note: this is required for reactivity to work, we will lose it if route params are converted into string, only as array they will be tracked // TODO: add tests for this
-      : `\`${route}\``;
+    const routeString =
+      isVue(outputClient) || override.query.shouldSplitQueryKey
+        ? getRouteAsArray(route) // Note: this is required for reactivity to work, we will lose it if route params are converted into string, only as array they will be tracked // TODO: add tests for this
+        : `\`${route}\``;
 
     // Note: do not unref() params in Vue - this will make key lose reactivity
     const queryKeyFn = `${

packages/query/src/utils.ts

@@ -58,6 +58,7 @@ export const normalizeQueryOptions = (
     ...(queryOptions.shouldExportHttpClient
       ? { shouldExportHttpClient: true }
       : {}),
+    ...(queryOptions.shouldSplitQueryKey ? { shouldSplitQueryKey: true } : {}),
   };
 };
 

samples/react-query/basic/orval.config.ts

@@ -15,6 +15,9 @@ export default defineConfig({
           path: './src/api/mutator/custom-instance.ts',
           name: 'customInstance',
         },
+        query: {
+          shouldSplitQueryKey: true,
+        },
         operations: {
           listPets: {
             mock: {

tests/configs/react-query.config.ts

@@ -8,6 +8,11 @@ export default defineConfig({
       client: 'react-query',
       mock: true,
       headers: true,
+      override: {
+        query: {
+          shouldSplitQueryKey: true,
+        },
+      },
     },
     input: {
       target: '../specifications/petstore.yaml',
@@ -25,6 +30,7 @@ export default defineConfig({
       target: '../specifications/petstore.yaml',
     },
   },
+
   petstoreSplit: {
     output: {
       target: '../generated/react-query/split/endpoints.ts',
@@ -409,4 +415,21 @@ export default defineConfig({
       },
     },
   },
+  splitedQueryKey: {
+    output: {
+      target: '../generated/react-query/splitedQueryKey/endpoints.ts',
+      schemas: '../generated/react-query/splitedQueryKey/model',
+      client: 'react-query',
+      mock: true,
+      headers: true,
+      override: {
+        query: {
+          shouldSplitQueryKey: true,
+        },
+      },
+    },
+    input: {
+      target: '../specifications/petstore.yaml',
+    },
+  },
 });

tests/specifications/petstore.yaml

@@ -176,6 +176,27 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+  /pets/status/{status}:
+    get:
+      summary: Finds Pets by status
+      operationId: findPetsByStatus
+      tags:
+        - pets
+      parameters:
+        - name: status
+          in: path
+          required: true
+          description: Status values that need to be considered for filter
+          schema:
+            type: string
+            enum:
+              - available
+              - pending
+              - sold
+      responses:
+        '200':
+          description: A paged array of pets
+          content:
   /health:
     get:
       summary: health check