Release 6.1.0

CHANGELOG.md

@@ -1,5 +1,12 @@
 # next release  
 
+Features:  
+- `--silent` option. Output only errors to console (default: false)  
+
+Fixes:  
+- Bug with `kebab-case` path params (issue #184, thanks @Mr-sgreen)  
+- Typings for `--js` option  
+
 # 6.0.0  
 
 BREAKING_CHANGES:  

README.md

@@ -57,6 +57,7 @@ Options:
   --clean-output                clean output folder before generate api. WARNING: May cause data loss (default: false)
   --axios                       generate axios http client (default: false)
   --single-http-client          Ability to send HttpClient instance to Api constructor (default: false)
+  --silent                      Output only errors to console (default: false)
   --default-response <type>     default type for empty response schema (default: "void")
   -h, --help                    display help for command
 ```

index.js

@@ -64,6 +64,7 @@ program
   .option("--disableStrictSSL", "disabled strict SSL", false)
   .option("--axios", "generate axios http client", false)
   .option("--single-http-client", "Ability to send HttpClient instance to Api constructor", false)
+  .option("--silent", "Output only errors to console", false)
   .option("--default-response <type>", "default type for empty response schema", TS_KEYWORDS.VOID)
   .option(
     "--clean-output",
@@ -93,6 +94,7 @@ const {
   defaultResponse,
   singleHttpClient,
   axios,
+  silent,
 } = program;
 
 generateApi({
@@ -116,4 +118,5 @@ generateApi({
   disableStrictSSL: !!disableStrictSSL,
   singleHttpClient: !!singleHttpClient,
   cleanOutput: !!cleanOutput,
+  silent: !!silent,
 });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "description": "Create typescript api module from swagger schema",
   "scripts": {
     "cli:json": "node index.js -r -d -p ./swagger-test-cli.json -n swagger-test-cli.ts --extract-request-params --enum-names-as-values",
@@ -30,6 +30,7 @@
     "test:--enum-names-as-values": "node tests/spec/enumNamesAsValues/test.js",
     "test:--default-response": "node tests/spec/defaultResponse/test.js",
     "test:--js": "node tests/spec/js/test.js",
+    "test:--js--axios": "node tests/spec/jsAxios/test.js",
     "test:--axios": "node tests/spec/axios/test.js",
     "test:partialBaseTemplate": "node tests/spec/partialBaseTemplate/test.js",
     "test:partialDefaultTemplate": "node tests/spec/partialDefaultTemplate/test.js"

src/config.js

@@ -64,6 +64,8 @@ const config = {
   },
   /** Record<templateName, templateContent> */
   templatesToRender: {},
+  toJS: false,
+  silent: false,
 };
 
 /** needs to use data everywhere in project */

src/index.js

@@ -26,7 +26,7 @@ module.exports = {
     url,
     spec,
     name: fileName,
-    toJS: translateToJavaScript,
+    toJS: translateToJavaScript = config.toJS,
     modular,
     templates,
     generateResponses = config.generateResponses,
@@ -45,6 +45,7 @@ module.exports = {
     enumNamesAsValues,
     disableStrictSSL = config.disableStrictSSL,
     cleanOutput,
+    silent = config.silent,
   }) =>
     new Promise((resolve, reject) => {
       addToConfig({
@@ -66,6 +67,8 @@ module.exports = {
         defaultResponseType,
         singleHttpClient,
         constants,
+        silent,
+        toJS: translateToJavaScript,
       });
       (spec ? convertSwaggerObject(spec) : getSwaggerObject(input, url, disableStrictSSL))
         .then(({ usageSchema, originalSchema }) => {
@@ -75,7 +78,7 @@ module.exports = {
 
           const templatesToRender = getTemplates(config);
 
-          console.log("☄️  start generating your typescript api");
+          if (!config.silent) console.log("☄️  start generating your typescript api");
 
           fixSwaggerScheme(usageSchema, originalSchema);
 
@@ -148,10 +151,12 @@ module.exports = {
             if (translateToJavaScript) {
               createFile(output, file.name, file.content);
               createFile(output, file.declaration.name, file.declaration.content);
-              console.log(`✔️  your javascript api file created in "${output}"`);
+              if (!config.silent)
+                console.log(`✔️  your javascript api file created in "${output}"`);
             } else {
               createFile(output, file.name, file.content);
-              console.log(`✔️  your typescript api file created in "${output}"`);
+              if (!config.silent)
+                console.log(`✔️  your typescript api file created in "${output}"`);
             }
 
             return file;

src/modelNames.js

@@ -1,12 +1,13 @@
 const _ = require("lodash");
+const { config } = require("./config");
 
 const isValidName = (name) => /^([A-Za-z$_]{1,})$/g.test(name);
 
 const formattedModelNamesMap = new Map();
 
 const checkAndRenameModelName = (name) => {
   if (typeof name !== "string") {
-    console.warn("🔨 wrong name of the model name", name);
+    if (!config.silent) console.warn("🔨 wrong name of the model name", name, config.silent);
 
     return name;
   }

src/routeNames.js

@@ -22,12 +22,13 @@ const getRouteName = (routeInfo) => {
       duplicateIdentifier,
       routeNameDuplicatesMap.get(duplicateIdentifier) + 1,
     );
-    console.warn(
-      `🥵  Module "${moduleName}" already have method "${routeName}()"`,
-      `\n🥵  This method has been renamed to "${
-        routeName + routeNameDuplicatesMap.get(duplicateIdentifier)
-      }()" to solve conflict names.`,
-    );
+    if (!config.silent)
+      console.warn(
+        `🥵  Module "${moduleName}" already have method "${routeName}()"`,
+        `\n🥵  This method has been renamed to "${
+          routeName + routeNameDuplicatesMap.get(duplicateIdentifier)
+        }()" to solve conflict names.`,
+      );
   } else {
     routeNameDuplicatesMap.set(duplicateIdentifier, 1);
   }

