@langchain/langgraph 0.4.9 → 1.0.0-alpha.1

package/dist/func/index.d.cts

@@ -0,0 +1,293 @@
+import { LastValue } from "../channels/last_value.cjs";
+import { EphemeralValue } from "../channels/ephemeral_value.cjs";
+import { CachePolicy, RetryPolicy } from "../pregel/utils/index.cjs";
+import { PregelNode } from "../pregel/read.cjs";
+import { END, PREVIOUS, START } from "../constants.cjs";
+import { Pregel } from "../pregel/index.cjs";
+import { EntrypointFinal, EntrypointFinalSaveT, EntrypointFunc, EntrypointReturnT, TaskFunc } from "./types.cjs";
+import { BaseCache, BaseCheckpointSaver, BaseStore } from "@langchain/langgraph-checkpoint";
+
+//#region src/func/index.d.ts
+
+/**
+ * Options for the {@link task} function
+ */
+interface TaskOptions {
+  /**
+   * The name of the task, analogous to the node name in {@link StateGraph}.
+   */
+  name: string;
+  /**
+   * The retry policy for the task. Configures how many times and under what conditions
+   * the task should be retried if it fails.
+   */
+  retry?: RetryPolicy;
+  /**
+   * The cache policy for the task. Configures how the task should be cached.
+   */
+  cachePolicy?: CachePolicy;
+}
+/**
+ * Define a LangGraph task using the `task` function.
+ *
+ * Tasks can only be called from within an {@link entrypoint} or from within a StateGraph.
+ * A task can be called like a regular function with the following differences:
+ *
+ * - When a checkpointer is enabled, the function inputs and outputs must be serializable.
+ * - The wrapped function can only be called from within an entrypoint or StateGraph.
+ * - Calling the function produces a promise. This makes it easy to parallelize tasks.
+ *
+ * @typeParam ArgsT - The type of arguments the task function accepts
+ * @typeParam OutputT - The type of value the task function returns
+ * @param optionsOrName - Either an {@link TaskOptions} object, or a string for the name of the task
+ * @param func - The function that executes this task
+ * @returns A proxy function that accepts the same arguments as the original and always returns the result as a Promise
+ *
+ * @example basic example
+ * ```typescript
+ * const addOne = task("add", async (a: number) => a + 1);
+ *
+ * const workflow = entrypoint("example", async (numbers: number[]) => {
+ *   const promises = numbers.map(n => addOne(n));
+ *   const results = await Promise.all(promises);
+ *   return results;
+ * });
+ *
+ * // Call the entrypoint
+ * await workflow.invoke([1, 2, 3]); // Returns [2, 3, 4]
+ * ```
+ *
+ * @example using a retry policy
+ * ```typescript
+ * const addOne = task({
+ *     name: "add",
+ *     retry: { maxAttempts: 3 }
+ *   },
+ *   async (a: number) => a + 1
+ * );
+ *
+ * const workflow = entrypoint("example", async (numbers: number[]) => {
+ *   const promises = numbers.map(n => addOne(n));
+ *   const results = await Promise.all(promises);
+ *   return results;
+ * });
+ * ```
+ * @category Functional API
+ */
+declare function task<ArgsT extends unknown[], OutputT>(optionsOrName: TaskOptions | string, func: TaskFunc<ArgsT, OutputT>): (...args: ArgsT) => Promise<OutputT>;
+/**
+ * Options for the {@link entrypoint} function
+ */
+type EntrypointOptions = {
+  /**
+   * The name of the {@link entrypoint}, analogous to the node name in {@link StateGraph}.
+   * This name is used for logging, debugging, and checkpoint identification.
+   */
+  name: string;
+  /**
+   * The checkpointer for the {@link entrypoint}. Used to save and restore state between
+   * invocations of the workflow.
+   */
+  checkpointer?: BaseCheckpointSaver;
+  /**
+   * The store for the {@link entrypoint}. Used to persist data across workflow runs.
+   */
+  store?: BaseStore;
+  /**
+   * The cache for the {@link entrypoint}. Used to cache values between workflow runs.
+   */
+  cache?: BaseCache;
+};
+/**
+ * Type declaration for the entrypoint function with its properties
+ * @category Functional API
+ */
+interface EntrypointFunction {
+  <InputT, OutputT>(optionsOrName: EntrypointOptions | string, func: EntrypointFunc<InputT, OutputT>): Pregel<Record<string, PregelNode<InputT, EntrypointReturnT<OutputT>>>, {
+    [START]: EphemeralValue<InputT>;
+    [END]: LastValue<EntrypointReturnT<OutputT>>;
+    [PREVIOUS]: LastValue<EntrypointFinalSaveT<OutputT>>;
+  }, Record<string, unknown>, InputT, EntrypointReturnT<OutputT>,
+  // Because the update type is an return type union of tasks + entrypoint,
+  // thus we can't type it properly.
+  any,
+  // eslint-disable-line @typescript-eslint/no-explicit-any
+  Awaited<EntrypointReturnT<OutputT>>>;
+  /**
+   * A helper utility for use with the functional API that returns a value to the caller,
+   * as well as a separate state value to persist to the checkpoint. This allows workflows
+   * to maintain state between runs while returning different values to the caller.
+   *
+   * @typeParam ValueT - The type of the value to return to the caller
+   * @typeParam SaveT - The type of the state to save to the checkpoint
+   * @param value - The value to return to the caller
+   * @param save - The value to save to the checkpoint
+   * @returns An object with the value and save properties
+   *
+   * @example
+   * ```typescript
+   * return entrypoint.final({
+   *   value: "result for caller",
+   *   save: { counter: currentCount + 1 }
+   * });
+   * ```
+   */
+  final<ValueT, SaveT>(options: {
+    value?: ValueT;
+    save?: SaveT;
+  }): EntrypointFinal<ValueT, SaveT>;
+}
+/**
+ * Define a LangGraph workflow using the `entrypoint` function.
+ *
+ * ### Function signature
+ *
+ * The wrapped function must accept at most **two parameters**. The first parameter
+ * is the input to the function. The second (optional) parameter is a
+ * {@link LangGraphRunnableConfig} object. If you wish to pass multiple parameters to
+ * the function, you can pass them as an object.
+ *
+ * ### Helper functions
+ *
+ * #### Streaming
+ * To write data to the "custom" stream, use the {@link getWriter} function, or the
+ * {@link LangGraphRunnableConfig.writer} property.
+ *
+ * #### State management
+ * The {@link getPreviousState} function can be used to access the previous state
+ * that was returned from the last invocation of the entrypoint on the same thread id.
+ *
+ * If you wish to save state other than the return value, you can use the
+ * {@link entrypoint.final} function.
+ *
+ * @typeParam InputT - The type of input the entrypoint accepts
+ * @typeParam OutputT - The type of output the entrypoint produces
+ * @param optionsOrName - Either an {@link EntrypointOptions} object, or a string for the name of the entrypoint
+ * @param func - The function that executes this entrypoint
+ * @returns A {@link Pregel} instance that can be run to execute the workflow
+ *
+ * @example Using entrypoint and tasks
+ * ```typescript
+ * import { task, entrypoint } from "@langchain/langgraph";
+ * import { MemorySaver } from "@langchain/langgraph-checkpoint";
+ * import { interrupt, Command } from "@langchain/langgraph";
+ *
+ * const composeEssay = task("compose", async (topic: string) => {
+ *   await new Promise(r => setTimeout(r, 1000)); // Simulate slow operation
+ *   return `An essay about ${topic}`;
+ * });
+ *
+ * const reviewWorkflow = entrypoint({
+ *   name: "review",
+ *   checkpointer: new MemorySaver()
+ * }, async (topic: string) => {
+ *   const essay = await composeEssay(topic);
+ *   const humanReview = await interrupt({
+ *     question: "Please provide a review",
+ *     essay
+ *   });
+ *   return {
+ *     essay,
+ *     review: humanReview
+ *   };
+ * });
+ *
+ * // Example configuration for the workflow
+ * const config = {
+ *   configurable: {
+ *     thread_id: "some_thread"
+ *   }
+ * };
+ *
+ * // Topic for the essay
+ * const topic = "cats";
+ *
+ * // Stream the workflow to generate the essay and await human review
+ * for await (const result of reviewWorkflow.stream(topic, config)) {
+ *   console.log(result);
+ * }
+ *
+ * // Example human review provided after the interrupt
+ * const humanReview = "This essay is great.";
+ *
+ * // Resume the workflow with the provided human review
+ * for await (const result of reviewWorkflow.stream(new Command({ resume: humanReview }), config)) {
+ *   console.log(result);
+ * }
+ * ```
+ *
+ * @example Accessing the previous return value
+ * ```typescript
+ * import { entrypoint, getPreviousState } from "@langchain/langgraph";
+ * import { MemorySaver } from "@langchain/langgraph-checkpoint";
+ *
+ * const accumulator = entrypoint({
+ *   name: "accumulator",
+ *   checkpointer: new MemorySaver()
+ * }, async (input: string) => {
+ *   const previous = getPreviousState<number>();
+ *   return previous !== undefined ? `${previous } ${input}` : input;
+ * });
+ *
+ * const config = {
+ *   configurable: {
+ *     thread_id: "some_thread"
+ *   }
+ * };
+ * await accumulator.invoke("hello", config); // returns "hello"
+ * await accumulator.invoke("world", config); // returns "hello world"
+ * ```
+ *
+ * @example Using entrypoint.final to save a value
+ * ```typescript
+ * import { entrypoint, getPreviousState } from "@langchain/langgraph";
+ * import { MemorySaver } from "@langchain/langgraph-checkpoint";
+ *
+ * const myWorkflow = entrypoint({
+ *   name: "accumulator",
+ *   checkpointer: new MemorySaver()
+ * }, async (num: number) => {
+ *   const previous = getPreviousState<number>();
+ *
+ *   // This will return the previous value to the caller, saving
+ *   // 2 * num to the checkpoint, which will be used in the next invocation
+ *   // for the `previous` parameter.
+ *   return entrypoint.final({
+ *     value: previous ?? 0,
+ *     save: 2 * num
+ *   });
+ * });
+ *
+ * const config = {
+ *   configurable: {
+ *     thread_id: "some_thread"
+ *   }
+ * };
+ *
+ * await myWorkflow.invoke(3, config); // 0 (previous was undefined)
+ * await myWorkflow.invoke(1, config); // 6 (previous was 3 * 2 from the previous invocation)
+ * ```
+ * @category Functional API
+ */
+declare const entrypoint: EntrypointFunction;
+/**
+ * A helper utility function for use with the functional API that returns the previous
+ * state from the checkpoint from the last invocation of the current thread.
+ *
+ * This function allows workflows to access state that was saved in previous runs
+ * using {@link entrypoint.final}.
+ *
+ * @typeParam StateT - The type of the state that was previously saved
+ * @returns The previous saved state from the last invocation of the current thread
+ *
+ * @example
+ * ```typescript
+ * const previousState = getPreviousState<{ counter: number }>();
+ * const newCount = (previousState?.counter ?? 0) + 1;
+ * ```
+ * @category Functional API
+ */
+declare function getPreviousState<StateT>(): StateT;
+//#endregion
+export { EntrypointOptions, TaskOptions, entrypoint, getPreviousState, task };
+//# sourceMappingURL=index.d.cts.map

