commandkit 0.0.9 → 0.1.0

package/CHANGELOG.md

@@ -1,52 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](http://keepachangelog.com/)
-
-## [0.0.9] - 2023-08-09
-
-### Added
-
--   Support for developer role IDs
--   Ability to skip built-in validations by setting `skipBuiltInValidations` to true inside the `CommandKit` constructor
-
-### Changed
-
--   Change validations to run custom user validations first, then CommandKit's built-in validations.
-
-## [0.0.8] - 2023-07-03
-
-### Added
-
--   Support for nested files inside of each event folder.
-
-## [0.0.7] - 2023-07-02
-
-### Changed
-
--   Give validation functions access to the full command object (commandObj) excluding the run function (as that is handled by the command handler), as opposed to just the `data` and `options` properties.
-
-## [0.0.6] - 2023-07-02
-
-### Fixed
-
--   Fixed a bug where wrong event names were being registered on Windows.
-
-## [0.0.5] - 2023-07-02
-
-### Added
-
--   Ability to automatically update application commands (guilds and global) when there's changes to the description or number of options (slash commands only).
-
-## [0.0.4] - 2023-07-01
-
-### Updated
-
--   Update package.json with new URLs, scripts, and version
-
-## [0.0.3] - 2023-07-01
-
-## [0.0.2] - 2023-07-01
-
-## [0.0.1] - N/A

package/dist/CommandKit.d.ts

@@ -1,36 +0,0 @@
-import { CommandKitOptions } from '../typings';
-export declare class CommandKit {
-    private _data;
-    constructor({ ...options }: CommandKitOptions);
-    private _init;
-    get commands(): ({
-        data: import("@discordjs/builders").SlashCommandBuilder | {
-            name: string;
-            name_localizations?: any;
-            description: string;
-            dm_permission?: boolean | undefined;
-            options?: import("discord.js").APIApplicationCommandOption[] | undefined;
-        };
-        options?: {
-            guildOnly?: boolean | undefined;
-            devOnly?: boolean | undefined;
-            deleted?: boolean | undefined;
-            userPermissions?: import("discord.js").PermissionResolvable[] | undefined;
-            botPermissions?: import("discord.js").PermissionResolvable[] | undefined;
-        } | undefined;
-    } | {
-        data: import("@discordjs/builders").ContextMenuCommandBuilder | {
-            name: string;
-            name_localizations?: any;
-            type: import("@discordjs/builders").ContextMenuCommandType;
-            dm_permission?: boolean | undefined;
-        };
-        options?: {
-            guildOnly?: boolean | undefined;
-            devOnly?: boolean | undefined;
-            deleted?: boolean | undefined;
-            userPermissions?: import("discord.js").PermissionResolvable[] | undefined;
-            botPermissions?: import("discord.js").PermissionResolvable[] | undefined;
-        } | undefined;
-    })[];
-}

package/dist/CommandKit.js

@@ -1,57 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommandKit = void 0;
-const handlers_1 = require("./handlers");
-class CommandKit {
-    _data;
-    constructor({ ...options }) {
-        if (!options.client) {
-            throw new Error('"client" is required when instantiating CommandKit.');
-        }
-        if (options.validationsPath && !options.commandsPath) {
-            throw new Error('"commandsPath" is required when "validationsPath" is set.');
-        }
-        this._data = {
-            ...options,
-            commands: [],
-        };
-        this._init();
-    }
-    _init() {
-        // Event handler
-        if (this._data.eventsPath) {
-            new handlers_1.EventHandler({
-                client: this._data.client,
-                eventsPath: this._data.eventsPath,
-            });
-        }
-        // Validation handler
-        let validationFunctions = [];
-        if (this._data.validationsPath) {
-            const validationHandler = new handlers_1.ValidationHandler({
-                validationsPath: this._data.validationsPath,
-            });
-            validationHandler.getValidations().forEach((v) => validationFunctions.push(v));
-        }
-        // Command handler
-        if (this._data.commandsPath) {
-            const commandHandler = new handlers_1.CommandHandler({
-                client: this._data.client,
-                commandsPath: this._data.commandsPath,
-                devGuildIds: this._data.devGuildIds || [],
-                devUserIds: this._data.devUserIds || [],
-                devRoleIds: this._data.devRoleIds || [],
-                customValidations: validationFunctions,
-                skipBuiltInValidations: this._data.skipBuiltInValidations || false,
-            });
-            this._data.commands = commandHandler.getCommands();
-        }
-    }
-    get commands() {
-        return this._data.commands.map((cmd) => {
-            const { run, ...command } = cmd;
-            return command;
-        });
-    }
-}
-exports.CommandKit = CommandKit;

package/dist/handlers/command-handler/CommandHandler.d.ts

@@ -1,12 +0,0 @@
-import { CommandHandlerData, CommandHandlerOptions } from './typings';
-import { ContextCommandObject, SlashCommandObject } from '../../../typings';
-export declare class CommandHandler {
-    _data: CommandHandlerData;
-    constructor({ ...options }: CommandHandlerOptions);
-    _init(): void;
-    _buildCommands(): void;
-    _buildValidations(): void;
-    _registerCommands(): void;
-    _handleCommands(): void;
-    getCommands(): (SlashCommandObject | ContextCommandObject)[];
-}

package/dist/handlers/command-handler/CommandHandler.js

@@ -1,62 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommandHandler = void 0;
-const get_paths_1 = require("../../utils/get-paths");
-const registerCommands_1 = __importDefault(require("./functions/registerCommands"));
-const handleCommands_1 = __importDefault(require("./functions/handleCommands"));
-const path_1 = __importDefault(require("path"));
-class CommandHandler {
-    _data;
-    constructor({ ...options }) {
-        this._data = {
-            ...options,
-            builtInValidations: [],
-            commands: [],
-        };
-        this._init();
-    }
-    _init() {
-        this._buildCommands();
-        this._buildValidations();
-        this._registerCommands();
-        this._handleCommands();
-    }
-    _buildCommands() {
-        const commandFilePaths = (0, get_paths_1.getFilePaths)(this._data.commandsPath, true).filter((path) => path.endsWith('.js') || path.endsWith('.ts'));
-        for (const commandFilePath of commandFilePaths) {
-            const commandObj = require(commandFilePath);
-            if (!commandObj.data) {
-                console.log(`⏩ Ignoring: Command ${commandFilePath} does not export "data".`);
-                continue;
-            }
-            if (!commandObj.run) {
-                console.log(`⏩ Ignoring: Command ${commandFilePath} does not export "run".`);
-                continue;
-            }
-            this._data.commands.push(commandObj);
-        }
-    }
-    _buildValidations() {
-        const validationFilePaths = (0, get_paths_1.getFilePaths)(path_1.default.join(__dirname, 'validations'), true).filter((path) => path.endsWith('.js'));
-        for (const validationFilePath of validationFilePaths) {
-            const validationFunction = require(validationFilePath);
-            if (typeof validationFunction !== 'function') {
-                continue;
-            }
-            this._data.builtInValidations.push(validationFunction);
-        }
-    }
-    _registerCommands() {
-        (0, registerCommands_1.default)(this);
-    }
-    _handleCommands() {
-        (0, handleCommands_1.default)(this);
-    }
-    getCommands() {
-        return this._data.commands;
-    }
-}
-exports.CommandHandler = CommandHandler;

package/dist/handlers/command-handler/functions/handleCommands.d.ts

@@ -1,2 +0,0 @@
-import { CommandHandler } from '../CommandHandler';
-export default function handleCommands(commandHandler: CommandHandler): void;

package/dist/handlers/command-handler/functions/handleCommands.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function handleCommands(commandHandler) {
-    const client = commandHandler._data.client;
-    client.on('interactionCreate', async (interaction) => {
-        if (!interaction.isChatInputCommand() && !interaction.isContextMenuCommand())
-            return;
-        const targetCommand = commandHandler._data.commands.find((cmd) => cmd.data.name === interaction.commandName);
-        if (!targetCommand)
-            return;
-        const { data, options, run, ...rest } = targetCommand;
-        const commandObj = {
-            data: targetCommand.data,
-            options: targetCommand.options,
-            ...rest,
-        };
-        let canRun = true;
-        for (const validationFunction of commandHandler._data.customValidations) {
-            const stopValidationLoop = await validationFunction({
-                interaction,
-                client,
-                commandObj,
-            });
-            if (stopValidationLoop) {
-                canRun = false;
-                break;
-            }
-        }
-        if (!canRun)
-            return;
-        // If custom validations pass and !skipBuiltInValidations, run built-in CommandKit validation functions
-        if (!commandHandler._data.skipBuiltInValidations) {
-            for (const validation of commandHandler._data.builtInValidations) {
-                const stopValidationLoop = validation({
-                    targetCommand,
-                    interaction,
-                    handlerData: commandHandler._data,
-                });
-                if (stopValidationLoop) {
-                    canRun = false;
-                    break;
-                }
-            }
-        }
-        if (!canRun)
-            return;
-        targetCommand.run({ interaction, client });
-    });
-}
-exports.default = handleCommands;

package/dist/handlers/command-handler/functions/registerCommands.d.ts

@@ -1,2 +0,0 @@
-import { CommandHandler } from '../CommandHandler';
-export default function registerCommands(commandHandler: CommandHandler): void;

package/dist/handlers/command-handler/functions/registerCommands.js

@@ -1,135 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const areSlashCommandsDifferent_1 = __importDefault(require("../utils/areSlashCommandsDifferent"));
-function registerCommands(commandHandler) {
-    const client = commandHandler._data.client;
-    const devGuildIds = commandHandler._data.devGuildIds;
-    const commands = commandHandler._data.commands;
-    client.once('ready', async () => {
-        const devGuilds = [];
-        for (const devGuildId of devGuildIds) {
-            const guild = client.guilds.cache.get(devGuildId);
-            if (!guild) {
-                console.log(`⏩ Ignoring: Guild ${devGuildId} does not exist or client isn't in this guild.`);
-                continue;
-            }
-            devGuilds.push(guild);
-        }
-        const appCommands = client.application?.commands;
-        await appCommands?.fetch();
-        const devGuildCommands = [];
-        for (const guild of devGuilds) {
-            const guildCommands = guild.commands;
-            await guildCommands?.fetch();
-            devGuildCommands.push(guildCommands);
-        }
-        for (const command of commands) {
-            // <!-- Delete command if options.deleted -->
-            if (command.options?.deleted) {
-                const targetCommand = appCommands?.cache.find((cmd) => cmd.name === command.data.name);
-                if (!targetCommand) {
-                    console.log(`⏩ Ignoring: Command "${command.data.name}" is globally marked as deleted.`);
-                }
-                else {
-                    targetCommand.delete().then(() => {
-                        console.log(`🚮 Deleted command "${command.data.name}" globally.`);
-                    });
-                }
-                for (const guildCommands of devGuildCommands) {
-                    const targetCommand = guildCommands.cache.find((cmd) => cmd.name === command.data.name);
-                    if (!targetCommand) {
-                        console.log(`⏩ Ignoring: Command "${command.data.name}" is marked as deleted for ${guildCommands.guild.name}.`);
-                    }
-                    else {
-                        targetCommand.delete().then(() => {
-                            console.log(`🚮 Deleted command "${command.data.name}" in ${guildCommands.guild.name}.`);
-                        });
-                    }
-                }
-                continue;
-            }
-            // <!-- Edit command -->
-            let commandData = command.data;
-            let editedCommand = false;
-            // Edit command globally
-            const appGlobalCommand = appCommands?.cache.find((cmd) => cmd.name === command.data.name);
-            if (appGlobalCommand) {
-                const commandsAreDifferent = (0, areSlashCommandsDifferent_1.default)(appGlobalCommand, commandData);
-                if (commandsAreDifferent) {
-                    appGlobalCommand
-                        .edit(commandData)
-                        .then(() => {
-                        console.log(`✅ Edited command "${commandData.name}" globally.`);
-                    })
-                        .catch((error) => {
-                        console.log(`❌ Failed to edit command "${commandData.name}" globally.`);
-                        console.error(error);
-                    });
-                    editedCommand = true;
-                }
-            }
-            // Edit command in a specific guild
-            for (const guildCommands of devGuildCommands) {
-                const appGuildCommand = guildCommands.cache.find((cmd) => cmd.name === commandData.name);
-                if (appGuildCommand) {
-                    const commandsAreDifferent = (0, areSlashCommandsDifferent_1.default)(appGuildCommand, commandData);
-                    if (commandsAreDifferent) {
-                        appGuildCommand
-                            .edit(commandData)
-                            .then(() => {
-                            console.log(`✅ Edited command "${commandData.name}" in ${guildCommands.guild.name}.`);
-                        })
-                            .catch((error) => {
-                            console.log(`❌ Failed to edit command "${commandData.name}" in ${guildCommands.guild.name}.`);
-                            console.error(error);
-                        });
-                        editedCommand = true;
-                    }
-                }
-            }
-            if (editedCommand)
-                continue;
-            // <!-- Register command -->
-            // Register command in a specific guild
-            if (command.options?.devOnly) {
-                if (!devGuilds.length) {
-                    console.log(`⏩ Ignoring: Cannot register command "${command.data.name}" as no valid "devGuildIds" were provided.`);
-                    continue;
-                }
-                for (const guild of devGuilds) {
-                    const cmdExists = guild.commands.cache.some((cmd) => cmd.name === command.data.name);
-                    if (cmdExists)
-                        continue;
-                    guild?.commands
-                        .create(command.data)
-                        .then(() => {
-                        console.log(`✅ Registered command "${command.data.name}" in ${guild.name}.`);
-                    })
-                        .catch((error) => {
-                        console.log(`❌ Failed to register command "${command.data.name}" in ${guild.name}.`);
-                        console.error(error);
-                    });
-                }
-            }
-            // Register command globally
-            else {
-                const cmdExists = appCommands?.cache.some((cmd) => cmd.name === command.data.name);
-                if (cmdExists)
-                    continue;
-                appCommands
-                    ?.create(command.data)
-                    .then(() => {
-                    console.log(`✅ Registered command "${command.data.name}" globally.`);
-                })
-                    .catch((error) => {
-                    console.log(`❌ Failed to register command "${command.data.name}" globally.`);
-                    console.error(error);
-                });
-            }
-        }
-    });
-}
-exports.default = registerCommands;

package/dist/handlers/command-handler/utils/areSlashCommandsDifferent.d.ts

@@ -1 +0,0 @@
-export default function areSlashCommandsDifferent(appCommand: any, localCommand: any): true | undefined;

package/dist/handlers/command-handler/utils/areSlashCommandsDifferent.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function areSlashCommandsDifferent(appCommand, localCommand) {
-    if (!appCommand.options)
-        appCommand.options = [];
-    if (!localCommand.options)
-        localCommand.options = [];
-    if (!appCommand.description)
-        appCommand.description = '';
-    if (!localCommand.description)
-        localCommand.description = '';
-    if (localCommand.description !== appCommand.description ||
-        localCommand.options.length !== appCommand.options.length) {
-        return true;
-    }
-}
-exports.default = areSlashCommandsDifferent;

package/dist/handlers/command-handler/validations/botPermissions.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/handlers/command-handler/validations/botPermissions.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-module.exports = ({ interaction, targetCommand }) => {
-    const botMember = interaction.guild?.members.me;
-    if (targetCommand.options?.botPermissions && botMember) {
-        for (const permission of targetCommand.options.botPermissions) {
-            const hasPermission = botMember.permissions.has(permission);
-            if (!hasPermission) {
-                interaction.reply({
-                    content: `❌ I do not have enough permission to execute this command. Required permission: \`${permission}\``,
-                    ephemeral: true,
-                });
-                return true;
-            }
-        }
-    }
-};

package/dist/handlers/command-handler/validations/devOnly.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/handlers/command-handler/validations/devOnly.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-module.exports = ({ interaction, targetCommand, handlerData }) => {
-    if (targetCommand.options?.devOnly) {
-        if (interaction.inGuild() && !handlerData.devGuildIds.includes(interaction.guildId)) {
-            interaction.reply({
-                content: '❌ This command can only be used inside development servers.',
-                ephemeral: true,
-            });
-            return true;
-        }
-        const guildMember = interaction.guild?.members.cache.get(interaction.user.id);
-        const memberRoles = guildMember?.roles.cache;
-        let hasDevRole = false;
-        memberRoles?.forEach((role) => {
-            if (handlerData.devRoleIds?.includes(role.id)) {
-                hasDevRole = true;
-            }
-        });
-        const isDevUser = handlerData.devUserIds.includes(interaction.user.id) || hasDevRole;
-        if (!isDevUser) {
-            interaction.reply({
-                content: '❌ This command can only be used by developers.',
-                ephemeral: true,
-            });
-            return true;
-        }
-    }
-};

package/dist/handlers/command-handler/validations/guildOnly.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/handlers/command-handler/validations/guildOnly.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-module.exports = ({ interaction, targetCommand }) => {
-    if (targetCommand.options?.guildOnly && !interaction.inGuild()) {
-        interaction.reply({
-            content: '❌ This command can only be used inside a server.',
-            ephemeral: true,
-        });
-        return true;
-    }
-};

package/dist/handlers/command-handler/validations/userPermissions.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/handlers/command-handler/validations/userPermissions.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-module.exports = ({ interaction, targetCommand }) => {
-    const memberPermissions = interaction.memberPermissions;
-    if (targetCommand.options?.userPermissions && memberPermissions) {
-        for (const permission of targetCommand.options.userPermissions) {
-            const hasPermission = memberPermissions.has(permission);
-            if (!hasPermission) {
-                interaction.reply({
-                    content: `❌ You do not have enough permission to run this command. Required permission: \`${permission}\``,
-                    ephemeral: true,
-                });
-                return true;
-            }
-        }
-    }
-};

package/dist/handlers/event-handler/EventHandler.d.ts

@@ -1,11 +0,0 @@
-import { EventHandlerOptions, EventHandlerData } from './typings';
-export declare class EventHandler {
-    _data: EventHandlerData;
-    constructor({ ...options }: EventHandlerOptions);
-    _buildEvents(): void;
-    _registerEvents(): void;
-    getEvents(): {
-        name: string;
-        functions: Function[];
-    }[];
-}

package/dist/handlers/event-handler/EventHandler.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventHandler = void 0;
-const get_paths_1 = require("../../utils/get-paths");
-class EventHandler {
-    _data;
-    constructor({ ...options }) {
-        this._data = {
-            ...options,
-            events: [],
-        };
-        this._buildEvents();
-        this._registerEvents();
-    }
-    _buildEvents() {
-        const eventFolderPaths = (0, get_paths_1.getFolderPaths)(this._data.eventsPath);
-        for (const eventFolderPath of eventFolderPaths) {
-            const eventName = eventFolderPath.replace(/\\/g, '/').split('/').pop();
-            const eventFilePaths = (0, get_paths_1.getFilePaths)(eventFolderPath, true).filter((path) => path.endsWith('.js') || path.endsWith('.ts'));
-            const eventObj = {
-                name: eventName,
-                functions: [],
-            };
-            this._data.events.push(eventObj);
-            for (const eventFilePath of eventFilePaths) {
-                const eventFunction = require(eventFilePath);
-                if (typeof eventFunction !== 'function') {
-                    console.log(`Ignoring: Event ${eventFilePath} does not export a function.`);
-                    continue;
-                }
-                eventObj.functions.push(eventFunction);
-            }
-        }
-    }
-    _registerEvents() {
-        const client = this._data.client;
-        for (const eventObj of this._data.events) {
-            client.on(eventObj.name, async (...params) => {
-                for (const eventFunction of eventObj.functions) {
-                    const stopEventLoop = await eventFunction(...params, client);
-                    if (stopEventLoop) {
-                        break;
-                    }
-                }
-            });
-        }
-    }
-    getEvents() {
-        return this._data.events;
-    }
-}
-exports.EventHandler = EventHandler;

package/dist/handlers/index.d.ts

@@ -1,3 +0,0 @@
-export * from './command-handler/CommandHandler';
-export * from './event-handler/EventHandler';
-export * from './validation-handler/ValidationHandler';

package/dist/handlers/index.js

@@ -1,19 +0,0 @@
-"use strict";
-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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./command-handler/CommandHandler"), exports);
-__exportStar(require("./event-handler/EventHandler"), exports);
-__exportStar(require("./validation-handler/ValidationHandler"), exports);

package/dist/handlers/validation-handler/ValidationHandler.d.ts

@@ -1,7 +0,0 @@
-import { ValidationHandlerData, ValidationHandlerOptions } from './typings';
-export declare class ValidationHandler {
-    _data: ValidationHandlerData;
-    constructor({ ...options }: ValidationHandlerOptions);
-    _buildValidations(): void;
-    getValidations(): Function[];
-}

package/dist/handlers/validation-handler/ValidationHandler.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ValidationHandler = void 0;
-const get_paths_1 = require("../../utils/get-paths");
-class ValidationHandler {
-    _data;
-    constructor({ ...options }) {
-        this._data = {
-            ...options,
-            validations: [],
-        };
-        this._buildValidations();
-    }
-    _buildValidations() {
-        const validationFilePaths = (0, get_paths_1.getFilePaths)(this._data.validationsPath, true).filter((path) => path.endsWith('.js') || path.endsWith('.ts'));
-        for (const validationFilePath of validationFilePaths) {
-            const validationFunction = require(validationFilePath);
-            if (typeof validationFunction !== 'function') {
-                console.log(`Ignoring: Validation ${validationFilePath} does not export a function.`);
-                continue;
-            }
-            this._data.validations.push(validationFunction);
-        }
-    }
-    getValidations() {
-        return this._data.validations;
-    }
-}
-exports.ValidationHandler = ValidationHandler;

package/dist/utils/get-paths.d.ts

@@ -1,3 +0,0 @@
-declare function getFilePaths(directory: string, nesting?: boolean): string[];
-declare function getFolderPaths(directory: string, nesting?: boolean): string[];
-export { getFilePaths, getFolderPaths };