js-discord-modularcommand 2.0.0 → 2.0.1

package/dist/modularcommand.d.ts

@@ -1,54 +1,69 @@
 /**
- * @module ModularCommand
- * @description A module for creating and managing modular commands in a easy way for me.
+ * @file Contains the main class for creating modular commands.
+ * @author vicentefelipechile
  * @license MIT
  */
-/**
- * Imports
- */
 import { LocalizationMap, ButtonStyle, Locale } from 'discord.js';
 import ModularModal from './modularmodal.js';
 import ModularButton from './modularbutton.js';
 import { ButtonExecuteFunction, CommandExecuteFunction, CommandOption, ComponentExecuteFunction, ModalExecuteFunction, PermissionCheckFunction } from './types.js';
 /**
  * @description Represents a modular command that can be registered with Discord.js.
- * It allows for dynamic command creation and execution.
+ * It allows for dynamic command creation and execution in a simple way.
  * @example
  * const { ModularCommand, RegisterCommand } = require('js-discord-modularcommand');
  *
  * const PingCommand = new ModularCommand('ping');
  * PingCommand.setDescription('Sends a ping message.');
  * PingCommand.setExecute(async ({interaction}) => {
- *     await interaction.reply('Pong!');
+ *   await interaction.reply('Pong!');
  * });
  *
  * PingCommand.setPermissionCheck(({ interaction }) => {
- *     return interaction.member.permissions.has(PermissionFlagsBits.Administrator);
+ *   return interaction.member.permissions.has(PermissionFlagsBits.Administrator);
  * });
  *
  * module.exports = RegisterCommand([
- *     PingCommand
+ *   PingCommand
  * ]);
  */
 export default class ModularCommand {
+    /** The name of the command, must be unique. */
     name: string;
+    /** The main description of the command. */
     description: string;
+    /** A map of localizations for the command's description. */
+    descriptionLocalizations?: LocalizationMap;
+    /** The options (arguments) that the command accepts. */
+    options: CommandOption[];
+    /** An object containing localizations for the names and descriptions of the options. */
+    optionsLocalizations: Record<string, Record<Locale, string>>;
+    /** The main function that executes when the command is invoked. */
     execute: CommandExecuteFunction;
+    /** (Optional) The function to handle button interactions. */
     buttonExecute?: ButtonExecuteFunction;
+    /** (Optional) The function to handle generic component interactions (like select menus). */
     componentExecute?: ComponentExecuteFunction;
+    /** (Optional) The function to handle modal submissions. */
     modalExecute?: ModalExecuteFunction;
-    options: CommandOption[];
-    optionsLocalizations: Record<string, Record<Locale, string>>;
+    /** A record of handlers for specific component custom IDs. */
     customIdHandlers: Record<string, CommandExecuteFunction>;
+    /** The command's cooldown time in seconds. */
     cooldown: number;
-    modals: Map<string, ModularModal>;
-    buttons: Map<string, ModularButton>;
-    buttonsArray: ModularButton[];
+    /** Whether the command is marked as Not Safe For Work (NSFW). */
     isNSFW: boolean;
-    descriptionLocalizations?: LocalizationMap;
+    /** (Optional) An object with localized phrases to be used within the command's execution. */
     localizationPhrases?: Record<Locale, string>;
+    /** (Optional) The function that checks if a user has permission to execute the command. */
     permissionCheck?: PermissionCheckFunction;
+    /** (Optional) The base ID for components associated with this command. */
     componentId?: string;
+    /** A map of modals associated with this command, keyed by modal ID. */
+    modals: Map<string, ModularModal>;
+    /** A map of buttons associated with this command, keyed by the button's custom ID. */
+    buttons: Map<string, ModularButton>;
+    /** An array containing all ModularButton instances for easy access. */
+    buttonsArray: ModularButton[];
     constructor(name: string);
     /**
      * Sets the description of the command.
@@ -58,10 +73,15 @@ export default class ModularCommand {
     setDescription(description: string): this;
     /**
      * Sets the description localizations for the command.
-     * @param {LocalizationMap} localizations The description localizations.
+     * @param {LocalizationMap} localizations The description localizations map.
      * @returns {ModularCommand} The command instance for chaining.
      */
     setLocalizationsDescription(localizations: LocalizationMap): this;
+    /**
+     * Sets the localizations for the command's options.
+     * @param {Record<string, Record<Locale, string>>} localizations An object with the localizations.
+     * @returns {ModularCommand} The command instance for chaining.
+     */
     setLocalizationOptions(localizations: Record<string, Record<Locale, string>>): this;
     /**
      * Sets the localization phrases for the command.
@@ -83,7 +103,7 @@ export default class ModularCommand {
      */
     setComponentExecute(componentId: string, executeFunction: ComponentExecuteFunction): this;
     /**
-     * Set the minimun permissions required to execute the command.
+     * Sets the minimum permissions required to execute the command.
      * @param {PermissionCheckFunction} permissionCheckFunction The function to check permissions.
      * @returns {ModularCommand} The command instance for chaining.
      */
@@ -101,14 +121,14 @@ export default class ModularCommand {
     getComponentId(): string | undefined;
     /**
      * Adds an option to the command.
-     * @param {CommandOption} option The option for the command option.
+     * @param {CommandOption} option The option for the command.
      * @returns {ModularCommand} The command instance for chaining.
      */
     addOption(option: CommandOption): this;
     /**
      * Adds a custom ID handler for the command.
      * @param {string} customId The custom ID to match.
-     * @param {CommandInteraction<CacheType>} handlerFunction The function to execute when the custom ID matches.
+     * @param {CommandExecuteFunction} handlerFunction The function to execute when the custom ID matches.
      * @returns {ModularCommand} The command instance for chaining.
      */
     addCustomIDHandler(customId: string, handlerFunction: CommandExecuteFunction): this;

package/dist/modularcommand.js

@@ -1,54 +1,40 @@
 "use strict";
 /**
- * @module ModularCommand
- * @description A module for creating and managing modular commands in a easy way for me.
+ * @file Contains the main class for creating modular commands.
+ * @author vicentefelipechile
  * @license MIT
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Imports
- */
+// =================================================================================================
+// Imports
+// =================================================================================================
 const discord_js_1 = require("discord.js");
 const modularmodal_js_1 = __importDefault(require("./modularmodal.js"));
 const modularbutton_js_1 = __importDefault(require("./modularbutton.js"));
-/**
- * Interface
- */
-/**
- * @description Represents a command option for a modular command.
- */
-/**
- * Variables
- */
-const ALLOWED_OPTION_TYPE = [
-    discord_js_1.ApplicationCommandOptionType.String,
-    discord_js_1.ApplicationCommandOptionType.Boolean,
-    discord_js_1.ApplicationCommandOptionType.Integer,
-    discord_js_1.ApplicationCommandOptionType.Number,
-    discord_js_1.ApplicationCommandOptionType.User,
-    discord_js_1.ApplicationCommandOptionType.Channel,
-];
+// =================================================================================================
+// Class: ModularCommand
+// =================================================================================================
 /**
  * @description Represents a modular command that can be registered with Discord.js.
- * It allows for dynamic command creation and execution.
+ * It allows for dynamic command creation and execution in a simple way.
  * @example
  * const { ModularCommand, RegisterCommand } = require('js-discord-modularcommand');
  *
  * const PingCommand = new ModularCommand('ping');
  * PingCommand.setDescription('Sends a ping message.');
  * PingCommand.setExecute(async ({interaction}) => {
- *     await interaction.reply('Pong!');
+ *   await interaction.reply('Pong!');
  * });
  *
  * PingCommand.setPermissionCheck(({ interaction }) => {
- *     return interaction.member.permissions.has(PermissionFlagsBits.Administrator);
+ *   return interaction.member.permissions.has(PermissionFlagsBits.Administrator);
  * });
  *
  * module.exports = RegisterCommand([
- *     PingCommand
+ *   PingCommand
  * ]);
  */
 class ModularCommand {
@@ -78,7 +64,7 @@ class ModularCommand {
     }
     /**
      * Sets the description localizations for the command.
-     * @param {LocalizationMap} localizations The description localizations.
+     * @param {LocalizationMap} localizations The description localizations map.
      * @returns {ModularCommand} The command instance for chaining.
      */
     setLocalizationsDescription(localizations) {
@@ -86,6 +72,11 @@ class ModularCommand {
         this.descriptionLocalizations = localizations;
         return this;
     }
+    /**
+     * Sets the localizations for the command's options.
+     * @param {Record<string, Record<Locale, string>>} localizations An object with the localizations.
+     * @returns {ModularCommand} The command instance for chaining.
+     */
     setLocalizationOptions(localizations) {
         this.optionsLocalizations = localizations;
         return this;
@@ -120,7 +111,7 @@ class ModularCommand {
         return this;
     }
     /**
-     * Set the minimun permissions required to execute the command.
+     * Sets the minimum permissions required to execute the command.
      * @param {PermissionCheckFunction} permissionCheckFunction The function to check permissions.
      * @returns {ModularCommand} The command instance for chaining.
      */
@@ -146,20 +137,17 @@ class ModularCommand {
     }
     /**
      * Adds an option to the command.
-     * @param {CommandOption} option The option for the command option.
+     * @param {CommandOption} option The option for the command.
      * @returns {ModularCommand} The command instance for chaining.
      */
     addOption(option) {
-        if (!ALLOWED_OPTION_TYPE.includes(option.type)) {
-            throw new Error(`Invalid option type: ${option.type}. Allowed types are: ${ALLOWED_OPTION_TYPE.join(', ')}`);
-        }
         this.options.push(option);
         return this;
     }
     /**
      * Adds a custom ID handler for the command.
      * @param {string} customId The custom ID to match.
-     * @param {CommandInteraction<CacheType>} handlerFunction The function to execute when the custom ID matches.
+     * @param {CommandExecuteFunction} handlerFunction The function to execute when the custom ID matches.
      * @returns {ModularCommand} The command instance for chaining.
      */
     addCustomIDHandler(customId, handlerFunction) {

package/dist/registercommand.d.ts

@@ -11,4 +11,4 @@ import ModularCommand from "./modularcommand";
  * @param {ModularCommand[]} commands An array of ModularCommand instances.
  * @returns {CommandData[]} An array of command data objects ready for the Discord.js client.
  */
-export default function RegisterCommand(commands: ModularCommand[]): CommandData[];
+export default function RegisterCommand(commands: ModularCommand[] | ModularCommand): CommandData[];

package/dist/registercommand.js

@@ -109,13 +109,7 @@ function createChatInputExecutor(command, options) {
         }
         const locale = getCommandLocale(command, interaction);
         // Execute Handler
-        const { customId } = interaction.isMessageComponent() ? interaction : { customId: null };
-        if (customId && command.customIdHandlers[customId]) {
-            await command.customIdHandlers[customId]({ interaction, args, command, locale });
-        }
-        else {
-            await command.execute({ interaction, args, command, locale });
-        }
+        await command.execute({ interaction, args, command, locale });
     };
 }
 /**
@@ -130,7 +124,6 @@ function createComponentExecutor(command) {
     return async (interaction) => {
         if (!interaction.customId.startsWith(command.componentId || ''))
             return;
-        // Llama a la constante, que TypeScript sabe que está definida.
         await executor({
             interaction,
             command,
@@ -192,8 +185,13 @@ function createButtonExecutor(command) {
  * @returns {CommandData[]} An array of command data objects ready for the Discord.js client.
  */
 function RegisterCommand(commands) {
+    commands = Array.isArray(commands) ? commands : [commands];
     return commands.map(command => {
-        // --- Build SlashCommand Data ---
+        if (command.name === undefined)
+            throw new Error("A command is missing a name.");
+        if (command.description === undefined)
+            throw new Error(`Command "${command.name}" is missing a description.`);
+        // Build SlashCommand Data
         const commandBuilder = new discord_js_1.SlashCommandBuilder()
             .setName(command.name)
             .setDescription(command.description)
@@ -235,13 +233,10 @@ function RegisterCommand(commands) {
                 case discord_js_1.ApplicationCommandOptionType.User:
                     commandBuilder.addUserOption(optionBuilder);
                     break;
-                case discord_js_1.ApplicationCommandOptionType.Channel:
-                    commandBuilder.addChannelOption(optionBuilder);
-                    break;
                 default: throw new Error(`Unsupported option type: ${opt.type}`);
             }
         });
-        // --- Assign Handlers using Constructors ---
+        // Assign Handlers using Constructors
         return {
             data: commandBuilder,
             execute: createChatInputExecutor(command, options),

package/dist/types.d.ts

@@ -13,7 +13,7 @@ export interface CommandOption {
     /** The name of the option, must be unique within the command. */
     name: string;
     /** The data type the option expects (e.g., STRING, USER, CHANNEL). */
-    type: OptionType;
+    type: AllowedOptionType;
     /** The description of the option. It can be a string or an object for localization. */
     description: Record<Locale, string> | string;
     /** Defines if the option is required. */
@@ -39,6 +39,16 @@ export interface CommandData {
     /** The command's cooldown time in seconds. */
     cooldown: number;
 }
+/**
+ * @const ALLOWED_OPTION_TYPE
+ * @description A list of allowed option types for slash commands.
+ */
+export declare const ALLOWED_OPTION_TYPE: readonly [OptionType.String, OptionType.Boolean, OptionType.Integer, OptionType.Number, OptionType.User];
+/**
+ * @type AllowedOptionType
+ * @description The union type of allowed option types for slash commands.
+ */
+export type AllowedOptionType = typeof ALLOWED_OPTION_TYPE[number];
 /**
  * @type LocaleKey
  * @description An object that maps text identifiers to their translations.

package/dist/types.js

@@ -5,3 +5,19 @@
  * @license MIT
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ALLOWED_OPTION_TYPE = void 0;
+const discord_js_1 = require("discord.js");
+// =================================================================================================
+// Generic and Utility Types
+// =================================================================================================
+/**
+ * @const ALLOWED_OPTION_TYPE
+ * @description A list of allowed option types for slash commands.
+ */
+exports.ALLOWED_OPTION_TYPE = [
+    discord_js_1.ApplicationCommandOptionType.String,
+    discord_js_1.ApplicationCommandOptionType.Boolean,
+    discord_js_1.ApplicationCommandOptionType.Integer,
+    discord_js_1.ApplicationCommandOptionType.Number,
+    discord_js_1.ApplicationCommandOptionType.User,
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-discord-modularcommand",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "",
   "keywords": [
     "discord",