feat: add cumulativeQueryHash option

Author: js2me

.changeset/easy-readers-shake.md

@@ -0,0 +1,5 @@
+---
+"mobx-tanstack-query": minor
+---
+
+added `cumulativeQueryHash` option for queries

src/inifinite-query.ts

@@ -261,6 +261,8 @@ export class InfiniteQuery<
   private hooks?: QueryClientHooks;
   protected errorListeners: InfiniteQueryErrorListener<TError>[];
   protected doneListeners: InfiniteQueryDoneListener<TData>[];
+  protected cumulativeQueryHash: boolean;
+  protected cumulativeQueryKeyHashesSet: Set<string>;
 
   constructor(
     config: InfiniteQueryConfig<
@@ -310,6 +312,7 @@ export class InfiniteQuery<
       config = args[0];
       getDynamicOptions = args[0].options;
     }
+    this.cumulativeQueryKeyHashesSet = new Set();
 
     const { queryKey: queryKeyOrDynamicQueryKey, ...restOptions } = config;
 
@@ -328,6 +331,8 @@ export class InfiniteQuery<
     this.hooks =
       'hooks' in this.queryClient ? this.queryClient.hooks : undefined;
     this.isLazy = this.config.lazy;
+    this.cumulativeQueryHash = !!config.cumulativeQueryHash;
+
     let transformError: QueryFeatures['transformError'] = config.transformError;
 
     if ('queryFeatures' in queryClient) {
@@ -338,6 +343,10 @@ export class InfiniteQuery<
         this.isEnabledOnResultDemand =
           queryClient.queryFeatures.enableOnDemand ?? false;
       }
+      if (config.cumulativeQueryHash === undefined) {
+        this.cumulativeQueryHash =
+          queryClient.queryFeatures.cumulativeQueryHash ?? false;
+      }
       if (!transformError) {
         transformError = queryClient.queryFeatures.transformError;
       }
@@ -645,6 +654,9 @@ export class InfiniteQuery<
     }
 
     delete this._observerSubscription;
+
+    this.cumulativeQueryKeyHashesSet.clear();
+
     this.hooks?.onInfiniteQueryDestroy?.(this);
   }
 

src/query.ts

@@ -113,6 +113,9 @@ export class Query<
   protected errorListeners: QueryErrorListener<TError>[];
   protected doneListeners: QueryDoneListener<TData>[];
 
+  protected cumulativeQueryHash: boolean;
+  protected cumulativeQueryKeyHashesSet: Set<string>;
+
   protected config: QueryConfig<
     TQueryFnData,
     TError,
@@ -266,6 +269,7 @@ export class Query<
       config = args[0];
       getDynamicOptions = args[0].options;
     }
+    this.cumulativeQueryKeyHashesSet = new Set();
 
     const { queryKey: queryKeyOrDynamicQueryKey, ...restOptions } = config;
 
@@ -284,6 +288,8 @@ export class Query<
     this.hooks =
       'hooks' in this.queryClient ? this.queryClient.hooks : undefined;
     this.isLazy = this.config.lazy;
+    this.cumulativeQueryHash = !!config.cumulativeQueryHash;
+
     let transformError: QueryFeatures['transformError'] = config.transformError;
 
     if ('queryFeatures' in queryClient) {
@@ -294,6 +300,10 @@ export class Query<
         this.isEnabledOnResultDemand =
           queryClient.queryFeatures.enableOnDemand ?? false;
       }
+      if (config.cumulativeQueryHash === undefined) {
+        this.cumulativeQueryHash =
+          queryClient.queryFeatures.cumulativeQueryHash ?? false;
+      }
       if (!transformError) {
         transformError = queryClient.queryFeatures.transformError;
       }
@@ -530,6 +540,10 @@ export class Query<
   ) {
     options.queryHash = this.createQueryHash(options.queryKey, options);
 
+    if (this.cumulativeQueryHash) {
+      this.cumulativeQueryKeyHashesSet.add(options.queryHash);
+    }
+
     // If the on-demand query mode is enabled (when using the result property)
     // then, if the user does not request the result, the queries should not be executed
     // to do this, we hold the original value of the enabled option
@@ -579,6 +593,14 @@ export class Query<
   }
 
   async reset(params?: QueryResetParams, options?: ResetOptions) {
+    if (this.cumulativeQueryHash) {
+      return await this.queryClient.resetQueries({
+        predicate: (query) =>
+          this.cumulativeQueryKeyHashesSet.has(query.options.queryHash!),
+        ...params,
+      });
+    }
+
     return await this.queryClient.resetQueries(
       {
         queryKey: this.options.queryKey,
@@ -590,6 +612,14 @@ export class Query<
   }
 
   remove(params?: QueryRemoveParams) {
+    if (this.cumulativeQueryHash) {
+      return this.queryClient.removeQueries({
+        predicate: (query) =>
+          this.cumulativeQueryKeyHashesSet.has(query.options.queryHash!),
+        ...params,
+      });
+    }
+
     return this.queryClient.removeQueries({
       queryKey: this.options.queryKey,
       exact: true,
@@ -657,6 +687,8 @@ export class Query<
 
     delete this._observerSubscription;
 
+    this.cumulativeQueryKeyHashesSet.clear();
+
     this.hooks?.onQueryDestroy?.(this);
   }
 

src/query.types.ts

@@ -19,10 +19,10 @@ export interface QueryInvalidateParams
 export type MobxQueryInvalidateParams = QueryInvalidateParams;
 
 export interface QueryResetParams
-  extends Partial<Omit<QueryFilters, 'queryKey' | 'exact'>> {}
+  extends Partial<Omit<QueryFilters, 'queryKey' | 'exact' | 'predicate'>> {}
 
 export interface QueryRemoveParams
-  extends Partial<Omit<QueryFilters, 'queryKey' | 'exact'>> {}
+  extends Partial<Omit<QueryFilters, 'queryKey' | 'exact' | 'predicate'>> {}
 
 /**
  * @deprecated ⚠️ use `QueryResetParams`. This type will be removed in next major release
@@ -139,6 +139,12 @@ export interface QueryFeatures {
    */
   lazy?: boolean;
   transformError?: (error: any) => any;
+
+  /**
+   * Cumulative all query key hashes when user update options inside query
+   * When destroy happened all accumulated query keys will be removed (if removeOnDestroy is true), and reseted (if resetOnDestroy is true)
+   */
+  cumulativeQueryHash?: boolean;
 }
 
 /**