@ama-sdk/schematics 9.1.0-alpha.9 → 9.2.0-alpha.0

package/README.md

@@ -75,3 +75,19 @@ yarn schematics @ama-sdk/schematics:java-client-core --spec-path ./swagger-spec.
 ```
 
 [Default swagger config](./schematics/java/client-core/swagger-codegen-java-client/config/swagger-codegen-config.json) will be used if `--swagger-config-path` is not provided.
+
+### Debug the typescript generator
+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.
+If there is an issue with the files generated with the spec provided, the generator provides debugging features that log this data model.
+
+You can use global property options to pass one or both of the following options:
+* debugModel - logs the full JSON structure used to generate models
+* debugOperations - logs the full JSON structure used to generate operations
+
+Example:
+```shell
+yarn schematics @ama-sdk/schematics:typescript-core --spec-path ./swagger-spec.yaml --global-property debugModels,debugOperations
+```
+You can also use npx instead of yarn in the command.
+
+You can correlate this data model with the [templates](https://github.com/AmadeusITGroup/otter/tree/main/packages/%40ama-sdk/schematics/schematics/typescript/core/openapi-codegen-typescript/src/main/resources/typescriptFetch) used by the generator.

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@ama-sdk/schematics",
-  "version": "9.1.0-alpha.9",
+  "version": "9.2.0-alpha.0",
   "description": "Swagger specification SDK Generator by schematics",
+  "typings": "./src/public_api.d.ts",
   "scripts": {
     "nx": "nx",
     "ng": "yarn nx",
     "test": "yarn nx test ama-sdk-schematics",
     "prepare:build:builders": "yarn cpy 'schematics/**/*.json' 'schematics/**/templates/**' 'schematics/**/*.jar' dist/schematics && yarn cpy '{package,collection}.json' dist",
     "build": "yarn nx build ama-sdk-schematics",
-    "build:builders": "tsc -b tsconfig.builders.json --pretty",
+    "build:builders": "tsc -b tsconfig.builders.json --pretty && yarn generate-cjs-manifest",
     "install-swagger-cli": "mvn install:install-file -DgroupId=io.swagger -DartifactId=swagger-codegen-cli -Dversion=2.4.0-AMADEUS -Dpackaging=jar -Dfile=./schematics/resources/swagger-codegen-cli.jar",
     "build:swagger": "yarn install-swagger-cli && run-p 'build:swagger-*' 'build:openapi-*'",
     "build:openapi-typescript-gen": "mvn clean package -f ./schematics/typescript/core/openapi-codegen-typescript/pom.xml",
@@ -27,9 +28,6 @@
     "@angular-devkit/schematics-cli": {
       "optional": true
     },
-    "@angular/cli": {
-      "optional": true
-    },
     "@angular/compiler": {
       "optional": true
     },
@@ -41,18 +39,17 @@
     }
   },
   "peerDependencies": {
-    "@ama-sdk/core": "^9.1.0-alpha.9",
-    "@angular-devkit/core": "~16.0.5",
-    "@angular-devkit/schematics": "~16.0.5",
-    "@angular-devkit/schematics-cli": "~16.0.5",
-    "@angular/cli": "~16.0.5",
+    "@ama-sdk/core": "^9.2.0-alpha.0",
+    "@angular-devkit/core": "^16.0.5",
+    "@angular-devkit/schematics": "^16.0.5",
+    "@angular-devkit/schematics-cli": "^16.0.5",
     "@openapitools/openapi-generator-cli": "~2.7.0",
-    "@schematics/angular": "~16.0.5"
+    "@schematics/angular": "^16.0.5"
   },
   "dependencies": {
-    "@angular-devkit/core": "~16.0.5",
-    "@angular-devkit/schematics": "~16.0.5",
-    "@o3r/dev-tools": "^9.1.0-alpha.9",
+    "@angular-devkit/core": "~16.1.6",
+    "@angular-devkit/schematics": "~16.1.6",
+    "@o3r/dev-tools": "^9.2.0-alpha.0",
     "js-yaml": "^4.1.0",
     "minimatch": "^9.0.0",
     "rxjs": "^7.8.1",
@@ -61,16 +58,16 @@
     "tslib": "^2.5.3"
   },
   "devDependencies": {
-    "@ama-sdk/core": "^9.1.0-alpha.9",
-    "@angular-devkit/schematics-cli": "~16.0.5",
-    "@angular-eslint/eslint-plugin": "~16.0.3",
-    "@angular/cli": "~16.0.5",
-    "@nx/jest": "~16.5.0",
-    "@o3r/build-helpers": "^9.1.0-alpha.9",
-    "@o3r/eslint-plugin": "^9.1.0-alpha.9",
-    "@o3r/schematics": "^9.1.0-alpha.9",
+    "@ama-sdk/core": "^9.2.0-alpha.0",
+    "@angular-devkit/schematics-cli": "~16.1.6",
+    "@angular-eslint/eslint-plugin": "~16.1.0",
+    "@angular/cli": "~16.1.6",
+    "@nx/jest": "~16.6.0",
+    "@o3r/build-helpers": "^9.2.0-alpha.0",
+    "@o3r/eslint-plugin": "^9.2.0-alpha.0",
+    "@o3r/schematics": "^9.2.0-alpha.0",
     "@openapitools/openapi-generator-cli": "~2.7.0",
-    "@schematics/angular": "~16.0.5",
+    "@schematics/angular": "~16.1.6",
     "@types/jest": "~29.5.2",
     "@types/js-yaml": "^4.0.5",
     "@types/minimatch": "^5.1.2",
@@ -83,22 +80,22 @@
     "cpy-cli": "^4.2.0",
     "eslint": "^8.42.0",
     "eslint-import-resolver-node": "^0.3.4",
-    "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-jsdoc": "^39.3.6",
-    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "eslint-plugin-jest": "~27.2.3",
+    "eslint-plugin-jsdoc": "~46.4.5",
+    "eslint-plugin-prefer-arrow": "~1.2.3",
     "eslint-plugin-unicorn": "^47.0.0",
     "isomorphic-fetch": "~3.0.0",
-    "jest": "~29.6.0",
-    "jest-junit": "^16.0.0",
+    "jest": "~29.6.2",
+    "jest-junit": "~16.0.0",
     "mem-fs": "^2.2.1",
     "npm-run-all": "^4.1.5",
-    "nx": "~16.5.0",
+    "nx": "~16.6.0",
     "onchange": "^7.0.2",
     "pid-from-port": "^1.1.3",
     "semver": "^7.5.2",
-    "ts-jest": "^29.1.0",
+    "ts-jest": "~29.1.1",
     "type-fest": "^3.12.0",
-    "typescript": "~5.0.2"
+    "typescript": "~5.1.6"
   },
   "openApiSupportedVersion": "~6.6.0",
   "engines": {

package/schematics/api-extension/schema.d.ts

@@ -1,5 +1,5 @@
-import { JsonObject } from '@angular-devkit/core';
-export interface NgGenerateApiExtensionSchematicsSchema extends JsonObject {
+import type { SchematicOptionObject } from '@o3r/schematics';
+export interface NgGenerateApiExtensionSchematicsSchema extends SchematicOptionObject {
     /** Extension Name */
     name: string;
     /** Type of the core API to extend */

package/schematics/api-extension/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../schematics/api-extension/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,MAAM,WAAW,sCAAuC,SAAQ,UAAU;IACxE,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,QAAQ,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC/B,wCAAwC;IACxC,WAAW,EAAE,MAAM,CAAC;CACrB"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../schematics/api-extension/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,WAAW,sCAAuC,SAAQ,qBAAqB;IACnF,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,QAAQ,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC/B,wCAAwC;IACxC,WAAW,EAAE,MAAM,CAAC;CACrB"}

package/schematics/code-generator/open-api-cli-generator/open-api-cli.generator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"open-api-cli.generator.d.ts","sourceRoot":"","sources":["../../../../schematics/code-generator/open-api-cli-generator/open-api-cli.generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAoC,iBAAiB,EAAC,MAAM,wBAAwB,CAAC;AAI5F;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,aAAa,CAAC,iBAAiB,CAAC;IAEvE,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,KAAK,GAAG,MAAM,CAAC;IAClD,SAAS,KAAK,oBAAoB,IAAI,KAAK,GAAG,MAAM,CAEnD;IAED,kBAAkB;IAClB,SAAS,CAAC,QAAQ,CAAC,aAAa,6BAA6B;gBAEjD,OAAO,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,EAAE,CAAA;KAAE;IAK9D;;;;;OAKG;IACH,OAAO,CAAC,0BAA0B;IAelC;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAsBpB,kBAAkB;IAClB,SAAS,CAAC,iBAAiB,0BAA2C;IAEtE,kBAAkB;IAClB,SAAS,CAAC,uBAAuB,oBAAoB;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,yBAI5C,iBAAiB,wBAclD;CACH"}
+{"version":3,"file":"open-api-cli.generator.d.ts","sourceRoot":"","sources":["../../../../schematics/code-generator/open-api-cli-generator/open-api-cli.generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAC,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAoC,iBAAiB,EAAC,MAAM,wBAAwB,CAAC;AAI5F;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,aAAa,CAAC,iBAAiB,CAAC;IAEvE,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,KAAK,GAAG,MAAM,CAAC;IAClD,SAAS,KAAK,oBAAoB,IAAI,KAAK,GAAG,MAAM,CAEnD;IAED,kBAAkB;IAClB,SAAS,CAAC,QAAQ,CAAC,aAAa,6BAA6B;gBAEjD,OAAO,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,EAAE,CAAA;KAAE;IAK9D;;;;;OAKG;IACH,OAAO,CAAC,0BAA0B;IAelC;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAuBpB,kBAAkB;IAClB,SAAS,CAAC,iBAAiB,0BAA2C;IAEtE,kBAAkB;IAClB,SAAS,CAAC,uBAAuB,oBAAoB;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,yBAI5C,iBAAiB,wBAclD;CACH"}

package/schematics/code-generator/open-api-cli-generator/open-api-cli.generator.js

@@ -73,7 +73,8 @@ class OpenApiCliGenerator extends code_generator_1.CodeGenerator {
             '-g', generatorOptions.generatorName,
             '-i', generatorOptions.specPath,
             ...generatorOptions.specConfigPath ? ['-c', generatorOptions.specConfigPath] : [],
-            '-o', generatorOptions.outputPath
+            '-o', generatorOptions.outputPath,
+            ...generatorOptions.globalProperty ? ['--global-property', generatorOptions.globalProperty] : []
         ];
         return new Promise((resolve, reject) => {
             (0, node_child_process_1.spawn)(this.packageManagerRunner, args, spawnOptions)

package/schematics/code-generator/open-api-cli-generator/open-api-cli.options.d.ts

@@ -10,7 +10,7 @@ export type OpenApiCliOptions = CodegenTaskOptions & {
      *  - the one defined in your openapitools.json
      *  - the latest version if openapitools.json is missing
      *
-     *  @default null
+     *  @default ''
      */
     generatorVersion: string;
     /**
@@ -25,6 +25,15 @@ export type OpenApiCliOptions = CodegenTaskOptions & {
      * @default path to our own custom typescript generator
      */
     generatorCustomPath: string;
+    /**
+     * Comma separated string of options to give to the openapi-generator-cli
+     *
+     * @example debugModels to log the full json structure used to generate models
+     * @example debugOperations to log the full json structure used to generate operations
+     *
+     * @default ''
+     */
+    globalProperty: string;
 };
 /**
  * Default options to run our custom typescript generator

package/schematics/code-generator/open-api-cli-generator/open-api-cli.options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"open-api-cli.options.d.ts","sourceRoot":"","sources":["../../../../schematics/code-generator/open-api-cli-generator/open-api-cli.options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kBAAkB,EAAC,MAAM,mBAAmB,CAAC;AAGrD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,GAAG;IACnD;;;;;;;OAOG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,EAAE,iBAO/C,CAAC"}
+{"version":3,"file":"open-api-cli.options.d.ts","sourceRoot":"","sources":["../../../../schematics/code-generator/open-api-cli-generator/open-api-cli.options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kBAAkB,EAAC,MAAM,mBAAmB,CAAC;AAGrD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,GAAG;IACnD;;;;;;;OAOG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;;;;;OAOG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,EAAE,iBAQ/C,CAAC"}

package/schematics/code-generator/open-api-cli-generator/open-api-cli.options.js

@@ -11,6 +11,7 @@ exports.defaultTypescriptGeneratorOptions = {
     generatorCustomPath: path.join(__dirname, '..', '..', 'typescript', 'core', 'openapi-codegen-typescript', 'target', 'typescriptFetch-openapi-generator.jar'),
     specPath: 'swagger-spec.yaml',
     outputPath: '.',
-    specConfigPath: ''
+    specConfigPath: '',
+    globalProperty: ''
 };
 //# sourceMappingURL=open-api-cli.options.js.map

package/schematics/java/client-core/schema.d.ts

@@ -1,8 +1,8 @@
-import { JsonObject } from '@angular-devkit/core';
-export interface NgGenerateJavaClientCoreSchematicsSchema extends JsonObject {
+import type { SchematicOptionObject } from '@o3r/schematics';
+export interface NgGenerateJavaClientCoreSchematicsSchema extends SchematicOptionObject {
     /** Path to the swagger specification used to generate the SDK */
     specPath: string;
     /** Swagger config file */
-    specConfigPath: string | null;
+    specConfigPath?: string | undefined;
 }
 //# sourceMappingURL=schema.d.ts.map

package/schematics/java/client-core/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../schematics/java/client-core/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,MAAM,WAAW,wCAAyC,SAAQ,UAAU;IAC1E,iEAAiE;IACjE,QAAQ,EAAE,MAAM,CAAC;IAEjB,0BAA0B;IAC1B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../schematics/java/client-core/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,WAAW,wCAAyC,SAAQ,qBAAqB;IACrF,iEAAiE;IACjE,QAAQ,EAAE,MAAM,CAAC;IAEjB,0BAA0B;IAC1B,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACrC"}

package/schematics/ng-add/schema.d.ts

@@ -1,6 +1,6 @@
-import type { JsonObject } from '@angular-devkit/core';
-export interface NgAddSchematicsSchema extends JsonObject {
+import type { SchematicOptionObject } from '@o3r/schematics';
+export interface NgAddSchematicsSchema extends SchematicOptionObject {
     /** Project name */
-    projectName: string | null;
+    projectName?: string | undefined;
 }
 //# sourceMappingURL=schema.d.ts.map

package/schematics/ng-add/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../schematics/ng-add/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAEvD,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD,mBAAmB;IACnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../schematics/ng-add/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB;IAClE,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC"}

package/schematics/typescript/core/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../schematics/typescript/core/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,IAAI,EAKL,MAAM,4BAA4B,CAAC;AASpC,OAAO,EAAE,2CAA2C,EAAE,MAAM,UAAU,CAAC;AAgBvE;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,2CAA2C,GAAG,IAAI,CA+GlG"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../schematics/typescript/core/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,IAAI,EAKL,MAAM,4BAA4B,CAAC;AASpC,OAAO,EAAE,2CAA2C,EAAE,MAAM,UAAU,CAAC;AAgBvE;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,2CAA2C,GAAG,IAAI,CAgHlG"}

package/schematics/typescript/core/index.js

@@ -24,7 +24,8 @@ const getPathObjectTemplate = (pathObj) => {
  */
 function ngGenerateTypescriptSDK(options) {
     const specPath = path.resolve(process.cwd(), options.specPath);
-    const targetPath = options.directory || '/';
+    const targetPath = options.directory || '';
+    const globalProperty = options.globalProperty;
     const generateOperationFinder = async () => {
         const swayOptions = {
             definition: path.resolve(options.specPath)
@@ -50,10 +51,10 @@ function ngGenerateTypescriptSDK(options) {
      * @param _context
      */
     const clearGeneratedCode = (tree, _context) => {
-        (0, tree_glob_1.treeGlob)(tree, path.join(targetPath, 'src', 'api', '**', '*.ts')).forEach((file) => tree.delete(file));
-        (0, tree_glob_1.treeGlob)(tree, path.join(targetPath, 'src', 'api', '**', '*.ts')).forEach((file) => tree.delete(file));
-        (0, tree_glob_1.treeGlob)(tree, path.join(targetPath, 'src', 'models', 'base', '**', '!(index).ts')).forEach((file) => tree.delete(file));
-        (0, tree_glob_1.treeGlob)(tree, path.join(targetPath, 'src', 'spec', '!(operation-adapter|index).ts')).forEach((file) => tree.delete(file));
+        (0, tree_glob_1.treeGlob)(tree, path.posix.join(targetPath, 'src', 'api', '**', '*.ts')).forEach((file) => tree.delete(file));
+        (0, tree_glob_1.treeGlob)(tree, path.posix.join(targetPath, 'src', 'api', '**', '*.ts')).forEach((file) => tree.delete(file));
+        (0, tree_glob_1.treeGlob)(tree, path.posix.join(targetPath, 'src', 'models', 'base', '**', '!(index).ts')).forEach((file) => tree.delete(file));
+        (0, tree_glob_1.treeGlob)(tree, path.posix.join(targetPath, 'src', 'spec', '!(operation-adapter|index).ts')).forEach((file) => tree.delete(file));
         return tree;
     };
     /**
@@ -100,7 +101,7 @@ function ngGenerateTypescriptSDK(options) {
         return () => tree;
     };
     const runGeneratorRule = (tree, context) => {
-        const generatorOptions = { specPath };
+        const generatorOptions = { specPath, globalProperty };
         const packageJsonFile = JSON.parse(((0, node_fs_1.readFileSync)(path.join(__dirname, '..', '..', '..', 'package.json'))).toString());
         const packageOpenApiSupportedVersion = packageJsonFile.openApiSupportedVersion?.replace(/\^|~/, '');
         let openApiVersion = '';

package/schematics/typescript/core/schema.d.ts

@@ -1,12 +1,20 @@
-import type { JsonObject } from '@angular-devkit/core';
-export interface NgGenerateTypescriptSDKCoreSchematicsSchema extends JsonObject {
+import type { SchematicOptionObject } from '@o3r/schematics';
+export interface NgGenerateTypescriptSDKCoreSchematicsSchema extends SchematicOptionObject {
     /** Path to the swagger specification used to generate the SDK */
     specPath: string;
     /** Directory where to generate the SDK */
-    directory: string | null;
+    directory?: string | undefined;
     /** Package manager to be used in the generated SDK */
-    packageManager: 'npm' | 'yarn' | '';
+    packageManager: 'npm' | 'yarn' | undefined;
     /** Path to the spec generation configuration */
-    specConfigPath: string | null;
+    specConfigPath: string | undefined;
+    /**
+     * Comma separated string of options to give to the openapi-generator-cli
+     *
+     * @example debugModels to log the full json structure used to generate models
+     * @example debugOperations to log the full json structure used to generate operations
+     * @default ''
+     */
+    globalProperty: string | undefined;
 }
 //# sourceMappingURL=schema.d.ts.map

package/schematics/typescript/core/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../schematics/typescript/core/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAEvD,MAAM,WAAW,2CAA4C,SAAQ,UAAU;IAC7E,iEAAiE;IACjE,QAAQ,EAAE,MAAM,CAAC;IAEjB,0CAA0C;IAC1C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,sDAAsD;IACtD,cAAc,EAAE,KAAK,GAAG,MAAM,GAAG,EAAE,CAAC;IAEpC,gDAAgD;IAChD,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../schematics/typescript/core/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,WAAW,2CAA4C,SAAQ,qBAAqB;IACxF,iEAAiE;IACjE,QAAQ,EAAE,MAAM,CAAC;IAEjB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/B,sDAAsD;IACtD,cAAc,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,CAAC;IAE3C,gDAAgD;IAChD,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;;;;OAMG;IACH,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC"}

package/schematics/typescript/core/schema.json

@@ -24,12 +24,14 @@
     "packageManager": {
       "type": "string",
       "enum": [
-        "",
         "npm",
         "yarn"
       ],
-      "description": "Package manager to be used in the generated SDK",
-      "default": ""
+      "description": "Package manager to be used in the generated SDK"
+    },
+    "globalProperty": {
+      "type": "string",
+      "description": "Comma separated string of options to give to the openapi-generator-cli"
     }
   },
   "additionalProperties": true,

package/schematics/typescript/mock/schema.d.ts

@@ -1,5 +1,5 @@
-import type { JsonObject } from '@angular-devkit/core';
-export interface NgGenerateMockSchematicsSchema extends JsonObject {
+import type { SchematicOptionObject } from '@o3r/schematics';
+export interface NgGenerateMockSchematicsSchema extends SchematicOptionObject {
     /** Name of the api model to generate */
     apiModel: string;
     /** True if the api model has a property id */

package/schematics/typescript/mock/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../schematics/typescript/mock/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,sBAAsB,CAAC;AAErD,MAAM,WAAW,8BAA+B,SAAQ,UAAU;IAChE,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAC;IAEjB,8CAA8C;IAC9C,UAAU,EAAE,OAAO,CAAC;IAEpB,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;IAEb,8BAA8B;IAC9B,WAAW,EAAE,MAAM,CAAC;CACrB"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../schematics/typescript/mock/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,WAAW,8BAA+B,SAAQ,qBAAqB;IAC3E,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAC;IAEjB,8CAA8C;IAC9C,UAAU,EAAE,OAAO,CAAC;IAEpB,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;IAEb,8BAA8B;IAC9B,WAAW,EAAE,MAAM,CAAC;CACrB"}

package/schematics/typescript/shell/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../schematics/typescript/shell/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,IAAI,EAIL,MAAM,4BAA4B,CAAC;AAGpC,OAAO,KAAK,EAAE,4CAA4C,EAAE,MAAM,UAAU,CAAC;AAI7E;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,4CAA4C,GAAG,IAAI,CAiFnG"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../schematics/typescript/shell/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,IAAI,EAIL,MAAM,4BAA4B,CAAC;AAKpC,OAAO,KAAK,EAAC,4CAA4C,EAAC,MAAM,UAAU,CAAC;AAE3E;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,4CAA4C,GAAG,IAAI,CAoFnG"}

package/schematics/typescript/shell/index.js

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ngGenerateTypescriptSDK = void 0;
 const schematics_1 = require("@angular-devkit/schematics");
 const js_yaml_1 = require("js-yaml");
-const read_package_1 = require("../../helpers/read-package");
 const node_path_1 = require("node:path");
 const node_install_1 = require("../../helpers/node-install");
+const read_package_1 = require("../../helpers/read-package");
 /**
  * @param options
  */
@@ -47,6 +47,7 @@ function ngGenerateTypescriptSDK(options) {
             projectName: options.name,
             projectPackageName: options.package,
             projectDescription: options.description,
+            packageManager: (0, node_install_1.getPackageManagerName)(options.packageManager),
             projectHosting: options.hosting,
             sdkCoreVersion: amaSdkSchematicsPackageJson.version,
             angularVersion: amaSdkSchematicsPackageJson.dependencies['@angular-devkit/core'],
@@ -56,20 +57,22 @@ function ngGenerateTypescriptSDK(options) {
             engineVersions,
             empty: ''
         };
-        const yarnrcPath = '.yarnrc.yml';
-        const yarnrc = ((0, js_yaml_1.load)(tree.exists(yarnrcPath) ? tree.readText(yarnrcPath) : '') || {});
-        yarnrc.nodeLinker ||= 'pnp';
-        yarnrc.packageExtensions ||= {};
-        yarnrc.packageExtensions['@ama-sdk/schematics@*'] = {
-            dependencies: {
-                'isomorphic-fetch': '~2.2.1'
+        if (properties.packageManager === 'yarn') {
+            const yarnrcPath = '.yarnrc.yml';
+            const yarnrc = ((0, js_yaml_1.load)(tree.exists(yarnrcPath) ? tree.readText(yarnrcPath) : '') || {});
+            yarnrc.nodeLinker ||= 'pnp';
+            yarnrc.packageExtensions ||= {};
+            yarnrc.packageExtensions['@ama-sdk/schematics@*'] = {
+                dependencies: {
+                    'isomorphic-fetch': '~2.2.1'
+                }
+            };
+            if (tree.exists(yarnrcPath)) {
+                tree.overwrite(yarnrcPath, (0, js_yaml_1.dump)(yarnrc, { indent: 2 }));
+            }
+            else {
+                tree.create(yarnrcPath, (0, js_yaml_1.dump)(yarnrc, { indent: 2 }));
             }
-        };
-        if (tree.exists(yarnrcPath)) {
-            tree.overwrite(yarnrcPath, (0, js_yaml_1.dump)(yarnrc, { indent: 2 }));
-        }
-        else {
-            tree.create(yarnrcPath, (0, js_yaml_1.dump)(yarnrc, { indent: 2 }));
         }
         const targetPath = options.directory || tree.root.path;
         const baseRule = (0, schematics_1.mergeWith)((0, schematics_1.apply)((0, schematics_1.url)('./templates/base'), [

package/schematics/typescript/shell/schema.d.ts

@@ -1,15 +1,15 @@
-import type { JsonObject } from '@angular-devkit/core';
-export interface NgGenerateTypescriptSDKShellSchematicsSchema extends JsonObject {
+import type { SchematicOptionObject } from '@o3r/schematics';
+export interface NgGenerateTypescriptSDKShellSchematicsSchema extends SchematicOptionObject {
     /** Project name (NPM package scope, package.json name will be @{projectName}/{packageName}) */
     name: string;
     /** Package name (package.json name will be @{projectName}/{packageName}) */
     package: string;
     /** Project description */
-    description: string | null;
+    description?: string | undefined;
     /** Directory where to generate the SDK */
-    directory: string | null;
+    directory?: string | undefined;
     /** Package manager to be used in the generated SDK */
-    packageManager: 'npm' | 'yarn' | '';
+    packageManager?: 'npm' | 'yarn' | undefined;
     /** Skip NPM install */
     skipInstall: boolean;
 }

package/schematics/typescript/shell/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../schematics/typescript/shell/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAEvD,MAAM,WAAW,4CAA6C,SAAQ,UAAU;IAC9E,+FAA+F;IAC/F,IAAI,EAAE,MAAM,CAAC;IAEb,4EAA4E;IAC5E,OAAO,EAAE,MAAM,CAAC;IAEhB,0BAA0B;IAC1B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,0CAA0C;IAC1C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,sDAAsD;IACtD,cAAc,EAAE,KAAK,GAAG,MAAM,GAAG,EAAE,CAAC;IAEpC,uBAAuB;IACvB,WAAW,EAAE,OAAO,CAAC;CACtB"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../schematics/typescript/shell/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,WAAW,4CAA6C,SAAQ,qBAAqB;IACzF,+FAA+F;IAC/F,IAAI,EAAE,MAAM,CAAC;IAEb,4EAA4E;IAC5E,OAAO,EAAE,MAAM,CAAC;IAEhB,0BAA0B;IAC1B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEjC,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/B,sDAAsD;IACtD,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,CAAC;IAE5C,uBAAuB;IACvB,WAAW,EAAE,OAAO,CAAC;CACtB"}

package/schematics/typescript/shell/schema.json

@@ -31,12 +31,10 @@
     "packageManager": {
       "type": "string",
       "enum": [
-        "",
         "npm",
         "yarn"
       ],
-      "description": "Package manager to be used in the generated SDK",
-      "default": ""
+      "description": "Package manager to be used in the generated SDK"
     }
   },
   "additionalProperties": true,

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

@@ -6,9 +6,6 @@
 /generated-*
 /build
 
-# Local configurations
-.custom.yo-rc.json
-
 # Open API
 .openapi-generator
 
@@ -38,6 +35,7 @@
 .history
 .ionide
 
+<% if (packageManager === 'yarn') { %>
 # Support for Project snippet scope
 
 ### yarn ###
@@ -56,10 +54,8 @@
 
 # and uncomment the following lines
 .pnp.*
-
-### Yeoman ###
+<% } %>
 node_modules/
-bower_components/
 *.log
 
 build/

package/schematics/typescript/shell/templates/base/.husky/commit-msg

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn commitlint --edit $1
+<%=packageManager%> exec commitlint --edit $1

package/schematics/typescript/shell/templates/base/.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn lint-staged
+<%=packageManager%> exec lint-staged

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

@@ -26,7 +26,7 @@
   ],
   "updateInternalDeps": true,
   "postUpdateOptions": [
-    "yarnDedupeHighest"
+    <% if (packageManager === 'yarn') { %>"yarnDedupeHighest",<% } %>
   ],
   "rangeStrategy": "replace",
   "automerge": true,
@@ -39,8 +39,8 @@
       ],
       "postUpgradeTasks": {
         "commands": [
-          "yarn install",
-          "yarn run swagger:generate"
+          "<%=packageManager%> install",
+          "<%=packageManager%> run generate"
         ],
         "executionMode": "branch"
       }

package/schematics/typescript/shell/templates/base/.vscode/settings.json

@@ -1,7 +1,7 @@
 {
   "typescript.preferences.importModuleSpecifier": "relative",
   "typescript.preferences.quoteStyle": "single",
-  "jest.jestCommandLine": "yarn jest",
+  "jest.jestCommandLine": "<%=packageManager%> exec jest",
   "jest.autoRun": {
     "watch": false,
     "onSave": "test-file"
@@ -9,8 +9,10 @@
   "files.readonlyFromPermissions": true,
   "files.readonlyInclude": {
     "**/.cache/**": true,
+    <% if (packageManager === 'yarn') { %>
     "**/.pnp.*": true,
     "**/.yarn/**": true,
+    <% } %>
     "**/node_modules/**": true,
     "src/base/*/*.ts": true
   },

package/schematics/typescript/shell/templates/base/jest.config.js

@@ -12,12 +12,15 @@ module.exports = {
     '^@<%=projectName%>/<%=projectPackageName%>$': ['<rootDir>/dist/cjs', '<rootDir>/src'],
     '^@<%=projectName%>/<%=projectPackageName%>/(.*)$': ['<rootDir>/dist/cjs/$1', '<rootDir>/src/$1'],
   },
-  globals: {
+  transform: {
     // eslint-disable-next-line @typescript-eslint/naming-convention
-    'ts-jest': {
-      tsconfig: '<rootDir>/testing/tsconfig.spec.json',
-      isolatedModules: true,
-      stringifyContentPathRegex: '\\.html$',
-    }
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        tsconfig: '<rootDir>/testing/tsconfig.spec.json',
+        isolatedModules: true,
+        stringifyContentPathRegex: '\\.html$',
+      }
+    ]
   }
 };

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

@@ -1,6 +1,6 @@
 {
   "name": "@<%=projectName%>/<%=projectPackageName%>",
-  "version": "0.0.0",
+  "version": "0.0.0-placeholder",
   "description": "<%=projectPackageName%> - SDK",
   "source": "src/index.ts",
   "main": "cjs/index.js",
@@ -32,15 +32,15 @@
     "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",
-    "start": "tsc-watch -b tsconfigs/esm2020 --noClear --onFirstSuccess \"yarn files:pack --watch\"",
-    "build": "yarn build:cjs && yarn build:esm2015 && yarn build:esm2020 && yarn files:pack",
+    "start": "tsc-watch -b tsconfigs/esm2020 --noClear --onFirstSuccess \"<%=packageManager%> run files:pack --watch\"",
+    "build": "<%=packageManager%> run build:cjs && <%=packageManager%> run build:esm2015 && <%=packageManager%> run build:esm2020 && <%=packageManager%> run files:pack",
     "build:cjs": "swc src -d dist/cjs -C module.type=commonjs -q",
     "build:esm2015": "swc src -d dist/esm2015 -C module.type=es6 -q",
     "build:esm2020": "tsc -b tsconfigs/esm2020",
-    "set:version": "set-version --placeholder 0.0.0",
+    "set:version": "set-version --placeholder 0.0.0-placeholder",
     "resolve": "node -e 'process.stdout.write(require.resolve(process.argv[1]));'",
     "generate": "schematics @ama-sdk/schematics:typescript-core --spec-path ./swagger-spec.yaml",
-    "spec:regen": "schematics @ama-sdk/schematics:typescript-core --spec-path ./swagger-spec.yaml && yarn clear-index",
+    "spec:regen": "<%=packageManager%> run generate && <%=packageManager%> exec clear-index",
     "clear-index": "node scripts/clear-index.js",
     "files:pack": "node scripts/files-pack.js",
     "test": "jest --passWithNoTests",
@@ -52,7 +52,7 @@
   },
   "lint-staged": {
     "**/*.(js|ts)": [
-      "yarn eslint --quiet --fix --global fast"
+      "<%=packageManager%> exec eslint --quiet --fix --global fast"
     ]
   },
   "dependencies": {
@@ -94,16 +94,16 @@
     "eslint-plugin-prefer-arrow": "<%= versions['eslint-plugin-prefer-arrow'] %>",
     "eslint-plugin-unicorn": "<%= versions['eslint-plugin-unicorn'] %>",
     "glob": "^8.0.0",
-    "husky": "^8.0.0",
+    "husky": "~8.0.3",
     "isomorphic-fetch": "<%= versions['isomorphic-fetch'] %>",
     "jest": "<%= versions['jest'] %>",
-    "jest-junit": "^16.0.0",
+    "jest-junit": "~16.0.0",
     "lint-staged": "^13.0.0",
     "minimist": "^1.2.6",
-    "rimraf": "^5.0.0",
+    "rimraf": "^5.0.1",
     "standard-version": "^9.0.0",
     "ts-jest": "<%= versions['ts-jest'] %>",
-    "typedoc": "~0.24.0",
+    "typedoc": "~0.24.8",
     "tsc-watch": "^6.0.0",
     "typescript": "<%= versions['typescript'] %>"
   },
@@ -115,6 +115,5 @@
     "node": "<%= engineVersions['node'] %>",
     "npm": "<%= engineVersions['npm'] %>",
     "yarn": "<%= engineVersions['yarn'] %>"
-  },
-  "packageManager": "yarn@3.6.1"
+  }
 }

package/schematics/typescript/shell/templates/base/readme.md

@@ -22,6 +22,7 @@ The Code can be regenerated by running the following command:
 ```shell
 yarn schematics @ama-sdk/sdk:typescript-core --spec-path [path to your swagger file]
 ```
+Note that you can use ```npm exec``` instead of ```yarn``` for every command specified in this documentation.
 
 ***
 
@@ -109,11 +110,95 @@ You can build and run UT with:
 yarn test
 ```
 
