@fireproof/core 0.3.10 → 0.3.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fireproof/core",
-  "version": "0.3.10",
+  "version": "0.3.11",
   "description": "Realtime database for IPFS",
   "main": "index.js",
   "type": "module",

package/src/blockstore.js

@@ -29,12 +29,12 @@ const husher = (id, workFn) => {
  */
 export default class TransactionBlockstore {
   /** @type {Map<string, Uint8Array>} */
-  committedBlocks = new Map()
+  #committedBlocks = new Map()
 
   valet = null
 
-  instanceId = 'blkz.' + Math.random().toString(36).substring(2, 4)
-  inflightTransactions = new Set()
+  #instanceId = 'blkz.' + Math.random().toString(36).substring(2, 4)
+  #inflightTransactions = new Set()
 
   constructor (name, encryptionKey) {
     this.valet = new Valet(name, encryptionKey)
@@ -49,7 +49,7 @@ export default class TransactionBlockstore {
   async get (cid) {
     const key = cid.toString()
     // it is safe to read from the in-flight transactions becauase they are immutable
-    const bytes = await Promise.any([this.transactionsGet(key), this.committedGet(key)]).catch(e => {
+    const bytes = await Promise.any([this.#transactionsGet(key), this.committedGet(key)]).catch(e => {
       // console.log('networkGet', cid.toString(), e)
       return this.networkGet(key)
     })
@@ -59,8 +59,8 @@ export default class TransactionBlockstore {
 
   // this iterates over the in-flight transactions
   // and returns the first matching block it finds
-  async transactionsGet (key) {
-    for (const transaction of this.inflightTransactions) {
+  async #transactionsGet (key) {
+    for (const transaction of this.#inflightTransactions) {
       const got = await transaction.get(key)
       if (got && got.bytes) return got.bytes
     }
@@ -68,16 +68,16 @@ export default class TransactionBlockstore {
   }
 
   async committedGet (key) {
-    const old = this.committedBlocks.get(key)
+    const old = this.#committedBlocks.get(key)
     if (old) return old
     const got = await this.valet.getBlock(key)
     // console.log('committedGet: ' + key)
-    this.committedBlocks.set(key, got)
+    this.#committedBlocks.set(key, got)
     return got
   }
 
   async clearCommittedCache () {
-    this.committedBlocks.clear()
+    this.#committedBlocks.clear()
   }
 
   async networkGet (key) {
@@ -118,10 +118,10 @@ export default class TransactionBlockstore {
    */
   // * entries () {
   //   // needs transaction blocks?
-  //   // for (const [str, bytes] of this.blocks) {
+  //   // for (const [str, bytes] of this.#blocks) {
   //   //   yield { cid: parse(str), bytes }
   //   // }
-  //   for (const [str, bytes] of this.committedBlocks) {
+  //   for (const [str, bytes] of this.#committedBlocks) {
   //     yield { cid: parse(str), bytes }
   //   }
   // }
@@ -134,7 +134,7 @@ export default class TransactionBlockstore {
    */
   begin (label = '') {
     const innerTransactionBlockstore = new InnerBlockstore(label, this)
-    this.inflightTransactions.add(innerTransactionBlockstore)
+    this.#inflightTransactions.add(innerTransactionBlockstore)
     return innerTransactionBlockstore
   }
 
@@ -144,7 +144,7 @@ export default class TransactionBlockstore {
    * @memberof TransactionBlockstore
    */
   async commit (innerBlockstore) {
-    await this.doCommit(innerBlockstore)
+    await this.#doCommit(innerBlockstore)
   }
 
   // first get the transaction blockstore from the map of transaction blockstores
@@ -152,14 +152,14 @@ export default class TransactionBlockstore {
   // then write the transaction blockstore to a car
   // then write the car to the valet
   // then remove the transaction blockstore from the map of transaction blockstores
-  doCommit = async innerBlockstore => {
+  #doCommit = async innerBlockstore => {
     const cids = new Set()
     for (const { cid, bytes } of innerBlockstore.entries()) {
       const stringCid = cid.toString() // unnecessary string conversion, can we fix upstream?
-      if (this.committedBlocks.has(stringCid)) {
+      if (this.#committedBlocks.has(stringCid)) {
         // console.log('Duplicate block: ' + stringCid) // todo some of this can be avoided, cost is extra size on car files
       } else {
-        this.committedBlocks.set(stringCid, bytes)
+        this.#committedBlocks.set(stringCid, bytes)
         cids.add(stringCid)
       }
     }
@@ -175,7 +175,7 @@ export default class TransactionBlockstore {
    * @memberof TransactionBlockstore
    */
   retire (innerBlockstore) {
-    this.inflightTransactions.delete(innerBlockstore)
+    this.#inflightTransactions.delete(innerBlockstore)
   }
 }
 
@@ -206,7 +206,7 @@ export const doTransaction = async (label, blockstore, doFun) => {
 /** @implements {BlockFetcher} */
 export class InnerBlockstore {
   /** @type {Map<string, Uint8Array>} */
-  blocks = new Map()
+  #blocks = new Map()
   lastCid = null
   label = ''
   parentBlockstore = null
@@ -222,7 +222,7 @@ export class InnerBlockstore {
    */
   async get (cid) {
     const key = cid.toString()
-    let bytes = this.blocks.get(key)
+    let bytes = this.#blocks.get(key)
     if (bytes) {
       return { cid, bytes }
     }
@@ -238,12 +238,12 @@ export class InnerBlockstore {
    */
   put (cid, bytes) {
     // console.log('put', cid)
-    this.blocks.set(cid.toString(), bytes)
+    this.#blocks.set(cid.toString(), bytes)
     this.lastCid = cid
   }
 
   * entries () {
-    for (const [str, bytes] of this.blocks) {
+    for (const [str, bytes] of this.#blocks) {
       yield { cid: parse(str), bytes }
     }
   }

package/src/db-index.js

@@ -179,9 +179,9 @@ export default class DbIndex {
   async query (query, update = true) {
     // const callId = Math.random().toString(36).substring(2, 7)
     // todo pass a root to query a snapshot
-    // console.time(callId + '.updateIndex')
-    update && await this.updateIndex(this.database.indexBlocks)
-    // console.timeEnd(callId + '.updateIndex')
+    // console.time(callId + '.#updateIndex')
+    update && await this.#updateIndex(this.database.indexBlocks)
+    // console.timeEnd(callId + '.#updateIndex')
     // console.time(callId + '.doIndexQuery')
     // console.log('query', query)
     const response = await doIndexQuery(this.database.indexBlocks, this.indexByKey, query)
@@ -200,18 +200,18 @@ export default class DbIndex {
    * @returns {Promise<void>}
    */
 
-  async updateIndex (blocks) {
+  async #updateIndex (blocks) {
     // todo this could enqueue the request and give fresh ones to all second comers -- right now it gives out stale promises while working
     // what would it do in a world where all indexes provide a database snapshot to query?
     if (this.updateIndexPromise) return this.updateIndexPromise
-    this.updateIndexPromise = this.innerUpdateIndex(blocks)
+    this.updateIndexPromise = this.#innerUpdateIndex(blocks)
     this.updateIndexPromise.finally(() => { this.updateIndexPromise = null })
     return this.updateIndexPromise
   }
 
-  async innerUpdateIndex (inBlocks) {
+  async #innerUpdateIndex (inBlocks) {
     // const callTag = Math.random().toString(36).substring(4)
-    // console.log(`updateIndex ${callTag} >`, this.instanceId, this.dbHead?.toString(), this.indexByKey.cid?.toString(), this.indexById.cid?.toString())
+    // console.log(`#updateIndex ${callTag} >`, this.instanceId, this.dbHead?.toString(), this.indexByKey.cid?.toString(), this.indexById.cid?.toString())
     // todo remove this hack
     if (ALWAYS_REBUILD) {
       this.indexById = { root: null, cid: null }
@@ -224,15 +224,15 @@ export default class DbIndex {
     // console.timeEnd(callTag + '.changesSince')
     // console.log('result.rows.length', result.rows.length)
 
-    // console.time(callTag + '.doTransactionupdateIndex')
-    // console.log('updateIndex changes length', result.rows.length)
+    // console.time(callTag + '.doTransaction#updateIndex')
+    // console.log('#updateIndex changes length', result.rows.length)
 
     if (result.rows.length === 0) {
-      // console.log('updateIndex < no changes', result.clock)
+      // console.log('#updateIndex < no changes', result.clock)
       this.dbHead = result.clock
       return
     }
-    await doTransaction('updateIndex', inBlocks, async (blocks) => {
+    await doTransaction('#updateIndex', inBlocks, async (blocks) => {
       let oldIndexEntries = []
       let removeByIdIndexEntries = []
       await loadIndex(blocks, this.indexById, idIndexOpts)
@@ -252,8 +252,8 @@ export default class DbIndex {
       this.dbHead = result.clock
     })
     this.database.notifyExternal('dbIndex')
-    // console.timeEnd(callTag + '.doTransactionupdateIndex')
-    // console.log(`updateIndex ${callTag} <`, this.instanceId, this.dbHead?.toString(), this.indexByKey.cid?.toString(), this.indexById.cid?.toString())
+    // console.timeEnd(callTag + '.doTransaction#updateIndex')
+    // console.log(`#updateIndex ${callTag} <`, this.instanceId, this.dbHead?.toString(), this.indexByKey.cid?.toString(), this.indexById.cid?.toString())
   }
 }
 

package/src/fireproof.js

@@ -18,7 +18,7 @@ import charwise from 'charwise'
  *
  */
 export default class Fireproof {
-  listeners = new Set()
+  #listeners = new Set()
 
   /**
    * @function storage
@@ -82,12 +82,12 @@ export default class Fireproof {
    * @instance
    */
   async notifyReset () {
-    await this.notifyListeners({ _reset: true, _clock: this.clockToJSON() })
+    await this.#notifyListeners({ _reset: true, _clock: this.clockToJSON() })
   }
 
   // used be indexes etc to notify database listeners of new availability
   async notifyExternal (source = 'unknown') {
-    await this.notifyListeners({ _external: source, _clock: this.clockToJSON() })
+    await this.#notifyListeners({ _external: source, _clock: this.clockToJSON() })
   }
 
   /**
@@ -147,7 +147,7 @@ export default class Fireproof {
    * @memberof Fireproof
    * @instance
    */
-  async runValidation (doc) {
+  async #runValidation (doc) {
     if (this.config && this.config.validateChange) {
       const oldDoc = await this.get(doc._id)
         .then((doc) => doc)
@@ -197,8 +197,8 @@ export default class Fireproof {
    */
   async put ({ _id, _proof, ...doc }) {
     const id = _id || 'f' + Math.random().toString(36).slice(2)
-    await this.runValidation({ _id: id, ...doc })
-    return await this.putToProllyTree({ key: id, value: doc }, doc._clock)
+    await this.#runValidation({ _id: id, ...doc })
+    return await this.#putToProllyTree({ key: id, value: doc }, doc._clock)
   }
 
   /**
@@ -217,10 +217,10 @@ export default class Fireproof {
     } else {
       id = docOrId
     }
-    await this.runValidation({ _id: id, _deleted: true })
-    return await this.putToProllyTree({ key: id, del: true }, clock) // not working at prolly tree layer?
+    await this.#runValidation({ _id: id, _deleted: true })
+    return await this.#putToProllyTree({ key: id, del: true }, clock) // not working at prolly tree layer?
     // this tombstone is temporary until we can get the prolly tree to delete
-    // return await this.putToProllyTree({ key: id, value: null }, clock)
+    // return await this.#putToProllyTree({ key: id, value: null }, clock)
   }
 
   /**
@@ -229,7 +229,7 @@ export default class Fireproof {
    * @param {Object<{key : string, value: any}>} event - the event to add
    * @returns {Object<{ id: string, clock: CID[] }>} - The result of adding the event to storage
    */
-  async putToProllyTree (decodedEvent, clock = null) {
+  async #putToProllyTree (decodedEvent, clock = null) {
     const event = encodeEvent(decodedEvent)
     if (clock && JSON.stringify(clock) !== JSON.stringify(this.clockToJSON())) {
       // we need to check and see what version of the document exists at the clock specified
@@ -241,7 +241,7 @@ export default class Fireproof {
       }
     }
     const result = await doTransaction(
-      'putToProllyTree',
+      '#putToProllyTree',
       this.blocks,
       async (blocks) => await put(blocks, this.clock, event)
     )
@@ -251,7 +251,7 @@ export default class Fireproof {
     }
     // console.log('new clock head', this.instanceId, result.head.toString())
     this.clock = result.head // do we want to do this as a finally block
-    await this.notifyListeners([decodedEvent]) // this type is odd
+    await this.#notifyListeners([decodedEvent]) // this type is odd
     return {
       id: decodedEvent.key,
       clock: this.clockToJSON(),
@@ -290,15 +290,15 @@ export default class Fireproof {
    * @memberof Fireproof
    */
   registerListener (listener) {
-    this.listeners.add(listener)
+    this.#listeners.add(listener)
     return () => {
-      this.listeners.delete(listener)
+      this.#listeners.delete(listener)
     }
   }
 
-  async notifyListeners (changes) {
+  async #notifyListeners (changes) {
     // await sleep(10)
-    for (const listener of this.listeners) {
+    for (const listener of this.#listeners) {
       await listener(changes)
     }
   }

package/src/listener.js

@@ -10,8 +10,8 @@
 // import { ChangeEvent } from './db-index'
 
 export default class Listener {
-  subcribers = new Map()
-  doStopListening = null
+  #subcribers = new Map()
+  #doStopListening = null
 
   constructor (database, routingFn) {
     /** routingFn
@@ -19,7 +19,7 @@ export default class Listener {
      * @type {Fireproof}
      */
     this.database = database
-    this.doStopListening = database.registerListener(changes => this.onChanges(changes))
+    this.#doStopListening = database.registerListener(changes => this.#onChanges(changes))
     /**
      * The map function to apply to each entry in the database.
      * @type {Function}
@@ -41,7 +41,7 @@ export default class Listener {
    * @instance
    */
   on (topic, subscriber, since) {
-    const listOfTopicSubscribers = getTopicList(this.subcribers, topic)
+    const listOfTopicSubscribers = getTopicList(this.#subcribers, topic)
     listOfTopicSubscribers.push(subscriber)
     if (typeof since !== 'undefined') {
       this.database.changesSince(since).then(({ rows: changes }) => {
@@ -55,16 +55,16 @@ export default class Listener {
     }
   }
 
-  onChanges (changes) {
+  #onChanges (changes) {
     if (Array.isArray(changes)) {
       const seenTopics = topicsForChanges(changes, this.routingFn)
       for (const [topic, keys] of seenTopics) {
-        const listOfTopicSubscribers = getTopicList(this.subcribers, topic)
+        const listOfTopicSubscribers = getTopicList(this.#subcribers, topic)
         listOfTopicSubscribers.forEach(subscriber => keys.forEach(key => subscriber(key)))
       }
     } else {
       // non-arrays go to all subscribers
-      for (const [, listOfTopicSubscribers] of this.subcribers) {
+      for (const [, listOfTopicSubscribers] of this.#subcribers) {
         listOfTopicSubscribers.forEach(subscriber => subscriber(changes))
       }
     }

package/src/valet.js

@@ -21,9 +21,9 @@ const NO_ENCRYPT =
 export default class Valet {
   idb = null
   name = null
-  uploadQueue = null
-  alreadyEnqueued = new Set()
-  keyMaterial = null
+  #uploadQueue = null
+  #alreadyEnqueued = new Set()
+  #keyMaterial = null
   keyId = 'null'
 
   /**
@@ -35,7 +35,7 @@ export default class Valet {
   constructor (name = 'default', keyMaterial) {
     this.name = name
     this.setKeyMaterial(keyMaterial)
-    this.uploadQueue = cargoQueue(async (tasks, callback) => {
+    this.#uploadQueue = cargoQueue(async (tasks, callback) => {
       console.log(
         'queue worker',
         tasks.length,
@@ -56,7 +56,7 @@ export default class Valet {
       callback()
     })
 
-    this.uploadQueue.drain(async () => {
+    this.#uploadQueue.drain(async () => {
       return await this.withDB(async db => {
         const carKeys = (await db.getAllFromIndex('cidToCar', 'pending')).map(c => c.car)
         for (const carKey of carKeys) {
@@ -70,17 +70,17 @@ export default class Valet {
   }
 
   getKeyMaterial () {
-    return this.keyMaterial
+    return this.#keyMaterial
   }
 
   setKeyMaterial (km) {
     if (km && !NO_ENCRYPT) {
       const hex = Uint8Array.from(Buffer.from(km, 'hex'))
-      this.keyMaterial = km
+      this.#keyMaterial = km
       const hash = sha1sync(hex)
       this.keyId = Buffer.from(hash).toString('hex')
     } else {
-      this.keyMaterial = null
+      this.#keyMaterial = null
       this.keyId = 'null'
     }
     // console.trace('keyId', this.name, this.keyId)
@@ -95,9 +95,9 @@ export default class Valet {
    */
   async writeTransaction (innerBlockstore, cids) {
     if (innerBlockstore.lastCid) {
-      if (this.keyMaterial) {
+      if (this.#keyMaterial) {
         // console.log('encrypting car', innerBlockstore.label)
-        const newCar = await blocksToEncryptedCarBlock(innerBlockstore.lastCid, innerBlockstore, this.keyMaterial)
+        const newCar = await blocksToEncryptedCarBlock(innerBlockstore.lastCid, innerBlockstore, this.#keyMaterial)
         await this.parkCar(newCar.cid.toString(), newCar.bytes, cids)
       } else {
         const newCar = await blocksToCarBlock(innerBlockstore.lastCid, innerBlockstore)
@@ -140,14 +140,14 @@ export default class Valet {
 
     // upload to web3.storage if we have credentials
     if (this.uploadFunction) {
-      if (this.alreadyEnqueued.has(carCid)) {
+      if (this.#alreadyEnqueued.has(carCid)) {
         // console.log('already enqueued', carCid)
         return
       }
       // don't await this, it will be done in the queue
       // console.log('add to queue', carCid, value.length)
-      this.uploadQueue.push({ carCid, value })
-      this.alreadyEnqueued.add(carCid)
+      this.#uploadQueue.push({ carCid, value })
+      this.#alreadyEnqueued.add(carCid)
     } else {
       // console.log('no upload function', carCid, value.length, this.uploadFunction)
     }
@@ -165,7 +165,7 @@ export default class Valet {
       }
       const carBytes = await tx.objectStore('cars').get(carCid)
       const reader = await CarReader.fromBytes(carBytes)
-      if (this.keyMaterial) {
+      if (this.#keyMaterial) {
         const roots = await reader.getRoots()
         const readerGetWithCodec = async cid => {
           const got = await reader.get(cid)
@@ -182,7 +182,7 @@ export default class Valet {
           // console.log('decoded', decoded.value)
           return decoded
         }
-        const { blocks } = await blocksFromEncryptedCarBlock(roots[0], readerGetWithCodec, this.keyMaterial)
+        const { blocks } = await blocksFromEncryptedCarBlock(roots[0], readerGetWithCodec, this.#keyMaterial)
         const block = blocks.find(b => b.cid.toString() === dataCID)
         if (block) {
           return block.bytes

package/test/block.js

@@ -8,14 +8,14 @@ import { parse } from 'multiformats/link'
 /** @implements {BlockFetcher} */
 export class MemoryBlockstore {
   /** @type {Map<string, Uint8Array>} */
-  blocks = new Map()
+  #blocks = new Map()
 
   /**
    * @param {import('../src/link').AnyLink} cid
    * @returns {Promise<AnyBlock | undefined>}
    */
   async get (cid) {
-    const bytes = this.blocks.get(cid.toString())
+    const bytes = this.#blocks.get(cid.toString())
     if (!bytes) return
     return { cid, bytes }
   }
@@ -26,7 +26,7 @@ export class MemoryBlockstore {
    */
   async put (cid, bytes) {
     // console.log('put', cid)
-    this.blocks.set(cid.toString(), bytes)
+    this.#blocks.set(cid.toString(), bytes)
   }
 
   /**
@@ -34,11 +34,11 @@ export class MemoryBlockstore {
    * @param {Uint8Array} bytes
    */
   putSync (cid, bytes) {
-    this.blocks.set(cid.toString(), bytes)
+    this.#blocks.set(cid.toString(), bytes)
   }
 
   * entries () {
-    for (const [str, bytes] of this.blocks) {
+    for (const [str, bytes] of this.#blocks) {
       yield { cid: parse(str), bytes }
     }
   }
@@ -46,16 +46,16 @@ export class MemoryBlockstore {
 
 export class MultiBlockFetcher {
   /** @type {BlockFetcher[]} */
-  fetchers
+  #fetchers
 
   /** @param {BlockFetcher[]} fetchers */
   constructor (...fetchers) {
-    this.fetchers = fetchers
+    this.#fetchers = fetchers
   }
 
   /** @param {import('../src/link').AnyLink} link */
   async get (link) {
-    for (const f of this.fetchers) {
+    for (const f of this.#fetchers) {
       const v = await f.get(link)
       if (v) {
         return v