Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(AllowedMentions): add support for MessageOptions#allowedMentions #3893

Merged
merged 12 commits into from
Mar 19, 2020
Merged
18 changes: 18 additions & 0 deletions src/structures/APIMessage.js
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,23 @@ class APIMessage {
flags = this.options.flags != null ? new MessageFlags(this.options.flags).bitfield : this.target.flags.bitfield;
}

let mentionUserIds;
let mentionRoleIds;
if (this.options.allowedMentions) {
monbrey marked this conversation as resolved.
Show resolved Hide resolved
if (this.options.allowedMentions.users) {
monbrey marked this conversation as resolved.
Show resolved Hide resolved
mentionUserIds = this.options.allowedMentions.users.map(u => this.target.client.users.resolveID(u));
monbrey marked this conversation as resolved.
Show resolved Hide resolved
}
if (this.options.allowedMentions.roles) {
monbrey marked this conversation as resolved.
Show resolved Hide resolved
mentionRoleIds = this.options.allowedMentions.roles.map(r => this.target.client.roles.resolveID(r));
monbrey marked this conversation as resolved.
Show resolved Hide resolved
}
}

const allowedMentions = {
parse: this.options.allowedMentions.parse,
monbrey marked this conversation as resolved.
Show resolved Hide resolved
users: mentionUserIds,
roles: mentionRoleIds,
};

this.data = {
content,
tts,
Expand All @@ -184,6 +201,7 @@ class APIMessage {
embeds,
username,
avatar_url: avatarURL,
allowed_mentions: allowedMentions,
flags,
};
return this;
Expand Down
1 change: 1 addition & 0 deletions src/structures/Webhook.js
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ class Webhook {
* @property {boolean} [tts=false] Whether or not the message should be spoken aloud
* @property {string} [nonce=''] The nonce for the message
* @property {Object[]} [embeds] An array of embeds for the message
* @property {MessageMentionOptions} [allowedMentions] Which mentions should be parsed from the message content
* (see [here](https://discordapp.com/developers/docs/resources/channel#embed-object) for more details)
* @property {'none' | 'all' | 'everyone'} [disableMentions=this.client.options.disableMentions] Whether or not
* all mentions or everyone/here mentions should be sanitized to prevent unexpected mentions
Expand Down
14 changes: 14 additions & 0 deletions src/structures/interfaces/TextBasedChannel.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ class TextBasedChannel {
* @property {string} [content=''] The content for the message
* @property {MessageEmbed|Object} [embed] An embed for the message
* (see [here](https://discordapp.com/developers/docs/resources/channel#embed-object) for more details)
* @property {MessageMentionOptions} [allowedMentions] Which mentions should be parsed from the message content
monbrey marked this conversation as resolved.
Show resolved Hide resolved
* @property {'none' | 'all' | 'everyone'} [disableMentions=this.client.options.disableMentions] Whether or not
* all mentions or everyone/here mentions should be sanitized to prevent unexpected mentions
* @property {FileOptions[]|BufferResolvable[]} [files] Files to send with the message
Expand All @@ -67,6 +68,19 @@ class TextBasedChannel {
* @property {UserResolvable} [reply] User to reply to (prefixes the message with a mention, except in DMs)
*/

/**
* Options provided to control parsing of mentions by Discord
* @typedef {Object} MessageMentionOptions
* @property {MessageMentionTypes[]} [parse] Types of mentions to be parsed
monbrey marked this conversation as resolved.
Show resolved Hide resolved
* @property {UserResolvable[]} [users] Snowflakes of Users to be parsed as mentions
* @property {RoleResolvable[]} [roles] Snowflakes of Roles to be parsed as mentions
monbrey marked this conversation as resolved.
Show resolved Hide resolved
*/

/**
* Types of mentions to enable in MessageMentionOptions
* @typedef {'role' | 'users' | 'everyone'} MessageMentionTypes
*/

/**
* @typedef {Object} FileOptions
* @property {BufferResolvable} attachment File to attach
Expand Down
10 changes: 10 additions & 0 deletions typings/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2742,12 +2742,21 @@ declare module 'discord.js' {

type MessageFlagsString = 'CROSSPOSTED' | 'IS_CROSSPOST' | 'SUPPRESS_EMBEDS' | 'SOURCE_MESSAGE_DELETED' | 'URGENT';

interface MessageMentionOptions {
parse?: MessageMentionTypes[];
roles?: UserResolvable[];
users?: RoleResolvable[];
monbrey marked this conversation as resolved.
Show resolved Hide resolved
}

type MessageMentionTypes = 'roles' | 'users' | 'everyone';

interface MessageOptions {
tts?: boolean;
nonce?: string;
content?: string;
embed?: MessageEmbed | MessageEmbedOptions;
disableMentions?: 'none' | 'all' | 'everyone';
allowedMentions?: MessageMentionOptions;
files?: (FileOptions | BufferResolvable | Stream | MessageAttachment)[];
code?: string | boolean;
split?: boolean | SplitOptions;
Expand Down Expand Up @@ -2994,6 +3003,7 @@ declare module 'discord.js' {
nonce?: string;
embeds?: (MessageEmbed | object)[];
disableMentions?: 'none' | 'all' | 'everyone';
allowedMentions?: MessageMentionOptions;
files?: (FileOptions | BufferResolvable | Stream | MessageAttachment)[];
code?: string | boolean;
split?: boolean | SplitOptions;
Expand Down