@trycua/cua-driver 0.11.0 → 0.12.3

package/dist/native/cua_driver_sdk.d.ts

@@ -25,6 +25,24 @@ export declare const DriverMetadata: Readonly<{
     new: (partial: Partial<DriverMetadata> & Required<Omit<DriverMetadata, "hostBundleId">>) => DriverMetadata;
     defaults: () => Partial<DriverMetadata>;
 }>;
+/**
+ * Options for a same-process Cua Driver SDK runtime.
+ */
+export type DriverOptions = {
+    /**
+     * Preserve the temporary reduced screenshot surface used by older Claude
+     * Code integrations. New applications should leave this false.
+     */
+    claudeCodeCompatibility: boolean;
+};
+/**
+ * Generated factory for {@link DriverOptions} record objects.
+ */
+export declare const DriverOptions: Readonly<{
+    create: (partial: Partial<DriverOptions> & Required<Omit<DriverOptions, never>>) => DriverOptions;
+    new: (partial: Partial<DriverOptions> & Required<Omit<DriverOptions, never>>) => DriverOptions;
+    defaults: () => Partial<DriverOptions>;
+}>;
 export type EmbeddedEnvironmentVariable = {
     name: string;
     value: string;
@@ -162,7 +180,8 @@ export declare enum DriverError_Tags {
     InvalidArguments = "InvalidArguments",
     Transport = "Transport",
     Protocol = "Protocol",
-    Tool = "Tool"
+    Tool = "Tool",
+    Shutdown = "Shutdown"
 }
 export declare const DriverError: Readonly<{
     instanceOf: (obj: any) => obj is DriverError;
@@ -628,8 +647,68 @@ export declare const DriverError: Readonly<{
         prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
         stackTraceLimit: number;
     };
+    Shutdown: {
+        new (): {
+            readonly tag: DriverError_Tags.Shutdown;
+            /**
+             * @private
+             * This field is private and should not be used, use `tag` instead.
+             */
+            readonly [uniffiTypeNameSymbol]: "DriverError";
+            name: string;
+            message: string;
+            stack?: string;
+            cause?: unknown;
+        };
+        "new"(): {
+            readonly tag: DriverError_Tags.Shutdown;
+            /**
+             * @private
+             * This field is private and should not be used, use `tag` instead.
+             */
+            readonly [uniffiTypeNameSymbol]: "DriverError";
+            name: string;
+            message: string;
+            stack?: string;
+            cause?: unknown;
+        };
+        instanceOf(obj: any): obj is {
+            readonly tag: DriverError_Tags.Shutdown;
+            /**
+             * @private
+             * This field is private and should not be used, use `tag` instead.
+             */
+            readonly [uniffiTypeNameSymbol]: "DriverError";
+            name: string;
+            message: string;
+            stack?: string;
+            cause?: unknown;
+        };
+        hasInner(obj: any): obj is {
+            readonly tag: DriverError_Tags.Shutdown;
+            /**
+             * @private
+             * This field is private and should not be used, use `tag` instead.
+             */
+            readonly [uniffiTypeNameSymbol]: "DriverError";
+            name: string;
+            message: string;
+            stack?: string;
+            cause?: unknown;
+        };
+        captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+        prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
+        stackTraceLimit: number;
+    };
 }>;
-export type DriverError = InstanceType<typeof DriverError['Configuration' | 'InvalidArguments' | 'Transport' | 'Protocol' | 'Tool']>;
+export type DriverError = InstanceType<typeof DriverError['Configuration' | 'InvalidArguments' | 'Transport' | 'Protocol' | 'Tool' | 'Shutdown']>;
+/**
+ * Process topology used by this SDK object.
+ */
+export declare enum DriverExecutionMode {
+    Embedded = 0,
+    Daemon = 1
+}
 export declare enum EmbeddedDriverError_Tags {
     Configuration = "Configuration",
     EndpointConflict = "EndpointConflict",
@@ -1321,30 +1400,89 @@ export declare enum EmbeddedDriverHostState {
     Ready = 2,
     Stopping = 3
 }
+/**
+ * Runtime that imported the shared UniFFI SDK library. The language package
+ * selects this automatically at its root entry point; callers do not need to
+ * supply telemetry metadata.
+ */
+export declare enum SdkClientKind {
+    Python = 0,
+    Typescript = 1
+}
 export interface CuaDriverLike {
     /**
-     * Escape hatch for forward-compatible tools and application-owned server
-     * adapters. Typed methods below serialize the same canonical Rust inputs.
+     * Generic protocol-adapter surface. Ordinary applications should prefer
+     * typed methods; MCP and other open-ended adapters use this method so they
+     * remain downstream of the same public SDK runtime.
      */
-    callTool(name: string, argumentsJson: string): ToolResult;
-    click(input: ClickInput): ToolResult;
-    drag(input: DragInput): ToolResult;
-    endSession(input: EndSessionInput): EndSessionOutput;
-    escalateSession(input: EscalateSessionInput): SessionStateOutput;
-    getCursorPosition(input: GetCursorPositionInput): ToolResult;
-    getDesktopState(input: GetDesktopStateInput): ToolResult;
-    getScreenSize(input: GetScreenSizeInput): ToolResult;
-    getSessionState(input: GetSessionStateInput): SessionStateOutput;
-    hotkey(input: HotkeyInput): ToolResult;
+    callTool(name: string, argumentsJson: string, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    click(input: ClickInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    drag(input: DragInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    endSession(input: EndSessionInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<EndSessionOutput>;
+    escalateSession(input: EscalateSessionInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<SessionStateOutput>;
+    executionMode(): DriverExecutionMode;
+    getCursorPosition(input: GetCursorPositionInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    getDesktopState(input: GetDesktopStateInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    getScreenSize(input: GetScreenSizeInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    getSessionState(input: GetSessionStateInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<SessionStateOutput>;
+    hotkey(input: HotkeyInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
     isAvailable(): boolean;
-    listToolsJson(): string;
-    metadata(): DriverMetadata;
-    moveCursor(input: MoveCursorInput): ToolResult;
-    pressKey(input: PressKeyInput): ToolResult;
-    scroll(input: ScrollInput): ToolResult;
+    /**
+     * Canonical tool inventory for MCP and other protocol adapters.
+     */
+    listToolsJson(asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<string>;
+    metadata(asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<DriverMetadata>;
+    moveCursor(input: MoveCursorInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    pressKey(input: PressKeyInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    scroll(input: ScrollInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    /**
+     * Stop accepting new embedded operations. Repeated calls are harmless;
+     * daemon compatibility clients do not own the daemon and therefore no-op.
+     */
+    shutdown(asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Compatibility accessor. Embedded runtimes have no socket and return an
+     * empty string; new code should branch on [`Self::execution_mode`].
+     */
     socketPath(): string;
-    startSession(input: StartSessionInput): StartSessionOutput;
-    typeText(input: TypeTextInput): ToolResult;
+    startSession(input: StartSessionInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<StartSessionOutput>;
+    typeText(input: TypeTextInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
 }
 /**
  * @deprecated Use `CuaDriverLike` instead.
@@ -1357,32 +1495,97 @@ export declare class CuaDriver extends UniffiAbstractObject implements CuaDriver
     private constructor();
     /**
      * Connect to the default installed daemon or an explicitly selected socket.
-     * Construction does not launch a process or perform I/O.
+     * This is the temporary compatibility path for released socket clients.
      */
     static connect(socketPath: string | undefined): CuaDriverLike;
     /**
-     * Escape hatch for forward-compatible tools and application-owned server
-     * adapters. Typed methods below serialize the same canonical Rust inputs.
+     * Language-package entry point that preserves the public `connect` API
+     * while attaching a closed runtime category to daemon requests.
+     */
+    static connectWithClientKind(socketPath: string | undefined, clientKind: SdkClientKind): CuaDriverLike;
+    /**
+     * Create a same-process driver runtime. This constructor never launches
+     * `cua-driver` and never opens daemon IPC.
+     */
+    static create(options: DriverOptions | undefined): CuaDriverLike;
+    /**
+     * Language-package entry point for the same-process runtime. The wrapper
+     * at each package root selects the client kind automatically.
      */
-    callTool(name: string, argumentsJson: string): ToolResult;
-    click(input: ClickInput): ToolResult;
-    drag(input: DragInput): ToolResult;
-    endSession(input: EndSessionInput): EndSessionOutput;
-    escalateSession(input: EscalateSessionInput): SessionStateOutput;
-    getCursorPosition(input: GetCursorPositionInput): ToolResult;
-    getDesktopState(input: GetDesktopStateInput): ToolResult;
-    getScreenSize(input: GetScreenSizeInput): ToolResult;
-    getSessionState(input: GetSessionStateInput): SessionStateOutput;
-    hotkey(input: HotkeyInput): ToolResult;
+    static createWithClientKind(options: DriverOptions | undefined, clientKind: SdkClientKind): CuaDriverLike;
+    /**
+     * Generic protocol-adapter surface. Ordinary applications should prefer
+     * typed methods; MCP and other open-ended adapters use this method so they
+     * remain downstream of the same public SDK runtime.
+     */
+    callTool(name: string, argumentsJson: string, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    click(input: ClickInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    drag(input: DragInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    endSession(input: EndSessionInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<EndSessionOutput>;
+    escalateSession(input: EscalateSessionInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<SessionStateOutput>;
+    executionMode(): DriverExecutionMode;
+    getCursorPosition(input: GetCursorPositionInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    getDesktopState(input: GetDesktopStateInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    getScreenSize(input: GetScreenSizeInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    getSessionState(input: GetSessionStateInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<SessionStateOutput>;
+    hotkey(input: HotkeyInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
     isAvailable(): boolean;
-    listToolsJson(): string;
-    metadata(): DriverMetadata;
-    moveCursor(input: MoveCursorInput): ToolResult;
-    pressKey(input: PressKeyInput): ToolResult;
-    scroll(input: ScrollInput): ToolResult;
+    /**
+     * Canonical tool inventory for MCP and other protocol adapters.
+     */
+    listToolsJson(asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<string>;
+    metadata(asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<DriverMetadata>;
+    moveCursor(input: MoveCursorInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    pressKey(input: PressKeyInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    scroll(input: ScrollInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
+    /**
+     * Stop accepting new embedded operations. Repeated calls are harmless;
+     * daemon compatibility clients do not own the daemon and therefore no-op.
+     */
+    shutdown(asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Compatibility accessor. Embedded runtimes have no socket and return an
+     * empty string; new code should branch on [`Self::execution_mode`].
+     */
     socketPath(): string;
-    startSession(input: StartSessionInput): StartSessionOutput;
-    typeText(input: TypeTextInput): ToolResult;
+    startSession(input: StartSessionInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<StartSessionOutput>;
+    typeText(input: TypeTextInput, asyncOpts_?: {
+        signal: AbortSignal;
+    }): Promise<ToolResult>;
     uniffiDestroy(): void;
     static instanceOf(obj_: any): obj_ is CuaDriver;
 }
@@ -1451,6 +1654,13 @@ declare const _default: Readonly<{
             lift(value: UniffiByteArray): DriverError;
             lower(value: DriverError, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
         };
+        FfiConverterTypeDriverExecutionMode: {
+            read(from: RustBuffer): DriverExecutionMode;
+            write(value: DriverExecutionMode, into: RustBuffer): void;
+            allocationSize(value: DriverExecutionMode): number;
+            lift(value: UniffiByteArray): DriverExecutionMode;
+            lower(value: DriverExecutionMode, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
         FfiConverterTypeDriverMetadata: {
             read(from: RustBuffer): DriverMetadata;
             write(value: DriverMetadata, into: RustBuffer): void;
@@ -1458,6 +1668,13 @@ declare const _default: Readonly<{
             lift(value: UniffiByteArray): DriverMetadata;
             lower(value: DriverMetadata, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
         };
+        FfiConverterTypeDriverOptions: {
+            read(from: RustBuffer): DriverOptions;
+            write(value: DriverOptions, into: RustBuffer): void;
+            allocationSize(value: DriverOptions): number;
+            lift(value: UniffiByteArray): DriverOptions;
+            lower(value: DriverOptions, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
         FfiConverterTypeEmbeddedCuaDriverHost: FfiConverterObject<EmbeddedCuaDriverHostLike>;
         FfiConverterTypeEmbeddedDriverConnection: {
             read(from: RustBuffer): EmbeddedDriverConnection;
@@ -1529,6 +1746,13 @@ declare const _default: Readonly<{
             lift(value: UniffiByteArray): MacOsPermissionStatus;
             lower(value: MacOsPermissionStatus, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
         };
+        FfiConverterTypeSdkClientKind: {
+            read(from: RustBuffer): SdkClientKind;
+            write(value: SdkClientKind, into: RustBuffer): void;
+            allocationSize(value: SdkClientKind): number;
+            lift(value: UniffiByteArray): SdkClientKind;
+            lower(value: SdkClientKind, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
         FfiConverterTypeToolResult: {
             read(from: RustBuffer): ToolResult;
             write(value: ToolResult, into: RustBuffer): void;