@langchain/langgraph 0.0.34 → 0.1.0-rc.0

package/dist/pregel/index.d.ts

@@ -1,11 +1,10 @@
 import { Runnable, RunnableConfig, RunnableFunc } from "@langchain/core/runnables";
-import { CallbackManagerForChainRun } from "@langchain/core/callbacks/manager";
-import { IterableReadableStream } from "@langchain/core/utils/stream";
 import { BaseChannel } from "../channels/base.js";
-import { BaseCheckpointSaver, Checkpoint, ReadonlyCheckpoint } from "../checkpoint/base.js";
+import { BaseCheckpointSaver, CheckpointListOptions } from "../checkpoint/base.js";
 import { PregelNode } from "./read.js";
 import { ChannelWrite } from "./write.js";
-import { All, PregelExecutableTask, PregelTaskDescription, StateSnapshot } from "./types.js";
+import { All, PregelInterface, PregelParams, StateSnapshot, StreamMode } from "./types.js";
+import { StrRecord } from "./algo.js";
 type WriteValue = Runnable | RunnableFunc<unknown, unknown> | unknown;
 export declare class Channel {
     static subscribeTo(channels: string, options?: {
@@ -17,51 +16,20 @@ export declare class Channel {
     }): PregelNode;
     static writeTo(channels: string[], kwargs?: Record<string, WriteValue>): ChannelWrite;
 }
-export type StreamMode = "values" | "updates";
 /**
- * Construct a type with a set of properties K of type T
+ * Config for executing the graph.
  */
-type StrRecord<K extends string, T> = {
-    [P in K]: T;
-};
-export interface PregelInterface<Nn extends StrRecord<string, PregelNode>, Cc extends StrRecord<string, BaseChannel>> {
-    nodes: Nn;
-    channels: Cc;
-    inputs: keyof Cc | Array<keyof Cc>;
-    outputs: keyof Cc | Array<keyof Cc>;
-    /**
-     * @default true
-     */
-    autoValidate?: boolean;
-    /**
-     * @default "values"
-     */
-    streamMode?: StreamMode;
-    streamChannels?: keyof Cc | Array<keyof Cc>;
-    /**
-     * @default []
-     */
-    interruptAfter?: Array<keyof Nn> | All;
-    /**
-     * @default []
-     */
-    interruptBefore?: Array<keyof Nn> | All;
-    /**
-     * @default undefined
-     */
-    stepTimeout?: number;
-    /**
-     * @default false
-     */
-    debug?: boolean;
-    checkpointer?: BaseCheckpointSaver;
-}
 export interface PregelOptions<Nn extends StrRecord<string, PregelNode>, Cc extends StrRecord<string, BaseChannel>> extends RunnableConfig {
-    streamMode?: StreamMode;
+    /** The stream mode for the graph run. Default is ["values"]. */
+    streamMode?: StreamMode | StreamMode[];
     inputKeys?: keyof Cc | Array<keyof Cc>;
+    /** The output keys to retrieve from the graph run. */
     outputKeys?: keyof Cc | Array<keyof Cc>;
+    /** The nodes to interrupt the graph run before. */
     interruptBefore?: All | Array<keyof Nn>;
+    /** The nodes to interrupt the graph run after. */
     interruptAfter?: All | Array<keyof Nn>;
+    /** Enable debug mode for the graph run. */
     debug?: boolean;
 }
 export type PregelInputType = any;
@@ -71,49 +39,44 @@ export declare class Pregel<Nn extends StrRecord<string, PregelNode>, Cc extends
     lc_namespace: string[];
     nodes: Nn;
     channels: Cc;
-    inputs: keyof Cc | Array<keyof Cc>;
-    outputs: keyof Cc | Array<keyof Cc>;
+    inputChannels: keyof Cc | Array<keyof Cc>;
+    outputChannels: keyof Cc | Array<keyof Cc>;
     autoValidate: boolean;
-    streamMode: StreamMode;
+    streamMode: StreamMode[];
     streamChannels?: keyof Cc | Array<keyof Cc>;
     interruptAfter?: Array<keyof Nn> | All;
     interruptBefore?: Array<keyof Nn> | All;
     stepTimeout?: number;
     debug: boolean;
     checkpointer?: BaseCheckpointSaver;
-    constructor(fields: PregelInterface<Nn, Cc>);
+    constructor(fields: PregelParams<Nn, Cc>);
     validate(): this;
     get streamChannelsList(): Array<keyof Cc>;
     get streamChannelsAsIs(): keyof Cc | Array<keyof Cc>;
     getState(config: RunnableConfig): Promise<StateSnapshot>;
-    getStateHistory(config: RunnableConfig, limit?: number, before?: RunnableConfig): AsyncIterableIterator<StateSnapshot>;
+    getStateHistory(config: RunnableConfig, options?: CheckpointListOptions): AsyncIterableIterator<StateSnapshot>;
     updateState(config: RunnableConfig, values: Record<string, unknown> | unknown, asNode?: keyof Nn): Promise<RunnableConfig>;
     _defaults(config: PregelOptions<Nn, Cc>): [
         boolean,
-        StreamMode,
+        StreamMode[],
         // stream mode
-        keyof Cc | Array<keyof Cc>,
+        string | string[],
         // input keys
-        keyof Cc | Array<keyof Cc>,
+        string | string[],
         RunnableConfig,
         // config without pregel keys
-        All | Array<keyof Nn>,
+        All | string[],
         // interrupt before
-        All | Array<keyof Nn>
+        All | string[],
+        // interrupt after
+        BaseCheckpointSaver | undefined
     ];
-    _transform(input: AsyncGenerator<PregelInputType>, runManager?: CallbackManagerForChainRun, config?: PregelOptions<Nn, Cc>): AsyncGenerator<PregelOutputType>;
-    invoke(input: PregelInputType, options?: PregelOptions<Nn, Cc>): Promise<PregelOutputType>;
-    stream(input: PregelInputType, config?: PregelOptions<Nn, Cc>): Promise<IterableReadableStream<PregelOutputType>>;
-    transform(generator: AsyncGenerator<PregelInputType>, config?: PregelOptions<Nn, Cc>): AsyncGenerator<PregelOutputType>;
+    _streamIterator(input: PregelInputType, options?: Partial<PregelOptions<Nn, Cc>>): AsyncGenerator<PregelOutputType>;
+    /**
+     * Run the graph with a single input and config.
+     * @param input
+     * @param options
+     */
+    invoke(input: PregelInputType, options?: Partial<PregelOptions<Nn, Cc>>): Promise<PregelOutputType>;
 }
