browser-use-sdk 1.2.0 → 2.0.1

package/dist/cjs/api/types/TaskListResponse.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as BrowserUse from "../index.js";
+/**
+ * Response model for paginated task list requests.
+ */
+export interface TaskListResponse {
+    /** List of task views for the current page */
+    items: BrowserUse.TaskItemView[];
+    /** Total number of items in the list */
+    totalItems: number;
+    /** Page number */
+    pageNumber: number;
+    /** Number of items per page */
+    pageSize: number;
+}

package/dist/cjs/api/types/TaskListResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TaskLogFileResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response model for log file requests
+ */
+export interface TaskLogFileResponse {
+    /** URL to download the log file */
+    downloadUrl: string;
+}

package/dist/cjs/api/types/TaskLogFileResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TaskNotFoundError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Error response when a task is not found
+ */
+export interface TaskNotFoundError {
+    detail?: string;
+}

package/dist/cjs/api/types/TaskNotFoundError.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TaskOutputFileResponse.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response model for output file requests.
+ */
+export interface TaskOutputFileResponse {
+    /** Unique identifier for the file */
+    id: string;
+    /** Name of the file */
+    fileName: string;
+    /** URL to download the file */
+    downloadUrl: string;
+}

package/dist/cjs/api/types/TaskOutputFileResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TaskStatus.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Enumeration of possible task execution states
+ *
+ * Attributes:
+ *     STARTED: Task has been started and is currently running.
+ *     PAUSED: Task execution has been temporarily paused (can be resumed)
+ *     FINISHED: Task has finished and the agent has completed the task.
+ *     STOPPED: Task execution has been manually stopped (cannot be resumed).
+ */
+export type TaskStatus = "started" | "paused" | "finished" | "stopped";
+export declare const TaskStatus: {
+    readonly Started: "started";
+    readonly Paused: "paused";
+    readonly Finished: "finished";
+    readonly Stopped: "stopped";
+};

package/dist/cjs/api/types/TaskStatus.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaskStatus = void 0;
+exports.TaskStatus = {
+    Started: "started",
+    Paused: "paused",
+    Finished: "finished",
+    Stopped: "stopped",
+};

package/dist/cjs/api/types/TaskStepView.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * View model for representing a single step in a task's execution
+ */
+export interface TaskStepView {
+    /** Sequential step number within the task */
+    number: number;
+    /** Agent's memory at this step */
+    memory: string;
+    /** Agent's evaluation of the previous goal completion */
+    evaluationPreviousGoal: string;
+    /** The goal for the next step */
+    nextGoal: string;
+    /** Current URL the browser is on for this step */
+    url: string;
+    /** Optional URL to the screenshot taken at this step */
+    screenshotUrl?: string;
+    /** List of stringified json actions performed by the agent in this step */
+    actions: string[];
+}

package/dist/cjs/api/types/TaskStepView.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TaskUpdateAction.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Available actions that can be performed on a task
+ *
+ * Attributes:
+ *     STOP: Stop the current task execution
+ *     PAUSE: Pause the current task execution
+ *     RESUME: Resume a paused task execution
+ *     STOP_TASK_AND_SESSION: Stop both the task and its parent session
+ */
+export type TaskUpdateAction = "stop" | "pause" | "resume" | "stop_task_and_session";
+export declare const TaskUpdateAction: {
+    readonly Stop: "stop";
+    readonly Pause: "pause";
+    readonly Resume: "resume";
+    readonly StopTaskAndSession: "stop_task_and_session";
+};

package/dist/cjs/api/types/TaskUpdateAction.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaskUpdateAction = void 0;
+exports.TaskUpdateAction = {
+    Stop: "stop",
+    Pause: "pause",
+    Resume: "resume",
+    StopTaskAndSession: "stop_task_and_session",
+};

package/dist/cjs/api/types/TaskView.d.ts

@@ -0,0 +1,34 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as BrowserUse from "../index.js";
+/**
+ * View model for representing a task with its execution details
+ */
+export interface TaskView {
+    /** Unique identifier for the task */
+    id: string;
+    sessionId: string;
+    /** The LLM model used for this task represented as a string */
+    llm: string;
+    /** The task prompt/instruction given to the agent */
+    task: string;
+    /** Current status of the task execution */
+    status: BrowserUse.TaskStatus;
+    /** Naive UTC timestamp when the task was started */
+    startedAt: string;
+    /** Naive UTC timestamp when the task completed (None if still running) */
+    finishedAt?: string;
+    /** Optional additional metadata associated with the task set by the user */
+    metadata?: Record<string, unknown>;
+    /** Whether this task was created as a scheduled task */
+    isScheduled: boolean;
+    steps: BrowserUse.TaskStepView[];
+    /** Final output/result of the task */
+    output?: string;
+    outputFiles: BrowserUse.FileView[];
+    /** Version of browser-use used for this task (older tasks may not have this set) */
+    browserUseVersion?: string;
+    /** Whether the task was successful (self-reported by the agent) */
+    isSuccess?: boolean;
+}

