@bctrl/sdk 1.0.1

package/dist/drivers/playwright/generated/dialog.d.ts

@@ -0,0 +1,79 @@
+/**
+ * AUTO-GENERATED FILE - DO NOT EDIT
+ *
+ * Generated from: packages/automation-spec/src/drivers/playwright/methods/
+ * Run `pnpm generate:playwright` to regenerate.
+ */
+import type { SimpleRpcSender } from '../../../internal/transport.js';
+import type { PlaywrightDialogType } from '../types.js';
+import type { RemotePlaywrightPage } from './page.js';
+/**
+ * Serialized Dialog data received over RPC.
+ */
+export interface SerializedDialog {
+    /** Dialog ID for RPC calls */
+    id: string;
+    /** Dialog type */
+    type: PlaywrightDialogType;
+    /** Message displayed in the dialog */
+    message: string;
+    /** Default value for prompt dialogs */
+    defaultValue: string;
+    /** Page ID or null */
+    pageId: string | null;
+}
+/**
+ * RemotePlaywrightDialog - Remote Playwright Dialog API over RPC.
+ *
+ * @see https://playwright.dev/docs/api/class-dialog
+ */
+export declare class RemotePlaywrightDialog {
+    private sendRpc;
+    private readonly _id;
+    private readonly _type;
+    private readonly _message;
+    private readonly _defaultValue;
+    constructor(sendRpc: SimpleRpcSender, data: SerializedDialog, createPage: (id: string) => RemotePlaywrightPage);
+    private readonly _page;
+    /**
+     * Accepts the dialog.
+     * @param promptText - Text to enter in a prompt dialog.
+     * @see https://playwright.dev/docs/api/class-dialog#dialog-accept
+     */
+    accept(promptText?: string): Promise<void>;
+    /**
+     * Dismisses the dialog.
+     * @see https://playwright.dev/docs/api/class-dialog#dialog-dismiss
+     */
+    dismiss(): Promise<void>;
+    /**
+     * Returns the default prompt value if the dialog is a prompt.
+     *
+     * @remarks
+     * Returns empty string for other dialog types.
+     *
+     * @see https://playwright.dev/docs/api/class-dialog#dialog-default-value
+     */
+    defaultValue(): string;
+    /**
+     * Returns the message displayed in the dialog.
+     *
+     * @see https://playwright.dev/docs/api/class-dialog#dialog-message
+     */
+    message(): string;
+    /**
+     * Returns the page that initiated the dialog, or null if not available.
+     *
+     * @see https://playwright.dev/docs/api/class-dialog#dialog-page
+     */
+    page(): RemotePlaywrightPage | null;
+    /**
+     * Returns the type of the dialog.
+     *
+     * @remarks
+     * One of 'alert', 'beforeunload', 'confirm', or 'prompt'.
+     *
+     * @see https://playwright.dev/docs/api/class-dialog#dialog-type
+     */
+    type(): PlaywrightDialogType;
+}

package/dist/drivers/playwright/generated/dialog.js

