chore(monorepo): delta, january, quark

crates/quark/src/models/channels/channel.rs

@@ -0,0 +1,169 @@
+use std::collections::HashMap;
+
+use serde::{Deserialize, Serialize};
+
+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 channel on Revolt
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone)]
+#[serde(tag = "channel_type")]
+pub enum Channel {
+    /// Personal "Saved Notes" channel which allows users to save messages
+    SavedMessages {
+        /// Unique Id
+        #[serde(rename = "_id")]
+        id: String,
+        /// Id of the user this channel belongs to
+        user: String,
+    },
+    /// Direct message channel between two users
+    DirectMessage {
+        /// Unique Id
+        #[serde(rename = "_id")]
+        id: String,
+
+        /// Whether this direct message channel is currently open on both sides
+        active: bool,
+        /// 2-tuple of user ids participating in direct message
+        recipients: Vec<String>,
+        /// Id of the last message sent in this channel
+        #[serde(skip_serializing_if = "Option::is_none")]
+        last_message_id: Option<String>,
+    },
+    /// Group channel between 1 or more participants
+    Group {
+        /// Unique Id
+        #[serde(rename = "_id")]
+        id: String,
+
+        /// Display name of the channel
+        name: String,
+        /// User id of the owner of the group
+        owner: String,
+        /// Channel description
+        #[serde(skip_serializing_if = "Option::is_none")]
+        description: Option<String>,
+        /// Array of user ids participating in channel
+        recipients: Vec<String>,
+
+        /// Custom icon attachment
+        #[serde(skip_serializing_if = "Option::is_none")]
+        icon: Option<File>,
+        /// Id of the last message sent in this channel
+        #[serde(skip_serializing_if = "Option::is_none")]
+        last_message_id: Option<String>,
+
+        /// Permissions assigned to members of this group
+        /// (does not apply to the owner of the group)
+        #[serde(skip_serializing_if = "Option::is_none")]
+        permissions: Option<i64>,
+
+        /// Whether this group is marked as not safe for work
+        #[serde(skip_serializing_if = "if_false", default)]
+        nsfw: bool,
+    },
+    /// Text channel belonging to a server
+    TextChannel {
+        /// Unique Id
+        #[serde(rename = "_id")]
+        id: String,
+        /// Id of the server this channel belongs to
+        server: String,
+
+        /// Display name of the channel
+        name: String,
+        /// Channel description
+        #[serde(skip_serializing_if = "Option::is_none")]
+        description: Option<String>,
+
+        /// Custom icon attachment
+        #[serde(skip_serializing_if = "Option::is_none")]
+        icon: Option<File>,
+        /// Id of the last message sent in this channel
+        #[serde(skip_serializing_if = "Option::is_none")]
+        last_message_id: Option<String>,
+
+        /// Default permissions assigned to users in this channel
+        #[serde(skip_serializing_if = "Option::is_none")]
+        default_permissions: Option<OverrideField>,
+        /// Permissions assigned based on role to this channel
+        #[serde(
+            default = "HashMap::<String, OverrideField>::new",
+            skip_serializing_if = "HashMap::<String, OverrideField>::is_empty"
+        )]
+        role_permissions: HashMap<String, OverrideField>,
+
+        /// Whether this channel is marked as not safe for work
+        #[serde(skip_serializing_if = "if_false", default)]
+        nsfw: bool,
+    },
+    /// Voice channel belonging to a server
+    VoiceChannel {
+        /// Unique Id
+        #[serde(rename = "_id")]
+        id: String,
+        /// Id of the server this channel belongs to
+        server: String,
+
+        /// Display name of the channel
+        name: String,
+        #[serde(skip_serializing_if = "Option::is_none")]
+        /// Channel description
+        description: Option<String>,
+        /// Custom icon attachment
+        #[serde(skip_serializing_if = "Option::is_none")]
+        icon: Option<File>,
+
+        /// Default permissions assigned to users in this channel
+        #[serde(skip_serializing_if = "Option::is_none")]
+        default_permissions: Option<OverrideField>,
+        /// Permissions assigned based on role to this channel
+        #[serde(
+            default = "HashMap::<String, OverrideField>::new",
+            skip_serializing_if = "HashMap::<String, OverrideField>::is_empty"
+        )]
+        role_permissions: HashMap<String, OverrideField>,
+
+        /// Whether this channel is marked as not safe for work
+        #[serde(skip_serializing_if = "if_false", default)]
+        nsfw: bool,
+    },
+}
+
+/// Partial values of [Channel]
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Default, Clone)]
+pub struct PartialChannel {
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub name: Option<String>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub owner: Option<String>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub description: Option<String>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub icon: Option<File>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub nsfw: Option<bool>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub active: Option<bool>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub permissions: Option<i64>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub role_permissions: Option<HashMap<String, OverrideField>>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub default_permissions: Option<OverrideField>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub last_message_id: Option<String>,
+}
+
+/// Optional fields on channel object
+#[derive(Serialize, Deserialize, JsonSchema, Debug, PartialEq, Clone)]
+pub enum FieldsChannel {
+    Description,
+    Icon,
+    DefaultPermissions,
+}

