swagger-typescript-api 11.1.1 → 11.1.3

package/index.d.ts

@@ -315,6 +315,7 @@ export enum RequestContentKind {
   FORM_DATA = "FORM_DATA",
   IMAGE = "IMAGE",
   OTHER = "OTHER",
+  TEXT = "TEXT",
 }
 
 export interface RequestResponseInfo {

package/index.js

@@ -308,7 +308,9 @@ const main = async () => {
   } catch (e) {
     console.error(e);
     process.exit(1);
+    return;
   }
+  process.exit(0);
 };
 
 main();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "11.1.1",
+  "version": "11.1.3",
   "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",
@@ -38,6 +38,7 @@
     "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",
+    "test:jsSingleHttpClientModular": "node tests/spec/jsSingleHttpClientModular/test.js",
     "test:--js--axios": "node tests/spec/jsAxios/test.js",
     "test:--axios": "node tests/spec/axios/test.js",
     "test:--another-array-type": "node tests/spec/another-array-type/test.js",
@@ -46,11 +47,16 @@
     "test:--type-suffix--type-prefix": "node tests/spec/typeSuffixPrefix/test.js",
     "test:--dot-path-params": "node tests/spec/dot-path-params/test.js",
     "test:--primitive-type-constructs": "node tests/spec/primitive-type-constructs/test.js",
-    "test:--cli": "node index.js -p tests/spec/cli/schema.json -o tests/spec/cli -n schema.ts --extract-response-body --extract-response-error --api-class-name MySuperApi --type-prefix Prefix",
+    "test:--cli": "node index.js -p tests/spec/cli/schema.json -o tests/spec/cli -n schema.ts --extract-response-body --extract-response-error --api-class-name MySuperApi --type-prefix Prefix && node tests/spec/cli/test.js",
     "test:partialBaseTemplate": "node tests/spec/partialBaseTemplate/test.js",
     "test:partialDefaultTemplate": "node tests/spec/partialDefaultTemplate/test.js",
     "test:--patch": "node tests/spec/patch/test.js",
-    "test:deprecated": "node tests/spec/deprecated/test.js"
+    "test:deprecated": "node tests/spec/deprecated/test.js",
+    "test:nullableRefTest3.0": "node tests/spec/nullable-3.0/test.js",
+    "test:nullableRefTest2.0": "node tests/spec/nullable-2.0/test.js",
+    "test:additionalProperties2.0": "node tests/spec/additional-properties-2.0/test.js",
+    "test:enums2.0": "node tests/spec/enums-2.0/test.js",
+    "test:another-query-params": "node tests/spec/another-query-params/test.js"
   },
   "author": "acacode",
   "license": "MIT",
@@ -61,6 +67,7 @@
     "@types/node": "^18.11.7",
     "@types/prettier": "^2.7.1",
     "all-contributors-cli": "^6.20.0",
+    "axios": "^1.1.3",
     "cross-env": "^7.0.3",
     "git-diff": "^2.0.6",
     "husky": "^4.3.6",

package/src/schema-parser/schema-parser.js

@@ -149,7 +149,7 @@ class SchemaParser {
       });
     },
     [SCHEMA_TYPES.OBJECT]: (schema, typeName) => {
-      const content = this.getObjectSchemaContent(schema);
+      const contentProperties = this.getObjectSchemaContent(schema);
 
       return this.attachParsedRef(schema, {
         ...(_.isObject(schema) ? schema : {}),
@@ -159,8 +159,8 @@ class SchemaParser {
         typeIdentifier: this.config.Ts.Keyword.Interface,
         name: typeName,
         description: this.schemaFormatters.formatDescription(schema.description),
-        allFieldsAreOptional: !_.some(_.values(content), (part) => part.isRequired),
-        content: content,
+        allFieldsAreOptional: !_.some(_.values(contentProperties), (part) => part.isRequired),
+        content: contentProperties,
       });
     },
     [SCHEMA_TYPES.COMPLEX]: (schema, typeName) => {
@@ -424,7 +424,7 @@ class SchemaParser {
       };
     });
 
