feat!: update to latest blockstore interface (#70)

The latest blockstore interface has the datastore-specific methods removed and an extra method added for iterating over the contents of the blockstore.

Also converts this module to typescript and updates all deps.x

BREAKING CHANGE: `interface-blockstore@5` removes query/batch methods and adds getAll

Author: achingbrain

.gitignore

@@ -1,39 +1,9 @@
-package-lock.json
-yarn.lock
-**/node_modules/
-**/*.log
-test/repo-tests*
-
-# Logs
-logs
-*.log
-
-coverage
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-build
-
-# Dependency directory
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
-
-lib
+build
 dist
-docs
-types
+.docs
+.coverage
+node_modules
+package-lock.json
+yarn.lock
+.vscode

package.json

@@ -49,19 +49,19 @@
   "exports": {
     ".": {
       "types": "./dist/src/index.d.ts",
-      "import": "./src/index.js"
+      "import": "./dist/src/index.js"
     },
     "./base": {
-      "types": "./src/base.d.ts",
-      "import": "./src/base.js"
+      "types": "./dist/src/base.d.ts",
+      "import": "./dist/src/base.js"
     },
     "./errors": {
-      "types": "./src/errors.d.ts",
-      "import": "./src/errors.js"
+      "types": "./dist/src/errors.d.ts",
+      "import": "./dist/src/errors.js"
     },
     "./memory": {
-      "types": "./src/memory.d.ts",
-      "import": "./src/memory.js"
+      "types": "./dist/src/memory.d.ts",
+      "import": "./dist/src/memory.js"
     }
   },
   "eslintConfig": {
@@ -172,16 +172,12 @@
   },
   "dependencies": {
     "err-code": "^3.0.1",
-    "interface-blockstore": "^4.0.0",
-    "interface-store": "^3.0.0",
-    "it-all": "^2.0.0",
-    "it-drain": "^2.0.0",
-    "it-filter": "^2.0.0",
-    "it-take": "^2.0.0",
+    "interface-blockstore": "^5.0.0",
+    "interface-store": "^4.0.0",
     "multiformats": "^11.0.0"
   },
   "devDependencies": {
-    "aegir": "^37.9.0",
-    "interface-blockstore-tests": "^4.0.0"
+    "aegir": "^38.1.7",
+    "interface-blockstore-tests": "^5.0.0"
   }
 }

src/base.js

@@ -0,0 +1,48 @@
+import type { Blockstore, Options, Pair } from 'interface-blockstore'
+import type { CID } from 'multiformats/cid'
+import type { AwaitIterable } from 'interface-store'
+
+export class BaseBlockstore implements Blockstore {
+  async has (key: CID, options?: Options): Promise<boolean> {
+    return await Promise.reject(new Error('.has is not implemented'))
+  }
+
+  async put (key: CID, val: Uint8Array, options?: Options): Promise<void> {
+    await Promise.reject(new Error('.put is not implemented'))
+  }
+
+  async * putMany (source: AwaitIterable<Pair>, options?: Options): AsyncIterable<Pair> {
+    for await (const { cid, block } of source) {
+      await this.put(cid, block, options)
+      yield { cid, block }
+    }
+  }
+
+  async get (key: CID, options?: Options): Promise<Uint8Array> {
+    return await Promise.reject(new Error('.get is not implemented'))
+  }
+
+  async * getMany (source: AwaitIterable<CID>, options?: Options): AsyncIterable<Uint8Array> {
+    for await (const key of source) {
+      yield this.get(key, options)
+    }
+  }
+
+  async delete (key: CID, options?: Options): Promise<void> {
+    await Promise.reject(new Error('.delete is not implemented'))
+  }
+
+  async * deleteMany (source: AwaitIterable<CID>, options?: Options): AsyncIterable<CID> {
+    for await (const key of source) {
+      await this.delete(key, options)
+      yield key
+    }
+  }
+
+  /**
+   * Extending classes should override `query` or implement this method
+   */
+  async * getAll (options?: Options): AwaitIterable<Pair> { // eslint-disable-line require-yield
+    throw new Error('.getAll is not implemented')
+  }
+}