feat: add hooks for MobxQueryClient

Author: js2me

src/mobx-inifinite-query.ts

@@ -29,7 +29,7 @@ import {
   MobxInfiniteQueryResetParams,
   MobxInfiniteQueryUpdateOptions,
 } from './mobx-inifinite-query.types';
-import { MobxQueryClient } from './mobx-query-client';
+import { MobxQueryClient, MobxQueryClientHooks } from './mobx-query-client';
 
 export class MobxInfiniteQuery<
   TData,
@@ -66,6 +66,7 @@ export class MobxInfiniteQuery<
     TPageParam
   >['enabled'];
   private _observerSubscription?: VoidFunction;
+  private hooks?: MobxQueryClientHooks;
 
   constructor(
     protected config: MobxInfiniteQueryConfig<
@@ -85,6 +86,8 @@ export class MobxInfiniteQuery<
     this._result = undefined as any;
     this.isResultRequsted = false;
     this.isEnabledOnResultDemand = config.enableOnDemand ?? false;
+    this.hooks =
+      'hooks' in this.queryClient ? this.queryClient.hooks : undefined;
 
     if (
       queryClient instanceof MobxQueryClient &&
@@ -174,6 +177,7 @@ export class MobxInfiniteQuery<
     this.abortController.signal.addEventListener('abort', this.handleAbort);
 
     this.config.onInit?.(this);
+    this.hooks?.onInfiniteQueryInit?.(this);
   }
 
   protected createQueryHash(
@@ -351,6 +355,7 @@ export class MobxInfiniteQuery<
 
   destroy() {
     this.abortController.abort();
+    this.hooks?.onInfiniteQueryDestroy?.(this);
   }
 
   /**

src/mobx-mutation.ts

@@ -10,7 +10,7 @@ import { LinkedAbortController } from 'linked-abort-controller';
 import { action, makeObservable, observable, reaction } from 'mobx';
 
 import { MobxMutationConfig } from './mobx-mutation.types';
-import { MobxQueryClient } from './mobx-query-client';
+import { MobxQueryClient, MobxQueryClientHooks } from './mobx-query-client';
 
 export class MobxMutation<
   TData = unknown,
@@ -28,6 +28,7 @@ export class MobxMutation<
   result: MutationObserverResult<TData, TError, TVariables, TContext>;
 
   private _observerSubscription?: VoidFunction;
+  private hooks?: MobxQueryClientHooks;
 
   constructor(
     protected config: MobxMutationConfig<TData, TVariables, TError, TContext>,
@@ -47,6 +48,8 @@ export class MobxMutation<
     makeObservable(this);
 
     this.mutationOptions = this.queryClient.defaultMutationOptions(restOptions);
+    this.hooks =
+      'hooks' in this.queryClient ? this.queryClient.hooks : undefined;
 
     this.mutationObserver = new MutationObserver<
       TData,
@@ -74,6 +77,7 @@ export class MobxMutation<
     });
 
     config.onInit?.(this);
+    this.hooks?.onMutationInit?.(this);
   }
 
   async mutate(
@@ -149,6 +153,7 @@ export class MobxMutation<
 
   destroy() {
     this.abortController.abort();
+    this.hooks?.onMutationDestroy?.(this);
   }
 
   /**

src/mobx-query-client.ts

@@ -5,18 +5,33 @@ import {
   QueryClientConfig,
 } from '@tanstack/query-core';
 
+import { MobxInfiniteQuery } from './mobx-inifinite-query';
+import { MobxMutation } from './mobx-mutation';
 import { MobxMutationFeatures } from './mobx-mutation.types';
+import { MobxQuery } from './mobx-query';
 import { MobxQueryFeatures } from './mobx-query.types';
 
-interface MobxDefaultOptions<TError = DefaultError>
+export interface MobxDefaultOptions<TError = DefaultError>
   extends Omit<DefaultOptions<TError>, 'queries' | 'mutations'> {
   queries?: DefaultOptions<TError>['queries'] & MobxQueryFeatures;
   mutations?: DefaultOptions<TError>['mutations'] & MobxMutationFeatures;
 }
 
+export interface MobxQueryClientHooks {
+  onQueryInit?: (query: MobxQuery<any, any, any>) => void;
+  onInfiniteQueryInit?: (query: MobxInfiniteQuery<any, any, any, any>) => void;
+  onMutationInit?: (query: MobxMutation<any, any, any, any>) => void;
+  onQueryDestroy?: (query: MobxQuery<any, any, any>) => void;
+  onInfiniteQueryDestroy?: (
+    query: MobxInfiniteQuery<any, any, any, any>,
+  ) => void;
+  onMutationDestroy?: (query: MobxMutation<any, any, any, any>) => void;
+}
+
 export interface MobxQueryClientConfig
   extends Omit<QueryClientConfig, 'defaultOptions'> {
   defaultOptions?: MobxDefaultOptions;
+  hooks?: MobxQueryClientHooks;
 }
 
 export class MobxQueryClient extends QueryClient {
@@ -42,6 +57,10 @@ export class MobxQueryClient extends QueryClient {
     return this.getDefaultOptions().queries ?? {};
   }
 
+  get hooks(): MobxQueryClientHooks | undefined {
+    return this.config.hooks;
+  }
+
   get mutationFeatures(): MobxMutationFeatures {
     return this.getDefaultOptions().mutations ?? {};
   }

src/mobx-query.ts

@@ -18,7 +18,7 @@ import {
   runInAction,
 } from 'mobx';
 
-import { MobxQueryClient } from './mobx-query-client';
+import { MobxQueryClient, MobxQueryClientHooks } from './mobx-query-client';
 import {
   MobxQueryConfig,
   MobxQueryDynamicOptions,
@@ -48,6 +48,7 @@ export class MobxQuery<
 
   private _originEnabled: MobxQueryOptions<TData, TError, TQueryKey>['enabled'];
   private _observerSubscription?: VoidFunction;
+  private hooks?: MobxQueryClientHooks;
 
   constructor(protected config: MobxQueryConfig<TData, TError, TQueryKey>) {
     const {
@@ -60,6 +61,8 @@ export class MobxQuery<
     this._result = undefined as any;
     this.isResultRequsted = false;
     this.isEnabledOnResultDemand = config.enableOnDemand ?? false;
+    this.hooks =
+      'hooks' in this.queryClient ? this.queryClient.hooks : undefined;
 
     if (
       queryClient instanceof MobxQueryClient &&
@@ -149,6 +152,7 @@ export class MobxQuery<
     this.abortController.signal.addEventListener('abort', this.handleAbort);
 
     this.config.onInit?.(this);
+    this.hooks?.onQueryInit?.(this);
   }
 
   async refetch(options?: RefetchOptions) {
@@ -305,6 +309,7 @@ export class MobxQuery<
 
   destroy() {
     this.abortController.abort();
+    this.hooks?.onQueryDestroy?.(this);
   }
 
   /**