@ngxs/storage-plugin 18.1.2 → 18.1.3

package/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2018 <amcdaniel2@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/index.d.ts

@@ -1,4 +1,48 @@
-/**
- * The public api for consumers of @ngxs/storage-plugin
- */
-export * from './src/public_api';
+import * as i0 from '@angular/core';
+import { ModuleWithProviders, EnvironmentProviders, InjectionToken } from '@angular/core';
+import { NgxsStoragePluginOptions, StorageKey, StorageEngine } from '@ngxs/storage-plugin/internals';
+export { NgxsStoragePluginOptions, STORAGE_ENGINE, StorageEngine, StorageOption } from '@ngxs/storage-plugin/internals';
+import { NgxsPlugin, NgxsNextPluginFn } from '@ngxs/store/plugins';
+
+declare class NgxsStoragePluginModule {
+    static forRoot(options: NgxsStoragePluginOptions): ModuleWithProviders<NgxsStoragePluginModule>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgxsStoragePluginModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<NgxsStoragePluginModule, never, never, never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<NgxsStoragePluginModule>;
+}
+declare function withNgxsStoragePlugin(options: NgxsStoragePluginOptions): EnvironmentProviders;
+
+declare function withStorageFeature(storageKeys: StorageKey[]): EnvironmentProviders;
+
+interface KeyWithEngine {
+    key: string;
+    engine: StorageEngine;
+}
+declare class ɵNgxsStoragePluginKeysManager {
+    /** Store keys separately in a set so we're able to check if the key already exists. */
+    private readonly _keys;
+    private readonly _injector;
+    private readonly _keysWithEngines;
+    constructor();
+    getKeysWithEngines(): KeyWithEngine[];
+    addKeys(storageKeys: StorageKey[]): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ɵNgxsStoragePluginKeysManager, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ɵNgxsStoragePluginKeysManager>;
+}
+
+declare class NgxsStoragePlugin implements NgxsPlugin {
+    private _keysManager;
+    private _options;
+    private _platformId;
+    private _allStatesPersisted;
+    constructor(_keysManager: ɵNgxsStoragePluginKeysManager, _options: NgxsStoragePluginOptions, _platformId: string);
+    handle(state: any, event: any, next: NgxsNextPluginFn): any;
+    private _hydrateSelectivelyOnUpdate;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgxsStoragePlugin, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<NgxsStoragePlugin>;
+}
+
+declare const LOCAL_STORAGE_ENGINE: InjectionToken<StorageEngine | null>;
+declare const SESSION_STORAGE_ENGINE: InjectionToken<StorageEngine | null>;
+
+export { LOCAL_STORAGE_ENGINE, NgxsStoragePlugin, NgxsStoragePluginModule, SESSION_STORAGE_ENGINE, withNgxsStoragePlugin, withStorageFeature };

package/internals/index.d.ts

