chore(monorepo): delta, january, quark

crates/delta/src/routes/bots/create.rs

@@ -0,0 +1,65 @@
+use crate::util::regex::RE_USERNAME;
+
+use nanoid::nanoid;
+use revolt_quark::{
+    models::{user::BotInformation, Bot, User},
+    variables::delta::MAX_BOT_COUNT,
+    Db, Error, Result,
+};
+
+use rocket::serde::json::Json;
+use serde::Deserialize;
+use ulid::Ulid;
+use validator::Validate;
+
+/// # Bot Details
+#[derive(Validate, Deserialize, JsonSchema)]
+pub struct DataCreateBot {
+    /// Bot username
+    #[validate(length(min = 2, max = 32), regex = "RE_USERNAME")]
+    name: String,
+}
+
+/// # Create Bot
+///
+/// Create a new Revolt bot.
+#[openapi(tag = "Bots")]
+#[post("/create", data = "<info>")]
+pub async fn create_bot(db: &Db, user: User, info: Json<DataCreateBot>) -> Result<Json<Bot>> {
+    if user.bot.is_some() {
+        return Err(Error::IsBot);
+    }
+
+    let info = info.into_inner();
+    info.validate()
+        .map_err(|error| Error::FailedValidation { error })?;
+
+    if db.get_number_of_bots_by_user(&user.id).await? >= *MAX_BOT_COUNT {
+        return Err(Error::ReachedMaximumBots);
+    }
+
+    if db.is_username_taken(&info.name).await? {
+        return Err(Error::UsernameTaken);
+    }
+
+    let id = Ulid::new().to_string();
+    let bot_user = User {
+        id: id.clone(),
+        username: info.name.trim().to_string(),
+        bot: Some(BotInformation {
+            owner: user.id.clone(),
+        }),
+        ..Default::default()
+    };
+
+    let bot = Bot {
+        id,
+        owner: user.id,
+        token: nanoid!(64),
+        ..Default::default()
+    };
+
+    db.insert_user(&bot_user).await?;
+    db.insert_bot(&bot).await?;
+    Ok(Json(bot))
+}

crates/delta/src/routes/bots/delete.rs

@@ -0,0 +1,19 @@
+use revolt_quark::{models::User, Db, EmptyResponse, Error, Ref, Result};
+
+/// # Delete Bot
+///
+/// Delete a bot by its id.
+#[openapi(tag = "Bots")]
+#[delete("/<target>")]
+pub async fn delete_bot(db: &Db, user: User, target: Ref) -> Result<EmptyResponse> {
+    if user.bot.is_some() {
+        return Err(Error::IsBot);
+    }
+
+    let bot = target.as_bot(db).await?;
+    if bot.owner != user.id {
+        return Err(Error::NotFound);
+    }
+
+    bot.delete(db).await.map(|_| EmptyResponse)
+}

crates/delta/src/routes/bots/edit.rs

