@langchain/langgraph-sdk 0.0.54 → 0.0.57

package/dist/client.cjs

@@ -686,6 +686,12 @@ class RunsClient extends BaseClient {
      *
      * @param threadId The ID of the thread.
      * @param runId The ID of the run.
+     * @param options Additional options for controlling the stream behavior:
+     *   - signal: An AbortSignal that can be used to cancel the stream request
+     *   - cancelOnDisconnect: When true, automatically cancels the run if the client disconnects from the stream
+     *   - streamMode: Controls what types of events to receive from the stream (can be a single mode or array of modes)
+     *        Must be a subset of the stream modes passed when creating the run. Background runs default to having the union of all
+     *        stream modes enabled.
      * @returns An async generator yielding stream parts.
      */
     async *joinStream(threadId, runId, options) {
@@ -698,7 +704,10 @@ class RunsClient extends BaseClient {
             method: "GET",
             timeoutMs: null,
             signal: opts?.signal,
-            params: { cancel_on_disconnect: opts?.cancelOnDisconnect ? "1" : "0" },
+            params: {
+                cancel_on_disconnect: opts?.cancelOnDisconnect ? "1" : "0",
+                stream_mode: opts?.streamMode,
+            },
         }));
         const stream = (response.body || new ReadableStream({ start: (ctrl) => ctrl.close() }))
             .pipeThrough(new sse_js_1.BytesLineDecoder())

package/dist/client.d.ts

@@ -364,11 +364,18 @@ export declare class RunsClient<TStateType = DefaultValues, TUpdateType = TState
      *
      * @param threadId The ID of the thread.
      * @param runId The ID of the run.
+     * @param options Additional options for controlling the stream behavior:
+     *   - signal: An AbortSignal that can be used to cancel the stream request
+     *   - cancelOnDisconnect: When true, automatically cancels the run if the client disconnects from the stream
+     *   - streamMode: Controls what types of events to receive from the stream (can be a single mode or array of modes)
+     *        Must be a subset of the stream modes passed when creating the run. Background runs default to having the union of all
+     *        stream modes enabled.
      * @returns An async generator yielding stream parts.
      */
     joinStream(threadId: string, runId: string, options?: {
         signal?: AbortSignal;
         cancelOnDisconnect?: boolean;
+        streamMode?: StreamMode | StreamMode[];
     } | AbortSignal): AsyncGenerator<{
         event: StreamEvent;
         data: any;

package/dist/client.js

@@ -679,6 +679,12 @@ export class RunsClient extends BaseClient {
      *
      * @param threadId The ID of the thread.
      * @param runId The ID of the run.
+     * @param options Additional options for controlling the stream behavior:
+     *   - signal: An AbortSignal that can be used to cancel the stream request
+     *   - cancelOnDisconnect: When true, automatically cancels the run if the client disconnects from the stream
+     *   - streamMode: Controls what types of events to receive from the stream (can be a single mode or array of modes)
+     *        Must be a subset of the stream modes passed when creating the run. Background runs default to having the union of all
+     *        stream modes enabled.
      * @returns An async generator yielding stream parts.
      */
     async *joinStream(threadId, runId, options) {
@@ -691,7 +697,10 @@ export class RunsClient extends BaseClient {
             method: "GET",
             timeoutMs: null,
             signal: opts?.signal,
-            params: { cancel_on_disconnect: opts?.cancelOnDisconnect ? "1" : "0" },
+            params: {
+                cancel_on_disconnect: opts?.cancelOnDisconnect ? "1" : "0",
+                stream_mode: opts?.streamMode,
+            },
         }));
         const stream = (response.body || new ReadableStream({ start: (ctrl) => ctrl.close() }))
             .pipeThrough(new BytesLineDecoder())

package/dist/react-ui/server/server.cjs

@@ -2,8 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.typedUi = void 0;
 const uuid_1 = require("uuid");
-const typedUi = (config) => {
+/**
+ * Helper to send and persist UI messages. Accepts a map of component names to React components
+ * as type argument to provide type safety. Will also write to the `options?.stateKey` state.
+ *
+ * @param config LangGraphRunnableConfig
+ * @param options
+ * @returns
+ */
+const typedUi = (config, options) => {
     let items = [];
+    const stateKey = options?.stateKey ?? "ui";
     const runId = config.metadata?.run_id ?? config.runId;
     if (!runId)
         throw new Error("run_id is required");
@@ -27,12 +36,14 @@ const typedUi = (config) => {
         };
         items.push(evt);
         config.writer?.(evt);
+        config.configurable?.__pregel_send?.([[stateKey, evt]]);
         return evt;
     };
     const handleDelete = (id) => {
         const evt = { type: "remove-ui", id };
         items.push(evt);
         config.writer?.(evt);
+        config.configurable?.__pregel_send?.([[stateKey, evt]]);
         return evt;
     };
     return { push: handlePush, delete: handleDelete, items };

package/dist/react-ui/server/server.d.ts

@@ -3,12 +3,27 @@ import type { RemoveUIMessage, UIMessage } from "../types.js";
 interface MessageLike {
     id?: string;
 }
+/**
+ * Helper to send and persist UI messages. Accepts a map of component names to React components
+ * as type argument to provide type safety. Will also write to the `options?.stateKey` state.
+ *
+ * @param config LangGraphRunnableConfig
+ * @param options
+ * @returns
+ */
 export declare const typedUi: <Decl extends Record<string, ElementType>>(config: {
     writer?: (chunk: unknown) => void;
     runId?: string;
     metadata?: Record<string, unknown>;
     tags?: string[];
     runName?: string;
+    configurable?: {
+        __pregel_send?: (writes_: [string, unknown][]) => void;
+        [key: string]: unknown;
+    };
+}, options?: {
+    /** The key to write the UI messages to. Defaults to `ui`. */
+    stateKey?: string;
 }) => {
     push: <K extends keyof Decl & string>(message: {
         id?: string | undefined;

package/dist/react-ui/server/server.js

@@ -1,6 +1,15 @@
 import { v4 as uuidv4 } from "uuid";
-export const typedUi = (config) => {
+/**
+ * Helper to send and persist UI messages. Accepts a map of component names to React components
+ * as type argument to provide type safety. Will also write to the `options?.stateKey` state.
+ *
+ * @param config LangGraphRunnableConfig
+ * @param options
+ * @returns
+ */
+export const typedUi = (config, options) => {
     let items = [];
+    const stateKey = options?.stateKey ?? "ui";
     const runId = config.metadata?.run_id ?? config.runId;
     if (!runId)
         throw new Error("run_id is required");
@@ -24,12 +33,14 @@ export const typedUi = (config) => {
         };
         items.push(evt);
         config.writer?.(evt);
+        config.configurable?.__pregel_send?.([[stateKey, evt]]);
         return evt;
     };
     const handleDelete = (id) => {
         const evt = { type: "remove-ui", id };
         items.push(evt);
         config.writer?.(evt);
+        config.configurable?.__pregel_send?.([[stateKey, evt]]);
         return evt;
     };
     return { push: handlePush, delete: handleDelete, items };

package/package.json

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