Merge pull request #252 from underctrl-io/docgen

twlite · web-flow · commit 276907a8ed90 · 2025-06-14T16:46:22.000+05:45
docs: generate api docs
diff --git a/apps/website/docs/api-reference/ai/functions/ai.mdx b/apps/website/docs/api-reference/ai/functions/ai.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## ai
 
-<GenerationInfo sourceFile="packages/ai/src/index.ts" sourceLine="36" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/index.ts" sourceLine="52" packageName="@commandkit/ai" />
 
 Defines the AI plugin for the application.
 
diff --git 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
 
-<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="170" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="183" packageName="@commandkit/ai" />
 
 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.
diff --git a/apps/website/docs/api-reference/ai/functions/execute-ai.mdx b/apps/website/docs/api-reference/ai/functions/execute-ai.mdx
@@ -0,0 +1,38 @@
+---
+title: "ExecuteAI"
+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';
+
+<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
+
+
+## executeAI
+
+<GenerationInfo sourceFile="packages/ai/src/index.ts" sourceLine="42" packageName="@commandkit/ai" />
+
+Executes an AI command.
+
+
+
+*Example*
+
+```ts
+const message = await getMessageSomehow();
+// use AI to process the message
+await executeAI(message);
+```
+
+```ts title="Signature"
+function executeAI(message: Message): Promise<void>
+```
+Parameters
+
+### message
+
+<MemberInfo kind="parameter" type={`Message`} />
+
diff --git 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
 
-<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="161" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="174" packageName="@commandkit/ai" />
 
 Retrieves the current AI configuration.
 
diff --git a/apps/website/docs/api-reference/ai/functions/use-ai.mdx b/apps/website/docs/api-reference/ai/functions/use-ai.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## useAI
 
-<GenerationInfo sourceFile="packages/ai/src/index.ts" sourceLine="18" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/index.ts" sourceLine="19" packageName="@commandkit/ai" />
 
 Fetches the AI plugin instance.
 
diff --git a/apps/website/docs/api-reference/ai/functions/use-aicontext.mdx b/apps/website/docs/api-reference/ai/functions/use-aicontext.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## useAIContext
 
-<GenerationInfo sourceFile="packages/ai/src/index.ts" sourceLine="10" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/index.ts" sourceLine="11" packageName="@commandkit/ai" />
 
 Retrieves the AI context.
 
diff --git a/apps/website/docs/api-reference/ai/interfaces/ai-plugin-options.mdx b/apps/website/docs/api-reference/ai/interfaces/ai-plugin-options.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## AiPluginOptions
 
-<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="45" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="41" packageName="@commandkit/ai" />
 
 Options for the AI plugin.
 
diff --git a/apps/website/docs/api-reference/ai/types/ai-command-context.mdx b/apps/website/docs/api-reference/ai/types/ai-command-context.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## AiCommandContext
 
-<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="58" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="54" packageName="@commandkit/ai" />
 
 Represents the context in which an AI command is executed.
 It extends the MessageCommandContext to include AI-specific properties.
diff --git a/apps/website/docs/api-reference/ai/types/ai-command.mdx b/apps/website/docs/api-reference/ai/types/ai-command.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## AiCommand
 
-<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="66" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="62" packageName="@commandkit/ai" />
 
 Represents a command that can be executed by the AI.
 
diff --git a/apps/website/docs/api-reference/ai/types/command-tool.mdx b/apps/website/docs/api-reference/ai/types/command-tool.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## CommandTool
 
-<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="39" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="35" packageName="@commandkit/ai" />
 
 
 
diff --git a/apps/website/docs/api-reference/ai/types/extract-ai-config.mdx b/apps/website/docs/api-reference/ai/types/extract-ai-config.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## ExtractAiConfig
 
-<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="50" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="46" packageName="@commandkit/ai" />
 
 Extracts the AI configuration params.
 
diff --git a/apps/website/docs/api-reference/ai/types/message-filter.mdx b/apps/website/docs/api-reference/ai/types/message-filter.mdx
@@ -13,10 +13,13 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## MessageFilter
 
-<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="25" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="18" packageName="@commandkit/ai" />
 
 Function type for filtering messages before they are processed by the AI.
 
 ```ts title="Signature"
-type MessageFilter = (message: Message) => Promise<boolean>
+type MessageFilter = (
+  commandkit: CommandKit,
+  message: Message,
+) => Promise<boolean>
 ```
diff --git a/apps/website/docs/api-reference/ai/types/select-ai-model-result.mdx b/apps/website/docs/api-reference/ai/types/select-ai-model-result.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## SelectAiModelResult
 
-<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="37" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="33" packageName="@commandkit/ai" />
 
 
 
diff --git a/apps/website/docs/api-reference/ai/types/select-ai-model.mdx b/apps/website/docs/api-reference/ai/types/select-ai-model.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## SelectAiModel
 
