@bctrl/sdk 1.0.1

package/dist/drivers/playwright/generated/js-handle.d.ts

@@ -0,0 +1,72 @@
+/**
+ * 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 { RemoteBase } from '../remote-base.js';
+/**
+ * RemotePlaywrightJSHandle - Remote Playwright JSHandle API over RPC.
+ *
+ * @see https://playwright.dev/docs/api/class-jshandle
+ */
+export declare class RemotePlaywrightJSHandle extends RemoteBase {
+    /** Factory to create JSHandle instances */
+    private readonly _jsHandleFactory;
+    constructor(id: string, sendRpc: SimpleRpcSender, jsHandleFactory: (id: string) => RemotePlaywrightJSHandle);
+    protected get jsHandleFactory(): (id: string) => RemotePlaywrightJSHandle;
+    /**
+     * Evaluates the given function with this handle as the first argument.
+     * @param pageFunction - Function to be evaluated in the page context.
+     * @param arg - Optional argument to pass to the function.
+     *
+     * @see https://playwright.dev/docs/api/class-jshandle#js-handle-evaluate
+     */
+    evaluate<R = unknown>(pageFunction: Function | string, arg?: unknown): Promise<R>;
+    /**
+     * Evaluates the given function with this handle as the first argument and returns a JSHandle.
+     * @param pageFunction - Function to be evaluated in the page context.
+     * @param arg - Optional argument to pass to the function.
+     *
+     * @remarks
+     * Note: Returns serialized handle reference. Full JSHandle support not yet available.
+     *
+     * @see https://playwright.dev/docs/api/class-jshandle#js-handle-evaluate-handle
+     */
+    evaluateHandle<R = unknown>(pageFunction: Function | string, arg?: unknown): Promise<unknown>;
+    /**
+     * Returns a map of property names to JSHandle instances for own properties of the object.
+     *
+     * @remarks
+     * Note: Returns serialized handle references. Full JSHandle support not yet available.
+     *
+     * @see https://playwright.dev/docs/api/class-jshandle#js-handle-get-properties
+     */
+    getProperties(): Promise<Map<string, unknown>>;
+    /**
+     * Returns a JSHandle for the property with the given name.
+     * @param propertyName - Property name to get.
+     *
+     * @remarks
+     * Note: Returns serialized handle reference. Full JSHandle support not yet available.
+     *
+     * @see https://playwright.dev/docs/api/class-jshandle#js-handle-get-property
+     */
+    getProperty(propertyName: string): Promise<unknown>;
+    /**
+     * Returns a JSON representation of the object.
+     *
+     * @remarks
+     * If the object has a toJSON function, it will not be called.
+     *
+     * @see https://playwright.dev/docs/api/class-jshandle#js-handle-json-value
+     */
+    jsonValue<T = unknown>(): Promise<T>;
+    /**
+     * Releases the handle. After calling dispose, the handle is no longer valid.
+     *
+     * @see https://playwright.dev/docs/api/class-jshandle#js-handle-dispose
+     */
+    dispose(): Promise<void>;
+}

package/dist/drivers/playwright/generated/js-handle.js

