@bctrl/sdk 1.0.3 → 1.0.4

package/README.md

@@ -24,19 +24,17 @@ const space = await bctrl.spaces.create({
   region: 'us-east-1',
 });
 
-const runtime = await space.runtimes.create({
+const createdRuntime = await space.runtimes.create({
   type: 'browser',
   name: 'browser-task',
   config: {
-    browser: { profile: false },
+    profile: false,
   },
 });
-const { runtime: browser } = await runtime.start();
+const started = await createdRuntime.start();
+console.log(started.run.id, started.browser.cdpUrl);
 
-const connection = await browser.connect();
-console.log(connection.wsUrl);
-
-const invocation = await browser.invocations.create({
+const invocation = await started.runtime.invocations.create({
   provider: 'stagehand',
   method: 'act',
   input: { instruction: 'Open https://example.com' },

package/dist/index.d.ts

@@ -3,7 +3,7 @@ export { BctrlError, BctrlApiError, BctrlAuthenticationError, BctrlConflictError
 export { V1FileResource, V1FilesClient, V1RunFilesClient } from './files.js';
 export { V1InvocationsClient, V1InvocationResource, V1RuntimeBrowserUseInvocationsClient, V1RuntimeInvocationsClient, V1RuntimeStagehandInvocationsClient, } from './invocations.js';
 export type { BrowserUseAgentOptions, StagehandActOptions, StagehandAgentOptions, StagehandExtractOptions, StagehandObserveOptions, StagehandVariablePrimitive, StagehandVariableValue, StagehandVariables, } from './invocations.js';
-export { V1RuntimeConnectionResource, V1RuntimeConnectionsClient, V1RuntimeFilesClient, V1RuntimeResource, V1RuntimeRunsClient, V1RuntimesClient, } from './runtimes.js';
-export { V1RunCommandsClient, V1RunEventsClient, V1RunResource, V1RunsClient, } from './runs.js';
+export { V1RuntimeFilesClient, V1RuntimeResource, V1RuntimeRunsClient, V1RuntimesClient, } from './runtimes.js';
+export { V1RunCommandsClient, V1RunEventsClient, V1RunResource, V1RunsClient } from './runs.js';
 export { V1SpaceEnvironmentClient, V1SpaceResource, V1SpaceRuntimesClient, V1SpacesClient, } from './spaces.js';
 export type * from './types.js';

package/dist/index.js

@@ -2,6 +2,6 @@ export { Bctrl, BctrlV1 } from './bctrl.js';
 export { BctrlError, BctrlApiError, BctrlAuthenticationError, BctrlConflictError, BctrlNetworkError, BctrlNotFoundError, BctrlNotReadyError, BctrlPermissionError, BctrlRateLimitError, BctrlUnsupportedError, BctrlValidationError, isControllerBusy, } from './errors.js';
 export { V1FileResource, V1FilesClient, V1RunFilesClient } from './files.js';
 export { V1InvocationsClient, V1InvocationResource, V1RuntimeBrowserUseInvocationsClient, V1RuntimeInvocationsClient, V1RuntimeStagehandInvocationsClient, } from './invocations.js';
-export { V1RuntimeConnectionResource, V1RuntimeConnectionsClient, V1RuntimeFilesClient, V1RuntimeResource, V1RuntimeRunsClient, V1RuntimesClient, } from './runtimes.js';
-export { V1RunCommandsClient, V1RunEventsClient, V1RunResource, V1RunsClient, } from './runs.js';
+export { V1RuntimeFilesClient, V1RuntimeResource, V1RuntimeRunsClient, V1RuntimesClient, } from './runtimes.js';
+export { V1RunCommandsClient, V1RunEventsClient, V1RunResource, V1RunsClient } from './runs.js';
 export { V1SpaceEnvironmentClient, V1SpaceResource, V1SpaceRuntimesClient, V1SpacesClient, } from './spaces.js';

package/dist/runs.d.ts

@@ -1,6 +1,6 @@
 import type { V1HttpClient } from './http.js';
 import { V1RunFilesClient } from './files.js';
-import type { V1ListEnvelope, V1Run, V1RunCommand, V1RunCommandsListQuery, V1RunEvent, V1RunEventsListQuery, V1RunEventsWaitRequest, V1RunEventsWaitResponse, V1RunListQuery, V1RunLiveRequest, V1RunLiveResponse, V1RunRecordingRequest, V1RunRecordingResponse, V1RunUsage } from './types.js';
+import type { V1ListEnvelope, V1Run, V1RunCommand, V1RunCommandsListQuery, V1RunEvent, V1RunEventsListQuery, V1RunEventsWaitRequest, V1RunEventsWaitResponse, V1RunListQuery, V1RunLiveRequest, V1RunLiveResponse, V1RunRecordingRequest, V1RunRecordingResponse, V1RuntimeStartRun, V1RunUsage } from './types.js';
 export declare class V1RunEventsClient {
     private readonly http;
     private readonly runId;
@@ -19,11 +19,11 @@ export declare class V1RunCommandsClient {
 }
 export declare class V1RunResource {
     private readonly http;
-    readonly data: V1Run;
+    readonly data: V1Run | V1RuntimeStartRun;
     readonly events: V1RunEventsClient;
     readonly commands: V1RunCommandsClient;
     readonly files: V1RunFilesClient;
-    constructor(http: V1HttpClient, data: V1Run);
+    constructor(http: V1HttpClient, data: V1Run | V1RuntimeStartRun);
     get id(): string;
     refresh(): Promise<V1RunResource>;
     live(request?: V1RunLiveRequest): Promise<V1RunLiveResponse>;

package/dist/runtimes.d.ts

@@ -1,24 +1,12 @@
 import type { V1HttpClient } from './http.js';
 import { V1RuntimeInvocationsClient } from './invocations.js';
 import { V1RunResource } from './runs.js';
-import type { V1ListEnvelope, V1File, V1Runtime, V1RuntimeConnection, V1RuntimeConnectionCreateOptions, V1RuntimeConnectionCreateResponse, V1RuntimeCreateRequest, V1RuntimeFileCollectRequest, V1RuntimeFileStageRequest, V1RuntimeFileUploadRequest, V1RuntimeFileUploadResponse, V1RuntimeStagedFile, V1RuntimeListQuery, V1RuntimeRunListQuery, V1RunSummary, V1SpaceRuntimeCreateRequest } from './types.js';
-export declare class V1RuntimeConnectionResource {
-    private readonly http;
-    private readonly runtimeId;
-    readonly data: V1RuntimeConnectionCreateResponse;
-    constructor(http: V1HttpClient, runtimeId: string, data: V1RuntimeConnectionCreateResponse);
-    get id(): string;
-    get endpoint(): V1RuntimeConnectionCreateResponse['endpoint'];
-    get wsUrl(): string | undefined;
-    close(): Promise<V1RuntimeConnection>;
-}
-export declare class V1RuntimeConnectionsClient {
-    private readonly http;
-    private readonly runtimeId;
-    constructor(http: V1HttpClient, runtimeId: string);
-    create(request?: V1RuntimeConnectionCreateOptions): Promise<V1RuntimeConnectionResource>;
-    delete(connectionId: string): Promise<V1RuntimeConnection>;
-}
+import type { V1ListEnvelope, V1File, V1Runtime, V1RuntimeCreateRequest, V1RuntimeFileCollectRequest, V1RuntimeFileStageRequest, V1RuntimeFileUploadRequest, V1RuntimeFileUploadResponse, V1RuntimeStagedFile, V1RuntimeListQuery, V1RuntimeRunListQuery, V1RuntimeStartBrowser, V1RuntimeStartRuntime, V1RunSummary, V1SpaceRuntimeCreateRequest } from './types.js';
+export type V1RuntimeStartResult = {
+    runtime: V1RuntimeResource;
+    run: V1RunResource;
+    browser: V1RuntimeStartBrowser;
+};
 export declare class V1RuntimeRunsClient {
     private readonly http;
     private readonly runtimeId;
@@ -36,20 +24,15 @@ export declare class V1RuntimeFilesClient {
 }
 export declare class V1RuntimeResource {
     private readonly http;
-    readonly data: V1Runtime;
-    readonly connections: V1RuntimeConnectionsClient;
+    readonly data: V1Runtime | V1RuntimeStartRuntime;
     readonly files: V1RuntimeFilesClient;
     readonly runs: V1RuntimeRunsClient;
     readonly invocations: V1RuntimeInvocationsClient;
-    constructor(http: V1HttpClient, data: V1Runtime);
+    constructor(http: V1HttpClient, data: V1Runtime | V1RuntimeStartRuntime);
     get id(): string;
     get activeRunId(): string | null;
     refresh(): Promise<V1RuntimeResource>;
-    connect(request?: V1RuntimeConnectionCreateOptions): Promise<V1RuntimeConnectionResource>;
-    start(): Promise<{
-        runtime: V1RuntimeResource;
-        run: V1RunResource;
-    }>;
+    start(): Promise<V1RuntimeStartResult>;
     stop(): Promise<V1Runtime>;
     run(): Promise<V1RunResource>;
 }
@@ -62,8 +45,5 @@ export declare class V1RuntimesClient {
     createInSpace(spaceId: string, request: V1SpaceRuntimeCreateRequest): Promise<V1RuntimeResource>;
     get(id: string): Promise<V1RuntimeResource>;
     stop(id: string): Promise<V1Runtime>;
-    start(id: string): Promise<{
-        runtime: V1RuntimeResource;
-        run: V1RunResource;
-    }>;
+    start(id: string): Promise<V1RuntimeStartResult>;
 }

package/dist/runtimes.js

@@ -2,49 +2,6 @@ import { BctrlValidationError } from './errors.js';
 import { V1RuntimeInvocationsClient } from './invocations.js';
 import { iterateV1Pages } from './pagination.js';
 import { V1RunResource } from './runs.js';
-export class V1RuntimeConnectionResource {
-    http;
-    runtimeId;
-    data;
-    constructor(http, runtimeId, data) {
-        this.http = http;
-        this.runtimeId = runtimeId;
-        this.data = data;
-    }
-    get id() {
-        return this.data.id;
-    }
-    get endpoint() {
-        return this.data.endpoint;
-    }
-    get wsUrl() {
-        return this.data.endpoint.type === 'websocket' ? this.data.endpoint.url : undefined;
-    }
-    close() {
-        return this.http.request(`/runtimes/${encodeURIComponent(this.runtimeId)}/connections/${encodeURIComponent(this.id)}`, { method: 'DELETE' });
-    }
-}
-export class V1RuntimeConnectionsClient {
-    http;
-    runtimeId;
-    constructor(http, runtimeId) {
-        this.http = http;
-        this.runtimeId = runtimeId;
-    }
-    async create(request = {}) {
-        const response = await this.http.request(`/runtimes/${encodeURIComponent(this.runtimeId)}/connections`, {
-            method: 'POST',
-            body: {
-                protocol: request.protocol ?? 'cdp',
-                ...request,
-            },
-        });
-        return new V1RuntimeConnectionResource(this.http, this.runtimeId, response);
-    }
-    delete(connectionId) {
-        return this.http.request(`/runtimes/${encodeURIComponent(this.runtimeId)}/connections/${encodeURIComponent(connectionId)}`, { method: 'DELETE' });
-    }
-}
 export class V1RuntimeRunsClient {
     http;
     runtimeId;
@@ -100,14 +57,12 @@ export class V1RuntimeFilesClient {
 export class V1RuntimeResource {
     http;
     data;
-    connections;
     files;
     runs;
     invocations;
     constructor(http, data) {
         this.http = http;
         this.data = data;
-        this.connections = new V1RuntimeConnectionsClient(http, data.id);
         this.files = new V1RuntimeFilesClient(http, data.id);
         this.runs = new V1RuntimeRunsClient(http, data.id);
         this.invocations = new V1RuntimeInvocationsClient(http, data.id);
@@ -116,19 +71,17 @@ export class V1RuntimeResource {
         return this.data.id;
     }
     get activeRunId() {
-        return this.data.activeRunId;
+        return 'activeRunId' in this.data ? this.data.activeRunId : null;
     }
     refresh() {
         return new V1RuntimesClient(this.http).get(this.id);
     }
-    async connect(request) {
-        return this.connections.create(request);
-    }
     async start() {
         const response = await this.http.request(`/runtimes/${encodeURIComponent(this.id)}/start`, { method: 'POST' });
         return {
             runtime: new V1RuntimeResource(this.http, response.runtime),
             run: new V1RunResource(this.http, response.run),
+            browser: response.browser,
         };
     }
     stop() {
@@ -138,25 +91,26 @@ export class V1RuntimeResource {
     }
     async run() {
         const runtime = await this.refresh();
-        if (!runtime.activeRunId) {
+        const activeRunId = runtime.activeRunId;
+        if (!activeRunId) {
             throw new BctrlValidationError('Runtime does not have an active run yet', 'runtime.no_active_run', {
                 runtimeId: this.id,
             });
         }
-        const run = await this.http.request(`/runs/${encodeURIComponent(runtime.activeRunId)}`);
+        const run = await this.http.request(`/runs/${encodeURIComponent(activeRunId)}`);
         return new V1RunResource(this.http, run);
     }
 }
 function validateRuntimeCreateRequest(request) {
-    const profileBacked = request.config?.browser?.profile === true;
+    const profileBacked = request.config?.profile === true;
     if (!profileBacked)
         return;
     if (!request.name?.trim()) {
-        throw new BctrlValidationError('name is required when config.browser.profile is true', 'runtime.profile_name_required');
+        throw new BctrlValidationError('name is required when config.profile is true', 'runtime.profile_name_required');
     }
     const unsupported = ['stealth', 'proxy', 'fingerprint', 'extensions'].filter((key) => request.config?.[key] !== undefined);
     if (unsupported.length > 0) {
-        throw new BctrlValidationError('Only config.browser.profile and config.lifecycle are supported for profile-backed browser runtimes', 'runtime.profile_config_unsupported', { unsupported });
+        throw new BctrlValidationError('Only config.profile, config.idleTimeoutMinutes, config.webRtcProxyOnly, and config.forceOpenShadowRoots are supported for profile-backed browser runtimes', 'runtime.profile_config_unsupported', { unsupported });
     }
 }
 export class V1RuntimesClient {

package/dist/types.d.ts

@@ -54,18 +54,15 @@ export interface V1RuntimeFingerprintCreateConfig {
     browser?: string;
     locale?: string;
 }
-export interface V1RuntimeLifecycleConfig {
-    idleTimeoutMinutes?: number;
-}
 export interface V1BrowserRuntimeCreateConfig {
-    browser?: {
-        profile?: boolean;
-    };
+    profile?: boolean;
     stealth?: V1BrowserStealth;
     proxy?: V1ProxyInput | null;
     fingerprint?: V1RuntimeFingerprintCreateConfig;
     extensions?: string[];
-    lifecycle?: V1RuntimeLifecycleConfig;
+    idleTimeoutMinutes?: number;
+    webRtcProxyOnly?: boolean;
+    forceOpenShadowRoots?: boolean;
 }
 export interface V1RuntimeCreateRequest {
     spaceId: string;
@@ -93,44 +90,26 @@ export interface V1Runtime extends V1RuntimeSummary {
     config?: JsonObject;
     metadata?: JsonObject | null;
 }
-export type V1ConnectionProtocol = 'cdp' | 'cua' | 'rdp' | 'vnc' | 'mcp' | 'http';
-export type V1ConnectionEndpoint = {
-    type: 'websocket';
-    url: string;
-} | {
-    type: 'http';
-    baseUrl: string;
-} | {
-    type: 'rdp';
-    host: string;
-    port: number;
-    username: string;
-    password: string;
-} | {
-    type: 'composite';
-    endpoints: Record<string, string>;
-};
-export interface V1RuntimeConnectionCreateRequest {
-    protocol: 'cdp';
-    options?: JsonObject;
-}
-export type V1RuntimeConnectionCreateOptions = Partial<V1RuntimeConnectionCreateRequest>;
-export interface V1RuntimeConnection {
+export interface V1RuntimeStartRuntime {
     id: string;
-    protocol: V1ConnectionProtocol;
-    status: string;
-    runId: string;
-    createdAt: string;
-    expiresAt: string | null;
-    closedAt?: string | null;
-    revokedAt?: string | null;
+    name: string;
+    type: V1RuntimeType;
+    status: V1RuntimeStatus;
+}
+export interface V1RuntimeStartRun extends V1RunSummary {
+    durationMs?: number | null;
+    lastSeenAt?: string | null;
+    endedReason?: string | null;
+    failureReason?: string | null;
 }
-export interface V1RuntimeConnectionCreateResponse extends V1RuntimeConnection {
-    endpoint: V1ConnectionEndpoint;
+export interface V1RuntimeStartBrowser {
+    cdpUrl: string;
+    connectionId: string;
 }
 export interface V1RuntimeStartResponse {
-    runtime: V1Runtime;
-    run: V1Run;
+    runtime: V1RuntimeStartRuntime;
+    run: V1RuntimeStartRun;
+    browser: V1RuntimeStartBrowser;
 }
 export interface V1RunListQuery extends V1PageQuery {
     status?: string | string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bctrl/sdk",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "BCTRL SDK - Remote browser automation",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -11,20 +11,9 @@
       "import": "./dist/index.js"
     }
   },
-  "scripts": {
-    "clean": "rm -rf dist",
-    "build": "pnpm run clean && tsc -p tsconfig.json",
-    "prepack": "pnpm run build",
-    "dev": "tsc --watch",
-    "test": "tsx --test tests/v1/*.test.ts tests/v1/e2e/*.test.ts",
-    "test:v1": "tsx --test tests/v1/*.test.ts tests/v1/e2e/*.test.ts",
-    "test:v1:e2e": "BCTRL_E2E=1 tsx --test tests/v1/e2e/**/*.test.ts",
-    "typecheck": "tsc --noEmit"
-  },
   "keywords": [],
   "author": "",
   "license": "ISC",
-  "packageManager": "pnpm@10.12.4",
   "devDependencies": {
     "@types/node": "^25.0.3",
     "@typescript-eslint/eslint-plugin": "^8.56.0",
@@ -35,5 +24,14 @@
   },
   "files": [
     "dist"
-  ]
-}
+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "pnpm run clean && tsc -p tsconfig.json",
+    "dev": "tsc --watch",
+    "test": "tsx --test tests/v1/*.test.ts tests/v1/e2e/*.test.ts",
+    "test:v1": "tsx --test tests/v1/*.test.ts tests/v1/e2e/*.test.ts",
+    "test:v1:e2e": "BCTRL_E2E=1 tsx --test tests/v1/e2e/**/*.test.ts",
+    "typecheck": "tsc --noEmit"
+  }
+}