@fireproof/core 0.3.22 → 0.4.1

package/dist/src/{index.js → fireproof.js}

@@ -37227,7 +37227,10 @@ class TransactionBlockstore {
   inflightTransactions = new Set()
 
   constructor (name, encryptionKey) {
-    this.valet = new Valet(name, encryptionKey);
+    if (name) {
+      this.valet = new Valet(name, encryptionKey);
+    }
+    this.remoteBlockFunction = null;
   }
 
   /**
@@ -37260,6 +37263,7 @@ class TransactionBlockstore {
   async committedGet (key) {
     const old = this.committedBlocks.get(key);
     if (old) return old
+    if (!this.valet) throw new Error('Missing block: ' + key)
     const got = await this.valet.getBlock(key);
     // console.log('committedGet: ' + key)
     this.committedBlocks.set(key, got);
@@ -37271,9 +37275,9 @@ class TransactionBlockstore {
   }
 
   async networkGet (key) {
-    if (this.valet.remoteBlockFunction) {
+    if (this.remoteBlockFunction) {
       // todo why is this on valet?
-      const value = await husher(key, async () => await this.valet.remoteBlockFunction(key));
+      const value = await husher(key, async () => await this.remoteBlockFunction(key));
       if (value) {
         // console.log('networkGot: ' + key, value.length)
         doTransaction('networkGot: ' + key, this, async innerBlockstore => {
@@ -37351,7 +37355,7 @@ class TransactionBlockstore {
         cids.add(stringCid);
       }
     }
-    if (cids.size > 0) {
+    if (cids.size > 0 && this.valet) {
       // console.log(innerBlockstore.label, 'committing', cids.size, 'blocks')
       await this.valet.writeTransaction(innerBlockstore, cids);
     }
@@ -37442,6 +37446,10 @@ class InnerBlockstore {
 
 const blockOpts = { cache: nocache, chunker: bf(3), codec: codec$1, hasher: sha256$2, compare: simpleCompare };
 
+/**
+ * @typedef {import('./blockstore.js').TransactionBlockstore} TransactionBlockstore
+ */
+
 const withLog = async (label, fn) => {
   const resp = await fn();
   // console.log('withLog', label, !!resp)
@@ -37662,7 +37670,7 @@ async function put (inBlocks, head, event, options) {
 /**
  * Determine the effective prolly root given the current merkle clock head.
  *
- * @param {import('./blockstore.js').TransactionBlockstore} inBlocks Bucket block storage.
+ * @param {TransactionBlockstore} inBlocks Bucket block storage.
  * @param {import('./clock').EventLink<import('./clock').EventData>[]} head Merkle clock head.
  */
 async function root (inBlocks, head) {
@@ -37671,8 +37679,8 @@ async function root (inBlocks, head) {
   }
   const { root: newProllyRootNode, blocks: newBlocks, cids } = await doProllyBulk(inBlocks, head);
   // todo maybe these should go to a temp blockstore?
-  await doTransaction('root', inBlocks, async (transactionBlockstore) => {
-    const { bigPut } = makeGetAndPutBlock(transactionBlockstore);
+  await doTransaction('root', inBlocks, async (transactionBlocks) => {
+    const { bigPut } = makeGetAndPutBlock(transactionBlocks);
     for (const nb of newBlocks) {
       bigPut(nb);
     }
@@ -37682,7 +37690,7 @@ async function root (inBlocks, head) {
 
 /**
  * Get the list of events not known by the `since` event
- * @param {import('./blockstore.js').TransactionBlockstore} blocks Bucket block storage.
+ * @param {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[]}>}
@@ -37699,7 +37707,7 @@ async function eventsSince (blocks, head, since) {
 
 /**
  *
- * @param {import('./blockstore.js').TransactionBlockstore} blocks Bucket block storage.
+ * @param {TransactionBlockstore} blocks Bucket block storage.
  * @param {import('./clock').EventLink<import('./clock').EventData>[]} head Merkle clock head.
  *
  * @returns {Promise<{cids: CIDCounter, clockCIDs: CIDCounter, result: import('./clock').EventData[]}>}
@@ -37720,7 +37728,7 @@ async function getAll (blocks, head) {
 }
 
 /**
- * @param {import('./blockstore.js').TransactionBlockstore} blocks Bucket block storage.
+ * @param {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.
  */
@@ -38002,6 +38010,22 @@ object.factory = function (codec) {
 	exports.type = 'charwise';
 } (charwise));
 
+/* global localStorage */
+let storageSupported = false;
+try {
+  storageSupported = window.localStorage && true;
+} catch (e) {}
+function localGet (key) {
+  if (storageSupported) {
+    return localStorage && localStorage.getItem(key)
+  }
+}
+function localSet (key, value) {
+  if (storageSupported) {
+    return localStorage && localStorage.setItem(key, value)
+  }
+}
+
 // @ts-nocheck
 
 /**
@@ -38016,31 +38040,16 @@ object.factory = function (codec) {
  * @param {object} [authCtx] - Optional authorization context object to use for any authentication checks.
  *
  */
-class Fireproof {
+class Database {
   listeners = new Set()
 
-  /**
-   * @function storage
-   * @memberof Fireproof
-   * Creates a new Fireproof instance with default storage settings
-   * Most apps should use this and not worry about the details.
-   * @static
-   * @returns {Fireproof} - a new Fireproof instance
-   */
-  static storage = (name = 'global') => {
-    const instanceKey = browserExports(32).toString('hex'); // pass null to disable encryption
-    // pick a random key from const validatedKeys
-    // const instanceKey = validatedKeys[Math.floor(Math.random() * validatedKeys.length)]
-    return new Fireproof(new TransactionBlockstore(name, instanceKey), [], { name })
-  }
-
-  constructor (blocks, clock, config, authCtx = {}) {
-    this.name = config?.name || 'global';
+  // todo refactor this for the next version
+  constructor (blocks, clock, config = {}) {
+    this.name = config.name;
     this.instanceId = `fp.${this.name}.${Math.random().toString(36).substring(2, 7)}`;
     this.blocks = blocks;
     this.clock = clock;
     this.config = config;
-    this.authCtx = authCtx;
     this.indexes = new Map();
   }
 
@@ -38055,7 +38064,7 @@ class Fireproof {
     return {
       clock: this.clockToJSON(),
       name: this.name,
-      key: this.blocks.valet.getKeyMaterial(),
+      key: this.blocks.valet?.getKeyMaterial(),
       indexes: [...this.indexes.values()].map(index => index.toJSON())
     }
   }
@@ -38073,10 +38082,16 @@ class Fireproof {
   hydrate ({ clock, name, key }) {
     this.name = name;
     this.clock = clock;
-    this.blocks.valet.setKeyMaterial(key);
+    this.blocks.valet?.setKeyMaterial(key);
     this.indexBlocks = null;
   }
 
+  maybeSaveClock () {
+    if (this.name && this.blocks.valet) {
+      localSet('fp.' + this.name, JSON.stringify(this));
+    }
+  }
+
   /**
    * Triggers a notification to all listeners
    * of the Fireproof instance so they can repaint UI, etc.
@@ -38187,14 +38202,19 @@ class Fireproof {
     doc._id = key;
     return doc
   }
+  /**
+ * @typedef {Object} Document
+ * @property {string} _id - The ID of the document (required)
+ * @property {string} [_proof] - The proof of the document (optional)
+ * @property {string} [_clock] - The clock of the document (optional)
+ * @property {any} [key: string] - Index signature notation to allow any other unknown fields
+ *  * @property {Object.<string, any>} [otherProperties] - Any other unknown properties (optional)
+ */
 
   /**
    * Adds a new document to the database, or updates an existing document. Returns the ID of the document and the new clock head.
    *
-   * @param {Object} doc - the document to be added
-   * @param {string} doc._id - the document ID. If not provided, a random ID will be generated.
-   * @param {CID[]} doc._clock - the document ID. If not provided, a random ID will be generated.
-   * @param {Proof} doc._proof - CIDs referenced by the update
+   * @param {Document} doc - the document to be added
    * @returns {Promise<{ id: string, clock: CID[]  }>} - The result of adding the document to the database
    * @memberof Fireproof
    * @instance
@@ -38302,6 +38322,7 @@ class Fireproof {
 
   async notifyListeners (changes) {
     // await sleep(10)
+    await this.maybeSaveClock();
     for (const listener of this.listeners) {
       await listener(changes);
     }
@@ -38314,8 +38335,7 @@ class Fireproof {
   }
 
   setRemoteBlockReader (remoteBlockReaderFn) {
-    // console.log('registering remote block reader')
-    this.blocks.valet.remoteBlockFunction = remoteBlockReaderFn;
+    this.blocks.remoteBlockFunction = remoteBlockReaderFn;
   }
 }
 
@@ -38336,6 +38356,124 @@ function encodeEvent (event) {
   return { ...event, key: encodedKey }
 }
 
+/**
+ * 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 {import('./database.js').Database} database - The Database database instance to index.
+ * @param {Function} routingFn - The routing function to apply to each entry in the database.
+ */
+// import { ChangeEvent } from './db-index'
+
+class Listener {
+  subcribers = new Map()
+  doStopListening = null
+
+  /**
+   * @param {import('./database.js').Database} database
+   * @param {(_: any, emit: any) => void} routingFn
+   */
+  constructor (
+    database,
+    routingFn = function (/** @type {any} */ _, /** @type {(arg0: string) => void} */ emit) {
+      emit('*');
+    }
+  ) {
+    this.database = database;
+    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;
+
+    this.dbHead = null;
+  }
+
+  /**
+   * Subscribe to a topic emitted by the event function.
+   * @param {string} topic - The topic to subscribe to.
+   * @param {Function} subscriber - The function to call when the topic is emitted.
+   * @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);
+    listOfTopicSubscribers.push(subscriber);
+    if (typeof since !== 'undefined') {
+      this.database.changesSince(since).then(({ rows: changes }) => {
+        const keys = topicsForChanges(changes, this.routingFn).get(topic);
+        if (keys) keys.forEach((/** @type {any} */ key) => subscriber(key));
+      });
+    }
+    return () => {
+      const index = listOfTopicSubscribers.indexOf(subscriber);
+      if (index > -1) listOfTopicSubscribers.splice(index, 1);
+    }
+  }
+
+  /**
+   * @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((/** @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((/** @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) {
+    topicList = [];
+    subscribersMap.set(name, topicList);
+  }
+  return topicList
+}
+
+/**
+ * Transforms a set of changes to events using an emitter function.
+ *
+ * @param {ChangeEvent[]} changes
+ * @param {Function} routingFn
+ * @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 }, (/** @type {any} */ t) => {
+      const topicList = getTopicList(seenTopics, t);
+      topicList.push(key);
+    });
+  });
+  return seenTopics
+};
+
 const compare$1 = (a, b) => {
   const [aKey, aRef] = a;
   const [bKey, bRef] = b;
@@ -38530,7 +38668,7 @@ const indexEntriesForChanges = (changes, mapFn) => {
  * @class DbIndex
  * @classdesc An DbIndex can be used to order and filter the documents in a Fireproof database.
  *
- * @param {Fireproof} database - The Fireproof database instance to DbIndex.
+ * @param {Database} database - The Fireproof database instance to DbIndex.
  * @param {Function} mapFn - The map function to apply to each entry in the database.
  *
  */
@@ -38538,7 +38676,7 @@ class DbIndex {
   constructor (database, mapFn, clock, opts = {}) {
     this.database = database;
     if (!database.indexBlocks) {
-      database.indexBlocks = new TransactionBlockstore(database.name + '.indexes', database.blocks.valet.getKeyMaterial());
+      database.indexBlocks = new TransactionBlockstore(database?.name + '.indexes', database.blocks.valet?.getKeyMaterial());
     }
     /**
      * The map function to apply to each entry in the database.
@@ -38757,125 +38895,34 @@ async function doIndexQuery (blocks, indexByKey, query = {}) {
   }
 }
 
-/**
- * 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 {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'
-
-class Listener {
-  subcribers = new Map()
-  doStopListening = null
-
-  /**
-   * @param {import('./fireproof.js').Fireproof} database
-   * @param {(_: any, emit: any) => void} routingFn
-   */
-  constructor (database, routingFn) {
-    this.database = database;
-    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 (/** @type {any} */ _, /** @type {(arg0: string) => void} */ emit) {
-        emit('*');
-      };
-    this.dbHead = null;
-  }
-
-  /**
-   * Subscribe to a topic emitted by the event function.
-   * @param {string} topic - The topic to subscribe to.
-   * @param {Function} subscriber - The function to call when the topic is emitted.
-   * @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);
-    listOfTopicSubscribers.push(subscriber);
-    if (typeof since !== 'undefined') {
-      this.database.changesSince(since).then(({ rows: changes }) => {
-        const keys = topicsForChanges(changes, this.routingFn).get(topic);
-        if (keys) keys.forEach((/** @type {any} */ key) => subscriber(key));
-      });
-    }
-    return () => {
-      const index = listOfTopicSubscribers.indexOf(subscriber);
-      if (index > -1) listOfTopicSubscribers.splice(index, 1);
-    }
-  }
-
-  /**
-   * @typedef {import('./db-index').ChangeEvent} ChangeEvent
-   */
+const parseCID = cid => typeof cid === 'string' ? CID$1.parse(cid) : cid;
 
