@bctrl/sdk 1.0.1

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

@@ -0,0 +1,77 @@
+/**
+ * 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 { HasHandleId, SimpleRpcSender } from '../../../internal/transport.js';
+import { RemoteComponentBase } from '../remote-base.js';
+import type { PuppeteerSerializedAXNode } from '../types.js';
+/**
+ * Options for SDK method. Wraps PuppeteerSnapshotOptions with SDK-friendly types.
+ */
+export interface SnapshotOptions {
+    /**
+     * Prune uninteresting nodes from the tree. @default true
+     */
+    interestingOnly?: boolean;
+    /**
+     * Root element to get the accessibility tree for. Can be a handle ID string or any object with a handleId property (e.g., RemotePuppeteerElementHandle). If not provided, defaults to the root node of the entire page.
+     */
+    root?: string | HasHandleId;
+}
+/**
+ * RemotePuppeteerAccessibility - Remote Puppeteer Accessibility API over RPC.
+ *
+ * @see https://pptr.dev/api/puppeteer.accessibility
+ */
+export declare class RemotePuppeteerAccessibility extends RemoteComponentBase {
+    constructor(sendRpc: SimpleRpcSender);
+    /**
+     * Captures the current state of the accessibility tree.
+     * @param options - Options for the snapshot.
+     * @returns A promise that resolves to the root AXNode object representing the snapshot of the accessibility tree, or `null` if the tree is empty.
+     *
+     * @remarks
+     * The accessibility tree is used by assistive technology such as screen readers or switches.
+     *
+     * Blink - Chrome's rendering engine - has a concept of "accessibility tree", which is then
+     * translated into different platform-specific APIs. Accessibility namespace gives users access
+     * to the Blink Accessibility Tree.
+     *
+     * Most of the accessibility tree gets filtered out when converting from Blink AX Tree to
+     * Platform-specific AX-Tree or by assistive technologies themselves. By default, Puppeteer
+     * tries to approximate this filtering, exposing only the "interesting" nodes of the tree.
+     *
+     * **NOTE:** The Chrome accessibility tree contains nodes that go unused on most platforms
+     * and by most screen readers. Puppeteer will discard them as well for an easier to process
+     * tree, unless `interestingOnly` is set to `false`.
+     *
+     * @example
+     * An example of dumping the entire accessibility tree:
+     * ```ts
+     * const snapshot = await page.accessibility.snapshot();
+     * console.log(snapshot);
+     * ```
+     *
+     * @example
+     * An example of logging the focused node's name:
+     * ```ts
+     * const snapshot = await page.accessibility.snapshot();
+     * const node = findFocusedNode(snapshot);
+     * console.log(node && node.name);
+     *
+     * function findFocusedNode(node: SerializedAXNode): SerializedAXNode | null {
+     *   if (node.focused) return node;
+     *   for (const child of node.children || []) {
+     *     const focusedChild = findFocusedNode(child);
+     *     if (focusedChild) return focusedChild;
+     *   }
+     *   return null;
+     * }
+     * ```
+     *
+     * @see https://pptr.dev/api/puppeteer.accessibility.snapshot
+     */
+    snapshot(options?: SnapshotOptions): Promise<PuppeteerSerializedAXNode | null>;
+}

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

