@hyperbrowser/sdk 0.68.0 → 0.70.0

package/dist/services/computer-action.d.ts

@@ -1,13 +1,17 @@
 import { SessionDetail } from "../types";
-import { ComputerActionResponse, Coordinate } from "../types/computer-action";
+import { ComputerActionResponse, Coordinate, ComputerActionMouseButton } from "../types/computer-action";
 import { BaseService } from "./base";
 export declare class ComputerActionService extends BaseService {
     private executeRequest;
-    click(session: SessionDetail | string, x: number, y: number, button?: "left" | "right" | "middle" | "back" | "forward" | "wheel", numClicks?: number, returnScreenshot?: boolean): Promise<ComputerActionResponse>;
+    click(session: SessionDetail | string, x: number, y: number, button?: ComputerActionMouseButton, numClicks?: number, returnScreenshot?: boolean): Promise<ComputerActionResponse>;
     typeText(session: SessionDetail | string, text: string, returnScreenshot?: boolean): Promise<ComputerActionResponse>;
     screenshot(session: SessionDetail | string): Promise<ComputerActionResponse>;
     pressKeys(session: SessionDetail | string, keys: string[], returnScreenshot?: boolean): Promise<ComputerActionResponse>;
     drag(session: SessionDetail | string, path: Coordinate[], returnScreenshot?: boolean): Promise<ComputerActionResponse>;
     moveMouse(session: SessionDetail | string, x: number, y: number, returnScreenshot?: boolean): Promise<ComputerActionResponse>;
     scroll(session: SessionDetail | string, x: number, y: number, scrollX: number, scrollY: number, returnScreenshot?: boolean): Promise<ComputerActionResponse>;
+    holdKey(session: SessionDetail | string, key: string, duration: number, returnScreenshot?: boolean): Promise<ComputerActionResponse>;
+    mouseDown(session: SessionDetail | string, button?: ComputerActionMouseButton, returnScreenshot?: boolean): Promise<ComputerActionResponse>;
+    mouseUp(session: SessionDetail | string, button?: ComputerActionMouseButton, returnScreenshot?: boolean): Promise<ComputerActionResponse>;
+    getClipboardText(session: SessionDetail | string, returnScreenshot?: boolean): Promise<ComputerActionResponse>;
 }

package/dist/services/computer-action.js

@@ -83,5 +83,33 @@ class ComputerActionService extends base_1.BaseService {
             returnScreenshot,
         });
     }
+    async holdKey(session, key, duration, returnScreenshot = false) {
+        return this.executeRequest(session, {
+            action: computer_action_1.ComputerAction.HOLD_KEY,
+            key,
+            duration,
+            returnScreenshot,
+        });
+    }
+    async mouseDown(session, button = "left", returnScreenshot = false) {
+        return this.executeRequest(session, {
+            action: computer_action_1.ComputerAction.MOUSE_DOWN,
+            button,
+            returnScreenshot,
+        });
+    }
+    async mouseUp(session, button = "left", returnScreenshot = false) {
+        return this.executeRequest(session, {
+            action: computer_action_1.ComputerAction.MOUSE_UP,
+            button,
+            returnScreenshot,
+        });
+    }
+    async getClipboardText(session, returnScreenshot = false) {
+        return this.executeRequest(session, {
+            action: computer_action_1.ComputerAction.GET_CLIPBOARD_TEXT,
+            returnScreenshot,
+        });
+    }
 }
 exports.ComputerActionService = ComputerActionService;

package/dist/types/agents/browser-use.d.ts

@@ -1,5 +1,5 @@
 import { z } from "zod";
