@fireproof/core 0.3.22 → 0.4.1

package/dist/src/{index.d.ts → fireproof.d.ts}

@@ -1,3 +1,98 @@
+/**
+ * Represents an DbIndex for a Fireproof database.
+ *
+ * @class DbIndex
+ * @classdesc An DbIndex can be used to order and filter the documents in a Fireproof database.
+ *
+ * @param {Database} database - The Fireproof database instance to DbIndex.
+ * @param {Function} mapFn - The map function to apply to each entry in the database.
+ *
+ */
+declare class DbIndex {
+    static registerWithDatabase(inIndex: any, database: any): void;
+    static fromJSON(database: any, { code, clock, name }: {
+        code: any;
+        clock: any;
+        name: any;
+    }): DbIndex;
+    constructor(database: any, mapFn: any, clock: any, opts?: {});
+    database: any;
+    mapFnString: any;
+    mapFn: any;
+    name: any;
+    indexById: {
+        root: any;
+        cid: any;
+    };
+    indexByKey: {
+        root: any;
+        cid: any;
+    };
+    dbHead: any;
+    instanceId: string;
+    updateIndexPromise: Promise<void>;
+    makeName(): any;
+    toJSON(): {
+        name: any;
+        code: any;
+        clock: {
+            db: any;
+            byId: any;
+            byKey: any;
+        };
+    };
+    /**
+     * JSDoc for Query type.
+     * @typedef {Object} DbQuery
+     * @property {string[]} [range] - The range to query.
+     * @memberof DbIndex
+     */
+    /**
+     * Query object can have {range}
+     * @param {DbQuery} query - the query range to use
+     * @returns {Promise<{proof: {}, rows: Array<{id: string, key: string, value: any}>}>}
+     * @memberof DbIndex
+     * @instance
+     */
+    query(query: {
+        /**
+         * - The range to query.
+         */
+        range?: string[];
+    }, update?: boolean): Promise<{
+        proof: {};
+        rows: Array<{
+            id: string;
+            key: string;
+            value: any;
+        }>;
+    }>;
+    /**
+     * Update the DbIndex with the latest changes
+     * @private
+     * @returns {Promise<void>}
+     */
+    private updateIndex;
+    innerUpdateIndex(inBlocks: any): Promise<void>;
+}
+/**
+ * JDoc for the result row type.
+ */
+type ChangeEvent = {
+    /**
+     * - The key of the document.
+     */
+    key: string;
+    /**
+     * - The new value of the document.
+     */
+    value: any;
+    /**
+     * - Is the row deleted?
+     */
+    del?: boolean;
+};
+
 /**
  * @class Fireproof
  * @classdesc Fireproof stores data in IndexedDB and provides a Merkle clock.
@@ -10,24 +105,14 @@
  * @param {object} [authCtx] - Optional authorization context object to use for any authentication checks.
  *
  */
