@ama-sdk/schematics 11.0.0-next.0 → 11.0.0-next.1

package/schematics/typescript/shell/schema.json

@@ -35,11 +35,15 @@
         "yarn"
       ],
       "description": "Package manager to be used in the generated SDK"
+    },
+    "exactO3rVersion": {
+      "type": "boolean",
+      "description": "Use a pinned version for otter packages",
+      "default": false
     }
   },
   "additionalProperties": true,
   "required": [
-    "name",
     "package"
   ]
 }

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

@@ -2,19 +2,16 @@
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
     "config:base",
-    "group:allNonMajor",
-    "group:recommended",
-    "group:monorepos",
-    "group:test",
-    "group:linters"
+    "github>AmadeusITGroup/otter//tools/renovate/base",
+    "github>AmadeusITGroup/otter//tools/renovate/sdk",
+    "github>AmadeusITGroup/otter//tools/renovate/sdk-spec-upgrade(my-specification-package)"
   ],
   "prConcurrentLimit": 0,
   "prHourlyLimit": 0,
   "baseBranches": [
-    "master"
+    "master",
+    "main"
   ],
-  "endpoint": "https://dev.azure.com/AmadeusDigitalAirline",
-  "platform": "azure",
   "enabledManagers": [
     "npm"
   ],
@@ -22,7 +19,7 @@
     "stabilityDays": 0
   },
   "labels": [
-    "upgrade"
+    "dependencies"
   ],
   "updateInternalDeps": true,
   "postUpdateOptions": [
@@ -32,54 +29,6 @@
   "automerge": true,
   "platformAutomerge": true,
   "packageRules": [
-    {
-      "matchPackagePrefixes": [
-        "@my-api-scope",
-        "@ama-sdk/generator"
-      ],
-      "postUpgradeTasks": {
-        "commands": [
-          "<%=packageManager%> install",
-          "<%=packageManager%> run generate"
-        ],
-        "executionMode": "branch"
-      }
-    },
-    {
-      "matchPackagePrefixes": [
-        "@my-api-scope"
-      ],
-      "rangeStrategy": "bump",
-      "groupName": "Swagger Specification upgrade",
-      "groupSlug": "spec-upgrade"
-    },
-    {
-      "matchPackagePrefixes": [
-        "@my-api-scope"
-      ],
-      "matchBaseBranches": [
-        "/^release\/.*/"
-      ],
-      "rangeStrategy": "in-range-only"
-    },
-    {
-      "matchPackageNames": [
-        "@ama-sdk/core",
-        "@ama-sdk/schematics"
-      ],
-      "rangeStrategy": "bump",
-      "groupName": "SDK Core and Generator dependencies",
-      "groupSlug": "sdk-core-dependencies"
-    },
-    {
-      "excludePackagePrefixes": [
-        "@my-api-scope"
-      ],
-      "matchBaseBranches": [
-        "/^release\/.*/"
-      ],
-      "enabled": false
-    },
     {
       "matchDepTypes": [
         "peerDependencies"

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

@@ -14,9 +14,13 @@
     "**/.yarn/**": true,
     <% } %>
     "**/node_modules/**": true,
-    "src/base/*/*.ts": true
+    "src/api/**/*.ts": true,
+    "src/models/base/**/*.ts": true,
+    "src/spec/api-mock.ts": true,
+    "src/spec/operation-adapter.ts": true
   },
   "files.readonlyExclude": {
-    "src/base/*/index.ts": true
+    "src/api/*/index.ts": true,
+    "src/models/base/*/index.ts": true
   }
 }

package/schematics/typescript/shell/templates/base/{openapitools.json → openapitools.json.template}

@@ -3,6 +3,13 @@
   "spaces": 2,
   "generator-cli": {
     "version": "<%= openApiSupportedVersion %>",
-    "storageDir": ".openapi-generator"
+    "storageDir": ".openapi-generator",
+    "generators": {
+      "<%=projectName%>-<%=projectPackageName%>": {
+        "generatorName": "typescriptFetch",
+        "output": ".",
+        "inputSpec": ""
+      }
+    }
   }
 }

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

