commandkit 1.2.0-rc.13 → 1.2.0-rc.15

package/README.md

@@ -6,43 +6,62 @@
     <a href="https://www.npmjs.com/package/commandkit"><img src="https://img.shields.io/npm/dt/commandkit?maxAge=3600" alt="npm downloads" /></a>
 </div>
 
-<p align="center">The discord.js meta-framework for building powerful, modular, and extensible Discord bots with ease.</p>
+<p align="center">Stop rebuilding command and event handlers for every new discord.js bot. CommandKit does it for you — and a lot more.</p>
+
+## Why CommandKit?
+
+Every new discord.js project starts the same way: write a command handler, write an event handler, set up interaction collectors, register slash commands with the API, figure out a project structure. It's hours of boilerplate before you write any real bot logic.
+
+Most existing discord.js frameworks solve this by giving you a handler class you instantiate and point at a folder — and that's about it. They're loaders, not frameworks. Others like Sapphire go further and have decent features, but require heavy OOP boilerplate where everything is a class extending a base class.
+
+CommandKit takes a different approach entirely. It works like a proper meta-framework — think **Next.js for Discord bots**. It ships with a smart CLI that handles bundling, TypeScript/JSX compilation, hot-reloading, command registration, and project scaffolding automatically. You run `commandkit dev` and everything just works — zero configuration.
+
+The design philosophy is **convention over configuration**: put a file in `src/app/commands/` and it's a command. Put a file in `src/app/events/` and it's an event listener. Export a `chatInput` function and it handles slash commands. Export a `message` function in the same file and it handles prefix commands too. No registration calls, no base classes, no decorators. The framework knows what to do with your code based on where it is and what it exports — so you skip the setup and go straight to building.
 
 ## Features
 
-- Beginner friendly 🚀
-- Suitable for both beginners and advanced users 👶👨‍💻
-- Slash + context menu commands + prefix commands support ✅
-- Automatic command registration and updates 🤖
-- Command middlewares for easy command management 🛠️
-- Localization support through `@commandkit/i18n` plugin 🌍
-- Plugin system to extend functionality 🔌
-- Built-in command line interface for easy development 🖥️
-- Out-of-the-box support for TypeScript and JavaScript 📜
-- Built-in customizable cache system for speedy data storage and retrieval 🗄️
-- User installable/guild scoped commands 🔧
-- Custom events support 🔔
-- JSX support for declaring Discord interaction components and modals 🎨
-- Easy to use interaction components and modals system (forget about collectors) 🧩
-- Less boilerplate code, more productivity 💪
-- and much more...
+### Automatic command and event handling
+Drop your command files in a folder, export a function, and they just work. Slash commands, context menu commands, and prefix commands are all supported under a single unified command structure — no separate handler for each type. Commands are automatically registered and kept in sync with Discord. Events work the same way: create a file, export a listener, and CommandKit handles the rest.
 
-## Getting Started
+### JSX components for Discord UI
+discord.js builder chains (`ActionRowBuilder` → `ButtonBuilder` → `setCustomId` → ...) get messy fast. CommandKit lets you write Discord components in JSX — the same declarative syntax used in React — so your UI code is clean and readable.
+
+### Built-in component handlers (no more collectors)
+Buttons get `onClick`. Modals get `onSubmit`. Select menus get `onSelect`. Define a component and its behavior in one place — no `InteractionCollector` setup, no timeout management, no cleanup boilerplate.
 
