@astral/mobx-query 1.2.2 → 1.3.1

package/DataStorage/DataStorage.d.ts

@@ -1,4 +1,4 @@
-import { CacheKey } from '../types';
+import type { CacheKey } from '../types';
 /**
  * @description хранилище данных, предназначено для обеспечения единого интерфейса при работе с данными
  */

package/InfiniteQuery/InfiniteQuery.d.ts

@@ -1,5 +1,5 @@
-import { FetchPolicy, QueryBaseActions, Sync, SyncParams } from '../types';
-import { DataStorage } from '../DataStorage';
+import type { FetchPolicy, QueryBaseActions, Sync, SyncParams } from '../types';
+import type { DataStorage } from '../DataStorage';
 export declare const DEFAULT_INFINITE_ITEMS_COUNT = 30;
 export type InfiniteParams = {
     offset: number;
@@ -82,6 +82,10 @@ export declare class InfiniteQuery<TResult, TError = void> implements QueryBaseA
      * @description обработчик успешного запроса, проверяет что мы достигли предела
      */
     private submitSuccess;
+    /**
+     * @description форс метод для установки данных
+     */
+    forceUpdate: (data: TResult[]) => void;
     /**
      * @description метод для обогащения параметров текущими значениями для инфинити
      */

package/InfiniteQuery/InfiniteQuery.js

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

package/MobxQuery/MobxQuery.d.ts

@@ -1,7 +1,10 @@
-import { Query, QueryExecutor, QueryParams } from '../Query';
-import { InfiniteExecutor, InfiniteQuery, InfiniteQueryParams } from '../InfiniteQuery';
-import { Mutation, MutationExecutor, MutationParams } from '../Mutation';
-import { CacheKey, FetchPolicy } from '../types';
+import type { QueryExecutor, QueryParams } from '../Query';
+import { Query } from '../Query';
+import type { InfiniteExecutor, InfiniteQueryParams } from '../InfiniteQuery';
+import { InfiniteQuery } from '../InfiniteQuery';
+import type { MutationExecutor, MutationParams } from '../Mutation';
+import { Mutation } from '../Mutation';
+import type { CacheKey, FetchPolicy } from '../types';
 /**
  * @description стандартный обработчик ошибки запроса,
  * будет вызван, если при вызове sync не был передан отдельный onError параметр

package/MobxQuery/MobxQuery.js

@@ -1,5 +1,5 @@
 import { Query } from '../Query';
-import { InfiniteQuery, } from '../InfiniteQuery';
+import { InfiniteQuery } from '../InfiniteQuery';
 import { Mutation } from '../Mutation';
 import { DataStorageFactory } from '../DataStorage';
 /**
@@ -95,8 +95,11 @@ export class MobxQuery {
          */
         this.createInfiniteQuery = (key, executor, params) => {
             const fetchPolicy = (params === null || params === void 0 ? void 0 : params.fetchPolicy) || this.defaultFetchPolicy || '';
-            return this.getCachedQuery(key, () => new InfiniteQuery(executor, Object.assign(Object.assign({}, params), { onError: ((params === null || params === void 0 ? void 0 : params.onError) ||
-                    this.defaultErrorHandler), enabledAutoFetch: (params === null || params === void 0 ? void 0 : params.enabledAutoFetch) || this.defaultEnabledAutoFetch, dataStorage: this.infiniteQueryDataStorageFactory.getStorage(key), fetchPolicy: fetchPolicy })), fetchPolicy);
+            return this.getCachedQuery(key, () => {
+                var _a;
+                return new InfiniteQuery(executor, Object.assign(Object.assign({}, params), { onError: ((params === null || params === void 0 ? void 0 : params.onError) ||
+                        this.defaultErrorHandler), enabledAutoFetch: (_a = params === null || params === void 0 ? void 0 : params.enabledAutoFetch) !== null && _a !== void 0 ? _a : this.defaultEnabledAutoFetch, dataStorage: this.infiniteQueryDataStorageFactory.getStorage(key), fetchPolicy: fetchPolicy }));
+            }, fetchPolicy);
         };
         /**
          * @description метод создания мутации, не кешируется

package/Mutation/Mutation.d.ts

@@ -1,4 +1,4 @@
-import { QueryBaseActions, Sync, SyncParams } from '../types';
+import type { QueryBaseActions, Sync, SyncParams } from '../types';
 /**
  * @description исполнитель запроса
  */

package/Query/Query.d.ts

@@ -1,5 +1,5 @@
-import { FetchPolicy, QueryBaseActions, Sync, SyncParams } from '../types';
-import { DataStorage } from '../DataStorage';
+import type { FetchPolicy, QueryBaseActions, Sync, SyncParams } from '../types';
+import type { DataStorage } from '../DataStorage';
 /**
  * @description исполнитель запроса
  */
@@ -68,6 +68,10 @@ export declare class Query<TResult, TError = void> implements QueryBaseActions<T
      * @description обработчик успешного ответа
      */
     private submitSuccess;
+    /**
+     * @description форс метод для установки данных
+     */
+    forceUpdate: (data: TResult) => void;
     /**
      * @description метод для переиспользования синхронной логики запроса
      */

package/Query/Query.js

@@ -38,6 +38,13 @@ export class Query {
             this.isInvalid = false;
             return resData;
         };
+        /**
+         * @description форс метод для установки данных
+         */
+        this.forceUpdate = (data) => {
+            this.auxiliary.submitSuccess();
+            this.submitSuccess(data);
+        };
         /**
          * @description метод для переиспользования синхронной логики запроса
          */

package/README.md

@@ -19,6 +19,7 @@
   - [Автоматический](#3-автоматический)
 - [Инвалидация данных](#инвалидация-данных)
   - [Особенности инвалидации](#особенности-инвалидации)
+- [Ручная установка данных в кэш](#ручная-установка-данных-в-кэш)
 - [InfiniteQuery](#infinitequery)
   - [isEndReached](#isendreached)
 - [Mutation](#mutation)
@@ -180,6 +181,14 @@ mobxQuery.invalidate(['key one']); // ключ не совпадает, query Н
 mobxQuery.invalidateQueries();
 ```
 
+# Ручная установка данных в кэш
+
+Для установки данных, без исполнения executor, используйте метод `forceUpdate`. При вызове все статусные флаги устанавливаются как success состояние
+
+```ts
+query.forceUpdate('foo');
+```
+
 # InfiniteQuery
 Существует необходимость постепенного запроса массивов данных, в постраничном режиме. Типичный пример, инфинити скролл, когда новая пачка данных запрашивается, в момент когда пользователь докрутил список до конца.
 Для удобства, мы создали специальный `query`, который содержит дополнительный метод `fetchMore` и при вызове оного, происходит запрос с увеличенными счетчиками. Данные ответа на этот запрос, будут сконкатенированы с уже имеющимся. В случае, если количество данных меньше, чем длина страницы, будет считаться что мы дошли до конца списка.

package/package.json

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