swagger-typescript-api 10.0.1 → 10.0.2

package/src/utils/resolveName.js

@@ -1,97 +1,97 @@
-const _ = require("lodash");
-const { getRandomInt } = require("./random");
-
-class NameResolver {
-  reservedNames = [];
-  getDefaultName = null;
-
-  /**
-   *
-   * @param {string[]} reservedNames
-   */
-  constructor(reservedNames, getDefaultName) {
-    this.getDefaultName = getDefaultName;
-    this.reserve(reservedNames);
-  }
-
-  /**
-   *
-   * @param {string[]} names
-   */
-  reserve(names) {
-    this.reservedNames.push(..._.uniq(_.compact(names)));
-  }
-
-  unreserve(names) {
-    this.reservedNames.filter((reservedName) => !names.some((name) => name === reservedName));
-  }
-
-  isReserved(name) {
-    return _.some(this.reservedNames, (reservedName) => reservedName === name);
-  }
-
-  /**
-   *
-   * @param {string[]} variants
-   * @param {((variant: string) => string) | undefined} onSelectMutation
-   * @returns {string | null}
-   */
-  resolve(variants, onSelectMutation) {
-    let usageName = null;
-    const uniqVariants = _.uniq(_.compact(variants));
-
-    _.forEach(uniqVariants, (variant) => {
-      const mutatedVariant = onSelectMutation ? onSelectMutation(variant) : variant;
-      if (!usageName && !this.isReserved(mutatedVariant)) {
-        usageName = mutatedVariant;
-      }
-    });
-
-    if (usageName) {
-      this.reserve([usageName]);
-      return usageName;
-    }
-
-    const defaultName = this.getDefaultName && this.getDefaultName(variants);
-
-    if (defaultName) {
-      this.reserve([onSelectMutation ? onSelectMutation(defaultName) : defaultName]);
-      return defaultName;
-    }
-
-    return null;
-  }
-}
-
-class SpecificArgNameResolver extends NameResolver {
-  /**
-   *
-   * @param {string[]} reservedNames
-   */
-  constructor(reservedNames) {
-    super(reservedNames, (variants) => {
-      return (variants[0] && `${variants[0]}${getRandomInt(1, 10)}`) || `arg${getRandomInt(1, 10)}`;
-    });
-  }
-}
-
-class ComponentTypeNameResolver extends NameResolver {
-  /**
-   *
-   * @param {string[]} reservedNames
-   */
-  constructor(reservedNames) {
-    super(reservedNames, (variants) => {
-      return (
-        (variants[0] && `${variants[0]}${getRandomInt(1, 10)}`) ||
-        `ComponentType${getRandomInt(1, 10)}`
-      );
-    });
-  }
-}
-
-module.exports = {
-  NameResolver,
-  SpecificArgNameResolver,
-  ComponentTypeNameResolver,
-};
+const _ = require("lodash");
+const { getRandomInt } = require("./random");
+
+class NameResolver {
+  reservedNames = [];
+  getDefaultName = null;
+
+  /**
+   *
+   * @param {string[]} reservedNames
+   */
+  constructor(reservedNames, getDefaultName) {
+    this.getDefaultName = getDefaultName;
+    this.reserve(reservedNames);
+  }
+
+  /**
+   *
+   * @param {string[]} names
+   */
+  reserve(names) {
+    this.reservedNames.push(..._.uniq(_.compact(names)));
+  }
+
+  unreserve(names) {
+    this.reservedNames.filter((reservedName) => !names.some((name) => name === reservedName));
+  }
+
+  isReserved(name) {
+    return _.some(this.reservedNames, (reservedName) => reservedName === name);
+  }
+
+  /**
+   *
+   * @param {string[]} variants
+   * @param {((variant: string) => string) | undefined} onSelectMutation
+   * @returns {string | null}
+   */
+  resolve(variants, onSelectMutation) {
+    let usageName = null;
+    const uniqVariants = _.uniq(_.compact(variants));
+
+    _.forEach(uniqVariants, (variant) => {
+      const mutatedVariant = onSelectMutation ? onSelectMutation(variant) : variant;
+      if (!usageName && !this.isReserved(mutatedVariant)) {
+        usageName = mutatedVariant;
+      }
+    });
+
+    if (usageName) {
+      this.reserve([usageName]);
+      return usageName;
+    }
+
+    const defaultName = this.getDefaultName && this.getDefaultName(variants);
+
+    if (defaultName) {
+      this.reserve([onSelectMutation ? onSelectMutation(defaultName) : defaultName]);
+      return defaultName;
+    }
+
+    return null;
+  }
+}
+
+class SpecificArgNameResolver extends NameResolver {
+  /**
+   *
+   * @param {string[]} reservedNames
+   */
+  constructor(reservedNames) {
+    super(reservedNames, (variants) => {
+      return (variants[0] && `${variants[0]}${getRandomInt(1, 10)}`) || `arg${getRandomInt(1, 10)}`;
+    });
+  }
+}
+
+class ComponentTypeNameResolver extends NameResolver {
+  /**
+   *
+   * @param {string[]} reservedNames
+   */
+  constructor(reservedNames) {
+    super(reservedNames, (variants) => {
+      return (
+        (variants[0] && `${variants[0]}${getRandomInt(1, 10)}`) ||
+        `ComponentType${getRandomInt(1, 10)}`
+      );
+    });
+  }
+}
+
+module.exports = {
+  NameResolver,
+  SpecificArgNameResolver,
+  ComponentTypeNameResolver,
+};

