js-discord-modularcommand 1.0.1 → 2.0.0

package/README.md

@@ -0,0 +1,55 @@
+# JS Discord ModularCommand
+
+A module to create and manage modular commands in a simple way for Discord.js bots.
+
+## What is it for?
+
+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
+```
+
+Then, you can create your commands in a modular fashion. Here is a basic example of a `ping` command:
+
+```javascript
+// filepath: commands/ping.js
+const { ModularCommand, RegisterCommand } = require('js-discord-modularcommand');
+const { PermissionFlagsBits } = require('discord.js');
+
+// Create a new command instance
+const PingCommand = new ModularCommand('ping');
+
+// Set the description
+PingCommand.setDescription('Sends a ping message!');
+
+// Optional: Add a permission check
+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!');
+});
+
+// Register the command so it can be used by the Discord.js client
+module.exports = RegisterCommand([
+    PingCommand
+]);
+```
+
+In your main file, you can load the commands and register their executors with your Discord client.
+
+## License
+
+This project is under the MIT License. See the [LICENSE](LICENSE) file

package/dist/cooldown.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @file Manages command cooldowns for users to prevent spam.
+ * @author vicentefelipechile
+ * @license MIT
+ */
+/**
+ * @interface CooldownStatus
+ * @description Represents the cooldown status of a user for a specific command.
+*/
+interface CooldownStatus {
+    /** Indicates if the user is currently on cooldown. */
+    inCooldown: boolean;
+    /** The remaining time in seconds until the cooldown expires. It will be 0 if the user is not in cooldown. */
+    waitTime: number;
+}
+/**
+ * Registers a new command and its cooldown duration in the internal maps.
+ * @param {string} name - The name of the command to register.
+ * @param {number} duration - The cooldown duration in seconds.
+ * @returns {void}
+ */
+export declare function cooldownRegister(name: string, duration: number): void;
+/**
+ * Gets the last execution timestamp for a user on a specific command.
+ * @param {string} name - The name of the command.
+ * @param {string} userId - The ID of the user.
+ * @returns {number | undefined} The timestamp (in milliseconds) of the last execution, or `undefined` if not found.
+ */
+export declare function cooldownGetUser(name: string, userId: string): number | undefined;
+/**
+ * Sets the current timestamp for a user on a specific command, effectively starting their cooldown.
+ * @param {string} name - The name of the command.
+ * @param {string} userId - The ID of the user.
+ * @returns {void}
+ */
+export declare function cooldownSetUser(name: string, userId: string): void;
+/**
+ * Checks if a user is currently on cooldown for a specific command.
+ * @param {string} name - The name of the command.
+ * @param {string} userId - The ID of the user.
+ * @returns {CooldownStatus} An object indicating if the user is in cooldown and the remaining time.
+ */
+export default function isUserInCooldown(name: string, userId: string): CooldownStatus;
+export {};

package/dist/cooldown.js

@@ -0,0 +1,81 @@
+"use strict";
+/**
+ * @file Manages command cooldowns for users to prevent spam.
+ * @author vicentefelipechile
+ * @license MIT
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cooldownRegister = cooldownRegister;
+exports.cooldownGetUser = cooldownGetUser;
+exports.cooldownSetUser = cooldownSetUser;
+exports.default = isUserInCooldown;
+// =================================================================================================
+// Module-level State
+// =================================================================================================
+/**
+ * @description Stores the cooldown duration configured for each command.
+ * @maps Command name (string) to its cooldown duration in seconds (number).
+ */
+const COMMAND_CONFIG = new Map();
+/**
+ * @description Stores the last execution timestamp for each user on a specific command.
+ * @maps Command name (string) to another Map, which in turn maps a user's ID (string) to the execution timestamp (number).
+ */
+const COOLDOWNS_MAP = new Map();
+// =================================================================================================
+// Public Functions
+// =================================================================================================
+/**
+ * Registers a new command and its cooldown duration in the internal maps.
+ * @param {string} name - The name of the command to register.
+ * @param {number} duration - The cooldown duration in seconds.
+ * @returns {void}
+ */
+function cooldownRegister(name, duration) {
+    COMMAND_CONFIG.set(name, duration);
+    COOLDOWNS_MAP.set(name, new Map());
+}
+;
+/**
+ * Gets the last execution timestamp for a user on a specific command.
+ * @param {string} name - The name of the command.
+ * @param {string} userId - The ID of the user.
+ * @returns {number | undefined} The timestamp (in milliseconds) of the last execution, or `undefined` if not found.
+ */
+function cooldownGetUser(name, userId) {
+    return COOLDOWNS_MAP.get(name)?.get(userId);
+}
+/**
+ * Sets the current timestamp for a user on a specific command, effectively starting their cooldown.
+ * @param {string} name - The name of the command.
+ * @param {string} userId - The ID of the user.
+ * @returns {void}
+ */
+function cooldownSetUser(name, userId) {
+    COOLDOWNS_MAP.get(name)?.set(userId, Date.now());
+}
+/**
+ * Checks if a user is currently on cooldown for a specific command.
+ * @param {string} name - The name of the command.
+ * @param {string} userId - The ID of the user.
+ * @returns {CooldownStatus} An object indicating if the user is in cooldown and the remaining time.
+ */
+function isUserInCooldown(name, userId) {
+    const lastTime = cooldownGetUser(name, userId);
+    // If the user has never used the command, they are not on cooldown.
+    if (lastTime === undefined) {
+        return { inCooldown: false, waitTime: 0 };
+    }
+    const timePassed = (Date.now() - lastTime) / 1000; // Time passed in seconds
+    const cooldownCommand = COMMAND_CONFIG.get(name);
+    // This error indicates a developer mistake, as a command should be registered before being checked.
+    if (cooldownCommand === undefined) {
+        throw new Error(`Command '${name}' isn't registered in the cooldown system.`);
+    }
+    if (timePassed < cooldownCommand) {
+        // If the time passed is less than the required cooldown, the user is still on cooldown.
+        return { inCooldown: true, waitTime: cooldownCommand - timePassed };
+    }
+    // Otherwise, the cooldown has expired.
+    return { inCooldown: false, waitTime: 0 };
+}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { LOCALE_DELAY, LOCALE_ERROR, LOCALE_FORBIDDEN, LOCALE_NSFW } from "./locales";
+import ModularCommandHandler from "./interaction";
+import { CommandData } from "./types";
+import ModularModal from "./modularmodal";
+import ModularCommand from "./modularcommand";
+import ModularButton from "./modularbutton";
+import RegisterCommand from "./registercommand";
+import LoadCommand from "./loadcommands";
+export default ModularCommand;
+export { ModularCommand, ModularButton, ModularModal, CommandData, RegisterCommand, LoadCommand, ModularCommandHandler, LOCALE_DELAY, LOCALE_ERROR, LOCALE_FORBIDDEN, LOCALE_NSFW };

