@bctrl/sdk 1.0.2 → 1.0.4

package/dist/spaces.d.ts

@@ -1,41 +1,40 @@
-import { V2SpaceBrowsersClient } from './browsers.js';
-import type { V2HttpClient } from './http.js';
-import { V2RuntimeResource, V2RuntimesClient } from './runtimes.js';
-import type { V2ListEnvelope, V2RuntimeListQuery, V2Space, V2SpaceCreateRequest, V2SpaceEnvironment, V2SpaceEnvironmentUpdateRequest, V2SpaceRuntimeCreateRequest, V2SpaceUpdateRequest } from './types.js';
-export declare class V2SpaceEnvironmentClient {
+import type { V1HttpClient } from './http.js';
+import { V1RuntimeResource, V1RuntimesClient } from './runtimes.js';
+import type { V1ListEnvelope, V1RuntimeListQuery, V1Space, V1SpaceCreateRequest, V1SpaceEnvironment, V1SpaceEnvironmentUpdateRequest, V1SpaceRuntimeCreateRequest, V1SpaceUpdateRequest } from './types.js';
+export declare class V1SpaceEnvironmentClient {
     private readonly http;
     private readonly spaceId;
-    constructor(http: V2HttpClient, spaceId: string);
-    get(): Promise<V2SpaceEnvironment>;
-    update(request: V2SpaceEnvironmentUpdateRequest): Promise<V2SpaceEnvironment>;
+    constructor(http: V1HttpClient, spaceId: string);
+    get(): Promise<V1SpaceEnvironment>;
+    update(request: V1SpaceEnvironmentUpdateRequest): Promise<V1SpaceEnvironment>;
 }
-export declare class V2SpaceRuntimesClient {
+export declare class V1SpaceRuntimesClient {
     private readonly http;
     private readonly spaceId;
-    constructor(http: V2HttpClient, spaceId: string);
-    list(query?: Omit<V2RuntimeListQuery, 'spaceId'>): ReturnType<V2RuntimesClient['list']>;
-    iter(query?: Omit<V2RuntimeListQuery, 'spaceId'>): ReturnType<V2RuntimesClient['iter']>;
-    create(request: V2SpaceRuntimeCreateRequest): Promise<V2RuntimeResource>;
-    get(runtimeId: string): Promise<V2RuntimeResource>;
-    stop(runtimeId: string): ReturnType<V2RuntimesClient['stop']>;
+    constructor(http: V1HttpClient, spaceId: string);
+    list(query?: Omit<V1RuntimeListQuery, 'spaceId'>): ReturnType<V1RuntimesClient['list']>;
+    iter(query?: Omit<V1RuntimeListQuery, 'spaceId'>): ReturnType<V1RuntimesClient['iter']>;
+    create(request: V1SpaceRuntimeCreateRequest): Promise<V1RuntimeResource>;
+    get(runtimeId: string): Promise<V1RuntimeResource>;
+    stop(runtimeId: string): ReturnType<V1RuntimesClient['stop']>;
+    start(runtimeId: string): ReturnType<V1RuntimesClient['start']>;
 }
-export declare class V2SpaceResource {
+export declare class V1SpaceResource {
     private readonly http;
-    readonly data: V2Space;
-    readonly environment: V2SpaceEnvironmentClient;
-    readonly runtimes: V2SpaceRuntimesClient;
-    readonly browsers: V2SpaceBrowsersClient;
-    constructor(http: V2HttpClient, data: V2Space);
+    readonly data: V1Space;
+    readonly environment: V1SpaceEnvironmentClient;
+    readonly runtimes: V1SpaceRuntimesClient;
+    constructor(http: V1HttpClient, data: V1Space);
     get id(): string;
-    refresh(): Promise<V2SpaceResource>;
-    update(request: V2SpaceUpdateRequest): Promise<V2SpaceResource>;
+    refresh(): Promise<V1SpaceResource>;
+    update(request: V1SpaceUpdateRequest): Promise<V1SpaceResource>;
 }
-export declare class V2SpacesClient {
+export declare class V1SpacesClient {
     private readonly http;
-    constructor(http: V2HttpClient);
-    list(): Promise<V2ListEnvelope<V2Space>>;
-    iter(): AsyncGenerator<V2Space, void, undefined>;
-    create(request: V2SpaceCreateRequest): Promise<V2SpaceResource>;
-    get(id: string): Promise<V2SpaceResource>;
-    update(id: string, request: V2SpaceUpdateRequest): Promise<V2SpaceResource>;
+    constructor(http: V1HttpClient);
+    list(): Promise<V1ListEnvelope<V1Space>>;
+    iter(): AsyncGenerator<V1Space, void, undefined>;
+    create(request: V1SpaceCreateRequest): Promise<V1SpaceResource>;
+    get(id: string): Promise<V1SpaceResource>;
+    update(id: string, request: V1SpaceUpdateRequest): Promise<V1SpaceResource>;
 }

package/dist/spaces.js

@@ -1,7 +1,6 @@
-import { V2SpaceBrowsersClient } from './browsers.js';
-import { iterateV2Pages } from './pagination.js';
-import { V2RuntimesClient } from './runtimes.js';
-export class V2SpaceEnvironmentClient {
+import { iterateV1Pages } from './pagination.js';
+import { V1RuntimesClient } from './runtimes.js';
+export class V1SpaceEnvironmentClient {
     http;
     spaceId;
     constructor(http, spaceId) {
@@ -18,7 +17,7 @@ export class V2SpaceEnvironmentClient {
         });
     }
 }
-export class V2SpaceRuntimesClient {
+export class V1SpaceRuntimesClient {
     http;
     spaceId;
     constructor(http, spaceId) {
@@ -26,45 +25,46 @@ export class V2SpaceRuntimesClient {
         this.spaceId = spaceId;
     }
     list(query = {}) {
-        return new V2RuntimesClient(this.http).list({ ...query, spaceId: this.spaceId });
+        return new V1RuntimesClient(this.http).list({ ...query, spaceId: this.spaceId });
     }
     iter(query = {}) {
-        return new V2RuntimesClient(this.http).iter({ ...query, spaceId: this.spaceId });
+        return new V1RuntimesClient(this.http).iter({ ...query, spaceId: this.spaceId });
     }
     async create(request) {
-        return new V2RuntimesClient(this.http).createInSpace(this.spaceId, request);
+        return new V1RuntimesClient(this.http).createInSpace(this.spaceId, request);
     }
     async get(runtimeId) {
-        return new V2RuntimesClient(this.http).get(runtimeId);
+        return new V1RuntimesClient(this.http).get(runtimeId);
     }
     stop(runtimeId) {
-        return new V2RuntimesClient(this.http).stop(runtimeId);
+        return new V1RuntimesClient(this.http).stop(runtimeId);
+    }
+    start(runtimeId) {
+        return new V1RuntimesClient(this.http).start(runtimeId);
     }
 }
-export class V2SpaceResource {
+export class V1SpaceResource {
     http;
     data;
     environment;
     runtimes;
-    browsers;
     constructor(http, data) {
         this.http = http;
         this.data = data;
-        this.environment = new V2SpaceEnvironmentClient(http, data.id);
-        this.runtimes = new V2SpaceRuntimesClient(http, data.id);
-        this.browsers = new V2SpaceBrowsersClient(http, data.id);
+        this.environment = new V1SpaceEnvironmentClient(http, data.id);
+        this.runtimes = new V1SpaceRuntimesClient(http, data.id);
     }
     get id() {
         return this.data.id;
     }
     refresh() {
-        return new V2SpacesClient(this.http).get(this.id);
+        return new V1SpacesClient(this.http).get(this.id);
     }
     async update(request) {
-        return new V2SpacesClient(this.http).update(this.id, request);
+        return new V1SpacesClient(this.http).update(this.id, request);
     }
 }
-export class V2SpacesClient {
+export class V1SpacesClient {
     http;
     constructor(http) {
         this.http = http;
@@ -73,24 +73,24 @@ export class V2SpacesClient {
         return this.http.request('/spaces');
     }
     iter() {
-        return iterateV2Pages({}, () => this.list());
+        return iterateV1Pages({}, () => this.list());
     }
     async create(request) {
         const space = await this.http.request('/spaces', {
             method: 'POST',
             body: request,
         });
-        return new V2SpaceResource(this.http, space);
+        return new V1SpaceResource(this.http, space);
     }
     async get(id) {
         const space = await this.http.request(`/spaces/${encodeURIComponent(id)}`);
-        return new V2SpaceResource(this.http, space);
+        return new V1SpaceResource(this.http, space);
     }
     async update(id, request) {
         const space = await this.http.request(`/spaces/${encodeURIComponent(id)}`, {
             method: 'PATCH',
             body: request,
         });
-        return new V2SpaceResource(this.http, space);
+        return new V1SpaceResource(this.http, space);
     }
 }

package/dist/types.d.ts

@@ -3,23 +3,23 @@ export type JsonValue = JsonPrimitive | JsonObject | JsonValue[];
 export type JsonObject = {
     [key: string]: JsonValue;
 };
-export interface V2ListEnvelope<T> {
+export interface V1ListEnvelope<T> {
     data: T[];
     nextCursor: string | null;
 }
-export interface V2PageQuery {
+export interface V1PageQuery {
     cursor?: string;
     limit?: number;
 }
-export interface V2SpaceCreateRequest {
+export interface V1SpaceCreateRequest {
     name: string;
     region: string;
     subaccountId?: string | null;
 }
-export interface V2SpaceUpdateRequest {
+export interface V1SpaceUpdateRequest {
     name?: string;
 }
-export interface V2Space {
+export interface V1Space {
     id: string;
     name: string;
     region: string;
@@ -27,18 +27,18 @@ export interface V2Space {
     createdAt: string;
     updatedAt: string;
 }
-export interface V2SpaceEnvironment {
+export interface V1SpaceEnvironment {
     spaceId: string;
     mounts: JsonObject;
     updatedAt: string;
 }
-export interface V2SpaceEnvironmentUpdateRequest {
+export interface V1SpaceEnvironmentUpdateRequest {
     mounts: JsonObject;
 }
-export type V2RuntimeType = 'browser';
-export type V2RuntimeStatus = 'active' | 'stopped' | 'failed';
-export type V2BrowserStealth = 'medium' | 'high' | 'ultra';
-export type V2ProxyInput = {
+export type V1RuntimeType = 'browser';
+export type V1RuntimeStatus = 'active' | 'stopped' | 'failed';
+export type V1BrowserStealth = 'medium' | 'high' | 'ultra';
+export type V1ProxyInput = {
     mode: 'custom';
     protocol: string;
     host: string;
@@ -50,102 +50,81 @@ export type V2ProxyInput = {
     id: string;
     overrides?: JsonObject;
 };
-export interface V2RuntimeFingerprintCreateConfig {
+export interface V1RuntimeFingerprintCreateConfig {
     browser?: string;
     locale?: string;
 }
-export interface V2RuntimeLifecycleConfig {
-    idleTimeoutMinutes?: number;
-}
-export interface V2BrowserRuntimeCreateConfig {
-    browser?: {
-        profile?: boolean;
-    };
-    stealth?: V2BrowserStealth;
-    proxy?: V2ProxyInput | null;
-    fingerprint?: V2RuntimeFingerprintCreateConfig;
+export interface V1BrowserRuntimeCreateConfig {
+    profile?: boolean;
+    stealth?: V1BrowserStealth;
+    proxy?: V1ProxyInput | null;
+    fingerprint?: V1RuntimeFingerprintCreateConfig;
     extensions?: string[];
-    lifecycle?: V2RuntimeLifecycleConfig;
+    idleTimeoutMinutes?: number;
+    webRtcProxyOnly?: boolean;
+    forceOpenShadowRoots?: boolean;
 }
-export interface V2RuntimeCreateRequest {
+export interface V1RuntimeCreateRequest {
     spaceId: string;
-    type: V2RuntimeType;
+    type: V1RuntimeType;
     name?: string;
     metadata?: JsonObject;
-    config?: V2BrowserRuntimeCreateConfig;
+    config?: V1BrowserRuntimeCreateConfig;
 }
-export type V2SpaceRuntimeCreateRequest = Omit<V2RuntimeCreateRequest, 'spaceId'>;
-export interface V2RuntimeListQuery {
+export type V1SpaceRuntimeCreateRequest = Omit<V1RuntimeCreateRequest, 'spaceId'>;
+export interface V1RuntimeListQuery {
     spaceId?: string;
     status?: string | string[];
     limit?: number;
 }
-export interface V2RuntimeSummary {
+export interface V1RuntimeSummary {
     id: string;
     name: string;
-    type: V2RuntimeType;
-    status: V2RuntimeStatus;
+    type: V1RuntimeType;
+    status: V1RuntimeStatus;
     activeRunId: string | null;
     createdAt: string;
     updatedAt: string;
 }
-export interface V2Runtime extends V2RuntimeSummary {
+export interface V1Runtime extends V1RuntimeSummary {
     config?: JsonObject;
     metadata?: JsonObject | null;
 }
-export type V2ConnectionProtocol = 'cdp' | 'cua' | 'rdp' | 'vnc' | 'mcp' | 'http';
-export type V2ConnectionEndpoint = {
-    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 V2RuntimeConnectionCreateRequest {
-    protocol: 'cdp';
-    options?: JsonObject;
-}
-export type V2RuntimeConnectionCreateOptions = Partial<V2RuntimeConnectionCreateRequest>;
-export interface V2RuntimeConnection {
+export interface V1RuntimeStartRuntime {
     id: string;
-    protocol: V2ConnectionProtocol;
-    status: string;
-    runId: string;
-    createdAt: string;
-    expiresAt: string | null;
-    closedAt?: string | null;
-    revokedAt?: string | null;
+    name: string;
+    type: V1RuntimeType;
+    status: V1RuntimeStatus;
 }
-export interface V2RuntimeConnectionCreateResponse extends V2RuntimeConnection {
-    endpoint: V2ConnectionEndpoint;
+export interface V1RuntimeStartRun extends V1RunSummary {
+    durationMs?: number | null;
+    lastSeenAt?: string | null;
+    endedReason?: string | null;
+    failureReason?: string | null;
 }
-export interface V2RuntimeStartResponse {
-    runtime: V2Runtime;
-    run: V2Run;
+export interface V1RuntimeStartBrowser {
+    cdpUrl: string;
+    connectionId: string;
 }
-export interface V2RunListQuery extends V2PageQuery {
+export interface V1RuntimeStartResponse {
+    runtime: V1RuntimeStartRuntime;
+    run: V1RuntimeStartRun;
+    browser: V1RuntimeStartBrowser;
+}
+export interface V1RunListQuery extends V1PageQuery {
     status?: string | string[];
     spaceId?: string;
     runtimeId?: string;
 }
-export type V2RuntimeRunListQuery = Omit<V2RunListQuery, 'spaceId' | 'runtimeId'>;
-export interface V2RunSummary {
+export type V1RuntimeRunListQuery = Omit<V1RunListQuery, 'spaceId' | 'runtimeId'>;
+export interface V1RunSummary {
     id: string;
     status: string;
     createdAt: string;
     startedAt: string;
     finishedAt?: string | null;
 }
-export interface V2Run extends V2RunSummary {
+export interface V1Run extends V1RunSummary {
     spaceId: string;
     runtimeId: string;
     runtimeType: string;
@@ -154,7 +133,44 @@ export interface V2Run extends V2RunSummary {
     endedReason?: string | null;
     failureReason?: string | null;
 }
-export interface V2RunEvent {
+export interface V1RunUsage {
+    runId: string;
+    runtimeId: string;
+    runtimeType: string;
+    status: string;
+    computedAt: string;
+    usage: {
+        runtime: {
+            seconds: number | null;
+            billingClass: string | null;
+        };
+        aiTokens: {
+            input: number | null;
+            output: number | null;
+            total: number | null;
+        };
+        proxyBytes: number | null;
+        captchaSolves: number;
+        files: {
+            count: number;
+            bytes: number;
+        };
+        invocations: number;
+        toolCalls: number;
+    };
+    billing: {
+        status: 'pending' | 'settled' | 'unavailable';
+        creditCost: number | null;
+        breakdown: {
+            runtime: number | null;
+            ai: number | null;
+            proxy: number | null;
+            captcha: number | null;
+            files: number | null;
+        };
+    };
+}
+export interface V1RunEvent {
     id: string;
     runId: string;
     runtimeId: string;
@@ -171,48 +187,48 @@ export interface V2RunEvent {
     name?: string;
     data?: JsonObject;
 }
-export interface V2RunEventsListQuery extends V2PageQuery {
+export interface V1RunEventsListQuery extends V1PageQuery {
     type?: string | string[];
     category?: string | string[];
     connectionId?: string;
 }
-export interface V2RunEventsWaitRequest {
+export interface V1RunEventsWaitRequest {
     cursor?: string;
     timeoutMs?: number;
     type?: string[];
     category?: string[];
     connectionId?: string;
 }
-export interface V2RunEventsWaitResponse {
-    data: V2RunEvent | null;
+export interface V1RunEventsWaitResponse {
+    data: V1RunEvent | null;
     cursor: string | null;
     timedOut: boolean;
 }
-export type V2RunCommand = V2RunEvent & {
+export type V1RunCommand = V1RunEvent & {
     category: 'command';
 };
-export interface V2RunCommandsListQuery extends V2PageQuery {
+export interface V1RunCommandsListQuery extends V1PageQuery {
     type?: string | string[];
     connectionId?: string;
 }
-export interface V2RunLiveRequest {
+export interface V1RunLiveRequest {
     control?: string;
     expiresInSeconds?: number;
 }
-export interface V2RunLiveResponse {
+export interface V1RunLiveResponse {
     iframeUrl: string;
     expiresAt: string;
 }
-export interface V2RunRecordingRequest {
+export interface V1RunRecordingRequest {
     expiresInSeconds?: number;
 }
-export interface V2RunRecordingResponse {
+export interface V1RunRecordingResponse {
     iframeUrl: string;
     status: string;
     durationMs?: number;
     expiresAt: string;
 }
-export interface V2Invocation {
+export interface V1Invocation {
     id: string;
     runId: string;
     spaceId: string;
@@ -230,32 +246,32 @@ export interface V2Invocation {
     durationMs?: number | null;
     metadata?: JsonObject | null;
 }
-export interface V2InvocationResponse {
-    data: V2Invocation;
+export interface V1InvocationResponse {
+    data: V1Invocation;
 }
-export interface V2InvocationWaitRequest {
+export interface V1InvocationWaitRequest {
     timeoutMs?: number;
 }
-export interface V2InvocationWaitResponse {
-    data: V2Invocation;
+export interface V1InvocationWaitResponse {
+    data: V1Invocation;
     timedOut: boolean;
 }
-export type V2RuntimeInvocationFileInput = {
+export type V1RuntimeInvocationFileInput = {
     storagePath: string;
     name?: string;
 } | {
     fileId: string;
     name?: string;
 };
-interface V2RuntimeInvocationAgentFields {
+interface V1RuntimeInvocationAgentFields {
     target?: JsonObject;
     idempotencyKey?: string;
     outputSchema?: JsonObject;
     toolsetId?: string;
     metadata?: JsonObject;
-    files?: V2RuntimeInvocationFileInput[];
+    files?: V1RuntimeInvocationFileInput[];
 }
-export type V2RuntimeInvocationCreateRequest = {
+export type V1RuntimeInvocationCreateRequest = {
     provider: 'stagehand';
     method: 'act' | 'observe';
     target?: JsonObject;
@@ -270,13 +286,13 @@ export type V2RuntimeInvocationCreateRequest = {
     outputSchema?: JsonObject;
     idempotencyKey?: string;
     metadata?: JsonObject;
-} | (V2RuntimeInvocationAgentFields & {
+} | (V1RuntimeInvocationAgentFields & {
     provider: 'stagehand';
     method: 'agent';
     input: JsonObject;
     config?: JsonObject;
     options?: JsonObject;
-}) | (V2RuntimeInvocationAgentFields & {
+}) | (V1RuntimeInvocationAgentFields & {
     provider: 'browserUse';
     method: 'agent';
     input: JsonObject;
@@ -290,7 +306,7 @@ export type V2RuntimeInvocationCreateRequest = {
     idempotencyKey?: string;
     metadata?: JsonObject;
 };
-export interface V2File {
+export interface V1File {
     id: string;
     type: string;
     source: 'upload' | 'runtime' | 'system';
@@ -306,7 +322,7 @@ export interface V2File {
     expiresAt?: string | null;
     downloadUrl?: string;
 }
-export interface V2FilesListQuery extends V2PageQuery {
+export interface V1FilesListQuery extends V1PageQuery {
     spaceId: string;
     source?: 'upload' | 'runtime' | 'system';
     path?: string;
@@ -314,38 +330,38 @@ export interface V2FilesListQuery extends V2PageQuery {
     query?: string;
     contentType?: string;
 }
-export interface V2FileUpdateRequest {
+export interface V1FileUpdateRequest {
     name?: string;
     metadata?: JsonObject | null;
 }
-export interface V2FileDeleteResponse {
+export interface V1FileDeleteResponse {
     success: true;
 }
-export interface V2FileUploadRequest {
+export interface V1FileUploadRequest {
     spaceId: string;
     file: Blob;
     name?: string;
     path?: string;
     metadata?: JsonObject;
 }
-export interface V2RunFilesListQuery extends V2PageQuery {
+export interface V1RunFilesListQuery extends V1PageQuery {
     type?: string | string[];
 }
-export interface V2RunFilesExportRequest {
+export interface V1RunFilesExportRequest {
     format: 'zip';
     name: string;
     filter?: {
         type?: string[];
     };
 }
-export type V2RuntimeFileStageRequest = {
+export type V1RuntimeFileStageRequest = {
     storagePath: string;
     name?: string;
 } | {
     fileId: string;
     name?: string;
 };
-export interface V2RuntimeStagedFile {
+export interface V1RuntimeStagedFile {
     id: string;
     runtimeId: string;
     runtimePath: string;
@@ -353,17 +369,17 @@ export interface V2RuntimeStagedFile {
     sizeBytes: number;
     expiresAt: string | null;
 }
-export interface V2RuntimeFileUploadRequest {
+export interface V1RuntimeFileUploadRequest {
     file: Blob;
     name?: string;
     storagePath?: string;
     metadata?: JsonObject;
 }
-export interface V2RuntimeFileUploadResponse {
-    file: V2File;
-    staged: V2RuntimeStagedFile;
+export interface V1RuntimeFileUploadResponse {
+    file: V1File;
+    staged: V1RuntimeStagedFile;
 }
-export interface V2RuntimeFileCollectRequest {
+export interface V1RuntimeFileCollectRequest {
     path: string;
     storagePath?: string;
     name?: string;
@@ -373,14 +389,4 @@ export interface V2RuntimeFileCollectRequest {
         metadata?: JsonObject;
     };
 }
-export interface BrowserLaunchOptions {
-    name: string;
-    state?: 'ephemeral' | 'profile';
-    metadata?: JsonObject;
-    lifecycle?: V2RuntimeLifecycleConfig;
-    stealth?: V2BrowserStealth;
-    proxy?: V2ProxyInput | null;
-    fingerprint?: V2RuntimeFingerprintCreateConfig;
-    extensions?: string[];
-}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bctrl/sdk",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "BCTRL SDK - Remote browser automation",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -29,9 +29,9 @@
     "clean": "rm -rf dist",
     "build": "pnpm run clean && tsc -p tsconfig.json",
     "dev": "tsc --watch",
-    "test": "tsx --test tests/v2/*.test.ts tests/v2/e2e/*.test.ts",
-    "test:v2": "tsx --test tests/v2/*.test.ts tests/v2/e2e/*.test.ts",
-    "test:v2:e2e": "BCTRL_E2E=1 tsx --test tests/v2/e2e/**/*.test.ts",
+    "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"
   }
 }