chore(monorepo): delta, january, quark

crates/quark/src/models/users/bot.rs

@@ -0,0 +1,63 @@
+use num_enum::TryFromPrimitive;
+use serde::{Deserialize, Serialize};
+
+/// Utility function to check if a boolean value is false
+pub fn if_false(t: &bool) -> bool {
+    !t
+}
+
+/// Bot flag enum
+#[derive(Debug, PartialEq, Eq, TryFromPrimitive, Copy, Clone)]
+#[repr(i32)]
+pub enum BotFlags {
+    Verified = 1,
+    Official = 2,
+}
+
+/// Representation of a bot on Revolt
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone, OptionalStruct, Default)]
+#[optional_derive(Serialize, Deserialize, JsonSchema, Debug, Default, Clone)]
+#[optional_name = "PartialBot"]
+#[opt_skip_serializing_none]
+#[opt_some_priority]
+pub struct Bot {
+    /// Bot Id
+    ///
+    /// This equals the associated bot user's id.
+    #[serde(rename = "_id")]
+    pub id: String,
+    /// User Id of the bot owner
+    pub owner: String,
+    /// Token used to authenticate requests for this bot
+    pub token: String,
+    /// Whether the bot is public
+    /// (may be invited by anyone)
+    pub public: bool,
+
+    /// Whether to enable analytics
+    #[serde(skip_serializing_if = "if_false", default)]
+    pub analytics: bool,
+    /// Whether this bot should be publicly discoverable
+    #[serde(skip_serializing_if = "if_false", default)]
+    pub discoverable: bool,
+    /// Reserved; URL for handling interactions
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub interactions_url: Option<String>,
+    /// URL for terms of service
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub terms_of_service_url: Option<String>,
+    /// URL for privacy policy
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub privacy_policy_url: Option<String>,
+
+    /// Enum of bot flags
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub flags: Option<i32>,
+}
+
+/// Optional fields on bot object
+#[derive(Serialize, Deserialize, JsonSchema, Debug, PartialEq)]
+pub enum FieldsBot {
+    Token,
+    InteractionsURL,
+}

crates/quark/src/models/users/user.rs

@@ -0,0 +1,177 @@
+use num_enum::TryFromPrimitive;
+use serde::{Deserialize, Serialize};
+use validator::Validate;
+
+use crate::models::attachment::File;
+
+/// Utility function to check if a boolean value is false
+pub fn if_false(t: &bool) -> bool {
+    !t
+}
+
+/// User's relationship with another user (or themselves)
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone, PartialEq)]
+pub enum RelationshipStatus {
+    None,
+    User,
+    Friend,
+    Outgoing,
+    Incoming,
+    Blocked,
+    BlockedOther,
+}
+
+/// Relationship entry indicating current status with other user
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone)]
+pub struct Relationship {
+    #[serde(rename = "_id")]
+    pub id: String,
+    pub status: RelationshipStatus,
+}
+
+/// Presence status
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone, PartialEq)]
+pub enum Presence {
+    Online,
+    Idle,
+    Busy,
+    Invisible,
+}
+
+/// User's active status
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone, Validate, Default)]
+pub struct UserStatus {
+    /// Custom status text
+    #[validate(length(min = 1, max = 128))]
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub text: Option<String>,
+    /// Current presence option
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub presence: Option<Presence>,
+}
+
+/// User's profile
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone, Default)]
+pub struct UserProfile {
+    /// Text content on user's profile
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub content: Option<String>,
+    /// Background visible on user's profile
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub background: Option<File>,
+}
+
+/// User badge bitfield
+#[derive(Debug, PartialEq, Eq, TryFromPrimitive, Copy, Clone)]
+#[repr(i32)]
+pub enum Badges {
+    /// Revolt Developer
+    Developer = 1,
+    /// Helped translate Revolt
+    Translator = 2,
+    /// Monetarily supported Revolt
+    Supporter = 4,
+    /// Responsibly disclosed a security issue
+    ResponsibleDisclosure = 8,
+    /// Revolt Founder
+    Founder = 16,
+    /// Platform moderator
+    PlatformModeration = 32,
+    /// Active monetary supporter
+    ActiveSupporter = 64,
+    /// 🦊🦝
+    Paw = 128,
+    /// Joined as one of the first 1000 users in 2021
+    EarlyAdopter = 256,
+    /// Amogus
+    ReservedRelevantJokeBadge1 = 512,
+    /// Low resolution troll face
+    ReservedRelevantJokeBadge2 = 1024,
+}
+
+/// User flag enum
+#[derive(Debug, PartialEq, Eq, TryFromPrimitive, Copy, Clone)]
+#[repr(i32)]
+pub enum Flags {
+    /// User has been suspended from the platform
+    Suspended = 1,
+    /// User has deleted their account
+    Deleted = 2,
+    /// User was banned off the platform
+    Banned = 4,
+}
+
+/// Bot information for if the user is a bot
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone)]
+pub struct BotInformation {
+    /// Id of the owner of this bot
+    pub owner: String,
+}
+
+/// Representiation of a User on Revolt.
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone, OptionalStruct, Default)]
+#[optional_derive(Serialize, Deserialize, Debug, Default, Clone)]
+#[optional_name = "PartialUser"]
+#[opt_skip_serializing_none]
+#[opt_some_priority]
+pub struct User {
+    /// Unique Id
+    #[serde(rename = "_id")]
+    pub id: String,
+    /// Username
+    pub username: String,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    /// Avatar attachment
+    pub avatar: Option<File>,
+    /// Relationships with other users
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub relations: Option<Vec<Relationship>>,
+
+    /// Bitfield of user badges
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub badges: Option<i32>,
+    /// User's current status
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub status: Option<UserStatus>,
+    /// User's profile page
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub profile: Option<UserProfile>,
+
+    /// Enum of user flags
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub flags: Option<i32>,
+    /// Whether this user is privileged
+    #[serde(skip_serializing_if = "if_false", default)]
+    pub privileged: bool,
+    /// Bot information
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub bot: Option<BotInformation>,
+
+    // ? Entries below should never be pushed to the database
+    /// Current session user's relationship with this user
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub relationship: Option<RelationshipStatus>,
+    /// Whether this user is currently online
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub online: Option<bool>,
+}
+
+/// Optional fields on user object
+#[derive(Serialize, Deserialize, JsonSchema, Debug, PartialEq, Clone)]
+pub enum FieldsUser {
+    Avatar,
+    StatusText,
+    StatusPresence,
+    ProfileContent,
+    ProfileBackground,
+}
+
+/// Enumeration providing a hint to the type of user we are handling
+pub enum UserHint {
+    /// Could be either a user or a bot
+    Any,
+    /// Only match bots
+    Bot,
+    /// Only match users
+    User,
+}

crates/quark/src/models/users/user_settings.rs

@@ -0,0 +1,6 @@
+use std::collections::HashMap;
+
+/// HashMap of user settings
+/// Each key is mapped to a tuple consisting of the
+/// revision timestamp and serialised data (in JSON format)
+pub type UserSettings = HashMap<String, (i64, String)>;