lib/structures/react-interface/index.js
const ReactCommand = require('../react-command/')
/**
* An array of emoji button that attach to a message to do different actions
*/
class ReactInterface {
/**
* Construct a react interface
* @class
* @param {Object} data The react interface data
* @prop {ReactCommand[]|ReactCommand} data.buttons The buttons of the interface
* @prop {Object} [data.options={}] The options for the interface
* @prop {String[]|String} [data.options.designatedUsers] The IDs of the users who can use the react interface. By default, it's the owner of the message reacted on
* @prop {Boolean} [data.options.deleteAfterUse=false] Whether the interface is deleted after a use or not
* @prop {Boolean} [data.options.removeReaction=false] Whether the triggering reaction is removed after executed or not
* @prop {Number} [data.options.authLevel=0] The minimum auth level required to execute this command
*/
constructor ({ buttons, options = {} }) {
if (!Array.isArray(buttons)) buttons = [buttons]
const {
designatedUsers,
deleteAfterUse = false,
removeReaction = false
} = options
const authLevel = parseInt(options.authLevel) || 0
/**
* The buttons of the interface
* @type {Map<String, ReactCommand>}
*/
this.buttons = new Map()
for (const button of buttons) {
if (!(button instanceof ReactCommand)) throw TypeError('Supplied button not ReactCommand instance:\n' + button)
if (designatedUsers) button.options._designatedUsers = Array.isArray(designatedUsers) ? designatedUsers : [designatedUsers]
if (removeReaction) button.options.removeReaction = true
button.options.authLevel = authLevel
button.parentInterface = this
this.buttons.set(button.emoji, button)
}
/**
* The options for the interface
* @type {Object}
* @prop {String[]|undefined} designatedUsers The IDs of the users who can use the react interface. By default, it's the owner of the message reacted on (defined by `ReactionHandler.bindInterface()`)
* @prop {Boolean} deleteAfterUse Whether the interface is deleted after a use or not
* @prop {Boolean} removeReaction Whether the triggering reaction is removed after executed or not
* @prop {Number} authLevel The minimum auth level required to execute this command
*/
this.options = {
designatedUsers: designatedUsers ? (Array.isArray(designatedUsers) ? designatedUsers : [designatedUsers]) : undefined,
deleteAfterUse,
removeReaction,
authLevel
}
}
}
module.exports = ReactInterface