ai 6.0.32 → 6.0.34

package/src/ui/__snapshots__/convert-to-model-messages.test.ts.snap

@@ -0,0 +1,419 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`convertToModelMessages > assistant message > should handle assistant message with tool invocations that have multi-part responses 1`] = `
+[
+  {
+    "content": [
+      {
+        "text": "Let me calculate that for you.",
+        "type": "text",
+      },
+      {
+        "input": {},
+        "providerExecuted": undefined,
+        "toolCallId": "call1",
+        "toolName": "screenshot",
+        "type": "tool-call",
+      },
+    ],
+    "role": "assistant",
+  },
+  {
+    "content": [
+      {
+        "output": {
+          "type": "text",
+          "value": "imgbase64",
+        },
+        "toolCallId": "call1",
+        "toolName": "screenshot",
+        "type": "tool-result",
+      },
+    ],
+    "role": "tool",
+  },
+]
+`;
+
+exports[`convertToModelMessages > assistant message > should handle conversation with an assistant message that has empty tool invocations 1`] = `
+[
+  {
+    "content": [
+      {
+        "text": "text1",
+        "type": "text",
+      },
+    ],
+    "role": "user",
+  },
+  {
+    "content": [
+      {
+        "text": "text2",
+        "type": "text",
+      },
+    ],
+    "role": "assistant",
+  },
+]
+`;
+
+exports[`convertToModelMessages > assistant message > should handle conversation with mix of tool invocations and text 1`] = `
+[
+  {
+    "content": [
+      {
+        "text": "i am gonna use tool1",
+        "type": "text",
+      },
+      {
+        "input": {
+          "value": "value-1",
+        },
+        "providerExecuted": undefined,
+        "toolCallId": "call-1",
+        "toolName": "screenshot",
+        "type": "tool-call",
+      },
+    ],
+    "role": "assistant",
+  },
+  {
+    "content": [
+      {
+        "output": {
+          "type": "text",
+          "value": "result-1",
+        },
+        "toolCallId": "call-1",
+        "toolName": "screenshot",
+        "type": "tool-result",
+      },
+    ],
+    "role": "tool",
+  },
+  {
+    "content": [
+      {
+        "text": "i am gonna use tool2 and tool3",
+        "type": "text",
+      },
+      {
+        "input": {
+          "value": "value-2",
+        },
+        "providerExecuted": undefined,
+        "toolCallId": "call-2",
+        "toolName": "screenshot",
+        "type": "tool-call",
+      },
+      {
+        "input": {
+          "value": "value-3",
+        },
+        "providerExecuted": undefined,
+        "toolCallId": "call-3",
+        "toolName": "screenshot",
+        "type": "tool-call",
+      },
+    ],
+    "role": "assistant",
+  },
+  {
+    "content": [
+      {
+        "output": {
+          "type": "text",
+          "value": "result-2",
+        },
+        "toolCallId": "call-2",
+        "toolName": "screenshot",
+        "type": "tool-result",
+      },
+      {
+        "output": {
+          "type": "text",
+          "value": "result-3",
+        },
+        "toolCallId": "call-3",
+        "toolName": "screenshot",
+        "type": "tool-result",
+      },
+    ],
+    "role": "tool",
+  },
+  {
+    "content": [
+      {
+        "input": {
+          "value": "value-4",
+        },
+        "providerExecuted": undefined,
+        "toolCallId": "call-4",
+        "toolName": "screenshot",
+        "type": "tool-call",
+      },
+    ],
+    "role": "assistant",
+  },
+  {
+    "content": [
+      {
+        "output": {
+          "type": "text",
+          "value": "result-4",
+        },
+        "toolCallId": "call-4",
+        "toolName": "screenshot",
+        "type": "tool-result",
+      },
+    ],
+    "role": "tool",
+  },
+  {
+    "content": [
+      {
+        "text": "final response",
+        "type": "text",
+      },
+    ],
+    "role": "assistant",
+  },
+]
+`;
+
+exports[`convertToModelMessages > assistant message > should handle conversation with multiple tool invocations that have step information 1`] = `
+[
+  {
+    "content": [
+      {
+        "text": "response",
+        "type": "text",
+      },
+      {
+        "input": {
+          "value": "value-1",
+        },
+        "providerExecuted": undefined,
+        "toolCallId": "call-1",
+        "toolName": "screenshot",
+        "type": "tool-call",
+      },
+    ],
+    "role": "assistant",
+  },
+  {
+    "content": [
+      {
+        "output": {
+          "type": "text",
+          "value": "result-1",
+        },
+        "toolCallId": "call-1",
+        "toolName": "screenshot",
+        "type": "tool-result",
+      },
+    ],
+    "role": "tool",
+  },
+  {
+    "content": [
+      {
+        "input": {
+          "value": "value-2",
+        },
+        "providerExecuted": undefined,
+        "toolCallId": "call-2",
+        "toolName": "screenshot",
+        "type": "tool-call",
+      },
+      {
+        "input": {
+          "value": "value-3",
+        },
+        "providerExecuted": undefined,
+        "toolCallId": "call-3",
+        "toolName": "screenshot",
+        "type": "tool-call",
+      },
+    ],
+    "role": "assistant",
+  },
+  {
+    "content": [
+      {
+        "output": {
+          "type": "text",
+          "value": "result-2",
+        },
+        "toolCallId": "call-2",
+        "toolName": "screenshot",
+        "type": "tool-result",
+      },
+      {
+        "output": {
+          "type": "text",
+          "value": "result-3",
+        },
+        "toolCallId": "call-3",
+        "toolName": "screenshot",
+        "type": "tool-result",
+      },
+    ],
+    "role": "tool",
+  },
+  {
+    "content": [
+      {
+        "input": {
+          "value": "value-4",
+        },
+        "providerExecuted": undefined,
+        "toolCallId": "call-4",
+        "toolName": "screenshot",
+        "type": "tool-call",
+      },
+    ],
+    "role": "assistant",
+  },
+  {
+    "content": [
+      {
+        "output": {
+          "type": "text",
+          "value": "result-4",
+        },
+        "toolCallId": "call-4",
+        "toolName": "screenshot",
+        "type": "tool-result",
+      },
+    ],
+    "role": "tool",
+  },
+]
+`;
+
+exports[`convertToModelMessages > multiple messages > should handle conversation with multiple tool invocations and user message at the end 1`] = `
+[
+  {
+    "content": [
+      {
+        "input": {
+          "value": "value-1",
+        },
+        "providerExecuted": undefined,
+        "toolCallId": "call-1",
+        "toolName": "screenshot",
+        "type": "tool-call",
+      },
+    ],
+    "role": "assistant",
+  },
+  {
+    "content": [
+      {
+        "output": {
+          "type": "text",
+          "value": "result-1",
+        },
+        "toolCallId": "call-1",
+        "toolName": "screenshot",
+        "type": "tool-result",
+      },
+    ],
+    "role": "tool",
+  },
+  {
+    "content": [
+      {
+        "input": {
+          "value": "value-2",
+        },
+        "providerExecuted": undefined,
+        "toolCallId": "call-2",
+        "toolName": "screenshot",
+        "type": "tool-call",
+      },
+      {
+        "input": {
+          "value": "value-3",
+        },
+        "providerExecuted": undefined,
+        "toolCallId": "call-3",
+        "toolName": "screenshot",
+        "type": "tool-call",
+      },
+    ],
+    "role": "assistant",
+  },
+  {
+    "content": [
+      {
+        "output": {
+          "type": "text",
+          "value": "result-2",
+        },
+        "toolCallId": "call-2",
+        "toolName": "screenshot",
+        "type": "tool-result",
+      },
+      {
+        "output": {
+          "type": "text",
+          "value": "result-3",
+        },
+        "toolCallId": "call-3",
+        "toolName": "screenshot",
+        "type": "tool-result",
+      },
+    ],
+    "role": "tool",
+  },
+  {
+    "content": [
+      {
+        "input": {
+          "value": "value-4",
+        },
+        "providerExecuted": undefined,
+        "toolCallId": "call-4",
+        "toolName": "screenshot",
+        "type": "tool-call",
+      },
+    ],
+    "role": "assistant",
+  },
+  {
+    "content": [
+      {
+        "output": {
+          "type": "text",
+          "value": "result-4",
+        },
+        "toolCallId": "call-4",
+        "toolName": "screenshot",
+        "type": "tool-result",
+      },
+    ],
+    "role": "tool",
+  },
+  {
+    "content": [
+      {
+        "text": "response",
+        "type": "text",
+      },
+    ],
+    "role": "assistant",
+  },
+  {
+    "content": [
+      {
+        "text": "Thanks!",
+        "type": "text",
+      },
+    ],
+    "role": "user",
+  },
+]
+`;