-Get started by checking out the [documentation](https://commandkit.dev).
+### Command middlewares
+Run logic before or after any command executes — permission checks, cooldowns, logging, analytics — without touching the command itself. A proper middleware layer, like you'd find in Express.
 
-## Installation
+### Unified prefix commands
+Message-based (prefix) commands live in the same file as your slash commands and context menus. One command file handles all input types. No separate handler needed.
 
-[![npm](https://nodei.co/npm/commandkit.png)](https://nodei.co/npm/commandkit/)
+### Caching with Redis support
+The `@commandkit/cache` plugin gives you a customizable caching layer — in-memory by default, Redis-backed when you need persistence. Just add the `'use cache'` directive to any function.
 
-To create a new CommandKit project, you can use the following command:
+### Plugin system with custom events
+Extend CommandKit through plugins that hook into the framework lifecycle. Plugins can emit custom events — for example, listening to an external webhook and firing events your bot can react to. This isn't a wrapper around `node:events`; it's a structured extension system for building modular, decoupled bot features. Official plugins include `@commandkit/i18n` for localization and `@commandkit/analytics` for usage tracking.
 
+### AI-powered command execution
+The `@commandkit/ai` plugin lets users interact with your bot through natural language. Instead of memorizing slash command names, users just talk to your bot — and the AI figures out which command to run. Built on the [AI SDK](https://ai-sdk.dev) with support for Google Gemini, OpenAI, and more. Includes built-in tools, custom tool support, lifecycle hooks, and per-user model selection.
+
+### Zero-config TypeScript and JavaScript
+Native TypeScript and JSX support with no configuration. No `tsconfig.json` fiddling, no separate build step, no bundler setup. The CLI handles compilation, bundling, hot-reloading, and project scaffolding.
+
+## Who is this for?
+
+- **Beginners** who don't want to spend hours building handlers before they can do anything useful
+- **Experienced developers** tired of rebuilding the same boilerplate for every new bot project
+- **Teams and freelancers** who need a reliable, structured foundation they can build on quickly
+
+CommandKit has been used in production client projects and has saved hours of setup time on each one. It's not overhead — it's the setup work you'd do anyway, already done well.
+
+## Getting Started
 
 ```bash
 npm create commandkit
 ```
 
-This will prompt you to enter few details about your project. Once you have entered the details, you can simply run `commandkit dev` to start the bot application.
+Follow the prompts, then run `commandkit dev` to start your bot. Check out the [documentation](https://commandkit.dev) for guides and API reference.
 
 ## Support and Suggestions
 

package/dist/{ActionRow-B-CGmjDp.d.ts → ActionRow-Bt9qi0Mb.d.ts}

@@ -1,4 +1,4 @@
-import { n as CommandKitElement, t as AnyCommandKitElement } from "./element-wQo0heGj.js";
+import { n as CommandKitElement, t as AnyCommandKitElement } from "./element-DeLvTMfZ.js";
 
 //#region src/components/interactive/action-row/ActionRow.d.ts
 /**
@@ -16,4 +16,4 @@ interface ActionRowProps {
 declare function ActionRow(props: ActionRowProps): CommandKitElement<'action-row'>;
 //#endregion
 export { ActionRowProps as n, ActionRow as t };
-//# sourceMappingURL=ActionRow-B-CGmjDp.d.ts.map
+//# sourceMappingURL=ActionRow-Bt9qi0Mb.d.ts.map

package/dist/{Button-C-GPeFA3.d.ts → Button-DxJLcZIU.d.ts}

@@ -1,7 +1,7 @@
-import { r as EventInterceptorErrorHandler } from "./EventInterceptor-CZmWpS08.js";
-import { a as CommandKitButtonBuilderOnEnd, i as CommandKitButtonBuilderInteractionCollectorDispatchContextData, r as CommandKitButtonBuilderInteractionCollectorDispatch } from "./ButtonKit-DKu0VAe4.js";
-import { n as CommandKitElement } from "./element-wQo0heGj.js";
-import { t as MaybeArray } from "./types-BywA9d2Z.js";
+import { r as EventInterceptorErrorHandler } from "./EventInterceptor-D9JKMcfi.js";
+import { a as CommandKitButtonBuilderOnEnd, i as CommandKitButtonBuilderInteractionCollectorDispatchContextData, r as CommandKitButtonBuilderInteractionCollectorDispatch } from "./ButtonKit-BfcyvWfj.js";
+import { n as CommandKitElement } from "./element-DeLvTMfZ.js";
+import { t as MaybeArray } from "./types-DZy7U-Ld.js";
 import { ButtonStyle, ComponentEmojiResolvable } from "discord.js";
 
 //#region src/components/interactive/button/Button.d.ts
@@ -35,4 +35,4 @@ interface ButtonProps {
 declare function Button(props: ButtonProps): CommandKitElement<'button-kit'>;
 //#endregion
 export { ButtonChildrenLike as n, ButtonProps as r, Button as t };
-//# sourceMappingURL=Button-C-GPeFA3.d.ts.map
+//# sourceMappingURL=Button-DxJLcZIU.d.ts.map

package/dist/{ButtonKit-DKu0VAe4.d.ts → ButtonKit-BfcyvWfj.d.ts}

@@ -1,4 +1,4 @@
-import { n as EventInterceptorContextData, r as EventInterceptorErrorHandler } from "./EventInterceptor-CZmWpS08.js";
+import { n as EventInterceptorContextData, r as EventInterceptorErrorHandler } from "./EventInterceptor-D9JKMcfi.js";
 import { Awaitable, ButtonBuilder, ButtonInteraction, Events } from "discord.js";
 
 //#region src/components/interactive/button/ButtonKit.d.ts
@@ -38,49 +38,49 @@ type CommandKitButtonBuilderInteractionCollectorDispatchContextData = EventInter
 declare class ButtonKit extends ButtonBuilder {
   #private;
   /**
-       * 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')
-       *   .filter((interaction) => interaction.user.id === '1234567890')
-       *   .onClick(async (interaction) => {
-       *     await interaction.reply('You clicked me!');
-       *   });
-       *
-       * const row = new ActionRowBuilder().addComponents(button);
-       *
-       * const message = await channel.send({ content: 'Click the button', components: [row] });
-       *
-       * // Remove onClick handler and destroy the interaction collector
-       * button.onClick(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')
+   *   .filter((interaction) => interaction.user.id === '1234567890')
+   *   .onClick(async (interaction) => {
+   *     await interaction.reply('You clicked me!');
+   *   });
+   *
+   * const row = new ActionRowBuilder().addComponents(button);
+   *
+   * const message = await channel.send({ content: 'Click the button', components: [row] });
+   *
+   * // Remove onClick handler and destroy the interaction collector
+   * button.onClick(null);
+   * ```
+   */
   onClick(handler: CommandKitButtonBuilderInteractionCollectorDispatch, data?: CommandKitButtonBuilderInteractionCollectorDispatchContextData): this;
   onEnd(handler: CommandKitButtonBuilderOnEnd): 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.
-       */
+   * 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.
+   */
   onError(handler: EventInterceptorErrorHandler): this;
   /**
-       * Sets a filter for the interaction collector.
-       * @param predicate The filter to use for the interaction collector
-       */
+   * Sets a filter for the interaction collector.
+   * @param predicate The filter to use for the interaction collector
+   */
   filter(predicate: ButtonKitPredicate): this;
   private get customId();
   /**
-       * Disposes of the button collector and cleans up resources.
-       */
+   * Disposes of the button collector and cleans up resources.
+   */
   dispose(): this;
 }
 //#endregion
 export { CommandKitButtonBuilderOnEnd as a, CommandKitButtonBuilderInteractionCollectorDispatchContextData as i, ButtonKitPredicate as n, OnButtonKitClick as o, CommandKitButtonBuilderInteractionCollectorDispatch as r, OnButtonKitEnd as s, ButtonKit as t };
-//# sourceMappingURL=ButtonKit-DKu0VAe4.d.ts.map
+//# sourceMappingURL=ButtonKit-BfcyvWfj.d.ts.map

package/dist/{ChannelSelectMenuKit-HQZ4hH5s.d.ts → ChannelSelectMenuKit-DYkudikb.d.ts}

@@ -1,5 +1,5 @@
-import { r as EventInterceptorErrorHandler } from "./EventInterceptor-CZmWpS08.js";
-import { a as OnSelectMenuKitSubmit, n as CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData, o as SelectMenuKitPredicate, r as CommandKitSelectMenuBuilderOnEnd, t as CommandKitSelectMenuBuilderInteractionCollectorDispatch } from "./common-DnwCYit8.js";
+import { r as EventInterceptorErrorHandler } from "./EventInterceptor-D9JKMcfi.js";
+import { a as OnSelectMenuKitSubmit, n as CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData, o as SelectMenuKitPredicate, r as CommandKitSelectMenuBuilderOnEnd, t as CommandKitSelectMenuBuilderInteractionCollectorDispatch } from "./common-CCvvgnxi.js";
 import { ChannelSelectMenuBuilder, ChannelSelectMenuInteraction } from "discord.js";
 
 //#region src/components/interactive/select-menu/ChannelSelectMenuKit.d.ts
@@ -20,47 +20,47 @@ type ChannelSelectMenuKitPredicate = SelectMenuKitPredicate<ChannelSelectMenuInt
 declare class ChannelSelectMenuKit extends ChannelSelectMenuBuilder {
   #private;
   /**
-       * Sets the handler to run when the modal is submitted.
-       * @param handler - The handler to run when the modal is submitted.
-       * @param data - The context data for the interaction collector.
-       * @returns This instance of the modal builder.
-       * @example
-       * ```ts
-       * const modal = new ChannelSelectMenuKit()
-       *  .setTitle('My Modal')
-       *  .setCustomId('my-modal')
-       *  .filter((interaction) => interaction.Channel.id === '1234567890')
-       *  .onSelect(async (interaction) => {
-       *     await interaction.reply('You submitted the modal!');
-       *   })
-       *   .addComponents(actionRow1, actionRow2);
-       * ```
-       */
+   * Sets the handler to run when the modal is submitted.
+   * @param handler - The handler to run when the modal is submitted.
+   * @param data - The context data for the interaction collector.
+   * @returns This instance of the modal builder.
+   * @example
+   * ```ts
+   * const modal = new ChannelSelectMenuKit()
+   *  .setTitle('My Modal')
+   *  .setCustomId('my-modal')
+   *  .filter((interaction) => interaction.Channel.id === '1234567890')
+   *  .onSelect(async (interaction) => {
+   *     await interaction.reply('You submitted the modal!');
+   *   })
+   *   .addComponents(actionRow1, actionRow2);
+   * ```
+   */
   onSelect(handler: CommandKitSelectMenuBuilderInteractionCollectorDispatch<ChannelSelectMenuInteraction, ChannelSelectMenuKit>, data?: CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData): 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.
-       */
+   * 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.
+   */
   onEnd(handler: CommandKitSelectMenuBuilderOnEnd): 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.
-       */
+   * 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.
+   */
   onError(handler: EventInterceptorErrorHandler): this;
   /**
-       * Sets a filter for the interaction collector.
-       * @param predicate - The filter to use for the interaction collector.
-       * @returns This instance of the modal builder.
-       */
+   * Sets a filter for the interaction collector.
+   * @param predicate - The filter to use for the interaction collector.
+   * @returns This instance of the modal builder.
+   */
   filter(predicate: SelectMenuKitPredicate<ChannelSelectMenuInteraction>): this;
   private get customId();
   /**
-       * Cleans up the interaction collector and removes the handler.
-       */
+   * Cleans up the interaction collector and removes the handler.
+   */
   dispose(): this;
 }
 //#endregion
 export { ChannelSelectMenuKitPredicate as n, OnChannelSelectMenuKitSubmit as r, ChannelSelectMenuKit as t };
-//# sourceMappingURL=ChannelSelectMenuKit-HQZ4hH5s.d.ts.map
+//# sourceMappingURL=ChannelSelectMenuKit-DYkudikb.d.ts.map

package/dist/{CommandsRouter-C7dZEepB.d.ts → CommandsRouter-DiNoF0dq.d.ts}

@@ -44,53 +44,53 @@ interface CommandsRouterOptions {
 declare class CommandsRouter {
   private readonly options;
   /**
-       * @private
-       * @internal
-       */
+   * @private
+   * @internal
+   */
   private commands;
   /**
-       * @private
-       * @internal
-       */
+   * @private
+   * @internal
+   */
   private middlewares;
   /**
-       * Creates a new CommandsRouter instance.
-       * @param options - Configuration options for the router
-       */
+   * Creates a new CommandsRouter instance.
+   * @param options - Configuration options for the router
+   */
   constructor(options: CommandsRouterOptions);
   /**
-       * Populates the router with existing command and middleware data.
-       * @param data - Parsed command data to populate with
-       */
+   * Populates the router with existing command and middleware data.
+   * @param data - Parsed command data to populate with
+   */
   populate(data: ParsedCommandData): void;
   /**
-       * Checks if the configured entrypoint path exists.
-       * @returns True if the path exists
-       */
+   * Checks if the configured entrypoint path exists.
+   * @returns True if the path exists
+   */
   isValidPath(): boolean;
   /**
-       * @private
-       * @internal
-       */
+   * @private
+   * @internal
+   */
   private isCommand;
   /**
-       * @private
-       * @internal
-       */
+   * @private
+   * @internal
+   */
   private isMiddleware;
   /**
-       * @private
-       * @internal
-       */
+   * @private
+   * @internal
+   */
   private isCategory;
   /**
-       * Clears all loaded commands and middleware.
-       */
+   * Clears all loaded commands and middleware.
+   */
   clear(): void;
   /**
-       * Scans the filesystem for commands and middleware files.
-       * @returns Parsed command data
-       */
+   * Scans the filesystem for commands and middleware files.
+   * @returns Parsed command data
+   */
   scan(): Promise<{
     commands: {
       [k: string]: Command;
@@ -100,17 +100,17 @@ declare class CommandsRouter {
     };
   }>;
   /**
-       * Gets the raw command and middleware collections.
-       * @returns Object containing commands and middlewares collections
-       */
+   * Gets the raw command and middleware collections.
+   * @returns Object containing commands and middlewares collections
+   */
   getData(): {
     commands: Collection<string, Command>;
     middlewares: Collection<string, Middleware>;
   };
   /**
-       * Converts the loaded data to a JSON-serializable format.
-       * @returns Plain object with commands and middlewares
-       */
+   * Converts the loaded data to a JSON-serializable format.
+   * @returns Plain object with commands and middlewares
+   */
   toJSON(): {
     commands: {
       [k: string]: Command;
@@ -120,26 +120,26 @@ declare class CommandsRouter {
     };
   };
   /**
-       * @private
-       * @internal
-       */
+   * @private
+   * @internal
+   */
   private traverse;
   /**
-       * @private
-       * @internal
-       */
+   * @private
+   * @internal
+   */
   private handle;
   /**
-       * @private
-       * @internal
-       */
+   * @private
+   * @internal
+   */
   private applyMiddlewares;
   /**
-       * @private
-       * @internal
-       */
+   * @private
+   * @internal
+   */
   private replaceEntrypoint;
 }
 //#endregion
 export { ParsedCommandData as a, Middleware as i, CommandsRouter as n, CommandsRouterOptions as r, Command as t };
-//# sourceMappingURL=CommandsRouter-C7dZEepB.d.ts.map
+//# sourceMappingURL=CommandsRouter-DiNoF0dq.d.ts.map

package/dist/{EventInterceptor-CZmWpS08.d.ts → EventInterceptor-D9JKMcfi.d.ts}

@@ -3,28 +3,28 @@ import { Awaitable, Client, ClientEvents } from "discord.js";
 //#region src/components/common/EventInterceptor.d.ts
 interface EventInterceptorContextData<E extends keyof ClientEvents> {
   /**
-       * The filter to use for the collector.
-       */
+   * The filter to use for the collector.
+   */
   filter?: (...args: ClientEvents[E]) => Awaitable<boolean>;
   /**
-       * The duration (in ms) that the collector should run for.
-       */
+   * The duration (in ms) that the collector should run for.
+   */
   time?: number;
   /**
-       * If the collector should automatically reset the timer when a button is clicked.
-       */
+   * If the collector should automatically reset the timer when a button is clicked.
+   */
   autoReset?: boolean;
   /**
-       * Whether the collector should run only once.
-       */
+   * Whether the collector should run only once.
+   */
   once?: boolean;
   /**
-       * The handler to run when the collector ends.
-       */
+   * The handler to run when the collector ends.
+   */
   onEnd?: (reason: string) => Awaitable<void>;
   /**
-       * The handler to run upon an error.
-       */
+   * The handler to run upon an error.
+   */
   onError?: EventInterceptorErrorHandler;
 }
 /**
@@ -42,50 +42,50 @@ declare class EventInterceptor {
   private globalHandlers;
   private cleanupTimer;
   /**
-       * Creates the event interceptor.
-       */
+   * Creates the event interceptor.
+   */
   constructor(client: Client);
   /**
-       * Destroys the event interceptor.
-       */
+   * Destroys the event interceptor.
+   */
   destroy(): void;
   /**
-       * Whether the event has subscribers.
-       * @param event The event to check.
-       */
+   * Whether the event has subscribers.
+   * @param event The event to check.
+   */
   hasSubscribers(event: keyof ClientEvents): boolean;
   /**
-       * Returns the number of subscribers for the event.
-       * @param event The event to check.
-       */
+   * Returns the number of subscribers for the event.
+   * @param event The event to check.
+   */
   getSubscriberCount(event: keyof ClientEvents): number;
   /**
-       * Whether the event has global handlers.
-       */
+   * Whether the event has global handlers.
+   */
   hasGlobalHandlers(): boolean;
   /**
-       * Returns the number of global handlers.
-       */
+   * Returns the number of global handlers.
+   */
   getGlobalHandlersCount(): number;
   /**
-       * Subscribes to an event.
-       * @param event The event to subscribe to.
-       * @param listener The listener to call when the event is emitted.
-       * @returns A function to unsubscribe from the event.
-       */
+   * Subscribes to an event.
+   * @param event The event to subscribe to.
+   * @param listener The listener to call when the event is emitted.
+   * @returns A function to unsubscribe from the event.
+   */
   subscribe<Event extends keyof ClientEvents>(event: Event, listener: (...args: ClientEvents[Event]) => void, options?: EventInterceptorContextData<Event>): () => void;
   /**
-       * Unsubscribes from an event.
-       * @param event The event to unsubscribe from.
-       */
+   * Unsubscribes from an event.
+   * @param event The event to unsubscribe from.
+   */
   unsubscribe<Event extends keyof ClientEvents>(event: Event, listener: (...args: ClientEvents[Event]) => void, reason?: string): void;
   /**
-       * Creates a global handler for the event.
-       * @param event The event to create a global handler for.
-       * @returns The global handler.
-       */
+   * Creates a global handler for the event.
+   * @param event The event to create a global handler for.
+   * @returns The global handler.
+   */
   private createGlobalHandler;
 }
 //#endregion
 export { EventInterceptorContextData as n, EventInterceptorErrorHandler as r, EventInterceptor as t };
-//# sourceMappingURL=EventInterceptor-CZmWpS08.d.ts.map
+//# sourceMappingURL=EventInterceptor-D9JKMcfi.d.ts.map