feat: add raw-format command and tip

Author: quirky-bluejay

package.json

@@ -1,6 +1,6 @@
 {
   "name": "message-manager-backend",
-  "version": "2.2.1",
+  "version": "2.3.0",
   "description": "Backend for the message manager site",
   "main": "./dist/index.js",
   "exports": "./dist/index.js",

src/discord_commands/global.json

@@ -164,6 +164,7 @@
   },
   {
     "default_permission": true,
+    "dm_permission": true,
     "type": 1,
     "name": "info",
     "description": "Information Commands",
@@ -176,5 +177,52 @@
         "required": true
       }
     ]
+  },
+  {
+    "type": 1,
+    "name": "raw-format",
+    "description": "Get the raw format of user, channel and role mentions. Use this format to show mentions in messages",
+    "dm_permission": true,
+    "options": [
+      {
+        "type": 1,
+        "name": "user",
+        "description": "Get the raw format of a user mention",
+        "options": [
+          {
+            "type": 6,
+            "name": "user",
+            "required": true,
+            "description": "The user to get the raw format of"
+          }
+        ]
+      },
+      {
+        "type": 1,
+        "name": "role",
+        "description": "Get the raw format of a role mention",
+        "options": [
+          {
+            "type": 8,
+            "name": "role",
+            "required": true,
+            "description": "The role to get the raw format of"
+          }
+        ]
+      },
+      {
+        "type": 1,
+        "name": "channel",
+        "description": "Get the raw format of a channel mention",
+        "options": [
+          {
+            "type": 7,
+            "name": "channel",
+            "required": true,
+            "description": "The channel to get the raw format of"
+          }
+        ]
+      }
+    ]
   }
 ]

src/interactions/commands/chatInput/raw-format.ts

