chore(release): 1.0.0-dev.18 [skip ci]

# @revanced/discord-bot [1.0.0-dev.18](https://github.com/revanced/revanced-helper/compare/@revanced/discord-bot@1.0.0-dev.17...@revanced/discord-bot@1.0.0-dev.18) (2024-08-03)

### Bug Fixes

* **bots/discord:** set the `label` property correctly for message scans ([6d463df](6d463df586))

bots/discord/.gitignore

@@ -174,9 +174,6 @@ dist
 # Finder (MacOS) folder config
 .DS_Store
 
-# Config
-config.ts
-
 # DB
 *.db
 *.sqlite

bots/discord/CHANGELOG.md

@@ -1,3 +1,49 @@
+# @revanced/discord-bot [1.0.0-dev.18](https://github.com/revanced/revanced-helper/compare/@revanced/discord-bot@1.0.0-dev.17...@revanced/discord-bot@1.0.0-dev.18) (2024-08-03)
+
+
+### Bug Fixes
+
+* **bots/discord:** set the `label` property correctly for message scans ([6d463df](https://github.com/revanced/revanced-helper/commit/6d463df586dee5dd8fe8d6cff1c5316f7809b32a))
+
+# @revanced/discord-bot [1.0.0-dev.17](https://github.com/revanced/revanced-helper/compare/@revanced/discord-bot@1.0.0-dev.16...@revanced/discord-bot@1.0.0-dev.17) (2024-08-02)
+
+
+### Bug Fixes
+
+* **bots/discord/commands/eval:** evaluate in current context ([5925d90](https://github.com/revanced/revanced-helper/commit/5925d902095acef5f6396ca03583a9cbb0862498))
+* **bots/discord:** send right response for after regexes ([a7688fa](https://github.com/revanced/revanced-helper/commit/a7688fa9b91919a87f74071b502cd0a87cd1c1fa))
+
+
+### Features
+
+* **bots/discord:** update example config file ([bc9951c](https://github.com/revanced/revanced-helper/commit/bc9951c9b5e007c3e1b3076aa0966ccf29bb18bc))
+
+# @revanced/discord-bot [1.0.0-dev.16](https://github.com/revanced/revanced-helper/compare/@revanced/discord-bot@1.0.0-dev.15...@revanced/discord-bot@1.0.0-dev.16) (2024-08-02)
+
+
+### Bug Fixes
+
+* **bots/discord:** open database as read-write ([c366840](https://github.com/revanced/revanced-helper/commit/c36684091dddf67880505dc459e4334a8a5492f4))
+* **bots/discord:** remove bad text channel checks ([f5939e2](https://github.com/revanced/revanced-helper/commit/f5939e25288fea2022fdeec9085ecb9ffada6111))
+* **bots/discord:** remove redundant footer for response embeds ([412e003](https://github.com/revanced/revanced-helper/commit/412e00317d1eaca23e9c1375e16f94a5f2fa8d86))
+
+
+### Features
+
+* **bots/discord/commands:** add `reload` command ([6875b32](https://github.com/revanced/revanced-helper/commit/6875b32fd0c6ce3034da9dc6c704d425afb26f2e))
+
+# @revanced/discord-bot [1.0.0-dev.15](https://github.com/revanced/revanced-helper/compare/@revanced/discord-bot@1.0.0-dev.14...@revanced/discord-bot@1.0.0-dev.15) (2024-07-31)
+
+
+### Bug Fixes
+
+* **bots/discord:** import `config` from context ([763ef25](https://github.com/revanced/revanced-helper/commit/763ef253f9d4ff70a8b79969a7f4f41cba7f3c59))
+
+
+### Features
+
+* **bots/discord:** add sticky messages ([bf66155](https://github.com/revanced/revanced-helper/commit/bf661556e131bf0ef24e47f658fbcd701960e312))
+
 # @revanced/discord-bot [1.0.0-dev.14](https://github.com/revanced/revanced-helper/compare/@revanced/discord-bot@1.0.0-dev.13...@revanced/discord-bot@1.0.0-dev.14) (2024-07-31)
 
 

bots/discord/config.js

@@ -11,8 +11,21 @@ export default {
             GUILD_ID_HERE: ['ROLE_ID_HERE'],
         },
     },
+    stickyMessages: {
+        GUILD_ID_HERE: {
+            CHANNEL_ID_HERE: {
+                message: {
+                    content: 'This is a sticky message!',
+                },
+                timeout: 60000,
+                forceSendTimeout: 300000,
+            }
+        }
+    },
     moderation: {
         cure: {
+            minimumNameLength: 3,
+            removeCharactersRegex: /[^a-zA-Z0-9 \-_]/g,
             defaultName: 'Server member',
         },
         roles: ['ROLE_ID_HERE'],
@@ -61,7 +74,11 @@ export default {
                 },
             },
         },
-        allowedAttachmentMimeTypes: ['image/jpeg', 'image/png', 'image/webp'],
+        attachments: {
+            scanAttachments: true,
+            allowedMimeTypes: ['image/jpeg', 'image/png', 'image/webp', 'text/plain'],
+            maxTextFileSize: 512000
+        },
         responses: [
             {
                 filterOverride: {

bots/discord/config.schema.ts

@@ -6,6 +6,7 @@ export type Config = {
         users?: string[]
         roles?: Record<string, string[]>
     }
+    stickyMessages?: Record<string, Record<string, StickyMessageConfig>>
     moderation?: {
         roles: string[]
         cure?: {
@@ -25,7 +26,11 @@ export type Config = {
     messageScan?: {
         scanBots?: boolean
         scanOutsideGuilds?: boolean
-        allowedAttachmentMimeTypes: string[]
+        attachments?: {
+            scanAttachments?: boolean
+            allowedMimeTypes?: string[]
+            maxTextFileSize?: number
+        }
         filter?: {
             whitelist?: Filter
             blacklist?: Filter
@@ -50,6 +55,12 @@ export type Config = {
     }
 }
 
+export type StickyMessageConfig = {
+    timeout: number
+    forceSendTimeout?: number
+    message: BaseMessageOptions
+}
+
 export type RolePresetConfig = {
     give: string[]
     take: string[]
@@ -62,7 +73,7 @@ export type ConfigMessageScanResponse = {
     }
     filterOverride?: NonNullable<Config['messageScan']>['filter']
     response: ConfigMessageScanResponseMessage | null
-    replyToReplied?: boolean
+    respondToReply?: boolean
 }
 
 export type ConfigMessageScanResponseLabelConfig = {

bots/discord/package.json

@@ -2,7 +2,7 @@
   "name": "@revanced/discord-bot",
   "type": "module",
   "private": true,
-  "version": "1.0.0-dev.14",
+  "version": "1.0.0-dev.18",
   "description": "🤖 Discord bot assisting ReVanced",
   "main": "src/index.ts",
   "scripts": {

bots/discord/src/commands/admin/eval.ts

@@ -1,5 +1,5 @@
 import { inspect } from 'util'
-import { runInNewContext } from 'vm'
+import { runInThisContext } from 'vm'
 import { ApplicationCommandOptionType } from 'discord.js'
 
 import { AdminCommand } from '$/classes/Command'
@@ -20,13 +20,13 @@ export default new AdminCommand({
             required: false,
         },
     },
-    async execute(context, trigger, { code, 'show-hidden': showHidden }) {
+    async execute(_, trigger, { code, 'show-hidden': showHidden }) {
         await trigger.reply({
             ephemeral: true,
             embeds: [
                 createSuccessEmbed('Evaluate', `\`\`\`js\n${code}\`\`\``).addFields({
                     name: 'Result',
-                    value: `\`\`\`js\n${inspect(runInNewContext(code, { client: trigger.client, context, trigger }), { depth: 1, showHidden, getters: true, numericSeparator: true, showProxy: true })}\`\`\``,
+                    value: `\`\`\`js\n${inspect(runInThisContext(code), { depth: 1, showHidden, getters: true, numericSeparator: true, showProxy: true })}\`\`\``,
                 }),
             ],
         })

bots/discord/src/commands/admin/reload.ts

@@ -0,0 +1,17 @@
+import { AdminCommand } from '$/classes/Command'
+import { join, dirname } from 'path'
+
+import type { Config } from 'config.schema'
+
+export default new AdminCommand({
+    name: 'reload',
+    description: 'Reload configuration',
+    async execute(context, trigger) {
+        context.config = ((await import(join(dirname(Bun.main), '..', 'config.js'))) as { default: Config }).default
+
+        await trigger.reply({
+            content: 'Reloaded configuration',
+            ephemeral: true,
+        })
+    },
+})

bots/discord/src/commands/moderation/purge.ts

@@ -1,4 +1,4 @@
-import { EmbedBuilder, GuildChannel } from 'discord.js'
+import { EmbedBuilder } from 'discord.js'
 
 import { ModerationCommand } from '$/classes/Command'
 import CommandError, { CommandErrorType } from '$/classes/CommandError'
@@ -31,7 +31,7 @@ export default new ModerationCommand({
             throw new CommandError(CommandErrorType.MissingArgument, 'Either `amount` or `until` must be provided.')
 
         const channel = interaction.channel!
-        if (!(channel.isTextBased() && channel instanceof GuildChannel))
+        if (!channel.isTextBased())
             throw new CommandError(CommandErrorType.InvalidChannel, 'The supplied channel is not a text channel.')
 
         const embed = applyCommonEmbedStyles(

bots/discord/src/commands/moderation/slowmode.ts

@@ -28,7 +28,7 @@ export default new ModerationCommand({
         if (!channel?.isTextBased() || channel.isDMBased())
             throw new CommandError(
                 CommandErrorType.InvalidChannel,
-                'The supplied channel is not a text channel or does not exist.',
+                'The supplied channel is not a text channel.',
             )
 
         if (Number.isNaN(duration)) throw new CommandError(CommandErrorType.InvalidDuration, 'Invalid duration.')

bots/discord/src/constants.ts

@@ -4,12 +4,6 @@ export const MessageScanLabeledResponseReactions = {
     delete: '❌',
 } as const
 
-export const MessageScanHumanizedMode = {
-    ocr: 'image recognition',
-    nlp: 'text analysis',
-    match: 'pattern matching',
-} as const
-
 export const DefaultEmbedColor = '#4E98F0'
 export const ReVancedLogoURL =
     'https://media.discordapp.net/attachments/1095487869923119144/1115436493050224660/revanced-logo.png'

bots/discord/src/context.ts

@@ -3,7 +3,7 @@ import { existsSync, readFileSync, readdirSync } from 'fs'
 import { join } from 'path'
 import { Client as APIClient } from '@revanced/bot-api'
 import { createLogger } from '@revanced/bot-shared'
-import { Client as DiscordClient, Partials } from 'discord.js'
+import { Client as DiscordClient, type Message, Partials } from 'discord.js'
 import { drizzle } from 'drizzle-orm/bun-sqlite'
 
 // Export some things first, as commands require them
@@ -56,7 +56,7 @@ if (DatabasePath && !existsSync(DatabasePath)) {
     }
 }
 
-const db = new Database(DatabasePath)
+const db = new Database(DatabasePath, { readwrite: true, create: true })
 if (dbSchemaFileName) db.run(readFileSync(join(DatabaseSchemaDir, dbSchemaFileName)).toString())
 
 export const database = drizzle(db, {
@@ -85,4 +85,19 @@ export const discord = {
         string,
         Command<boolean, CommandOptionsOptions | undefined, boolean>
     >,
+    stickyMessages: {} as Record<
+        string,
+        Record<
+            string,
+            {
+                forceSendTimerActive?: boolean
+                timeoutMs: number
+                forceSendMs?: number
+                send: (forced?: boolean) => Promise<void>
+                currentMessage?: Message<true>
+                interval?: NodeJS.Timeout
+                forceSendInterval?: NodeJS.Timeout
+            }
+        >
+    >,
 } as const

bots/discord/src/events/discord/messageCreate/messageScan.ts

@@ -24,7 +24,7 @@ withContext(on, 'messageCreate', async (context, msg) => {
         try {
             logger.debug(`Classifying message ${msg.id}`)
 
-            const { response, label, replyToReplied } = await getResponseFromText(
+            const { response, label, respondToReply } = await getResponseFromText(
                 msg.content,
                 filteredResponses,
                 context,
@@ -33,13 +33,13 @@ withContext(on, 'messageCreate', async (context, msg) => {
             if (response) {
                 logger.debug('Response found')
 
-                const toReply = replyToReplied ? (msg.reference?.messageId ? await msg.fetchReference() : msg) : msg
+                const toReply = respondToReply ? (msg.reference?.messageId ? await msg.fetchReference() : msg) : msg
                 const reply = await toReply.reply({
                     ...response,
-                    embeds: response.embeds?.map(it => createMessageScanResponseEmbed(it, label ? 'nlp' : 'match')),
+                    embeds: response.embeds?.map(createMessageScanResponseEmbed),
                 })
 
-                if (label)
+                if (label) {
                     db.insert(responses).values({
                         replyId: reply.id,
                         channelId: reply.channel.id,
@@ -49,7 +49,6 @@ withContext(on, 'messageCreate', async (context, msg) => {
                         content: msg.content,
                     })
 
-                if (label) {
                     for (const reaction of Object.values(MessageScanLabeledResponseReactions)) {
                         await reply.react(reaction)
                     }
@@ -60,11 +59,22 @@ withContext(on, 'messageCreate', async (context, msg) => {
         }
     }
 
-    if (msg.attachments.size > 0) {
+    if (msg.attachments.size > 0 && config.attachments?.scanAttachments) {
         logger.debug(`Classifying message attachments for ${msg.id}`)
 
         for (const attachment of msg.attachments.values()) {
-            if (attachment.contentType && !config.allowedAttachmentMimeTypes.includes(attachment.contentType)) continue
+            if (
+                config.attachments.allowedMimeTypes &&
+                !config.attachments.allowedMimeTypes.includes(attachment.contentType!)
+            ) {
+                logger.debug(`Disallowed MIME type for attachment: ${attachment.url}, ${attachment.contentType}`)
+                continue
+            }
+
+            if (attachment.contentType?.startsWith('text/') && attachment.size > (config.attachments.maxTextFileSize ?? 512 * 1000)) {
+                logger.debug(`Attachment ${attachment.url} is too large be to scanned, size is ${attachment.size}`)   
+                continue
+            }
 
             try {
                 const { text: content } = await api.client.parseImage(attachment.url)
@@ -74,7 +84,7 @@ withContext(on, 'messageCreate', async (context, msg) => {
                     logger.debug(`Response found for attachment: ${attachment.url}`)
                     await msg.reply({
                         ...response,
-                        embeds: response.embeds?.map(it => createMessageScanResponseEmbed(it, 'ocr')),
+                        embeds: response.embeds?.map(createMessageScanResponseEmbed),
                     })
 
                     break

bots/discord/src/events/discord/messageCreate/stickyMessageReset.ts

@@ -0,0 +1,30 @@
+import { on, withContext } from '$utils/discord/events'
+
+withContext(on, 'messageCreate', async ({ discord, logger }, msg) => {
+    if (!msg.inGuild()) return
+    if (msg.author.id === msg.client.user.id) return
+
+    const store = discord.stickyMessages[msg.guildId]?.[msg.channelId]
+    if (!store) return
+
+    if (!store.interval) store.interval = setTimeout(store.send, store.timeoutMs) as NodeJS.Timeout
+    else {
+        store.interval.refresh()
+
+        if (!store.forceSendTimerActive && store.forceSendMs) {
+            logger.debug(`Channel ${msg.channelId} in guild ${msg.guildId} is active, starting force send timer`)
+
+            store.forceSendTimerActive = true
+
+            if (!store.forceSendInterval)
+                store.forceSendInterval = setTimeout(
+                    () =>
+                        store.send(true).then(() => {
+                            store.forceSendTimerActive = false
+                        }),
+                    store.forceSendMs,
+                ) as NodeJS.Timeout
+            else store.forceSendInterval.refresh()
+        }
+    }
+})

bots/discord/src/events/discord/ready.ts

@@ -1,14 +1,68 @@
 import { database, logger } from '$/context'
 import { appliedPresets } from '$/database/schemas'
+import { applyCommonEmbedStyles } from '$/utils/discord/embeds'
+import { on, withContext } from '$/utils/discord/events'
 import { removeRolePreset } from '$/utils/discord/rolePresets'
-import type { Client } from 'discord.js'
 import { lt } from 'drizzle-orm'
-import { on, withContext } from 'src/utils/discord/events'
 
-export default withContext(on, 'ready', ({ config, logger }, client) => {
+import type { Client } from 'discord.js'
+
+export default withContext(on, 'ready', async ({ config, discord, logger }, client) => {
     logger.info(`Connected to Discord API, logged in as ${client.user.displayName} (@${client.user.tag})!`)
     logger.info(`Bot is in ${client.guilds.cache.size} guilds`)
 
+    if (config.stickyMessages)
+        for (const [guildId, channels] of Object.entries(config.stickyMessages)) {
+            const guild = await client.guilds.fetch(guildId)
+            discord.stickyMessages[guildId] = {}
+
+            for (const [channelId, { message, timeout, forceSendTimeout }] of Object.entries(channels)) {
+                const channel = await guild.channels.fetch(channelId)
+                if (!channel?.isTextBased()) return
+
+                const send = async (forced = false) => {
+                    try {
+                        const msg = await channel.send({
+                            ...message,
+                            embeds: message.embeds?.map(it => applyCommonEmbedStyles(it, true, true, true)),
+                        })
+
+                        const store = discord.stickyMessages[guildId]![channelId]
+                        if (!store) return
+
+                        await store.currentMessage?.delete().catch()
+                        store.currentMessage = msg
+
+                        if (!forced) {
+                            clearTimeout(store.forceSendInterval)
+                            logger.debug(
+                                `Timeout ended for sticky message in channel ${channelId} in guild ${guildId}, channel is inactive`,
+                            )
+                        } else {
+                            clearTimeout(store.interval)
+                            logger.debug(
+                                `Forced send timeout for sticky message in channel ${channelId} in guild ${guildId} ended, channel is too active`,
+                            )
+                        }
+
+                        logger.debug(`Sent sticky message to channel ${channelId} in guild ${guildId}`)
+                    } catch (e) {
+                        logger.error(
+                            `Error while sending sticky message to channel ${channelId} in guild ${guildId}:`,
+                            e,
+                        )
+                    }
+                }
+
+                discord.stickyMessages[guildId]![channelId] = {
+                    forceSendMs: forceSendTimeout,
+                    timeoutMs: timeout,
+                    send,
+                    forceSendTimerActive: false,
+                }
+            }
+        }
+
     if (config.rolePresets) {
         removeExpiredPresets(client)
         setTimeout(() => removeExpiredPresets(client), config.rolePresets.checkExpiredEvery)

bots/discord/src/utils/discord/embeds.ts

@@ -1,5 +1,5 @@
-import { DefaultEmbedColor, MessageScanHumanizedMode, ReVancedLogoURL } from '$/constants'
-import { EmbedBuilder, type EmbedField, type User } from 'discord.js'
+import { DefaultEmbedColor, ReVancedLogoURL } from '$/constants'
+import { type APIEmbed, EmbedBuilder, type EmbedField, type JSONEncodable, type User } from 'discord.js'
 import type { ConfigMessageScanResponseMessage } from '../../../config.schema'
 
 export const createErrorEmbed = (title: string | null, description?: string) =>
@@ -25,23 +25,7 @@ export const createSuccessEmbed = (title: string | null, description?: string) =
 
 export const createMessageScanResponseEmbed = (
     response: NonNullable<ConfigMessageScanResponseMessage['embeds']>[number],
-    mode: 'ocr' | 'nlp' | 'match',
-) => {
-    // biome-ignore lint/style/noParameterAssign: While this is confusing, it is fine for this purpose
-    if ('toJSON' in response) response = response.toJSON()
-
-    const embed = new EmbedBuilder().setTitle(response.title ?? null)
-
-    if (response.description) embed.setDescription(response.description)
-    if (response.fields) embed.addFields(response.fields)
-
-    embed.setFooter({
-        text: `ReVanced • Via ${MessageScanHumanizedMode[mode]}`,
-        iconURL: ReVancedLogoURL,
-    })
-
-    return applyCommonEmbedStyles(embed, true, true, true)
-}
+) => applyCommonEmbedStyles(response, true, true, true)
 
 export const createModerationActionEmbed = (
     action: string,
@@ -77,19 +61,23 @@ export const applyReferenceToModerationActionEmbed = (embed: EmbedBuilder, refer
 }
 
 export const applyCommonEmbedStyles = (
-    embed: EmbedBuilder,
+    embed: EmbedBuilder | JSONEncodable<APIEmbed> | APIEmbed,
     setThumbnail = false,
     setFooter = false,
     setColor = false,
 ) => {
+    // biome-ignore lint/style/noParameterAssign: While this is confusing, it is fine for this purpose
+    if ('toJSON' in embed) embed = embed.toJSON()
+    const builder = new EmbedBuilder(embed)
+
     if (setFooter)
-        embed.setFooter({
+        builder.setFooter({
             text: 'ReVanced',
             iconURL: ReVancedLogoURL,
         })
 
-    if (setColor) embed.setColor(DefaultEmbedColor)
-    if (setThumbnail) embed.setThumbnail(ReVancedLogoURL)
+    if (setColor) builder.setColor(DefaultEmbedColor)
+    if (setThumbnail) builder.setThumbnail(ReVancedLogoURL)
 
-    return embed
+    return builder
 }

bots/discord/src/utils/discord/messageScan.ts

@@ -64,23 +64,24 @@ export const getResponseFromText = async (
             const matchedLabel = scan.labels[0]!
             logger.debug(`Message matched label with confidence: ${matchedLabel.name}, ${matchedLabel.confidence}`)
 
-            let triggerConfig: ConfigMessageScanResponseLabelConfig | undefined
-            const labelConfig = responses.find(x => {
+            let trigger: ConfigMessageScanResponseLabelConfig | undefined
+            const response = responses.find(x => {
                 const config = x.triggers.text!.find(
                     (x): x is ConfigMessageScanResponseLabelConfig => 'label' in x && x.label === matchedLabel.name,
                 )
-                if (config) triggerConfig = config
+                if (config) trigger = config
                 return config
             })
 
-            if (!labelConfig) {
-                logger.warn(`No label config found for label ${matchedLabel.name}`)
+            if (!response) {
+                logger.warn(`No response config found for label ${matchedLabel.name}`)
+                // This returns the default value set in line 17, which means no response matched
                 return responseConfig
             }
 
-            if (matchedLabel.confidence >= triggerConfig!.threshold) {
+            if (matchedLabel.confidence >= trigger!.threshold) {
                 logger.debug('Label confidence is enough')
-                responseConfig = labelConfig
+                responseConfig = { ...responseConfig, ...response, label: trigger!.label }
             }
         }
     }
@@ -94,8 +95,8 @@ export const getResponseFromText = async (
             } = responses[i]!
             const firstLabelIndex = firstLabelIndexes[i] ?? -1
 
-            for (let i = firstLabelIndex + 1; i < textTriggers!.length; i++) {
-                const trigger = textTriggers![i]!
+            for (let j = firstLabelIndex + 1; j < textTriggers!.length; j++) {
+                const trigger = textTriggers![j]!
 
                 if (trigger instanceof RegExp) {
                     if (trigger.test(content)) {
@@ -158,7 +159,7 @@ export const handleUserResponseCorrection = async (
 
         await reply.edit({
             ...correctLabelResponse.response,
-            embeds: correctLabelResponse.response.embeds?.map(it => createMessageScanResponseEmbed(it, 'nlp')),
+            embeds: correctLabelResponse.response.embeds?.map(createMessageScanResponseEmbed),
         })
     }
 

bots/discord/src/utils/discord/moderation.ts

@@ -38,7 +38,7 @@ export const getLogChannel = async (guild: Guild) => {
 
     try {
         const channel = await guild.channels.fetch(logConfig.thread ?? logConfig.channel)
-        if (!channel || !channel.isTextBased())
+        if (!channel?.isTextBased())
             return void logger.warn('The moderation log channel does not exist, skipping logging')
 
         return channel

bots/discord/src/utils/discord/permissions.ts

@@ -1,5 +1,5 @@
 import { GuildMember, type User } from 'discord.js'
-import config from '../../../config'
+import { config } from '../../context'
 
 export const isAdmin = (userOrMember: User | GuildMember) => {
     return (