@julanzw/ttoolbox-discordjs-framework 1.3.0 → 1.5.0

package/dist/classes/Command.class.d.ts

@@ -173,4 +173,97 @@ export declare abstract class Command {
      * Set the error reporter for this command
      */
     setErrorReporter(reporter: ErrorReporter): void;
+    /**
+     * Lifecycle hook called before command execution.
+     *
+     * Can be used for:
+     * - Custom validation
+     * - Logging/analytics
+     * - Loading user preferences
+     * - Rate limiting checks
+     * - And more...
+     *
+     * If this hook throws an error or returns false, execution is stopped.
+     *
+     * @param interaction - The command interaction
+     * @returns true to continue execution, false to stop (or throw an error)
+     *
+     * @example
+     * ```typescript
+     * protected async beforeExecute(interaction: ChatInputCommandInteraction): Promise<boolean> {
+     *   // Log command usage
+     *   console.log(`${interaction.user.tag} used ${this.name}`);
+     *
+     *   // Check custom rate limit
+     *   if (await this.isRateLimited(interaction.user.id)) {
+     *     await interaction.reply('You are rate limited!');
+     *     return false; // Stop execution
+     *   }
+     *
+     *   return true; // Continue
+     * }
+     * ```
+     */
+    protected beforeExecute?(interaction: ChatInputCommandInteraction, client: Client): Promise<boolean | void>;
+    /**
+     * Lifecycle hook called after successful command execution.
+     *
+     * Can be used for:
+     * - Analytics tracking
+     * - Cleanup tasks
+     * - Success logging
+     * - Updating usage statistics
+     * - And more...
+     *
+     * Note: This is **NOT** called if the command throws an error (use onError for that).
+     *
+     * @param interaction - The command interaction
+     *
+     * @example
+     * ```typescript
+     * protected async afterExecute(interaction: ChatInputCommandInteraction): Promise<void> {
+     *   // Track command usage
+     *   await analytics.track('command_used', {
+     *     command: this.name,
+     *     user: interaction.user.id,
+     *   });
+     *
+     *   // Update user stats
+     *   await incrementCommandCount(interaction.user.id);
+     * }
+     * ```
+     */
+    protected afterExecute?(interaction: ChatInputCommandInteraction, client: Client): Promise<void>;
+    /**
+     * Lifecycle hook called when command execution fails.
+     *
+     * Can be used for:
+     * - Custom error handling
+     * - Error reporting to external services
+     * - User-friendly error messages
+     * - Cleanup after errors
+     * - And more...
+     *
+     * The error is rethrown after this hook.
+     *
+     * @param interaction - The command interaction
+     * @param error - The error that occurred
+     *
+     * @example
+     * ```typescript
+     * protected async onError(interaction: ChatInputCommandInteraction, error: Error): Promise<void> {
+     *   // Send to Sentry
+     *   Sentry.captureException(error, {
+     *     tags: { command: this.name },
+     *     user: { id: interaction.user.id },
+     *   });
+     *
+     *   // Custom error message
+     *   if (error.message.includes('DATABASE')) {
+     *     await interaction.reply('Database is temporarily unavailable. Try again later.');
+     *   }
+     * }
+     * ```
+     */
+    protected onError?(interaction: ChatInputCommandInteraction, error: Error, client: Client): Promise<void>;
 }

package/dist/classes/Command.class.js

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
 import { SlashCommandBuilder, } from 'discord.js';
 import { safeReply } from '../utils/editAndReply.js';
 import { getPermissionsForLevel } from '../utils/permissions.js';
