@fireproof/core 0.5.7 → 0.5.8

package/dist/src/fireproof.d.ts

@@ -1,101 +1,6 @@
 import * as multiformats from 'multiformats';
 import { CID } from 'multiformats';
 
-/**
- * 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, name: 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<any>;
-    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<any>;
-}
-/**
- * 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.
@@ -111,12 +16,14 @@ type ChangeEvent = {
 declare class Database$1 {
     constructor(blocks: any, clock: any, config?: {});
     listeners: Set<any>;
+    indexes: Map<any, any>;
+    rootCache: any;
+    eventsCache: Map<any, any>;
     name: any;
     instanceId: string;
     blocks: any;
     clock: any;
     config: {};
-    indexes: Map<any, any>;
     /**
      * Renders the Fireproof instance as a JSON object.
      * @returns {Object} - The JSON representation of the Fireproof instance. Includes clock heads for the database and its indexes.
@@ -265,16 +172,8 @@ declare class Database$1 {
         result?: undefined;
     }, unknown>;
     visTree(): Promise<{
-        cids: any;
-        result: any; /**
-        //    * Advances the clock to the specified event and updates the root CID
-        //    *   Will be used by replication
-        //    */
-        vis?: undefined;
-    } | {
         vis: string;
         cids: any;
-        result?: undefined;
     }>;
     visClock(): Promise<{
         vis: string;
@@ -292,6 +191,112 @@ declare class Database$1 {
     setRemoteBlockReader(remoteBlockReaderFn: any): void;
 }
 
+/**
+ * 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;
+    /**
+     * @param {Database} database
+     */
+    constructor(database: Database$1, name: any, mapFn: any, clock?: any, opts?: {});
+    database: Database$1;
+    mapFnString: any;
+    mapFn: any;
+    name: any;
+    indexById: {
+        root: any;
+        cid: any;
+    };
+    indexByKey: {
+        root: any;
+        cid: any;
+    };
+    dbHead: any;
+    instanceId: string;
+    updateIndexPromise: Promise<any>;
+    makeName(): any;
+    toJSON(): {
+        name: any;
+        code: any;
+        clock: {
+            db: any;
+            byId: any;
+            byKey: any;
+        };
+    };
+    visKeyTree(): Promise<{
+        vis: string;
+        cids: any;
+    }>;
+    visIdTree(): Promise<{
+        vis: string;
+        cids: 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<any>;
+}
+/**
+ * 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.
  *