hypercore-list 0.0.1-alpha.0

package/README.md

@@ -0,0 +1,5 @@
+# (WIP) Hypercore List
+
+Bundle Hypercores in an ordered collection.
+
+Includes rehoster support, so rehosting a collection means you keep all the hypercores it contains available too.

package/index.js

@@ -0,0 +1,68 @@
+const ReadyResource = require('ready-resource')
+const cenc = require('compact-encoding')
+const SubEncoder = require('sub-encoder')
+const idEnc = require('hypercore-id-encoding')
+const RehosterDb = require('hypercore-rehoster/db')
+
+class HypercoreList extends ReadyResource {
+  constructor (bee) {
+    super()
+
+    this.bee = bee
+
+    const subEncoder = new SubEncoder('collection')
+    this.entriesEncs = {
+      keyEncoding: subEncoder,
+      valueEncoding: cenc.array(cenc.fixed32)
+    }
+    this.titleEncs = {
+      keyEncoding: subEncoder,
+      valueEncoding: cenc.string
+    }
+
+    this.rehosterDb = new RehosterDb(this.bee)
+  }
+
+  async setTitle (title) {
+    await this.bee.put('TITLE', title, {
+      ...this.titleEncs,
+      cas: (prev, next) => prev !== next // no useless appends if it's the same
+    })
+  }
+
+  async getTitle () {
+    const entry = await this.bee.get('TITLE', this.titleEncs)
+    return entry?.value || null
+  }
+
+  async setEntries (orderedEntries) {
+    const bufferEntries = []
+    const rehosterEntries = new Map()
+    for (const key of orderedEntries) {
+      bufferEntries.push(idEnc.decode(key))
+      rehosterEntries.set(key, {})
+    }
+
+    let inserted = true
+    await this.bee.put('ENTRIES', bufferEntries, {
+      ...this.entriesEncs,
+      cas: (prev, next) => {
+        if (!prev) return true // only if none exists, for simplicity (TODO:)
+        inserted = false
+        return false
+      }
+    })
+
+    if (!inserted) throw new Error('Updating the entries is not yet supported (TODO)')
+
+    const synced = await this.rehosterDb.sync(rehosterEntries)
+    if (!synced) throw new Error('Logical error in hypercore-collection.setEntries')
+  }
+
+  async getEntries () {
+    const res = await this.bee.get('ENTRIES', this.entriesEncs)
+    return res.value || null
+  }
+}
+
+module.exports = HypercoreList

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "hypercore-list",
+  "version": "0.0.1-alpha.0",
+  "description": "An ordered collection of hypercores",
+  "main": "index.js",
+  "scripts": {
+    "test": "standard"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@gitlab.com/dcent-tech/hypercore-list.git"
+  },
+  "files": [
+    "index.js"
+  ],
+  "keywords": [
+    "Hypercore",
+    "list",
+    "ordered",
+    "collection"
+  ],
+  "author": "H. Degroote",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://gitlab.com/dcent-tech/hypercore-list/issues"
+  },
+  "homepage": "https://gitlab.com/dcent-tech/hypercore-list#readme",
+  "dependencies": {
+    "compact-encoding": "^2.15.0",
+    "hypercore-id-encoding": "^1.3.0",
+    "hypercore-rehoster": "^2.0.0",
+    "ready-resource": "^1.1.1",
+    "sub-encoder": "^2.1.3"
+  },
+  "devDependencies": {
+    "corestore": "^6.18.4",
+    "hyperbee": "^2.20.0",
+    "standard": "^17.1.2"
+  }
+}