adaptive-card-core 0.1.0

Pure-Rust library for validating, optimizing, and transforming Microsoft Adaptive Cards v1.6
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
103
104
105
106
107

//! Host capability matrix.
//!
//! Values derived from official Microsoft Adaptive Cards documentation:
//! - <https://learn.microsoft.com/en-us/adaptive-cards/resources/partners>
//! - <https://adaptivecards.microsoft.com/?topic=hostConfig>
//!
//! Update this table when Microsoft publishes new host capability info.

use crate::types::{CardVersion, Host};

/// Element types supported on every host (core set).
pub const UNIVERSAL_ELEMENTS: &[&str] = &[
    "TextBlock",
    "Image",
    "Container",
    "ColumnSet",
    "Column",
    "FactSet",
    "ImageSet",
    "ActionSet",
    "Input.Text",
    "Input.Number",
    "Input.Date",
    "Input.Time",
    "Input.Toggle",
    "Input.ChoiceSet",
];

/// Element types newer than v1.3 — not supported on hosts capped at v1.3.
pub const ELEMENTS_V1_5_PLUS: &[&str] = &["Table", "TableCell", "TableRow"];
pub const ELEMENTS_V1_2_PLUS: &[&str] = &["RichTextBlock"];
pub const ELEMENTS_V1_6_PLUS: &[&str] = &["CodeBlock"];
pub const ELEMENTS_V1_1_PLUS: &[&str] = &["Media"];

/// Action types that need Action.Execute support (v1.4+ for most hosts).
pub const ACTIONS_V1_4_PLUS: &[&str] = &["Action.Execute"];

/// Return all elements a host supports.
#[must_use]
pub fn supported_elements(host: Host) -> Vec<&'static str> {
    let mut out: Vec<&'static str> = UNIVERSAL_ELEMENTS.to_vec();

    let max = host.max_version();

    if max >= CardVersion::V1_1 && host != Host::Outlook {
        out.extend(ELEMENTS_V1_1_PLUS);
    }
    if max >= CardVersion::V1_2 {
        out.extend(ELEMENTS_V1_2_PLUS);
    }
    if max >= CardVersion::V1_5 {
        out.extend(ELEMENTS_V1_5_PLUS);
    }
    if max >= CardVersion::V1_6 {
        out.extend(ELEMENTS_V1_6_PLUS);
    }
    out
}

/// Return all actions a host supports.
#[must_use]
pub fn supported_actions(host: Host) -> Vec<&'static str> {
    let mut out = vec![
        "Action.OpenUrl",
        "Action.Submit",
        "Action.ShowCard",
        "Action.ToggleVisibility",
    ];
    if host.supports_action("Action.Execute") {
        out.push("Action.Execute");
    }
    out
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn generic_supports_everything_up_to_v1_6() {
        let els = supported_elements(Host::Generic);
        assert!(els.contains(&"Table"));
        assert!(els.contains(&"CodeBlock"));
        assert!(els.contains(&"TextBlock"));
    }

    #[test]
    fn webex_excludes_table_and_codeblock() {
        let els = supported_elements(Host::Webex);
        assert!(!els.contains(&"Table"));
        assert!(!els.contains(&"CodeBlock"));
    }

    #[test]
    fn outlook_excludes_media_and_codeblock() {
        let els = supported_elements(Host::Outlook);
        assert!(!els.contains(&"Media"));
        assert!(!els.contains(&"CodeBlock"));
    }

    #[test]
    fn webex_supported_actions_exclude_execute() {
        let acts = supported_actions(Host::Webex);
        assert!(!acts.contains(&"Action.Execute"));
        assert!(acts.contains(&"Action.Submit"));
    }
}