@ipld/car 3.2.4 → 4.1.1

package/test/test-reader.js

@@ -2,10 +2,21 @@
 
 import { CarReader } from '@ipld/car/reader'
 import { CarWriter } from '@ipld/car/writer'
+import { bytesReader, readHeader } from '@ipld/car/decoder'
 import * as Block from 'multiformats/block'
 import { sha256 } from 'multiformats/hashes/sha2'
 import * as raw from 'multiformats/codecs/raw'
-import { carBytes, makeIterable, assert } from './common.js'
+import { base64 } from 'multiformats/bases/base64'
+import * as dagPb from '@ipld/dag-pb'
+import {
+  carBytes,
+  makeIterable,
+  assert,
+  goCarV2Bytes,
+  goCarV2Roots,
+  goCarV2Index,
+  goCarV2Contents
+} from './common.js'
 import {
   verifyRoots,
   verifyHas,
@@ -13,6 +24,8 @@ import {
   verifyBlocks,
   verifyCids
 } from './verify-store-reader.js'
+import { data as fixtures } from './fixtures.js'
+import { expectations as fixtureExpectations } from './fixtures-expectations.js'
 
 describe('CarReader fromBytes()', () => {
   it('complete', async () => {
@@ -48,6 +61,30 @@ describe('CarReader fromBytes()', () => {
     })
   })
 
+  it('v2 complete', async () => {
+    const reader = await CarReader.fromBytes(goCarV2Bytes)
+    const roots = await reader.getRoots()
+    assert.strictEqual(roots.length, 1)
+    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.ok(cid.equals(block.cid))
+        let content
+        if (cid.code === dagPb.code) {
+          content = dagPb.decode(block.bytes)
+        } else if (cid.code === 85) { // raw
+          content = new TextDecoder().decode(block.bytes)
+        } else {
+          assert.fail('Unexpected codec')
+        }
+        assert.deepStrictEqual(content, goCarV2Contents[cid.toString()])
+      }
+    }
+  })
+
   it('decode error - trailing null bytes', async () => {
     const bytes = new Uint8Array(carBytes.length + 5)
     bytes.set(carBytes)
@@ -149,4 +186,60 @@ describe('CarReader fromIterable()', () => {
       message: 'Unexpected end of data'
     })
   })
+
+  it('v2 decode error - truncated', async () => {
+    const bytes = goCarV2Bytes.slice()
+    const dv = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength)
+    // dataSize is an 64-bit uint at byte offset 35 from the begining, we're shortening it
+    // by 10 to simulate a premature end of CARv1 content
+    dv.setBigUint64(35, BigInt(448 - 10), true)
+    await assert.isRejected(CarReader.fromIterable(makeIterable(bytes, 64)), {
+      name: 'Error',
+      message: 'Unexpected end of data'
+    })
+  })
+})
+
+describe('Shared fixtures', () => {
+  describe('Header', () => {
+    for (const [name, { version: expectedVersion, err: expectedError }] of Object.entries(fixtureExpectations)) {
+      it(name, async () => {
+        const data = base64.baseDecode(fixtures[name])
+        let header
+        try {
+          header = await readHeader(bytesReader(data))
+        } catch (err) {
+          if (expectedError != null) {
+            assert.equal(err.message, expectedError)
+            return
+          }
+          assert.ifError(err)
+        }
+        if (expectedError != null) {
+          assert.fail(`Expected error: ${expectedError}`)
+        }
+        assert.isDefined(header, 'did not decode header')
+        if (expectedVersion != null && header != null) {
+          assert.strictEqual(header.version, expectedVersion)
+        }
+      })
+    }
+  })
+
+  describe('Contents', () => {
+    for (const [name, { cids: expectedCids }] of Object.entries(fixtureExpectations)) {
+      if (expectedCids == null) {
+        continue
+      }
+      it(name, async () => {
+        const data = base64.baseDecode(fixtures[name])
+        const reader = await CarReader.fromBytes(data)
+        let i = 0
+        for await (const cid of reader.cids()) {
+          assert.strictEqual(cid.toString(), expectedCids[i++])
+        }
+        assert.strictEqual(i, expectedCids.length)
+      })
+    }
+  })
 })

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,10 +31,12 @@
     "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" ],
