@convex-dev/agent 0.1.18 → 0.2.0

package/src/validators.test.ts

@@ -1,108 +1,7 @@
-import type {
-  TextStreamPart as AITextStreamPart,
-  AssistantContent,
-  CoreAssistantMessage,
-  CoreMessage,
-  CoreSystemMessage,
-  CoreToolMessage,
-  CoreUserMessage,
-  FilePart,
-  ImagePart,
-  TextPart,
-  ToolCallPart,
-  ToolContent,
-  ToolSet,
-  UserContent,
-} from "ai";
 import type { Infer } from "convex/values";
 import { expectTypeOf, test } from "vitest";
 import type { ContextOptions, StorageOptions } from "./client/types.js";
-import type { SerializeUrlsAndUint8Arrays } from "./mapping.js";
-import type { TextStreamPart } from "./validators.js";
-import {
-  vAssistantContent,
-  vAssistantMessage,
-  vContextOptions,
-  vFilePart,
-  vImagePart,
-  vMessage,
-  vReasoningPart,
-  vRedactedReasoningPart,
-  vStorageOptions,
-  vSystemMessage,
-  vTextPart,
-  vToolCallPart,
-  vToolContent,
-  vToolMessage,
-  vUserContent,
-  vUserMessage,
-} from "./validators.js";
-
-// type assertion
-type OurUserContent = SerializeUrlsAndUint8Arrays<UserContent>;
-expectTypeOf<OurUserContent>().toExtend<Infer<typeof vUserContent>>();
-expectTypeOf<Infer<typeof vUserContent>>().toExtend<OurUserContent>();
-
-type OurAssistantContent = SerializeUrlsAndUint8Arrays<AssistantContent>;
-expectTypeOf<OurAssistantContent>().toExtend<Infer<typeof vAssistantContent>>();
-expectTypeOf<Infer<typeof vAssistantContent>>().toExtend<OurAssistantContent>();
-
-type OurToolContent = SerializeUrlsAndUint8Arrays<ToolContent>;
-expectTypeOf<OurToolContent>().toExtend<Infer<typeof vToolContent>>();
-expectTypeOf<Infer<typeof vToolContent>>().toExtend<OurToolContent>();
-
-expectTypeOf<Infer<typeof vToolCallPart>>().toExtend<ToolCallPart>();
-expectTypeOf<ToolCallPart>().toExtend<Infer<typeof vToolCallPart>>();
-
-type OurTextPart = SerializeUrlsAndUint8Arrays<TextPart>;
-expectTypeOf<OurTextPart>().toExtend<Infer<typeof vTextPart>>();
-expectTypeOf<Infer<typeof vTextPart>>().toExtend<OurTextPart>();
-
-type OurImagePart = SerializeUrlsAndUint8Arrays<ImagePart>;
-expectTypeOf<OurImagePart>().toExtend<Infer<typeof vImagePart>>();
-expectTypeOf<Infer<typeof vImagePart>>().toExtend<OurImagePart>();
-
-type OurFilePart = SerializeUrlsAndUint8Arrays<FilePart>;
-expectTypeOf<OurFilePart>().toExtend<Infer<typeof vFilePart>>();
-expectTypeOf<Infer<typeof vFilePart>>().toExtend<OurFilePart>();
-
-// narrow to the type
-type ReasoningPart = AssistantContent[number] & { type: "reasoning" } & object;
-type OurReasoningPart = SerializeUrlsAndUint8Arrays<ReasoningPart>;
-expectTypeOf<OurReasoningPart>().toExtend<Infer<typeof vReasoningPart>>();
-expectTypeOf<Infer<typeof vReasoningPart>>().toExtend<OurReasoningPart>();
-
-// narrow to the type
-type RedactedReasoningPart = AssistantContent[number] & {
-  type: "redacted-reasoning";
-} & object;
-type OurRedactedReasoningPart =
-  SerializeUrlsAndUint8Arrays<RedactedReasoningPart>;
-expectTypeOf<OurRedactedReasoningPart>().toExtend<
-  Infer<typeof vRedactedReasoningPart>
->();
-expectTypeOf<
-  Infer<typeof vRedactedReasoningPart>
->().toExtend<OurRedactedReasoningPart>();
-
-// test("noop", () => {
-type OurUserMessage = SerializeUrlsAndUint8Arrays<CoreUserMessage>;
-expectTypeOf<OurUserMessage>().toExtend<Infer<typeof vUserMessage>>();
-expectTypeOf<Infer<typeof vUserMessage>>().toExtend<OurUserMessage>();
-
-type OurAssistantMessage = SerializeUrlsAndUint8Arrays<CoreAssistantMessage>;
-expectTypeOf<OurAssistantMessage>().toExtend<Infer<typeof vAssistantMessage>>();
-expectTypeOf<Infer<typeof vAssistantMessage>>().toExtend<OurAssistantMessage>();
-
-expectTypeOf<Infer<typeof vToolMessage>>().toExtend<CoreToolMessage>();
-expectTypeOf<CoreToolMessage>().toExtend<Infer<typeof vToolMessage>>();
-
-expectTypeOf<Infer<typeof vSystemMessage>>().toExtend<CoreSystemMessage>();
-expectTypeOf<CoreSystemMessage>().toExtend<Infer<typeof vSystemMessage>>();
-
-type OurMessage = SerializeUrlsAndUint8Arrays<CoreMessage>;
-expectTypeOf<OurMessage>().toExtend<Infer<typeof vMessage>>();
-expectTypeOf<Infer<typeof vMessage>>().toExtend<OurMessage>();
+import { vContextOptions, vStorageOptions } from "./validators.js";
 
 expectTypeOf<Infer<typeof vContextOptions>>().toExtend<ContextOptions>();
 expectTypeOf<ContextOptions>().toExtend<Infer<typeof vContextOptions>>();
