fix: ai plugin enhancements

Author: twlite

apps/test-bot/src/app/commands/(interactions)/confirmation.tsx

@@ -4,10 +4,9 @@ import {
   ChatInputCommandContext,
   CommandData,
   OnButtonKitClick,
-  MessageCommandContext,
 } from 'commandkit';
 import { ButtonStyle, MessageFlags } from 'discord.js';
-import { AiConfig, AiContext } from '@commandkit/ai';
+import { AiConfig, AiCommand } from '@commandkit/ai';
 import { z } from 'zod';
 
 export const command: CommandData = {
@@ -60,8 +59,8 @@ export async function chatInput({ interaction }: ChatInputCommandContext) {
   });
 }
 
-export async function ai(ctx: MessageCommandContext) {
-  const message = ctx.ai?.params?.message as string;
+export const ai: AiCommand<typeof aiConfig> = async (ctx) => {
+  const message = ctx.ai.params.message;
 
   const buttons = (
     <ActionRow>
@@ -78,4 +77,4 @@ export async function ai(ctx: MessageCommandContext) {
     content: message || 'There was no confirmation message provided.',
     components: [buttons],
   });
-}
+};

apps/test-bot/src/app/commands/(leveling)/xp.ts

@@ -5,7 +5,7 @@ import {
 } from 'commandkit';
 import { database } from '@/database/store.ts';
 import { cacheTag } from '@commandkit/cache';
-import { AiConfig } from '@commandkit/ai';
+import { AiCommand, AiConfig } from '@commandkit/ai';
 import { z } from 'zod';
 
 export const command: CommandData = {
@@ -54,7 +54,7 @@ export async function chatInput({ interaction }: ChatInputCommandContext) {
   });
 }
 
-export async function ai(ctx: MessageCommandContext) {
+export const ai: AiCommand<typeof aiConfig> = async (ctx) => {
   const message = ctx.message;
 
   if (!message.inGuild()) {
@@ -63,9 +63,7 @@ export async function ai(ctx: MessageCommandContext) {
     };
   }
 
-  const { guildId, userId } = ctx.ai?.params as z.infer<
-    (typeof aiConfig)['parameters']
-  >;
+  const { guildId, userId } = ctx.ai.params;
 
   const xp = await getUserXP(guildId, userId);
 
@@ -74,4 +72,4 @@ export async function ai(ctx: MessageCommandContext) {
     guildId,
     xp,
   };
-}
+};

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

@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## getAIConfig
 
-<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="119" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="161" packageName="@commandkit/ai" />
 
 Retrieves the current AI configuration.
 

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

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

@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## ConfigureAI
 
-<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="13" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="16" packageName="@commandkit/ai" />
 
 Represents the configuration options for the AI model.
 
@@ -23,7 +23,10 @@ interface ConfigureAI {
     messageFilter?: MessageFilter;
     selectAiModel: SelectAiModel;
     prepareSystemPrompt?: (ctx: AiContext, message: Message) => Promise<string>;
-    preparePrompt?: (ctx: AiContext, message: Message) => Promise<string>;
+    preparePrompt?: (
+    ctx: AiContext,
+    message: Message,
+  ) => Promise<string | AiMessage>;
     onProcessingStart?: (ctx: AiContext, message: Message) => Promise<void>;
     onProcessingFinish?: (ctx: AiContext, message: Message) => Promise<void>;
     onResult?: (
@@ -63,7 +66,7 @@ This function should return a promise that resolves to a string containing the s
 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&#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

apps/website/docs/api-reference/ai/types/ai-command-context.mdx

@@ -0,0 +1,23 @@
+---
+title: "AiCommandContext"
+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 -->
+
+
+## AiCommandContext
+
+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="58" packageName="@commandkit/ai" />
+
+Represents the context in which an AI command is executed.
+It extends the MessageCommandContext to include AI-specific properties.
+
+```ts title="Signature"
+type AiCommandContext<T extends Record<string, unknown>> = MessageCommandContext & { ai: AiContext<ExtractAiConfig<T>> }
+```

apps/website/docs/api-reference/ai/types/ai-command.mdx

@@ -13,12 +13,10 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## AiCommand
 
-<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="50" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="66" packageName="@commandkit/ai" />
 
 Represents a command that can be executed by the AI.
 
 ```ts title="Signature"
-type AiCommand<T extends Record<string, unknown>> = (
-  ctx: AiContext<T>,
-) => Promise<unknown> | unknown
+type AiCommand<T extends Record<string, unknown> = Record<string, unknown>> = (ctx: AiCommandContext<ExtractAiConfig<T>>) => Promise<unknown> | unknown
 ```

apps/website/docs/api-reference/ai/types/ai-message.mdx

@@ -0,0 +1,22 @@
+---
+title: "AiMessage"
+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 -->
+
+
+## AiMessage
+
+<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="9" packageName="@commandkit/ai" />
+
+
+
+```ts title="Signature"
+type AiMessage = Parameters<typeof generateText>[0]['messages'] & {}
+```

apps/website/docs/api-reference/ai/types/aigenerate-result.mdx

@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## AIGenerateResult
 
-<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="9" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/types.ts" sourceLine="11" packageName="@commandkit/ai" />
 
 Represents the result of an AI text generation operation.