@ngxs/storage-plugin 3.8.1 → 3.8.2-dev.master-a75608e

package/fesm2020/ngxs-storage-plugin.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ngxs-storage-plugin.mjs","sources":["../../../packages/storage-plugin/src/internals.ts","../../../packages/storage-plugin/src/storage.plugin.ts","../../../packages/storage-plugin/src/storage.module.ts","../../../packages/storage-plugin/src/engines.ts","../../../packages/storage-plugin/index.ts","../../../packages/storage-plugin/ngxs-storage-plugin.ts"],"sourcesContent":["import { isPlatformServer } from '@angular/common';\nimport {\n  ɵDEFAULT_STATE_KEY,\n  StorageOption,\n  StorageEngine,\n  NgxsStoragePluginOptions\n} from '@ngxs/storage-plugin/internals';\n\nexport function storageOptionsFactory(\n  options: NgxsStoragePluginOptions | undefined\n): NgxsStoragePluginOptions {\n  return {\n    key: [ɵDEFAULT_STATE_KEY],\n    storage: StorageOption.LocalStorage,\n    serialize: JSON.stringify,\n    deserialize: JSON.parse,\n    beforeSerialize: obj => obj,\n    afterDeserialize: obj => obj,\n    ...options\n  };\n}\n\nexport function engineFactory(\n  options: NgxsStoragePluginOptions,\n  platformId: string\n): StorageEngine | null {\n  if (isPlatformServer(platformId)) {\n    return null;\n  }\n\n  if (options.storage === StorageOption.LocalStorage) {\n    return localStorage;\n  } else if (options.storage === StorageOption.SessionStorage) {\n    return sessionStorage;\n  }\n\n  return null;\n}\n\nexport function getStorageKey(key: string, options?: NgxsStoragePluginOptions): string {\n  // Prepends the `namespace` option to any key if it's been provided by a user.\n  // So `@@STATE` becomes `my-app:@@STATE`.\n  return options && options.namespace ? `${options.namespace}:${key}` : key;\n}\n","import { 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 {\n  ɵDEFAULT_STATE_KEY,\n  ɵFinalNgxsStoragePluginOptions,\n  ɵFINAL_NGXS_STORAGE_PLUGIN_OPTIONS\n} from '@ngxs/storage-plugin/internals';\nimport { tap } from 'rxjs/operators';\n\nimport { getStorageKey } from './internals';\n\ndeclare const ngDevMode: boolean;\n\nconst NG_DEV_MODE = typeof ngDevMode === 'undefined' || ngDevMode;\n\n@Injectable()\nexport class NgxsStoragePlugin implements NgxsPlugin {\n  private _keysWithEngines = this._options.keysWithEngines;\n  // We default to `[ɵDEFAULT_STATE_KEY]` if the user explicitly does not provide the `key` option.\n  private _usesDefaultStateKey =\n    this._keysWithEngines.length === 1 && this._keysWithEngines[0].key === ɵDEFAULT_STATE_KEY;\n\n  constructor(\n    @Inject(ɵFINAL_NGXS_STORAGE_PLUGIN_OPTIONS)\n    private _options: ɵFinalNgxsStoragePluginOptions,\n    @Inject(PLATFORM_ID) private _platformId: string\n  ) {}\n\n  handle(state: any, event: any, next: NgxsNextPluginFn) {\n    if (isPlatformServer(this._platformId)) {\n      return next(state, event);\n    }\n\n    const matches = actionMatcher(event);\n    const isInitAction = matches(InitState);\n    const isUpdateAction = matches(UpdateState);\n    const isInitOrUpdateAction = isInitAction || isUpdateAction;\n    let hasMigration = false;\n\n    if (isInitOrUpdateAction) {\n      const addedStates = isUpdateAction && event.addedStates;\n\n      for (const { key, engine } of this._keysWithEngines) {\n        // We're checking what states have been added by NGXS and if any of these states should be handled by\n        // the storage plugin. For instance, we only want to deserialize the `auth` state, NGXS has added\n        // the `user` state, the storage plugin will be rerun and will do redundant deserialization.\n        // `usesDefaultStateKey` is necessary to check since `event.addedStates` never contains `@@STATE`.\n        if (!this._usesDefaultStateKey && addedStates) {\n          // We support providing keys that can be deeply nested via dot notation, for instance,\n          // `keys: ['myState.myProperty']` is a valid key.\n          // The state name should always go first. The below code checks if the `key` includes dot\n          // notation and extracts the state name out of the key.\n          // Given the `key` is `myState.myProperty`, the `addedStates` will only contain `myState`.\n          const dotNotationIndex = key.indexOf(DOT);\n          const stateName = dotNotationIndex > -1 ? key.slice(0, dotNotationIndex) : key;\n          if (!addedStates.hasOwnProperty(stateName)) {\n            continue;\n          }\n        }\n\n        const storageKey = getStorageKey(key, this._options);\n        let storedValue: any = engine.getItem(storageKey);\n\n        if (storedValue !== 'undefined' && storedValue != null) {\n          try {\n            const newVal = this._options.deserialize!(storedValue);\n            storedValue = this._options.afterDeserialize!(newVal, key);\n          } catch {\n            NG_DEV_MODE &&\n              console.error(\n                `Error ocurred while deserializing the ${storageKey} store value, falling back to empty object, the value obtained from the store: `,\n                storedValue\n              );\n\n            storedValue = {};\n          }\n\n          this._options.migrations?.forEach(strategy => {\n            const versionMatch =\n              strategy.version === getValue(storedValue, strategy.versionKey || 'version');\n            const keyMatch =\n              (!strategy.key && this._usesDefaultStateKey) || strategy.key === key;\n            if (versionMatch && keyMatch) {\n              storedValue = strategy.migrate(storedValue);\n              hasMigration = true;\n            }\n          });\n\n          if (!this._usesDefaultStateKey) {\n            state = setValue(state, key, storedValue);\n          } else {\n            // The `UpdateState` action is dispatched whenever the feature\n            // state is added. The condition below is satisfied only when\n            // the `UpdateState` action is dispatched. Let's consider two states:\n            // `counter` and `@ngxs/router-plugin` state. When we call `NgxsModule.forRoot()`,\n            // `CounterState` is provided at the root level, while `@ngxs/router-plugin`\n            // is provided as a feature state. Beforehand, the storage plugin may have\n            // stored the value of the counter state as `10`. If `CounterState` implements\n            // the `ngxsOnInit` hook and calls `ctx.setState(999)`, the storage plugin\n            // will rehydrate the entire state when the `RouterState` is registered.\n            // Consequently, the `counter` state will revert back to `10` instead of `999`.\n            if (storedValue && addedStates && Object.keys(addedStates).length > 0) {\n              storedValue = Object.keys(addedStates).reduce((accumulator, addedState) => {\n                // The `storedValue` can be equal to the entire state when the default\n                // state key is used. However, if `addedStates` only contains the `router` value,\n                // we only want to merge the state 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 rehydrated 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 && !hasMigration) {\n          return;\n        }\n\n        for (const { key, engine } of this._keysWithEngines) {\n          let storedValue = nextState;\n\n          const storageKey = getStorageKey(key, this._options);\n\n          if (key !== ɵDEFAULT_STATE_KEY) {\n            storedValue = getValue(nextState, key);\n          }\n\n          try {\n            const newStoredValue = this._options.beforeSerialize!(storedValue, key);\n            engine.setItem(storageKey, this._options.serialize!(newStoredValue));\n          } catch (error: any) {\n            if (NG_DEV_MODE) {\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\nconst DOT = '.';\n","import {\n  NgModule,\n  ModuleWithProviders,\n  PLATFORM_ID,\n  InjectionToken,\n  Injector,\n  EnvironmentProviders,\n  makeEnvironmentProviders\n} from '@angular/core';\nimport { NGXS_PLUGINS, withNgxsPlugin } from '@ngxs/store';\nimport {\n  NgxsStoragePluginOptions,\n  STORAGE_ENGINE,\n  ɵNGXS_STORAGE_PLUGIN_OPTIONS,\n  ɵcreateFinalStoragePluginOptions,\n  ɵFINAL_NGXS_STORAGE_PLUGIN_OPTIONS\n} from '@ngxs/storage-plugin/internals';\n\nimport { NgxsStoragePlugin } from './storage.plugin';\nimport { engineFactory, storageOptionsFactory } from './internals';\n\ndeclare const ngDevMode: boolean;\n\nconst NG_DEV_MODE = typeof ngDevMode === 'undefined' || ngDevMode;\n\nexport const USER_OPTIONS = new InjectionToken(NG_DEV_MODE ? 'USER_OPTIONS' : '');\n\n@NgModule()\nexport class NgxsStoragePluginModule {\n  static forRoot(\n    options?: NgxsStoragePluginOptions\n  ): ModuleWithProviders<NgxsStoragePluginModule> {\n    return {\n      ngModule: NgxsStoragePluginModule,\n      providers: [\n        {\n          provide: NGXS_PLUGINS,\n          useClass: NgxsStoragePlugin,\n          multi: true\n        },\n        {\n          provide: USER_OPTIONS,\n          useValue: options\n        },\n        {\n          provide: ɵNGXS_STORAGE_PLUGIN_OPTIONS,\n          useFactory: storageOptionsFactory,\n          deps: [USER_OPTIONS]\n        },\n        {\n          provide: STORAGE_ENGINE,\n          useFactory: engineFactory,\n          deps: [ɵNGXS_STORAGE_PLUGIN_OPTIONS, PLATFORM_ID]\n        },\n        {\n          provide: ɵFINAL_NGXS_STORAGE_PLUGIN_OPTIONS,\n          useFactory: ɵcreateFinalStoragePluginOptions,\n          deps: [Injector, ɵNGXS_STORAGE_PLUGIN_OPTIONS]\n        }\n      ]\n    };\n  }\n}\n\nexport function withNgxsStoragePlugin(\n  options?: NgxsStoragePluginOptions\n): EnvironmentProviders {\n  return makeEnvironmentProviders([\n    withNgxsPlugin(NgxsStoragePlugin),\n    {\n      provide: USER_OPTIONS,\n      useValue: options\n    },\n    {\n      provide: ɵNGXS_STORAGE_PLUGIN_OPTIONS,\n      useFactory: storageOptionsFactory,\n      deps: [USER_OPTIONS]\n    },\n    {\n      provide: STORAGE_ENGINE,\n      useFactory: engineFactory,\n      deps: [ɵNGXS_STORAGE_PLUGIN_OPTIONS, PLATFORM_ID]\n    },\n    {\n      provide: ɵFINAL_NGXS_STORAGE_PLUGIN_OPTIONS,\n      useFactory: ɵcreateFinalStoragePluginOptions,\n      deps: [Injector, ɵNGXS_STORAGE_PLUGIN_OPTIONS]\n    }\n  ]);\n}\n","import { InjectionToken, PLATFORM_ID, inject } from '@angular/core';\nimport { isPlatformBrowser } from '@angular/common';\nimport { StorageEngine } from '@ngxs/storage-plugin/internals';\n\ndeclare const ngDevMode: boolean;\n\nconst NG_DEV_MODE = typeof ngDevMode === 'undefined' || ngDevMode;\n\nexport const LOCAL_STORAGE_ENGINE = new InjectionToken<StorageEngine | null>(\n  NG_DEV_MODE ? 'LOCAL_STORAGE_ENGINE' : '',\n  {\n    providedIn: 'root',\n    factory: () => (isPlatformBrowser(inject(PLATFORM_ID)) ? localStorage : null)\n  }\n);\n\nexport const SESSION_STORAGE_ENGINE = new InjectionToken<StorageEngine | null>(\n  NG_DEV_MODE ? 'SESSION_STORAGE_ENGINE' : '',\n  {\n    providedIn: 'root',\n    factory: () => (isPlatformBrowser(inject(PLATFORM_ID)) ? sessionStorage : null)\n  }\n);\n","/**\n * The public api for consumers of @ngxs/storage-plugin\n */\nexport * from './src/public_api';\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":["NG_DEV_MODE"],"mappings":";;;;;;;;AAQM,SAAU,qBAAqB,CACnC,OAA6C,EAAA;IAE7C,OAAO;QACL,GAAG,EAAE,CAAC,kBAAkB,CAAC;AACzB,QAAA,OAAO,EAA4B,CAAA;QACnC,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,WAAW,EAAE,IAAI,CAAC,KAAK;AACvB,QAAA,eAAe,EAAE,GAAG,IAAI,GAAG;AAC3B,QAAA,gBAAgB,EAAE,GAAG,IAAI,GAAG;AAC5B,QAAA,GAAG,OAAO;KACX,CAAC;AACJ,CAAC;AAEe,SAAA,aAAa,CAC3B,OAAiC,EACjC,UAAkB,EAAA;AAElB,IAAA,IAAI,gBAAgB,CAAC,UAAU,CAAC,EAAE;AAChC,QAAA,OAAO,IAAI,CAAC;AACb,KAAA;AAED,IAAA,IAAI,OAAO,CAAC,OAAO,KAAA,CAAA,mCAAiC;AAClD,QAAA,OAAO,YAAY,CAAC;AACrB,KAAA;AAAM,SAAA,IAAI,OAAO,CAAC,OAAO,KAAA,CAAA,qCAAmC;AAC3D,QAAA,OAAO,cAAc,CAAC;AACvB,KAAA;AAED,IAAA,OAAO,IAAI,CAAC;AACd,CAAC;AAEe,SAAA,aAAa,CAAC,GAAW,EAAE,OAAkC,EAAA;;;AAG3E,IAAA,OAAO,OAAO,IAAI,OAAO,CAAC,SAAS,GAAG,CAAA,EAAG,OAAO,CAAC,SAAS,IAAI,GAAG,CAAA,CAAE,GAAG,GAAG,CAAC;AAC5E;;ACpBA,MAAMA,aAAW,GAAG,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,CAAC;MAGrD,iBAAiB,CAAA;IAM5B,WAEU,CAAA,QAAwC,EACnB,WAAmB,EAAA;QADxC,IAAQ,CAAA,QAAA,GAAR,QAAQ,CAAgC;QACnB,IAAW,CAAA,WAAA,GAAX,WAAW,CAAQ;AAR1C,QAAA,IAAA,CAAA,gBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;;AAEjD,QAAA,IAAA,CAAA,oBAAoB,GAC1B,IAAI,CAAC,gBAAgB,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,kBAAkB,CAAC;KAMxF;AAEJ,IAAA,MAAM,CAAC,KAAU,EAAE,KAAU,EAAE,IAAsB,EAAA;AACnD,QAAA,IAAI,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;AACtC,YAAA,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAC3B,SAAA;AAED,QAAA,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;AACrC,QAAA,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;AACxC,QAAA,MAAM,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;AAC5C,QAAA,MAAM,oBAAoB,GAAG,YAAY,IAAI,cAAc,CAAC;QAC5D,IAAI,YAAY,GAAG,KAAK,CAAC;AAEzB,QAAA,IAAI,oBAAoB,EAAE;AACxB,YAAA,MAAM,WAAW,GAAG,cAAc,IAAI,KAAK,CAAC,WAAW,CAAC;YAExD,KAAK,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,gBAAgB,EAAE;;;;;AAKnD,gBAAA,IAAI,CAAC,IAAI,CAAC,oBAAoB,IAAI,WAAW,EAAE;;;;;;oBAM7C,MAAM,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;oBAC1C,MAAM,SAAS,GAAG,gBAAgB,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC,GAAG,GAAG,CAAC;AAC/E,oBAAA,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE;wBAC1C,SAAS;AACV,qBAAA;AACF,iBAAA;gBAED,MAAM,UAAU,GAAG,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACrD,IAAI,WAAW,GAAQ,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAElD,gBAAA,IAAI,WAAW,KAAK,WAAW,IAAI,WAAW,IAAI,IAAI,EAAE;oBACtD,IAAI;wBACF,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAY,CAAC,WAAW,CAAC,CAAC;wBACvD,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,gBAAiB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC5D,qBAAA;oBAAC,MAAM;wBACNA,aAAW;4BACT,OAAO,CAAC,KAAK,CACX,CAAA,sCAAA,EAAyC,UAAU,CAAiF,+EAAA,CAAA,EACpI,WAAW,CACZ,CAAC;wBAEJ,WAAW,GAAG,EAAE,CAAC;AAClB,qBAAA;oBAED,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,IAAG;AAC3C,wBAAA,MAAM,YAAY,GAChB,QAAQ,CAAC,OAAO,KAAK,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,UAAU,IAAI,SAAS,CAAC,CAAC;AAC/E,wBAAA,MAAM,QAAQ,GACZ,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,IAAI,CAAC,oBAAoB,KAAK,QAAQ,CAAC,GAAG,KAAK,GAAG,CAAC;wBACvE,IAAI,YAAY,IAAI,QAAQ,EAAE;AAC5B,4BAAA,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;4BAC5C,YAAY,GAAG,IAAI,CAAC;AACrB,yBAAA;AACH,qBAAC,CAAC,CAAC;AAEH,oBAAA,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE;wBAC9B,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;AAC3C,qBAAA;AAAM,yBAAA;;;;;;;;;;;AAWL,wBAAA,IAAI,WAAW,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;AACrE,4BAAA,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,UAAU,KAAI;;;;;;;;AAQxE,gCAAA,IAAI,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;oCAC1C,WAAW,CAAC,UAAU,CAAC,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;AACnD,iCAAA;AACD,gCAAA,OAAO,WAAW,CAAC;6BACpB,EAAe,EAAE,CAAC,CAAC;AACrB,yBAAA;wBAED,KAAK,GAAG,EAAE,GAAG,KAAK,EAAE,GAAG,WAAW,EAAE,CAAC;AACtC,qBAAA;AACF,iBAAA;AACF,aAAA;AACF,SAAA;AAED,QAAA,OAAO,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,CAC5B,GAAG,CAAC,SAAS,IAAG;AACd,YAAA,IAAI,oBAAoB,IAAI,CAAC,YAAY,EAAE;gBACzC,OAAO;AACR,aAAA;YAED,KAAK,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,gBAAgB,EAAE;gBACnD,IAAI,WAAW,GAAG,SAAS,CAAC;gBAE5B,MAAM,UAAU,GAAG,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAErD,IAAI,GAAG,KAAK,kBAAkB,EAAE;AAC9B,oBAAA,WAAW,GAAG,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AACxC,iBAAA;gBAED,IAAI;AACF,oBAAA,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;AACxE,oBAAA,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAU,CAAC,cAAc,CAAC,CAAC,CAAC;AACtE,iBAAA;AAAC,gBAAA,OAAO,KAAU,EAAE;AACnB,oBAAA,IAAIA,aAAW,EAAE;AACf,wBAAA,IACE,KAAK;AACL,6BAAC,KAAK,CAAC,IAAI,KAAK,oBAAoB;AAClC,gCAAA,KAAK,CAAC,IAAI,KAAK,4BAA4B,CAAC,EAC9C;4BACA,OAAO,CAAC,KAAK,CACX,CAAA,IAAA,EAAO,UAAU,CAAkD,gDAAA,CAAA,EACnE,WAAW,CACZ,CAAC;AACH,yBAAA;AAAM,6BAAA;4BACL,OAAO,CAAC,KAAK,CACX,CAAA,oCAAA,EAAuC,UAAU,CAAsE,oEAAA,CAAA,EACvH,WAAW,CACZ,CAAC;AACH,yBAAA;AACF,qBAAA;AACF,iBAAA;AACF,aAAA;SACF,CAAC,CACH,CAAC;KACH;;iIAnJU,iBAAiB,EAAA,IAAA,EAAA,CAAA,EAAA,KAAA,EAOlB,kCAAkC,EAAA,EAAA,EAAA,KAAA,EAElC,WAAW,EAAA,CAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA,CAAA;qIATV,iBAAiB,EAAA,CAAA,CAAA;2FAAjB,iBAAiB,EAAA,UAAA,EAAA,CAAA;kBAD7B,UAAU;;0BAQN,MAAM;2BAAC,kCAAkC,CAAA;;0BAEzC,MAAM;2BAAC,WAAW,CAAA;;AA6IvB,MAAM,GAAG,GAAG,GAAG;;ACzJf,MAAMA,aAAW,GAAG,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,CAAC;AAE3D,MAAM,YAAY,GAAG,IAAI,cAAc,CAACA,aAAW,GAAG,cAAc,GAAG,EAAE,CAAC,CAAC;MAGrE,uBAAuB,CAAA;IAClC,OAAO,OAAO,CACZ,OAAkC,EAAA;QAElC,OAAO;AACL,YAAA,QAAQ,EAAE,uBAAuB;AACjC,YAAA,SAAS,EAAE;AACT,gBAAA;AACE,oBAAA,OAAO,EAAE,YAAY;AACrB,oBAAA,QAAQ,EAAE,iBAAiB;AAC3B,oBAAA,KAAK,EAAE,IAAI;AACZ,iBAAA;AACD,gBAAA;AACE,oBAAA,OAAO,EAAE,YAAY;AACrB,oBAAA,QAAQ,EAAE,OAAO;AAClB,iBAAA;AACD,gBAAA;AACE,oBAAA,OAAO,EAAE,4BAA4B;AACrC,oBAAA,UAAU,EAAE,qBAAqB;oBACjC,IAAI,EAAE,CAAC,YAAY,CAAC;AACrB,iBAAA;AACD,gBAAA;AACE,oBAAA,OAAO,EAAE,cAAc;AACvB,oBAAA,UAAU,EAAE,aAAa;AACzB,oBAAA,IAAI,EAAE,CAAC,4BAA4B,EAAE,WAAW,CAAC;AAClD,iBAAA;AACD,gBAAA;AACE,oBAAA,OAAO,EAAE,kCAAkC;AAC3C,oBAAA,UAAU,EAAE,gCAAgC;AAC5C,oBAAA,IAAI,EAAE,CAAC,QAAQ,EAAE,4BAA4B,CAAC;AAC/C,iBAAA;AACF,aAAA;SACF,CAAC;KACH;;uIAjCU,uBAAuB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,QAAA,EAAA,CAAA,CAAA;wIAAvB,uBAAuB,EAAA,CAAA,CAAA;wIAAvB,uBAAuB,EAAA,CAAA,CAAA;2FAAvB,uBAAuB,EAAA,UAAA,EAAA,CAAA;kBADnC,QAAQ;;AAqCH,SAAU,qBAAqB,CACnC,OAAkC,EAAA;AAElC,IAAA,OAAO,wBAAwB,CAAC;QAC9B,cAAc,CAAC,iBAAiB,CAAC;AACjC,QAAA;AACE,YAAA,OAAO,EAAE,YAAY;AACrB,YAAA,QAAQ,EAAE,OAAO;AAClB,SAAA;AACD,QAAA;AACE,YAAA,OAAO,EAAE,4BAA4B;AACrC,YAAA,UAAU,EAAE,qBAAqB;YACjC,IAAI,EAAE,CAAC,YAAY,CAAC;AACrB,SAAA;AACD,QAAA;AACE,YAAA,OAAO,EAAE,cAAc;AACvB,YAAA,UAAU,EAAE,aAAa;AACzB,YAAA,IAAI,EAAE,CAAC,4BAA4B,EAAE,WAAW,CAAC;AAClD,SAAA;AACD,QAAA;AACE,YAAA,OAAO,EAAE,kCAAkC;AAC3C,YAAA,UAAU,EAAE,gCAAgC;AAC5C,YAAA,IAAI,EAAE,CAAC,QAAQ,EAAE,4BAA4B,CAAC;AAC/C,SAAA;AACF,KAAA,CAAC,CAAC;AACL;;ACnFA,MAAM,WAAW,GAAG,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,CAAC;AAErD,MAAA,oBAAoB,GAAG,IAAI,cAAc,CACpD,WAAW,GAAG,sBAAsB,GAAG,EAAE,EACzC;AACE,IAAA,UAAU,EAAE,MAAM;IAClB,OAAO,EAAE,OAAO,iBAAiB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,YAAY,GAAG,IAAI,CAAC;AAC9E,CAAA,EACD;AAEW,MAAA,sBAAsB,GAAG,IAAI,cAAc,CACtD,WAAW,GAAG,wBAAwB,GAAG,EAAE,EAC3C;AACE,IAAA,UAAU,EAAE,MAAM;IAClB,OAAO,EAAE,OAAO,iBAAiB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,cAAc,GAAG,IAAI,CAAC;AAChF,CAAA;;ACrBH;;AAEG;;ACFH;;AAEG;;;;"}

package/internals/final-options.d.ts

@@ -0,0 +1,10 @@
+import { InjectionToken, Injector } from '@angular/core';
+import { NgxsStoragePluginOptions, StorageEngine } from './symbols';
+export interface ɵFinalNgxsStoragePluginOptions extends NgxsStoragePluginOptions {
+    keysWithEngines: {
+        key: string;
+        engine: StorageEngine;
+    }[];
+}
+export declare const ɵFINAL_NGXS_STORAGE_PLUGIN_OPTIONS: InjectionToken<unknown>;
+export declare function ɵcreateFinalStoragePluginOptions(injector: Injector, options: NgxsStoragePluginOptions): ɵFinalNgxsStoragePluginOptions;

package/internals/index.d.ts

@@ -0,0 +1,3 @@
+export * from './symbols';
+export * from './final-options';
+export * from './storage-key';

package/{src/internals → internals}/storage-key.d.ts

@@ -1,17 +1,17 @@
 import { InjectionToken, Type } from '@angular/core';
 import { StateToken } from '@ngxs/store';
-import { StateClass } from '@ngxs/store/internals';
-import { StorageEngine } from '../symbols';
+import { ɵStateClass } from '@ngxs/store/internals';
+import { StorageEngine } from './symbols';
 /** This enables the user to provide a storage engine per individual key. */
 export interface KeyWithExplicitEngine {
-    key: string | StateClass | StateToken<any>;
+    key: string | ɵStateClass | StateToken<any>;
     engine: Type<StorageEngine> | InjectionToken<StorageEngine>;
 }
 /** Determines whether the provided key has the following structure. */
-export declare function isKeyWithExplicitEngine(key: any): key is KeyWithExplicitEngine;
+export declare function ɵisKeyWithExplicitEngine(key: any): key is KeyWithExplicitEngine;
 /**
  * This tuples all of the possible types allowed in the `key` property.
  * This is not exposed publicly and used internally only.
  */
-export declare type StorageKey = string | StateClass | StateToken<any> | KeyWithExplicitEngine;
-export declare function exctractStringKey(storageKey: StorageKey): string;
+export declare type StorageKey = string | ɵStateClass | StateToken<any> | KeyWithExplicitEngine;
+export declare function ɵextractStringKey(storageKey: StorageKey): string;

package/{src → internals}/symbols.d.ts

@@ -1,5 +1,10 @@
 import { InjectionToken } from '@angular/core';
-import { StorageKey } from './internals/storage-key';
+import { StorageKey } from './storage-key';
+/**
+ * The following key is used to store the entire serialized
+ * state when no specific state is provided.
+ */
+export declare const ɵDEFAULT_STATE_KEY = "@@STATE";
 export declare const enum StorageOption {
     LocalStorage = 0,
     SessionStorage = 1
@@ -59,12 +64,9 @@ export interface NgxsStoragePluginOptions {
      */
     afterDeserialize?(obj: any, key: string): any;
 }
-export declare const NGXS_STORAGE_PLUGIN_OPTIONS: InjectionToken<unknown>;
+export declare const ɵNGXS_STORAGE_PLUGIN_OPTIONS: InjectionToken<unknown>;
 export declare const STORAGE_ENGINE: InjectionToken<StorageEngine>;
 export interface StorageEngine {
-    readonly length: number;
     getItem(key: string): any;
-    setItem(key: string, val: any): void;
-    removeItem(key: string): void;
-    clear(): void;
+    setItem(key: string, value: any): void;
 }

package/package.json

@@ -1,22 +1,42 @@
 {
-  "$schema": "../../node_modules/ng-packagr/package.schema.json",
   "name": "@ngxs/storage-plugin",
   "description": "extendable storage plugin for @ngxs/store",
-  "version": "3.8.1",
-  "sideEffects": true,
+  "version": "3.8.2-dev.master-a75608e",
+  "sideEffects": false,
   "peerDependencies": {
-    "@ngxs/store": "^3.8.1 || ^3.8.1-dev",
-    "@angular/core": ">=12.0.0 <17.0.0",
+    "@angular/core": ">=12.0.0 <18.0.0",
+    "@ngxs/store": "^3.8.2 || ^3.8.2-dev",
     "rxjs": ">=6.5.5"
   },
-  "main": "bundles/ngxs-storage-plugin.umd.js",
-  "module": "fesm2015/ngxs-storage-plugin.js",
-  "es2015": "fesm2015/ngxs-storage-plugin.js",
-  "esm2015": "esm2015/ngxs-storage-plugin.js",
-  "fesm2015": "fesm2015/ngxs-storage-plugin.js",
-  "typings": "ngxs-storage-plugin.d.ts",
+  "module": "fesm2015/ngxs-storage-plugin.mjs",
+  "es2020": "fesm2020/ngxs-storage-plugin.mjs",
+  "esm2020": "esm2020/ngxs-storage-plugin.mjs",
+  "fesm2020": "fesm2020/ngxs-storage-plugin.mjs",
+  "fesm2015": "fesm2015/ngxs-storage-plugin.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "esm2020": "./esm2020/ngxs-storage-plugin.mjs",
+      "es2020": "./fesm2020/ngxs-storage-plugin.mjs",
+      "es2015": "./fesm2015/ngxs-storage-plugin.mjs",
+      "node": "./fesm2015/ngxs-storage-plugin.mjs",
+      "default": "./fesm2020/ngxs-storage-plugin.mjs"
+    },
+    "./internals": {
+      "types": "./internals/index.d.ts",
+      "esm2020": "./esm2020/internals/ngxs-storage-plugin-internals.mjs",
+      "es2020": "./fesm2020/ngxs-storage-plugin-internals.mjs",
+      "es2015": "./fesm2015/ngxs-storage-plugin-internals.mjs",
+      "node": "./fesm2015/ngxs-storage-plugin-internals.mjs",
+      "default": "./fesm2020/ngxs-storage-plugin-internals.mjs"
+    }
+  },
   "dependencies": {
-    "tslib": "^2.2.0"
+    "tslib": "^2.3.0"
   },
   "repository": {
     "type": "git",
@@ -62,4 +82,4 @@
     "type": "opencollective",
     "url": "https://opencollective.com/ngxs"
   }
-}
+}