package/dist/cjs/api/types/TaskView.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/UnsupportedContentTypeError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Error response for unsupported content types
+ */
+export interface UnsupportedContentTypeError {
+    detail?: string;
+}

package/dist/cjs/api/types/UnsupportedContentTypeError.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/UploadFilePresignedUrlResponse.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response model for a presigned upload URL.
+ */
+export interface UploadFilePresignedUrlResponse {
+    /** The URL to upload the file to. */
+    url: string;
+    /** The HTTP method to use for the upload. */
+    method: "POST";
+    /** The form fields to include in the upload request. */
+    fields: Record<string, string>;
+    /** The name of the file to upload (should be referenced when user wants to use the file in a task). */
+    fileName: string;
+    /** The number of seconds until the presigned URL expires. */
+    expiresIn: number;
+}

package/dist/cjs/api/types/UploadFilePresignedUrlResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ValidationError.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ValidationError {
+    loc: ValidationError.Loc.Item[];
+    msg: string;
+    type: string;
+}
+export declare namespace ValidationError {
+    type Loc = Loc.Item[];
+    namespace Loc {
+        type Item = string | number;
+    }
+}

package/dist/cjs/api/types/ValidationError.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/index.d.ts

@@ -0,0 +1,38 @@
+export * from "./BadRequestErrorBody.js";
+export * from "./NotFoundErrorBody.js";
+export * from "./AccountNotFoundError.js";
+export * from "./AccountView.js";
+export * from "./DownloadUrlGenerationError.js";
+export * from "./FileView.js";
+export * from "./HttpValidationError.js";
+export * from "./InsufficientCreditsError.js";
+export * from "./InternalServerErrorBody.js";
+export * from "./OutputFileNotFoundError.js";
+export * from "./ProfileListResponse.js";
+export * from "./ProfileNotFoundError.js";
+export * from "./ProfileView.js";
+export * from "./ProxyCountryCode.js";
+export * from "./SessionHasRunningTaskError.js";
+export * from "./SessionItemView.js";
+export * from "./SessionListResponse.js";
+export * from "./SessionNotFoundError.js";
+export * from "./SessionStatus.js";
+export * from "./SessionStoppedError.js";
+export * from "./SessionUpdateAction.js";
+export * from "./SessionView.js";
+export * from "./ShareNotFoundError.js";
+export * from "./ShareView.js";
+export * from "./SupportedLlMs.js";
+export * from "./TaskCreatedResponse.js";
+export * from "./TaskItemView.js";
+export * from "./TaskListResponse.js";
+export * from "./TaskLogFileResponse.js";
+export * from "./TaskNotFoundError.js";
+export * from "./TaskOutputFileResponse.js";
+export * from "./TaskStatus.js";
+export * from "./TaskStepView.js";
+export * from "./TaskUpdateAction.js";
+export * from "./TaskView.js";
+export * from "./UnsupportedContentTypeError.js";
+export * from "./UploadFilePresignedUrlResponse.js";
+export * from "./ValidationError.js";

package/dist/cjs/api/types/index.js