@@ -116,7 +115,24 @@ export class Command {
             const error = this.validate(interaction);
             if (error)
                 return await safeReply(interaction, error, true);
-            await this.run(interaction, client);
+            if (this.beforeExecute) {
+                const shouldContinue = await this.beforeExecute(interaction, client);
+                if (shouldContinue === false) {
+                    return;
+                }
+            }
+            try {
+                await this.run(interaction, client);
+                if (this.afterExecute) {
+                    await this.afterExecute(interaction, client);
+                }
+            }
+            catch (err) {
+                if (this.onError) {
+                    await this.onError(interaction, err, client);
+                }
+                throw err;
+            }
         });
     }
     /**

package/dist/classes/CommandManager.class.d.ts

@@ -1,36 +1,105 @@
-import { ChatInputCommandInteraction, Client, RESTPostAPIChatInputApplicationCommandsJSONBody } from 'discord.js';
+import { ChatInputCommandInteraction, Client, MessageContextMenuCommandInteraction, RESTPostAPIApplicationCommandsJSONBody, UserContextMenuCommandInteraction } from 'discord.js';
 import { ILogger } from '../types/logger.js';
 import { Command } from './Command.class.js';
 import { SubcommandGroup } from './SubcommandGroup.class.js';
 import { ErrorReporter } from '../utils/ErrorReporter.js';
+import { MessageContextMenuCommand } from './MessageContextMenuCommand.class.js';
+import { UserContextMenuCommand } from './UserContextMenuCommand.class.js';
+import { LoadCommandsOptions } from '../types/loadCommands.js';
 export declare class CommandManager {
     private commands;
+    private userContextMenuCommands;
+    private messageContextMenuCommands;
     protected logger?: ILogger;
     protected errorReporter?: ErrorReporter;
     /**
+     * Register commands (accepts single, array, or mixed types)
+     * @param command - Command(s) to register
+     * @example
+     * ```typescript
+     * // Single command
+     * commandManager.registerCommand(new PingCommand());
+     *
+     * // Array of commands
+     * commandManager.registerCommand([cmd1, cmd2, cmd3]);
+     *
+     * // Mixed types
+     * commandManager.registerCommand([
+     *   new PingCommand(),
+     *   new UserContextMenu(),
+     *   new SubcommandGroup(),
+     * ]);
+     * ```
+     */
+    registerCommand(command: Command | SubcommandGroup | UserContextMenuCommand | MessageContextMenuCommand | Array<Command | SubcommandGroup | UserContextMenuCommand | MessageContextMenuCommand | any>): void;
+    /**
+     * @experimental
+     * Automatically load and register all commands from a directory.
+     *
+     * This is a convenience wrapper around the loadCommands utility.
+     *
+     * @param dirPath - Absolute path to the directory containing commands
+     * @param options - Optional configuration
+     * @returns Number of commands successfully loaded
+     *
+     * @example
+     * ```typescript
+     * // Basic usage
+     * const count = await commandManager.loadFromDirectory('./src/commands');
+     * console.log(`Loaded ${count} commands`);
+     *
+     * // With options
+     * await commandManager.loadFromDirectory('./src/commands', {
+     *   verbose: true,
+     *   skipDirs: ['subcommands', 'test'],
+     * });
+     * ```
+     */
+    loadFromDirectory(dirPath: string, options?: LoadCommandsOptions): Promise<number>;
+    /**
+     * @deprecated Use `registerCommand()` instead
+     *
      * Register a single command or subcommand group
      */
     register(command: Command | SubcommandGroup): this;
     /**
+     * @deprecated Use `registerCommand()` with an array instead
+     *
      * Register multiple commands at once
      */
     registerMultiple(commands: Array<Command | SubcommandGroup>): this;
     /**
-     * Get a specific command by name
+     * Get a specific slash command by name
      */
     get(name: string): Command | SubcommandGroup | undefined;
     /**
-     * Get all registered commands
+     * Get a specific user context menu command by name
+     */
+    getUserContextMenu(name: string): UserContextMenuCommand | undefined;
+    /**
+     * Get a specific message context menu command by name
+     */
+    getMessageContextMenu(name: string): MessageContextMenuCommand | undefined;
+    /**
+     * Get all registered slash commands
      */
     getAll(): Array<Command | SubcommandGroup>;
     /**
-     * Get all commands sorted alphabetically by name
+     * Get all registered user context menu commands
+     */
+    getAllUserContextMenus(): UserContextMenuCommand[];
+    /**
+     * Get all registered message context menu commands
+     */
+    getAllMessageContextMenus(): MessageContextMenuCommand[];
+    /**
+     * Get all slash commands sorted alphabetically by name
      */
     getAllSorted(): Array<Command | SubcommandGroup>;
     /**
      * Convert all commands to Discord JSON format for registration
      */
