@ngxs/storage-plugin 19.0.0-dev.master-d141408 → 19.0.0-dev.master-a8d8453

package/fesm2022/ngxs-storage-plugin-internals.mjs

@@ -23,7 +23,7 @@ const STORAGE_ENGINE = new InjectionToken(typeof ngDevMode !== 'undefined' && ng
 
 /** Determines whether the provided key has the following structure. */
 function ɵisKeyWithExplicitEngine(key) {
-    return key != null && !!key.engine;
+    return !!key?.engine;
 }
 function ɵextractStringKey(storageKey) {
     // Extract the actual key out of the `{ key, engine }` structure.

package/fesm2022/ngxs-storage-plugin-internals.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"ngxs-storage-plugin-internals.mjs","sources":["../../../packages/storage-plugin/internals/src/symbols.ts","../../../packages/storage-plugin/internals/src/storage-key.ts","../../../packages/storage-plugin/internals/src/ngxs-storage-plugin-internals.ts"],"sourcesContent":["import { InjectionToken, inject } from '@angular/core';\n\nimport { StorageKey } from './storage-key';\n\n/**\n * The following key is used to store the entire serialized\n * state when no specific state is provided.\n */\nexport const ɵDEFAULT_STATE_KEY = '@@STATE';\n\ndeclare const ngDevMode: boolean;\n\nexport enum StorageOption {\n  LocalStorage,\n  SessionStorage\n}\n\nexport interface NgxsStoragePluginOptions {\n  /**\n   * Keys for the state slice to store in the storage engine.\n   */\n  keys: '*' | 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 interface ɵNgxsTransformedStoragePluginOptions extends NgxsStoragePluginOptions {\n  keys: StorageKey[];\n}\n\nexport const ɵUSER_OPTIONS = new InjectionToken<NgxsStoragePluginOptions>(\n  typeof ngDevMode !== 'undefined' && ngDevMode ? 'USER_OPTIONS' : ''\n);\n\n// Determines whether all states in the NGXS registry should be persisted or not.\nexport const ɵALL_STATES_PERSISTED = new InjectionToken<boolean>(\n  typeof ngDevMode !== 'undefined' && ngDevMode ? 'ALL_STATES_PERSISTED' : '',\n  {\n    providedIn: 'root',\n    factory: () => inject(ɵUSER_OPTIONS).keys === '*'\n  }\n);\n\nexport const ɵNGXS_STORAGE_PLUGIN_OPTIONS =\n  new InjectionToken<ɵNgxsTransformedStoragePluginOptions>(\n    typeof ngDevMode !== 'undefined' && ngDevMode ? 'NGXS_STORAGE_PLUGIN_OPTIONS' : ''\n  );\n\nexport const STORAGE_ENGINE = new InjectionToken<StorageEngine>(\n  typeof ngDevMode !== 'undefined' && ngDevMode ? 'STORAGE_ENGINE' : ''\n);\n\nexport interface StorageEngine {\n  getItem(key: string): any;\n  setItem(key: string, value: any): void;\n}\n","import { InjectionToken, Type } from '@angular/core';\nimport { StateToken } from '@ngxs/store';\nimport { ɵhasOwnProperty, ɵMETA_OPTIONS_KEY, ɵStateClass } from '@ngxs/store/internals';\n\nimport { StorageEngine } from './symbols';\n\n/** This enables the user to provide a storage engine per individual key. */\nexport interface KeyWithExplicitEngine {\n  key: string | ɵStateClass | StateToken<any>;\n  engine: Type<StorageEngine> | InjectionToken<StorageEngine>;\n}\n\n/** Determines whether the provided key has the following structure. */\nexport function ɵisKeyWithExplicitEngine(key: any): key is KeyWithExplicitEngine {\n  return key != null && !!key.engine;\n}\n\n/**\n * This tuples all of the possible types allowed in the `key` property.\n * This is not exposed publicly and used internally only.\n */\nexport type StorageKey = string | ɵStateClass | StateToken<any> | KeyWithExplicitEngine;\n\nexport function ɵextractStringKey(storageKey: StorageKey): string {\n  // Extract the actual key out of the `{ key, engine }` structure.\n  if (ɵisKeyWithExplicitEngine(storageKey)) {\n    storageKey = storageKey.key;\n  }\n\n  // Given the `storageKey` is a class, for instance, `AuthState`.\n  // We should retrieve its metadata and the `name` property.\n  // The `name` property might be a string (state name) or a state token.\n  if (ɵhasOwnProperty(storageKey, ɵMETA_OPTIONS_KEY)) {\n    storageKey = (storageKey as any)[ɵMETA_OPTIONS_KEY].name;\n  }\n\n  return storageKey instanceof StateToken ? storageKey.getName() : <string>storageKey;\n}\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":["ɵhasOwnProperty","ɵMETA_OPTIONS_KEY"],"mappings":";;;;AAIA;;;AAGG;AACI,MAAM,kBAAkB,GAAG;IAItB;AAAZ,CAAA,UAAY,aAAa,EAAA;AACvB,IAAA,aAAA,CAAA,aAAA,CAAA,cAAA,CAAA,GAAA,CAAA,CAAA,GAAA,cAAY;AACZ,IAAA,aAAA,CAAA,aAAA,CAAA,gBAAA,CAAA,GAAA,CAAA,CAAA,GAAA,gBAAc;AAChB,CAAC,EAHW,aAAa,KAAb,aAAa,GAGxB,EAAA,CAAA,CAAA;MAwEY,aAAa,GAAG,IAAI,cAAc,CAC7C,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,GAAG,cAAc,GAAG,EAAE;AAGrE;MACa,qBAAqB,GAAG,IAAI,cAAc,CACrD,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,GAAG,sBAAsB,GAAG,EAAE,EAC3E;AACE,IAAA,UAAU,EAAE,MAAM;IAClB,OAAO,EAAE,MAAM,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,KAAK;AAC/C,CAAA;MAGU,4BAA4B,GACvC,IAAI,cAAc,CAChB,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,GAAG,6BAA6B,GAAG,EAAE;MAGzE,cAAc,GAAG,IAAI,cAAc,CAC9C,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,GAAG,gBAAgB,GAAG,EAAE;;AC9FvE;AACM,SAAU,wBAAwB,CAAC,GAAQ,EAAA;IAC/C,OAAO,GAAG,IAAI,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM;AACpC;AAQM,SAAU,iBAAiB,CAAC,UAAsB,EAAA;;AAEtD,IAAA,IAAI,wBAAwB,CAAC,UAAU,CAAC,EAAE;AACxC,QAAA,UAAU,GAAG,UAAU,CAAC,GAAG;;;;;AAM7B,IAAA,IAAIA,eAAe,CAAC,UAAU,EAAEC,iBAAiB,CAAC,EAAE;AAClD,QAAA,UAAU,GAAI,UAAkB,CAACA,iBAAiB,CAAC,CAAC,IAAI;;AAG1D,IAAA,OAAO,UAAU,YAAY,UAAU,GAAG,UAAU,CAAC,OAAO,EAAE,GAAW,UAAU;AACrF;;ACrCA;;AAEG;;;;"}
+{"version":3,"file":"ngxs-storage-plugin-internals.mjs","sources":["../../../packages/storage-plugin/internals/src/symbols.ts","../../../packages/storage-plugin/internals/src/storage-key.ts","../../../packages/storage-plugin/internals/src/ngxs-storage-plugin-internals.ts"],"sourcesContent":["import { InjectionToken, inject } from '@angular/core';\n\nimport { StorageKey } from './storage-key';\n\n/**\n * The following key is used to store the entire serialized\n * state when no specific state is provided.\n */\nexport const ɵDEFAULT_STATE_KEY = '@@STATE';\n\ndeclare const ngDevMode: boolean;\n\nexport enum StorageOption {\n  LocalStorage,\n  SessionStorage\n}\n\nexport interface NgxsStoragePluginOptions {\n  /**\n   * Keys for the state slice to store in the storage engine.\n   */\n  keys: '*' | 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 interface ɵNgxsTransformedStoragePluginOptions extends NgxsStoragePluginOptions {\n  keys: StorageKey[];\n}\n\nexport const ɵUSER_OPTIONS = new InjectionToken<NgxsStoragePluginOptions>(\n  typeof ngDevMode !== 'undefined' && ngDevMode ? 'USER_OPTIONS' : ''\n);\n\n// Determines whether all states in the NGXS registry should be persisted or not.\nexport const ɵALL_STATES_PERSISTED = new InjectionToken<boolean>(\n  typeof ngDevMode !== 'undefined' && ngDevMode ? 'ALL_STATES_PERSISTED' : '',\n  {\n    providedIn: 'root',\n    factory: () => inject(ɵUSER_OPTIONS).keys === '*'\n  }\n);\n\nexport const ɵNGXS_STORAGE_PLUGIN_OPTIONS =\n  new InjectionToken<ɵNgxsTransformedStoragePluginOptions>(\n    typeof ngDevMode !== 'undefined' && ngDevMode ? 'NGXS_STORAGE_PLUGIN_OPTIONS' : ''\n  );\n\nexport const STORAGE_ENGINE = new InjectionToken<StorageEngine>(\n  typeof ngDevMode !== 'undefined' && ngDevMode ? 'STORAGE_ENGINE' : ''\n);\n\nexport interface StorageEngine {\n  getItem(key: string): any;\n  setItem(key: string, value: any): void;\n}\n","import { InjectionToken, Type } from '@angular/core';\nimport { StateToken } from '@ngxs/store';\nimport { ɵhasOwnProperty, ɵMETA_OPTIONS_KEY, ɵStateClass } from '@ngxs/store/internals';\n\nimport { StorageEngine } from './symbols';\n\n/** This enables the user to provide a storage engine per individual key. */\nexport interface KeyWithExplicitEngine {\n  key: string | ɵStateClass | StateToken<any>;\n  engine: Type<StorageEngine> | InjectionToken<StorageEngine>;\n}\n\n/** Determines whether the provided key has the following structure. */\nexport function ɵisKeyWithExplicitEngine(key: any): key is KeyWithExplicitEngine {\n  return !!key?.engine;\n}\n\n/**\n * This tuples all of the possible types allowed in the `key` property.\n * This is not exposed publicly and used internally only.\n */\nexport type StorageKey = string | ɵStateClass | StateToken<any> | KeyWithExplicitEngine;\n\nexport function ɵextractStringKey(storageKey: StorageKey): string {\n  // Extract the actual key out of the `{ key, engine }` structure.\n  if (ɵisKeyWithExplicitEngine(storageKey)) {\n    storageKey = storageKey.key;\n  }\n\n  // Given the `storageKey` is a class, for instance, `AuthState`.\n  // We should retrieve its metadata and the `name` property.\n  // The `name` property might be a string (state name) or a state token.\n  if (ɵhasOwnProperty(storageKey, ɵMETA_OPTIONS_KEY)) {\n    storageKey = (storageKey as any)[ɵMETA_OPTIONS_KEY].name;\n  }\n\n  return storageKey instanceof StateToken ? storageKey.getName() : <string>storageKey;\n}\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":["ɵhasOwnProperty","ɵMETA_OPTIONS_KEY"],"mappings":";;;;AAIA;;;AAGG;AACI,MAAM,kBAAkB,GAAG;IAItB;AAAZ,CAAA,UAAY,aAAa,EAAA;AACvB,IAAA,aAAA,CAAA,aAAA,CAAA,cAAA,CAAA,GAAA,CAAA,CAAA,GAAA,cAAY;AACZ,IAAA,aAAA,CAAA,aAAA,CAAA,gBAAA,CAAA,GAAA,CAAA,CAAA,GAAA,gBAAc;AAChB,CAAC,EAHW,aAAa,KAAb,aAAa,GAGxB,EAAA,CAAA,CAAA;MAwEY,aAAa,GAAG,IAAI,cAAc,CAC7C,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,GAAG,cAAc,GAAG,EAAE;AAGrE;MACa,qBAAqB,GAAG,IAAI,cAAc,CACrD,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,GAAG,sBAAsB,GAAG,EAAE,EAC3E;AACE,IAAA,UAAU,EAAE,MAAM;IAClB,OAAO,EAAE,MAAM,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,KAAK;AAC/C,CAAA;MAGU,4BAA4B,GACvC,IAAI,cAAc,CAChB,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,GAAG,6BAA6B,GAAG,EAAE;MAGzE,cAAc,GAAG,IAAI,cAAc,CAC9C,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,GAAG,gBAAgB,GAAG,EAAE;;AC9FvE;AACM,SAAU,wBAAwB,CAAC,GAAQ,EAAA;AAC/C,IAAA,OAAO,CAAC,CAAC,GAAG,EAAE,MAAM;AACtB;AAQM,SAAU,iBAAiB,CAAC,UAAsB,EAAA;;AAEtD,IAAA,IAAI,wBAAwB,CAAC,UAAU,CAAC,EAAE;AACxC,QAAA,UAAU,GAAG,UAAU,CAAC,GAAG;;;;;AAM7B,IAAA,IAAIA,eAAe,CAAC,UAAU,EAAEC,iBAAiB,CAAC,EAAE;AAClD,QAAA,UAAU,GAAI,UAAkB,CAACA,iBAAiB,CAAC,CAAC,IAAI;;AAG1D,IAAA,OAAO,UAAU,YAAY,UAAU,GAAG,UAAU,CAAC,OAAO,EAAE,GAAW,UAAU;AACrF;;ACrCA;;AAEG;;;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ngxs/storage-plugin",
   "description": "extendable storage plugin for @ngxs/store",
-  "version": "19.0.0-dev.master-d141408",
+  "version": "19.0.0-dev.master-a8d8453",
   "sideEffects": false,
   "peerDependencies": {
     "@angular/core": ">=19.0.0 <20.0.0",

package/schematics/collection.json

@@ -0,0 +1,12 @@
+{
+  "extends": ["@schematics/angular"],
+  "$schema": "../node_modules/@angular-devkit/schematics/collection-schema.json",
+  "schematics": {
+    "keys-migration": {
+      "factory": "./src/ng-generate/index#migrateKeys",
+      "description": "Migrates from key to keys",
+      "aliases": ["ngxs-keys-migration"],
+      "schema": "./src/ng-generate/schema.json"
+    }
+  }
+}

package/schematics/src/ng-generate/__snapshots__/keys-migration.spec.ts.snap

@@ -0,0 +1,125 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Storage Plugin Migration migrate empty forRoot 1`] = `
+"
+    import { NgxsStoragePluginModule } from '@ngxs/storage-plugin';
+    import { NgModule } from '@angular/core';
+    import { BrowserModule } from '@angular/platform-browser';
+
+    import { AppRoutingModule } from './app-routing.module';
+    import { AppComponent } from './app.component';
+
+      @NgModule({
+        declarations: [
+          AppComponent
+        ],
+        imports: [
+          BrowserModule,
+          AppRoutingModule,
+          NgxsStoragePluginModule.forRoot({ keys: '*' })
+        ],
+        bootstrap: [AppComponent]
+      })
+      export class AppModule { }
+    "
+`;
+
+exports[`Storage Plugin Migration migrate forRoot that has the "key" property with a value as a string literal 1`] = `
+"
+    import { NgxsStoragePluginModule } from '@ngxs/storage-plugin';
+    import { NgModule } from '@angular/core';
+    import { BrowserModule } from '@angular/platform-browser';
+
+    import { AppRoutingModule } from './app-routing.module';
+    import { AppComponent } from './app.component';
+
+      @NgModule({
+        declarations: [
+          AppComponent
+        ],
+        imports: [
+          BrowserModule,
+          AppRoutingModule,
+          NgxsStoragePluginModule.forRoot({proa: 'valuea', prob: 'valueb', keys: ['keep this value']})
+        ],
+        bootstrap: [AppComponent]
+      })
+      export class AppModule { }
+    "
+`;
+
+exports[`Storage Plugin Migration migrate forRoot that has the "key" property with values as an array literal 1`] = `
+"
+    import { NgxsStoragePluginModule } from '@ngxs/storage-plugin';
+    import { NgModule } from '@angular/core';
+    import { BrowserModule } from '@angular/platform-browser';
+
+    import { AppRoutingModule } from './app-routing.module';
+    import { AppComponent } from './app.component';
+
+      @NgModule({
+        declarations: [
+          AppComponent
+        ],
+        imports: [
+          BrowserModule,
+          AppRoutingModule,
+          NgxsStoragePluginModule.forRoot({proa: 'valuea', prob: 'valueb', keys: ['keyValue', NovelsState, { key: 'novels', engine: MyEngineX } ]})
+        ],
+        bootstrap: [AppComponent]
+      })
+      export class AppModule { }
+    "
+`;
+
+exports[`Storage Plugin Migration migrate forRoot that is missing the "key" property 1`] = `
+"
+    import { NgxsStoragePluginModule } from '@ngxs/storage-plugin';
+    import { NgModule } from '@angular/core';
+    import { BrowserModule } from '@angular/platform-browser';
+
+    import { AppRoutingModule } from './app-routing.module';
+    import { AppComponent } from './app.component';
+
+      @NgModule({
+        declarations: [
+          AppComponent
+        ],
+        imports: [
+          BrowserModule,
+          AppRoutingModule,
+          NgxsStoragePluginModule.forRoot({proa: 'valuea', prob: 'valueb',
+              keys: '*'
+        })
+        ],
+        bootstrap: [AppComponent]
+      })
+      export class AppModule { }
+    "
+`;
+
+exports[`Storage Plugin Migration migrate from a constant array 1`] = `
+"
+    import { NgxsStoragePluginModule } from '@ngxs/storage-plugin';
+    import { NgModule } from '@angular/core';
+    import { BrowserModule } from '@angular/platform-browser';
+
+    import { AppRoutingModule } from './app-routing.module';
+    import { AppComponent } from './app.component';
+
+    const imports = [
+      BrowserModule,
+      AppRoutingModule,
+      NgxsStoragePluginModule.forRoot({proa: 'valuea', prob: 'valueb', keys: ['keep this value']})
+    ];
+
+      @NgModule({
+        declarations: [
+          AppComponent
+        ],
+        imports,
+        bootstrap: [AppComponent]
+      })
+      export class AppModule { }
+    "
+`;

package/schematics/src/ng-generate/index.js

@@ -0,0 +1,98 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.migrateKeys = migrateKeys;
+const node_process_1 = require("node:process");
+const ts = require("ts-morph");
+const visit_files_1 = require("../utils/visit-files");
+function migrateEmptyForRoot(callExpression) {
+    callExpression.addArgument(`{ keys: '*' }`);
+}
+function migrateForRootWithArgs(arg) {
+    const objectLiteral = arg;
+    const hasPropertyName = (name) => objectLiteral.getProperties().some(prop => {
+        return ts.Node.isPropertyAssignment(prop) && prop.getName() === name;
+    });
+    const isAlreadyMigrated = hasPropertyName('keys');
+    // If the "keys" property is already there, we should not try migrating
+    if (isAlreadyMigrated) {
+        return;
+    }
+    const hasKeyProperty = hasPropertyName('key');
+    // Add the "keys" property if it's not there
+    if (!hasKeyProperty) {
+        objectLiteral.addPropertyAssignment({ name: 'keys', initializer: `'*'` });
+    }
+    else {
+        // Rename the "key" property to "keys"
+        const keyProperty = objectLiteral.getProperty('key');
+        const propertyName = keyProperty === null || keyProperty === void 0 ? void 0 : keyProperty.getChildAtIndex(0);
+        const propertyValue = keyProperty === null || keyProperty === void 0 ? void 0 : keyProperty.getChildAtIndex(2);
+        propertyName === null || propertyName === void 0 ? void 0 : propertyName.replaceWithText('keys');
+        // if the property value is a string literal, then we should wrap it in an array
+        // We are checking the isStringLiteral to avoid wrapping a value that is already an array
+        if (ts.Node.isStringLiteral(propertyValue)) {
+            propertyValue === null || propertyValue === void 0 ? void 0 : propertyValue.replaceWithText(`[${propertyValue === null || propertyValue === void 0 ? void 0 : propertyValue.getText()}]`);
+        }
+    }
+}
+function isStoragePluginProvided(callExpression) {
+    return (callExpression && callExpression.getText().includes('NgxsStoragePluginModule.forRoot'));
+}
+/**
+ * We do not use the ts.Node.isCallExpression(node) because the underlying implementation
+ * uses -> node.getKind() === typescript.SyntaxKind.CallExpression
+ * which is an enum that can return different numbers depending on minor typescript package versions
+ */
+function isCallExpression(node) {
+    return node.getKindName() === 'CallExpression';
+}
+function migrateKeys() {
+    return (tree, _context) => {
+        const tsProject = new ts.Project({ useInMemoryFileSystem: true });
+        const packageJson = tree.readJson('package.json');
+        const storePackage = packageJson['dependencies']['@ngxs/store'];
+        if (!storePackage) {
+            _context.logger.error(`No @ngxs/store found`);
+            return (0, node_process_1.exit)(1);
+        }
+        (0, visit_files_1.visitTsFiles)(tree, tree.root, (path) => __awaiter(this, void 0, void 0, function* () {
+            const fileContent = tree.readText(path);
+            const sourceFile = tsProject.createSourceFile(path, fileContent);
+            const hasStoragePluginImported = sourceFile.getImportDeclaration(importDecl => importDecl.getModuleSpecifierValue() === '@ngxs/storage-plugin');
+            // do not try migrating if the storage plugin is not imported
+            if (hasStoragePluginImported) {
+                sourceFile.forEachDescendant(node => {
+                    if (isCallExpression(node) &&
+                        ts.Node.isPropertyAccessExpression(node.getExpression())) {
+                        const callExpression = node;
+                        // If the storage plugin is not provided, we should not try migrating
+                        if (!isStoragePluginProvided(callExpression)) {
+                            return;
+                        }
+                        const args = callExpression.getArguments();
+                        // If there are no arguments in the forRoot(), then add the `keys` property
+                        if (!args.length) {
+                            _context.logger.info(`Migrating empty forRoot in ${path}`);
+                            migrateEmptyForRoot(callExpression);
+                        }
+                        else if (ts.Node.isObjectLiteralExpression(args[0])) {
+                            _context.logger.info(`Migrating forRoot with args in ${path}`);
+                            migrateForRootWithArgs(args[0]);
+                        }
+                    }
+                });
+                tree.overwrite(path, sourceFile.getFullText());
+            }
+        }));
+    };
+}
+//# sourceMappingURL=index.js.map

package/schematics/src/ng-generate/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/storage-plugin/schematics/src/ng-generate/index.ts"],"names":[],"mappings":";;;;;;;;;;;AA4DA,kCAgDC;AA5GD,+CAAoC;AACpC,+BAA+B;AAG/B,sDAAoD;AAEpD,SAAS,mBAAmB,CAAC,cAAuD;IAClF,cAAc,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;AAC9C,CAAC;AAED,SAAS,sBAAsB,CAAC,GAAwB;IACtD,MAAM,aAAa,GAAG,GAAiC,CAAC;IAExD,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,EAAE,CACvC,aAAa,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACxC,OAAO,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC;IACvE,CAAC,CAAC,CAAC;IAEL,MAAM,iBAAiB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IAElD,uEAAuE;IACvE,IAAI,iBAAiB,EAAE,CAAC;QACtB,OAAO;IACT,CAAC;IAED,MAAM,cAAc,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IAE9C,4CAA4C;IAC5C,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,aAAa,CAAC,qBAAqB,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;IAC5E,CAAC;SAAM,CAAC;QACN,sCAAsC;QACtC,MAAM,WAAW,GAAG,aAAa,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACrD,MAAM,YAAY,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,eAAe,CAAC,CAAC,CAAC,CAAC;QACrD,MAAM,aAAa,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,eAAe,CAAC,CAAC,CAAC,CAAC;QACtD,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,eAAe,CAAC,MAAM,CAAC,CAAC;QAEtC,gFAAgF;QAChF,yFAAyF;QACzF,IAAI,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,aAAc,CAAC,EAAE,CAAC;YAC5C,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,eAAe,CAAC,IAAI,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,OAAO,EAAE,GAAG,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,uBAAuB,CAAC,cAAiC;IAChE,OAAO,CACL,cAAc,IAAI,cAAc,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,iCAAiC,CAAC,CACvF,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,IAAa;IACrC,OAAO,IAAI,CAAC,WAAW,EAAE,KAAK,gBAAgB,CAAC;AACjD,CAAC;AAED,SAAgB,WAAW;IACzB,OAAO,CAAC,IAAU,EAAE,QAA0B,EAAE,EAAE;QAChD,MAAM,SAAS,GAAG,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC;QAClE,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAQ,CAAC;QACzD,MAAM,YAAY,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC,aAAa,CAAC,CAAC;QAEhE,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;YAC9C,OAAO,IAAA,mBAAI,EAAC,CAAC,CAAC,CAAC;QACjB,CAAC;QAED,IAAA,0BAAY,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAM,IAAI,EAAC,EAAE;YACzC,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACxC,MAAM,UAAU,GAAG,SAAS,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAY,CAAC,CAAC;YAClE,MAAM,wBAAwB,GAAG,UAAU,CAAC,oBAAoB,CAC9D,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,uBAAuB,EAAE,KAAK,sBAAsB,CAC9E,CAAC;YAEF,6DAA6D;YAC7D,IAAI,wBAAwB,EAAE,CAAC;gBAC7B,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE;oBAClC,IACE,gBAAgB,CAAC,IAAI,CAAC;wBACtB,EAAE,CAAC,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,EACxD,CAAC;wBACD,MAAM,cAAc,GAAG,IAAyB,CAAC;wBAEjD,qEAAqE;wBACrE,IAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC,EAAE,CAAC;4BAC7C,OAAO;wBACT,CAAC;wBAED,MAAM,IAAI,GAAG,cAAc,CAAC,YAAY,EAAE,CAAC;wBAC3C,2EAA2E;wBAC3E,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;4BACjB,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,8BAA8B,IAAI,EAAE,CAAC,CAAC;4BAC3D,mBAAmB,CAAC,cAAc,CAAC,CAAC;wBACtC,CAAC;6BAAM,IAAI,EAAE,CAAC,IAAI,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;4BACtD,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,kCAAkC,IAAI,EAAE,CAAC,CAAC;4BAC/D,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;wBAClC,CAAC;oBACH,CAAC;gBACH,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;YACjD,CAAC;QACH,CAAC,CAAA,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC"}

package/schematics/src/ng-generate/schema.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "SchematicsNgxsStoragePlugin",
+  "title": "Ngxs Storage Plugin Options Schema",
+  "type": "object",
+  "properties": {}
+}

package/schematics/src/utils/versions.json

@@ -0,0 +1,3 @@
+{
+  "@ngxs/store": "19.0.0"
+}

package/schematics/src/utils/visit-files.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.visitTsFiles = visitTsFiles;
+function visitTsFiles(tree, dirPath = tree.root, visitor) {
+    function visit(directory) {
+        for (const path of directory.subfiles) {
+            if (path.endsWith('.ts') && !path.endsWith('.d.ts')) {
+                const entry = directory.file(path);
+                if (entry) {
+                    visitor(entry.path);
+                }
+            }
+        }
+        for (const path of directory.subdirs) {
+            if (path === 'node_modules') {
+                continue;
+            }
+            visit(directory.dir(path));
+        }
+    }
+    visit(dirPath);
+}
+//# sourceMappingURL=visit-files.js.map

package/schematics/src/utils/visit-files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"visit-files.js","sourceRoot":"","sources":["../../../../../packages/storage-plugin/schematics/src/utils/visit-files.ts"],"names":[],"mappings":";;AAEA,oCAyBC;AAzBD,SAAgB,YAAY,CAC1B,IAAU,EACV,OAAO,GAAG,IAAI,CAAC,IAAI,EACnB,OAA+B;IAE/B,SAAS,KAAK,CAAC,SAAmB;QAChC,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;YACtC,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBACpD,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACnC,IAAI,KAAK,EAAE,CAAC;oBACV,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACtB,CAAC;YACH,CAAC;QACH,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;YACrC,IAAI,IAAI,KAAK,cAAc,EAAE,CAAC;gBAC5B,SAAS;YACX,CAAC;YAED,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,CAAC;AACjB,CAAC"}