examples/next-anthropic/package.json

@@ -10,7 +10,7 @@
   },
   "dependencies": {
     "@anthropic-ai/sdk": "0.15.0",
-    "ai": "3.0.6",
+    "ai": "3.0.7",
     "next": "14.1.1",
     "react": "18.2.0",
     "react-dom": "^18.2.0"

examples/next-aws-bedrock/package.json

@@ -10,7 +10,7 @@
   },
   "dependencies": {
     "@aws-sdk/client-bedrock-runtime": "3.451.0",
-    "ai": "3.0.6",
+    "ai": "3.0.7",
     "next": "14.1.1",
     "react": "18.2.0",
     "react-dom": "^18.2.0"

examples/next-fireworks/package.json

@@ -9,7 +9,7 @@
     "lint": "next lint"
   },
   "dependencies": {
-    "ai": "3.0.6",
+    "ai": "3.0.7",
     "next": "14.1.1",
     "openai": "4.16.1",
     "react": "18.2.0",

examples/next-google-generative-ai/package.json

@@ -10,7 +10,7 @@
   },
   "dependencies": {
     "@google/generative-ai": "0.1.1",
-    "ai": "3.0.6",
+    "ai": "3.0.7",
     "next": "14.1.1",
     "react": "18.2.0",
     "react-dom": "^18.2.0"

examples/next-huggingface/package.json

@@ -11,7 +11,7 @@
   "dependencies": {
     "@huggingface/inference": "^2.5.1",
     "next": "14.1.1",
-    "ai": "3.0.6",
+    "ai": "3.0.7",
     "react": "18.2.0",
     "react-dom": "^18.2.0"
   },

examples/next-inkeep/package.json

@@ -10,7 +10,7 @@
   },
   "dependencies": {
     "@inkeep/ai-api": "^0.1.8",
-    "ai": "3.0.6",
+    "ai": "3.0.7",
     "next": "14.1.1",
     "react": "18.2.0",
     "react-dom": "^18.2.0"

examples/next-langchain/package.json

@@ -9,7 +9,7 @@
     "lint": "next lint"
   },
   "dependencies": {
-    "ai": "3.0.6",
+    "ai": "3.0.7",
     "langchain": "^0.0.196",
     "next": "14.1.1",
     "react": "18.2.0",

examples/next-mistral/package.json

@@ -9,7 +9,7 @@
     "lint": "next lint"
   },
   "dependencies": {
-    "ai": "3.0.6",
+    "ai": "3.0.7",
     "next": "14.1.1",
     "@mistralai/mistralai": "0.1.3",
     "react": "18.2.0",

examples/next-openai-pages/package.json

@@ -9,7 +9,7 @@
     "lint": "next lint"
   },
   "dependencies": {
-    "ai": "3.0.6",
+    "ai": "3.0.7",
     "next": "14.1.1",
     "openai": "4.16.1",
     "react": "18.2.0",

examples/next-openai-rate-limits/package.json

@@ -11,7 +11,7 @@
   "dependencies": {
     "@upstash/ratelimit": "^0.4.3",
     "@vercel/kv": "^0.2.2",
-    "ai": "3.0.6",
+    "ai": "3.0.7",
     "next": "14.1.1",
     "openai": "4.16.1",
     "react": "18.2.0",

examples/next-openai/package.json

@@ -9,7 +9,7 @@
     "lint": "next lint"
   },
   "dependencies": {
-    "ai": "3.0.6",
+    "ai": "3.0.7",
     "next": "14.1.1",
     "openai": "4.16.1",
     "react": "18.2.0",

examples/next-perplexity/package.json

@@ -9,7 +9,7 @@
     "lint": "next lint"
   },
   "dependencies": {
-    "ai": "3.0.6",
+    "ai": "3.0.7",
     "next": "14.1.1",
     "openai": "4.16.1",
     "react": "18.2.0",

examples/nuxt-openai/package.json

@@ -17,7 +17,7 @@
     "@vue/runtime-core": "^3.3.4",
     "@vue/runtime-dom": "^3.3.4",
     "@vue/shared": "^3.3.4",
-    "ai": "3.0.6",
+    "ai": "3.0.7",
     "nuxt": "^3.6.5",
     "openai": "4.16.1",
     "tailwindcss": "^3.3.3",

examples/solidstart-openai/package.json

@@ -18,7 +18,7 @@
   "dependencies": {
     "@solidjs/meta": "0.29.3",
     "@solidjs/router": "0.8.2",
-    "ai": "3.0.6",
+    "ai": "3.0.7",
     "openai": "4.16.1",
     "solid-js": "1.8.7",
     "solid-start": "0.3.10",

examples/sveltekit-openai/package.json

@@ -11,7 +11,7 @@
   },
   "dependencies": {
     "openai": "4.16.1",
-    "ai": "3.0.6"
+    "ai": "3.0.7"
   },
   "devDependencies": {
     "@fontsource/fira-mono": "^4.5.10",

packages/core/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 3.0.7
+
+### Patch Changes
+
+- 9a9ae73: feat(ai/rsc): readStreamableValue
+
 ## 3.0.6
 
 ### Patch Changes

packages/core/package.json

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

packages/core/rsc/index.ts

@@ -7,7 +7,7 @@ export type {
   createAI,
 } from './rsc-server';
 export type {
-  useStreamableValue,
+  readStreamableValue,
   useUIState,
   useAIState,
   useActions,

packages/core/rsc/rsc-client.ts

@@ -1,5 +1,5 @@
 export {
-  useStreamableValue,
+  readStreamableValue,
   useUIState,
   useAIState,
   useActions,

packages/core/rsc/rsc-shared.mts

@@ -1,7 +1,7 @@
 'use client';
 
 export {
-  useStreamableValue,
+  readStreamableValue,
   useUIState,
   useAIState,
   useActions,

packages/core/rsc/shared-client/index.ts

@@ -1,6 +1,6 @@
 'use client';
 
-export { useStreamableValue } from './hooks';
+export { readStreamableValue } from './streamable';
 export {
   useUIState,
   useAIState,

packages/core/rsc/shared-client/streamable.tsx

@@ -0,0 +1,100 @@
+import { STREAMABLE_VALUE_TYPE } from '../constants';
+import type { StreamableValue } from '../types';
+
+function assertStreamableValue(
+  value: unknown,
+): asserts value is StreamableValue {
+  if (
+    !value ||
+    typeof value !== 'object' ||
+    !('type' in value) ||
+    value.type !== STREAMABLE_VALUE_TYPE
+  ) {
+    throw new Error(
+      'Invalid value: this hook only accepts values created via `createValueStream` from the server.',
+    );
+  }
+}
+
+/**
+ * `readStreamableValue` takes a streamable value created via the `createStreamableValue().value` API,
+ * and returns an async iterator.
+ *
+ * ```js
+ * // Inside your AI action:
+ *
+ * async function action() {
+ *   'use server'
+ *   const streamable = createStreamableValue();
+ *
+ *   streamable.update(1);
+ *   streamable.update(2);
+ *   streamable.done(3);
+ *   // ...
+ *   return streamable.value;
+ * }
+ * ```
+ *
+ * And to read the value:
+ *
+ * ```js
+ * const streamableValue = await action()
+ * for await (const v of readStreamableValue(streamableValue)) {
+ *   console.log(v)
+ * }
+ * ```
+ *
+ * This logs out 1, 2, 3 on console.
+ */
+export function readStreamableValue<T = unknown>(
+  streamableValue: StreamableValue<T>,
+): AsyncIterable<T | undefined> {
+  assertStreamableValue(streamableValue);
+
+  return {
+    [Symbol.asyncIterator]() {
+      let row: StreamableValue<T> | Promise<StreamableValue<T>> =
+        streamableValue;
+      let curr = row.curr;
+      let done = false;
+
+      return {
+        async next() {
+          if (done) return { value: curr, done: true };
+
+          row = await row;
+
+          if (typeof row.error !== 'undefined') {
+            throw row.error;
+          }
+          if ('curr' in row) {
+            curr = row.curr;
+
+            // The last emitted { done: true } won't be used as the value
+            // by the for await...of syntax.
+            if (!row.next) {
+              done = true;
+              return {
+                value: curr,
+                done: false,
+              };
+            }
+          }
+
+          if (!row.next) {
+            return {
+              value: curr,
+              done: true,
+            };
+          }
+
+          row = row.next;
+          return {
+            value: curr,
+            done: false,
+          };
+        },
+      };
+    },
+  };
+}