@ipld/car 4.0.0 → 4.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ipld/car",
-  "version": "4.0.0",
+  "version": "4.1.2",
   "description": "Content Addressable aRchive format reader and writer",
   "main": "./cjs/car.js",
   "types": "./types/car.d.ts",
@@ -18,7 +18,7 @@
     "test": "npm run lint && npm run test:node && npm run test:cjs && npm run test --prefix examples/",
     "test:ci": "npm run lint && npm run test:node && npm run test:esm && npm run test:cjs && npm run test --prefix examples/",
     "coverage": "c8 --reporter=html --reporter=text mocha test/test-*.js && npx st -d coverage -p 8888",
-    "docs": "jsdoc4readme --readme --description-only lib/reader*.js lib/indexed-reader.js lib/iterator.js lib/indexer.js lib/writer*.js lib/decoder.js"
+    "docs": "jsdoc4readme --readme --description-only lib/reader*.js lib/indexed-reader.js lib/iterator.js lib/indexer.js lib/writer*.js lib/buffer-writer.js lib/decoder.js"
   },
   "keywords": [
     "car",
@@ -63,10 +63,16 @@
       "browser": "./esm/lib/writer-browser.js",
       "require": "./cjs/lib/writer.js",
       "import": "./esm/lib/writer.js"
+    },
+    "./buffer-writer": {
+      "browser": "./esm/lib/buffer-writer.js",
+      "require": "./cjs/lib/buffer-writer.js",
+      "import": "./esm/lib/buffer-writer.js"
     }
   },
   "dependencies": {
     "@ipld/dag-cbor": "^7.0.0",
+    "cborg": "^1.9.0",
     "multiformats": "^9.5.4",
     "varint": "^6.0.0"
   },
@@ -87,7 +93,7 @@
     "jsdoc4readme": "^1.4.0",
     "mocha": "^9.1.3",
     "polendina": "~2.0.1",
-    "standard": "^16.0.4",
+    "standard": "^17.0.0",
     "typescript": "~4.6.2"
   },
   "standard": {
@@ -126,6 +132,9 @@
       "writer": [
         "types/lib/writer.d.ts"
       ],
+      "buffer-writer": [
+        "types/lib/buffer-writer.d.ts"
+      ],
       "*": [
         "types/*"
       ],
@@ -235,6 +244,7 @@
     "./iterator": "./cjs/lib/iterator.js",
     "./writer": "./cjs/lib/writer-browser.js",
     "./esm/lib/writer.js": "./esm/lib/writer-browser.js",
-    "./cjs/lib/writer.js": "./cjs/lib/writer-browser.js"
+    "./cjs/lib/writer.js": "./cjs/lib/writer-browser.js",
+    "./buffer-writer": "./cjs/lib/buffer-writer.js"
   }
 }

package/test/test-buffer-writer.js

