synapse-storage 3.0.11 → 3.0.13
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.
- package/README.md +92 -1
- package/dist/api.d.ts +1 -1
- package/dist/api.js +1 -1
- package/dist/core.d.ts +5 -307
- package/dist/core.js +1 -1
- package/dist/createSynapse-CzeX0ONj.d.ts +97 -0
- package/dist/{dispatcher.module-jd8U_ZEs.d.ts → dispatcher.module-DjMloBXe.d.ts} +4 -7
- package/dist/index.d.ts +5 -4
- package/dist/index.js +1 -1
- package/dist/react.d.ts +3 -3
- package/dist/react.js +1 -1
- package/dist/reactive.d.ts +3 -3
- package/dist/reactive.js +1 -1
- package/dist/storage.interface-2HKvqdAJ.d.ts +444 -0
- package/dist/utils.d.ts +87 -84
- package/dist/utils.js +1 -1
- package/package.json +15 -50
- package/dist/api.cjs +0 -1
- package/dist/core.cjs +0 -1
- package/dist/index.cjs +0 -1
- package/dist/react.cjs +0 -1
- package/dist/reactive.cjs +0 -1
- package/dist/storage.interface-Dl8SLUd1.d.ts +0 -128
- package/dist/utils.cjs +0 -1
|
@@ -0,0 +1,444 @@
|
|
|
1
|
+
declare class StorageKey {
|
|
2
|
+
private readonly value;
|
|
3
|
+
private readonly isRawKey;
|
|
4
|
+
constructor(value: string, isRawKey?: boolean);
|
|
5
|
+
toString(): string;
|
|
6
|
+
toJSON(): string;
|
|
7
|
+
valueOf(): string;
|
|
8
|
+
isUnparseable(): boolean;
|
|
9
|
+
}
|
|
10
|
+
type StorageKeyType = string | StorageKey;
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* Контекст выполнения для плагинов
|
|
14
|
+
* Содержит информацию о текущей операции и хранилище
|
|
15
|
+
*/
|
|
16
|
+
interface PluginContext {
|
|
17
|
+
/** Имя хранилища, к которому применяется плагин */
|
|
18
|
+
storageName: string;
|
|
19
|
+
/** Временная метка выполнения операции (timestamp) */
|
|
20
|
+
timestamp: number;
|
|
21
|
+
/** Дополнительные метаданные операции (могут быть предоставлены хранилищем или другими плагинами) */
|
|
22
|
+
metadata?: Record<string, any>;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Базовый интерфейс для всех плагинов
|
|
26
|
+
* Определяет основные свойства и методы жизненного цикла
|
|
27
|
+
*/
|
|
28
|
+
interface IPlugin {
|
|
29
|
+
/** Уникальное имя плагина */
|
|
30
|
+
name: string;
|
|
31
|
+
/**
|
|
32
|
+
* Метод инициализации плагина
|
|
33
|
+
* Вызывается при добавлении плагина в хранилище или при инициализации хранилища
|
|
34
|
+
*/
|
|
35
|
+
initialize?(): Promise<void>;
|
|
36
|
+
/**
|
|
37
|
+
* Метод уничтожения плагина
|
|
38
|
+
* Вызывается при удалении плагина из хранилища или при уничтожении хранилища
|
|
39
|
+
* Используется для освобождения ресурсов и очистки состояния
|
|
40
|
+
*/
|
|
41
|
+
destroy?(): Promise<void>;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Интерфейс плагина для хранилища данных
|
|
45
|
+
* Определяет хуки для различных операций хранилища
|
|
46
|
+
*/
|
|
47
|
+
interface IStoragePlugin extends IPlugin {
|
|
48
|
+
/**
|
|
49
|
+
* Вызывается перед установкой значения в хранилище
|
|
50
|
+
* Позволяет изменить значение до его сохранения
|
|
51
|
+
*
|
|
52
|
+
* @param value Значение, которое будет сохранено
|
|
53
|
+
* @param context Контекст выполнения операции
|
|
54
|
+
* @returns Модифицированное значение для сохранения
|
|
55
|
+
*/
|
|
56
|
+
onBeforeSet?<T>(value: T, context: PluginContext): Promise<T>;
|
|
57
|
+
/**
|
|
58
|
+
* Вызывается после установки значения в хранилище
|
|
59
|
+
* Позволяет выполнить дополнительные действия или модифицировать результат
|
|
60
|
+
*
|
|
61
|
+
* @param key Ключ, по которому было сохранено значение
|
|
62
|
+
* @param value Сохраненное значение
|
|
63
|
+
* @param context Контекст выполнения операции
|
|
64
|
+
* @returns Финальное значение (может быть модифицировано)
|
|
65
|
+
*/
|
|
66
|
+
onAfterSet?<T>(key: StorageKeyType, value: T, context: PluginContext): Promise<T>;
|
|
67
|
+
/**
|
|
68
|
+
* Вызывается перед получением значения из хранилища
|
|
69
|
+
* Позволяет модифицировать запрашиваемый ключ
|
|
70
|
+
*
|
|
71
|
+
* @param key Ключ, по которому запрашивается значение
|
|
72
|
+
* @param context Контекст выполнения операции
|
|
73
|
+
* @returns Возможно модифицированный ключ для запроса
|
|
74
|
+
*/
|
|
75
|
+
onBeforeGet?(key: StorageKeyType, context: PluginContext): Promise<StorageKeyType>;
|
|
76
|
+
/**
|
|
77
|
+
* Вызывается после получения значения из хранилища
|
|
78
|
+
* Позволяет модифицировать полученное значение
|
|
79
|
+
*
|
|
80
|
+
* @param key Ключ, по которому было запрошено значение
|
|
81
|
+
* @param value Полученное значение (undefined, если значение не найдено)
|
|
82
|
+
* @param context Контекст выполнения операции
|
|
83
|
+
* @returns Финальное значение (может быть модифицировано)
|
|
84
|
+
*/
|
|
85
|
+
onAfterGet?<T>(key: StorageKeyType, value: T | undefined, context: PluginContext): Promise<T | undefined>;
|
|
86
|
+
/**
|
|
87
|
+
* Вызывается перед удалением значения из хранилища
|
|
88
|
+
* Позволяет разрешить или запретить удаление
|
|
89
|
+
*
|
|
90
|
+
* @param key Ключ, по которому будет удалено значение
|
|
91
|
+
* @param context Контекст выполнения операции
|
|
92
|
+
* @returns Булево значение, разрешающее (true) или запрещающее (false) удаление
|
|
93
|
+
*/
|
|
94
|
+
onBeforeDelete?(key: StorageKeyType, context: PluginContext): Promise<boolean>;
|
|
95
|
+
/**
|
|
96
|
+
* Вызывается после удаления значения из хранилища
|
|
97
|
+
* Позволяет выполнить дополнительные действия после удаления
|
|
98
|
+
*
|
|
99
|
+
* @param key Ключ, по которому было удалено значение
|
|
100
|
+
* @param context Контекст выполнения операции
|
|
101
|
+
*/
|
|
102
|
+
onAfterDelete?(key: StorageKeyType, context: PluginContext): Promise<void>;
|
|
103
|
+
/**
|
|
104
|
+
* Вызывается перед очисткой хранилища
|
|
105
|
+
* Позволяет выполнить дополнительные действия перед удалением всех данных
|
|
106
|
+
*
|
|
107
|
+
* @param context Контекст выполнения операции
|
|
108
|
+
*/
|
|
109
|
+
onClear?(context: PluginContext): Promise<void>;
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Исполнитель плагинов
|
|
113
|
+
* Отвечает за выполнение хуков плагинов в определенной последовательности
|
|
114
|
+
*/
|
|
115
|
+
interface IPluginExecutor {
|
|
116
|
+
/**
|
|
117
|
+
* Выполняет хуки onBeforeSet всех зарегистрированных плагинов
|
|
118
|
+
*
|
|
119
|
+
* @param value Исходное значение
|
|
120
|
+
* @param metadata Дополнительные метаданные
|
|
121
|
+
* @returns Модифицированное значение после прохождения всех плагинов
|
|
122
|
+
*/
|
|
123
|
+
executeBeforeSet<T>(value: T, metadata?: Record<string, any>): Promise<T>;
|
|
124
|
+
/**
|
|
125
|
+
* Выполняет хуки onAfterSet всех зарегистрированных плагинов
|
|
126
|
+
*
|
|
127
|
+
* @param key Ключ, по которому было сохранено значение
|
|
128
|
+
* @param value Сохраненное значение
|
|
129
|
+
* @param metadata Дополнительные метаданные
|
|
130
|
+
* @returns Финальное значение после прохождения всех плагинов
|
|
131
|
+
*/
|
|
132
|
+
executeAfterSet<T>(key: StorageKeyType, value: T, metadata?: Record<string, any>): Promise<T>;
|
|
133
|
+
/**
|
|
134
|
+
* Выполняет хуки onBeforeGet всех зарегистрированных плагинов
|
|
135
|
+
*
|
|
136
|
+
* @param key Исходный ключ
|
|
137
|
+
* @param metadata Дополнительные метаданные
|
|
138
|
+
* @returns Модифицированный ключ после прохождения всех плагинов
|
|
139
|
+
*/
|
|
140
|
+
executeBeforeGet(key: StorageKeyType, metadata?: Record<string, any>): Promise<StorageKeyType>;
|
|
141
|
+
/**
|
|
142
|
+
* Выполняет хуки onAfterGet всех зарегистрированных плагинов
|
|
143
|
+
*
|
|
144
|
+
* @param key Ключ, по которому было запрошено значение
|
|
145
|
+
* @param value Полученное значение
|
|
146
|
+
* @param metadata Дополнительные метаданные
|
|
147
|
+
* @returns Финальное значение после прохождения всех плагинов
|
|
148
|
+
*/
|
|
149
|
+
executeAfterGet<T>(key: StorageKeyType, value: T | undefined, metadata?: Record<string, any>): Promise<T | undefined>;
|
|
150
|
+
/**
|
|
151
|
+
* Выполняет хуки onBeforeDelete всех зарегистрированных плагинов
|
|
152
|
+
*
|
|
153
|
+
* @param key Ключ, по которому будет удалено значение
|
|
154
|
+
* @param metadata Дополнительные метаданные
|
|
155
|
+
* @returns Результат проверки всех плагинов (false если хотя бы один плагин запретил удаление)
|
|
156
|
+
*/
|
|
157
|
+
executeBeforeDelete(key: StorageKeyType, metadata?: Record<string, any>): Promise<boolean>;
|
|
158
|
+
/**
|
|
159
|
+
* Выполняет хуки onAfterDelete всех зарегистрированных плагинов
|
|
160
|
+
*
|
|
161
|
+
* @param key Ключ, по которому было удалено значение
|
|
162
|
+
* @param metadata Дополнительные метаданные
|
|
163
|
+
*/
|
|
164
|
+
executeAfterDelete(key: StorageKeyType, metadata?: Record<string, any>): Promise<void>;
|
|
165
|
+
/**
|
|
166
|
+
* Выполняет хуки onClear всех зарегистрированных плагинов
|
|
167
|
+
*
|
|
168
|
+
* @param metadata Дополнительные метаданные
|
|
169
|
+
*/
|
|
170
|
+
executeOnClear(metadata?: Record<string, any>): Promise<void>;
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* Менеджер плагинов
|
|
174
|
+
* Отвечает за регистрацию, получение и удаление плагинов
|
|
175
|
+
*/
|
|
176
|
+
interface IPluginManager<T extends IPlugin> {
|
|
177
|
+
/**
|
|
178
|
+
* Добавляет плагин в менеджер
|
|
179
|
+
*
|
|
180
|
+
* @param plugin Экземпляр плагина
|
|
181
|
+
*/
|
|
182
|
+
add(plugin: T): Promise<void>;
|
|
183
|
+
/**
|
|
184
|
+
* Удаляет плагин из менеджера по имени
|
|
185
|
+
*
|
|
186
|
+
* @param name Имя плагина
|
|
187
|
+
*/
|
|
188
|
+
remove(name: string): Promise<void>;
|
|
189
|
+
/**
|
|
190
|
+
* Получает плагин по имени
|
|
191
|
+
*
|
|
192
|
+
* @param name Имя плагина
|
|
193
|
+
* @returns Экземпляр плагина или undefined, если плагин не найден
|
|
194
|
+
*/
|
|
195
|
+
get(name: string): T | undefined;
|
|
196
|
+
/**
|
|
197
|
+
* Получает все зарегистрированные плагины
|
|
198
|
+
*
|
|
199
|
+
* @returns Массив всех плагинов
|
|
200
|
+
*/
|
|
201
|
+
getAll(): T[];
|
|
202
|
+
/**
|
|
203
|
+
* Инициализирует все зарегистрированные плагины
|
|
204
|
+
*/
|
|
205
|
+
initialize(): Promise<void>;
|
|
206
|
+
/**
|
|
207
|
+
* Уничтожает все зарегистрированные плагины
|
|
208
|
+
*/
|
|
209
|
+
destroy(): Promise<void>;
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
type PathSelector<T, R> = (state: T) => R;
|
|
213
|
+
declare abstract class BaseStorage<T extends Record<string, any>> implements IStorage<T> {
|
|
214
|
+
protected readonly config: StorageConfig;
|
|
215
|
+
protected readonly pluginExecutor?: IPluginExecutor | undefined;
|
|
216
|
+
protected readonly eventEmitter?: IEventEmitter | undefined;
|
|
217
|
+
protected readonly logger?: ILogger | undefined;
|
|
218
|
+
protected static readonly GLOBAL_SUBSCRIPTION_KEY = "*";
|
|
219
|
+
name: string;
|
|
220
|
+
private _initStatus;
|
|
221
|
+
private statusSubscribers;
|
|
222
|
+
private selectorPathCache;
|
|
223
|
+
private middlewareModule;
|
|
224
|
+
private initializedMiddlewares;
|
|
225
|
+
protected subscribers: Map<StorageKeyType, Set<(value: any) => void>>;
|
|
226
|
+
constructor(config: StorageConfig, pluginExecutor?: IPluginExecutor | undefined, eventEmitter?: IEventEmitter | undefined, logger?: ILogger | undefined);
|
|
227
|
+
get initStatus(): StorageInitStatus;
|
|
228
|
+
waitForReady(): Promise<this>;
|
|
229
|
+
onStatusChange(callback: (status: StorageInitStatus) => void): VoidFunction;
|
|
230
|
+
private updateInitStatus;
|
|
231
|
+
initialize(): Promise<this>;
|
|
232
|
+
protected abstract doInitialize(): Promise<this>;
|
|
233
|
+
private ensureReady;
|
|
234
|
+
protected initializeMiddlewares(): void;
|
|
235
|
+
protected getDefaultMiddleware(): DefaultMiddlewares;
|
|
236
|
+
protected initializeWithMiddlewares(): Promise<void>;
|
|
237
|
+
protected abstract doGet(key: StorageKeyType): Promise<any>;
|
|
238
|
+
protected abstract doSet(key: StorageKeyType, value: any): Promise<void>;
|
|
239
|
+
protected abstract doUpdate(updates: Array<{
|
|
240
|
+
key: StorageKeyType;
|
|
241
|
+
value: any;
|
|
242
|
+
}>): Promise<void>;
|
|
243
|
+
protected abstract doDelete(key: StorageKeyType): Promise<boolean>;
|
|
244
|
+
protected abstract doClear(): Promise<void>;
|
|
245
|
+
protected abstract doKeys(): Promise<string[]>;
|
|
246
|
+
protected abstract doHas(key: StorageKeyType): Promise<boolean>;
|
|
247
|
+
protected abstract doDestroy(): Promise<void>;
|
|
248
|
+
get<R>(key: StorageKeyType): Promise<R | undefined>;
|
|
249
|
+
set<R>(key: StorageKeyType, value: R): Promise<void>;
|
|
250
|
+
update(updater: (state: T) => void): Promise<void>;
|
|
251
|
+
delete(key: StorageKeyType): Promise<void>;
|
|
252
|
+
clear(): Promise<void>;
|
|
253
|
+
keys(): Promise<string[]>;
|
|
254
|
+
has(key: StorageKeyType): Promise<boolean>;
|
|
255
|
+
getState(): Promise<T>;
|
|
256
|
+
subscribeToAll(callback: (event: {
|
|
257
|
+
type: string;
|
|
258
|
+
key?: StorageKeyType[] | StorageKeyType;
|
|
259
|
+
value?: any;
|
|
260
|
+
changedPaths?: string[];
|
|
261
|
+
}) => void): VoidFunction;
|
|
262
|
+
subscribe(key: string, callback: (value: any) => void): VoidFunction;
|
|
263
|
+
subscribe<R>(pathSelector: PathSelector<T, R>, callback: (value: R) => void): VoidFunction;
|
|
264
|
+
destroy(): Promise<void>;
|
|
265
|
+
private subscribeByKey;
|
|
266
|
+
private createDummyState;
|
|
267
|
+
private isEqual;
|
|
268
|
+
/**
|
|
269
|
+
* Возвращает полный путь, а не только корневой ключ
|
|
270
|
+
*/
|
|
271
|
+
private extractPath;
|
|
272
|
+
protected notifySubscribers(key: StorageKeyType, value: any): void;
|
|
273
|
+
/**
|
|
274
|
+
* Метод для определения изменившихся путей между двумя объектами
|
|
275
|
+
*/
|
|
276
|
+
private findChangedPaths;
|
|
277
|
+
private subscribeBySelector;
|
|
278
|
+
protected emitEvent(event: StorageEvent): Promise<void>;
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
interface IndexedDBConfig {
|
|
282
|
+
dbName?: string;
|
|
283
|
+
dbVersion: number;
|
|
284
|
+
}
|
|
285
|
+
declare class IndexedDBStorage<T extends Record<string, any>> extends BaseStorage<T> {
|
|
286
|
+
private readonly DB_NAME;
|
|
287
|
+
private readonly STORE_NAME;
|
|
288
|
+
private readonly DB_VERSION;
|
|
289
|
+
private dbManager;
|
|
290
|
+
constructor(config: StorageConfig & {
|
|
291
|
+
options: IndexedDBConfig;
|
|
292
|
+
}, pluginExecutor?: IPluginExecutor, eventEmitter?: IEventEmitter, logger?: ILogger);
|
|
293
|
+
protected doInitialize(): Promise<this>;
|
|
294
|
+
static getCurrentDBVersion(dbName: string): Promise<number>;
|
|
295
|
+
static createStorages<S extends Record<string, any>>(dbName: string, configs: {
|
|
296
|
+
[K in keyof S]: {
|
|
297
|
+
name: string;
|
|
298
|
+
initialState?: S[K];
|
|
299
|
+
middlewares?: ConfigureMiddlewares;
|
|
300
|
+
pluginExecutor?: IPluginExecutor;
|
|
301
|
+
eventEmitter?: IEventEmitter;
|
|
302
|
+
};
|
|
303
|
+
}, logger?: ILogger): Promise<{
|
|
304
|
+
[K in keyof S]: IndexedDBStorage<S[K]>;
|
|
305
|
+
}>;
|
|
306
|
+
private getTransaction;
|
|
307
|
+
private getObjectStore;
|
|
308
|
+
protected doGet(key: StorageKeyType): Promise<any>;
|
|
309
|
+
protected doSet(key: StorageKeyType, value: any): Promise<void>;
|
|
310
|
+
private putValueInStore;
|
|
311
|
+
protected doUpdate(updates: Array<{
|
|
312
|
+
key: string | StorageKey;
|
|
313
|
+
value: any;
|
|
314
|
+
}>): Promise<void>;
|
|
315
|
+
protected doDelete(key: StorageKeyType): Promise<boolean>;
|
|
316
|
+
protected doClear(): Promise<void>;
|
|
317
|
+
protected doKeys(): Promise<string[]>;
|
|
318
|
+
protected doHas(key: StorageKeyType): Promise<boolean>;
|
|
319
|
+
protected doDestroy(): Promise<void>;
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
type StorageActionType = 'get' | 'set' | 'delete' | 'clear' | 'init' | 'keys' | 'update';
|
|
323
|
+
type StorageAction = {
|
|
324
|
+
type: StorageActionType;
|
|
325
|
+
key?: StorageKeyType;
|
|
326
|
+
value?: any;
|
|
327
|
+
metadata?: Record<string, any>;
|
|
328
|
+
source?: string;
|
|
329
|
+
timestamp?: number;
|
|
330
|
+
};
|
|
331
|
+
type MiddlewareAPI = {
|
|
332
|
+
dispatch: (action: StorageAction) => Promise<any>;
|
|
333
|
+
getState: () => Promise<Record<string, any>>;
|
|
334
|
+
storage: {
|
|
335
|
+
doGet: (key: StorageKeyType) => Promise<any>;
|
|
336
|
+
doSet: (key: StorageKeyType, value: any) => Promise<void>;
|
|
337
|
+
doUpdate: (updates: Array<{
|
|
338
|
+
key: StorageKeyType;
|
|
339
|
+
value: any;
|
|
340
|
+
}>) => Promise<void>;
|
|
341
|
+
doDelete: (key: StorageKeyType) => Promise<boolean>;
|
|
342
|
+
doClear: () => Promise<void>;
|
|
343
|
+
doKeys: () => Promise<string[]>;
|
|
344
|
+
notifySubscribers: (key: StorageKeyType, value: any) => void;
|
|
345
|
+
};
|
|
346
|
+
};
|
|
347
|
+
type NextFunction = (action: StorageAction) => Promise<any>;
|
|
348
|
+
type SetupEventsFunction = (api: MiddlewareAPI) => void;
|
|
349
|
+
type Middleware = {
|
|
350
|
+
name: string;
|
|
351
|
+
setup?: SetupEventsFunction;
|
|
352
|
+
cleanup?: () => Promise<void> | void;
|
|
353
|
+
reducer: (api: MiddlewareAPI) => (next: NextFunction) => (action: StorageAction) => Promise<any>;
|
|
354
|
+
};
|
|
355
|
+
|
|
356
|
+
interface BatchingMiddlewareOptions {
|
|
357
|
+
batchSize?: number;
|
|
358
|
+
batchDelay?: number;
|
|
359
|
+
}
|
|
360
|
+
|
|
361
|
+
interface ShallowCompareMiddlewareOptions {
|
|
362
|
+
segments?: string[];
|
|
363
|
+
comparator?: <T>(prev: T, next: T) => boolean;
|
|
364
|
+
}
|
|
365
|
+
|
|
366
|
+
declare enum StorageStatus {
|
|
367
|
+
IDLE = "idle",// Не инициализировано
|
|
368
|
+
LOADING = "loading",// В процессе инициализации
|
|
369
|
+
READY = "ready",// Успешно инициализировано
|
|
370
|
+
ERROR = "error"
|
|
371
|
+
}
|
|
372
|
+
interface StorageInitStatus {
|
|
373
|
+
status: StorageStatus;
|
|
374
|
+
error?: Error;
|
|
375
|
+
}
|
|
376
|
+
interface IStorage<T extends Record<string, any> = any> {
|
|
377
|
+
name: string;
|
|
378
|
+
get<R>(key: StorageKeyType): Promise<R | undefined>;
|
|
379
|
+
getState(): Promise<T>;
|
|
380
|
+
set<R>(key: StorageKeyType, value: R): Promise<void>;
|
|
381
|
+
update(updater: (state: T) => void): Promise<void>;
|
|
382
|
+
has(key: StorageKeyType): Promise<boolean>;
|
|
383
|
+
delete(key: StorageKeyType): Promise<void>;
|
|
384
|
+
clear(): Promise<void>;
|
|
385
|
+
keys(): Promise<string[]>;
|
|
386
|
+
destroy(): Promise<void>;
|
|
387
|
+
subscribeToAll(callback: (event: {
|
|
388
|
+
type: string;
|
|
389
|
+
changedPaths?: string[];
|
|
390
|
+
key?: StorageKeyType[] | StorageKeyType;
|
|
391
|
+
value?: any;
|
|
392
|
+
}) => void): VoidFunction;
|
|
393
|
+
initialize(): Promise<this>;
|
|
394
|
+
subscribe(key: StorageKeyType, callback: (value: any) => void): VoidFunction;
|
|
395
|
+
subscribe<R>(pathSelector: (state: T) => R, callback: (value: R) => void): VoidFunction;
|
|
396
|
+
onStatusChange(callback: (status: StorageInitStatus) => void): VoidFunction;
|
|
397
|
+
waitForReady(): Promise<this>;
|
|
398
|
+
}
|
|
399
|
+
declare enum StorageEvents {
|
|
400
|
+
STORAGE_UPDATE = "storage:update",
|
|
401
|
+
STORAGE_DELETE = "storage:delete",
|
|
402
|
+
STORAGE_PATCH = "storage:patch",
|
|
403
|
+
STORAGE_SELECT = "storage:select",
|
|
404
|
+
STORAGE_CLEAR = "storage:clear",
|
|
405
|
+
STORAGE_DESTROY = "storage:destroy"
|
|
406
|
+
}
|
|
407
|
+
interface StorageEvent<T = any> {
|
|
408
|
+
type: string;
|
|
409
|
+
payload?: T;
|
|
410
|
+
metadata?: Record<string, any>;
|
|
411
|
+
}
|
|
412
|
+
interface IEventEmitter {
|
|
413
|
+
emit(event: StorageEvent): Promise<void>;
|
|
414
|
+
}
|
|
415
|
+
interface ILogger {
|
|
416
|
+
debug(message: string, meta?: Record<string, any>): void;
|
|
417
|
+
info(message: string, meta?: Record<string, any>): void;
|
|
418
|
+
warn(message: string, meta?: Record<string, any>): void;
|
|
419
|
+
error(message: string, meta?: Record<string, any>): void;
|
|
420
|
+
}
|
|
421
|
+
interface DefaultMiddlewares {
|
|
422
|
+
batching: (options?: BatchingMiddlewareOptions) => Middleware;
|
|
423
|
+
shallowCompare: (options?: ShallowCompareMiddlewareOptions) => Middleware;
|
|
424
|
+
}
|
|
425
|
+
type GetDefaultMiddleware = () => DefaultMiddlewares;
|
|
426
|
+
type ConfigureMiddlewares = (getDefaultMiddleware: GetDefaultMiddleware) => Middleware[];
|
|
427
|
+
interface StorageConfig {
|
|
428
|
+
name: string;
|
|
429
|
+
initialState?: Record<string, any>;
|
|
430
|
+
middlewares?: ConfigureMiddlewares;
|
|
431
|
+
}
|
|
432
|
+
type StorageType = 'memory' | 'localStorage' | 'indexedDB';
|
|
433
|
+
interface MemoryStorageConfig extends StorageConfig {
|
|
434
|
+
type: 'memory';
|
|
435
|
+
}
|
|
436
|
+
interface LocalStorageConfig extends StorageConfig {
|
|
437
|
+
type: 'localStorage';
|
|
438
|
+
}
|
|
439
|
+
interface IndexedDBStorageConfig extends StorageConfig {
|
|
440
|
+
type: 'indexedDB';
|
|
441
|
+
options: IndexedDBConfig;
|
|
442
|
+
}
|
|
443
|
+
|
|
444
|
+
export { type BatchingMiddlewareOptions as B, type ConfigureMiddlewares as C, type DefaultMiddlewares as D, type GetDefaultMiddleware as G, IndexedDBStorage as I, type LocalStorageConfig as L, type Middleware as M, type NextFunction as N, type PluginContext as P, type ShallowCompareMiddlewareOptions as S, type MiddlewareAPI as a, type StorageAction as b, type StorageKeyType as c, type IPlugin as d, type IStoragePlugin as e, type IPluginExecutor as f, type IPluginManager as g, StorageStatus as h, type StorageInitStatus as i, type IStorage as j, StorageEvents as k, type StorageEvent as l, type IEventEmitter as m, type ILogger as n, type StorageConfig as o, type StorageType as p, type MemoryStorageConfig as q, type IndexedDBStorageConfig as r, BaseStorage as s };
|
package/dist/utils.d.ts
CHANGED
|
@@ -1,92 +1,95 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
1
|
+
import { a as SynapseStoreWithDispatcher } from './createSynapse-CzeX0ONj.js';
|
|
2
|
+
export { A as AnySynapseStore, S as SynapseStoreBasic, b as SynapseStoreWithEffects, c as createSynapse } from './createSynapse-CzeX0ONj.js';
|
|
3
|
+
import { j as IStorage } from './storage.interface-2HKvqdAJ.js';
|
|
4
|
+
import { D as DispatchFunction, f as DispatchActions } from './dispatcher.module-DjMloBXe.js';
|
|
5
|
+
import 'rxjs';
|
|
6
|
+
import './selector.interface-CA5y-kD_.js';
|
|
5
7
|
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
storage: IStorage<TStore>;
|
|
15
|
-
createStorageFn?: undefined;
|
|
16
|
-
} | {
|
|
17
|
-
storage?: undefined;
|
|
18
|
-
createStorageFn: StorageCreatorFunction<TStore>;
|
|
19
|
-
}) & {
|
|
20
|
-
externalSelectors?: TExternalSelectors;
|
|
21
|
-
createSelectorsFn?: (selectorModule: ISelectorModule<TStore>, externalSelectors: TExternalSelectors) => TSelectors;
|
|
22
|
-
};
|
|
23
|
-
/**
|
|
24
|
-
* Конфигурация с dispatcher и effects
|
|
25
|
-
*/
|
|
26
|
-
type CreateSynapseConfigWithEffects<TStore extends Record<string, any>, TSelectors = any, TDispatcher = any, TApi extends Record<string, any> = Record<string, never>, TConfig extends Record<string, any> = Record<string, never>, TExternalSelectors extends Record<string, any> = Record<string, any>> = BaseSynapseConfig<TStore, TSelectors, TExternalSelectors> & {
|
|
27
|
-
createDispatcherFn: (storage: IStorage<TStore>) => TDispatcher;
|
|
28
|
-
createEffectConfig: (dispatcher: TDispatcher) => {
|
|
29
|
-
dispatchers: Record<string, any>;
|
|
30
|
-
api?: TApi;
|
|
31
|
-
config?: TConfig;
|
|
32
|
-
externalStates?: ExternalStates;
|
|
8
|
+
interface EventBusEvent {
|
|
9
|
+
id: string;
|
|
10
|
+
event: string;
|
|
11
|
+
data: any;
|
|
12
|
+
metadata: {
|
|
13
|
+
ttl?: number | null;
|
|
14
|
+
priority?: 'low' | 'normal' | 'high';
|
|
15
|
+
[key: string]: any;
|
|
33
16
|
};
|
|
34
|
-
|
|
35
|
-
};
|
|
36
|
-
/**
|
|
37
|
-
* Конфигурация только с dispatcher
|
|
38
|
-
*/
|
|
39
|
-
type CreateSynapseConfigWithDispatcher<TStore extends Record<string, any>, TSelectors = any, TDispatcher = any, TExternalSelectors extends Record<string, any> = Record<string, any>> = BaseSynapseConfig<TStore, TSelectors, TExternalSelectors> & {
|
|
40
|
-
createDispatcherFn: (storage: IStorage<TStore>) => TDispatcher;
|
|
41
|
-
createEffectConfig?: never;
|
|
42
|
-
effects?: never;
|
|
43
|
-
};
|
|
44
|
-
/**
|
|
45
|
-
* Конфигурация без dispatcher
|
|
46
|
-
*/
|
|
47
|
-
type CreateSynapseConfigBasic<TStore extends Record<string, any>, TSelectors = any, TExternalSelectors extends Record<string, any> = Record<string, any>> = BaseSynapseConfig<TStore, TSelectors, TExternalSelectors> & {
|
|
48
|
-
createDispatcherFn?: never;
|
|
49
|
-
createEffectConfig?: never;
|
|
50
|
-
effects?: never;
|
|
51
|
-
};
|
|
52
|
-
/**
|
|
53
|
-
* Результат с dispatcher и effects
|
|
54
|
-
*/
|
|
55
|
-
interface SynapseStoreWithEffects<TStore extends Record<string, any>, TStorage extends IStorage<TStore>, TSelectors, TActions> {
|
|
56
|
-
storage: TStorage;
|
|
57
|
-
selectors: TSelectors;
|
|
58
|
-
actions: TActions;
|
|
59
|
-
state$: Observable<TStore>;
|
|
60
|
-
dispatcher: any;
|
|
61
|
-
destroy: () => Promise<void>;
|
|
17
|
+
timestamp: number;
|
|
62
18
|
}
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
interface SynapseStoreWithDispatcher<TStore extends Record<string, any>, TStorage extends IStorage<TStore>, TSelectors, TActions> {
|
|
67
|
-
storage: TStorage;
|
|
68
|
-
selectors: TSelectors;
|
|
69
|
-
actions: TActions;
|
|
70
|
-
dispatcher: any;
|
|
71
|
-
destroy: () => Promise<void>;
|
|
19
|
+
interface EventBusState {
|
|
20
|
+
events: Record<string, EventBusEvent>;
|
|
21
|
+
subscriptions: Record<string, any>;
|
|
72
22
|
}
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
storage: TStorage;
|
|
78
|
-
selectors: TSelectors;
|
|
79
|
-
destroy: () => Promise<void>;
|
|
23
|
+
interface EventBusConfig {
|
|
24
|
+
name?: string;
|
|
25
|
+
autoCleanup?: boolean;
|
|
26
|
+
maxEvents?: number;
|
|
80
27
|
}
|
|
81
28
|
/**
|
|
82
|
-
*
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
*
|
|
29
|
+
* Создает EventBus для связи между модулями
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* ```typescript
|
|
33
|
+
* // Создание EventBus
|
|
34
|
+
* const eventBus = await createEventBus({
|
|
35
|
+
* name: 'app-events',
|
|
36
|
+
* autoCleanup: true,
|
|
37
|
+
* maxEvents: 500
|
|
38
|
+
* })
|
|
39
|
+
*
|
|
40
|
+
* // Использование в Synapse
|
|
41
|
+
* const mySynapse = await createSynapse({
|
|
42
|
+
* dependencies: [eventBus],
|
|
43
|
+
* createEffectConfig: (dispatcher) => ({
|
|
44
|
+
* dispatchers: {
|
|
45
|
+
* dispatcher,
|
|
46
|
+
* eventBus: eventBus.dispatcher
|
|
47
|
+
* }
|
|
48
|
+
* }),
|
|
49
|
+
* effects: [
|
|
50
|
+
* createEffect((action$, _, __, { eventBus }) => {
|
|
51
|
+
* // Публикация события
|
|
52
|
+
* eventBus.dispatch.publish({
|
|
53
|
+
* event: 'USER_UPDATED',
|
|
54
|
+
* data: { userId: 123 }
|
|
55
|
+
* })
|
|
56
|
+
*
|
|
57
|
+
* // Подписка на события
|
|
58
|
+
* eventBus.dispatch.subscribe({
|
|
59
|
+
* eventPattern: 'CORE_*',
|
|
60
|
+
* handler: (data, event) => console.log('Received:', event.event, data)
|
|
61
|
+
* })
|
|
62
|
+
* })
|
|
63
|
+
* ]
|
|
64
|
+
* })
|
|
65
|
+
* ```
|
|
87
66
|
*/
|
|
88
|
-
declare
|
|
89
|
-
|
|
90
|
-
|
|
67
|
+
declare const createEventBus: (config?: EventBusConfig) => Promise<SynapseStoreWithDispatcher<EventBusState, IStorage<EventBusState>, any, Record<string, DispatchFunction<any, any>> & DispatchActions<{
|
|
68
|
+
publish: DispatchFunction<{
|
|
69
|
+
event: string;
|
|
70
|
+
data: any;
|
|
71
|
+
metadata?: Record<string, any>;
|
|
72
|
+
}, {
|
|
73
|
+
eventId: string;
|
|
74
|
+
event: string;
|
|
75
|
+
data: any;
|
|
76
|
+
}>;
|
|
77
|
+
subscribe: DispatchFunction<{
|
|
78
|
+
eventPattern: string;
|
|
79
|
+
handler: (data: any, event: EventBusEvent) => void | Promise<void>;
|
|
80
|
+
options?: Record<string, any>;
|
|
81
|
+
}, {
|
|
82
|
+
subscriptionId: string;
|
|
83
|
+
unsubscribe: VoidFunction;
|
|
84
|
+
}>;
|
|
85
|
+
getEventHistory: DispatchFunction<{
|
|
86
|
+
eventType: string;
|
|
87
|
+
limit?: number;
|
|
88
|
+
}, EventBusEvent[]>;
|
|
89
|
+
clearEvents: DispatchFunction<{
|
|
90
|
+
olderThan?: number;
|
|
91
|
+
} | undefined, void>;
|
|
92
|
+
getActiveSubscriptions: DispatchFunction<any, any[]>;
|
|
93
|
+
}>>>;
|
|
91
94
|
|
|
92
|
-
export { type
|
|
95
|
+
export { type EventBusConfig, type EventBusEvent, type EventBusState, SynapseStoreWithDispatcher, createEventBus };
|