@bctrl/sdk 1.0.1

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

@@ -0,0 +1,261 @@
+/**
+ * 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 { PuppeteerAutofillData, PuppeteerBoundingBox, PuppeteerBoxModel, PuppeteerClickOptions, PuppeteerDragData, PuppeteerKeyPressOptions, PuppeteerKeyboardTypeOptions, PuppeteerOffset, PuppeteerPoint, PuppeteerWaitForSelectorOptions, TouchHandle } from '../types.js';
+import type { RemotePuppeteerFrame } from './frame.js';
+import type { RemotePuppeteerLocator } from './locator.js';
+/**
+ * RemotePuppeteerElementHandle - Remote Puppeteer ElementHandle API over RPC.
+ *
+ * @see https://pptr.dev/api/puppeteer.elementhandle
+ */
+export declare class RemotePuppeteerElementHandle extends RemoteBase {
+    /** The handle ID (alias for id, for compatibility). */
+    handleId: string;
+    private createElementHandle;
+    private createFrame;
+    private createLocator;
+    private createTouchHandle;
+    constructor(id: string, sendRpc: SimpleRpcSender, createElementHandle: (handleId: string) => RemotePuppeteerElementHandle, createFrame: (frameId: string) => RemotePuppeteerFrame, createLocator: (handleId: string) => RemotePuppeteerLocator, createTouchHandle: (touchId: string) => TouchHandle);
+    /**
+     * Click the element.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.click
+     */
+    click(options?: PuppeteerClickOptions): Promise<void>;
+    /**
+     * Hover over the element.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.hover
+     */
+    hover(): Promise<void>;
+    /**
+     * Tap the element (for touch devices).
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.tap
+     */
+    tap(): Promise<void>;
+    /**
+     * Focus the element.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.focus
+     */
+    focus(): Promise<void>;
+    /**
+     * Type text into the element.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.type
+     */
+    type(text: string, options?: PuppeteerKeyboardTypeOptions): Promise<void>;
+    /**
+     * Press a key while focused on the element.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.press
+     */
+    press(key: string, options?: PuppeteerKeyPressOptions): Promise<void>;
+    /**
+     * Select options in a <select> element.
+     * @returns An array of selected option values.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.select
+     */
+    select(...values: string[]): Promise<string[]>;
+    /**
+     * Upload files to a file input element.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.uploadfile
+     */
+    uploadFile(...filePaths: string[]): Promise<void>;
+    /**
+     * Scroll the element into view.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.scrollintoview
+     */
+    scrollIntoView(): Promise<void>;
+    /**
+     * Test if the form is compatible with browser autofill. Currently supports credit card autofill in Chrome headless/headful only.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.autofill
+     */
+    autofill(data: PuppeteerAutofillData): Promise<void>;
+    /**
+     * Query for a child element.
+     * @returns The matching element or null if not found.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle._
+     */
+    $(selector: string): Promise<RemotePuppeteerElementHandle | null>;
+    /**
+     * Query for all matching child elements.
+     * @returns An array of matching elements.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.__
+     */
+    $$(selector: string): Promise<RemotePuppeteerElementHandle[]>;
+    /**
+     * Get a property value.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.getproperty
+     */
+    getProperty<T = unknown>(propertyName: string): Promise<T>;
+    /**
+     * Get the JSON value of the element.
+     *
+     * @see https://pptr.dev/api/puppeteer.jshandle.jsonvalue
+     */
+    jsonValue<T = unknown>(): Promise<T>;
+    /**
+     * Check if the element is visible.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.isvisible
+     */
+    isVisible(): Promise<boolean>;
+    /**
+     * Check if the element is hidden.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.ishidden
+     */
+    isHidden(): Promise<boolean>;
+    /**
+     * Check if the element intersects the viewport.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.isintersectingviewport
+     */
+    isIntersectingViewport(options?: {
+        threshold?: number;
+    }): Promise<boolean>;
+    /**
+     * Get the bounding box of the element.
+     * @returns The bounding box or null if the element is not visible.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.boundingbox
+     */
+    boundingBox(): Promise<PuppeteerBoundingBox | null>;
+    /**
+     * Get the CSS box model of the element.
+     * @returns The box model or null if the element is not visible.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.boxmodel
+     */
+    boxModel(): Promise<PuppeteerBoxModel | null>;
+    /**
+     * Get a clickable point within the element.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.clickablepoint
+     */
+    clickablePoint(offset?: PuppeteerOffset): Promise<PuppeteerPoint>;
+    /**
+     * Evaluate a function in the context of the element.
+     *
+     * @remarks
+     * The element is passed as the first argument to the function.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.evaluate
+     */
+    evaluate<T = unknown>(pageFunction: string | ((element: Element, ...args: unknown[]) => T | Promise<T>), ...args: unknown[]): Promise<T>;
+    /**
+     * Evaluate a function on the first child matching the selector.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle._eval
+     */
+    $eval<T = unknown>(selector: string, pageFunction: string | ((element: Element, ...args: unknown[]) => T | Promise<T>), ...args: unknown[]): Promise<T>;
+    /**
+     * Evaluate a function on all children matching the selector.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.__eval
+     */
+    $$eval<T = unknown>(selector: string, pageFunction: string | ((elements: Element[], ...args: unknown[]) => T | Promise<T>), ...args: unknown[]): Promise<T>;
+    /**
+     * Get the content frame for iframe elements.
+     * @returns The frame or null if not an iframe.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.contentframe
+     */
+    contentFrame(): Promise<RemotePuppeteerFrame | null>;
+    /**
+     * Drag the element to the given target.
+     * @param target - Target point or element to drag to.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.drag
+     */
+    drag(target: PuppeteerPoint | RemotePuppeteerElementHandle): Promise<PuppeteerDragData | void>;
+    /**
+     * Dispatch a dragenter event.
+     *
+     * @remarks
+     * Deprecated: dragenter is automatically performed during dragging.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.dragenter
+     */
+    dragEnter(data?: PuppeteerDragData): Promise<void>;
+    /**
+     * Dispatch a dragover event.
+     *
+     * @remarks
+     * Deprecated: dragover is automatically performed during dragging.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.dragover
+     */
+    dragOver(data?: PuppeteerDragData): Promise<void>;
+    /**
+     * Drag and drop to another element or point.
+     * @param target - Target element or point to drop onto.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.draganddrop
+     */
+    dragAndDrop(target: RemotePuppeteerElementHandle | PuppeteerPoint, options?: {
+        delay?: number;
+    }): Promise<void>;
+    /**
+     * Drop the given element onto the current one.
+     * @param element - Element to drop.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.drop
+     */
+    drop(element: RemotePuppeteerElementHandle): Promise<void>;
+    /**
+     * Move the touch to the center of the element.
+     *
+     * @remarks
+     * Scrolls element into view if needed.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.touchmove
+     */
+    touchMove(touch?: {
+        touchId?: string;
+    }): Promise<void>;
+    /**
+     * End the first active touch.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.touchend
+     */
+    touchEnd(): Promise<void>;
+    /**
+     * Wait for a child element to appear.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.waitforselector
+     */
+    waitForSelector(selector: string, options?: PuppeteerWaitForSelectorOptions): Promise<RemotePuppeteerElementHandle | null>;
+    /**
+     * Convert to a typed element handle.
+     *
+     * @remarks
+     * Throws if the element is not of the specified tag type. Do NOT dispose the original handle - both handles reference the same element.
+     *
+     * @example
+     * Converting to an anchor element:
+     * ```ts
+     * const element = await page.$('.class-name-of-anchor');
+     * const anchor = await element.toElement('a');
+     * // anchor.href is now typed
+     * ```
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.toelement
+     */
+    toElement<K extends keyof HTMLElementTagNameMap>(tagName: K): Promise<RemotePuppeteerElementHandle>;
+}

