browser-use-sdk 1.2.0 → 2.0.1

package/dist/esm/core/runtime/runtime.mjs

@@ -0,0 +1,99 @@
+/**
+ * A constant that indicates which environment and version the SDK is running in.
+ */
+export const RUNTIME = evaluateRuntime();
+function evaluateRuntime() {
+    var _a, _b, _c, _d, _e;
+    /**
+     * A constant that indicates whether the environment the code is running is a Web Browser.
+     */
+    const isBrowser = typeof window !== "undefined" && typeof window.document !== "undefined";
+    if (isBrowser) {
+        return {
+            type: "browser",
+            version: window.navigator.userAgent,
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is Cloudflare.
+     * https://developers.cloudflare.com/workers/runtime-apis/web-standards/#navigatoruseragent
+     */
+    const isCloudflare = typeof globalThis !== "undefined" && ((_a = globalThis === null || globalThis === void 0 ? void 0 : globalThis.navigator) === null || _a === void 0 ? void 0 : _a.userAgent) === "Cloudflare-Workers";
+    if (isCloudflare) {
+        return {
+            type: "workerd",
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is Edge Runtime.
+     * https://vercel.com/docs/functions/runtimes/edge-runtime#check-if-you're-running-on-the-edge-runtime
+     */
+    const isEdgeRuntime = typeof EdgeRuntime === "string";
+    if (isEdgeRuntime) {
+        return {
+            type: "edge-runtime",
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is a Web Worker.
+     */
+    const isWebWorker = typeof self === "object" &&
+        typeof (self === null || self === void 0 ? void 0 : self.importScripts) === "function" &&
+        (((_b = self.constructor) === null || _b === void 0 ? void 0 : _b.name) === "DedicatedWorkerGlobalScope" ||
+            ((_c = self.constructor) === null || _c === void 0 ? void 0 : _c.name) === "ServiceWorkerGlobalScope" ||
+            ((_d = self.constructor) === null || _d === void 0 ? void 0 : _d.name) === "SharedWorkerGlobalScope");
+    if (isWebWorker) {
+        return {
+            type: "web-worker",
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is Deno.
+     * FYI Deno spoofs process.versions.node, see https://deno.land/std@0.177.0/node/process.ts?s=versions
+     */
+    const isDeno = typeof Deno !== "undefined" && typeof Deno.version !== "undefined" && typeof Deno.version.deno !== "undefined";
+    if (isDeno) {
+        return {
+            type: "deno",
+            version: Deno.version.deno,
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is Bun.sh.
+     */
+    const isBun = typeof Bun !== "undefined" && typeof Bun.version !== "undefined";
+    if (isBun) {
+        return {
+            type: "bun",
+            version: Bun.version,
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is Node.JS.
+     */
+    const isNode = typeof process !== "undefined" &&
+        "version" in process &&
+        !!process.version &&
+        "versions" in process &&
+        !!((_e = process.versions) === null || _e === void 0 ? void 0 : _e.node);
+    if (isNode) {
+        return {
+            type: "node",
+            version: process.versions.node,
+            parsedVersion: Number(process.versions.node.split(".")[0]),
+        };
+    }
+    /**
+     * A constant that indicates whether the environment the code is running is in React-Native.
+     * https://github.com/facebook/react-native/blob/main/packages/react-native/Libraries/Core/setUpNavigator.js
+     */
+    const isReactNative = typeof navigator !== "undefined" && (navigator === null || navigator === void 0 ? void 0 : navigator.product) === "ReactNative";
+    if (isReactNative) {
+        return {
+            type: "react-native",
+        };
+    }
+    return {
+        type: "unknown",
+    };
+}

package/dist/esm/core/url/index.d.mts

@@ -0,0 +1,2 @@
+export { join } from "./join.mjs";
+export { toQueryString } from "./qs.mjs";

package/dist/esm/core/url/index.mjs

@@ -0,0 +1,2 @@
+export { join } from "./join.mjs";
+export { toQueryString } from "./qs.mjs";

package/dist/esm/core/url/join.d.mts

@@ -0,0 +1 @@
+export declare function join(base: string, ...segments: string[]): string;

package/dist/esm/core/url/join.mjs

@@ -0,0 +1,66 @@
+export function join(base, ...segments) {
+    if (!base) {
+        return "";
+    }
+    if (segments.length === 0) {
+        return base;
+    }
+    if (base.includes("://")) {
+        let url;
+        try {
+            url = new URL(base);
+        }
+        catch (_a) {
+            // Fallback to path joining if URL is malformed
+            return joinPath(base, ...segments);
+        }
+        const lastSegment = segments[segments.length - 1];
+        const shouldPreserveTrailingSlash = lastSegment && lastSegment.endsWith("/");
+        for (const segment of segments) {
+            const cleanSegment = trimSlashes(segment);
+            if (cleanSegment) {
+                url.pathname = joinPathSegments(url.pathname, cleanSegment);
+            }
+        }
+        if (shouldPreserveTrailingSlash && !url.pathname.endsWith("/")) {
+            url.pathname += "/";
+        }
+        return url.toString();
+    }
+    return joinPath(base, ...segments);
+}
+function joinPath(base, ...segments) {
+    if (segments.length === 0) {
+        return base;
+    }
+    let result = base;
+    const lastSegment = segments[segments.length - 1];
+    const shouldPreserveTrailingSlash = lastSegment && lastSegment.endsWith("/");
+    for (const segment of segments) {
+        const cleanSegment = trimSlashes(segment);
+        if (cleanSegment) {
+            result = joinPathSegments(result, cleanSegment);
+        }
+    }
+    if (shouldPreserveTrailingSlash && !result.endsWith("/")) {
+        result += "/";
+    }
+    return result;
+}
+function joinPathSegments(left, right) {
+    if (left.endsWith("/")) {
+        return left + right;
+    }
+    return left + "/" + right;
+}
+function trimSlashes(str) {
+    if (!str)
+        return str;
+    let start = 0;
+    let end = str.length;
+    if (str.startsWith("/"))
+        start = 1;
+    if (str.endsWith("/"))
+        end = str.length - 1;
+    return start === 0 && end === str.length ? str : str.slice(start, end);
+}

package/dist/esm/core/url/qs.d.mts

@@ -0,0 +1,6 @@
+interface QueryStringOptions {
+    arrayFormat?: "indices" | "repeat";
+    encode?: boolean;
+}
+export declare function toQueryString(obj: unknown, options?: QueryStringOptions): string;
+export {};

package/dist/esm/core/url/qs.mjs

@@ -0,0 +1,61 @@
+const defaultQsOptions = {
+    arrayFormat: "indices",
+    encode: true,
+};
+function encodeValue(value, shouldEncode) {
+    if (value === undefined) {
+        return "";
+    }
+    if (value === null) {
+        return "";
+    }
+    const stringValue = String(value);
+    return shouldEncode ? encodeURIComponent(stringValue) : stringValue;
+}
+function stringifyObject(obj, prefix = "", options) {
+    const parts = [];
+    for (const [key, value] of Object.entries(obj)) {
+        const fullKey = prefix ? `${prefix}[${key}]` : key;
+        if (value === undefined) {
+            continue;
+        }
+        if (Array.isArray(value)) {
+            if (value.length === 0) {
+                continue;
+            }
+            for (let i = 0; i < value.length; i++) {
+                const item = value[i];
+                if (item === undefined) {
+                    continue;
+                }
+                if (typeof item === "object" && !Array.isArray(item) && item !== null) {
+                    const arrayKey = options.arrayFormat === "indices" ? `${fullKey}[${i}]` : fullKey;
+                    parts.push(...stringifyObject(item, arrayKey, options));
+                }
+                else {
+                    const arrayKey = options.arrayFormat === "indices" ? `${fullKey}[${i}]` : fullKey;
+                    const encodedKey = options.encode ? encodeURIComponent(arrayKey) : arrayKey;
+                    parts.push(`${encodedKey}=${encodeValue(item, options.encode)}`);
+                }
+            }
+        }
+        else if (typeof value === "object" && value !== null) {
+            if (Object.keys(value).length === 0) {
+                continue;
+            }
+            parts.push(...stringifyObject(value, fullKey, options));
+        }
+        else {
+            const encodedKey = options.encode ? encodeURIComponent(fullKey) : fullKey;
+            parts.push(`${encodedKey}=${encodeValue(value, options.encode)}`);
+        }
+    }
+    return parts;
+}
+export function toQueryString(obj, options) {
+    if (obj == null || typeof obj !== "object") {
+        return "";
+    }
+    const parts = stringifyObject(obj, "", Object.assign(Object.assign({}, defaultQsOptions), options));
+    return parts.join("&");
+}

package/dist/esm/environments.d.mts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare const BrowserUseEnvironment: {
+    readonly Production: "https://api.browser-use.com/api/v2";
+};
+export type BrowserUseEnvironment = typeof BrowserUseEnvironment.Production;

package/dist/esm/environments.mjs

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const BrowserUseEnvironment = {
+    Production: "https://api.browser-use.com/api/v2",
+};

package/dist/esm/errors/BrowserUseError.d.mts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../core/index.mjs";
+export declare class BrowserUseError extends Error {
+    readonly statusCode?: number;
+    readonly body?: unknown;
+    readonly rawResponse?: core.RawResponse;
+    constructor({ message, statusCode, body, rawResponse, }: {
+        message?: string;
+        statusCode?: number;
+        body?: unknown;
+        rawResponse?: core.RawResponse;
+    });
+}

package/dist/esm/errors/BrowserUseError.mjs

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { toJson } from "../core/json.mjs";
+export class BrowserUseError extends Error {
+    constructor({ message, statusCode, body, rawResponse, }) {
+        super(buildMessage({ message, statusCode, body }));
+        Object.setPrototypeOf(this, BrowserUseError.prototype);
+        this.statusCode = statusCode;
+        this.body = body;
+        this.rawResponse = rawResponse;
+    }
+}
+function buildMessage({ message, statusCode, body, }) {
+    let lines = [];
+    if (message != null) {
+        lines.push(message);
+    }
+    if (statusCode != null) {
+        lines.push(`Status code: ${statusCode.toString()}`);
+    }
+    if (body != null) {
+        lines.push(`Body: ${toJson(body, undefined, 2)}`);
+    }
+    return lines.join("\n");
+}

package/dist/esm/errors/BrowserUseTimeoutError.d.mts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare class BrowserUseTimeoutError extends Error {
+    constructor(message: string);
+}

package/dist/esm/errors/BrowserUseTimeoutError.mjs

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export class BrowserUseTimeoutError extends Error {
+    constructor(message) {
+        super(message);
+        Object.setPrototypeOf(this, BrowserUseTimeoutError.prototype);
+    }
+}

package/dist/esm/errors/index.d.mts

@@ -0,0 +1,2 @@
+export { BrowserUseError } from "./BrowserUseError.mjs";
+export { BrowserUseTimeoutError } from "./BrowserUseTimeoutError.mjs";

package/dist/esm/errors/index.mjs

@@ -0,0 +1,2 @@
+export { BrowserUseError } from "./BrowserUseError.mjs";
+export { BrowserUseTimeoutError } from "./BrowserUseTimeoutError.mjs";

package/dist/esm/index.d.mts

@@ -0,0 +1,7 @@
+export * as BrowserUse from "./api/index.mjs";
+export { BrowserUseEnvironment } from "./environments.mjs";
+export { BrowserUseError, BrowserUseTimeoutError } from "./errors/index.mjs";
+export { BrowserUseClient } from "./wrapper/BrowserUseClient.mjs";
+export type { WrappedTaskFnsWithoutSchema, WrappedTaskFnsWithSchema } from "./wrapper/lib/parse.mjs";
+export { createWebhookSignature, verifyWebhookEventSignature } from "./wrapper/lib/webhooks.mjs";
+export type { Webhook, WebhookAgentTaskStatusUpdatePayload, WebhookTestPayload } from "./wrapper/lib/webhooks.mjs";

package/dist/esm/index.mjs

@@ -0,0 +1,5 @@
+export * as BrowserUse from "./api/index.mjs";
+export { BrowserUseEnvironment } from "./environments.mjs";
+export { BrowserUseError, BrowserUseTimeoutError } from "./errors/index.mjs";
+export { BrowserUseClient } from "./wrapper/BrowserUseClient.mjs";
+export { createWebhookSignature, verifyWebhookEventSignature } from "./wrapper/lib/webhooks.mjs";

package/dist/esm/version.d.mts

@@ -0,0 +1 @@
+export declare const SDK_VERSION = "2.0.1";

package/dist/esm/version.mjs

@@ -0,0 +1 @@
+export const SDK_VERSION = "2.0.1";

package/dist/esm/wrapper/BrowserUseClient.d.mts

@@ -0,0 +1,6 @@
+import { BrowserUseClient as FernClient } from "../Client.mjs";
+import { BrowserUseTasks } from "./api/BrowserUseTasks.mjs";
+export declare class BrowserUseClient extends FernClient {
+    protected _tasks: BrowserUseTasks | undefined;
+    get tasks(): BrowserUseTasks;
+}

package/dist/esm/wrapper/BrowserUseClient.mjs

@@ -0,0 +1,8 @@
+import { BrowserUseClient as FernClient } from "../Client.mjs";
+import { BrowserUseTasks } from "./api/BrowserUseTasks.mjs";
+export class BrowserUseClient extends FernClient {
+    get tasks() {
+        var _a;
+        return ((_a = this._tasks) !== null && _a !== void 0 ? _a : (this._tasks = new BrowserUseTasks(this._options)));
+    }
+}

package/dist/esm/wrapper/api/BrowserUseTasks.d.mts

@@ -0,0 +1,15 @@
+import type { ZodType } from "zod";
+import * as BrowserUse from "../../api/index.mjs";
+import * as core from "../../core/index.mjs";
+import { Tasks } from "../../api/resources/tasks/client/Client.mjs";
+import { type CreateTaskRequestWithSchema, type WrappedTaskFnsWithSchema, type WrappedTaskFnsWithoutSchema, type TaskViewWithSchema } from "../lib/parse.mjs";
+export declare class BrowserUseTasks extends Tasks {
+    constructor(options: Tasks.Options);
+    createTask<T extends ZodType>(request: CreateTaskRequestWithSchema<T>, requestOptions?: Tasks.RequestOptions): core.HttpResponsePromise<WrappedTaskFnsWithSchema<T>>;
+    createTask(request: BrowserUse.CreateTaskRequest, requestOptions?: Tasks.RequestOptions): core.HttpResponsePromise<WrappedTaskFnsWithoutSchema>;
+    getTask<T extends ZodType>(request: {
+        taskId: string;
+        schema: T;
+    }, requestOptions?: Tasks.RequestOptions): core.HttpResponsePromise<TaskViewWithSchema<T>>;
+    getTask(taskId: string, requestOptions?: Tasks.RequestOptions): core.HttpResponsePromise<BrowserUse.TaskView>;
+}

package/dist/esm/wrapper/api/BrowserUseTasks.mjs

@@ -0,0 +1,52 @@
+import * as core from "../../core/index.mjs";
+import { Tasks } from "../../api/resources/tasks/client/Client.mjs";
+import { stringifyStructuredOutput, wrapCreateTaskResponse, parseStructuredTaskOutput, } from "../lib/parse.mjs";
+export class BrowserUseTasks extends Tasks {
+    constructor(options) {
+        super(options);
+    }
+    createTask(request, requestOptions) {
+        if ("schema" in request) {
+            const req = Object.assign(Object.assign({}, request), { structuredOutput: stringifyStructuredOutput(request.schema) });
+            const promise = super
+                .createTask(req, requestOptions)
+                .withRawResponse()
+                .then((res) => {
+                const wrapped = wrapCreateTaskResponse(this, res.data, request.schema);
+                return {
+                    data: wrapped,
+                    rawResponse: res.rawResponse,
+                };
+            });
+            return core.HttpResponsePromise.fromPromise(promise);
+        }
+        const promise = super
+            .createTask(request, requestOptions)
+            .withRawResponse()
+            .then((res) => {
+            const wrapped = wrapCreateTaskResponse(this, res.data, null);
+            return {
+                data: wrapped,
+                rawResponse: res.rawResponse,
+            };
+        });
+        return core.HttpResponsePromise.fromPromise(promise);
+    }
+    getTask(request, requestOptions) {
+        if (typeof request === "string") {
+            return super.getTask(request, requestOptions);
+        }
+        const { taskId, schema } = request;
+        const promise = super
+            .getTask(taskId, requestOptions)
+            .withRawResponse()
+            .then((res) => {
+            const parsed = parseStructuredTaskOutput(res.data, schema);
+            return {
+                data: parsed,
+                rawResponse: res.rawResponse,
+            };
+        });
+        return core.HttpResponsePromise.fromPromise(promise);
+    }
+}

package/dist/esm/wrapper/lib/parse.d.mts

@@ -0,0 +1,69 @@
+import type { RequestOptions } from "node:http";
+import z, { type ZodType } from "zod";
+import type { BrowserUse } from "../../index.mjs";
+import type { BrowserUseTasks } from "../api/BrowserUseTasks.mjs";
+import type { CreateTaskRequest, TaskView } from "../../api/index.mjs";
+export type CreateTaskRequestWithSchema<T extends ZodType> = Omit<CreateTaskRequest, "structuredOutput"> & {
+    schema: T;
+};
+export declare function stringifyStructuredOutput<T extends ZodType>(schema: T): string;
+export type TaskViewWithSchema<T extends ZodType> = TaskView & {
+    /**
+     * The parsed output of the task.
+     *
+     * @example
+     * ```ts
+     * const task = await client.tasks.retrieve(taskId, { schema: z.object({ name: z.string() }) });
+     * console.log(task.parsed);
+     * ```
+     */
+    parsed: z.output<T> | null;
+};
+export declare function parseStructuredTaskOutput<T extends ZodType>(res: TaskView, schema: T): TaskViewWithSchema<T>;
+/**
+ * Hashes the task view to detect changes.
+ * Uses fast-json-stable-stringify for deterministic JSON, then SHA-256.
+ */
+export declare function getTaskViewHash(view: TaskView): string;
+export type PollConfig = {
+    interval?: number;
+};
+export type WrappedTaskFnsWithSchema<T extends ZodType> = BrowserUse.TaskCreatedResponse & {
+    /**
+     * Streams the steps of the task and closes when the task is finished.
+     */
+    stream: (config?: PollConfig, options?: RequestOptions) => AsyncGenerator<BrowserUse.TaskStepView>;
+    /**
+     * Get the latest task update on every change.
+     */
+    watch: (config?: PollConfig, options?: RequestOptions) => AsyncGenerator<{
+        event: "status";
+        data: TaskViewWithSchema<T>;
+    }>;
+    /**
+     * Wait for the task to finish and return the result.
+     */
+    complete: (config?: PollConfig, options?: RequestOptions) => Promise<TaskViewWithSchema<T>>;
+};
+export type WrappedTaskFnsWithoutSchema = BrowserUse.TaskCreatedResponse & {
+    /**
+     * Streams the steps of the task and closes when the task is finished.
+     */
+    stream: (config?: PollConfig, options?: RequestOptions) => AsyncGenerator<BrowserUse.TaskStepView>;
+    /**
+     * Get the latest task update on every change.
+     */
+    watch: (config?: PollConfig, options?: RequestOptions) => AsyncGenerator<{
+        event: "status";
+        data: TaskView;
+    }>;
+    /**
+     * Wait for the task to finish and return the result.
+     */
+    complete: (config?: PollConfig, options?: RequestOptions) => Promise<TaskView>;
+};
+/**
+ * Wraps the task created response with the stream and complete functions.
+ */
+export declare function wrapCreateTaskResponse<T extends ZodType>(client: BrowserUseTasks, response: BrowserUse.TaskCreatedResponse, schema: T): WrappedTaskFnsWithSchema<T>;
+export declare function wrapCreateTaskResponse(client: BrowserUseTasks, response: BrowserUse.TaskCreatedResponse, schema: null): WrappedTaskFnsWithoutSchema;