commandkit 1.0.0-dev.20250511124349 → 1.0.0-dev.20250512143211

package/dist/index.d.ts

@@ -2,22 +2,10 @@ import * as discord_js from 'discord.js';
 import { RESTPostAPIApplicationCommandsJSONBody, Client, Interaction, CacheType, ClientEvents, Awaitable, ButtonBuilder, ButtonInteraction, Events, ModalBuilder, ModalSubmitInteraction, ActionRowBuilder, TextInputBuilder, ButtonStyle, ComponentEmojiResolvable, TextInputStyle, StringSelectMenuInteraction, StringSelectMenuBuilder, ChannelSelectMenuInteraction, ChannelSelectMenuBuilder, MentionableSelectMenuInteraction, MentionableSelectMenuBuilder, UserSelectMenuInteraction, UserSelectMenuBuilder, RoleSelectMenuInteraction, RoleSelectMenuBuilder, BaseSelectMenuComponentData, StringSelectMenuOptionBuilder, SelectMenuComponentOptionData, APISelectMenuOption, UserSelectMenuComponentData, RoleSelectMenuComponentData, MentionableSelectMenuComponentData, ChannelSelectMenuComponentData, ContainerComponentData, ComponentBuilder, ContainerBuilder, FileComponentData, FileBuilder, MediaGalleryItemBuilder, MediaGalleryBuilder, ThumbnailBuilder, TextDisplayBuilder, SectionBuilder, SeparatorComponentData, SeparatorBuilder, TextDisplayComponentData, Message as Message$1, ApplicationCommandOptionType, GuildMember, Attachment, User, Role, CommandInteractionOption, ChatInputCommandInteraction, MessageContextMenuCommandInteraction, UserContextMenuCommandInteraction, AutocompleteInteraction, Guild, TextBasedChannel, Locale, Collection, SlashCommandBuilder, ContextMenuCommandBuilder } from 'discord.js';
 import EventEmitter from 'node:events';
 import { Channel } from 'diagnostics_channel';
+import { DirectiveTransformerOptions } from 'directive-to-hof';
 import { AsyncLocalStorage } from 'node:async_hooks';
 import * as commander from 'commander';
 
-interface CacheEntry<T = unknown> {
-    value: T;
-    ttl?: number;
-}
-declare abstract class CacheProvider {
-    abstract get<T>(key: string): Promise<CacheEntry<T> | undefined>;
-    abstract set<T>(key: string, value: T, ttl?: number): Promise<void>;
-    abstract exists(key: string): Promise<boolean>;
-    abstract delete(key: string): Promise<void>;
-    abstract clear(): Promise<void>;
-    abstract expire(key: string, ttl: number): Promise<void>;
-}
-
 /**
  * Options for instantiating a CommandKit handler.
  */
