nhcarrigan/keiko
9
0
Fork 0
generated from nhcarrigan/template
Code Issues Pull Requests 9 Actions Releases Activity

feat: sanction DM links and per-event colour coding #13

Merged
naomi merged 2 commits from feat/sanction-dm-links into main 2026-03-31 17:33:35 -07:00
Conversation 0 Commits 2 Files Changed 20
+106 -20
20 changed files with 106 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 8dd66d88c1 - Show all commits
src/commands/ban.ts
+7 -1
View File
@@ -14,7 +14,11 @@ import {
} from "discord.js";
import { logModerationAction } from "../modules/logModAction.js";
import { sendSanction } from "../modules/sendSanction.js";
import { errorReply, sanctionDmMessage, successReply } from "../utils/components.js";
import {
errorReply,
sanctionDmMessage,
successReply,
} from "../utils/components.js";
import { logger } from "../utils/logger.js";
import type { Command } from "../interfaces/command.js";
@@ -105,6 +109,7 @@ const banCommand: Command = {
await target.send(
sanctionDmMessage(
`You have been banned from **${interaction.guild?.name ?? "the server"}**.\n**Reason:** ${reason}`,
"ban",
),
);
} catch {
@@ -136,6 +141,7 @@ const banCommand: Command = {
await logModerationAction(interaction.client, {
action: "Member Banned",
colour: "ban",
emoji: "🔨",
moderatorTag: interaction.user.username,
reason: reason,
src/commands/kick.ts
+7 -1
View File
@@ -14,7 +14,11 @@ import {
} from "discord.js";
import { logModerationAction } from "../modules/logModAction.js";
import { sendSanction } from "../modules/sendSanction.js";
import { errorReply, sanctionDmMessage, successReply } from "../utils/components.js";
import {
errorReply,
sanctionDmMessage,
successReply,
} from "../utils/components.js";
import { logger } from "../utils/logger.js";
import type { Command } from "../interfaces/command.js";
@@ -100,6 +104,7 @@ const kickCommand: Command = {
await target.send(
sanctionDmMessage(
`You have been kicked from **${interaction.guild?.name ?? "the server"}**.\n**Reason:** ${reason}`,
"kick",
),
);
} catch {
@@ -127,6 +132,7 @@ const kickCommand: Command = {
await logModerationAction(interaction.client, {
action: "Member Kicked",
colour: "kick",
emoji: "👢",
moderatorTag: interaction.user.username,
reason: reason,
src/commands/mute.ts
+7 -1
View File
@@ -14,7 +14,11 @@ import {
} from "discord.js";
import { logModerationAction } from "../modules/logModAction.js";
import { sendSanction } from "../modules/sendSanction.js";
import { errorReply, sanctionDmMessage, successReply } from "../utils/components.js";
import {
errorReply,
sanctionDmMessage,
successReply,
} from "../utils/components.js";
import { logger } from "../utils/logger.js";
import type { Command } from "../interfaces/command.js";
@@ -157,6 +161,7 @@ const muteCommand: Command = {
await target.send(
sanctionDmMessage(
`You have been muted in **${interaction.guild?.name ?? "the server"}** for **${durationLabel}**.\n**Reason:** ${reason}`,
"mute",
),
);
} catch {
@@ -165,6 +170,7 @@ const muteCommand: Command = {
await logModerationAction(interaction.client, {
action: "Member Muted",
colour: "mute",
emoji: "🔇",
moderatorTag: interaction.user.username,
reason: reason,
src/commands/prune.ts
+1
View File
@@ -102,6 +102,7 @@ const pruneCommand: Command = {
await logModerationAction(interaction.client, {
action: "Messages Pruned",
colour: "prune",
emoji: "🗑️",
moderatorTag: interaction.user.username,
reason: `Bulk delete of ${deletedCount.toString()} messages in <#${rawChannel.id}>`,
src/commands/softban.ts
+7 -1
View File
@@ -14,7 +14,11 @@ import {
} from "discord.js";
import { logModerationAction } from "../modules/logModAction.js";
import { sendSanction } from "../modules/sendSanction.js";
import { errorReply, sanctionDmMessage, successReply } from "../utils/components.js";
import {
errorReply,
sanctionDmMessage,
successReply,
} from "../utils/components.js";
import { logger } from "../utils/logger.js";
import type { Command } from "../interfaces/command.js";
@@ -96,6 +100,7 @@ const softbanCommand: Command = {
await target.send(
sanctionDmMessage(
`You have been softbanned from **${interaction.guild?.name ?? "the server"}** (your recent messages have been removed).\n**Reason:** ${reason}`,
"softban",
),
);
} catch {
@@ -132,6 +137,7 @@ const softbanCommand: Command = {
await logModerationAction(interaction.client, {
action: "Member Softbanned",
colour: "softban",
emoji: "🧹",
moderatorTag: interaction.user.username,
reason: reason,
src/commands/unban.ts
+1
View File
@@ -84,6 +84,7 @@ const unbanCommand: Command = {
await logModerationAction(interaction.client, {
action: "Member Unbanned",
colour: "unban",
emoji: "🔓",
moderatorTag: interaction.user.username,
reason: reason,
src/commands/unmute.ts
+1
View File
@@ -103,6 +103,7 @@ const unmuteCommand: Command = {
await logModerationAction(interaction.client, {
action: "Member Unmuted",
colour: "unmute",
emoji: "🔊",
moderatorTag: interaction.user.username,
reason: reason,
src/commands/warn.ts
+7 -1
View File
@@ -14,7 +14,11 @@ import {
} from "discord.js";
import { logModerationAction } from "../modules/logModAction.js";
import { sendSanction } from "../modules/sendSanction.js";
import { errorReply, sanctionDmMessage, successReply } from "../utils/components.js";
import {
errorReply,
sanctionDmMessage,
successReply,
} from "../utils/components.js";
import { logger } from "../utils/logger.js";
import type { Command } from "../interfaces/command.js";
@@ -101,6 +105,7 @@ const warnCommand: Command = {
await target.send(
sanctionDmMessage(
`You have received a warning in **${interaction.guild?.name ?? "the server"}**.\n**Reason:** ${reason}`,
"warn",
),
);
} catch {
@@ -109,6 +114,7 @@ const warnCommand: Command = {
await logModerationAction(interaction.client, {
action: "Warning Issued",
colour: "warn",
emoji: "⚠️",
moderatorTag: interaction.user.username,
reason: reason,
src/events/guildAuditLogEntryCreate.ts
+4
View File
@@ -57,6 +57,7 @@ const handleManualUnban = async(
await logModerationAction(client, {
action: "Member Unbanned",
colour: "unban",
emoji: "🔓",
moderatorTag: moderatorTag,
reason: resolvedReason,
@@ -98,6 +99,7 @@ const handleManualBan = async(
await logModerationAction(client, {
action: "Member Banned",
colour: "ban",
emoji: "🔨",
moderatorTag: moderatorTag,
reason: resolvedReason,
@@ -139,6 +141,7 @@ const handleManualKick = async(
await logModerationAction(client, {
action: "Member Kicked",
colour: "kick",
emoji: "👢",
moderatorTag: moderatorTag,
reason: resolvedReason,
@@ -191,6 +194,7 @@ const handleManualTimeout = async(
await logModerationAction(client, {
action: "Member Muted",
colour: "mute",
emoji: "🔇",
moderatorTag: moderatorTag,
reason: resolvedReason,
src/events/guildMemberUpdate.ts
+4
View File
@@ -41,6 +41,7 @@ export const onGuildMemberUpdate = async(
await logActivity({
client: newMember.client,
colour: "nicknameChange",
emoji: "đź“ť",
fields: [
`**User**: ${username} (\`${userId}\`)`,
@@ -64,6 +65,7 @@ export const onGuildMemberUpdate = async(
await logActivity({
client: newMember.client,
colour: "rolesAdded",
emoji: "âž•",
fields: [
`**User**: ${username} (\`${userId}\`)`,
@@ -86,6 +88,7 @@ export const onGuildMemberUpdate = async(
await logActivity({
client: newMember.client,
colour: "rolesRemoved",
emoji: "âž–",
fields: [
`**User**: ${username} (\`${userId}\`)`,
@@ -98,6 +101,7 @@ export const onGuildMemberUpdate = async(
if (oldMember.avatar !== newMember.avatar) {
await logActivity({
client: newMember.client,
colour: "serverAvatar",
emoji: "🖼️",
fields: [
`**User**: ${username} (\`${userId}\`)`,
src/events/messageDelete.ts
+1
View File
@@ -54,6 +54,7 @@ export const onMessageDelete = async(
await logActivity({
client: message.client,
colour: "messageDeleted",
emoji: "🗑️",
fields: fields,
title: "Message Deleted",
src/events/messageUpdate.ts
+1
View File
@@ -53,6 +53,7 @@ export const onMessageUpdate = async(
await logActivity({
client: newMessage.client,
colour: "messageEdited",
emoji: "✏️",
fields: fields,
title: "Message Edited",
src/events/threadCreate.ts
+1
View File
@@ -27,6 +27,7 @@ export const onThreadCreate = async(
await logActivity({
client: thread.client,
colour: "threadCreated",
emoji: "🧵",
fields: fields,
title: "Thread Created",
src/events/threadDelete.ts
+1
View File
@@ -24,6 +24,7 @@ export const onThreadDelete = async(
await logActivity({
client: thread.client,
colour: "threadDeleted",
emoji: "🗑️",
fields: fields,
title: "Thread Deleted",
src/events/threadUpdate.ts
+1
View File
@@ -52,6 +52,7 @@ export const onThreadUpdate = async(
await logActivity({
client: newThread.client,
colour: "threadUpdated",
emoji: "🔄",
fields: fields,
title: "Thread Updated",
src/events/userUpdate.ts
+3
View File
@@ -29,6 +29,7 @@ export const onUserUpdate = async(
if (oldUser.username !== newUser.username) {
await logActivity({
client: newUser.client,
colour: "usernameChanged",
emoji: "✏️",
fields: [
`**User**: ${newUser.username} (\`${newUser.id}\`)`,
@@ -42,6 +43,7 @@ export const onUserUpdate = async(
if (oldUser.globalName !== newUser.globalName) {
await logActivity({
client: newUser.client,
colour: "displayName",
emoji: "đź“›",
fields: [
`**User**: ${newUser.username} (\`${newUser.id}\`)`,
@@ -55,6 +57,7 @@ export const onUserUpdate = async(
if (oldUser.avatar !== newUser.avatar) {
await logActivity({
client: newUser.client,
colour: "avatarChanged",
emoji: "🖼️",
fields: [
`**User**: ${newUser.username} (\`${newUser.id}\`)`,
src/events/voiceStateUpdate.ts
+1
View File
@@ -60,6 +60,7 @@ export const onVoiceStateUpdate = async(
await logActivity({
client: user.client,
colour: "voiceState",
emoji: "🔊",
fields: fields,
title: "Voice State Update",
src/modules/logActivity.ts
+5 -2
View File
@@ -6,11 +6,12 @@
import { ChannelType, type Client } from "discord.js";
import { channelConfig } from "../config/channels.js";
import { activityMessage } from "../utils/components.js";
import { activityMessage, type ColourKey } from "../utils/components.js";
import { logger } from "../utils/logger.js";
interface ActivityData {
readonly client: Client;
readonly colour: ColourKey;
readonly emoji: string;
readonly fields: string;
readonly title: string;
@@ -35,7 +36,9 @@ const logActivity = async(data: ActivityData): Promise<void> => {
return;
}
await rawChannel.send(activityMessage(data.emoji, data.title, data.fields));
await rawChannel.send(
activityMessage(data.emoji, data.title, data.fields, data.colour),
);
} catch (error) {
await logger.error(
"Failed to log activity",
src/modules/logModAction.ts
+3 -2
View File
@@ -7,11 +7,12 @@
import { ChannelType, type Client } from "discord.js";
import { channelConfig } from "../config/channels.js";
import { modLogMessage } from "../utils/components.js";
import { modLogMessage, type ColourKey } from "../utils/components.js";
import { logger } from "../utils/logger.js";
interface ModuleActionData {
readonly action: string;
readonly colour: ColourKey;
readonly emoji: string;
readonly moderatorTag: string;
readonly reason: string;
@@ -57,7 +58,7 @@ const logModerationAction = async(
join("\n");
await rawChannel.send(
modLogMessage(`${data.emoji} ${data.action}`, fields, data.source),
modLogMessage(`${data.emoji} ${data.action}`, fields, data.source, data.colour),
);
} catch (error) {
await logger.error(
src/utils/components.ts
+43 -11
View File
@@ -27,13 +27,33 @@ const MessageFlags = {
} as const;
const Colours = {
error: 0xED_42_45,
info: 0x58_65_F2,
join: 0x57_F2_87,
leave: 0x99_AA_B5,
modAction: 0xE6_7E_22,
success: 0x57_F2_87,
warning: 0xFE_E7_5C,
avatarChanged: 0xEC_40_7A,
ban: 0xE7_4C_3C,
displayName: 0xAB_47_BC,
error: 0xED_42_45,
info: 0x58_65_F2,
join: 0x57_F2_87,
kick: 0xE6_7E_22,
leave: 0x99_AA_B5,
messageDeleted: 0xC0_39_2B,
messageEdited: 0x29_80_B9,
mute: 0xF3_9C_12,
nicknameChange: 0x9B_59_B6,
prune: 0x34_98_DB,
rolesAdded: 0x27_AE_60,
rolesRemoved: 0xE7_4C_3C,
serverAvatar: 0x16_A0_85,
softban: 0xD3_54_00,
success: 0x57_F2_87,
threadCreated: 0x00_BC_D4,
threadDeleted: 0x54_6E_7A,
threadUpdated: 0x5D_AD_E2,
unban: 0x2E_CC_71,
unmute: 0x1A_BC_9C,
usernameChanged: 0x7E_57_C2,
voiceState: 0x43_B5_81,
warn: 0xF1_C4_0F,
warning: 0xFE_E7_5C,
} as const;
/* eslint-enable @typescript-eslint/naming-convention -- Enum-style constants use PascalCase by convention */
@@ -106,18 +126,21 @@ const errorReply = (title: string, body: string): Record<string, unknown> => {
* @param title - The formatted title string (emoji + action combined).
* @param fields - The formatted field lines for the log entry.
* @param source - Whether the action originated from a command or the audit log.
* @param colour - The accent colour for the container.
* @returns A Discord message payload object.
*/
const modLogMessage = (
title: string,
fields: string,
source: "Command" | "Audit Log",
colour: ColourKey,
// eslint-disable-next-line @typescript-eslint/max-params -- Four params is the minimum needed for this helper
): Record<string, unknown> => {
return {
allowedMentions: { parse: [] },
components: [
buildContainer(
"modAction",
colour,
`## ${title}`,
fields,
`*Source: ${source}*`,
@@ -132,16 +155,19 @@ const modLogMessage = (
* @param emoji - The emoji to prefix the title with.
* @param title - The title of the activity entry.
* @param fields - The formatted field lines.
* @param colour - The accent colour for the container.
* @returns A Discord message payload object.
*/
const activityMessage = (
emoji: string,
title: string,
fields: string,
colour: ColourKey,
// eslint-disable-next-line @typescript-eslint/max-params -- Four params is the minimum needed for this helper
): Record<string, unknown> => {
return {
allowedMentions: { parse: [] },
components: [ buildContainer("info", `## ${emoji} ${title}`, fields) ],
components: [ buildContainer(colour, `## ${emoji} ${title}`, fields) ],
flags: MessageFlags.IsComponentsV2,
};
};
@@ -174,6 +200,7 @@ const memberMessage = (
};
const sanctionLinks = [
// eslint-disable-next-line stylistic/max-len -- URL cannot be shortened
"**Appeal this sanction:** https://forms.nhcarrigan.com/o/docs/forms/4w5VHsYiEkiS2mewvtuJYL/4",
"**View sanction logs:** https://hikari.nhcarrigan.com/sanctions",
"**Contact us:** https://docs.nhcarrigan.com/about/contact/",
@@ -184,15 +211,20 @@ const sanctionLinks = [
* Builds a Components v2 DM payload for sanction notifications.
* Includes a separator between the sanction details and the resource links.
* @param sanctionText - The formatted sanction message (action + reason).
* @param colour - The accent colour for the container.
* @returns A Discord message payload object.
*/
const sanctionDmMessage = (sanctionText: string): Record<string, unknown> => {
const sanctionDmMessage = (
sanctionText: string,
colour: ColourKey,
): Record<string, unknown> => {
return {
components: [ buildContainer("modAction", sanctionText, sanctionLinks) ],
components: [ buildContainer(colour, sanctionText, sanctionLinks) ],
flags: MessageFlags.IsComponentsV2,
};
};
export type { ColourKey };
export {
activityMessage,
errorReply,