feat: add spam detection event and cache handling command (#3)

* 🌟 feat: expand client intents for moderation

* 🌟 feat: add message utils

* 🌟 feat: add time constants for easier time calculations

* 🌟 feat: add spam detection channel and role IDs to environment configuration

* 🌟 feat: implement spam detection utilities for message filtering

* 🌟 feat: implement MessageCache with LRU eviction and message management

* 🌟 feat: add logging functionality for spam detection events

* 🔨 refactor: fix typo contants -> constants

* 🌟 feat: implement action handlers for spam detection with message deletion and user muting

* 🔨 refactor: remove console log from default log function

* 🔨 refactor(app): update high frequency action to not delete messages and set mute duration to 30 minutes

* 🌟 feat: add rules configuration for spam detection

* 🌟 feat: add MAX_RULE_TIMEFRAME constant for spam detection rules

* 🌟 feat: implement checkRules and checkRule functions for spam detection

* 🌟 feat: add messages cache command with stats, clear, and remove expired options

* 🌟 feat: implement spam detection event for message creation

* 🌟 feat: add spam detection event to the events list

* 🌟 feat: add messagesCacheCommand to the commands list

* 🌟 feat: add permission checks for messages cache command execution

* 🔨 refactor: update swap function parameter names for clarity

* 🔨 refactor: change variable name in getUserMessages filter from msg -> message

* 🔨 refactor: rename variable msg -> message

* 🔨 refactor: use a function block instead of 1 line return in createStatComponent function

* 🔨 refactor: remove WEEK and MONTH constants

* 🔨 refactor: rename variable msg to message for consistency

* 🔨 refactor: rename variable msg to message for consistency

* 🌟 feat: add handleSpoilerHackAction and integrate into rules

* 🔨 refactor: consolidate role check conditions for clarity

* 🔨 refactor: rename messagesMd to logMessagesFormatters for clarity

* 🔨 refactor: ename variable msg to message

* 🚨 test: add unit tests for stripCode, stripEmoji, and replaceSpoilerHack functions

Author: hmd-ali

.env.local.example

@@ -6,6 +6,8 @@
 DISCORD_TOKEN=your_bot_token_here
 CLIENT_ID=your_client_id_here
 SERVER_ID=your_server_id_here
+SPAM_DETECTION_CHANNEL_ID=your_channel_id_here
+ROLE_REGULAR_ID=your_regular_role_id_here
 
 # Database Configuration (Optional - uncomment and add to config.ts when needed)
 # DATABASE_URL=postgresql://user:password@localhost:5432/botdb

.github/workflows/deploy.yml

@@ -83,6 +83,8 @@ jobs:
           DISCORD_TOKEN=${{ secrets.DISCORD_TOKEN }}
           CLIENT_ID=${{ secrets.CLIENT_ID }}
           SERVER_ID=${{ secrets.SERVER_ID }}
+          SPAM_DETECTION_CHANNEL_ID=${{ secrets.SPAM_DETECTION_CHANNEL_ID }}
+          ROLE_REGULAR_ID=${{ secrets.ROLE_REGULAR_ID }}
           EOF
 
           echo "🐳 Stopping existing containers..."

README.md

@@ -41,6 +41,8 @@ A TypeScript Discord bot built with Discord.js v14, designed for server moderati
    DISCORD_TOKEN=your_bot_token_here
    CLIENT_ID=your_client_id_here
    SERVER_ID=your_guild_id_here
+   SPAM_DETECTION_CHANNEL_ID=your_spam_detection_channel_id_here
+   ROLE_REGULAR_ID=your_regular_role_id_here
    ```
 
 4. **Build and run**

package.json

@@ -8,7 +8,7 @@
 		"build:ci": "rm -rf dist && NODE_ENV=production tsc --outDir dist",
 		"start:ci": "NODE_ENV=production node dist/index.js ",
 		"dev": "NODE_ENV=development tsx --watch src/index.ts",
-		"test": "tsx --test **/*.test.ts",
+		"test": "tsx --test src/**/*.test.ts tests/*.test.ts",
 		"lint": "biome lint .",
 		"lint:fix": "biome lint --fix .",
 		"format": "biome format --write .",