Release 3.0.0 (#91)

* fix: handling x-omitempty property for definition properties (#68)

* docs: update CHANGELOG

* BREAKING_CHANGE: renamed mustache templates, split client mustache template

* Fixed unsafe clone() of Response causing json() hang. (#89)

Fixed unsafe clone() of Response causing json() hang   

* bump: up project version to 3.0.0; chore: refresh generated api modules; docs; update CHANGELOG

Co-authored-by: Benjamin Dobell <[email protected]>

Author: js2me

CHANGELOG.md

@@ -1,3 +1,17 @@
+# next release  
+
+
+# 3.0.0  
+
+BREAKING_CHANGES:  
+- Renamed mustache templates:  
+  - `api.mustache` -> `data-contracts.mustache`   
+  - `client.mustache` -> `http.client.mustache` + `api.mustache`  
+- Split the `client.mustache` template into two parts: `http-client.mustache` and `api.mustache`  
+
+Fixes:  
+- Fixed unsafe clone() of Response causing json() hang. (Thanks @Benjamin-Dobell)  
+
 # 2.0.0  
 
 Features:

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "2.0.0",
+  "version": "3.0.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",

package.json

@@ -1,6 +1,6 @@
 const config = {
   /** CLI flag */
-  templates: "./templates",
+  templates: "./templates/defaults",
   /** CLI flag */
   generateResponses: false,
   /** CLI flag */

src/config.js

@@ -0,0 +1,14 @@
+module.exports = {
+  filePrefix: `/* tslint:disable */
+/* eslint-disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+`,
+};

src/filePrefix.js

@@ -1,13 +1,14 @@
 const _ = require("lodash");
 const fs = require("fs");
 const { resolve } = require("path");
+const { filePrefix } = require("./filePrefix");
 
 const getFileContent = (path) => fs.readFileSync(path, { encoding: "UTF-8" });
 
 const pathIsExist = (path) => path && fs.existsSync(path);
 
 const createFile = (pathTo, fileName, content) =>
-  fs.writeFileSync(resolve(__dirname, pathTo, `./${fileName}`), content, _.noop);
+  fs.writeFileSync(resolve(__dirname, pathTo, `./${fileName}`), `${filePrefix}${content}`, _.noop);
 
 module.exports = {
   createFile,

src/files.js

@@ -56,7 +56,12 @@ module.exports = {
       });
       (spec ? convertSwaggerObject(spec) : getSwaggerObject(input, url))
         .then(({ usageSchema, originalSchema }) => {
-          const { apiTemplate, clientTemplate, routeTypesTemplate } = getTemplates();
+          const {
+            dataContractsTemplate,
+            httpClientTemplate,
+            apiTemplate,
+            routeTypesTemplate,
+          } = getTemplates();
 
           console.log("☄️  start generating your typescript api");
 
@@ -90,9 +95,10 @@ module.exports = {
           };
 
           let sourceFileContent = [
-            mustache.render(apiTemplate, configuration),
+            mustache.render(dataContractsTemplate, configuration),
             generateRouteTypes ? mustache.render(routeTypesTemplate, configuration) : "",
-            generateClient ? mustache.render(clientTemplate, configuration) : "",
+            generateClient ? mustache.render(httpClientTemplate, configuration) : "",
+            generateClient ? mustache.render(apiTemplate, configuration) : "",
           ].join("");
 
           if (toJS) {

src/index.js

@@ -2,19 +2,20 @@ const { getFileContent } = require("./files");
 const { config } = require("./config");
 const { resolve } = require("path");
 
+const getTemplate = (templateName) =>
+  getFileContent(resolve(config.templates, `./${templateName}.mustache`));
+
 const getTemplates = () => {
   console.log(`✨ try to read templates from directory "${config.templates}"`);
 
   return {
-    apiTemplate: getTemplate("api"),
-    clientTemplate: config.generateClient ? getTemplate("client") : null,
+    dataContractsTemplate: getTemplate("data-contracts"),
     routeTypesTemplate: config.generateRouteTypes ? getTemplate("route-types") : null,
+    httpClientTemplate: config.generateClient ? getTemplate("http-client") : null,
+    apiTemplate: config.generateClient ? getTemplate("api") : null,
   };
 };
 
-const getTemplate = (templateName) =>
-  getFileContent(resolve(config.templates, `./${templateName}.mustache`));
-
 module.exports = {
   getTemplates,
 };

src/templates.js

@@ -0,0 +1,41 @@
+
+{{#apiConfig.hasDescription}}
+/**
+{{#apiConfig.description}}
+ * {{.}}
+{{/apiConfig.description}}
+ */
+{{/apiConfig.hasDescription}}
+export class Api<{{#apiConfig.generic}}{{name}}{{#defaultValue}} = {{.}}{{/defaultValue}},{{/apiConfig.generic}}> extends HttpClient<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}>{
+{{#routes}}
+
+  {{#outOfModule}}
+
+
+  /**
+  {{#comments}}
+   * {{.}}
+  {{/comments}}
+   */
+  {{name}} = ({{#routeArgs}}{{name}}{{#optional}}?{{/optional}}: {{type}}, {{/routeArgs}}) =>
+    this.request<{{returnType}}, {{errorReturnType}}>({{requestMethodContent}})
+  {{/outOfModule}}
+
+  {{#combined}}
+  {{moduleName}} = {
+    {{#routes}}
+
+
+    /**
+    {{#comments}}
+     * {{.}}
+    {{/comments}}
+     */
+    {{name}}: ({{#routeArgs}}{{name}}{{#optional}}?{{/optional}}: {{type}}, {{/routeArgs}}) =>
+      this.request<{{returnType}}, {{errorReturnType}}>({{requestMethodContent}}),
+    {{/routes}}
+  }
+  {{/combined}}
+{{/routes}}
+
+}

src/templates/api.mustache

@@ -0,0 +1,9 @@
+{{#modelTypes}}
+
+{{#description}}
+/**
+ * {{.}}
+ */
+{{/description}}
+export {{typeIdentifier}} {{name}} {{content}}
+{{/modelTypes}}

src/templates/defaults/api.mustache

@@ -96,7 +96,7 @@ class HttpClient<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 
@@ -139,44 +139,3 @@ class HttpClient<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}> {
     })
   }
 }
-
-{{#apiConfig.hasDescription}}
-/**
-{{#apiConfig.description}}
- * {{.}}
-{{/apiConfig.description}}
- */
-{{/apiConfig.hasDescription}}
-export class Api<{{#apiConfig.generic}}{{name}}{{#defaultValue}} = {{.}}{{/defaultValue}},{{/apiConfig.generic}}> extends HttpClient<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}>{
-{{#routes}}
-
-  {{#outOfModule}}
-
-
-  /**
-  {{#comments}}
-   * {{.}}
-  {{/comments}}
-   */
-  {{name}} = ({{#routeArgs}}{{name}}{{#optional}}?{{/optional}}: {{type}}, {{/routeArgs}}) =>
-    this.request<{{returnType}}, {{errorReturnType}}>({{requestMethodContent}})
-  {{/outOfModule}}
-
-  {{#combined}}
-  {{moduleName}} = {
-    {{#routes}}
-
-
-    /**
-    {{#comments}}
-     * {{.}}
-    {{/comments}}
-     */
-    {{name}}: ({{#routeArgs}}{{name}}{{#optional}}?{{/optional}}: {{type}}, {{/routeArgs}}) =>
-      this.request<{{returnType}}, {{errorReturnType}}>({{requestMethodContent}}),
-    {{/routes}}
-  }
-  {{/combined}}
-{{/routes}}
-
-}

src/templates/defaults/data-contracts.mustache

@@ -237,7 +237,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 

src/templates/client.mustache renamed to src/templates/defaults/http-client.mustache

@@ -190,7 +190,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 

src/templates/route-types.mustache renamed to src/templates/defaults/route-types.mustache

@@ -68,7 +68,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 

tests/generated/v2.0/adafruit.ts

@@ -142,7 +142,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 

tests/generated/v2.0/another-example.ts

@@ -109,7 +109,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 

tests/generated/v2.0/api-with-examples.ts

@@ -74,7 +74,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 

tests/generated/v2.0/authentiq.ts

@@ -116,7 +116,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 

tests/generated/v2.0/example1.ts

@@ -257,7 +257,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 

tests/generated/v2.0/file-formdata-example.ts

@@ -1486,7 +1486,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 

tests/generated/v2.0/furkot-example.ts

@@ -90,7 +90,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 

tests/generated/v2.0/giphy.ts

@@ -116,7 +116,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 

tests/generated/v2.0/github-swagger.ts

@@ -75,7 +75,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 

tests/generated/v2.0/path-args.ts

@@ -112,7 +112,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 

tests/generated/v2.0/petstore-expanded.ts

@@ -147,7 +147,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 

tests/generated/v2.0/petstore-minimal.ts

@@ -102,7 +102,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 

tests/generated/v2.0/petstore-simple.ts

@@ -103,7 +103,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;
 

tests/generated/v2.0/petstore-swagger-io.ts

@@ -90,7 +90,7 @@ class HttpClient<SecurityDataType> {
   }
 
   private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
-    const r = response.clone() as HttpResponse<T, E>;
+    const r = response as HttpResponse<T, E>;
     r.data = null;
     r.error = null;