chore(monorepo): delta, january, quark

crates/quark/src/models/servers/server.rs

@@ -0,0 +1,150 @@
+use std::collections::HashMap;
+
+use num_enum::TryFromPrimitive;
+use serde::{Deserialize, Serialize};
+use validator::Validate;
+
+use crate::{models::attachment::File, OverrideField};
+
+/// Utility function to check if a boolean value is false
+pub fn if_false(t: &bool) -> bool {
+    !t
+}
+
+/// Representation of a server role
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone, OptionalStruct, Default)]
+#[optional_derive(Serialize, Deserialize, JsonSchema, Debug, Clone, Default)]
+#[optional_name = "PartialRole"]
+#[opt_skip_serializing_none]
+#[opt_some_priority]
+pub struct Role {
+    /// Role name
+    pub name: String,
+    /// Permissions available to this role
+    pub permissions: OverrideField,
+    /// Colour used for this role
+    ///
+    /// This can be any valid CSS colour
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub colour: Option<String>,
+    /// Whether this role should be shown separately on the member sidebar
+    #[serde(skip_serializing_if = "if_false", default)]
+    pub hoist: bool,
+    /// Ranking of this role
+    #[serde(default)]
+    pub rank: i64,
+}
+
+/// Channel category
+#[derive(Validate, Serialize, Deserialize, JsonSchema, Debug, Clone)]
+pub struct Category {
+    /// Unique ID for this category
+    #[validate(length(min = 1, max = 32))]
+    pub id: String,
+    /// Title for this category
+    #[validate(length(min = 1, max = 32))]
+    pub title: String,
+    /// Channels in this category
+    pub channels: Vec<String>,
+}
+
+/// System message channel assignments
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone)]
+pub struct SystemMessageChannels {
+    /// ID of channel to send user join messages in
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub user_joined: Option<String>,
+    /// ID of channel to send user left messages in
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub user_left: Option<String>,
+    /// ID of channel to send user kicked messages in
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub user_kicked: Option<String>,
+    /// ID of channel to send user banned messages in
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub user_banned: Option<String>,
+}
+
+/// Server flag enum
+#[derive(Debug, PartialEq, Eq, TryFromPrimitive, Copy, Clone)]
+#[repr(i32)]
+pub enum ServerFlags {
+    Verified = 1,
+    Official = 2,
+}
+
+/// Representation of a server on Revolt
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone, OptionalStruct, Default)]
+#[optional_derive(Serialize, Deserialize, JsonSchema, Debug, Default, Clone)]
+#[optional_name = "PartialServer"]
+#[opt_skip_serializing_none]
+#[opt_some_priority]
+pub struct Server {
+    /// Unique Id
+    #[serde(rename = "_id")]
+    pub id: String,
+    /// User id of the owner
+    pub owner: String,
+
+    /// Name of the server
+    pub name: String,
+    /// Description for the server
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub description: Option<String>,
+
+    /// Channels within this server
+    // ! FIXME: this may be redundant
+    pub channels: Vec<String>,
+    /// Categories for this server
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub categories: Option<Vec<Category>>,
+    /// Configuration for sending system event messages
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub system_messages: Option<SystemMessageChannels>,
+
+    /// Roles for this server
+    #[serde(
+        default = "HashMap::<String, Role>::new",
+        skip_serializing_if = "HashMap::<String, Role>::is_empty"
+    )]
+    pub roles: HashMap<String, Role>,
+    /// Default set of server and channel permissions
+    pub default_permissions: i64,
+
+    /// Icon attachment
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub icon: Option<File>,
+    /// Banner attachment
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub banner: Option<File>,
+
+    /// Enum of server flags
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub flags: Option<i32>,
+
+    /// Whether this server is flagged as not safe for work
+    #[serde(skip_serializing_if = "if_false", default)]
+    pub nsfw: bool,
+    /// Whether to enable analytics
+    #[serde(skip_serializing_if = "if_false", default)]
+    pub analytics: bool,
+    /// Whether this server should be publicly discoverable
+    #[serde(skip_serializing_if = "if_false", default)]
+    pub discoverable: bool,
+}
+
+/// Optional fields on server object
+#[derive(Serialize, Deserialize, JsonSchema, Debug, PartialEq, Clone)]
+pub enum FieldsServer {
+    Description,
+    Categories,
+    SystemMessages,
+    Icon,
+    Banner,
+}
+
+/// Optional fields on server object
+#[derive(Serialize, Deserialize, JsonSchema, Debug, PartialEq, Clone)]
+pub enum FieldsRole {
+    Colour,
+}

crates/quark/src/models/servers/server_ban.rs

@@ -0,0 +1,13 @@
+use serde::{Deserialize, Serialize};
+
+use super::server_member::MemberCompositeKey;
+
+/// Representation of a server ban on Revolt
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone)]
+pub struct ServerBan {
+    /// Unique member id
+    #[serde(rename = "_id")]
+    pub id: MemberCompositeKey,
+    /// Reason for ban creation
+    pub reason: Option<String>,
+}

crates/quark/src/models/servers/server_member.rs

@@ -0,0 +1,50 @@
+use serde::{Deserialize, Serialize};
+
+use crate::models::attachment::File;
+
+/// Composite primary key consisting of server and user id
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone, Default)]
+pub struct MemberCompositeKey {
+    /// Server Id
+    pub server: String,
+    /// User Id
+    pub user: String,
+}
+
+/// Representation of a member of a server on Revolt
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone, OptionalStruct, Default)]
+#[optional_derive(Serialize, Deserialize, JsonSchema, Debug, Default, Clone)]
+#[optional_name = "PartialMember"]
+#[opt_skip_serializing_none]
+#[opt_some_priority]
+pub struct Member {
+    /// Unique member id
+    #[serde(rename = "_id")]
+    pub id: MemberCompositeKey,
+
+    /// Member's nickname
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub nickname: Option<String>,
+    /// Avatar attachment
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub avatar: Option<File>,
+
+    /// Member's roles
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub roles: Option<Vec<String>>,
+}
+
+/// Optional fields on server member object
+#[derive(Serialize, Deserialize, JsonSchema, Debug, PartialEq, Clone)]
+pub enum FieldsMember {
+    Nickname,
+    Avatar,
+    Roles,
+}
+
+/// Member removal intention
+pub enum RemovalIntention {
+    Leave,
+    Kick,
+    Ban,
+}