package/src/engines.d.ts

@@ -1,4 +1,4 @@
 import { InjectionToken } from '@angular/core';
-import { StorageEngine } from './symbols';
-export declare const LOCAL_STORAGE_ENGINE: InjectionToken<StorageEngine>;
-export declare const SESSION_STORAGE_ENGINE: InjectionToken<StorageEngine>;
+import { StorageEngine } from '@ngxs/storage-plugin/internals';
+export declare const LOCAL_STORAGE_ENGINE: InjectionToken<StorageEngine | null>;
+export declare const SESSION_STORAGE_ENGINE: InjectionToken<StorageEngine | null>;

package/src/internals.d.ts

@@ -1,9 +1,4 @@
-import { StorageEngine, NgxsStoragePluginOptions } from './symbols';
-/**
- * The following key is used to store the entire serialized
- * state when there's no specific state provided.
- */
-export declare const DEFAULT_STATE_KEY = "@@STATE";
+import { StorageEngine, NgxsStoragePluginOptions } from '@ngxs/storage-plugin/internals';
 export declare function storageOptionsFactory(options: NgxsStoragePluginOptions | undefined): NgxsStoragePluginOptions;
 export declare function engineFactory(options: NgxsStoragePluginOptions, platformId: string): StorageEngine | null;
 export declare function getStorageKey(key: string, options?: NgxsStoragePluginOptions): string;

