Merge pull request #167 from sebgroup/develop

New release with new OpenAPI generator type for Angular

Author: yousifalraheem

package-lock.json

@@ -42,7 +42,7 @@
         "moment": "^2.24.0"
     },
     "devDependencies": {
-        "@commitlint/cli": "^8.3.5",
+        "@commitlint/cli": "^9.0.1",
         "@commitlint/config-conventional": "^8.3.4",
         "@semantic-release/changelog": "^5.0.1",
         "@types/jest": "^26.0.0",

package.json

@@ -1,4 +1,4 @@
-export type OpenApiGenerator = ClientSideGenerator | ServerSideGenerator | DocumentationGenerator | SchemaGenerator | ConfigGenerator;
+export type OpenApiGenerator = ClientSideGenerator | ServerSideGenerator | DocumentationGenerator | SchemaGenerator | ConfigGenerator | SEBGenerator;
 
 export type ClientSideGenerator = "ada" | "android" | "apex" | "bash" | "c" |
                                   "clojure" | "cpp-qt5-client" | "cpp-restsdk" | "cpp-tizen" | "csharp" |
@@ -28,4 +28,19 @@ export type DocumentationGenerator = "asciidoc" | "cwiki" | "dynamic-html" | "ht
 
 export type SchemaGenerator = "avro-schema" | "mysql-schema";
 
-export type ConfigGenerator = "apache2" | "graphql-schema" | "protobuf-schema";
+export type ConfigGenerator = "apache2" | "graphql-schema" | "protobuf-schema";
+
+export type SEBGenerator = "ts-angular";
+
+/**
+ * check if generator is custom seb generator
+ * @param generator generator set
+ */
+export function isSEBGenerator(generator: OpenApiGenerator){
+    switch (generator) {
+        case "ts-angular":
+            return true;
+        default:
+            return false;
+    }
+}

src/openapiGenerator/generatorList.ts

@@ -24,12 +24,13 @@ import {
 import {
     CustomOptions,
     CustomOptionType,
-    CustomOptionName,
     CustomTemplates,
     SEBTemplate,
     CustomOptionsArgumentType,
+    customGeneratorMapper,
+    CustomGeneratorMapper
 } from "./options/customOptions";
-import { OpenApiGenerator } from "./generatorList";
+import { OpenApiGenerator, isSEBGenerator } from "./generatorList";
 import { generateMock } from "./mockGenerator/mockGenerator";
 import { join } from "path";
 
@@ -42,6 +43,7 @@ type GeneratorArgs = (BatchArgumentType | ConfigHelpArgumentType | GenerateArgum
 };
 
 const minimist = require("minimist");
+const dargs = require("dargs");
 
 export function generatorFn() {
     const program: commander.Command = createCommand();
@@ -89,8 +91,8 @@ export function generatorFn() {
 
             if (generateArgs.p || generateArgs["additional-properties"]) {
                 const additionalProps: keyof GenerateArgumentType = !!generateArgs.p ? "p" : "additional-properties";
-                args[additionalProps] =
-                    args[additionalProps] + `,${extraOptions.toString()}`;
+                const formattedAdditionalProps: string = removeExtraOption(args[additionalProps]);
+                args[additionalProps] = `${formattedAdditionalProps}${formattedAdditionalProps.length ? ", " : ""}${extraOptions.toString()}`;
             } else {
                 (args as GenerateArgumentType).p = extraOptions.toString();
             }
@@ -107,6 +109,12 @@ export function generatorFn() {
                 // generate mock
                 generateMock((generateArgs.i || generateArgs["input-spec"]), outputDir);
             }
+            if (isSEBGenerator(generatorName)) {
+                const relativeGenerator: OpenApiGenerator = customGeneratorMapper.find(({ generator }: CustomGeneratorMapper) => generatorName === generator)?.relativeGenerator;
+                if (relativeGenerator) {
+                    (args as GenerateArgumentType)[(args as GenerateArgumentType).g ? "g" : "generator-name"] = relativeGenerator;
+                }
+            }
         }
         CustomOptions.filter(({ option }: CustomOptionType) => !!option).map((item: CustomOptionType) => {
             const customOption: CustomOptionsArgumentType = minimist(item.option);
@@ -115,10 +123,11 @@ export function generatorFn() {
                 delete args[selectedKey];
             }
         });
-        const revertArgs: Array<string> = require("dargs")(args, { excludes: ["_"] });
+        const revertArgs: Array<string> = dargs(args, { excludes: ["_"] });
         if (revertArgs) {
             command += ` ${revertArgs.join(" ")}`;
         }
+        console.log(command);
         process.env[
             "JAVA_OPTS"
         ] = `-Dio.swagger.parser.util.RemoteUrl.trustAll=true -Dio.swagger.v3.parser.util.RemoteUrl.trustAll=true`;
@@ -131,6 +140,24 @@ export function generatorFn() {
     program.parse(process.argv);
 }
 
+/**
+ * remove extra option
+ * @param addtionalProperties additional properties
+ */
+function removeExtraOption(addtionalProperties: string): string {
+    const additionalArgs: Array<string> = addtionalProperties.split(",");
+    let newAdditionalArgs: string = "";
+    additionalArgs.map((argument: string) => {
+        const keys: Array<string> = argument.split("=");
+        const keyName: string = keys[0];
+        const relatedOption: CustomOptionType = CustomOptions.find((option: CustomOptionType) => !!option.mappingName && option.mappingName === keyName);
+        if (keys[1] !== "false" || !relatedOption?.removeOnFalse) {
+            newAdditionalArgs = argument;
+        }
+    })
+    return newAdditionalArgs;
+}
+
 /**
  * format extra options into array to append to -p
  * @param args arguments

src/openapiGenerator/openapiGenerator.ts

@@ -1,6 +1,5 @@
 import { OptionType } from "./option.type";
-import { OpenApiGenerator } from "../generatorList";
-import { GenerateOptionName } from "./generateOptions";
+import { OpenApiGenerator, SEBGenerator } from "../generatorList";
 
 export interface CustomOptionType extends OptionType {
     mappingName?: string;
@@ -9,6 +8,11 @@ export interface CustomOptionType extends OptionType {
     noValue?: boolean;
     defaultValue?: string;
     additionalProp?: boolean;
+    removeOnFalse?: boolean;
+}
+
+export interface AdditionalProps {
+    withSeparateModelsAndApi?: boolean;
 }
 
 export interface SEBTemplate {
@@ -77,7 +81,8 @@ const options: Array<CustomOptionType> = [
         description: "separate models and apis",
         mappingName: "withSeparateModelsAndApi",
         defaultValue: "true",
-        additionalProp: true
+        additionalProp: true,
+        removeOnFalse: true
     },
     {
         option: null,
@@ -95,6 +100,19 @@ const options: Array<CustomOptionType> = [
     }
 ];
 
+
+export interface CustomGeneratorMapper {
+    generator: SEBGenerator;
+    relativeGenerator: OpenApiGenerator;
+}
+
+const customGeneratorMapper: Array<CustomGeneratorMapper> = [
+    {
+        generator: "ts-angular",
+        relativeGenerator: "typescript-axios"
+    }
+];
+
 const templates: Array<SEBTemplate> = [
     {
         generator: "typescript-axios",
@@ -103,7 +121,11 @@ const templates: Array<SEBTemplate> = [
     {
         generator: "typescript-angular",
         templatePath: "./node_modules/@sebgroup/frontend-tools/dist/openapiGenerator/templates/typescript-angular"
+    },
+    {
+        generator: "ts-angular",
+        templatePath: "./node_modules/@sebgroup/frontend-tools/dist/openapiGenerator/templates/ts-angular"
     }
 ]
 
-export { options as CustomOptions, OptionName as CustomOptionName, templates as CustomTemplates };
+export { options as CustomOptions, OptionName as CustomOptionName, templates as CustomTemplates, customGeneratorMapper };

src/openapiGenerator/options/customOptions.ts

@@ -295,6 +295,6 @@ const defaultOptions: Array<DefaultOptionType> = [
         key: [OptionName.outputShort, OptionName.output],
         value: "./src/apis"
     }
-]
+];
 
 export { options as GenerateOptions, defaultOptions as GenerateDefaultOptions, OptionName as GenerateOptionName,  GenerateArgumentType };

src/openapiGenerator/options/generateOptions.ts

@@ -0,0 +1,23 @@
+// tslint:disable
+{{>licenseInfo}}
+
+{{^withSeparateModelsAndApi}}
+import * as globalImportUrl from 'url';
+import { Configuration } from './configuration';
+import { Observable } from "rxjs";
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { APIModel, APIModelOptions, AttributeMapItem, HttpOptions, APIHandler, APIURLTypes, ApiKeyAuth, OAuth } from "./base";
+
+{{#models}}
+{{#model}}{{#isEnum}}{{>modelEnum}}{{/isEnum}}{{#oneOf}}{{#-first}}{{>modelOneOf}}{{/-first}}{{/oneOf}}{{^isEnum}}{{^oneOf}}{{>modelGeneric}}{{/oneOf}}{{/isEnum}}{{/model}}
+{{/models}}
+{{#apiInfo}}{{#apis}}
+{{>apiInner}}
+{{/apis}}{{/apiInfo}}
+{{/withSeparateModelsAndApi}}
+
+{{#withSeparateModelsAndApi}}
+{{#apiInfo}}{{#apis}}{{#operations}}export * from './{{tsApiPackage}}/{{classFilename}}';
+{{/operations}}{{/apis}}{{/apiInfo}}
+{{/withSeparateModelsAndApi}}

src/openapiGenerator/templates/ts-angular/api.mustache

@@ -0,0 +1,107 @@
+{{#withSeparateModelsAndApi}}
+// tslint:disable
+import { Observable } from "rxjs";
+import { APIHandler, APIURLTypes, HttpOptions{{#operations}}{{#operation}}{{#-first}}{{#authMethods}}{{#isBasic}}, HttpBasicAuth{{/isBasic}}{{#isApiKey}}, ApiKeyAuth{{/isApiKey}}{{#isBasicBearer}}, OAuth{{/isBasicBearer}}{{#isOAuth}}, OAuth{{/isOAuth}}{{/authMethods}}{{/-first}}{{/operation}}{{/operations}} } from "{{apiRelativeToRoot}}base";
+import { {{#imports}}{{classname}}{{^-last}}, {{/-last}}{{/imports}} } from "{{apiRelativeToRoot}}{{tsModelPackage}}";
+{{/withSeparateModelsAndApi}}
+
+{{#operations}}
+export class {{classname}} extends APIHandler {
+    static urls: APIURLTypes.{{classname}} = {
+        {{#operation}}{{nickname}}: "{{path}}"{{#hasMore}},
+        {{/hasMore}}{{/operation}}
+    };
+    
+    constructor() {
+        super("{{classname}}");{{#operation}}{{#-first}}{{#authMethods}}
+        this.authentications.push({{#isBasic}}new HttpBasicAuth(){{/isBasic}}{{#isApiKey}}new ApiKeyAuth({{#isKeyInHeader}}'header', {{/isKeyInHeader}}{{^isKeyInHeader}}'query', {{/isKeyInHeader}}'{{keyParamName}}'){{/isApiKey}}{{#isBasicBearer}}new OAuth(){{/isBasicBearer}}{{#isOAuth}}new OAuth(){{/isOAuth}});{{/authMethods}}{{/-first}}{{/operation}}
+    }
+    
+{{#operation}}
+    {{#-first}}
+    {{#authMethods}}
+    // authentication {{name}} required
+    {{#isApiKey}}
+    private _apiKey: string;
+    get apiKey() {
+        return this._apiKey;
+    }
+    {{#isKeyInHeader}}
+    set apiKey(key: string | Function) {
+        const localApiKey: string = typeof key === 'function'
+            ? key("{{keyParamName}}")
+            : key;
+        this._apiKey = localApiKey;
+    }
+    {{/isKeyInHeader}}
+    {{#isKeyInQuery}}
+    set apiKey(key: string | Function) {
+        const localApiKey: string = typeof key === 'function'
+            ? key("{{keyParamName}}")
+            : key;
+        this._apiKey = localApiKey;
+    }
+    {{/isKeyInQuery}}
+    {{/isApiKey}}
+    {{#isBasicBasic}}
+    private _username: string;
+    get username() {
+        return this._username;
+    }
+    set username(username: string) {
+        this._username = username;
+    }
+    private _password: string;
+    get password() {
+        return this._password;
+    }
+    set password(password: string) {
+        this._password = password;
+    }
+    {{/isBasicBasic}}
+    {{#isBasicBearer}}
+    private _accessToken: string;
+    get accessToken() {
+        return this._accessToken;
+    }
+    // http bearer authentication required
+    set accessToken(accessToken: string | Function) {
+        const bearerToken: string = typeof accessToken === 'function'
+            ? accessToken()
+            : accessToken;
+        this._accessToken = bearerToken;
+    }
+    {{/isBasicBearer}}
+    {{#isOAuth}}
+    private _accessToken: string;
+    get accessToken() {
+        return this._accessToken;
+    }
+    set accessToken(token: string) {
+        this._accessToken = token;
+    }
+    {{/isOAuth}}
+    {{/authMethods}}
+    {{/-first}}
+    /**{{#summary}}
+     * {{summary}}{{/summary}}{{#notes}}
+     * {{notes}}{{/notes}}{{#allParams}}
+     * @param {{paramName}} {{description}}{{/allParams}}
+     */
+    public {{nickname}}(params: {
+        {{#allParams}}{{paramName}}{{^required}}?{{/required}}: {{^isPrimitiveType}}{{^isFile}}{{/isFile}}{{/isPrimitiveType}}{{{dataType}}};{{#hasMore}}
+        {{/hasMore}}{{/allParams}}
+    }{{^hasRequiredParams}} = {}{{/hasRequiredParams}}, options?: HttpOptions): Observable<{{#imports}}{{#.}}{{.}}{{^-last}} | {{/-last}}{{/.}}{{/imports}}> {
+        const acceptTypes: Array<string> = [{{#produces}}"{{mediaType}}"{{#hasMore}}, {{/hasMore}}{{/produces}}];
+        this.initAuth({{#hasAuthMethods}}{{#cookieAuth}}false{{/cookieAuth}}{{#authMethods}}true, {{#isApiKey}}{{#isKeyInHeader}}{ token: this.apiKey as string, contentTypes: acceptTypes, key: "Authentication" }{{/isKeyInHeader}}{{/isApiKey}}{{#isBasicBasic}}{ username: this.username, password: this.password, key: "Basic" }{{/isBasicBasic}}{{#isBasicBearer}}{ token: this.accessToken, contentTypes: acceptTypes, key: "Authentication" } {{/isBasicBearer}}{{#isOAuth}}{ token: this.accessToken, contentTypes: acceptTypes, key: "Authentication" }{{/isOAuth}}{{/authMethods}}{{/hasAuthMethods}}{{^hasAuthMethods}}false{{/hasAuthMethods}});
+        const apiURL: string = this.initAPIURL({{classname}}.urls.{{nickname}}{{#hasPathParams}}, { {{/hasPathParams}}{{#pathParams}}{{baseName}}: params.{{paramName}}{{#hasMore}}, {{/hasMore}}{{/pathParams}}{{#hasPathParams}} } {{/hasPathParams}}{{^pathParams}}, null{{/pathParams}});
+        options = this.initOptions(options, { {{#queryParams}}{{paramName}}: params.{{paramName}}{{#hasMore}}, {{/hasMore}}{{/queryParams}} }, { {{#headerParams}}{{paramName}}: params.{{paramName}}{{#hasMore}}, {{/hasMore}}{{/headerParams}} });{{#formParams}}{{#isFile}}
+        const formData: FormData = new FormData();
+        formData.append("file", params.{{paramName}} as any);{{/isFile}}{{/formParams}}
+        const body: any = {{#formParams}}{{#-first}}{ {{/-first}}{{#isFile}}formData{{/isFile}}{{^isFile}}{{paramName}}: params.{{paramName}}{{/isFile}}{{#-last}} }{{/-last}}{{^-last}}, {{/-last}}{{/formParams}}{{^formParams}}{{#bodyParam}}params.{{paramName}}{{/bodyParam}}{{/formParams}}{{^formParams}}{{^bodyParam}}null{{/bodyParam}}{{/formParams}};
+        return this.makeCall<{{#imports}}{{#.}}{{.}}{{^-last}} | {{/-last}}{{/.}}{{/imports}}>("{{httpMethod}}".toLowerCase(), apiURL, options, body);
+    }
+
+{{/operation}}
+}
+{{/operations}}