blockstore-core - npm Package Compare versions

Comparing version 1.0.5 to 2.0.0

dist/src/memory.d.ts

@@ -13,2 +13,24 @@ /**
     data: Record<string, Uint8Array>;
+    /**
+     * @param {CID} key
+     * @param {Uint8Array} val
+     */
+    put(key: CID, val: Uint8Array): Promise<void>;
+    /**
+     * @param {CID} key
+     */
+    get(key: CID): Promise<Uint8Array>;
+    /**
+     * @param {CID} key
+     */
+    has(key: CID): Promise<boolean>;
+    /**
+     * @param {CID} key
+     */
+    delete(key: CID): Promise<void>;
+    _all(): AsyncGenerator<{
+        key: CID;
+        value: Uint8Array;
+    }, void, undefined>;
+    _allKeys(): AsyncGenerator<CID, void, undefined>;
 }
@@ -19,2 +41,3 @@ export type Pair = import('interface-blockstore').Pair;
 import { BaseBlockstore } from "./base.js";
+import { CID } from "multiformats/cid";
 //# sourceMappingURL=memory.d.ts.map

package.json

 {
   "name": "blockstore-core",
-  "version": "1.0.5",
+  "version": "2.0.0",
   "description": "Contains various implementations of the API contract described in interface-blockstore",
-  "main": "./cjs/src/index.js",
-  "types": "types/src/index.d.ts",
+  "author": "Alex Potsides <[e-mail]>",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/ipfs/js-blockstore-core#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ipfs/js-blockstore-core.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ipfs/js-blockstore-core/issues"
+  },
+  "keywords": [
+    "datastore",
+    "interface",
+    "ipfs",
+    "key-value"
+  ],
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
+  },
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
   "typesVersions": {
     "*": {
       "*": [
-        "types/*",
-        "types/src/*"
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
       ],
-      "types/*": [
-        "types/*",
-        "types/*"
+      "src/*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
       ]
@@ -20,5 +44,5 @@ }
   "files": [
-    "*",
-    "!**/*/browser-test",
-    "!**/*/node-test",
+    "src",
+    "dist",
+    "!dist/test",
     "!**/*.tsbuildinfo"
@@ -28,20 +52,16 @@ ],
     ".": {
-      "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"
     },
     "./base": {
-      "browser": "./esm/src/base.js",
-      "require": "./cjs/src/base.js",
-      "import": "./esm/src/base.js"
+      "types": "./src/base.d.ts",
+      "import": "./src/base.js"
     },
     "./errors": {
-      "browser": "./esm/src/errors.js",
-      "require": "./cjs/src/errors.js",
-      "import": "./esm/src/errors.js"
+      "types": "./src/errors.d.ts",
+      "import": "./src/errors.js"
     },
     "./memory": {
-      "browser": "./esm/src/memory.js",
-      "require": "./cjs/src/memory.js",
-      "import": "./esm/src/memory.js"
+      "types": "./src/memory.d.ts",
+      "import": "./src/memory.js"
     }
@@ -82,11 +102,11 @@ },
             {
-              "type": "chore",
+              "type": "docs",
               "release": "patch"
             },
             {
-              "type": "docs",
+              "type": "test",
               "release": "patch"
             },
             {
-              "type": "test",
+              "type": "deps",
               "release": "patch"
@@ -121,5 +141,9 @@ },
                 "type": "docs",
