diff --git a/apps/test-bot/src/config.json b/apps/test-bot/src/config.json index 9a154834..e75610a2 100644 --- a/apps/test-bot/src/config.json +++ b/apps/test-bot/src/config.json @@ -1,6 +1,6 @@ { - "foo": "bar", - "bar": { - "baz": "qux" - } -} \ No newline at end of file + "foo": "bar", + "bar": { + "baz": "qux" + } +} diff --git a/apps/website/docs/api-reference/ai/classes/ai-cli-plugin.mdx b/apps/website/docs/api-reference/ai/classes/ai-cli-plugin.mdx index 4ed55713..6cdb2b07 100644 --- a/apps/website/docs/api-reference/ai/classes/ai-cli-plugin.mdx +++ b/apps/website/docs/api-reference/ai/classes/ai-cli-plugin.mdx @@ -24,7 +24,7 @@ class AiCliPlugin extends CompilerPlugin { deactivate(ctx: CompilerPluginRuntime) => Promise; } ``` -* Extends: CompilerPlugin +* Extends: CompilerPlugin @@ -37,12 +37,12 @@ class AiCliPlugin extends CompilerPlugin { ### activate -CompilerPluginRuntime) => Promise<void>`} /> +CompilerPluginRuntime) => Promise<void>`} /> ### deactivate -CompilerPluginRuntime) => Promise<void>`} /> +CompilerPluginRuntime) => Promise<void>`} /> diff --git a/apps/website/docs/api-reference/ai/classes/ai-context.mdx b/apps/website/docs/api-reference/ai/classes/ai-context.mdx index 07f595fa..7afc12a8 100644 --- a/apps/website/docs/api-reference/ai/classes/ai-context.mdx +++ b/apps/website/docs/api-reference/ai/classes/ai-context.mdx @@ -25,7 +25,7 @@ class AiContext = Record> { public message!: Message; public client!: Client; public commandkit!: CommandKit; - public store = new Map(); + public store = new Collection(); constructor(options: AiContextOptions) setParams(params: T) => void; } @@ -50,7 +50,7 @@ The message that triggered the AI command. The client instance associated with the AI command. ### commandkit -CommandKit`} /> +CommandKit`} /> The CommandKit instance associated with the AI command. ### store @@ -60,7 +60,7 @@ The CommandKit instance associated with the AI command. A key-value store to hold additional data. ### constructor -AiContextOptions<T>) => AiContext`} /> +AiContextOptions<T>) => AiContext`} /> Creates a new instance of AiContext. ### setParams diff --git a/apps/website/docs/api-reference/ai/classes/ai-plugin.mdx b/apps/website/docs/api-reference/ai/classes/ai-plugin.mdx index 3c46a9b9..e1570836 100644 --- a/apps/website/docs/api-reference/ai/classes/ai-plugin.mdx +++ b/apps/website/docs/api-reference/ai/classes/ai-plugin.mdx @@ -28,7 +28,7 @@ class AiPlugin extends RuntimePlugin { onAfterCommandsLoad(ctx: CommandKitPluginRuntime) => Promise; } ``` -* Extends: RuntimePlugin<AiPluginOptions> +* Extends: RuntimePlugin<AiPluginOptions> @@ -41,22 +41,22 @@ class AiPlugin extends RuntimePlugin { ### constructor -AiPluginOptions) => AiPlugin`} /> +AiPluginOptions) => AiPlugin`} /> ### activate -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> ### deactivate -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> ### executeAI -CommandKit) => Promise<void>`} /> +CommandKit) => Promise<void>`} /> Executes the AI for a given message. ### onBeforeCommandsLoad @@ -66,7 +66,7 @@ Executes the AI for a given message. ### onAfterCommandsLoad -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> diff --git a/apps/website/docs/api-reference/ai/functions/ai.mdx b/apps/website/docs/api-reference/ai/functions/ai.mdx index ad215d49..1b49d3ed 100644 --- a/apps/website/docs/api-reference/ai/functions/ai.mdx +++ b/apps/website/docs/api-reference/ai/functions/ai.mdx @@ -24,5 +24,5 @@ Parameters ### options -AiPluginOptions`} /> +AiPluginOptions`} /> diff --git a/apps/website/docs/api-reference/ai/functions/configure-ai.mdx b/apps/website/docs/api-reference/ai/functions/configure-ai.mdx index 5862e579..06cda219 100644 --- a/apps/website/docs/api-reference/ai/functions/configure-ai.mdx +++ b/apps/website/docs/api-reference/ai/functions/configure-ai.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## configureAI - + Configures the AI plugin with the provided options. This function allows you to set a message filter, select an AI model, and generate a system prompt. @@ -25,5 +25,5 @@ Parameters ### config -ConfigureAI`} /> +ConfigureAI`} /> diff --git a/apps/website/docs/api-reference/ai/functions/create-tool.mdx b/apps/website/docs/api-reference/ai/functions/create-tool.mdx index e3d0f88d..d9438cb6 100644 --- a/apps/website/docs/api-reference/ai/functions/create-tool.mdx +++ b/apps/website/docs/api-reference/ai/functions/create-tool.mdx @@ -47,5 +47,5 @@ Parameters ### options -CreateToolOptions<T, R>`} /> +CreateToolOptions<T, R>`} /> diff --git a/apps/website/docs/api-reference/ai/functions/experimental_create-config.mdx b/apps/website/docs/api-reference/ai/functions/experimental_create-config.mdx index f3179586..f40a0743 100644 --- a/apps/website/docs/api-reference/ai/functions/experimental_create-config.mdx +++ b/apps/website/docs/api-reference/ai/functions/experimental_create-config.mdx @@ -24,5 +24,5 @@ Parameters ### command -CommandData`} /> +CommandData`} /> diff --git a/apps/website/docs/api-reference/ai/functions/get-aiconfig.mdx b/apps/website/docs/api-reference/ai/functions/get-aiconfig.mdx index 4d79d118..96fbe34e 100644 --- a/apps/website/docs/api-reference/ai/functions/get-aiconfig.mdx +++ b/apps/website/docs/api-reference/ai/functions/get-aiconfig.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## getAIConfig - + Retrieves the current AI configuration. diff --git a/apps/website/docs/api-reference/ai/interfaces/ai-context-options.mdx b/apps/website/docs/api-reference/ai/interfaces/ai-context-options.mdx index b50c614a..3681a45f 100644 --- a/apps/website/docs/api-reference/ai/interfaces/ai-context-options.mdx +++ b/apps/website/docs/api-reference/ai/interfaces/ai-context-options.mdx @@ -39,7 +39,7 @@ The message that triggered the AI command. The parameters passed to the AI command. ### commandkit -CommandKit`} /> +CommandKit`} /> The CommandKit instance associated with the AI command. diff --git a/apps/website/docs/api-reference/ai/interfaces/configure-ai.mdx b/apps/website/docs/api-reference/ai/interfaces/configure-ai.mdx index 1f31e2d9..40533e8c 100644 --- a/apps/website/docs/api-reference/ai/interfaces/configure-ai.mdx +++ b/apps/website/docs/api-reference/ai/interfaces/configure-ai.mdx @@ -47,46 +47,46 @@ interface ConfigureAI { Whether to disable the built-in tools. Default is false. ### messageFilter -MessageFilter`} /> +MessageFilter`} /> A filter function that determines whether a message should be processed by the AI. CommandKit invokes this function before processing the message. ### selectAiModel -SelectAiModel`} /> +SelectAiModel`} /> A function that selects the AI model to use based on the message. This function should return a promise that resolves to an object containing the model and options. ### prepareSystemPrompt -AiContext, message: Message) => Promise<string>`} /> +AiContext, message: Message) => Promise<string>`} /> A function that generates a system prompt based on the message. This function should return a promise that resolves to a string containing the system prompt. If not provided, a default system prompt will be used. ### preparePrompt -AiContext, message: Message, ) => Promise<string | AiMessage>`} /> +AiContext, message: Message, ) => Promise<string | AiMessage>`} /> A function that prepares the prompt for the AI model. ### onProcessingStart -AiContext, message: Message) => Promise<void>`} /> +AiContext, message: Message) => Promise<void>`} /> A function that gets called when the AI starts processing a message. ### onProcessingFinish -AiContext, message: Message) => Promise<void>`} /> +AiContext, message: Message) => Promise<void>`} /> A function that gets called when the AI finishes processing a message. ### onResult -AiContext, message: Message, result: AIGenerateResult, ) => Promise<void>`} /> +AiContext, message: Message, result: AIGenerateResult, ) => Promise<void>`} /> A function that gets called upon receiving the result from the AI model. ### onError -AiContext, message: Message, error: Error) => Promise<void>`} /> +AiContext, message: Message, error: Error) => Promise<void>`} /> A function that gets called when error occurs. diff --git a/apps/website/docs/api-reference/ai/interfaces/create-tool-options.mdx b/apps/website/docs/api-reference/ai/interfaces/create-tool-options.mdx index 8b6a6b4a..a33ab319 100644 --- a/apps/website/docs/api-reference/ai/interfaces/create-tool-options.mdx +++ b/apps/website/docs/api-reference/ai/interfaces/create-tool-options.mdx @@ -45,7 +45,7 @@ A human-readable description of what the tool does The parameter schema that defines the tool's input structure ### execute -ToolExecuteFunction<T, R>`} /> +ToolExecuteFunction<T, R>`} /> The function that executes when the tool is called diff --git a/apps/website/docs/api-reference/analytics/classes/post-hog-plugin.mdx b/apps/website/docs/api-reference/analytics/classes/post-hog-plugin.mdx index c124bfdb..20ace952 100644 --- a/apps/website/docs/api-reference/analytics/classes/post-hog-plugin.mdx +++ b/apps/website/docs/api-reference/analytics/classes/post-hog-plugin.mdx @@ -24,7 +24,7 @@ class PostHogPlugin extends RuntimePlugin { deactivate(ctx: CommandKitPluginRuntime) => Promise; } ``` -* Extends: RuntimePlugin<PostHogPluginOptions> +* Extends: RuntimePlugin<PostHogPluginOptions> @@ -37,12 +37,12 @@ class PostHogPlugin extends RuntimePlugin { ### activate -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> ### deactivate -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> diff --git a/apps/website/docs/api-reference/analytics/classes/post-hog-provider.mdx b/apps/website/docs/api-reference/analytics/classes/post-hog-provider.mdx index 53531366..43ae8050 100644 --- a/apps/website/docs/api-reference/analytics/classes/post-hog-provider.mdx +++ b/apps/website/docs/api-reference/analytics/classes/post-hog-provider.mdx @@ -26,7 +26,7 @@ class PostHogProvider implements AnalyticsProvider { track(engine: AnalyticsEngine, event: AnalyticsEvent) => Promise; } ``` -* Implements: AnalyticsProvider +* Implements: AnalyticsProvider @@ -44,12 +44,12 @@ class PostHogProvider implements AnalyticsProvider { ### identify -AnalyticsEngine, event: IdentifyEvent) => Promise<void>`} /> +AnalyticsEngine, event: IdentifyEvent) => Promise<void>`} /> ### track -AnalyticsEngine, event: AnalyticsEvent) => Promise<void>`} /> +AnalyticsEngine, event: AnalyticsEvent) => Promise<void>`} /> diff --git a/apps/website/docs/api-reference/analytics/classes/umami-plugin.mdx b/apps/website/docs/api-reference/analytics/classes/umami-plugin.mdx index dd092779..bf70dfe8 100644 --- a/apps/website/docs/api-reference/analytics/classes/umami-plugin.mdx +++ b/apps/website/docs/api-reference/analytics/classes/umami-plugin.mdx @@ -24,7 +24,7 @@ class UmamiPlugin extends RuntimePlugin { deactivate(ctx: CommandKitPluginRuntime) => Promise; } ``` -* Extends: RuntimePlugin<UmamiPluginOptions> +* Extends: RuntimePlugin<UmamiPluginOptions> @@ -37,12 +37,12 @@ class UmamiPlugin extends RuntimePlugin { ### activate -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> ### deactivate -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> diff --git a/apps/website/docs/api-reference/analytics/classes/umami-provider.mdx b/apps/website/docs/api-reference/analytics/classes/umami-provider.mdx index 46f5dc24..787db981 100644 --- a/apps/website/docs/api-reference/analytics/classes/umami-provider.mdx +++ b/apps/website/docs/api-reference/analytics/classes/umami-provider.mdx @@ -26,7 +26,7 @@ class UmamiProvider implements AnalyticsProvider { track(engine: AnalyticsEngine, event: AnalyticsEvent) => Promise; } ``` -* Implements: AnalyticsProvider +* Implements: AnalyticsProvider @@ -44,12 +44,12 @@ class UmamiProvider implements AnalyticsProvider { ### identify -AnalyticsEngine, event: IdentifyEvent) => Promise<void>`} /> +AnalyticsEngine, event: IdentifyEvent) => Promise<void>`} /> ### track -AnalyticsEngine, event: AnalyticsEvent) => Promise<void>`} /> +AnalyticsEngine, event: AnalyticsEvent) => Promise<void>`} /> diff --git a/apps/website/docs/api-reference/analytics/functions/posthog.mdx b/apps/website/docs/api-reference/analytics/functions/posthog.mdx index 55cd34fb..eaf85078 100644 --- a/apps/website/docs/api-reference/analytics/functions/posthog.mdx +++ b/apps/website/docs/api-reference/analytics/functions/posthog.mdx @@ -24,5 +24,5 @@ Parameters ### options -PostHogPluginOptions`} /> +PostHogPluginOptions`} /> diff --git a/apps/website/docs/api-reference/analytics/functions/umami.mdx b/apps/website/docs/api-reference/analytics/functions/umami.mdx index b1a04080..b910c168 100644 --- a/apps/website/docs/api-reference/analytics/functions/umami.mdx +++ b/apps/website/docs/api-reference/analytics/functions/umami.mdx @@ -24,5 +24,5 @@ Parameters ### options -UmamiPluginOptions`} /> +UmamiPluginOptions`} /> diff --git a/apps/website/docs/api-reference/cache/classes/cache-plugin.mdx b/apps/website/docs/api-reference/cache/classes/cache-plugin.mdx index 69fa8f57..1dd4c869 100644 --- a/apps/website/docs/api-reference/cache/classes/cache-plugin.mdx +++ b/apps/website/docs/api-reference/cache/classes/cache-plugin.mdx @@ -24,7 +24,7 @@ class CachePlugin extends RuntimePlugin { deactivate() => ; } ``` -* Extends: RuntimePlugin +* Extends: RuntimePlugin diff --git a/apps/website/docs/api-reference/cache/classes/cache-provider.mdx b/apps/website/docs/api-reference/cache/classes/cache-provider.mdx index 134204f1..46cc89cd 100644 --- a/apps/website/docs/api-reference/cache/classes/cache-provider.mdx +++ b/apps/website/docs/api-reference/cache/classes/cache-provider.mdx @@ -33,7 +33,7 @@ class CacheProvider { ### get - Promise<CacheEntry<T> | undefined>`} /> + Promise<CacheEntry<T> | undefined>`} /> Retrieves a value from the cache by its key. ### set diff --git a/apps/website/docs/api-reference/cache/classes/memory-cache.mdx b/apps/website/docs/api-reference/cache/classes/memory-cache.mdx index d57d1131..0ff69848 100644 --- a/apps/website/docs/api-reference/cache/classes/memory-cache.mdx +++ b/apps/website/docs/api-reference/cache/classes/memory-cache.mdx @@ -28,7 +28,7 @@ class MemoryCache extends CacheProvider { expire(key: string, ttl: number) => Promise; } ``` -* Extends: CacheProvider +* Extends: CacheProvider @@ -36,7 +36,7 @@ class MemoryCache extends CacheProvider { ### get - Promise<CacheEntry<T> | undefined>`} /> + Promise<CacheEntry<T> | undefined>`} /> Retrieves a value from the cache by its key. ### set diff --git a/apps/website/docs/api-reference/cache/classes/use-cache-directive-plugin.mdx b/apps/website/docs/api-reference/cache/classes/use-cache-directive-plugin.mdx index 66fad48f..028f33a5 100644 --- a/apps/website/docs/api-reference/cache/classes/use-cache-directive-plugin.mdx +++ b/apps/website/docs/api-reference/cache/classes/use-cache-directive-plugin.mdx @@ -26,7 +26,7 @@ class UseCacheDirectivePlugin extends CommonDirectiveTransformer { activate(ctx: CompilerPluginRuntime) => Promise; } ``` -* Extends: CommonDirectiveTransformer +* Extends: CommonDirectiveTransformer @@ -39,12 +39,12 @@ class UseCacheDirectivePlugin extends CommonDirectiveTransformer { ### constructor -CommonDirectiveTransformerOptions>) => UseCacheDirectivePlugin`} /> +CommonDirectiveTransformerOptions>) => UseCacheDirectivePlugin`} /> ### activate -CompilerPluginRuntime) => Promise<void>`} /> +CompilerPluginRuntime) => Promise<void>`} /> diff --git a/apps/website/docs/api-reference/cache/functions/cache.mdx b/apps/website/docs/api-reference/cache/functions/cache.mdx index a4fb4286..fb38ab1f 100644 --- a/apps/website/docs/api-reference/cache/functions/cache.mdx +++ b/apps/website/docs/api-reference/cache/functions/cache.mdx @@ -27,5 +27,5 @@ Parameters ### options -CommonDirectiveTransformerOptions; runtime: Record<never, never>; }>`} /> +CommonDirectiveTransformerOptions; runtime: Record<never, never>; }>`} /> diff --git a/apps/website/docs/api-reference/cache/functions/is-cached-function.mdx b/apps/website/docs/api-reference/cache/functions/is-cached-function.mdx index 87ac793b..44ba721a 100644 --- a/apps/website/docs/api-reference/cache/functions/is-cached-function.mdx +++ b/apps/website/docs/api-reference/cache/functions/is-cached-function.mdx @@ -34,5 +34,5 @@ Parameters ### fn -GenericFunction`} /> +GenericFunction`} /> diff --git a/apps/website/docs/api-reference/cache/functions/set-cache-provider.mdx b/apps/website/docs/api-reference/cache/functions/set-cache-provider.mdx index 8aca057a..8fcb0e78 100644 --- a/apps/website/docs/api-reference/cache/functions/set-cache-provider.mdx +++ b/apps/website/docs/api-reference/cache/functions/set-cache-provider.mdx @@ -24,5 +24,5 @@ Parameters ### provider -CacheProvider`} /> +CacheProvider`} /> diff --git a/apps/website/docs/api-reference/cache/interfaces/cache-context.mdx b/apps/website/docs/api-reference/cache/interfaces/cache-context.mdx index 8d8c21e9..8a40167d 100644 --- a/apps/website/docs/api-reference/cache/interfaces/cache-context.mdx +++ b/apps/website/docs/api-reference/cache/interfaces/cache-context.mdx @@ -33,7 +33,7 @@ interface CacheContext { ### params -cache entry */ name?: string; /** Time-to-live in milliseconds */ ttl?: number | null; tags: Set<string>; }`} /> +cache entry */ name?: string; /** Time-to-live in milliseconds */ ttl?: number | null; tags: Set<string>; }`} /> diff --git a/apps/website/docs/api-reference/commandkit/classes/analytics-engine.mdx b/apps/website/docs/api-reference/commandkit/classes/analytics-engine.mdx index fad5b6b7..5cb01d66 100644 --- a/apps/website/docs/api-reference/commandkit/classes/analytics-engine.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/analytics-engine.mdx @@ -34,12 +34,12 @@ class AnalyticsEngine { ### constructor -CommandKit) => AnalyticsEngine`} /> +CommandKit) => AnalyticsEngine`} /> Creates an instance of the AnalyticsEngine. ### setFilter -FilterFunction | null) => `} /> +FilterFunction | null) => `} /> Sets a filter function for analytics events. This function will be called before tracking an event to determine if it should be tracked. @@ -47,30 +47,30 @@ If the filter returns `false`, the event will not be tracked. If the filter is set to `null`, all events will be tracked unless `doNotTrack` is enabled. ### registerProvider -AnalyticsProvider) => `} /> +AnalyticsProvider) => `} /> Registers an analytics provider. This provider will be used to track and identify events. If a provider is already registered, it will be replaced with the new one. ### removeProvider -AnalyticsProvider) => `} /> +AnalyticsProvider) => `} /> Removes the currently registered analytics provider. ### getProvider - AnalyticsProvider | null`} /> + AnalyticsProvider | null`} /> Retrieves the currently registered analytics provider. ### identify -IdentifyEvent) => `} /> +IdentifyEvent) => `} /> Identifies a user with the analytics provider. This method sends an identify event to the provider, which can be used to associate user data with events. ### track -AnalyticsEvent) => `} /> +AnalyticsEvent) => `} /> Tracks an analytics event with the registered provider. This method sends the event to the provider, which can then process it as needed. diff --git a/apps/website/docs/api-reference/commandkit/classes/app-command-handler.mdx b/apps/website/docs/api-reference/commandkit/classes/app-command-handler.mdx index 679d703a..df93d69a 100644 --- a/apps/website/docs/api-reference/commandkit/classes/app-command-handler.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/app-command-handler.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## AppCommandHandler - + Handles application commands for CommandKit, including loading, registration, and execution. Manages both slash commands and message commands with middleware support. @@ -35,7 +35,7 @@ class AppCommandHandler { registerExternalLoadedMiddleware(data: LoadedMiddleware[]) => ; registerExternalLoadedCommands(data: LoadedCommand[]) => ; loadCommands() => ; - getMetadataFor(command: string) => CommandMetadata | null; + getMetadataFor(command: string, hint?: 'user' | 'message') => CommandMetadata | null; } ``` @@ -43,7 +43,7 @@ class AppCommandHandler { ### registrar -CommandRegistrar`} /> +CommandRegistrar`} /> Command registrar for handling Discord API registration. ### commandRunner @@ -63,7 +63,7 @@ External command data storage. External middleware data storage. ### constructor -CommandKit) => AppCommandHandler`} /> +CommandKit) => AppCommandHandler`} /> Creates a new AppCommandHandler instance. ### printBanner @@ -83,7 +83,7 @@ Gets an array of all loaded commands. Registers event handlers for Discord interactions and messages. ### prepareCommandRun - Promise<PreparedAppCommandExecution | null>`} /> + Promise<PreparedAppCommandExecution | null>`} /> Prepares a command for execution by resolving the command and its middleware. ### reloadCommands @@ -93,12 +93,12 @@ Prepares a command for execution by resolving the command and its middleware. Reloads all commands and middleware from scratch. ### addExternalMiddleware -Middleware[]) => `} /> +Middleware[]) => `} /> Adds external middleware data to be loaded. ### addExternalCommands -Command[]) => `} /> +Command[]) => `} /> Adds external command data to be loaded. ### registerExternalLoadedMiddleware @@ -108,7 +108,7 @@ Adds external command data to be loaded. Registers externally loaded middleware. ### registerExternalLoadedCommands -LoadedCommand[]) => `} /> +LoadedCommand[]) => `} /> Registers externally loaded commands. ### loadCommands @@ -118,7 +118,7 @@ Registers externally loaded commands. Loads all commands and middleware from the router. ### getMetadataFor - CommandMetadata | null`} /> + CommandMetadata | null`} /> Gets the metadata for a command. diff --git a/apps/website/docs/api-reference/commandkit/classes/app-command-runner.mdx b/apps/website/docs/api-reference/commandkit/classes/app-command-runner.mdx index 38e671a5..49b9d7ca 100644 --- a/apps/website/docs/api-reference/commandkit/classes/app-command-runner.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/app-command-runner.mdx @@ -30,18 +30,18 @@ class AppCommandRunner { ### constructor -AppCommandHandler) => AppCommandRunner`} /> +AppCommandHandler) => AppCommandRunner`} /> Creates a new AppCommandRunner instance. ### runCommand -PreparedAppCommandExecution, source: Interaction | Message, options?: RunCommandOptions) => `} /> +PreparedAppCommandExecution, source: Interaction | Message, options?: RunCommandOptions) => `} /> Executes a prepared command with middleware support and environment setup. Handles the complete command lifecycle including before/after middleware execution. ### getExecutionMode - CommandExecutionMode`} /> + CommandExecutionMode`} /> Determines the execution mode based on the source of the command. diff --git a/apps/website/docs/api-reference/commandkit/classes/app-events-handler.mdx b/apps/website/docs/api-reference/commandkit/classes/app-events-handler.mdx index a47a2cb1..0693c56c 100644 --- a/apps/website/docs/api-reference/commandkit/classes/app-events-handler.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/app-events-handler.mdx @@ -33,12 +33,12 @@ class AppEventsHandler { ### constructor -CommandKit) => AppEventsHandler`} /> +CommandKit) => AppEventsHandler`} /> Creates a new AppEventsHandler instance. ### getEvents - AppEventsHandlerLoadedData[]`} /> + AppEventsHandlerLoadedData[]`} /> Gets information about all loaded events. ### reloadEvents diff --git a/apps/website/docs/api-reference/commandkit/classes/async-queue.mdx b/apps/website/docs/api-reference/commandkit/classes/async-queue.mdx index 4c76d0be..a9761bb7 100644 --- a/apps/website/docs/api-reference/commandkit/classes/async-queue.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/async-queue.mdx @@ -36,12 +36,12 @@ class AsyncQueue { ### constructor -AsyncQueueOptions = {}) => AsyncQueue`} /> +AsyncQueueOptions = {}) => AsyncQueue`} /> ### add -AsyncQueueTask<T>, signal?: AbortSignal) => Promise<T>`} /> +AsyncQueueTask<T>, signal?: AbortSignal) => Promise<T>`} /> Adds a task to the queue. ### pause diff --git a/apps/website/docs/api-reference/commandkit/classes/button-kit.mdx b/apps/website/docs/api-reference/commandkit/classes/button-kit.mdx index 6fce71e3..8b23d8f7 100644 --- a/apps/website/docs/api-reference/commandkit/classes/button-kit.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/button-kit.mdx @@ -34,7 +34,7 @@ class ButtonKit extends ButtonBuilder { ### onClick -CommandKitButtonBuilderInteractionCollectorDispatch, data?: CommandKitButtonBuilderInteractionCollectorDispatchContextData) => this`} /> +CommandKitButtonBuilderInteractionCollectorDispatch, data?: CommandKitButtonBuilderInteractionCollectorDispatchContextData) => this`} /> 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. @@ -62,17 +62,17 @@ button.onClick(null); ``` ### onEnd -CommandKitButtonBuilderOnEnd) => this`} /> +CommandKitButtonBuilderOnEnd) => this`} /> ### onError -EventInterceptorErrorHandler) => this`} /> +EventInterceptorErrorHandler) => this`} /> Sets the handler to run when the interaction collector ends. ### filter -ButtonKitPredicate) => this`} /> +ButtonKitPredicate) => this`} /> Sets a filter for the interaction collector. ### dispose diff --git a/apps/website/docs/api-reference/commandkit/classes/channel-select-menu-kit.mdx b/apps/website/docs/api-reference/commandkit/classes/channel-select-menu-kit.mdx index 5d9d2180..56792e7b 100644 --- a/apps/website/docs/api-reference/commandkit/classes/channel-select-menu-kit.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/channel-select-menu-kit.mdx @@ -39,7 +39,7 @@ class ChannelSelectMenuKit extends ChannelSelectMenuBuilder { ### onSelect -CommandKitSelectMenuBuilderInteractionCollectorDispatch< ChannelSelectMenuInteraction, ChannelSelectMenuKit >, data?: CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData) => this`} /> +CommandKitSelectMenuBuilderInteractionCollectorDispatch< ChannelSelectMenuInteraction, ChannelSelectMenuKit >, data?: CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData) => this`} /> Sets the handler to run when the modal is submitted. @@ -59,17 +59,17 @@ const modal = new ChannelSelectMenuKit() ``` ### onEnd -CommandKitSelectMenuBuilderOnEnd) => this`} /> +CommandKitSelectMenuBuilderOnEnd) => this`} /> Sets the handler to run when the interaction collector ends. ### onError -EventInterceptorErrorHandler) => this`} /> +EventInterceptorErrorHandler) => this`} /> Sets the handler to run when the interaction collector ends. ### filter -SelectMenuKitPredicate<ChannelSelectMenuInteraction>) => this`} /> +SelectMenuKitPredicate<ChannelSelectMenuInteraction>) => this`} /> Sets a filter for the interaction collector. ### dispose diff --git a/apps/website/docs/api-reference/commandkit/classes/command-kit-environment.mdx b/apps/website/docs/api-reference/commandkit/classes/command-kit-environment.mdx index 693ddd8d..27da97b8 100644 --- a/apps/website/docs/api-reference/commandkit/classes/command-kit-environment.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/command-kit-environment.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CommandKitEnvironment - + Represents the execution environment for CommandKit commands. @@ -23,6 +23,7 @@ class CommandKitEnvironment { setContext(context: Context) => void; getType() => CommandKitEnvironmentType; variables: Map + store: Collection } ``` @@ -30,17 +31,17 @@ class CommandKitEnvironment { ### constructor -CommandKit) => CommandKitEnvironment`} /> +CommandKit) => CommandKitEnvironment`} /> Creates the commandkit execution environment. ### setContext -Context) => void`} /> +Context) => void`} /> Set the context. ### getType - CommandKitEnvironmentType`} /> + CommandKitEnvironmentType`} /> Get the environment type. ### variables @@ -48,6 +49,11 @@ Get the environment type. The variables store for this environment. +### store + + + +The shared store for this environment diff --git a/apps/website/docs/api-reference/commandkit/classes/command-kit-events-channel.mdx b/apps/website/docs/api-reference/commandkit/classes/command-kit-events-channel.mdx index 6cb64b79..e69865c0 100644 --- a/apps/website/docs/api-reference/commandkit/classes/command-kit-events-channel.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/command-kit-events-channel.mdx @@ -37,7 +37,7 @@ class CommandKitEventsChannel { ### constructor -CommandKit) => CommandKitEventsChannel`} /> +CommandKit) => CommandKitEventsChannel`} /> Creates a new instance of CommandKitEventsChannel. ### to @@ -57,17 +57,17 @@ commandkit.events.to('customNamespace').emit('eventName', data); ``` ### on -ListenerFunction) => `} /> +ListenerFunction) => `} /> Register an event listener for a specific event within the namespace. ### off -ListenerFunction) => `} /> +ListenerFunction) => `} /> Unregister an event listener for a specific event within the namespace. ### once -ListenerFunction) => `} /> +ListenerFunction) => `} /> Register an event listener that will be called only once for a specific event within the namespace. diff --git a/apps/website/docs/api-reference/commandkit/classes/command-kit-plugin-runtime.mdx b/apps/website/docs/api-reference/commandkit/classes/command-kit-plugin-runtime.mdx index e89643bc..d4430dff 100644 --- a/apps/website/docs/api-reference/commandkit/classes/command-kit-plugin-runtime.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/command-kit-plugin-runtime.mdx @@ -37,7 +37,7 @@ class CommandKitPluginRuntime { ### constructor -CommandKit) => CommandKitPluginRuntime`} /> +CommandKit) => CommandKitPluginRuntime`} /> Creates a new instance of CommandKitPluginRuntime. ### getPlugins @@ -47,7 +47,7 @@ Creates a new instance of CommandKitPluginRuntime. Returns the plugins registered in this runtime. ### getPlugin - RuntimePlugin | null`} /> + RuntimePlugin | null`} /> Checks if there are no plugins registered in this runtime. ### get @@ -57,22 +57,22 @@ Checks if there are no plugins registered in this runtime. Fetches the given plugin ### preload -RuntimePlugin) => `} /> +RuntimePlugin) => `} /> Pre-loads the specified entrypoints for the given plugin. ### softRegisterPlugin -RuntimePlugin) => `} /> +RuntimePlugin) => `} /> Soft registers a plugin in the runtime. ### registerPlugin -RuntimePlugin) => `} /> +RuntimePlugin) => `} /> Registers a plugin in the runtime. ### unregisterPlugin -RuntimePlugin) => `} /> +RuntimePlugin) => `} /> Unregisters a plugin from the runtime. ### unregisterAllPlugins @@ -87,7 +87,7 @@ Unregisters all plugins from the runtime. Signals the runtime to allow the current plugin take ownership of the execution context. ### execute -AsyncFunction<[CommandKitPluginRuntime, RuntimePlugin], R | undefined>) => `} /> +AsyncFunction<[CommandKitPluginRuntime, RuntimePlugin], R | undefined>) => `} /> Executes a function for each plugin in the runtime. diff --git a/apps/website/docs/api-reference/commandkit/classes/command-kit.mdx b/apps/website/docs/api-reference/commandkit/classes/command-kit.mdx index 9301cfac..de2afe53 100644 --- a/apps/website/docs/api-reference/commandkit/classes/command-kit.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/command-kit.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CommandKit - + The commandkit class that serves as the main entry point for the CommandKit framework. @@ -41,7 +41,7 @@ class CommandKit extends EventEmitter { start(token?: string | false) => ; loadPlugins() => ; started: void - setPrefixResolver(resolver: (message: Message) => Awaitable) => ; + setPrefixResolver(resolver: (message: Message) => Awaitable) => ; setDefaultLocale(locale: Locale) => ; client: Client setClient(client: Client) => ; @@ -61,7 +61,7 @@ class CommandKit extends EventEmitter { ### eventInterceptor -EventInterceptor`} /> +EventInterceptor`} /> The event interceptor to quickly register temporary event listeners ### createElement @@ -76,12 +76,12 @@ The static createElement function to create jsx elements The static Fragment component to create jsx fragments ### appConfig -CommandKitConfiguration`} /> +CommandKitConfiguration`} /> The configuration for the CommandKit instance. ### config -ResolvedCommandKitConfig`} /> +ResolvedCommandKitConfig`} /> The configuration for the CommandKit environment. ### store @@ -96,50 +96,50 @@ A key-value store for storing arbitrary data. A flag store for storing flags that can be used to enable or disable features. ### commandsRouter -CommandsRouter`} /> +CommandsRouter`} /> The command router for the CommandKit instance. ### eventsRouter -EventsRouter`} /> +EventsRouter`} /> The events router for the CommandKit instance. ### commandHandler -AppCommandHandler`} /> +AppCommandHandler`} /> The command handler for the CommandKit instance. This is responsible for handling commands and their execution. ### eventHandler -AppEventsHandler`} /> +AppEventsHandler`} /> The event handler for the CommandKit instance. This is responsible for handling events and their execution. ### plugins -CommandKitPluginRuntime`} /> +CommandKitPluginRuntime`} /> The plugins runtime for the CommandKit instance. ### events -CommandKitEventsChannel`} /> +CommandKitEventsChannel`} /> The events channel for the CommandKit instance. This can be used to emit custom events. ### analytics -AnalyticsEngine`} /> +AnalyticsEngine`} /> The analytics engine for the CommandKit instance. This is responsible for tracking events and user interactions. ### instance -CommandKit | undefined`} /> +CommandKit | undefined`} /> The static instance of CommandKit. ### constructor -CommandKitOptions = {}) => CommandKit`} /> +CommandKitOptions = {}) => CommandKit`} /> Create a new command and event handler with CommandKit. ### start @@ -159,7 +159,7 @@ Loads all the plugins. Whether or not the commandkit application has started. ### setPrefixResolver - `} /> + `} /> Sets the prefix resolver for the command handler. ### setDefaultLocale diff --git a/apps/website/docs/api-reference/commandkit/classes/command-registrar.mdx b/apps/website/docs/api-reference/commandkit/classes/command-registrar.mdx index 7427f1b2..4c4ab921 100644 --- a/apps/website/docs/api-reference/commandkit/classes/command-registrar.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/command-registrar.mdx @@ -31,12 +31,12 @@ class CommandRegistrar { ### constructor -CommandKit) => CommandRegistrar`} /> +CommandKit) => CommandRegistrar`} /> Creates an instance of CommandRegistrar. ### getCommandsData - (CommandData & { __metadata?: CommandMetadata })[]`} /> + (CommandData & { __metadata?: CommandMetadata })[]`} /> Gets the commands data. ### register @@ -46,12 +46,12 @@ Gets the commands data. Registers loaded commands. ### updateGlobalCommands -CommandData & { __metadata?: CommandMetadata })[]) => `} /> +CommandData & { __metadata?: CommandMetadata })[]) => `} /> Updates the global commands. ### updateGuildCommands -CommandData & { __metadata?: CommandMetadata })[]) => `} /> +CommandData & { __metadata?: CommandMetadata })[]) => `} /> Updates the guild commands. diff --git a/apps/website/docs/api-reference/commandkit/classes/commands-router.mdx b/apps/website/docs/api-reference/commandkit/classes/commands-router.mdx index 15900a3d..895c9bec 100644 --- a/apps/website/docs/api-reference/commandkit/classes/commands-router.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/commands-router.mdx @@ -33,12 +33,12 @@ class CommandsRouter { ### constructor -CommandsRouterOptions) => CommandsRouter`} /> +CommandsRouterOptions) => CommandsRouter`} /> Creates a new CommandsRouter instance. ### populate -ParsedCommandData) => `} /> +ParsedCommandData) => `} /> Populates the router with existing command and middleware data. ### isValidPath diff --git a/apps/website/docs/api-reference/commandkit/classes/common-directive-transformer.mdx b/apps/website/docs/api-reference/commandkit/classes/common-directive-transformer.mdx index ef16db56..39e2b016 100644 --- a/apps/website/docs/api-reference/commandkit/classes/common-directive-transformer.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/common-directive-transformer.mdx @@ -24,7 +24,7 @@ class CommonDirectiveTransformer extends CompilerPlugin Promise>; } ``` -* Extends: CompilerPlugin<CommonDirectiveTransformerOptions> +* Extends: CompilerPlugin<CommonDirectiveTransformerOptions> @@ -32,17 +32,17 @@ class CommonDirectiveTransformer extends CompilerPluginCompilerPluginRuntime) => Promise<void>`} /> +CompilerPluginRuntime) => Promise<void>`} /> ### deactivate -CompilerPluginRuntime) => Promise<void>`} /> +CompilerPluginRuntime) => Promise<void>`} /> ### transform -PluginTransformParameters) => Promise<MaybeFalsey<TransformedResult>>`} /> +PluginTransformParameters) => Promise<MaybeFalsey<TransformedResult>>`} /> diff --git a/apps/website/docs/api-reference/commandkit/classes/compiler-plugin-runtime.mdx b/apps/website/docs/api-reference/commandkit/classes/compiler-plugin-runtime.mdx index 9df5184e..0b069589 100644 --- a/apps/website/docs/api-reference/commandkit/classes/compiler-plugin-runtime.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/compiler-plugin-runtime.mdx @@ -43,7 +43,7 @@ class CompilerPluginRuntime { ### constructor -CompilerPlugin[]) => CompilerPluginRuntime`} /> +CompilerPlugin[]) => CompilerPluginRuntime`} /> Creates a new instance of CompilerPluginRuntime. ### getPlugins @@ -58,7 +58,7 @@ Returns the plugins managed by this runtime. Checks if there are no plugins registered in this runtime. ### registerTemplate -TemplateHandler) => `} /> +TemplateHandler) => `} /> Registers a template handler for a given name. This method must be called inside the activate() method of a plugin. @@ -70,12 +70,12 @@ Unregister a template handler for a given name. This method must be called inside the deactivate() method of a plugin. ### getTemplate - TemplateHandler | undefined`} /> + TemplateHandler | undefined`} /> Retrieves a template handler by its name. ### getTemplates - Map<string, TemplateHandler>`} /> + Map<string, TemplateHandler>`} /> Returns a map of all registered templates with their handlers. The keys are the template names and the values are the template handlers. diff --git a/apps/website/docs/api-reference/commandkit/classes/compiler-plugin.mdx b/apps/website/docs/api-reference/commandkit/classes/compiler-plugin.mdx index fd99dc0f..399e9500 100644 --- a/apps/website/docs/api-reference/commandkit/classes/compiler-plugin.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/compiler-plugin.mdx @@ -23,7 +23,7 @@ class CompilerPlugin extends PluginComm transform(params: PluginTransformParameters) => Promise>; } ``` -* Extends: PluginCommon<T, CompilerPluginRuntime> +* Extends: PluginCommon<T, CompilerPluginRuntime> @@ -36,7 +36,7 @@ class CompilerPlugin extends PluginComm The type of the plugin, which is Compiler. ### transform -PluginTransformParameters) => Promise<MaybeFalsey<TransformedResult>>`} /> +PluginTransformParameters) => Promise<MaybeFalsey<TransformedResult>>`} /> Called when transformation is requested to this plugin diff --git a/apps/website/docs/api-reference/commandkit/classes/context.mdx b/apps/website/docs/api-reference/commandkit/classes/context.mdx index 99947654..d553b701 100644 --- a/apps/website/docs/api-reference/commandkit/classes/context.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## Context - + Represents the execution context for a command, providing access to Discord.js objects, command metadata, and various utility methods for command execution. @@ -56,12 +56,12 @@ class ContextContextParameters<ExecutionMode>['interaction']`} /> +ContextParameters<ExecutionMode>['interaction']`} /> The interaction that triggered the command. ### message -ContextParameters<ExecutionMode>['message']`} /> +ContextParameters<ExecutionMode>['message']`} /> The message that triggered the command. ### guild @@ -91,12 +91,12 @@ The channel id where the command was triggered. The client instance. ### command -LoadedCommand`} /> +LoadedCommand`} /> The command that this context belongs to. ### constructor -CommandKit, config: ContextParameters<ExecutionMode, Args>) => Context`} /> +CommandKit, config: ContextParameters<ExecutionMode, Args>) => Context`} /> Creates a new command context. ### store @@ -112,7 +112,7 @@ This store is shared across all contexts in the same command execution, includin Gets the name of the current command. ### options -CommandContextOptions<ExecutionMode>`} /> +CommandContextOptions<ExecutionMode>`} /> Gets the command options based on the execution mode. ### forwarded @@ -132,32 +132,32 @@ Forwards the context to another command. The target handler will be the same as The execution mode of the command. ### isInteraction - this is InteractionCommandContext`} /> + this is InteractionCommandContext`} /> Whether the command was triggered by an interaction. ### isChatInputCommand - this is ChatInputCommandContext`} /> + this is ChatInputCommandContext`} /> Whether the command was triggered by a slash command interaction. ### isAutocomplete - this is AutocompleteCommandContext`} /> + this is AutocompleteCommandContext`} /> Whether the command was triggered by an autocomplete interaction. ### isMessageContextMenu - this is MessageContextMenuCommandContext`} /> + this is MessageContextMenuCommandContext`} /> Whether the command was triggered by a message context menu interaction. ### isUserContextMenu - this is UserContextMenuCommandContext`} /> + this is UserContextMenuCommandContext`} /> Whether the command was triggered by a user context menu interaction. ### isMessage - this is Context<'message'>`} /> + this is Context<'message'>`} /> Whether the command was triggered by a message. ### getCommandIdentifier @@ -187,12 +187,12 @@ Returns the locale for this command. Sets the locale for this command. ### clone -ContextParameters<ExecutionMode>>) => Context<ExecutionMode>`} /> +ContextParameters<ExecutionMode>>) => Context<ExecutionMode>`} /> Creates a clone of this context ### isMiddleware - this is MiddlewareContext<ExecutionMode>`} /> + this is MiddlewareContext<ExecutionMode>`} /> Checks if this context is a middleware context. ### args diff --git a/apps/website/docs/api-reference/commandkit/classes/default-logger.mdx b/apps/website/docs/api-reference/commandkit/classes/default-logger.mdx index 72dafdb3..c62872d7 100644 --- a/apps/website/docs/api-reference/commandkit/classes/default-logger.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/default-logger.mdx @@ -38,7 +38,7 @@ class DefaultLogger implements ILogger { warn(messageOrStrings: any | TemplateStringsArray, values: any[]) => void; } ``` -* Implements: ILogger +* Implements: ILogger diff --git a/apps/website/docs/api-reference/commandkit/classes/event-interceptor.mdx b/apps/website/docs/api-reference/commandkit/classes/event-interceptor.mdx index b0342ef7..698360f7 100644 --- a/apps/website/docs/api-reference/commandkit/classes/event-interceptor.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/event-interceptor.mdx @@ -65,7 +65,7 @@ Whether the event has global handlers. Returns the number of global handlers. ### subscribe -EventInterceptorContextData<Event>) => () => void`} /> +EventInterceptorContextData<Event>) => () => void`} /> Subscribes to an event. ### unsubscribe diff --git a/apps/website/docs/api-reference/commandkit/classes/events-router.mdx b/apps/website/docs/api-reference/commandkit/classes/events-router.mdx index f08edab9..abe83788 100644 --- a/apps/website/docs/api-reference/commandkit/classes/events-router.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/events-router.mdx @@ -36,7 +36,7 @@ class EventsRouter { ### constructor -EventsRouterOptions) => EventsRouter`} /> +EventsRouterOptions) => EventsRouter`} /> Creates a new EventsRouter instance ### addEntrypoints @@ -46,7 +46,7 @@ Creates a new EventsRouter instance Adds new entrypoints to the router ### match - ParsedEvent | null`} /> + ParsedEvent | null`} /> Find a parsed event by its name ### entrypoints @@ -71,12 +71,12 @@ Clear all parsed events Reload and re-scan the entrypoint directory for events ### scan - Promise<EventsTree>`} /> + Promise<EventsTree>`} /> Scan the entrypoint directory for events and their handlers ### toJSON - EventsTree`} /> + EventsTree`} /> Convert the internal events Collection to a plain object diff --git a/apps/website/docs/api-reference/commandkit/classes/feature-flag.mdx b/apps/website/docs/api-reference/commandkit/classes/feature-flag.mdx index 234d8c3c..ec47b972 100644 --- a/apps/website/docs/api-reference/commandkit/classes/feature-flag.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/feature-flag.mdx @@ -28,7 +28,7 @@ class FeatureFlag { ### constructor -FeatureFlagDefinition<R, T>) => FeatureFlag`} /> +FeatureFlagDefinition<R, T>) => FeatureFlag`} /> Create a new feature flag. ### execute diff --git a/apps/website/docs/api-reference/commandkit/classes/flag-store.mdx b/apps/website/docs/api-reference/commandkit/classes/flag-store.mdx index f514c9b6..916e0a5f 100644 --- a/apps/website/docs/api-reference/commandkit/classes/flag-store.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/flag-store.mdx @@ -23,6 +23,6 @@ class FlagStore extends Collection> { } ``` -* Extends: Collection<string, FeatureFlag<any, any>> +* Extends: Collection<string, FeatureFlag<any, any>> diff --git a/apps/website/docs/api-reference/commandkit/classes/json-flag-provider.mdx b/apps/website/docs/api-reference/commandkit/classes/json-flag-provider.mdx index a6db020e..989de62a 100644 --- a/apps/website/docs/api-reference/commandkit/classes/json-flag-provider.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/json-flag-provider.mdx @@ -25,7 +25,7 @@ class JsonFlagProvider implements FlagProvider { destroy() => Promise; } ``` -* Implements: FlagProvider +* Implements: FlagProvider @@ -33,12 +33,12 @@ class JsonFlagProvider implements FlagProvider { ### constructor -FlagConfiguration>) => JsonFlagProvider`} /> +FlagConfiguration>) => JsonFlagProvider`} /> ### getFlag - Promise<FlagConfiguration | null>`} /> + Promise<FlagConfiguration | null>`} /> ### hasFlag diff --git a/apps/website/docs/api-reference/commandkit/classes/kv.mdx b/apps/website/docs/api-reference/commandkit/classes/kv.mdx index 5a59d1c3..64fc83f3 100644 --- a/apps/website/docs/api-reference/commandkit/classes/kv.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/kv.mdx @@ -81,7 +81,7 @@ class KV implements Disposable, AsyncDisposable { ### constructor -KvOptions = { +KvOptions = { enableWAL: true, namespace: 'commandkit_kv', }) => KV`} /> @@ -189,7 +189,7 @@ kv.setex('user:123.temp_settings', { theme: 'light' }, 30 * 60 * 1000); ``` ### math -KvMathOperator, value: number | bigint) => number | bigint`} /> +KvMathOperator, value: number | bigint) => number | bigint`} /> Performs mathematical operations on numeric values in the KV store @@ -377,7 +377,7 @@ console.log('Available namespaces:', namespaces); Gets the current namespace name ### namespace - KV`} /> + KV`} /> Creates a new KV instance with a different namespace diff --git a/apps/website/docs/api-reference/commandkit/classes/macro-plugin.mdx b/apps/website/docs/api-reference/commandkit/classes/macro-plugin.mdx index 1e03858a..920fb8cc 100644 --- a/apps/website/docs/api-reference/commandkit/classes/macro-plugin.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/macro-plugin.mdx @@ -41,7 +41,7 @@ class MacroPlugin extends CompilerPlugin { transform(params: PluginTransformParameters) => Promise>; } ``` -* Extends: CompilerPlugin +* Extends: CompilerPlugin @@ -64,7 +64,7 @@ class MacroPlugin extends CompilerPlugin { ### transform -PluginTransformParameters) => Promise<MaybeFalsey<TransformedResult>>`} /> +PluginTransformParameters) => Promise<MaybeFalsey<TransformedResult>>`} /> diff --git a/apps/website/docs/api-reference/commandkit/classes/memory-mutex-storage.mdx b/apps/website/docs/api-reference/commandkit/classes/memory-mutex-storage.mdx index b8dcac73..0a35e215 100644 --- a/apps/website/docs/api-reference/commandkit/classes/memory-mutex-storage.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/memory-mutex-storage.mdx @@ -25,7 +25,7 @@ class MemoryMutexStorage implements MutexStorage { isLocked(key: string) => Promise; } ``` -* Implements: MutexStorage +* Implements: MutexStorage diff --git a/apps/website/docs/api-reference/commandkit/classes/memory-rate-limit-storage.mdx b/apps/website/docs/api-reference/commandkit/classes/memory-rate-limit-storage.mdx index 195603c1..a433ac86 100644 --- a/apps/website/docs/api-reference/commandkit/classes/memory-rate-limit-storage.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/memory-rate-limit-storage.mdx @@ -25,7 +25,7 @@ class MemoryRateLimitStorage implements RateLimitStorage { delete(key: string) => Promise; } ``` -* Implements: RateLimitStorage +* Implements: RateLimitStorage diff --git a/apps/website/docs/api-reference/commandkit/classes/memory-semaphore-storage.mdx b/apps/website/docs/api-reference/commandkit/classes/memory-semaphore-storage.mdx index c3780dc0..d3deecd2 100644 --- a/apps/website/docs/api-reference/commandkit/classes/memory-semaphore-storage.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/memory-semaphore-storage.mdx @@ -27,7 +27,7 @@ class MemorySemaphoreStorage implements SemaphoreStorage { initialize(key: string, permits: number) => void; } ``` -* Implements: SemaphoreStorage +* Implements: SemaphoreStorage diff --git a/apps/website/docs/api-reference/commandkit/classes/mentionable-select-menu-kit.mdx b/apps/website/docs/api-reference/commandkit/classes/mentionable-select-menu-kit.mdx index 3a4eb56e..7e8b74b8 100644 --- a/apps/website/docs/api-reference/commandkit/classes/mentionable-select-menu-kit.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/mentionable-select-menu-kit.mdx @@ -37,7 +37,7 @@ class MentionableSelectMenuKit extends MentionableSelectMenuBuilder { ### onSelect -CommandKitSelectMenuBuilderInteractionCollectorDispatch< MentionableSelectMenuInteraction, MentionableSelectMenuKit >, data?: CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData) => this`} /> +CommandKitSelectMenuBuilderInteractionCollectorDispatch< MentionableSelectMenuInteraction, MentionableSelectMenuKit >, data?: CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData) => this`} /> Sets the handler to run when the modal is submitted. @@ -57,17 +57,17 @@ const modal = new MentionableSelectMenuKit() ``` ### onEnd -CommandKitSelectMenuBuilderOnEnd) => this`} /> +CommandKitSelectMenuBuilderOnEnd) => this`} /> Sets the handler to run when the interaction collector ends. ### onError -EventInterceptorErrorHandler) => this`} /> +EventInterceptorErrorHandler) => this`} /> Sets the handler to run when the interaction collector ends. ### filter -SelectMenuKitPredicate<MentionableSelectMenuInteraction>) => this`} /> +SelectMenuKitPredicate<MentionableSelectMenuInteraction>) => this`} /> Sets a filter for the interaction collector. ### dispose diff --git a/apps/website/docs/api-reference/commandkit/classes/message-command-options.mdx b/apps/website/docs/api-reference/commandkit/classes/message-command-options.mdx index ac78b7dd..9b166702 100644 --- a/apps/website/docs/api-reference/commandkit/classes/message-command-options.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/message-command-options.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## MessageCommandOptions - + Provides typed access to message command options with methods similar to Discord.js interaction options. @@ -63,7 +63,7 @@ class MessageCommandOptions { ### constructor -MessageCommandParser) => MessageCommandOptions`} /> +MessageCommandParser) => MessageCommandOptions`} /> Creates a new message command options instance. ### getMember diff --git a/apps/website/docs/api-reference/commandkit/classes/message-command-parser.mdx b/apps/website/docs/api-reference/commandkit/classes/message-command-parser.mdx index fada5f2f..b27c5227 100644 --- a/apps/website/docs/api-reference/commandkit/classes/message-command-parser.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/message-command-parser.mdx @@ -19,7 +19,7 @@ Parses message content into structured command data with options and subcommands ```ts title="Signature" class MessageCommandParser { - constructor(message: Message, prefix: string[], schema: (command: string) => MessageCommandOptionsSchema) + constructor(message: Message, prefix: string[] | RegExp, schema: (command: string) => MessageCommandOptionsSchema) getArgs() => ; options: void getOption(name: string) => T | undefined; @@ -36,7 +36,7 @@ class MessageCommandParser { ### constructor -MessageCommandOptionsSchema) => MessageCommandParser`} /> +MessageCommandOptionsSchema) => MessageCommandParser`} /> Creates a new message command parser. ### getArgs @@ -81,7 +81,7 @@ Gets the prefix used in the message. Gets the full command including subcommand group and subcommand. ### parse - ParsedMessageCommand`} /> + ParsedMessageCommand`} /> Parses the message content into structured command data. diff --git a/apps/website/docs/api-reference/commandkit/classes/middleware-context.mdx b/apps/website/docs/api-reference/commandkit/classes/middleware-context.mdx index c9b08166..07244d0f 100644 --- a/apps/website/docs/api-reference/commandkit/classes/middleware-context.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/middleware-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## MiddlewareContext - + Extended context class for middleware execution with additional control methods. @@ -22,7 +22,7 @@ class MiddlewareContext e setCommandRunner(fn: RunCommand) => void; } ``` -* Extends: Context<T, MiddlewareContextArgs> +* Extends: Context<T, MiddlewareContextArgs> @@ -30,7 +30,7 @@ class MiddlewareContext e ### setCommandRunner -RunCommand) => void`} /> +RunCommand) => void`} /> Sets command runner function to wrap the command execution. diff --git a/apps/website/docs/api-reference/commandkit/classes/modal-kit.mdx b/apps/website/docs/api-reference/commandkit/classes/modal-kit.mdx index 1dad3fd4..4ff327ca 100644 --- a/apps/website/docs/api-reference/commandkit/classes/modal-kit.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/modal-kit.mdx @@ -36,7 +36,7 @@ class ModalKit extends ModalBuilder { ### onSubmit -CommandKitModalBuilderInteractionCollectorDispatch, data?: CommandKitModalBuilderInteractionCollectorDispatchContextData) => this`} /> +CommandKitModalBuilderInteractionCollectorDispatch, data?: CommandKitModalBuilderInteractionCollectorDispatchContextData) => this`} /> Sets the handler to run when the modal is submitted. @@ -56,17 +56,17 @@ const modal = new ModalKit() ``` ### onEnd -CommandKitModalBuilderOnEnd) => this`} /> +CommandKitModalBuilderOnEnd) => this`} /> Sets the handler to run when the interaction collector ends. ### onError -EventInterceptorErrorHandler) => this`} /> +EventInterceptorErrorHandler) => this`} /> Sets the handler to run when the interaction collector ends. ### filter -ModalKitPredicate) => this`} /> +ModalKitPredicate) => this`} /> Sets a filter for the interaction collector. ### dispose diff --git a/apps/website/docs/api-reference/commandkit/classes/mutex.mdx b/apps/website/docs/api-reference/commandkit/classes/mutex.mdx index 8010bc1a..ff4f7a2f 100644 --- a/apps/website/docs/api-reference/commandkit/classes/mutex.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/mutex.mdx @@ -35,17 +35,17 @@ class Mutex { ### constructor -MutexOptions = {}) => Mutex`} /> +MutexOptions = {}) => Mutex`} /> Creates a new mutex instance ### setStorage -MutexStorage) => `} /> +MutexStorage) => `} /> Sets the storage implementation for the mutex ### getStorage - MutexStorage`} /> + MutexStorage`} /> Gets the storage implementation for the mutex ### acquire @@ -70,7 +70,7 @@ Checks if a lock is currently held for the given key Executes a function with exclusive access to the resource ### getConfig - Omit<MutexOptions, 'storage'>`} /> + Omit<MutexOptions, 'storage'>`} /> Gets the current configuration of the mutex diff --git a/apps/website/docs/api-reference/commandkit/classes/noop-logger.mdx b/apps/website/docs/api-reference/commandkit/classes/noop-logger.mdx index 7793c4fa..1c0b8ed1 100644 --- a/apps/website/docs/api-reference/commandkit/classes/noop-logger.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/noop-logger.mdx @@ -36,7 +36,7 @@ class NoopLogger implements ILogger { warn(messageOrStrings: any | TemplateStringsArray, values: any[]) => void; } ``` -* Implements: ILogger +* Implements: ILogger diff --git a/apps/website/docs/api-reference/commandkit/classes/plugin-common.mdx b/apps/website/docs/api-reference/commandkit/classes/plugin-common.mdx index 5ada40a7..c251c985 100644 --- a/apps/website/docs/api-reference/commandkit/classes/plugin-common.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/plugin-common.mdx @@ -33,7 +33,7 @@ class PluginCommonPluginType`} /> +PluginType`} /> The type of the plugin, either Compiler or Runtime. ### id diff --git a/apps/website/docs/api-reference/commandkit/classes/rate-limiter.mdx b/apps/website/docs/api-reference/commandkit/classes/rate-limiter.mdx index 8899459e..f92d15d9 100644 --- a/apps/website/docs/api-reference/commandkit/classes/rate-limiter.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/rate-limiter.mdx @@ -35,17 +35,17 @@ class RateLimiter { ### constructor -RateLimitStorage = new MemoryRateLimitStorage()) => RateLimiter`} /> +RateLimitStorage = new MemoryRateLimitStorage()) => RateLimiter`} /> Creates a new rate limiter instance ### setStorage -RateLimitStorage) => `} /> +RateLimitStorage) => `} /> Sets the storage implementation for the rate limiter ### getStorage - RateLimitStorage`} /> + RateLimitStorage`} /> Gets the storage implementation for the rate limiter ### limit @@ -70,7 +70,7 @@ Gets the time until the rate limit resets for a given key Resets the rate limit for a given key ### getConfig - Omit<RateLimitOptions, 'storage'>`} /> + Omit<RateLimitOptions, 'storage'>`} /> Gets the current configuration of the rate limiter diff --git a/apps/website/docs/api-reference/commandkit/classes/role-select-menu-kit.mdx b/apps/website/docs/api-reference/commandkit/classes/role-select-menu-kit.mdx index 0a9ad16a..514f5b00 100644 --- a/apps/website/docs/api-reference/commandkit/classes/role-select-menu-kit.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/role-select-menu-kit.mdx @@ -39,7 +39,7 @@ class RoleSelectMenuKit extends RoleSelectMenuBuilder { ### onSelect -CommandKitSelectMenuBuilderInteractionCollectorDispatch< RoleSelectMenuInteraction, RoleSelectMenuKit >, data?: CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData) => this`} /> +CommandKitSelectMenuBuilderInteractionCollectorDispatch< RoleSelectMenuInteraction, RoleSelectMenuKit >, data?: CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData) => this`} /> Sets the handler to run when the modal is submitted. @@ -59,17 +59,17 @@ const modal = new RoleSelectMenuKit() ``` ### onEnd -CommandKitSelectMenuBuilderOnEnd) => this`} /> +CommandKitSelectMenuBuilderOnEnd) => this`} /> Sets the handler to run when the interaction collector ends. ### onError -EventInterceptorErrorHandler) => this`} /> +EventInterceptorErrorHandler) => this`} /> Sets the handler to run when the interaction collector ends. ### filter -SelectMenuKitPredicate<RoleSelectMenuInteraction>) => this`} /> +SelectMenuKitPredicate<RoleSelectMenuInteraction>) => this`} /> Sets a filter for the interaction collector. ### dispose diff --git a/apps/website/docs/api-reference/commandkit/classes/runtime-plugin.mdx b/apps/website/docs/api-reference/commandkit/classes/runtime-plugin.mdx index d5c99255..bbe91934 100644 --- a/apps/website/docs/api-reference/commandkit/classes/runtime-plugin.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/runtime-plugin.mdx @@ -42,7 +42,7 @@ class RuntimePlugin extends PluginCommo willEmitEvent(ctx: CommandKitPluginRuntime, event: CommandKitEventDispatch) => ; } ``` -* Extends: PluginCommon<T, CommandKitPluginRuntime> +* Extends: PluginCommon<T, CommandKitPluginRuntime> @@ -60,100 +60,100 @@ class RuntimePlugin extends PluginCommo ### onBeforeCommandsLoad -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> Called before commands are loaded ### onAfterCommandsLoad -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> Called after commands are loaded ### onBeforeEventsLoad -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> Called before events are loaded ### onAfterEventsLoad -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> Called after events are loaded ### onBeforeClientLogin -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> Called before the client logs in ### onAfterClientLogin -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> Called after the client logs in ### onBeforeInteraction -CommandKitPluginRuntime, interaction: Interaction) => Promise<void>`} /> +CommandKitPluginRuntime, interaction: Interaction) => Promise<void>`} /> Called before interaction is handled ### onBeforeMessageCommand -CommandKitPluginRuntime, message: Message) => Promise<void>`} /> +CommandKitPluginRuntime, message: Message) => Promise<void>`} /> Called before message command is processed ### executeCommand -CommandKitPluginRuntime, env: CommandKitEnvironment, source: Interaction | Message, command: PreparedAppCommandExecution, execute: () => Promise<any>) => Promise<boolean>`} /> +CommandKitPluginRuntime, env: CommandKitEnvironment, source: Interaction | Message, command: PreparedAppCommandExecution, execute: () => Promise<any>) => Promise<boolean>`} /> Called before command is executed. This method can execute the command itself. ### onEventsRouterInit -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> Called after events router is initialized ### onCommandsRouterInit -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> Called after commands router is initialized ### performHMR -CommandKitPluginRuntime, event: CommandKitHMREvent) => Promise<void>`} /> +CommandKitPluginRuntime, event: CommandKitHMREvent) => Promise<void>`} /> Called when HMR event is received ### prepareCommand -CommandKitPluginRuntime, commands: CommandBuilderLike) => Promise<CommandBuilderLike | null>`} /> +CommandKitPluginRuntime, commands: CommandBuilderLike) => Promise<CommandBuilderLike | null>`} /> Called before command is loaded for registration. This method can be used to modify the command data before it is loaded. ### onBeforeRegisterCommands -CommandKitPluginRuntime, event: PreRegisterCommandsEvent) => Promise<void>`} /> +CommandKitPluginRuntime, event: PreRegisterCommandsEvent) => Promise<void>`} /> Called before command is registered to discord. This method can cancel the registration of the command and handle it manually. ### onBeforeRegisterGlobalCommands -CommandKitPluginRuntime, event: PreRegisterCommandsEvent) => Promise<void>`} /> +CommandKitPluginRuntime, event: PreRegisterCommandsEvent) => Promise<void>`} /> Called before global commands registration. This method can cancel the registration of the command and handle it manually. This method is called after `onBeforeRegisterCommands` if that stage was not handled. ### onBeforePrepareGuildCommandsRegistration -CommandKitPluginRuntime, event: PreRegisterCommandsEvent) => Promise<void>`} /> +CommandKitPluginRuntime, event: PreRegisterCommandsEvent) => Promise<void>`} /> Called before guild commands registration. This method can cancel the registration of the command and handle it manually. This method is called before guilds of the command are resolved. It is called after `onBeforeRegisterCommands` if that stage was not handled. ### onBeforeRegisterGuildCommands -CommandKitPluginRuntime, event: PreRegisterCommandsEvent) => Promise<void>`} /> +CommandKitPluginRuntime, event: PreRegisterCommandsEvent) => Promise<void>`} /> Called before guild commands registration. This method can cancel the registration of the command and handle it manually. This method is called after guilds of the command are resolved. It is called after `onBeforePrepareGuildCommandsRegistration` if that stage was not handled. ### onAfterCommand -CommandKitPluginRuntime, env: CommandKitEnvironment) => `} /> +CommandKitPluginRuntime, env: CommandKitEnvironment) => `} /> Called after command and all of its deferred functions are executed. ### willEmitEvent -CommandKitPluginRuntime, event: CommandKitEventDispatch) => `} /> +CommandKitPluginRuntime, event: CommandKitEventDispatch) => `} /> Called before emitting an event diff --git a/apps/website/docs/api-reference/commandkit/classes/semaphore.mdx b/apps/website/docs/api-reference/commandkit/classes/semaphore.mdx index f6eba274..4df5f456 100644 --- a/apps/website/docs/api-reference/commandkit/classes/semaphore.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/semaphore.mdx @@ -37,17 +37,17 @@ class Semaphore { ### constructor -SemaphoreOptions = {}) => Semaphore`} /> +SemaphoreOptions = {}) => Semaphore`} /> Creates a new semaphore instance ### setStorage -SemaphoreStorage) => `} /> +SemaphoreStorage) => `} /> Sets the storage implementation for the semaphore ### getStorage - SemaphoreStorage`} /> + SemaphoreStorage`} /> Gets the storage implementation for the semaphore ### acquire @@ -82,7 +82,7 @@ Gets the number of acquired permits for the given key Executes a function with a permit from the semaphore ### getConfig - Omit<SemaphoreOptions, 'storage'>`} /> + Omit<SemaphoreOptions, 'storage'>`} /> Gets the current configuration of the semaphore diff --git a/apps/website/docs/api-reference/commandkit/classes/string-select-menu-kit.mdx b/apps/website/docs/api-reference/commandkit/classes/string-select-menu-kit.mdx index f7c7ffb7..86f4d946 100644 --- a/apps/website/docs/api-reference/commandkit/classes/string-select-menu-kit.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/string-select-menu-kit.mdx @@ -39,7 +39,7 @@ class StringSelectMenuKit extends StringSelectMenuBuilder { ### onSelect -CommandKitSelectMenuBuilderInteractionCollectorDispatch< StringSelectMenuInteraction, StringSelectMenuKit >, data?: CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData) => this`} /> +CommandKitSelectMenuBuilderInteractionCollectorDispatch< StringSelectMenuInteraction, StringSelectMenuKit >, data?: CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData) => this`} /> Sets the handler to run when the modal is submitted. @@ -59,17 +59,17 @@ const modal = new StringSelectMenuKit() ``` ### onEnd -CommandKitSelectMenuBuilderOnEnd) => this`} /> +CommandKitSelectMenuBuilderOnEnd) => this`} /> Sets the handler to run when the interaction collector ends. ### onError -EventInterceptorErrorHandler) => this`} /> +EventInterceptorErrorHandler) => this`} /> Sets the handler to run when the interaction collector ends. ### filter -SelectMenuKitPredicate<StringSelectMenuInteraction>) => this`} /> +SelectMenuKitPredicate<StringSelectMenuInteraction>) => this`} /> Sets a filter for the interaction collector. ### dispose diff --git a/apps/website/docs/api-reference/commandkit/classes/user-select-menu-kit.mdx b/apps/website/docs/api-reference/commandkit/classes/user-select-menu-kit.mdx index 865413b0..a6e234dd 100644 --- a/apps/website/docs/api-reference/commandkit/classes/user-select-menu-kit.mdx +++ b/apps/website/docs/api-reference/commandkit/classes/user-select-menu-kit.mdx @@ -39,7 +39,7 @@ class UserSelectMenuKit extends UserSelectMenuBuilder { ### onSelect -CommandKitSelectMenuBuilderInteractionCollectorDispatch< UserSelectMenuInteraction, UserSelectMenuKit >, data?: CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData) => this`} /> +CommandKitSelectMenuBuilderInteractionCollectorDispatch< UserSelectMenuInteraction, UserSelectMenuKit >, data?: CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData) => this`} /> Sets the handler to run when the modal is submitted. @@ -59,17 +59,17 @@ const modal = new UserSelectMenuKit() ``` ### onEnd -CommandKitSelectMenuBuilderOnEnd) => this`} /> +CommandKitSelectMenuBuilderOnEnd) => this`} /> Sets the handler to run when the interaction collector ends. ### onError -EventInterceptorErrorHandler) => this`} /> +EventInterceptorErrorHandler) => this`} /> Sets the handler to run when the interaction collector ends. ### filter -SelectMenuKitPredicate<UserSelectMenuInteraction>) => this`} /> +SelectMenuKitPredicate<UserSelectMenuInteraction>) => this`} /> Sets a filter for the interaction collector. ### dispose diff --git a/apps/website/docs/api-reference/commandkit/enums/command-kit-environment-type.mdx b/apps/website/docs/api-reference/commandkit/enums/command-kit-environment-type.mdx index 11a83e4f..b9b113e9 100644 --- a/apps/website/docs/api-reference/commandkit/enums/command-kit-environment-type.mdx +++ b/apps/website/docs/api-reference/commandkit/enums/command-kit-environment-type.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CommandKitEnvironmentType - + diff --git a/apps/website/docs/api-reference/commandkit/functions/action-row.mdx b/apps/website/docs/api-reference/commandkit/functions/action-row.mdx index c44ba055..ead3da1d 100644 --- a/apps/website/docs/api-reference/commandkit/functions/action-row.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/action-row.mdx @@ -32,5 +32,5 @@ Parameters ### props -ActionRowProps`} /> +ActionRowProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/after.mdx b/apps/website/docs/api-reference/commandkit/functions/after.mdx index aacb4934..2be5a22b 100644 --- a/apps/website/docs/api-reference/commandkit/functions/after.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/after.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## after - + Schedules the given function to run after the current command has finished executing. @@ -41,5 +41,5 @@ Parameters ### fn -GenericFunction<[CommandKitEnvironment]>`} /> +GenericFunction<[CommandKitEnvironment]>`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/button.mdx b/apps/website/docs/api-reference/commandkit/functions/button.mdx index ec7a3d1d..7d5b90a4 100644 --- a/apps/website/docs/api-reference/commandkit/functions/button.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/button.mdx @@ -32,5 +32,5 @@ Parameters ### props -ButtonProps`} /> +ButtonProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/cancel-after.mdx b/apps/website/docs/api-reference/commandkit/functions/cancel-after.mdx index 83c15b5e..f6ed7c4f 100644 --- a/apps/website/docs/api-reference/commandkit/functions/cancel-after.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/cancel-after.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## cancelAfter - + Cancels a deferred function registered with `after`. diff --git a/apps/website/docs/api-reference/commandkit/functions/channel-select-menu.mdx b/apps/website/docs/api-reference/commandkit/functions/channel-select-menu.mdx index 6ede128b..9f982260 100644 --- a/apps/website/docs/api-reference/commandkit/functions/channel-select-menu.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/channel-select-menu.mdx @@ -33,5 +33,5 @@ Parameters ### props -ChannelSelectMenuProps`} /> +ChannelSelectMenuProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/container.mdx b/apps/website/docs/api-reference/commandkit/functions/container.mdx index f54fed1c..ba0cd910 100644 --- a/apps/website/docs/api-reference/commandkit/functions/container.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/container.mdx @@ -34,5 +34,5 @@ Parameters ### props -ContainerProps`} /> +ContainerProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/create-async-queue.mdx b/apps/website/docs/api-reference/commandkit/functions/create-async-queue.mdx index 648c96e4..1a514a5a 100644 --- a/apps/website/docs/api-reference/commandkit/functions/create-async-queue.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/create-async-queue.mdx @@ -38,5 +38,5 @@ Parameters ### options -AsyncQueueOptions`} /> +AsyncQueueOptions`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/create-logger.mdx b/apps/website/docs/api-reference/commandkit/functions/create-logger.mdx index 1df0fdc4..adfb2451 100644 --- a/apps/website/docs/api-reference/commandkit/functions/create-logger.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/create-logger.mdx @@ -24,5 +24,5 @@ Parameters ### options -CommandKitLoggerOptions`} /> +CommandKitLoggerOptions`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/create-mutex.mdx b/apps/website/docs/api-reference/commandkit/functions/create-mutex.mdx index 4db4b649..01bb4d61 100644 --- a/apps/website/docs/api-reference/commandkit/functions/create-mutex.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/create-mutex.mdx @@ -35,5 +35,5 @@ Parameters ### options -MutexOptions`} /> +MutexOptions`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/create-rate-limiter.mdx b/apps/website/docs/api-reference/commandkit/functions/create-rate-limiter.mdx index 16f54d88..3d81ace2 100644 --- a/apps/website/docs/api-reference/commandkit/functions/create-rate-limiter.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/create-rate-limiter.mdx @@ -36,5 +36,5 @@ Parameters ### options -RateLimitOptions`} /> +RateLimitOptions`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/create-semaphore.mdx b/apps/website/docs/api-reference/commandkit/functions/create-semaphore.mdx index b5b2c0c1..cc336dae 100644 --- a/apps/website/docs/api-reference/commandkit/functions/create-semaphore.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/create-semaphore.mdx @@ -36,5 +36,5 @@ Parameters ### options -SemaphoreOptions`} /> +SemaphoreOptions`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/define-config.mdx b/apps/website/docs/api-reference/commandkit/functions/define-config.mdx index a8397ec3..91d7bde1 100644 --- a/apps/website/docs/api-reference/commandkit/functions/define-config.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/define-config.mdx @@ -24,5 +24,5 @@ Parameters ### config -CommandKitConfig>`} /> +CommandKitConfig>`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/deserializer.mdx b/apps/website/docs/api-reference/commandkit/functions/deserializer.mdx index e6c9a3d5..faef59eb 100644 --- a/apps/website/docs/api-reference/commandkit/functions/deserializer.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/deserializer.mdx @@ -24,5 +24,5 @@ Parameters ### serialized -SerializedValue`} /> +SerializedValue`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/exit-context.mdx b/apps/website/docs/api-reference/commandkit/functions/exit-context.mdx index 5661a27e..f4d7c397 100644 --- a/apps/website/docs/api-reference/commandkit/functions/exit-context.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/exit-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## exitContext - + diff --git a/apps/website/docs/api-reference/commandkit/functions/file.mdx b/apps/website/docs/api-reference/commandkit/functions/file.mdx index 24e90638..c6fa188d 100644 --- a/apps/website/docs/api-reference/commandkit/functions/file.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/file.mdx @@ -34,5 +34,5 @@ Parameters ### props -FileProps`} /> +FileProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/flag.mdx b/apps/website/docs/api-reference/commandkit/functions/flag.mdx index e5b436d7..460e8e2b 100644 --- a/apps/website/docs/api-reference/commandkit/functions/flag.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/flag.mdx @@ -24,5 +24,5 @@ Parameters ### options -FeatureFlagDefinition<Returns, Entity>`} /> +FeatureFlagDefinition<Returns, Entity>`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/fragment.mdx b/apps/website/docs/api-reference/commandkit/functions/fragment.mdx index 971c2181..908d8b86 100644 --- a/apps/website/docs/api-reference/commandkit/functions/fragment.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/fragment.mdx @@ -24,5 +24,5 @@ Parameters ### props -FragmentElementProps`} /> +FragmentElementProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/get-command-kit.mdx b/apps/website/docs/api-reference/commandkit/functions/get-command-kit.mdx index 9823dad1..9f75845f 100644 --- a/apps/website/docs/api-reference/commandkit/functions/get-command-kit.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/get-command-kit.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## getCommandKit - + diff --git a/apps/website/docs/api-reference/commandkit/functions/is-command-worker-context.mdx b/apps/website/docs/api-reference/commandkit/functions/is-command-worker-context.mdx index 9192ee6d..a0cfd280 100644 --- a/apps/website/docs/api-reference/commandkit/functions/is-command-worker-context.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/is-command-worker-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## isCommandWorkerContext - + Checks if the given worker is a CommandKit worker context. diff --git a/apps/website/docs/api-reference/commandkit/functions/is-interaction-source.mdx b/apps/website/docs/api-reference/commandkit/functions/is-interaction-source.mdx index 9eaedf89..86f7c826 100644 --- a/apps/website/docs/api-reference/commandkit/functions/is-interaction-source.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/is-interaction-source.mdx @@ -24,5 +24,5 @@ Parameters ### source -CommandSource`} /> +CommandSource`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/is-message-source.mdx b/apps/website/docs/api-reference/commandkit/functions/is-message-source.mdx index 7eaffbed..bed84e61 100644 --- a/apps/website/docs/api-reference/commandkit/functions/is-message-source.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/is-message-source.mdx @@ -24,5 +24,5 @@ Parameters ### source -CommandSource`} /> +CommandSource`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/media-gallery-item.mdx b/apps/website/docs/api-reference/commandkit/functions/media-gallery-item.mdx index 4d2b4c7e..4e94dafe 100644 --- a/apps/website/docs/api-reference/commandkit/functions/media-gallery-item.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/media-gallery-item.mdx @@ -34,5 +34,5 @@ Parameters ### props -MediaGalleryItemProps`} /> +MediaGalleryItemProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/media-gallery.mdx b/apps/website/docs/api-reference/commandkit/functions/media-gallery.mdx index 03cc3641..9a76d0b7 100644 --- a/apps/website/docs/api-reference/commandkit/functions/media-gallery.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/media-gallery.mdx @@ -39,5 +39,5 @@ Parameters ### props -MediaGalleryProps`} /> +MediaGalleryProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/mentionable-select-menu.mdx b/apps/website/docs/api-reference/commandkit/functions/mentionable-select-menu.mdx index 1b5e3118..b172044f 100644 --- a/apps/website/docs/api-reference/commandkit/functions/mentionable-select-menu.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/mentionable-select-menu.mdx @@ -33,5 +33,5 @@ Parameters ### props -MentionableSelectMenuProps`} /> +MentionableSelectMenuProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/modal.mdx b/apps/website/docs/api-reference/commandkit/functions/modal.mdx index cd2e375e..9ad5c3dc 100644 --- a/apps/website/docs/api-reference/commandkit/functions/modal.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/modal.mdx @@ -32,5 +32,5 @@ Parameters ### props -ModalProps`} /> +ModalProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/on-application-bootstrap.mdx b/apps/website/docs/api-reference/commandkit/functions/on-application-bootstrap.mdx index 3a99fd07..3cab400c 100644 --- a/apps/website/docs/api-reference/commandkit/functions/on-application-bootstrap.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/on-application-bootstrap.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## onApplicationBootstrap - + Registers a bootstrap hook that will be called when the CommandKit instance is created. This is useful for plugins that need to run some code after the CommandKit instance is fully initialized. diff --git a/apps/website/docs/api-reference/commandkit/functions/on-bootstrap.mdx b/apps/website/docs/api-reference/commandkit/functions/on-bootstrap.mdx index 31a15aaf..2f0c92af 100644 --- a/apps/website/docs/api-reference/commandkit/functions/on-bootstrap.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/on-bootstrap.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## onBootstrap - + Registers a bootstrap hook that will be called when the CommandKit instance is created. This is useful for plugins that need to run some code after the CommandKit instance is fully initialized. diff --git a/apps/website/docs/api-reference/commandkit/functions/open-kv.mdx b/apps/website/docs/api-reference/commandkit/functions/open-kv.mdx index c9cd9d63..3572d519 100644 --- a/apps/website/docs/api-reference/commandkit/functions/open-kv.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/open-kv.mdx @@ -28,5 +28,5 @@ Parameters ### options -KvOptions`} /> +KvOptions`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/paragraph-input.mdx b/apps/website/docs/api-reference/commandkit/functions/paragraph-input.mdx index 18571f91..ada3cfc4 100644 --- a/apps/website/docs/api-reference/commandkit/functions/paragraph-input.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/paragraph-input.mdx @@ -32,5 +32,5 @@ Parameters ### props -TextInputProps`} /> +TextInputProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/provide-context.mdx b/apps/website/docs/api-reference/commandkit/functions/provide-context.mdx index c0ebaa60..5477972f 100644 --- a/apps/website/docs/api-reference/commandkit/functions/provide-context.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/provide-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## provideContext - + Executes the provided function within a CommandKit context. @@ -24,7 +24,7 @@ Parameters ### value -CommandKitEnvironment`} /> +CommandKitEnvironment`} /> ### receiver diff --git a/apps/website/docs/api-reference/commandkit/functions/register-dev-hooks.mdx b/apps/website/docs/api-reference/commandkit/functions/register-dev-hooks.mdx index ad4b9f98..191f08cf 100644 --- a/apps/website/docs/api-reference/commandkit/functions/register-dev-hooks.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/register-dev-hooks.mdx @@ -24,5 +24,5 @@ Parameters ### commandkit -CommandKit`} /> +CommandKit`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/role-select-menu.mdx b/apps/website/docs/api-reference/commandkit/functions/role-select-menu.mdx index 2252ffb8..65fd170f 100644 --- a/apps/website/docs/api-reference/commandkit/functions/role-select-menu.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/role-select-menu.mdx @@ -34,5 +34,5 @@ Parameters ### props -RoleSelectMenuProps`} /> +RoleSelectMenuProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/run-in-event-worker-context.mdx b/apps/website/docs/api-reference/commandkit/functions/run-in-event-worker-context.mdx index 5feeaab6..1860b902 100644 --- a/apps/website/docs/api-reference/commandkit/functions/run-in-event-worker-context.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/run-in-event-worker-context.mdx @@ -24,7 +24,7 @@ Parameters ### context -EventWorkerContext`} /> +EventWorkerContext`} /> ### callback diff --git a/apps/website/docs/api-reference/commandkit/functions/section.mdx b/apps/website/docs/api-reference/commandkit/functions/section.mdx index bc78aef1..741a43a9 100644 --- a/apps/website/docs/api-reference/commandkit/functions/section.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/section.mdx @@ -34,5 +34,5 @@ Parameters ### props -SectionProps`} /> +SectionProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/separator.mdx b/apps/website/docs/api-reference/commandkit/functions/separator.mdx index 113609a8..534aea30 100644 --- a/apps/website/docs/api-reference/commandkit/functions/separator.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/separator.mdx @@ -34,5 +34,5 @@ Parameters ### props -SeparatorProps`} /> +SeparatorProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/set-flag-provider.mdx b/apps/website/docs/api-reference/commandkit/functions/set-flag-provider.mdx index 5ab916ca..9c26e475 100644 --- a/apps/website/docs/api-reference/commandkit/functions/set-flag-provider.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/set-flag-provider.mdx @@ -24,5 +24,5 @@ Parameters ### provider -FlagProvider`} /> +FlagProvider`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/short-input.mdx b/apps/website/docs/api-reference/commandkit/functions/short-input.mdx index 10176622..6b2416f9 100644 --- a/apps/website/docs/api-reference/commandkit/functions/short-input.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/short-input.mdx @@ -32,5 +32,5 @@ Parameters ### props -TextInputProps`} /> +TextInputProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/string-select-menu-option.mdx b/apps/website/docs/api-reference/commandkit/functions/string-select-menu-option.mdx index af5f860b..e8258217 100644 --- a/apps/website/docs/api-reference/commandkit/functions/string-select-menu-option.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/string-select-menu-option.mdx @@ -34,5 +34,5 @@ Parameters ### props -StringSelectMenuOptionProps`} /> +StringSelectMenuOptionProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/string-select-menu.mdx b/apps/website/docs/api-reference/commandkit/functions/string-select-menu.mdx index d1a47acc..0c7c0ea4 100644 --- a/apps/website/docs/api-reference/commandkit/functions/string-select-menu.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/string-select-menu.mdx @@ -42,5 +42,5 @@ Parameters ### props -StringSelectMenuProps`} /> +StringSelectMenuProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/text-display.mdx b/apps/website/docs/api-reference/commandkit/functions/text-display.mdx index a902c1f5..2336464b 100644 --- a/apps/website/docs/api-reference/commandkit/functions/text-display.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/text-display.mdx @@ -36,5 +36,5 @@ Parameters ### props -TextDisplayProps`} /> +TextDisplayProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/text-input.mdx b/apps/website/docs/api-reference/commandkit/functions/text-input.mdx index d9f80709..486b22cf 100644 --- a/apps/website/docs/api-reference/commandkit/functions/text-input.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/text-input.mdx @@ -32,5 +32,5 @@ Parameters ### props -TextInputProps & { style: TextInputStyle }`} /> +TextInputProps & { style: TextInputStyle }`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/thumbnail.mdx b/apps/website/docs/api-reference/commandkit/functions/thumbnail.mdx index cc36dbda..1cb66622 100644 --- a/apps/website/docs/api-reference/commandkit/functions/thumbnail.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/thumbnail.mdx @@ -34,5 +34,5 @@ Parameters ### props -ThumbnailProps`} /> +ThumbnailProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/functions/use-environment.mdx b/apps/website/docs/api-reference/commandkit/functions/use-environment.mdx index c052206e..e338b83c 100644 --- a/apps/website/docs/api-reference/commandkit/functions/use-environment.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/use-environment.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## useEnvironment - + Use current commandkit context. Throws an error if no context is found. diff --git a/apps/website/docs/api-reference/commandkit/functions/use-store.mdx b/apps/website/docs/api-reference/commandkit/functions/use-store.mdx new file mode 100644 index 00000000..a301fd4a --- /dev/null +++ b/apps/website/docs/api-reference/commandkit/functions/use-store.mdx @@ -0,0 +1,22 @@ +--- +title: "UseStore" +isDefaultIndex: false +generated: true +--- + +import MemberInfo from '@site/src/components/MemberInfo'; +import GenerationInfo from '@site/src/components/GenerationInfo'; +import MemberDescription from '@site/src/components/MemberDescription'; + + + + +## useStore + + + +Use the shared data store in the current environment. Throws an error if no context is found. + +```ts title="Signature" +function useStore(): Collection +``` diff --git a/apps/website/docs/api-reference/commandkit/functions/user-select-menu.mdx b/apps/website/docs/api-reference/commandkit/functions/user-select-menu.mdx index 673d1ab6..bd40fea5 100644 --- a/apps/website/docs/api-reference/commandkit/functions/user-select-menu.mdx +++ b/apps/website/docs/api-reference/commandkit/functions/user-select-menu.mdx @@ -34,5 +34,5 @@ Parameters ### props -UserSelectMenuProps`} /> +UserSelectMenuProps`} /> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/action-row-props.mdx b/apps/website/docs/api-reference/commandkit/interfaces/action-row-props.mdx index 5d1d0b17..bfd36b80 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/action-row-props.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/action-row-props.mdx @@ -27,7 +27,7 @@ interface ActionRowProps { ### children -AnyCommandKitElement[] | AnyCommandKitElement`} /> +AnyCommandKitElement[] | AnyCommandKitElement`} /> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/analytics-provider.mdx b/apps/website/docs/api-reference/commandkit/interfaces/analytics-provider.mdx index c20e7e82..063da4b0 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/analytics-provider.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/analytics-provider.mdx @@ -35,13 +35,13 @@ The name of the analytics provider. This is used for logging and identification purposes. ### track -AnalyticsEngine, event: AnalyticsEvent) => Promise<void>`} /> +AnalyticsEngine, event: AnalyticsEvent) => Promise<void>`} /> Initializes the analytics provider. This method is called when the provider is registered. ### identify -AnalyticsEngine, event: IdentifyEvent) => Promise<void>`} /> +AnalyticsEngine, event: IdentifyEvent) => Promise<void>`} /> Identifies a user or entity with the analytics provider. This method is called to associate user data with events. diff --git a/apps/website/docs/api-reference/commandkit/interfaces/app-command-native.mdx b/apps/website/docs/api-reference/commandkit/interfaces/app-command-native.mdx index fed296b5..d4fa2f39 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/app-command-native.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/app-command-native.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## AppCommandNative - + Represents a native command structure used in CommandKit. This structure includes the command definition and various handlers for different interaction types. @@ -36,42 +36,42 @@ interface AppCommandNative { ### command -CommandData | Record<string, any>`} /> +CommandData | Record<string, any>`} /> ### generateMetadata -CommandMetadataFunction`} /> +CommandMetadataFunction`} /> ### metadata -CommandMetadata`} /> +CommandMetadata`} /> ### chatInput -Context) => Awaitable<unknown>`} /> +Context) => Awaitable<unknown>`} /> ### autocomplete -Context) => Awaitable<unknown>`} /> +Context) => Awaitable<unknown>`} /> ### message -Context) => Awaitable<unknown>`} /> +Context) => Awaitable<unknown>`} /> ### messageContextMenu -Context) => Awaitable<unknown>`} /> +Context) => Awaitable<unknown>`} /> ### userContextMenu -Context) => Awaitable<unknown>`} /> +Context) => Awaitable<unknown>`} /> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/app-events-handler-loaded-data.mdx b/apps/website/docs/api-reference/commandkit/interfaces/app-events-handler-loaded-data.mdx index 83363c0e..bab74ee3 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/app-events-handler-loaded-data.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/app-events-handler-loaded-data.mdx @@ -51,7 +51,7 @@ interface AppEventsHandlerLoadedData { ### metadata -ParsedEvent`} /> +ParsedEvent`} /> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/button-props.mdx b/apps/website/docs/api-reference/commandkit/interfaces/button-props.mdx index 3692ec96..da7672dc 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/button-props.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/button-props.mdx @@ -73,27 +73,27 @@ interface ButtonProps { ### onClick -CommandKitButtonBuilderInteractionCollectorDispatch`} /> +CommandKitButtonBuilderInteractionCollectorDispatch`} /> ### onError -EventInterceptorErrorHandler`} /> +EventInterceptorErrorHandler`} /> ### options -CommandKitButtonBuilderInteractionCollectorDispatchContextData`} /> +CommandKitButtonBuilderInteractionCollectorDispatchContextData`} /> ### onEnd -CommandKitButtonBuilderOnEnd`} /> +CommandKitButtonBuilderOnEnd`} /> ### children -MaybeArray<ButtonChildrenLike>`} /> +MaybeArray<ButtonChildrenLike>`} /> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/channel-select-menu-props.mdx b/apps/website/docs/api-reference/commandkit/interfaces/channel-select-menu-props.mdx index 74c1fe81..b65fcf46 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/channel-select-menu-props.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/channel-select-menu-props.mdx @@ -23,6 +23,6 @@ interface ChannelSelectMenuProps extends PartialPartial<Omit<ChannelSelectMenuComponentData, 'type'>>, CommonSelectMenuProps<ChannelSelectMenuInteraction, ChannelSelectMenuKit> +* Extends: Partial<Omit<ChannelSelectMenuComponentData, 'type'>>, CommonSelectMenuProps<ChannelSelectMenuInteraction, ChannelSelectMenuKit> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/command-context.mdx b/apps/website/docs/api-reference/commandkit/interfaces/command-context.mdx index dc5f1a4a..12386bcb 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/command-context.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/command-context.mdx @@ -39,7 +39,7 @@ The interaction that triggered this command. The client that instantiated this command. ### handler -CommandKit`} /> +CommandKit`} /> The command data. diff --git a/apps/website/docs/api-reference/commandkit/interfaces/command-flag-context.mdx b/apps/website/docs/api-reference/commandkit/interfaces/command-flag-context.mdx index 2fec6a23..4f4a9db0 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/command-flag-context.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/command-flag-context.mdx @@ -64,13 +64,13 @@ The Discord client instance. This is the main entry point for interacting with the Discord API. ### commandkit -CommandKit`} /> +CommandKit`} /> The CommandKit instance, which provides access to the command framework. This includes commands, events, and other features of CommandKit. ### command -LoadedCommand; }`} /> +LoadedCommand; }`} /> The command context, which includes information about the command being executed. This can include the interaction, message, guild, channel, and the loaded command. diff --git a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-config.mdx b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-config.mdx index faec8f8d..26795770 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-config.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-config.mdx @@ -65,7 +65,7 @@ interface CommandKitConfig { ### plugins -MaybeArray<CommandKitPlugin>[] | Array<CommandKitPlugin>`} /> +MaybeArray<CommandKitPlugin>[] | Array<CommandKitPlugin>`} /> The plugins to use with CommandKit. Can be a single plugin, an array of plugins, or a nested array of plugins. @@ -82,7 +82,7 @@ The list of additional entrypoints to compile. Eg, `dir` or `dir/index.ts` or `d Similarly, negative patterns can be used to exclude files. Eg, `!dir/index.ts` or `!dir/*.ts`, etc. ### compilerOptions -CommandKitCompilerOptions`} /> +CommandKitCompilerOptions`} /> The compiler options to use with CommandKit. ### typescript diff --git a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-configuration.mdx b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-configuration.mdx index dad63115..db9829f2 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-configuration.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-configuration.mdx @@ -20,7 +20,9 @@ Configurations for the CommandKit instance. ```ts title="Signature" interface CommandKitConfiguration { defaultLocale: Locale; - getMessageCommandPrefix: (message: Message) => Awaitable; + getMessageCommandPrefix: ( + message: Message, + ) => Awaitable; } ``` @@ -33,7 +35,7 @@ interface CommandKitConfiguration { The default locale for the CommandKit instance. This will be used to infer the locale of the guild or user if it has not been set explicitly. ### getMessageCommandPrefix - + A function that returns the command prefix for a given message. This is used to determine how to parse commands from messages. diff --git a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-element-data.mdx b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-element-data.mdx index f83ee7a4..cf684288 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-element-data.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-element-data.mdx @@ -35,12 +35,12 @@ interface CommandKitElementData { ### \[ElementType.Button] -ButtonKit`} /> +ButtonKit`} /> ### \[ElementType.Modal] -ModalKit`} /> +ModalKit`} /> ### \[ElementType.TextInput] diff --git a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-environment-internal-data.mdx b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-environment-internal-data.mdx index 57b7c3cb..99050337 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-environment-internal-data.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-environment-internal-data.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CommandKitEnvironmentInternalData - + Represents the internal data structure for the CommandKit environment. @@ -27,6 +27,7 @@ interface CommandKitEnvironmentInternalData { markStart: number; markEnd: number; context: Context | null; + store: Collection; } ``` @@ -40,7 +41,7 @@ The error that occurred during command execution, if any. This is set when an error occurs during the execution of a command. ### type -CommandKitEnvironmentType | null`} /> +CommandKitEnvironmentType | null`} /> The type of the environment, which can be used to differentiate between different execution contexts (e.g., command handler, event handler, etc.). @@ -52,7 +53,7 @@ A map of variables that can be used to store and retrieve data during command ex This allows for sharing data between different parts of the command execution process. ### deferredFunctions -GenericFunction<[CommandKitEnvironment]>>`} /> +GenericFunction<[CommandKitEnvironment]>>`} /> A map of deferred functions that will be executed after the command has finished executing. This is useful for running cleanup tasks or additional processing after the main command logic. @@ -74,10 +75,15 @@ The start time of the command execution. The end time of the command execution. ### context -Context | null`} /> +Context | null`} /> The context associated with the command execution. This can be used to access request-specific data or application state. +### store + + + +Shared collection instance for arbitrary data storage diff --git a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-event-dispatch.mdx b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-event-dispatch.mdx index b25481e8..e1afbbd8 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-event-dispatch.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-event-dispatch.mdx @@ -52,7 +52,7 @@ The namespace of the event, if any. If this event runs only once, it will be set to true. ### metadata -ParsedEvent`} /> +ParsedEvent`} /> The additional metadata associated with the event. ### accept diff --git a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-hmrevent.mdx b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-hmrevent.mdx index f752ab2c..0ef4e85a 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-hmrevent.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-hmrevent.mdx @@ -30,7 +30,7 @@ interface CommandKitHMREvent { ### event -HMREventType`} /> +HMREventType`} /> The type of HMR event. ### path diff --git a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-logger-options.mdx b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-logger-options.mdx index 780fe583..e3062e68 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-logger-options.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-logger-options.mdx @@ -27,7 +27,7 @@ interface CommandKitLoggerOptions { ### provider -ILogger`} /> +ILogger`} /> The logger provider to use. diff --git a/apps/website/docs/api-reference/commandkit/interfaces/command-metadata.mdx b/apps/website/docs/api-reference/commandkit/interfaces/command-metadata.mdx index d16ccf89..fc250d3b 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/command-metadata.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/command-metadata.mdx @@ -23,6 +23,7 @@ interface CommandMetadata { aliases?: string[]; userPermissions?: PermissionsString | PermissionsString[]; botPermissions?: PermissionsString | PermissionsString[]; + nameAliases?: Record<'user' | 'message', string>; } ``` @@ -48,6 +49,11 @@ The user permissions required to execute the command. The bot permissions required to execute the command. +### nameAliases + + + +The name aliases for the `user` and `message` context menu commands. When i18n plugin is in use, this option will be ignored if the translation for the context menu command name is provided. diff --git a/apps/website/docs/api-reference/commandkit/interfaces/common-select-menu-props.mdx b/apps/website/docs/api-reference/commandkit/interfaces/common-select-menu-props.mdx index a9ddaee2..4c68882c 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/common-select-menu-props.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/common-select-menu-props.mdx @@ -30,12 +30,12 @@ interface CommonSelectMenuProps { ### onSelect -CommandKitSelectMenuBuilderInteractionCollectorDispatch<T, C>`} /> +CommandKitSelectMenuBuilderInteractionCollectorDispatch<T, C>`} /> ### onEnd -CommandKitSelectMenuBuilderOnEnd`} /> +CommandKitSelectMenuBuilderOnEnd`} /> ### onError @@ -45,7 +45,7 @@ interface CommonSelectMenuProps { ### options -CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData`} /> +CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData`} /> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/context-parameters.mdx b/apps/website/docs/api-reference/commandkit/interfaces/context-parameters.mdx index 055f9c5a..9b205c6f 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/context-parameters.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/context-parameters.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## ContextParameters - + Parameters required to create a command context. @@ -34,7 +34,7 @@ interface ContextParameters; + store?: Collection; customArgs?: Args; } ``` @@ -43,12 +43,12 @@ interface ContextParametersLoadedCommand`} /> +LoadedCommand`} /> ### environment -CommandKitEnvironment`} /> +CommandKitEnvironment`} /> ### executionMode @@ -73,12 +73,12 @@ interface ContextParametersMessageCommandParser : never`} /> +MessageCommandParser : never`} /> ### store - + ### customArgs diff --git a/apps/website/docs/api-reference/commandkit/interfaces/custom-app-command-props.mdx b/apps/website/docs/api-reference/commandkit/interfaces/custom-app-command-props.mdx index 1490ec86..c6451ca0 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/custom-app-command-props.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/custom-app-command-props.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CustomAppCommandProps - + Custom properties that can be added to an AppCommand. This allows for additional metadata or configuration to be associated with a command. diff --git a/apps/website/docs/api-reference/commandkit/interfaces/event-flag-context.mdx b/apps/website/docs/api-reference/commandkit/interfaces/event-flag-context.mdx index be20fb31..a3a92cd3 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/event-flag-context.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/event-flag-context.mdx @@ -65,13 +65,13 @@ The Discord client instance. This is the main entry point for interacting with the Discord API. ### commandkit -CommandKit`} /> +CommandKit`} /> The CommandKit instance, which provides access to the command framework. This includes commands, events, and other features of CommandKit. ### event -ParsedEvent; /** * The name of the event being processed. * This is the string identifier for the event, such as 'messageCreate' or 'guildMemberAdd'. */ event: string; /** * The namespace of the event, if applicable. * This can be used to group related events or commands together. * It is null if the event does not belong to a specific namespace. */ namespace: string | null; /** * The arguments passed to the event handler. * This is an array of arguments that were passed when the event was triggered. * It can be used to access specific data related to the event. */ arguments: any[]; /** * A function to retrieve the arguments for a specific event type. * This allows for type-safe access to the arguments based on the event name. * @param event - The name of the event to retrieve arguments for. */ argumentsAs<E extends keyof ClientEvents>(event: E): ClientEvents[E]; }`} /> +ParsedEvent; /** * The name of the event being processed. * This is the string identifier for the event, such as 'messageCreate' or 'guildMemberAdd'. */ event: string; /** * The namespace of the event, if applicable. * This can be used to group related events or commands together. * It is null if the event does not belong to a specific namespace. */ namespace: string | null; /** * The arguments passed to the event handler. * This is an array of arguments that were passed when the event was triggered. * It can be used to access specific data related to the event. */ arguments: any[]; /** * A function to retrieve the arguments for a specific event type. * This allows for type-safe access to the arguments based on the event name. * @param event - The name of the event to retrieve arguments for. */ argumentsAs<E extends keyof ClientEvents>(event: E): ClientEvents[E]; }`} /> The event context, which includes information about the event being processed. This can include the parsed event data, the event name, and the namespace if applicable. diff --git a/apps/website/docs/api-reference/commandkit/interfaces/event-interceptor-context-data.mdx b/apps/website/docs/api-reference/commandkit/interfaces/event-interceptor-context-data.mdx index 0e21360d..2aeb18df 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/event-interceptor-context-data.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/event-interceptor-context-data.mdx @@ -57,7 +57,7 @@ Whether the collector should run only once. The handler to run when the collector ends. ### onError -EventInterceptorErrorHandler`} /> +EventInterceptorErrorHandler`} /> The handler to run upon an error. diff --git a/apps/website/docs/api-reference/commandkit/interfaces/event-worker-context.mdx b/apps/website/docs/api-reference/commandkit/interfaces/event-worker-context.mdx index 4da578e4..61d3e0a2 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/event-worker-context.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/event-worker-context.mdx @@ -42,12 +42,12 @@ interface EventWorkerContext { ### data -ParsedEvent`} /> +ParsedEvent`} /> ### commandkit -CommandKit`} /> +CommandKit`} /> ### arguments diff --git a/apps/website/docs/api-reference/commandkit/interfaces/feature-flag-definition.mdx b/apps/website/docs/api-reference/commandkit/interfaces/feature-flag-definition.mdx index b79870c1..342a6f4e 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/feature-flag-definition.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/feature-flag-definition.mdx @@ -47,14 +47,14 @@ Optional description of the feature flag. This can be used for documentation or debugging purposes. ### identify -IdentifyFunction<Entity>`} /> +IdentifyFunction<Entity>`} /> Optional flag to enable integration with an external flag provider. If true, the flag will use the global flag provider to determine its state. Default: false ### decide -DecideFunction<Entity, R>`} /> +DecideFunction<Entity, R>`} /> Function to decide the outcome of the feature flag. This function receives the identified entities and should return the result of the decision. diff --git a/apps/website/docs/api-reference/commandkit/interfaces/flag-provider.mdx b/apps/website/docs/api-reference/commandkit/interfaces/flag-provider.mdx index 65e13df7..26065703 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/flag-provider.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/flag-provider.mdx @@ -37,7 +37,7 @@ interface FlagProvider { Initialize the provider (e.g., establish connections, load initial config) ### getFlag - MaybePromise<FlagConfiguration | null>`} /> + MaybePromise<FlagConfiguration | null>`} /> Get the current value/configuration for a feature flag ### hasFlag diff --git a/apps/website/docs/api-reference/commandkit/interfaces/flag-runner.mdx b/apps/website/docs/api-reference/commandkit/interfaces/flag-runner.mdx index 3d843554..1cd7372a 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/flag-runner.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/flag-runner.mdx @@ -27,7 +27,7 @@ interface FlagRunner { ### run -CustomEvaluationContext<E>) => Promise<R>`} /> +CustomEvaluationContext<E>) => Promise<R>`} /> Run the feature flag evaluation with a custom context. This allows for more flexible evaluation based on custom logic or external data. diff --git a/apps/website/docs/api-reference/commandkit/interfaces/ipc-message-command.mdx b/apps/website/docs/api-reference/commandkit/interfaces/ipc-message-command.mdx index ed5549c4..8581c315 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/ipc-message-command.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/ipc-message-command.mdx @@ -29,7 +29,7 @@ interface IpcMessageCommand { ### event -HMREventType`} /> +HMREventType`} /> The type of HMR event being communicated. ### path diff --git a/apps/website/docs/api-reference/commandkit/interfaces/legacy-command-metadata.mdx b/apps/website/docs/api-reference/commandkit/interfaces/legacy-command-metadata.mdx index 6af246a2..2d1e7d16 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/legacy-command-metadata.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/legacy-command-metadata.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## LegacyCommandMetadata - + diff --git a/apps/website/docs/api-reference/commandkit/interfaces/loaded-command.mdx b/apps/website/docs/api-reference/commandkit/interfaces/loaded-command.mdx index 08af0497..4dd60ca7 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/loaded-command.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/loaded-command.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## LoadedCommand - + Represents a loaded command with its metadata and configuration. @@ -29,17 +29,17 @@ interface LoadedCommand { ### command -Command`} /> +Command`} /> ### metadata -CommandMetadata`} /> +CommandMetadata`} /> ### data -AppCommand`} /> +AppCommand`} /> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/loaded-event.mdx b/apps/website/docs/api-reference/commandkit/interfaces/loaded-event.mdx index cc9889b2..1db98c4d 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/loaded-event.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/loaded-event.mdx @@ -42,22 +42,22 @@ interface LoadedEvent { ### event -ParsedEvent`} /> +ParsedEvent`} /> ### listeners -EventListener[]`} /> +EventListener[]`} /> ### mainListener -EventListener`} /> +EventListener`} /> ### executedOnceListeners -ListenerFunction>`} /> +ListenerFunction>`} /> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/logger-impl.mdx b/apps/website/docs/api-reference/commandkit/interfaces/logger-impl.mdx index afbfd21a..77360c29 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/logger-impl.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/logger-impl.mdx @@ -22,7 +22,7 @@ interface LoggerImpl extends ILogger { configure(options: CommandKitLoggerOptions): void; } ``` -* Extends: ILogger +* Extends: ILogger @@ -30,7 +30,7 @@ interface LoggerImpl extends ILogger { ### configure -CommandKitLoggerOptions) => void`} /> +CommandKitLoggerOptions) => void`} /> Configures the logger with the specified options. diff --git a/apps/website/docs/api-reference/commandkit/interfaces/mentionable-select-menu-props.mdx b/apps/website/docs/api-reference/commandkit/interfaces/mentionable-select-menu-props.mdx index b33f1eea..75eb12ed 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/mentionable-select-menu-props.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/mentionable-select-menu-props.mdx @@ -26,6 +26,6 @@ interface MentionableSelectMenuProps extends PartialPartial<Omit<MentionableSelectMenuComponentData, 'type'>>, CommonSelectMenuProps< MentionableSelectMenuInteraction, MentionableSelectMenuKit > +* Extends: Partial<Omit<MentionableSelectMenuComponentData, 'type'>>, CommonSelectMenuProps< MentionableSelectMenuInteraction, MentionableSelectMenuKit > diff --git a/apps/website/docs/api-reference/commandkit/interfaces/middleware-context-args.mdx b/apps/website/docs/api-reference/commandkit/interfaces/middleware-context-args.mdx index 0b272dc8..497c83f1 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/middleware-context-args.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/middleware-context-args.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## MiddlewareContextArgs - + Arguments for middleware context. @@ -27,7 +27,7 @@ interface MiddlewareContextArgs { ### setCommandRunner -GenericFunction<[RunCommand]>`} /> +GenericFunction<[RunCommand]>`} /> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/modal-props.mdx b/apps/website/docs/api-reference/commandkit/interfaces/modal-props.mdx index 8d6f2e96..b18219eb 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/modal-props.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/modal-props.mdx @@ -43,27 +43,27 @@ interface ModalProps { ### children -MaybeArray<TextInputBuilder | ActionRowBuilder>`} /> +MaybeArray<TextInputBuilder | ActionRowBuilder>`} /> ### onSubmit -OnModalKitSubmit`} /> +OnModalKitSubmit`} /> ### onEnd -OnModalKitEnd`} /> +OnModalKitEnd`} /> ### onError -EventInterceptorErrorHandler`} /> +EventInterceptorErrorHandler`} /> ### options -CommandKitModalBuilderInteractionCollectorDispatchContextData`} /> +CommandKitModalBuilderInteractionCollectorDispatchContextData`} /> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/mutex-options.mdx b/apps/website/docs/api-reference/commandkit/interfaces/mutex-options.mdx index 59ef2503..fbcb4307 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/mutex-options.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/mutex-options.mdx @@ -33,9 +33,9 @@ interface MutexOptions { Default timeout in milliseconds for lock acquisition. Default: 30000 ### storage -MutexStorage`} /> +MutexStorage`} /> -Storage implementation for persisting mutex data. Default: MemoryMutexStorage +Storage implementation for persisting mutex data. Default: MemoryMutexStorage diff --git a/apps/website/docs/api-reference/commandkit/interfaces/parsed-command-data.mdx b/apps/website/docs/api-reference/commandkit/interfaces/parsed-command-data.mdx index fcd8eead..b03d8b26 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/parsed-command-data.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/parsed-command-data.mdx @@ -28,12 +28,12 @@ interface ParsedCommandData { ### commands -Command>`} /> +Command>`} /> ### middlewares -Middleware>`} /> +Middleware>`} /> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/pre-register-commands-event.mdx b/apps/website/docs/api-reference/commandkit/interfaces/pre-register-commands-event.mdx index 941e1ad9..a159528f 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/pre-register-commands-event.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/pre-register-commands-event.mdx @@ -33,7 +33,7 @@ interface PreRegisterCommandsEvent { ### commands -CommandData[]`} /> +CommandData[]`} /> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/prepared-app-command-execution.mdx b/apps/website/docs/api-reference/commandkit/interfaces/prepared-app-command-execution.mdx index 205e4491..18694201 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/prepared-app-command-execution.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/prepared-app-command-execution.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## PreparedAppCommandExecution - + Represents a prepared command execution with all necessary data and middleware. @@ -29,7 +29,7 @@ interface PreparedAppCommandExecution { ### command -LoadedCommand`} /> +LoadedCommand`} /> ### middlewares @@ -39,7 +39,7 @@ interface PreparedAppCommandExecution { ### messageCommandParser -MessageCommandParser`} /> +MessageCommandParser`} /> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/rate-limit-options.mdx b/apps/website/docs/api-reference/commandkit/interfaces/rate-limit-options.mdx index 5f64cbe9..17953dba 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/rate-limit-options.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/rate-limit-options.mdx @@ -39,9 +39,9 @@ Maximum number of requests allowed per interval. Default: 10 Time interval in milliseconds for the rate limit window. Default: 60000 ### storage -RateLimitStorage`} /> +RateLimitStorage`} /> -Storage implementation for persisting rate limit data. Default: MemoryRateLimitStorage +Storage implementation for persisting rate limit data. Default: MemoryRateLimitStorage diff --git a/apps/website/docs/api-reference/commandkit/interfaces/role-select-menu-props.mdx b/apps/website/docs/api-reference/commandkit/interfaces/role-select-menu-props.mdx index 80eb5336..9729570a 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/role-select-menu-props.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/role-select-menu-props.mdx @@ -23,6 +23,6 @@ interface RoleSelectMenuProps extends PartialPartial<Omit<RoleSelectMenuComponentData, 'type'>>, CommonSelectMenuProps<RoleSelectMenuInteraction, RoleSelectMenuKit> +* Extends: Partial<Omit<RoleSelectMenuComponentData, 'type'>>, CommonSelectMenuProps<RoleSelectMenuInteraction, RoleSelectMenuKit> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/select-menu-props.mdx b/apps/website/docs/api-reference/commandkit/interfaces/select-menu-props.mdx index ed507ba0..70847b9a 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/select-menu-props.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/select-menu-props.mdx @@ -23,6 +23,6 @@ interface SelectMenuProps extends PartialPartial<Omit<BaseSelectMenuComponentData, 'type'>>, CommonSelectMenuProps<T, C> +* Extends: Partial<Omit<BaseSelectMenuComponentData, 'type'>>, CommonSelectMenuProps<T, C> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/semaphore-options.mdx b/apps/website/docs/api-reference/commandkit/interfaces/semaphore-options.mdx index b90af75f..e693862f 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/semaphore-options.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/semaphore-options.mdx @@ -39,9 +39,9 @@ Maximum number of concurrent permits allowed. Default: 1 Default timeout in milliseconds for permit acquisition. Default: 30000 ### storage -SemaphoreStorage`} /> +SemaphoreStorage`} /> -Storage implementation for persisting semaphore data. Default: MemorySemaphoreStorage +Storage implementation for persisting semaphore data. Default: MemorySemaphoreStorage diff --git a/apps/website/docs/api-reference/commandkit/interfaces/serialized-value.mdx b/apps/website/docs/api-reference/commandkit/interfaces/serialized-value.mdx index be9d0e6f..b35a1a00 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/serialized-value.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/serialized-value.mdx @@ -28,7 +28,7 @@ interface SerializedValue { ### t -SerializerType`} /> +SerializerType`} /> ### v diff --git a/apps/website/docs/api-reference/commandkit/interfaces/string-select-menu-props.mdx b/apps/website/docs/api-reference/commandkit/interfaces/string-select-menu-props.mdx index 2d8c5295..3a88228a 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/string-select-menu-props.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/string-select-menu-props.mdx @@ -22,7 +22,7 @@ interface StringSelectMenuProps extends SelectMenuProps; } ``` -* Extends: SelectMenuProps<StringSelectMenuInteraction, StringSelectMenuKit> +* Extends: SelectMenuProps<StringSelectMenuInteraction, StringSelectMenuKit> @@ -30,7 +30,7 @@ interface StringSelectMenuProps extends SelectMenuPropsMaybeArray<StringSelectMenuOptionBuilder>`} /> +MaybeArray<StringSelectMenuOptionBuilder>`} /> diff --git a/apps/website/docs/api-reference/commandkit/interfaces/text-display-props.mdx b/apps/website/docs/api-reference/commandkit/interfaces/text-display-props.mdx index 83fd11f0..4e3159b7 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/text-display-props.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/text-display-props.mdx @@ -33,7 +33,7 @@ interface TextDisplayProps extends OmitStringEncodable | StringEncodable[]`} /> +StringEncodable | StringEncodable[]`} /> ### content diff --git a/apps/website/docs/api-reference/commandkit/interfaces/user-select-menu-props.mdx b/apps/website/docs/api-reference/commandkit/interfaces/user-select-menu-props.mdx index 83db9289..4dd35c20 100644 --- a/apps/website/docs/api-reference/commandkit/interfaces/user-select-menu-props.mdx +++ b/apps/website/docs/api-reference/commandkit/interfaces/user-select-menu-props.mdx @@ -23,6 +23,6 @@ interface UserSelectMenuProps extends PartialPartial<Omit<UserSelectMenuComponentData, 'type'>>, CommonSelectMenuProps<UserSelectMenuInteraction, UserSelectMenuKit> +* Extends: Partial<Omit<UserSelectMenuComponentData, 'type'>>, CommonSelectMenuProps<UserSelectMenuInteraction, UserSelectMenuKit> diff --git a/apps/website/docs/api-reference/commandkit/types/any-command-execute.mdx b/apps/website/docs/api-reference/commandkit/types/any-command-execute.mdx index adb01e8a..260e292c 100644 --- a/apps/website/docs/api-reference/commandkit/types/any-command-execute.mdx +++ b/apps/website/docs/api-reference/commandkit/types/any-command-execute.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## AnyCommandExecute - + Generic type for command execution functions. diff --git a/apps/website/docs/api-reference/commandkit/types/app-command.mdx b/apps/website/docs/api-reference/commandkit/types/app-command.mdx index 59c97e40..add35392 100644 --- a/apps/website/docs/api-reference/commandkit/types/app-command.mdx +++ b/apps/website/docs/api-reference/commandkit/types/app-command.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## AppCommand - + Represents a command in the CommandKit application, including its metadata and handlers. This type extends the native command structure with additional properties. diff --git a/apps/website/docs/api-reference/commandkit/types/async-function.mdx b/apps/website/docs/api-reference/commandkit/types/async-function.mdx index 0dc96aa0..41a83512 100644 --- a/apps/website/docs/api-reference/commandkit/types/async-function.mdx +++ b/apps/website/docs/api-reference/commandkit/types/async-function.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## AsyncFunction - + Represents an async function that can be cached diff --git a/apps/website/docs/api-reference/commandkit/types/autocomplete-command-context.mdx b/apps/website/docs/api-reference/commandkit/types/autocomplete-command-context.mdx index ee5bf182..af06a16a 100644 --- a/apps/website/docs/api-reference/commandkit/types/autocomplete-command-context.mdx +++ b/apps/website/docs/api-reference/commandkit/types/autocomplete-command-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## AutocompleteCommandContext - + Context for autocomplete interactions. diff --git a/apps/website/docs/api-reference/commandkit/types/autocomplete-command-middleware-context.mdx b/apps/website/docs/api-reference/commandkit/types/autocomplete-command-middleware-context.mdx index 2a159339..d57b2e8c 100644 --- a/apps/website/docs/api-reference/commandkit/types/autocomplete-command-middleware-context.mdx +++ b/apps/website/docs/api-reference/commandkit/types/autocomplete-command-middleware-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## AutocompleteCommandMiddlewareContext - + Middleware context for autocomplete interactions. diff --git a/apps/website/docs/api-reference/commandkit/types/autocomplete-command.mdx b/apps/website/docs/api-reference/commandkit/types/autocomplete-command.mdx index 110ebf73..45cc7612 100644 --- a/apps/website/docs/api-reference/commandkit/types/autocomplete-command.mdx +++ b/apps/website/docs/api-reference/commandkit/types/autocomplete-command.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## AutocompleteCommand - + Type for autocomplete command execution functions. diff --git a/apps/website/docs/api-reference/commandkit/types/bootstrap-function.mdx b/apps/website/docs/api-reference/commandkit/types/bootstrap-function.mdx index 388df43a..d55a1ca0 100644 --- a/apps/website/docs/api-reference/commandkit/types/bootstrap-function.mdx +++ b/apps/website/docs/api-reference/commandkit/types/bootstrap-function.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## BootstrapFunction - + Represents the function executed during the bootstrap phase of CommandKit. diff --git a/apps/website/docs/api-reference/commandkit/types/chat-input-command-context.mdx b/apps/website/docs/api-reference/commandkit/types/chat-input-command-context.mdx index 86a9625d..4c8ed4a5 100644 --- a/apps/website/docs/api-reference/commandkit/types/chat-input-command-context.mdx +++ b/apps/website/docs/api-reference/commandkit/types/chat-input-command-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## ChatInputCommandContext - + Context for chat input (slash) commands. diff --git a/apps/website/docs/api-reference/commandkit/types/chat-input-command.mdx b/apps/website/docs/api-reference/commandkit/types/chat-input-command.mdx index 215ca550..87c79df3 100644 --- a/apps/website/docs/api-reference/commandkit/types/chat-input-command.mdx +++ b/apps/website/docs/api-reference/commandkit/types/chat-input-command.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## ChatInputCommand - + Type for chat input command execution functions. diff --git a/apps/website/docs/api-reference/commandkit/types/command-builder-like.mdx b/apps/website/docs/api-reference/commandkit/types/command-builder-like.mdx index 3ff95616..e908e981 100644 --- a/apps/website/docs/api-reference/commandkit/types/command-builder-like.mdx +++ b/apps/website/docs/api-reference/commandkit/types/command-builder-like.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CommandBuilderLike - + Type representing command builder objects supported by CommandKit. diff --git a/apps/website/docs/api-reference/commandkit/types/command-context-options.mdx b/apps/website/docs/api-reference/commandkit/types/command-context-options.mdx index 7377b161..d237c453 100644 --- a/apps/website/docs/api-reference/commandkit/types/command-context-options.mdx +++ b/apps/website/docs/api-reference/commandkit/types/command-context-options.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CommandContextOptions - + Type representing command context options based on execution mode. diff --git a/apps/website/docs/api-reference/commandkit/types/command-data.mdx b/apps/website/docs/api-reference/commandkit/types/command-data.mdx index d308cfe6..a4abb09f 100644 --- a/apps/website/docs/api-reference/commandkit/types/command-data.mdx +++ b/apps/website/docs/api-reference/commandkit/types/command-data.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CommandData - + Represents a command that can be executed by CommandKit. diff --git a/apps/website/docs/api-reference/commandkit/types/command-execution-mode.mdx b/apps/website/docs/api-reference/commandkit/types/command-execution-mode.mdx index 502774e6..a3a2289f 100644 --- a/apps/website/docs/api-reference/commandkit/types/command-execution-mode.mdx +++ b/apps/website/docs/api-reference/commandkit/types/command-execution-mode.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CommandExecutionMode - + Type representing the possible command execution modes. diff --git a/apps/website/docs/api-reference/commandkit/types/command-metadata-function.mdx b/apps/website/docs/api-reference/commandkit/types/command-metadata-function.mdx index e5c2ec46..924c0059 100644 --- a/apps/website/docs/api-reference/commandkit/types/command-metadata-function.mdx +++ b/apps/website/docs/api-reference/commandkit/types/command-metadata-function.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CommandMetadataFunction - + The command metadata function diff --git a/apps/website/docs/api-reference/commandkit/types/command-type-data.mdx b/apps/website/docs/api-reference/commandkit/types/command-type-data.mdx index d92c72fd..fa7007a0 100644 --- a/apps/website/docs/api-reference/commandkit/types/command-type-data.mdx +++ b/apps/website/docs/api-reference/commandkit/types/command-type-data.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CommandTypeData - + Type representing command data identifier. diff --git a/apps/website/docs/api-reference/commandkit/types/custom-evaluation-context.mdx b/apps/website/docs/api-reference/commandkit/types/custom-evaluation-context.mdx index 48bcd202..50e5e70a 100644 --- a/apps/website/docs/api-reference/commandkit/types/custom-evaluation-context.mdx +++ b/apps/website/docs/api-reference/commandkit/types/custom-evaluation-context.mdx @@ -29,7 +29,7 @@ type CustomEvaluationContext = { ### identify -CustomEvaluationFunction<E>`} /> +CustomEvaluationFunction<E>`} /> Optional function to identify the entities for evaluation. This can be a function that returns the entities based on the current context. diff --git a/apps/website/docs/api-reference/commandkit/types/event-handler.mdx b/apps/website/docs/api-reference/commandkit/types/event-handler.mdx index 741a8488..fd338b80 100644 --- a/apps/website/docs/api-reference/commandkit/types/event-handler.mdx +++ b/apps/website/docs/api-reference/commandkit/types/event-handler.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## EventHandler - + Represents an event handler for a specific event. diff --git a/apps/website/docs/api-reference/commandkit/types/event-listener.mdx b/apps/website/docs/api-reference/commandkit/types/event-listener.mdx index 023df437..c7e99a9a 100644 --- a/apps/website/docs/api-reference/commandkit/types/event-listener.mdx +++ b/apps/website/docs/api-reference/commandkit/types/event-listener.mdx @@ -28,7 +28,7 @@ type EventListener = { ### handler -ListenerFunction`} /> +ListenerFunction`} /> ### once diff --git a/apps/website/docs/api-reference/commandkit/types/generic-function.mdx b/apps/website/docs/api-reference/commandkit/types/generic-function.mdx index 9f79458d..281f3f13 100644 --- a/apps/website/docs/api-reference/commandkit/types/generic-function.mdx +++ b/apps/website/docs/api-reference/commandkit/types/generic-function.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## GenericFunction - + Represents a generic function type that can accept any number of arguments. diff --git a/apps/website/docs/api-reference/commandkit/types/interaction-command-context.mdx b/apps/website/docs/api-reference/commandkit/types/interaction-command-context.mdx index c6111126..35d84429 100644 --- a/apps/website/docs/api-reference/commandkit/types/interaction-command-context.mdx +++ b/apps/website/docs/api-reference/commandkit/types/interaction-command-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## InteractionCommandContext - + Context for interaction-based commands. diff --git a/apps/website/docs/api-reference/commandkit/types/interaction-command-middleware-context.mdx b/apps/website/docs/api-reference/commandkit/types/interaction-command-middleware-context.mdx index 27e7d7c2..84dc2b60 100644 --- a/apps/website/docs/api-reference/commandkit/types/interaction-command-middleware-context.mdx +++ b/apps/website/docs/api-reference/commandkit/types/interaction-command-middleware-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## InteractionCommandMiddlewareContext - + Middleware context for interaction-based commands. diff --git a/apps/website/docs/api-reference/commandkit/types/message-command-context.mdx b/apps/website/docs/api-reference/commandkit/types/message-command-context.mdx index e3626cb0..9238cdb3 100644 --- a/apps/website/docs/api-reference/commandkit/types/message-command-context.mdx +++ b/apps/website/docs/api-reference/commandkit/types/message-command-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## MessageCommandContext - + Context for message-based commands. diff --git a/apps/website/docs/api-reference/commandkit/types/message-command-middleware-context.mdx b/apps/website/docs/api-reference/commandkit/types/message-command-middleware-context.mdx index 7f7ad6a9..52a67310 100644 --- a/apps/website/docs/api-reference/commandkit/types/message-command-middleware-context.mdx +++ b/apps/website/docs/api-reference/commandkit/types/message-command-middleware-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## MessageCommandMiddlewareContext - + Middleware context for message-based commands. diff --git a/apps/website/docs/api-reference/commandkit/types/message-command.mdx b/apps/website/docs/api-reference/commandkit/types/message-command.mdx index 8dd03439..8649f3b8 100644 --- a/apps/website/docs/api-reference/commandkit/types/message-command.mdx +++ b/apps/website/docs/api-reference/commandkit/types/message-command.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## MessageCommand - + Type for message command execution functions. diff --git a/apps/website/docs/api-reference/commandkit/types/message-context-menu-command-context.mdx b/apps/website/docs/api-reference/commandkit/types/message-context-menu-command-context.mdx index 0eba59bd..1a58d303 100644 --- a/apps/website/docs/api-reference/commandkit/types/message-context-menu-command-context.mdx +++ b/apps/website/docs/api-reference/commandkit/types/message-context-menu-command-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## MessageContextMenuCommandContext - + Context for message context menu commands. diff --git a/apps/website/docs/api-reference/commandkit/types/message-context-menu-command-middleware-context.mdx b/apps/website/docs/api-reference/commandkit/types/message-context-menu-command-middleware-context.mdx index d5c4afe5..bf946e68 100644 --- a/apps/website/docs/api-reference/commandkit/types/message-context-menu-command-middleware-context.mdx +++ b/apps/website/docs/api-reference/commandkit/types/message-context-menu-command-middleware-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## MessageContextMenuCommandMiddlewareContext - + Middleware context for message context menu commands. diff --git a/apps/website/docs/api-reference/commandkit/types/message-context-menu-command.mdx b/apps/website/docs/api-reference/commandkit/types/message-context-menu-command.mdx index b6b6c523..18d1cbf7 100644 --- a/apps/website/docs/api-reference/commandkit/types/message-context-menu-command.mdx +++ b/apps/website/docs/api-reference/commandkit/types/message-context-menu-command.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## MessageContextMenuCommand - + Type for message context menu command execution functions. diff --git a/apps/website/docs/api-reference/commandkit/types/resolvable-command.mdx b/apps/website/docs/api-reference/commandkit/types/resolvable-command.mdx index c1004c47..8f95deb8 100644 --- a/apps/website/docs/api-reference/commandkit/types/resolvable-command.mdx +++ b/apps/website/docs/api-reference/commandkit/types/resolvable-command.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## ResolvableCommand - + Type for commands that can be resolved by the handler. diff --git a/apps/website/docs/api-reference/commandkit/types/run-command.mdx b/apps/website/docs/api-reference/commandkit/types/run-command.mdx index 1877338d..7333a0d6 100644 --- a/apps/website/docs/api-reference/commandkit/types/run-command.mdx +++ b/apps/website/docs/api-reference/commandkit/types/run-command.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## RunCommand - + Function type for wrapping command execution with custom logic. diff --git a/apps/website/docs/api-reference/commandkit/types/slash-command-middleware-context.mdx b/apps/website/docs/api-reference/commandkit/types/slash-command-middleware-context.mdx index f417e5d1..43d76f29 100644 --- a/apps/website/docs/api-reference/commandkit/types/slash-command-middleware-context.mdx +++ b/apps/website/docs/api-reference/commandkit/types/slash-command-middleware-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## SlashCommandMiddlewareContext - + Middleware context for slash commands. diff --git a/apps/website/docs/api-reference/commandkit/types/user-context-menu-command-context.mdx b/apps/website/docs/api-reference/commandkit/types/user-context-menu-command-context.mdx index a37a5544..12c04bee 100644 --- a/apps/website/docs/api-reference/commandkit/types/user-context-menu-command-context.mdx +++ b/apps/website/docs/api-reference/commandkit/types/user-context-menu-command-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## UserContextMenuCommandContext - + Context for user context menu commands. diff --git a/apps/website/docs/api-reference/commandkit/types/user-context-menu-command-middleware-context.mdx b/apps/website/docs/api-reference/commandkit/types/user-context-menu-command-middleware-context.mdx index 4dd12077..a7012f62 100644 --- a/apps/website/docs/api-reference/commandkit/types/user-context-menu-command-middleware-context.mdx +++ b/apps/website/docs/api-reference/commandkit/types/user-context-menu-command-middleware-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## UserContextMenuCommandMiddlewareContext - + Middleware context for user context menu commands. diff --git a/apps/website/docs/api-reference/commandkit/types/user-context-menu-command.mdx b/apps/website/docs/api-reference/commandkit/types/user-context-menu-command.mdx index 3e5fefbe..7229bddb 100644 --- a/apps/website/docs/api-reference/commandkit/types/user-context-menu-command.mdx +++ b/apps/website/docs/api-reference/commandkit/types/user-context-menu-command.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## UserContextMenuCommand - + Type for user context menu command execution functions. diff --git a/apps/website/docs/api-reference/commandkit/variables/command-execution-mode.mdx b/apps/website/docs/api-reference/commandkit/variables/command-execution-mode.mdx index 7af8fcd9..8f3eab39 100644 --- a/apps/website/docs/api-reference/commandkit/variables/command-execution-mode.mdx +++ b/apps/website/docs/api-reference/commandkit/variables/command-execution-mode.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CommandExecutionMode - + Enumeration of different command execution modes supported by CommandKit. diff --git a/apps/website/docs/api-reference/commandkit/variables/commandkit.mdx b/apps/website/docs/api-reference/commandkit/variables/commandkit.mdx index 315b5a02..5aa6e1d0 100644 --- a/apps/website/docs/api-reference/commandkit/variables/commandkit.mdx +++ b/apps/website/docs/api-reference/commandkit/variables/commandkit.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## commandkit - + The singleton instance of CommandKit. diff --git a/apps/website/docs/api-reference/i18n/classes/i18n-cli-template-plugin.mdx b/apps/website/docs/api-reference/i18n/classes/i18n-cli-template-plugin.mdx index c8a71456..067afbcc 100644 --- a/apps/website/docs/api-reference/i18n/classes/i18n-cli-template-plugin.mdx +++ b/apps/website/docs/api-reference/i18n/classes/i18n-cli-template-plugin.mdx @@ -34,7 +34,7 @@ class I18nCliTemplatePlugin extends CompilerPlugin { deactivate(ctx: CompilerPluginRuntime) => Promise; } ``` -* Extends: CompilerPlugin +* Extends: CompilerPlugin @@ -47,12 +47,12 @@ class I18nCliTemplatePlugin extends CompilerPlugin { ### activate -CompilerPluginRuntime) => Promise<void>`} /> +CompilerPluginRuntime) => Promise<void>`} /> ### deactivate -CompilerPluginRuntime) => Promise<void>`} /> +CompilerPluginRuntime) => Promise<void>`} /> diff --git a/apps/website/docs/api-reference/i18n/classes/i18n-plugin.mdx b/apps/website/docs/api-reference/i18n/classes/i18n-plugin.mdx index a95566c6..5b486a4b 100644 --- a/apps/website/docs/api-reference/i18n/classes/i18n-plugin.mdx +++ b/apps/website/docs/api-reference/i18n/classes/i18n-plugin.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## I18nPlugin - + @@ -25,9 +25,10 @@ class I18nPlugin extends RuntimePlugin { performHMR(ctx: CommandKitPluginRuntime, event: CommandKitHMREvent) => Promise; executeCommand(ctx: CommandKitPluginRuntime, env: CommandKitEnvironment, source: CommandSource, command: PreparedAppCommandExecution) => Promise; prepareCommand(ctx: CommandKitPluginRuntime, command: CommandBuilderLike) => Promise; + onBeforeRegisterCommands(ctx: CommandKitPluginRuntime, event: PreRegisterCommandsEvent) => Promise; } ``` -* Extends: RuntimePlugin<LocalizationPluginOptions> +* Extends: RuntimePlugin<LocalizationPluginOptions> @@ -40,7 +41,7 @@ class I18nPlugin extends RuntimePlugin { ### activate -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> ### getLoadPath @@ -50,17 +51,22 @@ class I18nPlugin extends RuntimePlugin { ### performHMR -CommandKitPluginRuntime, event: CommandKitHMREvent) => Promise<void>`} /> +CommandKitPluginRuntime, event: CommandKitHMREvent) => Promise<void>`} /> ### executeCommand -CommandKitPluginRuntime, env: CommandKitEnvironment, source: CommandSource, command: PreparedAppCommandExecution) => Promise<boolean>`} /> +CommandKitPluginRuntime, env: CommandKitEnvironment, source: CommandSource, command: PreparedAppCommandExecution) => Promise<boolean>`} /> ### prepareCommand -CommandKitPluginRuntime, command: CommandBuilderLike) => Promise<CommandBuilderLike | null>`} /> +CommandKitPluginRuntime, command: CommandBuilderLike) => Promise<CommandBuilderLike | null>`} /> + + +### onBeforeRegisterCommands + +CommandKitPluginRuntime, event: PreRegisterCommandsEvent) => Promise<void>`} /> diff --git a/apps/website/docs/api-reference/i18n/functions/i18n.mdx b/apps/website/docs/api-reference/i18n/functions/i18n.mdx index 397ae848..a108b4cf 100644 --- a/apps/website/docs/api-reference/i18n/functions/i18n.mdx +++ b/apps/website/docs/api-reference/i18n/functions/i18n.mdx @@ -25,5 +25,5 @@ Parameters ### options -LocalizationPluginOptions`} /> +LocalizationPluginOptions`} /> diff --git a/apps/website/docs/api-reference/i18n/functions/use-i18n.mdx b/apps/website/docs/api-reference/i18n/functions/use-i18n.mdx index 5f726edb..65b2a98b 100644 --- a/apps/website/docs/api-reference/i18n/functions/use-i18n.mdx +++ b/apps/website/docs/api-reference/i18n/functions/use-i18n.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## useI18n - + Retrieves the i18n instance from the commandkit store. @@ -38,5 +38,5 @@ Parameters ### commandkit -CommandKit`} /> +CommandKit`} /> diff --git a/apps/website/docs/api-reference/i18n/interfaces/basic-command-translation-metadata.mdx b/apps/website/docs/api-reference/i18n/interfaces/basic-command-translation-metadata.mdx new file mode 100644 index 00000000..7c934de5 --- /dev/null +++ b/apps/website/docs/api-reference/i18n/interfaces/basic-command-translation-metadata.mdx @@ -0,0 +1,35 @@ +--- +title: "BasicCommandTranslationMetadata" +isDefaultIndex: false +generated: true +--- + +import MemberInfo from '@site/src/components/MemberInfo'; +import GenerationInfo from '@site/src/components/GenerationInfo'; +import MemberDescription from '@site/src/components/MemberDescription'; + + + + +## BasicCommandTranslationMetadata + + + +Represents the metadata for basic command translations. + +```ts title="Signature" +interface BasicCommandTranslationMetadata { + name?: string; +} +``` + +
+ +### name + + + +The name of the command. + + +
diff --git a/apps/website/docs/api-reference/i18n/interfaces/command-localization-context.mdx b/apps/website/docs/api-reference/i18n/interfaces/command-localization-context.mdx index 82476824..6dc12b77 100644 --- a/apps/website/docs/api-reference/i18n/interfaces/command-localization-context.mdx +++ b/apps/website/docs/api-reference/i18n/interfaces/command-localization-context.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CommandLocalizationContext - + @@ -30,7 +30,7 @@ interface CommandLocalizationContext { ### i18n -i18n`} /> +i18n`} /> The i18next instance. ### t diff --git a/apps/website/docs/api-reference/i18n/interfaces/command-translation-metadata.mdx b/apps/website/docs/api-reference/i18n/interfaces/command-translation-metadata.mdx index f9f114fa..b63fc85e 100644 --- a/apps/website/docs/api-reference/i18n/interfaces/command-translation-metadata.mdx +++ b/apps/website/docs/api-reference/i18n/interfaces/command-translation-metadata.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CommandTranslationMetadata - + Represents the metadata for command translations. diff --git a/apps/website/docs/api-reference/i18n/interfaces/command-translation.mdx b/apps/website/docs/api-reference/i18n/interfaces/command-translation.mdx index 9bbb09eb..35bed4b5 100644 --- a/apps/website/docs/api-reference/i18n/interfaces/command-translation.mdx +++ b/apps/website/docs/api-reference/i18n/interfaces/command-translation.mdx @@ -13,13 +13,15 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CommandTranslation - + Represents a command translation, including its metadata and translations. ```ts title="Signature" interface CommandTranslation { [COMMAND_METADATA_KEY]: CommandTranslationMetadata; + [USER_CTX_COMMAND_METADATA_KEY]: BasicCommandTranslationMetadata; + [MESSAGE_CTX_COMMAND_METADATA_KEY]: BasicCommandTranslationMetadata; translations: Record; } ``` @@ -28,9 +30,19 @@ interface CommandTranslation { ### \[COMMAND_METADATA_KEY] -CommandTranslationMetadata`} /> +CommandTranslationMetadata`} /> The metadata for the command translation. +### \[USER_CTX_COMMAND_METADATA_KEY] + +BasicCommandTranslationMetadata`} /> + +The metadata for the user context menu command translation. +### \[MESSAGE_CTX_COMMAND_METADATA_KEY] + +BasicCommandTranslationMetadata`} /> + +The metadata for the message context menu command translation. ### translations diff --git a/apps/website/docs/api-reference/i18n/interfaces/localization-plugin-options.mdx b/apps/website/docs/api-reference/i18n/interfaces/localization-plugin-options.mdx index d7e92550..e41c2edd 100644 --- a/apps/website/docs/api-reference/i18n/interfaces/localization-plugin-options.mdx +++ b/apps/website/docs/api-reference/i18n/interfaces/localization-plugin-options.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## LocalizationPluginOptions - + Options for the localization plugin. This interface defines the options that can be passed to the localization plugin. @@ -30,7 +30,7 @@ interface LocalizationPluginOptions { ### plugins -LocalizationModule | DynamicLocalizationModule>`} /> +LocalizationModule | DynamicLocalizationModule>`} /> The i18next plugins to use. The plugins are loaded in the order they are specified. diff --git a/apps/website/docs/api-reference/i18n/types/dynamic-localization-module.mdx b/apps/website/docs/api-reference/i18n/types/dynamic-localization-module.mdx index 6ab69e6f..24ff2f51 100644 --- a/apps/website/docs/api-reference/i18n/types/dynamic-localization-module.mdx +++ b/apps/website/docs/api-reference/i18n/types/dynamic-localization-module.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## DynamicLocalizationModule - + Represents a dynamic localization module that can be used with the i18next plugin. diff --git a/apps/website/docs/api-reference/i18n/types/localization-module.mdx b/apps/website/docs/api-reference/i18n/types/localization-module.mdx index 5a195eca..f63d556c 100644 --- a/apps/website/docs/api-reference/i18n/types/localization-module.mdx +++ b/apps/website/docs/api-reference/i18n/types/localization-module.mdx @@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## LocalizationModule - + Represents a localization module that can be used with the i18next plugin. diff --git a/apps/website/docs/api-reference/i18n/variables/message_ctx_command_metadata_key.mdx b/apps/website/docs/api-reference/i18n/variables/message_ctx_command_metadata_key.mdx new file mode 100644 index 00000000..4fdd5b0f --- /dev/null +++ b/apps/website/docs/api-reference/i18n/variables/message_ctx_command_metadata_key.mdx @@ -0,0 +1,20 @@ +--- +title: "MESSAGE_CTX_COMMAND_METADATA_KEY" +isDefaultIndex: false +generated: true +--- + +import MemberInfo from '@site/src/components/MemberInfo'; +import GenerationInfo from '@site/src/components/GenerationInfo'; +import MemberDescription from '@site/src/components/MemberDescription'; + + + + +## MESSAGE_CTX_COMMAND_METADATA_KEY + + + +Metadata key for message context menu command localization. +This key is used to store metadata about message context menu commands in the i18n system. + diff --git a/apps/website/docs/api-reference/i18n/variables/user_ctx_command_metadata_key.mdx b/apps/website/docs/api-reference/i18n/variables/user_ctx_command_metadata_key.mdx new file mode 100644 index 00000000..72de83f9 --- /dev/null +++ b/apps/website/docs/api-reference/i18n/variables/user_ctx_command_metadata_key.mdx @@ -0,0 +1,20 @@ +--- +title: "USER_CTX_COMMAND_METADATA_KEY" +isDefaultIndex: false +generated: true +--- + +import MemberInfo from '@site/src/components/MemberInfo'; +import GenerationInfo from '@site/src/components/GenerationInfo'; +import MemberDescription from '@site/src/components/MemberDescription'; + + + + +## USER_CTX_COMMAND_METADATA_KEY + + + +Metadata key for user context menu command localization. +This key is used to store metadata about user context menu commands in the i18n system. + diff --git a/apps/website/docs/api-reference/legacy/classes/legacy-commands-cliplugin.mdx b/apps/website/docs/api-reference/legacy/classes/legacy-commands-cliplugin.mdx index a05bff20..deb5aa83 100644 --- a/apps/website/docs/api-reference/legacy/classes/legacy-commands-cliplugin.mdx +++ b/apps/website/docs/api-reference/legacy/classes/legacy-commands-cliplugin.mdx @@ -40,7 +40,7 @@ class LegacyCommandsCLIPlugin extends CompilerPlugin deactivate(ctx: CompilerPluginRuntime) => Promise; } ``` -* Extends: CompilerPlugin<LegacyHandlerPluginOptions> +* Extends: CompilerPlugin<LegacyHandlerPluginOptions> @@ -53,12 +53,12 @@ class LegacyCommandsCLIPlugin extends CompilerPlugin ### activate -CompilerPluginRuntime) => Promise<void>`} /> +CompilerPluginRuntime) => Promise<void>`} /> ### deactivate -CompilerPluginRuntime) => Promise<void>`} /> +CompilerPluginRuntime) => Promise<void>`} /> diff --git a/apps/website/docs/api-reference/legacy/classes/legacy-handler-plugin.mdx b/apps/website/docs/api-reference/legacy/classes/legacy-handler-plugin.mdx index fffff894..91441a3d 100644 --- a/apps/website/docs/api-reference/legacy/classes/legacy-handler-plugin.mdx +++ b/apps/website/docs/api-reference/legacy/classes/legacy-handler-plugin.mdx @@ -28,7 +28,7 @@ class LegacyHandlerPlugin extends RuntimePlugin { willEmitEvent(ctx: CommandKitPluginRuntime, event: CommandKitEventDispatch) => Promise; } ``` -* Extends: RuntimePlugin<LegacyHandlerPluginOptions> +* Extends: RuntimePlugin<LegacyHandlerPluginOptions> @@ -41,32 +41,32 @@ class LegacyHandlerPlugin extends RuntimePlugin { ### activate -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> ### deactivate -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> ### performHMR -CommandKitPluginRuntime, event: CommandKitHMREvent) => Promise<void>`} /> +CommandKitPluginRuntime, event: CommandKitHMREvent) => Promise<void>`} /> ### onEventsRouterInit -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> ### onBeforeCommandsLoad -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> ### willEmitEvent -CommandKitPluginRuntime, event: CommandKitEventDispatch) => Promise<void>`} /> +CommandKitPluginRuntime, event: CommandKitEventDispatch) => Promise<void>`} /> diff --git a/apps/website/docs/api-reference/legacy/functions/dev-only-validation.mdx b/apps/website/docs/api-reference/legacy/functions/dev-only-validation.mdx index 5aeb2dff..4bf54022 100644 --- a/apps/website/docs/api-reference/legacy/functions/dev-only-validation.mdx +++ b/apps/website/docs/api-reference/legacy/functions/dev-only-validation.mdx @@ -38,5 +38,5 @@ Parameters handlerData, } -ValidationProps & { handlerData: { devGuildIds: string[]; devRoleIds: string[]; devUserIds: string[]; }; }`} /> +ValidationProps & { handlerData: { devGuildIds: string[]; devRoleIds: string[]; devUserIds: string[]; }; }`} /> diff --git a/apps/website/docs/api-reference/legacy/functions/legacy.mdx b/apps/website/docs/api-reference/legacy/functions/legacy.mdx index 9d06e851..e0f8aa75 100644 --- a/apps/website/docs/api-reference/legacy/functions/legacy.mdx +++ b/apps/website/docs/api-reference/legacy/functions/legacy.mdx @@ -24,5 +24,5 @@ Parameters ### options -LegacyHandlerPluginOptions>`} /> +LegacyHandlerPluginOptions>`} /> diff --git a/apps/website/docs/api-reference/legacy/functions/permission-validation.mdx b/apps/website/docs/api-reference/legacy/functions/permission-validation.mdx index 3a8be1b9..1386e90b 100644 --- a/apps/website/docs/api-reference/legacy/functions/permission-validation.mdx +++ b/apps/website/docs/api-reference/legacy/functions/permission-validation.mdx @@ -30,5 +30,5 @@ Parameters commandObj, } -ValidationProps`} /> +ValidationProps`} /> diff --git a/apps/website/docs/api-reference/legacy/interfaces/command-file-data.mdx b/apps/website/docs/api-reference/legacy/interfaces/command-file-data.mdx index ac2f5e8c..392ad586 100644 --- a/apps/website/docs/api-reference/legacy/interfaces/command-file-data.mdx +++ b/apps/website/docs/api-reference/legacy/interfaces/command-file-data.mdx @@ -34,32 +34,32 @@ interface CommandFileData { ### data -CommandData`} /> +CommandData`} /> The command data, which includes the name, description, and options. ### options -CommandOptions`} /> +CommandOptions`} /> The options for the command, including permissions and execution conditions. ### chatInput -CommandRunner<ChatInputCommandInteraction>`} /> +CommandRunner<ChatInputCommandInteraction>`} /> The function to run when the command is executed as slash command. ### messageContextMenu -CommandRunner<MessageContextMenuCommandInteraction>`} /> +CommandRunner<MessageContextMenuCommandInteraction>`} /> The function to run when the command is executed as a message context menu command. ### userContextMenu -CommandRunner<UserContextMenuCommandInteraction>`} /> +CommandRunner<UserContextMenuCommandInteraction>`} /> The function to run when the command is executed as a user context menu command. ### autocomplete -CommandRunner<AutocompleteInteraction>`} /> +CommandRunner<AutocompleteInteraction>`} /> The function to run when the command is executed as an autocomplete interaction. ### category diff --git a/apps/website/docs/api-reference/legacy/interfaces/command-object.mdx b/apps/website/docs/api-reference/legacy/interfaces/command-object.mdx index 5a234e72..39a31b4c 100644 --- a/apps/website/docs/api-reference/legacy/interfaces/command-object.mdx +++ b/apps/website/docs/api-reference/legacy/interfaces/command-object.mdx @@ -35,7 +35,7 @@ interface CommandObject { The category of the command. ### data -CommandData`} /> +CommandData`} /> The command data, which includes the name, description, and options. ### filePath @@ -45,7 +45,7 @@ The command data, which includes the name, description, and options. The file path of the command. ### options -CommandOptions`} /> +CommandOptions`} /> The function to run when the command is executed. diff --git a/apps/website/docs/api-reference/legacy/interfaces/validation-function-data.mdx b/apps/website/docs/api-reference/legacy/interfaces/validation-function-data.mdx index f97a437f..7004f454 100644 --- a/apps/website/docs/api-reference/legacy/interfaces/validation-function-data.mdx +++ b/apps/website/docs/api-reference/legacy/interfaces/validation-function-data.mdx @@ -40,7 +40,7 @@ The name of the validation function. The path to the file where the validation function is defined. ### validate -ValidationFunction`} /> +ValidationFunction`} /> The validation function. diff --git a/apps/website/docs/api-reference/legacy/interfaces/validation-props.mdx b/apps/website/docs/api-reference/legacy/interfaces/validation-props.mdx index fda0aee6..ebda15d8 100644 --- a/apps/website/docs/api-reference/legacy/interfaces/validation-props.mdx +++ b/apps/website/docs/api-reference/legacy/interfaces/validation-props.mdx @@ -44,12 +44,12 @@ The Discord client instance. The interaction that triggered the command. ### commandObj -CommandObject`} /> +CommandObject`} /> The command object associated with the interaction. ### handler -CommandKit`} /> +CommandKit`} /> The CommandKit handler instance. diff --git a/apps/website/docs/api-reference/queue/classes/redis-pub-sub-driver.mdx b/apps/website/docs/api-reference/queue/classes/redis-pub-sub-driver.mdx index 96a784c0..8f0d377a 100644 --- a/apps/website/docs/api-reference/queue/classes/redis-pub-sub-driver.mdx +++ b/apps/website/docs/api-reference/queue/classes/redis-pub-sub-driver.mdx @@ -25,7 +25,7 @@ class RedisPubSubDriver = Record close() => Promise; } ``` -* Implements: MessageQueue +* Implements: MessageQueue diff --git a/apps/website/docs/api-reference/queue/functions/receive.mdx b/apps/website/docs/api-reference/queue/functions/receive.mdx index 5d143704..7dbd0d7e 100644 --- a/apps/website/docs/api-reference/queue/functions/receive.mdx +++ b/apps/website/docs/api-reference/queue/functions/receive.mdx @@ -28,5 +28,5 @@ Parameters ### handler -Awaitable<void>`} /> +Awaitable<void>`} /> diff --git a/apps/website/docs/api-reference/queue/functions/set-driver.mdx b/apps/website/docs/api-reference/queue/functions/set-driver.mdx index b669b42e..e26f7c09 100644 --- a/apps/website/docs/api-reference/queue/functions/set-driver.mdx +++ b/apps/website/docs/api-reference/queue/functions/set-driver.mdx @@ -24,5 +24,5 @@ Parameters ### driver -MessageQueue`} /> +MessageQueue`} /> diff --git a/apps/website/docs/api-reference/queue/interfaces/message-queue.mdx b/apps/website/docs/api-reference/queue/interfaces/message-queue.mdx index d3fe8c79..dbb57bf9 100644 --- a/apps/website/docs/api-reference/queue/interfaces/message-queue.mdx +++ b/apps/website/docs/api-reference/queue/interfaces/message-queue.mdx @@ -37,7 +37,7 @@ interface MessageQueue { ### receive -Awaitable<void>) => Promise<void>`} /> +Awaitable<void>) => Promise<void>`} /> ### close diff --git a/apps/website/docs/api-reference/redis/classes/redis-cache.mdx b/apps/website/docs/api-reference/redis/classes/redis-cache.mdx index 842232fa..8bd58b3a 100644 --- a/apps/website/docs/api-reference/redis/classes/redis-cache.mdx +++ b/apps/website/docs/api-reference/redis/classes/redis-cache.mdx @@ -46,7 +46,7 @@ class RedisCache extends CacheProvider { expire(key: string, ttl: number) => Promise; } ``` -* Extends: CacheProvider +* Extends: CacheProvider @@ -59,13 +59,13 @@ class RedisCache extends CacheProvider { ### serialize -SerializeFunction`} /> +SerializeFunction`} /> Serialize function used to serialize values before storing them in the cache. By default, it uses `JSON.stringify`. ### deserialize -DeserializeFunction`} /> +DeserializeFunction`} /> Deserialize function used to deserialize values before returning them from the cache. By default, it uses `JSON.parse`. @@ -91,7 +91,7 @@ Create a new RedisCache instance with the provided Redis options. ### get - Promise<CacheEntry<T> | undefined>`} /> + Promise<CacheEntry<T> | undefined>`} /> Retrieve a value from the cache. ### set diff --git a/apps/website/docs/api-reference/redis/classes/redis-mutex-storage.mdx b/apps/website/docs/api-reference/redis/classes/redis-mutex-storage.mdx index b2b3cb06..d3e5fdeb 100644 --- a/apps/website/docs/api-reference/redis/classes/redis-mutex-storage.mdx +++ b/apps/website/docs/api-reference/redis/classes/redis-mutex-storage.mdx @@ -32,7 +32,7 @@ class RedisMutexStorage implements MutexStorage { extendLock(key: string, additionalTime: number) => Promise; } ``` -* Implements: MutexStorage +* Implements: MutexStorage diff --git a/apps/website/docs/api-reference/redis/classes/redis-plugin.mdx b/apps/website/docs/api-reference/redis/classes/redis-plugin.mdx index e475974e..cb39432e 100644 --- a/apps/website/docs/api-reference/redis/classes/redis-plugin.mdx +++ b/apps/website/docs/api-reference/redis/classes/redis-plugin.mdx @@ -23,7 +23,7 @@ class RedisPlugin extends RuntimePlugin { activate(ctx: CommandKitPluginRuntime) => Promise; } ``` -* Extends: RuntimePlugin<RedisOptions> +* Extends: RuntimePlugin<RedisOptions> @@ -36,7 +36,7 @@ class RedisPlugin extends RuntimePlugin { ### activate -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> diff --git a/apps/website/docs/api-reference/redis/classes/redis-rate-limit-storage.mdx b/apps/website/docs/api-reference/redis/classes/redis-rate-limit-storage.mdx index c23e1852..eb9baa62 100644 --- a/apps/website/docs/api-reference/redis/classes/redis-rate-limit-storage.mdx +++ b/apps/website/docs/api-reference/redis/classes/redis-rate-limit-storage.mdx @@ -25,7 +25,7 @@ class RedisRateLimitStorage implements RateLimitStorage { delete(key: string) => Promise; } ``` -* Implements: RateLimitStorage +* Implements: RateLimitStorage diff --git a/apps/website/docs/api-reference/redis/classes/redis-semaphore-storage.mdx b/apps/website/docs/api-reference/redis/classes/redis-semaphore-storage.mdx index a73880b0..0b82898d 100644 --- a/apps/website/docs/api-reference/redis/classes/redis-semaphore-storage.mdx +++ b/apps/website/docs/api-reference/redis/classes/redis-semaphore-storage.mdx @@ -37,7 +37,7 @@ class RedisSemaphoreStorage implements SemaphoreStorage { clear(key: string) => Promise; } ``` -* Implements: SemaphoreStorage +* Implements: SemaphoreStorage diff --git a/apps/website/docs/api-reference/tasks/classes/bull-mqdriver.mdx b/apps/website/docs/api-reference/tasks/classes/bull-mqdriver.mdx index 9825852f..ab2c35af 100644 --- a/apps/website/docs/api-reference/tasks/classes/bull-mqdriver.mdx +++ b/apps/website/docs/api-reference/tasks/classes/bull-mqdriver.mdx @@ -61,7 +61,7 @@ class BullMQDriver implements TaskDriver { setTaskRunner(runner: TaskRunner) => Promise; } ``` -* Implements: TaskDriver +* Implements: TaskDriver @@ -84,7 +84,7 @@ The BullMQ worker instance for processing tasks Creates a new BullMQ driver instance. ### create -TaskData) => Promise<string>`} /> +TaskData) => Promise<string>`} /> Creates a new scheduled task in BullMQ. @@ -99,7 +99,7 @@ Deletes a scheduled task from BullMQ. This removes the job and all its children (for repeating jobs) from the queue. ### setTaskRunner -TaskRunner) => Promise<void>`} /> +TaskRunner) => Promise<void>`} /> Sets the task execution runner function. diff --git a/apps/website/docs/api-reference/tasks/classes/sqlite-driver.mdx b/apps/website/docs/api-reference/tasks/classes/sqlite-driver.mdx index f929de68..698e1b04 100644 --- a/apps/website/docs/api-reference/tasks/classes/sqlite-driver.mdx +++ b/apps/website/docs/api-reference/tasks/classes/sqlite-driver.mdx @@ -42,7 +42,7 @@ class SQLiteDriver implements TaskDriver { setTaskRunner(runner: TaskRunner) => Promise; } ``` -* Implements: TaskDriver +* Implements: TaskDriver @@ -60,7 +60,7 @@ Create a new SQLiteDriver instance. Destroy the SQLite driver and stop the polling loop. ### create -TaskData) => Promise<string>`} /> +TaskData) => Promise<string>`} /> Schedule a new job. ### delete @@ -70,7 +70,7 @@ Schedule a new job. Delete a scheduled job by its ID. ### setTaskRunner -TaskRunner) => Promise<void>`} /> +TaskRunner) => Promise<void>`} /> Set the task runner function to be called when a job is due. diff --git a/apps/website/docs/api-reference/tasks/classes/task-context.mdx b/apps/website/docs/api-reference/tasks/classes/task-context.mdx index 60019e0d..2edf5115 100644 --- a/apps/website/docs/api-reference/tasks/classes/task-context.mdx +++ b/apps/website/docs/api-reference/tasks/classes/task-context.mdx @@ -46,7 +46,7 @@ export default task({ ```ts title="Signature" class TaskContext = Record> { - public readonly store = new Map(); + public readonly store = new Collection(); constructor(_data: TaskContextData) task: Task client: Client @@ -88,12 +88,12 @@ export default task({ ``` ### constructor -TaskContextData<T>) => TaskContext`} /> +TaskContextData<T>) => TaskContext`} /> Creates a new task execution context. ### task -Task`} /> +Task`} /> Gets the task instance being executed. ### client @@ -108,7 +108,7 @@ Gets the Discord.js client. Gets the custom data passed to the task execution. ### commandkit -CommandKit`} /> +CommandKit`} /> Gets the CommandKit instance for accessing bot functionality. diff --git a/apps/website/docs/api-reference/tasks/classes/task-driver-manager.mdx b/apps/website/docs/api-reference/tasks/classes/task-driver-manager.mdx index c59ee1bb..37a9a8f8 100644 --- a/apps/website/docs/api-reference/tasks/classes/task-driver-manager.mdx +++ b/apps/website/docs/api-reference/tasks/classes/task-driver-manager.mdx @@ -53,12 +53,12 @@ class TaskDriverManager { ### driver -TaskDriver | null`} /> +TaskDriver | null`} /> ### setDriver -TaskDriver) => void`} /> +TaskDriver) => void`} /> Sets the active task driver. @@ -66,7 +66,7 @@ This method must be called before any task operations can be performed. The driver handles all scheduling, persistence, and execution timing. ### createTask -TaskData) => Promise<string>`} /> +TaskData) => Promise<string>`} /> Creates a new scheduled task. @@ -82,7 +82,7 @@ This method delegates to the active driver to remove the task from the scheduling system and cancel any pending executions. ### setTaskRunner -TaskRunner) => Promise<void>`} /> +TaskRunner) => Promise<void>`} /> Sets the task execution runner function. diff --git a/apps/website/docs/api-reference/tasks/classes/task.mdx b/apps/website/docs/api-reference/tasks/classes/task.mdx index d72605ab..0f7042ea 100644 --- a/apps/website/docs/api-reference/tasks/classes/task.mdx +++ b/apps/website/docs/api-reference/tasks/classes/task.mdx @@ -61,7 +61,7 @@ class Task = Record> { ### constructor -TaskDefinition<T>) => Task`} /> +TaskDefinition<T>) => Task`} /> Creates a new task instance. ### immediate @@ -77,7 +77,7 @@ Only applicable to cron tasks, defaults to false. The unique identifier for this task. ### schedule -TaskSchedule | null`} /> +TaskSchedule | null`} /> The schedule configuration for this task. Returns null if no schedule is defined (manual execution only). @@ -99,7 +99,7 @@ The timezone for the task schedule. Returns undefined if no timezone is defined. ### prepare -TaskContext<T>) => Promise<boolean>`} /> +TaskContext<T>) => Promise<boolean>`} /> Determines if the task is ready to be executed. @@ -107,7 +107,7 @@ This method calls the optional prepare function if defined. If no prepare function is provided, the task is always ready to execute. ### execute -TaskContext<T>) => Promise<void>`} /> +TaskContext<T>) => Promise<void>`} /> Executes the task's main logic. diff --git a/apps/website/docs/api-reference/tasks/classes/tasks-plugin.mdx b/apps/website/docs/api-reference/tasks/classes/tasks-plugin.mdx index 03e624d2..dc22cc82 100644 --- a/apps/website/docs/api-reference/tasks/classes/tasks-plugin.mdx +++ b/apps/website/docs/api-reference/tasks/classes/tasks-plugin.mdx @@ -44,7 +44,7 @@ class TasksPlugin extends RuntimePlugin { performHMR(ctx: CommandKitPluginRuntime, event: CommandKitHMREvent) => Promise; } ``` -* Extends: RuntimePlugin<TasksPluginOptions> +* Extends: RuntimePlugin<TasksPluginOptions> @@ -62,7 +62,7 @@ The plugin name identifier Collection of loaded task instances indexed by task name ### activate -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> Activates the tasks plugin. @@ -72,14 +72,14 @@ This method: 3. Schedules tasks that have defined schedules ### deactivate -CommandKitPluginRuntime) => Promise<void>`} /> +CommandKitPluginRuntime) => Promise<void>`} /> Deactivates the tasks plugin. Clears all loaded tasks from memory. ### performHMR -CommandKitPluginRuntime, event: CommandKitHMREvent) => Promise<void>`} /> +CommandKitPluginRuntime, event: CommandKitHMREvent) => Promise<void>`} /> Handles hot module replacement (HMR) for task files. diff --git a/apps/website/docs/api-reference/tasks/functions/create-task.mdx b/apps/website/docs/api-reference/tasks/functions/create-task.mdx index be754aed..a8a9d69b 100644 --- a/apps/website/docs/api-reference/tasks/functions/create-task.mdx +++ b/apps/website/docs/api-reference/tasks/functions/create-task.mdx @@ -40,5 +40,5 @@ Parameters ### task -TaskData`} /> +TaskData`} /> diff --git a/apps/website/docs/api-reference/tasks/functions/set-driver.mdx b/apps/website/docs/api-reference/tasks/functions/set-driver.mdx index 761ee11d..3dcd5bf2 100644 --- a/apps/website/docs/api-reference/tasks/functions/set-driver.mdx +++ b/apps/website/docs/api-reference/tasks/functions/set-driver.mdx @@ -37,5 +37,5 @@ Parameters ### driver -TaskDriver`} /> +TaskDriver`} /> diff --git a/apps/website/docs/api-reference/tasks/functions/task.mdx b/apps/website/docs/api-reference/tasks/functions/task.mdx index cf279a40..cadd0056 100644 --- a/apps/website/docs/api-reference/tasks/functions/task.mdx +++ b/apps/website/docs/api-reference/tasks/functions/task.mdx @@ -45,5 +45,5 @@ Parameters ### data -TaskDefinition<T>`} /> +TaskDefinition<T>`} /> diff --git a/apps/website/docs/api-reference/tasks/functions/tasks.mdx b/apps/website/docs/api-reference/tasks/functions/tasks.mdx index 3dcdf1d2..3ebd2dfb 100644 --- a/apps/website/docs/api-reference/tasks/functions/tasks.mdx +++ b/apps/website/docs/api-reference/tasks/functions/tasks.mdx @@ -47,5 +47,5 @@ Parameters ### options -TasksPluginOptions`} /> +TasksPluginOptions`} /> diff --git a/apps/website/docs/api-reference/tasks/interfaces/task-context-data.mdx b/apps/website/docs/api-reference/tasks/interfaces/task-context-data.mdx index b28114b6..c599f75b 100644 --- a/apps/website/docs/api-reference/tasks/interfaces/task-context-data.mdx +++ b/apps/website/docs/api-reference/tasks/interfaces/task-context-data.mdx @@ -32,7 +32,7 @@ interface TaskContextData = Record> { ### task -Task`} /> +Task`} /> The task instance that is being executed ### data @@ -42,7 +42,7 @@ The task instance that is being executed Custom data passed to the task execution ### commandkit -CommandKit`} /> +CommandKit`} /> The CommandKit instance for accessing bot functionality diff --git a/apps/website/docs/api-reference/tasks/interfaces/task-data.mdx b/apps/website/docs/api-reference/tasks/interfaces/task-data.mdx index f45e719e..f44b681e 100644 --- a/apps/website/docs/api-reference/tasks/interfaces/task-data.mdx +++ b/apps/website/docs/api-reference/tasks/interfaces/task-data.mdx @@ -43,7 +43,7 @@ The name of the task definition to execute Custom data passed to the task execution context ### schedule -TaskSchedule`} /> +TaskSchedule`} /> Schedule configuration for when the task should run ### timezone diff --git a/apps/website/docs/api-reference/tasks/interfaces/task-definition.mdx b/apps/website/docs/api-reference/tasks/interfaces/task-definition.mdx index 1eb0b692..82acf13f 100644 --- a/apps/website/docs/api-reference/tasks/interfaces/task-definition.mdx +++ b/apps/website/docs/api-reference/tasks/interfaces/task-definition.mdx @@ -40,7 +40,7 @@ interface TaskDefinition = Record> { Unique identifier for the task ### schedule -TaskSchedule`} /> +TaskSchedule`} /> Optional schedule configuration for recurring or delayed execution ### timezone @@ -55,13 +55,13 @@ Optional timezone for the schedule Whether the task should run immediately when created (only for cron tasks) ### prepare -TaskContext<T>) => Promise<boolean>`} /> +TaskContext<T>) => Promise<boolean>`} /> Optional preparation function that determines if the task should execute. Return false to skip execution for this run. ### execute -TaskContext<T>) => Promise<void>`} /> +TaskContext<T>) => Promise<void>`} /> The main execution function that performs the task work. This is called when the task is scheduled to run. diff --git a/apps/website/docs/api-reference/tasks/interfaces/task-driver.mdx b/apps/website/docs/api-reference/tasks/interfaces/task-driver.mdx index 6ff38e42..469cb2ab 100644 --- a/apps/website/docs/api-reference/tasks/interfaces/task-driver.mdx +++ b/apps/website/docs/api-reference/tasks/interfaces/task-driver.mdx @@ -59,7 +59,7 @@ interface TaskDriver { ### create -TaskData) => Promise<string>`} /> +TaskData) => Promise<string>`} /> Creates a new scheduled task. @@ -77,7 +77,7 @@ any pending executions. If the task doesn't exist, this method should complete successfully without throwing an error. ### setTaskRunner -TaskRunner) => Promise<void>`} /> +TaskRunner) => Promise<void>`} /> Sets the task execution runner function. diff --git a/packages/commandkit/package.json b/packages/commandkit/package.json index 05245e1a..cc31afe7 100644 --- a/packages/commandkit/package.json +++ b/packages/commandkit/package.json @@ -190,4 +190,4 @@ "engines": { "node": ">=24" } -} \ No newline at end of file +} diff --git a/scripts/docs/generate-typescript-docs.ts b/scripts/docs/generate-typescript-docs.ts index b25ca9e6..5f342b38 100644 --- a/scripts/docs/generate-typescript-docs.ts +++ b/scripts/docs/generate-typescript-docs.ts @@ -119,7 +119,7 @@ function generateTypescriptDocs( } const kindDir = getKindDirectory(declaration.kind); - const pathToTypeDoc = `docs/next/api-reference/${outputPath ? `${outputPath}/` : ''}${ + const pathToTypeDoc = `docs/api-reference/${outputPath ? `${outputPath}/` : ''}${ category ? category.map((part) => normalizeForUrlPart(part)).join('/') + '/' : ''