refactor: streamline command and context menu definitions, enhance utility functions

davidabou · davidabou · commit e7e386889a62 · 2024-06-06T18:13:42.000-04:00
diff --git a/playground/commands/info.ts b/playground/commands/info.ts
@@ -1,4 +1,4 @@
-import { defineCommand } from '../../src'
+import { defineCommand, useActionRow, useButtons } from '../../src'
 
 export default defineCommand(
   {
@@ -24,13 +24,15 @@ export default defineCommand(
       }
     }
   },
-  (_, interaction, ctx) => {
+  (interaction, ctx) => {
     const { user, server } = ctx.options
+    const { hello } = useButtons()
+    const row = useActionRow(hello!, hello!)
 
     if (user) {
-      return interaction.reply('User info')
+      return interaction.reply({ content: 'User info', components: [row] })
     } else if (server) {
-      return interaction.reply('Server info')
+      return interaction.reply({ content: 'Server info', components: [row] })
     }
   }
 )
diff --git a/playground/commands/moderations/ban.ts b/playground/commands/moderations/ban.ts
@@ -16,7 +16,7 @@ export default defineCommand(
     },
     userPermissions: ['Administrator']
   },
-  async (_, interaction, ctx) => {
+  async (interaction, ctx) => {
     const { user, reason } = ctx.options
 
     interaction.reply(`Banned user ${user} for ${reason}`)
diff --git a/playground/commands/moderations/kick.ts b/playground/commands/moderations/kick.ts
@@ -15,7 +15,7 @@ export default defineCommand(
       }
     }
   },
