ai 3.1.0 → 3.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "3.1.0",
+  "version": "3.1.2",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -102,8 +102,8 @@
     "typescript": "5.1.3",
     "vite-plugin-solid": "2.7.2",
     "zod": "3.22.4",
-    "@vercel/ai-tsconfig": "0.0.0",
-    "eslint-config-vercel-ai": "0.0.0"
+    "eslint-config-vercel-ai": "0.0.0",
+    "@vercel/ai-tsconfig": "0.0.0"
   },
   "peerDependencies": {
     "react": "^18.2.0",

package/rsc/dist/index.d.ts

@@ -164,9 +164,11 @@ type Streamable$1 = ReactNode | Promise<ReactNode>;
 type Renderer$1<T> = (props: T) => Streamable$1 | Generator<Streamable$1, Streamable$1, void> | AsyncGenerator<Streamable$1, Streamable$1, void>;
 /**
  * `render` is a helper function to create a streamable UI from some LLMs.
- * Currently, it only supports OpenAI's GPT models with Function Calling and Assistants Tools.
+ * This API only supports OpenAI's GPT models with Function Calling and Assistants Tools,
+ * please use `streamUI` for compatibility with other providers.
  *
- * @deprecated It's recommended to use the `experimental_streamUI` API for compatibility with the new core APIs.
+ * @deprecated It's recommended to use the `streamUI` API for compatibility with AI SDK Core APIs
+ * and future features. This API will be removed in a future release.
  */
 declare function render<TS extends {
     [name: string]: z.Schema;
@@ -443,9 +445,9 @@ type RenderResult = {
     value: ReactNode;
 } & Awaited<ReturnType<LanguageModelV1['doStream']>>;
 /**
- * `experimental_streamUI` is a helper function to create a streamable UI from LLMs.
+ * `streamUI` is a helper function to create a streamable UI from LLMs.
  */
-declare function experimental_streamUI<TOOLS extends {
+declare function streamUI<TOOLS extends {
     [name: string]: z.ZodTypeAny;
 } = {}>({ model, tools, system, prompt, messages, maxRetries, abortSignal, initial, text, ...settings }: CallSettings & Prompt & {
     /**
@@ -564,4 +566,4 @@ declare function useAIState<AI extends AIProvider = any>(key: keyof InferAIState
 declare function useActions<AI extends AIProvider = any>(): InferActions<AI, any>;
 declare function useSyncUIState(): () => Promise<void>;
 
-export { StreamableValue, createAI, createStreamableUI, createStreamableValue, experimental_streamUI, getAIState, getMutableAIState, readStreamableValue, render, useAIState, useActions, useStreamableValue, useSyncUIState, useUIState };
+export { StreamableValue, createAI, createStreamableUI, createStreamableValue, getAIState, getMutableAIState, readStreamableValue, render, streamUI, useAIState, useActions, useStreamableValue, useSyncUIState, useUIState };

package/rsc/dist/rsc-server.d.mts

@@ -162,9 +162,11 @@ type Streamable$1 = ReactNode | Promise<ReactNode>;
 type Renderer$1<T> = (props: T) => Streamable$1 | Generator<Streamable$1, Streamable$1, void> | AsyncGenerator<Streamable$1, Streamable$1, void>;
 /**
  * `render` is a helper function to create a streamable UI from some LLMs.
- * Currently, it only supports OpenAI's GPT models with Function Calling and Assistants Tools.
+ * This API only supports OpenAI's GPT models with Function Calling and Assistants Tools,
+ * please use `streamUI` for compatibility with other providers.
  *
- * @deprecated It's recommended to use the `experimental_streamUI` API for compatibility with the new core APIs.
+ * @deprecated It's recommended to use the `streamUI` API for compatibility with AI SDK Core APIs
+ * and future features. This API will be removed in a future release.
  */
 declare function render<TS extends {
     [name: string]: z.Schema;
@@ -441,9 +443,9 @@ type RenderResult = {
     value: ReactNode;
 } & Awaited<ReturnType<LanguageModelV1['doStream']>>;
 /**
- * `experimental_streamUI` is a helper function to create a streamable UI from LLMs.
+ * `streamUI` is a helper function to create a streamable UI from LLMs.
  */
-declare function experimental_streamUI<TOOLS extends {
+declare function streamUI<TOOLS extends {
     [name: string]: z.ZodTypeAny;
 } = {}>({ model, tools, system, prompt, messages, maxRetries, abortSignal, initial, text, ...settings }: CallSettings & Prompt & {
     /**
@@ -500,4 +502,4 @@ declare function createAI<AIState = any, UIState = any, Actions extends AIAction
     onGetUIState?: OnGetUIState<UIState>;
 }): AIProvider<AIState, UIState, Actions>;
 
-export { createAI, createStreamableUI, createStreamableValue, experimental_streamUI, getAIState, getMutableAIState, render };
+export { createAI, createStreamableUI, createStreamableValue, getAIState, getMutableAIState, render, streamUI };

package/rsc/dist/rsc-server.mjs

@@ -1581,7 +1581,7 @@ import {
 } from "@ai-sdk/provider";
 import { safeParseJSON } from "@ai-sdk/provider-utils";
 var defaultTextRenderer = ({ content }) => content;
-async function experimental_streamUI({
+async function streamUI({
   model,
   tools,
   system,
@@ -1595,24 +1595,24 @@ async function experimental_streamUI({
 }) {
   if (typeof model === "string") {
     throw new Error(
-      "`model` cannot be a string in `experimental_streamUI`. Use the actual model instance instead."
+      "`model` cannot be a string in `streamUI`. Use the actual model instance instead."
     );
   }
   if ("functions" in settings) {
     throw new Error(
-      "`functions` is not supported in `experimental_streamUI`, use `tools` instead."
+      "`functions` is not supported in `streamUI`, use `tools` instead."
     );
   }
   if ("provider" in settings) {
     throw new Error(
-      "`provider` is no longer needed in `experimental_streamUI`. Use `model` instead."
+      "`provider` is no longer needed in `streamUI`. Use `model` instead."
     );
   }
   if (tools) {
     for (const [name, tool] of Object.entries(tools)) {
       if ("render" in tool) {
         throw new Error(
-          "Tool definition in `experimental_streamUI` should not have `render` property. Use `generate` instead. Found in tool: " + name
+          "Tool definition in `streamUI` should not have `render` property. Use `generate` instead. Found in tool: " + name
         );
       }
     }
@@ -1835,9 +1835,9 @@ export {
   createAI,
   createStreamableUI,
   createStreamableValue,
-  experimental_streamUI,
   getAIState,
   getMutableAIState,
-  render
+  render,
+  streamUI
 };
 //# sourceMappingURL=rsc-server.mjs.map