@@ -0,0 +1,256 @@
+/* eslint-env mocha */
+
+import * as CarBufferWriter from '@ipld/car/buffer-writer'
+import { CarReader } from '@ipld/car/reader'
+import { createHeader } from '../lib/encoder.js'
+import { assert } from './common.js'
+import { CID, varint } from 'multiformats'
+import * as CBOR from '@ipld/dag-cbor'
+import { sha256, sha512 } from 'multiformats/hashes/sha2'
+import { identity } from 'multiformats/hashes/identity'
+import * as Raw from 'multiformats/codecs/raw'
+import * as Block from 'multiformats/block'
+
+describe('CarBufferWriter', () => {
+  const cid = CID.parse('bafkreifuosuzujyf4i6psbneqtwg2fhplc2wxptc5euspa2gn3bwhnihfu')
+  describe('calculateHeaderLength', async () => {
+    for (const count of [0, 1, 10, 18, 24, 48, 124, 255, 258, 65536 - 1, 65536]) {
+      it(`calculateHeaderLength(new Array(${count}).fill(36))`, () => {
+        const roots = new Array(count).fill(cid)
+        const sizes = new Array(count).fill(cid.bytes.byteLength)
+        assert.deepEqual(
+          CarBufferWriter.calculateHeaderLength(sizes),
+          createHeader(roots).byteLength
+        )
+      })
+      it(`calculateHeaderLength(new Array(${count}).fill(36))`, () => {
+        const roots = new Array(count).fill(cid)
+        const rootLengths = roots.map((c) => c.bytes.byteLength)
+        assert.deepEqual(CarBufferWriter.calculateHeaderLength(rootLengths), createHeader(roots).byteLength)
+      })
+    }
+    it('estimate on large CIDs', () => {
+      const largeCID = CID.parse(`bafkqbbac${'a'.repeat(416)}`)
+      assert.equal(
+        CarBufferWriter.calculateHeaderLength([
+          cid.bytes.byteLength,
+          largeCID.bytes.byteLength
+        ]),
+        createHeader([
+          cid,
+          largeCID
+        ]).byteLength
+      )
+    })
+
+    it('estimate on large CIDs 2', () => {
+      const largeCID = CID.createV1(Raw.code, identity.digest(new Uint8Array(512).fill(1)))
+      assert.equal(
+        CarBufferWriter.calculateHeaderLength([
+          cid.bytes.byteLength,
+          largeCID.bytes.byteLength
+        ]),
+        createHeader([cid, largeCID]).byteLength
+      )
+    })
+  })
+
+  describe('writer', () => {
+    it('estimate header and write blocks', async () => {
+      const headerSize = CarBufferWriter.estimateHeaderLength(1)
+      const dataSize = 256
+      const buffer = new ArrayBuffer(headerSize + dataSize)
+      const writer = CarBufferWriter.createWriter(buffer, { headerSize })
+      const b1 = await Block.encode({
+        value: { hello: 'world' },
+        codec: CBOR,
+        hasher: sha256
+      })
+
+      writer.write(b1)
+
+      const b2 = await Block.encode({
+        value: { bye: 'world' },
+        codec: CBOR,
+        hasher: sha256
+      })
+      writer.write(b2)
+
+      writer.addRoot(b1.cid)
+      const bytes = writer.close()
+
+      const reader = await CarReader.fromBytes(bytes)
+      assert.deepEqual(await reader.getRoots(), [b1.cid])
+      assert.deepEqual(reader._blocks, [{ cid: b1.cid, bytes: b1.bytes }, { cid: b2.cid, bytes: b2.bytes }])
+    })
+
+    it('overestimate header', async () => {
+      const headerSize = CarBufferWriter.estimateHeaderLength(2)
+      const dataSize = 256
+      const buffer = new ArrayBuffer(headerSize + dataSize)
+      const writer = CarBufferWriter.createWriter(buffer, { headerSize })
+      const b1 = await Block.encode({
+        value: { hello: 'world' },
+        codec: CBOR,
+        hasher: sha256
+      })
+
+      writer.write(b1)
+
+      const b2 = await Block.encode({
+        value: { bye: 'world' },
+        codec: CBOR,
+        hasher: sha256
+      })
+      writer.write(b2)
+
+      writer.addRoot(b1.cid)
+      assert.throws(() => writer.close(), /Header size was overestimate/)
+      const bytes = writer.close({ resize: true })
+
+      const reader = await CarReader.fromBytes(bytes)
+      assert.deepEqual(await reader.getRoots(), [b1.cid])
+      assert.deepEqual(reader._blocks, [{ cid: b1.cid, bytes: b1.bytes }, { cid: b2.cid, bytes: b2.bytes }])
+    })
+
+    it('underestimate header', async () => {
+      const headerSize = CarBufferWriter.estimateHeaderLength(2)
+      const dataSize = 300
+      const buffer = new ArrayBuffer(headerSize + dataSize)
+      const writer = CarBufferWriter.createWriter(buffer, { headerSize })
+      const b1 = await Block.encode({
+        value: { hello: 'world' },
+        codec: CBOR,
+        hasher: sha256
+      })
+
+      writer.write(b1)
+      writer.addRoot(b1.cid)
+
+      const b2 = await Block.encode({
+        value: { bye: 'world' },
+        codec: CBOR,
+        hasher: sha512
+      })
+      writer.write(b2)
+      assert.throws(() => writer.addRoot(b2.cid), /has no capacity/)
+      writer.addRoot(b2.cid, { resize: true })
+
+      const bytes = writer.close()
+
+      const reader = await CarReader.fromBytes(bytes)
+      assert.deepEqual(await reader.getRoots(), [b1.cid, b2.cid])
+      assert.deepEqual(reader._blocks, [{ cid: b1.cid, bytes: b1.bytes }, { cid: b2.cid, bytes: b2.bytes }])
+    })
+  })
+
+  it('has no space for the root', async () => {
+    const headerSize = CarBufferWriter.estimateHeaderLength(1)
+    const dataSize = 100
+    const buffer = new ArrayBuffer(headerSize + dataSize)
+    const writer = CarBufferWriter.createWriter(buffer, { headerSize })
+    const b1 = await Block.encode({
+      value: { hello: 'world' },
+      codec: CBOR,
+      hasher: sha256
+    })
+
+    writer.write(b1)
+    writer.addRoot(b1.cid)
+
+    const b2 = await Block.encode({
+      value: { bye: 'world' },
+      codec: CBOR,
+      hasher: sha256
+    })
+    writer.write(b2)
+    assert.throws(() => writer.addRoot(b2.cid), /Buffer has no capacity for a new root/)
+    assert.throws(() => writer.addRoot(b2.cid, { resize: true }), /Buffer has no capacity for a new root/)
+
+    const bytes = writer.close()
+
+    const reader = await CarReader.fromBytes(bytes)
+    assert.deepEqual(await reader.getRoots(), [b1.cid])
+    assert.deepEqual(reader._blocks, [{ cid: b1.cid, bytes: b1.bytes }, { cid: b2.cid, bytes: b2.bytes }])
+  })
+
+  it('has no space for the block', async () => {
+    const headerSize = CarBufferWriter.estimateHeaderLength(1)
+    const dataSize = 58
+    const buffer = new ArrayBuffer(headerSize + dataSize)
+    const writer = CarBufferWriter.createWriter(buffer, { headerSize })
+    const b1 = await Block.encode({
+      value: { hello: 'world' },
+      codec: CBOR,
+      hasher: sha256
+    })
+
+    writer.write(b1)
+    writer.addRoot(b1.cid)
+
+    const b2 = await Block.encode({
+      value: { bye: 'world' },
+      codec: CBOR,
+      hasher: sha256
+    })
+    assert.throws(() => writer.write(b2), /Buffer has no capacity for this block/)
+
+    const bytes = writer.close()
+
+    const reader = await CarReader.fromBytes(bytes)
+    assert.deepEqual(await reader.getRoots(), [b1.cid])
+    assert.deepEqual(reader._blocks, [{ cid: b1.cid, bytes: b1.bytes }])
+  })
+
+  it('provide roots', async () => {
+    const b1 = await Block.encode({
+      value: { hello: 'world' },
+      codec: CBOR,
+      hasher: sha256
+    })
+    const b2 = await Block.encode({
+      value: { bye: 'world' },
+      codec: CBOR,
+      hasher: sha512
+    })
+
+    const buffer = new ArrayBuffer(300)
+    const writer = CarBufferWriter.createWriter(buffer, { roots: [b1.cid, b2.cid] })
+
+    writer.write(b1)
+    writer.write(b2)
+
+    const bytes = writer.close()
+
+    const reader = await CarReader.fromBytes(bytes)
+    assert.deepEqual(await reader.getRoots(), [b1.cid, b2.cid])
+    assert.deepEqual(reader._blocks, [{ cid: b1.cid, bytes: b1.bytes }, { cid: b2.cid, bytes: b2.bytes }])
+  })
+
+  it('provide large CID root', async () => {
+    const bytes = new Uint8Array(512).fill(1)
+    const b1 = await Block.encode({
+      value: { hello: 'world' },
+      codec: CBOR,
+      hasher: sha256
+    })
+
+    const b2 = {
+      cid: CID.createV1(Raw.code, identity.digest(bytes)),
+      bytes
+    }
+
+    const headerSize = CBOR.encode({ version: 1, roots: [b1.cid, b2.cid] }).byteLength
+    const bodySize = CarBufferWriter.blockLength(b1) + CarBufferWriter.blockLength(b2)
+    const varintSize = varint.encodingLength(headerSize)
+
+    const writer = CarBufferWriter.createWriter(new ArrayBuffer(varintSize + headerSize + bodySize), { roots: [b1.cid, b2.cid] })
+
+    writer.write(b1)
+    writer.write(b2)
+    const car = writer.close()
+    const reader = await CarReader.fromBytes(car)
+    assert.deepEqual(await reader.getRoots(), [b1.cid, b2.cid])
+    assert.deepEqual(reader._blocks, [{ cid: b1.cid, bytes: b1.bytes }, { cid: b2.cid, bytes: b2.bytes }])
+  })
+})