-    toDiscordJSON(): RESTPostAPIChatInputApplicationCommandsJSONBody[];
+    toJSON(): RESTPostAPIApplicationCommandsJSONBody[];
     /**
      * Generate paginated help pages for display in help command
      * Returns a 2D array where each inner array is a page of command descriptions
@@ -48,25 +117,69 @@ export declare class CommandManager {
      */
     executeCommand(commandName: string, interaction: ChatInputCommandInteraction, client: Client): Promise<void>;
     /**
-     * Get total number of registered commands
+     * Execute a user context menu command.
+     */
+    executeUserContextMenu(commandName: string, interaction: UserContextMenuCommandInteraction, client: Client): Promise<void>;
+    /**
+     * Execute a message context menu command.
+     */
+    executeMessageContextMenu(commandName: string, interaction: MessageContextMenuCommandInteraction, client: Client): Promise<void>;
+    /**
+     * Get total number of registered slash commands
      */
     get size(): number;
     /**
-     * Check if a command exists
+     * Get total number of all registered commands
+     */
+    get totalSize(): number;
+    /**
+     * Check if a slash command exists
      */
     has(name: string): boolean;
     /**
-     * Remove a command (useful for hot-reloading in dev)
+     * Check if a user context menu command exists
+     */
+    hasUserContextMenu(name: string): boolean;
+    /**
+     * Check if a message context menu command exists
+     */
+    hasMessageContextMenu(name: string): boolean;
+    /**
+     * Check if any command (slash, user context, or message context) exists
+     */
+    hasAny(name: string): boolean;
+    /**
+     * Remove a slash command (useful for hot-reloading in dev)
      */
     unregister(name: string): boolean;
     /**
-     * Clear all commands
+     * Remove a user context menu command
+     */
+    unregisterUserContextMenu(name: string): boolean;
+    /**
+     * Remove a message context menu command
+     */
+    unregisterMessageContextMenu(name: string): boolean;
+    /**
+     * Clear all commands (slash commands, user context menus, and message context menus)
      */
     clear(): void;
     /**
-     * Get command names as an array
+     * Get slash command names as an array
      */
     getCommandNames(): string[];
+    /**
+     * Get user context menu command names as an array
+     */
+    getUserContextMenuNames(): string[];
+    /**
+     * Get message context menu command names as an array
+     */
+    getMessageContextMenuNames(): string[];
+    /**
+     * Get all command names (slash + context menus) as an array
+     */
+    getAllCommandNames(): string[];
     setLogger(logger: ILogger): this;
     /**
      * Set the error reporter for all commands

package/dist/classes/CommandManager.class.js

@@ -1,42 +1,148 @@
+import { Command } from './Command.class.js';
 import { SubcommandGroup } from './SubcommandGroup.class.js';
+import { MessageContextMenuCommand } from './MessageContextMenuCommand.class.js';
+import { UserContextMenuCommand } from './UserContextMenuCommand.class.js';
+import { loadCommands } from '../utils/loadCommands.js';
 export class CommandManager {
     constructor() {
         this.commands = new Map();
+        this.userContextMenuCommands = new Map();
+        this.messageContextMenuCommands = new Map();
     }
     /**
-     * Register a single command or subcommand group
+     * Register commands (accepts single, array, or mixed types)
+     * @param command - Command(s) to register
+     * @example
+     * ```typescript
+     * // Single command
+     * commandManager.registerCommand(new PingCommand());
+     *
+     * // Array of commands
+     * commandManager.registerCommand([cmd1, cmd2, cmd3]);
+     *
+     * // Mixed types
+     * commandManager.registerCommand([
+     *   new PingCommand(),
+     *   new UserContextMenu(),
+     *   new SubcommandGroup(),
+     * ]);
+     * ```
      */