crates/quark/src/models/channels/channel_invite.rs

@@ -0,0 +1,32 @@
+use serde::{Deserialize, Serialize};
+
+/// Representation of an invite to a channel on Revolt
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone)]
+#[serde(tag = "type")]
+pub enum Invite {
+    /// Invite to a specific server channel
+    Server {
+        /// Invite code
+        #[serde(rename = "_id")]
+        code: String,
+        /// Id of the server this invite points to
+        server: String,
+        /// Id of user who created this invite
+        creator: String,
+        /// Id of the server channel this invite points to
+        channel: String,
+    },
+    /// Invite to a group channel
+    Group {
+        /// Invite code
+        #[serde(rename = "_id")]
+        code: String,
+        /// Id of user who created this invite
+        creator: String,
+        /// Id of the group channel this invite points to
+        channel: String,
+    }, /* User {
+           code: String,
+           user: String
+       } */
+}

crates/quark/src/models/channels/channel_unread.rs

@@ -0,0 +1,25 @@
+use serde::{Deserialize, Serialize};
+
+/// Composite primary key consisting of channel and user id
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone)]
+pub struct ChannelCompositeKey {
+    /// Channel Id
+    pub channel: String,
+    /// User Id
+    pub user: String,
+}
+
+/// Representation of the state of a channel from the perspective of a user
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone)]
+pub struct ChannelUnread {
+    /// Composite key pointing to a user's view of a channel
+    #[serde(rename = "_id")]
+    pub id: ChannelCompositeKey,
+
+    /// Id of the last message read in this channel by a user
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub last_id: Option<String>,
+    /// Array of message ids that mention the user
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub mentions: Option<Vec<String>>,
+}

crates/quark/src/models/channels/message.rs

