@langchain/langgraph-sdk 0.0.105 → 0.0.107

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @langchain/langgraph-sdk
 
+## 0.0.107
+
+### Patch Changes
+
+- 72386a4: feat(sdk): expose stream metadata from messages via `getMessagesMetadata`
+- 3ee5c20: fix(sdk): avoid setting `messages-tuple` if only `getMessagesMetadata` is requested.
+
+## 0.0.106
+
+### Patch Changes
+
+- feat(sdk): allow setting `checkpoint: null` when submitting a run via useStream
+
 ## 0.0.105
 
 ### Patch Changes

package/dist/react/stream.cjs

@@ -34,7 +34,7 @@ class MessageTupleManager {
         });
         this.chunks = {};
     }
-    add(serialized) {
+    add(serialized, metadata) {
         // 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")) {
@@ -51,6 +51,7 @@ class MessageTupleManager {
             return null;
         }
         this.chunks[id] ??= {};
+        this.chunks[id].metadata = metadata ?? this.chunks[id].metadata;
         if (chunk) {
             const prev = this.chunks[id].chunk;
             this.chunks[id].chunk =
@@ -67,7 +68,8 @@ class MessageTupleManager {
     get(id, defaultIndex) {
         if (this.chunks[id] == null)
             return null;
-        this.chunks[id].index ??= defaultIndex;
+        if (defaultIndex != null)
+            this.chunks[id].index ??= defaultIndex;
         return this.chunks[id];
     }
 }
@@ -396,6 +398,9 @@ function useStream(options) {
         const alreadyShown = new Set();
         return getMessages(historyValues).map((message, idx) => {
             const messageId = message.id ?? idx;
+            const streamMetadata = message.id != null
+                ? messageManagerRef.current.get(message.id)?.metadata ?? undefined
+                : undefined;
             const firstSeenIdx = findLastIndex(history.data ?? [], (state) => getMessages(state.values)
                 .map((m, idx) => m.id ?? idx)
                 .includes(messageId));
@@ -418,6 +423,7 @@ function useStream(options) {
                 firstSeenState: firstSeen,
                 branch: branch?.branch,
                 branchOptions: branch?.branchOptions,
+                streamMetadata,
             };
         });
     })();
@@ -478,8 +484,8 @@ function useStream(options) {
                     // if `streamSubgraphs: true`, then we also want
                     // to also receive messages from subgraphs
                     event.startsWith("messages|")) {
-                    const [serialized] = data;
-                    const messageId = messageManagerRef.current.add(serialized);
+                    const [serialized, metadata] = data;
+                    const messageId = messageManagerRef.current.add(serialized, metadata);
                     if (!messageId) {
                         console.warn("Failed to add message to manager, no message ID found");
                         continue;
@@ -580,7 +586,11 @@ function useStream(options) {
                 ...trackStreamModeRef.current,
                 ...callbackStreamMode,
             ]);
-            const checkpoint = submitOptions?.checkpoint ?? threadHead?.checkpoint ?? undefined;
+            let checkpoint = submitOptions?.checkpoint ?? threadHead?.checkpoint ?? undefined;
+            // Avoid specifying a checkpoint if user explicitly set it to null
+            if (submitOptions?.checkpoint === null) {
+                checkpoint = undefined;
+            }
             // eslint-disable-next-line @typescript-eslint/ban-ts-comment
             // @ts-expect-error
             if (checkpoint != null)
@@ -698,7 +708,7 @@ function useStream(options) {
             return getMessages(values);
         },
         getMessagesMetadata(message, index) {
-            trackStreamMode("messages-tuple", "values");
+            trackStreamMode("values");
             return messageMetadata?.find((m) => m.messageId === (message.id ?? index));
         },
     };

package/dist/react/stream.d.ts

@@ -34,6 +34,11 @@ export type MessageMetadata<StateType extends Record<string, unknown>> = {
      * This is useful for displaying branching controls.
      */
     branchOptions: string[] | undefined;
+    /**
+     * Metadata sent alongside the message during run streaming.
+     * @remarks This metadata only exists temporarily in browser memory during streaming and is not persisted after completion.
+     */
+    streamMetadata: Record<string, unknown> | undefined;
 };
 type BagTemplate = {
     ConfigurableType?: Record<string, unknown>;

package/dist/react/stream.js

@@ -30,7 +30,7 @@ class MessageTupleManager {
         });
         this.chunks = {};
     }
-    add(serialized) {
+    add(serialized, metadata) {
         // 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")) {
@@ -47,6 +47,7 @@ class MessageTupleManager {
             return null;
         }
         this.chunks[id] ??= {};
+        this.chunks[id].metadata = metadata ?? this.chunks[id].metadata;
         if (chunk) {
             const prev = this.chunks[id].chunk;
             this.chunks[id].chunk =
@@ -63,7 +64,8 @@ class MessageTupleManager {
     get(id, defaultIndex) {
         if (this.chunks[id] == null)
             return null;
-        this.chunks[id].index ??= defaultIndex;
+        if (defaultIndex != null)
+            this.chunks[id].index ??= defaultIndex;
         return this.chunks[id];
     }
 }
@@ -392,6 +394,9 @@ export function useStream(options) {
         const alreadyShown = new Set();
         return getMessages(historyValues).map((message, idx) => {
             const messageId = message.id ?? idx;
+            const streamMetadata = message.id != null
+                ? messageManagerRef.current.get(message.id)?.metadata ?? undefined
+                : undefined;
             const firstSeenIdx = findLastIndex(history.data ?? [], (state) => getMessages(state.values)
                 .map((m, idx) => m.id ?? idx)
                 .includes(messageId));
@@ -414,6 +419,7 @@ export function useStream(options) {
                 firstSeenState: firstSeen,
                 branch: branch?.branch,
                 branchOptions: branch?.branchOptions,
+                streamMetadata,
             };
         });
     })();
@@ -474,8 +480,8 @@ export function useStream(options) {
                     // if `streamSubgraphs: true`, then we also want
                     // to also receive messages from subgraphs
                     event.startsWith("messages|")) {
-                    const [serialized] = data;
-                    const messageId = messageManagerRef.current.add(serialized);
+                    const [serialized, metadata] = data;
+                    const messageId = messageManagerRef.current.add(serialized, metadata);
                     if (!messageId) {
                         console.warn("Failed to add message to manager, no message ID found");
                         continue;
@@ -576,7 +582,11 @@ export function useStream(options) {
                 ...trackStreamModeRef.current,
                 ...callbackStreamMode,
             ]);
-            const checkpoint = submitOptions?.checkpoint ?? threadHead?.checkpoint ?? undefined;
+            let checkpoint = submitOptions?.checkpoint ?? threadHead?.checkpoint ?? undefined;
+            // Avoid specifying a checkpoint if user explicitly set it to null
+            if (submitOptions?.checkpoint === null) {
+                checkpoint = undefined;
+            }
             // eslint-disable-next-line @typescript-eslint/ban-ts-comment
             // @ts-expect-error
             if (checkpoint != null)
@@ -694,7 +704,7 @@ export function useStream(options) {
             return getMessages(values);
         },
         getMessagesMetadata(message, index) {
-            trackStreamMode("messages-tuple", "values");
+            trackStreamMode("values");
             return messageMetadata?.find((m) => m.messageId === (message.id ?? index));
         },
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/langgraph-sdk",
-  "version": "0.0.105",
+  "version": "0.0.107",
   "description": "Client library for interacting with the LangGraph API",
   "type": "module",
   "scripts": {