feat: add invalidateQueries parameter for MobxMutation

Author: js2me

src/mobx-mutation.ts

@@ -9,7 +9,10 @@ import {
 import { LinkedAbortController } from 'linked-abort-controller';
 import { action, makeObservable, observable, reaction } from 'mobx';
 
-import { MobxMutationConfig } from './mobx-mutation.types';
+import {
+  MobxMutationConfig,
+  MobxMutationInvalidateQueriesOptions,
+} from './mobx-mutation.types';
 import { MobxQueryClient, MobxQueryClientHooks } from './mobx-query-client';
 
 export class MobxMutation<
@@ -33,7 +36,7 @@ export class MobxMutation<
   constructor(
     protected config: MobxMutationConfig<TData, TVariables, TError, TContext>,
   ) {
-    const { queryClient, ...restOptions } = config;
+    const { queryClient, invalidateQueries, ...restOptions } = config;
     this.abortController = new LinkedAbortController(config.abortSignal);
     this.queryClient = queryClient;
     this.result = undefined as any;
@@ -76,6 +79,29 @@ export class MobxMutation<
       }
     });
 
+    if (invalidateQueries) {
+      this.onDone((data, payload) => {
+        let invalidateOptions: MobxMutationInvalidateQueriesOptions;
+
+        if (typeof invalidateQueries === 'function') {
+          invalidateOptions = invalidateQueries(data, payload);
+        } else {
+          invalidateOptions = invalidateQueries;
+        }
+
+        if (invalidateOptions.queryKeys?.length) {
+          invalidateOptions.queryKeys?.forEach((queryKey) => {
+            this.queryClient.invalidateQueries({
+              ...invalidateOptions,
+              queryKey,
+            });
+          });
+        } else {
+          this.queryClient.invalidateQueries(invalidateOptions);
+        }
+      });
+    }
+
     config.onInit?.(this);
     this.hooks?.onMutationInit?.(this);
   }

src/mobx-mutation.types.ts

@@ -1,5 +1,6 @@
 import {
   DefaultError,
+  InvalidateQueryFilters,
   MutationObserverOptions,
   QueryClient,
 } from '@tanstack/query-core';
@@ -22,6 +23,11 @@ export interface MobxMutationFeatures {
   resetOnDestroy?: boolean;
 }
 
+export interface MobxMutationInvalidateQueriesOptions
+  extends Omit<InvalidateQueryFilters, 'queryKey'> {
+  queryKeys?: InvalidateQueryFilters['queryKey'][];
+}
+
 export interface MobxMutationConfig<
   TData = unknown,
   TVariables = void,
@@ -38,6 +44,12 @@ export interface MobxMutationConfig<
    */
   disposer?: IDisposer;
   abortSignal?: AbortSignal;
+  invalidateQueries?:
+    | MobxMutationInvalidateQueriesOptions
+    | ((
+        data: TData,
+        payload: TVariables,
+      ) => MobxMutationInvalidateQueriesOptions);
   onInit?: (
     mutation: MobxMutation<TData, TVariables, TError, TContext>,
   ) => void;