@ipld/car 5.1.1 → 5.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ipld/car",
-  "version": "5.1.1",
+  "version": "5.2.1",
   "description": "Content Addressable aRchive format reader and writer",
   "author": "Rod <rod@vagg.org> (http://r.va.gg/)",
   "license": "Apache-2.0 OR MIT",
@@ -206,11 +206,8 @@
   "devDependencies": {
     "@ipld/dag-pb": "^4.0.0",
     "@ipld/garbage": "^6.0.0",
-    "@types/node": "^18.0.0",
     "@types/varint": "^6.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.6.0",
-    "@typescript-eslint/parser": "^5.6.0",
-    "aegir": "^37.5.6",
+    "aegir": "^40.0.11",
     "jsdoc4readme": "^1.4.0"
   },
   "browser": {

package/src/buffer-decoder.js

@@ -1,8 +1,8 @@
+import { decode as decodeDagCbor } from '@ipld/dag-cbor'
 import { CID } from 'multiformats/cid'
 import * as Digest from 'multiformats/hashes/digest'
-import { decode as decodeDagCbor } from '@ipld/dag-cbor'
-import { CarHeader as headerValidator } from './header-validator.js'
 import { CIDV0_BYTES, decodeV2Header, decodeVarint, getMultihashLength, V2_HEADER_LENGTH } from './decoder-common.js'
+import { CarHeader as headerValidator } from './header-validator.js'
 
 /**
  * @typedef {import('./api').Block} Block
@@ -50,8 +50,6 @@ export function readHeader (reader, strictVersion) {
   reader.seek(v2Header.dataOffset - reader.pos)
   const v1Header = readHeader(reader, 1)
   return Object.assign(v1Header, v2Header)
-  /* c8 ignore next 2 */
-  // Node.js 12 c8 bug
 }
 
 /**
@@ -77,8 +75,6 @@ function readCid (reader) {
   const bytes = reader.exactly(getMultihashLength(reader.upTo(8)), true)
   const multihash = Digest.decode(bytes)
   return CID.create(version, codec, multihash)
-  /* c8 ignore next 2 */
-  // Node.js 12 c8 bug
 }
 
 /**
@@ -104,8 +100,6 @@ export function readBlockHead (reader) {
   const blockLength = length - Number(reader.pos - start) // subtract CID length
 
   return { cid, length, blockLength }
-  /* c8 ignore next 2 */
-  // Node.js 12 c8 bug
 }
 
 /**
@@ -148,8 +142,6 @@ export function bytesReader (bytes) {
   return {
     upTo (length) {
       return bytes.subarray(pos, pos + Math.min(length, bytes.length - pos))
-      /* c8 ignore next 2 */
-      // Node.js 12 c8 bug
     },
 
     exactly (length, seek = false) {
@@ -162,8 +154,6 @@ export function bytesReader (bytes) {
         pos += length
       }
       return out
-      /* c8 ignore next 2 */
-      // Node.js 12 c8 bug
     },
 
     seek (length) {
@@ -197,8 +187,6 @@ export function limitReader (reader, byteLimit) {
         bytes = bytes.subarray(0, byteLimit - bytesRead)
       }
       return bytes
-      /* c8 ignore next 2 */
-      // Node.js 12 c8 bug
     },
 
     exactly (length, seek = false) {
@@ -210,8 +198,6 @@ export function limitReader (reader, byteLimit) {
         bytesRead += length
       }
       return bytes
-      /* c8 ignore next 2 */
-      // Node.js 12 c8 bug
     },
 
     seek (length) {

package/src/buffer-reader-browser.js

@@ -61,8 +61,6 @@ export class CarBufferReader {
    */
   getRoots () {
     return this._header.roots
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**
@@ -77,8 +75,6 @@ export class CarBufferReader {
    */
   has (key) {
     return this._blocks.some(b => b.cid.equals(key))
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**
@@ -95,8 +91,6 @@ export class CarBufferReader {
    */
   get (key) {
     return this._blocks.find(b => b.cid.equals(key))
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**

package/src/buffer-reader.js

@@ -45,8 +45,6 @@ export class CarBufferReader extends BrowserCarBufferReader {
       throw new Error(`Failed to read entire block (${read} instead of ${blockLength})`)
     }
     return { cid, bytes }
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 }
 

package/src/buffer-writer.js

@@ -1,7 +1,7 @@
-import varint from 'varint'
+import * as CBOR from '@ipld/dag-cbor'
 import { Token, Type } from 'cborg'
 import { tokensToLength } from 'cborg/length'
-import * as CBOR from '@ipld/dag-cbor'
+import varint from 'varint'
 
 /**
  * @typedef {import('./api').CID} CID

package/src/coding.ts

@@ -1,5 +1,5 @@
-import type { CID } from 'multiformats/cid'
 import type { Block, BlockIndex } from './api.js'
+import type { CID } from 'multiformats/cid'
 
 export interface CarEncoder {
   setRoots: (roots: CID[]) => Promise<void>
@@ -38,7 +38,7 @@ export interface CarV2Header extends CarV2FixedHeader {
 }
 
 export interface CarDecoder {
-  header: () => Promise<CarHeader|CarV2Header>
+  header: () => Promise<CarHeader | CarV2Header>
 
   blocks: () => AsyncGenerator<Block>
 
@@ -57,7 +57,7 @@ export interface BytesReader extends Seekable {
   pos: number
 }
 
-export interface BytesBufferReader extends Seekable{
+export interface BytesBufferReader extends Seekable {
   upTo: (length: number) => Uint8Array
 
   exactly: (length: number, seek?: boolean) => Uint8Array

package/src/decoder-common.js

@@ -27,8 +27,6 @@ export function decodeVarint (bytes, seeker) {
   const i = varint.decode(bytes)
   seeker.seek(/** @type {number} */(varint.decode.bytes))
   return i
-  /* c8 ignore next 2 */
-  // Node.js 12 c8 bug
 }
 
 /**
@@ -57,8 +55,6 @@ export function decodeV2Header (bytes) {
     indexOffset: Number(dv.getBigUint64(offset += 8, true))
   }
   return header
-  /* c8 ignore next 2 */
-  // Node.js 12 c8 bug
 }
 
 /**

package/src/decoder.js

@@ -1,8 +1,8 @@
+import { decode as decodeDagCbor } from '@ipld/dag-cbor'
 import { CID } from 'multiformats/cid'
 import * as Digest from 'multiformats/hashes/digest'
-import { decode as decodeDagCbor } from '@ipld/dag-cbor'
-import { CarHeader as headerValidator } from './header-validator.js'
 import { CIDV0_BYTES, decodeV2Header, decodeVarint, getMultihashLength, V2_HEADER_LENGTH } from './decoder-common.js'
+import { CarHeader as headerValidator } from './header-validator.js'
 
 /**
  * @typedef {import('./api').Block} Block
@@ -51,8 +51,6 @@ export async function readHeader (reader, strictVersion) {
   reader.seek(v2Header.dataOffset - reader.pos)
   const v1Header = await readHeader(reader, 1)
   return Object.assign(v1Header, v2Header)
-  /* c8 ignore next 2 */
-  // Node.js 12 c8 bug
 }
 
 /**
@@ -76,8 +74,6 @@ async function readCid (reader) {
   const bytes = await reader.exactly(getMultihashLength(await reader.upTo(8)), true)
   const multihash = Digest.decode(bytes)
   return CID.create(version, codec, multihash)
-  /* c8 ignore next 2 */
-  // Node.js 12 c8 bug
 }
 
 /**
@@ -103,8 +99,6 @@ export async function readBlockHead (reader) {
   const blockLength = length - Number(reader.pos - start) // subtract CID length
 
   return { cid, length, blockLength }
-  /* c8 ignore next 2 */
-  // Node.js 12 c8 bug
 }
 
 /**
@@ -115,8 +109,6 @@ async function readBlock (reader) {
   const { cid, blockLength } = await readBlockHead(reader)
   const bytes = await reader.exactly(blockLength, true)
   return { bytes, cid }
-  /* c8 ignore next 2 */
-  // Node.js 12 c8 bug
 }
 
 /**
@@ -129,8 +121,6 @@ async function readBlockIndex (reader) {
   const index = { cid, length, blockLength, offset, blockOffset: reader.pos }
   reader.seek(index.blockLength)
   return index
-  /* c8 ignore next 2 */
-  // Node.js 12 c8 bug
 }
 
 /**
@@ -150,8 +140,6 @@ export function createDecoder (reader) {
       reader = limitReader(reader, header.dataSize - v1length)
     }
     return header
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   })()
 
   return {
@@ -187,9 +175,7 @@ export function bytesReader (bytes) {
   return {
     async upTo (length) {
       const out = bytes.subarray(pos, pos + Math.min(length, bytes.length - pos))
-      /* c8 ignore next 2 */
       return out
