@ama-sdk/schematics 10.3.0 → 10.3.3

package/README.md

@@ -242,6 +242,18 @@ yarn schematics @ama-sdk/schematics:typescript-core --generator-key example-sdk
 > The values provided by the parameter `--global-property` will actually be merged with the values of `globalProperty` from
 > `openapitools.json` (rather than override them like the other properties).
 
+### Migration
+
+To help to apply changes on the Shell part of the SDK repository, a `migrate` schematic is exposed:
+
+```shell
+yarn schematics @ama-sdk/schematics:migrate --from 10.0.0 [--to 11.0.0]
+```
+
+> [!NOTE]
+> - The `--from` parameter is mandatory to provide the version of the original `@ama-sdk/schematics` package from which the rules should be run.
+> - The *optional* `--to` parameter allows to indicate a version until which the rules should be run. The current installed version will be used if not provided.
+
 ### Debug
 
 The OpenApi generator extracts an enhanced JSON data model from the specification YAML and uses this data model to feed the templates to generate the code.

package/collection.json

@@ -7,6 +7,11 @@
       "schema": "./schematics/ng-add/schema.json",
       "aliases": ["install", "i"]
     },
+    "migrate": {
+      "description": "Execute migration scripts between 2 versions.",
+      "factory": "./schematics/migrate/index#migrate",
+      "schema": "./schematics/migrate/schema.json"
+    },
     "typescript-mock": {
       "description": "Generate an api mock into the project.",
       "factory": "./schematics/typescript/mock/index#ngGenerateMock",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ama-sdk/schematics",
-  "version": "10.3.0",
+  "version": "10.3.3",
   "publishConfig": {
     "access": "public"
   },
@@ -48,12 +48,12 @@
     }
   },
   "peerDependencies": {
-    "@ama-sdk/core": "^10.3.0",
+    "@ama-sdk/core": "^10.3.3",
     "@angular-devkit/core": "~17.3.0",
     "@angular-devkit/schematics": "~17.3.0",
     "@angular-devkit/schematics-cli": "^17.0.1",
     "@angular/cli": "^17.0.1",
-    "@o3r/schematics": "^10.3.0",
+    "@o3r/schematics": "^10.3.3",
     "@openapitools/openapi-generator-cli": "~2.13.0",
     "@schematics/angular": "~17.3.0"
   },
