datastore-idb - npm Package Compare versions

Comparing version 1.1.0 to 2.0.0

package.json

 {
   "name": "datastore-idb",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "Datastore implementation with IndexedDB backend.",
-  "leadMaintainer": "Hugo Dias <[e-mail]>",
-  "main": "src/index.js",
+  "author": "Hugo Dias <[e-mail]>",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/ipfs/js-datastore-idb#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ipfs/js-datastore-idb.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ipfs/js-datastore-idb/issues"
+  },
+  "keywords": [
+    "browser",
+    "datastore",
+    "idb",
+    "interface",
+    "ipfs",
+    "key-value"
+  ],
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
+  },
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "src",
+    "dist",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
+    }
+  },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module",
+      "project": [
+        "tsconfig.json",
+        "benchmarks/datastore-level/tsconfig.json"
+      ]
+    }
+  },
+  "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": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "type": "deps",
+              "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": "Documentation"
+              },
+              {
+                "type": "deps",
+                "section": "Dependencies"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
+  },
   "scripts": {
@@ -14,39 +143,16 @@ "test": "aegir test -t browser -t webworker",
     "release": "aegir release",
-    "release-minor": "aegir release --type minor",
-    "release-major": "aegir release --type major",
-    "coverage": "nyc -s npm run test:node && nyc report --reporter=html",
-    "dep-check": "aegir dep-check"
+    "dep-check": "aegir dep-check",
+    "docs": "aegir docs"
   },
-  "repository": "github:ipfs/js-datastore-idb",
-  "keywords": [
-    "interface",
-    "key-value",
-    "ipfs",
-    "datastore",
-    "browser",
-    "idb"
-  ],
-  "author": "Hugo Dias <[e-mail]>",
-  "license": "MIT",
-  "bugs": "https://github.com/ipfs/js-datastore-idb/issues",
-  "homepage": "https://github.com/ipfs/js-datastore-idb#readme",
   "dependencies": {
-    "buffer": "^5.5.0",
-    "idb": "^5.0.2",
-    "interface-datastore": "^1.0.2"
+    "idb": "^7.1.1",
+    "interface-datastore": "^8.0.0",
+    "it-filter": "^2.0.1",
+    "it-sort": "^2.0.1"
   },
   "devDependencies": {
-    "aegir": "^22.0.0",
-    "chai": "^4.2.0",
-    "datastore-core": "^1.1.0",
-    "datastore-level": "^1.1.0",
-    "dirty-chai": "^2.0.1",
-    "ipfs-utils": "^2.2.0",
-    "iso-random-stream": "^1.1.1"
-  },
-  "contributors": [
-    "Hugo Dias <[e-mail]>",
-    "achingbrain <[e-mail]>",
-    "Hector Sanjuan <[e-mail]>"
-  ]
+    "aegir": "^38.1.7",
+    "datastore-core": "^9.0.2",
+    "interface-datastore-tests": "^4.0.0"
+  }
 }

README.md