@@ -0,0 +1,170 @@
+use serde::{Deserialize, Serialize};
+use validator::Validate;
+
+use iso8601_timestamp::Timestamp;
+
+#[cfg(feature = "rocket_impl")]
+use rocket::FromFormField;
+
+use crate::{
+    models::{attachment::File, Member, User},
+    types::january::Embed,
+};
+
+/// # Reply
+///
+/// Representation of a message reply before it is sent.
+#[derive(Serialize, Deserialize, JsonSchema, Clone, Debug)]
+pub struct Reply {
+    /// Message Id
+    pub id: String,
+    /// Whether this reply should mention the message's author
+    pub mention: bool,
+}
+
+/// Representation of a text embed before it is sent.
+#[derive(Validate, Serialize, Deserialize, JsonSchema, Clone, Debug)]
+pub struct SendableEmbed {
+    #[validate(length(min = 1, max = 128))]
+    pub icon_url: Option<String>,
+    pub url: Option<String>,
+    #[validate(length(min = 1, max = 100))]
+    pub title: Option<String>,
+    #[validate(length(min = 1, max = 2000))]
+    pub description: Option<String>,
+    pub media: Option<String>,
+    #[validate(length(min = 1, max = 64))]
+    pub colour: Option<String>,
+}
+
+/// Representation of a system event message
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone)]
+#[serde(tag = "type")]
+pub enum SystemMessage {
+    #[serde(rename = "text")]
+    Text { content: String },
+    #[serde(rename = "user_added")]
+    UserAdded { id: String, by: String },
+    #[serde(rename = "user_remove")]
+    UserRemove { id: String, by: String },
+    #[serde(rename = "user_joined")]
+    UserJoined { id: String },
+    #[serde(rename = "user_left")]
+    UserLeft { id: String },
+    #[serde(rename = "user_kicked")]
+    UserKicked { id: String },
+    #[serde(rename = "user_banned")]
+    UserBanned { id: String },
+    #[serde(rename = "channel_renamed")]
+    ChannelRenamed { name: String, by: String },
+    #[serde(rename = "channel_description_changed")]
+    ChannelDescriptionChanged { by: String },
+    #[serde(rename = "channel_icon_changed")]
+    ChannelIconChanged { by: String },
+}
+
+/// Name and / or avatar override information
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone, Validate)]
+pub struct Masquerade {
+    /// Replace the display name shown on this message
+    #[serde(skip_serializing_if = "Option::is_none")]
+    #[validate(length(min = 1, max = 32))]
+    pub name: Option<String>,
+    /// Replace the avatar shown on this message (URL to image file)
+    #[serde(skip_serializing_if = "Option::is_none")]
+    #[validate(length(min = 1, max = 128))]
+    pub avatar: Option<String>,
+}
+
+/// Representation of a Message on Revolt
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone, OptionalStruct, Default)]
+#[optional_derive(Serialize, Deserialize, JsonSchema, Debug, Default, Clone)]
+#[optional_name = "PartialMessage"]
+#[opt_skip_serializing_none]
+#[opt_some_priority]
+pub struct Message {
+    /// Unique Id
+    #[serde(rename = "_id")]
+    pub id: String,
+    /// Unique value generated by client sending this message
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub nonce: Option<String>,
+    /// Id of the channel this message was sent in
+    pub channel: String,
+    /// Id of the user that sent this message
+    pub author: String,
+
+    /// Message content
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub content: Option<String>,
+    /// System message
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub system: Option<SystemMessage>,
+    /// Array of attachments
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub attachments: Option<Vec<File>>,
+    /// Time at which this message was last edited
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub edited: Option<Timestamp>,
+    /// Attached embeds to this message
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub embeds: Option<Vec<Embed>>,
+    /// Array of user ids mentioned in this message
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub mentions: Option<Vec<String>>,
+    /// Array of message ids this message is replying to
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub replies: Option<Vec<String>>,
+    /// Name and / or avatar overrides for this message
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub masquerade: Option<Masquerade>,
+}
+
+/// # Message Sort
+///
+/// Sort used for retrieving messages
+#[derive(Serialize, Deserialize, JsonSchema)]
+#[cfg_attr(feature = "rocket_impl", derive(FromFormField))]
+pub enum MessageSort {
+    /// Sort by the most relevant messages
+    Relevance,
+    /// Sort by the newest messages first
+    Latest,
+    /// Sort by the oldest messages first
+    Oldest,
+}
+
+impl Default for MessageSort {
+    fn default() -> MessageSort {
+        MessageSort::Relevance
+    }
+}
+
+/// # Bulk Message Response
+///
+/// Response used when multiple messages are fetched
+#[derive(Serialize, JsonSchema)]
+#[serde(untagged)]
+pub enum BulkMessageResponse {
+    JustMessages(
+        /// List of messages
+        Vec<Message>,
+    ),
+    MessagesAndUsers {
+        /// List of messages
+        messages: Vec<Message>,
+        /// List of users
+        users: Vec<User>,
+        /// List of members
+        #[serde(skip_serializing_if = "Option::is_none")]
+        members: Option<Vec<Member>>,
+    },
+}
+
+/// # Appended Information
+#[derive(Serialize, Deserialize, Debug, Clone)]
+pub struct AppendMessage {
+    /// Additional embeds to include in this message
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub embeds: Option<Vec<Embed>>,
+}