commandkit 0.1.11-dev.20250328085113 → 0.1.11-dev.20250330063035

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as discord_js from 'discord.js';
-import { RESTPostAPIApplicationCommandsJSONBody, Client, Interaction, CacheType, PermissionsString, ChatInputCommandInteraction, ContextMenuCommandInteraction, UserContextMenuCommandInteraction, MessageContextMenuCommandInteraction, AutocompleteInteraction, ClientEvents, Awaitable, ButtonBuilder, ButtonInteraction, Events, ModalBuilder, ModalSubmitInteraction, ActionRowBuilder, TextInputBuilder, ButtonStyle, ComponentEmojiResolvable, TextInputStyle, LocalizationMap, Locale, Message as Message$1, ApplicationCommandOptionType, GuildMember, Attachment, User, Role, CommandInteractionOption, SlashCommandBuilder, ContextMenuCommandBuilder, PartialMessage } from 'discord.js';
+import { RESTPostAPIApplicationCommandsJSONBody, Client, Interaction, CacheType, ClientEvents, Awaitable, ButtonBuilder, ButtonInteraction, Events, ModalBuilder, ModalSubmitInteraction, ActionRowBuilder, TextInputBuilder, ButtonStyle, ComponentEmojiResolvable, TextInputStyle, LocalizationMap, Locale, Message as Message$1, ApplicationCommandOptionType, GuildMember, Attachment, User, Role, CommandInteractionOption, ChatInputCommandInteraction, MessageContextMenuCommandInteraction, UserContextMenuCommandInteraction, AutocompleteInteraction, Collection, SlashCommandBuilder, ContextMenuCommandBuilder, PartialMessage } from 'discord.js';
 import EventEmitter from 'node:events';
 import { Channel } from 'diagnostics_channel';
 import * as commander from 'commander';
@@ -25,42 +25,6 @@ interface CommandKitOptions {
      * The Discord.js client object to use with CommandKit.
      */
     client: Client;
-    /**
-     * The path to your commands directory.
-     */
-    commandsPath?: string;
-    /**
-     * The path to your events directory.
-     */
-    eventsPath?: string;
-    /**
-     * The path to the validations directory.
-     */
-    validationsPath?: string;
-    /**
-     * List of development guild IDs to restrict devOnly commands to.
-     */
-    devGuildIds?: string[];
-    /**
-     * List of developer user IDs to restrict devOnly commands to.
-     */
-    devUserIds?: string[];
-    /**
-     * List of developer role IDs to restrict devOnly commands to.
-     */
-    devRoleIds?: string[];
-    /**
-     * Skip CommandKit's built-in validations (for devOnly commands).
-     */
-    skipBuiltInValidations?: boolean;
-    /**
-     * Bulk register application commands instead of one-by-one.
-     */
-    bulkRegister?: boolean;
-    /**
-     * Whether or not to debug the command handler.
-     */
-    debugCommands?: boolean;
     /**
      * The cache provider to use with CommandKit. Defaults to MemoryCache provider.
      * Set this to `null` to not use any cache provider.
@@ -84,179 +48,9 @@ interface CommandContext<T extends Interaction, Cached extends CacheType> {
      */
     handler: CommandKit;
 }
