a3s-use-core 0.2.8

Shared typed contracts for A3S Use domains
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

use std::fmt;
use std::str::FromStr;

use serde::de::Error as _;
use serde::{Deserialize, Deserializer, Serialize};

use crate::{UseError, UseResult};

use super::contract_error;
use super::validation::valid_segment;

const PACKAGE_ID_ERROR: &str = "use.plugin.package_id_invalid";

/// Canonical A3S Use package identity in `<publisher>/<name>` form.
///
/// Host and control-plane contracts use this value object instead of
/// restating package-ID validation at every boundary.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize)]
#[serde(transparent)]
pub struct PluginPackageId(String);

impl PluginPackageId {
    pub fn parse(value: impl Into<String>) -> UseResult<Self> {
        let value = value.into();
        if !Self::is_valid(&value) {
            return Err(package_id_error(
                "Plugin package IDs must use canonical '<publisher>/<name>' form.",
            ));
        }
        Ok(Self(value))
    }

    pub fn as_str(&self) -> &str {
        &self.0
    }

    pub fn component_id(&self) -> String {
        format!("use/{}", self.0)
    }

    pub fn into_string(self) -> String {
        self.0
    }

    pub(crate) fn is_valid(value: &str) -> bool {
        let Some((publisher, name)) = value.split_once('/') else {
            return false;
        };
        !name.contains('/') && valid_segment(publisher) && valid_segment(name)
    }
}

impl<'de> Deserialize<'de> for PluginPackageId {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let value = String::deserialize(deserializer)?;
        Self::parse(value).map_err(D::Error::custom)
    }
}

impl fmt::Display for PluginPackageId {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(&self.0)
    }
}

impl AsRef<str> for PluginPackageId {
    fn as_ref(&self) -> &str {
        self.as_str()
    }
}

impl FromStr for PluginPackageId {
    type Err = UseError;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        Self::parse(value)
    }
}

impl TryFrom<String> for PluginPackageId {
    type Error = UseError;

    fn try_from(value: String) -> Result<Self, Self::Error> {
        Self::parse(value)
    }
}

fn package_id_error(message: impl Into<String>) -> UseError {
    contract_error(PACKAGE_ID_ERROR, message)
}