reciple 6.0.0-dev.3 → 6.0.0-dev.30

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 { RecipleModule } from '../classes/RecipleModule';
 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 UserHasCommandPermissionsOptions {
     /**
      * Command builder
@@ -33,8 +19,84 @@ 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;
 }
+//# sourceMappingURL=paramOptions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"paramOptions.d.ts","sourceRoot":"","sources":["../../../../src/reciple/types/paramOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAE/C,MAAM,WAAW,gCAAgC;IAC7C;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC;IAC3B;;OAEG;IACH,iBAAiB,CAAC,EAAE,mBAAmB,CAAC;IACxC;;OAEG;IACH,kBAAkB,CAAC,EAAE;QACjB,OAAO,EAAE,OAAO,CAAC;QACjB,QAAQ,EAAE,wBAAwB,EAAE,CAAC;KACxC,CAAC;CACL;AAED,MAAM,WAAW,sCAAsC;IACnD;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,kCAAkC;IAC/C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,gCAAgC;IAC7C;;OAEG;IACH,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,+BAA+B;IAC5C;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,iCAAiC;IAC9C;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B"}

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

@@ -1,12 +1,27 @@
+/// <reference types="node" />
+import { Logger } from 'fallout-utility';
 import { AnyCommandBuilder } from './types/builders';
+import _path from 'path';
 /**
  * Check if an object is a class
  * @param object Object to identify
  */
-export declare function isClass<T = any>(object: any): object is T;
+export declare function isClass<T>(object: any): object is T;
 /**
  * Emit process warning about deprecated method/function
  * @param content Warning content
  */
 export declare function deprecationWarning(content: string | Error): void;
-export declare function validateCommandBuilder(command: AnyCommandBuilder): boolean;
+export declare function validateCommandBuilder(command: AnyCommandBuilder): command is AnyCommandBuilder;
+/**
+ * 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;
+/**
+ * Path module that depending on os
+ */
+export declare const path: _path.PlatformPath;
+//# sourceMappingURL=util.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../src/reciple/util.ts"],"names":[],"mappings":";AAAA,OAAO,EAAsB,MAAM,EAAiB,MAAM,iBAAiB,CAAC;AAC5E,OAAO,EAAE,iBAAiB,EAAe,MAAM,kBAAkB,CAAC;AAGlE,OAAO,KAAK,MAAM,MAAM,CAAC;AAEzB;;;GAGG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,CAAC,CAMnD;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,CAEhE;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,IAAI,iBAAiB,CAK/F;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,EAAE,OAAO,EAAE,SAAS,GAAE,OAAe,EAAE,eAAe,GAAE,OAAc,GAAG,MAAM,CAoBxH;AAED;;GAEG;AACH,eAAO,MAAM,IAAI,EAAE,KAAK,CAAC,YAA8E,CAAC"}

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

@@ -23,3 +23,4 @@ export declare function parseVersion(ver: string): semver.SemVer | null;
  * @param supportedVersion Version to match given version range
  */
 export declare function isSupportedVersion(versionRange: string, supportedVersion?: string): boolean;
+//# sourceMappingURL=version.d.ts.map

package/dist/types/reciple/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/reciple/version.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B;;GAEG;AACH,eAAO,MAAM,OAAO,QAA+D,CAAC;AAEpF;;GAEG;AACH,eAAO,MAAM,UAAU,KAA2C,CAAC;AAEnE;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,WAEzC;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,wBAIvC;AACD;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,WAOjF"}

package/package.json

@@ -1,18 +1,29 @@
 {
   "name": "reciple",
-  "version": "6.0.0-dev.3",
-  "bin": "./dist/cjs/bin.js",
+  "type": "commonjs",
   "license": "GPL-3.0",
-  "main": "./dist/cjs/index.js",
-  "types": "./dist/types/index.d.ts",
-  "module": "./dist/mjs/index.js",
+  "engineStrict": true,
+  "version": "6.0.0-dev.30",
   "author": "FalloutStudios",
-  "description": "Handler for Discord.js",
+  "main": "./dist/lib/index.js",
+  "module": "./dist/lib/esm.mjs",
+  "types": "./dist/types/index.d.ts",
+  "description": "A simple Discord.js handler that just works",
   "homepage": "https://reciple.js.org",
+  "bin": {
+    "reciple": "./dist/lib/bin.mjs"
+  },
   "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",
@@ -25,53 +36,52 @@
   "bugs": {
     "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"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/FalloutStudios/reciple.git"
-  },
-  "engineStrict": true,
   "engines": {
     "node": ">=16.9.0"
   },
+  "workspaces": [
+    "test"
+  ],
   "files": [
     "dist",
     "resource",
     "LICENSE",
     "README.md"
   ],
+  "scripts": {
+    "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",
+    "url": "git+https://github.com/FalloutStudios/reciple.git"
+  },
   "dependencies": {
     "chalk": "4.1.2",
     "commander": "^9.4.1",
     "dotenv": "^16.0.3",
-    "fallout-utility": "^1.5.4",
+    "fallout-utility": "^1.5.17",
+    "micromatch": "^4.0.5",
     "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/micromatch": "^4.0.2",
+    "@types/node": "^18.11.9",
+    "@types/semver": "^7.3.13",
     "discord.js": "^14.6.0",
-    "prettier": "2.7.1",
+    "prettier": "^2.7.1",
     "rimraf": "^3.0.2",
-    "typescript": "^4.8.4"
+    "typescript": "^4.9.3"
   },
   "peerDependencies": {
     "discord.js": "^14.5.0"
-  },
-  "workspaces": [
-    "test"
-  ],
-  "packageManager": "yarn@3.2.2"
-}
+  }
+}

