const Collection = require('../util/Collection'); const Snowflake = require('../util/Snowflake'); const Base = require('./Base'); const { TypeError } = require('../errors'); /** * Represents a custom emoji. * @extends {Base} */ class Emoji extends Base { constructor(client, data, guild) { super(client); /** * The guild this emoji is part of * @type {Guild} */ this.guild = guild; this._patch(data); } _patch(data) { /** * The ID of the emoji * @type {Snowflake} */ this.id = data.id; /** * The name of the emoji * @type {string} */ this.name = data.name; /** * Whether or not this emoji requires colons surrounding it * @type {boolean} */ this.requiresColons = data.require_colons; /** * Whether this emoji is managed by an external service * @type {boolean} */ this.managed = data.managed; this._roles = data.roles; } /** * The timestamp the emoji was created at * @type {number} * @readonly */ get createdTimestamp() { return Snowflake.deconstruct(this.id).timestamp; } /** * The time the emoji was created * @type {Date} * @readonly */ get createdAt() { return new Date(this.createdTimestamp); } /** * A collection of roles this emoji is active for (empty if all), mapped by role ID * @type {Collection} * @readonly */ get roles() { const roles = new Collection(); for (const role of this._roles) { if (this.guild.roles.has(role)) roles.set(role, this.guild.roles.get(role)); } return roles; } /** * The URL to the emoji file * @type {string} * @readonly */ get url() { return this.client.rest.cdn.Emoji(this.id); } /** * The identifier of this emoji, used for message reactions * @type {string} * @readonly */ get identifier() { if (this.id) return `${this.name}:${this.id}`; return encodeURIComponent(this.name); } /** * Data for editing an emoji. * @typedef {Object} EmojiEditData * @property {string} [name] The name of the emoji * @property {Collection|RoleResolvable[]} [roles] Roles to restrict emoji to */ /** * Edits the emoji. * @param {EmojiEditData} data The new data for the emoji * @param {string} [reason] Reason for editing this emoji * @returns {Promise} * @example * // Edit an emoji * emoji.edit({name: 'newemoji'}) * .then(e => console.log(`Edited emoji ${e}`)) * .catch(console.error); */ edit(data, reason) { return this.client.api.guilds(this.guild.id).emojis(this.id) .patch({ data: { name: data.name, roles: data.roles ? data.roles.map(r => r.id ? r.id : r) : undefined, }, reason }) .then(() => this); } /** * Set the name of the emoji. * @param {string} name The new name for the emoji * @param {string} [reason] Reason for changing the emoji's name * @returns {Promise} */ setName(name, reason) { return this.edit({ name }, reason); } /** * Add a role to the list of roles that can use this emoji. * @param {Role} role The role to add * @returns {Promise} */ addRestrictedRole(role) { return this.addRestrictedRoles([role]); } /** * Add multiple roles to the list of roles that can use this emoji. * @param {Collection|RoleResolvable[]} roles Roles to add * @returns {Promise} */ addRestrictedRoles(roles) { const newRoles = new Collection(this.roles); for (let role of roles instanceof Collection ? roles.values() : roles) { role = this.guild.roles.resolve(role); if (!role) { return Promise.reject(new TypeError('INVALID_TYPE', 'roles', 'Array or Collection of Roles or Snowflakes', true)); } newRoles.set(role.id, role); } return this.edit({ roles: newRoles }); } /** * Remove a role from the list of roles that can use this emoji. * @param {Role} role The role to remove * @returns {Promise} */ removeRestrictedRole(role) { return this.removeRestrictedRoles([role]); } /** * Remove multiple roles from the list of roles that can use this emoji. * @param {Collection|RoleResolvable[]} roles Roles to remove * @returns {Promise} */ removeRestrictedRoles(roles) { const newRoles = new Collection(this.roles); for (let role of roles instanceof Collection ? roles.values() : roles) { role = this.guild.roles.resolve(role); if (!role) { return Promise.reject(new TypeError('INVALID_TYPE', 'roles', 'Array or Collection of Roles or Snowflakes', true)); } if (newRoles.has(role.id)) newRoles.delete(role.id); } return this.edit({ roles: newRoles }); } /** * When concatenated with a string, this automatically returns the emoji mention rather than the object. * @returns {string} * @example * // Send an emoji: * const emoji = guild.emojis.first(); * msg.reply(`Hello! ${emoji}`); */ toString() { return this.requiresColons ? `<:${this.name}:${this.id}>` : this.name; } /** * Delete the emoji. * @param {string} [reason] Reason for deleting the emoji * @returns {Promise} */ delete(reason) { return this.client.api.guilds(this.guild.id).emojis(this.id).delete({ reason }) .then(() => this); } /** * Whether this emoji is the same as another one. * @param {Emoji|Object} other The emoji to compare it to * @returns {boolean} Whether the emoji is equal to the given emoji or not */ equals(other) { if (other instanceof Emoji) { return ( other.id === this.id && other.name === this.name && other.managed === this.managed && other.requiresColons === this.requiresColons && other._roles === this._roles ); } else { return ( other.id === this.id && other.name === this.name && other._roles === this._roles ); } } } module.exports = Emoji;