package/dist/func/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":["BaseCache","BaseCheckpointSaver","BaseStore","Pregel","PregelNode","END","PREVIOUS","START","EphemeralValue","CachePolicy","RetryPolicy","LastValue","EntrypointFinal","EntrypointReturnT","EntrypointFinalSaveT","EntrypointFunc","TaskFunc","TaskOptions","task","ArgsT","OutputT","Promise","EntrypointOptions","EntrypointFunction","InputT","Record","Awaited","ValueT","SaveT","entrypoint","getPreviousState","StateT"],"sources":["../../src/func/index.d.ts"],"sourcesContent":["import { BaseCache, BaseCheckpointSaver, BaseStore } from \"@langchain/langgraph-checkpoint\";\nimport { Pregel } from \"../pregel/index.js\";\nimport { PregelNode } from \"../pregel/read.js\";\nimport { END, PREVIOUS, START } from \"../constants.js\";\nimport { EphemeralValue } from \"../channels/ephemeral_value.js\";\nimport type { CachePolicy, RetryPolicy } from \"../pregel/utils/index.js\";\nimport { LastValue } from \"../channels/last_value.js\";\nimport { EntrypointFinal, EntrypointReturnT, EntrypointFinalSaveT, EntrypointFunc, TaskFunc } from \"./types.js\";\n/**\n * Options for the {@link task} function\n */\nexport interface TaskOptions {\n    /**\n     * The name of the task, analogous to the node name in {@link StateGraph}.\n     */\n    name: string;\n    /**\n     * The retry policy for the task. Configures how many times and under what conditions\n     * the task should be retried if it fails.\n     */\n    retry?: RetryPolicy;\n    /**\n     * The cache policy for the task. Configures how the task should be cached.\n     */\n    cachePolicy?: CachePolicy;\n}\n/**\n * Define a LangGraph task using the `task` function.\n *\n * Tasks can only be called from within an {@link entrypoint} or from within a StateGraph.\n * A task can be called like a regular function with the following differences:\n *\n * - When a checkpointer is enabled, the function inputs and outputs must be serializable.\n * - The wrapped function can only be called from within an entrypoint or StateGraph.\n * - Calling the function produces a promise. This makes it easy to parallelize tasks.\n *\n * @typeParam ArgsT - The type of arguments the task function accepts\n * @typeParam OutputT - The type of value the task function returns\n * @param optionsOrName - Either an {@link TaskOptions} object, or a string for the name of the task\n * @param func - The function that executes this task\n * @returns A proxy function that accepts the same arguments as the original and always returns the result as a Promise\n *\n * @example basic example\n * ```typescript\n * const addOne = task(\"add\", async (a: number) => a + 1);\n *\n * const workflow = entrypoint(\"example\", async (numbers: number[]) => {\n *   const promises = numbers.map(n => addOne(n));\n *   const results = await Promise.all(promises);\n *   return results;\n * });\n *\n * // Call the entrypoint\n * await workflow.invoke([1, 2, 3]); // Returns [2, 3, 4]\n * ```\n *\n * @example using a retry policy\n * ```typescript\n * const addOne = task({\n *     name: \"add\",\n *     retry: { maxAttempts: 3 }\n *   },\n *   async (a: number) => a + 1\n * );\n *\n * const workflow = entrypoint(\"example\", async (numbers: number[]) => {\n *   const promises = numbers.map(n => addOne(n));\n *   const results = await Promise.all(promises);\n *   return results;\n * });\n * ```\n * @category Functional API\n */\nexport declare function task<ArgsT extends unknown[], OutputT>(optionsOrName: TaskOptions | string, func: TaskFunc<ArgsT, OutputT>): (...args: ArgsT) => Promise<OutputT>;\n/**\n * Options for the {@link entrypoint} function\n */\nexport type EntrypointOptions = {\n    /**\n     * The name of the {@link entrypoint}, analogous to the node name in {@link StateGraph}.\n     * This name is used for logging, debugging, and checkpoint identification.\n     */\n    name: string;\n    /**\n     * The checkpointer for the {@link entrypoint}. Used to save and restore state between\n     * invocations of the workflow.\n     */\n    checkpointer?: BaseCheckpointSaver;\n    /**\n     * The store for the {@link entrypoint}. Used to persist data across workflow runs.\n     */\n    store?: BaseStore;\n    /**\n     * The cache for the {@link entrypoint}. Used to cache values between workflow runs.\n     */\n    cache?: BaseCache;\n};\n/**\n * Type declaration for the entrypoint function with its properties\n * @category Functional API\n */\nexport interface EntrypointFunction {\n    <InputT, OutputT>(optionsOrName: EntrypointOptions | string, func: EntrypointFunc<InputT, OutputT>): Pregel<Record<string, PregelNode<InputT, EntrypointReturnT<OutputT>>>, {\n        [START]: EphemeralValue<InputT>;\n        [END]: LastValue<EntrypointReturnT<OutputT>>;\n        [PREVIOUS]: LastValue<EntrypointFinalSaveT<OutputT>>;\n    }, Record<string, unknown>, InputT, EntrypointReturnT<OutputT>, \n    // Because the update type is an return type union of tasks + entrypoint,\n    // thus we can't type it properly.\n    any, // eslint-disable-line @typescript-eslint/no-explicit-any\n    Awaited<EntrypointReturnT<OutputT>>>;\n    /**\n     * A helper utility for use with the functional API that returns a value to the caller,\n     * as well as a separate state value to persist to the checkpoint. This allows workflows\n     * to maintain state between runs while returning different values to the caller.\n     *\n     * @typeParam ValueT - The type of the value to return to the caller\n     * @typeParam SaveT - The type of the state to save to the checkpoint\n     * @param value - The value to return to the caller\n     * @param save - The value to save to the checkpoint\n     * @returns An object with the value and save properties\n     *\n     * @example\n     * ```typescript\n     * return entrypoint.final({\n     *   value: \"result for caller\",\n     *   save: { counter: currentCount + 1 }\n     * });\n     * ```\n     */\n    final<ValueT, SaveT>(options: {\n        value?: ValueT;\n        save?: SaveT;\n    }): EntrypointFinal<ValueT, SaveT>;\n}\n/**\n * Define a LangGraph workflow using the `entrypoint` function.\n *\n * ### Function signature\n *\n * The wrapped function must accept at most **two parameters**. The first parameter\n * is the input to the function. The second (optional) parameter is a\n * {@link LangGraphRunnableConfig} object. If you wish to pass multiple parameters to\n * the function, you can pass them as an object.\n *\n * ### Helper functions\n *\n * #### Streaming\n * To write data to the \"custom\" stream, use the {@link getWriter} function, or the\n * {@link LangGraphRunnableConfig.writer} property.\n *\n * #### State management\n * The {@link getPreviousState} function can be used to access the previous state\n * that was returned from the last invocation of the entrypoint on the same thread id.\n *\n * If you wish to save state other than the return value, you can use the\n * {@link entrypoint.final} function.\n *\n * @typeParam InputT - The type of input the entrypoint accepts\n * @typeParam OutputT - The type of output the entrypoint produces\n * @param optionsOrName - Either an {@link EntrypointOptions} object, or a string for the name of the entrypoint\n * @param func - The function that executes this entrypoint\n * @returns A {@link Pregel} instance that can be run to execute the workflow\n *\n * @example Using entrypoint and tasks\n * ```typescript\n * import { task, entrypoint } from \"@langchain/langgraph\";\n * import { MemorySaver } from \"@langchain/langgraph-checkpoint\";\n * import { interrupt, Command } from \"@langchain/langgraph\";\n *\n * const composeEssay = task(\"compose\", async (topic: string) => {\n *   await new Promise(r => setTimeout(r, 1000)); // Simulate slow operation\n *   return `An essay about ${topic}`;\n * });\n *\n * const reviewWorkflow = entrypoint({\n *   name: \"review\",\n *   checkpointer: new MemorySaver()\n * }, async (topic: string) => {\n *   const essay = await composeEssay(topic);\n *   const humanReview = await interrupt({\n *     question: \"Please provide a review\",\n *     essay\n *   });\n *   return {\n *     essay,\n *     review: humanReview\n *   };\n * });\n *\n * // Example configuration for the workflow\n * const config = {\n *   configurable: {\n *     thread_id: \"some_thread\"\n *   }\n * };\n *\n * // Topic for the essay\n * const topic = \"cats\";\n *\n * // Stream the workflow to generate the essay and await human review\n * for await (const result of reviewWorkflow.stream(topic, config)) {\n *   console.log(result);\n * }\n *\n * // Example human review provided after the interrupt\n * const humanReview = \"This essay is great.\";\n *\n * // Resume the workflow with the provided human review\n * for await (const result of reviewWorkflow.stream(new Command({ resume: humanReview }), config)) {\n *   console.log(result);\n * }\n * ```\n *\n * @example Accessing the previous return value\n * ```typescript\n * import { entrypoint, getPreviousState } from \"@langchain/langgraph\";\n * import { MemorySaver } from \"@langchain/langgraph-checkpoint\";\n *\n * const accumulator = entrypoint({\n *   name: \"accumulator\",\n *   checkpointer: new MemorySaver()\n * }, async (input: string) => {\n *   const previous = getPreviousState<number>();\n *   return previous !== undefined ? `${previous } ${input}` : input;\n * });\n *\n * const config = {\n *   configurable: {\n *     thread_id: \"some_thread\"\n *   }\n * };\n * await accumulator.invoke(\"hello\", config); // returns \"hello\"\n * await accumulator.invoke(\"world\", config); // returns \"hello world\"\n * ```\n *\n * @example Using entrypoint.final to save a value\n * ```typescript\n * import { entrypoint, getPreviousState } from \"@langchain/langgraph\";\n * import { MemorySaver } from \"@langchain/langgraph-checkpoint\";\n *\n * const myWorkflow = entrypoint({\n *   name: \"accumulator\",\n *   checkpointer: new MemorySaver()\n * }, async (num: number) => {\n *   const previous = getPreviousState<number>();\n *\n *   // This will return the previous value to the caller, saving\n *   // 2 * num to the checkpoint, which will be used in the next invocation\n *   // for the `previous` parameter.\n *   return entrypoint.final({\n *     value: previous ?? 0,\n *     save: 2 * num\n *   });\n * });\n *\n * const config = {\n *   configurable: {\n *     thread_id: \"some_thread\"\n *   }\n * };\n *\n * await myWorkflow.invoke(3, config); // 0 (previous was undefined)\n * await myWorkflow.invoke(1, config); // 6 (previous was 3 * 2 from the previous invocation)\n * ```\n * @category Functional API\n */\nexport declare const entrypoint: EntrypointFunction;\n/**\n * A helper utility function for use with the functional API that returns the previous\n * state from the checkpoint from the last invocation of the current thread.\n *\n * This function allows workflows to access state that was saved in previous runs\n * using {@link entrypoint.final}.\n *\n * @typeParam StateT - The type of the state that was previously saved\n * @returns The previous saved state from the last invocation of the current thread\n *\n * @example\n * ```typescript\n * const previousState = getPreviousState<{ counter: number }>();\n * const newCount = (previousState?.counter ?? 0) + 1;\n * ```\n * @category Functional API\n */\nexport declare function getPreviousState<StateT>(): StateT;\n"],"mappings":";;;;;;;;;;;;;AAWA;AAA4B,UAAXiB,WAAAA,CAAW;;;;EA8DJC,IAAAA,EAAAA,MAAI;EAAA;;;;OAA8EF,CAAAA,EArD9FN,WAqD8FM;;;;gBAjDxFP;AAqDlB;;;;;;AAwBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsKA;AAkBA;;;;;iBApNwBS,sDAAsDD,4BAA4BD,SAASG,OAAOC,qBAAqBD,UAAUE,QAAQD;;;;KAIrJE,iBAAAA;;;;;;;;;;iBAUOrB;;;;UAIPC;;;;UAIAF;;;;;;UAMKuB,kBAAAA;mCACoBD,kCAAkCP,eAAeS,QAAQJ,WAAWjB,OAAOsB,eAAerB,WAAWoB,QAAQX,kBAAkBO;KAC3Jb,KAAAA,GAAQC,eAAegB;KACvBnB,GAAAA,GAAMM,UAAUE,kBAAkBO;KAClCd,QAAAA,GAAWK,UAAUG,qBAAqBM;KAC5CK,yBAAyBD,QAAQX,kBAAkBO;;;;;EAItDM,QAAQb,kBAAkBO;;;;;;;;;;;;;;;;;;;;;YAqBdO;WACDC;MACPhB,gBAAgBe,QAAQC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAsIXC,YAAYN;;;;;;;;;;;;;;;;;;iBAkBTO,4BAA4BC"}

