@fireproof/core 0.18.0 → 0.19.5-dev

package/dist/node/fireproof.d.ts

@@ -1,268 +0,0 @@
-import { Link, Block } from 'multiformats';
-import { EventLink } from '@web3-storage/pail/clock/api';
-import { Operation } from '@web3-storage/pail/crdt/api';
-import { DbMeta, CryptoOpts, StoreOpts, EncryptedBlockstore, TransactionMeta } from '@fireproof/encrypted-blockstore';
-import { ProllyNode as ProllyNode$1 } from 'prolly-trees/db-index';
-
-type ConfigOpts = {
-    public?: boolean;
-    meta?: DbMeta;
-    persistIndexes?: boolean;
-    autoCompact?: number;
-    crypto?: CryptoOpts;
-    store?: StoreOpts;
-};
-type ClockLink = EventLink<Operation>;
-type ClockHead = ClockLink[];
-type DocFragment = Uint8Array | string | number | boolean | null | AnyLink | DocFragment[] | {
-    [key: string]: DocFragment;
-};
-type DocRecord<T> = {
-    [K in keyof T]: DocFragment;
-};
-type DocFiles = Record<string, DocFileMeta | File>;
-type DocBase = {
-    _id?: string;
-    _files?: DocFiles;
-    _publicFiles?: DocFiles;
-};
-type Doc<T extends DocRecord<T> = {}> = DocBase & T;
-type DocFileMeta = {
-    type: string;
-    size: number;
-    cid: AnyLink;
-    car?: AnyLink;
-    url?: string;
-    file?: () => Promise<File>;
-};
-type DocUpdate = {
-    key: string;
-    value?: Record<string, any>;
-    del?: boolean;
-    clock?: AnyLink;
-};
-type DocValue = {
-    doc?: DocBase;
-    del?: boolean;
-    cid?: AnyLink;
-};
-type IndexKey = [string, string] | string;
-type IndexUpdate = {
-    key: IndexKey;
-    value?: DocFragment;
-    del?: boolean;
-};
-type IndexRow<T extends DocRecord<T> = {}> = {
-    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 IdxMetaMap = {
-    indexes: Map<string, IdxMeta>;
-};
-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 AnyBlock = {
-    cid: AnyLink;
-    bytes: Uint8Array;
-};
-type AnyDecodedBlock = {
-    cid: AnyLink;
-    bytes: Uint8Array;
-    value: any;
-};
-type EmitFn = (k: DocFragment, v?: DocFragment) => void;
-type MapFn = <T extends DocRecord<T> = {}>(doc: Doc<T>, emit: EmitFn) => DocFragment | void;
-type ChangesOptions = {
-    dirty?: boolean;
-    limit?: number;
-};
-type ChangesResponse<T extends DocRecord<T> = {}> = {
-    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<T> = {}>(): PromiseLike<{
-        [x: string]: any;
-        result: IndexRow<T>[];
-    }>;
-    getMany(removeIds: string[]): Promise<{
-        [x: string]: any;
-        result: IndexKey[];
-    }>;
-    range<T extends DocRecord<T> = {}>(a: IndexKey, b: IndexKey): Promise<{
-        result: IndexRow<T>[];
-    }>;
-    get<T extends DocRecord<T> = {}>(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 DocRecord<T> = {}>(name: string, mapFn?: MapFn, meta?: IdxMeta): void;
-    query<T extends DocRecord<T> = {}>(opts?: QueryOpts): Promise<{
-        rows: IndexRow<T>[];
-    }>;
-    _resetIndex(): void;
-    _hydrateIndex(): Promise<void>;
-    _updateIndex(): Promise<TransactionMeta>;
-}
-
-type ApplyHeadTask = {
-    newHead: ClockHead;
-    prevHead: ClockHead;
-    updates: DocUpdate[] | null;
-};
-type ApplyHeadQueue = {
-    push(task: ApplyHeadTask): AsyncGenerator<{
-        updates: DocUpdate[];
-        all: boolean;
-    }, void, unknown>;
-    size(): number;
-};
-
-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, localUpdates: boolean): 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[]): Promise<CRDTMeta>;
-    allDocs(): Promise<{
-        result: DocUpdate[];
-        head: ClockHead;
-    }>;
-    vis(): Promise<string>;
-    getBlock(cidString: string): Promise<Block>;
-    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<T> = {}>(id: string): Promise<Doc<T>>;
-    put<T extends DocRecord<T> = {}>(doc: Doc<T>): Promise<DbResponse>;
-    del(id: string): Promise<DbResponse>;
-    changes<T extends DocRecord<T> = {}>(since?: ClockHead, opts?: ChangesOptions): Promise<ChangesResponse<T>>;
-    allDocs<T extends DocRecord<T> = {}>(): Promise<{
-        rows: {
-            key: string;
-            value: Doc<T>;
-        }[];
-        clock: ClockHead;
-    }>;
-    allDocuments<T extends DocRecord<T> = {}>(): Promise<{
-        rows: {
-            key: string;
-            value: Doc<T>;
-        }[];
-        clock: ClockHead;
-    }>;
-    subscribe(listener: ListenerFn | NoUpdateListenerFn, updates?: boolean): () => void;
-    query<T extends DocRecord<T> = {}>(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<T>>(docs: Doc<T>[]) => Promise<void> | void;
-type NoUpdateListenerFn = () => Promise<void> | void;
-type ListenerFn = UpdateListenerFn | NoUpdateListenerFn;
-declare function fireproof(name: string, opts?: ConfigOpts): Database;
-
-export { type AnyBlock, type AnyDecodedBlock, type AnyLink, type CRDTMeta, type ChangesOptions, type ChangesResponse, type ClockHead, type ClockLink, type ConfigOpts, Database, type DbResponse, type Doc, type DocBase, type DocFileMeta, type DocFiles, type DocFragment, type DocRecord, type DocUpdate, type DocValue, type IdxMeta, type IdxMetaMap, type IndexKey, type IndexRow, type IndexUpdate, type MapFn, type QueryOpts, fireproof };
-declare module '@fireproof/core'