commandkit 0.1.6-dev.20231124182258 → 0.1.6-dev.20231125121601

package/README.md

@@ -19,7 +19,7 @@ CommandKit is a library that makes it easy to handle commands and events in your
 -   Automatic command registration, edits, and deletion 🤖
 -   Supports multiple development servers 🤝
 -   Supports multiple users as bot developers 👥
--   Object oriented 💻
+-   User friendly CLI 🖥️
 
 ## Documentation
 

package/bin/build.mjs

@@ -39,7 +39,7 @@ export async function bootstrapProductionBuild(config) {
             entry: [src, '!dist', '!.commandkit', `!${outDir}`],
         });
 
-        if (antiCrash) await injectAntiCrash(outDir, main);
+        await injectShims(outDir, main, antiCrash);
 
         status.succeed(
             Colors.green(`Build completed in ${(performance.now() - start).toFixed(2)}ms!`),
@@ -55,27 +55,32 @@ export async function bootstrapProductionBuild(config) {
     }
 }
 
-function injectAntiCrash(outDir, main) {
+async function injectShims(outDir, main, antiCrash) {
     const path = join(process.cwd(), outDir, main);
-    const snippet = [
-        '\n\n// --- CommandKit Anti-Crash Monitor ---',
-        ';(()=>{',
-        "  'use strict';",
-        "  // 'uncaughtException' event is supposed to be used to perform synchronous cleanup before shutting down the process",
-        '  // instead of using it as a means to resume operation.',
-        '  // But it exists here due to compatibility reasons with discord bot ecosystem.',
-        "  const p = (t) => `\\x1b[33m${t}\\x1b[0m`, b = '[CommandKit Anti-Crash Monitor]', l = console.log, e1 = 'uncaughtException', e2 = 'unhandledRejection';",
-        '  if (!process.eventNames().includes(e1)) // skip if it is already handled',
-        '    process.on(e1, (e, o) => {',
-        '      l(p(`${b} Uncaught Exception`)); l(p(b), p(e.stack || e));',
-        '    })',
-        '  if (!process.eventNames().includes(e2)) // skip if it is already handled',
-        '    process.on(e2, (r) => {',
-        '      l(p(`${b} Unhandled promise rejection`)); l(p(`${b} ${r.stack || r}`));',
-        '    });',
-        '})();',
-        '// --- CommandKit Anti-Crash Monitor ---\n',
-    ].join('\n');
 
-    return appendFile(path, snippet);
+    const antiCrashScript = antiCrash
+        ? [
+              '\n\n// --- CommandKit Anti-Crash Monitor ---',
+              ';(()=>{',
+              "  'use strict';",
+              "  // 'uncaughtException' event is supposed to be used to perform synchronous cleanup before shutting down the process",
+              '  // instead of using it as a means to resume operation.',
+              '  // But it exists here due to compatibility reasons with discord bot ecosystem.',
+              "  const p = (t) => `\\x1b[33m${t}\\x1b[0m`, b = '[CommandKit Anti-Crash Monitor]', l = console.log, e1 = 'uncaughtException', e2 = 'unhandledRejection';",
+              '  if (!process.eventNames().includes(e1)) // skip if it is already handled',
+              '    process.on(e1, (e) => {',
+              '      l(p(`${b} Uncaught Exception`)); l(p(b), p(e.stack || e));',
+              '    })',
+              '  if (!process.eventNames().includes(e2)) // skip if it is already handled',
+              '    process.on(e2, (r) => {',
+              '      l(p(`${b} Unhandled promise rejection`)); l(p(`${b} ${r.stack || r}`));',
+              '    });',
+              '})();',
+              '// --- CommandKit Anti-Crash Monitor ---\n',
+          ].join('\n')
+        : '';
+
+    const finalScript = [antiCrashScript].join('\n');
+
+    return appendFile(path, finalScript);
 }

package/bin/parse-env.mjs

@@ -15,6 +15,15 @@ const VALUE_PREFIXES = {
     DATE: 'DATE::',
 };
 
+function catcher(fn) {
+    try {
+        fn();
+        return true;
+    } catch {
+        return false;
+    }
+}
+
 export function parseEnv(src) {
     for (const key in src) {
         const value = src[key];
@@ -22,7 +31,7 @@ export function parseEnv(src) {
         if (typeof value !== 'string') continue;
 
         if (value.startsWith(VALUE_PREFIXES.JSON)) {
-            src[key] = JSON.parse(value.replace(VALUE_PREFIXES.JSON, ''));
+            catcher(() => (src[key] = JSON.parse(value.replace(VALUE_PREFIXES.JSON, ''))));
             continue;
         }
 

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, UserContextMenuCommandInteraction, MessageContextMenuCommandInteraction, PermissionsString, RESTPostAPIApplicationCommandsJSONBody, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder } from 'discord.js';
+import { Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, UserContextMenuCommandInteraction, MessageContextMenuCommandInteraction, AutocompleteInteraction, PermissionsString, RESTPostAPIApplicationCommandsJSONBody, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder } from 'discord.js';
 
 /**
  * Options for instantiating a CommandKit handler.
@@ -53,7 +53,7 @@ interface CommandProps {
     /**
      * The current command interaction object.
      */
-    interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction | UserContextMenuCommandInteraction | MessageContextMenuCommandInteraction;
+    interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction | UserContextMenuCommandInteraction | MessageContextMenuCommandInteraction | AutocompleteInteraction;
     /**
      * The Discord.js client object that CommandKit is handling.
      */
@@ -63,6 +63,15 @@ interface CommandProps {
      */
     handler: CommandKit;
 }
+/**
+ * Props for autocomplete command run functions.
+ */
+interface AutocompleteCommandProps extends CommandProps {
+    /**
+     * The current autocomplete command interaction object.
+     */
+    interaction: AutocompleteInteraction;
+}
 /**
  * Props for slash (chat input) command run functions.
  */
@@ -244,7 +253,11 @@ declare class CommandKit {
     get devRoleIds(): string[];
 }
 
-type CommandKitButtonBuilderInteractionCollectorDispatch = (interaction: ButtonInteraction) => Awaitable<void>;
+/**
+ * The handler to run when a button is clicked. This handler is called with the interaction as the first argument.
+ * If the first argument is null, it means that the interaction collector has been destroyed.
+ */
+type CommandKitButtonBuilderInteractionCollectorDispatch = (interaction: ButtonInteraction | null) => Awaitable<void>;
 type CommandKitButtonBuilderInteractionCollectorDispatchContextData = {
     /**
      * The message to listen for button interactions on.
@@ -358,4 +371,4 @@ declare function createSignal<T = unknown>(value?: CommandKitSignalInitializer<T
  */
 declare function createEffect(callback: CommandKitEffectCallback): void;
 
-export { ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitConfig, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, ContextMenuCommandProps, MessageContextMenuCommandProps, ReloadType, SlashCommandProps, UserContextMenuCommandProps, ValidationFunctionProps, createEffect, createSignal, defineConfig, getConfig };
+export { AutocompleteCommandProps, ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitConfig, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, ContextMenuCommandProps, MessageContextMenuCommandProps, ReloadType, SlashCommandProps, UserContextMenuCommandProps, ValidationFunctionProps, createEffect, createSignal, defineConfig, getConfig };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, UserContextMenuCommandInteraction, MessageContextMenuCommandInteraction, PermissionsString, RESTPostAPIApplicationCommandsJSONBody, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder } from 'discord.js';
+import { Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, UserContextMenuCommandInteraction, MessageContextMenuCommandInteraction, AutocompleteInteraction, PermissionsString, RESTPostAPIApplicationCommandsJSONBody, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder } from 'discord.js';
 
 /**
  * Options for instantiating a CommandKit handler.
@@ -53,7 +53,7 @@ interface CommandProps {
     /**
      * The current command interaction object.
      */
-    interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction | UserContextMenuCommandInteraction | MessageContextMenuCommandInteraction;
+    interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction | UserContextMenuCommandInteraction | MessageContextMenuCommandInteraction | AutocompleteInteraction;
     /**
      * The Discord.js client object that CommandKit is handling.
      */
@@ -63,6 +63,15 @@ interface CommandProps {
      */
     handler: CommandKit;
 }
+/**
+ * Props for autocomplete command run functions.
+ */
+interface AutocompleteCommandProps extends CommandProps {
+    /**
+     * The current autocomplete command interaction object.
+     */
+    interaction: AutocompleteInteraction;
+}
 /**
  * Props for slash (chat input) command run functions.
  */
@@ -244,7 +253,11 @@ declare class CommandKit {
     get devRoleIds(): string[];
 }
 
-type CommandKitButtonBuilderInteractionCollectorDispatch = (interaction: ButtonInteraction) => Awaitable<void>;
+/**
+ * The handler to run when a button is clicked. This handler is called with the interaction as the first argument.
+ * If the first argument is null, it means that the interaction collector has been destroyed.
+ */
+type CommandKitButtonBuilderInteractionCollectorDispatch = (interaction: ButtonInteraction | null) => Awaitable<void>;
 type CommandKitButtonBuilderInteractionCollectorDispatchContextData = {
     /**
      * The message to listen for button interactions on.
@@ -358,4 +371,4 @@ declare function createSignal<T = unknown>(value?: CommandKitSignalInitializer<T
  */
 declare function createEffect(callback: CommandKitEffectCallback): void;
 
-export { ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitConfig, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, ContextMenuCommandProps, MessageContextMenuCommandProps, ReloadType, SlashCommandProps, UserContextMenuCommandProps, ValidationFunctionProps, createEffect, createSignal, defineConfig, getConfig };
+export { AutocompleteCommandProps, ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitConfig, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, ContextMenuCommandProps, MessageContextMenuCommandProps, ReloadType, SlashCommandProps, UserContextMenuCommandProps, ValidationFunctionProps, createEffect, createSignal, defineConfig, getConfig };

package/dist/index.js

@@ -366,6 +366,8 @@ async function registerDevCommands(client, commands, guildIds) {
 
 // src/handlers/command-handler/validations/devOnly.ts
 function devOnly_default({ interaction, targetCommand, handlerData }) {
+  if (interaction.isAutocomplete())
+    return;
   if (targetCommand.options?.devOnly) {
     if (interaction.inGuild() && !handlerData.devGuildIds.includes(interaction.guildId)) {
       interaction.reply({
@@ -396,6 +398,8 @@ function devOnly_default({ interaction, targetCommand, handlerData }) {
 // src/handlers/command-handler/validations/permissions.ts
 var import_discord = require("discord.js");
 function permissions_default({ interaction, targetCommand }) {
+  if (interaction.isAutocomplete())
+    return;
   const userPermissions = interaction.memberPermissions;
   let userPermissionsRequired = targetCommand.options?.userPermissions;
   let missingUserPermissions = [];
@@ -460,9 +464,11 @@ function permissions_default({ interaction, targetCommand }) {
 // src/handlers/command-handler/validations/index.ts
 var validations_default = [devOnly_default, permissions_default];
 
-// src/handlers/command-handler/CommandHandler.ts
+// src/utils/clone.ts
 var import_rfdc = __toESM(require("rfdc"));
 var clone = (0, import_rfdc.default)();
+
+// src/handlers/command-handler/CommandHandler.ts
 var CommandHandler = class {
   #data;
   constructor({ ...options }) {
@@ -511,7 +517,7 @@ var CommandHandler = class {
     const commandFilePaths = paths.filter((path3) => allowedExtensions.test(path3));
     for (const commandFilePath of commandFilePaths) {
       const modulePath = toFileURL(commandFilePath);
-      let importedObj = await import(`${modulePath}?t=${Date.now()}`);
+      const importedObj = await import(`${modulePath}?t=${Date.now()}`);
       let commandObj = clone(importedObj);
       if (typeof module !== "undefined" && typeof require !== "undefined") {
         delete require.cache[require.resolve(commandFilePath)];
@@ -573,14 +579,17 @@ var CommandHandler = class {
   }
   handleCommands() {
     this.#data.client.on("interactionCreate", async (interaction) => {
-      if (!interaction.isChatInputCommand() && !interaction.isContextMenuCommand())
+      if (!interaction.isChatInputCommand() && !interaction.isContextMenuCommand() && !interaction.isAutocomplete())
         return;
+      const isAutocomplete = interaction.isAutocomplete();
       const targetCommand = this.#data.commands.find(
         (cmd) => cmd.data.name === interaction.commandName
       );
       if (!targetCommand)
         return;
-      const { data, options, run, ...rest } = targetCommand;
+      const { data, options, run, autocompleteRun, ...rest } = targetCommand;
+      if (isAutocomplete && !autocompleteRun)
+        return;
       const commandObj = {
         data: targetCommand.data,
         options: targetCommand.options,
@@ -619,11 +628,12 @@ var CommandHandler = class {
       }
       if (!canRun)
         return;
-      targetCommand.run({
+      const context2 = {
         interaction,
         client: this.#data.client,
         handler: this.#data.commandkitInstance
-      });
+      };
+      await targetCommand[isAutocomplete ? "autocompleteRun" : "run"](context2);
     });
   }
   get commands() {
@@ -655,8 +665,6 @@ var CommandHandler = class {
 };
 
 // src/handlers/event-handler/EventHandler.ts
-var import_rfdc2 = __toESM(require("rfdc"));
-var clone2 = (0, import_rfdc2.default)();
 var EventHandler = class {
   #data;
   constructor({ ...options }) {
@@ -684,7 +692,7 @@ var EventHandler = class {
       for (const eventFilePath of eventFilePaths) {
         const modulePath = toFileURL(eventFilePath);
         let importedFunction = (await import(`${modulePath}?t=${Date.now()}`)).default;
-        let eventFunction = clone2(importedFunction);
+        let eventFunction = clone(importedFunction);
         if (typeof module !== "undefined" && typeof require !== "undefined") {
           delete require.cache[require.resolve(eventFilePath)];
         }
@@ -731,8 +739,6 @@ var EventHandler = class {
 };
 
 // src/handlers/validation-handler/ValidationHandler.ts
-var import_rfdc3 = __toESM(require("rfdc"));
-var clone3 = (0, import_rfdc3.default)();
 var ValidationHandler = class {
   #data;
   constructor({ ...options }) {
@@ -751,7 +757,7 @@ var ValidationHandler = class {
     for (const validationFilePath of validationFilePaths) {
       const modulePath = toFileURL(validationFilePath);
       let importedFunction = (await import(`${modulePath}?t=${Date.now()}`)).default;
-      let validationFunction = clone3(importedFunction);
+      let validationFunction = clone(importedFunction);
       if (typeof module !== "undefined" && typeof require !== "undefined") {
         delete require.cache[require.resolve(validationFilePath)];
       }
@@ -967,6 +973,7 @@ var ButtonKit = class extends import_discord2.ButtonBuilder {
     });
   }
   #destroyCollector() {
+    this.#onClickHandler?.(null);
     this.#collector?.stop("end");
     this.#collector?.removeAllListeners();
     this.#collector = null;

package/dist/index.mjs

@@ -333,6 +333,8 @@ async function registerDevCommands(client, commands, guildIds) {
 
 // src/handlers/command-handler/validations/devOnly.ts
 function devOnly_default({ interaction, targetCommand, handlerData }) {
+  if (interaction.isAutocomplete())
+    return;
   if (targetCommand.options?.devOnly) {
     if (interaction.inGuild() && !handlerData.devGuildIds.includes(interaction.guildId)) {
       interaction.reply({
@@ -363,6 +365,8 @@ function devOnly_default({ interaction, targetCommand, handlerData }) {
 // src/handlers/command-handler/validations/permissions.ts
 import { EmbedBuilder } from "discord.js";
 function permissions_default({ interaction, targetCommand }) {
+  if (interaction.isAutocomplete())
+    return;
   const userPermissions = interaction.memberPermissions;
   let userPermissionsRequired = targetCommand.options?.userPermissions;
   let missingUserPermissions = [];
@@ -427,9 +431,11 @@ function permissions_default({ interaction, targetCommand }) {
 // src/handlers/command-handler/validations/index.ts
 var validations_default = [devOnly_default, permissions_default];
 
+// src/utils/clone.ts
+import rfdc from "rfdc";
+var clone = rfdc();
+
 // src/handlers/command-handler/CommandHandler.ts
-import rdfc from "rfdc";
-var clone = rdfc();
 var CommandHandler = class {
   #data;
   constructor({ ...options }) {
@@ -478,7 +484,7 @@ var CommandHandler = class {
     const commandFilePaths = paths.filter((path3) => allowedExtensions.test(path3));
     for (const commandFilePath of commandFilePaths) {
       const modulePath = toFileURL(commandFilePath);
-      let importedObj = await import(`${modulePath}?t=${Date.now()}`);
+      const importedObj = await import(`${modulePath}?t=${Date.now()}`);
       let commandObj = clone(importedObj);
       if (typeof module !== "undefined" && typeof __require !== "undefined") {
         delete __require.cache[__require.resolve(commandFilePath)];
@@ -540,14 +546,17 @@ var CommandHandler = class {
   }
   handleCommands() {
     this.#data.client.on("interactionCreate", async (interaction) => {
-      if (!interaction.isChatInputCommand() && !interaction.isContextMenuCommand())
+      if (!interaction.isChatInputCommand() && !interaction.isContextMenuCommand() && !interaction.isAutocomplete())
         return;
+      const isAutocomplete = interaction.isAutocomplete();
       const targetCommand = this.#data.commands.find(
         (cmd) => cmd.data.name === interaction.commandName
       );
       if (!targetCommand)
         return;
-      const { data, options, run, ...rest } = targetCommand;
+      const { data, options, run, autocompleteRun, ...rest } = targetCommand;
+      if (isAutocomplete && !autocompleteRun)
+        return;
       const commandObj = {
         data: targetCommand.data,
         options: targetCommand.options,
@@ -586,11 +595,12 @@ var CommandHandler = class {
       }
       if (!canRun)
         return;
-      targetCommand.run({
+      const context2 = {
         interaction,
         client: this.#data.client,
         handler: this.#data.commandkitInstance
-      });
+      };
+      await targetCommand[isAutocomplete ? "autocompleteRun" : "run"](context2);
     });
   }
   get commands() {
@@ -622,8 +632,6 @@ var CommandHandler = class {
 };
 
 // src/handlers/event-handler/EventHandler.ts
-import rdfc2 from "rfdc";
-var clone2 = rdfc2();
 var EventHandler = class {
   #data;
   constructor({ ...options }) {
@@ -651,7 +659,7 @@ var EventHandler = class {
       for (const eventFilePath of eventFilePaths) {
         const modulePath = toFileURL(eventFilePath);
         let importedFunction = (await import(`${modulePath}?t=${Date.now()}`)).default;
-        let eventFunction = clone2(importedFunction);
+        let eventFunction = clone(importedFunction);
         if (typeof module !== "undefined" && typeof __require !== "undefined") {
           delete __require.cache[__require.resolve(eventFilePath)];
         }
@@ -698,8 +706,6 @@ var EventHandler = class {
 };
 
 // src/handlers/validation-handler/ValidationHandler.ts
-import rdfc3 from "rfdc";
-var clone3 = rdfc3();
 var ValidationHandler = class {
   #data;
   constructor({ ...options }) {
@@ -718,7 +724,7 @@ var ValidationHandler = class {
     for (const validationFilePath of validationFilePaths) {
       const modulePath = toFileURL(validationFilePath);
       let importedFunction = (await import(`${modulePath}?t=${Date.now()}`)).default;
-      let validationFunction = clone3(importedFunction);
+      let validationFunction = clone(importedFunction);
       if (typeof module !== "undefined" && typeof __require !== "undefined") {
         delete __require.cache[__require.resolve(validationFilePath)];
       }
@@ -938,6 +944,7 @@ var ButtonKit = class extends ButtonBuilder {
     });
   }
   #destroyCollector() {
+    this.#onClickHandler?.(null);
     this.#collector?.stop("end");
     this.#collector?.removeAllListeners();
     this.#collector = null;

package/package.json

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