@fireproof/core 0.5.6 → 0.5.7

package/README.md

@@ -27,6 +27,24 @@ const doc = await fireproof.get(ok.id)
 
 🤫 I like to drop a `window.fireproof = fireproof` in there as a development aid.
 
+### ChatGPT Quick Start
+
+Paste this to GPT 4 or 3.5 to enable it to write apps using Fireproof:
+
+```
+Fireproof/API/Usage: import { Fireproof, Listener, Index } from '@fireproof/core'; const db = fireproof.storage('app-db-name'); const ok = await db.put({ any: 'json' }); const doc = await db.get(ok.id); await db.del(doc._id); const all = await db.allDocuments(); all.rows.map(({key, value}) => value); const listener = new Listener(db); listener.on('*', updateReactStateFn); const index = new Index(db, (doc, map) => map(doc.any, {custom: Object.keys(doc)})); const result = await index.query({range : ['a', 'z']}); result.rows.map(({ key }) => key);
+```
+
+In the same prompt, describe the app you want to build. Here are some examples that worked for us:
+
+* Create a react app using Fireproof for tracking party invites. It should have a text input that creates a new document with the guest name, and an Index that lists all guests in a <ul>. ([Running copy here.](https://codepen.io/jchrisa/pen/zYmogWO))
+* Build a React app that allows you to create profiles for dogs, and browse to each profile. It should be optimized for mobile. Use Tailwind.
+* Build a photo grid app that with drag and drop ordering that references photos by url. Use tailwind and render all photos as squares. Keep grid arrangement in fireproof with one document for each gallery, that is: 4-16 photos arranged into a layout.
+* Build an app using React, Fireproof, MagicLink, and Tailwind that allows user to create one-question multiple choice polls and collect the answers.
+* Create a note taking app using React, Tailwind, and Fireproof that stores each note as a large text string in a Fireproof document, and uses an Index to split the text of the documents into tokens for full text search. The app has an input field to search the documents via an index query.
+
+Please share your successes with us here or on [Twitter.](https://twitter.com/FireproofStorge)
+
 ### Status
 
 Fireproof is alpha software, ready for you to evaluate for your future applications. For now, [check out our React TodoMVC implementation running in browser-local mode.](https://main--lucky-naiad-5aa507.netlify.app/) It demonstrates document persistence, index queries, and event subscriptions, and uses the [`useFireproof()` React hook.](https://github.com/fireproof-storage/fireproof/blob/main/packages/fireproof/hooks/use-fireproof.tsx)

package/dist/src/fireproof.d.ts

@@ -108,7 +108,7 @@ type ChangeEvent = {
  * @param {object} [authCtx] - Optional authorization context object to use for any authentication checks.
  *
  */
-declare class Database {
+declare class Database$1 {
     constructor(blocks: any, clock: any, config?: {});
     listeners: Set<any>;
     name: any;
@@ -169,6 +169,7 @@ declare class Database {
         proof: any[];
     }>;
     allCIDs(): Promise<any[]>;
+    allStoredCIDs(): Promise<any[]>;
     /**
      * Runs validation on the specified document using the Fireproof instance's configuration. Throws an error if the document is invalid.
      *
@@ -265,7 +266,10 @@ declare class Database {
     }, unknown>;
     visTree(): Promise<{
         cids: any;
-        result: any;
+        result: any; /**
+        //    * Advances the clock to the specified event and updates the root CID
+        //    *   Will be used by replication
+        //    */
         vis?: undefined;
     } | {
         vis: string;
@@ -302,10 +306,10 @@ declare class Listener {
      * @param {import('./database.js').Database} database
      * @param {(_: any, emit: any) => void} routingFn
      */
-    constructor(database: Database, routingFn?: (_: any, emit: any) => void);
+    constructor(database: Database$1, routingFn?: (_: any, emit: any) => void);
     subcribers: Map<any, any>;
     doStopListening: any;
-    database: Database;
+    database: Database$1;
     /**
      * The map function to apply to each entry in the database.
      * @type {Function}
@@ -319,7 +323,7 @@ declare class Listener {
      * @returns {Function} A function to unsubscribe from the topic.
      * @memberof Listener
      * @instance
-     * @param {any} [since] - clock to flush from on launch
+     * @param {any} [since] - clock to flush from on launch, pass null for all
      */
     on(topic: string, subscriber: Function, since?: any): Function;
     /**
@@ -331,6 +335,39 @@ declare class Listener {
     onChanges(changes: ChangeEvent[]): void;
 }
 
+/**
+ * @typedef {import('./database.js').Database} Database
+ */
+declare class Sync {
+    /**
+     * @param {import("./database.js").Database} database
+     * @param {string} key
+     */
+    static makeCar(database: Database$1, key: string, skip?: any[]): Promise<multiformats.BlockView<Uint8Array, 85, 18, 1>>;
+    /**
+     * @param {Database} database
+     * @param {typeof SimplePeer} [PeerClass]
+     * @memberof Sync
+     * @static
+     */
+    constructor(database: Database, PeerClass?: any);
+    database: Database$1;
+    PeerClass: any;
+    pushBacklog: Promise<any>;
+    pushBacklogResolve: (value: any) => void;
+    pushBacklogReject: (reason?: any) => void;
+    offer(): Promise<string>;
+    accept(base64offer: any): Promise<string>;
+    connect(base64accept: any): void;
+    setupPeer(initiator?: boolean): Promise<string>;
+    peer: any;
+    backlog(): Promise<any>;
+    gotData(data: any): Promise<void>;
+    sendUpdate(blockstore: any): Promise<void>;
+    startSync(): Promise<void>;
+}
+type Database = Database$1;
+
 declare class Fireproof {
     /**
      * @function storage
@@ -340,11 +377,10 @@ declare class Fireproof {
      * @static
      * @returns {Database} - a new Fireproof instance
      */
-    static storage: (name?: any, opts?: {}) => Database;
+    static storage: (name?: any, opts?: {}) => Database$1;
     static fromJSON(json: any, database: any): any;
     static snapshot(database: any, clock: any): any;
     static zoom(database: any, clock: any): Promise<any>;
-    static makeCar(database: any, key: any): Promise<multiformats.BlockView<Uint8Array, 85, 18, 1>>;
 }
 
-export { Database, Fireproof, DbIndex as Index, Listener };
+export { Database$1 as Database, Fireproof, DbIndex as Index, Listener, Sync };