@@ -26,11 +14,6 @@ interface CommandKitOptions {
      * The Discord.js client object to use with CommandKit.
      */
     client: Client;
-    /**
-     * The cache provider to use with CommandKit. Defaults to MemoryCache provider.
-     * Set this to `null` to not use any cache provider.
-     */
-    cacheProvider?: CacheProvider | null;
 }
 /**
  * Represents a command context.
@@ -730,6 +713,12 @@ declare class MessageCommandOptions {
 }
 
 type GenericFunction<A extends any[] = any[]> = (...args: A) => any;
+/**
+ * Represents an async function that can be cached
+ * @template R - Array of argument types
+ * @template T - Return type
+ */
+type AsyncFunction<R extends any[] = any[], T = any> = (...args: R) => Promise<T>;
 declare function exitContext<T>(fn: () => T): T;
 declare function provideContext<R>(value: CommandKitEnvironment, receiver: () => R): R;
 /**
@@ -1109,124 +1098,6 @@ declare class MiddlewareContext<T extends CommandExecutionMode = CommandExecutio
     setCommandRunner(fn: RunCommand): void;
 }
 
-declare class MemoryCache extends CacheProvider {
-    #private;
-    get<T>(key: string): Promise<CacheEntry<T> | undefined>;
-    set<T>(key: string, value: T, ttl?: number): Promise<void>;
-    exists(key: string): Promise<boolean>;
-    delete(key: string): Promise<void>;
-    clear(): Promise<void>;
-    expire(key: string, ttl: number): Promise<void>;
-}
-
-/**
- * Context for managing cache operations within an async scope
- */
-interface CacheContext {
-    params: {
-        /** Custom name for the cache entry */
-        name?: string;
-        /** Time-to-live in milliseconds */
-        ttl?: number;
-    };
-}
-/**
- * Represents an async function that can be cached
- * @template R - Array of argument types
- * @template T - Return type
- */
-type AsyncFunction<R extends any[] = any[], T = any> = (...args: R) => Promise<T>;
-/**
- * Configuration options for cache behavior
- */
-interface CacheMetadata {
-    /** Time-to-live duration in milliseconds or as a string (e.g., '1h', '5m') */
-    ttl?: number | string;
-    /** Custom name for the cache entry */
-    name?: string;
-}
-/**
- * Wraps an async function with caching capability
- * @template R - Array of argument types
- * @template F - Type of the async function
- * @param fn - The async function to cache
- * @param params - Optional cache configuration
- * @returns The wrapped function with caching behavior
- * @example
- * ```ts
- * const cachedFetch = cache(async (id: string) => {
- *   return await db.findOne(id);
- * }, { ttl: '1h' });
- * ```
- */
-declare function cache<R extends any[], F extends AsyncFunction<R>>(fn: F, params?: CacheMetadata): F;
-/**
- * Sets a custom identifier for the current cache operation
- * @param tag - The custom cache tag
- * @throws {Error} When called outside a cached function or without a tag
- * @example
- * ```ts
- * const fetchUser = cache(async (id: string) => {
- *   cacheTag(`user:${id}`);
- *   return await db.users.findOne(id);
- * });
- * ```
- */
-declare function cacheTag(tag: string): void;
-/**
- * Sets the TTL for the current cache operation
- * @param ttl - Time-to-live in milliseconds or as a string (e.g., '1h', '5m')
- * @throws {Error} When called outside a cached function or with invalid TTL
- * @example
- * ```ts
- * const fetchData = cache(async () => {
- *   cacheLife('30m');
- *   return await expensiveOperation();
- * });
- * ```
- */
-declare function cacheLife(ttl: number | string): void;
-/**
- * Removes a cached value by its tag
- * @param tag - The cache tag to invalidate
- * @throws {Error} When the cache key is not found
- * @example
- * ```ts
- * await invalidate('user:123');
- * ```
- */
-declare function invalidate(tag: string): Promise<void>;
-/**
- * Forces a refresh of cached data by its tag (on-demand revalidation)
- * @template T - Type of the cached value
- * @param tag - The cache tag to revalidate
- * @param args - Arguments to pass to the cached function
- * @returns Fresh data from the cached function
- * @throws {Error} When the cache key or function is not found
- * @example
- * ```ts
- * const freshData = await revalidate('user:123');
- * ```
- */
-declare function revalidate<T = unknown>(tag: string, ...args: any[]): Promise<T>;
-/**
- * Checks if a function is wrapped with cache functionality
- * @param fn - Function to check
- * @returns True if the function is cached
- * @example
- * ```ts
- * if (isCachedFunction(myFunction)) {
- *   console.log('Function is cached');
- * }
- * ```
- */
-declare function isCachedFunction(fn: GenericFunction): boolean;
-/**
- * @private
- * @internal
- */
-declare const __SECRET_USE_CACHE_INTERNAL_DO_NOT_USE_OR_YOU_WILL_BE_FIRED: any;
-
 interface Command {
     id: string;
     name: string;
@@ -1573,6 +1444,7 @@ interface CommandKitHMREvent {
 }
 
 declare abstract class RuntimePlugin<T extends PluginOptions = PluginOptions> extends PluginCommon<T, CommandKitPluginRuntime> {
+    readonly type = PluginType.Runtime;
     /**
      * Called before commands are loaded
      */
@@ -1690,6 +1562,7 @@ interface ResolveResult {
     external?: boolean;
 }
 declare abstract class CompilerPlugin<T extends PluginOptions = PluginOptions> extends PluginCommon<T, CompilerPluginRuntime> {
+    readonly type = PluginType.Compiler;
     /**
      * Called when transformation is requested to this plugin
      * @param params The parameters for the transformation
@@ -1713,6 +1586,16 @@ declare abstract class CompilerPlugin<T extends PluginOptions = PluginOptions> e
 }
 declare function isCompilerPlugin(plugin: unknown): plugin is CompilerPlugin;
 
+type CommonDirectiveTransformerOptions = DirectiveTransformerOptions & {
+    enabled?: boolean;
+};
+declare abstract class CommonDirectiveTransformer extends CompilerPlugin<CommonDirectiveTransformerOptions> {
+    private transformer;
+    activate(ctx: CompilerPluginRuntime): Promise<void>;
+    deactivate(ctx: CompilerPluginRuntime): Promise<void>;
+    transform(params: PluginTransformParameters): Promise<MaybeFalsey<TransformedResult>>;
+}
+
 declare class CompilerPluginRuntime {
     private readonly plugins;
     readonly name = "CompilerPluginRuntime";
@@ -1737,8 +1620,13 @@ declare function fromEsbuildPlugin(plugin: any): typeof CompilerPlugin;
 type CommonPluginRuntime = CommandKitPluginRuntime | CompilerPluginRuntime;
 
 type PluginOptions = Record<string, any>;
+declare enum PluginType {
+    Compiler = "compiler",
+    Runtime = "runtime"
+}
 declare abstract class PluginCommon<T extends PluginOptions = PluginOptions, C extends CommonPluginRuntime = CommonPluginRuntime> {
     protected readonly options: T;
+    abstract readonly type: PluginType;
     readonly id: `${string}-${string}-${string}-${string}-${string}`;
     readonly loadedAt: number;
     abstract readonly name: string;
@@ -1846,15 +1734,6 @@ declare class CommandKit extends EventEmitter {
      * @param locale The default locale.
      */
     setDefaultLocale(locale: Locale): this;
-    /**
-     * Sets the cache provider.
-     * @param provider The cache provider.
-     */
-    setCacheProvider(provider: CacheProvider): this;
-    /**
-     * Resolves the current cache provider.
-     */
-    getCacheProvider(): CacheProvider | null;
     /**
      * Get the client attached to this CommandKit instance.
      */
@@ -1888,8 +1767,9 @@ declare class CommandKit extends EventEmitter {
 interface CommandKitConfig {
     /**
      * The plugins to use with CommandKit.
+     * Can be a single plugin, an array of plugins, or a nested array of plugins.
      */
-    plugins?: MaybeArray<CommandKitPlugin[]>;
+    plugins?: MaybeArray<CommandKitPlugin>[] | Array<CommandKitPlugin>;
     /**
      * The esbuild plugins to use with CommandKit.
      */
@@ -1908,15 +1788,6 @@ interface CommandKitConfig {
              */
             development?: boolean;
         };
-        /**
-         * Cached function compiler configuration.
-         */
-        cache?: {
-            /**
-             * Whether to enable caching of compiled functions in development mode.
-             */
-            development?: boolean;
-        };
     };
     /**
      * The typescript configuration to use with CommandKit.
@@ -2076,4 +1947,4 @@ declare function getEventWorkerContext(): EventWorkerContext;
  */
 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 BootstrapFunction, Button, type ButtonChildrenLike, ButtonKit, type ButtonKitPredicate, type ButtonProps, COMMANDKIT_BOOTSTRAP_MODE, COMMANDKIT_CACHE_TAG, COMMANDKIT_IS_DEV, COMMANDKIT_IS_TEST, type CacheContext, type CacheEntry, type CacheMetadata, CacheProvider, ChannelSelectMenu, ChannelSelectMenuKit, type ChannelSelectMenuKitPredicate, type ChannelSelectMenuProps, type ChatInputCommand, type ChatInputCommandContext, type Command, type CommandBuilderLike, 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 CommandKitHMREvent, type CommandKitLoggerOptions, type CommandKitModalBuilderInteractionCollectorDispatch, type CommandKitModalBuilderInteractionCollectorDispatchContextData, type CommandKitModalBuilderOnEnd, type CommandKitOptions, type CommandKitPlugin, CommandKitPluginRuntime, type CommandKitSelectMenuBuilderInteractionCollectorDispatch, type CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData, type CommandKitSelectMenuBuilderOnEnd, CommandRegistrar, type CommandSource, type CommandTypeData, CommandsRouter, type CommandsRouterOptions, type CommonBuilderKit, type CommonPluginRuntime, type CommonSelectMenuProps, CompilerPlugin, CompilerPluginRuntime, Container, type ContainerProps, Context, type ContextParameters, DefaultLogger, ElementType, EventInterceptor, type EventInterceptorContextData, type EventInterceptorErrorHandler, type EventWorkerContext, EventsRouter, type EventsRouterOptions, type EventsTree, File, type FileProps, Fragment, type FragmentElementProps, type GenericFunction, HMREventType, type ILogger, type InteractionCommandContext, type InteractionCommandMiddlewareContext, type LoadedCommand, type Loader, type Location, Logger, type LoggerImpl, type MaybeArray, type MaybeFalsey, MediaGallery, MediaGalleryItem, type MediaGalleryItemProps, type MediaGalleryProps, MemoryCache, MentionableSelectMenu, MentionableSelectMenuKit, type MentionableSelectMenuKitPredicate, type MentionableSelectMenuProps, 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 OnChannelSelectMenuKitSubmit, type OnLoadArgs, type OnLoadOptions, type OnLoadResult, type OnMentionableSelectMenuKitSubmit, type OnModalKitEnd, type OnModalKitSubmit, type OnResolveArgs, type OnResolveOptions, type OnResolveResult, type OnRoleSelectMenuKitSubmit, type OnSelectMenuKitEnd, type OnSelectMenuKitSubmit, type OnStringSelectMenuKitSubmit, type OnUserSelectMenuKitSubmit, ParagraphInput, type ParsedCommandData, type ParsedEvent, type ParsedMessageCommand, type PluginTransformParameters, type PreRegisterCommandsEvent, type PreparedAppCommandExecution, type ResolvableCommand, type ResolveBuilderInteraction, type ResolveKind, type ResolveResult, RoleSelectMenu, RoleSelectMenuKit, type RoleSelectMenuKitPredicate, type RoleSelectMenuProps, type RunCommand, RuntimePlugin, Section, type SectionProps, type SelectMenuKitPredicate, type SelectMenuProps, Separator, type SeparatorProps, type Setup, ShortInput, type SlashCommandMiddlewareContext, StopEventPropagationError, StringSelectMenu, StringSelectMenuKit, type StringSelectMenuKitPredicate, StringSelectMenuOption, type StringSelectMenuOptionProps, type StringSelectMenuProps, TextDisplay, type TextDisplayProps, TextInput, type TextInputProps, Thumbnail, type ThumbnailProps, type TransformedResult, type UserContextMenuCommand, type UserContextMenuCommandContext, type UserContextMenuCommandMiddlewareContext, UserSelectMenu, UserSelectMenuKit, type UserSelectMenuKitPredicate, type UserSelectMenuProps, __SECRET_USE_CACHE_INTERNAL_DO_NOT_USE_OR_YOU_WILL_BE_FIRED, after, bootstrapCommandkitCLI, cache, cacheLife, cacheTag, cancelAfter, commandkit, createElement, createLogger, debounce, CommandKit as default, defineConfig, devOnly, eventWorkerContext, exitContext, exitMiddleware, fromEsbuildPlugin, getCommandKit, getConfig, getContext, getCurrentDirectory, getElement, getEventWorkerContext, getSourceDirectories, invalidate, isCachedFunction, isCommandKitElement, isCompilerPlugin, isInteractionSource, isMessageSource, isRuntimePlugin, makeContextAwareFunction, onApplicationBootstrap, onBootstrap, provideContext, redirect, rethrow, revalidate, runInEventWorkerContext, stopEvents, useEnvironment, version };
+export { ActionRow, type ActionRowProps, type AnyCommandExecute, type AnyCommandKitElement, AppCommandHandler, type AsyncFunction, type AutocompleteCommand, type AutocompleteCommandContext, type AutocompleteCommandMiddlewareContext, type BootstrapFunction, Button, type ButtonChildrenLike, ButtonKit, type ButtonKitPredicate, type ButtonProps, COMMANDKIT_BOOTSTRAP_MODE, COMMANDKIT_CACHE_TAG, COMMANDKIT_IS_DEV, COMMANDKIT_IS_TEST, ChannelSelectMenu, ChannelSelectMenuKit, type ChannelSelectMenuKitPredicate, type ChannelSelectMenuProps, type ChatInputCommand, type ChatInputCommandContext, type Command, type CommandBuilderLike, 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 CommandKitHMREvent, type CommandKitLoggerOptions, type CommandKitModalBuilderInteractionCollectorDispatch, type CommandKitModalBuilderInteractionCollectorDispatchContextData, type CommandKitModalBuilderOnEnd, type CommandKitOptions, type CommandKitPlugin, CommandKitPluginRuntime, type CommandKitSelectMenuBuilderInteractionCollectorDispatch, type CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData, type CommandKitSelectMenuBuilderOnEnd, CommandRegistrar, type CommandSource, type CommandTypeData, CommandsRouter, type CommandsRouterOptions, type CommonBuilderKit, CommonDirectiveTransformer, type CommonDirectiveTransformerOptions, type CommonPluginRuntime, type CommonSelectMenuProps, CompilerPlugin, CompilerPluginRuntime, Container, type ContainerProps, Context, type ContextParameters, DefaultLogger, ElementType, EventInterceptor, type EventInterceptorContextData, type EventInterceptorErrorHandler, type EventWorkerContext, EventsRouter, type EventsRouterOptions, type EventsTree, File, type FileProps, Fragment, type FragmentElementProps, type GenericFunction, HMREventType, type ILogger, type InteractionCommandContext, type InteractionCommandMiddlewareContext, type LoadedCommand, type Loader, type Location, Logger, type LoggerImpl, type MaybeArray, type MaybeFalsey, MediaGallery, MediaGalleryItem, type MediaGalleryItemProps, type MediaGalleryProps, MentionableSelectMenu, MentionableSelectMenuKit, type MentionableSelectMenuKitPredicate, type MentionableSelectMenuProps, 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 OnChannelSelectMenuKitSubmit, type OnLoadArgs, type OnLoadOptions, type OnLoadResult, type OnMentionableSelectMenuKitSubmit, type OnModalKitEnd, type OnModalKitSubmit, type OnResolveArgs, type OnResolveOptions, type OnResolveResult, type OnRoleSelectMenuKitSubmit, type OnSelectMenuKitEnd, type OnSelectMenuKitSubmit, type OnStringSelectMenuKitSubmit, type OnUserSelectMenuKitSubmit, ParagraphInput, type ParsedCommandData, type ParsedEvent, type ParsedMessageCommand, type PluginTransformParameters, type PreRegisterCommandsEvent, type PreparedAppCommandExecution, type ResolvableCommand, type ResolveBuilderInteraction, type ResolveKind, type ResolveResult, RoleSelectMenu, RoleSelectMenuKit, type RoleSelectMenuKitPredicate, type RoleSelectMenuProps, type RunCommand, RuntimePlugin, Section, type SectionProps, type SelectMenuKitPredicate, type SelectMenuProps, Separator, type SeparatorProps, type Setup, ShortInput, type SlashCommandMiddlewareContext, StopEventPropagationError, StringSelectMenu, StringSelectMenuKit, type StringSelectMenuKitPredicate, StringSelectMenuOption, type StringSelectMenuOptionProps, type StringSelectMenuProps, TextDisplay, type TextDisplayProps, TextInput, type TextInputProps, Thumbnail, type ThumbnailProps, type TransformedResult, type UserContextMenuCommand, type UserContextMenuCommandContext, type UserContextMenuCommandMiddlewareContext, UserSelectMenu, UserSelectMenuKit, type UserSelectMenuKitPredicate, type UserSelectMenuProps, after, bootstrapCommandkitCLI, cancelAfter, commandkit, createElement, createLogger, debounce, CommandKit as default, defineConfig, devOnly, eventWorkerContext, exitContext, exitMiddleware, fromEsbuildPlugin, getCommandKit, getConfig, getContext, getCurrentDirectory, getElement, getEventWorkerContext, getSourceDirectories, isCommandKitElement, isCompilerPlugin, isInteractionSource, isMessageSource, isRuntimePlugin, makeContextAwareFunction, onApplicationBootstrap, onBootstrap, provideContext, redirect, rethrow, runInEventWorkerContext, stopEvents, useEnvironment, version };