Release 1.7.0 (#42)

* BREAKING_CHANGE: removed title and version public Api properties (moved it to Api class JSDOC)

* BREAKING_CHANGE: move out all http client handlers/properties into HttpClient local class in module; chore: default value for SecurityDataType

Co-authored-by: svolkov <[email protected]>

Author: js2me

CHANGELOG.md

@@ -1,5 +1,20 @@
 # next release  
 
+# 1.7.0  
+
+Breaking Changes:  
+
+- Remove `title` and `version` public Api class properties (moved it to Api class JSDOC)([fixes this issue](https://github.com/acacode/swagger-typescript-api/issues/41))  
+  ![removed title and version properties](./assets/changelog_assets/removed-title-version-props.jpg)  
+- Move out all http client handlers/properties into `HttpClient` local class in module  
+  ![http-client-class1](./assets/changelog_assets/http-client-class1.jpg)  
+  ![http-client-class2](./assets/changelog_assets/http-client-class2.jpg)  
+
+Chore:  
+
+- default value for `SecurityDataType` Api class generic type  
+  
+
 # 1.6.3  
 
 Fixes:  

assets/changelog_assets/http-client-class1.jpg

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "1.6.3",
+  "version": "1.7.0",
   "description": "Create typescript api module from swagger schema",
   "scripts": {
     "cli": "node index.js -d -p ./swagger-test-cli.json -n swagger-test-cli.ts",

assets/changelog_assets/http-client-class2.jpg

@@ -1,38 +1,50 @@
+const _ = require("lodash");
 const { formatDescription } = require("./common");
 
-const createApiConfig = ({ info, servers, }) => {
-  const server = (servers && servers[0]) || { url: '' }
+const createApiConfig = ({ info, servers }) => {
+  const server = (servers && servers[0]) || { url: "" };
 
-  const generic = [
-    'SecurityDataType'
-  ].filter(Boolean).join(', ')
+  const generic = _.compact([
+    {
+      name: "SecurityDataType",
+      defaultValue: "any",
+    },
+  ]);
+
+  const description = _.compact([
+    `@title ${info.title || "Api"}`,
+    info.version && `@version ${info.version}`,
+    server.url && `@baseUrl ${server.url}`,
+    _.replace(formatDescription(info.description), /\n/g, "\n * "),
+  ]);
 
   return {
     props: [
       {
-        name: 'baseUrl',
+        name: "baseUrl",
         optional: true,
-        type: 'string'
+        type: "string",
       },
       {
-        name: 'baseApiParams',
+        name: "baseApiParams",
         optional: true,
-        type: 'RequestParams'
+        type: "RequestParams",
       },
       {
-        name: 'securityWorker',
+        name: "securityWorker",
         optional: true,
-        type: '(securityData: SecurityDataType) => RequestParams'
-      }
+        type: "(securityData: SecurityDataType) => RequestParams",
+      },
     ].filter(Boolean),
-    generic: generic && `<${generic}>`,
+    generic,
     baseUrl: server.url,
     title: info.title,
     version: info.version,
-    description: formatDescription(info.description),
-  }
-}
+    description,
+    hasDescription: !!description.length,
+  };
+};
 
 module.exports = {
   createApiConfig,
-}
+};

assets/changelog_assets/removed-title-version-props.jpg

@@ -7,7 +7,7 @@ export type RequestParams = Omit<RequestInit, "body" | "method"> & {
 export type RequestQueryParamsType = Record<string, string | string[] | number | number[] | boolean | undefined>;
 {{/hasQueryRoutes}}
 
-type ApiConfig{{apiConfig.generic}} = {
+type ApiConfig<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}> = {
 {{#apiConfig.props}}
   {{name}}{{#optional}}?{{/optional}}: {{type}},
 {{/apiConfig.props}}
@@ -21,17 +21,11 @@ type TPromise<ResolveType, RejectType = any> = Omit<Promise<ResolveType>, "then"
 }
 {{/generateResponses}}
 
-{{#apiConfig.description}}
-/** {{.}} */
-{{/apiConfig.description}}
-export class Api{{apiConfig.generic}} {
-  
-  public baseUrl = "{{apiConfig.baseUrl}}";
-  public title = "{{apiConfig.title}}";
-  public version = "{{apiConfig.version}}";
 
+class HttpClient<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}> {
+  public baseUrl: string = "{{apiConfig.baseUrl}}";
   private securityData: SecurityDataType = (null as any);
-  private securityWorker: ApiConfig{{apiConfig.generic}}["securityWorker"] = (() => {}) as any
+  private securityWorker: ApiConfig<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}>["securityWorker"] = (() => {}) as any
 
   private baseApiParams: RequestParams = {
     credentials: 'same-origin',
@@ -42,7 +36,7 @@ export class Api{{apiConfig.generic}} {
     referrerPolicy: 'no-referrer',
   }
 
-  constructor({ {{#apiConfig.props}}{{name}},{{/apiConfig.props}} }: ApiConfig{{apiConfig.generic}} = {}) {
+  constructor({ {{#apiConfig.props}}{{name}},{{/apiConfig.props}} }: ApiConfig<{{#apiConfig.generic}}{{name}},{{/apiConfig.generic}}> = {}) {
   {{#apiConfig.props}}
     this.{{name}} = {{name}} || this.{{name}};
   {{/apiConfig.props}}
@@ -57,7 +51,7 @@ export class Api{{apiConfig.generic}} {
     return encodeURIComponent(key) + "=" + encodeURIComponent(Array.isArray(query[key]) ? (query[key] as any).join(",") : query[key])
   }
 
-  private addQueryParams(query?: RequestQueryParamsType): string {
+  protected addQueryParams(query?: RequestQueryParamsType): string {
     const fixedQuery = query || {};
     const keys = Object.keys(fixedQuery).filter(key => "undefined" !== typeof fixedQuery[key]);
     return keys.length === 0 ? "" : `?${keys.map(key => this.addQueryParam(fixedQuery, key)).join("&")}`;
@@ -99,7 +93,16 @@ export class Api{{apiConfig.generic}} {
       if (!response.ok) throw data
       return data
     })
+}
 
+{{#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}}