feat(query): specify how querykey is filtered (orval-labs#3522)

* feat(query): specify how querykey is filtered

* fix(query): not boolean by default

Author: AllieJonsson

docs/content/docs/reference/configuration/output.mdx

@@ -910,12 +910,13 @@ Export query keys.
 **Type:** `Boolean`
 **Default:** `false`
 
-Add `.filter(Boolean)` to the query key. If false, `as const` is added instead.
+Add `.filter(q => q !== undefined)` to the query key. If false, `as const` is added instead.
+The filter can be adjusted with the `queryKeyFilter` option
 
 When shouldFilterQueryKey is true:
 ```ts title="endpoints.ts"
 export const getShowPetByIdQueryKey = (petId: string) => {
-  return ['pets', petId].filter(Boolean);
+  return ['pets', petId].filter(q => q !== undefined);
 };
 ```
 
@@ -926,6 +927,28 @@ export const getShowPetByIdQueryKey = (petId: string) => {
 };
 ```
 
+### queryKeyFilter
+
+**Type:** `String`
+**Default:** `'q => q !== undefined'`
+
+Adjusts how the queryKey is filtered, when `shouldFilterQueryKey` is `true`. Default is `'q => q !== undefined'`, which will result
+in it ending up beeing
+```ts title="endpoints.ts"
+.filter(q => q !== undefined)
+```
+
+One option could be to only make it filter out all falsy keys:
+```ts title="orval.config.ts"
+  shouldFilterQueryKey: true,
+  queryKeyFilter: 'Boolean'
+```
+
+which would result in the generated code being
+```ts title="endpoints.ts"
+.filter(Boolean)
+```
+
 ### shouldSplitQueryKey
 
 **Type:** `Boolean`

packages/core/src/types.ts

@@ -916,6 +916,7 @@ export interface NormalizedQueryOptions {
   shouldExportHttpClient?: boolean;
   shouldExportQueryKey?: boolean;
   shouldFilterQueryKey?: boolean;
+  queryKeyFilter?: string;
   shouldSplitQueryKey?: boolean;
   useOperationIdAsQueryKey?: boolean;
   signal?: boolean;
@@ -944,6 +945,7 @@ export interface QueryOptions {
   shouldExportHttpClient?: boolean;
   shouldExportQueryKey?: boolean;
   shouldFilterQueryKey?: boolean;
+  queryKeyFilter?: string;
   shouldSplitQueryKey?: boolean;
   useOperationIdAsQueryKey?: boolean;
   signal?: boolean;

packages/orval/src/utils/options.ts

@@ -1126,6 +1126,14 @@ function normalizeQueryOptions(
     ...(isNullish(queryOptions.shouldFilterQueryKey)
       ? {}
       : { shouldFilterQueryKey: queryOptions.shouldFilterQueryKey }),
+    ...(isNullish(globalOptions.queryKeyFilter)
+      ? {}
+      : {
+          queryKeyFilter: globalOptions.queryKeyFilter,
+        }),
+    ...(isNullish(queryOptions.queryKeyFilter)
+      ? {}
+      : { queryKeyFilter: queryOptions.queryKeyFilter }),
     ...(isNullish(globalOptions.shouldExportHttpClient)
       ? {}
       : {

packages/query/src/query-generator.ts

@@ -1164,7 +1164,7 @@ ${override.query.shouldExportQueryKey ? 'export ' : ''}const ${queryOption.query
     ]
       .filter((x) => !!x)
       .join(', ')}
-    ]${override.query.shouldFilterQueryKey ? '.filter(Boolean)' : ' as const'};
+    ]${override.query.shouldFilterQueryKey ? `.filter(${override.query.queryKeyFilter ?? 'q => q !== undefined'})` : ' as const'};
     }
 `;
       }

packages/query/src/utils.ts

@@ -70,6 +70,9 @@ export const normalizeQueryOptions = (
     ...(queryOptions.shouldFilterQueryKey
       ? { shouldFilterQueryKey: true }
       : {}),
+    ...(queryOptions.queryKeyFilter
+      ? { queryKeyFilter: queryOptions.queryKeyFilter }
+      : {}),
     ...(queryOptions.shouldExportHttpClient
       ? { shouldExportHttpClient: true }
       : {}),