use serde::Serialize;
use crate::uri::UiResourceUri;
#[derive(Debug, Default, Clone, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct ToolUi {
#[serde(skip_serializing_if = "Option::is_none")]
pub resource_uri: Option<UiResourceUri>,
#[serde(skip_serializing_if = "Option::is_none")]
pub visibility: Option<Vec<UiVisibility>>,
#[serde(skip)]
pub(crate) legacy_uri: bool,
}
impl ToolUi {
pub fn new(resource_uri: UiResourceUri) -> Self {
Self {
resource_uri: Some(resource_uri),
visibility: None,
legacy_uri: false,
}
}
pub fn with_legacy_uri(mut self) -> Self {
self.legacy_uri = true;
self
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum UiVisibility {
Model,
App,
}
#[derive(Debug, Default, Clone, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct ResourceUi {
#[serde(skip_serializing_if = "Option::is_none")]
pub csp: Option<UiCsp>,
#[serde(skip_serializing_if = "Option::is_none")]
pub permissions: Option<UiPermissions>,
#[serde(skip_serializing_if = "Option::is_none")]
pub domain: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub prefers_border: Option<bool>,
}
#[derive(Debug, Default, Clone, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct UiCsp {
#[serde(skip_serializing_if = "Option::is_none")]
pub connect_domains: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub resource_domains: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub frame_domains: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub base_uri_domains: Option<Vec<String>>,
}
#[derive(Debug, Default, Clone, PartialEq, Serialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct UiPermissions {
#[serde(skip_serializing_if = "Option::is_none")]
pub camera: Option<PermissionRequest>,
#[serde(skip_serializing_if = "Option::is_none")]
pub microphone: Option<PermissionRequest>,
#[serde(skip_serializing_if = "Option::is_none")]
pub geolocation: Option<PermissionRequest>,
#[serde(skip_serializing_if = "Option::is_none")]
pub clipboard_write: Option<PermissionRequest>,
}
#[derive(Debug, Default, Clone, PartialEq, Serialize)]
#[non_exhaustive]
pub struct PermissionRequest {}
impl PermissionRequest {
pub fn new() -> Self {
Self {}
}
}
#[cfg(test)]
mod tests {
use super::*;
use serde_json::json;
#[test]
fn resource_declarations_use_protocol_keys_and_permission_objects()
-> Result<(), serde_json::Error> {
let resource = ResourceUi {
csp: Some(UiCsp {
connect_domains: Some(vec!["wss://api.example.com".into()]),
resource_domains: Some(vec!["https://*.example.com".into()]),
frame_domains: Some(vec!["https://frame.example.com".into()]),
base_uri_domains: Some(vec!["https://base.example.com".into()]),
}),
permissions: Some(UiPermissions {
camera: Some(PermissionRequest::new()),
microphone: Some(PermissionRequest::new()),
geolocation: Some(PermissionRequest::new()),
clipboard_write: Some(PermissionRequest::new()),
}),
domain: Some("host-defined-sandbox".into()),
prefers_border: Some(false),
};
assert_eq!(
serde_json::to_value(resource)?,
json!({
"csp": {
"connectDomains": ["wss://api.example.com"],
"resourceDomains": ["https://*.example.com"],
"frameDomains": ["https://frame.example.com"],
"baseUriDomains": ["https://base.example.com"]
},
"permissions": {"camera": {}, "microphone": {}, "geolocation": {}, "clipboardWrite": {}},
"domain": "host-defined-sandbox",
"prefersBorder": false
})
);
Ok(())
}
#[test]
fn omissions_remain_distinct_from_explicit_empty_declarations()
-> Result<(), Box<dyn std::error::Error>> {
assert_eq!(serde_json::to_value(ToolUi::default())?, json!({}));
assert_eq!(serde_json::to_value(ResourceUi::default())?, json!({}));
let tool = ToolUi {
resource_uri: Some(UiResourceUri::new("ui://cart/view")?),
visibility: Some(vec![]),
..ToolUi::default()
}
.with_legacy_uri();
assert_eq!(
serde_json::to_value(tool)?,
json!({
"resourceUri": "ui://cart/view", "visibility": []
})
);
let resource = ResourceUi {
csp: Some(UiCsp {
connect_domains: Some(vec![]),
..UiCsp::default()
}),
permissions: Some(UiPermissions::default()),
..ResourceUi::default()
};
assert_eq!(
serde_json::to_value(resource)?,
json!({
"csp": {"connectDomains": []}, "permissions": {}
})
);
Ok(())
}
}