keanucode
/
TravBot-v3
mirror of https://github.com/keanuplayz/TravBot-v3.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added husky.

This commit is contained in:
Keanu Timmermans 2020-10-15 09:23:24 +00:00 committed by GitHub
parent 57433cc594
commit 74b4d4272c
36 changed files with 2677 additions and 2226 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/codeql/codeql-config.yml vendored
View File

@ -1,4 +1,4 @@
name: "CodeQL Config"
name: 'CodeQL Config'
queries:
- uses: security-and-quality

42
.github/workflows/codeql-analysis.yml vendored
View File

@ -1,4 +1,4 @@
name: "CodeQL"
name: 'CodeQL'
on:
push:
@ -14,28 +14,28 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
with:
fetch-depth: 2
- name: Checkout repository
uses: actions/checkout@v2
with:
fetch-depth: 2
- run: git checkout HEAD^2
if: ${{ github.event_name == 'pull_request' }}
- run: git checkout HEAD^2
if: ${{ github.event_name == 'pull_request' }}
- name: Setup Node.JS
uses: actions/setup-node@v2-beta
with:
node-version: '12'
- run: npm ci
- name: Setup Node.JS
uses: actions/setup-node@v2-beta
with:
node-version: '12'
- run: npm ci
- name: Build codebase
run: npm run build
- name: Build codebase
run: npm run build
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
config-file: ./.github/codeql/codeql-config.yml
languages: javascript
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
config-file: ./.github/codeql/codeql-config.yml
languages: javascript
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1

2
.github/workflows/image.yml vendored
View File

@ -1,7 +1,7 @@
name: Build Docker Image + Push
on:
push:
branches:
branches:
- typescript
- docker

1
.husky/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
_

4
.husky/pre-commit Executable file
View File

@ -0,0 +1,4 @@
#!/bin/sh
. "$(dirname $0)/_/husky.sh"
npm test && npx prettier --write .

71
.prettierignore Normal file
View File

@ -0,0 +1,71 @@
# Specific to this repository
dist/
data/
docs/
tmp/
test*
!test/
*.bat
desktop.ini
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
# nyc test coverage
.nyc_output
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# Bower dependency directory (https://bower.io/)
bower_components
# node-waf configuration
.lock-wscript
# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release
# Dependency directories
node_modules/
jspm_packages/
# Typescript v1 declaration files
typings/
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variables file
.env
config.json
.vscode/

2
README.md
View File

@ -13,7 +13,7 @@ Thank you for coming on this journey with me, but it is time to put the big chan
Special thanks to:
- Lexi Sother (TravBot v2, structural overhaul. Reviewing PRs.)
- WatDuhHekBro (a *lot* of contributions to TravBot v2)
- WatDuhHekBro (a _lot_ of contributions to TravBot v2)
- Zeehondie (Ideas for various commands.)
### License

146
docs/Documentation.md
View File

@ -1,128 +1,158 @@
# What this is
This is a user-friendly version of the project's structure (compared to the amalgamation that has become [specifications](Specifications.md) which is just a list of design decisions and isn't actually helpful at all for understanding the code). This will follow the line of logic that the program would run through.
# Building/Setup
- `npm run dev` runs the TypeScript compiler in watch mode, meaning that any changes you make to the code will automatically reload the bot.
- This will take all the files in `src` (where all the code is) and compile it into `dist` which is what the program actually uses.
- If there's a runtime error, `dist\commands\test.js:25:30` for example, then you have to into `dist` instead of `src`, then find the line that corresponds.
- If there's a runtime error, `dist\commands\test.js:25:30` for example, then you have to into `dist` instead of `src`, then find the line that corresponds.
# Launching
When you start the program, it'll run the code in `index` (meaning both `src/index.ts` and `dist/index.js`, they're the same except that `dist/<...>.js` is compiled). The code in `index` will call `setup` and check if `data/config.json` exists, prompting you if it doesn't. It'll then run initialization code.
# Structure
- `commands` contains all the commands.
- `defs` contains static definitions.
- `core` contains the foundation of the program. You won't need to worry about this unless you're modifying pre-existing behavior of the `Command` class for example or add a function to the library.
- `events` contains all the events. Again, you generally won't need to touch this unless you're listening for a new Discord event.
# The Command Class
A valid command file must be located in `commands` and export a default `Command` instance. Assume that we're working with `commands/money.ts`.
```js
import Command from '../core/command';
export default new Command({
//...
//...
});
```
The `run` property can be either a function or a string. If it's a function, you get one parameter, `$` which represents the common library (see below). If it's a string, it's a variable string.
- `%author%` pings the person who sent the message.
- `%prefix%` gets the bot's current prefix in the selected server.
```js
import Command from '../core/command';
import {CommonLibrary} from '../core/lib';
import { CommonLibrary } from '../core/lib';
export default new Command({
run: "%author%, make sure to use the prefix! (%prefix)"
run: '%author%, make sure to use the prefix! (%prefix)',
});
```
...is equal to...
```js
import Command from '../core/command';
import {CommonLibrary} from '../core/lib';
import {getPrefix} from "../core/structures";
import { CommonLibrary } from '../core/lib';
import { getPrefix } from '../core/structures';
export default new Command({
async run($: CommonLibrary): Promise<any> {
$.channel.send(`${$.author.toString()}, make sure to use the prefix! (${getPrefix($.guild)})`);
}
async run($: CommonLibrary): Promise<any> {
$.channel.send(
`${$.author.toString()}, make sure to use the prefix! (${getPrefix(
$.guild,
)})`,
);
},
});
```
Now here's where it gets fun. The `Command` class is a recursive structure, containing other `Command` instances as properties.
- `subcommands` is used for specific keywords for accessing a certain command. For example, `$eco pay` has a subcommand of `pay`.
```js
import Command from '../core/command';
import {CommonLibrary} from '../core/lib';
import { CommonLibrary } from '../core/lib';
export default new Command({
subcommands: {
pay: new Command({
//...
})
}
subcommands: {
pay: new Command({
//...
}),
},
});
```
There's also `user` which listens for a ping or a Discord ID, `<@237359961842253835>` and `237359961842253835` respectively. The argument will be a `User` object.
```js
import Command from '../core/command';
import {CommonLibrary} from '../core/lib';
import { CommonLibrary } from '../core/lib';
export default new Command({
user: new Command({
async run($: CommonLibrary): Promise<any> {
$.debug($.args[0].username); // "WatDuhHekBro"
}
})
user: new Command({
async run($: CommonLibrary): Promise<any> {
$.debug($.args[0].username); // "WatDuhHekBro"
},
}),
});
```
There's also `number` which checks for any number type except `Infinity`, converting the argument to a `number` type.
```js
import Command from '../core/command';
import {CommonLibrary} from '../core/lib';
import { CommonLibrary } from '../core/lib';
export default new Command({
number: new Command({
async run($: CommonLibrary): Promise<any> {
$.debug($.args[0] + 5);
}
})
number: new Command({
async run($: CommonLibrary): Promise<any> {
$.debug($.args[0] + 5);
},
}),
});
```
And then there's `any` which catches everything else that doesn't fall into the above categories. The argument will be a `string`.
```js
import Command from '../core/command';
import {CommonLibrary} from '../core/lib';
import { CommonLibrary } from '../core/lib';
export default new Command({
any: new Command({
async run($: CommonLibrary): Promise<any> {
$.debug($.args[0].toUpperCase());
}
})
any: new Command({
async run($: CommonLibrary): Promise<any> {
$.debug($.args[0].toUpperCase());
},
}),
});
```
Of course, maybe you just want to get string arguments regardless, and since everything is an optional property, so you'd then just include `any` and not `subcommands`, `user`, or `number`.
## Other Properties
- `description`: The description for that specific command.
- `endpoint`: A `boolean` determining whether or not to prevent any further arguments. For example, you could prevent `$money daily too many arguments`.
- `usage`: Provide a custom usage for the help menu. Do note that this is relative to the subcommand, so the below will result in `$money pay <user> <amount>`.
```js
import Command from '../core/command';
import {CommonLibrary} from '../core/lib';
import { CommonLibrary } from '../core/lib';
export default new Command({
subcommands: {
pay: new Command({
usage: "<user> <amount>"
})
}
subcommands: {
pay: new Command({
usage: '<user> <amount>',
}),
},
});
```
- `permission`: The permission to restrict the current command to. You can specify it for certain subcommands, useful for having `$money` be open to anyone but not `$money admin`. If it's `null` (default), the permission will inherit whatever was declared before (if any). The default value is NOT the same as `Command.PERMISSIONS.NONE`.
- `aliases`: A list of aliases (if any).
## Alternatives to Nesting
For a lot of the metadata properties like `description`, you must provide them when creating a new `Command` instance. However, you can freely modify and attach subcommands, useful for splitting a command into multiple files.
```js
import pay from "./subcommands/pay";
@ -141,19 +171,24 @@ export default cmd;
```
## Error Handling
Any errors caused when using `await` or just regular synchronous functions will be automatically caught, you don't need to worry about those. However, promises must be caught manually. For example, `$.channel.send("")` will throw an error because you can't send empty messages to Discord, but since it's a promise, it'll just fade without throwing an error. There are two ways to do this:
- `$.channel.send("").catch($.handler.bind($))`
- `$.channel.send("").catch(error => $.handler(error))`
# The Common Library
This is the container of functions available without having to import `core/lib`, usually as `$`. When accessing this from a command's `run` function, it'll also come with shortcuts to other properties.
## Custom Wrappers
- `$(5)` = `new NumberWrapper(5)`
- `$("text")` = `new StringWrapper("text")`
- `$([1,2,3])` = `new ArrayWrapper([1,2,3])`
## Custom Logger
- `$.log(...)`
- `$.warn(...)`
- `$.error(...)`
@ -161,34 +196,43 @@ This is the container of functions available without having to import `core/lib`
- `$.ready(...)` (only meant to be used once at the start of the program)
## Convenience Functions
This modularizes certain patterns of code to make things easier.
- `$.paginate()`: Takes a message and some additional parameters and makes a reaction page with it. All the pagination logic is taken care of but nothing more, the page index is returned and you have to send a callback to do something with it.
```js
const pages = ["one", "two", "three"];
const pages = ['one', 'two', 'three'];
const msg = await $.channel.send(pages[0]);
$.paginate(msg, $.author.id, pages.length, page => {
msg.edit(pages[page]);
$.paginate(msg, $.author.id, pages.length, (page) => {
msg.edit(pages[page]);
});
```
- `$.prompt()`: Prompts the user about a decision before following through.
```js
const msg = await $.channel.send("Are you sure you want to delete this?");
const msg = await $.channel.send('Are you sure you want to delete this?');
$.prompt(msg, $.author.id, () => {
delete this; // Replace this with actual code.
delete this; // Replace this with actual code.
});
```
- `$.getMemberByUsername()`: Gets a user by their username. Gets the first one then rolls with it.
- `$.callMemberByUsername()`: Convenience function to handle cases where someone isn't found by a username automatically.
```js
$.callMemberByUsername($.message, $.args.join(" "), member => {
$.channel.send(`Your nickname is ${member.nickname}.`);
$.callMemberByUsername($.message, $.args.join(' '), (member) => {
$.channel.send(`Your nickname is ${member.nickname}.`);
});
```
## Dynamic Properties
These will be accessible only inside a `Command` and will change per message.
- `$.args`: A list of arguments in the command. It's relative to the subcommand, so if you do `$test this 5`, `5` becomes `$.args[0]` if `this` is a subcommand. Args are already converted, so a `number` subcommand would return a number rather than a string.
- `$.client`: `message.client`
- `$.message`: `message`
@ -198,22 +242,28 @@ These will be accessible only inside a `Command` and will change per message.
- `$.member`: `message.member`
# Wrappers
This is similar to modifying a primitive object's `prototype` without actually doing so.
## NumberWrapper
- `.pluralise()`: A substitute for not having to do `amount === 1 ? "singular" : "plural"`. For example, `$(x).pluralise("credit", "s")` will return `"1 credit"` and/or `"5 credits"` respectively.
- `.pluraliseSigned()`: This builds on `.pluralise()` and adds a sign at the beginning for marking changes/differences. `$(0).pluraliseSigned("credit", "s")` will return `"+0 credits"`.
## StringWrapper
- `.replaceAll()`: A non-regex alternative to replacing everything in a string. `$("test").replaceAll('t', 'z')` = `"zesz"`.
- `.toTitleCase()`: Capitalizes the first letter of each word. `$("this is some text").toTitleCase()` = `"This Is Some Text"`.
## ArrayWrapper
- `.random()`: Returns a random element from an array. `$([1,2,3]).random()` could be any one of those elements.
- `.split()`: Splits an array into different arrays by a specified length. `$([1,2,3,4,5,6,7,8,9,10]).split(3)` = `[[1,2,3],[4,5,6],[7,8,9],[10]]`.
# Other Library Functions
These do have to be manually imported, which are used more on a case-by-case basis.
- `formatTimestamp()`: Formats a `Date` object into your system's time. `YYYY-MM-DD HH:MM:SS`
- `formatUTCTimestamp()`: Formats a `Date` object into UTC time. `YYYY-MM-DD HH:MM:SS`
- `botHasPermission()`: Tests if a bot has a certain permission in a specified guild.
@ -224,11 +274,13 @@ These do have to be manually imported, which are used more on a case-by-case bas
- `Random`: An object of functions containing stuff related to randomness. `Random.num` is a random decimal, `Random.int` is a random integer, `Random.chance` takes a number ranging from `0` to `1` as a percentage. `Random.sign` takes a number and has a 50-50 chance to be negative or positive. `Random.deviation` takes a number and a magnitude and produces a random number within those confines. `(5, 2)` would produce any number between `3` and `7`.
# Other Core Functions
- `permissions::hasPermission()`: Checks if a `Member` has a certain permission.
- `permissions::getPermissionLevel()`: Gets a `Member`'s permission level according to the permissions enum defined in the file.
- `structures::getPrefix()`: Get the current prefix of the guild or the bot's prefix if none is found.
# The other core files
- `core/permissions`: Contains all the permission roles and checking functions.
- `core/structures`: Contains all the code handling dynamic JSON data. Has a one-to-one connection with each file generated, for example, `Config` which calls `super("config")` meaning it writes to `data/config.json`.
- `core/storage`: Handles most of the file system operations, all of the ones related to `data` at least.
- `core/storage`: Handles most of the file system operations, all of the ones related to `data` at least.

5
docs/GettingStarted.md
View File

