@fireproof/core 0.6.2 → 0.6.3-dev

package/README.md

@@ -8,9 +8,6 @@
 </h3>
 
 <p align="center">
-  <a href="https://bundlephobia.com/package/@fireproof/core" rel="nofollow">
-    <img src="https://deno.bundlejs.com/?q=@fireproof/core&treeshake=[*+as+fireproofCore]&badge" alt="Bundle Size"  style="max-width: 100%;">
-  </a>
   <a href="https://github.com/jchris/fireproof/actions/workflows/test.yml">
     <img src="https://github.com/jchris/fireproof/actions/workflows/test.yml/badge.svg" alt="Test" style="max-width: 100%;">
   </a>
@@ -20,6 +17,9 @@
   <a href="https://github.com/fireproof-storage/fireproof/blob/main/packages/react/README.md">
     <img src="https://shields.io/badge/react-black?logo=react&style=for-the-badge%22" alt="React"  style="max-width: 100%;">
   </a>
+  <a href="https://bundlephobia.com/package/@fireproof/core" rel="nofollow">
+    <img src="https://deno.bundlejs.com/?q=@fireproof/core&treeshake=[*+as+fireproofCore]&badge" alt="Bundle Size"  style="max-width: 100%;">
+  </a>
 </p>
 
 Fireproof uses immutable data and distributed protocols to offer a new kind of database that:
