@langchain/langgraph 0.0.34 → 0.1.0-rc.1

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2023 LangChain
+Copyright (c) 2024 LangChain
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -60,20 +60,15 @@ import { tool } from "@langchain/core/tools";
 import { z } from "zod";
 import { ChatAnthropic } from "@langchain/anthropic";
 import { StateGraph, StateGraphArgs } from "@langchain/langgraph";
-import { MemorySaver } from "@langchain/langgraph";
+import { MemorySaver, Annotation } from "@langchain/langgraph";
 import { ToolNode } from "@langchain/langgraph/prebuilt";
 
-// Define the state interface
-interface AgentState {
-  messages: BaseMessage[];
-}
-
 // Define the graph state
-const graphState: StateGraphArgs<AgentState>["channels"] = {
-  messages: {
-    reducer: (x: BaseMessage[], y: BaseMessage[]) => x.concat(y),
-  },
-};
+const GraphState = Annotation.Root({
+  messages: Annotation<BaseMessage[]>({
+    reducer: (x, y) => x.concat(y),
+  })
+})
 
 // Define the tools for the agent to use
 const weatherTool = tool(async ({ query }) => {
@@ -92,7 +87,8 @@ const weatherTool = tool(async ({ query }) => {
 });
 
 const tools = [weatherTool];
-const toolNode = new ToolNode<AgentState>(tools);
+// We can extract the state typing via `GraphState.State`
+const toolNode = new ToolNode<typeof GraphState.State>(tools);
 
 const model = new ChatAnthropic({
   model: "claude-3-5-sonnet-20240620",
@@ -100,7 +96,7 @@ const model = new ChatAnthropic({
 }).bindTools(tools);
 
 // Define the function that determines whether to continue or not
-function shouldContinue(state: AgentState) {
+function shouldContinue(state: typeof GraphState.State) {
   const messages = state.messages;
   const lastMessage = messages[messages.length - 1] as AIMessage;
 
@@ -113,7 +109,7 @@ function shouldContinue(state: AgentState) {
 }
 
 // Define the function that calls the model
-async function callModel(state: AgentState) {
+async function callModel(state: typeof GraphState.State) {
   const messages = state.messages;
   const response = await model.invoke(messages);
 
@@ -122,7 +118,7 @@ async function callModel(state: AgentState) {
 }
 
 // Define a new graph
-const workflow = new StateGraph<AgentState>({ channels: graphState })
+const workflow = new StateGraph(GraphState)
   .addNode("agent", callModel)
   .addNode("tools", toolNode)
   .addEdge("__start__", "agent")

package/dist/channels/any_value.cjs

@@ -35,11 +35,13 @@ class AnyValue extends index_js_1.BaseChannel {
     }
     update(values) {
         if (values.length === 0) {
+            const updated = this.value !== undefined;
             this.value = undefined;
-            return;
+            return updated;
         }
         // eslint-disable-next-line prefer-destructuring
         this.value = values[values.length - 1];
+        return false;
     }
     get() {
         if (this.value === undefined) {

package/dist/channels/any_value.d.ts

@@ -10,7 +10,7 @@ export declare class AnyValue<Value> extends BaseChannel<Value, Value, Value> {
     value: Value | undefined;
     constructor();
     fromCheckpoint(checkpoint?: Value): this;
-    update(values: Value[]): void;
+    update(values: Value[]): boolean;
     get(): Value;
     checkpoint(): Value;
 }

package/dist/channels/any_value.js

@@ -32,11 +32,13 @@ export class AnyValue extends BaseChannel {
     }
     update(values) {
         if (values.length === 0) {
+            const updated = this.value !== undefined;
             this.value = undefined;
-            return;
+            return updated;
         }
         // eslint-disable-next-line prefer-destructuring
         this.value = values[values.length - 1];
+        return false;
     }
     get() {
         if (this.value === undefined) {

package/dist/channels/base.cjs

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createCheckpoint = exports.emptyChannels = exports.BaseChannel = void 0;
-const base_js_1 = require("../checkpoint/base.cjs");
-const id_js_1 = require("../checkpoint/id.cjs");
+const langgraph_checkpoint_1 = require("@langchain/langgraph-checkpoint");
 const errors_js_1 = require("../errors.cjs");
 class BaseChannel {
     constructor() {
@@ -19,6 +18,14 @@ class BaseChannel {
             value: void 0
         });
     }
+    /**
+     * Mark the current value of the channel as consumed. By default, no-op.
+     * This is called by Pregel before the start of the next step, for all
+     * channels that triggered a node. If the channel was updated, return true.
+     */
+    consume() {
+        return false;
+    }
 }
 exports.BaseChannel = BaseChannel;
 function emptyChannels(channels, checkpoint) {
@@ -34,28 +41,34 @@ function emptyChannels(channels, checkpoint) {
 exports.emptyChannels = emptyChannels;
 function createCheckpoint(checkpoint, channels, step) {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const values = {};
-    for (const k of Object.keys(channels)) {
-        try {
-            values[k] = channels[k].checkpoint();
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        }
-        catch (error) {
-            if (error.name === errors_js_1.EmptyChannelError.unminifiable_name) {
-                // no-op
+    let values;
+    if (channels === undefined) {
+        values = checkpoint.channel_values;
+    }
+    else {
+        values = {};
+        for (const k of Object.keys(channels)) {
+            try {
+                values[k] = channels[k].checkpoint();
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
             }
-            else {
-                throw error; // Rethrow unexpected errors
+            catch (error) {
+                if (error.name === errors_js_1.EmptyChannelError.unminifiable_name) {
+                    // no-op
+                }
+                else {
+                    throw error; // Rethrow unexpected errors
+                }
             }
         }
     }
     return {
         v: 1,
-        id: (0, id_js_1.uuid6)(step),
+        id: (0, langgraph_checkpoint_1.uuid6)(step),
         ts: new Date().toISOString(),
         channel_values: values,
         channel_versions: { ...checkpoint.channel_versions },
-        versions_seen: (0, base_js_1.deepCopy)(checkpoint.versions_seen),
+        versions_seen: (0, langgraph_checkpoint_1.deepCopy)(checkpoint.versions_seen),
         pending_sends: checkpoint.pending_sends ?? [],
     };
 }

package/dist/channels/base.d.ts

@@ -1,5 +1,4 @@
-import { ReadonlyCheckpoint } from "../checkpoint/base.js";
-import { Checkpoint } from "../checkpoint/index.js";
+import { ReadonlyCheckpoint, Checkpoint } from "@langchain/langgraph-checkpoint";
 export declare abstract class BaseChannel<ValueType = unknown, UpdateType = unknown, CheckpointType = unknown> {
     ValueType: ValueType;
     UpdateType: UpdateType;
@@ -19,12 +18,17 @@ export declare abstract class BaseChannel<ValueType = unknown, UpdateType = unkn
     /**
      * Update the channel's value with the given sequence of updates.
      * The order of the updates in the sequence is arbitrary.
+     * This method is called by Pregel for all channels at the end of each step.
+     * If there are no updates, it is called with an empty sequence.
+     *
+     * Raises InvalidUpdateError if the sequence of updates is invalid.
+     * Returns True if the channel was updated, False otherwise.
      *
      * @throws {InvalidUpdateError} if the sequence of updates is invalid.
      * @param {Array<UpdateType>} values
      * @returns {void}
      */
-    abstract update(values: UpdateType[]): void;
+    abstract update(values: UpdateType[]): boolean;
     /**
      * Return the current value of the channel.
      *
@@ -39,6 +43,12 @@ export declare abstract class BaseChannel<ValueType = unknown, UpdateType = unkn
      * @returns {CheckpointType | undefined}
      */
     abstract checkpoint(): CheckpointType | undefined;
+    /**
+     * Mark the current value of the channel as consumed. By default, no-op.
+     * This is called by Pregel before the start of the next step, for all
+     * channels that triggered a node. If the channel was updated, return true.
+     */
+    consume(): boolean;
 }
 export declare function emptyChannels<Cc extends Record<string, BaseChannel>>(channels: Cc, checkpoint: ReadonlyCheckpoint): Cc;
-export declare function createCheckpoint<ValueType>(checkpoint: ReadonlyCheckpoint, channels: Record<string, BaseChannel<ValueType>>, step: number): Checkpoint;
+export declare function createCheckpoint<ValueType>(checkpoint: ReadonlyCheckpoint, channels: Record<string, BaseChannel<ValueType>> | undefined, step: number): Checkpoint;

package/dist/channels/base.js

@@ -1,5 +1,4 @@
-import { deepCopy } from "../checkpoint/base.js";
-import { uuid6 } from "../checkpoint/id.js";
+import { deepCopy, uuid6, } from "@langchain/langgraph-checkpoint";
 import { EmptyChannelError } from "../errors.js";
 export class BaseChannel {
     constructor() {
@@ -16,6 +15,14 @@ export class BaseChannel {
             value: void 0
         });
     }
+    /**
+     * Mark the current value of the channel as consumed. By default, no-op.
+     * This is called by Pregel before the start of the next step, for all
+     * channels that triggered a node. If the channel was updated, return true.
+     */
+    consume() {
+        return false;
+    }
 }
 export function emptyChannels(channels, checkpoint) {
     const newChannels = {};
@@ -29,18 +36,24 @@ export function emptyChannels(channels, checkpoint) {
 }
 export function createCheckpoint(checkpoint, channels, step) {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const values = {};
-    for (const k of Object.keys(channels)) {
-        try {
-            values[k] = channels[k].checkpoint();
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        }
-        catch (error) {
-            if (error.name === EmptyChannelError.unminifiable_name) {
-                // no-op
+    let values;
+    if (channels === undefined) {
+        values = checkpoint.channel_values;
+    }
+    else {
+        values = {};
+        for (const k of Object.keys(channels)) {
+            try {
+                values[k] = channels[k].checkpoint();
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
             }
-            else {
-                throw error; // Rethrow unexpected errors
+            catch (error) {
+                if (error.name === EmptyChannelError.unminifiable_name) {
+                    // no-op
+                }
+                else {
+                    throw error; // Rethrow unexpected errors
+                }
             }
         }
     }

package/dist/channels/binop.cjs

@@ -47,7 +47,7 @@ class BinaryOperatorAggregate extends index_js_1.BaseChannel {
     update(values) {
         let newValues = values;
         if (!newValues.length)
-            return;
+            return false;
         if (this.value === undefined) {
             [this.value] = newValues;
             newValues = newValues.slice(1);
@@ -57,6 +57,7 @@ class BinaryOperatorAggregate extends index_js_1.BaseChannel {
                 this.value = this.operator(this.value, value);
             }
         }
+        return true;
     }
     get() {
         if (this.value === undefined) {

package/dist/channels/binop.d.ts

@@ -10,7 +10,7 @@ export declare class BinaryOperatorAggregate<ValueType, UpdateType = ValueType>
     initialValueFactory?: () => ValueType;
     constructor(operator: BinaryOperator<ValueType, UpdateType>, initialValueFactory?: () => ValueType);
     fromCheckpoint(checkpoint?: ValueType): this;
-    update(values: UpdateType[]): void;
+    update(values: UpdateType[]): boolean;
     get(): ValueType;
     checkpoint(): ValueType;
 }

package/dist/channels/binop.js

@@ -44,7 +44,7 @@ export class BinaryOperatorAggregate extends BaseChannel {
     update(values) {
         let newValues = values;
         if (!newValues.length)
-            return;
+            return false;
         if (this.value === undefined) {
             [this.value] = newValues;
             newValues = newValues.slice(1);
@@ -54,6 +54,7 @@ export class BinaryOperatorAggregate extends BaseChannel {
                 this.value = this.operator(this.value, value);
             }
         }
+        return true;
     }
     get() {
         if (this.value === undefined) {

package/dist/channels/dynamic_barrier_value.cjs

@@ -4,6 +4,9 @@ exports.DynamicBarrierValue = void 0;
 const errors_js_1 = require("../errors.cjs");
 const index_js_1 = require("./index.cjs");
 const named_barrier_value_js_1 = require("./named_barrier_value.cjs");
+function isWaitForNames(v) {
+    return v.__names !== undefined;
+}
 /**
   A channel that switches between two states
 
@@ -46,32 +49,41 @@ class DynamicBarrierValue extends index_js_1.BaseChannel {
         return empty;
     }
     update(values) {
-        // switch to priming state after reading it once
-        if (this.names && (0, named_barrier_value_js_1.areSetsEqual)(this.names, this.seen)) {
-            this.seen = new Set();
-            this.names = undefined;
-        }
-        const newNames = values.filter((v) => typeof v === "object" &&
-            !!v &&
-            "__names" in v &&
-            Object.keys(v).join(",") === "__names" &&
-            Array.isArray(v.__names));
-        if (newNames.length > 1) {
-            throw new errors_js_1.InvalidUpdateError(`Expected at most one WaitForNames object, got ${newNames.length}`);
-        }
-        else if (newNames.length === 1) {
-            this.names = new Set(newNames[0].__names);
+        const waitForNames = values.filter(isWaitForNames);
+        if (waitForNames.length > 0) {
+            if (waitForNames.length > 1) {
+                throw new errors_js_1.InvalidUpdateError("Received multiple WaitForNames updates in the same step.");
+            }
+            this.names = new Set(waitForNames[0].__names);
+            return true;
         }
-        else if (this.names) {
+        else if (this.names !== undefined) {
+            let updated = false;
             for (const value of values) {
+                if (isWaitForNames(value)) {
+                    throw new Error("Assertion Error: Received unexpected WaitForNames instance.");
+                }
                 if (this.names.has(value)) {
-                    this.seen.add(value);
+                    if (!this.seen.has(value)) {
+                        this.seen.add(value);
+                        updated = true;
+                    }
                 }
                 else {
-                    throw new errors_js_1.InvalidUpdateError(`Value ${value} not in names ${this.names}`);
+                    throw new errors_js_1.InvalidUpdateError(`Value ${value} not in ${[...this.names]}`);
                 }
             }
+            return updated;
+        }
+        return false;
+    }
+    consume() {
+        if (this.seen && this.names && (0, named_barrier_value_js_1.areSetsEqual)(this.seen, this.names)) {
+            this.seen = new Set();
+            this.names = undefined;
+            return true;
         }
+        return false;
     }
     // If we have not yet seen all the node names we want to wait for,
     // throw an error to prevent continuing.

package/dist/channels/dynamic_barrier_value.d.ts

@@ -20,7 +20,8 @@ export declare class DynamicBarrierValue<Value> extends BaseChannel<void, Value
     seen: Set<Value>;
     constructor();
     fromCheckpoint(checkpoint?: [Value[] | undefined, Value[]]): this;
-    update(values: (Value | WaitForNames<Value>)[]): void;
+    update(values: (Value | WaitForNames<Value>)[]): boolean;
+    consume(): boolean;
     get(): void;
     checkpoint(): [Value[] | undefined, Value[]];
 }

package/dist/channels/dynamic_barrier_value.js

@@ -1,6 +1,9 @@
 import { EmptyChannelError, InvalidUpdateError } from "../errors.js";
 import { BaseChannel } from "./index.js";
 import { areSetsEqual } from "./named_barrier_value.js";
+function isWaitForNames(v) {
+    return v.__names !== undefined;
+}
 /**
   A channel that switches between two states
 
@@ -43,32 +46,41 @@ export class DynamicBarrierValue extends BaseChannel {
         return empty;
     }
     update(values) {
-        // switch to priming state after reading it once
-        if (this.names && areSetsEqual(this.names, this.seen)) {
-            this.seen = new Set();
-            this.names = undefined;
-        }
-        const newNames = values.filter((v) => typeof v === "object" &&
-            !!v &&
-            "__names" in v &&
-            Object.keys(v).join(",") === "__names" &&
-            Array.isArray(v.__names));
-        if (newNames.length > 1) {
-            throw new InvalidUpdateError(`Expected at most one WaitForNames object, got ${newNames.length}`);
-        }
-        else if (newNames.length === 1) {
-            this.names = new Set(newNames[0].__names);
+        const waitForNames = values.filter(isWaitForNames);
+        if (waitForNames.length > 0) {
+            if (waitForNames.length > 1) {
+                throw new InvalidUpdateError("Received multiple WaitForNames updates in the same step.");
+            }
+            this.names = new Set(waitForNames[0].__names);
+            return true;
         }
-        else if (this.names) {
+        else if (this.names !== undefined) {
+            let updated = false;
             for (const value of values) {
+                if (isWaitForNames(value)) {
+                    throw new Error("Assertion Error: Received unexpected WaitForNames instance.");
+                }
                 if (this.names.has(value)) {
-                    this.seen.add(value);
+                    if (!this.seen.has(value)) {
+                        this.seen.add(value);
+                        updated = true;
+                    }
                 }
                 else {
-                    throw new InvalidUpdateError(`Value ${value} not in names ${this.names}`);
+                    throw new InvalidUpdateError(`Value ${value} not in ${[...this.names]}`);
                 }
             }
+            return updated;
+        }
+        return false;
+    }
+    consume() {
+        if (this.seen && this.names && areSetsEqual(this.seen, this.names)) {
+            this.seen = new Set();
+            this.names = undefined;
+            return true;
         }
+        return false;
     }
     // If we have not yet seen all the node names we want to wait for,
     // throw an error to prevent continuing.

package/dist/channels/ephemeral_value.cjs

@@ -38,15 +38,17 @@ class EphemeralValue extends index_js_1.BaseChannel {
     }
     update(values) {
         if (values.length === 0) {
+            const updated = this.value !== undefined;
             // If there are no updates for this specific channel at the end of the step, wipe it.
             this.value = undefined;
-            return;
+            return updated;
         }
         if (values.length !== 1 && this.guard) {
             throw new errors_js_1.InvalidUpdateError("EphemeralValue can only receive one value per step.");
         }
         // eslint-disable-next-line prefer-destructuring
         this.value = values[values.length - 1];
+        return true;
     }
     get() {
         if (this.value === undefined) {

package/dist/channels/ephemeral_value.d.ts

@@ -8,7 +8,7 @@ export declare class EphemeralValue<Value> extends BaseChannel<Value, Value, Val
     value?: Value;
     constructor(guard?: boolean);
     fromCheckpoint(checkpoint?: Value): this;
-    update(values: Value[]): void;
+    update(values: Value[]): boolean;
     get(): Value;
     checkpoint(): Value;
 }

package/dist/channels/ephemeral_value.js

@@ -35,15 +35,17 @@ export class EphemeralValue extends BaseChannel {
     }
     update(values) {
         if (values.length === 0) {
+            const updated = this.value !== undefined;
             // If there are no updates for this specific channel at the end of the step, wipe it.
             this.value = undefined;
-            return;
+            return updated;
         }
         if (values.length !== 1 && this.guard) {
             throw new InvalidUpdateError("EphemeralValue can only receive one value per step.");
         }
         // eslint-disable-next-line prefer-destructuring
         this.value = values[values.length - 1];
+        return true;
     }
     get() {
         if (this.value === undefined) {

package/dist/channels/last_value.cjs

@@ -35,13 +35,14 @@ class LastValue extends index_js_1.BaseChannel {
     }
     update(values) {
         if (values.length === 0) {
-            return;
+            return false;
         }
         if (values.length !== 1) {
-            throw new errors_js_1.InvalidUpdateError();
+            throw new errors_js_1.InvalidUpdateError("LastValue can only receive one value per step.");
         }
         // eslint-disable-next-line prefer-destructuring
         this.value = values[values.length - 1];
+        return true;
     }
     get() {
         if (this.value === undefined) {

package/dist/channels/last_value.d.ts

@@ -10,7 +10,7 @@ export declare class LastValue<Value> extends BaseChannel<Value, Value, Value> {
     lc_graph_name: string;
     value?: Value;
     fromCheckpoint(checkpoint?: Value): this;
-    update(values: Value[]): void;
+    update(values: Value[]): boolean;
     get(): Value;
     checkpoint(): Value;
 }

package/dist/channels/last_value.js

@@ -32,13 +32,14 @@ export class LastValue extends BaseChannel {
     }
     update(values) {
         if (values.length === 0) {
-            return;
+            return false;
         }
         if (values.length !== 1) {
-            throw new InvalidUpdateError();
+            throw new InvalidUpdateError("LastValue can only receive one value per step.");
         }
         // eslint-disable-next-line prefer-destructuring
         this.value = values[values.length - 1];
+        return true;
     }
     get() {
         if (this.value === undefined) {

package/dist/channels/named_barrier_value.cjs

@@ -43,18 +43,19 @@ class NamedBarrierValue extends index_js_1.BaseChannel {
         return empty;
     }
     update(values) {
-        // We have seen all nodes, so we can reset the seen set in preparation for the next round of updates.
-        if ((0, exports.areSetsEqual)(this.names, this.seen)) {
-            this.seen = new Set();
-        }
+        let updated = false;
         for (const nodeName of values) {
             if (this.names.has(nodeName)) {
-                this.seen.add(nodeName);
+                if (!this.seen.has(nodeName)) {
+                    this.seen.add(nodeName);
+                    updated = true;
+                }
             }
             else {
-                throw new Error(`Value ${JSON.stringify(nodeName)} not in names ${JSON.stringify(this.names)}`);
+                throw new errors_js_1.InvalidUpdateError(`Value ${JSON.stringify(nodeName)} not in names ${JSON.stringify(this.names)}`);
             }
         }
+        return updated;
     }
     // If we have not yet seen all the node names we want to wait for,
     // throw an error to prevent continuing.
@@ -67,5 +68,12 @@ class NamedBarrierValue extends index_js_1.BaseChannel {
     checkpoint() {
         return [...this.seen];
     }
+    consume() {
+        if (this.seen && this.names && (0, exports.areSetsEqual)(this.seen, this.names)) {
+            this.seen = new Set();
+            return true;
+        }
+        return false;
+    }
 }
 exports.NamedBarrierValue = NamedBarrierValue;

package/dist/channels/named_barrier_value.d.ts

@@ -12,7 +12,8 @@ export declare class NamedBarrierValue<Value> extends BaseChannel<void, Value, V
     seen: Set<Value>;
     constructor(names: Set<Value>);
     fromCheckpoint(checkpoint?: Value[]): this;
-    update(values: Value[]): void;
+    update(values: Value[]): boolean;
     get(): void;
     checkpoint(): Value[];
+    consume(): boolean;
 }