@@ -0,0 +1,129 @@
+import {
+  APIApplicationCommandInteractionDataChannelOption,
+  APIApplicationCommandInteractionDataRoleOption,
+  APIApplicationCommandInteractionDataSubcommandOption,
+  APIApplicationCommandInteractionDataUserOption,
+  APIChatInputApplicationCommandGuildInteraction,
+  ApplicationCommandOptionType,
+  InteractionResponseType,
+  MessageFlags,
+} from "discord-api-types/v9";
+
+import {
+  InteractionOrRequestFinalStatus,
+  UnexpectedFailure,
+} from "../../../errors";
+import { InternalInteractionType } from "../../interaction";
+import { InteractionReturnData } from "../../types";
+
+// eslint-disable-next-line @typescript-eslint/require-await
+export default async function handleRawFormatCommand(
+  internalInteraction: InternalInteractionType<APIChatInputApplicationCommandGuildInteraction>
+): Promise<InteractionReturnData> {
+  const interaction = internalInteraction.interaction;
+  const subcommand = interaction.data.options?.[0];
+  if (
+    !subcommand ||
+    subcommand.type !== ApplicationCommandOptionType.Subcommand
+  ) {
+    throw new UnexpectedFailure(
+      InteractionOrRequestFinalStatus.APPLICATION_COMMAND_MISSING_EXPECTED_OPTION,
+      "Missing subcommand"
+    );
+  }
+  switch (subcommand.name) {
+    case "user":
+      return handleRawFormatUserSubcommand(internalInteraction, subcommand);
+
+    case "role":
+      return handleRawFormatRoleSubcommand(internalInteraction, subcommand);
+
+    case "channel":
+      return handleRawFormatChannelSubcommand(internalInteraction, subcommand);
+
+    default:
+      throw new UnexpectedFailure(
+        InteractionOrRequestFinalStatus.APPLICATION_COMMAND_UNEXPECTED_SUBCOMMAND,
+        `Invalid subcommand: \`${subcommand.name}\``
+      );
+  }
+}
+
+function handleRawFormatUserSubcommand(
+  internalInteraction: InternalInteractionType<APIChatInputApplicationCommandGuildInteraction>,
+  subcommand: APIApplicationCommandInteractionDataSubcommandOption
+): InteractionReturnData {
+  const targetId: string | undefined = (
+    subcommand.options?.find(
+      (option) =>
+        option.name === "user" &&
+        option.type === ApplicationCommandOptionType.User
+    ) as APIApplicationCommandInteractionDataUserOption | undefined
+  )?.value;
+  if (targetId === undefined) {
+    throw new UnexpectedFailure(
+      InteractionOrRequestFinalStatus.APPLICATION_COMMAND_MISSING_EXPECTED_OPTION,
+      "Missing target option"
+    );
+  }
+
+  return {
+    type: InteractionResponseType.ChannelMessageWithSource,
+    data: {
+      content: `\`<@${targetId}>\``,
+      flags: MessageFlags.Ephemeral,
+    },
+  };
+}
+function handleRawFormatRoleSubcommand(
+  internalInteraction: InternalInteractionType<APIChatInputApplicationCommandGuildInteraction>,
+  subcommand: APIApplicationCommandInteractionDataSubcommandOption
+): InteractionReturnData {
+  const targetId: string | undefined = (
+    subcommand.options?.find(
+      (option) =>
+        option.name === "role" &&
+        option.type === ApplicationCommandOptionType.Role
+    ) as APIApplicationCommandInteractionDataRoleOption | undefined
+  )?.value;
+  if (targetId === undefined) {
+    throw new UnexpectedFailure(
+      InteractionOrRequestFinalStatus.APPLICATION_COMMAND_MISSING_EXPECTED_OPTION,
+      "Missing target option"
+    );
+  }
+
+  return {
+    type: InteractionResponseType.ChannelMessageWithSource,
+    data: {
+      content: `\`<@&${targetId}>\``,
+      flags: MessageFlags.Ephemeral,
+    },
+  };
+}
+
+function handleRawFormatChannelSubcommand(
+  internalInteraction: InternalInteractionType<APIChatInputApplicationCommandGuildInteraction>,
+  subcommand: APIApplicationCommandInteractionDataSubcommandOption
+): InteractionReturnData {
+  const targetId: string | undefined = (
+    subcommand.options?.find(
+      (option) =>
+        option.name === "channel" &&
+        option.type === ApplicationCommandOptionType.Channel
+    ) as APIApplicationCommandInteractionDataChannelOption | undefined
+  )?.value;
+  if (targetId === undefined) {
+    throw new UnexpectedFailure(
+      InteractionOrRequestFinalStatus.APPLICATION_COMMAND_MISSING_EXPECTED_OPTION,
+      "Missing target option"
+    );
+  }
+  return {
+    type: InteractionResponseType.ChannelMessageWithSource,
+    data: {
+      content: `\`<#${targetId}>\``,
+      flags: MessageFlags.Ephemeral,
+    },
+  };
+}

src/interactions/index.ts

@@ -50,6 +50,7 @@ import handleConfigCommand from "./commands/chatInput/config";
 import handleInfoCommand, {
   handleInfoAutocomplete,
 } from "./commands/chatInput/info";
+import handleRawFormatCommand from "./commands/chatInput/raw-format";
 import handleSendCommand from "./commands/chatInput/send";
 import handleActionMessageCommand from "./commands/message/actions";
 import handleAddMessageMessageCommand from "./commands/message/addMessage";
@@ -573,6 +574,7 @@ const interactionsPlugin = async (instance: FastifyInstance) => {
   handler.addGuildOnlyCommand("config", handleConfigCommand);
   handler.addGuildOnlyCommand("actions", handleActionsCommand);
   handler.addGuildOnlyCommand("add-message", handleAddMessageCommand);
+  handler.addGuildOnlyCommand("raw-format", handleRawFormatCommand);
 
   // Add message commands to handler
   handler.addGuildOnlyMessageCommand("actions", handleActionMessageCommand);

src/lib/tips/tips.ts

@@ -14,6 +14,10 @@ const allTips: Tip[] = [
   {
     message: "Discord administrators always have all bot permissions",
   },
+  {
+    message:
+      "Use /raw-format to get the format for mentions to show up in messages!",
+  },
 ];
 
 export { allTips };