@@ -0,0 +1,92 @@
+/**
+ * AUTO-GENERATED FILE - DO NOT EDIT
+ *
+ * Generated from: packages/automation-spec/src/drivers/playwright/methods/
+ * Run `pnpm generate:playwright` to regenerate.
+ */
+import { RemoteBase } from '../remote-base.js';
+import { serializeFunctionSource } from '../../../internal/transport.js';
+/**
+ * RemotePlaywrightJSHandle - Remote Playwright JSHandle API over RPC.
+ *
+ * @see https://playwright.dev/docs/api/class-jshandle
+ */
+export class RemotePlaywrightJSHandle extends RemoteBase {
+    /** Factory to create JSHandle instances */
+    _jsHandleFactory;
+    constructor(id, sendRpc, jsHandleFactory) {
+        super(id, sendRpc);
+        this._jsHandleFactory = jsHandleFactory;
+    }
+    get jsHandleFactory() {
+        return this._jsHandleFactory;
+    }
+    /**
+     * Evaluates the given function with this handle as the first argument.
+     * @param pageFunction - Function to be evaluated in the page context.
+     * @param arg - Optional argument to pass to the function.
+     *
+     * @see https://playwright.dev/docs/api/class-jshandle#js-handle-evaluate
+     */
+    async evaluate(pageFunction, arg) {
+        const _pageFunction = serializeFunctionSource(pageFunction);
+        return this.rpc('evaluate', [_pageFunction, arg]);
+    }
+    /**
+     * Evaluates the given function with this handle as the first argument and returns a JSHandle.
+     * @param pageFunction - Function to be evaluated in the page context.
+     * @param arg - Optional argument to pass to the function.
+     *
+     * @remarks
+     * Note: Returns serialized handle reference. Full JSHandle support not yet available.
+     *
+     * @see https://playwright.dev/docs/api/class-jshandle#js-handle-evaluate-handle
+     */
+    async evaluateHandle(pageFunction, arg) {
+        const _pageFunction = serializeFunctionSource(pageFunction);
+        return this.rpc('evaluateHandle', [_pageFunction, arg]);
+    }
+    /**
+     * Returns a map of property names to JSHandle instances for own properties of the object.
+     *
+     * @remarks
+     * Note: Returns serialized handle references. Full JSHandle support not yet available.
+     *
+     * @see https://playwright.dev/docs/api/class-jshandle#js-handle-get-properties
+     */
+    async getProperties() {
+        return this.rpc('getProperties', []);
+    }
+    /**
+     * Returns a JSHandle for the property with the given name.
+     * @param propertyName - Property name to get.
+     *
+     * @remarks
+     * Note: Returns serialized handle reference. Full JSHandle support not yet available.
+     *
+     * @see https://playwright.dev/docs/api/class-jshandle#js-handle-get-property
+     */
+    async getProperty(propertyName) {
+        return this.rpc('getProperty', [propertyName]);
+    }
+    /**
+     * Returns a JSON representation of the object.
+     *
+     * @remarks
+     * If the object has a toJSON function, it will not be called.
+     *
+     * @see https://playwright.dev/docs/api/class-jshandle#js-handle-json-value
+     */
+    async jsonValue() {
+        return this.rpc('jsonValue', []);
+    }
+    /**
+     * Releases the handle. After calling dispose, the handle is no longer valid.
+     *
+     * @see https://playwright.dev/docs/api/class-jshandle#js-handle-dispose
+     */
+    async dispose() {
+        await this.rpc('dispose', []);
+        this.markClosed();
+    }
+}

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

@@ -0,0 +1,103 @@
+/**
+ * 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 { PlaywrightKeyboardPressOptions, PlaywrightKeyboardTypeOptions } from '../types.js';
+/**
+ * RemotePlaywrightKeyboard - Remote Playwright Keyboard API over RPC.
+ *
+ * @see https://playwright.dev/docs/api/class-keyboard
+ */
+export declare class RemotePlaywrightKeyboard extends RemoteComponentBase {
+    constructor(sendRpc: SimpleRpcSender);
+    /**
+     * Dispatches a keydown event.
+     * @param key - Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
+     *
+     * @remarks
+     * If key is a single character and no modifier keys besides Shift are being held down,
+     * a keypress/input event will also be generated. The text option can be specified to force an input event to be generated.
+     *
+     * Modifier keys DO affect keyboard.down. Holding down Shift will type the text in upper case.
+     *
+     * @see https://playwright.dev/docs/api/class-keyboard#keyboard-down
+     */
+    down(key: string): Promise<void>;
+    /**
+     * Dispatches a keyup event.
+     * @param key - Name of the key to release or a character.
+     *
+     * @see https://playwright.dev/docs/api/class-keyboard#keyboard-up
+     */
+    up(key: string): Promise<void>;
+    /**
+     * Shortcut for keyboard.down() and keyboard.up().
+     * @param key - Key to press. Can be a character or a special key name (e.g., `ArrowLeft`, `Shift+A`, `ControlOrMeta+A`).
+     * @param options - Options for the key press event.
+     *
+     * @remarks
+     * Dispatches a keydown, keypress/input, and keyup event for the specified key.
+     *
+     * If key is a single character and no modifier keys besides Shift are being held down,
+     * a keypress/input event will also be generated.
+     *
+     * Modifier keys DO affect keyboard.press. Holding down Shift will type the text in upper case.
+     *
+     * Shortcut such as "ControlOrMeta+A" are supported. "ControlOrMeta" resolves to "Control" on Windows/Linux and to "Meta" on macOS.
+     *
+     * @example
+     * ```ts
+     * await page.keyboard.press('Enter');
+     * await page.keyboard.press('Shift+A');
+     * await page.keyboard.press('ControlOrMeta+A');
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-keyboard#keyboard-press
+     */
+    press(key: string, options?: PlaywrightKeyboardPressOptions): Promise<void>;
+    /**
+     * Sends a keydown, keypress/input, and keyup event for each character in the text.
+     * @param text - Text to type.
+     * @param options - Options for typing.
+     *
+     * @remarks
+     * Use this method when you need to simulate typing character by character,
+     * for example, if the page has custom keyboard event listeners.
+     *
+     * Modifier keys DO NOT affect keyboard.type. Holding down Shift will not type the text in upper case.
+     *
+     * For characters not present on a standard US keyboard layout, only an input event will be dispatched.
+     *
+     * For simple text input, locator.fill() is generally preferred.
+     *
+     * @example
+     * ```ts
+     * await page.keyboard.type('Hello'); // Types instantly
+     * await page.keyboard.type('World', { delay: 100 }); // Types slower, like a user
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-keyboard#keyboard-type
+     */
+    type(text: string, options?: PlaywrightKeyboardTypeOptions): Promise<void>;
+    /**
+     * Dispatches only an input event, does not emit keydown, keyup, or keypress events.
+     * @param text - Text to insert.
+     *
+     * @remarks
+     * This method is useful for directly inserting text without simulating physical key presses.
+     *
+     * Modifier keys DO NOT affect keyboard.insertText. Holding down Shift will not type the text in upper case.
+     *
+     * @example
+     * ```ts
+     * await page.keyboard.insertText('Hello');
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-keyboard#keyboard-insert-text
+     */
+    insertText(text: string): Promise<void>;
+}

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

