datastore-fs - npm Package Compare versions

Comparing version 7.0.0 to 8.0.0

dist/src/index.d.ts

@@ -59,2 +59,15 @@ /**
     /**
+     * Store the given value under the key
+     *
+     * @param {Key} key
+     * @param {Uint8Array} val
+     * @returns {Promise<void>}
+     */
+    put(key: Key, val: Uint8Array): Promise<void>;
+    /**
+     * @param {AwaitIterable<Pair>} source
+     * @returns {AsyncIterable<Pair>}
+     */
+    putMany(source: AwaitIterable<Pair>): AsyncIterable<Pair>;
+    /**
      * Read from the file system without extension.
@@ -66,2 +79,41 @@ *
     getRaw(key: Key): Promise<Uint8Array>;
+    /**
+     * Read from the file system.
+     *
+     * @param {Key} key
+     * @returns {Promise<Uint8Array>}
+     */
+    get(key: Key): Promise<Uint8Array>;
+    /**
+     * @param {AwaitIterable<Key>} source
+     * @returns {AsyncIterable<Uint8Array>}
+     */
+    getMany(source: AwaitIterable<Key>): AsyncIterable<Uint8Array>;
+    /**
+     * @param {AwaitIterable<Key>} source
+     * @returns {AsyncIterable<Key>}
+     */
+    deleteMany(source: AwaitIterable<Key>): AsyncIterable<Key>;
+    /**
+     * Check for the existence of the given key.
+     *
+     * @param {Key} key
+     * @returns {Promise<boolean>}
+     */
+    has(key: Key): Promise<boolean>;
+    /**
+     * Delete the record under the given key.
+     *
+     * @param {Key} key
+     * @returns {Promise<void>}
+     */
+    delete(key: Key): Promise<void>;
+    /**
+     * @param {Query} q
+     */
+    _all(q: Query): AsyncGenerator<import("interface-datastore").Pair, void, unknown>;
+    /**
+     * @param {KeyQuery} q
+     */
+    _allKeys(q: KeyQuery): AsyncGenerator<Key, void, undefined>;
 }
@@ -68,0 +120,0 @@ export type Datastore = import('interface-datastore').Datastore;

package.json

 {
   "name": "datastore-fs",
-  "version": "7.0.0",
+  "version": "8.0.0",
   "description": "Datastore implementation with file system backend",
@@ -26,13 +26,17 @@ "author": "Friedel Ziegelmayer<[e-mail]>",
   },
-  "main": "./cjs/src/index.js",
-  "types": "types/src/index.d.ts",
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
   "typesVersions": {
     "*": {
       "*": [
-        "types/*",
-        "types/src/*"
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
       ],
-      "types/*": [
-        "types/*",
-        "types/src/*"
+      "src/*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
       ]
@@ -42,3 +46,5 @@ }
   "files": [
-    "*",
+    "src",
+    "dist",
+    "!dist/test",
     "!**/*.tsbuildinfo"
@@ -48,5 +54,4 @@ ],
     ".": {
-      "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"
     }
@@ -87,11 +92,11 @@ },
             {
-              "type": "chore",
+              "type": "docs",
               "release": "patch"
             },
             {
-              "type": "docs",
+              "type": "test",
               "release": "patch"
             },
             {
-              "type": "test",
+              "type": "deps",
               "release": "patch"
@@ -126,5 +131,9 @@ },
                 "type": "docs",
