@bctrl/sdk 1.0.1

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

@@ -0,0 +1,221 @@
+/**
+ * AUTO-GENERATED FILE - DO NOT EDIT
+ *
+ * Generated from: packages/automation-spec/src/drivers/puppeteer/methods/puppeteer-methods.ts
+ * Run `pnpm generate:puppeteer` to regenerate.
+ */
+import type { SimpleRpcSender } from '../../../internal/transport.js';
+import { RemoteBase } from '../remote-base.js';
+import type { PuppeteerClickOptions, PuppeteerFrameAddScriptTagOptions, PuppeteerFrameAddStyleTagOptions, PuppeteerGotoOptions, PuppeteerHTTPResponse, PuppeteerKeyboardTypeOptions, PuppeteerWaitForNavigationOptions, PuppeteerWaitForSelectorOptions } from '../types.js';
+import type { RemotePuppeteerElementHandle } from './element-handle.js';
+import type { RemotePuppeteerJSHandle } from './js-handle.js';
+import type { RemotePuppeteerLocator } from './locator.js';
+import type { RemotePuppeteerPage } from './page.js';
+/**
+ * RemotePuppeteerFrame - Remote Puppeteer Frame API over RPC.
+ *
+ * @see https://pptr.dev/api/puppeteer.frame
+ */
+export declare class RemotePuppeteerFrame extends RemoteBase {
+    /** Whether this frame has been detached. */
+    _isDetached: boolean;
+    private createElementHandle;
+    private createFrame;
+    private createLocator;
+    private createJSHandle;
+    private getPage;
+    constructor(id: string, sendRpc: SimpleRpcSender, createElementHandle: (handleId: string) => RemotePuppeteerElementHandle, createFrame: (frameId: string) => RemotePuppeteerFrame, createLocator: (selector: string) => RemotePuppeteerLocator, createJSHandle: (handleId: string) => RemotePuppeteerJSHandle, getPage: () => RemotePuppeteerPage);
+    /**
+     * The page associated with this frame.
+     */
+    page(): RemotePuppeteerPage;
+    /**
+     * Creates a Locator for the given selector.
+     */
+    locator(selector: string): RemotePuppeteerLocator;
+    /**
+     * Evaluates a function in the frame's context and returns a handle to the result.
+     */
+    evaluateHandle<Params extends unknown[] = unknown[], Func extends (...args: Params) => unknown = (...args: Params) => unknown>(pageFunction: Func | string, ...args: Params): Promise<RemotePuppeteerJSHandle<Awaited<ReturnType<Func>>>>;
+    /**
+     * Wait for a function to return a truthy value.
+     */
+    waitForFunction<Params extends unknown[] = unknown[], Func extends (...args: Params) => unknown = (...args: Params) => unknown>(pageFunction: Func | string, options?: {
+        timeout?: number;
+        polling?: number | 'raf' | 'mutation';
+    }, ...args: Params): Promise<RemotePuppeteerJSHandle<Awaited<ReturnType<Func>>>>;
+    /**
+     * Is `true` if the frame has been detached. Otherwise, `false`.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.detached
+     */
+    detached(): boolean;
+    /**
+     * Whether this frame is detached.
+     *
+     * @remarks
+     * @deprecated Use the `detached` getter.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.isdetached
+     */
+    isDetached(): boolean;
+    /**
+     * The frame element associated with this frame, if any.
+     *
+     * @remarks
+     * Returns the ElementHandle for the <iframe> or <frame> tag for this frame. Returns null for the main frame.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.frameelement
+     */
+    frameElement(): Promise<RemotePuppeteerElementHandle | null>;
+    /**
+     * The frame's URL.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.url
+     */
+    url(): Promise<string>;
+    /**
+     * The frame's name attribute as specified in the tag.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.name
+     */
+    name(): Promise<string>;
+    /**
+     * The frame's title.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.title
+     */
+    title(): Promise<string>;
+    /**
+     * The full HTML contents of the frame.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.content
+     */
+    content(): Promise<string>;
+    /**
+     * Set the content of the frame.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.setcontent
+     */
+    setContent(html: string, options?: {
+        timeout?: number;
+        waitUntil?: string;
+    }): Promise<void>;
+    /**
+     * The parent frame, if any.
+     *
+     * @remarks
+     * Returns null for the main frame.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.parentframe
+     */
+    parentFrame(): Promise<RemotePuppeteerFrame | null>;
+    /**
+     * Child frames of this frame.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.childframes
+     */
+    childFrames(): Promise<RemotePuppeteerFrame[]>;
+    /**
+     * Is this the main frame?
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.ismainframe
+     */
+    isMainFrame(): Promise<boolean>;
+    /**
+     * Navigate the frame to a URL.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.goto
+     */
+    goto(url: string, options?: PuppeteerGotoOptions): Promise<PuppeteerHTTPResponse | null>;
+    /**
+     * Wait for navigation to complete.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.waitfornavigation
+     */
+    waitForNavigation(options?: PuppeteerWaitForNavigationOptions): Promise<PuppeteerHTTPResponse | null>;
+    /**
+     * Query for a single element.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame._
+     */
+    $(selector: string): Promise<RemotePuppeteerElementHandle | null>;
+    /**
+     * Query for all matching elements.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.__
+     */
+    $$(selector: string): Promise<RemotePuppeteerElementHandle[]>;
+    /**
+     * Wait for a selector to appear.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.waitforselector
+     */
+    waitForSelector(selector: string, options?: PuppeteerWaitForSelectorOptions): Promise<RemotePuppeteerElementHandle | null>;
+    /**
+     * Click on an element.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.click
+     */
+    click(selector: string, options?: PuppeteerClickOptions): Promise<void>;
+    /**
+     * Type text into an element.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.type
+     */
+    type(selector: string, text: string, options?: PuppeteerKeyboardTypeOptions): Promise<void>;
+    /**
+     * Focus on an element.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.focus
+     */
+    focus(selector: string): Promise<void>;
+    /**
+     * Hover over an element.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.hover
+     */
+    hover(selector: string): Promise<void>;
+    /**
+     * Select options in a <select> element.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.select
+     */
+    select(selector: string, ...values: string[]): Promise<string[]>;
+    /**
+     * Tap on an element.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.tap
+     */
+    tap(selector: string): Promise<void>;
+    /**
+     * Evaluate JavaScript in the frame context.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.evaluate
+     */
+    evaluate<T = unknown>(pageFunction: string | ((...args: unknown[]) => T | Promise<T>), ...args: unknown[]): Promise<T>;
+    /**
+     * Evaluate JavaScript on a selected element.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame._eval
+     */
+    $eval<T = unknown>(selector: string, pageFunction: string | ((el: Element, ...args: unknown[]) => T | Promise<T>), ...args: unknown[]): Promise<T>;
+    /**
+     * Evaluate JavaScript on all matching elements.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.__eval
+     */
+    $$eval<T = unknown>(selector: string, pageFunction: string | ((els: Element[], ...args: unknown[]) => T | Promise<T>), ...args: unknown[]): Promise<T>;
+    /**
+     * Add a script tag to the frame.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.addscripttag
+     */
+    addScriptTag(options: PuppeteerFrameAddScriptTagOptions): Promise<RemotePuppeteerElementHandle>;
+    /**
+     * Add a style tag to the frame.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.addstyletag
+     */
+    addStyleTag(options: PuppeteerFrameAddStyleTagOptions): Promise<RemotePuppeteerElementHandle>;
+}

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

