@ipld/car - npm Package Compare versions

Comparing version 4.1.6 to 5.0.0

package.json

 {
   "name": "@ipld/car",
-  "version": "4.1.6",
+  "version": "5.0.0",
   "description": "Content Addressable aRchive format reader and writer",
-  "main": "./cjs/car.js",
-  "types": "./types/car.d.ts",
-  "scripts": {
-    "lint": "standard",
-    "build": "npm run build:js && npm run build:types",
-    "build:js": "ipjs build --tests --main && npm run build:copy",
-    "build:copy": "mkdir -p dist/examples/ && cp -a tsconfig.json .npmignore *.js *.ts lib test dist/ && cp examples/*.* dist/examples/ && rm -rf dist/test/fixtures/",
-    "build:types": "tsc --build && mv types dist",
-    "test:cjs": "rm -rf dist && npm run build && cp test/go.car dist/cjs/node-test/ && mocha dist/cjs/node-test/test-*.js && mocha dist/cjs/node-test/node-test-*.js && npm run test:cjs:browser",
-    "test:esm": "rm -rf dist && npm run build && cp test/go.car dist/esm/node-test/ && mocha dist/esm/node-test/test-*.js && mocha dist/esm/node-test/node-test-*.js && npm run test:esm:browser",
-    "test:node": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --exclude lib/header-validator.js --exclude test/ mocha test/test-*.js test/node-test-*.js",
-    "test:cjs:browser": "polendina --page --worker --serviceworker --cleanup dist/cjs/browser-test/test-*.js",
-    "test:esm:browser": "polendina --page --worker --serviceworker --cleanup dist/esm/browser-test/test-*.js",
-    "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/buffer-writer.js lib/decoder.js"
+  "author": "Rod <[e-mail]> (http://r.va.gg/)",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/ipld/js-car#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ipld/js-car.git"
   },
+  "bugs": {
+    "url": "https://github.com/ipld/js-car/issues"
+  },
   "keywords": [
     "car",
+    "ipfs",
     "ipld",
-    "ipfs",
     "multiformats"
   ],
-  "author": "Rod <[e-mail]> (http://r.va.gg/)",
-  "license": "(Apache-2.0 AND MIT)",
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
+  },
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ],
+      "src/*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ]
+    }
+  },
+  "files": [
+    "src",
+    "dist",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
   "exports": {
     ".": {
-      "browser": "./esm/car-browser.js",
-      "require": "./cjs/car.js",
-      "import": "./esm/car.js"
+      "types": "./dist/src/index.d.ts",
+      "import": "./src/index.js",
+      "browser": "./src/index-browser.js"
     },
+    "./buffer-writer": {
+      "types": "./dist/src/buffer-writer.d.ts",
+      "import": "./src/buffer-writer.js"
+    },
     "./decoder": {
-      "browser": "./esm/lib/decoder.js",
-      "require": "./cjs/lib/decoder.js",
-      "import": "./esm/lib/decoder.js"
+      "types": "./dist/src/decoder.d.ts",
+      "import": "./src/decoder.js"
     },
-    "./reader": {
-      "browser": "./esm/lib/reader-browser.js",
-      "require": "./cjs/lib/reader.js",
-      "import": "./esm/lib/reader.js"
-    },
     "./indexed-reader": {
-      "browser": "./esm/lib/indexed-reader-browser.js",
-      "require": "./cjs/lib/indexed-reader.js",
-      "import": "./esm/lib/indexed-reader.js"
+      "types": "./dist/src/indexed-reader.d.ts",
+      "browser": "./src/indexed-reader-browser.js",
+      "import": "./src/indexed-reader.js"
     },
     "./indexer": {
-      "browser": "./esm/lib/indexer.js",
-      "require": "./cjs/lib/indexer.js",
-      "import": "./esm/lib/indexer.js"
+      "types": "./dist/src/indexer.d.ts",
+      "import": "./src/indexer.js"
     },
     "./iterator": {
-      "browser": "./esm/lib/iterator.js",
-      "require": "./cjs/lib/iterator.js",
-      "import": "./esm/lib/iterator.js"
+      "types": "./dist/src/iterator.d.ts",
+      "import": "./src/iterator.js"
     },
+    "./reader": {
+      "types": "./dist/src/reader.d.ts",
+      "browser": "./src/reader-browser.js",
+      "import": "./src/reader.js"
+    },
     "./writer": {
-      "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"
+      "types": "./dist/src/writer.d.ts",
+      "browser": "./src/writer-browser.js",
+      "import": "./src/writer.js"
     }
   },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    }
