feat: add context to defineModal callback

Author: davidabou

src/define.ts

@@ -9,7 +9,6 @@ import type {
   DefineContextMenuWithOptions,
   DefineEvent,
   DefineEventWithOptions,
-  DefineModal,
   DefinePrecondition,
   DefinePreconditionWithName,
   DefineSelectMenu,
@@ -19,6 +18,10 @@ import type {
   HarmonixConfig,
   HarmonixContextMenu,
   HarmonixEvent,
+  HarmonixModal,
+  ModalCallback,
+  ModalConfig,
+  ModalInputs,
   OptionsDef,
   PreconditionCallback
 } from './types'
@@ -96,7 +99,10 @@ export const defineButton: DefineButton = (config, callback) => {
   return { config, callback }
 }
 
-export const defineModal: DefineModal = (config, callback) => {
+export const defineModal = <T extends ModalInputs = ModalInputs>(
+  config: ModalConfig & { inputs?: T },
+  callback: ModalCallback<T>
+): HarmonixModal<T> => {
   return { config, callback }
 }
 

src/gets.ts

@@ -57,10 +57,11 @@ export const getModal = (id: string) => {
     .setCustomId(modal.config.id!)
     .setTitle(modal.config.title)
 
-  if (modal.config.textInputs) {
-    for (const input of modal.config.textInputs) {
+  if (modal.config.inputs) {
+    for (const id in modal.config.inputs) {
+      const input = modal.config.inputs[id]
       const inputBuilder = new TextInputBuilder()
-        .setCustomId(input.id)
+        .setCustomId(id)
         .setLabel(input.label)
         .setStyle(
           input.style ? TextInputStyle[input.style] : TextInputStyle.Short

src/register.ts

@@ -3,7 +3,7 @@ import consola from 'consola'
 import { colors } from 'consola/utils'
 import { toOption, resolveOption } from './utils'
 import { ctx } from './harmonix'
-import type { Harmonix, ParsedOptions } from './types'
+import { ParsedInputs, type Harmonix, type ParsedOptions } from './types'
 
 export const registerEvents = (harmonix: Harmonix) => {
   for (const [, event] of harmonix.events.filter((evt) => !evt.options.type)) {
@@ -117,14 +117,22 @@ export const registerButtons = (harmonix: Harmonix) => {
 }
 
 export const registerModals = (harmonix: Harmonix) => {
-  harmonix.client?.on(Events.InteractionCreate, (interaction) => {
+  harmonix.client?.on(Events.InteractionCreate, async (interaction) => {
     if (!interaction.isModalSubmit()) return
     const mdl = harmonix.modals.find(
       (mdl) => mdl.config.id === interaction.customId
     )
 
     if (!mdl) return
-    mdl.callback(interaction)
+    const inputs = Object.keys(mdl.config.inputs ?? {}).reduce<ParsedInputs>(
+      (acc, input) => ({
+        ...acc,
+        [input]: interaction.fields.getTextInputValue(input)
+      }),
+      {}
+    )
+
+    mdl.callback(interaction, { inputs })
   })
 }
 

src/types/modals.ts

@@ -1,9 +1,6 @@
 import type { ModalSubmitInteraction, TextInputStyle } from 'discord.js'
 
-type ModalCallback = (interaction: ModalSubmitInteraction) => void
-
 interface TextInput {
-  id: string
   label: string
   style: keyof typeof TextInputStyle
   maxLength?: number
@@ -13,20 +10,31 @@ interface TextInput {
   required?: boolean
 }
 
-export interface ModalConfig {
+export type ModalInputs = Record<string, TextInput>
+
+export interface ModalConfig<T extends ModalInputs = ModalInputs> {
   id?: string
   title: string
-  textInputs?: TextInput[]
+  inputs?: T
+}
+
+export type ParsedInputs<T extends ModalInputs = ModalInputs> = Record<
+  { [K in keyof T]: K }[keyof T],
+  string
+>
+
+interface ModalContext<T extends ModalInputs = ModalInputs> {
+  inputs: ParsedInputs<T>
 }
 
-export type DefineModal = (
-  config: ModalConfig,
-  callback: ModalCallback
-) => HarmonixModal
+export type ModalCallback<T extends ModalInputs = ModalInputs> = (
+  interaction: ModalSubmitInteraction,
+  context: ModalContext<T>
+) => void
 
 export type HarmonixModalInput = string | HarmonixModal
 
-export interface HarmonixModal {
-  config: ModalConfig
-  callback: ModalCallback
+export interface HarmonixModal<T extends ModalInputs = ModalInputs> {
+  config: ModalConfig<T>
+  callback: ModalCallback<T>
 }