-  (_, interaction, context) => {
+  (interaction, context) => {
     const { user, reason } = context.options
 
     interaction.reply(`Kicked user ${user} for ${reason}`)
diff --git a/playground/commands/utils/noop.ts b/playground/commands/utils/noop.ts
@@ -1,13 +1,13 @@
-import { defineCommand, getSelectMenu, useActionRow } from '../../../src'
+import { defineCommand, useActionRow, useSelectMenus } from '../../../src'
 
 export default defineCommand(
   {
     description: 'NOOP!',
     dm: true
   },
-  (_, interaction) => {
-    const selectMenu = getSelectMenu('choose')
-    const row = useActionRow(selectMenu!)
+  (interaction) => {
+    const { choose } = useSelectMenus()
+    const row = useActionRow(choose)
 
     interaction.reply({ content: 'Noop', components: [row] })
   }
diff --git a/playground/commands/utils/ping.ts b/playground/commands/utils/ping.ts
@@ -1,10 +1,12 @@
-import { defineCommand } from '../../../src'
+import { defineCommand, useHarmonix } from '../../../src'
 
 export default defineCommand(
   {
     description: 'Pong!'
   },
-  (client, interaction) => {
+  (interaction) => {
+    const { client } = useHarmonix()
+
     interaction.reply(`Pong ${client.ws.ping}ms!`)
   }
 )
diff --git a/playground/commands/utils/test.ts b/playground/commands/utils/test.ts
@@ -1,13 +1,13 @@
-import { defineCommand, getModal } from '../../../src'
+import { defineCommand, useModals } from '../../../src'
 
 export default defineCommand(
   {
     description: 'Test the bot',
     preconditions: ['ownerOnly']
   },
-  async (_, interaction) => {
-    const modal = getModal('form')
+  async (interaction) => {
+    const { form } = useModals()
 
-    await interaction.showModal(modal!)
+    await interaction.showModal(form!)
   }
 )
diff --git a/playground/context-menus/info.ts b/playground/context-menus/info.ts
@@ -3,11 +3,10 @@ import { defineContextMenu } from '../../src'
 export default defineContextMenu(
   {
     name: 'Get message author',
+    type: 'Message',
     preconditions: ['ownerOnly']
   },
-  (interaction) => {
-    interaction.reply(
-      `This message has been sent by ${interaction.targetMessage.author}`
-    )
+  async (interaction, target) => {
+    await interaction.reply(`This message has been sent by ${target.author}`)
   }
 )
diff --git a/playground/select-menus/choose.ts b/playground/select-menus/choose.ts
@@ -5,11 +5,13 @@ export default defineSelectMenu(
     type: 'User',
     placeholder: 'Choose a user'
   },
-  (interaction) => {
+  async (interaction, selected) => {
+    const member = await interaction.guild?.members.fetch(selected[0])
     const embed = useEmbed({
       color: 0x2c2d31,
-      description: `You selected ${interaction.users.first()}!`
+      description: `You selected ${member?.user}!`
     })
+
     interaction.reply({ embeds: [embed] })
   }
 )
diff --git a/src/builtins.ts b/src/builtins.ts
@@ -44,9 +44,9 @@ export const helpCommand = defineCommand(
       return interaction.respond(options)
     }
   },
-  async (client, interaction, ctx) => {
+  async (interaction, ctx) => {
     const { command } = ctx.options
-    const { commands } = useHarmonix()
+    const { client, commands } = useHarmonix()
 
     if (!command) {
       const groupedCommands = groupCommandsByCategory(
diff --git a/src/define.ts b/src/define.ts
@@ -61,7 +61,7 @@ export const defineEvent: DefineEvent = <
 }
 
 export const defineCommand = <T extends OptionsDef = OptionsDef>(
-  config: CommandConfig & { options?: T },
+  config: Omit<CommandConfig<T>, 'id'> & { options?: T },
   execute: CommandExecute<T>
 ): HarmonixCommand<T> => {
   for (const [key, value] of Object.entries(config.options ?? {})) {
@@ -77,7 +77,7 @@ export const defineCommand = <T extends OptionsDef = OptionsDef>(
 }
 
 export const defineContextMenu: DefineContextMenu = <
-  T extends ContextMenuType = 'Message'
+  T extends ContextMenuType = ContextMenuType
 >(
   ...args: [
     (ContextMenuConfig & { type?: T }) | ContextMenuCallback<T>,
diff --git a/src/discord.ts b/src/discord.ts
@@ -1,6 +1,6 @@
 import { APIApplicationCommand, Client, REST, Routes } from 'discord.js'
 import consola from 'consola'
-import type { Harmonix } from './types'
+import type { Harmonix, RuntimeHarmonix } from './types'
 import 'dotenv/config'
 import { createError, ctx } from './harmonix'
 import { toJSON } from './utils'
@@ -48,7 +48,7 @@ export const refreshApplicationCommands = async (harmonix: Harmonix) => {
       const readyEvent = harmonix.events.get('ready')
 
       if (readyEvent) {
-        ctx.call(harmonix, () => readyEvent.callback(client))
+        ctx.call(harmonix as RuntimeHarmonix, () => readyEvent.callback(client))
       }
     } catch (error: any) {
       createError(error.message)
diff --git a/src/harmonix.ts b/src/harmonix.ts
@@ -45,10 +45,15 @@ import {
   resolvePrecondition,
   resolveSelectMenu
 } from './resolve'
-import type { Harmonix, HarmonixConfig, HarmonixOptions } from './types'
+import type {
+  Harmonix,
+  HarmonixConfig,
+  HarmonixOptions,
+  RuntimeHarmonix
+} from './types'
 import { version } from '../package.json'
 
-export const ctx = getContext<Harmonix>('harmonix')
+export const ctx = getContext<RuntimeHarmonix>('harmonix')
 export const useHarmonix = ctx.use
 
 const initHarmonix = async (
diff --git a/src/index.ts b/src/index.ts
@@ -1,4 +1,3 @@
 export * from './define'
-export * from './getters'
 export * from './uses'
 export { createHarmonix, createError, useHarmonix } from './harmonix'
diff --git a/src/register.ts b/src/register.ts
@@ -1,21 +1,30 @@
-import { ClientEvents, Events } from 'discord.js'
+import {
+  ClientEvents,
+  Events,
+  MessageContextMenuCommandInteraction
+} from 'discord.js'
 import consola from 'consola'
 import { resolveOption } from './utils'
 import { createError, ctx } from './harmonix'
-import type { Harmonix, ParsedInputs, ParsedOptions } from './types'
+import type {
+  Harmonix,
+  ParsedInputs,
+  ParsedOptions,
+  RuntimeHarmonix
+} from './types'
 
 export const registerEvents = (harmonix: Harmonix) => {
   for (const [, event] of harmonix.events) {
     if (event.config.name === 'ready') continue
     if (event.config.once) {
       harmonix.client?.once(event.config.name!, (...args) => {
-        ctx.call(harmonix, () =>
+        ctx.call(harmonix as RuntimeHarmonix, () =>
           event.callback(...(args as ClientEvents[keyof ClientEvents]))
         )
       })
     } else {
       harmonix.client?.on(event.config.name!, (...args) => {
-        ctx.call(harmonix, () =>
+        ctx.call(harmonix as RuntimeHarmonix, () =>
           event.callback(...(args as ClientEvents[keyof ClientEvents]))
         )
       })
@@ -53,17 +62,15 @@ export const registerCommands = (harmonix: Harmonix) => {
           consola.warn(`Precondition \`${prc}\` not found.`)
           continue
         }
-        const result = ctx.call(harmonix, () =>
+        const result = ctx.call(harmonix as RuntimeHarmonix, () =>
           precondition.callback(interaction)
         )
 
         if (!result) return
       }
     }
-    ctx.call(harmonix, () =>
-      cmd.execute(harmonix.client!, interaction, {
-        options
-      })
+    ctx.call(harmonix as RuntimeHarmonix, () =>
+      cmd.execute(interaction, { options })
     )
   })
 }
@@ -82,14 +89,19 @@ export const registerContextMenu = (harmonix: Harmonix) => {
           consola.warn(`Precondition \`${prc}\` not found.`)
           continue
         }
-        const result = ctx.call(harmonix, () =>
+        const result = ctx.call(harmonix as RuntimeHarmonix, () =>
           precondition.callback(interaction)
         )
 
         if (!result) return
       }
     }
-    ctm.callback(interaction)
+    ctm.callback(
+      interaction,
+      interaction instanceof MessageContextMenuCommandInteraction
+        ? interaction.targetMessage
+        : interaction.targetUser
+    )
   })
 }
 
@@ -127,7 +139,7 @@ export const registerSelectMenus = (harmonix: Harmonix) => {
     const slm = harmonix.selectMenus.get(interaction.customId)
 
     if (!slm) return
-    slm.callback(interaction)
+    slm.callback(interaction, interaction.values)
   })
 }
 
@@ -139,7 +151,7 @@ export const registerAutocomplete = (harmonix: Harmonix) => {
     if (!cmd || !cmd.config.autocomplete) return
     try {
       await ctx.call(
-        harmonix,
+        harmonix as RuntimeHarmonix,
         async () => await cmd.config.autocomplete!(interaction)
       )
     } catch (error: any) {
diff --git a/src/types/commands.ts b/src/types/commands.ts
@@ -1,5 +1,4 @@
 import type {
-  Client,
   ChatInputCommandInteraction,
   PermissionsString,
   User,
@@ -294,7 +293,6 @@ export interface CommandConfig<T extends OptionsDef = OptionsDef> {
 }
 
 export type CommandExecute<T extends OptionsDef = OptionsDef> = (
-  client: Client,
   interaction: ChatInputCommandInteraction,
   context: CommandContext<T>
 ) => void
diff --git a/src/types/context-menus.ts b/src/types/context-menus.ts
@@ -1,6 +1,8 @@
 import type {
+  Message,
   MessageContextMenuCommandInteraction,
   PermissionsString,
+  User,
   UserContextMenuCommandInteraction
 } from 'discord.js'
 
@@ -9,7 +11,8 @@ export type ContextMenuType = 'Message' | 'User'
 export type ContextMenuCallback<T extends ContextMenuType = ContextMenuType> = (
   interaction: T extends 'Message'
     ? MessageContextMenuCommandInteraction
-    : UserContextMenuCommandInteraction
+    : UserContextMenuCommandInteraction,
+  target: T extends 'Message' ? Message : User
 ) => void
 
 export interface ContextMenuConfig<
@@ -24,10 +27,10 @@ export interface ContextMenuConfig<
 }
 
 export interface DefineContextMenu {
-  <T extends ContextMenuType = 'Message'>(
+  <T extends ContextMenuType = ContextMenuType>(
     callback: ContextMenuCallback<T>
   ): HarmonixContextMenu<T>
-  <T extends ContextMenuType = 'Message'>(
+  <T extends ContextMenuType = ContextMenuType>(
     config: ContextMenuConfig<T>,
     callback: ContextMenuCallback<T>
   ): HarmonixContextMenu<T>
diff --git a/src/types/harmonix.ts b/src/types/harmonix.ts
@@ -63,3 +63,7 @@ export interface Harmonix {
   selectMenus: Collection<string, HarmonixSelectMenu>
   preconditions: Collection<string, HarmonixPrecondition>
 }
+
+export interface RuntimeHarmonix extends Harmonix {
+  client: Client
+}
diff --git a/src/types/select-menus.ts b/src/types/select-menus.ts
@@ -18,15 +18,16 @@ export type SelectMenuType =
   | 'Mentionable'
 
 export type SelectMenuCallback<T extends SelectMenuType = SelectMenuType> = (
-  interaction: T extends 'String'
-    ? StringSelectMenuInteraction
-    : T extends 'User'
-      ? UserSelectMenuInteraction
-      : T extends 'Channel'
-        ? ChannelSelectMenuInteraction
-        : T extends 'Role'
-          ? RoleSelectMenuInteraction
-          : MentionableSelectMenuInteraction
+  interaction: T extends 'User'
+    ? UserSelectMenuInteraction
+    : T extends 'Channel'
+      ? ChannelSelectMenuInteraction
+      : T extends 'Role'
+        ? RoleSelectMenuInteraction
+        : T extends 'Mentionable'
+          ? MentionableSelectMenuInteraction
+          : StringSelectMenuInteraction,
+  selected: string[]
 ) => void
 
 interface StringOptionDef {
diff --git a/src/uses.ts b/src/uses.ts
diff --git a/src/utils.ts b/src/utils.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { defineCommand } from '../../src'`
	`1`	`+import { defineCommand, useActionRow, useButtons } from '../../src'`
`2`	`2`
`3`	`3`	`export default defineCommand(`
`4`	`4`	`{`
`@@ -24,13 +24,15 @@ export default defineCommand(`
`24`	`24`	`}`
`25`	`25`	`}`
`26`	`26`	`},`
`27`		`- (_, interaction, ctx) => {`
	`27`	`+ (interaction, ctx) => {`
`28`	`28`	`const { user, server } = ctx.options`
	`29`	`+ const { hello } = useButtons()`
	`30`	`+ const row = useActionRow(hello!, hello!)`
`29`	`31`
`30`	`32`	`if (user) {`
`31`		`- return interaction.reply('User info')`
	`33`	`+ return interaction.reply({ content: 'User info', components: [row] })`
`32`	`34`	`} else if (server) {`
`33`		`- return interaction.reply('Server info')`
	`35`	`+ return interaction.reply({ content: 'Server info', components: [row] })`
`34`	`36`	`}`
`35`	`37`	`}`
`36`	`38`	`)`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ export default defineCommand(`
`15`	`15`	`}`
`16`	`16`	`}`
`17`	`17`	`},`
`18`		`- (_, interaction, context) => {`
	`18`	`+ (interaction, context) => {`
`19`	`19`	`const { user, reason } = context.options`
`20`	`20`
`21`	`21`	interaction.reply(`Kicked user ${user} for ${reason}`)
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,12 @@`
`1`		`-import { defineCommand } from '../../../src'`
	`1`	`+import { defineCommand, useHarmonix } from '../../../src'`
`2`	`2`
`3`	`3`	`export default defineCommand(`
`4`	`4`	`{`
`5`	`5`	`description: 'Pong!'`
`6`	`6`	`},`
`7`		`- (client, interaction) => {`
	`7`	`+ (interaction) => {`
	`8`	`+ const { client } = useHarmonix()`
	`9`	`+`
`8`	`10`	interaction.reply(`Pong ${client.ws.ping}ms!`)
`9`	`11`	`}`
`10`	`12`	`)`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,13 @@`
`1`		`-import { defineCommand, getModal } from '../../../src'`
	`1`	`+import { defineCommand, useModals } from '../../../src'`
`2`	`2`
`3`	`3`	`export default defineCommand(`
`4`	`4`	`{`
`5`	`5`	`description: 'Test the bot',`
`6`	`6`	`preconditions: ['ownerOnly']`
`7`	`7`	`},`
`8`		`- async (_, interaction) => {`
`9`		`- const modal = getModal('form')`
	`8`	`+ async (interaction) => {`
	`9`	`+ const { form } = useModals()`
`10`	`10`
`11`		`- await interaction.showModal(modal!)`
	`11`	`+ await interaction.showModal(form!)`
`12`	`12`	`}`
`13`	`13`	`)`
Original file line number	Diff line number	Diff line change
`@@ -3,11 +3,10 @@ import { defineContextMenu } from '../../src'`
`3`	`3`	`export default defineContextMenu(`
`4`	`4`	`{`
`5`	`5`	`name: 'Get message author',`
	`6`	`+ type: 'Message',`
`6`	`7`	`preconditions: ['ownerOnly']`
`7`	`8`	`},`
`8`		`- (interaction) => {`
`9`		`- interaction.reply(`
`10`		- `This message has been sent by ${interaction.targetMessage.author}`
`11`		`- )`
	`9`	`+ async (interaction, target) => {`
	`10`	+ await interaction.reply(`This message has been sent by ${target.author}`)
`12`	`11`	`}`
`13`	`12`	`)`