+  },
+  "scripts": {
+    "clean": "aegir clean",
+    "lint": "aegir lint",
+    "build": "aegir build",
+    "release": "aegir release",
+    "test": "npm run lint && aegir test && npm run test:examples",
+    "test:node": "aegir test -t node --cov",
+    "test:chrome": "aegir test -t browser --cov",
+    "test:chrome-webworker": "aegir test -t webworker",
+    "test:firefox": "aegir test -t browser -- --browser firefox",
+    "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
+    "test:electron-main": "aegir test -t electron-main",
+    "test:examples": "npm run test --prefix examples/",
+    "dep-check": "aegir dep-check",
+    "coverage": "c8 --reporter=html --reporter=text mocha test/test-*.js && npx st -d coverage -p 8888",
+    "docs": "jsdoc4readme --readme --description-only src/reader*.js src/indexed-reader.js src/iterator.js src/indexer.js src/writer*.js src/buffer-writer.js src/decoder.js"
+  },
   "dependencies": {
-    "@ipld/dag-cbor": "^7.0.0",
+    "@ipld/dag-cbor": "^8.0.0",
     "cborg": "^1.9.0",
-    "multiformats": "^9.5.4",
+    "multiformats": "^10.0.2",
     "varint": "^6.0.0"
   },
   "devDependencies": {
-    "@ipld/dag-pb": "^2.1.14",
-    "@types/chai": "^4.3.0",
-    "@types/chai-as-promised": "^7.1.4",
-    "@types/mocha": "^10.0.0",
+    "@ipld/dag-pb": "^3.0.0",
+    "@ipld/garbage": "^6.0.0",
     "@types/node": "^18.0.0",
@@ -88,13 +123,8 @@ "@types/varint": "^6.0.0",
     "@typescript-eslint/parser": "^5.6.0",
-    "c8": "^7.10.0",
-    "chai": "^4.3.4",
-    "chai-as-promised": "^7.1.1",
-    "ipjs": "^5.2.0",
-    "ipld-garbage": "^5.0.0",
-    "jsdoc4readme": "^1.4.0",
-    "mocha": "^10.0.0",
-    "polendina": "~3.1.0",
-    "standard": "^17.0.0",
-    "typescript": "~4.8.2"
+    "aegir": "^37.5.6",
+    "jsdoc4readme": "^1.4.0"
   },
