feat(types): add rustmail_types crate for shared types

Author: Akinator31

Cargo.lock

@@ -1,3 +1,3 @@
 [workspace]
-members = ["rustmail", "rustmail_panel"]
+members = ["rustmail", "rustmail_panel", "rustmail_types"]
 resolver = "3"

Cargo.toml

@@ -5,6 +5,7 @@ edition = "2024"
 license = "MIT"
 
 [dependencies]
+rustmail_types = { path = "../rustmail_types" }
 serde = { version = "*", features = ["derive"] }
 serenity = "0.12.4"
 sqlx = { version = "0.8.6", features = ["runtime-tokio", "sqlite", "macros", "migrate"] }
@@ -24,8 +25,6 @@ serde_json = "1.0.145"
 rand = "0.8.5"
 base64 = "0.22.1"
 subtle = "2.6.1"
-chrono-tz = "0.10.4"
-console-subscriber = "0.4.1"
 
 [dependencies.uuid]
 version = "1.18.1"

rustmail/Cargo.toml

@@ -5,20 +5,20 @@ edition = "2024"
 license = "MIT"
 
 [dependencies]
+rustmail_types = { path = "../rustmail_types" }
 yew = { version = "0.21", features = ["csr"] }
 yew-router = "0.18.0"
 wasm-bindgen-futures = "0.4.50"
 gloo-net = "0.6.0"
 gloo-utils = "0.2.0"
-web-sys = "0.3.77"
+web-sys = { version = "0.3.77", features = ["HtmlSelectElement"] }
 serde_json = "1.0.145"
 i18nrs = { version = "0.1.7", features = ["yew"] }
-tailyew = "0.1.38"
 serde = { version = "1.0.228", features = ["derive"] }
 js-sys = "0.3.77"
 wasm-bindgen = "0.2.100"
 urlencoding = "2.1.3"
 ammonia = "4.1.2"
 pulldown-cmark = "0.13.0"
-[build-dependencies]
-navigator = "0.3.0"
+chrono-tz = { version = "0.10", features = ["serde"] }
+[build-dependencies]

rustmail_panel/Cargo.toml

@@ -0,0 +1,9 @@
+[package]
+name = "rustmail_types"
+version = "0.1.1"
+edition = "2024"
+license = "MIT"
+
+[dependencies]
+serde = { version = "1.0", features = ["derive"] }
+chrono-tz = { version = "0.10", features = ["serde"] }

rustmail_types/Cargo.toml

@@ -0,0 +1,14 @@
+use crate::config::*;
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
+pub struct ConfigResponse {
+    pub bot: BotConfig,
+    pub command: CommandConfig,
+    pub thread: ThreadConfig,
+    pub language: LanguageConfig,
+    pub error_handling: ErrorHandlingConfig,
+    pub notifications: NotificationsConfig,
+    pub reminders: ReminderConfig,
+    pub logs: LogsConfig,
+}

rustmail_types/src/api/mod.rs

