Interface Plugin

interface Plugin {
    commit(
        shape: Shape,
        target: Node,
        context: Omit<CommitContext, "self">,
    ): Promise<CommitResult>;
    computeDiff(
        __namedParameters: {
            context: Omit<Context, "self">;
            existing: Database;
            incoming: Database;
            mergedDatabase: Database;
            mode: "explicit" | "catch-all";
            visitedRecords: Database;
        },
    ): Promise<Record[]>;
    fileToRecord(
        file: File,
        context: Omit<Context, "self">,
    ): Promise<Result<Record>>;
    getCoalesceStrategy(table: string): CoalesceStrategy | undefined;
    getCoalesceTables(): string[];
    getConfig(): PluginConfig;
    getDescendants(parent: Record, database: Database): Record[];
    getEntryPoints(): EntryPoints;
    getName(): string;
    getReferenceColumns(table: string): { [column: string]: string };
    getRelationships(): SearchableRelationships;
    getTables(relationships?: Relationships, tables?: string[]): Set<string>;
    getTarget(
        shape: Shape,
        context: Omit<Context, "self">,
    ): Promise<Result<Node<tsc.Node>>>;
    getUpdateName(
        record: Record,
        context: Omit<Context, "self">,
    ): Promise<Result<string>>;
    inspect(shape: Shape, context: Omit<Context, "self">): void;
    isComposite(table: string): boolean;
    recordsToFiles(
        __namedParameters: {
            context: Omit<Context, "self">;
            database: Database;
            handledGuids: Set<string>;
            mode: "explicit" | "catch-all";
        },
    ): Promise<Result<OutputFile[]>>;
    recordsToShapes(
        __namedParameters: {
            changedOnly?: boolean;
            context: Omit<Context, "self">;
            creatorOnly: boolean;
            database: Database;
            existingDatabase?: Database;
            handledRecords: Database;
            mode: "explicit" | "catch-all";
        },
    ): Promise<Result<Shape<unknown>[]>>;
    recordToFile(
        record: Record,
        context: Omit<RecordContext, "self">,
    ): Promise<Result<OutputFile | OutputFile[]>>;
    recordToShape(
        __namedParameters: {
            context: Omit<Context, "self">;
            database: Database;
            existingDatabase?: Database;
            record: Record;
        },
    ): Promise<Result<Shape<unknown>>>;
}