js-discord-modularcommand 2.5.2 → 3.0.0

package/README.md

@@ -281,6 +281,118 @@ feedbackCommand.setExecute(async ({ interaction, locale }) => {
 module.exports = RegisterCommand(feedbackCommand);
 ```
 
+### Subcommands
+
+Create commands with subcommands for better organization of related functionality.
+
+```javascript
+// filepath: /commands/settings.js
+const { ModularCommand, RegisterCommand } = require('js-discord-modularcommand');
+const { ApplicationCommandOptionType, PermissionFlagsBits, Locale, EmbedBuilder, Colors } = require('discord.js');
+
+const settingsCommand = new ModularCommand('settings')
+    .setDescription('Configure bot settings for this server.')
+    .setCooldown(5)
+    .setPermissionCheck((interaction) => interaction.member.permissions.has(PermissionFlagsBits.ManageGuild));
+
+// Add subcommands with their own options
+settingsCommand.addSubCommand({
+    name: 'set-prefix',
+    description: 'Set the command prefix for this server',
+    options: [
+        {
+            name: 'prefix',
+            description: 'The new prefix to use',
+            type: ApplicationCommandOptionType.String,
+            required: true
+        }
+    ]
+});
+
+settingsCommand.addSubCommand({
+    name: 'set-channel',
+    description: 'Set the default channel for bot messages',
+    options: [
+        {
+            name: 'channel',
+            description: 'The channel to use for bot messages',
+            type: ApplicationCommandOptionType.Channel,
+            required: true
+        }
+    ]
+});
+
+settingsCommand.addSubCommand({
+    name: 'view-config',
+    description: 'View current server configuration'
+});
+
+// Localize subcommands and their options
+settingsCommand.setLocalizationSubCommands({
+    [Locale.EnglishUS]: {
+        'set-prefix': 'Set Command Prefix',
+        'set-prefix.description': 'Set the command prefix for this server',
+        'set-prefix.prefix': 'Prefix',
+        'set-prefix.prefix.description': 'The new prefix to use for commands',
+        
+        'set-channel': 'Set Default Channel',
+        'set-channel.description': 'Set the default channel for bot messages',
+        'set-channel.channel': 'Channel',
+        'set-channel.channel.description': 'The channel to use for bot messages',
+        
+        'view-config': 'View Configuration',
+        'view-config.description': 'View current server configuration'
+    }
+});
+
+// Set up localized phrases
+settingsCommand.setLocalizationPhrases({
+    [Locale.EnglishUS]: {
+        'success.prefix_set': 'Command prefix has been set to `{prefix}`.',
+        'success.channel_set': 'Default channel has been set to {channel}.',
+        'config.title': 'Server Configuration - {serverName}',
+        'config.description': 'Current bot settings for this server:'
+    }
+});
+
+// Handle all subcommands in a single execute function
+settingsCommand.setExecute(async ({ interaction, locale, args }) => {
+    await interaction.deferReply();
+    
+    const subcommand = args.subcommand; // The subcommand name is automatically added to args
+    
+    switch (subcommand) {
+        case 'set-prefix':
+            const newPrefix = args.prefix;
+            // Save the prefix to your database
+            await interaction.editReply({
+                content: locale['success.prefix_set'].replace('{prefix}', newPrefix)
+            });
+            break;
+            
+        case 'set-channel':
+            const channel = args.channel;
+            // Save the channel to your database
+            await interaction.editReply({
+                content: locale['success.channel_set'].replace('{channel}', `<#${channel.id}>`)
+            });
+            break;
+            
+        case 'view-config':
+            const embed = new EmbedBuilder()
+                .setColor(Colors.Blue)
+                .setTitle(locale['config.title'].replace('{serverName}', interaction.guild.name))
+                .setDescription(locale['config.description'])
+                .setTimestamp();
+            
+            await interaction.editReply({ embeds: [embed] });
+            break;
+    }
+});
+
+module.exports = RegisterCommand(settingsCommand);
+```
+
 ## License
 
 This project is licensed under the MIT License. See the `LICENSE` file for details.

package/dist/cooldown.d.ts

@@ -1,7 +1,8 @@
 /**
- * @file Manages command cooldowns for users to prevent spam.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/cooldown.ts
+ * @author      vicentefelipechile
+ * @description Manages command cooldowns for users in a Discord bot using Discord.js.
  */
 /**
  * @interface CooldownStatus

package/dist/cooldown.js

@@ -1,8 +1,9 @@
 "use strict";
 /**
- * @file Manages command cooldowns for users to prevent spam.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/cooldown.ts
+ * @author      vicentefelipechile
+ * @description Manages command cooldowns for users in a Discord bot using Discord.js.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cooldownRegister = cooldownRegister;
@@ -66,7 +67,7 @@ function isUserInCooldown(name, userId) {
     if (lastTime === undefined) {
         return { inCooldown: false, waitTime: 0 };
     }
-    const timePassed = (Date.now() - lastTime) / 1000; // Time passed in seconds
+    const timePassed = Math.floor((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) {

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 import { LOCALE_DELAY, LOCALE_ERROR, LOCALE_FORBIDDEN, LOCALE_NSFW } from "./locales";
 import ModularCommandHandler from "./interaction";
-import { CommandData } from "./types";
+import { CommandData, SubCommand } 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 };
+export { ModularCommand, ModularButton, ModularModal, CommandData, SubCommand, RegisterCommand, LoadCommand, ModularCommandHandler, LOCALE_DELAY, LOCALE_ERROR, LOCALE_FORBIDDEN, LOCALE_NSFW };

package/dist/interaction.d.ts

@@ -1,7 +1,8 @@
 /**
- * @file Contains the logic for handling Discord bot interactions.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/interaction.ts
+ * @author      vicentefelipechile
+ * @description Provides a modular command handler for a Discord bot using Discord.js.
  */
 import { BaseInteraction, CommandInteraction, MessageComponentInteraction, ModalSubmitInteraction } from "discord.js";
 import { ClientWithCommands } from "./types";

package/dist/interaction.js

@@ -1,11 +1,15 @@
 "use strict";
 /**
- * @file Contains the logic for handling Discord bot interactions.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/interaction.ts
+ * @author      vicentefelipechile
+ * @description Provides a modular command handler for a Discord bot using Discord.js.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = ModularCommandHandler;
+// =================================================================================================
+// Imports
+// =================================================================================================
 const discord_js_1 = require("discord.js");
 const locales_1 = require("./locales");
 // =================================================================================================

package/dist/loadcommands.d.ts

@@ -1,7 +1,8 @@
 /**
- * @file Contains the logic for loading modular commands into the Discord bot client.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/loadcommands.ts
+ * @author      vicentefelipechile
+ * @description Loads one or more commands into an array.
  */
 import { CommandData } from "./types";
 /**

package/dist/loadcommands.js

@@ -1,8 +1,9 @@
 "use strict";
 /**
- * @file Contains the logic for loading modular commands into the Discord bot client.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/loadcommands.ts
+ * @author      vicentefelipechile
+ * @description Loads one or more commands into an array.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = LoadCommand;
@@ -32,6 +33,12 @@ exports.default = LoadCommand;
 function LoadCommand(commandsArray, command) {
     const commands = Array.isArray(command) ? command : [command];
     for (const cmd of commands) {
+        if (!cmd || typeof cmd !== "object") {
+            throw new TypeError(`Invalid command provided. Expected an object but received: ${typeof cmd}`);
+        }
+        if (!cmd.data || typeof cmd.data.name !== "string") {
+            throw new TypeError(`Command is missing a valid 'name' property.`);
+        }
         if (typeof cmd.execute !== "function") {
             throw new TypeError(`Command "${cmd.data.name}" is missing a required 'execute' function.`);
         }

package/dist/locales.d.ts

@@ -1,10 +1,11 @@
 /**
- * @file Contains the generic localization phrases used throughout the application.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/locales.ts
+ * @author      vicentefelipechile
+ * @description Localization phrases for various command responses in a Discord bot using Discord.js.
  */
 import { Locale } from "discord.js";
-import LOCALE_DELAY, { ModularLocale } from "./modularlocale";
+import LOCALE_DELAY from "./modularlocale";
 /**
  * @description Localization phrases for various commands, specifically for permission errors.
  */
@@ -17,4 +18,4 @@ 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 };
+export { LOCALE_DELAY, LOCALE_ERROR, LOCALE_FORBIDDEN, LOCALE_NSFW, };

package/dist/locales.js

@@ -1,48 +1,21 @@
 "use strict";
 /**
- * @file Contains the generic localization phrases used throughout the application.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/locales.ts
+ * @author      vicentefelipechile
+ * @description Localization phrases for various command responses in a Discord bot using Discord.js.
  */
-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;
-    };
-})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModularLocale = exports.LOCALE_NSFW = exports.LOCALE_FORBIDDEN = exports.LOCALE_ERROR = exports.LOCALE_DELAY = void 0;
+exports.LOCALE_NSFW = exports.LOCALE_FORBIDDEN = exports.LOCALE_ERROR = exports.LOCALE_DELAY = void 0;
+// =================================================================================================
+// Imports
+// =================================================================================================
 const discord_js_1 = require("discord.js");
-const modularlocale_1 = __importStar(require("./modularlocale"));
+const modularlocale_1 = __importDefault(require("./modularlocale"));
 exports.LOCALE_DELAY = modularlocale_1.default;
-Object.defineProperty(exports, "ModularLocale", { enumerable: true, get: function () { return modularlocale_1.ModularLocale; } });
 // =================================================================================================
 // Localization Phrases
 // =================================================================================================

package/dist/modularbutton.d.ts

@@ -1,7 +1,8 @@
 /**
- * @file Contains the structure for creating reusable button components.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/modularbutton.ts
+ * @author      vicentefelipechile
+ * @description A class to create and manage reusable button components in a Discord bot using Discord.js.
  */
 import { ButtonBuilder } from "discord.js";
 import { ButtonExecuteFunction, LocaleKey } from "./types";

package/dist/modularbutton.js

@@ -1,13 +1,17 @@
 "use strict";
 /**
- * @file Contains the structure for creating reusable button components.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/modularbutton.ts
+ * @author      vicentefelipechile
+ * @description A class to create and manage reusable button components in a Discord bot using Discord.js.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+// =================================================================================================
+// Imports
+// =================================================================================================
 const discord_js_1 = require("discord.js");
 // =================================================================================================
-// Main Class
+// ModularButton Class
 // =================================================================================================
 /**
  * @class ModularButton

package/dist/modularcommand.d.ts

@@ -1,13 +1,15 @@
 /**
- * @file Contains the main class for creating modular commands.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/modularcommand.ts
+ * @author      vicentefelipechile
+ * @description Provides a modular command structure for a Discord bot using Discord.js.
  */
 import { LocalizationMap } from 'discord.js';
 import ModularModal from './modularmodal.js';
 import ModularButton from './modularbutton.js';
 import ModularSelectMenu from './modularselectmenu.js';
-import { ButtonExecuteFunction, CommandExecuteFunction, CommandOption, ComponentExecuteFunction, ModalExecuteFunction, PermissionCheckFunction, SelectMenuExecuteFunction } from './types.js';
+import { ButtonExecuteFunction, CommandExecuteFunction, CommandOption, ComponentExecuteFunction, ModalExecuteFunction, PermissionCheckFunction, SelectMenuExecuteFunction, // <- ADD THIS
+SubCommand } from './types.js';
 /**
  * @description Represents a modular command that can be registered with Discord.js.
  * It allows for dynamic command creation and execution in a simple way.
@@ -39,6 +41,10 @@ export default class ModularCommand {
     options: CommandOption[];
     /** An object containing localizations for the names and descriptions of the options. */
     optionsLocalizations: LocalizationMap;
+    /** The subcommands that this command supports. */
+    subCommands: SubCommand[];
+    /** An object containing localizations for subcommand names, descriptions and options. */
+    subCommandLocalizations: LocalizationMap;
     /** The main function that executes when the command is invoked. */
     execute: CommandExecuteFunction;
     /** (Optional) The function to handle button interactions. */
@@ -101,6 +107,12 @@ export default class ModularCommand {
      * @returns {ModularCommand} The command instance for chaining.
      */
     setLocalizationPhrases(localizationPhrases: LocalizationMap): this;
+    /**
+     * Sets the localizations for subcommands, including names, descriptions, and options.
+     * @param {LocalizationMap} localizations The subcommand localizations map.
+     * @returns {ModularCommand} The command instance for chaining.
+     */
+    setLocalizationSubCommands(localizations: LocalizationMap): this;
     /**
      * Sets the execute function for the command.
      * @param {CommandExecuteFunction} executeFunction The function to execute.
@@ -137,6 +149,12 @@ export default class ModularCommand {
      * @returns {ModularCommand} The command instance for chaining.
      */
     addOption(option: CommandOption): this;
+    /**
+     * Adds a subcommand to the command.
+     * @param {SubCommand} subCommand The subcommand configuration.
+     * @returns {ModularCommand} The command instance for chaining.
+     */
+    addSubCommand(subCommand: SubCommand): this;
     /**
      * Adds a custom ID handler for the command.
      * @param {string} customId The custom ID to match.

package/dist/modularcommand.js

@@ -1,8 +1,9 @@
 "use strict";
 /**
- * @file Contains the main class for creating modular commands.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/modularcommand.ts
+ * @author      vicentefelipechile
+ * @description Provides a modular command structure for a Discord bot using Discord.js.
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
@@ -16,7 +17,7 @@ const modularmodal_js_1 = __importDefault(require("./modularmodal.js"));
 const modularbutton_js_1 = __importDefault(require("./modularbutton.js"));
 const modularselectmenu_js_1 = __importDefault(require("./modularselectmenu.js")); // <- ADD THIS
 // =================================================================================================
-// Class: ModularCommand
+// ModularCommand Class
 // =================================================================================================
 /**
  * @description Represents a modular command that can be registered with Discord.js.
@@ -47,6 +48,8 @@ class ModularCommand {
         this.modalExecute = undefined;
         this.options = [];
         this.optionsLocalizations = {};
+        this.subCommands = [];
+        this.subCommandLocalizations = {};
         this.customIdHandlers = {};
         this.cooldown = 3;
         this.modals = new Map();
@@ -111,6 +114,18 @@ class ModularCommand {
         };
         return this;
     }
+    /**
+     * Sets the localizations for subcommands, including names, descriptions, and options.
+     * @param {LocalizationMap} localizations The subcommand localizations map.
+     * @returns {ModularCommand} The command instance for chaining.
+     */
+    setLocalizationSubCommands(localizations) {
+        this.subCommandLocalizations = {
+            ...this.subCommandLocalizations,
+            ...localizations,
+        };
+        return this;
+    }
     /**
      * Sets the execute function for the command.
      * @param {CommandExecuteFunction} executeFunction The function to execute.
@@ -165,6 +180,15 @@ class ModularCommand {
         this.options.push(option);
         return this;
     }
+    /**
+     * Adds a subcommand to the command.
+     * @param {SubCommand} subCommand The subcommand configuration.
+     * @returns {ModularCommand} The command instance for chaining.
+     */
+    addSubCommand(subCommand) {
+        this.subCommands.push(subCommand);
+        return this;
+    }
     /**
      * Adds a custom ID handler for the command.
      * @param {string} customId The custom ID to match.

package/dist/modularlocale.d.ts

@@ -1,7 +1,8 @@
 /**
- * @module ModularLocale
+ * @license     MIT
+ * @file        src/modularlocale.ts
+ * @author      vicentefelipechile
  * @description Generic localization phrases used throughout the application.
- * @license MIT
  */
 import { Locale } from "discord.js";
 /**
@@ -100,4 +101,3 @@ declare const LOCALE_DELAY: {
     vi: ModularLocale;
 };
 export default LOCALE_DELAY;
-export { LOCALE_DELAY, ModularLocale };

package/dist/modularlocale.js

@@ -1,12 +1,18 @@
 "use strict";
 /**
- * @module ModularLocale
+ * @license     MIT
+ * @file        src/modularlocale.ts
+ * @author      vicentefelipechile
  * @description Generic localization phrases used throughout the application.
- * @license MIT
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModularLocale = exports.LOCALE_DELAY = void 0;
+// =================================================================================================
+// Imports
+// =================================================================================================
 const discord_js_1 = require("discord.js");
+// =================================================================================================
+// Helper Functions
+// =================================================================================================
 /**
  * Format a time unit (seconds or minutes) for localization.
  * @param unit The time unit ('s' for seconds, 'm' for minutes).
@@ -23,6 +29,9 @@ function formatUnit(unit, unitCount, unitData) {
     }
 }
 ;
+// =================================================================================================
+// ModularLocale Class
+// =================================================================================================
 /**
  * @description Class to handle localization in a modular way.
  */
@@ -111,7 +120,9 @@ class ModularLocale {
         return formattedPhrase.replace(/\s+/g, ' ').trim();
     }
 }
-exports.ModularLocale = ModularLocale;
+// =================================================================================================
+// Localization Phrases
+// =================================================================================================
 /**
  * @description Localization phrases for delay commands in ModularLocale structure.
  * @example ```js
@@ -316,6 +327,8 @@ const LOCALE_DELAY = {
         .setPhrasePlural('Bạn phải đợi {seconds} và {minutes} trước khi sử dụng lại lệnh này.')
         .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);
+// =================================================================================================
+// Export
+// =================================================================================================
 exports.default = LOCALE_DELAY;

package/dist/modularmodal.d.ts

@@ -1,7 +1,8 @@
 /**
- * @file Contains the structure and logic for creating modular modals.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/modularmodal.ts
+ * @author      vicentefelipechile
+ * @description Represents a modular modal that can be dynamically created and managed.
  */
 import { ModalBuilder, TextInputBuilder } from "discord.js";
 import { LocaleKey, ModalExecuteFunction } from "./types";

package/dist/modularmodal.js

@@ -1,10 +1,14 @@
 "use strict";
 /**
- * @file Contains the structure and logic for creating modular modals.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/modularmodal.ts
+ * @author      vicentefelipechile
+ * @description Represents a modular modal that can be dynamically created and managed.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+// =================================================================================================
+// Imports
+// =================================================================================================
 const discord_js_1 = require("discord.js");
 // =================================================================================================
 // Main Class

package/dist/modularselectmenu.d.ts

@@ -1,7 +1,8 @@
 /**
- * @file Contains the structure and logic for creating modular select menus.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/modularselectmenu.ts
+ * @author      vicentefelipechile
+ * @description Represents a modular select menu that can be dynamically created and managed.
  */
 import { StringSelectMenuBuilder, StringSelectMenuOptionBuilder } from "discord.js";
 import { LocaleKey, SelectMenuExecuteFunction } from "./types";

package/dist/modularselectmenu.js

@@ -1,11 +1,18 @@
 "use strict";
 /**
- * @file Contains the structure and logic for creating modular select menus.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/modularselectmenu.ts
+ * @author      vicentefelipechile
+ * @description Represents a modular select menu that can be dynamically created and managed.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+// =================================================================================================
+// Imports
+// =================================================================================================
 const discord_js_1 = require("discord.js");
+// =================================================================================================
+// ModularSelectMenu Class
+// =================================================================================================
 /**
  * @class ModularSelectMenu
  * @description Represents a modular select menu that can be dynamically created and managed.

package/dist/registercommand.d.ts

@@ -1,7 +1,10 @@
 /**
- * @file Contains the logic for registering modular commands and building their Discord.js data structures.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/registercommand.ts
+ * @author      vicentefelipechile
+ * @description This module provides functionality to register modular commands for a Discord bot using Discord.js.
+ *              It constructs command data objects, sets up execution contexts for various interaction types,
+ *              and handles localization, permissions, NSFW checks, and cooldowns.
  */
 import { CommandData } from "./types";
 import ModularCommand from "./modularcommand";

package/dist/registercommand.js

@@ -1,8 +1,11 @@
 "use strict";
 /**
- * @file Contains the logic for registering modular commands and building their Discord.js data structures.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/registercommand.ts
+ * @author      vicentefelipechile
+ * @description This module provides functionality to register modular commands for a Discord bot using Discord.js.
+ *              It constructs command data objects, sets up execution contexts for various interaction types,
+ *              and handles localization, permissions, NSFW checks, and cooldowns.
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -39,9 +42,149 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = RegisterCommand;
+// =================================================================================================
+// Imports
+// =================================================================================================
 const discord_js_1 = require("discord.js");
 const cooldown_1 = __importStar(require("./cooldown"));
 const locales_1 = require("./locales");
+/**
+ * @description Gets localized description for a subcommand.
+ * @param {ModularCommand} command The command instance.
+ * @param {string} subCommandName The name of the subcommand.
+ * @param {string} defaultDescription The default description.
+ * @returns {string} The localized description.
+ */
+function getLocalizedSubCommandDescription(command, subCommandName, defaultDescription) {
+    if (!command.subCommandLocalizations)
+        return defaultDescription;
+    const localizations = command.subCommandLocalizations;
+    const enLocalizations = localizations[discord_js_1.Locale.EnglishUS];
+    return enLocalizations?.[`${subCommandName}.description`] || defaultDescription;
+}
+/**
+ * @description Gets localized description for a subcommand option.
+ * @param {ModularCommand} command The command instance.
+ * @param {string} subCommandName The name of the subcommand.
+ * @param {string} optionName The name of the option.
+ * @param {string} defaultDescription The default description.
+ * @returns {string} The localized description.
+ */
+function getLocalizedOptionDescription(command, subCommandName, optionName, defaultDescription) {
+    if (!command.subCommandLocalizations)
+        return defaultDescription;
+    const localizations = command.subCommandLocalizations;
+    const enLocalizations = localizations[discord_js_1.Locale.EnglishUS];
+    return enLocalizations?.[`${subCommandName}.${optionName}.description`] || defaultDescription;
+}
+/**
+ * @description Creates an option builder function with common configuration.
+ * @param {CommandOption} opt The option configuration.
+ * @param {string} description The resolved description.
+ * @returns {Function} The option builder function.
+ */
+function createOptionBuilder(opt, description) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    return (option) => {
+        option.setName(opt.name)
+            .setDescription(description)
+            .setRequired(opt.required || false)
+            .setDescriptionLocalizations(typeof opt.description === 'object' ? opt.description : {});
+        if (opt.choices && opt.choices.length > 0) {
+            option.addChoices(...opt.choices);
+        }
+        return option;
+    };
+}
+/**
+ * @description Adds an option to a command or subcommand builder based on its type.
+ * @param {any} builder The command or subcommand builder.
+ * @param {CommandOption} opt The option to add.
+ * @param {Function} optionBuilder The option builder function.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function addOptionToBuilder(builder, opt, optionBuilder) {
+    switch (opt.type) {
+        case discord_js_1.ApplicationCommandOptionType.String:
+            builder.addStringOption(optionBuilder);
+            break;
+        case discord_js_1.ApplicationCommandOptionType.Boolean:
+            builder.addBooleanOption(optionBuilder);
+            break;
+        case discord_js_1.ApplicationCommandOptionType.Integer:
+            builder.addIntegerOption(optionBuilder);
+            break;
+        case discord_js_1.ApplicationCommandOptionType.Number:
+            builder.addNumberOption(optionBuilder);
+            break;
+        case discord_js_1.ApplicationCommandOptionType.User:
+            builder.addUserOption(optionBuilder);
+            break;
+        case discord_js_1.ApplicationCommandOptionType.Role:
+            builder.addRoleOption(optionBuilder);
+            break;
+        case discord_js_1.ApplicationCommandOptionType.Channel:
+            builder.addChannelOption(optionBuilder);
+            break;
+        default: throw new Error(`Unsupported option type: ${opt.type}`);
+    }
+}
+/**
+ * @description Processes and adds subcommands to a command builder.
+ * @param {SlashCommandBuilder} commandBuilder The command builder.
+ * @param {ModularCommand} command The command instance.
+ * @param {Record<string, OptionType>} options The options record to populate.
+ */
+function processSubCommands(commandBuilder, command, options) {
+    if (!command.subCommands || command.subCommands.length === 0)
+        return;
+    command.subCommands.forEach(subCmd => {
+        commandBuilder.addSubcommand((subcommand) => {
+            // Get localized description for subcommand
+            const subCmdDescription = getLocalizedSubCommandDescription(command, subCmd.name, subCmd.description);
+            subcommand
+                .setName(subCmd.name)
+                .setDescription(subCmdDescription);
+            // Add options to the subcommand
+            if (subCmd.options) {
+                subCmd.options.forEach(opt => {
+                    // Get base description
+                    let description = typeof opt.description === 'string'
+                        ? opt.description
+                        : (opt.description[discord_js_1.Locale.EnglishUS] || `The description for ${opt.name} in English.`);
+                    // Apply subcommand-specific localization
+                    description = getLocalizedOptionDescription(command, subCmd.name, opt.name, description);
+                    if (!description) {
+                        throw new Error(`Option '${opt.name}' in subcommand '${subCmd.name}' is missing a description.`);
+                    }
+                    options[opt.name] = opt.type;
+                    const optionBuilder = createOptionBuilder(opt, description);
+                    addOptionToBuilder(subcommand, opt, optionBuilder);
+                });
+            }
+            return subcommand;
+        });
+    });
+}
+/**
+ * @description Processes and adds regular options to a command builder.
+ * @param {SlashCommandBuilder} commandBuilder The command builder.
+ * @param {ModularCommand} command The command instance.
+ * @param {Record<string, OptionType>} options The options record to populate.
+ */
+function processRegularOptions(commandBuilder, command, options) {
+    command.options.forEach(opt => {
+        const description = typeof opt.description === 'string'
+            ? opt.description
+            : (opt.description[discord_js_1.Locale.EnglishUS] || `The description for ${opt.name} in English.`);
+        if (!description) {
+            throw new Error(`Option '${opt.name}' is missing a description.`);
+        }
+        options[opt.name] = opt.type;
+        const optionBuilder = createOptionBuilder(opt, description);
+        addOptionToBuilder(commandBuilder, opt, optionBuilder);
+    });
+}
 /**
  * @description Gets the appropriate localization object for a command based on the interaction's locale.
  * Falls back to EnglishUS if the target locale is not available.
@@ -93,6 +236,16 @@ function createChatInputExecutor(command, options) {
         (0, cooldown_1.cooldownSetUser)(command.name, interaction.user.id);
         // Argument Parsing
         const args = {};
+        // Check if this command has subcommands and get the current subcommand
+        let currentSubcommand = null;
+        if (command.subCommands && command.subCommands.length > 0) {
+            try {
+                currentSubcommand = interaction.options.getSubcommand();
+            }
+            catch {
+                throw new Error(`Subcommand not found for command ${command.name}.`);
+            }
+        }
         for (const optionName of Object.keys(options)) {
             switch (options[optionName]) {
                 case discord_js_1.ApplicationCommandOptionType.String:
@@ -110,9 +263,19 @@ function createChatInputExecutor(command, options) {
                 case discord_js_1.ApplicationCommandOptionType.User:
                     args[optionName] = interaction.options.getUser(optionName, false);
                     break;
+                case discord_js_1.ApplicationCommandOptionType.Role:
+                    args[optionName] = interaction.options.getRole(optionName, false);
+                    break;
+                case discord_js_1.ApplicationCommandOptionType.Channel:
+                    args[optionName] = interaction.options.getChannel(optionName, false);
+                    break;
                 default: throw new Error(`Unsupported option type: ${options[optionName]}`);
             }
         }
+        // Add the current subcommand to args if it exists
+        if (currentSubcommand) {
+            args['subcommand'] = currentSubcommand;
+        }
         const locale = getCommandLocale(command, interaction);
         // Execute Handler
         await command.execute({ interaction, args, command, locale });
@@ -226,44 +389,13 @@ function RegisterCommand(commands) {
             .setDescriptionLocalizations(command.descriptionLocalizations || null);
         (0, cooldown_1.cooldownRegister)(command.name, command.cooldown);
         const options = {};
-        command.options.forEach(opt => {
-            const description = typeof opt.description === 'string'
-                ? opt.description
-                : (opt.description[discord_js_1.Locale.EnglishUS] || `The description for ${opt.name} in English.`);
-            if (!description) {
-                throw new Error(`Option '${opt.name}' is missing a description.`);
-            }
-            options[opt.name] = opt.type;
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            const optionBuilder = (option) => {
-                option.setName(opt.name)
-                    .setDescription(description)
-                    .setRequired(opt.required || false)
-                    .setDescriptionLocalizations(typeof opt.description === 'object' ? opt.description : {});
-                if (opt.choices && opt.choices.length > 0) {
-                    option.addChoices(...opt.choices);
-                }
-                return option;
-            };
-            switch (opt.type) {
-                case discord_js_1.ApplicationCommandOptionType.String:
-                    commandBuilder.addStringOption(optionBuilder);
-                    break;
-                case discord_js_1.ApplicationCommandOptionType.Boolean:
-                    commandBuilder.addBooleanOption(optionBuilder);
-                    break;
-                case discord_js_1.ApplicationCommandOptionType.Integer:
-                    commandBuilder.addIntegerOption(optionBuilder);
-                    break;
-                case discord_js_1.ApplicationCommandOptionType.Number:
-                    commandBuilder.addNumberOption(optionBuilder);
-                    break;
-                case discord_js_1.ApplicationCommandOptionType.User:
-                    commandBuilder.addUserOption(optionBuilder);
-                    break;
-                default: throw new Error(`Unsupported option type: ${opt.type}`);
-            }
-        });
+        // Process subcommands or regular options
+        if (command.subCommands && command.subCommands.length > 0) {
+            processSubCommands(commandBuilder, command, options);
+        }
+        else {
+            processRegularOptions(commandBuilder, command, options);
+        }
         // Assign Handlers using Constructors
         return {
             data: commandBuilder,

package/dist/types.d.ts

@@ -1,9 +1,10 @@
 /**
- * @file Contains the type and interface definitions for the Discord bot's modular commands.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/types.ts
+ * @author      vicentefelipechile
+ * @description Defines types and interfaces used throughout the modular command framework.
  */
-import { ApplicationCommandOptionType as OptionType, APIApplicationCommandOptionChoice, ChatInputCommandInteraction, MessageComponentInteraction, ModalSubmitInteraction, StringSelectMenuInteraction, CommandInteraction, ButtonInteraction, SlashCommandBuilder, PartialDMChannel, ThreadChannel, GuildChannel, Collection, Message, Locale, Client, User } from "discord.js";
+import { ApplicationCommandOptionType as OptionType, APIApplicationCommandOptionChoice, ChatInputCommandInteraction, MessageComponentInteraction, ModalSubmitInteraction, StringSelectMenuInteraction, CommandInteraction, ButtonInteraction, SlashCommandBuilder, PartialDMChannel, ThreadChannel, GuildChannel, Collection, Message, Locale, Client, User, Role, APIRole, BaseChannel, SlashCommandBooleanOption, SlashCommandChannelOption, SlashCommandNumberOption, SlashCommandStringOption, SlashCommandUserOption, SlashCommandRoleOption, SlashCommandIntegerOption } from "discord.js";
 import ModularCommand from "./modularcommand";
 /**
  * @interface CommandOption
@@ -21,6 +22,18 @@ export interface CommandOption {
     /** An array of predefined choices the user can select from. */
     choices?: APIApplicationCommandOptionChoice[];
 }
