@bctrl/sdk 1.0.3 → 1.0.5

package/README.md

@@ -21,22 +21,19 @@ const bctrl = new Bctrl({
 
 const space = await bctrl.spaces.create({
   name: 'my-task',
-  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/account.d.ts

@@ -0,0 +1,43 @@
+import type { V1HttpClient } from './http.js';
+import type { V1AccountUsage, V1ApiKey, V1ApiKeyCreateRequest, V1ApiKeyCreateResponse, V1ApiKeyDeleteResponse, V1ApiKeyListQuery, V1AuthWhoamiResponse, V1ListEnvelope, V1Subaccount, V1SubaccountArchiveResponse, V1SubaccountCreateRequest, V1SubaccountGetQuery, V1SubaccountListQuery, V1SubaccountUpdateRequest, V1SubaccountUsage, V1SubaccountUsageListQuery } from './types.js';
+export declare class V1AuthClient {
+    private readonly http;
+    constructor(http: V1HttpClient);
+    whoami(): Promise<V1AuthWhoamiResponse>;
+}
+export declare class V1ApiKeysClient {
+    private readonly http;
+    constructor(http: V1HttpClient);
+    list(query?: V1ApiKeyListQuery): Promise<V1ListEnvelope<V1ApiKey>>;
+    iter(query?: V1ApiKeyListQuery): AsyncGenerator<V1ApiKey, void, undefined>;
+    create(request?: V1ApiKeyCreateRequest): Promise<V1ApiKeyCreateResponse>;
+    delete(keyId: string): Promise<V1ApiKeyDeleteResponse>;
+}
+export declare class V1SubaccountUsageClient {
+    private readonly http;
+    constructor(http: V1HttpClient);
+    list(query?: V1SubaccountUsageListQuery): Promise<V1ListEnvelope<V1SubaccountUsage>>;
+    iter(query?: V1SubaccountUsageListQuery): AsyncGenerator<V1SubaccountUsage, void, undefined>;
+}
+export declare class V1SubaccountsClient {
+    private readonly http;
+    readonly usage: V1SubaccountUsageClient;
+    constructor(http: V1HttpClient);
+    list(query?: V1SubaccountListQuery): Promise<V1ListEnvelope<V1Subaccount>>;
+    iter(query?: V1SubaccountListQuery): AsyncGenerator<V1Subaccount, void, undefined>;
+    create(request: V1SubaccountCreateRequest): Promise<V1Subaccount>;
+    get(subaccountId: string, query?: V1SubaccountGetQuery): Promise<V1Subaccount>;
+    update(subaccountId: string, request: V1SubaccountUpdateRequest): Promise<V1Subaccount>;
+    archive(subaccountId: string): Promise<V1SubaccountArchiveResponse>;
+}
+export declare class V1UsageClient {
+    private readonly http;
+    constructor(http: V1HttpClient);
+    get(): Promise<V1AccountUsage>;
+}
+export declare class V1AccountClient {
+    readonly apiKeys: V1ApiKeysClient;
+    readonly subaccounts: V1SubaccountsClient;
+    readonly usage: V1UsageClient;
+    constructor(http: V1HttpClient);
+}

package/dist/account.js

@@ -0,0 +1,100 @@
+import { iterateV1Pages } from './pagination.js';
+export class V1AuthClient {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    whoami() {
+        return this.http.request('/auth/whoami');
+    }
+}
+export class V1ApiKeysClient {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    list(query = {}) {
+        return this.http.request('/api-keys', { query });
+    }
+    iter(query = {}) {
+        return iterateV1Pages(query, (pageQuery) => this.list(pageQuery));
+    }
+    create(request = {}) {
+        return this.http.request('/api-keys', {
+            method: 'POST',
+            body: request,
+        });
+    }
+    delete(keyId) {
+        return this.http.request(`/api-keys/${encodeURIComponent(keyId)}`, {
+            method: 'DELETE',
+        });
+    }
+}
+export class V1SubaccountUsageClient {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    list(query = {}) {
+        return this.http.request('/subaccounts/usage', {
+            query,
+        });
+    }
+    iter(query = {}) {
+        return iterateV1Pages(query, (pageQuery) => this.list(pageQuery));
+    }
+}
+export class V1SubaccountsClient {
+    http;
+    usage;
+    constructor(http) {
+        this.http = http;
+        this.usage = new V1SubaccountUsageClient(http);
+    }
+    list(query = {}) {
+        return this.http.request('/subaccounts', { query });
+    }
+    iter(query = {}) {
+        return iterateV1Pages(query, (pageQuery) => this.list(pageQuery));
+    }
+    create(request) {
+        return this.http.request('/subaccounts', {
+            method: 'POST',
+            body: request,
+        });
+    }
+    get(subaccountId, query = {}) {
+        return this.http.request(`/subaccounts/${encodeURIComponent(subaccountId)}`, {
+            query,
+        });
+    }
+    update(subaccountId, request) {
+        return this.http.request(`/subaccounts/${encodeURIComponent(subaccountId)}`, {
+            method: 'PATCH',
+            body: request,
+        });
+    }
+    archive(subaccountId) {
+        return this.http.request(`/subaccounts/${encodeURIComponent(subaccountId)}/archive`, { method: 'POST' });
+    }
+}
+export class V1UsageClient {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    get() {
+        return this.http.request('/usage');
+    }
+}
+export class V1AccountClient {
+    apiKeys;
+    subaccounts;
+    usage;
+    constructor(http) {
+        this.apiKeys = new V1ApiKeysClient(http);
+        this.subaccounts = new V1SubaccountsClient(http);
+        this.usage = new V1UsageClient(http);
+    }
+}

package/dist/accountTypes.d.ts

@@ -0,0 +1,126 @@
+import type { JsonObject, V1ListEnvelope, V1PageQuery } from './types.js';
+export type V1AuthScope = 'organization' | 'subaccount';
+export type V1Plan = 'free' | 'developer' | 'business' | 'enterprise';
+export interface V1AuthWhoamiResponse {
+    email: string | null;
+    scope: V1AuthScope;
+    organizationId: string;
+    subaccountId: string | null;
+    defaultSpaceId: string;
+    plan: V1Plan;
+    keyId: string;
+}
+export interface V1ApiKey {
+    id: string;
+    keyKind: 'organization' | 'subaccount';
+    subaccountId: string | null;
+    name: string | null;
+    keyPrefix: string;
+    scopes: '*'[];
+    expiresAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+    lastUsedAt: string | null;
+    usageCount: number;
+}
+export interface V1ApiKeyListQuery extends V1PageQuery {
+    subaccountId?: string;
+    keyKind?: V1ApiKey['keyKind'];
+}
+export interface V1ApiKeyCreateRequest {
+    name?: string;
+    subaccountId?: string;
+    scopes?: '*'[];
+    expiresAt?: string | null;
+}
+export interface V1ApiKeyCreateResponse {
+    data: V1ApiKey;
+    secret: string;
+}
+export interface V1ApiKeyDeleteResponse {
+    id: string;
+    deleted: true;
+}
+export interface V1AccountUsage {
+    organizationId: string;
+    isBlocked: boolean;
+    blockedReasons: string[];
+    cycle: {
+        startedAt: string | null;
+        endsAt: string | null;
+    };
+    credits: {
+        monthlyLimit: number;
+        monthlyUsed: number;
+        monthlyRemaining: number;
+        purchasedRemaining: number;
+        available: number;
+        outstandingDebt: number;
+        effectiveBalance: number;
+        breakdown: JsonObject;
+    };
+    computedAt: string;
+}
+export interface V1SubaccountLimits {
+    monthlyCredits?: number | null;
+    maxConcurrentRuntimes?: number | null;
+    maxRuntimeMinutes?: number | null;
+}
+export interface V1Subaccount {
+    id: string;
+    name: string;
+    status: 'active' | 'archived';
+    externalId?: string | null;
+    metadata?: JsonObject | null;
+    archivedAt?: string | null;
+    defaultSpaceId: string;
+    limits: V1SubaccountLimits;
+    usage?: V1SubaccountUsage;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface V1SubaccountListQuery extends V1PageQuery {
+    status?: V1Subaccount['status'];
+    externalId?: string;
+}
+export interface V1SubaccountCreateRequest {
+    name: string;
+    externalId?: string;
+    metadata?: JsonObject;
+    limits?: V1SubaccountLimits;
+}
+export interface V1SubaccountUpdateRequest {
+    name?: string;
+    externalId?: string | null;
+    metadata?: JsonObject | null;
+    limits?: V1SubaccountLimits;
+}
+export interface V1SubaccountGetQuery {
+    include?: 'usage' | 'usage'[];
+}
+export interface V1SubaccountArchiveResponse {
+    id: string;
+    archived: true;
+}
+export interface V1SubaccountUsage {
+    subaccountId: string;
+    isBlocked: boolean;
+    blockedReasons: string[];
+    cycle: {
+        startedAt: string | null;
+        endsAt: string | null;
+    };
+    credits: {
+        monthlyLimit: number;
+        monthlyUsed: number;
+        monthlyRemaining: number;
+        purchasedRemaining: number;
+        available: number;
+        breakdown: JsonObject;
+    };
+    computedAt: string;
+}
+export type V1SubaccountUsageListQuery = V1PageQuery & {
+    subaccountId?: string;
+};
+export type V1SubaccountUsageListResponse = V1ListEnvelope<V1SubaccountUsage>;

package/dist/accountTypes.js

@@ -0,0 +1 @@
+export {};

package/dist/aiProviderTypes.d.ts

@@ -0,0 +1,58 @@
+import type { V1PageQuery } from './types.js';
+export type V1AiProviderProvider = 'openai' | 'anthropic' | 'google' | 'groq' | 'deepseek' | 'mistral' | 'cerebras' | 'openrouter' | 'xai' | 'perplexity' | 'togetherai' | 'vercel-ai-gateway' | 'custom';
+export type V1AiProviderStatus = 'enabled' | 'disabled';
+export interface V1AiProviderModel {
+    id: string;
+    name?: string;
+    inputModalities?: string[];
+    outputModalities?: string[];
+}
+export interface V1AiProvider {
+    id: string;
+    name?: string;
+    provider: V1AiProviderProvider;
+    status: V1AiProviderStatus;
+    subaccountId?: string;
+    defaultModel?: string;
+    baseUrl?: string;
+    hasApiKey: boolean;
+    models?: V1AiProviderModel[];
+    createdAt: string;
+    updatedAt: string;
+}
+export interface V1AiProviderListQuery extends V1PageQuery {
+    provider?: V1AiProviderProvider;
+    status?: V1AiProviderStatus;
+    include?: 'models' | 'models'[];
+    subaccountId?: string;
+}
+export interface V1AiProviderGetQuery {
+    include?: 'models' | 'models'[];
+}
+export interface V1AiProviderCreateRequest {
+    provider: V1AiProviderProvider;
+    name?: string;
+    apiKey?: string;
+    defaultModel?: string;
+    baseUrl?: string;
+    status?: V1AiProviderStatus;
+    subaccountId?: string | null;
+    test?: boolean;
+}
+export interface V1AiProviderUpdateRequest {
+    name?: string;
+    apiKey?: string | null;
+    defaultModel?: string | null;
+    baseUrl?: string | null;
+    status?: V1AiProviderStatus;
+}
+export interface V1AiProviderDeleteResponse {
+    id: string;
+    deleted: true;
+}
+export interface V1AiProviderTestResponse {
+    ok: boolean;
+    checkedAt: string;
+    latencyMs?: number;
+    error?: string;
+}

package/dist/aiProviderTypes.js

@@ -0,0 +1 @@
+export {};

package/dist/aiProviders.d.ts

@@ -0,0 +1,13 @@
+import type { V1HttpClient } from './http.js';
+import type { V1AiProvider, V1AiProviderCreateRequest, V1AiProviderDeleteResponse, V1AiProviderGetQuery, V1AiProviderListQuery, V1AiProviderTestResponse, V1AiProviderUpdateRequest, V1ListEnvelope } from './types.js';
+export declare class V1AiProvidersClient {
+    private readonly http;
+    constructor(http: V1HttpClient);
+    list(query?: V1AiProviderListQuery): Promise<V1ListEnvelope<V1AiProvider>>;
+    iter(query?: V1AiProviderListQuery): AsyncGenerator<V1AiProvider, void, undefined>;
+    create(request: V1AiProviderCreateRequest): Promise<V1AiProvider>;
+    get(aiProviderId: string, query?: V1AiProviderGetQuery): Promise<V1AiProvider>;
+    update(aiProviderId: string, request: V1AiProviderUpdateRequest): Promise<V1AiProvider>;
+    delete(aiProviderId: string): Promise<V1AiProviderDeleteResponse>;
+    test(aiProviderId: string): Promise<V1AiProviderTestResponse>;
+}

package/dist/aiProviders.js

@@ -0,0 +1,36 @@
+import { iterateV1Pages } from './pagination.js';
+export class V1AiProvidersClient {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    list(query = {}) {
+        return this.http.request('/ai-providers', { query });
+    }
+    iter(query = {}) {
+        return iterateV1Pages(query, (pageQuery) => this.list(pageQuery));
+    }
+    create(request) {
+        return this.http.request('/ai-providers', {
+            method: 'POST',
+            body: request,
+        });
+    }
+    get(aiProviderId, query = {}) {
+        return this.http.request(`/ai-providers/${encodeURIComponent(aiProviderId)}`, {
+            query,
+        });
+    }
+    update(aiProviderId, request) {
+        return this.http.request(`/ai-providers/${encodeURIComponent(aiProviderId)}`, {
+            method: 'PATCH',
+            body: request,
+        });
+    }
+    delete(aiProviderId) {
+        return this.http.request(`/ai-providers/${encodeURIComponent(aiProviderId)}`, { method: 'DELETE' });
+    }
+    test(aiProviderId) {
+        return this.http.request(`/ai-providers/${encodeURIComponent(aiProviderId)}/test`, { method: 'POST' });
+    }
+}

package/dist/bctrl.d.ts

@@ -1,23 +1,55 @@
+import { V1AccountClient, V1ApiKeysClient, V1AuthClient, V1SubaccountsClient, V1UsageClient } from './account.js';
+import { V1AiProvidersClient } from './aiProviders.js';
+import { V1BrowserExtensionsClient } from './browserExtensions.js';
 import { V1FilesClient } from './files.js';
+import { V1HelpClient } from './help.js';
 import { type V1ClientOptions } from './http.js';
-import { V1InvocationsClient } from './invocations.js';
+import { V1ProxiesClient } from './proxies.js';
 import { V1RunsClient } from './runs.js';
 import { V1RuntimesClient } from './runtimes.js';
 import { V1SpacesClient } from './spaces.js';
+import { V1ToolCallsClient } from './toolCalls.js';
+import { V1ToolsClient } from './tools.js';
+import { V1ToolsetsClient } from './toolsets.js';
+import { V1VaultClient } from './vault.js';
 export type BctrlV1Options = V1ClientOptions;
 export declare class BctrlV1 {
     private readonly http;
     private _spaces;
     private _runtimes;
     private _runs;
-    private _invocations;
     private _files;
+    private _help;
+    private _tools;
+    private _toolsets;
+    private _toolCalls;
+    private _vault;
+    private _proxies;
+    private _browserExtensions;
+    private _aiProviders;
+    private _account;
+    private _apiKeys;
+    private _auth;
+    private _subaccounts;
+    private _usage;
     static isControllerBusy(error: unknown): boolean;
     constructor(options?: BctrlV1Options);
     get spaces(): V1SpacesClient;
     get runtimes(): V1RuntimesClient;
     get runs(): V1RunsClient;
-    get invocations(): V1InvocationsClient;
     get files(): V1FilesClient;
+    get help(): V1HelpClient;
+    get tools(): V1ToolsClient;
+    get toolsets(): V1ToolsetsClient;
+    get toolCalls(): V1ToolCallsClient;
+    get vault(): V1VaultClient;
+    get proxies(): V1ProxiesClient;
+    get browserExtensions(): V1BrowserExtensionsClient;
+    get aiProviders(): V1AiProvidersClient;
+    get account(): V1AccountClient;
+    get apiKeys(): V1ApiKeysClient;
+    get auth(): V1AuthClient;
+    get subaccounts(): V1SubaccountsClient;
+    get usage(): V1UsageClient;
 }
 export { BctrlV1 as Bctrl };

package/dist/bctrl.js

@@ -1,17 +1,37 @@
+import { V1AccountClient, V1ApiKeysClient, V1AuthClient, V1SubaccountsClient, V1UsageClient, } from './account.js';
+import { V1AiProvidersClient } from './aiProviders.js';
+import { V1BrowserExtensionsClient } from './browserExtensions.js';
 import { isControllerBusy } from './errors.js';
 import { V1FilesClient } from './files.js';
+import { V1HelpClient } from './help.js';
 import { V1HttpClient } from './http.js';
-import { V1InvocationsClient } from './invocations.js';
+import { V1ProxiesClient } from './proxies.js';
 import { V1RunsClient } from './runs.js';
 import { V1RuntimesClient } from './runtimes.js';
 import { V1SpacesClient } from './spaces.js';
+import { V1ToolCallsClient } from './toolCalls.js';
+import { V1ToolsClient } from './tools.js';
+import { V1ToolsetsClient } from './toolsets.js';
+import { V1VaultClient } from './vault.js';
 export class BctrlV1 {
     http;
     _spaces = null;
     _runtimes = null;
     _runs = null;
-    _invocations = null;
     _files = null;
+    _help = null;
+    _tools = null;
+    _toolsets = null;
+    _toolCalls = null;
+    _vault = null;
+    _proxies = null;
+    _browserExtensions = null;
+    _aiProviders = null;
+    _account = null;
+    _apiKeys = null;
+    _auth = null;
+    _subaccounts = null;
+    _usage = null;
     static isControllerBusy(error) {
         return isControllerBusy(error);
     }
@@ -30,13 +50,61 @@ export class BctrlV1 {
         this._runs ??= new V1RunsClient(this.http);
         return this._runs;
     }
-    get invocations() {
-        this._invocations ??= new V1InvocationsClient(this.http);
-        return this._invocations;
-    }
     get files() {
         this._files ??= new V1FilesClient(this.http);
         return this._files;
     }
+    get help() {
+        this._help ??= new V1HelpClient(this.http);
+        return this._help;
+    }
+    get tools() {
+        this._tools ??= new V1ToolsClient(this.http);
+        return this._tools;
+    }
+    get toolsets() {
+        this._toolsets ??= new V1ToolsetsClient(this.http);
+        return this._toolsets;
+    }
+    get toolCalls() {
+        this._toolCalls ??= new V1ToolCallsClient(this.http);
+        return this._toolCalls;
+    }
+    get vault() {
+        this._vault ??= new V1VaultClient(this.http);
+        return this._vault;
+    }
+    get proxies() {
+        this._proxies ??= new V1ProxiesClient(this.http);
+        return this._proxies;
+    }
+    get browserExtensions() {
+        this._browserExtensions ??= new V1BrowserExtensionsClient(this.http);
+        return this._browserExtensions;
+    }
+    get aiProviders() {
+        this._aiProviders ??= new V1AiProvidersClient(this.http);
+        return this._aiProviders;
+    }
+    get account() {
+        this._account ??= new V1AccountClient(this.http);
+        return this._account;
+    }
+    get apiKeys() {
+        this._apiKeys ??= new V1ApiKeysClient(this.http);
+        return this._apiKeys;
+    }
+    get auth() {
+        this._auth ??= new V1AuthClient(this.http);
+        return this._auth;
+    }
+    get subaccounts() {
+        this._subaccounts ??= new V1SubaccountsClient(this.http);
+        return this._subaccounts;
+    }
+    get usage() {
+        this._usage ??= new V1UsageClient(this.http);
+        return this._usage;
+    }
 }
 export { BctrlV1 as Bctrl };

package/dist/browserExtensionTypes.d.ts

@@ -0,0 +1,45 @@
+import type { V1PageQuery } from './types.js';
+export type V1BrowserExtensionFormat = 'crx';
+export type V1BrowserExtensionSource = 'upload' | 'url';
+export interface V1BrowserExtension {
+    id: string;
+    name: string;
+    version: string;
+    format: V1BrowserExtensionFormat;
+    subaccountId?: string;
+    sourceUrl?: string;
+    sizeBytes?: number;
+    contentHash?: string;
+    profileCount: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface V1BrowserExtensionListQuery extends V1PageQuery {
+    subaccountId?: string;
+    q?: string;
+    format?: V1BrowserExtensionFormat;
+    source?: V1BrowserExtensionSource;
+}
+export interface V1BrowserExtensionUploadRequest {
+    /** Packed Chromium extension package. Only .crx is supported today. */
+    file: Blob;
+    /** Optional display name. Defaults to manifest.name. */
+    name?: string;
+    /** Parent/org keys may create inside a child subaccount. */
+    subaccountId?: string;
+}
+export interface V1BrowserExtensionImportRequest {
+    /** Chrome Web Store detail URL. */
+    url: string;
+    /** Optional display name. Defaults to manifest.name. */
+    name?: string;
+    /** Parent/org keys may create inside a child subaccount. */
+    subaccountId?: string;
+}
+export interface V1BrowserExtensionUpdateRequest {
+    name: string;
+}
+export interface V1BrowserExtensionDeleteResponse {
+    id: string;
+    deleted: true;
+}

package/dist/browserExtensionTypes.js

@@ -0,0 +1 @@
+export {};

package/dist/browserExtensions.d.ts

@@ -0,0 +1,14 @@
+import type { V1HttpClient } from './http.js';
+import type { V1BrowserExtension, V1BrowserExtensionDeleteResponse, V1BrowserExtensionImportRequest, V1BrowserExtensionListQuery, V1BrowserExtensionUpdateRequest, V1BrowserExtensionUploadRequest } from './browserExtensionTypes.js';
+import type { V1ListEnvelope } from './types.js';
+export declare class V1BrowserExtensionsClient {
+    private readonly http;
+    constructor(http: V1HttpClient);
+    list(query?: V1BrowserExtensionListQuery): Promise<V1ListEnvelope<V1BrowserExtension>>;
+    iter(query?: V1BrowserExtensionListQuery): AsyncGenerator<V1BrowserExtension, void, undefined>;
+    get(extensionId: string): Promise<V1BrowserExtension>;
+    upload(request: V1BrowserExtensionUploadRequest): Promise<V1BrowserExtension>;
+    import(request: V1BrowserExtensionImportRequest): Promise<V1BrowserExtension>;
+    update(extensionId: string, request: V1BrowserExtensionUpdateRequest): Promise<V1BrowserExtension>;
+    delete(extensionId: string): Promise<V1BrowserExtensionDeleteResponse>;
+}