viewpoint_cdp/protocol/target_domain/
mod.rs

1//! Target domain types.
2//!
3//! The Target domain supports inspecting, attaching to, and managing Chrome targets.
4
5use serde::{Deserialize, Serialize};
6
7/// Information about a target.
8#[derive(Debug, Clone, Deserialize)]
9#[serde(rename_all = "camelCase")]
10pub struct TargetInfo {
11    /// Target identifier.
12    pub target_id: String,
13    /// Target type (e.g., "page", "`background_page`", "`service_worker`").
14    #[serde(rename = "type")]
15    pub target_type: String,
16    /// Target title.
17    pub title: String,
18    /// Target URL.
19    pub url: String,
20    /// Whether the target is attached.
21    pub attached: bool,
22    /// Browser context ID if this target belongs to a context.
23    pub browser_context_id: Option<String>,
24    /// Opener target ID (the target that opened this one, for popups).
25    pub opener_id: Option<String>,
26}
27
28/// Parameters for Target.createBrowserContext.
29#[derive(Debug, Clone, Serialize, Default)]
30#[serde(rename_all = "camelCase")]
31pub struct CreateBrowserContextParams {
32    /// Whether to create a context without any proxy.
33    #[serde(skip_serializing_if = "Option::is_none")]
34    pub dispose_on_detach: Option<bool>,
35    /// Proxy server, e.g., "<http://proxy.example.com:8080>".
36    #[serde(skip_serializing_if = "Option::is_none")]
37    pub proxy_server: Option<String>,
38    /// Bypass list for the proxy.
39    #[serde(skip_serializing_if = "Option::is_none")]
40    pub proxy_bypass_list: Option<String>,
41}
42
43/// Result of Target.createBrowserContext.
44#[derive(Debug, Clone, Deserialize)]
45#[serde(rename_all = "camelCase")]
46pub struct CreateBrowserContextResult {
47    /// Browser context ID.
48    pub browser_context_id: String,
49}
50
51/// Parameters for Target.disposeBrowserContext.
52#[derive(Debug, Clone, Serialize)]
53#[serde(rename_all = "camelCase")]
54pub struct DisposeBrowserContextParams {
55    /// Browser context ID to dispose.
56    pub browser_context_id: String,
57}
58
59/// Parameters for Target.createTarget.
60#[derive(Debug, Clone, Serialize)]
61#[serde(rename_all = "camelCase")]
62pub struct CreateTargetParams {
63    /// The initial URL the page will be navigated to.
64    pub url: String,
65    /// Frame width in pixels. Browser-controlled if unset.
66    #[serde(skip_serializing_if = "Option::is_none")]
67    pub width: Option<u32>,
68    /// Frame height in pixels. Browser-controlled if unset.
69    #[serde(skip_serializing_if = "Option::is_none")]
70    pub height: Option<u32>,
71    /// Browser context to create the page in.
72    #[serde(skip_serializing_if = "Option::is_none")]
73    pub browser_context_id: Option<String>,
74    /// Whether to begin with background tab.
75    #[serde(skip_serializing_if = "Option::is_none")]
76    pub background: Option<bool>,
77    /// Whether to create a new window.
78    #[serde(skip_serializing_if = "Option::is_none")]
79    pub new_window: Option<bool>,
80}
81
82/// Result of Target.createTarget.
83#[derive(Debug, Clone, Deserialize)]
84#[serde(rename_all = "camelCase")]
85pub struct CreateTargetResult {
86    /// The ID of the created target.
87    pub target_id: String,
88}
89
90/// Parameters for Target.attachToTarget.
91#[derive(Debug, Clone, Serialize)]
92#[serde(rename_all = "camelCase")]
93pub struct AttachToTargetParams {
94    /// Target ID to attach to.
95    pub target_id: String,
96    /// Enables "flat" access to the session via specifying sessionId.
97    #[serde(skip_serializing_if = "Option::is_none")]
98    pub flatten: Option<bool>,
99}
100
101/// Result of Target.attachToTarget.
102#[derive(Debug, Clone, Deserialize)]
103#[serde(rename_all = "camelCase")]
104pub struct AttachToTargetResult {
105    /// Session ID for the attached target.
106    pub session_id: String,
107}
108
109/// Parameters for Target.closeTarget.
110#[derive(Debug, Clone, Serialize)]
111#[serde(rename_all = "camelCase")]
112pub struct CloseTargetParams {
113    /// Target ID to close.
114    pub target_id: String,
115}
116
117/// Result of Target.closeTarget.
118#[derive(Debug, Clone, Deserialize)]
119pub struct CloseTargetResult {
120    /// Whether the target was closed successfully.
121    pub success: bool,
122}
123
124/// Parameters for Target.detachFromTarget.
125#[derive(Debug, Clone, Serialize)]
126#[serde(rename_all = "camelCase")]
127pub struct DetachFromTargetParams {
128    /// Session ID to detach from.
129    #[serde(skip_serializing_if = "Option::is_none")]
130    pub session_id: Option<String>,
131}
132
133/// Parameters for Target.getTargets.
134#[derive(Debug, Clone, Serialize, Default)]
135pub struct GetTargetsParams {
136    /// Filter targets by their types.
137    #[serde(skip_serializing_if = "Option::is_none")]
138    pub filter: Option<Vec<TargetFilter>>,
139}
140
141/// Target filter for getTargets.
142#[derive(Debug, Clone, Serialize)]
143#[serde(rename_all = "camelCase")]
144pub struct TargetFilter {
145    /// Target type to filter.
146    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
147    pub target_type: Option<String>,
148    /// Whether to exclude the target.
149    #[serde(skip_serializing_if = "Option::is_none")]
150    pub exclude: Option<bool>,
151}
152
153/// Result of Target.getTargets.
154#[derive(Debug, Clone, Deserialize)]
155#[serde(rename_all = "camelCase")]
156pub struct GetTargetsResult {
157    /// List of targets.
158    pub target_infos: Vec<TargetInfo>,
159}
160
161/// Result of Target.getBrowserContexts.
162#[derive(Debug, Clone, Deserialize)]
163#[serde(rename_all = "camelCase")]
164pub struct GetBrowserContextsResult {
165    /// List of browser context IDs.
166    pub browser_context_ids: Vec<String>,
167}
168
169/// Event: Target.targetCreated
170#[derive(Debug, Clone, Deserialize)]
171#[serde(rename_all = "camelCase")]
172pub struct TargetCreatedEvent {
173    /// Target info.
174    pub target_info: TargetInfo,
175}
176
177/// Event: Target.targetDestroyed
178#[derive(Debug, Clone, Deserialize)]
179#[serde(rename_all = "camelCase")]
180pub struct TargetDestroyedEvent {
181    /// Target ID.
182    pub target_id: String,
183}
184
185/// Event: Target.attachedToTarget
186#[derive(Debug, Clone, Deserialize)]
187#[serde(rename_all = "camelCase")]
188pub struct AttachedToTargetEvent {
189    /// Session ID.
190    pub session_id: String,
191    /// Target info.
192    pub target_info: TargetInfo,
193    /// Whether waiting for debugger.
194    pub waiting_for_debugger: bool,
195}
196
197/// Event: Target.targetInfoChanged
198///
199/// Issued when target info (e.g., title, URL, or visibility) changes.
200/// This can be used to detect when a tab becomes active.
201#[derive(Debug, Clone, Deserialize)]
202#[serde(rename_all = "camelCase")]
203pub struct TargetInfoChangedEvent {
204    /// Updated target info.
205    pub target_info: TargetInfo,
206}
207
208/// Parameters for Target.setDiscoverTargets.
209#[derive(Debug, Clone, Serialize)]
210#[serde(rename_all = "camelCase")]
211pub struct SetDiscoverTargetsParams {
212    /// Whether to discover targets.
213    pub discover: bool,
214}
215
216#[cfg(test)]
217mod tests {
218    use super::*;
219
220    #[test]
221    fn test_target_info_changed_event_deserialization() {
222        let json = r#"{
223            "targetInfo": {
224                "targetId": "ABC123",
225                "type": "page",
226                "title": "Example Page",
227                "url": "https://example.com",
228                "attached": true,
229                "browserContextId": "context-456"
230            }
231        }"#;
232
233        let event: TargetInfoChangedEvent = serde_json::from_str(json).unwrap();
234        assert_eq!(event.target_info.target_id, "ABC123");
235        assert_eq!(event.target_info.target_type, "page");
236        assert_eq!(event.target_info.title, "Example Page");
237        assert_eq!(event.target_info.url, "https://example.com");
238        assert!(event.target_info.attached);
239        assert_eq!(
240            event.target_info.browser_context_id,
241            Some("context-456".to_string())
242        );
243    }
244
245    #[test]
246    fn test_target_info_changed_event_without_context_id() {
247        let json = r#"{
248            "targetInfo": {
249                "targetId": "DEF789",
250                "type": "page",
251                "title": "Default Context Page",
252                "url": "about:blank",
253                "attached": false
254            }
255        }"#;
256
257        let event: TargetInfoChangedEvent = serde_json::from_str(json).unwrap();
258        assert_eq!(event.target_info.target_id, "DEF789");
259        assert!(!event.target_info.attached);
260        assert!(event.target_info.browser_context_id.is_none());
261        assert!(event.target_info.opener_id.is_none());
262    }
263
264    #[test]
265    fn test_target_created_event_deserialization() {
266        let json = r#"{
267            "targetInfo": {
268                "targetId": "target-123",
269                "type": "page",
270                "title": "New Tab",
271                "url": "chrome://newtab/",
272                "attached": false,
273                "openerId": "opener-456"
274            }
275        }"#;
276
277        let event: TargetCreatedEvent = serde_json::from_str(json).unwrap();
278        assert_eq!(event.target_info.target_id, "target-123");
279        assert_eq!(event.target_info.opener_id, Some("opener-456".to_string()));
280    }
281}
viewpoint_cdp/protocol/target_domain/mod.rs

viewpoint_cdp/protocol/target_domain/
mod.rs
