@bctrl/sdk 1.0.1 → 1.0.3

package/dist/drivers/stagehand/generated/locator.js

@@ -1,368 +0,0 @@
-/**
- * AUTO-GENERATED FILE - DO NOT EDIT
- *
- * Generated from: packages/automation-spec/src/drivers/stagehand/methods/
- * Run `pnpm generate:stagehand` to regenerate.
- */
-/**
- * RemoteStagehandLocator - Remote Puppeteer Locator API over RPC.
- *
- * @see https://pptr.dev/api/puppeteer.locator
- */
-export class RemoteStagehandLocator {
-    selector;
-    sendRpc;
-    constructor(selector, sendRpc) {
-        this.selector = selector;
-        this.sendRpc = sendRpc;
-    }
-    rpc(method, args) {
-        return this.sendRpc(method, args);
-    }
-    /**
-     * Create a new locator with a different selector (internal helper for nth/first).
-     */
-    createLocator(selector) {
-        return new RemoteStagehandLocator(selector, this.sendRpc);
-    }
-    /**
-     * Clones the locator.
-     * @returns A new locator with the same configuration.
-     */
-    clone() {
-        return new RemoteStagehandLocator(this.selector, this.sendRpc);
-    }
-    /**
-     * Click the element at its visual center.
-     *
-     * @remarks
-     * The method:
-     * 1. Scrolls element into view
-     * 2. Gets element geometry
-     * 3. Moves mouse to center
-     * 4. Dispatches mousePressed and mouseReleased events
-     *
-     * Options include:
-     * - button: 'left' | 'right' | 'middle' (default: 'left')
-     * - clickCount: Number of clicks (default: 1)
-     *
-     * @example
-     * await locator.click();
-     *
-     * @example
-     * await locator.click({ button: "right" });
-     *
-     * @example
-     * await locator.click({ clickCount: 2 }); // Double click
-     *
-     * @see https://docs.stagehand.dev/references/locator#click
-     */
-    async click(options) {
-        await this.rpc('click', [options]);
-    }
-    /**
-     * Fill an input, textarea, or contenteditable element.
-     * @param value - The text value to fill into the element.
-     *
-     * @remarks
-     * The method intelligently handles different input types:
-     * - Uses native value setter for special inputs (date, number, etc.)
-     * - Types text character-by-character for regular inputs
-     * - Clears existing content before filling
-     *
-     * @example
-     * await locator.fill("user@example.com");
-     *
-     * @see https://docs.stagehand.dev/references/locator#fill
-     */
-    async fill(value) {
-        await this.rpc('fill', [value]);
-    }
-    /**
-     * Type text into the element with optional delay between keystrokes.
-     * @param text - The text to type.
-     *
-     * @remarks
-     * If delay is not specified, uses Input.insertText for efficiency.
-     *
-     * @example
-     * await locator.type("Hello");
-     *
-     * @example
-     * await locator.type("World", { delay: 100 });
-     *
-     * @see https://docs.stagehand.dev/references/locator#type
-     */
-    async type(text, options) {
-        await this.rpc('type', [text, options]);
-    }
-    /**
-     * Move the mouse cursor to the element's center without clicking.
-     *
-     * @remarks
-     * Scrolls the element into view and dispatches a mouse move event.
-     *
-     * @example
-     * await locator.hover();
-     *
-     * @see https://docs.stagehand.dev/references/locator#hover
-     */
-    async hover() {
-        await this.rpc('hover', []);
-    }
-    /**
-     * Select one or more options in a <select> element.
-     * @param values - Option value(s) to select.
-     * @returns Array of values that were actually selected.
-     *
-     * @remarks
-     * For multi-select elements, pass an array of values.
-     *
-     * @example
-     * await locator.selectOption("blue");
-     *
-     * @example
-     * await locator.selectOption(["red", "green"]);
-     *
-     * @see https://docs.stagehand.dev/references/locator#selectoption
-     */
-    async selectOption(values) {
-        return this.rpc('selectOption', [values]);
-    }
-    /**
-     * Set files on an <input type="file"> element.
-     * @param files - File paths or file payloads to upload.
-     *
-     * @remarks
-     * Accepts:
-     * - File path (string)
-     * - Array of file paths
-     * - File payload object { name, mimeType, buffer }
-     * - Array of file payloads
-     *
-     * Pass an empty array to clear the file selection.
-     *
-     * @example
-     * await locator.setInputFiles("./file.pdf");
-     *
-     * @example
-     * await locator.setInputFiles(["file1.txt", "file2.txt"]);
-     *
-     * @example
-     * await locator.setInputFiles({ name: "file.txt", mimeType: "text/plain", buffer: "..." });
-     *
-     * @example
-     * await locator.setInputFiles([]); // Clear files
-     *
-     * @see https://docs.stagehand.dev/references/locator#setinputfiles
-     */
-    async setInputFiles(files) {
-        await this.rpc('setInputFiles', [files]);
-    }
-    /**
-     * Check if the element is visible.
-     * @returns true if element is attached and visible.
-     *
-     * @example
-     * const visible = await locator.isVisible();
-     *
-     * @see https://docs.stagehand.dev/references/locator#isvisible
-     */
-    async isVisible() {
-        return this.rpc('isVisible', []);
-    }
-    /**
-     * Check if a checkbox or radio button is checked.
-     * @returns true if checked.
-     *
-     * @remarks
-     * Also considers aria-checked for ARIA widgets.
-     *
-     * @example
-     * const checked = await locator.isChecked();
-     *
-     * @see https://docs.stagehand.dev/references/locator#ischecked
-     */
-    async isChecked() {
-        return this.rpc('isChecked', []);
-    }
-    /**
-     * Get the current value of an input element.
-     * @returns The element's input value.
-     *
-     * @remarks
-     * Works with: <input>, <textarea>, <select>, contenteditable elements.
-     *
-     * @example
-     * const value = await locator.inputValue();
-     *
-     * @see https://docs.stagehand.dev/references/locator#inputvalue
-     */
-    async inputValue() {
-        return this.rpc('inputValue', []);
-    }
-    /**
-     * Get the element's text content (raw).
-     * @returns The element's textContent property.
-     *
-     * @example
-     * const text = await locator.textContent();
-     *
-     * @see https://docs.stagehand.dev/references/locator#textcontent
-     */
-    async textContent() {
-        return this.rpc('textContent', []);
-    }
-    /**
-     * Get the element's visible text (layout-aware).
-     * @returns The element's innerText property.
-     *
-     * @example
-     * const text = await locator.innerText();
-     *
-     * @see https://docs.stagehand.dev/references/locator#innertext
-     */
-    async innerText() {
-        return this.rpc('innerText', []);
-    }
-    /**
-     * Get the element's inner HTML.
-     * @returns The element's innerHTML property.
-     *
-     * @example
-     * const html = await locator.innerHtml();
-     *
-     * @see https://docs.stagehand.dev/references/locator#innerhtml
-     */
-    async innerHtml() {
-        return this.rpc('innerHtml', []);
-    }
-    /**
-     * Return the number of elements matching this locator.
-     *
-     * @example
-     * const count = await locator.count();
-     *
-     * @see https://docs.stagehand.dev/references/locator#count
-     */
-    async count() {
-        return this.rpc('count', []);
-    }
-    /**
-     * Return a locator for the nth matching element.
-     * @param index - Zero-based index of the element.
-     *
-     * @remarks
-     * Index is zero-based.
-     *
-     * @example
-     * const secondItem = locator.nth(1);
-     *
-     * @see https://docs.stagehand.dev/references/locator#nth
-     */
-    nth(index) {
-        return this.createLocator(`${this.selector}:nth-child(${index})`);
-    }
-    /**
-     * Return a locator for the first matching element.
-     *
-     * @example
-     * const firstItem = locator.first();
-     *
-     * @see https://docs.stagehand.dev/references/locator#first
-     */
-    first() {
-        return this.createLocator(`${this.selector}:first-child`);
-    }
-    /**
-     * Visually highlight the element with an overlay.
-     *
-     * @remarks
-     * Useful for debugging and visual verification.
-     *
-     * Options include:
-     * - durationMs: How long to display the highlight (default: 800)
-     * - borderColor: Border color RGBA values
-     * - contentColor: Content fill color RGBA values
-     *
-     * @example
-     * await locator.highlight();
-     *
-     * @example
-     * await locator.highlight({ durationMs: 2000 });
-     *
-     * @see https://docs.stagehand.dev/references/locator#highlight
-     */
-    async highlight(options) {
-        await this.rpc('highlight', [options]);
-    }
-    /**
-     * Scroll the element to a specific position.
-     * @param percent - Scroll position as percentage (0-100).
-     *
-     * @remarks
-     * For <html> or <body> elements, scrolls the window. Otherwise, scrolls the element itself.
-     *
-     * @example
-     * await locator.scrollTo(50); // Scroll to 50%
-     *
-     * @example
-     * await locator.scrollTo("100"); // Scroll to bottom
-     *
-     * @see https://docs.stagehand.dev/references/locator#scrollto
-     */
-    async scrollTo(percent) {
-        await this.rpc('scrollTo', [percent]);
-    }
-    /**
-     * Get the center coordinates of the element.
-     * @returns Center point in CSS pixels { x, y }.
-     *
-     * @example
-     * const { x, y } = await locator.centroid();
-     *
-     * @see https://docs.stagehand.dev/references/locator#centroid
-     */
-    async centroid() {
-        return this.rpc('centroid', []);
-    }
-    /**
-     * Get the DOM backend node ID for the element.
-     * @returns Unique identifier for the DOM node.
-     *
-     * @remarks
-     * Useful for identity comparisons without maintaining element handles.
-     *
-     * @example
-     * const nodeId = await locator.backendNodeId();
-     *
-     * @see https://docs.stagehand.dev/references/locator#backendnodeid
-     */
-    async backendNodeId() {
-        return this.rpc('backendNodeId', []);
-    }
-    /**
-     * Dispatch a DOM click event directly on the element.
-     *
-     * @remarks
-     * This dispatches an event directly without synthesizing real pointer input.
-     * Useful for elements that rely on click handlers without needing hit-testing.
-     *
-     * Options include:
-     * - bubbles: Whether the event bubbles (default: true)
-     * - cancelable: Whether the event is cancelable (default: true)
-     * - composed: Whether the event crosses shadow DOM boundaries (default: true)
-     * - detail: Click count detail (default: 1)
-     *
-     * @example
-     * await locator.sendClickEvent();
-     *
-     * @example
-     * await locator.sendClickEvent({ detail: 2 }); // Double click event
-     *
-     * @see https://docs.stagehand.dev/references/locator#sendclickevent
-     */
-    async sendClickEvent(options) {
-        await this.rpc('sendClickEvent', [options]);
-    }
-}