# simple-discordjs > A command framework for Discord.JS, featuring pattern matching, middlewares and autogenerated help. Latest version **2.0.0** (published 2018-12-11) · MIT license · 0 weekly downloads ## Install ```sh npm install simple-discordjs pnpm add simple-discordjs yarn add simple-discordjs bun add simple-discordjs ``` ## Health **Score 20/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.0.0 | | Published | 2018-12-11 | | First published | 2017-06-12 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 9 | | Unpacked size | 907.3 KB | | Known vulnerabilities | 0 (+12 in 2 direct dependencies) | | Install scripts | no | | Author | Navrin Thomas | | Maintainers | navrin | ## Links - npm: https://www.npmjs.com/package/simple-discordjs - npm.io page: https://npm.io/package/simple-discordjs ## Dependencies (9) - [lodash](https://npm.io/package/lodash.md) 4.17.11 - [sqlite3](https://npm.io/package/sqlite3.md) 4.0.4 - [typeorm](https://npm.io/package/typeorm.md) 0.2.9 - [mustache](https://npm.io/package/mustache.md) 3.0.1 - [discord.js](https://npm.io/package/discord.js.md) 11.4.2 - [common-tags](https://npm.io/package/common-tags.md) 1.8.0 - [string-template](https://npm.io/package/string-template.md) 1.0.0 - [reflect-metadata](https://npm.io/package/reflect-metadata.md) 0.1.12 - [reverse-mustache](https://npm.io/package/reverse-mustache.md) 1.9.0 ## Recent versions - 2.0.0 (latest) — 2018-12-11 - 1.5.11 — 2017-07-11 - 1.5.10 — 2017-07-10 - 1.5.9 — 2017-07-10 - 1.5.8 — 2017-07-09 - 1.5.7 — 2017-07-09 - 1.5.6 — 2017-07-09 - 1.4.6 — 2017-07-09 - 1.3.6 — 2017-07-02 - 1.3.5 — 2017-07-02 - 1.3.4 — 2017-07-02 - 1.2.4 — 2017-07-01 - 0.2.4 — 2017-06-25 - 0.2.3 — 2017-06-20 - 0.1.3 — 2017-06-12 - … 1 more at https://npm.io/package/simple-discordjs/versions ## README # Simple DiscordJS [![TypeScript](https://badges.frapsoft.com/typescript/version/typescript-next.svg?v=101)](https://github.com/ellerbrock/typescript-badges/) [![David](https://david-dm.org/Navrin/yifflesworth.svg)](https://david-dm.org) ![npm](https://img.shields.io/npm/l/express.svg?style=flat-square) The commander class was originally designed to assist a programmer with the tedious task of setting up commands for Discord.js. The syntax for the bot is as follows: ```typescript import Commands, { RateLimiter, RoleTypes, Auth } from 'simple-discordjs'; new Commands(configJson.prefix, client, options) .use(rateLimit.protect) .use(auth.authenticate) .defineCommand({ command: { names: ['p', 'ping'], action: ping, }, description: { message: 'Replies with pong.', example: '{{prefix}}ping', } }) .defineCommand({ command: { names: ['pang', 'pong'], action: pinger, pattern: /p[oa]ng/, }, authentication: RoleTypes.ADMIN, description: { message: 'A joke reply to pong', example: 'pang' } }) .generateHelp() .listen(); ``` ## Bot Config The bot settings is a simple object that accepts this interface: ```typescript export type botTypes = 'normal' | 'self' | 'guildonly'; export interface CommandsOptions { /** * Valid bot types * Normal replies to all text channels, including guildonly * Self bot, only replies to you and only you. * Guildonly will only work in discord guild channels * * @type {botTypes} * @memberof CommandsOptions */ botType: botTypes; /** * If someone types a prefixed command like !action, * delete the message on successful reply * * @type {boolean} * @memberof CommandsOptions */ deleteCommandMessage?: boolean; /** * Defines the amount of time the !action command will * stay in the channel until it is deleted. * * @type {number} * @memberof CommandsOptions */ deleteMessageDelay?: number; } ``` ### Bot Types Bots can have multiple different types, including a self type for selfbots. Type | Description --------------|------------ `'normal'` | Standard default bot type, replies to all messages in all channels. `'self'` | Selfbot, limited to only repling to its own client.id messages. `'guildonly'` | Limits the bot to only reply messages sent in a guild channel. Users will not be able to interact with the bot in DMs. ### Auto Message Deletion Setting `deleteCommandMessage` allows for !action messages to be automatically deleted when they trigger a bot commnand. This helps remove some of the spam of !action commands, but only works when the bot is triggered explicitly. Pattern commands will not be deleted. ## Commands Middlware Support The `.use` syntax on the class is a form of middleware, accepting a promise that returns a boolean condition. The message chain will fail, and not send if the condition returns false. ```typescript new Commands(configJson.prefix, client) .use(async (message, options, parameters, client) => { // do stuff to check the message. return true; }); ``` The middleware demonstrated above is a spam limiter, checking an auto-clearing object and rejecting a message middleware if they are above the spam limit. ### Middlewares included #### Rate Limiter A simple rate limiter that prevents users from flooding a bot with commands. Syntax is as follows ```typescript const limiter = new RateLimiter(['messages allowed per window'], ['window length in seconds']) new RateLimiter(10, 5) // 10 messages every 5 seconds ``` A window is the period of time the user will be allowed to send message, within the limit. After the limit is reached, the bot will not respond to any messages from the user until the window is reset. Pass to the middleware acceptor with, ```typescript new Commands(prefix, client) .use(limiter.protect) ``` ### **Authentication Module** The auth module exposes a middleware function and a command object for the user. It uses a SQLite database to keep track of what roles have what permissions on a server. All the roles are set up in a enumerable with 5 properties. ```typescript enum RoleTypes { ALL = 0, MOD, ADMIN, OWNER, SUPERUSER, }; ``` **Due to properties being simple numbers, roles have hierarchy. A superuser will have access to all commands as it is the highest number.** Admins will be able to use all mod and admin commands, and owners will be able to use all mod, admin and owner commands, etc. `Superuser` should be your user ID. `Owner` is automatically infered from the server owner exposed from discord. `Admin | Mod` is set via the `!addrole` command. Only server owners or the superuser may use addrole. `!addrole mod @roleGroup` Usage is as follows: ```typescript const auth = new Auth(superuserToken); // superuser token should be your discord user ID, // you will have access to all commands. new Commands(prefix, client) .use(auth.authenticate) .defineCommand(auth.getCommand()) ``` ### Command Helper #### Simple Command The `.defineCommand` function defines a chat command that takes an `action`, a function that will be called once the command is verified and registered. An optional `description` is passed to generate a help command with the `.generateHelp` command. ```typescript .defineCommand({ command: { name: ['action', 'a', 'actionname'] action: (message: Discord.Message, options: CommandOptions, parameters: ParameterOptions, client: Discord.Client) => Promise, parameters: '{{param1}} {{param2}}', noPrefix: false, // a boolean that represents if the function // requres an explicit call, like .action or !action }, description: { message: 'A description of the function, for the generator', example: '{{prefix}}action', }, }); ``` For regex matching, pass a `pattern: RegExp` in the command object. ## Parameter matching Reverse string templating is supported with the `parameter` option in the function description. Parameters are defined with `{{parameter}}`, and are passed as an object to the action. Strings must match to register, you cannot ignore parts of message, e.g. `'action verb noun' !== '{{action}} ignore {{noun}}'`. Instead, match it and add a junk name to it, e.g. `'action verb noun' === '{{action}} {{ignored}} {{noun}}'`. ```typescript export interface ParameterDefinition { array: string[]; named?: { [key: string]: string; }; } // called with .param ADD 1 2. .defineCommand(['param'], { command: { action: (message, options, params: ParameterDefintion) => { console.log(params) // { // array: ['add', '1', '2'], // named: { // directive: 'ADD', // num1: '1', // num2: '2' // } // } }, parameters: '{{directive}} {{num1}} {{num2}}', } }) ``` ### Help Generator The command `.generateHelp(descriptor?)` will automatically take the current command list and generate a series of `RichEmbed` objects that will be DM'd to the user who calls either `h` or `help` with the assigned prefix. The function also accepts an optional `RichEmbed` element for a custom message to be sent after the commands. In the example parameter in the description object, `{{prefix}}` is templated to return the default prefix of the command class. ```typescript { ...options description: { message: 'The description of the chat command', example: 'The chat command, e.g. {{prefix}}command', } } ``` The returned help function looks as follows: ![helper](https://i.imgur.com/wBOdcK6.png) *Please do not remove the signature from the source code, it would be appreciated if you left that in for developers looking to use this library.* --- _Source: https://npm.io/package/simple-discordjs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._