commandkit 0.1.8 → 0.1.9-dev.20231213080753

package/dist/index.d.mts

@@ -66,7 +66,7 @@ interface CommandProps {
 /**
  * Props for autocomplete command run functions.
  */
-interface AutocompleteCommandProps extends CommandProps {
+interface AutocompleteProps extends CommandProps {
     /**
      * The current autocomplete command interaction object.
      */
@@ -105,11 +105,11 @@ interface MessageContextMenuCommandProps extends CommandProps {
 /**
  * Props for command validation functions.
  */
-interface ValidationFunctionProps {
+interface ValidationProps {
     /**
      * The current command interaction object.
      */
-    interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction;
+    interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction | AutocompleteInteraction;
     /**
      * The Discord.js client object that CommandKit is handling.
      */
@@ -257,7 +257,8 @@ declare class CommandKit {
  * The handler to run when a button is clicked. This handler is called with the interaction as the first argument.
  * If the first argument is null, it means that the interaction collector has been destroyed.
  */
-type CommandKitButtonBuilderInteractionCollectorDispatch = (interaction: ButtonInteraction | null) => Awaitable<void>;
+type CommandKitButtonBuilderInteractionCollectorDispatch = (interaction: ButtonInteraction) => Awaitable<void>;
+type CommandKitButtonBuilderOnEnd = () => Awaitable<void>;
 type CommandKitButtonBuilderInteractionCollectorDispatchContextData = {
     /**
      * The message to listen for button interactions on.
@@ -299,8 +300,8 @@ declare class ButtonKit extends ButtonBuilder {
      * button.onClick(null);
      * ```
      */
-    onClick(handler: null): this;
-    onClick(handler: CommandKitButtonBuilderInteractionCollectorDispatch, data: CommandKitButtonBuilderInteractionCollectorDispatchContextData): this;
+    onClick(handler: CommandKitButtonBuilderInteractionCollectorDispatch, data?: CommandKitButtonBuilderInteractionCollectorDispatchContextData): this;
+    onEnd(handler: CommandKitButtonBuilderOnEnd): this;
 }
 
 interface CommandKitConfig {
@@ -375,4 +376,4 @@ declare function createSignal<T = unknown>(value?: CommandKitSignalInitializer<T
  */
 declare function createEffect(callback: CommandKitEffectCallback): void;
 
-export { AutocompleteCommandProps, ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitConfig, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, ContextMenuCommandProps, MessageContextMenuCommandProps, ReloadType, SlashCommandProps, UserContextMenuCommandProps, ValidationFunctionProps, createEffect, createSignal, defineConfig, getConfig };
+export { AutocompleteProps, ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitButtonBuilderOnEnd, CommandKitConfig, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, ContextMenuCommandProps, MessageContextMenuCommandProps, ReloadType, SlashCommandProps, UserContextMenuCommandProps, ValidationProps, createEffect, createSignal, defineConfig, getConfig };

package/dist/index.d.ts

@@ -66,7 +66,7 @@ interface CommandProps {
 /**
  * Props for autocomplete command run functions.
  */
-interface AutocompleteCommandProps extends CommandProps {
+interface AutocompleteProps extends CommandProps {
     /**
      * The current autocomplete command interaction object.
      */
@@ -105,11 +105,11 @@ interface MessageContextMenuCommandProps extends CommandProps {
 /**
  * Props for command validation functions.
  */
-interface ValidationFunctionProps {
+interface ValidationProps {
     /**
      * The current command interaction object.
      */
-    interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction;
+    interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction | AutocompleteInteraction;
     /**
      * The Discord.js client object that CommandKit is handling.
      */
@@ -257,7 +257,8 @@ declare class CommandKit {
  * The handler to run when a button is clicked. This handler is called with the interaction as the first argument.
  * If the first argument is null, it means that the interaction collector has been destroyed.
  */
-type CommandKitButtonBuilderInteractionCollectorDispatch = (interaction: ButtonInteraction | null) => Awaitable<void>;
+type CommandKitButtonBuilderInteractionCollectorDispatch = (interaction: ButtonInteraction) => Awaitable<void>;
+type CommandKitButtonBuilderOnEnd = () => Awaitable<void>;
 type CommandKitButtonBuilderInteractionCollectorDispatchContextData = {
     /**
      * The message to listen for button interactions on.
@@ -299,8 +300,8 @@ declare class ButtonKit extends ButtonBuilder {
      * button.onClick(null);
      * ```
      */
-    onClick(handler: null): this;
-    onClick(handler: CommandKitButtonBuilderInteractionCollectorDispatch, data: CommandKitButtonBuilderInteractionCollectorDispatchContextData): this;
+    onClick(handler: CommandKitButtonBuilderInteractionCollectorDispatch, data?: CommandKitButtonBuilderInteractionCollectorDispatchContextData): this;
+    onEnd(handler: CommandKitButtonBuilderOnEnd): this;
 }
 
 interface CommandKitConfig {
@@ -375,4 +376,4 @@ declare function createSignal<T = unknown>(value?: CommandKitSignalInitializer<T
  */
 declare function createEffect(callback: CommandKitEffectCallback): void;
 
-export { AutocompleteCommandProps, ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitConfig, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, ContextMenuCommandProps, MessageContextMenuCommandProps, ReloadType, SlashCommandProps, UserContextMenuCommandProps, ValidationFunctionProps, createEffect, createSignal, defineConfig, getConfig };
+export { AutocompleteProps, ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitButtonBuilderOnEnd, CommandKitConfig, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, ContextMenuCommandProps, MessageContextMenuCommandProps, ReloadType, SlashCommandProps, UserContextMenuCommandProps, ValidationProps, createEffect, createSignal, defineConfig, getConfig };

package/dist/index.js

@@ -594,8 +594,8 @@ var CommandHandler = class {
       );
       if (!targetCommand)
         return;
-      const { data, options, run, autocompleteRun, ...rest } = targetCommand;
-      if (isAutocomplete && !autocompleteRun)
+      const { data, options, run, autocomplete, ...rest } = targetCommand;
+      if (isAutocomplete && !autocomplete)
         return;
       const commandObj = {
         data: targetCommand.data,
@@ -640,7 +640,7 @@ var CommandHandler = class {
         client: this.#data.client,
         handler: this.#data.commandkitInstance
       };
-      await targetCommand[isAutocomplete ? "autocompleteRun" : "run"](context2);
+      await targetCommand[isAutocomplete ? "autocomplete" : "run"](context2);
     });
   }
   get commands() {
@@ -896,7 +896,7 @@ var CommandKit = class {
       return [];
     }
     const commands = this.#data.commandHandler.commands.map((cmd) => {
-      const { run, ...command } = cmd;
+      const { run, autocomplete, ...command } = cmd;
       return command;
     });
     return commands;
@@ -943,19 +943,55 @@ var CommandKit = class {
 var import_discord2 = require("discord.js");
 var ButtonKit = class extends import_discord2.ButtonBuilder {
   #onClickHandler = null;
+  #onEndHandler = null;
   #contextData = null;
   #collector = null;
+  /**
+   * Sets up an inline interaction collector for this button. This collector by default allows as many interactions as possible if it is actively used.
+   * If unused, this expires after 24 hours or custom time if specified.
+   * @param handler The handler to run when the button is clicked
+   * @param data The context data to use for the interaction collector
+   * @returns This button
+   * @example
+   * ```ts
+   * const button = new ButtonKit()
+   *   .setLabel('Click me')
+   *   .setStyle(ButtonStyle.Primary)
+   *   .setCustomId('click_me');
+   *
+   * const row = new ActionRowBuilder().addComponents(button);
+   *
+   * const message = await channel.send({ content: 'Click the button', components: [row] });
+   *
+   * button.onClick(async (interaction) => {
+   *   await interaction.reply('You clicked me!');
+   * }, { message });
+   *
+   * // Remove onClick handler and destroy the interaction collector
+   * button.onClick(null);
+   * ```
+   */
   onClick(handler, data) {
     if (this.data.style === import_discord2.ButtonStyle.Link) {
       throw new TypeError('Cannot setup "onClick" handler on link buttons.');
     }
+    if (!handler) {
+      throw new TypeError('Cannot setup "onClick" without a handler function parameter.');
+    }
     this.#destroyCollector();
     this.#onClickHandler = handler;
-    if (handler && data)
+    if (data)
       this.#contextData = data;
     this.#setupInteractionCollector();
     return this;
   }
+  onEnd(handler) {
+    if (!handler) {
+      throw new TypeError('Cannot setup "onEnd" without a handler function parameter.');
+    }
+    this.#onEndHandler = handler;
+    return this;
+  }
   #setupInteractionCollector() {
     if (!this.#contextData || !this.#onClickHandler)
       return;
@@ -992,10 +1028,10 @@ var ButtonKit = class extends import_discord2.ButtonBuilder {
     });
     this.#collector.on("end", () => {
       this.#destroyCollector();
+      this.#onEndHandler?.();
     });
   }
   #destroyCollector() {
-    this.#onClickHandler?.(null);
     this.#collector?.stop("end");
     this.#collector?.removeAllListeners();
     this.#collector = null;

package/dist/index.mjs

@@ -561,8 +561,8 @@ var CommandHandler = class {
       );
       if (!targetCommand)
         return;
-      const { data, options, run, autocompleteRun, ...rest } = targetCommand;
-      if (isAutocomplete && !autocompleteRun)
+      const { data, options, run, autocomplete, ...rest } = targetCommand;
+      if (isAutocomplete && !autocomplete)
         return;
       const commandObj = {
         data: targetCommand.data,
@@ -607,7 +607,7 @@ var CommandHandler = class {
         client: this.#data.client,
         handler: this.#data.commandkitInstance
       };
-      await targetCommand[isAutocomplete ? "autocompleteRun" : "run"](context2);
+      await targetCommand[isAutocomplete ? "autocomplete" : "run"](context2);
     });
   }
   get commands() {
@@ -863,7 +863,7 @@ var CommandKit = class {
       return [];
     }
     const commands = this.#data.commandHandler.commands.map((cmd) => {
-      const { run, ...command } = cmd;
+      const { run, autocomplete, ...command } = cmd;
       return command;
     });
     return commands;
@@ -914,19 +914,55 @@ import {
 } from "discord.js";
 var ButtonKit = class extends ButtonBuilder {
   #onClickHandler = null;
+  #onEndHandler = null;
   #contextData = null;
   #collector = null;
+  /**
+   * Sets up an inline interaction collector for this button. This collector by default allows as many interactions as possible if it is actively used.
+   * If unused, this expires after 24 hours or custom time if specified.
+   * @param handler The handler to run when the button is clicked
+   * @param data The context data to use for the interaction collector
+   * @returns This button
+   * @example
+   * ```ts
+   * const button = new ButtonKit()
+   *   .setLabel('Click me')
+   *   .setStyle(ButtonStyle.Primary)
+   *   .setCustomId('click_me');
+   *
+   * const row = new ActionRowBuilder().addComponents(button);
+   *
+   * const message = await channel.send({ content: 'Click the button', components: [row] });
+   *
+   * button.onClick(async (interaction) => {
+   *   await interaction.reply('You clicked me!');
+   * }, { message });
+   *
+   * // Remove onClick handler and destroy the interaction collector
+   * button.onClick(null);
+   * ```
+   */
   onClick(handler, data) {
     if (this.data.style === ButtonStyle.Link) {
       throw new TypeError('Cannot setup "onClick" handler on link buttons.');
     }
+    if (!handler) {
+      throw new TypeError('Cannot setup "onClick" without a handler function parameter.');
+    }
     this.#destroyCollector();
     this.#onClickHandler = handler;
-    if (handler && data)
+    if (data)
       this.#contextData = data;
     this.#setupInteractionCollector();
     return this;
   }
+  onEnd(handler) {
+    if (!handler) {
+      throw new TypeError('Cannot setup "onEnd" without a handler function parameter.');
+    }
+    this.#onEndHandler = handler;
+    return this;
+  }
   #setupInteractionCollector() {
     if (!this.#contextData || !this.#onClickHandler)
       return;
@@ -963,10 +999,10 @@ var ButtonKit = class extends ButtonBuilder {
     });
     this.#collector.on("end", () => {
       this.#destroyCollector();
+      this.#onEndHandler?.();
     });
   }
   #destroyCollector() {
-    this.#onClickHandler?.(null);
     this.#collector?.stop("end");
     this.#collector?.removeAllListeners();
     this.#collector = null;

package/package.json

@@ -1,58 +1,58 @@
 {
-    "name": "commandkit",
-    "description": "Beginner friendly command & event handler for Discord.js",
-    "version": "0.1.8",
-    "license": "MIT",
-    "main": "./dist/index.js",
-    "module": "./dist/index.mjs",
-    "types": "./dist/index.d.ts",
-    "bin": "./bin/index.mjs",
-    "exports": {
-        ".": {
-            "require": "./dist/index.js",
-            "import": "./dist/index.mjs",
-            "types": "./dist/index.d.ts"
-        }
-    },
-    "files": [
-        "dist",
-        "bin"
-    ],
-    "scripts": {
-        "lint": "tsc",
-        "dev": "tsup --watch",
-        "build": "tsup",
-        "deploy": "npm publish",
-        "deploy-dev": "npm publish --access public --tag dev",
-        "test": "cd ./tests && node ../bin/index.mjs dev",
-        "test:build": "cd ./tests && node ../bin/index.mjs build",
-        "test:prod": "cd ./tests && node ../bin/index.mjs start"
-    },
-    "repository": {
-        "url": "git+https://github.com/underctrl-io/commandkit.git"
-    },
-    "homepage": "https://commandkit.js.org",
-    "keywords": [
-        "discord.js",
-        "command handler",
-        "event handler"
-    ],
-    "dependencies": {
-        "commander": "^11.1.0",
-        "dotenv": "^16.3.1",
-        "ora": "^7.0.1",
-        "rfdc": "^1.3.0",
-        "rimraf": "^5.0.5",
-        "tsup": "^7.2.0"
-    },
-    "devDependencies": {
-        "@types/node": "^20.5.9",
-        "discord.js": "^14.13.0",
-        "tsconfig": "workspace:*",
-        "tsx": "^3.12.8",
-        "typescript": "^5.1.6"
-    },
-    "peerDependencies": {
-        "discord.js": "^14"
+  "name": "commandkit",
+  "description": "Beginner friendly command & event handler for Discord.js",
+  "version": "0.1.9-dev.20231213080753",
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "bin": "./bin/index.mjs",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
     }
-}
+  },
+  "files": [
+    "dist",
+    "bin"
+  ],
+  "scripts": {
+    "lint": "tsc",
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "deploy": "npm publish",
+    "deploy-dev": "npm publish --access public --tag dev",
+    "test": "cd ./tests && node ../bin/index.mjs dev",
+    "test:build": "cd ./tests && node ../bin/index.mjs build",
+    "test:prod": "cd ./tests && node ../bin/index.mjs start"
+  },
+  "repository": {
+    "url": "git+https://github.com/underctrl-io/commandkit.git"
+  },
+  "homepage": "https://commandkit.js.org",
+  "keywords": [
+    "discord.js",
+    "command handler",
+    "event handler"
+  ],
+  "dependencies": {
+    "commander": "^11.1.0",
+    "dotenv": "^16.3.1",
+    "ora": "^7.0.1",
+    "rfdc": "^1.3.0",
+    "rimraf": "^5.0.5",
+    "tsup": "^7.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.5.9",
+    "discord.js": "^14.13.0",
+    "tsconfig": "workspace:*",
+    "tsx": "^3.12.8",
+    "typescript": "^5.1.6"
+  },
+  "peerDependencies": {
+    "discord.js": "^14"
+  }
+}