@bctrl/sdk 1.0.1 → 1.0.3

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

@@ -1,557 +0,0 @@
-/**
- * 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 { SerializedHandle } from '../../../internal/serialization.js';
-import { RemoteBase } from '../remote-base.js';
-import type { PlaywrightCheckOptions, PlaywrightClickOptions, PlaywrightFillOptions, PlaywrightFocusOptions, PlaywrightGetAttributeOptions, PlaywrightGetByAltTextOptions, PlaywrightGetByLabelOptions, PlaywrightGetByPlaceholderOptions, PlaywrightGetByRoleOptions, PlaywrightGetByTextOptions, PlaywrightGetByTitleOptions, PlaywrightGotoOptions, PlaywrightHoverOptions, PlaywrightInnerHTMLOptions, PlaywrightInnerTextOptions, PlaywrightInputValueOptions, PlaywrightIsOptions, PlaywrightPressOptions, PlaywrightSelectOptionOptions, PlaywrightTextContentOptions, PlaywrightTypeOptions, PlaywrightWaitForSelectorOptions, PlaywrightWaitForURLOptions } from '../types.js';
-import type { RemotePlaywrightElementHandle } from './element-handle.js';
-import type { RemotePlaywrightJSHandle } from './js-handle.js';
-import type { RemotePlaywrightLocator } from './locator.js';
-import type { RemotePlaywrightFrameLocator } from './frame-locator.js';
-import type { RemotePlaywrightPage } from './page.js';
-/**
- * RemotePlaywrightFrame - Remote Playwright Frame API over RPC.
- *
- * @see https://playwright.dev/docs/api/class-frame
- */
-export declare class RemotePlaywrightFrame extends RemoteBase {
-    /** Whether this frame has been detached. */
-    _isDetached: boolean;
-    private createElementHandle;
-    private createFrame;
-    private createLocator;
-    private createFrameLocator;
-    private createJSHandle;
-    private getPage;
-    constructor(id: string, sendRpc: SimpleRpcSender, createElementHandle: (handleId: string) => RemotePlaywrightElementHandle, createFrame: (frameId: string) => RemotePlaywrightFrame, createLocator: (selector: string) => RemotePlaywrightLocator, createFrameLocator: (selector: string) => RemotePlaywrightFrameLocator, createJSHandle: (handleId: string) => RemotePlaywrightJSHandle, getPage: () => RemotePlaywrightPage);
-    /**
-     * The page associated with this frame.
-     */
-    page(): RemotePlaywrightPage;
-    /**
-     * Creates a Locator for the given selector.
-     */
-    locator(selector: string, options?: {
-        has?: RemotePlaywrightLocator;
-        hasNot?: RemotePlaywrightLocator;
-        hasText?: string | RegExp;
-        hasNotText?: string | RegExp;
-    }): RemotePlaywrightLocator;
-    /**
-     * Returns a FrameLocator for the given selector.
-     */
-    frameLocator(selector: string): RemotePlaywrightFrameLocator;
-    /**
-     * Allows locating elements by their ARIA role, ARIA attributes and accessible name.
-     */
-    getByRole(role: "alert" | "alertdialog" | "application" | "article" | "banner" | "blockquote" | "button" | "caption" | "cell" | "checkbox" | "code" | "columnheader" | "combobox" | "complementary" | "contentinfo" | "definition" | "deletion" | "dialog" | "directory" | "document" | "emphasis" | "feed" | "figure" | "form" | "generic" | "grid" | "gridcell" | "group" | "heading" | "img" | "insertion" | "link" | "list" | "listbox" | "listitem" | "log" | "main" | "marquee" | "math" | "meter" | "menu" | "menubar" | "menuitem" | "menuitemcheckbox" | "menuitemradio" | "navigation" | "none" | "note" | "option" | "paragraph" | "presentation" | "progressbar" | "radio" | "radiogroup" | "region" | "row" | "rowgroup" | "rowheader" | "scrollbar" | "search" | "searchbox" | "separator" | "slider" | "spinbutton" | "status" | "strong" | "subscript" | "superscript" | "switch" | "tab" | "table" | "tablist" | "tabpanel" | "term" | "textbox" | "time" | "timer" | "toolbar" | "tooltip" | "tree" | "treegrid" | "treeitem", options?: PlaywrightGetByRoleOptions): RemotePlaywrightLocator;
-    /**
-     * Allows locating elements that contain given text.
-     */
-    getByText(text: string | RegExp, options?: PlaywrightGetByTextOptions): RemotePlaywrightLocator;
-    /**
-     * Allows locating input elements by the text of the associated label.
-     */
-    getByLabel(text: string | RegExp, options?: PlaywrightGetByLabelOptions): RemotePlaywrightLocator;
-    /**
-     * Allows locating input elements by the placeholder text.
-     */
-    getByPlaceholder(text: string | RegExp, options?: PlaywrightGetByPlaceholderOptions): RemotePlaywrightLocator;
-    /**
-     * Allows locating elements by their alt text.
-     */
-    getByAltText(text: string | RegExp, options?: PlaywrightGetByAltTextOptions): RemotePlaywrightLocator;
-    /**
-     * Allows locating elements by their title attribute.
-     */
-    getByTitle(text: string | RegExp, options?: PlaywrightGetByTitleOptions): RemotePlaywrightLocator;
-    /**
-     * Locate element by the test id.
-     */
-    getByTestId(testId: string | RegExp): RemotePlaywrightLocator;
-    /**
-     * Evaluates a function in the frame's context and returns a handle to the result.
-     * Note: Returns serialized handle reference. Full JSHandle support not yet available.
-     */
-    evaluateHandle<R = unknown>(pageFunction: string | ((...args: unknown[]) => R | Promise<R>), arg?: unknown): Promise<RemotePlaywrightJSHandle>;
-    /**
-     * Returns when the pageFunction returns a truthy value.
-     * Note: Returns serialized handle reference. Full JSHandle support not yet available.
-     */
-    waitForFunction<R = unknown>(pageFunction: string | ((...args: unknown[]) => R | Promise<R>), arg?: unknown, options?: {
-        timeout?: number;
-        polling?: number | 'raf';
-    }): Promise<RemotePlaywrightJSHandle>;
-    /**
-     * Returns `true` if the frame has been detached, or `false` otherwise.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-is-detached
-     */
-    isDetached(): boolean;
-    /**
-     * Returns the frame element associated with this frame.
-     *
-     * @remarks
-     * Returns the ElementHandle for the <iframe> or <frame> tag for this frame. Returns null for the main frame.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-frame-element
-     */
-    frameElement(): Promise<RemotePlaywrightElementHandle>;
-    /**
-     * Returns frame's URL.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-url
-     */
-    url(): Promise<string>;
-    /**
-     * Returns frame's name attribute as specified in the tag.
-     *
-     * @remarks
-     * If the name is empty, returns the id attribute instead. Returns empty string if both name and id are empty.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-name
-     */
-    name(): Promise<string>;
-    /**
-     * Returns the page title.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-title
-     */
-    title(): Promise<string>;
-    /**
-     * Gets the full HTML contents of the frame, including the doctype.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-content
-     */
-    content(): Promise<string>;
-    /**
-     * Sets the content of the frame.
-     *
-     * @remarks
-     * This method takes the HTML to set as the frame's content. The default waitUntil is 'load'.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-set-content
-     */
-    setContent(html: string, options?: {
-        timeout?: number;
-        waitUntil?: "load" | "domcontentloaded" | "networkidle" | "commit";
-    }): Promise<void>;
-    /**
-     * Parent frame, if any. Detached frames and main frames return null.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-parent-frame
-     */
-    parentFrame(): Promise<RemotePlaywrightFrame | null>;
-    /**
-     * Returns child frames of this frame.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-child-frames
-     */
-    childFrames(): Promise<RemotePlaywrightFrame[]>;
-    /**
-     * Returns the main resource response.
-     *
-     * @remarks
-     * Navigates the frame to the given URL. In case of multiple redirects, the navigation will resolve with the first non-redirect response. The method will throw an error if navigation fails. The method will not throw an error when any valid HTTP status code is returned by the remote server.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-goto
-     */
-    goto(url: string, options?: PlaywrightGotoOptions): Promise<SerializedHandle | null>;
-    /**
-     * Waits for the frame to navigate to the given URL.
-     *
-     * @remarks
-     * This method can be used after an action that causes navigation. A glob pattern, regex pattern or predicate receiving URL to match while waiting for the navigation.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-wait-for-url
-     */
-    waitForURL(url: string | RegExp | ((url: URL) => boolean), options?: PlaywrightWaitForURLOptions): Promise<void>;
-    /**
-     * Waits for the required load state to be reached.
-     * @param state - State to wait for, defaults to load.
-     *
-     * @remarks
-     * This method returns when the page reaches a required load state, 'load' by default. The navigation must have been committed when this method is called.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-wait-for-load-state
-     */
-    waitForLoadState(state?: "load" | "domcontentloaded" | "networkidle", options?: {
-        timeout?: number;
-    }): Promise<void>;
-    /**
-     * Returns the ElementHandle pointing to the frame element.
-     *
-     * @remarks
-     * This method queries the frame for the given selector. If no element matches the selector, returns null. Discouraged: use locator-based frame.locator() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-query-selector
-     */
-    $(selector: string): Promise<RemotePlaywrightElementHandle | null>;
-    /**
-     * Returns the ElementHandles pointing to the frame elements.
-     *
-     * @remarks
-     * This method queries the frame for all elements matching the given selector. Returns empty array if no elements match. Discouraged: use locator-based frame.locator() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-query-selector-all
-     */
-    $$(selector: string): Promise<RemotePlaywrightElementHandle[]>;
-    /**
-     * Returns when element specified by selector satisfies state option.
-     *
-     * @remarks
-     * Returns null if waiting for hidden or detached. Returns the ElementHandle matching the selector in visible/attached states. Discouraged: use locator-based locator.waitFor() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-wait-for-selector
-     */
-    waitForSelector(selector: string, options?: PlaywrightWaitForSelectorOptions): Promise<RemotePlaywrightElementHandle | null>;
-    /**
-     * Waits for the given timeout in milliseconds.
-     *
-     * @remarks
-     * Note: This should never be used in production. Tests that wait for time are inherently flaky. Use Locator actions and web assertions that wait automatically.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-wait-for-timeout
-     */
-    waitForTimeout(timeout: number): Promise<void>;
-    /**
-     * Clicks an element matching selector.
-     *
-     * @remarks
-     * This method waits for actionability checks, scrolls element into view, and then clicks the center of the element. Discouraged: use locator-based locator.click() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-click
-     */
-    click(selector: string, options?: PlaywrightClickOptions): Promise<void>;
-    /**
-     * Double-clicks an element matching selector.
-     *
-     * @remarks
-     * This method waits for actionability checks, scrolls element into view, and then double-clicks the center of the element. Discouraged: use locator-based locator.dblclick() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-dblclick
-     */
-    dblclick(selector: string, options?: PlaywrightClickOptions): Promise<void>;
-    /**
-     * Fills a form field with text.
-     *
-     * @remarks
-     * This method waits for an element matching selector, waits for actionability checks, focuses the element, fills it and triggers an input event. Discouraged: use locator-based locator.fill() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-fill
-     */
-    fill(selector: string, value: string, options?: PlaywrightFillOptions): Promise<void>;
-    /**
-     * Types into an element matching selector.
-     *
-     * @remarks
-     * Sends a keydown, keypress/input, and keyup event for each character in the text. Discouraged: In most cases, you should use locator.fill() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-type
-     */
-    type(selector: string, text: string, options?: PlaywrightTypeOptions): Promise<void>;
-    /**
-     * Presses a key.
-     *
-     * @remarks
-     * Focuses the element matching selector, and then uses keyboard.press. Discouraged: use locator-based locator.press() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-press
-     */
-    press(selector: string, key: string, options?: PlaywrightPressOptions): Promise<void>;
-    /**
-     * Hovers over an element matching selector.
-     *
-     * @remarks
-     * This method waits for actionability checks, scrolls element into view, and then hovers over the center of the element. Discouraged: use locator-based locator.hover() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-hover
-     */
-    hover(selector: string, options?: PlaywrightHoverOptions): Promise<void>;
-    /**
-     * Fetches the element matching selector and focuses it.
-     *
-     * @remarks
-     * If there is no element matching selector, the method waits until a matching element appears in the DOM. Discouraged: use locator-based locator.focus() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-focus
-     */
-    focus(selector: string, options?: PlaywrightFocusOptions): Promise<void>;
-    /**
-     * Taps an element matching selector.
-     *
-     * @remarks
-     * This method waits for actionability checks, scrolls element into view, and then taps the center of the element. Discouraged: use locator-based locator.tap() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-tap
-     */
-    tap(selector: string, options?: {
-        force?: boolean;
-        modifiers?: ("Alt" | "Control" | "Meta" | "Shift")[];
-        noWaitAfter?: boolean;
-        position?: {
-            x: number;
-            y: number;
-        };
-        strict?: boolean;
-        timeout?: number;
-        trial?: boolean;
-    }): Promise<void>;
-    /**
-     * Checks a checkbox or radio element.
-     *
-     * @remarks
-     * This method checks an element matching selector by performing the following steps: scrolls element into view, and then uses click to check the element. Discouraged: use locator-based locator.check() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-check
-     */
-    check(selector: string, options?: PlaywrightCheckOptions): Promise<void>;
-    /**
-     * Unchecks a checkbox element.
-     *
-     * @remarks
-     * This method unchecks an element matching selector by scrolling element into view and using click to uncheck the element. Discouraged: use locator-based locator.uncheck() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-uncheck
-     */
-    uncheck(selector: string, options?: PlaywrightCheckOptions): Promise<void>;
-    /**
-     * Checks or unchecks a checkbox or radio element.
-     *
-     * @remarks
-     * This method checks or unchecks an element matching selector. Discouraged: use locator-based locator.setChecked() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-set-checked
-     */
-    setChecked(selector: string, checked: boolean, options?: PlaywrightCheckOptions): Promise<void>;
-    /**
-     * Selects option(s) in the select element.
-     *
-     * @remarks
-     * Returns array of selected option values. Shortcuts such as "blue" match both value and label. Objects such as { label: "blue" } match by label only. Discouraged: use locator-based locator.selectOption() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-select-option
-     */
-    selectOption(selector: string, values: string | string[] | {
-        value?: string;
-        label?: string;
-        index?: number;
-    } | {
-        value?: string;
-        label?: string;
-        index?: number;
-    }[] | null, options?: PlaywrightSelectOptionOptions): Promise<string[]>;
-    /**
-     * Sets the file input element to the given files.
-     *
-     * @remarks
-     * Empty array clears the selected files. Discouraged: use locator-based locator.setInputFiles() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-set-input-files
-     */
-    setInputFiles(selector: string, files: string | string[] | {
-        name: string;
-        mimeType: string;
-        buffer: Buffer;
-    } | {
-        name: string;
-        mimeType: string;
-        buffer: Buffer;
-    }[], options?: {
-        noWaitAfter?: boolean;
-        strict?: boolean;
-        timeout?: number;
-    }): Promise<void>;
-    /**
-     * Drags source element to target element.
-     *
-     * @remarks
-     * This method drags the source element to the target element. It will first move to the source element, perform a mousedown, then move to the target element and perform a mouseup.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-drag-and-drop
-     */
-    dragAndDrop(source: string, target: string, options?: {
-        force?: boolean;
-        noWaitAfter?: boolean;
-        sourcePosition?: {
-            x: number;
-            y: number;
-        };
-        strict?: boolean;
-        targetPosition?: {
-            x: number;
-            y: number;
-        };
-        timeout?: number;
-        trial?: boolean;
-    }): Promise<void>;
-    /**
-     * Dispatches an event on the element.
-     *
-     * @remarks
-     * This method dispatches a DOM event on the element matching selector. Events are composed, cancelable, and bubble by default. Discouraged: use locator-based locator.dispatchEvent() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-dispatch-event
-     */
-    dispatchEvent(selector: string, type: string, eventInit?: unknown, options?: {
-        strict?: boolean;
-        timeout?: number;
-    }): Promise<void>;
-    /**
-     * Returns the element.textContent.
-     *
-     * @remarks
-     * Discouraged: use locator-based locator.textContent() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-text-content
-     */
-    textContent(selector: string, options?: PlaywrightTextContentOptions): Promise<string | null>;
-    /**
-     * Returns the element.innerText.
-     *
-     * @remarks
-     * Discouraged: use locator-based locator.innerText() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-inner-text
-     */
-    innerText(selector: string, options?: PlaywrightInnerTextOptions): Promise<string>;
-    /**
-     * Returns the element.innerHTML.
-     *
-     * @remarks
-     * Discouraged: use locator-based locator.innerHTML() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-inner-html
-     */
-    innerHTML(selector: string, options?: PlaywrightInnerHTMLOptions): Promise<string>;
-    /**
-     * Returns element attribute value.
-     *
-     * @remarks
-     * Discouraged: use locator-based locator.getAttribute() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-get-attribute
-     */
-    getAttribute(selector: string, name: string, options?: PlaywrightGetAttributeOptions): Promise<string | null>;
-    /**
-     * Returns input.value for the selected <input> or <textarea> or <select> element.
-     *
-     * @remarks
-     * Throws for non-input elements. Discouraged: use locator-based locator.inputValue() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-input-value
-     */
-    inputValue(selector: string, options?: PlaywrightInputValueOptions): Promise<string>;
-    /**
-     * Returns whether the element is checked.
-     *
-     * @remarks
-     * Throws if the element is not a checkbox or radio input. Discouraged: use locator-based locator.isChecked() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-is-checked
-     */
-    isChecked(selector: string, options?: PlaywrightIsOptions): Promise<boolean>;
-    /**
-     * Returns whether the element is disabled.
-     *
-     * @remarks
-     * Discouraged: use locator-based locator.isDisabled() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-is-disabled
-     */
-    isDisabled(selector: string, options?: PlaywrightIsOptions): Promise<boolean>;
-    /**
-     * Returns whether the element is editable.
-     *
-     * @remarks
-     * Discouraged: use locator-based locator.isEditable() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-is-editable
-     */
-    isEditable(selector: string, options?: PlaywrightIsOptions): Promise<boolean>;
-    /**
-     * Returns whether the element is enabled.
-     *
-     * @remarks
-     * Discouraged: use locator-based locator.isEnabled() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-is-enabled
-     */
-    isEnabled(selector: string, options?: PlaywrightIsOptions): Promise<boolean>;
-    /**
-     * Returns whether the element is hidden.
-     *
-     * @remarks
-     * Opposite of isVisible(). Discouraged: use locator-based locator.isHidden() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-is-hidden
-     */
-    isHidden(selector: string, options?: PlaywrightIsOptions): Promise<boolean>;
-    /**
-     * Returns whether the element is visible.
-     *
-     * @remarks
-     * Element is considered visible if it has non-zero bounding box and is not visibility:hidden. Discouraged: use locator-based locator.isVisible() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-is-visible
-     */
-    isVisible(selector: string, options?: PlaywrightIsOptions): Promise<boolean>;
-    /**
-     * Evaluates JavaScript in the frame context.
-     *
-     * @remarks
-     * Returns the return value of pageFunction. If the function returns a Promise, evaluate will wait for that Promise to resolve and return its value.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-evaluate
-     */
-    evaluate<R = unknown>(pageFunction: string | ((...args: unknown[]) => R | Promise<R>), arg?: unknown): Promise<R>;
-    /**
-     * Finds an element matching selector and passes it to pageFunction.
-     *
-     * @remarks
-     * Returns the value of pageFunction. Throws if selector matches no elements. Discouraged: use locator-based locator.evaluate() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-eval-on-selector
-     */
-    $eval<R = unknown>(selector: string, pageFunction: string | ((element: Element, ...args: unknown[]) => R | Promise<R>), arg?: unknown): Promise<R>;
-    /**
-     * Finds all elements matching selector and passes them to pageFunction.
-     *
-     * @remarks
-     * Returns the value of pageFunction. Discouraged: use locator-based locator.evaluateAll() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-eval-on-selector-all
-     */
-    $$eval<R = unknown>(selector: string, pageFunction: string | ((elements: Element[], ...args: unknown[]) => R | Promise<R>), arg?: unknown): Promise<R>;
-    /**
-     * Adds a <script> tag into the page with the desired url or content.
-     *
-     * @remarks
-     * Returns the added tag when the script's onload fires or when the script content was injected into frame.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-add-script-tag
-     */
-    addScriptTag(options?: {
-        content?: string;
-        path?: string;
-        type?: string;
-        url?: string;
-    }): Promise<RemotePlaywrightElementHandle>;
-    /**
-     * Adds a <style> tag into the page with the desired url or content.
-     *
-     * @remarks
-     * Returns the added tag when the stylesheet's onload fires or when the CSS content was injected into frame.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-add-style-tag
-     */
-    addStyleTag(options?: {
-        content?: string;
-        path?: string;
-        url?: string;
-    }): Promise<RemotePlaywrightElementHandle>;
-}