@ -1,9 +1,11 @@
# Getting Started
1. `npm install`
2. `npm run build`
3. `npm start`
# Getting Started (Developers)
1. `npm install`
2. `npm run dev`
3. Familiarize yourself with the [project's structure](Documentation.md).
@ -11,6 +13,7 @@
5. Begin developing.
## Don't forget to...
- ...update the [changelog](CHANGELOG.md) and any other necessary docs.
- ...update the version numbers in `package.json` and `package-lock.json`.
- ...make sure the test suite passes by running `npm test`.
- ...make sure the test suite passes by running `npm test`.

27
docs/Specifications.md
View File

@ -1,13 +1,15 @@
# Structure
The top-level directory is reserved for files that have to be there for it to work as well as configuration files.
- `src`: Contains all the code for the bot itself. Code in this directory is for independent tasks keeping the initialization out of the subdirectories.
- `core`: This is where core structures and critical functions for the bot go.
- `modules`: This is where modules go that accomplish one specific purpose but isn't so necessary for the bot to function. The goal is to be able to safely remove these without too much trouble.
- `commands`: Here's the place to store commands. The file name determines the command name.
- `subcommands/`: All commands here are ignored by the category loader. Here is where you can split commands into different files. Also works per directory, for example, `utility/subcommands/` is ignored.
- `<directory>/`: Specify a directory which'll group commands into a category. For example, a `utility` folder would make all commands inside have the `Utility` category.
- `<file>.ts`: All commands at this level will have the `Miscellaneous` category.
- `events`: Here's the place to store events. The file name determines the event type.
- `core`: This is where core structures and critical functions for the bot go.
- `modules`: This is where modules go that accomplish one specific purpose but isn't so necessary for the bot to function. The goal is to be able to safely remove these without too much trouble.
- `commands`: Here's the place to store commands. The file name determines the command name.
- `subcommands/`: All commands here are ignored by the category loader. Here is where you can split commands into different files. Also works per directory, for example, `utility/subcommands/` is ignored.
- `<directory>/`: Specify a directory which'll group commands into a category. For example, a `utility` folder would make all commands inside have the `Utility` category.
- `<file>.ts`: All commands at this level will have the `Miscellaneous` category.
- `events`: Here's the place to store events. The file name determines the event type.
- `dist`: This is where the runnable code in `src` compiles to. (The directory structure mirrors `src`.)
- `test`: Used for all the unit tests.
- `data`: Holds all the dynamic data used by the bot. This is what you modify if you want to change stuff for just your instance of the bot.
@ -15,7 +17,9 @@ The top-level directory is reserved for files that have to be there for it to wo
- `docs`: Used for information about the design of the project.
# Specific Files
This list starts from `src`/`dist`.
- `index`: This is the entry point of the bot. Here is where all the initialization is done, because the idea is to keep repeatable code in separate modules while having code that runs only once here designating this is **the** starting point.
- `setup`: Used for the first time the bot is loaded, walking the user through setting up the bot.
- `core/lib`: Exports a function object which lets you wrap values letting you call special functions as well as calling utility functions common to all commands.
@ -27,6 +31,7 @@ This list starts from `src`/`dist`.
- `core/permissions`: The file containing everything related to permissions.
# Design Decisions
- All top-level files (relative to `src`/`dist`) should ideally be independent, one-time use scripts. This helps separate code that just initializes once and reusable code that forms the bulk of the main program itself. That's why all the file searching and loading commands/events will be done in `index`.
- Wrapper objects were designed with the idea of letting you assign functions directly to native objects [without the baggage of actually doing so](https://developer.mozilla.org/en-US/docs/Web/JavaScript/The_performance_hazards_of__%5B%5BPrototype%5D%5D_mutation).
- `test` should be a keyword for any file not tracked by git and generally be more flexible to play around with. It should also be automatically generated during initialization in `commands` so you can have templates ready for new commands.
@ -37,7 +42,7 @@ This list starts from `src`/`dist`.
- All commands should have only one parameter. This parameter is meant to be flexible so you can add properties without making a laundry list of parameters. It also has convenience functions too so you don't have to import the library for each command.
- The objects in `core/structures` are initialized into a special object once and then cached into memory automatically due to an import system. This means you don't have to keep loading JSON files over and over again even without the stack storage system. Because a JSON file resolves into an object, any extra keys are removed automatically (as it isn't initialized into the data) and any property that doesn't yet exist on the JSON object will be initialized into something. You can then have specific functions like `addUser` onto objects with a specific structure.
- There were several possible ways to go about implementing aliases and subaliases.
- Two properties on the `Command` class, `aliases: string[]` and `subaliases: {[key: string]: string[]}`.
- Exporting a const named `aliases` which would handle top-level aliases.
- For `subaliases`, either making subaliases work like redirects (Instead of doing `new Command(...)`, you'd do `"nameOfSubcommand"`), or define properties on `Command`.
- What I ended up doing for aliases is making an `aliases` property on `Command` and then converting those string arrays to a more usable structure with strings pointing to the original commands. `aliases` at the very top will determine global aliases and is pretty much the exception in the program's logic. `aliases` elsewhere will provide aliases per subcommand. For anything other than the top-level or `subcommands`, `aliases` does nothing (plus you'll get a warning about it).
- Two properties on the `Command` class, `aliases: string[]` and `subaliases: {[key: string]: string[]}`.
- Exporting a const named `aliases` which would handle top-level aliases.
- For `subaliases`, either making subaliases work like redirects (Instead of doing `new Command(...)`, you'd do `"nameOfSubcommand"`), or define properties on `Command`.
- What I ended up doing for aliases is making an `aliases` property on `Command` and then converting those string arrays to a more usable structure with strings pointing to the original commands. `aliases` at the very top will determine global aliases and is pretty much the exception in the program's logic. `aliases` elsewhere will provide aliases per subcommand. For anything other than the top-level or `subcommands`, `aliases` does nothing (plus you'll get a warning about it).

12
package-lock.json generated
View File

@ -610,6 +610,12 @@
"integrity": "sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==",
"dev": true
},
"husky": {
"version": "5.0.0-alpha.6",
"resolved": "https://registry.npmjs.org/husky/-/husky-5.0.0-alpha.6.tgz",
"integrity": "sha512-Ofqq0oHLCO0r8hTb/1PQ3FAfsW945adUli8jFTeXdOIK8gCUmxY9A0BI0mG9oGboPf+Y53bvEmX6ljdrz+yV6w==",
"dev": true
},
"iconv-lite": {
"version": "0.4.24",
"resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz",
@ -1032,6 +1038,12 @@
"integrity": "sha512-q0M/9eZHzmr0AulXyPwNfZjtwZ/RBZlbN3K3CErVrk50T2ASYI7Bye0EvekFY3IP1Nt2DHu0re+V2ZHIpMkuWg==",
"dev": true
},
"prettier": {
"version": "2.1.2",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-2.1.2.tgz",
"integrity": "sha512-16c7K+x4qVlJg9rEbXl7HEGmQyZlG4R9AgP+oHKRMsMsuk8s+ATStlf1NpDqyBI1HpVyfjLOeMhH2LvuNvV5Vg==",
"dev": true
},
"promise.allsettled": {
"version": "1.0.2",
"resolved": "https://registry.npmjs.org/promise.allsettled/-/promise.allsettled-1.0.2.tgz",

4
package.json
View File

@ -3,6 +3,7 @@
"version": "0.0.1",
"description": "A Discord bot built on Discord.JS v12",
"main": "dist/index.js",
"private": true,
"dependencies": {
"chalk": "^4.1.0",
"discord.js": "^12.2.0",
@ -14,12 +15,15 @@
"@types/mocha": "^8.0.3",
"@types/node": "^14.0.22",
"@types/ws": "^7.2.6",
"husky": "^5.0.0-alpha.6",
"mocha": "^8.1.2",
"prettier": "2.1.2",
"ts-node": "^9.0.0",
"tsc-watch": "^4.2.9",
"typescript": "^3.9.6"
},
"scripts": {
"postinstall": "husky install",
"build": "tsc && npm prune --production",
"start": "node dist/index.js",
"once": "tsc && npm start",

13
prettier.config.js Normal file
View File

@ -0,0 +1,13 @@
module.exports = {
printWidth: 80,
tabWidth: 2,
useTabs: false,
semi: true,
singleQuote: true,
quoteProps: 'as-needed',
jsxSingleQuote: false,
trailingComma: 'all',
bracketSpacing: true,
jsxBracketSameLine: true,
arrowParens: 'always',
};

339
src/commands/admin.ts
View File

@ -1,163 +1,188 @@
import Command from "../core/command";
import {CommonLibrary, logs, botHasPermission} from "../core/lib";
import {Config, Storage} from "../core/structures";
import {PermissionNames, getPermissionLevel} from "../core/permissions";
import {Permissions} from "discord.js";
import Command from '../core/command';
import { CommonLibrary, logs, botHasPermission } from '../core/lib';
import { Config, Storage } from '../core/structures';
import { PermissionNames, getPermissionLevel } from '../core/permissions';
import { Permissions } from 'discord.js';
function getLogBuffer(type: string)
{
return {files: [{
attachment: Buffer.alloc(logs[type].length, logs[type]),
name: `${Date.now()}.${type}.log`
}]};
function getLogBuffer(type: string) {
return {
files: [
{
attachment: Buffer.alloc(logs[type].length, logs[type]),
name: `${Date.now()}.${type}.log`,
},
],
};
}
const activities = ["playing", "listening", "streaming", "watching"];
const activities = ['playing', 'listening', 'streaming', 'watching'];
export default new Command({
description: "An all-in-one command to do admin stuff. You need to be either an admin of the server or one of the bot's mechanics to use this command.",
async run($: CommonLibrary): Promise<any>
{
if(!$.member)
return $.channel.send("Couldn't find a member object for you! Did you make sure you used this in a server?");
const permLevel = getPermissionLevel($.member);
$.channel.send(`${$.author.toString()}, your permission level is \`${PermissionNames[permLevel]}\` (${permLevel}).`);
},
subcommands:
{
set: new Command({
description: "Set different per-guild settings for the bot.",
run: "You have to specify the option you want to set.",
permission: Command.PERMISSIONS.ADMIN,
subcommands:
{
prefix: new Command({
description: "Set a custom prefix for your guild. Removes your custom prefix if none is provided.",
usage: "(<prefix>)",
async run($: CommonLibrary): Promise<any>
{
Storage.getGuild($.guild?.id || "N/A").prefix = null;
Storage.save();
$.channel.send(`The custom prefix for this guild has been removed. My prefix is now back to \`${Config.prefix}\`.`);
},
any: new Command({
async run($: CommonLibrary): Promise<any>
{
Storage.getGuild($.guild?.id || "N/A").prefix = $.args[0];
Storage.save();
$.channel.send(`The custom prefix for this guild is now \`${$.args[0]}\`.`);
}
})
})
}
}),
diag: new Command({
description: "Requests a debug log with the \"info\" verbosity level.",
permission: Command.PERMISSIONS.BOT_SUPPORT,
async run($: CommonLibrary): Promise<any>
{
$.channel.send(getLogBuffer("info"));
},
any: new Command({
description: `Select a verbosity to listen to. Available levels: \`[${Object.keys(logs).join(", ")}]\``,
async run($: CommonLibrary): Promise<any>
{
const type = $.args[0];
if(type in logs)
$.channel.send(getLogBuffer(type));
else
$.channel.send(`Couldn't find a verbosity level named \`${type}\`! The available types are \`[${Object.keys(logs).join(", ")}]\`.`);
}
})
}),
status: new Command({
description: "Changes the bot's status.",
permission: Command.PERMISSIONS.BOT_SUPPORT,
async run($: CommonLibrary): Promise<any>
{
$.channel.send('Setting status to `online`...');
},
any: new Command({
description: `Select a status to set to. Available statuses: \`online\`, \`idle\`, \`dnd\`, \`invisible\``,
async run($: CommonLibrary): Promise<any>
{
let statuses = ['online', 'idle', 'dnd', 'invisible'];
if (!statuses.includes($.args[0])) return $.channel.send("That status doesn't exist!");
else {
$.client.user?.setStatus($.args[0]);
$.channel.send(`Setting status to \`${$.args[0]}\`...`);
}
}
})
}),
purge: new Command({
description: "Purges bot messages.",
permission: Command.PERMISSIONS.BOT_SUPPORT,
async run($: CommonLibrary): Promise<any>
{
$.message.delete();
const msgs = await $.channel.messages.fetch({
limit: 100
});
const travMessages = msgs.filter(m => m.author.id === $.client.user?.id);
description:
"An all-in-one command to do admin stuff. You need to be either an admin of the server or one of the bot's mechanics to use this command.",
async run($: CommonLibrary): Promise<any> {
if (!$.member)
return $.channel.send(
"Couldn't find a member object for you! Did you make sure you used this in a server?",
);
const permLevel = getPermissionLevel($.member);
$.channel.send(
`${$.author.toString()}, your permission level is \`${
PermissionNames[permLevel]
}\` (${permLevel}).`,
);
},
subcommands: {
set: new Command({
description: 'Set different per-guild settings for the bot.',
run: 'You have to specify the option you want to set.',
permission: Command.PERMISSIONS.ADMIN,
subcommands: {
prefix: new Command({
description:
'Set a custom prefix for your guild. Removes your custom prefix if none is provided.',
usage: '(<prefix>)',
async run($: CommonLibrary): Promise<any> {
Storage.getGuild($.guild?.id || 'N/A').prefix = null;
Storage.save();
$.channel.send(
`The custom prefix for this guild has been removed. My prefix is now back to \`${Config.prefix}\`.`,
);
},
any: new Command({
async run($: CommonLibrary): Promise<any> {
Storage.getGuild($.guild?.id || 'N/A').prefix = $.args[0];
Storage.save();
$.channel.send(
`The custom prefix for this guild is now \`${$.args[0]}\`.`,
);
},
}),
}),
},
}),
diag: new Command({
description: 'Requests a debug log with the "info" verbosity level.',
permission: Command.PERMISSIONS.BOT_SUPPORT,
async run($: CommonLibrary): Promise<any> {
$.channel.send(getLogBuffer('info'));
},
any: new Command({
description: `Select a verbosity to listen to. Available levels: \`[${Object.keys(
logs,
).join(', ')}]\``,
async run($: CommonLibrary): Promise<any> {
const type = $.args[0];
await $.message.channel.send(`Found ${travMessages.size} messages to delete.`)
.then(m => m.delete({
timeout: 5000
}));
await $.message.channel.bulkDelete(travMessages);
}
}),
nick: new Command({
description: "Change the bot's nickname.",
permission: Command.PERMISSIONS.BOT_SUPPORT,
async run($: CommonLibrary): Promise<any>
{
const nickName = $.args.join(" ");
const trav = $.guild?.members.cache.find(member => member.id === $.client.user?.id);
await trav?.setNickname(nickName);
if(botHasPermission($.guild, Permissions.FLAGS.MANAGE_MESSAGES))
$.message.delete({timeout: 5000}).catch($.handler.bind($));
$.channel.send(`Nickname set to \`${nickName}\``)
.then(m => m.delete({timeout: 5000}));
}
}),
guilds: new Command({
description: "Shows a list of all guilds the bot is a member of.",
permission: Command.PERMISSIONS.BOT_SUPPORT,
async run($: CommonLibrary): Promise<any>
{
const guildList = $.client.guilds.cache.array()
.map(e => e.name);
$.channel.send(guildList);
}
}),
activity: new Command({
description: "Set the activity of the bot.",
permission: Command.PERMISSIONS.BOT_SUPPORT,
usage: "<type> <string>",
async run($: CommonLibrary): Promise<any>
{
$.client.user?.setActivity(".help", {
type: "LISTENING"
});
$.channel.send("Activity set to default.")
},
any: new Command({
description: `Select an activity type to set. Available levels: \`[${activities.join(", ")}]\``,
async run($: CommonLibrary): Promise<any>
{
const type = $.args[0];
if(activities.includes(type)) {
$.client.user?.setActivity($.args.slice(1).join(" "), {type: $.args[0].toUpperCase()})
$.channel.send(`Set activity to \`${$.args[0].toUpperCase()}\` \`${$.args.slice(1).join(" ")}\`.`)
}
else
$.channel.send(`Couldn't find an activity type named \`${type}\`! The available types are \`[${activities.join(", ")}]\`.`);
}
})
})
}
});
if (type in logs) $.channel.send(getLogBuffer(type));
else
$.channel.send(
`Couldn't find a verbosity level named \`${type}\`! The available types are \`[${Object.keys(
logs,
).join(', ')}]\`.`,
);
},
}),
}),
status: new Command({
description: "Changes the bot's status.",
permission: Command.PERMISSIONS.BOT_SUPPORT,
async run($: CommonLibrary): Promise<any> {
$.channel.send('Setting status to `online`...');
},
any: new Command({
description: `Select a status to set to. Available statuses: \`online\`, \`idle\`, \`dnd\`, \`invisible\``,
async run($: CommonLibrary): Promise<any> {
let statuses = ['online', 'idle', 'dnd', 'invisible'];
if (!statuses.includes($.args[0]))
return $.channel.send("That status doesn't exist!");
else {
$.client.user?.setStatus($.args[0]);
$.channel.send(`Setting status to \`${$.args[0]}\`...`);
}
},
}),
}),
purge: new Command({
description: 'Purges bot messages.',
permission: Command.PERMISSIONS.BOT_SUPPORT,
async run($: CommonLibrary): Promise<any> {
$.message.delete();
const msgs = await $.channel.messages.fetch({
limit: 100,
});
const travMessages = msgs.filter(
(m) => m.author.id === $.client.user?.id,
);
await $.message.channel
.send(`Found ${travMessages.size} messages to delete.`)
.then((m) =>
m.delete({
timeout: 5000,
}),
);
await $.message.channel.bulkDelete(travMessages);
},
}),
nick: new Command({
description: "Change the bot's nickname.",
permission: Command.PERMISSIONS.BOT_SUPPORT,
async run($: CommonLibrary): Promise<any> {
const nickName = $.args.join(' ');
const trav = $.guild?.members.cache.find(
(member) => member.id === $.client.user?.id,
);
await trav?.setNickname(nickName);
if (botHasPermission($.guild, Permissions.FLAGS.MANAGE_MESSAGES))
$.message.delete({ timeout: 5000 }).catch($.handler.bind($));
$.channel
.send(`Nickname set to \`${nickName}\``)
.then((m) => m.delete({ timeout: 5000 }));
},
}),
guilds: new Command({
description: 'Shows a list of all guilds the bot is a member of.',
permission: Command.PERMISSIONS.BOT_SUPPORT,
async run($: CommonLibrary): Promise<any> {
const guildList = $.client.guilds.cache.array().map((e) => e.name);
$.channel.send(guildList);
},
}),
activity: new Command({
description: 'Set the activity of the bot.',
permission: Command.PERMISSIONS.BOT_SUPPORT,
usage: '<type> <string>',
async run($: CommonLibrary): Promise<any> {
$.client.user?.setActivity('.help', {
type: 'LISTENING',
});
$.channel.send('Activity set to default.');
},
any: new Command({
description: `Select an activity type to set. Available levels: \`[${activities.join(
', ',
)}]\``,
async run($: CommonLibrary): Promise<any> {
const type = $.args[0];
if (activities.includes(type)) {
$.client.user?.setActivity($.args.slice(1).join(' '), {
type: $.args[0].toUpperCase(),
});
$.channel.send(
`Set activity to \`${$.args[0].toUpperCase()}\` \`${$.args
.slice(1)
.join(' ')}\`.`,
);
} else
$.channel.send(
`Couldn't find an activity type named \`${type}\`! The available types are \`[${activities.join(
', ',
)}]\`.`,
);
},
}),
}),
},
});

69
src/commands/fun/8ball.ts
View File

@ -1,39 +1,38 @@
import Command from "../../core/command";
import {CommonLibrary} from "../../core/lib";
import Command from '../../core/command';
import { CommonLibrary } from '../../core/lib';
const responses = [
"Most likely,",
"It is certain,",
"It is decidedly so,",
"Without a doubt,",
"Definitely,",
"You may rely on it,",
"As I see it, yes,",
"Outlook good,",
"Yes,",
"Signs point to yes,",
"Reply hazy, try again,",
"Ask again later,",
"Better not tell you now,",
"Cannot predict now,",
"Concentrate and ask again,",
"Don't count on it,",
"My reply is no,",
"My sources say no,",
"Outlook not so good,",
"Very doubtful,"
'Most likely,',
'It is certain,',
'It is decidedly so,',
'Without a doubt,',
'Definitely,',
'You may rely on it,',
'As I see it, yes,',
'Outlook good,',
'Yes,',
'Signs point to yes,',
'Reply hazy, try again,',
'Ask again later,',
'Better not tell you now,',
'Cannot predict now,',
'Concentrate and ask again,',
"Don't count on it,",
'My reply is no,',
'My sources say no,',
'Outlook not so good,',
'Very doubtful,',
];
export default new Command({
description: "Answers your question in an 8-ball manner.",
endpoint: false,
usage: "<question>",
run: "Please provide a question.",
any: new Command({
description: "Question to ask the 8-ball.",
async run($: CommonLibrary): Promise<any>
{
const sender = $.message.author;
$.channel.send($(responses).random() + ` <@${sender.id}>`);
}
})
})
description: 'Answers your question in an 8-ball manner.',
endpoint: false,
usage: '<question>',
run: 'Please provide a question.',
any: new Command({
description: 'Question to ask the 8-ball.',
async run($: CommonLibrary): Promise<any> {
const sender = $.message.author;
$.channel.send($(responses).random() + ` <@${sender.id}>`);
},
}),
});

50
src/commands/fun/poll.ts
View File

@ -1,26 +1,28 @@
import { MessageEmbed } from "discord.js";
import Command from "../../core/command";
import {CommonLibrary} from "../../core/lib";
import { MessageEmbed } from 'discord.js';
import Command from '../../core/command';
import { CommonLibrary } from '../../core/lib';
export default new Command({
description: "Create a poll.",
usage: "<question>",
run: "Please provide a question.",
any: new Command({
description: "Question for the poll.",
async run($: CommonLibrary): Promise<any>
{
const embed = new MessageEmbed()
.setAuthor(`Poll created by ${$.message.author.username}`, $.message.guild?.iconURL({ dynamic: true }) ?? undefined)
.setColor(0xffffff)
.setFooter("React to vote.")
.setDescription($.args.join(" "));
const msg = await $.channel.send(embed);
await msg.react("✅");
await msg.react("⛔");
$.message.delete({
timeout: 1000
});
}
})
})
description: 'Create a poll.',
usage: '<question>',
run: 'Please provide a question.',
any: new Command({
description: 'Question for the poll.',
async run($: CommonLibrary): Promise<any> {
const embed = new MessageEmbed()
.setAuthor(
`Poll created by ${$.message.author.username}`,
$.message.guild?.iconURL({ dynamic: true }) ?? undefined,
)
.setColor(0xffffff)
.setFooter('React to vote.')
.setDescription($.args.join(' '));
const msg = await $.channel.send(embed);
await msg.react('✅');
await msg.react('⛔');
$.message.delete({
timeout: 1000,
});
},
}),
});

280
src/commands/help.ts
View File

@ -1,141 +1,145 @@
import Command from "../core/command";
import {CommonLibrary} from "../core/lib";
import {loadCommands, categories} from "../core/command";
import {PermissionNames} from "../core/permissions";
import Command from '../core/command';
import { CommonLibrary } from '../core/lib';
import { loadCommands, categories } from '../core/command';
import { PermissionNames } from '../core/permissions';
export default new Command({
description: "Lists all commands. If a command is specified, their arguments are listed as well.",
usage: "([command, [subcommand/type], ...])",
aliases: ["h"],
async run($: CommonLibrary): Promise<any>
{
const commands = await loadCommands();
let output = `Legend: \`<type>\`, \`[list/of/stuff]\`, \`(optional)\`, \`(<optional type>)\`, \`([optional/list/...])\``;
for(const [category, headers] of categories)
{
output += `\n\n===[ ${category} ]===`;
for(const header of headers)
{
if(header !== "test")
{
const command = commands.get(header);
if(!command)
return $.warn(`Command "${header}" of category "${category}" unexpectedly doesn't exist!`);
output += `\n- \`${header}\`: ${command.description}`;
}
}
}
$.channel.send(output, {split: true});
},
any: new Command({
async run($: CommonLibrary): Promise<any>
{
const commands = await loadCommands();
let header = $.args.shift() as string;
let command = commands.get(header);
if(!command || header === "test")
return $.channel.send(`No command found by the name \`${header}\`!`);
description:
'Lists all commands. If a command is specified, their arguments are listed as well.',
usage: '([command, [subcommand/type], ...])',
aliases: ['h'],
async run($: CommonLibrary): Promise<any> {
const commands = await loadCommands();
let output = `Legend: \`<type>\`, \`[list/of/stuff]\`, \`(optional)\`, \`(<optional type>)\`, \`([optional/list/...])\``;
if(command.originalCommandName)
header = command.originalCommandName;
else
$.warn(`originalCommandName isn't defined for ${header}?!`);
let permLevel = command.permission ?? Command.PERMISSIONS.NONE;
let usage = command.usage;
let invalid = false;
let selectedCategory = "Unknown";
for(const [category, headers] of categories)
{
if(headers.includes(header))
{
if(selectedCategory !== "Unknown")
$.warn(`Command "${header}" is somehow in multiple categories. This means that the command loading stage probably failed in properly adding categories.`);
else
selectedCategory = category;
}
}
for(const param of $.args)
{
const type = command.resolve(param);
command = command.get(param);
permLevel = command.permission ?? permLevel;
switch(type)
{
case Command.TYPES.SUBCOMMAND: header += ` ${command.originalCommandName}`; break;
case Command.TYPES.USER: header += " <user>" ; break;
case Command.TYPES.NUMBER: header += " <number>" ; break;
case Command.TYPES.ANY: header += " <any>" ; break;
default: header += ` ${param}`; break;
}
if(type === Command.TYPES.NONE)
{
invalid = true;
break;
}
}
if(invalid)
return $.channel.send(`No command found by the name \`${header}\`!`);
let append = "";
if(usage === "")
{
const list: string[] = [];
command.subcommands.forEach((subcmd, subtag) => {
// Don't capture duplicates generated from aliases.
if(subcmd.originalCommandName === subtag) {
const customUsage = subcmd.usage ? ` ${subcmd.usage}` : "";
list.push(`- \`${header} ${subtag}${customUsage}\` - ${subcmd.description}`);
}
});
const addDynamicType = (cmd: Command|null, type: string) => {
if(cmd) {
const customUsage = cmd.usage ? ` ${cmd.usage}` : "";
list.push(`- \`${header} <${type}>${customUsage}\` - ${cmd.description}`);
}
};
addDynamicType(command.user, "user");
addDynamicType(command.number, "number");
addDynamicType(command.any, "any");
append = "Usages:" + (list.length > 0 ? `\n${list.join('\n')}` : " None.");
}
else
append = `Usage: \`${header} ${usage}\``;
let aliases = "None";
if(command.aliases.length > 0)
{
aliases = "";
for(let i = 0; i < command.aliases.length; i++)
{
const alias = command.aliases[i];
aliases += `\`${alias}\``;
if(i !== command.aliases.length-1)
aliases += ", ";
}
}
$.channel.send(`Command: \`${header}\`\nAliases: ${aliases}\nCategory: \`${selectedCategory}\`\nPermission Required: \`${PermissionNames[permLevel]}\` (${permLevel})\nDescription: ${command.description}\n${append}`, {split: true});
}
})
});
for (const [category, headers] of categories) {
output += `\n\n===[ ${category} ]===`;
for (const header of headers) {
if (header !== 'test') {
const command = commands.get(header);
if (!command)
return $.warn(
`Command "${header}" of category "${category}" unexpectedly doesn't exist!`,
);
output += `\n- \`${header}\`: ${command.description}`;
}
}
}
$.channel.send(output, { split: true });
},
any: new Command({
async run($: CommonLibrary): Promise<any> {
const commands = await loadCommands();
let header = $.args.shift() as string;
let command = commands.get(header);
if (!command || header === 'test')
return $.channel.send(`No command found by the name \`${header}\`!`);
if (command.originalCommandName) header = command.originalCommandName;
else $.warn(`originalCommandName isn't defined for ${header}?!`);
let permLevel = command.permission ?? Command.PERMISSIONS.NONE;
let usage = command.usage;
let invalid = false;
let selectedCategory = 'Unknown';
for (const [category, headers] of categories) {
if (headers.includes(header)) {
if (selectedCategory !== 'Unknown')
$.warn(
`Command "${header}" is somehow in multiple categories. This means that the command loading stage probably failed in properly adding categories.`,
);
else selectedCategory = category;
}
}
for (const param of $.args) {
const type = command.resolve(param);
command = command.get(param);
permLevel = command.permission ?? permLevel;
switch (type) {
case Command.TYPES.SUBCOMMAND:
header += ` ${command.originalCommandName}`;
break;
case Command.TYPES.USER:
header += ' <user>';
break;
case Command.TYPES.NUMBER:
header += ' <number>';
break;
case Command.TYPES.ANY:
header += ' <any>';
break;
default:
header += ` ${param}`;
break;
}
if (type === Command.TYPES.NONE) {
invalid = true;
break;
}
}
if (invalid)
return $.channel.send(`No command found by the name \`${header}\`!`);
let append = '';
if (usage === '') {
const list: string[] = [];
command.subcommands.forEach((subcmd, subtag) => {
// Don't capture duplicates generated from aliases.
if (subcmd.originalCommandName === subtag) {
const customUsage = subcmd.usage ? ` ${subcmd.usage}` : '';
list.push(
`- \`${header} ${subtag}${customUsage}\` - ${subcmd.description}`,
);
}
});
const addDynamicType = (cmd: Command | null, type: string) => {
if (cmd) {
const customUsage = cmd.usage ? ` ${cmd.usage}` : '';
list.push(
`- \`${header} <${type}>${customUsage}\` - ${cmd.description}`,
);
}
};
addDynamicType(command.user, 'user');
addDynamicType(command.number, 'number');
addDynamicType(command.any, 'any');
append =
'Usages:' + (list.length > 0 ? `\n${list.join('\n')}` : ' None.');
} else append = `Usage: \`${header} ${usage}\``;
let aliases = 'None';
if (command.aliases.length > 0) {
aliases = '';
for (let i = 0; i < command.aliases.length; i++) {
const alias = command.aliases[i];
aliases += `\`${alias}\``;
if (i !== command.aliases.length - 1) aliases += ', ';
}
}
$.channel.send(
`Command: \`${header}\`\nAliases: ${aliases}\nCategory: \`${selectedCategory}\`\nPermission Required: \`${PermissionNames[permLevel]}\` (${permLevel})\nDescription: ${command.description}\n${append}`,
{ split: true },
);
},
}),
});

