feat: experimental_createConfig

Author: twlite

apps/website/docs/api-reference/ai/classes/ai-plugin.mdx

@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## AiPlugin
 
-<GenerationInfo sourceFile="packages/ai/src/plugin.ts" sourceLine="38" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/plugin.ts" sourceLine="39" packageName="@commandkit/ai" />
 
 
 

apps/website/docs/api-reference/ai/functions/experimental_create-config.mdx

@@ -0,0 +1,28 @@
+---
+title: "Experimental_createConfig"
+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 -->
+
+
+## experimental_createConfig
+
+<GenerationInfo sourceFile="packages/ai/src/utils.ts" sourceLine="37" packageName="@commandkit/ai" experimental="true" />
+
+Generates AI config from a CommandKit command data.
+
+```ts title="Signature"
+function experimental_createConfig(command: CommandData): AiConfig
+```
+Parameters
+
+### command
+
+<MemberInfo kind="parameter" type={`<a href='/docs/next/api-reference/commandkit/types/command-data#commanddata'>CommandData</a>`} />
+

apps/website/docs/api-reference/ai/interfaces/ai-config.mdx

@@ -13,14 +13,14 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## AiConfig
 
-<GenerationInfo sourceFile="packages/ai/src/plugin.ts" sourceLine="19" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/plugin.ts" sourceLine="20" packageName="@commandkit/ai" />
 
 Represents the configuration options for the AI plugin scoped to a specific command.
 
 ```ts title="Signature"
-interface AiConfig {
+interface AiConfig<T extends ToolParameterType = ToolParameterType> {
     description?: string;
-    parameters: any;
+    inputSchema: T;
 }
 ```
 
@@ -31,9 +31,9 @@ interface AiConfig {
 <MemberInfo kind="property" type={`string`}   />
 
 A description of the AI functionality provided by this command. If not given, the command's description will be used.
-### parameters
+### inputSchema
 
-<MemberInfo kind="property" type={`any`}   />
+<MemberInfo kind="property" type={`T`}   />
 
 A zod schema defining the parameters that the AI command accepts.
 

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="41" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="44" packageName="@commandkit/ai" />
 
 Options for the AI plugin.
 

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

apps/website/docs/api-reference/ai/interfaces/create-tool-options.mdx

@@ -21,7 +21,7 @@ Configuration options for creating an AI tool.
 interface CreateToolOptions<T extends ToolParameterType, R = unknown> {
     name: string;
     description: string;
-    parameters: T;
+    inputSchema: T;
     execute: ToolExecuteFunction<T, R>;
 }
 ```
@@ -38,7 +38,7 @@ The unique name identifier for the tool
 <MemberInfo kind="property" type={`string`}   />
 
 A human-readable description of what the tool does
-### parameters
+### inputSchema
 
 <MemberInfo kind="property" type={`T`}   />
 

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="54" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="57" packageName="@commandkit/ai" />
 
 Represents the context in which an AI command is executed.
 It extends the MessageCommandContext to include AI-specific properties.

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="62" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="65" packageName="@commandkit/ai" />
 
 Represents a command that can be executed by the AI.
 

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="35" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="38" packageName="@commandkit/ai" />
 
 
 

apps/website/docs/api-reference/ai/types/extract-ai-config.mdx

@@ -13,10 +13,10 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## ExtractAiConfig
 
-<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="46" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="49" packageName="@commandkit/ai" />
 
 Extracts the AI configuration params.
 
 ```ts title="Signature"
-type ExtractAiConfig<T extends Record<string, unknown>> = T extends AiConfig ? InferParameters<T['parameters']> : T
+type ExtractAiConfig<T extends Record<string, unknown>> = T extends AiConfig ? InferParameters<T['inputSchema']> : T
 ```