@bctrl/sdk 1.0.1

package/dist/drivers/playwright/event-emitter.js

@@ -0,0 +1,297 @@
+// ============================================================================
+// PlaywrightEventEmitter - EventEmitter base class for Playwright SDK
+// ============================================================================
+//
+// This class provides an EventEmitter implementation that matches the real
+// Playwright EventEmitter API 1:1. It supports local event handling on the SDK
+// side and can be extended by Page, Browser, and other classes.
+//
+// @see https://playwright.dev/docs/api/class-page#events
+// ============================================================================
+import { getRemoteListenerBinding } from '../../base/event-binding.js';
+/**
+ * The EventEmitter class that many Playwright classes extend.
+ *
+ * This provides a familiar event-driven interface for handling browser events
+ * like page load, console messages, dialogs, network requests, etc.
+ *
+ * @example
+ * ```ts
+ * page.on('console', msg => {
+ *   console.log('Page logged:', msg.text());
+ * });
+ *
+ * page.once('load', () => {
+ *   console.log('Page loaded!');
+ * });
+ * ```
+ *
+ * @see https://playwright.dev/docs/api/class-page#events
+ */
+export class PlaywrightEventEmitter {
+    /**
+     * Map of event types to their listeners.
+     * @internal
+     */
+    _listeners = new Map();
+    notifyFirstListener(event) {
+        const binding = getRemoteListenerBinding(this);
+        if (!binding)
+            return;
+        binding.onFirstListener(String(event));
+    }
+    notifyNoListeners(event) {
+        const binding = getRemoteListenerBinding(this);
+        if (!binding)
+            return;
+        binding.onNoListeners(String(event));
+    }
+    /**
+     * Bind an event listener to fire when an event occurs.
+     *
+     * @param event - The event type to listen for.
+     * @param handler - The function to call when the event occurs.
+     * @returns `this` to allow for method chaining.
+     *
+     * @example
+     * ```ts
+     * page.on('request', request => {
+     *   console.log('Request:', request.url());
+     * });
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-page#page-event-request
+     */
+    on(event, handler) {
+        const listeners = this._listeners.get(event) ?? [];
+        const hadListeners = listeners.length > 0;
+        listeners.push({ handler: handler, once: false });
+        this._listeners.set(event, listeners);
+        if (!hadListeners) {
+            this.notifyFirstListener(event);
+        }
+        return this;
+    }
+    /**
+     * Remove an event listener.
+     *
+     * If `handler` is provided, only that specific listener is removed.
+     * If `handler` is not provided, all listeners for that event type are removed.
+     *
+     * @param event - The event type.
+     * @param handler - Optional specific handler to remove.
+     * @returns `this` to allow for method chaining.
+     *
+     * @example
+     * ```ts
+     * const handler = msg => console.log(msg);
+     * page.on('console', handler);
+     * // Later...
+     * page.off('console', handler);
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-page#page-remove-listener
+     */
+    off(event, handler) {
+        if (!handler) {
+            // Remove all listeners for this type
+            const hadListeners = (this._listeners.get(event)?.length ?? 0) > 0;
+            this._listeners.delete(event);
+            if (hadListeners) {
+                this.notifyNoListeners(event);
+            }
+            return this;
+        }
+        const listeners = this._listeners.get(event);
+        if (!listeners) {
+            return this;
+        }
+        const filtered = listeners.filter((entry) => entry.handler !== handler);
+        if (filtered.length === 0) {
+            this._listeners.delete(event);
+            if (listeners.length > 0) {
+                this.notifyNoListeners(event);
+            }
+        }
+        else {
+            this._listeners.set(event, filtered);
+        }
+        return this;
+    }
+    /**
+     * Alias for off() - removes an event listener.
+     *
+     * @see https://playwright.dev/docs/api/class-page#page-remove-listener
+     */
+    removeListener(event, handler) {
+        return this.off(event, handler);
+    }
+    /**
+     * Bind an event listener that will fire only once.
+     *
+     * After the handler is called once, it is automatically removed.
+     *
+     * @param event - The event type to listen for.
+     * @param handler - The function to call when the event occurs.
+     * @returns `this` to allow for method chaining.
+     *
+     * @example
+     * ```ts
+     * page.once('load', () => {
+     *   console.log('Page loaded for the first time!');
+     * });
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-page#page-wait-for-event
+     */
+    once(event, handler) {
+        const listeners = this._listeners.get(event) ?? [];
+        const hadListeners = listeners.length > 0;
+        listeners.push({ handler: handler, once: true });
+        this._listeners.set(event, listeners);
+        if (!hadListeners) {
+            this.notifyFirstListener(event);
+        }
+        return this;
+    }
+    /**
+     * Alias for on() - adds an event listener.
+     *
+     * @see https://playwright.dev/docs/api/class-page#page-event-console
+     */
+    addListener(event, handler) {
+        return this.on(event, handler);
+    }
+    /**
+     * Emit an event, calling all registered handlers.
+     *
+     * This method is typically used internally by Playwright classes to dispatch
+     * events. Users rarely need to call this directly.
+     *
+     * @param event - The event type to emit.
+     * @param data - The event data to pass to handlers.
+     * @returns `true` if there were listeners for this event, `false` otherwise.
+     */
+    emit(event, data) {
+        const listeners = this._listeners.get(event);
+        if (!listeners || listeners.length === 0) {
+            return false;
+        }
+        // Create a copy to avoid issues if handlers modify the listener list
+        const listenersCopy = [...listeners];
+        const toRemove = [];
+        for (const entry of listenersCopy) {
+            try {
+                entry.handler(data);
+            }
+            catch (error) {
+                // Log but don't throw to allow other handlers to run
+                console.error(`Error in event handler for "${String(event)}":`, error);
+            }
+            if (entry.once) {
+                toRemove.push(entry);
+            }
+        }
+        // Remove once listeners
+        if (toRemove.length > 0) {
+            const remaining = listeners.filter((entry) => !toRemove.includes(entry));
+            if (remaining.length === 0) {
+                this._listeners.delete(event);
+                if (listeners.length > 0) {
+                    this.notifyNoListeners(event);
+                }
+            }
+            else {
+                this._listeners.set(event, remaining);
+            }
+        }
+        return true;
+    }
+    /**
+     * Get the count of listeners for a specific event type.
+     *
+     * @param event - The event type.
+     * @returns The number of registered listeners.
+     *
+     * @example
+     * ```ts
+     * const count = page.listenerCount('request');
+     * console.log(`There are ${count} request listeners`);
+     * ```
+     */
+    listenerCount(event) {
+        const listeners = this._listeners.get(event);
+        return listeners?.length ?? 0;
+    }
+    /**
+     * Remove all listeners.
+     *
+     * If `event` is provided, only listeners for that event type are removed.
+     * If `event` is not provided, all listeners for all event types are removed.
+     *
+     * @param event - Optional event type to remove listeners for.
+     * @returns `this` to allow for method chaining.
+     *
+     * @example
+     * ```ts
+     * // Remove all 'request' listeners
+     * page.removeAllListeners('request');
+     *
+     * // Remove ALL listeners
+     * page.removeAllListeners();
+     * ```
+     */
+    removeAllListeners(event) {
+        if (event === undefined) {
+            const existingEvents = Array.from(this._listeners.entries())
+                .filter(([, listeners]) => listeners.length > 0)
+                .map(([eventName]) => eventName);
+            this._listeners.clear();
+            for (const eventName of existingEvents) {
+                this.notifyNoListeners(eventName);
+            }
+        }
+        else {
+            const hadListeners = (this._listeners.get(event)?.length ?? 0) > 0;
+            this._listeners.delete(event);
+            if (hadListeners) {
+                this.notifyNoListeners(event);
+            }
+        }
+        return this;
+    }
+    /**
+     * PrependListener - adds a listener that will be called before other listeners.
+     *
+     * @param event - The event type to listen for.
+     * @param handler - The function to call when the event occurs.
+     * @returns `this` to allow for method chaining.
+     */
+    prependListener(event, handler) {
+        const listeners = this._listeners.get(event) ?? [];
+        const hadListeners = listeners.length > 0;
+        listeners.unshift({ handler: handler, once: false });
+        this._listeners.set(event, listeners);
+        if (!hadListeners) {
+            this.notifyFirstListener(event);
+        }
+        return this;
+    }
+    /**
+     * PrependOnceListener - adds a once listener that will be called before other listeners.
+     *
+     * @param event - The event type to listen for.
+     * @param handler - The function to call when the event occurs.
+     * @returns `this` to allow for method chaining.
+     */
+    prependOnceListener(event, handler) {
+        const listeners = this._listeners.get(event) ?? [];
+        const hadListeners = listeners.length > 0;
+        listeners.unshift({ handler: handler, once: true });
+        this._listeners.set(event, listeners);
+        if (!hadListeners) {
+            this.notifyFirstListener(event);
+        }
+        return this;
+    }
+}

