(fix, typescript): multipart form upload on Node 19+ (#4056)

generators/typescript/sdk/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.33.0] - 2024-07-15
+
+- Fix: This release comes with numerous improvements to multipart uploads: 
+
+  1. `Fetcher.ts` no longer depends on form-data and formdata-node which reduces
+      the size of the SDK for all consumers that are not leveraging multipart form 
+      data uploads. 
+  2.  The SDK now accepts `fs.ReadStream`, `Blob` and `File` as inputs and handles
+      parsing them appropriately. 
+  3.  By accepting a `Blob` as a file parameter, the SDK now supports sending the 
+      filename when making a request. 
+
 ## [0.32.0] - 2024-07-15
 
 - Feature: The `reference.md` is now generated for every SDK.

generators/typescript/sdk/VERSION

@@ -1 +1 @@
-0.32.0
+0.33.0

generators/typescript/sdk/client-class-generator/src/endpoint-request/GeneratedDefaultEndpointRequest.ts

@@ -176,12 +176,13 @@ export class GeneratedDefaultEndpointRequest implements GeneratedEndpointRequest
 
     public getFetcherRequestArgs(
         context: SdkContext
-    ): Pick<Fetcher.Args, "headers" | "queryParameters" | "body" | "contentType"> {
+    ): Pick<Fetcher.Args, "headers" | "queryParameters" | "body" | "contentType" | "requestType"> {
         return {
             headers: this.getHeaders(context),
             queryParameters: this.queryParams.getReferenceTo(context),
             body: this.getSerializedRequestBodyWithNullCheck(context),
-            contentType: "application/json"
+            contentType: "application/json",
+            requestType: "json"
         };
     }
 

generators/typescript/sdk/client-class-generator/src/endpoint-request/GeneratedEndpointRequest.ts

@@ -9,7 +9,7 @@ export interface GeneratedEndpointRequest {
     getEndpointParameters(context: SdkContext): OptionalKind<ParameterDeclarationStructure & { docs?: string }>[];
     getFetcherRequestArgs: (
         context: SdkContext
-    ) => Pick<Fetcher.Args, "headers" | "queryParameters" | "body" | "contentType">;
+    ) => Pick<Fetcher.Args, "headers" | "queryParameters" | "body" | "contentType" | "requestType">;
     getReferenceToRequestBody: (context: SdkContext) => ts.Expression | undefined;
     getReferenceToQueryParameter: (queryParameterKey: string, context: SdkContext) => ts.Expression;
     getExampleEndpointParameters({

generators/typescript/sdk/client-class-generator/src/endpoint-request/GeneratedFileUploadEndpointRequest.ts

@@ -210,6 +210,13 @@ export class GeneratedFileUploadEndpointRequest implements GeneratedEndpointRequ
                         value: context.externalDependencies.fs.ReadStream._getReferenceToType()
                     })
                 );
+
+                types.push(
+                    this.maybeWrapFileArray({
+                        property,
+                        value: context.externalDependencies.blob.Blob._getReferenceToType()
+                    })
+                );
             },
             browser: () => {
                 types.push(
@@ -252,7 +259,7 @@ export class GeneratedFileUploadEndpointRequest implements GeneratedEndpointRequ
                             GeneratedFileUploadEndpointRequest.FORM_DATA_VARIABLE_NAME,
                             undefined,
                             undefined,
-                            context.coreUtilities.formDataUtils._instantiate()
+                            context.coreUtilities.formDataUtils.newFormData()
                         )
                     ],
                     ts.NodeFlags.Const
@@ -282,11 +289,13 @@ export class GeneratedFileUploadEndpointRequest implements GeneratedEndpointRequ
                             GeneratedFileUploadEndpointRequest.FORM_DATA_REQUEST_OPTIONS_VARIABLE_NAME,
                             undefined,
                             undefined,
-                            context.coreUtilities.formDataUtils.getRequest({
-                                referencetoFormData: ts.factory.createIdentifier(
-                                    GeneratedFileUploadEndpointRequest.FORM_DATA_VARIABLE_NAME
-                                )
-                            })
+                            ts.factory.createAwaitExpression(
+                                context.coreUtilities.formDataUtils.getRequest({
+                                    referencetoFormData: ts.factory.createIdentifier(
+                                        GeneratedFileUploadEndpointRequest.FORM_DATA_VARIABLE_NAME
+                                    )
+                                })
+                            )
                         )
                     ],
                     ts.NodeFlags.Const
