Release 1.11.0 (#66)

* chore: update tsoa-odd-types schema

* feat: improve the naming of data contract types (remove special characters)

* bump: up swagger-typescript-api version to 1.11.0

Author: js2me

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 .vscode
-swagger-test-cli.*
+swagger-test-cli.*
+dist

CHANGELOG.md

@@ -1,6 +1,11 @@
 # next release  
 
 
+# 1.11.0  
+
+Features:  
+- Improve the naming of model types ([#65 issue](https://github.com/acacode/swagger-typescript-api/issues/65))  
+
 # 1.10.0  
 
 Features:  

package-lock.json

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

package.json

@@ -1,28 +1,35 @@
-const _ = require("lodash")
+const _ = require("lodash");
 
-const isValidName = name => /^([A-Za-z$_]{1,})$/g.test(name)
+const isValidName = (name) => /^([A-Za-z$_]{1,})$/g.test(name);
 
-const checkAndRenameModelName = name => {
+const formattedModelNamesMap = new Map();
 
-  if (!isValidName(name)) {
+const checkAndRenameModelName = (name) => {
+  if (formattedModelNamesMap.has(name)) {
+    return formattedModelNamesMap.get(name);
+  }
 
+  if (!isValidName(name)) {
     // specific replaces for TSOA 3.x
-    if (name.includes('.'))
+    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(/__+$/, '');
-
-    if (name.includes('-'))
-      name = _.startCase(name).replace(/ /g, '')
+        .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(/__+$/, "");
+
+    if (name.includes("-")) name = _.startCase(name).replace(/ /g, "");
   }
 
-  return name;
-}
+  const formattedModelName = _.replace(_.startCase(name), /\s/g, "");
+
+  formattedModelNamesMap.set(name, formattedModelName);
+
+  return formattedModelName;
+};
 
 module.exports = {
   checkAndRenameModelName,
   isValidName,
-}
+};

src/modelNames.js

@@ -49,7 +49,7 @@ const getTypeFromRequestInfo = (requestInfo, parsedSchemas, operationId, content
     const { content } = parseSchema(schema, "none", inlineExtraFormatters);
     const foundedSchemaByName = _.find(
       parsedSchemas,
-      (parsedSchema) => parsedSchema.name === content,
+      (parsedSchema) => checkAndRenameModelName(parsedSchema.name) === content,
     );
     const foundSchemaByContent = _.find(parsedSchemas, (parsedSchema) =>
       _.isEqual(parsedSchema.content, content),

src/routes.js

@@ -42,7 +42,9 @@ const formatters = {
 
     return content;
   },
-  primitive: (content) => checkAndRenameModelName(content),
+  primitive: (content) => {
+    return content;
+  },
 };
 
 const inlineExtraFormatters = {