fix: user/bot permissions middleware to support message commands + acknowledge dms

Author: notunderctrl

apps/test-bot/src/app.ts

@@ -1,4 +1,4 @@
-import { Client } from 'discord.js';
+import { Client, Partials } from 'discord.js';
 import { Logger, commandkit } from 'commandkit';
 import { setDriver } from '@commandkit/tasks';
 import { SQLiteDriver } from '@commandkit/tasks/sqlite';
@@ -11,7 +11,9 @@ const client = new Client({
     'GuildMessages',
     'MessageContent',
     'GuildMessageTyping',
+    'DirectMessages',
   ],
+  partials: [Partials.Channel, Partials.Message, Partials.User],
 });
 
 setDriver(new SQLiteDriver('./tasks.db'));

apps/test-bot/src/app/commands/(general)/ping.ts

@@ -1,13 +1,16 @@
 import {
   ActionRowBuilder,
   ApplicationCommandOptionType,
+  ApplicationIntegrationType,
   ButtonStyle,
 } from 'discord.js';
 import {
   CommandData,
   ButtonKit,
   ChatInputCommandContext,
   AutocompleteCommandContext,
+  CommandMetadata,
+  MessageCommandContext,
 } from 'commandkit';
 
 export const command: CommandData = {
@@ -22,6 +25,17 @@ export const command: CommandData = {
       required: false,
     },
   ],
