reciple 5.6.0 → 6.0.0-dev.10

package/dist/types/reciple/types/paramOptions.d.ts

@@ -1,37 +1,6 @@
-import { ApplicationCommandBuilder } from '../registerApplicationCommands';
-import { ApplicationCommandData, PermissionsBitField } from 'discord.js';
 import { ConfigCommandPermissions } from '../classes/RecipleConfig';
-import { RecipleModule, RecipleScript } from '../modules';
-import { RecipleClient } from '../classes/RecipleClient';
+import { PermissionsBitField } from 'discord.js';
 import { AnyCommandBuilder } from './builders';
-export interface RecipleClientAddModuleOptions {
-    /**
-     * The module script
-     */
-    script: RecipleScript;
-    /**
-     * Register application commands if possible
-     */
-    registerApplicationCommands?: boolean;
-    /**
-     * Module optional info
-     */
-    moduleInfo?: RecipleModule["info"];
-}
-export interface RegisterApplicationCommandsOptions {
-    /**
-     * Bot client
-     */
-    client: RecipleClient;
-    /**
-     * Commands to register
-     */
-    commands: (ApplicationCommandData | ApplicationCommandBuilder)[];
-    /**
-     * Set guild to not register commands globally
-     */
-    guilds?: string | string[];
-}
 export interface UserHasCommandPermissionsOptions {
     /**
      * Command builder
@@ -49,3 +18,8 @@ export interface UserHasCommandPermissionsOptions {
         commands: ConfigCommandPermissions[];
     };
 }
+export interface ClientModuleManagerGetModulesFromFilesOptions {
+    files: string[];
+    disabeVersionCheck?: boolean;
+    dontSkipError?: boolean;
+}

package/dist/types/reciple/util.d.ts

@@ -1,3 +1,5 @@
+import { Logger } from 'fallout-utility';
+import { AnyCommandBuilder } from './types/builders';
 /**
  * Check if an object is a class
  * @param object Object to identify
@@ -8,3 +10,11 @@ export declare function isClass<T = any>(object: any): object is T;
  * @param content Warning content
  */
 export declare function deprecationWarning(content: string | Error): void;
+export declare function validateCommandBuilder(command: AnyCommandBuilder): boolean;
+/**
+ * Create new logger
+ * @param stringifyJSON stringify json objects in console
+ * @param debugmode display debug messages
+ * @param colorizeMessage add logger colours to messages
+ */
+export declare function createLogger(stringifyJSON: boolean, debugmode?: boolean, colorizeMessage?: boolean): Logger;

package/package.json

@@ -1,19 +1,23 @@
 {
   "name": "reciple",
-  "version": "5.6.0",
-  "bin": "dist/cjs/bin.js",
+  "version": "6.0.0-dev.10",
+  "bin": "./dist/cjs/bin.js",
   "license": "GPL-3.0",
-  "main": "dist/cjs/index.js",
-  "typings": "dist/types/index.d.ts",
+  "main": "./dist/cjs/index.js",
+  "types": "./dist/types/index.d.ts",
+  "module": "./dist/mjs/index.js",
   "author": "FalloutStudios",
   "description": "Handler for Discord.js",
   "homepage": "https://reciple.js.org",
+  "exports": {
+    "require": "./dist/cjs/index.js",
+    "import": "./dist/mjs/index.js",
+    "types": "./dist/types/index.d.ts"
+  },
   "keywords": [
     "Discord",
     "Discord.js handler",
-    "Reciple",
-    "Slash command handler",
-    "Message command handler"
+    "Reciple"
   ],
   "contributors": [
     "GhexterCortes"
@@ -22,13 +26,15 @@
     "url": "https://github.com/FalloutStudios/reciple/issues"
   },
   "scripts": {
-    "clean": "yarn exec rimraf dist",
-    "build": "yarn clean && yarn exec tsc",
-    "build:publish": "yarn build && yarn docs && yarn npm publish",
-    "build:publish-prerelease": "yarn build && yarn npm publish --tag pre",
-    "test": "yarn build && yarn workspace test start",
-    "docs": "yarn exec docgen --typescript true -c ./docs/index.json -o ./docs/docs.json -i src/index.ts",
-    "watch": "yarn exec tsc --watch --noEmit"
+    "format": "npx prettier --write src",
+    "clean": "npx rimraf dist",
+    "build": "npm run clean && npx tsc",
+    "build:publish": "npm run format && npm run build && npx docs && npm publish",
+    "build:publish-dev": "npm run format && npm run build && npm publish --tag dev",
+    "test": "npm run build && npm run start -w test",
+    "docs": "npx docgen --typescript true -c ./docs/index.json -o ./docs/docs.json -i src/index.ts",
+    "watch": "npx tsc --watch --noEmit",
+    "husky:install": "npx husky install"
   },
   "repository": {
     "type": "git",
@@ -41,7 +47,6 @@
   "files": [
     "dist",
     "resource",
-    "package.json",
     "LICENSE",
     "README.md"
   ],
@@ -49,24 +54,25 @@
     "chalk": "4.1.2",
     "commander": "^9.4.1",
     "dotenv": "^16.0.3",
-    "fallout-utility": "^1.5.2",
-    "semver": "^7.3.8",
+    "fallout-utility": "^1.5.4",
+    "semver": "^7.3.7",
     "wildcard-match": "^5.1.2",
-    "yaml": "^2.1.3"
+    "yaml": "^2.1.1"
   },
   "devDependencies": {
     "@discordjs/docgen": "^0.12.1",
-    "@types/node": "^18.8.3",
+    "@types/node": "^18.11.0",
     "@types/semver": "^7.3.12",
-    "discord.js": "^14.5.0",
+    "discord.js": "^14.6.0",
+    "husky": "^8.0.1",
+    "prettier": "2.7.1",
     "rimraf": "^3.0.2",
     "typescript": "^4.8.4"
   },
   "peerDependencies": {
-    "discord.js": "^14.1.0"
+    "discord.js": "^14.5.0"
   },
   "workspaces": [
     "test"
-  ],
-  "packageManager": "yarn@3.2.2"
-}
+  ]
+}

