reciple 6.0.0-dev.1 → 6.0.0-dev.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/dist/cjs/bin.js +11 -7
  2. package/dist/cjs/index.js +3 -3
  3. package/dist/cjs/reciple/classes/RecipleClient.js +86 -45
  4. package/dist/cjs/reciple/classes/RecipleConfig.js +9 -2
  5. package/dist/cjs/reciple/classes/RecipleModule.js +94 -0
  6. package/dist/cjs/reciple/classes/builders/MessageCommandBuilder.js +6 -4
  7. package/dist/cjs/reciple/classes/builders/SlashCommandBuilder.js +12 -23
  8. package/dist/cjs/reciple/classes/managers/ApplicationCommandManager.js +32 -33
  9. package/dist/cjs/reciple/classes/managers/ClientCommandManager.js +14 -14
  10. package/dist/cjs/reciple/classes/managers/ClientModuleManager.js +93 -115
  11. package/dist/cjs/reciple/classes/managers/CommandCooldownManager.js +7 -1
  12. package/dist/cjs/reciple/permissions.js +3 -4
  13. package/dist/cjs/reciple/types/builders.js +6 -6
  14. package/dist/cjs/reciple/util.js +36 -2
  15. package/dist/types/index.d.ts +3 -3
  16. package/dist/types/reciple/classes/RecipleClient.d.ts +3 -6
  17. package/dist/types/reciple/classes/RecipleModule.d.ts +56 -0
  18. package/dist/types/reciple/classes/builders/MessageCommandBuilder.d.ts +6 -6
  19. package/dist/types/reciple/classes/builders/SlashCommandBuilder.d.ts +17 -17
  20. package/dist/types/reciple/classes/managers/ApplicationCommandManager.d.ts +6 -11
  21. package/dist/types/reciple/classes/managers/ClientCommandManager.d.ts +3 -3
  22. package/dist/types/reciple/classes/managers/ClientModuleManager.d.ts +10 -70
  23. package/dist/types/reciple/classes/managers/CommandCooldownManager.d.ts +2 -2
  24. package/dist/types/reciple/types/builders.d.ts +19 -19
  25. package/dist/types/reciple/types/commands.d.ts +10 -10
  26. package/dist/types/reciple/types/paramOptions.d.ts +1 -16
  27. package/dist/types/reciple/util.d.ts +8 -0
  28. package/package.json +17 -13
  29. package/dist/cjs/reciple/logger.js +0 -35
  30. package/dist/cjs/reciple/modules.js +0 -113
  31. package/dist/types/reciple/logger.d.ts +0 -8
  32. package/dist/types/reciple/modules.d.ts +0 -64
  33. package/docs/README.md +0 -1
package/package.json CHANGED
@@ -1,17 +1,18 @@
1
1
  {
2
2
  "name": "reciple",
3
- "version": "6.0.0-dev.1",
3
+ "version": "6.0.0-dev.10",
4
4
  "bin": "./dist/cjs/bin.js",
5
5
  "license": "GPL-3.0",
6
6
  "main": "./dist/cjs/index.js",
7
- "typings": "./dist/types/index.d.ts",
7
+ "types": "./dist/types/index.d.ts",
8
8
  "module": "./dist/mjs/index.js",
9
9
  "author": "FalloutStudios",
10
10
  "description": "Handler for Discord.js",
11
11
  "homepage": "https://reciple.js.org",
12
12
  "exports": {
13
13
  "require": "./dist/cjs/index.js",
14
- "import": "./dist/mjs/index.js"
14
+ "import": "./dist/mjs/index.js",
15
+ "types": "./dist/types/index.d.ts"
15
16
  },
16
17
  "keywords": [
17
18
  "Discord",
@@ -25,13 +26,15 @@
25
26
  "url": "https://github.com/FalloutStudios/reciple/issues"
26
27
  },
27
28
  "scripts": {
28
- "clean": "yarn exec rimraf dist",
29
- "build": "yarn clean && yarn exec tsc",
30
- "build:publish": "yarn build && yarn docs && yarn npm publish",
31
- "build:publish-dev": "yarn build && yarn npm publish --tag dev",
32
- "test": "yarn build && yarn workspace test start",
33
- "docs": "yarn exec docgen --typescript true -c ./docs/index.json -o ./docs/docs.json -i src/index.ts",
34
- "watch": "yarn exec tsc --watch --noEmit"
29
+ "format": "npx prettier --write src",
30
+ "clean": "npx rimraf dist",
31
+ "build": "npm run clean && npx tsc",
32
+ "build:publish": "npm run format && npm run build && npx docs && npm publish",
33
+ "build:publish-dev": "npm run format && npm run build && npm publish --tag dev",
34
+ "test": "npm run build && npm run start -w test",
35
+ "docs": "npx docgen --typescript true -c ./docs/index.json -o ./docs/docs.json -i src/index.ts",
36
+ "watch": "npx tsc --watch --noEmit",
37
+ "husky:install": "npx husky install"
35
38
  },
36
39
  "repository": {
37
40
  "type": "git",
@@ -61,6 +64,8 @@
61
64
  "@types/node": "^18.11.0",
62
65
  "@types/semver": "^7.3.12",
63
66
  "discord.js": "^14.6.0",
67
+ "husky": "^8.0.1",
68
+ "prettier": "2.7.1",
64
69
  "rimraf": "^3.0.2",
65
70
  "typescript": "^4.8.4"
66
71
  },
@@ -69,6 +74,5 @@
69
74
  },