-      "@ipld/car/indexer": [ "./lib/indexer.js" ]
+      "@ipld/car/indexer": [ "./lib/indexer.js" ],
+      "@ipld/car/decoder": [ "./lib/decoder.js" ],
     }
   },
   "exclude": [

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/lib/coding.d.ts

@@ -13,12 +13,22 @@ export interface IteratorChannel<T> {
     writer: IteratorChannel_Writer<T>;
     iterator: AsyncIterator<T>;
 }
-export declare type CarHeader = {
-    version: number;
+export interface CarHeader {
+    version: 1;
     roots: CID[];
-};
+}
+export interface CarV2FixedHeader {
+    characteristics: [bigint, bigint];
+    dataOffset: number;
+    dataSize: number;
+    indexOffset: number;
+}
+export interface CarV2Header extends CarV2FixedHeader {
+    version: 2;
+    roots: CID[];
+}
 export interface CarDecoder {
-    header(): Promise<CarHeader>;
+    header(): Promise<CarHeader | CarV2Header>;
     blocks(): AsyncGenerator<Block>;
     blocksIndex(): AsyncGenerator<BlockIndex>;
 }

package/types/lib/coding.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"coding.d.ts","sourceRoot":"","sources":["../../lib/coding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AAE1C,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErC,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEvC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACvB;AAED,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,KAAK,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9B,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACrB;AAED,MAAM,WAAW,eAAe,CAAC,CAAC;IAChC,MAAM,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAA;IAEjC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,CAAA;CAC3B;AAED,oBAAY,SAAS,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,GAAG,EAAE,CAAA;CAAE,CAAA;AAEzD,MAAM,WAAW,UAAU;IACzB,MAAM,IAAI,OAAO,CAAC,SAAS,CAAC,CAAA;IAE5B,MAAM,IAAI,cAAc,CAAC,KAAK,CAAC,CAAA;IAE/B,WAAW,IAAI,cAAc,CAAC,UAAU,CAAC,CAAA;CAC1C;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEzC,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE5C,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1B,GAAG,EAAE,MAAM,CAAA;CACZ"}
+{"version":3,"file":"coding.d.ts","sourceRoot":"","sources":["../../lib/coding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AAE1C,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErC,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEvC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACvB;AAED,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,KAAK,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9B,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACrB;AAED,MAAM,WAAW,eAAe,CAAC,CAAC;IAChC,MAAM,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAA;IAEjC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,CAAA;CAC3B;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,CAAC,CAAC;IACX,KAAK,EAAE,GAAG,EAAE,CAAA;CACb;AAED,MAAM,WAAW,gBAAgB;IAC/B,eAAe,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,WAAY,SAAQ,gBAAgB;IACnD,OAAO,EAAE,CAAC,CAAC;IACX,KAAK,EAAE,GAAG,EAAE,CAAC;CACd;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,IAAI,OAAO,CAAC,SAAS,GAAC,WAAW,CAAC,CAAA;IAExC,MAAM,IAAI,cAAc,CAAC,KAAK,CAAC,CAAA;IAE/B,WAAW,IAAI,cAAc,CAAC,UAAU,CAAC,CAAA;CAC1C;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEzC,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE5C,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1B,GAAG,EAAE,MAAM,CAAA;CACZ"}

package/types/lib/decoder.d.ts

@@ -1,19 +1,38 @@
 /**
+ * Reads header data from a `BytesReader`. The header may either be in the form
+ * of a `CarHeader` or `CarV2Header` depending on the CAR being read.
+ *
+ * @name async decoder.readHeader(reader)
  * @param {BytesReader} reader
- * @returns {Promise<CarHeader>}
+ * @param {number} [strictVersion]
+ * @returns {Promise<CarHeader|CarV2Header>}
  */
-export function readHeader(reader: BytesReader): Promise<CarHeader>;
+export function readHeader(reader: BytesReader, strictVersion?: number | undefined): Promise<CarHeader | CarV2Header>;
 /**
+ * Reads the leading data of an individual block from CAR data from a
+ * `BytesReader`. Returns a `BlockHeader` object which contains
+ * `{ cid, length, blockLength }` which can be used to either index the block
+ * or read the block binary data.
+ *
+ * @name async decoder.readBlockHead(reader)
  * @param {BytesReader} reader
  * @returns {Promise<BlockHeader>}
  */
 export function readBlockHead(reader: BytesReader): Promise<BlockHeader>;
 /**
+ * Creates a `CarDecoder` from a `BytesReader`. The `CarDecoder` is as async
+ * interface that will consume the bytes from the `BytesReader` to yield a
+ * `header()` and either `blocks()` or `blocksIndex()` data.
+ *
+ * @name decoder.createDecoder(reader)
  * @param {BytesReader} reader
  * @returns {CarDecoder}
  */
 export function createDecoder(reader: BytesReader): CarDecoder;
 /**
+ * Creates a `BytesReader` from a `Uint8Array`.
+ *
+ * @name decoder.bytesReader(bytes)
  * @param {Uint8Array} bytes
  * @returns {BytesReader}
  */
@@ -28,14 +47,31 @@ export function bytesReader(bytes: Uint8Array): BytesReader;
  */
 export function chunkReader(readChunk: () => Promise<Uint8Array | null>): BytesReader;
 /**
+ * Creates a `BytesReader` from an `AsyncIterable<Uint8Array>`, which allows for
+ * consumption of CAR data from a streaming source.
+ *
+ * @name decoder.asyncIterableReader(asyncIterable)
  * @param {AsyncIterable<Uint8Array>} asyncIterable
  * @returns {BytesReader}
  */
 export function asyncIterableReader(asyncIterable: AsyncIterable<Uint8Array>): BytesReader;
+/**
+ * Wraps a `BytesReader` in a limiting `BytesReader` which limits maximum read
+ * to `byteLimit` bytes. It _does not_ update `pos` of the original
+ * `BytesReader`.
+ *
+ * @name decoder.limitReader(reader, byteLimit)
+ * @param {BytesReader} reader
+ * @param {number} byteLimit
+ * @returns {BytesReader}
+ */
+export function limitReader(reader: BytesReader, byteLimit: number): BytesReader;
 export type Block = import('../api').Block;
 export type BlockHeader = import('../api').BlockHeader;
 export type BlockIndex = import('../api').BlockIndex;
 export type BytesReader = import('./coding').BytesReader;
 export type CarHeader = import('./coding').CarHeader;
+export type CarV2Header = import('./coding').CarV2Header;
+export type CarV2FixedHeader = import('./coding').CarV2FixedHeader;
 export type CarDecoder = import('./coding').CarDecoder;
 //# sourceMappingURL=decoder.d.ts.map

package/types/lib/decoder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decoder.d.ts","sourceRoot":"","sources":["../../lib/decoder.js"],"names":[],"mappings":"AAiCA;;;GAGG;AACH,mCAHW,WAAW,GACT,QAAQ,SAAS,CAAC,CA4B9B;AAkDD;;;GAGG;AACH,sCAHW,WAAW,GACT,QAAQ,WAAW,CAAC,CAiBhC;AA6BD;;;GAGG;AACH,sCAHW,WAAW,GACT,UAAU,CAsBtB;AAED;;;GAGG;AACH,mCAHW,UAAU,GACR,WAAW,CA8BvB;AAED;;;;;;;GAOG;AACH,uCAHW,MAAM,QAAQ,UAAU,GAAC,IAAI,CAAC,GAC5B,WAAW,CAsEvB;AAED;;;GAGG;AACH,mDAHW,cAAc,UAAU,CAAC,GACvB,WAAW,CAgBvB;oBAvTY,OAAO,QAAQ,EAAE,KAAK;0BACtB,OAAO,QAAQ,EAAE,WAAW;yBAC5B,OAAO,QAAQ,EAAE,UAAU;0BAC3B,OAAO,UAAU,EAAE,WAAW;wBAC9B,OAAO,UAAU,EAAE,SAAS;yBAC5B,OAAO,UAAU,EAAE,UAAU"}
+{"version":3,"file":"decoder.d.ts","sourceRoot":"","sources":["../../lib/decoder.js"],"names":[],"mappings":"AAmEA;;;;;;;;GAQG;AACH,mCAJW,WAAW,uCAET,QAAQ,SAAS,GAAC,WAAW,CAAC,CAgC1C;AAkDD;;;;;;;;;GASG;AACH,sCAHW,WAAW,GACT,QAAQ,WAAW,CAAC,CAiBhC;AA6BD;;;;;;;;GAQG;AACH,sCAHW,WAAW,GACT,UAAU,CA+BtB;AAED;;;;;;GAMG;AACH,mCAHW,UAAU,GACR,WAAW,CA8BvB;AAED;;;;;;;GAOG;AACH,uCAHW,MAAM,QAAQ,UAAU,GAAC,IAAI,CAAC,GAC5B,WAAW,CAsEvB;AAED;;;;;;;GAOG;AACH,mDAHW,cAAc,UAAU,CAAC,GACvB,WAAW,CAgBvB;AAED;;;;;;;;;GASG;AACH,oCAJW,WAAW,aACX,MAAM,GACJ,WAAW,CAoCvB;oBA1aY,OAAO,QAAQ,EAAE,KAAK;0BACtB,OAAO,QAAQ,EAAE,WAAW;yBAC5B,OAAO,QAAQ,EAAE,UAAU;0BAC3B,OAAO,UAAU,EAAE,WAAW;wBAC9B,OAAO,UAAU,EAAE,SAAS;0BAC5B,OAAO,UAAU,EAAE,WAAW;+BAC9B,OAAO,UAAU,EAAE,gBAAgB;yBACnC,OAAO,UAAU,EAAE,UAAU"}

package/types/lib/header-validator.d.ts

@@ -0,0 +1,2 @@
+export function CarHeader(obj: any): boolean;
+//# sourceMappingURL=header-validator.d.ts.map

package/types/lib/header-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"header-validator.d.ts","sourceRoot":"","sources":["../../lib/header-validator.js"],"names":[],"mappings":"AAsB4B,+BAAK,GAAG,GAAG,OAAO,CAAA"}

package/types/lib/reader-browser.d.ts

@@ -1,8 +1,16 @@
+/**
+ * @private
+ * @param {BytesReader} reader
+ * @returns {Promise<CarReader>}
+ */
+export function decodeReaderComplete(reader: BytesReader): Promise<CarReader>;
 /**
  * @typedef {import('multiformats').CID} CID
  * @typedef {import('../api').Block} Block
  * @typedef {import('../api').CarReader} CarReaderIface
  * @typedef {import('./coding').BytesReader} BytesReader
+ * @typedef {import('./coding').CarHeader} CarHeader
+ * @typedef {import('./coding').CarV2Header} CarV2Header
  */
 /**
  * Provides blockstore-like access to a CAR.
@@ -23,7 +31,7 @@
  * @class
  * @implements {CarReaderIface}
  * @property {number} version The version number of the CAR referenced by this
- * reader (should be `1`).
+ * reader (should be `1` or `2`).
  */
 export class CarReader implements CarReaderIface {
     /**
@@ -57,13 +65,11 @@ export class CarReader implements CarReaderIface {
     static fromIterable(asyncIterable: AsyncIterable<Uint8Array>): Promise<CarReader>;
     /**
      * @constructs CarReader
-     * @param {number} version
-     * @param {CID[]} roots
+     * @param {CarHeader|CarV2Header} header
      * @param {Block[]} blocks
      */
-    constructor(version: number, roots: CID[], blocks: Block[]);
-    _version: number;
-    _roots: import("multiformats").CID[];
+    constructor(header: CarHeader | CarV2Header, blocks: Block[]);
+    _header: import("./coding").CarHeader | import("./coding").CarV2Header;
     _blocks: import("../api").Block[];
     _keys: string[];
     /**
@@ -71,7 +77,7 @@ export class CarReader implements CarReaderIface {
      * @memberof CarReader
      * @instance
      */
-    get version(): number;
+    get version(): 1 | 2;
     /**
      * Get the list of roots defined by the CAR referenced by this reader. May be
      * zero or more `CID`s.
@@ -140,4 +146,6 @@ export type CID = import('multiformats').CID;
 export type Block = import('../api').Block;
 export type CarReaderIface = import('../api').CarReader;
 export type BytesReader = import('./coding').BytesReader;
+export type CarHeader = import('./coding').CarHeader;
+export type CarV2Header = import('./coding').CarV2Header;
 //# sourceMappingURL=reader-browser.d.ts.map

package/types/lib/reader-browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reader-browser.d.ts","sourceRoot":"","sources":["../../lib/reader-browser.js"],"names":[],"mappings":"AAEA;;;;;GAKG;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH;IA+GE;;;;;;;;;;OAUG;IACH,wBAHW,UAAU,GACR,QAAQ,SAAS,CAAC,CAS9B;IAED;;;;;;;;;;;;;;;OAeG;IACH,mCAHW,cAAc,UAAU,CAAC,GACvB,QAAQ,SAAS,CAAC,CAS9B;IAzJD;;;;;OAKG;IACH,qBAJW,MAAM,SACN,GAAG,EAAE,UACL,KAAK,EAAE,EAOjB;IAJC,iBAAuB;IACvB,qCAAmB;IACnB,kCAAqB;IACrB,gBAAgD;IAGlD;;;;OAIG;IACH,sBAEC;IAED;;;;;;;;;OASG;IACH,YAFa,QAAQ,GAAG,EAAE,CAAC,CAM1B;IAED;;;;;;;;;;OAUG;IACH,SAHW,GAAG,GACD,QAAQ,OAAO,CAAC,CAM5B;IAED;;;;;;;;;;;;OAYG;IACH,SAHW,GAAG,GACD,QAAQ,KAAK,GAAG,SAAS,CAAC,CAOtC;IAED;;;;;;;;;;;OAWG;IACH,UAFa,eAAe,KAAK,CAAC,CAMjC;IAED;;;;;;;;;;OAUG;IACH,QAFa,eAAe,GAAG,CAAC,CAM/B;CA8CF;AAoBD,6BAA6B;kBA1MhB,OAAO,cAAc,EAAE,GAAG;oBAC1B,OAAO,QAAQ,EAAE,KAAK;6BACtB,OAAO,QAAQ,EAAE,SAAS;0BAC1B,OAAO,UAAU,EAAE,WAAW"}
+{"version":3,"file":"reader-browser.d.ts","sourceRoot":"","sources":["../../lib/reader-browser.js"],"names":[],"mappings":"AA2LA;;;;GAIG;AACH,6CAHW,WAAW,GACT,QAAQ,SAAS,CAAC,CAa9B;AAzMD;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH;IA6GE;;;;;;;;;;OAUG;IACH,wBAHW,UAAU,GACR,QAAQ,SAAS,CAAC,CAS9B;IAED;;;;;;;;;;;;;;;OAeG;IACH,mCAHW,cAAc,UAAU,CAAC,GACvB,QAAQ,SAAS,CAAC,CAS9B;IAvJD;;;;OAIG;IACH,oBAHW,SAAS,GAAC,WAAW,UACrB,KAAK,EAAE,EAMjB;IAHC,uEAAqB;IACrB,kCAAqB;IACrB,gBAAgD;IAGlD;;;;OAIG;IACH,qBAEC;IAED;;;;;;;;;OASG;IACH,YAFa,QAAQ,GAAG,EAAE,CAAC,CAM1B;IAED;;;;;;;;;;OAUG;IACH,SAHW,GAAG,GACD,QAAQ,OAAO,CAAC,CAM5B;IAED;;;;;;;;;;;;OAYG;IACH,SAHW,GAAG,GACD,QAAQ,KAAK,GAAG,SAAS,CAAC,CAOtC;IAED;;;;;;;;;;;OAWG;IACH,UAFa,eAAe,KAAK,CAAC,CAMjC;IAED;;;;;;;;;;OAUG;IACH,QAFa,eAAe,GAAG,CAAC,CAM/B;CA8CF;AAoBD,6BAA6B;kBA1MhB,OAAO,cAAc,EAAE,GAAG;oBAC1B,OAAO,QAAQ,EAAE,KAAK;6BACtB,OAAO,QAAQ,EAAE,SAAS;0BAC1B,OAAO,UAAU,EAAE,WAAW;wBAC9B,OAAO,UAAU,EAAE,SAAS;0BAC5B,OAAO,UAAU,EAAE,WAAW"}

package/types/test/_fixtures_to_js.d.mts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=_fixtures_to_js.d.mts.map

package/types/test/_fixtures_to_js.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_fixtures_to_js.d.mts","sourceRoot":"","sources":["../../test/_fixtures_to_js.mjs"],"names":[],"mappings":""}

package/types/test/common.d.ts

@@ -37,6 +37,19 @@ export const goCarIndex: {
     blockOffset: number;
     blockLength: number;
 }[];
+export const goCarV2Bytes: Uint8Array;
+export const goCarV2Roots: CID[];
+export const goCarV2Index: {
+    blockLength: number;
+    blockOffset: number;
+    cid: CID;
+    length: number;
+    offset: number;
+}[];
+/** @type {{[k in string]: any}} */
+export const goCarV2Contents: {
+    [x: string]: any;
+};
 /**
  * @typedef {import('../api').Block} Block
  * @typedef {import('@ipld/dag-pb').PBNode} PBNode

package/types/test/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../test/common.js"],"names":[],"mappings":"oBAUa,OAAO,QAAQ,EAAE,KAAK;qBACtB,OAAO,cAAc,EAAE,MAAM;AAmC1C;;;;;GAKG;AACH,gCALW,GAAG;UACI,MAAM;kBAAgB,GAAG,KAAK,UAAU;aAC/C,OAAO,kBAAkB,EAAE,UAAU,GACnC,QAAQ,SAAS,GAAG;IAAE,MAAM,EAAE,GAAG,CAAA;CAAE,CAAC,CAOhD;;AAED;;;;;;GAiDC;AAED;;;;GAIG;AACH,mCAJW,UAAU,aACV,MAAM,GACJ,cAAc,UAAU,CAAC,CAkBrC;AAvFD,yBAAuF;AAyFvF,kCAAw7C;AAEx7C,oCAA07C;AAE17C,+BAGC;AAED;;;;;;IASC;AA9ID;;;GAGG;AAEH;;GAEG;AACH;IACE;;;;OAIG;IACH,mBAJW,UAAU,OACV,GAAG,UACH,GAAG,EAMb;IAHC,kBAAkB;IAClB,SAAc;IACd,YAAoB;CAEvB"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../test/common.js"],"names":[],"mappings":"oBAUa,OAAO,QAAQ,EAAE,KAAK;qBACtB,OAAO,cAAc,EAAE,MAAM;AAmC1C;;;;;GAKG;AACH,gCALW,GAAG;UACI,MAAM;kBAAgB,GAAG,KAAK,UAAU;aAC/C,OAAO,kBAAkB,EAAE,UAAU,GACnC,QAAQ,SAAS,GAAG;IAAE,MAAM,EAAE,GAAG,CAAA;CAAE,CAAC,CAOhD;;AAED;;;;;;GAiDC;AAED;;;;GAIG;AACH,mCAJW,UAAU,aACV,MAAM,GACJ,cAAc,UAAU,CAAC,CAkBrC;AAvFD,yBAAuF;AAyFvF,kCAAw7C;AAGx7C,oCAA07C;AAC17C,+BAGC;AACD;;;;;;IASC;AAED,sCAA47C;AAC57C,iCAAkF;AAClF;;;;;;IAMC;AACD,mCAAmC;AACnC;;EA+BC;AAxLD;;;GAGG;AAEH;;GAEG;AACH;IACE;;;;OAIG;IACH,mBAJW,UAAU,OACV,GAAG,UACH,GAAG,EAMb;IAHC,kBAAkB;IAClB,SAAc;IACd,YAAoB;CAEvB"}

package/types/test/fixtures-expectations.d.ts

@@ -0,0 +1,63 @@
+export const expectations: {
+    'sample-v1.car': {
+        version: number;
+        err: null;
+        cids: string[];
+    };
+    'sample-v1-noidentity.car': {
+        version: number;
+        err: null;
+        cids: string[];
+    };
+    'sample-unixfs-v2.car': {
+        version: number;
+        err: null;
+        cids: string[];
+    };
+    'sample-rw-bs-v2.car': {
+        version: number;
+        err: null;
+        cids: string[];
+    };
+    'sample-v1-with-zero-len-section.car': {
+        version: number;
+        err: null;
+        cids: null;
+    };
+    'sample-v1-with-zero-len-section2.car': {
+        version: number;
+        err: null;
+        cids: null;
+    };
+    'sample-wrapped-v2.car': {
+        version: number;
+        err: null;
+        cids: string[];
+    };
+    'sample-rootless-v42.car': {
+        version: null;
+        err: string;
+        cids: null;
+    };
+    'sample-v1-tailing-corrupt-section.car': {
+        version: number;
+        err: null;
+        cids: null;
+    };
+    'sample-v2-corrupt-data-and-index.car': {
+        version: number;
+        err: string;
+        cids: null;
+    };
+    'sample-corrupt-pragma.car': {
+        version: null;
+        err: string;
+        cids: null;
+    };
+    'sample-v2-indexless.car': {
+        version: number;
+        err: null;
+        cids: string[];
+    };
+};
+//# sourceMappingURL=fixtures-expectations.d.ts.map

package/types/test/fixtures-expectations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fixtures-expectations.d.ts","sourceRoot":"","sources":["../../test/fixtures-expectations.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAuqIC"}

package/types/test/fixtures.d.ts

@@ -0,0 +1,3 @@
+/** @type {Record<string, string>} */
+export const data: Record<string, string>;
+//# sourceMappingURL=fixtures.d.ts.map

package/types/test/fixtures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fixtures.d.ts","sourceRoot":"","sources":["../../test/fixtures.js"],"names":[],"mappings":"AAAA,qCAAqC;AACrC,mBADW,OAAO,MAAM,EAAE,MAAM,CAAC,CAgBhC"}

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":""}