swagger-typescript-api 10.0.2 → 10.0.3

package/src/typeFormatters.js

@@ -1,121 +1,121 @@
-const _ = require("lodash");
-const { config } = require("./config");
-const { TS_KEYWORDS, SCHEMA_TYPES, TS_EXTERNAL } = require("./constants");
-
-const checkAndAddNull = (schema, value) => {
-  const { nullable, type } = schema || {};
-  return (nullable || !!_.get(schema, "x-nullable") || type === TS_KEYWORDS.NULL) &&
-    _.isString(value) &&
-    !value.includes(` ${TS_KEYWORDS.NULL}`) &&
-    !value.includes(`${TS_KEYWORDS.NULL} `)
-    ? `${value} | ${TS_KEYWORDS.NULL}`
-    : value;
-};
-
-const formatters = {
-  [SCHEMA_TYPES.ENUM]: (parsedSchema) => {
-    const isNumberEnum = _.some(parsedSchema.content, (content) => typeof content.key === "number");
-    const formatAsUnionType = !!(isNumberEnum || config.generateUnionEnums);
-
-    if (formatAsUnionType) {
-      return {
-        ...parsedSchema,
-        $content: parsedSchema.content,
-        content: _.map(parsedSchema.content, ({ value }) => value).join(" | "),
-      };
-    }
-
-    return {
-      ...parsedSchema,
-      $content: parsedSchema.content,
-      content: _.map(parsedSchema.content, ({ key, value }) => `  ${key} = ${value}`).join(",\n"),
-    };
-  },
-  [SCHEMA_TYPES.OBJECT]: (parsedSchema) => {
-    if (parsedSchema.nullable) return inlineExtraFormatters[SCHEMA_TYPES.OBJECT](parsedSchema);
-    return {
-      ...parsedSchema,
-      $content: parsedSchema.content,
-      content: formatObjectContent(parsedSchema.content),
-    };
-  },
-  [SCHEMA_TYPES.PRIMITIVE]: (parsedSchema) => {
-    return {
-      ...parsedSchema,
-      $content: parsedSchema.content,
-    };
-  },
-};
-
-/** transform content of parsed schema to string or compact size */
-const inlineExtraFormatters = {
-  [SCHEMA_TYPES.OBJECT]: (parsedSchema) => {
-    if (_.isString(parsedSchema.content)) {
-      return {
-        ...parsedSchema,
-        typeIdentifier: TS_KEYWORDS.TYPE,
-        content: checkAndAddNull(parsedSchema.content),
-      };
-    }
-
-    return {
-      ...parsedSchema,
-      typeIdentifier: TS_KEYWORDS.TYPE,
-      content: checkAndAddNull(
-        parsedSchema,
-        parsedSchema.content.length ? `{\n${formatObjectContent(parsedSchema.content)}\n}` : TS_EXTERNAL.RECORD,
-      ),
-    };
-  },
-  [SCHEMA_TYPES.ENUM]: (parsedSchema) => {
-    return {
-      ...parsedSchema,
-      content: parsedSchema.$ref
-        ? parsedSchema.typeName
-        : _.uniq(
-            _.compact([
-              ..._.map(parsedSchema.content, ({ value }) => `${value}`),
-              parsedSchema.nullable && TS_KEYWORDS.NULL,
-            ]),
-          ).join(" | "),
-    };
-  },
-};
-
-const formatObjectContent = (content) => {
-  return _.map(content, (part) => {
-    const extraSpace = "  ";
-    const result = `${extraSpace}${part.field},\n`;
-
-    const comments = _.uniq(
-      _.compact([
-        part.title,
-        part.description,
-        part.deprecated && ` * @deprecated`,
-        !_.isUndefined(part.format) && `@format ${part.format}`,
-        !_.isUndefined(part.minimum) && `@min ${part.minimum}`,
-        !_.isUndefined(part.maximum) && `@max ${part.maximum}`,
-        !_.isUndefined(part.pattern) && `@pattern ${part.pattern}`,
-        !_.isUndefined(part.example) &&
-          `@example ${_.isObject(part.example) ? JSON.stringify(part.example) : part.example}`,
-      ]).reduce((acc, comment) => [...acc, ...comment.split(/\n/g)], []),
-    );
-
-    const commonText = comments.length
-      ? [
-          ...(comments.length === 1
-            ? [`/** ${comments[0]} */`]
-            : ["/**", ...comments.map((commentPart) => ` * ${commentPart}`), " */"]),
-        ]
-          .map((part) => `${extraSpace}${part}\n`)
-          .join("")
-      : "";
-
-    return `${commonText}${result}`;
-  }).join("");
-};
-
-module.exports = {
-  formatters,
-  inlineExtraFormatters,
-};
+const _ = require("lodash");
+const { config } = require("./config");
+const { TS_KEYWORDS, SCHEMA_TYPES, TS_EXTERNAL } = require("./constants");
+
+const checkAndAddNull = (schema, value) => {
+  const { nullable, type } = schema || {};
+  return (nullable || !!_.get(schema, "x-nullable") || type === TS_KEYWORDS.NULL) &&
+    _.isString(value) &&
+    !value.includes(` ${TS_KEYWORDS.NULL}`) &&
+    !value.includes(`${TS_KEYWORDS.NULL} `)
+    ? `${value} | ${TS_KEYWORDS.NULL}`
+    : value;
+};
+
+const formatters = {
+  [SCHEMA_TYPES.ENUM]: (parsedSchema) => {
+    const isNumberEnum = _.some(parsedSchema.content, (content) => typeof content.key === "number");
+    const formatAsUnionType = !!(isNumberEnum || config.generateUnionEnums);
+
+    if (formatAsUnionType) {
+      return {
+        ...parsedSchema,
+        $content: parsedSchema.content,
+        content: _.map(parsedSchema.content, ({ value }) => value).join(" | "),
+      };
+    }
+
+    return {
+      ...parsedSchema,
+      $content: parsedSchema.content,
+      content: _.map(parsedSchema.content, ({ key, value }) => `  ${key} = ${value}`).join(",\n"),
+    };
+  },
+  [SCHEMA_TYPES.OBJECT]: (parsedSchema) => {
+    if (parsedSchema.nullable) return inlineExtraFormatters[SCHEMA_TYPES.OBJECT](parsedSchema);
+    return {
+      ...parsedSchema,
+      $content: parsedSchema.content,
+      content: formatObjectContent(parsedSchema.content),
+    };
+  },
+  [SCHEMA_TYPES.PRIMITIVE]: (parsedSchema) => {
+    return {
+      ...parsedSchema,
+      $content: parsedSchema.content,
+    };
+  },
+};
+
+/** transform content of parsed schema to string or compact size */
+const inlineExtraFormatters = {
+  [SCHEMA_TYPES.OBJECT]: (parsedSchema) => {
+    if (_.isString(parsedSchema.content)) {
+      return {
+        ...parsedSchema,
+        typeIdentifier: TS_KEYWORDS.TYPE,
+        content: checkAndAddNull(parsedSchema.content),
+      };
+    }
+
+    return {
+      ...parsedSchema,
+      typeIdentifier: TS_KEYWORDS.TYPE,
+      content: checkAndAddNull(
+        parsedSchema,
+        parsedSchema.content.length ? `{\n${formatObjectContent(parsedSchema.content)}\n}` : TS_EXTERNAL.RECORD,
+      ),
+    };
+  },
+  [SCHEMA_TYPES.ENUM]: (parsedSchema) => {
+    return {
+      ...parsedSchema,
+      content: parsedSchema.$ref
+        ? parsedSchema.typeName
+        : _.uniq(
+            _.compact([
+              ..._.map(parsedSchema.content, ({ value }) => `${value}`),
+              parsedSchema.nullable && TS_KEYWORDS.NULL,
+            ]),
+          ).join(" | "),
+    };
+  },
+};
+
+const formatObjectContent = (content) => {
+  return _.map(content, (part) => {
+    const extraSpace = "  ";
+    const result = `${extraSpace}${part.field},\n`;
+
+    const comments = _.uniq(
+      _.compact([
+        part.title,
+        part.description,
+        part.deprecated && ` * @deprecated`,
+        !_.isUndefined(part.format) && `@format ${part.format}`,
+        !_.isUndefined(part.minimum) && `@min ${part.minimum}`,
+        !_.isUndefined(part.maximum) && `@max ${part.maximum}`,
+        !_.isUndefined(part.pattern) && `@pattern ${part.pattern}`,
+        !_.isUndefined(part.example) &&
+          `@example ${_.isObject(part.example) ? JSON.stringify(part.example) : part.example}`,
+      ]).reduce((acc, comment) => [...acc, ...comment.split(/\n/g)], []),
+    );
+
+    const commonText = comments.length
+      ? [
+          ...(comments.length === 1
+            ? [`/** ${comments[0]} */`]
+            : ["/**", ...comments.map((commentPart) => ` * ${commentPart}`), " */"]),
+        ]
+          .map((part) => `${extraSpace}${part}\n`)
+          .join("")
+      : "";
+
+    return `${commonText}${result}`;
+  }).join("");
+};
+
+module.exports = {
+  formatters,
+  inlineExtraFormatters,
+};