-/**
- * Represents a command file.
- */
-interface CommandFileObject {
-    data: CommandData;
-    options?: CommandOptions;
-    run: <Cached extends CacheType = CacheType>(ctx: CommandContext<Interaction, Cached>) => Awaited<void>;
-    autocomplete?: <Cached extends CacheType = CacheType>(ctx: CommandContext<Interaction, Cached>) => Awaited<void>;
-    filePath: string;
-    category: string | null;
-    [key: string]: any;
-}
-/**
- * A reload type for commands.
- */
-type ReloadOptions = 'dev' | 'global' | ReloadType;
-/**
- * Props for command run functions.
- */
-interface CommandProps {
-    /**
-     * The current command interaction object.
-     */
-    interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction | UserContextMenuCommandInteraction | MessageContextMenuCommandInteraction | AutocompleteInteraction;
-    /**
-     * The Discord.js client object that CommandKit is handling.
-     */
-    client: Client<true>;
-    /**
-     * The current CommandKit handler instance.
-     */
-    handler: CommandKit;
-}
-/**
- * Props for autocomplete command run functions.
- */
-interface AutocompleteProps extends CommandProps {
-    /**
-     * The current autocomplete command interaction object.
-     */
-    interaction: AutocompleteInteraction;
-}
-/**
- * Props for slash (chat input) command run functions.
- */
-interface SlashCommandProps extends CommandProps {
-    /**
-     * The current slash (chat input) command interaction object.
-     */
-    interaction: ChatInputCommandInteraction;
-}
-/**
- * Props for context menu command run functions.
- */
-interface ContextMenuCommandProps extends CommandProps {
-    /**
-     * The current context menu command interaction object.
-     */
-    interaction: ContextMenuCommandInteraction;
-}
-/**
- * Props for user context menu command run functions.
- */
-interface UserContextMenuCommandProps extends CommandProps {
-    interaction: UserContextMenuCommandInteraction;
-}
-/**
- * Props for message context menu command run functions.
- */
-interface MessageContextMenuCommandProps extends CommandProps {
-    interaction: MessageContextMenuCommandInteraction;
-}
-/**
- * Props for command validation functions.
- */
-interface ValidationProps {
-    /**
-     * The current command interaction object.
-     */
-    interaction: ChatInputCommandInteraction | ContextMenuCommandInteraction | AutocompleteInteraction;
-    /**
-     * The Discord.js client object that CommandKit is handling.
-     */
-    client: Client<true>;
-    /**
-     * The current (local) target command object.
-     */
-    commandObj: CommandObject;
-    /**
-     * The current CommandKit handler instance.
-     */
-    handler: CommandKit;
-}
-/**
- * Additional command configuration options.
- */
-interface CommandOptions {
-    /**
-     * A boolean indicating whether the command is guild-only.
-     * Used for built-in validation.
-     *
-     * @deprecated Use `dm_permission` in the command's `data` object instead.
-     */
-    guildOnly?: boolean;
-    /**
-     * A boolean indicating whether the command is developer-only.
-     * Used for registration and built-in validation.
-     */
-    devOnly?: boolean;
-    /**
-     * A boolean indicating whether the command is deleted/ignored on restart/reload.
-     */
-    deleted?: boolean;
-    /**
-     * A string or array of permissions that a user needs for the current command to be executed.
-     * Used for built-in validation.
-     *
-     * @example
-     * userPermissions: 'BanMembers'
-     * or
-     * userPermissions: ['BanMembers', 'KickMembers']
-     */
-    userPermissions?: PermissionsString | PermissionsString[];
-    /**
-     * A string or array of permissions that the bot needs to execute the current command.
-     * Used for built-in validation.
-     *
-     * @example
-     * botPermissions: 'BanMembers'
-     * or
-     * botPermissions: ['BanMembers', 'KickMembers']
-     */
-    botPermissions?: PermissionsString | PermissionsString[];
-    [key: string]: any;
-}
 type CommandData = RESTPostAPIApplicationCommandsJSONBody & {
     guilds?: string[];
 };
