Build extended selection context with additional details

declare function buildExtendedSelectionContext(doc: Document, range: Range, options?: SelectionContextOptions): ExtendedSelectionContext;

Build selection context for AI operations

declare function buildSelectionContext(doc: Document, range: Range, options?: SelectionContextOptions): SelectionContext;

Build selection context for AI operations

declare function buildSelectionContext$1(doc: Document, range: Range, options?: SelectionContextOptions$1): SelectionContext;

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;

Count characters in text

declare function countCharacters(text: string, includeSpaces?: boolean): number;

Count words in text

declare function countWords(text: string): number;

Create a DocumentAgent from a DOCX buffer

declare function createAgent(buffer: ArrayBuffer): Promise<DocumentAgent>;

Create a DocumentAgent from a parsed Document

declare function createAgentFromDocument(document: Document): DocumentAgent;

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;

Execute an agent command on a document Returns a new document with the command applied (immutable)

Dispatch order: 1. Try plugin handlers first (allows plugins to override built-in commands) 2. Fall back to built-in handlers

declare function executeCommand(doc: Document, command: AgentCommand): Document;

Execute multiple commands in sequence

declare function executeCommands(doc: Document, commands: AgentCommand[]): Document;

Get action description

declare function getActionDescription(action: AIAction): string;

Get action label

declare function getActionLabel(action: AIAction): string;

Build agent context from a document

declare function getAgentContext(doc: Document, options?: AgentContextOptions): AgentContext;

Get block index for a paragraph index

declare function getBlockIndexForParagraph(body: DocumentBody, paragraphIndex: number): number;

Get character count from document body

declare function getBodyCharacterCount(body: DocumentBody): number;

Get plain text from document body

declare function getBodyText(body: DocumentBody): string;

Get word count from document body

declare function getBodyWordCount(body: DocumentBody): number;

Get a simple document summary for quick context

declare function getDocumentSummary(doc: Document): string;

Get formatting at a specific position in a paragraph

declare function getFormattingAtPosition(paragraph: Paragraph, offset: number): Partial<TextFormatting>;

Get hyperlink at position

declare function getHyperlinkAtPosition(paragraph: Paragraph, offset: number): Hyperlink | undefined;

Get plain text from a hyperlink

declare function getHyperlinkText(hyperlink: Hyperlink): string;

Get paragraph at index from document body

declare function getParagraphAtIndex(body: DocumentBody, index: number): Paragraph | undefined;

Get all paragraphs from document body

declare function getParagraphs(body: DocumentBody): Paragraph[];

Get plain text from a paragraph

declare function getParagraphText(paragraph: Paragraph): string;

Get plain text from a run

declare function getRunText(run: Run): string;

Get formatting summary for a selection

declare function getSelectionFormattingSummary(doc: Document, range: Range): FormattingSummary;

Get plain text from a table

declare function getTableText(table: Table): string;

Get text after a position

declare function getTextAfter(paragraphs: Paragraph[], position: Position, maxChars: number): string;

Get text before a position

declare function getTextBefore(paragraphs: Paragraph[], position: Position, maxChars: number): string;

Check if document body has hyperlinks

declare function hasHyperlinks(body: DocumentBody): boolean;

Check if document body has images

declare function hasImages(body: DocumentBody): boolean;

Check if document body has tables

declare function hasTables(body: DocumentBody): boolean;

Check if style ID represents a heading

declare function isHeadingStyle(styleId?: string): boolean;

Check if position is within a hyperlink

declare function isPositionInHyperlink(paragraph: Paragraph, offset: number): boolean;

Check if a position is within a range

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

Parse heading level from style ID

declare function parseHeadingLevel(styleId?: string): number | undefined;

DocumentAgent provides a fluent API for document manipulation

declare class DocumentAgent

```ts
const agent = new DocumentAgent(buffer);

// Read operations
const text = agent.getText();
const wordCount = agent.getWordCount();
const variables = agent.getVariables();

// Write operations (returns new agent)
const newAgent = agent
  .insertText({ paragraphIndex: 0, offset: 0 }, 'Hello ', { formatting: { bold: true } })
  .applyStyle({ paragraphIndex: 0, offset: 0 }, { paragraphIndex: 0, offset: 5 }, 'Heading1');

// Export
const newBuffer = await newAgent.toBuffer();
```

Document context for AI agents

interface AgentContext

Options for building agent context

interface AgentContextOptions

Response from an agent action

interface AgentResponse

Context about the current selection

interface SelectionContext

AI action request

interface AIActionRequest

Apply a named style to a paragraph

interface ApplyStyleCommand extends BaseCommand

Apply all template variables

interface ApplyVariablesCommand extends BaseCommand

Options for building selection context

interface SelectionContextOptions$1

Delete text in a range

interface DeleteTextCommand extends BaseCommand

Extended selection context with additional details

interface ExtendedSelectionContext extends SelectionContext

Apply paragraph formatting

interface FormatParagraphCommand extends BaseCommand

Formatted text segment

interface FormattedTextSegment

Apply formatting to a range

interface FormatTextCommand extends BaseCommand

Selection formatting summary

interface FormattingSummary

Insert a hyperlink at a range

interface InsertHyperlinkCommand extends BaseCommand

Options for inserting hyperlink

interface InsertHyperlinkOptions

Insert an image at a position

interface InsertImageCommand extends BaseCommand

Options for inserting image

interface InsertImageOptions

Insert a paragraph break

interface InsertParagraphBreakCommand extends BaseCommand

Insert a table at a position

interface InsertTableCommand extends BaseCommand

Options for inserting table

interface InsertTableOptions

Insert text at a position

interface InsertTextCommand extends BaseCommand

Options for inserting text

interface InsertTextOptions

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

Options for building selection context

interface SelectionContextOptions

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';

Default AI actions for context menu

DEFAULT_AI_ACTIONS: AIAction[]