fix(ai/rsc): Improve typings for StreamableValue (#1225)

Author: shuding

.changeset/eight-points-dress.md

@@ -0,0 +1,5 @@
+---
+'ai': patch
+---
+
+fix(ai/rsc): improve typings for `StreamableValue`

packages/core/rsc/streamable.tsx

@@ -213,7 +213,9 @@ export function createStreamableValue<T = any, E = any>(initialValue?: T) {
 
   return {
     /**
-     * The value of the streamable. This can be returned from a Server Action and received by the client.
+     * The value of the streamable. This can be returned from a Server Action and
+     * received by the client. To read the streamed values, use the
+     * `readStreamableValue` API.
      */
     get value() {
       return createWrapped(true);

packages/core/rsc/types.ts

@@ -89,10 +89,29 @@ export type MutableAIState<AIState> = {
 
 export type StreamablePatch = undefined | [0, string]; // Append string.
 
+/**
+ * StreamableValue is a value that can be streamed over the network via AI Actions.
+ * To read the streamed values, use the `readStreamableValue` API.
+ */
 export type StreamableValue<T = any, E = any> = {
+  /**
+   * @internal Use `readStreamableValue` to read the values.
+   */
   type?: typeof STREAMABLE_VALUE_TYPE;
+  /**
+   * @internal Use `readStreamableValue` to read the values.
+   */
   curr?: T;
+  /**
+   * @internal Use `readStreamableValue` to read the values.
+   */
   error?: E;
+  /**
+   * @internal Use `readStreamableValue` to read the values.
+   */
   diff?: StreamablePatch;
+  /**
+   * @internal Use `readStreamableValue` to read the values.
+   */
   next?: Promise<StreamableValue<T, E>>;
 };

packages/core/tsconfig.json

@@ -1,7 +1,8 @@
 {
   "extends": "./node_modules/@vercel/ai-tsconfig/react-library.json",
   "compilerOptions": {
-    "target": "ES2018"
+    "target": "ES2018",
+    "stripInternal": true
   },
   "include": ["."],
   "exclude": ["dist", "build", "node_modules"]