@bctrl/sdk 1.0.1

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

@@ -0,0 +1,97 @@
+/**
+ * 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 { RemoteComponentBase } from '../remote-base.js';
+import type { PlaywrightMouseClickOptions, PlaywrightMouseDblclickOptions, PlaywrightMouseDownUpOptions, PlaywrightMouseMoveOptions } from '../types.js';
+/**
+ * RemotePlaywrightMouse - Remote Playwright Mouse API over RPC.
+ *
+ * @see https://playwright.dev/docs/api/class-mouse
+ */
+export declare class RemotePlaywrightMouse extends RemoteComponentBase {
+    constructor(sendRpc: SimpleRpcSender);
+    /**
+     * Shortcut for mouse.move(), mouse.down(), mouse.up().
+     * @param x - X coordinate relative to the main frame viewport in CSS pixels.
+     * @param y - Y coordinate relative to the main frame viewport in CSS pixels.
+     * @param options - Click options.
+     *
+     * @remarks
+     * Simulates a mouse click at the specified coordinates.
+     *
+     * @example
+     * ```ts
+     * await page.mouse.click(100, 50);
+     * await page.mouse.click(200, 100, { button: 'right', delay: 100 });
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-mouse#mouse-click
+     */
+    click(x: number, y: number, options?: PlaywrightMouseClickOptions): Promise<void>;
+    /**
+     * Shortcut for mouse.move(), mouse.down(), mouse.up(), mouse.down(), mouse.up().
+     * @param x - X coordinate relative to the main frame viewport in CSS pixels.
+     * @param y - Y coordinate relative to the main frame viewport in CSS pixels.
+     * @param options - Double-click options.
+     *
+     * @remarks
+     * Simulates a double mouse click at the specified coordinates.
+     *
+     * @example
+     * ```ts
+     * await page.mouse.dblclick(100, 50);
+     * await page.mouse.dblclick(200, 100, { delay: 50 });
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-mouse#mouse-dblclick
+     */
+    dblclick(x: number, y: number, options?: PlaywrightMouseDblclickOptions): Promise<void>;
+    /**
+     * Dispatches a mousedown event.
+     * @param options - Mouse down options.
+     *
+     * @see https://playwright.dev/docs/api/class-mouse#mouse-down
+     */
+    down(options?: PlaywrightMouseDownUpOptions): Promise<void>;
+    /**
+     * Dispatches a mouseup event.
+     * @param options - Mouse up options.
+     *
+     * @see https://playwright.dev/docs/api/class-mouse#mouse-up
+     */
+    up(options?: PlaywrightMouseDownUpOptions): Promise<void>;
+    /**
+     * Dispatches a mousemove event.
+     * @param x - X coordinate relative to the main frame viewport in CSS pixels.
+     * @param y - Y coordinate relative to the main frame viewport in CSS pixels.
+     * @param options - Mouse move options.
+     *
+     * @remarks
+     * The steps option controls the number of intermediate mousemove events to generate.
+     *
+     * @see https://playwright.dev/docs/api/class-mouse#mouse-move
+     */
+    move(x: number, y: number, options?: PlaywrightMouseMoveOptions): Promise<void>;
+    /**
+     * Dispatches a wheel event.
+     * @param deltaX - Pixels to scroll horizontally.
+     * @param deltaY - Pixels to scroll vertically.
+     *
+     * @remarks
+     * This method is usually used to manually scroll the page.
+     * Wheel events may cause scrolling if they are not handled, and this method does not wait for the scrolling to finish before returning.
+     *
+     * @example
+     * ```ts
+     * // Scroll down by 100 pixels
+     * await page.mouse.wheel(0, 100);
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-mouse#mouse-wheel
+     */
+    wheel(deltaX: number, deltaY: number): Promise<void>;
+}

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

@@ -0,0 +1,109 @@
+/**
+ * AUTO-GENERATED FILE - DO NOT EDIT
+ *
+ * Generated from: packages/automation-spec/src/drivers/playwright/methods/
+ * Run `pnpm generate:playwright` to regenerate.
+ */
+import { RemoteComponentBase } from '../remote-base.js';
+/**
+ * RemotePlaywrightMouse - Remote Playwright Mouse API over RPC.
+ *
+ * @see https://playwright.dev/docs/api/class-mouse
+ */
+export class RemotePlaywrightMouse extends RemoteComponentBase {
+    constructor(sendRpc) {
+        super(sendRpc);
+    }
+    /**
+     * Shortcut for mouse.move(), mouse.down(), mouse.up().
+     * @param x - X coordinate relative to the main frame viewport in CSS pixels.
+     * @param y - Y coordinate relative to the main frame viewport in CSS pixels.
+     * @param options - Click options.
+     *
+     * @remarks
+     * Simulates a mouse click at the specified coordinates.
+     *
+     * @example
+     * ```ts
+     * await page.mouse.click(100, 50);
+     * await page.mouse.click(200, 100, { button: 'right', delay: 100 });
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-mouse#mouse-click
+     */
+    async click(x, y, options) {
+        await this.rpc('mouse.click', [x, y, options]);
+    }
+    /**
+     * Shortcut for mouse.move(), mouse.down(), mouse.up(), mouse.down(), mouse.up().
+     * @param x - X coordinate relative to the main frame viewport in CSS pixels.
+     * @param y - Y coordinate relative to the main frame viewport in CSS pixels.
+     * @param options - Double-click options.
+     *
+     * @remarks
+     * Simulates a double mouse click at the specified coordinates.
+     *
+     * @example
+     * ```ts
+     * await page.mouse.dblclick(100, 50);
+     * await page.mouse.dblclick(200, 100, { delay: 50 });
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-mouse#mouse-dblclick
+     */
+    async dblclick(x, y, options) {
+        await this.rpc('mouse.dblclick', [x, y, options]);
+    }
+    /**
+     * Dispatches a mousedown event.
+     * @param options - Mouse down options.
+     *
+     * @see https://playwright.dev/docs/api/class-mouse#mouse-down
+     */
+    async down(options) {
+        await this.rpc('mouse.down', [options]);
+    }
+    /**
+     * Dispatches a mouseup event.
+     * @param options - Mouse up options.
+     *
+     * @see https://playwright.dev/docs/api/class-mouse#mouse-up
+     */
+    async up(options) {
+        await this.rpc('mouse.up', [options]);
+    }
+    /**
+     * Dispatches a mousemove event.
+     * @param x - X coordinate relative to the main frame viewport in CSS pixels.
+     * @param y - Y coordinate relative to the main frame viewport in CSS pixels.
+     * @param options - Mouse move options.
+     *
+     * @remarks
+     * The steps option controls the number of intermediate mousemove events to generate.
+     *
+     * @see https://playwright.dev/docs/api/class-mouse#mouse-move
+     */
+    async move(x, y, options) {
+        await this.rpc('mouse.move', [x, y, options]);
+    }
+    /**
+     * Dispatches a wheel event.
+     * @param deltaX - Pixels to scroll horizontally.
+     * @param deltaY - Pixels to scroll vertically.
+     *
+     * @remarks
+     * This method is usually used to manually scroll the page.
+     * Wheel events may cause scrolling if they are not handled, and this method does not wait for the scrolling to finish before returning.
+     *
+     * @example
+     * ```ts
+     * // Scroll down by 100 pixels
+     * await page.mouse.wheel(0, 100);
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-mouse#mouse-wheel
+     */
+    async wheel(deltaX, deltaY) {
+        await this.rpc('mouse.wheel', [deltaX, deltaY]);
+    }
+}