reciple 6.0.0-dev.2 → 6.0.0-dev.21

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

@@ -1,21 +1,7 @@
-import { RecipleModule, RecipleScript } from '../classes/managers/ClientModuleManager';
 import { ConfigCommandPermissions } from '../classes/RecipleConfig';
-import { PermissionsBitField } from 'discord.js';
+import { Awaitable, 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'];
-}
+import { RecipleModule } from '../classes/RecipleModule';
 export interface UserHasCommandPermissionsOptions {
     /**
      * Command builder
@@ -33,8 +19,83 @@ export interface UserHasCommandPermissionsOptions {
         commands: ConfigCommandPermissions[];
     };
 }
-export interface ModuleManagerResolveFilesOptions {
+export interface ModuleManagerResolveModuleFilesOptions {
+    /**
+     * valid reciple module (ESM or CJS) Javascript file paths
+     */
     files: string[];
+    /**
+     * Allow loading unsupported module versions
+     * @default false
+     */
     disabeVersionCheck?: boolean;
-    dontSkipError?: boolean;
+    /**
+     * Ignore errors
+     * @dafault true
+     */
+    ignoreErrors?: boolean;
+}
+export interface ModuleManagerGetModulePathsOptions {
+    /**
+     * Get javascript module file paths from folders
+     */
+    folders?: string[];
+    /**
+     * Add ignored files (wildcard)
+     * @example _*.js // Ignores _module.js and _hi.js
+     */
+    ignoredFiles?: string[];
+    /**
+     * Filter found javascript files
+     * @param file Loaded javascript file
+     * @returns `true` if the path is acceptable
+     */
+    filter?: (file: string) => Awaitable<boolean>;
+}
+export interface ModuleManagerStartModulesOptions {
+    /**
+     * Modules to start
+     */
+    modules: RecipleModule[];
+    /**
+     * Add modules to Client modules collection
+     * @default true
+     */
+    addToModulesCollection?: boolean;
+    /**
+     * Ignore errors
+     * @default true
+     */
+    ignoreErrors?: boolean;
+}
+export interface ModuleManagerLoadModulesOptions {
+    /**
+     * Modules to execute `load` method
+     */
+    modules?: RecipleModule[];
+    /**
+     * Add commands to client
+     * @default true
+     */
+    resolveCommands?: boolean;
+    /**
+     * Ignore errors
+     * @default true
+     */
+    ignoreErrors?: boolean;
+}
+export interface ModuleManagerUnloadModulesOptions {
+    /**
+     * Modules to execute `unload` method
+     */
+    modules?: RecipleModule[];
+    /**
+     * Reason for unloading modules
+     */
+    reason?: string;
+    /**
+     * Ignore errors
+     * @default true
+     */
+    ignoreErrors?: boolean;
 }

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

@@ -1,3 +1,6 @@
+/// <reference types="node" />
+import { Logger } from 'fallout-utility';
+import { default as _path } from 'path';
 import { AnyCommandBuilder } from './types/builders';
 /**
  * Check if an object is a class
@@ -10,3 +13,11 @@ export declare function isClass<T = any>(object: any): object is T;
  */
 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;
+export declare const path: _path.PlatformPath;

package/package.json

@@ -1,18 +1,26 @@
 {
   "name": "reciple",
-  "version": "6.0.0-dev.2",
-  "bin": "./dist/cjs/bin.js",
+  "version": "6.0.0-dev.21",
+  "bin": "./dist/lib/bin.mjs",
   "license": "GPL-3.0",
-  "main": "./dist/cjs/index.js",
+  "type": "commonjs",
+  "main": "./dist/lib/index.js",
   "types": "./dist/types/index.d.ts",
-  "module": "./dist/mjs/index.js",
+  "module": "./dist/lib/esm.mjs",
   "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"
+    ".": {
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/lib/esm.mjs"
+      },
+      "require": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/lib/index.js"
+      }
+    }
   },
   "keywords": [
     "Discord",
@@ -26,14 +34,14 @@
     "url": "https://github.com/FalloutStudios/reciple/issues"
   },
   "scripts": {
-    "format": "yarn prettier --write src",
-    "clean": "yarn exec rimraf dist",
-    "build": "yarn clean && yarn format && yarn exec tsc",
-    "build:publish": "yarn build && yarn docs && yarn npm publish",
-    "build:publish-dev": "yarn build && yarn npm publish --tag dev",
-    "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 && npm run docs && npm publish",
+    "build:publish-dev": "npm run format && npm run build && npm publish --tag dev",
+    "test": "npm run build && npm install && 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"
   },
   "repository": {
     "type": "git",
@@ -53,15 +61,15 @@
     "chalk": "4.1.2",
     "commander": "^9.4.1",
     "dotenv": "^16.0.3",
-    "fallout-utility": "^1.5.4",
+    "fallout-utility": "^1.5.13",
     "semver": "^7.3.7",
     "wildcard-match": "^5.1.2",
     "yaml": "^2.1.1"
   },
   "devDependencies": {
     "@discordjs/docgen": "^0.12.1",
-    "@types/node": "^18.11.0",
-    "@types/semver": "^7.3.12",
+    "@types/node": "^18.11.7",
+    "@types/semver": "^7.3.13",
     "discord.js": "^14.6.0",
     "prettier": "2.7.1",
     "rimraf": "^3.0.2",
@@ -72,6 +80,5 @@
   },
   "workspaces": [
     "test"
-  ],
-  "packageManager": "yarn@3.2.2"
-}
+  ]
+}

