feat: middlewares

Author: twlite

apps/test-bot/src/app/commands/prompt/middleware.ts

@@ -0,0 +1,25 @@
+import { MiddlewareContext } from 'commandkit';
+import { MessageFlags } from 'discord.js';
+
+export function beforeExecute(ctx: MiddlewareContext) {
+  console.log('Pre-command middleware');
+
+  const user = ctx.isInteraction() ? ctx.interaction.user : ctx.message.author;
+
+  if (ctx.commandName === 'prompt' && user.id === '159985870458322944') {
+    if (ctx.isSlashCommand()) {
+      ctx.interaction.reply({
+        content: 'You are not allowed to use this command.',
+        flags: MessageFlags.Ephemeral,
+      });
+    } else {
+      ctx.message.reply('You are not allowed to use this command.');
+    }
+
+    ctx.cancel();
+  }
+}
+
+export function afterExecute(ctx: MiddlewareContext) {
+  console.log('Post-command middleware executed');
+}

packages/commandkit/src/app/command-handler/AppCommandHandler.ts

@@ -107,12 +107,14 @@ export class AppCommandHandler {
               ? loadedCommand.data.command.toJSON()
               : loadedCommand.data.command;
 
-          return json.options.reduce(
-            (acc: Record<string, unknown>, opt: Record<string, any>) => {
-              acc[opt.name] = opt.type;
-              return acc;
-            },
-            {} as Record<string, unknown>,
+          return (
+            json.options?.reduce(
+              (acc: Record<string, unknown>, opt: Record<string, any>) => {
+                acc[opt.name] = opt.type;
+                return acc;
+              },
+              {} as Record<string, unknown>,
+            ) ?? {}
           );
         },
       );

packages/commandkit/src/app/commands/Context.ts

@@ -1,15 +1,9 @@
 import {
   AutocompleteInteraction,
   ChatInputCommandInteraction,
-  ContextMenuCommandInteraction,
   MessageContextMenuCommandInteraction,
   Message,
   Locale,
-  User,
-  Channel,
-  Role,
-  Attachment,
-  GuildMember,
   Interaction,
   UserContextMenuCommandInteraction,
 } from 'discord.js';
@@ -346,7 +340,7 @@ export class Context<
 }
 
 export class MiddlewareContext<
-  T extends CommandExecutionMode,
+  T extends CommandExecutionMode = CommandExecutionMode,
 > extends Context<T> {
   #cancel = false;
 

packages/commandkit/src/app/router/CommandsRouter.ts

@@ -1,6 +1,6 @@
 import { existsSync } from 'node:fs';
 import { readdir } from 'node:fs/promises';
-import { join } from 'node:path';
+import path, { join } from 'node:path';
 
 /**
  * Matcher type for identifying command and middleware files.
@@ -249,7 +249,7 @@ export class CommandsRouter {
     for (const file of files) {
       if (this.execMatcher(this.matchers.command, file)) {
         const location = this.resolveRelativePath(file);
-        const parts = location.split('/');
+        const parts = location.split(path.sep);
 
         const parentSegments: string[] = [];
 
@@ -283,10 +283,14 @@ export class CommandsRouter {
       if (this.execMatcher(this.matchers.middleware, file)) {
         const location = this.resolveRelativePath(file);
         const name = location.replace(/\.(m|c)?(j|t)sx?$/, '');
+        const middlewareDir = path.dirname(location);
 
-        const command = Array.from(this.commands.values()).filter((command) =>
-          command.path.startsWith(location),
-        );
+        const command = Array.from(this.commands.values()).filter((command) => {
+          const commandDir = path.dirname(command.path);
+          return (
+            commandDir === middlewareDir || commandDir.startsWith(middlewareDir)
+          );
+        });
 
         const id = crypto.randomUUID();
 

packages/commandkit/src/legacy/handlers/command-handler/CommandHandler.ts

@@ -36,6 +36,11 @@ export interface hCommandContext {
   command: CommandData;
 }
 
+enum CommandIndication {
+  Continue,
+  Stop,
+}
+
 /**
  * A handler for client application commands.
  */
@@ -219,20 +224,22 @@ export class CommandHandler {
     env.clearAllDeferredFunctions();
   }
 
-  async #requestExternalHandler(interaction: Interaction<CacheType> | Message) {
+  async #requestExternalHandler(
+    interaction: Interaction<CacheType> | Message,
+  ): Promise<CommandIndication> {
     const handler = this.#data.commandkitInstance.appCommandsHandler;
-    if (!handler) return false;
+    if (!handler) return CommandIndication.Continue;
 
     if (
       !(interaction instanceof Message) &&
       !(interaction.isCommand() || interaction.isAutocomplete())
     ) {
-      return false;
+      return CommandIndication.Continue;
     }
 
     const targetCommand = await handler.prepareCommandRun(interaction);
 
-    if (!targetCommand) return false;
+    if (!targetCommand) return CommandIndication.Continue;
 
     const environment = useEnvironment();
 
@@ -261,6 +268,9 @@ export class CommandHandler {
     const exec = async () => {
       if (middlewares.length > 0) {
         for (const middleware of middlewares) {
+          // command was cancelled by middleware
+          if (context.cancelled) return CommandIndication.Stop;
+
           try {
             await middleware.data.beforeExecute(context);
           } catch (e) {
@@ -281,6 +291,9 @@ export class CommandHandler {
         }
       }
 
+      // command was cancelled by middleware
+      if (context.cancelled) return CommandIndication.Stop;
+
       let postStageRunner = true;
 
       try {
@@ -368,7 +381,8 @@ export class CommandHandler {
     const shouldDebug = this.#data.commandkitInstance.isDebuggingCommands();
 
     if (!shouldDebug) {
-      return exec();
+      await exec();
+      return CommandIndication.Stop;
     }
 
     afterCommand((env) => {
@@ -394,9 +408,8 @@ export class CommandHandler {
 
     try {
       environment.markStart(`${command.data.command.name}`);
-      const res = await exec();
-
-      return res;
+      await exec();
+      return CommandIndication.Stop;
     } finally {
       environment.markEnd();
     }
@@ -407,9 +420,10 @@ export class CommandHandler {
     try {
       const result = await this.#requestExternalHandler(interaction);
 
-      if (result !== false) return;
+      if (result === CommandIndication.Stop) return;
     } catch (e) {
       console.error(e);
+      return;
     }
 
     if (
@@ -487,6 +501,8 @@ export class CommandHandler {
 
       const command = targetCommand[isAutocomplete ? 'autocomplete' : 'run']!;
 
+      if (!command) return;
+
       const context = {
         interaction,
         client: this.#data.client,