src/routes.js

@@ -132,14 +132,14 @@ const parseRoute = (route) => {
       if (!paramName) return pathParams;
 
       if (_.includes(paramName, "-")) {
-        console.warn("🔨 wrong path param name", paramName);
+        if (!config.silent) console.warn("🔨 wrong path param name", paramName);
       }
 
       return [
         ...pathParams,
         {
           $match: match,
-          name: paramName,
+          name: _.camelCase(paramName),
           required: true,
           type: "string",
           description: "",
@@ -162,6 +162,7 @@ const parseRoute = (route) => {
   );
 
   return {
+    originalRoute: route || "",
     route: fixedRoute,
     pathParams,
   };
@@ -206,6 +207,10 @@ const getRouteParams = (routeInfo, pathParams) => {
       };
     }
 
+    if (routeParam.in === "path" && routeParam.name) {
+      routeParam.name = _.camelCase(routeParam.name);
+    }
+
     if (routeParam) {
       routeParams[routeParam.in].push(routeParam);
     }

src/swagger.js

@@ -3,7 +3,7 @@ const yaml = require("js-yaml");
 const axios = require("axios");
 const converter = require("swagger2openapi");
 const https = require("https");
-const { addToConfig } = require("./config");
+const { addToConfig, config } = require("./config");
 const { pathIsExist, getFileContent } = require("./files");
 
 const parseSwaggerFile = (file) => {
@@ -19,10 +19,10 @@ const parseSwaggerFile = (file) => {
 const getSwaggerFile = (pathToSwagger, urlToSwagger, disableStrictSSL) =>
   new Promise((resolve) => {
     if (pathIsExist(pathToSwagger)) {
-      console.log(`✨ try to get swagger by path "${pathToSwagger}"`);
+      if (!config.silent) console.log(`✨ try to get swagger by path "${pathToSwagger}"`);
       resolve(getFileContent(pathToSwagger));
     } else {
-      console.log(`✨ try to get swagger by url "${urlToSwagger}"`);
+      if (!config.silent) console.log(`✨ try to get swagger by url "${urlToSwagger}"`);
       let agent = undefined;
       if (disableStrictSSL) {
         agent = new https.Agent({

src/templates.js

@@ -1,7 +1,7 @@
 const _ = require("lodash");
 const Eta = require("eta");
 const { getFileContent, pathIsExist } = require("./files");
-const { config, addToConfig } = require("./config");
+const { config } = require("./config");
 const { resolve } = require("path");
 
 /**
@@ -38,7 +38,8 @@ const getTemplatePaths = ({ templates, modular }) => {
 };
 
 const getTemplates = ({ templatePaths }) => {
-  console.log(`✨ try to read templates from directory "${templatePaths.custom}"`);
+  if (!config.silent)
+    console.log(`✨ try to read templates from directory "${templatePaths.custom}"`);
 
   const templatesMap = _.reduce(
     TEMPLATE_INFOS,
@@ -53,10 +54,11 @@ const getTemplates = ({ templatePaths }) => {
         if (pathIsExist(baseFullPath)) {
           fileContent = getFileContent(baseFullPath);
         } else {
-          console.log(
-            `❗❗❗ ${_.lowerCase(name)} template not found in ${customFullPath}\n` +
-              `Code generator will use the default template`,
-          );
+          if (!config.silent)
+            console.log(
+              `❗❗❗ ${_.lowerCase(name)} template not found in ${customFullPath}\n` +
+                `Code generator will use the default template`,
+            );
         }
 
         if (pathIsExist(originalFullPath)) {

templates/default/api.eta

@@ -13,7 +13,7 @@ const descriptionLines = _.compact([
 ]);
 
 %>
-<% if (config.httpClientType === config.constants.HTTP_CLIENT.AXIOS) { %> import { AxiosRequestConfig } from "axios"; <% } %>
+<% if (config.httpClientType === config.constants.HTTP_CLIENT.AXIOS) { %> import { AxiosRequestConfig, AxiosResponse } from "axios"; <% } %>
 <% if (descriptionLines.length) { %>
 /**
 <% descriptionLines.forEach((descriptionLine) => { %>

templates/default/procedure-call.eta

@@ -60,6 +60,19 @@ const bodyContentKindTmpl = requestContentKind[requestBodyInfo.contentKind] || n
 const responseFormatTmpl = responseContentKind[responseBodyInfo.success && responseBodyInfo.success.schema && responseBodyInfo.success.schema.contentKind] || null;
 const securityTmpl = security ? 'true' : null;
 
+const describeReturnType = () => {
+    if (!config.toJS) return "";
+
+    switch(config.httpClientType) {
+        case config.constants.HTTP_CLIENT.AXIOS: {
+          return `Promise<AxiosResponse<${type}>>`
+        }
+        default: {
+          return `Promise<HttpResponse<${type}, ${errorType}>`
+        }
+    }
+}
+
 %>
 /**
 <%~ routeDocs.description %>
@@ -69,7 +82,7 @@ const securityTmpl = security ? 'true' : null;
 <%~ routeDocs.lines %>
 
  */
-<%~ route.routeName.usage %><%~ route.namespace ? ': ' : ' = ' %>(<%~ wrapperArgs %>) =>
+<%~ route.routeName.usage %><%~ route.namespace ? ': ' : ' = ' %>(<%~ wrapperArgs %>)<%~ config.toJS ? `: ${describeReturnType()}` : "" %> =>
     <%~ config.singleHttpClient ? 'this.http.request' : 'this.request' %><<%~ type %>, <%~ errorType %>>({
         path: `<%~ path %>`,
         method: '<%~ _.upperCase(method) %>',

templates/modular/api.eta

@@ -5,7 +5,7 @@ const apiClassName = classNameCase(route.moduleName);
 const routes = route.routes;
 const dataContracts = _.map(modelTypes, "name");
 %>
-<% if (config.httpClientType === config.constants.HTTP_CLIENT.AXIOS) { %> import { AxiosRequestConfig } from "axios"; <% } %>
+<% if (config.httpClientType === config.constants.HTTP_CLIENT.AXIOS) { %> import { AxiosRequestConfig, AxiosResponse } from "axios"; <% } %>
 import { HttpClient, RequestParams, ContentType } from "./<%~ config.fileNames.httpClient %>";
 <% if (dataContracts.length) { %>
 import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %>"

templates/modular/procedure-call.eta

@@ -59,6 +59,20 @@ const queryTmpl = (query != null && queryName) || null;
 const bodyContentKindTmpl = requestContentKind[requestBodyInfo.contentKind] || null;
 const responseFormatTmpl = responseContentKind[responseBodyInfo.success && responseBodyInfo.success.schema && responseBodyInfo.success.schema.contentKind] || null;
 const securityTmpl = security ? 'true' : null;
+
+const describeReturnType = () => {
+    if (!config.toJS) return "";
+
+    switch(config.httpClientType) {
+        case config.constants.HTTP_CLIENT.AXIOS: {
+          return `Promise<AxiosResponse<${type}>>`
+        }
+        default: {
+          return `Promise<HttpResponse<${type}, ${errorType}>`
+        }
+    }
+}
+
 %>
 /**
 <%~ routeDocs.description %>
@@ -68,7 +82,7 @@ const securityTmpl = security ? 'true' : null;
 <%~ routeDocs.lines %>
 
  */
-<%~ route.routeName.usage %> = (<%~ wrapperArgs %>) =>
+<%~ route.routeName.usage %> = (<%~ wrapperArgs %>)<%~ config.toJS ? `: ${describeReturnType()}` : "" %> =>
     <%~ config.singleHttpClient ? 'this.http.request' : 'this.request' %><<%~ type %>, <%~ errorType %>>({
         path: `<%~ path %>`,
         method: '<%~ _.upperCase(method) %>',

tests/generate.js

@@ -1,28 +1,25 @@
 const { resolve } = require("path");
-const createSchemasInfos = require("./helpers/createSchemaInfos")
-const { generateApi } = require('../src');
+const createSchemasInfos = require("./helpers/createSchemaInfos");
+const { generateApi } = require("../src");
 
 const schemas = [
   ...createSchemasInfos({
     absolutePathToSchemas: resolve(__dirname, "./schemas/v2.0"),
-    absoluteOutputPath: resolve(__dirname, "./generated/v2.0")
+    absoluteOutputPath: resolve(__dirname, "./generated/v2.0"),
   }),
   ...createSchemasInfos({
     absolutePathToSchemas: resolve(__dirname, "./schemas/v3.0"),
-    absoluteOutputPath: resolve(__dirname, "./generated/v3.0")
+    absoluteOutputPath: resolve(__dirname, "./generated/v3.0"),
   }),
-]
+];
 
-schemas.forEach(({
-  absolutePath,
-  apiFileName,
-  outputPath,
-}) => {
+schemas.forEach(({ absolutePath, apiFileName, outputPath }) => {
   generateApi({
     name: apiFileName,
     input: absolutePath,
     output: outputPath,
     generateClient: true,
-    generateRouteTypes: false
+    generateRouteTypes: false,
+    silent: true,
   });
-})
+});