@astral/mobx-query 1.5.0 → 1.6.0

package/QueryContainer/QueryContainer.d.ts

@@ -13,27 +13,27 @@ export declare abstract class QueryContainer<TError, TAuxiliary extends QueryCon
     protected readonly auxiliary: TAuxiliary;
     protected constructor(statusStorage: StatusStorage<TError>, backgroundStatusStorage: StatusStorage<TError> | null, auxiliary: TAuxiliary);
     /**
-     * флаг загрузки данных
+     * Флаг загрузки данных
      */
     get isLoading(): boolean;
     /**
-     * флаг обозначающий, что последний запрос был зафейлен
+     * Флаг обозначающий, что последний запрос был зафейлен
      */
     get isError(): boolean;
     /**
-     * данные о последней ошибке
+     * Данные о последней ошибке
      */
     get error(): TError | undefined;
     /**
-     * флаг обозначающий, что последний запрос был успешно завершен
+     * Флаг обозначающий, что последний запрос был успешно завершен
      */
     get isSuccess(): boolean;
     /**
-     * флаг, обозначающий простаивание, т.е. запроса еще не было
+     * Флаг, обозначающий простаивание, т.е. запроса еще не было
      */
     get isIdle(): boolean;
     /**
-     * статусы, изменяющиеся после первого успешного запроса в режиме isBackground: true
+     * Статусы, изменяющиеся после первого успешного запроса в режиме isBackground: true
      * @example
      * const query = mobxQuery.createQuery(
      *     ['some cache key'],
@@ -50,8 +50,8 @@ export declare abstract class QueryContainer<TError, TAuxiliary extends QueryCon
      * console.log(query.isLoading); // не изменялся
      * console.log(query.isSuccess); // остался неизменным - true
      *
-     * console.log(query.backgroundStatus.isLoading); // переключался в true на момент обновления
-     * console.log(query.backgroundStatus.isSuccess); // true
+     * console.log(query.background.isLoading); // переключался в true на момент обновления
+     * console.log(query.background.isSuccess); // true
      *
      * @exception isBackground:false (а так же по умолчанию) background не доступен, и равен null
      * @exception Mutation не доступен в мутации и равен null

package/QueryContainer/QueryContainer.js

@@ -17,37 +17,37 @@ export class QueryContainer {
         });
     }
     /**
-     * флаг загрузки данных
+     * Флаг загрузки данных
      */
     get isLoading() {
         return this.statusStorage.isLoading;
     }
     /**
-     * флаг обозначающий, что последний запрос был зафейлен
+     * Флаг обозначающий, что последний запрос был зафейлен
      */
     get isError() {
         return this.statusStorage.isError;
     }
     /**
-     * данные о последней ошибке
+     * Данные о последней ошибке
      */
     get error() {
         return this.statusStorage.error;
     }
     /**
-     * флаг обозначающий, что последний запрос был успешно завершен
+     * Флаг обозначающий, что последний запрос был успешно завершен
      */
     get isSuccess() {
         return this.statusStorage.isSuccess;
     }
     /**
-     * флаг, обозначающий простаивание, т.е. запроса еще не было
+     * Флаг, обозначающий простаивание, т.е. запроса еще не было
      */
     get isIdle() {
         return this.auxiliary.isIdle;
     }
     /**
-     * статусы, изменяющиеся после первого успешного запроса в режиме isBackground: true
+     * Статусы, изменяющиеся после первого успешного запроса в режиме isBackground: true
      * @example
      * const query = mobxQuery.createQuery(
      *     ['some cache key'],
@@ -64,8 +64,8 @@ export class QueryContainer {
      * console.log(query.isLoading); // не изменялся
      * console.log(query.isSuccess); // остался неизменным - true
      *
-     * console.log(query.backgroundStatus.isLoading); // переключался в true на момент обновления
-     * console.log(query.backgroundStatus.isSuccess); // true
+     * console.log(query.background.isLoading); // переключался в true на момент обновления
+     * console.log(query.background.isSuccess); // true
      *
      * @exception isBackground:false (а так же по умолчанию) background не доступен, и равен null
      * @exception Mutation не доступен в мутации и равен null

package/README.md

@@ -345,7 +345,7 @@ console.log(query.error); // 'foo'
 ## Режим фонового обновления
 `Query` и `InfiniteQuery` имеют режим фонового обновления. Предполагается, что будет хорошо подходить для обновления данных через websocket.
 
-В этом режиме, основные статусные флаги `isSuccess`, `isLoading`, `isError`, `error` будут изменяться до первого успешного запроса. Последующие запросы уже будут изменять статусные флаги под полем `backgroundStatus`
+В этом режиме, основные статусные флаги `isSuccess`, `isLoading`, `isError`, `error` будут изменяться до первого успешного запроса. Последующие запросы уже будут изменять статусные флаги под полем `background`
 
 ```ts
 const query = mobxQuery.createQuery(
@@ -363,8 +363,8 @@ await query.async();
 console.log(query.isLoading); // не изменялся
 console.log(query.isSuccess); // остался неизменным - true
 
-console.log(query.backgroundStatus.isLoading); // переключался в true на момент обновления
-console.log(query.backgroundStatus.isSuccess); // true
+console.log(query.background.isLoading); // переключался в true на момент обновления
+console.log(query.background.isSuccess); // true
 ```
 
 # Тестирование

package/StatusStorage/StatusStorage.d.ts

@@ -1,25 +1,24 @@
 import { StorageFactory } from '../StorageFactory';
-import { type CacheKey } from '../types';
 export declare class StatusStorage<TError> {
     constructor();
     /**
-     * флаг обозначающий загрузку данных
+     * Флаг обозначающий загрузку данных
      */
     isLoading: boolean;
     /**
-     * флаг обозначающий, что последний запрос был зафейлен
+     * Флаг обозначающий, что последний запрос был зафейлен
      */
     isError: boolean;
     /**
-     * данные о последней ошибке
+     * Данные о последней ошибке
      */
     error?: TError;
     /**
-     * флаг, обозначающий успешность завершения последнего запроса
+     * Флаг, обозначающий успешность завершения последнего запроса
      */
     isSuccess: boolean;
 }
 export declare class StatusStorageFactory extends StorageFactory<StatusStorage<void>> {
     constructor();
-    getStorage: <TError>(key: CacheKey[]) => StatusStorage<TError>;
+    getStorage: <TError>(keyHash: string) => StatusStorage<TError>;
 }

