swagger-typescript-api 11.1.2 → 12.0.0

package/src/util/name-resolver.js

@@ -3,19 +3,24 @@ const { getRandomInt } = require("./random.js");
 
 class NameResolver {
   reservedNames = [];
-  getDefaultName = null;
+  getFallbackName = null;
 
   /**
-   *
+   * @type {Logger}
+   */
+  logger;
+
+  /**
+   * @param {Logger} logger;
    * @param {string[]} reservedNames
    */
-  constructor(reservedNames, getDefaultName) {
-    this.getDefaultName = getDefaultName;
+  constructor(logger, reservedNames, getFallbackName) {
+    this.logger = logger;
+    this.getFallbackName = getFallbackName;
     this.reserve(reservedNames);
   }
 
   /**
-   *
    * @param {string[]} names
    */
   reserve(names) {
@@ -32,44 +37,59 @@ class NameResolver {
 
   /**
    *
-   * @param {string[]} variants
-   * @param {((variant: string) => string) | undefined} onSelectMutation
+   * @param {(string[]) | ((reserved: string[]) => string)} variantsOrResolver
    * @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;
+  resolve(variantsOrResolver) {
+    this.logger.debug("resolving name with using", variantsOrResolver);
+    if (Array.isArray(variantsOrResolver)) {
+      const variants = variantsOrResolver;
+      let usageName = null;
+      const uniqVariants = _.uniq(_.compact(variants));
+
+      _.forEach(uniqVariants, (variant) => {
+        if (!usageName && !this.isReserved(variant)) {
+          usageName = variant;
+        }
+      });
+
+      if (usageName) {
+        this.reserve([usageName]);
+        return usageName;
       }
-    });
 
-    if (usageName) {
-      this.reserve([usageName]);
-      return usageName;
-    }
+      this.logger.debug("trying to resolve name with using fallback name generator");
+      return this.resolve(this.getFallbackName);
+    } else if (typeof variantsOrResolver === "function") {
+      let usageName = null;
+      while (usageName === null) {
+        const variant = variantsOrResolver(this.reservedNames);
 
-    const defaultName = this.getDefaultName && this.getDefaultName(variants);
+        if (variant === undefined) {
+          this.logger.warn("unable to resolve name. current reserved names: ", this.reservedNames);
+          return null;
+        }
+        if (!this.isReserved(variant)) {
+          usageName = variant;
+        }
+      }
 
-    if (defaultName) {
-      this.reserve([onSelectMutation ? onSelectMutation(defaultName) : defaultName]);
-      return defaultName;
+      this.reserve([usageName]);
+      return usageName;
     }
 
+    this.logger.debug("problem with reserving names. current reserved names: ", this.reservedNames);
     return null;
   }
 }
 
 class SpecificArgNameResolver extends NameResolver {
   /**
-   *
+   * @param {Logger} logger;
    * @param {string[]} reservedNames
    */
-  constructor(reservedNames) {
-    super(reservedNames, (variants) => {
+  constructor(logger, reservedNames) {
+    super(logger, reservedNames, (variants) => {
       return (variants[0] && `${variants[0]}${getRandomInt(1, 10)}`) || `arg${getRandomInt(1, 10)}`;
     });
   }
@@ -77,18 +97,17 @@ class SpecificArgNameResolver extends NameResolver {
 
 class ComponentTypeNameResolver extends NameResolver {
   /**
-   *
+   * @param {Logger} logger;
    * @param {string[]} reservedNames
    */
-  constructor(reservedNames) {
-    super(reservedNames, (variants) => {
+  constructor(logger, reservedNames) {
+    super(logger, reservedNames, (variants) => {
       return (variants[0] && `${variants[0]}${getRandomInt(1, 10)}`) || `ComponentType${getRandomInt(1, 10)}`;
     });
   }
 }
 
 module.exports = {
-  NameResolver,
   SpecificArgNameResolver,
   ComponentTypeNameResolver,
 };

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

@@ -2,11 +2,8 @@
 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) { %>
+<% if (config.generateUnionEnums) { %>
   export type <%~ name %> = <%~ _.map($content, ({ value }) => value).join(" | ") %>
 <% } else { %>
   export enum <%~ name %> {

package/templates/base/http-clients/axios-http-client.ejs

@@ -33,6 +33,7 @@ export enum ContentType {
   Json = "application/json",
   FormData = "multipart/form-data",
   UrlEncoded = "application/x-www-form-urlencoded",
+  Text = "text/plain",
 }
 
 export class HttpClient<SecurityDataType = unknown> {
@@ -114,6 +115,10 @@ export class HttpClient<SecurityDataType = unknown> {
           body = this.createFormData(body as Record<string, unknown>);
         }
 
+        if (type === ContentType.Text && body && body !== null && typeof body !== "string") {
+          body = JSON.stringify(body);
+        }
+
         return this.instance.request({
             ...requestParams,
             headers: {

package/templates/base/http-clients/fetch-http-client.ejs

@@ -45,6 +45,7 @@ export enum ContentType {
     Json = "application/json",
     FormData = "multipart/form-data",
     UrlEncoded = "application/x-www-form-urlencoded",
+    Text = "text/plain",
 }
 
 export class HttpClient<SecurityDataType = unknown> {
@@ -102,6 +103,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
     private contentFormatters: Record<ContentType, (input: any) => any> = {
         [ContentType.Json]: (input:any) => input !== null && (typeof input === "object" || typeof input === "string") ? JSON.stringify(input) : input,
+        [ContentType.Text]: (input:any) => input !== null && typeof input !== "string" ? JSON.stringify(input) : input,
         [ContentType.FormData]: (input: any) =>
             Object.keys(input || {}).reduce((formData, key) => {
                 const property = input[key];

package/templates/default/procedure-call.ejs

@@ -50,6 +50,7 @@ const requestContentKind = {
     "JSON": "ContentType.Json",
     "URL_ENCODED": "ContentType.UrlEncoded",
     "FORM_DATA": "ContentType.FormData",
+    "TEXT": "ContentType.Text",
 }
 // RequestParams["format"]
 const responseContentKind = {

package/templates/modular/procedure-call.ejs

@@ -50,6 +50,7 @@ const requestContentKind = {
     "JSON": "ContentType.Json",
     "URL_ENCODED": "ContentType.UrlEncoded",
     "FORM_DATA": "ContentType.FormData",
+    "TEXT": "ContentType.Text",
 }
 // RequestParams["format"]
 const responseContentKind = {