@fireproof/core 0.3.12 → 0.3.14

package/src/clock.js

@@ -1,7 +1,7 @@
-// @ts-nocheck
 import { Block, encode, decode } from 'multiformats/block'
 import { sha256 } from 'multiformats/hashes/sha2'
 import * as cbor from '@ipld/dag-cbor'
+// @ts-ignore
 import { CIDCounter } from 'prolly-trees/utils'
 
 /**
@@ -19,14 +19,28 @@ import { CIDCounter } from 'prolly-trees/utils'
  * @typedef {import('multiformats').Link<EventView<T>>} EventLink
  */
 
+/**
+ * @typedef {{
+*   type: 'put'|'del'
+*   key: string
+*   value: import('./link').AnyLink
+*   root: import('./link').AnyLink
+* }} EventData
+* @typedef {{
+*   root: import('./link').AnyLink
+*   head: import('./clock').EventLink<EventData>[]
+*   event: import('./clock').EventBlockView<EventData>
+* }} Result
+*/
+
 /**
  * Advance the clock by adding an event.
  *
  * @template T
- * @param {import('./blockstore').BlockFetcher} blocks Block storage.
+ * @param {import('./blockstore').TransactionBlockstore} blocks Block storage.
  * @param {EventLink<T>[]} head The head of the clock.
  * @param {EventLink<T>} event The event to add.
- * @returns {Promise<EventLink<T>[]>} The new head of the clock.
+ * @returns {Promise<{head:EventLink<T>[], cids:any[]}>} The new head of the clock.
  */
 export async function advance (blocks, head, event) {
   /** @type {EventFetcher<T>} */
@@ -34,7 +48,7 @@ export async function advance (blocks, head, event) {
   const headmap = new Map(head.map((cid) => [cid.toString(), cid]))
 
   // Check if the headmap already includes the event, return head if it does
-  if (headmap.has(event.toString())) return { head, cids: events.cids }
+  if (headmap.has(event.toString())) return { head, cids: await events.all() }
 
   // Does event contain the clock?
   let changed = false
@@ -48,18 +62,18 @@ export async function advance (blocks, head, event) {
 
   // If the headmap has been changed, return the new headmap values
   if (changed) {
-    return { head: [...headmap.values()], cids: events.cids }
+    return { head: [...headmap.values()], cids: await events.all() }
   }
 
   // Does clock contain the event?
   for (const p of head) {
     if (await contains(events, p, event)) {
-      return { head, cids: events.cids }
+      return { head, cids: await events.all() }
     }
   }
 
   // Return the head concatenated with the new event if it passes both checks
-  return { head: head.concat(event), cids: events.cids }
+  return { head: head.concat(event), cids: await events.all() }
 }
 
 /**
@@ -90,7 +104,7 @@ export class EventBlock extends Block {
 
 /** @template T */
 export class EventFetcher {
-  /** @param {import('./blockstore').BlockFetcher} blocks */
+  /** @param {import('./blockstore').TransactionBlockstore} blocks */
   constructor (blocks) {
     /** @private */
     this._blocks = blocks
@@ -115,8 +129,8 @@ export class EventFetcher {
   }
 
   async all () {
-    await Promise.all([...this._cids])
-    return this._cids
+    // await Promise.all([...this._cids])
+    return this._cids.all()
   }
 }
 
@@ -169,12 +183,13 @@ async function contains (events, a, b) {
 
 /**
  * @template T
- * @param {import('./blockstore').BlockFetcher} blocks Block storage.
+ * @param {import('./blockstore').TransactionBlockstore} blocks Block storage.
  * @param {EventLink<T>[]} head
  * @param {object} [options]
  * @param {(b: EventBlockView<T>) => string} [options.renderNodeLabel]
  */
 export async function * vis (blocks, head, options = {}) {
+  // @ts-ignore
   const renderNodeLabel = options.renderNodeLabel ?? ((b) => b.value.data.value)
   const events = new EventFetcher(blocks)
   yield 'digraph clock {'
@@ -217,7 +232,7 @@ export async function findEventsToSync (blocks, head) {
   const toSync = await asyncFilter(sorted, async (uks) => !(await contains(events, ancestor, uks.cid)))
   // console.timeEnd(callTag + '.contains')
 
-  return { cids: events.cids, events: toSync }
+  return { cids: events.all(), events: toSync }
 }
 
 const asyncFilter = async (arr, predicate) =>
@@ -336,10 +351,10 @@ async function findSortedEvents (events, head, tail) {
 }
 
 /**
- * @param {import('./clock').EventFetcher} events
- * @param {import('./clock').EventLink<EventData>} start
- * @param {import('./clock').EventLink<EventData>} end
- * @returns {Promise<Array<{ event: import('./clock').EventBlockView<EventData>, depth: number }>>}
+ * @param {EventFetcher} events
+ * @param {EventLink<EventData>} start
+ * @param {EventLink<EventData>} end
+ * @returns {Promise<Array<{ event: EventBlockView<EventData>, depth: number }>>}
  */
 async function findEvents (events, start, end, depth = 0) {
   // console.log('findEvents', start)

package/src/db-index.js

@@ -1,4 +1,3 @@
-// @ts-nocheck
 // @ts-ignore
 import { create, load } from 'prolly-trees/db-index'
 // import { create, load } from '../../../../prolly-trees/src/db-index.js'
@@ -9,7 +8,8 @@ import { nocache as cache } from 'prolly-trees/cache'
 // @ts-ignore
 import { bf, simpleCompare } from 'prolly-trees/utils'
 import { makeGetBlock } from './prolly.js'
-import { cidsToProof } from './fireproof.js'
+// eslint-disable-next-line no-unused-vars
+import { Fireproof, cidsToProof } from './fireproof.js'
 
 import * as codec from '@ipld/dag-cbor'
 // import { create as createBlock } from 'multiformats/block'
@@ -94,11 +94,6 @@ const indexEntriesForChanges = (changes, mapFn) => {
  */
 export class DbIndex {
   constructor (database, mapFn, clock, opts = {}) {
-    // console.log('DbIndex constructor', database.constructor.name, typeof mapFn, clock)
-    /**
-     * The database instance to DbIndex.
-     * @type {Fireproof}
-     */
     this.database = database
     if (!database.indexBlocks) {
       database.indexBlocks = new TransactionBlockstore(database.name + '.indexes', database.blocks.valet.getKeyMaterial())

package/src/fireproof.js

@@ -3,11 +3,12 @@ import { randomBytes } from 'crypto'
 import { visMerkleClock, visMerkleTree, vis, put, get, getAll, eventsSince } from './prolly.js'
 import { TransactionBlockstore, doTransaction } from './blockstore.js'
 import charwise from 'charwise'
-// import { CID } from 'multiformats/dist/types/src/cid.js'
-
-// const sleep = ms => new Promise(resolve => setTimeout(resolve, ms))
 
-// class Proof {}
+// TypeScript Types
+// eslint-disable-next-line no-unused-vars
+// import { CID } from 'multiformats/dist/types/src/cid.js'
+// eslint-disable-next-line no-unused-vars
+class Proof {}
 
 /**
  * @class Fireproof
@@ -65,6 +66,12 @@ export class Fireproof {
     }
   }
 
+  /**
+   * Returns the Merkle clock heads for the Fireproof instance.
+   * @returns {string[]} - The Merkle clock heads for the Fireproof instance.
+   * @memberof Fireproof
+   * @instance
+   */
   clockToJSON () {
     return this.clock.map(cid => cid.toString())
   }
@@ -79,8 +86,6 @@ export class Fireproof {
   /**
    * Triggers a notification to all listeners
    * of the Fireproof instance so they can repaint UI, etc.
-   * @param {CID[] } clock
-   *    Clock to use for the snapshot.
    * @returns {Promise<void>}
    * @memberof Fireproof
    * @instance
@@ -98,7 +103,7 @@ export class Fireproof {
    * Returns the changes made to the Fireproof instance since the specified event.
    * @function changesSince
    * @param {CID[]} [event] - The clock head to retrieve changes since. If null or undefined, retrieves all changes.
-   * @returns {Object<{rows : Object[], clock: CID[]}>} An object containing the rows and the head of the instance's clock.
+   * @returns {Promise<{rows : Object[], clock: CID[], proof: {}}>} An object containing the rows and the head of the instance's clock.
    * @memberof Fireproof
    * @instance
    */
@@ -117,7 +122,7 @@ export class Fireproof {
         }
       }
       rows = Array.from(docsMap.values())
-      clockCIDs = resp.cids
+      clockCIDs = resp.clockCIDs
       // console.log('change rows', this.instanceId, rows)
     } else {
       const allResp = await getAll(this.blocks, this.clock)

package/src/listener.js

@@ -1,11 +1,10 @@
-// @ts-nocheck
 /**
  * A Fireproof database Listener allows you to react to events in the database.
  *
  * @class Listener
  * @classdesc An listener attaches to a Fireproof database and runs a routing function on each change, sending the results to subscribers.
  *
- * @param {Fireproof} database - The Fireproof database instance to index.
+ * @param {import('./fireproof.js').Fireproof} database - The Fireproof database instance to index.
  * @param {Function} routingFn - The routing function to apply to each entry in the database.
  */
 // import { ChangeEvent } from './db-index'
@@ -14,20 +13,20 @@ export class Listener {
   subcribers = new Map()
   doStopListening = null
 
+  /**
+   * @param {import('./fireproof.js').Fireproof} database
+   * @param {(_: any, emit: any) => void} routingFn
+   */
   constructor (database, routingFn) {
-    /** routingFn
-     * The database instance to index.
-     * @type {Fireproof}
-     */
     this.database = database
-    this.doStopListening = database.registerListener(changes => this.onChanges(changes))
+    this.doStopListening = database.registerListener((/** @type {any} */ changes) => this.onChanges(changes))
     /**
      * The map function to apply to each entry in the database.
      * @type {Function}
      */
     this.routingFn =
       routingFn ||
-      function (_, emit) {
+      function (/** @type {any} */ _, /** @type {(arg0: string) => void} */ emit) {
         emit('*')
       }
     this.dbHead = null
@@ -40,6 +39,7 @@ export class Listener {
    * @returns {Function} A function to unsubscribe from the topic.
    * @memberof Listener
    * @instance
+   * @param {any} since
    */
   on (topic, subscriber, since) {
     const listOfTopicSubscribers = getTopicList(this.subcribers, topic)
@@ -47,7 +47,7 @@ export class Listener {
     if (typeof since !== 'undefined') {
       this.database.changesSince(since).then(({ rows: changes }) => {
         const keys = topicsForChanges(changes, this.routingFn).get(topic)
-        if (keys) keys.forEach(key => subscriber(key))
+        if (keys) keys.forEach((/** @type {any} */ key) => subscriber(key))
       })
     }
     return () => {
@@ -56,22 +56,35 @@ export class Listener {
     }
   }
 
+  /**
+   * @typedef {import('./db-index').ChangeEvent} ChangeEvent
+   */
+
+  /**
+   * @param {ChangeEvent[]} 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)
-        listOfTopicSubscribers.forEach(subscriber => keys.forEach(key => subscriber(key)))
+        listOfTopicSubscribers.forEach((/** @type {(arg0: any) => any} */ subscriber) =>
+          keys.forEach((/** @type {any} */ key) => subscriber(key))
+        )
       }
     } else {
       // non-arrays go to all subscribers
       for (const [, listOfTopicSubscribers] of this.subcribers) {
-        listOfTopicSubscribers.forEach(subscriber => subscriber(changes))
+        listOfTopicSubscribers.forEach((/** @type {(arg0: any) => any} */ subscriber) => subscriber(changes))
       }
     }
   }
 }
 
+/**
+ * @param {Map<any, any>} subscribersMap
+ * @param {string} name
+ */
 function getTopicList (subscribersMap, name) {
   let topicList = subscribersMap.get(name)
   if (!topicList) {
@@ -86,14 +99,14 @@ function getTopicList (subscribersMap, name) {
  *
  * @param {ChangeEvent[]} changes
  * @param {Function} routingFn
- * @returns {Array<string>} The topics emmitted by the event function.
+ * @returns {Map<string,string[]>} The topics emmitted by the event function.
  * @private
  */
 const topicsForChanges = (changes, routingFn) => {
   const seenTopics = new Map()
   changes.forEach(({ key, value, del }) => {
     if (del || !value) value = { _deleted: true }
-    routingFn(({ _id: key, ...value }), t => {
+    routingFn({ _id: key, ...value }, (/** @type {any} */ t) => {
       const topicList = getTopicList(seenTopics, t)
       topicList.push(key)
     })

package/src/prolly.js

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import {
   advance,
   EventFetcher,
@@ -7,9 +6,12 @@ import {
   findEventsToSync,
   vis as visClock
 } from './clock.js'
-import { create, load } from 'prolly-trees/map'
 // import { create, load } from '../../../../prolly-trees/src/map.js'
+// @ts-ignore
+import { create, load } from 'prolly-trees/map'
+// @ts-ignore
 import { nocache as cache } from 'prolly-trees/cache'
+// @ts-ignore
 import { CIDCounter, bf, simpleCompare as compare } from 'prolly-trees/utils'
 import * as codec from '@ipld/dag-cbor'
 import { sha256 as hasher } from 'multiformats/hashes/sha2'
@@ -63,7 +65,7 @@ async function createAndSaveNewEvent ({
       : null),
     key
   }
-
+  // import('./clock').EventLink<import('./clock').EventData>
   if (del) {
     data.value = null
     data.type = 'del'
@@ -71,10 +73,11 @@ async function createAndSaveNewEvent ({
     data.value = value
     data.type = 'put'
   }
-  /** @type {EventData} */
-
+  /** @type {import('./clock').EventData} */
+  // @ts-ignore
   const event = await EventBlock.create(data, head)
   bigPut(event)
+  // @ts-ignore
   ;({ head, cids } = await advance(inBlocks, head, event.cid))
 
   return {
@@ -130,7 +133,7 @@ const bulkFromEvents = (sorted, event) => {
 /**
  *
  * @param {EventFetcher} events
- * @param {Link} ancestor
+ * @param {import('./clock').EventLink<import('./clock').EventData>} ancestor
  * @param {*} getBlock
  * @returns
  */
@@ -185,12 +188,11 @@ const doProllyBulk = async (inBlocks, head, event) => {
 /**
  * Put a value (a CID) for the given key. If the key exists it's value is overwritten.
  *
- * @param {import('./blockstore.js').BlockFetcher} blocks Bucket block storage.
- * @param {import('./clock').EventLink<EventData>[]} head Merkle clock head.
- * @param {string} key The key of the value to put.
- * @param {CID} value The value to put.
+ * @param {import('./blockstore.js').Blockstore} inBlocks Bucket block storage.
+ * @param {import('./clock').EventLink<import('./clock').EventData>[]} head Merkle clock head.
+* @param {{key: string, value: import('./clock').EventLink<import('./clock').EventData>}} event The key of the value to put.
  * @param {object} [options]
- * @returns {Promise<Result>}
+ * @returns {Promise<any>}
  */
 export async function put (inBlocks, head, event, options) {
   const { bigPut } = makeGetAndPutBlock(inBlocks)
@@ -237,8 +239,8 @@ export async function put (inBlocks, head, event, options) {
 /**
  * Determine the effective prolly root given the current merkle clock head.
  *
- * @param {import('./blockstore.js').BlockFetcher} blocks Bucket block storage.
- * @param {import('./clock').EventLink<EventData>[]} head Merkle clock head.
+ * @param {import('./blockstore.js').TransactionBlockstore} inBlocks Bucket block storage.
+ * @param {import('./clock').EventLink<import('./clock').EventData>[]} head Merkle clock head.
  */
 export async function root (inBlocks, head) {
   if (!head.length) {
@@ -257,15 +259,16 @@ export async function root (inBlocks, head) {
 
 /**
  * Get the list of events not known by the `since` event
- * @param {import('./blockstore.js').BlockFetcher} blocks Bucket block storage.
- * @param {import('./clock').EventLink<EventData>[]} head Merkle clock head.
- * @param {import('./clock').EventLink<EventData>} since Event to compare against.
- * @returns {Promise<{clockCIDs: CIDCounter, result: EventData[]}>}
+ * @param {import('./blockstore.js').TransactionBlockstore} blocks Bucket block storage.
+ * @param {import('./clock').EventLink<import('./clock').EventData>[]} head Merkle clock head.
+ * @param {import('./clock').EventLink<import('./clock').EventData>} since Event to compare against.
+ * @returns {Promise<{clockCIDs: CIDCounter, result: import('./clock').EventData[]}>}
  */
 export async function eventsSince (blocks, head, since) {
   if (!head.length) {
     throw new Error('no head')
   }
+  // @ts-ignore
   const sinceHead = [...since, ...head] // ?
   const { cids, events: unknownSorted3 } = await findEventsToSync(blocks, sinceHead)
   return { clockCIDs: cids, result: unknownSorted3.map(({ value: { data } }) => data) }
@@ -273,10 +276,10 @@ export async function eventsSince (blocks, head, since) {
 
 /**
  *
- * @param {import('./blockstore.js').BlockFetcher} blocks Bucket block storage.
- * @param {import('./clock').EventLink<EventData>[]} head Merkle clock head.
+ * @param {import('./blockstore.js').TransactionBlockstore} blocks Bucket block storage.
+ * @param {import('./clock').EventLink<import('./clock').EventData>[]} head Merkle clock head.
  *
- * @returns {Promise<{clockCIDs: CIDCounter, result: EventData[]}>}
+ * @returns {Promise<{cids: CIDCounter, clockCIDs: CIDCounter, result: import('./clock').EventData[]}>}
  *
  */
 export async function getAll (blocks, head) {
@@ -294,8 +297,8 @@ export async function getAll (blocks, head) {
 }
 
 /**
- * @param {import('./blockstore.js').BlockFetcher} blocks Bucket block storage.
- * @param {import('./clock').EventLink<EventData>[]} head Merkle clock head.
+ * @param {import('./blockstore.js').TransactionBlockstore} blocks Bucket block storage.
+ * @param {import('./clock').EventLink<import('./clock').EventData>[]} head Merkle clock head.
  * @param {string} key The key of the value to retrieve.
  */
 export async function get (blocks, head, key) {

package/src/valet.js

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import { CarReader } from '@ipld/car'
 import { CID } from 'multiformats/cid'
 import { sha256 } from 'multiformats/hashes/sha2'
@@ -8,16 +7,19 @@ import * as Block from 'multiformats/block'
 import * as dagcbor from '@ipld/dag-cbor'
 import { openDB } from 'idb'
 import cargoQueue from 'async/cargoQueue.js'
+// @ts-ignore
 import { bf } from 'prolly-trees/utils'
+// @ts-ignore
 import { nocache as cache } from 'prolly-trees/cache'
 import { encrypt, decrypt } from './crypto.js'
 import { Buffer } from 'buffer'
+// @ts-ignore
 import * as codec from 'encrypted-block'
 import { rawSha1 as sha1sync } from './sha1.js'
 const chunker = bf(3)
 
-const NO_ENCRYPT =
-  typeof process !== 'undefined' ? process.env.NO_ENCRYPT : import.meta && import.meta.env.VITE_NO_ENCRYPT
+const NO_ENCRYPT = process.env?.NO_ENCRYPT
+// typeof process !== 'undefined' ? process.env.NO_ENCRYPT : import.meta && import.meta.env.VITE_NO_ENCRYPT
 
 export class Valet {
   idb = null
@@ -89,7 +91,7 @@ export class Valet {
 
   /**
    * Group the blocks into a car and write it to the valet.
-   * @param {InnerBlockstore} innerBlockstore
+   * @param {import('./blockstore.js').InnerBlockstore} innerBlockstore
    * @param {Set<string>} cids
    * @returns {Promise<void>}
    * @memberof Valet