@@ -1,2 +1,95 @@
-export * from './symbols';
-export * from './storage-key';
+import { Type, InjectionToken } from '@angular/core';
+import { StateToken } from '@ngxs/store';
+import { ɵStateClass as _StateClass } from '@ngxs/store/internals';
+
+/** This enables the user to provide a storage engine per individual key. */
+interface KeyWithExplicitEngine {
+    key: string | _StateClass | StateToken<any>;
+    engine: Type<StorageEngine> | InjectionToken<StorageEngine>;
+}
+/** Determines whether the provided key has the following structure. */
+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.
+ */
+type StorageKey = string | _StateClass | StateToken<any> | KeyWithExplicitEngine;
+declare function ɵextractStringKey(storageKey: StorageKey): string;
+
+/**
+ * The following key is used to store the entire serialized
+ * state when no specific state is provided.
+ */
+declare const ɵDEFAULT_STATE_KEY = "@@STATE";
+declare const enum StorageOption {
+    LocalStorage = 0,
+    SessionStorage = 1
+}
+interface NgxsStoragePluginOptions {
+    /**
+     * Keys for the state slice to store in the storage engine.
+     */
+    keys: '*' | 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
+     *
+     * sessionStorage or custom implementation of the StorageEngine interface
+     */
+    storage?: StorageOption;
+    /**
+     * Migration strategies.
+     */
+    migrations?: {
+        /**
+         * Version to key off.
+         */
+        version: number | string;
+        /**
+         * Method to migrate the previous state.
+         */
+        migrate: (state: any) => any;
+        /**
+         * Key to migrate.
+         */
+        key?: string;
+        /**
+         * Key for the version. Defaults to 'version'.
+         */
+        versionKey?: string;
+    }[];
+    /**
+     * Serailizer for the object before its pushed into the engine.
+     */
+    serialize?(obj: any): string;
+    /**
+     * Deserializer for the object before its pulled out of the engine.
+     */
+    deserialize?(obj: any): any;
+    /**
+     * Method to alter object before serialization.
+     */
+    beforeSerialize?(obj: any, key: string): any;
+    /**
+     * Method to alter object after deserialization.
+     */
+    afterDeserialize?(obj: any, key: string): any;
+}
+interface ɵNgxsTransformedStoragePluginOptions extends NgxsStoragePluginOptions {
+    keys: StorageKey[];
+}
+declare const ɵUSER_OPTIONS: InjectionToken<NgxsStoragePluginOptions>;
+declare const ɵALL_STATES_PERSISTED: InjectionToken<boolean>;
+declare const ɵNGXS_STORAGE_PLUGIN_OPTIONS: InjectionToken<ɵNgxsTransformedStoragePluginOptions>;
+declare const STORAGE_ENGINE: InjectionToken<StorageEngine>;
+interface StorageEngine {
+    getItem(key: string): any;
+    setItem(key: string, value: any): void;
+}
+
+export { type KeyWithExplicitEngine, type NgxsStoragePluginOptions, STORAGE_ENGINE, type StorageEngine, type StorageKey, StorageOption, ɵALL_STATES_PERSISTED, ɵDEFAULT_STATE_KEY, ɵNGXS_STORAGE_PLUGIN_OPTIONS, type ɵNgxsTransformedStoragePluginOptions, ɵUSER_OPTIONS, ɵextractStringKey, ɵisKeyWithExplicitEngine };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@ngxs/storage-plugin",
   "description": "extendable storage plugin for @ngxs/store",
-  "version": "18.1.2",
+  "version": "18.1.3",
   "sideEffects": false,
   "peerDependencies": {
-    "@ngxs/store": "^18.1.2 || ^18.1.2-dev",
+    "@ngxs/store": "^18.1.3 || ^18.1.3-dev",
     "@angular/core": ">=16.0.0 <19.0.0",
     "rxjs": ">=6.5.5",
     "ts-morph": "21.0.1"

package/internals/storage-key.d.ts

@@ -1,17 +0,0 @@
-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 type StorageKey = string | ɵStateClass | StateToken<any> | KeyWithExplicitEngine;
-export declare function ɵextractStringKey(storageKey: StorageKey): string;

package/internals/symbols.d.ts

@@ -1,77 +0,0 @@
-import { InjectionToken } from '@angular/core';
-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
-}
-export interface NgxsStoragePluginOptions {
-    /**
-     * Keys for the state slice to store in the storage engine.
-     */
-    keys: '*' | 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
-     *
-     * sessionStorage or custom implementation of the StorageEngine interface
-     */
-    storage?: StorageOption;
-    /**
-     * Migration strategies.
-     */
-    migrations?: {
-        /**
-         * Version to key off.
-         */
-        version: number | string;
-        /**
-         * Method to migrate the previous state.
-         */
-        migrate: (state: any) => any;
-        /**
-         * Key to migrate.
-         */
-        key?: string;
-        /**
-         * Key for the version. Defaults to 'version'.
-         */
-        versionKey?: string;
-    }[];
-    /**
-     * Serailizer for the object before its pushed into the engine.
-     */
-    serialize?(obj: any): string;
-    /**
-     * Deserializer for the object before its pulled out of the engine.
-     */
-    deserialize?(obj: any): any;
-    /**
-     * Method to alter object before serialization.
-     */
-    beforeSerialize?(obj: any, key: string): any;
-    /**
-     * Method to alter object after deserialization.
-     */
-    afterDeserialize?(obj: any, key: string): any;
-}
-export interface ɵNgxsTransformedStoragePluginOptions extends NgxsStoragePluginOptions {
-    keys: StorageKey[];
-}
-export declare const ɵUSER_OPTIONS: InjectionToken<NgxsStoragePluginOptions>;
-export declare const ɵALL_STATES_PERSISTED: InjectionToken<boolean>;
-export declare const ɵNGXS_STORAGE_PLUGIN_OPTIONS: InjectionToken<ɵNgxsTransformedStoragePluginOptions>;
-export declare const STORAGE_ENGINE: InjectionToken<StorageEngine>;
-export interface StorageEngine {
-    getItem(key: string): any;
-    setItem(key: string, value: any): void;
-}

