@langchain/langgraph-sdk 0.0.43 → 0.0.44

package/dist/react/stream.cjs

@@ -26,6 +26,13 @@ class MessageTupleManager {
         this.chunks = {};
     }
     add(serialized) {
+        // TODO: this is sometimes sent from the API
+        // figure out how to prevent this or move this to LC.js
+        if (serialized.type.endsWith("MessageChunk")) {
+            serialized.type = serialized.type
+                .slice(0, -"MessageChunk".length)
+                .toLowerCase();
+        }
         const chunk = (0, messages_1.convertToChunk)((0, messages_1.coerceMessageLikeToMessage)(serialized));
         const id = chunk.id;
         if (!id)
@@ -195,7 +202,7 @@ function useStream(options) {
     const messageManagerRef = (0, react_1.useRef)(new MessageTupleManager());
     const submittingRef = (0, react_1.useRef)(false);
     const abortRef = (0, react_1.useRef)(null);
-    const trackStreamModeRef = (0, react_1.useRef)(["values", "messages-tuple"]);
+    const trackStreamModeRef = (0, react_1.useRef)(["values"]);
     const trackStreamMode = (0, react_1.useCallback)((mode) => {
         if (!trackStreamModeRef.current.includes(mode))
             trackStreamModeRef.current.push(mode);
@@ -376,6 +383,7 @@ function useStream(options) {
         catch (error) {
             if (!(error instanceof Error &&
                 (error.name === "AbortError" || error.name === "TimeoutError"))) {
+                console.error(error);
                 setStreamError(error);
                 onError?.(error);
             }
@@ -388,7 +396,7 @@ function useStream(options) {
             abortRef.current = null;
         }
     };
-    const error = isLoading ? streamError : historyError;
+    const error = streamError ?? historyError;
     const values = streamValues ?? historyValues;
     return {
         get values() {
@@ -403,6 +411,16 @@ function useStream(options) {
         setBranch,
         history: flatHistory,
         experimental_branchTree: rootSequence,
+        get interrupt() {
+            // Don't show the interrupt if the stream is loading
+            if (isLoading)
+                return undefined;
+            const interrupts = threadHead?.tasks?.at(-1)?.interrupts;
+            if (interrupts == null || interrupts.length === 0)
+                return undefined;
+            // Return only the current interrupt
+            return interrupts.at(-1);
+        },
         get messages() {
             trackStreamMode("messages-tuple");
             return getMessages(values);

package/dist/react/stream.d.ts

@@ -1,7 +1,7 @@
 import { type ClientConfig } from "../client.js";
 import type { Command, DisconnectMode, MultitaskStrategy, OnCompletionBehavior } from "../types.js";
 import type { Message } from "../types.messages.js";
-import type { Checkpoint, Config, Metadata, ThreadState } from "../schema.js";
+import type { Checkpoint, Config, Interrupt, Metadata, ThreadState } from "../schema.js";
 import type { CustomStreamEvent, MetadataStreamEvent, StreamMode, UpdatesStreamEvent } from "../types.stream.js";
 interface Node<StateType = any> {
     type: "node";
@@ -35,7 +35,25 @@ export type MessageMetadata<StateType extends Record<string, unknown>> = {
      */
     branchOptions: string[] | undefined;
 };
-interface UseStreamOptions<StateType extends Record<string, unknown> = Record<string, unknown>, UpdateType extends Record<string, unknown> = Partial<StateType>, CustomType = unknown> {
+type BagTemplate = {
+    ConfigurableType?: Record<string, unknown>;
+    InterruptType?: unknown;
+    CustomEventType?: unknown;
+    UpdateType?: unknown;
+};
+type GetUpdateType<Bag extends BagTemplate, StateType extends Record<string, unknown>> = Bag extends {
+    UpdateType: unknown;
+} ? Bag["UpdateType"] : Partial<StateType>;
+type GetConfigurableType<Bag extends BagTemplate> = Bag extends {
+    ConfigurableType: Record<string, unknown>;
+} ? Bag["ConfigurableType"] : Record<string, unknown>;
+type GetInterruptType<Bag extends BagTemplate> = Bag extends {
+    InterruptType: unknown;
+} ? Bag["InterruptType"] : unknown;
+type GetCustomEventType<Bag extends BagTemplate> = Bag extends {
+    CustomEventType: unknown;
+} ? Bag["CustomEventType"] : unknown;
+interface UseStreamOptions<StateType extends Record<string, unknown> = Record<string, unknown>, Bag extends BagTemplate = BagTemplate> {
     /**
      * The ID of the assistant to use.
      */
@@ -66,11 +84,11 @@ interface UseStreamOptions<StateType extends Record<string, unknown> = Record<st
     /**
      * Callback that is called when an update event is received.
      */
-    onUpdateEvent?: (data: UpdatesStreamEvent<UpdateType>["data"]) => void;
+    onUpdateEvent?: (data: UpdatesStreamEvent<GetUpdateType<Bag, StateType>>["data"]) => void;
     /**
      * Callback that is called when a custom event is received.
      */
-    onCustomEvent?: (data: CustomStreamEvent<CustomType>["data"]) => void;
+    onCustomEvent?: (data: CustomStreamEvent<GetCustomEventType<Bag>>["data"]) => void;
     /**
      * Callback that is called when a metadata event is received.
      */
@@ -84,7 +102,7 @@ interface UseStreamOptions<StateType extends Record<string, unknown> = Record<st
      */
     onThreadId?: (threadId: string) => void;
 }
-interface UseStream<StateType extends Record<string, unknown> = Record<string, unknown>, UpdateType extends Record<string, unknown> = Partial<StateType>> {
+interface UseStream<StateType extends Record<string, unknown> = Record<string, unknown>, Bag extends BagTemplate = BagTemplate> {
     /**
      * The current values of the thread.
      */
@@ -104,7 +122,7 @@ interface UseStream<StateType extends Record<string, unknown> = Record<string, u
     /**
      * Create and stream a run to the thread.
      */
-    submit: (values: UpdateType, options?: SubmitOptions<StateType>) => void;
+    submit: (values: GetUpdateType<Bag, StateType> | null | undefined, options?: SubmitOptions<StateType, GetConfigurableType<Bag>>) => void;
     /**
      * The current branch of the thread.
      */
@@ -122,6 +140,10 @@ interface UseStream<StateType extends Record<string, unknown> = Record<string, u
      * @experimental
      */
     experimental_branchTree: Sequence<StateType>;
+    /**
+     * Get the interrupt value for the stream if interrupted.
+     */
+    interrupt: Interrupt<GetInterruptType<Bag>> | undefined;
     /**
      * Messages inferred from the thread.
      * Will automatically update with incoming message chunks.
@@ -137,8 +159,11 @@ interface UseStream<StateType extends Record<string, unknown> = Record<string, u
      */
     getMessagesMetadata: (message: Message, index?: number) => MessageMetadata<StateType> | undefined;
 }
-interface SubmitOptions<StateType extends Record<string, unknown> = Record<string, unknown>> {
-    config?: Config;
+type ConfigWithConfigurable<ConfigurableType extends Record<string, unknown>> = Config & {
+    configurable?: ConfigurableType;
+};
+interface SubmitOptions<StateType extends Record<string, unknown> = Record<string, unknown>, ConfigurableType extends Record<string, unknown> = Record<string, unknown>> {
+    config?: ConfigWithConfigurable<ConfigurableType>;
     checkpoint?: Omit<Checkpoint, "thread_id"> | null;
     command?: Command;
     interruptBefore?: "*" | string[];
@@ -151,5 +176,10 @@ interface SubmitOptions<StateType extends Record<string, unknown> = Record<strin
     streamMode?: Array<StreamMode>;
     optimisticValues?: Partial<StateType> | ((prev: StateType) => Partial<StateType>);
 }
-export declare function useStream<StateType extends Record<string, unknown> = Record<string, unknown>, UpdateType extends Record<string, unknown> = Partial<StateType>, CustomType = unknown>(options: UseStreamOptions<StateType, UpdateType, CustomType>): UseStream<StateType, UpdateType>;
+export declare function useStream<StateType extends Record<string, unknown> = Record<string, unknown>, Bag extends {
+    ConfigurableType?: Record<string, unknown>;
+    InterruptType?: unknown;
+    CustomEventType?: unknown;
+    UpdateType?: unknown;
+} = BagTemplate>(options: UseStreamOptions<StateType, Bag>): UseStream<StateType, Bag>;
 export {};

package/dist/react/stream.js

@@ -23,6 +23,13 @@ class MessageTupleManager {
         this.chunks = {};
     }
     add(serialized) {
+        // TODO: this is sometimes sent from the API
+        // figure out how to prevent this or move this to LC.js
+        if (serialized.type.endsWith("MessageChunk")) {
+            serialized.type = serialized.type
+                .slice(0, -"MessageChunk".length)
+                .toLowerCase();
+        }
         const chunk = convertToChunk(coerceMessageLikeToMessage(serialized));
         const id = chunk.id;
         if (!id)
@@ -192,7 +199,7 @@ export function useStream(options) {
     const messageManagerRef = useRef(new MessageTupleManager());
     const submittingRef = useRef(false);
     const abortRef = useRef(null);
-    const trackStreamModeRef = useRef(["values", "messages-tuple"]);
+    const trackStreamModeRef = useRef(["values"]);
     const trackStreamMode = useCallback((mode) => {
         if (!trackStreamModeRef.current.includes(mode))
             trackStreamModeRef.current.push(mode);
@@ -373,6 +380,7 @@ export function useStream(options) {
         catch (error) {
             if (!(error instanceof Error &&
                 (error.name === "AbortError" || error.name === "TimeoutError"))) {
+                console.error(error);
                 setStreamError(error);
                 onError?.(error);
             }
@@ -385,7 +393,7 @@ export function useStream(options) {
             abortRef.current = null;
         }
     };
-    const error = isLoading ? streamError : historyError;
+    const error = streamError ?? historyError;
     const values = streamValues ?? historyValues;
     return {
         get values() {
@@ -400,6 +408,16 @@ export function useStream(options) {
         setBranch,
         history: flatHistory,
         experimental_branchTree: rootSequence,
+        get interrupt() {
+            // Don't show the interrupt if the stream is loading
+            if (isLoading)
+                return undefined;
+            const interrupts = threadHead?.tasks?.at(-1)?.interrupts;
+            if (interrupts == null || interrupts.length === 0)
+                return undefined;
+            // Return only the current interrupt
+            return interrupts.at(-1);
+        },
         get messages() {
             trackStreamMode("messages-tuple");
             return getMessages(values);

package/dist/schema.d.ts

@@ -103,8 +103,8 @@ export interface AssistantGraph {
 /**
  * An interrupt thrown inside a thread.
  */
-export interface Interrupt {
-    value: unknown;
+export interface Interrupt<TValue = unknown> {
+    value: TValue;
     when: "during";
     resumable: boolean;
     ns?: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/langgraph-sdk",
-  "version": "0.0.43",
+  "version": "0.0.44",
   "description": "Client library for interacting with the LangGraph API",
   "type": "module",
   "packageManager": "yarn@1.22.19",