reciple 1.1.2 → 1.1.5

package/CHANGELOG.md

@@ -0,0 +1,71 @@
+#### 1.1.4 (2022-05-21)
+
+##### New Features
+
+* **version.ts:**  Version checking functions (491b97b2)
+* **registerinteractions:**  You can now overwrite guilds in register interactions (422fe8ad)
+
+##### Bug Fixes
+
+* **modules:**  fix module loading version check (c3c2ad94)
+* **versions:**  Fixed checking supported version (4220ea96)
+* **scripts:**  Fixed changelog when deleting non existing file (cafdfe47)
+
+##### Other Changes
+
+* **changelog:**  Don't delete current changelog (29c49362)
+* **dependencies:**  Updated dev dependency (8b4a131c)
+
+##### Refactors
+
+* **versions:**  supported versions made backwards compatible (addf514a)
+* **modules:**  Check if module is supported (d79fbd49)
+* **Config.ts:**  Checks if version is supported (83bae35b)
+* **modules.ts:**  import default when available (cdad52e9)
+* **ignoredfiles:**  Ignore rmm files (55760c0e)
+
+#### 1.1.4 (2022-05-21)
+
+##### New Features
+
+* **version.ts:**  Version checking functions (491b97b2)
+* **registerinteractions:**  You can now overwrite guilds in register interactions (422fe8ad)
+
+##### Bug Fixes
+
+* **modules:**  fix module loading version check (c3c2ad94)
+* **versions:**  Fixed checking supported version (4220ea96)
+* **scripts:**  Fixed changelog when deleting non existing file (cafdfe47)
+
+##### Other Changes
+
+* **changelog:**  Don't delete current changelog (29c49362)
+* **dependencies:**  Updated dev dependency (8b4a131c)
+
+##### Refactors
+
+* **modules:**  Check if module is supported (d79fbd49)
+* **Config.ts:**  Checks if version is supported (83bae35b)
+* **modules.ts:**  import default when available (cdad52e9)
+* **ignoredfiles:**  Ignore rmm files (55760c0e)
+
+#### 1.1.4 (2022-05-20)
+
+##### New Features
+
+* **version.ts:**  Version checking functions (491b97b2)
+* **registerinteractions:**  You can now overwrite guilds in register interactions (422fe8ad)
+
+##### Bug Fixes
+
+* **scripts:**  Fixed changelog when deleting non existing file (cafdfe47)
+
+##### Other Changes
+
+* **dependencies:**  Updated dev dependency (8b4a131c)
+
+##### Refactors
+
+* **modules.ts:**  import default when available (cdad52e9)
+* **ignoredfiles:**  Ignore rmm files (55760c0e)
+

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) {

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

@@ -1,4 +1,4 @@
-import { ClientOptions, InteractionReplyOptions, MessageOptions, PermissionResolvable } from 'discord.js';
+import { ClientOptions, PermissionResolvable } from 'discord.js';
 export interface Config {
     token: string;
     prefix: string;
@@ -44,10 +44,10 @@ export interface Config {
     };
     client: ClientOptions;
     messages: {
-        [key: string]: MessageOptions | InteractionReplyOptions | string;
+        [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,13 +1,7 @@
 import { Message, PermissionFlags } from 'discord.js';
 import { Command } from 'fallout-utility';
 import { RecipleClient } from '../Client';
-export interface CommandMessage extends Command {
-    command?: string;
-    args?: string[];
-    raw?: string;
-    prefix?: string;
-    separator?: string;
-}
+export declare type CommandMessage = Command;
 export interface RecipleMessageCommandExecute {
     message: Message;
     command: CommandMessage;

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,8 +10,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerInteractionCommands = void 0;
-function registerInteractionCommands(client, cmds) {
-    var _a, _b, _c, _d;
+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')
@@ -22,15 +22,18 @@ function registerInteractionCommands(client, cmds) {
             client.logger.warn('No interaction commands found.');
             return;
         }
-        if (!((_b = client.config) === null || _b === void 0 ? void 0 : _b.commands.interactionCommand.guilds.length)) {
-            yield ((_c = client.application) === null || _c === void 0 ? void 0 : _c.commands.set(commands).catch(e => client.logger.error(e)));
+        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) {
-                yield ((_d = client.application) === null || _d === void 0 ? void 0 : _d.commands.set(commands, guild).catch(e => client.logger.error(e)));
+                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.2",
+  "version": "1.1.5",
   "description": "A Discord.js bot",
   "author": "FalloutStudios",
   "license": "GPL-3.0",
@@ -13,25 +13,28 @@
     "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 && npm 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"
   },
   "dependencies": {
     "commander": "^9.2.0",
-    "discord.js": "^13.6.0",
-    "dotenv": "^16.0.0",
-    "fallout-utility": "^1.3.13",
-    "yaml": "^2.0.1"
+    "discord.js": "^13.7.0",
+    "dotenv": "^16.0.1",
+    "fallout-utility": "^1.3.14",
+    "yaml": "^2.1.0"
   },
   "devDependencies": {
-    "@types/node": "^17.0.31",
+    "@types/node": "^17.0.35",
+    "generate-changelog": "^1.8.0",
     "typescript": "^4.6.4"
   }
 }

package/resource/reciple.yml

@@ -1,41 +1,69 @@
+# Your bot token here
+# To use env variable as a token just do it like this env:TOKEN_ENV
 token: TOKEN
+
+# Message command prefix
 prefix: '!'
 
+
+# Commands options
 commands:
   messageCommand:
+    # enable message commands
     enabled: true
+    # reply when an error occured
     replyOnError: false
+    # command argument separator
     commandArgumentSeparator: ' '
   interactionCommand:
+    # enable interaction commands
     enabled: true
+    # reply when an error occured
     replyOnError: false
+    # register interaction commands on bot ready
     registerCommands: true
+    # register commands to specific guild(s) empty to make it global
     guilds: []
 
+
+# Commands permissions
 permissions:
   messageCommands:
+    # enable command permissions
     enabled: true
     commands:
       - command: 'stop'
         permissions: ['ADMINISTRATOR']
   interactionCommands:
+    # enable command permissions
     enabled: true
     commands:
       - command: 'stop'
         permissions: ['ADMINISTRATOR']
 
 
+# Ignored channel IDs
 ignoredChannels:
+  # enable ignored channels
   enabled: false
+  # convert to only allowed channels
   convertToAllowList: false
+  # channel IDs
   channels: []
 
+
+# Logger options
 fileLogging:
+  # enable console output to file
   enabled: true
+  # enable debug mode
   debugmode: false
+  # stringify logged JSONs
   stringifyLoggedJSON: false
+  # log file path
   logFilePath: './logs/latest.log'
 
+# Client options
 client:
   intents:
     - 'GUILDS'
@@ -45,6 +73,7 @@ client:
     - 'GUILD_MESSAGES'
     - 'GUILD_MESSAGE_REACTIONS'
 
+# Bot replies
 messages:
   notEnoughArguments: 'Not enough arguments.'
   noPermissions:
@@ -54,6 +83,20 @@ messages:
     content: 'An error occurred.'
     ephemeral: true
 
+
+###################################################
+#                                                 #
+#   #####  #####  #    #   ###   #####  ####      #
+#   #   #  #   #  # #  #  #      #      #   #     #
+#   #   #  #####  #  # #  # ###  ###    ####      #
+#   #  #   #   #  #    #  #   #  #      #   #     #
+#   ###    #   #  #    #   ###   #####  #    #    #
+#                                                 #
+###################################################
+## Modifying these values below can cause errors ##
+
+# Modules folder
 modulesFolder: 'modules'
 
-version: VERSION
+# Current version
+version: VERSION