ferridriver 0.4.0

Browser automation in Rust with a Playwright-compatible API. Four pluggable backends: CDP pipe, CDP WebSocket, Playwright WebKit, Firefox BiDi.
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

//! Minimal serde-typed surface of Playwright's `WebKit` Inspector protocol.
//!
//! Method names follow the wire format (`Namespace.method`, e.g.
//! `Playwright.createContext`, `Page.navigate`). Constants are kept
//! as `&'static str` so callers can pass them to
//! [`crate::backend::webkit::Session::send`] without further
//! allocation.

use serde::{Deserialize, Serialize};

/// Top-level message envelope shared by requests, responses and
/// events. Per-target traffic is routed through `pageProxyId`.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Envelope {
  #[serde(default, skip_serializing_if = "Option::is_none")]
  pub id: Option<i64>,
  #[serde(default, skip_serializing_if = "Option::is_none")]
  pub method: Option<String>,
  #[serde(default, skip_serializing_if = "serde_json::Value::is_null")]
  pub params: serde_json::Value,
  #[serde(default, skip_serializing_if = "Option::is_none")]
  pub result: Option<serde_json::Value>,
  #[serde(default, skip_serializing_if = "Option::is_none")]
  pub error: Option<ErrorPayload>,
  #[serde(default, skip_serializing_if = "Option::is_none")]
  pub page_proxy_id: Option<String>,
}

#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct ErrorPayload {
  pub message: String,
  #[serde(default)]
  pub code: Option<i64>,
  #[serde(default)]
  pub data: Option<serde_json::Value>,
}

// ── Browser-session methods ────────────────────────────────────────────

pub const PLAYWRIGHT_ENABLE: &str = "Playwright.enable";
pub const PLAYWRIGHT_CLOSE: &str = "Playwright.close";
pub const PLAYWRIGHT_GET_INFO: &str = "Playwright.getInfo";
pub const PLAYWRIGHT_CREATE_CONTEXT: &str = "Playwright.createContext";
pub const PLAYWRIGHT_DELETE_CONTEXT: &str = "Playwright.deleteContext";
pub const PLAYWRIGHT_CREATE_PAGE: &str = "Playwright.createPage";
pub const PLAYWRIGHT_NAVIGATE: &str = "Playwright.navigate";
pub const PLAYWRIGHT_TAKE_SCREENSHOT: &str = "Playwright.takePageScreenshot";

// ── Browser-session events ─────────────────────────────────────────────

pub const EVT_PAGE_PROXY_CREATED: &str = "Playwright.pageProxyCreated";
pub const EVT_PAGE_PROXY_DESTROYED: &str = "Playwright.pageProxyDestroyed";

// ── Per-page-session methods (subset) ──────────────────────────────────

pub const PAGE_RELOAD: &str = "Page.reload";
pub const PAGE_GO_BACK: &str = "Page.goBack";
pub const PAGE_GO_FORWARD: &str = "Page.goForward";
pub const PAGE_NAVIGATE_WITHIN: &str = "Page.navigatedWithinDocument";
pub const RUNTIME_EVALUATE: &str = "Runtime.evaluate";
pub const RUNTIME_CALL_FUNCTION_ON: &str = "Runtime.callFunctionOn";
pub const RUNTIME_RELEASE_OBJECT: &str = "Runtime.releaseObject";
pub const DOM_QUERY_SELECTOR: &str = "DOM.querySelector";
pub const INPUT_DISPATCH_MOUSE: &str = "Input.dispatchMouseEvent";
pub const INPUT_DISPATCH_KEY: &str = "Input.dispatchKeyEvent";
pub const CONSOLE_ENABLE: &str = "Console.enable";

// ── Common parameter / return shapes ───────────────────────────────────

#[derive(Debug, Default, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct CreateContextParams {
  #[serde(skip_serializing_if = "Option::is_none")]
  pub proxy_server: Option<String>,
  #[serde(skip_serializing_if = "Option::is_none")]
  pub proxy_bypass_list: Option<String>,
}

#[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CreateContextResult {
  pub browser_context_id: String,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct CreatePageParams {
  #[serde(skip_serializing_if = "Option::is_none")]
  pub browser_context_id: Option<String>,
}

#[derive(Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CreatePageResult {
  pub page_proxy_id: String,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct NavigateParams {
  pub url: String,
  pub page_proxy_id: String,
  #[serde(skip_serializing_if = "Option::is_none")]
  pub frame_id: Option<String>,
  #[serde(skip_serializing_if = "Option::is_none")]
  pub referrer: Option<String>,
}

#[derive(Debug, Deserialize, Default)]
#[serde(rename_all = "camelCase")]
pub struct NavigateResult {
  #[serde(default)]
  pub loader_id: Option<String>,
  #[serde(default)]
  pub error_text: Option<String>,
}