ipfs-unixfs - npm Package Compare versions

Comparing version 6.0.9 to 7.0.0

package.json

 {
   "name": "ipfs-unixfs",
-  "version": "6.0.9",
+  "version": "7.0.0",
   "description": "JavaScript implementation of IPFS' unixfs (a Unix FileSystem representation on top of a MerkleDAG)",
@@ -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"
     }
@@ -72,11 +88,11 @@ },
             {
-              "type": "chore",
+              "type": "docs",
               "release": "patch"
             },
             {
-              "type": "docs",
+              "type": "test",
               "release": "patch"
             },
             {
-              "type": "test",
+              "type": "deps",
               "release": "patch"
@@ -111,5 +127,9 @@ },
                 "type": "docs",
-                "section": "Trivial Changes"
+                "section": "Documentation"
               },
               {
+                "type": "deps",
+                "section": "Dependencies"
+              },
+              {
                 "type": "test",
@@ -123,8 +143,3 @@ "section": "Tests"
       "@semantic-release/changelog",
-      [
-        "@semantic-release/npm",
-        {
-          "pkgRoot": "dist"
-        }
-      ],
+      "@semantic-release/npm",
       "@semantic-release/github",
@@ -135,6 +150,5 @@ "@semantic-release/git"
   "scripts": {
-    "prepare": "aegir build --no-bundle && cp -R types dist",
-    "prepare:proto": "pbjs -t static-module -w es6 -r ipfs-unixfs --force-number --no-verify --no-delimited --no-create --no-beautify --no-defaults --lint eslint-disable -o src/unixfs.js ./src/unixfs.proto",
-    "prepare:proto-types": "pbts -o src/unixfs.d.ts src/unixfs.js",
-    "pretest": "aegir build --esm-tests",
+    "generate": "npm run generate:proto && generate:proto-types",
+    "generate:proto": "pbjs -t static-module -w es6 -r ipfs-unixfs --force-number --no-verify --no-delimited --no-create --no-beautify --no-defaults --lint eslint-disable -o src/unixfs.js ./src/unixfs.proto",
+    "generate:proto-types": "pbts -o src/unixfs.d.ts src/unixfs.js",
     "test": "aegir test",
@@ -144,27 +158,20 @@ "test:node": "aegir test -t node --cov",
     "test:firefox": "aegir test -t browser -- --browser firefox",
-    "build": "aegir build && cp -R types dist",
-    "clean": "rimraf ./dist ./types",
-    "lint": "aegir ts -p check && aegir lint",
-    "dep-check": "aegir dep-check -i mkdirp -i npm-run-all -i copy -i util",
-    "release": "semantic-release"
+    "build": "aegir build",
+    "clean": "aegir clean",
+    "lint": "aegir lint",
+    "dep-check": "aegir dep-check",
+    "release": "aegir release"
   },
   "dependencies": {
     "err-code": "^3.0.1",
-    "protobufjs": "^6.10.2"
+    "protobufjs": "^7.0.0"
   },
   "devDependencies": {
-    "aegir": "^36.2.3",
-    "copy": "^0.3.2",
-    "mkdirp": "^1.0.4",
-    "npm-run-all": "^4.1.5",
-    "uint8arrays": "^3.0.0",
-    "util": "^0.12.3"
+    "aegir": "^37.5.0",
+    "protobufjs-cli": "^1.0.0",
+    "uint8arrays": "^3.0.0"
   },
   "browser": {
-    ".": "./cjs/src/index.js"
-  },
-  "main": "./cjs/src/index.js",
-  "publishConfig": {
-    "directory": "dist"
+    "fs": false
   }
 }

README.md

@@ -1,21 +0,15 @@
-# ipfs-unixfs JavaScript Implementation <!-- omit in toc -->
+# ipfs-unixfs <!-- 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)
 
-> JavaScript implementation of IPFS' UnixFS (a Unix FileSystem files representation on top of a MerkleDAG)
+> JavaScript implementation of IPFS' unixfs (a Unix FileSystem representation on top of a MerkleDAG)
 
-The UnixFS spec can be found inside the [ipfs/specs repository](http://github.com/ipfs/specs)
+## Table of contents <!-- omit in toc -->
 
-## Lead Maintainer <!-- omit in toc -->
-
-[Alex Potsides](https://github.com/achingbrain)
-
-## Table of Contents <!-- omit in toc -->
-
 - [Install](#install)
-  - [npm](#npm)
+- [Lead Maintainer <!-- omit in toc -->](#lead-maintainer----omit-in-toc---)
   - [Use in Node.js](#use-in-nodejs)
@@ -29,3 +23,3 @@ - [Use in a browser with browserify, webpack or any other bundler](#use-in-a-browser-with-browserify-webpack-or-any-other-bundler)
 - [API](#api)
-    - [UnixFS Data Structure](#unixfs-data-structure)
+  - - [UnixFS Data Structure](#unixfs-data-structure)
     - [create an unixfs Data element](#create-an-unixfs-data-element)
@@ -39,7 +33,16 @@ - [add and remove a block size to the block size list](#add-and-remove-a-block-size-to-the-block-size-list)
 - [License](#license)
+- [Contribute](#contribute-1)
 
 ## Install
 
-### npm
+```console
+$ npm i ipfs-unixfs
+```
 
+The UnixFS spec can be found inside the [ipfs/specs repository](http://github.com/ipfs/specs)
+
+## Lead Maintainer <!-- omit in toc -->
+
+[Alex Potsides](https://github.com/achingbrain)
+
 ```sh
@@ -208,2 +211,13 @@ > npm i ipfs-unixfs
 
-[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

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

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

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

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

3

decreased by-50%

Number of low license alerts

1

decreased by-50%

Number of lines in readme file

221

increased by6.76%

Is type module

Yes

Worsened metrics

Total package byte prevSize

88867

decreased by-17.8%

Number of package files

13

decreased by-50%

Lines of code

1360

decreased by-29.79%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addedlong@5.2.3(transitive)

• + Addedprotobufjs@7.4.0(transitive)

• - Removed@types/long@4.0.2(transitive)

• - Removedlong@4.0.0(transitive)

• - Removedprotobufjs@6.11.4(transitive)

• Updatedprotobufjs@^7.0.0