@@ -0,0 +1,80 @@
+/**
+ * AUTO-GENERATED FILE - DO NOT EDIT
+ *
+ * Generated from: packages/automation-spec/src/drivers/playwright/methods/
+ * Run `pnpm generate:playwright` to regenerate.
+ */
+/**
+ * RemotePlaywrightDialog - Remote Playwright Dialog API over RPC.
+ *
+ * @see https://playwright.dev/docs/api/class-dialog
+ */
+export class RemotePlaywrightDialog {
+    sendRpc;
+    _id;
+    _type;
+    _message;
+    _defaultValue;
+    constructor(sendRpc, data, createPage) {
+        this.sendRpc = sendRpc;
+        this._id = data.id;
+        this._type = data.type;
+        this._message = data.message;
+        this._defaultValue = data.defaultValue;
+        this._page = data.pageId ? createPage(data.pageId) : null;
+    }
+    _page;
+    /**
+     * Accepts the dialog.
+     * @param promptText - Text to enter in a prompt dialog.
+     * @see https://playwright.dev/docs/api/class-dialog#dialog-accept
+     */
+    async accept(promptText) {
+        await this.sendRpc('accept', [this._id, promptText]);
+    }
+    /**
+     * Dismisses the dialog.
+     * @see https://playwright.dev/docs/api/class-dialog#dialog-dismiss
+     */
+    async dismiss() {
+        await this.sendRpc('dismiss', [this._id]);
+    }
+    /**
+     * Returns the default prompt value if the dialog is a prompt.
+     *
+     * @remarks
+     * Returns empty string for other dialog types.
+     *
+     * @see https://playwright.dev/docs/api/class-dialog#dialog-default-value
+     */
+    defaultValue() {
+        return this._defaultValue;
+    }
+    /**
+     * Returns the message displayed in the dialog.
+     *
+     * @see https://playwright.dev/docs/api/class-dialog#dialog-message
+     */
+    message() {
+        return this._message;
+    }
+    /**
+     * Returns the page that initiated the dialog, or null if not available.
+     *
+     * @see https://playwright.dev/docs/api/class-dialog#dialog-page
+     */
+    page() {
+        return this._page;
+    }
+    /**
+     * Returns the type of the dialog.
+     *
+     * @remarks
+     * One of 'alert', 'beforeunload', 'confirm', or 'prompt'.
+     *
+     * @see https://playwright.dev/docs/api/class-dialog#dialog-type
+     */
+    type() {
+        return this._type;
+    }
+}

package/dist/drivers/playwright/generated/element-handle.d.ts

