@astral/mobx-query 1.8.0 → 1.9.0

package/node/Sets/QuerySet/QuerySet.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuerySet = void 0;
+const utils_1 = require("../utils");
+/**
+ * Набор queries под одним ключем с целью повышения читаемости кода и удобства инвалидации по общему ключу
+ */
+class QuerySet {
+    constructor(_cache, _queryConfigurator, config) {
+        var _a;
+        this._cache = _cache;
+        this._queryConfigurator = _queryConfigurator;
+        /**
+         * Создает query в кэше. Добавляет его в набор
+         * @returns Query объект
+         * @example
+         * const docQuery = docFetcher.queries.doc.create('docId')
+         * // Получает данные
+         * docQuery.sync()
+         */
+        this.create = (...params) => {
+            const { keys, execute } = this.configureQuery(...params);
+            return this._cache.createQuery(keys, execute);
+        };
+        /**
+         * Создает query в кэше с дополнительными параметрами конфигурации. Добавляет его в набор
+         * @param config - Параметры конфигурации query. Например, fetchPolicy
+         * @param params - Параметры запроса
+         * @returns Query объект
+         * @example
+         * const docQuery = docFetcher.queries.doc.createWithConfig(
+         *   { fetchPolicy: 'network-only' },
+         *   'docId',
+         * )
+         * // Получает данные из query
+         * docQuery.sync()
+         */
+        this.createWithConfig = (config, ...params) => {
+            const { keys, execute } = this.configureQuery(...params);
+            return this._cache.createQuery(keys, execute, config);
+        };
+        /**
+         * Инвалидирует текущий query в кэше
+         * @param keys - Дополнительные ключи для инвалидации. Если не указаны, то инвалидируется весь набор query
+         * @example
+         * const docFetcher = {
+         *   doc: mobxQuery.createQuerySet((id: string) => ({
+         *     execute: () => httpService.get(`/doc/${id}?page=${page}`),
+         *   })),
+         * };
+         *
+         * // Инвалидирует все query doc
+         * docFetcher.doc.invalidate()
+         *
+         * // Инвалидирует query doc с конкретным переданным id. Доступные ключи инвалидации зависят от указанных additionalKeys, переданных при определении query в фабрике createDataFetcher
+         * docFetcher.doc.invalidate('docId')
+         */
+        this.invalidate = (...params) => {
+            if (params.length === 0) {
+                this._cache.invalidate([this.baseKey]);
+                return;
+            }
+            const { keys } = this.configureQuery(...params);
+            this._cache.invalidate(keys, 'chain-match');
+        };
+        this.configureQuery = (...params) => {
+            const { keys, execute } = this._queryConfigurator(...params);
+            return {
+                keys: (0, utils_1.generateQuerySetKeys)(this.baseKey, keys !== null && keys !== void 0 ? keys : params),
+                execute,
+            };
+        };
+        this.baseKey = (_a = config === null || config === void 0 ? void 0 : config.name) !== null && _a !== void 0 ? _a : (0, utils_1.generateQuerySetBaseKey)(_queryConfigurator);
+    }
+}
+exports.QuerySet = QuerySet;

package/node/Sets/QuerySet/index.d.ts

@@ -0,0 +1 @@
+export * from './QuerySet';

package/node/Sets/QuerySet/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./QuerySet"), exports);

package/node/Sets/index.d.ts

@@ -0,0 +1,3 @@
+export * from './MutationSet';
+export * from './QuerySet';
+export * from './InfiniteQuerySet';

package/node/Sets/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./MutationSet"), exports);
+__exportStar(require("./QuerySet"), exports);
+__exportStar(require("./InfiniteQuerySet"), exports);

package/node/Sets/utils/generateQuerySetBaseKey/generateQuerySetBaseKey.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Создает базовый ключ на основе хэша от configurator
+ */
+export declare const generateQuerySetBaseKey: (configurator: Function) => string;

package/node/Sets/utils/generateQuerySetBaseKey/generateQuerySetBaseKey.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateQuerySetBaseKey = void 0;
+const hash_1 = __importDefault(require("@emotion/hash"));
+/**
+ * Создает базовый ключ на основе хэша от configurator
+ */
+const generateQuerySetBaseKey = (configurator) => (0, hash_1.default)(configurator.toString());
+exports.generateQuerySetBaseKey = generateQuerySetBaseKey;

package/node/Sets/utils/generateQuerySetBaseKey/index.d.ts

@@ -0,0 +1 @@
+export * from './generateQuerySetBaseKey';

package/node/Sets/utils/generateQuerySetBaseKey/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./generateQuerySetBaseKey"), exports);

package/node/Sets/utils/generateQuerySetKeys/generateQuerySetKeys.d.ts

