@ngxs/storage-plugin 3.7.5-dev.master-66b90a9 → 3.7.5-dev.master-27cb95c
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bundles/ngxs-storage-plugin.umd.js +31 -10
- package/bundles/ngxs-storage-plugin.umd.js.map +1 -1
- package/bundles/ngxs-storage-plugin.umd.min.js +1 -1
- package/bundles/ngxs-storage-plugin.umd.min.js.map +1 -1
- package/esm2015/src/internals.js +11 -1
- package/esm2015/src/storage.plugin.js +15 -11
- package/esm2015/src/symbols.js +9 -2
- package/esm5/src/internals.js +11 -1
- package/esm5/src/storage.plugin.js +15 -11
- package/esm5/src/symbols.js +9 -2
- package/fesm2015/ngxs-storage-plugin.js +31 -10
- package/fesm2015/ngxs-storage-plugin.js.map +1 -1
- package/fesm5/ngxs-storage-plugin.js +31 -10
- package/fesm5/ngxs-storage-plugin.js.map +1 -1
- package/ngxs-storage-plugin.metadata.json +1 -1
- package/package.json +1 -1
- package/src/internals.d.ts +1 -0
- package/src/symbols.d.ts +7 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ngxs-storage-plugin.js","sources":["ng://@ngxs/storage-plugin/src/symbols.ts","ng://@ngxs/storage-plugin/src/internals.ts","ng://@ngxs/storage-plugin/src/storage.plugin.ts","ng://@ngxs/storage-plugin/src/storage.module.ts"],"sourcesContent":["import { InjectionToken } from '@angular/core';\n\nimport { StorageKey } from './internals';\n\nexport const enum StorageOption {\n LocalStorage,\n SessionStorage\n}\n\nexport interface NgxsStoragePluginOptions {\n /**\n * Key for the state slice to store in the storage engine.\n */\n key?: undefined | StorageKey;\n\n /**\n * Storage engine to use. Deaults to localStorage but can provide\n *\n * sessionStorage or custom implementation of the StorageEngine interface\n */\n storage?: StorageOption;\n\n /**\n * Migration strategies.\n */\n migrations?: {\n /**\n * Version to key off.\n */\n version: number | string;\n\n /**\n * Method to migrate the previous state.\n */\n migrate: (state: any) => any;\n\n /**\n * Key to migrate.\n */\n key?: string;\n\n /**\n * Key for the version. Defaults to 'version'.\n */\n versionKey?: string;\n }[];\n\n /**\n * Serailizer for the object before its pushed into the engine.\n */\n serialize?(obj: any): string;\n\n /**\n * Deserializer for the object before its pulled out of the engine.\n */\n deserialize?(obj: any): any;\n\n /**\n * Method to alter object before serialization.\n */\n beforeSerialize?(obj: any, key: string): any;\n\n /**\n * Method to alter object after deserialization.\n */\n afterDeserialize?(obj: any, key: string): any;\n}\n\nexport const NGXS_STORAGE_PLUGIN_OPTIONS = new InjectionToken('NGXS_STORAGE_PLUGIN_OPTION');\n\nexport const STORAGE_ENGINE = new InjectionToken('STORAGE_ENGINE');\n\nexport interface StorageEngine {\n readonly length: number;\n getItem(key: string): any;\n setItem(key: string, val: any): void;\n removeItem(key: string): void;\n clear(): void;\n}\n","import { isPlatformServer } from '@angular/common';\nimport { StateClass } from '@ngxs/store/internals';\nimport { StateToken } from '@ngxs/store';\n\nimport { StorageOption, StorageEngine, NgxsStoragePluginOptions } from './symbols';\n\n/**\n * If the `key` option is not provided then the below constant\n * will be used as a default key\n */\nexport const DEFAULT_STATE_KEY = '@@STATE';\n\n/**\n * Internal type definition for the `key` option provided\n * in the `forRoot` method when importing module\n */\nexport type StorageKey =\n | string\n | StateClass\n | StateToken<any>\n | (string | StateClass | StateToken<any>)[];\n\n/**\n * This key is used to retrieve static metadatas on state classes.\n * This constant is taken from the core codebase\n */\nconst META_OPTIONS_KEY = 'NGXS_OPTIONS_META';\n\nfunction transformKeyOption(key: StorageKey): string[] {\n if (!Array.isArray(key)) {\n key = [key];\n }\n\n return key.map((token: string | StateClass | StateToken<any>) => {\n // If it has the `NGXS_OPTIONS_META` key then it means the developer\n // has provided state class like `key: [AuthState]`.\n if (token.hasOwnProperty(META_OPTIONS_KEY)) {\n // The `name` property will be an actual state name or a `StateToken`.\n token = (token as any)[META_OPTIONS_KEY].name;\n }\n\n return token instanceof StateToken ? token.getName() : (token as string);\n });\n}\n\nexport function storageOptionsFactory(\n options: NgxsStoragePluginOptions | undefined\n): NgxsStoragePluginOptions {\n if (options !== undefined && options.key) {\n options.key = transformKeyOption(options.key);\n }\n\n return {\n key: [DEFAULT_STATE_KEY],\n storage: StorageOption.LocalStorage,\n serialize: JSON.stringify,\n deserialize: JSON.parse,\n beforeSerialize: obj => obj,\n afterDeserialize: obj => obj,\n ...options\n };\n}\n\nexport function engineFactory(\n options: NgxsStoragePluginOptions,\n platformId: string\n): StorageEngine | null {\n if (isPlatformServer(platformId)) {\n return null;\n }\n\n if (options.storage === StorageOption.LocalStorage) {\n return localStorage;\n } else if (options.storage === StorageOption.SessionStorage) {\n return sessionStorage;\n }\n\n return null;\n}\n","import { PLATFORM_ID, Inject, Injectable } from '@angular/core';\nimport { isPlatformServer } from '@angular/common';\nimport { PlainObject } from '@ngxs/store/internals';\nimport {\n NgxsPlugin,\n setValue,\n getValue,\n InitState,\n UpdateState,\n actionMatcher,\n NgxsNextPluginFn\n} from '@ngxs/store';\nimport { tap } from 'rxjs/operators';\n\nimport {\n StorageEngine,\n NgxsStoragePluginOptions,\n STORAGE_ENGINE,\n NGXS_STORAGE_PLUGIN_OPTIONS\n} from './symbols';\nimport { DEFAULT_STATE_KEY } from './internals';\n\n/**\n * @description Will be provided through Terser global definitions by Angular CLI\n * during the production build. This is how Angular does tree-shaking internally.\n */\ndeclare const ngDevMode: boolean;\n\n@Injectable()\nexport class NgxsStoragePlugin implements NgxsPlugin {\n // We cast to `string[]` here as we're sure that this option has been\n // transformed by the `storageOptionsFactory` function that provided token.\n private _keys = this._options.key as string[];\n // We default to `[DEFAULT_STATE_KEY]` if the user explicitly does not provide the `key` option.\n private _usesDefaultStateKey =\n this._keys.length === 1 && this._keys[0] === DEFAULT_STATE_KEY;\n\n constructor(\n @Inject(NGXS_STORAGE_PLUGIN_OPTIONS) private _options: NgxsStoragePluginOptions,\n @Inject(STORAGE_ENGINE) private _engine: StorageEngine,\n @Inject(PLATFORM_ID) private _platformId: string\n ) {}\n\n handle(state: any, event: any, next: NgxsNextPluginFn) {\n if (isPlatformServer(this._platformId) && this._engine === null) {\n return next(state, event);\n }\n\n const matches = actionMatcher(event);\n const isInitAction = matches(InitState);\n const isUpdateAction = matches(UpdateState);\n const isInitOrUpdateAction = isInitAction || isUpdateAction;\n let hasMigration = false;\n\n if (isInitOrUpdateAction) {\n const addedStates = isUpdateAction && event.addedStates;\n\n for (const key of this._keys) {\n // We're checking what states have been added by NGXS and if any of these states should be handled by\n // the storage plugin. For instance, we only want to deserialize the `auth` state, NGXS has added\n // the `user` state, the storage plugin will be rerun and will do redundant deserialization.\n // `usesDefaultStateKey` is necessary to check since `event.addedStates` never contains `@@STATE`.\n if (!this._usesDefaultStateKey && addedStates) {\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 let storedValue: any = this._engine.getItem(key!);\n\n if (storedValue !== 'undefined' && storedValue != null) {\n try {\n const newVal = this._options.deserialize!(storedValue);\n storedValue = this._options.afterDeserialize!(newVal, key);\n } catch {\n // Caretaker note: we have still left the `typeof` condition in order to avoid\n // creating a breaking change for projects that still use the View Engine.\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n console.error(\n `Error ocurred while deserializing the ${key} store value, falling back to empty object, the value obtained from the store: `,\n storedValue\n );\n }\n storedValue = {};\n }\n\n if (this._options.migrations) {\n this._options.migrations.forEach(strategy => {\n const versionMatch =\n strategy.version === getValue(storedValue, strategy.versionKey || 'version');\n const keyMatch =\n (!strategy.key && this._usesDefaultStateKey) || strategy.key === key;\n if (versionMatch && keyMatch) {\n storedValue = strategy.migrate(storedValue);\n hasMigration = true;\n }\n });\n }\n\n if (!this._usesDefaultStateKey) {\n state = setValue(state, key!, storedValue);\n } else {\n // The `UpdateState` action is dispatched whenever the feature state is added.\n // The below condition is met only when the `UpdateState` is dispatched.\n // Let's assume that we have 2 states `counter` and `@ngxs/router-plugin` state.\n // `CounterState` is provided on the root level when calling `NgxsModule.forRoot()`\n // and `@ngxs/router-plugin` is provided as a feature state.\n // The storage plugin may save the `counter` state value as `10` before.\n // The `CounterState` may implement the `ngxsOnInit` hook and call `ctx.setState(999)`.\n // The storage plugin will re-hydrate the whole state when the `RouterState` is registered,\n // and the `counter` state will again equal `10` (not `999`).\n if (storedValue && addedStates && Object.keys(addedStates).length > 0) {\n storedValue = Object.keys(addedStates).reduce((accumulator, addedState) => {\n // The `storedValue` may equal the whole state (when the default state key is used).\n // If `addedStates` contains only `router` then we want to merge the state only\n // with the `router` value.\n // Let's assume that the `storedValue` is an object:\n // `{ counter: 10, router: {...} }`\n // This will pick only the `router` object from the `storedValue` and `counter`\n // state will not be re-hydrated unnecessary.\n if (storedValue.hasOwnProperty(addedState)) {\n accumulator[addedState] = storedValue[addedState];\n }\n return accumulator;\n }, <PlainObject>{});\n }\n\n state = { ...state, ...storedValue };\n }\n }\n }\n }\n\n return next(state, event).pipe(\n tap(nextState => {\n if (!isInitOrUpdateAction || (isInitOrUpdateAction && hasMigration)) {\n for (const key of this._keys) {\n let val = nextState;\n\n if (key !== DEFAULT_STATE_KEY) {\n val = getValue(nextState, key!);\n }\n\n try {\n const newVal = this._options.beforeSerialize!(val, key);\n this._engine.setItem(key!, this._options.serialize!(newVal));\n } catch (error) {\n // Caretaker note: we have still left the `typeof` condition in order to avoid\n // creating a breaking change for projects that still use the View Engine.\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n if (\n error &&\n (error.name === 'QuotaExceededError' ||\n error.name === 'NS_ERROR_DOM_QUOTA_REACHED')\n ) {\n console.error(\n `The ${key} store value exceeds the browser storage quota: `,\n val\n );\n } else {\n console.error(\n `Error ocurred while serializing the ${key} store value, value not updated, the value obtained from the store: `,\n val\n );\n }\n }\n }\n }\n }\n })\n );\n }\n}\n\nconst DOT = '.';\n","import { NgModule, ModuleWithProviders, PLATFORM_ID, InjectionToken } from '@angular/core';\nimport { NGXS_PLUGINS } from '@ngxs/store';\n\nimport {\n NgxsStoragePluginOptions,\n STORAGE_ENGINE,\n NGXS_STORAGE_PLUGIN_OPTIONS\n} from './symbols';\nimport { NgxsStoragePlugin } from './storage.plugin';\nimport { storageOptionsFactory, engineFactory } from './internals';\n\nexport const USER_OPTIONS = new InjectionToken('USER_OPTIONS');\n\n@NgModule()\nexport class NgxsStoragePluginModule {\n static forRoot(\n options?: NgxsStoragePluginOptions\n ): ModuleWithProviders<NgxsStoragePluginModule> {\n return {\n ngModule: NgxsStoragePluginModule,\n providers: [\n {\n provide: NGXS_PLUGINS,\n useClass: NgxsStoragePlugin,\n multi: true\n },\n {\n provide: USER_OPTIONS,\n useValue: options\n },\n {\n provide: NGXS_STORAGE_PLUGIN_OPTIONS,\n useFactory: storageOptionsFactory,\n deps: [USER_OPTIONS]\n },\n {\n provide: STORAGE_ENGINE,\n useFactory: engineFactory,\n deps: [NGXS_STORAGE_PLUGIN_OPTIONS, PLATFORM_ID]\n }\n ]\n };\n }\n}\n"],"names":[],"mappings":";;;;;;;;;AAAA;;IAKE,eAAY;IACZ,iBAAc;;;;;AAGhB,uCAyDC;;;;;;IArDC,uCAA6B;;;;;;;IAO7B,2CAAwB;;;;;IAKxB,8CAoBI;;;;;;IAKJ,kEAA6B;;;;;;IAK7B,oEAA4B;;;;;;;IAK5B,6EAA6C;;;;;;;IAK7C,8EAA8C;;;AAGhD,MAAa,2BAA2B,GAAG,IAAI,cAAc,CAAC,4BAA4B,CAAC;;AAE3F,MAAa,cAAc,GAAG,IAAI,cAAc,CAAC,gBAAgB,CAAC;;;;AAElE,4BAMC;;;IALC,+BAAwB;;;;;IACxB,qDAA0B;;;;;;IAC1B,0DAAqC;;;;;IACrC,wDAA8B;;;;IAC9B,gDAAc;;;;;;;AC7EhB;;;;;AAUA,MAAa,iBAAiB,GAAG,SAAS;;;;;;MAgBpC,gBAAgB,GAAG,mBAAmB;;;;;AAE5C,SAAS,kBAAkB,CAAC,GAAe;IACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACvB,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;KACb;IAED,OAAO,GAAG,CAAC,GAAG;;;;IAAC,CAAC,KAA4C;;;QAG1D,IAAI,KAAK,CAAC,cAAc,CAAC,gBAAgB,CAAC,EAAE;;YAE1C,KAAK,GAAG,oBAAC,KAAK,IAAS,gBAAgB,CAAC,CAAC,IAAI,CAAC;SAC/C;QAED,OAAO,KAAK,YAAY,UAAU,GAAG,KAAK,CAAC,OAAO,EAAE,uBAAI,KAAK,GAAW,CAAC;KAC1E,EAAC,CAAC;CACJ;;;;;AAED,SAAgB,qBAAqB,CACnC,OAA6C;IAE7C,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,EAAE;QACxC,OAAO,CAAC,GAAG,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;KAC/C;IAED,uBACE,GAAG,EAAE,CAAC,iBAAiB,CAAC,EACxB,OAAO,wBACP,SAAS,EAAE,IAAI,CAAC,SAAS,EACzB,WAAW,EAAE,IAAI,CAAC,KAAK,EACvB,eAAe;;;;QAAE,GAAG,IAAI,GAAG,GAC3B,gBAAgB;;;;QAAE,GAAG,IAAI,GAAG,KACzB,OAAO,EACV;CACH;;;;;;AAED,SAAgB,aAAa,CAC3B,OAAiC,EACjC,UAAkB;IAElB,IAAI,gBAAgB,CAAC,UAAU,CAAC,EAAE;QAChC,OAAO,IAAI,CAAC;KACb;IAED,IAAI,OAAO,CAAC,OAAO,2BAAiC;QAClD,OAAO,YAAY,CAAC;KACrB;SAAM,IAAI,OAAO,CAAC,OAAO,6BAAmC;QAC3D,OAAO,cAAc,CAAC;KACvB;IAED,OAAO,IAAI,CAAC;CACb;;;;;;AC9ED,MA6Ba,iBAAiB;;;;;;IAQ5B,YAC+C,QAAkC,EAC/C,OAAsB,EACzB,WAAmB;QAFH,aAAQ,GAAR,QAAQ,CAA0B;QAC/C,YAAO,GAAP,OAAO,CAAe;QACzB,gBAAW,GAAX,WAAW,CAAQ;;;QAR1C,UAAK,sBAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAY,CAAC;;QAEtC,yBAAoB,GAC1B,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,iBAAiB,CAAC;KAM7D;;;;;;;IAEJ,MAAM,CAAC,KAAU,EAAE,KAAU,EAAE,IAAsB;QACnD,IAAI,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE;YAC/D,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;SAC3B;;cAEK,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC;;cAC9B,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;;cACjC,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;;cACrC,oBAAoB,GAAG,YAAY,IAAI,cAAc;;YACvD,YAAY,GAAG,KAAK;QAExB,IAAI,oBAAoB,EAAE;;kBAClB,WAAW,GAAG,cAAc,IAAI,KAAK,CAAC,WAAW;YAEvD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,EAAE;;;;;gBAK5B,IAAI,CAAC,IAAI,CAAC,oBAAoB,IAAI,WAAW,EAAE;;;;;;;0BAMvC,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC;;0BACnC,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,SAAS;qBACV;iBACF;;oBAEG,WAAW,GAAQ,IAAI,CAAC,OAAO,CAAC,OAAO,oBAAC,GAAG,GAAE;gBAEjD,IAAI,WAAW,KAAK,WAAW,IAAI,WAAW,IAAI,IAAI,EAAE;oBACtD,IAAI;;8BACI,MAAM,GAAG,mBAAA,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAE,WAAW,CAAC;wBACtD,WAAW,GAAG,mBAAA,IAAI,CAAC,QAAQ,CAAC,gBAAgB,GAAE,MAAM,EAAE,GAAG,CAAC,CAAC;qBAC5D;oBAAC,WAAM;;;wBAGN,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE;4BACjD,OAAO,CAAC,KAAK,CACX,yCAAyC,GAAG,iFAAiF,EAC7H,WAAW,CACZ,CAAC;yBACH;wBACD,WAAW,GAAG,EAAE,CAAC;qBAClB;oBAED,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE;wBAC5B,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO;;;;wBAAC,QAAQ;;kCACjC,YAAY,GAChB,QAAQ,CAAC,OAAO,KAAK,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,UAAU,IAAI,SAAS,CAAC;;kCACxE,QAAQ,GACZ,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,IAAI,CAAC,oBAAoB,KAAK,QAAQ,CAAC,GAAG,KAAK,GAAG;4BACtE,IAAI,YAAY,IAAI,QAAQ,EAAE;gCAC5B,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gCAC5C,YAAY,GAAG,IAAI,CAAC;6BACrB;yBACF,EAAC,CAAC;qBACJ;oBAED,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE;wBAC9B,KAAK,GAAG,QAAQ,CAAC,KAAK,qBAAE,GAAG,IAAG,WAAW,CAAC,CAAC;qBAC5C;yBAAM;;;;;;;;;;wBAUL,IAAI,WAAW,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;4BACrE,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM;;;;;4BAAC,CAAC,WAAW,EAAE,UAAU;;;;;;;;gCAQpE,IAAI,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;oCAC1C,WAAW,CAAC,UAAU,CAAC,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;iCACnD;gCACD,OAAO,WAAW,CAAC;6BACpB,sBAAe,EAAE,GAAC,CAAC;yBACrB;wBAED,KAAK,qBAAQ,KAAK,EAAK,WAAW,CAAE,CAAC;qBACtC;iBACF;aACF;SACF;QAED,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,CAC5B,GAAG;;;;QAAC,SAAS;YACX,IAAI,CAAC,oBAAoB,KAAK,oBAAoB,IAAI,YAAY,CAAC,EAAE;gBACnE,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,EAAE;;wBACxB,GAAG,GAAG,SAAS;oBAEnB,IAAI,GAAG,KAAK,iBAAiB,EAAE;wBAC7B,GAAG,GAAG,QAAQ,CAAC,SAAS,qBAAE,GAAG,GAAE,CAAC;qBACjC;oBAED,IAAI;;8BACI,MAAM,GAAG,mBAAA,IAAI,CAAC,QAAQ,CAAC,eAAe,GAAE,GAAG,EAAE,GAAG,CAAC;wBACvD,IAAI,CAAC,OAAO,CAAC,OAAO,oBAAC,GAAG,IAAG,mBAAA,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAE,MAAM,CAAC,CAAC,CAAC;qBAC9D;oBAAC,OAAO,KAAK,EAAE;;;wBAGd,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE;4BACjD,IACE,KAAK;iCACJ,KAAK,CAAC,IAAI,KAAK,oBAAoB;oCAClC,KAAK,CAAC,IAAI,KAAK,4BAA4B,CAAC,EAC9C;gCACA,OAAO,CAAC,KAAK,CACX,OAAO,GAAG,kDAAkD,EAC5D,GAAG,CACJ,CAAC;6BACH;iCAAM;gCACL,OAAO,CAAC,KAAK,CACX,uCAAuC,GAAG,sEAAsE,EAChH,GAAG,CACJ,CAAC;6BACH;yBACF;qBACF;iBACF;aACF;SACF,EAAC,CACH,CAAC;KACH;;;YAtJF,UAAU;;;;4CAUN,MAAM,SAAC,2BAA2B;4CAClC,MAAM,SAAC,cAAc;yCACrB,MAAM,SAAC,WAAW;;;;;;;IARrB,kCAA8C;;;;;IAE9C,iDACiE;;;;;IAG/D,qCAA+E;;;;;IAC/E,oCAAsD;;;;;IACtD,wCAAgD;;;MA6I9C,GAAG,GAAG,GAAG;;;;;;ACrLf;AAWA,MAAa,YAAY,GAAG,IAAI,cAAc,CAAC,cAAc,CAAC;AAG9D,MAAa,uBAAuB;;;;;IAClC,OAAO,OAAO,CACZ,OAAkC;QAElC,OAAO;YACL,QAAQ,EAAE,uBAAuB;YACjC,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,YAAY;oBACrB,QAAQ,EAAE,iBAAiB;oBAC3B,KAAK,EAAE,IAAI;iBACZ;gBACD;oBACE,OAAO,EAAE,YAAY;oBACrB,QAAQ,EAAE,OAAO;iBAClB;gBACD;oBACE,OAAO,EAAE,2BAA2B;oBACpC,UAAU,EAAE,qBAAqB;oBACjC,IAAI,EAAE,CAAC,YAAY,CAAC;iBACrB;gBACD;oBACE,OAAO,EAAE,cAAc;oBACvB,UAAU,EAAE,aAAa;oBACzB,IAAI,EAAE,CAAC,2BAA2B,EAAE,WAAW,CAAC;iBACjD;aACF;SACF,CAAC;KACH;;;YA7BF,QAAQ;;;;;;;;;;;;;;;;;;;;"}
|
|
1
|
+
{"version":3,"file":"ngxs-storage-plugin.js","sources":["ng://@ngxs/storage-plugin/src/symbols.ts","ng://@ngxs/storage-plugin/src/internals.ts","ng://@ngxs/storage-plugin/src/storage.plugin.ts","ng://@ngxs/storage-plugin/src/storage.module.ts"],"sourcesContent":["import { InjectionToken } from '@angular/core';\n\nimport { StorageKey } from './internals';\n\nexport const enum StorageOption {\n LocalStorage,\n SessionStorage\n}\n\nexport interface NgxsStoragePluginOptions {\n /**\n * Key for the state slice to store in the storage engine.\n */\n key?: StorageKey;\n\n /**\n * The namespace is used to prefix the key for the state slice. This is\n * necessary when running micro frontend applications which use storage plugin.\n * The namespace will eliminate the conflict between keys that might overlap.\n */\n namespace?: string;\n\n /**\n * Storage engine to use. Deaults to localStorage but can provide\n *\n * sessionStorage or custom implementation of the StorageEngine interface\n */\n storage?: StorageOption;\n\n /**\n * Migration strategies.\n */\n migrations?: {\n /**\n * Version to key off.\n */\n version: number | string;\n\n /**\n * Method to migrate the previous state.\n */\n migrate: (state: any) => any;\n\n /**\n * Key to migrate.\n */\n key?: string;\n\n /**\n * Key for the version. Defaults to 'version'.\n */\n versionKey?: string;\n }[];\n\n /**\n * Serailizer for the object before its pushed into the engine.\n */\n serialize?(obj: any): string;\n\n /**\n * Deserializer for the object before its pulled out of the engine.\n */\n deserialize?(obj: any): any;\n\n /**\n * Method to alter object before serialization.\n */\n beforeSerialize?(obj: any, key: string): any;\n\n /**\n * Method to alter object after deserialization.\n */\n afterDeserialize?(obj: any, key: string): any;\n}\n\nexport const NGXS_STORAGE_PLUGIN_OPTIONS = new InjectionToken('NGXS_STORAGE_PLUGIN_OPTIONS');\n\nexport const STORAGE_ENGINE = new InjectionToken('STORAGE_ENGINE');\n\nexport interface StorageEngine {\n readonly length: number;\n getItem(key: string): any;\n setItem(key: string, val: any): void;\n removeItem(key: string): void;\n clear(): void;\n}\n","import { isPlatformServer } from '@angular/common';\nimport { StateClass } from '@ngxs/store/internals';\nimport { StateToken } from '@ngxs/store';\n\nimport { StorageOption, StorageEngine, NgxsStoragePluginOptions } from './symbols';\n\n/**\n * If the `key` option is not provided then the below constant\n * will be used as a default key\n */\nexport const DEFAULT_STATE_KEY = '@@STATE';\n\n/**\n * Internal type definition for the `key` option provided\n * in the `forRoot` method when importing module\n */\nexport type StorageKey =\n | string\n | StateClass\n | StateToken<any>\n | (string | StateClass | StateToken<any>)[];\n\n/**\n * This key is used to retrieve static metadatas on state classes.\n * This constant is taken from the core codebase\n */\nconst META_OPTIONS_KEY = 'NGXS_OPTIONS_META';\n\nfunction transformKeyOption(key: StorageKey): string[] {\n if (!Array.isArray(key)) {\n key = [key];\n }\n\n return key.map((token: string | StateClass | StateToken<any>) => {\n // If it has the `NGXS_OPTIONS_META` key then it means the developer\n // has provided state class like `key: [AuthState]`.\n if (token.hasOwnProperty(META_OPTIONS_KEY)) {\n // The `name` property will be an actual state name or a `StateToken`.\n token = (token as any)[META_OPTIONS_KEY].name;\n }\n\n return token instanceof StateToken ? token.getName() : (token as string);\n });\n}\n\nexport function storageOptionsFactory(\n options: NgxsStoragePluginOptions | undefined\n): NgxsStoragePluginOptions {\n if (options !== undefined && options.key) {\n options.key = transformKeyOption(options.key);\n }\n\n return {\n key: [DEFAULT_STATE_KEY],\n storage: StorageOption.LocalStorage,\n serialize: JSON.stringify,\n deserialize: JSON.parse,\n beforeSerialize: obj => obj,\n afterDeserialize: obj => obj,\n ...options\n };\n}\n\nexport function engineFactory(\n options: NgxsStoragePluginOptions,\n platformId: string\n): StorageEngine | null {\n if (isPlatformServer(platformId)) {\n return null;\n }\n\n if (options.storage === StorageOption.LocalStorage) {\n return localStorage;\n } else if (options.storage === StorageOption.SessionStorage) {\n return sessionStorage;\n }\n\n return null;\n}\n\nexport function getStorageKey(key: string, options?: NgxsStoragePluginOptions): string {\n // Prepends the `namespace` option to any key if it's been provided by a user.\n // So `@@STATE` becomes `my-app:@@STATE`.\n return options && options.namespace ? `${options.namespace}:${key}` : key;\n}\n","import { PLATFORM_ID, Inject, Injectable } from '@angular/core';\nimport { isPlatformServer } from '@angular/common';\nimport { PlainObject } from '@ngxs/store/internals';\nimport {\n NgxsPlugin,\n setValue,\n getValue,\n InitState,\n UpdateState,\n actionMatcher,\n NgxsNextPluginFn\n} from '@ngxs/store';\nimport { tap } from 'rxjs/operators';\n\nimport {\n StorageEngine,\n NgxsStoragePluginOptions,\n STORAGE_ENGINE,\n NGXS_STORAGE_PLUGIN_OPTIONS\n} from './symbols';\nimport { DEFAULT_STATE_KEY, getStorageKey } from './internals';\n\n/**\n * @description Will be provided through Terser global definitions by Angular CLI\n * during the production build. This is how Angular does tree-shaking internally.\n */\ndeclare const ngDevMode: boolean;\n\n@Injectable()\nexport class NgxsStoragePlugin implements NgxsPlugin {\n // We cast to `string[]` here as we're sure that this option has been\n // transformed by the `storageOptionsFactory` function that provided token.\n private _keys = this._options.key as string[];\n // We default to `[DEFAULT_STATE_KEY]` if the user explicitly does not provide the `key` option.\n private _usesDefaultStateKey =\n this._keys.length === 1 && this._keys[0] === DEFAULT_STATE_KEY;\n\n constructor(\n @Inject(NGXS_STORAGE_PLUGIN_OPTIONS) private _options: NgxsStoragePluginOptions,\n @Inject(STORAGE_ENGINE) private _engine: StorageEngine,\n @Inject(PLATFORM_ID) private _platformId: string\n ) {}\n\n handle(state: any, event: any, next: NgxsNextPluginFn) {\n if (isPlatformServer(this._platformId) && this._engine === null) {\n return next(state, event);\n }\n\n const matches = actionMatcher(event);\n const isInitAction = matches(InitState);\n const isUpdateAction = matches(UpdateState);\n const isInitOrUpdateAction = isInitAction || isUpdateAction;\n let hasMigration = false;\n\n if (isInitOrUpdateAction) {\n const addedStates = isUpdateAction && event.addedStates;\n\n for (const key of this._keys) {\n // We're checking what states have been added by NGXS and if any of these states should be handled by\n // the storage plugin. For instance, we only want to deserialize the `auth` state, NGXS has added\n // the `user` state, the storage plugin will be rerun and will do redundant deserialization.\n // `usesDefaultStateKey` is necessary to check since `event.addedStates` never contains `@@STATE`.\n if (!this._usesDefaultStateKey && addedStates) {\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 = this._engine.getItem(storageKey);\n\n if (storedValue !== 'undefined' && storedValue != null) {\n try {\n const newVal = this._options.deserialize!(storedValue);\n storedValue = this._options.afterDeserialize!(newVal, key);\n } catch {\n // Caretaker note: we have still left the `typeof` condition in order to avoid\n // creating a breaking change for projects that still use the View Engine.\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n console.error(\n `Error ocurred while deserializing the ${storageKey} store value, falling back to empty object, the value obtained from the store: `,\n storedValue\n );\n }\n storedValue = {};\n }\n\n if (this._options.migrations) {\n this._options.migrations.forEach(strategy => {\n const versionMatch =\n strategy.version === getValue(storedValue, strategy.versionKey || 'version');\n const keyMatch =\n (!strategy.key && this._usesDefaultStateKey) || strategy.key === key;\n if (versionMatch && keyMatch) {\n storedValue = strategy.migrate(storedValue);\n hasMigration = true;\n }\n });\n }\n\n if (!this._usesDefaultStateKey) {\n state = setValue(state, key, storedValue);\n } else {\n // The `UpdateState` action is dispatched whenever the feature state is added.\n // The below condition is met only when the `UpdateState` is dispatched.\n // Let's assume that we have 2 states `counter` and `@ngxs/router-plugin` state.\n // `CounterState` is provided on the root level when calling `NgxsModule.forRoot()`\n // and `@ngxs/router-plugin` is provided as a feature state.\n // The storage plugin may save the `counter` state value as `10` before.\n // The `CounterState` may implement the `ngxsOnInit` hook and call `ctx.setState(999)`.\n // The storage plugin will re-hydrate the whole state when the `RouterState` is registered,\n // and the `counter` state will again equal `10` (not `999`).\n if (storedValue && addedStates && Object.keys(addedStates).length > 0) {\n storedValue = Object.keys(addedStates).reduce((accumulator, addedState) => {\n // The `storedValue` may equal the whole state (when the default state key is used).\n // If `addedStates` contains only `router` then we want to merge the state only\n // with the `router` value.\n // Let's assume that the `storedValue` is an object:\n // `{ counter: 10, router: {...} }`\n // This will pick only the `router` object from the `storedValue` and `counter`\n // state will not be re-hydrated unnecessary.\n if (storedValue.hasOwnProperty(addedState)) {\n accumulator[addedState] = storedValue[addedState];\n }\n return accumulator;\n }, <PlainObject>{});\n }\n\n state = { ...state, ...storedValue };\n }\n }\n }\n }\n\n return next(state, event).pipe(\n tap(nextState => {\n if (!isInitOrUpdateAction || (isInitOrUpdateAction && hasMigration)) {\n for (const key of this._keys) {\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 this._engine.setItem(storageKey, this._options.serialize!(newStoredValue));\n } catch (error) {\n // Caretaker note: we have still left the `typeof` condition in order to avoid\n // creating a breaking change for projects that still use the View Engine.\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n if (\n error &&\n (error.name === 'QuotaExceededError' ||\n error.name === 'NS_ERROR_DOM_QUOTA_REACHED')\n ) {\n console.error(\n `The ${storageKey} store value exceeds the browser storage quota: `,\n storedValue\n );\n } else {\n console.error(\n `Error ocurred while serializing the ${storageKey} store value, value not updated, the value obtained from the store: `,\n storedValue\n );\n }\n }\n }\n }\n }\n })\n );\n }\n}\n\nconst DOT = '.';\n","import { NgModule, ModuleWithProviders, PLATFORM_ID, InjectionToken } from '@angular/core';\nimport { NGXS_PLUGINS } from '@ngxs/store';\n\nimport {\n NgxsStoragePluginOptions,\n STORAGE_ENGINE,\n NGXS_STORAGE_PLUGIN_OPTIONS\n} from './symbols';\nimport { NgxsStoragePlugin } from './storage.plugin';\nimport { storageOptionsFactory, engineFactory } from './internals';\n\nexport const USER_OPTIONS = new InjectionToken('USER_OPTIONS');\n\n@NgModule()\nexport class NgxsStoragePluginModule {\n static forRoot(\n options?: NgxsStoragePluginOptions\n ): ModuleWithProviders<NgxsStoragePluginModule> {\n return {\n ngModule: NgxsStoragePluginModule,\n providers: [\n {\n provide: NGXS_PLUGINS,\n useClass: NgxsStoragePlugin,\n multi: true\n },\n {\n provide: USER_OPTIONS,\n useValue: options\n },\n {\n provide: NGXS_STORAGE_PLUGIN_OPTIONS,\n useFactory: storageOptionsFactory,\n deps: [USER_OPTIONS]\n },\n {\n provide: STORAGE_ENGINE,\n useFactory: engineFactory,\n deps: [NGXS_STORAGE_PLUGIN_OPTIONS, PLATFORM_ID]\n }\n ]\n };\n }\n}\n"],"names":[],"mappings":";;;;;;;;;AAAA;;IAKE,eAAY;IACZ,iBAAc;;;;;AAGhB,uCAgEC;;;;;;IA5DC,uCAAiB;;;;;;;IAOjB,6CAAmB;;;;;;;IAOnB,2CAAwB;;;;;IAKxB,8CAoBI;;;;;;IAKJ,kEAA6B;;;;;;IAK7B,oEAA4B;;;;;;;IAK5B,6EAA6C;;;;;;;IAK7C,8EAA8C;;;AAGhD,MAAa,2BAA2B,GAAG,IAAI,cAAc,CAAC,6BAA6B,CAAC;;AAE5F,MAAa,cAAc,GAAG,IAAI,cAAc,CAAC,gBAAgB,CAAC;;;;AAElE,4BAMC;;;IALC,+BAAwB;;;;;IACxB,qDAA0B;;;;;;IAC1B,0DAAqC;;;;;IACrC,wDAA8B;;;;IAC9B,gDAAc;;;;;;;ACpFhB;;;;;AAUA,MAAa,iBAAiB,GAAG,SAAS;;;;;;MAgBpC,gBAAgB,GAAG,mBAAmB;;;;;AAE5C,SAAS,kBAAkB,CAAC,GAAe;IACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACvB,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;KACb;IAED,OAAO,GAAG,CAAC,GAAG;;;;IAAC,CAAC,KAA4C;;;QAG1D,IAAI,KAAK,CAAC,cAAc,CAAC,gBAAgB,CAAC,EAAE;;YAE1C,KAAK,GAAG,oBAAC,KAAK,IAAS,gBAAgB,CAAC,CAAC,IAAI,CAAC;SAC/C;QAED,OAAO,KAAK,YAAY,UAAU,GAAG,KAAK,CAAC,OAAO,EAAE,uBAAI,KAAK,GAAW,CAAC;KAC1E,EAAC,CAAC;CACJ;;;;;AAED,SAAgB,qBAAqB,CACnC,OAA6C;IAE7C,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,EAAE;QACxC,OAAO,CAAC,GAAG,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;KAC/C;IAED,uBACE,GAAG,EAAE,CAAC,iBAAiB,CAAC,EACxB,OAAO,wBACP,SAAS,EAAE,IAAI,CAAC,SAAS,EACzB,WAAW,EAAE,IAAI,CAAC,KAAK,EACvB,eAAe;;;;QAAE,GAAG,IAAI,GAAG,GAC3B,gBAAgB;;;;QAAE,GAAG,IAAI,GAAG,KACzB,OAAO,EACV;CACH;;;;;;AAED,SAAgB,aAAa,CAC3B,OAAiC,EACjC,UAAkB;IAElB,IAAI,gBAAgB,CAAC,UAAU,CAAC,EAAE;QAChC,OAAO,IAAI,CAAC;KACb;IAED,IAAI,OAAO,CAAC,OAAO,2BAAiC;QAClD,OAAO,YAAY,CAAC;KACrB;SAAM,IAAI,OAAO,CAAC,OAAO,6BAAmC;QAC3D,OAAO,cAAc,CAAC;KACvB;IAED,OAAO,IAAI,CAAC;CACb;;;;;;AAED,SAAgB,aAAa,CAAC,GAAW,EAAE,OAAkC;;;IAG3E,OAAO,OAAO,IAAI,OAAO,CAAC,SAAS,GAAG,GAAG,OAAO,CAAC,SAAS,IAAI,GAAG,EAAE,GAAG,GAAG,CAAC;CAC3E;;;;;;ACpFD,MA6Ba,iBAAiB;;;;;;IAQ5B,YAC+C,QAAkC,EAC/C,OAAsB,EACzB,WAAmB;QAFH,aAAQ,GAAR,QAAQ,CAA0B;QAC/C,YAAO,GAAP,OAAO,CAAe;QACzB,gBAAW,GAAX,WAAW,CAAQ;;;QAR1C,UAAK,sBAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAY,CAAC;;QAEtC,yBAAoB,GAC1B,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,iBAAiB,CAAC;KAM7D;;;;;;;IAEJ,MAAM,CAAC,KAAU,EAAE,KAAU,EAAE,IAAsB;QACnD,IAAI,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE;YAC/D,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;SAC3B;;cAEK,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC;;cAC9B,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;;cACjC,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;;cACrC,oBAAoB,GAAG,YAAY,IAAI,cAAc;;YACvD,YAAY,GAAG,KAAK;QAExB,IAAI,oBAAoB,EAAE;;kBAClB,WAAW,GAAG,cAAc,IAAI,KAAK,CAAC,WAAW;YAEvD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,EAAE;;;;;gBAK5B,IAAI,CAAC,IAAI,CAAC,oBAAoB,IAAI,WAAW,EAAE;;;;;;;0BAMvC,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC;;0BACnC,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,SAAS;qBACV;iBACF;;sBAEK,UAAU,GAAG,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC;;oBAChD,WAAW,GAAQ,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;gBAEvD,IAAI,WAAW,KAAK,WAAW,IAAI,WAAW,IAAI,IAAI,EAAE;oBACtD,IAAI;;8BACI,MAAM,GAAG,mBAAA,IAAI,CAAC,QAAQ,CAAC,WAAW,GAAE,WAAW,CAAC;wBACtD,WAAW,GAAG,mBAAA,IAAI,CAAC,QAAQ,CAAC,gBAAgB,GAAE,MAAM,EAAE,GAAG,CAAC,CAAC;qBAC5D;oBAAC,WAAM;;;wBAGN,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE;4BACjD,OAAO,CAAC,KAAK,CACX,yCAAyC,UAAU,iFAAiF,EACpI,WAAW,CACZ,CAAC;yBACH;wBACD,WAAW,GAAG,EAAE,CAAC;qBAClB;oBAED,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE;wBAC5B,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO;;;;wBAAC,QAAQ;;kCACjC,YAAY,GAChB,QAAQ,CAAC,OAAO,KAAK,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,UAAU,IAAI,SAAS,CAAC;;kCACxE,QAAQ,GACZ,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,IAAI,CAAC,oBAAoB,KAAK,QAAQ,CAAC,GAAG,KAAK,GAAG;4BACtE,IAAI,YAAY,IAAI,QAAQ,EAAE;gCAC5B,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gCAC5C,YAAY,GAAG,IAAI,CAAC;6BACrB;yBACF,EAAC,CAAC;qBACJ;oBAED,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE;wBAC9B,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;qBAC3C;yBAAM;;;;;;;;;;wBAUL,IAAI,WAAW,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;4BACrE,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM;;;;;4BAAC,CAAC,WAAW,EAAE,UAAU;;;;;;;;gCAQpE,IAAI,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;oCAC1C,WAAW,CAAC,UAAU,CAAC,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;iCACnD;gCACD,OAAO,WAAW,CAAC;6BACpB,sBAAe,EAAE,GAAC,CAAC;yBACrB;wBAED,KAAK,qBAAQ,KAAK,EAAK,WAAW,CAAE,CAAC;qBACtC;iBACF;aACF;SACF;QAED,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,CAC5B,GAAG;;;;QAAC,SAAS;YACX,IAAI,CAAC,oBAAoB,KAAK,oBAAoB,IAAI,YAAY,CAAC,EAAE;gBACnE,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,EAAE;;wBACxB,WAAW,GAAG,SAAS;;0BAErB,UAAU,GAAG,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC;oBAEpD,IAAI,GAAG,KAAK,iBAAiB,EAAE;wBAC7B,WAAW,GAAG,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;qBACxC;oBAED,IAAI;;8BACI,cAAc,GAAG,mBAAA,IAAI,CAAC,QAAQ,CAAC,eAAe,GAAE,WAAW,EAAE,GAAG,CAAC;wBACvE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,mBAAA,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAE,cAAc,CAAC,CAAC,CAAC;qBAC5E;oBAAC,OAAO,KAAK,EAAE;;;wBAGd,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE;4BACjD,IACE,KAAK;iCACJ,KAAK,CAAC,IAAI,KAAK,oBAAoB;oCAClC,KAAK,CAAC,IAAI,KAAK,4BAA4B,CAAC,EAC9C;gCACA,OAAO,CAAC,KAAK,CACX,OAAO,UAAU,kDAAkD,EACnE,WAAW,CACZ,CAAC;6BACH;iCAAM;gCACL,OAAO,CAAC,KAAK,CACX,uCAAuC,UAAU,sEAAsE,EACvH,WAAW,CACZ,CAAC;6BACH;yBACF;qBACF;iBACF;aACF;SACF,EAAC,CACH,CAAC;KACH;;;YAzJF,UAAU;;;;4CAUN,MAAM,SAAC,2BAA2B;4CAClC,MAAM,SAAC,cAAc;yCACrB,MAAM,SAAC,WAAW;;;;;;;IARrB,kCAA8C;;;;;IAE9C,iDACiE;;;;;IAG/D,qCAA+E;;;;;IAC/E,oCAAsD;;;;;IACtD,wCAAgD;;;MAgJ9C,GAAG,GAAG,GAAG;;;;;;ACxLf;AAWA,MAAa,YAAY,GAAG,IAAI,cAAc,CAAC,cAAc,CAAC;AAG9D,MAAa,uBAAuB;;;;;IAClC,OAAO,OAAO,CACZ,OAAkC;QAElC,OAAO;YACL,QAAQ,EAAE,uBAAuB;YACjC,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,YAAY;oBACrB,QAAQ,EAAE,iBAAiB;oBAC3B,KAAK,EAAE,IAAI;iBACZ;gBACD;oBACE,OAAO,EAAE,YAAY;oBACrB,QAAQ,EAAE,OAAO;iBAClB;gBACD;oBACE,OAAO,EAAE,2BAA2B;oBACpC,UAAU,EAAE,qBAAqB;oBACjC,IAAI,EAAE,CAAC,YAAY,CAAC;iBACrB;gBACD;oBACE,OAAO,EAAE,cAAc;oBACvB,UAAU,EAAE,aAAa;oBACzB,IAAI,EAAE,CAAC,2BAA2B,EAAE,WAAW,CAAC;iBACjD;aACF;SACF,CAAC;KACH;;;YA7BF,QAAQ;;;;;;;;;;;;;;;;;;;;"}
|
|
@@ -23,6 +23,13 @@ if (false) {
|
|
|
23
23
|
* @type {?|undefined}
|
|
24
24
|
*/
|
|
25
25
|
NgxsStoragePluginOptions.prototype.key;
|
|
26
|
+
/**
|
|
27
|
+
* The namespace is used to prefix the key for the state slice. This is
|
|
28
|
+
* necessary when running micro frontend applications which use storage plugin.
|
|
29
|
+
* The namespace will eliminate the conflict between keys that might overlap.
|
|
30
|
+
* @type {?|undefined}
|
|
31
|
+
*/
|
|
32
|
+
NgxsStoragePluginOptions.prototype.namespace;
|
|
26
33
|
/**
|
|
27
34
|
* Storage engine to use. Deaults to localStorage but can provide
|
|
28
35
|
*
|
|
@@ -63,7 +70,7 @@ if (false) {
|
|
|
63
70
|
NgxsStoragePluginOptions.prototype.afterDeserialize = function (obj, key) { };
|
|
64
71
|
}
|
|
65
72
|
/** @type {?} */
|
|
66
|
-
var NGXS_STORAGE_PLUGIN_OPTIONS = new InjectionToken('
|
|
73
|
+
var NGXS_STORAGE_PLUGIN_OPTIONS = new InjectionToken('NGXS_STORAGE_PLUGIN_OPTIONS');
|
|
67
74
|
/** @type {?} */
|
|
68
75
|
var STORAGE_ENGINE = new InjectionToken('STORAGE_ENGINE');
|
|
69
76
|
/**
|
|
@@ -168,6 +175,16 @@ function engineFactory(options, platformId) {
|
|
|
168
175
|
}
|
|
169
176
|
return null;
|
|
170
177
|
}
|
|
178
|
+
/**
|
|
179
|
+
* @param {?} key
|
|
180
|
+
* @param {?=} options
|
|
181
|
+
* @return {?}
|
|
182
|
+
*/
|
|
183
|
+
function getStorageKey(key, options) {
|
|
184
|
+
// Prepends the `namespace` option to any key if it's been provided by a user.
|
|
185
|
+
// So `@@STATE` becomes `my-app:@@STATE`.
|
|
186
|
+
return options && options.namespace ? options.namespace + ":" + key : key;
|
|
187
|
+
}
|
|
171
188
|
|
|
172
189
|
/**
|
|
173
190
|
* @fileoverview added by tsickle
|
|
@@ -235,7 +252,9 @@ var NgxsStoragePlugin = /** @class */ (function () {
|
|
|
235
252
|
}
|
|
236
253
|
}
|
|
237
254
|
/** @type {?} */
|
|
238
|
-
var
|
|
255
|
+
var storageKey = getStorageKey(key, this_1._options);
|
|
256
|
+
/** @type {?} */
|
|
257
|
+
var storedValue = this_1._engine.getItem(storageKey);
|
|
239
258
|
if (storedValue !== 'undefined' && storedValue != null) {
|
|
240
259
|
try {
|
|
241
260
|
/** @type {?} */
|
|
@@ -246,7 +265,7 @@ var NgxsStoragePlugin = /** @class */ (function () {
|
|
|
246
265
|
// Caretaker note: we have still left the `typeof` condition in order to avoid
|
|
247
266
|
// creating a breaking change for projects that still use the View Engine.
|
|
248
267
|
if (typeof ngDevMode === 'undefined' || ngDevMode) {
|
|
249
|
-
console.error("Error ocurred while deserializing the " +
|
|
268
|
+
console.error("Error ocurred while deserializing the " + storageKey + " store value, falling back to empty object, the value obtained from the store: ", storedValue);
|
|
250
269
|
}
|
|
251
270
|
storedValue = {};
|
|
252
271
|
}
|
|
@@ -267,7 +286,7 @@ var NgxsStoragePlugin = /** @class */ (function () {
|
|
|
267
286
|
}));
|
|
268
287
|
}
|
|
269
288
|
if (!this_1._usesDefaultStateKey) {
|
|
270
|
-
state = setValue(state,
|
|
289
|
+
state = setValue(state, key, storedValue);
|
|
271
290
|
}
|
|
272
291
|
else {
|
|
273
292
|
// The `UpdateState` action is dispatched whenever the feature state is added.
|
|
@@ -329,14 +348,16 @@ var NgxsStoragePlugin = /** @class */ (function () {
|
|
|
329
348
|
for (var _b = __values(_this._keys), _c = _b.next(); !_c.done; _c = _b.next()) {
|
|
330
349
|
var key = _c.value;
|
|
331
350
|
/** @type {?} */
|
|
332
|
-
var
|
|
351
|
+
var storedValue = nextState;
|
|
352
|
+
/** @type {?} */
|
|
353
|
+
var storageKey = getStorageKey(key, _this._options);
|
|
333
354
|
if (key !== DEFAULT_STATE_KEY) {
|
|
334
|
-
|
|
355
|
+
storedValue = getValue(nextState, key);
|
|
335
356
|
}
|
|
336
357
|
try {
|
|
337
358
|
/** @type {?} */
|
|
338
|
-
var
|
|
339
|
-
_this._engine.setItem(
|
|
359
|
+
var newStoredValue = (/** @type {?} */ (_this._options.beforeSerialize))(storedValue, key);
|
|
360
|
+
_this._engine.setItem(storageKey, (/** @type {?} */ (_this._options.serialize))(newStoredValue));
|
|
340
361
|
}
|
|
341
362
|
catch (error) {
|
|
342
363
|
// Caretaker note: we have still left the `typeof` condition in order to avoid
|
|
@@ -345,10 +366,10 @@ var NgxsStoragePlugin = /** @class */ (function () {
|
|
|
345
366
|
if (error &&
|
|
346
367
|
(error.name === 'QuotaExceededError' ||
|
|
347
368
|
error.name === 'NS_ERROR_DOM_QUOTA_REACHED')) {
|
|
348
|
-
console.error("The " +
|
|
369
|
+
console.error("The " + storageKey + " store value exceeds the browser storage quota: ", storedValue);
|
|
349
370
|
}
|
|
350
371
|
else {
|
|
351
|
-
console.error("Error ocurred while serializing the " +
|
|
372
|
+
console.error("Error ocurred while serializing the " + storageKey + " store value, value not updated, the value obtained from the store: ", storedValue);
|
|
352
373
|
}
|
|
353
374
|
}
|
|
354
375
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ngxs-storage-plugin.js","sources":["ng://@ngxs/storage-plugin/src/symbols.ts","ng://@ngxs/storage-plugin/src/internals.ts","ng://@ngxs/storage-plugin/src/storage.plugin.ts","ng://@ngxs/storage-plugin/src/storage.module.ts"],"sourcesContent":["import { InjectionToken } from '@angular/core';\n\nimport { StorageKey } from './internals';\n\nexport const enum StorageOption {\n LocalStorage,\n SessionStorage\n}\n\nexport interface NgxsStoragePluginOptions {\n /**\n * Key for the state slice to store in the storage engine.\n */\n key?: undefined | StorageKey;\n\n /**\n * Storage engine to use. Deaults to localStorage but can provide\n *\n * sessionStorage or custom implementation of the StorageEngine interface\n */\n storage?: StorageOption;\n\n /**\n * Migration strategies.\n */\n migrations?: {\n /**\n * Version to key off.\n */\n version: number | string;\n\n /**\n * Method to migrate the previous state.\n */\n migrate: (state: any) => any;\n\n /**\n * Key to migrate.\n */\n key?: string;\n\n /**\n * Key for the version. Defaults to 'version'.\n */\n versionKey?: string;\n }[];\n\n /**\n * Serailizer for the object before its pushed into the engine.\n */\n serialize?(obj: any): string;\n\n /**\n * Deserializer for the object before its pulled out of the engine.\n */\n deserialize?(obj: any): any;\n\n /**\n * Method to alter object before serialization.\n */\n beforeSerialize?(obj: any, key: string): any;\n\n /**\n * Method to alter object after deserialization.\n */\n afterDeserialize?(obj: any, key: string): any;\n}\n\nexport const NGXS_STORAGE_PLUGIN_OPTIONS = new InjectionToken('NGXS_STORAGE_PLUGIN_OPTION');\n\nexport const STORAGE_ENGINE = new InjectionToken('STORAGE_ENGINE');\n\nexport interface StorageEngine {\n readonly length: number;\n getItem(key: string): any;\n setItem(key: string, val: any): void;\n removeItem(key: string): void;\n clear(): void;\n}\n","import { isPlatformServer } from '@angular/common';\nimport { StateClass } from '@ngxs/store/internals';\nimport { StateToken } from '@ngxs/store';\n\nimport { StorageOption, StorageEngine, NgxsStoragePluginOptions } from './symbols';\n\n/**\n * If the `key` option is not provided then the below constant\n * will be used as a default key\n */\nexport const DEFAULT_STATE_KEY = '@@STATE';\n\n/**\n * Internal type definition for the `key` option provided\n * in the `forRoot` method when importing module\n */\nexport type StorageKey =\n | string\n | StateClass\n | StateToken<any>\n | (string | StateClass | StateToken<any>)[];\n\n/**\n * This key is used to retrieve static metadatas on state classes.\n * This constant is taken from the core codebase\n */\nconst META_OPTIONS_KEY = 'NGXS_OPTIONS_META';\n\nfunction transformKeyOption(key: StorageKey): string[] {\n if (!Array.isArray(key)) {\n key = [key];\n }\n\n return key.map((token: string | StateClass | StateToken<any>) => {\n // If it has the `NGXS_OPTIONS_META` key then it means the developer\n // has provided state class like `key: [AuthState]`.\n if (token.hasOwnProperty(META_OPTIONS_KEY)) {\n // The `name` property will be an actual state name or a `StateToken`.\n token = (token as any)[META_OPTIONS_KEY].name;\n }\n\n return token instanceof StateToken ? token.getName() : (token as string);\n });\n}\n\nexport function storageOptionsFactory(\n options: NgxsStoragePluginOptions | undefined\n): NgxsStoragePluginOptions {\n if (options !== undefined && options.key) {\n options.key = transformKeyOption(options.key);\n }\n\n return {\n key: [DEFAULT_STATE_KEY],\n storage: StorageOption.LocalStorage,\n serialize: JSON.stringify,\n deserialize: JSON.parse,\n beforeSerialize: obj => obj,\n afterDeserialize: obj => obj,\n ...options\n };\n}\n\nexport function engineFactory(\n options: NgxsStoragePluginOptions,\n platformId: string\n): StorageEngine | null {\n if (isPlatformServer(platformId)) {\n return null;\n }\n\n if (options.storage === StorageOption.LocalStorage) {\n return localStorage;\n } else if (options.storage === StorageOption.SessionStorage) {\n return sessionStorage;\n }\n\n return null;\n}\n","import { PLATFORM_ID, Inject, Injectable } from '@angular/core';\nimport { isPlatformServer } from '@angular/common';\nimport { PlainObject } from '@ngxs/store/internals';\nimport {\n NgxsPlugin,\n setValue,\n getValue,\n InitState,\n UpdateState,\n actionMatcher,\n NgxsNextPluginFn\n} from '@ngxs/store';\nimport { tap } from 'rxjs/operators';\n\nimport {\n StorageEngine,\n NgxsStoragePluginOptions,\n STORAGE_ENGINE,\n NGXS_STORAGE_PLUGIN_OPTIONS\n} from './symbols';\nimport { DEFAULT_STATE_KEY } from './internals';\n\n/**\n * @description Will be provided through Terser global definitions by Angular CLI\n * during the production build. This is how Angular does tree-shaking internally.\n */\ndeclare const ngDevMode: boolean;\n\n@Injectable()\nexport class NgxsStoragePlugin implements NgxsPlugin {\n // We cast to `string[]` here as we're sure that this option has been\n // transformed by the `storageOptionsFactory` function that provided token.\n private _keys = this._options.key as string[];\n // We default to `[DEFAULT_STATE_KEY]` if the user explicitly does not provide the `key` option.\n private _usesDefaultStateKey =\n this._keys.length === 1 && this._keys[0] === DEFAULT_STATE_KEY;\n\n constructor(\n @Inject(NGXS_STORAGE_PLUGIN_OPTIONS) private _options: NgxsStoragePluginOptions,\n @Inject(STORAGE_ENGINE) private _engine: StorageEngine,\n @Inject(PLATFORM_ID) private _platformId: string\n ) {}\n\n handle(state: any, event: any, next: NgxsNextPluginFn) {\n if (isPlatformServer(this._platformId) && this._engine === null) {\n return next(state, event);\n }\n\n const matches = actionMatcher(event);\n const isInitAction = matches(InitState);\n const isUpdateAction = matches(UpdateState);\n const isInitOrUpdateAction = isInitAction || isUpdateAction;\n let hasMigration = false;\n\n if (isInitOrUpdateAction) {\n const addedStates = isUpdateAction && event.addedStates;\n\n for (const key of this._keys) {\n // We're checking what states have been added by NGXS and if any of these states should be handled by\n // the storage plugin. For instance, we only want to deserialize the `auth` state, NGXS has added\n // the `user` state, the storage plugin will be rerun and will do redundant deserialization.\n // `usesDefaultStateKey` is necessary to check since `event.addedStates` never contains `@@STATE`.\n if (!this._usesDefaultStateKey && addedStates) {\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 let storedValue: any = this._engine.getItem(key!);\n\n if (storedValue !== 'undefined' && storedValue != null) {\n try {\n const newVal = this._options.deserialize!(storedValue);\n storedValue = this._options.afterDeserialize!(newVal, key);\n } catch {\n // Caretaker note: we have still left the `typeof` condition in order to avoid\n // creating a breaking change for projects that still use the View Engine.\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n console.error(\n `Error ocurred while deserializing the ${key} store value, falling back to empty object, the value obtained from the store: `,\n storedValue\n );\n }\n storedValue = {};\n }\n\n if (this._options.migrations) {\n this._options.migrations.forEach(strategy => {\n const versionMatch =\n strategy.version === getValue(storedValue, strategy.versionKey || 'version');\n const keyMatch =\n (!strategy.key && this._usesDefaultStateKey) || strategy.key === key;\n if (versionMatch && keyMatch) {\n storedValue = strategy.migrate(storedValue);\n hasMigration = true;\n }\n });\n }\n\n if (!this._usesDefaultStateKey) {\n state = setValue(state, key!, storedValue);\n } else {\n // The `UpdateState` action is dispatched whenever the feature state is added.\n // The below condition is met only when the `UpdateState` is dispatched.\n // Let's assume that we have 2 states `counter` and `@ngxs/router-plugin` state.\n // `CounterState` is provided on the root level when calling `NgxsModule.forRoot()`\n // and `@ngxs/router-plugin` is provided as a feature state.\n // The storage plugin may save the `counter` state value as `10` before.\n // The `CounterState` may implement the `ngxsOnInit` hook and call `ctx.setState(999)`.\n // The storage plugin will re-hydrate the whole state when the `RouterState` is registered,\n // and the `counter` state will again equal `10` (not `999`).\n if (storedValue && addedStates && Object.keys(addedStates).length > 0) {\n storedValue = Object.keys(addedStates).reduce((accumulator, addedState) => {\n // The `storedValue` may equal the whole state (when the default state key is used).\n // If `addedStates` contains only `router` then we want to merge the state only\n // with the `router` value.\n // Let's assume that the `storedValue` is an object:\n // `{ counter: 10, router: {...} }`\n // This will pick only the `router` object from the `storedValue` and `counter`\n // state will not be re-hydrated unnecessary.\n if (storedValue.hasOwnProperty(addedState)) {\n accumulator[addedState] = storedValue[addedState];\n }\n return accumulator;\n }, <PlainObject>{});\n }\n\n state = { ...state, ...storedValue };\n }\n }\n }\n }\n\n return next(state, event).pipe(\n tap(nextState => {\n if (!isInitOrUpdateAction || (isInitOrUpdateAction && hasMigration)) {\n for (const key of this._keys) {\n let val = nextState;\n\n if (key !== DEFAULT_STATE_KEY) {\n val = getValue(nextState, key!);\n }\n\n try {\n const newVal = this._options.beforeSerialize!(val, key);\n this._engine.setItem(key!, this._options.serialize!(newVal));\n } catch (error) {\n // Caretaker note: we have still left the `typeof` condition in order to avoid\n // creating a breaking change for projects that still use the View Engine.\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n if (\n error &&\n (error.name === 'QuotaExceededError' ||\n error.name === 'NS_ERROR_DOM_QUOTA_REACHED')\n ) {\n console.error(\n `The ${key} store value exceeds the browser storage quota: `,\n val\n );\n } else {\n console.error(\n `Error ocurred while serializing the ${key} store value, value not updated, the value obtained from the store: `,\n val\n );\n }\n }\n }\n }\n }\n })\n );\n }\n}\n\nconst DOT = '.';\n","import { NgModule, ModuleWithProviders, PLATFORM_ID, InjectionToken } from '@angular/core';\nimport { NGXS_PLUGINS } from '@ngxs/store';\n\nimport {\n NgxsStoragePluginOptions,\n STORAGE_ENGINE,\n NGXS_STORAGE_PLUGIN_OPTIONS\n} from './symbols';\nimport { NgxsStoragePlugin } from './storage.plugin';\nimport { storageOptionsFactory, engineFactory } from './internals';\n\nexport const USER_OPTIONS = new InjectionToken('USER_OPTIONS');\n\n@NgModule()\nexport class NgxsStoragePluginModule {\n static forRoot(\n options?: NgxsStoragePluginOptions\n ): ModuleWithProviders<NgxsStoragePluginModule> {\n return {\n ngModule: NgxsStoragePluginModule,\n providers: [\n {\n provide: NGXS_PLUGINS,\n useClass: NgxsStoragePlugin,\n multi: true\n },\n {\n provide: USER_OPTIONS,\n useValue: options\n },\n {\n provide: NGXS_STORAGE_PLUGIN_OPTIONS,\n useFactory: storageOptionsFactory,\n deps: [USER_OPTIONS]\n },\n {\n provide: STORAGE_ENGINE,\n useFactory: engineFactory,\n deps: [NGXS_STORAGE_PLUGIN_OPTIONS, PLATFORM_ID]\n }\n ]\n };\n }\n}\n"],"names":["tslib_1.__values"],"mappings":";;;;;;;;;;AAAA;;IAKE,eAAY;IACZ,iBAAc;;;;;AAGhB,uCAyDC;;;;;;IArDC,uCAA6B;;;;;;;IAO7B,2CAAwB;;;;;IAKxB,8CAoBI;;;;;;IAKJ,kEAA6B;;;;;;IAK7B,oEAA4B;;;;;;;IAK5B,6EAA6C;;;;;;;IAK7C,8EAA8C;;;AAGhD,IAAa,2BAA2B,GAAG,IAAI,cAAc,CAAC,4BAA4B,CAAC;;AAE3F,IAAa,cAAc,GAAG,IAAI,cAAc,CAAC,gBAAgB,CAAC;;;;AAElE,4BAMC;;;IALC,+BAAwB;;;;;IACxB,qDAA0B;;;;;;IAC1B,0DAAqC;;;;;IACrC,wDAA8B;;;;IAC9B,gDAAc;;;;;;;;;;;;ACnEhB,IAAa,iBAAiB,GAAG,SAAS;;;;;;IAgBpC,gBAAgB,GAAG,mBAAmB;;;;;AAE5C,SAAS,kBAAkB,CAAC,GAAe;IACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACvB,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;KACb;IAED,OAAO,GAAG,CAAC,GAAG;;;;IAAC,UAAC,KAA4C;;;QAG1D,IAAI,KAAK,CAAC,cAAc,CAAC,gBAAgB,CAAC,EAAE;;YAE1C,KAAK,GAAG,oBAAC,KAAK,IAAS,gBAAgB,CAAC,CAAC,IAAI,CAAC;SAC/C;QAED,OAAO,KAAK,YAAY,UAAU,GAAG,KAAK,CAAC,OAAO,EAAE,uBAAI,KAAK,GAAW,CAAC;KAC1E,EAAC,CAAC;CACJ;;;;;AAED,SAAgB,qBAAqB,CACnC,OAA6C;IAE7C,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,EAAE;QACxC,OAAO,CAAC,GAAG,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;KAC/C;IAED,kBACE,GAAG,EAAE,CAAC,iBAAiB,CAAC,EACxB,OAAO,wBACP,SAAS,EAAE,IAAI,CAAC,SAAS,EACzB,WAAW,EAAE,IAAI,CAAC,KAAK,EACvB,eAAe;;;;QAAE,UAAA,GAAG,IAAI,OAAA,GAAG,GAAA,GAC3B,gBAAgB;;;;QAAE,UAAA,GAAG,IAAI,OAAA,GAAG,GAAA,KACzB,OAAO,EACV;CACH;;;;;;AAED,SAAgB,aAAa,CAC3B,OAAiC,EACjC,UAAkB;IAElB,IAAI,gBAAgB,CAAC,UAAU,CAAC,EAAE;QAChC,OAAO,IAAI,CAAC;KACb;IAED,IAAI,OAAO,CAAC,OAAO,2BAAiC;QAClD,OAAO,YAAY,CAAC;KACrB;SAAM,IAAI,OAAO,CAAC,OAAO,6BAAmC;QAC3D,OAAO,cAAc,CAAC;KACvB;IAED,OAAO,IAAI,CAAC;CACb;;;;;;;ICzCC,2BAC+C,QAAkC,EAC/C,OAAsB,EACzB,WAAmB;QAFH,aAAQ,GAAR,QAAQ,CAA0B;QAC/C,YAAO,GAAP,OAAO,CAAe;QACzB,gBAAW,GAAX,WAAW,CAAQ;;;QAR1C,UAAK,sBAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAY,CAAC;;QAEtC,yBAAoB,GAC1B,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,iBAAiB,CAAC;KAM7D;;;;;;;IAEJ,kCAAM;;;;;;IAAN,UAAO,KAAU,EAAE,KAAU,EAAE,IAAsB;QAArD,iBAuIC;;QAtIC,IAAI,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE;YAC/D,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;SAC3B;;YAEK,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC;;YAC9B,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;;YACjC,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;;YACrC,oBAAoB,GAAG,YAAY,IAAI,cAAc;;YACvD,YAAY,GAAG,KAAK;QAExB,IAAI,oBAAoB,EAAE;;gBAClB,WAAW,GAAG,cAAc,IAAI,KAAK,CAAC,WAAW;oCAE5C,GAAG;;;;;gBAKZ,IAAI,CAAC,OAAK,oBAAoB,IAAI,WAAW,EAAE;;;;;;;wBAMvC,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC;;wBACnC,SAAS,GAAG,gBAAgB,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC,GAAG,GAAG;oBAC9E,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE;;qBAE3C;iBACF;;oBAEG,WAAW,GAAQ,OAAK,OAAO,CAAC,OAAO,oBAAC,GAAG,GAAE;gBAEjD,IAAI,WAAW,KAAK,WAAW,IAAI,WAAW,IAAI,IAAI,EAAE;oBACtD,IAAI;;4BACI,MAAM,GAAG,mBAAA,OAAK,QAAQ,CAAC,WAAW,GAAE,WAAW,CAAC;wBACtD,WAAW,GAAG,mBAAA,OAAK,QAAQ,CAAC,gBAAgB,GAAE,MAAM,EAAE,GAAG,CAAC,CAAC;qBAC5D;oBAAC,WAAM;;;wBAGN,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE;4BACjD,OAAO,CAAC,KAAK,CACX,2CAAyC,GAAG,oFAAiF,EAC7H,WAAW,CACZ,CAAC;yBACH;wBACD,WAAW,GAAG,EAAE,CAAC;qBAClB;oBAED,IAAI,OAAK,QAAQ,CAAC,UAAU,EAAE;wBAC5B,OAAK,QAAQ,CAAC,UAAU,CAAC,OAAO;;;;wBAAC,UAAA,QAAQ;;gCACjC,YAAY,GAChB,QAAQ,CAAC,OAAO,KAAK,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,UAAU,IAAI,SAAS,CAAC;;gCACxE,QAAQ,GACZ,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,KAAI,CAAC,oBAAoB,KAAK,QAAQ,CAAC,GAAG,KAAK,GAAG;4BACtE,IAAI,YAAY,IAAI,QAAQ,EAAE;gCAC5B,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gCAC5C,YAAY,GAAG,IAAI,CAAC;6BACrB;yBACF,EAAC,CAAC;qBACJ;oBAED,IAAI,CAAC,OAAK,oBAAoB,EAAE;wBAC9B,KAAK,GAAG,QAAQ,CAAC,KAAK,qBAAE,GAAG,IAAG,WAAW,CAAC,CAAC;qBAC5C;yBAAM;;;;;;;;;;wBAUL,IAAI,WAAW,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;4BACrE,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM;;;;;4BAAC,UAAC,WAAW,EAAE,UAAU;;;;;;;;gCAQpE,IAAI,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;oCAC1C,WAAW,CAAC,UAAU,CAAC,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;iCACnD;gCACD,OAAO,WAAW,CAAC;6BACpB,sBAAe,EAAE,GAAC,CAAC;yBACrB;wBAED,KAAK,gBAAQ,KAAK,EAAK,WAAW,CAAE,CAAC;qBACtC;iBACF;aACF;;;gBAhFD,KAAkB,IAAA,KAAAA,SAAA,IAAI,CAAC,KAAK,CAAA,gBAAA;oBAAvB,IAAM,GAAG,WAAA;4BAAH,GAAG;iBAgFb;;;;;;;;;SACF;QAED,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,CAC5B,GAAG;;;;QAAC,UAAA,SAAS;;YACX,IAAI,CAAC,oBAAoB,KAAK,oBAAoB,IAAI,YAAY,CAAC,EAAE;;oBACnE,KAAkB,IAAA,KAAAA,SAAA,KAAI,CAAC,KAAK,CAAA,gBAAA,4BAAE;wBAAzB,IAAM,GAAG,WAAA;;4BACR,GAAG,GAAG,SAAS;wBAEnB,IAAI,GAAG,KAAK,iBAAiB,EAAE;4BAC7B,GAAG,GAAG,QAAQ,CAAC,SAAS,qBAAE,GAAG,GAAE,CAAC;yBACjC;wBAED,IAAI;;gCACI,MAAM,GAAG,mBAAA,KAAI,CAAC,QAAQ,CAAC,eAAe,GAAE,GAAG,EAAE,GAAG,CAAC;4BACvD,KAAI,CAAC,OAAO,CAAC,OAAO,oBAAC,GAAG,IAAG,mBAAA,KAAI,CAAC,QAAQ,CAAC,SAAS,GAAE,MAAM,CAAC,CAAC,CAAC;yBAC9D;wBAAC,OAAO,KAAK,EAAE;;;4BAGd,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE;gCACjD,IACE,KAAK;qCACJ,KAAK,CAAC,IAAI,KAAK,oBAAoB;wCAClC,KAAK,CAAC,IAAI,KAAK,4BAA4B,CAAC,EAC9C;oCACA,OAAO,CAAC,KAAK,CACX,SAAO,GAAG,qDAAkD,EAC5D,GAAG,CACJ,CAAC;iCACH;qCAAM;oCACL,OAAO,CAAC,KAAK,CACX,yCAAuC,GAAG,yEAAsE,EAChH,GAAG,CACJ,CAAC;iCACH;6BACF;yBACF;qBACF;;;;;;;;;aACF;SACF,EAAC,CACH,CAAC;KACH;;gBAtJF,UAAU;;;;gDAUN,MAAM,SAAC,2BAA2B;gDAClC,MAAM,SAAC,cAAc;6CACrB,MAAM,SAAC,WAAW;;IA2IvB,wBAAC;CAvJD,IAuJC;;;;;;IAnJC,kCAA8C;;;;;IAE9C,iDACiE;;;;;IAG/D,qCAA+E;;;;;IAC/E,oCAAsD;;;;;IACtD,wCAAgD;;;IA6I9C,GAAG,GAAG,GAAG;;;;;;ACrLf;AAWA,IAAa,YAAY,GAAG,IAAI,cAAc,CAAC,cAAc,CAAC;AAE9D;IAAA;KA8BC;;;;;IA5BQ,+BAAO;;;;IAAd,UACE,OAAkC;QAElC,OAAO;YACL,QAAQ,EAAE,uBAAuB;YACjC,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,YAAY;oBACrB,QAAQ,EAAE,iBAAiB;oBAC3B,KAAK,EAAE,IAAI;iBACZ;gBACD;oBACE,OAAO,EAAE,YAAY;oBACrB,QAAQ,EAAE,OAAO;iBAClB;gBACD;oBACE,OAAO,EAAE,2BAA2B;oBACpC,UAAU,EAAE,qBAAqB;oBACjC,IAAI,EAAE,CAAC,YAAY,CAAC;iBACrB;gBACD;oBACE,OAAO,EAAE,cAAc;oBACvB,UAAU,EAAE,aAAa;oBACzB,IAAI,EAAE,CAAC,2BAA2B,EAAE,WAAW,CAAC;iBACjD;aACF;SACF,CAAC;KACH;;gBA7BF,QAAQ;;IA8BT,8BAAC;CA9BD;;;;;;;;;;;;;;;;;;;"}
|
|
1
|
+
{"version":3,"file":"ngxs-storage-plugin.js","sources":["ng://@ngxs/storage-plugin/src/symbols.ts","ng://@ngxs/storage-plugin/src/internals.ts","ng://@ngxs/storage-plugin/src/storage.plugin.ts","ng://@ngxs/storage-plugin/src/storage.module.ts"],"sourcesContent":["import { InjectionToken } from '@angular/core';\n\nimport { StorageKey } from './internals';\n\nexport const enum StorageOption {\n LocalStorage,\n SessionStorage\n}\n\nexport interface NgxsStoragePluginOptions {\n /**\n * Key for the state slice to store in the storage engine.\n */\n key?: StorageKey;\n\n /**\n * The namespace is used to prefix the key for the state slice. This is\n * necessary when running micro frontend applications which use storage plugin.\n * The namespace will eliminate the conflict between keys that might overlap.\n */\n namespace?: string;\n\n /**\n * Storage engine to use. Deaults to localStorage but can provide\n *\n * sessionStorage or custom implementation of the StorageEngine interface\n */\n storage?: StorageOption;\n\n /**\n * Migration strategies.\n */\n migrations?: {\n /**\n * Version to key off.\n */\n version: number | string;\n\n /**\n * Method to migrate the previous state.\n */\n migrate: (state: any) => any;\n\n /**\n * Key to migrate.\n */\n key?: string;\n\n /**\n * Key for the version. Defaults to 'version'.\n */\n versionKey?: string;\n }[];\n\n /**\n * Serailizer for the object before its pushed into the engine.\n */\n serialize?(obj: any): string;\n\n /**\n * Deserializer for the object before its pulled out of the engine.\n */\n deserialize?(obj: any): any;\n\n /**\n * Method to alter object before serialization.\n */\n beforeSerialize?(obj: any, key: string): any;\n\n /**\n * Method to alter object after deserialization.\n */\n afterDeserialize?(obj: any, key: string): any;\n}\n\nexport const NGXS_STORAGE_PLUGIN_OPTIONS = new InjectionToken('NGXS_STORAGE_PLUGIN_OPTIONS');\n\nexport const STORAGE_ENGINE = new InjectionToken('STORAGE_ENGINE');\n\nexport interface StorageEngine {\n readonly length: number;\n getItem(key: string): any;\n setItem(key: string, val: any): void;\n removeItem(key: string): void;\n clear(): void;\n}\n","import { isPlatformServer } from '@angular/common';\nimport { StateClass } from '@ngxs/store/internals';\nimport { StateToken } from '@ngxs/store';\n\nimport { StorageOption, StorageEngine, NgxsStoragePluginOptions } from './symbols';\n\n/**\n * If the `key` option is not provided then the below constant\n * will be used as a default key\n */\nexport const DEFAULT_STATE_KEY = '@@STATE';\n\n/**\n * Internal type definition for the `key` option provided\n * in the `forRoot` method when importing module\n */\nexport type StorageKey =\n | string\n | StateClass\n | StateToken<any>\n | (string | StateClass | StateToken<any>)[];\n\n/**\n * This key is used to retrieve static metadatas on state classes.\n * This constant is taken from the core codebase\n */\nconst META_OPTIONS_KEY = 'NGXS_OPTIONS_META';\n\nfunction transformKeyOption(key: StorageKey): string[] {\n if (!Array.isArray(key)) {\n key = [key];\n }\n\n return key.map((token: string | StateClass | StateToken<any>) => {\n // If it has the `NGXS_OPTIONS_META` key then it means the developer\n // has provided state class like `key: [AuthState]`.\n if (token.hasOwnProperty(META_OPTIONS_KEY)) {\n // The `name` property will be an actual state name or a `StateToken`.\n token = (token as any)[META_OPTIONS_KEY].name;\n }\n\n return token instanceof StateToken ? token.getName() : (token as string);\n });\n}\n\nexport function storageOptionsFactory(\n options: NgxsStoragePluginOptions | undefined\n): NgxsStoragePluginOptions {\n if (options !== undefined && options.key) {\n options.key = transformKeyOption(options.key);\n }\n\n return {\n key: [DEFAULT_STATE_KEY],\n storage: StorageOption.LocalStorage,\n serialize: JSON.stringify,\n deserialize: JSON.parse,\n beforeSerialize: obj => obj,\n afterDeserialize: obj => obj,\n ...options\n };\n}\n\nexport function engineFactory(\n options: NgxsStoragePluginOptions,\n platformId: string\n): StorageEngine | null {\n if (isPlatformServer(platformId)) {\n return null;\n }\n\n if (options.storage === StorageOption.LocalStorage) {\n return localStorage;\n } else if (options.storage === StorageOption.SessionStorage) {\n return sessionStorage;\n }\n\n return null;\n}\n\nexport function getStorageKey(key: string, options?: NgxsStoragePluginOptions): string {\n // Prepends the `namespace` option to any key if it's been provided by a user.\n // So `@@STATE` becomes `my-app:@@STATE`.\n return options && options.namespace ? `${options.namespace}:${key}` : key;\n}\n","import { PLATFORM_ID, Inject, Injectable } from '@angular/core';\nimport { isPlatformServer } from '@angular/common';\nimport { PlainObject } from '@ngxs/store/internals';\nimport {\n NgxsPlugin,\n setValue,\n getValue,\n InitState,\n UpdateState,\n actionMatcher,\n NgxsNextPluginFn\n} from '@ngxs/store';\nimport { tap } from 'rxjs/operators';\n\nimport {\n StorageEngine,\n NgxsStoragePluginOptions,\n STORAGE_ENGINE,\n NGXS_STORAGE_PLUGIN_OPTIONS\n} from './symbols';\nimport { DEFAULT_STATE_KEY, getStorageKey } from './internals';\n\n/**\n * @description Will be provided through Terser global definitions by Angular CLI\n * during the production build. This is how Angular does tree-shaking internally.\n */\ndeclare const ngDevMode: boolean;\n\n@Injectable()\nexport class NgxsStoragePlugin implements NgxsPlugin {\n // We cast to `string[]` here as we're sure that this option has been\n // transformed by the `storageOptionsFactory` function that provided token.\n private _keys = this._options.key as string[];\n // We default to `[DEFAULT_STATE_KEY]` if the user explicitly does not provide the `key` option.\n private _usesDefaultStateKey =\n this._keys.length === 1 && this._keys[0] === DEFAULT_STATE_KEY;\n\n constructor(\n @Inject(NGXS_STORAGE_PLUGIN_OPTIONS) private _options: NgxsStoragePluginOptions,\n @Inject(STORAGE_ENGINE) private _engine: StorageEngine,\n @Inject(PLATFORM_ID) private _platformId: string\n ) {}\n\n handle(state: any, event: any, next: NgxsNextPluginFn) {\n if (isPlatformServer(this._platformId) && this._engine === null) {\n return next(state, event);\n }\n\n const matches = actionMatcher(event);\n const isInitAction = matches(InitState);\n const isUpdateAction = matches(UpdateState);\n const isInitOrUpdateAction = isInitAction || isUpdateAction;\n let hasMigration = false;\n\n if (isInitOrUpdateAction) {\n const addedStates = isUpdateAction && event.addedStates;\n\n for (const key of this._keys) {\n // We're checking what states have been added by NGXS and if any of these states should be handled by\n // the storage plugin. For instance, we only want to deserialize the `auth` state, NGXS has added\n // the `user` state, the storage plugin will be rerun and will do redundant deserialization.\n // `usesDefaultStateKey` is necessary to check since `event.addedStates` never contains `@@STATE`.\n if (!this._usesDefaultStateKey && addedStates) {\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 = this._engine.getItem(storageKey);\n\n if (storedValue !== 'undefined' && storedValue != null) {\n try {\n const newVal = this._options.deserialize!(storedValue);\n storedValue = this._options.afterDeserialize!(newVal, key);\n } catch {\n // Caretaker note: we have still left the `typeof` condition in order to avoid\n // creating a breaking change for projects that still use the View Engine.\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n console.error(\n `Error ocurred while deserializing the ${storageKey} store value, falling back to empty object, the value obtained from the store: `,\n storedValue\n );\n }\n storedValue = {};\n }\n\n if (this._options.migrations) {\n this._options.migrations.forEach(strategy => {\n const versionMatch =\n strategy.version === getValue(storedValue, strategy.versionKey || 'version');\n const keyMatch =\n (!strategy.key && this._usesDefaultStateKey) || strategy.key === key;\n if (versionMatch && keyMatch) {\n storedValue = strategy.migrate(storedValue);\n hasMigration = true;\n }\n });\n }\n\n if (!this._usesDefaultStateKey) {\n state = setValue(state, key, storedValue);\n } else {\n // The `UpdateState` action is dispatched whenever the feature state is added.\n // The below condition is met only when the `UpdateState` is dispatched.\n // Let's assume that we have 2 states `counter` and `@ngxs/router-plugin` state.\n // `CounterState` is provided on the root level when calling `NgxsModule.forRoot()`\n // and `@ngxs/router-plugin` is provided as a feature state.\n // The storage plugin may save the `counter` state value as `10` before.\n // The `CounterState` may implement the `ngxsOnInit` hook and call `ctx.setState(999)`.\n // The storage plugin will re-hydrate the whole state when the `RouterState` is registered,\n // and the `counter` state will again equal `10` (not `999`).\n if (storedValue && addedStates && Object.keys(addedStates).length > 0) {\n storedValue = Object.keys(addedStates).reduce((accumulator, addedState) => {\n // The `storedValue` may equal the whole state (when the default state key is used).\n // If `addedStates` contains only `router` then we want to merge the state only\n // with the `router` value.\n // Let's assume that the `storedValue` is an object:\n // `{ counter: 10, router: {...} }`\n // This will pick only the `router` object from the `storedValue` and `counter`\n // state will not be re-hydrated unnecessary.\n if (storedValue.hasOwnProperty(addedState)) {\n accumulator[addedState] = storedValue[addedState];\n }\n return accumulator;\n }, <PlainObject>{});\n }\n\n state = { ...state, ...storedValue };\n }\n }\n }\n }\n\n return next(state, event).pipe(\n tap(nextState => {\n if (!isInitOrUpdateAction || (isInitOrUpdateAction && hasMigration)) {\n for (const key of this._keys) {\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 this._engine.setItem(storageKey, this._options.serialize!(newStoredValue));\n } catch (error) {\n // Caretaker note: we have still left the `typeof` condition in order to avoid\n // creating a breaking change for projects that still use the View Engine.\n if (typeof ngDevMode === 'undefined' || ngDevMode) {\n if (\n error &&\n (error.name === 'QuotaExceededError' ||\n error.name === 'NS_ERROR_DOM_QUOTA_REACHED')\n ) {\n console.error(\n `The ${storageKey} store value exceeds the browser storage quota: `,\n storedValue\n );\n } else {\n console.error(\n `Error ocurred while serializing the ${storageKey} store value, value not updated, the value obtained from the store: `,\n storedValue\n );\n }\n }\n }\n }\n }\n })\n );\n }\n}\n\nconst DOT = '.';\n","import { NgModule, ModuleWithProviders, PLATFORM_ID, InjectionToken } from '@angular/core';\nimport { NGXS_PLUGINS } from '@ngxs/store';\n\nimport {\n NgxsStoragePluginOptions,\n STORAGE_ENGINE,\n NGXS_STORAGE_PLUGIN_OPTIONS\n} from './symbols';\nimport { NgxsStoragePlugin } from './storage.plugin';\nimport { storageOptionsFactory, engineFactory } from './internals';\n\nexport const USER_OPTIONS = new InjectionToken('USER_OPTIONS');\n\n@NgModule()\nexport class NgxsStoragePluginModule {\n static forRoot(\n options?: NgxsStoragePluginOptions\n ): ModuleWithProviders<NgxsStoragePluginModule> {\n return {\n ngModule: NgxsStoragePluginModule,\n providers: [\n {\n provide: NGXS_PLUGINS,\n useClass: NgxsStoragePlugin,\n multi: true\n },\n {\n provide: USER_OPTIONS,\n useValue: options\n },\n {\n provide: NGXS_STORAGE_PLUGIN_OPTIONS,\n useFactory: storageOptionsFactory,\n deps: [USER_OPTIONS]\n },\n {\n provide: STORAGE_ENGINE,\n useFactory: engineFactory,\n deps: [NGXS_STORAGE_PLUGIN_OPTIONS, PLATFORM_ID]\n }\n ]\n };\n }\n}\n"],"names":["tslib_1.__values"],"mappings":";;;;;;;;;;AAAA;;IAKE,eAAY;IACZ,iBAAc;;;;;AAGhB,uCAgEC;;;;;;IA5DC,uCAAiB;;;;;;;IAOjB,6CAAmB;;;;;;;IAOnB,2CAAwB;;;;;IAKxB,8CAoBI;;;;;;IAKJ,kEAA6B;;;;;;IAK7B,oEAA4B;;;;;;;IAK5B,6EAA6C;;;;;;;IAK7C,8EAA8C;;;AAGhD,IAAa,2BAA2B,GAAG,IAAI,cAAc,CAAC,6BAA6B,CAAC;;AAE5F,IAAa,cAAc,GAAG,IAAI,cAAc,CAAC,gBAAgB,CAAC;;;;AAElE,4BAMC;;;IALC,+BAAwB;;;;;IACxB,qDAA0B;;;;;;IAC1B,0DAAqC;;;;;IACrC,wDAA8B;;;;IAC9B,gDAAc;;;;;;;;;;;;AC1EhB,IAAa,iBAAiB,GAAG,SAAS;;;;;;IAgBpC,gBAAgB,GAAG,mBAAmB;;;;;AAE5C,SAAS,kBAAkB,CAAC,GAAe;IACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACvB,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;KACb;IAED,OAAO,GAAG,CAAC,GAAG;;;;IAAC,UAAC,KAA4C;;;QAG1D,IAAI,KAAK,CAAC,cAAc,CAAC,gBAAgB,CAAC,EAAE;;YAE1C,KAAK,GAAG,oBAAC,KAAK,IAAS,gBAAgB,CAAC,CAAC,IAAI,CAAC;SAC/C;QAED,OAAO,KAAK,YAAY,UAAU,GAAG,KAAK,CAAC,OAAO,EAAE,uBAAI,KAAK,GAAW,CAAC;KAC1E,EAAC,CAAC;CACJ;;;;;AAED,SAAgB,qBAAqB,CACnC,OAA6C;IAE7C,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,EAAE;QACxC,OAAO,CAAC,GAAG,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;KAC/C;IAED,kBACE,GAAG,EAAE,CAAC,iBAAiB,CAAC,EACxB,OAAO,wBACP,SAAS,EAAE,IAAI,CAAC,SAAS,EACzB,WAAW,EAAE,IAAI,CAAC,KAAK,EACvB,eAAe;;;;QAAE,UAAA,GAAG,IAAI,OAAA,GAAG,GAAA,GAC3B,gBAAgB;;;;QAAE,UAAA,GAAG,IAAI,OAAA,GAAG,GAAA,KACzB,OAAO,EACV;CACH;;;;;;AAED,SAAgB,aAAa,CAC3B,OAAiC,EACjC,UAAkB;IAElB,IAAI,gBAAgB,CAAC,UAAU,CAAC,EAAE;QAChC,OAAO,IAAI,CAAC;KACb;IAED,IAAI,OAAO,CAAC,OAAO,2BAAiC;QAClD,OAAO,YAAY,CAAC;KACrB;SAAM,IAAI,OAAO,CAAC,OAAO,6BAAmC;QAC3D,OAAO,cAAc,CAAC;KACvB;IAED,OAAO,IAAI,CAAC;CACb;;;;;;AAED,SAAgB,aAAa,CAAC,GAAW,EAAE,OAAkC;;;IAG3E,OAAO,OAAO,IAAI,OAAO,CAAC,SAAS,GAAM,OAAO,CAAC,SAAS,SAAI,GAAK,GAAG,GAAG,CAAC;CAC3E;;;;;;;IC/CC,2BAC+C,QAAkC,EAC/C,OAAsB,EACzB,WAAmB;QAFH,aAAQ,GAAR,QAAQ,CAA0B;QAC/C,YAAO,GAAP,OAAO,CAAe;QACzB,gBAAW,GAAX,WAAW,CAAQ;;;QAR1C,UAAK,sBAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAY,CAAC;;QAEtC,yBAAoB,GAC1B,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,iBAAiB,CAAC;KAM7D;;;;;;;IAEJ,kCAAM;;;;;;IAAN,UAAO,KAAU,EAAE,KAAU,EAAE,IAAsB;QAArD,iBA0IC;;QAzIC,IAAI,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE;YAC/D,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;SAC3B;;YAEK,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC;;YAC9B,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;;YACjC,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;;YACrC,oBAAoB,GAAG,YAAY,IAAI,cAAc;;YACvD,YAAY,GAAG,KAAK;QAExB,IAAI,oBAAoB,EAAE;;gBAClB,WAAW,GAAG,cAAc,IAAI,KAAK,CAAC,WAAW;oCAE5C,GAAG;;;;;gBAKZ,IAAI,CAAC,OAAK,oBAAoB,IAAI,WAAW,EAAE;;;;;;;wBAMvC,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC;;wBACnC,SAAS,GAAG,gBAAgB,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC,GAAG,GAAG;oBAC9E,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE;;qBAE3C;iBACF;;oBAEK,UAAU,GAAG,aAAa,CAAC,GAAG,EAAE,OAAK,QAAQ,CAAC;;oBAChD,WAAW,GAAQ,OAAK,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;gBAEvD,IAAI,WAAW,KAAK,WAAW,IAAI,WAAW,IAAI,IAAI,EAAE;oBACtD,IAAI;;4BACI,MAAM,GAAG,mBAAA,OAAK,QAAQ,CAAC,WAAW,GAAE,WAAW,CAAC;wBACtD,WAAW,GAAG,mBAAA,OAAK,QAAQ,CAAC,gBAAgB,GAAE,MAAM,EAAE,GAAG,CAAC,CAAC;qBAC5D;oBAAC,WAAM;;;wBAGN,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE;4BACjD,OAAO,CAAC,KAAK,CACX,2CAAyC,UAAU,oFAAiF,EACpI,WAAW,CACZ,CAAC;yBACH;wBACD,WAAW,GAAG,EAAE,CAAC;qBAClB;oBAED,IAAI,OAAK,QAAQ,CAAC,UAAU,EAAE;wBAC5B,OAAK,QAAQ,CAAC,UAAU,CAAC,OAAO;;;;wBAAC,UAAA,QAAQ;;gCACjC,YAAY,GAChB,QAAQ,CAAC,OAAO,KAAK,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,UAAU,IAAI,SAAS,CAAC;;gCACxE,QAAQ,GACZ,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,KAAI,CAAC,oBAAoB,KAAK,QAAQ,CAAC,GAAG,KAAK,GAAG;4BACtE,IAAI,YAAY,IAAI,QAAQ,EAAE;gCAC5B,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gCAC5C,YAAY,GAAG,IAAI,CAAC;6BACrB;yBACF,EAAC,CAAC;qBACJ;oBAED,IAAI,CAAC,OAAK,oBAAoB,EAAE;wBAC9B,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;qBAC3C;yBAAM;;;;;;;;;;wBAUL,IAAI,WAAW,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;4BACrE,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM;;;;;4BAAC,UAAC,WAAW,EAAE,UAAU;;;;;;;;gCAQpE,IAAI,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;oCAC1C,WAAW,CAAC,UAAU,CAAC,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;iCACnD;gCACD,OAAO,WAAW,CAAC;6BACpB,sBAAe,EAAE,GAAC,CAAC;yBACrB;wBAED,KAAK,gBAAQ,KAAK,EAAK,WAAW,CAAE,CAAC;qBACtC;iBACF;aACF;;;gBAjFD,KAAkB,IAAA,KAAAA,SAAA,IAAI,CAAC,KAAK,CAAA,gBAAA;oBAAvB,IAAM,GAAG,WAAA;4BAAH,GAAG;iBAiFb;;;;;;;;;SACF;QAED,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,CAC5B,GAAG;;;;QAAC,UAAA,SAAS;;YACX,IAAI,CAAC,oBAAoB,KAAK,oBAAoB,IAAI,YAAY,CAAC,EAAE;;oBACnE,KAAkB,IAAA,KAAAA,SAAA,KAAI,CAAC,KAAK,CAAA,gBAAA,4BAAE;wBAAzB,IAAM,GAAG,WAAA;;4BACR,WAAW,GAAG,SAAS;;4BAErB,UAAU,GAAG,aAAa,CAAC,GAAG,EAAE,KAAI,CAAC,QAAQ,CAAC;wBAEpD,IAAI,GAAG,KAAK,iBAAiB,EAAE;4BAC7B,WAAW,GAAG,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;yBACxC;wBAED,IAAI;;gCACI,cAAc,GAAG,mBAAA,KAAI,CAAC,QAAQ,CAAC,eAAe,GAAE,WAAW,EAAE,GAAG,CAAC;4BACvE,KAAI,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,mBAAA,KAAI,CAAC,QAAQ,CAAC,SAAS,GAAE,cAAc,CAAC,CAAC,CAAC;yBAC5E;wBAAC,OAAO,KAAK,EAAE;;;4BAGd,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,EAAE;gCACjD,IACE,KAAK;qCACJ,KAAK,CAAC,IAAI,KAAK,oBAAoB;wCAClC,KAAK,CAAC,IAAI,KAAK,4BAA4B,CAAC,EAC9C;oCACA,OAAO,CAAC,KAAK,CACX,SAAO,UAAU,qDAAkD,EACnE,WAAW,CACZ,CAAC;iCACH;qCAAM;oCACL,OAAO,CAAC,KAAK,CACX,yCAAuC,UAAU,yEAAsE,EACvH,WAAW,CACZ,CAAC;iCACH;6BACF;yBACF;qBACF;;;;;;;;;aACF;SACF,EAAC,CACH,CAAC;KACH;;gBAzJF,UAAU;;;;gDAUN,MAAM,SAAC,2BAA2B;gDAClC,MAAM,SAAC,cAAc;6CACrB,MAAM,SAAC,WAAW;;IA8IvB,wBAAC;CA1JD,IA0JC;;;;;;IAtJC,kCAA8C;;;;;IAE9C,iDACiE;;;;;IAG/D,qCAA+E;;;;;IAC/E,oCAAsD;;;;;IACtD,wCAAgD;;;IAgJ9C,GAAG,GAAG,GAAG;;;;;;ACxLf;AAWA,IAAa,YAAY,GAAG,IAAI,cAAc,CAAC,cAAc,CAAC;AAE9D;IAAA;KA8BC;;;;;IA5BQ,+BAAO;;;;IAAd,UACE,OAAkC;QAElC,OAAO;YACL,QAAQ,EAAE,uBAAuB;YACjC,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,YAAY;oBACrB,QAAQ,EAAE,iBAAiB;oBAC3B,KAAK,EAAE,IAAI;iBACZ;gBACD;oBACE,OAAO,EAAE,YAAY;oBACrB,QAAQ,EAAE,OAAO;iBAClB;gBACD;oBACE,OAAO,EAAE,2BAA2B;oBACpC,UAAU,EAAE,qBAAqB;oBACjC,IAAI,EAAE,CAAC,YAAY,CAAC;iBACrB;gBACD;oBACE,OAAO,EAAE,cAAc;oBACvB,UAAU,EAAE,aAAa;oBACzB,IAAI,EAAE,CAAC,2BAA2B,EAAE,WAAW,CAAC;iBACjD;aACF;SACF,CAAC;KACH;;gBA7BF,QAAQ;;IA8BT,8BAAC;CA9BD;;;;;;;;;;;;;;;;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"__symbolic":"module","version":4,"metadata":{"ɵa":{"__symbolic":"new","expression":{"__symbolic":"reference","module":"@angular/core","name":"InjectionToken","line":11,"character":32},"arguments":["USER_OPTIONS"]},"NgxsStoragePluginModule":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"NgModule","line":13,"character":1}}],"members":{},"statics":{"forRoot":{"__symbolic":"function","parameters":["options"],"value":{"ngModule":{"__symbolic":"reference","name":"NgxsStoragePluginModule"},"providers":[{"provide":{"__symbolic":"reference","module":"@ngxs/store","name":"NGXS_PLUGINS","line":22,"character":19},"useClass":{"__symbolic":"reference","name":"NgxsStoragePlugin"},"multi":true},{"provide":{"__symbolic":"reference","name":"ɵa"},"useValue":{"__symbolic":"reference","name":"options"}},{"provide":{"__symbolic":"reference","name":"NGXS_STORAGE_PLUGIN_OPTIONS"},"useFactory":{"__symbolic":"reference","name":"ɵb"},"deps":[{"__symbolic":"reference","name":"ɵa"}]},{"provide":{"__symbolic":"reference","name":"STORAGE_ENGINE"},"useFactory":{"__symbolic":"reference","name":"ɵc"},"deps":[{"__symbolic":"reference","name":"NGXS_STORAGE_PLUGIN_OPTIONS"},{"__symbolic":"reference","module":"@angular/core","name":"PLATFORM_ID","line":38,"character":46}]}]}}}},"NgxsStoragePlugin":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Injectable","line":28,"character":1}}],"members":{"__ctor__":[{"__symbolic":"constructor","parameterDecorators":[[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Inject","line":38,"character":5},"arguments":[{"__symbolic":"reference","name":"NGXS_STORAGE_PLUGIN_OPTIONS"}]}],[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Inject","line":39,"character":5},"arguments":[{"__symbolic":"reference","name":"STORAGE_ENGINE"}]}],[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Inject","line":40,"character":5},"arguments":[{"__symbolic":"reference","module":"@angular/core","name":"PLATFORM_ID","line":40,"character":12}]}]],"parameters":[{"__symbolic":"reference","name":"NgxsStoragePluginOptions"},{"__symbolic":"reference","name":"StorageEngine"},{"__symbolic":"reference","name":"string"}]}],"handle":[{"__symbolic":"method"}]}},"StorageOption":{"LocalStorage":0,"SessionStorage":1},"NgxsStoragePluginOptions":{"__symbolic":"interface"},"NGXS_STORAGE_PLUGIN_OPTIONS":{"__symbolic":"new","expression":{"__symbolic":"reference","module":"@angular/core","name":"InjectionToken","line":
|
|
1
|
+
{"__symbolic":"module","version":4,"metadata":{"ɵa":{"__symbolic":"new","expression":{"__symbolic":"reference","module":"@angular/core","name":"InjectionToken","line":11,"character":32},"arguments":["USER_OPTIONS"]},"NgxsStoragePluginModule":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"NgModule","line":13,"character":1}}],"members":{},"statics":{"forRoot":{"__symbolic":"function","parameters":["options"],"value":{"ngModule":{"__symbolic":"reference","name":"NgxsStoragePluginModule"},"providers":[{"provide":{"__symbolic":"reference","module":"@ngxs/store","name":"NGXS_PLUGINS","line":22,"character":19},"useClass":{"__symbolic":"reference","name":"NgxsStoragePlugin"},"multi":true},{"provide":{"__symbolic":"reference","name":"ɵa"},"useValue":{"__symbolic":"reference","name":"options"}},{"provide":{"__symbolic":"reference","name":"NGXS_STORAGE_PLUGIN_OPTIONS"},"useFactory":{"__symbolic":"reference","name":"ɵb"},"deps":[{"__symbolic":"reference","name":"ɵa"}]},{"provide":{"__symbolic":"reference","name":"STORAGE_ENGINE"},"useFactory":{"__symbolic":"reference","name":"ɵc"},"deps":[{"__symbolic":"reference","name":"NGXS_STORAGE_PLUGIN_OPTIONS"},{"__symbolic":"reference","module":"@angular/core","name":"PLATFORM_ID","line":38,"character":46}]}]}}}},"NgxsStoragePlugin":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Injectable","line":28,"character":1}}],"members":{"__ctor__":[{"__symbolic":"constructor","parameterDecorators":[[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Inject","line":38,"character":5},"arguments":[{"__symbolic":"reference","name":"NGXS_STORAGE_PLUGIN_OPTIONS"}]}],[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Inject","line":39,"character":5},"arguments":[{"__symbolic":"reference","name":"STORAGE_ENGINE"}]}],[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Inject","line":40,"character":5},"arguments":[{"__symbolic":"reference","module":"@angular/core","name":"PLATFORM_ID","line":40,"character":12}]}]],"parameters":[{"__symbolic":"reference","name":"NgxsStoragePluginOptions"},{"__symbolic":"reference","name":"StorageEngine"},{"__symbolic":"reference","name":"string"}]}],"handle":[{"__symbolic":"method"}]}},"StorageOption":{"LocalStorage":0,"SessionStorage":1},"NgxsStoragePluginOptions":{"__symbolic":"interface"},"NGXS_STORAGE_PLUGIN_OPTIONS":{"__symbolic":"new","expression":{"__symbolic":"reference","module":"@angular/core","name":"InjectionToken","line":75,"character":47},"arguments":["NGXS_STORAGE_PLUGIN_OPTIONS"]},"STORAGE_ENGINE":{"__symbolic":"new","expression":{"__symbolic":"reference","module":"@angular/core","name":"InjectionToken","line":77,"character":34},"arguments":["STORAGE_ENGINE"]},"StorageEngine":{"__symbolic":"interface"},"ɵb":{"__symbolic":"function"},"ɵc":{"__symbolic":"function"}},"origins":{"ɵa":"./src/storage.module","NgxsStoragePluginModule":"./src/storage.module","NgxsStoragePlugin":"./src/storage.plugin","StorageOption":"./src/symbols","NgxsStoragePluginOptions":"./src/symbols","NGXS_STORAGE_PLUGIN_OPTIONS":"./src/symbols","STORAGE_ENGINE":"./src/symbols","StorageEngine":"./src/symbols","ɵb":"./src/internals","ɵc":"./src/internals"},"importAs":"@ngxs/storage-plugin"}
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"$schema": "../../node_modules/ng-packagr/package.schema.json",
|
|
3
3
|
"name": "@ngxs/storage-plugin",
|
|
4
4
|
"description": "extendable storage plugin for @ngxs/store",
|
|
5
|
-
"version": "3.7.5-dev.master-
|
|
5
|
+
"version": "3.7.5-dev.master-27cb95c",
|
|
6
6
|
"sideEffects": true,
|
|
7
7
|
"peerDependencies": {
|
|
8
8
|
"@angular/core": ">=6.1.0 <16.0.0",
|
package/src/internals.d.ts
CHANGED
|
@@ -13,3 +13,4 @@ export declare const DEFAULT_STATE_KEY = "@@STATE";
|
|
|
13
13
|
export declare type StorageKey = string | StateClass | StateToken<any> | (string | StateClass | StateToken<any>)[];
|
|
14
14
|
export declare function storageOptionsFactory(options: NgxsStoragePluginOptions | undefined): NgxsStoragePluginOptions;
|
|
15
15
|
export declare function engineFactory(options: NgxsStoragePluginOptions, platformId: string): StorageEngine | null;
|
|
16
|
+
export declare function getStorageKey(key: string, options?: NgxsStoragePluginOptions): string;
|
package/src/symbols.d.ts
CHANGED
|
@@ -8,7 +8,13 @@ export interface NgxsStoragePluginOptions {
|
|
|
8
8
|
/**
|
|
9
9
|
* Key for the state slice to store in the storage engine.
|
|
10
10
|
*/
|
|
11
|
-
key?:
|
|
11
|
+
key?: StorageKey;
|
|
12
|
+
/**
|
|
13
|
+
* The namespace is used to prefix the key for the state slice. This is
|
|
14
|
+
* necessary when running micro frontend applications which use storage plugin.
|
|
15
|
+
* The namespace will eliminate the conflict between keys that might overlap.
|
|
16
|
+
*/
|
|
17
|
+
namespace?: string;
|
|
12
18
|
/**
|
|
13
19
|
* Storage engine to use. Deaults to localStorage but can provide
|
|
14
20
|
*
|