@bctrl/sdk 1.0.1 → 1.0.3

package/dist/drivers/stagehand/generated/response.js

@@ -1,232 +0,0 @@
-/**
- * AUTO-GENERATED FILE - DO NOT EDIT
- *
- * Generated from: packages/automation-spec/src/drivers/stagehand/methods/
- * Run `pnpm generate:stagehand` to regenerate.
- */
-/**
- * RemoteStagehandResponse - Remote Puppeteer Response API over RPC.
- *
- * @see https://pptr.dev/api/puppeteer.response
- */
-export class RemoteStagehandResponse {
-    sendRpc;
-    _id;
-    _url;
-    _status;
-    _statusText;
-    _ok;
-    _headers;
-    _fromServiceWorker;
-    constructor(sendRpc, data) {
-        this.sendRpc = sendRpc;
-        this._id = data.id;
-        this._url = data.url;
-        this._status = data.status;
-        this._statusText = data.statusText;
-        this._ok = data.ok;
-        this._headers = data.headers;
-        this._fromServiceWorker = data.fromServiceWorker;
-    }
-    rpc(method, args) {
-        return this.sendRpc(method, args);
-    }
-    /**
-     * Get the frame that initiated this response (synchronous version).
-     * Note: Not fully supported in remote SDK.
-     */
-    frame() {
-        return null;
-    }
-    /**
-     * Get the URL of the response.
-     *
-     * @example
-     * const url = response.url();
-     *
-     * @see https://docs.stagehand.dev/references/response#url
-     */
-    url() {
-        return this._url;
-    }
-    /**
-     * Get the HTTP status code of the response.
-     *
-     * @example
-     * const statusCode = response.status();
-     *
-     * @see https://docs.stagehand.dev/references/response#status
-     */
-    status() {
-        return this._status;
-    }
-    /**
-     * Get the HTTP status text of the response.
-     *
-     * @example
-     * const text = response.statusText();
-     *
-     * @see https://docs.stagehand.dev/references/response#statustext
-     */
-    statusText() {
-        return this._statusText;
-    }
-    /**
-     * Check if the response status is in the 200-299 range.
-     *
-     * @example
-     * if (response.ok()) { console.log("success"); }
-     *
-     * @see https://docs.stagehand.dev/references/response#ok
-     */
-    ok() {
-        return this._ok;
-    }
-    /**
-     * Check if the response was served from a service worker.
-     *
-     * @example
-     * const fromSW = response.fromServiceWorker();
-     *
-     * @see https://docs.stagehand.dev/references/response#fromserviceworker
-     */
-    fromServiceWorker() {
-        return this._fromServiceWorker;
-    }
-    /**
-     * Get the security details of the response (for HTTPS).
-     *
-     * @remarks
-     * Returns null for non-HTTPS responses.
-     *
-     * @example
-     * const security = await response.securityDetails();
-     *
-     * @see https://docs.stagehand.dev/references/response#securitydetails
-     */
-    async securityDetails() {
-        return this.rpc('securityDetails', []);
-    }
-    /**
-     * Get the server address (IP and port) that served the response.
-     *
-     * @example
-     * const addr = await response.serverAddr();
-     *
-     * @see https://docs.stagehand.dev/references/response#serveraddr
-     */
-    async serverAddr() {
-        return this.rpc('serverAddr', []);
-    }
-    /**
-     * Get all response headers as an object.
-     *
-     * @remarks
-     * Header names are lower-cased. Multiple values for the same header are joined with ", ".
-     *
-     * @example
-     * const headers = response.headers();
-     *
-     * @see https://docs.stagehand.dev/references/response#headers
-     */
-    headers() {
-        return this._headers;
-    }
-    /**
-     * Get all response headers including those not exposed by the standard API.
-     *
-     * @example
-     * const allHeaders = await response.allHeaders();
-     *
-     * @see https://docs.stagehand.dev/references/response#allheaders
-     */
-    async allHeaders() {
-        return this.rpc('allHeaders', []);
-    }
-    /**
-     * Get the value of a specific header.
-     * @param name - Header name (case-insensitive).
-     *
-     * @example
-     * const contentType = await response.headerValue("content-type");
-     *
-     * @see https://docs.stagehand.dev/references/response#headervalue
-     */
-    async headerValue(name) {
-        return this.rpc('headerValue', [name]);
-    }
-    /**
-     * Get all values of a specific header (for headers with multiple values).
-     * @param name - Header name (case-insensitive).
-     *
-     * @example
-     * const cookies = await response.headerValues("set-cookie");
-     *
-     * @see https://docs.stagehand.dev/references/response#headervalues
-     */
-    async headerValues(name) {
-        return this.rpc('headerValues', [name]);
-    }
-    /**
-     * Get all response headers as an array of { name, value } objects.
-     *
-     * @remarks
-     * Preserves multiple values for the same header as separate entries.
-     *
-     * @example
-     * const headersArray = await response.headersArray();
-     *
-     * @see https://docs.stagehand.dev/references/response#headersarray
-     */
-    async headersArray() {
-        return this.rpc('headersArray', []);
-    }
-    /**
-     * Get the response body as a Buffer.
-     *
-     * @example
-     * const buffer = await response.body();
-     *
-     * @see https://docs.stagehand.dev/references/response#body
-     */
-    async body() {
-        const result = await this.rpc('body', []);
-        return Buffer.from(result, 'base64');
-    }
-    /**
-     * Get the response body as text.
-     *
-     * @example
-     * const text = await response.text();
-     *
-     * @see https://docs.stagehand.dev/references/response#text
-     */
-    async text() {
-        return this.rpc('text', []);
-    }
-    /**
-     * Get the response body parsed as JSON.
-     *
-     * @example
-     * const data = await response.json();
-     *
-     * @see https://docs.stagehand.dev/references/response#json
-     */
-    async json() {
-        return this.rpc('json', []);
-    }
-    /**
-     * Wait for the response to finish and get any error message.
-     *
-     * @remarks
-     * Returns null if the response was successful, or an error message if it failed.
-     *
-     * @example
-     * const error = await response.finished();
-     *
-     * @see https://docs.stagehand.dev/references/response#finished
-     */
-    async finished() {
-        return this.rpc('finished', []);
-    }
-}

