browser-use 0.2.0 → 0.3.0

package/dist/browser/session.d.ts

@@ -1,7 +1,11 @@
+import { EventBus, type EventDispatchOptions, type EventPayload } from '../event-bus.js';
 import { type Browser, type BrowserContext, type Page, type Locator } from './types.js';
 import { BrowserProfile, type BrowserProfileOptions, DEFAULT_BROWSER_PROFILE } from './profile.js';
 import { BrowserStateSummary, type TabInfo } from './views.js';
+import { type WaitUntilState } from './events.js';
 import { DOMElementNode, type SelectorMap } from '../dom/views.js';
+import { SessionManager } from './session-manager.js';
+import type { BaseWatchdog } from './watchdogs/base.js';
 export interface BrowserSessionInit {
     id?: string;
     browser_profile?: BrowserProfile;
@@ -16,18 +20,27 @@ export interface BrowserSessionInit {
     browser_pid?: number | null;
     playwright?: unknown;
     downloaded_files?: string[];
+    closed_popup_messages?: string[];
 }
 export interface BrowserStateOptions {
     cache_clickable_elements_hashes?: boolean;
     include_screenshot?: boolean;
+    include_recent_events?: boolean;
     signal?: AbortSignal | null;
 }
 export interface BrowserActionOptions {
     signal?: AbortSignal | null;
+    clear?: boolean;
+}
+export interface BrowserNavigationOptions extends BrowserActionOptions {
+    wait_until?: WaitUntilState;
+    timeout_ms?: number | null;
 }
 export declare class BrowserSession {
     readonly id: string;
     readonly browser_profile: BrowserProfile;
+    readonly event_bus: EventBus;
+    readonly session_manager: SessionManager;
     browser: Browser | null;
     browser_context: BrowserContext | null;
     agent_current_page: Page | null;
@@ -47,6 +60,8 @@ export declare class BrowserSession {
     private currentTabIndex;
     private historyStack;
     downloaded_files: string[];
+    llm_screenshot_size: [number, number] | null;
+    _original_viewport_size: [number, number] | null;
     private ownsBrowserResources;
     private _autoDownloadPdfs;
     private tabPages;
@@ -56,14 +71,43 @@ export declare class BrowserSession {
     private attachedAgentId;
     private attachedSharedAgentIds;
     private _stoppingPromise;
+    private _closedPopupMessages;
+    private _dialogHandlersAttached;
+    private readonly _maxClosedPopupMessages;
+    private _recentEvents;
+    private readonly _maxRecentEvents;
+    private _watchdogs;
+    private _defaultWatchdogsAttached;
     constructor(init?: BrowserSessionInit);
+    attach_watchdog(watchdog: BaseWatchdog): void;
+    attach_watchdogs(watchdogs: BaseWatchdog[]): void;
+    detach_watchdog(watchdog: BaseWatchdog): void;
+    detach_all_watchdogs(): void;
+    get_watchdogs(): BaseWatchdog[];
+    dispatch_browser_event<TEvent extends EventPayload>(event: TEvent, options?: Omit<EventDispatchOptions, 'throw_on_error'>): Promise<import("../event-bus.js").EventDispatchResult<TEvent>>;
+    launch(): Promise<{
+        cdp_url: string;
+    }>;
+    attach_default_watchdogs(): void;
+    private _formatTabId;
+    private _createTabInfo;
+    private _buildSyntheticTargetId;
+    private _syncSessionManagerFromTabs;
+    get_or_create_cdp_session(page?: Page | null): Promise<any>;
     private _waitForStableNetwork;
     private _setActivePage;
+    private _captureClosedPopupMessage;
+    private _getClosedPopupMessagesSnapshot;
+    private _recordRecentEvent;
+    private _getRecentEventsSummary;
+    private _attachDialogHandler;
+    private _getPendingNetworkRequests;
     get tabs(): TabInfo[];
     get active_tab_index(): number;
     get active_tab(): TabInfo;
     describe(): string;
     get _owns_browser_resources(): boolean;
+    get is_stopping(): boolean;
     claim_agent(agentId: string, mode?: 'exclusive' | 'shared'): boolean;
     claimAgent(agentId: string, mode?: 'exclusive' | 'shared'): boolean;
     release_agent(agentId?: string): boolean;
@@ -84,7 +128,7 @@ export declare class BrowserSession {
     private _launchChromiumWithSandboxFallback;
     private _connectionDescriptor;
     toString(): string;
-    private get logger();
+    get logger(): import("../logging-config.js").Logger;
     start(): Promise<this>;
     /**
      * Setup browser session by connecting to an existing browser process via PID
@@ -104,11 +148,44 @@ export declare class BrowserSession {
     get_current_page(): Promise<import("playwright-core").Page | null>;
     update_current_page(page: Page | null, title?: string | null, url?: string | null): void;
     private _buildTabs;
-    navigate_to(url: string, options?: BrowserActionOptions): Promise<import("playwright-core").Page | null>;
-    create_new_tab(url: string, options?: BrowserActionOptions): Promise<import("playwright-core").Page | null>;
+    navigate_to(url: string, options?: BrowserNavigationOptions): Promise<import("playwright-core").Page | null>;
+    create_new_tab(url: string, options?: BrowserNavigationOptions): Promise<import("playwright-core").Page | null>;
     private _resolveTabIndex;
-    switch_to_tab(identifier: number, options?: BrowserActionOptions): Promise<import("playwright-core").Page | null>;
-    close_tab(identifier: number): Promise<void>;
+    switch_to_tab(identifier: number | string, options?: BrowserActionOptions): Promise<import("playwright-core").Page | null>;
+    close_tab(identifier: number | string): Promise<void>;
+    wait(seconds: number, options?: BrowserActionOptions): Promise<void>;
+    send_keys(keys: string, options?: BrowserActionOptions): Promise<void>;
+    click_coordinates(coordinate_x: number, coordinate_y: number, options?: BrowserActionOptions & {
+        button?: 'left' | 'right' | 'middle';
+    }): Promise<void>;
+    scroll(direction: 'up' | 'down' | 'left' | 'right', amount: number, options?: BrowserActionOptions & {
+        node?: DOMElementNode | null;
+    }): Promise<void>;
+    scroll_to_text(text: string, options?: BrowserActionOptions & {
+        direction?: 'up' | 'down';
+    }): Promise<void>;
+    get_dropdown_options(element_node: DOMElementNode, options?: BrowserActionOptions): Promise<{
+        type: string;
+        options: string;
+        formatted_options: any;
+        message: any;
+        short_term_memory: any;
+        long_term_memory: string;
+    }>;
+    select_dropdown_option(element_node: DOMElementNode, text: string, options?: BrowserActionOptions): Promise<{
+        message: string;
+        short_term_memory: string;
+        long_term_memory: string;
+        matched_text: string;
+        matched_value: string;
+    } | {
+        message: string;
+        short_term_memory: string;
+        long_term_memory: string;
+        matched_text: string;
+        matched_value?: undefined;
+    }>;
+    upload_file(element_node: DOMElementNode, file_path: string, options?: BrowserActionOptions): Promise<void>;
     go_back(options?: BrowserActionOptions): Promise<void>;
     get_dom_element_by_index(_index: number, options?: BrowserActionOptions): Promise<DOMElementNode>;
     set_downloaded_files(files: string[]): void;
@@ -199,10 +276,11 @@ export declare class BrowserSession {
     off_response(callback: (response: any) => void | Promise<void>): Promise<void>;
     /**
      * Get information about all open tabs
-     * @returns Array of tab information including page_id, url, and title
+     * @returns Array of tab information including page_id, tab_id, url, and title
      */
     get_tabs_info(): Promise<Array<{
         page_id: number;
+        tab_id: string;
         url: string;
         title: string;
     }>>;
@@ -231,12 +309,12 @@ export declare class BrowserSession {
      * @param include_screenshot - Include screenshot in state summary
      * @returns BrowserStateSummary with current page state
      */
-    get_state_summary(cache_clickable_elements_hashes?: boolean, include_screenshot?: boolean): Promise<BrowserStateSummary>;
+    get_state_summary(cache_clickable_elements_hashes?: boolean, include_screenshot?: boolean, include_recent_events?: boolean): Promise<BrowserStateSummary>;
     /**
      * Get minimal state summary without DOM processing, but with screenshot
      * Used when page is in error state or unresponsive
      */
-    get_minimal_state_summary(): Promise<BrowserStateSummary>;
+    get_minimal_state_summary(include_recent_events?: boolean): Promise<BrowserStateSummary>;
     /**
      * Internal method to get updated browser state with DOM processing
      * @param focus_element - Element index to focus on (default: -1)
@@ -247,6 +325,8 @@ export declare class BrowserSession {
      * Check if a URL is a new tab page
      */
     private _is_new_tab_page;
+    private _is_ip_address_host;
+    private _get_domain_variants;
     /**
      * Check if page is displaying a PDF
      */
@@ -283,7 +363,10 @@ export declare class BrowserSession {
      * Check if a URL is allowed based on allowed_domains configuration
      * @param url - URL to check
      */
+    private _get_url_access_denial_reason;
     private _is_url_allowed;
+    private _formatDomainCollection;
+    private _assert_url_allowed;
     /**
      * Navigate helper with URL validation
      */
@@ -305,6 +388,15 @@ export declare class BrowserSession {
      * Remove all highlights from the current page
      */
     remove_highlights(): Promise<void>;
+    /**
+     * Start tracing on browser context if traces_dir is configured
+     * Note: Currently optional as it may cause performance issues in some cases
+     */
+    start_trace_recording(): Promise<void>;
+    /**
+     * Save browser trace recording if active
+     */
+    save_trace_recording(): Promise<void>;
     /**
      * Start tracing on browser context if traces_dir is configured
      * Note: Currently optional as it may cause performance issues in some cases