-      // Node.js 12 c8 bug
     },
 
     async exactly (length, seek = false) {
@@ -201,8 +187,6 @@ export function bytesReader (bytes) {
         pos += length
       }
       return out
-      /* c8 ignore next 2 */
-      // Node.js 12 c8 bug
     },
 
     seek (length) {
@@ -266,8 +250,6 @@ export function chunkReader (readChunk /*, closer */) {
         await read(length)
       }
       return currentChunk.subarray(offset, offset + Math.min(currentChunk.length - offset, length))
-      /* c8 ignore next 2 */
-      // Node.js 12 c8 bug
     },
 
     async exactly (length, seek = false) {
@@ -283,8 +265,6 @@ export function chunkReader (readChunk /*, closer */) {
         offset += length
       }
       return out
-      /* c8 ignore next 2 */
-      // Node.js 12 c8 bug
     },
 
     seek (length) {
@@ -315,8 +295,6 @@ export function asyncIterableReader (asyncIterable) {
       return null
     }
     return next.value
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   return chunkReader(readChunk)
@@ -343,8 +321,6 @@ export function limitReader (reader, byteLimit) {
         bytes = bytes.subarray(0, byteLimit - bytesRead)
       }
       return bytes
-      /* c8 ignore next 2 */
-      // Node.js 12 c8 bug
     },
 
     async exactly (length, seek = false) {
@@ -356,8 +332,6 @@ export function limitReader (reader, byteLimit) {
         bytesRead += length
       }
       return bytes
-      /* c8 ignore next 2 */
-      // Node.js 12 c8 bug
     },
 
     seek (length) {

package/src/encoder.js

@@ -1,5 +1,5 @@
-import varint from 'varint'
 import { encode as dagCborEncode } from '@ipld/dag-cbor'
+import varint from 'varint'
 
 /**
  * @typedef {import('multiformats').CID} CID
@@ -60,8 +60,6 @@ function createEncoder (writer) {
      */
     async close () {
       await writer.end()
-      /* c8 ignore next 2 */
-      // Node.js 12 c8 bug
     }
   }
 }