-import { BrowserUseLlm, BrowserUseTaskStatus } from "../constants";
+import { BrowserUseLlm, BrowserUseTaskStatus, BrowserUseVersion } from "../constants";
 import { CreateSessionParams } from "../session";
 export interface BrowserUseApiKeys {
     openai?: string;
@@ -8,6 +8,7 @@ export interface BrowserUseApiKeys {
 }
 export interface StartBrowserUseTaskParams {
     task: string;
+    version?: BrowserUseVersion;
     llm?: BrowserUseLlm;
     sessionId?: string;
     validateOutput?: boolean;
@@ -76,13 +77,56 @@ export interface BrowserUseAgentHistory {
     state: BrowserUseBrowserStateHistory;
     metadata?: BrowserUseStepMetadata | null;
 }
+export interface BrowserUseAgentOutputV0710 {
+    thinking?: string | null;
+    evaluation_previous_goal?: string | null;
+    memory?: string | null;
+    next_goal?: string | null;
+    action: Array<Record<string, unknown>>;
+}
+export interface BrowserUseActionResultV0710 {
+    is_done?: boolean | null;
+    success?: boolean | null;
+    error?: string | null;
+    metadata?: Record<string, unknown> | null;
+    attachments?: string[] | null;
+    long_term_memory?: string | null;
+    extracted_content?: string | null;
+    include_extracted_content_only_once?: boolean | null;
+    include_in_memory?: boolean | null;
+}
+export interface BrowserUseBrowserStateHistoryV0710 {
+    url: string;
+    title: string;
+    tabs: Array<Record<string, unknown>>;
+    interacted_element: Array<Record<string, unknown> | null>;
+}
+export interface BrowserUseStepMetadataV0710 {
+    step_start_time: number;
+    step_end_time: number;
+    step_number: number;
+}
+export interface BrowserUseAgentHistoryV0710 {
+    model_output: BrowserUseAgentOutputV0710 | null;
+    result: BrowserUseActionResultV0710[];
+    state: BrowserUseBrowserStateHistoryV0710;
+    metadata?: BrowserUseStepMetadataV0710 | null;
+}
+export type BrowserUseAgentHistoryLatest = Record<string, unknown>;
+export type BrowserUseStep = BrowserUseAgentHistory | BrowserUseAgentHistoryV0710 | BrowserUseAgentHistoryLatest;
 export interface BrowserUseTaskData {
-    steps: BrowserUseAgentHistory[];
+    steps: BrowserUseStep[];
     finalResult: string | null;
 }
+export interface BrowserUseTaskMetadata {
+    inputTokens?: number | null;
+    outputTokens?: number | null;
+    numTaskStepsCompleted?: number | null;
+}
 export interface BrowserUseTaskResponse {
     jobId: string;
     status: BrowserUseTaskStatus;
+    metadata?: BrowserUseTaskMetadata | null;
     data?: BrowserUseTaskData | null;
     error?: string | null;
     liveUrl: string | null;

package/dist/types/agents/claude-computer-use.d.ts

@@ -34,9 +34,15 @@ export interface ClaudeComputerUseTaskData {
     steps: ClaudeComputerUseStepResponse[];
     finalResult: string | null;
 }
+export interface ClaudeComputerUseTaskMetadata {
+    inputTokens?: number | null;
+    outputTokens?: number | null;
+    numTaskStepsCompleted?: number | null;
+}
 export interface ClaudeComputerUseTaskResponse {
     jobId: string;
     status: ClaudeComputerUseTaskStatus;
+    metadata?: ClaudeComputerUseTaskMetadata | null;
     data?: ClaudeComputerUseTaskData | null;
     error?: string | null;
     liveUrl: string | null;

package/dist/types/agents/cua.d.ts

@@ -46,9 +46,15 @@ export interface CuaTaskData {
     steps: CuaStepResponse[];
     finalResult: string | null;
 }
+export interface CuaTaskMetadata {
+    inputTokens?: number | null;
+    outputTokens?: number | null;
+    numTaskStepsCompleted?: number | null;
+}
 export interface CuaTaskResponse {
     jobId: string;
     status: CuaTaskStatus;
+    metadata?: CuaTaskMetadata | null;
     data?: CuaTaskData | null;
     error?: string | null;
     liveUrl: string | null;

package/dist/types/agents/gemini-computer-use.d.ts

@@ -30,9 +30,15 @@ export interface GeminiComputerUseTaskData {
     steps: GeminiComputerUseStepResponse[];
     finalResult: string | null;
 }
+export interface GeminiComputerUseTaskMetadata {
+    inputTokens?: number | null;
+    outputTokens?: number | null;
+    numTaskStepsCompleted?: number | null;
+}
 export interface GeminiComputerUseTaskResponse {
     jobId: string;
     status: GeminiComputerUseTaskStatus;
+    metadata?: GeminiComputerUseTaskMetadata | null;
     data?: GeminiComputerUseTaskData | null;
     error?: string | null;
     liveUrl: string | null;

package/dist/types/agents/hyper-agent.d.ts

@@ -44,9 +44,13 @@ export interface HyperAgentTaskData {
     steps: HyperAgentStep[];
     finalResult: string | null;
 }
+export interface HyperAgentTaskMetadata {
+    numTaskStepsCompleted?: number | null;
+}
 export interface HyperAgentTaskResponse {
     jobId: string;
     status: HyperAgentTaskStatus;
+    metadata?: HyperAgentTaskMetadata | null;
     data?: HyperAgentTaskData | null;
     error?: string | null;
     liveUrl: string | null;

package/dist/types/computer-action.d.ts

@@ -4,12 +4,17 @@
 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"
+    TYPE_TEXT = "type_text",
+    GET_CLIPBOARD_TEXT = "get_clipboard_text"
 }
+export type ComputerActionMouseButton = "left" | "right" | "middle" | "back" | "forward" | "wheel";
 /**
  * Coordinate model for drag actions
  */
@@ -22,9 +27,9 @@ export interface Coordinate {
  */
 export interface ClickActionParams {
     action: ComputerAction.CLICK;
-    x: number;
-    y: number;
-    button?: "left" | "right" | "middle" | "back" | "forward" | "wheel";
+    x?: number;
+    y?: number;
+    button?: ComputerActionMouseButton;
     numClicks?: number;
     returnScreenshot?: boolean;
 }
@@ -78,16 +83,50 @@ export interface TypeTextActionParams {
     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;
+}
 /**
  * Union type for all computer action parameters
  */
-export type ComputerActionParams = ClickActionParams | DragActionParams | PressKeysActionParams | MoveMouseActionParams | ScreenshotActionParams | ScrollActionParams | TypeTextActionParams;
+export type ComputerActionParams = ClickActionParams | DragActionParams | PressKeysActionParams | MoveMouseActionParams | ScreenshotActionParams | ScrollActionParams | TypeTextActionParams | HoldKeyActionParams | MouseDownActionParams | MouseUpActionParams | GetClipboardTextActionParams;
+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;
 }

package/dist/types/computer-action.js

@@ -8,9 +8,13 @@ var ComputerAction;
 (function (ComputerAction) {
     ComputerAction["CLICK"] = "click";
     ComputerAction["DRAG"] = "drag";
+    ComputerAction["HOLD_KEY"] = "hold_key";
+    ComputerAction["MOUSE_DOWN"] = "mouse_down";
+    ComputerAction["MOUSE_UP"] = "mouse_up";
     ComputerAction["PRESS_KEYS"] = "press_keys";
     ComputerAction["MOVE_MOUSE"] = "move_mouse";
     ComputerAction["SCREENSHOT"] = "screenshot";
     ComputerAction["SCROLL"] = "scroll";
     ComputerAction["TYPE_TEXT"] = "type_text";
+    ComputerAction["GET_CLIPBOARD_TEXT"] = "get_clipboard_text";
 })(ComputerAction || (exports.ComputerAction = ComputerAction = {}));

package/dist/types/constants.d.ts

@@ -15,6 +15,7 @@ export type ScrapeScreenshotFormat = "jpeg" | "png" | "webp";
 export type RecordingStatus = "not_enabled" | "pending" | "in_progress" | "completed" | "failed";
 export type DownloadsStatus = "not_enabled" | "pending" | "in_progress" | "completed" | "failed";
 export declare const POLLING_ATTEMPTS = 5;
+export type BrowserUseVersion = "0.1.40" | "0.7.10" | "latest";
 export type BrowserUseLlm = "gpt-4o" | "gpt-4o-mini" | "gpt-4.1" | "gpt-4.1-mini" | "gpt-5" | "gpt-5-mini" | "claude-sonnet-4-5" | "claude-sonnet-4-20250514" | "claude-3-7-sonnet-20250219" | "claude-3-5-sonnet-20241022" | "claude-3-5-haiku-20241022" | "gemini-2.0-flash" | "gemini-2.5-flash";
 export type ClaudeComputerUseLlm = "claude-haiku-4-5-20251001" | "claude-sonnet-4-5" | "claude-sonnet-4-20250514" | "claude-3-7-sonnet-20250219";
 export type HyperAgentLlm = "gpt-4o" | "gpt-4o-mini" | "gpt-4.1" | "gpt-4.1-mini" | "gpt-4.1-nano";

package/dist/types/extract.d.ts

@@ -16,9 +16,15 @@ export interface StartExtractJobResponse {
 export interface ExtractJobStatusResponse {
     status: ExtractJobStatus;
 }
+export interface ExtractJobMetadata {
+    inputTokens?: number | null;
+    outputTokens?: number | null;
+    numPagesScraped?: number | null;
+}
 export interface ExtractJobResponse {
     jobId: string;
     status: ExtractJobStatus;
+    metadata?: ExtractJobMetadata | null;
     data?: object;
     error?: string;
 }

package/dist/types/index.d.ts

@@ -1,15 +1,15 @@
 export { HyperbrowserConfig } from "./config";
 export { StartCrawlJobParams, StartCrawlJobResponse, CrawledPage, CrawlJobResponse, GetCrawlJobParams, CrawlJobStatusResponse, } from "./crawl";
-export { StartScrapeJobParams, StartScrapeJobResponse, ScrapeJobData, ScrapeJobResponse, ScrapeOptions, ScrapeJobStatusResponse, BatchScrapeJobStatusResponse, } from "./scrape";
-export { StartExtractJobParams, StartExtractJobResponse, ExtractJobResponse, ExtractJobStatusResponse, } from "./extract";
-export { StartBrowserUseTaskParams, StartBrowserUseTaskResponse, BrowserUseTaskStatusResponse, BrowserUseTaskResponse, BrowserUseTaskData, BrowserUseApiKeys, } from "./agents/browser-use";
-export { StartClaudeComputerUseTaskParams, StartClaudeComputerUseTaskResponse, ClaudeComputerUseTaskStatusResponse, ClaudeComputerUseTaskResponse, ClaudeComputerUseTaskData, ClaudeComputerUseStepResponse, ClaudeComputerUseApiKeys, } from "./agents/claude-computer-use";
-export { StartCuaTaskParams, StartCuaTaskResponse, CuaTaskStatusResponse, CuaTaskResponse, CuaTaskData, CuaStepResponse, CuaApiKeys, } from "./agents/cua";
-export { StartHyperAgentTaskParams, StartHyperAgentTaskResponse, HyperAgentTaskStatusResponse, HyperAgentTaskResponse, HyperAgentTaskData, HyperAgentStep, HyperAgentOutput, HyperAgentActionOutput, HyperAgentApiKeys, } from "./agents/hyper-agent";
-export { StartGeminiComputerUseTaskParams, StartGeminiComputerUseTaskResponse, GeminiComputerUseTaskStatusResponse, GeminiComputerUseTaskResponse, GeminiComputerUseTaskData, GeminiComputerUseStepResponse, GeminiComputerUseApiKeys, } from "./agents/gemini-computer-use";
+export { StartScrapeJobParams, StartScrapeJobResponse, ScrapeJobData, ScrapeJobResponse, ScrapeOptions, ScrapeJobStatusResponse, BatchScrapeJobStatusResponse, StorageStateOptions, } from "./scrape";
+export { StartExtractJobParams, StartExtractJobResponse, ExtractJobResponse, ExtractJobStatusResponse, ExtractJobMetadata, } from "./extract";
+export { StartBrowserUseTaskParams, StartBrowserUseTaskResponse, BrowserUseTaskStatusResponse, BrowserUseTaskResponse, BrowserUseTaskData, BrowserUseApiKeys, BrowserUseTaskMetadata, BrowserUseStep, BrowserUseAgentBrain, BrowserUseAgentOutput, BrowserUseActionResult, BrowserUseStepMetadata, BrowserUseTabInfo, BrowserUseBrowserStateHistory, BrowserUseAgentHistory, BrowserUseAgentOutputV0710, BrowserUseActionResultV0710, BrowserUseBrowserStateHistoryV0710, BrowserUseStepMetadataV0710, BrowserUseAgentHistoryV0710, BrowserUseAgentHistoryLatest, } from "./agents/browser-use";
+export { StartClaudeComputerUseTaskParams, StartClaudeComputerUseTaskResponse, ClaudeComputerUseTaskStatusResponse, ClaudeComputerUseTaskResponse, ClaudeComputerUseTaskData, ClaudeComputerUseStepResponse, ClaudeComputerUseApiKeys, ClaudeComputerUseTaskMetadata, } from "./agents/claude-computer-use";
+export { StartCuaTaskParams, StartCuaTaskResponse, CuaTaskStatusResponse, CuaTaskResponse, CuaTaskData, CuaStepResponse, CuaApiKeys, CuaTaskMetadata, } from "./agents/cua";
+export { StartHyperAgentTaskParams, StartHyperAgentTaskResponse, HyperAgentTaskStatusResponse, HyperAgentTaskResponse, HyperAgentTaskData, HyperAgentStep, HyperAgentOutput, HyperAgentActionOutput, HyperAgentApiKeys, HyperAgentTaskMetadata, } from "./agents/hyper-agent";
+export { StartGeminiComputerUseTaskParams, StartGeminiComputerUseTaskResponse, GeminiComputerUseTaskStatusResponse, GeminiComputerUseTaskResponse, GeminiComputerUseTaskData, GeminiComputerUseStepResponse, GeminiComputerUseApiKeys, GeminiComputerUseTaskMetadata, } from "./agents/gemini-computer-use";
 export { BasicResponse, SessionStatus, Session, SessionDetail, SessionListParams, SessionListResponse, ScreenConfig, CreateSessionParams, GetSessionDownloadsUrlResponse, GetSessionVideoRecordingUrlResponse, GetSessionRecordingUrlResponse, ImageCaptchaParam, UploadFileResponse, UploadFileOptions, GetActiveSessionsCountResponse, SessionEventLogListParams, SessionEventLogListResponse, SessionEventLog, SessionProfile, SessionLaunchState, } from "./session";
 export { CreateProfileParams, ProfileResponse, CreateProfileResponse, ProfileListParams, ProfileListResponse, } from "./profile";
 export { CreateExtensionParams, CreateExtensionResponse, ListExtensionsResponse, } from "./extension";
-export { ExtractJobStatus, BrowserUseTaskStatus, BrowserUseLlm, ClaudeComputerUseLlm, GeminiComputerUseLlm, ScrapeScreenshotFormat, ScrapeJobStatus, CrawlJobStatus, Country, State, ISO639_1, OperatingSystem, Platform, ScrapeFormat, ScrapeWaitUntil, ScrapePageStatus, CrawlPageStatus, RecordingStatus, DownloadsStatus, HyperAgentLlm, HyperAgentTaskStatus, ClaudeComputerUseTaskStatus, CuaTaskStatus, GeminiComputerUseTaskStatus, SessionEventLogType, SessionRegion, } from "./constants";
+export { ExtractJobStatus, BrowserUseTaskStatus, BrowserUseLlm, ClaudeComputerUseLlm, GeminiComputerUseLlm, ScrapeScreenshotFormat, ScrapeJobStatus, CrawlJobStatus, Country, State, ISO639_1, OperatingSystem, Platform, ScrapeFormat, ScrapeWaitUntil, ScrapePageStatus, CrawlPageStatus, RecordingStatus, DownloadsStatus, HyperAgentLlm, HyperAgentTaskStatus, ClaudeComputerUseTaskStatus, CuaTaskStatus, GeminiComputerUseTaskStatus, SessionEventLogType, SessionRegion, BrowserUseVersion, } from "./constants";
 export { TeamCreditInfo } from "./team";
-export { ComputerAction, Coordinate, ClickActionParams, DragActionParams, PressKeysActionParams, MoveMouseActionParams, ScreenshotActionParams, ScrollActionParams, TypeTextActionParams, ComputerActionParams, ComputerActionResponse, } from "./computer-action";
+export { ComputerAction, Coordinate, ClickActionParams, DragActionParams, PressKeysActionParams, MoveMouseActionParams, ScreenshotActionParams, ScrollActionParams, TypeTextActionParams, ComputerActionParams, ComputerActionResponse, ComputerActionMouseButton, ComputerActionResponseData, HoldKeyActionParams, MouseDownActionParams, MouseUpActionParams, GetClipboardTextActionParams, ComputerActionResponseDataClipboardText, } from "./computer-action";

package/dist/types/scrape.d.ts

@@ -4,6 +4,10 @@ export interface ScreenshotOptions {
     fullPage?: boolean;
     format?: ScrapeScreenshotFormat;
 }
+export interface StorageStateOptions {
+    localStorage?: Record<string, string>;
+    sessionStorage?: Record<string, string>;
+}
 export interface ScrapeOptions {
     formats?: ScrapeFormat[];
     includeTags?: string[];
@@ -13,6 +17,7 @@ export interface ScrapeOptions {
     timeout?: number;
     waitUntil?: ScrapeWaitUntil;
     screenshotOptions?: ScreenshotOptions;
+    storageState?: StorageStateOptions;
 }
 export interface StartScrapeJobParams {
     url: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperbrowser/sdk",
-  "version": "0.68.0",
+  "version": "0.70.0",
   "description": "Node SDK for Hyperbrowser API",
   "author": "",
   "main": "dist/index.js",