bmux_plugin_sdk 0.0.1-alpha.1

Plugin SDK for bmux — the types and traits plugin authors need
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

use crate::{PluginError, Result};
use serde::{Deserialize, Serialize};
use std::fmt;

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
pub struct HostScope(String);

impl HostScope {
    /// Create a new host scope from a capability identifier string.
    ///
    /// The value must be a non-empty ASCII lowercase string that may contain
    /// digits, hyphens, underscores, and dots.
    ///
    /// # Errors
    ///
    /// Returns [`PluginError::InvalidCapabilityId`] if the value does not
    /// conform to the capability identifier format.
    pub fn new(value: impl Into<String>) -> Result<Self> {
        let value = value.into();
        if is_valid_capability_id(&value) {
            Ok(Self(value))
        } else {
            Err(PluginError::InvalidCapabilityId { capability: value })
        }
    }

    #[must_use]
    pub const fn as_str(&self) -> &str {
        self.0.as_str()
    }

    #[must_use]
    pub fn is_hot_path(&self) -> bool {
        matches!(
            self.as_str(),
            "bmux.terminal.input_intercept" | "bmux.terminal.output_intercept"
        )
    }
}

impl fmt::Display for HostScope {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.as_str())
    }
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
pub struct PluginFeature(String);

impl PluginFeature {
    /// Create a new plugin feature from an identifier string.
    ///
    /// The value must be a non-empty ASCII lowercase string that may contain
    /// digits, hyphens, underscores, and dots.
    ///
    /// # Errors
    ///
    /// Returns [`PluginError::InvalidPluginFeature`] if the value does not
    /// conform to the capability identifier format.
    pub fn new(value: impl Into<String>) -> Result<Self> {
        let value = value.into();
        if is_valid_capability_id(&value) {
            Ok(Self(value))
        } else {
            Err(PluginError::InvalidPluginFeature { feature: value })
        }
    }

    #[must_use]
    pub const fn as_str(&self) -> &str {
        self.0.as_str()
    }
}

impl fmt::Display for PluginFeature {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.as_str())
    }
}

fn is_valid_capability_id(value: &str) -> bool {
    let mut chars = value.chars();
    let Some(first) = chars.next() else {
        return false;
    };
    if !first.is_ascii_lowercase() {
        return false;
    }
    chars.all(|ch| ch.is_ascii_lowercase() || ch.is_ascii_digit() || matches!(ch, '-' | '_' | '.'))
}

#[cfg(test)]
mod tests {
    use super::{HostScope, PluginFeature};

    #[test]
    fn host_scope_requires_stable_ascii_format() {
        assert!(HostScope::new("bmux.sessions.read").is_ok());
        assert!(HostScope::new("Bmux.Sessions.Read").is_err());
    }

    #[test]
    fn plugin_feature_requires_stable_ascii_format() {
        assert!(PluginFeature::new("acme.timeline").is_ok());
        assert!(PluginFeature::new("Acme.Timeline").is_err());
    }
}