package/dist/cjs/reciple/logger.js

@@ -1,35 +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.createLogger = void 0;
-const fallout_utility_1 = require("fallout-utility");
-const flags_1 = require("./flags");
-const chalk_1 = __importDefault(require("chalk"));
-/**
- * Create new logger
- * @param stringifyJSON stringify json objects in console
- * @param debugmode display debug messages
- * @param colorizeMessage add logger colours to messages
- */
-function createLogger(stringifyJSON, debugmode = false, colorizeMessage = true) {
-    return new fallout_utility_1.Logger({
-        stringifyJSON: stringifyJSON,
-        enableDebugMode: flags_1.flags.debugmode ?? debugmode,
-        loggerName: 'Main',
-        prefixes: {
-            [fallout_utility_1.LogLevels.INFO]: (name) => `[${new Date().toLocaleTimeString(undefined, { hour12: false })}][${(name ? name + "/" : '') + "INFO"}]`,
-            [fallout_utility_1.LogLevels.WARN]: (name) => `[${chalk_1.default.yellow(new Date().toLocaleTimeString(undefined, { hour12: false }))}][${chalk_1.default.yellow((name ? name + "/" : '') + "WARN")}]`,
-            [fallout_utility_1.LogLevels.ERROR]: (name) => `[${chalk_1.default.red(new Date().toLocaleTimeString(undefined, { hour12: false }))}][${chalk_1.default.red((name ? name + "/" : '') + "ERROR")}]`,
-            [fallout_utility_1.LogLevels.DEBUG]: (name) => `[${chalk_1.default.blue(new Date().toLocaleTimeString(undefined, { hour12: false }))}][${chalk_1.default.blue((name ? name + "/" : '') + "DEBUG")}]`
-        },
-        colorMessages: {
-            [fallout_utility_1.LogLevels.INFO]: (message) => message,
-            [fallout_utility_1.LogLevels.WARN]: (message) => !colorizeMessage ? message : chalk_1.default.yellow(message),
-            [fallout_utility_1.LogLevels.ERROR]: (message) => !colorizeMessage ? message : chalk_1.default.red(message),
-            [fallout_utility_1.LogLevels.DEBUG]: (message) => !colorizeMessage ? message : chalk_1.default.blue(message)
-        }
-    });
-}
-exports.createLogger = createLogger;

package/dist/cjs/reciple/modules.js