package/templates/README.md

@@ -1,13 +1,17 @@
-# swagger-typescript-api  
-
-# templates  
-
-Templates:  
-- `api.eta` - Api class module (locations: [default](https://github.com/acacode/swagger-typescript-api/tree/next/templates/default/api.eta), [modular](https://github.com/acacode/swagger-typescript-api/tree/next/templates/modular/api.eta))  
-- `data-contracts.eta` - all types (data contracts) from swagger schema (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/data-contracts.eta))  
-- `http-client.eta` - HttpClient class module (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/http-client.eta))  
-- `procedure-call.eta` - route in Api class (locations: [default](https://github.com/acacode/swagger-typescript-api/tree/next/templates/default/procedure-call.eta), [modular](https://github.com/acacode/swagger-typescript-api/tree/next/templates/modular/procedure-call.eta))  
-- `route-docs.eta` - documentation for route in Api class (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/route-docs.eta))  
-- `route-name.eta` - route name for route in Api class (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/route-name.eta))  
-- `route-type.eta` - *(`--route-types` option)* (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/route-type.eta))  
-- `route-types.eta` - *(`--route-types` option)* (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/route-types.eta))  
+# swagger-typescript-api  
+
+# templates  
+
+Templates:  
+- `api.ejs` - *(generates file)* Api class module (locations: [default](https://github.com/acacode/swagger-typescript-api/tree/next/templates/default/api.ejs), [modular](https://github.com/acacode/swagger-typescript-api/tree/next/templates/modular/api.ejs))  
+- `data-contracts.ejs` - *(generates file)* all types (data contracts) from swagger schema (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/data-contracts.ejs))  
+- `http-client.ejs` - *(generates file)* HttpClient class module (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/http-client.ejs))  
+- `procedure-call.ejs` - *(subtemplate)* route in Api class (locations: [default](https://github.com/acacode/swagger-typescript-api/tree/next/templates/default/procedure-call.ejs), [modular](https://github.com/acacode/swagger-typescript-api/tree/next/templates/modular/procedure-call.ejs))  
+- `route-docs.ejs` - *(generates file)* documentation for route in Api class (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/route-docs.ejs))  
+- `route-name.ejs` - *(subtemplate)* route name for route in Api class (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/route-name.ejs))  
+- `route-type.ejs` - *(`--route-types` option)* *(subtemplate)* (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/route-type.ejs))  
+- `route-types.ejs` - *(`--route-types` option)* *(subtemplate)* (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/route-types.ejs))  - `data-contract-jsdoc.ejs` - *(subtemplate)* generates JSDOC for data contract (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/data-contract-jsdoc.ejs))
+
+[//]: # (- `enum-data-contract.ejs` - *(subtemplate)* generates `enum` data contract (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/enum-data-contract.ejs)))
+[//]: # (- `interface-data-contract.ejs` - *(subtemplate)* generates `interface` data contract (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/interface-data-contract.ejs)))
+[//]: # (- `type-data-contract.ejs` - *(subtemplate)* generates `type` data contract (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/type-data-contract.ejs)))

package/templates/base/README.md

@@ -1,8 +1,8 @@
-# swagger-typescript-api  
-
-# templates/base  
-
-This templates use both for multiple api files and single api file  
-
-
+# swagger-typescript-api  
+
+# templates/base  
+
+This templates use both for multiple api files and single api file  
+
+
 path prefix `@base`  

package/templates/base/data-contract-jsdoc.ejs

@@ -0,0 +1,32 @@
+<%
+const { contract, utils } = it;
+const { formatDescription, require, _ } = utils;
+
+let jsDocLines = [];
+
+jsDocLines.push(
+    contract.title,
+    contract.description && formatDescription(contract.description),
+)
+
+if (contract.typeData) {
+  jsDocLines.push(
+      contract.typeData.deprecated === true && '@deprecated',
+      !_.isUndefined(contract.typeData.format) && `@format ${contract.typeData.format}`,
+      !_.isUndefined(contract.typeData.minimum) && `@min ${contract.typeData.minimum}`,
+      !_.isUndefined(contract.typeData.maximum) && `@max ${contract.typeData.maximum}`,
+      !_.isUndefined(contract.typeData.pattern) && `@pattern ${contract.typeData.pattern}`,
+      !_.isUndefined(contract.typeData.example) && `@example ${
+              _.isObject(contract.typeData.example) ? JSON.stringify(contract.typeData.example) : contract.typeData.example
+      }`
+  )
+}
+
+jsDocLines = _.compact(jsDocLines);
+%>
+<% if (jsDocLines.length) { %>
+/**
+<%~ jsDocLines.map(part => `* ${part}`).join("\n") %>
+
+*/
+<% } %>

package/templates/base/data-contracts.ejs

@@ -0,0 +1,28 @@
+<%
+const { modelTypes, utils, config } = it;
+const { formatDescription, require, _ } = utils;
+
+
+const dataContractTemplates = {
+  enum: (contract) => {
+    return `enum ${contract.name} {\r\n${contract.content} \r\n }`;
+  },
+  interface: (contract) => {
+    return `interface ${contract.name} {\r\n${contract.content}}`;
+  },
+  type: (contract) => {
+    return `type ${contract.name} = ${contract.content}`;
+  },
+}
+%>
+
+<% if (config.internalTemplateOptions.addUtilRequiredKeysType) { %>
+type UtilRequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>
+<% } %>
+
+<% modelTypes.forEach((contract) => { %>
+  <%~ includeFile('@base/data-contract-jsdoc.ejs', { ...it, contract }) %>
+  export <%~ (dataContractTemplates[contract.typeIdentifier] || dataContractTemplates.type)(contract) %>
+
+
+<% }) %>

package/templates/base/enum-data-contract.ejs

@@ -0,0 +1,15 @@
+<%
+const { contract, utils, config } = it;
+const { formatDescription, require, _ } = utils;
+const { name, $content } = contract;
+
+const isNumberEnum = _.some($content, (content) => typeof content.key === "number");
+const formatAsUnionType = !!(isNumberEnum || config.generateUnionEnums);
+%>
+<% if (formatAsUnionType) { %>
+  export type <%~ name %> = <%~ _.map($content, ({ value }) => value).join(" | ") %>
+<% } else { %>
+  export enum <%~ name %> {
+    <%~ _.map($content, ({ key, value }) => `${key} = ${value}`).join(",\n") %>
+  }
+<% } %>

package/templates/base/{http-client.eta → http-client.ejs}

@@ -1,3 +1,3 @@
-<% const { config } = it; %>
-<% /* https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/http-clients/ */ %>
+<% const { config } = it; %>
+<% /* https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/http-clients/ */ %>
 <%~ includeFile(`@base/http-clients/${config.httpClientType}-http-client`, it) %>

package/templates/base/http-clients/{axios-http-client.eta → axios-http-client.ejs}

@@ -1,145 +1,133 @@
-<%
-const { apiConfig, generateResponses, config } = it;
-%>
-
-import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType, HeadersDefaults } from "axios";
-
-export type QueryParamsType = Record<string | number, any>;
-
-export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
-  /** set parameter to `true` for call `securityWorker` for this request */
-  secure?: boolean;
-  /** request path */
-  path: string;
-  /** content type of request body */
-  type?: ContentType;
-  /** query params */
-  query?: QueryParamsType;
-  /** format of response (i.e. response.json() -> format: "json") */
-  format?: ResponseType;
-  /** request body */
-  body?: unknown;
-}
-
-export type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
-
-export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
-  securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
-  secure?: boolean;
-  format?: ResponseType;
-}
-
-export enum ContentType {
-  Json = "application/json",
-  FormData = "multipart/form-data",
-  UrlEncoded = "application/x-www-form-urlencoded",
-}
-
-export class HttpClient<SecurityDataType = unknown> {
-    public instance: AxiosInstance;
-    private securityData: SecurityDataType | null = null;
-    private securityWorker?: ApiConfig<SecurityDataType>["securityWorker"];
-    private secure?: boolean;
-    private format?: ResponseType;
-
-    constructor({ securityWorker, secure, format, ...axiosConfig }: ApiConfig<SecurityDataType> = {}) {
-        this.instance = axios.create({ ...axiosConfig, baseURL: axiosConfig.baseURL || "<%~ apiConfig.baseUrl %>" })
-        this.secure = secure;
-        this.format = format;
-        this.securityWorker = securityWorker;
-    }
-
-    public setSecurityData = (data: SecurityDataType | null) => {
-        this.securityData = data
-    }
-
-    protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig {
-      const method = params1.method || (params2 && params2.method)
-
-      return {
-        ...this.instance.defaults,
-        ...params1,
-        ...(params2 || {}),
-        headers: {
-          ...((method && this.instance.defaults.headers[method.toLowerCase() as keyof HeadersDefaults]) || {}),
-          ...(params1.headers || {}),
-          ...((params2 && params2.headers) || {}),
-        },
-      };
-    }
-
-    protected stringifyFormItem(formItem: unknown) {
-      if (typeof formItem === "object" && formItem !== null) {
-        return JSON.stringify(formItem);
-      } else {
-        return `${formItem}`;
-      }
-    }
-
-    protected createFormData(input: Record<string, unknown>): FormData {
-      return Object.keys(input || {}).reduce((formData, key) => {
-        const property = input[key];
-        const propertyContent: Iterable<any> = (property instanceof Array) ? property : [property]
-
-        for (const formItem of propertyContent) {
-          const isFileType = formItem instanceof Blob || formItem instanceof File;
-          formData.append(
-            key,
-            isFileType ? formItem : this.stringifyFormItem(formItem)
-            );
-        }
-
-        return formData;
-      }, new FormData());
-      return Object.keys(input || {}).reduce((formData, key) => {
-        const property = input[key];
-        formData.append(
-            key,
-            property instanceof Blob ?
-                property :
-            typeof property === "object" && property !== null ?
-                JSON.stringify(property) :
-            `${property}`
-        );
-        return formData;
-      }, new FormData())
-    }
-
-    public request = async <T = any, _E = any>({
-        secure,
-        path,
-        type,
-        query,
-        format,
-        body,
-        ...params
-<% if (config.unwrapResponseData) { %>
-    }: FullRequestParams): Promise<T> => {
-<% } else { %>
-    }: FullRequestParams): Promise<AxiosResponse<T>> => {
-<% } %>
-        const secureParams = ((typeof secure === 'boolean' ? secure : this.secure) && this.securityWorker && (await this.securityWorker(this.securityData))) || {};
-        const requestParams = this.mergeRequestParams(params, secureParams);
-        const responseFormat = (format || this.format) || undefined;
-
-        if (type === ContentType.FormData && body && body !== null && typeof body === "object") {
-          body = this.createFormData(body as Record<string, unknown>);
-        }
-
-        return this.instance.request({
-            ...requestParams,
-            headers: {
-                ...(type && type !== ContentType.FormData ? { "Content-Type": type } : {}),
-                ...(requestParams.headers || {}),
-            },
-            params: query,
-            responseType: responseFormat,
-            data: body,
-            url: path,
-<% if (config.unwrapResponseData) { %>
-        }).then(response => response.data);
-<% } else { %>
-        });
-<% } %>
-    };
-}
+<%
+const { apiConfig, generateResponses, config } = it;
+%>
+
+import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType, HeadersDefaults } from "axios";
+
+export type QueryParamsType = Record<string | number, any>;
+
+export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
+  /** set parameter to `true` for call `securityWorker` for this request */
+  secure?: boolean;
+  /** request path */
+  path: string;
+  /** content type of request body */
+  type?: ContentType;
+  /** query params */
+  query?: QueryParamsType;
+  /** format of response (i.e. response.json() -> format: "json") */
+  format?: ResponseType;
+  /** request body */
+  body?: unknown;
+}
+
+export type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
+
+export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
+  securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
+  secure?: boolean;
+  format?: ResponseType;
+}
+
+export enum ContentType {
+  Json = "application/json",
+  FormData = "multipart/form-data",
+  UrlEncoded = "application/x-www-form-urlencoded",
+}
+
+export class HttpClient<SecurityDataType = unknown> {
+    public instance: AxiosInstance;
+    private securityData: SecurityDataType | null = null;
+    private securityWorker?: ApiConfig<SecurityDataType>["securityWorker"];
+    private secure?: boolean;
+    private format?: ResponseType;
+
+    constructor({ securityWorker, secure, format, ...axiosConfig }: ApiConfig<SecurityDataType> = {}) {
+        this.instance = axios.create({ ...axiosConfig, baseURL: axiosConfig.baseURL || "<%~ apiConfig.baseUrl %>" })
+        this.secure = secure;
+        this.format = format;
+        this.securityWorker = securityWorker;
+    }
+
+    public setSecurityData = (data: SecurityDataType | null) => {
+        this.securityData = data
+    }
+
+    protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig {
+      const method = params1.method || (params2 && params2.method)
+
+      return {
+        ...this.instance.defaults,
+        ...params1,
+        ...(params2 || {}),
+        headers: {
+          ...((method && this.instance.defaults.headers[method.toLowerCase() as keyof HeadersDefaults]) || {}),
+          ...(params1.headers || {}),
+          ...((params2 && params2.headers) || {}),
+        },
+      };
+    }
+
+    protected stringifyFormItem(formItem: unknown) {
+      if (typeof formItem === "object" && formItem !== null) {
+        return JSON.stringify(formItem);
+      } else {
+        return `${formItem}`;
+      }
+    }
+
+    protected createFormData(input: Record<string, unknown>): FormData {
+      return Object.keys(input || {}).reduce((formData, key) => {
+        const property = input[key];
+        const propertyContent: Iterable<any> = (property instanceof Array) ? property : [property]
+
+        for (const formItem of propertyContent) {
+          const isFileType = formItem instanceof Blob || formItem instanceof File;
+          formData.append(
+            key,
+            isFileType ? formItem : this.stringifyFormItem(formItem)
+            );
+        }
+
+        return formData;
+      }, new FormData());
+    }
+
+    public request = async <T = any, _E = any>({
+        secure,
+        path,
+        type,
+        query,
+        format,
+        body,
+        ...params
+<% if (config.unwrapResponseData) { %>
+    }: FullRequestParams): Promise<T> => {
+<% } else { %>
+    }: FullRequestParams): Promise<AxiosResponse<T>> => {
+<% } %>
+        const secureParams = ((typeof secure === 'boolean' ? secure : this.secure) && this.securityWorker && (await this.securityWorker(this.securityData))) || {};
+        const requestParams = this.mergeRequestParams(params, secureParams);
+        const responseFormat = (format || this.format) || undefined;
+
+        if (type === ContentType.FormData && body && body !== null && typeof body === "object") {
+          body = this.createFormData(body as Record<string, unknown>);
+        }
+
+        return this.instance.request({
+            ...requestParams,
+            headers: {
+                ...(requestParams.headers || {}),
+                ...(type && type !== ContentType.FormData ? { "Content-Type": type } : {}),
+            },
+            params: query,
+            responseType: responseFormat,
+            data: body,
+            url: path,
+<% if (config.unwrapResponseData) { %>
+        }).then(response => response.data);
+<% } else { %>
+        });
+<% } %>
+    };
+}