package/dist/drivers/playwright/generated/api-request-context.d.ts

@@ -0,0 +1,137 @@
+/**
+ * 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 { PlaywrightAPIRequestOptions, PlaywrightAPIResponse, PlaywrightStorageState, PlaywrightStorageStateOptions } from '../types.js';
+/**
+ * RemotePlaywrightAPIRequestContext - Remote Playwright APIRequestContext API over RPC.
+ *
+ * @see https://playwright.dev/docs/api/class-apirequestcontext
+ */
+export declare class RemotePlaywrightAPIRequestContext extends RemoteComponentBase {
+    constructor(sendRpc: SimpleRpcSender);
+    /**
+     * Sends HTTP(S) GET request and returns its response.
+     * @param url - Target URL.
+     * @param options - Request options.
+     *
+     * @remarks
+     * Sends an HTTP(S) GET request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-get
+     */
+    get(url: string, options?: PlaywrightAPIRequestOptions): Promise<PlaywrightAPIResponse>;
+    /**
+     * Sends HTTP(S) POST request and returns its response.
+     * @param url - Target URL.
+     * @param options - Request options.
+     *
+     * @remarks
+     * Sends an HTTP(S) POST request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-post
+     */
+    post(url: string, options?: PlaywrightAPIRequestOptions): Promise<PlaywrightAPIResponse>;
+    /**
+     * Sends HTTP(S) PUT request and returns its response.
+     * @param url - Target URL.
+     * @param options - Request options.
+     *
+     * @remarks
+     * Sends an HTTP(S) PUT request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-put
+     */
+    put(url: string, options?: PlaywrightAPIRequestOptions): Promise<PlaywrightAPIResponse>;
+    /**
+     * Sends HTTP(S) DELETE request and returns its response.
+     * @param url - Target URL.
+     * @param options - Request options.
+     *
+     * @remarks
+     * Sends an HTTP(S) DELETE request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-delete
+     */
+    delete(url: string, options?: PlaywrightAPIRequestOptions): Promise<PlaywrightAPIResponse>;
+    /**
+     * Sends HTTP(S) PATCH request and returns its response.
+     * @param url - Target URL.
+     * @param options - Request options.
+     *
+     * @remarks
+     * Sends an HTTP(S) PATCH request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-patch
+     */
+    patch(url: string, options?: PlaywrightAPIRequestOptions): Promise<PlaywrightAPIResponse>;
+    /**
+     * Sends HTTP(S) HEAD request and returns its response.
+     * @param url - Target URL.
+     * @param options - Request options.
+     *
+     * @remarks
+     * Sends an HTTP(S) HEAD request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-head
+     */
+    head(url: string, options?: PlaywrightAPIRequestOptions): Promise<PlaywrightAPIResponse>;
+    /**
+     * Sends HTTP(S) request and returns its response.
+     * @param urlOrRequest - Target URL or Request to get all parameters from.
+     * @param options - Request options.
+     *
+     * @remarks
+     * This method can be used to send requests with any HTTP method. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
+     *
+     * @example
+     * ```ts
+     * // Send a GET request
+     * const response = await request.fetch('https://example.com/api/users');
+     *
+     * // Send a POST request with JSON body
+     * const response = await request.fetch('https://example.com/api/users', {
+     *   method: 'post',
+     *   data: { name: 'John Doe', email: 'john@example.com' }
+     * });
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-fetch
+     */
+    fetch(urlOrRequest: string, options?: PlaywrightAPIRequestOptions): Promise<PlaywrightAPIResponse>;
+    /**
+     * All responses returned by this context will be disposed of and no longer accessible.
+     * @param options - Options for disposal.
+     *
+     * @remarks
+     * The method will await for the disposal of the context. Calling dispose() is optional but recommended to release resources.
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-dispose
+     */
+    dispose(options?: {
+        reason?: string;
+    }): Promise<void>;
+    /**
+     * Returns storage state for this request context.
+     * @param options - Options for saving storage state.
+     *
+     * @remarks
+     * Returns cookies and local storage snapshot. Can be used to save and later restore the storage state with `browser.newContext()` or `request.newContext()`.
+     *
+     * @example
+     * ```ts
+     * // Get storage state
+     * const state = await request.storageState();
+     *
+     * // Save storage state to file
+     * const state = await request.storageState({ path: 'state.json' });
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-storage-state
+     */
+    storageState(options?: PlaywrightStorageStateOptions): Promise<PlaywrightStorageState>;
+}