-type CommandObject = {
-    /**
-     * An object which defines the structure of the application command.
-     */
-    data: CommandData;
-    /**
-     * Additional command configuration options.
-     */
-    options?: CommandOptions;
-    /**
-     * The path to the command file.
-     */
-    filePath: string;
-    /**
-     * The command's category. Determined based on the command folder.
-     *
-     * @example
-     * ```txt
-     * "/src/commands/ping.js" -> null
-     * "/src/commands/Misc/ping.js" -> "Misc"
-     * ```
-     */
-    category: string | null;
-    [key: string]: any;
-};
-declare enum ReloadType {
-    /**
-     * Reload developer/guild commands.
-     */
-    Developer = "dev",
-    /**
-     * Reload global commands.
-     */
-    Global = "global"
-}
 
 interface EventInterceptorContextData<E extends keyof ClientEvents> {
     /**
@@ -707,6 +501,7 @@ declare class MessageCommandOptions {
 
 type GenericFunction<A extends any[] = any[]> = (...args: A) => any;
 declare function exitContext<T>(fn: () => T): T;
+declare function provideContext<R>(value: CommandKitEnvironment, receiver: () => R): R;
 /**
  * Returns a context-aware version of the given function.
  * @param env - The commandkit environment data.
@@ -732,14 +527,6 @@ declare function getContext(): CommandKitEnvironment | undefined;
  * Use current commandkit context. Throws an error if no context is found.
  */
 declare function useEnvironment(): CommandKitEnvironment;
-/**
- * Ensures the command is only available in guilds.
- */
-declare function guildOnly(): void;
-/**
- * Ensures the command is only available in DMs.
- */
-declare function dmOnly(): void;
 
 interface CommandKitEnvironmentInternalData {
     executionError: Error | null;
@@ -1228,8 +1015,8 @@ declare class CommandsRouter {
         };
     }>;
     getData(): {
-        commands: Map<string, Command>;
-        middlewares: Map<string, Middleware>;
+        commands: Collection<string, Command>;
+        middlewares: Collection<string, Middleware>;
     };
     toJSON(): {
         commands: {
@@ -1267,7 +1054,7 @@ interface ParsedEvent {
     /** Namespace of the event */
     namespace: string | null;
 }
-/** Map of event names to their parsed metadata */
+/** Collection of event names to their parsed metadata */
 type EventsTree = Record<string, ParsedEvent>;
 /**
  * Router for discovering and managing event handler files in a directory structure.
@@ -1313,7 +1100,7 @@ declare class EventsRouter {
      */
     scan(): Promise<EventsTree>;
     /**
-     * Convert the internal events map to a plain object
+     * Convert the internal events Collection to a plain object
      * @returns Events tree as a plain object
      */
     toJSON(): EventsTree;
@@ -1379,7 +1166,7 @@ declare class AppCommandHandler {
     constructor(commandkit: CommandKit);
     getCommandsArray(): LoadedCommand[];
     registerCommandHandler(): void;
-    prepareCommandRun(source: Interaction | Message$1): Promise<PreparedAppCommandExecution | null>;
+    prepareCommandRun(source: Interaction | Message$1, cmdName?: string): Promise<PreparedAppCommandExecution | null>;
     reloadCommands(): Promise<void>;
     loadCommands(): Promise<void>;
     private loadMiddleware;
@@ -1596,6 +1383,10 @@ declare function rethrow(error: unknown): void;
  */
 declare function redirect(): never;
 
+type CommandSource = Interaction | Message$1;
+declare function isMessageSource(source: CommandSource): source is Message$1;
+declare function isInteractionSource(source: CommandSource): source is Interaction;
+
 declare abstract class RuntimePlugin<T extends PluginOptions = PluginOptions> extends PluginCommon<T, CommandKitPluginRuntime> {
     /**
      * Called before commands are loaded
@@ -1626,11 +1417,6 @@ declare abstract class RuntimePlugin<T extends PluginOptions = PluginOptions> ex
      * @param interaction The interaction
      */
     onBeforeInteraction(ctx: CommandKitPluginRuntime, interaction: Interaction): Promise<void>;
-    /**
-     * Called after interaction is handled
-     * @param interaction The interaction that was handled
-     */
-    onAfterInteraction(ctx: CommandKitPluginRuntime, interaction: Interaction): Promise<void>;
     /**
      * Called before message command is processed
      * @param message The message
@@ -1647,14 +1433,13 @@ declare abstract class RuntimePlugin<T extends PluginOptions = PluginOptions> ex
      * @param command The command
      * @param execute The function that executes the command
      */
-    executeCommand(ctx: CommandKitPluginRuntime, source: Interaction | Message$1, command: PreparedAppCommandExecution, execute: () => Promise<any>): Promise<boolean>;
+    executeCommand(ctx: CommandKitPluginRuntime, env: CommandKitEnvironment, source: Interaction | Message$1, command: PreparedAppCommandExecution, execute: () => Promise<any>): Promise<boolean>;
 }
 declare function isRuntimePlugin(plugin: unknown): plugin is RuntimePlugin;
 
-declare class CommandKitPluginRuntime extends EventTarget {
+declare class CommandKitPluginRuntime {
     readonly commandkit: CommandKit;
     private plugins;
-    private onClientLogin;
     constructor(commandkit: CommandKit);
     getPlugin(pluginName: string): RuntimePlugin | null;
     softRegisterPlugin(plugin: RuntimePlugin): Promise<void>;
@@ -1724,10 +1509,6 @@ declare class CommandKit extends EventEmitter {
      * Resolves the current cache provider.
      */
     getCacheProvider(): CacheProvider | null;
-    /**
-     * Whether or not to debug the command handler.
-     */
-    isDebuggingCommands(): boolean;
     /**
      * Get the client attached to this CommandKit instance.
      */
@@ -1740,30 +1521,6 @@ declare class CommandKit extends EventEmitter {
      * Updates application events with the latest from "eventsPath".
      */
     reloadEvents(): Promise<void>;
-    /**
-     * @returns The path to the commands folder which was set when instantiating CommandKit.
-     */
-    get commandsPath(): string | undefined;
-    /**
-     * @returns The path to the events folder which was set when instantiating CommandKit.
-     */
-    get eventsPath(): string | undefined;
-    /**
-     * @returns The path to the validations folder which was set when instantiating CommandKit.
-     */
-    get validationsPath(): string | undefined;
-    /**
-     * @returns An array of all the developer user IDs which was set when instantiating CommandKit.
-     */
-    get devUserIds(): string[];
-    /**
-     * @returns An array of all the developer guild IDs which was set when instantiating CommandKit.
-     */
-    get devGuildIds(): string[];
-    /**
-     * @returns An array of all the developer role IDs which was set when instantiating CommandKit.
-     */
-    get devRoleIds(): string[];
     /**
      * Increment the client listeners count.
      */
@@ -1934,4 +1691,4 @@ declare const version: string;
  */
 declare function bootstrapCommandkitCLI(argv: string[], options?: commander.ParseOptions | undefined): Promise<void>;
 
-export { ActionRow, type ActionRowProps, type AnyCommandExecute, type AnyCommandKitElement, type ApiTranslatableCommandOptions, AppCommandHandler, type AsyncFunction, type AutocompleteCommand, type AutocompleteCommandContext, type AutocompleteCommandMiddlewareContext, type AutocompleteProps, Button, type ButtonChildrenLike, ButtonKit, type ButtonKitPredicate, type ButtonProps, type CacheContext, type CacheEntry, type CacheMetadata, CacheProvider, type Command, type CommandContext, type CommandContextOptions, type CommandData, CommandExecutionMode, type CommandFileObject, CommandKit, type CommandKitButtonBuilderInteractionCollectorDispatch, type CommandKitButtonBuilderInteractionCollectorDispatchContextData, type CommandKitButtonBuilderOnEnd, type CommandKitConfiguration, type CommandKitElement, type CommandKitElementData, CommandKitEnvironment, type CommandKitEnvironmentInternalData, CommandKitEnvironmentType, type CommandKitLoggerOptions, type CommandKitModalBuilderInteractionCollectorDispatch, type CommandKitModalBuilderInteractionCollectorDispatchContextData, type CommandKitModalBuilderOnEnd, type CommandKitOptions, type CommandKitPlugin, CommandKitPluginRuntime, type CommandLocalizationTypeData, type CommandObject, type CommandOptions, type CommandProps, type CommandTypeData, CommandsRouter, type CommandsRouterOptions, type CommonPluginRuntime, CompilerPlugin, CompilerPluginRuntime, Context, type ContextMenuCommandProps, type ContextParameters, DefaultLocalizationStrategy, DefaultLogger, ElementType, EventInterceptor, type EventInterceptorContextData, type EventInterceptorErrorHandler, EventsRouter, type EventsRouterOptions, type EventsTree, Fragment, type FragmentElementProps, type GenericFunction, type ILogger, type InteractionCommandContext, type InteractionCommandMiddlewareContext, type LoadedCommand, type Loader, Localization, type LocalizationConfig, type LocalizationStrategy, type LocalizationTranslationRequest, type Location, Logger, type LoggerImpl, type MaybeArray, type MaybeFalsey, MemoryCache, type Message, type MessageCommand, type MessageCommandContext, type MessageCommandMiddlewareContext, MessageCommandOptions, type MessageCommandOptionsSchema, MessageCommandParser, type MessageContextMenuCommand, type MessageContextMenuCommandContext, type MessageContextMenuCommandMiddlewareContext, type MessageContextMenuCommandProps, type Middleware, MiddlewareContext, type MiddlewareContextArgs, Modal, ModalKit, type ModalKitPredicate, type ModalProps, type OnButtonKitClick, type OnButtonKitEnd, type OnLoadArgs, type OnLoadOptions, type OnLoadResult, type OnModalKitEnd, type OnModalKitSubmit, type OnResolveArgs, type OnResolveOptions, type OnResolveResult, ParagraphInput, type ParsedCommandData, type ParsedEvent, type ParsedMessageCommand, type PluginTransformParameters, type PreparedAppCommandExecution, type ReloadOptions, ReloadType, type ResolvableCommand, type ResolveKind, type ResolveResult, type RunCommand, RuntimePlugin, type Setup, ShortInput, type SlashCommand, type SlashCommandContext, type SlashCommandMiddlewareContext, type SlashCommandProps, TextInput, type TextInputProps, type TransformedResult, type TranslatableArguments, type TranslatableCommand, type TranslatableCommandName, type TranslatableCommandOptions, type Translation, type TranslationResult, type Translator, type UserContextMenuCommand, type UserContextMenuCommandContext, type UserContextMenuCommandMiddlewareContext, type UserContextMenuCommandProps, type ValidationProps, afterCommand, bootstrapCommandkitCLI, cache, cacheLife, cacheTag, cancelAfterCommand, commandkit, createElement, createLogger, CommandKit as default, defineConfig, dmOnly, exitContext, exitMiddleware, fromEsbuildPlugin, getCommandKit, getConfig, getContext, getElement, guildOnly, invalidate, isCachedFunction, isCommandKitElement, isCompilerPlugin, isRuntimePlugin, makeContextAwareFunction, redirect, rethrow, revalidate, useCache as super_duper_secret_internal_for_use_cache_directive_of_commandkit_cli_do_not_use_it_directly_or_you_will_be_fired_from_your_job_kthxbai, useEnvironment, version };
+export { ActionRow, type ActionRowProps, type AnyCommandExecute, type AnyCommandKitElement, type ApiTranslatableCommandOptions, AppCommandHandler, type AsyncFunction, type AutocompleteCommand, type AutocompleteCommandContext, type AutocompleteCommandMiddlewareContext, Button, type ButtonChildrenLike, ButtonKit, type ButtonKitPredicate, type ButtonProps, type CacheContext, type CacheEntry, type CacheMetadata, CacheProvider, type Command, type CommandContext, type CommandContextOptions, type CommandData, CommandExecutionMode, CommandKit, type CommandKitButtonBuilderInteractionCollectorDispatch, type CommandKitButtonBuilderInteractionCollectorDispatchContextData, type CommandKitButtonBuilderOnEnd, type CommandKitConfiguration, type CommandKitElement, type CommandKitElementData, CommandKitEnvironment, type CommandKitEnvironmentInternalData, CommandKitEnvironmentType, type CommandKitLoggerOptions, type CommandKitModalBuilderInteractionCollectorDispatch, type CommandKitModalBuilderInteractionCollectorDispatchContextData, type CommandKitModalBuilderOnEnd, type CommandKitOptions, type CommandKitPlugin, CommandKitPluginRuntime, type CommandLocalizationTypeData, type CommandSource, type CommandTypeData, CommandsRouter, type CommandsRouterOptions, type CommonPluginRuntime, CompilerPlugin, CompilerPluginRuntime, Context, type ContextParameters, DefaultLocalizationStrategy, DefaultLogger, ElementType, EventInterceptor, type EventInterceptorContextData, type EventInterceptorErrorHandler, EventsRouter, type EventsRouterOptions, type EventsTree, Fragment, type FragmentElementProps, type GenericFunction, type ILogger, type InteractionCommandContext, type InteractionCommandMiddlewareContext, type LoadedCommand, type Loader, Localization, type LocalizationConfig, type LocalizationStrategy, type LocalizationTranslationRequest, type Location, Logger, type LoggerImpl, type MaybeArray, type MaybeFalsey, MemoryCache, type Message, type MessageCommand, type MessageCommandContext, type MessageCommandMiddlewareContext, MessageCommandOptions, type MessageCommandOptionsSchema, MessageCommandParser, type MessageContextMenuCommand, type MessageContextMenuCommandContext, type MessageContextMenuCommandMiddlewareContext, type Middleware, MiddlewareContext, type MiddlewareContextArgs, Modal, ModalKit, type ModalKitPredicate, type ModalProps, type OnButtonKitClick, type OnButtonKitEnd, type OnLoadArgs, type OnLoadOptions, type OnLoadResult, type OnModalKitEnd, type OnModalKitSubmit, type OnResolveArgs, type OnResolveOptions, type OnResolveResult, ParagraphInput, type ParsedCommandData, type ParsedEvent, type ParsedMessageCommand, type PluginTransformParameters, type PreparedAppCommandExecution, type ResolvableCommand, type ResolveKind, type ResolveResult, type RunCommand, RuntimePlugin, type Setup, ShortInput, type SlashCommand, type SlashCommandContext, type SlashCommandMiddlewareContext, TextInput, type TextInputProps, type TransformedResult, type TranslatableArguments, type TranslatableCommand, type TranslatableCommandName, type TranslatableCommandOptions, type Translation, type TranslationResult, type Translator, type UserContextMenuCommand, type UserContextMenuCommandContext, type UserContextMenuCommandMiddlewareContext, afterCommand, bootstrapCommandkitCLI, cache, cacheLife, cacheTag, cancelAfterCommand, commandkit, createElement, createLogger, CommandKit as default, defineConfig, exitContext, exitMiddleware, fromEsbuildPlugin, getCommandKit, getConfig, getContext, getElement, invalidate, isCachedFunction, isCommandKitElement, isCompilerPlugin, isInteractionSource, isMessageSource, isRuntimePlugin, makeContextAwareFunction, provideContext, redirect, rethrow, revalidate, useCache as super_duper_secret_internal_for_use_cache_directive_of_commandkit_cli_do_not_use_it_directly_or_you_will_be_fired_from_your_job_kthxbai, useEnvironment, version };