Compare two positions Returns: -1 if a b, 0 if equal, 1 if a b

declare function comparePositions(a: Position, b: Position): -1 | 0 | 1;

Create a collapsed range (cursor) at a position

declare function createCollapsedRange(position: Position): Range;

Create a command with generated ID

declare function createCommand<T extends AgentCommand>(command: Omit<T, 'id'>): T;

Create a range from two positions

declare function createRange(start: Position, end: Position): Range;

Get action description

declare function getActionDescription(action: AIAction): string;

Get action label

declare function getActionLabel(action: AIAction): string;

Check if a position is within a range

declare function isPositionInRange(position: Position, range: Range): boolean;

Content block in agent response

interface AgentContent

Document context for AI agents

interface AgentContext

Response from an agent action

interface AgentResponse

AI action request

interface AIActionRequest

Apply a named style to a paragraph

interface ApplyStyleCommand extends BaseCommand

Apply all template variables

interface ApplyVariablesCommand extends BaseCommand

Base command interface

interface BaseCommand

Delete text in a range

interface DeleteTextCommand extends BaseCommand

Apply paragraph formatting

interface FormatParagraphCommand extends BaseCommand

Apply formatting to a range

interface FormatTextCommand extends BaseCommand

Insert a hyperlink at a range

interface InsertHyperlinkCommand extends BaseCommand

Insert an image at a position

interface InsertImageCommand extends BaseCommand

Insert a paragraph break

interface InsertParagraphBreakCommand extends BaseCommand

Insert a table at a position

interface InsertTableCommand extends BaseCommand

Insert text at a position

interface InsertTextCommand extends BaseCommand

Merge paragraphs

interface MergeParagraphsCommand extends BaseCommand

Paragraph context for selection

interface ParagraphContext

Paragraph outline for context

interface ParagraphOutline

Position within a document

interface Position

Range within a document

interface Range

Remove a hyperlink but keep the text

interface RemoveHyperlinkCommand extends BaseCommand

Replace text in a range

interface ReplaceTextCommand extends BaseCommand

Section information

interface SectionInfo

Context about the current selection

interface SelectionContext

Set template variable value

interface SetVariableCommand extends BaseCommand

Split a paragraph

interface SplitParagraphCommand extends BaseCommand

Style information for context

interface StyleInfo

Suggested action for context menu

interface SuggestedAction

Union of all command types

type AgentCommand = InsertTextCommand | ReplaceTextCommand | DeleteTextCommand | FormatTextCommand | FormatParagraphCommand | ApplyStyleCommand | InsertTableCommand | InsertImageCommand | InsertHyperlinkCommand | RemoveHyperlinkCommand | InsertParagraphBreakCommand | MergeParagraphsCommand | SplitParagraphCommand | SetVariableCommand | ApplyVariablesCommand;

AI action types for context menu

type AIAction = 'askAI' | 'rewrite' | 'expand' | 'summarize' | 'translate' | 'explain' | 'fixGrammar' | 'makeFormal' | 'makeCasual' | 'custom';

AI request handler function type

type AIRequestHandler = (request: AIActionRequest) => Promise<AgentResponse>;

Command handler function type

type CommandHandler<T extends AgentCommand = AgentCommand> = (command: T) => Promise<boolean>;

Get command type

type CommandType = AgentCommand['type'];

_default: {
    createCollapsedRange: typeof createCollapsedRange;
    createRange: typeof createRange;
    isPositionInRange: typeof isPositionInRange;
    comparePositions: typeof comparePositions;
    getActionLabel: typeof getActionLabel;
    getActionDescription: typeof getActionDescription;
    createCommand: typeof createCommand;
    DEFAULT_AI_ACTIONS: AIAction[];
}

Default AI actions for context menu

DEFAULT_AI_ACTIONS: AIAction[]