@@ -125,6 +125,8 @@ const { rows, ref } = await index.query({ range: [40, 52] })
 //   { key: 47, value: 'André', id: 'three-thousand' } ]
 ```
 
+The same mechanism that powers the built-in indexes can all be used to connect secondary [vector indexers](https://github.com/tantaraio/voy) or fulltext indexes to Fireproof. [Follow this tutorial to connect a secondary index](https://fireproof.storage/documentation/external-indexers/).
+
 ### Realtime Updates
 
 Subscribe to query changes in your application, so your UI updates automatically. Use the supplied React hooks, or simple function calls to be notified of relevant changes.
@@ -146,12 +148,16 @@ useEffect(() => database.subscribe((changes) =>
 
 ### Cryptographic Proofs
 
-Fireproof's Merkle clocks and hash trees are immutable and self-validating, making merging changes safe and efficient. Fireproof makes cryptographic proofs available for all of its operations, accelerating replication and making trustless index sharing possible. [Proofs make Fireproof the ideal verifiable document database](https://fireproof.storage/posts/from-mlops-to-point-of-sale:-merkle-proofs-and-data-locality/) for smart contracts and other applications where unique, verifiable, and trustworthy data is required. [Proof chains provide performance benefits as well](https://purrfect-tracker-45c.notion.site/Data-Routing-23c37b269b4c4c3dacb60d0077113bcb), by allowing recipients to skip costly I/O operations and instead cryptographically verify that changes contain all of the required context.
+Fireproof's Merkle clocks and hash trees are immutable and self-validating, and all query results are offline-capable data slices. Fireproof makes cryptographic proofs available for all of its operations, accelerating replication and making trustless index sharing possible. If you are making a "DocuSign for _____", [proofs make Fireproof the ideal verifiable document database](https://fireproof.storage/posts/from-mlops-to-point-of-sale:-merkle-proofs-and-data-locality/) for smart contracts and other applications where unique, verifiable, and trustworthy data is required. [Proof chains provide performance benefits as well](https://purrfect-tracker-45c.notion.site/Data-Routing-23c37b269b4c4c3dacb60d0077113bcb), by allowing recipients to skip costly I/O operations and instead cryptographically verify that changes contain all of the required context.
 
 ### Automatic Replication
 
 Documents changes are persisted to [Filecoin](https://filecoin.io) via [web3.storage](https://web3.storage), and made available over IPFS and on a global content delivery network. All you need to do to sync state is send a link to the latest database head, and Fireproof will take care of the rest. 
 
+### Peer-to-peer Sync
+
+Application instances can be connected using WebRTC or any other stream API library, like [Socket Supply](https://socketsupply.co), [libp2p](https://libp2p.io), or [PartyKit](https://partykit.io). The [first sync demo uses pure WebRTC with no signaling server](https://game.fireproof.storage), which limits its usability. There are demos with other transports coming soon.
+
 ### Self-sovereign Identity
 
 Fireproof is so easy to integrate with any site or app because you can get started right away, and set up an account later. By default users write to their own database copy, so you can get pretty far before you even have to think about API keys. [Authorization is via non-extractable keypair](https://ucan.xyz), like TouchID / FaceID.

package/dist/src/crypto-poly.js

@@ -0,0 +1,4 @@
+import crypto from 'crypto-browserify';
+export function randomBytes(n) {
+    return crypto.randomBytes(n);
+}

package/dist/src/database.js

@@ -2,7 +2,6 @@
 import { visMerkleClock, visMerkleTree, vis, put, get, getAll, eventsSince } from './prolly.js';
 import { doTransaction, TransactionBlockstore } from './blockstore.js';
 import charwise from 'charwise';
-import { localSet } from './utils.js';
 import { CID } from 'multiformats';
 // TypeScript Types
 // eslint-disable-next-line no-unused-vars
@@ -31,7 +30,7 @@ export class Database {
         this.name = name;
         this.instanceId = `fp.${this.name}.${Math.random().toString(36).substring(2, 7)}`;
         this.blocks = new TransactionBlockstore(name, config.key);
-        this.indexBlocks = new TransactionBlockstore(name + '.indexes', config.key);
+        this.indexBlocks = new TransactionBlockstore(name ? name + '.indexes' : null, config.key);
         this.clock = clock;
         this.config = config;
     }
@@ -71,7 +70,7 @@ export class Database {
     }
     maybeSaveClock() {
         if (this.name && this.blocks.valet) {
-            localSet('fp.' + this.name, JSON.stringify(this));
+            this.blocks.valet.saveHeader(JSON.stringify(this));
         }
     }
     index(name) {
@@ -292,6 +291,7 @@ export class Database {
             console.error('failed', event);
             throw new Error('failed to put at storage layer');
         }
+        // await new Promise(resolve => setTimeout(resolve, 10)) // makes concurrent tests work
         this.applyClock(prevClock, result.head);
         await this.notifyListeners([decodedEvent]); // this type is odd
         return {

package/dist/src/fireproof.d.ts

@@ -1,9 +1,33 @@
 import * as multiformats from 'multiformats';
 import { Link, CID } from 'multiformats';
 import * as multiformats_cid from 'multiformats/cid';
+import * as idb from 'idb';
 
 type AnyLink = Link<unknown, number, number, 1|0>
 
+declare class Loader {
+    constructor(name: any, keyId: any, config?: {
+        dataDir: any;
+        headerKeyPrefix: string;
+    });
+    name: any;
+    keyId: any;
+    config: {
+        dataDir: any;
+        headerKeyPrefix: string;
+    };
+    isBrowser: boolean;
+    withDB: (dbWorkFun: any) => Promise<any>;
+    idb: idb.IDBPDatabase<unknown>;
+    writeCars(cars: any): Promise<void>;
+    writeCarsIDB(cars: any): Promise<any>;
+    readCar(carCid: any): Promise<any>;
+    readCarIDB(carCid: any): Promise<any>;
+    getHeader(): any;
+    saveHeader(stringValue: any): Promise<void>;
+    headerFilename(): any;
+}
+
 declare class Valet {
     constructor(name: string, keyMaterial: any);
     idb: any;
@@ -22,6 +46,8 @@ declare class Valet {
      * @type {null|function(string, Uint8Array):Promise<void>}
      */
     uploadFunction: null | ((arg0: string, arg1: Uint8Array) => Promise<void>);
+    loader: Loader;
+    saveHeader(header: any): Promise<void>;
     getKeyMaterial(): any;
     setKeyMaterial(km: any): void;
     /**
@@ -32,7 +58,6 @@ declare class Valet {
      * @memberof Valet
      */
     writeTransaction(innerBlockstore: InnerBlockstore, cids: Set<string>): Promise<void>;
-    withDB: (dbWorkFun: any) => Promise<any>;
     /**
      * Iterate over all blocks in the store.
      *
@@ -55,7 +80,6 @@ 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;