package/dist/drivers/stagehand/index.d.ts

@@ -1,5 +0,0 @@
-export * from './types.js';
-export { RemoteStagehandPage } from './generated/page.js';
-export { RemoteStagehandLocator } from './generated/locator.js';
-export { RemoteStagehandContext } from './generated/context.js';
-export { RemoteStagehandResponse } from './generated/response.js';

package/dist/drivers/stagehand/index.js

@@ -1,8 +0,0 @@
-// Stagehand driver exports.
-// Re-export types
-export * from './types.js';
-// Generated classes
-export { RemoteStagehandPage } from './generated/page.js';
-export { RemoteStagehandLocator } from './generated/locator.js';
-export { RemoteStagehandContext } from './generated/context.js';
-export { RemoteStagehandResponse } from './generated/response.js';

package/dist/drivers/stagehand/types.d.ts

@@ -1 +0,0 @@
-export type { StagehandLoadState, StagehandGotoOptions, StagehandReloadOptions, StagehandClickOptions, StagehandHoverOptions, StagehandDragAndDropOptions, StagehandTypeOptions, StagehandLocatorClickOptions, StagehandLocatorTypeOptions, StagehandHighlightOptions, StagehandSendClickEventOptions, StagehandFilePayload, StagehandFileInput, StagehandWaitForSelectorOptions, StagehandScreenshotClip, StagehandScreenshotOptions, StagehandSnapshotOptions, StagehandSnapshotResult, StagehandViewportSize, StagehandViewportOptions, StagehandSecurityDetails, StagehandServerAddr, StagehandHeaderEntry, StagehandInitScriptSource, } from '../../contracts/drivers/stagehand.js';