@@ -1,113 +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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getModules = void 0;
-const builders_1 = require("./types/builders");
-const MessageCommandBuilder_1 = require("./classes/builders/MessageCommandBuilder");
-const SlashCommandBuilder_1 = require("./classes/builders/SlashCommandBuilder");
-const discord_js_1 = require("discord.js");
-const version_1 = require("./version");
-const fs_1 = require("fs");
-const wildcard_match_1 = __importDefault(require("wildcard-match"));
-const flags_1 = require("./flags");
-const path_1 = __importDefault(require("path"));
-/**
- * Load modules from folder
- * @param client Reciple client
- * @param folder Modules folder
- */
-async function getModules(client, folder) {
-    const response = { commands: [], modules: [] };
-    const modulesDir = folder || path_1.default.join(flags_1.cwd, 'modules');
-    if (!(0, fs_1.existsSync)(modulesDir))
-        (0, fs_1.mkdirSync)(modulesDir, { recursive: true });
-    const ignoredFiles = (client.config.ignoredFiles || []).map(file => file.endsWith('.js') ? file : `${file}.js`);
-    const scripts = (0, fs_1.readdirSync)(modulesDir).filter(file => {
-        return file.endsWith('.js') && (!file.startsWith('_') && !file.startsWith('.')) && !ignoredFiles.some(f => (0, wildcard_match_1.default)(f)(file));
-    });
-    for (const script of scripts) {
-        const modulePath = path_1.default.join(modulesDir, script);
-        const commands = [];
-        let module_;
-        try {
-            const reqMod = await Promise.resolve().then(() => __importStar(require(modulePath)));
-            module_ = reqMod?.default !== undefined ? reqMod.default : reqMod;
-            if (typeof module_ !== 'object')
-                throw new Error(`Module ${modulePath} is not an object`);
-            if (!client.config.disableVersionCheck && !module_?.versions?.length)
-                throw new Error(`${modulePath} does not have supported versions.`);
-            const versions = (0, discord_js_1.normalizeArray)([module_.versions]);
-            if (!client.config.disableVersionCheck && !versions.some(v => (0, version_1.isSupportedVersion)(v, version_1.version)))
-                throw new Error(`${modulePath} is unsupported; current version: ${version_1.version}; module supported versions: ` + versions.join(', ') ?? 'none');
-            if (!await Promise.resolve(module_.onStart(client)).catch(() => false))
-                throw new Error(script + ' onStart returned false or undefined.');
-            if (module_.commands) {
-                for (const command of module_.commands) {
-                    if (command.type === builders_1.CommandBuilderType.MessageCommand) {
-                        commands.push(MessageCommandBuilder_1.MessageCommandBuilder.resolveMessageCommand(command));
-                    }
-                    else if (command.type === builders_1.CommandBuilderType.SlashCommand) {
-                        commands.push(SlashCommandBuilder_1.SlashCommandBuilder.resolveSlashCommand(command));
-                    }
-                }
-            }
-        }
-        catch (error) {
-            if (client.isClientLogsEnabled()) {
-                client.logger.error(`Failed to load module ${script}`);
-                client.logger.error(error);
-            }
-            continue;
-        }
-        response.commands.push(...commands.filter((c) => {
-            if (!c.name) {
-                if (client.isClientLogsEnabled())
-                    client.logger.error(`A ${builders_1.CommandBuilderType[c.type]} command name is not defined in ${modulePath}`);
-                return false;
-            }
-            if (c.type === builders_1.CommandBuilderType.MessageCommand && c.options.length && c.options.some(o => !o.name)) {
-                if (client.isClientLogsEnabled())
-                    client.logger.error(`A ${builders_1.CommandBuilderType[c.type]} option name is not defined in ${modulePath}`);
-                return false;
-            }
-            return true;
-        }));
-        response.modules.push({
-            script: module_,
-            info: {
-                filename: script,
-                versions: (0, discord_js_1.normalizeArray)([module_.versions]),
-                path: modulePath
-            }
-        });
-        if (client.isClientLogsEnabled())
-            client.logger.info(`Loaded module ${modulePath}`);
-    }
-    return response;
-}
-exports.getModules = getModules;

