Release 2.0.0 (acacode#86)

* fix: security configuration in methods (acacode#84)

* chore: update generated schemas

* feat: add --js option (to generate js api module)

* docs: update CHANGELOG

* feat: up typescript to 4.0.2; fix: problem at the top level comments in generated modules

* BREAKING_CHANGE: responses from HttpClients returns Fetch responses with data and error fields

* BREAKING_CHANGES: update client.mustache template, remove interpolations in ApiConfig interface

* chore: add docs for toJS property

Co-authored-by: Jose Enrique Marquez <jmrqz21@gmail.com>

Author: js2me

.prettierignore

@@ -1,2 +1,4 @@
 tests/**/*.ts
+tests/**/schema.js
+tests/**/*.d.js
 *.md

CHANGELOG.md

@@ -1,5 +1,23 @@
 # next release  
 
+Features:
+- `--js` CLI option. [[feature request]](https://github.com/acacode/swagger-typescript-api/issues/79)  
+
+BREAKING_CHANGES:  
+- Requests returns `Promise<HttpResponse<Data, Error>>` type.  
+  `HttpResponse` it is [Fetch.Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) wrapper with fields `data` and `error`
+  Example:  
+  ```ts
+    const api = new Api()
+    
+    //
+    const response: HttpResponse<Data, Error> = await api.fruits.getAll()
+
+    response.data // Data (can be null if response.ok is false)
+    response.error // Error (can be null if response.ok is true)
+  ```  
+- Breaking changes in the `client.mustache` template. Needs to update local custom templates.  
+
 
 # 1.12.0   
 

README.md

@@ -43,6 +43,7 @@ Options:
   --union-enums             generate all "enum" types as union types (T1 | T2 | TN) (default: false)
   --route-types             generate type definitions for API routes (default: false)
   --no-client               do not generate an API class
+  --js                      generate js api module with declaration file (default: false)
   -h, --help                output usage information
 ```
 

index.d.ts

@@ -50,6 +50,11 @@ interface GenerateApiParams {
    * also add typings for bad responses
    */
   generateResponses?: boolean;
+
+  /**
+   * generate js api module with declaration file (default: false)
+   */
+  toJS?: boolean;
 }
 
 export declare function generateApi(

index.js

@@ -32,11 +32,23 @@ program
   )
   .option("--union-enums", 'generate all "enum" types as union types (T1 | T2 | TN)', false)
   .option("--route-types", "generate type definitions for API routes", false)
-  .option("--no-client", "do not generate an API class", false);
+  .option("--no-client", "do not generate an API class", false)
+  .option("--js", "generate js api module with declaration file", false);
 
 program.parse(process.argv);
 
-const { path, output, name, templates, unionEnums, routeTypes, client, defaultAsSuccess, responses } = program;
+const {
+  path,
+  output,
+  name,
+  templates,
+  unionEnums,
+  routeTypes,
+  client,
+  defaultAsSuccess,
+  responses,
+  js,
+} = program;
 
 generateApi({
   name,
@@ -49,4 +61,5 @@ generateApi({
   input: resolve(process.cwd(), path),
   output: resolve(process.cwd(), output || "."),
   templates: resolve(templates ? process.cwd() : __dirname, templates || "./src/templates"),
+  toJS: !!js,
 });

package-lock.json

@@ -8,7 +8,7 @@
     "cli:debug:json": "node --nolazy index.js -p ./swagger-test-cli.json -n swagger-test-cli.ts --union-enums",
     "cli:debug:yaml": "node --nolazy index.js -p ./swagger-test-cli.yaml -n swagger-test-cli.ts",
     "cli:help": "node index.js -h",
-    "test:all": "npm-run-all generate validate test:routeTypes test:noClient test:defaultAsSuccess test:responses test:templates test:unionEnums test:specProperty --continue-on-error",
+    "test:all": "npm-run-all generate validate test:routeTypes test:noClient test:defaultAsSuccess test:responses test:templates test:unionEnums test:specProperty test:js --continue-on-error",
     "generate": "node tests/generate.js",
     "generate:debug": "node --nolazy tests/generate.js",
     "validate": "node tests/validate.js",
@@ -19,7 +19,8 @@
     "test:templates": "node tests/spec/templates/test.js",
     "test:unionEnums": "node tests/spec/unionEnums/test.js",
     "test:responses": "node tests/spec/responses/test.js",
-    "test:specProperty": "node tests/spec/specProperty/test.js"
+    "test:specProperty": "node tests/spec/specProperty/test.js",
+    "test:js": "node tests/spec/js/test.js"
   },
   "author": "acacode",
   "license": "MIT",
@@ -31,8 +32,7 @@
     "@types/prettier": "^2.0.1",
     "husky": "^4.2.3",
     "npm-run-all": "^4.1.5",
-    "pretty-quick": "^2.0.1",
-    "typescript": "^3.9.3"
+    "pretty-quick": "^2.0.1"
   },
   "dependencies": {
     "@types/swagger-schema-official": "2.0.21",
@@ -43,7 +43,8 @@
     "mustache": "^4.0.1",
     "prettier": "^2.0.5",
     "swagger-schema-official": "2.0.0-bab6bed",
-    "swagger2openapi": "^6.0.3"
+    "swagger2openapi": "^6.0.3",
+    "typescript": "^4.0.2"
   },
   "bin": {
     "swagger-typescript-api": "index.js",

package.json

@@ -22,12 +22,13 @@ const { getTemplates } = require("./templates");
 
 mustache.escape = (value) => value;
 
-const prettierConfig = {
-  printWidth: 120,
-  tabWidth: 2,
-  trailingComma: "all",
-  parser: "typescript",
-};
+const prettierFormat = (content) =>
+  prettier.format(content, {
+    printWidth: 120,
+    tabWidth: 2,
+    trailingComma: "all",
+    parser: "typescript",
+  });
 
 module.exports = {
   generateApi: ({
@@ -36,6 +37,7 @@ module.exports = {
     url,
     spec,
     name,
+    toJS,
     templates = resolve(__dirname, config.templates),
     generateResponses = config.generateResponses,
     defaultResponseAsSuccess = config.defaultResponseAsSuccess,
@@ -87,21 +89,36 @@ module.exports = {
             routes: groupRoutes(routes),
           };
 
-          const sourceFile = prettier.format(
-            [
-              mustache.render(apiTemplate, configuration),
-              generateRouteTypes ? mustache.render(routeTypesTemplate, configuration) : "",
-              generateClient ? mustache.render(clientTemplate, configuration) : "",
-            ].join(""),
-            prettierConfig,
-          );
-
-          if (pathIsExist(output)) {
-            createFile(output, name, sourceFile);
-            console.log(`✔️  your typescript api file created in "${output}"`);
-          }
+          let sourceFileContent = [
+            mustache.render(apiTemplate, configuration),
+            generateRouteTypes ? mustache.render(routeTypesTemplate, configuration) : "",
+            generateClient ? mustache.render(clientTemplate, configuration) : "",
+          ].join("");
+
+          if (toJS) {
+            const {
+              sourceFile: sourceJsFile,
+              declarationFile,
+            } = require("./translators/JavaScript").translate(name, sourceFileContent);
 
-          resolve(sourceFile);
+            sourceJsFile.content = prettierFormat(sourceJsFile.content);
+            declarationFile.content = prettierFormat(declarationFile.content);
+
+            if (pathIsExist(output)) {
+              createFile(output, sourceJsFile.name, sourceJsFile.content);
+              createFile(output, declarationFile.name, declarationFile.content);
+              console.log(`✔️  your javascript api file created in "${output}"`);
+            }
+            resolve(sourceJsFile.content);
+          } else {
+            sourceFileContent = prettierFormat(sourceFileContent);
+
+            if (pathIsExist(output)) {
+              createFile(output, name, sourceFileContent);
+              console.log(`✔️  your typescript api file created in "${output}"`);
+            }
+            resolve(sourceFileContent);
+          }
         })
         .catch((e) => {
           reject(e);

src/index.js

@@ -191,7 +191,7 @@ const createRequestsMap = (requestInfoByMethodsMap) => {
   );
 };
 
-const parseRoutes = ({ paths }, parsedSchemas) =>
+const parseRoutes = ({ paths, security: globalSecurity }, parsedSchemas) =>
   _.entries(paths).reduce((routes, [route, requestInfoByMethodsMap]) => {
     if (route.startsWith("x-")) return routes;
 
@@ -210,7 +210,10 @@ const parseRoutes = ({ paths }, parsedSchemas) =>
           tags,
           responses,
         } = requestInfo;
-        const hasSecurity = !!(security && security.length);
+        const hasSecurity = !!(
+          (globalSecurity && globalSecurity.length) ||
+          (security && security.length)
+        );
 
         const formDataParams = getRouteParams(parameters, "formData");
         const pathParams = getRouteParams(parameters, "path");

src/routes.js

@@ -1,6 +1,5 @@
 /* tslint:disable */
 /* eslint-disable */
-
 /*
 * ---------------------------------------------------------------
 * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##

src/templates/api.mustache

@@ -7,10 +7,10 @@ export type RequestParams = Omit<RequestInit, "body" | "method"> & {
 export type RequestQueryParamsType = Record<string | number, any>;
 {{/hasQueryRoutes}}
 
-type ApiConfig<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}> = {
-{{#apiConfig.props}}
-  {{name}}{{#optional}}?{{/optional}}: {{type}},
-{{/apiConfig.props}}
+interface ApiConfig<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}> {
+  baseUrl?: string;
+  baseApiParams?: RequestParams;
+  securityWorker?: (securityData: SecurityDataType) => RequestParams;
 }
 
 {{#generateResponses}}
@@ -21,6 +21,10 @@ type TPromise<ResolveType, RejectType = any> = Omit<Promise<ResolveType>, "then"
 }
 {{/generateResponses}}
 
+interface HttpResponse<D extends unknown, E extends unknown = unknown> extends Response {
+  data: D | null;
+  error: E | null;
+}
 
 enum BodyType {
   Json,
@@ -32,7 +36,7 @@ enum BodyType {
 class HttpClient<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}> {
   public baseUrl: string = "{{apiConfig.baseUrl}}";
   private securityData: SecurityDataType = (null as any);
-  private securityWorker: ApiConfig<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}>["securityWorker"] = (() => {}) as any
+  private securityWorker: null | ApiConfig<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}>["securityWorker"] = null;
 
   private baseApiParams: RequestParams = {
     credentials: 'same-origin',
@@ -43,10 +47,8 @@ class HttpClient<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}> {
     referrerPolicy: 'no-referrer',
   }
 
-  constructor({ {{#apiConfig.props}}{{name}},{{/apiConfig.props}} }: ApiConfig<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}> = {}) {
-  {{#apiConfig.props}}
-    this.{{name}} = {{name}} || this.{{name}};
-  {{/apiConfig.props}}
+  constructor(apiConfig: ApiConfig<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}> = {}) {
+    Object.assign(this, apiConfig);
   }
 
   public setSecurityData = (data: SecurityDataType) => {
@@ -93,10 +95,26 @@ class HttpClient<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}> {
     }
   }
 
-  private safeParseResponse = <T = any, E = any>(response: Response): {{#generateResponses}}TPromise<T, E>{{/generateResponses}}{{^generateResponses}}Promise<T>{{/generateResponses}} =>
-    response.json()
-      .then(data => data)
-      .catch(e => response.text);
+  private safeParseResponse = <T = any, E = any>(response: Response): Promise<HttpResponse<T, E>> => {
+    const r = response.clone() as HttpResponse<T, E>;
+    r.data = null;
+    r.error = null;
+
+    return response
+      .json()
+      .then((data) => {
+        if (r.ok) {
+          r.data = data;
+        } else {
+          r.error = data;
+        }
+        return r;
+      })
+      .catch((e) => {
+        r.error = e;
+        return r;
+      });
+  }
 
   public request = <T = any, E = any>(
     path: string,
@@ -105,17 +123,21 @@ class HttpClient<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}> {
     body?: any,
     bodyType?: BodyType,
     secureByDefault?: boolean,
-  ): {{#generateResponses}}TPromise<T, E>{{/generateResponses}}{{^generateResponses}}Promise<T>{{/generateResponses}} =>
-    fetch(`${this.baseUrl}${path}`, {
-      // @ts-ignore
-      ...this.mergeRequestOptions(params, (secureByDefault || secure) && this.securityWorker(this.securityData)),
+  ): {{#generateResponses}}TPromise<HttpResponse<T, E>>{{/generateResponses}}{{^generateResponses}}Promise<HttpResponse<T>>{{/generateResponses}} => {
+    const requestUrl = `${this.baseUrl}${path}`;
+    const secureOptions = (secureByDefault || secure) && this.securityWorker ? this.securityWorker(this.securityData) : {};
+    const requestOptions = {
+      ...this.mergeRequestOptions(params, secureOptions),
       method,
       body: body ? this.bodyFormatters[bodyType || BodyType.Json](body) : null,
-    }).then(async response => {
+    }
+
+    return fetch(requestUrl, requestOptions).then(async response => {
       const data = await this.safeParseResponse<T, E>(response);
       if (!response.ok) throw data
       return data
     })
+  }
 }
 
 {{#apiConfig.hasDescription}}