docs: add command metadata

notunderctrl · notunderctrl · commit 7e56da4c50df · 2025-08-25T14:49:39.000+03:00
diff --git a/apps/test-bot/src/app/commands/(general)/ping.ts b/apps/test-bot/src/app/commands/(general)/ping.ts
@@ -14,6 +14,7 @@ import {
   stopMiddlewares,
   Logger,
   unstable_after as after,
+  CommandMetadataFunction,
 } from 'commandkit';
 
 export const command: CommandData = {
@@ -35,10 +36,25 @@ export const command: CommandData = {
   // guilds: ['1314834483660455938'],
 };
 
-export const metadata: CommandMetadata = {
-  // userPermissions: 'Administrator',
-  // botPermissions: 'KickMembers',
-  // guilds: ['1314834483660455938'],
+// export const metadata: CommandMetadata = {
+//   // userPermissions: 'Administrator',
+//   // botPermissions: 'KickMembers',
+//   // guilds: ['1314834483660455938'],
+//   aliases: [''],
+//   userPermissions: 'Administrator',
+//   botPermissions: 'KickMembers',
+//   guilds: ['1314834483660455938'],
+// };
+
+export const generateMetadata: CommandMetadataFunction = async () => {
+  // Dynamically determine the metadata for the command
+
+  return {
+    userPermissions: 'Administrator',
+    botPermissions: ['KickMembers', 'BanMembers'],
+    guilds: ['1234567890', '1234567891'],
+    aliases: ['p', 'pong'],
+  };
 };
 
 const tests = Array.from({ length: 10 }, (_, i) => ({
diff --git a/apps/website/docs/api-reference/ai/functions/create-tool.mdx b/apps/website/docs/api-reference/ai/functions/create-tool.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## createTool
 
-<GenerationInfo sourceFile="packages/ai/src/tools/common/index.ts" sourceLine="88" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/tools/common/index.ts" sourceLine="90" packageName="@commandkit/ai" />
 
 Creates a new AI tool with the specified configuration.
 This function wraps the underlying AI library's tool creation with additional
diff --git a/apps/website/docs/api-reference/ai/interfaces/configure-ai.mdx b/apps/website/docs/api-reference/ai/interfaces/configure-ai.mdx
@@ -23,16 +23,16 @@ interface ConfigureAI {
     messageFilter?: MessageFilter;
     selectAiModel: SelectAiModel;
     prepareSystemPrompt?: (ctx: AiContext, message: Message) => Promise<string>;
-    preparePrompt?: (
-    ctx: AiContext,
-    message: Message,
+    preparePrompt?: (
+    ctx: AiContext,
+    message: Message,
   ) => Promise<string | AiMessage>;
     onProcessingStart?: (ctx: AiContext, message: Message) => Promise<void>;
     onProcessingFinish?: (ctx: AiContext, message: Message) => Promise<void>;
-    onResult?: (
-    ctx: AiContext,
-    message: Message,
-    result: AIGenerateResult,
+    onResult?: (
+    ctx: AiContext,
+    message: Message,
+    result: AIGenerateResult,
   ) => Promise<void>;
     onError?: (ctx: AiContext, message: Message, error: Error) => Promise<void>;
 }
@@ -49,24 +49,24 @@ Whether to disable the built-in tools. Default is false.
 
 <MemberInfo kind="property" type={`<a href='/docs/next/api-reference/ai/types/message-filter#messagefilter'>MessageFilter</a>`}   />
 
-A filter function that determines whether a message should be processed by the AI.
+A filter function that determines whether a message should be processed by the AI.
 CommandKit invokes this function before processing the message.
 ### selectAiModel
 
 <MemberInfo kind="property" type={`<a href='/docs/next/api-reference/ai/types/select-ai-model#selectaimodel'>SelectAiModel</a>`}   />
 
-A function that selects the AI model to use based on the message.
+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
 
 <MemberInfo kind="property" type={`(ctx: <a href='/docs/next/api-reference/ai/classes/ai-context#aicontext'>AiContext</a>, message: Message) =&#62; Promise&#60;string&#62;`}   />
 
-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.
+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
 
-<MemberInfo kind="property" type={`(     ctx: <a href='/docs/next/api-reference/ai/classes/ai-context#aicontext'>AiContext</a>,     message: Message,   ) =&#62; Promise&#60;string | <a href='/docs/next/api-reference/ai/types/ai-message#aimessage'>AiMessage</a>&#62;`}   />
+<MemberInfo kind="property" type={`(     ctx: <a href='/docs/next/api-reference/ai/classes/ai-context#aicontext'>AiContext</a>,     message: Message,   ) =&#62; Promise&#60;string | <a href='/docs/next/api-reference/ai/types/ai-message#aimessage'>AiMessage</a>&#62;`}   />
 
 A function that prepares the prompt for the AI model.
 ### onProcessingStart
@@ -81,7 +81,7 @@ A function that gets called when the AI starts processing a message.
 A function that gets called when the AI finishes processing a message.
 ### onResult
 
-<MemberInfo kind="property" type={`(     ctx: <a href='/docs/next/api-reference/ai/classes/ai-context#aicontext'>AiContext</a>,     message: Message,     result: <a href='/docs/next/api-reference/ai/types/aigenerate-result#aigenerateresult'>AIGenerateResult</a>,   ) =&#62; Promise&#60;void&#62;`}   />
+<MemberInfo kind="property" type={`(     ctx: <a href='/docs/next/api-reference/ai/classes/ai-context#aicontext'>AiContext</a>,     message: Message,     result: <a href='/docs/next/api-reference/ai/types/aigenerate-result#aigenerateresult'>AIGenerateResult</a>,   ) =&#62; Promise&#60;void&#62;`}   />
 
 A function that gets called upon receiving the result from the AI model.
 ### onError
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
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## CreateToolOptions
 
-<GenerationInfo sourceFile="packages/ai/src/tools/common/index.ts" sourceLine="36" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/tools/common/index.ts" sourceLine="38" packageName="@commandkit/ai" />
 
 Configuration options for creating an AI tool.
 
diff --git a/apps/website/docs/api-reference/ai/types/infer-parameters.mdx b/apps/website/docs/api-reference/ai/types/infer-parameters.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## InferParameters
 
-<GenerationInfo sourceFile="packages/ai/src/tools/common/index.ts" sourceLine="24" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/tools/common/index.ts" sourceLine="25" packageName="@commandkit/ai" />
 
 Utility type that infers the TypeScript type from a tool parameter schema.
 Supports both Zod schemas and AI library schemas.
@@ -23,5 +23,7 @@ type InferParameters<T extends ToolParameterType> = T extends Schema<any>
     ? T['_type']
     : T extends z.ZodTypeAny
       ? z.infer<T>
-      : never
+      : T extends z3.ZodTypeAny
+        ? z3.infer<T>
+        : never
 ```
diff --git a/apps/website/docs/api-reference/ai/types/tool-execute-function.mdx b/apps/website/docs/api-reference/ai/types/tool-execute-function.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## ToolExecuteFunction
 
-<GenerationInfo sourceFile="packages/ai/src/tools/common/index.ts" sourceLine="55" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/tools/common/index.ts" sourceLine="57" packageName="@commandkit/ai" />
 
 Type definition for a tool's execute function.
 
diff --git a/apps/website/docs/api-reference/ai/types/tool-parameter-type.mdx b/apps/website/docs/api-reference/ai/types/tool-parameter-type.mdx
@@ -13,11 +13,11 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## ToolParameterType
 
-<GenerationInfo sourceFile="packages/ai/src/tools/common/index.ts" sourceLine="17" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/tools/common/index.ts" sourceLine="18" packageName="@commandkit/ai" />
 
 Type representing the parameters schema for AI tools.
 Extracted from the first parameter of the `tool` function from the 'ai' library.
 
 ```ts title="Signature"
-type ToolParameterType = z.ZodType | Schema<any>
+type ToolParameterType = z.ZodType | z3.ZodType | Schema<any>
 ```
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
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## UseCacheDirectivePlugin
 
-<GenerationInfo sourceFile="packages/cache/src/use-cache-directive.ts" sourceLine="13" packageName="@commandkit/cache" />
+<GenerationInfo sourceFile="packages/cache/src/use-cache-directive.ts" sourceLine="12" packageName="@commandkit/cache" />
 
 Compiler plugin for the "use cache" directive.
 This plugin transforms the "use cache" directive into a runtime cache operation.
diff --git a/apps/website/docs/api-reference/commandkit/classes/analytics-engine.mdx b/apps/website/docs/api-reference/commandkit/classes/analytics-engine.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## AnalyticsEngine
 
-<GenerationInfo sourceFile="packages/commandkit/src/analytics/analytics-engine.ts" sourceLine="26" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/analytics/analytics-engine.ts" sourceLine="25" packageName="commandkit" />
 
 AnalyticsEngine class for managing analytics providers and tracking events.
 This class allows you to register a provider, set a filter for events, and track or identify events.
diff --git a/apps/website/docs/api-reference/commandkit/functions/flag.mdx b/apps/website/docs/api-reference/commandkit/functions/flag.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## flag
 
-<GenerationInfo sourceFile="packages/commandkit/src/flags/feature-flags.ts" sourceLine="412" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/flags/feature-flags.ts" sourceLine="410" packageName="commandkit" />
 
 Create a new feature flag.
 
diff --git a/apps/website/docs/api-reference/commandkit/functions/redirect.mdx b/apps/website/docs/api-reference/commandkit/functions/redirect.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## redirect
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/interrupt/signals.ts" sourceLine="35" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/interrupt/signals.ts" sourceLine="34" packageName="commandkit" />
 
 Stops current command assuming it has been redirected to another command.
 
diff --git a/apps/website/docs/api-reference/commandkit/functions/rethrow.mdx b/apps/website/docs/api-reference/commandkit/functions/rethrow.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## rethrow
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/interrupt/signals.ts" sourceLine="28" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/interrupt/signals.ts" sourceLine="27" packageName="commandkit" />
 
 Rethrow the error if it is a CommandKit error.
 
diff --git a/apps/website/docs/api-reference/commandkit/functions/stop-events.mdx b/apps/website/docs/api-reference/commandkit/functions/stop-events.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## stopEvents
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/interrupt/signals.ts" sourceLine="51" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/interrupt/signals.ts" sourceLine="50" packageName="commandkit" />
 
 Stops event propagation. This function should be called inside an event handler
 to prevent further event handling.
diff --git a/apps/website/docs/api-reference/commandkit/functions/stop-middlewares.mdx b/apps/website/docs/api-reference/commandkit/functions/stop-middlewares.mdx
@@ -13,10 +13,9 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## stopMiddlewares
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/interrupt/signals.ts" sourceLine="12" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/interrupt/signals.ts" sourceLine="11" packageName="commandkit" />
 
-Stop upcoming middleware and command execution.
-This will **not** stop any `after()` callbacks inside the command.
+Stop upcoming middlewares and command execution.
 
 ```ts title="Signature"
 function stopMiddlewares(): never
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
@@ -21,34 +21,34 @@ Context for evaluating command flags in CommandKit.
 interface CommandFlagContext {
     client: Client<true>;
     commandkit: CommandKit;
-    command: {
-    /**
-     * The interaction object if the command was invoked via an interaction.
-     * This can be a ChatInputCommandInteraction, AutocompleteInteraction, or ContextMenuCommandInteraction.
-     */
-    interaction?:
-      | ChatInputCommandInteraction
-      | AutocompleteInteraction
-      | ContextMenuCommandInteraction;
-    /**
-     * The message object if the command was invoked via a message.
-     */
-    message?: Message;
-    /**
-     * The guild where the command was invoked, if applicable.
-     * This will be null for commands invoked in DMs.
-     */
-    guild: Guild | null;
-    /**
-     * The channel where the command was invoked.
-     * This can be a text channel, DM channel, or any other type of text-based channel.
-     */
-    channel: TextBasedChannel | null;
-    /**
-     * The loaded command instance that is being executed.
-     * This contains the command's metadata and logic.
-     */
-    command: LoadedCommand;
+    command: {
+    /**
+     * The interaction object if the command was invoked via an interaction.
+     * This can be a ChatInputCommandInteraction, AutocompleteInteraction, or ContextMenuCommandInteraction.
+     */
+    interaction?:
+      | ChatInputCommandInteraction
+      | AutocompleteInteraction
+      | ContextMenuCommandInteraction;
+    /**
+     * The message object if the command was invoked via a message.
+     */
+    message?: Message;
+    /**
+     * The guild where the command was invoked, if applicable.
+     * This will be null for commands invoked in DMs.
+     */
+    guild: Guild | null;
+    /**
+     * The channel where the command was invoked.
+     * This can be a text channel, DM channel, or any other type of text-based channel.
+     */
+    channel: TextBasedChannel | null;
+    /**
+     * The loaded command instance that is being executed.
+     * This contains the command's metadata and logic.
+     */
+    command: LoadedCommand;
   };
     event: null;
 }
@@ -60,25 +60,25 @@ interface CommandFlagContext {
 
 <MemberInfo kind="property" type={`Client&#60;true&#62;`}   />
 
-The Discord client instance.
+The Discord client instance.
 This is the main entry point for interacting with the Discord API.
 ### commandkit
 
 <MemberInfo kind="property" type={`<a href='/docs/next/api-reference/commandkit/classes/command-kit#commandkit'>CommandKit</a>`}   />
 
-The CommandKit instance, which provides access to the command framework.
+The CommandKit instance, which provides access to the command framework.
 This includes commands, events, and other features of CommandKit.
 ### command
 
-<MemberInfo kind="property" type={`{     /**      * The interaction object if the command was invoked via an interaction.      * This can be a ChatInputCommandInteraction, AutocompleteInteraction, or ContextMenuCommandInteraction.      */     interaction?:       | ChatInputCommandInteraction       | AutocompleteInteraction       | ContextMenuCommandInteraction;     /**      * The message object if the command was invoked via a message.      */     message?: Message;     /**      * The guild where the command was invoked, if applicable.      * This will be null for commands invoked in DMs.      */     guild: Guild | null;     /**      * The channel where the command was invoked.      * This can be a text channel, DM channel, or any other type of text-based channel.      */     channel: TextBasedChannel | null;     /**      * The loaded command instance that is being executed.      * This contains the command's metadata and logic.      */     command: <a href='/docs/next/api-reference/commandkit/interfaces/loaded-command#loadedcommand'>LoadedCommand</a>;   }`}   />
+<MemberInfo kind="property" type={`{     /**      * The interaction object if the command was invoked via an interaction.      * This can be a ChatInputCommandInteraction, AutocompleteInteraction, or ContextMenuCommandInteraction.      */     interaction?:       | ChatInputCommandInteraction       | AutocompleteInteraction       | ContextMenuCommandInteraction;     /**      * The message object if the command was invoked via a message.      */     message?: Message;     /**      * The guild where the command was invoked, if applicable.      * This will be null for commands invoked in DMs.      */     guild: Guild | null;     /**      * The channel where the command was invoked.      * This can be a text channel, DM channel, or any other type of text-based channel.      */     channel: TextBasedChannel | null;     /**      * The loaded command instance that is being executed.      * This contains the command's metadata and logic.      */     command: <a href='/docs/next/api-reference/commandkit/interfaces/loaded-command#loadedcommand'>LoadedCommand</a>;   }`}   />
 
-The command context, which includes information about the command being executed.
+The command context, which includes information about the command being executed.
 This can include the interaction, message, guild, channel, and the loaded command.
 ### event
 
 <MemberInfo kind="property" type={`null`}   />
 
-The event context is null for command flags, as they are not tied to a specific event.
+The event context is null for command flags, as they are not tied to a specific event.
 This is used to differentiate between command and event flags.
 
 
diff --git a/apps/website/docs/api-reference/commandkit/interfaces/context-parameters.mdx b/apps/website/docs/api-reference/commandkit/interfaces/context-parameters.mdx
@@ -22,14 +22,14 @@ interface ContextParameters<T extends CommandExecutionMode, Args = Record<string
     command: LoadedCommand;
     environment?: CommandKitEnvironment;
     executionMode: T;
-    interaction: T extends 'chatInput'
-    ? ChatInputCommandInteraction
-    : T extends 'messageContextMenu'
-      ? MessageContextMenuCommandInteraction
-      : T extends 'userContextMenu'
-        ? UserContextMenuCommandInteraction
-        : T extends 'autocomplete'
-          ? AutocompleteInteraction
+    interaction: T extends 'chatInput'
+    ? ChatInputCommandInteraction
+    : T extends 'messageContextMenu'
+      ? MessageContextMenuCommandInteraction
+      : T extends 'userContextMenu'
+        ? UserContextMenuCommandInteraction
+        : T extends 'autocomplete'
+          ? AutocompleteInteraction
           : never;
     message: T extends 'message' ? Message : never;
     forwarded?: boolean;
@@ -58,7 +58,7 @@ interface ContextParameters<T extends CommandExecutionMode, Args = Record<string
 
 ### interaction
 
-<MemberInfo kind="property" type={`T extends 'chatInput'     ? ChatInputCommandInteraction     : T extends 'messageContextMenu'       ? MessageContextMenuCommandInteraction       : T extends 'userContextMenu'         ? UserContextMenuCommandInteraction         : T extends 'autocomplete'           ? AutocompleteInteraction           : never`}   />
+<MemberInfo kind="property" type={`T extends 'chatInput'     ? ChatInputCommandInteraction     : T extends 'messageContextMenu'       ? MessageContextMenuCommandInteraction       : T extends 'userContextMenu'         ? UserContextMenuCommandInteraction         : T extends 'autocomplete'           ? AutocompleteInteraction           : never`}   />
 
 
 ### message
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
diff --git a/apps/website/docs/api-reference/commandkit/types/filter-function.mdx b/apps/website/docs/api-reference/commandkit/types/filter-function.mdx
diff --git a/apps/website/docs/guide/02-commands/01-chat-input-commands.mdx b/apps/website/docs/guide/02-commands/01-chat-input-commands.mdx
diff --git a/apps/website/docs/guide/02-commands/05-command-metadata.mdx b/apps/website/docs/guide/02-commands/05-command-metadata.mdx
diff --git a/apps/website/docs/guide/02-commands/06-after-function.mdx b/apps/website/docs/guide/02-commands/06-after-function.mdx
diff --git a/apps/website/docs/guide/02-commands/07-category-directory.mdx b/apps/website/docs/guide/02-commands/07-category-directory.mdx
diff --git a/apps/website/docs/guide/02-commands/08-middlewares.mdx b/apps/website/docs/guide/02-commands/08-middlewares.mdx
diff --git a/apps/website/docs/guide/05-official-plugins/01-commandkit-ai.mdx b/apps/website/docs/guide/05-official-plugins/01-commandkit-ai.mdx