+/**
+ * @interface SubCommand
+ * @description Defines the structure of a subcommand for a slash command.
+ */
+export interface SubCommand {
+    /** The name of the subcommand, must be unique within the command. */
+    name: string;
+    /** The description of the subcommand. */
+    description: string;
+    /** The options (arguments) that the subcommand accepts. */
+    options?: CommandOption[];
+}
 /**
  * @interface CommandData
  * @description Represents the final structure of a registered command, ready to be used by the Discord client.
@@ -45,7 +58,7 @@ export interface CommandData {
  * @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];
+export declare const ALLOWED_OPTION_TYPE: readonly [OptionType.String, OptionType.Boolean, OptionType.Integer, OptionType.Number, OptionType.User, OptionType.Role, OptionType.Channel];
 /**
  * @type AllowedOptionType
  * @description The union type of allowed option types for slash commands.
@@ -68,7 +81,12 @@ export type ClientWithCommands = Client & {
  * @type CommandArgumentValue
  * @description Represents the possible value types that a command argument can have.
  */
-export type CommandArgumentValue = string | boolean | number | User | GuildChannel | ThreadChannel | PartialDMChannel | null;
+export type CommandArgumentValue = string | boolean | number | User | GuildChannel | ThreadChannel | PartialDMChannel | Role | APIRole | BaseChannel | null;
+/**
+ * @type OptionBuilderType
+ * @description Represents the type of an option builder function.
+ */
+export type OptionBuilderType = SlashCommandStringOption | SlashCommandBooleanOption | SlashCommandIntegerOption | SlashCommandNumberOption | SlashCommandUserOption | SlashCommandRoleOption | SlashCommandChannelOption;
 /**
  * @type BaseExecuteParams
  * @description Defines the base parameters shared by all execution functions.

package/dist/types.js

@@ -1,11 +1,15 @@
 "use strict";
 /**
- * @file Contains the type and interface definitions for the Discord bot's modular commands.
- * @author vicentefelipechile
- * @license MIT
+ * @license     MIT
+ * @file        src/types.ts
+ * @author      vicentefelipechile
+ * @description Defines types and interfaces used throughout the modular command framework.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ALLOWED_OPTION_TYPE = void 0;
+// =================================================================================================
+// Imports
+// =================================================================================================
 const discord_js_1 = require("discord.js");
 // =================================================================================================
 // Generic and Utility Types
@@ -20,4 +24,6 @@ exports.ALLOWED_OPTION_TYPE = [
     discord_js_1.ApplicationCommandOptionType.Integer,
     discord_js_1.ApplicationCommandOptionType.Number,
     discord_js_1.ApplicationCommandOptionType.User,
+    discord_js_1.ApplicationCommandOptionType.Role,
+    discord_js_1.ApplicationCommandOptionType.Channel,
 ];

package/package.json

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