Release 1.6.0 (#30)

* chore(refactor): make query params collect function more readable

* bump: up project version to 1.6.0 (see changes in changelog)

Co-authored-by: svolkov <[email protected]>

Author: js2me

CHANGELOG.md

@@ -1,5 +1,21 @@
 # next release
 
+# 1.6.0
+
+Features:
+
+- Improvenment in optional request params (request body, query params, path params)
+
+Fixes:
+
+- Fix bug when `path` request param have the same name as `query`
+- Fix bug when `path` request param have the same name as `params`
+
+Minor/Internal:
+
+- changed `addQueryParams()` method
+- up `swagger2openapi` dependency version to `5.3.4`
+
 # 1.5.0
 
 Features:

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "Create typescript api module from swagger schema",
   "scripts": {
     "cli": "node index.js -d -p ./swagger-test-cli.json -n swagger-test-cli.ts",
@@ -35,7 +35,7 @@
     "js-yaml": "^3.13.1",
     "lodash": "^4.17.15",
     "mustache": "^4.0.0",
-    "swagger2openapi": "^5.3.3",
+    "swagger2openapi": "^5.3.4",
     "prettier": "^1.19.1"
   },
   "bin": {

package.json

@@ -81,12 +81,7 @@ module.exports = {
               generateRouteTypes ? mustache.render(routeTypesTemplate, configuration) : "",
               generateClient ? mustache.render(clientTemplate, configuration) : "",
             ].join(""),
-            {
-              printWidth: 120,
-              tabWidth: 2,
-              trailingComma: "all",
-              parser: "typescript",
-            },
+            prettierConfig,
           );
 
           if (pathIsExist(output)) {

src/index.js

@@ -216,20 +216,59 @@ const parseRoutes = ({ paths }, parsedSchemas) =>
           ? getTypeFromRequestInfo(requestBody, parsedSchemas, operationId)
           : null;
 
-        const args = [
-          ...pathParams.map(param => ({
-            name: param.name,
-            type: parseSchema(param.schema, null, inlineExtraFormatters).content,
-          })),
-          queryType && {
-            name: "query",
-            type: queryType,
+        const pathArgs = _.map(pathParams, param => ({
+          name: param.name,
+          optional: !param.required,
+          type: parseSchema(param.schema, null, inlineExtraFormatters).content,
+        }));
+
+        const specificArgs = {
+          query: queryType
+            ? {
+                name: pathArgs.some(pathArg => pathArg.name === "query") ? "queryParams" : "query",
+                optional: parseSchema(queryObjectSchema, null).allFieldsAreOptional,
+                type: queryType,
+              }
+            : void 0,
+          body: bodyType
+            ? {
+                name: bodyParamName,
+                optional:
+                  typeof requestBody.required === "undefined" ? false : !requestBody.required,
+                type: bodyType,
+              }
+            : void 0,
+          requestParams: {
+            name: pathArgs.some(pathArg => pathArg.name === "params") ? "requestParams" : "params",
+            optional: true,
+            type: "RequestParams",
           },
-          bodyType && {
-            name: bodyParamName,
-            type: bodyType,
-          },
-        ].filter(Boolean);
+        };
+
+        let routeArgs = [...pathArgs, specificArgs.query, specificArgs.body].filter(Boolean);
+
+        if (routeArgs.some(pathArg => pathArg.optional)) {
+          const { optionalArgs, requiredArgs } = _.reduce(
+            [...routeArgs],
+            (acc, pathArg) => {
+              if (pathArg.optional) {
+                acc.optionalArgs.push(pathArg);
+              } else {
+                acc.requiredArgs.push(pathArg);
+              }
+
+              return acc;
+            },
+            {
+              optionalArgs: [],
+              requiredArgs: [],
+            },
+          );
+
+          routeArgs = [...requiredArgs, ...optionalArgs];
+        }
+
+        routeArgs.push(specificArgs.requestParams);
 
         // TODO: get args for formData
         // "name": "file",
@@ -275,7 +314,8 @@ const parseRoutes = ({ paths }, parsedSchemas) =>
           name,
           pascalName: _.upperFirst(name),
           comments,
-          args,
+          routeArgs,
+          specificArgs,
           method: _.upperCase(method),
           path: route.replace(/{/g, "${"),
           returnType: getReturnType(responses, parsedSchemas, operationId),