@fireproof/core 0.16.1 → 0.16.4

package/dist/node/fireproof.d.cts

@@ -0,0 +1,286 @@
+import { Link, Block } from 'multiformats';
+import { EventLink } from '@alanshaw/pail/clock';
+import { EventData } from '@alanshaw/pail/crdt';
+import * as _fireproof_encrypted_blockstore from '@fireproof/encrypted-blockstore';
+import { DbMeta, EncryptedBlockstore } from '@fireproof/encrypted-blockstore';
+import * as multiformats_dist_types_src_block from 'multiformats/dist/types/src/block';
+import { ProllyNode as ProllyNode$1 } from 'prolly-trees/base';
+
+type ConfigOpts = {
+    public?: boolean;
+    meta?: DbMeta;
+    persistIndexes?: boolean;
+    autoCompact?: number;
+};
+type ClockLink = EventLink<EventData>;
+type ClockHead = ClockLink[];
+type DocFragment = Uint8Array | string | number | boolean | null | AnyLink | DocFragment[] | {
+    [key: string]: DocFragment;
+};
+type DocRecord = Record<string, DocFragment>;
+type Doc<T extends DocRecord = {}> = DocBase & DocBody<T>;
+type DocBase = {
+    _id?: string;
+    _files?: DocFiles;
+    _publicFiles?: DocFiles;
+};
+type DocFileMeta = {
+    type: string;
+    size: number;
+    cid: AnyLink;
+    car?: AnyLink;
+    url?: string;
+    file?: () => Promise<File>;
+};
+type DocFiles = Record<string, DocFileMeta | File>;
+type DocBody<T extends DocRecord = {}> = {
+    _id?: string;
+} & {
+    [K in Exclude<keyof T, keyof DocBase>]: DocFragment;
+} & T;
+type DocUpdate = {
+    key: string;
+    value?: Record<string, any>;
+    del?: boolean;
+    clock?: AnyLink;
+};
+type DocValue = {
+    doc?: DocBase;
+    del?: boolean;
+};
+type IndexKey = [string, string] | string;
+type IndexUpdate = {
+    key: IndexKey;
+    value?: DocFragment;
+    del?: boolean;
+};
+type IndexRow<T extends DocRecord = {}> = {
+    id: string;
+    key: IndexKey;
+    row?: DocFragment;
+    doc?: Doc<T> | null;
+    value?: DocFragment;
+    del?: boolean;
+};
+type CRDTMeta = {
+    head: ClockHead;
+};
+type IdxMeta = {
+    byId: AnyLink;
+    byKey: AnyLink;
+    map: string;
+    name: string;
+    head: ClockHead;
+};
+type QueryOpts = {
+    descending?: boolean;
+    limit?: number;
+    includeDocs?: boolean;
+    range?: [IndexKey, IndexKey];
+    key?: DocFragment;
+    keys?: DocFragment[];
+    prefix?: DocFragment | [DocFragment];
+};
+type AnyLink = Link<unknown, number, number, 1 | 0>;
+type EmitFn = (k: DocFragment, v?: DocFragment) => void;
+type MapFn = <T extends DocRecord = {}>(doc: Doc<T>, emit: EmitFn) => DocFragment | void;
+type ChangesOptions = {
+    dirty?: boolean;
+    limit?: number;
+};
+type ChangesResponse<T extends DocRecord = {}> = {
+    clock: ClockHead;
+    rows: {
+        key: string;
+        value: Doc<T>;
+    }[];
+};
+type DbResponse = {
+    id: string;
+    clock: ClockHead;
+};
+
+type WriteQueue = {
+    push(task: DocUpdate): Promise<CRDTMeta>;
+};
+
+declare class IndexTree {
+    cid: AnyLink | null;
+    root: ProllyNode | null;
+}
+interface ProllyNode extends ProllyNode$1 {
+    getAllEntries<T extends DocRecord = {}>(): PromiseLike<{
+        [x: string]: any;
+        result: IndexRow<T>[];
+    }>;
+    getMany(removeIds: string[]): Promise<{
+        [x: string]: any;
+        result: IndexKey[];
+    }>;
+    range<T extends DocRecord = {}>(a: IndexKey, b: IndexKey): Promise<{
+        result: IndexRow<T>[];
+    }>;
+    get<T extends DocRecord = {}>(key: string): Promise<{
+        result: IndexRow<T>[];
+    }>;
+    bulk(bulk: IndexUpdate[]): PromiseLike<{
+        root: ProllyNode | null;
+        blocks: Block[];
+    }>;
+    address: Promise<Link>;
+    distance: number;
+    compare: (a: any, b: any) => number;
+    cache: any;
+    block: Promise<Block>;
+}
+
+declare class Index {
+    blockstore: EncryptedBlockstore;
+    crdt: CRDT;
+    name: string | null;
+    mapFn: MapFn | null;
+    mapFnString: string;
+    byKey: IndexTree;
+    byId: IndexTree;
+    indexHead: ClockHead | undefined;
+    includeDocsDefault: boolean;
+    initError: Error | null;
+    ready: Promise<void>;
+    constructor(crdt: CRDT, name: string, mapFn?: MapFn, meta?: IdxMeta);
+    applyMapFn<T extends Record<string, any> = {}>(name: string, mapFn?: MapFn, meta?: IdxMeta): void;
+    query<T extends DocRecord = {}>(opts?: QueryOpts): Promise<{
+        rows: IndexRow<T>[];
+    }>;
+    _resetIndex(): void;
+    _hydrateIndex(): Promise<void>;
+    _updateIndex(): Promise<{
+        [x: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null;
+    } | {
+        byId: IndexTree;
+        byKey: IndexTree;
+    }>;
+}
+
+type ApplyHeadTask = {
+    newHead: ClockHead;
+    prevHead: ClockHead;
+    updates: DocUpdate[] | null;
+};
+type ApplyHeadQueue = {
+    push(task: ApplyHeadTask): AsyncGenerator<{
+        updates: DocUpdate[];
+        all: boolean;
+    }, void, unknown>;
+};
+
+declare class CRDTClock {
+    head: ClockHead;
+    zoomers: Set<() => void>;
+    watchers: Set<(updates: DocUpdate[]) => void>;
+    emptyWatchers: Set<() => void>;
+    blockstore: EncryptedBlockstore | null;
+    applyHeadQueue: ApplyHeadQueue;
+    constructor();
+    setHead(head: ClockHead): void;
+    applyHead(newHead: ClockHead, prevHead: ClockHead, updates?: DocUpdate[] | null): Promise<void>;
+    processUpdates(updatesAcc: DocUpdate[], all: boolean, prevHead: ClockHead): Promise<void>;
+    notifyWatchers(updates: DocUpdate[]): void;
+    onTick(fn: (updates: DocUpdate[]) => void): void;
+    onTock(fn: () => void): void;
+    onZoom(fn: () => void): void;
+    int_applyHead(newHead: ClockHead, prevHead: ClockHead): Promise<void>;
+}
+
+declare class CRDT {
+    name: string | null;
+    opts: ConfigOpts;
+    ready: Promise<void>;
+    blockstore: EncryptedBlockstore;
+    indexBlockstore: EncryptedBlockstore;
+    indexers: Map<string, Index>;
+    clock: CRDTClock;
+    constructor(name?: string, opts?: ConfigOpts);
+    bulk(updates: DocUpdate[], options?: object): Promise<CRDTMeta>;
+    allDocs(): Promise<{
+        result: DocUpdate[];
+        head: ClockHead;
+    }>;
+    vis(): Promise<string>;
+    getBlock(cidString: string): Promise<multiformats_dist_types_src_block.Block<unknown, 113, 18, 1>>;
+    get(key: string): Promise<DocValue | null>;
+    changes(since?: ClockHead, opts?: ChangesOptions): Promise<{
+        result: DocUpdate[];
+        head: ClockHead;
+    }>;
+    compact(): Promise<void>;
+}
+
+type DbName = string | null;
+declare class Database {
+    static databases: Map<string, Database>;
+    name: DbName;
+    opts: ConfigOpts;
+    _listening: boolean;
+    _listeners: Set<ListenerFn>;
+    _noupdate_listeners: Set<ListenerFn>;
+    _crdt: CRDT;
+    _writeQueue: WriteQueue;
+    blockstore: EncryptedBlockstore;
+    constructor(name?: string, opts?: ConfigOpts);
+    get<T extends DocRecord = {}>(id: string): Promise<Doc<T>>;
+    put<T extends DocRecord = {}>(doc: Doc<T>): Promise<DbResponse>;
+    del(id: string): Promise<DbResponse>;
+    changes<T extends DocRecord = {}>(since?: ClockHead, opts?: ChangesOptions): Promise<ChangesResponse<T>>;
+    allDocs<T extends DocRecord = {}>(): Promise<{
+        rows: {
+            key: string;
+            value: Doc<T>;
+        }[];
+        clock: ClockHead;
+    }>;
+    allDocuments<T extends DocRecord = {}>(): Promise<{
+        rows: {
+            key: string;
+            value: Doc<T>;
+        }[];
+        clock: ClockHead;
+    }>;
+    subscribe(listener: ListenerFn | NoUpdateListenerFn, updates?: boolean): () => void;
+    query<T extends DocRecord = {}>(field: string | MapFn, opts?: QueryOpts): Promise<{
+        rows: IndexRow<T>[];
+    }>;
+    compact(): Promise<void>;
+    _notify(updates: DocUpdate[]): Promise<void>;
+    _no_update_notify(): Promise<void>;
+}
+type UpdateListenerFn = <T extends DocRecord = {}>(docs: Doc<T>[]) => Promise<void> | void;
+type NoUpdateListenerFn = () => Promise<void> | void;
+type ListenerFn = UpdateListenerFn | NoUpdateListenerFn;
+declare function fireproof(name: string, opts?: ConfigOpts): Database;
+
+export { Database, fireproof };
+declare module '@fireproof/core'

package/dist/node/fireproof.d.ts

@@ -0,0 +1,286 @@
+import { Link, Block } from 'multiformats';
+import { EventLink } from '@alanshaw/pail/clock';
+import { EventData } from '@alanshaw/pail/crdt';
+import * as _fireproof_encrypted_blockstore from '@fireproof/encrypted-blockstore';
+import { DbMeta, EncryptedBlockstore } from '@fireproof/encrypted-blockstore';
+import * as multiformats_dist_types_src_block from 'multiformats/dist/types/src/block';
+import { ProllyNode as ProllyNode$1 } from 'prolly-trees/base';
+
+type ConfigOpts = {
+    public?: boolean;
+    meta?: DbMeta;
+    persistIndexes?: boolean;
+    autoCompact?: number;
+};
+type ClockLink = EventLink<EventData>;
+type ClockHead = ClockLink[];
+type DocFragment = Uint8Array | string | number | boolean | null | AnyLink | DocFragment[] | {
+    [key: string]: DocFragment;
+};
+type DocRecord = Record<string, DocFragment>;
+type Doc<T extends DocRecord = {}> = DocBase & DocBody<T>;
+type DocBase = {
+    _id?: string;
+    _files?: DocFiles;
+    _publicFiles?: DocFiles;
+};
+type DocFileMeta = {
+    type: string;
+    size: number;
+    cid: AnyLink;
+    car?: AnyLink;
+    url?: string;
+    file?: () => Promise<File>;
+};
+type DocFiles = Record<string, DocFileMeta | File>;
+type DocBody<T extends DocRecord = {}> = {
+    _id?: string;
+} & {
+    [K in Exclude<keyof T, keyof DocBase>]: DocFragment;
+} & T;
+type DocUpdate = {
+    key: string;
+    value?: Record<string, any>;
+    del?: boolean;
+    clock?: AnyLink;
+};
+type DocValue = {
+    doc?: DocBase;
+    del?: boolean;
+};
+type IndexKey = [string, string] | string;
+type IndexUpdate = {
+    key: IndexKey;
+    value?: DocFragment;
+    del?: boolean;
+};
+type IndexRow<T extends DocRecord = {}> = {
+    id: string;
+    key: IndexKey;
+    row?: DocFragment;
+    doc?: Doc<T> | null;
+    value?: DocFragment;
+    del?: boolean;
+};
+type CRDTMeta = {
+    head: ClockHead;
+};
+type IdxMeta = {
+    byId: AnyLink;
+    byKey: AnyLink;
+    map: string;
+    name: string;
+    head: ClockHead;
+};
+type QueryOpts = {
+    descending?: boolean;
+    limit?: number;
+    includeDocs?: boolean;
+    range?: [IndexKey, IndexKey];
+    key?: DocFragment;
+    keys?: DocFragment[];
+    prefix?: DocFragment | [DocFragment];
+};
+type AnyLink = Link<unknown, number, number, 1 | 0>;
+type EmitFn = (k: DocFragment, v?: DocFragment) => void;
+type MapFn = <T extends DocRecord = {}>(doc: Doc<T>, emit: EmitFn) => DocFragment | void;
+type ChangesOptions = {
+    dirty?: boolean;
+    limit?: number;
+};
+type ChangesResponse<T extends DocRecord = {}> = {
+    clock: ClockHead;
+    rows: {
+        key: string;
+        value: Doc<T>;
+    }[];
+};
+type DbResponse = {
+    id: string;
+    clock: ClockHead;
+};
+
+type WriteQueue = {
+    push(task: DocUpdate): Promise<CRDTMeta>;
+};
+
+declare class IndexTree {
+    cid: AnyLink | null;
+    root: ProllyNode | null;
+}
+interface ProllyNode extends ProllyNode$1 {
+    getAllEntries<T extends DocRecord = {}>(): PromiseLike<{
+        [x: string]: any;
+        result: IndexRow<T>[];
+    }>;
+    getMany(removeIds: string[]): Promise<{
+        [x: string]: any;
+        result: IndexKey[];
+    }>;
+    range<T extends DocRecord = {}>(a: IndexKey, b: IndexKey): Promise<{
+        result: IndexRow<T>[];
+    }>;
+    get<T extends DocRecord = {}>(key: string): Promise<{
+        result: IndexRow<T>[];
+    }>;
+    bulk(bulk: IndexUpdate[]): PromiseLike<{
+        root: ProllyNode | null;
+        blocks: Block[];
+    }>;
+    address: Promise<Link>;
+    distance: number;
+    compare: (a: any, b: any) => number;
+    cache: any;
+    block: Promise<Block>;
+}
+
+declare class Index {
+    blockstore: EncryptedBlockstore;
+    crdt: CRDT;
+    name: string | null;
+    mapFn: MapFn | null;
+    mapFnString: string;
+    byKey: IndexTree;
+    byId: IndexTree;
+    indexHead: ClockHead | undefined;
+    includeDocsDefault: boolean;
+    initError: Error | null;
+    ready: Promise<void>;
+    constructor(crdt: CRDT, name: string, mapFn?: MapFn, meta?: IdxMeta);
+    applyMapFn<T extends Record<string, any> = {}>(name: string, mapFn?: MapFn, meta?: IdxMeta): void;
+    query<T extends DocRecord = {}>(opts?: QueryOpts): Promise<{
+        rows: IndexRow<T>[];
+    }>;
+    _resetIndex(): void;
+    _hydrateIndex(): Promise<void>;
+    _updateIndex(): Promise<{
+        [x: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | (string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null)[] | {
+            [key: string]: string | number | boolean | Uint8Array | _fireproof_encrypted_blockstore.AnyLink | any | any | null;
+        } | null;
+    } | {
+        byId: IndexTree;
+        byKey: IndexTree;
+    }>;
+}
+
+type ApplyHeadTask = {
+    newHead: ClockHead;
+    prevHead: ClockHead;
+    updates: DocUpdate[] | null;
+};
+type ApplyHeadQueue = {
+    push(task: ApplyHeadTask): AsyncGenerator<{
+        updates: DocUpdate[];
+        all: boolean;
+    }, void, unknown>;
+};
+
+declare class CRDTClock {
+    head: ClockHead;
+    zoomers: Set<() => void>;
+    watchers: Set<(updates: DocUpdate[]) => void>;
+    emptyWatchers: Set<() => void>;
+    blockstore: EncryptedBlockstore | null;
+    applyHeadQueue: ApplyHeadQueue;
+    constructor();
+    setHead(head: ClockHead): void;
+    applyHead(newHead: ClockHead, prevHead: ClockHead, updates?: DocUpdate[] | null): Promise<void>;
+    processUpdates(updatesAcc: DocUpdate[], all: boolean, prevHead: ClockHead): Promise<void>;
+    notifyWatchers(updates: DocUpdate[]): void;
+    onTick(fn: (updates: DocUpdate[]) => void): void;
+    onTock(fn: () => void): void;
+    onZoom(fn: () => void): void;
+    int_applyHead(newHead: ClockHead, prevHead: ClockHead): Promise<void>;
+}
+
+declare class CRDT {
+    name: string | null;
+    opts: ConfigOpts;
+    ready: Promise<void>;
+    blockstore: EncryptedBlockstore;
+    indexBlockstore: EncryptedBlockstore;
+    indexers: Map<string, Index>;
+    clock: CRDTClock;
+    constructor(name?: string, opts?: ConfigOpts);
+    bulk(updates: DocUpdate[], options?: object): Promise<CRDTMeta>;
+    allDocs(): Promise<{
+        result: DocUpdate[];
+        head: ClockHead;
+    }>;
+    vis(): Promise<string>;
+    getBlock(cidString: string): Promise<multiformats_dist_types_src_block.Block<unknown, 113, 18, 1>>;
+    get(key: string): Promise<DocValue | null>;
+    changes(since?: ClockHead, opts?: ChangesOptions): Promise<{
+        result: DocUpdate[];
+        head: ClockHead;
+    }>;
+    compact(): Promise<void>;
+}
+
+type DbName = string | null;
+declare class Database {
+    static databases: Map<string, Database>;
+    name: DbName;
+    opts: ConfigOpts;
+    _listening: boolean;
+    _listeners: Set<ListenerFn>;
+    _noupdate_listeners: Set<ListenerFn>;
+    _crdt: CRDT;
+    _writeQueue: WriteQueue;
+    blockstore: EncryptedBlockstore;
+    constructor(name?: string, opts?: ConfigOpts);
+    get<T extends DocRecord = {}>(id: string): Promise<Doc<T>>;
+    put<T extends DocRecord = {}>(doc: Doc<T>): Promise<DbResponse>;
+    del(id: string): Promise<DbResponse>;
+    changes<T extends DocRecord = {}>(since?: ClockHead, opts?: ChangesOptions): Promise<ChangesResponse<T>>;
+    allDocs<T extends DocRecord = {}>(): Promise<{
+        rows: {
+            key: string;
+            value: Doc<T>;
+        }[];
+        clock: ClockHead;
+    }>;
+    allDocuments<T extends DocRecord = {}>(): Promise<{
+        rows: {
+            key: string;
+            value: Doc<T>;
+        }[];
+        clock: ClockHead;
+    }>;
+    subscribe(listener: ListenerFn | NoUpdateListenerFn, updates?: boolean): () => void;
+    query<T extends DocRecord = {}>(field: string | MapFn, opts?: QueryOpts): Promise<{
+        rows: IndexRow<T>[];
+    }>;
+    compact(): Promise<void>;
+    _notify(updates: DocUpdate[]): Promise<void>;
+    _no_update_notify(): Promise<void>;
+}
+type UpdateListenerFn = <T extends DocRecord = {}>(docs: Doc<T>[]) => Promise<void> | void;
+type NoUpdateListenerFn = () => Promise<void> | void;
+type ListenerFn = UpdateListenerFn | NoUpdateListenerFn;
+declare function fireproof(name: string, opts?: ConfigOpts): Database;
+
+export { Database, fireproof };
+declare module '@fireproof/core'