@convex-dev/agent 0.2.5 → 0.2.6-alpha.1

package/src/react/toUIMessages.test.ts

@@ -106,7 +106,10 @@ describe("toUIMessages", () => {
               type: "tool-result",
               toolCallId: "call1",
               toolName: "myTool",
-              result: "42",
+              output: {
+                type: "text",
+                value: "42",
+              },
             },
           ],
         },
@@ -129,7 +132,10 @@ describe("toUIMessages", () => {
       type: "tool-myTool",
       toolCallId: "call1",
       state: "output-available",
-      output: "42",
+      output: {
+        type: "text",
+        value: "42",
+      },
     });
   });
 
@@ -590,7 +596,10 @@ describe("toUIMessages", () => {
               type: "tool-result",
               toolCallId: "call1",
               toolName: "calculator",
-              result: "42",
+              output: {
+                type: "text",
+                value: "42",
+              },
             },
           ],
         },
@@ -639,7 +648,10 @@ describe("toUIMessages", () => {
       toolCallId: "call1",
       state: "output-available",
       input: { operation: "add", a: 40, b: 2 },
-      output: "42",
+      output: {
+        type: "text",
+        value: "42",
+      },
     });
 
     // Should also have text part

package/src/react/useSmoothText.ts

@@ -2,7 +2,7 @@ import { useEffect, useRef, useState } from "react";
 
 const FPS = 20;
 const MS_PER_FRAME = 1000 / FPS;