package/dist/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOCALE_NSFW = exports.LOCALE_FORBIDDEN = exports.LOCALE_ERROR = exports.LOCALE_DELAY = exports.ModularCommandHandler = exports.LoadCommand = exports.RegisterCommand = exports.ModularModal = exports.ModularButton = exports.ModularCommand = void 0;
+const locales_1 = require("./locales");
+Object.defineProperty(exports, "LOCALE_DELAY", { enumerable: true, get: function () { return locales_1.LOCALE_DELAY; } });
+Object.defineProperty(exports, "LOCALE_ERROR", { enumerable: true, get: function () { return locales_1.LOCALE_ERROR; } });
+Object.defineProperty(exports, "LOCALE_FORBIDDEN", { enumerable: true, get: function () { return locales_1.LOCALE_FORBIDDEN; } });
+Object.defineProperty(exports, "LOCALE_NSFW", { enumerable: true, get: function () { return locales_1.LOCALE_NSFW; } });
+const interaction_1 = __importDefault(require("./interaction"));
+exports.ModularCommandHandler = interaction_1.default;
+const modularmodal_1 = __importDefault(require("./modularmodal"));
+exports.ModularModal = modularmodal_1.default;
+const modularcommand_1 = __importDefault(require("./modularcommand"));
+exports.ModularCommand = modularcommand_1.default;
+const modularbutton_1 = __importDefault(require("./modularbutton"));
+exports.ModularButton = modularbutton_1.default;
+const registercommand_1 = __importDefault(require("./registercommand"));
+exports.RegisterCommand = registercommand_1.default;
+const loadcommands_1 = __importDefault(require("./loadcommands"));
+exports.LoadCommand = loadcommands_1.default;
+exports.default = modularcommand_1.default;