package/dist/drivers/puppeteer/generated/element-handle.js

@@ -0,0 +1,341 @@
+/**
+ * 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 { extractHandleId, serializeFunctionSource, toHandleRef, } from '../../../internal/transport.js';
+import { RemoteBase } from '../remote-base.js';
+/**
+ * RemotePuppeteerElementHandle - Remote Puppeteer ElementHandle API over RPC.
+ *
+ * @see https://pptr.dev/api/puppeteer.elementhandle
+ */
+export class RemotePuppeteerElementHandle extends RemoteBase {
+    /** The handle ID (alias for id, for compatibility). */
+    handleId;
+    createElementHandle;
+    createFrame;
+    createLocator;
+    createTouchHandle;
+    constructor(id, sendRpc, createElementHandle, createFrame, createLocator, createTouchHandle) {
+        super(id, sendRpc);
+        this.createElementHandle = createElementHandle;
+        this.createFrame = createFrame;
+        this.createLocator = createLocator;
+        this.createTouchHandle = createTouchHandle;
+    }
+    /**
+     * Click the element.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.click
+     */
+    async click(options) {
+        await this.rpc('click', [options]);
+    }
+    /**
+     * Hover over the element.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.hover
+     */
+    async hover() {
+        await this.rpc('hover', []);
+    }
+    /**
+     * Tap the element (for touch devices).
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.tap
+     */
+    async tap() {
+        await this.rpc('tap', []);
+    }
+    /**
+     * Focus the element.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.focus
+     */
+    async focus() {
+        await this.rpc('focus', []);
+    }
+    /**
+     * Type text into the element.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.type
+     */
+    async type(text, options) {
+        await this.rpc('type', [text, options]);
+    }
+    /**
+     * Press a key while focused on the element.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.press
+     */
+    async press(key, options) {
+        await this.rpc('press', [key, options]);
+    }
+    /**
+     * Select options in a <select> element.
+     * @returns An array of selected option values.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.select
+     */
+    async select(...values) {
+        return this.rpc('select', [...values]);
+    }
+    /**
+     * Upload files to a file input element.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.uploadfile
+     */
+    async uploadFile(...filePaths) {
+        await this.rpc('uploadFile', [...filePaths]);
+    }
+    /**
+     * Scroll the element into view.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.scrollintoview
+     */
+    async scrollIntoView() {
+        await this.rpc('scrollIntoView', []);
+    }
+    /**
+     * Test if the form is compatible with browser autofill. Currently supports credit card autofill in Chrome headless/headful only.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.autofill
+     */
+    async autofill(data) {
+        await this.rpc('autofill', [data]);
+    }
+    /**
+     * Query for a child element.
+     * @returns The matching element or null if not found.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle._
+     */
+    async $(selector) {
+        const result = await this.rpc('$', [selector]);
+        if (!result)
+            return null;
+        return this.createElementHandle(result.id);
+    }
+    /**
+     * Query for all matching child elements.
+     * @returns An array of matching elements.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.__
+     */
+    async $$(selector) {
+        const results = await this.rpc('$$', [selector]);
+        return results.map((r) => this.createElementHandle(r.id));
+    }
+    /**
+     * Get a property value.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.getproperty
+     */
+    async getProperty(propertyName) {
+        return this.rpc('getProperty', [propertyName]);
+    }
+    /**
+     * Get the JSON value of the element.
+     *
+     * @see https://pptr.dev/api/puppeteer.jshandle.jsonvalue
+     */
+    async jsonValue() {
+        return this.rpc('jsonValue', []);
+    }
+    /**
+     * Check if the element is visible.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.isvisible
+     */
+    async isVisible() {
+        return this.rpc('isVisible', []);
+    }
+    /**
+     * Check if the element is hidden.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.ishidden
+     */
+    async isHidden() {
+        return this.rpc('isHidden', []);
+    }
+    /**
+     * Check if the element intersects the viewport.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.isintersectingviewport
+     */
+    async isIntersectingViewport(options) {
+        return this.rpc('isIntersectingViewport', [options]);
+    }
+    /**
+     * Get the bounding box of the element.
+     * @returns The bounding box or null if the element is not visible.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.boundingbox
+     */
+    async boundingBox() {
+        return this.rpc('boundingBox', []);
+    }
+    /**
+     * Get the CSS box model of the element.
+     * @returns The box model or null if the element is not visible.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.boxmodel
+     */
+    async boxModel() {
+        return this.rpc('boxModel', []);
+    }
+    /**
+     * Get a clickable point within the element.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.clickablepoint
+     */
+    async clickablePoint(offset) {
+        return this.rpc('clickablePoint', [offset]);
+    }
+    /**
+     * Evaluate a function in the context of the element.
+     *
+     * @remarks
+     * The element is passed as the first argument to the function.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.evaluate
+     */
+    async evaluate(pageFunction, ...args) {
+        const _pageFunction = serializeFunctionSource(pageFunction);
+        return this.rpc('evaluate', [_pageFunction, ...args]);
+    }
+    /**
+     * Evaluate a function on the first child matching the selector.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle._eval
+     */
+    async $eval(selector, pageFunction, ...args) {
+        const _pageFunction = serializeFunctionSource(pageFunction);
+        return this.rpc('$eval', [selector, _pageFunction, ...args]);
+    }
+    /**
+     * Evaluate a function on all children matching the selector.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.__eval
+     */
+    async $$eval(selector, pageFunction, ...args) {
+        const _pageFunction = serializeFunctionSource(pageFunction);
+        return this.rpc('$$eval', [selector, _pageFunction, ...args]);
+    }
+    /**
+     * Get the content frame for iframe elements.
+     * @returns The frame or null if not an iframe.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.contentframe
+     */
+    async contentFrame() {
+        const result = await this.rpc('contentFrame', []);
+        if (!result)
+            return null;
+        return this.createFrame(result.id);
+    }
+    /**
+     * Drag the element to the given target.
+     * @param target - Target point or element to drag to.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.drag
+     */
+    async drag(target) {
+        const _target = toHandleRef(target);
+        return this.rpc('drag', [_target]);
+    }
+    /**
+     * Dispatch a dragenter event.
+     *
+     * @remarks
+     * Deprecated: dragenter is automatically performed during dragging.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.dragenter
+     */
+    async dragEnter(data) {
+        await this.rpc('dragEnter', [data]);
+    }
+    /**
+     * Dispatch a dragover event.
+     *
+     * @remarks
+     * Deprecated: dragover is automatically performed during dragging.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.dragover
+     */
+    async dragOver(data) {
+        await this.rpc('dragOver', [data]);
+    }
+    /**
+     * Drag and drop to another element or point.
+     * @param target - Target element or point to drop onto.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.draganddrop
+     */
+    async dragAndDrop(target, options) {
+        const _target = toHandleRef(target);
+        await this.rpc('dragAndDrop', [_target, options]);
+    }
+    /**
+     * Drop the given element onto the current one.
+     * @param element - Element to drop.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.drop
+     */
+    async drop(element) {
+        const _element = extractHandleId(element);
+        await this.rpc('drop', [_element]);
+    }
+    /**
+     * Move the touch to the center of the element.
+     *
+     * @remarks
+     * Scrolls element into view if needed.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.touchmove
+     */
+    async touchMove(touch) {
+        await this.rpc('touchMove', [touch]);
+    }
+    /**
+     * End the first active touch.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.touchend
+     */
+    async touchEnd() {
+        await this.rpc('touchEnd', []);
+    }
+    /**
+     * Wait for a child element to appear.
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.waitforselector
+     */
+    async waitForSelector(selector, options) {
+        const result = await this.rpc('waitForSelector', [selector, options]);
+        if (!result)
+            return null;
+        return this.createElementHandle(result.id);
+    }
+    /**
+     * Convert to a typed element handle.
+     *
+     * @remarks
+     * Throws if the element is not of the specified tag type. Do NOT dispose the original handle - both handles reference the same element.
+     *
+     * @example
+     * Converting to an anchor element:
+     * ```ts
+     * const element = await page.$('.class-name-of-anchor');
+     * const anchor = await element.toElement('a');
+     * // anchor.href is now typed
+     * ```
+     *
+     * @see https://pptr.dev/api/puppeteer.elementhandle.toelement
+     */
+    async toElement(tagName) {
+        const result = await this.rpc('toElement', [tagName]);
+        return this.createElementHandle(result.id);
+    }
+}

