commandkit 0.1.11-dev.20250306101654 → 0.1.11-dev.20250306152436

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, Locale, Message as Message$1, ApplicationCommandOptionType, GuildMember, Attachment, User, Role, CommandInteractionOption, SlashCommandBuilder, ContextMenuCommandBuilder, PartialMessage } 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, Locale, Message as Message$1, ApplicationCommandOptionType, GuildMember, Attachment, User, Role, CommandInteractionOption, Collection, SlashCommandBuilder, ContextMenuCommandBuilder, PartialMessage } from 'discord.js';
 import EventEmitter from 'node:events';
 import { Channel } from 'diagnostics_channel';
 import * as commander from 'commander';
@@ -1007,164 +1007,131 @@ declare class MiddlewareContext<T extends CommandExecutionMode = CommandExecutio
     cancel(): void;
 }
 
-/**
- * Matcher type for identifying command and middleware files.
- * Can be a string suffix (e.g. '.cmd.js'), RegExp pattern, or custom matcher function.
- */
-type CommandsRouterMatcher = string | RegExp | ((path: string) => boolean);
-/**
- * Maps file type identifiers to their respective matchers.
- * Used to identify command and middleware files in the directory structure.
- */
-type CommandsRouterMatchersMap = Record<'command' | 'middleware', CommandsRouterMatcher>;
-/**
- * Configuration options for the CommandsRouter
- */
-interface CommandsRouterOptions {
+interface ParsedCommand {
     /**
-     * The path to the directory containing the command files.
+     * The unique identifier of this command.
      */
-    entrypoint: string;
+    id: string;
     /**
-     * The path to the directory containing the middleware files.
+     * The file name without the extension.
      */
-    matcher?: Partial<CommandsRouterMatchersMap>;
-}
-/**
- * Represents a parsed command with its metadata
- * @interface ParsedCommand
- */
-interface ParsedCommand {
-    /** Command name derived from the file name without extension */
     name: string;
-    /** Absolute file system path to the command file */
-    path: string;
-    /** Parent command name for nested commands, or null if root-level command */
-    parent: string | null;
-    /** Array of command segments representing the command hierarchy */
-    parentSegments: string[];
-    /** Array of middleware IDs that apply to this command */
-    middlewares: string[];
-    /** Absolute path to this command */
-    fullPath: string;
-    /** Category the command belongs to, if any */
+    /**
+     * The full path to the command file.
+     * This can be null for directories that function as command groups but have no index file.
+     */
+    path: string | null;
+    /**
+     * The category of the command.
+     */
     category: string | null;
+    /**
+     * The subcommands of this command parsed from `(category)` format, but omitting the brackets.
+     */
+    subcommands: string[];
+    /**
+     * The middlewares of this command.
+     */
+    middlewares: string[];
 }
-/**
- * Represents a parsed middleware with its metadata
- * @interface ParsedMiddleware
- */
-interface ParsedMiddleware {
-    /** Unique identifier used to reference this middleware */
+interface ParsedSubCommand {
+    /**
+     * The unique identifier of this subcommand.
+     */
     id: string;
-    /** Middleware name derived from the file path */
+    /**
+     * The file name without the extension.
+     */
     name: string;
-    /** Path to the middleware file, relative to the entrypoint */
+    /**
+     * The full path to the subcommand file.
+     */
     path: string;
-    /** Absolute path to the middleware file */
-    fullPath: string;
-    /** Category the middleware belongs to, if any */
+    /**
+     * The category of the subcommand parsed from `(category)` format, but omitting the brackets.
+     */
     category: string | null;
-}
-/**
- * Complete tree structure of all commands and middleware
- * @interface CommandsTree
- */
-interface CommandsTree {
-    /** Map of command names to their parsed metadata */
-    commands: Record<string, ParsedCommand>;
-    /** Map of middleware IDs to their parsed metadata */
-    middleware: Record<string, ParsedMiddleware>;
-}
-/**
- * Result of a successful command match operation
- * @interface CommandMatchResult
- */
-interface CommandMatchResult {
-    /** The matched command metadata */
-    command: ParsedCommand;
-    /** Array of middleware that apply to the matched command */
-    middlewares: ParsedMiddleware[];
-}
-/**
- * CommandsRouter handles the discovery and routing of commands and middleware files
- * in a directory structure. It supports nested commands and middleware inheritance.
- */
-declare class CommandsRouter {
-    private readonly options;
-    private commands;
-    private middlewares;
     /**
-     * Creates a new CommandsRouter instance
-     * @param options - Configuration options for the router
+     * The subcommand group name for this subcommand.
      */
-    constructor(options: CommandsRouterOptions);
+    group: string | null;
     /**
-     * Gets the configured entrypoint directory
+     * The middlewares of this subcommand.
      */
-    get entrypoint(): string;
+    middlewares: string[];
+}
+interface ParsedMiddleware {
     /**
-     * Gets the configured matchers for command and middleware files
+     * The file name without the extension.
      */
-    get matchers(): CommandsRouterMatchersMap;
+    name: string;
     /**
-     * Returns the cached data of the commands and middleware
+     * The unique identifier of this middleware.
      */
-    getData(): {
-        commands: Map<string, ParsedCommand>;
-        middleware: Map<string, ParsedMiddleware>;
-    };
+    id: string;
     /**
-     * Checks if the entrypoint path is valid
+     * The full path to this middleware file.
      */
-    isValidPath(): boolean;
+    path: string;
     /**
-     * Executes a matcher against a file path
-     * @param matcher - The matcher to use
-     * @param path - The file path to test
-     * @returns boolean indicating if the path matches
+     * The category of this middleware.
      */
-    private execMatcher;
+    category: string | null;
+}
+interface CommandsTree {
     /**
-     * Converts an absolute path to a path relative to the entrypoint
-     * @param path - The absolute path to convert
+     * The record of commands mapped by their unique identifiers.
      */
-    private resolveRelativePath;
+    commands: Record<string, ParsedCommand>;
     /**
-     * Matches a command by name or path segments
-     * @param commandOrSegment - Command name or array of path segments
-     * @returns Matched command and its middlewares, or null if no match
+     * The record of subcommands mapped by their unique identifiers.
      */
-    match(commandOrSegment: string | string[]): CommandMatchResult | null;
+    subcommands: Record<string, ParsedSubCommand>;
     /**
-     * Reloads the commands tree by re-scanning the entrypoint directory
+     * The record of middlewares mapped by their unique identifiers.
      */
-    reload(): Promise<CommandsTree>;
+    middlewares: Record<string, ParsedMiddleware>;
+}
+interface ParsedCommandsData {
     /**
-     * Clears the internal commands and middleware maps
+     * The collection of parsed commands.
      */
-    clear(): void;
+    commands: Collection<string, ParsedCommand>;
     /**
-     * Scans the entrypoint directory for commands and middleware
-     * @returns Promise resolving to the complete commands tree
+     * The collection of parsed subcommands.
      */
-    scan(): Promise<CommandsTree>;
+    subcommands: Collection<string, ParsedSubCommand>;
     /**
-     * Converts the internal maps to a serializable object
-     * @returns CommandsTree containing all commands and middleware
+     * The collection of parsed middlewares.
      */
-    toJSON(): CommandsTree;
+    middlewares: Collection<string, ParsedMiddleware>;
+}
+interface CommandsRouterOptions {
     /**
-     * Recursively scans a directory for files
-     * @param dir - Directory to scan
-     * @param entries - Accumulator for found files
-     * @returns Promise resolving to array of file paths
+     * The entrypoint directory to scan for commands.
      */
+    entrypoint: string;
+}
+declare class CommandsRouter {
+    private readonly options;
+    private commands;
+    private subcommands;
+    private middlewares;
+    constructor(options: CommandsRouterOptions);
+    get entrypoint(): string;
+    isValidPath(): boolean;
+    getData(): ParsedCommandsData;
+    toJSON(): CommandsTree;
+    clear(): void;
+    reload(): Promise<CommandsTree>;
+    scan(): Promise<CommandsTree>;
     private scanDirectory;
-    private isIgnoredFile;
-    private isCommandFile;
-    private parseCategories;
-    private parseCommandPath;
+    private processMiddlewares;
+    private processCommand;
+    private processCommandDirectory;
+    private processSubCommand;
+    private parseNameAndCategory;
+    private findAssociatedMiddlewares;
 }
 
 /**
@@ -1261,6 +1228,10 @@ declare class CommandRegistrar {
      * Gets the commands data.
      */
     getCommandsData(): CommandData[];
+    /**
+     * Process and merge subcommands into the parent command's options
+     */
+    private processSubcommands;
     /**
      * Registers loaded commands.
      */
@@ -1290,6 +1261,7 @@ interface AppCommandMiddleware {
 interface LoadedCommand {
     command: ParsedCommand;
     data: AppCommand;
+    subcommands?: ParsedSubCommand[];
     guilds?: string[];
 }
 interface LoadedMiddleware {
@@ -1298,26 +1270,41 @@ interface LoadedMiddleware {
 }
 interface PreparedAppCommandExecution {
     command: LoadedCommand;
+    subcommand?: LoadedSubCommand | null;
     middlewares: LoadedMiddleware[];
     messageCommandParser?: MessageCommandParser;
 }
+interface LoadedSubCommand {
+    subcommand: ParsedSubCommand;
+    data: AppCommand;
+}
 type CommandBuilderLike = SlashCommandBuilder | ContextMenuCommandBuilder | Record<string, any>;
 declare class AppCommandHandler {
     readonly commandkit: CommandKit;
     private loadedCommands;
+    private loadedSubCommands;
     private loadedMiddlewares;
+    private commandNameToId;
+    private subcommandPathToId;
     readonly registrar: CommandRegistrar;
     private onInteraction;
     private onMessageCreate;
     private onMessageUpdate;
     constructor(commandkit: CommandKit);
     getCommandsArray(): LoadedCommand[];
+    /**
+     * Get subcommand data by ID for the command registrar
+     */
+    getSubcommandData(id: string): any;
     registerCommandHandler(): void;
     getExecutionMode(source: Interaction | Message$1): CommandExecutionMode;
-    runCommand(command: PreparedAppCommandExecution, source: Interaction | Message$1): Promise<void>;
+    runCommand(prepared: PreparedAppCommandExecution, source: Interaction | Message$1): Promise<void>;
     prepareCommandRun(source: Interaction | Message$1): Promise<PreparedAppCommandExecution | null>;
     reloadCommands(): Promise<void>;
     loadCommands(): Promise<void>;
+    private loadMiddleware;
+    private loadCommand;
+    private loadSubcommand;
     applyLocalizations(command: CommandBuilderLike): Promise<discord_js.RESTPostAPIContextMenuApplicationCommandsJSONBody | CommandBuilderLike>;
 }
 
@@ -1965,4 +1952,4 @@ declare const version: string;
  */
 declare function bootstrapCommandkitCLI(argv: string[], options?: commander.ParseOptions | undefined): Promise<void>;
 
-export { ActionRow, type ActionRowProps, type AnyCommandExecute, type AnyCommandKitElement, 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 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 CommandMatchResult, type CommandObject, type CommandOptions, type CommandProps, CommandsRouter, type CommandsRouterMatcher, type CommandsRouterMatchersMap, type CommandsRouterOptions, type CommandsTree, 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, Localization, type LocalizationConfig, type LocalizationStrategy, type LocalizationTranslationRequest, Logger, type LoggerImpl, type MaybeArray, MemoryCache, type MessageCommand, type MessageCommandContext, type MessageCommandMiddlewareContext, MessageCommandOptions, type MessageCommandOptionsSchema, MessageCommandParser, type MessageContextMenuCommand, type MessageContextMenuCommandContext, type MessageContextMenuCommandMiddlewareContext, type MessageContextMenuCommandProps, MiddlewareContext, Modal, ModalKit, type ModalKitPredicate, type ModalProps, type OnButtonKitClick, type OnButtonKitEnd, type OnModalKitEnd, type OnModalKitSubmit, ParagraphInput, type ParsedCommand, type ParsedEvent, type ParsedMessageCommand, type ParsedMiddleware, type PreparedAppCommandExecution, type ReloadOptions, ReloadType, ShortInput, type SlashCommand, type SlashCommandContext, type SlashCommandMiddlewareContext, type SlashCommandProps, TextInput, type TextInputProps, type TranslatableArguments, type TranslatableCommand, type TranslatableCommandOptions, type Translation, type TranslationResult, type Translator, type UserContextMenuCommand, type UserContextMenuCommandContext, type UserContextMenuCommandMiddlewareContext, type UserContextMenuCommandProps, type ValidationProps, afterCommand, bootstrapCommandkitCLI, cache, cacheLife, cacheTag, cancelAfterCommand, createElement, createLogger, CommandKit as default, defineConfig, dmOnly, exitContext, exitMiddleware, getCommandKit, getConfig, getContext, getElement, guildOnly, invalidate, isCachedFunction, isCommandKitElement, 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, 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 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 CommandObject, type CommandOptions, type CommandProps, CommandsRouter, type CommandsRouterOptions, type CommandsTree, 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, Localization, type LocalizationConfig, type LocalizationStrategy, type LocalizationTranslationRequest, Logger, type LoggerImpl, type MaybeArray, MemoryCache, type MessageCommand, type MessageCommandContext, type MessageCommandMiddlewareContext, MessageCommandOptions, type MessageCommandOptionsSchema, MessageCommandParser, type MessageContextMenuCommand, type MessageContextMenuCommandContext, type MessageContextMenuCommandMiddlewareContext, type MessageContextMenuCommandProps, MiddlewareContext, Modal, ModalKit, type ModalKitPredicate, type ModalProps, type OnButtonKitClick, type OnButtonKitEnd, type OnModalKitEnd, type OnModalKitSubmit, ParagraphInput, type ParsedCommand, type ParsedCommandsData, type ParsedEvent, type ParsedMessageCommand, type ParsedMiddleware, type ParsedSubCommand, type PreparedAppCommandExecution, type ReloadOptions, ReloadType, ShortInput, type SlashCommand, type SlashCommandContext, type SlashCommandMiddlewareContext, type SlashCommandProps, TextInput, type TextInputProps, type TranslatableArguments, type TranslatableCommand, type TranslatableCommandOptions, type Translation, type TranslationResult, type Translator, type UserContextMenuCommand, type UserContextMenuCommandContext, type UserContextMenuCommandMiddlewareContext, type UserContextMenuCommandProps, type ValidationProps, afterCommand, bootstrapCommandkitCLI, cache, cacheLife, cacheTag, cancelAfterCommand, createElement, createLogger, CommandKit as default, defineConfig, dmOnly, exitContext, exitMiddleware, getCommandKit, getConfig, getContext, getElement, guildOnly, invalidate, isCachedFunction, isCommandKitElement, 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 };