@ama-sdk/schematics 0.0.0-placeholder

package/LICENSE

@@ -0,0 +1,26 @@
+Copyright Amadeus SAS
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+may be used to endorse or promote products derived from this software without
+specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,72 @@
+# SDK Generator
+
+This package provides `schematics` generators to create an SDK based on an API swagger spec.
+
+## Setup
+
+The Angular schematics package is required to use these generators:
+
+if you are in an Angular project
+
+```shell
+yarn ng add @ama-sdk/schematics
+yarn ng add @ama-sdk/core
+```
+or
+```shell
+npx -p @angular/cli ng add @ama-sdk/schematics
+npx -p @angular/cli ng add @ama-sdk/core
+```
+
+else
+
+```shell
+# Install @angular-devkit/schematics-cli, @ama-sdk/core and the SDK generator
+yarn add --dev @angular-devkit/schematics-cli @ama-sdk/schematics @ama-sdk/core
+yarn schematics @ama-sdk/schematics:install
+yarn schematics @ama-sdk/core:install
+```
+or
+```shell
+npm i -D @angular-devkit/schematics-cli @ama-sdk/schematics @ama-sdk/core
+npx -p @angular-devkit/schematics-cli schematics @ama-sdk/schematics:install
+npx -p @angular-devkit/schematics-cli schematics @ama-sdk/core:install
+```
+
+## How to use?
+
+### Typescript SDK
+
+The typescript generator provides 2 generators:
+
+- **shell**: To generate the "shell" of an SDK package
+- **core**: To (re)generate the SDK based on a specified Swagger spec
+- **create**: To create a new SDK from scratch (i.e. chain **shell** and **core**)
+
+To generate the `shell` you can run:
+
+```shell
+yarn schematics @ama-sdk/schematics:typescript-shell
+```
+
+If you use `Yarn2+`, you can use the following `scripts` in `package.json`:
+
+```json
+    "resolve": "node -e 'process.stdout.write(require.resolve(process.argv[1]));'",
+    "generate": "yarn schematics @ama-sdk/schematics:typescript-core --swagger-spec-path ./swagger-spec.yaml",
+    "upgrade:repository": "yarn schematics @ama-sdk/schematics:typescript-shell",
+```
+
+Use `generate` to (re)generate your SDK based on the content of `./swagger-spec.yaml` (make sure you have this file at the root of your project) and `upgrade:repository` to regenerate the structure of your project.
+
+### Java Client Core SDK
+
+Generate a Java Client Core SDK:
+
+Make sure to have a `./swagger-spec.yaml` file at the root of your project and run:
+
+```shell
+yarn schematics @ama-sdk/schematics:java-client-core --swagger-spec-path ./swagger-spec.yaml --swagger-config-path ./swagger-codegen-config.json
+```
+
+[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.

package/collection.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "https://raw.githubusercontent.com/angular/angular-cli/master/packages/angular_devkit/schematics/collection-schema.json",
+  "schematics": {
+    "ng-add": {
+      "description": "Add Otter ama-sdk-schematics to the project.",
+      "factory": "./schematics/ng-add/index#ngAdd",
+      "schema": "./schematics/ng-add/schema.json",
+      "aliases": ["install", "i"]
+    },
+    "typescript-mock": {
+      "description": "Generate an api mock into the project.",
+      "factory": "./schematics/typescript/mock/index#ngGenerateMock",
+      "schema": "./schematics/typescript/mock/schema.json"
+    },
+    "api-extension": {
+      "description": "Generate a api specification extension.",
+      "factory": "./schematics/api-extension/index#ngGenerateApiExtension",
+      "schema": "./schematics/api-extension/schema.json"
+    },
+    "typescript-core": {
+      "description": "Generate a typescript SDK source code based on swagger specification",
+      "factory": "./schematics/typescript/core/index#ngGenerateTypescriptSDK",
+      "schema": "./schematics/typescript/core/schema.json"
+    },
+    "typescript-shell": {
+      "description": "Generate a typescript SDK repository shell",
+      "factory": "./schematics/typescript/shell/index#ngGenerateTypescriptSDK",
+      "schema": "./schematics/typescript/shell/schema.json"
+    },
+    "typescript-sdk": {
+      "alias": ["typescript-create"],
+      "description": "Generate a typescript SDK repository with code based on swagger specification",
+      "factory": "./schematics/typescript/create/index#ngGenerateTypescriptSDK",
+      "schema": "./schematics/typescript/create/schema.json"
+    },
+    "java-client-core": {
+      "description": "Generate a Java SDK source code based on swagger specification",
+      "factory": "./schematics/java/client-core/index#ngGenerateJavaClientCore",
+      "schema": "./schematics/java/client-core/schema.json"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,148 @@
+{
+  "name": "@ama-sdk/schematics",
+  "version": "0.0.0-placeholder",
+  "description": "Swagger specification SDK Generator by schematics",
+  "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",
+    "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:swagger-typescript-gen": "mvn clean package -f ./schematics/typescript/core/swagger-codegen-typescript/pom.xml",
+    "build:swagger-java-client-gen": "mvn clean package -f ./schematics/java/client-core/swagger-codegen-java-client/pom.xml",
+    "prepare:publish": "prepare-publish ./dist"
+  },
+  "schematics": "./collection.json",
+  "keywords": [
+    "schematics",
+    "sdk"
+  ],
+  "peerDependenciesMeta": {
+    "@ama-sdk/core": {
+      "optional": true
+    },
+    "@angular-devkit/schematics-cli": {
+      "optional": true
+    },
+    "@angular/cli": {
+      "optional": true
+    },
+    "@angular/compiler": {
+      "optional": true
+    }
+  },
+  "peerDependencies": {
+    "@ama-sdk/core": "workspace:^",
+    "@angular-devkit/core": "~15.2.0",
+    "@angular-devkit/schematics": "~15.2.0",
+    "@angular-devkit/schematics-cli": "~15.2.0",
+    "@angular/cli": "~15.2.0",
+    "@schematics/angular": "~15.2.0"
+  },
+  "dependencies": {
+    "@angular-devkit/core": "~15.2.0",
+    "@angular-devkit/schematics": "~15.2.0",
+    "@o3r/dev-tools": "workspace:^",
+    "minimatch": "^6.1.6",
+    "rxjs": "^7.4.0",
+    "sway": "^2.0.6",
+    "tslib": "^2.4.1"
+  },
+  "devDependencies": {
+    "@ama-sdk/core": "workspace:^",
+    "@angular-devkit/schematics-cli": "~15.2.0",
+    "@angular-eslint/eslint-plugin": "~15.2.0",
+    "@angular/cli": "~15.2.0",
+    "@nrwl/jest": "~15.9.0",
+    "@o3r/build-helpers": "workspace:^",
+    "@o3r/eslint-plugin": "workspace:^",
+    "@schematics/angular": "~15.2.0",
+    "@types/jest": "~28.1.2",
+    "@types/minimatch": "^5.1.2",
+    "@types/node": "^17.0.45",
+    "@types/pid-from-port": "^1.1.0",
+    "@types/semver": "^7.3.13",
+    "@typescript-eslint/eslint-plugin": "^5.19.0",
+    "@typescript-eslint/parser": "^5.19.0",
+    "copyfiles": "^2.4.1",
+    "cpy-cli": "^4.2.0",
+    "eslint": "^8.22.0",
+    "eslint-import-resolver-node": "^0.3.4",
+    "eslint-plugin-jest": "^26.1.4",
+    "eslint-plugin-jsdoc": "^39.3.6",
+    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "eslint-plugin-unicorn": "^45.0.2",
+    "isomorphic-fetch": "~2.2.1",
+    "jest": "~28.1.1",
+    "mem-fs": "^2.2.1",
+    "npm-run-all": "^4.1.5",
+    "nx": "~15.9.0",
+    "onchange": "^7.0.2",
+    "pid-from-port": "^1.1.3",
+    "semver": "^7.3.2",
+    "ts-jest": "^28.0.5",
+    "type-fest": "^3.6.1",
+    "typescript": "~4.9.4"
+  },
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=4",
+    "yarn": "<4.0.0"
+  },
+  "contributors": [
+    {
+      "name": "Yannick Adam",
+      "email": "yannickadam@users.noreply.github.com"
+    },
+    {
+      "name": "Kilian Panot",
+      "email": "kpanot@users.noreply.github.com"
+    },
+    {
+      "name": "Jeremy Bourgeois",
+      "email": "jbourgeois-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Pierre Henri Ginoux",
+      "email": "pginoux-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Mircea Vasile Rednic",
+      "email": "mrednic-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Stephane Dalle",
+      "email": "sdalle-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Nicolas Hoffmann",
+      "email": "nhoffmann-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Victor Scaiceanu",
+      "email": "vscaiceanu-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Florian Paul",
+      "email": "fpaul-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Corinne Paulve",
+      "email": "cpaulve-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Matthieu Crouzet",
+      "email": "matthieu-crouzet@users.noreply.github.com"
+    },
+    {
+      "name": "Salome Do",
+      "email": "sdo-1A@users.noreply.github.com"
+    }
+  ],
+  "bugs": "https://github.com/AmadeusITGroup/otter/issues",
+  "repository": "https://github.com/AmadeusITGroup/otter",
+  "license": "BSD-3-Clause"
+}

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

@@ -0,0 +1,9 @@
+import { Rule } from '@angular-devkit/schematics';
+import { NgGenerateApiExtensionSchematicsSchema } from './schema';
+/**
+ * Generate a Extension of a API core definition
+ *
+ * @param options
+ */
+export declare function ngGenerateApiExtension(options: NgGenerateApiExtensionSchematicsSchema): Rule;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../schematics/api-extension/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,IAAI,EAGL,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,sCAAsC,EAAE,MAAM,UAAU,CAAC;AAElE;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,sCAAsC,GAAG,IAAI,CAW5F"}

package/schematics/api-extension/index.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ngGenerateApiExtension = void 0;
+const schematics_1 = require("@angular-devkit/schematics");
+/**
+ * Generate a Extension of a API core definition
+ *
+ * @param options
+ */
+function ngGenerateApiExtension(options) {
+    return (tree) => (0, schematics_1.mergeWith)((0, schematics_1.apply)((0, schematics_1.url)('./templates'), [
+        (0, schematics_1.template)({
+            ...options,
+            empty: ''
+        }),
+        (0, schematics_1.move)(tree.root.path),
+        (0, schematics_1.renameTemplateFiles)()
+    ]), schematics_1.MergeStrategy.Overwrite);
+}
+exports.ngGenerateApiExtension = ngGenerateApiExtension;
+//# sourceMappingURL=index.js.map

package/schematics/api-extension/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../schematics/api-extension/index.ts"],"names":[],"mappings":";;;AAAA,2DASoC;AAGpC;;;;GAIG;AACH,SAAgB,sBAAsB,CAAC,OAA+C;IAEpF,OAAO,CAAC,IAAU,EAAE,EAAE,CAAC,IAAA,sBAAS,EAAC,IAAA,kBAAK,EAAC,IAAA,gBAAG,EAAC,aAAa,CAAC,EAAE;QACzD,IAAA,qBAAQ,EAAC;YACP,GAAG,OAAO;YACV,KAAK,EAAE,EAAE;SACV,CAAC;QACF,IAAA,iBAAI,EAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QACpB,IAAA,gCAAmB,GAAE;KACtB,CAAC,EAAE,0BAAa,CAAC,SAAS,CAAC,CAAC;AAE/B,CAAC;AAXD,wDAWC"}

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

@@ -0,0 +1,10 @@
+import { JsonObject } from '@angular-devkit/core';
+export interface NgGenerateApiExtensionSchematicsSchema extends JsonObject {
+    /** Extension Name */
+    name: string;
+    /** Type of the core API to extend */
+    coreType: 'private' | 'public';
+    /** Version of the core API to extend */
+    coreVersion: string;
+}
+//# sourceMappingURL=schema.d.ts.map

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

@@ -0,0 +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"}

package/schematics/api-extension/schema.js

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

package/schematics/api-extension/schema.js.map

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

package/schematics/api-extension/schema.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "NgGenerateApiExtensionSchematicsSchema",
+  "title": "Generate Api Extension",
+  "description": "ng generate api-extension",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Extension Name",
+      "x-prompt": "Extension Name?",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      }
+    },
+    "coreType": {
+      "type": "string",
+      "description": "Type of the core API to extend",
+      "x-prompt": "Type of the core API to extend?",
+      "enum": [
+        "private",
+        "public"
+      ]
+    },
+    "coreVersion": {
+      "type": "string",
+      "description": "Version of the core API to extend",
+      "x-prompt": "Version of the core API to extend?"
+    }
+  },
+  "additionalProperties": true,
+  "required": [
+    "name",
+    "coreType",
+    "coreVersion"
+  ]
+}