package/src/public_api.d.ts

@@ -1,4 +1,4 @@
-export { NgxsStoragePluginModule } from './storage.module';
+export { NgxsStoragePluginModule, withNgxsStoragePlugin } from './storage.module';
 export { NgxsStoragePlugin } from './storage.plugin';
-export * from './symbols';
 export * from './engines';
+export { StorageOption, NgxsStoragePluginOptions, STORAGE_ENGINE, StorageEngine } from '@ngxs/storage-plugin/internals';

package/src/storage.module.d.ts

@@ -1,5 +1,5 @@
-import { ModuleWithProviders, InjectionToken } from '@angular/core';
-import { NgxsStoragePluginOptions } from './symbols';
+import { ModuleWithProviders, InjectionToken, EnvironmentProviders } from '@angular/core';
+import { NgxsStoragePluginOptions } from '@ngxs/storage-plugin/internals';
 import * as i0 from "@angular/core";
 export declare const USER_OPTIONS: InjectionToken<unknown>;
 export declare class NgxsStoragePluginModule {
@@ -8,3 +8,4 @@ export declare class NgxsStoragePluginModule {
     static ɵmod: i0.ɵɵNgModuleDeclaration<NgxsStoragePluginModule, never, never, never>;
     static ɵinj: i0.ɵɵInjectorDeclaration<NgxsStoragePluginModule>;
 }
+export declare function withNgxsStoragePlugin(options?: NgxsStoragePluginOptions): EnvironmentProviders;

package/src/storage.plugin.d.ts

@@ -1,12 +1,12 @@
 import { NgxsPlugin, NgxsNextPluginFn } from '@ngxs/store';
-import { FinalNgxsStoragePluginOptions } from './internals/final-options';
+import { ɵFinalNgxsStoragePluginOptions } from '@ngxs/storage-plugin/internals';
 import * as i0 from "@angular/core";
 export declare class NgxsStoragePlugin implements NgxsPlugin {
     private _options;
     private _platformId;
     private _keysWithEngines;
     private _usesDefaultStateKey;
-    constructor(_options: FinalNgxsStoragePluginOptions, _platformId: string);
+    constructor(_options: ɵFinalNgxsStoragePluginOptions, _platformId: string);
     handle(state: any, event: any, next: NgxsNextPluginFn): any;
     static ɵfac: i0.ɵɵFactoryDeclaration<NgxsStoragePlugin, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<NgxsStoragePlugin>;