@hyperbrowser/sdk/dist/types/computer-action.d.ts

Node SDK for Hyperbrowser API

/**
 * Computer action types enumeration
 */
export declare enum ComputerAction {
    CLICK = "click",
    DRAG = "drag",
    HOLD_KEY = "hold_key",
    MOUSE_DOWN = "mouse_down",
    MOUSE_UP = "mouse_up",
    PRESS_KEYS = "press_keys",
    MOVE_MOUSE = "move_mouse",
    SCREENSHOT = "screenshot",
    SCROLL = "scroll",
    TYPE_TEXT = "type_text",
    GET_CLIPBOARD_TEXT = "get_clipboard_text",
    PUT_SELECTION_TEXT = "put_selection_text"
}
export type ComputerActionMouseButton = "left" | "right" | "middle" | "back" | "forward" | "wheel";
/**
 * Coordinate model for drag actions
 */
export interface Coordinate {
    x: number;
    y: number;
}
/**
 * Parameters for click action
 */
export interface ClickActionParams {
    action: ComputerAction.CLICK;
    x?: number;
    y?: number;
    button?: ComputerActionMouseButton;
    numClicks?: number;
    returnScreenshot?: boolean;
}
/**
 * Parameters for drag action
 */
export interface DragActionParams {
    action: ComputerAction.DRAG;
    path: Coordinate[];
    returnScreenshot?: boolean;
}
/**
 * Parameters for press keys action
 */
export interface PressKeysActionParams {
    action: ComputerAction.PRESS_KEYS;
    keys: string[];
    returnScreenshot?: boolean;
}
/**
 * Parameters for move mouse action
 */
export interface MoveMouseActionParams {
    action: ComputerAction.MOVE_MOUSE;
    x: number;
    y: number;
    returnScreenshot?: boolean;
}
/**
 * Parameters for screenshot action
 */
export interface ScreenshotActionParams {
    action: ComputerAction.SCREENSHOT;
}
/**
 * Parameters for scroll action
 */
export interface ScrollActionParams {
    action: ComputerAction.SCROLL;
    x: number;
    y: number;
    scrollX: number;
    scrollY: number;
    returnScreenshot?: boolean;
}
/**
 * Parameters for type text action
 */
export interface TypeTextActionParams {
    action: ComputerAction.TYPE_TEXT;
    text: string;
    returnScreenshot?: boolean;
}
/**
 * Parameters for hold key action
 */
export interface HoldKeyActionParams {
    action: ComputerAction.HOLD_KEY;
    key: string;
    duration: number;
    returnScreenshot?: boolean;
}
/**
 * Parameters for mouse down action
 */
export interface MouseDownActionParams {
    action: ComputerAction.MOUSE_DOWN;
    button?: ComputerActionMouseButton;
    returnScreenshot?: boolean;
}
/**
 * Parameters for mouse up action
 */
export interface MouseUpActionParams {
    action: ComputerAction.MOUSE_UP;
    button?: ComputerActionMouseButton;
    returnScreenshot?: boolean;
}
export interface GetClipboardTextActionParams {
    action: ComputerAction.GET_CLIPBOARD_TEXT;
    returnScreenshot?: boolean;
}
export interface PutSelectionTextActionParams {
    action: ComputerAction.PUT_SELECTION_TEXT;
    text: string;
    returnScreenshot?: boolean;
}
/**
 * Union type for all computer action parameters
 */
export type ComputerActionParams = ClickActionParams | DragActionParams | PressKeysActionParams | MoveMouseActionParams | ScreenshotActionParams | ScrollActionParams | TypeTextActionParams | HoldKeyActionParams | MouseDownActionParams | MouseUpActionParams | GetClipboardTextActionParams | PutSelectionTextActionParams;
export interface ComputerActionResponseDataClipboardText {
    clipboardText?: string;
}
export type ComputerActionResponseData = ComputerActionResponseDataClipboardText;
/**
 * Response from computer action API
 */
export interface ComputerActionResponse {
    success: boolean;
    screenshot?: string;
    data?: ComputerActionResponseData;
    error?: string;
    message?: string;
}