@trycua/cua-driver 0.11.0

package/dist/native/cua_driver_contract.d.ts

@@ -0,0 +1,515 @@
+import { type UniffiByteArray, RustBuffer } from "@ubjs/core";
+export declare enum DesktopScope {
+    Desktop = 0
+}
+export declare enum ClickButton {
+    Left = 0,
+    Right = 1,
+    Middle = 2
+}
+export type ClickInput = {
+    x: number;
+    y: number;
+    scope: DesktopScope;
+    /**
+     * Optional session id.
+     */
+    session?: string;
+    button?: ClickButton;
+    count?: number;
+};
+/**
+ * Generated factory for {@link ClickInput} record objects.
+ */
+export declare const ClickInput: Readonly<{
+    create: (partial: Partial<ClickInput> & Required<Omit<ClickInput, "session" | "button" | "count">>) => ClickInput;
+    new: (partial: Partial<ClickInput> & Required<Omit<ClickInput, "session" | "button" | "count">>) => ClickInput;
+    defaults: () => Partial<ClickInput>;
+}>;
+export type DragInput = {
+    fromX: number;
+    fromY: number;
+    toX: number;
+    toY: number;
+    scope: DesktopScope;
+    /**
+     * Optional session id.
+     */
+    session?: string;
+    durationMs?: bigint;
+    steps?: bigint;
+    button?: ClickButton;
+    modifier?: Array<string>;
+};
+/**
+ * Generated factory for {@link DragInput} record objects.
+ */
+export declare const DragInput: Readonly<{
+    create: (partial: Partial<DragInput> & Required<Omit<DragInput, "session" | "button" | "durationMs" | "steps" | "modifier">>) => DragInput;
+    new: (partial: Partial<DragInput> & Required<Omit<DragInput, "session" | "button" | "durationMs" | "steps" | "modifier">>) => DragInput;
+    defaults: () => Partial<DragInput>;
+}>;
+export type EndSessionInput = {
+    /**
+     * The session id to end.
+     */
+    session: string;
+};
+/**
+ * Generated factory for {@link EndSessionInput} record objects.
+ */
+export declare const EndSessionInput: Readonly<{
+    create: (partial: Partial<EndSessionInput> & Required<Omit<EndSessionInput, never>>) => EndSessionInput;
+    new: (partial: Partial<EndSessionInput> & Required<Omit<EndSessionInput, never>>) => EndSessionInput;
+    defaults: () => Partial<EndSessionInput>;
+}>;
+/**
+ * Successful structured result returned by `end_session`.
+ */
+export type EndSessionOutput = {
+    session: string;
+    active: boolean;
+};
+/**
+ * Generated factory for {@link EndSessionOutput} record objects.
+ */
+export declare const EndSessionOutput: Readonly<{
+    create: (partial: Partial<EndSessionOutput> & Required<Omit<EndSessionOutput, never>>) => EndSessionOutput;
+    new: (partial: Partial<EndSessionOutput> & Required<Omit<EndSessionOutput, never>>) => EndSessionOutput;
+    defaults: () => Partial<EndSessionOutput>;
+}>;
+export declare enum EscalationReason {
+    AxTreePixelMismatch = 0,
+    BackgroundDeliveryFailed = 1,
+    ForegroundIneffective = 2,
+    NoWindowTarget = 3,
+    Other = 4
+}
+export type EscalateSessionInput = {
+    session: string;
+    reason: EscalationReason;
+    /**
+     * Optional bounded diagnostic detail. Never use secrets or page content.
+     */
+    detail?: string;
+};
+/**
+ * Generated factory for {@link EscalateSessionInput} record objects.
+ */
+export declare const EscalateSessionInput: Readonly<{
+    create: (partial: Partial<EscalateSessionInput> & Required<Omit<EscalateSessionInput, "detail">>) => EscalateSessionInput;
+    new: (partial: Partial<EscalateSessionInput> & Required<Omit<EscalateSessionInput, "detail">>) => EscalateSessionInput;
+    defaults: () => Partial<EscalateSessionInput>;
+}>;
+export type GetCursorPositionInput = {
+    /**
+     * Optional session id.
+     */
+    session?: string;
+};
+/**
+ * Generated factory for {@link GetCursorPositionInput} record objects.
+ */
+export declare const GetCursorPositionInput: Readonly<{
+    create: (partial: Partial<GetCursorPositionInput> & Required<Omit<GetCursorPositionInput, "session">>) => GetCursorPositionInput;
+    new: (partial: Partial<GetCursorPositionInput> & Required<Omit<GetCursorPositionInput, "session">>) => GetCursorPositionInput;
+    defaults: () => Partial<GetCursorPositionInput>;
+}>;
+export type GetDesktopStateInput = {
+    /**
+     * Optional session id.
+     */
+    session?: string;
+    /**
+     * Write the PNG here instead of returning base64.
+     */
+    screenshotOutFile?: string;
+};
+/**
+ * Generated factory for {@link GetDesktopStateInput} record objects.
+ */
+export declare const GetDesktopStateInput: Readonly<{
+    create: (partial: Partial<GetDesktopStateInput> & Required<Omit<GetDesktopStateInput, "session" | "screenshotOutFile">>) => GetDesktopStateInput;
+    new: (partial: Partial<GetDesktopStateInput> & Required<Omit<GetDesktopStateInput, "session" | "screenshotOutFile">>) => GetDesktopStateInput;
+    defaults: () => Partial<GetDesktopStateInput>;
+}>;
+export type GetScreenSizeInput = {
+    /**
+     * Optional session id.
+     */
+    session?: string;
+};
+/**
+ * Generated factory for {@link GetScreenSizeInput} record objects.
+ */
+export declare const GetScreenSizeInput: Readonly<{
+    create: (partial: Partial<GetScreenSizeInput> & Required<Omit<GetScreenSizeInput, "session">>) => GetScreenSizeInput;
+    new: (partial: Partial<GetScreenSizeInput> & Required<Omit<GetScreenSizeInput, "session">>) => GetScreenSizeInput;
+    defaults: () => Partial<GetScreenSizeInput>;
+}>;
+export type GetSessionStateInput = {
+    session: string;
+};
+/**
+ * Generated factory for {@link GetSessionStateInput} record objects.
+ */
+export declare const GetSessionStateInput: Readonly<{
+    create: (partial: Partial<GetSessionStateInput> & Required<Omit<GetSessionStateInput, never>>) => GetSessionStateInput;
+    new: (partial: Partial<GetSessionStateInput> & Required<Omit<GetSessionStateInput, never>>) => GetSessionStateInput;
+    defaults: () => Partial<GetSessionStateInput>;
+}>;
+export type HotkeyInput = {
+    keys: Array<string>;
+    scope: DesktopScope;
+    /**
+     * Optional session id.
+     */
+    session?: string;
+};
+/**
+ * Generated factory for {@link HotkeyInput} record objects.
+ */
+export declare const HotkeyInput: Readonly<{
+    create: (partial: Partial<HotkeyInput> & Required<Omit<HotkeyInput, "session">>) => HotkeyInput;
+    new: (partial: Partial<HotkeyInput> & Required<Omit<HotkeyInput, "session">>) => HotkeyInput;
+    defaults: () => Partial<HotkeyInput>;
+}>;
+export type MoveCursorInput = {
+    x: number;
+    y: number;
+    scope: DesktopScope;
+    /**
+     * Optional session id.
+     */
+    session?: string;
+};
+/**
+ * Generated factory for {@link MoveCursorInput} record objects.
+ */
+export declare const MoveCursorInput: Readonly<{
+    create: (partial: Partial<MoveCursorInput> & Required<Omit<MoveCursorInput, "session">>) => MoveCursorInput;
+    new: (partial: Partial<MoveCursorInput> & Required<Omit<MoveCursorInput, "session">>) => MoveCursorInput;
+    defaults: () => Partial<MoveCursorInput>;
+}>;
+export type PressKeyInput = {
+    key: string;
+    scope: DesktopScope;
+    /**
+     * Optional session id.
+     */
+    session?: string;
+    modifiers?: Array<string>;
+};
+/**
+ * Generated factory for {@link PressKeyInput} record objects.
+ */
+export declare const PressKeyInput: Readonly<{
+    create: (partial: Partial<PressKeyInput> & Required<Omit<PressKeyInput, "session" | "modifiers">>) => PressKeyInput;
+    new: (partial: Partial<PressKeyInput> & Required<Omit<PressKeyInput, "session" | "modifiers">>) => PressKeyInput;
+    defaults: () => Partial<PressKeyInput>;
+}>;
+export declare enum ScrollDirection {
+    Up = 0,
+    Down = 1,
+    Left = 2,
+    Right = 3
+}
+export declare enum ScrollBy {
+    Line = 0,
+    Page = 1
+}
+export type ScrollInput = {
+    x: number;
+    y: number;
+    direction: ScrollDirection;
+    scope: DesktopScope;
+    /**
+     * Optional session id.
+     */
+    session?: string;
+    by?: ScrollBy;
+    amount?: bigint;
+};
+/**
+ * Generated factory for {@link ScrollInput} record objects.
+ */
+export declare const ScrollInput: Readonly<{
+    create: (partial: Partial<ScrollInput> & Required<Omit<ScrollInput, "session" | "by" | "amount">>) => ScrollInput;
+    new: (partial: Partial<ScrollInput> & Required<Omit<ScrollInput, "session" | "by" | "amount">>) => ScrollInput;
+    defaults: () => Partial<ScrollInput>;
+}>;
+export declare enum CaptureScope {
+    Auto = 0,
+    Window = 1,
+    Desktop = 2
+}
+export declare enum EffectiveScope {
+    Window = 0,
+    Desktop = 1
+}
+/**
+ * Successful structured result shared by session state and escalation tools.
+ */
+export type SessionStateOutput = {
+    session: string;
+    captureScope: CaptureScope;
+    effectiveScope: EffectiveScope;
+    desktopUnlocked: boolean;
+    escalationReason?: EscalationReason;
+    escalationDetail?: string;
+};
+/**
+ * Generated factory for {@link SessionStateOutput} record objects.
+ */
+export declare const SessionStateOutput: Readonly<{
+    create: (partial: Partial<SessionStateOutput> & Required<Omit<SessionStateOutput, "escalationReason" | "escalationDetail">>) => SessionStateOutput;
+    new: (partial: Partial<SessionStateOutput> & Required<Omit<SessionStateOutput, "escalationReason" | "escalationDetail">>) => SessionStateOutput;
+    defaults: () => Partial<SessionStateOutput>;
+}>;
+export type StartSessionInput = {
+    /**
+     * Stable session id for this run (e.g. "research-run-1").
+     */
+    session: string;
+    /**
+     * Per-session perception/action modality. auto starts window-only and requires explicit escalation before desktop tools; window and desktop are strict. Immutable for the live session.
+     */
+    captureScope?: CaptureScope;
+};
+/**
+ * Generated factory for {@link StartSessionInput} record objects.
+ */
+export declare const StartSessionInput: Readonly<{
+    create: (partial: Partial<StartSessionInput> & Required<Omit<StartSessionInput, "captureScope">>) => StartSessionInput;
+    new: (partial: Partial<StartSessionInput> & Required<Omit<StartSessionInput, "captureScope">>) => StartSessionInput;
+    defaults: () => Partial<StartSessionInput>;
+}>;
+/**
+ * Successful structured result returned by `start_session`.
+ */
+export type StartSessionOutput = {
+    state: SessionStateOutput;
+    active: boolean;
+    revived: boolean;
+};
+/**
+ * Generated factory for {@link StartSessionOutput} record objects.
+ */
+export declare const StartSessionOutput: Readonly<{
+    create: (partial: Partial<StartSessionOutput> & Required<Omit<StartSessionOutput, never>>) => StartSessionOutput;
+    new: (partial: Partial<StartSessionOutput> & Required<Omit<StartSessionOutput, never>>) => StartSessionOutput;
+    defaults: () => Partial<StartSessionOutput>;
+}>;
+export type TypeTextInput = {
+    text: string;
+    scope: DesktopScope;
+    /**
+     * Optional session id.
+     */
+    session?: string;
+};
+/**
+ * Generated factory for {@link TypeTextInput} record objects.
+ */
+export declare const TypeTextInput: Readonly<{
+    create: (partial: Partial<TypeTextInput> & Required<Omit<TypeTextInput, "session">>) => TypeTextInput;
+    new: (partial: Partial<TypeTextInput> & Required<Omit<TypeTextInput, "session">>) => TypeTextInput;
+    defaults: () => Partial<TypeTextInput>;
+}>;
+export declare enum Platform {
+    Macos = 0,
+    Windows = 1,
+    Linux = 2
+}
+/**
+ * This should be called before anything else.
+ *
+ * It is likely that this is being done for you by the library's `index.ts`.
+ *
+ * It checks versions of uniffi between when the Rust scaffolding was generated
+ * and when the bindings were generated.
+ *
+ * It also initializes the machinery to enable Rust to talk back to Javascript.
+ */
+declare function uniffiEnsureInitialized(): void;
+declare const _default: Readonly<{
+    initialize: typeof uniffiEnsureInitialized;
+    converters: {
+        FfiConverterTypeCaptureScope: {
+            read(from: RustBuffer): CaptureScope;
+            write(value: CaptureScope, into: RustBuffer): void;
+            allocationSize(value: CaptureScope): number;
+            lift(value: UniffiByteArray): CaptureScope;
+            lower(value: CaptureScope, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeClickButton: {
+            read(from: RustBuffer): ClickButton;
+            write(value: ClickButton, into: RustBuffer): void;
+            allocationSize(value: ClickButton): number;
+            lift(value: UniffiByteArray): ClickButton;
+            lower(value: ClickButton, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeClickInput: {
+            read(from: RustBuffer): ClickInput;
+            write(value: ClickInput, into: RustBuffer): void;
+            allocationSize(value: ClickInput): number;
+            lift(value: UniffiByteArray): ClickInput;
+            lower(value: ClickInput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeDesktopScope: {
+            read(from: RustBuffer): DesktopScope;
+            write(value: DesktopScope, into: RustBuffer): void;
+            allocationSize(value: DesktopScope): number;
+            lift(value: UniffiByteArray): DesktopScope;
+            lower(value: DesktopScope, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeDragInput: {
+            read(from: RustBuffer): DragInput;
+            write(value: DragInput, into: RustBuffer): void;
+            allocationSize(value: DragInput): number;
+            lift(value: UniffiByteArray): DragInput;
+            lower(value: DragInput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeEffectiveScope: {
+            read(from: RustBuffer): EffectiveScope;
+            write(value: EffectiveScope, into: RustBuffer): void;
+            allocationSize(value: EffectiveScope): number;
+            lift(value: UniffiByteArray): EffectiveScope;
+            lower(value: EffectiveScope, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeEndSessionInput: {
+            read(from: RustBuffer): EndSessionInput;
+            write(value: EndSessionInput, into: RustBuffer): void;
+            allocationSize(value: EndSessionInput): number;
+            lift(value: UniffiByteArray): EndSessionInput;
+            lower(value: EndSessionInput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeEndSessionOutput: {
+            read(from: RustBuffer): EndSessionOutput;
+            write(value: EndSessionOutput, into: RustBuffer): void;
+            allocationSize(value: EndSessionOutput): number;
+            lift(value: UniffiByteArray): EndSessionOutput;
+            lower(value: EndSessionOutput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeEscalateSessionInput: {
+            read(from: RustBuffer): EscalateSessionInput;
+            write(value: EscalateSessionInput, into: RustBuffer): void;
+            allocationSize(value: EscalateSessionInput): number;
+            lift(value: UniffiByteArray): EscalateSessionInput;
+            lower(value: EscalateSessionInput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeEscalationReason: {
+            read(from: RustBuffer): EscalationReason;
+            write(value: EscalationReason, into: RustBuffer): void;
+            allocationSize(value: EscalationReason): number;
+            lift(value: UniffiByteArray): EscalationReason;
+            lower(value: EscalationReason, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeGetCursorPositionInput: {
+            read(from: RustBuffer): GetCursorPositionInput;
+            write(value: GetCursorPositionInput, into: RustBuffer): void;
+            allocationSize(value: GetCursorPositionInput): number;
+            lift(value: UniffiByteArray): GetCursorPositionInput;
+            lower(value: GetCursorPositionInput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeGetDesktopStateInput: {
+            read(from: RustBuffer): GetDesktopStateInput;
+            write(value: GetDesktopStateInput, into: RustBuffer): void;
+            allocationSize(value: GetDesktopStateInput): number;
+            lift(value: UniffiByteArray): GetDesktopStateInput;
+            lower(value: GetDesktopStateInput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeGetScreenSizeInput: {
+            read(from: RustBuffer): GetScreenSizeInput;
+            write(value: GetScreenSizeInput, into: RustBuffer): void;
+            allocationSize(value: GetScreenSizeInput): number;
+            lift(value: UniffiByteArray): GetScreenSizeInput;
+            lower(value: GetScreenSizeInput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeGetSessionStateInput: {
+            read(from: RustBuffer): GetSessionStateInput;
+            write(value: GetSessionStateInput, into: RustBuffer): void;
+            allocationSize(value: GetSessionStateInput): number;
+            lift(value: UniffiByteArray): GetSessionStateInput;
+            lower(value: GetSessionStateInput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeHotkeyInput: {
+            read(from: RustBuffer): HotkeyInput;
+            write(value: HotkeyInput, into: RustBuffer): void;
+            allocationSize(value: HotkeyInput): number;
+            lift(value: UniffiByteArray): HotkeyInput;
+            lower(value: HotkeyInput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeMoveCursorInput: {
+            read(from: RustBuffer): MoveCursorInput;
+            write(value: MoveCursorInput, into: RustBuffer): void;
+            allocationSize(value: MoveCursorInput): number;
+            lift(value: UniffiByteArray): MoveCursorInput;
+            lower(value: MoveCursorInput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypePlatform: {
+            read(from: RustBuffer): Platform;
+            write(value: Platform, into: RustBuffer): void;
+            allocationSize(value: Platform): number;
+            lift(value: UniffiByteArray): Platform;
+            lower(value: Platform, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypePressKeyInput: {
+            read(from: RustBuffer): PressKeyInput;
+            write(value: PressKeyInput, into: RustBuffer): void;
+            allocationSize(value: PressKeyInput): number;
+            lift(value: UniffiByteArray): PressKeyInput;
+            lower(value: PressKeyInput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeScrollBy: {
+            read(from: RustBuffer): ScrollBy;
+            write(value: ScrollBy, into: RustBuffer): void;
+            allocationSize(value: ScrollBy): number;
+            lift(value: UniffiByteArray): ScrollBy;
+            lower(value: ScrollBy, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeScrollDirection: {
+            read(from: RustBuffer): ScrollDirection;
+            write(value: ScrollDirection, into: RustBuffer): void;
+            allocationSize(value: ScrollDirection): number;
+            lift(value: UniffiByteArray): ScrollDirection;
+            lower(value: ScrollDirection, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeScrollInput: {
+            read(from: RustBuffer): ScrollInput;
+            write(value: ScrollInput, into: RustBuffer): void;
+            allocationSize(value: ScrollInput): number;
+            lift(value: UniffiByteArray): ScrollInput;
+            lower(value: ScrollInput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeSessionStateOutput: {
+            read(from: RustBuffer): SessionStateOutput;
+            write(value: SessionStateOutput, into: RustBuffer): void;
+            allocationSize(value: SessionStateOutput): number;
+            lift(value: UniffiByteArray): SessionStateOutput;
+            lower(value: SessionStateOutput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeStartSessionInput: {
+            read(from: RustBuffer): StartSessionInput;
+            write(value: StartSessionInput, into: RustBuffer): void;
+            allocationSize(value: StartSessionInput): number;
+            lift(value: UniffiByteArray): StartSessionInput;
+            lower(value: StartSessionInput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeStartSessionOutput: {
+            read(from: RustBuffer): StartSessionOutput;
+            write(value: StartSessionOutput, into: RustBuffer): void;
+            allocationSize(value: StartSessionOutput): number;
+            lift(value: UniffiByteArray): StartSessionOutput;
+            lower(value: StartSessionOutput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+        FfiConverterTypeTypeTextInput: {
+            read(from: RustBuffer): TypeTextInput;
+            write(value: TypeTextInput, into: RustBuffer): void;
+            allocationSize(value: TypeTextInput): number;
+            lift(value: UniffiByteArray): TypeTextInput;
+            lower(value: TypeTextInput, alloc: import("@ubjs/core").RustBufferAllocator): UniffiByteArray;
+        };
+    };
+}>;
+export default _default;