@@ -0,0 +1,74 @@
+/**
+ * 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 } from '../../../internal/transport.js';
+import { RemoteComponentBase } from '../remote-base.js';
+/**
+ * RemotePuppeteerAccessibility - Remote Puppeteer Accessibility API over RPC.
+ *
+ * @see https://pptr.dev/api/puppeteer.accessibility
+ */
+export class RemotePuppeteerAccessibility extends RemoteComponentBase {
+    constructor(sendRpc) {
+        super(sendRpc);
+    }
+    /**
+     * Captures the current state of the accessibility tree.
+     * @param options - Options for the snapshot.
+     * @returns A promise that resolves to the root AXNode object representing the snapshot of the accessibility tree, or `null` if the tree is empty.
+     *
+     * @remarks
+     * The accessibility tree is used by assistive technology such as screen readers or switches.
+     *
+     * Blink - Chrome's rendering engine - has a concept of "accessibility tree", which is then
+     * translated into different platform-specific APIs. Accessibility namespace gives users access
+     * to the Blink Accessibility Tree.
+     *
+     * Most of the accessibility tree gets filtered out when converting from Blink AX Tree to
+     * Platform-specific AX-Tree or by assistive technologies themselves. By default, Puppeteer
+     * tries to approximate this filtering, exposing only the "interesting" nodes of the tree.
+     *
+     * **NOTE:** The Chrome accessibility tree contains nodes that go unused on most platforms
+     * and by most screen readers. Puppeteer will discard them as well for an easier to process
+     * tree, unless `interestingOnly` is set to `false`.
+     *
+     * @example
+     * An example of dumping the entire accessibility tree:
+     * ```ts
+     * const snapshot = await page.accessibility.snapshot();
+     * console.log(snapshot);
+     * ```
+     *
+     * @example
+     * An example of logging the focused node's name:
+     * ```ts
+     * const snapshot = await page.accessibility.snapshot();
+     * const node = findFocusedNode(snapshot);
+     * console.log(node && node.name);
+     *
+     * function findFocusedNode(node: SerializedAXNode): SerializedAXNode | null {
+     *   if (node.focused) return node;
+     *   for (const child of node.children || []) {
+     *     const focusedChild = findFocusedNode(child);
+     *     if (focusedChild) return focusedChild;
+     *   }
+     *   return null;
+     * }
+     * ```
+     *
+     * @see https://pptr.dev/api/puppeteer.accessibility.snapshot
+     */
+    async snapshot(options) {
+        // Convert options to RPC-friendly format
+        const rpcOptions = options
+            ? {
+                interestingOnly: options.interestingOnly,
+                root: extractHandleId(options.root),
+            }
+            : undefined;
+        return this.rpc('accessibility.snapshot', [rpcOptions]);
+    }
+}

package/dist/drivers/puppeteer/generated/browser-context.d.ts

@@ -0,0 +1,116 @@
+/**
+ * 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 type { RemotePuppeteerPage } from './page.js';
+import type { BrowserContextEvents, PuppeteerCookie, PuppeteerCookieData, PuppeteerDeleteCookiesRequest, PuppeteerPermission, PuppeteerTarget } from '../types.js';
+/**
+ * RemotePuppeteerBrowserContext - Remote Puppeteer BrowserContext API over RPC.
+ *
+ * @see https://pptr.dev/api/puppeteer.browsercontext
+ */
+export declare class RemotePuppeteerBrowserContext extends PuppeteerEventEmitter<BrowserContextEvents> {
+    private createPage;
+    protected sendRpc: SimpleRpcSender;
+    constructor(sendRpc: SimpleRpcSender, options: {
+        contextId: string;
+        isDefault?: boolean;
+    }, createPage: (pageId: string) => RemotePuppeteerPage);
+    private _contextId;
+    private _isDefault;
+    private _isClosed;
+    private _pages;
+    /** Get the context ID. */
+    get id(): string;
+    /** Whether this is the default context. */
+    get isDefault(): boolean;
+    /** Whether this context has been closed. */
+    get closed(): boolean;
+    /**
+     * Mark this context as closed (internal use).
+     */
+    markClosed(): void;
+    private rpc;
+    /**
+     * Gets a list of all open pages inside this browser context.
+     * @see https://pptr.dev/api/puppeteer.browsercontext.pages
+     */
+    pages(includeAll?: boolean): Promise<RemotePuppeteerPage[]>;
+    /**
+     * Creates a new page in this browser context.
+     * @see https://pptr.dev/api/puppeteer.browsercontext.newpage
+     */
+    newPage(options?: {
+        timeout?: number;
+    }): Promise<RemotePuppeteerPage>;
+    /**
+     * Close this browser context.
+     * @see https://pptr.dev/api/puppeteer.browsercontext.close
+     */
+    close(): Promise<void>;
+    /**
+     * Gets all cookies in this browser context.
+     *
+     * @see https://pptr.dev/api/puppeteer.browsercontext.cookies
+     */
+    cookies(...urls: string[]): Promise<PuppeteerCookie[]>;
+    /**
+     * Sets cookies in this browser context.
+     *
+     * @see https://pptr.dev/api/puppeteer.browsercontext.setcookie
+     */
+    setCookie(...cookies: PuppeteerCookieData[]): Promise<void>;
+    /**
+     * Deletes cookies from this browser context.
+     *
+     * @see https://pptr.dev/api/puppeteer.browsercontext.deletecookie
+     */
+    deleteCookie(...cookies: PuppeteerCookie[]): Promise<void>;
+    /**
+     * Deletes cookies matching the filter criteria from this browser context.
+     *
+     * @see https://pptr.dev/api/puppeteer.browsercontext.deletematchingcookies
+     */
+    deleteMatchingCookies(...filters: PuppeteerDeleteCookiesRequest[]): Promise<void>;
+    /**
+     * Grants this browser context the given permissions within the given origin.
+     *
+     * @remarks
+     * All permissions that are not listed will be automatically denied.
+     *
+     * @example
+     * Grant geolocation permission:
+     * ```ts
+     * const context = browser.defaultBrowserContext();
+     * await context.overridePermissions('https://html5demos.com', ['geolocation']);
+     * ```
+     *
+     * @see https://pptr.dev/api/puppeteer.browsercontext.overridepermissions
+     */
+    overridePermissions(origin: string, permissions: PuppeteerPermission[]): Promise<void>;
+    /**
+     * Clears all permission overrides for this browser context.
+     *
+     * @example
+     * Clear permission overrides:
+     * ```ts
+     * const context = browser.defaultBrowserContext();
+     * context.overridePermissions('https://example.com', ['clipboard-read']);
+     * // do stuff ..
+     * context.clearPermissionOverrides();
+     * ```
+     *
+     * @see https://pptr.dev/api/puppeteer.browsercontext.clearpermissionoverrides
+     */
+    clearPermissionOverrides(): Promise<void>;
+    /**
+     * Gets all active targets inside this browser context.
+     *
+     * @see https://pptr.dev/api/puppeteer.browsercontext.targets
+     */
+    targets(): Promise<PuppeteerTarget[]>;
+}

