fix: problems with using generated swagger schemas from tsoa 3.x

Author: svolkov

CHANGELOG.md

@@ -1,6 +1,8 @@
 # 1.2.5  
 Features: better naming of routes without `operationId`  
 ![route naming](./assets/changelog_assets/1.2.5_route_naming.jpg)  
+Changes: rename `@security true` -> `@secure`, `@duplicate true` -> `@duplicate`  
+Fixes: Support tsoa 3.x usage with complex types  
 
 # 1.2.4  
 Features: add .d.ts file into npm package  

src/modelNames.js

@@ -0,0 +1,21 @@
+
+const checkAndRenameModelName = name => {
+
+  if (!/^([A-Za-z$_]{1,})$/g.test(name)) {
+    // specific replaces for TSOA 3.x
+
+    if (name.includes('.'))
+      name = name
+        .replace(/Exclude_keyof[A-Za-z]{1,}/g, match => 'ExcludeKeys')
+        .replace(/%22\~AND\~%22/g, 'And')
+        .replace(/%22\~OR\~%22/g, 'Or')
+        .replace(/(\.?%22)|\./g, '_')
+        .replace(/__+$/, '');
+  }
+
+  return name;
+}
+
+module.exports = {
+  checkAndRenameModelName
+}

src/modelTypes.js

@@ -1,5 +1,6 @@
 const _ = require('lodash');
 const { formatters } = require("./typeFormatters");
+const { checkAndRenameModelName } = require("./modelNames");
 
 const CONTENT_KEYWORD = '__CONTENT__';
 
@@ -10,12 +11,13 @@ const contentWrapersByTypeIdentifier = {
 }
 
 // { typeIdentifier, name, content, type }
-const getModelType = ({ typeIdentifier, name, content, type, description }) => {
+const getModelType = ({ typeIdentifier, name: originalName, content, type, description }) => {
   if (!contentWrapersByTypeIdentifier[typeIdentifier]) {
     throw new Error(`${typeIdentifier} - type identifier is unknown for this utility`)
   }
 
   const resultContent = formatters[type] ? formatters[type](content) : content;
+  const name = checkAndRenameModelName(originalName);
 
   return {
     typeIdentifier,
@@ -26,7 +28,7 @@ const getModelType = ({ typeIdentifier, name, content, type, description }) => {
   }
 }
 
-
 module.exports = {
   getModelType,
-}
+  checkAndRenameModelName,
+}

src/routes.js

@@ -1,5 +1,6 @@
 const _ = require("lodash");
 const { parseSchema } = require("./schema");
+const { checkAndRenameModelName } = require("./modelNames");
 const { inlineExtraFormatters } = require("./typeFormatters");
 
 const methodAliases = {
@@ -18,7 +19,8 @@ const getTypeFromRequestInfo = (requestInfo, parsedSchemas, contentType) => {
     const extractedSchema = _.get(schema, 'additionalProperties', schema);
     const { content } = parseSchema(extractedSchema, 'none', inlineExtraFormatters);
     const foundSchema = _.find(parsedSchemas, parsedSchema => _.isEqual(parsedSchema.content, content))
-    return foundSchema ? foundSchema.name : content;
+
+    return foundSchema ? foundSchema.name : checkAndRenameModelName(content);
   }
 
   return 'any';

src/schema.js

@@ -15,7 +15,7 @@ const findSchemaType = schema => {
 const typeAliases = {
   "integer": "number",
 }
-const getTypeAlias = type => typeAliases[type] || type || 'any'
+const getPrimitiveType = type => typeAliases[type] || type || 'any'
 
 const specificObjectTypes = {
   'array': ({ items }) => {
@@ -25,7 +25,7 @@ const specificObjectTypes = {
 }
 const getRefType = (ref) => _.last(_.split(ref, '/'))
 const getType = (property) => {
-  const func = specificObjectTypes[property.type] || (() => getTypeAlias(property.type))
+  const func = specificObjectTypes[property.type] || (() => getPrimitiveType(property.type))
   return property["$ref"] ? getRefType(property["$ref"]) : func(property)
 }
 const getObjectTypeContent = (properties) => {
@@ -73,7 +73,7 @@ const getComplexType = (schema) => {
 
 const schemaParsers = {
   'enum': (schema, typeName) => {
-    const type = getTypeAlias(schema.type);
+    const type = getPrimitiveType(schema.type);
     const isIntegerEnum = type === "number";
     return {
       type: isIntegerEnum ? "intEnum" : 'enum',
@@ -136,4 +136,5 @@ const parseSchema = (schema, typeName, formattersMap) => {
 module.exports = {
   parseSchema,
   getType,
+  getPrimitiveType,
 }

src/typeFormatters.js

@@ -1,4 +1,5 @@
 const _ = require('lodash');
+const { checkAndRenameModelName } = require("./modelNames");
 
 const formatters = {
   'enum': content => _.map(content, ({ key, value }) => `  ${key} = ${value}`).join(',\n'),
@@ -15,7 +16,19 @@ const formatters = {
     }
 
     return result;
-  }).join('')
+  }).join(''),
+  'type': content => {
+    if (content.includes(' & ')) {
+      return content.split(' & ').map(checkAndRenameModelName).join(' & ')
+    }
+
+    if (content.includes(' | ')) {
+      return content.split(' | ').map(checkAndRenameModelName).join(' | ')
+    }
+
+    return content
+  },
+  'primitive': content =>checkAndRenameModelName(content),
 }
 
 const inlineExtraFormatters = {