blobToBuffer -> readAsBuffer

Author: dinwwwh

eslint.config.js

@@ -17,7 +17,7 @@ export default antfu({
       },
       {
         name: ['*', 'bytes'],
-        message: 'Blob.bytes is not widely supported, use blobToBuffer instead',
+        message: 'Request/Blob/Response/... .bytes is not widely supported, use readAsBuffer instead',
       },
     ],
     'no-restricted-imports': ['error', {

packages/client/src/adapters/websocket/link-client.ts

@@ -1,7 +1,7 @@
 import type { StandardLazyResponse, StandardRequest } from '@orpc/standard-server'
 import type { ClientContext, ClientOptions } from '../../types'
 import type { StandardLinkClient } from '../standard'
-import { blobToBuffer } from '@orpc/shared'
+import { readAsBuffer } from '@orpc/shared'
 import { ClientPeer } from '@orpc/standard-server-peer'
 
 export interface experimental_LinkWebsocketClientOptions {
@@ -30,7 +30,7 @@ export class experimental_LinkWebsocketClient<T extends ClientContext> implement
 
     options.websocket.addEventListener('message', async (event) => {
       const message = event.data instanceof Blob
-        ? await blobToBuffer(event.data)
+        ? await readAsBuffer(event.data)
         : event.data
 
       this.peer.message(message)

packages/server/src/adapters/websocket/handler.ts

@@ -4,7 +4,7 @@ import type { StandardHandler } from '../standard'
 import type {
   experimental_HandleStandardServerPeerMessageOptions as HandleStandardServerPeerMessageOptions,
 } from '../standard-peer'
-import { blobToBuffer, resolveMaybeOptionalOptions } from '@orpc/shared'
+import { readAsBuffer, resolveMaybeOptionalOptions } from '@orpc/shared'
 import { ServerPeer } from '@orpc/standard-server-peer'
 import {
   experimental_handleStandardServerPeerMessage as handleStandardServerPeerMessage,
@@ -57,7 +57,7 @@ export class experimental_WebsocketHandler<T extends Context> {
     }
 
     const message = data instanceof Blob
-      ? await blobToBuffer(data)
+      ? await readAsBuffer(data)
       : data
 
     await handleStandardServerPeerMessage(

packages/server/src/adapters/ws/handler.ts

@@ -5,7 +5,7 @@ import type { StandardHandler } from '../standard'
 import type {
   experimental_HandleStandardServerPeerMessageOptions as HandleStandardServerPeerMessageOptions,
 } from '../standard-peer'
-import { blobToBuffer, resolveMaybeOptionalOptions } from '@orpc/shared'
+import { readAsBuffer, resolveMaybeOptionalOptions } from '@orpc/shared'
 import { ServerPeer } from '@orpc/standard-server-peer'
 import {
   experimental_handleStandardServerPeerMessage as handleStandardServerPeerMessage,
@@ -25,7 +25,7 @@ export class experimental_WsHandler<T extends Context> {
 
     ws.addEventListener('message', async (event) => {
       const message = Array.isArray(event.data)
-        ? await blobToBuffer(new Blob(event.data))
+        ? await readAsBuffer(new Blob(event.data))
         : event.data
 
       await handleStandardServerPeerMessage(

packages/shared/src/blob.test.ts

@@ -1,10 +1,17 @@
-import { blobToBuffer } from './blob'
+import { readAsBuffer } from './blob'
 
-it('blobToBuffer', async () => {
+it('readAsBuffer', async () => {
   const blob = new Blob(['test'], { type: 'text/plain' })
 
-  expect(new TextDecoder().decode(await blobToBuffer(blob))).toBe('test')
-  expect(new TextDecoder().decode(await blobToBuffer(new Proxy(blob, {
-    has: (target, prop) => Reflect.has(target, prop) && prop !== 'bytes',
+  expect(new TextDecoder().decode(await readAsBuffer(blob))).toBe('test')
+  expect(new TextDecoder().decode(await readAsBuffer(new Proxy(blob, {
+    get: (target, prop) => {
+      if (prop === 'bytes') {
+        return undefined
+      }
+      return Reflect.get(target, prop)
+    },
   })))).toBe('test')
+
+  expect(new TextDecoder().decode(await readAsBuffer(new Response(blob)))).toBe('test')
 })

packages/shared/src/blob.ts

@@ -1,13 +1,13 @@
 /**
- * Converts a Blob to a buffer (ArrayBuffer or Uint8Array).
+ * Converts Request/Response/Blob/File/.. to a buffer (ArrayBuffer or Uint8Array).
  *
  * Prefers the newer `.bytes` method when available as it more efficient but not widely supported yet.
  */
-export function blobToBuffer(blob: Blob): Promise<ArrayBuffer | Uint8Array> {
-  if ('bytes' in blob) {
+export function readAsBuffer(source: Pick<Blob, 'arrayBuffer' | 'bytes'>): Promise<ArrayBuffer | Uint8Array> {
+  if (typeof source.bytes === 'function') {
     // eslint-disable-next-line ban/ban
-    return blob.bytes()
+    return source.bytes()
   }
 
-  return (blob as Blob).arrayBuffer()
+  return (source as Pick<Blob, 'arrayBuffer'>).arrayBuffer()
 }

packages/standard-server-peer/src/codec.ts

@@ -1,6 +1,6 @@
 import type { EventMeta, StandardBody, StandardHeaders, StandardRequest, StandardResponse } from '@orpc/standard-server'
 import type { EncodedMessage } from './types'
-import { blobToBuffer, isAsyncIteratorObject, stringifyJSON } from '@orpc/shared'
+import { isAsyncIteratorObject, readAsBuffer, stringifyJSON } from '@orpc/shared'
 import { flattenHeader, generateContentDisposition, getFilenameFromContentDisposition } from '@orpc/standard-server'
 
 export enum MessageType {
@@ -307,7 +307,7 @@ async function encodeRawMessage(data: object, blob?: Blob): Promise<EncodedMessa
     return json
   }
 
-  return blobToBuffer(new Blob([
+  return readAsBuffer(new Blob([
     new TextEncoder().encode(json),
     new Uint8Array([JSON_AND_BINARY_DELIMITER]),
     blob,