-export declare function _shouldInterrupt<N extends PropertyKey, C extends PropertyKey>(checkpoint: ReadonlyCheckpoint, interruptNodes: All | Array<N>, snapshotChannels: Array<C>, tasks: Array<PregelExecutableTask<N, C>>): boolean;
-export declare function _localRead<Cc extends StrRecord<string, BaseChannel>>(checkpoint: ReadonlyCheckpoint, channels: Cc, writes: Array<[keyof Cc, unknown]>, select: Array<keyof Cc> | keyof Cc, fresh?: boolean): Record<string, unknown> | unknown;
-export declare function _localWrite(commit: (writes: [string, any][]) => void, processes: Record<string, PregelNode>, channels: Record<string, BaseChannel>, writes: [string, any][]): void;
-export declare function _applyWrites<Cc extends Record<string, BaseChannel>>(checkpoint: Checkpoint, channels: Cc, pendingWrites: Array<[keyof Cc, unknown]>): void;
-export declare function _prepareNextTasks<Nn extends StrRecord<string, PregelNode>, Cc extends StrRecord<string, BaseChannel>>(checkpoint: ReadonlyCheckpoint, processes: Nn, channels: Cc, forExecution: false, extra: {
-    step: number;
-}): [Checkpoint, Array<PregelTaskDescription>];
-export declare function _prepareNextTasks<Nn extends StrRecord<string, PregelNode>, Cc extends StrRecord<string, BaseChannel>>(checkpoint: ReadonlyCheckpoint, processes: Nn, channels: Cc, forExecution: true, extra: {
-    step: number;
-}): [Checkpoint, Array<PregelExecutableTask<keyof Nn, keyof Cc>>];
 export {};