commandkit 0.1.6-dev.20231112142450 → 0.1.6-dev.20231112181436

package/bin/build.mjs

@@ -5,12 +5,7 @@ import ora from 'ora';
 import { Colors, erase, findCommandKitJSON, panic, write } from './common.mjs';
 
 export async function bootstrapProductionBuild(config) {
-    const {
-        minify = false,
-        outDir = 'dist',
-        main,
-        src,
-    } = findCommandKitJSON(config);
+    const { minify = false, outDir = 'dist', main, src } = findCommandKitJSON(config);
 
     const status = ora('Creating optimized production build...\n').start();
     const start = performance.now();
@@ -26,7 +21,7 @@ export async function bootstrapProductionBuild(config) {
             minify,
             shims: true,
             banner: {
-                js: '/* Optimized production build of your project, generated by CommandKit */'
+                js: '/* Optimized production build of your project, generated by CommandKit */',
             },
             sourcemap: false,
             keepNames: true,
@@ -35,10 +30,18 @@ export async function bootstrapProductionBuild(config) {
             entry: [src, '!dist', '!.commandkit'],
         });
 
-        status.succeed(Colors.green(`Build completed in ${(performance.now() - start).toFixed(2)}ms!`));
-        write(Colors.green(`\nRun ${Colors.magenta(`node ${outDir}/${main}`)} ${Colors.green('to start your bot.')}`))
+        status.succeed(
+            Colors.green(`Build completed in ${(performance.now() - start).toFixed(2)}ms!`),
+        );
+        write(
+            Colors.green(
+                `\nRun ${Colors.magenta(`node ${outDir}/${main}`)} ${Colors.green(
+                    'to start your bot.',
+                )}`,
+            ),
+        );
     } catch (e) {
-        status.fail(`Build failed after ${(performance.now() - start).toFixed(2)}ms!`)
+        status.fail(`Build failed after ${(performance.now() - start).toFixed(2)}ms!`);
         panic(e);
     }
-}
+}

package/bin/common.mjs

@@ -1,8 +1,8 @@
 // @ts-check
 
-import { join } from 'node:path'
+import { join } from 'node:path';
 import fs from 'node:fs';
-import { rimrafSync } from 'rimraf'
+import { rimrafSync } from 'rimraf';
 
 const resetColor = '\x1b[0m';
 
@@ -71,4 +71,4 @@ export function findCommandKitJSON(src) {
 
 export function erase(dir) {
     rimrafSync(dir);
-}
+}

package/bin/dev-server.mjs

@@ -1,17 +1,13 @@
 // @ts-check
-import { config as dotenv } from 'dotenv'
+import { config as dotenv } from 'dotenv';
 import { build } from 'tsup';
-import child_process from 'node:child_process'
+import child_process from 'node:child_process';
 import ora from 'ora';
 import { join } from 'node:path';
 import { Colors, erase, findCommandKitJSON, panic, write } from './common.mjs';
 
 export async function bootstrapDevelopmentServer(config) {
-    const {
-        src,
-        main = 'index.mjs',
-        nodeOptions = ['--watch']
-    } = findCommandKitJSON(config);
+    const { src, main = 'index.mjs', nodeOptions = ['--watch'] } = findCommandKitJSON(config);
 
     if (!src) {
         panic('Could not find src in commandkit.json');
@@ -38,14 +34,16 @@ export async function bootstrapDevelopmentServer(config) {
             watch: nodeOptions.includes('--watch'),
         });
 
-        status.succeed(Colors.green(`Server started in ${(performance.now() - start).toFixed(2)}ms!\n`));
+        status.succeed(
+            Colors.green(`Server started in ${(performance.now() - start).toFixed(2)}ms!\n`),
+        );
 
         const processEnv = {};
 
         const env = dotenv({
             path: join(process.cwd(), '.env'),
             // @ts-expect-error
-            processEnv
+            processEnv,
         });
 
         if (env.error) {
@@ -56,15 +54,19 @@ export async function bootstrapDevelopmentServer(config) {
             write(Colors.blue('[DOTENV] Loaded .env file!'));
         }
 
-        const ps = child_process.spawn('node', [...nodeOptions, join(process.cwd(), '.commandkit', main)], {
-            env: {
-                ...process.env,
-                ...processEnv,
-                NODE_ENV: 'development',
-                COMMANDKIT_DEV: 'true'
+        const ps = child_process.spawn(
+            'node',
+            [...nodeOptions, join(process.cwd(), '.commandkit', main)],
+            {
+                env: {
+                    ...process.env,
+                    ...processEnv,
+                    NODE_ENV: 'development',
+                    COMMANDKIT_DEV: 'true',
+                },
+                cwd: process.cwd(),
             },
-            cwd: process.cwd(),
-        });
+        );
 
         ps.stdout.on('data', (data) => {
             write(data.toString());
@@ -83,7 +85,7 @@ export async function bootstrapDevelopmentServer(config) {
             panic(err);
         });
     } catch (e) {
-        status.fail(`Error occurred after ${(performance.now() - start).toFixed(2)}ms!\n`)
+        status.fail(`Error occurred after ${(performance.now() - start).toFixed(2)}ms!\n`);
         panic(e);
     }
-}
+}

package/bin/index.mjs

@@ -8,20 +8,22 @@ import { bootstrapProductionBuild } from './build.mjs';
 
 const program = new Command('commandkit');
 
-program.command('dev')
+program
+    .command('dev')
     .description('Start your bot in development mode.')
     .option('-c, --config <path>', 'Path to your commandkit.json file.', './commandkit.json')
     .action(() => {
         const options = program.opts();
-        bootstrapDevelopmentServer(options.config)
+        bootstrapDevelopmentServer(options.config);
     });
 
-program.command('build')
+program
+    .command('build')
     .description('Build your project for production usage.')
     .option('-c, --config <path>', 'Path to your commandkit.json file.', './commandkit.json')
     .action(() => {
         const options = program.opts();
-        bootstrapProductionBuild(options.config)
+        bootstrapProductionBuild(options.config);
     });
 
-program.parse();
+program.parse();

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 {

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 {

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"));
@@ -904,13 +908,13 @@ var CommandKit = class {
 };
 
 // src/components/Button.ts
-var import_discord = require("discord.js");
-var ButtonKit = class extends import_discord.ButtonBuilder {
+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) {
+    if (this.data.style === import_discord2.ButtonStyle.Link) {
       throw new TypeError('Cannot setup "onClick" handler for link buttons');
     }
     this.#destroyCollector();
@@ -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) => {

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";

package/package.json

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