package/dist/interaction.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @file Contains the logic for handling Discord bot interactions.
+ * @author vicentefelipechile
+ * @license MIT
+ */
+import { BaseInteraction, CommandInteraction, MessageComponentInteraction, ModalSubmitInteraction } from "discord.js";
+import { ClientWithCommands } from "./types";
+/**
+ * @interface InteractionHandlerArgs
+ * @description Defines the arguments for the custom interaction handler function.
+ */
+interface InteractionHandlerArgs {
+    /** The interaction received from Discord. */
+    interaction: CommandInteraction | MessageComponentInteraction | ModalSubmitInteraction;
+}
+/**
+ * @type InteractionHandler
+ * @description A function signature for a custom interaction handler.
+ * @returns {Promise<boolean | undefined>} A promise that resolves to `false` to stop the default handler, or `true`/`undefined` to continue.
+ */
+type InteractionHandler = (args: InteractionHandlerArgs) => Promise<boolean | undefined>;
+/**
+ * @description Creates a modular command handler function for the Discord client.
+ * @param {ClientWithCommands} client The Discord client instance with a commands collection.
+ * @param {InteractionHandler} customHandler A custom function to handle interactions before the default logic.
+ * @returns {(interaction: BaseInteraction) = Promise<void>} The main interaction handler function.
+ */
+export default function ModularCommandHandler(client: ClientWithCommands, customHandler: InteractionHandler): (interaction: BaseInteraction) => Promise<void>;
+export {};

package/dist/interaction.js

@@ -0,0 +1,83 @@
+"use strict";
+/**
+ * @file Contains the logic for handling Discord bot interactions.
+ * @author vicentefelipechile
+ * @license MIT
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = ModularCommandHandler;
+const discord_js_1 = require("discord.js");
+const locales_1 = require("./locales");
+// =================================================================================================
+// Main Handler Function
+// =================================================================================================
+/**
+ * @description Creates a modular command handler function for the Discord client.
+ * @param {ClientWithCommands} client The Discord client instance with a commands collection.
+ * @param {InteractionHandler} customHandler A custom function to handle interactions before the default logic.
+ * @returns {(interaction: BaseInteraction) = Promise<void>} The main interaction handler function.
+ */
+function ModularCommandHandler(client, customHandler) {
+    if (!client.commands) {
+        throw new Error(`Client is missing the 'commands' collection.`);
+    }
+    if (!(client.commands instanceof discord_js_1.Collection)) {
+        throw new Error(`Client.commands is not an instance of Discord.js Collection.`);
+    }
+    const handler = async (interaction) => {
+        if (!interaction.isChatInputCommand() && !interaction.isMessageComponent() && !interaction.isModalSubmit()) {
+            return;
+        }
+        const response = await customHandler({ interaction });
+        if (response === false)
+            return;
+        let commandName;
+        if (interaction.isChatInputCommand()) {
+            commandName = interaction.commandName;
+        }
+        else if (interaction.customId) {
+            commandName = interaction.customId.split('_')[0];
+        }
+        else {
+            const errorMessage = locales_1.LOCALE_ERROR[interaction.locale];
+            if (interaction.replied || interaction.deferred) {
+                await interaction.followUp({ content: errorMessage, flags: discord_js_1.MessageFlags.Ephemeral });
+            }
+            else {
+                await interaction.reply({ content: errorMessage, flags: discord_js_1.MessageFlags.Ephemeral });
+            }
+            console.error(`Interaction does not have a commandName or customId: ${interaction.id}`);
+            return;
+        }
+        const command = client.commands.get(commandName);
+        if (command === undefined) {
+            console.error(`No command found for interaction: ${interaction.id} with command name: ${commandName}`);
+            return;
+        }
+        try {
+            if (interaction.isChatInputCommand()) {
+                await command.execute(interaction);
+            }
+            else if (interaction.isButton() && command.buttonExecute) {
+                await command.buttonExecute(interaction);
+            }
+            else if (interaction.isMessageComponent() && command.componentExecute) {
+                await command.componentExecute(interaction);
+            }
+            else if (interaction.isModalSubmit() && command.modalExecute) {
+                await command.modalExecute(interaction);
+            }
+        }
+        catch (error) {
+            const errorMessage = locales_1.LOCALE_ERROR[interaction.locale];
+            if (interaction.replied || interaction.deferred) {
+                await interaction.followUp({ content: errorMessage, flags: discord_js_1.MessageFlags.Ephemeral });
+            }
+            else {
+                await interaction.reply({ content: errorMessage, flags: discord_js_1.MessageFlags.Ephemeral });
+            }
+            console.error(`Error handling interaction: ${interaction.id}`, error);
+        }
+    };
+    return handler;
+}

