@bctrl/sdk/desktop

import { ... } from '@bctrl/sdk/desktop';

class DesktopClipboard

new (session: DesktopSession)

read(): Promise<string>

write(text: string): Promise<void>

class DesktopCua

new (session: DesktopSession)

close(): Promise<void>

init(config?: CuaAgentConfig): Promise<{ success: boolean; model: string }>

predictClick(instruction: string): Promise<CuaPredictClickResult>

run(instruction: string, options?: CuaRunOptions): Promise<CuaRunResult>

class DesktopKeyboard

new (session: DesktopSession)

down(key: string): Promise<void>

hotkey(...keys: string[]): Promise<void>

press(key: string): Promise<void>

type(text: string): Promise<void>

up(key: string): Promise<void>

class DesktopMouse

new (session: DesktopSession)

click(button?: 'left' | 'right' | 'middle'): Promise<void>

doubleClick(): Promise<void>

drag(fromX: number, fromY: number, toX: number, toY: number): Promise<void>

move(x: number, y: number): Promise<void>

position(): Promise<Point>

scroll(deltaX: number, deltaY: number): Promise<void>

class DesktopScreen

new (session: DesktopSession)

capture(region?: { x: number; y: number; width: number; height: number }): Promise<Buffer>

size(): Promise<Size>

class DesktopSession

new (sessionId: string, hostId: string, baseUrl: string, options?: { apiKey?: string })

close(): Promise<void>

closeBrowser(): Promise<void>

isBrowserRunning(): Promise<boolean>

launchBrowser(options?: {
    executablePath?: string;
    headless?: boolean;
    userDataDir?: string;
    args?: string[];
  }): Promise<BrowserLaunchResult>

rpc<T>(method: string, args: unknown[], target?: 'desktop' | 'cua'): Promise<T>

class DesktopWindow

new (session: DesktopSession)

active(): Promise<WindowInfo | null>

bounds(handle: number): Promise<Bounds>

close(handle: number): Promise<void>

focus(handle: number): Promise<void>

list(): Promise<WindowInfo[]>

maximize(handle: number): Promise<void>

minimize(handle: number): Promise<void>

restore(handle: number): Promise<void>

setBounds(handle: number, bounds: Partial<Bounds>): Promise<void>

const desktop: { connect(options: DesktopConnectOptions): Promise<DesktopSession>; }

export interface DesktopConnectOptions {
  /** API key for authentication */
  apiKey: string;
  /**
   * Target environment.
   * Defaults to `production` (`https://api.bctrl.ai`).
   * Use `development` for a local control plane on `http://localhost:3000`.
   */
  environment?: BctrlEnvironment;
  /**
   * Control plane origin or API base URL.
   * If you pass an origin, the SDK appends `/v1` automatically.
   */
  baseUrl?: string;
}