@hyperbrowser/sdk 0.36.0 → 0.38.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);
+    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}`);
@@ -17,7 +18,7 @@ class HyperbrowserError extends Error {
 }
 exports.HyperbrowserError = HyperbrowserError;
 class HyperbrowserClient {
-    constructor(config) {
+    constructor(config = {}) {
         const apiKey = config.apiKey || process.env["HYPERBROWSER_API_KEY"];
         const baseUrl = config.baseUrl || "https://app.hyperbrowser.ai";
         const timeout = config.timeout || 30000;
@@ -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/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/config.d.ts

@@ -1,5 +1,5 @@
 export interface HyperbrowserConfig {
-    apiKey: string;
+    apiKey?: string;
     baseUrl?: string;
     timeout?: number;
 }

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.36.0",
+  "version": "0.38.0",
   "description": "Node SDK for Hyperbrowser API",
   "author": "",
   "main": "dist/index.js",