ipfs-unixfs-exporter - npm Package Compare versions

Comparing version 7.0.11 to 8.0.0

package.json

 {
   "name": "ipfs-unixfs-exporter",
-  "version": "7.0.11",
+  "version": "8.0.0",
   "description": "JavaScript implementation of the UnixFs exporter used by IPFS",
@@ -21,14 +21,30 @@ "license": "Apache-2.0 OR MIT",
   },
-  "types": "types/src/index.d.ts",
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ],
+      "src/*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ]
+    }
+  },
   "files": [
-    "*",
-    "!**/*.tsbuildinfo",
-    "!**/browser-test",
-    "!**/node-test"
+    "src",
+    "dist",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
   ],
   "exports": {
     ".": {
-      "browser": "./esm/src/index.js",
-      "require": "./cjs/src/index.js",
-      "import": "./esm/src/index.js"
+      "types": "./dist/src/index.d.ts",
+      "import": "./src/index.js"
     }
@@ -69,11 +85,11 @@ },
             {
-              "type": "chore",
+              "type": "docs",
               "release": "patch"
             },
             {
-              "type": "docs",
+              "type": "test",
               "release": "patch"
             },
             {
-              "type": "test",
+              "type": "deps",
               "release": "patch"
@@ -108,5 +124,9 @@ },
                 "type": "docs",
-                "section": "Trivial Changes"
+                "section": "Documentation"
               },
               {
+                "type": "deps",
+                "section": "Dependencies"
+              },
+              {
                 "type": "test",
@@ -120,8 +140,3 @@ "section": "Tests"
       "@semantic-release/changelog",
-      [
-        "@semantic-release/npm",
-        {
-          "pkgRoot": "dist"
-        }
-      ],
+      "@semantic-release/npm",
       "@semantic-release/github",
@@ -132,4 +147,2 @@ "@semantic-release/git"
   "scripts": {
-    "prepare": "aegir build --no-bundle && cp -R types dist",
-    "pretest": "aegir build --esm-tests",
     "test": "aegir test",
@@ -139,8 +152,7 @@ "test:node": "aegir test -t node --cov",
     "test:firefox": "aegir test -t browser -- --browser firefox",
-    "build": "aegir build && cp -R types dist",
-    "preleaseOnly": "npx json -I -f dist/package.json -e this.types='\"src/index.d.ts\"'",
-    "clean": "rimraf ./dist ./types",
-    "lint": "aegir ts -p check && aegir lint",
-    "dep-check": "aegir dep-check -i @types/sinon -i nyc -i rimraf -i copy -i util -i crypto-browserify -i events -i readable-stream -i interface-blockstore",
-    "release": "semantic-release"
+    "build": "aegir build",
+    "clean": "aegir clean",
+    "lint": "aegir lint",
+    "dep-check": "aegir dep-check -i interface-blockstore",
+    "release": "aegir release"
   },
@@ -152,3 +164,3 @@ "dependencies": {
     "err-code": "^3.0.1",
-    "hamt-sharding": "^2.0.0",
+    "hamt-sharding": "^3.0.0",
     "interface-blockstore": "^2.0.3",
@@ -163,7 +175,5 @@ "ipfs-unixfs": "^6.0.0",
     "abort-controller": "^3.0.0",
-    "aegir": "^36.2.3",
+    "aegir": "^37.5.0",
     "blockstore-core": "^1.0.5",
-    "copy": "^0.3.2",
     "crypto-browserify": "^3.12.0",
-    "events": "^3.3.0",
     "ipfs-unixfs-importer": "^9.0.0",
@@ -175,14 +185,7 @@ "it-all": "^1.0.5",
     "native-abort-controller": "^1.0.3",
-    "readable-stream": "^3.6.0",
-    "rimraf": "^3.0.2",
-    "sinon": "^14.0.0",
-    "util": "^0.12.3"
+    "sinon": "^14.0.0"
   },
   "browser": {
-    ".": "./cjs/src/index.js"
-  },
-  "main": "./cjs/src/index.js",
-  "publishConfig": {
-    "directory": "dist"
+    "fs": false
   }
 }

README.md

