feat: support application/octet-stream req/res bodies

mnahkies · mnahkies · commit eb45ad68d587 · 2025-08-09T13:19:01.000+01:00
diff --git a/package.json b/package.json
@@ -43,6 +43,7 @@
     "@biomejs/js-api": "2.0.3",
     "@biomejs/wasm-nodejs": "2.1.2",
     "@commander-js/extra-typings": "^14.0.0",
+    "@jest/reporters": "^30.0.5",
     "@swc/core": "^1.13.2",
     "@swc/jest": "^0.2.39",
     "@tsconfig/node24": "^24.0.1",
@@ -78,5 +79,5 @@
   "engines": {
     "node": ">=20 <25"
   },
-  "packageManager": "pnpm@10.13.1"
+  "packageManager": "pnpm@10.14.0"
 }
diff --git a/packages/openapi-code-generator/src/typescript/client/typescript-axios/typescript-axios-client-builder.ts b/packages/openapi-code-generator/src/typescript/client/typescript-axios/typescript-axios-client-builder.ts
@@ -16,6 +16,7 @@ export class TypescriptAxiosClientBuilder extends AbstractClientBuilder {
         "application/scim+json",
         "application/merge-patch+json",
         "application/x-www-form-urlencoded",
+        "application/octet-stream",
         "text/json",
         "text/plain",
         "text/x-markdown",
@@ -67,6 +68,9 @@ export class TypescriptAxiosClientBuilder extends AbstractClientBuilder {
     const axiosFragment = `this._request({${[
       `url: url ${queryString ? "+ query" : ""}`,
       `method: "${method}"`,
+      responseSchema?.type === "Blob"
+        ? "responseType: 'arraybuffer'"
+        : undefined,
       requestBody?.parameter
         ? requestBody.isSupported
           ? "data: body"
@@ -102,7 +106,9 @@ export class TypescriptAxiosClientBuilder extends AbstractClientBuilder {
 
     return {...res, data: ${this.schemaBuilder.parse(
       responseSchema.schema,
-      "res.data",
+      responseSchema.type === "Blob"
+        ? "new Blob([res.data], {type: res.headers['content-type'] || 'application/octet-stream'})"
+        : "res.data",
     )}}
     `
         : `return ${axiosFragment}`
@@ -203,6 +209,16 @@ ${this.legacyExports(clientName)}
         return `${param} !== undefined ? ${serialize} : null`
       }
 
+      case "Blob": {
+        const serialize = param
+
+        if (requestBody.parameter.required) {
+          return serialize
+        }
+
+        return `${param} !== undefined ? ${serialize} : null`
+      }
+
       default: {
         throw new Error(
           `typescript-axios does not support request bodies of content-type '${requestBody.contentType}' using serializer '${requestBody.serializer satisfies never}'`,
diff --git a/packages/openapi-code-generator/src/typescript/client/typescript-fetch/typescript-fetch-client-builder.ts b/packages/openapi-code-generator/src/typescript/client/typescript-fetch/typescript-fetch-client-builder.ts
@@ -18,6 +18,7 @@ export class TypescriptFetchClientBuilder extends AbstractClientBuilder {
         "application/scim+json",
         "application/merge-patch+json",
         "application/x-www-form-urlencoded",
+        "application/octet-stream",
         "text/json",
         "text/plain",
         "text/x-markdown",
@@ -187,6 +188,16 @@ export class TypescriptFetchClientBuilder extends AbstractClientBuilder {
         return `${param} !== undefined ? ${serialize} : null`
       }
 
+      case "Blob": {
+        const serialize = param
+
+        if (requestBody.parameter.required) {
+          return serialize
+        }
+
+        return `${param} !== undefined ? ${serialize} : null`
+      }
+
       default: {
         throw new Error(
           `typescript-fetch does not support request bodies of content-type '${requestBody.contentType}' using serializer '${requestBody.serializer satisfies never}'`,
diff --git a/packages/openapi-code-generator/src/typescript/common/schema-builders/abstract-schema-builder.ts b/packages/openapi-code-generator/src/typescript/common/schema-builders/abstract-schema-builder.ts
@@ -223,9 +223,15 @@ export abstract class AbstractSchemaBuilder<
     const model = this.input.schema(maybeModel)
 
     switch (model.type) {
-      case "string":
-        result = this.string(model)
+      case "string": {
+        if (model.format === "byte" || model.format === "binary") {
+          result = this.any()
+        } else {
+          result = this.string(model)
+        }
+
         break
+      }
       case "number":
         result = this.number(model)
         break
diff --git a/packages/openapi-code-generator/src/typescript/common/type-builder.ts b/packages/openapi-code-generator/src/typescript/common/type-builder.ts
@@ -174,6 +174,11 @@ export class TypeBuilder implements ICompilable {
             if (schemaObject["x-enum-extensibility"] === "open") {
               result.push(this.addStaticType("UnknownEnumStringValue"))
             }
+          } else if (
+            schemaObject.format === "binary" ||
+            schemaObject.format === "byte"
+          ) {
+            result.push("Blob")
           } else {
             result.push("string")
           }
diff --git a/packages/openapi-code-generator/src/typescript/common/typescript-common.ts b/packages/openapi-code-generator/src/typescript/common/typescript-common.ts
@@ -141,9 +141,12 @@ export function buildExport(args: ExportDefinition) {
   }
 }
 
-export type Serializer = "JSON.stringify" | "String" | "URLSearchParams"
+export type Serializer =
+  | "JSON.stringify"
+  | "String"
+  | "URLSearchParams"
+  | "Blob"
 // TODO: support more serializations
-// | "Blob"
 // | "FormData"
 
 export type RequestBodyAsParameter = {
@@ -169,10 +172,10 @@ function serializerForNormalizedContentType(contentType: string): Serializer {
     case "application/x-www-form-urlencoded":
       return "URLSearchParams"
 
+    case "application/octet-stream":
+      return "Blob"
+
     // TODO: support more serializations
-    // case "application/octet-stream":
-    //   return "Blob"
-    //
     // case "multipart/form-data":
     //   return "FormData"
 
diff --git a/packages/openapi-code-generator/src/typescript/server/abstract-router-builder.ts b/packages/openapi-code-generator/src/typescript/server/abstract-router-builder.ts
@@ -17,6 +17,7 @@ export abstract class AbstractRouterBuilder implements ICompilable {
         "application/scim+json",
         "application/merge-patch+json",
         "application/x-www-form-urlencoded",
+        "application/octet-stream",
         "text/json",
         "text/plain",
         "text/x-markdown",
diff --git a/packages/openapi-code-generator/src/typescript/server/typescript-express/typescript-express-router-builder.ts b/packages/openapi-code-generator/src/typescript/server/typescript-express/typescript-express-router-builder.ts
@@ -52,6 +52,8 @@ export class ExpressRouterBuilder extends AbstractRouterBuilder {
         "StatusCode3xx",
         "StatusCode4xx",
         "StatusCode5xx",
+        "parseOctetStream",
+        "sendResponse",
       )
 
     this.imports
@@ -134,7 +136,7 @@ router.${builder.method.toLowerCase()}(\`${builder.route}\`, async (req: Request
    const input = {
     params: ${params.path.schema ? `parseRequestInput(${symbols.paramSchema}, req.params, RequestInputType.RouteParam)` : "undefined"},
     query: ${params.query.schema ? `parseRequestInput(${symbols.querySchema}, req.query, RequestInputType.QueryString)` : "undefined"},
-    body: ${params.body.schema ? `parseRequestInput(${symbols.requestBodySchema}, req.body, RequestInputType.RequestBody)` : "undefined"},
+    body: ${params.body.schema ? (params.body.contentType === "application/octet-stream" ? `parseRequestInput(${symbols.requestBodySchema}, await parseOctetStream(req), RequestInputType.RequestBody)` : `parseRequestInput(${symbols.requestBodySchema}, req.body, RequestInputType.RequestBody)`) : "undefined"},
     headers: ${params.header.schema ? `parseRequestInput(${symbols.requestHeaderSchema}, req.headers, RequestInputType.RequestHeader)` : "undefined"}
    }
 
@@ -150,13 +152,7 @@ router.${builder.method.toLowerCase()}(\`${builder.route}\`, async (req: Request
 
    const { status, body } = response instanceof ExpressRuntimeResponse ? response.unpack() : response
 
-    res.status(status)
-
-    if (body !== undefined) {
-      res.json(${symbols.responseBodyValidator}(status, body))
-    } else {
-      res.end()
-    }
+   await sendResponse(res, status, body, ${symbols.responseBodyValidator})
   } catch (error) {
     next(error)
   }
diff --git a/packages/openapi-code-generator/src/typescript/server/typescript-koa/typescript-koa-router-builder.ts b/packages/openapi-code-generator/src/typescript/server/typescript-koa/typescript-koa-router-builder.ts
@@ -49,6 +49,7 @@ export class KoaRouterBuilder extends AbstractRouterBuilder {
         "StatusCode4xx",
         "StatusCode5xx",
         "startServer",
+        "parseOctetStream",
       )
 
     this.imports
@@ -142,7 +143,7 @@ router.${builder.method.toLowerCase()}('${symbols.implPropName}','${builder.rout
    const input = {
     params: ${params.path.schema ? `parseRequestInput(${symbols.paramSchema}, ctx.params, RequestInputType.RouteParam)` : "undefined"},
     query: ${params.query.schema ? `parseRequestInput(${symbols.querySchema}, ctx.query, RequestInputType.QueryString)` : "undefined"},
-    body: ${params.body.schema ? `parseRequestInput(${symbols.requestBodySchema}, Reflect.get(ctx.request, "body"), RequestInputType.RequestBody)` : "undefined"},
+    body: ${params.body.schema ? (params.body.contentType === "application/octet-stream" ? `parseRequestInput(${symbols.requestBodySchema}, await parseOctetStream(ctx), RequestInputType.RequestBody)` : `parseRequestInput(${symbols.requestBodySchema}, Reflect.get(ctx.request, "body"), RequestInputType.RequestBody)`) : "undefined"},
     headers: ${params.header.schema ? `parseRequestInput(${symbols.requestHeaderSchema}, Reflect.get(ctx.request, "headers"), RequestInputType.RequestHeader)` : "undefined"}
    }
 
diff --git a/packages/typescript-express-runtime/package.json b/packages/typescript-express-runtime/package.json
@@ -45,6 +45,7 @@
     "test": "jest"
   },
   "dependencies": {
+    "raw-body": "^3.0.0",
     "tslib": "^2.8.1"
   },
   "peerDependencies": {
diff --git a/packages/typescript-express-runtime/src/server.ts b/packages/typescript-express-runtime/src/server.ts
@@ -6,9 +6,12 @@ import Cors, {type CorsOptions, type CorsOptionsDelegate} from "cors"
 import express, {
   type ErrorRequestHandler,
   type Express,
+  type Response as ExpressResponse,
+  type Request,
   type RequestHandler,
   type Router,
 } from "express"
+import getRawBody from "raw-body"
 
 // from https://stackoverflow.com/questions/39494689/is-it-possible-to-restrict-number-to-a-certain-range
 type Enumerate<
@@ -41,6 +44,8 @@ export type Response<Status extends StatusCode, Type> = {
   body: Type
 }
 
+export type ResponseValidator = (status: number, value: unknown) => any
+
 export const SkipResponse = Symbol("skip response processing")
 
 export class ExpressRuntimeResponse<Type> {
@@ -204,3 +209,64 @@ export async function startServer({
     }
   })
 }
+
+export async function parseOctetStream(
+  req: Request,
+): Promise<Blob | undefined> {
+  const contentLength = req.headers["content-length"]
+    ? parseInt(req.headers["content-length"], 10)
+    : undefined
+
+  if (!contentLength) {
+    throw new Error("No content length provided")
+  }
+
+  const body = await getRawBody(req, {
+    length: contentLength,
+    limit: "1mb",
+  })
+
+  if (!body) {
+    return undefined
+  }
+
+  if (!Buffer.isBuffer(body)) {
+    throw new Error("body must be a buffer")
+  }
+
+  const blob = new Blob([new Uint8Array(body)], {
+    type: "application/octet-stream",
+  })
+
+  return blob
+}
+
+export async function sendResponse(
+  res: ExpressResponse,
+  status: number,
+  body: unknown,
+  validator: ResponseValidator,
+) {
+  res.status(status)
+
+  if (body === undefined) {
+    res.end()
+    return
+  }
+
+  if (body instanceof Blob) {
+    await sendBlob(res, body)
+  } else {
+    res.json(validator(status, body))
+  }
+}
+
+export async function sendBlob(res: ExpressResponse, body: Blob) {
+  const arrayBuffer = await body.arrayBuffer()
+  const buffer = Buffer.from(arrayBuffer)
+
+  res.setHeader("Content-Type", body.type ?? "application/octet-stream")
+  res.setHeader("Content-Length", buffer.length)
+
+  res.send(buffer)
+}
diff --git a/packages/typescript-express-runtime/src/zod.ts b/packages/typescript-express-runtime/src/zod.ts
@@ -1,5 +1,6 @@
 import type {z} from "zod"
 import {ExpressRuntimeError, type RequestInputType} from "./errors"
+import type {ResponseValidator} from "./server"
 
 export function parseRequestInput<Schema extends z.ZodTypeAny>(
   schema: Schema,
@@ -27,7 +28,7 @@ export function parseRequestInput<Schema extends z.ZodTypeAny>(
 export function responseValidationFactory(
   possibleResponses: [string, z.ZodTypeAny][],
   defaultResponse?: z.ZodTypeAny,
-) {
+): ResponseValidator {
   // Exploit the natural ordering matching the desired specificity of eg: 404 vs 4xx
   possibleResponses.sort((x, y) => (x[0] < y[0] ? -1 : 1))
 
diff --git a/packages/typescript-koa-runtime/package.json b/packages/typescript-koa-runtime/package.json
@@ -44,6 +44,7 @@
     "test": "jest"
   },
   "dependencies": {
+    "raw-body": "^3.0.0",
     "tslib": "^2.8.1"
   },
   "peerDependencies": {
diff --git a/packages/typescript-koa-runtime/src/server.ts b/packages/typescript-koa-runtime/src/server.ts
@@ -2,9 +2,10 @@ import type {Server} from "node:http"
 import type {AddressInfo, ListenOptions} from "node:net"
 import Cors from "@koa/cors"
 import type Router from "@koa/router"
-import Koa, {type Middleware} from "koa"
+import Koa, {type Context, type Middleware} from "koa"
+import type {KoaBodyMiddlewareOptions} from "koa-body"
 import KoaBody from "koa-body"
-import type {KoaBodyMiddlewareOptions} from "koa-body/lib/types"
+import getRawBody from "raw-body"
 
 // from https://stackoverflow.com/questions/39494689/is-it-possible-to-restrict-number-to-a-certain-range
 type Enumerate<
@@ -105,6 +106,38 @@ export type Params<Params, Query, Body, Header> = {
   headers: Header
 }
 
+export async function parseOctetStream(
+  ctx: Context,
+): Promise<Blob | undefined> {
+  const contentLength = ctx.req.headers["content-length"]
+    ? parseInt(ctx.req.headers["content-length"], 10)
+    : undefined
+
+  if (!contentLength) {
+    throw new Error("No content length provided")
+  }
+
+  const body = await getRawBody(ctx.req, {
+    length: contentLength,
+    limit: "1mb",
+  })
+
+  if (!body) {
+    return undefined
+  }
+
+  if (!Buffer.isBuffer(body)) {
+    throw new Error("body must be a buffer")
+  }
+
+  const blob = new Blob([new Uint8Array(body)], {
+    type: "application/octet-stream",
+  })
+
+  ctx.body = blob
+  return blob
+}
+
 /**
  * Starts a Koa server and listens on `port` or a randomly allocated port if none provided.
  * Enables CORS and body parsing by default. It's recommended to customize the CORS options
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -174,6 +174,11 @@ export class TypeBuilder implements ICompilable {`
`174`	`174`	`if (schemaObject["x-enum-extensibility"] === "open") {`
`175`	`175`	`result.push(this.addStaticType("UnknownEnumStringValue"))`
`176`	`176`	`}`
	`177`	`+ } else if (`
	`178`	`+ schemaObject.format === "binary" \|\|`
	`179`	`+ schemaObject.format === "byte"`
	`180`	`+ ) {`
	`181`	`+ result.push("Blob")`
`177`	`182`	`} else {`
`178`	`183`	`result.push("string")`
`179`	`184`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@ export class KoaRouterBuilder extends AbstractRouterBuilder {`
`49`	`49`	`"StatusCode4xx",`
`50`	`50`	`"StatusCode5xx",`
`51`	`51`	`"startServer",`
	`52`	`+ "parseOctetStream",`
`52`	`53`	`)`
`53`	`54`
`54`	`55`	`this.imports`
`@@ -142,7 +143,7 @@ router.${builder.method.toLowerCase()}('${symbols.implPropName}','${builder.rout`
`142`	`143`	`const input = {`
`143`	`144`	params: ${params.path.schema ? `parseRequestInput(${symbols.paramSchema}, ctx.params, RequestInputType.RouteParam)` : "undefined"},
`144`	`145`	query: ${params.query.schema ? `parseRequestInput(${symbols.querySchema}, ctx.query, RequestInputType.QueryString)` : "undefined"},
`145`		- body: ${params.body.schema ? `parseRequestInput(${symbols.requestBodySchema}, Reflect.get(ctx.request, "body"), RequestInputType.RequestBody)` : "undefined"},
	`146`	+ body: ${params.body.schema ? (params.body.contentType === "application/octet-stream" ? `parseRequestInput(${symbols.requestBodySchema}, await parseOctetStream(ctx), RequestInputType.RequestBody)` : `parseRequestInput(${symbols.requestBodySchema}, Reflect.get(ctx.request, "body"), RequestInputType.RequestBody)`) : "undefined"},
`146`	`147`	headers: ${params.header.schema ? `parseRequestInput(${symbols.requestHeaderSchema}, Reflect.get(ctx.request, "headers"), RequestInputType.RequestHeader)` : "undefined"}
`147`	`148`	`}`
`148`	`149`