@astral/mobx-query 1.8.0 → 1.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (98) hide show
  1. package/MobxQuery/MobxQuery.d.ts +44 -0
  2. package/MobxQuery/MobxQuery.js +48 -0
  3. package/README.md +1048 -287
  4. package/Sets/InfiniteQuerySet/InfiniteQuerySet.d.ts +60 -0
  5. package/Sets/InfiniteQuerySet/InfiniteQuerySet.js +71 -0
  6. package/Sets/InfiniteQuerySet/index.d.ts +1 -0
  7. package/Sets/InfiniteQuerySet/index.js +1 -0
  8. package/Sets/MutationSet/MutationSet.d.ts +32 -0
  9. package/Sets/MutationSet/MutationSet.js +31 -0
  10. package/Sets/MutationSet/index.d.ts +1 -0
  11. package/Sets/MutationSet/index.js +1 -0
  12. package/Sets/QuerySet/QuerySet.d.ts +64 -0
  13. package/Sets/QuerySet/QuerySet.js +72 -0
  14. package/Sets/QuerySet/index.d.ts +1 -0
  15. package/Sets/QuerySet/index.js +1 -0
  16. package/Sets/index.d.ts +3 -0
  17. package/Sets/index.js +3 -0
  18. package/Sets/utils/generateQuerySetBaseKey/generateQuerySetBaseKey.d.ts +4 -0
  19. package/Sets/utils/generateQuerySetBaseKey/generateQuerySetBaseKey.js +5 -0
  20. package/Sets/utils/generateQuerySetBaseKey/index.d.ts +1 -0
  21. package/Sets/utils/generateQuerySetBaseKey/index.js +1 -0
  22. package/Sets/utils/generateQuerySetKeys/generateQuerySetKeys.d.ts +9 -0
  23. package/Sets/utils/generateQuerySetKeys/generateQuerySetKeys.js +20 -0
  24. package/Sets/utils/generateQuerySetKeys/index.d.ts +1 -0
  25. package/Sets/utils/generateQuerySetKeys/index.js +1 -0
  26. package/Sets/utils/index.d.ts +2 -0
  27. package/Sets/utils/index.js +2 -0
  28. package/index.d.ts +2 -1
  29. package/index.js +1 -0
  30. package/node/AdaptableMap/AdaptableMap.d.ts +29 -0
  31. package/node/AdaptableMap/AdaptableMap.js +81 -0
  32. package/node/AdaptableMap/index.d.ts +1 -0
  33. package/node/AdaptableMap/index.js +17 -0
  34. package/node/AuxiliaryQuery/AuxiliaryQuery.d.ts +55 -0
  35. package/node/AuxiliaryQuery/AuxiliaryQuery.js +115 -0
  36. package/node/AuxiliaryQuery/index.d.ts +1 -0
  37. package/node/AuxiliaryQuery/index.js +17 -0
  38. package/node/DataStorage/DataStorage.d.ts +33 -0
  39. package/node/DataStorage/DataStorage.js +51 -0
  40. package/node/DataStorage/index.d.ts +1 -0
  41. package/node/DataStorage/index.js +17 -0
  42. package/node/InfiniteQuery/InfiniteQuery.d.ts +135 -0
  43. package/node/InfiniteQuery/InfiniteQuery.js +169 -0
  44. package/node/InfiniteQuery/index.d.ts +1 -0
  45. package/node/InfiniteQuery/index.js +17 -0
  46. package/node/MobxQuery/MobxQuery.d.ts +176 -0
  47. package/node/MobxQuery/MobxQuery.js +225 -0
  48. package/node/MobxQuery/index.d.ts +1 -0
  49. package/node/MobxQuery/index.js +17 -0
  50. package/node/Mutation/Mutation.d.ts +34 -0
  51. package/node/Mutation/Mutation.js +47 -0
  52. package/node/Mutation/index.d.ts +1 -0
  53. package/node/Mutation/index.js +17 -0
  54. package/node/Query/Query.d.ts +103 -0
  55. package/node/Query/Query.js +113 -0
  56. package/node/Query/index.d.ts +1 -0
  57. package/node/Query/index.js +17 -0
  58. package/node/QueryContainer/QueryContainer.d.ts +61 -0
  59. package/node/QueryContainer/QueryContainer.js +83 -0
  60. package/node/QueryContainer/index.d.ts +1 -0
  61. package/node/QueryContainer/index.js +17 -0
  62. package/node/Sets/InfiniteQuerySet/InfiniteQuerySet.d.ts +60 -0
  63. package/node/Sets/InfiniteQuerySet/InfiniteQuerySet.js +75 -0
  64. package/node/Sets/InfiniteQuerySet/index.d.ts +1 -0
  65. package/node/Sets/InfiniteQuerySet/index.js +17 -0
  66. package/node/Sets/MutationSet/MutationSet.d.ts +32 -0
  67. package/node/Sets/MutationSet/MutationSet.js +35 -0
  68. package/node/Sets/MutationSet/index.d.ts +1 -0
  69. package/node/Sets/MutationSet/index.js +17 -0
  70. package/node/Sets/QuerySet/QuerySet.d.ts +64 -0
  71. package/node/Sets/QuerySet/QuerySet.js +76 -0
  72. package/node/Sets/QuerySet/index.d.ts +1 -0
  73. package/node/Sets/QuerySet/index.js +17 -0
  74. package/node/Sets/index.d.ts +3 -0
  75. package/node/Sets/index.js +19 -0
  76. package/node/Sets/utils/generateQuerySetBaseKey/generateQuerySetBaseKey.d.ts +4 -0
  77. package/node/Sets/utils/generateQuerySetBaseKey/generateQuerySetBaseKey.js +12 -0
  78. package/node/Sets/utils/generateQuerySetBaseKey/index.d.ts +1 -0
  79. package/node/Sets/utils/generateQuerySetBaseKey/index.js +17 -0
  80. package/node/Sets/utils/generateQuerySetKeys/generateQuerySetKeys.d.ts +9 -0
  81. package/node/Sets/utils/generateQuerySetKeys/generateQuerySetKeys.js +27 -0
  82. package/node/Sets/utils/generateQuerySetKeys/index.d.ts +1 -0
  83. package/node/Sets/utils/generateQuerySetKeys/index.js +17 -0
  84. package/node/Sets/utils/index.d.ts +2 -0
  85. package/node/Sets/utils/index.js +18 -0
  86. package/node/StatusStorage/StatusStorage.d.ts +24 -0
  87. package/node/StatusStorage/StatusStorage.js +41 -0
  88. package/node/StatusStorage/index.d.ts +1 -0
  89. package/node/StatusStorage/index.js +17 -0
  90. package/node/StorageFactory/StorageFactory.d.ts +9 -0
  91. package/node/StorageFactory/StorageFactory.js +23 -0
  92. package/node/StorageFactory/index.d.ts +1 -0
  93. package/node/StorageFactory/index.js +17 -0
  94. package/node/index.d.ts +6 -0
  95. package/node/index.js +11 -0
  96. package/node/types.d.ts +55 -0
  97. package/node/types.js +2 -0
  98. package/package.json +11 -4