@@ -0,0 +1,114 @@
+use chrono_tz::Tz;
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
+pub struct BotConfig {
+    pub token: String,
+    pub mode: ServerMode,
+    pub status: String,
+    pub welcome_message: String,
+    pub close_message: String,
+    pub typing_proxy_from_user: bool,
+    pub typing_proxy_from_staff: bool,
+    pub enable_logs: bool,
+    pub enable_features: bool,
+    pub enable_panel: bool,
+    pub client_id: u64,
+    pub client_secret: String,
+    pub redirect_url: String,
+    #[serde(
+        default = "default_timezone",
+        deserialize_with = "deserialize_timezone",
+        serialize_with = "serialize_timezone"
+    )]
+    pub timezone: Tz,
+    #[serde(default)]
+    pub logs_channel_id: Option<u64>,
+    #[serde(default)]
+    pub features_channel_id: Option<u64>,
+    #[serde(default)]
+    pub ip: Option<String>,
+}
+
+#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
+#[serde(tag = "type", rename_all = "lowercase")]
+pub enum ServerMode {
+    Single { guild_id: u64 },
+    Dual {
+        community_guild_id: u64,
+        staff_guild_id: u64,
+    },
+}
+
+impl BotConfig {
+    pub fn get_community_guild_id(&self) -> u64 {
+        match &self.mode {
+            ServerMode::Single { guild_id } => *guild_id,
+            ServerMode::Dual { community_guild_id, .. } => *community_guild_id,
+        }
+    }
+
+    pub fn get_staff_guild_id(&self) -> u64 {
+        match &self.mode {
+            ServerMode::Single { guild_id } => *guild_id,
+            ServerMode::Dual { staff_guild_id, .. } => *staff_guild_id,
+        }
+    }
+
+    pub fn is_dual_mode(&self) -> bool {
+        matches!(self.mode, ServerMode::Dual { .. })
+    }
+
+    pub fn validate_logs_config(&self) -> Result<(), String> {
+        match (self.enable_logs, self.logs_channel_id) {
+            (true, None) => {
+                Err("'logs_channel_id' field is required if 'enable_logs' is true".to_string())
+            }
+            (false, Some(_)) => {
+                Err("'logs_channel_id' must not be filled in if 'enable_logs' is false".to_string())
+            }
+            (true, Some(_)) => Ok(()),
+            (false, None) => Ok(()),
+        }
+    }
+
+    pub fn validate_features_config(&self) -> Result<(), String> {
+        match (self.enable_features, self.features_channel_id) {
+            (true, None) => Err(
+                "'features_channel_id' field is required if 'enable_features' is true".to_string(),
+            ),
+            (false, Some(_)) => Err(
+                "'features_channel_id' must not be filled in if 'enable_features' is false"
+                    .to_string(),
+            ),
+            (true, Some(_)) => Ok(()),
+            (false, None) => Ok(()),
+        }
+    }
+
+    pub fn is_community_guild(&self, guild_id: u64) -> bool {
+        match &self.mode {
+            ServerMode::Single { guild_id: gid } => *gid == guild_id,
+            ServerMode::Dual { community_guild_id, .. } => *community_guild_id == guild_id,
+        }
+    }
+}
+
+fn deserialize_timezone<'de, D>(deserializer: D) -> Result<Tz, D::Error>
+where
+    D: serde::Deserializer<'de>,
+{
+    let s: String = Deserialize::deserialize(deserializer)?;
+    s.parse::<Tz>().map_err(serde::de::Error::custom)
+}
+
+fn serialize_timezone<S>(tz: &Tz, serializer: S) -> Result<S::Ok, S::Error>
+where
+    S: serde::Serializer,
+{
+    serializer.serialize_str(&tz.to_string())
+}
+
+fn default_timezone() -> Tz {
+    chrono_tz::UTC
+}

rustmail_types/src/config/bot.rs

@@ -0,0 +1,14 @@
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
+pub struct CommandConfig {
+    pub prefix: String,
+}
+
+impl Default for CommandConfig {
+    fn default() -> Self {
+        Self {
+            prefix: "!".to_string(),
+        }
+    }
+}

rustmail_types/src/config/commands.rs

@@ -0,0 +1,29 @@
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
+pub struct ErrorHandlingConfig {
+    pub show_detailed_errors: bool,
+    pub log_errors: bool,
+    pub send_error_embeds: bool,
+    pub auto_delete_error_messages: bool,
+    pub error_message_ttl: Option<u64>,
+    #[serde(default = "default_display_errors")]
+    pub display_errors: bool,
+}
+
+fn default_display_errors() -> bool {
+    true
+}
+
+impl Default for ErrorHandlingConfig {
+    fn default() -> Self {
+        Self {
+            show_detailed_errors: true,
+            log_errors: true,
+            send_error_embeds: true,
+            auto_delete_error_messages: false,
+            error_message_ttl: None,
+            display_errors: true,
+        }
+    }
+}

rustmail_types/src/config/error_handling.rs

@@ -0,0 +1,18 @@
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Deserialize, Serialize, Clone, PartialEq)]
+pub struct LanguageConfig {
+    pub default_language: String,
+    pub fallback_language: String,
+    pub supported_languages: Vec<String>,
+}
+
+impl Default for LanguageConfig {
+    fn default() -> Self {
+        Self {
+            default_language: "en".to_string(),
+            fallback_language: "en".to_string(),
+            supported_languages: vec!["en".to_string(), "fr".to_string()],
+        }
+    }
+}