roder-protocol 0.1.0

Agentic software development tools and SDKs for Roder.
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

//! Protocol-facing DTOs for the `chrome/*` app-server methods.
//!
//! The shared browser-bridge contract lives in [`roder_api::chrome`]; the status
//! and tab/browser/permission record types are re-exported here so SDK clients
//! and the app-server handlers share one definition. The request param structs
//! below describe the JSON-RPC payloads accepted by `AppServer`.
//!
//! Browser page content, console output, and network metadata forwarded through
//! these methods are **untrusted**: dispatch results are passed through verbatim
//! as opaque `serde_json::Value` and must not be treated as instructions.

use serde::{Deserialize, Serialize};

pub use roder_api::chrome::{
    ChromeBrowser, ChromeCommand, ChromeError, ChromePermissionMode, ChromeSitePermission,
    ChromeStatus, ChromeTab,
};

/// Params for `chrome/enable`. Optionally sets the permission mode.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ChromeEnableParams {
    /// `observe` | `assist` | `control`.
    #[serde(default)]
    pub mode: Option<String>,
}

/// Params for `chrome/setMode`.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ChromeSetModeParams {
    /// `observe` | `assist` | `control`.
    pub mode: String,
}

/// Params for `chrome/tabs/activate`.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ChromeTabActivateParams {
    pub tab_id: i64,
}

/// Params for `chrome/tabs/navigate`.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ChromeNavigateParams {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub tab_id: Option<i64>,
    pub url: String,
}

/// Params for `chrome/page/snapshot`.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ChromePageSnapshotParams {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub tab_id: Option<i64>,
    /// Optional list of snapshot sections to include (e.g. `["dom","text"]`).
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub include: Vec<String>,
}

/// Params for `chrome/page/action`.
///
/// `action` selects the wire command (`page/<action>`); all other fields are
/// forwarded to the extension untouched via [`extra`](Self::extra).
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ChromePageActionParams {
    /// One of: click, type, keypress, scroll, select, screenshot, highlight, eval.
    pub action: String,
    /// Remaining action-specific parameters, forwarded verbatim.
    #[serde(flatten)]
    pub extra: serde_json::Map<String, serde_json::Value>,
}

/// Params for `chrome/debug/console` and `chrome/debug/network`.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ChromeDebugReadParams {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub tab_id: Option<i64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
}

/// Params for `chrome/permissions/list`.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ChromePermissionsListParams {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub origin: Option<String>,
}

/// Params for `chrome/permissions/update`.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ChromePermissionsUpdateParams {
    pub origin: String,
    /// The permission bits to apply for `origin`, forwarded verbatim.
    pub perms: serde_json::Value,
}