@@ -0,0 +1,107 @@
+use crate::util::regex::RE_USERNAME;
+
+use revolt_quark::{
+    models::{
+        bot::{FieldsBot, PartialBot},
+        Bot, User,
+    },
+    Db, Error, Ref, Result,
+};
+
+use rocket::serde::json::Json;
+use serde::{Deserialize, Serialize};
+use validator::Validate;
+
+/// # Bot Details
+#[derive(Validate, Serialize, Deserialize, JsonSchema)]
+pub struct DataEditBot {
+    /// Bot username
+    #[validate(length(min = 2, max = 32), regex = "RE_USERNAME")]
+    #[serde(skip_serializing_if = "Option::is_none")]
+    name: Option<String>,
+    /// Whether the bot can be added by anyone
+    public: Option<bool>,
+    /// Whether analytics should be gathered for this bot
+    ///
+    /// Must be enabled in order to show up on [Revolt Discover](https://rvlt.gg).
+    analytics: Option<bool>,
+    /// Interactions URL
+    #[validate(length(min = 1, max = 2048))]
+    interactions_url: Option<String>,
+    /// Fields to remove from bot object
+    #[validate(length(min = 1))]
+    remove: Option<Vec<FieldsBot>>,
+}
+
+/// # Edit Bot
+///
+/// Edit bot details by its id.
+#[openapi(tag = "Bots")]
+#[patch("/<target>", data = "<data>")]
+pub async fn edit_bot(
+    db: &Db,
+    user: User,
+    target: Ref,
+    data: Json<DataEditBot>,
+) -> Result<Json<Bot>> {
+    if user.bot.is_some() {
+        return Err(Error::IsBot);
+    }
+
+    let data = data.into_inner();
+    data.validate()
+        .map_err(|error| Error::FailedValidation { error })?;
+
+    let mut bot = target.as_bot(db).await?;
+    if bot.owner != user.id {
+        return Err(Error::NotFound);
+    }
+
+    if let Some(name) = data.name {
+        if db.is_username_taken(&name).await? {
+            return Err(Error::UsernameTaken);
+        }
+
+        let mut user = db.fetch_user(&bot.id).await?;
+        user.update_username(db, name).await?;
+    }
+
+    if data.public.is_none()
+        && data.analytics.is_none()
+        && data.interactions_url.is_none()
+        && data.remove.is_none()
+    {
+        return Ok(Json(bot));
+    }
+
+    let DataEditBot {
+        public,
+        analytics,
+        interactions_url,
+        remove,
+        ..
+    } = data;
+
+    let mut partial = PartialBot {
+        public,
+        analytics,
+        interactions_url,
+        ..Default::default()
+    };
+
+    if let Some(remove) = &remove {
+        for field in remove {
+            bot.remove(field);
+        }
+
+        if remove.iter().any(|x| x == &FieldsBot::Token) {
+            partial.token = Some(bot.token.clone());
+        }
+    }
+
+    db.update_bot(&bot.id, &partial, remove.unwrap_or_default())
+        .await?;
+
+    bot.apply_options(partial);
+    Ok(Json(bot))
+}

crates/delta/src/routes/bots/fetch.rs

@@ -0,0 +1,36 @@
+use revolt_quark::{
+    models::{Bot, User},
+    Db, Error, Ref, Result,
+};
+use rocket::serde::json::Json;
+use serde::Serialize;
+
+/// # Bot Response
+#[derive(Serialize, JsonSchema)]
+pub struct BotResponse {
+    /// Bot object
+    bot: Bot,
+    /// User object
+    user: User,
+}
+
+/// # Fetch Bot
+///
+/// Fetch details of a bot you own by its id.
+#[openapi(tag = "Bots")]
+#[get("/<target>")]
+pub async fn fetch_bot(db: &Db, user: User, target: Ref) -> Result<Json<BotResponse>> {
+    if user.bot.is_some() {
+        return Err(Error::IsBot);
+    }
+
+    let bot = target.as_bot(db).await?;
+    if bot.owner != user.id {
+        return Err(Error::NotFound);
+    }
+
+    Ok(Json(BotResponse {
+        user: db.fetch_user(&bot.id).await?.foreign(),
+        bot,
+    }))
+}

crates/delta/src/routes/bots/fetch_owned.rs

@@ -0,0 +1,42 @@
+use revolt_quark::{
+    models::{Bot, User},
+    Db, Error, Result,
+};
+use rocket::serde::json::Json;
+use serde::Serialize;
+
+/// # Owned Bots Response
+///
+/// Both lists are sorted by their IDs.
+#[derive(Serialize, JsonSchema)]
+pub struct OwnedBotsResponse {
+    /// Bot objects
+    bots: Vec<Bot>,
+    /// User objects
+    users: Vec<User>,
+}
+
+/// # Fetch Owned Bots
+///
+/// Fetch all of the bots that you have control over.
+#[openapi(tag = "Bots")]
+#[get("/@me")]
+pub async fn fetch_owned_bots(db: &Db, user: User) -> Result<Json<OwnedBotsResponse>> {
+    if user.bot.is_some() {
+        return Err(Error::IsBot);
+    }
+
+    let mut bots = db.fetch_bots_by_user(&user.id).await?;
+    let user_ids = bots
+        .iter()
+        .map(|x| x.id.to_owned())
+        .collect::<Vec<String>>();
+
+    let mut users = db.fetch_users(&user_ids).await?;
+
+    // Ensure the lists match up exactly.
+    bots.sort_by(|a, b| a.id.cmp(&b.id));
+    users.sort_by(|a, b| a.id.cmp(&b.id));
+
+    Ok(Json(OwnedBotsResponse { users, bots }))
+}

crates/delta/src/routes/bots/fetch_public.rs