package/resource/reciple.yml

@@ -1,117 +1,120 @@
-# Your bot token here
-# To use env variable as a token just do it like this env:TOKEN_ENV
-token: TOKEN
-
-# Commands options
-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
-    # allow executing commands via aliases
-    allowCommandAlias: true
-    # command argument separator
-    commandArgumentSeparator: ' '
-    # overwrite command permissions
-    permissions:
-      # enable overwriten command permissions
-      enabled: false
-      commands:
-        - command: example-command
-          permissions:
-            - Administrator
-
-  # Interaction command options
-  slashCommand:
-    # enable interaction commands
-    enabled: true
-    # 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: []
-    # overwrite command permissions
-    permissions:
-      # enable overwriten command permissions
-      enabled: false
-      commands:
-        - command: example-command
-          permissions:
-            - Administrator
-
-
-# Logger options
-fileLogging:
-  # enable console output to file
-  enabled: true
-  # enable debug mode
-  debugmode: false
-  # enable if reciple will use the logger
-  clientLogs: true
-  # stringify logged JSONs
-  stringifyLoggedJSON: false
-  # log file path
-  logFilePath: logs/latest.log
-
-# Client options
-# Learn more about client options at https://discord.js.org/#/docs/discord.js/main/typedef/ClientOptions
-client:
-  intents:
-    - Guilds
-    - GuildMembers
-    - GuildMessages
-    - MessageContent
-
-# Bot messages
-messages:
-  missingArguments: Not enough arguments.
-  invalidArguments: Invalid argument(s) given.
-  insufficientBotPerms:
-    content: Insufficient bot permissions.
-    ephemeral: true
-  noPermissions:
-    content: You do not have permission to use this command.
-    ephemeral: true
-  cooldown:
-    content: You cannot execute this command right now due to the cooldown.
-    ephemeral: true
-  error:
-    content: An error occurred.
-    ephemeral: true
-
-# Ignored Files
-ignoredFiles: []
-
-
-####################################################
-#                                                  #
-#    #####  #####  #    #   ###   #####  ####      #
-#    #   #  #   #  # #  #  #      #      #   #     #
-#    #   #  #####  #  # #  # ###  ###    ####      #
-#    #  #   #   #  #    #  #   #  #      #   #     #
-#    ###    #   #  #    #   ###   #####  #    #    #
-#                                                  #
-####################################################
-## Modifying the values below could break reciple ##
-
-# Modules folder
-modulesFolder: 'modules'
-
-# Load modules regardless of its supported versions
-disableVersionCheck: false
-
-# Current version
-version: ^VERSION
+# Your bot token here
+# To use env variable as a token just do it like this env:TOKEN_ENV
+token: TOKEN
+
+# Commands options
+commands:
+  # Interaction command options
+  slashCommand:
+    # enable interaction commands
+    enabled: true
+    # reply when an error occured
+    replyOnError: false
+    # enable the use of command cooldowns
+    enableCooldown: true
+    # 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
+      enabled: false
+      commands:
+        - command: example-command
+          permissions:
+            - Administrator
+
+  # 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
+    # allow executing commands via aliases
+    allowCommandAlias: true
+    # command argument separator
+    commandArgumentSeparator: ' '
+    # overwrite command permissions
+    permissions:
+      # enable overwriten command permissions
+      enabled: false
+      commands:
+        - command: example-command
+          permissions:
+            - Administrator
+
+# Logger options
+fileLogging:
+  # enable console output to file
+  enabled: true
+  # enable debug mode
+  debugmode: false
+  # enable if reciple will use the logger
+  clientLogs: true
+  # stringify logged JSONs
+  stringifyLoggedJSON: false
+  # log file path
+  logFilePath: logs/latest.log
+
+# Client options
+# Learn more about client options at https://discord.js.org/#/docs/discord.js/main/typedef/ClientOptions
+client:
+  intents:
+    - Guilds
+    - GuildMembers
+    - GuildMessages
+    - MessageContent
+
+# Bot messages
+messages:
+  missingArguments: Not enough arguments.
+  invalidArguments: Invalid argument(s) given.
+  insufficientBotPerms:
+    content: Insufficient bot permissions.
+    ephemeral: true
+  noPermissions:
+    content: You do not have permission to use this command.
+    ephemeral: true
+  cooldown:
+    content: You cannot execute this command right now due to the cooldown.
+    ephemeral: true
+  error:
+    content: An error occurred.
+    ephemeral: true
+
+# Ignored Files
+ignoredFiles:
+  - '_*'
+  - '.*'
+
+
+####################################################
+#                                                  #
+#    #####  #####  #    #   ###   #####  ####      #
+#    #   #  #   #  # #  #  #      #      #   #     #
+#    #   #  #####  #  # #  # ###  ###    ####      #
+#    #  #   #   #  #    #  #   #  #      #   #     #
+#    ###    #   #  #    #   ###   #####  #    #    #
+#                                                  #
+####################################################
+## Modifying the values below could break reciple ##
+
+# Modules folder
+modulesFolder: 'modules'
+
+# Load modules regardless of its supported versions
+disableVersionCheck: false
+
+# Current version
+version: ^VERSION

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);
-    });
-})();