-
Notifications
You must be signed in to change notification settings - Fork 13
/
modmail.js
283 lines (258 loc) · 8.24 KB
/
modmail.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
import {
GuildMember,
Message,
EmbedBuilder,
ButtonBuilder,
Colors,
MessageMentions,
ButtonStyle,
User,
} from "discord.js";
import { generateHash } from "../util/text.js";
import { escapeMessage } from "../util/markdown.js";
import { asyncFilter } from "../util/promises.js";
import { disableComponents, extractMessageExtremities, messageToText } from "../util/discord.js";
import CONSTANTS from "./CONSTANTS.js";
import { MessageActionRowBuilder } from "./types/ActionRowBuilder.js";
import client, { guild } from "../client.js";
export const MODMAIL_COLORS = {
opened: Colors.Gold,
closed: Colors.DarkGreen,
confirm: Colors.Blurple,
};
export const MODMAIL_UNSUPPORTED =
"Please note that reactions, replies, edits, and deletions are not supported";
/**
* Generate a webhook message from a message sent by a user.
*
* @param {import("discord.js").Message} message - Message sent by a user.
*
* @returns {Promise<import("discord.js").WebhookCreateMessageOptions>} - Webhook message.
*/
export async function generateModmailMessage(message) {
const { files, embeds } = await extractMessageExtremities(message);
const member =
(message.interaction &&
(await guild?.members.fetch(message.interaction.user.id).catch(() => {}))) ||
message.member ||
(await guild?.members.fetch(message.author.id).catch(() => {}));
return {
avatarURL: (member || message.author).displayAvatarURL(),
content: (await messageToText(message, false)) || undefined,
embeds,
files,
username: member?.displayName ?? message.author.username,
};
}
/**
* Given a modmail ticket thread, return the user who messages are being sent to.
*
* @param {import("discord.js").ThreadChannel} thread - Modmail ticket thread.
*
* @returns User who messages are being sent to.
*/
export async function getUserFromModmail(thread) {
const starter = await thread.fetchStarterMessage().catch(() => {});
const embed = starter?.embeds[0];
if (!embed?.description) return;
const userId = embed.description.match(MessageMentions.UsersPattern)?.[1] ?? embed.description;
return (
(await guild.members.fetch(userId).catch(() => {})) ||
(await client.users.fetch(userId).catch(() => {}))
);
}
/**
* Given a user, find a ticket thread that sends messages to them.
*
* @param {import("discord.js").GuildMember | import("discord.js").User} user - The user to search for.
*
* @returns {Promise<import("discord.js").ThreadChannel | void>} - Ticket thread.
*/
export async function getThreadFromMember(user) {
if (!CONSTANTS.channels.modmail) return;
const { threads } = await CONSTANTS.channels.modmail.threads.fetchActive();
return (
await asyncFilter(
threads.toJSON(),
async (thread) => (await getUserFromModmail(thread))?.id === user.id && thread,
).next()
).value;
}
/**
* Let a user know that their ticket has been closed.
*
* @param {import("discord.js").ThreadChannel} thread - Ticket thread.
* @param {{ reason?: string; user?: import("discord.js").User | import("discord.js").GuildMember }} meta - The reason for closing the ticket.
*
* @returns {Promise<Message<false> | undefined>} - Message sent to user.
*/
export async function sendClosedMessage(thread, { reason, user } = {}) {
const member = await getUserFromModmail(thread);
const embed = new EmbedBuilder()
.setTitle("Modmail ticket closed!")
.setTimestamp(thread.createdAt)
.setFooter({
iconURL: guild.iconURL() ?? undefined,
text: "Any future messages will start a new ticket.",
})
.setColor(MODMAIL_COLORS.closed);
if (reason) embed.setDescription(reason);
if (user) {
const member =
user instanceof GuildMember
? user
: (await guild.members.fetch(user.id).catch(() => {})) || user;
embed.setAuthor({
iconURL: member.displayAvatarURL(),
name: member instanceof GuildMember ? member.displayName : member.username,
});
}
return (
await Promise.all([
thread
.fetchStarterMessage()
.catch(() => {})
.then((starter) => {
starter
?.edit({
embeds: [
(starter.embeds[0]
? EmbedBuilder.from(starter.embeds[0])
: new EmbedBuilder()
)
.setTitle("Modmail ticket closed!")
.setColor(MODMAIL_COLORS.closed),
],
})
.catch(console.error);
}),
member?.send({ embeds: [embed] }),
])
)[1];
}
/**
* Close a Modmail ticket.
*
* @param {import("discord.js").ThreadChannel} thread - Modmail ticket thread.
* @param {import("discord.js").User} user - User who closed the ticket.
* @param {string} [reason] - The reason for closing the ticket.
*/
export async function closeModmail(thread, user, reason) {
await sendClosedMessage(thread, { reason, user });
await thread.setArchived(true, `Closed by ${user.tag}${reason ? ": " + reason : ""}`);
}
/**
* Let a user know that the Mods want to talk to them.
*
* @param {GuildMember | User} user - The user to message.
*
* @returns {Promise<import("discord.js").Message<false> | false>} - The message sent.
*/
export async function sendOpenedMessage(user) {
return await user
.send({
embeds: [
new EmbedBuilder()
.setTitle("Modmail ticket opened!")
.setDescription(
`The moderation team of **${escapeMessage(
guild.name,
)}** would like to talk to you. I will DM you their messages. You may send them messages by sending me DMs.`,
)
.setFooter({ text: MODMAIL_UNSUPPORTED })
.setColor(MODMAIL_COLORS.opened),
],
})
.catch(() => false);
}
/**
* @param {EmbedBuilder} confirmEmbed
* @param {(buttonInteraction: import("discord.js").MessageComponentInteraction) => Promise<void>} onConfirm
* @param {(options: import("discord.js").BaseMessageOptions) => Promise<Message>} reply
*/
export async function generateModmailConfirm(confirmEmbed, onConfirm, reply) {
const confirmId = generateHash("confirm");
const button = new ButtonBuilder()
.setLabel("Confirm")
.setStyle(ButtonStyle.Primary)
.setCustomId(confirmId);
const cancelId = generateHash("cancel");
const cancelButton = new ButtonBuilder()
.setLabel("Cancel")
.setCustomId(cancelId)
.setStyle(ButtonStyle.Secondary);
const message = await reply({
components: [new MessageActionRowBuilder().addComponents(button, cancelButton)],
embeds: [confirmEmbed],
});
const collector = message.createMessageComponentCollector({
filter: (buttonInteraction) => [confirmId, cancelId].includes(buttonInteraction.customId),
time: CONSTANTS.collectorTime,
});
collector
.on("collect", async (buttonInteraction) => {
collector.stop();
switch (buttonInteraction.customId) {
case confirmId: {
await onConfirm(buttonInteraction);
break;
}
case cancelId: {
await buttonInteraction.reply({
content: `${CONSTANTS.emojis.statuses.no} Modmail canceled!`,
ephemeral: true,
});
break;
}
}
})
.on("end", async () => {
await message.edit({ components: disableComponents(message.components) });
});
return collector;
}
/**
* @param {import("discord.js").Message} message
*
* @returns
*/
export function generateReactionFunctions(message) {
return /** @type {const} */ ([
async () => {
const reaction = await message.react(CONSTANTS.emojis.statuses.yes);
message.channel
.createMessageCollector({ maxProcessed: 1, time: 5_000 })
.on("end", async () => {
await reaction.users.remove(client.user || "");
});
return reaction;
},
/** @param {unknown} error */
async (error) => {
console.error(error);
return await message.react(CONSTANTS.emojis.statuses.no);
},
]);
}
/**
* @param {EmbedBuilder} openedEmbed
* @param {string} name
*/
export async function openModmail(openedEmbed, name, ping = false) {
if (!CONSTANTS.channels.modmail) throw new ReferenceError("Cannot find modmail channel");
const starterMessage = await CONSTANTS.channels.modmail.send({
allowedMentions: { parse: ["everyone"] },
content: process.env.NODE_ENV === "production" && ping ? "@here" : undefined,
embeds: [openedEmbed],
});
const date = new Date();
const thread = await starterMessage.startThread({
name: `${name} (${date.getUTCFullYear().toLocaleString([], { useGrouping: false })}-${date
.getUTCMonth()
.toLocaleString([], { minimumIntegerDigits: 2 })}-${date
.getUTCDate()
.toLocaleString([], { minimumIntegerDigits: 2 })})`,
});
await thread.setLocked(true);
return thread;
}