-                "section": "Trivial Changes"
+                "section": "Documentation"
               },
               {
+                "type": "deps",
+                "section": "Dependencies"
+              },
+              {
                 "type": "test",
@@ -138,8 +147,3 @@ "section": "Tests"
       "@semantic-release/changelog",
-      [
-        "@semantic-release/npm",
-        {
-          "pkgRoot": "dist"
-        }
-      ],
+      "@semantic-release/npm",
       "@semantic-release/github",
@@ -150,7 +154,6 @@ "@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",
+    "clean": "aegir clean",
+    "lint": "aegir lint",
+    "build": "aegir build",
+    "release": "aegir release",
     "test": "aegir test",
@@ -161,5 +164,5 @@ "test:node": "aegir test -t node",
   "dependencies": {
-    "datastore-core": "^7.0.0",
+    "datastore-core": "^8.0.1",
     "fast-write-atomic": "^0.2.0",
-    "interface-datastore": "^6.0.2",
+    "interface-datastore": "^7.0.0",
     "it-glob": "^1.0.1",
@@ -173,6 +176,6 @@ "it-map": "^1.0.5",
     "@types/rimraf": "^3.0.2",
-    "aegir": "^36.1.3",
+    "aegir": "^37.5.0",
     "async-iterator-all": "^1.0.0",
     "detect-node": "^2.0.4",
-    "interface-datastore-tests": "^2.0.3",
+    "interface-datastore-tests": "^3.0.0",
     "ipfs-utils": "^9.0.4",
@@ -183,4 +186,6 @@ "memdown": "^6.0.0",
   "browser": {
-    ".": "./cjs/src/index.js"
+    "fs": false,
+    "path": false,
+    "util": false
   }
 }

README.md

@@ -1,17 +0,12 @@
-# js-datastore-fs <!-- omit in toc -->
+# datastore-fs <!-- 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)
-[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
-[![Build Status](https://github.com/ipfs/js-datastore-fs/actions/workflows/js-test-and-release.yml/badge.svg?branch=master)](https://github.com/ipfs/js-datastore-fs/actions/workflows/js-test-and-release.yml)
-[![Codecov](https://codecov.io/gh/ipfs/js-datastore-fs/branch/master/graph/badge.svg)](https://codecov.io/gh/ipfs/js-datastore-fs)
-[![Dependency Status](https://david-dm.org/ipfs/js-datastore-fs.svg?style=flat-square)](https://david-dm.org/ipfs/js-datastore-fs)
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
-![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
-![](https://img.shields.io/badge/Node.js-%3E%3D8.0.0-orange.svg?style=flat-square)
+[![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-datastore-fs.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-datastore-fs)
+[![CI](https://img.shields.io/github/workflow/status/ipfs/js-datastore-fs/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-datastore-fs/actions/workflows/js-test-and-release.yml)
 
-> Datastore implementation with file system backend.
+> Datastore implementation with file system backend
 
-## Table of Contents <!-- omit in toc -->
+## Table of contents <!-- omit in toc -->
 
@@ -22,8 +17,9 @@ - [Install](#install)
 - [License](#license)
+- [Contribute](#contribute-1)
 
 ## Install
 
+```console
+$ npm i datastore-fs
 ```
-$ npm install datastore-fs
-```
 
@@ -48,2 +44,13 @@ ## Usage
 
-[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

Fixed 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

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Number of low license alerts

1

decreased by-50%

Number of lines in readme file

55

increased by14.58%

Number of low supply chain risk alerts

1

decreased by-83.33%

Is type module

Yes

Worsened metrics

Total package byte prevSize

71628

decreased by-29.7%

Number of package files

7

decreased by-61.11%

Lines of code

657

decreased by-53.4%

Number of medium supply chain risk alerts

2

increased by100%

Dependency changes

• + Added@chainsafe/is-ip@2.1.0(transitive)

• + Added@chainsafe/netmask@2.0.0(transitive)

• + Added@leichtgewicht/ip-codec@2.0.5(transitive)

• + Added@libp2p/interface-peer-id@2.0.2(transitive)

• + Added@libp2p/logger@2.1.1(transitive)

• + Added@multiformats/dns@1.0.6(transitive)

• + Added@multiformats/multiaddr@12.4.0(transitive)

• + Added@types/dns-packet@5.6.5(transitive)

• + Added@types/node@22.13.8(transitive)

• + Addedbase64-js@1.5.1(transitive)

• + Addedbuffer@6.0.3(transitive)

• + Addeddatastore-core@8.0.4(transitive)

• + Addeddns-packet@5.6.1(transitive)

• + Addedeventemitter3@5.0.1(transitive)

• + Addedhashlru@2.3.0(transitive)

• + Addedieee754@1.2.1(transitive)

• + Addedinterface-datastore@7.0.48.3.1(transitive)

• + Addedinterface-store@3.0.46.0.2(transitive)

• + Addedit-all@2.0.1(transitive)

• + Addedit-drain@2.0.1(transitive)

• + Addedit-filter@2.0.2(transitive)

• + Addedit-map@2.0.1(transitive)

• + Addedit-merge@2.0.1(transitive)

• + Addedit-pipe@2.0.5(transitive)

• + Addedit-pushable@3.2.3(transitive)

• + Addedit-stream-types@1.0.5(transitive)

• + Addedit-take@2.0.1(transitive)

• + Addedmultiformats@11.0.212.1.313.3.2(transitive)

• + Addednanoid@4.0.2(transitive)

• + Addedp-defer@4.0.1(transitive)

• + Addedp-queue@8.1.0(transitive)

• + Addedp-timeout@6.1.4(transitive)

• + Addedprogress-events@1.0.1(transitive)

• + Addeduint8-varint@2.0.4(transitive)

• + Addeduint8arraylist@2.4.8(transitive)

• + Addeduint8arrays@4.0.105.1.0(transitive)

• + Addedundici-types@6.20.0(transitive)

• - Removeddatastore-core@7.0.3(transitive)

• - Removedfast-fifo@1.3.2(transitive)

• - Removedinterface-datastore@6.1.1(transitive)

• - Removedinterface-store@2.0.2(transitive)

• - Removedit-drain@1.0.5(transitive)

• - Removedit-filter@1.0.3(transitive)

• - Removedit-merge@1.0.4(transitive)

• - Removedit-pipe@1.1.0(transitive)

• - Removedit-pushable@1.4.2(transitive)

• - Removedit-take@1.0.2(transitive)

• - Removedmultiformats@9.9.0(transitive)

• - Removednanoid@3.3.8(transitive)

• - Removeduint8arrays@3.1.1(transitive)

• Updateddatastore-core@^8.0.1

• Updatedinterface-datastore@^7.0.0