@@ -0,0 +1,113 @@
+/**
+ * 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';
+/**
+ * RemotePlaywrightKeyboard - Remote Playwright Keyboard API over RPC.
+ *
+ * @see https://playwright.dev/docs/api/class-keyboard
+ */
+export class RemotePlaywrightKeyboard extends RemoteComponentBase {
+    constructor(sendRpc) {
+        super(sendRpc);
+    }
+    /**
+     * Dispatches a keydown event.
+     * @param key - Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
+     *
+     * @remarks
+     * If key is a single character and no modifier keys besides Shift are being held down,
+     * a keypress/input event will also be generated. The text option can be specified to force an input event to be generated.
+     *
+     * Modifier keys DO affect keyboard.down. Holding down Shift will type the text in upper case.
+     *
+     * @see https://playwright.dev/docs/api/class-keyboard#keyboard-down
+     */
+    async down(key) {
+        await this.rpc('keyboard.down', [key]);
+    }
+    /**
+     * Dispatches a keyup event.
+     * @param key - Name of the key to release or a character.
+     *
+     * @see https://playwright.dev/docs/api/class-keyboard#keyboard-up
+     */
+    async up(key) {
+        await this.rpc('keyboard.up', [key]);
+    }
+    /**
+     * Shortcut for keyboard.down() and keyboard.up().
+     * @param key - Key to press. Can be a character or a special key name (e.g., `ArrowLeft`, `Shift+A`, `ControlOrMeta+A`).
+     * @param options - Options for the key press event.
+     *
+     * @remarks
+     * Dispatches a keydown, keypress/input, and keyup event for the specified key.
+     *
+     * If key is a single character and no modifier keys besides Shift are being held down,
+     * a keypress/input event will also be generated.
+     *
+     * Modifier keys DO affect keyboard.press. Holding down Shift will type the text in upper case.
+     *
+     * Shortcut such as "ControlOrMeta+A" are supported. "ControlOrMeta" resolves to "Control" on Windows/Linux and to "Meta" on macOS.
+     *
+     * @example
+     * ```ts
+     * await page.keyboard.press('Enter');
+     * await page.keyboard.press('Shift+A');
+     * await page.keyboard.press('ControlOrMeta+A');
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-keyboard#keyboard-press
+     */
+    async press(key, options) {
+        await this.rpc('keyboard.press', [key, options]);
+    }
+    /**
+     * Sends a keydown, keypress/input, and keyup event for each character in the text.
+     * @param text - Text to type.
+     * @param options - Options for typing.
+     *
+     * @remarks
+     * Use this method when you need to simulate typing character by character,
+     * for example, if the page has custom keyboard event listeners.
+     *
+     * Modifier keys DO NOT affect keyboard.type. Holding down Shift will not type the text in upper case.
+     *
+     * For characters not present on a standard US keyboard layout, only an input event will be dispatched.
+     *
+     * For simple text input, locator.fill() is generally preferred.
+     *
+     * @example
+     * ```ts
+     * await page.keyboard.type('Hello'); // Types instantly
+     * await page.keyboard.type('World', { delay: 100 }); // Types slower, like a user
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-keyboard#keyboard-type
+     */
+    async type(text, options) {
+        await this.rpc('keyboard.type', [text, options]);
+    }
+    /**
+     * Dispatches only an input event, does not emit keydown, keyup, or keypress events.
+     * @param text - Text to insert.
+     *
+     * @remarks
+     * This method is useful for directly inserting text without simulating physical key presses.
+     *
+     * Modifier keys DO NOT affect keyboard.insertText. Holding down Shift will not type the text in upper case.
+     *
+     * @example
+     * ```ts
+     * await page.keyboard.insertText('Hello');
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-keyboard#keyboard-insert-text
+     */
+    async insertText(text) {
+        await this.rpc('keyboard.insertText', [text]);
+    }
+}