js-discord-modularcommand 2.1.0 → 2.3.0

package/README.md

@@ -6,17 +6,12 @@ A module to create and manage modular commands in a simple way for Discord.js bo
 
 This library simplifies the creation and management of slash commands for [Discord.js](https://discord.js.org/). It allows you to structure your commands in a modular way, making it easier to handle logic, permissions, cooldowns, localizations, and interactive components like buttons and modals.
 
-The main classes are:
-- [`ModularCommand`](src/modularcommand.ts): To define the base structure of a command.
-- [`ModularButton`](src/modularcommand.ts): To create interactive buttons associated with a command.
-- [`ModularModal`](src/modularcommand.ts): To create modals (forms) that the user can fill out.
-
 ## How to use it?
 
 First, install the package in your project:
 
 ```sh
-npm install js-discord-modularcommand
+npm install js-discord-modularcommand@latest
 ```
 
 Then, you can create your commands in a modular fashion. Here is a basic example of a `ping` command:
@@ -24,7 +19,7 @@ Then, you can create your commands in a modular fashion. Here is a basic example
 ```javascript
 // filepath: commands/ping.js
 const { ModularCommand, RegisterCommand } = require('js-discord-modularcommand');
-const { PermissionFlagsBits } = require('discord.js');
+const { PermissionFlagsBits, Locale } = require('discord.js');
 
 // Create a new command instance
 const PingCommand = new ModularCommand('ping');
@@ -37,15 +32,34 @@ PingCommand.setPermissionCheck(async ({ interaction }) => {
     return interaction.member.permissions.has(PermissionFlagsBits.Administrator);
 });
 
-// Define the logic to be executed
-PingCommand.setExecute(async ({ interaction }) => {
-    await interaction.reply('Pong!');
+// Optional: Localization to use with 'locale'
+PingCommand.setLocalizationPhrases({
+    [Locale.EnglishUS]: {
+        response: 'Replies with Pong!',
+    },
+    [Locale.SpanishLATAM]: {
+        response: 'Responde con Pong!',
+    }
+});
+
+// Optional: Set a cooldown (in seconds) by default is 3 seconds
+PingCommand.setCooldown(5);
+
+// Set the command's description
+PingCommand.setDescription('Replies with Pong!');
+
+// Optional: Add more localization descriptions for the command itself
+PingCommand.setLocalizationDescription({
+    [Locale.EnglishUS]: 'Replies with Pong!',
+    [Locale.SpanishLATAM]: 'Responde con Pong!',
+});
+
+// Set the executor function
+PingCommand.setExecute(async ({ interaction, locale }) => {
+    await interaction.reply(locale['response']);
 });
 
-// Register the command so it can be used by the Discord.js client
-module.exports = RegisterCommand([
-    PingCommand
-]);
+module.exports = RegisterCommand(PingCommand)
 ```
 
 In your main file, you can load the commands and register their executors with your Discord client.

package/dist/modularbutton.d.ts

@@ -16,15 +16,19 @@ export default class ModularButton {
     customId: string;
     /** The visual style of the button. */
     style: ButtonStyle;
-    /** The function to execute when the button is clicked. */
+    /**
+     * @deprecated This property is deprecated and will be removed in future versions.
+     * Use other mechanisms to handle button interactions.
+     */
     execute: ButtonExecuteFunction;
     /**
      * @description Creates a new ModularButton instance.
      * @param {string} customId The custom ID for the button. This should be unique within the context of a message.
-     * @param {ButtonStyle} style The visual style of the button.
      */
-    constructor(customId: string, style: ButtonStyle);
+    constructor(customId: string);
     /**
+     * @deprecated This method is deprecated and will be removed in future versions.
+     * Use other mechanisms to handle button interactions.
      * @description Sets the execution function for the button's click event.
      * @param {ButtonExecuteFunction} executeFunction The function to run when the button is interacted with.
      * @returns {this} The current ModularButton instance for method chaining.

package/dist/modularbutton.js

@@ -17,18 +17,21 @@ class ModularButton {
     /**
      * @description Creates a new ModularButton instance.
      * @param {string} customId The custom ID for the button. This should be unique within the context of a message.
-     * @param {ButtonStyle} style The visual style of the button.
      */
-    constructor(customId, style) {
-        /** The function to execute when the button is clicked. */
+    constructor(customId) {
+        /**
+         * @deprecated This property is deprecated and will be removed in future versions.
+         * Use other mechanisms to handle button interactions.
+         */
         this.execute = async () => { };
         this.buttonObject = new discord_js_1.ButtonBuilder()
-            .setCustomId(customId)
-            .setStyle(style);
+            .setCustomId(customId);
         this.customId = customId;
-        this.style = style;
+        this.style = discord_js_1.ButtonStyle.Primary;
     }
     /**
+     * @deprecated This method is deprecated and will be removed in future versions.
+     * Use other mechanisms to handle button interactions.
      * @description Sets the execution function for the button's click event.
      * @param {ButtonExecuteFunction} executeFunction The function to run when the button is interacted with.
      * @returns {this} The current ModularButton instance for method chaining.

package/dist/modularcommand.d.ts

@@ -3,7 +3,7 @@
  * @author vicentefelipechile
  * @license MIT
  */
-import { LocalizationMap, ButtonStyle } from 'discord.js';
+import { LocalizationMap } from 'discord.js';
 import ModularModal from './modularmodal.js';
 import ModularButton from './modularbutton.js';
 import { ButtonExecuteFunction, CommandExecuteFunction, CommandOption, ComponentExecuteFunction, ModalExecuteFunction, PermissionCheckFunction } from './types.js';
@@ -47,7 +47,7 @@ export default class ModularCommand {
     /** (Optional) The function to handle modal submissions. */
     modalExecute?: ModalExecuteFunction;
     /** A record of handlers for specific component custom IDs. */
-    customIdHandlers: Record<string, CommandExecuteFunction>;
+    customIdHandlers: Record<string, CommandExecuteFunction | ButtonExecuteFunction | ModalExecuteFunction>;
     /** The command's cooldown time in seconds. */
     cooldown: number;
     /** Whether the command is marked as Not Safe For Work (NSFW). */
@@ -136,10 +136,10 @@ export default class ModularCommand {
     /**
      * Adds a custom ID handler for the command.
      * @param {string} customId The custom ID to match.
-     * @param {CommandExecuteFunction} handlerFunction The function to execute when the custom ID matches.
+     * @param {CommandExecuteFunction | ButtonExecuteFunction | ModalExecuteFunction} handlerFunction The function to execute when the custom ID matches.
      * @returns {ModularCommand} The command instance for chaining.
      */
-    addCustomIDHandler(customId: string, handlerFunction: CommandExecuteFunction): this;
+    addCustomIDHandler(customId: string, handlerFunction: CommandExecuteFunction | ButtonExecuteFunction | ModalExecuteFunction): this;
     /**
      * Creates a new modal for the command.
      * @param {string} modalId The ID for the modal.
@@ -149,8 +149,8 @@ export default class ModularCommand {
     /**
      * Creates a new button for the command.
      * @param {string} customId The custom ID for the button.
-     * @param {ButtonStyle} style The style of the button.
+     * @param {ButtonExecuteFunction} execute The function to execute when the button is clicked.
      * @return {ModularButton} The created button instance.
      */
-    addButton(customId: string, style: ButtonStyle): ModularButton;
+    addButton(customId: string, execute: ButtonExecuteFunction): ModularButton;
 }

package/dist/modularcommand.js

@@ -166,7 +166,7 @@ class ModularCommand {
     /**
      * Adds a custom ID handler for the command.
      * @param {string} customId The custom ID to match.
-     * @param {CommandExecuteFunction} handlerFunction The function to execute when the custom ID matches.
+     * @param {CommandExecuteFunction | ButtonExecuteFunction | ModalExecuteFunction} handlerFunction The function to execute when the custom ID matches.
      * @returns {ModularCommand} The command instance for chaining.
      */
     addCustomIDHandler(customId, handlerFunction) {
@@ -186,13 +186,14 @@ class ModularCommand {
     /**
      * Creates a new button for the command.
      * @param {string} customId The custom ID for the button.
-     * @param {ButtonStyle} style The style of the button.
+     * @param {ButtonExecuteFunction} execute The function to execute when the button is clicked.
      * @return {ModularButton} The created button instance.
      */
-    addButton(customId, style) {
-        const button = new modularbutton_js_1.default(customId, style);
+    addButton(customId, execute) {
+        const button = new modularbutton_js_1.default(customId);
         this.buttons.set(customId, button);
         this.buttonsArray.push(button);
+        this.addCustomIDHandler(customId, execute);
         return button;
     }
 }

package/dist/modularlocale.js

@@ -317,4 +317,5 @@ const LOCALE_DELAY = {
         .setPhraseOnlyMinutes('Bạn phải đợi {minutes} trước khi sử dụng lại lệnh này.')
 };
 exports.LOCALE_DELAY = LOCALE_DELAY;
+Object.freeze(LOCALE_DELAY);
 exports.default = LOCALE_DELAY;

package/dist/modularmodal.d.ts

@@ -3,7 +3,7 @@
  * @author vicentefelipechile
  * @license MIT
  */
-import { ModalBuilder, TextInputBuilder, TextInputStyle } from "discord.js";
+import { ModalBuilder, TextInputBuilder } from "discord.js";
 import { LocaleKey, ModalExecuteFunction } from "./types";
 import ModularCommand from "./modularcommand";
 /**
@@ -38,10 +38,9 @@ export default class ModularModal {
     /**
      * @description Creates a new text input component and adds it to the modal.
      * @param {string} id The custom ID for the text input.
-     * @param {TextInputStyle} style The visual style of the text input.
      * @returns {TextInputBuilder} The created text input instance.
      */
-    newTextInput(id: string, style: TextInputStyle): TextInputBuilder;
+    newTextInput(id: string): TextInputBuilder;
     /**
      * @description Builds the final modal object, applying localized titles and labels.
      * @param {LocaleKey} locale The localization object containing translated texts.

package/dist/modularmodal.js

@@ -40,13 +40,11 @@ class ModularModal {
     /**
      * @description Creates a new text input component and adds it to the modal.
      * @param {string} id The custom ID for the text input.
-     * @param {TextInputStyle} style The visual style of the text input.
      * @returns {TextInputBuilder} The created text input instance.
      */
-    newTextInput(id, style) {
+    newTextInput(id) {
         const textInput = new discord_js_1.TextInputBuilder()
-            .setCustomId(id)
-            .setStyle(style);
+            .setCustomId(id);
         this.modalInputs.set(id, textInput);
         const actionRow = new discord_js_1.ActionRowBuilder().addComponents(textInput);
         this.modalObject.addComponents(actionRow);

package/dist/registercommand.js

@@ -47,7 +47,7 @@ const locales_1 = require("./locales");
  * Falls back to EnglishUS if the target locale is not available.
  * @param {ModularCommand} command The command instance.
  * @param {Interaction} interaction The interaction object to get the locale from.
- * @returns {CommandLocale} The resolved locale object.
+ * @returns {LocalizationPhrases} The resolved locale object.
  * @throws {Error} If the EnglishUS localization is missing when at least one localization is defined.
  */
 function getCommandLocale(command, interaction) {
@@ -58,8 +58,11 @@ function getCommandLocale(command, interaction) {
     if (!localeTable[discord_js_1.Locale.EnglishUS]) {
         throw new Error(`Missing localization for EnglishUS in command ${command.name}`);
     }
-    const targetLocale = localeTable[interaction.locale] ? interaction.locale : discord_js_1.Locale.EnglishUS;
-    return { [targetLocale]: localeTable[targetLocale] };
+    let phrases = localeTable[interaction.locale];
+    if (!phrases) {
+        phrases = localeTable[discord_js_1.Locale.EnglishUS];
+    }
+    return phrases;
 }
 // =================================================================================================
 // Execution Context Constructors

package/package.json

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