commandkit 0.1.6-dev.20231112143016 → 0.1.6-dev.20231113064545

package/bin/build.mjs

@@ -1,8 +1,8 @@
 // @ts-check
 
 import { build } from 'tsup';
-import ora from 'ora';
 import { Colors, erase, findCommandKitJSON, panic, write } from './common.mjs';
+import ora from 'ora';
 
 export async function bootstrapProductionBuild(config) {
     const { minify = false, outDir = 'dist', main, src } = findCommandKitJSON(config);

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { CommandInteraction, Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, PermissionResolvable, APIApplicationCommandOption, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder } from 'discord.js';
+import { CommandInteraction, Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, PermissionsString, APIApplicationCommandOption, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder } from 'discord.js';
 
 interface CommandProps {
     interaction: CommandInteraction;
@@ -25,8 +25,8 @@ interface CommandOptions {
     guildOnly?: boolean;
     devOnly?: boolean;
     deleted?: boolean;
-    userPermissions?: PermissionResolvable;
-    botPermissions?: PermissionResolvable;
+    userPermissions?: PermissionsString[];
+    botPermissions?: PermissionsString[];
     [key: string]: any;
 }
 declare enum CommandType {
@@ -176,13 +176,15 @@ declare class ButtonKit extends ButtonBuilder {
      *   .setStyle(ButtonStyle.Primary)
      *   .setCustomId('click_me');
      *
-     * const message = await channel.send({ content: 'Click the button', components: [new MessageActionRow().addComponents(button)] });
+     * const row = new ActionRowBuilder().addComponents(button);
+     *
+     * const message = await channel.send({ content: 'Click the button', components: [row] });
      *
      * button.onClick(async (interaction) => {
      *   await interaction.reply('You clicked me!');
      * }, { message });
      *
-     * // remove onClick handler and destroy the interaction collector
+     * // Remove onClick handler and destroy the interaction collector
      * button.onClick(null);
      * ```
      */

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { CommandInteraction, Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, PermissionResolvable, APIApplicationCommandOption, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder } from 'discord.js';
+import { CommandInteraction, Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, PermissionsString, APIApplicationCommandOption, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder } from 'discord.js';
 
 interface CommandProps {
     interaction: CommandInteraction;
@@ -25,8 +25,8 @@ interface CommandOptions {
     guildOnly?: boolean;
     devOnly?: boolean;
     deleted?: boolean;
-    userPermissions?: PermissionResolvable;
-    botPermissions?: PermissionResolvable;
+    userPermissions?: PermissionsString[];
+    botPermissions?: PermissionsString[];
     [key: string]: any;
 }
 declare enum CommandType {
@@ -176,13 +176,15 @@ declare class ButtonKit extends ButtonBuilder {
      *   .setStyle(ButtonStyle.Primary)
      *   .setCustomId('click_me');
      *
-     * const message = await channel.send({ content: 'Click the button', components: [new MessageActionRow().addComponents(button)] });
+     * const row = new ActionRowBuilder().addComponents(button);
+     *
+     * const message = await channel.send({ content: 'Click the button', components: [row] });
      *
      * button.onClick(async (interaction) => {
      *   await interaction.reply('You clicked me!');
      * }, { message });
      *
-     * // remove onClick handler and destroy the interaction collector
+     * // Remove onClick handler and destroy the interaction collector
      * button.onClick(null);
      * ```
      */

package/dist/index.js

@@ -364,33 +364,6 @@ async function registerDevCommands(client, commands, guildIds) {
   }
 }
 
-// src/handlers/command-handler/validations/botPermissions.ts
-function botPermissions_default({ interaction, targetCommand }) {
-  const botMember = interaction.guild?.members.me;
-  let commandPermissions = targetCommand.options?.botPermissions;
-  if (!botMember || !commandPermissions)
-    return;
-  if (!Array.isArray(commandPermissions)) {
-    commandPermissions = [commandPermissions];
-  }
-  const missingPermissions = [];
-  for (const permission of commandPermissions) {
-    const hasPermission = botMember.permissions.has(permission);
-    if (!hasPermission) {
-      missingPermissions.push(`\`${permission.toString()}\``);
-    }
-  }
-  if (missingPermissions.length) {
-    interaction.reply({
-      content: `\u274C I do not have enough permissions to execute this command. Missing: ${missingPermissions.join(
-        ", "
-      )}`,
-      ephemeral: true
-    });
-    return true;
-  }
-}
-
 // src/handlers/command-handler/validations/devOnly.ts
 function devOnly_default({ interaction, targetCommand, handlerData }) {
   if (targetCommand.options?.devOnly) {
@@ -431,35 +404,66 @@ function guildOnly_default({ interaction, targetCommand }) {
   }
 }
 
-// src/handlers/command-handler/validations/userPermissions.ts
-function userPermissions_default({ interaction, targetCommand }) {
-  const memberPermissions = interaction.memberPermissions;
-  let commandPermissions = targetCommand.options?.userPermissions;
-  if (!memberPermissions || !commandPermissions)
+// src/handlers/command-handler/validations/permissions.ts
+var import_discord = require("discord.js");
+function permissions_default({ interaction, targetCommand }) {
+  const userPermissions = interaction.memberPermissions;
+  let userPermissionsRequired = targetCommand.options?.userPermissions;
+  let missingUserPermissions = [];
+  const botPermissions = interaction.guild?.members.me?.permissions;
+  let botPermissionsRequired = targetCommand.options?.botPermissions;
+  let missingBotPermissions = [];
+  if (!userPermissionsRequired?.length && !botPermissionsRequired?.length) {
     return;
-  if (!Array.isArray(commandPermissions)) {
-    commandPermissions = [commandPermissions];
   }
-  const missingPermissions = [];
-  for (const permission of commandPermissions) {
-    const hasPermission = memberPermissions.has(permission);
-    if (!hasPermission) {
-      missingPermissions.push(`\`${permission.toString()}\``);
+  if (userPermissions && userPermissionsRequired) {
+    for (const permission of userPermissionsRequired) {
+      const hasPermission = userPermissions.has(permission);
+      if (!hasPermission) {
+        missingUserPermissions.push(permission);
+      }
     }
   }
-  if (missingPermissions.length) {
-    interaction.reply({
-      content: `\u274C You do not have enough permissions to run this command. Missing: ${missingPermissions.join(
-        ", "
-      )}`,
-      ephemeral: true
-    });
-    return true;
+  if (botPermissions && botPermissionsRequired) {
+    for (const permission of botPermissionsRequired) {
+      const hasPermission = botPermissions.has(permission);
+      if (!hasPermission) {
+        missingBotPermissions.push(permission);
+      }
+    }
+  }
+  if (!missingUserPermissions.length && !missingBotPermissions.length) {
+    return;
   }
+  const pattern = /([a-z])([A-Z])|([A-Z]+)([A-Z][a-z])/g;
+  missingUserPermissions = missingUserPermissions.map((str) => str.replace(pattern, "$1$3 $2$4"));
+  missingBotPermissions = missingBotPermissions.map((str) => str.replace(pattern, "$1$3 $2$4"));
+  let embedDescription = "";
+  const formatter = new Intl.ListFormat("en", { style: "long", type: "conjunction" });
+  const getPermissionWord = (permissions) => permissions.length === 1 ? "permission" : "permissions";
+  if (missingUserPermissions.length) {
+    const formattedPermissions = missingUserPermissions.map((p) => `\`${p}\``);
+    const permissionsString = formatter.format(formattedPermissions);
+    embedDescription += `- You must have the ${permissionsString} ${getPermissionWord(
+      missingUserPermissions
+    )} to be able to run this command.
+`;
+  }
+  if (missingBotPermissions.length) {
+    const formattedPermissions = missingBotPermissions.map((p) => `\`${p}\``);
+    const permissionsString = formatter.format(formattedPermissions);
+    embedDescription += `- I must have the ${permissionsString} ${getPermissionWord(
+      missingBotPermissions
+    )} to be able to execute this command.
+`;
+  }
+  const embed = new import_discord.EmbedBuilder().setTitle(`:x: Missing permissions!`).setDescription(embedDescription).setColor("Red");
+  interaction.reply({ embeds: [embed], ephemeral: true });
+  return true;
 }
 
 // src/handlers/command-handler/validations/index.ts
-var validations_default = [botPermissions_default, devOnly_default, guildOnly_default, userPermissions_default];
+var validations_default = [devOnly_default, guildOnly_default, permissions_default];
 
 // src/handlers/command-handler/CommandHandler.ts
 var import_rfdc = __toESM(require("rfdc"));
@@ -903,15 +907,15 @@ var CommandKit = class {
   }
 };
 
-// src/components/Button.ts
-var import_discord = require("discord.js");
-var ButtonKit = class extends import_discord.ButtonBuilder {
+// src/components/ButtonKit.ts
+var import_discord2 = require("discord.js");
+var ButtonKit = class extends import_discord2.ButtonBuilder {
   #onClickHandler = null;
   #contextData = null;
   #collector = null;
   onClick(handler, data) {
-    if (this.data.style === import_discord.ButtonStyle.Link) {
-      throw new TypeError('Cannot setup "onClick" handler for link buttons');
+    if (this.data.style === import_discord2.ButtonStyle.Link) {
+      throw new TypeError('Cannot setup "onClick" handler on link buttons.');
     }
     this.#destroyCollector();
     this.#onClickHandler = handler;
@@ -923,14 +927,14 @@ var ButtonKit = class extends import_discord.ButtonBuilder {
   #setupInteractionCollector() {
     if (!this.#contextData || !this.#onClickHandler)
       return;
-    const message = this.#contextData?.message;
+    const message = this.#contextData.message;
     if (!message) {
       throw new TypeError(
-        'Cannot setup "onClick" handler without a message in the context data'
+        'Cannot setup "onClick" handler without a message in the context data.'
       );
     }
     if ("customId" in this.data && !this.data.customId) {
-      throw new TypeError('Cannot setup "onClick" handler without a custom id');
+      throw new TypeError('Cannot setup "onClick" handler on a button without a custom id.');
     }
     const data = {
       time: 864e5,
@@ -939,7 +943,7 @@ var ButtonKit = class extends import_discord.ButtonBuilder {
     };
     const collector = this.#collector = message.createMessageComponentCollector({
       filter: (interaction) => interaction.customId === this.data.custom_id && interaction.message.id === message.id,
-      componentType: import_discord.ComponentType.Button,
+      componentType: import_discord2.ComponentType.Button,
       ...data
     });
     this.#collector.on("collect", (interaction) => {
@@ -950,7 +954,7 @@ var ButtonKit = class extends import_discord.ButtonBuilder {
         return collector.stop("destroyed");
       }
       if (data.autoReset) {
-        this.#collector?.resetTimer();
+        this.#collector.resetTimer();
       }
       return handler(interaction);
     });

package/dist/index.mjs

@@ -331,33 +331,6 @@ async function registerDevCommands(client, commands, guildIds) {
   }
 }
 
-// src/handlers/command-handler/validations/botPermissions.ts
-function botPermissions_default({ interaction, targetCommand }) {
-  const botMember = interaction.guild?.members.me;
-  let commandPermissions = targetCommand.options?.botPermissions;
-  if (!botMember || !commandPermissions)
-    return;
-  if (!Array.isArray(commandPermissions)) {
-    commandPermissions = [commandPermissions];
-  }
-  const missingPermissions = [];
-  for (const permission of commandPermissions) {
-    const hasPermission = botMember.permissions.has(permission);
-    if (!hasPermission) {
-      missingPermissions.push(`\`${permission.toString()}\``);
-    }
-  }
-  if (missingPermissions.length) {
-    interaction.reply({
-      content: `\u274C I do not have enough permissions to execute this command. Missing: ${missingPermissions.join(
-        ", "
-      )}`,
-      ephemeral: true
-    });
-    return true;
-  }
-}
-
 // src/handlers/command-handler/validations/devOnly.ts
 function devOnly_default({ interaction, targetCommand, handlerData }) {
   if (targetCommand.options?.devOnly) {
@@ -398,35 +371,66 @@ function guildOnly_default({ interaction, targetCommand }) {
   }
 }
 
-// src/handlers/command-handler/validations/userPermissions.ts
-function userPermissions_default({ interaction, targetCommand }) {
-  const memberPermissions = interaction.memberPermissions;
-  let commandPermissions = targetCommand.options?.userPermissions;
-  if (!memberPermissions || !commandPermissions)
+// src/handlers/command-handler/validations/permissions.ts
+import { EmbedBuilder } from "discord.js";
+function permissions_default({ interaction, targetCommand }) {
+  const userPermissions = interaction.memberPermissions;
+  let userPermissionsRequired = targetCommand.options?.userPermissions;
+  let missingUserPermissions = [];
+  const botPermissions = interaction.guild?.members.me?.permissions;
+  let botPermissionsRequired = targetCommand.options?.botPermissions;
+  let missingBotPermissions = [];
+  if (!userPermissionsRequired?.length && !botPermissionsRequired?.length) {
     return;
-  if (!Array.isArray(commandPermissions)) {
-    commandPermissions = [commandPermissions];
   }
-  const missingPermissions = [];
-  for (const permission of commandPermissions) {
-    const hasPermission = memberPermissions.has(permission);
-    if (!hasPermission) {
-      missingPermissions.push(`\`${permission.toString()}\``);
+  if (userPermissions && userPermissionsRequired) {
+    for (const permission of userPermissionsRequired) {
+      const hasPermission = userPermissions.has(permission);
+      if (!hasPermission) {
+        missingUserPermissions.push(permission);
+      }
     }
   }
-  if (missingPermissions.length) {
-    interaction.reply({
-      content: `\u274C You do not have enough permissions to run this command. Missing: ${missingPermissions.join(
-        ", "
-      )}`,
-      ephemeral: true
-    });
-    return true;
+  if (botPermissions && botPermissionsRequired) {
+    for (const permission of botPermissionsRequired) {
+      const hasPermission = botPermissions.has(permission);
+      if (!hasPermission) {
+        missingBotPermissions.push(permission);
+      }
+    }
+  }
+  if (!missingUserPermissions.length && !missingBotPermissions.length) {
+    return;
   }
+  const pattern = /([a-z])([A-Z])|([A-Z]+)([A-Z][a-z])/g;
+  missingUserPermissions = missingUserPermissions.map((str) => str.replace(pattern, "$1$3 $2$4"));
+  missingBotPermissions = missingBotPermissions.map((str) => str.replace(pattern, "$1$3 $2$4"));
+  let embedDescription = "";
+  const formatter = new Intl.ListFormat("en", { style: "long", type: "conjunction" });
+  const getPermissionWord = (permissions) => permissions.length === 1 ? "permission" : "permissions";
+  if (missingUserPermissions.length) {
+    const formattedPermissions = missingUserPermissions.map((p) => `\`${p}\``);
+    const permissionsString = formatter.format(formattedPermissions);
+    embedDescription += `- You must have the ${permissionsString} ${getPermissionWord(
+      missingUserPermissions
+    )} to be able to run this command.
+`;
+  }
+  if (missingBotPermissions.length) {
+    const formattedPermissions = missingBotPermissions.map((p) => `\`${p}\``);
+    const permissionsString = formatter.format(formattedPermissions);
+    embedDescription += `- I must have the ${permissionsString} ${getPermissionWord(
+      missingBotPermissions
+    )} to be able to execute this command.
+`;
+  }
+  const embed = new EmbedBuilder().setTitle(`:x: Missing permissions!`).setDescription(embedDescription).setColor("Red");
+  interaction.reply({ embeds: [embed], ephemeral: true });
+  return true;
 }
 
 // src/handlers/command-handler/validations/index.ts
-var validations_default = [botPermissions_default, devOnly_default, guildOnly_default, userPermissions_default];
+var validations_default = [devOnly_default, guildOnly_default, permissions_default];
 
 // src/handlers/command-handler/CommandHandler.ts
 import rdfc from "rfdc";
@@ -870,15 +874,19 @@ var CommandKit = class {
   }
 };
 
-// src/components/Button.ts
-import { ButtonBuilder, ButtonStyle, ComponentType } from "discord.js";
+// src/components/ButtonKit.ts
+import {
+  ButtonStyle,
+  ButtonBuilder,
+  ComponentType
+} from "discord.js";
 var ButtonKit = class extends ButtonBuilder {
   #onClickHandler = null;
   #contextData = null;
   #collector = null;
   onClick(handler, data) {
     if (this.data.style === ButtonStyle.Link) {
-      throw new TypeError('Cannot setup "onClick" handler for link buttons');
+      throw new TypeError('Cannot setup "onClick" handler on link buttons.');
     }
     this.#destroyCollector();
     this.#onClickHandler = handler;
@@ -890,14 +898,14 @@ var ButtonKit = class extends ButtonBuilder {
   #setupInteractionCollector() {
     if (!this.#contextData || !this.#onClickHandler)
       return;
-    const message = this.#contextData?.message;
+    const message = this.#contextData.message;
     if (!message) {
       throw new TypeError(
-        'Cannot setup "onClick" handler without a message in the context data'
+        'Cannot setup "onClick" handler without a message in the context data.'
       );
     }
     if ("customId" in this.data && !this.data.customId) {
-      throw new TypeError('Cannot setup "onClick" handler without a custom id');
+      throw new TypeError('Cannot setup "onClick" handler on a button without a custom id.');
     }
     const data = {
       time: 864e5,
@@ -917,7 +925,7 @@ var ButtonKit = class extends ButtonBuilder {
         return collector.stop("destroyed");
       }
       if (data.autoReset) {
-        this.#collector?.resetTimer();
+        this.#collector.resetTimer();
       }
       return handler(interaction);
     });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "commandkit",
   "description": "Beginner friendly command & event handler for Discord.js",
-  "version": "0.1.6-dev.20231112143016",
+  "version": "0.1.6-dev.20231113064545",
   "license": "MIT",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",