-    register(command) {
-        if (this.logger) {
+    registerCommand(command) {
+        if (Array.isArray(command)) {
+            for (const cmd of command) {
+                this.registerCommand(cmd);
+            }
+            return;
+        }
+        if (this.logger && 'setLogger' in command) {
             command.setLogger(this.logger);
         }
-        if (this.errorReporter) {
+        if (this.errorReporter && 'setErrorReporter' in command) {
             command.setErrorReporter(this.errorReporter);
         }
-        this.commands.set(command.name, command);
+        if (command instanceof Command || command instanceof SubcommandGroup) {
+            this.commands.set(command.name, command);
+        }
+        else if (command instanceof UserContextMenuCommand) {
+            this.userContextMenuCommands.set(command.name, command);
+        }
+        else if (command instanceof MessageContextMenuCommand) {
+            this.messageContextMenuCommands.set(command.name, command);
+        }
+        else {
+            this.logger?.warn(`Attempted to register invalid command type: ${command?.constructor?.name || 'unknown'}`, 'command-manager');
+        }
+    }
+    /**
+     * @experimental
+     * Automatically load and register all commands from a directory.
+     *
+     * This is a convenience wrapper around the loadCommands utility.
+     *
+     * @param dirPath - Absolute path to the directory containing commands
+     * @param options - Optional configuration
+     * @returns Number of commands successfully loaded
+     *
+     * @example
+     * ```typescript
+     * // Basic usage
+     * const count = await commandManager.loadFromDirectory('./src/commands');
+     * console.log(`Loaded ${count} commands`);
+     *
+     * // With options
+     * await commandManager.loadFromDirectory('./src/commands', {
+     *   verbose: true,
+     *   skipDirs: ['subcommands', 'test'],
+     * });
+     * ```
+     */
+    async loadFromDirectory(dirPath, options = {}) {
+        const commands = await loadCommands(dirPath, options);
+        this.registerCommand(commands);
+        const validCount = commands.filter(cmd => cmd instanceof Command ||
+            cmd instanceof SubcommandGroup ||
+            cmd instanceof UserContextMenuCommand ||
+            cmd instanceof MessageContextMenuCommand).length;
+        this.logger?.info(`Auto-loaded ${validCount} commands from ${dirPath}`, 'command-manager');
+        return validCount;
+    }
+    /**
+     * @deprecated Use `registerCommand()` instead
+     *
+     * Register a single command or subcommand group
+     */
+    register(command) {
+        this.registerCommand(command);
         return this;
     }
     /**
+     * @deprecated Use `registerCommand()` with an array instead
+     *
      * Register multiple commands at once
      */
     registerMultiple(commands) {
-        commands.forEach((cmd) => this.register(cmd));
+        this.registerCommand(commands);
         return this;
     }
     /**
-     * Get a specific command by name
+     * Get a specific slash command by name
      */
     get(name) {
         return this.commands.get(name);
     }
     /**
-     * Get all registered commands
+     * Get a specific user context menu command by name
+     */
+    getUserContextMenu(name) {
+        return this.userContextMenuCommands.get(name);
+    }
+    /**
+     * Get a specific message context menu command by name
+     */
+    getMessageContextMenu(name) {
+        return this.messageContextMenuCommands.get(name);
+    }
+    /**
+     * Get all registered slash commands
      */
     getAll() {
         return Array.from(this.commands.values());
     }
     /**
-     * Get all commands sorted alphabetically by name
+     * Get all registered user context menu commands
+     */
+    getAllUserContextMenus() {
+        return Array.from(this.userContextMenuCommands.values());
+    }
+    /**
+     * Get all registered message context menu commands
+     */
+    getAllMessageContextMenus() {
+        return Array.from(this.messageContextMenuCommands.values());
+    }
+    /**
+     * Get all slash commands sorted alphabetically by name
      */
     getAllSorted() {
         return this.getAll().sort((a, b) => a.name.localeCompare(b.name));
@@ -44,13 +150,26 @@ export class CommandManager {
     /**
      * Convert all commands to Discord JSON format for registration
      */
-    toDiscordJSON() {
-        return this.getAll().map((cmd) => {
+    toJSON() {
+        const slashCommands = Array.from(this.commands.values()).map((cmd) => {
             if (process.env.ENV === 'dev') {
                 console.log(`Registering: ${cmd.name}`);
             }
             return cmd.toJSON();
         });
+        const userContextMenus = Array.from(this.userContextMenuCommands.values()).map((cmd) => {
+            if (process.env.ENV === 'dev') {
+                console.log(`Registering user context menu: ${cmd.name}`);
+            }
+            return cmd.toJSON();
+        });
+        const messageContextMenus = Array.from(this.messageContextMenuCommands.values()).map((cmd) => {
+            if (process.env.ENV === 'dev') {
+                console.log(`Registering message context menu: ${cmd.name}`);
+            }
+            return cmd.toJSON();
+        });
+        return [...slashCommands, ...userContextMenus, ...messageContextMenus];
     }
     /**
      * Generate paginated help pages for display in help command
@@ -112,41 +231,131 @@ export class CommandManager {
         await command.execute(interaction, client);
     }
     /**
-     * Get total number of registered commands
+     * Execute a user context menu command.
+     */
+    async executeUserContextMenu(commandName, interaction, client) {
+        const command = this.userContextMenuCommands.get(commandName);
+        if (!command) {
+            throw new Error(`User context menu command not found: ${commandName}`);
+        }
+        await command.execute(interaction, client);
+    }
+    /**
+     * Execute a message context menu command.
+     */
+    async executeMessageContextMenu(commandName, interaction, client) {
+        const command = this.messageContextMenuCommands.get(commandName);
+        if (!command) {
+            throw new Error(`Message context menu command not found: ${commandName}`);
+        }
+        await command.execute(interaction, client);
+    }
+    /**
+     * Get total number of registered slash commands
      */
     get size() {
         return this.commands.size;
     }
     /**
-     * Check if a command exists
+     * Get total number of all registered commands
+     */
+    get totalSize() {
+        return this.commands.size +
+            this.userContextMenuCommands.size +
+            this.messageContextMenuCommands.size;
+    }
+    /**
+     * Check if a slash command exists
      */
     has(name) {
         return this.commands.has(name);
     }
     /**
-     * Remove a command (useful for hot-reloading in dev)
+     * Check if a user context menu command exists
+     */
+    hasUserContextMenu(name) {
+        return this.userContextMenuCommands.has(name);
+    }
+    /**
+     * Check if a message context menu command exists
+     */
+    hasMessageContextMenu(name) {
+        return this.messageContextMenuCommands.has(name);
+    }
+    /**
+     * Check if any command (slash, user context, or message context) exists
+     */
+    hasAny(name) {
+        return this.commands.has(name) ||
+            this.userContextMenuCommands.has(name) ||
+            this.messageContextMenuCommands.has(name);
+    }
+    /**
+     * Remove a slash command (useful for hot-reloading in dev)
      */
     unregister(name) {
         return this.commands.delete(name);
     }
     /**
-     * Clear all commands
+     * Remove a user context menu command
+     */
+    unregisterUserContextMenu(name) {
+        return this.userContextMenuCommands.delete(name);
+    }
+    /**
+     * Remove a message context menu command
+     */
+    unregisterMessageContextMenu(name) {
+        return this.messageContextMenuCommands.delete(name);
+    }
+    /**
+     * Clear all commands (slash commands, user context menus, and message context menus)
      */
     clear() {
         this.commands.clear();
+        this.userContextMenuCommands.clear();
+        this.messageContextMenuCommands.clear();
     }
     /**
-     * Get command names as an array
+     * Get slash command names as an array
      */
     getCommandNames() {
         return Array.from(this.commands.keys());
     }
+    /**
+     * Get user context menu command names as an array
+     */
+    getUserContextMenuNames() {
+        return Array.from(this.userContextMenuCommands.keys());
+    }
+    /**
+     * Get message context menu command names as an array
+     */
+    getMessageContextMenuNames() {
+        return Array.from(this.messageContextMenuCommands.keys());
+    }
+    /**
+     * Get all command names (slash + context menus) as an array
+     */
+    getAllCommandNames() {
+        return [
+            ...this.getCommandNames(),
+            ...this.getUserContextMenuNames(),
+            ...this.getMessageContextMenuNames(),
+        ];
+    }
     setLogger(logger) {
         this.logger = logger;
         // Inject logger into all already-registered commands
         for (const command of this.commands.values()) {
             command.setLogger(logger);
         }
+        for (const command of this.userContextMenuCommands.values()) {
+            command.setLogger(logger);
+        }
+        for (const command of this.messageContextMenuCommands.values()) {
+            command.setLogger(logger);
+        }
         return this;
     }
     /**
@@ -157,6 +366,12 @@ export class CommandManager {
         for (const command of this.commands.values()) {
             command.setErrorReporter(reporter);
         }
+        for (const command of this.userContextMenuCommands.values()) {
+            command.setErrorReporter(reporter);
+        }
+        for (const command of this.messageContextMenuCommands.values()) {
+            command.setErrorReporter(reporter);
+        }
         return this;
     }
 }