@@ -0,0 +1,44 @@
+use revolt_quark::{
+    models::{File, User},
+    Db, Error, Ref, Result,
+};
+
+use rocket::serde::json::Json;
+use serde::{Deserialize, Serialize};
+
+/// # Public Bot
+#[derive(Serialize, Deserialize, JsonSchema)]
+pub struct PublicBot {
+    /// Bot Id
+    #[serde(rename = "_id")]
+    id: String,
+    /// Bot Username
+    username: String,
+    /// Profile Avatar
+    #[serde(skip_serializing_if = "Option::is_none")]
+    avatar: Option<File>,
+    /// Profile Description
+    #[serde(skip_serializing_if = "Option::is_none")]
+    description: Option<String>,
+}
+
+/// # Fetch Public Bot
+///
+/// Fetch details of a public (or owned) bot by its id.
+#[openapi(tag = "Bots")]
+#[get("/<target>/invite")]
+pub async fn fetch_public_bot(db: &Db, user: Option<User>, target: Ref) -> Result<Json<PublicBot>> {
+    let bot = target.as_bot(db).await?;
+    if !bot.public && user.map_or(true, |x| x.id != bot.owner) {
+        return Err(Error::NotFound);
+    }
+
+    let user = db.fetch_user(&bot.id).await?;
+
+    Ok(Json(PublicBot {
+        id: bot.id,
+        username: user.username,
+        avatar: user.avatar,
+        description: user.profile.and_then(|p| p.content),
+    }))
+}

crates/delta/src/routes/bots/invite.rs

@@ -0,0 +1,71 @@
+use revolt_quark::{models::User, perms, Db, EmptyResponse, Error, Permission, Ref, Result};
+
+use rocket::serde::json::Json;
+use serde::Deserialize;
+
+/// # Invite Destination
+#[derive(Deserialize, JsonSchema)]
+#[serde(untagged)]
+pub enum InviteBotDestination {
+    /// Invite to a server
+    Server {
+        /// Server Id
+        server: String,
+    },
+    /// Invite to a group
+    Group {
+        /// Group Id
+        group: String,
+    },
+}
+
+/// # Invite Bot
+///
+/// Invite a bot to a server or group by its id.`
+#[openapi(tag = "Bots")]
+#[post("/<target>/invite", data = "<dest>")]
+pub async fn invite_bot(
+    db: &Db,
+    user: User,
+    target: Ref,
+    dest: Json<InviteBotDestination>,
+) -> Result<EmptyResponse> {
+    if user.bot.is_some() {
+        return Err(Error::IsBot);
+    }
+
+    let bot = target.as_bot(db).await?;
+    if !bot.public && bot.owner != user.id {
+        return Err(Error::BotIsPrivate);
+    }
+
+    match dest.into_inner() {
+        InviteBotDestination::Server { server } => {
+            let server = db.fetch_server(&server).await?;
+
+            perms(&user)
+                .server(&server)
+                .throw_permission(db, Permission::ManageServer)
+                .await?;
+
+            let user = db.fetch_user(&bot.id).await?;
+            server
+                .create_member(db, user, None)
+                .await
+                .map(|_| EmptyResponse)
+        }
+        InviteBotDestination::Group { group } => {
+            let mut channel = db.fetch_channel(&group).await?;
+
+            perms(&user)
+                .channel(&channel)
+                .throw_permission_and_view_channel(db, Permission::InviteOthers)
+                .await?;
+
+            channel
+                .add_user_to_group(db, &bot.id, &user.id)
+                .await
+                .map(|_| EmptyResponse)
+        }
+    }
+}

crates/delta/src/routes/bots/mod.rs

@@ -0,0 +1,22 @@
+use rocket::Route;
+use rocket_okapi::okapi::openapi3::OpenApi;
+
+mod create;
+mod delete;
+mod edit;
+mod fetch;
+mod fetch_owned;
+mod fetch_public;
+mod invite;
+
+pub fn routes() -> (Vec<Route>, OpenApi) {
+    openapi_get_routes_spec![
+        create::create_bot,
+        invite::invite_bot,
+        fetch_public::fetch_public_bot,
+        fetch::fetch_bot,
+        fetch_owned::fetch_owned_bots,
+        edit::edit_bot,
+        delete::delete_bot,
+    ]
+}