package/dist/drivers/stagehand/types.js

@@ -1,7 +0,0 @@
-// ============================================================================
-// Stagehand Driver Types
-// ============================================================================
-//
-// Re-export type definitions from the SDK-local Stagehand contract module.
-// ============================================================================
-export {};

package/dist/extensions/client.d.ts

@@ -1,47 +0,0 @@
-import type { ExtensionMetadata } from '../contracts/extensions.js';
-export declare class ExtensionsClient {
-    private readonly baseUrl;
-    private readonly apiKey?;
-    constructor(baseUrl: string, apiKey?: string | undefined);
-    private headers;
-    private jsonHeaders;
-    /**
-     * Upload an extension from a file buffer or Chrome Web Store URL.
-     */
-    upload(opts: {
-        file?: Buffer;
-        filename?: string;
-        url?: string;
-    }): Promise<ExtensionMetadata>;
-    /**
-     * List all uploaded extensions.
-     */
-    list(): Promise<ExtensionMetadata[]>;
-    /**
-     * Get extension metadata by ID.
-     */
-    get(id: string): Promise<ExtensionMetadata | null>;
-    /**
-     * Update an existing extension with a new file.
-     */
-    update(id: string, opts: {
-        file: Buffer;
-        filename: string;
-    }): Promise<ExtensionMetadata>;
-    /**
-     * Delete an extension.
-     */
-    delete(id: string): Promise<void>;
-    /**
-     * Install extension(s) on a browser profile.
-     */
-    install(browserName: string, extensionIds: string | string[]): Promise<void>;
-    /**
-     * Uninstall an extension from a browser profile.
-     */
-    uninstall(browserName: string, extensionId: string): Promise<void>;
-    /**
-     * List extensions installed on a browser profile.
-     */
-    installed(browserName: string): Promise<ExtensionMetadata[]>;
-}

package/dist/extensions/client.js