@@ -67,16 +67,16 @@
     "tslib": "^2.6.2"
   },
   "devDependencies": {
-    "@ama-sdk/core": "^10.3.0",
+    "@ama-sdk/core": "^10.3.3",
     "@angular-devkit/schematics-cli": "~17.3.0",
     "@angular-eslint/eslint-plugin": "~17.3.0",
     "@angular/cli": "~17.3.0",
     "@nx/eslint-plugin": "~18.3.0",
     "@nx/jest": "~18.3.0",
-    "@o3r/build-helpers": "^10.3.0",
-    "@o3r/eslint-plugin": "^10.3.0",
-    "@o3r/schematics": "^10.3.0",
-    "@o3r/test-helpers": "^10.3.0",
+    "@o3r/build-helpers": "^10.3.3",
+    "@o3r/eslint-plugin": "^10.3.3",
+    "@o3r/schematics": "^10.3.3",
+    "@o3r/test-helpers": "^10.3.3",
     "@openapitools/openapi-generator-cli": "~2.13.0",
     "@schematics/angular": "~17.3.0",
     "@stylistic/eslint-plugin-ts": "^1.5.4",

package/schematics/helpers/is-typescript-project.d.ts

@@ -0,0 +1,8 @@
+import type { Tree } from '@angular-devkit/schematics';
+/**
+ * Determine if the targeted SDK is typescript based
+ * @param tree Schematic Tree
+ * @param pathInTree Path to the SDK in the tree
+ */
+export declare const isTypescriptSdk: (tree: Tree, pathInTree?: string) => boolean;
+//# sourceMappingURL=is-typescript-project.d.ts.map

package/schematics/helpers/is-typescript-project.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-typescript-project.d.ts","sourceRoot":"","sources":["../../../schematics/helpers/is-typescript-project.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAEvD;;;;GAIG;AACH,eAAO,MAAM,eAAe,SAAU,IAAI,iCAIzC,CAAC"}

package/schematics/helpers/is-typescript-project.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTypescriptSdk = void 0;
+/**
+ * Determine if the targeted SDK is typescript based
+ * @param tree Schematic Tree
+ * @param pathInTree Path to the SDK in the tree
+ */
+const isTypescriptSdk = (tree, pathInTree = '/') => {
+    return tree.getDir(pathInTree)
+        .subfiles
+        .some((filePath) => /tsconfig[^/\\]*\.json$/.test(filePath));
+};
+exports.isTypescriptSdk = isTypescriptSdk;
+//# sourceMappingURL=is-typescript-project.js.map

package/schematics/helpers/is-typescript-project.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-typescript-project.js","sourceRoot":"","sources":["../../../schematics/helpers/is-typescript-project.ts"],"names":[],"mappings":";;;AAEA;;;;GAIG;AACI,MAAM,eAAe,GAAG,CAAC,IAAU,EAAE,UAAU,GAAG,GAAG,EAAE,EAAE;IAC9D,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;SAC3B,QAAQ;SACR,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,wBAAwB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;AACjE,CAAC,CAAC;AAJW,QAAA,eAAe,mBAI1B"}

package/schematics/migrate/index.d.ts

@@ -0,0 +1,8 @@
+import type { Rule } from '@angular-devkit/schematics';
+import { MigrateSchematicsSchemaOptions } from './schema';
+/**
+ * Facilitate the migration of a version to another by the run of migration rules
+ * @param options
+ */
+export declare const migrate: (options: MigrateSchematicsSchemaOptions) => () => Promise<Rule>;
+//# sourceMappingURL=index.d.ts.map

package/schematics/migrate/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../schematics/migrate/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAAE,8BAA8B,EAAE,MAAM,UAAU,CAAC;AA8B1D;;;GAGG;AACH,eAAO,MAAM,OAAO,YAAa,8BAA8B,wBAG9D,CAAC"}

package/schematics/migrate/index.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.migrate = void 0;
+const schematics_1 = require("@o3r/schematics");
+const node_path_1 = require("node:path");
+const semver_1 = require("semver");
+const is_typescript_project_1 = require("../helpers/is-typescript-project");
+const tsMigrationMap = {};
+/**
+ * Facilitate the migration of a version to another by the run of migration rules
+ * @param options
+ */
+function migrateFn(options) {
+    const currentVersion = JSON.parse(require((0, node_path_1.resolve)(__dirname, '..', '..', 'package.json'))).version;
+    const to = options.to || currentVersion;
+    const minimumVersion = (0, semver_1.minVersion)(to);
+    return (tree, context) => {
+        if (minimumVersion && (0, semver_1.gt)(minimumVersion, currentVersion)) {
+            context.logger.warn(`The specified range "${to}" has a minimum supported version higher than the current version of @ama-sdk/schematics (${currentVersion}).` +
+                ' The migration may not have any effect.');
+        }
+        const workingDirectory = options?.projectName && (0, schematics_1.getWorkspaceConfig)(tree)?.projects[options.projectName]?.root || '/';
+        const runMigrateSchematic = (0, is_typescript_project_1.isTypescriptSdk)(tree, workingDirectory) ? (0, schematics_1.getMigrationRuleRunner)(tsMigrationMap, { logger: context.logger }) : undefined;
+        return runMigrateSchematic?.({ from: options.from, to });
+    };
+}
+/**
+ * Facilitate the migration of a version to another by the run of migration rules
+ * @param options
+ */
+const migrate = (options) => async () => {
+    const { createSchematicWithMetricsIfInstalled } = await Promise.resolve().then(() => require('@o3r/schematics'));
+    return createSchematicWithMetricsIfInstalled(migrateFn)(options);
+};
+exports.migrate = migrate;
+//# sourceMappingURL=index.js.map

package/schematics/migrate/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../schematics/migrate/index.ts"],"names":[],"mappings":";;;AAEA,gDAAqG;AACrG,yCAAoC;AACpC,mCAAwC;AACxC,4EAAmE;AAEnE,MAAM,cAAc,GAAsB,EAEzC,CAAC;AACF;;;GAGG;AACH,SAAS,SAAS,CAAC,OAAuC;IAExD,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAA,mBAAO,EAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IACnG,MAAM,EAAE,GAAW,OAAO,CAAC,EAAE,IAAI,cAAc,CAAC;IAChD,MAAM,cAAc,GAAG,IAAA,mBAAU,EAAC,EAAE,CAAC,CAAC;IAEtC,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;QACvB,IAAI,cAAc,IAAI,IAAA,WAAE,EAAC,cAAc,EAAE,cAAc,CAAC,EAAE,CAAC;YACzD,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,wBAAwB,EAAE,6FAA6F,cAAc,IAAI;gBAC7J,yCAAyC,CAAC,CAAC;QAC7C,CAAC;QACD,MAAM,gBAAgB,GAAG,OAAO,EAAE,WAAW,IAAI,IAAA,+BAAkB,EAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,IAAI,IAAI,GAAG,CAAC;QACtH,MAAM,mBAAmB,GAAG,IAAA,uCAAe,EAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,IAAA,mCAAsB,EAAC,cAAc,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACrJ,OAAO,mBAAmB,EAAE,CAAC,EAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,EAAE,EAAC,CAAC,CAAC;IACzD,CAAC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACI,MAAM,OAAO,GAAG,CAAC,OAAuC,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE;IAC7E,MAAM,EAAE,qCAAqC,EAAE,GAAG,2CAAa,iBAAiB,EAAC,CAAC;IAClF,OAAO,qCAAqC,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC;AACnE,CAAC,CAAC;AAHW,QAAA,OAAO,WAGlB"}

package/schematics/migrate/schema.d.ts

@@ -0,0 +1,10 @@
+/** Schematic Option */
+export interface MigrateSchematicsSchemaOptions {
+    /** Starting version from which the migration scripts are executed */
+    from: string;
+    /** Version of the package to migrate to (will use the current version if not specified) */
+    to?: string;
+    /** Project name */
+    projectName?: string | undefined;
+}
+//# sourceMappingURL=schema.d.ts.map

package/schematics/migrate/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../schematics/migrate/schema.ts"],"names":[],"mappings":"AAAA,uBAAuB;AACvB,MAAM,WAAW,8BAA8B;IAC7C,qEAAqE;IACrE,IAAI,EAAE,MAAM,CAAC;IACb,2FAA2F;IAC3F,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC"}

package/schematics/migrate/schema.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=schema.js.map

package/schematics/migrate/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../schematics/migrate/schema.ts"],"names":[],"mappings":""}

package/schematics/migrate/schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "MigrateSchematicsSchema",
+  "title": "Execute migration scripts between 2 versions",
+  "description": "Schematics to migrate from a specific version to another one",
+  "properties": {
+    "from": {
+      "type": "string",
+      "description": "Starting version from which the migration scripts are executed",
+      "x-prompt": "What was the original version before migration?"
+    },
+    "to": {
+      "type": "string",
+      "description": "Version of the package to migrate to (will use the current version if not specified)"
+    },
+    "projectName": {
+      "type": "string",
+      "description": "Project name (in case it is applied to a module from an Angular Project)",
+      "$default": {
+        "$source": "projectName"
+      }
+    }
+  },
+  "additionalProperties": true,
+  "required": [
+    "from"
+  ]
+}

