filthy-rich 1.0.3

//! Return types for various functions and closures for filthy-rich. Most of these do not need to be
//! imported separately as these are already supplied to you, and are clonable and can be debugged.
//!
use serde::Deserialize;
use serde_json::Value;

use crate::{ds, str, types::payloads::ActivityPayload};

/// Data received in response from the server after sending a SET_ACTIVITY command.
///
/// Note that this struct doesn't fully cover the schema of the actual response since most of the fields
/// that are found are the same as the actual activity that is sent.
///
/// More importantly, open-source implementations of RPC (e.g. arRPC) have different response styles so
/// the actual output of this struct may vary depending on what client you are using.
#[derive(Debug, Clone, Deserialize)]
pub struct ActivityResponseData {
    application_id: Option<String>,
    platform: Option<String>,
    metadata: Option<Value>,
    /// The activity payload which came in response to the send.
    #[serde(flatten)]
    pub activity: ActivityPayload,
}

impl ActivityResponseData {
    ds!(application_id, "The ID of the application");
    ds!(platform, "The platform of the host.");

    #[must_use]
    pub fn metadata(&self) -> Option<&Value> {
        self.metadata.as_ref()
    }
}

/// Data received from a READY event.
#[derive(Debug, Clone, Deserialize)]
pub struct ReadyData {
    v: u8,
    /// The server configuration data for the RPC.
    pub config: ServerConfigurationData,
    /// The user to whom you are connected.
    pub user: DiscordUser,
}

impl ReadyData {
    /// The version of the RPC that is being used.
    #[must_use]
    pub fn version(&self) -> u8 {
        self.v
    }
}

/// Server configuration data received from the RPC server.
#[derive(Debug, Clone, Deserialize)]
pub struct ServerConfigurationData {
    cdn_host: String,
    api_endpoint: String,
    environment: String,
}

impl ServerConfigurationData {
    str!(cdn_host, "The CDN for the RPC server.");
    str!(api_endpoint, "The API endpoint for the RPC server.");
    str!(environment, "The environment for the RPC server.");
}

/// Represents the Discord user that the RPC connection is present with.
///
/// NOTE: Only the fields which may need a documentation have been given one.
#[derive(Debug, Clone, Deserialize)]
pub struct DiscordUser {
    id: String,
    username: String,
    discriminator: String,
    global_name: Option<String>,
    avatar: Option<String>,
    bot: Option<bool>,
    system: Option<bool>,
    mfa_enabled: Option<bool>,
    banner: Option<String>,
    accent_color: Option<isize>,
    locale: Option<String>,
    verified: Option<bool>,
    email: Option<String>,
    flags: Option<isize>,
    premium_type: Option<isize>,
    public_flags: Option<isize>,
    /// Data for the user's avatar decoration.
    pub avatar_decoration_data: Option<AvatarDecorationData>,
    /// Data for the user's collectibles.
    pub collectibles: Option<Collectibles>,
    /// The user's primary guild.
    pub primary_guild: Option<PrimaryGuild>,
}

impl DiscordUser {
    str!(id, "The user's ID.");
    str!(
        username,
        "The user's username, not unique across the platform."
    );
    str!(discriminator, "The user's Discord-tag.");

    ds!(global_name, "The user's display name, if set.");
    ds!(avatar, "The user's avatar hash.");

    /// Whether the user belongs to an OAuth2 application.
    #[must_use]
    pub fn bot(&self) -> Option<bool> {
        self.bot
    }

    /// Whether the user is an Official Discord System user (part of the urgent message system).
    #[must_use]
    pub fn system(&self) -> Option<bool> {
        self.system
    }

    /// Whether the user has two factor enabled on their account.
    #[must_use]
    pub fn mfa_enabled(&self) -> Option<bool> {
        self.mfa_enabled
    }

    ds!(banner, "The user's banner hash.");
    ds!(locale, "The user's chosen language option.");
    ds!(email, "The user's email.");

    /// Whether the email on this account has been verified.
    #[must_use]
    pub fn verified(&self) -> Option<bool> {
        self.verified
    }

    /// The user's banner color encoded as an integer representation of hexadecimal color code.
    #[must_use]
    pub fn accent_color(&self) -> Option<isize> {
        self.accent_color
    }

    /// The flags on the user's account.
    #[must_use]
    pub fn flags(&self) -> Option<isize> {
        self.flags
    }

    /// The type of Nitro subscription on the user's account.
    #[must_use]
    pub fn premium_type(&self) -> Option<isize> {
        self.premium_type
    }

    /// The public flags on the user's account.
    #[must_use]
    pub fn public_flags(&self) -> Option<isize> {
        self.public_flags
    }
}

/// The data for the user’s avatar decoration.
#[derive(Debug, Clone, Deserialize)]
pub struct AvatarDecorationData {
    asset: String,
    sku_id: String,
}

impl AvatarDecorationData {
    str!(
        asset,
        "The avatar decoration hash. See: <https://docs.discord.com/developers/reference#image-formatting>"
    );
    str!(sku_id, "ID of the avatar decoration's SKU.");
}

/// The collectibles the user has, excluding Avatar Decorations and Profile Effects.
#[derive(Debug, Clone, Deserialize)]
pub struct Collectibles {
    /// The nameplate the user has.
    pub nameplate: Option<NameplateData>,
}

#[derive(Debug, Clone, Deserialize)]
pub struct NameplateData {
    sku_id: String,
    asset: String,
    label: String,
    palette: String,
}

impl NameplateData {
    str!(sku_id, "ID of the nameplate SKU.");
    str!(
        asset,
        "Path to the nameplate asset. See: <https://docs.discord.com/developers/reference#image-formatting>"
    );
    str!(label, "The label of this nameplate. Currently unused.");
    str!(
        palette,
        "Background color of the nameplate, one of: `crimson`, `berry`, `sky`, `teal`, `forest`, `bubble_gum`, `violet`, `cobalt`, `clover`, `lemon`, `white`"
    );
}

#[derive(Debug, Clone, Deserialize)]
pub struct PrimaryGuild {
    identity_guild_id: Option<String>,
    identity_enabled: Option<bool>,
    tag: Option<String>,
    badge: Option<String>,
}

impl PrimaryGuild {
    ds!(identity_guild_id, "The ID of the user's primary guild.");
    ds!(
        tag,
        "The text of the user's server tag. Limited to 4 characters."
    );
    ds!(badge, "The server tag badge hash.");

    /// Whether the user is displaying the primary guild’s server tag.
    /// This can be `None` if the system clears the identity, e.g. the server no longer supports tags.
    /// This will be `false` if the user manually removes their tag.
    #[must_use]
    pub fn identity_enabled(&self) -> Option<bool> {
        self.identity_enabled
    }
}