@@ -0,0 +1,399 @@
+/**
+ * AUTO-GENERATED FILE - DO NOT EDIT
+ *
+ * Generated from: packages/automation-spec/src/drivers/playwright/methods/
+ * Run `pnpm generate:playwright` to regenerate.
+ */
+import type { SimpleRpcSender } from '../../../internal/transport.js';
+import { RemoteBase } from '../remote-base.js';
+import type { PlaywrightBoundingBox, PlaywrightCheckOptions, PlaywrightClickOptions, PlaywrightElementState, PlaywrightEventInit, PlaywrightFilePayload, PlaywrightFillOptions, PlaywrightHoverOptions, PlaywrightPressOptions, PlaywrightSelectOption, PlaywrightSelectOptionOptions, PlaywrightSetInputFilesOptions, PlaywrightTapOptions, PlaywrightTimeoutOptions, PlaywrightTypeOptions, PlaywrightWaitForSelectorOptions } from '../types.js';
+import type { RemotePlaywrightFrame } from './frame.js';
+import type { RemotePlaywrightJSHandle } from './js-handle.js';
+/**
+ * RemotePlaywrightElementHandle - Remote Playwright ElementHandle API over RPC.
+ *
+ * @see https://playwright.dev/docs/api/class-elementhandle
+ */
+export declare class RemotePlaywrightElementHandle extends RemoteBase {
+    private createElementHandle;
+    private createFrame;
+    private createJSHandle;
+    constructor(id: string, sendRpc: SimpleRpcSender, createElementHandle: (handleId: string) => RemotePlaywrightElementHandle, createFrame: (frameId: string) => RemotePlaywrightFrame, createJSHandle: (handleId: string) => RemotePlaywrightJSHandle);
+    /**
+     * Return this handle as an ElementHandle.
+     * Since this is already an ElementHandle, returns itself.
+     * @see https://playwright.dev/docs/api/class-jshandle#js-handle-as-element
+     */
+    asElement(): RemotePlaywrightElementHandle | null;
+    /**
+     * Click the element.
+     *
+     * @remarks
+     * This method clicks the element by performing actionability checks, scrolling into view, and simulating a mouse click. Discouraged in favor of locator.click().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-click
+     */
+    click(options?: PlaywrightClickOptions): Promise<void>;
+    /**
+     * Double-click the element.
+     *
+     * @remarks
+     * Discouraged in favor of locator.dblclick().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-dblclick
+     */
+    dblclick(options?: PlaywrightClickOptions): Promise<void>;
+    /**
+     * Fill an input, textarea, or contenteditable element with the specified value.
+     *
+     * @remarks
+     * This method waits for actionability checks, focuses the element, fills it, and triggers an input event. Pass empty string to clear. Discouraged in favor of locator.fill().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-fill
+     */
+    fill(value: string, options?: PlaywrightFillOptions): Promise<void>;
+    /**
+     * Focus the element and type text into it character by character.
+     *
+     * @remarks
+     * Deprecated: In most cases use locator.fill() instead. Only use this for special keyboard handling. For special keys use press().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-type
+     */
+    type(text: string, options?: PlaywrightTypeOptions): Promise<void>;
+    /**
+     * Focus the element and press a key or key combination.
+     *
+     * @remarks
+     * Key can be a single character or a special key like "Enter", "Control+a", "Shift+ArrowDown". Discouraged in favor of locator.press().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-press
+     */
+    press(key: string, options?: PlaywrightPressOptions): Promise<void>;
+    /**
+     * Hover over the element.
+     *
+     * @remarks
+     * This method hovers over the element by performing actionability checks, scrolling into view, and simulating mouse hover. Discouraged in favor of locator.hover().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-hover
+     */
+    hover(options?: PlaywrightHoverOptions): Promise<void>;
+    /**
+     * Focus the element.
+     *
+     * @remarks
+     * Discouraged in favor of locator.focus().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-focus
+     */
+    focus(): Promise<void>;
+    /**
+     * Tap the element (for touch devices).
+     *
+     * @remarks
+     * This method taps the element by performing actionability checks, scrolling into view, centering, and dispatching touchstart/touchend events. Discouraged in favor of locator.tap().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-tap
+     */
+    tap(options?: PlaywrightTapOptions): Promise<void>;
+    /**
+     * Check a checkbox or radio element.
+     *
+     * @remarks
+     * If the element is already checked, this method returns immediately. Discouraged in favor of locator.check().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-check
+     */
+    check(options?: PlaywrightCheckOptions): Promise<void>;
+    /**
+     * Uncheck a checkbox element.
+     *
+     * @remarks
+     * If the element is already unchecked, this method returns immediately. Discouraged in favor of locator.uncheck().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-uncheck
+     */
+    uncheck(options?: PlaywrightCheckOptions): Promise<void>;
+    /**
+     * Check or uncheck a checkbox or radio element.
+     *
+     * @remarks
+     * Discouraged in favor of locator.setChecked().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-set-checked
+     */
+    setChecked(checked: boolean, options?: PlaywrightCheckOptions): Promise<void>;
+    /**
+     * Select one or more options in a <select> element.
+     * @param values - Options to select. Can be value, label, or option object.
+     * @returns An array of selected option values.
+     *
+     * @remarks
+     * Discouraged in favor of locator.selectOption().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-select-option
+     */
+    selectOption(values: string | string[] | PlaywrightSelectOption | PlaywrightSelectOption[], options?: PlaywrightSelectOptionOptions): Promise<string[]>;
+    /**
+     * Set the files for a file input element.
+     * @param files - File paths or file payloads to upload.
+     *
+     * @remarks
+     * Sets the value of the file input to these file paths or files. If some paths are relative, they are resolved relative to the current working directory. Clears selected files if empty array is passed. Discouraged in favor of locator.setInputFiles().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-set-input-files
+     */
+    setInputFiles(files: string | string[] | PlaywrightFilePayload | PlaywrightFilePayload[], options?: PlaywrightSetInputFilesOptions): Promise<void>;
+    /**
+     * Scroll the element into view if not already visible.
+     *
+     * @remarks
+     * If the element is detached from DOM, throws an error. Discouraged in favor of locator.scrollIntoViewIfNeeded().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-scroll-into-view-if-needed
+     */
+    scrollIntoViewIfNeeded(options?: PlaywrightTimeoutOptions): Promise<void>;
+    /**
+     * Dispatch a DOM event on the element.
+     * @param type - DOM event type, e.g., "click".
+     * @param eventInit - Event-specific initialization properties.
+     *
+     * @remarks
+     * The event is composed, cancelable and bubbles by default. Regardless of visibility, this will dispatch the event. Discouraged in favor of locator.dispatchEvent().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-dispatch-event
+     */
+    dispatchEvent(type: string, eventInit?: PlaywrightEventInit): Promise<void>;
+    /**
+     * Get the innerHTML of the element.
+     *
+     * @remarks
+     * Discouraged in favor of locator.innerHTML().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-inner-html
+     */
+    innerHTML(): Promise<string>;
+    /**
+     * Get the innerText of the element.
+     *
+     * @remarks
+     * Discouraged in favor of locator.innerText().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-inner-text
+     */
+    innerText(): Promise<string>;
+    /**
+     * Get the textContent of the element.
+     *
+     * @remarks
+     * Discouraged in favor of locator.textContent().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-text-content
+     */
+    textContent(): Promise<string | null>;
+    /**
+     * Get an attribute value of the element.
+     * @param name - Attribute name to get.
+     *
+     * @remarks
+     * Discouraged in favor of locator.getAttribute().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-get-attribute
+     */
+    getAttribute(name: string): Promise<string | null>;
+    /**
+     * Get the input value for input, textarea, or select elements.
+     *
+     * @remarks
+     * Throws for non-input elements. Discouraged in favor of locator.inputValue().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-input-value
+     */
+    inputValue(options?: PlaywrightTimeoutOptions): Promise<string>;
+    /**
+     * Check if the element is visible.
+     *
+     * @remarks
+     * Returns true if element is visible. Non-attached elements return false. Discouraged in favor of locator.isVisible().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-is-visible
+     */
+    isVisible(): Promise<boolean>;
+    /**
+     * Check if the element is hidden.
+     *
+     * @remarks
+     * Returns true if element is hidden. Non-attached elements return true. Discouraged in favor of locator.isHidden().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-is-hidden
+     */
+    isHidden(): Promise<boolean>;
+    /**
+     * Check if the element is enabled.
+     *
+     * @remarks
+     * Discouraged in favor of locator.isEnabled().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-is-enabled
+     */
+    isEnabled(): Promise<boolean>;
+    /**
+     * Check if the element is disabled.
+     *
+     * @remarks
+     * Discouraged in favor of locator.isDisabled().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-is-disabled
+     */
+    isDisabled(): Promise<boolean>;
+    /**
+     * Check if a checkbox or radio is checked.
+     *
+     * @remarks
+     * Throws if element is not a checkbox or radio. Discouraged in favor of locator.isChecked().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-is-checked
+     */
+    isChecked(): Promise<boolean>;
+    /**
+     * Check if the element is editable.
+     *
+     * @remarks
+     * Discouraged in favor of locator.isEditable().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-is-editable
+     */
+    isEditable(): Promise<boolean>;
+    /**
+     * Get the bounding box of the element.
+     * @returns Bounding box with x, y, width, height, or null if element is not visible.
+     *
+     * @remarks
+     * Discouraged in favor of locator.boundingBox().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-bounding-box
+     */
+    boundingBox(): Promise<PlaywrightBoundingBox | null>;
+    /**
+     * Get the content frame for iframe elements.
+     * @returns The frame content, or null if not an iframe.
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-content-frame
+     */
+    contentFrame(): Promise<RemotePlaywrightFrame | null>;
+    /**
+     * Get the frame that owns this element.
+     * @returns The owner frame, or null if element is detached.
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-owner-frame
+     */
+    ownerFrame(): Promise<RemotePlaywrightFrame | null>;
+    /**
+     * Evaluate a function in the context of the element.
+     * @param pageFunction - Function or string to evaluate in the page context.
+     * @param arg - Argument to pass to the function.
+     *
+     * @remarks
+     * The element is passed as the first argument to the function. If the function returns a Promise, it will be awaited.
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-evaluate
+     */
+    evaluate<R = unknown, Arg = unknown>(pageFunction: string | ((element: Element, arg: Arg) => R | Promise<R>), arg?: unknown): Promise<R>;
+    /**
+     * Evaluate a function and return a JSHandle to the result.
+     * @param pageFunction - Function or string to evaluate in the page context.
+     * @param arg - Argument to pass to the function.
+     *
+     * @remarks
+     * The element is passed as the first argument. Note: Returns serialized handle reference. Full JSHandle support not yet available.
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-evaluate-handle
+     */
+    evaluateHandle<R = unknown, Arg = unknown>(pageFunction: string | ((element: Element, arg: Arg) => R | Promise<R>), arg?: unknown): Promise<unknown>;
+    /**
+     * Query for a child element matching the selector.
+     * @returns The matching element or null if not found.
+     *
+     * @remarks
+     * Discouraged in favor of locator-based locator.locator().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-query-selector
+     */
+    $(selector: string): Promise<RemotePlaywrightElementHandle | null>;
+    /**
+     * Query for all child elements matching the selector.
+     * @returns An array of matching elements.
+     *
+     * @remarks
+     * Discouraged in favor of locator-based locator.locator().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-query-selector-all
+     */
+    $$(selector: string): Promise<RemotePlaywrightElementHandle[]>;
+    /**
+     * Evaluate a function on a child element matching the selector.
+     *
+     * @remarks
+     * Throws if no element matches. Discouraged in favor of locator.evaluate().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-eval-on-selector
+     */
+    $eval<R = unknown, Arg = unknown>(selector: string, pageFunction: string | ((element: Element, arg: Arg) => R | Promise<R>), arg?: unknown): Promise<R>;
+    /**
+     * Evaluate a function on all child elements matching the selector.
+     *
+     * @remarks
+     * Discouraged in favor of locator.evaluateAll().
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-eval-on-selector-all
+     */
+    $$eval<R = unknown, Arg = unknown>(selector: string, pageFunction: string | ((elements: Element[], arg: Arg) => R | Promise<R>), arg?: unknown): Promise<R>;
+    /**
+     * Wait for the element to reach a specific state.
+     * @param state - State to wait for: "visible", "hidden", "stable", "enabled", or "disabled".
+     *
+     * @remarks
+     * Discouraged in favor of web-first assertions.
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-wait-for-element-state
+     */
+    waitForElementState(state: PlaywrightElementState, options?: PlaywrightTimeoutOptions): Promise<void>;
+    /**
+     * Wait for a child element matching the selector.
+     * @returns The matching element, or null if waiting for hidden/detached.
+     *
+     * @remarks
+     * Discouraged in favor of locator-based assertions.
+     *
+     * @see https://playwright.dev/docs/api/class-elementhandle#element-handle-wait-for-selector
+     */
+    waitForSelector(selector: string, options?: PlaywrightWaitForSelectorOptions): Promise<RemotePlaywrightElementHandle | null>;
+    /**
+     * Dispose of the handle, releasing it from the browser.
+     *
+     * @remarks
+     * After disposal, any method calls will throw. The SDK sets the disposed flag before the RPC call to prevent race conditions.
+     *
+     * @see https://playwright.dev/docs/api/class-jshandle#js-handle-dispose
+     */
+    dispose(): Promise<void>;
+    /**
+     * Get a JSHandle for a property of this element.
+     *
+     * @remarks
+     * Note: Returns serialized handle reference. Full JSHandle support not yet available.
+     *
+     * @see https://playwright.dev/docs/api/class-jshandle#js-handle-get-property
+     */
+    getProperty(propertyName: string): Promise<unknown>;
+    /**
+     * Get the JSON value of the element.
+     *
+     * @remarks
+     * Throws if the object cannot be serialized to JSON (e.g., DOM nodes).
+     *
+     * @see https://playwright.dev/docs/api/class-jshandle#js-handle-json-value
+     */
+    jsonValue<T = unknown>(): Promise<T>;
+}