package/resource/reciple.yml

@@ -4,20 +4,24 @@ token: TOKEN
 
 # Commands options
 commands:
-  # message command options
-  messageCommand:
-    # enable message commands
+  # Interaction command options
+  slashCommand:
+    # enable interaction commands
     enabled: true
-    # command prefix
-    prefix: '!'
     # reply when an error occured
     replyOnError: false
     # enable the use of command cooldowns
     enableCooldown: true
-    # allow executing commands via aliases
-    allowCommandAlias: true
-    # command argument separator
-    commandArgumentSeparator: ' '
+    # register interaction commands on bot ready
+    registerCommands: true
+    # allow register empty list of application commands
+    allowRegisterEmptyCommandList: true
+    # set required permissions for interaction commands
+    setRequiredPermissions: true
+    # accept replied or deffered command interaction
+    acceptRepliedInteractions: false
+    # register commands to specific guild(s) empty to make it global
+    guilds: []
     # overwrite command permissions
     permissions:
       # enable overwriten command permissions
@@ -27,22 +31,20 @@ commands:
           permissions:
             - Administrator
 
-  # Interaction command options
-  slashCommand:
-    # enable interaction commands
+  # message command options
+  messageCommand:
+    # enable message commands
     enabled: true
+    # command prefix
+    prefix: '!'
     # reply when an error occured
     replyOnError: false
     # enable the use of command cooldowns
     enableCooldown: true
-    # register interaction commands on bot ready
-    registerCommands: true
-    # set required permissions for interaction commands
-    setRequiredPermissions: true
-    # accept replied or deffered command interaction
-    acceptRepliedInteractions: false
-    # register commands to specific guild(s) empty to make it global
-    guilds: []
+    # allow executing commands via aliases
+    allowCommandAlias: true
+    # command argument separator
+    commandArgumentSeparator: ' '
     # overwrite command permissions
     permissions:
       # enable overwriten command permissions
@@ -52,7 +54,6 @@ commands:
           permissions:
             - Administrator
 
-
 # Logger options
 fileLogging:
   # enable console output to file
@@ -93,7 +94,9 @@ messages:
     ephemeral: true
 
 # Ignored Files
-ignoredFiles: []
+ignoredFiles:
+  - '_*'
+  - '.*'
 
 
 ####################################################

package/dist/cjs/bin.js

@@ -1,50 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const RecipleClient_1 = require("./reciple/classes/RecipleClient");
-const RecipleConfig_1 = require("./reciple/classes/RecipleConfig");
-const version_1 = require("./reciple/version");
-const fs_1 = require("fs");
-const flags_1 = require("./reciple/flags");
-const fallout_utility_1 = require("fallout-utility");
-const chalk_1 = __importDefault(require("chalk"));
-require("dotenv/config");
-const path_1 = __importDefault(require("path"));
-const allowedFiles = ['node_modules', 'reciple.yml', 'package.json'];
-const configPath = path_1.default.join(flags_1.cwd, './reciple.yml');
-if ((0, fs_1.readdirSync)(flags_1.cwd).filter(f => !f.startsWith('.') && allowedFiles.indexOf(f)).length > 0 && !(0, fs_1.existsSync)(flags_1.flags.config ?? configPath)) {
-    const ask = (flags_1.flags.yes ? 'y' : null) ?? (0, fallout_utility_1.input)('This directory does not contain reciple.yml. Would you like to init axis here? [y/n] ') ?? '';
-    if (ask.toString().toLowerCase() !== 'y')
-        process.exit(0);
-}
-let configParser;
-try {
-    configParser = new RecipleConfig_1.RecipleConfig(flags_1.flags.config ?? configPath).parseConfig();
-}
-catch (err) {
-    console.error(`${chalk_1.default.bold.red('Config Error')}: ${chalk_1.default.white(err.message)}`);
-    process.exit(1);
-}
-const config = configParser.getConfig();
-const client = new RecipleClient_1.RecipleClient({ config: config, ...config.client });
-if (!client.isClientLogsSilent)
-    client.logger.info('Starting Reciple client v' + version_1.rawVersion);
-(async () => {
-    client.addCommandListeners();
-    await client.modules.startModulesFromFiles({
-        files: await client.modules.getModuleFiles(),
-    });
-    client.on('ready', async () => {
-        await client.modules.loadAll(true);
-        if (!client.isClientLogsSilent)
-            client.logger.warn(`Logged in as ${client.user?.tag || 'Unknown'}!`);
-        client.on('cacheSweep', () => client.cooldowns.clean());
-    });
-    client.login(config.token).catch(err => {
-        if (!client.isClientLogsSilent)
-            client.logger.error(err);
-    });
-})();

