@bctrl/sdk 1.0.1 → 1.0.3

package/dist/drivers/stagehand/generated/context.d.ts

@@ -1,127 +0,0 @@
-/**
- * AUTO-GENERATED FILE - DO NOT EDIT
- *
- * Generated from: packages/automation-spec/src/drivers/stagehand/methods/
- * Run `pnpm generate:stagehand` to regenerate.
- */
-import type { SimpleRpcSender } from '../../../internal/transport.js';
-import type { RemoteStagehandPage } from './page.js';
-/**
- * RemoteStagehandContext - Remote Puppeteer Context API over RPC.
- *
- * @see https://pptr.dev/api/puppeteer.context
- */
-export declare class RemoteStagehandContext {
-    readonly id: string;
-    protected sendRpc: SimpleRpcSender;
-    constructor(id: string, sendRpc: SimpleRpcSender, createPage: (id: string) => RemoteStagehandPage);
-    private createPage;
-    private _isClosed;
-    private rpc;
-    /**
-     * Mark this context as closed (internal use).
-     */
-    markClosed(): void;
-    /**
-     * Create a new page (tab) in the browser.
-     * @param url - The URL to navigate to in the new page.
-     *
-     * @remarks
-     * The new page is automatically set as the active page. Defaults to "about:blank" if no URL is provided.
-     *
-     * @example
-     * const page = await context.newPage();
-     *
-     * @example
-     * const page = await context.newPage("https://example.com");
-     *
-     * @see https://docs.stagehand.dev/references/context#newpage
-     */
-    newPage(url?: string): Promise<RemoteStagehandPage>;
-    /**
-     * Get all open pages in the browser context.
-     *
-     * @remarks
-     * Returns an array of all open pages, ordered from oldest to newest.
-     *
-     * @example
-     * const allPages = await context.pages();
-     *
-     * @see https://docs.stagehand.dev/references/context#pages
-     */
-    pages(): Promise<RemoteStagehandPage[]>;
-    /**
-     * Get the currently active page.
-     *
-     * @remarks
-     * The active page is determined by:
-     * 1. Most recently interacted with page
-     * 2. Most recently created page if no interaction history
-     * 3. undefined if all pages have been closed
-     *
-     * @example
-     * const page = await context.activePage();
-     *
-     * @see https://docs.stagehand.dev/references/context#activepage
-     */
-    activePage(): Promise<RemoteStagehandPage | undefined>;
-    /**
-     * Set a specific page as the active page.
-     * @param pageId - The ID of the page to set as active.
-     *
-     * @remarks
-     * This method:
-     * - Marks the page as most recently used
-     * - Brings the tab to the foreground (in headed mode)
-     * - Makes it the default page for subsequent operations
-     *
-     * Note: Pass page.id from a RemoteStagehandPage instance.
-     *
-     * @example
-     * context.setActivePage(page.id);
-     *
-     * @see https://docs.stagehand.dev/references/context#setactivepage
-     */
-    setActivePage(pageId: string): Promise<void>;
-    /**
-     * Inject JavaScript that runs before any page scripts on every navigation.
-     * @param script - The script to inject. Can be raw source code, a file reference, or a function.
-     * @param arg - Extra data that is JSON-serialized and passed to your function.
-     *
-     * @remarks
-     * This method:
-     * - Runs at document start
-     * - Installs the script on all currently open pages
-     * - Replays it on every navigation of those pages
-     * - Automatically applies to any pages created after calling addInitScript()
-     *
-     * @example
-     * await context.addInitScript(() => {
-     *   window.alert = () => {};
-     *   window.confirm = () => true;
-     * });
-     *
-     * @example
-     * await context.addInitScript({ path: "./preloads/setup.js" });
-     *
-     * @see https://docs.stagehand.dev/references/context#addinitscript
-     */
-    addInitScript<Arg = unknown>(script: string | {
-        path?: string;
-        content?: string;
-    } | ((arg: Arg) => unknown), arg?: Arg): Promise<void>;
-    /**
-     * Close the browser context and all associated pages.
-     *
-     * @remarks
-     * This method:
-     * - Closes the CDP connection
-     * - Cleans up all pages
-     * - Clears all internal mappings
-     *
-     * Note: This is typically called internally by stagehand.close(). You usually don't need to call this directly.
-     *
-     * @see https://docs.stagehand.dev/references/context#close
-     */
-    close(): Promise<void>;
-}

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

