butterflow-models 0.1.1

A self-hostable workflow engine for code transformations
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

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use ts_rs::TS;

use crate::runtime::Runtime;
use crate::step::Step;

/// Represents a template input
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, TS)]
pub struct TemplateInput {
    /// Name of the input
    pub name: String,

    /// Type of the input (string, number, boolean)
    #[serde(default = "default_input_type")]
    pub r#type: String,

    /// Whether the input is required
    #[serde(default)]
    #[ts(optional, as = "Option<bool>")]
    pub required: bool,

    /// Description of the input
    #[serde(default)]
    pub description: Option<String>,

    /// Default value for the input
    #[serde(default)]
    pub default: Option<String>,
}

/// Represents a template output
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, TS)]
pub struct TemplateOutput {
    /// Name of the output
    pub name: String,

    /// Value of the output
    pub value: String,

    /// Description of the output
    #[serde(default)]
    pub description: Option<String>,
}

/// Represents a reusable template
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, TS)]
pub struct Template {
    /// Unique identifier for the template
    pub id: String,

    /// Human-readable name
    pub name: String,

    /// Detailed description of what the template does
    #[serde(default)]
    #[ts(optional=nullable)]
    pub description: Option<String>,

    /// Container runtime configuration
    #[serde(default)]
    #[ts(optional=nullable)]
    pub runtime: Option<Runtime>,

    /// Inputs for the template
    #[serde(default)]
    pub inputs: Vec<TemplateInput>,

    /// Steps to execute within the template
    pub steps: Vec<Step>,

    /// Outputs from the template
    #[serde(default)]
    #[ts(optional, as = "Option<Vec<TemplateOutput>>")]
    pub outputs: Vec<TemplateOutput>,

    /// Environment variables to inject into the container
    #[serde(default)]
    #[ts(as = "Option<HashMap<String, String>>", optional)]
    pub env: HashMap<String, String>,
}

fn default_input_type() -> String {
    "string".to_string()
}