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

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, Eq, Clone)]
pub enum FieldsChannel {
    Description,
    Icon,
    DefaultPermissions,
}