@langchain/langgraph-sdk 0.0.97 → 0.0.98

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @langchain/langgraph-sdk
 
+## 0.0.98
+
+### Patch Changes
+
+- ee1defa: feat(sdk): add typing for "tasks" and "checkpoints" stream mode
+
 ## 0.0.97
 
 ### Patch Changes

package/dist/react/stream.cjs

@@ -315,6 +315,8 @@ function useStream(options) {
     const hasCustomListener = options.onCustomEvent != null;
     const hasLangChainListener = options.onLangChainEvent != null;
     const hasDebugListener = options.onDebugEvent != null;
+    const hasCheckpointListener = options.onCheckpointEvent != null;
+    const hasTaskListener = options.onTaskEvent != null;
     const callbackStreamMode = (0, react_1.useMemo)(() => {
         const modes = [];
         if (hasUpdateListener)
@@ -325,12 +327,18 @@ function useStream(options) {
             modes.push("events");
         if (hasDebugListener)
             modes.push("debug");
+        if (hasCheckpointListener)
+            modes.push("checkpoints");
+        if (hasTaskListener)
+            modes.push("tasks");
         return modes;
     }, [
         hasUpdateListener,
         hasCustomListener,
         hasLangChainListener,
         hasDebugListener,
+        hasCheckpointListener,
+        hasTaskListener,
     ]);
     const clearCallbackRef = (0, react_1.useRef)(null);
     clearCallbackRef.current = () => {
@@ -435,6 +443,10 @@ function useStream(options) {
                     options.onLangChainEvent?.(data);
                 if (event === "debug")
                     options.onDebugEvent?.(data);
+                if (event === "checkpoints")
+                    options.onCheckpointEvent?.(data);
+                if (event === "tasks")
+                    options.onTaskEvent?.(data);
                 if (event === "values") {
                     if ("__interrupt__" in data) {
                         // don't update values on interrupt values event

package/dist/react/stream.d.ts

@@ -2,7 +2,7 @@ import { Client, 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, Interrupt, Metadata, ThreadState } from "../schema.js";
-import type { CustomStreamEvent, DebugStreamEvent, EventsStreamEvent, MetadataStreamEvent, StreamMode, UpdatesStreamEvent } from "../types.stream.js";
+import type { CheckpointsStreamEvent, CustomStreamEvent, DebugStreamEvent, EventsStreamEvent, MetadataStreamEvent, StreamMode, TasksStreamEvent, UpdatesStreamEvent } from "../types.stream.js";
 interface Node<StateType = any> {
     type: "node";
     value: ThreadState<StateType>;
@@ -125,6 +125,14 @@ export interface UseStreamOptions<StateType extends Record<string, unknown> = Re
      * @internal This API is experimental and subject to change.
      */
     onDebugEvent?: (data: DebugStreamEvent["data"]) => void;
+    /**
+     * Callback that is called when a checkpoints event is received.
+     */
+    onCheckpointEvent?: (data: CheckpointsStreamEvent<StateType>["data"]) => void;
+    /**
+     * Callback that is called when a tasks event is received.
+     */
+    onTaskEvent?: (data: TasksStreamEvent<StateType, GetUpdateType<Bag, StateType>>["data"]) => void;
     /**
      * Callback that is called when the stream is stopped by the user.
      * Provides a mutate function to update the stream state immediately

package/dist/react/stream.js

@@ -311,6 +311,8 @@ export function useStream(options) {
     const hasCustomListener = options.onCustomEvent != null;
     const hasLangChainListener = options.onLangChainEvent != null;
     const hasDebugListener = options.onDebugEvent != null;
+    const hasCheckpointListener = options.onCheckpointEvent != null;
+    const hasTaskListener = options.onTaskEvent != null;
     const callbackStreamMode = useMemo(() => {
         const modes = [];
         if (hasUpdateListener)
@@ -321,12 +323,18 @@ export function useStream(options) {
             modes.push("events");
         if (hasDebugListener)
             modes.push("debug");
+        if (hasCheckpointListener)
+            modes.push("checkpoints");
+        if (hasTaskListener)
+            modes.push("tasks");
         return modes;
     }, [
         hasUpdateListener,
         hasCustomListener,
         hasLangChainListener,
         hasDebugListener,
+        hasCheckpointListener,
+        hasTaskListener,
     ]);
     const clearCallbackRef = useRef(null);
     clearCallbackRef.current = () => {
@@ -431,6 +439,10 @@ export function useStream(options) {
                     options.onLangChainEvent?.(data);
                 if (event === "debug")
                     options.onDebugEvent?.(data);
+                if (event === "checkpoints")
+                    options.onCheckpointEvent?.(data);
+                if (event === "tasks")
+                    options.onTaskEvent?.(data);
                 if (event === "values") {
                     if ("__interrupt__" in data) {
                         // don't update values on interrupt values event

package/dist/types.stream.d.ts

@@ -1,5 +1,7 @@
 import type { Message } from "./types.messages.js";
+import type { Interrupt, Metadata, Config, ThreadTask } from "./schema.js";
 /**
+import type { SubgraphCheckpointsStreamEvent } from "./types.stream.subgraph.js";
  * Stream modes
  * - "values": Stream only the state values.
  * - "messages": Stream complete messages.
@@ -9,7 +11,7 @@ import type { Message } from "./types.messages.js";
  * - "debug": Stream detailed debug information.
  * - "custom": Stream custom events.
  */
-export type StreamMode = "values" | "messages" | "updates" | "events" | "debug" | "custom" | "messages-tuple";
+export type StreamMode = "values" | "messages" | "updates" | "events" | "debug" | "tasks" | "checkpoints" | "custom" | "messages-tuple";
 type MessageTupleMetadata = {
     tags: string[];
     [key: string]: unknown;
@@ -108,6 +110,51 @@ type MessagesPartialStreamEvent = {
     event: "messages/partial";
     data: Message[];
 };
+type TasksStreamCreateEvent<StateType> = {
+    id?: string;
+    event: "tasks";
+    data: {
+        id: string;
+        name: string;
+        interrupts: Interrupt[];
+        input: StateType;
+        triggers: string[];
+    };
+};
+type TasksStreamResultEvent<UpdateType> = {
+    id?: string;
+    event: "tasks";
+    data: {
+        id: string;
+        name: string;
+        interrupts: Interrupt[];
+        result: [string, UpdateType][];
+    };
+};
+type TasksStreamErrorEvent = {
+    id?: string;
+    event: "tasks";
+    data: {
+        id: string;
+        name: string;
+        interrupts: Interrupt[];
+        error: string;
+    };
+};
+export type TasksStreamEvent<StateType, UpdateType> = TasksStreamCreateEvent<StateType> | TasksStreamResultEvent<UpdateType> | TasksStreamErrorEvent;
+type SubgraphTasksStreamEvent<StateType, UpdateType> = AsSubgraph<TasksStreamCreateEvent<StateType>> | AsSubgraph<TasksStreamResultEvent<UpdateType>> | AsSubgraph<TasksStreamErrorEvent>;
+export type CheckpointsStreamEvent<StateType> = {
+    id?: string;
+    event: "checkpoints";
+    data: {
+        values: StateType;
+        next: string[];
+        config: Config;
+        metadata: Metadata;
+        tasks: ThreadTask[];
+    };
+};
+type SubgraphCheckpointsStreamEvent<StateType> = AsSubgraph<CheckpointsStreamEvent<StateType>>;
 /**
  * Message stream event specific to LangGraph Server.
  * @deprecated Use `streamMode: "messages-tuple"` instead.
@@ -161,6 +208,8 @@ type GetStreamModeMap<TStreamMode extends StreamMode | StreamMode[], TStateType
     debug: DebugStreamEvent;
     messages: MessagesStreamEvent;
     "messages-tuple": MessagesTupleStreamEvent;
+    tasks: TasksStreamEvent<TStateType, TUpdateType>;
+    checkpoints: CheckpointsStreamEvent<TStateType>;
     events: EventsStreamEvent;
 }[TStreamMode extends StreamMode[] ? TStreamMode[number] : TStreamMode] | ErrorStreamEvent | MetadataStreamEvent | FeedbackStreamEvent;
 type GetSubgraphsStreamModeMap<TStreamMode extends StreamMode | StreamMode[], TStateType = unknown, TUpdateType = TStateType, TCustomType = unknown> = {
@@ -171,6 +220,8 @@ type GetSubgraphsStreamModeMap<TStreamMode extends StreamMode | StreamMode[], TS
     messages: SubgraphMessagesStreamEvent;
     "messages-tuple": SubgraphMessagesTupleStreamEvent;
     events: SubgraphEventsStreamEvent;
+    tasks: SubgraphTasksStreamEvent<TStateType, TUpdateType>;
+    checkpoints: SubgraphCheckpointsStreamEvent<TStateType>;
 }[TStreamMode extends StreamMode[] ? TStreamMode[number] : TStreamMode] | SubgraphErrorStreamEvent | MetadataStreamEvent | FeedbackStreamEvent;
 export type TypedAsyncGenerator<TStreamMode extends StreamMode | StreamMode[] = [], TSubgraphs extends boolean = false, TStateType = unknown, TUpdateType = TStateType, TCustomType = unknown> = AsyncGenerator<TSubgraphs extends true ? GetSubgraphsStreamModeMap<TStreamMode, TStateType, TUpdateType, TCustomType> : GetStreamModeMap<TStreamMode, TStateType, TUpdateType, TCustomType>>;
 export {};

package/package.json

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