refactor: ai plugin

Author: twlite

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

@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## AiContext
 
-<GenerationInfo sourceFile="packages/ai/src/context.ts" sourceLine="17" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/context.ts" sourceLine="29" packageName="@commandkit/ai" />
 
 Represents the context in which an AI command is executed.
 This includes the parameters passed to the command, the message that triggered it,
@@ -25,6 +25,7 @@ class AiContext<T extends Record<string, unknown> = Record<string, unknown>> {
     public message!: Message;
     public client!: Client;
     public commandkit!: CommandKit;
+    public store = new Map<string, any>();
     constructor(options: AiContextOptions<T>)
     setParams(params: T) => void;
 }
@@ -52,6 +53,11 @@ The client instance associated with the AI command.
 <MemberInfo kind="property" type={`<a href='/docs/next/api-reference/commandkit/classes/command-kit#commandkit'>CommandKit</a>`}   />
 
 The CommandKit instance associated with the AI command.
+### store
+
+<MemberInfo kind="property" type={``}   />
+
+A key-value store to hold additional data.
 ### constructor
 
 <MemberInfo kind="method" type={`(options: <a href='/docs/next/api-reference/ai/interfaces/ai-context-options#aicontextoptions'>AiContextOptions</a>&#60;T&#62;) => AiContext`}   />

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="78" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/plugin.ts" sourceLine="38" packageName="@commandkit/ai" />
 
 
 
@@ -23,7 +23,7 @@ class AiPlugin extends RuntimePlugin<AiPluginOptions> {
     constructor(options: AiPluginOptions)
     activate(ctx: CommandKitPluginRuntime) => Promise<void>;
     deactivate(ctx: CommandKitPluginRuntime) => Promise<void>;
-    onBeforeCommandsLoad(ctx: CommandKitPluginRuntime) => Promise<void>;
+    onBeforeCommandsLoad() => Promise<void>;
     onAfterCommandsLoad(ctx: CommandKitPluginRuntime) => Promise<void>;
 }
 ```
@@ -55,7 +55,7 @@ class AiPlugin extends RuntimePlugin<AiPluginOptions> {
 
 ### onBeforeCommandsLoad
 
-<MemberInfo kind="method" type={`(ctx: <a href='/docs/next/api-reference/commandkit/classes/command-kit-plugin-runtime#commandkitpluginruntime'>CommandKitPluginRuntime</a>) => Promise&#60;void&#62;`}   />
+<MemberInfo kind="method" type={`() => Promise&#60;void&#62;`}   />
 
 
 ### onAfterCommandsLoad

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="9" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/index.ts" sourceLine="18" packageName="@commandkit/ai" />
 
 Defines the AI plugin for the application.
 

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/plugin.ts" sourceLine="64" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="128" 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.

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

@@ -0,0 +1,51 @@
+---
+title: "CreateTool"
+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 -->
+
+
+## createTool
+
+<GenerationInfo sourceFile="packages/ai/src/tools/common/index.ts" sourceLine="88" packageName="@commandkit/ai" />
+
+Creates a new AI tool with the specified configuration.
+This function wraps the underlying AI library's tool creation with additional
+context management and parameter validation.
+
+
+
+*Example*
+
+```typescript
+const myTool = createTool({
+  name: 'calculate',
+  description: 'Performs basic arithmetic calculations',
+  parameters: z.object({
+    operation: z.enum(['add', 'subtract']),
+    a: z.number(),
+    b: z.number(),
+  }),
+  execute: async (ctx, params) => {
+    return params.operation === 'add'
+      ? params.a + params.b
+      : params.a - params.b;
+  },
+});
+```
+
+```ts title="Signature"
+function createTool<T extends ToolParameterType, R = unknown>(options: CreateToolOptions<T, R>): void
+```
+Parameters
+
+### options
+
+<MemberInfo kind="parameter" type={`<a href='/docs/next/api-reference/ai/interfaces/create-tool-options#createtooloptions'>CreateToolOptions</a>&#60;T, R&#62;`} />
+

apps/website/docs/api-reference/ai/functions/get-aiconfig.mdx

@@ -0,0 +1,22 @@
+---
+title: "GetAIConfig"
+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 -->
+
+
+## getAIConfig
+
+<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="119" packageName="@commandkit/ai" />
+
+Retrieves the current AI configuration.
+
+```ts title="Signature"
+function getAIConfig(): Required<ConfigureAI>
+```

apps/website/docs/api-reference/ai/functions/use-aicontext.mdx

@@ -0,0 +1,22 @@
+---
+title: "UseAIContext"
+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 -->
+
+
+## useAIContext
+
+<GenerationInfo sourceFile="packages/ai/src/index.ts" sourceLine="8" packageName="@commandkit/ai" />
+
+Retrieves the AI context.
+
+```ts title="Signature"
+function useAIContext(): void
+```

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

@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## AiConfig
 
-<GenerationInfo sourceFile="packages/ai/src/plugin.ts" sourceLine="22" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/plugin.ts" sourceLine="19" packageName="@commandkit/ai" />
 
 Represents the configuration options for the AI plugin scoped to a specific command.
 

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

@@ -13,9 +13,9 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## AiContextOptions
 
-<GenerationInfo sourceFile="packages/ai/src/context.ts" sourceLine="4" packageName="@commandkit/ai" />
-
+<GenerationInfo sourceFile="packages/ai/src/context.ts" sourceLine="7" packageName="@commandkit/ai" />
 
+Options for the AI context.
 
 ```ts title="Signature"
 interface AiContextOptions<T extends Record<string, unknown> = Record<string, unknown>> {
@@ -31,17 +31,17 @@ interface AiContextOptions<T extends Record<string, unknown> = Record<string, un
 
 <MemberInfo kind="property" type={`Message`}   />
 
-
+The message that triggered the AI command.
 ### params
 
 <MemberInfo kind="property" type={`T`}   />
 
-
+The parameters passed to the AI command.
 ### commandkit
 
 <MemberInfo kind="property" type={`<a href='/docs/next/api-reference/commandkit/classes/command-kit#commandkit'>CommandKit</a>`}   />
 
-
+The CommandKit instance associated with the AI command.
 
 
 </div>

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