feat: option to generate query invalidations

Author: aizerin

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

@@ -1209,6 +1209,25 @@ export const prefetchGetCategories = async <
 };
 ```
 
+#### useInvalidate
+
+Type: `Boolean`.
+
+Use to generate <a href="https://tanstack.com/query/latest/docs/framework/react/guides/query-invalidation" target="_blank">invalidation</a> functions.
+
+Example generated function:
+
+```js
+export const invalidateShowPetById = async (
+ queryClient: QueryClient, petId: string, options?: InvalidateOptions
+  ): Promise<QueryClient> => {
+
+  await queryClient.invalidateQueries({ queryKey: getShowPetByIdQueryKey(petId) }, options);
+
+  return queryClient;
+}
+```
+
 #### useInfiniteQueryParam
 
 Type: `String`.

packages/core/src/types.ts

@@ -578,6 +578,7 @@ export type NormalizedQueryOptions = {
   useSuspenseInfiniteQuery?: boolean;
   useInfiniteQueryParam?: string;
   usePrefetch?: boolean;
+  useInvalidate?: boolean;
   options?: any;
   queryKey?: NormalizedMutator;
   queryOptions?: NormalizedMutator;
@@ -599,6 +600,7 @@ export type QueryOptions = {
   useSuspenseInfiniteQuery?: boolean;
   useInfiniteQueryParam?: string;
   usePrefetch?: boolean;
+  useInvalidate?: boolean;
   options?: any;
   queryKey?: Mutator;
   queryOptions?: Mutator;

packages/orval/src/utils/options.ts

@@ -648,6 +648,9 @@ const normalizeQueryOptions = (
     ...(isUndefined(queryOptions.usePrefetch)
       ? {}
       : { usePrefetch: queryOptions.usePrefetch }),
+    ...(isUndefined(queryOptions.useInvalidate)
+      ? {}
+      : { useInvalidate: queryOptions.useInvalidate }),
     ...(isUndefined(queryOptions.useQuery)
       ? {}
       : { useQuery: queryOptions.useQuery }),

packages/query/src/index.ts

@@ -96,6 +96,7 @@ const SVELTE_QUERY_DEPENDENCIES_V3: GeneratorDependency[] = [
       { name: 'UseInfiniteQueryStoreResult' },
       { name: 'QueryKey' },
       { name: 'CreateMutationResult' },
+      { name: 'InvalidateOptions' },
     ],
     dependency: '@sveltestack/svelte-query',
   },
@@ -120,6 +121,7 @@ const SVELTE_QUERY_DEPENDENCIES: GeneratorDependency[] = [
       { name: 'CreateMutationResult' },
       { name: 'DataTag' },
       { name: 'QueryClient' },
+      { name: 'InvalidateOptions' },
     ],
     dependency: '@tanstack/svelte-query',
   },
@@ -177,6 +179,7 @@ const REACT_QUERY_DEPENDENCIES_V3: GeneratorDependency[] = [
       { name: 'QueryKey' },
       { name: 'QueryClient' },
       { name: 'UseMutationResult' },
+      { name: 'InvalidateOptions' },
     ],
     dependency: 'react-query',
   },
@@ -209,6 +212,7 @@ const REACT_QUERY_DEPENDENCIES: GeneratorDependency[] = [
       { name: 'InfiniteData' },
       { name: 'UseMutationResult' },
       { name: 'DataTag' },
+      { name: 'InvalidateOptions' },
     ],
     dependency: '@tanstack/react-query',
   },
@@ -268,6 +272,7 @@ const VUE_QUERY_DEPENDENCIES_V3: GeneratorDependency[] = [
       { name: 'UseInfiniteQueryResult' },
       { name: 'QueryKey' },
       { name: 'UseMutationReturnType' },
+      { name: 'InvalidateOptions' },
     ],
     dependency: 'vue-query/types',
   },
@@ -302,6 +307,7 @@ const VUE_QUERY_DEPENDENCIES: GeneratorDependency[] = [
       { name: 'UseMutationReturnType' },
       { name: 'DataTag' },
       { name: 'QueryClient' },
+      { name: 'InvalidateOptions' },
     ],
     dependency: '@tanstack/vue-query',
   },
@@ -772,6 +778,7 @@ const generateQueryImplementation = ({
   usePrefetch,
   useQuery,
   useInfinite,
+  useInvalidate,
 }: {
   queryOption: {
     name: string;
@@ -806,6 +813,7 @@ const generateQueryImplementation = ({
   usePrefetch?: boolean;
   useQuery?: boolean;
   useInfinite?: boolean;
+  useInvalidate?: boolean;
 }) => {
   const queryPropDefinitions = toObjectString(props, 'definition');
   const definedInitialDataQueryPropsDefinitions = toObjectString(
@@ -1086,6 +1094,14 @@ export function ${queryHookName}<TData = ${TData}, TError = ${errorType}>(\n ${q
   const prefetchVarName = camel(`prefetch-${operationName}-${prefetchType}`);
   const prefetchFnName = camel(`prefetch-${prefetchType}`);
 
+  const shouldGenerateInvalidate =
+    useInvalidate &&
+    (type === QueryType.QUERY ||
+      type === QueryType.INFINITE ||
+      (type === QueryType.SUSPENSE_QUERY && !useQuery) ||
+      (type === QueryType.SUSPENSE_INFINITE && !useInfinite));
+  const invalidateFnName = camel(`invalidate-${operationName}`);
+
   return `
 ${queryOptionsFn}
 
@@ -1132,6 +1148,16 @@ ${
 }\n`
     : ''
 }
+${
+  shouldGenerateInvalidate
+    ? `${doc}export const ${invalidateFnName} = async (\n queryClient: QueryClient, ${queryProps} options?: InvalidateOptions\n  ): Promise<QueryClient> => {
+
+  await queryClient.invalidateQueries({ queryKey: ${queryKeyFnName}(${queryKeyProperties}) }, options);
+
+  return queryClient;
+}\n`
+    : ''
+}
 `;
 };
 
@@ -1433,6 +1459,7 @@ ${override.query.shouldExportQueryKey ? 'export ' : ''}const ${queryOption.query
           usePrefetch: query.usePrefetch,
           useQuery: query.useQuery,
           useInfinite: query.useInfinite,
+          useInvalidate: query.useInvalidate,
         })
       );
     }, '')}

packages/query/src/utils.ts

@@ -22,6 +22,7 @@ export const normalizeQueryOptions = (
 ): NormalizedQueryOptions => {
   return {
     ...(queryOptions.usePrefetch ? { usePrefetch: true } : {}),
+    ...(queryOptions.useInvalidate ? { useInvalidate: true } : {}),
     ...(queryOptions.useQuery ? { useQuery: true } : {}),
     ...(queryOptions.useInfinite ? { useInfinite: true } : {}),
     ...(queryOptions.useInfiniteQueryParam

tests/configs/react-query.config.ts

@@ -513,4 +513,19 @@ export default defineConfig({
       target: '../specifications/models-with-special-char.yaml',
     },
   },
+  useInvalidate: {
+    output: {
+      target: '../generated/react-query/use-invalidate/endpoints.ts',
+      schemas: '../generated/react-query/use-invalidate/model',
+      client: 'react-query',
+      override: {
+        query: {
+          useInvalidate: true,
+        },
+      },
+    },
+    input: {
+      target: '../specifications/petstore.yaml',
+    },
+  },
 });