package/dist/cjs/reciple/registerApplicationCommands.js

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerApplicationCommands = void 0;
-const discord_js_1 = require("discord.js");
-const SlashCommandBuilder_1 = require("./classes/builders/SlashCommandBuilder");
-/**
- * Register application commands
- * @param options Register application commands options
- */
-async function registerApplicationCommands(options) {
-    const client = options.client;
-    const guilds = (0, discord_js_1.normalizeArray)([options.guilds]);
-    const commands = options.commands ?? client.commands.slashCommands.toJSON().map(cmd => {
-        if (cmd?.toJSON === undefined)
-            return (cmd);
-        if (SlashCommandBuilder_1.SlashCommandBuilder.isSlashCommandBuilder(cmd) && client.config.commands.slashCommand.setRequiredPermissions) {
-            const permissions = client.config.commands.slashCommand.permissions.enabled
-                ? client.config.commands.slashCommand.permissions.commands.find(cmd_ => cmd_.command.toLowerCase() === cmd.name.toLowerCase())?.permissions
-                : undefined;
-            if (permissions) {
-                cmd.setRequiredMemberPermissions(...permissions);
-                if (client.isClientLogsEnabled())
-                    client.logger.debug(`Set required permissions for ${cmd.name}`);
-            }
-        }
-        return cmd.toJSON();
-    }) ?? [];
-    if (!client.isReady())
-        throw new Error('Client is not ready');
-    if (!guilds || !guilds?.length) {
-        client.application?.commands.set(commands).then(() => {
-            if (client.isClientLogsEnabled())
-                client.logger.warn('No guilds were specified for application commands. Registered application commands globally.');
-        });
-    }
-    else {
-        if (client.isClientLogsEnabled())
-            client.logger.warn(`Registering ${commands.length} application commands to ${guilds.length} guild(s).`);
-        for (const guild of guilds) {
-            if (!guild)
-                continue;
-            client.application?.commands.set(commands, guild).then(() => {
-                if (client.isClientLogsEnabled())
-                    client.logger.warn(`Registered ${commands.length} application command(s) for ${guild}.`);
-            });
-        }
-    }
-}
-exports.registerApplicationCommands = registerApplicationCommands;

package/dist/types/reciple/logger.d.ts

@@ -1,8 +0,0 @@
-import { Logger } from 'fallout-utility';
-/**
- * Create new logger
- * @param stringifyJSON stringify json objects in console
- * @param debugmode display debug messages
- * @param colorizeMessage add logger colours to messages
- */
-export declare function createLogger(stringifyJSON: boolean, debugmode?: boolean, colorizeMessage?: boolean): Logger;

package/dist/types/reciple/modules.d.ts

@@ -1,64 +0,0 @@
-import { AnyCommandBuilder, AnyCommandData } from './types/builders';
-import { RecipleClient } from './classes/RecipleClient';
-/**
- * Loaded modules and commands
- */
-export interface LoadedModules {
-    commands: AnyCommandBuilder[];
-    modules: RecipleModule[];
-}
-/**
- * Reciple script object
- */
-export interface RecipleScript {
-    /**
-     * Supported reciple versions
-     */
-    versions: string | string[];
-    /**
-     * Module commands
-     */
-    commands?: (AnyCommandBuilder | AnyCommandData)[];
-    /**
-     * Action on bot ready
-     * @param client Bot client
-     */
-    onLoad?(client: RecipleClient<true>): void | Promise<void>;
-    /**
-     * Action on module start
-     * @param client Bot client
-     */
-    onStart(client: RecipleClient<false>): boolean | Promise<boolean>;
-}
-/**
- * Reciple module object
- */
-export interface RecipleModule {
-    /**
-     * Module script
-     */
-    script: RecipleScript;
-    /**
-     * Module local information
-     */
-    info: {
-        /**
-         * Module file name
-         */
-        filename?: string;
-        /**
-         * Supported reciple versions
-         */
-        versions: string[];
-        /**
-         * Module local file path
-         */
-        path?: string;
-    };
-}
-/**
- * Load modules from folder
- * @param client Reciple client
- * @param folder Modules folder
- */
-export declare function getModules(client: RecipleClient, folder?: string): Promise<LoadedModules>;

package/dist/types/reciple/registerApplicationCommands.d.ts

@@ -1,9 +0,0 @@
-import { ContextMenuCommandBuilder, SlashCommandBuilder as DiscordJsSlashCommandBuilder } from 'discord.js';
-import { RegisterApplicationCommandsOptions } from './types/paramOptions';
-import { AnySlashCommandBuilder } from './types/builders';
-export declare type ApplicationCommandBuilder = AnySlashCommandBuilder | ContextMenuCommandBuilder | DiscordJsSlashCommandBuilder;
-/**
- * Register application commands
- * @param options Register application commands options
- */
-export declare function registerApplicationCommands(options: RegisterApplicationCommandsOptions): Promise<void>;

package/docs/README.md

@@ -1 +0,0 @@
-# [VIEW DOCS](https://reciple.js.org/#/docs)