@hyperbrowser/sdk 0.30.0 → 0.32.0

package/dist/client.d.ts

@@ -5,6 +5,7 @@ import { CrawlService } from "./services/crawl";
 import { ProfilesService } from "./services/profiles";
 import { ExtensionService } from "./services/extensions";
 import { ExtractService } from "./services/extract";
+import { BrowserUseService } from "./services/beta/agents/browser-use";
 export declare class HyperbrowserError extends Error {
     statusCode?: number | undefined;
     constructor(message: string, statusCode?: number | undefined);
@@ -16,5 +17,10 @@ export declare class HyperbrowserClient {
     readonly extract: ExtractService;
     readonly profiles: ProfilesService;
     readonly extensions: ExtensionService;
+    readonly beta: {
+        agents: {
+            browserUse: BrowserUseService;
+        };
+    };
     constructor(config: HyperbrowserConfig);
 }

package/dist/client.js

@@ -7,6 +7,7 @@ const crawl_1 = require("./services/crawl");
 const profiles_1 = require("./services/profiles");
 const extensions_1 = require("./services/extensions");
 const extract_1 = require("./services/extract");
+const browser_use_1 = require("./services/beta/agents/browser-use");
 class HyperbrowserError extends Error {
     constructor(message, statusCode) {
         super(`[Hyperbrowser]: ${message}`);
@@ -29,6 +30,11 @@ class HyperbrowserClient {
         this.extract = new extract_1.ExtractService(apiKey, baseUrl, timeout);
         this.profiles = new profiles_1.ProfilesService(apiKey, baseUrl, timeout);
         this.extensions = new extensions_1.ExtensionService(apiKey, baseUrl, timeout);
+        this.beta = {
+            agents: {
+                browserUse: new browser_use_1.BrowserUseService(apiKey, baseUrl, timeout),
+            },
+        };
     }
 }
 exports.HyperbrowserClient = HyperbrowserClient;

package/dist/services/beta/agents/browser-use.d.ts

@@ -0,0 +1,30 @@
+import { BasicResponse } from "../../../types";
+import { StartBrowserUseTaskParams, StartBrowserUseTaskResponse, BrowserUseTaskResponse, BrowserUseTaskStatusResponse } from "../../../types/beta/agents/browser-use";
+import { BaseService } from "../../base";
+export declare class BrowserUseService extends BaseService {
+    /**
+     * Start a new browser-use task job
+     * @param params The parameters for the task job
+     */
+    start(params: StartBrowserUseTaskParams): Promise<StartBrowserUseTaskResponse>;
+    /**
+     * Get the status of a browser-use task job
+     * @param id The ID of the task job to get
+     */
+    getStatus(id: string): Promise<BrowserUseTaskStatusResponse>;
+    /**
+     * Get the result of a task job
+     * @param id The ID of the task job to get
+     */
+    get(id: string): Promise<BrowserUseTaskResponse>;
+    /**
+     * Stop a task job
+     * @param id The ID of the task job to stop
+     */
+    stop(id: string): Promise<BasicResponse>;
+    /**
+     * Start a browser-use task job and wait for it to complete
+     * @param params The parameters for the task job
+     */
+    startAndWait(params: StartBrowserUseTaskParams): Promise<BrowserUseTaskResponse>;
+}

package/dist/services/beta/agents/browser-use.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrowserUseService = void 0;
+const client_1 = require("../../../client");
+const constants_1 = require("../../../types/constants");
+const utils_1 = require("../../../utils");
+const base_1 = require("../../base");
+class BrowserUseService extends base_1.BaseService {
+    /**
+     * Start a new browser-use task job
+     * @param params The parameters for the task job
+     */
+    async start(params) {
+        try {
+            return await this.request("/task/browser-use", {
+                method: "POST",
+                body: JSON.stringify(params),
+            });
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError("Failed to start browser-use task job", undefined);
+        }
+    }
+    /**
+     * Get the status of a browser-use task job
+     * @param id The ID of the task job to get
+     */
+    async getStatus(id) {
+        try {
+            return await this.request(`/task/browser-use/${id}/status`);
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to get browser-use task job ${id} status`, undefined);
+        }
+    }
+    /**
+     * Get the result of a task job
+     * @param id The ID of the task job to get
+     */
+    async get(id) {
+        try {
+            return await this.request(`/task/browser-use/${id}`);
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to get browser-use task job ${id}`, undefined);
+        }
+    }
+    /**
+     * Stop a task job
+     * @param id The ID of the task job to stop
+     */
+    async stop(id) {
+        try {
+            return await this.request(`/task/browser-use/${id}/stop`, { method: "PUT" });
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to stop browser-use task job ${id}`, undefined);
+        }
+    }
+    /**
+     * Start a browser-use task job and wait for it to complete
+     * @param params The parameters for the task job
+     */
+    async startAndWait(params) {
+        const job = await this.start(params);
+        const jobId = job.jobId;
+        if (!jobId) {
+            throw new client_1.HyperbrowserError("Failed to start browser-use task job, could not get job ID");
+        }
+        let failures = 0;
+        while (true) {
+            try {
+                const { status } = await this.getStatus(jobId);
+                if (status === "completed" || status === "failed" || status === "stopped") {
+                    return await this.get(jobId);
+                }
+                failures = 0;
+            }
+            catch (error) {
+                failures++;
+                if (failures >= constants_1.POLLING_ATTEMPTS) {
+                    throw new client_1.HyperbrowserError(`Failed to poll browser-use task job ${jobId} after ${constants_1.POLLING_ATTEMPTS} attempts: ${error}`);
+                }
+            }
+            await (0, utils_1.sleep)(2000);
+        }
+    }
+}
+exports.BrowserUseService = BrowserUseService;

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

@@ -0,0 +1,73 @@
+import { BrowserUseLlm, BrowserUseTaskStatus } from "../../constants";
+import { CreateSessionParams } from "../../session";
+export interface StartBrowserUseTaskParams {
+    task: string;
+    llm?: BrowserUseLlm;
+    sessionId?: string;
+    validateOutput?: boolean;
+    useVision?: boolean;
+    useVisionForPlanner?: boolean;
+    maxActionsPerStep?: number;
+    maxInputTokens?: number;
+    plannerLlm?: BrowserUseLlm;
+    pageExtractionLlm?: BrowserUseLlm;
+    plannerInterval?: number;
+    maxSteps?: number;
+    keepBrowserOpen?: boolean;
+    sessionOptions?: CreateSessionParams;
+}
+export interface StartBrowserUseTaskResponse {
+    jobId: string;
+}
+export interface BrowserUseTaskStatusResponse {
+    status: BrowserUseTaskStatus;
+}
+export interface BrowserUseAgentBrain {
+    evaluation_previous_goal: string;
+    memory: string;
+    next_goal: string;
+}
+export interface BrowserUseAgentOutput {
+    current_state: BrowserUseAgentBrain;
+    action: object[];
+}
+export interface BrowserUseActionResult {
+    is_done?: boolean | null;
+    success?: boolean | null;
+    extracted_content?: string | null;
+    error?: string | null;
+    include_in_memory?: boolean | null;
+}
+export interface BrowserUseStepMetadata {
+    step_start_time: number;
+    step_end_time: number;
+    input_tokens: number;
+    step_number: number;
+}
+export interface BrowserUseTabInfo {
+    page_id: number;
+    url: string;
+    title: string;
+}
+export interface BrowserUseBrowserStateHistory {
+    url: string;
+    title: string;
+    tabs: BrowserUseTabInfo[];
+    interacted_element: (object | null)[] | null[];
+    screenshot?: string | null;
+}
+export interface BrowserUseAgentHistory {
+    model_output: BrowserUseAgentOutput | null;
+    result: BrowserUseActionResult[];
+    state: BrowserUseBrowserStateHistory;
+    metadata?: BrowserUseStepMetadata | null;
+}
+export interface BrowserUseTaskData {
+    history: BrowserUseAgentHistory[];
+}
+export interface BrowserUseTaskResponse {
+    jobId: string;
+    status: BrowserUseTaskStatus;
+    data?: BrowserUseTaskData | null;
+    error?: string | null;
+}

package/dist/types/beta/agents/browser-use.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/constants.d.ts

@@ -2,11 +2,13 @@ export type ScrapeFormat = "markdown" | "html" | "links" | "screenshot";
 export type ScrapeJobStatus = "pending" | "running" | "completed" | "failed";
 export type ExtractJobStatus = "pending" | "running" | "completed" | "failed";
 export type CrawlJobStatus = "pending" | "running" | "completed" | "failed";
+export type BrowserUseTaskStatus = "pending" | "running" | "completed" | "failed" | "stopped";
 export type ScrapePageStatus = "completed" | "failed" | "pending" | "running";
 export type CrawlPageStatus = "completed" | "failed";
 export type ScrapeWaitUntil = "load" | "domcontentloaded" | "networkidle";
 export type ScrapeScreenshotFormat = "jpeg" | "png" | "webp";
 export declare const POLLING_ATTEMPTS = 5;
+export type BrowserUseLlm = "gpt-4o" | "gpt-4o-mini" | "claude-3-7-sonnet-20250219" | "claude-3-5-sonnet-20241022" | "claude-3-5-haiku-20241022" | "gemini-2.0-flash";
 export type Country = "AD" | "AE" | "AF" | "AL" | "AM" | "AO" | "AR" | "AT" | "AU" | "AW" | "AZ" | "BA" | "BD" | "BE" | "BG" | "BH" | "BJ" | "BO" | "BR" | "BS" | "BT" | "BY" | "BZ" | "CA" | "CF" | "CH" | "CI" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "EC" | "EE" | "EG" | "ES" | "ET" | "EU" | "FI" | "FJ" | "FR" | "GB" | "GE" | "GH" | "GM" | "GR" | "HK" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IN" | "IQ" | "IR" | "IS" | "IT" | "JM" | "JO" | "JP" | "KE" | "KH" | "KR" | "KW" | "KZ" | "LB" | "LI" | "LR" | "LT" | "LU" | "LV" | "MA" | "MC" | "MD" | "ME" | "MG" | "MK" | "ML" | "MM" | "MN" | "MR" | "MT" | "MU" | "MV" | "MX" | "MY" | "MZ" | "NG" | "NL" | "NO" | "NZ" | "OM" | "PA" | "PE" | "PH" | "PK" | "PL" | "PR" | "PT" | "PY" | "QA" | "RANDOM_COUNTRY" | "RO" | "RS" | "RU" | "SA" | "SC" | "SD" | "SE" | "SG" | "SI" | "SK" | "SN" | "SS" | "TD" | "TG" | "TH" | "TM" | "TN" | "TR" | "TT" | "TW" | "UA" | "UG" | "US" | "UY" | "UZ" | "VE" | "VG" | "VN" | "YE" | "ZA" | "ZM" | "ZW" | "ad" | "ae" | "af" | "al" | "am" | "ao" | "ar" | "at" | "au" | "aw" | "az" | "ba" | "bd" | "be" | "bg" | "bh" | "bj" | "bo" | "br" | "bs" | "bt" | "by" | "bz" | "ca" | "cf" | "ch" | "ci" | "cl" | "cm" | "cn" | "co" | "cr" | "cu" | "cy" | "cz" | "de" | "dj" | "dk" | "dm" | "ec" | "ee" | "eg" | "es" | "et" | "eu" | "fi" | "fj" | "fr" | "gb" | "ge" | "gh" | "gm" | "gr" | "hk" | "hn" | "hr" | "ht" | "hu" | "id" | "ie" | "il" | "in" | "iq" | "ir" | "is" | "it" | "jm" | "jo" | "jp" | "ke" | "kh" | "kr" | "kw" | "kz" | "lb" | "li" | "lr" | "lt" | "lu" | "lv" | "ma" | "mc" | "md" | "me" | "mg" | "mk" | "ml" | "mm" | "mn" | "mr" | "mt" | "mu" | "mv" | "mx" | "my" | "mz" | "ng" | "nl" | "no" | "nz" | "om" | "pa" | "pe" | "ph" | "pk" | "pl" | "pr" | "pt" | "py" | "qa" | "ro" | "rs" | "ru" | "sa" | "sc" | "sd" | "se" | "sg" | "si" | "sk" | "sn" | "ss" | "td" | "tg" | "th" | "tm" | "tn" | "tr" | "tt" | "tw" | "ua" | "ug" | "us" | "uy" | "uz" | "ve" | "vg" | "vn" | "ye" | "za" | "zm" | "zw";
 export type OperatingSystem = "windows" | "android" | "macos" | "linux" | "ios";
 export type Platform = "chrome" | "firefox" | "safari" | "edge";

package/package.json

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