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

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use ts_rs::TS;
/// Type of state schema property
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, JsonSchema, TS)]
#[serde(rename_all = "lowercase")]
pub enum StateSchemaType {
    /// Array type
    Array,

    /// Object type
    Object,

    /// String type
    String,

    /// Number type
    Number,

    /// Boolean type
    Boolean,
}

/// Represents a state schema property
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, TS)]
pub struct StateSchemaProperty {
    /// Type of the property
    pub r#type: StateSchemaType,

    /// Description of the property
    #[serde(default)]
    #[ts(optional=nullable)]
    pub description: Option<String>,
}

/// Represents a state schema definition
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, TS)]
pub struct StateSchema {
    /// Name of the state schema
    pub name: String,

    /// Type of the state schema
    pub r#type: StateSchemaType,

    /// For array types, the schema of the items
    #[serde(default)]
    #[ts(optional=nullable)]
    pub items: Option<Box<StateSchemaItems>>,

    /// Description of the state schema
    #[serde(default)]
    #[ts(optional=nullable)]
    pub description: Option<String>,
}

/// Represents the schema for items in an array
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, TS)]
pub struct StateSchemaItems {
    /// Type of the items
    pub r#type: StateSchemaType,

    /// For object types, the properties of the object
    #[serde(default)]
    #[ts(optional=nullable)]
    pub properties: Option<HashMap<String, StateSchemaProperty>>,
}