package/dist/cjs/reciple/classes/builders/MessageCommandBuilder.js

@@ -1,242 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateMessageCommandOptions = exports.MessageCommandBuilder = void 0;
-const builders_1 = require("../../types/builders");
-const discord_js_1 = require("discord.js");
-const MessageCommandOptionManager_1 = require("../managers/MessageCommandOptionManager");
-const MessageCommandOptionBuilder_1 = require("./MessageCommandOptionBuilder");
-/**
- * Reciple builder for message command
- */
-class MessageCommandBuilder {
-    constructor(data) {
-        this.type = builders_1.CommandBuilderType.MessageCommand;
-        this.name = '';
-        this.description = '';
-        this.cooldown = 0;
-        this.aliases = [];
-        this.validateOptions = false;
-        this.options = [];
-        this.requiredBotPermissions = [];
-        this.requiredMemberPermissions = [];
-        this.allowExecuteInDM = true;
-        this.allowExecuteByBots = false;
-        this.execute = () => {
-            /* Execute */
-        };
-        if (data?.name !== undefined)
-            this.setName(data.name);
-        if (data?.description !== undefined)
-            this.setDescription(data.description);
-        if (data?.aliases !== undefined)
-            this.addAliases(data.aliases);
-        if (data?.cooldown !== undefined)
-            this.setCooldown(Number(data?.cooldown));
-        if (data?.requiredBotPermissions !== undefined)
-            this.setRequiredBotPermissions(data.requiredBotPermissions);
-        if (data?.requiredMemberPermissions !== undefined)
-            this.setRequiredMemberPermissions(data.requiredMemberPermissions);
-        if (data?.halt !== undefined)
-            this.setHalt(data.halt);
-        if (data?.execute !== undefined)
-            this.setExecute(data.execute);
-        if (data?.metadata !== undefined)
-            this.setMetadata(data.metadata);
-        if (data?.allowExecuteByBots !== undefined)
-            this.setAllowExecuteByBots(true);
-        if (data?.allowExecuteInDM !== undefined)
-            this.setAllowExecuteInDM(true);
-        if (data?.validateOptions !== undefined)
-            this.setValidateOptions(true);
-        if (data?.options !== undefined)
-            this.options = data.options.map(o => (o instanceof MessageCommandOptionBuilder_1.MessageCommandOptionBuilder ? o : new MessageCommandOptionBuilder_1.MessageCommandOptionBuilder(o)));
-    }
-    /**
-     * Sets the command name
-     * @param name Command name
-     */
-    setName(name) {
-        if (!name || typeof name !== 'string' || !name.match(/^[\w-]{1,32}$/))
-            throw new TypeError('name must be a string and match the regex /^[\\w-]{1,32}$/');
-        this.name = name;
-        return this;
-    }
-    /**
-     * Sets the command description
-     * @param description Command description
-     */
-    setDescription(description) {
-        if (!description || typeof description !== 'string')
-            throw new TypeError('description must be a string.');
-        this.description = description;
-        return this;
-    }
-    /**
-     * Add aliases to the command
-     * @param aliases Command aliases
-     */
-    addAliases(...aliases) {
-        aliases = (0, discord_js_1.normalizeArray)(aliases);
-        if (!aliases.length)
-            throw new TypeError('Provide atleast one alias');
-        if (aliases.some(a => !a || typeof a !== 'string' || a.match(/^\s+$/)))
-            throw new TypeError('aliases must be strings and should not contain whitespaces');
-        if (this.name && aliases.some(a => a == this.name))
-            throw new TypeError('alias cannot have same name to its real command name');
-        this.aliases = [...new Set(aliases.map(s => s.toLowerCase()))];
-        return this;
-    }
-    /**
-     * Set if command can be executed in dms
-     * @param allowExecuteInDM `true` if the command can execute in DMs
-     */
-    setAllowExecuteInDM(allowExecuteInDM) {
-        if (typeof allowExecuteInDM !== 'boolean')
-            throw new TypeError('allowExecuteInDM must be a boolean.');
-        this.allowExecuteInDM = allowExecuteInDM;
-        return this;
-    }
-    /**
-     * Allow command to be executed by bots
-     * @param allowExecuteByBots `true` if the command can be executed by bots
-     */
-    setAllowExecuteByBots(allowExecuteByBots) {
-        if (typeof allowExecuteByBots !== 'boolean')
-            throw new TypeError('allowExecuteByBots must be a boolean.');
-        this.allowExecuteByBots = allowExecuteByBots;
-        return this;
-    }
-    /**
-     * Add option to the command
-     * @param option Message option builder
-     */
-    addOption(option) {
-        if (!option)
-            throw new TypeError('option must be a MessageOption.');
-        option = typeof option === 'function' ? option(new MessageCommandOptionBuilder_1.MessageCommandOptionBuilder()) : option;
-        if (this.options.find(o => o.name === option.name))
-            throw new TypeError('option with name "' + option.name + '" already exists.');
-        if (this.options.length > 0 && !this.options[this.options.length - 1 < 0 ? 0 : this.options.length - 1].required && option.required)
-            throw new TypeError('All required options must be before optional options.');
-        this.options.push(option);
-        return this;
-    }
-    /**
-     * Validate options before executing
-     * @param validateOptions `true` if the command options needs to be validated before executing
-     */
-    setValidateOptions(validateOptions) {
-        if (typeof validateOptions !== 'boolean')
-            throw new TypeError('validateOptions must be a boolean.');
-        this.validateOptions = validateOptions;
-        return this;
-    }
-    setCooldown(cooldown) {
-        this.cooldown = cooldown;
-        return this;
-    }
-    setRequiredBotPermissions(...permissions) {
-        this.requiredBotPermissions = (0, discord_js_1.normalizeArray)(permissions);
-        return this;
-    }
-    setRequiredMemberPermissions(...permissions) {
-        this.requiredMemberPermissions = (0, discord_js_1.normalizeArray)(permissions);
-        return this;
-    }
-    setHalt(halt) {
-        this.halt = halt ?? undefined;
-        return this;
-    }
-    setExecute(execute) {
-        if (!execute || typeof execute !== 'function')
-            throw new TypeError('execute must be a function.');
-        this.execute = execute;
-        return this;
-    }
-    setMetadata(metadata) {
-        this.metadata = metadata;
-        return this;
-    }
-    /**
-     * Returns JSON object of this builder
-     */
-    toJSON() {
-        return {
-            type: this.type,
-            name: this.name,
-            description: this.description,
-            aliases: this.aliases,
-            cooldown: this.cooldown,
-            requiredBotPermissions: this.requiredBotPermissions,
-            requiredMemberPermissions: this.requiredMemberPermissions,
-            halt: this.halt,
-            execute: this.execute,
-            metadata: this.metadata,
-            allowExecuteByBots: this.allowExecuteByBots,
-            allowExecuteInDM: this.allowExecuteInDM,
-            validateOptions: this.validateOptions,
-            options: this.options.map(o => o.toJSON()),
-        };
-    }
-    /**
-     * Resolve message command data/builder
-     * @param commandData Command data to resolve
-     */
-    static resolveMessageCommand(commandData) {
-        return this.isMessageCommandBuilder(commandData) ? commandData : new MessageCommandBuilder(commandData);
-    }
-    /**
-     * Is a message command builder
-     * @param builder data to check
-     */
-    static isMessageCommandBuilder(builder) {
-        return builder instanceof MessageCommandBuilder;
-    }
-    /**
-     * Is a message command execute data
-     * @param executeData data to check
-     */
-    static isMessageCommandExecuteData(executeData) {
-        return executeData.builder !== undefined && this.isMessageCommandBuilder(executeData.builder);
-    }
-}
-exports.MessageCommandBuilder = MessageCommandBuilder;
-/**
- * Validate message command options
- * @param builder Command builder
- * @param options Parsed command args
- */
-async function validateMessageCommandOptions(builder, options) {
-    const args = options.args || [];
-    const required = builder.options.filter(o => o.required);
-    const optional = builder.options.filter(o => !o.required);
-    const allOptions = [...required, ...optional];
-    const result = [];
-    let i = 0;
-    for (const option of allOptions) {
-        const arg = args[i];
-        const value = {
-            name: option.name,
-            value: arg ?? undefined,
-            required: option.required,
-            invalid: false,
-            missing: false,
-        };
-        if (arg == undefined && option.required) {
-            value.missing = true;
-            result.push(value);
-            continue;
-        }
-        if (arg == undefined && !option.required) {
-            result.push(value);
-            continue;
-        }
-        const validate = option.validator ? await Promise.resolve(option.validator(arg)) : true;
-        if (!validate)
-            value.invalid = true;
-        result.push(value);
-        i++;
-    }
-    return new MessageCommandOptionManager_1.MessageCommandOptionManager(...result);
-}
-exports.validateMessageCommandOptions = validateMessageCommandOptions;