@fireproof/core 0.6.4 → 0.7.0-alpha.0

package/dist/src/fireproof.d.ts

@@ -1,67 +1,73 @@
 import * as multiformats from 'multiformats';
 import { Link, CID } from 'multiformats';
-import * as multiformats_cid from 'multiformats/cid';
+import * as multiformats_link from 'multiformats/link';
+import * as _ipld_car_dist_src_api_js from '@ipld/car/dist/src/api.js';
+import * as idb from 'idb';
 
 type AnyLink = Link<unknown, number, number, 1|0>
 
-declare class Valet {
-    constructor(name: string, keyMaterial: any);
-    idb: any;
-    name: any;
-    uploadQueue: any;
-    alreadyEnqueued: Set<any>;
+declare class Base {
+    constructor(name: any, config?: {});
+    valetRootCarCid: any;
     keyMaterial: any;
     keyId: string;
-    valetRoot: any;
-    valetRootCid: any;
-    valetRootCarCid: any;
-    valetCidBlocks: VMemoryBlockstore;
     instanceId: string;
-    /**
-     * Function installed by the database to upload car files
-     * @type {null|function(string, Uint8Array):Promise<void>}
-     */
-    uploadFunction: null | ((arg0: string, arg1: Uint8Array) => Promise<void>);
-    getKeyMaterial(): any;
+    name: any;
+    config: {};
+    ready: Promise<{}>;
+    setCarCidMapCarCid(carCid: any): void;
+    valetCarCidMap: Map<any, any>;
     setKeyMaterial(km: any): void;
-    /**
-     * Group the blocks into a car and write it to the valet.
-     * @param {import('./blockstore.js').InnerBlockstore} innerBlockstore
-     * @param {Set<string>} cids
-     * @returns {Promise<void>}
-     * @memberof Valet
-     */
-    writeTransaction(innerBlockstore: InnerBlockstore, cids: Set<string>): Promise<void>;
-    withDB: (dbWorkFun: any) => Promise<any>;
-    /**
-     * Iterate over all blocks in the store.
-     *
-     * @yields {{cid: string, value: Uint8Array}}
-     * @returns {AsyncGenerator<any, any, any>}
-     */
-    cids(): AsyncGenerator<any, any, any>;
-    setRootCarCid(cid: any): void;
+    saveCar(carCid: any, value: any, cids: any): Promise<multiformats.BlockView<Uint8Array, 85, 18, 1>>;
+    applyHeaders(headers: any): void;
+    headers: any;
+    getHeaders(): Promise<{}>;
+    loadHeader(branch?: string): void;
+    saveHeader(header: any): Promise<void>;
+    prepareHeader(header: any, json?: boolean): any;
+    writeHeader(branch: any, header: any): void;
     getCarCIDForCID(cid: any): Promise<{
         result: any;
     }>;
-    getCombinedReader(carCid: any): Promise<{
+    readCar(carCid: any): Promise<Uint8Array>;
+    getLoaderBlock(dataCID: any): Promise<{
+        block: any;
+        reader: {
+            entries: () => Generator<any, void, unknown>;
+            root: any;
+            gat: (dataCID: any) => Promise<any>;
+            get: (dataCID: any) => Promise<any>;
+        } | {
+            entries: any;
+            root: any;
+            gat: (dataCID: any) => Promise<_ipld_car_dist_src_api_js.Block>;
+            get: (dataCID: any) => Promise<Uint8Array>;
+        };
+        carCid: any;
+    }>;
+    /** Private - internal **/
+    getCidCarMap(): Promise<Map<any, any>>;
+    mapForIPLDHashmapCarCid(carCid: any): Promise<Map<any, any>>;
+    getWriteableCarReader(carCid: any): Promise<{
+        blocks: VMemoryBlockstore;
         root: any;
         put: (cid: any, bytes: any) => Promise<void>;
         get: (cid: any) => Promise<any>;
     }>;
-    /**
-     *
-     * @param {string} carCid
-     * @param {*} value
-     */
-    parkCar(carCid: string, value: any, cids: any): Promise<void>;
-    writeCars(cars: any): Promise<any>;
-    remoteBlockFunction: any;
     getCarReader(carCid: any): Promise<{
+        entries: () => Generator<any, void, unknown>;
         root: any;
+        gat: (dataCID: any) => Promise<any>;
         get: (dataCID: any) => Promise<any>;
+    } | {
+        entries: any;
+        root: any;
+        gat: (dataCID: any) => Promise<_ipld_car_dist_src_api_js.Block>;
+        get: (dataCID: any) => Promise<Uint8Array>;
     }>;
-    getValetBlock(dataCID: any): Promise<any>;
+    writeCars(cars: any): void;
+    updateCarCidMap(carCid: any, cids: any): Promise<multiformats.BlockView<Uint8Array, 85, 18, 1>>;
+    persistCarMap(theCarMap: any): Promise<multiformats.BlockView<Uint8Array, 85, 18, 1>>;
 }
 declare class VMemoryBlockstore {
     /** @type {Map<string, Uint8Array>} */
@@ -72,16 +78,72 @@ declare class VMemoryBlockstore {
         bytes: Uint8Array;
     }>;
     /**
-     * @param {import('../src/link').AnyLink} cid
+     * @param {any} cid
      * @param {Uint8Array} bytes
      */
-    put(cid: AnyLink, bytes: Uint8Array): Promise<void>;
+    put(cid: any, bytes: Uint8Array): Promise<void>;
     entries(): Generator<{
-        cid: multiformats_cid.Link<unknown, number, number, multiformats_cid.Version>;
+        cid: multiformats_link.Link<unknown, number, number, multiformats_link.Version>;
         bytes: Uint8Array;
     }, void, unknown>;
 }
 
+declare class Rest extends Base {
+    headerURL(branch?: string): string;
+    writeCars(cars: any): Promise<void>;
+    loadHeader(branch?: string): Promise<unknown>;
+    writeHeader(branch: any, header: any): Promise<void>;
+}
+
+declare class Filesystem extends Base {
+    writeCars(cars: any): Promise<void>;
+    readCar(carCid: any): Promise<any>;
+    loadHeader(branch?: string): any;
+    writeHeader(branch: any, header: any): Promise<void>;
+    headerFilename(branch?: string): any;
+}
+
+declare class Browser extends Base {
+    isBrowser: boolean;
+    withDB: (dbWorkFun: any) => Promise<any>;
+    idb: idb.IDBPDatabase<unknown>;
+    writeCars(cars: any): Promise<any>;
+    readCar(carCid: any): Promise<any>;
+    loadHeader(branch?: string): string;
+    writeHeader(branch: any, header: any): Promise<void>;
+    headerKey(branch?: string): string;
+}
+
+declare class Valet {
+    constructor(name?: string, config?: {});
+    idb: any;
+    name: any;
+    uploadQueue: any;
+    alreadyEnqueued: Set<any>;
+    instanceId: string;
+    primary: Browser | Filesystem | Rest;
+    secondary: Browser | Filesystem | Rest;
+    ready: Promise<{}[]>;
+    saveHeader(header: any): Promise<void>;
+    /**
+     * Group the blocks into a car and write it to the valet.
+     * @param {import('./blockstore.js').InnerBlockstore} innerBlockstore
+     * @param {Set<string>} cids
+     * @returns {Promise<void>}
+     * @memberof Valet
+     */
+    writeTransaction(innerBlockstore: InnerBlockstore, cids: Set<string>): Promise<void>;
+    /**
+     * Iterate over all blocks in the store.
+     *
+     * @yields {{cid: string, value: Uint8Array}}
+     * @returns {AsyncGenerator<any, any, any>}
+     */
+    cids(): AsyncGenerator<any, any, any>;
+    remoteBlockFunction: any;
+    getValetBlock(dataCID: any): Promise<any>;
+}
+
 /**
  * @typedef {{ get: (link: import('../src/link').AnyLink) => Promise<AnyBlock | undefined> }} BlockFetcher
  */
@@ -97,7 +159,7 @@ declare class VMemoryBlockstore {
  * A blockstore that caches writes to a transaction and only persists them when committed.
 */
 declare class TransactionBlockstore {
-    constructor(name: any, encryptionKey: any);
+    constructor(name: any, config: any);
     /** @type {Map<string, Uint8Array>} */
     committedBlocks: Map<string, Uint8Array>;
     /** @type {Valet} */
@@ -105,6 +167,7 @@ declare class TransactionBlockstore {
     instanceId: string;
     inflightTransactions: Set<any>;
     syncs: Set<any>;
+    ready: Promise<void> | Promise<{}[]>;
     remoteBlockFunction: any;
     /**
      * Get a block from the store.
@@ -201,17 +264,18 @@ type AnyBlock = {
  *
  */
 declare class Database {
-    constructor(name: any, clock: any, config?: {});
+    constructor(name: any, config?: {});
     listeners: Set<any>;
     indexes: Map<any, any>;
     rootCache: any;
     eventsCache: Map<any, any>;
     name: any;
+    clock: any[];
     instanceId: string;
     blocks: TransactionBlockstore;
     indexBlocks: TransactionBlockstore;
-    clock: any;
     config: {};
+    ready: Promise<void>;
     /**
      * 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.
@@ -219,6 +283,15 @@ declare class Database {
      * @instance
      */
     toJSON(): any;
+    toHeader(): {
+        clock: string[];
+        name: any;
+        index: {
+            key: any;
+            car: any;
+        };
+        indexes: any[];
+    };
     /**
      * Returns the Merkle clock heads for the Fireproof instance.
      * @returns {string[]} - The Merkle clock heads for the Fireproof instance.
@@ -226,13 +299,6 @@ declare class Database {
      * @instance
      */
     clockToJSON(clock?: any): string[];
-    hydrate({ clock, name, key, car, indexCar }: {
-        clock: any;
-        name: any;
-        key: any;
-        car: any;
-        indexCar: any;
-    }): void;
     maybeSaveClock(): void;
     index(name: any): any;
     /**
@@ -266,16 +332,6 @@ declare class Database {
     }>;
     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.
-     *
-     * @param {Object} doc - The document to validate.
-     * @returns {Promise<void>}
-     * @throws {Error} - Throws an error if the document is invalid.
-     * @memberof Fireproof
-     * @instance
-     */
-    runValidation(doc: any): Promise<void>;
     /**
      * Retrieves the document with the specified ID from the database
      *
@@ -318,6 +374,16 @@ declare class Database {
         id: string;
         clock: CID[];
     }>;
+    /**
+     * Runs validation on the specified document using the Fireproof instance's configuration. Throws an error if the document is invalid.
+     *
+     * @param {Object} doc - The document to validate.
+     * @returns {Promise<void>}
+     * @throws {Error} - Throws an error if the document is invalid.
+     * @memberof Fireproof
+     * @instance
+     */
+    runValidation(doc: any): Promise<void>;
     /**
      * Updates the underlying storage with the specified event.
      * @private
@@ -358,7 +424,6 @@ declare class Database {
      */
     registerListener(listener: Function): Function;
     notifyListeners(changes: any): Promise<void>;
-    setCarUploader(carUploaderFn: any): void;
     setRemoteBlockReader(remoteBlockReaderFn: any): void;
 }
 
@@ -398,7 +463,7 @@ declare class DbIndex {
     applyMapFn(mapFn: any, name: any): void;
     mapFnString: any;
     mapFn: any;
-    includeDocsDefault: boolean;
+    includeDocsDefault: any;
     name: any;
     makeName(): any;
     toJSON(): {
@@ -461,69 +526,6 @@ declare class DbIndex {
     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.
- *
- * @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('./database.js').Database} database - The Database database instance to index.
- * @param {Function} routingFn - The routing function to apply to each entry in the database.
- */
-/**
- * @deprecated since version 0.7.0
- */
-declare class Listener {
-    /**
-     * @param {import('./database.js').Database} database
-     * @param {(_: any, emit: any) => void} routingFn
-     */
-    constructor(database: Database, routingFn?: (_: any, emit: any) => void);
-    subcribers: Map<any, any>;
-    doStopListening: any;
-    database: Database;
-    /**
-     * The map function to apply to each entry in the database.
-     * @type {Function}
-     */
-    routingFn: Function;
-    dbHead: any;
-    /**
-     * Subscribe to a topic emitted by the event function.
-     * @param {string} topic - The topic to subscribe to.
-     * @param {Function} subscriber - The function to call when the topic is emitted.
-     * @returns {Function} A function to unsubscribe from the topic.
-     * @memberof Listener
-     * @instance
-     * @param {any} [since] - clock to flush from on launch, pass null for all
-     */
-    on(topic: string, subscriber: Function, since?: any): Function;
-    /**
-     * @typedef {import('./db-index').ChangeEvent} ChangeEvent
-     */
-    /**
-     * @param {ChangeEvent[]} changes
-     */
-    onChanges(changes: ChangeEvent[]): void;
-}
 
 /**
  * @typedef {import('./database.js').Database} Database
@@ -567,13 +569,12 @@ declare class 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
+     * @returns {Database|Promise<Database>} - a new Fireproof instance or a promise for remote loaders
      */
-    static storage: (name?: any, opts?: {}) => Database;
-    static fromConfig(name: any, existingConfig: any, opts?: {}): any;
-    static fromJSON(json: any, database: any): any;
+    static storage: (name?: any, opts?: {}) => Database | Promise<Database>;
+    static fromJSON(primary: any, secondary: any, database: any): any;
     static snapshot(database: any, clock: any): any;
     static zoom(database: any, clock: any): Promise<any>;
 }
 
-export { Database, Fireproof, DbIndex as Index, Listener, Sync };
+export { Database, Fireproof, DbIndex as Index, Sync };