package/src/utils/id.js

@@ -1,9 +1,9 @@
-const { customAlphabet } = require("nanoid");
-
-const ALPHABET = "abcdefghijklmnopqrstuvwxyz0123456789";
-
-const generateId = customAlphabet(ALPHABET, 12);
-
-module.exports = {
-  generateId,
-};
+const { customAlphabet } = require("nanoid");
+
+const ALPHABET = "abcdefghijklmnopqrstuvwxyz0123456789";
+
+const generateId = customAlphabet(ALPHABET, 12);
+
+module.exports = {
+  generateId,
+};

package/src/utils/random.js

@@ -1,14 +1,14 @@
-const getRandomFloat = (min = 0, max = 1) => {
-  return Math.random() * (max - min) + min;
-};
-
-const getRandomInt = (min = 0, max = 1) => {
-  if (min === max) return min;
-
-  return Math.round(getRandomFloat(min, max));
-};
-
-module.exports = {
-  getRandomFloat,
-  getRandomInt,
-};
+const getRandomFloat = (min = 0, max = 1) => {
+  return Math.random() * (max - min) + min;
+};
+
+const getRandomInt = (min = 0, max = 1) => {
+  if (min === max) return min;
+
+  return Math.round(getRandomFloat(min, max));
+};
+
+module.exports = {
+  getRandomFloat,
+  getRandomInt,
+};