package/dist/func/index.d.ts

@@ -1,28 +1,31 @@
-import { BaseCache, BaseCheckpointSaver, BaseStore } from "@langchain/langgraph-checkpoint";
-import { Pregel } from "../pregel/index.js";
+import { LastValue } from "../channels/last_value.js";
+import { EphemeralValue } from "../channels/ephemeral_value.js";
+import { CachePolicy, RetryPolicy } from "../pregel/utils/index.js";
 import { PregelNode } from "../pregel/read.js";
 import { END, PREVIOUS, START } from "../constants.js";
-import { EphemeralValue } from "../channels/ephemeral_value.js";
-import type { CachePolicy, RetryPolicy } from "../pregel/utils/index.js";
-import { LastValue } from "../channels/last_value.js";
-import { EntrypointFinal, EntrypointReturnT, EntrypointFinalSaveT, EntrypointFunc, TaskFunc } from "./types.js";
+import { Pregel } from "../pregel/index.js";
+import { EntrypointFinal, EntrypointFinalSaveT, EntrypointFunc, EntrypointReturnT, TaskFunc } from "./types.js";
+import { BaseCache, BaseCheckpointSaver, BaseStore } from "@langchain/langgraph-checkpoint";
+
+//#region src/func/index.d.ts
+
 /**
  * Options for the {@link task} function
  */