@@ -30,8 +30,8 @@
   },
   "scripts": {
     "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",
+    "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 \"<%=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",
@@ -40,13 +40,12 @@
     "set:version": "o3r-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:regen": "<%=packageManager%> run generate <% if (packageManager === 'npm') {%>-- <%}%>--spec-path ./swagger-spec.yaml && amasdk-clear-index",
+    "spec:regen": "<%=packageManager%> run generate <% if (packageManager === 'npm') {%>-- <%}%>--generator-key <%=projectName%>-<%=projectPackageName%> && amasdk-clear-index",
     "files:pack": "amasdk-files-pack",
     "test": "jest --passWithNoTests",
     "publish:package": "npm publish ./dist",
-    "postinstall": "husky install",
     "generate:mock": "schematics @ama-sdk/schematics:mock",
-    "doc:generate": "cpx ./readme.md ./.readme-backup && typedoc && cpx ./.readme-backup ./readme.md && rimraf ./.readme-backup",
+    "doc:generate": "typedoc",
     "tools:changelog": "standard-version"
   },
   "lint-staged": {
@@ -71,43 +70,47 @@
     "@angular-eslint/eslint-plugin-template": "<%= angularEslintVersion %>",
     "@angular-eslint/utils": "<%= angularEslintVersion %>",
     "@angular/compiler": "<%= angularVersion %>",
+    "@angular/cli": "<%= angularVersion %>",
     "@commitlint/cli": "^17.0.0",
     "@schematics/angular": "<%= angularVersion %>",
     "@commitlint/config-conventional": "^17.0.0",
-    "@ama-sdk/schematics": "~<%= sdkCoreVersion %>",
-    "@ama-sdk/core": "~<%= sdkCoreVersion %>",
-    "@o3r/eslint-config-otter": "^<%= sdkCoreVersion %>",
-    "@o3r/eslint-plugin": "^<%= sdkCoreVersion %>",
-    "@o3r/schematics": "^<%= sdkCoreVersion %>",
-    "@o3r/workspace": "^<%= sdkCoreVersion %>",
+    "@ama-sdk/schematics": "<%= sdkCoreRange %>",
+    "@ama-sdk/core": "<%= sdkCoreRange %>",
+    "@o3r/eslint-config-otter": "<%= sdkCoreRange %>",
+    "@o3r/eslint-plugin": "<%= sdkCoreRange %>",
+    "@o3r/schematics": "<%= sdkCoreRange %>",
     "@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",
     "@types/jest": "<%= versions['@types/jest'] %>",
     "@types/node": "<%= versions['@types/node'] %>",
     "@typescript-eslint/eslint-plugin": "<%= versions['@typescript-eslint/eslint-plugin'] %>",
     "@typescript-eslint/parser": "<%= versions['@typescript-eslint/parser'] %>",
-    "cpy": "<%= versions['cpy'] %>",
     "cpy-cli": "<%= versions['cpy-cli'] %>",
     "eslint": "<%= versions['eslint'] %>",
+    "eslint-import-resolver-node": "<%= versions['eslint-import-resolver-node'] %>",
     "eslint-plugin-jest": "<%= versions['eslint-plugin-jest'] %>",
     "eslint-plugin-jsdoc": "<%= versions['eslint-plugin-jsdoc'] %>",
     "eslint-plugin-prefer-arrow": "<%= versions['eslint-plugin-prefer-arrow'] %>",
     "eslint-plugin-unicorn": "<%= versions['eslint-plugin-unicorn'] %>",
     "globby": "<%= versions['globby'] %>",
-    "husky": "~8.0.3",
     "isomorphic-fetch": "<%= versions['isomorphic-fetch'] %>",
     "jest": "<%= versions['jest'] %>",
     "jest-junit": "~16.0.0",
     "lint-staged": "^13.0.0",
     "minimist": "^1.2.6",
     "rimraf": "^5.0.1",
+    "rxjs": "<%= versions['rxjs'] %>",
     "standard-version": "^9.0.0",
     "ts-jest": "<%= versions['ts-jest'] %>",
     "typedoc": "~0.25.0",
     "tsc-watch": "^6.0.0",
     "typescript": "<%= versions['typescript'] %>"
-  },
+  },<% if (exactO3rVersion) { %>
+  "<%= packageManager == 'yarn' ? 'resolutions' : 'overrides' %>": {
+    "@o3r/schematics": "<%= sdkCoreRange %>"
+  },<% } %>
   "peerDependencies": {
     "@ama-sdk/core": "~<%= sdkCoreVersion %>",
     "isomorphic-fetch": "<%= versions['isomorphic-fetch'] %>"

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

@@ -1,26 +1,26 @@
 <% if (projectDescription) { %># <%=projectDescription%><% } %>
 
-### Based on Swagger spec 0.0.0
+### Based on OpenAPI spec 0.0.0
 
 The SDK contains 2 different parts:
 
-* Auto generated code (based on Swagger Spec)
+* Auto generated code (based on OpenAPI Spec)
 * Specific code dedicated to this SDK
 
 ## Structure
 
 ### Auto Generated code
 
-A main part of the SDK is automatically generated from a Swagger Spec.
+A main part of the SDK is automatically generated from an OpenAPI Spec.
 The following folders contain the generated code:
 
 * **src/api**: Containing the API calls files
-* **src/models/base**: Models based of swagger definitions
+* **src/models/base**: Models based of OpenAPI definitions
 
 The Code can be regenerated by running the following command:
 
 ```shell
-yarn create @ama-sdk typescript --spec-path [path to your swagger file]
+yarn create @ama-sdk typescript --spec-path [path to your openapi file]
 ```
 Note that you can use ```npm exec``` instead of ```yarn``` for every command specified in this documentation.
 
@@ -40,45 +40,45 @@ You can extend a base model in 3 steps:
 * Redirect the default model to your override:
 
 ```typescript
-// src/models/base/<model name>/index.ts
-export * from "../../core/<model name>";
+// src/models/base/your-model-name/index.ts
+export * from "../../core/your-model-name";
 ```
 
-* Indicate to Swagger CodeGen that you have override the base model:
+* Indicate to OpenAPI CodeGen that you have overridden the base model:
 
 ```gitignore
-# in .swagger-codegen-ignore
-src/models/base/<model name>/index.ts
+# in .openapi-codegen-ignore
+src/models/base/your-model-name/index.ts
 ```
 
 * Create your core models
 
 ```typescript
-// src/models/core/<model name>/index.ts
-export * from "./<model name>.ts";
-export * from "./<model name>.reviver.ts";
+// src/models/core/your-model-name/index.ts
+export * from "./your-model-name.ts";
+export * from "./your-model-name.reviver.ts";
 ```
 
 ```typescript
-// src/models/core/<model name>/<model name>.ts
-import { <model name> as Base<model name> } from "../../base/<model name>/<model name>";
+// src/models/core/your-model-name/your-model-name.ts
+import { YourModelName as BaseYourModelName } from "../../base/your-model-name/your-model-name";
 
-export interface <model name> extends BaseB<model name> {
+export interface YourModelName extends BaseYourModelName {
   // Additional fields
 }
 ```
 
 ```typescript
-// src/models/core/<model name>/<model name>.reviver.ts
-import { yourFunction } from "../../../helpers/<model name>";
-import { revive<model name> as Base<model name> } from "../../base/<model name>/<model name>.reviver";
-import { <model name> } from "./<model name>";
+// src/models/core/your-model-name/your-model-name.reviver.ts
+import { yourFunction } from "../../../helpers/your-model-name";
+import { reviveYourModelName as baseReviveYourModelName } from "../../base/your-model-name/your-model-name.reviver";
+import { YourModelName } from "./your-model-name";
 
 import {Reviver, utils} from "@ama-sdk/core";
 
-export function revive<model name><T extends <model name> = <model name>>(data: any, dictionary?: any) {
+export function reviveYourModelName<T extends YourModelName = YourModelName>(data: any, dictionary?: any) {
   // TODO: use BaseRevive<T> when ready
-  const revivedData: T | undefined = Base<model name>(data, dictionary) as T | undefined;
+  const revivedData: T | undefined = baseReviveYourModelName(data, dictionary) as T | undefined;
 
   if (!revivedData) { return ; }
 
@@ -96,7 +96,7 @@ export function revive<model name><T extends <model name> = <model name>>(data:
 
 Some commands are provided to keep your SDK up-to-date.
 
-### Generate SDK from a Swagger specification
+### Generate SDK from an OpenAPI specification
 
 ```shell
 yarn spec:regen

package/schematics/typescript/shell/templates/base/testing/tsconfig.spec.json

@@ -13,7 +13,6 @@
     "declaration": false,
     "declarationMap": false,
     "strict": false,
-    "skipLibCheck": true,
     "module": "ES2020",
     "target": "ES2020"
   },

package/schematics/typescript/shell/templates/base/tsconfig.build.json

@@ -21,24 +21,6 @@
     "composite": true,
     "declaration": true,
     "declarationMap": false,
-    "rootDir": "./src",
-    "baseUrl": ".",
-    "paths": {
-      "<% if (projectName) { %>@<%=projectName%>/<% } %><%=projectPackageName%>/helpers/*": [
-        "./src/helpers/*"
-      ],
-      "<% if (projectName) { %>@<%=projectName%>/<% } %><%=projectPackageName%>/helpers": [
-        "./src/helpers/index"
-      ],
-      "<% if (projectName) { %>@<%=projectName%>/<% } %><%=projectPackageName%>": [
-        "./src/index"
-      ],
-      "<% if (projectName) { %>@<%=projectName%>/<% } %><%=projectPackageName%>/*": [
-        "./src/*"
-      ],
-      "<% if (projectName) { %>@<%=projectName%>/<% } %><%=projectPackageName%>/spec": [
-        "./src/spec/index"
-      ]
-    }
+    "rootDir": "./src"
   }
 }

package/schematics/typescript/shell/templates/base/tsconfig.doc.json

@@ -10,10 +10,10 @@
     "**/fixtures*.ts",
     "**/*.mock*.ts",
     "**/*.spec.ts",
-    "**/*.perf.ts",
-    "**/*.reviver.ts"
+    "**/*.perf.ts"
   ],
   "include": [
+    "./src/api/**/*.ts",
     "./src/models/**/*.ts",
     "./src/helpers/**/*.ts"
   ]

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

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

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

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