@@ -110,19 +9,4 @@ expectTypeOf<ContextOptions>().toExtend<Infer<typeof vContextOptions>>();
 expectTypeOf<Infer<typeof vStorageOptions>>().toExtend<StorageOptions>();
 expectTypeOf<StorageOptions>().toExtend<Infer<typeof vStorageOptions>>();
 
-type StreamPart = Extract<
-  AITextStreamPart<ToolSet>,
-  {
-    type:
-      | "text-delta"
-      | "reasoning"
-      | "source"
-      | "tool-call"
-      | "tool-call-streaming-start"
-      | "tool-call-delta"
-      | "tool-result";
-  }
->;
-expectTypeOf<StreamPart>().toExtend<TextStreamPart>();
-
 test("noop", () => {});

package/src/validators.ts

@@ -1,10 +1,4 @@
-import {
-  v,
-  type Infer,
-  type ObjectType,
-  type Validator,
-  type Value,
-} from "convex/values";
+import { v, type Infer, type Validator, type Value } from "convex/values";
 import { vVectorDimension } from "./component/vector/tables.js";
 
 // const deprecated = v.optional(v.any()) as unknown as VNull<unknown, "optional">;
@@ -69,6 +63,7 @@ export const vReasoningPart = v.object({
   text: v.string(),
   signature: v.optional(v.string()),
   providerOptions,
+  state: v.optional(v.union(v.literal("streaming"), v.literal("done"))),
 });
 
 export const vRedactedReasoningPart = v.object({
@@ -79,6 +74,7 @@ export const vRedactedReasoningPart = v.object({
 
 export const vReasoningDetails = v.array(
   v.union(
+    vReasoningPart,
     v.object({
       type: v.literal("text"),
       text: v.string(),
@@ -97,6 +93,7 @@ export const vToolCallPart = v.object({
   toolName: v.string(),
   args: v.any(),
   providerOptions,
+  providerExecuted: v.optional(v.boolean()),
 });
 
 export const vAssistantContent = v.union(
@@ -126,17 +123,20 @@ const vToolResultContent = v.array(
   ),
 );
 
-const vToolResultPart = v.object({
+export const vToolResultPart = v.object({
   type: v.literal("tool-result"),
   toolCallId: v.string(),
   toolName: v.string(),
   result: v.any(),
+  providerOptions,
+  providerExecuted: v.optional(v.boolean()),
+
+  // Deprecated in ai v5
+  isError: v.optional(v.boolean()),
   // This is only here b/c steps include it in toolResults
-  // Normal CoreMessage doesn't have this
+  // Normal ModelMessage doesn't have this
   args: v.optional(v.any()),
   experimental_content: v.optional(vToolResultContent),
-  isError: v.optional(v.boolean()),
-  providerOptions,
 });
 export const vToolContent = v.array(vToolResultPart);
 
@@ -175,13 +175,25 @@ export const vMessage = v.union(
 );
 export type Message = Infer<typeof vMessage>;
 
-export const vSource = v.object({
-  sourceType: v.literal("url"),
-  id: v.string(),
-  url: v.string(),
-  title: v.optional(v.string()),
-  providerOptions,
-});
+export const vSource = v.union(
+  v.object({
+    type: v.optional(v.literal("source")),
+    sourceType: v.literal("url"),
+    id: v.string(),
+    url: v.string(),
+    title: v.optional(v.string()),
+    providerOptions,
+  }),
+  v.object({
+    type: v.literal("source"),
+    sourceType: v.literal("document"),
+    id: v.string(),
+    mediaType: v.string(),
+    title: v.string(),
+    filename: v.optional(v.string()),
+    providerMetadata,
+  }),
+);
 
 export const vRequest = v.object({
   body: v.optional(v.any()),
@@ -191,29 +203,6 @@ export const vRequest = v.object({
   url: v.optional(v.string()),
 });
 
-const vMessageWithFileAndId = v.object({
-  id: v.optional(v.string()),
-  message: vMessage,
-  fileId: v.optional(v.id("files")),
-});
-
-export const vResponse = v.object({
-  id: v.string(),
-  timestamp: v.number(),
-  modelId: v.string(),
-  headers: v.optional(v.record(v.string(), v.string())), // clear these?
-  messages: v.array(vMessageWithFileAndId),
-  body: v.optional(v.any()),
-});
-
-export const vResponseWithoutMessages = v.object({
-  id: v.string(),
-  timestamp: v.number(),
-  modelId: v.string(),
-  headers: v.optional(v.record(v.string(), v.string())), // clear these?
-  body: v.optional(v.any()),
-});
-
 export const vFinishReason = v.union(
   v.literal("stop"),
   v.literal("length"),
@@ -228,10 +217,12 @@ export const vUsage = v.object({
   promptTokens: v.number(),
   completionTokens: v.number(),
   totalTokens: v.number(),
+  reasoningTokens: v.optional(v.number()),
+  cachedInputTokens: v.optional(v.number()),
 });
 export type Usage = Infer<typeof vUsage>;
 
-export const vLanguageModelV1CallWarning = v.union(
+export const vLanguageModelCallWarning = v.union(
   v.object({
     type: v.literal("unsupported-setting"),
     setting: v.string(),
@@ -242,17 +233,14 @@ export const vLanguageModelV1CallWarning = v.union(
     tool: v.any(),
     details: v.optional(v.string()),
   }),
-  v.object({
-    type: v.literal("other"),
-    message: v.string(),
-  }),
+  v.object({ type: v.literal("other"), message: v.string() }),
 );
 
 export const vMessageWithMetadataInternal = v.object({
-  id: v.optional(v.string()), // external id, e.g. from Vercel AI SDK
   message: vMessage,
   text: v.optional(v.string()),
   fileIds: v.optional(v.array(v.id("files"))),
+  status: v.optional(vMessageStatus),
   // metadata
   finishReason: v.optional(vFinishReason),
   model: v.optional(v.string()),
@@ -262,33 +250,32 @@ export const vMessageWithMetadataInternal = v.object({
   reasoning: v.optional(v.string()),
   reasoningDetails: v.optional(vReasoningDetails),
   usage: v.optional(vUsage),
-  warnings: v.optional(v.array(vLanguageModelV1CallWarning)),
+  warnings: v.optional(v.array(vLanguageModelCallWarning)),
   error: v.optional(v.string()),
 });
+export type MessageWithMetadataInternal = Infer<
+  typeof vMessageWithMetadataInternal
+>;
 export const vMessageWithMetadata = v.object({
   ...vMessageWithMetadataInternal.fields,
   fileIds: v.optional(v.array(v.string())),
 });
 export type MessageWithMetadata = Infer<typeof vMessageWithMetadata>;
 
-export const vMessageEmbeddings = v.object({
+export const vMessageEmbeddingsWithDimension = v.object({
   model: v.string(),
   dimension: vVectorDimension,
   vectors: v.array(v.union(v.array(v.number()), v.null())),
 });
-export type MessageEmbeddings = Infer<typeof vMessageEmbeddings>;
+export type MessageEmbeddingsWithDimension = Infer<
+  typeof vMessageEmbeddingsWithDimension
+>;
 
-export const vObjectResult = v.object({
-  request: vRequest,
-  response: vResponseWithoutMessages,
-  finishReason: vFinishReason,
-  usage: v.optional(v.any()),
-  object: v.any(),
-  error: v.optional(v.string()),
-  warnings: v.optional(v.array(vLanguageModelV1CallWarning)),
-  providerMetadata,
+export const vMessageEmbeddings = v.object({
+  model: v.string(),
+  vectors: v.array(v.union(v.array(v.number()), v.null())),
 });
-export type ObjectResult = Infer<typeof vObjectResult>;
+export type MessageEmbeddings = Infer<typeof vMessageEmbeddings>;
 
 export const vContextOptionsSearchOptions = v.object({
   limit: v.number(),
@@ -318,18 +305,19 @@ const vPromptFields = {
   promptMessageId: v.optional(v.string()),
 };
 
-export const vCallSettingsFields = {
-  maxTokens: v.optional(v.number()),
+export const vCallSettings = v.object({
+  maxOutputTokens: v.optional(v.number()),
   temperature: v.optional(v.number()),
   topP: v.optional(v.number()),
   topK: v.optional(v.number()),
   presencePenalty: v.optional(v.number()),
   frequencyPenalty: v.optional(v.number()),
+  stopSequences: v.optional(v.array(v.string())),
   seed: v.optional(v.number()),
   maxRetries: v.optional(v.number()),
   headers: v.optional(v.record(v.string(), v.string())),
-};
-export type CallSettings = ObjectType<typeof vCallSettingsFields>;
+});
+export type CallSettings = Infer<typeof vCallSettings>;
 
 const vCommonArgs = {
   userId: v.optional(v.string()),
@@ -337,7 +325,7 @@ const vCommonArgs = {
   contextOptions: v.optional(vContextOptions),
   storageOptions: v.optional(vStorageOptions),
   providerOptions,
-  ...vCallSettingsFields,
+  callSettings: v.optional(vCallSettings),
   ...vPromptFields,
 };
 
@@ -349,10 +337,7 @@ export const vTextArgs = v.object({
       v.literal("auto"),
       v.literal("none"),
       v.literal("required"),
-      v.object({
-        type: v.literal("tool"),
-        toolName: v.string(),
-      }),
+      v.object({ type: v.literal("tool"), toolName: v.string() }),
     ),
   ),
   maxSteps: v.optional(v.number()),
@@ -388,35 +373,6 @@ export function vPaginationResult<
   });
 }
 
-export const vTextStreamPart = v.union(
-  v.object({
-    type: v.literal("text-delta"),
-    textDelta: v.string(),
-  }),
-  v.object({
-    type: v.literal("reasoning"),
-    textDelta: v.string(),
-  }),
-  v.object({
-    type: v.literal("source"),
-    source: vSource,
-  }),
-  vToolCallPart,
-  v.object({
-    type: v.literal("tool-call-streaming-start"),
-    toolCallId: v.string(),
-    toolName: v.string(),
-  }),
-  v.object({
-    type: v.literal("tool-call-delta"),
-    toolCallId: v.string(),
-    toolName: v.string(),
-    argsTextDelta: v.string(),
-  }),
-  vToolResultPart,
-);
-export type TextStreamPart = Infer<typeof vTextStreamPart>;
-
 export const vStreamCursor = v.object({
   streamId: v.string(),
   cursor: v.number(),
@@ -425,14 +381,8 @@ export type StreamCursor = Infer<typeof vStreamCursor>;
 
 export const vStreamArgs = v.optional(
   v.union(
-    v.object({
-      kind: v.literal("list"),
-      startOrder: v.optional(v.number()),
-    }),
-    v.object({
-      kind: v.literal("deltas"),
-      cursors: v.array(vStreamCursor),
-    }),
+    v.object({ kind: v.literal("list"), startOrder: v.optional(v.number()) }),
+    v.object({ kind: v.literal("deltas"), cursors: v.array(vStreamCursor) }),
   ),
 );
 export type StreamArgs = Infer<typeof vStreamArgs>;
@@ -459,6 +409,6 @@ export const vStreamDelta = v.object({
   streamId: v.string(),
   start: v.number(), // inclusive
   end: v.number(), // exclusive
-  parts: v.array(vTextStreamPart),
+  parts: v.array(v.any()),
 });
 export type StreamDelta = Infer<typeof vStreamDelta>;

package/dist/client/listMessages.d.ts

@@ -1,22 +0,0 @@
-import type { PaginationOptions, PaginationResult } from "convex/server";
-import type { AgentComponent, RunQueryCtx } from "./types.js";
-import type { MessageStatus } from "../validators.js";
-import type { MessageDoc } from "../component/schema.js";
-/**
- * List messages from a thread.
- * @param ctx A ctx object from a query, mutation, or action.
- * @param component The agent component, usually `components.agent`.
- * @param args.threadId The thread to list messages from.
- * @param args.paginationOpts Pagination options (e.g. via usePaginatedQuery).
- * @param args.excludeToolMessages Whether to exclude tool messages.
- *   False by default.
- * @param args.statuses What statuses to include. All by default.
- * @returns The MessageDoc's in a format compatible with usePaginatedQuery.
- */
-export declare function listMessages(ctx: RunQueryCtx, component: AgentComponent, args: {
-    threadId: string;
-    paginationOpts: PaginationOptions;
-    excludeToolMessages?: boolean;
-    statuses?: MessageStatus[];
-}): Promise<PaginationResult<MessageDoc>>;
-//# sourceMappingURL=listMessages.d.ts.map

package/dist/client/listMessages.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"listMessages.d.ts","sourceRoot":"","sources":["../../src/client/listMessages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACzE,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEzD;;;;;;;;;;GAUG;AACH,wBAAsB,YAAY,CAChC,GAAG,EAAE,WAAW,EAChB,SAAS,EAAE,cAAc,EACzB,IAAI,EAAE;IACJ,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,iBAAiB,CAAC;IAClC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;CAC5B,GACA,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAYvC"}

package/dist/client/listMessages.js

@@ -1,25 +0,0 @@
-/**
- * List messages from a thread.
- * @param ctx A ctx object from a query, mutation, or action.
- * @param component The agent component, usually `components.agent`.
- * @param args.threadId The thread to list messages from.
- * @param args.paginationOpts Pagination options (e.g. via usePaginatedQuery).
- * @param args.excludeToolMessages Whether to exclude tool messages.
- *   False by default.
- * @param args.statuses What statuses to include. All by default.
- * @returns The MessageDoc's in a format compatible with usePaginatedQuery.
- */
-export async function listMessages(ctx, component, args) {
-    if (args.paginationOpts.numItems === 0) {
-        return {
-            page: [],
-            isDone: true,
-            continueCursor: args.paginationOpts.cursor ?? "",
-        };
-    }
-    return ctx.runQuery(component.messages.listMessagesByThreadId, {
-        order: "desc",
-        ...args,
-    });
-}
-//# sourceMappingURL=listMessages.js.map

package/dist/client/listMessages.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"listMessages.js","sourceRoot":"","sources":["../../src/client/listMessages.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,GAAgB,EAChB,SAAyB,EACzB,IAKC;IAED,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;QACvC,OAAO;YACL,IAAI,EAAE,EAAE;YACR,MAAM,EAAE,IAAI;YACZ,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,IAAI,EAAE;SACjD,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,sBAAsB,EAAE;QAC7D,KAAK,EAAE,MAAM;QACb,GAAG,IAAI;KACR,CAAC,CAAC;AACL,CAAC"}

package/src/client/listMessages.ts

@@ -1,38 +0,0 @@
-import type { PaginationOptions, PaginationResult } from "convex/server";
-import type { AgentComponent, RunQueryCtx } from "./types.js";
-import type { MessageStatus } from "../validators.js";
-import type { MessageDoc } from "../component/schema.js";
-
-/**
- * List messages from a thread.
- * @param ctx A ctx object from a query, mutation, or action.
- * @param component The agent component, usually `components.agent`.
- * @param args.threadId The thread to list messages from.
- * @param args.paginationOpts Pagination options (e.g. via usePaginatedQuery).
- * @param args.excludeToolMessages Whether to exclude tool messages.
- *   False by default.
- * @param args.statuses What statuses to include. All by default.
- * @returns The MessageDoc's in a format compatible with usePaginatedQuery.
- */
-export async function listMessages(
-  ctx: RunQueryCtx,
-  component: AgentComponent,
-  args: {
-    threadId: string;
-    paginationOpts: PaginationOptions;
-    excludeToolMessages?: boolean;
-    statuses?: MessageStatus[];
-  },
-): Promise<PaginationResult<MessageDoc>> {
-  if (args.paginationOpts.numItems === 0) {
-    return {
-      page: [],
-      isDone: true,
-      continueCursor: args.paginationOpts.cursor ?? "",
-    };
-  }
-  return ctx.runQuery(component.messages.listMessagesByThreadId, {
-    order: "desc",
-    ...args,
-  });
-}