package/src/ui/__snapshots__/process-chat-text-response.test.ts.snap

@@ -0,0 +1,142 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`processChatTextResponse > scenario: multiple short chunks > should call the onFinish function after the stream ends 1`] = `
+[
+  {
+    "id": "test-id",
+    "parts": [
+      {
+        "text": "ABCDE",
+        "type": "text",
+      },
+    ],
+    "role": "assistant",
+  },
+]
+`;
+
+exports[`processChatTextResponse > scenario: multiple short chunks > should call the update function with correct arguments for each chunk 1`] = `
+[
+  {
+    "message": {
+      "id": "test-id",
+      "parts": [
+        {
+          "text": "A",
+          "type": "text",
+        },
+      ],
+      "role": "assistant",
+    },
+  },
+  {
+    "message": {
+      "id": "test-id",
+      "parts": [
+        {
+          "text": "AB",
+          "type": "text",
+        },
+      ],
+      "role": "assistant",
+    },
+  },
+  {
+    "message": {
+      "id": "test-id",
+      "parts": [
+        {
+          "text": "ABC",
+          "type": "text",
+        },
+      ],
+      "role": "assistant",
+    },
+  },
+  {
+    "message": {
+      "id": "test-id",
+      "parts": [
+        {
+          "text": "ABCD",
+          "type": "text",
+        },
+      ],
+      "role": "assistant",
+    },
+  },
+  {
+    "message": {
+      "id": "test-id",
+      "parts": [
+        {
+          "text": "ABCDE",
+          "type": "text",
+        },
+      ],
+      "role": "assistant",
+    },
+  },
+]
+`;
+
+exports[`processChatTextResponse > scenario: no text chunks > should call the onFinish function after the stream ends 1`] = `
+[
+  {
+    "id": "test-id",
+    "parts": [
+      {
+        "text": "",
+        "type": "text",
+      },
+    ],
+    "role": "assistant",
+  },
+]
+`;
+
+exports[`processChatTextResponse > scenario: no text chunks > should call the update function with correct arguments for each chunk 1`] = `[]`;
+
+exports[`processChatTextResponse > scenario: simple text response > should call the onFinish function after the stream ends 1`] = `
+[
+  {
+    "id": "test-id",
+    "parts": [
+      {
+        "text": "Hello, world!",
+        "type": "text",
+      },
+    ],
+    "role": "assistant",
+  },
+]
+`;
+
+exports[`processChatTextResponse > scenario: simple text response > should call the update function with correct arguments for each chunk 1`] = `
+[
+  {
+    "message": {
+      "id": "test-id",
+      "parts": [
+        {
+          "text": "Hello, ",
+          "type": "text",
+        },
+      ],
+      "role": "assistant",
+    },
+  },
+  {
+    "message": {
+      "id": "test-id",
+      "parts": [
+        {
+          "text": "Hello, world!",
+          "type": "text",
+        },
+      ],
+      "role": "assistant",
+    },
+  },
+]
+`;