307
src/commands/info.ts
View File

@ -1,124 +1,197 @@
import { Guild, MessageEmbed } from "discord.js";
import moment from "moment";
import Command from "../core/command";
import {CommonLibrary} from "../core/lib";
import { verificationLevels, filterLevels, regions, flags } from "../defs/info";
import { Guild, MessageEmbed } from 'discord.js';
import moment from 'moment';
import Command from '../core/command';
import { CommonLibrary } from '../core/lib';
import { verificationLevels, filterLevels, regions, flags } from '../defs/info';
export default new Command({
description: "Command to provide all sorts of info about the current server, a user, etc.",
run: "Please provide an argument.\nFor help, run `%prefix%help info`.",
subcommands:
{
avatar: new Command({
description: "Shows your own, or another user's avatar.",
usage: "(<user>)",
async run($: CommonLibrary): Promise<any>
{
$.channel.send($.author.displayAvatarURL({ dynamic: true, size: 2048 }))
},
user: new Command({
description: "Shows your own, or another user's avatar.",
async run($: CommonLibrary): Promise<any>
{
$.channel.send($.args[0].displayAvatarURL({ dynamic: true, size: 2048 }))
}
}),
}),
guild: new Command({
description: "Displays info about the current guild.",
async run($: CommonLibrary): Promise<any>
{
if ($.guild) {
const roles = $.guild.roles.cache.sort((a, b) => b.position - a.position).map(role => role.toString());
const members = $.guild.members.cache;
const channels = $.guild.channels.cache;
const emojis = $.guild.emojis.cache;
const iconURL = $.guild.iconURL({ dynamic: true })
const embed = new MessageEmbed()
.setDescription(`**Guild information for __${$.guild.name}__**`)
.setColor('BLUE')
if (iconURL) embed.setThumbnail(iconURL)
.addField('General', [
`**❯ Name:** ${$.guild.name}`,
`**❯ ID:** ${$.guild.id}`,
`**❯ Owner:** ${$.guild.owner?.user.tag} (${$.guild.ownerID})`,
`**❯ Region:** ${regions[$.guild.region]}`,
`**❯ Boost Tier:** ${$.guild.premiumTier ? `Tier ${$.guild.premiumTier}` : 'None'}`,
`**❯ Explicit Filter:** ${filterLevels[$.guild.explicitContentFilter]}`,
`**❯ Verification Level:** ${verificationLevels[$.guild.verificationLevel]}`,
`**❯ Time Created:** ${moment($.guild.createdTimestamp).format('LT')} ${moment($.guild.createdTimestamp).format('LL')} ${moment($.guild.createdTimestamp).fromNow()})`,
'\u200b'
])
.addField('Statistics', [
`**❯ Role Count:** ${roles.length}`,
`**❯ Emoji Count:** ${emojis.size}`,
`**❯ Regular Emoji Count:** ${emojis.filter(emoji => !emoji.animated).size}`,
`**❯ Animated Emoji Count:** ${emojis.filter(emoji => emoji.animated).size}`,
`**❯ Member Count:** ${$.guild.memberCount}`,
`**❯ Humans:** ${members.filter(member => !member.user.bot).size}`,
`**❯ Bots:** ${members.filter(member => member.user.bot).size}`,
`**❯ Text Channels:** ${channels.filter(channel => channel.type === 'text').size}`,
`**❯ Voice Channels:** ${channels.filter(channel => channel.type === 'voice').size}`,
`**❯ Boost Count:** ${$.guild.premiumSubscriptionCount || '0'}`,
`\u200b`
])
.addField('Presence', [
`**❯ Online:** ${members.filter(member => member.presence.status === 'online').size}`,
`**❯ Idle:** ${members.filter(member => member.presence.status === 'idle').size}`,
`**❯ Do Not Disturb:** ${members.filter(member => member.presence.status === 'dnd').size}`,
`**❯ Offline:** ${members.filter(member => member.presence.status === 'offline').size}`,
'\u200b'
])
.addField(`Roles [${roles.length - 1}]`, roles.length < 10 ? roles.join(', ') : roles.length > 10 ? this.client.utils.trimArray(roles) : 'None')
.setTimestamp();
description:
'Command to provide all sorts of info about the current server, a user, etc.',
run: 'Please provide an argument.\nFor help, run `%prefix%help info`.',
subcommands: {
avatar: new Command({
description: "Shows your own, or another user's avatar.",
usage: '(<user>)',
async run($: CommonLibrary): Promise<any> {
$.channel.send(
$.author.displayAvatarURL({ dynamic: true, size: 2048 }),
);
},
user: new Command({
description: "Shows your own, or another user's avatar.",
async run($: CommonLibrary): Promise<any> {
$.channel.send(
$.args[0].displayAvatarURL({ dynamic: true, size: 2048 }),
);
},
}),
}),
$.channel.send(embed)
guild: new Command({
description: 'Displays info about the current guild.',
async run($: CommonLibrary): Promise<any> {
if ($.guild) {
const roles = $.guild.roles.cache
.sort((a, b) => b.position - a.position)
.map((role) => role.toString());
const members = $.guild.members.cache;
const channels = $.guild.channels.cache;
const emojis = $.guild.emojis.cache;
} else {
$.channel.send("Please execute this command in a guild.")
}
}
})
},
user: new Command({
description: "Displays info about mentioned user.",
async run($: CommonLibrary): Promise<any>
{
// Transforms the User object into a GuildMember object of the current guild.
const member = $.guild?.members.resolve($.args[0]);
const iconURL = $.guild.iconURL({ dynamic: true });
const embed = new MessageEmbed()
.setDescription(`**Guild information for __${$.guild.name}__**`)
.setColor('BLUE');
if (iconURL)
embed
.setThumbnail(iconURL)
.addField('General', [
`**❯ Name:** ${$.guild.name}`,
`**❯ ID:** ${$.guild.id}`,
`**❯ Owner:** ${$.guild.owner?.user.tag} (${$.guild.ownerID})`,
`**❯ Region:** ${regions[$.guild.region]}`,
`**❯ Boost Tier:** ${
$.guild.premiumTier ? `Tier ${$.guild.premiumTier}` : 'None'
}`,
`**❯ Explicit Filter:** ${
filterLevels[$.guild.explicitContentFilter]
}`,
`**❯ Verification Level:** ${
verificationLevels[$.guild.verificationLevel]
}`,
`**❯ Time Created:** ${moment($.guild.createdTimestamp).format(
'LT',
)} ${moment($.guild.createdTimestamp).format('LL')} ${moment(
$.guild.createdTimestamp,
).fromNow()})`,
'\u200b',
])
.addField('Statistics', [
`**❯ Role Count:** ${roles.length}`,
`**❯ Emoji Count:** ${emojis.size}`,
`**❯ Regular Emoji Count:** ${
emojis.filter((emoji) => !emoji.animated).size
}`,
`**❯ Animated Emoji Count:** ${
emojis.filter((emoji) => emoji.animated).size
}`,
`**❯ Member Count:** ${$.guild.memberCount}`,
`**❯ Humans:** ${
members.filter((member) => !member.user.bot).size
}`,
`**❯ Bots:** ${
members.filter((member) => member.user.bot).size
}`,
`**❯ Text Channels:** ${
channels.filter((channel) => channel.type === 'text').size
}`,
`**❯ Voice Channels:** ${
channels.filter((channel) => channel.type === 'voice').size
}`,
`**❯ Boost Count:** ${$.guild.premiumSubscriptionCount || '0'}`,
`\u200b`,
])
.addField('Presence', [
`**❯ Online:** ${
members.filter(
(member) => member.presence.status === 'online',
).size
}`,
`**❯ Idle:** ${
members.filter((member) => member.presence.status === 'idle')
.size
}`,
`**❯ Do Not Disturb:** ${
members.filter((member) => member.presence.status === 'dnd')
.size
}`,
`**❯ Offline:** ${
members.filter(
(member) => member.presence.status === 'offline',
).size
}`,
'\u200b',
])
.addField(
`Roles [${roles.length - 1}]`,
roles.length < 10
? roles.join(', ')
: roles.length > 10
? this.client.utils.trimArray(roles)
: 'None',
)
.setTimestamp();
if(!member)
return $.channel.send("No member object was found by that user! Are you sure you used this command in a server?");
$.channel.send(embed);
} else {
$.channel.send('Please execute this command in a guild.');
}
},
}),
},
user: new Command({
description: 'Displays info about mentioned user.',
async run($: CommonLibrary): Promise<any> {
// Transforms the User object into a GuildMember object of the current guild.
const member = $.guild?.members.resolve($.args[0]);
const roles = member.roles.cache
.sort((a: { position: number; }, b: { position: number; }) => b.position - a.position)
.map((role: { toString: () => any; }) => role.toString())
.slice(0, -1);
// @ts-ignore - Discord.js' typings seem to be outdated here. According to their v12 docs, it's User.fetchFlags() instead of User.flags.
const userFlags = (await member.user.fetchFlags() as UserFlags).toArray();
if (!member)
return $.channel.send(
'No member object was found by that user! Are you sure you used this command in a server?',
);
const embed = new MessageEmbed()
.setThumbnail(member.user.displayAvatarURL({ dynamic: true, size: 512 }))
.setColor(member.displayHexColor || 'BLUE')
.addField('User', [
`**❯ Username:** ${member.user.username}`,
`**❯ Discriminator:** ${member.user.discriminator}`,
`**❯ ID:** ${member.id}`,
`**❯ Flags:** ${userFlags.length ? userFlags.join(', ') : 'None'}`,
`**❯ Avatar:** [Link to avatar](${member.user.displayAvatarURL({ dynamic: true })})`,
`**❯ Time Created:** ${moment(member.user.createdTimestamp).format('LT')} ${moment(member.user.createdTimestamp).format('LL')} ${moment(member.user.createdTimestamp).fromNow()}`,
`**❯ Status:** ${member.user.presence.status}`,
`**❯ Game:** ${member.user.presence.activities || 'Not playing a game.'}`
])
.addField('Member', [
`**❯ Highest Role:** ${member.roles.highest.id === $.guild?.id ? 'None' : member.roles.highest.name}`,
`**❯ Server Join Date:** ${moment(member.joinedAt).format('LL LTS')}`,
`**❯ Hoist Role:** ${member.roles.hoist ? member.roles.hoist.name : 'None'}`,
`**❯ Roles:** [${roles.length}]: ${roles.length < 10 ? roles.join(', ') : roles.length > 10 ? this.client.utils.trimArray(roles) : 'None'}`,
]);
$.channel.send(embed)
}
})
});
const roles = member.roles.cache
.sort(
(a: { position: number }, b: { position: number }) =>
b.position - a.position,
)
.map((role: { toString: () => any }) => role.toString())
.slice(0, -1);
// @ts-ignore - Discord.js' typings seem to be outdated here. According to their v12 docs, it's User.fetchFlags() instead of User.flags.
const userFlags = ((await member.user.fetchFlags()) as UserFlags).toArray();
const embed = new MessageEmbed()
.setThumbnail(
member.user.displayAvatarURL({ dynamic: true, size: 512 }),
)
.setColor(member.displayHexColor || 'BLUE')
.addField('User', [
`**❯ Username:** ${member.user.username}`,
`**❯ Discriminator:** ${member.user.discriminator}`,
`**❯ ID:** ${member.id}`,
`**❯ Flags:** ${userFlags.length ? userFlags.join(', ') : 'None'}`,
`**❯ Avatar:** [Link to avatar](${member.user.displayAvatarURL({
dynamic: true,
})})`,
`**❯ Time Created:** ${moment(member.user.createdTimestamp).format(
'LT',
)} ${moment(member.user.createdTimestamp).format('LL')} ${moment(
member.user.createdTimestamp,
).fromNow()}`,
`**❯ Status:** ${member.user.presence.status}`,
`**❯ Game:** ${
member.user.presence.activities || 'Not playing a game.'
}`,
])
.addField('Member', [
`**❯ Highest Role:** ${
member.roles.highest.id === $.guild?.id
? 'None'
: member.roles.highest.name
}`,
`**❯ Server Join Date:** ${moment(member.joinedAt).format('LL LTS')}`,
`**❯ Hoist Role:** ${
member.roles.hoist ? member.roles.hoist.name : 'None'
}`,
`**❯ Roles:** [${roles.length}]: ${
roles.length < 10
? roles.join(', ')
: roles.length > 10
? this.client.utils.trimArray(roles)
: 'None'
}`,
]);
$.channel.send(embed);
},
}),
});

479
src/commands/money.ts
View File