@@ -1,154 +0,0 @@
-/**
- * ExtensionsClient — SDK client for browser extension management.
- *
- * Handles account-level extension CRUD and profile-level install/uninstall.
- */
-import { fetchWithTimeout, parseJsonResponse } from '../utils/http.js';
-import { SDK_VERSION } from '../version.js';
-// ============================================================================
-// ExtensionsClient
-// ============================================================================
-export class ExtensionsClient {
-    baseUrl;
-    apiKey;
-    constructor(baseUrl, apiKey) {
-        this.baseUrl = baseUrl;
-        this.apiKey = apiKey;
-    }
-    headers() {
-        const h = {
-            'x-sdk-version': SDK_VERSION,
-        };
-        if (this.apiKey)
-            h['Authorization'] = `Bearer ${this.apiKey}`;
-        return h;
-    }
-    jsonHeaders() {
-        return { 'Content-Type': 'application/json', ...this.headers() };
-    }
-    // --------------------------------------------------------------------------
-    // Account-level extension management
-    // --------------------------------------------------------------------------
-    /**
-     * Upload an extension from a file buffer or Chrome Web Store URL.
-     */
-    async upload(opts) {
-        if (opts.url) {
-            // JSON body with URL
-            const res = await fetchWithTimeout(`${this.baseUrl}/extensions/upload`, {
-                method: 'POST',
-                headers: this.jsonHeaders(),
-                body: JSON.stringify({ url: opts.url }),
-            });
-            if (!res.ok)
-                throw new Error(`Extension upload failed: ${await res.text()}`);
-            return parseJsonResponse(res, 'Extension upload');
-        }
-        if (!opts.file) {
-            throw new Error('Either file or url must be provided');
-        }
-        // Multipart file upload
-        const formData = new FormData();
-        const blob = new Blob([new Uint8Array(opts.file)], { type: 'application/octet-stream' });
-        formData.append('file', blob, opts.filename || 'extension.crx');
-        const res = await fetchWithTimeout(`${this.baseUrl}/extensions/upload`, {
-            method: 'POST',
-            headers: this.headers(), // No Content-Type — FormData sets it with boundary
-            body: formData,
-        });
-        if (!res.ok)
-            throw new Error(`Extension upload failed: ${await res.text()}`);
-        return parseJsonResponse(res, 'Extension upload');
-    }
-    /**
-     * List all uploaded extensions.
-     */
-    async list() {
-        const res = await fetchWithTimeout(`${this.baseUrl}/extensions`, {
-            headers: this.headers(),
-        });
-        if (!res.ok)
-            throw new Error(`Extension list failed: ${await res.text()}`);
-        const data = await parseJsonResponse(res, 'Extension list');
-        return data.extensions;
-    }
-    /**
-     * Get extension metadata by ID.
-     */
-    async get(id) {
-        const res = await fetchWithTimeout(`${this.baseUrl}/extensions/${encodeURIComponent(id)}`, {
-            headers: this.headers(),
-        });
-        if (res.status === 404)
-            return null;
-        if (!res.ok)
-            throw new Error(`Extension get failed: ${await res.text()}`);
-        return parseJsonResponse(res, 'Extension get');
-    }
-    /**
-     * Update an existing extension with a new file.
-     */
-    async update(id, opts) {
-        const formData = new FormData();
-        const blob = new Blob([new Uint8Array(opts.file)], { type: 'application/octet-stream' });
-        formData.append('file', blob, opts.filename);
-        const res = await fetchWithTimeout(`${this.baseUrl}/extensions/${encodeURIComponent(id)}`, {
-            method: 'PUT',
-            headers: this.headers(),
-            body: formData,
-        });
-        if (!res.ok)
-            throw new Error(`Extension update failed: ${await res.text()}`);
-        return parseJsonResponse(res, 'Extension update');
-    }
-    /**
-     * Delete an extension.
-     */
-    async delete(id) {
-        const res = await fetchWithTimeout(`${this.baseUrl}/extensions/${encodeURIComponent(id)}`, {
-            method: 'DELETE',
-            headers: this.headers(),
-        });
-        if (!res.ok)
-            throw new Error(`Extension delete failed: ${await res.text()}`);
-    }
-    // --------------------------------------------------------------------------
-    // Profile-level install/uninstall
-    // --------------------------------------------------------------------------
-    /**
-     * Install extension(s) on a browser profile.
-     */
-    async install(browserName, extensionIds) {
-        const ids = Array.isArray(extensionIds) ? extensionIds : [extensionIds];
-        const res = await fetchWithTimeout(`${this.baseUrl}/profiles/by-name/${encodeURIComponent(browserName)}/extensions`, {
-            method: 'POST',
-            headers: this.jsonHeaders(),
-            body: JSON.stringify({ extensionIds: ids }),
-        });
-        if (!res.ok)
-            throw new Error(`Extension install failed: ${await res.text()}`);
-    }
-    /**
-     * Uninstall an extension from a browser profile.
-     */
-    async uninstall(browserName, extensionId) {
-        const res = await fetchWithTimeout(`${this.baseUrl}/profiles/by-name/${encodeURIComponent(browserName)}/extensions/${encodeURIComponent(extensionId)}`, {
-            method: 'DELETE',
-            headers: this.headers(),
-        });
-        if (!res.ok)
-            throw new Error(`Extension uninstall failed: ${await res.text()}`);
-    }
-    /**
-     * List extensions installed on a browser profile.
-     */
-    async installed(browserName) {
-        const res = await fetchWithTimeout(`${this.baseUrl}/profiles/by-name/${encodeURIComponent(browserName)}/extensions`, {
-            headers: this.headers(),
-        });
-        if (!res.ok)
-            throw new Error(`Extension installed list failed: ${await res.text()}`);
-        const data = await parseJsonResponse(res, 'Extension installed list');
-        return data.extensions;
-    }
-}

