typescript-node: form data file (#3967)

* [typescript][node]: Add options to specify a from data file

Be able to specify file options as described on
https://github.com/request/request in the 'multipart/form-data
(Multipart Form Uploads)' section).

Related to #3944

Fix file return type

* [typescript][node]: Fix use of applyLocalTypeMapping

Previous call to applyLocalTypeMapping didn't had any effect.

* [typescript][node]: Update samples

Author: clemens-smartparking

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptNodeClientCodegen.java

@@ -17,7 +17,9 @@
 
 package org.openapitools.codegen.languages;
 
+import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.media.Schema;
+import io.swagger.v3.oas.models.responses.ApiResponse;
 import org.openapitools.codegen.*;
 import org.openapitools.codegen.utils.ModelUtils;
 import org.slf4j.Logger;
@@ -40,8 +42,12 @@ public class TypeScriptNodeClientCodegen extends AbstractTypeScriptClientCodegen
     public TypeScriptNodeClientCodegen() {
         super();
 
-        typeMapping.put("file", "Buffer");
+        typeMapping.put("file", "RequestFile");
+        // RequestFile is defined as: `type RequestFile = string | Buffer | ReadStream | RequestDetailedFile;`
         languageSpecificPrimitives.add("Buffer");
+        languageSpecificPrimitives.add("ReadStream");
+        languageSpecificPrimitives.add("RequestDetailedFile");
+        languageSpecificPrimitives.add("RequestFile");
 
         // clear import mapping (from default generator) as TS does not use it
         // at the moment
@@ -70,19 +76,35 @@ public String getHelp() {
 
     @Override
     public boolean isDataTypeFile(final String dataType) {
-        return "Buffer".equals(dataType);
+        return dataType != null && dataType.equals("RequestFile");
     }
 
     @Override
     public String getTypeDeclaration(Schema p) {
         if (ModelUtils.isFileSchema(p)) {
-            return "Buffer";
+            // There are two file types:
+            // 1) RequestFile: the parameter for the request lib when uploading a file
+            // (https://github.com/request/request#multipartform-data-multipart-form-uploads)
+            // 2) Buffer: for downloading files.
+            // Use RequestFile as a default. The return type is fixed to Buffer in handleMethodResponse.
+            return "RequestFile";
         } else if (ModelUtils.isBinarySchema(p)) {
             return "Buffer";
         }
         return super.getTypeDeclaration(p);
     }
-    
+
+    @Override
+    protected void handleMethodResponse(Operation operation, Map<String, Schema> schemas, CodegenOperation op,
+                                        ApiResponse methodResponse) {
+        super.handleMethodResponse(operation, schemas, op, methodResponse);
+
+        // see comment in getTypeDeclaration
+        if (op.isResponseFile) {
+            op.returnType = "Buffer";
+        }
+    }
+
     @Override
     public String toApiName(String name) {
         if (name.length() == 0) {
@@ -239,13 +261,12 @@ public String getSchemaType(Schema p) {
         if (isLanguagePrimitive(openAPIType) || isLanguageGenericType(openAPIType)) {
             return openAPIType;
         }
-        applyLocalTypeMapping(openAPIType);
-        return openAPIType;
+        return applyLocalTypeMapping(openAPIType);
     }
 
     private String applyLocalTypeMapping(String type) {
         if (typeMapping.containsKey(type)) {
-            type = typeMapping.get(type);
+            return typeMapping.get(type);
         }
         return type;
     }

modules/openapi-generator/src/main/resources/typescript-node/api-all.mustache

@@ -8,12 +8,25 @@ import { {{ classname }} } from './{{ classFilename }}';
 export * from './{{ classFilename }}Interface'
 {{/withInterfaces}}
 {{/apis}}
-import http = require('http');
+import * as fs from 'fs';
+import * as http from 'http';
+
 export class HttpError extends Error {
     constructor (public response: http.{{#supportsES6}}IncomingMessage{{/supportsES6}}{{^supportsES6}}ClientResponse{{/supportsES6}}, public body: any, public statusCode?: number) {
         super('HTTP request failed');
         this.name = 'HttpError';
     }
 }
+
+export interface RequestDetailedFile {
+    value: Buffer;
+    options?: {
+        filename?: string;
+        contentType?: string;
+    }
+}
+
+export type RequestFile = string | Buffer | fs.ReadStream | RequestDetailedFile;
+
 export const APIS = [{{#apis}}{{#operations}}{{ classname }}{{/operations}}{{^-last}}, {{/-last}}{{/apis}}];
 {{/apiInfo}}

modules/openapi-generator/src/main/resources/typescript-node/api-single.mustache

@@ -12,7 +12,7 @@ import { ObjectSerializer, Authentication, VoidAuth } from '../model/models';
 import { HttpBasicAuth, ApiKeyAuth, OAuth } from '../model/models';
 {{/hasAuthMethods}}
 
-import { HttpError } from './apis';
+import { HttpError, RequestFile } from './apis';
 
 let defaultBasePath = '{{{basePath}}}';
 

samples/client/petstore/typescript-node/default/api/apis.ts

@@ -4,11 +4,24 @@ export * from './storeApi';
 import { StoreApi } from './storeApi';
 export * from './userApi';
 import { UserApi } from './userApi';
-import http = require('http');
+import * as fs from 'fs';
+import * as http from 'http';
+
 export class HttpError extends Error {
     constructor (public response: http.ClientResponse, public body: any, public statusCode?: number) {
         super('HTTP request failed');
         this.name = 'HttpError';
     }
 }
+
+export interface RequestDetailedFile {
+    value: Buffer;
+    options?: {
+        filename?: string;
+        contentType?: string;
+    }
+}
+
+export type RequestFile = string | Buffer | fs.ReadStream | RequestDetailedFile;
+
 export const APIS = [PetApi, StoreApi, UserApi];

samples/client/petstore/typescript-node/default/api/petApi.ts

@@ -20,7 +20,7 @@ import { Pet } from '../model/pet';
 import { ObjectSerializer, Authentication, VoidAuth } from '../model/models';
 import { HttpBasicAuth, ApiKeyAuth, OAuth } from '../model/models';
 
-import { HttpError } from './apis';
+import { HttpError, RequestFile } from './apis';
 
 let defaultBasePath = 'http://petstore.swagger.io/v2';
 
@@ -528,7 +528,7 @@ export class PetApi {
      * @param additionalMetadata Additional data to pass to server
      * @param file file to upload
      */
-    public async uploadFile (petId: number, additionalMetadata?: string, file?: Buffer, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.ClientResponse; body: ApiResponse;  }> {
+    public async uploadFile (petId: number, additionalMetadata?: string, file?: RequestFile, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.ClientResponse; body: ApiResponse;  }> {
         const localVarPath = this.basePath + '/pet/{petId}/uploadImage'
             .replace('{' + 'petId' + '}', encodeURIComponent(String(petId)));
         let localVarQueryParameters: any = {};

samples/client/petstore/typescript-node/default/api/storeApi.ts

@@ -19,7 +19,7 @@ import { Order } from '../model/order';
 import { ObjectSerializer, Authentication, VoidAuth } from '../model/models';
 import { HttpBasicAuth, ApiKeyAuth, OAuth } from '../model/models';
 
-import { HttpError } from './apis';
+import { HttpError, RequestFile } from './apis';
 
 let defaultBasePath = 'http://petstore.swagger.io/v2';
 

samples/client/petstore/typescript-node/default/api/userApi.ts

@@ -18,7 +18,7 @@ import { User } from '../model/user';
 
 import { ObjectSerializer, Authentication, VoidAuth } from '../model/models';
 
-import { HttpError } from './apis';
+import { HttpError, RequestFile } from './apis';
 
 let defaultBasePath = 'http://petstore.swagger.io/v2';
 

samples/client/petstore/typescript-node/npm/api/apis.ts

@@ -4,11 +4,24 @@ export * from './storeApi';
 import { StoreApi } from './storeApi';
 export * from './userApi';
 import { UserApi } from './userApi';
-import http = require('http');
+import * as fs from 'fs';
+import * as http from 'http';
+
 export class HttpError extends Error {
     constructor (public response: http.ClientResponse, public body: any, public statusCode?: number) {
         super('HTTP request failed');
         this.name = 'HttpError';
     }
 }
+
+export interface RequestDetailedFile {
+    value: Buffer;
+    options?: {
+        filename?: string;
+        contentType?: string;
+    }
+}
+
+export type RequestFile = string | Buffer | fs.ReadStream | RequestDetailedFile;
+
 export const APIS = [PetApi, StoreApi, UserApi];

samples/client/petstore/typescript-node/npm/api/petApi.ts

@@ -20,7 +20,7 @@ import { Pet } from '../model/pet';
 import { ObjectSerializer, Authentication, VoidAuth } from '../model/models';
 import { HttpBasicAuth, ApiKeyAuth, OAuth } from '../model/models';
 
-import { HttpError } from './apis';
+import { HttpError, RequestFile } from './apis';
 
 let defaultBasePath = 'http://petstore.swagger.io/v2';
 
@@ -528,7 +528,7 @@ export class PetApi {
      * @param additionalMetadata Additional data to pass to server
      * @param file file to upload
      */
-    public async uploadFile (petId: number, additionalMetadata?: string, file?: Buffer, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.ClientResponse; body: ApiResponse;  }> {
+    public async uploadFile (petId: number, additionalMetadata?: string, file?: RequestFile, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.ClientResponse; body: ApiResponse;  }> {
         const localVarPath = this.basePath + '/pet/{petId}/uploadImage'
             .replace('{' + 'petId' + '}', encodeURIComponent(String(petId)));
         let localVarQueryParameters: any = {};

samples/client/petstore/typescript-node/npm/api/storeApi.ts

@@ -19,7 +19,7 @@ import { Order } from '../model/order';
 import { ObjectSerializer, Authentication, VoidAuth } from '../model/models';
 import { HttpBasicAuth, ApiKeyAuth, OAuth } from '../model/models';
 
-import { HttpError } from './apis';
+import { HttpError, RequestFile } from './apis';
 
 let defaultBasePath = 'http://petstore.swagger.io/v2';