package/schematics/api-extension/templates/.gitignore.template

@@ -0,0 +1,38 @@
+# IDE project files
+.classpath
+.project
+.settings/
+dist/
+/swagger-spec/src/
+.idea
+*.iml
+
+
+# sublime text
+*.sublime-project
+*.sublime-workspace
+
+# ADK
+adkprj.json
+
+# Version control and merge
+*.orig
+
+# reports / logs / runtime generated files
+**/target
+
+# Dependency directories
+node_modules
+
+# Bundled files
+swagger-spec/src/bundles
+swagger-spec/src/main
+
+# NPM
+.npm
+package-lock.json
+
+# Logs
+logs
+*.log
+npm-debug.log*

package/schematics/api-extension/templates/.npmrc.template

@@ -0,0 +1,4 @@
+# Please contact the Otter Team to get your access to the de specific API to extend
+
+always-auth=true
+package-lock=false

package/schematics/api-extension/templates/package.json.template

@@ -0,0 +1,16 @@
+{
+  "name": "@<%= name %>-spec/<%= coreType %>",
+  "version": "0.0.0",
+  "main": "dist/API_<%= name %>_<%= coreType %>.yaml",
+  "description": "<%= name %> API",
+  "scripts": {
+    "build": "swagger-build @api-spec/core-<%= coreType %> ./src/generate.config.json -o ./dist/API_<%= name %>_<%= coreType %>.yaml -u"
+  },
+  "devDependencies": {
+    "@ama-sdk/swagger-builder": "^<%= myVersion %>",
+    "@api-spec/core-<%= coreType %>": "^<%= coreVersion %>"
+  },
+  "files": [
+    "dist/"
+  ]
+}