@astral/mobx-query 1.3.0 → 1.3.2

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;

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 исполнитель запроса
  */

package/README.md

@@ -31,6 +31,8 @@
   - [isSuccess](#issuccess)
   - [isError](#iserror)
   - [error](#error)
+- [Тестирование](#тестирование)
+  - [Тестирование при включенном enabledAutoFetch](#тестирование-при-включенном-enabledautofetch)
 
 # Installation
 
@@ -337,3 +339,94 @@ await query
 console.log(query.isError); // 'true'
 console.log(query.error); // 'foo'
 ```
+
+# Тестирование
+
+## Тестирование при включенном ```enabledAutoFetch```
+
+### Исходный код
+
+```MobxQuery``` инициализируется с параметром: ```enabledAutoFetch```:
+```ts
+const createMobxQuery = () => new MobxQuery<ApiDataError>({
+  enabledAutoFetch: true,
+});
+```
+
+```BookRepository``` - фасад для работы с данными, который использует MobxQuery:
+```ts
+export class BookRepository {
+  constructor(private readonly mobxQuery: MobxQuery) {}
+
+  public getBookListQuery = (params: BookRepositoryDTO.BookListInputDTO) =>
+    this.mobxQuery.createQuery<BookRepositoryDTO.BookListDTO>(
+      ['book-list', params],
+      () =>
+          apiHttpClient.get('/books', {
+              params,
+          }),
+    );
+}
+```
+
+```BooksListStore``` - использует BookRepository для получения данных:
+```ts
+class BooksListStore {
+  public sort?: SortData;
+
+  constructor(private readonly bookRepository: BookRepository) {
+    makeAutoObservable(this);
+  }
+
+  private get listQuery() {
+    return this.bookRepository.getBookListQuery(this.sort);
+  }
+
+  public get list(): ListItem[] {
+    const data = this.listQuery.data?.data || [];
+
+    return data.map(({ id, name, price }) => ({
+      id,
+      name,
+      price: formatPriceToView(price),
+    }));
+  }
+}
+```
+
+### Тест
+
+```ts
+import { when } from 'mobx';
+
+describe('BooksListStore', () => {
+  it('Список книг форматируется для отображения', async () => {
+    // Для каждого теста необходимо инициализировать свой instance MobxQuery,
+    // иначе будет проблема состояния гонки при выполнении нескольких тестов
+    const mobxQuery = createMobxQuery();
+
+    const fakeBookList = makeFakeBookList(2, { price: 1000 });
+    const fakeBookListItem = fakeBookList.data[0];
+
+    const bookRepositoryMock = mock<BookRepository>({
+      // Подменяем реализацию метода для того, чтобы получить ожидаемый результат
+      getBookListQuery: () =>
+          // Создаем моковый Query, соответствующий интерфейсу BookRepository
+          mobxQuery.createQuery(['id'], async () => fakeBookList),
+    });
+
+    const sut = new GoodsListStore(bookRepositoryMock);
+
+    // Ждем автоматической загрузки данных
+    // Загрузка данных начнется автоматически при обращении к sut.list за счет параметра enabledAutoFetch
+    await when(() => Boolean(sut.list?.length));
+
+    expect(sut.list[0]).toMatchObject({
+      id: fakeBookListItem.id,
+      name: fakeBookListItem.name,
+      price: '1 000 руб.',
+    });
+  });
+});
+```
+

package/package.json

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