@bctrl/sdk 1.0.1

package/dist/drivers/playwright/generated/api-response.d.ts

@@ -0,0 +1,119 @@
+/**
+ * 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';
+/**
+ * Serialized API response data sent over RPC.
+ */
+export interface SerializedAPIResponse {
+    /** Unique identifier for this response (for body fetching) */
+    id: string;
+    /** Response URL */
+    url: string;
+    /** HTTP status code */
+    status: number;
+    /** HTTP status text */
+    statusText: string;
+    /** Whether status is 200-299 */
+    ok: boolean;
+    /** Response headers (lowercase keys) */
+    headers: Record<string, string>;
+    /** Response headers array (original case) */
+    headersArray: Array<{
+        name: string;
+        value: string;
+    }>;
+}
+/**
+ * RemotePlaywrightAPIResponse - Remote Playwright APIResponse API over RPC.
+ *
+ * @see https://playwright.dev/docs/api/class-apiresponse
+ */
+export declare class RemotePlaywrightAPIResponse extends RemoteBase {
+    private readonly _url;
+    private readonly _status;
+    private readonly _statusText;
+    private readonly _ok;
+    private readonly _headers;
+    private readonly _headersArray;
+    constructor(sendRpc: SimpleRpcSender, data: SerializedAPIResponse);
+    /**
+     * Returns the buffer with response body.
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-body
+     */
+    body(): Promise<Buffer>;
+    /**
+     * Contains the URL of the response.
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-url
+     */
+    url(): string;
+    /**
+     * Contains the status code of the response (e.g., 200 for a success).
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-status
+     */
+    status(): number;
+    /**
+     * Contains the status text of the response (e.g., "OK" for a success).
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-status-text
+     */
+    statusText(): string;
+    /**
+     * Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-ok
+     */
+    ok(): boolean;
+    /**
+     * An object with all the response HTTP headers associated with this response.
+     *
+     * @remarks
+     * Header names are lower-cased.
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-headers
+     */
+    headers(): Record<string, string>;
+    /**
+     * An array with all the response HTTP headers associated with this response.
+     *
+     * @remarks
+     * Header names are NOT lower-cased. Headers with multiple entries, such as Set-Cookie, appear in the array multiple times.
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-headers-array
+     */
+    headersArray(): Array<{
+        name: string;
+        value: string;
+    }>;
+    /**
+     * Returns the text representation of response body.
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-text
+     */
+    text(): Promise<string>;
+    /**
+     * Returns the JSON representation of response body.
+     *
+     * @remarks
+     * This method will throw if the response body is not parsable via JSON.parse.
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-json
+     */
+    json(): Promise<unknown>;
+    /**
+     * Disposes the body of this response.
+     *
+     * @remarks
+     * If not called, the body will stay in memory until the context closes.
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-dispose
+     */
+    dispose(): Promise<void>;
+}

package/dist/drivers/playwright/generated/api-response.js

