@bctrl/sdk 1.0.1

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

@@ -0,0 +1,604 @@
+/**
+ * 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 { PuppeteerEventEmitter } from '../event-emitter.js';
+import { RemotePuppeteerAccessibility } from './accessibility.js';
+import { RemotePuppeteerMouse } from './mouse.js';
+import { RemotePuppeteerKeyboard } from './keyboard.js';
+import { RemotePuppeteerTouchscreen } from './touchscreen.js';
+import { RemotePuppeteerTracing } from './tracing.js';
+import { RemotePuppeteerFrame } from './frame.js';
+import { RemotePuppeteerFileChooser } from './file-chooser.js';
+import { RemotePuppeteerLocator } from './locator.js';
+import { RemotePuppeteerElementHandle } from './element-handle.js';
+import { RemotePuppeteerJSHandle } from './js-handle.js';
+import type { PageEvents, PuppeteerClickOptions, PuppeteerCookie, PuppeteerDevice, PuppeteerGeolocation, PuppeteerGotoOptions, PuppeteerHTTPRequest, PuppeteerHTTPResponse, PuppeteerIdleOverrides, PuppeteerKeyboardTypeOptions, PuppeteerPDFOptions, PuppeteerReloadOptions, PuppeteerScreenshotOptions, PuppeteerSelectValue, PuppeteerSerializedElement, PuppeteerTarget, PuppeteerViewport, PuppeteerWaitForNavigationOptions, PuppeteerWaitForNetworkIdleOptions, PuppeteerWaitForOptions, PuppeteerWebWorker } from '../types.js';
+/**
+ * RemotePuppeteerPage - Remote Puppeteer Page API over RPC.
+ *
+ * @see https://pptr.dev/api/puppeteer.page
+ */
+export declare class RemotePuppeteerPage extends PuppeteerEventEmitter<PageEvents> {
+    readonly accessibility: RemotePuppeteerAccessibility;
+    readonly mouse: RemotePuppeteerMouse;
+    readonly keyboard: RemotePuppeteerKeyboard;
+    readonly touchscreen: RemotePuppeteerTouchscreen;
+    readonly tracing: RemotePuppeteerTracing;
+    private createElementHandle;
+    private createFrame;
+    private createLocator;
+    private createJSHandle;
+    protected sendRpc: SimpleRpcSender;
+    constructor(sendRpc: SimpleRpcSender, id: string, createElementHandle: (handleId: string) => RemotePuppeteerElementHandle, createFrame: (frameId: string) => RemotePuppeteerFrame, createLocator: (selector: string) => RemotePuppeteerLocator, createJSHandle: (handleId: string) => RemotePuppeteerJSHandle);
+    readonly id: string;
+    private _isClosed;
+    private _defaultTimeout;
+    private _defaultNavigationTimeout;
+    private _isDragInterceptionEnabled;
+    get isClosed(): boolean;
+    /**
+     * Mark this page as closed (internal use by browser.close()).
+     */
+    markClosed(): void;
+    private rpc;
+    /**
+     * Close the page.
+     * @see https://pptr.dev/api/puppeteer.page.close
+     */
+    close(): Promise<void>;
+    /**
+     * Take a screenshot (returns base64 string or Buffer).
+     * @see https://pptr.dev/api/puppeteer.page.screenshot
+     */
+    screenshot(options?: PuppeteerScreenshotOptions): Promise<string | Buffer>;
+    /**
+     * Generate a PDF (returns base64 string or Buffer).
+     * @see https://pptr.dev/api/puppeteer.page.pdf
+     */
+    pdf(options?: PuppeteerPDFOptions): Promise<string | Buffer>;
+    /**
+     * Get the main frame.
+     * @see https://pptr.dev/api/puppeteer.page.mainframe
+     */
+    mainFrame(): RemotePuppeteerFrame;
+    /**
+     * Set the default navigation timeout.
+     * @see https://pptr.dev/api/puppeteer.page.setdefaultnavigationtimeout
+     */
+    setDefaultNavigationTimeout(timeout: number): Promise<void>;
+    /**
+     * Set the default timeout.
+     * @see https://pptr.dev/api/puppeteer.page.setdefaulttimeout
+     */
+    setDefaultTimeout(timeout: number): Promise<void>;
+    /**
+     * Get the default navigation timeout.
+     */
+    getDefaultNavigationTimeout(): number;
+    /**
+     * Get the default timeout.
+     */
+    getDefaultTimeout(): number;
+    /**
+     * Create a locator for the given selector.
+     * @see https://pptr.dev/api/puppeteer.page.locator
+     */
+    locator(selector: string): RemotePuppeteerLocator;
+    /**
+     * Check if drag interception is enabled.
+     * @see https://pptr.dev/api/puppeteer.page.isdraginterceptionenabled
+     */
+    isDragInterceptionEnabled(): boolean;
+    /**
+     * Set drag interception.
+     * @see https://pptr.dev/api/puppeteer.page.setdraginterception
+     */
+    setDragInterception(enabled: boolean): Promise<void>;
+    /**
+     * Wait for a file chooser to appear.
+     * @see https://pptr.dev/api/puppeteer.page.waitforfilechooser
+     */
+    waitForFileChooser(options?: {
+        timeout?: number;
+    }): Promise<RemotePuppeteerFileChooser>;
+    /**
+     * Wait for a device prompt (e.g., Bluetooth, USB).
+     * @see https://pptr.dev/api/puppeteer.page.waitfordeviceprompt
+     */
+    waitForDevicePrompt(options?: {
+        timeout?: number;
+    }): Promise<{
+        devices: Array<{
+            name: string;
+            id: string;
+        }>;
+        select: (deviceId: string) => Promise<void>;
+        cancel: () => Promise<void>;
+    }>;
+    /**
+     * Navigate to a URL.
+     * @returns The main resource response, or null if navigating to about:blank.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.goto
+     */
+    goto(url: string, options?: PuppeteerGotoOptions): Promise<PuppeteerHTTPResponse | null>;
+    /**
+     * Reload the page.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.reload
+     */
+    reload(options?: PuppeteerReloadOptions): Promise<PuppeteerHTTPResponse | null>;
+    /**
+     * Navigate back in history.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.goback
+     */
+    goBack(options?: PuppeteerWaitForNavigationOptions): Promise<PuppeteerHTTPResponse | null>;
+    /**
+     * Navigate forward in history.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.goforward
+     */
+    goForward(options?: PuppeteerWaitForNavigationOptions): Promise<PuppeteerHTTPResponse | null>;
+    /**
+     * Wait for navigation to complete.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.waitfornavigation
+     */
+    waitForNavigation(options?: PuppeteerWaitForNavigationOptions): Promise<PuppeteerHTTPResponse | null>;
+    /**
+     * Get the page title.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.title
+     */
+    title(): Promise<string>;
+    /**
+     * Get the current URL.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.url
+     */
+    url(): Promise<string>;
+    /**
+     * Get the full HTML content.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.content
+     */
+    content(): Promise<string>;
+    /**
+     * Set the page content.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.setcontent
+     */
+    setContent(html: string, options?: {
+        timeout?: number;
+        waitUntil?: string;
+    }): Promise<void>;
+    /**
+     * Click on an element matching the selector.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.click
+     */
+    click(selector: string, options?: PuppeteerClickOptions): Promise<void>;
+    /**
+     * Type text into an element.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.type
+     */
+    type(selector: string, text: string, options?: PuppeteerKeyboardTypeOptions): Promise<void>;
+    /**
+     * Focus on an element.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.focus
+     */
+    focus(selector: string): Promise<void>;
+    /**
+     * Hover over an element.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.hover
+     */
+    hover(selector: string): Promise<void>;
+    /**
+     * Select options in a <select> element.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.select
+     */
+    select(selector: string, ...values: (string | PuppeteerSelectValue)[]): Promise<string[]>;
+    /**
+     * Tap on an element (for touch devices).
+     *
+     * @see https://pptr.dev/api/puppeteer.page.tap
+     */
+    tap(selector: string): Promise<void>;
+    /**
+     * Get the text content of an element matching the selector.
+     */
+    textContent(selector: string): Promise<string | null>;
+    /**
+     * Get the inner HTML of an element matching the selector.
+     */
+    innerHTML(selector: string): Promise<string>;
+    /**
+     * Wait for a selector to appear in the DOM.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.waitforselector
+     */
+    waitForSelector(selector: string, options?: PuppeteerWaitForOptions): Promise<RemotePuppeteerElementHandle | null>;
+    /**
+     * Wait for a timeout.
+     *
+     * @remarks
+     * Deprecated: Use `await new Promise(r => setTimeout(r, ms))` instead.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.waitfortimeout
+     */
+    waitForTimeout(milliseconds: number): Promise<void>;
+    /**
+     * Wait for a function to return true.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.waitforfunction
+     */
+    waitForFunction(pageFunction: Function | string, options?: {
+        timeout?: number;
+        polling?: number | "raf";
+    }, ...args: unknown[]): Promise<void>;
+    /**
+     * Wait for network to be idle.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.waitfornetworkidle
+     */
+    waitForNetworkIdle(options?: PuppeteerWaitForNetworkIdleOptions): Promise<void>;
+    /**
+     * Evaluate JavaScript in the page context.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.evaluate
+     */
+    evaluate<T = unknown>(pageFunction: Function | string, ...args: unknown[]): Promise<T>;
+    /**
+     * Evaluate JavaScript on a selected element.
+     *
+     * @see https://pptr.dev/api/puppeteer.page._eval
+     */
+    $eval<T = unknown>(selector: string, pageFunction: Function | string, ...args: unknown[]): Promise<T>;
+    /**
+     * Evaluate JavaScript on all matching elements.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.__eval
+     */
+    $$eval<T = unknown>(selector: string, pageFunction: Function | string, ...args: unknown[]): Promise<T>;
+    /**
+     * Evaluate handle (returns a JSHandle).
+     *
+     * @remarks
+     * Note: Handles are not fully supported in RPC mode - use evaluate instead.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.evaluatehandle
+     */
+    evaluateHandle<T = unknown>(pageFunction: Function | string, ...args: unknown[]): Promise<unknown>;
+    /**
+     * Query for a single element.
+     *
+     * @see https://pptr.dev/api/puppeteer.page._
+     */
+    $(selector: string): Promise<RemotePuppeteerElementHandle | null>;
+    /**
+     * Query for all matching elements.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.__
+     */
+    $$(selector: string): Promise<RemotePuppeteerElementHandle[]>;
+    /**
+     * Evaluate XPath expression.
+     *
+     * @see https://pptr.dev/api/puppeteer.page._x
+     */
+    $x(expression: string): Promise<RemotePuppeteerElementHandle[]>;
+    /**
+     * Set the viewport size. Pass null to reset to default.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.setviewport
+     */
+    setViewport(viewport: PuppeteerViewport | null): Promise<void>;
+    /**
+     * Get the current viewport.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.viewport
+     */
+    viewport(): Promise<PuppeteerViewport | null>;
+    /**
+     * Emulate media type.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.emulatemediatype
+     */
+    emulateMediaType(type?: 'screen' | 'print' | null): Promise<void>;
+    /**
+     * Emulate media features.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.emulatemediafeatures
+     */
+    emulateMediaFeatures(features?: Array<{
+        name: string;
+        value: string;
+    }>): Promise<void>;
+    /**
+     * Emulate timezone.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.emulatetimezone
+     */
+    emulateTimezone(timezoneId?: string): Promise<void>;
+    /**
+     * Emulate vision deficiency.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.emulatevisiondeficiency
+     */
+    emulateVisionDeficiency(type?: 'none' | 'achromatopsia' | 'deuteranopia' | 'protanopia' | 'tritanopia' | 'blurredVision'): Promise<void>;
+    /**
+     * Set geolocation.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.setgeolocation
+     */
+    setGeolocation(geolocation: PuppeteerGeolocation): Promise<void>;
+    /**
+     * Set user agent.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.setuseragent
+     */
+    setUserAgent(userAgent: string): Promise<void>;
+    /**
+     * Set extra HTTP headers.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.setextrahttpheaders
+     */
+    setExtraHTTPHeaders(headers: Record<string, string>): Promise<void>;
+    /**
+     * Get all cookies.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.cookies
+     */
+    cookies(...urls: string[]): Promise<PuppeteerCookie[]>;
+    /**
+     * Set cookies.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.setcookie
+     */
+    setCookie(...cookies: PuppeteerCookie[]): Promise<void>;
+    /**
+     * Delete cookies.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.deletecookie
+     */
+    deleteCookie(...cookies: PuppeteerCookie[]): Promise<void>;
+    /**
+     * Bring page to front.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.bringtofront
+     */
+    bringToFront(): Promise<void>;
+    /**
+     * Create a CDP session.
+     *
+     * @remarks
+     * Note: Returns a session identifier in RPC mode (not a live CDPSession).
+     *
+     * @see https://pptr.dev/api/puppeteer.page.createcdpsession
+     */
+    createCDPSession(): Promise<{
+        sessionId: string;
+    }>;
+    /**
+     * Send a CDP command directly.
+     */
+    sendCDP<T = unknown>(method: string, params?: Record<string, unknown>): Promise<T>;
+    /**
+     * Get metrics.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.metrics
+     */
+    metrics(): Promise<Record<string, number>>;
+    /**
+     * Set JavaScript enabled/disabled.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.setjavascriptenabled
+     */
+    setJavaScriptEnabled(enabled: boolean): Promise<void>;
+    /**
+     * Set cache enabled/disabled.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.setcacheenabled
+     */
+    setCacheEnabled(enabled: boolean): Promise<void>;
+    /**
+     * Set offline mode.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.setofflinemode
+     */
+    setOfflineMode(enabled: boolean): Promise<void>;
+    /**
+     * Emulate network conditions.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.emulatenetworkconditions
+     */
+    emulateNetworkConditions(conditions: {
+        offline: boolean;
+        downloadThroughput: number;
+        uploadThroughput: number;
+        latency: number;
+    } | null): Promise<void>;
+    /**
+     * Add script tag.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.addscripttag
+     */
+    addScriptTag(options: {
+        url?: string;
+        path?: string;
+        content?: string;
+        type?: string;
+    }): Promise<PuppeteerSerializedElement>;
+    /**
+     * Add style tag.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.addstyletag
+     */
+    addStyleTag(options: {
+        url?: string;
+        path?: string;
+        content?: string;
+    }): Promise<PuppeteerSerializedElement>;
+    /**
+     * Set request interception enabled/disabled.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.setrequestinterception
+     */
+    setRequestInterception(enabled: boolean): Promise<void>;
+    /**
+     * Authenticate with HTTP auth.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.authenticate
+     */
+    authenticate(credentials: {
+        username: string;
+        password: string;
+    } | null): Promise<void>;
+    /**
+     * Get all frames.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.frames
+     */
+    frames(): Promise<RemotePuppeteerFrame[]>;
+    /**
+     * Wait for a frame to appear.
+     *
+     * @remarks
+     * Note: Predicate functions are not supported in RPC mode. Use URL string instead.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.waitforframe
+     */
+    waitForFrame(urlOrPredicate: string, options?: {
+        timeout?: number;
+    }): Promise<RemotePuppeteerFrame>;
+    /**
+     * Wait for a specific request.
+     *
+     * @remarks
+     * Note: Predicate functions are not supported in RPC mode. Use URL string instead.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.waitforrequest
+     */
+    waitForRequest(urlOrPredicate: string, options?: {
+        timeout?: number;
+    }): Promise<PuppeteerHTTPRequest>;
+    /**
+     * Wait for a specific response.
+     *
+     * @remarks
+     * Note: Predicate functions are not supported in RPC mode. Use URL string instead.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.waitforresponse
+     */
+    waitForResponse(urlOrPredicate: string, options?: {
+        timeout?: number;
+    }): Promise<PuppeteerHTTPResponse>;
+    /**
+     * Toggle bypassing Content-Security-Policy.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.setbypasscsp
+     */
+    setBypassCSP(enabled: boolean): Promise<void>;
+    /**
+     * Add a script to evaluate when a new document is created.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.evaluateonnewdocument
+     */
+    evaluateOnNewDocument(pageFunction: Function | string, ...args: unknown[]): Promise<{
+        identifier: string;
+    }>;
+    /**
+     * Remove an injected script.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.removescripttoevaluateonnewdocument
+     */
+    removeScriptToEvaluateOnNewDocument(identifier: string): Promise<void>;
+    /**
+     * Remove an exposed function.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.removeexposedfunction
+     */
+    removeExposedFunction(name: string): Promise<void>;
+    /**
+     * Emulate a device (viewport + user agent).
+     *
+     * @see https://pptr.dev/api/puppeteer.page.emulate
+     */
+    emulate(device: PuppeteerDevice): Promise<void>;
+    /**
+     * Emulate CPU throttling.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.emulatecputhrottling
+     */
+    emulateCPUThrottling(factor: number | null): Promise<void>;
+    /**
+     * Emulate idle state.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.emulateidlestate
+     */
+    emulateIdleState(overrides?: PuppeteerIdleOverrides): Promise<void>;
+    /**
+     * Check if JavaScript is enabled.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.isjavascriptenabled
+     */
+    isJavaScriptEnabled(): Promise<boolean>;
+    /**
+     * Check if service worker bypass is enabled.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.isserviceworkerbypassed
+     */
+    isServiceWorkerBypassed(): Promise<boolean>;
+    /**
+     * Set service worker bypass.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.setbypassserviceworker
+     */
+    setBypassServiceWorker(bypass: boolean): Promise<void>;
+    /**
+     * Get the target for this page.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.target
+     */
+    target(): Promise<PuppeteerTarget>;
+    /**
+     * Get all web workers for this page.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.workers
+     */
+    workers(): Promise<PuppeteerWebWorker[]>;
+    /**
+     * Get the window ID.
+     */
+    windowId(): Promise<number>;
+    /**
+     * Resize the page.
+     */
+    resize(options: {
+        width: number;
+        height: number;
+    }): Promise<void>;
+    /**
+     * Query all objects of a given prototype.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.queryobjects
+     */
+    queryObjects(prototypeHandle: RemotePuppeteerElementHandle): Promise<RemotePuppeteerElementHandle>;
+    /**
+     * Open DevTools. Only works in headful mode.
+     *
+     * @see https://pptr.dev/api/puppeteer.page.opendevtools
+     */
+    openDevTools(options?: {
+        docking?: 'right' | 'bottom' | 'left' | 'undocked';
+    }): Promise<void>;
+}