package/dist/drivers/playwright/generated/api-request-context.js

@@ -0,0 +1,154 @@
+/**
+ * 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';
+/**
+ * RemotePlaywrightAPIRequestContext - Remote Playwright APIRequestContext API over RPC.
+ *
+ * @see https://playwright.dev/docs/api/class-apirequestcontext
+ */
+export class RemotePlaywrightAPIRequestContext extends RemoteComponentBase {
+    constructor(sendRpc) {
+        super(sendRpc);
+    }
+    /**
+     * Sends HTTP(S) GET request and returns its response.
+     * @param url - Target URL.
+     * @param options - Request options.
+     *
+     * @remarks
+     * Sends an HTTP(S) GET request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-get
+     */
+    async get(url, options) {
+        return this.rpc('apiRequest.get', [url, options]);
+    }
+    /**
+     * Sends HTTP(S) POST request and returns its response.
+     * @param url - Target URL.
+     * @param options - Request options.
+     *
+     * @remarks
+     * Sends an HTTP(S) POST request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-post
+     */
+    async post(url, options) {
+        return this.rpc('apiRequest.post', [url, options]);
+    }
+    /**
+     * Sends HTTP(S) PUT request and returns its response.
+     * @param url - Target URL.
+     * @param options - Request options.
+     *
+     * @remarks
+     * Sends an HTTP(S) PUT request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-put
+     */
+    async put(url, options) {
+        return this.rpc('apiRequest.put', [url, options]);
+    }
+    /**
+     * Sends HTTP(S) DELETE request and returns its response.
+     * @param url - Target URL.
+     * @param options - Request options.
+     *
+     * @remarks
+     * Sends an HTTP(S) DELETE request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-delete
+     */
+    async delete(url, options) {
+        return this.rpc('apiRequest.delete', [url, options]);
+    }
+    /**
+     * Sends HTTP(S) PATCH request and returns its response.
+     * @param url - Target URL.
+     * @param options - Request options.
+     *
+     * @remarks
+     * Sends an HTTP(S) PATCH request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-patch
+     */
+    async patch(url, options) {
+        return this.rpc('apiRequest.patch', [url, options]);
+    }
+    /**
+     * Sends HTTP(S) HEAD request and returns its response.
+     * @param url - Target URL.
+     * @param options - Request options.
+     *
+     * @remarks
+     * Sends an HTTP(S) HEAD request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-head
+     */
+    async head(url, options) {
+        return this.rpc('apiRequest.head', [url, options]);
+    }
+    /**
+     * Sends HTTP(S) request and returns its response.
+     * @param urlOrRequest - Target URL or Request to get all parameters from.
+     * @param options - Request options.
+     *
+     * @remarks
+     * This method can be used to send requests with any HTTP method. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.
+     *
+     * @example
+     * ```ts
+     * // Send a GET request
+     * const response = await request.fetch('https://example.com/api/users');
+     *
+     * // Send a POST request with JSON body
+     * const response = await request.fetch('https://example.com/api/users', {
+     *   method: 'post',
+     *   data: { name: 'John Doe', email: 'john@example.com' }
+     * });
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-fetch
+     */
+    async fetch(urlOrRequest, options) {
+        return this.rpc('apiRequest.fetch', [urlOrRequest, options]);
+    }
+    /**
+     * All responses returned by this context will be disposed of and no longer accessible.
+     * @param options - Options for disposal.
+     *
+     * @remarks
+     * The method will await for the disposal of the context. Calling dispose() is optional but recommended to release resources.
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-dispose
+     */
+    async dispose(options) {
+        await this.rpc('apiRequest.dispose', [options]);
+        this.markClosed();
+    }
+    /**
+     * Returns storage state for this request context.
+     * @param options - Options for saving storage state.
+     *
+     * @remarks
+     * Returns cookies and local storage snapshot. Can be used to save and later restore the storage state with `browser.newContext()` or `request.newContext()`.
+     *
+     * @example
+     * ```ts
+     * // Get storage state
+     * const state = await request.storageState();
+     *
+     * // Save storage state to file
+     * const state = await request.storageState({ path: 'state.json' });
+     * ```
+     *
+     * @see https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-storage-state
+     */
+    async storageState(options) {
+        return this.rpc('apiRequest.storageState', [options]);
+    }
+}