@ -1,231 +1,260 @@
import Command from "../core/command";
import $, {CommonLibrary} from "../core/lib";
import {Storage} from "../core/structures";
import {User} from "discord.js";
import Command from '../core/command';
import $, { CommonLibrary } from '../core/lib';
import { Storage } from '../core/structures';
import { User } from 'discord.js';
export function getMoneyEmbed(user: User): object
{
const profile = Storage.getUser(user.id);
return {embed: {
color: 0xFFFF00,
author:
{
name: user.username,
icon_url: user.displayAvatarURL({
format: "png",
dynamic: true
})
},
fields:
[
{
name: "Balance",
value: $(profile.money).pluralise("credit", "s")
}
]
}};
export function getMoneyEmbed(user: User): object {
const profile = Storage.getUser(user.id);
return {
embed: {
color: 0xffff00,
author: {
name: user.username,
icon_url: user.displayAvatarURL({
format: 'png',
dynamic: true,
}),
},
fields: [
{
name: 'Balance',
value: $(profile.money).pluralise('credit', 's'),
},
],
},
};
}
function getSendEmbed(sender: User, receiver: User, amount: number): object
{
return {embed: {
color: 0xFFFF00,
author:
{
name: sender.username,
icon_url: sender.displayAvatarURL({
format: "png",
dynamic: true
})
},
title: "Transaction",
description: `${sender.toString()} has sent ${$(amount).pluralise("credit", "s")} to ${receiver.toString()}!`,
fields:
[
{
name: `Sender: ${sender.username}#${sender.discriminator}`,
value: $(Storage.getUser(sender.id).money).pluralise("credit", "s")
},
{
name: `Receiver: ${receiver.username}#${receiver.discriminator}`,
value: $(Storage.getUser(receiver.id).money).pluralise("credit", "s")
}
],
footer:
{
text: receiver.username,
icon_url: receiver.displayAvatarURL({
format: "png",
dynamic: true
})
}
}};
function getSendEmbed(sender: User, receiver: User, amount: number): object {
return {
embed: {
color: 0xffff00,
author: {
name: sender.username,
icon_url: sender.displayAvatarURL({
format: 'png',
dynamic: true,
}),
},
title: 'Transaction',
description: `${sender.toString()} has sent ${$(amount).pluralise(
'credit',
's',
)} to ${receiver.toString()}!`,
fields: [
{
name: `Sender: ${sender.username}#${sender.discriminator}`,
value: $(Storage.getUser(sender.id).money).pluralise('credit', 's'),
},
{
name: `Receiver: ${receiver.username}#${receiver.discriminator}`,
value: $(Storage.getUser(receiver.id).money).pluralise('credit', 's'),
},
],
footer: {
text: receiver.username,
icon_url: receiver.displayAvatarURL({
format: 'png',
dynamic: true,
}),
},
},
};
}
export default new Command({
description: "See how much money you have. Also provides other commands related to money.",
async run($: CommonLibrary): Promise<any>
{
$.channel.send(getMoneyEmbed($.author));
},
subcommands:
{
get: new Command({
description: "Pick up your daily credits. The cooldown is per user and every 22 hours to allow for some leeway.",
async run($: CommonLibrary): Promise<any>
{
const user = Storage.getUser($.author.id);
const now = Date.now();
if(user.lastReceived === -1)
{
user.money = 100;
user.lastReceived = now;
Storage.save();
$.channel.send("Here's 100 credits to get started, the price of a sandwich in Rookie Harbor.", getMoneyEmbed($.author));
}
else if(now - user.lastReceived >= 79200000)
{
user.money += 25;
user.lastReceived = now;
Storage.save();
$.channel.send("Here's your daily 25 credits.", getMoneyEmbed($.author));
}
else
$.channel.send(`It's too soon to pick up your daily credits. You have about ${((user.lastReceived + 79200000 - now) / 3600000).toFixed(1)} hours to go.`);
}
}),
send: new Command({
description: "Send money to someone.",
usage: "<user> <amount>",
run: "Who are you sending this money to?",
user: new Command({
run: "You need to enter an amount you're sending!",
number: new Command({
async run($: CommonLibrary): Promise<any>
{
const amount = Math.floor($.args[1]);
const author = $.author;
const sender = Storage.getUser(author.id);
const target = $.args[0];
const receiver = Storage.getUser(target.id);
if(amount <= 0)
return $.channel.send("You must send at least one credit!");
else if(sender.money < amount)
return $.channel.send("You don't have enough money to do that!", getMoneyEmbed(author));
else if(target.id === author.id)
return $.channel.send("You can't send money to yourself!");
else if(target.bot && process.argv[2] !== "dev")
return $.channel.send("You can't send money to a bot!");
sender.money -= amount;
receiver.money += amount;
Storage.save();
$.channel.send(getSendEmbed(author, target, amount));
}
})
}),
number: new Command({
run: "You must use the format `money send <user> <amount>`!"
}),
any: new Command({
async run($: CommonLibrary): Promise<any>
{
const last = $.args.pop();
if(!/\d+/g.test(last) && $.args.length === 0)
return $.channel.send("You need to enter an amount you're sending!");
const amount = Math.floor(last);
const author = $.author;
const sender = Storage.getUser(author.id);
if(amount <= 0)
return $.channel.send("You must send at least one credit!");
else if(sender.money < amount)
return $.channel.send("You don't have enough money to do that!", getMoneyEmbed(author));
else if(!$.guild)
return $.channel.send("You have to use this in a server if you want to send money with a username!");
const username = $.args.join(" ");
const member = (await $.guild.members.fetch({
query: username,
limit: 1
})).first();
if(!member)
return $.channel.send(`Couldn't find a user by the name of \`${username}\`! If you want to send money to someone in a different server, you have to use their user ID!`);
else if(member.user.id === author.id)
return $.channel.send("You can't send money to yourself!");
else if(member.user.bot && process.argv[2] !== "dev")
return $.channel.send("You can't send money to a bot!");
const target = member.user;
$.prompt(await $.channel.send(`Are you sure you want to send ${$(amount).pluralise("credit", "s")} to this person?\n*(This message will automatically be deleted after 10 seconds.)*`, {embed: {
color: "#ffff00",
author:
{
name: `${target.username}#${target.discriminator}`,
icon_url: target.displayAvatarURL({
format: "png",
dynamic: true
})
}
}}), $.author.id, () => {
const receiver = Storage.getUser(target.id);
sender.money -= amount;
receiver.money += amount;
Storage.save();
$.channel.send(getSendEmbed(author, target, amount));
});
}
})
}),
leaderboard: new Command({
description: "See the richest players tracked by this bot (across servers).",
async run($: CommonLibrary): Promise<any>
{
const users = Storage.users;
const ids = Object.keys(users);
ids.sort((a, b) => users[b].money - users[a].money);
const fields = [];
for(let i = 0, limit = Math.min(10, ids.length); i < limit; i++)
{
const id = ids[i];
const user = await $.client.users.fetch(id);
fields.push({
name: `#${i+1}. ${user.username}#${user.discriminator}`,
value: $(users[id].money).pluralise("credit", "s")
});
}
$.channel.send({embed: {
title: "Top 10 Richest Players",
color: "#ffff00",
fields: fields
}});
}
})
},
user: new Command({
description: "See how much money someone else has by using their user ID or pinging them.",
async run($: CommonLibrary): Promise<any>
{
$.channel.send(getMoneyEmbed($.args[0]));
}
}),
any: new Command({
description: "See how much money someone else has by using their username.",
async run($: CommonLibrary): Promise<any>
{
$.callMemberByUsername($.message, $.args.join(" "), member => {
$.channel.send(getMoneyEmbed(member.user));
});
}
})
});
description:
'See how much money you have. Also provides other commands related to money.',
async run($: CommonLibrary): Promise<any> {
$.channel.send(getMoneyEmbed($.author));
},
subcommands: {
get: new Command({
description:
'Pick up your daily credits. The cooldown is per user and every 22 hours to allow for some leeway.',
async run($: CommonLibrary): Promise<any> {
const user = Storage.getUser($.author.id);
const now = Date.now();
if (user.lastReceived === -1) {
user.money = 100;
user.lastReceived = now;
Storage.save();
$.channel.send(
"Here's 100 credits to get started, the price of a sandwich in Rookie Harbor.",
getMoneyEmbed($.author),
);
} else if (now - user.lastReceived >= 79200000) {
user.money += 25;
user.lastReceived = now;
Storage.save();
$.channel.send(
"Here's your daily 25 credits.",
getMoneyEmbed($.author),
);
} else
$.channel.send(
`It's too soon to pick up your daily credits. You have about ${(
(user.lastReceived + 79200000 - now) /
3600000
).toFixed(1)} hours to go.`,
);
},
}),
send: new Command({
description: 'Send money to someone.',
usage: '<user> <amount>',
run: 'Who are you sending this money to?',
user: new Command({
run: "You need to enter an amount you're sending!",
number: new Command({
async run($: CommonLibrary): Promise<any> {
const amount = Math.floor($.args[1]);
const author = $.author;
const sender = Storage.getUser(author.id);
const target = $.args[0];
const receiver = Storage.getUser(target.id);
if (amount <= 0)
return $.channel.send('You must send at least one credit!');
else if (sender.money < amount)
return $.channel.send(
"You don't have enough money to do that!",
getMoneyEmbed(author),
);
else if (target.id === author.id)
return $.channel.send("You can't send money to yourself!");
else if (target.bot && process.argv[2] !== 'dev')
return $.channel.send("You can't send money to a bot!");
sender.money -= amount;
receiver.money += amount;
Storage.save();
$.channel.send(getSendEmbed(author, target, amount));
},
}),
}),
number: new Command({
run: 'You must use the format `money send <user> <amount>`!',
}),
any: new Command({
async run($: CommonLibrary): Promise<any> {
const last = $.args.pop();
if (!/\d+/g.test(last) && $.args.length === 0)
return $.channel.send(
"You need to enter an amount you're sending!",
);
const amount = Math.floor(last);
const author = $.author;
const sender = Storage.getUser(author.id);
if (amount <= 0)
return $.channel.send('You must send at least one credit!');
else if (sender.money < amount)
return $.channel.send(
"You don't have enough money to do that!",
getMoneyEmbed(author),
);
else if (!$.guild)
return $.channel.send(
'You have to use this in a server if you want to send money with a username!',
);
const username = $.args.join(' ');
const member = (
await $.guild.members.fetch({
query: username,
limit: 1,
})
).first();
if (!member)
return $.channel.send(
`Couldn't find a user by the name of \`${username}\`! If you want to send money to someone in a different server, you have to use their user ID!`,
);
else if (member.user.id === author.id)
return $.channel.send("You can't send money to yourself!");
else if (member.user.bot && process.argv[2] !== 'dev')
return $.channel.send("You can't send money to a bot!");
const target = member.user;
$.prompt(
await $.channel.send(
`Are you sure you want to send ${$(amount).pluralise(
'credit',
's',
)} to this person?\n*(This message will automatically be deleted after 10 seconds.)*`,
{
embed: {
color: '#ffff00',
author: {
name: `${target.username}#${target.discriminator}`,
icon_url: target.displayAvatarURL({
format: 'png',
dynamic: true,
}),
},
},
},
),
$.author.id,
() => {
const receiver = Storage.getUser(target.id);
sender.money -= amount;
receiver.money += amount;
Storage.save();
$.channel.send(getSendEmbed(author, target, amount));
},
);
},
}),
}),
leaderboard: new Command({
description:
'See the richest players tracked by this bot (across servers).',
async run($: CommonLibrary): Promise<any> {
const users = Storage.users;
const ids = Object.keys(users);
ids.sort((a, b) => users[b].money - users[a].money);
const fields = [];
for (let i = 0, limit = Math.min(10, ids.length); i < limit; i++) {
const id = ids[i];
const user = await $.client.users.fetch(id);
fields.push({
name: `#${i + 1}. ${user.username}#${user.discriminator}`,
value: $(users[id].money).pluralise('credit', 's'),
});
}
$.channel.send({
embed: {
title: 'Top 10 Richest Players',
color: '#ffff00',
fields: fields,
},
});
},
}),
},
user: new Command({
description:
'See how much money someone else has by using their user ID or pinging them.',
async run($: CommonLibrary): Promise<any> {
$.channel.send(getMoneyEmbed($.args[0]));
},
}),
any: new Command({
description: 'See how much money someone else has by using their username.',
async run($: CommonLibrary): Promise<any> {
$.callMemberByUsername($.message, $.args.join(' '), (member) => {
$.channel.send(getMoneyEmbed(member.user));
});
},
}),
});

374
src/commands/scanemotes.ts
View File

@ -1,191 +1,191 @@
import Command from '../core/command';
import {CommonLibrary} from '../core/lib';
import moment from "moment";
import {Collection, TextChannel} from 'discord.js';
import { CommonLibrary } from '../core/lib';
import moment from 'moment';
import { Collection, TextChannel } from 'discord.js';
const lastUsedTimestamps: {[id: string]: number} = {};
const lastUsedTimestamps: { [id: string]: number } = {};
export default new Command({
description: "Scans all text channels in the current guild and returns the number of times each emoji specific to the guild has been used. Has a cooldown of 24 hours per guild.",
async run($: CommonLibrary): Promise<any>
{
if(!$.guild)
return $.channel.send(`You must use this command on a server!`);
// Test if the command is on cooldown. This isn't the strictest cooldown possible, because in the event that the bot crashes, the cooldown will be reset. But for all intends and purposes, it's a good enough cooldown. It's a per-server cooldown.
const startTime = Date.now();
const cooldown = 86400000; // 24 hours
const lastUsedTimestamp = lastUsedTimestamps[$.guild.id] ?? 0;
const difference = startTime - lastUsedTimestamp;
const howLong = moment(startTime).to(lastUsedTimestamp + cooldown);
// If it's been less than an hour since the command was last used, prevent it from executing.
if(difference < cooldown)
return $.channel.send(`This command requires a day to cooldown. You'll be able to activate this command ${howLong}.`);
else
lastUsedTimestamps[$.guild.id] = startTime;
const stats: {[id: string]: {
name: string,
formatted: string,
users: number,
bots: number
}} = {};
let totalUserEmoteUsage = 0;
// IMPORTANT: You MUST check if the bot actually has access to the channel in the first place. It will get the list of all channels, but that doesn't mean it has access to every channel. Without this, it'll require admin access and throw an annoying unhelpful DiscordAPIError: Missing Access otherwise.
const allTextChannelsInCurrentGuild = $.guild.channels.cache.filter(channel => channel.type === "text" && channel.viewable) as Collection<string, TextChannel>;
let messagesSearched = 0;
let channelsSearched = 0;
let currentChannelName = "";
const totalChannels = allTextChannelsInCurrentGuild.size;
const statusMessage = await $.channel.send("Gathering emotes...");
let warnings = 0;
$.channel.startTyping();
// Initialize the emote stats object with every emote in the current guild.
// The goal here is to cut the need to access guild.emojis.get() which'll make it faster and easier to work with.
for(let emote of $.guild.emojis.cache.values())
{
// If you don't include the "a" for animated emotes, it'll not only not show up, but also cause all other emotes in the same message to not show up. The emote name is self-correcting but it's better to keep the right value since it'll be used to calculate message lengths that fit.
stats[emote.id] = {
name: emote.name,
formatted: `<${emote.animated ? "a" : ""}:${emote.name}:${emote.id}>`,
users: 0,
bots: 0
};
};
const interval = setInterval(() => {
statusMessage.edit(`Searching channel \`${currentChannelName}\`... (${messagesSearched} messages scanned, ${channelsSearched}/${totalChannels} channels scanned)`);
}, 5000);
for(const channel of allTextChannelsInCurrentGuild.values())
{
currentChannelName = channel.name;
let selected = channel.lastMessageID ?? $.message.id;
let continueLoop = true;
while(continueLoop)
{
// Unfortunately, any kind of .fetch call is limited to 100 items at once by Discord's API.
const messages = await channel.messages.fetch({
limit: 100,
before: selected
});
if(messages.size > 0)
{
for(const msg of messages.values())
{
// It's very important to not capture an array of matches then do \d+ on each item because emote names can have numbers in them, causing the bot to not count them correctly.
const search = /<a?:.+?:(\d+?)>/g;
const text = msg.content;
let match: RegExpExecArray|null;
while(match = search.exec(text))
{
const emoteID = match[1];
if(emoteID in stats)
{
if(msg.author.bot)
stats[emoteID].bots++;
else
{
stats[emoteID].users++;
totalUserEmoteUsage++;
}
}
}
for(const reaction of msg.reactions.cache.values())
{
const emoteID = reaction.emoji.id;
let continueReactionLoop = true;
let lastUserID: string|undefined;
let userReactions = 0;
let botReactions = 0;
// An emote's ID will be null if it's a unicode emote.
if(emoteID && emoteID in stats)
{
// There is a simple count property on a reaction, but that doesn't separate users from bots.
// So instead, I'll use that property to check for inconsistencies.
while(continueReactionLoop)
{
// After logging users, it seems like the order is strictly numerical. As long as that stays consistent, this should work fine.
const users = await reaction.users.fetch({
limit: 100,
after: lastUserID
});
if(users.size > 0)
{
for(const user of users.values())
{
if(user.bot)
{
stats[emoteID].bots++;
botReactions++;
}
else
{
stats[emoteID].users++;
totalUserEmoteUsage++;
userReactions++;
}
lastUserID = user.id;
};
}
else
{
// Then halt the loop and send warnings of any inconsistencies.
continueReactionLoop = false;
if(reaction.count !== userReactions + botReactions)
{
$.warn(`[Channel: ${channel.id}, Message: ${msg.id}] A reaction count of ${reaction.count} was expected but was given ${userReactions} user reactions and ${botReactions} bot reactions.`);
warnings++;
}
}
}
}
};
selected = msg.id;
messagesSearched++;
};
}
else
{
continueLoop = false;
channelsSearched++;
}
}
}
// Mark the operation as ended.
const finishTime = Date.now();
clearInterval(interval);
statusMessage.edit(`Finished operation in ${moment.duration(finishTime - startTime).humanize()} with ${$(warnings).pluralise("inconsistenc", "ies", "y")}.`);
$.log(`Finished operation in ${finishTime - startTime} ms.`);
$.channel.stopTyping();
// Display stats on emote usage.
// This can work outside the loop now that it's synchronous, and now it's clearer what code is meant to execute at the end.
let sortedEmoteIDs = Object.keys(stats).sort((a, b) => stats[b].users - stats[a].users);
const lines: string[] = [];
let rank = 1;
// It's better to send all the lines at once rather than paginate the data because it's quite a memory-intensive task to search all the messages in a server for it, and I wouldn't want to activate the command again just to get to another page.
for(const emoteID of sortedEmoteIDs)
{
const emote = stats[emoteID];
const botInfo = emote.bots > 0 ? ` (Bots: ${emote.bots})` : "";
lines.push(`\`#${rank++}\` ${emote.formatted} x ${emote.users} - ${((emote.users / totalUserEmoteUsage * 100) || 0).toFixed(3)}%` + botInfo);
}
$.channel.send(lines, {split: true}).catch($.handler.bind($));
}
});
description:
'Scans all text channels in the current guild and returns the number of times each emoji specific to the guild has been used. Has a cooldown of 24 hours per guild.',
async run($: CommonLibrary): Promise<any> {
if (!$.guild)
return $.channel.send(`You must use this command on a server!`);
// Test if the command is on cooldown. This isn't the strictest cooldown possible, because in the event that the bot crashes, the cooldown will be reset. But for all intends and purposes, it's a good enough cooldown. It's a per-server cooldown.
const startTime = Date.now();
const cooldown = 86400000; // 24 hours
const lastUsedTimestamp = lastUsedTimestamps[$.guild.id] ?? 0;
const difference = startTime - lastUsedTimestamp;
const howLong = moment(startTime).to(lastUsedTimestamp + cooldown);
// If it's been less than an hour since the command was last used, prevent it from executing.
if (difference < cooldown)
return $.channel.send(
`This command requires a day to cooldown. You'll be able to activate this command ${howLong}.`,
);
else lastUsedTimestamps[$.guild.id] = startTime;
const stats: {
[id: string]: {
name: string;
formatted: string;
users: number;
bots: number;
};
} = {};
let totalUserEmoteUsage = 0;
// IMPORTANT: You MUST check if the bot actually has access to the channel in the first place. It will get the list of all channels, but that doesn't mean it has access to every channel. Without this, it'll require admin access and throw an annoying unhelpful DiscordAPIError: Missing Access otherwise.
const allTextChannelsInCurrentGuild = $.guild.channels.cache.filter(
(channel) => channel.type === 'text' && channel.viewable,
) as Collection<string, TextChannel>;
let messagesSearched = 0;
let channelsSearched = 0;
let currentChannelName = '';
const totalChannels = allTextChannelsInCurrentGuild.size;
const statusMessage = await $.channel.send('Gathering emotes...');
let warnings = 0;
$.channel.startTyping();
// Initialize the emote stats object with every emote in the current guild.
// The goal here is to cut the need to access guild.emojis.get() which'll make it faster and easier to work with.
for (let emote of $.guild.emojis.cache.values()) {
// If you don't include the "a" for animated emotes, it'll not only not show up, but also cause all other emotes in the same message to not show up. The emote name is self-correcting but it's better to keep the right value since it'll be used to calculate message lengths that fit.
stats[emote.id] = {
name: emote.name,
formatted: `<${emote.animated ? 'a' : ''}:${emote.name}:${emote.id}>`,
users: 0,
bots: 0,
};
}
const interval = setInterval(() => {
statusMessage.edit(
`Searching channel \`${currentChannelName}\`... (${messagesSearched} messages scanned, ${channelsSearched}/${totalChannels} channels scanned)`,
);
}, 5000);
for (const channel of allTextChannelsInCurrentGuild.values()) {
currentChannelName = channel.name;
let selected = channel.lastMessageID ?? $.message.id;
let continueLoop = true;
while (continueLoop) {
// Unfortunately, any kind of .fetch call is limited to 100 items at once by Discord's API.
const messages = await channel.messages.fetch({
limit: 100,
before: selected,
});
if (messages.size > 0) {
for (const msg of messages.values()) {
// It's very important to not capture an array of matches then do \d+ on each item because emote names can have numbers in them, causing the bot to not count them correctly.
const search = /<a?:.+?:(\d+?)>/g;
const text = msg.content;
let match: RegExpExecArray | null;
while ((match = search.exec(text))) {
const emoteID = match[1];
if (emoteID in stats) {
if (msg.author.bot) stats[emoteID].bots++;
else {
stats[emoteID].users++;
totalUserEmoteUsage++;
}
}
}
for (const reaction of msg.reactions.cache.values()) {
const emoteID = reaction.emoji.id;
let continueReactionLoop = true;
let lastUserID: string | undefined;
let userReactions = 0;
let botReactions = 0;
// An emote's ID will be null if it's a unicode emote.
if (emoteID && emoteID in stats) {
// There is a simple count property on a reaction, but that doesn't separate users from bots.
// So instead, I'll use that property to check for inconsistencies.
while (continueReactionLoop) {
// After logging users, it seems like the order is strictly numerical. As long as that stays consistent, this should work fine.
const users = await reaction.users.fetch({
limit: 100,
after: lastUserID,
});
if (users.size > 0) {
for (const user of users.values()) {
if (user.bot) {
stats[emoteID].bots++;
botReactions++;
} else {
stats[emoteID].users++;
totalUserEmoteUsage++;
userReactions++;
}
lastUserID = user.id;
}
} else {
// Then halt the loop and send warnings of any inconsistencies.
continueReactionLoop = false;
if (reaction.count !== userReactions + botReactions) {
$.warn(
`[Channel: ${channel.id}, Message: ${msg.id}] A reaction count of ${reaction.count} was expected but was given ${userReactions} user reactions and ${botReactions} bot reactions.`,
);
warnings++;
}
}
}
}
}
selected = msg.id;
messagesSearched++;
}
} else {
continueLoop = false;
channelsSearched++;
}
}
}
// Mark the operation as ended.
const finishTime = Date.now();
clearInterval(interval);
statusMessage.edit(
`Finished operation in ${moment
.duration(finishTime - startTime)
.humanize()} with ${$(warnings).pluralise(
'inconsistenc',
'ies',
'y',
)}.`,
);
$.log(`Finished operation in ${finishTime - startTime} ms.`);
$.channel.stopTyping();
// Display stats on emote usage.
// This can work outside the loop now that it's synchronous, and now it's clearer what code is meant to execute at the end.
let sortedEmoteIDs = Object.keys(stats).sort(
(a, b) => stats[b].users - stats[a].users,
);
const lines: string[] = [];
let rank = 1;
// It's better to send all the lines at once rather than paginate the data because it's quite a memory-intensive task to search all the messages in a server for it, and I wouldn't want to activate the command again just to get to another page.
for (const emoteID of sortedEmoteIDs) {
const emote = stats[emoteID];
const botInfo = emote.bots > 0 ? ` (Bots: ${emote.bots})` : '';
lines.push(
`\`#${rank++}\` ${emote.formatted} x ${emote.users} - ${(
(emote.users / totalUserEmoteUsage) * 100 || 0
).toFixed(3)}%` + botInfo,
);
}
$.channel.send(lines, { split: true }).catch($.handler.bind($));
},
});

