@ngxs/storage-plugin 3.7.5 → 3.7.6-dev.master-95e4742
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/bundles/ngxs-storage-plugin.umd.js +177 -68
- package/bundles/ngxs-storage-plugin.umd.js.map +1 -1
- package/bundles/ngxs-storage-plugin.umd.min.js +1 -1
- package/bundles/ngxs-storage-plugin.umd.min.js.map +1 -1
- package/esm2015/index.js +2 -2
- package/esm2015/ngxs-storage-plugin.js +4 -3
- package/esm2015/src/engines.js +22 -0
- package/esm2015/src/internals/final-options.js +42 -0
- package/esm2015/src/internals/storage-key.js +47 -0
- package/esm2015/src/internals.js +13 -35
- package/esm2015/src/public_api.js +2 -1
- package/esm2015/src/storage.module.js +9 -3
- package/esm2015/src/storage.plugin.js +39 -32
- package/esm2015/src/symbols.js +9 -2
- package/esm5/index.js +2 -2
- package/esm5/ngxs-storage-plugin.js +4 -3
- package/esm5/src/engines.js +22 -0
- package/esm5/src/internals/final-options.js +43 -0
- package/esm5/src/internals/storage-key.js +47 -0
- package/esm5/src/internals.js +13 -35
- package/esm5/src/public_api.js +2 -1
- package/esm5/src/storage.module.js +9 -3
- package/esm5/src/storage.plugin.js +43 -35
- package/esm5/src/symbols.js +9 -2
- package/fesm2015/ngxs-storage-plugin.js +169 -65
- package/fesm2015/ngxs-storage-plugin.js.map +1 -1
- package/fesm5/ngxs-storage-plugin.js +173 -68
- package/fesm5/ngxs-storage-plugin.js.map +1 -1
- package/ngxs-storage-plugin.d.ts +2 -1
- package/ngxs-storage-plugin.metadata.json +1 -1
- package/package.json +4 -4
- package/src/engines.d.ts +4 -0
- package/src/internals/final-options.d.ts +10 -0
- package/src/internals/storage-key.d.ts +17 -0
- package/src/internals.d.ts +3 -9
- package/src/public_api.d.ts +1 -0
- package/src/storage.plugin.d.ts +3 -4
- package/src/symbols.d.ts +9 -3
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { InjectionToken, Injectable, Inject, PLATFORM_ID, NgModule } from '@angular/core';
|
|
1
|
+
import { InjectionToken, Injectable, Inject, PLATFORM_ID, Injector, NgModule } from '@angular/core';
|
|
2
2
|
import { StateToken, actionMatcher, InitState, UpdateState, getValue, setValue, NGXS_PLUGINS } from '@ngxs/store';
|
|
3
3
|
import { __assign, __values } from 'tslib';
|
|
4
4
|
import { isPlatformServer } from '@angular/common';
|
|
@@ -23,6 +23,13 @@ if (false) {
|
|
|
23
23
|
* @type {?|undefined}
|
|
24
24
|
*/
|
|
25
25
|
NgxsStoragePluginOptions.prototype.key;
|
|
26
|
+
/**
|
|
27
|
+
* The namespace is used to prefix the key for the state slice. This is
|
|
28
|
+
* necessary when running micro frontend applications which use storage plugin.
|
|
29
|
+
* The namespace will eliminate the conflict between keys that might overlap.
|
|
30
|
+
* @type {?|undefined}
|
|
31
|
+
*/
|
|
32
|
+
NgxsStoragePluginOptions.prototype.namespace;
|
|
26
33
|
/**
|
|
27
34
|
* Storage engine to use. Deaults to localStorage but can provide
|
|
28
35
|
*
|
|
@@ -63,7 +70,7 @@ if (false) {
|
|
|
63
70
|
NgxsStoragePluginOptions.prototype.afterDeserialize = function (obj, key) { };
|
|
64
71
|
}
|
|
65
72
|
/** @type {?} */
|
|
66
|
-
var NGXS_STORAGE_PLUGIN_OPTIONS = new InjectionToken('
|
|
73
|
+
var NGXS_STORAGE_PLUGIN_OPTIONS = new InjectionToken('NGXS_STORAGE_PLUGIN_OPTIONS');
|
|
67
74
|
/** @type {?} */
|
|
68
75
|
var STORAGE_ENGINE = new InjectionToken('STORAGE_ENGINE');
|
|
69
76
|
/**
|
|
@@ -100,47 +107,16 @@ if (false) {
|
|
|
100
107
|
* @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
|
|
101
108
|
*/
|
|
102
109
|
/**
|
|
103
|
-
*
|
|
104
|
-
*
|
|
110
|
+
* The following key is used to store the entire serialized
|
|
111
|
+
* state when there's no specific state provided.
|
|
105
112
|
* @type {?}
|
|
106
113
|
*/
|
|
107
114
|
var DEFAULT_STATE_KEY = '@@STATE';
|
|
108
|
-
/**
|
|
109
|
-
* This key is used to retrieve static metadatas on state classes.
|
|
110
|
-
* This constant is taken from the core codebase
|
|
111
|
-
* @type {?}
|
|
112
|
-
*/
|
|
113
|
-
var META_OPTIONS_KEY = 'NGXS_OPTIONS_META';
|
|
114
|
-
/**
|
|
115
|
-
* @param {?} key
|
|
116
|
-
* @return {?}
|
|
117
|
-
*/
|
|
118
|
-
function transformKeyOption(key) {
|
|
119
|
-
if (!Array.isArray(key)) {
|
|
120
|
-
key = [key];
|
|
121
|
-
}
|
|
122
|
-
return key.map((/**
|
|
123
|
-
* @param {?} token
|
|
124
|
-
* @return {?}
|
|
125
|
-
*/
|
|
126
|
-
function (token) {
|
|
127
|
-
// If it has the `NGXS_OPTIONS_META` key then it means the developer
|
|
128
|
-
// has provided state class like `key: [AuthState]`.
|
|
129
|
-
if (token.hasOwnProperty(META_OPTIONS_KEY)) {
|
|
130
|
-
// The `name` property will be an actual state name or a `StateToken`.
|
|
131
|
-
token = ((/** @type {?} */ (token)))[META_OPTIONS_KEY].name;
|
|
132
|
-
}
|
|
133
|
-
return token instanceof StateToken ? token.getName() : ((/** @type {?} */ (token)));
|
|
134
|
-
}));
|
|
135
|
-
}
|
|
136
115
|
/**
|
|
137
116
|
* @param {?} options
|
|
138
117
|
* @return {?}
|
|
139
118
|
*/
|
|
140
119
|
function storageOptionsFactory(options) {
|
|
141
|
-
if (options !== undefined && options.key) {
|
|
142
|
-
options.key = transformKeyOption(options.key);
|
|
143
|
-
}
|
|
144
120
|
return __assign({ key: [DEFAULT_STATE_KEY], storage: 0 /* LocalStorage */, serialize: JSON.stringify, deserialize: JSON.parse, beforeSerialize: (/**
|
|
145
121
|
* @param {?} obj
|
|
146
122
|
* @return {?}
|
|
@@ -168,21 +144,113 @@ function engineFactory(options, platformId) {
|
|
|
168
144
|
}
|
|
169
145
|
return null;
|
|
170
146
|
}
|
|
147
|
+
/**
|
|
148
|
+
* @param {?} key
|
|
149
|
+
* @param {?=} options
|
|
150
|
+
* @return {?}
|
|
151
|
+
*/
|
|
152
|
+
function getStorageKey(key, options) {
|
|
153
|
+
// Prepends the `namespace` option to any key if it's been provided by a user.
|
|
154
|
+
// So `@@STATE` becomes `my-app:@@STATE`.
|
|
155
|
+
return options && options.namespace ? options.namespace + ":" + key : key;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
/**
|
|
159
|
+
* @fileoverview added by tsickle
|
|
160
|
+
* @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
|
|
161
|
+
*/
|
|
162
|
+
/**
|
|
163
|
+
* This enables the user to provide a storage engine per individual key.
|
|
164
|
+
* @record
|
|
165
|
+
*/
|
|
166
|
+
function KeyWithExplicitEngine() { }
|
|
167
|
+
if (false) {
|
|
168
|
+
/** @type {?} */
|
|
169
|
+
KeyWithExplicitEngine.prototype.key;
|
|
170
|
+
/** @type {?} */
|
|
171
|
+
KeyWithExplicitEngine.prototype.engine;
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Determines whether the provided key has the following structure.
|
|
175
|
+
* @param {?} key
|
|
176
|
+
* @return {?}
|
|
177
|
+
*/
|
|
178
|
+
function isKeyWithExplicitEngine(key) {
|
|
179
|
+
return key != null && !!key.engine;
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* This symbol is used to store the metadata on state classes.
|
|
183
|
+
* @type {?}
|
|
184
|
+
*/
|
|
185
|
+
var META_OPTIONS_KEY = 'NGXS_OPTIONS_META';
|
|
186
|
+
/**
|
|
187
|
+
* @param {?} storageKey
|
|
188
|
+
* @return {?}
|
|
189
|
+
*/
|
|
190
|
+
function exctractStringKey(storageKey) {
|
|
191
|
+
// Extract the actual key out of the `{ key, engine }` structure.
|
|
192
|
+
if (isKeyWithExplicitEngine(storageKey)) {
|
|
193
|
+
storageKey = storageKey.key;
|
|
194
|
+
}
|
|
195
|
+
// Given the `storageKey` is a class, for instance, `AuthState`.
|
|
196
|
+
// We should retrieve its metadata and the `name` property.
|
|
197
|
+
// The `name` property might be a string (state name) or a state token.
|
|
198
|
+
if (storageKey.hasOwnProperty(META_OPTIONS_KEY)) {
|
|
199
|
+
storageKey = ((/** @type {?} */ (storageKey)))[META_OPTIONS_KEY].name;
|
|
200
|
+
}
|
|
201
|
+
return storageKey instanceof StateToken ? storageKey.getName() : (/** @type {?} */ (storageKey));
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* @fileoverview added by tsickle
|
|
206
|
+
* @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
|
|
207
|
+
*/
|
|
208
|
+
/**
|
|
209
|
+
* @record
|
|
210
|
+
*/
|
|
211
|
+
function FinalNgxsStoragePluginOptions() { }
|
|
212
|
+
if (false) {
|
|
213
|
+
/** @type {?} */
|
|
214
|
+
FinalNgxsStoragePluginOptions.prototype.keysWithEngines;
|
|
215
|
+
}
|
|
216
|
+
/** @type {?} */
|
|
217
|
+
var FINAL_NGXS_STORAGE_PLUGIN_OPTIONS = new InjectionToken('FINAL_NGXS_STORAGE_PLUGIN_OPTIONS');
|
|
218
|
+
/**
|
|
219
|
+
* @param {?} injector
|
|
220
|
+
* @param {?} options
|
|
221
|
+
* @return {?}
|
|
222
|
+
*/
|
|
223
|
+
function createFinalStoragePluginOptions(injector, options) {
|
|
224
|
+
/** @type {?} */
|
|
225
|
+
var storageKeys = Array.isArray(options.key) ? options.key : [(/** @type {?} */ (options.key))];
|
|
226
|
+
/** @type {?} */
|
|
227
|
+
var keysWithEngines = storageKeys.map((/**
|
|
228
|
+
* @param {?} storageKey
|
|
229
|
+
* @return {?}
|
|
230
|
+
*/
|
|
231
|
+
function (storageKey) {
|
|
232
|
+
/** @type {?} */
|
|
233
|
+
var key = exctractStringKey(storageKey);
|
|
234
|
+
/** @type {?} */
|
|
235
|
+
var engine = isKeyWithExplicitEngine(storageKey)
|
|
236
|
+
? injector.get(storageKey.engine)
|
|
237
|
+
: injector.get(STORAGE_ENGINE);
|
|
238
|
+
return { key: key, engine: engine };
|
|
239
|
+
}));
|
|
240
|
+
return __assign({}, options, { keysWithEngines: keysWithEngines });
|
|
241
|
+
}
|
|
171
242
|
|
|
172
243
|
/**
|
|
173
244
|
* @fileoverview added by tsickle
|
|
174
245
|
* @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
|
|
175
246
|
*/
|
|
176
247
|
var NgxsStoragePlugin = /** @class */ (function () {
|
|
177
|
-
function NgxsStoragePlugin(_options,
|
|
248
|
+
function NgxsStoragePlugin(_options, _platformId) {
|
|
178
249
|
this._options = _options;
|
|
179
|
-
this._engine = _engine;
|
|
180
250
|
this._platformId = _platformId;
|
|
181
|
-
|
|
182
|
-
// transformed by the `storageOptionsFactory` function that provided token.
|
|
183
|
-
this._keys = (/** @type {?} */ (this._options.key));
|
|
251
|
+
this._keysWithEngines = this._options.keysWithEngines;
|
|
184
252
|
// We default to `[DEFAULT_STATE_KEY]` if the user explicitly does not provide the `key` option.
|
|
185
|
-
this._usesDefaultStateKey = this.
|
|
253
|
+
this._usesDefaultStateKey = this._keysWithEngines.length === 1 && this._keysWithEngines[0].key === DEFAULT_STATE_KEY;
|
|
186
254
|
}
|
|
187
255
|
/**
|
|
188
256
|
* @param {?} state
|
|
@@ -199,7 +267,7 @@ var NgxsStoragePlugin = /** @class */ (function () {
|
|
|
199
267
|
function (state, event, next) {
|
|
200
268
|
var _this = this;
|
|
201
269
|
var e_1, _a;
|
|
202
|
-
if (isPlatformServer(this._platformId)
|
|
270
|
+
if (isPlatformServer(this._platformId)) {
|
|
203
271
|
return next(state, event);
|
|
204
272
|
}
|
|
205
273
|
/** @type {?} */
|
|
@@ -215,16 +283,29 @@ var NgxsStoragePlugin = /** @class */ (function () {
|
|
|
215
283
|
if (isInitOrUpdateAction) {
|
|
216
284
|
/** @type {?} */
|
|
217
285
|
var addedStates = isUpdateAction && event.addedStates;
|
|
218
|
-
var _loop_1 = function (key) {
|
|
286
|
+
var _loop_1 = function (key, engine) {
|
|
219
287
|
// We're checking what states have been added by NGXS and if any of these states should be handled by
|
|
220
288
|
// the storage plugin. For instance, we only want to deserialize the `auth` state, NGXS has added
|
|
221
289
|
// the `user` state, the storage plugin will be rerun and will do redundant deserialization.
|
|
222
290
|
// `usesDefaultStateKey` is necessary to check since `event.addedStates` never contains `@@STATE`.
|
|
223
|
-
if (!this_1._usesDefaultStateKey && addedStates
|
|
224
|
-
|
|
291
|
+
if (!this_1._usesDefaultStateKey && addedStates) {
|
|
292
|
+
// We support providing keys that can be deeply nested via dot notation, for instance,
|
|
293
|
+
// `keys: ['myState.myProperty']` is a valid key.
|
|
294
|
+
// The state name should always go first. The below code checks if the `key` includes dot
|
|
295
|
+
// notation and extracts the state name out of the key.
|
|
296
|
+
// Given the `key` is `myState.myProperty`, the `addedStates` will only contain `myState`.
|
|
297
|
+
/** @type {?} */
|
|
298
|
+
var dotNotationIndex = key.indexOf(DOT);
|
|
299
|
+
/** @type {?} */
|
|
300
|
+
var stateName = dotNotationIndex > -1 ? key.slice(0, dotNotationIndex) : key;
|
|
301
|
+
if (!addedStates.hasOwnProperty(stateName)) {
|
|
302
|
+
return "continue";
|
|
303
|
+
}
|
|
225
304
|
}
|
|
226
305
|
/** @type {?} */
|
|
227
|
-
var
|
|
306
|
+
var storageKey = getStorageKey(key, this_1._options);
|
|
307
|
+
/** @type {?} */
|
|
308
|
+
var storedValue = engine.getItem(storageKey);
|
|
228
309
|
if (storedValue !== 'undefined' && storedValue != null) {
|
|
229
310
|
try {
|
|
230
311
|
/** @type {?} */
|
|
@@ -235,7 +316,7 @@ var NgxsStoragePlugin = /** @class */ (function () {
|
|
|
235
316
|
// Caretaker note: we have still left the `typeof` condition in order to avoid
|
|
236
317
|
// creating a breaking change for projects that still use the View Engine.
|
|
237
318
|
if (typeof ngDevMode === 'undefined' || ngDevMode) {
|
|
238
|
-
console.error("Error ocurred while deserializing the " +
|
|
319
|
+
console.error("Error ocurred while deserializing the " + storageKey + " store value, falling back to empty object, the value obtained from the store: ", storedValue);
|
|
239
320
|
}
|
|
240
321
|
storedValue = {};
|
|
241
322
|
}
|
|
@@ -256,7 +337,7 @@ var NgxsStoragePlugin = /** @class */ (function () {
|
|
|
256
337
|
}));
|
|
257
338
|
}
|
|
258
339
|
if (!this_1._usesDefaultStateKey) {
|
|
259
|
-
state = setValue(state,
|
|
340
|
+
state = setValue(state, key, storedValue);
|
|
260
341
|
}
|
|
261
342
|
else {
|
|
262
343
|
// The `UpdateState` action is dispatched whenever the feature state is added.
|
|
@@ -294,9 +375,9 @@ var NgxsStoragePlugin = /** @class */ (function () {
|
|
|
294
375
|
};
|
|
295
376
|
var this_1 = this;
|
|
296
377
|
try {
|
|
297
|
-
for (var _b = __values(this.
|
|
298
|
-
var
|
|
299
|
-
_loop_1(key);
|
|
378
|
+
for (var _b = __values(this._keysWithEngines), _c = _b.next(); !_c.done; _c = _b.next()) {
|
|
379
|
+
var _d = _c.value, key = _d.key, engine = _d.engine;
|
|
380
|
+
_loop_1(key, engine);
|
|
300
381
|
}
|
|
301
382
|
}
|
|
302
383
|
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
@@ -315,17 +396,19 @@ var NgxsStoragePlugin = /** @class */ (function () {
|
|
|
315
396
|
var e_2, _a;
|
|
316
397
|
if (!isInitOrUpdateAction || (isInitOrUpdateAction && hasMigration)) {
|
|
317
398
|
try {
|
|
318
|
-
for (var _b = __values(_this.
|
|
319
|
-
var
|
|
399
|
+
for (var _b = __values(_this._keysWithEngines), _c = _b.next(); !_c.done; _c = _b.next()) {
|
|
400
|
+
var _d = _c.value, key = _d.key, engine = _d.engine;
|
|
401
|
+
/** @type {?} */
|
|
402
|
+
var storedValue = nextState;
|
|
320
403
|
/** @type {?} */
|
|
321
|
-
var
|
|
404
|
+
var storageKey = getStorageKey(key, _this._options);
|
|
322
405
|
if (key !== DEFAULT_STATE_KEY) {
|
|
323
|
-
|
|
406
|
+
storedValue = getValue(nextState, key);
|
|
324
407
|
}
|
|
325
408
|
try {
|
|
326
409
|
/** @type {?} */
|
|
327
|
-
var
|
|
328
|
-
|
|
410
|
+
var newStoredValue = (/** @type {?} */ (_this._options.beforeSerialize))(storedValue, key);
|
|
411
|
+
engine.setItem(storageKey, (/** @type {?} */ (_this._options.serialize))(newStoredValue));
|
|
329
412
|
}
|
|
330
413
|
catch (error) {
|
|
331
414
|
// Caretaker note: we have still left the `typeof` condition in order to avoid
|
|
@@ -334,10 +417,10 @@ var NgxsStoragePlugin = /** @class */ (function () {
|
|
|
334
417
|
if (error &&
|
|
335
418
|
(error.name === 'QuotaExceededError' ||
|
|
336
419
|
error.name === 'NS_ERROR_DOM_QUOTA_REACHED')) {
|
|
337
|
-
console.error("The " +
|
|
420
|
+
console.error("The " + storageKey + " store value exceeds the browser storage quota: ", storedValue);
|
|
338
421
|
}
|
|
339
422
|
else {
|
|
340
|
-
console.error("Error ocurred while serializing the " +
|
|
423
|
+
console.error("Error ocurred while serializing the " + storageKey + " store value, value not updated, the value obtained from the store: ", storedValue);
|
|
341
424
|
}
|
|
342
425
|
}
|
|
343
426
|
}
|
|
@@ -358,8 +441,7 @@ var NgxsStoragePlugin = /** @class */ (function () {
|
|
|
358
441
|
];
|
|
359
442
|
/** @nocollapse */
|
|
360
443
|
NgxsStoragePlugin.ctorParameters = function () { return [
|
|
361
|
-
{ type: undefined, decorators: [{ type: Inject, args: [
|
|
362
|
-
{ type: undefined, decorators: [{ type: Inject, args: [STORAGE_ENGINE,] }] },
|
|
444
|
+
{ type: undefined, decorators: [{ type: Inject, args: [FINAL_NGXS_STORAGE_PLUGIN_OPTIONS,] }] },
|
|
363
445
|
{ type: String, decorators: [{ type: Inject, args: [PLATFORM_ID,] }] }
|
|
364
446
|
]; };
|
|
365
447
|
return NgxsStoragePlugin;
|
|
@@ -369,7 +451,7 @@ if (false) {
|
|
|
369
451
|
* @type {?}
|
|
370
452
|
* @private
|
|
371
453
|
*/
|
|
372
|
-
NgxsStoragePlugin.prototype.
|
|
454
|
+
NgxsStoragePlugin.prototype._keysWithEngines;
|
|
373
455
|
/**
|
|
374
456
|
* @type {?}
|
|
375
457
|
* @private
|
|
@@ -380,17 +462,14 @@ if (false) {
|
|
|
380
462
|
* @private
|
|
381
463
|
*/
|
|
382
464
|
NgxsStoragePlugin.prototype._options;
|
|
383
|
-
/**
|
|
384
|
-
* @type {?}
|
|
385
|
-
* @private
|
|
386
|
-
*/
|
|
387
|
-
NgxsStoragePlugin.prototype._engine;
|
|
388
465
|
/**
|
|
389
466
|
* @type {?}
|
|
390
467
|
* @private
|
|
391
468
|
*/
|
|
392
469
|
NgxsStoragePlugin.prototype._platformId;
|
|
393
470
|
}
|
|
471
|
+
/** @type {?} */
|
|
472
|
+
var DOT = '.';
|
|
394
473
|
|
|
395
474
|
/**
|
|
396
475
|
* @fileoverview added by tsickle
|
|
@@ -431,6 +510,11 @@ var NgxsStoragePluginModule = /** @class */ (function () {
|
|
|
431
510
|
provide: STORAGE_ENGINE,
|
|
432
511
|
useFactory: engineFactory,
|
|
433
512
|
deps: [NGXS_STORAGE_PLUGIN_OPTIONS, PLATFORM_ID]
|
|
513
|
+
},
|
|
514
|
+
{
|
|
515
|
+
provide: FINAL_NGXS_STORAGE_PLUGIN_OPTIONS,
|
|
516
|
+
useFactory: createFinalStoragePluginOptions,
|
|
517
|
+
deps: [Injector, NGXS_STORAGE_PLUGIN_OPTIONS]
|
|
434
518
|
}
|
|
435
519
|
]
|
|
436
520
|
};
|
|
@@ -441,6 +525,27 @@ var NgxsStoragePluginModule = /** @class */ (function () {
|
|
|
441
525
|
return NgxsStoragePluginModule;
|
|
442
526
|
}());
|
|
443
527
|
|
|
528
|
+
/**
|
|
529
|
+
* @fileoverview added by tsickle
|
|
530
|
+
* @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
|
|
531
|
+
*/
|
|
532
|
+
/** @type {?} */
|
|
533
|
+
var LOCAL_STORAGE_ENGINE = new InjectionToken('LOCAL_STORAGE_ENGINE', {
|
|
534
|
+
providedIn: 'root',
|
|
535
|
+
factory: (/**
|
|
536
|
+
* @return {?}
|
|
537
|
+
*/
|
|
538
|
+
function () { return localStorage; })
|
|
539
|
+
});
|
|
540
|
+
/** @type {?} */
|
|
541
|
+
var SESSION_STORAGE_ENGINE = new InjectionToken('SESSION_STORAGE_ENGINE', {
|
|
542
|
+
providedIn: 'root',
|
|
543
|
+
factory: (/**
|
|
544
|
+
* @return {?}
|
|
545
|
+
*/
|
|
546
|
+
function () { return sessionStorage; })
|
|
547
|
+
});
|
|
548
|
+
|
|
444
549
|
/**
|
|
445
550
|
* @fileoverview added by tsickle
|
|
446
551
|
* @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
|
|
@@ -456,5 +561,5 @@ var NgxsStoragePluginModule = /** @class */ (function () {
|
|
|
456
561
|
* @suppress {checkTypes,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
|
|
457
562
|
*/
|
|
458
563
|
|
|
459
|
-
export { NGXS_STORAGE_PLUGIN_OPTIONS, NgxsStoragePlugin, NgxsStoragePluginModule, STORAGE_ENGINE, USER_OPTIONS as ɵa, storageOptionsFactory as
|
|
564
|
+
export { LOCAL_STORAGE_ENGINE, NGXS_STORAGE_PLUGIN_OPTIONS, NgxsStoragePlugin, NgxsStoragePluginModule, SESSION_STORAGE_ENGINE, STORAGE_ENGINE, USER_OPTIONS as ɵa, FINAL_NGXS_STORAGE_PLUGIN_OPTIONS as ɵc, createFinalStoragePluginOptions as ɵd, storageOptionsFactory as ɵe, engineFactory as ɵf };
|
|
460
565
|
//# sourceMappingURL=ngxs-storage-plugin.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ngxs-storage-plugin.js","sources":["ng://@ngxs/storage-plugin/src/symbols.ts","ng://@ngxs/storage-plugin/src/internals.ts","ng://@ngxs/storage-plugin/src/storage.plugin.ts","ng://@ngxs/storage-plugin/src/storage.module.ts"],"sourcesContent":["import { InjectionToken } from '@angular/core';\n\nimport { StorageKey } from './internals';\n\nexport const enum StorageOption {\n LocalStorage,\n SessionStorage\n}\n\nexport interface NgxsStoragePluginOptions {\n /**\n * Key for the state slice to store in the storage engine.\n */\n key?: undefined | StorageKey;\n\n /**\n * Storage engine to use. Deaults to localStorage but can provide\n *\n * sessionStorage or custom implementation of the StorageEngine interface\n */\n storage?: StorageOption;\n\n /**\n * Migration strategies.\n */\n migrations?: {\n /**\n * Version to key off.\n */\n version: number | string;\n\n /**\n * Method to migrate the previous state.\n */\n migrate: (state: any) => any;\n\n /**\n * Key to migrate.\n */\n key?: string;\n\n /**\n * Key for the version. Defaults to 'version'.\n */\n versionKey?: string;\n }[];\n\n /**\n * Serailizer for the object before its pushed into the engine.\n */\n serialize?(obj: any): string;\n\n /**\n * Deserializer for the object before its pulled out of the engine.\n */\n deserialize?(obj: any): any;\n\n /**\n * Method to alter object before serialization.\n */\n beforeSerialize?(obj: any, key: string): any;\n\n /**\n * Method to alter object after deserialization.\n */\n afterDeserialize?(obj: any, key: string): any;\n}\n\nexport const NGXS_STORAGE_PLUGIN_OPTIONS = new InjectionToken('NGXS_STORAGE_PLUGIN_OPTION');\n\nexport const STORAGE_ENGINE = new InjectionToken('STORAGE_ENGINE');\n\nexport interface StorageEngine {\n readonly length: number;\n getItem(key: string): any;\n setItem(key: string, val: any): void;\n removeItem(key: string): void;\n clear(): void;\n}\n","import { isPlatformServer } from '@angular/common';\nimport { StateClass } from '@ngxs/store/internals';\nimport { StateToken } from '@ngxs/store';\n\nimport { StorageOption, StorageEngine, NgxsStoragePluginOptions } from './symbols';\n\n/**\n * If the `key` option is not provided then the below constant\n * will be used as a default key\n */\nexport const DEFAULT_STATE_KEY = '@@STATE';\n\n/**\n * Internal type definition for the `key` option provided\n * in the `forRoot` method when importing module\n */\nexport type StorageKey =\n | string\n | StateClass\n | StateToken<any>\n | (string | StateClass | StateToken<any>)[];\n\n/**\n * This key is used to retrieve static metadatas on state classes.\n * This constant is taken from the core codebase\n */\nconst META_OPTIONS_KEY = 'NGXS_OPTIONS_META';\n\nfunction transformKeyOption(key: StorageKey): string[] {\n if (!Array.isArray(key)) {\n key = [key];\n }\n\n return key.map((token: string | StateClass | StateToken<any>) => {\n // If it has the `NGXS_OPTIONS_META` key then it means the developer\n // has provided state class like `key: [AuthState]`.\n if (token.hasOwnProperty(META_OPTIONS_KEY)) {\n // The `name` property will be an actual state name or a `StateToken`.\n token = (token as any)[META_OPTIONS_KEY].name;\n }\n\n return token instanceof StateToken ? token.getName() : (token as string);\n });\n}\n\nexport function storageOptionsFactory(\n options: NgxsStoragePluginOptions | undefined\n): NgxsStoragePluginOptions {\n if (options !== undefined && options.key) {\n options.key = transformKeyOption(options.key);\n }\n\n return {\n key: [DEFAULT_STATE_KEY],\n storage: StorageOption.LocalStorage,\n serialize: JSON.stringify,\n deserialize: JSON.parse,\n beforeSerialize: obj => obj,\n afterDeserialize: obj => obj,\n ...options\n };\n}\n\nexport function engineFactory(\n options: NgxsStoragePluginOptions,\n platformId: string\n): StorageEngine | null {\n if (isPlatformServer(platformId)) {\n return null;\n }\n\n if (options.storage === StorageOption.LocalStorage) {\n return localStorage;\n } else if (options.storage === StorageOption.SessionStorage) {\n return sessionStorage;\n }\n\n return null;\n}\n","import { PLATFORM_ID, Inject, Injectable } from '@angular/core';\nimport { isPlatformServer } from '@angular/common';\nimport { PlainObject } from '@ngxs/store/internals';\nimport {\n NgxsPlugin,\n setValue,\n getValue,\n InitState,\n UpdateState,\n actionMatcher,\n NgxsNextPluginFn\n} from '@ngxs/store';\nimport { tap } from 'rxjs/operators';\n\nimport {\n StorageEngine,\n NgxsStoragePluginOptions,\n STORAGE_ENGINE,\n NGXS_STORAGE_PLUGIN_OPTIONS\n} from './symbols';\nimport { DEFAULT_STATE_KEY } from './internals';\n\n/**\n * @description Will be provided through Terser global definitions by Angular CLI\n * during the production build. This is how Angular does tree-shaking internally.\n */\ndeclare const ngDevMode: boolean;\n\n@Injectable()\nexport class NgxsStoragePlugin implements NgxsPlugin {\n // We cast to `string[]` here as we're sure that this option has been\n // transformed by the `storageOptionsFactory` function that provided token.\n private _keys = this._options.key as string[];\n // We default to `[DEFAULT_STATE_KEY]` if the user explicitly does not provide the `key` option.\n private _usesDefaultStateKey =\n this._keys.length === 1 && this._keys[0] === DEFAULT_STATE_KEY;\n\n constructor(\n @Inject(NGXS_STORAGE_PLUGIN_OPTIONS) private _options: NgxsStoragePluginOptions,\n @Inject(STORAGE_ENGINE) private _engine: StorageEngine,\n @Inject(PLATFORM_ID) private _platformId: string\n ) {}\n\n handle(state: any, event: any, next: NgxsNextPluginFn) {\n if (isPlatformServer(this._platformId) && this._engine === null) {\n return next(state, event);\n }\n\n const matches = actionMatcher(event);\n const isInitAction = matches(InitState);\n const isUpdateAction = matches(UpdateState);\n const isInitOrUpdateAction = isInitAction || isUpdateAction;\n let hasMigration = false;\n\n if (isInitOrUpdateAction) {\n const addedStates = isUpdateAction && event.addedStates;\n\n for (const key of this._keys) {\n // We're checking what states have been added by NGXS and if any of these states should be handled by\n // the storage plugin. For instance, we only want to deserialize the `auth` state, NGXS has added\n // the `user` state, the storage plugin will be rerun and will do redundant deserialization.\n // `usesDefaultStateKey` is necessary to check since `event.addedStates` never contains `@@STATE`.\n if (!this._usesDefaultStateKey && addedStates && !addedStates.hasOwnProperty(key)) {\n continue;\n }\n\n let storedValue: any = this._engine.getItem(key!);\n\n if (storedValue !== 'undefined' && storedValue != null) {\n try {\n const newVal = this._options.deserialize!(storedValue);\n storedValue = this._options.afterDeserialize!(newVal, key);\n } catch {\n // Caretaker note: we have still left the `typeof` condition in order to avoid\n // creating a breaking change for projects that still use the View Engine.\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n console.error(\n `Error ocurred while deserializing the ${key} store value, falling back to empty object, the value obtained from the store: `,\n storedValue\n );\n }\n storedValue = {};\n }\n\n if (this._options.migrations) {\n this._options.migrations.forEach(strategy => {\n const versionMatch =\n strategy.version === getValue(storedValue, strategy.versionKey || 'version');\n const keyMatch =\n (!strategy.key && this._usesDefaultStateKey) || strategy.key === key;\n if (versionMatch && keyMatch) {\n storedValue = strategy.migrate(storedValue);\n hasMigration = true;\n }\n });\n }\n\n if (!this._usesDefaultStateKey) {\n state = setValue(state, key!, storedValue);\n } else {\n // The `UpdateState` action is dispatched whenever the feature state is added.\n // The below condition is met only when the `UpdateState` is dispatched.\n // Let's assume that we have 2 states `counter` and `@ngxs/router-plugin` state.\n // `CounterState` is provided on the root level when calling `NgxsModule.forRoot()`\n // and `@ngxs/router-plugin` is provided as a feature state.\n // The storage plugin may save the `counter` state value as `10` before.\n // The `CounterState` may implement the `ngxsOnInit` hook and call `ctx.setState(999)`.\n // The storage plugin will re-hydrate the whole state when the `RouterState` is registered,\n // and the `counter` state will again equal `10` (not `999`).\n if (storedValue && addedStates && Object.keys(addedStates).length > 0) {\n storedValue = Object.keys(addedStates).reduce((accumulator, addedState) => {\n // The `storedValue` may equal the whole state (when the default state key is used).\n // If `addedStates` contains only `router` then we want to merge the state only\n // with the `router` value.\n // Let's assume that the `storedValue` is an object:\n // `{ counter: 10, router: {...} }`\n // This will pick only the `router` object from the `storedValue` and `counter`\n // state will not be re-hydrated unnecessary.\n if (storedValue.hasOwnProperty(addedState)) {\n accumulator[addedState] = storedValue[addedState];\n }\n return accumulator;\n }, <PlainObject>{});\n }\n\n state = { ...state, ...storedValue };\n }\n }\n }\n }\n\n return next(state, event).pipe(\n tap(nextState => {\n if (!isInitOrUpdateAction || (isInitOrUpdateAction && hasMigration)) {\n for (const key of this._keys) {\n let val = nextState;\n\n if (key !== DEFAULT_STATE_KEY) {\n val = getValue(nextState, key!);\n }\n\n try {\n const newVal = this._options.beforeSerialize!(val, key);\n this._engine.setItem(key!, this._options.serialize!(newVal));\n } catch (error) {\n // Caretaker note: we have still left the `typeof` condition in order to avoid\n // creating a breaking change for projects that still use the View Engine.\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n if (\n error &&\n (error.name === 'QuotaExceededError' ||\n error.name === 'NS_ERROR_DOM_QUOTA_REACHED')\n ) {\n console.error(\n `The ${key} store value exceeds the browser storage quota: `,\n val\n );\n } else {\n console.error(\n `Error ocurred while serializing the ${key} store value, value not updated, the value obtained from the store: `,\n val\n );\n }\n }\n }\n }\n }\n })\n );\n }\n}\n","import { NgModule, ModuleWithProviders, PLATFORM_ID, InjectionToken } from '@angular/core';\nimport { NGXS_PLUGINS } from '@ngxs/store';\n\nimport {\n NgxsStoragePluginOptions,\n STORAGE_ENGINE,\n NGXS_STORAGE_PLUGIN_OPTIONS\n} from './symbols';\nimport { NgxsStoragePlugin } from './storage.plugin';\nimport { storageOptionsFactory, engineFactory } from './internals';\n\nexport const USER_OPTIONS = new InjectionToken('USER_OPTIONS');\n\n@NgModule()\nexport class NgxsStoragePluginModule {\n static forRoot(\n options?: NgxsStoragePluginOptions\n ): ModuleWithProviders<NgxsStoragePluginModule> {\n return {\n ngModule: NgxsStoragePluginModule,\n providers: [\n {\n provide: NGXS_PLUGINS,\n useClass: NgxsStoragePlugin,\n multi: true\n },\n {\n provide: USER_OPTIONS,\n useValue: options\n },\n {\n provide: NGXS_STORAGE_PLUGIN_OPTIONS,\n useFactory: storageOptionsFactory,\n deps: [USER_OPTIONS]\n },\n {\n provide: STORAGE_ENGINE,\n useFactory: engineFactory,\n deps: [NGXS_STORAGE_PLUGIN_OPTIONS, PLATFORM_ID]\n }\n ]\n };\n }\n}\n"],"names":["tslib_1.__values"],"mappings":";;;;;;;;;;AAAA;;IAKE,eAAY;IACZ,iBAAc;;;;;AAGhB,uCAyDC;;;;;;IArDC,uCAA6B;;;;;;;IAO7B,2CAAwB;;;;;IAKxB,8CAoBI;;;;;;IAKJ,kEAA6B;;;;;;IAK7B,oEAA4B;;;;;;;IAK5B,6EAA6C;;;;;;;IAK7C,8EAA8C;;;AAGhD,IAAa,2BAA2B,GAAG,IAAI,cAAc,CAAC,4BAA4B,CAAC;;AAE3F,IAAa,cAAc,GAAG,IAAI,cAAc,CAAC,gBAAgB,CAAC;;;;AAElE,4BAMC;;;IALC,+BAAwB;;;;;IACxB,qDAA0B;;;;;;IAC1B,0DAAqC;;;;;IACrC,wDAA8B;;;;IAC9B,gDAAc;;;;;;;;;;;;ACnEhB,IAAa,iBAAiB,GAAG,SAAS;;;;;;IAgBpC,gBAAgB,GAAG,mBAAmB;;;;;AAE5C,SAAS,kBAAkB,CAAC,GAAe;IACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACvB,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;KACb;IAED,OAAO,GAAG,CAAC,GAAG;;;;IAAC,UAAC,KAA4C;;;QAG1D,IAAI,KAAK,CAAC,cAAc,CAAC,gBAAgB,CAAC,EAAE;;YAE1C,KAAK,GAAG,oBAAC,KAAK,IAAS,gBAAgB,CAAC,CAAC,IAAI,CAAC;SAC/C;QAED,OAAO,KAAK,YAAY,UAAU,GAAG,KAAK,CAAC,OAAO,EAAE,uBAAI,KAAK,GAAW,CAAC;KAC1E,EAAC,CAAC;CACJ;;;;;AAED,SAAgB,qBAAqB,CACnC,OAA6C;IAE7C,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,EAAE;QACxC,OAAO,CAAC,GAAG,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;KAC/C;IAED,kBACE,GAAG,EAAE,CAAC,iBAAiB,CAAC,EACxB,OAAO,wBACP,SAAS,EAAE,IAAI,CAAC,SAAS,EACzB,WAAW,EAAE,IAAI,CAAC,KAAK,EACvB,eAAe;;;;QAAE,UAAA,GAAG,IAAI,OAAA,GAAG,GAAA,GAC3B,gBAAgB;;;;QAAE,UAAA,GAAG,IAAI,OAAA,GAAG,GAAA,KACzB,OAAO,EACV;CACH;;;;;;AAED,SAAgB,aAAa,CAC3B,OAAiC,EACjC,UAAkB;IAElB,IAAI,gBAAgB,CAAC,UAAU,CAAC,EAAE;QAChC,OAAO,IAAI,CAAC;KACb;IAED,IAAI,OAAO,CAAC,OAAO,2BAAiC;QAClD,OAAO,YAAY,CAAC;KACrB;SAAM,IAAI,OAAO,CAAC,OAAO,6BAAmC;QAC3D,OAAO,cAAc,CAAC;KACvB;IAED,OAAO,IAAI,CAAC;CACb;;;;;;;ICzCC,2BAC+C,QAAkC,EAC/C,OAAsB,EACzB,WAAmB;QAFH,aAAQ,GAAR,QAAQ,CAA0B;QAC/C,YAAO,GAAP,OAAO,CAAe;QACzB,gBAAW,GAAX,WAAW,CAAQ;;;QAR1C,UAAK,sBAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAY,CAAC;;QAEtC,yBAAoB,GAC1B,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,iBAAiB,CAAC;KAM7D;;;;;;;IAEJ,kCAAM;;;;;;IAAN,UAAO,KAAU,EAAE,KAAU,EAAE,IAAsB;QAArD,iBA8HC;;QA7HC,IAAI,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE;YAC/D,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;SAC3B;;YAEK,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC;;YAC9B,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;;YACjC,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;;YACrC,oBAAoB,GAAG,YAAY,IAAI,cAAc;;YACvD,YAAY,GAAG,KAAK;QAExB,IAAI,oBAAoB,EAAE;;gBAClB,WAAW,GAAG,cAAc,IAAI,KAAK,CAAC,WAAW;oCAE5C,GAAG;;;;;gBAKZ,IAAI,CAAC,OAAK,oBAAoB,IAAI,WAAW,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;;iBAElF;;oBAEG,WAAW,GAAQ,OAAK,OAAO,CAAC,OAAO,oBAAC,GAAG,GAAE;gBAEjD,IAAI,WAAW,KAAK,WAAW,IAAI,WAAW,IAAI,IAAI,EAAE;oBACtD,IAAI;;4BACI,MAAM,GAAG,mBAAA,OAAK,QAAQ,CAAC,WAAW,GAAE,WAAW,CAAC;wBACtD,WAAW,GAAG,mBAAA,OAAK,QAAQ,CAAC,gBAAgB,GAAE,MAAM,EAAE,GAAG,CAAC,CAAC;qBAC5D;oBAAC,WAAM;;;wBAGN,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE;4BACjD,OAAO,CAAC,KAAK,CACX,2CAAyC,GAAG,oFAAiF,EAC7H,WAAW,CACZ,CAAC;yBACH;wBACD,WAAW,GAAG,EAAE,CAAC;qBAClB;oBAED,IAAI,OAAK,QAAQ,CAAC,UAAU,EAAE;wBAC5B,OAAK,QAAQ,CAAC,UAAU,CAAC,OAAO;;;;wBAAC,UAAA,QAAQ;;gCACjC,YAAY,GAChB,QAAQ,CAAC,OAAO,KAAK,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,UAAU,IAAI,SAAS,CAAC;;gCACxE,QAAQ,GACZ,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,KAAI,CAAC,oBAAoB,KAAK,QAAQ,CAAC,GAAG,KAAK,GAAG;4BACtE,IAAI,YAAY,IAAI,QAAQ,EAAE;gCAC5B,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gCAC5C,YAAY,GAAG,IAAI,CAAC;6BACrB;yBACF,EAAC,CAAC;qBACJ;oBAED,IAAI,CAAC,OAAK,oBAAoB,EAAE;wBAC9B,KAAK,GAAG,QAAQ,CAAC,KAAK,qBAAE,GAAG,IAAG,WAAW,CAAC,CAAC;qBAC5C;yBAAM;;;;;;;;;;wBAUL,IAAI,WAAW,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;4BACrE,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM;;;;;4BAAC,UAAC,WAAW,EAAE,UAAU;;;;;;;;gCAQpE,IAAI,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;oCAC1C,WAAW,CAAC,UAAU,CAAC,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;iCACnD;gCACD,OAAO,WAAW,CAAC;6BACpB,sBAAe,EAAE,GAAC,CAAC;yBACrB;wBAED,KAAK,gBAAQ,KAAK,EAAK,WAAW,CAAE,CAAC;qBACtC;iBACF;aACF;;;gBAvED,KAAkB,IAAA,KAAAA,SAAA,IAAI,CAAC,KAAK,CAAA,gBAAA;oBAAvB,IAAM,GAAG,WAAA;4BAAH,GAAG;iBAuEb;;;;;;;;;SACF;QAED,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,CAC5B,GAAG;;;;QAAC,UAAA,SAAS;;YACX,IAAI,CAAC,oBAAoB,KAAK,oBAAoB,IAAI,YAAY,CAAC,EAAE;;oBACnE,KAAkB,IAAA,KAAAA,SAAA,KAAI,CAAC,KAAK,CAAA,gBAAA,4BAAE;wBAAzB,IAAM,GAAG,WAAA;;4BACR,GAAG,GAAG,SAAS;wBAEnB,IAAI,GAAG,KAAK,iBAAiB,EAAE;4BAC7B,GAAG,GAAG,QAAQ,CAAC,SAAS,qBAAE,GAAG,GAAE,CAAC;yBACjC;wBAED,IAAI;;gCACI,MAAM,GAAG,mBAAA,KAAI,CAAC,QAAQ,CAAC,eAAe,GAAE,GAAG,EAAE,GAAG,CAAC;4BACvD,KAAI,CAAC,OAAO,CAAC,OAAO,oBAAC,GAAG,IAAG,mBAAA,KAAI,CAAC,QAAQ,CAAC,SAAS,GAAE,MAAM,CAAC,CAAC,CAAC;yBAC9D;wBAAC,OAAO,KAAK,EAAE;;;4BAGd,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE;gCACjD,IACE,KAAK;qCACJ,KAAK,CAAC,IAAI,KAAK,oBAAoB;wCAClC,KAAK,CAAC,IAAI,KAAK,4BAA4B,CAAC,EAC9C;oCACA,OAAO,CAAC,KAAK,CACX,SAAO,GAAG,qDAAkD,EAC5D,GAAG,CACJ,CAAC;iCACH;qCAAM;oCACL,OAAO,CAAC,KAAK,CACX,yCAAuC,GAAG,yEAAsE,EAChH,GAAG,CACJ,CAAC;iCACH;6BACF;yBACF;qBACF;;;;;;;;;aACF;SACF,EAAC,CACH,CAAC;KACH;;gBA7IF,UAAU;;;;gDAUN,MAAM,SAAC,2BAA2B;gDAClC,MAAM,SAAC,cAAc;6CACrB,MAAM,SAAC,WAAW;;IAkIvB,wBAAC;CA9ID,IA8IC;;;;;;IA1IC,kCAA8C;;;;;IAE9C,iDACiE;;;;;IAG/D,qCAA+E;;;;;IAC/E,oCAAsD;;;;;IACtD,wCAAgD;;;;;;;ACxCpD;AAWA,IAAa,YAAY,GAAG,IAAI,cAAc,CAAC,cAAc,CAAC;AAE9D;IAAA;KA8BC;;;;;IA5BQ,+BAAO;;;;IAAd,UACE,OAAkC;QAElC,OAAO;YACL,QAAQ,EAAE,uBAAuB;YACjC,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,YAAY;oBACrB,QAAQ,EAAE,iBAAiB;oBAC3B,KAAK,EAAE,IAAI;iBACZ;gBACD;oBACE,OAAO,EAAE,YAAY;oBACrB,QAAQ,EAAE,OAAO;iBAClB;gBACD;oBACE,OAAO,EAAE,2BAA2B;oBACpC,UAAU,EAAE,qBAAqB;oBACjC,IAAI,EAAE,CAAC,YAAY,CAAC;iBACrB;gBACD;oBACE,OAAO,EAAE,cAAc;oBACvB,UAAU,EAAE,aAAa;oBACzB,IAAI,EAAE,CAAC,2BAA2B,EAAE,WAAW,CAAC;iBACjD;aACF;SACF,CAAC;KACH;;gBA7BF,QAAQ;;IA8BT,8BAAC;CA9BD;;;;;;;;;;;;;;;;;;;"}
|
|
1
|
+
{"version":3,"file":"ngxs-storage-plugin.js","sources":["ng://@ngxs/storage-plugin/src/symbols.ts","ng://@ngxs/storage-plugin/src/internals.ts","ng://@ngxs/storage-plugin/src/internals/storage-key.ts","ng://@ngxs/storage-plugin/src/internals/final-options.ts","ng://@ngxs/storage-plugin/src/storage.plugin.ts","ng://@ngxs/storage-plugin/src/storage.module.ts","ng://@ngxs/storage-plugin/src/engines.ts"],"sourcesContent":["import { InjectionToken } from '@angular/core';\n\nimport { StorageKey } from './internals/storage-key';\n\nexport const enum StorageOption {\n LocalStorage,\n SessionStorage\n}\n\nexport interface NgxsStoragePluginOptions {\n /**\n * Key for the state slice to store in the storage engine.\n */\n key?: undefined | StorageKey | StorageKey[];\n\n /**\n * The namespace is used to prefix the key for the state slice. This is\n * necessary when running micro frontend applications which use storage plugin.\n * The namespace will eliminate the conflict between keys that might overlap.\n */\n namespace?: string;\n\n /**\n * Storage engine to use. Deaults to localStorage but can provide\n *\n * sessionStorage or custom implementation of the StorageEngine interface\n */\n storage?: StorageOption;\n\n /**\n * Migration strategies.\n */\n migrations?: {\n /**\n * Version to key off.\n */\n version: number | string;\n\n /**\n * Method to migrate the previous state.\n */\n migrate: (state: any) => any;\n\n /**\n * Key to migrate.\n */\n key?: string;\n\n /**\n * Key for the version. Defaults to 'version'.\n */\n versionKey?: string;\n }[];\n\n /**\n * Serailizer for the object before its pushed into the engine.\n */\n serialize?(obj: any): string;\n\n /**\n * Deserializer for the object before its pulled out of the engine.\n */\n deserialize?(obj: any): any;\n\n /**\n * Method to alter object before serialization.\n */\n beforeSerialize?(obj: any, key: string): any;\n\n /**\n * Method to alter object after deserialization.\n */\n afterDeserialize?(obj: any, key: string): any;\n}\n\nexport const NGXS_STORAGE_PLUGIN_OPTIONS = new InjectionToken('NGXS_STORAGE_PLUGIN_OPTIONS');\n\nexport const STORAGE_ENGINE = new InjectionToken<StorageEngine>('STORAGE_ENGINE');\n\nexport interface StorageEngine {\n readonly length: number;\n getItem(key: string): any;\n setItem(key: string, val: any): void;\n removeItem(key: string): void;\n clear(): void;\n}\n","import { isPlatformServer } from '@angular/common';\n\nimport { StorageOption, StorageEngine, NgxsStoragePluginOptions } from './symbols';\n\n/**\n * The following key is used to store the entire serialized\n * state when there's no specific state provided.\n */\nexport const DEFAULT_STATE_KEY = '@@STATE';\n\nexport function storageOptionsFactory(\n options: NgxsStoragePluginOptions | undefined\n): NgxsStoragePluginOptions {\n return {\n key: [DEFAULT_STATE_KEY],\n storage: StorageOption.LocalStorage,\n serialize: JSON.stringify,\n deserialize: JSON.parse,\n beforeSerialize: obj => obj,\n afterDeserialize: obj => obj,\n ...options\n };\n}\n\nexport function engineFactory(\n options: NgxsStoragePluginOptions,\n platformId: string\n): StorageEngine | null {\n if (isPlatformServer(platformId)) {\n return null;\n }\n\n if (options.storage === StorageOption.LocalStorage) {\n return localStorage;\n } else if (options.storage === StorageOption.SessionStorage) {\n return sessionStorage;\n }\n\n return null;\n}\n\nexport function getStorageKey(key: string, options?: NgxsStoragePluginOptions): string {\n // Prepends the `namespace` option to any key if it's been provided by a user.\n // So `@@STATE` becomes `my-app:@@STATE`.\n return options && options.namespace ? `${options.namespace}:${key}` : key;\n}\n","import { InjectionToken, Type } from '@angular/core';\nimport { StateToken } from '@ngxs/store';\nimport { StateClass } from '@ngxs/store/internals';\n\nimport { StorageEngine } from '../symbols';\n\n/** This enables the user to provide a storage engine per individual key. */\nexport interface KeyWithExplicitEngine {\n key: string | StateClass | StateToken<any>;\n engine: Type<StorageEngine> | InjectionToken<StorageEngine>;\n}\n\n/** Determines whether the provided key has the following structure. */\nexport function isKeyWithExplicitEngine(key: any): key is KeyWithExplicitEngine {\n return key != null && !!key.engine;\n}\n\n/**\n * This tuples all of the possible types allowed in the `key` property.\n * This is not exposed publicly and used internally only.\n */\nexport type StorageKey = string | StateClass | StateToken<any> | KeyWithExplicitEngine;\n\n/** This symbol is used to store the metadata on state classes. */\nconst META_OPTIONS_KEY = 'NGXS_OPTIONS_META';\nexport function exctractStringKey(storageKey: StorageKey): string {\n // Extract the actual key out of the `{ key, engine }` structure.\n if (isKeyWithExplicitEngine(storageKey)) {\n storageKey = storageKey.key;\n }\n\n // Given the `storageKey` is a class, for instance, `AuthState`.\n // We should retrieve its metadata and the `name` property.\n // The `name` property might be a string (state name) or a state token.\n if (storageKey.hasOwnProperty(META_OPTIONS_KEY)) {\n storageKey = (storageKey as any)[META_OPTIONS_KEY].name;\n }\n\n return storageKey instanceof StateToken ? storageKey.getName() : <string>storageKey;\n}\n","import { InjectionToken, Injector } from '@angular/core';\n\nimport { exctractStringKey, isKeyWithExplicitEngine, StorageKey } from './storage-key';\nimport { NgxsStoragePluginOptions, StorageEngine, STORAGE_ENGINE } from '../symbols';\n\nexport interface FinalNgxsStoragePluginOptions extends NgxsStoragePluginOptions {\n keysWithEngines: {\n key: string;\n engine: StorageEngine;\n }[];\n}\n\nexport const FINAL_NGXS_STORAGE_PLUGIN_OPTIONS = new InjectionToken<\n FinalNgxsStoragePluginOptions\n>('FINAL_NGXS_STORAGE_PLUGIN_OPTIONS');\n\nexport function createFinalStoragePluginOptions(\n injector: Injector,\n options: NgxsStoragePluginOptions\n): FinalNgxsStoragePluginOptions {\n const storageKeys: StorageKey[] = Array.isArray(options.key) ? options.key : [options.key!];\n\n const keysWithEngines = storageKeys.map((storageKey: StorageKey) => {\n const key = exctractStringKey(storageKey);\n const engine = isKeyWithExplicitEngine(storageKey)\n ? injector.get(storageKey.engine)\n : injector.get(STORAGE_ENGINE);\n return { key, engine };\n });\n\n return {\n ...options,\n keysWithEngines\n };\n}\n","import { PLATFORM_ID, Inject, Injectable } from '@angular/core';\nimport { isPlatformServer } from '@angular/common';\nimport { PlainObject } from '@ngxs/store/internals';\nimport {\n NgxsPlugin,\n setValue,\n getValue,\n InitState,\n UpdateState,\n actionMatcher,\n NgxsNextPluginFn\n} from '@ngxs/store';\nimport { tap } from 'rxjs/operators';\n\nimport { DEFAULT_STATE_KEY, getStorageKey } from './internals';\nimport {\n FinalNgxsStoragePluginOptions,\n FINAL_NGXS_STORAGE_PLUGIN_OPTIONS\n} from './internals/final-options';\n\n/**\n * @description Will be provided through Terser global definitions by Angular CLI\n * during the production build. This is how Angular does tree-shaking internally.\n */\ndeclare const ngDevMode: boolean;\n\n@Injectable()\nexport class NgxsStoragePlugin implements NgxsPlugin {\n private _keysWithEngines = this._options.keysWithEngines;\n // We default to `[DEFAULT_STATE_KEY]` if the user explicitly does not provide the `key` option.\n private _usesDefaultStateKey =\n this._keysWithEngines.length === 1 && this._keysWithEngines[0].key === DEFAULT_STATE_KEY;\n\n constructor(\n @Inject(FINAL_NGXS_STORAGE_PLUGIN_OPTIONS) private _options: FinalNgxsStoragePluginOptions,\n @Inject(PLATFORM_ID) private _platformId: string\n ) {}\n\n handle(state: any, event: any, next: NgxsNextPluginFn) {\n if (isPlatformServer(this._platformId)) {\n return next(state, event);\n }\n\n const matches = actionMatcher(event);\n const isInitAction = matches(InitState);\n const isUpdateAction = matches(UpdateState);\n const isInitOrUpdateAction = isInitAction || isUpdateAction;\n let hasMigration = false;\n\n if (isInitOrUpdateAction) {\n const addedStates = isUpdateAction && event.addedStates;\n\n for (const { key, engine } of this._keysWithEngines) {\n // We're checking what states have been added by NGXS and if any of these states should be handled by\n // the storage plugin. For instance, we only want to deserialize the `auth` state, NGXS has added\n // the `user` state, the storage plugin will be rerun and will do redundant deserialization.\n // `usesDefaultStateKey` is necessary to check since `event.addedStates` never contains `@@STATE`.\n if (!this._usesDefaultStateKey && addedStates) {\n // We support providing keys that can be deeply nested via dot notation, for instance,\n // `keys: ['myState.myProperty']` is a valid key.\n // The state name should always go first. The below code checks if the `key` includes dot\n // notation and extracts the state name out of the key.\n // Given the `key` is `myState.myProperty`, the `addedStates` will only contain `myState`.\n const dotNotationIndex = key.indexOf(DOT);\n const stateName = dotNotationIndex > -1 ? key.slice(0, dotNotationIndex) : key;\n if (!addedStates.hasOwnProperty(stateName)) {\n continue;\n }\n }\n\n const storageKey = getStorageKey(key, this._options);\n let storedValue: any = engine.getItem(storageKey);\n\n if (storedValue !== 'undefined' && storedValue != null) {\n try {\n const newVal = this._options.deserialize!(storedValue);\n storedValue = this._options.afterDeserialize!(newVal, key);\n } catch {\n // Caretaker note: we have still left the `typeof` condition in order to avoid\n // creating a breaking change for projects that still use the View Engine.\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n console.error(\n `Error ocurred while deserializing the ${storageKey} store value, falling back to empty object, the value obtained from the store: `,\n storedValue\n );\n }\n storedValue = {};\n }\n\n if (this._options.migrations) {\n this._options.migrations.forEach(strategy => {\n const versionMatch =\n strategy.version === getValue(storedValue, strategy.versionKey || 'version');\n const keyMatch =\n (!strategy.key && this._usesDefaultStateKey) || strategy.key === key;\n if (versionMatch && keyMatch) {\n storedValue = strategy.migrate(storedValue);\n hasMigration = true;\n }\n });\n }\n\n if (!this._usesDefaultStateKey) {\n state = setValue(state, key, storedValue);\n } else {\n // The `UpdateState` action is dispatched whenever the feature state is added.\n // The below condition is met only when the `UpdateState` is dispatched.\n // Let's assume that we have 2 states `counter` and `@ngxs/router-plugin` state.\n // `CounterState` is provided on the root level when calling `NgxsModule.forRoot()`\n // and `@ngxs/router-plugin` is provided as a feature state.\n // The storage plugin may save the `counter` state value as `10` before.\n // The `CounterState` may implement the `ngxsOnInit` hook and call `ctx.setState(999)`.\n // The storage plugin will re-hydrate the whole state when the `RouterState` is registered,\n // and the `counter` state will again equal `10` (not `999`).\n if (storedValue && addedStates && Object.keys(addedStates).length > 0) {\n storedValue = Object.keys(addedStates).reduce((accumulator, addedState) => {\n // The `storedValue` may equal the whole state (when the default state key is used).\n // If `addedStates` contains only `router` then we want to merge the state only\n // with the `router` value.\n // Let's assume that the `storedValue` is an object:\n // `{ counter: 10, router: {...} }`\n // This will pick only the `router` object from the `storedValue` and `counter`\n // state will not be re-hydrated unnecessary.\n if (storedValue.hasOwnProperty(addedState)) {\n accumulator[addedState] = storedValue[addedState];\n }\n return accumulator;\n }, <PlainObject>{});\n }\n\n state = { ...state, ...storedValue };\n }\n }\n }\n }\n\n return next(state, event).pipe(\n tap(nextState => {\n if (!isInitOrUpdateAction || (isInitOrUpdateAction && hasMigration)) {\n for (const { key, engine } of this._keysWithEngines) {\n let storedValue = nextState;\n\n const storageKey = getStorageKey(key, this._options);\n\n if (key !== DEFAULT_STATE_KEY) {\n storedValue = getValue(nextState, key);\n }\n\n try {\n const newStoredValue = this._options.beforeSerialize!(storedValue, key);\n engine.setItem(storageKey, this._options.serialize!(newStoredValue));\n } catch (error) {\n // Caretaker note: we have still left the `typeof` condition in order to avoid\n // creating a breaking change for projects that still use the View Engine.\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n if (\n error &&\n (error.name === 'QuotaExceededError' ||\n error.name === 'NS_ERROR_DOM_QUOTA_REACHED')\n ) {\n console.error(\n `The ${storageKey} store value exceeds the browser storage quota: `,\n storedValue\n );\n } else {\n console.error(\n `Error ocurred while serializing the ${storageKey} store value, value not updated, the value obtained from the store: `,\n storedValue\n );\n }\n }\n }\n }\n }\n })\n );\n }\n}\n\nconst DOT = '.';\n","import {\n NgModule,\n ModuleWithProviders,\n PLATFORM_ID,\n InjectionToken,\n Injector\n} from '@angular/core';\nimport { NGXS_PLUGINS } from '@ngxs/store';\n\nimport {\n NgxsStoragePluginOptions,\n STORAGE_ENGINE,\n NGXS_STORAGE_PLUGIN_OPTIONS\n} from './symbols';\nimport { NgxsStoragePlugin } from './storage.plugin';\nimport { engineFactory, storageOptionsFactory } from './internals';\nimport {\n createFinalStoragePluginOptions,\n FINAL_NGXS_STORAGE_PLUGIN_OPTIONS\n} from './internals/final-options';\n\nexport const USER_OPTIONS = new InjectionToken('USER_OPTIONS');\n\n@NgModule()\nexport class NgxsStoragePluginModule {\n static forRoot(\n options?: NgxsStoragePluginOptions\n ): ModuleWithProviders<NgxsStoragePluginModule> {\n return {\n ngModule: NgxsStoragePluginModule,\n providers: [\n {\n provide: NGXS_PLUGINS,\n useClass: NgxsStoragePlugin,\n multi: true\n },\n {\n provide: USER_OPTIONS,\n useValue: options\n },\n {\n provide: NGXS_STORAGE_PLUGIN_OPTIONS,\n useFactory: storageOptionsFactory,\n deps: [USER_OPTIONS]\n },\n {\n provide: STORAGE_ENGINE,\n useFactory: engineFactory,\n deps: [NGXS_STORAGE_PLUGIN_OPTIONS, PLATFORM_ID]\n },\n {\n provide: FINAL_NGXS_STORAGE_PLUGIN_OPTIONS,\n useFactory: createFinalStoragePluginOptions,\n deps: [Injector, NGXS_STORAGE_PLUGIN_OPTIONS]\n }\n ]\n };\n }\n}\n","import { InjectionToken } from '@angular/core';\n\nimport { StorageEngine } from './symbols';\n\nexport const LOCAL_STORAGE_ENGINE = new InjectionToken<StorageEngine>('LOCAL_STORAGE_ENGINE', {\n providedIn: 'root',\n factory: () => localStorage\n});\n\nexport const SESSION_STORAGE_ENGINE = new InjectionToken<StorageEngine>(\n 'SESSION_STORAGE_ENGINE',\n {\n providedIn: 'root',\n factory: () => sessionStorage\n }\n);\n"],"names":["tslib_1.__values"],"mappings":";;;;;;;;;;AAAA;;IAKE,eAAY;IACZ,iBAAc;;;;;AAGhB,uCAgEC;;;;;;IA5DC,uCAA4C;;;;;;;IAO5C,6CAAmB;;;;;;;IAOnB,2CAAwB;;;;;IAKxB,8CAoBI;;;;;;IAKJ,kEAA6B;;;;;;IAK7B,oEAA4B;;;;;;;IAK5B,6EAA6C;;;;;;;IAK7C,8EAA8C;;;AAGhD,IAAa,2BAA2B,GAAG,IAAI,cAAc,CAAC,6BAA6B,CAAC;;AAE5F,IAAa,cAAc,GAAG,IAAI,cAAc,CAAgB,gBAAgB,CAAC;;;;AAEjF,4BAMC;;;IALC,+BAAwB;;;;;IACxB,qDAA0B;;;;;;IAC1B,0DAAqC;;;;;IACrC,wDAA8B;;;;IAC9B,gDAAc;;;;;;;;;;;;AC5EhB,IAAa,iBAAiB,GAAG,SAAS;;;;;AAE1C,SAAgB,qBAAqB,CACnC,OAA6C;IAE7C,kBACE,GAAG,EAAE,CAAC,iBAAiB,CAAC,EACxB,OAAO,wBACP,SAAS,EAAE,IAAI,CAAC,SAAS,EACzB,WAAW,EAAE,IAAI,CAAC,KAAK,EACvB,eAAe;;;;QAAE,UAAA,GAAG,IAAI,OAAA,GAAG,GAAA,GAC3B,gBAAgB;;;;QAAE,UAAA,GAAG,IAAI,OAAA,GAAG,GAAA,KACzB,OAAO,EACV;CACH;;;;;;AAED,SAAgB,aAAa,CAC3B,OAAiC,EACjC,UAAkB;IAElB,IAAI,gBAAgB,CAAC,UAAU,CAAC,EAAE;QAChC,OAAO,IAAI,CAAC;KACb;IAED,IAAI,OAAO,CAAC,OAAO,2BAAiC;QAClD,OAAO,YAAY,CAAC;KACrB;SAAM,IAAI,OAAO,CAAC,OAAO,6BAAmC;QAC3D,OAAO,cAAc,CAAC;KACvB;IAED,OAAO,IAAI,CAAC;CACb;;;;;;AAED,SAAgB,aAAa,CAAC,GAAW,EAAE,OAAkC;;;IAG3E,OAAO,OAAO,IAAI,OAAO,CAAC,SAAS,GAAM,OAAO,CAAC,SAAS,SAAI,GAAK,GAAG,GAAG,CAAC;CAC3E;;;;;;AC5CD;;;;AAMA,oCAGC;;;IAFC,oCAA2C;;IAC3C,uCAA4D;;;;;;;AAI9D,SAAgB,uBAAuB,CAAC,GAAQ;IAC9C,OAAO,GAAG,IAAI,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;CACpC;;;;;IASK,gBAAgB,GAAG,mBAAmB;;;;;AAC5C,SAAgB,iBAAiB,CAAC,UAAsB;;IAEtD,IAAI,uBAAuB,CAAC,UAAU,CAAC,EAAE;QACvC,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC;KAC7B;;;;IAKD,IAAI,UAAU,CAAC,cAAc,CAAC,gBAAgB,CAAC,EAAE;QAC/C,UAAU,GAAG,oBAAC,UAAU,IAAS,gBAAgB,CAAC,CAAC,IAAI,CAAC;KACzD;IAED,OAAO,UAAU,YAAY,UAAU,GAAG,UAAU,CAAC,OAAO,EAAE,sBAAW,UAAU,EAAA,CAAC;CACrF;;;;;;;;;AClCD,4CAKC;;;IAJC,wDAGI;;;AAGN,IAAa,iCAAiC,GAAG,IAAI,cAAc,CAEjE,mCAAmC,CAAC;;;;;;AAEtC,SAAgB,+BAA+B,CAC7C,QAAkB,EAClB,OAAiC;;QAE3B,WAAW,GAAiB,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,GAAG,oBAAC,OAAO,CAAC,GAAG,GAAE;;QAErF,eAAe,GAAG,WAAW,CAAC,GAAG;;;;IAAC,UAAC,UAAsB;;YACvD,GAAG,GAAG,iBAAiB,CAAC,UAAU,CAAC;;YACnC,MAAM,GAAG,uBAAuB,CAAC,UAAU,CAAC;cAC9C,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC;cAC/B,QAAQ,CAAC,GAAG,CAAC,cAAc,CAAC;QAChC,OAAO,EAAE,GAAG,KAAA,EAAE,MAAM,QAAA,EAAE,CAAC;KACxB,EAAC;IAEF,oBACK,OAAO,IACV,eAAe,iBAAA,IACf;CACH;;;;;;;ICDC,2BACqD,QAAuC,EAC7D,WAAmB;QADG,aAAQ,GAAR,QAAQ,CAA+B;QAC7D,gBAAW,GAAX,WAAW,CAAQ;QAP1C,qBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;;QAEjD,yBAAoB,GAC1B,IAAI,CAAC,gBAAgB,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,iBAAiB,CAAC;KAKvF;;;;;;;IAEJ,kCAAM;;;;;;IAAN,UAAO,KAAU,EAAE,KAAU,EAAE,IAAsB;QAArD,iBA0IC;;QAzIC,IAAI,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YACtC,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;SAC3B;;YAEK,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC;;YAC9B,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;;YACjC,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;;YACrC,oBAAoB,GAAG,YAAY,IAAI,cAAc;;YACvD,YAAY,GAAG,KAAK;QAExB,IAAI,oBAAoB,EAAE;;gBAClB,WAAW,GAAG,cAAc,IAAI,KAAK,CAAC,WAAW;oCAE1C,GAAG,EAAE,MAAM;;;;;gBAKtB,IAAI,CAAC,OAAK,oBAAoB,IAAI,WAAW,EAAE;;;;;;;wBAMvC,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC;;wBACnC,SAAS,GAAG,gBAAgB,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC,GAAG,GAAG;oBAC9E,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE;;qBAE3C;iBACF;;oBAEK,UAAU,GAAG,aAAa,CAAC,GAAG,EAAE,OAAK,QAAQ,CAAC;;oBAChD,WAAW,GAAQ,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;gBAEjD,IAAI,WAAW,KAAK,WAAW,IAAI,WAAW,IAAI,IAAI,EAAE;oBACtD,IAAI;;4BACI,MAAM,GAAG,mBAAA,OAAK,QAAQ,CAAC,WAAW,GAAE,WAAW,CAAC;wBACtD,WAAW,GAAG,mBAAA,OAAK,QAAQ,CAAC,gBAAgB,GAAE,MAAM,EAAE,GAAG,CAAC,CAAC;qBAC5D;oBAAC,WAAM;;;wBAGN,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE;4BACjD,OAAO,CAAC,KAAK,CACX,2CAAyC,UAAU,oFAAiF,EACpI,WAAW,CACZ,CAAC;yBACH;wBACD,WAAW,GAAG,EAAE,CAAC;qBAClB;oBAED,IAAI,OAAK,QAAQ,CAAC,UAAU,EAAE;wBAC5B,OAAK,QAAQ,CAAC,UAAU,CAAC,OAAO;;;;wBAAC,UAAA,QAAQ;;gCACjC,YAAY,GAChB,QAAQ,CAAC,OAAO,KAAK,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,UAAU,IAAI,SAAS,CAAC;;gCACxE,QAAQ,GACZ,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,KAAI,CAAC,oBAAoB,KAAK,QAAQ,CAAC,GAAG,KAAK,GAAG;4BACtE,IAAI,YAAY,IAAI,QAAQ,EAAE;gCAC5B,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gCAC5C,YAAY,GAAG,IAAI,CAAC;6BACrB;yBACF,EAAC,CAAC;qBACJ;oBAED,IAAI,CAAC,OAAK,oBAAoB,EAAE;wBAC9B,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;qBAC3C;yBAAM;;;;;;;;;;wBAUL,IAAI,WAAW,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;4BACrE,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM;;;;;4BAAC,UAAC,WAAW,EAAE,UAAU;;;;;;;;gCAQpE,IAAI,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;oCAC1C,WAAW,CAAC,UAAU,CAAC,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;iCACnD;gCACD,OAAO,WAAW,CAAC;6BACpB,sBAAe,EAAE,GAAC,CAAC;yBACrB;wBAED,KAAK,gBAAQ,KAAK,EAAK,WAAW,CAAE,CAAC;qBACtC;iBACF;aACF;;;gBAjFD,KAA8B,IAAA,KAAAA,SAAA,IAAI,CAAC,gBAAgB,CAAA,gBAAA;oBAAxC,IAAA,aAAe,EAAb,YAAG,EAAE,kBAAM;4BAAX,GAAG,EAAE,MAAM;iBAiFvB;;;;;;;;;SACF;QAED,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,CAC5B,GAAG;;;;QAAC,UAAA,SAAS;;YACX,IAAI,CAAC,oBAAoB,KAAK,oBAAoB,IAAI,YAAY,CAAC,EAAE;;oBACnE,KAA8B,IAAA,KAAAA,SAAA,KAAI,CAAC,gBAAgB,CAAA,gBAAA,4BAAE;wBAA1C,IAAA,aAAe,EAAb,YAAG,EAAE,kBAAM;;4BAClB,WAAW,GAAG,SAAS;;4BAErB,UAAU,GAAG,aAAa,CAAC,GAAG,EAAE,KAAI,CAAC,QAAQ,CAAC;wBAEpD,IAAI,GAAG,KAAK,iBAAiB,EAAE;4BAC7B,WAAW,GAAG,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;yBACxC;wBAED,IAAI;;gCACI,cAAc,GAAG,mBAAA,KAAI,CAAC,QAAQ,CAAC,eAAe,GAAE,WAAW,EAAE,GAAG,CAAC;4BACvE,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,mBAAA,KAAI,CAAC,QAAQ,CAAC,SAAS,GAAE,cAAc,CAAC,CAAC,CAAC;yBACtE;wBAAC,OAAO,KAAK,EAAE;;;4BAGd,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE;gCACjD,IACE,KAAK;qCACJ,KAAK,CAAC,IAAI,KAAK,oBAAoB;wCAClC,KAAK,CAAC,IAAI,KAAK,4BAA4B,CAAC,EAC9C;oCACA,OAAO,CAAC,KAAK,CACX,SAAO,UAAU,qDAAkD,EACnE,WAAW,CACZ,CAAC;iCACH;qCAAM;oCACL,OAAO,CAAC,KAAK,CACX,yCAAuC,UAAU,yEAAsE,EACvH,WAAW,CACZ,CAAC;iCACH;6BACF;yBACF;qBACF;;;;;;;;;aACF;SACF,EAAC,CACH,CAAC;KACH;;gBAtJF,UAAU;;;;gDAQN,MAAM,SAAC,iCAAiC;6CACxC,MAAM,SAAC,WAAW;;IA8IvB,wBAAC;CAvJD,IAuJC;;;;;;IArJC,6CAAyD;;;;;IAEzD,iDAC2F;;;;;IAGzF,qCAA0F;;;;;IAC1F,wCAAgD;;;IAgJ9C,GAAG,GAAG,GAAG;;;;;;ACnLf;AAqBA,IAAa,YAAY,GAAG,IAAI,cAAc,CAAC,cAAc,CAAC;AAE9D;IAAA;KAmCC;;;;;IAjCQ,+BAAO;;;;IAAd,UACE,OAAkC;QAElC,OAAO;YACL,QAAQ,EAAE,uBAAuB;YACjC,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,YAAY;oBACrB,QAAQ,EAAE,iBAAiB;oBAC3B,KAAK,EAAE,IAAI;iBACZ;gBACD;oBACE,OAAO,EAAE,YAAY;oBACrB,QAAQ,EAAE,OAAO;iBAClB;gBACD;oBACE,OAAO,EAAE,2BAA2B;oBACpC,UAAU,EAAE,qBAAqB;oBACjC,IAAI,EAAE,CAAC,YAAY,CAAC;iBACrB;gBACD;oBACE,OAAO,EAAE,cAAc;oBACvB,UAAU,EAAE,aAAa;oBACzB,IAAI,EAAE,CAAC,2BAA2B,EAAE,WAAW,CAAC;iBACjD;gBACD;oBACE,OAAO,EAAE,iCAAiC;oBAC1C,UAAU,EAAE,+BAA+B;oBAC3C,IAAI,EAAE,CAAC,QAAQ,EAAE,2BAA2B,CAAC;iBAC9C;aACF;SACF,CAAC;KACH;;gBAlCF,QAAQ;;IAmCT,8BAAC;CAnCD;;;;;;ACvBA;AAIA,IAAa,oBAAoB,GAAG,IAAI,cAAc,CAAgB,sBAAsB,EAAE;IAC5F,UAAU,EAAE,MAAM;IAClB,OAAO;;;IAAE,cAAM,OAAA,YAAY,GAAA,CAAA;CAC5B,CAAC;;AAEF,IAAa,sBAAsB,GAAG,IAAI,cAAc,CACtD,wBAAwB,EACxB;IACE,UAAU,EAAE,MAAM;IAClB,OAAO;;;IAAE,cAAM,OAAA,cAAc,GAAA,CAAA;CAC9B,CACF;;;;;;;;;;;;;;;;;;;"}
|
package/ngxs-storage-plugin.d.ts
CHANGED
|
@@ -2,5 +2,6 @@
|
|
|
2
2
|
* Generated bundle index. Do not edit.
|
|
3
3
|
*/
|
|
4
4
|
export * from './index';
|
|
5
|
-
export { engineFactory as
|
|
5
|
+
export { engineFactory as ɵf, storageOptionsFactory as ɵe } from './src/internals';
|
|
6
|
+
export { FINAL_NGXS_STORAGE_PLUGIN_OPTIONS as ɵc, FinalNgxsStoragePluginOptions as ɵb, createFinalStoragePluginOptions as ɵd } from './src/internals/final-options';
|
|
6
7
|
export { USER_OPTIONS as ɵa } from './src/storage.module';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"__symbolic":"module","version":4,"metadata":{"ɵa":{"__symbolic":"new","expression":{"__symbolic":"reference","module":"@angular/core","name":"InjectionToken","line":
|
|
1
|
+
{"__symbolic":"module","version":4,"metadata":{"ɵa":{"__symbolic":"new","expression":{"__symbolic":"reference","module":"@angular/core","name":"InjectionToken","line":21,"character":32},"arguments":["USER_OPTIONS"]},"NgxsStoragePluginModule":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"NgModule","line":23,"character":1}}],"members":{},"statics":{"forRoot":{"__symbolic":"function","parameters":["options"],"value":{"ngModule":{"__symbolic":"reference","name":"NgxsStoragePluginModule"},"providers":[{"provide":{"__symbolic":"reference","module":"@ngxs/store","name":"NGXS_PLUGINS","line":32,"character":19},"useClass":{"__symbolic":"reference","name":"NgxsStoragePlugin"},"multi":true},{"provide":{"__symbolic":"reference","name":"ɵa"},"useValue":{"__symbolic":"reference","name":"options"}},{"provide":{"__symbolic":"reference","name":"NGXS_STORAGE_PLUGIN_OPTIONS"},"useFactory":{"__symbolic":"reference","name":"ɵe"},"deps":[{"__symbolic":"reference","name":"ɵa"}]},{"provide":{"__symbolic":"reference","name":"STORAGE_ENGINE"},"useFactory":{"__symbolic":"reference","name":"ɵf"},"deps":[{"__symbolic":"reference","name":"NGXS_STORAGE_PLUGIN_OPTIONS"},{"__symbolic":"reference","module":"@angular/core","name":"PLATFORM_ID","line":48,"character":46}]},{"provide":{"__symbolic":"reference","name":"ɵc"},"useFactory":{"__symbolic":"reference","name":"ɵd"},"deps":[{"__symbolic":"reference","module":"@angular/core","name":"Injector","line":53,"character":17},{"__symbolic":"reference","name":"NGXS_STORAGE_PLUGIN_OPTIONS"}]}]}}}},"NgxsStoragePlugin":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Injectable","line":26,"character":1}}],"members":{"__ctor__":[{"__symbolic":"constructor","parameterDecorators":[[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Inject","line":34,"character":5},"arguments":[{"__symbolic":"reference","name":"ɵc"}]}],[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Inject","line":35,"character":5},"arguments":[{"__symbolic":"reference","module":"@angular/core","name":"PLATFORM_ID","line":35,"character":12}]}]],"parameters":[{"__symbolic":"reference","name":"ɵb"},{"__symbolic":"reference","name":"string"}]}],"handle":[{"__symbolic":"method"}]}},"StorageOption":{"LocalStorage":0,"SessionStorage":1},"NgxsStoragePluginOptions":{"__symbolic":"interface"},"NGXS_STORAGE_PLUGIN_OPTIONS":{"__symbolic":"new","expression":{"__symbolic":"reference","module":"@angular/core","name":"InjectionToken","line":75,"character":47},"arguments":["NGXS_STORAGE_PLUGIN_OPTIONS"]},"STORAGE_ENGINE":{"__symbolic":"new","expression":{"__symbolic":"reference","module":"@angular/core","name":"InjectionToken","line":77,"character":34},"arguments":["STORAGE_ENGINE"]},"StorageEngine":{"__symbolic":"interface"},"LOCAL_STORAGE_ENGINE":{"__symbolic":"new","expression":{"__symbolic":"reference","module":"@angular/core","name":"InjectionToken","line":4,"character":40},"arguments":["LOCAL_STORAGE_ENGINE",{"__symbolic":"error","message":"Lambda not supported","line":6,"character":11,"module":"./src/engines"}]},"SESSION_STORAGE_ENGINE":{"__symbolic":"new","expression":{"__symbolic":"reference","module":"@angular/core","name":"InjectionToken","line":9,"character":42},"arguments":["SESSION_STORAGE_ENGINE",{"__symbolic":"error","message":"Lambda not supported","line":13,"character":13,"module":"./src/engines"}]},"ɵb":{"__symbolic":"interface"},"ɵc":{"__symbolic":"new","expression":{"__symbolic":"reference","module":"@angular/core","name":"InjectionToken","line":12,"character":53},"arguments":["FINAL_NGXS_STORAGE_PLUGIN_OPTIONS"]},"ɵd":{"__symbolic":"function"},"ɵe":{"__symbolic":"function","parameters":["options"],"value":{"__symbolic":"error","message":"Lambda not supported","line":18,"character":21,"module":"./src/internals"}},"ɵf":{"__symbolic":"function"}},"origins":{"ɵa":"./src/storage.module","NgxsStoragePluginModule":"./src/storage.module","NgxsStoragePlugin":"./src/storage.plugin","StorageOption":"./src/symbols","NgxsStoragePluginOptions":"./src/symbols","NGXS_STORAGE_PLUGIN_OPTIONS":"./src/symbols","STORAGE_ENGINE":"./src/symbols","StorageEngine":"./src/symbols","LOCAL_STORAGE_ENGINE":"./src/engines","SESSION_STORAGE_ENGINE":"./src/engines","ɵb":"./src/internals/final-options","ɵc":"./src/internals/final-options","ɵd":"./src/internals/final-options","ɵe":"./src/internals","ɵf":"./src/internals"},"importAs":"@ngxs/storage-plugin"}
|
package/package.json
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
"$schema": "../../node_modules/ng-packagr/package.schema.json",
|
|
3
3
|
"name": "@ngxs/storage-plugin",
|
|
4
4
|
"description": "extendable storage plugin for @ngxs/store",
|
|
5
|
-
"version": "3.7.
|
|
5
|
+
"version": "3.7.6-dev.master-95e4742",
|
|
6
6
|
"sideEffects": true,
|
|
7
7
|
"peerDependencies": {
|
|
8
|
-
"@
|
|
9
|
-
"@
|
|
8
|
+
"@angular/core": ">=6.1.0 <16.0.0",
|
|
9
|
+
"@ngxs/store": "^3.7.6 || ^3.7.6-dev",
|
|
10
10
|
"rxjs": ">=6.5.5"
|
|
11
11
|
},
|
|
12
12
|
"main": "bundles/ngxs-storage-plugin.umd.js",
|
|
@@ -65,4 +65,4 @@
|
|
|
65
65
|
"type": "opencollective",
|
|
66
66
|
"url": "https://opencollective.com/ngxs"
|
|
67
67
|
}
|
|
68
|
-
}
|
|
68
|
+
}
|
package/src/engines.d.ts
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { InjectionToken, Injector } from '@angular/core';
|
|
2
|
+
import { NgxsStoragePluginOptions, StorageEngine } from '../symbols';
|
|
3
|
+
export interface FinalNgxsStoragePluginOptions extends NgxsStoragePluginOptions {
|
|
4
|
+
keysWithEngines: {
|
|
5
|
+
key: string;
|
|
6
|
+
engine: StorageEngine;
|
|
7
|
+
}[];
|
|
8
|
+
}
|
|
9
|
+
export declare const FINAL_NGXS_STORAGE_PLUGIN_OPTIONS: InjectionToken<FinalNgxsStoragePluginOptions>;
|
|
10
|
+
export declare function createFinalStoragePluginOptions(injector: Injector, options: NgxsStoragePluginOptions): FinalNgxsStoragePluginOptions;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { InjectionToken, Type } from '@angular/core';
|
|
2
|
+
import { StateToken } from '@ngxs/store';
|
|
3
|
+
import { StateClass } from '@ngxs/store/internals';
|
|
4
|
+
import { StorageEngine } from '../symbols';
|
|
5
|
+
/** This enables the user to provide a storage engine per individual key. */
|
|
6
|
+
export interface KeyWithExplicitEngine {
|
|
7
|
+
key: string | StateClass | StateToken<any>;
|
|
8
|
+
engine: Type<StorageEngine> | InjectionToken<StorageEngine>;
|
|
9
|
+
}
|
|
10
|
+
/** Determines whether the provided key has the following structure. */
|
|
11
|
+
export declare function isKeyWithExplicitEngine(key: any): key is KeyWithExplicitEngine;
|
|
12
|
+
/**
|
|
13
|
+
* This tuples all of the possible types allowed in the `key` property.
|
|
14
|
+
* This is not exposed publicly and used internally only.
|
|
15
|
+
*/
|
|
16
|
+
export declare type StorageKey = string | StateClass | StateToken<any> | KeyWithExplicitEngine;
|
|
17
|
+
export declare function exctractStringKey(storageKey: StorageKey): string;
|
package/src/internals.d.ts
CHANGED
|
@@ -1,15 +1,9 @@
|
|
|
1
|
-
import { StateClass } from '@ngxs/store/internals';
|
|
2
|
-
import { StateToken } from '@ngxs/store';
|
|
3
1
|
import { StorageEngine, NgxsStoragePluginOptions } from './symbols';
|
|
4
2
|
/**
|
|
5
|
-
*
|
|
6
|
-
*
|
|
3
|
+
* The following key is used to store the entire serialized
|
|
4
|
+
* state when there's no specific state provided.
|
|
7
5
|
*/
|
|
8
6
|
export declare const DEFAULT_STATE_KEY = "@@STATE";
|
|
9
|
-
/**
|
|
10
|
-
* Internal type definition for the `key` option provided
|
|
11
|
-
* in the `forRoot` method when importing module
|
|
12
|
-
*/
|
|
13
|
-
export declare type StorageKey = string | StateClass | StateToken<any> | (string | StateClass | StateToken<any>)[];
|
|
14
7
|
export declare function storageOptionsFactory(options: NgxsStoragePluginOptions | undefined): NgxsStoragePluginOptions;
|
|
15
8
|
export declare function engineFactory(options: NgxsStoragePluginOptions, platformId: string): StorageEngine | null;
|
|
9
|
+
export declare function getStorageKey(key: string, options?: NgxsStoragePluginOptions): string;
|
package/src/public_api.d.ts
CHANGED