mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-09 16:13:31 +01:00
373 lines
10 KiB
JavaScript
373 lines
10 KiB
JavaScript
'use strict';
|
|
|
|
const Util = require('../util/Util');
|
|
const { RangeError } = require('../errors');
|
|
|
|
/**
|
|
* Represents an embed in a message (image/video preview, rich embed, etc.)
|
|
*/
|
|
class MessageEmbed {
|
|
constructor(data = {}) {
|
|
this.setup(data);
|
|
}
|
|
|
|
setup(data) { // eslint-disable-line complexity
|
|
/**
|
|
* The type of this embed, either:
|
|
* * `image` - an image embed
|
|
* * `video` - a video embed
|
|
* * `gifv` - a gifv embed
|
|
* * `link` - a link embed
|
|
* * `rich` - a rich embed
|
|
* @type {string}
|
|
*/
|
|
this.type = data.type;
|
|
|
|
/**
|
|
* The title of this embed
|
|
* @type {?string}
|
|
*/
|
|
this.title = data.title;
|
|
|
|
/**
|
|
* The description of this embed
|
|
* @type {?string}
|
|
*/
|
|
this.description = data.description;
|
|
|
|
/**
|
|
* The URL of this embed
|
|
* @type {?string}
|
|
*/
|
|
this.url = data.url;
|
|
|
|
/**
|
|
* The color of this embed
|
|
* @type {?number}
|
|
*/
|
|
this.color = Util.resolveColor(data.color);
|
|
|
|
/**
|
|
* The timestamp of this embed
|
|
* @type {?number}
|
|
*/
|
|
this.timestamp = data.timestamp ? new Date(data.timestamp).getTime() : null;
|
|
|
|
/**
|
|
* @typedef {Object} EmbedField
|
|
* @property {string} name The name of this field
|
|
* @property {string} value The value of this field
|
|
* @property {boolean} inline If this field will be displayed inline
|
|
*/
|
|
|
|
/**
|
|
* The fields of this embed
|
|
* @type {EmbedField[]}
|
|
*/
|
|
this.fields = data.fields ? data.fields.map(Util.cloneObject) : [];
|
|
|
|
/**
|
|
* The thumbnail of this embed (if there is one)
|
|
* @type {?Object}
|
|
* @property {string} url URL for this thumbnail
|
|
* @property {string} proxyURL ProxyURL for this thumbnail
|
|
* @property {number} height Height of this thumbnail
|
|
* @property {number} width Width of this thumbnail
|
|
*/
|
|
this.thumbnail = data.thumbnail ? {
|
|
url: data.thumbnail.url,
|
|
proxyURL: data.thumbnail.proxy_url,
|
|
height: data.thumbnail.height,
|
|
width: data.thumbnail.width,
|
|
} : null;
|
|
|
|
/**
|
|
* The image of this embed, if there is one
|
|
* @type {?Object}
|
|
* @property {string} url URL for this image
|
|
* @property {string} proxyURL ProxyURL for this image
|
|
* @property {number} height Height of this image
|
|
* @property {number} width Width of this image
|
|
*/
|
|
this.image = data.image ? {
|
|
url: data.image.url,
|
|
proxyURL: data.image.proxy_url,
|
|
height: data.image.height,
|
|
width: data.image.width,
|
|
} : null;
|
|
|
|
/**
|
|
* The video of this embed (if there is one)
|
|
* @type {?Object}
|
|
* @property {string} url URL of this video
|
|
* @property {string} proxyURL ProxyURL for this video
|
|
* @property {number} height Height of this video
|
|
* @property {number} width Width of this video
|
|
* @readonly
|
|
*/
|
|
this.video = data.video ? {
|
|
url: data.video.url,
|
|
proxyURL: data.video.proxy_url,
|
|
height: data.video.height,
|
|
width: data.video.width,
|
|
} : null;
|
|
|
|
/**
|
|
* The author of this embed (if there is one)
|
|
* @type {?Object}
|
|
* @property {string} name The name of this author
|
|
* @property {string} url URL of this author
|
|
* @property {string} iconURL URL of the icon for this author
|
|
* @property {string} proxyIconURL Proxied URL of the icon for this author
|
|
*/
|
|
this.author = data.author ? {
|
|
name: data.author.name,
|
|
url: data.author.url,
|
|
iconURL: data.author.iconURL || data.author.icon_url,
|
|
proxyIconURL: data.author.proxyIconUrl || data.author.proxy_icon_url,
|
|
} : null;
|
|
|
|
/**
|
|
* The provider of this embed (if there is one)
|
|
* @type {?Object}
|
|
* @property {string} name The name of this provider
|
|
* @property {string} url URL of this provider
|
|
*/
|
|
this.provider = data.provider;
|
|
|
|
/**
|
|
* The footer of this embed
|
|
* @type {?Object}
|
|
* @property {string} text The text of this footer
|
|
* @property {string} iconURL URL of the icon for this footer
|
|
* @property {string} proxyIconURL Proxied URL of the icon for this footer
|
|
*/
|
|
this.footer = data.footer ? {
|
|
text: data.footer.text,
|
|
iconURL: data.footer.iconURL || data.footer.icon_url,
|
|
proxyIconURL: data.footer.proxyIconURL || data.footer.proxy_icon_url,
|
|
} : null;
|
|
|
|
/**
|
|
* The files of this embed
|
|
* @type {Array<FileOptions|string|MessageAttachment>}
|
|
*/
|
|
this.files = data.files || [];
|
|
}
|
|
|
|
/**
|
|
* The date this embed was created at
|
|
* @type {?Date}
|
|
* @readonly
|
|
*/
|
|
get createdAt() {
|
|
return this.timestamp ? new Date(this.timestamp) : null;
|
|
}
|
|
|
|
/**
|
|
* The hexadecimal version of the embed color, with a leading hash
|
|
* @type {?string}
|
|
* @readonly
|
|
*/
|
|
get hexColor() {
|
|
return this.color ? `#${this.color.toString(16).padStart(6, '0')}` : null;
|
|
}
|
|
|
|
/**
|
|
* The accumulated length for the embed title, description, fields and footer text
|
|
* @type {number}
|
|
* @readonly
|
|
*/
|
|
get length() {
|
|
return (
|
|
(this.title ? this.title.length : 0) +
|
|
(this.description ? this.description.length : 0) +
|
|
(this.fields.length >= 1 ? this.fields.reduce((prev, curr) =>
|
|
prev + curr.name.length + curr.value.length, 0) : 0) +
|
|
(this.footer ? this.footer.text.length : 0));
|
|
}
|
|
|
|
/**
|
|
* Adds a fields to the embed (max 25).
|
|
* @param {...EmbedField|EmbedField[]} fields The fields to add
|
|
* @returns {MessageEmbed}
|
|
*/
|
|
addFields(...fields) {
|
|
this.fields.push(...this.constructor.normalizeFields(fields));
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Removes, replaces, and inserts fields in the embed (max 25).
|
|
* @param {number} index The index to start at
|
|
* @param {number} deleteCount The number of fields to remove
|
|
* @param {...EmbedField|EmbedField[]} [fields] The replacing field objects
|
|
* @returns {MessageEmbed}
|
|
*/
|
|
spliceFields(index, deleteCount, ...fields) {
|
|
this.fields.splice(index, deleteCount, ...this.constructor.normalizeFields(...fields));
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets the file to upload alongside the embed. This file can be accessed via `attachment://fileName.extension` when
|
|
* setting an embed image or author/footer icons. Multiple files can be attached.
|
|
* @param {Array<FileOptions|string|MessageAttachment>} files Files to attach
|
|
* @returns {MessageEmbed}
|
|
*/
|
|
attachFiles(files) {
|
|
this.files = this.files.concat(files);
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets the author of this embed.
|
|
* @param {StringResolvable} name The name of the author
|
|
* @param {string} [iconURL] The icon URL of the author
|
|
* @param {string} [url] The URL of the author
|
|
* @returns {MessageEmbed}
|
|
*/
|
|
setAuthor(name, iconURL, url) {
|
|
this.author = { name: Util.resolveString(name), iconURL, url };
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets the color of this embed.
|
|
* @param {ColorResolvable} color The color of the embed
|
|
* @returns {MessageEmbed}
|
|
*/
|
|
setColor(color) {
|
|
this.color = Util.resolveColor(color);
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets the description of this embed.
|
|
* @param {StringResolvable} description The description
|
|
* @returns {MessageEmbed}
|
|
*/
|
|
setDescription(description) {
|
|
description = Util.resolveString(description);
|
|
this.description = description;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets the footer of this embed.
|
|
* @param {StringResolvable} text The text of the footer
|
|
* @param {string} [iconURL] The icon URL of the footer
|
|
* @returns {MessageEmbed}
|
|
*/
|
|
setFooter(text, iconURL) {
|
|
text = Util.resolveString(text);
|
|
this.footer = { text, iconURL };
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets the image of this embed.
|
|
* @param {string} url The URL of the image
|
|
* @returns {MessageEmbed}
|
|
*/
|
|
setImage(url) {
|
|
this.image = { url };
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets the thumbnail of this embed.
|
|
* @param {string} url The URL of the thumbnail
|
|
* @returns {MessageEmbed}
|
|
*/
|
|
setThumbnail(url) {
|
|
this.thumbnail = { url };
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets the timestamp of this embed.
|
|
* @param {Date|number} [timestamp=Date.now()] The timestamp or date
|
|
* @returns {MessageEmbed}
|
|
*/
|
|
setTimestamp(timestamp = Date.now()) {
|
|
if (timestamp instanceof Date) timestamp = timestamp.getTime();
|
|
this.timestamp = timestamp;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets the title of this embed.
|
|
* @param {StringResolvable} title The title
|
|
* @returns {MessageEmbed}
|
|
*/
|
|
setTitle(title) {
|
|
title = Util.resolveString(title);
|
|
this.title = title;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets the URL of this embed.
|
|
* @param {string} url The URL
|
|
* @returns {MessageEmbed}
|
|
*/
|
|
setURL(url) {
|
|
this.url = url;
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Transforms the embed to a plain object.
|
|
* @returns {Object} The raw data of this embed
|
|
*/
|
|
toJSON() {
|
|
return {
|
|
title: this.title,
|
|
type: 'rich',
|
|
description: this.description,
|
|
url: this.url,
|
|
timestamp: this.timestamp ? new Date(this.timestamp) : null,
|
|
color: this.color,
|
|
fields: this.fields,
|
|
thumbnail: this.thumbnail,
|
|
image: this.image,
|
|
author: this.author ? {
|
|
name: this.author.name,
|
|
url: this.author.url,
|
|
icon_url: this.author.iconURL,
|
|
} : null,
|
|
footer: this.footer ? {
|
|
text: this.footer.text,
|
|
icon_url: this.footer.iconURL,
|
|
} : null,
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Checks for valid field input and resolves strings
|
|
* @param {StringResolvable} name The name of the field
|
|
* @param {StringResolvable} value The value of the field
|
|
* @param {boolean} [inline=false] Set the field to display inline
|
|
* @returns {EmbedField}
|
|
*/
|
|
static normalizeField(name, value, inline = false) {
|
|
name = Util.resolveString(name);
|
|
if (!name) throw new RangeError('EMBED_FIELD_NAME');
|
|
value = Util.resolveString(value);
|
|
if (!value) throw new RangeError('EMBED_FIELD_VALUE');
|
|
return { name, value, inline };
|
|
}
|
|
|
|
/**
|
|
* Check for valid field input and resolves strings
|
|
* @param {...EmbedField|EmbedField[]} fields Fields to normalize
|
|
* @returns {EmbedField[]}
|
|
*/
|
|
static normalizeFields(...fields) {
|
|
return fields.flat(2).map(({ name, value, inline }) => this.normalizeField(name, value, inline));
|
|
}
|
|
}
|
|
|
|
module.exports = MessageEmbed;
|