Interface DocumentAdapter

webapp/_webapp/src/adapters/types.ts:35–81

}

export interface DocumentAdapter {
  /**
   * Platform identifier for conditional UI rendering
   */
  readonly platform: "overleaf" | "word" | "browser";

  /**
   * Get the full document text
   */
  getFullText(): Promise<string>;

  /**
   * Get the currently selected text and its context
   */
  getSelection(): Promise<SelectionInfo | null>;

  /**
   * Insert text at the current cursor position
   * @param text - Text to insert
   * @param location - Optional: 'cursor' (default), 'start', or 'end'
   */
  insertText(text: string, location?: "cursor" | "start" | "end"): Promise<void>;

  /**
   * Replace the current selection with new text
   * @param text - Text to replace with
   * @param rangeId - Optional range identifier from getSelection()
   */
  replaceSelection(text: string, rangeId?: string): Promise<void>;

  /**
   * Subscribe to selection change events
   * @param callback - Called when selection changes
   * @returns Cleanup function to unsubscribe
   */
  onSelectionChange?(callback: (selection: SelectionInfo | null) => void): () => void;

  /**
   * Check if the adapter is ready/connected
   */
  isReady(): boolean;

  /**
   * Optional: Get project/document identifier
   */
  getDocumentId?(): string;
}

/**
 * Type for adapter props passed to Web Component