@ngxs/storage-plugin 3.7.5-dev.master-66b90a9 → 3.7.5-dev.master-7ca104f

package/package.json

@@ -2,7 +2,7 @@
   "$schema": "../../node_modules/ng-packagr/package.schema.json",
   "name": "@ngxs/storage-plugin",
   "description": "extendable storage plugin for @ngxs/store",
-  "version": "3.7.5-dev.master-66b90a9",
+  "version": "3.7.5-dev.master-7ca104f",
   "sideEffects": true,
   "peerDependencies": {
     "@angular/core": ">=6.1.0 <16.0.0",

package/src/engines.d.ts

@@ -0,0 +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>;

package/src/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<FinalNgxsStoragePluginOptions>;
+export declare function createFinalStoragePluginOptions(injector: Injector, options: NgxsStoragePluginOptions): FinalNgxsStoragePluginOptions;

package/src/internals/storage-key.d.ts

@@ -0,0 +1,17 @@
+import { InjectionToken, Type } from '@angular/core';
+import { StateToken } from '@ngxs/store';
+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>;
+    engine: Type<StorageEngine> | InjectionToken<StorageEngine>;
+}
+/** Determines whether the provided key has the following structure. */
+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;

package/src/internals.d.ts

@@ -1,15 +1,9 @@
-import { StateClass } from '@ngxs/store/internals';
-import { StateToken } from '@ngxs/store';
 import { StorageEngine, NgxsStoragePluginOptions } from './symbols';
 /**
- * If the `key` option is not provided then the below constant
- * will be used as a default key
+ * 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";
-/**
- * Internal type definition for the `key` option provided
- * in the `forRoot` method when importing module
- */
-export declare type StorageKey = string | StateClass | StateToken<any> | (string | StateClass | StateToken<any>)[];
 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,3 +1,4 @@
 export { NgxsStoragePluginModule } from './storage.module';
 export { NgxsStoragePlugin } from './storage.plugin';
 export * from './symbols';
+export * from './engines';

package/src/storage.plugin.d.ts

@@ -1,11 +1,10 @@
 import { NgxsPlugin, NgxsNextPluginFn } from '@ngxs/store';
-import { StorageEngine, NgxsStoragePluginOptions } from './symbols';
+import { FinalNgxsStoragePluginOptions } from './internals/final-options';
 export declare class NgxsStoragePlugin implements NgxsPlugin {
     private _options;
-    private _engine;
     private _platformId;
-    private _keys;
+    private _keysWithEngines;
     private _usesDefaultStateKey;
-    constructor(_options: NgxsStoragePluginOptions, _engine: StorageEngine, _platformId: string);
+    constructor(_options: FinalNgxsStoragePluginOptions, _platformId: string);
     handle(state: any, event: any, next: NgxsNextPluginFn): any;
 }

package/src/symbols.d.ts

@@ -1,5 +1,5 @@
 import { InjectionToken } from '@angular/core';
-import { StorageKey } from './internals';
+import { StorageKey } from './internals/storage-key';
 export declare const enum StorageOption {
     LocalStorage = 0,
     SessionStorage = 1
@@ -8,7 +8,13 @@ export interface NgxsStoragePluginOptions {
     /**
      * Key for the state slice to store in the storage engine.
      */
-    key?: undefined | StorageKey;
+    key?: undefined | StorageKey | StorageKey[];
+    /**
+     * The namespace is used to prefix the key for the state slice. This is
+     * necessary when running micro frontend applications which use storage plugin.
+     * The namespace will eliminate the conflict between keys that might overlap.
+     */
+    namespace?: string;
     /**
      * Storage engine to use. Deaults to localStorage but can provide
      *
@@ -54,7 +60,7 @@ export interface NgxsStoragePluginOptions {
     afterDeserialize?(obj: any, key: string): any;
 }
 export declare const NGXS_STORAGE_PLUGIN_OPTIONS: InjectionToken<{}>;
-export declare const STORAGE_ENGINE: InjectionToken<{}>;
+export declare const STORAGE_ENGINE: InjectionToken<StorageEngine>;
 export interface StorageEngine {
     readonly length: number;
     getItem(key: string): any;