feat: support application/octet-stream (Blob) req/res bodies (#359)

- adds support for `application/octet-stream` content types for both
request and response bodies
- introduces some associated helper functions, notably uses `raw-body`
for the request body parsing side of things. It might make sense to see
if we could always use this and drop the other body parsers
- may still refactor things a bit more before release, eg: avoid pulling
`raw-body` into the client runtimes

Author: mnahkies

e2e/openapi.yaml

@@ -323,6 +323,25 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ProductOrder'
+  /media-types/octet-stream:
+    post:
+      tags:
+        - media types
+      requestBody:
+        content:
+          application/octet-stream:
+            schema:
+              type: string
+              format: binary
+              maxLength: 20971520
+      responses:
+        200:
+          description: ok
+          content:
+            application/octet-stream:
+              schema:
+                type: string
+                format: binary
 
   /escape-hatches/plain-text:
     get:

e2e/src/generated/client/axios/client.ts

@@ -430,6 +430,20 @@ describe.each(
     })
   })
 
+  describe("POST /media-types/octet-stream", () => {
+    it("can send and parse application/octet-stream request bodies", async () => {
+      const blob = new Blob([new Uint8Array([0xde, 0xad, 0xbe, 0xef])], {
+        type: "application/octet-stream",
+      })
+      const res = await client.postMediaTypesOctetStream({
+        requestBody: blob,
+      })
+      expect(res.status).toBe(200)
+
+      await expect(res.data).toEqualBlob(blob)
+    })
+  })
+
   describe("query parameters", () => {
     it("GET /params/simple-query", async () => {
       const {status, data} = await client.getParamsSimpleQuery({

e2e/src/generated/client/fetch/client.ts

@@ -431,6 +431,20 @@ describe.each(
     })
   })
 
+  describe("POST /media-types/octet-stream", () => {
+    it("can send and parse application/octet-stream request bodies", async () => {
+      const blob = new Blob([new Uint8Array([0xde, 0xad, 0xbe, 0xef])], {
+        type: "application/octet-stream",
+      })
+      const res = await client.postMediaTypesOctetStream({
+        requestBody: blob,
+      })
+      expect(res.status).toBe(200)
+
+      await expect(await res.blob()).toEqualBlob(blob)
+    })
+  })
+
   describe("query parameters", () => {
     it("GET /params/simple-query", async () => {
       const res = await client.getParamsSimpleQuery({

e2e/src/generated/server/express/routes/media-types.ts

@@ -0,0 +1,10 @@
+import type {CustomMatcherResult} from "expect"
+
+declare module "expect" {
+  interface AsymmetricMatchers {
+    toEqualBlob(this: R, expected: Blob): Promise<CustomMatcherResult>
+  }
+  interface Matchers<R> {
+    toEqualBlob(this: R, expected: Blob): Promise<CustomMatcherResult>
+  }
+}

e2e/src/generated/server/koa/routes/media-types.ts

@@ -1,6 +1,7 @@
 import {SkipResponse} from "@nahkies/typescript-express-runtime/server"
 import {
   createRouter,
+  type PostMediaTypesOctetStream,
   type PostMediaTypesText,
   type PostMediaTypesXWwwFormUrlencoded,
 } from "../../generated/server/express/routes/media-types.ts"
@@ -23,9 +24,17 @@ const postMediaTypesXWwwFormUrlencoded: PostMediaTypesXWwwFormUrlencoded =
     return respond.with200().body(body)
   }
 
+const postMediaTypesOctetStream: PostMediaTypesOctetStream = async (
+  {body},
+  respond,
+) => {
+  return respond.with200().body(body)
+}
+
 export function createMediaTypesRouter() {
   return createRouter({
     postMediaTypesText,
     postMediaTypesXWwwFormUrlencoded,
+    postMediaTypesOctetStream,
   })
 }

e2e/src/index.axios.spec.ts

@@ -1,6 +1,7 @@
 import {SkipResponse} from "@nahkies/typescript-koa-runtime/server"
 import {
   createRouter,
+  type PostMediaTypesOctetStream,
   type PostMediaTypesText,
   type PostMediaTypesXWwwFormUrlencoded,
 } from "../../generated/server/koa/routes/media-types.ts"
@@ -24,9 +25,17 @@ const postMediaTypesXWwwFormUrlencoded: PostMediaTypesXWwwFormUrlencoded =
     return respond.with200().body(body)
   }
 
+const postMediaTypesOctetStream: PostMediaTypesOctetStream = async (
+  {body},
+  respond,
+) => {
+  return respond.with200().body(body)
+}
+
 export function createMediaTypesRouter() {
   return createRouter({
     postMediaTypesText,
     postMediaTypesXWwwFormUrlencoded,
+    postMediaTypesOctetStream,
   })
 }