browser-use-sdk 2.0.15 → 3.0.3

package/dist/v3.d.cts

@@ -0,0 +1,287 @@
+import { z } from 'zod';
+import { H as HttpClient } from './errors-BtB79l7x.cjs';
+export { B as BrowserUseError } from './errors-BtB79l7x.cjs';
+
+interface components {
+    schemas: {
+        /**
+         * BuAgentSessionStatus
+         * @enum {string}
+         */
+        BuAgentSessionStatus: "created" | "idle" | "running" | "stopped" | "timed_out" | "error";
+        /**
+         * BuModel
+         * @enum {string}
+         */
+        BuModel: "bu-mini" | "bu-max";
+        /**
+         * FileInfo
+         * @description A file in a session's workspace.
+         */
+        FileInfo: {
+            /** Path */
+            path: string;
+            /** Size */
+            size: number;
+            /**
+             * Lastmodified
+             * Format: date-time
+             */
+            lastModified: string;
+            /** Url */
+            url?: string | null;
+        };
+        /**
+         * FileListResponse
+         * @description Paginated file listing with optional presigned download URLs.
+         */
+        FileListResponse: {
+            /** Files */
+            files: components["schemas"]["FileInfo"][];
+            /** Nextcursor */
+            nextCursor?: string | null;
+            /**
+             * Hasmore
+             * @default false
+             */
+            hasMore: boolean;
+        };
+        /** HTTPValidationError */
+        HTTPValidationError: {
+            /** Detail */
+            detail?: components["schemas"]["ValidationError"][];
+        };
+        /**
+         * ProxyCountryCode
+         * @enum {string}
+         */
+        ProxyCountryCode: "ad" | "ae" | "af" | "ag" | "ai" | "al" | "am" | "an" | "ao" | "aq" | "ar" | "as" | "at" | "au" | "aw" | "az" | "ba" | "bb" | "bd" | "be" | "bf" | "bg" | "bh" | "bi" | "bj" | "bl" | "bm" | "bn" | "bo" | "bq" | "br" | "bs" | "bt" | "bv" | "bw" | "by" | "bz" | "ca" | "cc" | "cd" | "cf" | "cg" | "ch" | "ck" | "cl" | "cm" | "co" | "cr" | "cs" | "cu" | "cv" | "cw" | "cx" | "cy" | "cz" | "de" | "dj" | "dk" | "dm" | "do" | "dz" | "ec" | "ee" | "eg" | "eh" | "er" | "es" | "et" | "fi" | "fj" | "fk" | "fm" | "fo" | "fr" | "ga" | "gd" | "ge" | "gf" | "gg" | "gh" | "gi" | "gl" | "gm" | "gn" | "gp" | "gq" | "gr" | "gs" | "gt" | "gu" | "gw" | "gy" | "hk" | "hm" | "hn" | "hr" | "ht" | "hu" | "id" | "ie" | "il" | "im" | "in" | "iq" | "ir" | "is" | "it" | "je" | "jm" | "jo" | "jp" | "ke" | "kg" | "kh" | "ki" | "km" | "kn" | "kp" | "kr" | "kw" | "ky" | "kz" | "la" | "lb" | "lc" | "li" | "lk" | "lr" | "ls" | "lt" | "lu" | "lv" | "ly" | "ma" | "mc" | "md" | "me" | "mf" | "mg" | "mh" | "mk" | "ml" | "mm" | "mn" | "mo" | "mp" | "mq" | "mr" | "ms" | "mt" | "mu" | "mv" | "mw" | "mx" | "my" | "mz" | "na" | "nc" | "ne" | "nf" | "ng" | "ni" | "nl" | "no" | "np" | "nr" | "nu" | "nz" | "om" | "pa" | "pe" | "pf" | "pg" | "ph" | "pk" | "pl" | "pm" | "pn" | "pr" | "ps" | "pt" | "pw" | "py" | "qa" | "re" | "ro" | "rs" | "ru" | "rw" | "sa" | "sb" | "sc" | "sd" | "se" | "sg" | "sh" | "si" | "sj" | "sk" | "sl" | "sm" | "sn" | "so" | "sr" | "ss" | "st" | "sv" | "sx" | "sy" | "sz" | "tc" | "td" | "tf" | "tg" | "th" | "tj" | "tk" | "tl" | "tm" | "tn" | "to" | "tr" | "tt" | "tv" | "tw" | "tz" | "ua" | "ug" | "uk" | "us" | "uy" | "uz" | "va" | "vc" | "ve" | "vg" | "vi" | "vn" | "vu" | "wf" | "ws" | "xk" | "ye" | "yt" | "za" | "zm" | "zw";
+        /**
+         * RunTaskRequest
+         * @description Unified request for creating a session or dispatching a task.
+         *
+         *     - Without session_id: creates a new session + dispatches the task
+         *     - With session_id: dispatches the task to an existing session
+         */
+        RunTaskRequest: {
+            /** Task */
+            task: string;
+            /** @default bu-mini */
+            model: components["schemas"]["BuModel"];
+            /** Sessionid */
+            sessionId?: string | null;
+            /**
+             * Keepalive
+             * @default false
+             */
+            keepAlive: boolean;
+            /** Maxcostusd */
+            maxCostUsd?: number | string | null;
+            /** Profileid */
+            profileId?: string | null;
+            proxyCountryCode?: components["schemas"]["ProxyCountryCode"] | null;
+            /** Outputschema */
+            outputSchema?: {
+                [key: string]: unknown;
+            } | null;
+        };
+        /** SessionListResponse */
+        SessionListResponse: {
+            /** Sessions */
+            sessions: components["schemas"]["SessionResponse"][];
+            /** Total */
+            total: number;
+            /** Page */
+            page: number;
+            /** Pagesize */
+            pageSize: number;
+        };
+        /** SessionResponse */
+        SessionResponse: {
+            /**
+             * Id
+             * Format: uuid
+             */
+            id: string;
+            status: components["schemas"]["BuAgentSessionStatus"];
+            model: components["schemas"]["BuModel"];
+            /** Title */
+            title?: string | null;
+            /** Output */
+            output?: unknown | null;
+            /** Liveurl */
+            liveUrl?: string | null;
+            /** Profileid */
+            profileId?: string | null;
+            proxyCountryCode?: components["schemas"]["ProxyCountryCode"] | null;
+            /** Maxcostusd */
+            maxCostUsd?: string | null;
+            /**
+             * Totalinputtokens
+             * @default 0
+             */
+            totalInputTokens: number;
+            /**
+             * Totaloutputtokens
+             * @default 0
+             */
+            totalOutputTokens: number;
+            /**
+             * Proxyusedmb
+             * @default 0
+             */
+            proxyUsedMb: string;
+            /**
+             * Llmcostusd
+             * @default 0
+             */
+            llmCostUsd: string;
+            /**
+             * Proxycostusd
+             * @default 0
+             */
+            proxyCostUsd: string;
+            /**
+             * Totalcostusd
+             * @default 0
+             */
+            totalCostUsd: string;
+            /**
+             * Createdat
+             * Format: date-time
+             */
+            createdAt: string;
+            /**
+             * Updatedat
+             * Format: date-time
+             */
+            updatedAt: string;
+        };
+        /** ValidationError */
+        ValidationError: {
+            /** Location */
+            loc: (string | number)[];
+            /** Message */
+            msg: string;
+            /** Error Type */
+            type: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+
+type RunTaskRequest$2 = components["schemas"]["RunTaskRequest"];
+/** Like RunTaskRequest but only `task` is required; fields with server defaults are optional. */
+type CreateSessionBody = Pick<RunTaskRequest$2, "task"> & Partial<Omit<RunTaskRequest$2, "task">>;
+type SessionResponse$2 = components["schemas"]["SessionResponse"];
+type SessionListResponse$1 = components["schemas"]["SessionListResponse"];
+type FileListResponse$1 = components["schemas"]["FileListResponse"];
+interface SessionListParams {
+    page?: number;
+    page_size?: number;
+}
+interface SessionFilesParams {
+    prefix?: string;
+    limit?: number;
+    cursor?: string | null;
+    includeUrls?: boolean;
+}
+declare class Sessions {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** Create a session and run a task. */
+    create(body: CreateSessionBody): Promise<SessionResponse$2>;
+    /** List sessions for the authenticated project. */
+    list(params?: SessionListParams): Promise<SessionListResponse$1>;
+    /** Get session details. */
+    get(sessionId: string): Promise<SessionResponse$2>;
+    /** Stop a session. */
+    stop(sessionId: string): Promise<SessionResponse$2>;
+    /** List files in a session's workspace. */
+    files(sessionId: string, params?: SessionFilesParams): Promise<FileListResponse$1>;
+}
+
+type SessionResponse$1 = components["schemas"]["SessionResponse"];
+interface RunOptions {
+    /** Maximum time to wait in milliseconds. Default: 300_000 (5 min). */
+    timeout?: number;
+    /** Polling interval in milliseconds. Default: 2_000. */
+    interval?: number;
+}
+/** Session result with typed output. All SessionResponse fields are directly accessible. */
+type SessionResult<T = string | null> = Omit<SessionResponse$1, "output"> & {
+    output: T;
+};
+/**
+ * Dual-purpose session handle: `await` it for a typed SessionResult,
+ * or access `.result` for the full SessionResult after resolution.
+ */
+declare class SessionRun<T = string> implements PromiseLike<SessionResult<T>> {
+    private readonly _createPromise;
+    private readonly _sessions;
+    private readonly _schema?;
+    private readonly _timeout;
+    private readonly _interval;
+    private _sessionId;
+    private _result;
+    constructor(createPromise: Promise<SessionResponse$1>, sessions: Sessions, schema?: z.ZodType<T>, options?: RunOptions);
+    /** The session ID, available after task creation resolves. */
+    get sessionId(): string | null;
+    /** The full SessionResult, available after polling completes. */
+    get result(): SessionResult<T> | null;
+    /** Enable `await client.run(...)` — polls until terminal, returns SessionResult. */
+    then<R1 = SessionResult<T>, R2 = never>(onFulfilled?: ((value: SessionResult<T>) => R1 | PromiseLike<R1>) | null, onRejected?: ((reason: unknown) => R2 | PromiseLike<R2>) | null): Promise<R1 | R2>;
+    private _ensureSessionId;
+    /** Poll session until terminal, return SessionResult. */
+    private _waitForOutput;
+    private _parseOutput;
+}
+
+type RunTaskRequest$1 = components["schemas"]["RunTaskRequest"];
+interface BrowserUseOptions {
+    apiKey?: string;
+    baseUrl?: string;
+    maxRetries?: number;
+    timeout?: number;
+}
+type RunSessionOptions = Partial<Omit<RunTaskRequest$1, "task">> & RunOptions & {
+    schema?: z.ZodType;
+};
+declare class BrowserUse {
+    readonly sessions: Sessions;
+    private readonly http;
+    constructor(options?: BrowserUseOptions);
+    /**
+     * Create a session and run a task. `await` the result for a typed SessionResult.
+     *
+     * ```ts
+     * // Simple — just get the output
+     * const result = await client.run("Find the top HN post");
+     * console.log(result.output);
+     *
+     * // Structured output (Zod)
+     * const result = await client.run("Find product info", { schema: ProductSchema });
+     * console.log(result.output.name); // fully typed
+     * ```
+     */
+    run(task: string, options?: Omit<RunSessionOptions, "schema">): SessionRun<string>;
+    run<T extends z.ZodType>(task: string, options: RunSessionOptions & {
+        schema: T;
+    }): SessionRun<z.output<T>>;
+}
+
+type S = components["schemas"];
+type SessionResponse = S["SessionResponse"];
+type SessionListResponse = S["SessionListResponse"];
+type FileListResponse = S["FileListResponse"];
+type FileInfo = S["FileInfo"];
+type RunTaskRequest = S["RunTaskRequest"];
+type BuAgentSessionStatus = S["BuAgentSessionStatus"];
+type BuModel = S["BuModel"];
+type ProxyCountryCode = S["ProxyCountryCode"];
+
+export { BrowserUse, type BrowserUseOptions, type BuAgentSessionStatus, type BuModel, type CreateSessionBody, type FileInfo, type FileListResponse, type ProxyCountryCode, type RunOptions, type RunSessionOptions, type RunTaskRequest, type SessionFilesParams, type SessionListParams, type SessionListResponse, type SessionResponse, type SessionResult, SessionRun, Sessions, type components as V3Types };

package/dist/v3.d.ts

@@ -0,0 +1,287 @@
+import { z } from 'zod';
+import { H as HttpClient } from './errors-BtB79l7x.js';
+export { B as BrowserUseError } from './errors-BtB79l7x.js';
+
+interface components {
+    schemas: {
+        /**
+         * BuAgentSessionStatus
+         * @enum {string}
+         */
+        BuAgentSessionStatus: "created" | "idle" | "running" | "stopped" | "timed_out" | "error";
+        /**
+         * BuModel
+         * @enum {string}
+         */
+        BuModel: "bu-mini" | "bu-max";
+        /**
+         * FileInfo
+         * @description A file in a session's workspace.
+         */
+        FileInfo: {
+            /** Path */
+            path: string;
+            /** Size */
+            size: number;
+            /**
+             * Lastmodified
+             * Format: date-time
+             */
+            lastModified: string;
+            /** Url */
+            url?: string | null;
+        };
+        /**
+         * FileListResponse
+         * @description Paginated file listing with optional presigned download URLs.
+         */
+        FileListResponse: {
+            /** Files */
+            files: components["schemas"]["FileInfo"][];
+            /** Nextcursor */
+            nextCursor?: string | null;
+            /**
+             * Hasmore
+             * @default false
+             */
+            hasMore: boolean;
+        };
+        /** HTTPValidationError */
+        HTTPValidationError: {
+            /** Detail */
+            detail?: components["schemas"]["ValidationError"][];
+        };
+        /**
+         * ProxyCountryCode
+         * @enum {string}
+         */
+        ProxyCountryCode: "ad" | "ae" | "af" | "ag" | "ai" | "al" | "am" | "an" | "ao" | "aq" | "ar" | "as" | "at" | "au" | "aw" | "az" | "ba" | "bb" | "bd" | "be" | "bf" | "bg" | "bh" | "bi" | "bj" | "bl" | "bm" | "bn" | "bo" | "bq" | "br" | "bs" | "bt" | "bv" | "bw" | "by" | "bz" | "ca" | "cc" | "cd" | "cf" | "cg" | "ch" | "ck" | "cl" | "cm" | "co" | "cr" | "cs" | "cu" | "cv" | "cw" | "cx" | "cy" | "cz" | "de" | "dj" | "dk" | "dm" | "do" | "dz" | "ec" | "ee" | "eg" | "eh" | "er" | "es" | "et" | "fi" | "fj" | "fk" | "fm" | "fo" | "fr" | "ga" | "gd" | "ge" | "gf" | "gg" | "gh" | "gi" | "gl" | "gm" | "gn" | "gp" | "gq" | "gr" | "gs" | "gt" | "gu" | "gw" | "gy" | "hk" | "hm" | "hn" | "hr" | "ht" | "hu" | "id" | "ie" | "il" | "im" | "in" | "iq" | "ir" | "is" | "it" | "je" | "jm" | "jo" | "jp" | "ke" | "kg" | "kh" | "ki" | "km" | "kn" | "kp" | "kr" | "kw" | "ky" | "kz" | "la" | "lb" | "lc" | "li" | "lk" | "lr" | "ls" | "lt" | "lu" | "lv" | "ly" | "ma" | "mc" | "md" | "me" | "mf" | "mg" | "mh" | "mk" | "ml" | "mm" | "mn" | "mo" | "mp" | "mq" | "mr" | "ms" | "mt" | "mu" | "mv" | "mw" | "mx" | "my" | "mz" | "na" | "nc" | "ne" | "nf" | "ng" | "ni" | "nl" | "no" | "np" | "nr" | "nu" | "nz" | "om" | "pa" | "pe" | "pf" | "pg" | "ph" | "pk" | "pl" | "pm" | "pn" | "pr" | "ps" | "pt" | "pw" | "py" | "qa" | "re" | "ro" | "rs" | "ru" | "rw" | "sa" | "sb" | "sc" | "sd" | "se" | "sg" | "sh" | "si" | "sj" | "sk" | "sl" | "sm" | "sn" | "so" | "sr" | "ss" | "st" | "sv" | "sx" | "sy" | "sz" | "tc" | "td" | "tf" | "tg" | "th" | "tj" | "tk" | "tl" | "tm" | "tn" | "to" | "tr" | "tt" | "tv" | "tw" | "tz" | "ua" | "ug" | "uk" | "us" | "uy" | "uz" | "va" | "vc" | "ve" | "vg" | "vi" | "vn" | "vu" | "wf" | "ws" | "xk" | "ye" | "yt" | "za" | "zm" | "zw";
+        /**
+         * RunTaskRequest
+         * @description Unified request for creating a session or dispatching a task.
+         *
+         *     - Without session_id: creates a new session + dispatches the task
+         *     - With session_id: dispatches the task to an existing session
+         */
+        RunTaskRequest: {
+            /** Task */
+            task: string;
+            /** @default bu-mini */
+            model: components["schemas"]["BuModel"];
+            /** Sessionid */
+            sessionId?: string | null;
+            /**
+             * Keepalive
+             * @default false
+             */
+            keepAlive: boolean;
+            /** Maxcostusd */
+            maxCostUsd?: number | string | null;
+            /** Profileid */
+            profileId?: string | null;
+            proxyCountryCode?: components["schemas"]["ProxyCountryCode"] | null;
+            /** Outputschema */
+            outputSchema?: {
+                [key: string]: unknown;
+            } | null;
+        };
+        /** SessionListResponse */
+        SessionListResponse: {
+            /** Sessions */
+            sessions: components["schemas"]["SessionResponse"][];
+            /** Total */
+            total: number;
+            /** Page */
+            page: number;
+            /** Pagesize */
+            pageSize: number;
+        };
+        /** SessionResponse */
+        SessionResponse: {
+            /**
+             * Id
+             * Format: uuid
+             */
+            id: string;
+            status: components["schemas"]["BuAgentSessionStatus"];
+            model: components["schemas"]["BuModel"];
+            /** Title */
+            title?: string | null;
+            /** Output */
+            output?: unknown | null;
+            /** Liveurl */
+            liveUrl?: string | null;
+            /** Profileid */
+            profileId?: string | null;
+            proxyCountryCode?: components["schemas"]["ProxyCountryCode"] | null;
+            /** Maxcostusd */
+            maxCostUsd?: string | null;
+            /**
+             * Totalinputtokens
+             * @default 0
+             */
+            totalInputTokens: number;
+            /**
+             * Totaloutputtokens
+             * @default 0
+             */
+            totalOutputTokens: number;
+            /**
+             * Proxyusedmb
+             * @default 0
+             */
+            proxyUsedMb: string;
+            /**
+             * Llmcostusd
+             * @default 0
+             */
+            llmCostUsd: string;
+            /**
+             * Proxycostusd
+             * @default 0
+             */
+            proxyCostUsd: string;
+            /**
+             * Totalcostusd
+             * @default 0
+             */
+            totalCostUsd: string;
+            /**
+             * Createdat
+             * Format: date-time
+             */
+            createdAt: string;
+            /**
+             * Updatedat
+             * Format: date-time
+             */
+            updatedAt: string;
+        };
+        /** ValidationError */
+        ValidationError: {
+            /** Location */
+            loc: (string | number)[];
+            /** Message */
+            msg: string;
+            /** Error Type */
+            type: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+
+type RunTaskRequest$2 = components["schemas"]["RunTaskRequest"];
+/** Like RunTaskRequest but only `task` is required; fields with server defaults are optional. */
+type CreateSessionBody = Pick<RunTaskRequest$2, "task"> & Partial<Omit<RunTaskRequest$2, "task">>;
+type SessionResponse$2 = components["schemas"]["SessionResponse"];
+type SessionListResponse$1 = components["schemas"]["SessionListResponse"];
+type FileListResponse$1 = components["schemas"]["FileListResponse"];
+interface SessionListParams {
+    page?: number;
+    page_size?: number;
+}
+interface SessionFilesParams {
+    prefix?: string;
+    limit?: number;
+    cursor?: string | null;
+    includeUrls?: boolean;
+}
+declare class Sessions {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** Create a session and run a task. */
+    create(body: CreateSessionBody): Promise<SessionResponse$2>;
+    /** List sessions for the authenticated project. */
+    list(params?: SessionListParams): Promise<SessionListResponse$1>;
+    /** Get session details. */
+    get(sessionId: string): Promise<SessionResponse$2>;
+    /** Stop a session. */
+    stop(sessionId: string): Promise<SessionResponse$2>;
+    /** List files in a session's workspace. */
+    files(sessionId: string, params?: SessionFilesParams): Promise<FileListResponse$1>;
+}
+
+type SessionResponse$1 = components["schemas"]["SessionResponse"];
+interface RunOptions {
+    /** Maximum time to wait in milliseconds. Default: 300_000 (5 min). */
+    timeout?: number;
+    /** Polling interval in milliseconds. Default: 2_000. */
+    interval?: number;
+}
+/** Session result with typed output. All SessionResponse fields are directly accessible. */
+type SessionResult<T = string | null> = Omit<SessionResponse$1, "output"> & {
+    output: T;
+};
+/**
+ * Dual-purpose session handle: `await` it for a typed SessionResult,
+ * or access `.result` for the full SessionResult after resolution.
+ */
+declare class SessionRun<T = string> implements PromiseLike<SessionResult<T>> {
+    private readonly _createPromise;
+    private readonly _sessions;
+    private readonly _schema?;
+    private readonly _timeout;
+    private readonly _interval;
+    private _sessionId;
+    private _result;
+    constructor(createPromise: Promise<SessionResponse$1>, sessions: Sessions, schema?: z.ZodType<T>, options?: RunOptions);
+    /** The session ID, available after task creation resolves. */
+    get sessionId(): string | null;
+    /** The full SessionResult, available after polling completes. */
+    get result(): SessionResult<T> | null;
+    /** Enable `await client.run(...)` — polls until terminal, returns SessionResult. */
+    then<R1 = SessionResult<T>, R2 = never>(onFulfilled?: ((value: SessionResult<T>) => R1 | PromiseLike<R1>) | null, onRejected?: ((reason: unknown) => R2 | PromiseLike<R2>) | null): Promise<R1 | R2>;
+    private _ensureSessionId;
+    /** Poll session until terminal, return SessionResult. */
+    private _waitForOutput;
+    private _parseOutput;
+}
+
+type RunTaskRequest$1 = components["schemas"]["RunTaskRequest"];
+interface BrowserUseOptions {
+    apiKey?: string;
+    baseUrl?: string;
+    maxRetries?: number;
+    timeout?: number;
+}
+type RunSessionOptions = Partial<Omit<RunTaskRequest$1, "task">> & RunOptions & {
+    schema?: z.ZodType;
+};
+declare class BrowserUse {
+    readonly sessions: Sessions;
+    private readonly http;
+    constructor(options?: BrowserUseOptions);
+    /**
+     * Create a session and run a task. `await` the result for a typed SessionResult.
+     *
+     * ```ts
+     * // Simple — just get the output
+     * const result = await client.run("Find the top HN post");
+     * console.log(result.output);
+     *
+     * // Structured output (Zod)
+     * const result = await client.run("Find product info", { schema: ProductSchema });
+     * console.log(result.output.name); // fully typed
+     * ```
+     */
+    run(task: string, options?: Omit<RunSessionOptions, "schema">): SessionRun<string>;
+    run<T extends z.ZodType>(task: string, options: RunSessionOptions & {
+        schema: T;
+    }): SessionRun<z.output<T>>;
+}
+
+type S = components["schemas"];
+type SessionResponse = S["SessionResponse"];
+type SessionListResponse = S["SessionListResponse"];
+type FileListResponse = S["FileListResponse"];
+type FileInfo = S["FileInfo"];
+type RunTaskRequest = S["RunTaskRequest"];
+type BuAgentSessionStatus = S["BuAgentSessionStatus"];
+type BuModel = S["BuModel"];
+type ProxyCountryCode = S["ProxyCountryCode"];
+
+export { BrowserUse, type BrowserUseOptions, type BuAgentSessionStatus, type BuModel, type CreateSessionBody, type FileInfo, type FileListResponse, type ProxyCountryCode, type RunOptions, type RunSessionOptions, type RunTaskRequest, type SessionFilesParams, type SessionListParams, type SessionListResponse, type SessionResponse, type SessionResult, SessionRun, Sessions, type components as V3Types };