@@ -0,0 +1,54 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./BadRequestErrorBody.js"), exports);
+__exportStar(require("./NotFoundErrorBody.js"), exports);
+__exportStar(require("./AccountNotFoundError.js"), exports);
+__exportStar(require("./AccountView.js"), exports);
+__exportStar(require("./DownloadUrlGenerationError.js"), exports);
+__exportStar(require("./FileView.js"), exports);
+__exportStar(require("./HttpValidationError.js"), exports);
+__exportStar(require("./InsufficientCreditsError.js"), exports);
+__exportStar(require("./InternalServerErrorBody.js"), exports);
+__exportStar(require("./OutputFileNotFoundError.js"), exports);
+__exportStar(require("./ProfileListResponse.js"), exports);
+__exportStar(require("./ProfileNotFoundError.js"), exports);
+__exportStar(require("./ProfileView.js"), exports);
+__exportStar(require("./ProxyCountryCode.js"), exports);
+__exportStar(require("./SessionHasRunningTaskError.js"), exports);
+__exportStar(require("./SessionItemView.js"), exports);
+__exportStar(require("./SessionListResponse.js"), exports);
+__exportStar(require("./SessionNotFoundError.js"), exports);
+__exportStar(require("./SessionStatus.js"), exports);
+__exportStar(require("./SessionStoppedError.js"), exports);
+__exportStar(require("./SessionUpdateAction.js"), exports);
+__exportStar(require("./SessionView.js"), exports);
+__exportStar(require("./ShareNotFoundError.js"), exports);
+__exportStar(require("./ShareView.js"), exports);
+__exportStar(require("./SupportedLlMs.js"), exports);
+__exportStar(require("./TaskCreatedResponse.js"), exports);
+__exportStar(require("./TaskItemView.js"), exports);
+__exportStar(require("./TaskListResponse.js"), exports);
+__exportStar(require("./TaskLogFileResponse.js"), exports);
+__exportStar(require("./TaskNotFoundError.js"), exports);
+__exportStar(require("./TaskOutputFileResponse.js"), exports);
+__exportStar(require("./TaskStatus.js"), exports);
+__exportStar(require("./TaskStepView.js"), exports);
+__exportStar(require("./TaskUpdateAction.js"), exports);
+__exportStar(require("./TaskView.js"), exports);
+__exportStar(require("./UnsupportedContentTypeError.js"), exports);
+__exportStar(require("./UploadFilePresignedUrlResponse.js"), exports);
+__exportStar(require("./ValidationError.js"), exports);

package/dist/cjs/core/fetcher/APIResponse.d.ts

@@ -0,0 +1,20 @@
+import { RawResponse } from "./RawResponse.js";
+/**
+ * The response of an API call.
+ * It is a successful response or a failed response.
+ */
+export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
+export interface SuccessfulResponse<T> {
+    ok: true;
+    body: T;
+    /**
+     * @deprecated Use `rawResponse` instead
+     */
+    headers?: Record<string, any>;
+    rawResponse: RawResponse;
+}
+export interface FailedResponse<T> {
+    ok: false;
+    error: T;
+    rawResponse: RawResponse;
+}

package/dist/cjs/core/fetcher/APIResponse.js

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

package/dist/cjs/core/fetcher/BinaryResponse.d.ts

@@ -0,0 +1,20 @@
+import { ResponseWithBody } from "./ResponseWithBody.js";
+export type BinaryResponse = {
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed) */
+    bodyUsed: boolean;
+    /**
+     * Returns a ReadableStream of the response body.
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body)
+     */
+    stream: () => ReadableStream<Uint8Array>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer) */
+    arrayBuffer: () => Promise<ArrayBuffer>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob) */
+    blob: () => Promise<Blob>;
+    /**
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
+     * Some versions of the Fetch API may not support this method.
+     */
+    bytes?(): Promise<Uint8Array>;
+};
+export declare function getBinaryResponse(response: ResponseWithBody): BinaryResponse;

package/dist/cjs/core/fetcher/BinaryResponse.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBinaryResponse = getBinaryResponse;
+function getBinaryResponse(response) {
+    const binaryResponse = {
+        get bodyUsed() {
+            return response.bodyUsed;
+        },
+        stream: () => response.body,
+        arrayBuffer: response.arrayBuffer.bind(response),
+        blob: response.blob.bind(response),
+    };
+    if ("bytes" in response && typeof response.bytes === "function") {
+        binaryResponse.bytes = response.bytes.bind(response);
+    }
+    return binaryResponse;
+}

package/dist/cjs/core/fetcher/Fetcher.d.ts

@@ -0,0 +1,40 @@
+import { APIResponse } from "./APIResponse.js";
+import { Supplier } from "./Supplier.js";
+export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
+export declare namespace Fetcher {
+    interface Args {
+        url: string;
+        method: string;
+        contentType?: string;
+        headers?: Record<string, string | Supplier<string | undefined> | undefined>;
+        queryParameters?: Record<string, unknown>;
+        body?: unknown;
+        timeoutMs?: number;
+        maxRetries?: number;
+        withCredentials?: boolean;
+        abortSignal?: AbortSignal;
+        requestType?: "json" | "file" | "bytes";
+        responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arrayBuffer" | "binary-response";
+        duplex?: "half";
+    }
+    type Error = FailedStatusCodeError | NonJsonError | TimeoutError | UnknownError;
+    interface FailedStatusCodeError {
+        reason: "status-code";
+        statusCode: number;
+        body: unknown;
+    }
+    interface NonJsonError {
+        reason: "non-json";
+        statusCode: number;
+        rawBody: string;
+    }
+    interface TimeoutError {
+        reason: "timeout";
+    }
+    interface UnknownError {
+        reason: "unknown";
+        errorMessage: string;
+    }
+}
+export declare function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>>;
+export declare const fetcher: FetchFunction;

