codetether-browser 0.1.0

Browser automation runtime for CodeTether
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

//! Browser command messages accepted by a [`BrowserSession`](crate::browser::BrowserSession).
//!
//! The command enum keeps tool-facing request parsing separate from the
//! session backend that executes each operation.

use super::request::{
    AxiosRequest, ClickTextRequest, CloseTabRequest, DiagnoseRequest, EvalRequest, FetchRequest,
    FillRequest, KeyPressRequest, NavigationRequest, NetworkLogRequest, NewTabRequest,
    ReplayRequest, ScopeRequest, ScreenshotRequest, ScrollRequest, SelectorRequest, StartRequest,
    TabSelectRequest, ToggleRequest, TypeRequest, UploadRequest, WaitRequest, XhrRequest,
};

/// Operation that can be executed against a browser session.
///
/// Variants carry the request payload needed by the native TetherScript backend
/// and by callers that route browserctl actions through the shared browser
/// service.
pub enum BrowserCommand {
    /// Report session health.
    Health,
    /// Start a browser session.
    Start(StartRequest),
    /// Stop the active browser session.
    Stop,
    /// Return a structured page snapshot.
    Snapshot,
    /// Navigate the current tab.
    Goto(NavigationRequest),
    /// Move back in the current tab history.
    Back,
    /// Reload the current tab.
    Reload,
    /// Wait for a selector or timeout.
    Wait(WaitRequest),
    /// Click an element by selector.
    Click(SelectorRequest),
    /// Move the pointer over an element by selector.
    Hover(SelectorRequest),
    /// Focus an element by selector.
    Focus(SelectorRequest),
    /// Blur an element by selector.
    Blur(SelectorRequest),
    /// Scroll the current page or selected element.
    Scroll(ScrollRequest),
    /// Upload files through an input element.
    Upload(UploadRequest),
    /// Fill an input-like element.
    Fill(FillRequest),
    /// Type text into the active page.
    Type(TypeRequest),
    /// Press a keyboard key.
    Press(KeyPressRequest),
    /// Read text content.
    Text(ScopeRequest),
    /// Read HTML content.
    Html(ScopeRequest),
    /// Evaluate JavaScript in the current page.
    Eval(EvalRequest),
    /// Click by visible text.
    ClickText(ClickTextRequest),
    /// Fill an input through the native path.
    FillNative(FillRequest),
    /// Toggle a checkbox-like control.
    Toggle(ToggleRequest),
    /// Capture a screenshot.
    Screenshot(ScreenshotRequest),
    /// Click at page coordinates.
    MouseClick(super::request::PointerClick),
    /// Type raw keyboard text.
    KeyboardType(super::request::KeyboardTypeRequest),
    /// Press a named keyboard key.
    KeyboardPress(super::request::KeyboardPressRequest),
    /// List open tabs.
    Tabs,
    /// Select a tab by index.
    TabsSelect(TabSelectRequest),
    /// Open a new tab.
    TabsNew(NewTabRequest),
    /// Close a tab.
    TabsClose(CloseTabRequest),
    /// Return recorded network events.
    NetworkLog(NetworkLogRequest),
    /// Issue a fetch-style HTTP request.
    Fetch(FetchRequest),
    /// Issue an axios-style HTTP request.
    Axios(AxiosRequest),
    /// Issue an XHR-style HTTP request.
    Xhr(XhrRequest),
    /// Replay a captured HTTP request.
    Replay(ReplayRequest),
    /// Return backend diagnostics.
    Diagnose(DiagnoseRequest),
}