@ngxs/storage-plugin 19.0.0 → 20.0.0-dev.master-0db0003
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/fesm2022/ngxs-storage-plugin-internals.mjs +9 -4
- package/fesm2022/ngxs-storage-plugin-internals.mjs.map +1 -1
- package/fesm2022/ngxs-storage-plugin.mjs +49 -59
- package/fesm2022/ngxs-storage-plugin.mjs.map +1 -1
- package/index.d.ts +2 -3
- package/internals/index.d.ts +4 -3
- package/package.json +5 -5
- package/internals/package.json +0 -3
|
@@ -1,12 +1,17 @@
|
|
|
1
1
|
import { InjectionToken, inject } from '@angular/core';
|
|
2
2
|
import { StateToken } from '@ngxs/store';
|
|
3
|
-
import { ɵMETA_OPTIONS_KEY as _META_OPTIONS_KEY } from '@ngxs/store/internals';
|
|
3
|
+
import { ɵhasOwnProperty as _hasOwnProperty, ɵMETA_OPTIONS_KEY as _META_OPTIONS_KEY } from '@ngxs/store/internals';
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* The following key is used to store the entire serialized
|
|
7
7
|
* state when no specific state is provided.
|
|
8
8
|
*/
|
|
9
9
|
const ɵDEFAULT_STATE_KEY = '@@STATE';
|
|
10
|
+
var StorageOption;
|
|
11
|
+
(function (StorageOption) {
|
|
12
|
+
StorageOption[StorageOption["LocalStorage"] = 0] = "LocalStorage";
|
|
13
|
+
StorageOption[StorageOption["SessionStorage"] = 1] = "SessionStorage";
|
|
14
|
+
})(StorageOption || (StorageOption = {}));
|
|
10
15
|
const ɵUSER_OPTIONS = new InjectionToken(typeof ngDevMode !== 'undefined' && ngDevMode ? 'USER_OPTIONS' : '');
|
|
11
16
|
// Determines whether all states in the NGXS registry should be persisted or not.
|
|
12
17
|
const ɵALL_STATES_PERSISTED = new InjectionToken(typeof ngDevMode !== 'undefined' && ngDevMode ? 'ALL_STATES_PERSISTED' : '', {
|
|
@@ -18,7 +23,7 @@ const STORAGE_ENGINE = new InjectionToken(typeof ngDevMode !== 'undefined' && ng
|
|
|
18
23
|
|
|
19
24
|
/** Determines whether the provided key has the following structure. */
|
|
20
25
|
function ɵisKeyWithExplicitEngine(key) {
|
|
21
|
-
return
|
|
26
|
+
return !!key?.engine;
|
|
22
27
|
}
|
|
23
28
|
function ɵextractStringKey(storageKey) {
|
|
24
29
|
// Extract the actual key out of the `{ key, engine }` structure.
|
|
@@ -28,7 +33,7 @@ function ɵextractStringKey(storageKey) {
|
|
|
28
33
|
// Given the `storageKey` is a class, for instance, `AuthState`.
|
|
29
34
|
// We should retrieve its metadata and the `name` property.
|
|
30
35
|
// The `name` property might be a string (state name) or a state token.
|
|
31
|
-
if (storageKey
|
|
36
|
+
if (_hasOwnProperty(storageKey, _META_OPTIONS_KEY)) {
|
|
32
37
|
storageKey = storageKey[_META_OPTIONS_KEY].name;
|
|
33
38
|
}
|
|
34
39
|
return storageKey instanceof StateToken ? storageKey.getName() : storageKey;
|
|
@@ -38,5 +43,5 @@ function ɵextractStringKey(storageKey) {
|
|
|
38
43
|
* Generated bundle index. Do not edit.
|
|
39
44
|
*/
|
|
40
45
|
|
|
41
|
-
export { STORAGE_ENGINE, ɵALL_STATES_PERSISTED, ɵDEFAULT_STATE_KEY, ɵNGXS_STORAGE_PLUGIN_OPTIONS, ɵUSER_OPTIONS, ɵextractStringKey, ɵisKeyWithExplicitEngine };
|
|
46
|
+
export { STORAGE_ENGINE, StorageOption, ɵALL_STATES_PERSISTED, ɵDEFAULT_STATE_KEY, ɵNGXS_STORAGE_PLUGIN_OPTIONS, ɵUSER_OPTIONS, ɵextractStringKey, ɵisKeyWithExplicitEngine };
|
|
42
47
|
//# sourceMappingURL=ngxs-storage-plugin-internals.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ngxs-storage-plugin-internals.mjs","sources":["../../../packages/storage-plugin/internals/src/symbols.ts","../../../packages/storage-plugin/internals/src/storage-key.ts","../../../packages/storage-plugin/internals/src/ngxs-storage-plugin-internals.ts"],"sourcesContent":["import { InjectionToken, inject } from '@angular/core';\n\nimport { StorageKey } from './storage-key';\n\n/**\n * The following key is used to store the entire serialized\n * state when no specific state is provided.\n */\nexport const ɵDEFAULT_STATE_KEY = '@@STATE';\n\ndeclare const ngDevMode: boolean;\n\nexport
|
|
1
|
+
{"version":3,"file":"ngxs-storage-plugin-internals.mjs","sources":["../../../packages/storage-plugin/internals/src/symbols.ts","../../../packages/storage-plugin/internals/src/storage-key.ts","../../../packages/storage-plugin/internals/src/ngxs-storage-plugin-internals.ts"],"sourcesContent":["import { InjectionToken, inject } from '@angular/core';\n\nimport { StorageKey } from './storage-key';\n\n/**\n * The following key is used to store the entire serialized\n * state when no specific state is provided.\n */\nexport const ɵDEFAULT_STATE_KEY = '@@STATE';\n\ndeclare const ngDevMode: boolean;\n\nexport enum StorageOption {\n LocalStorage,\n SessionStorage\n}\n\nexport interface NgxsStoragePluginOptions {\n /**\n * Keys for the state slice to store in the storage engine.\n */\n keys: '*' | 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 interface ɵNgxsTransformedStoragePluginOptions extends NgxsStoragePluginOptions {\n keys: StorageKey[];\n}\n\nexport const ɵUSER_OPTIONS = new InjectionToken<NgxsStoragePluginOptions>(\n typeof ngDevMode !== 'undefined' && ngDevMode ? 'USER_OPTIONS' : ''\n);\n\n// Determines whether all states in the NGXS registry should be persisted or not.\nexport const ɵALL_STATES_PERSISTED = new InjectionToken<boolean>(\n typeof ngDevMode !== 'undefined' && ngDevMode ? 'ALL_STATES_PERSISTED' : '',\n {\n providedIn: 'root',\n factory: () => inject(ɵUSER_OPTIONS).keys === '*'\n }\n);\n\nexport const ɵNGXS_STORAGE_PLUGIN_OPTIONS =\n new InjectionToken<ɵNgxsTransformedStoragePluginOptions>(\n typeof ngDevMode !== 'undefined' && ngDevMode ? 'NGXS_STORAGE_PLUGIN_OPTIONS' : ''\n );\n\nexport const STORAGE_ENGINE = new InjectionToken<StorageEngine>(\n typeof ngDevMode !== 'undefined' && ngDevMode ? 'STORAGE_ENGINE' : ''\n);\n\nexport interface StorageEngine {\n getItem(key: string): any;\n setItem(key: string, value: any): void;\n}\n","import { InjectionToken, Type } from '@angular/core';\nimport { StateToken } from '@ngxs/store';\nimport { ɵhasOwnProperty, ɵMETA_OPTIONS_KEY, ɵ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?.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\nexport function ɵextractStringKey(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 (ɵhasOwnProperty(storageKey, ɵ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","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":["ɵhasOwnProperty","ɵMETA_OPTIONS_KEY"],"mappings":";;;;AAIA;;;AAGG;AACI,MAAM,kBAAkB,GAAG;IAItB;AAAZ,CAAA,UAAY,aAAa,EAAA;AACvB,IAAA,aAAA,CAAA,aAAA,CAAA,cAAA,CAAA,GAAA,CAAA,CAAA,GAAA,cAAY;AACZ,IAAA,aAAA,CAAA,aAAA,CAAA,gBAAA,CAAA,GAAA,CAAA,CAAA,GAAA,gBAAc;AAChB,CAAC,EAHW,aAAa,KAAb,aAAa,GAGxB,EAAA,CAAA,CAAA;MAwEY,aAAa,GAAG,IAAI,cAAc,CAC7C,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,GAAG,cAAc,GAAG,EAAE;AAGrE;MACa,qBAAqB,GAAG,IAAI,cAAc,CACrD,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,GAAG,sBAAsB,GAAG,EAAE,EAC3E;AACE,IAAA,UAAU,EAAE,MAAM;IAClB,OAAO,EAAE,MAAM,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,KAAK;AAC/C,CAAA;MAGU,4BAA4B,GACvC,IAAI,cAAc,CAChB,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,GAAG,6BAA6B,GAAG,EAAE;MAGzE,cAAc,GAAG,IAAI,cAAc,CAC9C,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,GAAG,gBAAgB,GAAG,EAAE;;AC9FvE;AACM,SAAU,wBAAwB,CAAC,GAAQ,EAAA;AAC/C,IAAA,OAAO,CAAC,CAAC,GAAG,EAAE,MAAM;AACtB;AAQM,SAAU,iBAAiB,CAAC,UAAsB,EAAA;;AAEtD,IAAA,IAAI,wBAAwB,CAAC,UAAU,CAAC,EAAE;AACxC,QAAA,UAAU,GAAG,UAAU,CAAC,GAAG;;;;;AAM7B,IAAA,IAAIA,eAAe,CAAC,UAAU,EAAEC,iBAAiB,CAAC,EAAE;AAClD,QAAA,UAAU,GAAI,UAAkB,CAACA,iBAAiB,CAAC,CAAC,IAAI;;AAG1D,IAAA,OAAO,UAAU,YAAY,UAAU,GAAG,UAAU,CAAC,OAAO,EAAE,GAAW,UAAU;AACrF;;ACrCA;;AAEG;;;;"}
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
import * as i0 from '@angular/core';
|
|
2
|
-
import { inject, Injector, Injectable,
|
|
2
|
+
import { inject, Injector, Injectable, NgModule, makeEnvironmentProviders, provideEnvironmentInitializer, InjectionToken } from '@angular/core';
|
|
3
3
|
import { withNgxsPlugin } from '@ngxs/store';
|
|
4
|
-
import { ɵDEFAULT_STATE_KEY as _DEFAULT_STATE_KEY, ɵNGXS_STORAGE_PLUGIN_OPTIONS as _NGXS_STORAGE_PLUGIN_OPTIONS, ɵextractStringKey as _extractStringKey, ɵisKeyWithExplicitEngine as _isKeyWithExplicitEngine, STORAGE_ENGINE, ɵALL_STATES_PERSISTED as _ALL_STATES_PERSISTED, ɵUSER_OPTIONS as _USER_OPTIONS } from '@ngxs/storage-plugin/internals';
|
|
5
|
-
export { STORAGE_ENGINE } from '@ngxs/storage-plugin/internals';
|
|
6
|
-
import {
|
|
4
|
+
import { ɵDEFAULT_STATE_KEY as _DEFAULT_STATE_KEY, StorageOption, ɵNGXS_STORAGE_PLUGIN_OPTIONS as _NGXS_STORAGE_PLUGIN_OPTIONS, ɵextractStringKey as _extractStringKey, ɵisKeyWithExplicitEngine as _isKeyWithExplicitEngine, STORAGE_ENGINE, ɵALL_STATES_PERSISTED as _ALL_STATES_PERSISTED, ɵUSER_OPTIONS as _USER_OPTIONS } from '@ngxs/storage-plugin/internals';
|
|
5
|
+
export { STORAGE_ENGINE, StorageOption } from '@ngxs/storage-plugin/internals';
|
|
6
|
+
import { ɵhasOwnProperty as _hasOwnProperty } from '@ngxs/store/internals';
|
|
7
7
|
import { actionMatcher, InitState, UpdateState, getValue, setValue } from '@ngxs/store/plugins';
|
|
8
|
-
import { tap } from 'rxjs
|
|
8
|
+
import { tap } from 'rxjs';
|
|
9
9
|
|
|
10
10
|
function storageOptionsFactory(options) {
|
|
11
11
|
return {
|
|
12
|
-
storage:
|
|
12
|
+
storage: StorageOption.LocalStorage,
|
|
13
13
|
serialize: JSON.stringify,
|
|
14
14
|
deserialize: JSON.parse,
|
|
15
15
|
beforeSerialize: obj => obj,
|
|
@@ -18,14 +18,14 @@ function storageOptionsFactory(options) {
|
|
|
18
18
|
keys: options.keys === '*' ? [_DEFAULT_STATE_KEY] : options.keys
|
|
19
19
|
};
|
|
20
20
|
}
|
|
21
|
-
function engineFactory(options
|
|
22
|
-
if (
|
|
21
|
+
function engineFactory(options) {
|
|
22
|
+
if (typeof ngServerMode !== 'undefined' && ngServerMode) {
|
|
23
23
|
return null;
|
|
24
24
|
}
|
|
25
|
-
if (options.storage ===
|
|
25
|
+
if (options.storage === StorageOption.LocalStorage) {
|
|
26
26
|
return localStorage;
|
|
27
27
|
}
|
|
28
|
-
else if (options.storage ===
|
|
28
|
+
else if (options.storage === StorageOption.SessionStorage) {
|
|
29
29
|
return sessionStorage;
|
|
30
30
|
}
|
|
31
31
|
return null;
|
|
@@ -37,11 +37,11 @@ function getStorageKey(key, options) {
|
|
|
37
37
|
}
|
|
38
38
|
|
|
39
39
|
class ɵNgxsStoragePluginKeysManager {
|
|
40
|
+
/** Store keys separately in a set so we're able to check if the key already exists. */
|
|
41
|
+
_keys = new Set();
|
|
42
|
+
_injector = inject(Injector);
|
|
43
|
+
_keysWithEngines = [];
|
|
40
44
|
constructor() {
|
|
41
|
-
/** Store keys separately in a set so we're able to check if the key already exists. */
|
|
42
|
-
this._keys = new Set();
|
|
43
|
-
this._injector = inject(Injector);
|
|
44
|
-
this._keysWithEngines = [];
|
|
45
45
|
const { keys } = inject(_NGXS_STORAGE_PLUGIN_OPTIONS);
|
|
46
46
|
this.addKeys(keys);
|
|
47
47
|
}
|
|
@@ -68,23 +68,20 @@ class ɵNgxsStoragePluginKeysManager {
|
|
|
68
68
|
this._keysWithEngines.push({ key, engine });
|
|
69
69
|
}
|
|
70
70
|
}
|
|
71
|
-
/** @nocollapse */ static
|
|
72
|
-
/** @nocollapse */ static
|
|
71
|
+
/** @nocollapse */ static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.0.3", ngImport: i0, type: ɵNgxsStoragePluginKeysManager, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
|
|
72
|
+
/** @nocollapse */ static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.0.3", ngImport: i0, type: ɵNgxsStoragePluginKeysManager, providedIn: 'root' });
|
|
73
73
|
}
|
|
74
|
-
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "
|
|
74
|
+
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.0.3", ngImport: i0, type: ɵNgxsStoragePluginKeysManager, decorators: [{
|
|
75
75
|
type: Injectable,
|
|
76
76
|
args: [{ providedIn: 'root' }]
|
|
77
77
|
}], ctorParameters: () => [] });
|
|
78
78
|
|
|
79
79
|
class NgxsStoragePlugin {
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
this._allStatesPersisted = inject(_ALL_STATES_PERSISTED);
|
|
84
|
-
this._isServer = isPlatformServer(inject(PLATFORM_ID));
|
|
85
|
-
}
|
|
80
|
+
_keysManager = inject(ɵNgxsStoragePluginKeysManager);
|
|
81
|
+
_options = inject(_NGXS_STORAGE_PLUGIN_OPTIONS);
|
|
82
|
+
_allStatesPersisted = inject(_ALL_STATES_PERSISTED);
|
|
86
83
|
handle(state, event, next) {
|
|
87
|
-
if (
|
|
84
|
+
if (typeof ngServerMode !== 'undefined' && ngServerMode) {
|
|
88
85
|
return next(state, event);
|
|
89
86
|
}
|
|
90
87
|
const matches = actionMatcher(event);
|
|
@@ -107,9 +104,8 @@ class NgxsStoragePlugin {
|
|
|
107
104
|
// Given the `key` is `myState.myProperty`, the `addedStates` will only contain `myState`.
|
|
108
105
|
const dotNotationIndex = key.indexOf(DOT);
|
|
109
106
|
const stateName = dotNotationIndex > -1 ? key.slice(0, dotNotationIndex) : key;
|
|
110
|
-
if (!addedStates
|
|
107
|
+
if (!_hasOwnProperty(addedStates, stateName))
|
|
111
108
|
continue;
|
|
112
|
-
}
|
|
113
109
|
}
|
|
114
110
|
const storageKey = getStorageKey(key, this._options);
|
|
115
111
|
let storedValue = engine.getItem(storageKey);
|
|
@@ -193,16 +189,16 @@ class NgxsStoragePlugin {
|
|
|
193
189
|
// This will only select the `router` object from the `storedValue`,
|
|
194
190
|
// avoiding unnecessary rehydration of the `counter` state.
|
|
195
191
|
return Object.keys(addedStates).reduce((accumulator, addedState) => {
|
|
196
|
-
if (storedValue
|
|
192
|
+
if (_hasOwnProperty(storedValue, addedState)) {
|
|
197
193
|
accumulator[addedState] = storedValue[addedState];
|
|
198
194
|
}
|
|
199
195
|
return accumulator;
|
|
200
196
|
}, {});
|
|
201
197
|
}
|
|
202
|
-
/** @nocollapse */ static
|
|
203
|
-
/** @nocollapse */ static
|
|
198
|
+
/** @nocollapse */ static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.0.3", ngImport: i0, type: NgxsStoragePlugin, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
|
|
199
|
+
/** @nocollapse */ static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.0.3", ngImport: i0, type: NgxsStoragePlugin });
|
|
204
200
|
}
|
|
205
|
-
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "
|
|
201
|
+
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.0.3", ngImport: i0, type: NgxsStoragePlugin, decorators: [{
|
|
206
202
|
type: Injectable
|
|
207
203
|
}] });
|
|
208
204
|
const DOT = '.';
|
|
@@ -225,16 +221,16 @@ class NgxsStoragePluginModule {
|
|
|
225
221
|
{
|
|
226
222
|
provide: STORAGE_ENGINE,
|
|
227
223
|
useFactory: engineFactory,
|
|
228
|
-
deps: [_NGXS_STORAGE_PLUGIN_OPTIONS
|
|
224
|
+
deps: [_NGXS_STORAGE_PLUGIN_OPTIONS]
|
|
229
225
|
}
|
|
230
226
|
]
|
|
231
227
|
};
|
|
232
228
|
}
|
|
233
|
-
/** @nocollapse */ static
|
|
234
|
-
/** @nocollapse */ static
|
|
235
|
-
/** @nocollapse */ static
|
|
229
|
+
/** @nocollapse */ static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.0.3", ngImport: i0, type: NgxsStoragePluginModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
|
|
230
|
+
/** @nocollapse */ static ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "20.0.3", ngImport: i0, type: NgxsStoragePluginModule });
|
|
231
|
+
/** @nocollapse */ static ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "20.0.3", ngImport: i0, type: NgxsStoragePluginModule });
|
|
236
232
|
}
|
|
237
|
-
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "
|
|
233
|
+
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.0.3", ngImport: i0, type: NgxsStoragePluginModule, decorators: [{
|
|
238
234
|
type: NgModule
|
|
239
235
|
}] });
|
|
240
236
|
function withNgxsStoragePlugin(options) {
|
|
@@ -252,44 +248,38 @@ function withNgxsStoragePlugin(options) {
|
|
|
252
248
|
{
|
|
253
249
|
provide: STORAGE_ENGINE,
|
|
254
250
|
useFactory: engineFactory,
|
|
255
|
-
deps: [_NGXS_STORAGE_PLUGIN_OPTIONS
|
|
251
|
+
deps: [_NGXS_STORAGE_PLUGIN_OPTIONS]
|
|
256
252
|
}
|
|
257
253
|
]);
|
|
258
254
|
}
|
|
259
255
|
|
|
260
256
|
function withStorageFeature(storageKeys) {
|
|
261
|
-
return
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
const message = 'The NGXS storage plugin is currently persisting all states because the `keys` ' +
|
|
270
|
-
'option was explicitly set to `*` at the root level. To selectively persist states, ' +
|
|
271
|
-
'consider explicitly specifying them, allowing for addition at the feature level.';
|
|
272
|
-
console.error(message);
|
|
273
|
-
}
|
|
274
|
-
// We should prevent the addition of any feature states to persistence
|
|
275
|
-
// if the `keys` property is set to `*`, as this could disrupt the algorithm
|
|
276
|
-
// used in the storage plugin. Instead, we should log an error in development
|
|
277
|
-
// mode. In production, it should continue to function, but act as a no-op.
|
|
278
|
-
return;
|
|
279
|
-
}
|
|
280
|
-
inject(ɵNgxsStoragePluginKeysManager).addKeys(storageKeys);
|
|
257
|
+
return provideEnvironmentInitializer(() => {
|
|
258
|
+
const allStatesPersisted = inject(_ALL_STATES_PERSISTED);
|
|
259
|
+
if (allStatesPersisted) {
|
|
260
|
+
if (typeof ngDevMode !== 'undefined' && ngDevMode) {
|
|
261
|
+
const message = 'The NGXS storage plugin is currently persisting all states because the `keys` ' +
|
|
262
|
+
'option was explicitly set to `*` at the root level. To selectively persist states, ' +
|
|
263
|
+
'consider explicitly specifying them, allowing for addition at the feature level.';
|
|
264
|
+
console.error(message);
|
|
281
265
|
}
|
|
266
|
+
// We should prevent the addition of any feature states to persistence
|
|
267
|
+
// if the `keys` property is set to `*`, as this could disrupt the algorithm
|
|
268
|
+
// used in the storage plugin. Instead, we should log an error in development
|
|
269
|
+
// mode. In production, it should continue to function, but act as a no-op.
|
|
270
|
+
return;
|
|
282
271
|
}
|
|
283
|
-
|
|
272
|
+
inject(ɵNgxsStoragePluginKeysManager).addKeys(storageKeys);
|
|
273
|
+
});
|
|
284
274
|
}
|
|
285
275
|
|
|
286
276
|
const LOCAL_STORAGE_ENGINE = /* @__PURE__ */ new InjectionToken(typeof ngDevMode !== 'undefined' && ngDevMode ? 'LOCAL_STORAGE_ENGINE' : '', {
|
|
287
277
|
providedIn: 'root',
|
|
288
|
-
factory: () => (
|
|
278
|
+
factory: () => (typeof ngServerMode !== 'undefined' && ngServerMode ? null : localStorage)
|
|
289
279
|
});
|
|
290
280
|
const SESSION_STORAGE_ENGINE = /* @__PURE__ */ new InjectionToken(typeof ngDevMode !== 'undefined' && ngDevMode ? 'SESSION_STORAGE_ENGINE' : '', {
|
|
291
281
|
providedIn: 'root',
|
|
292
|
-
factory: () =>
|
|
282
|
+
factory: () => typeof ngServerMode !== 'undefined' && ngServerMode ? null : sessionStorage
|
|
293
283
|
});
|
|
294
284
|
|
|
295
285
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ngxs-storage-plugin.mjs","sources":["../../../packages/storage-plugin/src/internals.ts","../../../packages/storage-plugin/src/keys-manager.ts","../../../packages/storage-plugin/src/storage.plugin.ts","../../../packages/storage-plugin/src/storage.module.ts","../../../packages/storage-plugin/src/with-storage-feature.ts","../../../packages/storage-plugin/src/engines.ts","../../../packages/storage-plugin/index.ts","../../../packages/storage-plugin/ngxs-storage-plugin.ts"],"sourcesContent":["import { isPlatformServer } from '@angular/common';\nimport {\n ɵDEFAULT_STATE_KEY,\n StorageOption,\n StorageEngine,\n NgxsStoragePluginOptions,\n ɵNgxsTransformedStoragePluginOptions\n} from '@ngxs/storage-plugin/internals';\n\nexport function storageOptionsFactory(\n options: NgxsStoragePluginOptions\n): ɵNgxsTransformedStoragePluginOptions {\n return {\n storage: StorageOption.LocalStorage,\n serialize: JSON.stringify,\n deserialize: JSON.parse,\n beforeSerialize: obj => obj,\n afterDeserialize: obj => obj,\n ...options,\n keys: options.keys === '*' ? [ɵDEFAULT_STATE_KEY] : options.keys\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?.namespace ? `${options.namespace}:${key}` : key;\n}\n","import { Injectable, Injector, inject } from '@angular/core';\nimport {\n STORAGE_ENGINE,\n StorageEngine,\n StorageKey,\n ɵextractStringKey,\n ɵisKeyWithExplicitEngine,\n ɵNGXS_STORAGE_PLUGIN_OPTIONS\n} from '@ngxs/storage-plugin/internals';\n\ninterface KeyWithEngine {\n key: string;\n engine: StorageEngine;\n}\n\n@Injectable({ providedIn: 'root' })\nexport class ɵNgxsStoragePluginKeysManager {\n /** Store keys separately in a set so we're able to check if the key already exists. */\n private readonly _keys = new Set<string>();\n\n private readonly _injector = inject(Injector);\n\n private readonly _keysWithEngines: KeyWithEngine[] = [];\n\n constructor() {\n const { keys } = inject(ɵNGXS_STORAGE_PLUGIN_OPTIONS);\n this.addKeys(keys);\n }\n\n getKeysWithEngines() {\n // Spread to prevent external code from directly modifying the internal state.\n return [...this._keysWithEngines];\n }\n\n addKeys(storageKeys: StorageKey[]): void {\n for (const storageKey of storageKeys) {\n const key = ɵextractStringKey(storageKey);\n\n // The user may call `withStorageFeature` with the same state multiple times.\n // Let's prevent duplicating state names in the `keysWithEngines` list.\n // Please note that calling provideStates multiple times with the same state is\n // acceptable behavior. This may occur because the state could be necessary at the\n // feature level, and different parts of the application might require its registration.\n // Consequently, `withStorageFeature` may also be called multiple times.\n if (this._keys.has(key)) {\n continue;\n }\n\n this._keys.add(key);\n\n const engine = ɵisKeyWithExplicitEngine(storageKey)\n ? this._injector.get(storageKey.engine)\n : this._injector.get(STORAGE_ENGINE);\n\n this._keysWithEngines.push({ key, engine });\n }\n }\n}\n","import { PLATFORM_ID, Injectable, inject } 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/plugins';\nimport {\n ɵDEFAULT_STATE_KEY,\n ɵALL_STATES_PERSISTED,\n ɵNGXS_STORAGE_PLUGIN_OPTIONS\n} from '@ngxs/storage-plugin/internals';\nimport { tap } from 'rxjs/operators';\n\nimport { getStorageKey } from './internals';\nimport { ɵNgxsStoragePluginKeysManager } from './keys-manager';\n\ndeclare const ngDevMode: boolean;\n\n@Injectable()\nexport class NgxsStoragePlugin implements NgxsPlugin {\n private _keysManager = inject(ɵNgxsStoragePluginKeysManager);\n private _options = inject(ɵNGXS_STORAGE_PLUGIN_OPTIONS);\n private _allStatesPersisted = inject(ɵALL_STATES_PERSISTED);\n private _isServer = isPlatformServer(inject(PLATFORM_ID));\n\n handle(state: any, event: any, next: NgxsNextPluginFn) {\n if (this._isServer) {\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: ɵPlainObject = isUpdateAction && event.addedStates;\n\n for (const { key, engine } of this._keysManager.getKeysWithEngines()) {\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._allStatesPersisted && 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 typeof ngDevMode !== 'undefined' &&\n 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 this._options.migrations?.forEach(strategy => {\n const versionMatch =\n strategy.version === getValue(storedValue, strategy.versionKey || 'version');\n const keyMatch =\n (!strategy.key && this._allStatesPersisted) || strategy.key === key;\n if (versionMatch && keyMatch) {\n storedValue = strategy.migrate(storedValue);\n hasMigration = true;\n }\n });\n\n if (this._allStatesPersisted) {\n storedValue = this._hydrateSelectivelyOnUpdate(storedValue, addedStates);\n state = { ...state, ...storedValue };\n } else {\n state = setValue(state, key, storedValue);\n }\n }\n }\n }\n\n return next(state, event).pipe(\n tap(nextState => {\n if (isInitOrUpdateAction && !hasMigration) {\n return;\n }\n\n for (const { key, engine } of this._keysManager.getKeysWithEngines()) {\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: any) {\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 private _hydrateSelectivelyOnUpdate(storedValue: any, addedStates: ɵPlainObject) {\n // The `UpdateState` action is triggered whenever a feature state is added.\n // The condition below is only satisfied when this action is triggered.\n // Let's consider two states: `counter` and `@ngxs/router-plugin` state.\n // When `provideStore` is called, `CounterState` is provided at the root level,\n // while `@ngxs/router-plugin` is provided as a feature state. Previously, the storage\n // plugin might have stored the value of the counter state as `10`. If `CounterState`\n // implements the `ngxsOnInit` hook and sets the state to `999`, the storage plugin will\n // reset the entire state when the `RouterState` is registered.\n // Consequently, the `counter` state will revert back to `10` instead of `999`.\n\n if (!storedValue || !addedStates || Object.keys(addedStates).length === 0) {\n // Nothing to update if `addedStates` object is empty.\n return storedValue;\n }\n\n // The `storedValue` can be the entire state when the default state key\n // is used. However, if `addedStates` only contains the `router` value,\n // we only want to merge the state with that `router` value.\n // Given the `storedValue` is an object:\n // `{ counter: 10, router: {...} }`\n // This will only select the `router` object from the `storedValue`,\n // avoiding unnecessary rehydration of the `counter` state.\n return Object.keys(addedStates).reduce(\n (accumulator, addedState) => {\n if (storedValue.hasOwnProperty(addedState)) {\n accumulator[addedState] = storedValue[addedState];\n }\n return accumulator;\n },\n <ɵPlainObject>{}\n );\n }\n}\n\nconst DOT = '.';\n","import {\n NgModule,\n ModuleWithProviders,\n PLATFORM_ID,\n EnvironmentProviders,\n makeEnvironmentProviders\n} from '@angular/core';\nimport { withNgxsPlugin } from '@ngxs/store';\nimport {\n ɵUSER_OPTIONS,\n STORAGE_ENGINE,\n ɵNGXS_STORAGE_PLUGIN_OPTIONS,\n NgxsStoragePluginOptions\n} from '@ngxs/storage-plugin/internals';\n\nimport { NgxsStoragePlugin } from './storage.plugin';\nimport { engineFactory, storageOptionsFactory } from './internals';\n\n@NgModule()\nexport class NgxsStoragePluginModule {\n static forRoot(\n options: NgxsStoragePluginOptions\n ): ModuleWithProviders<NgxsStoragePluginModule> {\n return {\n ngModule: NgxsStoragePluginModule,\n providers: [\n withNgxsPlugin(NgxsStoragePlugin),\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\nexport function withNgxsStoragePlugin(\n options: NgxsStoragePluginOptions\n): EnvironmentProviders {\n return makeEnvironmentProviders([\n withNgxsPlugin(NgxsStoragePlugin),\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","import {\n inject,\n EnvironmentProviders,\n ENVIRONMENT_INITIALIZER,\n makeEnvironmentProviders\n} from '@angular/core';\nimport { StorageKey, ɵALL_STATES_PERSISTED } from '@ngxs/storage-plugin/internals';\n\nimport { ɵNgxsStoragePluginKeysManager } from './keys-manager';\n\ndeclare const ngDevMode: boolean;\n\nexport function withStorageFeature(storageKeys: StorageKey[]): EnvironmentProviders {\n return makeEnvironmentProviders([\n {\n provide: ENVIRONMENT_INITIALIZER,\n multi: true,\n useValue: () => {\n const allStatesPersisted = inject(ɵALL_STATES_PERSISTED);\n\n if (allStatesPersisted) {\n if (typeof ngDevMode !== 'undefined' && ngDevMode) {\n const message =\n 'The NGXS storage plugin is currently persisting all states because the `keys` ' +\n 'option was explicitly set to `*` at the root level. To selectively persist states, ' +\n 'consider explicitly specifying them, allowing for addition at the feature level.';\n\n console.error(message);\n }\n\n // We should prevent the addition of any feature states to persistence\n // if the `keys` property is set to `*`, as this could disrupt the algorithm\n // used in the storage plugin. Instead, we should log an error in development\n // mode. In production, it should continue to function, but act as a no-op.\n return;\n }\n\n inject(ɵNgxsStoragePluginKeysManager).addKeys(storageKeys);\n }\n }\n ]);\n}\n","import { InjectionToken, PLATFORM_ID, inject } from '@angular/core';\nimport { isPlatformBrowser } from '@angular/common';\nimport { StorageEngine } from '@ngxs/storage-plugin/internals';\n\ndeclare const ngDevMode: boolean;\n\nexport const LOCAL_STORAGE_ENGINE = /* @__PURE__ */ new InjectionToken<StorageEngine | null>(\n typeof ngDevMode !== 'undefined' && ngDevMode ? 'LOCAL_STORAGE_ENGINE' : '',\n {\n providedIn: 'root',\n factory: () => (isPlatformBrowser(inject(PLATFORM_ID)) ? localStorage : null)\n }\n);\n\nexport const SESSION_STORAGE_ENGINE = /* @__PURE__ */ new InjectionToken<StorageEngine | null>(\n typeof ngDevMode !== 'undefined' && ngDevMode ? 'SESSION_STORAGE_ENGINE' : '',\n {\n providedIn: 'root',\n factory: () => (isPlatformBrowser(inject(PLATFORM_ID)) ? sessionStorage : null)\n }\n);\n","/**\n * The public api for consumers of @ngxs/storage-plugin\n */\nexport * from './src/public_api';\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":["ɵDEFAULT_STATE_KEY","ɵNGXS_STORAGE_PLUGIN_OPTIONS","ɵextractStringKey","ɵisKeyWithExplicitEngine","ɵALL_STATES_PERSISTED","ɵUSER_OPTIONS"],"mappings":";;;;;;;;;AASM,SAAU,qBAAqB,CACnC,OAAiC,EAAA;IAEjC,OAAO;AACL,QAAA,OAAO,EAA4B,CAAA;QACnC,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,WAAW,EAAE,IAAI,CAAC,KAAK;AACvB,QAAA,eAAe,EAAE,GAAG,IAAI,GAAG;AAC3B,QAAA,gBAAgB,EAAE,GAAG,IAAI,GAAG;AAC5B,QAAA,GAAG,OAAO;AACV,QAAA,IAAI,EAAE,OAAO,CAAC,IAAI,KAAK,GAAG,GAAG,CAACA,kBAAkB,CAAC,GAAG,OAAO,CAAC;KAC7D;AACH;AAEgB,SAAA,aAAa,CAC3B,OAAiC,EACjC,UAAkB,EAAA;AAElB,IAAA,IAAI,gBAAgB,CAAC,UAAU,CAAC,EAAE;AAChC,QAAA,OAAO,IAAI;;AAGb,IAAA,IAAI,OAAO,CAAC,OAAO,KAAA,CAAA,mCAAiC;AAClD,QAAA,OAAO,YAAY;;AACd,SAAA,IAAI,OAAO,CAAC,OAAO,KAAA,CAAA,qCAAmC;AAC3D,QAAA,OAAO,cAAc;;AAGvB,IAAA,OAAO,IAAI;AACb;AAEgB,SAAA,aAAa,CAAC,GAAW,EAAE,OAAkC,EAAA;;;AAG3E,IAAA,OAAO,OAAO,EAAE,SAAS,GAAG,CAAG,EAAA,OAAO,CAAC,SAAS,IAAI,GAAG,CAAA,CAAE,GAAG,GAAG;AACjE;;MC5Ba,6BAA6B,CAAA;AAQxC,IAAA,WAAA,GAAA;;AANiB,QAAA,IAAA,CAAA,KAAK,GAAG,IAAI,GAAG,EAAU;AAEzB,QAAA,IAAA,CAAA,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;QAE5B,IAAgB,CAAA,gBAAA,GAAoB,EAAE;QAGrD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAACC,4BAA4B,CAAC;AACrD,QAAA,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;;IAGpB,kBAAkB,GAAA;;AAEhB,QAAA,OAAO,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;;AAGnC,IAAA,OAAO,CAAC,WAAyB,EAAA;AAC/B,QAAA,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;AACpC,YAAA,MAAM,GAAG,GAAGC,iBAAiB,CAAC,UAAU,CAAC;;;;;;;YAQzC,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBACvB;;AAGF,YAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;AAEnB,YAAA,MAAM,MAAM,GAAGC,wBAAwB,CAAC,UAAU;kBAC9C,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM;kBACpC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC;YAEtC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;;;iIAtCpC,6BAA6B,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA,CAAA;AAA7B,uBAAA,SAAA,IAAA,CAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,QAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,6BAA6B,cADhB,MAAM,EAAA,CAAA,CAAA;;2FACnB,6BAA6B,EAAA,UAAA,EAAA,CAAA;kBADzC,UAAU;mBAAC,EAAE,UAAU,EAAE,MAAM,EAAE;;;MCUrB,iBAAiB,CAAA;AAD9B,IAAA,WAAA,GAAA;AAEU,QAAA,IAAA,CAAA,YAAY,GAAG,MAAM,CAAC,6BAA6B,CAAC;AACpD,QAAA,IAAA,CAAA,QAAQ,GAAG,MAAM,CAACF,4BAA4B,CAAC;AAC/C,QAAA,IAAA,CAAA,mBAAmB,GAAG,MAAM,CAACG,qBAAqB,CAAC;QACnD,IAAS,CAAA,SAAA,GAAG,gBAAgB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;AAoJ1D;AAlJC,IAAA,MAAM,CAAC,KAAU,EAAE,KAAU,EAAE,IAAsB,EAAA;AACnD,QAAA,IAAI,IAAI,CAAC,SAAS,EAAE;AAClB,YAAA,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC;;AAG3B,QAAA,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC;AACpC,QAAA,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;AACvC,QAAA,MAAM,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;AAC3C,QAAA,MAAM,oBAAoB,GAAG,YAAY,IAAI,cAAc;QAC3D,IAAI,YAAY,GAAG,KAAK;QAExB,IAAI,oBAAoB,EAAE;AACxB,YAAA,MAAM,WAAW,GAAiB,cAAc,IAAI,KAAK,CAAC,WAAW;AAErE,YAAA,KAAK,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,EAAE;;;;;AAKpE,gBAAA,IAAI,CAAC,IAAI,CAAC,mBAAmB,IAAI,WAAW,EAAE;;;;;;oBAM5C,MAAM,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC;oBACzC,MAAM,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;wBAC1C;;;gBAIJ,MAAM,UAAU,GAAG,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC;gBACpD,IAAI,WAAW,GAAQ,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;gBAEjD,IAAI,WAAW,KAAK,WAAW,IAAI,WAAW,IAAI,IAAI,EAAE;AACtD,oBAAA,IAAI;wBACF,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAY,CAAC,WAAW,CAAC;wBACtD,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,gBAAiB,CAAC,MAAM,EAAE,GAAG,CAAC;;AAC1D,oBAAA,MAAM;wBACN,OAAO,SAAS,KAAK,WAAW;4BAC9B,SAAS;4BACT,OAAO,CAAC,KAAK,CACX,CAAA,sCAAA,EAAyC,UAAU,CAAiF,+EAAA,CAAA,EACpI,WAAW,CACZ;wBAEH,WAAW,GAAG,EAAE;;oBAGlB,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,IAAG;AAC3C,wBAAA,MAAM,YAAY,GAChB,QAAQ,CAAC,OAAO,KAAK,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,UAAU,IAAI,SAAS,CAAC;AAC9E,wBAAA,MAAM,QAAQ,GACZ,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,IAAI,CAAC,mBAAmB,KAAK,QAAQ,CAAC,GAAG,KAAK,GAAG;AACrE,wBAAA,IAAI,YAAY,IAAI,QAAQ,EAAE;AAC5B,4BAAA,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC;4BAC3C,YAAY,GAAG,IAAI;;AAEvB,qBAAC,CAAC;AAEF,oBAAA,IAAI,IAAI,CAAC,mBAAmB,EAAE;wBAC5B,WAAW,GAAG,IAAI,CAAC,2BAA2B,CAAC,WAAW,EAAE,WAAW,CAAC;wBACxE,KAAK,GAAG,EAAE,GAAG,KAAK,EAAE,GAAG,WAAW,EAAE;;yBAC/B;wBACL,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,WAAW,CAAC;;;;;AAMjD,QAAA,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,CAC5B,GAAG,CAAC,SAAS,IAAG;AACd,YAAA,IAAI,oBAAoB,IAAI,CAAC,YAAY,EAAE;gBACzC;;AAGF,YAAA,KAAK,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,EAAE;gBACpE,IAAI,WAAW,GAAG,SAAS;gBAE3B,MAAM,UAAU,GAAG,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC;AAEpD,gBAAA,IAAI,GAAG,KAAKJ,kBAAkB,EAAE;AAC9B,oBAAA,WAAW,GAAG,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC;;AAGxC,gBAAA,IAAI;AACF,oBAAA,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,GAAG,CAAC;AACvE,oBAAA,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAU,CAAC,cAAc,CAAC,CAAC;;gBACpE,OAAO,KAAU,EAAE;AACnB,oBAAA,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE;AACjD,wBAAA,IACE,KAAK;AACL,6BAAC,KAAK,CAAC,IAAI,KAAK,oBAAoB;AAClC,gCAAA,KAAK,CAAC,IAAI,KAAK,4BAA4B,CAAC,EAC9C;4BACA,OAAO,CAAC,KAAK,CACX,CAAA,IAAA,EAAO,UAAU,CAAkD,gDAAA,CAAA,EACnE,WAAW,CACZ;;6BACI;4BACL,OAAO,CAAC,KAAK,CACX,CAAA,oCAAA,EAAuC,UAAU,CAAsE,oEAAA,CAAA,EACvH,WAAW,CACZ;;;;;SAKV,CAAC,CACH;;IAGK,2BAA2B,CAAC,WAAgB,EAAE,WAAyB,EAAA;;;;;;;;;;AAW7E,QAAA,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;;AAEzE,YAAA,OAAO,WAAW;;;;;;;;;AAUpB,QAAA,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CACpC,CAAC,WAAW,EAAE,UAAU,KAAI;AAC1B,YAAA,IAAI,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;gBAC1C,WAAW,CAAC,UAAU,CAAC,GAAG,WAAW,CAAC,UAAU,CAAC;;AAEnD,YAAA,OAAO,WAAW;SACnB,EACa,EAAE,CACjB;;iIAtJQ,iBAAiB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA,CAAA;qIAAjB,iBAAiB,EAAA,CAAA,CAAA;;2FAAjB,iBAAiB,EAAA,UAAA,EAAA,CAAA;kBAD7B;;AA2JD,MAAM,GAAG,GAAG,GAAG;;MChKF,uBAAuB,CAAA;IAClC,OAAO,OAAO,CACZ,OAAiC,EAAA;QAEjC,OAAO;AACL,YAAA,QAAQ,EAAE,uBAAuB;AACjC,YAAA,SAAS,EAAE;gBACT,cAAc,CAAC,iBAAiB,CAAC;AACjC,gBAAA;AACE,oBAAA,OAAO,EAAEK,aAAa;AACtB,oBAAA,QAAQ,EAAE;AACX,iBAAA;AACD,gBAAA;AACE,oBAAA,OAAO,EAAEJ,4BAA4B;AACrC,oBAAA,UAAU,EAAE,qBAAqB;oBACjC,IAAI,EAAE,CAACI,aAAa;AACrB,iBAAA;AACD,gBAAA;AACE,oBAAA,OAAO,EAAE,cAAc;AACvB,oBAAA,UAAU,EAAE,aAAa;AACzB,oBAAA,IAAI,EAAE,CAACJ,4BAA4B,EAAE,WAAW;AACjD;AACF;SACF;;iIAvBQ,uBAAuB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,QAAA,EAAA,CAAA,CAAA;kIAAvB,uBAAuB,EAAA,CAAA,CAAA;kIAAvB,uBAAuB,EAAA,CAAA,CAAA;;2FAAvB,uBAAuB,EAAA,UAAA,EAAA,CAAA;kBADnC;;AA4BK,SAAU,qBAAqB,CACnC,OAAiC,EAAA;AAEjC,IAAA,OAAO,wBAAwB,CAAC;QAC9B,cAAc,CAAC,iBAAiB,CAAC;AACjC,QAAA;AACE,YAAA,OAAO,EAAEI,aAAa;AACtB,YAAA,QAAQ,EAAE;AACX,SAAA;AACD,QAAA;AACE,YAAA,OAAO,EAAEJ,4BAA4B;AACrC,YAAA,UAAU,EAAE,qBAAqB;YACjC,IAAI,EAAE,CAACI,aAAa;AACrB,SAAA;AACD,QAAA;AACE,YAAA,OAAO,EAAE,cAAc;AACvB,YAAA,UAAU,EAAE,aAAa;AACzB,YAAA,IAAI,EAAE,CAACJ,4BAA4B,EAAE,WAAW;AACjD;AACF,KAAA,CAAC;AACJ;;ACtDM,SAAU,kBAAkB,CAAC,WAAyB,EAAA;AAC1D,IAAA,OAAO,wBAAwB,CAAC;AAC9B,QAAA;AACE,YAAA,OAAO,EAAE,uBAAuB;AAChC,YAAA,KAAK,EAAE,IAAI;YACX,QAAQ,EAAE,MAAK;AACb,gBAAA,MAAM,kBAAkB,GAAG,MAAM,CAACG,qBAAqB,CAAC;gBAExD,IAAI,kBAAkB,EAAE;AACtB,oBAAA,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE;wBACjD,MAAM,OAAO,GACX,gFAAgF;4BAChF,qFAAqF;AACrF,4BAAA,kFAAkF;AAEpF,wBAAA,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;;;;;;oBAOxB;;gBAGF,MAAM,CAAC,6BAA6B,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;;AAE7D;AACF,KAAA,CAAC;AACJ;;MCnCa,oBAAoB,mBAAmB,IAAI,cAAc,CACpE,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,GAAG,sBAAsB,GAAG,EAAE,EAC3E;AACE,IAAA,UAAU,EAAE,MAAM;IAClB,OAAO,EAAE,OAAO,iBAAiB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,YAAY,GAAG,IAAI;AAC7E,CAAA;MAGU,sBAAsB,mBAAmB,IAAI,cAAc,CACtE,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,GAAG,wBAAwB,GAAG,EAAE,EAC7E;AACE,IAAA,UAAU,EAAE,MAAM;IAClB,OAAO,EAAE,OAAO,iBAAiB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,cAAc,GAAG,IAAI;AAC/E,CAAA;;ACnBH;;AAEG;;ACFH;;AAEG;;;;"}
|
|
1
|
+
{"version":3,"file":"ngxs-storage-plugin.mjs","sources":["../../../packages/storage-plugin/src/internals.ts","../../../packages/storage-plugin/src/keys-manager.ts","../../../packages/storage-plugin/src/storage.plugin.ts","../../../packages/storage-plugin/src/storage.module.ts","../../../packages/storage-plugin/src/with-storage-feature.ts","../../../packages/storage-plugin/src/engines.ts","../../../packages/storage-plugin/index.ts","../../../packages/storage-plugin/ngxs-storage-plugin.ts"],"sourcesContent":["import {\n ɵDEFAULT_STATE_KEY,\n StorageOption,\n StorageEngine,\n NgxsStoragePluginOptions,\n ɵNgxsTransformedStoragePluginOptions\n} from '@ngxs/storage-plugin/internals';\n\ndeclare const ngServerMode: boolean;\n\nexport function storageOptionsFactory(\n options: NgxsStoragePluginOptions\n): ɵNgxsTransformedStoragePluginOptions {\n return {\n storage: StorageOption.LocalStorage,\n serialize: JSON.stringify,\n deserialize: JSON.parse,\n beforeSerialize: obj => obj,\n afterDeserialize: obj => obj,\n ...options,\n keys: options.keys === '*' ? [ɵDEFAULT_STATE_KEY] : options.keys\n };\n}\n\nexport function engineFactory(options: NgxsStoragePluginOptions): StorageEngine | null {\n if (typeof ngServerMode !== 'undefined' && ngServerMode) {\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?.namespace ? `${options.namespace}:${key}` : key;\n}\n","import { Injectable, Injector, inject } from '@angular/core';\nimport {\n STORAGE_ENGINE,\n StorageEngine,\n StorageKey,\n ɵextractStringKey,\n ɵisKeyWithExplicitEngine,\n ɵNGXS_STORAGE_PLUGIN_OPTIONS\n} from '@ngxs/storage-plugin/internals';\n\ninterface KeyWithEngine {\n key: string;\n engine: StorageEngine;\n}\n\n@Injectable({ providedIn: 'root' })\nexport class ɵNgxsStoragePluginKeysManager {\n /** Store keys separately in a set so we're able to check if the key already exists. */\n private readonly _keys = new Set<string>();\n\n private readonly _injector = inject(Injector);\n\n private readonly _keysWithEngines: KeyWithEngine[] = [];\n\n constructor() {\n const { keys } = inject(ɵNGXS_STORAGE_PLUGIN_OPTIONS);\n this.addKeys(keys);\n }\n\n getKeysWithEngines() {\n // Spread to prevent external code from directly modifying the internal state.\n return [...this._keysWithEngines];\n }\n\n addKeys(storageKeys: StorageKey[]): void {\n for (const storageKey of storageKeys) {\n const key = ɵextractStringKey(storageKey);\n\n // The user may call `withStorageFeature` with the same state multiple times.\n // Let's prevent duplicating state names in the `keysWithEngines` list.\n // Please note that calling provideStates multiple times with the same state is\n // acceptable behavior. This may occur because the state could be necessary at the\n // feature level, and different parts of the application might require its registration.\n // Consequently, `withStorageFeature` may also be called multiple times.\n if (this._keys.has(key)) {\n continue;\n }\n\n this._keys.add(key);\n\n const engine = ɵisKeyWithExplicitEngine(storageKey)\n ? this._injector.get(storageKey.engine)\n : this._injector.get(STORAGE_ENGINE);\n\n this._keysWithEngines.push({ key, engine });\n }\n }\n}\n","import { Injectable, inject } from '@angular/core';\nimport { ɵhasOwnProperty, ɵPlainObject } from '@ngxs/store/internals';\nimport {\n NgxsPlugin,\n setValue,\n getValue,\n InitState,\n UpdateState,\n actionMatcher,\n NgxsNextPluginFn\n} from '@ngxs/store/plugins';\nimport {\n ɵDEFAULT_STATE_KEY,\n ɵALL_STATES_PERSISTED,\n ɵNGXS_STORAGE_PLUGIN_OPTIONS\n} from '@ngxs/storage-plugin/internals';\nimport { tap } from 'rxjs';\n\nimport { getStorageKey } from './internals';\nimport { ɵNgxsStoragePluginKeysManager } from './keys-manager';\n\ndeclare const ngDevMode: boolean;\ndeclare const ngServerMode: boolean;\n\n@Injectable()\nexport class NgxsStoragePlugin implements NgxsPlugin {\n private _keysManager = inject(ɵNgxsStoragePluginKeysManager);\n private _options = inject(ɵNGXS_STORAGE_PLUGIN_OPTIONS);\n private _allStatesPersisted = inject(ɵALL_STATES_PERSISTED);\n\n handle(state: any, event: any, next: NgxsNextPluginFn) {\n if (typeof ngServerMode !== 'undefined' && ngServerMode) {\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: ɵPlainObject = isUpdateAction && event.addedStates;\n\n for (const { key, engine } of this._keysManager.getKeysWithEngines()) {\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._allStatesPersisted && 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 (!ɵhasOwnProperty(addedStates, stateName)) continue;\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 typeof ngDevMode !== 'undefined' &&\n 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 this._options.migrations?.forEach(strategy => {\n const versionMatch =\n strategy.version === getValue(storedValue, strategy.versionKey || 'version');\n const keyMatch =\n (!strategy.key && this._allStatesPersisted) || strategy.key === key;\n if (versionMatch && keyMatch) {\n storedValue = strategy.migrate(storedValue);\n hasMigration = true;\n }\n });\n\n if (this._allStatesPersisted) {\n storedValue = this._hydrateSelectivelyOnUpdate(storedValue, addedStates);\n state = { ...state, ...storedValue };\n } else {\n state = setValue(state, key, storedValue);\n }\n }\n }\n }\n\n return next(state, event).pipe(\n tap(nextState => {\n if (isInitOrUpdateAction && !hasMigration) {\n return;\n }\n\n for (const { key, engine } of this._keysManager.getKeysWithEngines()) {\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: any) {\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 private _hydrateSelectivelyOnUpdate(storedValue: any, addedStates: ɵPlainObject) {\n // The `UpdateState` action is triggered whenever a feature state is added.\n // The condition below is only satisfied when this action is triggered.\n // Let's consider two states: `counter` and `@ngxs/router-plugin` state.\n // When `provideStore` is called, `CounterState` is provided at the root level,\n // while `@ngxs/router-plugin` is provided as a feature state. Previously, the storage\n // plugin might have stored the value of the counter state as `10`. If `CounterState`\n // implements the `ngxsOnInit` hook and sets the state to `999`, the storage plugin will\n // reset the entire state when the `RouterState` is registered.\n // Consequently, the `counter` state will revert back to `10` instead of `999`.\n\n if (!storedValue || !addedStates || Object.keys(addedStates).length === 0) {\n // Nothing to update if `addedStates` object is empty.\n return storedValue;\n }\n\n // The `storedValue` can be the entire state when the default state key\n // is used. However, if `addedStates` only contains the `router` value,\n // we only want to merge the state with that `router` value.\n // Given the `storedValue` is an object:\n // `{ counter: 10, router: {...} }`\n // This will only select the `router` object from the `storedValue`,\n // avoiding unnecessary rehydration of the `counter` state.\n return Object.keys(addedStates).reduce(\n (accumulator, addedState) => {\n if (ɵhasOwnProperty(storedValue, addedState)) {\n accumulator[addedState] = storedValue[addedState];\n }\n return accumulator;\n },\n <ɵPlainObject>{}\n );\n }\n}\n\nconst DOT = '.';\n","import {\n NgModule,\n ModuleWithProviders,\n EnvironmentProviders,\n makeEnvironmentProviders\n} from '@angular/core';\nimport { withNgxsPlugin } from '@ngxs/store';\nimport {\n ɵUSER_OPTIONS,\n STORAGE_ENGINE,\n ɵNGXS_STORAGE_PLUGIN_OPTIONS,\n NgxsStoragePluginOptions\n} from '@ngxs/storage-plugin/internals';\n\nimport { NgxsStoragePlugin } from './storage.plugin';\nimport { engineFactory, storageOptionsFactory } from './internals';\n\n@NgModule()\nexport class NgxsStoragePluginModule {\n static forRoot(\n options: NgxsStoragePluginOptions\n ): ModuleWithProviders<NgxsStoragePluginModule> {\n return {\n ngModule: NgxsStoragePluginModule,\n providers: [\n withNgxsPlugin(NgxsStoragePlugin),\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]\n }\n ]\n };\n }\n}\n\nexport function withNgxsStoragePlugin(\n options: NgxsStoragePluginOptions\n): EnvironmentProviders {\n return makeEnvironmentProviders([\n withNgxsPlugin(NgxsStoragePlugin),\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]\n }\n ]);\n}\n","import { inject, EnvironmentProviders, provideEnvironmentInitializer } from '@angular/core';\nimport { StorageKey, ɵALL_STATES_PERSISTED } from '@ngxs/storage-plugin/internals';\n\nimport { ɵNgxsStoragePluginKeysManager } from './keys-manager';\n\ndeclare const ngDevMode: boolean;\n\nexport function withStorageFeature(storageKeys: StorageKey[]): EnvironmentProviders {\n return provideEnvironmentInitializer(() => {\n const allStatesPersisted = inject(ɵALL_STATES_PERSISTED);\n\n if (allStatesPersisted) {\n if (typeof ngDevMode !== 'undefined' && ngDevMode) {\n const message =\n 'The NGXS storage plugin is currently persisting all states because the `keys` ' +\n 'option was explicitly set to `*` at the root level. To selectively persist states, ' +\n 'consider explicitly specifying them, allowing for addition at the feature level.';\n\n console.error(message);\n }\n\n // We should prevent the addition of any feature states to persistence\n // if the `keys` property is set to `*`, as this could disrupt the algorithm\n // used in the storage plugin. Instead, we should log an error in development\n // mode. In production, it should continue to function, but act as a no-op.\n return;\n }\n\n inject(ɵNgxsStoragePluginKeysManager).addKeys(storageKeys);\n });\n}\n","import { InjectionToken } from '@angular/core';\nimport { StorageEngine } from '@ngxs/storage-plugin/internals';\n\ndeclare const ngDevMode: boolean;\ndeclare const ngServerMode: boolean;\n\nexport const LOCAL_STORAGE_ENGINE = /* @__PURE__ */ new InjectionToken<StorageEngine | null>(\n typeof ngDevMode !== 'undefined' && ngDevMode ? 'LOCAL_STORAGE_ENGINE' : '',\n {\n providedIn: 'root',\n factory: () => (typeof ngServerMode !== 'undefined' && ngServerMode ? null : localStorage)\n }\n);\n\nexport const SESSION_STORAGE_ENGINE = /* @__PURE__ */ new InjectionToken<StorageEngine | null>(\n typeof ngDevMode !== 'undefined' && ngDevMode ? 'SESSION_STORAGE_ENGINE' : '',\n {\n providedIn: 'root',\n factory: () =>\n typeof ngServerMode !== 'undefined' && ngServerMode ? null : sessionStorage\n }\n);\n","/**\n * The public api for consumers of @ngxs/storage-plugin\n */\nexport * from './src/public_api';\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":["ɵDEFAULT_STATE_KEY","ɵNGXS_STORAGE_PLUGIN_OPTIONS","ɵextractStringKey","ɵisKeyWithExplicitEngine","ɵALL_STATES_PERSISTED","ɵhasOwnProperty","ɵUSER_OPTIONS"],"mappings":";;;;;;;;;AAUM,SAAU,qBAAqB,CACnC,OAAiC,EAAA;IAEjC,OAAO;QACL,OAAO,EAAE,aAAa,CAAC,YAAY;QACnC,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,WAAW,EAAE,IAAI,CAAC,KAAK;AACvB,QAAA,eAAe,EAAE,GAAG,IAAI,GAAG;AAC3B,QAAA,gBAAgB,EAAE,GAAG,IAAI,GAAG;AAC5B,QAAA,GAAG,OAAO;AACV,QAAA,IAAI,EAAE,OAAO,CAAC,IAAI,KAAK,GAAG,GAAG,CAACA,kBAAkB,CAAC,GAAG,OAAO,CAAC;KAC7D;AACH;AAEM,SAAU,aAAa,CAAC,OAAiC,EAAA;AAC7D,IAAA,IAAI,OAAO,YAAY,KAAK,WAAW,IAAI,YAAY,EAAE;AACvD,QAAA,OAAO,IAAI;;IAGb,IAAI,OAAO,CAAC,OAAO,KAAK,aAAa,CAAC,YAAY,EAAE;AAClD,QAAA,OAAO,YAAY;;SACd,IAAI,OAAO,CAAC,OAAO,KAAK,aAAa,CAAC,cAAc,EAAE;AAC3D,QAAA,OAAO,cAAc;;AAGvB,IAAA,OAAO,IAAI;AACb;AAEgB,SAAA,aAAa,CAAC,GAAW,EAAE,OAAkC,EAAA;;;AAG3E,IAAA,OAAO,OAAO,EAAE,SAAS,GAAG,CAAG,EAAA,OAAO,CAAC,SAAS,IAAI,GAAG,CAAA,CAAE,GAAG,GAAG;AACjE;;MC1Ba,6BAA6B,CAAA;;AAEvB,IAAA,KAAK,GAAG,IAAI,GAAG,EAAU;AAEzB,IAAA,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;IAE5B,gBAAgB,GAAoB,EAAE;AAEvD,IAAA,WAAA,GAAA;QACE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAACC,4BAA4B,CAAC;AACrD,QAAA,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;;IAGpB,kBAAkB,GAAA;;AAEhB,QAAA,OAAO,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;;AAGnC,IAAA,OAAO,CAAC,WAAyB,EAAA;AAC/B,QAAA,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;AACpC,YAAA,MAAM,GAAG,GAAGC,iBAAiB,CAAC,UAAU,CAAC;;;;;;;YAQzC,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBACvB;;AAGF,YAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;AAEnB,YAAA,MAAM,MAAM,GAAGC,wBAAwB,CAAC,UAAU;kBAC9C,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM;kBACpC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC;YAEtC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;;;0HAtCpC,6BAA6B,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA;AAA7B,uBAAA,OAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,QAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,6BAA6B,cADhB,MAAM,EAAA,CAAA;;2FACnB,6BAA6B,EAAA,UAAA,EAAA,CAAA;kBADzC,UAAU;mBAAC,EAAE,UAAU,EAAE,MAAM,EAAE;;;MCUrB,iBAAiB,CAAA;AACpB,IAAA,YAAY,GAAG,MAAM,CAAC,6BAA6B,CAAC;AACpD,IAAA,QAAQ,GAAG,MAAM,CAACF,4BAA4B,CAAC;AAC/C,IAAA,mBAAmB,GAAG,MAAM,CAACG,qBAAqB,CAAC;AAE3D,IAAA,MAAM,CAAC,KAAU,EAAE,KAAU,EAAE,IAAsB,EAAA;AACnD,QAAA,IAAI,OAAO,YAAY,KAAK,WAAW,IAAI,YAAY,EAAE;AACvD,YAAA,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC;;AAG3B,QAAA,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC;AACpC,QAAA,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;AACvC,QAAA,MAAM,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;AAC3C,QAAA,MAAM,oBAAoB,GAAG,YAAY,IAAI,cAAc;QAC3D,IAAI,YAAY,GAAG,KAAK;QAExB,IAAI,oBAAoB,EAAE;AACxB,YAAA,MAAM,WAAW,GAAiB,cAAc,IAAI,KAAK,CAAC,WAAW;AAErE,YAAA,KAAK,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,EAAE;;;;;AAKpE,gBAAA,IAAI,CAAC,IAAI,CAAC,mBAAmB,IAAI,WAAW,EAAE;;;;;;oBAM5C,MAAM,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC;oBACzC,MAAM,SAAS,GAAG,gBAAgB,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC,GAAG,GAAG;AAC9E,oBAAA,IAAI,CAACC,eAAe,CAAC,WAAW,EAAE,SAAS,CAAC;wBAAE;;gBAGhD,MAAM,UAAU,GAAG,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC;gBACpD,IAAI,WAAW,GAAQ,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;gBAEjD,IAAI,WAAW,KAAK,WAAW,IAAI,WAAW,IAAI,IAAI,EAAE;AACtD,oBAAA,IAAI;wBACF,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAY,CAAC,WAAW,CAAC;wBACtD,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,gBAAiB,CAAC,MAAM,EAAE,GAAG,CAAC;;AAC1D,oBAAA,MAAM;wBACN,OAAO,SAAS,KAAK,WAAW;4BAC9B,SAAS;4BACT,OAAO,CAAC,KAAK,CACX,CAAA,sCAAA,EAAyC,UAAU,CAAiF,+EAAA,CAAA,EACpI,WAAW,CACZ;wBAEH,WAAW,GAAG,EAAE;;oBAGlB,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,IAAG;AAC3C,wBAAA,MAAM,YAAY,GAChB,QAAQ,CAAC,OAAO,KAAK,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,UAAU,IAAI,SAAS,CAAC;AAC9E,wBAAA,MAAM,QAAQ,GACZ,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,IAAI,CAAC,mBAAmB,KAAK,QAAQ,CAAC,GAAG,KAAK,GAAG;AACrE,wBAAA,IAAI,YAAY,IAAI,QAAQ,EAAE;AAC5B,4BAAA,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC;4BAC3C,YAAY,GAAG,IAAI;;AAEvB,qBAAC,CAAC;AAEF,oBAAA,IAAI,IAAI,CAAC,mBAAmB,EAAE;wBAC5B,WAAW,GAAG,IAAI,CAAC,2BAA2B,CAAC,WAAW,EAAE,WAAW,CAAC;wBACxE,KAAK,GAAG,EAAE,GAAG,KAAK,EAAE,GAAG,WAAW,EAAE;;yBAC/B;wBACL,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,WAAW,CAAC;;;;;AAMjD,QAAA,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,CAC5B,GAAG,CAAC,SAAS,IAAG;AACd,YAAA,IAAI,oBAAoB,IAAI,CAAC,YAAY,EAAE;gBACzC;;AAGF,YAAA,KAAK,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,EAAE;gBACpE,IAAI,WAAW,GAAG,SAAS;gBAE3B,MAAM,UAAU,GAAG,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC;AAEpD,gBAAA,IAAI,GAAG,KAAKL,kBAAkB,EAAE;AAC9B,oBAAA,WAAW,GAAG,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC;;AAGxC,gBAAA,IAAI;AACF,oBAAA,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,GAAG,CAAC;AACvE,oBAAA,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAU,CAAC,cAAc,CAAC,CAAC;;gBACpE,OAAO,KAAU,EAAE;AACnB,oBAAA,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE;AACjD,wBAAA,IACE,KAAK;AACL,6BAAC,KAAK,CAAC,IAAI,KAAK,oBAAoB;AAClC,gCAAA,KAAK,CAAC,IAAI,KAAK,4BAA4B,CAAC,EAC9C;4BACA,OAAO,CAAC,KAAK,CACX,CAAA,IAAA,EAAO,UAAU,CAAkD,gDAAA,CAAA,EACnE,WAAW,CACZ;;6BACI;4BACL,OAAO,CAAC,KAAK,CACX,CAAA,oCAAA,EAAuC,UAAU,CAAsE,oEAAA,CAAA,EACvH,WAAW,CACZ;;;;;SAKV,CAAC,CACH;;IAGK,2BAA2B,CAAC,WAAgB,EAAE,WAAyB,EAAA;;;;;;;;;;AAW7E,QAAA,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;;AAEzE,YAAA,OAAO,WAAW;;;;;;;;;AAUpB,QAAA,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CACpC,CAAC,WAAW,EAAE,UAAU,KAAI;AAC1B,YAAA,IAAIK,eAAe,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE;gBAC5C,WAAW,CAAC,UAAU,CAAC,GAAG,WAAW,CAAC,UAAU,CAAC;;AAEnD,YAAA,OAAO,WAAW;SACnB,EACa,EAAE,CACjB;;0HAnJQ,iBAAiB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA;8HAAjB,iBAAiB,EAAA,CAAA;;2FAAjB,iBAAiB,EAAA,UAAA,EAAA,CAAA;kBAD7B;;AAwJD,MAAM,GAAG,GAAG,GAAG;;MC9JF,uBAAuB,CAAA;IAClC,OAAO,OAAO,CACZ,OAAiC,EAAA;QAEjC,OAAO;AACL,YAAA,QAAQ,EAAE,uBAAuB;AACjC,YAAA,SAAS,EAAE;gBACT,cAAc,CAAC,iBAAiB,CAAC;AACjC,gBAAA;AACE,oBAAA,OAAO,EAAEC,aAAa;AACtB,oBAAA,QAAQ,EAAE;AACX,iBAAA;AACD,gBAAA;AACE,oBAAA,OAAO,EAAEL,4BAA4B;AACrC,oBAAA,UAAU,EAAE,qBAAqB;oBACjC,IAAI,EAAE,CAACK,aAAa;AACrB,iBAAA;AACD,gBAAA;AACE,oBAAA,OAAO,EAAE,cAAc;AACvB,oBAAA,UAAU,EAAE,aAAa;oBACzB,IAAI,EAAE,CAACL,4BAA4B;AACpC;AACF;SACF;;0HAvBQ,uBAAuB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,QAAA,EAAA,CAAA;2HAAvB,uBAAuB,EAAA,CAAA;2HAAvB,uBAAuB,EAAA,CAAA;;2FAAvB,uBAAuB,EAAA,UAAA,EAAA,CAAA;kBADnC;;AA4BK,SAAU,qBAAqB,CACnC,OAAiC,EAAA;AAEjC,IAAA,OAAO,wBAAwB,CAAC;QAC9B,cAAc,CAAC,iBAAiB,CAAC;AACjC,QAAA;AACE,YAAA,OAAO,EAAEK,aAAa;AACtB,YAAA,QAAQ,EAAE;AACX,SAAA;AACD,QAAA;AACE,YAAA,OAAO,EAAEL,4BAA4B;AACrC,YAAA,UAAU,EAAE,qBAAqB;YACjC,IAAI,EAAE,CAACK,aAAa;AACrB,SAAA;AACD,QAAA;AACE,YAAA,OAAO,EAAE,cAAc;AACvB,YAAA,UAAU,EAAE,aAAa;YACzB,IAAI,EAAE,CAACL,4BAA4B;AACpC;AACF,KAAA,CAAC;AACJ;;AC1DM,SAAU,kBAAkB,CAAC,WAAyB,EAAA;IAC1D,OAAO,6BAA6B,CAAC,MAAK;AACxC,QAAA,MAAM,kBAAkB,GAAG,MAAM,CAACG,qBAAqB,CAAC;QAExD,IAAI,kBAAkB,EAAE;AACtB,YAAA,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE;gBACjD,MAAM,OAAO,GACX,gFAAgF;oBAChF,qFAAqF;AACrF,oBAAA,kFAAkF;AAEpF,gBAAA,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;;;;;;YAOxB;;QAGF,MAAM,CAAC,6BAA6B,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;AAC5D,KAAC,CAAC;AACJ;;MCxBa,oBAAoB,mBAAmB,IAAI,cAAc,CACpE,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,GAAG,sBAAsB,GAAG,EAAE,EAC3E;AACE,IAAA,UAAU,EAAE,MAAM;AAClB,IAAA,OAAO,EAAE,OAAO,OAAO,YAAY,KAAK,WAAW,IAAI,YAAY,GAAG,IAAI,GAAG,YAAY;AAC1F,CAAA;MAGU,sBAAsB,mBAAmB,IAAI,cAAc,CACtE,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,GAAG,wBAAwB,GAAG,EAAE,EAC7E;AACE,IAAA,UAAU,EAAE,MAAM;AAClB,IAAA,OAAO,EAAE,MACP,OAAO,YAAY,KAAK,WAAW,IAAI,YAAY,GAAG,IAAI,GAAG;AAChE,CAAA;;ACpBH;;AAEG;;ACFH;;AAEG;;;;"}
|
package/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as i0 from '@angular/core';
|
|
2
|
-
import { ModuleWithProviders, EnvironmentProviders
|
|
3
|
-
import { NgxsStoragePluginOptions, StorageKey
|
|
2
|
+
import { InjectionToken, ModuleWithProviders, EnvironmentProviders } from '@angular/core';
|
|
3
|
+
import { StorageEngine, NgxsStoragePluginOptions, StorageKey } from '@ngxs/storage-plugin/internals';
|
|
4
4
|
export { NgxsStoragePluginOptions, STORAGE_ENGINE, StorageEngine, StorageOption } from '@ngxs/storage-plugin/internals';
|
|
5
5
|
import { NgxsPlugin, NgxsNextPluginFn } from '@ngxs/store/plugins';
|
|
6
6
|
|
|
@@ -18,7 +18,6 @@ declare class NgxsStoragePlugin implements NgxsPlugin {
|
|
|
18
18
|
private _keysManager;
|
|
19
19
|
private _options;
|
|
20
20
|
private _allStatesPersisted;
|
|
21
|
-
private _isServer;
|
|
22
21
|
handle(state: any, event: any, next: NgxsNextPluginFn): any;
|
|
23
22
|
private _hydrateSelectivelyOnUpdate;
|
|
24
23
|
static ɵfac: i0.ɵɵFactoryDeclaration<NgxsStoragePlugin, never>;
|
package/internals/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { InjectionToken, Type } from '@angular/core';
|
|
2
2
|
import { StateToken } from '@ngxs/store';
|
|
3
3
|
import { ɵStateClass as _StateClass } from '@ngxs/store/internals';
|
|
4
4
|
|
|
@@ -21,7 +21,7 @@ declare function ɵextractStringKey(storageKey: StorageKey): string;
|
|
|
21
21
|
* state when no specific state is provided.
|
|
22
22
|
*/
|
|
23
23
|
declare const ɵDEFAULT_STATE_KEY = "@@STATE";
|
|
24
|
-
declare
|
|
24
|
+
declare enum StorageOption {
|
|
25
25
|
LocalStorage = 0,
|
|
26
26
|
SessionStorage = 1
|
|
27
27
|
}
|
|
@@ -92,4 +92,5 @@ interface StorageEngine {
|
|
|
92
92
|
setItem(key: string, value: any): void;
|
|
93
93
|
}
|
|
94
94
|
|
|
95
|
-
export {
|
|
95
|
+
export { STORAGE_ENGINE, StorageOption, ɵALL_STATES_PERSISTED, ɵDEFAULT_STATE_KEY, ɵNGXS_STORAGE_PLUGIN_OPTIONS, ɵUSER_OPTIONS, ɵextractStringKey, ɵisKeyWithExplicitEngine };
|
|
96
|
+
export type { KeyWithExplicitEngine, NgxsStoragePluginOptions, StorageEngine, StorageKey, ɵNgxsTransformedStoragePluginOptions };
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ngxs/storage-plugin",
|
|
3
3
|
"description": "extendable storage plugin for @ngxs/store",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "20.0.0-dev.master-0db0003",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"peerDependencies": {
|
|
7
|
-
"@
|
|
8
|
-
"@
|
|
9
|
-
"rxjs": ">=
|
|
7
|
+
"@angular/core": ">=20.0.0 <21.0.0",
|
|
8
|
+
"@ngxs/store": "^20.0.0 || ^20.0.0-dev",
|
|
9
|
+
"rxjs": ">=7.0.0",
|
|
10
10
|
"ts-morph": "21.0.1"
|
|
11
11
|
},
|
|
12
12
|
"schematics": "./schematics/collection.json",
|
|
@@ -72,4 +72,4 @@
|
|
|
72
72
|
"type": "opencollective",
|
|
73
73
|
"url": "https://opencollective.com/ngxs"
|
|
74
74
|
}
|
|
75
|
-
}
|
|
75
|
+
}
|
package/internals/package.json
DELETED