@@ -0,0 +1,9 @@
+import { type CacheKey } from '../../../types';
+/**
+ * Создает ключи на основе каждого параметра
+ * @param additionalKeys - Создает для каждого параметра отдельный ключ, чтобы по нему можно было инвалидировать query
+ * @example
+ * // Создаст ключи ['22f4', ['22f4', 'organizationID', '1'], ['22f4', 'employeeID', '2']]
+ * generateQuerySetKeys('22f4', params)
+ */
+export declare const generateQuerySetKeys: (baseKey: string, params: CacheKey[]) => CacheKey[];

package/node/Sets/utils/generateQuerySetKeys/generateQuerySetKeys.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateQuerySetKeys = void 0;
+const is_plain_obj_1 = __importDefault(require("is-plain-obj"));
+/**
+ * Создает ключи на основе каждого параметра
+ * @param additionalKeys - Создает для каждого параметра отдельный ключ, чтобы по нему можно было инвалидировать query
+ * @example
+ * // Создаст ключи ['22f4', ['22f4', 'organizationID', '1'], ['22f4', 'employeeID', '2']]
+ * generateQuerySetKeys('22f4', params)
+ */
+const generateQuerySetKeys = (baseKey, params) => {
+    const resultKeys = [];
+    params.forEach((param) => {
+        if ((0, is_plain_obj_1.default)(param)) {
+            resultKeys.push(...Object.entries(param).map(([key, value]) => [baseKey, key, value]));
+        }
+        else {
+            resultKeys.push(param);
+        }
+    });
+    return [baseKey, ...resultKeys];
+};
+exports.generateQuerySetKeys = generateQuerySetKeys;

package/node/Sets/utils/generateQuerySetKeys/index.d.ts

@@ -0,0 +1 @@
+export * from './generateQuerySetKeys';

package/node/Sets/utils/generateQuerySetKeys/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./generateQuerySetKeys"), exports);

package/node/Sets/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './generateQuerySetKeys';
+export * from './generateQuerySetBaseKey';

package/node/Sets/utils/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./generateQuerySetKeys"), exports);
+__exportStar(require("./generateQuerySetBaseKey"), exports);

package/node/StatusStorage/StatusStorage.d.ts

@@ -0,0 +1,24 @@
+import { StorageFactory } from '../StorageFactory';
+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>(keyHash: string) => StatusStorage<TError>;
+}

package/node/StatusStorage/StatusStorage.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatusStorageFactory = exports.StatusStorage = void 0;
+const mobx_1 = require("mobx");
+const StorageFactory_1 = require("../StorageFactory");
+class StatusStorage {
+    constructor() {
+        /**
+         * Флаг обозначающий загрузку данных
+         */
+        this.isLoading = false;
+        /**
+         * Флаг обозначающий, что последний запрос был зафейлен
+         */
+        this.isError = false;
+        /**
+         * Данные о последней ошибке
+         */
+        this.error = undefined;
+        /**
+         * Флаг, обозначающий успешность завершения последнего запроса
+         */
+        this.isSuccess = false;
+        (0, mobx_1.makeObservable)(this, {
+            error: mobx_1.observable,
+            isError: mobx_1.observable,
+            isLoading: mobx_1.observable,
+            isSuccess: mobx_1.observable,
+        });
+    }
+}
+exports.StatusStorage = StatusStorage;
+class StatusStorageFactory extends StorageFactory_1.StorageFactory {
+    constructor() {
+        super(() => new StatusStorage());
+        this.getStorage = (keyHash) => {
+            return this.getInternalStorage(keyHash);
+        };
+    }
+}
+exports.StatusStorageFactory = StatusStorageFactory;

package/node/StatusStorage/index.d.ts

@@ -0,0 +1 @@
+export * from './StatusStorage';

package/node/StatusStorage/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./StatusStorage"), exports);

package/node/StorageFactory/StorageFactory.d.ts

@@ -0,0 +1,9 @@
+export declare abstract class StorageFactory<TStorage extends {}> {
+    private readonly createStorage;
+    private readonly adaptableMap;
+    protected constructor(createStorage: () => TStorage);
+    /**
+     * Фабричный метод получения/создания инстанса хранилища по ключу
+     */
+    getInternalStorage: (keyHash: string) => TStorage;
+}