package/dist/extensions/index.d.ts

@@ -1 +0,0 @@
-export { ExtensionsClient } from './client.js';

package/dist/extensions/index.js

@@ -1 +0,0 @@
-export { ExtensionsClient } from './client.js';

package/dist/internal/dev-client.d.ts

@@ -1,5 +0,0 @@
-import { type Bctrl, type BctrlOptions } from '../bctrl.js';
-export interface InternalBctrlOptions extends BctrlOptions {
-    apiOrigin?: string;
-}
-export declare function createInternalBctrl(options: InternalBctrlOptions): Bctrl;

package/dist/internal/dev-client.js

@@ -1,9 +0,0 @@
-import { createInternalBctrlClient } from '../bctrl.js';
-import { resolveInternalApiBaseUrl } from '../config.js';
-export function createInternalBctrl(options) {
-    return createInternalBctrlClient({
-        apiKey: options.apiKey,
-        telemetry: options.telemetry,
-        apiBaseUrl: resolveInternalApiBaseUrl(options.apiOrigin),
-    });
-}

package/dist/internal/rpc-targets.d.ts

@@ -1,17 +0,0 @@
-/**
- * AUTO-GENERATED FILE - DO NOT EDIT
- *
- * Generated from: scripts/generate/rpc-targets-config.ts
- * Run `pnpm generate:rpc-targets` to regenerate.
- */
-/**
- * All valid SDK RPC target types.
- * Generated from driver handler configurations.
- */
-export declare const RPC_TARGETS: readonly ["browser", "browserUse", "consoleMessage", "context", "cua", "desktop", "dialog", "element", "fileChooser", "frame", "httpRequest", "httpResponse", "jsHandle", "locator", "page", "response", "selenium", "selenium-element", "stagehand", "target", "worker"];
-export type RpcTarget = (typeof RPC_TARGETS)[number];
-export declare const HANDLE_TARGETS: ReadonlySet<RpcTarget>;
-export declare const PAGE_REF_TARGETS: ReadonlySet<RpcTarget>;
-export declare const CONTEXT_REF_TARGETS: ReadonlySet<RpcTarget>;
-export declare const SCREENSHOT_ARTIFACT_TARGETS: ReadonlySet<RpcTarget>;
-export declare const PDF_ARTIFACT_TARGETS: ReadonlySet<RpcTarget>;

package/dist/internal/rpc-targets.js

@@ -1,58 +0,0 @@
-/**
- * AUTO-GENERATED FILE - DO NOT EDIT
- *
- * Generated from: scripts/generate/rpc-targets-config.ts
- * Run `pnpm generate:rpc-targets` to regenerate.
- */
-/**
- * All valid SDK RPC target types.
- * Generated from driver handler configurations.
- */
-export const RPC_TARGETS = [
-    'browser',
-    'browserUse',
-    'consoleMessage',
-    'context',
-    'cua',
-    'desktop',
-    'dialog',
-    'element',
-    'fileChooser',
-    'frame',
-    'httpRequest',
-    'httpResponse',
-    'jsHandle',
-    'locator',
-    'page',
-    'response',
-    'selenium',
-    'selenium-element',
-    'stagehand',
-    'target',
-    'worker',
-];
-export const HANDLE_TARGETS = new Set([
-    'consoleMessage',
-    'dialog',
-    'element',
-    'frame',
-    'jsHandle',
-    'worker',
-]);
-export const PAGE_REF_TARGETS = new Set([
-    'browserUse',
-    'locator',
-    'page',
-    'stagehand',
-]);
-export const CONTEXT_REF_TARGETS = new Set([
-    'context',
-]);
-export const SCREENSHOT_ARTIFACT_TARGETS = new Set([
-    'element',
-    'locator',
-    'page',
-]);
-export const PDF_ARTIFACT_TARGETS = new Set([
-    'page',
-]);