package/dist/drivers/puppeteer/generated/browser-context.js

@@ -0,0 +1,168 @@
+/**
+ * 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 { PuppeteerEventEmitter } from '../event-emitter.js';
+/**
+ * RemotePuppeteerBrowserContext - Remote Puppeteer BrowserContext API over RPC.
+ *
+ * @see https://pptr.dev/api/puppeteer.browsercontext
+ */
+export class RemotePuppeteerBrowserContext extends PuppeteerEventEmitter {
+    createPage;
+    sendRpc;
+    constructor(sendRpc, options, createPage) {
+        super();
+        this.sendRpc = sendRpc;
+        this.createPage = createPage;
+        this._contextId = options?.contextId ?? "default";
+        this._isDefault = options?.isDefault ?? false;
+    }
+    _contextId;
+    _isDefault;
+    _isClosed = false;
+    _pages = new Map();
+    /** Get the context ID. */
+    get id() {
+        return this._contextId;
+    }
+    /** Whether this is the default context. */
+    get isDefault() {
+        return this._isDefault;
+    }
+    /** Whether this context has been closed. */
+    get closed() {
+        return this._isClosed;
+    }
+    /**
+     * Mark this context as closed (internal use).
+     */
+    markClosed() {
+        this._isClosed = true;
+        // Mark all pages as closed
+        for (const page of this._pages.values()) {
+            if ('markClosed' in page && typeof page.markClosed === 'function') {
+                page.markClosed();
+            }
+        }
+    }
+    rpc(method, args) {
+        if (this._isClosed) {
+            throw new Error('Context is closed');
+        }
+        return this.sendRpc(method, args);
+    }
+    /**
+     * Gets a list of all open pages inside this browser context.
+     * @see https://pptr.dev/api/puppeteer.browsercontext.pages
+     */
+    async pages(includeAll) {
+        const pageIds = await this.rpc('pages', [includeAll]);
+        return pageIds.map((id) => {
+            let page = this._pages.get(id);
+            if (!page) {
+                page = this.createPage(id);
+                this._pages.set(id, page);
+            }
+            return page;
+        });
+    }
+    /**
+     * Creates a new page in this browser context.
+     * @see https://pptr.dev/api/puppeteer.browsercontext.newpage
+     */
+    async newPage(options) {
+        const pageId = await this.rpc('newPage', [options]);
+        const page = this.createPage(pageId);
+        this._pages.set(pageId, page);
+        return page;
+    }
+    /**
+     * Close this browser context.
+     * @see https://pptr.dev/api/puppeteer.browsercontext.close
+     */
+    async close() {
+        if (this._isDefault) {
+            throw new Error('Cannot close the default context');
+        }
+        await this.rpc('close', []);
+        this.markClosed();
+    }
+    /**
+     * Gets all cookies in this browser context.
+     *
+     * @see https://pptr.dev/api/puppeteer.browsercontext.cookies
+     */
+    async cookies(...urls) {
+        return this.sendRpc('cookies', [...urls]);
+    }
+    /**
+     * Sets cookies in this browser context.
+     *
+     * @see https://pptr.dev/api/puppeteer.browsercontext.setcookie
+     */
+    async setCookie(...cookies) {
+        await this.sendRpc('setCookie', [...cookies]);
+    }
+    /**
+     * Deletes cookies from this browser context.
+     *
+     * @see https://pptr.dev/api/puppeteer.browsercontext.deletecookie
+     */
+    async deleteCookie(...cookies) {
+        await this.sendRpc('deleteCookie', [...cookies]);
+    }
+    /**
+     * Deletes cookies matching the filter criteria from this browser context.
+     *
+     * @see https://pptr.dev/api/puppeteer.browsercontext.deletematchingcookies
+     */
+    async deleteMatchingCookies(...filters) {
+        await this.sendRpc('deleteMatchingCookies', [...filters]);
+    }
+    /**
+     * Grants this browser context the given permissions within the given origin.
+     *
+     * @remarks
+     * All permissions that are not listed will be automatically denied.
+     *
+     * @example
+     * Grant geolocation permission:
+     * ```ts
+     * const context = browser.defaultBrowserContext();
+     * await context.overridePermissions('https://html5demos.com', ['geolocation']);
+     * ```
+     *
+     * @see https://pptr.dev/api/puppeteer.browsercontext.overridepermissions
+     */
+    async overridePermissions(origin, permissions) {
+        await this.sendRpc('overridePermissions', [origin, permissions]);
+    }
+    /**
+     * Clears all permission overrides for this browser context.
+     *
+     * @example
+     * Clear permission overrides:
+     * ```ts
+     * const context = browser.defaultBrowserContext();
+     * context.overridePermissions('https://example.com', ['clipboard-read']);
+     * // do stuff ..
+     * context.clearPermissionOverrides();
+     * ```
+     *
+     * @see https://pptr.dev/api/puppeteer.browsercontext.clearpermissionoverrides
+     */
+    async clearPermissionOverrides() {
+        await this.sendRpc('clearPermissionOverrides', []);
+    }
+    /**
+     * Gets all active targets inside this browser context.
+     *
+     * @see https://pptr.dev/api/puppeteer.browsercontext.targets
+     */
+    async targets() {
+        return this.sendRpc('targets', []);
+    }
+}

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

