@ngxs/storage-plugin 3.8.1-dev.master-db96f65 → 3.8.1-dev.master-bb36826
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/esm2020/internals/storage-key.mjs +4 -5
- package/fesm2015/ngxs-storage-plugin-internals.mjs +3 -4
- package/fesm2015/ngxs-storage-plugin-internals.mjs.map +1 -1
- package/fesm2020/ngxs-storage-plugin-internals.mjs +3 -4
- package/fesm2020/ngxs-storage-plugin-internals.mjs.map +1 -1
- package/internals/storage-key.d.ts +3 -3
- package/package.json +1 -1
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
import { StateToken } from '@ngxs/store';
|
|
2
|
+
import { ɵMETA_OPTIONS_KEY } from '@ngxs/store/internals';
|
|
2
3
|
/** Determines whether the provided key has the following structure. */
|
|
3
4
|
export function ɵisKeyWithExplicitEngine(key) {
|
|
4
5
|
return key != null && !!key.engine;
|
|
5
6
|
}
|
|
6
|
-
/** This symbol is used to store the metadata on state classes. */
|
|
7
|
-
const META_OPTIONS_KEY = 'NGXS_OPTIONS_META';
|
|
8
7
|
export function ɵextractStringKey(storageKey) {
|
|
9
8
|
// Extract the actual key out of the `{ key, engine }` structure.
|
|
10
9
|
if (ɵisKeyWithExplicitEngine(storageKey)) {
|
|
@@ -13,9 +12,9 @@ export function ɵextractStringKey(storageKey) {
|
|
|
13
12
|
// Given the `storageKey` is a class, for instance, `AuthState`.
|
|
14
13
|
// We should retrieve its metadata and the `name` property.
|
|
15
14
|
// The `name` property might be a string (state name) or a state token.
|
|
16
|
-
if (storageKey.hasOwnProperty(META_OPTIONS_KEY)) {
|
|
17
|
-
storageKey = storageKey[META_OPTIONS_KEY].name;
|
|
15
|
+
if (storageKey.hasOwnProperty(ɵMETA_OPTIONS_KEY)) {
|
|
16
|
+
storageKey = storageKey[ɵMETA_OPTIONS_KEY].name;
|
|
18
17
|
}
|
|
19
18
|
return storageKey instanceof StateToken ? storageKey.getName() : storageKey;
|
|
20
19
|
}
|
|
21
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
20
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RvcmFnZS1rZXkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9wYWNrYWdlcy9zdG9yYWdlLXBsdWdpbi9pbnRlcm5hbHMvc3JjL3N0b3JhZ2Uta2V5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sRUFBRSxVQUFVLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFDekMsT0FBTyxFQUFFLGlCQUFpQixFQUFlLE1BQU0sdUJBQXVCLENBQUM7QUFVdkUsdUVBQXVFO0FBQ3ZFLE1BQU0sVUFBVSx3QkFBd0IsQ0FBQyxHQUFRO0lBQy9DLE9BQU8sR0FBRyxJQUFJLElBQUksSUFBSSxDQUFDLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQztBQUNyQyxDQUFDO0FBUUQsTUFBTSxVQUFVLGlCQUFpQixDQUFDLFVBQXNCO0lBQ3RELGlFQUFpRTtJQUNqRSxJQUFJLHdCQUF3QixDQUFDLFVBQVUsQ0FBQyxFQUFFO1FBQ3hDLFVBQVUsR0FBRyxVQUFVLENBQUMsR0FBRyxDQUFDO0tBQzdCO0lBRUQsZ0VBQWdFO0lBQ2hFLDJEQUEyRDtJQUMzRCx1RUFBdUU7SUFDdkUsSUFBSSxVQUFVLENBQUMsY0FBYyxDQUFDLGlCQUFpQixDQUFDLEVBQUU7UUFDaEQsVUFBVSxHQUFJLFVBQWtCLENBQUMsaUJBQWlCLENBQUMsQ0FBQyxJQUFJLENBQUM7S0FDMUQ7SUFFRCxPQUFPLFVBQVUsWUFBWSxVQUFVLENBQUMsQ0FBQyxDQUFDLFVBQVUsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxDQUFDLENBQVMsVUFBVSxDQUFDO0FBQ3RGLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBJbmplY3Rpb25Ub2tlbiwgVHlwZSB9IGZyb20gJ0Bhbmd1bGFyL2NvcmUnO1xuaW1wb3J0IHsgU3RhdGVUb2tlbiB9IGZyb20gJ0BuZ3hzL3N0b3JlJztcbmltcG9ydCB7IMm1TUVUQV9PUFRJT05TX0tFWSwgybVTdGF0ZUNsYXNzIH0gZnJvbSAnQG5neHMvc3RvcmUvaW50ZXJuYWxzJztcblxuaW1wb3J0IHsgU3RvcmFnZUVuZ2luZSB9IGZyb20gJy4vc3ltYm9scyc7XG5cbi8qKiBUaGlzIGVuYWJsZXMgdGhlIHVzZXIgdG8gcHJvdmlkZSBhIHN0b3JhZ2UgZW5naW5lIHBlciBpbmRpdmlkdWFsIGtleS4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgS2V5V2l0aEV4cGxpY2l0RW5naW5lIHtcbiAga2V5OiBzdHJpbmcgfCDJtVN0YXRlQ2xhc3MgfCBTdGF0ZVRva2VuPGFueT47XG4gIGVuZ2luZTogVHlwZTxTdG9yYWdlRW5naW5lPiB8IEluamVjdGlvblRva2VuPFN0b3JhZ2VFbmdpbmU+O1xufVxuXG4vKiogRGV0ZXJtaW5lcyB3aGV0aGVyIHRoZSBwcm92aWRlZCBrZXkgaGFzIHRoZSBmb2xsb3dpbmcgc3RydWN0dXJlLiAqL1xuZXhwb3J0IGZ1bmN0aW9uIMm1aXNLZXlXaXRoRXhwbGljaXRFbmdpbmUoa2V5OiBhbnkpOiBrZXkgaXMgS2V5V2l0aEV4cGxpY2l0RW5naW5lIHtcbiAgcmV0dXJuIGtleSAhPSBudWxsICYmICEha2V5LmVuZ2luZTtcbn1cblxuLyoqXG4gKiBUaGlzIHR1cGxlcyBhbGwgb2YgdGhlIHBvc3NpYmxlIHR5cGVzIGFsbG93ZWQgaW4gdGhlIGBrZXlgIHByb3BlcnR5LlxuICogVGhpcyBpcyBub3QgZXhwb3NlZCBwdWJsaWNseSBhbmQgdXNlZCBpbnRlcm5hbGx5IG9ubHkuXG4gKi9cbmV4cG9ydCB0eXBlIFN0b3JhZ2VLZXkgPSBzdHJpbmcgfCDJtVN0YXRlQ2xhc3MgfCBTdGF0ZVRva2VuPGFueT4gfCBLZXlXaXRoRXhwbGljaXRFbmdpbmU7XG5cbmV4cG9ydCBmdW5jdGlvbiDJtWV4dHJhY3RTdHJpbmdLZXkoc3RvcmFnZUtleTogU3RvcmFnZUtleSk6IHN0cmluZyB7XG4gIC8vIEV4dHJhY3QgdGhlIGFjdHVhbCBrZXkgb3V0IG9mIHRoZSBgeyBrZXksIGVuZ2luZSB9YCBzdHJ1Y3R1cmUuXG4gIGlmICjJtWlzS2V5V2l0aEV4cGxpY2l0RW5naW5lKHN0b3JhZ2VLZXkpKSB7XG4gICAgc3RvcmFnZUtleSA9IHN0b3JhZ2VLZXkua2V5O1xuICB9XG5cbiAgLy8gR2l2ZW4gdGhlIGBzdG9yYWdlS2V5YCBpcyBhIGNsYXNzLCBmb3IgaW5zdGFuY2UsIGBBdXRoU3RhdGVgLlxuICAvLyBXZSBzaG91bGQgcmV0cmlldmUgaXRzIG1ldGFkYXRhIGFuZCB0aGUgYG5hbWVgIHByb3BlcnR5LlxuICAvLyBUaGUgYG5hbWVgIHByb3BlcnR5IG1pZ2h0IGJlIGEgc3RyaW5nIChzdGF0ZSBuYW1lKSBvciBhIHN0YXRlIHRva2VuLlxuICBpZiAoc3RvcmFnZUtleS5oYXNPd25Qcm9wZXJ0eSjJtU1FVEFfT1BUSU9OU19LRVkpKSB7XG4gICAgc3RvcmFnZUtleSA9IChzdG9yYWdlS2V5IGFzIGFueSlbybVNRVRBX09QVElPTlNfS0VZXS5uYW1lO1xuICB9XG5cbiAgcmV0dXJuIHN0b3JhZ2VLZXkgaW5zdGFuY2VvZiBTdGF0ZVRva2VuID8gc3RvcmFnZUtleS5nZXROYW1lKCkgOiA8c3RyaW5nPnN0b3JhZ2VLZXk7XG59XG4iXX0=
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { InjectionToken } from '@angular/core';
|
|
2
2
|
import { StateToken } from '@ngxs/store';
|
|
3
|
+
import { ɵMETA_OPTIONS_KEY } from '@ngxs/store/internals';
|
|
3
4
|
|
|
4
5
|
/**
|
|
5
6
|
* The following key is used to store the entire serialized
|
|
@@ -14,8 +15,6 @@ const STORAGE_ENGINE = new InjectionToken(NG_DEV_MODE$1 ? 'STORAGE_ENGINE' : '')
|
|
|
14
15
|
function ɵisKeyWithExplicitEngine(key) {
|
|
15
16
|
return key != null && !!key.engine;
|
|
16
17
|
}
|
|
17
|
-
/** This symbol is used to store the metadata on state classes. */
|
|
18
|
-
const META_OPTIONS_KEY = 'NGXS_OPTIONS_META';
|
|
19
18
|
function ɵextractStringKey(storageKey) {
|
|
20
19
|
// Extract the actual key out of the `{ key, engine }` structure.
|
|
21
20
|
if (ɵisKeyWithExplicitEngine(storageKey)) {
|
|
@@ -24,8 +23,8 @@ function ɵextractStringKey(storageKey) {
|
|
|
24
23
|
// Given the `storageKey` is a class, for instance, `AuthState`.
|
|
25
24
|
// We should retrieve its metadata and the `name` property.
|
|
26
25
|
// The `name` property might be a string (state name) or a state token.
|
|
27
|
-
if (storageKey.hasOwnProperty(META_OPTIONS_KEY)) {
|
|
28
|
-
storageKey = storageKey[META_OPTIONS_KEY].name;
|
|
26
|
+
if (storageKey.hasOwnProperty(ɵMETA_OPTIONS_KEY)) {
|
|
27
|
+
storageKey = storageKey[ɵMETA_OPTIONS_KEY].name;
|
|
29
28
|
}
|
|
30
29
|
return storageKey instanceof StateToken ? storageKey.getName() : storageKey;
|
|
31
30
|
}
|
|
@@ -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/final-options.ts","../../../packages/storage-plugin/internals/src/ngxs-storage-plugin-internals.ts"],"sourcesContent":["import { InjectionToken } 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\nconst NG_DEV_MODE = typeof ngDevMode === 'undefined' || ngDevMode;\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(\n NG_DEV_MODE ? 'NGXS_STORAGE_PLUGIN_OPTIONS' : ''\n);\n\nexport const STORAGE_ENGINE = new InjectionToken<StorageEngine>(\n NG_DEV_MODE ? '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 {
|
|
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/final-options.ts","../../../packages/storage-plugin/internals/src/ngxs-storage-plugin-internals.ts"],"sourcesContent":["import { InjectionToken } 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\nconst NG_DEV_MODE = typeof ngDevMode === 'undefined' || ngDevMode;\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(\n NG_DEV_MODE ? 'NGXS_STORAGE_PLUGIN_OPTIONS' : ''\n);\n\nexport const STORAGE_ENGINE = new InjectionToken<StorageEngine>(\n NG_DEV_MODE ? '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 { ɵ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 != 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\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 (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 { NgxsStoragePluginOptions, STORAGE_ENGINE, StorageEngine } from './symbols';\nimport { StorageKey, ɵextractStringKey, ɵisKeyWithExplicitEngine } from './storage-key';\n\nexport interface ɵFinalNgxsStoragePluginOptions extends NgxsStoragePluginOptions {\n keysWithEngines: {\n key: string;\n engine: StorageEngine;\n }[];\n}\n\ndeclare const ngDevMode: boolean;\n\nconst NG_DEV_MODE = typeof ngDevMode === 'undefined' || ngDevMode;\n\nexport const ɵFINAL_NGXS_STORAGE_PLUGIN_OPTIONS = new InjectionToken<unknown>(\n NG_DEV_MODE ? 'FINAL_NGXS_STORAGE_PLUGIN_OPTIONS' : ''\n);\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 = ɵextractStringKey(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","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":["NG_DEV_MODE"],"mappings":";;;;AAIA;;;AAGG;AACI,MAAM,kBAAkB,GAAG,UAAU;AAI5C,MAAMA,aAAW,GAAG,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,CAAC;AAyErD,MAAA,4BAA4B,GAAG,IAAI,cAAc,CAC5DA,aAAW,GAAG,6BAA6B,GAAG,EAAE,EAChD;AAEW,MAAA,cAAc,GAAG,IAAI,cAAc,CAC9CA,aAAW,GAAG,gBAAgB,GAAG,EAAE;;AC9ErC;AACM,SAAU,wBAAwB,CAAC,GAAQ,EAAA;IAC/C,OAAO,GAAG,IAAI,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;AACrC,CAAC;AAQK,SAAU,iBAAiB,CAAC,UAAsB,EAAA;;AAEtD,IAAA,IAAI,wBAAwB,CAAC,UAAU,CAAC,EAAE;AACxC,QAAA,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC;AAC7B,KAAA;;;;AAKD,IAAA,IAAI,UAAU,CAAC,cAAc,CAAC,iBAAiB,CAAC,EAAE;AAChD,QAAA,UAAU,GAAI,UAAkB,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC;AAC1D,KAAA;AAED,IAAA,OAAO,UAAU,YAAY,UAAU,GAAG,UAAU,CAAC,OAAO,EAAE,GAAW,UAAU,CAAC;AACtF;;ACvBA,MAAM,WAAW,GAAG,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,CAAC;AAErD,MAAA,kCAAkC,GAAG,IAAI,cAAc,CAClE,WAAW,GAAG,mCAAmC,GAAG,EAAE,EACtD;AAEc,SAAA,gCAAgC,CAC9C,QAAkB,EAClB,OAAiC,EAAA;IAEjC,MAAM,WAAW,GAAiB,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,GAAI,CAAC,CAAC;IAE5F,MAAM,eAAe,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,UAAsB,KAAI;AACjE,QAAA,MAAM,GAAG,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;AAC1C,QAAA,MAAM,MAAM,GAAG,wBAAwB,CAAC,UAAU,CAAC;cAC/C,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC;AACjC,cAAE,QAAQ,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;AACjC,QAAA,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;AACzB,KAAC,CAAC,CAAC;IAEH,OACK,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,EAAA,EAAA,OAAO,CACV,EAAA,EAAA,eAAe,EACf,CAAA,CAAA;AACJ;;ACtCA;;AAEG;;;;"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { InjectionToken } from '@angular/core';
|
|
2
2
|
import { StateToken } from '@ngxs/store';
|
|
3
|
+
import { ɵMETA_OPTIONS_KEY } from '@ngxs/store/internals';
|
|
3
4
|
|
|
4
5
|
/**
|
|
5
6
|
* The following key is used to store the entire serialized
|
|
@@ -14,8 +15,6 @@ const STORAGE_ENGINE = new InjectionToken(NG_DEV_MODE$1 ? 'STORAGE_ENGINE' : '')
|
|
|
14
15
|
function ɵisKeyWithExplicitEngine(key) {
|
|
15
16
|
return key != null && !!key.engine;
|
|
16
17
|
}
|
|
17
|
-
/** This symbol is used to store the metadata on state classes. */
|
|
18
|
-
const META_OPTIONS_KEY = 'NGXS_OPTIONS_META';
|
|
19
18
|
function ɵextractStringKey(storageKey) {
|
|
20
19
|
// Extract the actual key out of the `{ key, engine }` structure.
|
|
21
20
|
if (ɵisKeyWithExplicitEngine(storageKey)) {
|
|
@@ -24,8 +23,8 @@ function ɵextractStringKey(storageKey) {
|
|
|
24
23
|
// Given the `storageKey` is a class, for instance, `AuthState`.
|
|
25
24
|
// We should retrieve its metadata and the `name` property.
|
|
26
25
|
// The `name` property might be a string (state name) or a state token.
|
|
27
|
-
if (storageKey.hasOwnProperty(META_OPTIONS_KEY)) {
|
|
28
|
-
storageKey = storageKey[META_OPTIONS_KEY].name;
|
|
26
|
+
if (storageKey.hasOwnProperty(ɵMETA_OPTIONS_KEY)) {
|
|
27
|
+
storageKey = storageKey[ɵMETA_OPTIONS_KEY].name;
|
|
29
28
|
}
|
|
30
29
|
return storageKey instanceof StateToken ? storageKey.getName() : storageKey;
|
|
31
30
|
}
|
|
@@ -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/final-options.ts","../../../packages/storage-plugin/internals/src/ngxs-storage-plugin-internals.ts"],"sourcesContent":["import { InjectionToken } 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\nconst NG_DEV_MODE = typeof ngDevMode === 'undefined' || ngDevMode;\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(\n NG_DEV_MODE ? 'NGXS_STORAGE_PLUGIN_OPTIONS' : ''\n);\n\nexport const STORAGE_ENGINE = new InjectionToken<StorageEngine>(\n NG_DEV_MODE ? '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 {
|
|
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/final-options.ts","../../../packages/storage-plugin/internals/src/ngxs-storage-plugin-internals.ts"],"sourcesContent":["import { InjectionToken } 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\nconst NG_DEV_MODE = typeof ngDevMode === 'undefined' || ngDevMode;\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(\n NG_DEV_MODE ? 'NGXS_STORAGE_PLUGIN_OPTIONS' : ''\n);\n\nexport const STORAGE_ENGINE = new InjectionToken<StorageEngine>(\n NG_DEV_MODE ? '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 { ɵ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 != 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\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 (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 { NgxsStoragePluginOptions, STORAGE_ENGINE, StorageEngine } from './symbols';\nimport { StorageKey, ɵextractStringKey, ɵisKeyWithExplicitEngine } from './storage-key';\n\nexport interface ɵFinalNgxsStoragePluginOptions extends NgxsStoragePluginOptions {\n keysWithEngines: {\n key: string;\n engine: StorageEngine;\n }[];\n}\n\ndeclare const ngDevMode: boolean;\n\nconst NG_DEV_MODE = typeof ngDevMode === 'undefined' || ngDevMode;\n\nexport const ɵFINAL_NGXS_STORAGE_PLUGIN_OPTIONS = new InjectionToken<unknown>(\n NG_DEV_MODE ? 'FINAL_NGXS_STORAGE_PLUGIN_OPTIONS' : ''\n);\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 = ɵextractStringKey(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","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":["NG_DEV_MODE"],"mappings":";;;;AAIA;;;AAGG;AACI,MAAM,kBAAkB,GAAG,UAAU;AAI5C,MAAMA,aAAW,GAAG,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,CAAC;AAyErD,MAAA,4BAA4B,GAAG,IAAI,cAAc,CAC5DA,aAAW,GAAG,6BAA6B,GAAG,EAAE,EAChD;AAEW,MAAA,cAAc,GAAG,IAAI,cAAc,CAC9CA,aAAW,GAAG,gBAAgB,GAAG,EAAE;;AC9ErC;AACM,SAAU,wBAAwB,CAAC,GAAQ,EAAA;IAC/C,OAAO,GAAG,IAAI,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;AACrC,CAAC;AAQK,SAAU,iBAAiB,CAAC,UAAsB,EAAA;;AAEtD,IAAA,IAAI,wBAAwB,CAAC,UAAU,CAAC,EAAE;AACxC,QAAA,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC;AAC7B,KAAA;;;;AAKD,IAAA,IAAI,UAAU,CAAC,cAAc,CAAC,iBAAiB,CAAC,EAAE;AAChD,QAAA,UAAU,GAAI,UAAkB,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC;AAC1D,KAAA;AAED,IAAA,OAAO,UAAU,YAAY,UAAU,GAAG,UAAU,CAAC,OAAO,EAAE,GAAW,UAAU,CAAC;AACtF;;ACvBA,MAAM,WAAW,GAAG,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,CAAC;AAErD,MAAA,kCAAkC,GAAG,IAAI,cAAc,CAClE,WAAW,GAAG,mCAAmC,GAAG,EAAE,EACtD;AAEc,SAAA,gCAAgC,CAC9C,QAAkB,EAClB,OAAiC,EAAA;IAEjC,MAAM,WAAW,GAAiB,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,GAAI,CAAC,CAAC;IAE5F,MAAM,eAAe,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,UAAsB,KAAI;AACjE,QAAA,MAAM,GAAG,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;AAC1C,QAAA,MAAM,MAAM,GAAG,wBAAwB,CAAC,UAAU,CAAC;cAC/C,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC;AACjC,cAAE,QAAQ,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;AACjC,QAAA,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;AACzB,KAAC,CAAC,CAAC;IAEH,OAAO;AACL,QAAA,GAAG,OAAO;QACV,eAAe;KAChB,CAAC;AACJ;;ACtCA;;AAEG;;;;"}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { InjectionToken, Type } from '@angular/core';
|
|
2
2
|
import { StateToken } from '@ngxs/store';
|
|
3
|
-
import {
|
|
3
|
+
import { ɵStateClass } from '@ngxs/store/internals';
|
|
4
4
|
import { StorageEngine } from './symbols';
|
|
5
5
|
/** This enables the user to provide a storage engine per individual key. */
|
|
6
6
|
export interface KeyWithExplicitEngine {
|
|
7
|
-
key: string |
|
|
7
|
+
key: string | ɵStateClass | StateToken<any>;
|
|
8
8
|
engine: Type<StorageEngine> | InjectionToken<StorageEngine>;
|
|
9
9
|
}
|
|
10
10
|
/** Determines whether the provided key has the following structure. */
|
|
@@ -13,5 +13,5 @@ export declare function ɵisKeyWithExplicitEngine(key: any): key is KeyWithExpli
|
|
|
13
13
|
* This tuples all of the possible types allowed in the `key` property.
|
|
14
14
|
* This is not exposed publicly and used internally only.
|
|
15
15
|
*/
|
|
16
|
-
export declare type StorageKey = string |
|
|
16
|
+
export declare type StorageKey = string | ɵStateClass | StateToken<any> | KeyWithExplicitEngine;
|
|
17
17
|
export declare function ɵextractStringKey(storageKey: StorageKey): string;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ngxs/storage-plugin",
|
|
3
3
|
"description": "extendable storage plugin for @ngxs/store",
|
|
4
|
-
"version": "3.8.1-dev.master-
|
|
4
|
+
"version": "3.8.1-dev.master-bb36826",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"peerDependencies": {
|
|
7
7
|
"@angular/core": ">=12.0.0 <17.0.0",
|