109
src/commands/util.ts
View File

@ -1,58 +1,59 @@
import { MessageEmbed } from "discord.js";
import { MessageEmbed } from 'discord.js';
import Command from '../core/command';
import {CommonLibrary} from '../core/lib';
import { CommonLibrary } from '../core/lib';
export default new Command({
description: "Various utilities.",
endpoint: false,
usage: '',
async run($: CommonLibrary): Promise<any> {
},
subcommands: {
lsemotes: new Command({
description: "Lists all emotes the bot has in it's registry,",
endpoint: true,
async run($: CommonLibrary): Promise<any> {
const nsfw: string | string[] = [];
const pages = $.client.emojis.cache.filter(x => !nsfw.includes(x.guild.id), this).array();
const pagesSplit = $(pages).split(20);
$.log(pagesSplit)
var embed = new MessageEmbed()
.setTitle("**Emoji list!**")
.setColor("AQUA")
let desc = ""
for (const emote of pagesSplit[0]) {
desc += `${emote} | ${emote.name}\n`
}
embed.setDescription(desc)
const msg = await $.channel.send({embed});
description: 'Various utilities.',
endpoint: false,
usage: '',
async run($: CommonLibrary): Promise<any> {},
subcommands: {
lsemotes: new Command({
description: "Lists all emotes the bot has in it's registry,",
endpoint: true,
async run($: CommonLibrary): Promise<any> {
const nsfw: string | string[] = [];
const pages = $.client.emojis.cache
.filter((x) => !nsfw.includes(x.guild.id), this)
.array();
const pagesSplit = $(pages).split(20);
$.log(pagesSplit);
var embed = new MessageEmbed()
.setTitle('**Emoji list!**')
.setColor('AQUA');
let desc = '';
for (const emote of pagesSplit[0]) {
desc += `${emote} | ${emote.name}\n`;
}
embed.setDescription(desc);
const msg = await $.channel.send({ embed });
$.paginate(msg, $.author.id, pages.length, page => {
let desc = ""
for(const emote of pagesSplit[page]) {
desc += `${emote} | ${emote.name}\n`
}
embed.setDescription(desc)
msg.edit(embed);
});
}
}),
emote: new Command({
description: "Send the specified emote.",
run: "Please provide a command name.",
any: new Command({
description: "The emote to send.",
usage: "<emote>",
async run($: CommonLibrary): Promise<any>
{
const search = $.args[0].toLowerCase();
const emote = $.client.emojis.cache.find(emote => emote.name.toLowerCase().includes(search));
if (!emote) return $.channel.send("That's not a valid emote name!");
$.message.delete();
$.channel.send(`${emote}`);
}
})
})
}
});
$.paginate(msg, $.author.id, pages.length, (page) => {
let desc = '';
for (const emote of pagesSplit[page]) {
desc += `${emote} | ${emote.name}\n`;
}
embed.setDescription(desc);
msg.edit(embed);
});
},
}),
emote: new Command({
description: 'Send the specified emote.',
run: 'Please provide a command name.',
any: new Command({
description: 'The emote to send.',
usage: '<emote>',
async run($: CommonLibrary): Promise<any> {
const search = $.args[0].toLowerCase();
const emote = $.client.emojis.cache.find((emote) =>
emote.name.toLowerCase().includes(search),
);
if (!emote) return $.channel.send("That's not a valid emote name!");
$.message.delete();
$.channel.send(`${emote}`);
},
}),
}),
},
});

455
src/core/command.ts
View File

