@commandkit/ai 0.1.0-dev.20250611020404 → 0.1.0-dev.20250611155146

package/dist/ai-context-worker.d.ts

@@ -1,7 +1,13 @@
 import { Message } from 'discord.js';
 import { AiContext } from './context';
+/**
+ * @private
+ */
 export declare function getAiWorkerContext(): {
     message: Message;
     ctx: AiContext;
 };
+/**
+ * @private
+ */
 export declare function runInAiWorkerContext<R, F extends (...args: any[]) => R>(ctx: AiContext, message: Message, callback: F): R;

package/dist/ai-context-worker.js

@@ -4,6 +4,9 @@ exports.getAiWorkerContext = getAiWorkerContext;
 exports.runInAiWorkerContext = runInAiWorkerContext;
 const node_async_hooks_1 = require("node:async_hooks");
 const worker = new node_async_hooks_1.AsyncLocalStorage();
+/**
+ * @private
+ */
 function getAiWorkerContext() {
     const ctx = worker.getStore();
     if (!ctx) {
@@ -11,7 +14,10 @@ function getAiWorkerContext() {
     }
     return ctx;
 }
+/**
+ * @private
+ */
 function runInAiWorkerContext(ctx, message, callback) {
     return worker.run({ message, ctx }, callback);
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWktY29udGV4dC13b3JrZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvYWktY29udGV4dC13b3JrZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFNQSxnREFVQztBQUVELG9EQU1DO0FBdkJELHVEQUFxRDtBQUdyRCxNQUFNLE1BQU0sR0FBRyxJQUFJLG9DQUFpQixFQUF3QyxDQUFDO0FBRTdFLFNBQWdCLGtCQUFrQjtJQUNoQyxNQUFNLEdBQUcsR0FBRyxNQUFNLENBQUMsUUFBUSxFQUFFLENBQUM7SUFFOUIsSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFDO1FBQ1QsTUFBTSxJQUFJLEtBQUssQ0FDYixtRkFBbUYsQ0FDcEYsQ0FBQztJQUNKLENBQUM7SUFFRCxPQUFPLEdBQUcsQ0FBQztBQUNiLENBQUM7QUFFRCxTQUFnQixvQkFBb0IsQ0FDbEMsR0FBYyxFQUNkLE9BQWdCLEVBQ2hCLFFBQVc7SUFFWCxPQUFPLE1BQU0sQ0FBQyxHQUFHLENBQUMsRUFBRSxPQUFPLEVBQUUsR0FBRyxFQUFFLEVBQUUsUUFBUSxDQUFDLENBQUM7QUFDaEQsQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWktY29udGV4dC13b3JrZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvYWktY29udGV4dC13b3JrZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFTQSxnREFVQztBQUtELG9EQU1DO0FBN0JELHVEQUFxRDtBQUdyRCxNQUFNLE1BQU0sR0FBRyxJQUFJLG9DQUFpQixFQUF3QyxDQUFDO0FBRTdFOztHQUVHO0FBQ0gsU0FBZ0Isa0JBQWtCO0lBQ2hDLE1BQU0sR0FBRyxHQUFHLE1BQU0sQ0FBQyxRQUFRLEVBQUUsQ0FBQztJQUU5QixJQUFJLENBQUMsR0FBRyxFQUFFLENBQUM7UUFDVCxNQUFNLElBQUksS0FBSyxDQUNiLG1GQUFtRixDQUNwRixDQUFDO0lBQ0osQ0FBQztJQUVELE9BQU8sR0FBRyxDQUFDO0FBQ2IsQ0FBQztBQUVEOztHQUVHO0FBQ0gsU0FBZ0Isb0JBQW9CLENBQ2xDLEdBQWMsRUFDZCxPQUFnQixFQUNoQixRQUFXO0lBRVgsT0FBTyxNQUFNLENBQUMsR0FBRyxDQUFDLEVBQUUsT0FBTyxFQUFFLEdBQUcsRUFBRSxFQUFFLFFBQVEsQ0FBQyxDQUFDO0FBQ2hELENBQUMifQ==

package/dist/augmentation.d.ts

@@ -0,0 +1,17 @@
+import { AiContext } from './context';
+import { Awaitable } from 'discord.js';
+import { AiConfig } from './plugin';
+declare module 'commandkit' {
+    interface CustomAppCommandProps {
+        ai?: (ctx: AiContext) => Awaitable<unknown>;
+        aiConfig?: AiConfig;
+    }
+    interface Context {
+        ai?: AiContext;
+    }
+}
+/**
+ * @private
+ * @internal
+ */
+export declare function augmentCommandKit(isAdd: boolean): void;

package/dist/augmentation.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.augmentCommandKit = augmentCommandKit;
+const commandkit_1 = require("commandkit");
+const ai_context_worker_1 = require("./ai-context-worker");
+/**
+ * @private
+ * @internal
+ */
+function augmentCommandKit(isAdd) {
+    if (isAdd) {
+        if (!Object.prototype.hasOwnProperty.call(commandkit_1.Context.prototype, 'ai')) {
+            Object.defineProperty(commandkit_1.Context.prototype, 'ai', {
+                get() {
+                    try {
+                        const { ctx } = (0, ai_context_worker_1.getAiWorkerContext)();
+                        return ctx;
+                    }
+                    catch {
+                        // no-op if not in AI worker context
+                    }
+                },
+            });
+        }
+    }
+    else {
+        if (Object.prototype.hasOwnProperty.call(commandkit_1.Context.prototype, 'ai')) {
+            delete commandkit_1.Context.prototype.ai;
+        }
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXVnbWVudGF0aW9uLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2F1Z21lbnRhdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQXFCQSw4Q0FtQkM7QUFyQ0QsMkNBQXFDO0FBQ3JDLDJEQUF5RDtBQWF6RDs7O0dBR0c7QUFDSCxTQUFnQixpQkFBaUIsQ0FBQyxLQUFjO0lBQzlDLElBQUksS0FBSyxFQUFFLENBQUM7UUFDVixJQUFJLENBQUMsTUFBTSxDQUFDLFNBQVMsQ0FBQyxjQUFjLENBQUMsSUFBSSxDQUFDLG9CQUFPLENBQUMsU0FBUyxFQUFFLElBQUksQ0FBQyxFQUFFLENBQUM7WUFDbkUsTUFBTSxDQUFDLGNBQWMsQ0FBQyxvQkFBTyxDQUFDLFNBQVMsRUFBRSxJQUFJLEVBQUU7Z0JBQzdDLEdBQUc7b0JBQ0QsSUFBSSxDQUFDO3dCQUNILE1BQU0sRUFBRSxHQUFHLEVBQUUsR0FBRyxJQUFBLHNDQUFrQixHQUFFLENBQUM7d0JBQ3JDLE9BQU8sR0FBRyxDQUFDO29CQUNiLENBQUM7b0JBQUMsTUFBTSxDQUFDO3dCQUNQLG9DQUFvQztvQkFDdEMsQ0FBQztnQkFDSCxDQUFDO2FBQ0YsQ0FBQyxDQUFDO1FBQ0wsQ0FBQztJQUNILENBQUM7U0FBTSxDQUFDO1FBQ04sSUFBSSxNQUFNLENBQUMsU0FBUyxDQUFDLGNBQWMsQ0FBQyxJQUFJLENBQUMsb0JBQU8sQ0FBQyxTQUFTLEVBQUUsSUFBSSxDQUFDLEVBQUUsQ0FBQztZQUNsRSxPQUFPLG9CQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQztRQUM5QixDQUFDO0lBQ0gsQ0FBQztBQUNILENBQUMifQ==

package/dist/configure.d.ts

@@ -0,0 +1,58 @@
+import { Message } from 'discord.js';
+import { AIGenerateResult, MessageFilter, SelectAiModel } from './types';
+import { AiContext } from './context';
+/**
+ * Represents the configuration options for the AI model.
+ */
+export interface ConfigureAI {
+    /**
+     * Whether to disable the built-in tools. Default is false.
+     */
+    disableBuiltInTools?: boolean;
+    /**
+     * A filter function that determines whether a message should be processed by the AI.
+     * CommandKit invokes this function before processing the message.
+     */
+    messageFilter?: MessageFilter;
+    /**
+     * 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.
+     */
+    selectAiModel: SelectAiModel;
+    /**
+     * 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.
+     */
+    prepareSystemPrompt?: (ctx: AiContext, message: Message) => Promise<string>;
+    /**
+     * A function that prepares the prompt for the AI model.
+     */
+    preparePrompt?: (ctx: AiContext, message: Message) => Promise<string>;
+    /**
+     * A function that gets called when the AI starts processing a message.
+     */
+    onProcessingStart?: (ctx: AiContext, message: Message) => Promise<void>;
+    /**
+     * A function that gets called when the AI finishes processing a message.
+     */
+    onProcessingFinish?: (ctx: AiContext, message: Message) => Promise<void>;
+    /**
+     * A function that gets called upon receiving the result from the AI model.
+     */
+    onResult?: (ctx: AiContext, message: Message, result: AIGenerateResult) => Promise<void>;
+    /**
+     * A function that gets called when error occurs.
+     */
+    onError?: (ctx: AiContext, message: Message, error: Error) => Promise<void>;
+}
+/**
+ * Retrieves the current AI configuration.
+ */
+export declare function getAIConfig(): Required<ConfigureAI>;
+/**
+ * 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.
+ * @param config The configuration options for the AI plugin.
+ */
+export declare function configureAI(config: ConfigureAI): void;

package/dist/configure.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAIConfig = getAIConfig;
+exports.configureAI = configureAI;
+const system_prompt_1 = require("./system-prompt");
+const utils_1 = require("./utils");
+const commandkit_1 = require("commandkit");
+const CKIT_INTERNAL_STOP_TYPING = '<<{{[[((ckitInternalStopTyping))]]}}>>';
+const AIConfig = {
+    disableBuiltInTools: false,
+    messageFilter: async (message) => message.mentions.users.has(message.client.user.id),
+    prepareSystemPrompt: async (_ctx, message) => (0, system_prompt_1.createSystemPrompt)(message),
+    async preparePrompt(_ctx, message) {
+        const userInfo = `<user>
+    <id>${message.author.id}</id>
+    <name>${message.author.username}</name>
+    <displayName>${message.author.displayName}</displayName>
+    <avatar>${message.author.avatarURL()}</avatar>
+    </user>`;
+        return `${userInfo}\nUser: ${message.content}\nAI:`;
+    },
+    selectAiModel: async () => {
+        throw new Error('No AI model selected. Please configure the AI plugin using configureAI() function, making sure to include a selectAiModel function.');
+    },
+    onProcessingStart: async (ctx, message) => {
+        const channel = message.channel;
+        const stop = await (0, utils_1.createTypingIndicator)(channel);
+        ctx.store.set(CKIT_INTERNAL_STOP_TYPING, stop);
+    },
+    onProcessingFinish: async (ctx) => {
+        const stop = ctx.store.get(CKIT_INTERNAL_STOP_TYPING);
+        if (stop) {
+            stop();
+            ctx.store.delete(CKIT_INTERNAL_STOP_TYPING);
+        }
+    },
+    onResult: async (_ctx, message, result) => {
+        if (!!result.text) {
+            await message.reply({
+                content: result.text.substring(0, 2000),
+                allowedMentions: { parse: [] },
+            });
+        }
+    },
+    onError: async (_ctx, message, error) => {
+        commandkit_1.Logger.error(`Error processing AI message: ${error}`);
+        const channel = message.channel;
+        if (channel.isSendable()) {
+            await message
+                .reply({
+                content: 'An error occurred while processing your request.',
+                allowedMentions: { parse: [] },
+            })
+                .catch((e) => commandkit_1.Logger.error(`Failed to send error message: ${e}`));
+        }
+    },
+};
+/**
+ * Retrieves the current AI configuration.
+ */
+function getAIConfig() {
+    return AIConfig;
+}
+/**
+ * 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.
+ * @param config The configuration options for the AI plugin.
+ */
+function configureAI(config) {
+    if (config.messageFilter) {
+        AIConfig.messageFilter = config.messageFilter;
+    }
+    if (config.selectAiModel) {
+        AIConfig.selectAiModel = config.selectAiModel;
+    }
+    if (config.prepareSystemPrompt) {
+        AIConfig.prepareSystemPrompt = config.prepareSystemPrompt;
+    }
+    if (config.preparePrompt) {
+        AIConfig.preparePrompt = config.preparePrompt;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlndXJlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NvbmZpZ3VyZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQXNIQSxrQ0FFQztBQU9ELGtDQWdCQztBQTdJRCxtREFBcUQ7QUFDckQsbUNBQWdEO0FBRWhELDJDQUFvQztBQUVwQyxNQUFNLHlCQUF5QixHQUFHLHdDQUF3QyxDQUFDO0FBb0QzRSxNQUFNLFFBQVEsR0FBMEI7SUFDdEMsbUJBQW1CLEVBQUUsS0FBSztJQUMxQixhQUFhLEVBQUUsS0FBSyxFQUFFLE9BQU8sRUFBRSxFQUFFLENBQy9CLE9BQU8sQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUM7SUFDcEQsbUJBQW1CLEVBQUUsS0FBSyxFQUFFLElBQUksRUFBRSxPQUFPLEVBQUUsRUFBRSxDQUFDLElBQUEsa0NBQWtCLEVBQUMsT0FBTyxDQUFDO0lBQ3pFLEtBQUssQ0FBQyxhQUFhLENBQUMsSUFBSSxFQUFFLE9BQU87UUFDL0IsTUFBTSxRQUFRLEdBQUc7VUFDWCxPQUFPLENBQUMsTUFBTSxDQUFDLEVBQUU7WUFDZixPQUFPLENBQUMsTUFBTSxDQUFDLFFBQVE7bUJBQ2hCLE9BQU8sQ0FBQyxNQUFNLENBQUMsV0FBVztjQUMvQixPQUFPLENBQUMsTUFBTSxDQUFDLFNBQVMsRUFBRTtZQUM1QixDQUFDO1FBRVQsT0FBTyxHQUFHLFFBQVEsV0FBVyxPQUFPLENBQUMsT0FBTyxPQUFPLENBQUM7SUFDdEQsQ0FBQztJQUNELGFBQWEsRUFBRSxLQUFLLElBQUksRUFBRTtRQUN4QixNQUFNLElBQUksS0FBSyxDQUNiLHFJQUFxSSxDQUN0SSxDQUFDO0lBQ0osQ0FBQztJQUNELGlCQUFpQixFQUFFLEtBQUssRUFBRSxHQUFHLEVBQUUsT0FBTyxFQUFFLEVBQUU7UUFDeEMsTUFBTSxPQUFPLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQztRQUNoQyxNQUFNLElBQUksR0FBRyxNQUFNLElBQUEsNkJBQXFCLEVBQUMsT0FBTyxDQUFDLENBQUM7UUFDbEQsR0FBRyxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMseUJBQXlCLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDakQsQ0FBQztJQUNELGtCQUFrQixFQUFFLEtBQUssRUFBRSxHQUFHLEVBQUUsRUFBRTtRQUNoQyxNQUFNLElBQUksR0FBRyxHQUFHLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyx5QkFBeUIsQ0FBQyxDQUFDO1FBRXRELElBQUksSUFBSSxFQUFFLENBQUM7WUFDVCxJQUFJLEVBQUUsQ0FBQztZQUNQLEdBQUcsQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLHlCQUF5QixDQUFDLENBQUM7UUFDOUMsQ0FBQztJQUNILENBQUM7SUFDRCxRQUFRLEVBQUUsS0FBSyxFQUFFLElBQUksRUFBRSxPQUFPLEVBQUUsTUFBTSxFQUFFLEVBQUU7UUFDeEMsSUFBSSxDQUFDLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRSxDQUFDO1lBQ2xCLE1BQU0sT0FBTyxDQUFDLEtBQUssQ0FBQztnQkFDbEIsT0FBTyxFQUFFLE1BQU0sQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLENBQUMsRUFBRSxJQUFJLENBQUM7Z0JBQ3ZDLGVBQWUsRUFBRSxFQUFFLEtBQUssRUFBRSxFQUFFLEVBQUU7YUFDL0IsQ0FBQyxDQUFDO1FBQ0wsQ0FBQztJQUNILENBQUM7SUFDRCxPQUFPLEVBQUUsS0FBSyxFQUFFLElBQUksRUFBRSxPQUFPLEVBQUUsS0FBSyxFQUFFLEVBQUU7UUFDdEMsbUJBQU0sQ0FBQyxLQUFLLENBQUMsZ0NBQWdDLEtBQUssRUFBRSxDQUFDLENBQUM7UUFDdEQsTUFBTSxPQUFPLEdBQUcsT0FBTyxDQUFDLE9BQXNCLENBQUM7UUFFL0MsSUFBSSxPQUFPLENBQUMsVUFBVSxFQUFFLEVBQUUsQ0FBQztZQUN6QixNQUFNLE9BQU87aUJBQ1YsS0FBSyxDQUFDO2dCQUNMLE9BQU8sRUFBRSxrREFBa0Q7Z0JBQzNELGVBQWUsRUFBRSxFQUFFLEtBQUssRUFBRSxFQUFFLEVBQUU7YUFDL0IsQ0FBQztpQkFDRCxLQUFLLENBQUMsQ0FBQyxDQUFDLEVBQUUsRUFBRSxDQUFDLG1CQUFNLENBQUMsS0FBSyxDQUFDLGlDQUFpQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUM7UUFDdEUsQ0FBQztJQUNILENBQUM7Q0FDRixDQUFDO0FBRUY7O0dBRUc7QUFDSCxTQUFnQixXQUFXO0lBQ3pCLE9BQU8sUUFBUSxDQUFDO0FBQ2xCLENBQUM7QUFFRDs7OztHQUlHO0FBQ0gsU0FBZ0IsV0FBVyxDQUFDLE1BQW1CO0lBQzdDLElBQUksTUFBTSxDQUFDLGFBQWEsRUFBRSxDQUFDO1FBQ3pCLFFBQVEsQ0FBQyxhQUFhLEdBQUcsTUFBTSxDQUFDLGFBQWEsQ0FBQztJQUNoRCxDQUFDO0lBRUQsSUFBSSxNQUFNLENBQUMsYUFBYSxFQUFFLENBQUM7UUFDekIsUUFBUSxDQUFDLGFBQWEsR0FBRyxNQUFNLENBQUMsYUFBYSxDQUFDO0lBQ2hELENBQUM7SUFFRCxJQUFJLE1BQU0sQ0FBQyxtQkFBbUIsRUFBRSxDQUFDO1FBQy9CLFFBQVEsQ0FBQyxtQkFBbUIsR0FBRyxNQUFNLENBQUMsbUJBQW1CLENBQUM7SUFDNUQsQ0FBQztJQUVELElBQUksTUFBTSxDQUFDLGFBQWEsRUFBRSxDQUFDO1FBQ3pCLFFBQVEsQ0FBQyxhQUFhLEdBQUcsTUFBTSxDQUFDLGFBQWEsQ0FBQztJQUNoRCxDQUFDO0FBQ0gsQ0FBQyJ9

package/dist/context.d.ts

@@ -1,15 +1,56 @@
 import type { CommandKit } from 'commandkit';
 import { Client, Message } from 'discord.js';
+/**
+ * Options for the AI context.
+ */
 export interface AiContextOptions<T extends Record<string, unknown> = Record<string, unknown>> {
+    /**
+     * The message that triggered the AI command.
+     */
     message: Message;
+    /**
+     * The parameters passed to the AI command.
+     */
     params: T;
+    /**
+     * The CommandKit instance associated with the AI command.
+     */
     commandkit: CommandKit;
 }
+/**
+ * Represents the context in which an AI command is executed.
+ * This includes the parameters passed to the command, the message that triggered it,
+ * and the CommandKit instance associated with the command.
+ */
 export declare class AiContext<T extends Record<string, unknown> = Record<string, unknown>> {
+    /**
+     * The parameters passed to the AI command.
+     */
     params: T;
+    /**
+     * The message that triggered the AI command.
+     */
     message: Message;
+    /**
+     * The client instance associated with the AI command.
+     */
     client: Client;
+    /**
+     * The CommandKit instance associated with the AI command.
+     */
     commandkit: CommandKit;
+    /**
+     * A key-value store to hold additional data.
+     */
+    store: Map<string, any>;
+    /**
+     * Creates a new instance of AiContext.
+     * @param options - The options for the AI context, including the message, parameters, and CommandKit instance.
+     */
     constructor(options: AiContextOptions<T>);
+    /**
+     * Sets the parameters for the AI context.
+     * @param params - The parameters to set.
+     */
     setParams(params: T): void;
 }

package/dist/context.js

@@ -1,16 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AiContext = void 0;
+/**
+ * Represents the context in which an AI command is executed.
+ * This includes the parameters passed to the command, the message that triggered it,
+ * and the CommandKit instance associated with the command.
+ */
 class AiContext {
+    /**
+     * Creates a new instance of AiContext.
+     * @param options - The options for the AI context, including the message, parameters, and CommandKit instance.
+     */
     constructor(options) {
+        /**
+         * A key-value store to hold additional data.
+         */
+        this.store = new Map();
         this.params = options.params;
         this.message = options.message;
         this.commandkit = options.commandkit;
         this.client = options.commandkit.client;
     }
+    /**
+     * Sets the parameters for the AI context.
+     * @param params - The parameters to set.
+     */
     setParams(params) {
         this.params = params;
     }
 }
 exports.AiContext = AiContext;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9jb250ZXh0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQVdBLE1BQWEsU0FBUztJQVFwQixZQUFtQixPQUE0QjtRQUM3QyxJQUFJLENBQUMsTUFBTSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUM7UUFDN0IsSUFBSSxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDO1FBQy9CLElBQUksQ0FBQyxVQUFVLEdBQUcsT0FBTyxDQUFDLFVBQVUsQ0FBQztRQUNyQyxJQUFJLENBQUMsTUFBTSxHQUFHLE9BQU8sQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDO0lBQzFDLENBQUM7SUFFTSxTQUFTLENBQUMsTUFBUztRQUN4QixJQUFJLENBQUMsTUFBTSxHQUFHLE1BQU0sQ0FBQztJQUN2QixDQUFDO0NBQ0Y7QUFsQkQsOEJBa0JDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9jb250ZXh0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQXVCQTs7OztHQUlHO0FBQ0gsTUFBYSxTQUFTO0lBd0JwQjs7O09BR0c7SUFDSCxZQUFtQixPQUE0QjtRQVQvQzs7V0FFRztRQUNJLFVBQUssR0FBRyxJQUFJLEdBQUcsRUFBZSxDQUFDO1FBT3BDLElBQUksQ0FBQyxNQUFNLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQztRQUM3QixJQUFJLENBQUMsT0FBTyxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUM7UUFDL0IsSUFBSSxDQUFDLFVBQVUsR0FBRyxPQUFPLENBQUMsVUFBVSxDQUFDO1FBQ3JDLElBQUksQ0FBQyxNQUFNLEdBQUcsT0FBTyxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUM7SUFDMUMsQ0FBQztJQUVEOzs7T0FHRztJQUNJLFNBQVMsQ0FBQyxNQUFTO1FBQ3hCLElBQUksQ0FBQyxNQUFNLEdBQUcsTUFBTSxDQUFDO0lBQ3ZCLENBQUM7Q0FDRjtBQTFDRCw4QkEwQ0MifQ==

package/dist/index.d.ts

@@ -1,6 +1,24 @@
+import './augmentation';
 import { AiPlugin } from './plugin';
 import { AiPluginOptions } from './types';
+/**
+ * Retrieves the AI context.
+ */
+export declare function useAIContext(): import("./context").AiContext<Record<string, unknown>>;
+/**
+ * Fetches the AI plugin instance.
+ */
+export declare function useAI(): AiPlugin;
+/**
+ * Defines the AI plugin for the application.
+ * @param options The options for the AI plugin
+ * @returns The AI plugin instance
+ */
 export declare function ai(options?: AiPluginOptions): AiPlugin;
 export * from './types';
 export * from './plugin';
 export * from './context';
+export * from './configure';
+export * from './types';
+export * from './system-prompt';
+export * from './tools/common/index';

package/dist/index.js

@@ -14,12 +14,44 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.useAIContext = useAIContext;
+exports.useAI = useAI;
 exports.ai = ai;
+require("./augmentation");
 const plugin_1 = require("./plugin");
+const ai_context_worker_1 = require("./ai-context-worker");
+const commandkit_1 = require("commandkit");
+/**
+ * Retrieves the AI context.
+ */
+function useAIContext() {
+    const { ctx } = (0, ai_context_worker_1.getAiWorkerContext)();
+    return ctx;
+}
+/**
+ * Fetches the AI plugin instance.
+ */
+function useAI() {
+    const commandkit = (0, commandkit_1.getCommandKit)(true);
+    const aiPlugin = commandkit.plugins.get(plugin_1.AiPlugin);
+    if (!aiPlugin) {
+        throw new Error('AI plugin is not registered. Please ensure it is activated.');
+    }
+    return aiPlugin;
+}
+/**
+ * Defines the AI plugin for the application.
+ * @param options The options for the AI plugin
+ * @returns The AI plugin instance
+ */
 function ai(options) {
     return new plugin_1.AiPlugin(options ?? {});
 }
 __exportStar(require("./types"), exports);
 __exportStar(require("./plugin"), exports);
 __exportStar(require("./context"), exports);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUdBLGdCQUVDO0FBTEQscUNBQW9DO0FBR3BDLFNBQWdCLEVBQUUsQ0FBQyxPQUF5QjtJQUMxQyxPQUFPLElBQUksaUJBQVEsQ0FBQyxPQUFPLElBQUksRUFBRSxDQUFDLENBQUM7QUFDckMsQ0FBQztBQUVELDBDQUF3QjtBQUN4QiwyQ0FBeUI7QUFDekIsNENBQTBCIn0=
+__exportStar(require("./configure"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./system-prompt"), exports);
+__exportStar(require("./tools/common/index"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQVNBLG9DQUdDO0FBS0Qsc0JBV0M7QUFPRCxnQkFFQztBQXJDRCwwQkFBd0I7QUFDeEIscUNBQW9DO0FBRXBDLDJEQUF5RDtBQUN6RCwyQ0FBMkM7QUFFM0M7O0dBRUc7QUFDSCxTQUFnQixZQUFZO0lBQzFCLE1BQU0sRUFBRSxHQUFHLEVBQUUsR0FBRyxJQUFBLHNDQUFrQixHQUFFLENBQUM7SUFDckMsT0FBTyxHQUFHLENBQUM7QUFDYixDQUFDO0FBRUQ7O0dBRUc7QUFDSCxTQUFnQixLQUFLO0lBQ25CLE1BQU0sVUFBVSxHQUFHLElBQUEsMEJBQWEsRUFBQyxJQUFJLENBQUMsQ0FBQztJQUN2QyxNQUFNLFFBQVEsR0FBRyxVQUFVLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxpQkFBUSxDQUFDLENBQUM7SUFFbEQsSUFBSSxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQ2QsTUFBTSxJQUFJLEtBQUssQ0FDYiw2REFBNkQsQ0FDOUQsQ0FBQztJQUNKLENBQUM7SUFFRCxPQUFPLFFBQVEsQ0FBQztBQUNsQixDQUFDO0FBRUQ7Ozs7R0FJRztBQUNILFNBQWdCLEVBQUUsQ0FBQyxPQUF5QjtJQUMxQyxPQUFPLElBQUksaUJBQVEsQ0FBQyxPQUFPLElBQUksRUFBRSxDQUFDLENBQUM7QUFDckMsQ0FBQztBQUVELDBDQUF3QjtBQUN4QiwyQ0FBeUI7QUFDekIsNENBQTBCO0FBQzFCLDhDQUE0QjtBQUM1QiwwQ0FBd0I7QUFDeEIsa0RBQWdDO0FBQ2hDLHVEQUFxQyJ9

package/dist/plugin.d.ts

@@ -1,16 +1,20 @@
 import { CommandKitPluginRuntime, RuntimePlugin } from 'commandkit/plugin';
-import { AiPluginOptions, MessageFilter, SelectAiModel } from './types';
+import { AiPluginOptions } from './types';
+import CommandKit from 'commandkit';
 import { Message } from 'discord.js';
+/**
+ * Represents the configuration options for the AI plugin scoped to a specific command.
+ */
 export interface AiConfig {
+    /**
+     * A description of the AI functionality provided by this command. If not given, the command's description will be used.
+     */
     description?: string;
+    /**
+     * A zod schema defining the parameters that the AI command accepts.
+     */
     parameters: any;
 }
-export interface ConfigureAI {
-    messageFilter?: MessageFilter;
-    selectAiModel?: SelectAiModel;
-    systemPrompt?: (message: Message) => Promise<string>;
-}
-export declare function configureAI(config: ConfigureAI): void;
 export declare class AiPlugin extends RuntimePlugin<AiPluginOptions> {
     readonly name = "AiPlugin";
     private toolsRecord;
@@ -18,10 +22,14 @@ export declare class AiPlugin extends RuntimePlugin<AiPluginOptions> {
     private onMessageFunc;
     constructor(options: AiPluginOptions);
     activate(ctx: CommandKitPluginRuntime): Promise<void>;
-    private createDefaultTools;
     deactivate(ctx: CommandKitPluginRuntime): Promise<void>;
     private handleMessage;
-    private startTyping;
-    onBeforeCommandsLoad(ctx: CommandKitPluginRuntime): Promise<void>;
+    /**
+     * Executes the AI for a given message.
+     * @param message The message to process.
+     * @param commandkit The CommandKit instance to use. If not provided, it will be inferred automatically.
+     */
+    executeAI(message: Message, commandkit?: CommandKit): Promise<void>;
+    onBeforeCommandsLoad(): Promise<void>;
     onAfterCommandsLoad(ctx: CommandKitPluginRuntime): Promise<void>;
 }