reciple 1.1.4 → 1.2.0

package/CHANGELOG.md

@@ -0,0 +1,28 @@
+#### 1.2.0 (2022-05-21)
+
+##### New Features
+
+* **permissions:**  you can now set required permissions for interaction command (3a80154f)
+
+##### Refactors
+
+* **permissions:**  some changes to message command required permissions (22a01ae3)
+
+#### 1.2.0 (2022-05-21)
+
+##### New Features
+
+* **permissions:**  you can now set required permissions for interaction command (3a80154f)
+
+##### Refactors
+
+* **permissions:**  some changes to message command required permissions (22a01ae3)
+
+#### 1.1.6 (2022-05-21)
+
+##### Bug Fixes
+
+* **interactionCommands:**  Interaction commands error (55a29d74)
+
+#### 1.1.5 (2022-05-21)
+

package/bin/bin.js

@@ -15,7 +15,7 @@ const Client_1 = require("./reciple/classes/Client");
 const fs_1 = require("fs");
 const fallout_utility_1 = require("fallout-utility");
 require("dotenv/config");
-const allowedFiles = ['node_modules', 'reciple.yml', 'package.json', 'package.lock.json'];
+const allowedFiles = ['node_modules', 'reciple.yml', 'package.json', 'package.lock.json', 'modules.yml', '.rmmcache'];
 if ((0, fs_1.readdirSync)('./').filter(f => !f.startsWith('.') && allowedFiles.indexOf(f)).length > 0 && !(0, fs_1.existsSync)('./reciple.yml')) {
     const ask = (0, fallout_utility_1.input)('This directory does not contain reciple.yml. Would you like to init axis here? [y/n] ');
     if (ask !== 'y')

package/bin/reciple/classes/Client.js

@@ -1,4 +1,10 @@
 "use strict";
+// Dear precious programmer,
+// If you're trying to understand this code, please, consider that
+// at the time of writing this code, It was written the way humans
+// can understand it but I transformed into a dog at Apr 12th 2022
+// and accidentally made it unreadable for humans. So, if you're
+// trying to understand this code, please, consider being a dog first.
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -82,29 +88,29 @@ class RecipleClient extends discord_js_1.Client {
             if (!message.content || !((_a = this.config) === null || _a === void 0 ? void 0 : _a.commands.messageCommand.enabled))
                 return this;
             const parseCommand = (0, fallout_utility_1.getCommand)(message.content, ((_b = this.config) === null || _b === void 0 ? void 0 : _b.prefix) || '!', ((_c = this.config) === null || _c === void 0 ? void 0 : _c.commands.messageCommand.commandArgumentSeparator) || ' ');
-            if (parseCommand && parseCommand.command) {
-                const command = this.commands.MESSAGE_COMMANDS[parseCommand.command];
-                if (!command)
+            if (!(parseCommand === null || parseCommand === void 0 ? void 0 : parseCommand.command) || !parseCommand)
+                return this;
+            const command = this.commands.MESSAGE_COMMANDS[parseCommand.command];
+            if (!command)
+                return this;
+            if ((0, commandPermissions_1.commandPermissions)(command.name, (_d = message.member) === null || _d === void 0 ? void 0 : _d.permissions, (_e = this.config) === null || _e === void 0 ? void 0 : _e.permissions.messageCommands, command)) {
+                if (!command.allowExecuteInDM && message.channel.type === 'DM' || !command.allowExecuteByBots && (message.author.bot || message.author.system) || (0, isIgnoredChannel_1.isIgnoredChannel)(message.channelId, (_f = this.config) === null || _f === void 0 ? void 0 : _f.ignoredChannels))
+                    return this;
+                if (command.validateOptions && !command.getCommandOptionValues(parseCommand)) {
+                    yield message.reply(((_g = this.config) === null || _g === void 0 ? void 0 : _g.messages.notEnoughArguments) || 'Not enough arguments.').catch((err) => this.logger.error(err));
                     return this;
-                if ((0, commandPermissions_1.commandPermissions)(command.name, (_d = message.member) === null || _d === void 0 ? void 0 : _d.permissions, (_e = this.config) === null || _e === void 0 ? void 0 : _e.permissions.messageCommands, command)) {
-                    if (!command.allowExecuteInDM && message.channel.type === 'DM' || !command.allowExecuteByBots && (message.author.bot || message.author.system) || (0, isIgnoredChannel_1.isIgnoredChannel)(message.channelId, (_f = this.config) === null || _f === void 0 ? void 0 : _f.ignoredChannels))
-                        return this;
-                    if (command.validateOptions && !command.getCommandOptionValues(parseCommand)) {
-                        yield message.reply(((_g = this.config) === null || _g === void 0 ? void 0 : _g.messages.notEnoughArguments) || 'Not enough arguments.').catch((err) => this.logger.error(err));
-                        return this;
-                    }
-                    const options = {
-                        message: message,
-                        command: parseCommand,
-                        builder: command,
-                        client: this
-                    };
-                    yield Promise.resolve(command.execute(options)).catch(err => this._commandExecuteError(err, options));
-                    this.emit('recipleMessageCommandCreate', options);
-                }
-                else {
-                    yield message.reply(((_h = this.config) === null || _h === void 0 ? void 0 : _h.messages.noPermissions) || 'You do not have permission to use this command.').catch((err) => this.logger.error(err));
                 }
+                const options = {
+                    message: message,
+                    command: parseCommand,
+                    builder: command,
+                    client: this
+                };
+                yield Promise.resolve(command.execute(options)).catch(err => this._commandExecuteError(err, options));
+                this.emit('recipleMessageCommandCreate', options);
+            }
+            else {
+                yield message.reply(((_h = this.config) === null || _h === void 0 ? void 0 : _h.messages.noPermissions) || 'You do not have permission to use this command.').catch((err) => this.logger.error(err));
             }
             return this;
         });
@@ -115,6 +121,8 @@ class RecipleClient extends discord_js_1.Client {
             if (!interaction || !interaction.isCommand() || !((_a = this.config) === null || _a === void 0 ? void 0 : _a.commands.interactionCommand.enabled))
                 return this;
             const command = this.commands.INTERACTION_COMMANDS[interaction.commandName];
+            if (!command)
+                return this;
             if ((0, commandPermissions_1.commandPermissions)(command.name, (_b = interaction.memberPermissions) !== null && _b !== void 0 ? _b : undefined, (_c = this.config) === null || _c === void 0 ? void 0 : _c.permissions.interactionCommands, command)) {
                 if (!command.allowExecuteInDM && interaction.member === null || (0, isIgnoredChannel_1.isIgnoredChannel)(interaction.channelId, (_d = this.config) === null || _d === void 0 ? void 0 : _d.ignoredChannels))
                     return this;

package/bin/reciple/classes/Config.d.ts

@@ -1,4 +1,4 @@
-import { ClientOptions, PermissionResolvable } from 'discord.js';
+import { ClientOptions, PermissionFlags, PermissionString } from 'discord.js';
 export interface Config {
     token: string;
     prefix: string;
@@ -12,6 +12,7 @@ export interface Config {
             enabled: boolean;
             replyOnError: boolean;
             registerCommands: boolean;
+            setRequiredPermissions: boolean;
             guilds: string[] | string;
         };
     };
@@ -20,14 +21,14 @@ export interface Config {
             enabled: boolean;
             commands: {
                 command: string;
-                permissions: PermissionResolvable[];
+                permissions: (PermissionFlags | PermissionString)[];
             }[];
         };
         interactionCommands: {
             enabled: boolean;
             commands: {
                 command: string;
-                permissions: PermissionResolvable[];
+                permissions: (PermissionFlags | PermissionString)[];
             }[];
         };
     };
@@ -47,7 +48,7 @@ export interface Config {
         [key: string]: any;
     };
     modulesFolder: string;
-    version?: string;
+    version: string;
 }
 export declare class RecipleConfig {
     config?: Config;

package/bin/reciple/classes/Config.js

@@ -67,7 +67,7 @@ class RecipleConfig {
     }
     isSupportedConfig() {
         var _a;
-        return (((_a = this.config) === null || _a === void 0 ? void 0 : _a.version) && this.config.version != version_1.version) ? false : true;
+        return (0, version_1.isSupportedVersion)(((_a = this.config) === null || _a === void 0 ? void 0 : _a.version) || '0.0.0', version_1.version);
     }
     askToken() {
         return flags_1.token || (0, fallout_utility_1.input)({ 'text': 'Bot Token >>> ', echo: '*', repeatIfEmpty: true, exitStrings: ['exit', 'quit', ''], sigint: true }) || null;

package/bin/reciple/classes/builders/MessageCommandBuilder.d.ts

@@ -1,4 +1,4 @@
-import { Message, PermissionFlags } from 'discord.js';
+import { Message, PermissionFlags, PermissionString } from 'discord.js';
 import { Command } from 'fallout-utility';
 import { RecipleClient } from '../Client';
 export declare type CommandMessage = Command;
@@ -29,12 +29,12 @@ export declare class MessageCommandBuilder {
     description: string;
     options: MessageOption[];
     validateOptions: boolean;
-    requiredPermissions: (keyof PermissionFlags)[];
+    requiredPermissions: (PermissionFlags | PermissionString)[];
     allowExecuteInDM: boolean;
     allowExecuteByBots: boolean;
     execute: (options: RecipleMessageCommandExecute) => void;
     setName(name: string): MessageCommandBuilder;
-    setRequiredPermissions(permissions: (keyof PermissionFlags)[]): MessageCommandBuilder;
+    setRequiredPermissions(permissions: (PermissionFlags | PermissionString)[]): MessageCommandBuilder;
     setAllowExecuteInDM(allowExecuteInDM: boolean): MessageCommandBuilder;
     setAllowExecuteByBots(allowExecuteByBots: boolean): MessageCommandBuilder;
     setDescription(description: string): MessageCommandBuilder;

package/bin/reciple/modules.js

@@ -14,9 +14,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadModules = void 0;
 const fs_1 = require("fs");
+const version_1 = require("./version");
 const path_1 = __importDefault(require("path"));
 function loadModules(client) {
-    var _a;
+    var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         const response = { commands: [], modules: [] };
         const modulesDir = ((_a = client.config) === null || _a === void 0 ? void 0 : _a.modulesFolder) || './modules';
@@ -29,8 +30,12 @@ function loadModules(client) {
             const commands = [];
             let module_;
             try {
-                module_ = require(modulePath);
-                if (!module_.versions || !(typeof module_.versions === 'object' ? module_.versions : [module_.versions]).includes(client.version))
+                const reqMod = require(modulePath);
+                module_ = !!(reqMod === null || reqMod === void 0 ? void 0 : reqMod.default) ? reqMod.default : reqMod;
+                if (!((_b = module_.versions) === null || _b === void 0 ? void 0 : _b.length))
+                    throw new Error('Module does not have supported versions.');
+                const versions = typeof module_.versions === 'object' ? module_.versions : [module_.versions];
+                if (!versions.some(v => (0, version_1.isSupportedVersion)(v, version_1.version)))
                     throw new Error('Module versions is not defined or unsupported.');
                 if (!(yield Promise.resolve(module_.onStart(client))))
                     throw new Error(script + ' onStart is not defined or returned false.');

package/bin/reciple/registerInteractionCommands.d.ts

@@ -1,6 +1,6 @@
 import { InteractionCommandBuilder } from './classes/builders/InteractionCommandBuilder';
 import { RecipleClient } from "./classes/Client";
-import { ApplicationCommandDataResolvable } from 'discord.js';
+import { ApplicationCommandDataResolvable, GuildResolvable } from 'discord.js';
 import { ContextMenuCommandBuilder, SlashCommandBuilder, SlashCommandSubcommandBuilder, SlashCommandOptionsOnlyBuilder, SlashCommandSubcommandGroupBuilder, SlashCommandSubcommandsOnlyBuilder } from '@discordjs/builders';
 export declare type commandBuilders = InteractionCommandBuilder | ContextMenuCommandBuilder | SlashCommandBuilder | SlashCommandSubcommandBuilder | SlashCommandOptionsOnlyBuilder | SlashCommandSubcommandGroupBuilder | SlashCommandSubcommandsOnlyBuilder;
-export declare function registerInteractionCommands(client: RecipleClient, cmds?: (commandBuilders | ApplicationCommandDataResolvable)[]): Promise<void>;
+export declare function registerInteractionCommands(client: RecipleClient, cmds?: (commandBuilders | ApplicationCommandDataResolvable)[], overwriteGuilds?: GuildResolvable | GuildResolvable[]): Promise<void>;

package/bin/reciple/registerInteractionCommands.js

@@ -10,26 +10,41 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerInteractionCommands = void 0;
-function registerInteractionCommands(client, cmds) {
+function registerInteractionCommands(client, cmds, overwriteGuilds) {
     var _a, _b, _c, _d, _e, _f;
     return __awaiter(this, void 0, void 0, function* () {
-        const commands = (_a = Object.values(cmds !== null && cmds !== void 0 ? cmds : client.commands.INTERACTION_COMMANDS).map(c => {
-            if (typeof c.toJSON !== 'undefined')
+        let commands = (_a = Object.values(cmds !== null && cmds !== void 0 ? cmds : client.commands.INTERACTION_COMMANDS).map(c => {
+            var _a, _b, _c, _d, _e, _f, _g;
+            if (typeof c.toJSON !== 'undefined') {
+                const cmd = c;
+                if ((cmd === null || cmd === void 0 ? void 0 : cmd.builder) === 'INTERACTION_COMMAND' && ((_a = client.config) === null || _a === void 0 ? void 0 : _a.commands.interactionCommand.setRequiredPermissions)) {
+                    const permissions = (_g = (((_c = (_b = client.config) === null || _b === void 0 ? void 0 : _b.permissions) === null || _c === void 0 ? void 0 : _c.interactionCommands.enabled) ?
+                        (_f = (_e = (_d = client.config) === null || _d === void 0 ? void 0 : _d.permissions) === null || _e === void 0 ? void 0 : _e.interactionCommands.commands.find(c => c.command.toLowerCase() === cmd.name.toLowerCase())) === null || _f === void 0 ? void 0 : _f.permissions :
+                        undefined)) !== null && _g !== void 0 ? _g : cmd.requiredPermissions;
+                    cmd.setRequiredPermissions(permissions);
+                    client.commands.INTERACTION_COMMANDS[cmd.name] = cmd;
+                    client.logger.debug(`Set required permissions for ${cmd.name} to ${permissions.join(', ')}`);
+                    return cmd.toJSON();
+                }
                 return c.toJSON();
+            }
             return c;
         })) !== null && _a !== void 0 ? _a : [];
         if (!commands || !commands.length) {
             client.logger.warn('No interaction commands found.');
             return;
         }
-        if (!((_b = client.config) === null || _b === void 0 ? void 0 : _b.commands.interactionCommand.guilds.length)) {
+        const configGuilds = overwriteGuilds !== null && overwriteGuilds !== void 0 ? overwriteGuilds : (_b = client.config) === null || _b === void 0 ? void 0 : _b.commands.interactionCommand.guilds;
+        const guilds = typeof configGuilds === 'object' ? configGuilds : [configGuilds];
+        if (!guilds || !(guilds === null || guilds === void 0 ? void 0 : guilds.length)) {
             yield ((_d = (_c = client.application) === null || _c === void 0 ? void 0 : _c.commands.set(commands)) === null || _d === void 0 ? void 0 : _d.catch(e => client.logger.error(e)));
             client.logger.warn('No guilds were specified for interaction commands. Registered commands for all guilds.');
         }
         else {
-            const guilds = typeof client.config.commands.interactionCommand.guilds === 'string' ? [client.config.commands.interactionCommand.guilds] : client.config.commands.interactionCommand.guilds;
             client.logger.warn(`Registering ${commands.length} interaction commands for ${guilds.length} guild(s).`);
             for (const guild of guilds) {
+                if (!guild)
+                    continue;
                 yield ((_f = (_e = client.application) === null || _e === void 0 ? void 0 : _e.commands.set(commands, guild)) === null || _f === void 0 ? void 0 : _f.catch(e => client.logger.error(e)));
                 client.logger.warn(`Registered ${commands.length} interaction commands for ${guild}.`);
             }

package/bin/reciple/version.d.ts

@@ -1 +1,8 @@
-export declare const version: any;
+export declare const version: string;
+export declare function validVersion(ver: string): boolean;
+export declare function parseVersion(ver: string): {
+    major: number;
+    minor: number;
+    patch: number;
+};
+export declare function isSupportedVersion(ver: string, supportedVersion?: string): boolean;

package/bin/reciple/version.js

@@ -1,4 +1,38 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.version = void 0;
+exports.isSupportedVersion = exports.parseVersion = exports.validVersion = exports.version = void 0;
+const fallout_utility_1 = require("fallout-utility");
 exports.version = require('../../package.json').version;
+function validVersion(ver) {
+    if (!ver || typeof ver !== 'string' || ver.split('.').length < 3)
+        return false;
+    const [major, minor, patch] = ver.split('.');
+    if (!(0, fallout_utility_1.isNumber)(major) || !(0, fallout_utility_1.isNumber)(minor) || !(0, fallout_utility_1.isNumber)(patch))
+        return false;
+    return true;
+}
+exports.validVersion = validVersion;
+function parseVersion(ver) {
+    if (!validVersion(ver))
+        throw new TypeError(`Invalid version: ${ver}`);
+    const [major, minor, patch] = ver.split('.');
+    return { major: parseInt(major), minor: parseInt(minor), patch: parseInt(patch) };
+}
+exports.parseVersion = parseVersion;
+function isSupportedVersion(ver, supportedVersion) {
+    supportedVersion = supportedVersion || exports.version;
+    if (!validVersion(ver))
+        throw new TypeError(`Invalid version: ${ver}`);
+    if (!validVersion(supportedVersion))
+        throw new TypeError(`Invalid supported version: ${supportedVersion}`);
+    const { major, minor, patch } = parseVersion(ver);
+    const { major: supportedMajor, minor: supportedMinor, patch: supportedPatch } = parseVersion(supportedVersion);
+    if (major !== supportedMajor)
+        return false;
+    if (minor !== supportedMinor)
+        return false;
+    if (patch > supportedPatch)
+        return false;
+    return true;
+}
+exports.isSupportedVersion = isSupportedVersion;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reciple",
-  "version": "1.1.4",
+  "version": "1.2.0",
   "description": "A Discord.js bot",
   "author": "FalloutStudios",
   "license": "GPL-3.0",
@@ -13,13 +13,15 @@
     "resource",
     "package.json",
     "LICENSE",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md"
   ],
   "scripts": {
     "clean": "rimraf bin",
     "compile": "yarn clean && tsc",
     "build": "yarn compile && npm un reciple -g && npm i ./ -g",
-    "build:publish": "yarn run build && yarn publish",
+    "build:publish": "yarn run build && yarn run changelog && yarn publish",
+    "changelog": "changelog generate",
     "test": "cd test && reciple",
     "test:compile": "yarn run build && yarn test:run"
   },
@@ -31,7 +33,8 @@
     "yaml": "^2.1.0"
   },
   "devDependencies": {
-    "@types/node": "^17.0.33",
+    "@types/node": "^17.0.35",
+    "generate-changelog": "^1.8.0",
     "typescript": "^4.6.4"
   }
 }

package/resource/reciple.yml

@@ -22,6 +22,8 @@ commands:
     replyOnError: false
     # register interaction commands on bot ready
     registerCommands: true
+    # set required permissions for interaction commands
+    setRequiredPermissions: true
     # register commands to specific guild(s) empty to make it global
     guilds: []