+  integration_types: [
+    ApplicationIntegrationType.GuildInstall,
+    ApplicationIntegrationType.UserInstall,
+  ],
+  // guilds: ['1314834483660455938'],
+};
+
+export const metadata: CommandMetadata = {
+  userPermissions: 'Administrator',
+  botPermissions: 'KickMembers',
+  // guilds: ['1314834483660455938'],
 };
 
 const tests = Array.from({ length: 10 }, (_, i) => ({
@@ -43,6 +57,10 @@ export async function autocomplete({
   interaction.respond(filtered);
 }
 
+export async function message({ message }: MessageCommandContext) {
+  message.reply('Pong!');
+}
+
 export async function chatInput({
   interaction,
   client,

apps/website/docs/guide/02-commands/07-middlewares.mdx

@@ -36,7 +36,7 @@ export function afterExecute(ctx: MiddlewareContext) {
 
 ## Stop command execution
 
-You can stop a command from running by calling `ctx.cancel()` in the
+You can stop a command from running by returning `ctx.cancel()` in the
 `beforeExecute` function.
 
 ```ts title="src/app/commands/+middleware.ts"
@@ -46,7 +46,7 @@ export function beforeExecute(ctx: MiddlewareContext) {
   if (ctx.interaction.user.id !== '1234567890') {
     // Conditionally stop command execution
     console.log(`${ctx.commandName} will not be executed!`);
-    ctx.cancel();
+    return ctx.cancel();
   }
 
   // Continue with command execution

packages/commandkit/src/app/middlewares/permissions.ts

@@ -1,19 +1,7 @@
-import {
-  EmbedBuilder,
-  PermissionFlags,
-  PermissionFlagsBits,
-  PermissionResolvable,
-} from 'discord.js';
-import { MiddlewareContext } from '../commands/Context';
+import { EmbedBuilder, MessageFlags } from 'discord.js';
 import { getConfig } from '../../config/config';
-
-const findName = (flags: PermissionFlags, flag: PermissionResolvable) => {
-  if (typeof flag === 'string') return flag;
-
-  return (
-    Object.entries(flags).find(([_, value]) => value === flag)?.[0] ?? `${flag}`
-  );
-};
+import { Logger } from '../../logger/Logger';
+import { MiddlewareContext } from '../commands/Context';
 
 export const middlewareId = crypto.randomUUID();
 
@@ -22,55 +10,85 @@ export const middlewareId = crypto.randomUUID();
  * @ignore
  */
 export async function beforeExecute(ctx: MiddlewareContext) {
-  if (getConfig().disablePermissionsMiddleware) return;
+  if (getConfig().disablePermissionsMiddleware) {
+    return;
+  }
+
+  const { interaction, message, command } = ctx;
+
+  if (interaction && !interaction.isCommand()) {
+    return;
+  }
 
-  const { interaction, command } = ctx;
+  if (
+    (interaction && interaction.channel?.isDMBased()) ||
+    (message && message.channel?.isDMBased())
+  ) {
+    const channel = interaction?.channel ?? message?.channel;
+
+    const embed = new EmbedBuilder()
+      .setTitle(':x: Server-only command!')
+      .setDescription('This command can only be used in a server.')
+      .setColor('Red');
+
+    try {
+      if (channel?.isSendable()) {
+        if (interaction && interaction.isRepliable()) {
+          await interaction.reply({
+            embeds: [embed],
+            flags: MessageFlags.Ephemeral,
+          });
+        } else {
+          await message.reply({ embeds: [embed] });
+        }
+      }
+    } catch (error) {
+      Logger.error(
+        `Could not send 'Server-only command' DM to user ${interaction?.user.id ?? message?.author.id} for command ${command.command.name}.`,
+        error,
+      );
+    }
+
+    return ctx.cancel(); // Stop the command from executing
+  }
 
-  if (interaction.isAutocomplete()) return;
-  const userPermissions = interaction.memberPermissions;
-  let userPermissionsRequired = command.metadata?.userPermissions;
+  const userPermissions =
+    interaction?.memberPermissions ?? message?.member?.permissions;
+  let userPermissionsRequired = command.metadata?.userPermissions ?? [];
   let missingUserPermissions: string[] = [];
 
   if (typeof userPermissionsRequired === 'string') {
     userPermissionsRequired = [userPermissionsRequired];
   }
 
-  const botPermissions = interaction.guild?.members.me?.permissions;
-  let botPermissionsRequired = command.metadata?.botPermissions;
+  const botPermissions =
+    interaction?.guild?.members.me?.permissions ??
+    message?.guild?.members.me?.permissions;
+  let botPermissionsRequired = command.metadata?.botPermissions ?? [];
   let missingBotPermissions: string[] = [];
 
   if (typeof botPermissionsRequired === 'string') {
     botPermissionsRequired = [botPermissionsRequired];
   }
 
-  if (!userPermissionsRequired?.length && !botPermissionsRequired?.length) {
+  if (!userPermissionsRequired.length && !botPermissionsRequired.length) {
     return;
   }
 
-  if (userPermissions && userPermissionsRequired) {
+  if (userPermissionsRequired.length) {
     for (const permission of userPermissionsRequired) {
-      const hasPermission = userPermissions.has(permission);
-
+      const hasPermission = userPermissions?.has(permission);
       if (!hasPermission) {
-        missingUserPermissions.push(
-          typeof permission === 'string'
-            ? permission
-            : findName(PermissionFlagsBits, permission),
-        );
+        missingUserPermissions.push(permission);
       }
     }
   }
 
-  if (botPermissions && botPermissionsRequired) {
+  if (botPermissionsRequired.length) {
     for (const permission of botPermissionsRequired) {
-      const hasPermission = botPermissions.has(permission);
-
+      const hasPermission = botPermissions?.has(permission);
       if (!hasPermission) {
-        missingBotPermissions.push(
-          typeof permission === 'string'
-            ? permission
-            : findName(PermissionFlagsBits, permission),
-        );
+        missingBotPermissions.push(permission);
       }
     }
   }
@@ -79,7 +97,7 @@ export async function beforeExecute(ctx: MiddlewareContext) {
     return;
   }
 
-  // Fix casing. e.g. KickMembers -> Kick Members
+  // Fix permission string. e.g. KickMembers -> Kick Members
   const pattern = /([a-z])([A-Z])|([A-Z]+)([A-Z][a-z])/g;
 
   missingUserPermissions = missingUserPermissions.map((str) =>
@@ -123,6 +141,23 @@ export async function beforeExecute(ctx: MiddlewareContext) {
     .setDescription(embedDescription)
     .setColor('Red');
 
-  await interaction.reply({ embeds: [embed], ephemeral: true });
-  return true;
+  try {
+    if (interaction && interaction.isRepliable()) {
+      await interaction.reply({
+        embeds: [embed],
+        flags: MessageFlags.Ephemeral,
+      });
+    } else if (message && message.channel?.isSendable()) {
+      await message.reply({
+        embeds: [embed],
+      });
+    }
+  } catch (error) {
+    Logger.error(
+      `Could not send 'Not enough permissions' reply to user ${interaction?.user.id ?? message?.author.id} for command ${command.command.name}.`,
+      error,
+    );
+  }
+
+  return ctx.cancel(); // Stop the command from executing
 }

packages/commandkit/src/types.ts

@@ -4,6 +4,7 @@ import type {
   ClientEvents,
   Interaction,
   PermissionResolvable,
+  PermissionsString,
   RESTPostAPIApplicationCommandsJSONBody,
 } from 'discord.js';
 import type { CommandKit } from './commandkit';
@@ -58,11 +59,11 @@ export interface CommandMetadata {
   /**
    * The user permissions required to execute the command.
    */
-  userPermissions?: PermissionResolvable[];
+  userPermissions?: PermissionsString | PermissionsString[];
   /**
    * The bot permissions required to execute the command.
    */
-  botPermissions?: PermissionResolvable[];
+  botPermissions?: PermissionsString | PermissionsString[];
 }
 
 /**
@@ -71,12 +72,12 @@ export interface CommandMetadata {
 export interface LegacyCommandMetadata {
   /**
    * The aliases of the command.
-   * @deprecated Use `metadata` or `generateMetadata` instead.
+   * @deprecated Use `metadata.aliases` or `generateMetadata` instead.
    */
   aliases?: string[];
   /**
    * The guilds that the command is available in.
-   * @deprecated Use `metadata` or `generateMetadata` instead.
+   * @deprecated Use `metadata.guilds` or `generateMetadata` instead.
    */
   guilds?: string[];
 }