Merge pull request #249 from underctrl-io/fix-ai

refactor: update messageFilter to include commandkit parameter for improved filtering logic

Author: twlite

apps/test-bot/src/ai.ts

@@ -13,9 +13,4 @@ configureAI({
       model,
     };
   },
-  messageFilter: async (message) => {
-    return (
-      message.inGuild() && message.mentions.users.has(message.client.user.id)
-    );
-  },
 });

apps/website/docs/guide/13-ai-powered-commands/01-introduction.mdx

@@ -127,7 +127,7 @@ message: 'Hey bot, can you play some music?';
 ### 2. Message Filtering
 
 ```ts
-messageFilter: async (message) => {
+messageFilter: async (commandkit, message) => {
   return message.mentions.users.has(message.client.user.id);
 };
 ```
@@ -176,7 +176,7 @@ await message.reply('🎵 Now playing music!');
 ```ts
 configureAI({
   selectAiModel: async () => ({ model: myModel }),
-  messageFilter: async (message) =>
+  messageFilter: async (commandkit, message) =>
     message.mentions.users.has(message.client.user.id),
 });
 ```

apps/website/docs/guide/13-ai-powered-commands/02-ai-configuration.mdx

@@ -44,7 +44,7 @@ configureAI({
   },
 
   // Optional: Filter which messages trigger AI processing
-  messageFilter: async (message) => {
+  messageFilter: async (commandkit, message) => {
     // Only respond when the bot is mentioned
     return (
       message.inGuild() && message.mentions.users.has(message.client.user.id)
@@ -89,7 +89,7 @@ selectAiModel: async (ctx, message) => {
 Control which messages trigger AI processing:
 
 ```ts
-messageFilter: async (message) => {
+messageFilter: async (commandkit, message) => {
   // Only respond to mentions
   return message.mentions.users.has(message.client.user.id);
 
@@ -236,7 +236,7 @@ configureAI({
     };
   },
 
-  messageFilter: async (message) => {
+  messageFilter: async (commandkit, message) => {
     return message.mentions.users.has(message.client.user.id);
   },
 });

apps/website/docs/guide/13-ai-powered-commands/05-advanced-configuration.mdx

@@ -26,7 +26,7 @@ configureAI({
   }),
 
   // Optional: Filter which messages trigger AI processing
-  messageFilter: async (message) => {
+  messageFilter: async (commandkit, message) => {
     return message.mentions.users.has(message.client.user.id);
   },
 
@@ -130,7 +130,7 @@ selectAiModel: async (ctx, message) => ({
 ### Basic Filtering
 
 ```ts
-messageFilter: async (message) => {
+messageFilter: async (commandkit, message) => {
   // Only respond to mentions
   return message.mentions.users.has(message.client.user.id);
 };
@@ -139,7 +139,7 @@ messageFilter: async (message) => {
 ### Advanced Filtering
 
 ```ts
-messageFilter: async (message) => {
+messageFilter: async (commandkit, message) => {
   // Don't process bot messages
   if (message.author.bot) return false;
 
@@ -165,7 +165,7 @@ messageFilter: async (message) => {
 ### Role-based Filtering
 
 ```ts
-messageFilter: async (message) => {
+messageFilter: async (commandkit, message) => {
   if (!message.inGuild()) return false;
 
   const member = message.member;

apps/website/docs/guide/13-ai-powered-commands/08-troubleshooting.mdx

@@ -29,7 +29,7 @@ This guide covers common issues you might encounter when working with CommandKit
 
    ```ts
    // Check your message filter
-   messageFilter: async (message) => {
+   messageFilter: async (commandkit, message) => {
      console.log('Filtering message:', message.content);
      const shouldProcess = message.mentions.users.has(message.client.user.id);
      console.log('Should process:', shouldProcess);
@@ -153,7 +153,7 @@ This guide covers common issues you might encounter when working with CommandKit
    ```ts
    const userCooldowns = new Map<string, number>();
 
-   messageFilter: async (message) => {
+   messageFilter: async (commandkit, message) => {
      const userId = message.author.id;
      const now = Date.now();
      const cooldown = userCooldowns.get(userId) || 0;
@@ -368,7 +368,7 @@ export const ai: AiCommand<typeof aiConfig> = async (ctx) => {
 ### Channel Access Issues
 
 ```ts
-messageFilter: async (message) => {
+messageFilter: async (commandkit, message) => {
   // Check if bot can send messages in the channel
   if (!message.channel.isSendable()) {
     console.log('Cannot send messages in channel:', message.channelId);

packages/ai/src/configure.ts

@@ -65,8 +65,21 @@ export interface ConfigureAI {
 
 const AIConfig: Required<ConfigureAI> = {
   disableBuiltInTools: false,
-  messageFilter: async (message) =>
-    message.mentions.users.has(message.client.user.id),
+  messageFilter: async (commandkit, message) => {
+    const prefixOrPrefixes =
+      await commandkit.config.getMessageCommandPrefix(message);
+
+    const prefixes = Array.isArray(prefixOrPrefixes)
+      ? prefixOrPrefixes
+      : [prefixOrPrefixes];
+
+    const possiblyCommand = prefixes.some((p) => message.content.startsWith(p));
+
+    // TODO: figure out a workaround for mention prefixes
+    return (
+      !possiblyCommand && message.mentions.users.has(message.client.user.id)
+    );
+  },
   prepareSystemPrompt: async (_ctx, message) => createSystemPrompt(message),
   preparePrompt: async (_ctx, message) => {
     const recentMessages = await message.channel.messages.fetch({

packages/ai/src/plugin.ts

@@ -85,7 +85,9 @@ export class AiPlugin extends RuntimePlugin<AiPluginOptions> {
 
     if (!message.channel.isTextBased() || !message.channel.isSendable()) return;
 
-    const shouldContinue = messageFilter ? await messageFilter(message) : true;
+    const shouldContinue = messageFilter
+      ? await messageFilter(commandkit, message)
+      : true;
     if (!shouldContinue) return;
 
     const ctx = new AiContext<any>({

packages/ai/src/types.ts

@@ -1,7 +1,7 @@
 import { Tool, type generateText } from 'ai';
 import { Message } from 'discord.js';
 import { AiContext } from './context';
-import { LoadedCommand, MessageCommandContext } from 'commandkit';
+import CommandKit, { LoadedCommand, MessageCommandContext } from 'commandkit';
 import { AiConfig } from './plugin';
 import { InferParameters } from './tools/common';
 
@@ -10,19 +10,15 @@ import { InferParameters } from './tools/common';
  */
 export type AIGenerateResult = Awaited<ReturnType<typeof generateText>>;
 
-/**
- * Function type for filtering commands based on their name.
- * @param commandName - The name of the command to filter.
- * @returns A boolean indicating whether the command should be included in the filter.
- */
-export type CommandFilterFunction = (commandName: string) => boolean;
-
 /**
  * Function type for filtering messages before they are processed by the AI.
  * @param message - The message to filter.
  * @returns A promise that resolves to a boolean indicating whether the message should be processed.
  */
-export type MessageFilter = (message: Message) => Promise<boolean>;
+export type MessageFilter = (
+  commandkit: CommandKit,
+  message: Message,
+) => Promise<boolean>;
 
 /**
  * Function type for selecting an AI model based on the message.