@fireproof/core 0.5.18 → 0.5.20

package/dist/src/blockstore.js

@@ -80,7 +80,6 @@ export class TransactionBlockstore {
     }
     async networkGet(key) {
         if (this.remoteBlockFunction) {
-            // todo why is this on valet?
             const value = await husher(key, async () => await this.remoteBlockFunction(key));
             if (value) {
                 // console.log('networkGot: ' + key, value.length)

package/dist/src/clock.js

@@ -78,7 +78,7 @@ export class EventBlock extends Block {
      * @param {Uint8Array} config.bytes
      */
     constructor({ cid, value, bytes }) {
-        // @ts-expect-error
+        // @ts-ignore
         super({ cid, value, bytes });
     }
     /**
@@ -129,7 +129,7 @@ export class EventFetcher {
 export async function encodeEventBlock(value) {
     // TODO: sort parents
     const { cid, bytes } = await encode({ value, codec: cbor, hasher: sha256 });
-    // @ts-expect-error
+    // @ts-ignore
     return new Block({ cid, value, bytes });
 }
 /**
@@ -139,7 +139,7 @@ export async function encodeEventBlock(value) {
  */
 export async function decodeEventBlock(bytes) {
     const { cid, value } = await decode({ bytes, codec: cbor, hasher: sha256 });
-    // @ts-expect-error
+    // @ts-ignore
     return new Block({ cid, value, bytes });
 }
 /**

package/dist/src/database.js

@@ -42,7 +42,6 @@ export class Database {
      * @instance
      */
     toJSON() {
-        // todo this also needs to return the index roots...
         return {
             clock: this.clockToJSON(),
             name: this.name,
@@ -75,6 +74,17 @@ export class Database {
             localSet('fp.' + this.name, JSON.stringify(this));
         }
     }
+    index(name) {
+        // iterate over the indexes and gather any with the same name
+        // if there are more than one, throw an error
+        // if there is one, return it
+        // if there are none, return null
+        const indexes = [...this.indexes.values()].filter(index => index.name === name);
+        if (indexes.length > 1) {
+            throw new Error(`Multiple indexes found with name ${name}`);
+        }
+        return indexes[0] || null;
+    }
     /**
      * Triggers a notification to all listeners
      * of the Fireproof instance so they can repaint UI, etc.
@@ -159,8 +169,7 @@ export class Database {
         const cids = await cidsToProof(allResp.cids);
         const clockCids = await cidsToProof(allResp.clockCIDs);
         // console.log('allcids', cids, clockCids)
-        // todo we need to put the clock head as the last block in the encrypted car
-        return [...cids, ...clockCids]; // need a single block version of clock head, maybe an encoded block for it
+        return [...cids, ...clockCids]; // clock CID last -- need to handle multiple entry clocks
     }
     async allStoredCIDs() {
         const allCIDs = [];
@@ -199,7 +208,7 @@ export class Database {
         const clock = opts.clock || this.clock;
         const resp = await get(this.blocks, clock, charwise.encode(key), this.rootCache);
         this.rootCache = { root: resp.root, clockCIDs: resp.clockCIDs };
-        // this tombstone is temporary until we can get the prolly tree to delete
+        // ? this tombstone is temporary until we can get the prolly tree to delete
         if (!resp || resp.result === null) {
             throw new Error('Not found');
         }
@@ -215,12 +224,11 @@ export class Database {
         return doc;
     }
     /**
-     * @typedef {Object} Document
+     * @typedef {any} 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)
+     * @property {Object.<string, any>} [unknown: string] - 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.

package/dist/src/db-index.js

@@ -291,7 +291,7 @@ export class DbIndex {
     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())
-        // todo remove this hack
+        // todo remove this hack in 0.7.0
         if (ALWAYS_REBUILD) {
             this.indexById = { root: null, cid: null };
             this.indexByKey = { root: null, cid: null };
@@ -329,9 +329,7 @@ export class DbIndex {
             this.indexById = await bulkIndex(blocks, this.indexById, removeByIdIndexEntries.concat(byIdIndexEntries), idIndexOpts);
             this.indexByKey = await bulkIndex(blocks, this.indexByKey, oldIndexEntries.concat(indexEntries), dbIndexOpts);
             this.dbHead = result.clock;
-        }, false /* don't sync transaction -- maybe move this flag to database.indexBlocks? */);
-        // todo index subscriptions
-        // this.database.notifyExternal('dbIndex')
+        }, false /* don't sync transaction -- todo move this flag to database.indexBlocks, and concept of sync channels */);
         // console.timeEnd(callTag + '.doTransactionupdateIndex')
         // console.log(`updateIndex ${callTag} <`, this.instanceId, this.dbHead?.toString(), this.indexByKey.cid?.toString(), this.indexById.cid?.toString())
         return didT;

package/dist/src/fireproof.d.ts

@@ -44,9 +44,6 @@ declare class Valet {
     getCarCIDForCID(cid: any): Promise<{
         result: any;
     }>;
-    OLDgetCarCIDForCID(cid: any): Promise<{
-        result: any;
-    }>;
     getCombinedReader(carCid: any): Promise<{
         root: any;
         put: (cid: any, bytes: any) => Promise<void>;
@@ -58,6 +55,7 @@ declare class Valet {
      * @param {*} value
      */
     parkCar(carCid: string, value: any, cids: any): Promise<void>;
+    writeCars(cars: any): Promise<any>;
     remoteBlockFunction: any;
     getCarReader(carCid: any): Promise<{
         root: any;
@@ -236,6 +234,7 @@ declare class Database {
         indexCar: any;
     }): void;
     maybeSaveClock(): void;
+    index(name: any): any;
     /**
      * Triggers a notification to all listeners
      * of the Fireproof instance so they can repaint UI, etc.
@@ -290,12 +289,11 @@ declare class Database {
         _id: string;
     }>;
     /**
-     * @typedef {Object} Document
+     * @typedef {any} 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)
+     * @property {Object.<string, any>} [unknown: string] - 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.
@@ -305,31 +303,7 @@ declare class Database {
      * @memberof Fireproof
      * @instance
      */
-    put({ _id, _proof, ...doc }: {
-        /**
-         * - The ID of the document (required)
-         */
-        _id: string;
-        /**
-         * - The proof of the document (optional)
-         */
-        _proof?: string;
-        /**
-         * - The clock of the document (optional)
-         */
-        _clock?: string;
-        /**
-         * : string] - Index signature notation to allow any other unknown fields
-         * *
-         */
-        key?: any;
-        /**
-         * - Any other unknown properties (optional)
-         */
-        otherProperties?: {
-            [x: string]: any;
-        };
-    }): Promise<{
+    put({ _id, _proof, ...doc }: any): Promise<{
         id: string;
         clock: CID[];
     }>;

package/dist/src/fireproof.js

@@ -5566,7 +5566,7 @@ class EventBlock extends Block {
    * @param {Uint8Array} config.bytes
    */
   constructor ({ cid, value, bytes }) {
-    // @ts-expect-error
+    // @ts-ignore
     super({ cid, value, bytes });
   }
 
@@ -5620,7 +5620,7 @@ class EventFetcher {
 async function encodeEventBlock (value) {
   // TODO: sort parents
   const { cid, bytes } = await encode$7({ value, codec: codec$1, hasher: sha256$2 });
-  // @ts-expect-error
+  // @ts-ignore
   return new Block({ cid, value, bytes })
 }
 
@@ -5631,7 +5631,7 @@ async function encodeEventBlock (value) {
  */
 async function decodeEventBlock (bytes) {
   const { cid, value } = await decode$9({ bytes, codec: codec$1, hasher: sha256$2 });
-  // @ts-expect-error
+  // @ts-ignore
   return new Block({ cid, value, bytes })
 }
 
@@ -39554,29 +39554,29 @@ class Valet {
       // )
       if (this.uploadFunction) {
         // todo we can coalesce these into a single car file
-        return await this.withDB(async db => {
-          for (const task of tasks) {
-            await this.uploadFunction(task.carCid, task.value);
-            // update the indexedb to mark this car as no longer pending
-            const carMeta = await db.get('cidToCar', task.carCid);
-            delete carMeta.pending;
-            await db.put('cidToCar', carMeta);
-          }
-        })
+        // todo remove idb usage here
+        for (const task of tasks) {
+          await this.uploadFunction(task.carCid, task.value);
+          // todo update syncCidMap to say this has been synced
+          // const carMeta = await db.get('cidToCar', task.carCid)
+          // delete carMeta.pending
+          // await db.put('cidToCar', carMeta)
+        }
       }
       callback();
     });
 
     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) {
-          await this.uploadFunction(carKey, await db.get('cars', carKey));
-          const carMeta = await db.get('cidToCar', carKey);
-          delete carMeta.pending;
-          await db.put('cidToCar', carMeta);
-        }
-      })
+      // todo read syncCidMap and sync any that are still unsynced
+      //   return await this.withDB(async db => {
+      //     const carKeys = (await db.getAllFromIndex('cidToCar', 'pending')).map(c => c.car)
+      //     for (const carKey of carKeys) {
+      //       await this.uploadFunction(carKey, await db.get('cars', carKey))
+      //       const carMeta = await db.get('cidToCar', carKey)
+      //       delete carMeta.pending
+      //       await db.put('cidToCar', carMeta)
+      //     }
+      //   })
     });
   }
 
@@ -39622,16 +39622,10 @@ class Valet {
 
   withDB = async dbWorkFun => {
     if (!this.idb) {
-      this.idb = await openDB(`fp.${this.keyId}.${this.name}.valet`, 2, {
+      this.idb = await openDB(`fp.${this.keyId}.${this.name}.valet`, 3, {
         upgrade (db, oldVersion, newVersion, transaction) {
           if (oldVersion < 1) {
-            db.createObjectStore('cars'); // todo use database name
-            const cidToCar = db.createObjectStore('cidToCar', { keyPath: 'car' });
-            cidToCar.createIndex('cids', 'cids', { multiEntry: true });
-          }
-          if (oldVersion < 2) {
-            const cidToCar = transaction.objectStore('cidToCar');
-            cidToCar.createIndex('pending', 'pending');
+            db.createObjectStore('cars');
           }
         }
       });
@@ -39647,13 +39641,11 @@ class Valet {
    */
   async * cids () {
     // console.log('valet cids')
-    const db = await this.withDB(async db => db);
-    const tx = db.transaction(['cidToCar'], 'readonly');
-    let cursor = await tx.store.openCursor();
-    while (cursor) {
-      yield { cid: cursor.key, car: cursor.value.car };
-      cursor = await cursor.continue();
-    }
+    // todo use cidMap
+    // while (cursor) {
+    // yield { cid: cursor.key, car: cursor.value.car }
+    // cursor = await cursor.continue()
+    // }
   }
 
   setRootCarCid (cid) {
@@ -39662,6 +39654,7 @@ class Valet {
     this.valetRootCid = null;
   }
 
+  // todo memoize this
   async getCarCIDForCID (cid) {
     // make a car reader for this.valetRootCarCid
     if (!this.valetRootCarCid) return
@@ -39687,15 +39680,6 @@ class Valet {
     return { result: got }
   }
 
-  async OLDgetCarCIDForCID (cid) {
-    const carCid = await this.withDB(async db => {
-      const tx = db.transaction(['cars', 'cidToCar'], 'readonly');
-      const indexResp = await tx.objectStore('cidToCar').index('cids').get(cid);
-      return indexResp?.car
-    });
-    return { result: carCid }
-  }
-
   async getCombinedReader (carCid) {
     let carMapReader;
     if (this.valetRootCarCid) {
@@ -39760,15 +39744,20 @@ class Valet {
       newValetCidCar = await blocksToCarBlock(this.valetRootCid, saveValetBlocks);
     }
     // console.log('newValetCidCar', this.name, Math.floor(newValetCidCar.bytes.length / 1024))
-    await this.withDB(async db => {
-      const tx = db.transaction(['cars'], 'readwrite');
-      await tx.objectStore('cars').put(value, carCid.toString());
-      if (newValetCidCar) {
-        if (this.valetRootCarCid) ;
-        await tx.objectStore('cars').put(newValetCidCar.bytes, newValetCidCar.cid.toString());
+    await this.writeCars([
+      {
+        cid: carCid,
+        bytes: value,
+        replaces: null
+      },
+      {
+        cid: newValetCidCar.cid,
+        bytes: newValetCidCar.bytes,
+        replaces: null
+        // replaces: this.valetRootCarCid // todo
       }
-      return await tx.done
-    });
+    ]);
+
     this.valetRootCarCid = newValetCidCar.cid; // goes to clock
 
     // console.log('parked car', carCid, value.length, Array.from(cids))
@@ -39785,6 +39774,20 @@ class Valet {
     }
   }
 
+  async writeCars (cars) {
+    return await this.withDB(async db => {
+      const tx = db.transaction(['cars'], 'readwrite');
+      for (const { cid, bytes, replaces } of cars) {
+        await tx.objectStore('cars').put(bytes, cid.toString());
+        // todo remove old maps
+        if (replaces) {
+          await tx.objectStore('cars').delete(replaces.toString());
+        }
+      }
+      return await tx.done
+    })
+  }
+
   remoteBlockFunction = null
 
   async getCarReader (carCid) {
@@ -39815,7 +39818,7 @@ class Valet {
       };
       const { blocks } = await blocksFromEncryptedCarBlock(roots[0], readerGetWithCodec, this.keyMaterial);
 
-      // last block is the root ???
+      // last block is the root ??? todo
       const rootBlock = blocks[blocks.length - 1];
 
       return {
@@ -40083,7 +40086,6 @@ class TransactionBlockstore {
 
   async networkGet (key) {
     if (this.remoteBlockFunction) {
-      // todo why is this on valet?
       const value = await husher(key, async () => await this.remoteBlockFunction(key));
       if (value) {
         // console.log('networkGot: ' + key, value.length)
@@ -40421,13 +40423,6 @@ const prollyRootFromAncestor = async (events, ancestor, getBlock) => {
   }
 };
 
-// async function bigMerge (events, head, getBlock) {
-//   const allRoots = await Promise.all(head.map(async h => prollyRootFromAncestor(events, h, getBlock)))
-//   console.log('allRoots', allRoots)
-//   // todo query over all roots and merge them, but how do they not have a common ancestor? they all start with the _sync root
-//   throw new Error('not implemented')
-// }
-
 const doProllyBulk = async (inBlocks, head, event, doFull = false) => {
   const { getBlock, blocks } = makeGetAndPutBlock(inBlocks); // this is doubled with eventfetcher
   let bulkSorted = [];
@@ -40596,8 +40591,6 @@ async function eventsSince (blocks, head, since) {
  *
  */
 async function getAll (blocks, head, rootCache = null, doFull = false) {
-  // todo use the root node left around from put, etc
-  // move load to a central place
   if (!head.length) {
     return { root: null, clockCIDs: new CIDCounter(), cids: new CIDCounter(), result: [] }
   }
@@ -40977,7 +40970,6 @@ class Database {
    * @instance
    */
   toJSON () {
-    // todo this also needs to return the index roots...
     return {
       clock: this.clockToJSON(),
       name: this.name,
@@ -41014,6 +41006,18 @@ class Database {
     }
   }
 
+  index (name) {
+    // iterate over the indexes and gather any with the same name
+    // if there are more than one, throw an error
+    // if there is one, return it
+    // if there are none, return null
+    const indexes = [...this.indexes.values()].filter(index => index.name === name);
+    if (indexes.length > 1) {
+      throw new Error(`Multiple indexes found with name ${name}`)
+    }
+    return indexes[0] || null
+  }
+
   /**
    * Triggers a notification to all listeners
    * of the Fireproof instance so they can repaint UI, etc.
@@ -41102,8 +41106,7 @@ class Database {
     const cids = await cidsToProof(allResp.cids);
     const clockCids = await cidsToProof(allResp.clockCIDs);
     // console.log('allcids', cids, clockCids)
-    // todo we need to put the clock head as the last block in the encrypted car
-    return [...cids, ...clockCids] // need a single block version of clock head, maybe an encoded block for it
+    return [...cids, ...clockCids] // clock CID last -- need to handle multiple entry clocks
   }
 
   async allStoredCIDs () {
@@ -41145,7 +41148,7 @@ class Database {
     const clock = opts.clock || this.clock;
     const resp = await get(this.blocks, clock, charwise.encode(key), this.rootCache);
     this.rootCache = { root: resp.root, clockCIDs: resp.clockCIDs };
-    // this tombstone is temporary until we can get the prolly tree to delete
+    // ? this tombstone is temporary until we can get the prolly tree to delete
     if (!resp || resp.result === null) {
       throw new Error('Not found')
     }
@@ -41161,12 +41164,11 @@ class Database {
     return doc
   }
   /**
-   * @typedef {Object} Document
+   * @typedef {any} 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)
+   * @property {Object.<string, any>} [unknown: string] - Any other unknown properties (optional)
    */
 
   /**
@@ -41920,9 +41922,7 @@ class DbIndex {
       );
       this.indexByKey = await bulkIndex(blocks, this.indexByKey, oldIndexEntries.concat(indexEntries), dbIndexOpts);
       this.dbHead = result.clock;
-    }, false /* don't sync transaction -- maybe move this flag to database.indexBlocks? */);
-    // todo index subscriptions
-    // this.database.notifyExternal('dbIndex')
+    }, false /* don't sync transaction -- todo move this flag to database.indexBlocks, and concept of sync channels */);
     // console.timeEnd(callTag + '.doTransactionupdateIndex')
     // console.log(`updateIndex ${callTag} <`, this.instanceId, this.dbHead?.toString(), this.indexByKey.cid?.toString(), this.indexById.cid?.toString())
     return didT
@@ -44014,7 +44014,7 @@ class Sync {
   async sendUpdate (blockstore) {
     if (!this.peer || !this.isReady) return
     // console.log('send update from', this.database.instanceId)
-    // todo should send updates since last sync
+    // todo should send updates since last sync (currently sends each transaction)
     const newCar = await blocksToCarBlock(blockstore.lastCid, blockstore);
     this.status = 'sending update car';
     this.peer.send(newCar.bytes);
@@ -44099,7 +44099,7 @@ class Fireproof {
   static storage = (name = null, opts = {}) => {
     if (name) {
       opts.name = name;
-      // todo this can come from a registry also
+      // todo this can come from a registry also eg remote database / config, etc
       const existing = localGet('fp.' + name);
       if (existing) {
         const existingConfig = JSON.parse(existing);