package/test/test-indexer.js

@@ -30,7 +30,7 @@ describe('CarIndexer fromBytes()', () => {
     const indexer = await CarIndexer.fromBytes(goCarV2Bytes)
     const roots = await indexer.getRoots()
     assert.strictEqual(roots.length, 1)
-    assert(goCarV2Roots[0].equals(roots[0]))
+    assert.ok(goCarV2Roots[0].equals(roots[0]))
     assert.strictEqual(indexer.version, 2)
 
     const indexData = []

package/test/test-reader.js

@@ -65,13 +65,13 @@ describe('CarReader fromBytes()', () => {
     const reader = await CarReader.fromBytes(goCarV2Bytes)
     const roots = await reader.getRoots()
     assert.strictEqual(roots.length, 1)
-    assert(goCarV2Roots[0].equals(roots[0]))
+    assert.ok(goCarV2Roots[0].equals(roots[0]))
     assert.strictEqual(reader.version, 2)
     for (const { cid } of goCarV2Index) {
       const block = await reader.get(cid)
       assert.isDefined(block)
       if (block) {
-        assert(cid.equals(block.cid))
+        assert.ok(cid.equals(block.cid))
         let content
         if (cid.code === dagPb.code) {
           content = dagPb.decode(block.bytes)

package/test/test-writer.js

@@ -265,9 +265,9 @@ describe('CarWriter', () => {
     const pbBytes = await append(1)
     const cborBytes = await append(2)
 
-    assert(rawBytes.length > 0)
-    assert(pbBytes.length > 0)
-    assert(cborBytes.length > 0)
+    assert.ok(rawBytes.length > 0)
+    assert.ok(pbBytes.length > 0)
+    assert.ok(cborBytes.length > 0)
 
     const reassembled = concatBytes([headerBytes, rawBytes, pbBytes, cborBytes])
 

package/tsconfig.json

@@ -31,6 +31,7 @@
     "paths": {
       "@ipld/car": [ "car.js", "car-browser.js", "lib/" ],
       "@ipld/car/writer": [ "./lib/writer.js" ],
+      "@ipld/car/buffer-writer": ["./lib/buffer-writer.js"],
       "@ipld/car/reader": [ "./lib/reader.js" ],
       "@ipld/car/indexed-reader": [ "./lib/indexed-reader.js" ],
       "@ipld/car/iterator": [ "./lib/iterator.js" ],

package/types/api.d.ts

@@ -1,4 +1,5 @@
 import { CID } from 'multiformats/cid';
+export type { CID };
 export declare type Block = {
     cid: CID;
     bytes: Uint8Array;
@@ -30,6 +31,21 @@ export interface BlockWriter {
     put(block: Block): Promise<void>;
     close(): Promise<void>;
 }
+export interface CarBufferWriter {
+    addRoot(root: CID, options?: {
+        resize?: boolean;
+    }): CarBufferWriter;
+    write(block: Block): CarBufferWriter;
+    close(options?: {
+        resize?: boolean;
+    }): Uint8Array;
+}
+export interface CarBufferWriterOptions {
+    roots?: CID[];
+    byteOffset?: number;
+    byteLength?: number;
+    headerSize?: number;
+}
 export interface WriterChannel {
     writer: BlockWriter;
     out: AsyncIterable<Uint8Array>;

package/types/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAItC,oBAAY,KAAK,GAAG;IAAE,GAAG,EAAE,GAAG,CAAC;IAAC,KAAK,EAAE,UAAU,CAAA;CAAE,CAAA;AAEnD,oBAAY,WAAW,GAAG;IACxB,GAAG,EAAE,GAAG,CAAC;IACT,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,oBAAY,UAAU,GAAG,WAAW,GAAG;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAA;CAC3B;AAED,MAAM,WAAW,aAAc,SAAQ,aAAa,CAAC,KAAK,CAAC;CAAG;AAE9D,MAAM,WAAW,WAAY,SAAQ,aAAa,CAAC,GAAG,CAAC;CAAG;AAE1D,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC/B,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAAA;IACzC,MAAM,IAAI,aAAa,CAAA;IACvB,IAAI,IAAI,WAAW,CAAA;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAChC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACvB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,WAAW,CAAA;IACnB,GAAG,EAAE,aAAa,CAAC,UAAU,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,SAAU,SAAQ,WAAW,EAAE,WAAW;CAAG"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAEtC,YAAY,EAAE,GAAG,EAAE,CAAA;AAGnB,oBAAY,KAAK,GAAG;IAClB,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,UAAU,CAAA;CAClB,CAAA;AAED,oBAAY,WAAW,GAAG;IACxB,GAAG,EAAE,GAAG,CAAA;IACR,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,oBAAY,UAAU,GAAG,WAAW,GAAG;IACrC,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAA;CAC3B;AAED,MAAM,WAAW,aAAc,SAAQ,aAAa,CAAC,KAAK,CAAC;CAAG;AAE9D,MAAM,WAAW,WAAY,SAAQ,aAAa,CAAC,GAAG,CAAC;CAAG;AAE1D,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC/B,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAAA;IACzC,MAAM,IAAI,aAAa,CAAA;IACvB,IAAI,IAAI,WAAW,CAAA;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAChC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACvB;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,IAAI,EAAC,GAAG,EAAE,OAAO,CAAC,EAAC;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAE,eAAe,CAAA;IAChE,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe,CAAA;IACpC,KAAK,CAAC,OAAO,CAAC,EAAC;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,UAAU,CAAA;CACjD;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,WAAW,CAAA;IACnB,GAAG,EAAE,aAAa,CAAC,UAAU,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,SAAU,SAAQ,WAAW,EAAE,WAAW;CAAG"}

package/types/lib/buffer-writer.d.ts

@@ -0,0 +1,86 @@
+export function addRoot(writer: CarBufferWriter, root: CID, { resize }?: {
+    resize?: boolean | undefined;
+} | undefined): void;
+export function blockLength({ cid, bytes }: Block): number;
+export function addBlock(writer: CarBufferWriter, { cid, bytes }: Block): void;
+export function close(writer: CarBufferWriter, { resize }?: {
+    resize?: boolean | undefined;
+} | undefined): Uint8Array;
+export function resizeHeader(writer: CarBufferWriter, byteLength: number): void;
+export function calculateHeaderLength(rootLengths: number[]): number;
+export function headerLength({ roots }: {
+    roots: CID[];
+}): number;
+export function estimateHeaderLength(rootCount: number, rootByteLength?: number | undefined): number;
+export function createWriter(buffer: ArrayBuffer, { roots, byteOffset, byteLength, headerSize }?: {
+    roots?: import("multiformats/cid").CID[] | undefined;
+    byteOffset?: number | undefined;
+    byteLength?: number | undefined;
+    headerSize?: number | undefined;
+} | undefined): CarBufferWriter;
+export type CID = import('../api').CID;
+export type Block = import('../api').Block;
+export type Writer = import('../api').CarBufferWriter;
+export type Options = import('../api').CarBufferWriterOptions;
+export type CarEncoder = import('./coding').CarEncoder;
+/**
+ * @typedef {import('../api').CID} CID
+ * @typedef {import('../api').Block} Block
+ * @typedef {import('../api').CarBufferWriter} Writer
+ * @typedef {import('../api').CarBufferWriterOptions} Options
+ * @typedef {import('./coding').CarEncoder} CarEncoder
+ */
+/**
+ * A simple CAR writer that writes to a pre-allocated buffer.
+ *
+ * @class
+ * @name CarBufferWriter
+ * @implements {Writer}
+ */
+declare class CarBufferWriter implements Writer {
+    /**
+     * @param {Uint8Array} bytes
+     * @param {number} headerSize
+     */
+    constructor(bytes: Uint8Array, headerSize: number);
+    /** @readonly */
+    readonly bytes: Uint8Array;
+    byteOffset: number;
+    /**
+     * @readonly
+     * @type {CID[]}
+     */
+    readonly roots: CID[];
+    headerSize: number;
+    /**
+     * Add a root to this writer, to be used to create a header when the CAR is
+     * finalized with {@link CarBufferWriter.close `close()`}
+     *
+     * @param {CID} root
+     * @param {{resize?:boolean}} [options]
+     * @returns {CarBufferWriter}
+     */
+    addRoot(root: CID, options?: {
+        resize?: boolean | undefined;
+    } | undefined): CarBufferWriter;
+    /**
+     * Write a `Block` (a `{ cid:CID, bytes:Uint8Array }` pair) to the archive.
+     * Throws if there is not enough capacity.
+     *
+     * @param {Block} block A `{ cid:CID, bytes:Uint8Array }` pair.
+     * @returns {CarBufferWriter}
+     */
+    write(block: Block): CarBufferWriter;
+    /**
+     * Finalize the CAR and return it as a `Uint8Array`.
+     *
+     * @param {object} [options]
+     * @param {boolean} [options.resize]
+     * @returns {Uint8Array}
+     */
+    close(options?: {
+        resize?: boolean | undefined;
+    } | undefined): Uint8Array;
+}
+export {};
+//# sourceMappingURL=buffer-writer.d.ts.map

package/types/lib/buffer-writer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buffer-writer.d.ts","sourceRoot":"","sources":["../../lib/buffer-writer.js"],"names":[],"mappings":"AAgFO,gCAJI,eAAe,QACf,GAAG;;qBA0Bb;AAUM,4CAHI,KAAK,GACH,MAAM,CAKlB;AAMM,iCAHI,eAAe,kBACf,KAAK,QAYf;AAOM,8BAJI,eAAe;;2BA2BzB;AAMM,qCAHI,eAAe,cACf,MAAM,QAShB;AAqCM,mDAHI,MAAM,EAAE,GACN,MAAM,CAWlB;AAUM;IAHmB,KAAK,EAApB,GAAG,EAAE;IACH,MAAM,CAG4C;AAYxD,gDAJI,MAAM,wCAEJ,MAAM,CAG+C;AAuB3D,qCARI,WAAW;;;;;gBAMT,eAAe,CAmB3B;kBAvRY,OAAO,QAAQ,EAAE,GAAG;oBACpB,OAAO,QAAQ,EAAE,KAAK;qBACtB,OAAO,QAAQ,EAAE,eAAe;sBAChC,OAAO,QAAQ,EAAE,sBAAsB;yBACvC,OAAO,UAAU,EAAE,UAAU;AAL1C;;;;;;GAMG;AAEH;;;;;;GAMG;AACH;IACE;;;OAGG;IACH,mBAHW,UAAU,cACV,MAAM,EAahB;IAVC,gBAAgB;IAChB,2BAAkB;IAClB,mBAA4B;IAE5B;;;OAGG;IACH,gBAFU,GAAG,EAAE,CAEA;IACf,mBAA4B;IAG9B;;;;;;;OAOG;IACH,cAJW,GAAG;;oBAED,eAAe,CAK3B;IAED;;;;;;OAMG;IACH,aAHW,KAAK,GACH,eAAe,CAK3B;IAED;;;;;;OAMG;IACH;;oBAFa,UAAU,CAItB;CACF"}

package/types/test/test-buffer-writer.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=test-buffer-writer.d.ts.map

package/types/test/test-buffer-writer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-buffer-writer.d.ts","sourceRoot":"","sources":["../../test/test-buffer-writer.js"],"names":[],"mappings":""}