@hyperbrowser/sdk 0.35.0 → 0.37.0

package/dist/client.d.ts

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

package/dist/client.js

@@ -8,6 +8,7 @@ const profiles_1 = require("./services/profiles");
 const extensions_1 = require("./services/extensions");
 const extract_1 = require("./services/extract");
 const browser_use_1 = require("./services/agents/browser-use");
+const cua_1 = require("./services/agents/cua");
 class HyperbrowserError extends Error {
     constructor(message, statusCode) {
         super(`[Hyperbrowser]: ${message}`);
@@ -32,6 +33,7 @@ class HyperbrowserClient {
         this.extensions = new extensions_1.ExtensionService(apiKey, baseUrl, timeout);
         this.agents = {
             browserUse: new browser_use_1.BrowserUseService(apiKey, baseUrl, timeout),
+            cua: new cua_1.CuaService(apiKey, baseUrl, timeout),
         };
     }
 }

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

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

package/dist/services/agents/cua.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CuaService = void 0;
+const client_1 = require("../../client");
+const constants_1 = require("../../types/constants");
+const utils_1 = require("../../utils");
+const base_1 = require("../base");
+class CuaService extends base_1.BaseService {
+    /**
+     * Start a new CUA task job
+     * @param params The parameters for the task job
+     */
+    async start(params) {
+        try {
+            return await this.request("/task/cua", {
+                method: "POST",
+                body: JSON.stringify(params),
+            });
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError("Failed to start CUA task job", undefined);
+        }
+    }
+    /**
+     * Get the status of a CUA task job
+     * @param id The ID of the task job to get
+     */
+    async getStatus(id) {
+        try {
+            return await this.request(`/task/cua/${id}/status`);
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to get CUA task job ${id} status`, undefined);
+        }
+    }
+    /**
+     * Get the result of a CUA task job
+     * @param id The ID of the task job to get
+     */
+    async get(id) {
+        try {
+            return await this.request(`/task/cua/${id}`);
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to get CUA task job ${id}`, undefined);
+        }
+    }
+    /**
+     * Stop a CUA task job
+     * @param id The ID of the task job to stop
+     */
+    async stop(id) {
+        try {
+            return await this.request(`/task/cua/${id}/stop`, { method: "PUT" });
+        }
+        catch (error) {
+            if (error instanceof client_1.HyperbrowserError) {
+                throw error;
+            }
+            throw new client_1.HyperbrowserError(`Failed to stop CUA task job ${id}`, undefined);
+        }
+    }
+    /**
+     * Start a CUA 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 CUA 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 CUA task job ${jobId} after ${constants_1.POLLING_ATTEMPTS} attempts: ${error}`);
+                }
+            }
+            await (0, utils_1.sleep)(2000);
+        }
+    }
+}
+exports.CuaService = CuaService;

package/dist/tools/anthropic.d.ts

@@ -32,6 +32,7 @@ export interface Tool {
     description?: string;
 }
 export declare const SCRAPE_TOOL_ANTHROPIC: Tool;
+export declare const SCREENSHOT_TOOL_ANTHROPIC: Tool;
 export declare const CRAWL_TOOL_ANTHROPIC: Tool;
 export declare const EXTRACT_TOOL_ANTHROPIC: Tool;
 export declare const BROWSER_USE_TOOL_ANTHROPIC: Tool;

package/dist/tools/anthropic.js

@@ -1,12 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BROWSER_USE_TOOL_ANTHROPIC = exports.EXTRACT_TOOL_ANTHROPIC = exports.CRAWL_TOOL_ANTHROPIC = exports.SCRAPE_TOOL_ANTHROPIC = void 0;
+exports.BROWSER_USE_TOOL_ANTHROPIC = exports.EXTRACT_TOOL_ANTHROPIC = exports.CRAWL_TOOL_ANTHROPIC = exports.SCREENSHOT_TOOL_ANTHROPIC = exports.SCRAPE_TOOL_ANTHROPIC = void 0;
 const schema_1 = require("./schema");
 exports.SCRAPE_TOOL_ANTHROPIC = {
     input_schema: schema_1.SCRAPE_SCHEMA,
     name: "scrape_webpage",
     description: "Scrape content from a webpage and return the content in markdown format",
 };
+exports.SCREENSHOT_TOOL_ANTHROPIC = {
+    name: "screenshot_webpage",
+    description: "Take a screenshot of a webpage and return the screenshot in screenshot format as a url",
+    input_schema: schema_1.SCREENSHOT_SCHEMA,
+};
 exports.CRAWL_TOOL_ANTHROPIC = {
     input_schema: schema_1.CRAWL_SCHEMA,
     name: "crawl_website",

package/dist/tools/index.d.ts

@@ -6,6 +6,11 @@ export declare class WebsiteScrapeTool {
     static anthropicToolDefinition: import("./anthropic").Tool;
     static runnable(hb: HyperbrowserClient, params: StartScrapeJobParams): Promise<string>;
 }
+export declare class WebsiteScreenshotTool {
+    static openaiToolDefinition: import("./openai").ChatCompletionTool;
+    static anthropicToolDefinition: import("./anthropic").Tool;
+    static runnable(hb: HyperbrowserClient, params: StartScrapeJobParams): Promise<string>;
+}
 export declare class WebsiteCrawlTool {
     static openaiToolDefinition: import("./openai").ChatCompletionTool;
     static anthropicToolDefinition: import("./anthropic").Tool;

package/dist/tools/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BrowserUseTool = exports.WebsiteExtractTool = exports.WebsiteCrawlTool = exports.WebsiteScrapeTool = void 0;
+exports.BrowserUseTool = exports.WebsiteExtractTool = exports.WebsiteCrawlTool = exports.WebsiteScreenshotTool = exports.WebsiteScrapeTool = void 0;
 const openai_1 = require("./openai");
 const anthropic_1 = require("./anthropic");
 class WebsiteScrapeTool {
@@ -12,6 +12,15 @@ class WebsiteScrapeTool {
 exports.WebsiteScrapeTool = WebsiteScrapeTool;
 WebsiteScrapeTool.openaiToolDefinition = openai_1.SCRAPE_TOOL_OPENAI;
 WebsiteScrapeTool.anthropicToolDefinition = anthropic_1.SCRAPE_TOOL_ANTHROPIC;
+class WebsiteScreenshotTool {
+    static async runnable(hb, params) {
+        const resp = await hb.scrape.startAndWait(params);
+        return resp.data?.screenshot || "";
+    }
+}
+exports.WebsiteScreenshotTool = WebsiteScreenshotTool;
+WebsiteScreenshotTool.openaiToolDefinition = openai_1.SCREENSHOT_TOOL_OPENAI;
+WebsiteScreenshotTool.anthropicToolDefinition = anthropic_1.SCREENSHOT_TOOL_ANTHROPIC;
 class WebsiteCrawlTool {
     static async runnable(hb, params) {
         const resp = await hb.crawl.startAndWait(params);

package/dist/tools/openai.d.ts

@@ -37,6 +37,7 @@ export interface ChatCompletionTool {
     type: "function";
 }
 export declare const SCRAPE_TOOL_OPENAI: ChatCompletionTool;
+export declare const SCREENSHOT_TOOL_OPENAI: ChatCompletionTool;
 export declare const CRAWL_TOOL_OPENAI: ChatCompletionTool;
 export declare const EXTRACT_TOOL_OPENAI: ChatCompletionTool;
 export declare const BROWSER_USE_TOOL_OPENAI: ChatCompletionTool;

package/dist/tools/openai.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BROWSER_USE_TOOL_OPENAI = exports.EXTRACT_TOOL_OPENAI = exports.CRAWL_TOOL_OPENAI = exports.SCRAPE_TOOL_OPENAI = void 0;
+exports.BROWSER_USE_TOOL_OPENAI = exports.EXTRACT_TOOL_OPENAI = exports.CRAWL_TOOL_OPENAI = exports.SCREENSHOT_TOOL_OPENAI = exports.SCRAPE_TOOL_OPENAI = void 0;
 const schema_1 = require("./schema");
 exports.SCRAPE_TOOL_OPENAI = {
     type: "function",
@@ -11,6 +11,15 @@ exports.SCRAPE_TOOL_OPENAI = {
         strict: true,
     },
 };
+exports.SCREENSHOT_TOOL_OPENAI = {
+    type: "function",
+    function: {
+        name: "screenshot_webpage",
+        description: "Take a screenshot of a webpage and return the screenshot in screenshot format as a url",
+        parameters: schema_1.SCREENSHOT_SCHEMA,
+        strict: true,
+    },
+};
 exports.CRAWL_TOOL_OPENAI = {
     type: "function",
     function: {

package/dist/tools/schema.d.ts

@@ -1,30 +1,49 @@
-export declare const SCRAPE_OPTIONS: {
-    type: string;
-    description: string;
+export declare const SCRAPE_SCHEMA: {
+    type: "object";
     properties: {
-        includeTags: {
-            type: string;
-            items: {
-                type: string;
-            };
-            description: string;
-        };
-        excludeTags: {
+        url: {
             type: string;
-            items: {
-                type: string;
-            };
             description: string;
         };
-        onlyMainContent: {
+        scrapeOptions: {
             type: string;
             description: string;
+            properties: {
+                formats: {
+                    type: string;
+                    description: string;
+                    items: {
+                        type: string;
+                        enum: ("markdown" | "screenshot")[];
+                    };
+                };
+                includeTags: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                excludeTags: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                onlyMainContent: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
         };
     };
     required: string[];
     additionalProperties: boolean;
 };
-export declare const SCRAPE_SCHEMA: {
+export declare const SCREENSHOT_SCHEMA: {
     type: "object";
     properties: {
         url: {
@@ -35,6 +54,14 @@ export declare const SCRAPE_SCHEMA: {
             type: string;
             description: string;
             properties: {
+                formats: {
+                    type: string;
+                    description: string;
+                    items: {
+                        type: string;
+                        enum: ("markdown" | "screenshot")[];
+                    };
+                };
                 includeTags: {
                     type: string;
                     items: {
@@ -98,6 +125,14 @@ export declare const CRAWL_SCHEMA: {
             type: string;
             description: string;
             properties: {
+                formats: {
+                    type: string;
+                    description: string;
+                    items: {
+                        type: string;
+                        enum: ("markdown" | "screenshot")[];
+                    };
+                };
                 includeTags: {
                     type: string;
                     items: {

package/dist/tools/schema.js

@@ -1,40 +1,62 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BROWSER_USE_SCHEMA = exports.EXTRACT_SCHEMA = exports.CRAWL_SCHEMA = exports.SCRAPE_SCHEMA = exports.SCRAPE_OPTIONS = void 0;
-exports.SCRAPE_OPTIONS = {
-    type: "object",
-    description: "The options for the scrape",
-    properties: {
-        includeTags: {
-            type: "array",
-            items: {
-                type: "string",
+exports.BROWSER_USE_SCHEMA = exports.EXTRACT_SCHEMA = exports.CRAWL_SCHEMA = exports.SCREENSHOT_SCHEMA = exports.SCRAPE_SCHEMA = void 0;
+function getScrapeOptions(formats = ["markdown"]) {
+    return {
+        type: "object",
+        description: "The options for the scrape",
+        properties: {
+            formats: {
+                type: "array",
+                description: "The format of the content to scrape",
+                items: {
+                    type: "string",
+                    enum: formats,
+                },
             },
-            description: "An array of HTML tags, classes, or IDs to include in the scraped content. Only elements matching these selectors will be returned.",
-        },
-        excludeTags: {
-            type: "array",
-            items: {
-                type: "string",
+            includeTags: {
+                type: "array",
+                items: {
+                    type: "string",
+                },
+                description: "An array of HTML tags, classes, or IDs to include in the scraped content. Only elements matching these selectors will be returned.",
+            },
+            excludeTags: {
+                type: "array",
+                items: {
+                    type: "string",
+                },
+                description: "An array of HTML tags, classes, or IDs to exclude from the scraped content. Elements matching these selectors will be omitted from the response.",
+            },
+            onlyMainContent: {
+                type: "boolean",
+                description: "Whether to only return the main content of the page. If true, only the main content of the page will be returned, excluding any headers, navigation menus,footers, or other non-main content.",
             },
-            description: "An array of HTML tags, classes, or IDs to exclude from the scraped content. Elements matching these selectors will be omitted from the response.",
         },
-        onlyMainContent: {
-            type: "boolean",
-            description: "Whether to only return the main content of the page. If true, only the main content of the page will be returned, excluding any headers, navigation menus,footers, or other non-main content.",
+        required: ["includeTags", "excludeTags", "onlyMainContent", "formats"],
+        additionalProperties: false,
+    };
+}
+exports.SCRAPE_SCHEMA = {
+    type: "object",
+    properties: {
+        url: {
+            type: "string",
+            description: "The URL of the website to scrape",
         },
+        scrapeOptions: getScrapeOptions(),
     },
-    required: ["includeTags", "excludeTags", "onlyMainContent"],
+    required: ["url", "scrapeOptions"],
     additionalProperties: false,
 };
-exports.SCRAPE_SCHEMA = {
+exports.SCREENSHOT_SCHEMA = {
     type: "object",
     properties: {
         url: {
             type: "string",
             description: "The URL of the website to scrape",
         },
-        scrapeOptions: exports.SCRAPE_OPTIONS,
+        scrapeOptions: getScrapeOptions(["screenshot"]),
     },
     required: ["url", "scrapeOptions"],
     additionalProperties: false,
@@ -72,7 +94,7 @@ exports.CRAWL_SCHEMA = {
             },
             description: "An array of regular expressions or wildcard patterns specifying which URLs should be included in the crawl. Only pages whose URLs' path match one of these path patterns will be visited. Example: ['/admin', '/careers/*']",
         },
-        scrapeOptions: exports.SCRAPE_OPTIONS,
+        scrapeOptions: getScrapeOptions(),
     },
     required: [
         "url",

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

@@ -0,0 +1,49 @@
+import { CuaTaskStatus } from "../constants";
+import { CreateSessionParams } from "../session";
+export interface StartCuaTaskParams {
+    task: string;
+    sessionId?: string;
+    maxFailures?: number;
+    maxSteps?: number;
+    keepBrowserOpen?: boolean;
+    sessionOptions?: CreateSessionParams;
+}
+export interface StartCuaTaskResponse {
+    jobId: string;
+    liveUrl: string | null;
+}
+export interface CuaTaskStatusResponse {
+    status: CuaTaskStatus;
+}
+export interface CuaStepResponseError {
+    code: string;
+    message: string;
+}
+export interface CuaStepIncompleteDetails {
+    reason?: string;
+}
+export interface CuaStepReasoning {
+    effort: string | null;
+    generate_summary?: string | null;
+}
+export interface CuaStepResponse {
+    created_at: number;
+    output_text: string;
+    error: CuaStepResponseError | null;
+    incomplete_details: CuaStepIncompleteDetails | null;
+    model: string;
+    output: Array<any>;
+    reasoning?: CuaStepReasoning | null;
+    status?: string;
+}
+export interface CuaTaskData {
+    steps: CuaStepResponse[];
+    finalResult: string | null;
+}
+export interface CuaTaskResponse {
+    jobId: string;
+    status: CuaTaskStatus;
+    data?: CuaTaskData | null;
+    error?: string | null;
+    liveUrl: string | null;
+}

package/dist/types/agents/cua.js

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

package/dist/types/constants.d.ts

@@ -3,6 +3,7 @@ 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 CuaTaskStatus = "pending" | "running" | "completed" | "failed" | "stopped";
 export type ScrapePageStatus = "completed" | "failed" | "pending" | "running";
 export type CrawlPageStatus = "completed" | "failed";
 export type ScrapeWaitUntil = "load" | "domcontentloaded" | "networkidle";

package/dist/types/index.d.ts

@@ -3,6 +3,7 @@ export { StartCrawlJobParams, StartCrawlJobResponse, CrawledPage, CrawlJobRespon
 export { StartScrapeJobParams, StartScrapeJobResponse, ScrapeJobData, ScrapeJobResponse, ScrapeOptions, ScrapeJobStatusResponse, BatchScrapeJobStatusResponse, } from "./scrape";
 export { StartExtractJobParams, StartExtractJobResponse, ExtractJobResponse, ExtractJobStatusResponse, } from "./extract";
 export { StartBrowserUseTaskParams, StartBrowserUseTaskResponse, BrowserUseTaskStatusResponse, BrowserUseTaskResponse, BrowserUseTaskData, } from "./agents/browser-use";
+export { StartCuaTaskParams, StartCuaTaskResponse, CuaTaskStatusResponse, CuaTaskResponse, CuaTaskData, CuaStepResponse, } from "./agents/cua";
 export { BasicResponse, SessionStatus, Session, SessionDetail, SessionListParams, SessionListResponse, ScreenConfig, CreateSessionParams, } from "./session";
 export { ProfileResponse, CreateProfileResponse, ProfileListParams, ProfileListResponse, } from "./profile";
 export { CreateExtensionParams, CreateExtensionResponse, ListExtensionsResponse, } from "./extension";

package/package.json

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