@@ -299,12 +308,13 @@ export class GeneratedFileUploadEndpointRequest implements GeneratedEndpointRequ
 
     public getFetcherRequestArgs(
         context: SdkContext
-    ): Pick<Fetcher.Args, "headers" | "queryParameters" | "body" | "contentType"> {
+    ): Pick<Fetcher.Args, "headers" | "queryParameters" | "body" | "contentType" | "requestType"> {
         return {
             headers: this.getHeaders(context),
             queryParameters: this.queryParams != null ? this.queryParams.getReferenceTo(context) : undefined,
+            requestType: "file",
             body: context.coreUtilities.formDataUtils.getBody({
-                referencetoFormDataRequest: ts.factory.createIdentifier(
+                referencetoFormData: ts.factory.createIdentifier(
                     GeneratedFileUploadEndpointRequest.FORM_DATA_REQUEST_OPTIONS_VARIABLE_NAME
                 )
             })
@@ -321,7 +331,7 @@ export class GeneratedFileUploadEndpointRequest implements GeneratedEndpointRequ
             endpoint: this.endpoint,
             additionalSpreadHeaders: [
                 context.coreUtilities.formDataUtils.getHeaders({
-                    referencetoFormDataRequest: ts.factory.createIdentifier(
+                    referencetoFormData: ts.factory.createIdentifier(
                         GeneratedFileUploadEndpointRequest.FORM_DATA_REQUEST_OPTIONS_VARIABLE_NAME
                     )
                 })

generators/typescript/sdk/client-class-generator/src/endpoints/utils/appendPropertyToFormData.ts

@@ -21,7 +21,7 @@ export function appendPropertyToFormData({
         file: (property) => {
             const FOR_LOOP_ITEM_VARIABLE_NAME = "_file";
 
-            let statement = context.coreUtilities.formDataUtils.append({
+            let statement = context.coreUtilities.formDataUtils.appendFile({
                 referencetoFormData: referenceToFormData,
                 key: property.key.wireValue,
                 value: ts.factory.createIdentifier(

generators/typescript/utils/commons/src/core-utilities/fetcher/Fetcher.ts

@@ -94,6 +94,7 @@ export declare namespace Fetcher {
         withCredentials: boolean;
         timeoutInSeconds: ts.Expression;
         maxRetries?: ts.Expression;
+        requestType?: "json" | "file" | "bytes" | "other";
         responseType?: "json" | "blob" | "streaming" | "text";
     }
 }

generators/typescript/utils/commons/src/core-utilities/fetcher/FetcherImpl.ts

@@ -38,6 +38,7 @@ export class FetcherImpl extends CoreUtility implements Fetcher {
                 body: "body",
                 timeoutMs: "timeoutMs",
                 withCredentials: "withCredentials",
+                requestType: "requestType",
                 responseType: "responseType",
                 abortSignal: "abortSignal"
             },
@@ -106,6 +107,14 @@ export class FetcherImpl extends CoreUtility implements Fetcher {
                     )
                 );
             }
+            if (args.requestType != null && args.responseType !== "json") {
+                properties.push(
+                    ts.factory.createPropertyAssignment(
+                        this.Fetcher.Args.properties.requestType,
+                        ts.factory.createStringLiteral(args.requestType)
+                    )
+                );
+            }
             if (args.body != null) {
                 properties.push(ts.factory.createPropertyAssignment(this.Fetcher.Args.properties.body, args.body));
             }

generators/typescript/utils/commons/src/core-utilities/form-data-utils/FormDataUtils.ts

@@ -1,9 +1,17 @@
 import { ts } from "ts-morph";
 
 export interface FormDataUtils {
-    _instantiate: () => ts.NewExpression;
+    newFormData: () => ts.AwaitExpression;
+
     append: (args: { referencetoFormData: ts.Expression; key: string; value: ts.Expression }) => ts.Statement;
+    appendFile: (args: {
+        referencetoFormData: ts.Expression;
+        key: string;
+        value: ts.Expression;
+        filename?: ts.Expression;
+    }) => ts.Statement;
+
+    getBody: (args: { referencetoFormData: ts.Expression }) => ts.Expression;
+    getHeaders: (args: { referencetoFormData: ts.Expression }) => ts.Expression;
     getRequest: (args: { referencetoFormData: ts.Expression }) => ts.Expression;
-    getBody: (args: { referencetoFormDataRequest: ts.Expression }) => ts.Expression;
-    getHeaders: (args: { referencetoFormDataRequest: ts.Expression }) => ts.Expression;
 }