feat: changed module options and added auto-defer option

Author: zojize

README.md

@@ -29,11 +29,16 @@ export default defineNuxtConfig({
   modules: ['nuxt-discord'],
   discord: {
     // Discord bot configuration
-    intents: ['Guilds'], // Discord gateway intents
+    client: {
+      intents: ['Guilds'], // Discord gateway intents
+      deferOnPromise: true, // Auto-defer interactions when command returns a promise
+    },
     dir: 'discord', // Directory for Discord-related files
     autoStart: true, // Auto-start the bot on server startup
     watch: {
       enabled: true, // Enable HMR for commands
+      port: 5720, // HMR server port
+      showURL: false, // Show HMR server URL in console
       sync: {
         debounce: 1000 // Sync delay in milliseconds
       }
@@ -209,15 +214,19 @@ export default (message: string) => {
 // nuxt.config.ts
 export default defineNuxtConfig({
   discord: {
-    intents: [
-      'Guilds',
-      'GuildMessages'
-    ],
+    client: {
+      intents: [
+        'Guilds',
+        'GuildMessages'
+      ],
+      deferOnPromise: true, // Auto-defer interactions when command returns a promise
+    },
     dir: 'discord',
     autoStart: true,
     watch: {
       enabled: true,
-      port: 4222,
+      port: 5720, // HMR server port
+      showURL: false, // Show HMR server URL in console
       sync: {
         debounce: 1000
       }

src/module.ts

@@ -16,12 +16,15 @@ export default defineNuxtModule<NuxtDiscordOptions>({
     configKey: 'discord',
   },
   defaults: {
-    intents: [GatewayIntentBits.Guilds],
+    client: {
+      intents: [GatewayIntentBits.Guilds],
+      deferOnPromise: true,
+    },
     dir: 'discord',
     autoStart: true,
     watch: {
       enabled: true,
-      port: 4222,
+      port: 5720,
       showURL: false,
       sync: {
         debounce: 1000, // milliseconds

src/runtime/server/plugins/discord.ts

@@ -1,4 +1,3 @@
-import type { ClientOptions } from 'discord.js'
 import type { WatchEvent } from 'nuxt/schema'
 import type { SlashCommand, SlashCommandRuntime } from '~/src/types'
 import { existsSync } from 'node:fs'
@@ -67,7 +66,6 @@ export default defineNitroPlugin(async (nitro) => {
   }
 
   if (runtimeConfig.discord.autoStart) {
-    const options: ClientOptions = { intents: runtimeConfig.discord.intents }
-    await client.start(options)
+    await client.start(runtimeConfig.discord.client)
   }
 })

src/runtime/server/utils/client.ts

@@ -1,5 +1,5 @@
-import type { APIApplicationCommand, APIApplicationCommandOption, ChatInputCommandInteraction, ClientOptions, RESTGetAPIApplicationCommandsResult, RESTPatchAPIApplicationCommandResult, RESTPutAPIApplicationCommandsResult } from 'discord.js'
-import type { SlashCommandOption, SlashCommandOptionType, SlashCommandReturnType, SlashCommandRuntime } from '~/src/types'
+import type { APIApplicationCommand, APIApplicationCommandOption, ChatInputCommandInteraction, RESTGetAPIApplicationCommandsResult, RESTPatchAPIApplicationCommandResult, RESTPutAPIApplicationCommandsResult } from 'discord.js'
+import type { NuxtDiscordOptions, SlashCommandOption, SlashCommandOptionType, SlashCommandReturnType, SlashCommandRuntime } from '~/src/types'
 import process from 'node:process'
 import { ApplicationCommandOptionType, Events, Client as InternalClient, REST, Routes, SlashCommandBuilder } from 'discord.js'
 import { useNitroApp } from 'nitropack/runtime'
@@ -76,9 +76,11 @@ export class DiscordClient {
     })
   }
 
-  public async start(options: ClientOptions): Promise<undefined> {
-    await this.#nitro.hooks.callHook('discord:client:config', options)
-    this.#client = new InternalClient(options)
+  #clientOptions?: NuxtDiscordOptions['client']
+  public async start(options: NuxtDiscordOptions['client']): Promise<undefined> {
+    this.#clientOptions = { ...options }
+    await this.#nitro.hooks.callHook('discord:client:config', this.#clientOptions)
+    this.#client = new InternalClient(this.#clientOptions)
     this.#client.on(Events.InteractionCreate, (interaction) => {
       if (!interaction.isChatInputCommand())
         return
@@ -205,9 +207,14 @@ export class DiscordClient {
 
     try {
       currentInteraction = interaction
-      const result = await command.execute!(...args)
+      const result = command.execute!(...args)
       currentInteraction = null
-      this.#handleSlashCommandReturn(result, interaction, command)
+
+      if (this.#clientOptions?.deferOnPromise && isPromise(result)) {
+        await interaction.deferReply()
+      }
+
+      await this.#handleSlashCommandReturn(result, interaction, command)
     }
     catch (error) {
       this.#nitro.hooks.callHook('discord:client:error', {
@@ -222,11 +229,14 @@ export class DiscordClient {
 
   async #handleSlashCommandReturn(
     // not sure why Awaited<SlashCommandReturnType> does't work here
-    result: Exclude<SlashCommandReturnType, Promise<SlashCommandReturnType>>,
+    result: SlashCommandReturnType,
     interaction: ChatInputCommandInteraction,
     command: SlashCommandRuntime,
     // TODO: type this
   ): Promise<unknown> {
+    // @ts-expect-error - i don't know why this error occurs
+    result = await result
+
     if (!result) {
       return
     }
@@ -237,7 +247,7 @@ export class DiscordClient {
       }
       else if (typeof result === 'function') {
         const newResult = result.call(this, interaction, this)
-        return this.#handleSlashCommandReturn(await newResult, interaction, command)
+        return this.#handleSlashCommandReturn(newResult, interaction, command)
       }
       else if (Symbol.iterator in result && typeof result[Symbol.iterator] === 'function') {
         const gen = result[Symbol.iterator]()
@@ -532,3 +542,8 @@ function optionEqual(a: SlashCommandOption, b: APIApplicationCommandOption): boo
 
   return true
 }
+
+// https://stackoverflow.com/a/53955664/14835397
+export function isPromise(value: any): value is Promise<unknown> {
+  return typeof value?.then === 'function'
+}

src/types.ts

@@ -6,13 +6,21 @@ import { ApplicationCommandOptionType } from 'discord.js'
 
 export interface NuxtDiscordOptions {
   /**
-   * The intents to use for the Discord client. Use
-   * the 'nitro:client:config' hook to configure other
-   * options passed to the Discord client.
+   * Options passed to the internal Discord client.
+   * Use the 'nitro:client:config' hook to configure
+   * client options in runtime.
    *
-   * @default [GatewayIntentBits.Guilds]
+   * @default { intents: [GatewayIntentBits.Guilds] }
    */
-  intents: ClientOptions['intents']
+  client: ClientOptions & {
+    /**
+     * Whether to automatically defer the interaction reply
+     * on slash command execution if the command returns a promise.
+     *
+     * @default true
+     */
+    deferOnPromise?: boolean
+  }
 
   /**
    * The directory to scan for nuxt-discord related
@@ -32,35 +40,32 @@ export interface NuxtDiscordOptions {
   /**
    * HMR options
    */
-  watch:
-    & {
+  watch: Partial<ListenOptions> & {
+    /**
+     * Enable or disable HMR for slash commands.
+     *
+     * @default true
+     */
+    enabled?: boolean
+
+    /**
+     * Whether to automatically register and update
+     * slash commands on the Discord client.
+     */
+    sync?: false | {
       /**
-       * Enable or disable HMR for slash commands.
+       * Milliseconds to debounce before updating
+       * on HMR events.
        *
-       * @default true
+       * @default 1000
        */
-      enabled?: boolean
+      debounce?: number
     }
-    & {
-      /**
-       * Whether to automatically register and update
-       * slash commands on the Discord client.
-       */
-      sync?: false | {
-        /**
-         * Milliseconds to debounce before updating
-         * on HMR events.
-         *
-         * @default 1000
-         */
-        debounce?: number
-      }
-    }
-    & Partial<ListenOptions>
+  }
 }
 
 export interface DiscordRuntimeConfig {
-  intents: ClientOptions['intents']
+  client: NuxtDiscordOptions['client']
   autoStart: boolean
   sync: NuxtDiscordOptions['watch']['sync']
   dir: string

src/utils/runtimeConfig.ts

@@ -4,7 +4,7 @@ export function prepareRuntimeConfig(ctx: NuxtDiscordContext) {
   ctx.nuxt.hook('nitro:config', (config) => {
     config.runtimeConfig ??= {}
     config.runtimeConfig.discord ??= {}
-    config.runtimeConfig.discord.intents = ctx.options.intents
+    config.runtimeConfig.discord.client = ctx.options.client
     config.runtimeConfig.discord.autoStart = ctx.options.autoStart
     config.runtimeConfig.discord.sync = ctx.options.watch.sync ?? false
     config.runtimeConfig.discord.dir = ctx.resolve.root(ctx.options.dir)

src/utils/templates.ts

@@ -28,7 +28,7 @@ type integer = import('nuxt-discord').integer
 declare global {
   declare module 'nitropack/types' {
     interface NitroRuntimeHooks {
-      'discord:client:config': (options: import('discord.js').ClientOptions) => void
+      'discord:client:config': (options: import('nuxt-discord').NuxtDiscordOptions['client']) => void
       'discord:client:ready': (client: DiscordClient) => void
       'discord:client:error': (error: DiscordClientError) => void
     }