-const MAX_TIME_JUMP_MS = 250;
+const INITIAL_CHARS_PER_SEC = 128;
 
 export type SmoothTextOptions = {
   /**
@@ -28,17 +28,21 @@ export type SmoothTextOptions = {
  */
 export function useSmoothText(
   text: string,
-  { charsPerSec = 256, startStreaming = false }: SmoothTextOptions = {},
+  {
+    charsPerSec = INITIAL_CHARS_PER_SEC,
+    startStreaming = false,
+  }: SmoothTextOptions = {},
 ): [string, { cursor: number; isStreaming: boolean }] {
   const [visibleText, setVisibleText] = useState(
     startStreaming ? "" : text || "",
   );
   const smoothState = useRef({
-    tick: Date.now() + (visibleText.length * 1000) / charsPerSec,
+    tick: Date.now(),
     cursor: visibleText.length,
-    start: Date.now(),
-    initialLength: visibleText.length,
+    lastUpdate: Date.now(),
+    lastUpdateLength: text.length,
     charsPerMs: charsPerSec / 1000,
+    initial: true,
   });
 
   const isStreaming = smoothState.current.cursor < text.length;
@@ -47,46 +51,51 @@ export function useSmoothText(
     if (!isStreaming) {
       return;
     }
-    if (
-      smoothState.current.cursor === 0 &&
-      smoothState.current.initialLength === 0
-    ) {
-      smoothState.current.cursor = text.length;
-      smoothState.current.start = Date.now();
-      smoothState.current.initialLength = text.length;
-      smoothState.current.charsPerMs = charsPerSec / 1000;
-    } else {
+    if (smoothState.current.lastUpdateLength !== text.length) {
+      const timeSinceLastUpdate = Date.now() - smoothState.current.lastUpdate;
       const latestCharsPerMs =
-        (text.length - smoothState.current.initialLength) /
-        (Date.now() - smoothState.current.start);
-      // Smooth out the charsPerSec by averaging it with the previous value.
+        (text.length - smoothState.current.lastUpdateLength) /
+        timeSinceLastUpdate;
+      // Is the rate increasing?
+      const rateError = latestCharsPerMs - smoothState.current.charsPerMs;
+      // Is our visible text falling behind what it could show?
+      const charLag =
+        smoothState.current.lastUpdateLength - smoothState.current.cursor;
+      const lagRate = charLag / timeSinceLastUpdate;
+      const charsPerMs =
+        latestCharsPerMs +
+        (smoothState.current.initial
+          ? 0
+          : Math.max(0, (rateError + lagRate) / 2));
+      smoothState.current.initial = false;
+      // Smooth out the charsPerSec by weighting it with the previous value.
       smoothState.current.charsPerMs = Math.min(
-        (2 * latestCharsPerMs + smoothState.current.charsPerMs) / 3,
+        (2 * charsPerMs + smoothState.current.charsPerMs) / 3,
         smoothState.current.charsPerMs * 2,
       );
-      smoothState.current.tick = Math.max(
-        smoothState.current.tick,
-        Date.now() - 2 * MS_PER_FRAME,
-      );
     }
+    smoothState.current.tick = Math.max(
+      smoothState.current.tick,
+      Date.now() - MS_PER_FRAME,
+    );
+    smoothState.current.lastUpdate = Date.now();
+    smoothState.current.lastUpdateLength = text.length;
 
     function update() {
       if (smoothState.current.cursor >= text.length) {
         return;
       }
       const now = Date.now();
-      const timeSinceLastUpdate = Math.min(
-        MAX_TIME_JUMP_MS,
-        now - smoothState.current.tick,
-      );
-      const chars = Math.floor(
+      const timeSinceLastUpdate = now - smoothState.current.tick;
+      const charsSinceLastUpdate = Math.floor(
         timeSinceLastUpdate * smoothState.current.charsPerMs,
       );
-      smoothState.current.cursor = Math.min(
-        smoothState.current.cursor + chars,
-        text.length,
+      const chars = Math.min(
+        charsSinceLastUpdate,
+        text.length - smoothState.current.cursor,
       );
-      smoothState.current.tick = now;
+      smoothState.current.cursor += chars;
+      smoothState.current.tick += chars / smoothState.current.charsPerMs;
       setVisibleText(text.slice(0, smoothState.current.cursor));
     }
     update();

package/src/validators.ts

@@ -131,16 +131,38 @@ const vToolResultContent = v.array(
   ),
 );
 
+export const vToolResultOutput = v.union(
+  v.object({ type: v.literal("text"), value: v.string() }),
+  v.object({ type: v.literal("json"), value: v.any() }),
+  v.object({ type: v.literal("error-text"), value: v.string() }),
+  v.object({ type: v.literal("error-json"), value: v.any() }),
+  v.object({
+    type: v.literal("content"),
+    value: v.array(
+      v.union(
+        v.object({ type: v.literal("text"), text: v.string() }),
+        v.object({
+          type: v.literal("media"),
+          data: v.string(),
+          mediaType: v.string(),
+        }),
+      ),
+    ),
+  }),
+);
+
 export const vToolResultPart = v.object({
   type: v.literal("tool-result"),
   toolCallId: v.string(),
   toolName: v.string(),
-  result: v.any(),
+  output: v.optional(vToolResultOutput),
+
   providerOptions,
   providerMetadata,
   providerExecuted: v.optional(v.boolean()),
 
   // Deprecated in ai v5
+  result: v.optional(v.any()), // either this or output will be present
   isError: v.optional(v.boolean()),
   // This is only here b/c steps include it in toolResults
   // Normal ModelMessage doesn't have this

package/dist/parts.d.ts

@@ -1,3 +0,0 @@
-import type { TextStreamPart, ToolSet } from "ai";
-export declare function serializeTextStreamingPartsV5(parts: TextStreamPart<ToolSet>[]): TextStreamPart<ToolSet>[];
-//# sourceMappingURL=parts.d.ts.map

package/dist/parts.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"parts.d.ts","sourceRoot":"","sources":["../src/parts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAElD,wBAAgB,6BAA6B,CAC3C,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,EAAE,GAC/B,cAAc,CAAC,OAAO,CAAC,EAAE,CAkC3B"}

package/dist/parts.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"parts.js","sourceRoot":"","sources":["../src/parts.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,6BAA6B,CAC3C,KAAgC;IAEhC,MAAM,UAAU,GAA8B,EAAE,CAAC;IACjD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/B,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,IAAI,IAAI,EAAE,IAAI,KAAK,YAAY,EAAE,CAAC;YAC9D,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC;QACzB,CAAC;aAAM,IACL,IAAI,CAAC,IAAI,KAAK,iBAAiB;YAC/B,IAAI,EAAE,IAAI,KAAK,iBAAiB,EAChC,CAAC;YACD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC;QACzB,CAAC;aAAM,CAAC;YACN,IACE,IAAI,CAAC,IAAI,KAAK,YAAY;gBAC1B,IAAI,CAAC,IAAI,KAAK,aAAa;gBAC3B,IAAI,CAAC,IAAI,KAAK,OAAO;gBACrB,IAAI,CAAC,IAAI,KAAK,QAAQ,EACtB,CAAC;gBACD,SAAS;YACX,CAAC;YACD,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;gBACzB,UAAU,CAAC,IAAI,CAAC;oBACd,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE;wBACJ,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS;wBAC9B,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;wBACxB,UAAU,EAAE,IAAI,UAAU,CAAC,EAAE,CAAC;qBAC/B;iBACF,CAAC,CAAC;YACL,CAAC;YACD,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC"}