@@ -1,40 +0,39 @@
-# ipfs-unixfs-exporter
+# ipfs-unixfs-exporter <!-- omit in toc -->
 
-[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
-[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
-[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
-[![Build Status](https://flat.badgen.net/travis/ipfs/js-ipfs-unixfs)](https://travis-ci.com/ipfs/js-ipfs-unixfs)
-[![Codecov](https://codecov.io/gh/ipfs/js-ipfs-unixfs/branch/master/graph/badge.svg)](https://codecov.io/gh/ipfs/js-ipfs-unixfs)
+[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
+[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
+[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
+[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-unixfs.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-unixfs)
+[![CI](https://img.shields.io/github/workflow/status/ipfs/js-ipfs-unixfs/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipfs-unixfs/actions/workflows/js-test-and-release.yml)
 
-> Exports UnixFS and other DAGs from IPFS
+> JavaScript implementation of the UnixFs exporter used by IPFS
 
-## Lead Maintainer
+## Table of contents <!-- omit in toc -->
 
-[Alex Potsides](https://github.com/achingbrain)
+- [Install](#install)
+- [Lead Maintainer](#lead-maintainer)
+- [Usage](#usage)
+  - [Example](#example)
+    - [API](#api)
+  - [`exporter(cid, blockstore, options)`](#exportercid-blockstore-options)
+    - [UnixFSEntry](#unixfsentry)
+    - [Raw entries](#raw-entries)
+    - [CBOR entries](#cbor-entries)
+    - [`entry.content({ offset, length })`](#entrycontent-offset-length-)
+  - [`walkPath(cid, blockstore)`](#walkpathcid-blockstore)
+  - [`recursive(cid, blockstore)`](#recursivecid-blockstore)
+- [Contribute](#contribute)
+- [License](#license)
+- [Contribute](#contribute-1)
 
-## Table of Contents
-
-- [ipfs-unixfs-exporter](#ipfs-unixfs-exporter)
-  - [Lead Maintainer](#lead-maintainer)
-  - [Table of Contents](#table-of-contents)
-  - [Install](#install)
-  - [Usage](#usage)
-    - [Example](#example)
-      - [API](#api)
-    - [`exporter(cid, blockstore, options)`](#exportercid-blockstore-options)
-      - [UnixFSEntry](#unixfsentry)
-      - [Raw entries](#raw-entries)
-      - [CBOR entries](#cbor-entries)
-      - [`entry.content({ offset, length })`](#entrycontent-offset-length-)
-    - [`walkPath(cid, blockstore)`](#walkpathcid-blockstore)
-    - [`recursive(cid, blockstore)`](#recursivecid-blockstore)
-  - [Contribute](#contribute)
-  - [License](#license)
-
 ## Install
 
+```console
+$ npm i ipfs-unixfs-exporter
 ```
-> npm install ipfs-unixfs-exporter
-```
 
+## Lead Maintainer
+
+[Alex Potsides](https://github.com/achingbrain)
+
 ## Usage
@@ -241,3 +240,5 @@
 [dag API]: https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/DAG.md
+
 [blockstore]: https://github.com/ipfs/js-ipfs-interfaces/tree/master/packages/interface-blockstore#readme
+
 [UnixFS]: https://github.com/ipfs/specs/tree/master/unixfs
@@ -255,2 +256,13 @@
 
-[MIT](LICENSE)
+Licensed under either of
+
+- 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>)
+
+## Contribute
+
+Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
+
+This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

New alerts

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

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

Mixed license

License

(Experimental) Package contains multiple licenses.

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

Improved metrics

Dev dependency count

12

-29.41%

Number of low license alerts

1

-50%

Number of lines in readme file

267

4.71%

Is type module

Yes

NaN

Worsened metrics

Total package byte prevSize

149498

-19.37%

Number of package files

46

-47.73%

Lines of code

1462

-27.52%

Number of medium supply chain risk alerts

2

Infinity%

Dependency changes

• + Added

  hamt-sharding@3.0.6
  (transitive)

• + Added

  multiformats@13.3.7
  (transitive)

• + Added

  uint8arrays@5.1.0
  (transitive)

• - Removed

  hamt-sharding@2.0.1
  (transitive)

• Updated

  hamt-sharding@^3.0.0