@@ -1,41 +0,53 @@
-# js-datastore-idb
+# datastore-idb <!-- 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-datastore-idb)](https://travis-ci.com/ipfs/js-datastore-idb)
-[![Codecov](https://codecov.io/gh/ipfs/js-datastore-idb/branch/master/graph/badge.svg)](https://codecov.io/gh/ipfs/js-datastore-idb)
-[![Dependency Status](https://david-dm.org/ipfs/js-datastore-idb.svg?style=flat-square)](https://david-dm.org/ipfs/js-datastore-idb)
+[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
+[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
+[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-datastore-idb.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-datastore-idb)
+[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-datastore-idb/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-datastore-idb/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
-
 > Datastore implementation with IndexedDB backend.
 
-## Lead Maintainer
+## Table of contents <!-- omit in toc -->
 
-[Hugo Dias](https://github.com/hugomrdias)
+- [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
+- [API Docs](#api-docs)
+- [License](#license)
+- [Contribute](#contribute)
 
 ## Install
 
+```console
+$ npm i datastore-idb
 ```
-$ npm install datastore-idb
-```
 
-## Usage
+### Browser `<script>` tag
 
-```js
-const IdbStore = require('datastore-idb')
+Loading this module through a script tag will make it's exports available as `DatastoreIdb` in the global namespace.
 
-const store = new IdbStore('path/to/store')
+```html
+<script src="https://unpkg.com/datastore-idb/dist/index.min.js"></script>
 ```
 
+## API Docs
+
+- <https://ipfs.github.io/js-datastore-idb>
+
+## 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-datastore-level/issues)!
+Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-datastore-idb/issues).
 
-This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
 
-[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
+Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
 
-## License
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
 
-[MIT](LICENSE)
+[![](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

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

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

61827

increased by179.62%

Dev dependency count

3

decreased by-57.14%

Lines of code

539

increased by44.89%

Number of low maintenance alerts

0

decreased by-100%

Number of lines in readme file

54

increased by28.57%

Number of low supply chain risk alerts

0

decreased by-100%

Is type module

Yes

Worsened metrics

Dependency count

4

increased by33.33%

Number of package files

10

decreased by-9.09%

Number of low license alerts

1

increased byInfinity%

License quality

80

decreased by-20%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addedit-filter@^2.0.1

• + Addedit-sort@^2.0.1

• + Addedidb@7.1.1(transitive)

• + Addedinterface-datastore@8.3.1(transitive)

• + Addedinterface-store@6.0.2(transitive)

• + Addedit-all@2.0.1(transitive)

• + Addedit-filter@2.0.2(transitive)

• + Addedit-sort@2.0.1(transitive)

• + Addedmultiformats@13.3.1(transitive)

• + Addeduint8arrays@5.1.0(transitive)

• - Removedbuffer@^5.5.0

• - Removedabort-controller@3.0.0(transitive)

• - Removedany-signal@1.2.0(transitive)

• - Removedat-least-node@1.0.0(transitive)

• - Removedbalanced-match@1.0.2(transitive)

• - Removedbase64-js@1.5.1(transitive)

• - Removedbrace-expansion@1.1.11(transitive)

• - Removedbuffer@5.7.16.0.3(transitive)

• - Removedclass-is@1.1.0(transitive)

• - Removedconcat-map@0.0.1(transitive)

• - Removederr-code@2.0.3(transitive)

• - Removedevent-target-shim@5.0.1(transitive)

• - Removedfast-fifo@1.3.2(transitive)

• - Removedfs-extra@8.1.09.1.0(transitive)

• - Removedget-iterator@1.0.2(transitive)

• - Removedgraceful-fs@4.2.11(transitive)

• - Removedidb@5.0.8(transitive)

• - Removedieee754@1.2.1(transitive)

• - Removedinherits@2.0.4(transitive)

• - Removedinterface-datastore@1.0.4(transitive)

• - Removedipfs-utils@2.4.0(transitive)

• - Removedis-electron@2.2.2(transitive)

• - Removedis-plain-obj@2.1.0(transitive)

• - Removediso-random-stream@1.1.2(transitive)

• - Removediso-url@0.4.7(transitive)

• - Removedit-all@1.0.6(transitive)

• - Removedit-drain@1.0.5(transitive)

• - Removedit-glob@0.0.8(transitive)

• - Removedit-to-stream@0.1.2(transitive)

• - Removedjsonfile@4.0.06.1.0(transitive)

• - Removedmerge-options@2.0.0(transitive)

• - Removedminimatch@3.1.2(transitive)

• - Removednanoid@3.3.7(transitive)

• - Removednode-fetch@2.7.0(transitive)

• - Removedp-defer@3.0.0(transitive)

• - Removedp-fifo@1.0.0(transitive)

• - Removedreadable-stream@3.6.2(transitive)

• - Removedsafe-buffer@5.2.1(transitive)

• - Removedstream-to-it@0.2.4(transitive)

• - Removedstring_decoder@1.3.0(transitive)

• - Removedtr46@0.0.3(transitive)

• - Removeduniversalify@0.1.22.0.1(transitive)

• - Removedutil-deprecate@1.0.2(transitive)

• - Removedwebidl-conversions@3.0.1(transitive)

• - Removedwhatwg-url@5.0.0(transitive)

• Updatedidb@^7.1.1

• Updatedinterface-datastore@^8.0.0