@@ -0,0 +1,169 @@
+/**
+ * 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 type { RemotePuppeteerPage } from './page.js';
+import type { RemotePuppeteerBrowserContext } from './browser-context.js';
+import type { BrowserEvents, PuppeteerBrowserContextOptions, PuppeteerCookie, PuppeteerCookieData, PuppeteerDeleteCookiesRequest, PuppeteerTarget, PuppeteerTargetFilter, PuppeteerWaitForTargetOptions, PuppeteerWindowBounds } from '../types.js';
+/**
+ * RemotePuppeteerBrowser - Remote Puppeteer Browser API over RPC.
+ *
+ * @see https://pptr.dev/api/puppeteer.browser
+ */
+export declare class RemotePuppeteerBrowser extends PuppeteerEventEmitter<BrowserEvents> {
+    private createPage;
+    private createContext;
+    protected sendRpc: SimpleRpcSender;
+    constructor(sendRpc: SimpleRpcSender, createPage: (pageId: string) => RemotePuppeteerPage, createContext: (contextId: string, isDefault: boolean) => RemotePuppeteerBrowserContext);
+    private _isConnected;
+    private _pages;
+    private _contexts;
+    private _defaultContext;
+    /** Whether the browser is connected. */
+    get isConnected(): boolean;
+    /**
+     * Get all open pages.
+     * @see https://pptr.dev/api/puppeteer.browser.pages
+     */
+    pages(includeAll?: boolean): Promise<RemotePuppeteerPage[]>;
+    /**
+     * Create a new page in the default browser context.
+     * @see https://pptr.dev/api/puppeteer.browser.newpage
+     */
+    newPage(options?: {
+        timeout?: number;
+    }): Promise<RemotePuppeteerPage>;
+    /**
+     * Close the browser.
+     * @see https://pptr.dev/api/puppeteer.browser.close
+     */
+    close(): Promise<void>;
+    /**
+     * Disconnect from the browser (without closing it).
+     * @see https://pptr.dev/api/puppeteer.browser.disconnect
+     */
+    disconnect(): void;
+    /**
+     * Get the default browser context.
+     * @see https://pptr.dev/api/puppeteer.browser.defaultbrowsercontext
+     */
+    defaultBrowserContext(): RemotePuppeteerBrowserContext;
+    /**
+     * Create a new browser context.
+     * @see https://pptr.dev/api/puppeteer.browser.createbrowsercontext
+     */
+    createBrowserContext(options?: PuppeteerBrowserContextOptions): Promise<RemotePuppeteerBrowserContext>;
+    /**
+     * Get all browser contexts.
+     * @see https://pptr.dev/api/puppeteer.browser.browsercontexts
+     */
+    browserContexts(): RemotePuppeteerBrowserContext[];
+    /**
+     * Wait for a target matching the filter.
+     * @see https://pptr.dev/api/puppeteer.browser.waitfortarget
+     */
+    waitForTarget(filter: PuppeteerTargetFilter, options?: PuppeteerWaitForTargetOptions): Promise<PuppeteerTarget>;
+    /**
+     * Get the browser version.
+     *
+     * @see https://pptr.dev/api/puppeteer.browser.version
+     */
+    version(): Promise<string>;
+    /**
+     * Get the browser's user agent.
+     *
+     * @see https://pptr.dev/api/puppeteer.browser.useragent
+     */
+    userAgent(): Promise<string>;
+    /**
+     * Get the WebSocket endpoint for the browser.
+     *
+     * @see https://pptr.dev/api/puppeteer.browser.wsendpoint
+     */
+    wsEndpoint(): Promise<string>;
+    /**
+     * Get browser process info (if available).
+     *
+     * @remarks
+     * Returns serialized process info in RPC mode.
+     */
+    process(): Promise<{
+        pid: number;
+    } | null>;
+    /**
+     * Gets the browser target.
+     *
+     * @see https://pptr.dev/api/puppeteer.browser.target
+     */
+    target(): Promise<PuppeteerTarget>;
+    /**
+     * Gets all active targets inside the browser.
+     *
+     * @remarks
+     * Returns serialized target data in RPC mode.
+     *
+     * @see https://pptr.dev/api/puppeteer.browser.targets
+     */
+    targets(): Promise<PuppeteerTarget[]>;
+    /**
+     * Gets cookies from the default browser context.
+     *
+     * @see https://pptr.dev/api/puppeteer.browser.cookies
+     */
+    cookies(...urls: string[]): Promise<PuppeteerCookie[]>;
+    /**
+     * Sets cookies in the default browser context.
+     *
+     * @see https://pptr.dev/api/puppeteer.browser.setcookie
+     */
+    setCookie(...cookies: PuppeteerCookieData[]): Promise<void>;
+    /**
+     * Deletes cookies from the default browser context.
+     *
+     * @see https://pptr.dev/api/puppeteer.browser.deletecookie
+     */
+    deleteCookie(...cookies: PuppeteerCookie[]): Promise<void>;
+    /**
+     * Deletes cookies matching the filter criteria from the default browser context.
+     *
+     * @see https://pptr.dev/api/puppeteer.browser.deletematchingcookies
+     */
+    deleteMatchingCookies(...filters: PuppeteerDeleteCookiesRequest[]): Promise<void>;
+    /**
+     * Gets the bounds of a browser window.
+     *
+     * @see https://pptr.dev/api/puppeteer.browser.getwindowbounds
+     */
+    getWindowBounds(windowId: number): Promise<PuppeteerWindowBounds>;
+    /**
+     * Sets the bounds of a browser window.
+     *
+     * @see https://pptr.dev/api/puppeteer.browser.setwindowbounds
+     */
+    setWindowBounds(windowId: number, bounds: PuppeteerWindowBounds): Promise<void>;
+    /**
+     * Installs a browser extension.
+     * @returns The extension ID.
+     *
+     * @remarks
+     * In Chrome, this requires the browser to be launched with `pipe: true`
+     * and the `--enable-unsafe-extension-debugging` flag.
+     *
+     * @see https://pptr.dev/api/puppeteer.browser.installextension
+     */
+    installExtension(path: string): Promise<string>;
+    /**
+     * Uninstalls a browser extension.
+     *
+     * @remarks
+     * In Chrome, this requires the browser to be launched with `pipe: true`
+     * and the `--enable-unsafe-extension-debugging` flag.
+     *
+     * @see https://pptr.dev/api/puppeteer.browser.uninstallextension
+     */
+    uninstallExtension(id: string): Promise<void>;
+}