feat(typescript): support bytes responses

fern/pages/changelogs/ts-express/2024-12-12.mdx

@@ -0,0 +1,3 @@
+## 0.18.0
+**`(internal):`** Upgraces to v53 of the IR.
+

generators/typescript/codegen/package.json

@@ -28,7 +28,7 @@
   "devDependencies": {
     "@fern-api/core-utils": "workspace:*",
     "@fern-api/base-generator": "workspace:*",
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@types/jest": "^29.5.12",
     "@types/node": "18.7.18",
     "depcheck": "^1.4.6",

generators/typescript/express/cli/package.json

@@ -31,7 +31,7 @@
   },
   "devDependencies": {
     "@fern-fern/generator-exec-sdk": "^0.0.898",
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/abstract-generator-cli": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

generators/typescript/express/express-endpoint-type-schemas-generator/package.json

@@ -28,7 +28,7 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/abstract-schema-generator": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

generators/typescript/express/express-endpoint-type-schemas-generator/src/GeneratedExpressEndpointTypeSchemasImpl.ts

@@ -196,6 +196,9 @@ export class GeneratedExpressEndpointTypeSchemasImpl implements GeneratedExpress
         if (this.endpoint.response.body?.type === "text") {
             throw new Error("Text response is not supported");
         }
+        if (this.endpoint.response.body.type === "bytes") {
+            throw new Error("Bytes response is not supported");
+        }
 
         if (!this.includeSerdeLayer) {
             return referenceToParsedResponse;

generators/typescript/express/express-error-generator/package.json

@@ -27,7 +27,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/abstract-error-class-generator": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

generators/typescript/express/express-error-schema-generator/package.json

@@ -28,7 +28,7 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/abstract-schema-generator": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

generators/typescript/express/express-inlined-request-body-generator/package.json

@@ -27,7 +27,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*"
   },

generators/typescript/express/express-inlined-request-body-schema-generator/package.json

@@ -27,7 +27,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/abstract-schema-generator": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

generators/typescript/express/express-register-generator/package.json

@@ -27,7 +27,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "@fern-typescript/resolvers": "workspace:*",

generators/typescript/express/express-service-generator/package.json

@@ -27,7 +27,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "@fern-typescript/resolvers": "workspace:*",

generators/typescript/express/express-service-generator/src/GeneratedExpressServiceImpl.ts

@@ -936,6 +936,9 @@ export class GeneratedExpressServiceImpl implements GeneratedExpressService {
             fileDownload: () => {
                 throw new Error("File download is not supported");
             },
+            bytes: () => {
+                throw new Error("Bytes is not supported");
+            },
             text: () => {
                 throw new Error("Text response is not supported");
             },

generators/typescript/express/generator/package.json

@@ -30,7 +30,7 @@
     "@fern-api/core-utils": "workspace:*",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/logger": "workspace:*",
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "@fern-typescript/express-endpoint-type-schemas-generator": "workspace:*",

generators/typescript/express/versions.yml

@@ -1,3 +1,9 @@
+- changelogEntry:
+  - summary: Upgraces to v53 of the IR.
+    type: internal
+  irVersion: 53
+  version: 0.18.0
+
 - changelogEntry:
   - summary: Re-release the `0.17.5` version.
     type: feat

generators/typescript/model/type-generator/package.json

@@ -27,7 +27,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "@fern-typescript/union-generator": "workspace:*",

generators/typescript/model/type-reference-converters/package.json

@@ -27,7 +27,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-api/core-utils": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/resolvers": "workspace:*",

generators/typescript/model/type-reference-example-generator/package.json

@@ -28,7 +28,7 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "ts-morph": "^15.1.0"

generators/typescript/model/type-schema-generator/package.json

@@ -27,7 +27,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/abstract-schema-generator": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

generators/typescript/model/union-generator/package.json

@@ -28,7 +28,7 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "ts-morph": "^15.1.0"

generators/typescript/model/union-schema-generator/package.json

@@ -27,7 +27,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/abstract-schema-generator": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

generators/typescript/sdk/CHANGELOG.md

@@ -5,6 +5,15 @@ 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.44.0] - 2024-12-12
+
+- Feature: The SDK now has first class support for `bytes` responses and returns them as
+  a `Promise<ArrayBuffer>`. This is particularly useful for usecases like text to speech 
+  where you would like to play the audio in the browser. 
+
+  Additional this feature ugprade the dependency of the generator to Intermediate Representation v54. 
+  Please upgrade the Fern CLI to `0.46.1` or above to use this generator. 
+
 ## [0.43.0] - 2024-12-11
 
 - Feature: Generate inline types for inline schemas by setting `enableInlineTypes` to `true` in the generator config.

generators/typescript/sdk/VERSION

@@ -1 +1 @@
-0.43.0
+0.44.0

generators/typescript/sdk/cli/package.json

@@ -35,7 +35,7 @@
   "devDependencies": {
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/base-generator": "workspace:*",
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/abstract-generator-cli": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

generators/typescript/sdk/client-class-generator/package.json

@@ -28,7 +28,7 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "@fern-typescript/resolvers": "workspace:*",

generators/typescript/sdk/client-class-generator/src/GeneratedSdkClientClassImpl.ts

@@ -210,6 +210,7 @@ export class GeneratedSdkClientClassImpl implements GeneratedSdkClientClass {
                         | HttpResponseBody.FileDownload
                         | HttpResponseBody.Text
                         | HttpResponseBody.Streaming
+                        | HttpResponseBody.Bytes
                         | undefined;
                 }) => {
                     if (neverThrowErrors) {
@@ -237,7 +238,12 @@ export class GeneratedSdkClientClassImpl implements GeneratedSdkClientClass {
                 const getDefaultEndpointImplementation = ({
                     response
                 }: {
-                    response: HttpResponseBody.Json | HttpResponseBody.FileDownload | HttpResponseBody.Text | undefined;
+                    response:
+                        | HttpResponseBody.Json
+                        | HttpResponseBody.FileDownload
+                        | HttpResponseBody.Text
+                        | HttpResponseBody.Bytes
+                        | undefined;
                 }) => {
                     return new GeneratedDefaultEndpointImplementation({
                         endpoint,
@@ -307,6 +313,11 @@ export class GeneratedSdkClientClassImpl implements GeneratedSdkClientClass {
                             retainOriginalCasing: this.retainOriginalCasing,
                             omitUndefined: this.omitUndefined
                         }),
+                    bytes: (bytesResponse) => {
+                        return getDefaultEndpointImplementation({
+                            response: HttpResponseBody.bytes(bytesResponse)
+                        });
+                    },
                     text: (textResponse) => {
                         return getDefaultEndpointImplementation({
                             response: HttpResponseBody.text(textResponse)

generators/typescript/sdk/client-class-generator/src/endpoints/default/GeneratedDefaultEndpointImplementation.ts

@@ -425,10 +425,17 @@ export class GeneratedDefaultEndpointImplementation implements GeneratedEndpoint
             withCredentials: this.includeCredentialsOnCrossOriginRequests
         };
 
+        let cast: ts.TypeNode | undefined = undefined;
+
         if (this.endpoint.response?.body?.type === "text") {
             fetcherArgs.responseType = "text";
         }
 
+        if (this.endpoint.response?.body?.type === "bytes") {
+            fetcherArgs.responseType = "arrayBuffer";
+            cast = ts.factory.createTypeReferenceNode("ArrayBuffer");
+        }
+
         return [
             ts.factory.createVariableStatement(
                 undefined,
@@ -440,7 +447,7 @@ export class GeneratedDefaultEndpointImplementation implements GeneratedEndpoint
                             undefined,
                             context.coreUtilities.fetcher.fetcher._invoke(fetcherArgs, {
                                 referenceToFetcher: this.generatedSdkClientClass.getReferenceToFetcher(context),
-                                cast: undefined
+                                cast
                             })
                         )
                     ],

generators/typescript/sdk/client-class-generator/src/endpoints/default/endpoint-response/GeneratedNonThrowingEndpointResponse.ts

@@ -20,6 +20,7 @@ export declare namespace GeneratedNonThrowingEndpointResponse {
             | HttpResponseBody.FileDownload
             | HttpResponseBody.Streaming
             | HttpResponseBody.Text
+            | HttpResponseBody.Bytes
             | undefined;
         errorDiscriminationStrategy: ErrorDiscriminationStrategy;
         errorResolver: ErrorResolver;
@@ -37,6 +38,7 @@ export class GeneratedNonThrowingEndpointResponse implements GeneratedEndpointRe
         | HttpResponseBody.FileDownload
         | HttpResponseBody.Streaming
         | HttpResponseBody.Text
+        | HttpResponseBody.Bytes
         | undefined;
     private errorDiscriminationStrategy: ErrorDiscriminationStrategy;
     private errorResolver: ErrorResolver;

generators/typescript/sdk/client-class-generator/src/endpoints/default/endpoint-response/GeneratedThrowingEndpointResponse.ts

@@ -35,6 +35,7 @@ export declare namespace GeneratedThrowingEndpointResponse {
             | HttpResponseBody.FileDownload
             | HttpResponseBody.Streaming
             | HttpResponseBody.Text
+            | HttpResponseBody.Bytes
             | undefined;
         errorDiscriminationStrategy: ErrorDiscriminationStrategy;
         errorResolver: ErrorResolver;
@@ -53,6 +54,7 @@ export class GeneratedThrowingEndpointResponse implements GeneratedEndpointRespo
         | HttpResponseBody.FileDownload
         | HttpResponseBody.Streaming
         | HttpResponseBody.Text
+        | HttpResponseBody.Bytes
         | undefined;
     private errorDiscriminationStrategy: ErrorDiscriminationStrategy;
     private errorResolver: ErrorResolver;

generators/typescript/sdk/client-class-generator/src/endpoints/default/endpoint-response/getSuccessReturnType.ts

@@ -10,6 +10,7 @@ export function getSuccessReturnType(
         | HttpResponseBody.FileDownload
         | HttpResponseBody.Streaming
         | HttpResponseBody.Text
+        | HttpResponseBody.Bytes
         | undefined,
     context: SdkContext,
     opts: {
@@ -27,6 +28,8 @@ export function getSuccessReturnType(
                 includeContentHeadersOnResponse: opts.includeContentHeadersOnResponse
             });
         }
+        case "bytes":
+            return ts.factory.createTypeReferenceNode("ArrayBuffer");
         case "json":
             return context.type.getReferenceToType(response.value.responseBodyType).typeNode;
         case "text":

generators/typescript/sdk/endpoint-error-union-generator/package.json

@@ -27,7 +27,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "@fern-typescript/resolvers": "workspace:*",

generators/typescript/sdk/environments-generator/package.json

@@ -27,7 +27,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "ts-morph": "^15.1.0"

generators/typescript/sdk/generator/package.json

@@ -34,7 +34,7 @@
     "@fern-api/logger": "workspace:*",
     "@fern-fern/generator-cli-sdk": "0.0.17",
     "@fern-fern/generator-exec-sdk": "^0.0.898",
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-fern/snippet-sdk": "^0.0.5526",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

generators/typescript/sdk/request-wrapper-generator/package.json

@@ -28,7 +28,7 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",
     "ts-morph": "^15.1.0"

generators/typescript/sdk/sdk-endpoint-type-schemas-generator/package.json

@@ -28,7 +28,7 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/abstract-schema-generator": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",

generators/typescript/sdk/sdk-endpoint-type-schemas-generator/src/GeneratedSdkEndpointTypeSchemasImpl.ts

@@ -268,11 +268,11 @@ export class GeneratedSdkEndpointTypeSchemasImpl implements GeneratedSdkEndpoint
         }
 
         if (this.endpoint.response.body.type === "text") {
-            return ts.factory.createAsExpression(
-                referenceToRawResponse,
-                context.type.getReferenceToType(TypeReference.primitive({ v1: PrimitiveTypeV1.String, v2: undefined }))
-                    .typeNode
-            );
+            return referenceToRawResponse;
+        }
+
+        if (this.endpoint.response.body.type === "bytes") {
+            return referenceToRawResponse;
         }
 
         if (this.endpoint.response.body.value.responseBodyType.type === "unknown") {

generators/typescript/sdk/sdk-error-generator/package.json

@@ -27,7 +27,7 @@
     "depcheck": "depcheck"
   },
   "dependencies": {
-    "@fern-fern/ir-sdk": "53.23.0",
+    "@fern-fern/ir-sdk": "54.0.0",
     "@fern-typescript/abstract-error-class-generator": "workspace:*",
     "@fern-typescript/commons": "workspace:*",
     "@fern-typescript/contexts": "workspace:*",