@astral/mobx-query 1.4.0 → 1.5.0

package/AuxiliaryQuery/AuxiliaryQuery.d.ts

@@ -1,56 +1,55 @@
+import { type StatusStorage } from '../StatusStorage';
 /**
- * @description испольнитель запроса
+ * испольнитель запроса
  */
 type Executor<TResult> = () => Promise<TResult>;
 /**
- * @description вспомогательное хранилище данных, для композиции в Query сторах,
+ * вспомогательное хранилище данных, для композиции в Query сторах,
  * содержащее флаги загрузки и ошибки,
  * колбэки на успешный запрос и на ошибку,
  * данные последней ошибки,
  * а так же, управляющее синглтон промисом.
  */
 export declare class AuxiliaryQuery<TResult, TError = void> {
-    /**
-     * @description флаг обозначающий загрузку данных
-     */
-    isLoading: boolean;
-    /**
-     * @description флаг обозначающий, что последний запрос был зафейлен
-     */
-    isError: boolean;
-    /**
-     * @description данные о последней ошибке
-     */
-    error?: TError;
-    /**
-     * @description флаг, обозначающий успешность завершения последнего запроса
-     */
-    isSuccess: boolean;
+    private readonly statusStorage;
+    private readonly backgroundStatusStorage;
     /**
      * флаг, обозначающий простаивание, т.е. запроса еще не было
      */
     isIdle: boolean;
     /**
-     * @description единый промис, для устранения гонки запросов
+     * единый промис, для устранения гонки запросов
+     */
+    private unifiedPromise?;
+    /**
+     * флаг, по которому реактивно определяется необходимость запуска инвалидации
      */
-    unifiedPromise?: Promise<TResult>;
-    constructor();
+    isInvalid: boolean;
+    constructor(statusStorage: StatusStorage<TError>, backgroundStatusStorage: StatusStorage<TError> | null);
     /**
-     * @description метод ответственный за создание единого промиса,
+     * метод ответственный за создание единого промиса,
      * для устранения гонки запросов
      */
     getUnifiedPromise: (executor: Executor<TResult>) => Promise<TResult>;
+    private setSuccess;
+    private checkBackgroundAndSet;
     /**
-     * @description обработчик успешного ответа
+     * обработчик успешного ответа
      */
     submitSuccess: () => void;
+    private setError;
     /**
-     * @description обработчик ошибки
+     * обработчик ошибки
      */
-    submitError: (e: TError) => void;
+    submitError: (error: TError) => void;
+    private setLoading;
     /**
-     * @description метод, вызываемый в самом начале запроса, чтобы сбросить флаги в соответствующее значение
+     * метод, вызываемый в самом начале запроса, чтобы сбросить флаги в соответствующее значение
      */
     startLoading: () => void;
+    /**
+     * метод для инвалидации данных
+     */
+    invalidate: () => void;
 }
 export {};

package/AuxiliaryQuery/AuxiliaryQuery.js

