feat(bot): implement core utilities and features for command handling and rate limiting

- Add JSON configuration for group and command responses:
  - Includes responses for various bot actions like user management (`ban`, `mute`, `warn`), group events (e.g., welcome messages), and command outputs.
  - Centralized text management for better localization and customization.

- Implement centralized logging utility:
  - Added a `Log` class utilizing `@medishen/gland-logger` for structured logging.
  - Provides methods for logging `info`, `warn`, `error`, and `debug` messages with configurable transport and format.

- Define command list:
  - Created a `COMMANDS` constant for standardized command names.
  - Categorized commands into general, user, and admin-specific functionalities.
  - Defined `CommandName` type for stricter typing in command handling.

- Add rate-limiting utility:
  - `RateLimiter` class to prevent command abuse with configurable limits:
    - Maximum commands (`COMMAND_LIMIT`) per time frame (`TIME_FRAME`).
    - Automatic cleanup of stale entries after a defined interval (`CLEANUP_INTERVAL`).
  - Ensures smoother operation and protects against spam.

- Miscellaneous:
  - Improved maintainability and readability by organizing utilities and constants.
  - Established groundwork for scalable bot features with structured handling of commands and responses.

Author: m-mdy-m

src/utils/RateLimiter.ts

@@ -0,0 +1,55 @@
+import { RateLimitEntry } from '../types/ResponseTypes';
+
+export class RateLimiter {
+  private static rateLimits: Map<number, RateLimitEntry> = new Map();
+  private static COMMAND_LIMIT = 5; // Max commands allowed
+  private static TIME_FRAME = 10000; // Time frame in milliseconds (10 seconds)
+  private static CLEANUP_INTERVAL = 60000; // Cleanup interval in milliseconds (1 minute)
+
+  // Initializes the cleanup task
+  static initCleanup() {
+    setInterval(() => {
+      const currentTime = Date.now();
+      for (const [userId, entry] of this.rateLimits.entries()) {
+        if (currentTime - entry.lastCommandTime > this.TIME_FRAME) {
+          this.rateLimits.delete(userId);
+        }
+      }
+    }, this.CLEANUP_INTERVAL);
+  }
+
+  // Rate limit checking logic
+  static limit(userId: number): boolean {
+    const currentTime = Date.now();
+    const entry = this.rateLimits.get(userId);
+
+    if (entry) {
+      if (currentTime - entry.lastCommandTime > this.TIME_FRAME) {
+        // Reset if the time frame has passed
+        this.rateLimits.set(userId, {
+          lastCommandTime: currentTime,
+          commandCount: 1,
+        });
+        return true;
+      }
+
+      if (entry.commandCount < this.COMMAND_LIMIT) {
+        // Increment the command count
+        entry.commandCount += 1;
+        this.rateLimits.set(userId, entry);
+        return true;
+      } else {
+        // Rate limit exceeded, silently return false
+        return false;
+      }
+    } else {
+      // First command from the user
+      this.rateLimits.set(userId, {
+        lastCommandTime: currentTime,
+        commandCount: 1,
+      });
+      return true;
+    }
+  }
+}
+RateLimiter.initCleanup();

src/utils/index.ts

@@ -0,0 +1,46 @@
+export const COMMANDS: string[] = [
+  /** General Commands */
+  'start',
+  'help',
+  'commands',
+  'date',
+  'viewsupportcontact',
+  'getbotinfo',
+  /** Users Commands */
+  'rules',
+  'codetime',
+  'future',
+  'news',
+  'groupinfo',
+  'report',
+  'cancel',
+  'link',
+  'adminlist',
+  /** admin Commands */
+  /** Approved Commands */
+  'approved','disapproved','approvedlist',
+  /** Ban Commands */
+  'ban','unban',
+  /** Warn Commands */
+  'warn','rmwarn','warns','warnslist',
+  /** Mute Commands */
+  'mute','unmute','mutelist',
+  /** Admin Command  */
+  'grant','revoke',
+  /** BlackList Command */
+  'blacklist','rmbl','abl',
+  /** Rules Commands */
+  'rules',
+  /** Pin Command */
+  'pin','unpin',
+  /** Purge Command */
+  'purge',
+  /** Group Setting Command */
+  'lock','unlock','title','welcome',
+  /** General Commands */
+  'group_stats',
+  'shahin',
+  'aran',
+] as const;
+
+export type CommandName = (typeof COMMANDS)[number];

src/utils/jsons/blacklist.json

@@ -0,0 +1,41 @@
+{
+  "gorup": {
+    "user": {
+      "ban": {
+        "banned": "",
+        "un_ban": "",
+        "ban_use_blacklist_message": ""
+      },
+      "mute": "",
+      "warn": ""
+    },
+    "join_to_new_group": "",
+    "new_member_welcome": "Welcome to the group, {name}! Please introduce yourself."
+  },
+  "command": {
+    "link": "Here is the group link: [Group Link]",
+    "status": "Checking status for {username}. Please wait...",
+    "time": "Current time: {current_time}",
+    "date": "Today's date: {current_date}",
+    "report": "Thank you for reporting the issue! It will be reviewed by the admin team.",
+    "unreport": "The report has been removed.",
+    "future": "Please wait for future updates regarding this issue. Thank you for your patience.",
+    "info": "Here is the information about the group: [Group Info]",
+    "admins": "Here are the current admins of the group: [Admin List]",
+    "purge": "Purging messages... This may take a moment.",
+    "news": "Latest news in the community: [News Updates]",
+    "lock": "The group is now locked. No new members can join.",
+    "unlock": "The group is now unlocked. New members can join."
+  },
+  "help": {
+    "general": "I am here to assist you! To see a list of commands, use the `/commands` command in a private chat with the bot."
+  },
+  "start": {
+    "Private": "Welcome to CMCOP!\n I am the dedicated robot and police of Codemodule community.\n Use the /help command to explore my features and commands.",
+    "gorup": "Hello! What can I do?"
+  },
+  "commands": {
+    "private": "Use this command in a private chat to interact with the bot.",
+    "public": "This command is only available in private chats. Please use it there."
+  }
+}