@@ -0,0 +1,176 @@
1
+ import { Query, type QueryExecutor, type QueryParams } from '../Query';
2
+ import { type InfiniteExecutor, InfiniteQuery, type InfiniteQueryParams } from '../InfiniteQuery';
3
+ import { Mutation, type MutationExecutor, type MutationParams } from '../Mutation';
4
+ import type { CacheKey, FetchPolicy } from '../types';
5
+ import { InfiniteQuerySet, type InfiniteQuerySetConfig, type InfiniteQuerySetConfigurator, MutationSet, QuerySet, type QuerySetConfig, type QuerySetConfigurator } from '../Sets';
6
+ /**
7
+ * Стандартный обработчик ошибки запроса,
8
+ * будет вызван, если при вызове sync не был передан отдельный onError параметр
9
+ */
10
+ type OnError<TError = unknown> = (error: TError) => void;
11
+ type MobxQueryParams = {
12
+ /**
13
+ * Политика получения данных по умолчанию.
14
+ * @enum cache-first - данные сначала берутся из кеша, если их нет, тогда идет обращение к сети, ответ записывается в кэш
15
+ * @enum network-only - данные всегда берутся из сети, при этом ответ записывается в кэш
16
+ */
17
+ fetchPolicy?: FetchPolicy;
18
+ /**
19
+ * обработчик ошибок по умолчанию
20
+ */
21
+ onError?: OnError;
22
+ /**
23
+ * Флаг, отвечающий за автоматический запрос данных при обращении к полю data по умолчанию.
24
+ * @default false
25
+ */
26
+ enabledAutoFetch?: boolean;
27
+ };
28
+ export type CreateQueryParams<TResult, TError, TIsBackground extends boolean> = Omit<QueryParams<TResult, TError, TIsBackground>, 'dataStorage' | 'statusStorage' | 'backgroundStatusStorage' | 'submitValidity'> & {
29
+ /**
30
+ * Режим фонового обновления
31
+ * @default false
32
+ */
33
+ isBackground?: TIsBackground;
34
+ };
35
+ export type CreateInfiniteQueryParams<TResult, TError, TIsBackground extends boolean> = Omit<InfiniteQueryParams<TResult, TError, TIsBackground>, 'dataStorage' | 'statusStorage' | 'backgroundStatusStorage' | 'submitValidity'> & {
36
+ /**
37
+ * Режим фонового обновления
38
+ * @default false
39
+ */
40
+ isBackground?: TIsBackground;
41
+ };
42
+ export type CreateMutationParams<TResult, TError> = MutationParams<TResult, TError>;
43
+ /**
44
+ * Стратегия инвалидации кэша
45
+ * @property 'partial-match' - Проверяет наличие хотя бы одной части ключа в кэше
46
+ * @property 'chain-match' - Проверяет наличие полной связки ключей в кэше
47
+ */
48
+ type InvalidateStrategy = 'partial-match' | 'chain-match';
49
+ /**
50
+ * Сервис, позволяющий кэшировать данные.
51
+ */
52
+ export declare class MobxQuery<TDefaultError = void> {
53
+ /**
54
+ * Объект соответствия хешей ключей и их значений
55
+ */
56
+ private keys;
57
+ /**
58
+ * Map соответствия хешей ключей к запомненным сторам
59
+ */
60
+ private queriesMap;
61
+ /**
62
+ * Фабрика создания хранилищ данных для обычного Query
63
+ */
64
+ private queryDataStorageFactory;
65
+ /**
66
+ * Фабрика создания хранилищ статусов между экземплярами Query и экземллярами Infinite Query.
67
+ */
68
+ private statusStorageFactory;
69
+ /**
70
+ * Стандартный обработчик ошибок, будет использован, если не передан другой
71
+ */
72
+ private readonly defaultErrorHandler?;
73
+ /**
74
+ * Стандартное поведение политики кеширования
75
+ */
76
+ private readonly defaultFetchPolicy;
77
+ /**
78
+ * Флаг, отвечающий за автоматический запрос данных при обращении к полю data
79
+ * @default false
80
+ */
81
+ private readonly defaultEnabledAutoFetch;
82
+ private serialize;
83
+ constructor({ onError, fetchPolicy, enabledAutoFetch, }?: MobxQueryParams);
84
+ /**
85
+ * Проверяет пересечение ключей в зависимости от стратегии
86
+ * @param invalidatedKeys - Ключи для инвалидации
87
+ * @param queryKeys - Ключи запроса
88
+ * @param strategy - Стратегия проверки:
89
+ * - 'chain-match' - все ключи из invalidatedKeys должны присутствовать в queryKeys
90
+ * - 'partial-match' - хотя бы один ключ из invalidatedKeys должен быть в queryKeys
91
+ */
92
+ private checkTouchedElement;
93
+ /**
94
+ * Метод для инвалидации по списку ключей, предполагается использование из домена
95
+ * @param invalidatedKeys - Массив ключей для инвалидации
96
+ * @param strategy - Стратегия инвалидации. 'chain-match' - инвалидировать при совпадении связки ключей в кэше, 'partial-match' - инвалидировать при частичном совпадении ключей. По умолчанию 'partial-match'
97
+ * @example
98
+ * // Инвалидация по частичному совпадению ключей
99
+ * mobxQuery.invalidate(['users', '1']); // Инвалидирует все query, содержащие ключ 'users' или '1'
100
+ *
101
+ * // Инвалидация по совпадению связки ключей
102
+ * mobxQuery.invalidate(['users', '1'], 'chain-match'); // Инвалидирует только query с точным набором ключей ['users', '1']
103
+ */
104
+ invalidate: (invalidatedKeys: CacheKey[], strategy?: InvalidateStrategy) => void;
105
+ private submitValidity;
106
+ /**
107
+ * Метод инвалидации всех query
108
+ */
109
+ invalidateQueries: () => void;
110
+ /**
111
+ * Метод, который занимается проверкой наличия квери по ключу,
112
+ * и если нет, создает новый, добавляет его к себе в память, и возвращает его пользователю
113
+ */
114
+ private getCachedQuery;
115
+ /**
116
+ * Метод для создания ключей к внутренним хранилищам
117
+ */
118
+ private makeKeys;
119
+ private getBackgroundStatusStorage;
120
+ /**
121
+ * Метод создания стора, кешируется
122
+ */
123
+ createQuery: <TResult, TError = TDefaultError, TIsBackground extends boolean = false>(key: CacheKey[], executor: QueryExecutor<TResult>, params?: CreateQueryParams<TResult, TError, TIsBackground>) => Query<TResult, TError, TIsBackground>;
124
+ /**
125
+ * Метод создания инфинит стора, кешируется
126
+ */
127
+ createInfiniteQuery: <TResult, TError = TDefaultError, TIsBackground extends boolean = false>(key: CacheKey[], executor: InfiniteExecutor<TResult>, params?: CreateInfiniteQueryParams<TResult, TError, TIsBackground>) => InfiniteQuery<TResult, TError, TIsBackground>;
128
+ /**
129
+ * Метод создания мутации, не кешируется
130
+ */
131
+ createMutation: <TResult, TError = TDefaultError, TExecutorParams = void>(executor: MutationExecutor<TResult, TExecutorParams>, params?: CreateMutationParams<TResult, TError>) => Mutation<TResult, TError, TExecutorParams>;
132
+ /**
133
+ * Создает набор queries под одним ключем
134
+ * @param configurator - Функция конфигурации набора запросов. Она должна возвращать объект с полями:
135
+ * - keys (необязательно): массив ключей для кеширования;
136
+ * - execute: функция, которая возвращает промис с результатом выполнения запроса.
137
+ * @example
138
+ * const docQuerySet = mobxQuery.createQuerySet((id: string, count?: number) => ({
139
+ * execute: () => docEndpoint.getDoc(id),
140
+ * }));
141
+ *
142
+ * const docQuery = docQuerySet.create();
143
+ *
144
+ * docQuery.data // { data: [id, count] }
145
+ */
146
+ createQuerySet: <TParams extends any[], TResponse>(configurator: QuerySetConfigurator<TParams, TResponse>, config?: QuerySetConfig) => QuerySet<TParams, TResponse, TDefaultError>;
147
+ /**
148
+ * Создает набор infinite queries под одним ключем
149
+ * @param configurator - Функция конфигурации набора запросов. Она должна возвращать объект с полями:
150
+ * - keys (необязательно): массив ключей для кеширования;
151
+ * - execute: функция, которая возвращает промис с результатом выполнения запроса.
152
+ * @example
153
+ * const docListInfiniteQuerySet = mobxQuery.createInfiniteQuerySet((id: string, count?: number) => ({
154
+ * execute: ({ offset, count }) => docEndpoint.getDocList(id, offset, count),
155
+ * }));
156
+ *
157
+ * const docListInfiniteQuery = docListInfiniteQuerySet.create();
158
+ *
159
+ * docListInfiniteQuery.data
160
+ */
161
+ createInfiniteQuerySet: <TParams extends any[], TResponse>(configurator: InfiniteQuerySetConfigurator<TParams, TResponse>, config?: InfiniteQuerySetConfig) => InfiniteQuerySet<TParams, TResponse, TDefaultError>;
162
+ /**
163
+ * Создает набор мутаций для единого интерфейса с query sets
164
+ * @param executor - Функция-исполнитель мутации. Она должна возвращать промис с результатом выполнения мутации.
165
+ * @example
166
+ * const editDocMutationSet = mobxQuery.createMutationSet((params: DocsEndpointsDTO.EditDocInput) => {
167
+ * return docsEndpoint.editDoc(params);
168
+ * });
169
+ *
170
+ * const editDocMutation = editDocMutationSet.create();
171
+ *
172
+ * editDocMutation.sync({ params: { id: 'docId', content: 'Новое содержимое' } });
173
+ */
174
+ createMutationSet: <TResponse, TExecutorParams = void>(executor: MutationExecutor<TResponse, TExecutorParams>) => MutationSet<TResponse, TExecutorParams, TDefaultError>;
175
+ }
176
+ export {};
@@ -0,0 +1,225 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.MobxQuery = void 0;
4
+ const Query_1 = require("../Query");
5
+ const InfiniteQuery_1 = require("../InfiniteQuery");
6
+ const Mutation_1 = require("../Mutation");
7
+ const DataStorage_1 = require("../DataStorage");
8
+ const StatusStorage_1 = require("../StatusStorage");
9
+ const AdaptableMap_1 = require("../AdaptableMap");
10
+ const Sets_1 = require("../Sets");
11
+ /**
12
+ * Сервис, позволяющий кэшировать данные.
13
+ */
14
+ class MobxQuery {
15
+ constructor({ onError, fetchPolicy = 'cache-first', enabledAutoFetch = false, } = {}) {
16
+ /**
17
+ * Объект соответствия хешей ключей и их значений
18
+ */
19
+ this.keys = new Map();
20
+ /**
21
+ * Map соответствия хешей ключей к запомненным сторам
22
+ */
23
+ this.queriesMap = new AdaptableMap_1.AdaptableMap();
24
+ /**
25
+ * Фабрика создания хранилищ данных для обычного Query
26
+ */
27
+ this.queryDataStorageFactory = new DataStorage_1.DataStorageFactory();
28
+ /**
29
+ * Фабрика создания хранилищ статусов между экземплярами Query и экземллярами Infinite Query.
30
+ */
31
+ this.statusStorageFactory = new StatusStorage_1.StatusStorageFactory();
32
+ this.serialize = (data) => JSON.stringify(data);
33
+ /**
34
+ * Проверяет пересечение ключей в зависимости от стратегии
35
+ * @param invalidatedKeys - Ключи для инвалидации
36
+ * @param queryKeys - Ключи запроса
37
+ * @param strategy - Стратегия проверки:
38
+ * - 'chain-match' - все ключи из invalidatedKeys должны присутствовать в queryKeys
39
+ * - 'partial-match' - хотя бы один ключ из invalidatedKeys должен быть в queryKeys
40
+ */
41
+ this.checkTouchedElement = (invalidatedKeys, queryKeys, strategy) => {
42
+ const serializedInvalidatedKeys = invalidatedKeys.map(this.serialize);
43
+ if (strategy === 'chain-match') {
44
+ return serializedInvalidatedKeys.every((invalidatedKey) => queryKeys.some((queryKey) => invalidatedKey === this.serialize(queryKey)));
45
+ }
46
+ return queryKeys.some((queryKey) => serializedInvalidatedKeys.find((invalidatedKey) => invalidatedKey === this.serialize(queryKey)));
47
+ };
48
+ /**
49
+ * Метод для инвалидации по списку ключей, предполагается использование из домена
50
+ * @param invalidatedKeys - Массив ключей для инвалидации
51
+ * @param strategy - Стратегия инвалидации. 'chain-match' - инвалидировать при совпадении связки ключей в кэше, 'partial-match' - инвалидировать при частичном совпадении ключей. По умолчанию 'partial-match'
52
+ * @example
53
+ * // Инвалидация по частичному совпадению ключей
54
+ * mobxQuery.invalidate(['users', '1']); // Инвалидирует все query, содержащие ключ 'users' или '1'
55
+ *
56
+ * // Инвалидация по совпадению связки ключей
57
+ * mobxQuery.invalidate(['users', '1'], 'chain-match'); // Инвалидирует только query с точным набором ключей ['users', '1']
58
+ */
59
+ this.invalidate = (invalidatedKeys, strategy = 'partial-match') => {
60
+ for (const keyHash of this.keys.keys()) {
61
+ const queryKeys = this.keys.get(keyHash);
62
+ if (!queryKeys) {
63
+ return;
64
+ }
65
+ // Проверяем, есть ли пересечение между закешированными ключами и набором ключей для инвалидации
66
+ if (this.checkTouchedElement(invalidatedKeys, queryKeys, strategy)) {
67
+ const query = this.queriesMap.get(keyHash);
68
+ if (query) {
69
+ query.invalidate();
70
+ // Конвертируем инвалидированный квери в слабый,
71
+ // чтобы сборщик мусора мог удалить неиспользуемые квери
72
+ this.queriesMap.convertToWeak(keyHash);
73
+ }
74
+ }
75
+ }
76
+ };
77
+ // Метод для подтверждения того, что квери успешно получил валидные данные
78
+ this.submitValidity = (keyHash) => {
79
+ // конвертируем квери в сильный,
80
+ // чтобы сборщик мусора не удалил наш кеш преждевременно
81
+ this.queriesMap.convertToStrong(keyHash);
82
+ };
83
+ /**
84
+ * Метод инвалидации всех query
85
+ */
86
+ this.invalidateQueries = () => {
87
+ [...this.keys.keys()].forEach((keyHash) => {
88
+ var _a;
89
+ (_a = this.queriesMap.get(keyHash)) === null || _a === void 0 ? void 0 : _a.invalidate();
90
+ this.queriesMap.convertToWeak(keyHash);
91
+ });
92
+ };
93
+ /**
94
+ * Метод, который занимается проверкой наличия квери по ключу,
95
+ * и если нет, создает новый, добавляет его к себе в память, и возвращает его пользователю
96
+ */
97
+ this.getCachedQuery = (key, createInstance, type, createParams) => {
98
+ var _a, _b;
99
+ const fetchPolicy = (createParams === null || createParams === void 0 ? void 0 : createParams.fetchPolicy) || this.defaultFetchPolicy;
100
+ const keys = this.makeKeys(key, fetchPolicy, (_a = createParams === null || createParams === void 0 ? void 0 : createParams.isBackground) !== null && _a !== void 0 ? _a : false, type);
101
+ const cachedQuery = this.queriesMap.get(keys.queryKeyHash);
102
+ if (cachedQuery) {
103
+ return cachedQuery;
104
+ }
105
+ const query = createInstance({
106
+ onError: ((createParams === null || createParams === void 0 ? void 0 : createParams.onError) ||
107
+ this.defaultErrorHandler),
108
+ enabledAutoFetch: (_b = createParams === null || createParams === void 0 ? void 0 : createParams.enabledAutoFetch) !== null && _b !== void 0 ? _b : this.defaultEnabledAutoFetch,
109
+ fetchPolicy: fetchPolicy,
110
+ dataStorage: this.queryDataStorageFactory.getStorage(keys.dataKeyHash),
111
+ statusStorage: this.statusStorageFactory.getStorage(keys.statusKeyHash),
112
+ backgroundStatusStorage: this.getBackgroundStatusStorage(keys.backgroundStatusKeyHash, Boolean(createParams === null || createParams === void 0 ? void 0 : createParams.isBackground)),
113
+ submitValidity:
114
+ // 'network-only' квери не будут подтверждать свою валидность,
115
+ // следовательно, они всегда будут храниться как "слабые",
116
+ // что позволит сборщику мусора удалять их из памяти при отсутствии ссылок
117
+ fetchPolicy !== 'network-only'
118
+ ? () => this.submitValidity(keys.queryKeyHash)
119
+ : undefined,
120
+ });
121
+ this.queriesMap.set(keys.queryKeyHash, query);
122
+ this.keys.set(keys.queryKeyHash, keys.queryKey);
123
+ return query;
124
+ };
125
+ /**
126
+ * Метод для создания ключей к внутренним хранилищам
127
+ */
128
+ this.makeKeys = (rootKey, fetchPolicy, isBackground, type) => {
129
+ // C введением StrictMode в реакт 18, проявилась проблема,
130
+ // что network-only квери, созданные в одном реакт компоненте,
131
+ // создаются дважды (т.к. все хуки вызываются дважды)
132
+ // и т.к. мы не ограничиваем момент запроса,
133
+ // то можем получить эффект, что оба network-only квери
134
+ // делают по отдельному запросу к данным единомоментно.
135
+ // Для решения этой проблемы, добавляем уникальный ключ даты, с обнуляемыми милисекундами,
136
+ // что позволит создавать одинаковые network-only квери в течении одной секунды.
137
+ // Остается крайне редкий корнер кейс, когда разница между созданиями квери крайне мала,
138
+ // но все таки первый был создан в одной секунде, а последующее создание уже попало в следующую секунду.
139
+ // Этот кейс крайне маловероятен, и будет проявляться только в дев режиме с включенным StrictMode,
140
+ // поэтому мы пренебрегаем решением этой проблемы, в угоду упрощения.
141
+ const date = fetchPolicy === 'network-only' ? new Date().setMilliseconds(0) : null;
142
+ const queryKey = [...rootKey, { fetchPolicy, date, isBackground, type }];
143
+ const queryKeyHash = this.serialize(queryKey);
144
+ const dataKeyHash = this.serialize([...rootKey, { type }]);
145
+ const statusKeyHash = this.serialize([...rootKey, { type }]);
146
+ const backgroundStatusKeyHash = this.serialize([
147
+ ...rootKey,
148
+ { type, isBackground },
149
+ ]);
150
+ return {
151
+ queryKey,
152
+ queryKeyHash,
153
+ statusKeyHash,
154
+ backgroundStatusKeyHash,
155
+ dataKeyHash,
156
+ };
157
+ };
158
+ this.getBackgroundStatusStorage = (keyHash, hasBackground) => (hasBackground
159
+ ? this.statusStorageFactory.getStorage(keyHash)
160
+ : null);
161
+ /**
162
+ * Метод создания стора, кешируется
163
+ */
164
+ this.createQuery = (key, executor, params) => this.getCachedQuery(key, (internalParams) => new Query_1.Query(executor, Object.assign(Object.assign(Object.assign({}, params), internalParams), { dataStorage: internalParams.dataStorage })), Query_1.Query.name, params);
165
+ /**
166
+ * Метод создания инфинит стора, кешируется
167
+ */
168
+ this.createInfiniteQuery = (key, executor, params) => this.getCachedQuery(key, (internalParams) => new InfiniteQuery_1.InfiniteQuery(executor, Object.assign(Object.assign(Object.assign({}, params), internalParams), { dataStorage: internalParams.dataStorage })), InfiniteQuery_1.InfiniteQuery.name, params);
169
+ /**
170
+ * Метод создания мутации, не кешируется
171
+ */
172
+ this.createMutation = (executor, params) => new Mutation_1.Mutation(executor, Object.assign(Object.assign({}, params), { onError: (params === null || params === void 0 ? void 0 : params.onError) || this.defaultErrorHandler }));
173
+ /**
174
+ * Создает набор queries под одним ключем
175
+ * @param configurator - Функция конфигурации набора запросов. Она должна возвращать объект с полями:
176
+ * - keys (необязательно): массив ключей для кеширования;
177
+ * - execute: функция, которая возвращает промис с результатом выполнения запроса.
178
+ * @example
179
+ * const docQuerySet = mobxQuery.createQuerySet((id: string, count?: number) => ({
180
+ * execute: () => docEndpoint.getDoc(id),
181
+ * }));
182
+ *
183
+ * const docQuery = docQuerySet.create();
184
+ *
185
+ * docQuery.data // { data: [id, count] }
186
+ */
187
+ // any нужен для вывода типов
188
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
189
+ this.createQuerySet = (configurator, config) => new Sets_1.QuerySet(this, configurator, config);
190
+ /**
191
+ * Создает набор infinite queries под одним ключем
192
+ * @param configurator - Функция конфигурации набора запросов. Она должна возвращать объект с полями:
193
+ * - keys (необязательно): массив ключей для кеширования;
194
+ * - execute: функция, которая возвращает промис с результатом выполнения запроса.
195
+ * @example
196
+ * const docListInfiniteQuerySet = mobxQuery.createInfiniteQuerySet((id: string, count?: number) => ({
197
+ * execute: ({ offset, count }) => docEndpoint.getDocList(id, offset, count),
198
+ * }));
199
+ *
200
+ * const docListInfiniteQuery = docListInfiniteQuerySet.create();
201
+ *
202
+ * docListInfiniteQuery.data
203
+ */
204
+ // any нужен для вывода типов
205
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
206
+ this.createInfiniteQuerySet = (configurator, config) => new Sets_1.InfiniteQuerySet(this, configurator, config);
207
+ /**
208
+ * Создает набор мутаций для единого интерфейса с query sets
209
+ * @param executor - Функция-исполнитель мутации. Она должна возвращать промис с результатом выполнения мутации.
210
+ * @example
211
+ * const editDocMutationSet = mobxQuery.createMutationSet((params: DocsEndpointsDTO.EditDocInput) => {
212
+ * return docsEndpoint.editDoc(params);
213
+ * });
214
+ *
215
+ * const editDocMutation = editDocMutationSet.create();
216
+ *
217
+ * editDocMutation.sync({ params: { id: 'docId', content: 'Новое содержимое' } });
218
+ */
219
+ this.createMutationSet = (executor) => new Sets_1.MutationSet(this, executor);
220
+ this.defaultErrorHandler = onError;
221
+ this.defaultFetchPolicy = fetchPolicy;
222
+ this.defaultEnabledAutoFetch = enabledAutoFetch;
223
+ }
224
+ }
225
+ exports.MobxQuery = MobxQuery;
@@ -0,0 +1 @@
1
+ export * from './MobxQuery';
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./MobxQuery"), exports);
@@ -0,0 +1,34 @@
1
+ import { AuxiliaryQuery } from '../AuxiliaryQuery';
2
+ import type { QueryBaseActions, Sync, SyncParams } from '../types';
3
+ import { QueryContainer } from '../QueryContainer';
4
+ /**
5
+ * Исполнитель запроса
6
+ */
7
+ export type MutationExecutor<TResult, TParams> = (params: TParams) => Promise<TResult>;
8
+ export type MutationParams<TResult, TError> = {
9
+ /**
10
+ * Обработчик ошибки, вызываемый по умолчанию
11
+ */
12
+ onError?: SyncParams<TResult, TError>['onError'];
13
+ };
14
+ /**
15
+ * Простой квери для запросов, которые не требуют кэширования,
16
+ * пример - POST запросы
17
+ */
18
+ export declare class Mutation<TResult, TError = void, TExecutorParams = void> extends QueryContainer<TError, AuxiliaryQuery<TResult, TError>, false> implements QueryBaseActions<TResult, TError, TExecutorParams> {
19
+ private readonly executor;
20
+ /**
21
+ * Обработчик ошибки, вызываемый по умолчанию
22
+ */
23
+ private readonly defaultOnError?;
24
+ constructor(executor: MutationExecutor<TResult, TExecutorParams>, { onError }?: MutationParams<TResult, TError>);
25
+ /**
26
+ * Синхронный метод получения/отправки данных
27
+ */
28
+ sync: Sync<TResult, TError, TExecutorParams>;
29
+ /**
30
+ * Асинхронный метод получения/отправки данных,
31
+ * предполагается, что нужно будет самостоятельно обрабатывать ошибку
32
+ */
33
+ async: (params: TExecutorParams) => Promise<TResult>;
34
+ }
@@ -0,0 +1,47 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Mutation = void 0;
4
+ const mobx_1 = require("mobx");
5
+ const AuxiliaryQuery_1 = require("../AuxiliaryQuery");
6
+ const QueryContainer_1 = require("../QueryContainer");
7
+ const StatusStorage_1 = require("../StatusStorage");
8
+ /**
9
+ * Простой квери для запросов, которые не требуют кэширования,
10
+ * пример - POST запросы
11
+ */
12
+ class Mutation extends QueryContainer_1.QueryContainer {
13
+ constructor(executor, { onError } = {}) {
14
+ const statusStorage = new StatusStorage_1.StatusStorage();
15
+ super(statusStorage, null, new AuxiliaryQuery_1.AuxiliaryQuery(statusStorage, null));
16
+ this.executor = executor;
17
+ /**
18
+ * Синхронный метод получения/отправки данных
19
+ */
20
+ this.sync = (options) => {
21
+ const { onSuccess, onError, params } = options || {};
22
+ this.auxiliary
23
+ .getUnifiedPromise(() => this.executor(params), (resData) => {
24
+ onSuccess === null || onSuccess === void 0 ? void 0 : onSuccess(resData);
25
+ })
26
+ .catch((e) => {
27
+ var _a;
28
+ if (onError) {
29
+ onError(e);
30
+ }
31
+ else {
32
+ (_a = this.defaultOnError) === null || _a === void 0 ? void 0 : _a.call(this, e);
33
+ }
34
+ });
35
+ };
36
+ /**
37
+ * Асинхронный метод получения/отправки данных,
38
+ * предполагается, что нужно будет самостоятельно обрабатывать ошибку
39
+ */
40
+ this.async = (params) => {
41
+ return this.auxiliary.getUnifiedPromise(() => this.executor(params));
42
+ };
43
+ this.defaultOnError = onError;
44
+ (0, mobx_1.makeObservable)(this, { async: mobx_1.action, sync: mobx_1.action });
45
+ }
46
+ }
47
+ exports.Mutation = Mutation;
@@ -0,0 +1 @@
1
+ export * from './Mutation';
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./Mutation"), exports);
@@ -0,0 +1,103 @@
1
+ import { AuxiliaryQuery } from '../AuxiliaryQuery';
2
+ import type { FetchPolicy, QueryBaseActions, Sync, SyncParams } from '../types';
3
+ import type { DataStorage } from '../DataStorage';
4
+ import { QueryContainer } from '../QueryContainer';
5
+ import { type StatusStorage } from '../StatusStorage';
6
+ /**
7
+ * Исполнитель запроса
8
+ */
9
+ export type QueryExecutor<TResult> = () => Promise<TResult>;
10
+ export type QueryParams<TResult, TError, TIsBackground extends boolean = false> = {
11
+ /**
12
+ * Обработчик ошибки, вызываемый по умолчанию
13
+ */
14
+ onError?: SyncParams<TResult, TError>['onError'];
15
+ /**
16
+ * Флаг, отвечающий за автоматический запрос данных при обращении к полю data
17
+ */
18
+ enabledAutoFetch?: boolean;
19
+ /**
20
+ * Политика получения данных.
21
+ * @enum cache-first - данные сначала берутся из кеша, если их нет, тогда идет обращение к сети, ответ записывается в кэш
22
+ * @enum network-only - данные всегда берутся из сети, при этом ответ записывается в кэш
23
+ */
24
+ fetchPolicy?: FetchPolicy;
25
+ /**
26
+ * Инстанс хранилища данных
27
+ */
28
+ dataStorage: DataStorage<TResult>;
29
+ /**
30
+ * Инстанс хранилища основных статусов
31
+ */
32
+ statusStorage: StatusStorage<TError>;
33
+ /**
34
+ * Инстанс хранилища фоновых статусов
35
+ */
36
+ backgroundStatusStorage?: TIsBackground extends true ? StatusStorage<TError> : null | undefined;
37
+ /**
38
+ * Колбэк, вызываемый при успешном завершении запроса, подразумевается использование, для подтверждения валидности данных, чтобы квери не был удален из памяти
39
+ */
40
+ submitValidity?: () => void;
41
+ };
42
+ /**
43
+ * Стор для работы с запросами,
44
+ * которые должны быть закешированы,
45
+ * но им не требуется усложнение в виде работы с фильтрами и инфинити запросами
46
+ */
47
+ export declare class Query<TResult, TError = void, TIsBackground extends boolean = false> extends QueryContainer<TError, AuxiliaryQuery<TResult, TError>, TIsBackground> implements QueryBaseActions<TResult, TError, undefined> {
48
+ private readonly executor;
49
+ /**
50
+ * Хранилище данных, для обеспечения возможности синхронизации данных между разными инстансами
51
+ */
52
+ private storage;
53
+ /**
54
+ * Обработчик ошибки, вызываемый по умолчанию
55
+ */
56
+ private defaultOnError?;
57
+ /**
58
+ * Флаг, отвечающий за автоматический запрос данных при обращении к полю data
59
+ */
60
+ private enabledAutoFetch?;
61
+ /**
62
+ * Стандартное поведение политики кеширования
63
+ */
64
+ private readonly defaultFetchPolicy?;
65
+ /**
66
+ * Колбэк, вызываемый при успешном завершении запроса, подразумевается использование, для подтверждения валидности данных, чтобы квери не был удален из памяти
67
+ */
68
+ private readonly submitValidity?;
69
+ constructor(executor: QueryExecutor<TResult>, { onError, enabledAutoFetch, fetchPolicy, dataStorage, statusStorage, backgroundStatusStorage, submitValidity, }: QueryParams<TResult, TError, TIsBackground>);
70
+ private get isNetworkOnly();
71
+ /**
72
+ * Метод для инвалидации данных
73
+ */
74
+ invalidate: () => void;
75
+ /**
76
+ * Синхронный метод получения данных
77
+ */
78
+ sync: Sync<TResult, TError, undefined>;
79
+ /**
80
+ * Обработчик успешного ответа
81
+ */
82
+ private submitSuccess;
83
+ /**
84
+ * Форс метод для установки данных
85
+ */
86
+ forceUpdate: (data: TResult) => void;
87
+ /**
88
+ * Метод для переиспользования синхронной логики запроса
89
+ */
90
+ protected proceedSync: Sync<TResult, TError>;
91
+ /**
92
+ * Асинхронный метод получения данных,
93
+ * предполагается, что нужно будет самостоятельно обрабатывать ошибку
94
+ */
95
+ async: () => Promise<TResult>;
96
+ /**
97
+ * Содержит реактивные данные
98
+ * благодаря mobx, при изменении isInvalid, свойство будет вычисляться заново,
99
+ * следовательно, стриггерится условие невалидности,
100
+ * и начнется запрос, в результате которого, данные обновятся
101
+ */
102
+ get data(): TResult | undefined;
103
+ }