interface-datastore - npm Package Compare versions

Comparing version 8.2.10 to 8.2.11

package.json

 {
   "name": "interface-datastore",
-  "version": "8.2.10",
+  "version": "8.2.11",
   "description": "datastore interface",
   "license": "Apache-2.0 OR MIT",
-  "homepage": "https://github.com/ipfs/js-stores/tree/master/packages/interface-datastore#readme",
+  "homepage": "https://github.com/ipfs/js-stores/tree/main/packages/interface-datastore#readme",
   "repository": {
@@ -14,2 +14,6 @@ "type": "git",
   },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "keywords": [
@@ -62,87 +66,2 @@ "datastore",
   },
-  "release": {
-    "branches": [
-      "main"
-    ],
-    "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": {
@@ -163,7 +82,7 @@ "build": "aegir build",
     "interface-store": "^5.0.0",
-    "uint8arrays": "^5.0.0"
+    "uint8arrays": "^5.0.2"
   },
   "devDependencies": {
-    "aegir": "^41.1.9"
+    "aegir": "^42.2.3"
   }
 }

README.md

@@ -0,1 +1,3 @@
+# interface-datastore
+
 [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
@@ -8,2 +10,98 @@ [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 
+# About
+
+A Datastore is a key/value database that lets store/retrieve binary blobs using namespaced Keys.
+
+It is used by IPFS to store/retrieve arbitrary metadata needed to run the node - DHT provider records, signed peer records, etc.
+
+## Backed Implementations
+
+- File System: [`datastore-fs`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-fs)
+- IndexedDB: [`datastore-idb`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-idb)
+- level: [`datastore-level`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-level) (supports any levelup compatible backend)
+- Memory: [`datastore-core/memory`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/memory.ts)
+- S3: [`datastore-s3`](https://github.com/ipfs/js-stores/tree/main/packages/datastore-s3)
+
+## Wrapper Implementations
+
+- Keytransform: [`datstore-core/src/keytransform`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/keytransform.ts)
+- Mount: [`datastore-core/src/mount`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/mount.ts)
+- Namespace: [`datastore-core/src/namespace`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/namespace.ts)
+- Sharding: [`datastore-core/src/sharding`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/sharding.ts)
+- Tiered: [`datstore-core/src/tiered`](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/src/tiered.ts)
+
+If you want the same functionality as [go-ds-flatfs](https://github.com/ipfs/go-ds-flatfs), use sharding with fs.
+
+## Example
+
+```js
+import FsStore from 'datastore-fs'
+import { ShardingDataStore, shard } from 'datastore-core'
+
+const fs = new FsStore('path/to/store')
+
+// flatfs now works like go-flatfs
+const flatfs = await ShardingStore.createOrOpen(fs, new shard.NextToLast(2))
+```
+
+### Test suite
+
+Available via the [`interface-datastore-tests`](https://npmjs.com/package/interface-datastore-tests) module
+
+```js
+import { interfaceDatastoreTests } from 'interface-datastore-tests'
+
+describe('mystore', () => {
+  interfaceDatastoreTests({
+    async setup () {
+      return instanceOfMyStore
+    },
+    async teardown () {
+      // cleanup resources
+    }
+  })
+})
+```
+
+### Aborting requests
+
+Most API methods accept an \[AbortSignal]\[] as part of an options object.  Implementations may listen for an `abort` event emitted by this object, or test the `signal.aborted` property. When received implementations should tear down any long-lived requests or resources created.
+
+### Concurrency
+
+The streaming `(put|get|delete)Many` methods are intended to be used with modules such as [it-parallel-batch](https://www.npmjs.com/package/it-parallel-batch) to allow calling code to control levels of parallelisation.  The batching method ensures results are returned in the correct order, but interface implementations should be thread safe.
+
+```js
+import batch from 'it-parallel-batch'
+const source = [{
+  key: ..,
+  value: ..
+}]
+
+// put values into the datastore concurrently, max 10 at a time
+for await (const { key, data } of batch(store.putMany(source), 10)) {
+  console.info(`Put ${key}`)
+}
+```
+
+### Keys
+
+To allow a better abstraction on how to address values, there is a `Key` class which is used as identifier. It's easy to create a key from a `Uint8Array` or a `string`.
+
+```js
+const a = new Key('a')
+const b = new Key(new Uint8Array([0, 1, 2, 3]))
+```
+
+The key scheme is inspired by file systems and Google App Engine key model. Keys are meant to be unique across a system. They are typically hierarchical, incorporating more and more specific namespaces. Thus keys can be deemed 'children' or 'ancestors' of other keys:
+
+- `new Key('/Comedy')`
+- `new Key('/Comedy/MontyPython')`
+
+Also, every namespace can be parameterized to embed relevant object information. For example, the Key `name` (most specific namespace) could include the object type:
+
+- `new Key('/Comedy/MontyPython/Actor:JohnCleese')`
+- `new Key('/Comedy/MontyPython/Sketch:CheeseShop')`
+- `new Key('/Comedy/MontyPython/Sketch:CheeseShop/Character:Mousebender')`
+
 # Install
@@ -10,0 +108,0 @@

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

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

Improved metrics

Total package byte prevSize

86668

increased by2.67%

Number of lines in readme file

142

increased by222.73%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• Updateduint8arrays@^5.0.2