Release 9.1.0 (#256)

* feat: improve --type-suffix --type-prefix options

* fix: critical problem based on it.utils.require()

* internal: critical fix of type prefix/suffix for typeSuffixPrefix manual test

* fix: critical bug linked with type prefix\suffix with extracted params

* chore: change test script in github workflow

* bump: up version to 9.1.0; docs: update CHANGELOG;

Author: js2me

.github/workflows/main.yml

@@ -34,4 +34,4 @@ jobs:
 
       # Runs a set of commands using the runners shell
       - name: test
-        run: npm run test-all
+        run: npm run test-all-extended

.vscode/launch.json

@@ -59,6 +59,30 @@
       "cwd": "${workspaceFolder}",
       "runtimeExecutable": "npm",
       "runtimeArgs": ["run-script", "test-all"]
+    },
+    {
+      "name": "Debug test-all-extended",
+      "type": "node",
+      "request": "launch",
+      "cwd": "${workspaceFolder}",
+      "runtimeExecutable": "npm",
+      "runtimeArgs": ["run-script", "test-all-extended"]
+    },
+    {
+      "name": "Debug test:--extract-request-body",
+      "type": "node",
+      "request": "launch",
+      "cwd": "${workspaceFolder}",
+      "runtimeExecutable": "npm",
+      "runtimeArgs": ["run-script", "test:--extract-request-body"]
+    },
+    {
+      "name": "Debug test:--type-suffix--type-prefix",
+      "type": "node",
+      "request": "launch",
+      "cwd": "${workspaceFolder}",
+      "runtimeExecutable": "npm",
+      "runtimeArgs": ["run-script", "test:--type-suffix--type-prefix"]
     }
   ]
 }

CHANGELOG.md

@@ -1,5 +1,14 @@
 # next release  
 
+# 9.1.0  
+
+Fixes:  
+- Critical bug linked with `templateRequire` in ETA templates  
+- Critical bugs linked with `--type-prefix`, `--type-suffix`  
+
+Internal:  
+- Improve manual testing scripts  
+
 # 9.0.2  
 
 Fixes:  

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "9.0.2",
+  "version": "9.1.0",
   "description": "Generate typescript/javascript api from swagger schema",
   "scripts": {
     "cli:json": "node index.js -r -d -p ./swagger-test-cli.json -n swagger-test-cli.ts",
@@ -9,9 +9,12 @@
     "node:debug": "node --nolazy swagger-test-cli/generate.js",
     "contributors": "all-contributors generate",
     "cli:help": "node index.js -h",
-    "test-all": "node ./scriptsRunner.js generate validate test:*",
+    "test-all": "node --unhandled-rejections=strict ./scriptsRunner.js generate validate test:*",
+    "test-all-extended": "node --unhandled-rejections=strict ./scriptsRunner.js generate-extended validate generate validate test:*",
     "test-specific": "node ./scriptsRunner.js generate validate test:*",
+    "prepare": "npm run test-all-extended",
     "generate": "node tests/generate.js",
+    "generate-extended": "node tests/generate-extended.js",
     "generate:debug": "node --nolazy tests/generate.js",
     "validate": "node tests/validate.js",
     "validate:debug": "node --nolazy tests/validate.js",
@@ -27,6 +30,7 @@
     "test:--modular": "node tests/spec/modular/test.js",
     "test:--single-http-client": "node tests/spec/singleHttpClient/test.js",
     "test:--extract-request-params": "node tests/spec/extractRequestParams/test.js",
+    "test:--extract-request-body": "node tests/spec/extractRequestBody/test.js",
     "test:--enum-names-as-values": "node tests/spec/enumNamesAsValues/test.js",
     "test:--default-response": "node tests/spec/defaultResponse/test.js",
     "test:--js": "node tests/spec/js/test.js",
@@ -43,6 +47,7 @@
   "main": "src/index.js",
   "devDependencies": {
     "@types/lodash": "^4.14.166",
+    "@types/node": "^15.0.2",
     "@types/prettier": "^2.1.6",
     "all-contributors-cli": "^6.19.0",
     "husky": "^4.3.6",

package.json

@@ -18,6 +18,14 @@ const execute = (scriptName) =>
       process.stderr.write(data);
     });
 
