browser-use 0.0.1 → 0.0.2

package/dist/agent/cloud-events.d.ts

@@ -0,0 +1,264 @@
+interface AgentReference {
+    task_id: string;
+    session_id: string;
+    task: string;
+    llm: {
+        model?: string;
+        model_name?: string;
+    };
+    state: {
+        stopped: boolean;
+        paused: boolean;
+        n_steps: number;
+        model_dump?: () => Record<string, unknown>;
+    };
+    history: {
+        final_result(): string | null;
+        is_done(): boolean;
+    };
+    browser_session: {
+        id: string;
+        browser_profile?: {
+            viewport?: {
+                width: number;
+                height: number;
+            };
+            user_agent?: string | null;
+            headless?: boolean;
+            allowed_domains?: string[];
+        };
+    };
+    browser_profile?: {
+        viewport?: {
+            width: number;
+            height: number;
+        };
+        user_agent?: string | null;
+        headless?: boolean;
+        allowed_domains?: string[];
+    };
+    cloud_sync?: {
+        auth_client?: {
+            device_id?: string | null;
+        };
+    };
+    _task_start_time?: number;
+}
+interface AgentWithState extends AgentReference {
+    state: AgentReference['state'] & {
+        model_dump?: () => Record<string, unknown>;
+    };
+}
+export declare abstract class BaseEvent {
+    readonly event_type: string;
+    id: string;
+    user_id: string;
+    device_id: string | null;
+    protected constructor(event_type: string, init?: Partial<BaseEvent>);
+    toJSON(): {
+        event_type: string;
+        id: string;
+        user_id: string;
+        device_id: string | null;
+    };
+}
+export declare class UpdateAgentTaskEvent extends BaseEvent {
+    stopped: boolean | null;
+    paused: boolean | null;
+    done_output: string | null;
+    finished_at: Date | null;
+    agent_state: Record<string, unknown> | null;
+    user_feedback_type: string | null;
+    user_comment: string | null;
+    gif_url: string | null;
+    constructor(init: Partial<UpdateAgentTaskEvent> & {
+        id: string;
+    });
+    static fromAgent(agent: AgentWithState): UpdateAgentTaskEvent;
+    toJSON(): {
+        stopped: boolean | null;
+        paused: boolean | null;
+        done_output: string | null;
+        finished_at: string | null;
+        agent_state: Record<string, unknown> | null;
+        user_feedback_type: string | null;
+        user_comment: string | null;
+        gif_url: string | null;
+        event_type: string;
+        id: string;
+        user_id: string;
+        device_id: string | null;
+    };
+}
+export declare class CreateAgentOutputFileEvent extends BaseEvent {
+    task_id: string;
+    file_name: string;
+    file_content: string | null;
+    content_type: string | null;
+    created_at: Date;
+    constructor(init: {
+        user_id?: string;
+        device_id?: string | null;
+        task_id: string;
+        id?: string;
+        file_name: string;
+        file_content?: string | null;
+        content_type?: string | null;
+        created_at?: Date;
+    });
+    static fromAgentAndFile(agent: AgentReference, outputPath: string): Promise<CreateAgentOutputFileEvent>;
+    toJSON(): {
+        task_id: string;
+        file_name: string;
+        file_content: string | null;
+        content_type: string | null;
+        created_at: string;
+        event_type: string;
+        id: string;
+        user_id: string;
+        device_id: string | null;
+    };
+}
+export declare class CreateAgentStepEvent extends BaseEvent {
+    created_at: Date;
+    agent_task_id: string;
+    step: number;
+    evaluation_previous_goal: string;
+    memory: string;
+    next_goal: string;
+    actions: Array<Record<string, unknown>>;
+    screenshot_url: string | null;
+    url: string;
+    constructor(init: {
+        user_id?: string;
+        device_id?: string | null;
+        agent_task_id: string;
+        id?: string;
+        step: number;
+        evaluation_previous_goal: string;
+        memory: string;
+        next_goal: string;
+        actions: Array<Record<string, unknown>>;
+        screenshot_url?: string | null;
+        url: string;
+        created_at?: Date;
+    });
+    static fromAgentStep(agent: AgentWithState, model_output: {
+        current_state: {
+            evaluation_previous_goal: string;
+            memory: string;
+            next_goal: string;
+        };
+        action: any[];
+    }, result: Array<unknown>, actions_data: Array<Record<string, unknown>>, browser_state_summary: {
+        screenshot?: string | null;
+        url: string;
+    }): CreateAgentStepEvent;
+    toJSON(): {
+        created_at: string;
+        agent_task_id: string;
+        step: number;
+        evaluation_previous_goal: string;
+        memory: string;
+        next_goal: string;
+        actions: Record<string, unknown>[];
+        screenshot_url: string | null;
+        url: string;
+        event_type: string;
+        id: string;
+        user_id: string;
+        device_id: string | null;
+    };
+}
+export declare class CreateAgentTaskEvent extends BaseEvent {
+    agent_session_id: string;
+    llm_model: string;
+    stopped: boolean;
+    paused: boolean;
+    task: string;
+    done_output: string | null;
+    scheduled_task_id: string | null;
+    started_at: Date;
+    finished_at: Date | null;
+    agent_state: Record<string, unknown>;
+    user_feedback_type: string | null;
+    user_comment: string | null;
+    gif_url: string | null;
+    constructor(init: {
+        user_id?: string;
+        device_id?: string | null;
+        agent_session_id: string;
+        id?: string;
+        llm_model: string;
+        task: string;
+        stopped?: boolean;
+        paused?: boolean;
+        done_output?: string | null;
+        scheduled_task_id?: string | null;
+        started_at?: Date;
+        finished_at?: Date | null;
+        agent_state?: Record<string, unknown>;
+        user_feedback_type?: string | null;
+        user_comment?: string | null;
+        gif_url?: string | null;
+    });
+    static fromAgent(agent: AgentWithState): CreateAgentTaskEvent;
+    toJSON(): {
+        agent_session_id: string;
+        llm_model: string;
+        task: string;
+        stopped: boolean;
+        paused: boolean;
+        done_output: string | null;
+        scheduled_task_id: string | null;
+        started_at: string;
+        finished_at: string | null;
+        agent_state: Record<string, unknown>;
+        user_feedback_type: string | null;
+        user_comment: string | null;
+        gif_url: string | null;
+        event_type: string;
+        id: string;
+        user_id: string;
+        device_id: string | null;
+    };
+}
+export declare class CreateAgentSessionEvent extends BaseEvent {
+    browser_session_id: string;
+    browser_session_live_url: string;
+    browser_session_cdp_url: string;
+    browser_session_stopped: boolean;
+    browser_session_stopped_at: Date | null;
+    is_source_api: boolean | null;
+    browser_state: Record<string, unknown>;
+    browser_session_data: Record<string, unknown> | null;
+    constructor(init: {
+        user_id?: string;
+        device_id?: string | null;
+        browser_session_id: string;
+        id?: string;
+        browser_state?: Record<string, unknown>;
+        browser_session_live_url?: string;
+        browser_session_cdp_url?: string;
+        browser_session_stopped?: boolean;
+        browser_session_stopped_at?: Date | null;
+        is_source_api?: boolean | null;
+        browser_session_data?: Record<string, unknown> | null;
+    });
+    static fromAgent(agent: AgentReference): CreateAgentSessionEvent;
+    toJSON(): {
+        browser_session_id: string;
+        browser_session_live_url: string;
+        browser_session_cdp_url: string;
+        browser_session_stopped: boolean;
+        browser_session_stopped_at: string | null;
+        is_source_api: boolean | null;
+        browser_state: Record<string, unknown>;
+        browser_session_data: Record<string, unknown> | null;
+        event_type: string;
+        id: string;
+        user_id: string;
+        device_id: string | null;
+    };
+}
+export {};

