feat: add mentionable and attachment to command option type

Author: davidabou

src/register.ts

@@ -1,7 +1,7 @@
 import { ClientEvents, Events } from 'discord.js'
 import consola from 'consola'
 import { colors } from 'consola/utils'
-import { toOption, resolveOption } from './utils'
+import { resolveOption } from './utils'
 import { ctx } from './harmonix'
 import type { Harmonix, ParsedInputs, ParsedOptions } from './types'
 
@@ -36,11 +36,7 @@ export const registerCommands = (harmonix: Harmonix) => {
       Promise<ParsedOptions>
     >(async (acc, opt) => {
       const resolvedAcc = await acc
-      const resolvedOption = await resolveOption(
-        interaction,
-        toOption(opt.type),
-        String(opt.value)
-      )
+      const resolvedOption = resolveOption(interaction, opt.type, opt.name)
 
       return {
         ...resolvedAcc,

src/types/commands.ts

@@ -4,17 +4,24 @@ import type {
   PermissionsString,
   User,
   GuildBasedChannel,
-  Role
+  Role,
+  APIRole,
+  APIInteractionDataResolvedChannel,
+  GuildMember,
+  APIInteractionDataResolvedGuildMember,
+  Attachment
 } from 'discord.js'
 
-export type OptionType =
+type OptionType =
   | 'String'
   | 'Integer'
   | 'Boolean'
   | 'User'
   | 'Channel'
   | 'Role'
   | 'Number'
+  | 'Mentionable'
+  | 'Attachment'
 
 type _OptionDef<T extends OptionType> = {
   type: T
@@ -30,6 +37,8 @@ type UserOptionDef = _OptionDef<'User'>
 type ChannelOptionDef = _OptionDef<'Channel'>
 type RoleOptionDef = _OptionDef<'Role'>
 type NumberOptionDef = _OptionDef<'Number'>
+type MentionableOptionDef = _OptionDef<'Mentionable'>
+type AttachmentOptionDef = _OptionDef<'Attachment'>
 
 type OptionDef =
   | StringOptionDef
@@ -39,8 +48,24 @@ type OptionDef =
   | ChannelOptionDef
   | RoleOptionDef
   | NumberOptionDef
+  | MentionableOptionDef
+  | AttachmentOptionDef
 export type OptionsDef = Record<string, OptionDef>
 
+export type ParsedOptionType =
+  | string
+  | number
+  | boolean
+  | User
+  | GuildBasedChannel
+  | APIInteractionDataResolvedChannel
+  | Role
+  | APIRole
+  | GuildMember
+  | APIInteractionDataResolvedGuildMember
+  | Attachment
+  | null
+
 export type ParsedOptions<T extends OptionsDef = OptionsDef> = Record<
   {
     [K in keyof T]: T[K] extends {
@@ -49,7 +74,7 @@ export type ParsedOptions<T extends OptionsDef = OptionsDef> = Record<
       ? K
       : never
   }[keyof T],
-  string | undefined
+  string | null
 > &
   Record<
     {
@@ -59,7 +84,7 @@ export type ParsedOptions<T extends OptionsDef = OptionsDef> = Record<
         ? K
         : never
     }[keyof T],
-    number | undefined
+    number | null
   > &
   Record<
     {
@@ -69,7 +94,7 @@ export type ParsedOptions<T extends OptionsDef = OptionsDef> = Record<
         ? K
         : never
     }[keyof T],
-    boolean | undefined
+    boolean | null
   > &
   Record<
     {
@@ -79,7 +104,7 @@ export type ParsedOptions<T extends OptionsDef = OptionsDef> = Record<
         ? K
         : never
     }[keyof T],
-    User | undefined
+    User | null
   > &
   Record<
     {
@@ -89,7 +114,7 @@ export type ParsedOptions<T extends OptionsDef = OptionsDef> = Record<
         ? K
         : never
     }[keyof T],
-    GuildBasedChannel | undefined
+    GuildBasedChannel | APIInteractionDataResolvedChannel | null
   > &
   Record<
     {
@@ -99,7 +124,7 @@ export type ParsedOptions<T extends OptionsDef = OptionsDef> = Record<
         ? K
         : never
     }[keyof T],
-    Role | undefined
+    Role | APIRole | null
   > &
   Record<
     {
@@ -109,7 +134,27 @@ export type ParsedOptions<T extends OptionsDef = OptionsDef> = Record<
         ? K
         : never
     }[keyof T],
-    number | undefined
+    number | null
+  > &
+  Record<
+    {
+      [K in keyof T]: T[K] extends {
+        type: 'Mentionable'
+      }
+        ? K
+        : never
+    }[keyof T],
+    GuildMember | APIInteractionDataResolvedGuildMember | null
+  > &
+  Record<
+    {
+      [K in keyof T]: T[K] extends {
+        type: 'Attachment'
+      }
+        ? K
+        : never
+    }[keyof T],
+    Attachment | null
   >
 
 interface CommandContext<T extends OptionsDef = OptionsDef> {

src/utils.ts

@@ -4,17 +4,13 @@ import {
   ChatInputCommandInteraction,
   ContextMenuCommandBuilder,
   PermissionFlagsBits,
-  SlashCommandBuilder,
-  channelMention,
-  roleMention,
-  userMention,
-  type User
+  SlashCommandBuilder
 } from 'discord.js'
 import type {
   HarmonixCommand,
   HarmonixContextMenu,
-  OptionType,
-  OptionsDef
+  OptionsDef,
+  ParsedOptionType
 } from './types'
 
 export const slashToJSON = (cmd: HarmonixCommand<OptionsDef>) => {
@@ -143,6 +139,22 @@ export const slashToJSON = (cmd: HarmonixCommand<OptionsDef>) => {
             return opt
           })
           break
+        case 'Mentionable':
+          builder.addMentionableOption((opt) =>
+            opt
+              .setName(name)
+              .setDescription(arg.description ?? 'No description provided')
+              .setRequired(arg.required ?? true)
+          )
+          break
+        case 'Attachment':
+          builder.addAttachmentOption((opt) =>
+            opt
+              .setName(name)
+              .setDescription(arg.description ?? 'No description provided')
+              .setRequired(arg.required ?? true)
+          )
+          break
       }
     }
   }
@@ -176,87 +188,30 @@ export const isHarmonixCommand = (
   return (command as HarmonixCommand<OptionsDef>).config.category !== undefined
 }
 
-export const resolveOption = async (
-  interaction: ChatInputCommandInteraction,
-  type: OptionType | null,
-  value: string
-) => {
-  switch (type) {
-    case 'String':
-      return value
-    case 'Integer':
-      return parseInt(value)
-    case 'Boolean':
-      return value === 'true'
-    case 'User':
-      const user = await resolveUser(interaction, value)
-
-      return user
-    case 'Channel':
-      const channel = await resolveChannel(interaction, value)
-
-      return channel
-    case 'Role':
-      const role = await resolveRole(interaction, value)
-
-      return role
-    case 'Number':
-      return parseFloat(value)
-  }
-}
-
-const resolveUser = async (
-  interaction: ChatInputCommandInteraction,
-  value: string
-): Promise<User | undefined> => {
-  return interaction.guild?.members.cache.find(
-    (member) =>
-      member.user.username === value ||
-      member.nickname === value ||
-      member.id === value ||
-      userMention(member.id) === value ||
-      `<@!${member.id}>` === value
-  )?.user
-}
-
-const resolveChannel = async (
+export const resolveOption = (
   interaction: ChatInputCommandInteraction,
-  value: string
-) => {
-  return interaction.guild?.channels.cache.find(
-    (channel) =>
-      channel.name === value ||
-      channel.id === value ||
-      channelMention(channel.id) === value
-  )
-}
-
-const resolveRole = async (
-  interaction: ChatInputCommandInteraction,
-  value: string
-) => {
-  return interaction.guild?.roles.cache.find(
-    (role) =>
-      role.name === value || role.id === value || roleMention(role.id) === value
-  )
-}
-
-export const toOption = (type: ApplicationCommandOptionType | null) => {
+  type: ApplicationCommandOptionType,
+  name: string
+): ParsedOptionType => {
   switch (type) {
     case ApplicationCommandOptionType.String:
-      return 'String'
+      return interaction.options.getString(name)
     case ApplicationCommandOptionType.Integer:
-      return 'Integer'
+      return interaction.options.getInteger(name)
     case ApplicationCommandOptionType.Boolean:
-      return 'Boolean'
+      return interaction.options.getBoolean(name)
     case ApplicationCommandOptionType.User:
-      return 'User'
+      return interaction.options.getUser(name)
     case ApplicationCommandOptionType.Channel:
-      return 'Channel'
+      return interaction.options.getChannel(name)
     case ApplicationCommandOptionType.Role:
-      return 'Role'
+      return interaction.options.getRole(name)
     case ApplicationCommandOptionType.Number:
-      return 'Number'
+      return interaction.options.getNumber(name)
+    case ApplicationCommandOptionType.Mentionable:
+      return interaction.options.getMentionable(name)
+    case ApplicationCommandOptionType.Attachment:
+      return interaction.options.getAttachment(name)
     default:
       return null
   }