@julanzw/ttoolbox-discordjs-framework 1.3.0 → 1.4.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

@@ -116,7 +116,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/SubcommandGroup.class.d.ts

@@ -35,20 +35,6 @@ export declare abstract class SubcommandGroup {
     protected logger?: ILogger;
     /** ErrorReporter instance to use inside the subcommand group */
     private errorReporter?;
-    /**
-     * Safely executes a function with error handling and logging.
-     *
-     * Wraps the execution in a try-catch block, logs successful executions,
-     * and automatically handles errors by logging them and sending a user-friendly
-     * error message.
-     *
-     * @param subcommandName - The name of the subcommand
-     * @param scope - The logging scope for this execution
-     * @param interaction - The command interaction
-     * @param fn - The function to execute
-     * @private
-     */
-    private safeExecute;
     /**
      * Executes the appropriate subcommand based on the user's interaction.
      *
@@ -131,4 +117,19 @@ export declare abstract class SubcommandGroup {
      * Set the error reporter for this subcommand group.
      */
     setErrorReporter(reporter: ErrorReporter): this;
+    /**
+     * Lifecycle hook called before any subcommand in this group executes.
+     *
+     * @param interaction - The command interaction
+     * @returns true to continue, false to stop execution
+     */
+    protected beforeExecute?(interaction: ChatInputCommandInteraction, client: Client): Promise<boolean | void>;
+    /**
+     * Lifecycle hook called after any subcommand in this group executes successfully.
+     */
+    protected afterExecute?(interaction: ChatInputCommandInteraction, client: Client): Promise<void>;
+    /**
+     * Lifecycle hook called when any subcommand in this group fails.
+     */
+    protected onError?(interaction: ChatInputCommandInteraction, error: Error, client: Client): Promise<void>;
 }

package/dist/classes/SubcommandGroup.class.js

@@ -1,5 +1,4 @@
 import { SlashCommandBuilder, } from 'discord.js';
-import { safeReply } from '../utils/editAndReply.js';
 /**
  * Abstract base class for Discord slash command groups with subcommands.
  *
@@ -23,36 +22,6 @@ import { safeReply } from '../utils/editAndReply.js';
  * ```
  */
 export class SubcommandGroup {
-    /**
-     * Safely executes a function with error handling and logging.
-     *
-     * Wraps the execution in a try-catch block, logs successful executions,
-     * and automatically handles errors by logging them and sending a user-friendly
-     * error message.
-     *
-     * @param subcommandName - The name of the subcommand
-     * @param scope - The logging scope for this execution
-     * @param interaction - The command interaction
-     * @param fn - The function to execute
-     * @private
-     */
-    async safeExecute(subcommandName, scope, interaction, fn) {
-        try {
-            await fn();
-            this.logger?.log(`${this.name} (${subcommandName}) command executed`, 'info', scope);
-        }
-        catch (err) {
-            this.logger?.log('An Error occured' + err, 'error', scope, true);
-            await this.errorReporter?.reportError(err, `Command: ${subcommandName} in SubcommandGroup: ${this.name}`, {
-                user: interaction.user.tag,
-                userId: interaction.user.id,
-                guild: interaction.guild?.name,
-                guildId: interaction.guildId,
-                channel: interaction.channel?.id,
-            });
-            return await safeReply(interaction, 'An unexpected error occurred.');
-        }
-    }
     /**
      * Executes the appropriate subcommand based on the user's interaction.
      *
@@ -79,8 +48,24 @@ export class SubcommandGroup {
         if (!subcommand) {
             throw new Error(`Unknown subcommand: ${subcommandName}`);
         }
-        const scope = `${subcommand.name}_EXECUTION`;
-        await this.safeExecute(subcommandName, scope, interaction, () => subcommand.execute(interaction, client));
+        if (this.beforeExecute) {
+            const shouldContinue = await this.beforeExecute(interaction, client);
+            if (shouldContinue === false) {
+                return;
+            }
+        }
+        try {
+            await subcommand.execute(interaction, client);
+            if (this.afterExecute) {
+                await this.afterExecute(interaction, client);
+            }
+        }
+        catch (err) {
+            if (this.onError) {
+                await this.onError(interaction, err, client);
+            }
+            throw err;
+        }
     }
     /**
      * Converts the command group to Discord API JSON format for registration.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@julanzw/ttoolbox-discordjs-framework",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "A Discord.js command framework with built-in handlers and utilities",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",