package/schematics/ng-update/index.d.ts

@@ -1,4 +1,4 @@
-import { Rule } from '@angular-devkit/schematics';
+import type { Rule } from '@angular-devkit/schematics';
 /**
  * update of Otter library V10.0
  */

package/schematics/ng-update/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../schematics/ng-update/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAQ,MAAM,4BAA4B,CAAC;AAWxD;;GAEG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAQlC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../schematics/ng-update/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAIvD;;GAEG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAQlC"}

package/schematics/ng-update/index.js

@@ -4,19 +4,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.updateV10_0 = void 0;
 const typescript_1 = require("./typescript");
-/**
- * Determine if the script is run in a Typescript SDK
- * @param tree
- */
-const isTypescriptSdk = (tree) => {
-    return tree.exists('/tsconfig.json');
-};
+const is_typescript_project_1 = require("../helpers/is-typescript-project");
 /**
  * update of Otter library V10.0
  */
 function updateV10_0() {
     return (tree, context) => {
-        if (isTypescriptSdk(tree)) {
+        if ((0, is_typescript_project_1.isTypescriptSdk)(tree)) {
             return (0, typescript_1.updateV10_0)()(tree, context);
         }
         return tree;

package/schematics/ng-update/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../schematics/ng-update/index.ts"],"names":[],"mappings":";AAAA,yDAAyD;AACzD,8BAA8B;;;AAG9B,6CAA4D;AAE5D;;;GAGG;AACH,MAAM,eAAe,GAAG,CAAC,IAAU,EAAE,EAAE;IACrC,OAAO,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF;;GAEG;AACH,SAAgB,WAAW;IACzB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;QACvB,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAA,wBAAa,GAAE,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACxC,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;AACJ,CAAC;AARD,kCAQC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../schematics/ng-update/index.ts"],"names":[],"mappings":";AAAA,yDAAyD;AACzD,8BAA8B;;;AAG9B,6CAA4D;AAC5D,4EAAmE;AAEnE;;GAEG;AACH,SAAgB,WAAW;IACzB,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;QACvB,IAAI,IAAA,uCAAe,EAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAA,wBAAa,GAAE,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACxC,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;AACJ,CAAC;AARD,kCAQC"}

package/schematics/typescript/shell/templates/base/package.json.template

@@ -29,6 +29,7 @@
     }
   },
   "scripts": {
+    "schematics": "schematics",
     "clean": "rimraf test/ test-dev/ dist/ dist-dev/ dist-test/ build/",
     "lint:ci": "eslint \"**/*[jt]s\" --quiet --format junit --output-file ./dist-lint/result.xml",
     "lint": "eslint \"**/*[jt]s\" --cache",
@@ -82,7 +83,7 @@
     "@openapitools/openapi-generator-cli": "<%= versions['@openapitools/openapi-generator-cli'] %>",
     "@stylistic/eslint-plugin-ts": "<%= versions['@stylistic/eslint-plugin-ts'] %>",
     "@swc/cli": "^0.1.57",
-    "@swc/core": "^1.3.85",
+    "@swc/core": "1.5.7",
     "@types/jest": "<%= versions['@types/jest'] %>",
     "@types/node": "<%= versions['@types/node'] %>",
     "@typescript-eslint/eslint-plugin": "<%= versions['@typescript-eslint/eslint-plugin'] %>",