package/dist/agent/cloud-events.js

@@ -0,0 +1,318 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { uuid7str } from '../utils.js';
+const MAX_STRING_LENGTH = 100_000;
+const MAX_URL_LENGTH = 100_000;
+const MAX_TASK_LENGTH = 100_000;
+const MAX_COMMENT_LENGTH = 2_000;
+const MAX_FILE_CONTENT_SIZE = 50 * 1024 * 1024;
+const getDeviceId = (agent) => agent.cloud_sync?.auth_client?.device_id ?? null;
+const getBrowserProfile = (agent) => agent.browser_profile ?? agent.browser_session?.browser_profile ?? null;
+const serializeAgentState = (agent) => {
+    if (typeof agent.state.model_dump === 'function') {
+        return agent.state.model_dump();
+    }
+    return {
+        stopped: agent.state.stopped,
+        paused: agent.state.paused,
+        n_steps: agent.state.n_steps,
+    };
+};
+const toDate = (timestamp) => {
+    if (!timestamp) {
+        return null;
+    }
+    return new Date(timestamp * 1000);
+};
+export class BaseEvent {
+    event_type;
+    id;
+    user_id;
+    device_id;
+    constructor(event_type, init = {}) {
+        this.event_type = event_type;
+        this.id = init.id ?? uuid7str();
+        this.user_id = init.user_id ?? '';
+        this.device_id = init.device_id ?? null;
+    }
+    toJSON() {
+        return {
+            event_type: this.event_type,
+            id: this.id,
+            user_id: this.user_id,
+            device_id: this.device_id,
+        };
+    }
+}
+export class UpdateAgentTaskEvent extends BaseEvent {
+    stopped;
+    paused;
+    done_output;
+    finished_at;
+    agent_state;
+    user_feedback_type;
+    user_comment;
+    gif_url;
+    constructor(init) {
+        super('UpdateAgentTaskEvent', init);
+        this.stopped = init.stopped ?? null;
+        this.paused = init.paused ?? null;
+        this.done_output = init.done_output ?? null;
+        this.finished_at = init.finished_at ?? null;
+        this.agent_state = init.agent_state ?? null;
+        this.user_feedback_type = init.user_feedback_type ?? null;
+        this.user_comment = init.user_comment ?? null;
+        this.gif_url = init.gif_url ?? null;
+    }
+    static fromAgent(agent) {
+        if (agent._task_start_time == null) {
+            throw new Error('Agent must have _task_start_time attribute');
+        }
+        return new UpdateAgentTaskEvent({
+            id: String(agent.task_id),
+            device_id: getDeviceId(agent),
+            stopped: agent.state.stopped,
+            paused: agent.state.paused,
+            done_output: agent.history.final_result(),
+            finished_at: agent.history.is_done() ? new Date() : null,
+            agent_state: serializeAgentState(agent),
+            user_feedback_type: null,
+            user_comment: null,
+            gif_url: null,
+        });
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            stopped: this.stopped,
+            paused: this.paused,
+            done_output: this.done_output,
+            finished_at: this.finished_at?.toISOString() ?? null,
+            agent_state: this.agent_state,
+            user_feedback_type: this.user_feedback_type,
+            user_comment: this.user_comment,
+            gif_url: this.gif_url,
+        };
+    }
+}
+export class CreateAgentOutputFileEvent extends BaseEvent {
+    task_id;
+    file_name;
+    file_content;
+    content_type;
+    created_at;
+    constructor(init) {
+        super('CreateAgentOutputFileEvent', init);
+        this.task_id = init.task_id;
+        this.file_name = init.file_name;
+        this.file_content = init.file_content ?? null;
+        this.content_type = init.content_type ?? null;
+        this.created_at = init.created_at ?? new Date();
+    }
+    static async fromAgentAndFile(agent, outputPath) {
+        const resolved = path.resolve(outputPath);
+        await fs.promises.access(resolved, fs.constants.F_OK);
+        const stats = await fs.promises.stat(resolved);
+        let fileContent = null;
+        if (stats.size < MAX_FILE_CONTENT_SIZE) {
+            const data = await fs.promises.readFile(resolved);
+            fileContent = data.toString('base64');
+        }
+        return new CreateAgentOutputFileEvent({
+            task_id: String(agent.task_id),
+            device_id: getDeviceId(agent),
+            file_name: path.basename(resolved),
+            file_content: fileContent,
+            content_type: 'image/gif',
+        });
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            task_id: this.task_id,
+            file_name: this.file_name,
+            file_content: this.file_content,
+            content_type: this.content_type,
+            created_at: this.created_at.toISOString(),
+        };
+    }
+}
+export class CreateAgentStepEvent extends BaseEvent {
+    created_at;
+    agent_task_id;
+    step;
+    evaluation_previous_goal;
+    memory;
+    next_goal;
+    actions;
+    screenshot_url;
+    url;
+    constructor(init) {
+        super('CreateAgentStepEvent', init);
+        this.created_at = init.created_at ?? new Date();
+        this.agent_task_id = init.agent_task_id;
+        this.step = init.step;
+        this.evaluation_previous_goal = init.evaluation_previous_goal;
+        this.memory = init.memory;
+        this.next_goal = init.next_goal;
+        this.actions = init.actions;
+        this.screenshot_url = init.screenshot_url ?? null;
+        this.url = init.url;
+    }
+    static fromAgentStep(agent, model_output, result, actions_data, browser_state_summary) {
+        const currentState = model_output.current_state;
+        const screenshot = browser_state_summary.screenshot
+            ? `data:image/png;base64,${browser_state_summary.screenshot}`
+            : null;
+        return new CreateAgentStepEvent({
+            device_id: getDeviceId(agent),
+            agent_task_id: String(agent.task_id),
+            step: agent.state.n_steps,
+            evaluation_previous_goal: currentState?.evaluation_previous_goal ?? '',
+            memory: currentState?.memory ?? '',
+            next_goal: currentState?.next_goal ?? '',
+            actions: actions_data ?? [],
+            url: browser_state_summary.url ?? '',
+            screenshot_url: screenshot,
+        });
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            created_at: this.created_at.toISOString(),
+            agent_task_id: this.agent_task_id,
+            step: this.step,
+            evaluation_previous_goal: this.evaluation_previous_goal,
+            memory: this.memory,
+            next_goal: this.next_goal,
+            actions: this.actions,
+            screenshot_url: this.screenshot_url,
+            url: this.url,
+        };
+    }
+}
+export class CreateAgentTaskEvent extends BaseEvent {
+    agent_session_id;
+    llm_model;
+    stopped;
+    paused;
+    task;
+    done_output;
+    scheduled_task_id;
+    started_at;
+    finished_at;
+    agent_state;
+    user_feedback_type;
+    user_comment;
+    gif_url;
+    constructor(init) {
+        super('CreateAgentTaskEvent', init);
+        this.agent_session_id = init.agent_session_id;
+        this.llm_model = init.llm_model;
+        this.task = init.task;
+        this.stopped = init.stopped ?? false;
+        this.paused = init.paused ?? false;
+        this.done_output = init.done_output ?? null;
+        this.scheduled_task_id = init.scheduled_task_id ?? null;
+        this.started_at = init.started_at ?? new Date();
+        this.finished_at = init.finished_at ?? null;
+        this.agent_state = init.agent_state ?? {};
+        this.user_feedback_type = init.user_feedback_type ?? null;
+        this.user_comment = init.user_comment ?? null;
+        this.gif_url = init.gif_url ?? null;
+    }
+    static fromAgent(agent) {
+        const startedAt = toDate(agent._task_start_time) ?? new Date();
+        return new CreateAgentTaskEvent({
+            id: String(agent.task_id),
+            device_id: getDeviceId(agent),
+            agent_session_id: String(agent.session_id),
+            task: agent.task.slice(0, MAX_TASK_LENGTH),
+            llm_model: agent.llm.model_name || agent.llm.model || 'unknown',
+            agent_state: serializeAgentState(agent),
+            stopped: false,
+            paused: false,
+            started_at: startedAt,
+            finished_at: null,
+            done_output: null,
+            scheduled_task_id: null,
+            user_feedback_type: null,
+            user_comment: null,
+            gif_url: null,
+        });
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            agent_session_id: this.agent_session_id,
+            llm_model: this.llm_model,
+            task: this.task,
+            stopped: this.stopped,
+            paused: this.paused,
+            done_output: this.done_output,
+            scheduled_task_id: this.scheduled_task_id,
+            started_at: this.started_at.toISOString(),
+            finished_at: this.finished_at?.toISOString() ?? null,
+            agent_state: this.agent_state,
+            user_feedback_type: this.user_feedback_type,
+            user_comment: this.user_comment,
+            gif_url: this.gif_url,
+        };
+    }
+}
+export class CreateAgentSessionEvent extends BaseEvent {
+    browser_session_id;
+    browser_session_live_url;
+    browser_session_cdp_url;
+    browser_session_stopped;
+    browser_session_stopped_at;
+    is_source_api;
+    browser_state;
+    browser_session_data;
+    constructor(init) {
+        super('CreateAgentSessionEvent', init);
+        this.browser_session_id = init.browser_session_id;
+        this.browser_session_live_url = init.browser_session_live_url ?? '';
+        this.browser_session_cdp_url = init.browser_session_cdp_url ?? '';
+        this.browser_session_stopped = init.browser_session_stopped ?? false;
+        this.browser_session_stopped_at = init.browser_session_stopped_at ?? null;
+        this.is_source_api = init.is_source_api ?? null;
+        this.browser_state = init.browser_state ?? {};
+        this.browser_session_data = init.browser_session_data ?? null;
+    }
+    static fromAgent(agent) {
+        const profile = getBrowserProfile(agent);
+        return new CreateAgentSessionEvent({
+            id: String(agent.session_id),
+            device_id: getDeviceId(agent),
+            browser_session_id: agent.browser_session.id,
+            browser_state: {
+                viewport: profile?.viewport ?? { width: 1280, height: 720 },
+                user_agent: profile?.user_agent ?? null,
+                headless: profile?.headless ?? true,
+                initial_url: null,
+                final_url: null,
+                total_pages_visited: 0,
+                session_duration_seconds: 0,
+            },
+            browser_session_data: {
+                cookies: [],
+                secrets: {},
+                allowed_domains: profile?.allowed_domains ?? [],
+            },
+        });
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            browser_session_id: this.browser_session_id,
+            browser_session_live_url: this.browser_session_live_url,
+            browser_session_cdp_url: this.browser_session_cdp_url,
+            browser_session_stopped: this.browser_session_stopped,
+            browser_session_stopped_at: this.browser_session_stopped_at?.toISOString() ?? null,
+            is_source_api: this.is_source_api,
+            browser_state: this.browser_state,
+            browser_session_data: this.browser_session_data,
+        };
+    }
+}

package/dist/agent/gif.d.ts

@@ -0,0 +1,15 @@
+import type { AgentHistoryList } from './views.js';
+export declare const decode_unicode_escapes_to_utf8: (text: string) => string;
+export interface HistoryGifOptions {
+    output_path?: string;
+    duration?: number;
+    show_goals?: boolean;
+    show_task?: boolean;
+    show_logo?: boolean;
+    font_size?: number;
+    title_font_size?: number;
+    goal_font_size?: number;
+    margin?: number;
+    line_spacing?: number;
+}
+export declare const create_history_gif: (task: string, history: AgentHistoryList, { output_path, duration, show_goals, show_task, show_logo, font_size, title_font_size, goal_font_size, line_spacing, }?: HistoryGifOptions) => Promise<void>;