systemprompt-models 0.1.18

Shared data models and types for systemprompt.io OS
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
119
120
121
122
123
124
125
126

use anyhow::Result;
use serde::{Deserialize, Deserializer, Serialize};
use std::path::PathBuf;
pub use systemprompt_extension::{SchemaSource, SeedSource};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Module {
    #[serde(skip_deserializing, default = "generate_uuid")]
    pub uuid: String,
    pub name: String,
    pub version: String,
    pub display_name: String,
    pub description: Option<String>,
    pub weight: Option<i32>,
    #[serde(default)]
    pub dependencies: Vec<String>,
    pub schemas: Option<Vec<ModuleSchema>>,
    pub seeds: Option<Vec<ModuleSeed>>,
    pub permissions: Option<Vec<ModulePermission>>,
    #[serde(default)]
    pub audience: Vec<String>,
    #[serde(skip_deserializing, default)]
    pub enabled: bool,
    #[serde(default)]
    pub api: Option<ApiConfig>,
    #[serde(skip)]
    pub path: PathBuf,
}

impl Module {
    pub fn parse(content: &str, module_path: PathBuf) -> Result<Self> {
        let mut module: Self = serde_yaml::from_str(content)?;
        module.path = module_path;
        Ok(module)
    }
}

fn generate_uuid() -> String {
    uuid::Uuid::new_v4().to_string()
}

pub type ModuleDefinition = Module;

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ApiConfig {
    pub enabled: bool,
    #[serde(default)]
    pub path_prefix: Option<String>,
    #[serde(default)]
    pub openapi_path: Option<String>,
}

#[derive(Debug, Clone, Serialize)]
pub struct ModuleSchema {
    pub sql: SchemaSource,
    pub table: String,
    #[serde(default)]
    pub required_columns: Vec<String>,
}

#[derive(Deserialize)]
struct ModuleSchemaYaml {
    file: String,
    table: String,
    #[serde(default)]
    required_columns: Vec<String>,
}

impl<'de> Deserialize<'de> for ModuleSchema {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let yaml = ModuleSchemaYaml::deserialize(deserializer)?;
        Ok(Self {
            sql: SchemaSource::File(PathBuf::from(yaml.file)),
            table: yaml.table,
            required_columns: yaml.required_columns,
        })
    }
}

#[derive(Debug, Clone, Serialize)]
pub struct ModuleSeed {
    pub sql: SeedSource,
    pub table: String,
    pub check_column: String,
    pub check_value: String,
}

#[derive(Deserialize)]
struct ModuleSeedYaml {
    file: String,
    table: String,
    check_column: String,
    check_value: String,
}

impl<'de> Deserialize<'de> for ModuleSeed {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let yaml = ModuleSeedYaml::deserialize(deserializer)?;
        Ok(Self {
            sql: SeedSource::File(PathBuf::from(yaml.file)),
            table: yaml.table,
            check_column: yaml.check_column,
            check_value: yaml.check_value,
        })
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ModulePermission {
    pub name: String,
    pub description: String,
    pub resource: String,
    pub action: String,
}

#[derive(Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum ModuleType {
    Regular,
    Proxy,
}