@mintlify/common/dist/editor/types.d.ts

Commonly shared code within Mintlify

export interface CommentAnchor {
    anchorCommit: string;
    line: number;
    startCol: number;
    endCol: number;
    originalText: string;
    contextBefore: string;
    contextAfter: string;
    tiptapFrom?: number;
    tiptapTo?: number;
    createdAt: Date;
    createdBy: string;
}
export type AnchorResolutionStatus = 'found' | 'stale' | 'orphan';
export interface TextRange {
    startIndex: number;
    endIndex: number;
}
export interface AnchorResolutionResult {
    status: AnchorResolutionStatus;
    range: TextRange | null;
    similarity?: number;
}
export interface ThreadResolutionInput<T = unknown> {
    threadId: string;
    anchor: CommentAnchor;
    metadata?: T;
}
export interface ThreadResolutionResult<T = unknown> {
    threadId: string;
    resolution: AnchorResolutionResult;
    updatedAnchor?: CommentAnchor;
    metadata?: T;
}
export interface ResolveAnchorOptions {
    currentCommit?: string;
    similarityThreshold?: number;
}
export interface TextSearchResult {
    found: boolean;
    startIndex: number;
    endIndex: number;
}