const { RangeError } = require('../errors'); /** * Data structure that makes it easy to interact with a permission bitfield. All {@link GuildMember}s have a set of * permissions in their guild, and each channel in the guild may also have {@link PermissionOverwrites} for the member * that override their default permissions. */ class Permissions { /** * @param {number|PermissionResolvable[]} permissions Permissions or bitfield to read from */ constructor(permissions) { /** * Bitfield of the packed permissions * @type {number} */ this.bitfield = typeof permissions === 'number' ? permissions : this.constructor.resolve(permissions); } /** * Checks whether the bitfield has a permission, or multiple permissions. * @param {PermissionResolvable|PermissionResolvable[]} permission Permission(s) to check for * @param {boolean} [checkAdmin=true] Whether to allow the administrator permission to override * @returns {boolean} */ has(permission, checkAdmin = true) { if (permission instanceof Array) return permission.every(p => this.has(p, checkAdmin)); permission = this.constructor.resolve(permission); if (checkAdmin && (this.bitfield & this.constructor.FLAGS.ADMINISTRATOR) > 0) return true; return (this.bitfield & permission) === permission; } /** * Gets all given permissions that are missing from the bitfield. * @param {PermissionResolvable[]} permissions Permissions to check for * @param {boolean} [checkAdmin=true] Whether to allow the administrator permission to override * @returns {PermissionResolvable[]} */ missing(permissions, checkAdmin = true) { return permissions.filter(p => !this.has(p, checkAdmin)); } /** * Freezes these permissions, making them immutable. * @returns {Permissions} These permissions */ freeze() { return Object.freeze(this); } /** * Adds permissions to these ones. * @param {...PermissionResolvable} permissions Permissions to add * @returns {Permissions} These permissions or new permissions if the instance is frozen. */ add(...permissions) { let total = 0; for (let p = permissions.length - 1; p >= 0; p--) { const perm = this.constructor.resolve(permissions[p]); total |= perm; } if (Object.isFrozen(this)) return new this.constructor(this.bitfield | total); this.bitfield |= total; return this; } /** * Removes permissions from these. * @param {...PermissionResolvable} permissions Permissions to remove * @returns {Permissions} These permissions or new permissions if the instance is frozen. */ remove(...permissions) { let total = 0; for (let p = permissions.length - 1; p >= 0; p--) { const perm = this.constructor.resolve(permissions[p]); total |= perm; } if (Object.isFrozen(this)) return new this.constructor(this.bitfield & ~total); this.bitfield &= ~total; return this; } /** * Gets an object mapping permission name (like `VIEW_CHANNEL`) to a {@link boolean} indicating whether the * permission is available. * @param {boolean} [checkAdmin=true] Whether to allow the administrator permission to override * @returns {Object} */ serialize(checkAdmin = true) { const serialized = {}; for (const perm in this.constructor.FLAGS) serialized[perm] = this.has(perm, checkAdmin); return serialized; } /** * Data that can be resolved to give a permission number. This can be: * * A string (see {@link Permissions.FLAGS}) * * A permission number * * An instance of Permissions * @typedef {string|number|Permissions} PermissionResolvable */ /** * Resolves permissions to their numeric form. * @param {PermissionResolvable|PermissionResolvable[]} permission - Permission(s) to resolve * @returns {number} */ static resolve(permission) { if (typeof permission === 'number' && permission >= 0) return permission; if (permission instanceof Permissions) return permission.bitfield; if (permission instanceof Array) return permission.map(p => this.resolve(p)).reduce((prev, p) => prev | p, 0); if (typeof permission === 'string') return this.FLAGS[permission]; throw new RangeError('PERMISSIONS_INVALID'); } } /** * Numeric permission flags. All available properties: * * `ADMINISTRATOR` (implicitly has *all* permissions, and bypasses all channel overwrites) * * `CREATE_INSTANT_INVITE` (create invitations to the guild) * * `KICK_MEMBERS` * * `BAN_MEMBERS` * * `MANAGE_CHANNELS` (edit and reorder channels) * * `MANAGE_GUILD` (edit the guild information, region, etc.) * * `ADD_REACTIONS` (add new reactions to messages) * * `VIEW_AUDIT_LOG` * * `VIEW_CHANNEL` * * `SEND_MESSAGES` * * `SEND_TTS_MESSAGES` * * `MANAGE_MESSAGES` (delete messages and reactions) * * `EMBED_LINKS` (links posted will have a preview embedded) * * `ATTACH_FILES` * * `READ_MESSAGE_HISTORY` (view messages that were posted prior to opening Discord) * * `MENTION_EVERYONE` * * `USE_EXTERNAL_EMOJIS` (use emojis from different guilds) * * `CONNECT` (connect to a voice channel) * * `SPEAK` (speak in a voice channel) * * `MUTE_MEMBERS` (mute members across all voice channels) * * `DEAFEN_MEMBERS` (deafen members across all voice channels) * * `MOVE_MEMBERS` (move members between voice channels) * * `USE_VAD` (use voice activity detection) * * `CHANGE_NICKNAME` * * `MANAGE_NICKNAMES` (change other members' nicknames) * * `MANAGE_ROLES` * * `MANAGE_WEBHOOKS` * * `MANAGE_EMOJIS` * @type {Object} * @see {@link https://discordapp.com/developers/docs/topics/permissions} */ Permissions.FLAGS = { CREATE_INSTANT_INVITE: 1 << 0, KICK_MEMBERS: 1 << 1, BAN_MEMBERS: 1 << 2, ADMINISTRATOR: 1 << 3, MANAGE_CHANNELS: 1 << 4, MANAGE_GUILD: 1 << 5, ADD_REACTIONS: 1 << 6, VIEW_AUDIT_LOG: 1 << 7, VIEW_CHANNEL: 1 << 10, SEND_MESSAGES: 1 << 11, SEND_TTS_MESSAGES: 1 << 12, MANAGE_MESSAGES: 1 << 13, EMBED_LINKS: 1 << 14, ATTACH_FILES: 1 << 15, READ_MESSAGE_HISTORY: 1 << 16, MENTION_EVERYONE: 1 << 17, USE_EXTERNAL_EMOJIS: 1 << 18, CONNECT: 1 << 20, SPEAK: 1 << 21, MUTE_MEMBERS: 1 << 22, DEAFEN_MEMBERS: 1 << 23, MOVE_MEMBERS: 1 << 24, USE_VAD: 1 << 25, CHANGE_NICKNAME: 1 << 26, MANAGE_NICKNAMES: 1 << 27, MANAGE_ROLES: 1 << 28, MANAGE_WEBHOOKS: 1 << 29, MANAGE_EMOJIS: 1 << 30, }; /** * Bitfield representing every permission combined * @type {number} */ Permissions.ALL = Object.values(Permissions.FLAGS).reduce((all, p) => all | p, 0); /** * Bitfield representing the default permissions for users * @type {number} */ Permissions.DEFAULT = 104324097; module.exports = Permissions;