const TextBasedChannel = require('./interfaces/TextBasedChannel'); const Role = require('./Role'); const Permissions = require('../util/Permissions'); const Collection = require('../util/Collection'); const { Presence } = require('./Presence'); const { Error, TypeError } = require('../errors'); /** * Represents a member of a guild on Discord. * @implements {TextBasedChannel} */ class GuildMember { constructor(guild, data) { /** * The client that instantiated this GuildMember * @name GuildMember#client * @type {Client} * @readonly */ Object.defineProperty(this, 'client', { value: guild.client }); /** * The guild that this member is part of * @type {Guild} */ this.guild = guild; /** * The user that this guild member instance Represents * @type {User} */ this.user = {}; this._roles = []; if (data) this.setup(data); /** * The ID of the last message sent by the member in their guild, if one was sent * @type {?Snowflake} */ this.lastMessageID = null; /** * The Message object of the last message sent by the member in their guild, if one was sent * @type {?Message} */ this.lastMessage = null; } setup(data) { /** * Whether this member is deafened server-wide * @type {boolean} */ this.serverDeaf = data.deaf; /** * Whether this member is muted server-wide * @type {boolean} */ this.serverMute = data.mute; /** * Whether this member is self-muted * @type {boolean} */ this.selfMute = data.self_mute; /** * Whether this member is self-deafened * @type {boolean} */ this.selfDeaf = data.self_deaf; /** * The voice session ID of this member, if any * @type {?Snowflake} */ this.voiceSessionID = data.session_id; /** * The voice channel ID of this member, if any * @type {?Snowflake} */ this.voiceChannelID = data.channel_id; /** * Whether this member is speaking * @type {boolean} */ this.speaking = false; /** * The nickname of this guild member, if they have one * @type {?string} */ this.nickname = data.nick || null; /** * The timestamp the member joined the guild at * @type {number} */ this.joinedTimestamp = new Date(data.joined_at).getTime(); this.user = data.user; this._roles = data.roles; } /** * The time the member joined the guild * @type {Date} * @readonly */ get joinedAt() { return new Date(this.joinedTimestamp); } /** * The presence of this guild member * @type {Presence} * @readonly */ get presence() { return this.frozenPresence || this.guild.presences.get(this.id) || new Presence(); } /** * A list of roles that are applied to this GuildMember, mapped by the role ID * @type {Collection} * @readonly */ get roles() { const list = new Collection(); const everyoneRole = this.guild.roles.get(this.guild.id); if (everyoneRole) list.set(everyoneRole.id, everyoneRole); for (const roleID of this._roles) { const role = this.guild.roles.get(roleID); if (role) list.set(role.id, role); } return list; } /** * The role of the member with the highest position * @type {Role} * @readonly */ get highestRole() { return this.roles.reduce((prev, role) => !prev || role.comparePositionTo(prev) > 0 ? role : prev); } /** * The role of the member used to set their color * @type {?Role} * @readonly */ get colorRole() { const coloredRoles = this.roles.filter(role => role.color); if (!coloredRoles.size) return null; return coloredRoles.reduce((prev, role) => !prev || role.comparePositionTo(prev) > 0 ? role : prev); } /** * The displayed color of the member in base 10 * @type {number} * @readonly */ get displayColor() { const role = this.colorRole; return (role && role.color) || 0; } /** * The displayed color of the member in hexadecimal * @type {string} * @readonly */ get displayHexColor() { const role = this.colorRole; return (role && role.hexColor) || '#000000'; } /** * The role of the member used to hoist them in a separate category in the users list * @type {?Role} * @readonly */ get hoistRole() { const hoistedRoles = this.roles.filter(role => role.hoist); if (!hoistedRoles.size) return null; return hoistedRoles.reduce((prev, role) => !prev || role.comparePositionTo(prev) > 0 ? role : prev); } /** * Whether this member is muted in any way * @type {boolean} * @readonly */ get mute() { return this.selfMute || this.serverMute; } /** * Whether this member is deafened in any way * @type {boolean} * @readonly */ get deaf() { return this.selfDeaf || this.serverDeaf; } /** * The voice channel this member is in, if any * @type {?VoiceChannel} * @readonly */ get voiceChannel() { return this.guild.channels.get(this.voiceChannelID); } /** * The ID of this user * @type {Snowflake} * @readonly */ get id() { return this.user.id; } /** * The nickname of the member, or their username if they don't have one * @type {string} * @readonly */ get displayName() { return this.nickname || this.user.username; } /** * The overall set of permissions for the guild member, taking only roles into account * @type {Permissions} * @readonly */ get permissions() { if (this.user.id === this.guild.ownerID) return new Permissions(Permissions.ALL); let permissions = 0; const roles = this.roles; for (const role of roles.values()) permissions |= role.permissions; return new Permissions(permissions); } /** * Whether the member is kickable by the client user * @type {boolean} * @readonly */ get kickable() { if (this.user.id === this.guild.ownerID) return false; if (this.user.id === this.client.user.id) return false; const clientMember = this.guild.member(this.client.user); if (!clientMember.permissions.has(Permissions.FLAGS.KICK_MEMBERS)) return false; return clientMember.highestRole.comparePositionTo(this.highestRole) > 0; } /** * Whether the member is bannable by the client user * @type {boolean} * @readonly */ get bannable() { if (this.user.id === this.guild.ownerID) return false; if (this.user.id === this.client.user.id) return false; const clientMember = this.guild.member(this.client.user); if (!clientMember.permissions.has(Permissions.FLAGS.BAN_MEMBERS)) return false; return clientMember.highestRole.comparePositionTo(this.highestRole) > 0; } /** * Returns `channel.permissionsFor(guildMember)`. Returns permissions for a member in a guild channel, * taking into account roles and permission overwrites. * @param {ChannelResolvable} channel The guild channel to use as context * @returns {?Permissions} */ permissionsIn(channel) { channel = this.client.resolver.resolveChannel(channel); if (!channel || !channel.guild) throw new Error('GUILD_CHANNEL_RESOLVE'); return channel.permissionsFor(this); } /** * Checks if any of the member's roles have a permission. * @param {PermissionResolvable|PermissionResolvable[]} permission Permission(s) to check for * @param {boolean} [explicit=false] Whether to require the role to explicitly have the exact permission * **(deprecated)** * @param {boolean} [checkAdmin] Whether to allow the administrator permission to override * (takes priority over `explicit`) * @param {boolean} [checkOwner] Whether to allow being the guild's owner to override * (takes priority over `explicit`) * @returns {boolean} */ hasPermission(permission, explicit = false, checkAdmin, checkOwner) { if (typeof checkAdmin === 'undefined') checkAdmin = !explicit; if (typeof checkOwner === 'undefined') checkOwner = !explicit; if (checkOwner && this.user.id === this.guild.ownerID) return true; return this.roles.some(r => r.hasPermission(permission, undefined, checkAdmin)); } /** * Checks whether the roles of the member allows them to perform specific actions, and lists any missing permissions. * @param {PermissionResolvable[]} permissions The permissions to check for * @param {boolean} [explicit=false] Whether to require the member to explicitly have the exact permissions * @returns {PermissionResolvable[]} */ missingPermissions(permissions, explicit = false) { return permissions.missing(permissions, explicit); } /** * The data for editing a guild member. * @typedef {Object} GuildMemberEditData * @property {string} [nick] The nickname to set for the member * @property {Collection|Role[]|Snowflake[]} [roles] The roles or role IDs to apply * @property {boolean} [mute] Whether or not the member should be muted * @property {boolean} [deaf] Whether or not the member should be deafened * @property {ChannelResolvable} [channel] Channel to move member to (if they are connected to voice) */ /** * Edit a guild member. * @param {GuildMemberEditData} data The data to edit the member with * @param {string} [reason] Reason for editing this user * @returns {Promise} */ edit(data, reason) { if (data.channel) { data.channel_id = this.client.resolver.resolveChannel(data.channel).id; data.channel = null; } if (data.roles) data.roles = data.roles.map(role => role instanceof Role ? role.id : role); let endpoint = this.client.api.guilds(this.guild.id); if (this.user.id === this.client.user.id) { const keys = Object.keys(data); if (keys.length === 1 && keys[0] === 'nick') endpoint = endpoint.members('@me').nick; else endpoint = endpoint.members(this.id); } else { endpoint = endpoint.members(this.id); } return endpoint.patch({ data, reason }).then(newData => this.guild._updateMember(this, newData).mem); } /** * Mute/unmute a user. * @param {boolean} mute Whether or not the member should be muted * @returns {Promise} */ setMute(mute) { return this.edit({ mute }); } /** * Deafen/undeafen a user. * @param {boolean} deaf Whether or not the member should be deafened * @returns {Promise} */ setDeaf(deaf) { return this.edit({ deaf }); } /** * Moves the guild member to the given channel. * @param {ChannelResolvable} channel The channel to move the member to * @returns {Promise} */ setVoiceChannel(channel) { return this.edit({ channel }); } /** * Sets the roles applied to the member. * @param {Collection|Role[]|Snowflake[]} roles The roles or role IDs to apply * @returns {Promise} */ setRoles(roles) { return this.edit({ roles }); } /** * Adds a single role to the member. * @param {Role|Snowflake} role The role or ID of the role to add * @returns {Promise} */ addRole(role) { if (!(role instanceof Role)) role = this.guild.roles.get(role); if (!role) return Promise.reject(new TypeError('INVALID_TYPE', 'role', 'Role nor a Snowflake')); if (this._roles.includes(role.id)) return Promise.resolve(this); return this.client.api.guilds(this.guild.id).members(this.user.id).roles(role.id) .put() .then(() => this); } /** * Adds multiple roles to the member. * @param {Collection|Role[]|Snowflake[]} roles The roles or role IDs to add * @returns {Promise} */ addRoles(roles) { let allRoles; if (roles instanceof Collection) { allRoles = this._roles.slice(); for (const role of roles.values()) allRoles.push(role.id ? role.id : role); } else { allRoles = this._roles.concat(roles.map(r => r.id ? r.id : r)); } return this.edit({ roles: allRoles }); } /** * Removes a single role from the member. * @param {Role|Snowflake} role The role or ID of the role to remove * @returns {Promise} */ removeRole(role) { if (!(role instanceof Role)) role = this.guild.roles.get(role); if (!role) return Promise.reject(new TypeError('INVALID_TYPE', 'role', 'Role nor a Snowflake')); return this.client.api.guilds(this.guild.id).members(this.user.id).roles(role.id) .delete() .then(() => this); } /** * Removes multiple roles from the member. * @param {Collection|Role[]|Snowflake[]} roles The roles or role IDs to remove * @returns {Promise} */ removeRoles(roles) { const allRoles = this._roles.slice(); if (roles instanceof Collection) { for (const role of roles.values()) { const index = allRoles.indexOf(role.id); if (index >= 0) allRoles.splice(index, 1); } } else { for (const role of roles) { const index = allRoles.indexOf(role instanceof Role ? role.id : role); if (index >= 0) allRoles.splice(index, 1); } } return this.edit({ roles: allRoles }); } /** * Set the nickname for the guild member. * @param {string} nick The nickname for the guild member * @returns {Promise} */ setNickname(nick) { return this.edit({ nick }); } /** * Creates a DM channel between the client and the member. * @returns {Promise} */ createDM() { return this.user.createDM(); } /** * Deletes any DMs with this guild member. * @returns {Promise} */ deleteDM() { return this.user.deleteDM(); } /** * Kick this member from the guild. * @param {string} [reason] Reason for kicking user * @returns {Promise} */ kick(reason) { return this.client.api.guilds(this.guild.id).members(this.user.id).delete({ reason }) .then(() => this.client.actions.GuildMemberRemove.handle({ guild_id: this.guild.id, user: this.user, }).member ); } /** * Ban this guild member * @param {Object|number|string} [options] Ban options. If a number, the number of days to delete messages for, if a * string, the ban reason. Supplying an object allows you to do both. * @param {number} [options.days=0] Number of days of messages to delete * @param {string} [options.reason] Reason for banning * @returns {Promise} * @example * // ban a guild member * guildMember.ban(7); */ ban(options) { return this.guild.ban(this, options); } /** * When concatenated with a string, this automatically concatenates the user's mention instead of the Member object. * @returns {string} * @example * // Logs: Hello from <@123456789>! * console.log(`Hello from ${member}!`); */ toString() { return `<@${this.nickname ? '!' : ''}${this.user.id}>`; } // These are here only for documentation purposes - they are implemented by TextBasedChannel /* eslint-disable no-empty-function */ send() {} } TextBasedChannel.applyToClass(GuildMember); module.exports = GuildMember;