package/dist/internal/serialization.d.ts

@@ -1,32 +0,0 @@
-/**
- * AUTO-GENERATED FILE - DO NOT EDIT
- *
- * Generated from: packages/automation-spec/src/drivers/puppeteer/methods/types.ts
- * Run `pnpm generate:sdk-contracts` to regenerate.
- */
-/**
- * Shared Types for Schema-Driven Code Generation
- *
- * Contains serialization schemas used across the Puppeteer SDK.
- */
-import { z } from 'zod';
-/**
- * Schema for serialized handle reference (returned from RPC)
- */
-export declare const SerializedHandleSchema: z.ZodObject<{
-    __bctrl_type: z.ZodLiteral<"Handle">;
-    id: z.ZodString;
-    handleType: z.ZodString;
-}, z.core.$strip>;
-export type SerializedHandle = z.infer<typeof SerializedHandleSchema>;
-/**
- * Schema for handle ID passed as argument (sent to RPC)
- */
-export declare const HandleRefSchema: z.ZodObject<{
-    __bctrl_handle_id: z.ZodString;
-}, z.core.$strip>;
-export type HandleRef = z.infer<typeof HandleRefSchema>;
-/**
- * Type guard to check if a value is a SerializedHandle.
- */
-export declare function isSerializedHandle(value: unknown): value is SerializedHandle;

package/dist/internal/serialization.js

@@ -1,42 +0,0 @@
-/**
- * AUTO-GENERATED FILE - DO NOT EDIT
- *
- * Generated from: packages/automation-spec/src/drivers/puppeteer/methods/types.ts
- * Run `pnpm generate:sdk-contracts` to regenerate.
- */
-/**
- * Shared Types for Schema-Driven Code Generation
- *
- * Contains serialization schemas used across the Puppeteer SDK.
- */
-import { z } from 'zod';
-// ============================================================================
-// Handle Serialization Schemas
-// ============================================================================
-/**
- * Schema for serialized handle reference (returned from RPC)
- */
-export const SerializedHandleSchema = z.object({
-    __bctrl_type: z.literal('Handle'),
-    id: z.string(),
-    handleType: z.string(),
-});
-/**
- * Schema for handle ID passed as argument (sent to RPC)
- */
-export const HandleRefSchema = z.object({
-    __bctrl_handle_id: z.string(),
-});
-/**
- * Type guard to check if a value is a SerializedHandle.
- */
-export function isSerializedHandle(value) {
-    return (value !== null &&
-        typeof value === 'object' &&
-        '__bctrl_type' in value &&
-        value.__bctrl_type === 'Handle' &&
-        'id' in value &&
-        typeof value.id === 'string' &&
-        'handleType' in value &&
-        typeof value.handleType === 'string');
-}

package/dist/internal/transport.d.ts

@@ -1,24 +0,0 @@
-/**
- * Internal SDK transport and handle helpers.
- *
- * These are SDK implementation details used by sessions, namespaces, and
- * generated driver classes. They intentionally live inside the SDK so the
- * public package does not depend on shared schema helpers for its own runtime.
- */
-import type { RpcTarget } from './rpc-targets.js';
-export type { RpcTarget } from './rpc-targets.js';
-export type SimpleRpcSender = <T = unknown>(method: string, args: unknown[]) => Promise<T>;
-export type RpcSender = <T = unknown>(target: RpcTarget, method: string, args: unknown[], ids?: {
-    contextId?: string;
-    pageId?: string;
-}) => Promise<T>;
-export interface HasHandleId {
-    readonly handleId: string;
-}
-export declare function extractHandleId(value: string | HasHandleId | undefined | null): string | undefined;
-export declare function toHandleRef<T>(value: T | HasHandleId): T | {
-    __bctrl_handle_id: string;
-};
-export declare function serializeFunctionSource(value: Function): string;
-export declare function serializeFunctionSource(value: string): string;
-export declare function serializeFunctionSource<T>(value: T): T;