package/src/engines.d.ts

@@ -1,4 +0,0 @@
-import { InjectionToken } from '@angular/core';
-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,4 +0,0 @@
-import { StorageEngine, NgxsStoragePluginOptions, ɵNgxsTransformedStoragePluginOptions } from '@ngxs/storage-plugin/internals';
-export declare function storageOptionsFactory(options: NgxsStoragePluginOptions): ɵNgxsTransformedStoragePluginOptions;
-export declare function engineFactory(options: NgxsStoragePluginOptions, platformId: string): StorageEngine | null;
-export declare function getStorageKey(key: string, options?: NgxsStoragePluginOptions): string;

package/src/keys-manager.d.ts

@@ -1,18 +0,0 @@
-import { StorageEngine, StorageKey } from '@ngxs/storage-plugin/internals';
-import * as i0 from "@angular/core";
-interface KeyWithEngine {
-    key: string;
-    engine: StorageEngine;
-}
-export declare class ɵNgxsStoragePluginKeysManager {
-    /** Store keys separately in a set so we're able to check if the key already exists. */
-    private readonly _keys;
-    private readonly _injector;
-    private readonly _keysWithEngines;
-    constructor();
-    getKeysWithEngines(): KeyWithEngine[];
-    addKeys(storageKeys: StorageKey[]): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ɵNgxsStoragePluginKeysManager, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ɵNgxsStoragePluginKeysManager>;
-}
-export {};

package/src/public_api.d.ts

@@ -1,5 +0,0 @@
-export { NgxsStoragePluginModule, withNgxsStoragePlugin } from './storage.module';
-export { withStorageFeature } from './with-storage-feature';
-export { NgxsStoragePlugin } from './storage.plugin';
-export * from './engines';
-export { StorageOption, NgxsStoragePluginOptions, STORAGE_ENGINE, StorageEngine } from '@ngxs/storage-plugin/internals';

package/src/storage.module.d.ts

@@ -1,10 +0,0 @@
-import { ModuleWithProviders, EnvironmentProviders } from '@angular/core';
-import { NgxsStoragePluginOptions } from '@ngxs/storage-plugin/internals';
-import * as i0 from "@angular/core";
-export declare class NgxsStoragePluginModule {
-    static forRoot(options: NgxsStoragePluginOptions): ModuleWithProviders<NgxsStoragePluginModule>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgxsStoragePluginModule, never>;
-    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,15 +0,0 @@
-import { NgxsPlugin, NgxsNextPluginFn } from '@ngxs/store/plugins';
-import { NgxsStoragePluginOptions } from '@ngxs/storage-plugin/internals';
-import { ɵNgxsStoragePluginKeysManager } from './keys-manager';
-import * as i0 from "@angular/core";
-export declare class NgxsStoragePlugin implements NgxsPlugin {
-    private _keysManager;
-    private _options;
-    private _platformId;
-    private _allStatesPersisted;
-    constructor(_keysManager: ɵNgxsStoragePluginKeysManager, _options: NgxsStoragePluginOptions, _platformId: string);
-    handle(state: any, event: any, next: NgxsNextPluginFn): any;
-    private _hydrateSelectivelyOnUpdate;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgxsStoragePlugin, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<NgxsStoragePlugin>;
-}

package/src/with-storage-feature.d.ts

@@ -1,3 +0,0 @@
-import { EnvironmentProviders } from '@angular/core';
-import { StorageKey } from '@ngxs/storage-plugin/internals';
-export declare function withStorageFeature(storageKeys: StorageKey[]): EnvironmentProviders;