codex-rs/protocol/src/capabilities.rs

use codex_utils_path_uri::LegacyAppPathString;
use codex_utils_path_uri::PathUri;
use schemars::JsonSchema;
use serde::Deserialize;
use serde::Serialize;
use ts_rs::TS;

/// A user-selected root that can expose one or more runtime capabilities.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema, TS)]
#[serde(rename_all = "camelCase")]
#[ts(export_to = "v2/")]
pub struct SelectedCapabilityRoot {
    /// Stable identifier supplied by the capability selection platform.
    pub id: String,
    /// Where the selected root can be resolved.
    pub location: CapabilityRootLocation,
}

/// Location used to resolve a selected capability root.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema, TS)]
#[serde(tag = "type", rename_all = "camelCase")]
#[ts(tag = "type")]
#[ts(export_to = "v2/")]
pub enum CapabilityRootLocation {
    /// A path owned by an execution environment.
    Environment {
        #[serde(rename = "environmentId")]
        #[ts(rename = "environmentId")]
        environment_id: String,
        /// Absolute path for the root in the selected environment.
        #[serde(deserialize_with = "deserialize_path_uri_from_api_path")]
        #[schemars(with = "String")]
        #[ts(type = "string")]
        path: PathUri,
    },
}

fn deserialize_path_uri_from_api_path<'de, D>(deserializer: D) -> Result<PathUri, D::Error>
where
    D: serde::Deserializer<'de>,
{
    let path = LegacyAppPathString::deserialize(deserializer)?;
    if let Ok(path_uri) = PathUri::parse(path.as_str()) {
        return Ok(path_uri);
    }
    path.try_into().map_err(serde::de::Error::custom)
}

#[cfg(test)]
#[path = "capabilities_tests.rs"]
mod tests;