@convex-dev/agent 0.1.16-alpha.0 → 0.1.16-alpha.2

package/src/client/createTool.ts

@@ -2,9 +2,12 @@ import type { Schema, Tool, ToolExecutionOptions, ToolSet } from "ai";
 import { tool } from "ai";
 import { z } from "zod";
 import type { Agent } from "./index.js";
-import type { ActionCtx } from "./types.js";
+import type { GenericActionCtx, GenericDataModel } from "convex/server";
 
-export type ToolCtx<TOOLS extends ToolSet = ToolSet> = ActionCtx & {
+export type ToolCtx<
+  DataModel extends GenericDataModel = GenericDataModel,
+  TOOLS extends ToolSet = ToolSet,
+> = GenericActionCtx<DataModel> & {
   agent: Agent<TOOLS>;
   userId?: string;
   threadId?: string;
@@ -41,13 +44,13 @@ export function createTool<PARAMETERS extends ToolParameters, RESULT>(t: {
   handler: (
     ctx: ToolCtx,
     args: inferParameters<PARAMETERS>,
-    options: ToolExecutionOptions
+    options: ToolExecutionOptions,
   ) => PromiseLike<RESULT>;
   ctx?: ToolCtx;
 }): Tool<PARAMETERS, RESULT> & {
   execute: (
     args: inferParameters<PARAMETERS>,
-    options: ToolExecutionOptions
+    options: ToolExecutionOptions,
   ) => PromiseLike<RESULT>;
 } {
   const args = {
@@ -57,13 +60,13 @@ export function createTool<PARAMETERS extends ToolParameters, RESULT>(t: {
     parameters: t.args,
     async execute(
       args: inferParameters<PARAMETERS>,
-      options: ToolExecutionOptions
+      options: ToolExecutionOptions,
     ) {
       if (!this.ctx) {
         throw new Error(
           "To use a Convex tool, you must either provide the ctx" +
             " at definition time (dynamically in an action), or use the Agent to" +
-            " call it (which injects the ctx, userId and threadId)"
+            " call it (which injects the ctx, userId and threadId)",
         );
       }
       return t.handler(this.ctx, args, options);

package/src/client/files.ts

@@ -33,26 +33,26 @@ export async function storeFile(
   component: AgentComponent,
   blob: Blob,
   filename?: string,
-  sha256?: string
+  sha256?: string,
 ): Promise<{
   file: File;
   filePart: FilePart;
   imagePart: ImagePart | undefined;
 }> {
-  if (!("runAction" in ctx)) {
+  if (!("runAction" in ctx) || !("storage" in ctx)) {
     throw new Error(
-      "You're trying to save a file that's too large in a mutation. " +
+      "You're trying to save a file that's too large in a mutation / workflow. " +
         "You can store the file in file storage from an action first, then pass a URL instead. " +
         "To have the agent component track the file, you can use `saveFile` from an action then use the fileId with getFile in the mutation. " +
-        "Read more in the docs."
+        "Read more in the docs.",
     );
   }
   const hash =
     sha256 ||
     Array.from(
       new Uint8Array(
-        await crypto.subtle.digest("SHA-256", await blob.arrayBuffer())
-      )
+        await crypto.subtle.digest("SHA-256", await blob.arrayBuffer()),
+      ),
     )
       .map((b) => b.toString(16).padStart(2, "0"))
       .join("");
@@ -124,7 +124,7 @@ export async function storeFile(
 export async function getFile(
   ctx: ActionCtx | QueryCtx,
   component: AgentComponent,
-  fileId: string
+  fileId: string,
 ) {
   const file = await ctx.runQuery(component.files.get, { fileId });
   if (!file) {
@@ -149,7 +149,7 @@ export async function getFile(
 function getParts(
   url: string,
   mimeType: string,
-  filename: string | undefined
+  filename: string | undefined,
 ): {
   filePart: FilePart;
   imagePart: ImagePart | undefined;

package/src/client/index.test.ts

@@ -113,7 +113,7 @@ export const generateTextWithThread = action({
       {
         contextOptions: args.contextOptions,
         storageOptions: args.storageOptions,
-      }
+      },
     );
     return { text: result.text };
   },
@@ -313,7 +313,7 @@ describe("Agent thread management", () => {
   test("createThread returns threadId (mutation context)", async () => {
     const t = initConvexTest(schema);
     const threadId = await t.run(async (ctx) =>
-      agent.createThread(ctx, { userId: "2" }).then(({ threadId }) => threadId)
+      agent.createThread(ctx, { userId: "2" }).then(({ threadId }) => threadId),
     );
     expect(threadId).toBeTypeOf("string");
   });
@@ -321,7 +321,7 @@ describe("Agent thread management", () => {
   test("continueThread returns thread object", async () => {
     const t = initConvexTest(schema);
     const threadId = await t.run(async (ctx) =>
-      agent.createThread(ctx, { userId: "3" }).then(({ threadId }) => threadId)
+      agent.createThread(ctx, { userId: "3" }).then(({ threadId }) => threadId),
     );
     const result = await t.action(testApi.continueThreadAction, {
       threadId,
@@ -335,14 +335,14 @@ describe("Agent message operations", () => {
   test("saveMessage and saveMessages store messages", async () => {
     const t = initConvexTest(schema);
     const threadId = await t.run(async (ctx) =>
-      agent.createThread(ctx, { userId: "4" }).then(({ threadId }) => threadId)
+      agent.createThread(ctx, { userId: "4" }).then(({ threadId }) => threadId),
     );
     const { messageId } = await t.run(async (ctx) =>
       agent.saveMessage(ctx, {
         threadId,
         userId: "4",
         message: { role: "user", content: "Hello" },
-      })
+      }),
     );
     expect(messageId).toBeTypeOf("string");
 
@@ -354,7 +354,7 @@ describe("Agent message operations", () => {
           { role: "user", content: "Hi" },
           { role: "assistant", content: "Hello!" },
         ],
-      })
+      }),
     );
     expect(messages.length).toBe(2);
     expect(lastMessageId).toBe(messages[1]._id);
@@ -365,7 +365,7 @@ describe("Agent text/object generation", () => {
   test("generateText with custom context and storage options", async () => {
     const t = initConvexTest(schema);
     const threadId = await t.run(async (ctx) =>
-      agent.createThread(ctx, { userId: "5" }).then(({ threadId }) => threadId)
+      agent.createThread(ctx, { userId: "5" }).then(({ threadId }) => threadId),
     );
     const result = await t.action(testApi.generateTextWithThread, {
       threadId,
@@ -380,7 +380,7 @@ describe("Agent text/object generation", () => {
   test("generateObject returns object", async () => {
     const t = initConvexTest(schema);
     const threadId = await t.run(async (ctx) =>
-      agent.createThread(ctx, { userId: "6" }).then(({ threadId }) => threadId)
+      agent.createThread(ctx, { userId: "6" }).then(({ threadId }) => threadId),
     );
     const result = await t.action(testApi.generateObjectWithThread, {
       threadId,
@@ -402,7 +402,7 @@ describe("Agent-generated mutations/actions/queries", () => {
   test("asTextAction and asObjectAction work via t.action", async () => {
     const t = initConvexTest(schema);
     const threadId = await t.run(async (ctx) =>
-      agent.createThread(ctx, { userId: "8" }).then(({ threadId }) => threadId)
+      agent.createThread(ctx, { userId: "8" }).then(({ threadId }) => threadId),
     );
     const textResult = await t.action(testApi.generateTextAction, {
       userId: "8",
@@ -422,7 +422,7 @@ describe("Agent-generated mutations/actions/queries", () => {
   test("asSaveMessagesMutation works via t.mutation", async () => {
     const t = initConvexTest(schema);
     const threadId = await t.run(async (ctx) =>
-      agent.createThread(ctx, { userId: "9" }).then(({ threadId }) => threadId)
+      agent.createThread(ctx, { userId: "9" }).then(({ threadId }) => threadId),
     );
     const result = await t.mutation(testApi.saveMessageMutation, {
       threadId,
@@ -442,14 +442,16 @@ describe("Agent context and search options", () => {
   test("fetchContextMessages returns context messages", async () => {
     const t = initConvexTest(schema);
     const threadId = await t.run(async (ctx) =>
-      agent.createThread(ctx, { userId: "10" }).then(({ threadId }) => threadId)
+      agent
+        .createThread(ctx, { userId: "10" })
+        .then(({ threadId }) => threadId),
     );
     await t.run(async (ctx) =>
       agent.saveMessage(ctx, {
         threadId,
         userId: "10",
         message: { role: "user", content: "Context test" },
-      })
+      }),
     );
     const context = await t.action(testApi.fetchContextAction, {
       userId: "10",