+  "directories": {
+    "test": "test"
+  },
   "standard": {
@@ -105,148 +135,11 @@ "ignore": [
   },
-  "directories": {
-    "test": "test"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ipld/js-car.git"
-  },
-  "bugs": {
-    "url": "https://github.com/ipld/js-car/issues"
-  },
-  "homepage": "https://github.com/ipld/js-car#readme",
-  "typesVersions": {
-    "*": {
-      "reader": [
-        "types/lib/reader.d.ts"
-      ],
-      "decoder": [
-        "types/lib/decoder.d.ts"
-      ],
-      "indexed-reader": [
-        "types/lib/indexed-reader.d.ts"
-      ],
-      "indexer": [
-        "types/lib/indexer.d.ts"
-      ],
-      "iterator": [
-        "types/lib/iterator.d.ts"
-      ],
-      "writer": [
-        "types/lib/writer.d.ts"
-      ],
-      "buffer-writer": [
-        "types/lib/buffer-writer.d.ts"
-      ],
-      "*": [
-        "types/*"
-      ],
-      "types/*": [
-        "types/*"
-      ]
-    }
-  },
-  "release": {
-    "branches": [
-      "master"
-    ],
-    "plugins": [
-      [
-        "@semantic-release/commit-analyzer",
-        {
-          "preset": "conventionalcommits",
-          "releaseRules": [
-            {
-              "breaking": true,
-              "release": "major"
-            },
-            {
-              "revert": true,
-              "release": "patch"
-            },
-            {
-              "type": "feat",
-              "release": "minor"
-            },
-            {
-              "type": "fix",
-              "release": "patch"
-            },
-            {
-              "type": "chore",
-              "release": "patch"
-            },
-            {
-              "type": "docs",
-              "release": "patch"
-            },
-            {
-              "type": "test",
-              "release": "patch"
-            },
-            {
-              "scope": "no-release",
-              "release": false
-            }
-          ]
-        }
-      ],
-      [
-        "@semantic-release/release-notes-generator",
-        {
-          "preset": "conventionalcommits",
-          "presetConfig": {
-            "types": [
-              {
-                "type": "feat",
-                "section": "Features"
-              },
-              {
-                "type": "fix",
-                "section": "Bug Fixes"
-              },
-              {
-                "type": "chore",
-                "section": "Trivial Changes"
-              },
-              {
-                "type": "docs",
-                "section": "Trivial Changes"
-              },
-              {
-                "type": "test",
-                "section": "Tests"
-              }
-            ]
-          }
-        }
-      ],
-      "@semantic-release/changelog",
-      [
-        "@semantic-release/npm",
-        {
-          "pkgRoot": "dist"
-        }
-      ],
-      "@semantic-release/github",
-      "@semantic-release/git"
-    ]
-  },
   "browser": {
-    ".": "./cjs/car-browser.js",
-    "./esm/car.js": "./esm/car-browser.js",
-    "./cjs/car.js": "./cjs/car-browser.js",
-    "./decoder": "./cjs/lib/decoder.js",
-    "./reader": "./cjs/lib/reader-browser.js",
-    "./esm/lib/reader.js": "./esm/lib/reader-browser.js",
-    "./cjs/lib/reader.js": "./cjs/lib/reader-browser.js",
-    "./indexed-reader": "./cjs/lib/indexed-reader-browser.js",
-    "./esm/lib/indexed-reader.js": "./esm/lib/indexed-reader-browser.js",
-    "./cjs/lib/indexed-reader.js": "./cjs/lib/indexed-reader-browser.js",
-    "./indexer": "./cjs/lib/indexer.js",
-    "./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",
-    "./buffer-writer": "./cjs/lib/buffer-writer.js"
+    "./src/index.js": "./src/index-browser.js",
+    "./src/index-reader.js": "./src/index-reader-browser.js",
+    "./src/reader.js": "./src/reader-browser.js",
+    "./src/writer.js": "./src/writer-browser.js",
+    "fs": false,
+    "util": false,
+    "stream": false
   }
 }

README.md

 # @ipld/car
 
-A JavaScript Content Addressable aRchive (CAR) file reader and writer.
+[![codecov](https://img.shields.io/codecov/c/github/ipld/js-car.svg?style=flat-square)](https://codecov.io/gh/ipld/js-car)
+[![CI](https://img.shields.io/github/workflow/status/ipld/js-car/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipld/js-car/actions/workflows/js-test-and-release.yml)
 
+> Content Addressable aRchive format reader and writer
+
+## Install
+
+```console
+$ npm i @ipld/car
+```
+
 See also:
@@ -10,3 +19,2 @@
  * [IPLD](https://ipld.io)
- 
 
@@ -948,4 +956,4 @@ ## Contents
 
- * Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0)
- * MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT)
+ * Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+ * MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
@@ -952,0 +960,0 @@ ### Contribution

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 2 instances in 1 package

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

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

8

decreased by-55.56%

Number of lines in readme file

961

increased by0.84%

Number of low supply chain risk alerts

3

decreased by-95%

Number of medium supply chain risk alerts

1

decreased by-66.67%

Is type module

Yes

Worsened metrics

Total package byte prevSize

211654

decreased by-64.54%

Number of package files

56

decreased by-73.33%

License quality

80

decreased by-20%

Lines of code

3454

decreased by-77.66%

Dependency changes

• + Added@ipld/dag-cbor@8.0.1(transitive)

• + Addedmultiformats@10.0.311.0.2(transitive)

• - Removed@ipld/dag-cbor@7.0.3(transitive)

• - Removedmultiformats@9.9.0(transitive)

• Updated@ipld/dag-cbor@^8.0.0

• Updatedmultiformats@^10.0.2