@@ -1,153 +0,0 @@
-/**
- * AUTO-GENERATED FILE - DO NOT EDIT
- *
- * Generated from: packages/automation-spec/src/drivers/stagehand/methods/
- * Run `pnpm generate:stagehand` to regenerate.
- */
-import { serializeFunctionSource } from '../../../internal/transport.js';
-/**
- * RemoteStagehandContext - Remote Puppeteer Context API over RPC.
- *
- * @see https://pptr.dev/api/puppeteer.context
- */
-export class RemoteStagehandContext {
-    id;
-    sendRpc;
-    constructor(id, sendRpc, createPage) {
-        this.id = id;
-        this.sendRpc = sendRpc;
-        this.createPage = createPage;
-    }
-    createPage;
-    _isClosed = false;
-    rpc(method, args) {
-        if (this._isClosed) {
-            throw new Error('Context is closed');
-        }
-        return this.sendRpc(method, args);
-    }
-    /**
-     * Mark this context as closed (internal use).
-     */
-    markClosed() {
-        this._isClosed = true;
-    }
-    /**
-     * Create a new page (tab) in the browser.
-     * @param url - The URL to navigate to in the new page.
-     *
-     * @remarks
-     * The new page is automatically set as the active page. Defaults to "about:blank" if no URL is provided.
-     *
-     * @example
-     * const page = await context.newPage();
-     *
-     * @example
-     * const page = await context.newPage("https://example.com");
-     *
-     * @see https://docs.stagehand.dev/references/context#newpage
-     */
-    async newPage(url) {
-        const pageId = await this.rpc('newPage', [url]);
-        return this.createPage(pageId);
-    }
-    /**
-     * Get all open pages in the browser context.
-     *
-     * @remarks
-     * Returns an array of all open pages, ordered from oldest to newest.
-     *
-     * @example
-     * const allPages = await context.pages();
-     *
-     * @see https://docs.stagehand.dev/references/context#pages
-     */
-    async pages() {
-        const pageIds = await this.rpc('pages', []);
-        return pageIds.map((id) => this.createPage(id));
-    }
-    /**
-     * Get the currently active page.
-     *
-     * @remarks
-     * The active page is determined by:
-     * 1. Most recently interacted with page
-     * 2. Most recently created page if no interaction history
-     * 3. undefined if all pages have been closed
-     *
-     * @example
-     * const page = await context.activePage();
-     *
-     * @see https://docs.stagehand.dev/references/context#activepage
-     */
-    async activePage() {
-        const pageId = await this.rpc('activePage', []);
-        if (!pageId)
-            return undefined;
-        return this.createPage(pageId);
-    }
-    /**
-     * Set a specific page as the active page.
-     * @param pageId - The ID of the page to set as active.
-     *
-     * @remarks
-     * This method:
-     * - Marks the page as most recently used
-     * - Brings the tab to the foreground (in headed mode)
-     * - Makes it the default page for subsequent operations
-     *
-     * Note: Pass page.id from a RemoteStagehandPage instance.
-     *
-     * @example
-     * context.setActivePage(page.id);
-     *
-     * @see https://docs.stagehand.dev/references/context#setactivepage
-     */
-    async setActivePage(pageId) {
-        await this.rpc('setActivePage', [pageId]);
-    }
-    /**
-     * Inject JavaScript that runs before any page scripts on every navigation.
-     * @param script - The script to inject. Can be raw source code, a file reference, or a function.
-     * @param arg - Extra data that is JSON-serialized and passed to your function.
-     *
-     * @remarks
-     * This method:
-     * - Runs at document start
-     * - Installs the script on all currently open pages
-     * - Replays it on every navigation of those pages
-     * - Automatically applies to any pages created after calling addInitScript()
-     *
-     * @example
-     * await context.addInitScript(() => {
-     *   window.alert = () => {};
-     *   window.confirm = () => true;
-     * });
-     *
-     * @example
-     * await context.addInitScript({ path: "./preloads/setup.js" });
-     *
-     * @see https://docs.stagehand.dev/references/context#addinitscript
-     */
-    async addInitScript(script, arg) {
-        const _script = serializeFunctionSource(script);
-        await this.rpc('addInitScript', [_script, arg]);
-    }
-    /**
-     * Close the browser context and all associated pages.
-     *
-     * @remarks
-     * This method:
-     * - Closes the CDP connection
-     * - Cleans up all pages
-     * - Clears all internal mappings
-     *
-     * Note: This is typically called internally by stagehand.close(). You usually don't need to call this directly.
-     *
-     * @see https://docs.stagehand.dev/references/context#close
-     */
-    async close() {
-        await this.rpc('close', []);
-        this.markClosed();
-    }
-}

