minimongo/lib/types.d.ts

Client-side mongo database with server sync over http

import { XHRError } from "./XHRError";
export interface MinimongoCollectionFindOptions {
    fields?: any;
    sort?: any;
    limit?: number;
    skip?: number;
    cacheFind?: boolean;
    /** Return interim results from local db while waiting for remote db. Return again if different. Only applicable to HybridDb
     * or a ReplicatingDb on top of a HybridDb. */
    interim?: boolean;
    /** Set to ms to timeout in for remote calls */
    timeout?: number;
    /** Cache findOne results in local db */
    cacheFindOne?: boolean;
    /** Use local results if the remote find fails. Only applies if interim is false. */
    useLocalOnRemoteError?: boolean;
    /** true to return `findOne` results if any matching result is found in the local database. Useful for documents that change rarely. */
    shortcut?: boolean;
    /** Only for RemoteDb.find */
    localData?: any[];
    /** Only for RemoteDb.find, Must be an mwater-expression */
    whereExpr?: any;
    /** Only for RemoteDb.find. expr must be an mwater-expression */
    orderByExprs?: {
        expr: any;
        dir: "asc" | "desc";
    }[];
}
export interface MinimongoCollectionFindOneOptions {
    fields?: any;
    sort?: any;
    limit?: number;
    skip?: number;
    interim?: boolean;
    cacheFindOne?: boolean;
    timeout?: number;
    shortcut?: boolean;
}
export interface MinimongoDb {
    localDb?: MinimongoLocalDb;
    remoteDb?: MinimongoDb;
    collections: {
        [collectionName: string]: MinimongoCollection;
    };
    addCollection<T>(name: string, options?: any, success?: () => void, error?: (err: any) => void): void;
    removeCollection<T>(name: string, success?: () => void, error?: (err: any) => void): void;
    getCollectionNames(): string[];
}
/** Local minimongo db which has local collections */
export interface MinimongoLocalDb extends MinimongoDb {
    collections: {
        [collectionName: string]: MinimongoLocalCollection;
    };
    addCollection<T>(name: string, options?: any, success?: (collection: MinimongoLocalCollection<T>) => void, error?: (err: any) => void): void;
}
export interface MinimongoBaseCollection<T = any> {
    name: string;
    find(selector: any, options?: MinimongoCollectionFindOptions): {
        fetch(success: (docs: T[]) => void, error: (err: any) => void): void;
        fetch(): Promise<T[]>;
    };
    findOne(selector: any, options?: MinimongoCollectionFindOneOptions): Promise<T | null>;
    findOne(selector: any, options: MinimongoCollectionFindOneOptions, success: (doc: T | null) => void, error: (err: any) => void): void;
    findOne(selector: any, success: (doc: T | null) => void, error: (err: any) => void): void;
    upsert(doc: T): Promise<T | null>;
    upsert(doc: T, base: T | null | undefined): Promise<T | null>;
    upsert(doc: T, success: (doc: T | null) => void, error: (err: any) => void): void;
    upsert(doc: T, base: T | null | undefined, success: (doc: T | null) => void, error: (err: any) => void): void;
    upsert(docs: T[], success: (docs: (T | null)[]) => void, error: (err: any) => void): void;
    upsert(docs: T[], bases: (T | null | undefined)[], success: (item: T | null) => void, error: (err: any) => void): void;
    remove(id: string): Promise<void>;
    remove(id: string, success: () => void, error: (err: any) => void): void;
}
export interface MinimongoLocalCollection<T = any> extends MinimongoBaseCollection<T> {
    cache(docs: T[], selector: any, options: any, success: () => void, error: (err: any) => void): void;
    pendingUpserts(success: (items: Item<T>[]) => void, error: (err: any) => void): void;
    pendingRemoves(success: (ids: string[]) => void, error: (err: any) => void): void;
    resolveUpserts(items: Item<T>[], success: () => void, error: (err: any) => void): void;
    resolveRemove(id: string, success: () => void, error: (err: any) => void): void;
    /** Add but do not overwrite or record as upsert */
    seed(docs: T[], success: () => void, error: (err: any) => void): void;
    /** Add but do not overwrite upserts or removes */
    cacheOne(doc: T, success: () => void, error: (err: any) => void): void;
    /** Add but do not overwrite upserts or removes */
    cacheList(docs: T[], success: () => void, error: (err: any) => void): void;
    uncache(selector: any, success: () => void, error: (err: any) => void): void;
    uncacheList(ids: string[], success: () => void, error: (err: any) => void): void;
}
/** Document base */
export interface Doc {
    _id?: string;
    _rev?: number;
}
/** Item with doc and optional base */
export interface Item<T> {
    doc: T;
    base?: T;
}
export type MinimongoCollection<T = any> = MinimongoBaseCollection<T> | MinimongoLocalCollection<T>;
/** Client for making http requests */
export type HttpClient = (method: "GET" | "PATCH" | "POST" | "DELETE", url: string, queryParams: any, data: any, success: (results: any) => void, error: (xhrError: XHRError) => void) => void;