ai 3.1.16 → 3.1.18

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

@@ -1,4 +1,3 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ReactNode } from 'react';
 import OpenAI from 'openai';
 import { z } from 'zod';
@@ -41,8 +40,8 @@ type StreamableValue<T = any, E = any> = {};
  * @example const state = getAIState() // Get the entire AI state
  * @example const field = getAIState('key') // Get the value of the key
  */
-declare function getAIState<AI extends AIProvider = any>(): InferAIState<AI, any>;
-declare function getAIState<AI extends AIProvider = any>(key: keyof InferAIState<AI, any>): InferAIState<AI, any>[typeof key];
+declare function getAIState<AI extends AIProvider = any>(): Readonly<InferAIState<AI, any>>;
+declare function getAIState<AI extends AIProvider = any>(key: keyof InferAIState<AI, any>): Readonly<InferAIState<AI, any>[typeof key]>;
 /**
  * Get the mutable AI state. Note that you must call `.close()` when finishing
  * updating the AI state.
@@ -64,19 +63,15 @@ declare function getAIState<AI extends AIProvider = any>(key: keyof InferAIState
 declare function getMutableAIState<AI extends AIProvider = any>(): MutableAIState<InferAIState<AI, any>>;
 declare function getMutableAIState<AI extends AIProvider = any>(key: keyof InferAIState<AI, any>): MutableAIState<InferAIState<AI, any>[typeof key]>;
 
-/**
- * Create a piece of changable UI that can be streamed to the client.
- * On the client side, it can be rendered as a normal React node.
- */
-declare function createStreamableUI(initialValue?: React.ReactNode): {
+type StreamableUIWrapper = {
     /**
      * The value of the streamable UI. This can be returned from a Server Action and received by the client.
      */
-    value: react_jsx_runtime.JSX.Element;
+    readonly value: React.ReactNode;
     /**
      * This method updates the current UI node. It takes a new UI node and replaces the old one.
      */
-    update(value: React.ReactNode): any;
+    update(value: React.ReactNode): StreamableUIWrapper;
     /**
      * This method is used to append a new UI node to the end of the old one.
      * Once appended a new UI node, the previous UI node cannot be updated anymore.
@@ -93,31 +88,31 @@ declare function createStreamableUI(initialValue?: React.ReactNode): {
      * // </>
      * ```
      */
-    append(value: React.ReactNode): any;
+    append(value: React.ReactNode): StreamableUIWrapper;
     /**
      * This method is used to signal that there is an error in the UI stream.
      * It will be thrown on the client side and caught by the nearest error boundary component.
      */
-    error(error: any): any;
+    error(error: any): StreamableUIWrapper;
     /**
      * This method marks the UI node as finalized. You can either call it without any parameters or with a new UI node as the final state.
      * Once called, the UI node cannot be updated or appended anymore.
      *
      * This method is always **required** to be called, otherwise the response will be stuck in a loading state.
      */
-    done(...args: [] | [React.ReactNode]): any;
+    done(...args: [React.ReactNode] | []): StreamableUIWrapper;
 };
-declare const STREAMABLE_VALUE_INTERNAL_LOCK: unique symbol;
+/**
+ * Create a piece of changable UI that can be streamed to the client.
+ * On the client side, it can be rendered as a normal React node.
+ */
+declare function createStreamableUI(initialValue?: React.ReactNode): StreamableUIWrapper;
 /**
  * Create a wrapped, changable value that can be streamed to the client.
  * On the client side, the value can be accessed via the readStreamableValue() API.
  */
-declare function createStreamableValue<T = any, E = any>(initialValue?: T | ReadableStream<T>): {
-    /**
-     * @internal This is an internal lock to prevent the value from being
-     * updated by the user.
-     */
-    [STREAMABLE_VALUE_INTERNAL_LOCK]: boolean;
+declare function createStreamableValue<T = any, E = any>(initialValue?: T | ReadableStream<T>): StreamableValueWrapper<T, E>;
+type StreamableValueWrapper<T, E> = {
     /**
      * 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
@@ -127,7 +122,7 @@ declare function createStreamableValue<T = any, E = any>(initialValue?: T | Read
     /**
      * This method updates the current value with a new one.
      */
-    update(value: T): any;
+    update(value: T): StreamableValueWrapper<T, E>;
     /**
      * This method is used to append a delta string to the current value. It
      * requires the current value of the streamable to be a string.
@@ -140,13 +135,13 @@ declare function createStreamableValue<T = any, E = any>(initialValue?: T | Read
      * // The value will be 'hello world'
      * ```
      */
-    append(value: T): any;
+    append(value: T): StreamableValueWrapper<T, E>;
     /**
      * This method is used to signal that there is an error in the value stream.
      * It will be thrown on the client side when consumed via
      * `readStreamableValue` or `useStreamableValue`.
      */
-    error(error: any): any;
+    error(error: any): StreamableValueWrapper<T, E>;
     /**
      * This method marks the value as finalized. You can either call it without
      * any parameters or with a new value as the final state.
@@ -155,7 +150,7 @@ declare function createStreamableValue<T = any, E = any>(initialValue?: T | Read
      * This method is always **required** to be called, otherwise the response
      * will be stuck in a loading state.
      */
-    done(...args: [] | [T]): any;
+    done(...args: [T] | []): StreamableValueWrapper<T, E>;
 };
 
 type Streamable$1 = ReactNode | Promise<ReactNode>;

package/rsc/dist/rsc-server.mjs

@@ -1242,13 +1242,7 @@ function createStreamableUI(initialValue) {
   }
   warnUnclosedStream();
   const streamable2 = {
-    /**
-     * The value of the streamable UI. This can be returned from a Server Action and received by the client.
-     */
     value: row,
-    /**
-     * This method updates the current UI node. It takes a new UI node and replaces the old one.
-     */
     update(value) {
       assertStream(".update()");
       if (value === currentValue) {
@@ -1263,22 +1257,6 @@ function createStreamableUI(initialValue) {
       warnUnclosedStream();
       return streamable2;
     },
-    /**
-     * This method is used to append a new UI node to the end of the old one.
-     * Once appended a new UI node, the previous UI node cannot be updated anymore.
-     *
-     * @example
-     * ```jsx
-     * const ui = createStreamableUI(<div>hello</div>)
-     * ui.append(<div>world</div>)
-     *
-     * // The UI node will be:
-     * // <>
-     * //   <div>hello</div>
-     * //   <div>world</div>
-     * // </>
-     * ```
-     */
     append(value) {
       assertStream(".append()");
       const resolvable = createResolvablePromise();
@@ -1289,10 +1267,6 @@ function createStreamableUI(initialValue) {
       warnUnclosedStream();
       return streamable2;
     },
-    /**
-     * This method is used to signal that there is an error in the UI stream.
-     * It will be thrown on the client side and caught by the nearest error boundary component.
-     */
     error(error) {
       assertStream(".error()");
       if (warningTimeout) {
@@ -1302,12 +1276,6 @@ function createStreamableUI(initialValue) {
       reject(error);
       return streamable2;
     },
-    /**
-     * This method marks the UI node as finalized. You can either call it without any parameters or with a new UI node as the final state.
-     * Once called, the UI node cannot be updated or appended anymore.
-     *
-     * This method is always **required** to be called, otherwise the response will be stuck in a loading state.
-     */
     done(...args) {
       assertStream(".done()");
       if (warningTimeout) {
@@ -1420,24 +1388,12 @@ function createStreamableValueImpl(initialValue) {
     currentValue = value;
   }
   const streamable2 = {
-    /**
-     * @internal This is an internal lock to prevent the value from being
-     * updated by the user.
-     */
     set [STREAMABLE_VALUE_INTERNAL_LOCK](state) {
       locked = state;
     },
-    /**
-     * 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` or `useStreamableValue` APIs.
-     */
     get value() {
       return createWrapped(true);
     },
-    /**
-     * This method updates the current value with a new one.
-     */
     update(value) {
       assertStream(".update()");
       const resolvePrevious = resolvable.resolve;
@@ -1448,18 +1404,6 @@ function createStreamableValueImpl(initialValue) {
       warnUnclosedStream();
       return streamable2;
     },
-    /**
-     * This method is used to append a delta string to the current value. It
-     * requires the current value of the streamable to be a string.
-     *
-     * @example
-     * ```jsx
-     * const streamable = createStreamableValue('hello');
-     * streamable.append(' world');
-     *
-     * // The value will be 'hello world'
-     * ```
-     */
     append(value) {
       assertStream(".append()");
       if (typeof currentValue !== "string" && typeof currentValue !== "undefined") {
@@ -1486,11 +1430,6 @@ function createStreamableValueImpl(initialValue) {
       warnUnclosedStream();
       return streamable2;
     },
-    /**
-     * This method is used to signal that there is an error in the value stream.
-     * It will be thrown on the client side when consumed via
-     * `readStreamableValue` or `useStreamableValue`.
-     */
     error(error) {
       assertStream(".error()");
       if (warningTimeout) {
@@ -1502,14 +1441,6 @@ function createStreamableValueImpl(initialValue) {
       resolvable.resolve({ error });
       return streamable2;
     },
-    /**
-     * This method marks the value as finalized. You can either call it without
-     * any parameters or with a new value as the final state.
-     * Once called, the value cannot be updated or appended anymore.
-     *
-     * This method is always **required** to be called, otherwise the response
-     * will be stuck in a loading state.
-     */
     done(...args) {
       assertStream(".done()");
       if (warningTimeout) {