package/dist/drivers/stagehand/generated/locator.d.ts

@@ -1,324 +0,0 @@
-/**
- * AUTO-GENERATED FILE - DO NOT EDIT
- *
- * Generated from: packages/automation-spec/src/drivers/stagehand/methods/
- * Run `pnpm generate:stagehand` to regenerate.
- */
-import type { SimpleRpcSender } from '../../../internal/transport.js';
-import type { StagehandFileInput, StagehandHighlightOptions, StagehandLocatorClickOptions, StagehandLocatorTypeOptions, StagehandSendClickEventOptions } from '../types.js';
-/**
- * RemoteStagehandLocator - Remote Puppeteer Locator API over RPC.
- *
- * @see https://pptr.dev/api/puppeteer.locator
- */
-export declare class RemoteStagehandLocator {
-    readonly selector: string;
-    private sendRpc;
-    constructor(selector: string, sendRpc: SimpleRpcSender);
-    private rpc;
-    /**
-     * Create a new locator with a different selector (internal helper for nth/first).
-     */
-    private createLocator;
-    /**
-     * Clones the locator.
-     * @returns A new locator with the same configuration.
-     */
-    clone(): RemoteStagehandLocator;
-    /**
-     * 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
-     */
-    click(options?: StagehandLocatorClickOptions): Promise<void>;
-    /**
-     * 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
-     */
-    fill(value: string): Promise<void>;
-    /**
-     * 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
-     */
-    type(text: string, options?: StagehandLocatorTypeOptions): Promise<void>;
-    /**
-     * 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
-     */
-    hover(): Promise<void>;
-    /**
-     * 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
-     */
-    selectOption(values: string | string[]): Promise<string[]>;
-    /**
-     * 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
-     */
-    setInputFiles(files: StagehandFileInput): Promise<void>;
-    /**
-     * 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
-     */
-    isVisible(): Promise<boolean>;
-    /**
-     * 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
-     */
-    isChecked(): Promise<boolean>;
-    /**
-     * 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
-     */
-    inputValue(): Promise<string>;
-    /**
-     * 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
-     */
-    textContent(): Promise<string>;
-    /**
-     * 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
-     */
-    innerText(): Promise<string>;
-    /**
-     * 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
-     */
-    innerHtml(): Promise<string>;
-    /**
-     * Return the number of elements matching this locator.
-     *
-     * @example
-     * const count = await locator.count();
-     *
-     * @see https://docs.stagehand.dev/references/locator#count
-     */
-    count(): Promise<number>;
-    /**
-     * 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: number): RemoteStagehandLocator;
-    /**
-     * Return a locator for the first matching element.
-     *
-     * @example
-     * const firstItem = locator.first();
-     *
-     * @see https://docs.stagehand.dev/references/locator#first
-     */
-    first(): RemoteStagehandLocator;
-    /**
-     * 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
-     */
-    highlight(options?: StagehandHighlightOptions): Promise<void>;
-    /**
-     * 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
-     */
-    scrollTo(percent: number | string): Promise<void>;
-    /**
-     * 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
-     */
-    centroid(): Promise<{
-        x: number;
-        y: number;
-    }>;
-    /**
-     * 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
-     */
-    backendNodeId(): Promise<number>;
-    /**
-     * 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
-     */
-    sendClickEvent(options?: StagehandSendClickEventOptions): Promise<void>;
-}