package/src/index-browser.js

@@ -1,10 +1,10 @@
-import { CarReader } from './reader-browser.js'
+import { CarBufferReader } from './buffer-reader.js'
+import * as CarBufferWriter from './buffer-writer.js'
+import { CarIndexedReader } from './indexed-reader-browser.js'
 import { CarIndexer } from './indexer.js'
 import { CarBlockIterator, CarCIDIterator } from './iterator.js'
+import { CarReader } from './reader-browser.js'
 import { CarWriter } from './writer-browser.js'
-import { CarIndexedReader } from './indexed-reader-browser.js'
-import { CarBufferReader } from './buffer-reader.js'
-import * as CarBufferWriter from './buffer-writer.js'
 
 export {
   CarReader,

package/src/index.js

@@ -1,10 +1,13 @@
-import { CarReader } from './reader.js'
 import { CarBufferReader } from './buffer-reader.js'
+import * as CarBufferWriter from './buffer-writer.js'
+import { CarIndexedReader } from './indexed-reader.js'
 import { CarIndexer } from './indexer.js'
 import { CarBlockIterator, CarCIDIterator } from './iterator.js'
+import { CarReader } from './reader.js'
 import { CarWriter } from './writer.js'
-import { CarIndexedReader } from './indexed-reader.js'
-import * as CarBufferWriter from './buffer-writer.js'
+
+// @see https://www.iana.org/assignments/media-types/application/vnd.ipld.car
+export const contentType = 'application/vnd.ipld.car'
 
 export {
   CarReader,

package/src/indexed-reader.js

@@ -76,8 +76,6 @@ export class CarIndexedReader {
    */
   async getRoots () {
     return this._roots
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**
@@ -92,8 +90,6 @@ export class CarIndexedReader {
    */
   async has (key) {
     return this._index.has(key.toString())
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**
@@ -122,8 +118,6 @@ export class CarIndexedReader {
       blockOffset: blockIndex.blockOffset
     }
     return NodeCarReader.readRaw(this._fd, readIndex)
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**
@@ -177,8 +171,6 @@ export class CarIndexedReader {
     if (this._fd) {
       return this._fd.close()
     }
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**
@@ -213,8 +205,6 @@ export class CarIndexedReader {
       order.push(cidStr)
     }
     return new CarIndexedReader(iterable.version, path, await iterable.getRoots(), index, order)
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 }
 

package/src/indexer.js

@@ -70,8 +70,6 @@ export class CarIndexer {
    */
   async getRoots () {
     return this._roots
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**
@@ -97,8 +95,6 @@ export class CarIndexer {
       throw new TypeError('fromBytes() requires a Uint8Array')
     }
     return decodeIndexerComplete(bytesReader(bytes))
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**
@@ -118,8 +114,6 @@ export class CarIndexer {
       throw new TypeError('fromIterable() requires an async iterable')
     }
     return decodeIndexerComplete(asyncIterableReader(asyncIterable))
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 }
 
@@ -133,6 +127,4 @@ async function decodeIndexerComplete (reader) {
   const { version, roots } = await decoder.header()
 
   return new CarIndexer(version, roots, decoder.blocksIndex())
-  /* c8 ignore next 2 */
-  // Node.js 12 c8 bug
 }

package/src/iterator-channel.js

@@ -53,8 +53,6 @@ export function create () {
       const drainer = makeDrainer()
       outWaitResolver()
       await drainer
-      /* c8 ignore next 2 */
-      // Node.js 12 c8 bug
     }
   }
 
@@ -86,8 +84,6 @@ export function create () {
       }
 
       return outWait
-      /* c8 ignore next 2 */
-      // Node.js 12 c8 bug
     }
   }
 

package/src/iterator.js

@@ -38,8 +38,6 @@ export class CarIteratorBase {
    */
   async getRoots () {
     return this._roots
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 }
 
@@ -114,8 +112,6 @@ export class CarBlockIterator extends CarIteratorBase {
   static async fromBytes (bytes) {
     const { version, roots, iterator } = await fromBytes(bytes)
     return new CarBlockIterator(version, roots, iterator)
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**
@@ -133,8 +129,6 @@ export class CarBlockIterator extends CarIteratorBase {
   static async fromIterable (asyncIterable) {
     const { version, roots, iterator } = await fromIterable(asyncIterable)
     return new CarBlockIterator(version, roots, iterator)
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 }
 
@@ -199,8 +193,6 @@ export class CarCIDIterator extends CarIteratorBase {
           return next
         }
         return { done: false, value: next.value.cid }
-        /* c8 ignore next 2 */
-        // Node.js 12 c8 bug
       }
     }
   }
@@ -220,8 +212,6 @@ export class CarCIDIterator extends CarIteratorBase {
   static async fromBytes (bytes) {
     const { version, roots, iterator } = await fromBytes(bytes)
     return new CarCIDIterator(version, roots, iterator)
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**
@@ -240,8 +230,6 @@ export class CarCIDIterator extends CarIteratorBase {
   static async fromIterable (asyncIterable) {
     const { version, roots, iterator } = await fromIterable(asyncIterable)
     return new CarCIDIterator(version, roots, iterator)
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 }
 
@@ -254,8 +242,6 @@ async function fromBytes (bytes) {
     throw new TypeError('fromBytes() requires a Uint8Array')
   }
   return decodeIterator(bytesReader(bytes))
-  /* c8 ignore next 2 */
-  // Node.js 12 c8 bug
 }
 
 /**
@@ -267,8 +253,6 @@ async function fromIterable (asyncIterable) {
     throw new TypeError('fromIterable() requires an async iterable')
   }
   return decodeIterator(asyncIterableReader(asyncIterable))
-  /* c8 ignore next 2 */
-  // Node.js 12 c8 bug
 }
 
 /**
@@ -280,6 +264,4 @@ async function decodeIterator (reader) {
   const decoder = createDecoder(reader)
   const { version, roots } = await decoder.header()
   return { version, roots, iterator: decoder.blocks() }
-  /* c8 ignore next 2 */
-  // Node.js 12 c8 bug
 }

package/src/reader-browser.js

@@ -63,8 +63,6 @@ export class CarReader {
    */
   async getRoots () {
     return this._header.roots
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**
@@ -80,8 +78,6 @@ export class CarReader {
    */
   async has (key) {
     return this._keys.indexOf(key.toString()) > -1
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**
@@ -100,8 +96,6 @@ export class CarReader {
   async get (key) {
     const index = this._keys.indexOf(key.toString())
     return index > -1 ? this._blocks[index] : undefined
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**
@@ -155,8 +149,6 @@ export class CarReader {
       throw new TypeError('fromBytes() requires a Uint8Array')
     }
     return decodeReaderComplete(bytesReader(bytes))
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**
@@ -180,8 +172,6 @@ export class CarReader {
       throw new TypeError('fromIterable() requires an async iterable')
     }
     return decodeReaderComplete(asyncIterableReader(asyncIterable))
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 }
 
@@ -199,8 +189,6 @@ export async function decodeReaderComplete (reader) {
   }
 
   return new CarReader(header, blocks)
-  /* c8 ignore next 2 */
-  // Node.js 12 c8 bug
 }
 
 export const __browser = true

package/src/reader.js

@@ -50,8 +50,6 @@ export class CarReader extends BrowserCarReader {
       throw new Error(`Failed to read entire block (${read} instead of ${blockLength})`)
     }
     return { cid, bytes }
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 }
 

package/src/writer-browser.js

@@ -1,7 +1,7 @@
 import { CID } from 'multiformats/cid'
+import { bytesReader, readHeader } from './decoder.js'
 import { createEncoder, createHeader } from './encoder.js'
 import { create as iteratorChannel } from './iterator-channel.js'
-import { bytesReader, readHeader } from './decoder.js'
 
 /**
  * @typedef {import('./api').Block} Block
@@ -83,8 +83,6 @@ export class CarWriter {
     }
     this._mutex = this._mutex.then(() => this._encoder.writeBlock({ cid, bytes: block.bytes }))
     return this._mutex
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**
@@ -104,8 +102,6 @@ export class CarWriter {
     await this._mutex
     this._ended = true
     return this._encoder.close()
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 
   /**
@@ -181,8 +177,6 @@ export class CarWriter {
     }
     bytes.set(newHeader, 0)
     return bytes
-    /* c8 ignore next 2 */
-    // Node.js 12 c8 bug
   }
 }
 

package/src/writer.js

@@ -1,8 +1,8 @@
 import fs from 'fs'
 import { promisify } from 'util'
-import { CarWriter as BrowserCarWriter } from './writer-browser.js'
 import { readHeader, chunkReader } from './decoder.js'
 import { createHeader } from './encoder.js'
+import { CarWriter as BrowserCarWriter } from './writer-browser.js'
 
 const fsread = promisify(fs.read)
 const fswrite = promisify(fs.write)
@@ -64,8 +64,6 @@ export class CarWriter extends BrowserCarWriter {
       const read = await readChunk()
       offset += read
       // TODO: test header > 256 bytes
-      // also Node.js 12 c8 bug
-      /* c8 ignore next 2 */
       return read < chunkSize ? bytes.subarray(0, read) : bytes
     })