@spatulox/discord-interaction-manager 1.0.0

package/.env.example

@@ -0,0 +1,2 @@
+DISCORD_BOT_TOKEN=example
+DISCORD_BOT_CLIENTID=example

package/LICENSE.md

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,36 @@
+# Discord Interaction Manager
+
+A lightweight CLI tool to manage Discord bot interactions (slash commands, context menus) in under 30 seconds. Deploy, update, delete, and generate interaction files with an interactive terminal interface.
+
+✨ Features
+
+    📡 Interaction Management: List, deploy, update, delete global/guild commands & context menus
+
+    ⚙️ File Generation: Interactive JSON generators for slash commands & context menus
+
+    🔍 Guild Discovery: Auto-detect all guilds + command counts per guild
+
+    🎛️ Interactive CLI: Rich menus, input validation, command selection
+
+    📦 Only one runtime deps: Only discord.js is required in production
+    
+    🛡️ Never deprecated: Uses discord.js for all Discord requests - no breaking changes, always up-to-date with Discord API
+
+## Quick Start
+```bash
+npm install @spatulox/discord-interaction-manager
+```
+
+### Env variables :
+You can use dotenv or set them by hand
+```
+DISCORD_BOT_TOKEN="" // Discord Bot Token
+DISCORD_BOT_CLIENTID="" // The clientID of your bot
+```
+
+## Run the tool
+Simply type "dim" in your console (which stands for DiscordInteractionManager)
+```bash
+dim
+```
+You will be greet by a CLI

package/dist/Env.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Env = void 0;
+const dotenv_1 = __importDefault(require("dotenv"));
+const DiscordRegex_1 = require("./utils/DiscordRegex");
+dotenv_1.default.config();
+exports.Env = {
+    get token() {
+        const token = process.env.DISCORD_BOT_TOKEN;
+        if (!token)
+            throw new Error('Missing environment variable : DISCORD_BOT_TOKEN');
+        return token;
+    },
+    get dev() {
+        return process.env.DEV === 'true';
+    },
+    get clientId() {
+        const token = process.env.DISCORD_BOT_CLIENTID;
+        if (!token)
+            throw new Error('Missing environment variable : DISCORD_BOT_CLIENTID');
+        if (!DiscordRegex_1.DiscordRegex.BOT_ID.test(token)) {
+            throw new Error("Invalid token format");
+        }
+        return token;
+    }
+};

package/dist/cli/BaseCLI.js

