hypercore-storage 1.4.4 → 1.5.0

package/index.js

@@ -19,7 +19,8 @@ const {
   createBlockStream,
   createBitfieldStream,
   createUserDataStream,
-  createTreeNodeStream
+  createTreeNodeStream,
+  createLocalStream
 } = require('./lib/streams.js')
 
 const EMPTY = new View()
@@ -172,6 +173,10 @@ class HypercoreStorage {
     return createUserDataStream(this.core, this.db, this.view, opts)
   }
 
+  createLocalStream (opts) {
+    return createLocalStream(this.core, this.db, this.view, opts)
+  }
+
   async resumeSession (name) {
     const rx = this.read()
     const existingSessionsPromise = rx.getSessions()

package/lib/keys.js

@@ -20,6 +20,7 @@ const DATA_BLOCK = 3
 const DATA_TREE = 4
 const DATA_BITFIELD = 5
 const DATA_USER_DATA = 6
+const DATA_LOCAL = 7
 
 const slab = { buffer: b4a.allocUnsafe(65536), start: 0, end: 0 }
 
@@ -207,6 +208,31 @@ core.userDataEnd = function (ptr) {
   return state.buffer.subarray(start, state.start)
 }
 
+core.local = function (ptr, key) {
+  if (key.byteLength > 2048) {
+    throw new Error('local keys has an upper limit of 2048 bytes atm')
+  }
+
+  const state = alloc()
+  const start = state.start
+  UINT.encode(state, TL_DATA)
+  UINT.encode(state, ptr)
+  UINT.encode(state, DATA_LOCAL)
+
+  state.buffer.set(key, state.start)
+  state.start += key.byteLength
+  return state.buffer.subarray(start, state.start)
+}
+
+core.localEnd = function (ptr) {
+  const state = alloc()
+  const start = state.start
+  UINT.encode(state, TL_DATA)
+  UINT.encode(state, ptr)
+  UINT.encode(state, DATA_LOCAL + 1)
+  return state.buffer.subarray(start, state.start)
+}
+
 core.blockIndex = function (buffer) {
   const state = { buffer, start: 0, end: buffer.byteLength }
   UINT.decode(state) // ns
@@ -231,6 +257,14 @@ core.userDataKey = function (buffer) {
   return STRING.decode(state)
 }
 
+core.localKey = function (buffer) {
+  const state = { buffer, start: 0, end: buffer.byteLength }
+  UINT.decode(state) // ns
+  UINT.decode(state) // ptr
+  UINT.decode(state) // type
+  return state.buffer.subarray(state.start, state.end)
+}
+
 module.exports = { store, core }
 
 function alloc () {

package/lib/streams.js

@@ -1,9 +1,11 @@
+const b4a = require('b4a')
 const BlockDependencyStream = require('./block-dependency-stream.js')
 const { core, store } = require('./keys.js')
 const schema = require('../spec/hyperschema')
 
 const CORESTORE_CORE = schema.getEncoding('@corestore/core')
 const CORE_TREE_NODE = schema.getEncoding('@core/tree-node')
+const EMPTY = b4a.alloc(0)
 
 module.exports = {
   createBlockStream,
@@ -11,7 +13,8 @@ module.exports = {
   createUserDataStream,
   createCoreStream,
   createAliasStream,
-  createTreeNodeStream
+  createTreeNodeStream,
+  createLocalStream
 }
 
 function createCoreStream (db, view) {
@@ -81,12 +84,28 @@ function createUserDataStream (ptr, db, view, { gt = null, gte = '', lte = null,
   return ite
 }
 
+function createLocalStream (ptr, db, view, { gt = null, gte = EMPTY, lte = null, lt = null, reverse = false } = {}) {
+  if (gt !== null || lte !== null) throw new Error('gt and lte not yet supported for local streams')
+
+  const s = core.local(ptr.dataPointer, gte)
+  const e = lt === null ? core.localEnd(ptr.dataPointer) : core.local(ptr.dataPointer, lt)
+  const ite = view.iterator(db, s, e, false)
+
+  ite._readableState.map = mapLocal
+  return ite
+}
+
 function mapBitfield (data) {
   const [index, type] = core.bitfieldIndexAndType(data.key)
   if (type !== 0) return null // ignore for now
   return { index, page: data.value }
 }
 
+function mapLocal (data) {
+  const key = core.localKey(data.key)
+  return { key, value: data.value }
+}
+
 function mapUserData (data) {
   const key = core.userDataKey(data.key)
   return { key, value: data.value }

package/lib/tx.js

@@ -100,6 +100,22 @@ class CoreTX {
     this.changes.push([core.userData(this.core.dataPointer, key), null, null])
   }
 
+  putLocal (key, value) {
+    this.changes.push([core.local(this.core.dataPointer, key), value, null])
+  }
+
+  deleteLocal (key) {
+    this.changes.push([core.local(this.core.dataPointer, key), null, null])
+  }
+
+  deleteLocalRange (start, end) {
+    this.changes.push([
+      core.local(this.core.dataPointer, start),
+      null,
+      end === null ? core.localEnd(this.core.dataPointer) : core.local(this.core.dataPointer, end)
+    ])
+  }
+
   flush () {
     const changes = this.changes
     if (changes === null) return Promise.resolve(!this.view)
@@ -168,6 +184,10 @@ class CoreRX {
     return this.view.get(this.read, core.userData(this.core.dataPointer, key))
   }
 
+  getLocal (key) {
+    return this.view.get(this.read, core.local(this.core.dataPointer, key))
+  }
+
   tryFlush () {
     this.read.tryFlush()
     this._free()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypercore-storage",
-  "version": "1.4.4",
+  "version": "1.5.0",
   "main": "index.js",
   "files": [
     "index.js",