Class AgentDOM

Constructors

constructor

new AgentDOM(doc?: Document, win?: Window): AgentDOM
Parameters
- Optionaldoc: Document
- Optionalwin: Window
Returns AgentDOM
- Defined in core/agent-dom.ts:39

Methods

getToolDescriptors

getToolDescriptors(): AgentDOMToolDescriptor[]
Returns AgentDOMToolDescriptor[]
- Defined in core/agent-dom.ts:53

snapshot

snapshot(options?: SnapshotOptions): ToolResult<SnapshotElement>
Parameters
- options: SnapshotOptions = {}
Returns ToolResult<SnapshotElement>
- Defined in core/agent-dom.ts:242

focusedSnapshot

focusedSnapshot(hint: SnapshotHint): ToolResult<SnapshotElement>
Takes a snapshot that prioritizes certain DOM zones based on the hint. Focus zones get deeper traversal; non-focus zones stay shallow but still include interactable elements and the path to any focus zone.
Parameters
- hint: SnapshotHint
Returns ToolResult<SnapshotElement>
- Defined in core/agent-dom.ts:264

readText

readText(options: ReadTextOptions): ToolResult<string>
Parameters
- options: ReadTextOptions
Returns ToolResult<string>
- Defined in core/agent-dom.ts:283

inspect

inspect(selector: string): ToolResult<InspectResult>
Parameters
- selector: string
Returns ToolResult<InspectResult>
- Defined in core/agent-dom.ts:296

findByText

findByText(options: FindByTextOptions): ToolResult<InspectResult[]>
Parameters
- options: FindByTextOptions
Returns ToolResult<InspectResult[]>
- Defined in core/agent-dom.ts:306

click

click(options: ClickOptions): ToolResult<void>
Parameters
- options: ClickOptions
Returns ToolResult<void>
- Defined in core/agent-dom.ts:352

type

type(options: TypeOptions): ToolResult<void>
Parameters
- options: TypeOptions
Returns ToolResult<void>
- Defined in core/agent-dom.ts:379

select

select(options: SelectOptions): ToolResult<void>
Parameters
- options: SelectOptions
Returns ToolResult<void>
- Defined in core/agent-dom.ts:425

check

check(options: CheckOptions): ToolResult<void>
Parameters
- options: CheckOptions
Returns ToolResult<void>
- Defined in core/agent-dom.ts:447

hover

hover(options: HoverOptions): ToolResult<void>
Parameters
- options: HoverOptions
Returns ToolResult<void>
- Defined in core/agent-dom.ts:466

focus

focus(options: FocusOptions): ToolResult<void>
Parameters
- options: FocusOptions
Returns ToolResult<void>
- Defined in core/agent-dom.ts:478

scroll

scroll(options: ScrollOptions): ToolResult<void>
Parameters
- options: ScrollOptions
Returns ToolResult<void>
- Defined in core/agent-dom.ts:492

scrollIntoView

scrollIntoView(options: ScrollIntoViewOptions): ToolResult<void>
Parameters
- options: ScrollIntoViewOptions
Returns ToolResult<void>
- Defined in core/agent-dom.ts:517

pressKey

pressKey(options: PressKeyOptions): ToolResult<void>
Parameters
- options: PressKeyOptions
Returns ToolResult<void>
- Defined in core/agent-dom.ts:547

setAttribute

setAttribute(options: SetAttributeOptions): ToolResult<void>
Parameters
- options: SetAttributeOptions
Returns ToolResult<void>
- Defined in core/agent-dom.ts:573

toggleClass

toggleClass(options: ToggleClassOptions): ToolResult<boolean>
Parameters
- options: ToggleClassOptions
Returns ToolResult<boolean>
- Defined in core/agent-dom.ts:583

setStyle

setStyle(options: SetStyleOptions): ToolResult<void>
Parameters
- options: SetStyleOptions
Returns ToolResult<void>
- Defined in core/agent-dom.ts:596

submitForm

submitForm(options: SubmitFormOptions): ToolResult<void>
Parameters
- options: SubmitFormOptions
Returns ToolResult<void>
- Defined in core/agent-dom.ts:608

fillForm

fillForm(options: FillFormOptions): ToolResult<Record<string, boolean>>
Parameters
- options: FillFormOptions
Returns ToolResult<Record<string, boolean>>
- Defined in core/agent-dom.ts:627

waitFor

waitFor(options: WaitForOptions): ToolResult<Promise<void>>
Parameters
- options: WaitForOptions
Returns ToolResult<Promise<void>>
- Defined in core/agent-dom.ts:651

execute

execute(toolName: string, params: Record<string, unknown>): ToolResult<unknown>
Parameters
- toolName: string
- params: Record<string, unknown>
Returns ToolResult<unknown>
- Defined in core/agent-dom.ts:697

uniqueSelector

uniqueSelector(el: Element): string
Generate a unique CSS selector for an element, preferring stable attributes (id, data-testid, name) over positional selectors (nth-child).
Parameters
- el: Element
Returns string
- Defined in core/agent-dom.ts:782