package/dist/loadcommands.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @file Contains the logic for loading modular commands into the Discord bot client.
+ * @author vicentefelipechile
+ * @license MIT
+ */
+import { CommandData } from "./types";
+/**
+ * @description Loads one or more commands into an array.
+ * @param {CommandData[]} commandsArray The array where the loaded commands will be stored.
+ * @param {CommandData | CommandData[]} command The command(s) to load. Can be a single `CommandData` object or an array of them.
+ * @throws {TypeError} If a command is missing the `execute` function.
+ * @example
+ * ```typescript
+ * import { Collection } from "discord.js";
+ * import LoadCommand from "./loadcommands";
+ * import exampleCommand from "./commands/example";
+ *
+ * const commandsList: CommandData[] = [];
+ * LoadCommand(commandsList, exampleCommand);
+ *
+ * const client = { commands: new Collection<string, CommandData>() };
+ * for (const cmd of commandsList) {
+ *   client.commands.set(cmd.data.name, cmd);
+ * }
+ * ```
+ */
+export default function LoadCommand(commandsArray: CommandData[], command: CommandData | CommandData[]): void;

package/dist/loadcommands.js

@@ -0,0 +1,40 @@
+"use strict";
+/**
+ * @file Contains the logic for loading modular commands into the Discord bot client.
+ * @author vicentefelipechile
+ * @license MIT
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = LoadCommand;
+// =================================================================================================
+// Main Loading Function
+// =================================================================================================
+/**
+ * @description Loads one or more commands into an array.
+ * @param {CommandData[]} commandsArray The array where the loaded commands will be stored.
+ * @param {CommandData | CommandData[]} command The command(s) to load. Can be a single `CommandData` object or an array of them.
+ * @throws {TypeError} If a command is missing the `execute` function.
+ * @example
+ * ```typescript
+ * import { Collection } from "discord.js";
+ * import LoadCommand from "./loadcommands";
+ * import exampleCommand from "./commands/example";
+ *
+ * const commandsList: CommandData[] = [];
+ * LoadCommand(commandsList, exampleCommand);
+ *
+ * const client = { commands: new Collection<string, CommandData>() };
+ * for (const cmd of commandsList) {
+ *   client.commands.set(cmd.data.name, cmd);
+ * }
+ * ```
+ */
+function LoadCommand(commandsArray, command) {
+    const commands = Array.isArray(command) ? command : [command];
+    for (const cmd of commands) {
+        if (typeof cmd.execute !== "function") {
+            throw new TypeError(`Command "${cmd.data.name}" is missing a required 'execute' function.`);
+        }
+        commandsArray.push(cmd);
+    }
+}

package/dist/locales.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @file Contains the generic localization phrases used throughout the application.
+ * @author vicentefelipechile
+ * @license MIT
+ */
+import { Locale } from "discord.js";
+import LOCALE_DELAY, { ModularLocale } from "./modularlocale";
+/**
+ * @description Localization phrases for various commands, specifically for permission errors.
+ */
+declare const LOCALE_FORBIDDEN: Record<Locale, string>;
+/**
+ * @description Localization phrases for NSFW command usage errors.
+ */
+declare const LOCALE_NSFW: Record<Locale, string>;
+/**
+ * @description Localization phrases for general application errors.
+ */
+declare const LOCALE_ERROR: Record<Locale, string>;
+export { LOCALE_DELAY, LOCALE_ERROR, LOCALE_FORBIDDEN, LOCALE_NSFW, ModularLocale };

package/dist/locales.js