@@ -0,0 +1,302 @@
+/**
+ * AUTO-GENERATED FILE - DO NOT EDIT
+ *
+ * Generated from: packages/automation-spec/src/drivers/puppeteer/methods/puppeteer-methods.ts
+ * Run `pnpm generate:puppeteer` to regenerate.
+ */
+import { serializeFunctionSource } from '../../../internal/transport.js';
+import { RemoteBase } from '../remote-base.js';
+/**
+ * RemotePuppeteerFrame - Remote Puppeteer Frame API over RPC.
+ *
+ * @see https://pptr.dev/api/puppeteer.frame
+ */
+export class RemotePuppeteerFrame extends RemoteBase {
+    /** Whether this frame has been detached. */
+    _isDetached;
+    createElementHandle;
+    createFrame;
+    createLocator;
+    createJSHandle;
+    getPage;
+    constructor(id, sendRpc, createElementHandle, createFrame, createLocator, createJSHandle, getPage) {
+        super(id, sendRpc);
+        this.createElementHandle = createElementHandle;
+        this.createFrame = createFrame;
+        this.createLocator = createLocator;
+        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) {
+        return this.createLocator(selector);
+    }
+    /**
+     * Evaluates a function in the frame's context and returns a handle to the result.
+     */
+    async evaluateHandle(pageFunction, ...args) {
+        const _pageFunction = serializeFunctionSource(pageFunction);
+        const result = await this.rpc('evaluateHandle', [_pageFunction, ...args]);
+        return this.createJSHandle(result.id);
+    }
+    /**
+     * Wait for a function to return a truthy value.
+     */
+    async waitForFunction(pageFunction, options, ...args) {
+        const _pageFunction = serializeFunctionSource(pageFunction);
+        const result = await this.rpc('waitForFunction', [_pageFunction, options, ...args]);
+        return this.createJSHandle(result.id);
+    }
+    /**
+     * Is `true` if the frame has been detached. Otherwise, `false`.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.detached
+     */
+    detached() {
+        return this._isDetached;
+    }
+    /**
+     * Whether this frame is detached.
+     *
+     * @remarks
+     * @deprecated Use the `detached` getter.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.isdetached
+     */
+    isDetached() {
+        return this._isDetached;
+    }
+    /**
+     * The frame element associated with this frame, if any.
+     *
+     * @remarks
+     * Returns the ElementHandle for the <iframe> or <frame> tag for this frame. Returns null for the main frame.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.frameelement
+     */
+    async frameElement() {
+        const result = await this.rpc('frameElement', []);
+        if (!result)
+            return null;
+        return this.createElementHandle(result.id);
+    }
+    /**
+     * The frame's URL.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.url
+     */
+    async url() {
+        return this.rpc('url', []);
+    }
+    /**
+     * The frame's name attribute as specified in the tag.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.name
+     */
+    async name() {
+        return this.rpc('name', []);
+    }
+    /**
+     * The frame's title.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.title
+     */
+    async title() {
+        return this.rpc('title', []);
+    }
+    /**
+     * The full HTML contents of the frame.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.content
+     */
+    async content() {
+        return this.rpc('content', []);
+    }
+    /**
+     * Set the content of the frame.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.setcontent
+     */
+    async setContent(html, options) {
+        await this.rpc('setContent', [html, options]);
+    }
+    /**
+     * The parent frame, if any.
+     *
+     * @remarks
+     * Returns null for the main frame.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.parentframe
+     */
+    async parentFrame() {
+        const result = await this.rpc('parentFrame', []);
+        if (!result)
+            return null;
+        return this.createFrame(result.id);
+    }
+    /**
+     * Child frames of this frame.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.childframes
+     */
+    async childFrames() {
+        const results = await this.rpc('childFrames', []);
+        return results.map((r) => this.createFrame(r.id));
+    }
+    /**
+     * Is this the main frame?
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.ismainframe
+     */
+    async isMainFrame() {
+        return this.rpc('isMainFrame', []);
+    }
+    /**
+     * Navigate the frame to a URL.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.goto
+     */
+    async goto(url, options) {
+        return this.rpc('goto', [url, options]);
+    }
+    /**
+     * Wait for navigation to complete.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.waitfornavigation
+     */
+    async waitForNavigation(options) {
+        return this.rpc('waitForNavigation', [options]);
+    }
+    /**
+     * Query for a single element.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame._
+     */
+    async $(selector) {
+        const result = await this.rpc('$', [selector]);
+        if (!result)
+            return null;
+        return this.createElementHandle(result.id);
+    }
+    /**
+     * Query for all matching elements.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.__
+     */
+    async $$(selector) {
+        const results = await this.rpc('$$', [selector]);
+        return results.map((r) => this.createElementHandle(r.id));
+    }
+    /**
+     * Wait for a selector to appear.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.waitforselector
+     */
+    async waitForSelector(selector, options) {
+        const result = await this.rpc('waitForSelector', [selector, options]);
+        if (!result)
+            return null;
+        return this.createElementHandle(result.id);
+    }
+    /**
+     * Click on an element.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.click
+     */
+    async click(selector, options) {
+        await this.rpc('click', [selector, options]);
+    }
+    /**
+     * Type text into an element.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.type
+     */
+    async type(selector, text, options) {
+        await this.rpc('type', [selector, text, options]);
+    }
+    /**
+     * Focus on an element.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.focus
+     */
+    async focus(selector) {
+        await this.rpc('focus', [selector]);
+    }
+    /**
+     * Hover over an element.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.hover
+     */
+    async hover(selector) {
+        await this.rpc('hover', [selector]);
+    }
+    /**
+     * Select options in a <select> element.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.select
+     */
+    async select(selector, ...values) {
+        return this.rpc('select', [selector, ...values]);
+    }
+    /**
+     * Tap on an element.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.tap
+     */
+    async tap(selector) {
+        await this.rpc('tap', [selector]);
+    }
+    /**
+     * Evaluate JavaScript in the frame context.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.evaluate
+     */
+    async evaluate(pageFunction, ...args) {
+        const _pageFunction = serializeFunctionSource(pageFunction);
+        return this.rpc('evaluate', [_pageFunction, ...args]);
+    }
+    /**
+     * Evaluate JavaScript on a selected element.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame._eval
+     */
+    async $eval(selector, pageFunction, ...args) {
+        const _pageFunction = serializeFunctionSource(pageFunction);
+        return this.rpc('$eval', [selector, _pageFunction, ...args]);
+    }
+    /**
+     * Evaluate JavaScript on all matching elements.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.__eval
+     */
+    async $$eval(selector, pageFunction, ...args) {
+        const _pageFunction = serializeFunctionSource(pageFunction);
+        return this.rpc('$$eval', [selector, _pageFunction, ...args]);
+    }
+    /**
+     * Add a script tag to the frame.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.addscripttag
+     */
+    async addScriptTag(options) {
+        const result = await this.rpc('addScriptTag', [options]);
+        return this.createElementHandle(result.id);
+    }
+    /**
+     * Add a style tag to the frame.
+     *
+     * @see https://pptr.dev/api/puppeteer.frame.addstyletag
+     */
+    async addStyleTag(options) {
+        const result = await this.rpc('addStyleTag', [options]);
+        return this.createElementHandle(result.id);
+    }
+}