package/node/StorageFactory/StorageFactory.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorageFactory = void 0;
+const AdaptableMap_1 = require("../AdaptableMap");
+class StorageFactory {
+    constructor(createStorage) {
+        this.createStorage = createStorage;
+        this.adaptableMap = new AdaptableMap_1.AdaptableMap();
+        /**
+         * Фабричный метод получения/создания инстанса хранилища по ключу
+         */
+        this.getInternalStorage = (keyHash) => {
+            const storage = this.adaptableMap.get(keyHash);
+            if (!storage) {
+                const createdStorage = this.createStorage();
+                this.adaptableMap.set(keyHash, createdStorage);
+                return createdStorage;
+            }
+            return storage;
+        };
+    }
+}
+exports.StorageFactory = StorageFactory;

package/node/StorageFactory/index.d.ts

@@ -0,0 +1 @@
+export * from './StorageFactory';

package/node/StorageFactory/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./StorageFactory"), exports);

package/node/index.d.ts

@@ -0,0 +1,6 @@
+export { Mutation } from './Mutation';
+export { Query } from './Query';
+export { type InfiniteParams, InfiniteQuery } from './InfiniteQuery';
+export { MobxQuery, type CreateQueryParams, type CreateInfiniteQueryParams, type CreateMutationParams, } from './MobxQuery';
+export { type QuerySet, type InfiniteQuerySet, type MutationSet } from './Sets';
+export { type CacheKey, type FetchPolicy } from './types';

package/node/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MobxQuery = exports.InfiniteQuery = exports.Query = exports.Mutation = void 0;
+var Mutation_1 = require("./Mutation");
+Object.defineProperty(exports, "Mutation", { enumerable: true, get: function () { return Mutation_1.Mutation; } });
+var Query_1 = require("./Query");
+Object.defineProperty(exports, "Query", { enumerable: true, get: function () { return Query_1.Query; } });
+var InfiniteQuery_1 = require("./InfiniteQuery");
+Object.defineProperty(exports, "InfiniteQuery", { enumerable: true, get: function () { return InfiniteQuery_1.InfiniteQuery; } });
+var MobxQuery_1 = require("./MobxQuery");
+Object.defineProperty(exports, "MobxQuery", { enumerable: true, get: function () { return MobxQuery_1.MobxQuery; } });

package/node/types.d.ts

@@ -0,0 +1,55 @@
+export type SyncParams<TResult, TError, TExecutorParams = void> = {
+    onSuccess?: (res: TResult) => void;
+    onError?: (e: TError) => void;
+    params?: TExecutorParams;
+};
+/**
+ * синхронный метод получения данных
+ */
+export type Sync<TResult, TError, TExecutorParams = void> = (params?: SyncParams<TResult, TError, TExecutorParams>) => void;
+/**
+ * асинхронный метод получения данных
+ */
+export type Async<TResult, TExecutorParams = void> = (params: TExecutorParams) => Promise<TResult>;
+export type QueryBaseActions<TResult, TError, TExecutorParams = void> = {
+    /**
+     * синхронный метод получения данных
+     */
+    sync: Sync<TResult, TError, TExecutorParams>;
+    /**
+     * асинхронный метод получения данных
+     */
+    async: Async<TResult, TExecutorParams>;
+    /**
+     * флаг обозначающий загрузку данных
+     */
+    isLoading: boolean;
+    /**
+     * флаг обозначающий, что последний запрос был зафейлен
+     */
+    isError: boolean;
+    /**
+     * данные о последней ошибке
+     */
+    error?: TError;
+    /**
+     * флаг обзначающий, что последний запрос был успешно выполнен
+     */
+    isSuccess: boolean;
+    /**
+     * флаг, обозначающий простаивание, т.е. запроса еще не было
+     */
+    isIdle: boolean;
+};
+/**
+ * политика получения данных.
+ * @enum cache-first - данные сначала берутся из кеша, если их нет, тогда идет обращение к сети, ответ записывается в кэш
+ * @enum network-only - данные всегда берутся из сети, при этом ответ записывается в кэш
+ */
+export type FetchPolicy = 'network-only' | 'cache-first';
+/**
+ * ключ для кешированя
+ */
+export type CacheKey = string | number | boolean | null | undefined | CacheKey[] | {
+    [key: string]: CacheKey;
+};

package/node/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "@astral/mobx-query",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "browser": "./index.js",
-  "main": "./index.js",
+  "main": "./node/index.js",
   "dependencies": {
-    "mobx": "^6.9.0"
+    "mobx": "^6.9.0",
+    "is-plain-obj": "4.1.0",
+    "utility-types": "3.11.0",
+    "@emotion/hash": "0.9.2"
   },
   "author": "Astral.Soft",
   "license": "MIT",
@@ -20,6 +23,10 @@
   "types": "./index.d.ts",
   "module": "./index.js",
   "exports": {
-    ".": "./index.js"
+    ".": {
+      "vitest": "./node/index.js",
+      "module": "./index.js",
+      "require": "./node/index.js"
+    }
   }
 }