-                "section": "Trivial Changes"
+                "section": "Documentation"
               },
               {
+                "type": "deps",
+                "section": "Dependencies"
+              },
+              {
                 "type": "test",
@@ -133,8 +157,3 @@ "section": "Tests"
       "@semantic-release/changelog",
-      [
-        "@semantic-release/npm",
-        {
-          "pkgRoot": "dist"
-        }
-      ],
+      "@semantic-release/npm",
       "@semantic-release/github",
@@ -145,39 +164,15 @@ "@semantic-release/git"
   "scripts": {
-    "clean": "rimraf dist types",
-    "prepare": "aegir build --no-bundle && cp -R types dist",
-    "lint": "aegir ts -p check && aegir lint",
-    "build": "aegir build --esm-tests",
-    "release": "semantic-release",
-    "test": "aegir test",
-    "test:node": "aegir test -t node",
-    "test:chrome": "aegir test -t browser",
+    "clean": "aegir clean",
+    "lint": "aegir lint",
+    "build": "aegir build",
+    "release": "aegir release",
+    "test": "aegir test -t node -t browser -t webworker -t electron-main",
+    "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 -f dist/cjs/node-test/*js",
-    "test:electron-renderer": "aegir test -t electron-renderer -f dist/cjs/node-test/*js",
-    "dep-check": "aegir dep-check -i rimraf -i interface-blockstore -i interface-store -i aegir -i util"
+    "test:electron-main": "aegir test -t electron-main",
+    "dep-check": "aegir dep-check"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ipfs/js-blockstore-core.git"
-  },
-  "keywords": [
-    "interface",
-    "key-value",
-    "ipfs",
-    "datastore"
-  ],
-  "author": "Alex Potsides <[e-mail]>",
-  "license": "(Apache-2.0 OR MIT)",
-  "bugs": {
-    "url": "https://github.com/ipfs/js-blockstore-core/issues"
-  },
-  "homepage": "https://github.com/ipfs/js-blockstore-core#readme",
-  "devDependencies": {
-    "@types/debug": "^4.1.5",
-    "aegir": "^36.1.2",
-    "interface-blockstore-tests": "^2.0.1",
-    "util": "^0.12.4"
-  },
   "dependencies": {
@@ -193,8 +188,6 @@ "err-code": "^3.0.1",
   },
-  "browser": {
-    ".": "./cjs/src/index.js",
-    "./base": "./cjs/src/base.js",
-    "./errors": "./cjs/src/errors.js",
-    "./memory": "./cjs/src/memory.js"
+  "devDependencies": {
+    "aegir": "^37.5.1",
+    "interface-blockstore-tests": "^2.0.1"
   }
 }

README.md

@@ -1,15 +0,15 @@
-# js-blockstore-core <!-- omit in toc -->
+# blockstore-core <!-- 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)
+[![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-blockstore-core.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-blockstore-core)
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/ipfs/js-blockstore-core/ci?label=ci&style=flat-square)](https://github.com/ipfs/js-blockstore-core/actions?query=branch%3Amaster+workflow%3Aci+)
+[![CI](https://img.shields.io/github/workflow/status/ipfs/js-blockstore-core/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-blockstore-core/actions/workflows/js-test-and-release.yml)
 
-> Contains various implementations of the API contract described in [interface-blockstore](https://github.com/ipfs/js-ipfs-interfaces/tree/master/packages/interface-blockstore)
+> Contains various implementations of the API contract described in interface-blockstore
 
-## Table of Contents <!-- omit in toc -->
+## Table of contents <!-- omit in toc -->
 
+- [Install](#install)
 - [Implementations](#implementations)
-- [Install](#install)
 - [Usage](#usage)
@@ -20,3 +20,10 @@ - [BaseBlockstore](#baseblockstore)
 - [License](#license)
+- [Contribute](#contribute-1)
 
+## Install
+
+```console
+$ npm i blockstore-core
+```
+
 ## Implementations
@@ -27,8 +34,2 @@
 
-## Install
-
-```
-$ npm install blockstore-core
-```
-
 ## Usage
@@ -76,2 +77,13 @@
 
-[Apache-2.0](LICENSE-APACHE) OR [MIT](LICENSE-MIT)
+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

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

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

2

decreased by-50%

Number of low license alerts

1

decreased by-50%

Number of lines in readme file

87

increased by16%

Is type module

Yes

Worsened metrics

Total package byte prevSize

38458

decreased by-23.07%

Number of package files

16

decreased by-54.29%

Lines of code

527

decreased by-28.4%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes