commandkit 1.0.0-next-beta.20240203223402 → 1.2.0-dev.20250818125640

package/LICENSE

@@ -0,0 +1,5 @@
+Copyright 2025 Avraj Sahota
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-    <img src="https://raw.githubusercontent.com/underctrl-io/commandkit/master/apps/docs/public/ckit_logo.svg" width="60%" />
+    <img src="https://raw.githubusercontent.com/underctrl-io/commandkit/main/apps/website/static/img/ckit_logo.svg" width="60%" />
     <br />
     <a href="https://ctrl.lol/discord"><img src="https://img.shields.io/discord/1055188344188973066?color=5865F2&logo=discord&logoColor=white" alt="support server" /></a>
     <a href="https://www.npmjs.com/package/commandkit"><img src="https://img.shields.io/npm/v/commandkit?maxAge=3600" alt="npm version" /></a>
@@ -15,100 +15,42 @@ CommandKit is a library that makes it easy to handle commands and events in your
 ## Features
 
 - Beginner friendly 🚀
-- Slash + context menu commands support ✅
-- Multiple dev guilds, users, & roles support 🤝
-- Automatic command updates 🤖
-- REST registration behaviour 📍
-- Easy command line interface 🖥️
-- And much more! 🧪
+- 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...
 
 ## Documentation
 
-You can find the full documentation [here](https://commandkit.js.org).
+You can find the full documentation [here](https://commandkit.dev).
 
 ## Installation
 
 [![npm](https://nodei.co/npm/commandkit.png)](https://nodei.co/npm/commandkit/)
 
-To install CommandKit, simply run the following command:
+To create a new CommandKit project, you can use the following command:
 
-For npm:
 
 ```bash
-npm install commandkit
+npm create commandkit
 ```
 
-Yarn:
+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.
 
-```bash
-yarn add commandkit
-```
-
-pnpm:
-
-```bash
-pnpm add commandkit
-```
-
-### Install development version
-
-To install the development version of CommandKit, run the following command:
-
-```bash
-npm install commandkit@dev
-```
-
-> ⚠️ The development version is likely to have bugs.
-
-## Usage
+## Getting Started
 
-This is a simple overview of how to set up this library with all the options. You can read more in the [full documentation](https://commandkit.js.org)
-
-```js
-// index.js
-const { Client, GatewayIntentBits } = require('discord.js');
-const { CommandKit } = require('commandkit');
-const path = require('path');
-
-const client = new Client({
-    intents: [
-        GatewayIntentBits.Guilds,
-        GatewayIntentBits.GuildMessages,
-        GatewayIntentBits.MessageContent,
-    ],
-});
-
-new CommandKit({
-    // Your discord.js client object
-    client,
-
-    // Path to the commands folder
-    commandsPath: path.join(__dirname, 'commands'),
-
-    // Path to the events folder
-    eventsPath: path.join(__dirname, 'events'),
-
-    // Path to the validations folder (only valid if "commandsPath" was provided)
-    validationsPath: path.join(__dirname, 'validations'),
-
-    // Array of development server IDs (used to register and run devOnly commands)
-    devGuildIds: ['1234567890', '0987654321'],
-
-    // Array of developer user IDs (used for devOnly commands)
-    devUserIds: ['1234567890', '0987654321'],
-
-    // Array of developer role IDs (used for devOnly commands)
-    devRoleIds: ['1234567890', '0987654321'],
-
-    // Disable CommandKit's built-in validations
-    skipBuiltInValidations: true,
-
-    // Update command registration/reload behaviour to register all commands at once
-    bulkRegister: true,
-});
-
-client.login('YOUR_TOKEN_HERE');
-```
+To get started with CommandKit, you can check out the [quick start guide](https://commandkit.dev/docs/next/guide/installation).
 
 ## Support and Suggestions
 

package/ai.cjs

@@ -0,0 +1,21 @@
+const {
+  AiContext,
+  AiPlugin,
+  configureAI,
+  createSystemPrompt,
+  createTool,
+  getAIConfig,
+  useAIContext,
+  ai,
+} = require('@commandkit/ai');
+
+module.exports = {
+  AiContext,
+  AiPlugin,
+  configureAI,
+  createSystemPrompt,
+  createTool,
+  getAIConfig,
+  useAIContext,
+  ai,
+};

package/ai.d.ts

@@ -0,0 +1 @@
+export * from '@commandkit/ai';

package/analytics.cjs

@@ -0,0 +1,21 @@
+const { getCommandKit } = require('./dist/context/async-context.js');
+const { AnalyticsEngine } = require('./dist/analytics/analytics-engine.js');
+const { noAnalytics } = require('./dist/analytics/utils.js');
+const { AnalyticsEvents } = require('./dist/analytics/constants.js');
+
+function useAnalytics() {
+  const commandkit = getCommandKit(true);
+  return commandkit.analytics;
+}
+
+function track(event) {
+  return useAnalytics().track(event);
+}
+
+module.exports = {
+  AnalyticsEvents,
+  AnalyticsEngine,
+  useAnalytics,
+  noAnalytics,
+  track,
+};

package/analytics.d.ts

@@ -0,0 +1,9 @@
+import type { AnalyticsEngine } from './dist/analytics/analytics-engine';
+
+export * from './dist/analytics/analytics-engine';
+export * from './dist/analytics/analytics-provider';
+export { noAnalytics } from './dist/analytics/utils';
+export { AnalyticsEvents } from './dist/analytics/constants';
+
+export function useAnalytics(): AnalyticsEngine;
+export function track(event: AnalyticsEvent): Promise<void>;

package/async-queue.cjs

@@ -0,0 +1,9 @@
+const {
+  AsyncQueue,
+  createAsyncQueue,
+} = require('./dist/utils/useful-stuff/async-queue.js');
+
+module.exports = {
+  AsyncQueue,
+  createAsyncQueue,
+};

package/async-queue.d.ts

@@ -0,0 +1 @@
+export * from './dist/utils/useful-stuff/async-queue.js';

package/bin/index.mjs

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { bootstrapCommandkitCLI } from '../dist/index.js';
+
+await bootstrapCommandkitCLI(process.argv);

package/cache.cjs

@@ -0,0 +1,23 @@
+const {
+  cacheTag,
+  cacheLife,
+  revalidateTag,
+  cleanup,
+  MemoryCache,
+  CacheProvider,
+  isCachedFunction,
+  setCacheProvider,
+  getCacheProvider,
+} = require('@commandkit/cache');
+
+module.exports = {
+  cacheTag,
+  cacheLife,
+  revalidateTag,
+  cleanup,
+  MemoryCache,
+  CacheProvider,
+  isCachedFunction,
+  setCacheProvider,
+  getCacheProvider,
+};

package/cache.d.ts

@@ -0,0 +1,13 @@
+export {
+  cacheTag,
+  cacheLife,
+  revalidateTag,
+  cleanup,
+  MemoryCache,
+  CacheProvider,
+  CacheEntry,
+  isCachedFunction,
+  setCacheProvider,
+  getCacheProvider,
+  // @ts-ignore
+} from '@commandkit/cache';

package/components.cjs

@@ -0,0 +1 @@
+module.exports = require('./dist/components/index.js');

package/components.d.ts

@@ -0,0 +1 @@
+export * from './dist/components/index';

package/config.cjs

@@ -0,0 +1,5 @@
+const { defineConfig } = require('./dist/config/config.js');
+
+module.exports = {
+  defineConfig,
+};

package/config.d.ts

@@ -0,0 +1 @@
+export { defineConfig, CommandKitConfiguration as Config } from './dist/index';

package/dist/ActionRow-CmTHbo2t.js

@@ -0,0 +1,25 @@
+const require_chunk = require('./chunk-nOFOJqeH.js');
+const discord_js = require_chunk.__toESM(require("discord.js"));
+
+//#region src/components/v1/action-row/ActionRow.ts
+/**
+* The action row component.
+* @param props The action row properties.
+* @returns The commandkit element.
+* @example <ActionRow><Button label="Click me" style={ButtonStyle.Primary} customId="click_me" /></ActionRow>
+*/
+function ActionRow(props) {
+	const row = new discord_js.ActionRowBuilder();
+	if (Array.isArray(props.children)) row.setComponents(...props.children);
+	else if (props.children) row.setComponents(props.children);
+	return row;
+}
+
+//#endregion
+Object.defineProperty(exports, 'ActionRow', {
+  enumerable: true,
+  get: function () {
+    return ActionRow;
+  }
+});
+//# sourceMappingURL=ActionRow-CmTHbo2t.js.map

package/dist/ActionRow-CmTHbo2t.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionRow-CmTHbo2t.js","names":[],"sources":["../src/components/v1/action-row/ActionRow.ts"],"sourcesContent":["import { ActionRowBuilder } from 'discord.js';\nimport { AnyCommandKitElement, CommandKitElement } from '../../common/element';\n\n/**\n * The properties for the action row component.\n */\nexport interface ActionRowProps {\n  children?: AnyCommandKitElement[] | AnyCommandKitElement;\n}\n\n/**\n * The action row component.\n * @param props The action row properties.\n * @returns The commandkit element.\n * @example <ActionRow><Button label=\"Click me\" style={ButtonStyle.Primary} customId=\"click_me\" /></ActionRow>\n */\nexport function ActionRow(\n  props: ActionRowProps,\n): CommandKitElement<'action-row'> {\n  const row = new ActionRowBuilder();\n\n  if (Array.isArray(props.children)) {\n    // @ts-ignore\n    row.setComponents(...props.children);\n  } else if (props.children) {\n    // @ts-ignore\n    row.setComponents(props.children);\n  }\n\n  return row;\n}\n"],"mappings":";;;;;;;;;;AAgBA,SAAgB,UAChB,OACkC;CAChC,MAAM,MAAM,IAAI;AAEhB,KAAI,MAAM,QAAQ,MAAM,UAEtB,KAAI,cAAc,GAAG,MAAM;UAClB,MAAM,SAEf,KAAI,cAAc,MAAM;AAG1B,QAAO;AACT"}

package/dist/ActionRow-DKnFVDME.d.ts

@@ -0,0 +1,20 @@
+import { AnyCommandKitElement, CommandKitElement } from "./element-CAXu1XtK.js";
+
+//#region src/components/v1/action-row/ActionRow.d.ts
+
+/**
+ * The properties for the action row component.
+ */
+interface ActionRowProps {
+  children?: AnyCommandKitElement[] | AnyCommandKitElement;
+}
+/**
+ * The action row component.
+ * @param props The action row properties.
+ * @returns The commandkit element.
+ * @example <ActionRow><Button label="Click me" style={ButtonStyle.Primary} customId="click_me" /></ActionRow>
+ */
+declare function ActionRow(props: ActionRowProps): CommandKitElement<'action-row'>;
+//#endregion
+export { ActionRow, ActionRowProps };
+//# sourceMappingURL=ActionRow-DKnFVDME.d.ts.map

package/dist/Button-4ZUXdA56.d.ts

@@ -0,0 +1,39 @@
+import { EventInterceptorErrorHandler } from "./EventInterceptor-x-R2qshQ.js";
+import { CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitButtonBuilderOnEnd } from "./ButtonKit-C7r7RPNf.js";
+import { CommandKitElement } from "./element-CAXu1XtK.js";
+import { MaybeArray } from "./types-CJ-XvOFN.js";
+import { ButtonStyle, ComponentEmojiResolvable } from "discord.js";
+
+//#region src/components/v1/button/Button.d.ts
+
+/**
+ * The button children type.
+ */
+type ButtonChildrenLike = string | number | boolean;
+/**
+ * The button props
+ */
+interface ButtonProps {
+  label?: string;
+  style?: ButtonStyle;
+  emoji?: ComponentEmojiResolvable;
+  disabled?: boolean;
+  customId?: string;
+  url?: string;
+  skuId?: string;
+  onClick?: CommandKitButtonBuilderInteractionCollectorDispatch;
+  onError?: EventInterceptorErrorHandler;
+  options?: CommandKitButtonBuilderInteractionCollectorDispatchContextData;
+  onEnd?: CommandKitButtonBuilderOnEnd;
+  children?: MaybeArray<ButtonChildrenLike>;
+}
+/**
+ * The button component.
+ * @param props The button properties.
+ * @returns The commandkit element.
+ * @example <Button style={ButtonStyle.Primary} customId="click_me">Click Me</Button>
+ */
+declare function Button(props: ButtonProps): CommandKitElement<'button-kit'>;
+//#endregion
+export { Button, ButtonChildrenLike, ButtonProps };
+//# sourceMappingURL=Button-4ZUXdA56.d.ts.map

package/dist/ButtonKit-C7r7RPNf.d.ts

@@ -0,0 +1,87 @@
+import { EventInterceptorContextData, EventInterceptorErrorHandler } from "./EventInterceptor-x-R2qshQ.js";
+import { Awaitable, ButtonBuilder, ButtonInteraction, Events } from "discord.js";
+
+//#region src/components/v1/button/ButtonKit.d.ts
+
+/**
+ * The predicate function that filters button interactions.
+ * It receives a ButtonInteraction and returns a boolean or a Promise that resolves to a boolean.
+ */
+type ButtonKitPredicate = (interaction: ButtonInteraction) => Awaitable<boolean>;
+/**
+ * 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 OnButtonKitClick = CommandKitButtonBuilderInteractionCollectorDispatch;
+/**
+ * The handler to run when the interaction collector ends. This handler is called with the reason as the first argument.
+ * If the first argument is null, it means that the interaction collector has been destroyed.
+ */
+type OnButtonKitEnd = CommandKitButtonBuilderOnEnd;
+/**
+ * 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, context: ButtonKit) => Awaitable<void>;
+/**
+ * The handler to run when the interaction collector ends. This handler is called with the reason as the first argument.
+ * If the first argument is null, it means that the interaction collector has been destroyed.
+ */
+type CommandKitButtonBuilderOnEnd = (reason: string) => Awaitable<void>;
+/**
+ * The context data for the interaction collector.
+ * This includes the autoReset, time, filter, onEnd, and onError properties.
+ */
+type CommandKitButtonBuilderInteractionCollectorDispatchContextData = EventInterceptorContextData<Events.InteractionCreate>;
+/**
+ * A builder for creating buttons with additional features like interaction collectors and event handling.
+ */
+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);
+   * ```
+   */
+  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.
+   */
+  onError(handler: EventInterceptorErrorHandler): this;
+  /**
+   * 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.
+   */
+  dispose(): this;
+}
+//#endregion
+export { ButtonKit, ButtonKitPredicate, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitButtonBuilderOnEnd, OnButtonKitClick, OnButtonKitEnd };
+//# sourceMappingURL=ButtonKit-C7r7RPNf.d.ts.map

package/dist/ChannelSelectMenuKit-BrXvBYNH.d.ts

@@ -0,0 +1,67 @@
+import { EventInterceptorErrorHandler } from "./EventInterceptor-x-R2qshQ.js";
+import { CommandKitSelectMenuBuilderInteractionCollectorDispatch, CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData, CommandKitSelectMenuBuilderOnEnd, OnSelectMenuKitSubmit, SelectMenuKitPredicate } from "./common-DOCvOVC4.js";
+import { ChannelSelectMenuBuilder, ChannelSelectMenuInteraction } from "discord.js";
+
+//#region src/components/v1/select-menu/ChannelSelectMenuKit.d.ts
+
+/**
+ * Type for the handler function that is called when the channel select menu is submitted.
+ */
+type OnChannelSelectMenuKitSubmit = OnSelectMenuKitSubmit<ChannelSelectMenuInteraction, ChannelSelectMenuKit>;
+/**
+ * Type for the predicate function that filters channel select menu interactions.
+ * It receives a ChannelSelectMenuInteraction and returns a boolean or a Promise that resolves to a boolean.
+ */
+type ChannelSelectMenuKitPredicate = SelectMenuKitPredicate<ChannelSelectMenuInteraction>;
+/**
+ * A builder for creating channel select menus with additional features like interaction collectors and event handling.
+ * This class extends the ChannelSelectMenuBuilder from discord.js and adds methods for handling interactions.
+ * It allows you to set a handler for when the channel select menu is submitted, filter interactions, and handle the end of the interaction collector.
+ */
+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);
+   * ```
+   */
+  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.
+   */
+  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.
+   */
+  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.
+   */
+  filter(predicate: SelectMenuKitPredicate<ChannelSelectMenuInteraction>): this;
+  private get customId();
+  /**
+   * Cleans up the interaction collector and removes the handler.
+   */
+  dispose(): this;
+}
+//#endregion
+export { ChannelSelectMenuKit, ChannelSelectMenuKitPredicate, OnChannelSelectMenuKitSubmit };
+//# sourceMappingURL=ChannelSelectMenuKit-BrXvBYNH.d.ts.map

package/dist/CommandKitEventsChannel-Bgw0XCOl.js

@@ -0,0 +1,87 @@
+const require_chunk = require('./chunk-nOFOJqeH.js');
+const node_events = require_chunk.__toESM(require("node:events"));
+
+//#region src/events/CommandKitEventsChannel.ts
+/**
+* Represents a channel for emitting and listening to events in CommandKit.
+* This class provides methods to manage event listeners and emit events
+* within a specific namespace.
+*/
+var CommandKitEventsChannel = class {
+	emitter = new node_events.default();
+	/**
+	* Creates a new instance of CommandKitEventsChannel.
+	* @param commandkit The CommandKit instance that this channel belongs to.
+	*/
+	constructor(commandkit) {
+		this.commandkit = commandkit;
+	}
+	/**
+	* Creates a namespaced event channel. This allows you to manage events
+	* within a specific namespace, preventing conflicts with other event channels.
+	* This is useful for organizing events related to different parts of your application.
+	* @param namespace The namespace for the event channel.
+	* @returns An object containing methods for managing events within the namespace.
+	* @example commandkit.events.to('customNamespace').emit('eventName', data);
+	*/
+	to(namespace) {
+		return {
+			on: this.on.bind(this, namespace),
+			off: this.off.bind(this, namespace),
+			once: this.once.bind(this, namespace),
+			emit: this.emit.bind(this, namespace),
+			removeAllListeners: this.removeAllListeners.bind(this, namespace)
+		};
+	}
+	/**
+	* Register an event listener for a specific event within the namespace.
+	* @param namespace The namespace for the event channel.
+	* @param event The name of the event to listen for.
+	* @param listener The function to call when the event is emitted.
+	*/
+	on(namespace, event, listener) {
+		this.emitter.on(`${namespace}:${event}`, listener);
+	}
+	/**
+	* Unregister an event listener for a specific event within the namespace.
+	* @param namespace The namespace for the event channel.
+	* @param event The name of the event to stop listening for.
+	* @param listener The function that was registered as the listener.
+	*/
+	off(namespace, event, listener) {
+		this.emitter.off(`${namespace}:${event}`, listener);
+	}
+	/**
+	* Register an event listener that will be called only once for a specific event
+	* within the namespace.
+	* @param namespace The namespace for the event channel.
+	* @param event The name of the event to listen for.
+	* @param listener The function to call when the event is emitted.
+	*/
+	once(namespace, event, listener) {
+		this.emitter.once(`${namespace}:${event}`, listener);
+	}
+	/**
+	* Emit an event within the specified namespace, calling all registered listeners.
+	* @param namespace The namespace for the event channel.
+	* @param event The name of the event to emit.
+	* @param args The arguments to pass to the listeners.
+	* @returns A boolean indicating whether any listeners were called.
+	*/
+	emit(namespace, event, ...args) {
+		return this.emitter.emit(`${namespace}:${event}`, ...args);
+	}
+	removeAllListeners(namespace, event) {
+		if (event) this.emitter.removeAllListeners(`${namespace}:${event}`);
+		else this.emitter.removeAllListeners(namespace);
+	}
+};
+
+//#endregion
+Object.defineProperty(exports, 'CommandKitEventsChannel', {
+  enumerable: true,
+  get: function () {
+    return CommandKitEventsChannel;
+  }
+});
+//# sourceMappingURL=CommandKitEventsChannel-Bgw0XCOl.js.map

package/dist/CommandKitEventsChannel-Bgw0XCOl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandKitEventsChannel-Bgw0XCOl.js","names":[],"sources":["../src/events/CommandKitEventsChannel.ts"],"sourcesContent":["import EventEmitter from 'node:events';\nimport type { CommandKit } from '../commandkit';\nimport type { AsyncFunction, GenericFunction } from '../context/async-context';\n\n/**\n * The function type for event listeners.\n */\nexport type ListenerFunction = GenericFunction | AsyncFunction;\n\n/**\n * Represents a channel for emitting and listening to events in CommandKit.\n * This class provides methods to manage event listeners and emit events\n * within a specific namespace.\n */\nexport class CommandKitEventsChannel {\n  private emitter = new EventEmitter();\n\n  /**\n   * Creates a new instance of CommandKitEventsChannel.\n   * @param commandkit The CommandKit instance that this channel belongs to.\n   */\n  public constructor(public readonly commandkit: CommandKit) {}\n\n  /**\n   * Creates a namespaced event channel. This allows you to manage events\n   * within a specific namespace, preventing conflicts with other event channels.\n   * This is useful for organizing events related to different parts of your application.\n   * @param namespace The namespace for the event channel.\n   * @returns An object containing methods for managing events within the namespace.\n   * @example commandkit.events.to('customNamespace').emit('eventName', data);\n   */\n  public to(namespace: string) {\n    return {\n      on: this.on.bind(this, namespace),\n      off: this.off.bind(this, namespace),\n      once: this.once.bind(this, namespace),\n      emit: this.emit.bind(this, namespace),\n      removeAllListeners: this.removeAllListeners.bind(this, namespace),\n    };\n  }\n\n  /**\n   * Register an event listener for a specific event within the namespace.\n   * @param namespace The namespace for the event channel.\n   * @param event The name of the event to listen for.\n   * @param listener The function to call when the event is emitted.\n   */\n  public on(namespace: string, event: string, listener: ListenerFunction) {\n    this.emitter.on(`${namespace}:${event}`, listener);\n  }\n\n  /**\n   * Unregister an event listener for a specific event within the namespace.\n   * @param namespace The namespace for the event channel.\n   * @param event The name of the event to stop listening for.\n   * @param listener The function that was registered as the listener.\n   */\n  public off(namespace: string, event: string, listener: ListenerFunction) {\n    this.emitter.off(`${namespace}:${event}`, listener);\n  }\n\n  /**\n   * Register an event listener that will be called only once for a specific event\n   * within the namespace.\n   * @param namespace The namespace for the event channel.\n   * @param event The name of the event to listen for.\n   * @param listener The function to call when the event is emitted.\n   */\n  public once(namespace: string, event: string, listener: ListenerFunction) {\n    this.emitter.once(`${namespace}:${event}`, listener);\n  }\n\n  /**\n   * Emit an event within the specified namespace, calling all registered listeners.\n   * @param namespace The namespace for the event channel.\n   * @param event The name of the event to emit.\n   * @param args The arguments to pass to the listeners.\n   * @returns A boolean indicating whether any listeners were called.\n   */\n  public emit(namespace: string, event: string, ...args: any[]) {\n    return this.emitter.emit(`${namespace}:${event}`, ...args);\n  }\n\n  /**\n   * Remove all listeners for a specific event or all events within the namespace.\n   * @param namespace The namespace for the event channel.\n   * @param event The name of the event to remove listeners for. If not provided, all listeners for all events in the namespace will be removed.\n   */\n  public removeAllListeners(namespace: string): void;\n  public removeAllListeners(namespace: string, event: string): void;\n  public removeAllListeners(namespace: string, event?: string): void {\n    if (event) {\n      this.emitter.removeAllListeners(`${namespace}:${event}`);\n    } else {\n      this.emitter.removeAllListeners(namespace);\n    }\n  }\n}\n"],"mappings":";;;;;;;;;AAcA,IAAa,0BAAb,MAAqC;CACnC,AAAQ,UAAU,IAAI;;;;;CAMtB,AAAO,YAAY,AAAgB,YAAwB;EAAxB;CAAyB;;;;;;;;;CAU5D,AAAO,GAAG,WAAmB;AAC3B,SAAO;GACL,IAAI,KAAK,GAAG,KAAK,MAAM;GACvB,KAAK,KAAK,IAAI,KAAK,MAAM;GACzB,MAAM,KAAK,KAAK,KAAK,MAAM;GAC3B,MAAM,KAAK,KAAK,KAAK,MAAM;GAC3B,oBAAoB,KAAK,mBAAmB,KAAK,MAAM;GACxD;CACH;;;;;;;CAQA,AAAO,GAAG,WAAmB,OAAe,UAA4B;AACtE,OAAK,QAAQ,GAAG,GAAG,UAAU,GAAG,SAAS;CAC3C;;;;;;;CAQA,AAAO,IAAI,WAAmB,OAAe,UAA4B;AACvE,OAAK,QAAQ,IAAI,GAAG,UAAU,GAAG,SAAS;CAC5C;;;;;;;;CASA,AAAO,KAAK,WAAmB,OAAe,UAA4B;AACxE,OAAK,QAAQ,KAAK,GAAG,UAAU,GAAG,SAAS;CAC7C;;;;;;;;CASA,AAAO,KAAK,WAAmB,OAAe,GAAG,MAAa;AAC5D,SAAO,KAAK,QAAQ,KAAK,GAAG,UAAU,GAAG,SAAS,GAAG;CACvD;CASA,AAAO,mBAAmB,WAAmB,OAAsB;AACjE,MAAI,MACF,MAAK,QAAQ,mBAAmB,GAAG,UAAU,GAAG;MAEhD,MAAK,QAAQ,mBAAmB;CAEpC;AACF"}