ai 2.2.18 → 2.2.19

package/dist/index.d.ts

@@ -42,6 +42,7 @@ interface Message {
     id: string;
     createdAt?: Date;
     content: string;
+    ui?: string | JSX.Element | JSX.Element[] | null | undefined;
     role: 'system' | 'user' | 'assistant' | 'function';
     /**
      * If the message has a role of `function`, the `name` field is the name of the function.
@@ -601,4 +602,32 @@ declare const getStreamStringTypeAndValue: (line: string) => {
  */
 declare const COMPLEX_HEADER = "X-Experimental-Stream-Data";
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AnthropicStream, COMPLEX_HEADER, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CreateMessage, FunctionCall, FunctionCallHandler, FunctionCallPayload, HuggingFaceStream, JSONValue, LangChainStream, Message, OpenAIStream, OpenAIStreamCallbacks, ReplicateStream, RequestOptions, StreamString, StreamStringPrefixes, StreamingTextResponse, UseChatOptions, UseCompletionOptions, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, experimental_StreamData, getStreamString, getStreamStringTypeAndValue, isStreamStringEqualToType, nanoid, readableFromAsyncIterable, streamToResponse, trimStartOfStreamHelper };
+/**
+ * This is a naive implementation of the streaming React response API.
+ * Currently, it can carry the original raw content, data payload and a special
+ * UI payload and stream them via "rows" (nested promises).
+ * It must be used inside Server Actions so Flight can encode the React elements.
+ *
+ * It is naive as unlike the StreamingTextResponse, it does not send the diff
+ * between the rows, but flushing the full payload on each row.
+ */
+type UINode = string | JSX.Element | JSX.Element[] | null | undefined;
+type Payload = {
+    ui: UINode | Promise<UINode>;
+    content: string;
+};
+type ReactResponseRow = Payload & {
+    next: null | Promise<ReactResponseRow>;
+};
+/**
+ * A utility class for streaming React responses.
+ */
+declare class experimental_StreamingReactResponse {
+    constructor(res: ReadableStream, options?: {
+        ui?: (message: {
+            content: string;
+        }) => UINode | Promise<UINode>;
+    });
+}
+
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AnthropicStream, COMPLEX_HEADER, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CreateMessage, FunctionCall, FunctionCallHandler, FunctionCallPayload, HuggingFaceStream, JSONValue, LangChainStream, Message, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamString, StreamStringPrefixes, StreamingTextResponse, UseChatOptions, UseCompletionOptions, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, experimental_StreamData, experimental_StreamingReactResponse, getStreamString, getStreamStringTypeAndValue, isStreamStringEqualToType, nanoid, readableFromAsyncIterable, streamToResponse, trimStartOfStreamHelper };

package/dist/index.js

