Add project files

Author: MichaelHilus

.gitignore

@@ -0,0 +1,2 @@
+
+node_modules/

bin/generator

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require("../index.js");

generators/modelFilesGenerator.js

@@ -0,0 +1,33 @@
+const { join } = require("path");
+const fs = require("fs");
+const fx = require('mkdir-recursive');
+const mustache = require("mustache");
+
+function modelFilesGenerator(path, apiInfo, models) {
+    fx.mkdirSync(path);
+    const template = loadTemplate();
+    models.forEach(model => modelFileGenerator(path, apiInfo, model, template))
+}
+
+function modelFileGenerator(path, apiInfo, model, template) {
+    const view = model;
+    view.apiInfo = apiInfo;
+
+    saveFile(path, template, view);
+}
+
+function loadTemplate() {
+    const path = join(__dirname, "./templates/model.mst");
+    return fs.readFileSync(path, "utf8");
+}
+
+function saveFile(path, template, view) {
+    const fileContent = mustache.render(template, view);
+    const fileName = join(path, `${view.fileName}.ts`);
+
+    fs.writeFileSync(fileName, fileContent);
+}
+
+module.exports = {
+    modelFilesGenerator
+};

generators/requestBodiesGenerator.js

@@ -0,0 +1,34 @@
+const { join } = require("path");
+const fs = require("fs");
+const fx = require('mkdir-recursive');
+const mustache = require("mustache");
+
+function requestBodiesGenerator(path, apiInfo, requestBodies) {
+    const requestBodiesPath = join(path, "/requestBodies");
+    fx.mkdirSync(requestBodiesPath);
+    const template = loadTemplate();
+    requestBodies.forEach(requestBody => requestBodyGenerator(requestBodiesPath, apiInfo, requestBody, template))
+}
+
+function requestBodyGenerator(path, apiInfo, requestBody, template) {
+    const view = requestBody;
+    view.apiInfo = apiInfo;
+
+    saveFile(path, template, view);
+}
+
+function loadTemplate() {
+    const path = join(__dirname, "./templates/requestBody.mst");
+    return fs.readFileSync(path, "utf8");
+}
+
+function saveFile(path, template, view) {
+    const fileContent = mustache.render(template, view);
+    const fileName = join(path, `${view.fileName}.ts`);
+
+    fs.writeFileSync(fileName, fileContent);
+}
+
+module.exports = {
+    requestBodiesGenerator
+};

generators/serviceFilesGenerator.js

@@ -0,0 +1,37 @@
+const { join } = require("path");
+const fs = require("fs");
+const fx = require('mkdir-recursive');
+const mustache = require("mustache");
+
+function serviceFilesGenerator(paths, apiInfo, services) {
+    fx.mkdirSync(paths.services);
+    const classTemplate = loadTemplate("service");
+    const interfaceTemplate = loadTemplate("serviceInterface");
+    services.forEach(service => serviceFileGenerator(paths, apiInfo, service, classTemplate, interfaceTemplate))
+}
+
+function serviceFileGenerator(paths, apiInfo, service, classTemplate, interfaceTemplate) {
+    const view = service;
+    view.apiInfo = apiInfo;
+    view.relativeModelsPath = paths.relativeModels;
+    view.relativeServiceBasePath = paths.relativeServiceBase;
+
+    saveFile(paths, `${view.fileName}.ts`, classTemplate, view);
+    saveFile(paths, `${view.fileName}.interface.ts`, interfaceTemplate, view);
+}
+
+function loadTemplate(name) {
+    const path = join(__dirname, `./templates/${name}.mst`);
+    return fs.readFileSync(path, "utf8");
+}
+
+function saveFile(paths, fileName, template, view) {
+    const fileContent = mustache.render(template, view);
+    fileName = join(paths.services, fileName);
+
+    fs.writeFileSync(fileName, fileContent);
+}
+
+module.exports = {
+    serviceFilesGenerator
+};

generators/templates/model.mst

