@astral/mobx-query 1.7.1 → 1.8.0

package/AuxiliaryQuery/AuxiliaryQuery.d.ts

@@ -30,7 +30,7 @@ export declare class AuxiliaryQuery<TResult, TError = void> {
      * Метод ответственный за создание единого промиса,
      * для устранения гонки запросов
      */
-    getUnifiedPromise: (executor: Executor<TResult>, onSuccess?: ((data: TResult) => void) | undefined) => Promise<TResult>;
+    getUnifiedPromise: (executor: Executor<TResult>, onSuccess?: (data: TResult) => void) => Promise<TResult>;
     private setSuccess;
     private checkBackgroundAndSet;
     /**

package/InfiniteQuery/InfiniteQuery.js

@@ -46,8 +46,6 @@ export class InfiniteQuery extends QueryContainer {
          * Форс метод для установки данных
          */
         this.forceUpdate = (data) => {
-            this.offset = 0;
-            this.isEndReached = false;
             this.auxiliary.submitSuccess();
             this.submitSuccess(data);
         };

package/MobxQuery/MobxQuery.d.ts

@@ -24,20 +24,27 @@ type MobxQueryParams = {
      */
     enabledAutoFetch?: boolean;
 };
-type CreateQueryParams<TResult, TError, TIsBackground extends boolean> = Omit<QueryParams<TResult, TError, TIsBackground>, 'dataStorage' | 'statusStorage' | 'backgroundStatusStorage' | 'submitValidity'> & {
+export type CreateQueryParams<TResult, TError, TIsBackground extends boolean> = Omit<QueryParams<TResult, TError, TIsBackground>, 'dataStorage' | 'statusStorage' | 'backgroundStatusStorage' | 'submitValidity'> & {
     /**
      * Режим фонового обновления
      * @default false
      */
     isBackground?: TIsBackground;
 };
-type CreateInfiniteQueryParams<TResult, TError, TIsBackground extends boolean> = Omit<InfiniteQueryParams<TResult, TError, TIsBackground>, 'dataStorage' | 'statusStorage' | 'backgroundStatusStorage' | 'submitValidity'> & {
+export type CreateInfiniteQueryParams<TResult, TError, TIsBackground extends boolean> = Omit<InfiniteQueryParams<TResult, TError, TIsBackground>, 'dataStorage' | 'statusStorage' | 'backgroundStatusStorage' | 'submitValidity'> & {
     /**
      * Режим фонового обновления
      * @default false
      */
     isBackground?: TIsBackground;
 };
+export type CreateMutationParams<TResult, TError> = MutationParams<TResult, TError>;
+/**
+ * Стратегия инвалидации кэша
+ * @property 'partial-match' - Проверяет наличие хотя бы одной части ключа в кэше
+ * @property 'chain-match' - Проверяет наличие полной связки ключей в кэше
+ */
+type InvalidateStrategy = 'partial-match' | 'chain-match';
 /**
  * Сервис, позволяющий кэшировать данные.
  */
@@ -74,10 +81,26 @@ export declare class MobxQuery<TDefaultError = void> {
     private serialize;
     constructor({ onError, fetchPolicy, enabledAutoFetch, }?: MobxQueryParams);
     /**
-     * Метод для инвалидации по списку ключей,
-     * предполагается использование из домена
-     */
-    invalidate: (keysParts: CacheKey[]) => void;
+     * Проверяет пересечение ключей в зависимости от стратегии
+     * @param invalidatedKeys - Ключи для инвалидации
+     * @param queryKeys - Ключи запроса
+     * @param strategy - Стратегия проверки:
+     * - 'chain-match' - все ключи из invalidatedKeys должны присутствовать в queryKeys
+     * - 'partial-match' - хотя бы один ключ из invalidatedKeys должен быть в queryKeys
+     */
+    private checkTouchedElement;
+    /**
+     * Метод для инвалидации по списку ключей, предполагается использование из домена
+     * @param invalidatedKeys - Массив ключей для инвалидации
+     * @param strategy - Стратегия инвалидации. 'chain-match' - инвалидировать при совпадении связки ключей в кэше, 'partial-match' - инвалидировать при частичном совпадении ключей. По умолчанию 'partial-match'
+     * @example
+     * // Инвалидация по частичному совпадению ключей
+     * mobxQuery.invalidate(['users', '1']); // Инвалидирует все query, содержащие ключ 'users' или '1'
+     *
+     * // Инвалидация по совпадению связки ключей
+     * mobxQuery.invalidate(['users', '1'], 'chain-match'); // Инвалидирует только query с точным набором ключей ['users', '1']
+     */
+    invalidate: (invalidatedKeys: CacheKey[], strategy?: InvalidateStrategy) => void;
     private submitValidity;
     /**
      * Метод инвалидации всех query
@@ -96,14 +119,14 @@ export declare class MobxQuery<TDefaultError = void> {
     /**
      * Метод создания стора, кешируется
      */
-    createQuery: <TResult, TError = TDefaultError, TIsBackground extends boolean = false>(key: CacheKey[], executor: QueryExecutor<TResult>, params?: CreateQueryParams<TResult, TError, TIsBackground> | undefined) => Query<TResult, TError, TIsBackground>;
+    createQuery: <TResult, TError = TDefaultError, TIsBackground extends boolean = false>(key: CacheKey[], executor: QueryExecutor<TResult>, params?: CreateQueryParams<TResult, TError, TIsBackground>) => Query<TResult, TError, TIsBackground>;
     /**
      * Метод создания инфинит стора, кешируется
      */
-    createInfiniteQuery: <TResult, TError = TDefaultError, TIsBackground extends boolean = false>(key: CacheKey[], executor: InfiniteExecutor<TResult>, params?: CreateInfiniteQueryParams<TResult, TError, TIsBackground> | undefined) => InfiniteQuery<TResult, TError, TIsBackground>;
+    createInfiniteQuery: <TResult, TError = TDefaultError, TIsBackground extends boolean = false>(key: CacheKey[], executor: InfiniteExecutor<TResult>, params?: CreateInfiniteQueryParams<TResult, TError, TIsBackground>) => InfiniteQuery<TResult, TError, TIsBackground>;
     /**
      * Метод создания мутации, не кешируется
      */
-    createMutation: <TResult, TError = TDefaultError, TExecutorParams = void>(executor: MutationExecutor<TResult, TExecutorParams>, params?: MutationParams<TResult, TError> | undefined) => Mutation<TResult, TError, TExecutorParams>;
+    createMutation: <TResult, TError = TDefaultError, TExecutorParams = void>(executor: MutationExecutor<TResult, TExecutorParams>, params?: CreateMutationParams<TResult, TError>) => Mutation<TResult, TError, TExecutorParams>;
 }
 export {};

package/MobxQuery/MobxQuery.js

@@ -27,20 +27,39 @@ export class MobxQuery {
         this.statusStorageFactory = new StatusStorageFactory();
         this.serialize = (data) => JSON.stringify(data);
         /**
-         * Метод для инвалидации по списку ключей,
-         * предполагается использование из домена
+         * Проверяет пересечение ключей в зависимости от стратегии
+         * @param invalidatedKeys - Ключи для инвалидации
+         * @param queryKeys - Ключи запроса
+         * @param strategy - Стратегия проверки:
+         * - 'chain-match' - все ключи из invalidatedKeys должны присутствовать в queryKeys
+         * - 'partial-match' - хотя бы один ключ из invalidatedKeys должен быть в queryKeys
          */
-        this.invalidate = (keysParts) => {
-            // Сет сериализованных ключей
-            const keysSet = new Set(keysParts.map(this.serialize));
-            [...this.keys.keys()].forEach((keyHash) => {
-                const key = this.keys.get(keyHash);
-                if (!key) {
+        this.checkTouchedElement = (invalidatedKeys, queryKeys, strategy) => {
+            const serializedInvalidatedKeys = invalidatedKeys.map(this.serialize);
+            if (strategy === 'chain-match') {
+                return serializedInvalidatedKeys.every((invalidatedKey) => queryKeys.some((queryKey) => invalidatedKey === this.serialize(queryKey)));
+            }
+            return queryKeys.some((queryKey) => serializedInvalidatedKeys.find((invalidatedKey) => invalidatedKey === this.serialize(queryKey)));
+        };
+        /**
+         * Метод для инвалидации по списку ключей, предполагается использование из домена
+         * @param invalidatedKeys - Массив ключей для инвалидации
+         * @param strategy - Стратегия инвалидации. 'chain-match' - инвалидировать при совпадении связки ключей в кэше, 'partial-match' - инвалидировать при частичном совпадении ключей. По умолчанию 'partial-match'
+         * @example
+         * // Инвалидация по частичному совпадению ключей
+         * mobxQuery.invalidate(['users', '1']); // Инвалидирует все query, содержащие ключ 'users' или '1'
+         *
+         * // Инвалидация по совпадению связки ключей
+         * mobxQuery.invalidate(['users', '1'], 'chain-match'); // Инвалидирует только query с точным набором ключей ['users', '1']
+         */
+        this.invalidate = (invalidatedKeys, strategy = 'partial-match') => {
+            for (const keyHash of this.keys.keys()) {
+                const queryKeys = this.keys.get(keyHash);
+                if (!queryKeys) {
                     return;
                 }
                 // Проверяем, есть ли пересечение между закешированными ключами и набором ключей для инвалидации
-                const hasTouchedElement = key.some((valuePart) => keysSet.has(this.serialize(valuePart)));
-                if (hasTouchedElement) {
+                if (this.checkTouchedElement(invalidatedKeys, queryKeys, strategy)) {
                     const query = this.queriesMap.get(keyHash);
                     if (query) {
                         query.invalidate();
@@ -49,7 +68,7 @@ export class MobxQuery {
                         this.queriesMap.convertToWeak(keyHash);
                     }
                 }
-            });
+            }
         };
         // Метод для подтверждения того, что квери успешно получил валидные данные
         this.submitValidity = (keyHash) => {

package/index.d.ts

@@ -1,4 +1,5 @@
 export { Mutation } from './Mutation';
 export { Query } from './Query';
-export { InfiniteQuery } from './InfiniteQuery';
-export { MobxQuery } from './MobxQuery';
+export { type InfiniteParams } from './InfiniteQuery';
+export { MobxQuery, type CreateQueryParams, type CreateInfiniteQueryParams, type CreateMutationParams, } from './MobxQuery';
+export { type CacheKey, type FetchPolicy } from './types';

package/index.js

@@ -1,4 +1,3 @@
 export { Mutation } from './Mutation';
 export { Query } from './Query';
-export { InfiniteQuery } from './InfiniteQuery';
-export { MobxQuery } from './MobxQuery';
+export { MobxQuery, } from './MobxQuery';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astral/mobx-query",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "browser": "./index.js",
   "main": "./index.js",
   "dependencies": {