typesaurus/types/batch.d.ts

Type-safe ODM for Firestore

import type { TypesaurusCore as Core } from "./core.js";
import type { TypesaurusUpdate as Update } from "./update.js";
export declare const batch: TypesaurusBatch.Function;
export declare namespace TypesaurusBatch {
    interface Function {
        <DB extends Core.DB<any>, Environment extends Core.RuntimeEnvironment, Props extends Core.DocProps & {
            environment: Environment;
        }>(db: DB, options?: Core.OperationOptions<Environment>): RootDB<DB, Props>;
    }
    type RootDB<DB extends Core.DB<any>, Props extends Core.DocProps> = BatchDB<DB, Props> & {
        (): Promise<void>;
    };
    type BatchDB<DB extends Core.DB<any>, Props extends Core.DocProps> = {
        [Path in keyof DB]: DB[Path] extends Core.NestedCollection<infer Model, infer NestedDB> ? NestedCollection<Model, Props, BatchDB<NestedDB, Props>> : DB[Path] extends Core.Collection<infer Def> ? Collection<Def, Props> : never;
    };
    type AnyCollection<Def extends Core.DocDef, Props extends Core.DocProps> = Collection<Def, Props> | NestedCollection<Def, Props, Schema<Props>>;
    interface NestedCollection<Def extends Core.DocDef, Props extends Core.DocProps, NestedSchema> extends Collection<Def, Props> {
        (id: Def["Id"]): NestedSchema;
    }
    /**
     *
     */
    interface Collection<Def extends Core.DocDef, Props extends Core.DocProps> extends Core.PlainCollection<Def["Model"]> {
        /** The Firestore path */
        path: string;
        set(id: Def["Id"], data: Core.AssignArg<Core.IntersectVariableModelType<Def["Model"]>, Props>): void;
        upset(id: Def["Id"], data: Core.AssignArg<Core.IntersectVariableModelType<Def["Model"]>, Props>): void;
        update(id: Def["Id"], data: Update.Arg<Def, Props>): void;
        remove(id: Def["Id"]): void;
    }
    interface Schema<Props extends Core.DocProps> {
        [CollectionPath: string]: AnyCollection<any, Props>;
    }
}