package/dist/cjs/core/fetcher/Fetcher.js

@@ -0,0 +1,120 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetcher = void 0;
+exports.fetcherImpl = fetcherImpl;
+const json_js_1 = require("../json.js");
+const createRequestUrl_js_1 = require("./createRequestUrl.js");
+const getErrorResponseBody_js_1 = require("./getErrorResponseBody.js");
+const getFetchFn_js_1 = require("./getFetchFn.js");
+const getRequestBody_js_1 = require("./getRequestBody.js");
+const getResponseBody_js_1 = require("./getResponseBody.js");
+const makeRequest_js_1 = require("./makeRequest.js");
+const RawResponse_js_1 = require("./RawResponse.js");
+const requestWithRetries_js_1 = require("./requestWithRetries.js");
+const Supplier_js_1 = require("./Supplier.js");
+function getHeaders(args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const newHeaders = {};
+        if (args.body !== undefined && args.contentType != null) {
+            newHeaders["Content-Type"] = args.contentType;
+        }
+        if (args.headers == null) {
+            return newHeaders;
+        }
+        for (const [key, value] of Object.entries(args.headers)) {
+            const result = yield Supplier_js_1.Supplier.get(value);
+            if (typeof result === "string") {
+                newHeaders[key] = result;
+                continue;
+            }
+            if (result == null) {
+                continue;
+            }
+            newHeaders[key] = `${result}`;
+        }
+        return newHeaders;
+    });
+}
+function fetcherImpl(args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const url = (0, createRequestUrl_js_1.createRequestUrl)(args.url, args.queryParameters);
+        const requestBody = yield (0, getRequestBody_js_1.getRequestBody)({
+            body: args.body,
+            type: args.requestType === "json" ? "json" : "other",
+        });
+        const fetchFn = yield (0, getFetchFn_js_1.getFetchFn)();
+        try {
+            const response = yield (0, requestWithRetries_js_1.requestWithRetries)(() => __awaiter(this, void 0, void 0, function* () {
+                return (0, makeRequest_js_1.makeRequest)(fetchFn, url, args.method, yield getHeaders(args), requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex);
+            }), args.maxRetries);
+            if (response.status >= 200 && response.status < 400) {
+                return {
+                    ok: true,
+                    body: (yield (0, getResponseBody_js_1.getResponseBody)(response, args.responseType)),
+                    headers: response.headers,
+                    rawResponse: (0, RawResponse_js_1.toRawResponse)(response),
+                };
+            }
+            else {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "status-code",
+                        statusCode: response.status,
+                        body: yield (0, getErrorResponseBody_js_1.getErrorResponseBody)(response),
+                    },
+                    rawResponse: (0, RawResponse_js_1.toRawResponse)(response),
+                };
+            }
+        }
+        catch (error) {
+            if (args.abortSignal != null && args.abortSignal.aborted) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "unknown",
+                        errorMessage: "The user aborted a request",
+                    },
+                    rawResponse: RawResponse_js_1.abortRawResponse,
+                };
+            }
+            else if (error instanceof Error && error.name === "AbortError") {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "timeout",
+                    },
+                    rawResponse: RawResponse_js_1.abortRawResponse,
+                };
+            }
+            else if (error instanceof Error) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "unknown",
+                        errorMessage: error.message,
+                    },
+                    rawResponse: RawResponse_js_1.unknownRawResponse,
+                };
+            }
+            return {
+                ok: false,
+                error: {
+                    reason: "unknown",
+                    errorMessage: (0, json_js_1.toJson)(error),
+                },
+                rawResponse: RawResponse_js_1.unknownRawResponse,
+            };
+        }
+    });
+}
+exports.fetcher = fetcherImpl;

package/dist/cjs/core/fetcher/Headers.d.ts

@@ -0,0 +1,2 @@
+declare let Headers: typeof globalThis.Headers;
+export { Headers };