package/src/utils/resolveName.js

@@ -1,97 +1,94 @@
-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/base/route-docs.ejs

@@ -21,8 +21,7 @@ const jsDocLines = _.compact([
             ` * @response \`${status}\` \`${_.replace(_.replace(type, /\/\*/g, "\\*"), /\*\//g, "*\\")}\` ${description}`,
         )
     : []),
-]).join("\n");
-
+]).map(str => str.trimEnd()).join("\n");
 
 return {
   description: jsDocDescription,

package/templates/default/procedure-call.ejs

@@ -81,7 +81,7 @@ const describeReturnType = () => {
 /**
 <%~ routeDocs.description %>
 
- * <% /* Here you can add some other JSDoc tags */ %>
+ *<% /* Here you can add some other JSDoc tags */ %>
 
 <%~ routeDocs.lines %>
 
@@ -96,4 +96,4 @@ const describeReturnType = () => {
         <%~ bodyContentKindTmpl ? `type: ${bodyContentKindTmpl},` : '' %>
         <%~ responseFormatTmpl ? `format: ${responseFormatTmpl},` : '' %>
         ...<%~ _.get(requestConfigParam, "name") %>,
-    })<%~ route.namespace ? ',' : '' %>
+    })<%~ route.namespace ? ',' : '' %>

package/templates/modular/procedure-call.ejs

@@ -81,7 +81,7 @@ const describeReturnType = () => {
 /**
 <%~ routeDocs.description %>
 
- * <% /* Here you can add some other JSDoc tags */ %>
+ *<% /* Here you can add some other JSDoc tags */ %>
 
 <%~ routeDocs.lines %>
 
@@ -96,4 +96,4 @@ const describeReturnType = () => {
         <%~ bodyContentKindTmpl ? `type: ${bodyContentKindTmpl},` : '' %>
         <%~ responseFormatTmpl ? `format: ${responseFormatTmpl},` : '' %>
         ...<%~ _.get(requestConfigParam, "name") %>,
-    })
+    })