commandkit 0.1.6-dev.20231124165615 → 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,202 +1,178 @@
-import { CommandInteraction, Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, PermissionsString, APIApplicationCommandOption, 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';
 
 /**
- * Base props for commands.
+ * Options for instantiating a CommandKit handler.
  */
-interface CommandProps {
+interface CommandKitOptions {
     /**
-     * Represents the command's interaction.
+     * The Discord.js client object to use with CommandKit.
      */
-    interaction: CommandInteraction;
+    client: Client;
     /**
-     * The client created in your main file.
+     * The path to your commands directory.
      */
-    client: Client<true>;
+    commandsPath?: string;
     /**
-     * The main CommandKit handler that instantiated this.
+     * The path to your events directory.
      */
-    handler: CommandKit;
+    eventsPath?: string;
+    /**
+     * The path to the validations directory.
+     */
+    validationsPath?: string;
+    /**
+     * List of development guild IDs to restrict devOnly commands to.
+     */
+    devGuildIds?: string[];
+    /**
+     * List of developer user IDs to restrict devOnly commands to.
+     */
+    devUserIds?: string[];
+    /**
+     * List of developer role IDs to restrict devOnly commands to.
+     */
+    devRoleIds?: string[];
+    /**
+     * Skip CommandKit's built-in validations (for devOnly commands).
+     */
+    skipBuiltInValidations?: boolean;
+    /**
+     * Bulk register application commands instead of one-by-one.
+     */
+    bulkRegister?: boolean;
 }
 /**
- * Props for slash command run functions.
+ * A reload type for commands.
+ */
+type ReloadOptions = 'dev' | 'global' | ReloadType;
+
+/**
+ * Props for command run functions.
  */
-interface SlashCommandProps {
+interface CommandProps {
     /**
-     * Represents the command's interaction.
+     * The current command interaction object.
      */
-    interaction: ChatInputCommandInteraction;
+    interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction | UserContextMenuCommandInteraction | MessageContextMenuCommandInteraction | AutocompleteInteraction;
     /**
-     * The client created in your main file.
+     * The Discord.js client object that CommandKit is handling.
      */
     client: Client<true>;
     /**
-     * The CommandKit handler that instantiated this.
+     * The current CommandKit handler instance.
      */
     handler: CommandKit;
 }
 /**
- * Props for context menu command run functions.
+ * Props for autocomplete command run functions.
  */
-interface ContextMenuCommandProps {
+interface AutocompleteCommandProps extends CommandProps {
     /**
-     * Represents the command's interaction.
+     * The current autocomplete command interaction object.
      */
-    interaction: ContextMenuCommandInteraction;
+    interaction: AutocompleteInteraction;
+}
+/**
+ * Props for slash (chat input) command run functions.
+ */
+interface SlashCommandProps extends CommandProps {
     /**
-     * The client created in your main file.
+     * The current slash (chat input) command interaction object.
      */
-    client: Client<true>;
+    interaction: ChatInputCommandInteraction;
+}
+/**
+ * Props for context menu command run functions.
+ */
+interface ContextMenuCommandProps extends CommandProps {
     /**
-     * The CommandKit handler that instantiated this.
+     * The current context menu command interaction object.
      */
-    handler: CommandKit;
+    interaction: ContextMenuCommandInteraction;
+}
+/**
+ * Props for user context menu command run functions.
+ */
+interface UserContextMenuCommandProps extends CommandProps {
+    interaction: UserContextMenuCommandInteraction;
 }
 /**
- * Props for command validations.
+ * Props for message context menu command run functions.
+ */
+interface MessageContextMenuCommandProps extends CommandProps {
+    interaction: MessageContextMenuCommandInteraction;
+}
+/**
+ * Props for command validation functions.
  */
 interface ValidationFunctionProps {
     /**
-     * Represents the command's interaction.
-     * Either a slash command or a context menu command interaction.
+     * The current command interaction object.
      */
     interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction;
     /**
-     * The client created in your main file.
-     * Represented as a ready client (`Client<true>`).
+     * The Discord.js client object that CommandKit is handling.
      */
     client: Client<true>;
     /**
-     * The command object that is being validated.
+     * The current (local) target command object.
      */
     commandObj: CommandObject;
     /**
-     * The CommandKit handler that instantiated this.
+     * The current CommandKit handler instance.
      */
     handler: CommandKit;
 }
 /**
- * Configuration for commands.
+ * Additional command configuration options.
  */
 interface CommandOptions {
     /**
-     * Boolean indicating whether the command is guild-only.
-     * @deprecated - Use `dm_permission` in the command's data instead.
+     * A boolean indicating whether the command is guild-only.
+     * Used for built-in validation.
+     *
+     * @deprecated Use `dm_permission` in the command's `data` object instead.
      */
     guildOnly?: boolean;
     /**
-     * Boolean indicating whether the command is developer only.
+     * A boolean indicating whether the command is developer-only.
+     * Used for registration and built-in validation.
      */
     devOnly?: boolean;
     /**
-     * Boolean indicating whether the command is deleted and should not be registered.
+     * A boolean indicating whether the command is deleted/ignored on restart/reload.
      */
     deleted?: boolean;
     /**
-     * An array of user permissions.
+     * A string or array of permissions that a user needs for the current command to be executed.
+     * Used for built-in validation.
      *
      * @example
-     * userPermissions: ['BanMembers']
+     * userPermissions: 'BanMembers'
+     * or
+     * userPermissions: ['BanMembers', 'KickMembers']
      */
-    userPermissions?: PermissionsString[];
+    userPermissions?: PermissionsString | PermissionsString[];
     /**
-     * An array of bot permissions.
+     * A string or array of permissions that the bot needs to execute the current command.
+     * Used for built-in validation.
      *
      * @example
-     * botPermissions: ['BanMembers']
+     * botPermissions: 'BanMembers'
+     * or
+     * botPermissions: ['BanMembers', 'KickMembers']
      */
-    botPermissions?: PermissionsString[];
+    botPermissions?: PermissionsString | PermissionsString[];
     [key: string]: any;
 }
-declare enum CommandType {
-    /**
-     * Slash commands.
-     */
-    'ChatInput' = 1,
-    /**
-     * Message context menu commands.
-     */
-    'Message' = 3,
-    /**
-     * User context menu commands.
-     */
-    'User' = 2
-}
-type LocaleString = 'id' | `en-${'GB' | 'US'}` | 'bg' | `zh-${'CN' | 'TW'}` | 'hr' | 'cs' | 'da' | 'nl' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'it' | 'ja' | 'ko' | 'lt' | 'no' | 'pl' | 'pt-BR' | 'ro' | 'ru' | 'es-ES' | 'sv-SE' | 'th' | 'tr' | 'uk' | 'vi';
-/**
- * Common items for command data.
- */
-type BaseCommandData = {
-    /**
-     * The name of the command.
-     */
-    name: string;
-    /**
-     * The type of the command.
-     */
-    type?: CommandType;
-    /**
-     * i18n for the command name.
-     */
-    name_localizations?: Partial<Record<LocaleString, string | null>>;
-    /**
-     * Whether to allow this command in DMs.
-     */
-    dm_permission?: boolean;
-    /**
-     * Default permissions for members for the command.
-     */
-    default_member_permissions?: string;
-    /**
-     * Whether the command is age-restricted.
-     */
-    nsfw?: boolean;
-};
-/**
- * Data for chat input commands.
- */
-type ChatInputCommandData = BaseCommandData & {
-    /**
-     * The command's type.
-     */
-    type?: CommandType.ChatInput;
-    /**
-     * The description of the command.
-     */
-    description: string;
-    /**
-     * i18n for the command description.
-     */
-    description_localizations?: Partial<Record<LocaleString, string | null>>;
-    /**
-     * Chat input command options.
-     */
-    options?: Array<APIApplicationCommandOption>;
-};
-/**
- * Represents any context menu command data.
- */
-type UserOrMessageCommandData = BaseCommandData & {
-    type: CommandType.User | CommandType.Message;
-};
-type CommandData = ChatInputCommandData | UserOrMessageCommandData;
+type CommandData = RESTPostAPIApplicationCommandsJSONBody;
 type CommandObject = {
     /**
-     * Command data which is a slash command builder or raw JSON data.
-     * @example
-     * {
-     *      name: 'ping',
-     *      description: 'Replies with Pong!'
-     * }
+     * An object which defines the structure of the application command.
      */
     data: CommandData;
     /**
-     * CommandKit command options.
-     * @example
-     * {
-     *      devOnly: true,
-     *      userPermissions: ['ManageGuild'],
-     *      botPermissions: ['ManageGuild'],
-     * }
+     * Additional command configuration options.
      */
     options?: CommandOptions;
     /**
@@ -204,7 +180,13 @@ type CommandObject = {
      */
     filePath: string;
     /**
-     * The command's category.
+     * The command's category. Determined based on the command folder.
+     *
+     * @example
+     * ```txt
+     * "/src/commands/ping.js" -> null
+     * "/src/commands/Misc/ping.js" -> "Misc"
+     * ```
      */
     category: string | null;
     [key: string]: any;
@@ -220,57 +202,12 @@ declare enum ReloadType {
     Global = "global"
 }
 
-/**
- * Options for instantiating a CommandKit handler.
- */
-interface CommandKitOptions {
-    /**
-     * The Discord.js client object to use with CommandKit.
-     */
-    client: Client;
-    /**
-     * The path to your commands directory.
-     */
-    commandsPath?: string;
-    /**
-     * The path to your events directory.
-     */
-    eventsPath?: string;
-    /**
-     * The path to the validations directory.
-     */
-    validationsPath?: string;
-    /**
-     * List of development guild IDs to restrict devOnly commands to.
-     */
-    devGuildIds?: string[];
-    /**
-     * List of developer user IDs to restrict devOnly commands to.
-     */
-    devUserIds?: string[];
-    /**
-     * List of developer role IDs to restrict devOnly commands to.
-     */
-    devRoleIds?: string[];
-    /**
-     * Skip CommandKit's built-in validations (for devOnly commands).
-     */
-    skipBuiltInValidations?: boolean;
-    /**
-     * Bulk register application commands instead of one-by-one.
-     */
-    bulkRegister?: boolean;
-}
-/**
- * A reload type for commands.
- */
-type ReloadOptions = 'dev' | 'global' | ReloadType;
-
 declare class CommandKit {
     #private;
     /**
-     * Create a new handler with CommandKit.
-     * @param options - Options to use (client, commandsPath, eventsPath, etc.)
+     * Create a new command and event handler with CommandKit.
+     *
+     * @param options - The default CommandKit configuration.
      * @see {@link https://commandkit.js.org/docs/commandkit-setup}
      */
     constructor(options: CommandKitOptions);
@@ -316,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.
@@ -430,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, CommandType, ContextMenuCommandProps, ReloadType, SlashCommandProps, 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,202 +1,178 @@
-import { CommandInteraction, Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, PermissionsString, APIApplicationCommandOption, 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';
 
 /**
- * Base props for commands.
+ * Options for instantiating a CommandKit handler.
  */
-interface CommandProps {
+interface CommandKitOptions {
     /**
-     * Represents the command's interaction.
+     * The Discord.js client object to use with CommandKit.
      */
-    interaction: CommandInteraction;
+    client: Client;
     /**
-     * The client created in your main file.
+     * The path to your commands directory.
      */
-    client: Client<true>;
+    commandsPath?: string;
     /**
-     * The main CommandKit handler that instantiated this.
+     * The path to your events directory.
      */
-    handler: CommandKit;
+    eventsPath?: string;
+    /**
+     * The path to the validations directory.
+     */
+    validationsPath?: string;
+    /**
+     * List of development guild IDs to restrict devOnly commands to.
+     */
+    devGuildIds?: string[];
+    /**
+     * List of developer user IDs to restrict devOnly commands to.
+     */
+    devUserIds?: string[];
+    /**
+     * List of developer role IDs to restrict devOnly commands to.
+     */
+    devRoleIds?: string[];
+    /**
+     * Skip CommandKit's built-in validations (for devOnly commands).
+     */
+    skipBuiltInValidations?: boolean;
+    /**
+     * Bulk register application commands instead of one-by-one.
+     */
+    bulkRegister?: boolean;
 }
 /**
- * Props for slash command run functions.
+ * A reload type for commands.
+ */
+type ReloadOptions = 'dev' | 'global' | ReloadType;
+
+/**
+ * Props for command run functions.
  */
-interface SlashCommandProps {
+interface CommandProps {
     /**
-     * Represents the command's interaction.
+     * The current command interaction object.
      */
-    interaction: ChatInputCommandInteraction;
+    interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction | UserContextMenuCommandInteraction | MessageContextMenuCommandInteraction | AutocompleteInteraction;
     /**
-     * The client created in your main file.
+     * The Discord.js client object that CommandKit is handling.
      */
     client: Client<true>;
     /**
-     * The CommandKit handler that instantiated this.
+     * The current CommandKit handler instance.
      */
     handler: CommandKit;
 }
 /**
- * Props for context menu command run functions.
+ * Props for autocomplete command run functions.
  */
-interface ContextMenuCommandProps {
+interface AutocompleteCommandProps extends CommandProps {
     /**
-     * Represents the command's interaction.
+     * The current autocomplete command interaction object.
      */
-    interaction: ContextMenuCommandInteraction;
+    interaction: AutocompleteInteraction;
+}
+/**
+ * Props for slash (chat input) command run functions.
+ */
+interface SlashCommandProps extends CommandProps {
     /**
-     * The client created in your main file.
+     * The current slash (chat input) command interaction object.
      */
-    client: Client<true>;
+    interaction: ChatInputCommandInteraction;
+}
+/**
+ * Props for context menu command run functions.
+ */
+interface ContextMenuCommandProps extends CommandProps {
     /**
-     * The CommandKit handler that instantiated this.
+     * The current context menu command interaction object.
      */
-    handler: CommandKit;
+    interaction: ContextMenuCommandInteraction;
+}
+/**
+ * Props for user context menu command run functions.
+ */
+interface UserContextMenuCommandProps extends CommandProps {
+    interaction: UserContextMenuCommandInteraction;
 }
 /**
- * Props for command validations.
+ * Props for message context menu command run functions.
+ */
+interface MessageContextMenuCommandProps extends CommandProps {
+    interaction: MessageContextMenuCommandInteraction;
+}
+/**
+ * Props for command validation functions.
  */
 interface ValidationFunctionProps {
     /**
-     * Represents the command's interaction.
-     * Either a slash command or a context menu command interaction.
+     * The current command interaction object.
      */
     interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction;
     /**
-     * The client created in your main file.
-     * Represented as a ready client (`Client<true>`).
+     * The Discord.js client object that CommandKit is handling.
      */
     client: Client<true>;
     /**
-     * The command object that is being validated.
+     * The current (local) target command object.
      */
     commandObj: CommandObject;
     /**
-     * The CommandKit handler that instantiated this.
+     * The current CommandKit handler instance.
      */
     handler: CommandKit;
 }
 /**
- * Configuration for commands.
+ * Additional command configuration options.
  */
 interface CommandOptions {
     /**
-     * Boolean indicating whether the command is guild-only.
-     * @deprecated - Use `dm_permission` in the command's data instead.
+     * A boolean indicating whether the command is guild-only.
+     * Used for built-in validation.
+     *
+     * @deprecated Use `dm_permission` in the command's `data` object instead.
      */
     guildOnly?: boolean;
     /**
-     * Boolean indicating whether the command is developer only.
+     * A boolean indicating whether the command is developer-only.
+     * Used for registration and built-in validation.
      */
     devOnly?: boolean;
     /**
-     * Boolean indicating whether the command is deleted and should not be registered.
+     * A boolean indicating whether the command is deleted/ignored on restart/reload.
      */
     deleted?: boolean;
     /**
-     * An array of user permissions.
+     * A string or array of permissions that a user needs for the current command to be executed.
+     * Used for built-in validation.
      *
      * @example
-     * userPermissions: ['BanMembers']
+     * userPermissions: 'BanMembers'
+     * or
+     * userPermissions: ['BanMembers', 'KickMembers']
      */
-    userPermissions?: PermissionsString[];
+    userPermissions?: PermissionsString | PermissionsString[];
     /**
-     * An array of bot permissions.
+     * A string or array of permissions that the bot needs to execute the current command.
+     * Used for built-in validation.
      *
      * @example
-     * botPermissions: ['BanMembers']
+     * botPermissions: 'BanMembers'
+     * or
+     * botPermissions: ['BanMembers', 'KickMembers']
      */
-    botPermissions?: PermissionsString[];
+    botPermissions?: PermissionsString | PermissionsString[];
     [key: string]: any;
 }
-declare enum CommandType {
-    /**
-     * Slash commands.
-     */
-    'ChatInput' = 1,
-    /**
-     * Message context menu commands.
-     */
-    'Message' = 3,
-    /**
-     * User context menu commands.
-     */
-    'User' = 2
-}
-type LocaleString = 'id' | `en-${'GB' | 'US'}` | 'bg' | `zh-${'CN' | 'TW'}` | 'hr' | 'cs' | 'da' | 'nl' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'it' | 'ja' | 'ko' | 'lt' | 'no' | 'pl' | 'pt-BR' | 'ro' | 'ru' | 'es-ES' | 'sv-SE' | 'th' | 'tr' | 'uk' | 'vi';
-/**
- * Common items for command data.
- */
-type BaseCommandData = {
-    /**
-     * The name of the command.
-     */
-    name: string;
-    /**
-     * The type of the command.
-     */
-    type?: CommandType;
-    /**
-     * i18n for the command name.
-     */
-    name_localizations?: Partial<Record<LocaleString, string | null>>;
-    /**
-     * Whether to allow this command in DMs.
-     */
-    dm_permission?: boolean;
-    /**
-     * Default permissions for members for the command.
-     */
-    default_member_permissions?: string;
-    /**
-     * Whether the command is age-restricted.
-     */
-    nsfw?: boolean;
-};
-/**
- * Data for chat input commands.
- */
-type ChatInputCommandData = BaseCommandData & {
-    /**
-     * The command's type.
-     */
-    type?: CommandType.ChatInput;
-    /**
-     * The description of the command.
-     */
-    description: string;
-    /**
-     * i18n for the command description.
-     */
-    description_localizations?: Partial<Record<LocaleString, string | null>>;
-    /**
-     * Chat input command options.
-     */
-    options?: Array<APIApplicationCommandOption>;
-};
-/**
- * Represents any context menu command data.
- */
-type UserOrMessageCommandData = BaseCommandData & {
-    type: CommandType.User | CommandType.Message;
-};
-type CommandData = ChatInputCommandData | UserOrMessageCommandData;
+type CommandData = RESTPostAPIApplicationCommandsJSONBody;
 type CommandObject = {
     /**
-     * Command data which is a slash command builder or raw JSON data.
-     * @example
-     * {
-     *      name: 'ping',
-     *      description: 'Replies with Pong!'
-     * }
+     * An object which defines the structure of the application command.
      */
     data: CommandData;
     /**
-     * CommandKit command options.
-     * @example
-     * {
-     *      devOnly: true,
-     *      userPermissions: ['ManageGuild'],
-     *      botPermissions: ['ManageGuild'],
-     * }
+     * Additional command configuration options.
      */
     options?: CommandOptions;
     /**
@@ -204,7 +180,13 @@ type CommandObject = {
      */
     filePath: string;
     /**
-     * The command's category.
+     * The command's category. Determined based on the command folder.
+     *
+     * @example
+     * ```txt
+     * "/src/commands/ping.js" -> null
+     * "/src/commands/Misc/ping.js" -> "Misc"
+     * ```
      */
     category: string | null;
     [key: string]: any;
@@ -220,57 +202,12 @@ declare enum ReloadType {
     Global = "global"
 }
 
-/**
- * Options for instantiating a CommandKit handler.
- */
-interface CommandKitOptions {
-    /**
-     * The Discord.js client object to use with CommandKit.
-     */
-    client: Client;
-    /**
-     * The path to your commands directory.
-     */
-    commandsPath?: string;
-    /**
-     * The path to your events directory.
-     */
-    eventsPath?: string;
-    /**
-     * The path to the validations directory.
-     */
-    validationsPath?: string;
-    /**
-     * List of development guild IDs to restrict devOnly commands to.
-     */
-    devGuildIds?: string[];
-    /**
-     * List of developer user IDs to restrict devOnly commands to.
-     */
-    devUserIds?: string[];
-    /**
-     * List of developer role IDs to restrict devOnly commands to.
-     */
-    devRoleIds?: string[];
-    /**
-     * Skip CommandKit's built-in validations (for devOnly commands).
-     */
-    skipBuiltInValidations?: boolean;
-    /**
-     * Bulk register application commands instead of one-by-one.
-     */
-    bulkRegister?: boolean;
-}
-/**
- * A reload type for commands.
- */
-type ReloadOptions = 'dev' | 'global' | ReloadType;
-
 declare class CommandKit {
     #private;
     /**
-     * Create a new handler with CommandKit.
-     * @param options - Options to use (client, commandsPath, eventsPath, etc.)
+     * Create a new command and event handler with CommandKit.
+     *
+     * @param options - The default CommandKit configuration.
      * @see {@link https://commandkit.js.org/docs/commandkit-setup}
      */
     constructor(options: CommandKitOptions);
@@ -316,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.
@@ -430,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, CommandType, ContextMenuCommandProps, ReloadType, SlashCommandProps, 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

@@ -39,8 +39,15 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
-// src/utils/get-paths.ts
+// src/utils/resolve-file-url.ts
 var import_path = __toESM(require("path"));
+function toFileURL(filePath) {
+  const resolvedPath = import_path.default.resolve(filePath);
+  return "file://" + resolvedPath.replace(/\\\\|\\/g, "/");
+}
+
+// src/utils/get-paths.ts
+var import_path2 = __toESM(require("path"));
 var import_promises = __toESM(require("fs/promises"));
 async function getFilePaths(directory, nesting) {
   let filePaths = [];
@@ -48,7 +55,7 @@ async function getFilePaths(directory, nesting) {
     return filePaths;
   const files = await import_promises.default.readdir(directory, { withFileTypes: true });
   for (const file of files) {
-    const filePath = import_path.default.join(directory, file.name);
+    const filePath = import_path2.default.join(directory, file.name);
     if (file.isFile()) {
       filePaths.push(filePath);
     }
@@ -64,7 +71,7 @@ async function getFolderPaths(directory, nesting) {
     return folderPaths;
   const folders = await import_promises.default.readdir(directory, { withFileTypes: true });
   for (const folder of folders) {
-    const folderPath = import_path.default.join(directory, folder.name);
+    const folderPath = import_path2.default.join(directory, folder.name);
     if (folder.isDirectory()) {
       folderPaths.push(folderPath);
       if (nesting) {
@@ -75,13 +82,6 @@ async function getFolderPaths(directory, nesting) {
   return folderPaths;
 }
 
-// src/utils/resolve-file-url.ts
-var import_path2 = __toESM(require("path"));
-function toFileURL(filePath) {
-  const resolvedPath = import_path2.default.resolve(filePath);
-  return "file://" + resolvedPath.replace(/\\\\|\\/g, "/");
-}
-
 // src/utils/colors.ts
 var resetColor = "\x1B[0m";
 var colors_default = {
@@ -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({
@@ -393,26 +395,23 @@ function devOnly_default({ interaction, targetCommand, handlerData }) {
   }
 }
 
-// src/handlers/command-handler/validations/guildOnly.ts
-function guildOnly_default({ interaction, targetCommand }) {
-  if (targetCommand.options?.guildOnly && !interaction.inGuild()) {
-    interaction.reply({
-      content: "\u274C This command can only be used inside a server.",
-      ephemeral: true
-    });
-    return true;
-  }
-}
-
 // 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 = [];
+  if (typeof userPermissionsRequired === "string") {
+    userPermissionsRequired = [userPermissionsRequired];
+  }
   const botPermissions = interaction.guild?.members.me?.permissions;
   let botPermissionsRequired = targetCommand.options?.botPermissions;
   let missingBotPermissions = [];
+  if (typeof botPermissionsRequired === "string") {
+    botPermissionsRequired = [botPermissionsRequired];
+  }
   if (!userPermissionsRequired?.length && !botPermissionsRequired?.length) {
     return;
   }
@@ -463,11 +462,13 @@ function permissions_default({ interaction, targetCommand }) {
 }
 
 // src/handlers/command-handler/validations/index.ts
-var validations_default = [devOnly_default, guildOnly_default, permissions_default];
+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 }) {
@@ -516,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)];
@@ -578,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,
@@ -624,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() {
@@ -660,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 }) {
@@ -689,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)];
         }
@@ -736,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 }) {
@@ -756,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)];
       }
@@ -788,8 +789,9 @@ var ValidationHandler = class {
 var CommandKit = class {
   #data;
   /**
-   * Create a new handler with CommandKit.
-   * @param options - Options to use (client, commandsPath, eventsPath, etc.)
+   * Create a new command and event handler with CommandKit.
+   *
+   * @param options - The default CommandKit configuration.
    * @see {@link https://commandkit.js.org/docs/commandkit-setup}
    */
   constructor(options) {
@@ -971,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

@@ -6,8 +6,15 @@ var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require
   throw Error('Dynamic require of "' + x + '" is not supported');
 });
 
-// src/utils/get-paths.ts
+// src/utils/resolve-file-url.ts
 import path from "path";
+function toFileURL(filePath) {
+  const resolvedPath = path.resolve(filePath);
+  return "file://" + resolvedPath.replace(/\\\\|\\/g, "/");
+}
+
+// src/utils/get-paths.ts
+import path2 from "path";
 import fs from "fs/promises";
 async function getFilePaths(directory, nesting) {
   let filePaths = [];
@@ -15,7 +22,7 @@ async function getFilePaths(directory, nesting) {
     return filePaths;
   const files = await fs.readdir(directory, { withFileTypes: true });
   for (const file of files) {
-    const filePath = path.join(directory, file.name);
+    const filePath = path2.join(directory, file.name);
     if (file.isFile()) {
       filePaths.push(filePath);
     }
@@ -31,7 +38,7 @@ async function getFolderPaths(directory, nesting) {
     return folderPaths;
   const folders = await fs.readdir(directory, { withFileTypes: true });
   for (const folder of folders) {
-    const folderPath = path.join(directory, folder.name);
+    const folderPath = path2.join(directory, folder.name);
     if (folder.isDirectory()) {
       folderPaths.push(folderPath);
       if (nesting) {
@@ -42,13 +49,6 @@ async function getFolderPaths(directory, nesting) {
   return folderPaths;
 }
 
-// src/utils/resolve-file-url.ts
-import path2 from "path";
-function toFileURL(filePath) {
-  const resolvedPath = path2.resolve(filePath);
-  return "file://" + resolvedPath.replace(/\\\\|\\/g, "/");
-}
-
 // src/utils/colors.ts
 var resetColor = "\x1B[0m";
 var colors_default = {
@@ -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({
@@ -360,26 +362,23 @@ function devOnly_default({ interaction, targetCommand, handlerData }) {
   }
 }
 
-// src/handlers/command-handler/validations/guildOnly.ts
-function guildOnly_default({ interaction, targetCommand }) {
-  if (targetCommand.options?.guildOnly && !interaction.inGuild()) {
-    interaction.reply({
-      content: "\u274C This command can only be used inside a server.",
-      ephemeral: true
-    });
-    return true;
-  }
-}
-
 // 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 = [];
+  if (typeof userPermissionsRequired === "string") {
+    userPermissionsRequired = [userPermissionsRequired];
+  }
   const botPermissions = interaction.guild?.members.me?.permissions;
   let botPermissionsRequired = targetCommand.options?.botPermissions;
   let missingBotPermissions = [];
+  if (typeof botPermissionsRequired === "string") {
+    botPermissionsRequired = [botPermissionsRequired];
+  }
   if (!userPermissionsRequired?.length && !botPermissionsRequired?.length) {
     return;
   }
@@ -430,11 +429,13 @@ function permissions_default({ interaction, targetCommand }) {
 }
 
 // src/handlers/command-handler/validations/index.ts
-var validations_default = [devOnly_default, guildOnly_default, permissions_default];
+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 }) {
@@ -483,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)];
@@ -545,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,
@@ -591,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() {
@@ -627,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 }) {
@@ -656,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)];
         }
@@ -703,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 }) {
@@ -723,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)];
       }
@@ -755,8 +756,9 @@ var ValidationHandler = class {
 var CommandKit = class {
   #data;
   /**
-   * Create a new handler with CommandKit.
-   * @param options - Options to use (client, commandsPath, eventsPath, etc.)
+   * Create a new command and event handler with CommandKit.
+   *
+   * @param options - The default CommandKit configuration.
    * @see {@link https://commandkit.js.org/docs/commandkit-setup}
    */
   constructor(options) {
@@ -942,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.20231124165615",
+  "version": "0.1.6-dev.20231125121601",
   "license": "MIT",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",