@@ -35,6 +35,7 @@ __export(streams_exports, {
   createEventStreamTransformer: () => createEventStreamTransformer,
   createStreamDataTransformer: () => createStreamDataTransformer,
   experimental_StreamData: () => experimental_StreamData,
+  experimental_StreamingReactResponse: () => experimental_StreamingReactResponse,
   getStreamString: () => getStreamString,
   getStreamStringTypeAndValue: () => getStreamStringTypeAndValue,
   isStreamStringEqualToType: () => isStreamStringEqualToType,
@@ -231,7 +232,6 @@ var experimental_StreamData = class {
         self.controller = controller;
       },
       transform: async (chunk, controller) => {
-        controller.enqueue(chunk);
         if (self.data.length > 0) {
           const encodedData = self.encoder.encode(
             getStreamString("data", JSON.stringify(self.data))
@@ -239,6 +239,7 @@ var experimental_StreamData = class {
           self.data = [];
           controller.enqueue(encodedData);
         }
+        controller.enqueue(chunk);
       },
       async flush(controller) {
         const warningTimeout = process.env.NODE_ENV === "development" ? setTimeout(() => {
@@ -713,6 +714,46 @@ async function ReplicateStream(res, cb) {
     createStreamDataTransformer(cb == null ? void 0 : cb.experimental_streamData)
   );
 }
+
+// streams/streaming-react-response.ts
+var experimental_StreamingReactResponse = class {
+  constructor(res, options) {
+    let resolveFunc = () => {
+    };
+    let next = new Promise((resolve) => {
+      resolveFunc = resolve;
+    });
+    let content = "";
+    const decode = createChunkDecoder();
+    const reader = res.getReader();
+    async function readChunk() {
+      var _a;
+      const { done, value } = await reader.read();
+      if (!done) {
+        content += decode(value);
+      }
+      const ui = ((_a = options == null ? void 0 : options.ui) == null ? void 0 : _a.call(options, { content })) || content;
+      const payload = {
+        ui,
+        content
+      };
+      const resolvePrevious = resolveFunc;
+      const nextRow = done ? null : new Promise((resolve) => {
+        resolveFunc = resolve;
+      });
+      resolvePrevious({
+        next: nextRow,
+        ...payload
+      });
+      if (done) {
+        return;
+      }
+      await readChunk();
+    }
+    readChunk();
+    return next;
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AIStream,
@@ -730,6 +771,7 @@ async function ReplicateStream(res, cb) {
   createEventStreamTransformer,
   createStreamDataTransformer,
   experimental_StreamData,
+  experimental_StreamingReactResponse,
   getStreamString,
   getStreamStringTypeAndValue,
   isStreamStringEqualToType,

package/dist/index.mjs

@@ -186,7 +186,6 @@ var experimental_StreamData = class {
         self.controller = controller;
       },
       transform: async (chunk, controller) => {
-        controller.enqueue(chunk);
         if (self.data.length > 0) {
           const encodedData = self.encoder.encode(
             getStreamString("data", JSON.stringify(self.data))
@@ -194,6 +193,7 @@ var experimental_StreamData = class {
           self.data = [];
           controller.enqueue(encodedData);
         }
+        controller.enqueue(chunk);
       },
       async flush(controller) {
         const warningTimeout = process.env.NODE_ENV === "development" ? setTimeout(() => {
@@ -668,6 +668,46 @@ async function ReplicateStream(res, cb) {
     createStreamDataTransformer(cb == null ? void 0 : cb.experimental_streamData)
   );
 }
+
+// streams/streaming-react-response.ts
+var experimental_StreamingReactResponse = class {
+  constructor(res, options) {
+    let resolveFunc = () => {
+    };
+    let next = new Promise((resolve) => {
+      resolveFunc = resolve;
+    });
+    let content = "";
+    const decode = createChunkDecoder();
+    const reader = res.getReader();
+    async function readChunk() {
+      var _a;
+      const { done, value } = await reader.read();
+      if (!done) {
+        content += decode(value);
+      }
+      const ui = ((_a = options == null ? void 0 : options.ui) == null ? void 0 : _a.call(options, { content })) || content;
+      const payload = {
+        ui,
+        content
+      };
+      const resolvePrevious = resolveFunc;
+      const nextRow = done ? null : new Promise((resolve) => {
+        resolveFunc = resolve;
+      });
+      resolvePrevious({
+        next: nextRow,
+        ...payload
+      });
+      if (done) {
+        return;
+      }
+      await readChunk();
+    }
+    readChunk();
+    return next;
+  }
+};
 export {
   AIStream,
   AnthropicStream,
@@ -684,6 +724,7 @@ export {
   createEventStreamTransformer,
   createStreamDataTransformer,
   experimental_StreamData,
+  experimental_StreamingReactResponse,
   getStreamString,
   getStreamStringTypeAndValue,
   isStreamStringEqualToType,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "2.2.18",
+  "version": "2.2.19",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",

package/prompts/dist/index.d.ts

@@ -18,6 +18,7 @@ interface Message {
     id: string;
     createdAt?: Date;
     content: string;
+    ui?: string | JSX.Element | JSX.Element[] | null | undefined;
     role: 'system' | 'user' | 'assistant' | 'function';
     /**
      * If the message has a role of `function`, the `name` field is the name of the function.

package/react/dist/index.d.ts

@@ -40,6 +40,7 @@ interface Message {
     id: string;
     createdAt?: Date;
     content: string;
+    ui?: string | JSX.Element | JSX.Element[] | null | undefined;
     role: 'system' | 'user' | 'assistant' | 'function';
     /**
      * If the message has a role of `function`, the `name` field is the name of the function.
@@ -197,6 +198,27 @@ type UseCompletionOptions = {
     body?: object;
 };
 
+/**
+ * This is a naive implementation of the streaming React response API.
+ * Currently, it can carry the original raw content, data payload and a special
+ * UI payload and stream them via "rows" (nested promises).
+ * It must be used inside Server Actions so Flight can encode the React elements.
+ *
+ * It is naive as unlike the StreamingTextResponse, it does not send the diff
+ * between the rows, but flushing the full payload on each row.
+ */
+type UINode = string | JSX.Element | JSX.Element[] | null | undefined;
+/**
+ * A utility class for streaming React responses.
+ */
+declare class experimental_StreamingReactResponse {
+    constructor(res: ReadableStream, options?: {
+        ui?: (message: {
+            content: string;
+        }) => UINode | Promise<UINode>;
+    });
+}
+
 type UseChatHelpers = {
     /** Current messages in the chat */
     messages: Message[];
@@ -239,7 +261,12 @@ type UseChatHelpers = {
     /** Additional data added on the server via StreamData */
     data?: any;
 };
-declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, experimental_onFunctionCall, onResponse, onFinish, onError, credentials, headers, body, }?: UseChatOptions): UseChatHelpers;
+type StreamingReactResponseAction = (payload: {
+    messages: Message[];
+}) => Promise<experimental_StreamingReactResponse>;
+declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, experimental_onFunctionCall, onResponse, onFinish, onError, credentials, headers, body, }?: Omit<UseChatOptions, 'api'> & {
+    api?: string | StreamingReactResponseAction;
+}): UseChatHelpers;
 
 type UseCompletionHelpers = {
     /** The current completion result */

package/react/dist/index.js

@@ -91,19 +91,50 @@ var getStreamedResponse = async (api, chatRequest, mutate, mutateStreamData, exi
   var _a, _b;
   const previousMessages = messagesRef.current;
   mutate(chatRequest.messages, false);
+  const constructedMessagesPayload = sendExtraMessageFields ? chatRequest.messages : chatRequest.messages.map(({ role, content, name, function_call }) => ({
+    role,
+    content,
+    ...name !== void 0 && { name },
+    ...function_call !== void 0 && {
+      function_call
+    }
+  }));
+  if (typeof api !== "string") {
+    const replyId = nanoid();
+    const createdAt2 = /* @__PURE__ */ new Date();
+    let responseMessage = {
+      id: replyId,
+      createdAt: createdAt2,
+      content: "",
+      role: "assistant"
+    };
+    async function readRow(promise) {
+      const { content, ui, next } = await promise;
+      responseMessage["content"] = content;
+      responseMessage["ui"] = await ui;
+      mutate([...chatRequest.messages, { ...responseMessage }], false);
+      if (next) {
+        await readRow(next);
+      }
+    }
+    try {
+      const promise = api({
+        messages: constructedMessagesPayload
+      });
+      await readRow(promise);
+    } catch (e) {
+      mutate(previousMessages, false);
+      throw e;
+    }
+    if (onFinish) {
+      onFinish(responseMessage);
+    }
+    return responseMessage;
+  }
   const res = await fetch(api, {
     method: "POST",
     body: JSON.stringify({
-      messages: sendExtraMessageFields ? chatRequest.messages : chatRequest.messages.map(
-        ({ role, content, name, function_call }) => ({
-          role,
-          content,
-          ...name !== void 0 && { name },
-          ...function_call !== void 0 && {
-            function_call
-          }
-        })
-      ),
+      messages: constructedMessagesPayload,
       ...extraMetadataRef.current.body,
       ...(_a = chatRequest.options) == null ? void 0 : _a.body,
       ...chatRequest.functions !== void 0 && {

package/react/dist/index.mjs

@@ -55,19 +55,50 @@ var getStreamedResponse = async (api, chatRequest, mutate, mutateStreamData, exi
   var _a, _b;
   const previousMessages = messagesRef.current;
   mutate(chatRequest.messages, false);
+  const constructedMessagesPayload = sendExtraMessageFields ? chatRequest.messages : chatRequest.messages.map(({ role, content, name, function_call }) => ({
+    role,
+    content,
+    ...name !== void 0 && { name },
+    ...function_call !== void 0 && {
+      function_call
+    }
+  }));
+  if (typeof api !== "string") {
+    const replyId = nanoid();
+    const createdAt2 = /* @__PURE__ */ new Date();
+    let responseMessage = {
+      id: replyId,
+      createdAt: createdAt2,
+      content: "",
+      role: "assistant"
+    };
+    async function readRow(promise) {
+      const { content, ui, next } = await promise;
+      responseMessage["content"] = content;
+      responseMessage["ui"] = await ui;
+      mutate([...chatRequest.messages, { ...responseMessage }], false);
+      if (next) {
+        await readRow(next);
+      }
+    }
+    try {
+      const promise = api({
+        messages: constructedMessagesPayload
+      });
+      await readRow(promise);
+    } catch (e) {
+      mutate(previousMessages, false);
+      throw e;
+    }
+    if (onFinish) {
+      onFinish(responseMessage);
+    }
+    return responseMessage;
+  }
   const res = await fetch(api, {
     method: "POST",
     body: JSON.stringify({
-      messages: sendExtraMessageFields ? chatRequest.messages : chatRequest.messages.map(
-        ({ role, content, name, function_call }) => ({
-          role,
-          content,
-          ...name !== void 0 && { name },
-          ...function_call !== void 0 && {
-            function_call
-          }
-        })
-      ),
+      messages: constructedMessagesPayload,
       ...extraMetadataRef.current.body,
       ...(_a = chatRequest.options) == null ? void 0 : _a.body,
       ...chatRequest.functions !== void 0 && {

package/solid/dist/index.d.ts

@@ -42,6 +42,7 @@ interface Message {
     id: string;
     createdAt?: Date;
     content: string;
+    ui?: string | JSX.Element | JSX.Element[] | null | undefined;
     role: 'system' | 'user' | 'assistant' | 'function';
     /**
      * If the message has a role of `function`, the `name` field is the name of the function.

package/svelte/dist/index.d.ts

@@ -42,6 +42,7 @@ interface Message {
     id: string;
     createdAt?: Date;
     content: string;
+    ui?: string | JSX.Element | JSX.Element[] | null | undefined;
     role: 'system' | 'user' | 'assistant' | 'function';
     /**
      * If the message has a role of `function`, the `name` field is the name of the function.

package/vue/dist/index.d.ts

@@ -42,6 +42,7 @@ interface Message {
     id: string;
     createdAt?: Date;
     content: string;
+    ui?: string | JSX.Element | JSX.Element[] | null | undefined;
     role: 'system' | 'user' | 'assistant' | 'function';
     /**
      * If the message has a role of `function`, the `name` field is the name of the function.