@@ -0,0 +1,162 @@
+"use strict";
+/**
+ * @file Contains the generic localization phrases used throughout the application.
+ * @author vicentefelipechile
+ * @license MIT
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModularLocale = exports.LOCALE_NSFW = exports.LOCALE_FORBIDDEN = exports.LOCALE_ERROR = exports.LOCALE_DELAY = void 0;
+const discord_js_1 = require("discord.js");
+const modularlocale_1 = __importStar(require("./modularlocale"));
+exports.LOCALE_DELAY = modularlocale_1.default;
+Object.defineProperty(exports, "ModularLocale", { enumerable: true, get: function () { return modularlocale_1.ModularLocale; } });
+// =================================================================================================
+// Localization Phrases
+// =================================================================================================
+/**
+ * @description Localization phrases for various commands, specifically for permission errors.
+ */
+const LOCALE_FORBIDDEN = {
+    [discord_js_1.Locale.SpanishLATAM]: 'No tienes permiso para usar este comando.',
+    [discord_js_1.Locale.EnglishUS]: 'You do not have permission to use this command.',
+    [discord_js_1.Locale.EnglishGB]: 'I say, it appears you lack the proper authorisation to utilise this command, old bean.',
+    [discord_js_1.Locale.SpanishES]: 'Ostias chaval, tio parece que no vais a poder usar este comando madre mia willy, que barbaridad.',
+    [discord_js_1.Locale.PortugueseBR]: 'Você não tem permissão para usar este comando.',
+    [discord_js_1.Locale.French]: 'Vous n\'avez pas la permission d\'utiliser cette commande.',
+    [discord_js_1.Locale.German]: 'Du hast keine Berechtigung, diesen Befehl zu verwenden.',
+    [discord_js_1.Locale.Italian]: 'Non hai il permesso di usare questo comando.',
+    [discord_js_1.Locale.Russian]: 'У вас нет разрешения на использование этой команды.',
+    [discord_js_1.Locale.ChineseCN]: '您没有权限使用此命令。',
+    [discord_js_1.Locale.ChineseTW]: '您沒有權限使用此命令。',
+    [discord_js_1.Locale.Japanese]: 'このコマンドを使用する権限がありません。',
+    [discord_js_1.Locale.Korean]: '이 명령을 사용할 권한이 없습니다.',
+    [discord_js_1.Locale.Bulgarian]: 'Нямате разрешение да използвате тази команда.',
+    [discord_js_1.Locale.Czech]: 'Nemáte oprávnění k použití tohoto příkazu.',
+    [discord_js_1.Locale.Danish]: 'Du har ikke tilladelse til at bruge denne kommando.',
+    [discord_js_1.Locale.Dutch]: 'Je hebt geen toestemming om deze opdracht te gebruiken.',
+    [discord_js_1.Locale.Finnish]: 'Sinulla ei ole lupaa käyttää tätä komentoa.',
+    [discord_js_1.Locale.Hungarian]: 'Nincs jogosultságod ehhez a parancshoz.',
+    [discord_js_1.Locale.Norwegian]: 'Du har ikke behörighet til å bruke denne kommandoen.',
+    [discord_js_1.Locale.Polish]: 'Nie masz uprawnień do używania tej komendy.',
+    [discord_js_1.Locale.Romanian]: 'Nu ai permisiunea de a folosi acest comandă.',
+    [discord_js_1.Locale.Swedish]: 'Du har inte behörighet att använda det här kommandot.',
+    [discord_js_1.Locale.Turkish]: 'Bu komutu kullanma izniniz yok.',
+    [discord_js_1.Locale.Ukrainian]: 'У вас немає дозволу на використання цієї команди.',
+    [discord_js_1.Locale.Hindi]: 'आपको इस कमांड का उपयोग करने की अनुमति नहीं है।',
+    [discord_js_1.Locale.Indonesian]: 'Anda tidak memiliki izin untuk menggunakan perintah ini.',
+    [discord_js_1.Locale.Greek]: 'Δεν έχετε άδεια να χρησιμοποιήσετε αυτήν την εντολή.',
+    [discord_js_1.Locale.Croatian]: 'Nemate dopuštenje za korištenje ove naredbe.',
+    [discord_js_1.Locale.Lithuanian]: 'Jūs neturite teisės naudoti šio komandos.',
+    [discord_js_1.Locale.Thai]: 'คุณไม่มีสิทธิ์ใช้คำสั่งนี้.',
+    [discord_js_1.Locale.Vietnamese]: 'Bạn không có quyền sử dụng lệnh này.'
+};
+exports.LOCALE_FORBIDDEN = LOCALE_FORBIDDEN;
+/**
+ * @description Localization phrases for NSFW command usage errors.
+ */
+const LOCALE_NSFW = {
+    [discord_js_1.Locale.SpanishLATAM]: 'Este comando solo puede ser usado en canales NSFW.',
+    [discord_js_1.Locale.EnglishUS]: 'This command can only be used in NSFW channels.',
+    [discord_js_1.Locale.EnglishGB]: 'I do declare, this command is exclusively for channels of a... risqué nature. little bit of cheeky fun, eh?',
+    [discord_js_1.Locale.SpanishES]: '¡Ostias, chaval! Que este comando es solo para los canales más guarros, ¿vale? No me seas meapilas.',
+    [discord_js_1.Locale.PortugueseBR]: 'Este comando só pode ser usado em canais NSFW.',
+    [discord_js_1.Locale.French]: 'Cette commande ne peut être utilisée que dans les salons NSFW.',
+    [discord_js_1.Locale.German]: 'Dieser Befehl kann nur in NSFW-Kanälen verwendet werden.',
+    [discord_js_1.Locale.Italian]: 'Questo comando può essere utilizzato solo nei canali NSFW.',
+    [discord_js_1.Locale.Russian]: 'Эту команду можно использовать только в каналах NSFW.',
+    [discord_js_1.Locale.ChineseCN]: '此命令只能在NSFW频道中使用。',
+    [discord_js_1.Locale.ChineseTW]: '此命令只能在 NSFW 頻道中使用。',
+    [discord_js_1.Locale.Japanese]: 'このコマンドはNSFWチャンネルでのみ使用できます。',
+    [discord_js_1.Locale.Korean]: '이 명령어는 NSFW 채널에서만 사용할 수 있습니다.',
+    [discord_js_1.Locale.Bulgarian]: 'Тази команда може да се използва само в NSFW канали.',
+    [discord_js_1.Locale.Czech]: 'Tento příkaz lze použít pouze v kanálech NSFW.',
+    [discord_js_1.Locale.Danish]: 'Denne kommando kan kun bruges i NSFW-kanaler.',
+    [discord_js_1.Locale.Dutch]: 'Deze opdracht kan alleen worden gebruikt in NSFW-kanalen.',
+    [discord_js_1.Locale.Finnish]: 'Tätä komentoa voi käyttää vain NSFW-kanavilla.',
+    [discord_js_1.Locale.Hungarian]: 'Ez a parancs csak NSFW csatornákon használható.',
+    [discord_js_1.Locale.Norwegian]: 'Denne kommandoen kan bare brukes i NSFW-kanaler.',
+    [discord_js_1.Locale.Polish]: 'Ta komenda może być używana tylko na kanałach NSFW.',
+    [discord_js_1.Locale.Romanian]: 'Această comandă poate fi utilizată numai în canalele NSFW.',
+    [discord_js_1.Locale.Swedish]: 'Det här kommandot kan endast användas i NSFW-kanaler.',
+    [discord_js_1.Locale.Turkish]: 'Bu komut yalnızca NSFW kanallarında kullanılabilir.',
+    [discord_js_1.Locale.Ukrainian]: 'Цю команду можна використовувати лише в каналах NSFW.',
+    [discord_js_1.Locale.Hindi]: 'यह कमांड केवल NSFW चैनलों में ही उपयोग की जा सकती है।',
+    [discord_js_1.Locale.Indonesian]: 'Perintah ini hanya dapat digunakan di saluran NSFW.',
+    [discord_js_1.Locale.Greek]: 'Αυτή η εντολή μπορεί να χρησιμοποιηθεί μόνο σε κανάλια NSFW.',
+    [discord_js_1.Locale.Croatian]: 'Ova se naredba može koristiti samo u NSFW kanalima.',
+    [discord_js_1.Locale.Lithuanian]: 'Ši komanda gali būti naudojama tik NSFW kanaluose.',
+    [discord_js_1.Locale.Thai]: 'คำสั่งนี้สามารถใช้ได้เฉพาะในช่องทาง NSFW เท่านั้น.',
+    [discord_js_1.Locale.Vietnamese]: 'Lệnh này chỉ có thể được sử dụng trong các kênh NSFW.'
+};
+exports.LOCALE_NSFW = LOCALE_NSFW;
+/**
+ * @description Localization phrases for general application errors.
+ */
+const LOCALE_ERROR = {
+    [discord_js_1.Locale.SpanishLATAM]: 'Ocurrió un error al procesar tu solicitud.',
+    [discord_js_1.Locale.EnglishUS]: 'An error occurred while processing your request.',
+    [discord_js_1.Locale.EnglishGB]: 'I do declare, an error occurred while processing your request.',
+    [discord_js_1.Locale.SpanishES]: 'Pero que me estás contando, willy, ocurrió un error al procesar tu solicitud.',
+    [discord_js_1.Locale.PortugueseBR]: 'Ocorreu um erro ao processar sua solicitação.',
+    [discord_js_1.Locale.French]: 'Une erreur est survenue lors du traitement de votre demande.',
+    [discord_js_1.Locale.German]: 'Bei der Verarbeitung Ihrer Anfrage ist ein Fehler aufgetreten.',
+    [discord_js_1.Locale.Italian]: 'Si è verificato un errore durante l\'elaborazione della tua richiesta.',
+    [discord_js_1.Locale.Russian]: 'Произошла ошибка при обработке вашего запроса.',
+    [discord_js_1.Locale.ChineseCN]: '处理您的请求时发生错误。',
+    [discord_js_1.Locale.ChineseTW]: '處理您的請求時發生錯誤。',
+    [discord_js_1.Locale.Japanese]: 'リクエストの処理中にエラーが発生しました。',
+    [discord_js_1.Locale.Korean]: '요청을 처리하는 동안 오류가 발생했습니다.',
+    [discord_js_1.Locale.Bulgarian]: 'При обработката на заявката ви възникна грешка.',
+    [discord_js_1.Locale.Czech]: 'Při zpracování vaší žádosti došlo k chybě.',
+    [discord_js_1.Locale.Danish]: 'Der opstod en fejl under behandlingen af din anmodning.',
+    [discord_js_1.Locale.Dutch]: 'Er is een fout opgetreden bij het verwerken van uw verzoek.',
+    [discord_js_1.Locale.Finnish]: 'Pyyntösi käsittelyssä tapahtui virhe.',
+    [discord_js_1.Locale.Hungarian]: 'A kérésed feldolgozása során hiba lépett fel.',
+    [discord_js_1.Locale.Norwegian]: 'Det oppstod en feil under behandling av forespørselen din.',
+    [discord_js_1.Locale.Polish]: 'Wystąpił błąd podczas przetwarzania twojej prośby.',
+    [discord_js_1.Locale.Romanian]: 'A apărut o eroare în timpul procesării cererii tale.',
+    [discord_js_1.Locale.Swedish]: 'Ett fel inträffade vid behandling av din begäran.',
+    [discord_js_1.Locale.Turkish]: 'Talebiniz işlenirken bir hata oluştu.',
+    [discord_js_1.Locale.Ukrainian]: 'Під час обробки вашого запиту сталася помилка.',
+    [discord_js_1.Locale.Hindi]: 'आपके अनुरोध को संसाधित करते समय एक त्रुटि हुई।',
+    [discord_js_1.Locale.Indonesian]: 'Terjadi kesalahan saat memproses permintaan Anda.',
+    [discord_js_1.Locale.Greek]: 'Συνέβη σφάλμα κατά την επεξεργασία του αιτήματός σας.',
+    [discord_js_1.Locale.Croatian]: 'Došlo je do pogreške prilikom obrade vašeg zahtjeva.',
+    [discord_js_1.Locale.Lithuanian]: 'Apdorojant jūsų užklausą įvyko klaida.',
+    [discord_js_1.Locale.Thai]: 'เกิดข้อผิดพลาดระหว่างการประมวลผลคำขอของคุณ',
+    [discord_js_1.Locale.Vietnamese]: 'Đã xảy ra lỗi trong quá trình xử lý yêu cầu của bạn.'
+};
+exports.LOCALE_ERROR = LOCALE_ERROR;

package/dist/modularbutton.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @file Contains the structure for creating reusable button components.
+ * @author vicentefelipechile
+ * @license MIT
+ */
+import { ButtonBuilder, ButtonStyle } from "discord.js";
+import { ButtonExecuteFunction } from "./types";
+/**
+ * @class ModularButton
+ * @description A class to create and manage reusable button components.
+ */
+export default class ModularButton {
+    /** The Discord.js ButtonBuilder instance. */
+    buttonObject: ButtonBuilder;
+    /** The custom ID for the button, used to identify it in interactions. */
+    customId: string;
+    /** The visual style of the button. */
+    style: ButtonStyle;
+    /** The function to execute when the button is clicked. */
+    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);
+    /**
+     * @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.
+     */
+    setExecute(executeFunction: ButtonExecuteFunction): this;
+}