-    if (additionalProperties === true) {
+    if (additionalProperties) {
       propertiesContent.push({
         $$raw: { additionalProperties },
         description: "",

package/src/schema-parser/schema-routes.js

@@ -16,6 +16,7 @@ const CONTENT_KIND = {
   FORM_DATA: "FORM_DATA",
   IMAGE: "IMAGE",
   OTHER: "OTHER",
+  TEXT: "TEXT",
 };
 
 class SchemaRoutes {
@@ -103,25 +104,24 @@ class SchemaRoutes {
           this.logger.warn("wrong path param name", paramName);
         }
 
-        return [
-          ...pathParams,
-          {
-            $match: match,
-            name: _.camelCase(paramName),
-            required: true,
+        pathParams.push({
+          $match: match,
+          name: _.camelCase(paramName),
+          required: true,
+          type: "string",
+          description: "",
+          schema: {
             type: "string",
-            description: "",
-            schema: {
-              type: "string",
-            },
-            in: "path",
           },
-        ];
+          in: "path",
+        });
+
+        return pathParams;
       },
       [],
     );
 
-    const fixedRoute = _.reduce(
+    let fixedRoute = _.reduce(
       pathParams,
       (fixedRoute, pathParam) => {
         return _.replace(fixedRoute, pathParam.$match, `\${${pathParam.name}}`);
@@ -129,14 +129,47 @@ class SchemaRoutes {
       routeName || "",
     );
 
+    const queryParamMatches = fixedRoute.match(/(\{\?.*\})/g);
+    const queryParams = [];
+
+    if (queryParamMatches && queryParamMatches.length) {
+      queryParamMatches.forEach((match) => {
+        fixedRoute = fixedRoute.replace(match, "");
+      });
+
+      _.uniq(
+        queryParamMatches
+          .join(",")
+          .replace(/(\{\?)|(\})|\s/g, "")
+          .split(","),
+      ).forEach((paramName) => {
+        if (_.includes(paramName, "-")) {
+          this.logger.warn("wrong query param name", paramName);
+        }
+
+        queryParams.push({
+          $match: paramName,
+          name: _.camelCase(paramName),
+          required: true,
+          type: "string",
+          description: "",
+          schema: {
+            type: "string",
+          },
+          in: "query",
+        });
+      });
+    }
+
     return {
       originalRoute: routeName || "",
       route: fixedRoute,
       pathParams,
+      queryParams,
     };
   };
 
-  getRouteParams = (routeInfo, pathParams) => {
+  getRouteParams = (routeInfo, pathParamsFromRouteName, queryParamsFromRouteName) => {
     const { parameters } = routeInfo;
 
     const routeParams = {
@@ -186,13 +219,21 @@ class SchemaRoutes {
     });
 
     // used in case when path parameters is not declared in requestInfo.parameters ("in": "path")
-    _.each(pathParams, (pathParam) => {
+    _.each(pathParamsFromRouteName, (pathParam) => {
       const alreadyExist = _.some(routeParams.path, (parameter) => parameter.name === pathParam.name);
 
       if (!alreadyExist) {
         routeParams.path.push(pathParam);
       }
     });
+    // used in case when path parameters is not declared in requestInfo.parameters ("in": "path")
+    _.each(queryParamsFromRouteName, (queryParam) => {
+      const alreadyExist = _.some(routeParams.query, (parameter) => parameter.name === queryParam.name);
+
+      if (!alreadyExist) {
+        routeParams.query.push(queryParam);
+      }
+    });
 
     return routeParams;
   };
@@ -207,7 +248,7 @@ class SchemaRoutes {
 
   getContentKind = (contentTypes) => {
     if (
-      _.includes(contentTypes, "application/json") ||
+      _.some(contentTypes, (contentType) => _.startsWith(contentType, "application/json")) ||
       _.some(contentTypes, (contentType) => _.endsWith(contentType, "+json"))
     ) {
       return CONTENT_KIND.JSON;
@@ -225,6 +266,12 @@ class SchemaRoutes {
       return CONTENT_KIND.IMAGE;
     }
 
+    if (
+        _.some(contentTypes, (contentType) => _.startsWith(contentType, "text/"))
+    ) {
+      return CONTENT_KIND.TEXT;
+    }
+
     return CONTENT_KIND.OTHER;
   };
 
@@ -642,7 +689,11 @@ class SchemaRoutes {
       consumes,
       ...otherInfo
     } = routeInfo;
-    const { route, pathParams } = this.parseRouteName(rawRouteName);
+    const {
+      route,
+      pathParams: pathParamsFromRouteName,
+      queryParams: queryParamsFromRouteName,
+    } = this.parseRouteName(rawRouteName);
 
     const routeId = generateId();
     const firstTag = tags && tags.length > 0 ? tags[0] : null;
@@ -655,7 +706,7 @@ class SchemaRoutes {
       hasSecurity = security.length > 0;
     }
 
-    const routeParams = this.getRouteParams(routeInfo, pathParams);
+    const routeParams = this.getRouteParams(routeInfo, pathParamsFromRouteName, queryParamsFromRouteName);
 
     const pathArgs = routeParams.path.map((pathArgSchema) => ({
       name: pathArgSchema.name,

package/src/translators/JavaScript.js

@@ -1,49 +1,60 @@
-const ts = require("typescript");
-
-function translate(fileName, content, options) {
-  const output = {};
-  const host = ts.createCompilerHost(options, true);
-  const fileNames = [fileName];
-  const originalSourceFileGet = host.getSourceFile.bind(host);
-  host.getSourceFile = (sourceFileName, languageVersion, onError, shouldCreateNewSourceFile) => {
-    if (sourceFileName !== fileName)
-      return originalSourceFileGet(sourceFileName, languageVersion, onError, shouldCreateNewSourceFile);
-
-    return ts.createSourceFile(sourceFileName, content, languageVersion, true, ts.ScriptKind.External);
-  };
-
-  host.writeFile = (fileName, contents) => {
-    output[fileName] = contents;
-  };
-
-  ts.createProgram(fileNames, options, host).emit();
-
-  return output;
-}
-
-module.exports = {
-  translate: (fileName, sourceTypeScript) => {
-    const translated = translate(fileName, sourceTypeScript, {
-      module: "ESNext",
-      noImplicitReturns: true,
-      alwaysStrict: true,
-      target: ts.ScriptTarget.ESNext,
-      declaration: true,
-      noImplicitAny: false,
-      sourceMap: false,
-      removeComments: false,
-      disableSizeLimit: true,
-      esModuleInterop: true,
-      emitDecoratorMetadata: true,
-      skipLibCheck: true,
-    });
-
-    const sourceFileName = fileName.replace(ts.Extension.Ts, ts.Extension.Js);
-    const declarationFileName = fileName.replace(ts.Extension.Ts, ts.Extension.Dts);
-
-    return {
-      sourceContent: translated[sourceFileName],
-      declarationContent: translated[declarationFileName],
-    };
-  },
-};
+const ts = require("typescript");
+
+function translate(fileName, content, options) {
+  const output = {};
+  const host = ts.createCompilerHost(options, true);
+  const fileNames = [fileName];
+  const originalSourceFileGet = host.getSourceFile.bind(host);
+  host.getSourceFile = (sourceFileName, languageVersion, onError, shouldCreateNewSourceFile) => {
+    if (sourceFileName !== fileName)
+      return originalSourceFileGet(sourceFileName, languageVersion, onError, shouldCreateNewSourceFile);
+
+    return ts.createSourceFile(sourceFileName, content, languageVersion, true, ts.ScriptKind.External);
+  };
+
+  host.writeFile = (fileName, contents) => {
+    output[fileName] = contents;
+  };
+
+  ts.createProgram(fileNames, options, host).emit();
+
+  return output;
+}
+
+module.exports = {
+  translate: (fileName, sourceTypeScript) => {
+    const translated = translate(fileName, sourceTypeScript, {
+      module: "ESNext",
+      noImplicitReturns: true,
+      alwaysStrict: true,
+      target: ts.ScriptTarget.ESNext,
+      declaration: true,
+      noImplicitAny: false,
+      sourceMap: false,
+      removeComments: false,
+      disableSizeLimit: true,
+      esModuleInterop: true,
+      emitDecoratorMetadata: true,
+      skipLibCheck: true,
+    });
+
+    const sourceFileName = fileName.replace(ts.Extension.Ts, ts.Extension.Js);
+    const declarationFileName = fileName.replace(ts.Extension.Ts, ts.Extension.Dts);
+    const sourceContent = translated[sourceFileName];
+    const tsImportRows = sourceTypeScript.split("\n").filter((line) => line.startsWith("import "));
+    const declarationContent = translated[declarationFileName]
+      .split("\n")
+      .map((line) => {
+        if (line.startsWith("import ")) {
+          return tsImportRows.shift();
+        }
+        return line;
+      })
+      .join("\n");
+
+    return {
+      sourceContent: sourceContent,
+      declarationContent: declarationContent,
+    };
+  },
+};

package/templates/base/http-clients/axios-http-client.ejs

@@ -33,6 +33,7 @@ export enum ContentType {
   Json = "application/json",
   FormData = "multipart/form-data",
   UrlEncoded = "application/x-www-form-urlencoded",
+  Text = "text/plain",
 }
 
 export class HttpClient<SecurityDataType = unknown> {
@@ -114,6 +115,10 @@ export class HttpClient<SecurityDataType = unknown> {
           body = this.createFormData(body as Record<string, unknown>);
         }
 
+        if (type === ContentType.Text && body && body !== null && typeof body !== "string") {
+          body = JSON.stringify(body);
+        }
+
         return this.instance.request({
             ...requestParams,
             headers: {

package/templates/base/http-clients/fetch-http-client.ejs

@@ -45,6 +45,7 @@ export enum ContentType {
     Json = "application/json",
     FormData = "multipart/form-data",
     UrlEncoded = "application/x-www-form-urlencoded",
+    Text = "text/plain",
 }
 
 export class HttpClient<SecurityDataType = unknown> {
@@ -102,6 +103,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
     private contentFormatters: Record<ContentType, (input: any) => any> = {
         [ContentType.Json]: (input:any) => input !== null && (typeof input === "object" || typeof input === "string") ? JSON.stringify(input) : input,
+        [ContentType.Text]: (input:any) => input !== null && typeof input !== "string" ? JSON.stringify(input) : input,
         [ContentType.FormData]: (input: any) =>
             Object.keys(input || {}).reduce((formData, key) => {
                 const property = input[key];

package/templates/default/procedure-call.ejs

@@ -50,6 +50,7 @@ const requestContentKind = {
     "JSON": "ContentType.Json",
     "URL_ENCODED": "ContentType.UrlEncoded",
     "FORM_DATA": "ContentType.FormData",
+    "TEXT": "ContentType.Text",
 }
 // RequestParams["format"]
 const responseContentKind = {

package/templates/modular/procedure-call.ejs

@@ -50,6 +50,7 @@ const requestContentKind = {
     "JSON": "ContentType.Json",
     "URL_ENCODED": "ContentType.UrlEncoded",
     "FORM_DATA": "ContentType.FormData",
+    "TEXT": "ContentType.Text",
 }
 // RequestParams["format"]
 const responseContentKind = {