chore: prettier

Author: twlite

apps/test-bot/src/commands/misc/confirmation.tsx

@@ -12,18 +12,22 @@ export const data: CommandData = {
   description: 'This is a confirm command.',
 };
 
-const handleConfirm: OnButtonKitClick = async (interaction) => {
+const handleConfirm: OnButtonKitClick = async (interaction, context) => {
   await interaction.reply({
     content: 'The item was deleted successfully.',
     flags: MessageFlags.Ephemeral,
   });
+
+  context.dispose();
 };
 
-const handleCancel: OnButtonKitClick = async (interaction) => {
+const handleCancel: OnButtonKitClick = async (interaction, context) => {
   await interaction.reply({
     content: 'The item was not deleted.',
     flags: MessageFlags.Ephemeral,
   });
+
+  context.dispose();
 };
 
 export async function run({ interaction }: SlashCommandProps) {

apps/test-bot/src/commands/misc/prompt.tsx

@@ -13,14 +13,16 @@ export const data: CommandData = {
   description: 'This is a prompt command.',
 };
 
-const handleSubmit: OnModalKitSubmit = async (interaction) => {
+const handleSubmit: OnModalKitSubmit = async (interaction, context) => {
   const name = interaction.fields.getTextInputValue('name');
   const description = interaction.fields.getTextInputValue('description');
 
   await interaction.reply({
     content: `Name: ${name}\nDescription: ${description}`,
     flags: MessageFlags.Ephemeral,
   });
+
+  context.dispose();
 };
 
 export async function run({ interaction }: SlashCommandProps) {

packages/commandkit/package.json

@@ -48,17 +48,17 @@
     "@types/ms": "^0.7.34",
     "@types/node": "^22.10.2",
     "@types/yargs": "^17.0.32",
-    "discord.js": "^14.16.3",
+    "discord.js": "^14.17.3",
     "tsconfig": "workspace:*",
-    "tsx": "^4.7.0",
-    "typescript": "^5.7.2",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.3",
     "use-macro": "^1.1.0",
-    "vitest": "^1.2.1"
+    "vitest": "^3.0.5"
   },
   "peerDependencies": {
     "discord.js": "^14"
   },
   "engines": {
     "node": ">=22"
   }
-}
+}

packages/commandkit/src/CommandKit.ts

@@ -1,5 +1,9 @@
 import EventEmitter from 'node:events';
-import { CommandHandler, EventHandler, ValidationHandler } from './handlers';
+import {
+  CommandHandler,
+  EventHandler,
+  ValidationHandler,
+} from './legacy/handlers';
 import type {
   CommandKitData,
   CommandKitOptions,

packages/commandkit/src/cli/common.ts

@@ -111,7 +111,7 @@ async function loadConfigInner(target: string) {
    */
   // @ts-ignore
   const config = await import(`file://${target}`, {
-    assert: isJSON ? { type: 'json' } : undefined,
+    with: isJSON ? { type: 'json' } : undefined,
   }).then((conf) => conf.default || conf);
 
   return config;

packages/commandkit/src/components/button/Button.ts

@@ -7,6 +7,7 @@ import {
 } from './ButtonKit';
 import { CommandKitElement } from '../common/element';
 import { MaybeArray } from '../common/types';
+import { EventInterceptorErrorHandler } from '../common/EventInterceptor';
 
 export type ButtonChildrenLike = string | number | boolean;
 
@@ -19,6 +20,7 @@ export interface ButtonProps {
   url?: string;
   skuId?: string;
   onClick?: CommandKitButtonBuilderInteractionCollectorDispatch;
+  onError?: EventInterceptorErrorHandler;
   options?: CommandKitButtonBuilderInteractionCollectorDispatchContextData;
   onEnd?: CommandKitButtonBuilderOnEnd;
   children?: MaybeArray<ButtonChildrenLike>;
@@ -84,5 +86,9 @@ export function Button(props: ButtonProps): CommandKitElement<'button-kit'> {
     button.onEnd(props.onEnd);
   }
 
+  if (props.onError) {
+    button.onError(props.onError);
+  }
+
   return button;
 }

packages/commandkit/src/components/button/ButtonKit.ts

@@ -10,7 +10,10 @@ import {
   getCommandKit,
   getContext,
 } from '../../context/async-context';
-import { EventInterceptorContextData } from '../common/EventInterceptor';
+import {
+  EventInterceptorContextData,
+  EventInterceptorErrorHandler,
+} from '../common/EventInterceptor';
 
 export type ButtonKitPredicate = (
   interaction: ButtonInteraction,
@@ -35,6 +38,7 @@ export type OnButtonKitEnd = CommandKitButtonBuilderOnEnd;
  */
 export type CommandKitButtonBuilderInteractionCollectorDispatch = (
   interaction: ButtonInteraction,
+  context: ButtonKit,
 ) => Awaitable<void>;
 
 export type CommandKitButtonBuilderOnEnd = (reason: string) => Awaitable<void>;
@@ -49,6 +53,7 @@ export class ButtonKit extends ButtonBuilder {
     {
       autoReset: true,
       time: 5 * 60 * 1000,
+      once: false,
     };
   #unsub: (() => void) | null = null;
 
@@ -134,6 +139,24 @@ export class ButtonKit extends ButtonBuilder {
     return this;
   }
 
+  /**
+   * Sets the handler to run when the interaction collector ends.
+   * @param handler - The handler to run when the interaction collector ends.
+   * @returns This instance of the modal builder.
+   */
+  public onError(handler: EventInterceptorErrorHandler): this {
+    if (!handler) {
+      throw new TypeError(
+        'Cannot setup "onError" without a handler function parameter.',
+      );
+    }
+
+    this.#contextData ??= {};
+    this.#contextData.onError = handler;
+
+    return this;
+  }
+
   /**
    * Sets a filter for the interaction collector.
    * @param predicate The filter to use for the interaction collector
@@ -190,7 +213,7 @@ export class ButtonKit extends ButtonBuilder {
 
         if (!handler) return this.#unsub?.();
 
-        return handler(interaction);
+        return handler(interaction, this);
       },
       this.#contextData,
     );

packages/commandkit/src/components/common/EventInterceptor.ts

@@ -1,4 +1,4 @@
-import { Awaitable, Client, ClientEvents } from 'discord.js';
+import { Awaitable, Client, ClientEvents, Events } from 'discord.js';
 
 export interface EventInterceptorContextData<E extends keyof ClientEvents> {
   /**
@@ -13,12 +13,22 @@ export interface EventInterceptorContextData<E extends keyof ClientEvents> {
    * If the collector should automatically reset the timer when a button is clicked.
    */
   autoReset?: boolean;
+  /**
+   * Whether the collector should run only once.
+   */
+  once?: boolean;
   /**
    * The handler to run when the collector ends.
    */
   onEnd?: (reason: string) => Awaitable<void>;
+  /**
+   * The handler to run upon an error.
+   */
+  onError?: EventInterceptorErrorHandler;
 }
 
+export type EventInterceptorErrorHandler = (error: Error) => Awaitable<void>;
+
 export class EventInterceptor {
   private subscribers = new Map<
     keyof ClientEvents,
@@ -205,7 +215,19 @@ export class EventInterceptor {
             continue;
           }
 
-          await subscriber(...args);
+          try {
+            await subscriber(...args);
+          } catch (e) {
+            if (options.onError) {
+              await options.onError(<Error>e);
+            } else {
+              throw e;
+            }
+          } finally {
+            if (options.once) {
+              this.unsubscribe(event, subscriber, 'once');
+            }
+          }
         }
       }
     };

packages/commandkit/src/components/modal/Modal.ts

@@ -7,13 +7,15 @@ import {
   OnModalKitEnd,
   OnModalKitSubmit,
 } from './ModalKit';
+import { EventInterceptorErrorHandler } from '../common/EventInterceptor';
 
 export interface ModalProps {
   customId?: string;
   title: string;
   children?: MaybeArray<TextInputBuilder | ActionRowBuilder>;
   onSubmit?: OnModalKitSubmit;
   onEnd?: OnModalKitEnd;
+  onError?: EventInterceptorErrorHandler;
   options?: CommandKitModalBuilderInteractionCollectorDispatchContextData;
 }
 
@@ -60,6 +62,10 @@ export function Modal(props: ModalProps): CommandKitElement<'modal'> {
     modal.onEnd(props.onEnd);
   }
 
+  if (props.onError) {
+    modal.onError(props.onError);
+  }
+
   return modal;
 }
 

packages/commandkit/src/components/modal/ModalKit.ts

@@ -9,7 +9,10 @@ import {
   getCommandKit,
   getContext,
 } from '../../context/async-context';
-import { EventInterceptorContextData } from '../common/EventInterceptor';
+import {
+  EventInterceptorContextData,
+  EventInterceptorErrorHandler,
+} from '../common/EventInterceptor';
 
 export type ModalKitPredicate = (
   interaction: ModalSubmitInteraction,
@@ -34,6 +37,7 @@ export type OnModalKitEnd = CommandKitModalBuilderOnEnd;
  */
 export type CommandKitModalBuilderInteractionCollectorDispatch = (
   interaction: ModalSubmitInteraction,
+  context: ModalKit,
 ) => Awaitable<void>;
 
 export type CommandKitModalBuilderOnEnd = (reason: string) => Awaitable<void>;
@@ -46,8 +50,9 @@ export class ModalKit extends ModalBuilder {
     null;
   #contextData: CommandKitModalBuilderInteractionCollectorDispatchContextData | null =
     {
-      autoReset: true,
+      autoReset: false,
       time: 5 * 60 * 1000,
+      once: true,
     };
   #unsub: (() => void) | null = null;
 
@@ -123,6 +128,24 @@ export class ModalKit extends ModalBuilder {
     return this;
   }
 
+  /**
+   * Sets the handler to run when the interaction collector ends.
+   * @param handler - The handler to run when the interaction collector ends.
+   * @returns This instance of the modal builder.
+   */
+  public onError(handler: EventInterceptorErrorHandler): this {
+    if (!handler) {
+      throw new TypeError(
+        'Cannot setup "onError" without a handler function parameter.',
+      );
+    }
+
+    this.#contextData ??= {};
+    this.#contextData.onError = handler;
+
+    return this;
+  }
+
   /**
    * Sets a filter for the interaction collector.
    * @param predicate - The filter to use for the interaction collector.
@@ -174,7 +197,7 @@ export class ModalKit extends ModalBuilder {
 
         if (!handler) return this.#unsub?.();
 
-        return handler(interaction);
+        return handler(interaction, this);
       },
       this.#contextData,
     );