@@ -0,0 +1,166 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseCLI = void 0;
+const readline_1 = __importDefault(require("readline"));
+const FileManager_1 = require("../utils/FileManager");
+/**
+ * --- BaseCLI ---
+ */
+class BaseCLI {
+    get rl() {
+        if (!BaseCLI._rl) {
+            BaseCLI._rl = readline_1.default.createInterface({
+                input: process.stdin,
+                output: process.stdout
+            });
+        }
+        return BaseCLI._rl;
+    }
+    constructor(parent) {
+        this.parent = parent;
+    }
+    getTitle() {
+        return "BaseCLI";
+    }
+    async showMainMenu() {
+        console.clear();
+        console.log(this.getTitle());
+        console.log('═'.repeat(40));
+        this.menuSelection.forEach((option, index) => {
+            console.log(`${index + 1}. ${option.label}`);
+        });
+        console.log('═'.repeat(40));
+        const choice = await this.prompt('Choose an option: ');
+        if (choice == "exit") {
+            return this.goBack();
+        }
+        const choiceIndex = parseInt(choice) - 1;
+        if (choiceIndex >= 0 && choiceIndex < this.menuSelection.length) {
+            const option = this.menuSelection[choiceIndex];
+            if (!option) {
+                console.log("Invalid Choice");
+                return this.showMainMenu();
+            }
+            const result = await option.action();
+            if (result instanceof BaseCLI) {
+                if (result == this) {
+                    await this.execute();
+                }
+                else {
+                    return await result.showMainMenu();
+                }
+            }
+        }
+        await this.prompt('Press Enter to continue...');
+        return this.showMainMenu();
+    }
+    async prompt(question) {
+        return new Promise(resolve => this.rl.question(question, resolve));
+    }
+    async requireInput(message, validator, canBeEmpty = false) {
+        while (true) {
+            const value = (await this.prompt(message));
+            if (!value && !canBeEmpty) {
+                console.log("⚠️  This field is required. Please enter a value.");
+                continue;
+            }
+            if (validator && !validator(value)) {
+                console.log("⚠️  Invalid input. Try again.");
+                continue;
+            }
+            return value;
+        }
+    }
+    async yesNoInput(message) {
+        while (true) {
+            const value = (await this.prompt(message));
+            if (!value) {
+                console.log("⚠️  This field is required. Please enter a value.");
+                continue;
+            }
+            if (!["y", "n", "yes", "no"].includes(value.toLowerCase())) {
+                console.log("⚠️  Invalid input. Try again.");
+                continue;
+            }
+            return value == "y" || value == "yes";
+        }
+    }
+    async showHelp() {
+        console.clear();
+        console.log('');
+        console.log('||| HELP - Discord Bot Command Manager CLI |||');
+        console.log('');
+        console.log('🔗 Wiki: https://github.com/Spatulox/SimpleDiscordBot/wiki');
+        console.log('═'.repeat(80));
+        console.log('🤖 What it does:');
+        console.log('  • Manage your Discord interactions (slash commands & context menus) via an interactive CLI');
+        console.log('  • Let you deploy/update/delete any interaction');
+        console.log('  • Let you generate an interaction files');
+        console.log('');
+        console.log('How you need to save your interaction files');
+        console.log('📁 Folder Structure:');
+        console.log('  ├── handlers/         ← In the root folder of your project');
+        console.log('  │   ├── commands/     ← Slash Commands (type 1)');
+        console.log('  │   └── context_menu/ ← Context Menus (type 2/3)');
+        console.log('');
+        console.log('🎯 Features:');
+        console.log('  📊 1. List Remote    → Show deployed commands on Discord');
+        console.log('  🚀 2. Deploy Local   → Deploy local JSON files → Discord');
+        console.log('  🔄 3. Update Remote  → Update Discord commands based on local JSON file');
+        console.log('  🗑️ 4. Delete Remote → Remove Discord commands based on local JSON file');
+        console.log('');
+        console.log('🎮 Selection:');
+        console.log('  • Numbered lists appear after the interaction list');
+        console.log('  • Enter: "1,3,5" or "all" to select which interaction you want to apply the action');
+        console.log('');
+        console.log('🔗 Wiki: https://github.com/Spatulox/SimpleDiscordBot/wiki');
+        console.log('🔗 Bugs: https://github.com/Spatulox/SimpleDiscordBot/issues');
+        console.log('═'.repeat(80));
+        await this.prompt('Press Enter to continue...');
+        if (this.parent) {
+            await this.parent.showMainMenu();
+        }
+        else {
+            await this.showMainMenu();
+        }
+    }
+    async goBack() {
+        if (this.parent) {
+            return this.parent?.showMainMenu();
+        }
+        return this.execute(); // Fallback for MainCLI
+    }
+    async saveFile(folderName, filename, data) {
+        let finalFilename = filename;
+        if (await FileManager_1.FileManager.readJsonFile(`./handlers/${folderName}/${filename}`)) {
+            if (!await this.yesNoInput(`"${finalFilename}" already exists. Overwrite? (y/n): `)) {
+                const timestamp = Date.now();
+                finalFilename = `${filename.replace('.json', '')}-${timestamp}`;
+                console.log(`📝 New filename: ${finalFilename}`);
+            }
+        }
+        // 2. Preview + Confirmation
+        console.clear();
+        console.log("✨ Final JSON preview:");
+        console.log(JSON.stringify(data, null, 2));
+        if (!await this.yesNoInput("\nSave this file? (y/n): ")) {
+            console.log("Cancelled");
+            await this.prompt('Press Enter to continue...');
+            return this.showMainMenu();
+        }
+        try {
+            await FileManager_1.FileManager.writeJsonFile(`./handlers/${folderName}`, finalFilename, data);
+            console.log(`File saved: ./handlers/${folderName}/${finalFilename}`);
+        }
+        catch (error) {
+            console.error("Error saving file:", error);
+        }
+        return;
+    }
+}
+exports.BaseCLI = BaseCLI;
+BaseCLI._rl = null;

