fix: typings for MobxQuery

Author: js2me

src/mobx-infinite-query.test.ts

@@ -311,6 +311,7 @@ describe('MobxInfiniteQuery', () => {
 
     mobxQuery.dispose();
   });
+
   it('should call queryFn after fetchNextPage call (x3 times)', async () => {
     const mobxQuery = new MobxInfiniteQueryMock({
       queryKey: ['test'],
@@ -408,4 +409,87 @@ describe('MobxInfiniteQuery', () => {
 
     mobxQuery.dispose();
   });
+
+  describe('"enabled" reactive parameter', () => {
+    it.skip('should be reactive after change queryKey', async () => {
+      const mobxQuery = new MobxInfiniteQueryMock({
+        queryKey: ['test', 0 as number] as const,
+        enabled: ({ queryKey }) => queryKey[1] > 0,
+        queryFn: () => 100,
+      });
+
+      mobxQuery.update({ queryKey: ['test', 1] as const });
+
+      await when(() => !mobxQuery._rawResult.isFetching);
+
+      expect(mobxQuery.spies.queryFn).toBeCalledTimes(1);
+      expect(mobxQuery.spies.queryFn).nthReturnedWith(1, 100);
+
+      mobxQuery.dispose();
+    });
+
+    it.skip('should be reactive dependent on another query (runs before declartion)', async () => {
+      const disabledMobxQuery = new MobxInfiniteQueryMock({
+        queryKey: ['test', 0 as number] as const,
+        enabled: ({ queryKey }) => queryKey[1] > 0,
+        queryFn: () => 100,
+      });
+
+      disabledMobxQuery.update({ queryKey: ['test', 1] as const });
+
+      const dependentMobxQuery = new MobxInfiniteQueryMock({
+        options: () => ({
+          enabled: !!disabledMobxQuery.options.enabled,
+          queryKey: [...disabledMobxQuery.options.queryKey, 'dependent'],
+        }),
+        queryFn: ({ queryKey }) => queryKey,
+      });
+
+      await when(() => !disabledMobxQuery._rawResult.isLoading);
+      await when(() => !dependentMobxQuery._rawResult.isLoading);
+
+      expect(dependentMobxQuery.spies.queryFn).toBeCalledTimes(1);
+      expect(dependentMobxQuery.spies.queryFn).nthReturnedWith(1, [
+        'test',
+        1,
+        'dependent',
+      ]);
+
+      disabledMobxQuery.dispose();
+      dependentMobxQuery.dispose();
+    });
+
+    it.skip('should be reactive dependent on another query (runs after declaration)', async () => {
+      const tempDisabledMobxQuery = new MobxInfiniteQueryMock({
+        queryKey: ['test', 0 as number] as const,
+        enabled: ({ queryKey }) => queryKey[1] > 0,
+        queryFn: () => 100,
+      });
+
+      const dependentMobxQuery = new MobxInfiniteQueryMock({
+        options: () => ({
+          enabled: !!tempDisabledMobxQuery.options.enabled,
+          queryKey: [...tempDisabledMobxQuery.options.queryKey, 'dependent'],
+        }),
+        queryFn: ({ queryKey }) => queryKey,
+      });
+
+      tempDisabledMobxQuery.update({ queryKey: ['test', 1] as const });
+
+      await when(() => !tempDisabledMobxQuery._rawResult.isLoading);
+      await when(() => !dependentMobxQuery._rawResult.isLoading);
+
+      expect(dependentMobxQuery.spies.queryFn).toBeCalledTimes(1);
+      // результат с 0 потому что options.enabled у первой квери - это функция и
+      // !!tempDisabledMobxQuery.options.enabled будет всегда true
+      expect(dependentMobxQuery.spies.queryFn).nthReturnedWith(1, [
+        'test',
+        0,
+        'dependent',
+      ]);
+
+      tempDisabledMobxQuery.dispose();
+      dependentMobxQuery.dispose();
+    });
+  });
 });

src/mobx-inifinite-query.types.ts

@@ -54,6 +54,22 @@ export interface MobxInfiniteQueryOptions<
     TPageParam
   > {}
 
+export interface MobxInfiniteQueryUpdateOptions<
+  TData,
+  TError = DefaultError,
+  TQueryKey extends QueryKey = QueryKey,
+  TPageParam = unknown,
+> extends Partial<
+    InfiniteQueryObserverOptions<
+      TData,
+      TError,
+      InfiniteData<TData>,
+      InfiniteData<TData>,
+      TQueryKey,
+      TPageParam
+    >
+  > {}
+
 export interface MobxInfiniteQueryConfig<
   TData,
   TError = DefaultError,
@@ -119,19 +135,3 @@ export interface MobxInfiniteQueryConfig<
    */
   enableOnDemand?: boolean;
 }
-
-export interface MobxInfiniteQueryUpdateOptions<
-  TData,
-  TError = DefaultError,
-  TQueryKey extends QueryKey = QueryKey,
-  TPageParam = unknown,
-> extends Partial<
-    InfiniteQueryObserverOptions<
-      TData,
-      TError,
-      InfiniteData<TData>,
-      InfiniteData<TData>,
-      TQueryKey,
-      TPageParam
-    >
-  > {}

src/mobx-query.test.ts

@@ -2,7 +2,6 @@ import {
   DefaultError,
   QueryClient,
   QueryKey,
-  QueryObserverOptions,
   QueryObserverResult,
   RefetchOptions,
   SetDataOptions,
@@ -12,7 +11,12 @@ import { observable, reaction, runInAction, when } from 'mobx';
 import { describe, expect, it, vi } from 'vitest';
 
 import { MobxQuery } from './mobx-query';
-import { MobxQueryConfig, MobxQueryInvalidateParams } from './mobx-query.types';
+import {
+  MobxQueryConfig,
+  MobxQueryDynamicOptions,
+  MobxQueryInvalidateParams,
+  MobxQueryUpdateOptions,
+} from './mobx-query.types';
 
 class MobxQueryMock<
   TData,
@@ -67,9 +71,9 @@ class MobxQueryMock<
   }
 
   update(
-    options: Partial<
-      QueryObserverOptions<TData, TError, TQueryKey, TData, QueryKey, never>
-    >,
+    options:
+      | MobxQueryUpdateOptions<TData, TError, TQueryKey>
+      | MobxQueryDynamicOptions<TData, TError, TQueryKey>,
   ): void {
     const result = super.update(options);
     this.spies.update.mockReturnValue(result)(options);
@@ -190,7 +194,7 @@ describe('MobxQuery', () => {
   describe('"enabled" reactive parameter', () => {
     it('should be reactive after change queryKey', async () => {
       const mobxQuery = new MobxQueryMock({
-        queryKey: ['test', 0] as const,
+        queryKey: ['test', 0 as number] as const,
         enabled: ({ queryKey }) => queryKey[1] > 0,
         queryFn: () => 100,
       });
@@ -207,7 +211,7 @@ describe('MobxQuery', () => {
 
     it('should be reactive dependent on another query (runs before declartion)', async () => {
       const disabledMobxQuery = new MobxQueryMock({
-        queryKey: ['test', 0] as const,
+        queryKey: ['test', 0 as number] as const,
         enabled: ({ queryKey }) => queryKey[1] > 0,
         queryFn: () => 100,
       });
@@ -238,7 +242,7 @@ describe('MobxQuery', () => {
 
     it('should be reactive dependent on another query (runs after declaration)', async () => {
       const tempDisabledMobxQuery = new MobxQueryMock({
-        queryKey: ['test', 0] as const,
+        queryKey: ['test', 0 as number] as const,
         enabled: ({ queryKey }) => queryKey[1] > 0,
         queryFn: () => 100,
       });

src/mobx-query.types.ts

@@ -30,12 +30,6 @@ export interface MobxQueryDynamicOptions<
   enabled?: boolean;
 }
 
-export type MobxQueryUpdateOptions<
-  TData,
-  TError = DefaultError,
-  TQueryKey extends QueryKey = QueryKey,
-> = Partial<QueryObserverOptions<TData, TError, TQueryKey>>;
-
 export interface MobxQueryOptions<
   TData,
   TError = DefaultError,
@@ -48,6 +42,12 @@ export interface MobxQueryOptions<
     TQueryKey
   > {}
 
+export type MobxQueryUpdateOptions<
+  TData,
+  TError = DefaultError,
+  TQueryKey extends QueryKey = QueryKey,
+> = Partial<QueryObserverOptions<TData, TError, TData, TData, TQueryKey>>;
+
 export interface MobxQueryConfig<
   TData,
   TError = DefaultError,