70
75
  "workspaces": [
71
76
  "test"
72
- ],
73
- "packageManager": "yarn@3.2.2"
74
- }
77
+ ]
78
+ }
@@ -1,35 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.createLogger = void 0;
7
- const fallout_utility_1 = require("fallout-utility");
8
- const flags_1 = require("./flags");
9
- const chalk_1 = __importDefault(require("chalk"));
10
- /**
11
- * Create new logger
12
- * @param stringifyJSON stringify json objects in console
13
- * @param debugmode display debug messages
14
- * @param colorizeMessage add logger colours to messages
15
- */
16
- function createLogger(stringifyJSON, debugmode = false, colorizeMessage = true) {
17
- return new fallout_utility_1.Logger({
18
- stringifyJSON: stringifyJSON,
19
- enableDebugMode: flags_1.flags.debugmode ?? debugmode,
20
- loggerName: 'Main',
21
- prefixes: {
22
- [fallout_utility_1.LogLevels.INFO]: (name) => `[${new Date().toLocaleTimeString(undefined, { hour12: false })}][${(name ? name + "/" : '') + "INFO"}]`,
23
- [fallout_utility_1.LogLevels.WARN]: (name) => `[${chalk_1.default.yellow(new Date().toLocaleTimeString(undefined, { hour12: false }))}][${chalk_1.default.yellow((name ? name + "/" : '') + "WARN")}]`,
24
- [fallout_utility_1.LogLevels.ERROR]: (name) => `[${chalk_1.default.red(new Date().toLocaleTimeString(undefined, { hour12: false }))}][${chalk_1.default.red((name ? name + "/" : '') + "ERROR")}]`,
25
- [fallout_utility_1.LogLevels.DEBUG]: (name) => `[${chalk_1.default.blue(new Date().toLocaleTimeString(undefined, { hour12: false }))}][${chalk_1.default.blue((name ? name + "/" : '') + "DEBUG")}]`
26
- },
27
- colorMessages: {
28
- [fallout_utility_1.LogLevels.INFO]: (message) => message,
29
- [fallout_utility_1.LogLevels.WARN]: (message) => !colorizeMessage ? message : chalk_1.default.yellow(message),
30
- [fallout_utility_1.LogLevels.ERROR]: (message) => !colorizeMessage ? message : chalk_1.default.red(message),
31
- [fallout_utility_1.LogLevels.DEBUG]: (message) => !colorizeMessage ? message : chalk_1.default.blue(message)
32
- }
33
- });
34
- }
35
- exports.createLogger = createLogger;
@@ -1,113 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
- Object.defineProperty(o, "default", { enumerable: true, value: v });
15
- }) : function(o, v) {
16
- o["default"] = v;
17
- });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
25
- var __importDefault = (this && this.__importDefault) || function (mod) {
26
- return (mod && mod.__esModule) ? mod : { "default": mod };
27
- };
28
- Object.defineProperty(exports, "__esModule", { value: true });
29
- exports.getModules = void 0;
30
- const builders_1 = require("./types/builders");
31
- const MessageCommandBuilder_1 = require("./classes/builders/MessageCommandBuilder");
32
- const SlashCommandBuilder_1 = require("./classes/builders/SlashCommandBuilder");
33
- const discord_js_1 = require("discord.js");
34
- const version_1 = require("./version");
35
- const fs_1 = require("fs");
36
- const wildcard_match_1 = __importDefault(require("wildcard-match"));
37
- const flags_1 = require("./flags");
38
- const path_1 = __importDefault(require("path"));
39
- /**
40
- * Load modules from folder
41
- * @param client Reciple client
42
- * @param folder Modules folder
43
- */
44
- async function getModules(client, folder) {
45
- const response = { commands: [], modules: [] };
46
- const modulesDir = folder || path_1.default.join(flags_1.cwd, 'modules');
47
- if (!(0, fs_1.existsSync)(modulesDir))
48
- (0, fs_1.mkdirSync)(modulesDir, { recursive: true });
49
- const ignoredFiles = (client.config.ignoredFiles || []).map(file => file.endsWith('.js') ? file : `${file}.js`);
50
- const scripts = (0, fs_1.readdirSync)(modulesDir).filter(file => {
51
- return file.endsWith('.js') && (!file.startsWith('_') && !file.startsWith('.')) && !ignoredFiles.some(f => (0, wildcard_match_1.default)(f)(file));
52
- });
53
- for (const script of scripts) {
54
- const modulePath = path_1.default.join(modulesDir, script);
55
- const commands = [];
56
- let module_;
57
- try {
58
- const reqMod = await Promise.resolve().then(() => __importStar(require(modulePath)));
59
- module_ = reqMod?.default !== undefined ? reqMod.default : reqMod;
60
- if (typeof module_ !== 'object')
61
- throw new Error(`Module ${modulePath} is not an object`);
62
- if (!client.config.disableVersionCheck && !module_?.versions?.length)
63
- throw new Error(`${modulePath} does not have supported versions.`);
64
- const versions = (0, discord_js_1.normalizeArray)([module_.versions]);
65
- if (!client.config.disableVersionCheck && !versions.some(v => (0, version_1.isSupportedVersion)(v, version_1.version)))
66
- throw new Error(`${modulePath} is unsupported; current version: ${version_1.version}; module supported versions: ` + versions.join(', ') ?? 'none');
67
- if (!await Promise.resolve(module_.onStart(client)).catch(() => false))
68
- throw new Error(script + ' onStart returned false or undefined.');
69
- if (module_.commands) {
70
- for (const command of module_.commands) {
71
- if (command.type === builders_1.CommandBuilderType.MessageCommand) {
72
- commands.push(MessageCommandBuilder_1.MessageCommandBuilder.resolveMessageCommand(command));
73
- }
74
- else if (command.type === builders_1.CommandBuilderType.SlashCommand) {
75
- commands.push(SlashCommandBuilder_1.SlashCommandBuilder.resolveSlashCommand(command));
76
- }
77
- }
78
- }
79
- }
80
- catch (error) {
81
- if (client.isClientLogsEnabled()) {
82
- client.logger.error(`Failed to load module ${script}`);
83
- client.logger.error(error);
84
- }
85
- continue;
86
- }
87
- response.commands.push(...commands.filter((c) => {
88
- if (!c.name) {
89
- if (client.isClientLogsEnabled())
90
- client.logger.error(`A ${builders_1.CommandBuilderType[c.type]} command name is not defined in ${modulePath}`);
91
- return false;
92
- }
93
- if (c.type === builders_1.CommandBuilderType.MessageCommand && c.options.length && c.options.some(o => !o.name)) {
94
- if (client.isClientLogsEnabled())
95
- client.logger.error(`A ${builders_1.CommandBuilderType[c.type]} option name is not defined in ${modulePath}`);
96
- return false;
97
- }
98
- return true;
99
- }));
100
- response.modules.push({
101
- script: module_,
102
- info: {
103
- filename: script,
104
- versions: (0, discord_js_1.normalizeArray)([module_.versions]),
105
- path: modulePath
106
- }
107
- });
108
- if (client.isClientLogsEnabled())
109
- client.logger.info(`Loaded module ${modulePath}`);
110
- }
111
- return response;
112
- }
113
- exports.getModules = getModules;
@@ -1,8 +0,0 @@
1
- import { Logger } from 'fallout-utility';
2
- /**
3
- * Create new logger
4
- * @param stringifyJSON stringify json objects in console
5
- * @param debugmode display debug messages
6
- * @param colorizeMessage add logger colours to messages
7
- */
8
- export declare function createLogger(stringifyJSON: boolean, debugmode?: boolean, colorizeMessage?: boolean): Logger;
@@ -1,64 +0,0 @@
1
- import { AnyCommandBuilder, AnyCommandData } from './types/builders';
2
- import { RecipleClient } from './classes/RecipleClient';
3
- /**
4
- * Loaded modules and commands
5
- */
6
- export interface LoadedModules {
7
- commands: AnyCommandBuilder[];
8
- modules: RecipleModule[];
9
- }
10
- /**
11
- * Reciple script object
12
- */
13
- export interface RecipleScript {
14
- /**
15
- * Supported reciple versions
16
- */
17
- versions: string | string[];
18
- /**
19
- * Module commands
20
- */
21
- commands?: (AnyCommandBuilder | AnyCommandData)[];
22
- /**
23
- * Action on bot ready
24
- * @param client Bot client
25
- */
26
- onLoad?(client: RecipleClient<true>): void | Promise<void>;
27
- /**
28
- * Action on module start
29
- * @param client Bot client
30
- */
31
- onStart(client: RecipleClient<false>): boolean | Promise<boolean>;
32
- }
33
- /**
34
- * Reciple module object
35
- */
36
- export interface RecipleModule {
37
- /**
38
- * Module script
39
- */
40
- script: RecipleScript;
41
- /**
42
- * Module local information
43
- */
44
- info: {
45
- /**
46
- * Module file name
47
- */
48
- filename?: string;
49
- /**
50
- * Supported reciple versions
51
- */
52
- versions: string[];
53
- /**
54
- * Module local file path
55
- */
56
- path?: string;
57
- };
58
- }
59
- /**
60
- * Load modules from folder
61
- * @param client Reciple client
62
- * @param folder Modules folder
63
- */
64
- export declare function getModules(client: RecipleClient, folder?: string): Promise<LoadedModules>;
package/docs/README.md DELETED
@@ -1 +0,0 @@
1
- # [VIEW DOCS](https://reciple.js.org/#/docs)