+class Fireproof {
   /**
-   * @param {ChangeEvent[]} changes
+   * @function storage
+   * @memberof Fireproof
+   * Creates a new Fireproof instance with default storage settings
+   * Most apps should use this and not worry about the details.
+   * @static
+   * @returns {Database} - a new Fireproof instance
    */
-  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((/** @type {(arg0: any) => any} */ subscriber) =>
-          keys.forEach((/** @type {any} */ key) => subscriber(key))
-        );
+  static storage = (name = null, opts = {}) => {
+    if (name) {
+      opts.name = name;
+      const existing = localGet('fp.' + name);
+      if (existing) {
+        const existingConfig = JSON.parse(existing);
+        const fp = new Database(new TransactionBlockstore(name, existingConfig.key), [], opts);
+        return this.fromJSON(existingConfig, fp)
+      } else {
+        const instanceKey = browserExports(32).toString('hex'); // pass null to disable encryption
+        return new Database(new TransactionBlockstore(name, instanceKey), [], opts)
       }
     } else {
-      // non-arrays go to all subscribers
-      for (const [, listOfTopicSubscribers] of this.subcribers) {
-        listOfTopicSubscribers.forEach((/** @type {(arg0: any) => any} */ subscriber) => subscriber(changes));
-      }
+      return new Database(new TransactionBlockstore(), [], opts)
     }
   }
-}
-
-/**
- * @param {Map<any, any>} subscribersMap
- * @param {string} name
- */
-function getTopicList (subscribersMap, name) {
-  let topicList = subscribersMap.get(name);
-  if (!topicList) {
-    topicList = [];
-    subscribersMap.set(name, topicList);
-  }
-  return topicList
-}
-
-/**
- * Transforms a set of changes to events using an emitter function.
- *
- * @param {ChangeEvent[]} changes
- * @param {Function} routingFn
- * @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 }, (/** @type {any} */ t) => {
-      const topicList = getTopicList(seenTopics, t);
-      topicList.push(key);
-    });
-  });
-  return seenTopics
-};
-
-const parseCID = cid => typeof cid === 'string' ? CID$1.parse(cid) : cid;
 
-class Hydrator {
   static fromJSON (json, database) {
     database.hydrate({ clock: json.clock.map(c => parseCID(c)), name: json.name, key: json.key });
     if (json.indexes) {
@@ -38896,7 +38943,7 @@ class Hydrator {
 
   static snapshot (database, clock) {
     const definition = database.toJSON();
-    const withBlocks = new Fireproof(database.blocks);
+    const withBlocks = new Database(database.blocks);
     if (clock) {
       definition.clock = clock.map(c => parseCID(c));
       definition.indexes.forEach(index => {
@@ -38925,7 +38972,6 @@ class Hydrator {
 }
 
 exports.Fireproof = Fireproof;
-exports.Hydrator = Hydrator;
 exports.Index = DbIndex;
 exports.Listener = Listener;
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=fireproof.js.map