+    spawned.on("error", (error) => {
+      console.error(error);
+    });
+
+    spawned.on("message", (message) => {
+      console.log(message);
+    });
+
     spawned.on("close", (code) => {
       if (code) {
         reject(code);
@@ -28,18 +36,22 @@ const execute = (scriptName) =>
   });
 
 const run = async () => {
-  for (const scriptName of packageScripts) {
-    for (const command of commands) {
-      if (scriptName === command) {
-        await execute(scriptName);
-      }
-
-      if (command.includes("*")) {
-        const commandPart = command.replace("*", "");
-        // TODO: refactor
-        if (scriptName.startsWith(commandPart) || scriptName.endsWith(commandPart)) {
+  for (const command of commands) {
+    for (const scriptName of packageScripts) {
+      try {
+        if (scriptName === command) {
           await execute(scriptName);
         }
+
+        if (command.includes("*")) {
+          const commandPart = command.replace("*", "");
+          // TODO: refactor
+          if (scriptName.startsWith(commandPart) || scriptName.endsWith(commandPart)) {
+            await execute(scriptName);
+          }
+        }
+      } catch (e) {
+        process.exit(1);
       }
     }
   }

scriptsRunner.js

@@ -27,35 +27,52 @@ const fixModelName = (name) => {
   return name;
 };
 
-const formatModelName = (name) => {
+/**
+ *
+ * @param {string} name
+ * @param {{ ignorePrefix?: boolean; ignoreSuffix?: boolean }} options
+ * @returns
+ */
+const formatModelName = (name, options) => {
+  const typePrefix = options && options.ignorePrefix ? "" : config.typePrefix;
+  const typeSuffix = options && options.ignoreSuffix ? "" : config.typeSuffix;
+  const hashKey = `${typePrefix}_${name}_${typeSuffix}`;
+
   if (typeof name !== "string") {
     logger.warn("wrong name of the model name", name);
     return name;
   }
 
   if (/^([A-Z_]{1,})$/g.test(name)) {
-    return name;
+    return _.compact([typePrefix, name, typeSuffix]).join("_");
   }
 
-  if (formattedModelNamesMap.has(name)) {
-    return formattedModelNamesMap.get(name);
+  if (formattedModelNamesMap.has(hashKey)) {
+    return formattedModelNamesMap.get(hashKey);
   }
 
   const fixedModelName = fixModelName(name);
 
   const formattedModelName = _.replace(
-    _.startCase(`${config.typePrefix}_${fixedModelName}_${config.typeSuffix}`),
+    _.startCase(`${typePrefix}_${fixedModelName}_${typeSuffix}`),
     /\s/g,
     "",
   );
   const modelName = config.hooks.onFormatTypeName(formattedModelName, name) || formattedModelName;
 
-  formattedModelNamesMap.set(name, modelName);
+  formattedModelNamesMap.set(hashKey, modelName);
 
   return modelName;
 };
 
+const formatEnumKey = (key) =>
+  formatModelName(key, {
+    ignorePrefix: true,
+    ignoreSuffix: true,
+  });
+
 module.exports = {
   formatModelName: formatModelName,
+  formatEnumKey: formatEnumKey,
   isValidName,
 };

src/modelNames.js

@@ -13,7 +13,7 @@ const prepareModelType = (typeInfo) => {
   let { typeIdentifier, name: originalName, content, type, description } = typeData;
 
   const resultContent = formatters[type] ? formatters[type](content) : content;
-  const name = formatModelName(originalName || typeInfo.typeName);
+  const name = formatModelName(originalName);
 
   return {
     typeIdentifier,

src/modelTypes.js

@@ -19,5 +19,5 @@ module.exports = {
   fmtToJSDocLine: require("./fmtToJSDocLine"),
   NameResolver: NameResolver,
   _: require("lodash"),
-  require: require("./templateRequire"),
+  require: require("./templateRequire").templateRequire,
 };

src/render/utils/index.js

@@ -46,13 +46,19 @@ const getSchemaFromRequestType = (requestInfo) => {
   return null;
 };
 
-const getTypeFromRequestInfo = ({ requestInfo, parsedSchemas, operationId, defaultType }) => {
+const getTypeFromRequestInfo = ({
+  requestInfo,
+  parsedSchemas,
+  operationId,
+  defaultType,
+  typeName,
+}) => {
   // TODO: make more flexible pick schema without content type
   const schema = getSchemaFromRequestType(requestInfo);
   const refTypeInfo = getRefType(requestInfo);
 
   if (schema) {
-    const content = getInlineParseContent(schema, "none");
+    const content = getInlineParseContent(schema, typeName);
     const foundedSchemaByName = _.find(
       parsedSchemas,
       (parsedSchema) => formatModelName(parsedSchema.name) === content,
@@ -81,9 +87,12 @@ const getTypeFromRequestInfo = ({ requestInfo, parsedSchemas, operationId, defau
         return formatModelName(refTypeInfo.typeName);
       case "responses":
       case "requestBodies":
-        return getInlineParseContent(getSchemaFromRequestType(refTypeInfo.rawTypeData), "none");
+        return getInlineParseContent(
+          getSchemaFromRequestType(refTypeInfo.rawTypeData),
+          refTypeInfo.typeName || null,
+        );
       default:
-        return getInlineParseContent(refTypeInfo.rawTypeData, "none");
+        return getInlineParseContent(refTypeInfo.rawTypeData, refTypeInfo.typeName || null);
     }
   }
 
@@ -396,13 +405,23 @@ const getRequestBodyInfo = (routeInfo, routeParams, parsedSchemas, routeName) =>
   );
   let contentKind = getContentKind(contentTypes);
 
+  let typeName = null;
+
+  if (config.extractRequestBody) {
+    typeName = config.componentTypeNameResolver.resolve([
+      classNameCase(`${routeName.usage} Payload`),
+      classNameCase(`${routeName.usage} Body`),
+      classNameCase(`${routeName.usage} Input`),
+    ]);
+  }
+
   if (routeParams.formData.length) {
     contentKind = CONTENT_KIND.FORM_DATA;
     schema = convertRouteParamsIntoObject(routeParams.formData);
-    type = getInlineParseContent(schema);
+    type = getInlineParseContent(schema, typeName);
   } else if (contentKind === CONTENT_KIND.FORM_DATA) {
     schema = getSchemaFromRequestType(requestBody);
-    type = getInlineParseContent(schema);
+    type = getInlineParseContent(schema, typeName);
   } else if (requestBody) {
     schema = getSchemaFromRequestType(requestBody);
     type = checkAndAddNull(
@@ -411,6 +430,7 @@ const getRequestBodyInfo = (routeInfo, routeParams, parsedSchemas, routeName) =>
         requestInfo: requestBody,
         parsedSchemas,
         operationId,
+        typeName,
       }),
     );
 
@@ -423,13 +443,8 @@ const getRequestBodyInfo = (routeInfo, routeParams, parsedSchemas, routeName) =>
   }
 
   if (schema && !schema.$ref && config.extractRequestBody) {
-    const typeName = config.componentTypeNameResolver.resolve([
-      classNameCase(`${routeName.usage} Payload`),
-      classNameCase(`${routeName.usage} Body`),
-      classNameCase(`${routeName.usage} Input`),
-    ]);
     schema = createComponent("schemas", typeName, { ...schema });
-    type = typeName;
+    type = getInlineParseContent(schema);
   }
 
   return {