browser-use-sdk 1.2.0 → 2.0.1

package/dist/esm/api/types/TaskStepView.d.mts

@@ -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/esm/api/types/TaskStepView.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/TaskUpdateAction.d.mts

@@ -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/esm/api/types/TaskUpdateAction.mjs

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const TaskUpdateAction = {
+    Stop: "stop",
+    Pause: "pause",
+    Resume: "resume",
+    StopTaskAndSession: "stop_task_and_session",
+};

package/dist/esm/api/types/TaskView.d.mts

@@ -0,0 +1,34 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as BrowserUse from "../index.mjs";
+/**
+ * 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/esm/api/types/TaskView.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/UnsupportedContentTypeError.d.mts

@@ -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/esm/api/types/UnsupportedContentTypeError.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/UploadFilePresignedUrlResponse.d.mts

@@ -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/esm/api/types/UploadFilePresignedUrlResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/ValidationError.d.mts

@@ -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/esm/api/types/ValidationError.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/types/index.d.mts

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

package/dist/esm/api/types/index.mjs

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

package/dist/esm/core/fetcher/APIResponse.d.mts

@@ -0,0 +1,20 @@
+import { RawResponse } from "./RawResponse.mjs";
+/**
+ * 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/esm/core/fetcher/APIResponse.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/core/fetcher/BinaryResponse.d.mts

@@ -0,0 +1,20 @@
+import { ResponseWithBody } from "./ResponseWithBody.mjs";
+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/esm/core/fetcher/BinaryResponse.mjs

@@ -0,0 +1,14 @@
+export 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/esm/core/fetcher/Fetcher.d.mts

@@ -0,0 +1,40 @@
+import { APIResponse } from "./APIResponse.mjs";
+import { Supplier } from "./Supplier.mjs";
+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/esm/core/fetcher/Fetcher.mjs

@@ -0,0 +1,116 @@
+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());
+    });
+};
+import { toJson } from "../json.mjs";
+import { createRequestUrl } from "./createRequestUrl.mjs";
+import { getErrorResponseBody } from "./getErrorResponseBody.mjs";
+import { getFetchFn } from "./getFetchFn.mjs";
+import { getRequestBody } from "./getRequestBody.mjs";
+import { getResponseBody } from "./getResponseBody.mjs";
+import { makeRequest } from "./makeRequest.mjs";
+import { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse.mjs";
+import { requestWithRetries } from "./requestWithRetries.mjs";
+import { Supplier } from "./Supplier.mjs";
+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.get(value);
+            if (typeof result === "string") {
+                newHeaders[key] = result;
+                continue;
+            }
+            if (result == null) {
+                continue;
+            }
+            newHeaders[key] = `${result}`;
+        }
+        return newHeaders;
+    });
+}
+export function fetcherImpl(args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const url = createRequestUrl(args.url, args.queryParameters);
+        const requestBody = yield getRequestBody({
+            body: args.body,
+            type: args.requestType === "json" ? "json" : "other",
+        });
+        const fetchFn = yield getFetchFn();
+        try {
+            const response = yield requestWithRetries(() => __awaiter(this, void 0, void 0, function* () {
+                return 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 getResponseBody(response, args.responseType)),
+                    headers: response.headers,
+                    rawResponse: toRawResponse(response),
+                };
+            }
+            else {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "status-code",
+                        statusCode: response.status,
+                        body: yield getErrorResponseBody(response),
+                    },
+                    rawResponse: toRawResponse(response),
+                };
+            }
+        }
+        catch (error) {
+            if (args.abortSignal != null && args.abortSignal.aborted) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "unknown",
+                        errorMessage: "The user aborted a request",
+                    },
+                    rawResponse: abortRawResponse,
+                };
+            }
+            else if (error instanceof Error && error.name === "AbortError") {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "timeout",
+                    },
+                    rawResponse: abortRawResponse,
+                };
+            }
+            else if (error instanceof Error) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "unknown",
+                        errorMessage: error.message,
+                    },
+                    rawResponse: unknownRawResponse,
+                };
+            }
+            return {
+                ok: false,
+                error: {
+                    reason: "unknown",
+                    errorMessage: toJson(error),
+                },
+                rawResponse: unknownRawResponse,
+            };
+        }
+    });
+}
+export const fetcher = fetcherImpl;

package/dist/esm/core/fetcher/Headers.d.mts

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

package/dist/esm/core/fetcher/Headers.mjs

@@ -0,0 +1,82 @@
+let Headers;
+if (typeof globalThis.Headers !== "undefined") {
+    Headers = globalThis.Headers;
+}
+else {
+    Headers = class Headers {
+        constructor(init) {
+            this.headers = new Map();
+            if (init) {
+                if (init instanceof Headers) {
+                    init.forEach((value, key) => this.append(key, value));
+                }
+                else if (Array.isArray(init)) {
+                    for (const [key, value] of init) {
+                        if (typeof key === "string" && typeof value === "string") {
+                            this.append(key, value);
+                        }
+                        else {
+                            throw new TypeError("Each header entry must be a [string, string] tuple");
+                        }
+                    }
+                }
+                else {
+                    for (const [key, value] of Object.entries(init)) {
+                        if (typeof value === "string") {
+                            this.append(key, value);
+                        }
+                        else {
+                            throw new TypeError("Header values must be strings");
+                        }
+                    }
+                }
+            }
+        }
+        append(name, value) {
+            const key = name.toLowerCase();
+            const existing = this.headers.get(key) || [];
+            this.headers.set(key, [...existing, value]);
+        }
+        delete(name) {
+            const key = name.toLowerCase();
+            this.headers.delete(key);
+        }
+        get(name) {
+            const key = name.toLowerCase();
+            const values = this.headers.get(key);
+            return values ? values.join(", ") : null;
+        }
+        has(name) {
+            const key = name.toLowerCase();
+            return this.headers.has(key);
+        }
+        set(name, value) {
+            const key = name.toLowerCase();
+            this.headers.set(key, [value]);
+        }
+        forEach(callbackfn, thisArg) {
+            const boundCallback = thisArg ? callbackfn.bind(thisArg) : callbackfn;
+            this.headers.forEach((values, key) => boundCallback(values.join(", "), key, this));
+        }
+        getSetCookie() {
+            return this.headers.get("set-cookie") || [];
+        }
+        *entries() {
+            for (const [key, values] of this.headers.entries()) {
+                yield [key, values.join(", ")];
+            }
+        }
+        *keys() {
+            yield* this.headers.keys();
+        }
+        *values() {
+            for (const values of this.headers.values()) {
+                yield values.join(", ");
+            }
+        }
+        [Symbol.iterator]() {
+            return this.entries();
+        }
+    };
+}
+export { Headers };

package/dist/esm/core/fetcher/HttpResponsePromise.d.mts

@@ -0,0 +1,58 @@
+import { WithRawResponse } from "./RawResponse.mjs";
+/**
+ * A promise that returns the parsed response and lets you retrieve the raw response too.
+ */
+export declare class HttpResponsePromise<T> extends Promise<T> {
+    private innerPromise;
+    private unwrappedPromise;
+    private constructor();
+    /**
+     * Creates an `HttpResponsePromise` from a function that returns a promise.
+     *
+     * @param fn - A function that returns a promise resolving to a `WithRawResponse` object.
+     * @param args - Arguments to pass to the function.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromFunction<F extends (...args: never[]) => Promise<WithRawResponse<T>>, T>(fn: F, ...args: Parameters<F>): HttpResponsePromise<T>;
+    /**
+     * Creates a function that returns an `HttpResponsePromise` from a function that returns a promise.
+     *
+     * @param fn - A function that returns a promise resolving to a `WithRawResponse` object.
+     * @returns A function that returns an `HttpResponsePromise` instance.
+     */
+    static interceptFunction<F extends (...args: never[]) => Promise<WithRawResponse<T>>, T = Awaited<ReturnType<F>>["data"]>(fn: F): (...args: Parameters<F>) => HttpResponsePromise<T>;
+    /**
+     * Creates an `HttpResponsePromise` from an existing promise.
+     *
+     * @param promise - A promise resolving to a `WithRawResponse` object.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromPromise<T>(promise: Promise<WithRawResponse<T>>): HttpResponsePromise<T>;
+    /**
+     * Creates an `HttpResponsePromise` from an executor function.
+     *
+     * @param executor - A function that takes resolve and reject callbacks to create a promise.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromExecutor<T>(executor: (resolve: (value: WithRawResponse<T>) => void, reject: (reason?: unknown) => void) => void): HttpResponsePromise<T>;
+    /**
+     * Creates an `HttpResponsePromise` from a resolved result.
+     *
+     * @param result - A `WithRawResponse` object to resolve immediately.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromResult<T>(result: WithRawResponse<T>): HttpResponsePromise<T>;
+    private unwrap;
+    /** @inheritdoc */
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
+    /** @inheritdoc */
+    catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
+    /** @inheritdoc */
+    finally(onfinally?: (() => void) | null): Promise<T>;
+    /**
+     * Retrieves the data and raw response.
+     *
+     * @returns A promise resolving to a `WithRawResponse` object.
+     */
+    withRawResponse(): Promise<WithRawResponse<T>>;
+}