feat: support decoding ArrayBuffers (#287)

When using `fetch` to download something over HTTP, it only makes
an `ArrayBuffer` available, not a `Uint8Array`.

`TextDecoder` supports decoding `ArrayBuffer`s, and the `raw` codec
turns passed `ArrayBuffer`s into `Uint8Array`s so this is just a
type change.

Instead of:

```js
const res = await fetch('...')
const obj = json.decode(new Uint8Array(await res.arrayBuffer()))
```

we can do:

```js
const res = await fetch('...')
const obj = json.decode(await res.arrayBuffer())
```

Author: achingbrain

src/block/interface.ts

@@ -12,6 +12,11 @@ import type { Link, Version } from '../link/interface.js'
  */
 export interface ByteView<Data> extends Uint8Array, Phantom<Data> {}
 
+/**
+ * Similar to ByteView but extends ArrayBuffer.
+ */
+export interface ArrayBufferView<Data> extends ArrayBuffer, Phantom<Data> {}
+
 declare const Marker: unique symbol
 
 /**

src/codecs/interface.ts

@@ -1,4 +1,4 @@
-import type { ByteView } from '../block/interface.js'
+import type { ArrayBufferView, ByteView } from '../block/interface.js'
 
 /**
  * IPLD encoder part of the codec.
@@ -14,12 +14,12 @@ export interface BlockEncoder<Code extends number, T> {
  */
 export interface BlockDecoder<Code extends number, T> {
   code: Code
-  decode(bytes: ByteView<T>): T
+  decode(bytes: ByteView<T> | ArrayBufferView<T>): T
 }
 
 /**
  * An IPLD codec is a combination of both encoder and decoder.
  */
 export interface BlockCodec<Code extends number, T> extends BlockEncoder<Code, T>, BlockDecoder<Code, T> {}
 
-export type { ByteView }
+export type { ArrayBufferView, ByteView }

src/codecs/json.ts

@@ -1,4 +1,4 @@
-import type { ByteView } from './interface.js'
+import type { ArrayBufferView, ByteView } from './interface.js'
 
 const textEncoder = new TextEncoder()
 const textDecoder = new TextDecoder()
@@ -10,6 +10,6 @@ export function encode <T> (node: T): ByteView<T> {
   return textEncoder.encode(JSON.stringify(node))
 }
 
-export function decode <T> (data: ByteView<T>): T {
+export function decode <T> (data: ByteView<T> | ArrayBufferView<T>): T {
   return JSON.parse(textDecoder.decode(data))
 }

src/codecs/raw.ts

@@ -1,5 +1,5 @@
 import { coerce } from '../bytes.js'
-import type { ByteView } from './interface.js'
+import type { ArrayBufferView, ByteView } from './interface.js'
 
 export const name = 'raw'
 export const code = 0x55
@@ -8,6 +8,6 @@ export function encode (node: Uint8Array): ByteView<Uint8Array> {
   return coerce(node)
 }
 
-export function decode (data: ByteView<Uint8Array>): Uint8Array {
+export function decode (data: ByteView<Uint8Array> | ArrayBufferView<Uint8Array>): Uint8Array {
   return coerce(data)
 }

test/test-multicodec.spec.ts

@@ -12,12 +12,24 @@ describe('multicodec', () => {
     assert.deepStrictEqual(raw.decode(buff), bytes.fromString('test'))
   })
 
+  it('encode/decode raw arraybuffer', () => {
+    const buff = raw.encode(bytes.fromString('test'))
+    assert.deepStrictEqual(buff, bytes.fromString('test'))
+    assert.deepStrictEqual(raw.decode(buff.buffer), bytes.fromString('test'))
+  })
+
   it('encode/decode json', () => {
     const buff = json.encode({ hello: 'world' })
     assert.deepStrictEqual(buff, bytes.fromString(JSON.stringify({ hello: 'world' })))
     assert.deepStrictEqual(json.decode(buff), { hello: 'world' })
   })
 
+  it('encode/decode json arraybuffer', () => {
+    const buff = json.encode({ hello: 'world' })
+    assert.deepStrictEqual(buff, bytes.fromString(JSON.stringify({ hello: 'world' })))
+    assert.deepStrictEqual(json.decode(buff.buffer), { hello: 'world' })
+  })
+
   it('raw cannot encode string', async () => {
     // @ts-expect-error - 'string' is not assignable to parameter of type 'Uint8Array'
     assert.throws(() => raw.encode('asdf'), 'Unknown type, must be binary type')