package/dist/cli/GenerationCLI/ContextMenuGeneratorCLI.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContextMenuGeneratorCLI = void 0;
+const BaseCLI_1 = require("../BaseCLI");
+const discord_js_1 = require("discord.js");
+const DiscordRegex_1 = require("../../utils/DiscordRegex");
+const FolderName_1 = require("../../type/FolderName");
+class ContextMenuGeneratorCLI extends BaseCLI_1.BaseCLI {
+    constructor() {
+        super(...arguments);
+        this.menuSelection = [
+            { label: "Generate Context Menu", action: () => this },
+            { label: "Back", action: () => this.goBack() },
+        ];
+    }
+    getTitle() {
+        return "📝 Context Menu JSON Generator";
+    }
+    async execute() {
+        const config = { dm_permission: false, integration_types: [], name: "", type: 2 };
+        // 1. Context Menu Name
+        console.clear();
+        console.log("👤 1/10 - Name");
+        config.name = await this.requireInput("Enter Context Menu name (ex: 'Example context Menu'): ");
+        // 2. Type (2=User, 3=Message)
+        console.clear();
+        console.log("🔧 2/10 - Type");
+        console.log("2 => Context Menu for users");
+        console.log("3 => Context Menu for messages");
+        config.type = parseInt(await this.requireInput("Enter type (2 or 3): ", val => ["2", "3"].includes(val)));
+        // 3. Member Permissions
+        console.clear();
+        console.log("🔐 3/10 - Permissions");
+        console.log("📋 Valid permissions:\n", Object.keys(discord_js_1.PermissionFlagsBits).join(', '));
+        const permsInput = await this.requireInput("Default member permissions (comma separated, or 'none'): ", (val) => {
+            if (!val || val.toLowerCase() === "none" || val == '')
+                return true;
+            const permissions = val.split(",").map(p => p.trim());
+            const invalidPerms = permissions.filter(perm => !(perm in discord_js_1.PermissionFlagsBits));
+            if (invalidPerms.length > 0) {
+                console.log(`❌ Invalid permissions: ${invalidPerms.join(', ')}`);
+                console.log("📋 Valid permissions:\n", Object.keys(discord_js_1.PermissionFlagsBits).join(', '));
+                return false;
+            }
+            return true;
+        }, true);
+        if (permsInput !== '' && permsInput.toLowerCase() !== "none") {
+            config.default_member_permissions = permsInput.split(",")
+                .map(p => p.trim());
+        }
+        // 4. DM Permission
+        console.clear();
+        console.log("💬 4/10 - DM Permission");
+        config.dm_permission = (await this.yesNoInput("Allow in DMs? (y/n): "));
+        // 5. Integration Types
+        console.clear();
+        console.log("🔗 5/10 - Integration Types");
+        console.log("0 => GUILD_INSTALL");
+        console.log("1 => USER_INSTALL");
+        console.log("(comma separated, or 'all')");
+        const intInput = await this.requireInput("Integration types: ");
+        if (intInput.toLowerCase() === "all") {
+            config.integration_types = [0, 1];
+        }
+        else {
+            config.integration_types = intInput.split(",").map(i => parseInt(i.trim())).filter(i => !isNaN(i));
+        }
+        console.clear();
+        console.log("🌐 6/10 - Contexts");
+        console.log("0 => Can be used inside server");
+        console.log("1 => Can be used inside DMs with bot");
+        console.log("2 => Group DMs & other DMs");
+        console.log("(comma separated, or 'all')");
+        const ctxInput = await this.requireInput("Contexts: ");
+        if (ctxInput.toLowerCase() === "all") {
+            config.contexts = [0, 1, 2];
+        }
+        else {
+            config.contexts = ctxInput.split(",").map(i => parseInt(i.trim())).filter(i => !isNaN(i));
+        }
+        // 7. Guild IDs
+        console.clear();
+        console.log("🏠 7/10 - Guild IDs (optional)");
+        console.log(" => Used to deploy specific context menu for specific guild");
+        const guildInput = await this.requireInput("Guild IDs (comma separated, or 'none'): ", (val) => {
+            if (!val || val.toLowerCase() === "none")
+                return true;
+            const ids = val.split(",").map(id => id.trim());
+            const invalidIds = ids.filter(id => !DiscordRegex_1.DiscordRegex.GUILD_ID.test(id));
+            if (invalidIds.length > 0) {
+                console.log(`❌ Invalid Guild IDs: ${invalidIds.join(', ')}`);
+                console.log("ℹ️  Discord Guild ID = 18 chiffres (ex: 1111160769132896377)");
+                return false;
+            }
+            console.log("✅ Valid Guild IDs:", ids.join(', '));
+            return true;
+        }, true);
+        if (guildInput.toLowerCase() !== "none" && guildInput !== "") {
+            config.guildID = guildInput.split(",").map(id => id.trim());
+        }
+        // 8. Filename
+        console.clear();
+        console.log("💾 8/10 - File");
+        const filename = (await this.requireInput("Filename (ex: my-context-menu): ")) + ".json";
+        await this.saveFile(FolderName_1.FolderName.CONTEXT_MENU, filename, config);
+        return this.showMainMenu();
+    }
+}
+exports.ContextMenuGeneratorCLI = ContextMenuGeneratorCLI;

package/dist/cli/GenerationCLI/GenerationCLI.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerationCLI = void 0;
+const BaseCLI_1 = require("../BaseCLI");
+const ContextMenuGeneratorCLI_1 = require("./ContextMenuGeneratorCLI");
+const ModalGeneratorCLI_1 = require("./ModalGeneratorCLI");
+const SlashCommandsGeneratorCLI_1 = require("./SlashCommandsGeneratorCLI");
+class GenerationCLI extends BaseCLI_1.BaseCLI {
+    constructor() {
+        super(...arguments);
+        this.menuSelection = [
+            { label: 'Generate Slash Command Template', action: () => new SlashCommandsGeneratorCLI_1.SlashCommandGeneratorCLI(this) },
+            { label: 'Generate Context Menu Template', action: () => new ContextMenuGeneratorCLI_1.ContextMenuGeneratorCLI(this) },
+            { label: 'Generate Modal Template', action: () => new ModalGeneratorCLI_1.ModalGeneratorCLI(this) },
+            { label: 'Back', action: () => this.goBack() },
+        ];
+    }
+    getTitle() {
+        return '⚙️  Generation Manager CLI';
+    }
+    async execute() {
+        throw new Error("Method not implemented.");
+    }
+}
+exports.GenerationCLI = GenerationCLI;