@hyperbrowser/sdk 0.69.0 → 0.71.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
1
  import { z } from "zod";
2
- import { BrowserUseLlm, BrowserUseTaskStatus } from "../constants";
2
+ import { BrowserUseLlm, BrowserUseTaskStatus, BrowserUseVersion } from "../constants";
3
3
  import { CreateSessionParams } from "../session";
4
4
  export interface BrowserUseApiKeys {
5
5
  openai?: string;
@@ -8,6 +8,7 @@ export interface BrowserUseApiKeys {
8
8
  }
9
9
  export interface StartBrowserUseTaskParams {
10
10
  task: string;
11
+ version?: BrowserUseVersion;
11
12
  llm?: BrowserUseLlm;
12
13
  sessionId?: string;
13
14
  validateOutput?: boolean;
@@ -76,13 +77,56 @@ export interface BrowserUseAgentHistory {
76
77
  state: BrowserUseBrowserStateHistory;
77
78
  metadata?: BrowserUseStepMetadata | null;
78
79
  }
80
+ export interface BrowserUseAgentOutputV0710 {
81
+ thinking?: string | null;
82
+ evaluation_previous_goal?: string | null;
83
+ memory?: string | null;
84
+ next_goal?: string | null;
85
+ action: Array<Record<string, unknown>>;
86
+ }
87
+ export interface BrowserUseActionResultV0710 {
88
+ is_done?: boolean | null;
89
+ success?: boolean | null;
90
+ error?: string | null;
91
+ metadata?: Record<string, unknown> | null;
92
+ attachments?: string[] | null;
93
+ long_term_memory?: string | null;
94
+ extracted_content?: string | null;
95
+ include_extracted_content_only_once?: boolean | null;
96
+ include_in_memory?: boolean | null;
97
+ }
98
+ export interface BrowserUseBrowserStateHistoryV0710 {
99
+ url: string;
100
+ title: string;
101
+ tabs: Array<Record<string, unknown>>;
102
+ interacted_element: Array<Record<string, unknown> | null>;
103
+ }
104
+ export interface BrowserUseStepMetadataV0710 {
105
+ step_start_time: number;
106
+ step_end_time: number;
107
+ step_number: number;
108
+ }
109
+ export interface BrowserUseAgentHistoryV0710 {
110
+ model_output: BrowserUseAgentOutputV0710 | null;
111
+ result: BrowserUseActionResultV0710[];
112
+ state: BrowserUseBrowserStateHistoryV0710;
113
+ metadata?: BrowserUseStepMetadataV0710 | null;
114
+ }
115
+ export type BrowserUseAgentHistoryLatest = Record<string, unknown>;
116
+ export type BrowserUseStep = BrowserUseAgentHistory | BrowserUseAgentHistoryV0710 | BrowserUseAgentHistoryLatest;
79
117
  export interface BrowserUseTaskData {
80
- steps: BrowserUseAgentHistory[];
118
+ steps: BrowserUseStep[];
81
119
  finalResult: string | null;
82
120
  }
121
+ export interface BrowserUseTaskMetadata {
122
+ inputTokens?: number | null;
123
+ outputTokens?: number | null;
124
+ numTaskStepsCompleted?: number | null;
125
+ }
83
126
  export interface BrowserUseTaskResponse {
84
127
  jobId: string;
85
128
  status: BrowserUseTaskStatus;
129
+ metadata?: BrowserUseTaskMetadata | null;
86
130
  data?: BrowserUseTaskData | null;
87
131
  error?: string | null;
88
132
  liveUrl: string | null;
@@ -34,9 +34,15 @@ export interface ClaudeComputerUseTaskData {
34
34
  steps: ClaudeComputerUseStepResponse[];
35
35
  finalResult: string | null;
36
36
  }
37
+ export interface ClaudeComputerUseTaskMetadata {
38
+ inputTokens?: number | null;
39
+ outputTokens?: number | null;
40
+ numTaskStepsCompleted?: number | null;
41
+ }
37
42
  export interface ClaudeComputerUseTaskResponse {
38
43
  jobId: string;
39
44
  status: ClaudeComputerUseTaskStatus;
45
+ metadata?: ClaudeComputerUseTaskMetadata | null;
40
46
  data?: ClaudeComputerUseTaskData | null;
41
47
  error?: string | null;
42
48
  liveUrl: string | null;
@@ -46,9 +46,15 @@ export interface CuaTaskData {
46
46
  steps: CuaStepResponse[];
47
47
  finalResult: string | null;
48
48
  }
49
+ export interface CuaTaskMetadata {
50
+ inputTokens?: number | null;
51
+ outputTokens?: number | null;
52
+ numTaskStepsCompleted?: number | null;
53
+ }
49
54
  export interface CuaTaskResponse {
50
55
  jobId: string;
51
56
  status: CuaTaskStatus;
57
+ metadata?: CuaTaskMetadata | null;
52
58
  data?: CuaTaskData | null;
53
59
  error?: string | null;
54
60
  liveUrl: string | null;
@@ -30,9 +30,15 @@ export interface GeminiComputerUseTaskData {
30
30
  steps: GeminiComputerUseStepResponse[];
31
31
  finalResult: string | null;
32
32
  }
33
+ export interface GeminiComputerUseTaskMetadata {
34
+ inputTokens?: number | null;
35
+ outputTokens?: number | null;
36
+ numTaskStepsCompleted?: number | null;
37
+ }
33
38
  export interface GeminiComputerUseTaskResponse {
34
39
  jobId: string;
35
40
  status: GeminiComputerUseTaskStatus;
41
+ metadata?: GeminiComputerUseTaskMetadata | null;
36
42
  data?: GeminiComputerUseTaskData | null;
37
43
  error?: string | null;
38
44
  liveUrl: string | null;
@@ -44,9 +44,13 @@ export interface HyperAgentTaskData {
44
44
  steps: HyperAgentStep[];
45
45
  finalResult: string | null;
46
46
  }
47
+ export interface HyperAgentTaskMetadata {
48
+ numTaskStepsCompleted?: number | null;
49
+ }
47
50
  export interface HyperAgentTaskResponse {
48
51
  jobId: string;
49
52
  status: HyperAgentTaskStatus;
53
+ metadata?: HyperAgentTaskMetadata | null;
50
54
  data?: HyperAgentTaskData | null;
51
55
  error?: string | null;
52
56
  liveUrl: string | null;
@@ -15,6 +15,7 @@ export type ScrapeScreenshotFormat = "jpeg" | "png" | "webp";
15
15
  export type RecordingStatus = "not_enabled" | "pending" | "in_progress" | "completed" | "failed";
16
16
  export type DownloadsStatus = "not_enabled" | "pending" | "in_progress" | "completed" | "failed";
17
17
  export declare const POLLING_ATTEMPTS = 5;
18
+ export type BrowserUseVersion = "0.1.40" | "0.7.10" | "latest";
18
19
  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";
19
20
  export type ClaudeComputerUseLlm = "claude-haiku-4-5-20251001" | "claude-sonnet-4-5" | "claude-sonnet-4-20250514" | "claude-3-7-sonnet-20250219";
20
21
  export type HyperAgentLlm = "gpt-4o" | "gpt-4o-mini" | "gpt-4.1" | "gpt-4.1-mini" | "gpt-4.1-nano";
@@ -16,9 +16,15 @@ export interface StartExtractJobResponse {
16
16
  export interface ExtractJobStatusResponse {
17
17
  status: ExtractJobStatus;
18
18
  }
19
+ export interface ExtractJobMetadata {
20
+ inputTokens?: number | null;
21
+ outputTokens?: number | null;
22
+ numPagesScraped?: number | null;
23
+ }
19
24
  export interface ExtractJobResponse {
20
25
  jobId: string;
21
26
  status: ExtractJobStatus;
27
+ metadata?: ExtractJobMetadata | null;
22
28
  data?: object;
23
29
  error?: string;
24
30
  }
@@ -1,15 +1,15 @@
1
1
  export { HyperbrowserConfig } from "./config";
2
2
  export { StartCrawlJobParams, StartCrawlJobResponse, CrawledPage, CrawlJobResponse, GetCrawlJobParams, CrawlJobStatusResponse, } from "./crawl";
3
- export { StartScrapeJobParams, StartScrapeJobResponse, ScrapeJobData, ScrapeJobResponse, ScrapeOptions, ScrapeJobStatusResponse, BatchScrapeJobStatusResponse, } from "./scrape";
4
- export { StartExtractJobParams, StartExtractJobResponse, ExtractJobResponse, ExtractJobStatusResponse, } from "./extract";
5
- export { StartBrowserUseTaskParams, StartBrowserUseTaskResponse, BrowserUseTaskStatusResponse, BrowserUseTaskResponse, BrowserUseTaskData, BrowserUseApiKeys, } from "./agents/browser-use";
6
- export { StartClaudeComputerUseTaskParams, StartClaudeComputerUseTaskResponse, ClaudeComputerUseTaskStatusResponse, ClaudeComputerUseTaskResponse, ClaudeComputerUseTaskData, ClaudeComputerUseStepResponse, ClaudeComputerUseApiKeys, } from "./agents/claude-computer-use";
7
- export { StartCuaTaskParams, StartCuaTaskResponse, CuaTaskStatusResponse, CuaTaskResponse, CuaTaskData, CuaStepResponse, CuaApiKeys, } from "./agents/cua";
8
- export { StartHyperAgentTaskParams, StartHyperAgentTaskResponse, HyperAgentTaskStatusResponse, HyperAgentTaskResponse, HyperAgentTaskData, HyperAgentStep, HyperAgentOutput, HyperAgentActionOutput, HyperAgentApiKeys, } from "./agents/hyper-agent";
9
- export { StartGeminiComputerUseTaskParams, StartGeminiComputerUseTaskResponse, GeminiComputerUseTaskStatusResponse, GeminiComputerUseTaskResponse, GeminiComputerUseTaskData, GeminiComputerUseStepResponse, GeminiComputerUseApiKeys, } from "./agents/gemini-computer-use";
3
+ export { StartScrapeJobParams, StartScrapeJobResponse, ScrapeJobData, ScrapeJobResponse, ScrapeOptions, ScrapeJobStatusResponse, BatchScrapeJobStatusResponse, StorageStateOptions, } from "./scrape";
4
+ export { StartExtractJobParams, StartExtractJobResponse, ExtractJobResponse, ExtractJobStatusResponse, ExtractJobMetadata, } from "./extract";
5
+ 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";
6
+ export { StartClaudeComputerUseTaskParams, StartClaudeComputerUseTaskResponse, ClaudeComputerUseTaskStatusResponse, ClaudeComputerUseTaskResponse, ClaudeComputerUseTaskData, ClaudeComputerUseStepResponse, ClaudeComputerUseApiKeys, ClaudeComputerUseTaskMetadata, } from "./agents/claude-computer-use";
7
+ export { StartCuaTaskParams, StartCuaTaskResponse, CuaTaskStatusResponse, CuaTaskResponse, CuaTaskData, CuaStepResponse, CuaApiKeys, CuaTaskMetadata, } from "./agents/cua";
8
+ export { StartHyperAgentTaskParams, StartHyperAgentTaskResponse, HyperAgentTaskStatusResponse, HyperAgentTaskResponse, HyperAgentTaskData, HyperAgentStep, HyperAgentOutput, HyperAgentActionOutput, HyperAgentApiKeys, HyperAgentTaskMetadata, } from "./agents/hyper-agent";
9
+ export { StartGeminiComputerUseTaskParams, StartGeminiComputerUseTaskResponse, GeminiComputerUseTaskStatusResponse, GeminiComputerUseTaskResponse, GeminiComputerUseTaskData, GeminiComputerUseStepResponse, GeminiComputerUseApiKeys, GeminiComputerUseTaskMetadata, } from "./agents/gemini-computer-use";
10
10
  export { BasicResponse, SessionStatus, Session, SessionDetail, SessionListParams, SessionListResponse, ScreenConfig, CreateSessionParams, GetSessionDownloadsUrlResponse, GetSessionVideoRecordingUrlResponse, GetSessionRecordingUrlResponse, ImageCaptchaParam, UploadFileResponse, UploadFileOptions, GetActiveSessionsCountResponse, SessionEventLogListParams, SessionEventLogListResponse, SessionEventLog, SessionProfile, SessionLaunchState, } from "./session";
11
11
  export { CreateProfileParams, ProfileResponse, CreateProfileResponse, ProfileListParams, ProfileListResponse, } from "./profile";
12
12
  export { CreateExtensionParams, CreateExtensionResponse, ListExtensionsResponse, } from "./extension";
13
- 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";
13
+ 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";
14
14
  export { TeamCreditInfo } from "./team";
15
15
  export { ComputerAction, Coordinate, ClickActionParams, DragActionParams, PressKeysActionParams, MoveMouseActionParams, ScreenshotActionParams, ScrollActionParams, TypeTextActionParams, ComputerActionParams, ComputerActionResponse, ComputerActionMouseButton, ComputerActionResponseData, HoldKeyActionParams, MouseDownActionParams, MouseUpActionParams, GetClipboardTextActionParams, ComputerActionResponseDataClipboardText, } from "./computer-action";
@@ -4,6 +4,10 @@ export interface ScreenshotOptions {
4
4
  fullPage?: boolean;
5
5
  format?: ScrapeScreenshotFormat;
6
6
  }
7
+ export interface StorageStateOptions {
8
+ localStorage?: Record<string, string>;
9
+ sessionStorage?: Record<string, string>;
10
+ }
7
11
  export interface ScrapeOptions {
8
12
  formats?: ScrapeFormat[];
9
13
  includeTags?: string[];
@@ -13,6 +17,7 @@ export interface ScrapeOptions {
13
17
  timeout?: number;
14
18
  waitUntil?: ScrapeWaitUntil;
15
19
  screenshotOptions?: ScreenshotOptions;
20
+ storageState?: StorageStateOptions;
16
21
  }
17
22
  export interface StartScrapeJobParams {
18
23
  url: string;
@@ -40,6 +40,7 @@ export interface Session {
40
40
  updatedAt: string;
41
41
  sessionUrl: string;
42
42
  launchState?: SessionLaunchState | null;
43
+ creditsUsed: number | null;
43
44
  }
44
45
  export interface SessionDetail extends Session {
45
46
  wsEndpoint: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hyperbrowser/sdk",
3
- "version": "0.69.0",
3
+ "version": "0.71.0",
4
4
  "description": "Node SDK for Hyperbrowser API",
5
5
  "author": "",
6
6
  "main": "dist/index.js",