@@ -0,0 +1,54 @@
+/**
+ * {{apiInfo.name}} {{apiInfo.version.api}} (OpenAPI: {{apiInfo.version.openApi}})
+ * {{{apiInfo.description}}}
+ *
+ * NOTE: This class is auto generated by instage-client-api-generator.
+ * Do not edit the file manually.
+ */
+
+{{#hasUsedTypes}}
+{{#usedTypes}}
+import { {{name}} } from "./{{fileName}}";
+{{/usedTypes}}
+
+{{/hasUsedTypes}}
+{{#description}}
+/**
+ * {{.}}
+ */
+ {{/description}}
+export class {{name}}{{#supertype}} extends {{name}}{{/supertype}} {
+
+    /**
+     * Creates a {{name}}.
+     *
+{{#supertype}}
+{{#properties}}
+     * @param {{=<% %>=}}{<%type%>}<%={{ }}=%> {{name}} {{description}}
+{{/properties}}
+{{/supertype}}
+{{#properties}}
+     * @param {{=<% %>=}}{<%type%>}<%={{ }}=%> {{name}} {{description}}
+{{/properties}}
+     */
+    constructor({{#supertype}}{{#properties}}{{name}}: {{type}}{{#typeIsArray}}[]{{/typeIsArray}}, {{/properties}}{{/supertype}}{{#properties}}{{name}}: {{type}}{{#typeIsArray}}[]{{/typeIsArray}}{{^isLast}}, {{/isLast}}{{/properties}}) {
+{{#supertype}}
+        super({{#properties}}{{name}}{{^isLast}}, {{/isLast}}{{/properties}});
+{{/supertype}}
+{{#properties}}
+        this.{{name}} = {{name}};
+{{/properties}}
+    }
+
+    {{#properties}}
+    {{#description}}
+    /**
+     * {{.}}
+     */
+    {{/description}}
+    public {{name}}: {{type}}{{#typeIsArray}}[]{{/typeIsArray}};
+{{^isLast}}
+
+{{/isLast}}
+    {{/properties}}
+}

generators/templates/requestBody.mst

@@ -0,0 +1,11 @@
+/**
+ * {{apiInfo.name}} {{apiInfo.version.api}} (OpenAPI: {{apiInfo.version.openApi}})
+ * {{{apiInfo.description}}}
+ *
+ * NOTE: This class is auto generated by instage-client-api-generator.
+ * Do not edit the file manually.
+ */
+
+ import { {{type}} } from "../{{typeFileName}}";
+
+ export type {{name}} = {{type}}{{#isArray}}[]{{/isArray}};

generators/templates/service.mst

@@ -0,0 +1,75 @@
+/**
+ * {{apiInfo.name}} {{apiInfo.version.api}} (OpenAPI: {{apiInfo.version.openApi}})
+ * {{{apiInfo.description}}}
+ *
+ * NOTE: This class is auto generated by instage-client-api-generator.
+ * Do not edit the file manually.
+ */
+
+import axios from "axios";
+
+import { ServiceBase } from "{{{relativeServiceBasePath}}}/serviceBase";
+import { I{{name}} } from "./{{fileName}}.interface";
+
+{{#usedTypes}}
+import { {{name}} } from "{{{relativeModelsPath}}}/{{{fileName}}}";
+{{/usedTypes}}
+{{#usedRequestBodies}}
+import { {{name}} as {{name}}RequestBody } from "{{{relativeModelsPath}}}/requestBodies/{{{fileName}}}";
+{{/usedRequestBodies}}
+
+export class {{name}} extends ServiceBase implements I{{name}} {
+{{#endpoints}}
+    /**
+{{#description}}
+     * {{{.}}}
+     *
+{{/description}}
+{{#parameters}}
+     * @param {{=<% %>=}}{<%type%><%#isBody%>RequestBody<%/isBody%>}<%={{ }}=%> {{^required}}[{{/required}}{{name}}{{^required}}]{{/required}} {{{description}}}
+{{/parameters}}
+     */
+    public async {{name}}({{#parameters}}{{name}}{{^required}}?{{/required}}: {{type}}{{#isBody}}RequestBody{{/isBody}}{{^isLastParam}}, {{/isLastParam}}{{/parameters}}): Promise<{{returnType}}> {
+        const config = this.getAxiosConfiguration();
+
+{{#hasQueryParameters}}
+        const queryList: string[] = [];
+{{#queryParameters}}
+        if ({{name}} !== undefined) {
+            queryList.push(`{{name}}=${{=<% %>=}}{<%name%>}<%={{ }}=%>`);
+        }
+{{/queryParameters}}
+        const query = `?${queryList.join("&")}`;
+
+{{/hasQueryParameters}}
+        const response = await axios.{{#isGet}}get{{/isGet}}{{#isPost}}post{{/isPost}}{{#isPut}}put{{/isPut}}{{#isDelete}}delete{{/isDelete}}<{{returnType}}>(`{{{path}}}{{#hasQueryParameters}}${query}{{/hasQueryParameters}}`,{{#body}} body,{{/body}} config);
+{{^returnTypeIsArray}}
+
+{{#subReturnTypes}}
+        if (response.data.discriminator === "{{name}}") {
+            const data = response.data as {{name}};
+            return new {{name}}({{#supertype}}{{#properties}}data.{{name}}, {{/properties}}{{/supertype}}{{#properties}}data.{{name}}{{^isLast}}, {{/isLast}}{{/properties}});
+        }
+{{/subReturnTypes}}
+
+{{/returnTypeIsArray}}
+{{#returnTypeIsArray}}
+
+        response.data = response.data.map(item => {
+{{#subReturnTypes}}
+            if (item.discriminator === "{{name}}") {
+                const data = item as {{name}};
+                return new {{name}}({{#supertype}}{{#properties}}data.{{name}}, {{/properties}}{{/supertype}}{{#properties}}data.{{name}}{{^isLast}}, {{/isLast}}{{/properties}});
+            }
+{{/subReturnTypes}}
+            return item;
+        });
+
+{{/returnTypeIsArray}}
+        return response.data;
+    }
+{{^isLast}}
+
+{{/isLast}}
+{{/endpoints}}
+}

generators/templates/serviceInterface.mst

@@ -0,0 +1,32 @@
+/**
+ * {{apiInfo.name}} {{apiInfo.version.api}} (OpenAPI: {{apiInfo.version.openApi}})
+ * {{{apiInfo.description}}}
+ *
+ * NOTE: This class is auto generated by instage-client-api-generator.
+ * Do not edit the file manually.
+ */
+
+{{#usedTypes}}
+import { {{name}} } from "{{{relativeModelsPath}}}/{{{fileName}}}";
+{{/usedTypes}}
+{{#usedRequestBodies}}
+import { {{name}} as {{name}}RequestBody } from "{{{relativeModelsPath}}}/requestBodies/{{{fileName}}}";
+{{/usedRequestBodies}}
+
+export interface I{{name}} {
+    {{#endpoints}}
+    /**
+{{#description}}
+     * {{{.}}}
+     *
+{{/description}}
+{{#parameters}}
+     * @param {{=<% %>=}}{<%type%><%#isBody%>RequestBody<%/isBody%>}<%={{ }}=%> {{^required}}[{{/required}}{{name}}{{^required}}]{{/required}} {{{description}}}
+{{/parameters}}
+     */
+    {{name}}({{#parameters}}{{name}}{{^required}}?{{/required}}: {{type}}{{#isBody}}RequestBody{{/isBody}}{{^isLastParam}}, {{/isLastParam}}{{/parameters}}): Promise<{{returnType}}>
+{{^isLast}}
+
+{{/isLast}}
+    {{/endpoints}}
+}

index.js

@@ -0,0 +1,55 @@
+const { createPaths } = require("./pathCreator");
+
+const { configFileLoader } = require("./loaders/configFileLoader");
+const { apiInfoLoader } = require("./loaders/apiInfoLoader");
+const { modelsLoader } = require("./loaders/modelsLoader");
+const { requestBodiesLoader } = require("./loaders/requestBodiesLoader");
+const { servicesLoader } = require("./loaders/servicesLoader");
+
+const { modelFilesGenerator } = require("./generators/modelFilesGenerator");
+const { requestBodiesGenerator } = require("./generators/requestBodiesGenerator");
+const { serviceFilesGenerator } = require("./generators/serviceFilesGenerator");
+
+const args = process.argv.slice(2);
+const errorMessage = "Too few arguments. Specify openapi config file with -c <path>, path of service base class location with -cb <path>, path of service generation destination with -s <path>, path of models generation destination with -m <path> and path of server models location with -sm <path>.";
+if (!args || !args[1] || !args[3] || !args[5] || !args[7] || !args[9]) {
+    console.log(errorMessage);
+    return;
+}
+
+async function generate() {
+    console.log("InStage client api generator");
+    const paths = createPaths(args[1], args[3], args[5], args[7], args[9]);
+    
+    console.log("Loading config file...");
+    const config = await configFileLoader(paths.configFile, paths.serverModels);
+    console.log("Config file loaded.");
+    
+    console.log("Loading api info...");
+    const apiInfo = apiInfoLoader(config);
+    console.log("Done.");
+    
+    console.log("Loading models...");
+    const models = modelsLoader(config);
+    console.log(`Loaded ${models.length} models.`);
+
+    console.log("Generating model files...");
+    modelFilesGenerator(paths.models, apiInfo, models);
+    console.log(`Generated ${models.length} model files.`);
+
+    console.log("Loading request bodies...");
+    const requestBodies = requestBodiesLoader(config);
+    console.log(`Loaded ${requestBodies.length} request bodies.`);
+    
+    console.log("Generating request body files...");
+    requestBodiesGenerator(paths.models, apiInfo, requestBodies);
+    console.log(`Generated ${requestBodies.length} request body files.`);
+    
+    const services = servicesLoader(config, models, requestBodies);
+    serviceFilesGenerator(paths, apiInfo, services);
+    
+    console.log(`Generated ${services.length} services.`);
+}
+
+generate();
+