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>>;
    flushCache(): void;
    getCoalesceStrategy(table: string): CoalesceStrategy | undefined;
    getCoalesceTables(): string[];
    getDescendants(parent: Record, database: Database): Record[];
    getDocsMetadata(): DocsManifest | undefined;
    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;
    isEntryPoint(
        pathOrNode:
            | string
            | SourceFile
            | ImportDeclaration
            | ExportDeclaration
            | ExportAssignment
            | ClassDeclaration
            | FunctionDeclaration
            | VariableDeclaration
            | TypeAliasDeclaration
            | ModuleDeclaration
            | Identifier
            | StringLiteral
            | NumericLiteral
            | ComputedPropertyName
            | NoSubstitutionTemplateLiteral
            | ParameterDeclaration
            | PropertySignature
            | VariableStatement
            | TrueLiteral
            | FalseLiteral
            | TaggedTemplateExpression
            | PropertyAccessExpression<tsc.PropertyAccessExpression>
            | PropertyAssignment
            | TemplateExpression
            | ArrayLiteralExpression
            | ArrowFunction
            | AsExpression
            | BinaryExpression<tsc.BinaryExpression>
            | Block
            | CallExpression<tsc.CallExpression>
            | ElementAccessExpression<tsc.ElementAccessExpression>
            | ExportSpecifier
            | ExpressionStatement
            | FunctionExpression
            | ImportClause
            | ImportSpecifier
            | ModuleBlock
            | NamedExports
            | NamedImports
            | ObjectLiteralExpression
            | PrefixUnaryExpression
            | TemplateHead
            | TemplateMiddle
            | TemplateSpan
            | TemplateTail
            | VariableDeclarationList
            | LiteralTypeNode
            | NullLiteral
            | TupleTypeNode
            | TypeLiteralNode
            | TypeReferenceNode
            | Node<EndOfFileToken>
            | Node<EqualsToken>
            | Node<PlusToken>
            | Node<ExportKeyword>
            | Node<KeywordTypeNode<AnyKeyword>>
            | Node<EqualsGreaterThanToken>,
        context: Omit<Context, "self">,
    ): Promise<boolean>;
    nodeToShape(
        node:
            | SourceFile
            | ImportDeclaration
            | ExportDeclaration
            | ExportAssignment
            | ClassDeclaration
            | FunctionDeclaration
            | VariableDeclaration
            | TypeAliasDeclaration
            | ModuleDeclaration
            | Identifier
            | StringLiteral
            | NumericLiteral
            | ComputedPropertyName
            | NoSubstitutionTemplateLiteral
            | ParameterDeclaration
            | PropertySignature
            | VariableStatement
            | TrueLiteral
            | FalseLiteral
            | TaggedTemplateExpression
            | PropertyAccessExpression<tsc.PropertyAccessExpression>
            | PropertyAssignment
            | TemplateExpression
            | ArrayLiteralExpression
            | ArrowFunction
            | AsExpression
            | BinaryExpression<tsc.BinaryExpression>
            | Block
            | CallExpression<tsc.CallExpression>
            | ElementAccessExpression<tsc.ElementAccessExpression>
            | ExportSpecifier
            | ExpressionStatement
            | FunctionExpression
            | ImportClause
            | ImportSpecifier
            | ModuleBlock
            | NamedExports
            | NamedImports
            | ObjectLiteralExpression
            | PrefixUnaryExpression
            | TemplateHead
            | TemplateMiddle
            | TemplateSpan
            | TemplateTail
            | VariableDeclarationList
            | LiteralTypeNode
            | NullLiteral
            | TupleTypeNode
            | TypeLiteralNode
            | TypeReferenceNode
            | Node<EndOfFileToken>
            | Node<EqualsToken>
            | Node<PlusToken>
            | Node<ExportKeyword>
            | Node<KeywordTypeNode<AnyKeyword>>
            | Node<EqualsGreaterThanToken>,
        context: Omit<Context, "self">,
    ): Promise<Result<Shape<unknown>>>;
    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;
            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;
            record: Record;
        },
    ): Promise<Result<Shape<unknown>>>;
    shapeToRecord(
        shape: Shape,
        context: Omit<Context, "self">,
    ): Promise<Result<Record>>;
    shapeToSubclass<const S extends Shape<unknown>>(
        shape: S,
        context: Omit<Context, "self">,
    ): Promise<Result<S>>;
}