-export interface TaskOptions {
-    /**
-     * The name of the task, analogous to the node name in {@link StateGraph}.
-     */
-    name: string;
-    /**
-     * The retry policy for the task. Configures how many times and under what conditions
-     * the task should be retried if it fails.
-     */
-    retry?: RetryPolicy;
-    /**
-     * The cache policy for the task. Configures how the task should be cached.
-     */
-    cachePolicy?: CachePolicy;
+interface TaskOptions {
+  /**
+   * The name of the task, analogous to the node name in {@link StateGraph}.
+   */
+  name: string;
+  /**
+   * The retry policy for the task. Configures how many times and under what conditions
+   * the task should be retried if it fails.
+   */
+  retry?: RetryPolicy;
+  /**
+   * The cache policy for the task. Configures how the task should be cached.
+   */
+  cachePolicy?: CachePolicy;
 }
 /**
  * Define a LangGraph task using the `task` function.
@@ -69,64 +72,70 @@ export interface TaskOptions {
  *   return results;
  * });
  * ```
+ * @category Functional API
  */
-export declare function task<ArgsT extends unknown[], OutputT>(optionsOrName: TaskOptions | string, func: TaskFunc<ArgsT, OutputT>): (...args: ArgsT) => Promise<OutputT>;
+declare function task<ArgsT extends unknown[], OutputT>(optionsOrName: TaskOptions | string, func: TaskFunc<ArgsT, OutputT>): (...args: ArgsT) => Promise<OutputT>;
 /**
  * Options for the {@link entrypoint} function
  */
-export type EntrypointOptions = {
-    /**
-     * The name of the {@link entrypoint}, analogous to the node name in {@link StateGraph}.
-     * This name is used for logging, debugging, and checkpoint identification.
-     */
-    name: string;
-    /**
-     * The checkpointer for the {@link entrypoint}. Used to save and restore state between
-     * invocations of the workflow.
-     */
-    checkpointer?: BaseCheckpointSaver;
-    /**
-     * The store for the {@link entrypoint}. Used to persist data across workflow runs.
-     */
-    store?: BaseStore;
-    /**
-     * The cache for the {@link entrypoint}. Used to cache values between workflow runs.
-     */
-    cache?: BaseCache;
+type EntrypointOptions = {
+  /**
+   * The name of the {@link entrypoint}, analogous to the node name in {@link StateGraph}.
+   * This name is used for logging, debugging, and checkpoint identification.
+   */
+  name: string;
+  /**
+   * The checkpointer for the {@link entrypoint}. Used to save and restore state between
+   * invocations of the workflow.
+   */
+  checkpointer?: BaseCheckpointSaver;
+  /**
+   * The store for the {@link entrypoint}. Used to persist data across workflow runs.
+   */
+  store?: BaseStore;
+  /**
+   * The cache for the {@link entrypoint}. Used to cache values between workflow runs.
+   */
+  cache?: BaseCache;
 };
 /**
  * Type declaration for the entrypoint function with its properties
+ * @category Functional API
  */
-export interface EntrypointFunction {
-    <InputT, OutputT>(optionsOrName: EntrypointOptions | string, func: EntrypointFunc<InputT, OutputT>): Pregel<Record<string, PregelNode<InputT, EntrypointReturnT<OutputT>>>, {
-        [START]: EphemeralValue<InputT>;
-        [END]: LastValue<EntrypointReturnT<OutputT>>;
-        [PREVIOUS]: LastValue<EntrypointFinalSaveT<OutputT>>;
-    }, Record<string, unknown>, InputT, EntrypointReturnT<OutputT>, any, // eslint-disable-line @typescript-eslint/no-explicit-any
-    Awaited<EntrypointReturnT<OutputT>>>;
-    /**
-     * A helper utility for use with the functional API that returns a value to the caller,
-     * as well as a separate state value to persist to the checkpoint. This allows workflows
-     * to maintain state between runs while returning different values to the caller.
-     *
-     * @typeParam ValueT - The type of the value to return to the caller
-     * @typeParam SaveT - The type of the state to save to the checkpoint
-     * @param value - The value to return to the caller
-     * @param save - The value to save to the checkpoint
-     * @returns An object with the value and save properties
-     *
-     * @example
-     * ```typescript
-     * return entrypoint.final({
-     *   value: "result for caller",
-     *   save: { counter: currentCount + 1 }
-     * });
-     * ```
-     */
-    final<ValueT, SaveT>(options: {
-        value?: ValueT;
-        save?: SaveT;
-    }): EntrypointFinal<ValueT, SaveT>;
+interface EntrypointFunction {
+  <InputT, OutputT>(optionsOrName: EntrypointOptions | string, func: EntrypointFunc<InputT, OutputT>): Pregel<Record<string, PregelNode<InputT, EntrypointReturnT<OutputT>>>, {
+    [START]: EphemeralValue<InputT>;
+    [END]: LastValue<EntrypointReturnT<OutputT>>;
+    [PREVIOUS]: LastValue<EntrypointFinalSaveT<OutputT>>;
+  }, Record<string, unknown>, InputT, EntrypointReturnT<OutputT>,
+  // Because the update type is an return type union of tasks + entrypoint,
+  // thus we can't type it properly.
+  any,
+  // eslint-disable-line @typescript-eslint/no-explicit-any
+  Awaited<EntrypointReturnT<OutputT>>>;
+  /**
+   * A helper utility for use with the functional API that returns a value to the caller,
+   * as well as a separate state value to persist to the checkpoint. This allows workflows
+   * to maintain state between runs while returning different values to the caller.
+   *
+   * @typeParam ValueT - The type of the value to return to the caller
+   * @typeParam SaveT - The type of the state to save to the checkpoint
+   * @param value - The value to return to the caller
+   * @param save - The value to save to the checkpoint
+   * @returns An object with the value and save properties
+   *
+   * @example
+   * ```typescript
+   * return entrypoint.final({
+   *   value: "result for caller",
+   *   save: { counter: currentCount + 1 }
+   * });
+   * ```
+   */
+  final<ValueT, SaveT>(options: {
+    value?: ValueT;
+    save?: SaveT;
+  }): EntrypointFinal<ValueT, SaveT>;
 }
 /**
  * Define a LangGraph workflow using the `entrypoint` function.
@@ -258,8 +267,9 @@ export interface EntrypointFunction {
  * await myWorkflow.invoke(3, config); // 0 (previous was undefined)
  * await myWorkflow.invoke(1, config); // 6 (previous was 3 * 2 from the previous invocation)
  * ```
+ * @category Functional API
  */
-export declare const entrypoint: EntrypointFunction;
+declare const entrypoint: EntrypointFunction;
 /**
  * A helper utility function for use with the functional API that returns the previous
  * state from the checkpoint from the last invocation of the current thread.
@@ -275,5 +285,9 @@ export declare const entrypoint: EntrypointFunction;
  * const previousState = getPreviousState<{ counter: number }>();
  * const newCount = (previousState?.counter ?? 0) + 1;
  * ```
+ * @category Functional API
  */
-export declare function getPreviousState<StateT>(): StateT;
+declare function getPreviousState<StateT>(): StateT;
+//#endregion
+export { EntrypointOptions, TaskOptions, entrypoint, getPreviousState, task };
+//# sourceMappingURL=index.d.ts.map

package/dist/func/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":["BaseCache","BaseCheckpointSaver","BaseStore","Pregel","PregelNode","END","PREVIOUS","START","EphemeralValue","CachePolicy","RetryPolicy","LastValue","EntrypointFinal","EntrypointReturnT","EntrypointFinalSaveT","EntrypointFunc","TaskFunc","TaskOptions","task","ArgsT","OutputT","Promise","EntrypointOptions","EntrypointFunction","InputT","Record","Awaited","ValueT","SaveT","entrypoint","getPreviousState","StateT"],"sources":["../../src/func/index.d.ts"],"sourcesContent":["import { BaseCache, BaseCheckpointSaver, BaseStore } from \"@langchain/langgraph-checkpoint\";\nimport { Pregel } from \"../pregel/index.js\";\nimport { PregelNode } from \"../pregel/read.js\";\nimport { END, PREVIOUS, START } from \"../constants.js\";\nimport { EphemeralValue } from \"../channels/ephemeral_value.js\";\nimport type { CachePolicy, RetryPolicy } from \"../pregel/utils/index.js\";\nimport { LastValue } from \"../channels/last_value.js\";\nimport { EntrypointFinal, EntrypointReturnT, EntrypointFinalSaveT, EntrypointFunc, TaskFunc } from \"./types.js\";\n/**\n * Options for the {@link task} function\n */\nexport interface TaskOptions {\n    /**\n     * The name of the task, analogous to the node name in {@link StateGraph}.\n     */\n    name: string;\n    /**\n     * The retry policy for the task. Configures how many times and under what conditions\n     * the task should be retried if it fails.\n     */\n    retry?: RetryPolicy;\n    /**\n     * The cache policy for the task. Configures how the task should be cached.\n     */\n    cachePolicy?: CachePolicy;\n}\n/**\n * Define a LangGraph task using the `task` function.\n *\n * Tasks can only be called from within an {@link entrypoint} or from within a StateGraph.\n * A task can be called like a regular function with the following differences:\n *\n * - When a checkpointer is enabled, the function inputs and outputs must be serializable.\n * - The wrapped function can only be called from within an entrypoint or StateGraph.\n * - Calling the function produces a promise. This makes it easy to parallelize tasks.\n *\n * @typeParam ArgsT - The type of arguments the task function accepts\n * @typeParam OutputT - The type of value the task function returns\n * @param optionsOrName - Either an {@link TaskOptions} object, or a string for the name of the task\n * @param func - The function that executes this task\n * @returns A proxy function that accepts the same arguments as the original and always returns the result as a Promise\n *\n * @example basic example\n * ```typescript\n * const addOne = task(\"add\", async (a: number) => a + 1);\n *\n * const workflow = entrypoint(\"example\", async (numbers: number[]) => {\n *   const promises = numbers.map(n => addOne(n));\n *   const results = await Promise.all(promises);\n *   return results;\n * });\n *\n * // Call the entrypoint\n * await workflow.invoke([1, 2, 3]); // Returns [2, 3, 4]\n * ```\n *\n * @example using a retry policy\n * ```typescript\n * const addOne = task({\n *     name: \"add\",\n *     retry: { maxAttempts: 3 }\n *   },\n *   async (a: number) => a + 1\n * );\n *\n * const workflow = entrypoint(\"example\", async (numbers: number[]) => {\n *   const promises = numbers.map(n => addOne(n));\n *   const results = await Promise.all(promises);\n *   return results;\n * });\n * ```\n * @category Functional API\n */\nexport declare function task<ArgsT extends unknown[], OutputT>(optionsOrName: TaskOptions | string, func: TaskFunc<ArgsT, OutputT>): (...args: ArgsT) => Promise<OutputT>;\n/**\n * Options for the {@link entrypoint} function\n */\nexport type EntrypointOptions = {\n    /**\n     * The name of the {@link entrypoint}, analogous to the node name in {@link StateGraph}.\n     * This name is used for logging, debugging, and checkpoint identification.\n     */\n    name: string;\n    /**\n     * The checkpointer for the {@link entrypoint}. Used to save and restore state between\n     * invocations of the workflow.\n     */\n    checkpointer?: BaseCheckpointSaver;\n    /**\n     * The store for the {@link entrypoint}. Used to persist data across workflow runs.\n     */\n    store?: BaseStore;\n    /**\n     * The cache for the {@link entrypoint}. Used to cache values between workflow runs.\n     */\n    cache?: BaseCache;\n};\n/**\n * Type declaration for the entrypoint function with its properties\n * @category Functional API\n */\nexport interface EntrypointFunction {\n    <InputT, OutputT>(optionsOrName: EntrypointOptions | string, func: EntrypointFunc<InputT, OutputT>): Pregel<Record<string, PregelNode<InputT, EntrypointReturnT<OutputT>>>, {\n        [START]: EphemeralValue<InputT>;\n        [END]: LastValue<EntrypointReturnT<OutputT>>;\n        [PREVIOUS]: LastValue<EntrypointFinalSaveT<OutputT>>;\n    }, Record<string, unknown>, InputT, EntrypointReturnT<OutputT>, \n    // Because the update type is an return type union of tasks + entrypoint,\n    // thus we can't type it properly.\n    any, // eslint-disable-line @typescript-eslint/no-explicit-any\n    Awaited<EntrypointReturnT<OutputT>>>;\n    /**\n     * A helper utility for use with the functional API that returns a value to the caller,\n     * as well as a separate state value to persist to the checkpoint. This allows workflows\n     * to maintain state between runs while returning different values to the caller.\n     *\n     * @typeParam ValueT - The type of the value to return to the caller\n     * @typeParam SaveT - The type of the state to save to the checkpoint\n     * @param value - The value to return to the caller\n     * @param save - The value to save to the checkpoint\n     * @returns An object with the value and save properties\n     *\n     * @example\n     * ```typescript\n     * return entrypoint.final({\n     *   value: \"result for caller\",\n     *   save: { counter: currentCount + 1 }\n     * });\n     * ```\n     */\n    final<ValueT, SaveT>(options: {\n        value?: ValueT;\n        save?: SaveT;\n    }): EntrypointFinal<ValueT, SaveT>;\n}\n/**\n * Define a LangGraph workflow using the `entrypoint` function.\n *\n * ### Function signature\n *\n * The wrapped function must accept at most **two parameters**. The first parameter\n * is the input to the function. The second (optional) parameter is a\n * {@link LangGraphRunnableConfig} object. If you wish to pass multiple parameters to\n * the function, you can pass them as an object.\n *\n * ### Helper functions\n *\n * #### Streaming\n * To write data to the \"custom\" stream, use the {@link getWriter} function, or the\n * {@link LangGraphRunnableConfig.writer} property.\n *\n * #### State management\n * The {@link getPreviousState} function can be used to access the previous state\n * that was returned from the last invocation of the entrypoint on the same thread id.\n *\n * If you wish to save state other than the return value, you can use the\n * {@link entrypoint.final} function.\n *\n * @typeParam InputT - The type of input the entrypoint accepts\n * @typeParam OutputT - The type of output the entrypoint produces\n * @param optionsOrName - Either an {@link EntrypointOptions} object, or a string for the name of the entrypoint\n * @param func - The function that executes this entrypoint\n * @returns A {@link Pregel} instance that can be run to execute the workflow\n *\n * @example Using entrypoint and tasks\n * ```typescript\n * import { task, entrypoint } from \"@langchain/langgraph\";\n * import { MemorySaver } from \"@langchain/langgraph-checkpoint\";\n * import { interrupt, Command } from \"@langchain/langgraph\";\n *\n * const composeEssay = task(\"compose\", async (topic: string) => {\n *   await new Promise(r => setTimeout(r, 1000)); // Simulate slow operation\n *   return `An essay about ${topic}`;\n * });\n *\n * const reviewWorkflow = entrypoint({\n *   name: \"review\",\n *   checkpointer: new MemorySaver()\n * }, async (topic: string) => {\n *   const essay = await composeEssay(topic);\n *   const humanReview = await interrupt({\n *     question: \"Please provide a review\",\n *     essay\n *   });\n *   return {\n *     essay,\n *     review: humanReview\n *   };\n * });\n *\n * // Example configuration for the workflow\n * const config = {\n *   configurable: {\n *     thread_id: \"some_thread\"\n *   }\n * };\n *\n * // Topic for the essay\n * const topic = \"cats\";\n *\n * // Stream the workflow to generate the essay and await human review\n * for await (const result of reviewWorkflow.stream(topic, config)) {\n *   console.log(result);\n * }\n *\n * // Example human review provided after the interrupt\n * const humanReview = \"This essay is great.\";\n *\n * // Resume the workflow with the provided human review\n * for await (const result of reviewWorkflow.stream(new Command({ resume: humanReview }), config)) {\n *   console.log(result);\n * }\n * ```\n *\n * @example Accessing the previous return value\n * ```typescript\n * import { entrypoint, getPreviousState } from \"@langchain/langgraph\";\n * import { MemorySaver } from \"@langchain/langgraph-checkpoint\";\n *\n * const accumulator = entrypoint({\n *   name: \"accumulator\",\n *   checkpointer: new MemorySaver()\n * }, async (input: string) => {\n *   const previous = getPreviousState<number>();\n *   return previous !== undefined ? `${previous } ${input}` : input;\n * });\n *\n * const config = {\n *   configurable: {\n *     thread_id: \"some_thread\"\n *   }\n * };\n * await accumulator.invoke(\"hello\", config); // returns \"hello\"\n * await accumulator.invoke(\"world\", config); // returns \"hello world\"\n * ```\n *\n * @example Using entrypoint.final to save a value\n * ```typescript\n * import { entrypoint, getPreviousState } from \"@langchain/langgraph\";\n * import { MemorySaver } from \"@langchain/langgraph-checkpoint\";\n *\n * const myWorkflow = entrypoint({\n *   name: \"accumulator\",\n *   checkpointer: new MemorySaver()\n * }, async (num: number) => {\n *   const previous = getPreviousState<number>();\n *\n *   // This will return the previous value to the caller, saving\n *   // 2 * num to the checkpoint, which will be used in the next invocation\n *   // for the `previous` parameter.\n *   return entrypoint.final({\n *     value: previous ?? 0,\n *     save: 2 * num\n *   });\n * });\n *\n * const config = {\n *   configurable: {\n *     thread_id: \"some_thread\"\n *   }\n * };\n *\n * await myWorkflow.invoke(3, config); // 0 (previous was undefined)\n * await myWorkflow.invoke(1, config); // 6 (previous was 3 * 2 from the previous invocation)\n * ```\n * @category Functional API\n */\nexport declare const entrypoint: EntrypointFunction;\n/**\n * A helper utility function for use with the functional API that returns the previous\n * state from the checkpoint from the last invocation of the current thread.\n *\n * This function allows workflows to access state that was saved in previous runs\n * using {@link entrypoint.final}.\n *\n * @typeParam StateT - The type of the state that was previously saved\n * @returns The previous saved state from the last invocation of the current thread\n *\n * @example\n * ```typescript\n * const previousState = getPreviousState<{ counter: number }>();\n * const newCount = (previousState?.counter ?? 0) + 1;\n * ```\n * @category Functional API\n */\nexport declare function getPreviousState<StateT>(): StateT;\n"],"mappings":";;;;;;;;;;;;;AAWA;AAA4B,UAAXiB,WAAAA,CAAW;;;;EA8DJC,IAAAA,EAAAA,MAAI;EAAA;;;;OAA8EF,CAAAA,EArD9FN,WAqD8FM;;;;gBAjDxFP;AAqDlB;;;;;;AAwBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsKA;AAkBA;;;;;iBApNwBS,sDAAsDD,4BAA4BD,SAASG,OAAOC,qBAAqBD,UAAUE,QAAQD;;;;KAIrJE,iBAAAA;;;;;;;;;;iBAUOrB;;;;UAIPC;;;;UAIAF;;;;;;UAMKuB,kBAAAA;mCACoBD,kCAAkCP,eAAeS,QAAQJ,WAAWjB,OAAOsB,eAAerB,WAAWoB,QAAQX,kBAAkBO;KAC3Jb,KAAAA,GAAQC,eAAegB;KACvBnB,GAAAA,GAAMM,UAAUE,kBAAkBO;KAClCd,QAAAA,GAAWK,UAAUG,qBAAqBM;KAC5CK,yBAAyBD,QAAQX,kBAAkBO;;;;;EAItDM,QAAQb,kBAAkBO;;;;;;;;;;;;;;;;;;;;;YAqBdO;WACDC;MACPhB,gBAAgBe,QAAQC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAsIXC,YAAYN;;;;;;;;;;;;;;;;;;iBAkBTO,4BAA4BC"}