-## Vendor extensions
+## Manage dates
 
-These are some of the available configurations using vendor extensions in the swagger spec
+### The timezone issue
+Managing dates with timezones has always been a bit painful in front end applications.
+Let's give a concrete example to understand the problem:
+An API returns the date and hour of your flight in the timezone of the airport location. In our use case, let's say the departure airport is on GTM+7 : 2023-07-10T00:37:00.000+07:00.
+The timezone sent is the one from the airport, here GMT+7. If you just use the Date(), the computer browser will convert this in its own timezone.
+For example, if the user is in GMT+2 you will end up displaying the following: 2023-07-09T19:37:00.000+02:00.
+This is not what you want. You want the exact date time of the flight at the airport timezone, not the one of your user's computer.
+However, there might be cases where you might still need the timezone information.
+For example, you want to be able to display that the flight is in X hours.
+You will need to compute this information with the two timezones -- the airport's and the user's.
 
-### Manage timezone in date
+### Solution proposed to remove the timezone: utils.DateTime
+We have introduced the utils.Date object to replace the Date implementation and ignore the timezone.
+As we need to get rid of the timezones more often than not, this will be our default behavior.
+By default, the Date models are replaced with utils.Date.
+
+When we need to keep the timezone information, we create a new field directly in the SDK.
+As this field does not exist in the specification, it will not be part of the base model but of the core model instead.
+
+Simple example:
+```yaml
+  Flight:
+    type: "object"
+    required:
+      - departureDateTime
+    properties:
+      departureDateTime:
+        type: string
+        format: date-time
+```
+Base model generated
+```typescript
+// flight.ts generated in base models
+export interface Flight {
+  /** @see utils.DateTime */
+  departureDateTime: utils.DateTime;
+}
+```
+You need to create a core model to store the timezone information (src/models/core/flight.ts):
+```typescript
+import type { IgnoreEnum } from '@ama-sdk/core';
+import type { Flight } from '../../base/flight/flight';
+export type FlightStopCoreIfy<T extends IgnoreEnum<Flight>> = T & {
+  /** Departure date time of the flight considering timezone */
+  departureDateTimeConsideringTimezone?: Date;
+};
+```
+
+And an associated reviver (src/models/core/flight.reviver.ts):
+```typescript
+import type { Flight } from '../../base/flight/flight';
+import type { reviveFlight } from '../../base/flight/flight.reviver';
+import type { FlightCoreIfy } from './flight';
+
+/**
+ * @param baseRevive
+ */
+export function reviveFlightFactory<R extends typeof reviveFlight>(baseRevive: R) {
+  const reviver = <T extends Flight = Flight>(data: any, dictionaries?: any) => {
+    const originalData: any = {...data};
+    const revivedData = baseRevive<FlightCoreIfy<T>>(data, dictionaries);
+    if (!revivedData) {
+      return;
+    }
+    revivedData.departureDateTimeConsideringTimezone = originalData.departureDateTimeConsideringTimezone && new Date(originalData.departureDateTimeConsideringTimezone)
+      || originalData.departureDateTime && new Date(originalData.departureDateTime);
+    return revivedData;
+  };
+  return reviver;
+}
+```
+
+And export it here (src/models/core/flight/index.ts):
+```typescript
+export * from './flight';
+export * from './flight.reviver';
+```
+
+And here (src/models/core/index.ts):
+```typescript
+export * from './flight/index';
+```
+
+You can now use departureDateTimeConsideringTimezone to access the timezone information.
+See [utils.Date](https://github.com/AmadeusITGroup/otter/blob/main/packages/%40ama-sdk/core/src/fwk/date.ts) for more information.
+
+### How to keep the timezone (prevent Date replacement with utils.Date)
 
 In order to add the timezone to your timestamp property you can add the x-date-timezone extension in your yaml, for example:
 

package/schematics/typescript/shell/templates/base/src/api/fixtures.jest.ts

@@ -0,0 +1,2 @@
+// This contains testing helpers for api endpoints, will be filled when the sdk is generated from a spec.
+export type { };

package/schematics/typescript/shell/templates/base/src/api/index.ts

@@ -0,0 +1 @@
+export type { };

package/schematics/typescript/shell/templates/base/src/models/base/enums.ts

@@ -0,0 +1,2 @@
+// This contains enums from the spec, will be filled when the sdk is generated.
+export { };

package/schematics/typescript/shell/templates/base/src/models/base/index.ts

@@ -0,0 +1 @@
+export type { };

package/schematics/typescript/shell/templates/base/src/models/base/patterns.ts

@@ -0,0 +1,2 @@
+// This contains patterns from the spec, will be filled when the sdk is generated.
+export { };

package/schematics/typescript/shell/templates/base/src/spec/api-mock.ts

@@ -0,0 +1,2 @@
+// This contains testing helpers for api endpoints, will be filled when the sdk is generated from a spec.
+export { };