feat: add button handling

Author: davidabou

src/define.ts

@@ -1,14 +1,18 @@
 import {
   ActionRowBuilder,
-  type ModalActionRowComponentBuilder,
   ModalBuilder,
   TextInputBuilder,
   EmbedBuilder,
   AttachmentBuilder,
-  type BufferResolvable
+  type BufferResolvable,
+  ButtonBuilder,
+  ButtonStyle,
+  type AnyComponentBuilder,
+  type RestOrArray
 } from 'discord.js'
 import type { Stream } from 'node:stream'
 import type {
+  ButtonOptions,
   CommandConfig,
   CommandExecute,
   ContextMenuCallback,
@@ -123,6 +127,16 @@ export const definePrecondition: DefinePrecondition &
   return { name, callback }
 }
 
+export const defineActionRow = <
+  T extends AnyComponentBuilder = AnyComponentBuilder
+>(
+  ...components: RestOrArray<T>
+): ActionRowBuilder<T> => {
+  const builder = new ActionRowBuilder<T>().addComponents(...components)
+
+  return builder
+}
+
 export const defineModal = (options: ModalOptions): ModalBuilder => {
   const builder = new ModalBuilder()
     .setCustomId(options.id)
@@ -150,10 +164,7 @@ export const defineModal = (options: ModalOptions): ModalBuilder => {
       if (input.required) {
         inputBuilder.setRequired(input.required)
       }
-      const row =
-        new ActionRowBuilder<ModalActionRowComponentBuilder>().addComponents(
-          inputBuilder
-        )
+      const row = defineActionRow(inputBuilder)
 
       builder.addComponents(row)
     }
@@ -189,3 +200,24 @@ export const defineEmbed = (options: EmbedOptions) => {
 export const defineAttachment = (args: BufferResolvable | Stream) => {
   return new AttachmentBuilder(args)
 }
+
+export const defineButton = (options: ButtonOptions) => {
+  const builder = new ButtonBuilder()
+    .setCustomId(options.id)
+    .setStyle(options.style ? ButtonStyle[options.style] : ButtonStyle.Primary)
+
+  if (options.label) {
+    builder.setLabel(options.label)
+  }
+  if (options.emoji) {
+    builder.setEmoji(options.emoji)
+  }
+  if (options.url) {
+    builder.setURL(options.url)
+  }
+  if (options.disabled) {
+    builder.setDisabled(options.disabled)
+  }
+
+  return builder
+}

src/register.ts

@@ -34,6 +34,17 @@ export const registerEvents = (harmonix: Harmonix) => {
       event.callback(interaction)
     })
   })
+  harmonix.client?.on(Events.InteractionCreate, (interaction) => {
+    if (!interaction.isButton()) return
+    const event = harmonix.events
+      .filter((evt) => evt.options.type === 'button')
+      .find((evt) => evt.options.name === interaction.customId)
+
+    if (!event) return
+    ctx.call(harmonix, () => {
+      event.callback(interaction)
+    })
+  })
 }
 
 export const registerCommands = (harmonix: Harmonix) => {

src/resolve.ts

@@ -30,9 +30,10 @@ export const resolveEvent = (
       name: event.options.name || filename(_evtPath).split('.')[0],
       once: event.options.once || filename(_evtPath).endsWith('.once'),
       type:
-        event.options.type || filename(dirname(_evtPath)) === 'modals'
-          ? 'modal'
-          : undefined
+        event.options.type ||
+        ((['modals', 'buttons'].includes(filename(dirname(_evtPath)))
+          ? filename(dirname(_evtPath)).slice(0, -1)
+          : undefined) as EventOptions['type'])
     }
 
     return { options, callback: event.callback }

src/types/events.ts

@@ -1,7 +1,12 @@
-import type { ClientEvents, ModalSubmitInteraction } from 'discord.js'
+import type {
+  ButtonInteraction,
+  ClientEvents,
+  ModalSubmitInteraction
+} from 'discord.js'
 
 export interface HarmonixEvents extends ClientEvents {
   modal: [interaction: ModalSubmitInteraction]
+  button: [interaction: ButtonInteraction]
 }
 
 export type EventCallback<Event extends keyof HarmonixEvents | any = any> = (
@@ -11,7 +16,7 @@ export type EventCallback<Event extends keyof HarmonixEvents | any = any> = (
 export interface EventOptions {
   name?: string
   once?: boolean
-  type?: 'modal'
+  type?: 'modal' | 'button'
 }
 
 export type DefineEvent = <Event extends keyof HarmonixEvents = any>(

src/types/rich.ts

@@ -1,9 +1,11 @@
-import {
-  type ColorResolvable,
-  type EmbedAuthorOptions,
-  type EmbedFooterOptions,
-  type APIEmbedField,
-  type TextInputStyle
+import type {
+  ColorResolvable,
+  EmbedAuthorOptions,
+  EmbedFooterOptions,
+  APIEmbedField,
+  TextInputStyle,
+  ButtonStyle,
+  ComponentEmojiResolvable
 } from 'discord.js'
 
 interface TextInput {
@@ -39,3 +41,12 @@ export interface EmbedOptions {
 export type EmbedSetters = {
   [K in keyof EmbedOptions]: (value: EmbedOptions[K]) => void
 }
+
+export interface ButtonOptions {
+  id: string
+  label?: string
+  style?: keyof typeof ButtonStyle
+  emoji?: ComponentEmojiResolvable
+  url?: string
+  disabled?: boolean
+}