@@ -1,35 +1,25 @@
-import { makeAutoObservable, runInAction } from 'mobx';
+import { action, makeObservable, observable, runInAction } from 'mobx';
 /**
- * @description вспомогательное хранилище данных, для композиции в Query сторах,
+ * вспомогательное хранилище данных, для композиции в Query сторах,
  * содержащее флаги загрузки и ошибки,
  * колбэки на успешный запрос и на ошибку,
  * данные последней ошибки,
  * а так же, управляющее синглтон промисом.
  */
 export class AuxiliaryQuery {
-    constructor() {
-        /**
-         * @description флаг обозначающий загрузку данных
-         */
-        this.isLoading = false;
-        /**
-         * @description флаг обозначающий, что последний запрос был зафейлен
-         */
-        this.isError = false;
-        /**
-         * @description данные о последней ошибке
-         */
-        this.error = undefined;
-        /**
-         * @description флаг, обозначающий успешность завершения последнего запроса
-         */
-        this.isSuccess = false;
+    constructor(statusStorage, backgroundStatusStorage) {
+        this.statusStorage = statusStorage;
+        this.backgroundStatusStorage = backgroundStatusStorage;
         /**
          * флаг, обозначающий простаивание, т.е. запроса еще не было
          */
         this.isIdle = true;
         /**
-         * @description метод ответственный за создание единого промиса,
+         * флаг, по которому реактивно определяется необходимость запуска инвалидации
+         */
+        this.isInvalid = false;
+        /**
+         * метод ответственный за создание единого промиса,
          * для устранения гонки запросов
          */
         this.getUnifiedPromise = (executor) => {
@@ -50,36 +40,71 @@ export class AuxiliaryQuery {
                     .finally(() => {
                     this.unifiedPromise = undefined;
                     runInAction(() => {
-                        this.isLoading = false;
+                        this.statusStorage.isLoading = false;
                     });
                 });
             }
             return this.unifiedPromise;
         };
+        this.setSuccess = (storage) => {
+            storage.isError = false;
+            storage.isSuccess = true;
+        };
+        this.checkBackgroundAndSet = (setStorage) => {
+            if (this.backgroundStatusStorage && this.statusStorage.isSuccess) {
+                setStorage(this.backgroundStatusStorage);
+            }
+            else {
+                setStorage(this.statusStorage);
+            }
+        };
         /**
-         * @description обработчик успешного ответа
+         * обработчик успешного ответа
          */
         this.submitSuccess = () => {
-            this.isError = false;
-            this.isSuccess = true;
+            this.checkBackgroundAndSet(this.setSuccess);
+            this.isInvalid = false;
+        };
+        this.setError = (storage, error) => {
+            storage.isSuccess = false;
+            storage.isError = true;
+            storage.error = error;
         };
         /**
-         * @description обработчик ошибки
+         * обработчик ошибки
          */
-        this.submitError = (e) => {
-            this.isSuccess = false;
-            this.isError = true;
-            this.error = e;
+        this.submitError = (error) => {
+            this.checkBackgroundAndSet((storage) => this.setError(storage, error));
+        };
+        this.setLoading = (storage) => {
+            storage.isLoading = true;
+            storage.isError = false;
+            storage.isSuccess = false;
         };
         /**
-         * @description метод, вызываемый в самом начале запроса, чтобы сбросить флаги в соответствующее значение
+         * метод, вызываемый в самом начале запроса, чтобы сбросить флаги в соответствующее значение
          */
         this.startLoading = () => {
             this.isIdle = false;
-            this.isLoading = true;
-            this.isError = false;
-            this.isSuccess = false;
+            this.checkBackgroundAndSet(this.setLoading);
+        };
+        /**
+         * метод для инвалидации данных
+         */
+        this.invalidate = () => {
+            this.isInvalid = true;
         };
-        makeAutoObservable(this, { unifiedPromise: false });
+        makeObservable(this, {
+            getUnifiedPromise: action,
+            isIdle: observable,
+            isInvalid: observable,
+            submitSuccess: action,
+            setSuccess: action,
+            setError: action,
+            setLoading: action,
+            submitError: action,
+            startLoading: action,
+            invalidate: action,
+        });
     }
 }

package/DataStorage/DataStorage.d.ts

@@ -1,36 +1,34 @@
 import type { CacheKey } from '../types';
+import { StorageFactory } from '../StorageFactory';
 /**
- * @description хранилище данных, предназначено для обеспечения единого интерфейса при работе с данными
+ * хранилище данных, предназначено для обеспечения единого интерфейса при работе с данными
  */
 export declare class DataStorage<TData> {
     /**
-     * @description поле, отвечающее за непосредственное хранение данных
+     * поле, отвечающее за непосредственное хранение данных
      */
     private internalData?;
     constructor();
     /**
-     * @description флаг, отображающий наличие данных
+     * флаг, отображающий наличие данных
      */
     get hasData(): boolean;
     /**
-     * @description метод для установки данных
+     * метод для установки данных
      */
     setData: (value: TData) => void;
     /**
-     * @description геттер данных
+     * геттер данных
      */
     get data(): TData | undefined;
 }
 /**
- * @description фабрика ответственная за создание и хранение экземляров хранилищ
+ * фабрика ответственная за создание и хранение экземляров хранилищ
  */
-export declare class DataStorageFactory {
-    /**
-     * @description Map хранящий инстансы хранилищ по хэшу ключа
-     */
-    private storageMap;
+export declare class DataStorageFactory extends StorageFactory<DataStorage<unknown>> {
+    constructor();
     /**
-     * @description фабричный метод получения/создания инстанса хранилища по ключу
+     * фабричный метод получения/создания инстанса хранилища по ключу
      */
     getStorage: <TData>(key: CacheKey[]) => DataStorage<TData>;
 }

package/DataStorage/DataStorage.js

@@ -1,15 +1,16 @@
 import { makeAutoObservable } from 'mobx';
+import { StorageFactory } from '../StorageFactory';
 /**
- * @description хранилище данных, предназначено для обеспечения единого интерфейса при работе с данными
+ * хранилище данных, предназначено для обеспечения единого интерфейса при работе с данными
  */
 export class DataStorage {
     constructor() {
         /**
-         * @description поле, отвечающее за непосредственное хранение данных
+         * поле, отвечающее за непосредственное хранение данных
          */
         this.internalData = undefined;
         /**
-         * @description метод для установки данных
+         * метод для установки данных
          */
         this.setData = (value) => {
             this.internalData = value;
@@ -17,36 +18,29 @@ export class DataStorage {
         makeAutoObservable(this);
     }
     /**
-     * @description флаг, отображающий наличие данных
+     * флаг, отображающий наличие данных
      */
     get hasData() {
         return Boolean(this.internalData);
     }
     /**
-     * @description геттер данных
+     * геттер данных
      */
     get data() {
         return this.internalData;
     }
 }
 /**
- * @description фабрика ответственная за создание и хранение экземляров хранилищ
+ * фабрика ответственная за создание и хранение экземляров хранилищ
  */
-export class DataStorageFactory {
+export class DataStorageFactory extends StorageFactory {
     constructor() {
+        super(() => new DataStorage());
         /**
-         * @description Map хранящий инстансы хранилищ по хэшу ключа
-         */
-        this.storageMap = new Map();
-        /**
-         * @description фабричный метод получения/создания инстанса хранилища по ключу
+         * фабричный метод получения/создания инстанса хранилища по ключу
          */
         this.getStorage = (key) => {
-            const keyHash = JSON.stringify(key);
-            if (!this.storageMap.has(keyHash)) {
-                this.storageMap.set(keyHash, new DataStorage());
-            }
-            return this.storageMap.get(keyHash);
+            return this.getInternalStorage(key);
         };
     }
 }

package/InfiniteQuery/InfiniteQuery.d.ts

@@ -1,140 +1,122 @@
 import type { FetchPolicy, QueryBaseActions, Sync, SyncParams } from '../types';
+import { AuxiliaryQuery } from '../AuxiliaryQuery';
 import type { DataStorage } from '../DataStorage';
+import { QueryContainer } from '../QueryContainer';
+import { type StatusStorage } from '../StatusStorage';
 export declare const DEFAULT_INFINITE_ITEMS_COUNT = 30;
 export type InfiniteParams = {
     offset: number;
     count: number;
 };
 /**
- * @description исполнитель запроса, ожидается,
+ * исполнитель запроса, ожидается,
  * что будет использоваться что-то возвращающее массив данных
  */
 export type InfiniteExecutor<TResult> = (params: InfiniteParams) => Promise<Array<TResult>>;
-export type InfiniteQueryParams<TResult, TError> = {
+export type InfiniteQueryParams<TResult, TError, TIsBackground extends boolean = false> = {
     /**
-     * @description количество запрашиваемых элементов
+     * количество запрашиваемых элементов
      * @default 30
      */
     incrementCount?: number;
     /**
-     * @description обработчик ошибки, вызываемый по умолчанию
+     * обработчик ошибки, вызываемый по умолчанию
      */
     onError?: SyncParams<TResult, TError>['onError'];
     /**
-     * @description флаг, отвечающий за автоматический запрос данных при обращении к полю data
+     * флаг, отвечающий за автоматический запрос данных при обращении к полю data
      */
     enabledAutoFetch?: boolean;
+    /**
+     * инстанс хранилища основных статусов
+     */
+    statusStorage: StatusStorage<TError>;
     fetchPolicy?: FetchPolicy;
     /**
-     * @description инстанс хранилища данных
+     * инстанс хранилища данных
      */
     dataStorage: DataStorage<TResult[]>;
+    /**
+     * инстанс хранилища фоновых статусов
+     */
+    backgroundStatusStorage?: TIsBackground extends true ? StatusStorage<TError> : null | undefined;
 };
 /**
- * @description стор для работы с инфинити запросами,
+ * стор для работы с инфинити запросами,
  * которые должны быть закешированы,
  */
-export declare class InfiniteQuery<TResult, TError = void> implements QueryBaseActions<Array<TResult>, TError> {
+export declare class InfiniteQuery<TResult, TError = void, TIsBackground extends boolean = false> extends QueryContainer<TError, AuxiliaryQuery<Array<TResult>, TError>, TIsBackground> implements QueryBaseActions<Array<TResult>, TError> {
+    private readonly executor;
     /**
-     * @description инстанс вспомогательного стора
-     */
-    private auxiliary;
-    /**
-     * @description счетчик отступа для инфинити запроса
+     * счетчик отступа для инфинити запроса
      */
     private offset;
     /**
-     * @description количество запрашиваемых элементов
+     * количество запрашиваемых элементов
      */
     private readonly incrementCount;
     /**
-     * @description исполнитель запроса, ожидается,
-     * что будет использоваться что-то из слоя sources, возвращающее массив данных
-     */
-    private executor;
-    /**
-     * @description хранилище данных, для обеспечения возможности синхронизации данных между разными инстансами
+     * хранилище данных, для обеспечения возможности синхронизации данных между разными инстансами
      */
     private storage;
     /**
-     * @description флаг того, что мы достигли предела запрашиваемых элементов
+     * флаг того, что мы достигли предела запрашиваемых элементов
      */
     isEndReached: boolean;
     /**
-     * @description флаг необходимости выполнить обновления данных
-     */
-    private isInvalid;
-    /**
-     * @description обработчик ошибки, вызываемый по умолчанию
+     * обработчик ошибки, вызываемый по умолчанию
      */
     private defaultOnError?;
     /**
-     * @description флаг, отвечающий за автоматический запрос данных при обращении к полю data
+     * флаг, отвечающий за автоматический запрос данных при обращении к полю data
      */
     private enabledAutoFetch?;
     /**
-     * @description стандартное поведение политики кеширования
+     * стандартное поведение политики кеширования
      */
     private readonly defaultFetchPolicy?;
-    constructor(executor: InfiniteExecutor<TResult>, { incrementCount, onError, enabledAutoFetch, fetchPolicy, dataStorage, }: InfiniteQueryParams<TResult, TError>);
+    constructor(executor: InfiniteExecutor<TResult>, { incrementCount, onError, enabledAutoFetch, fetchPolicy, dataStorage, statusStorage, backgroundStatusStorage, }: InfiniteQueryParams<TResult, TError, TIsBackground>);
     private get isNetworkOnly();
     /**
-     * @description обработчик успешного запроса, проверяет что мы достигли предела
+     * обработчик успешного запроса, проверяет что мы достигли предела
      */
     private submitSuccess;
     /**
-     * @description форс метод для установки данных
+     * форс метод для установки данных
      */
     forceUpdate: (data: TResult[]) => void;
     /**
-     * @description метод для обогащения параметров текущими значениями для инфинити
+     * метод для обогащения параметров текущими значениями для инфинити
      */
     private get infiniteExecutor();
     /**
-     * @description метод для инвалидации данных
+     * метод для инвалидации данных
      */
     invalidate: () => void;
     /**
-     * @description метод для запроса следующего набора данных
+     * метод для запроса следующего набора данных
      */
     fetchMore: () => void;
     /**
-     * @description синхронный метод получения данных
+     * синхронный метод получения данных
      */
     sync: Sync<Array<TResult>, TError>;
     /**
-     * @description метод для переиспользования синхронной логики запроса
+     * метод для переиспользования синхронной логики запроса
      */
     private proceedSync;
     /**
-     * @description aсинхронный метод получения данных,
+     * aсинхронный метод получения данных,
      * подходит для изменения параметров запроса(фильтров),
      * при котором будет сброшен offset,
      * предполагается, что нужно будет самостоятельно обрабатывать ошибку
      */
     async: () => Promise<TResult[]>;
     /**
-     * @description вычисляемое свойство, содержащее реактивные данные,
+     * вычисляемое свойство, содержащее реактивные данные,
      * благодаря mobx, при изменении isInvalid, свойство будет вычисляться заново,
      * следовательно, стриггерится условие невалидности,
      * и начнется запрос, в результате которого, данные обновятся
      */
     get data(): TResult[] | undefined;
-    /**
-     * @description флаг загрузки данных
-     */
-    get isLoading(): boolean;
-    /**
-     * @description флаг обозначающий, что последний запрос был зафейлен
-     */
-    get isError(): boolean;
-    /**
-     * @description данные о последней ошибке
-     */
-    get error(): TError | undefined;
-    /**
-     * @description флаг обозначающий, что последний запрос был успешно завершен
-     */
-    get isSuccess(): boolean;
-    get isIdle(): boolean;
 }