@ -1,232 +1,259 @@
import $, {isType, parseVars, CommonLibrary} from "./lib";
import {Collection} from "discord.js";
import {generateHandler} from "./storage";
import {promises as ffs, existsSync, writeFile} from "fs";
import {PERMISSIONS} from "./permissions";
import {getPrefix} from "../core/structures";
import $, { isType, parseVars, CommonLibrary } from './lib';
import { Collection } from 'discord.js';
import { generateHandler } from './storage';
import { promises as ffs, existsSync, writeFile } from 'fs';
import { PERMISSIONS } from './permissions';
import { getPrefix } from '../core/structures';
interface CommandOptions
{
description?: string;
endpoint?: boolean;
usage?: string;
permission?: PERMISSIONS|null;
aliases?: string[];
run?: (($: CommonLibrary) => Promise<any>)|string;
subcommands?: {[key: string]: Command};
user?: Command;
number?: Command;
any?: Command;
interface CommandOptions {
description?: string;
endpoint?: boolean;
usage?: string;
permission?: PERMISSIONS | null;
aliases?: string[];
run?: (($: CommonLibrary) => Promise<any>) | string;
subcommands?: { [key: string]: Command };
user?: Command;
number?: Command;
any?: Command;
}
export enum TYPES {SUBCOMMAND, USER, NUMBER, ANY, NONE};
export default class Command
{
public readonly description: string;
public readonly endpoint: boolean;
public readonly usage: string;
public readonly permission: PERMISSIONS|null;
public readonly aliases: string[]; // This is to keep the array intact for parent Command instances to use. It'll also be used when loading top-level aliases.
public originalCommandName: string|null; // If the command is an alias, what's the original name?
public run: (($: CommonLibrary) => Promise<any>)|string;
public readonly subcommands: Collection<string, Command>; // This is the final data structure you'll actually use to work with the commands the aliases point to.
public user: Command|null;
public number: Command|null;
public any: Command|null;
public static readonly TYPES = TYPES;
public static readonly PERMISSIONS = PERMISSIONS;
constructor(options?: CommandOptions)
{
this.description = options?.description || "No description.";
this.endpoint = options?.endpoint || false;
this.usage = options?.usage || "";
this.permission = options?.permission ?? null;
this.aliases = options?.aliases ?? [];
this.originalCommandName = null;
this.run = options?.run || "No action was set on this command!";
this.subcommands = new Collection(); // Populate this collection after setting subcommands.
this.user = options?.user || null;
this.number = options?.number || null;
this.any = options?.any || null;
if(options?.subcommands)
{
const baseSubcommands = Object.keys(options.subcommands);
// Loop once to set the base subcommands.
for(const name in options.subcommands)
this.subcommands.set(name, options.subcommands[name]);
// Then loop again to make aliases point to the base subcommands and warn if something's not right.
// This shouldn't be a problem because I'm hoping that JS stores these as references that point to the same object.
for(const name in options.subcommands)
{
const subcmd = options.subcommands[name];
subcmd.originalCommandName = name;
const aliases = subcmd.aliases;
for(const alias of aliases)
{
if(baseSubcommands.includes(alias))
$.warn(`"${alias}" in subcommand "${name}" was attempted to be declared as an alias but it already exists in the base commands! (Look at the next "Loading Command" line to see which command is affected.)`);
else if(this.subcommands.has(alias))
$.warn(`Duplicate alias "${alias}" at subcommand "${name}"! (Look at the next "Loading Command" line to see which command is affected.)`);
else
this.subcommands.set(alias, subcmd);
}
}
}
if(this.user && this.user.aliases.length > 0)
$.warn(`There are aliases defined for a "user"-type subcommand, but those aliases won't be used. (Look at the next "Loading Command" line to see which command is affected.)`);
if(this.number && this.number.aliases.length > 0)
$.warn(`There are aliases defined for a "number"-type subcommand, but those aliases won't be used. (Look at the next "Loading Command" line to see which command is affected.)`);
if(this.any && this.any.aliases.length > 0)
$.warn(`There are aliases defined for an "any"-type subcommand, but those aliases won't be used. (Look at the next "Loading Command" line to see which command is affected.)`);
}
public execute($: CommonLibrary)
{
if(isType(this.run, String))
{
$.channel.send(parseVars(this.run as string, {
author: $.author.toString(),
prefix: getPrefix($.guild)
}, "???"));
}
else
(this.run as Function)($).catch($.handler.bind($));
}
public resolve(param: string): TYPES
{
if(this.subcommands.has(param))
return TYPES.SUBCOMMAND;
// Any Discord ID format will automatically format to a user ID.
else if(this.user && (/\d{17,19}/.test(param)))
return TYPES.USER;
// Disallow infinity and allow for 0.
else if(this.number && (Number(param) || param === "0") && !param.includes("Infinity"))
return TYPES.NUMBER;
else if(this.any)
return TYPES.ANY;
else
return TYPES.NONE;
}
public get(param: string): Command
{
const type = this.resolve(param);
let command: Command;
switch(type)
{
case TYPES.SUBCOMMAND: command = this.subcommands.get(param) as Command; break;
case TYPES.USER: command = this.user as Command; break;
case TYPES.NUMBER: command = this.number as Command; break;
case TYPES.ANY: command = this.any as Command; break;
default: command = this; break;
}
return command;
}
export enum TYPES {
SUBCOMMAND,
USER,
NUMBER,
ANY,
NONE,
}
let commands: Collection<string, Command>|null = null;
export default class Command {
public readonly description: string;
public readonly endpoint: boolean;
public readonly usage: string;
public readonly permission: PERMISSIONS | null;
public readonly aliases: string[]; // This is to keep the array intact for parent Command instances to use. It'll also be used when loading top-level aliases.
public originalCommandName: string | null; // If the command is an alias, what's the original name?
public run: (($: CommonLibrary) => Promise<any>) | string;
public readonly subcommands: Collection<string, Command>; // This is the final data structure you'll actually use to work with the commands the aliases point to.
public user: Command | null;
public number: Command | null;
public any: Command | null;
public static readonly TYPES = TYPES;
public static readonly PERMISSIONS = PERMISSIONS;
constructor(options?: CommandOptions) {
this.description = options?.description || 'No description.';
this.endpoint = options?.endpoint || false;
this.usage = options?.usage || '';
this.permission = options?.permission ?? null;
this.aliases = options?.aliases ?? [];
this.originalCommandName = null;
this.run = options?.run || 'No action was set on this command!';
this.subcommands = new Collection(); // Populate this collection after setting subcommands.
this.user = options?.user || null;
this.number = options?.number || null;
this.any = options?.any || null;
if (options?.subcommands) {
const baseSubcommands = Object.keys(options.subcommands);
// Loop once to set the base subcommands.
for (const name in options.subcommands)
this.subcommands.set(name, options.subcommands[name]);
// Then loop again to make aliases point to the base subcommands and warn if something's not right.
// This shouldn't be a problem because I'm hoping that JS stores these as references that point to the same object.
for (const name in options.subcommands) {
const subcmd = options.subcommands[name];
subcmd.originalCommandName = name;
const aliases = subcmd.aliases;
for (const alias of aliases) {
if (baseSubcommands.includes(alias))
$.warn(
`"${alias}" in subcommand "${name}" was attempted to be declared as an alias but it already exists in the base commands! (Look at the next "Loading Command" line to see which command is affected.)`,
);
else if (this.subcommands.has(alias))
$.warn(
`Duplicate alias "${alias}" at subcommand "${name}"! (Look at the next "Loading Command" line to see which command is affected.)`,
);
else this.subcommands.set(alias, subcmd);
}
}
}
if (this.user && this.user.aliases.length > 0)
$.warn(
`There are aliases defined for a "user"-type subcommand, but those aliases won't be used. (Look at the next "Loading Command" line to see which command is affected.)`,
);
if (this.number && this.number.aliases.length > 0)
$.warn(
`There are aliases defined for a "number"-type subcommand, but those aliases won't be used. (Look at the next "Loading Command" line to see which command is affected.)`,
);
if (this.any && this.any.aliases.length > 0)
$.warn(
`There are aliases defined for an "any"-type subcommand, but those aliases won't be used. (Look at the next "Loading Command" line to see which command is affected.)`,
);
}
public execute($: CommonLibrary) {
if (isType(this.run, String)) {
$.channel.send(
parseVars(
this.run as string,
{
author: $.author.toString(),
prefix: getPrefix($.guild),
},
'???',
),
);
} else (this.run as Function)($).catch($.handler.bind($));
}
public resolve(param: string): TYPES {
if (this.subcommands.has(param)) return TYPES.SUBCOMMAND;
// Any Discord ID format will automatically format to a user ID.
else if (this.user && /\d{17,19}/.test(param)) return TYPES.USER;
// Disallow infinity and allow for 0.
else if (
this.number &&
(Number(param) || param === '0') &&
!param.includes('Infinity')
)
return TYPES.NUMBER;
else if (this.any) return TYPES.ANY;
else return TYPES.NONE;
}
public get(param: string): Command {
const type = this.resolve(param);
let command: Command;
switch (type) {
case TYPES.SUBCOMMAND:
command = this.subcommands.get(param) as Command;
break;
case TYPES.USER:
command = this.user as Command;
break;
case TYPES.NUMBER:
command = this.number as Command;
break;
case TYPES.ANY:
command = this.any as Command;
break;
default:
command = this;
break;
}
return command;
}
}
let commands: Collection<string, Command> | null = null;
export const categories: Collection<string, string[]> = new Collection();
export const aliases: Collection<string, string> = new Collection(); // Top-level aliases only.
/** Returns the cache of the commands if it exists and searches the directory if not. */
export async function loadCommands(): Promise<Collection<string, Command>>
{
if(commands)
return commands;
if(process.argv[2] === "dev" && !existsSync("src/commands/test.ts"))
writeFile("src/commands/test.ts", template, generateHandler('"test.ts" (testing/template command) successfully generated.'));
commands = new Collection();
const dir = await ffs.opendir("dist/commands");
const listMisc: string[] = [];
let selected;
// There will only be one level of directory searching (per category).
while(selected = await dir.read())
{
if(selected.isDirectory())
{
if(selected.name === "subcommands")
continue;
const subdir = await ffs.opendir(`dist/commands/${selected.name}`);
const category = $(selected.name).toTitleCase();
const list: string[] = [];
let cmd;
while(cmd = await subdir.read())
{
if(cmd.isDirectory())
{
if(cmd.name === "subcommands")
continue;
else
$.warn(`You can't have multiple levels of directories! From: "dist/commands/${cmd.name}"`);
}
else
loadCommand(cmd.name, list, selected.name);
}
subdir.close();
categories.set(category, list);
}
else
loadCommand(selected.name, listMisc);
}
dir.close();
categories.set("Miscellaneous", listMisc);
return commands;
export async function loadCommands(): Promise<Collection<string, Command>> {
if (commands) return commands;
if (process.argv[2] === 'dev' && !existsSync('src/commands/test.ts'))
writeFile(
'src/commands/test.ts',
template,
generateHandler(
'"test.ts" (testing/template command) successfully generated.',
),
);
commands = new Collection();
const dir = await ffs.opendir('dist/commands');
const listMisc: string[] = [];
let selected;
// There will only be one level of directory searching (per category).
while ((selected = await dir.read())) {
if (selected.isDirectory()) {
if (selected.name === 'subcommands') continue;
const subdir = await ffs.opendir(`dist/commands/${selected.name}`);
const category = $(selected.name).toTitleCase();
const list: string[] = [];
let cmd;
while ((cmd = await subdir.read())) {
if (cmd.isDirectory()) {
if (cmd.name === 'subcommands') continue;
else
$.warn(
`You can't have multiple levels of directories! From: "dist/commands/${cmd.name}"`,
);
} else loadCommand(cmd.name, list, selected.name);
}
subdir.close();
categories.set(category, list);
} else loadCommand(selected.name, listMisc);
}
dir.close();
categories.set('Miscellaneous', listMisc);
return commands;
}
async function loadCommand(filename: string, list: string[], category?: string)
{
if(!commands)
return $.error(`Function "loadCommand" was called without first initializing commands!`);
const prefix = category ?? "";
const header = filename.substring(0, filename.indexOf(".js"));
const command = (await import(`../commands/${prefix}/${header}`)).default as Command|undefined;
if(!command)
return $.warn(`Command "${header}" has no default export which is a Command instance!`);
command.originalCommandName = header;
list.push(header);
if(commands.has(header))
$.warn(`Command "${header}" already exists! Make sure to make each command uniquely identifiable across categories!`);
else
commands.set(header, command);
for(const alias of command.aliases)
{
if(commands.has(alias))
$.warn(`Top-level alias "${alias}" from command "${header}" already exists either as a command or alias!`);
else
commands.set(alias, command);
}
$.log(`Loading Command: ${header} (${category ? $(category).toTitleCase() : "Miscellaneous"})`);
async function loadCommand(
filename: string,
list: string[],
category?: string,
) {
if (!commands)
return $.error(
`Function "loadCommand" was called without first initializing commands!`,
);
const prefix = category ?? '';
const header = filename.substring(0, filename.indexOf('.js'));
const command = (await import(`../commands/${prefix}/${header}`)).default as
| Command
| undefined;
if (!command)
return $.warn(
`Command "${header}" has no default export which is a Command instance!`,
);
command.originalCommandName = header;
list.push(header);
if (commands.has(header))
$.warn(
`Command "${header}" already exists! Make sure to make each command uniquely identifiable across categories!`,
);
else commands.set(header, command);
for (const alias of command.aliases) {
if (commands.has(alias))
$.warn(
`Top-level alias "${alias}" from command "${header}" already exists either as a command or alias!`,
);
else commands.set(alias, command);
}
$.log(
`Loading Command: ${header} (${
category ? $(category).toTitleCase() : 'Miscellaneous'
})`,
);
}
// The template should be built with a reductionist mentality.
// Provide everything the user needs and then let them remove whatever they want.
// That way, they aren't focusing on what's missing, but rather what they need for their command.
const template =
`import Command from '../core/command';
const template = `import Command from '../core/command';
import {CommonLibrary} from '../core/lib';
export default new Command({
@ -277,4 +304,4 @@ export default new Command({
}
})
});`;
});`;

78
src/core/event.ts
View File

@ -1,47 +1,41 @@
import {Client, ClientEvents, Constants} from "discord.js";
import Storage from "./storage";
import $ from "./lib";
import { Client, ClientEvents, Constants } from 'discord.js';
import Storage from './storage';
import $ from './lib';
interface EventOptions<K extends keyof ClientEvents>
{
readonly on?: (...args: ClientEvents[K]) => void;
readonly once?: (...args: ClientEvents[K]) => void;
interface EventOptions<K extends keyof ClientEvents> {
readonly on?: (...args: ClientEvents[K]) => void;
readonly once?: (...args: ClientEvents[K]) => void;
}
export default class Event<K extends keyof ClientEvents>
{
private readonly on?: (...args: ClientEvents[K]) => void;
private readonly once?: (...args: ClientEvents[K]) => void;
constructor(options: EventOptions<K>)
{
this.on = options.on;
this.once = options.once;
}
// For this function, I'm going to assume that the event is used with the correct arguments and that the event tag is checked in "storage.ts".
public attach(client: Client, event: K)
{
if(this.on)
client.on(event, this.on);
if(this.once)
client.once(event, this.once);
}
export default class Event<K extends keyof ClientEvents> {
private readonly on?: (...args: ClientEvents[K]) => void;
private readonly once?: (...args: ClientEvents[K]) => void;
constructor(options: EventOptions<K>) {
this.on = options.on;
this.once = options.once;
}
// For this function, I'm going to assume that the event is used with the correct arguments and that the event tag is checked in "storage.ts".
public attach(client: Client, event: K) {
if (this.on) client.on(event, this.on);
if (this.once) client.once(event, this.once);
}
}
export async function loadEvents(client: Client)
{
for(const file of Storage.open("dist/events", (filename: string) => filename.endsWith(".js")))
{
const header = file.substring(0, file.indexOf(".js"));
const event = (await import(`../events/${header}`)).default;
if((Object.values(Constants.Events) as string[]).includes(header))
{
event.attach(client, header);
$.log(`Loading Event: ${header}`);
}
else
$.warn(`"${header}" is not a valid event type! Did you misspell it? (Note: If you fixed the issue, delete "dist" because the compiler won't automatically delete any extra files.)`);
}
}
export async function loadEvents(client: Client) {
for (const file of Storage.open('dist/events', (filename: string) =>
filename.endsWith('.js'),
)) {
const header = file.substring(0, file.indexOf('.js'));
const event = (await import(`../events/${header}`)).default;
if ((Object.values(Constants.Events) as string[]).includes(header)) {
event.attach(client, header);
$.log(`Loading Event: ${header}`);
} else
$.warn(
`"${header}" is not a valid event type! Did you misspell it? (Note: If you fixed the issue, delete "dist" because the compiler won't automatically delete any extra files.)`,
);
}
}

667
src/core/lib.ts
View File

@ -1,249 +1,323 @@
import {GenericWrapper, NumberWrapper, StringWrapper, ArrayWrapper} from "./wrappers";
import {Client, Message, TextChannel, DMChannel, NewsChannel, Guild, User, GuildMember, Permissions} from "discord.js";
import chalk from "chalk";
import FileManager from "./storage";
import {eventListeners} from "../events/messageReactionRemove";
import {client} from "../index";
import {
GenericWrapper,
NumberWrapper,
StringWrapper,
ArrayWrapper,
} from './wrappers';
import {
Client,
Message,
TextChannel,
DMChannel,
NewsChannel,
Guild,
User,
GuildMember,
Permissions,
} from 'discord.js';
import chalk from 'chalk';
import FileManager from './storage';
import { eventListeners } from '../events/messageReactionRemove';
import { client } from '../index';
/** A type that describes what the library module does. */
export interface CommonLibrary
{
// Wrapper Object //
/** Wraps the value you enter with an object that provides extra functionality and provides common utility functions. */
(value: number): NumberWrapper;
(value: string): StringWrapper;
<T>(value: T[]): ArrayWrapper<T>;
<T>(value: T): GenericWrapper<T>;
// Common Library Functions //
/** <Promise>.catch($.handler.bind($)) or <Promise>.catch(error => $.handler(error)) */
handler: (error: Error) => void;
log: (...args: any[]) => void;
warn: (...args: any[]) => void;
error: (...args: any[]) => void;
debug: (...args: any[]) => void;
ready: (...args: any[]) => void;
paginate: (message: Message, senderID: string, total: number, callback: (page: number) => void, duration?: number) => void;
prompt: (message: Message, senderID: string, onConfirm: () => void, duration?: number) => void;
getMemberByUsername: (guild: Guild, username: string) => Promise<GuildMember|undefined>;
callMemberByUsername: (message: Message, username: string, onSuccess: (member: GuildMember) => void) => Promise<void>;
// Dynamic Properties //
args: any[];
client: Client;
message: Message;
channel: TextChannel|DMChannel|NewsChannel;
guild: Guild|null;
author: User;
member: GuildMember|null;
export interface CommonLibrary {
// Wrapper Object //
/** Wraps the value you enter with an object that provides extra functionality and provides common utility functions. */
(value: number): NumberWrapper;
(value: string): StringWrapper;
<T>(value: T[]): ArrayWrapper<T>;
<T>(value: T): GenericWrapper<T>;
// Common Library Functions //
/** <Promise>.catch($.handler.bind($)) or <Promise>.catch(error => $.handler(error)) */
handler: (error: Error) => void;
log: (...args: any[]) => void;
warn: (...args: any[]) => void;
error: (...args: any[]) => void;
debug: (...args: any[]) => void;
ready: (...args: any[]) => void;
paginate: (
message: Message,
senderID: string,
total: number,
callback: (page: number) => void,
duration?: number,
) => void;
prompt: (
message: Message,
senderID: string,
onConfirm: () => void,
duration?: number,
) => void;
getMemberByUsername: (
guild: Guild,
username: string,
) => Promise<GuildMember | undefined>;
callMemberByUsername: (
message: Message,
username: string,
onSuccess: (member: GuildMember) => void,
) => Promise<void>;
// Dynamic Properties //
args: any[];
client: Client;
message: Message;
channel: TextChannel | DMChannel | NewsChannel;
guild: Guild | null;
author: User;
member: GuildMember | null;
}
export default function $(value: number): NumberWrapper;
export default function $(value: string): StringWrapper;
export default function $<T>(value: T[]): ArrayWrapper<T>;
export default function $<T>(value: T): GenericWrapper<T>;
export default function $(value: any)
{
if(isType(value, Number))
return new NumberWrapper(value);
else if(isType(value, String))
return new StringWrapper(value);
else if(isType(value, Array))
return new ArrayWrapper(value);
else
return new GenericWrapper(value);
export default function $(value: any) {
if (isType(value, Number)) return new NumberWrapper(value);
else if (isType(value, String)) return new StringWrapper(value);
else if (isType(value, Array)) return new ArrayWrapper(value);
else return new GenericWrapper(value);
}
// If you use promises, use this function to display the error in chat.
// Case #1: await $.channel.send(""); --> Automatically caught by Command.execute().
// Case #2: $.channel.send("").catch($.handler.bind($)); --> Manually caught by the user.
$.handler = function(this: CommonLibrary, error: Error)
{
if(this)
this.channel.send(`There was an error while trying to execute that command!\`\`\`${error.stack ?? error}\`\`\``);
else
$.warn("No context was attached to $.handler! Make sure to use .catch($.handler.bind($)) or .catch(error => $.handler(error)) instead!");
$.error(error);
$.handler = function (this: CommonLibrary, error: Error) {
if (this)
this.channel.send(
`There was an error while trying to execute that command!\`\`\`${
error.stack ?? error
}\`\`\``,
);
else
$.warn(
'No context was attached to $.handler! Make sure to use .catch($.handler.bind($)) or .catch(error => $.handler(error)) instead!',
);
$.error(error);
};
// Logs with different levels of verbosity.
export const logs: {[type: string]: string} = {
error: "",
warn: "",
info: "",
verbose: ""
export const logs: { [type: string]: string } = {
error: '',
warn: '',
info: '',
verbose: '',
};
let enabled = true;
export function setConsoleActivated(activated: boolean) {enabled = activated};
export function setConsoleActivated(activated: boolean) {
enabled = activated;
}
// The custom console. In order of verbosity, error, warn, log, and debug. Ready is a variation of log.
// General Purpose Logger
$.log = (...args: any[]) => {
if(enabled)
console.log(chalk.white.bgGray(formatTimestamp()), chalk.black.bgWhite("INFO"), ...args);
const text = `[${formatUTCTimestamp()}] [INFO] ${args.join(" ")}\n`;
logs.info += text;
logs.verbose += text;
if (enabled)
console.log(
chalk.white.bgGray(formatTimestamp()),
chalk.black.bgWhite('INFO'),
...args,
);
const text = `[${formatUTCTimestamp()}] [INFO] ${args.join(' ')}\n`;
logs.info += text;
logs.verbose += text;
};
// "It'll still work, but you should really check up on this."
$.warn = (...args: any[]) => {
if(enabled)
console.warn(chalk.white.bgGray(formatTimestamp()), chalk.black.bgYellow("WARN"), ...args);
const text = `[${formatUTCTimestamp()}] [WARN] ${args.join(" ")}\n`;
logs.warn += text;
logs.info += text;
logs.verbose += text;
if (enabled)
console.warn(
chalk.white.bgGray(formatTimestamp()),
chalk.black.bgYellow('WARN'),
...args,
);
const text = `[${formatUTCTimestamp()}] [WARN] ${args.join(' ')}\n`;
logs.warn += text;
logs.info += text;
logs.verbose += text;
};
// Used for anything which prevents the program from actually running.
$.error = (...args: any[]) => {
if(enabled)
console.error(chalk.white.bgGray(formatTimestamp()), chalk.white.bgRed("ERROR"), ...args);
const text = `[${formatUTCTimestamp()}] [ERROR] ${args.join(" ")}\n`;
logs.error += text;
logs.warn += text;
logs.info += text;
logs.verbose += text;
if (enabled)
console.error(
chalk.white.bgGray(formatTimestamp()),
chalk.white.bgRed('ERROR'),
...args,
);
const text = `[${formatUTCTimestamp()}] [ERROR] ${args.join(' ')}\n`;
logs.error += text;
logs.warn += text;
logs.info += text;
logs.verbose += text;
};
// Be as verbose as possible. If anything might help when debugging an error, then include it. This only shows in your console if you run this with "dev", but you can still get it from "logs.verbose".
// $.debug(`core/lib::parseArgs("testing \"in progress\"") = ["testing", "in progress"]`) --> <path>/::(<object>.)<function>(<args>) = <value>
// Would probably be more suited for debugging program logic rather than function logic, which can be checked using unit tests.
$.debug = (...args: any[]) => {
if(process.argv[2] === "dev" && enabled)
console.debug(chalk.white.bgGray(formatTimestamp()), chalk.white.bgBlue("DEBUG"), ...args);
const text = `[${formatUTCTimestamp()}] [DEBUG] ${args.join(" ")}\n`;
logs.verbose += text;
if (process.argv[2] === 'dev' && enabled)
console.debug(
chalk.white.bgGray(formatTimestamp()),
chalk.white.bgBlue('DEBUG'),
...args,
);
const text = `[${formatUTCTimestamp()}] [DEBUG] ${args.join(' ')}\n`;
logs.verbose += text;
};
// Used once at the start of the program when the bot loads.
$.ready = (...args: any[]) => {
if(enabled)
console.log(chalk.white.bgGray(formatTimestamp()), chalk.black.bgGreen("READY"), ...args);
const text = `[${formatUTCTimestamp()}] [READY] ${args.join(" ")}\n`;
logs.info += text;
logs.verbose += text;
if (enabled)
console.log(
chalk.white.bgGray(formatTimestamp()),
chalk.black.bgGreen('READY'),
...args,
);
const text = `[${formatUTCTimestamp()}] [READY] ${args.join(' ')}\n`;
logs.info += text;
logs.verbose += text;
};
export function formatTimestamp(now = new Date())
{
const year = now.getFullYear();
const month = (now.getMonth() + 1).toString().padStart(2, '0');
const day = now.getDate().toString().padStart(2, '0');
const hour = now.getHours().toString().padStart(2, '0');
const minute = now.getMinutes().toString().padStart(2, '0');
const second = now.getSeconds().toString().padStart(2, '0');
return `${year}-${month}-${day} ${hour}:${minute}:${second}`;
export function formatTimestamp(now = new Date()) {
const year = now.getFullYear();
const month = (now.getMonth() + 1).toString().padStart(2, '0');
const day = now.getDate().toString().padStart(2, '0');
const hour = now.getHours().toString().padStart(2, '0');
const minute = now.getMinutes().toString().padStart(2, '0');
const second = now.getSeconds().toString().padStart(2, '0');
return `${year}-${month}-${day} ${hour}:${minute}:${second}`;
}
export function formatUTCTimestamp(now = new Date())
{
const year = now.getUTCFullYear();
const month = (now.getUTCMonth() + 1).toString().padStart(2, '0');
const day = now.getUTCDate().toString().padStart(2, '0');
const hour = now.getUTCHours().toString().padStart(2, '0');
const minute = now.getUTCMinutes().toString().padStart(2, '0');
const second = now.getUTCSeconds().toString().padStart(2, '0');
return `${year}-${month}-${day} ${hour}:${minute}:${second}`;
export function formatUTCTimestamp(now = new Date()) {
const year = now.getUTCFullYear();
const month = (now.getUTCMonth() + 1).toString().padStart(2, '0');
const day = now.getUTCDate().toString().padStart(2, '0');
const hour = now.getUTCHours().toString().padStart(2, '0');
const minute = now.getUTCMinutes().toString().padStart(2, '0');
const second = now.getUTCSeconds().toString().padStart(2, '0');
return `${year}-${month}-${day} ${hour}:${minute}:${second}`;
}
export function botHasPermission(guild: Guild|null, permission: number): boolean
{
return !!(client.user && guild?.members.resolve(client.user)?.hasPermission(permission))
export function botHasPermission(
guild: Guild | null,
permission: number,
): boolean {
return !!(
client.user &&
guild?.members.resolve(client.user)?.hasPermission(permission)
);
}
// Pagination function that allows for customization via a callback.
// Define your own pages outside the function because this only manages the actual turning of pages.
$.paginate = async(message: Message, senderID: string, total: number, callback: (page: number) => void, duration = 60000) => {
let page = 0;
const turn = (amount: number) => {
page += amount;
if(page < 0)
page += total;
else if(page >= total)
page -= total;
callback(page);
}
const handle = (emote: string, reacterID: string) => {
switch(emote)
{
case '⬅️': turn(-1); break;
case '➡️': turn(1); break;
}
};
$.paginate = async (
message: Message,
senderID: string,
total: number,
callback: (page: number) => void,
duration = 60000,
) => {
let page = 0;
const turn = (amount: number) => {
page += amount;
// Listen for reactions and call the handler.
await message.react('⬅️');
await message.react('➡️');
eventListeners.set(message.id, handle);
await message.awaitReactions((reaction, user) => {
if(user.id === senderID)
{
// The reason this is inside the call is because it's possible to switch a user's permissions halfway and suddenly throw an error.
// This will dynamically adjust for that, switching modes depending on whether it currently has the "Manage Messages" permission.
const canDeleteEmotes = botHasPermission(message.guild, Permissions.FLAGS.MANAGE_MESSAGES);
handle(reaction.emoji.name, user.id);
if(canDeleteEmotes)
reaction.users.remove(user);
}
return false;
}, {time: duration});
// When time's up, remove the bot's own reactions.
eventListeners.delete(message.id);
message.reactions.cache.get('⬅️')?.users.remove(message.author);
message.reactions.cache.get('➡️')?.users.remove(message.author);
if (page < 0) page += total;
else if (page >= total) page -= total;
callback(page);
};
const handle = (emote: string, reacterID: string) => {
switch (emote) {
case '⬅️':
turn(-1);
break;
case '➡️':
turn(1);
break;
}
};
// Listen for reactions and call the handler.
await message.react('⬅️');
await message.react('➡️');
eventListeners.set(message.id, handle);
await message.awaitReactions(
(reaction, user) => {
if (user.id === senderID) {
// The reason this is inside the call is because it's possible to switch a user's permissions halfway and suddenly throw an error.
// This will dynamically adjust for that, switching modes depending on whether it currently has the "Manage Messages" permission.
const canDeleteEmotes = botHasPermission(
message.guild,
Permissions.FLAGS.MANAGE_MESSAGES,
);
handle(reaction.emoji.name, user.id);
if (canDeleteEmotes) reaction.users.remove(user);
}
return false;
},
{ time: duration },
);
// When time's up, remove the bot's own reactions.
eventListeners.delete(message.id);
message.reactions.cache.get('⬅️')?.users.remove(message.author);
message.reactions.cache.get('➡️')?.users.remove(message.author);
};
// Waits for the sender to either confirm an action or let it pass (and delete the message).
$.prompt = async(message: Message, senderID: string, onConfirm: () => void, duration = 10000) => {
let isDeleted = false;
message.react('✅');
await message.awaitReactions((reaction, user) => {
if(user.id === senderID)
{
if(reaction.emoji.name === '✅')
onConfirm();
isDeleted = true;
message.delete();
}
// CollectorFilter requires a boolean to be returned.
// My guess is that the return value of awaitReactions can be altered by making a boolean filter.
// However, because that's not my concern with this command, I don't have to worry about it.
// May as well just set it to false because I'm not concerned with collecting any reactions.
return false;
}, {time: duration});
if(!isDeleted)
message.delete();
$.prompt = async (
message: Message,
senderID: string,
onConfirm: () => void,
duration = 10000,
) => {
let isDeleted = false;
message.react('✅');
await message.awaitReactions(
(reaction, user) => {
if (user.id === senderID) {
if (reaction.emoji.name === '✅') onConfirm();
isDeleted = true;
message.delete();
}
// CollectorFilter requires a boolean to be returned.
// My guess is that the return value of awaitReactions can be altered by making a boolean filter.
// However, because that's not my concern with this command, I don't have to worry about it.
// May as well just set it to false because I'm not concerned with collecting any reactions.
return false;
},
{ time: duration },
);
if (!isDeleted) message.delete();
};
$.getMemberByUsername = async(guild: Guild, username: string) => {
return (await guild.members.fetch({
query: username,
limit: 1
})).first();
$.getMemberByUsername = async (guild: Guild, username: string) => {
return (
await guild.members.fetch({
query: username,
limit: 1,
})
).first();
};
/** Convenience function to handle false cases automatically. */
$.callMemberByUsername = async(message: Message, username: string, onSuccess: (member: GuildMember) => void) => {
const guild = message.guild;
const send = message.channel.send;
if(guild)
{
const member = await $.getMemberByUsername(guild, username);
if(member)
onSuccess(member);
else
send(`Couldn't find a user by the name of \`${username}\`!`);
}
else
send("You must execute this command in a server!");
$.callMemberByUsername = async (
message: Message,
username: string,
onSuccess: (member: GuildMember) => void,
) => {
const guild = message.guild;
const send = message.channel.send;
if (guild) {
const member = await $.getMemberByUsername(guild, username);
if (member) onSuccess(member);
else send(`Couldn't find a user by the name of \`${username}\`!`);
} else send('You must execute this command in a server!');
};
/**
@ -251,41 +325,29 @@ $.callMemberByUsername = async(message: Message, username: string, onSuccess: (m
* - `\"` = `"`
* - `\\` = `\`
*/
export function parseArgs(line: string): string[]
{
let result = [];
let selection = "";
let inString = false;
let isEscaped = false;
for(let c of line)
{
if(isEscaped)
{
if(['"', '\\'].includes(c))
selection += c;
else
selection += '\\' + c;
isEscaped = false;
}
else if(c === '\\')
isEscaped = true;
else if(c === '"')
inString = !inString;
else if(c === ' ' && !inString)
{
result.push(selection);
selection = "";
}
else
selection += c;
}
if(selection.length > 0)
result.push(selection)
return result;
export function parseArgs(line: string): string[] {
let result = [];
let selection = '';
let inString = false;
let isEscaped = false;
for (let c of line) {
if (isEscaped) {
if (['"', '\\'].includes(c)) selection += c;
else selection += '\\' + c;
isEscaped = false;
} else if (c === '\\') isEscaped = true;
else if (c === '"') inString = !inString;
else if (c === ' ' && !inString) {
result.push(selection);
selection = '';
} else selection += c;
}
if (selection.length > 0) result.push(selection);
return result;
}
/**
@ -294,52 +356,41 @@ export function parseArgs(line: string): string[]
* - `%%` = `%`
* - If the invalid token is null/undefined, nothing is changed.
*/
export function parseVars(line: string, definitions: {[key: string]: string}, invalid: string|null = ""): string
{
let result = "";
let inVariable = false;
let token = "";
for(const c of line)
{
if(c === '%')
{
if(inVariable)
{
if(token === "")
result += '%';
else
{
if(token in definitions)
result += definitions[token];
else if(invalid === null)
result += `%${token}%`;
else
result += invalid;
token = "";
}
}
inVariable = !inVariable;
}
else if(inVariable)
token += c;
else
result += c;
}
return result;
export function parseVars(
line: string,
definitions: { [key: string]: string },
invalid: string | null = '',
): string {
let result = '';
let inVariable = false;
let token = '';
for (const c of line) {
if (c === '%') {
if (inVariable) {
if (token === '') result += '%';
else {
if (token in definitions) result += definitions[token];
else if (invalid === null) result += `%${token}%`;
else result += invalid;
token = '';
}
}
inVariable = !inVariable;
} else if (inVariable) token += c;
else result += c;
}
return result;
}
export function isType(value: any, type: any): boolean
{
if(value === undefined && type === undefined)
return true;
else if(value === null && type === null)
return true;
else
return value !== undefined && value !== null && value.constructor === type;
export function isType(value: any, type: any): boolean {
if (value === undefined && type === undefined) return true;
else if (value === null && type === null) return true;
else
return value !== undefined && value !== null && value.constructor === type;
}
/**
@ -348,54 +399,48 @@ export function isType(value: any, type: any): boolean
* If at any point the value doesn't match the data structure provided, the fallback is returned.
* Warning: Type checking is based on the fallback's type. Be sure that the "type" parameter is accurate to this!
*/
export function select<T>(value: any, fallback: T, type: Function, isArray = false): T
{
if(isArray && isType(value, Array))
{
for(let item of value)
if(!isType(item, type))
return fallback;
return value;
}
else
{
if(isType(value, type))
return value;
else
return fallback;
}
export function select<T>(
value: any,
fallback: T,
type: Function,
isArray = false,
): T {
if (isArray && isType(value, Array)) {
for (let item of value) if (!isType(item, type)) return fallback;
return value;
} else {
if (isType(value, type)) return value;
else return fallback;
}
}
export interface GenericJSON
{
[key: string]: any;
export interface GenericJSON {
[key: string]: any;
}
export abstract class GenericStructure
{
private __meta__ = "generic";
constructor(tag?: string)
{
this.__meta__ = tag || this.__meta__;
}
public save(asynchronous = true)
{
const tag = this.__meta__;
/// @ts-ignore
delete this.__meta__;
FileManager.write(tag, this, asynchronous);
this.__meta__ = tag;
}
export abstract class GenericStructure {
private __meta__ = 'generic';
constructor(tag?: string) {
this.__meta__ = tag || this.__meta__;
}
public save(asynchronous = true) {
const tag = this.__meta__;
/// @ts-ignore
delete this.__meta__;
FileManager.write(tag, this, asynchronous);
this.__meta__ = tag;
}
}
// A 50% chance would be "Math.random() < 0.5" because Math.random() can be [0, 1), so to make two equal ranges, you'd need [0, 0.5)U[0.5, 1).
// Similar logic would follow for any other percentage. Math.random() < 1 is always true (100% chance) and Math.random() < 0 is always false (0% chance).
export const Random = {
num: (min: number, max: number) => (Math.random() * (max - min)) + min,
int: (min: number, max: number) => Math.floor(Random.num(min, max)),
chance: (decimal: number) => Math.random() < decimal,
sign: (number = 1) => number * (Random.chance(0.5) ? -1 : 1),
deviation: (base: number, deviation: number) => Random.num(base - deviation, base + deviation)
};
num: (min: number, max: number) => Math.random() * (max - min) + min,
int: (min: number, max: number) => Math.floor(Random.num(min, max)),
chance: (decimal: number) => Math.random() < decimal,
sign: (number = 1) => number * (Random.chance(0.5) ? -1 : 1),
deviation: (base: number, deviation: number) =>
Random.num(base - deviation, base + deviation),
};

113
src/core/permissions.ts
View File

@ -1,63 +1,80 @@
import {GuildMember, Permissions} from "discord.js";
import {Config} from "./structures";
import $ from "./lib";
import { GuildMember, Permissions } from 'discord.js';
import { Config } from './structures';
import $ from './lib';
export enum PERMISSIONS {NONE, MOD, ADMIN, OWNER, BOT_SUPPORT, BOT_ADMIN, BOT_OWNER};
export const PermissionNames = ["User", "Moderator", "Administrator", "Server Owner", "Bot Support", "Bot Admin", "Bot Owner"];
export enum PERMISSIONS {
NONE,
MOD,
ADMIN,
OWNER,
BOT_SUPPORT,
BOT_ADMIN,
BOT_OWNER,
}
export const PermissionNames = [
'User',
'Moderator',
'Administrator',
'Server Owner',
'Bot Support',
'Bot Admin',
'Bot Owner',
];
// Here is where you enter in the functions that check for permissions.
const PermissionChecker: ((member: GuildMember) => boolean)[] = [
// NONE //
() => true,
// MOD //
member =>
member.hasPermission(Permissions.FLAGS.MANAGE_ROLES) ||
member.hasPermission(Permissions.FLAGS.MANAGE_MESSAGES) ||
member.hasPermission(Permissions.FLAGS.KICK_MEMBERS) ||
member.hasPermission(Permissions.FLAGS.BAN_MEMBERS),
// ADMIN //
member => member.hasPermission(Permissions.FLAGS.ADMINISTRATOR),
// OWNER //
member => member.guild.ownerID === member.id,
// BOT_SUPPORT //
member => Config.support.includes(member.id),
// BOT_ADMIN //
member => Config.admins.includes(member.id),
// BOT_OWNER //
member => Config.owner === member.id
// NONE //
() => true,
// MOD //
(member) =>
member.hasPermission(Permissions.FLAGS.MANAGE_ROLES) ||
member.hasPermission(Permissions.FLAGS.MANAGE_MESSAGES) ||
member.hasPermission(Permissions.FLAGS.KICK_MEMBERS) ||
member.hasPermission(Permissions.FLAGS.BAN_MEMBERS),
// ADMIN //
(member) => member.hasPermission(Permissions.FLAGS.ADMINISTRATOR),
// OWNER //
(member) => member.guild.ownerID === member.id,
// BOT_SUPPORT //
(member) => Config.support.includes(member.id),
// BOT_ADMIN //
(member) => Config.admins.includes(member.id),
// BOT_OWNER //
(member) => Config.owner === member.id,
];
// After checking the lengths of these three objects, use this as the length for consistency.
const length = Object.keys(PERMISSIONS).length / 2;
export function hasPermission(member: GuildMember, permission: PERMISSIONS): boolean
{
for(let i = length-1; i >= permission; i--)
if(PermissionChecker[i](member))
return true;
return false;
export function hasPermission(
member: GuildMember,
permission: PERMISSIONS,
): boolean {
for (let i = length - 1; i >= permission; i--)
if (PermissionChecker[i](member)) return true;
return false;
}
export function getPermissionLevel(member: GuildMember): number
{
for(let i = length-1; i >= 0; i--)
if(PermissionChecker[i](member))
return i;
return 0;
export function getPermissionLevel(member: GuildMember): number {
for (let i = length - 1; i >= 0; i--)
if (PermissionChecker[i](member)) return i;
return 0;
}
// Length Checking
(() => {
const lenNames = PermissionNames.length;
const lenChecker = PermissionChecker.length;
// By transitive property, lenNames and lenChecker have to be equal to each other as well.
if(length !== lenNames || length !== lenChecker)
$.error(`Permission object lengths aren't equal! Enum Length (${length}), Names Length (${lenNames}), and Functions Length (${lenChecker}). This WILL cause problems!`);
})()
const lenNames = PermissionNames.length;
const lenChecker = PermissionChecker.length;
// By transitive property, lenNames and lenChecker have to be equal to each other as well.
if (length !== lenNames || length !== lenChecker)
$.error(
`Permission object lengths aren't equal! Enum Length (${length}), Names Length (${lenNames}), and Functions Length (${lenChecker}). This WILL cause problems!`,
);
})();

159
src/core/storage.ts
View File

@ -1,84 +1,85 @@
import fs from "fs";
import $ from "./lib";
import fs from 'fs';
import $ from './lib';
const Storage = {
read(header: string): object
{
this.open("data");
const path = `data/${header}.json`;
let data = {};
if(fs.existsSync(path))
{
const file = fs.readFileSync(path, "utf-8");
try
{
data = JSON.parse(file);
}
catch(error)
{
if(process.argv[2] !== "dev")
{
$.warn(`Malformed JSON data (header: ${header}), backing it up.`, file);
fs.writeFile(`${path}.backup`, file, generateHandler(`Backup file of "${header}" successfully written as ${file}.`));
}
}
}
return data;
},
write(header: string, data: object, asynchronous = true)
{
this.open("data");
const path = `data/${header}.json`;
if(process.argv[2] === "dev" || header === "config")
{
const result = JSON.stringify(data, null, '\t');
if(asynchronous)
fs.writeFile(path, result, generateHandler(`"${header}" sucessfully spaced and written.`));
else
fs.writeFileSync(path, result);
}
else
{
const result = JSON.stringify(data);
if(asynchronous)
fs.writeFile(path, result, generateHandler(`"${header}" sucessfully written.`));
else
fs.writeFileSync(path, result);
}
},
open(path: string, filter?: (value: string, index: number, array: string[]) => unknown): string[]
{
if(!fs.existsSync(path))
fs.mkdirSync(path);
let directory = fs.readdirSync(path);
if(filter)
directory = directory.filter(filter);
return directory;
},
close(path: string)
{
if(fs.existsSync(path) && fs.readdirSync(path).length === 0)
fs.rmdir(path, generateHandler(`"${path}" successfully closed.`));
}
read(header: string): object {
this.open('data');
const path = `data/${header}.json`;
let data = {};
if (fs.existsSync(path)) {
const file = fs.readFileSync(path, 'utf-8');
try {
data = JSON.parse(file);
} catch (error) {
if (process.argv[2] !== 'dev') {
$.warn(
`Malformed JSON data (header: ${header}), backing it up.`,
file,
);
fs.writeFile(
`${path}.backup`,
file,
generateHandler(
`Backup file of "${header}" successfully written as ${file}.`,
),
);
}
}
}
return data;
},
write(header: string, data: object, asynchronous = true) {
this.open('data');
const path = `data/${header}.json`;
if (process.argv[2] === 'dev' || header === 'config') {
const result = JSON.stringify(data, null, '\t');
if (asynchronous)
fs.writeFile(
path,
result,
generateHandler(`"${header}" sucessfully spaced and written.`),
);
else fs.writeFileSync(path, result);
} else {
const result = JSON.stringify(data);
if (asynchronous)
fs.writeFile(
path,
result,
generateHandler(`"${header}" sucessfully written.`),
);
else fs.writeFileSync(path, result);
}
},
open(
path: string,
filter?: (value: string, index: number, array: string[]) => unknown,
): string[] {
if (!fs.existsSync(path)) fs.mkdirSync(path);
let directory = fs.readdirSync(path);
if (filter) directory = directory.filter(filter);
return directory;
},
close(path: string) {
if (fs.existsSync(path) && fs.readdirSync(path).length === 0)
fs.rmdir(path, generateHandler(`"${path}" successfully closed.`));
},
};
export function generateHandler(message: string)
{
return (error: Error|null) => {
if(error)
$.error(error);
else
$.debug(message);
};
};
export function generateHandler(message: string) {
return (error: Error | null) => {
if (error) $.error(error);
else $.debug(message);
};
}
export default Storage;
export default Storage;

205
src/core/structures.ts
View File

@ -1,123 +1,112 @@
import FileManager from "./storage";
import $, {select, GenericJSON, GenericStructure} from "./lib";
import {watch} from "fs";
import {Guild as DiscordGuild} from "discord.js";
import FileManager from './storage';
import $, { select, GenericJSON, GenericStructure } from './lib';
import { watch } from 'fs';
import { Guild as DiscordGuild } from 'discord.js';
class ConfigStructure extends GenericStructure
{
public token: string;
public prefix: string;
public owner: string;
public admins: string[];
public support: string[];
constructor(data: GenericJSON)
{
super("config");
this.token = select(data.token, "<ENTER YOUR TOKEN HERE>", String);
this.prefix = select(data.prefix, "$", String);
this.owner = select(data.owner, "", String);
this.admins = select(data.admins, [], String, true);
this.support = select(data.support, [], String, true);
}
class ConfigStructure extends GenericStructure {
public token: string;
public prefix: string;
public owner: string;
public admins: string[];
public support: string[];
constructor(data: GenericJSON) {
super('config');
this.token = select(data.token, '<ENTER YOUR TOKEN HERE>', String);
this.prefix = select(data.prefix, '$', String);
this.owner = select(data.owner, '', String);
this.admins = select(data.admins, [], String, true);
this.support = select(data.support, [], String, true);
}
}
class User
{
public money: number;
public lastReceived: number;
constructor(data?: GenericJSON)
{
this.money = select(data?.money, 0, Number);
this.lastReceived = select(data?.lastReceived, -1, Number);
}
class User {
public money: number;
public lastReceived: number;
constructor(data?: GenericJSON) {
this.money = select(data?.money, 0, Number);
this.lastReceived = select(data?.lastReceived, -1, Number);
}
}
class Guild
{
public prefix: string|null;
constructor(data?: GenericJSON)
{
this.prefix = select(data?.prefix, null, String);
}
class Guild {
public prefix: string | null;
constructor(data?: GenericJSON) {
this.prefix = select(data?.prefix, null, String);
}
}
class StorageStructure extends GenericStructure
{
public users: {[id: string]: User};
public guilds: {[id: string]: Guild};
constructor(data: GenericJSON)
{
super("storage");
this.users = {};
this.guilds = {};
for(let id in data.users)
if(/\d{17,19}/g.test(id))
this.users[id] = new User(data.users[id]);
for(let id in data.guilds)
if(/\d{17,19}/g.test(id))
this.guilds[id] = new Guild(data.guilds[id]);
}
/** Gets a user's profile if they exist and generate one if not. */
public getUser(id: string): User
{
if(!/\d{17,19}/g.test(id))
$.warn(`"${id}" is not a valid user ID! It will be erased when the data loads again.`);
if(id in this.users)
return this.users[id];
else
{
const user = new User();
this.users[id] = user;
return user;
}
}
/** Gets a guild's settings if they exist and generate one if not. */
public getGuild(id: string): Guild
{
if(!/\d{17,19}/g.test(id))
$.warn(`"${id}" is not a valid guild ID! It will be erased when the data loads again.`);
if(id in this.guilds)
return this.guilds[id];
else
{
const guild = new Guild();
this.guilds[id] = guild;
return guild;
}
}
class StorageStructure extends GenericStructure {
public users: { [id: string]: User };
public guilds: { [id: string]: Guild };
constructor(data: GenericJSON) {
super('storage');
this.users = {};
this.guilds = {};
for (let id in data.users)
if (/\d{17,19}/g.test(id)) this.users[id] = new User(data.users[id]);
for (let id in data.guilds)
if (/\d{17,19}/g.test(id)) this.guilds[id] = new Guild(data.guilds[id]);
}
/** Gets a user's profile if they exist and generate one if not. */
public getUser(id: string): User {
if (!/\d{17,19}/g.test(id))
$.warn(
`"${id}" is not a valid user ID! It will be erased when the data loads again.`,
);
if (id in this.users) return this.users[id];
else {
const user = new User();
this.users[id] = user;
return user;
}
}
/** Gets a guild's settings if they exist and generate one if not. */
public getGuild(id: string): Guild {
if (!/\d{17,19}/g.test(id))
$.warn(
`"${id}" is not a valid guild ID! It will be erased when the data loads again.`,
);
if (id in this.guilds) return this.guilds[id];
else {
const guild = new Guild();
this.guilds[id] = guild;
return guild;
}
}
}
// Exports instances. Don't worry, importing it from different files will load the same instance.
export let Config = new ConfigStructure(FileManager.read("config"));
export let Storage = new StorageStructure(FileManager.read("storage"));
export let Config = new ConfigStructure(FileManager.read('config'));
export let Storage = new StorageStructure(FileManager.read('storage'));
// This part will allow the user to manually edit any JSON files they want while the program is running which'll update the program's cache.
// However, fs.watch is a buggy mess that should be avoided in production. While it helps test out stuff for development, it's not a good idea to have it running outside of development as it causes all sorts of issues.
if(process.argv[2] === "dev")
{
watch("data", (event, filename) => {
$.debug("File Watcher:", event, filename);
const header = filename.substring(0, filename.indexOf(".json"));
switch(header)
{
case "config": Config = new ConfigStructure(FileManager.read("config")); break;
case "storage": Storage = new StorageStructure(FileManager.read("storage")); break;
}
});
if (process.argv[2] === 'dev') {
watch('data', (event, filename) => {
$.debug('File Watcher:', event, filename);
const header = filename.substring(0, filename.indexOf('.json'));
switch (header) {
case 'config':
Config = new ConfigStructure(FileManager.read('config'));
break;
case 'storage':
Storage = new StorageStructure(FileManager.read('storage'));
break;
}
});
}
export function getPrefix(guild: DiscordGuild|null): string
{
return Storage.getGuild(guild?.id || "N/A").prefix ?? Config.prefix;
}
export function getPrefix(guild: DiscordGuild | null): string {
return Storage.getGuild(guild?.id || 'N/A').prefix ?? Config.prefix;
}

159
src/core/wrappers.ts
View File

@ -1,84 +1,87 @@
export class GenericWrapper<T>
{
protected readonly value: T;
public constructor(value: T)
{
this.value = value;
}
export class GenericWrapper<T> {
protected readonly value: T;
public constructor(value: T) {
this.value = value;
}
}
export class NumberWrapper extends GenericWrapper<number>
{
/**
* Pluralises a word and chooses a suffix attached to the root provided.
* - pluralise("credit", "s") = credit/credits
* - pluralise("part", "ies", "y") = party/parties
* - pluralise("sheep") = sheep
*/
public pluralise(word: string, plural = "", singular = "", excludeNumber = false): string
{
let result = excludeNumber ? "" : `${this.value} `;
if(this.value === 1)
result += word + singular;
else
result += word + plural;
return result;
}
/**
* Pluralises a word for changes.
* - (-1).pluraliseSigned() = '-1 credits'
* - (0).pluraliseSigned() = '+0 credits'
* - (1).pluraliseSigned() = '+1 credit'
*/
public pluraliseSigned(word: string, plural = "", singular = "", excludeNumber = false): string
{
const sign = this.value >= 0 ? '+' : '';
return `${sign}${this.pluralise(word, plural, singular, excludeNumber)}`;
}
export class NumberWrapper extends GenericWrapper<number> {
/**
* Pluralises a word and chooses a suffix attached to the root provided.
* - pluralise("credit", "s") = credit/credits
* - pluralise("part", "ies", "y") = party/parties
* - pluralise("sheep") = sheep
*/
public pluralise(
word: string,
plural = '',
singular = '',
excludeNumber = false,
): string {
let result = excludeNumber ? '' : `${this.value} `;
if (this.value === 1) result += word + singular;
else result += word + plural;
return result;
}
/**
* Pluralises a word for changes.
* - (-1).pluraliseSigned() = '-1 credits'
* - (0).pluraliseSigned() = '+0 credits'
* - (1).pluraliseSigned() = '+1 credit'
*/
public pluraliseSigned(
word: string,
plural = '',
singular = '',
excludeNumber = false,
): string {
const sign = this.value >= 0 ? '+' : '';
return `${sign}${this.pluralise(word, plural, singular, excludeNumber)}`;
}
}
export class StringWrapper extends GenericWrapper<string>
{
public replaceAll(before: string, after: string): string
{
let result = this.value;
while(result.indexOf(before) !== -1)
result = result.replace(before, after);
return result;
}
public toTitleCase(): string
{
return this.value.replace(/([^\W_]+[^\s-]*) */g, txt => txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase());
}
export class StringWrapper extends GenericWrapper<string> {
public replaceAll(before: string, after: string): string {
let result = this.value;
while (result.indexOf(before) !== -1)
result = result.replace(before, after);
return result;
}
public toTitleCase(): string {
return this.value.replace(
/([^\W_]+[^\s-]*) */g,
(txt) => txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase(),
);
}
}
export class ArrayWrapper<T> extends GenericWrapper<T[]>
{
/** Returns a random element from this array. */
public random(): T
{
return this.value[Math.floor(Math.random() * this.value.length)];
}
/**
* Splits up this array into a specified length.
* `$([1,2,3,4,5,6,7,8,9,10]).split(3)` = `[[1,2,3],[4,5,6],[7,8,9],[10]]`
*/
public split(lengthOfEachSection: number): T[][]
{
const amountOfSections = Math.ceil(this.value.length / lengthOfEachSection);
const sections: T[][] = new Array(amountOfSections);
for(let index = 0; index < amountOfSections; index++)
sections[index] = this.value.slice(index * lengthOfEachSection, (index + 1) * lengthOfEachSection);
return sections;
}
}
export class ArrayWrapper<T> extends GenericWrapper<T[]> {
/** Returns a random element from this array. */
public random(): T {
return this.value[Math.floor(Math.random() * this.value.length)];
}
/**
* Splits up this array into a specified length.
* `$([1,2,3,4,5,6,7,8,9,10]).split(3)` = `[[1,2,3],[4,5,6],[7,8,9],[10]]`
*/
public split(lengthOfEachSection: number): T[][] {
const amountOfSections = Math.ceil(this.value.length / lengthOfEachSection);
const sections: T[][] = new Array(amountOfSections);
for (let index = 0; index < amountOfSections; index++)
sections[index] = this.value.slice(
index * lengthOfEachSection,
(index + 1) * lengthOfEachSection,
);
return sections;
}
}

78
src/defs/info.ts
View File

@ -1,45 +1,45 @@
// Flags a user can have.
// They're basically your profile badges.
export const flags: {[index: string]:any} = {
DISCORD_EMPLOYEE: 'Discord Employee',
DISCORD_PARTNER: 'Discord Partner',
BUGHUNTER_LEVEL_1: 'Bug Hunter (Level 1)',
BUGHUNTER_LEVEL_2: 'Bug Hunter (Level 2)',
HYPESQUAD_EVENTS: 'HypeSquad Events',
HOUSE_BRAVERY: 'House of Bravery',
HOUSE_BRILLIANCE: 'House of Brilliance',
HOUSE_BALANCE: 'House of Balance',
EARLY_SUPPORTER: 'Early Supporter',
TEAM_USER: 'Team User',
SYSTEM: 'System',
VERIFIED_BOT: 'Verified Bot',
VERIFIED_DEVELOPER: 'Verified Bot Developer',
export const flags: { [index: string]: any } = {
DISCORD_EMPLOYEE: 'Discord Employee',
DISCORD_PARTNER: 'Discord Partner',
BUGHUNTER_LEVEL_1: 'Bug Hunter (Level 1)',
BUGHUNTER_LEVEL_2: 'Bug Hunter (Level 2)',
HYPESQUAD_EVENTS: 'HypeSquad Events',
HOUSE_BRAVERY: 'House of Bravery',
HOUSE_BRILLIANCE: 'House of Brilliance',
HOUSE_BALANCE: 'House of Balance',
EARLY_SUPPORTER: 'Early Supporter',
TEAM_USER: 'Team User',
SYSTEM: 'System',
VERIFIED_BOT: 'Verified Bot',
VERIFIED_DEVELOPER: 'Verified Bot Developer',
};
export const filterLevels: {[index: string]:any} = {
DISABLED: 'Off',
MEMBERS_WITHOUT_ROLES: 'No Role',
ALL_MEMBERS: 'Everyone',
export const filterLevels: { [index: string]: any } = {
DISABLED: 'Off',
MEMBERS_WITHOUT_ROLES: 'No Role',
ALL_MEMBERS: 'Everyone',
};
export const verificationLevels: {[index: string]:any} = {
NONE: 'None',
LOW: 'Low',
MEDIUM: 'Medium',
HIGH: '(╯°□°）╯︵ ┻━┻',
VERY_HIGH: '┻━┻ ﾐヽ(ಠ益ಠ)ノ彡┻━┻',
export const verificationLevels: { [index: string]: any } = {
NONE: 'None',
LOW: 'Low',
MEDIUM: 'Medium',
HIGH: '(╯°□°）╯︵ ┻━┻',
VERY_HIGH: '┻━┻ ﾐヽ(ಠ益ಠ)ノ彡┻━┻',
};
export const regions: { [index: string]: any } = {
brazil: 'Brazil',
europe: 'Europe',
hongkong: 'Hong Kong',
india: 'India',
japan: 'Japan',
russia: 'Russia',
singapore: 'Singapore',
southafrica: 'South Africa',
sydney: 'Sydney',
'us-central': 'US Central',
'us-east': 'US East',
'us-west': 'US West',
'us-south': 'US South',
};
export const regions: {[index: string]:any} = {
brazil: 'Brazil',
europe: 'Europe',
hongkong: 'Hong Kong',
india: 'India',
japan: 'Japan',
russia: 'Russia',
singapore: 'Singapore',
southafrica: 'South Africa',
sydney: 'Sydney',
'us-central': 'US Central',
'us-east': 'US East',
'us-west': 'US West',
'us-south': 'US South',
};

240
src/events/message.ts
View File

@ -1,109 +1,137 @@
import Event from "../core/event";
import Command, {loadCommands} from "../core/command";
import {hasPermission, getPermissionLevel, PermissionNames} from "../core/permissions";
import {Permissions, Collection} from "discord.js";
import {getPrefix} from "../core/structures";
import $ from "../core/lib";
import Event from '../core/event';
import Command, { loadCommands } from '../core/command';
import {
hasPermission,
getPermissionLevel,
PermissionNames,
} from '../core/permissions';
import { Permissions, Collection } from 'discord.js';
import { getPrefix } from '../core/structures';
import $ from '../core/lib';
// It's a rather hacky solution, but since there's no top-level await, I just have to make the loading conditional.
let commands: Collection<string, Command>|null = null;
let commands: Collection<string, Command> | null = null;
export default new Event<"message">({
async on(message)
{
// Load commands if it hasn't already done so. Luckily, it's called once at most.
if(!commands)
commands = await loadCommands();
// Message Setup //
if(message.author.bot)
return;
const prefix = getPrefix(message.guild);
if(!message.content.startsWith(prefix))
{
if(message.client.user && message.mentions.has(message.client.user))
message.channel.send(`${message.author.toString()}, my prefix on this guild is \`${prefix}\`.`);
return;
}
const [header, ...args] = message.content.substring(prefix.length).split(/ +/);
if(!commands.has(header))
return;
if(message.channel.type === "text" && !message.channel.permissionsFor(message.client.user || "")?.has(Permissions.FLAGS.SEND_MESSAGES))
{
let status;
if(message.member?.hasPermission(Permissions.FLAGS.ADMINISTRATOR))
status = "Because you're a server admin, you have the ability to change that channel's permissions to match if that's what you intended.";
else
status = "Try using a different channel or contacting a server admin to change permissions of that channel if you think something's wrong.";
return message.author.send(`I don't have permission to send messages in ${message.channel.toString()}. ${status}`);
}
$.log(`${message.author.username}#${message.author.discriminator} executed the command "${header}" with arguments "${args}".`);
// Subcommand Recursion //
let command = commands.get(header);
if(!command) return $.warn(`Command "${header}" was called but for some reason it's still undefined!`);
const params: any[] = [];
let isEndpoint = false;
let permLevel = command.permission ?? Command.PERMISSIONS.NONE;
for(let param of args)
{
if(command.endpoint)
{
if(command.subcommands.size > 0 || command.user || command.number || command.any)
$.warn(`An endpoint cannot have subcommands! Check ${prefix}${header} again.`);
isEndpoint = true;
break;
}
const type = command.resolve(param);
command = command.get(param);
permLevel = command.permission ?? permLevel;
if(type === Command.TYPES.USER)
{
const id = param.match(/\d+/g)![0];
try {params.push(await message.client.users.fetch(id))}
catch(error) {return message.channel.send(`No user found by the ID \`${id}\`!`)}
}
else if(type === Command.TYPES.NUMBER)
params.push(Number(param));
else if(type !== Command.TYPES.SUBCOMMAND)
params.push(param);
}
if(!message.member)
return $.warn("This command was likely called from a DM channel meaning the member object is null.");
if(!hasPermission(message.member, permLevel))
{
const userPermLevel = getPermissionLevel(message.member);
return message.channel.send(`You don't have access to this command! Your permission level is \`${PermissionNames[userPermLevel]}\` (${userPermLevel}), but this command requires a permission level of \`${PermissionNames[permLevel]}\` (${permLevel}).`);
}
if(isEndpoint)
return message.channel.send("Too many arguments!");
// Execute with dynamic library attached. //
// The purpose of using $.bind($) is to clone the function so as to not modify the original $.
// The cloned function doesn't copy the properties, so Object.assign() is used.
// Object.assign() modifies the first element and returns that, the second element applies its properties and the third element applies its own overriding the second one.
command.execute(Object.assign($.bind($), {
args: params,
author: message.author,
channel: message.channel,
client: message.client,
guild: message.guild,
member: message.member,
message: message
}, $));
}
});
export default new Event<'message'>({
async on(message) {
// Load commands if it hasn't already done so. Luckily, it's called once at most.
if (!commands) commands = await loadCommands();
// Message Setup //
if (message.author.bot) return;
const prefix = getPrefix(message.guild);
if (!message.content.startsWith(prefix)) {
if (message.client.user && message.mentions.has(message.client.user))
message.channel.send(
`${message.author.toString()}, my prefix on this guild is \`${prefix}\`.`,
);
return;
}
const [header, ...args] = message.content
.substring(prefix.length)
.split(/ +/);
if (!commands.has(header)) return;
if (
message.channel.type === 'text' &&
!message.channel
.permissionsFor(message.client.user || '')
?.has(Permissions.FLAGS.SEND_MESSAGES)
) {
let status;
if (message.member?.hasPermission(Permissions.FLAGS.ADMINISTRATOR))
status =
"Because you're a server admin, you have the ability to change that channel's permissions to match if that's what you intended.";
else
status =
"Try using a different channel or contacting a server admin to change permissions of that channel if you think something's wrong.";
return message.author.send(
`I don't have permission to send messages in ${message.channel.toString()}. ${status}`,
);
}
$.log(
`${message.author.username}#${message.author.discriminator} executed the command "${header}" with arguments "${args}".`,
);
// Subcommand Recursion //
let command = commands.get(header);
if (!command)
return $.warn(
`Command "${header}" was called but for some reason it's still undefined!`,
);
const params: any[] = [];
let isEndpoint = false;
let permLevel = command.permission ?? Command.PERMISSIONS.NONE;
for (let param of args) {
if (command.endpoint) {
if (
command.subcommands.size > 0 ||
command.user ||
command.number ||
command.any
)
$.warn(
`An endpoint cannot have subcommands! Check ${prefix}${header} again.`,
);
isEndpoint = true;
break;
}
const type = command.resolve(param);
command = command.get(param);
permLevel = command.permission ?? permLevel;
if (type === Command.TYPES.USER) {
const id = param.match(/\d+/g)![0];
try {
params.push(await message.client.users.fetch(id));
} catch (error) {
return message.channel.send(`No user found by the ID \`${id}\`!`);
}
} else if (type === Command.TYPES.NUMBER) params.push(Number(param));
else if (type !== Command.TYPES.SUBCOMMAND) params.push(param);
}
if (!message.member)
return $.warn(
'This command was likely called from a DM channel meaning the member object is null.',
);
if (!hasPermission(message.member, permLevel)) {
const userPermLevel = getPermissionLevel(message.member);
return message.channel.send(
`You don't have access to this command! Your permission level is \`${PermissionNames[userPermLevel]}\` (${userPermLevel}), but this command requires a permission level of \`${PermissionNames[permLevel]}\` (${permLevel}).`,
);
}
if (isEndpoint) return message.channel.send('Too many arguments!');
// Execute with dynamic library attached. //
// The purpose of using $.bind($) is to clone the function so as to not modify the original $.
// The cloned function doesn't copy the properties, so Object.assign() is used.
// Object.assign() modifies the first element and returns that, the second element applies its properties and the third element applies its own overriding the second one.
command.execute(
Object.assign(
$.bind($),
{
args: params,
author: message.author,
channel: message.channel,
client: message.client,
guild: message.guild,
member: message.member,
message: message,
},
$,
),
);
},
});

36
src/events/messageReactionRemove.ts
View File

@ -1,20 +1,24 @@
import Event from "../core/event";
import {Permissions} from "discord.js";
import {botHasPermission} from "../core/lib";
import Event from '../core/event';
import { Permissions } from 'discord.js';
import { botHasPermission } from '../core/lib';
// A list of message ID and callback pairs. You get the emote name and ID of the user reacting.
export const eventListeners: Map<string, (emote: string, id: string) => void> = new Map();
export const eventListeners: Map<
string,
(emote: string, id: string) => void
> = new Map();
// Attached to the client, there can be one event listener attached to a message ID which is executed if present.
export default new Event<"messageReactionRemove">({
on(reaction, user)
{
const canDeleteEmotes = botHasPermission(reaction.message.guild, Permissions.FLAGS.MANAGE_MESSAGES);
if(!canDeleteEmotes)
{
const callback = eventListeners.get(reaction.message.id);
callback && callback(reaction.emoji.name, user.id);
}
}
});
export default new Event<'messageReactionRemove'>({
on(reaction, user) {
const canDeleteEmotes = botHasPermission(
reaction.message.guild,
Permissions.FLAGS.MANAGE_MESSAGES,
);
if (!canDeleteEmotes) {
const callback = eventListeners.get(reaction.message.id);
callback && callback(reaction.emoji.name, user.id);
}
},
});

34
src/events/ready.ts
View File

@ -1,18 +1,18 @@
import Event from "../core/event";
import {client} from "../index";
import $ from "../core/lib";
import {Config} from "../core/structures";
import Event from '../core/event';
import { client } from '../index';
import $ from '../core/lib';
import { Config } from '../core/structures';
export default new Event<"ready">({
once()
{
if(client.user)
{
$.ready(`Logged in as ${client.user.username}#${client.user.discriminator}.`);
client.user.setActivity({
type: "LISTENING",
name: `${Config.prefix}help`
});
}
}
});
export default new Event<'ready'>({
once() {
if (client.user) {
$.ready(
`Logged in as ${client.user.username}#${client.user.discriminator}.`,
);
client.user.setActivity({
type: 'LISTENING',
name: `${Config.prefix}help`,
});
}
},
});

18
src/index.ts
View File

@ -1,8 +1,8 @@
import {Client} from "discord.js";
import setup from "./setup";
import {Config} from "./core/structures";
import {loadCommands} from "./core/command";
import {loadEvents} from "./core/event";
import { Client } from 'discord.js';
import setup from './setup';
import { Config } from './core/structures';
import { loadCommands } from './core/command';
import { loadEvents } from './core/event';
// This is here in order to make it much less of a headache to access the client from other files.
// This of course won't actually do anything until the setup process is complete and it logs in.
@ -10,7 +10,7 @@ export const client = new Client();
// Begin the command loading here rather than when it's needed like in the message event.
setup.init().then(() => {
loadCommands();
loadEvents(client);
client.login(Config.token).catch(setup.again);
});
loadCommands();
loadEvents(client);
client.login(Config.token).catch(setup.again);
});

114
src/setup.ts
View File

@ -1,60 +1,64 @@
import {existsSync as exists} from "fs";
import inquirer from "inquirer";
import Storage from "./core/storage";
import {Config} from "./core/structures";
import $, {setConsoleActivated} from "./core/lib";
import { existsSync as exists } from 'fs';
import inquirer from 'inquirer';
import Storage from './core/storage';
import { Config } from './core/structures';
import $, { setConsoleActivated } from './core/lib';
// This file is called (or at least should be called) automatically as long as a config file doesn't exist yet.
// And that file won't be written until the data is successfully initialized.
const prompts = [{
type: "password",
name: "token",
message: "What's your bot's token?",
mask: true
}, {
type: "input",
name: "prefix",
message: "What do you want your bot's prefix to be?",
default: "$"
}, {
type: "input",
name: "owner",
message: "Enter the owner's user ID here."
}, {
type: "input",
name: "admins",
message: "Enter a list of bot admins (by their IDs) separated by spaces."
}, {
type: "input",
name: "support",
message: "Enter a list of bot troubleshooters (by their IDs) separated by spaces."
}];
const prompts = [
{
type: 'password',
name: 'token',
message: "What's your bot's token?",
mask: true,
},
{
type: 'input',
name: 'prefix',
message: "What do you want your bot's prefix to be?",
default: '$',
},
{
type: 'input',
name: 'owner',
message: "Enter the owner's user ID here.",
},
{
type: 'input',
name: 'admins',
message: 'Enter a list of bot admins (by their IDs) separated by spaces.',
},
{
type: 'input',
name: 'support',
message:
'Enter a list of bot troubleshooters (by their IDs) separated by spaces.',
},
];
export default {
async init()
{
while(!exists("data/config.json"))
{
const answers = await inquirer.prompt(prompts);
Storage.open("data");
Config.token = answers.token as string;
Config.prefix = answers.prefix as string;
Config.owner = answers.owner as string;
const admins = (answers.admins as string);
Config.admins = admins !== "" ? admins.split(" ") : [];
const support = (answers.support as string);
Config.support = support !== "" ? support.split(" ") : [];
Config.save(false);
}
},
/** Prompt the user to set their token again. */
async again()
{
$.error("It seems that the token you provided is invalid.");
setConsoleActivated(false);
const answers = await inquirer.prompt(prompts.slice(0, 1));
Config.token = answers.token as string;
Config.save(false);
process.exit();
}
};
async init() {
while (!exists('data/config.json')) {
const answers = await inquirer.prompt(prompts);
Storage.open('data');
Config.token = answers.token as string;
Config.prefix = answers.prefix as string;
Config.owner = answers.owner as string;
const admins = answers.admins as string;
Config.admins = admins !== '' ? admins.split(' ') : [];
const support = answers.support as string;
Config.support = support !== '' ? support.split(' ') : [];
Config.save(false);
}
},
/** Prompt the user to set their token again. */
async again() {
$.error('It seems that the token you provided is invalid.');
setConsoleActivated(false);
const answers = await inquirer.prompt(prompts.slice(0, 1));
Config.token = answers.token as string;
Config.save(false);
process.exit();
},
};

176
test/wrappers.ts
View File

@ -1,69 +1,111 @@
import {strict as assert} from "assert";
import {NumberWrapper, StringWrapper, ArrayWrapper} from "../src/core/wrappers";
import { strict as assert } from 'assert';
import {
NumberWrapper,
StringWrapper,
ArrayWrapper,
} from '../src/core/wrappers';
// I can't figure out a way to run the test suite while running the bot.
describe("Wrappers", () => {
describe("NumberWrapper", () => {
describe("#pluralise()", () => {
it('should return "5 credits"', () => {
assert.strictEqual(new NumberWrapper(5).pluralise("credit", "s"), "5 credits");
})
it('should return "1 credit"', () => {
assert.strictEqual(new NumberWrapper(1).pluralise("credit", "s"), "1 credit");
})
it('should return "-1 credits"', () => {
assert.strictEqual(new NumberWrapper(-1).pluralise("credit", "s"), "-1 credits");
})
it('should be able to work with a plural suffix', () => {
assert.strictEqual(new NumberWrapper(2).pluralise("part", "ies", "y"), "2 parties");
})
it('should be able to work with a singular suffix', () => {
assert.strictEqual(new NumberWrapper(1).pluralise("part", "ies", "y"), "1 party");
})
it('should be able to exclude the number', () => {
assert.strictEqual(new NumberWrapper(1).pluralise("credit", "s", "", true), "credit");
})
})
describe("#pluraliseSigned()", () => {
it('should return "-1 credits"', () => {
assert.strictEqual(new NumberWrapper(-1).pluraliseSigned("credit", "s"), "-1 credits");
})
it('should return "+0 credits"', () => {
assert.strictEqual(new NumberWrapper(0).pluraliseSigned("credit", "s"), "+0 credits");
})
it('should return "+1 credit"', () => {
assert.strictEqual(new NumberWrapper(1).pluraliseSigned("credit", "s"), "+1 credit");
})
})
})
describe("StringWrapper", () => {
describe("#replaceAll()", () => {
it('should convert "test" to "zesz"', () => {
assert.strictEqual(new StringWrapper("test").replaceAll('t', 'z'), "zesz");
})
})
describe("#toTitleCase()", () => {
it('should capitalize the first letter of each word', () => {
assert.strictEqual(new StringWrapper("yeetus deletus find salvation from jesus").toTitleCase(), "Yeetus Deletus Find Salvation From Jesus");
})
})
})
describe("ArrayWrapper", () => {
describe("#split()", () => {
it('should split [1,2,3,4,5,6,7,8,9,10] into [[1,2,3],[4,5,6],[7,8,9],[10]]', () => {
assert.deepStrictEqual(new ArrayWrapper([1,2,3,4,5,6,7,8,9,10]).split(3), [[1,2,3],[4,5,6],[7,8,9],[10]]);
})
})
})
})
describe('Wrappers', () => {
describe('NumberWrapper', () => {
describe('#pluralise()', () => {
it('should return "5 credits"', () => {
assert.strictEqual(
new NumberWrapper(5).pluralise('credit', 's'),
'5 credits',
);
});
it('should return "1 credit"', () => {
assert.strictEqual(
new NumberWrapper(1).pluralise('credit', 's'),
'1 credit',
);
});
it('should return "-1 credits"', () => {
assert.strictEqual(
new NumberWrapper(-1).pluralise('credit', 's'),
'-1 credits',
);
});
it('should be able to work with a plural suffix', () => {
assert.strictEqual(
new NumberWrapper(2).pluralise('part', 'ies', 'y'),
'2 parties',
);
});
it('should be able to work with a singular suffix', () => {
assert.strictEqual(
new NumberWrapper(1).pluralise('part', 'ies', 'y'),
'1 party',
);
});
it('should be able to exclude the number', () => {
assert.strictEqual(
new NumberWrapper(1).pluralise('credit', 's', '', true),
'credit',
);
});
});
describe('#pluraliseSigned()', () => {
it('should return "-1 credits"', () => {
assert.strictEqual(
new NumberWrapper(-1).pluraliseSigned('credit', 's'),
'-1 credits',
);
});
it('should return "+0 credits"', () => {
assert.strictEqual(
new NumberWrapper(0).pluraliseSigned('credit', 's'),
'+0 credits',
);
});
it('should return "+1 credit"', () => {
assert.strictEqual(
new NumberWrapper(1).pluraliseSigned('credit', 's'),
'+1 credit',
);
});
});
});
describe('StringWrapper', () => {
describe('#replaceAll()', () => {
it('should convert "test" to "zesz"', () => {
assert.strictEqual(
new StringWrapper('test').replaceAll('t', 'z'),
'zesz',
);
});
});
describe('#toTitleCase()', () => {
it('should capitalize the first letter of each word', () => {
assert.strictEqual(
new StringWrapper(
'yeetus deletus find salvation from jesus',
).toTitleCase(),
'Yeetus Deletus Find Salvation From Jesus',
);
});
});
});
describe('ArrayWrapper', () => {
describe('#split()', () => {
it('should split [1,2,3,4,5,6,7,8,9,10] into [[1,2,3],[4,5,6],[7,8,9],[10]]', () => {
assert.deepStrictEqual(
new ArrayWrapper([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]).split(3),
[[1, 2, 3], [4, 5, 6], [7, 8, 9], [10]],
);
});
});
});
});

33
tsconfig.json
View File

@ -1,18 +1,17 @@
{
"compilerOptions":
{
"rootDir": "src",
"outDir": "dist",
"target": "ES6",
"module": "CommonJS",
"moduleResolution": "node",
"esModuleInterop": true,
"noImplicitAny": true,
"noImplicitReturns": true,
"strictNullChecks": true,
"strictFunctionTypes": true,
"strictPropertyInitialization": true,
"removeComments": true
},
"exclude": ["test"]
}
"compilerOptions": {
"rootDir": "src",
"outDir": "dist",
"target": "ES6",
"module": "CommonJS",
"moduleResolution": "node",
"esModuleInterop": true,
"noImplicitAny": true,
"noImplicitReturns": true,
"strictNullChecks": true,
"strictFunctionTypes": true,
"strictPropertyInitialization": true,
"removeComments": true
},
"exclude": ["test"]
}