@@ -0,0 +1,123 @@
+/**
+ * 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';
+/**
+ * RemotePlaywrightAPIResponse - Remote Playwright APIResponse API over RPC.
+ *
+ * @see https://playwright.dev/docs/api/class-apiresponse
+ */
+export class RemotePlaywrightAPIResponse extends RemoteBase {
+    _url;
+    _status;
+    _statusText;
+    _ok;
+    _headers;
+    _headersArray;
+    constructor(sendRpc, data) {
+        super(data.id, sendRpc);
+        this._url = data.url;
+        this._status = data.status;
+        this._statusText = data.statusText;
+        this._ok = data.ok;
+        this._headers = data.headers;
+        this._headersArray = data.headersArray;
+    }
+    /**
+     * Returns the buffer with response body.
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-body
+     */
+    async body() {
+        const base64 = await this.rpc('apiResponse.body', [this.id]);
+        return Buffer.from(base64, 'base64');
+    }
+    /**
+     * Contains the URL of the response.
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-url
+     */
+    url() {
+        return this._url;
+    }
+    /**
+     * Contains the status code of the response (e.g., 200 for a success).
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-status
+     */
+    status() {
+        return this._status;
+    }
+    /**
+     * Contains the status text of the response (e.g., "OK" for a success).
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-status-text
+     */
+    statusText() {
+        return this._statusText;
+    }
+    /**
+     * Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-ok
+     */
+    ok() {
+        return this._ok;
+    }
+    /**
+     * An object with all the response HTTP headers associated with this response.
+     *
+     * @remarks
+     * Header names are lower-cased.
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-headers
+     */
+    headers() {
+        return this._headers;
+    }
+    /**
+     * An array with all the response HTTP headers associated with this response.
+     *
+     * @remarks
+     * Header names are NOT lower-cased. Headers with multiple entries, such as Set-Cookie, appear in the array multiple times.
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-headers-array
+     */
+    headersArray() {
+        return this._headersArray;
+    }
+    /**
+     * Returns the text representation of response body.
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-text
+     */
+    async text() {
+        return this.rpc('apiResponse.text', [this.id]);
+    }
+    /**
+     * Returns the JSON representation of response body.
+     *
+     * @remarks
+     * This method will throw if the response body is not parsable via JSON.parse.
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-json
+     */
+    async json() {
+        return this.rpc('apiResponse.json', [this.id]);
+    }
+    /**
+     * Disposes the body of this response.
+     *
+     * @remarks
+     * If not called, the body will stay in memory until the context closes.
+     *
+     * @see https://playwright.dev/docs/api/class-apiresponse#api-response-dispose
+     */
+    async dispose() {
+        await this.rpc('apiResponse.dispose', [this.id]);
+        this.markClosed();
+    }
+}

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

