@astral/mobx-query 1.8.0 → 1.9.0

package/MobxQuery/MobxQuery.d.ts

@@ -2,6 +2,7 @@ import { Query, type QueryExecutor, type QueryParams } from '../Query';
 import { type InfiniteExecutor, InfiniteQuery, type InfiniteQueryParams } from '../InfiniteQuery';
 import { Mutation, type MutationExecutor, type MutationParams } from '../Mutation';
 import type { CacheKey, FetchPolicy } from '../types';
+import { InfiniteQuerySet, type InfiniteQuerySetConfig, type InfiniteQuerySetConfigurator, MutationSet, QuerySet, type QuerySetConfig, type QuerySetConfigurator } from '../Sets';
 /**
  * Стандартный обработчик ошибки запроса,
  * будет вызван, если при вызове sync не был передан отдельный onError параметр
@@ -128,5 +129,48 @@ export declare class MobxQuery<TDefaultError = void> {
      * Метод создания мутации, не кешируется
      */
     createMutation: <TResult, TError = TDefaultError, TExecutorParams = void>(executor: MutationExecutor<TResult, TExecutorParams>, params?: CreateMutationParams<TResult, TError>) => Mutation<TResult, TError, TExecutorParams>;
+    /**
+     * Создает набор queries под одним ключем
+     * @param configurator - Функция конфигурации набора запросов. Она должна возвращать объект с полями:
+     *   - keys (необязательно): массив ключей для кеширования;
+     *   - execute: функция, которая возвращает промис с результатом выполнения запроса.
+     * @example
+     * const docQuerySet = mobxQuery.createQuerySet((id: string, count?: number) => ({
+     *   execute: () => docEndpoint.getDoc(id),
+     * }));
+     *
+     * const docQuery = docQuerySet.create();
+     *
+     * docQuery.data // { data: [id, count] }
+     */
+    createQuerySet: <TParams extends any[], TResponse>(configurator: QuerySetConfigurator<TParams, TResponse>, config?: QuerySetConfig) => QuerySet<TParams, TResponse, TDefaultError>;
+    /**
+     * Создает набор infinite queries под одним ключем
+     * @param configurator - Функция конфигурации набора запросов. Она должна возвращать объект с полями:
+     *   - keys (необязательно): массив ключей для кеширования;
+     *   - execute: функция, которая возвращает промис с результатом выполнения запроса.
+     * @example
+     * const docListInfiniteQuerySet = mobxQuery.createInfiniteQuerySet((id: string, count?: number) => ({
+     *   execute: ({ offset, count }) => docEndpoint.getDocList(id, offset, count),
+     * }));
+     *
+     * const docListInfiniteQuery = docListInfiniteQuerySet.create();
+     *
+     * docListInfiniteQuery.data
+     */
+    createInfiniteQuerySet: <TParams extends any[], TResponse>(configurator: InfiniteQuerySetConfigurator<TParams, TResponse>, config?: InfiniteQuerySetConfig) => InfiniteQuerySet<TParams, TResponse, TDefaultError>;
+    /**
+     * Создает набор мутаций для единого интерфейса с query sets
+     * @param executor - Функция-исполнитель мутации. Она должна возвращать промис с результатом выполнения мутации.
+     * @example
+     * const editDocMutationSet = mobxQuery.createMutationSet((params: DocsEndpointsDTO.EditDocInput) => {
+     *   return docsEndpoint.editDoc(params);
+     * });
+     *
+     * const editDocMutation = editDocMutationSet.create();
+     *
+     * editDocMutation.sync({ params: { id: 'docId', content: 'Новое содержимое' } });
+     */
+    createMutationSet: <TResponse, TExecutorParams = void>(executor: MutationExecutor<TResponse, TExecutorParams>) => MutationSet<TResponse, TExecutorParams, TDefaultError>;
 }
 export {};

package/MobxQuery/MobxQuery.js

@@ -4,6 +4,7 @@ import { Mutation, } from '../Mutation';
 import { DataStorageFactory } from '../DataStorage';
 import { StatusStorageFactory } from '../StatusStorage';
 import { AdaptableMap } from '../AdaptableMap';
+import { InfiniteQuerySet, MutationSet, QuerySet, } from '../Sets';
 /**
  * Сервис, позволяющий кэшировать данные.
  */
@@ -166,6 +167,53 @@ export class MobxQuery {
          * Метод создания мутации, не кешируется
          */
         this.createMutation = (executor, params) => new Mutation(executor, Object.assign(Object.assign({}, params), { onError: (params === null || params === void 0 ? void 0 : params.onError) || this.defaultErrorHandler }));
+        /**
+         * Создает набор queries под одним ключем
+         * @param configurator - Функция конфигурации набора запросов. Она должна возвращать объект с полями:
+         *   - keys (необязательно): массив ключей для кеширования;
+         *   - execute: функция, которая возвращает промис с результатом выполнения запроса.
+         * @example
+         * const docQuerySet = mobxQuery.createQuerySet((id: string, count?: number) => ({
+         *   execute: () => docEndpoint.getDoc(id),
+         * }));
+         *
+         * const docQuery = docQuerySet.create();
+         *
+         * docQuery.data // { data: [id, count] }
+         */
+        // any нужен для вывода типов
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        this.createQuerySet = (configurator, config) => new QuerySet(this, configurator, config);
+        /**
+         * Создает набор infinite queries под одним ключем
+         * @param configurator - Функция конфигурации набора запросов. Она должна возвращать объект с полями:
+         *   - keys (необязательно): массив ключей для кеширования;
+         *   - execute: функция, которая возвращает промис с результатом выполнения запроса.
+         * @example
+         * const docListInfiniteQuerySet = mobxQuery.createInfiniteQuerySet((id: string, count?: number) => ({
+         *   execute: ({ offset, count }) => docEndpoint.getDocList(id, offset, count),
+         * }));
+         *
+         * const docListInfiniteQuery = docListInfiniteQuerySet.create();
+         *
+         * docListInfiniteQuery.data
+         */
+        // any нужен для вывода типов
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        this.createInfiniteQuerySet = (configurator, config) => new InfiniteQuerySet(this, configurator, config);
+        /**
+         * Создает набор мутаций для единого интерфейса с query sets
+         * @param executor - Функция-исполнитель мутации. Она должна возвращать промис с результатом выполнения мутации.
+         * @example
+         * const editDocMutationSet = mobxQuery.createMutationSet((params: DocsEndpointsDTO.EditDocInput) => {
+         *   return docsEndpoint.editDoc(params);
+         * });
+         *
+         * const editDocMutation = editDocMutationSet.create();
+         *
+         * editDocMutation.sync({ params: { id: 'docId', content: 'Новое содержимое' } });
+         */
+        this.createMutationSet = (executor) => new MutationSet(this, executor);
         this.defaultErrorHandler = onError;
         this.defaultFetchPolicy = fetchPolicy;
         this.defaultEnabledAutoFetch = enabledAutoFetch;