browser_commander/
lib.rs

1//! Browser Commander - Universal Browser Automation Library
2//!
3//! A Rust library for browser automation that provides a unified API
4//! for different browser automation engines.
5//!
6//! # Features
7//!
8//! - Unified API across multiple browser engines
9//! - Built-in navigation safety handling
10//! - Element visibility and scroll management
11//! - Click, fill, and other interaction support with verification
12//! - Async/await support with Tokio
13//!
14//! # Example
15//!
16//! ```rust,no_run
17//! use browser_commander::browser::{launch_browser, LaunchOptions};
18//!
19//! #[tokio::main]
20//! async fn main() -> anyhow::Result<()> {
21//!     // Launch a browser
22//!     let options = LaunchOptions::chromiumoxide().headless(true);
23//!     let result = launch_browser(options).await?;
24//!
25//!     // The returned `page` is an `Arc<dyn EngineAdapter>` and can be
26//!     // passed to any of the crate's navigation / interaction helpers.
27//!     let page = result.page.as_ref();
28//!     page.goto("https://example.com").await?;
29//!     println!("Current URL: {}", page.url().await?);
30//!
31//!     Ok(())
32//! }
33//! ```
34//!
35//! # Modules
36//!
37//! - [`core`] - Core types and traits (constants, engine adapter, logger)
38//! - [`elements`] - Element operations (selectors, visibility, content)
39//! - [`interactions`] - User interactions (click, scroll, fill)
40//! - [`browser`] - Browser management (launcher, navigation)
41//! - [`utilities`] - General utilities (URL handling, wait operations)
42//! - [`high_level`] - High-level DRY utilities
43
44pub mod browser;
45pub mod core;
46pub mod elements;
47pub mod high_level;
48pub mod interactions;
49pub mod utilities;
50
51// Re-export commonly used items at crate root
52pub use browser::{
53    build_real_browser_args, connect_browser, emulate_media, launch_and_connect_real_browser,
54    launch_browser, launch_real_browser, Browser, BrowserProcess, ChromiumoxidePage, ColorScheme,
55    ConnectOptions, EmulateMediaOptions, LaunchOptions, LaunchResult, NodeBridgePage,
56    RealBrowserLaunchResult, RealBrowserOptions,
57};
58pub use core::{
59    DialogEvent, DialogManager, DialogType, EngineAdapter, EngineError, EngineType, Logger,
60    LoggerOptions, PdfOptions, Timing, CHROME_ARGS, TIMING,
61};
62
63/// Prelude module for convenient imports.
64///
65/// Import everything commonly needed with:
66/// ```rust
67/// use browser_commander::prelude::*;
68/// ```
69pub mod prelude {
70    pub use crate::browser::{
71        connect_browser, emulate_media, goto, launch_and_connect_real_browser, launch_browser,
72        launch_real_browser, verify_navigation, wait_for_navigation, wait_for_url_stabilization,
73        Browser, BrowserProcess, ColorScheme, ConnectOptions, EmulateMediaOptions, LaunchOptions,
74        LaunchResult, NavigationOptions, NavigationResult, RealBrowserLaunchResult,
75        RealBrowserOptions, WaitUntil,
76    };
77    pub use crate::core::{
78        is_navigation_error, is_timeout_error, DialogEvent, DialogManager, DialogType,
79        EngineAdapter, EngineError, EngineType, Logger, LoggerOptions, PdfOptions, Timing,
80        CHROME_ARGS, TIMING,
81    };
82    pub use crate::elements::{
83        count, get_attribute, input_value, is_enabled, is_visible, normalize_selector,
84        text_content, ParsedSelector,
85    };
86    pub use crate::high_level::{
87        check_and_clear_flag, find_toggle_button, install_click_listener, wait_for_url_condition,
88    };
89    pub use crate::interactions::{
90        click_button, click_element, fill_text_area, key_down, key_up, perform_fill, press_key,
91        scroll_into_view, scroll_into_view_if_needed, type_text, ClickOptions, ClickResult,
92        FillOptions, FillResult, ScrollBehavior, ScrollOptions, ScrollResult,
93    };
94    pub use crate::utilities::{
95        evaluate, get_domain, get_url, parse_url, safe_evaluate, same_origin, unfocus_address_bar,
96        wait, wait_with_cancel, WaitResult,
97    };
98}
browser_commander/lib.rs

browser_commander/
lib.rs