-declare class Fireproof {
-    /**
-     * @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?: string) => Fireproof;
-    constructor(blocks: any, clock: any, config: any, authCtx?: {});
+declare class Database$1 {
+    constructor(blocks: any, clock: any, config?: {});
     listeners: Set<any>;
     name: any;
     instanceId: string;
     blocks: any;
     clock: any;
-    config: any;
-    authCtx: {};
+    config: {};
     indexes: Map<any, any>;
     /**
      * Renders the Fireproof instance as a JSON object.
@@ -49,6 +134,7 @@ declare class Fireproof {
         key: any;
     }): void;
     indexBlocks: any;
+    maybeSaveClock(): void;
     /**
      * Triggers a notification to all listeners
      * of the Fireproof instance so they can repaint UI, etc.
@@ -101,21 +187,46 @@ declare class Fireproof {
     get(key: string, opts?: any): Promise<{
         _id: string;
     }>;
+    /**
+   * @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
      */
     put({ _id, _proof, ...doc }: {
+        /**
+         * - The ID of the document (required)
+         */
         _id: string;
-        _clock: CID[];
-        _proof: Proof;
+        /**
+         * - 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<{
         id: string;
         clock: CID[];
@@ -171,103 +282,6 @@ declare class Fireproof {
     setCarUploader(carUploaderFn: any): void;
     setRemoteBlockReader(remoteBlockReaderFn: any): void;
 }
-declare class Proof {
-}
-
-/**
- * Represents an DbIndex for a Fireproof database.
- *
- * @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 {Function} mapFn - The map function to apply to each entry in the database.
- *
- */
-declare class DbIndex {
-    static registerWithDatabase(inIndex: any, database: any): void;
-    static fromJSON(database: any, { code, clock, name }: {
-        code: any;
-        clock: any;
-        name: any;
-    }): DbIndex;
-    constructor(database: any, mapFn: any, clock: any, opts?: {});
-    database: any;
-    mapFnString: any;
-    mapFn: any;
-    name: any;
-    indexById: {
-        root: any;
-        cid: any;
-    };
-    indexByKey: {
-        root: any;
-        cid: any;
-    };
-    dbHead: any;
-    instanceId: string;
-    updateIndexPromise: Promise<void>;
-    makeName(): any;
-    toJSON(): {
-        name: any;
-        code: any;
-        clock: {
-            db: any;
-            byId: any;
-            byKey: any;
-        };
-    };
-    /**
-     * JSDoc for Query type.
-     * @typedef {Object} DbQuery
-     * @property {string[]} [range] - The range to query.
-     * @memberof DbIndex
-     */
-    /**
-     * Query object can have {range}
-     * @param {DbQuery} query - the query range to use
-     * @returns {Promise<{proof: {}, rows: Array<{id: string, key: string, value: any}>}>}
-     * @memberof DbIndex
-     * @instance
-     */
-    query(query: {
-        /**
-         * - The range to query.
-         */
-        range?: string[];
-    }, update?: boolean): Promise<{
-        proof: {};
-        rows: Array<{
-            id: string;
-            key: string;
-            value: any;
-        }>;
-    }>;
-    /**
-     * Update the DbIndex with the latest changes
-     * @private
-     * @returns {Promise<void>}
-     */
-    private updateIndex;
-    innerUpdateIndex(inBlocks: any): Promise<void>;
-}
-/**
- * JDoc for the result row type.
- */
-type ChangeEvent = {
-    /**
-     * - The key of the document.
-     */
-    key: string;
-    /**
-     * - The new value of the document.
-     */
-    value: any;
-    /**
-     * - Is the row deleted?
-     */
-    del?: boolean;
-};
 
 /**
  * A Fireproof database Listener allows you to react to events in the database.
@@ -275,18 +289,18 @@ type ChangeEvent = {
  * @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 {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.
  */
 declare class Listener {
     /**
-     * @param {import('./fireproof.js').Fireproof} database
+     * @param {import('./database.js').Database} database
      * @param {(_: any, emit: any) => void} routingFn
      */
-    constructor(database: Fireproof, routingFn: (_: any, emit: any) => void);
+    constructor(database: Database$1, routingFn?: (_: any, emit: any) => void);
     subcribers: Map<any, any>;
     doStopListening: any;
-    database: Fireproof;
+    database: Database$1;
     /**
      * The map function to apply to each entry in the database.
      * @type {Function}
@@ -312,10 +326,19 @@ declare class Listener {
     onChanges(changes: ChangeEvent[]): void;
 }
 
-declare class Hydrator {
+declare class Fireproof {
+    /**
+     * @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
+     */
+    static storage: (name?: any, opts?: {}) => Database;
     static fromJSON(json: any, database: any): any;
     static snapshot(database: any, clock: any): any;
     static zoom(database: any, clock: any): Promise<any>;
 }
 
-export { Fireproof, Hydrator, DbIndex as Index, Listener };
+export { Fireproof, DbIndex as Index, Listener };