@@ -0,0 +1,284 @@
+/**
+ * AUTO-GENERATED FILE - DO NOT EDIT
+ *
+ * Generated from: packages/automation-spec/src/drivers/playwright/methods/
+ * Run `pnpm generate:playwright` to regenerate.
+ */
+import type { HasHandleId, SimpleRpcSender } from '../../../internal/transport.js';
+import type { PlaywrightClearCookiesOptions, PlaywrightCookie, PlaywrightGeolocation, PlaywrightGrantPermissionsOptions, PlaywrightHttpCredentials, PlaywrightPermission, PlaywrightRouteFromHAROptions, PlaywrightRouteOptions, PlaywrightStorageState, PlaywrightUnrouteAllOptions, PlaywrightWaitForEventOptions } from '../types.js';
+import { RemoteBase } from '../remote-base.js';
+import { RemotePlaywrightClock } from './clock.js';
+import { RemotePlaywrightTracing } from './tracing.js';
+import { RemotePlaywrightAPIRequestContext } from './api-request-context.js';
+import type { RemotePlaywrightPage } from './page.js';
+import type { RemotePlaywrightBrowser } from './browser.js';
+/**
+ * RemotePlaywrightBrowserContext - Remote Playwright BrowserContext API over RPC.
+ *
+ * @see https://playwright.dev/docs/api/class-browsercontext
+ */
+export declare class RemotePlaywrightBrowserContext extends RemoteBase {
+    constructor(id: string, sendRpc: SimpleRpcSender, createPage: (id: string) => RemotePlaywrightPage, browserRef: RemotePlaywrightBrowser | null);
+    private _browser;
+    private _defaultTimeout;
+    private _defaultNavigationTimeout;
+    private _listeners;
+    private _clock;
+    private _request;
+    private _tracing;
+    private createPage;
+    private notifyFirstListener;
+    private notifyNoListeners;
+    /**
+     * Returns the browser this context belongs to.
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-browser
+     */
+    browser(): RemotePlaywrightBrowser | null;
+    /**
+     * Playwright Clock API for mocking time.
+     * @see https://playwright.dev/docs/api/class-clock
+     */
+    get clock(): RemotePlaywrightClock;
+    /**
+     * API testing helper associated with this context.
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-request
+     */
+    get request(): RemotePlaywrightAPIRequestContext;
+    /**
+     * Tracing helper for recording execution traces.
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-tracing
+     */
+    get tracing(): RemotePlaywrightTracing;
+    /**
+     * Sets the default maximum navigation timeout.
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-set-default-navigation-timeout
+     */
+    setDefaultNavigationTimeout(timeout: number): Promise<void>;
+    /**
+     * Sets the default maximum time for all methods accepting timeout option.
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-set-default-timeout
+     */
+    setDefaultTimeout(timeout: number): Promise<void>;
+    on(event: string, handler: (event: unknown) => void): this;
+    once(event: string, handler: (event: unknown) => void): this;
+    off(event: string, handler?: (event: unknown) => void): this;
+    addListener(event: string, handler: (event: unknown) => void): this;
+    removeListener(event: string, handler: (event: unknown) => void): this;
+    listenerCount(event: string): number;
+    emit(event: string, payload: unknown): boolean;
+    /**
+     * Removes all listeners for the specified event, or all events if no event is specified.
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-remove-all-listeners
+     */
+    removeAllListeners(event?: string): this;
+    /**
+     * Returns all open pages in the context.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-pages
+     */
+    pages(): Promise<RemotePlaywrightPage[]>;
+    /**
+     * Returns all service workers in the context.
+     *
+     * @remarks
+     * Service workers are only available on Chromium-based browsers.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-service-workers
+     */
+    serviceWorkers(): Promise<Array<{
+        url: string;
+        workerId: string;
+    }>>;
+    /**
+     * Creates a new page in the browser context.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-new-page
+     */
+    newPage(): Promise<RemotePlaywrightPage>;
+    /**
+     * Returns the newly created CDP session attached to the given page.
+     * @param page - Target page to create CDP session for.
+     *
+     * @remarks
+     * CDP Sessions are only supported on Chromium-based browsers.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-new-cdp-session
+     */
+    newCDPSession(page: HasHandleId): Promise<{
+        sessionId: string;
+    }>;
+    /**
+     * Adds cookies into this browser context. All pages within this context will have these cookies installed.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-add-cookies
+     */
+    addCookies(cookies: PlaywrightCookie[]): Promise<void>;
+    /**
+     * Returns cookies for the specified URLs, or all cookies if no URLs are specified.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-cookies
+     */
+    cookies(urls?: string | string[]): Promise<PlaywrightCookie[]>;
+    /**
+     * Removes cookies from context. Accepts optional filter to remove specific cookies.
+     *
+     * @remarks
+     * If no options are provided, removes all cookies from the context.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-clear-cookies
+     */
+    clearCookies(options?: PlaywrightClearCookiesOptions): Promise<void>;
+    /**
+     * Grants specified permissions to the browser context.
+     *
+     * @remarks
+     * Only grants corresponding permissions to the given origin if specified.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-grant-permissions
+     */
+    grantPermissions(permissions: PlaywrightPermission[], options?: PlaywrightGrantPermissionsOptions): Promise<void>;
+    /**
+     * Clears all permission overrides for the browser context.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-clear-permissions
+     */
+    clearPermissions(): Promise<void>;
+    /**
+     * Adds a script which would be evaluated in one of the following scenarios: whenever a page is created in the context or navigated.
+     *
+     * @remarks
+     * The script is evaluated before any page script. Use when you want to inject JavaScript before the page loads.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-add-init-script
+     */
+    addInitScript(script: Function | string | {
+        path?: string;
+        content?: string;
+    }, arg?: unknown): Promise<void>;
+    /**
+     * Adds a function called name on the window object of every frame in every page in the context.
+     *
+     * @remarks
+     * When called, the function executes callback and returns a Promise which resolves to the return value of callback. The first argument of the callback function contains information about the caller.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-expose-binding
+     */
+    exposeBinding(name: string, callback: Function, options?: {
+        handle?: boolean;
+    }): Promise<void>;
+    /**
+     * Routing provides the capability to modify network requests that are made by any page in the browser context.
+     *
+     * @remarks
+     * Once routing is enabled, every request matching the url pattern will stall unless it is continued, fulfilled, or aborted.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-route
+     */
+    route(url: string | RegExp | ((url: URL) => boolean), handler: Function, options?: PlaywrightRouteOptions): Promise<void>;
+    /**
+     * If specified, network requests that are made in the context will be served from the HAR file.
+     * @param har - Path to a HAR file with recorded network data.
+     *
+     * @remarks
+     * Read more about Replaying from HAR.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-route-from-har
+     */
+    routeFromHAR(har: string, options?: PlaywrightRouteFromHAROptions): Promise<void>;
+    /**
+     * Removes a route created with browserContext.route(). When handler is not specified, removes all routes for the url.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-unroute
+     */
+    unroute(url: string | RegExp | ((url: URL) => boolean), handler?: Function): Promise<void>;
+    /**
+     * Removes all routes created with browserContext.route() and browserContext.routeFromHAR().
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-unroute-all
+     */
+    unrouteAll(options?: PlaywrightUnrouteAllOptions): Promise<void>;
+    /**
+     * Sets extra HTTP headers that will be sent with every request in the context.
+     *
+     * @remarks
+     * These headers are merged with page-specific extra HTTP headers set with page.setExtraHTTPHeaders(). If page overrides a particular header, page-specific header value will be used instead of the browser context header value.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-set-extra-http-headers
+     */
+    setExtraHTTPHeaders(headers: Record<string, string>): Promise<void>;
+    /**
+     * Sets HTTP credentials for HTTP authentication.
+     *
+     * @remarks
+     * Deprecated: Browsers may cache credentials after successful authentication. Create a new browser context instead.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-set-http-credentials
+     */
+    setHTTPCredentials(httpCredentials: PlaywrightHttpCredentials | null): Promise<void>;
+    /**
+     * Sets whether to emulate network being offline for the browser context.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-set-offline
+     */
+    setOffline(offline: boolean): Promise<void>;
+    /**
+     * Sets the contexts geolocation. Passing null clears geolocation.
+     *
+     * @remarks
+     * Requires the geolocation permission to be granted.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-set-geolocation
+     */
+    setGeolocation(geolocation: PlaywrightGeolocation | null): Promise<void>;
+    /**
+     * Returns storage state for this browser context.
+     *
+     * @remarks
+     * Contains current cookies and local storage snapshot.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-storage-state
+     */
+    storageState(options?: {
+        path?: string;
+    }): Promise<PlaywrightStorageState>;
+    /**
+     * Waits for event to fire and passes its value into the predicate function.
+     *
+     * @remarks
+     * Returns when the predicate returns truthy value. Will throw an error if the context closes before the event is fired.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-wait-for-event
+     */
+    waitForEvent<T = unknown>(event: string, optionsOrPredicate?: PlaywrightWaitForEventOptions | ((event: unknown) => boolean)): Promise<T>;
+    /**
+     * Allows modifying WebSocket connections made by pages in the context.
+     * @param url - URL pattern to match WebSocket connections.
+     * @param handler - Handler function to route the WebSocket.
+     *
+     * @remarks
+     * Only WebSockets created after this method was called will be routed. It is recommended to call this method before creating any pages.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-route-web-socket
+     */
+    routeWebSocket(url: string | RegExp | ((url: URL) => boolean), handler: Function): Promise<void>;
+    /**
+     * Closes the browser context. All the pages that belong to the browser context will be closed.
+     *
+     * @remarks
+     * The default browser context cannot be closed.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-close
+     */
+    close(options?: {
+        reason?: string;
+    }): Promise<void>;
+    /**
+     * Returns all background pages in the context.
+     *
+     * @remarks
+     * Deprecated. Background pages are only supported on Chromium-based browsers.
+     *
+     * @see https://playwright.dev/docs/api/class-browsercontext#browser-context-background-pages
+     */
+    backgroundPages(): Promise<RemotePlaywrightPage[]>;
+}