package/src/ui/call-completion-api.ts

@@ -0,0 +1,157 @@
+import {
+  parseJsonEventStream,
+  ParseResult,
+  withUserAgentSuffix,
+  getRuntimeEnvironmentUserAgent,
+} from '@ai-sdk/provider-utils';
+import {
+  UIMessageChunk,
+  uiMessageChunkSchema,
+} from '../ui-message-stream/ui-message-chunks';
+import { consumeStream } from '../util/consume-stream';
+import { processTextStream } from './process-text-stream';
+import { VERSION } from '../version';
+
+// use function to allow for mocking in tests:
+const getOriginalFetch = () => fetch;
+
+export async function callCompletionApi({
+  api,
+  prompt,
+  credentials,
+  headers,
+  body,
+  streamProtocol = 'data',
+  setCompletion,
+  setLoading,
+  setError,
+  setAbortController,
+  onFinish,
+  onError,
+  fetch = getOriginalFetch(),
+}: {
+  api: string;
+  prompt: string;
+  credentials: RequestCredentials | undefined;
+  headers: HeadersInit | undefined;
+  body: Record<string, any>;
+  streamProtocol: 'data' | 'text' | undefined;
+  setCompletion: (completion: string) => void;
+  setLoading: (loading: boolean) => void;
+  setError: (error: Error | undefined) => void;
+  setAbortController: (abortController: AbortController | null) => void;
+  onFinish: ((prompt: string, completion: string) => void) | undefined;
+  onError: ((error: Error) => void) | undefined;
+  fetch: ReturnType<typeof getOriginalFetch> | undefined;
+}) {
+  try {
+    setLoading(true);
+    setError(undefined);
+
+    const abortController = new AbortController();
+    setAbortController(abortController);
+
+    // Empty the completion immediately.
+    setCompletion('');
+
+    const response = await fetch(api, {
+      method: 'POST',
+      body: JSON.stringify({
+        prompt,
+        ...body,
+      }),
+      credentials,
+      headers: withUserAgentSuffix(
+        {
+          'Content-Type': 'application/json',
+          ...headers,
+        },
+        `ai-sdk/${VERSION}`,
+        getRuntimeEnvironmentUserAgent(),
+      ),
+      signal: abortController.signal,
+    }).catch(err => {
+      throw err;
+    });
+
+    if (!response.ok) {
+      throw new Error(
+        (await response.text()) ?? 'Failed to fetch the chat response.',
+      );
+    }
+
+    if (!response.body) {
+      throw new Error('The response body is empty.');
+    }
+
+    let result = '';
+
+    switch (streamProtocol) {
+      case 'text': {
+        await processTextStream({
+          stream: response.body,
+          onTextPart: chunk => {
+            result += chunk;
+            setCompletion(result);
+          },
+        });
+        break;
+      }
+      case 'data': {
+        await consumeStream({
+          stream: parseJsonEventStream({
+            stream: response.body,
+            schema: uiMessageChunkSchema,
+          }).pipeThrough(
+            new TransformStream<ParseResult<UIMessageChunk>, UIMessageChunk>({
+              async transform(part) {
+                if (!part.success) {
+                  throw part.error;
+                }
+
+                const streamPart = part.value;
+                if (streamPart.type === 'text-delta') {
+                  result += streamPart.delta;
+                  setCompletion(result);
+                } else if (streamPart.type === 'error') {
+                  throw new Error(streamPart.errorText);
+                }
+              },
+            }),
+          ),
+          onError: error => {
+            throw error;
+          },
+        });
+        break;
+      }
+      default: {
+        const exhaustiveCheck: never = streamProtocol;
+        throw new Error(`Unknown stream protocol: ${exhaustiveCheck}`);
+      }
+    }
+
+    if (onFinish) {
+      onFinish(prompt, result);
+    }
+
+    setAbortController(null);
+    return result;
+  } catch (err) {
+    // Ignore abort errors as they are expected.
+    if ((err as any).name === 'AbortError') {
+      setAbortController(null);
+      return null;
+    }
+
+    if (err instanceof Error) {
+      if (onError) {
+        onError(err);
+      }
+    }
+
+    setError(err as Error);
+  } finally {
+    setLoading(false);
+  }
+}