reciple 1.0.0 → 1.0.3

package/README.md

@@ -1,2 +1,61 @@
-# reciple
- A Discord.js bot
+<h1 align="center">
+    <img src="https://i.imgur.com/8pYGOWW.png" width="50%">
+    <br>
+    <img alt="Lines of code" src="https://img.shields.io/tokei/lines/github/FalloutStudios/Reciple">
+    <img alt="GitHub" src="https://img.shields.io/github/license/FalloutStudios/Reciple">
+    <a href="https://www.codefactor.io/repository/github/falloutstudios/reciple/overview/main"><img src="https://www.codefactor.io/repository/github/falloutstudios/reciple/badge/main" alt="CodeFactor"></a>
+</h1>
+
+A simple modular Discord bot made with Discord.js written in TypeScript.
+
+
+## Installation
+To install the bot, run the following command:
+
+```bash
+npm i reciple
+```
+
+You can initialize the bot to the current directory with the following command:
+
+```bash
+reciple
+```
+
+It will ask you to continue if the directory is not empty type `y` to continue after the bot has been initialized it will ask you for your `TOKEN`.
+
+> You can always change the token on `reciple.yml`
+
+## Config
+
+You can configure the bot on `reciple.yml` in the bot root directory.
+
+### Token
+
+You can directly change the token on `reciple.yml` like so:
+
+```yml
+token: "YOUR_TOKEN_HERE"
+```
+
+Using environment variables is also supported:
+
+```yml
+token: "env:TOKEN_VARIABLE"
+```
+
+You can override the token on the command line like so:
+
+```bash
+reciple --token "YOUR_TOKEN_HERE"
+```
+
+## Running the bot
+To run the bot, run the following command:
+
+```bash
+reciple
+```
+
+> ## Fun Fact
+> The name reciple is from a minecraft bug. The bug was a misspelling of the word `recipe`. [Mojang Reciple](https://bugs.mojang.com/browse/MC-225837)

package/bin/reciple/classes/Client.js

@@ -12,8 +12,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RecipleClient = void 0;
 const discord_js_1 = require("discord.js");
 const fallout_utility_1 = require("fallout-utility");
-const MessageCommandBuilder_1 = require("./builders/MessageCommandBuilder");
-const InteractionCommandBuilder_1 = require("./builders/InteractionCommandBuilder");
 const registerInteractionCommands_1 = require("../registerInteractionCommands");
 const logger_1 = require("../logger");
 const modules_1 = require("../modules");
@@ -43,10 +41,10 @@ class RecipleClient extends discord_js_1.Client {
             for (const command of modules.commands) {
                 if (!command.name)
                     continue;
-                if (command instanceof MessageCommandBuilder_1.MessageCommandBuilder) {
+                if (command.type === 'MESSAGE_COMMAND') {
                     this.commands.MESSAGE_COMMANDS[command.name] = command;
                 }
-                else if (command instanceof InteractionCommandBuilder_1.InteractionCommandBuilder) {
+                else if (command.type === 'INTERACTION_COMMAND') {
                     this.commands.INTERACTION_COMMANDS[command.name] = command;
                 }
             }
@@ -85,9 +83,7 @@ class RecipleClient extends discord_js_1.Client {
             if (parseCommand && parseCommand.command) {
                 const command = this.commands.MESSAGE_COMMANDS[parseCommand.command];
                 if (command && (0, commandPermissions_1.commandPermissions)(command.name, ((_c = message.member) === null || _c === void 0 ? void 0 : _c.permissions) || null, (_d = this.config) === null || _d === void 0 ? void 0 : _d.permissions.messageCommands)) {
-                    if (!command.allowExecuteInDM && message.channel.type === 'DM')
-                        return this;
-                    if (!command.allowExecuteByBots && (message.author.bot || message.author.system))
+                    if (!command.allowExecuteInDM && message.channel.type === 'DM' || !command.allowExecuteByBots && (message.author.bot || message.author.system))
                         return this;
                     if (command.validateOptions && !command.getCommandOptionValues(parseCommand)) {
                         yield message.reply(((_e = this.config) === null || _e === void 0 ? void 0 : _e.messages.notEnoughArguments) || 'Not enough arguments.').catch((err) => this.logger.error(err));
@@ -99,7 +95,7 @@ class RecipleClient extends discord_js_1.Client {
                         builder: command,
                         client: this
                     };
-                    yield Promise.resolve(command.execute(options));
+                    yield Promise.resolve(command.execute(options)).catch(err => { this.logger.error(`An error occured executing "${command.name}"`); this.logger.error(err); });
                     this.emit('recipleMessageCommandCreate', options);
                 }
             }
@@ -121,7 +117,7 @@ class RecipleClient extends discord_js_1.Client {
                     builder: command,
                     client: this
                 };
-                yield Promise.resolve(command.execute(options));
+                yield Promise.resolve(command.execute(options)).catch(err => { this.logger.error(`An error occured executing "${command.name}"`); this.logger.error(err); });
                 this.emit('recipleInteractionCommandCreate', options);
             }
             return this;

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

@@ -43,6 +43,7 @@ export interface Config {
         [key: string]: MessageOptions | string;
     };
     modulesFolder: string;
+    version?: string;
 }
 export declare class RecipleConfig {
     config?: Config;
@@ -51,5 +52,6 @@ export declare class RecipleConfig {
     parseConfig(): RecipleConfig;
     getConfig(): Config;
     parseToken(askIfNull?: boolean): string | null;
+    private isSupportedConfig;
     private askToken;
 }

package/bin/reciple/classes/Config.js

@@ -9,6 +9,7 @@ const fs_1 = require("fs");
 const flags_1 = require("../flags");
 const path_1 = __importDefault(require("path"));
 const yaml_1 = __importDefault(require("yaml"));
+const version_1 = require("../version");
 class RecipleConfig {
     constructor(configPath) {
         this.configPath = './reciple.yml';
@@ -17,11 +18,12 @@ class RecipleConfig {
         this.configPath = configPath;
     }
     parseConfig() {
+        var _a;
         if (!(0, fs_1.existsSync)(this.configPath)) {
             const defaultConfigPath = path_1.default.join(__dirname, '../../../resource/reciple.yml');
             if (!(0, fs_1.existsSync)(defaultConfigPath))
                 throw new Error('Default Config file not found. Please reinstall Reciple.');
-            const defaultConfig = (0, fs_1.readFileSync)(defaultConfigPath, 'utf-8');
+            const defaultConfig = (0, fallout_utility_1.replaceAll)((0, fs_1.readFileSync)(defaultConfigPath, 'utf-8'), 'VERSION', version_1.version);
             (0, fs_1.writeFileSync)(this.configPath, defaultConfig, 'utf-8');
             if (!(0, fs_1.existsSync)(this.configPath))
                 throw new Error('Failed to create config file.');
@@ -36,6 +38,8 @@ class RecipleConfig {
             throw new Error('Failed to read config file.');
         const config = (0, fs_1.readFileSync)(this.configPath, 'utf-8');
         this.config = yaml_1.default.parse(config);
+        if (!this.isSupportedConfig())
+            throw new Error('Unsupported config version. Your config version: ' + (((_a = this.config) === null || _a === void 0 ? void 0 : _a.version) || 'No version specified.') + ', Reciple version: ' + version_1.version);
         return this;
     }
     getConfig() {
@@ -61,6 +65,10 @@ class RecipleConfig {
         }
         return token || (askIfNull ? this.askToken() : null);
     }
+    isSupportedConfig() {
+        var _a;
+        return (((_a = this.config) === null || _a === void 0 ? void 0 : _a.version) && this.config.version != version_1.version) ? false : true;
+    }
     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/InteractionCommandBuilder.d.ts

@@ -8,6 +8,7 @@ export interface RecipleInteractionCommandExecute {
     client: RecipleClient;
 }
 export declare class InteractionCommandBuilder extends SlashCommandBuilder {
+    readonly type: string;
     allowExecuteInDM: boolean;
     execute: (options: RecipleInteractionCommandExecute) => void;
     setAllowExecuteInDM(allowExecuteInDM: boolean): InteractionCommandBuilder;

package/bin/reciple/classes/builders/InteractionCommandBuilder.js

@@ -5,6 +5,7 @@ const builders_1 = require("@discordjs/builders");
 class InteractionCommandBuilder extends builders_1.SlashCommandBuilder {
     constructor() {
         super(...arguments);
+        this.type = 'INTERACTION_COMMAND';
         this.allowExecuteInDM = true;
         this.execute = (options) => { };
     }

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

@@ -15,20 +15,21 @@ export interface RecipleMessageCommandExecute {
 }
 export interface MessageCommandValidatedOption {
     name: string;
-    value: any;
+    value: string;
     required: boolean;
 }
 export declare class MessageOption {
     name: string;
     description: string;
     required: boolean;
-    validate: (value: any) => boolean;
+    validate: (value: string) => boolean;
     setName(name: string): MessageOption;
     setDescription(description: string): MessageOption;
     setRequired(required: boolean): MessageOption;
-    setValidator(validator: (value: any) => boolean): MessageOption;
+    setValidator(validator: (value: string) => boolean): MessageOption;
 }
 export declare class MessageCommandBuilder {
+    readonly type: string;
     name: string;
     description: string;
     options: MessageOption[];

package/bin/reciple/classes/builders/MessageCommandBuilder.js

@@ -36,6 +36,7 @@ class MessageOption {
 exports.MessageOption = MessageOption;
 class MessageCommandBuilder {
     constructor() {
+        this.type = 'MESSAGE_COMMAND';
         this.name = '';
         this.description = '';
         this.options = [];

package/bin/reciple/commandPermissions.d.ts

@@ -1,3 +1,3 @@
 import { Permissions } from "discord.js";
 import { Config } from "./classes/Config";
-export declare function commandPermissions(commandName: string, member: Permissions | null, permissions?: Config['permissions']['messageCommands'] | Config['permissions']['interactionCommands']): boolean;
+export declare function commandPermissions(commandName: string, memberPermissions: Permissions | null, configConmmandPermissions?: Config['permissions']['messageCommands'] | Config['permissions']['interactionCommands']): boolean;

package/bin/reciple/commandPermissions.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.commandPermissions = void 0;
-function commandPermissions(commandName, member, permissions) {
-    if (!(permissions === null || permissions === void 0 ? void 0 : permissions.enabled))
+function commandPermissions(commandName, memberPermissions, configConmmandPermissions) {
+    if (!(configConmmandPermissions === null || configConmmandPermissions === void 0 ? void 0 : configConmmandPermissions.enabled))
         return true;
-    const command = permissions.commands.find(c => c.command.toLowerCase() === commandName.toLowerCase());
+    const command = configConmmandPermissions.commands.find(c => c.command.toLowerCase() === commandName.toLowerCase());
     if (!command)
         return true;
     if (!command.permissions.length)
         return true;
-    return member ? member.has(command.permissions) : false;
+    return memberPermissions ? memberPermissions.has(command.permissions) : false;
 }
 exports.commandPermissions = commandPermissions;

package/bin/reciple/flags.d.ts

@@ -1 +1,2 @@
+export declare const flags: import("commander").OptionValues;
 export declare const token: any;

package/bin/reciple/flags.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.token = void 0;
+exports.token = exports.flags = void 0;
 const commander_1 = require("commander");
-const flags = commander_1.program
+exports.flags = commander_1.program
     .option('-t, --token <token>', 'Replace used bot token')
     .parse().opts();
-exports.token = flags.token;
+exports.token = exports.flags.token;

package/bin/reciple/modules.d.ts

@@ -9,8 +9,8 @@ export declare type loadedModules = {
 export interface RecipleScript {
     versions: string | string[];
     commands?: (MessageCommandBuilder | InteractionCommandBuilder)[];
-    onLoad?: (reciple: RecipleClient) => void;
-    onStart: (reciple: RecipleClient) => boolean;
+    onLoad?: (reciple: RecipleClient) => void | Promise<void>;
+    onStart: (reciple: RecipleClient) => boolean | Promise<boolean>;
 }
 export interface RecipleModule {
     script: RecipleScript;

package/bin/reciple/modules.js

@@ -15,7 +15,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadModules = void 0;
 const fs_1 = require("fs");
 const MessageCommandBuilder_1 = require("./classes/builders/MessageCommandBuilder");
-const InteractionCommandBuilder_1 = require("./classes/builders/InteractionCommandBuilder");
 const path_1 = __importDefault(require("path"));
 function loadModules(client) {
     var _a;
@@ -38,10 +37,8 @@ function loadModules(client) {
                     throw new Error(script + ' onStart is not defined or returned false.');
                 if (module_.commands) {
                     for (const command of module_.commands) {
-                        if (!(command instanceof MessageCommandBuilder_1.MessageCommandBuilder) && !(command instanceof InteractionCommandBuilder_1.InteractionCommandBuilder)) {
-                            continue;
-                        }
-                        commands.push(command);
+                        if (command.type === 'MESSAGE_COMMAND' || command.type === 'INTERACTION_COMMAND')
+                            commands.push(command);
                     }
                 }
             }
@@ -55,7 +52,7 @@ function loadModules(client) {
                     logger.error(`A message command name is not defined in ${script}`);
                     return false;
                 }
-                if (c instanceof MessageCommandBuilder_1.MessageCommandBuilder && c.options.some(o => !o.name)) {
+                if (c instanceof MessageCommandBuilder_1.MessageCommandBuilder && c.options.length && c.options.some(o => !o.name)) {
                     logger.error(`A message command option name is not defined in ${script}`);
                     return false;
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reciple",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "A Discord.js bot",
   "author": "FalloutStudios",
   "license": "GPL-3.0",

package/resource/reciple.yml

@@ -45,4 +45,6 @@ messages:
   noPermission: 'You do not have permission to use this command.'
   notEnoughArguments: 'Not enough arguments.'
 
-modulesFolder: 'modules'
+modulesFolder: 'modules'
+
+version: VERSION