package/StatusStorage/StatusStorage.js

@@ -3,19 +3,19 @@ import { StorageFactory } from '../StorageFactory';
 export class StatusStorage {
     constructor() {
         /**
-         * флаг обозначающий загрузку данных
+         * Флаг обозначающий загрузку данных
          */
         this.isLoading = false;
         /**
-         * флаг обозначающий, что последний запрос был зафейлен
+         * Флаг обозначающий, что последний запрос был зафейлен
          */
         this.isError = false;
         /**
-         * данные о последней ошибке
+         * Данные о последней ошибке
          */
         this.error = undefined;
         /**
-         * флаг, обозначающий успешность завершения последнего запроса
+         * Флаг, обозначающий успешность завершения последнего запроса
          */
         this.isSuccess = false;
         makeObservable(this, {
@@ -29,8 +29,8 @@ export class StatusStorage {
 export class StatusStorageFactory extends StorageFactory {
     constructor() {
         super(() => new StatusStorage());
-        this.getStorage = (key) => {
-            return this.getInternalStorage(key);
+        this.getStorage = (keyHash) => {
+            return this.getInternalStorage(keyHash);
         };
     }
 }

package/StorageFactory/StorageFactory.d.ts

@@ -1,13 +1,9 @@
-import { type CacheKey } from '../types';
-export declare abstract class StorageFactory<TStorage> {
+export declare abstract class StorageFactory<TStorage extends {}> {
     private readonly createStorage;
+    private readonly adaptableMap;
     protected constructor(createStorage: () => TStorage);
     /**
-     * Map хранящий инстансы хранилищ по хэшу ключа
+     * Фабричный метод получения/создания инстанса хранилища по ключу
      */
-    private storageMap;
-    /**
-     * фабричный метод получения/создания инстанса хранилища по ключу
-     */
-    protected getInternalStorage: (key: CacheKey[]) => TStorage | undefined;
+    getInternalStorage: (keyHash: string) => TStorage;
 }

package/StorageFactory/StorageFactory.js

@@ -1,19 +1,19 @@
+import { AdaptableMap } from '../AdaptableMap';
 export class StorageFactory {
     constructor(createStorage) {
         this.createStorage = createStorage;
+        this.adaptableMap = new AdaptableMap();
         /**
-         * Map хранящий инстансы хранилищ по хэшу ключа
+         * Фабричный метод получения/создания инстанса хранилища по ключу
          */
-        this.storageMap = new Map();
-        /**
-         * фабричный метод получения/создания инстанса хранилища по ключу
-         */
-        this.getInternalStorage = (key) => {
-            const keyHash = JSON.stringify(key);
-            if (!this.storageMap.has(keyHash)) {
-                this.storageMap.set(keyHash, this.createStorage());
+        this.getInternalStorage = (keyHash) => {
+            const storage = this.adaptableMap.get(keyHash);
+            if (!storage) {
+                const createdStorage = this.createStorage();
+                this.adaptableMap.set(keyHash, createdStorage);
+                return createdStorage;
             }
-            return this.storageMap.get(keyHash);
+            return storage;
         };
     }
 }

package/package.json

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

package/types.d.ts

@@ -44,7 +44,7 @@ export type QueryBaseActions<TResult, TError, TExecutorParams = void> = {
 /**
  * политика получения данных.
  * @enum cache-first - данные сначала берутся из кеша, если их нет, тогда идет обращение к сети, ответ записывается в кэш
- * @enum network-only - данные всегда беруться из сети, при этом ответ записывается в кэш
+ * @enum network-only - данные всегда берутся из сети, при этом ответ записывается в кэш
  */
 export type FetchPolicy = 'network-only' | 'cache-first';
 /**