-<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="32" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="28" packageName="@commandkit/ai" />
 
 Function type for selecting an AI model based on the message.
 
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
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## AppCommandHandler
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="143" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="149" packageName="commandkit" />
 
 Handles application commands for CommandKit, including loading, registration, and execution.
 Manages both slash commands and message commands with middleware support.
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
@@ -13,15 +13,15 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## AppCommandNative
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="36" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="38" packageName="commandkit" />
 
 Represents a native command structure used in CommandKit.
 This structure includes the command definition and various handlers for different interaction types.
 It can be used to define slash commands, context menu commands, and message commands.
 
 ```ts title="Signature"
 interface AppCommandNative {
-    command: SlashCommandBuilder | Record<string, any>;
+    command: CommandData | Record<string, any>;
     chatInput?: (ctx: Context) => Awaitable<unknown>;
     autocomplete?: (ctx: Context) => Awaitable<unknown>;
     message?: (ctx: Context) => Awaitable<unknown>;
@@ -34,7 +34,7 @@ interface AppCommandNative {
 
 ### command
 
-<MemberInfo kind="property" type={`SlashCommandBuilder | Record&#60;string, any&#62;`}   />
+<MemberInfo kind="property" type={`<a href='/docs/next/api-reference/commandkit/types/command-data#commanddata'>CommandData</a> | Record&#60;string, any&#62;`}   />
 
 
 ### chatInput
diff --git a/apps/website/docs/api-reference/commandkit/interfaces/command-context.mdx b/apps/website/docs/api-reference/commandkit/interfaces/command-context.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## CommandContext
 
-<GenerationInfo sourceFile="packages/commandkit/src/types.ts" sourceLine="22" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/types.ts" sourceLine="26" packageName="commandkit" />
 
 Represents a command context.
 
diff --git a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-options.mdx b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-options.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## CommandKitOptions
 
-<GenerationInfo sourceFile="packages/commandkit/src/types.ts" sourceLine="12" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/types.ts" sourceLine="16" packageName="commandkit" />
 
 Options for instantiating a CommandKit handler.
 
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
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## CustomAppCommandProps
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="50" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="52" packageName="commandkit" />
 
 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/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
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="72" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="74" packageName="commandkit" />
 
 Represents a loaded command with its metadata and configuration.
 
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
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## PreparedAppCommandExecution
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="100" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="102" packageName="commandkit" />
 
 Represents a prepared command execution with all necessary data and middleware.
 
diff --git 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
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="58" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="60" packageName="commandkit" />
 
 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/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
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="109" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="111" packageName="commandkit" />
 
 Type representing command builder objects supported by CommandKit.
 
diff --git a/apps/website/docs/api-reference/commandkit/types/command-data-schema-key.mdx b/apps/website/docs/api-reference/commandkit/types/command-data-schema-key.mdx
@@ -1,5 +1,5 @@
 ---
-title: "CommandFilterFunction"
+title: "CommandDataSchemaKey"
 isDefaultIndex: false
 generated: true
 ---
@@ -11,12 +11,12 @@ import MemberDescription from '@site/src/components/MemberDescription';
 <!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
 
 
-## CommandFilterFunction
+## CommandDataSchemaKey
+
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="133" packageName="commandkit" />
 
-<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="18" packageName="@commandkit/ai" />
 
-Function type for filtering commands based on their name.
 
 ```ts title="Signature"
-type CommandFilterFunction = (commandName: string) => boolean
+type CommandDataSchemaKey = keyof CommandDataSchema
 ```
diff --git a/apps/website/docs/api-reference/commandkit/types/command-data-schema-value.mdx b/apps/website/docs/api-reference/commandkit/types/command-data-schema-value.mdx
@@ -0,0 +1,22 @@
+---
+title: "CommandDataSchemaValue"
+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';
+
+<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
+
+
+## CommandDataSchemaValue
+
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="134" packageName="commandkit" />
+
+
+
+```ts title="Signature"
+type CommandDataSchemaValue = CommandDataSchema[CommandDataSchemaKey]
+```
diff --git a/apps/website/docs/api-reference/commandkit/types/command-data-schema.mdx b/apps/website/docs/api-reference/commandkit/types/command-data-schema.mdx
@@ -0,0 +1,22 @@
+---
+title: "CommandDataSchema"
+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';
+
+<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
+
+
+## CommandDataSchema
+
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="132" packageName="commandkit" />
+
+
+
+```ts title="Signature"
+type CommandDataSchema = typeof commandDataSchema
+```
diff --git a/apps/website/docs/api-reference/commandkit/types/command-data.mdx b/apps/website/docs/api-reference/commandkit/types/command-data.mdx
@@ -13,12 +13,15 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## CommandData
 
-<GenerationInfo sourceFile="packages/commandkit/src/types.ts" sourceLine="43" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/types.ts" sourceLine="47" packageName="commandkit" />
 
 Represents a command that can be executed by CommandKit.
 
 ```ts title="Signature"
-type CommandData = RESTPostAPIApplicationCommandsJSONBody & {
-  guilds?: string[];
-}
+type CommandData = Prettify<
+  Omit<RESTPostAPIApplicationCommandsJSONBody, 'description'> & {
+    description?: string;
+    guilds?: string[];
+  }
+>
 ```
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
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## CommandTypeData
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="81" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="83" packageName="commandkit" />
 
 Type representing command data identifier.
 
diff --git 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
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="86" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="88" packageName="commandkit" />
 
 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
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## RunCommand
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="29" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="31" packageName="commandkit" />
 
 Function type for wrapping command execution with custom logic.
 
diff --git a/apps/website/src/plugins/llms-txt.js b/apps/website/src/plugins/llms-txt.js

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';`
`13`	`13`
`14`	`14`	`## CommandTool`
`15`	`15`
`16`		`-<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="39" packageName="@commandkit/ai" />`
	`16`	`+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="35" packageName="@commandkit/ai" />`
`17`	`17`
`18`	`18`
`19`	`19`