moon_pdk_api 2.0.3

Core APIs for creating moon WASM plugins.
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
108
109
110
111
112
113
114
115
116
117
118

use crate::is_false;
use serde_json::Value as JsonValue;
use warpgate_api::{api_enum, api_struct};

api_enum!(
    /// The type of prompt to render to receive an answer.
    #[derive(Default)]
    #[serde(tag = "type", rename_all = "kebab-case")]
    pub enum PromptType {
        #[default]
        #[doc(hidden)]
        None,

        /// A confirmation prompt.
        Confirm { default: bool },

        /// A text input field.
        Input { default: String },

        /// A select field with options.
        Select {
            default_index: usize,
            options: Vec<JsonValue>,
        },
    }
);

// api_struct!(
//     pub struct Prompt {
//         pub question: String,
//         pub required: bool,
//         pub ty: PromptType,
//     }
// );

api_struct!(
    /// Represents a prompt (question) for a configuration setting.
    #[serde(default)]
    pub struct SettingPrompt {
        /// A condition to evaluate on whether to render this prompt.
        #[serde(skip_serializing_if = "Option::is_none")]
        pub condition: Option<SettingCondition>,

        /// Description of what the setting will do.
        #[serde(skip_serializing_if = "Option::is_none")]
        pub description: Option<String>,

        /// Will be rendered in the minimal initialization flow.
        #[serde(skip_serializing_if = "is_false")]
        pub minimal: bool,

        /// Nested prompts to render if the answer is truthy.
        #[serde(skip_serializing_if = "Vec::is_empty")]
        pub prompts: Vec<SettingPrompt>,

        /// The question to prompt the user.
        pub question: String,

        /// Whether this prompt is required or optional.
        #[serde(skip_serializing_if = "is_false")]
        pub required: bool,

        /// Name of the setting to inject. Supports dot notation.
        pub setting: String,

        /// Skip injecting this setting if the answer is falsy.
        #[serde(skip_serializing_if = "is_false")]
        pub skip_if_falsy: bool,

        /// Type of prompt to render.
        pub ty: PromptType,
    }
);

impl SettingPrompt {
    /// Create a new minimal setting.
    pub fn new(setting: impl AsRef<str>, question: impl AsRef<str>, ty: PromptType) -> Self {
        Self {
            minimal: true,
            question: question.as_ref().into(),
            required: true,
            setting: setting.as_ref().into(),
            ty,
            ..Default::default()
        }
    }

    /// Create a new full (non-minimal) setting.
    pub fn new_full(setting: impl AsRef<str>, question: impl AsRef<str>, ty: PromptType) -> Self {
        let mut prompt = Self::new(setting, question, ty);
        prompt.minimal = false;
        prompt
    }
}

api_enum!(
    /// A type of condition to evaluate against a setting value.
    #[derive(Default)]
    #[serde(tag = "op", content = "match", rename_all = "kebab-case")]
    pub enum ConditionType {
        BoolEquals(bool),
        #[default]
        Exists,
        FloatEquals(f64),
        IntEquals(i64),
        NotExists,
        StringContains(String),
        StringEquals(String),
    }
);

api_struct!(
    /// Represents a condition against another setting.
    pub struct SettingCondition {
        pub op: ConditionType,
        pub setting: String,
    }
);