package/dist/drivers/puppeteer/generated/file-chooser.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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';
+/**
+ * RemotePuppeteerFileChooser - Remote Puppeteer FileChooser API over RPC.
+ *
+ * @see https://pptr.dev/api/puppeteer.filechooser
+ */
+export declare class RemotePuppeteerFileChooser {
+    readonly id: string;
+    protected sendRpc: SimpleRpcSender;
+    /** Whether the file chooser allows multiple file selection. */
+    private readonly _isMultiple;
+    constructor(id: string, sendRpc: SimpleRpcSender, isMultiple: boolean);
+    /**
+     * Whether file chooser allows multiple file selection.
+     * @see https://pptr.dev/api/puppeteer.filechooser.ismultiple
+     */
+    isMultiple(): boolean;
+    /**
+     * Accept the file chooser request with the given file paths.
+     * @see https://pptr.dev/api/puppeteer.filechooser.accept
+     */
+    accept(paths: string[]): Promise<void>;
+    /**
+     * Close the file chooser without selecting any files.
+     * @see https://pptr.dev/api/puppeteer.filechooser.cancel
+     */
+    cancel(): Promise<void>;
+}

package/dist/drivers/puppeteer/generated/file-chooser.js

@@ -0,0 +1,43 @@
+/**
+ * AUTO-GENERATED FILE - DO NOT EDIT
+ *
+ * Generated from: packages/automation-spec/src/drivers/puppeteer/methods/puppeteer-methods.ts
+ * Run `pnpm generate:puppeteer` to regenerate.
+ */
+/**
+ * RemotePuppeteerFileChooser - Remote Puppeteer FileChooser API over RPC.
+ *
+ * @see https://pptr.dev/api/puppeteer.filechooser
+ */
+export class RemotePuppeteerFileChooser {
+    id;
+    sendRpc;
+    /** Whether the file chooser allows multiple file selection. */
+    _isMultiple;
+    constructor(id, sendRpc, isMultiple) {
+        this.id = id;
+        this.sendRpc = sendRpc;
+        this._isMultiple = isMultiple;
+    }
+    /**
+     * Whether file chooser allows multiple file selection.
+     * @see https://pptr.dev/api/puppeteer.filechooser.ismultiple
+     */
+    isMultiple() {
+        return this._isMultiple;
+    }
+    /**
+     * Accept the file chooser request with the given file paths.
+     * @see https://pptr.dev/api/puppeteer.filechooser.accept
+     */
+    async accept(paths) {
+        await this.sendRpc('fileChooser:accept', [this.id, paths]);
+    }
+    /**
+     * Close the file chooser without selecting any files.
+     * @see https://pptr.dev/api/puppeteer.filechooser.cancel
+     */
+    async cancel() {
+        await this.sendRpc('fileChooser:cancel', [this.id]);
+    }
+}