@bctrl/sdk 1.0.1 → 1.0.2

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

@@ -1,634 +0,0 @@
-/**
- * AUTO-GENERATED FILE - DO NOT EDIT
- *
- * Generated from: packages/automation-spec/src/drivers/playwright/methods/
- * Run `pnpm generate:playwright` to regenerate.
- */
-import { serializeFunctionSource } from '../../../internal/transport.js';
-import { RemoteBase } from '../remote-base.js';
-/**
- * RemotePlaywrightFrame - Remote Playwright Frame API over RPC.
- *
- * @see https://playwright.dev/docs/api/class-frame
- */
-export class RemotePlaywrightFrame extends RemoteBase {
-    /** Whether this frame has been detached. */
-    _isDetached;
-    createElementHandle;
-    createFrame;
-    createLocator;
-    createFrameLocator;
-    createJSHandle;
-    getPage;
-    constructor(id, sendRpc, createElementHandle, createFrame, createLocator, createFrameLocator, createJSHandle, getPage) {
-        super(id, sendRpc);
-        this.createElementHandle = createElementHandle;
-        this.createFrame = createFrame;
-        this.createLocator = createLocator;
-        this.createFrameLocator = createFrameLocator;
-        this.createJSHandle = createJSHandle;
-        this.getPage = getPage;
-    }
-    /**
-     * The page associated with this frame.
-     */
-    page() {
-        return this.getPage();
-    }
-    /**
-     * Creates a Locator for the given selector.
-     */
-    locator(selector, options) {
-        return this.createLocator(selector);
-    }
-    /**
-     * Returns a FrameLocator for the given selector.
-     */
-    frameLocator(selector) {
-        return this.createFrameLocator(selector);
-    }
-    /**
-     * Allows locating elements by their ARIA role, ARIA attributes and accessible name.
-     */
-    getByRole(role, options) {
-        // Create a special locator with role-based selector
-        return this.createLocator(`role=${role}`);
-    }
-    /**
-     * Allows locating elements that contain given text.
-     */
-    getByText(text, options) {
-        const textStr = text instanceof RegExp ? text.source : text;
-        return this.createLocator(`text=${textStr}`);
-    }
-    /**
-     * Allows locating input elements by the text of the associated label.
-     */
-    getByLabel(text, options) {
-        const textStr = text instanceof RegExp ? text.source : text;
-        return this.createLocator(`label=${textStr}`);
-    }
-    /**
-     * Allows locating input elements by the placeholder text.
-     */
-    getByPlaceholder(text, options) {
-        const textStr = text instanceof RegExp ? text.source : text;
-        return this.createLocator(`placeholder=${textStr}`);
-    }
-    /**
-     * Allows locating elements by their alt text.
-     */
-    getByAltText(text, options) {
-        const textStr = text instanceof RegExp ? text.source : text;
-        return this.createLocator(`alt=${textStr}`);
-    }
-    /**
-     * Allows locating elements by their title attribute.
-     */
-    getByTitle(text, options) {
-        const textStr = text instanceof RegExp ? text.source : text;
-        return this.createLocator(`title=${textStr}`);
-    }
-    /**
-     * Locate element by the test id.
-     */
-    getByTestId(testId) {
-        const testIdStr = testId instanceof RegExp ? testId.source : testId;
-        return this.createLocator(`data-testid=${testIdStr}`);
-    }
-    /**
-     * 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.
-     */
-    async evaluateHandle(pageFunction, arg) {
-        const _pageFunction = serializeFunctionSource(pageFunction);
-        const result = await this.rpc('evaluateHandle', [this.id, _pageFunction, arg]);
-        return this.createJSHandle(result.id);
-    }
-    /**
-     * Returns when the pageFunction returns a truthy value.
-     * Note: Returns serialized handle reference. Full JSHandle support not yet available.
-     */
-    async waitForFunction(pageFunction, arg, options) {
-        const _pageFunction = serializeFunctionSource(pageFunction);
-        const result = await this.rpc('waitForFunction', [this.id, _pageFunction, arg, options]);
-        return this.createJSHandle(result.id);
-    }
-    /**
-     * Returns `true` if the frame has been detached, or `false` otherwise.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-is-detached
-     */
-    isDetached() {
-        return this._isDetached;
-    }
-    /**
-     * 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
-     */
-    async frameElement() {
-        const result = await this.rpc('frameElement', []);
-        return this.createElementHandle(result.id);
-    }
-    /**
-     * Returns frame's URL.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-url
-     */
-    async url() {
-        return this.rpc('url', []);
-    }
-    /**
-     * 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
-     */
-    async name() {
-        return this.rpc('name', []);
-    }
-    /**
-     * Returns the page title.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-title
-     */
-    async title() {
-        return this.rpc('title', []);
-    }
-    /**
-     * Gets the full HTML contents of the frame, including the doctype.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-content
-     */
-    async content() {
-        return this.rpc('content', []);
-    }
-    /**
-     * 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
-     */
-    async setContent(html, options) {
-        await this.rpc('setContent', [html, options]);
-    }
-    /**
-     * Parent frame, if any. Detached frames and main frames return null.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-parent-frame
-     */
-    async parentFrame() {
-        const result = await this.rpc('parentFrame', []);
-        if (!result)
-            return null;
-        return this.createFrame(result.id);
-    }
-    /**
-     * Returns child frames of this frame.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-child-frames
-     */
-    async childFrames() {
-        const results = await this.rpc('childFrames', []);
-        return results.map((r) => this.createFrame(r.id));
-    }
-    /**
-     * 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
-     */
-    async goto(url, options) {
-        return this.rpc('goto', [url, options]);
-    }
-    /**
-     * 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
-     */
-    async waitForURL(url, options) {
-        await this.rpc('waitForURL', [url, options]);
-    }
-    /**
-     * 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
-     */
-    async waitForLoadState(state, options) {
-        await this.rpc('waitForLoadState', [state, options]);
-    }
-    /**
-     * 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
-     */
-    async $(selector) {
-        const result = await this.rpc('$', [selector]);
-        if (!result)
-            return null;
-        return this.createElementHandle(result.id);
-    }
-    /**
-     * 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
-     */
-    async $$(selector) {
-        const results = await this.rpc('$$', [selector]);
-        return results.map((r) => this.createElementHandle(r.id));
-    }
-    /**
-     * 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
-     */
-    async waitForSelector(selector, options) {
-        const result = await this.rpc('waitForSelector', [selector, options]);
-        if (!result)
-            return null;
-        return this.createElementHandle(result.id);
-    }
-    /**
-     * 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
-     */
-    async waitForTimeout(timeout) {
-        await this.rpc('waitForTimeout', [timeout]);
-    }
-    /**
-     * 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
-     */
-    async click(selector, options) {
-        await this.rpc('click', [selector, options]);
-    }
-    /**
-     * 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
-     */
-    async dblclick(selector, options) {
-        await this.rpc('dblclick', [selector, options]);
-    }
-    /**
-     * 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
-     */
-    async fill(selector, value, options) {
-        await this.rpc('fill', [selector, value, options]);
-    }
-    /**
-     * 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
-     */
-    async type(selector, text, options) {
-        await this.rpc('type', [selector, text, options]);
-    }
-    /**
-     * 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
-     */
-    async press(selector, key, options) {
-        await this.rpc('press', [selector, key, options]);
-    }
-    /**
-     * 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
-     */
-    async hover(selector, options) {
-        await this.rpc('hover', [selector, options]);
-    }
-    /**
-     * 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
-     */
-    async focus(selector, options) {
-        await this.rpc('focus', [selector, options]);
-    }
-    /**
-     * 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
-     */
-    async tap(selector, options) {
-        await this.rpc('tap', [selector, options]);
-    }
-    /**
-     * 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
-     */
-    async check(selector, options) {
-        await this.rpc('check', [selector, options]);
-    }
-    /**
-     * 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
-     */
-    async uncheck(selector, options) {
-        await this.rpc('uncheck', [selector, options]);
-    }
-    /**
-     * 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
-     */
-    async setChecked(selector, checked, options) {
-        await this.rpc('setChecked', [selector, checked, options]);
-    }
-    /**
-     * 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
-     */
-    async selectOption(selector, values, options) {
-        return this.rpc('selectOption', [selector, values, options]);
-    }
-    /**
-     * 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
-     */
-    async setInputFiles(selector, files, options) {
-        await this.rpc('setInputFiles', [selector, files, options]);
-    }
-    /**
-     * 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
-     */
-    async dragAndDrop(source, target, options) {
-        await this.rpc('dragAndDrop', [source, target, options]);
-    }
-    /**
-     * 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
-     */
-    async dispatchEvent(selector, type, eventInit, options) {
-        await this.rpc('dispatchEvent', [selector, type, eventInit, options]);
-    }
-    /**
-     * Returns the element.textContent.
-     *
-     * @remarks
-     * Discouraged: use locator-based locator.textContent() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-text-content
-     */
-    async textContent(selector, options) {
-        return this.rpc('textContent', [selector, options]);
-    }
-    /**
-     * Returns the element.innerText.
-     *
-     * @remarks
-     * Discouraged: use locator-based locator.innerText() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-inner-text
-     */
-    async innerText(selector, options) {
-        return this.rpc('innerText', [selector, options]);
-    }
-    /**
-     * Returns the element.innerHTML.
-     *
-     * @remarks
-     * Discouraged: use locator-based locator.innerHTML() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-inner-html
-     */
-    async innerHTML(selector, options) {
-        return this.rpc('innerHTML', [selector, options]);
-    }
-    /**
-     * Returns element attribute value.
-     *
-     * @remarks
-     * Discouraged: use locator-based locator.getAttribute() instead.
-     *
-     * @see https://playwright.dev/docs/api/class-frame#frame-get-attribute
-     */
-    async getAttribute(selector, name, options) {
-        return this.rpc('getAttribute', [selector, name, options]);
-    }
-    /**
-     * 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
-     */
-    async inputValue(selector, options) {
-        return this.rpc('inputValue', [selector, options]);
-    }
-    /**
-     * 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
-     */
-    async isChecked(selector, options) {
-        return this.rpc('isChecked', [selector, options]);
-    }
-    /**
-     * 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
-     */
-    async isDisabled(selector, options) {
-        return this.rpc('isDisabled', [selector, options]);
-    }
-    /**
-     * 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
-     */
-    async isEditable(selector, options) {
-        return this.rpc('isEditable', [selector, options]);
-    }
-    /**
-     * 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
-     */
-    async isEnabled(selector, options) {
-        return this.rpc('isEnabled', [selector, options]);
-    }
-    /**
-     * 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
-     */
-    async isHidden(selector, options) {
-        return this.rpc('isHidden', [selector, options]);
-    }
-    /**
-     * 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
-     */
-    async isVisible(selector, options) {
-        return this.rpc('isVisible', [selector, options]);
-    }
-    /**
-     * 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
-     */
-    async evaluate(pageFunction, arg) {
-        const _pageFunction = serializeFunctionSource(pageFunction);
-        return this.rpc('evaluate', [_pageFunction, arg]);
-    }
-    /**
-     * 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
-     */
-    async $eval(selector, pageFunction, arg) {
-        const _pageFunction = serializeFunctionSource(pageFunction);
-        return this.rpc('$eval', [selector, _pageFunction, arg]);
-    }
-    /**
-     * 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
-     */
-    async $$eval(selector, pageFunction, arg) {
-        const _pageFunction = serializeFunctionSource(pageFunction);
-        return this.rpc('$$eval', [selector, _pageFunction, arg]);
-    }
-    /**
-     * 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
-     */
-    async addScriptTag(options) {
-        const result = await this.rpc('addScriptTag', [options]);
-        return this.createElementHandle(result.id);
-    }
-    /**
-     * 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
-     */
-    async addStyleTag(options) {
-        const result = await this.rpc('addStyleTag', [options]);
-        return this.createElementHandle(result.id);
-    }
-}