@ipld/car - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

package.json

 {
   "name": "@ipld/car",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Content Addressable aRchive format reader and writer",
@@ -13,3 +13,3 @@ "main": "./cjs/car.js",
     "build:js": "ipjs build --tests --main && npm run build:copy",
-    "build:copy": "cp -a tsconfig.json *.js *.ts lib/ test/ dist/",
+    "build:copy": "mkdir -p dist/examples/ && cp -a tsconfig.json *.js *.ts lib/ test/ dist/ && cp examples/*.* dist/examples/",
     "build:types": "npm run build:copy && cd dist && tsc --build",
@@ -22,3 +22,3 @@ "prepublishOnly": "npm run build",
     "test:cjs:browser": "polendina --cleanup dist/cjs/browser-test/test-*.js",
-    "test": "npm run lint && npm run test:node && npm run test:cjs",
+    "test": "npm run lint && npm run test:node && 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",
@@ -47,3 +47,3 @@ "docs": "jsdoc4readme --readme --description-only lib/reader*.js lib/indexed-reader.js lib/iterator.js lib/indexer.js lib/writer.js"
     "@types/mocha": "^8.2.2",
-    "@types/node": "^14.14.41",
+    "@types/node": "^15.0.2",
     "@typescript-eslint/eslint-plugin": "^4.22.0",
@@ -65,3 +65,3 @@ "@typescript-eslint/parser": "^4.22.0",
     "@types/varint": "^6.0.0",
-    "multiformats": "^7.0.0",
+    "multiformats": "^8.0.3",
     "varint": "^6.0.0"
@@ -68,0 +68,0 @@ },

README.md

@@ -28,4 +28,4 @@ # @ipld/car
 import { CarReader, CarWriter } from '@ipld/car'
-import raw from 'multiformats/codecs/raw'
-import CID from 'multiformats/cid'
+import * as raw from 'multiformats/codecs/raw'
+import { CID } from 'multiformats/cid'
 import { sha256 } from 'multiformats/hashes/sha2'
@@ -74,2 +74,4 @@
 
+See the [examples](./examples) directory for more.
+
 ## Usage
@@ -81,2 +83,9 @@
 
+Please be aware that `@ipld/car` **does not validate** that block data matches
+the paired CIDs when reading a CAR. See the
+[verify-car.js](./examples/verify-car.js) example for one possible approach to
+validating blocks as they are read. Any CID verification requires that the hash
+function that was used to generate the CID be available, the CAR format does
+not restrict the allowable multihashes.
+
 ### [`CarReader`](#CarReader)
@@ -83,0 +92,0 @@

tsconfig.json

@@ -43,5 +43,5 @@ {
     "cjs",
-    "example*.js"
+    "examples"
   ],
   "compileOnSave": false
 }

New alerts

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

678444

79.96%

Number of package files

164

2.5%

Lines of code

16778

67.29%

Number of lines in readme file

716

1.27%

Worsened metrics

Number of low supply chain risk alerts

42

2.44%

Number of medium supply chain risk alerts

1

Infinity%

Dependency changes

• - Removed

  @multiformats/base-x@4.0.1
  (transitive)

• - Removed

  base64-js@1.5.1
  (transitive)

• - Removed

  buffer@6.0.3
  (transitive)

• - Removed

  cids@1.1.9
  (transitive)

• - Removed

  ieee754@1.2.1
  (transitive)

• - Removed

  multibase@4.0.6
  (transitive)

• - Removed

  multicodec@3.2.1
  (transitive)

• - Removed

  multiformats@7.0.09.9.0
  (transitive)

• - Removed

  multihashes@4.0.3
  (transitive)

• - Removed

  uint8arrays@3.1.1
  (transitive)

• - Removed

  varint@5.0.2
  (transitive)

• Updated

  multiformats@^8.0.3