@langchain/langgraph 0.4.8 → 1.0.0-alpha.0

package/dist/ui/types.schema.d.cts

@@ -0,0 +1,228 @@
+import { SerializedMessage } from "./types.message.cjs";
+
+//#region src/ui/types.schema.d.ts
+type Optional<T> = T | null | undefined;
+type MessageTupleMetadata = {
+  tags: string[];
+  [key: string]: unknown;
+};
+type DefaultValues = Record<string, unknown>[] | Record<string, unknown>;
+interface ThreadState<ValuesType = DefaultValues> {
+  /** The state values */
+  values: ValuesType;
+  /** The next nodes to execute. If empty, the thread is done until new input is received */
+  next: string[];
+  /** Checkpoint of the thread state */
+  checkpoint: Checkpoint;
+  /** Metadata for this state */
+  metadata: CheckpointMetadata;
+  /** Time of state creation  */
+  created_at: Optional<string>;
+  /** The parent checkpoint. If missing, this is the root checkpoint */
+  parent_checkpoint: Optional<Checkpoint>;
+  /** Tasks to execute in this step. If already attempted, may contain an error */
+  tasks: Array<ThreadTask>;
+}
+interface ThreadTask {
+  id: string;
+  name: string;
+  result?: unknown;
+  error: Optional<string>;
+  interrupts: Array<Interrupt>;
+  checkpoint: Optional<Checkpoint>;
+  state: Optional<ThreadState>;
+}
+type Config = {
+  /**
+   * Tags for this call and any sub-calls (eg. a Chain calling an LLM).
+   * You can use these to filter calls.
+   */
+  tags?: string[];
+  /**
+   * Maximum number of times a call can recurse.
+   * If not provided, defaults to 25.
+   */
+  recursion_limit?: number;
+  /**
+   * Runtime values for attributes previously made configurable on this Runnable.
+   */
+  configurable?: {
+    /**
+     * ID of the thread
+     */
+    thread_id?: Optional<string>;
+    /**
+     * Timestamp of the state checkpoint
+     */
+    checkpoint_id?: Optional<string>;
+    [key: string]: unknown;
+  };
+};
+type CheckpointMetadata = Optional<{
+  source?: "input" | "loop" | "update" | (string & {}); // eslint-disable-line @typescript-eslint/ban-types
+  step?: number;
+  writes?: Record<string, unknown> | null;
+  parents?: Record<string, string>;
+  [key: string]: unknown;
+}>;
+interface Checkpoint {
+  thread_id: string;
+  checkpoint_ns: string;
+  checkpoint_id: Optional<string>;
+  checkpoint_map: Optional<Record<string, unknown>>;
+}
+/**
+ * An interrupt thrown inside a thread.
+ */
+interface Interrupt<TValue = unknown> {
+  /**
+   * The ID of the interrupt.
+   */
+  id?: string;
+  /**
+   * The value of the interrupt.
+   */
+  value?: TValue;
+}
+type AsSubgraph<TEvent extends {
+  id?: string;
+  event: string;
+  data: unknown;
+}> = {
+  id?: TEvent["id"];
+  event: TEvent["event"] | `${TEvent["event"]}|${string}`;
+  data: TEvent["data"];
+};
+/**
+ * Stream event with values after completion of each step.
+ */
+type ValuesStreamEvent<StateType, InterruptType> = AsSubgraph<{
+  id?: string;
+  event: "values";
+  data: unknown extends InterruptType ? StateType : StateType & {
+    __interrupt__?: InterruptType;
+  };
+}>;
+/**
+ * Stream event with message chunks coming from LLM invocations inside nodes.
+ */
+type MessagesTupleStreamEvent = AsSubgraph<{
+  id?: string;
+  event: "messages";
+  // TODO: add types for message and config, which do not depend on LangChain
+  // while making sure it's easy to keep them in sync.
+  data: [message: SerializedMessage.AnyMessage, config: MessageTupleMetadata];
+}>;
+/**
+ * Metadata stream event with information about the run and thread
+ */
+type MetadataStreamEvent = {
+  id?: string;
+  event: "metadata";
+  data: {
+    run_id: string;
+    thread_id: string;
+  };
+};
+/**
+ * Stream event with error information.
+ */
+type SubgraphErrorStreamEvent = AsSubgraph<{
+  id?: string;
+  event: "error";
+  data: {
+    error: string;
+    message: string;
+  };
+}>;
+/**
+ * Stream event with updates to the state after each step.
+ * The streamed outputs include the name of the node that
+ * produced the update as well as the update.
+ */
+type UpdatesStreamEvent<UpdateType, NodeReturnType> = AsSubgraph<{
+  id?: string;
+  event: "updates";
+  data: NodeReturnType extends Record<string, unknown> ? { [K in keyof NodeReturnType]?: NodeReturnType[K] } & {
+    [node: string]: UpdateType;
+  } : Record<string, UpdateType>;
+}>;
+/**
+ * Streaming custom data from inside the nodes.
+ */
+type CustomStreamEvent<T> = AsSubgraph<{
+  id?: string;
+  event: "custom";
+  data: T;
+}>;
+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;
+  };
+};
+type TasksStreamEvent<StateType, UpdateType> = AsSubgraph<TasksStreamCreateEvent<StateType>> | AsSubgraph<TasksStreamResultEvent<UpdateType>> | AsSubgraph<TasksStreamErrorEvent>;
+type CheckpointsStreamEvent<StateType> = AsSubgraph<{
+  id?: string;
+  event: "checkpoints";
+  data: {
+    values: StateType;
+    next: string[];
+    config: Config;
+    metadata: CheckpointMetadata;
+    tasks: ThreadTask[];
+  };
+}>;
+/**
+ * Stream event with detailed debug information.
+ */
+type DebugStreamEvent = AsSubgraph<{
+  id?: string;
+  event: "debug";
+  data: unknown;
+}>;
+/**
+ * Stream event with events occurring during execution.
+ */
+type EventsStreamEvent = {
+  id?: string;
+  event: "events";
+  data: {
+    event: `on_${"chat_model" | "llm" | "chain" | "tool" | "retriever" | "prompt"}_${"start" | "stream" | "end"}` | (string & {}); // eslint-disable-line @typescript-eslint/ban-types
+    name: string;
+    tags: string[];
+    run_id: string;
+    metadata: Record<string, unknown>;
+    parent_ids: string[];
+    data: unknown;
+  };
+};
+type LangGraphEventStream<TStateType = unknown, TUpdateType = TStateType, TCustomType = unknown, TInterruptType = unknown, TNodeReturnType = unknown> = ValuesStreamEvent<TStateType, TInterruptType> | UpdatesStreamEvent<TUpdateType, TNodeReturnType> | CustomStreamEvent<TCustomType> | DebugStreamEvent | MessagesTupleStreamEvent | EventsStreamEvent | TasksStreamEvent<TStateType, TUpdateType> | CheckpointsStreamEvent<TStateType> | SubgraphErrorStreamEvent | MetadataStreamEvent;
+//#endregion
+export { LangGraphEventStream };
+//# sourceMappingURL=types.schema.d.cts.map

package/dist/ui/types.schema.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.schema.d.cts","names":["SerializedMessage","Optional","T","MessageTupleMetadata","DefaultValues","Record","ThreadState","ValuesType","Checkpoint","CheckpointMetadata","ThreadTask","Array","Interrupt","Config","TValue","AsSubgraph","TEvent","ValuesStreamEvent","InterruptType","StateType","MessagesTupleStreamEvent","AnyMessage","MetadataStreamEvent","SubgraphErrorStreamEvent","UpdatesStreamEvent","NodeReturnType","K","UpdateType","CustomStreamEvent","TasksStreamCreateEvent","TasksStreamResultEvent","TasksStreamErrorEvent","TasksStreamEvent","CheckpointsStreamEvent","DebugStreamEvent","EventsStreamEvent","LangGraphEventStream","TStateType","TInterruptType","TUpdateType","TNodeReturnType","TCustomType"],"sources":["../../src/ui/types.schema.d.ts"],"sourcesContent":["import type { SerializedMessage } from \"./types.message.js\";\ntype Optional<T> = T | null | undefined;\ntype MessageTupleMetadata = {\n    tags: string[];\n    [key: string]: unknown;\n};\ntype DefaultValues = Record<string, unknown>[] | Record<string, unknown>;\ninterface ThreadState<ValuesType = DefaultValues> {\n    /** The state values */\n    values: ValuesType;\n    /** The next nodes to execute. If empty, the thread is done until new input is received */\n    next: string[];\n    /** Checkpoint of the thread state */\n    checkpoint: Checkpoint;\n    /** Metadata for this state */\n    metadata: CheckpointMetadata;\n    /** Time of state creation  */\n    created_at: Optional<string>;\n    /** The parent checkpoint. If missing, this is the root checkpoint */\n    parent_checkpoint: Optional<Checkpoint>;\n    /** Tasks to execute in this step. If already attempted, may contain an error */\n    tasks: Array<ThreadTask>;\n}\ninterface ThreadTask {\n    id: string;\n    name: string;\n    result?: unknown;\n    error: Optional<string>;\n    interrupts: Array<Interrupt>;\n    checkpoint: Optional<Checkpoint>;\n    state: Optional<ThreadState>;\n}\ntype Config = {\n    /**\n     * Tags for this call and any sub-calls (eg. a Chain calling an LLM).\n     * You can use these to filter calls.\n     */\n    tags?: string[];\n    /**\n     * Maximum number of times a call can recurse.\n     * If not provided, defaults to 25.\n     */\n    recursion_limit?: number;\n    /**\n     * Runtime values for attributes previously made configurable on this Runnable.\n     */\n    configurable?: {\n        /**\n         * ID of the thread\n         */\n        thread_id?: Optional<string>;\n        /**\n         * Timestamp of the state checkpoint\n         */\n        checkpoint_id?: Optional<string>;\n        [key: string]: unknown;\n    };\n};\ntype CheckpointMetadata = Optional<{\n    source?: \"input\" | \"loop\" | \"update\" | (string & {}); // eslint-disable-line @typescript-eslint/ban-types\n    step?: number;\n    writes?: Record<string, unknown> | null;\n    parents?: Record<string, string>;\n    [key: string]: unknown;\n}>;\ninterface Checkpoint {\n    thread_id: string;\n    checkpoint_ns: string;\n    checkpoint_id: Optional<string>;\n    checkpoint_map: Optional<Record<string, unknown>>;\n}\n/**\n * An interrupt thrown inside a thread.\n */\ninterface Interrupt<TValue = unknown> {\n    /**\n     * The ID of the interrupt.\n     */\n    id?: string;\n    /**\n     * The value of the interrupt.\n     */\n    value?: TValue;\n}\ntype AsSubgraph<TEvent extends {\n    id?: string;\n    event: string;\n    data: unknown;\n}> = {\n    id?: TEvent[\"id\"];\n    event: TEvent[\"event\"] | `${TEvent[\"event\"]}|${string}`;\n    data: TEvent[\"data\"];\n};\n/**\n * Stream event with values after completion of each step.\n */\ntype ValuesStreamEvent<StateType, InterruptType> = AsSubgraph<{\n    id?: string;\n    event: \"values\";\n    data: unknown extends InterruptType ? StateType : StateType & {\n        __interrupt__?: InterruptType;\n    };\n}>;\n/**\n * Stream event with message chunks coming from LLM invocations inside nodes.\n */\ntype MessagesTupleStreamEvent = AsSubgraph<{\n    id?: string;\n    event: \"messages\";\n    // TODO: add types for message and config, which do not depend on LangChain\n    // while making sure it's easy to keep them in sync.\n    data: [message: SerializedMessage.AnyMessage, config: MessageTupleMetadata];\n}>;\n/**\n * Metadata stream event with information about the run and thread\n */\ntype MetadataStreamEvent = {\n    id?: string;\n    event: \"metadata\";\n    data: {\n        run_id: string;\n        thread_id: string;\n    };\n};\n/**\n * Stream event with error information.\n */\ntype SubgraphErrorStreamEvent = AsSubgraph<{\n    id?: string;\n    event: \"error\";\n    data: {\n        error: string;\n        message: string;\n    };\n}>;\n/**\n * Stream event with updates to the state after each step.\n * The streamed outputs include the name of the node that\n * produced the update as well as the update.\n */\ntype UpdatesStreamEvent<UpdateType, NodeReturnType> = AsSubgraph<{\n    id?: string;\n    event: \"updates\";\n    data: NodeReturnType extends Record<string, unknown> ? {\n        [K in keyof NodeReturnType]?: NodeReturnType[K];\n    } & {\n        [node: string]: UpdateType;\n    } : Record<string, UpdateType>;\n}>;\n/**\n * Streaming custom data from inside the nodes.\n */\ntype CustomStreamEvent<T> = AsSubgraph<{\n    id?: string;\n    event: \"custom\";\n    data: T;\n}>;\ntype TasksStreamCreateEvent<StateType> = {\n    id?: string;\n    event: \"tasks\";\n    data: {\n        id: string;\n        name: string;\n        interrupts: Interrupt[];\n        input: StateType;\n        triggers: string[];\n    };\n};\ntype TasksStreamResultEvent<UpdateType> = {\n    id?: string;\n    event: \"tasks\";\n    data: {\n        id: string;\n        name: string;\n        interrupts: Interrupt[];\n        result: [string, UpdateType][];\n    };\n};\ntype TasksStreamErrorEvent = {\n    id?: string;\n    event: \"tasks\";\n    data: {\n        id: string;\n        name: string;\n        interrupts: Interrupt[];\n        error: string;\n    };\n};\ntype TasksStreamEvent<StateType, UpdateType> = AsSubgraph<TasksStreamCreateEvent<StateType>> | AsSubgraph<TasksStreamResultEvent<UpdateType>> | AsSubgraph<TasksStreamErrorEvent>;\ntype CheckpointsStreamEvent<StateType> = AsSubgraph<{\n    id?: string;\n    event: \"checkpoints\";\n    data: {\n        values: StateType;\n        next: string[];\n        config: Config;\n        metadata: CheckpointMetadata;\n        tasks: ThreadTask[];\n    };\n}>;\n/**\n * Stream event with detailed debug information.\n */\ntype DebugStreamEvent = AsSubgraph<{\n    id?: string;\n    event: \"debug\";\n    data: unknown;\n}>;\n/**\n * Stream event with events occurring during execution.\n */\ntype EventsStreamEvent = {\n    id?: string;\n    event: \"events\";\n    data: {\n        event: `on_${\"chat_model\" | \"llm\" | \"chain\" | \"tool\" | \"retriever\" | \"prompt\"}_${\"start\" | \"stream\" | \"end\"}` | (string & {}); // eslint-disable-line @typescript-eslint/ban-types\n        name: string;\n        tags: string[];\n        run_id: string;\n        metadata: Record<string, unknown>;\n        parent_ids: string[];\n        data: unknown;\n    };\n};\nexport type LangGraphEventStream<TStateType = unknown, TUpdateType = TStateType, TCustomType = unknown, TInterruptType = unknown, TNodeReturnType = unknown> = ValuesStreamEvent<TStateType, TInterruptType> | UpdatesStreamEvent<TUpdateType, TNodeReturnType> | CustomStreamEvent<TCustomType> | DebugStreamEvent | MessagesTupleStreamEvent | EventsStreamEvent | TasksStreamEvent<TStateType, TUpdateType> | CheckpointsStreamEvent<TStateType> | SubgraphErrorStreamEvent | MetadataStreamEvent;\nexport {};\n"],"mappings":";;;KACKC,cAAcC;KACdC,oBAAAA;EADAF,IAAAA,EAAAA,MAAQ,EAAA;EACRE,CAAAA,GAAAA,EAAAA,MAAAA,CAAAA,EAAAA,OAAAA;AAAoB,CAAA;KAIpBC,aAAAA,GAAgBC,MAAH,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,GAA+BA,MAA/B,CAAA,MAAA,EAAA,OAAA,CAAA;UACRC,WADWD,CAAAA,aACcD,aADdC,CAAAA,CAAAA;;UAGTE;EAFFD;EAAW,IAAA,EAAA,MAAA,EAAA;;YAETC,EAIIC,UAJJD;;UAMEE,EAAAA,kBAAAA;;YAIkBD,EAFhBP,QAEgBO,CAAAA,MAAAA,CAAAA;;mBAEfE,EAFMT,QAENS,CAFeF,UAEfE,CAAAA;;SAANC,MAAMD;AAAD;UAENA,UAAAA,CAAU;MAITT,MAAAA;MACWW,EAAAA,MAAAA;QAAND,CAAAA,EAAAA,OAAAA;OACSH,EAFdP,QAEcO,CAAAA,MAAAA,CAAAA;YAATP,EADAU,KACAV,CADMW,SACNX,CAAAA;YACIK,EADJL,QACIK,CADKE,UACLF,CAAAA;OAATL,EAAAA,QAAAA,CAASK,WAATL,CAAAA;;AAAQ,KAEdY,MAAAA,GAAM;EAAA;;;;EA0BNJ,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA;EAAkB;;;;;EAObD;;;cAImBH,CAAAA,EAAAA;IAATJ;;AAAQ;IAevBc,SAAU,CAAA,EAlCKd,QAkCL,CAAA,MAAA,CAAA;IAAA;;;IAMiBe,aAAAA,CAAAA,EApCRf,QAoCQe,CAAAA,MAAAA,CAAAA;IACtBA,CAAAA,GAAAA,EAAAA,MAAAA,CAAAA,EAAAA,OAAAA;;AAAM,CAAA;KAjCXP,kBAAAA,GAAqBR,QAsCJ,CAAA;QAGIiB,CAAAA,EAAAA,OAAAA,GAAAA,MAAAA,GAAAA,QAAAA,GAAAA,CAAAA,MAAAA,GAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA;MAAgBC,CAAAA,EAAAA,MAAAA;QAAYA,CAAAA,EAtCzCd,MAsCyCc,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,GAAAA,IAAAA;SAC9BD,CAAAA,EAtCVb,MAsCUa,CAAAA,MAAAA,EAAAA,MAAAA,CAAAA;MAJ2BH,EAAAA,MAAAA,CAAAA,EAAAA,OAAAA;;AAAU,UA/BnDP,UAAAA,CAyCLY;EAAwB,SAAA,EAAA,MAAA;eAKTpB,EAAAA,MAAkBqB;eAAoBlB,EA3CvCF,QA2CuCE,CAAAA,MAAAA,CAAAA;gBAL1BY,EArCZd,QAqCYc,CArCHV,MAqCGU,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,CAAAA;;AAAU;AAUlB;AAWkB;UArDhCH,SAkEa,CAAA,SAAA,OAAA,CAAA,CAAA;;;;KAIea,EAAAA,MAAAA;;;;OAG9BpB,CAAAA,EAjEIS,MAiEJT;;KA/DHU;EAoEAa,EAAAA,CAAAA,EAAAA,MAAAA;EAAiB,KAAA,EAAA,MAAA;MAGZ1B,EAAAA,OAAAA;;OAlEDc;EAoEJa,KAAAA,EAnEMb,MAmENa,CAAAA,OAAAA,CAAAA,GAAsB,GAnEKb,MAmEL,CAAA,OAAA,CAAA,IAAA,MAAA,EAAA;EAAA,IAAA,EAlEjBA,MAkEiB,CAAA,MAAA,CAAA;;;;AAOH;KApEnBC,iBAwEsB,CAAA,SAAA,EAAA,aAAA,CAAA,GAxEwBF,UAwExB,CAAA;KAMPH,EAAAA,MAAAA;OACKe,EAAAA,QAAAA;wBA5ECT,gBAAgBC,YAAYA;IA+EjDY,aAAAA,CAAAA,EA9EmBb,aA8EE;EAUrBc,CAAAA;CAAgB,CAAA;;;;KAlFhBZ,wBAAAA,GAA2BL,UAkFiGY,CAAAA;KAAvBG,EAAAA,MAAAA;OAAXf,EAAAA,UAAAA;;;kBA7E3Ef,iBAAAA,CAAkBqB,oBAAoBlB;AA6EgG,CAAA,CAAA;;;;KAxErJmB,mBAAAA,GAgFab;KACHC,EAAAA,MAAAA;OAR0BK,EAAAA,UAAAA;;IAcpCmB,MAAAA,EAAAA,MAAAA;IAQAC,SAAAA,EAAAA,MAAiB;EAaVC,CAAAA;CAAoB;;;;KAjG3Bb,wBAAAA,GAA2BR,UAiG+HE,CAAAA;KAAmEsB,EAAAA,MAAAA;OAAaC,EAAAA,OAAAA;MAAhChB,EAAAA;IAAqEiB,KAAAA,EAAAA,MAAAA;IAAlBb,OAAAA,EAAAA,MAAAA;;;;;;;;KApF7PJ,kBAoF4YS,CAAAA,UAAAA,EAAAA,cAAAA,CAAAA,GApF3VlB,UAoF2VkB,CAAAA;KAAqCV,EAAAA,MAAAA;OAA2BD,EAAAA,SAAAA;QAjFvcG,uBAAuBpB,wCACboB,kBAAkBA,eAAeC;oBAE7BC;MAChBtB,eAAesB;;;;;KAKlBC,uBAAuBb;;;QAGlBb;;KAEL2B;;;;;;gBAMejB;WACLO;;;;KAIVW;;;;;;gBAMelB;qBACKe;;;KAGpBI,qBAAAA;;;;;;gBAMenB;;;;KAIfoB,0CAA0CjB,WAAWc,uBAAuBV,cAAcJ,WAAWe,uBAAuBH,eAAeZ,WAAWgB;KACtJE,oCAAoClB;;;;YAIzBI;;YAEAN;cACEJ;WACHC;;;;;;KAMVwB,gBAAAA,GAAmBnB;;;;;;;;KAQnBoB,iBAAAA;;;;;;;;cAQa9B;;;;;KAKN+B,yDAAyDC,0FAA0FpB,kBAAkBoB,YAAYC,kBAAkBd,mBAAmBe,aAAaC,mBAAmBZ,kBAAkBa,eAAeP,mBAAmBd,2BAA2Be,oBAAoBH,iBAAiBK,YAAYE,eAAeN,uBAAuBI,cAAcd,2BAA2BD"}

package/dist/ui/types.schema.d.ts

@@ -0,0 +1,228 @@
+import { SerializedMessage } from "./types.message.js";
+
+//#region src/ui/types.schema.d.ts
+type Optional<T> = T | null | undefined;
+type MessageTupleMetadata = {
+  tags: string[];
+  [key: string]: unknown;
+};
+type DefaultValues = Record<string, unknown>[] | Record<string, unknown>;
+interface ThreadState<ValuesType = DefaultValues> {
+  /** The state values */
+  values: ValuesType;
+  /** The next nodes to execute. If empty, the thread is done until new input is received */
+  next: string[];
+  /** Checkpoint of the thread state */
+  checkpoint: Checkpoint;
+  /** Metadata for this state */
+  metadata: CheckpointMetadata;
+  /** Time of state creation  */
+  created_at: Optional<string>;
+  /** The parent checkpoint. If missing, this is the root checkpoint */
+  parent_checkpoint: Optional<Checkpoint>;
+  /** Tasks to execute in this step. If already attempted, may contain an error */
+  tasks: Array<ThreadTask>;
+}
+interface ThreadTask {
+  id: string;
+  name: string;
+  result?: unknown;
+  error: Optional<string>;
+  interrupts: Array<Interrupt>;
+  checkpoint: Optional<Checkpoint>;
+  state: Optional<ThreadState>;
+}
+type Config = {
+  /**
+   * Tags for this call and any sub-calls (eg. a Chain calling an LLM).
+   * You can use these to filter calls.
+   */
+  tags?: string[];
+  /**
+   * Maximum number of times a call can recurse.
+   * If not provided, defaults to 25.
+   */
+  recursion_limit?: number;
+  /**
+   * Runtime values for attributes previously made configurable on this Runnable.
+   */
+  configurable?: {
+    /**
+     * ID of the thread
+     */
+    thread_id?: Optional<string>;
+    /**
+     * Timestamp of the state checkpoint
+     */
+    checkpoint_id?: Optional<string>;
+    [key: string]: unknown;
+  };
+};
+type CheckpointMetadata = Optional<{
+  source?: "input" | "loop" | "update" | (string & {}); // eslint-disable-line @typescript-eslint/ban-types
+  step?: number;
+  writes?: Record<string, unknown> | null;
+  parents?: Record<string, string>;
+  [key: string]: unknown;
+}>;
+interface Checkpoint {
+  thread_id: string;
+  checkpoint_ns: string;
+  checkpoint_id: Optional<string>;
+  checkpoint_map: Optional<Record<string, unknown>>;
+}
+/**
+ * An interrupt thrown inside a thread.
+ */
+interface Interrupt<TValue = unknown> {
+  /**
+   * The ID of the interrupt.
+   */
+  id?: string;
+  /**
+   * The value of the interrupt.
+   */
+  value?: TValue;
+}
+type AsSubgraph<TEvent extends {
+  id?: string;
+  event: string;
+  data: unknown;
+}> = {
+  id?: TEvent["id"];
+  event: TEvent["event"] | `${TEvent["event"]}|${string}`;
+  data: TEvent["data"];
+};
+/**
+ * Stream event with values after completion of each step.
+ */
+type ValuesStreamEvent<StateType, InterruptType> = AsSubgraph<{
+  id?: string;
+  event: "values";
+  data: unknown extends InterruptType ? StateType : StateType & {
+    __interrupt__?: InterruptType;
+  };
+}>;
+/**
+ * Stream event with message chunks coming from LLM invocations inside nodes.
+ */
+type MessagesTupleStreamEvent = AsSubgraph<{
+  id?: string;
+  event: "messages";
+  // TODO: add types for message and config, which do not depend on LangChain
+  // while making sure it's easy to keep them in sync.
+  data: [message: SerializedMessage.AnyMessage, config: MessageTupleMetadata];
+}>;
+/**
+ * Metadata stream event with information about the run and thread
+ */
+type MetadataStreamEvent = {
+  id?: string;
+  event: "metadata";
+  data: {
+    run_id: string;
+    thread_id: string;
+  };
+};
+/**
+ * Stream event with error information.
+ */
+type SubgraphErrorStreamEvent = AsSubgraph<{
+  id?: string;
+  event: "error";
+  data: {
+    error: string;
+    message: string;
+  };
+}>;
+/**
+ * Stream event with updates to the state after each step.
+ * The streamed outputs include the name of the node that
+ * produced the update as well as the update.
+ */
+type UpdatesStreamEvent<UpdateType, NodeReturnType> = AsSubgraph<{
+  id?: string;
+  event: "updates";
+  data: NodeReturnType extends Record<string, unknown> ? { [K in keyof NodeReturnType]?: NodeReturnType[K] } & {
+    [node: string]: UpdateType;
+  } : Record<string, UpdateType>;
+}>;
+/**
+ * Streaming custom data from inside the nodes.
+ */
+type CustomStreamEvent<T> = AsSubgraph<{
+  id?: string;
+  event: "custom";
+  data: T;
+}>;
+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;
+  };
+};
+type TasksStreamEvent<StateType, UpdateType> = AsSubgraph<TasksStreamCreateEvent<StateType>> | AsSubgraph<TasksStreamResultEvent<UpdateType>> | AsSubgraph<TasksStreamErrorEvent>;
+type CheckpointsStreamEvent<StateType> = AsSubgraph<{
+  id?: string;
+  event: "checkpoints";
+  data: {
+    values: StateType;
+    next: string[];
+    config: Config;
+    metadata: CheckpointMetadata;
+    tasks: ThreadTask[];
+  };
+}>;
+/**
+ * Stream event with detailed debug information.
+ */
+type DebugStreamEvent = AsSubgraph<{
+  id?: string;
+  event: "debug";
+  data: unknown;
+}>;
+/**
+ * Stream event with events occurring during execution.
+ */
+type EventsStreamEvent = {
+  id?: string;
+  event: "events";
+  data: {
+    event: `on_${"chat_model" | "llm" | "chain" | "tool" | "retriever" | "prompt"}_${"start" | "stream" | "end"}` | (string & {}); // eslint-disable-line @typescript-eslint/ban-types
+    name: string;
+    tags: string[];
+    run_id: string;
+    metadata: Record<string, unknown>;
+    parent_ids: string[];
+    data: unknown;
+  };
+};
+type LangGraphEventStream<TStateType = unknown, TUpdateType = TStateType, TCustomType = unknown, TInterruptType = unknown, TNodeReturnType = unknown> = ValuesStreamEvent<TStateType, TInterruptType> | UpdatesStreamEvent<TUpdateType, TNodeReturnType> | CustomStreamEvent<TCustomType> | DebugStreamEvent | MessagesTupleStreamEvent | EventsStreamEvent | TasksStreamEvent<TStateType, TUpdateType> | CheckpointsStreamEvent<TStateType> | SubgraphErrorStreamEvent | MetadataStreamEvent;
+//#endregion
+export { LangGraphEventStream };
+//# sourceMappingURL=types.schema.d.ts.map

package/dist/ui/types.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.schema.d.ts","names":["SerializedMessage","Optional","T","MessageTupleMetadata","DefaultValues","Record","ThreadState","ValuesType","Checkpoint","CheckpointMetadata","ThreadTask","Array","Interrupt","Config","TValue","AsSubgraph","TEvent","ValuesStreamEvent","InterruptType","StateType","MessagesTupleStreamEvent","AnyMessage","MetadataStreamEvent","SubgraphErrorStreamEvent","UpdatesStreamEvent","NodeReturnType","K","UpdateType","CustomStreamEvent","TasksStreamCreateEvent","TasksStreamResultEvent","TasksStreamErrorEvent","TasksStreamEvent","CheckpointsStreamEvent","DebugStreamEvent","EventsStreamEvent","LangGraphEventStream","TStateType","TInterruptType","TUpdateType","TNodeReturnType","TCustomType"],"sources":["../../src/ui/types.schema.d.ts"],"sourcesContent":["import type { SerializedMessage } from \"./types.message.js\";\ntype Optional<T> = T | null | undefined;\ntype MessageTupleMetadata = {\n    tags: string[];\n    [key: string]: unknown;\n};\ntype DefaultValues = Record<string, unknown>[] | Record<string, unknown>;\ninterface ThreadState<ValuesType = DefaultValues> {\n    /** The state values */\n    values: ValuesType;\n    /** The next nodes to execute. If empty, the thread is done until new input is received */\n    next: string[];\n    /** Checkpoint of the thread state */\n    checkpoint: Checkpoint;\n    /** Metadata for this state */\n    metadata: CheckpointMetadata;\n    /** Time of state creation  */\n    created_at: Optional<string>;\n    /** The parent checkpoint. If missing, this is the root checkpoint */\n    parent_checkpoint: Optional<Checkpoint>;\n    /** Tasks to execute in this step. If already attempted, may contain an error */\n    tasks: Array<ThreadTask>;\n}\ninterface ThreadTask {\n    id: string;\n    name: string;\n    result?: unknown;\n    error: Optional<string>;\n    interrupts: Array<Interrupt>;\n    checkpoint: Optional<Checkpoint>;\n    state: Optional<ThreadState>;\n}\ntype Config = {\n    /**\n     * Tags for this call and any sub-calls (eg. a Chain calling an LLM).\n     * You can use these to filter calls.\n     */\n    tags?: string[];\n    /**\n     * Maximum number of times a call can recurse.\n     * If not provided, defaults to 25.\n     */\n    recursion_limit?: number;\n    /**\n     * Runtime values for attributes previously made configurable on this Runnable.\n     */\n    configurable?: {\n        /**\n         * ID of the thread\n         */\n        thread_id?: Optional<string>;\n        /**\n         * Timestamp of the state checkpoint\n         */\n        checkpoint_id?: Optional<string>;\n        [key: string]: unknown;\n    };\n};\ntype CheckpointMetadata = Optional<{\n    source?: \"input\" | \"loop\" | \"update\" | (string & {}); // eslint-disable-line @typescript-eslint/ban-types\n    step?: number;\n    writes?: Record<string, unknown> | null;\n    parents?: Record<string, string>;\n    [key: string]: unknown;\n}>;\ninterface Checkpoint {\n    thread_id: string;\n    checkpoint_ns: string;\n    checkpoint_id: Optional<string>;\n    checkpoint_map: Optional<Record<string, unknown>>;\n}\n/**\n * An interrupt thrown inside a thread.\n */\ninterface Interrupt<TValue = unknown> {\n    /**\n     * The ID of the interrupt.\n     */\n    id?: string;\n    /**\n     * The value of the interrupt.\n     */\n    value?: TValue;\n}\ntype AsSubgraph<TEvent extends {\n    id?: string;\n    event: string;\n    data: unknown;\n}> = {\n    id?: TEvent[\"id\"];\n    event: TEvent[\"event\"] | `${TEvent[\"event\"]}|${string}`;\n    data: TEvent[\"data\"];\n};\n/**\n * Stream event with values after completion of each step.\n */\ntype ValuesStreamEvent<StateType, InterruptType> = AsSubgraph<{\n    id?: string;\n    event: \"values\";\n    data: unknown extends InterruptType ? StateType : StateType & {\n        __interrupt__?: InterruptType;\n    };\n}>;\n/**\n * Stream event with message chunks coming from LLM invocations inside nodes.\n */\ntype MessagesTupleStreamEvent = AsSubgraph<{\n    id?: string;\n    event: \"messages\";\n    // TODO: add types for message and config, which do not depend on LangChain\n    // while making sure it's easy to keep them in sync.\n    data: [message: SerializedMessage.AnyMessage, config: MessageTupleMetadata];\n}>;\n/**\n * Metadata stream event with information about the run and thread\n */\ntype MetadataStreamEvent = {\n    id?: string;\n    event: \"metadata\";\n    data: {\n        run_id: string;\n        thread_id: string;\n    };\n};\n/**\n * Stream event with error information.\n */\ntype SubgraphErrorStreamEvent = AsSubgraph<{\n    id?: string;\n    event: \"error\";\n    data: {\n        error: string;\n        message: string;\n    };\n}>;\n/**\n * Stream event with updates to the state after each step.\n * The streamed outputs include the name of the node that\n * produced the update as well as the update.\n */\ntype UpdatesStreamEvent<UpdateType, NodeReturnType> = AsSubgraph<{\n    id?: string;\n    event: \"updates\";\n    data: NodeReturnType extends Record<string, unknown> ? {\n        [K in keyof NodeReturnType]?: NodeReturnType[K];\n    } & {\n        [node: string]: UpdateType;\n    } : Record<string, UpdateType>;\n}>;\n/**\n * Streaming custom data from inside the nodes.\n */\ntype CustomStreamEvent<T> = AsSubgraph<{\n    id?: string;\n    event: \"custom\";\n    data: T;\n}>;\ntype TasksStreamCreateEvent<StateType> = {\n    id?: string;\n    event: \"tasks\";\n    data: {\n        id: string;\n        name: string;\n        interrupts: Interrupt[];\n        input: StateType;\n        triggers: string[];\n    };\n};\ntype TasksStreamResultEvent<UpdateType> = {\n    id?: string;\n    event: \"tasks\";\n    data: {\n        id: string;\n        name: string;\n        interrupts: Interrupt[];\n        result: [string, UpdateType][];\n    };\n};\ntype TasksStreamErrorEvent = {\n    id?: string;\n    event: \"tasks\";\n    data: {\n        id: string;\n        name: string;\n        interrupts: Interrupt[];\n        error: string;\n    };\n};\ntype TasksStreamEvent<StateType, UpdateType> = AsSubgraph<TasksStreamCreateEvent<StateType>> | AsSubgraph<TasksStreamResultEvent<UpdateType>> | AsSubgraph<TasksStreamErrorEvent>;\ntype CheckpointsStreamEvent<StateType> = AsSubgraph<{\n    id?: string;\n    event: \"checkpoints\";\n    data: {\n        values: StateType;\n        next: string[];\n        config: Config;\n        metadata: CheckpointMetadata;\n        tasks: ThreadTask[];\n    };\n}>;\n/**\n * Stream event with detailed debug information.\n */\ntype DebugStreamEvent = AsSubgraph<{\n    id?: string;\n    event: \"debug\";\n    data: unknown;\n}>;\n/**\n * Stream event with events occurring during execution.\n */\ntype EventsStreamEvent = {\n    id?: string;\n    event: \"events\";\n    data: {\n        event: `on_${\"chat_model\" | \"llm\" | \"chain\" | \"tool\" | \"retriever\" | \"prompt\"}_${\"start\" | \"stream\" | \"end\"}` | (string & {}); // eslint-disable-line @typescript-eslint/ban-types\n        name: string;\n        tags: string[];\n        run_id: string;\n        metadata: Record<string, unknown>;\n        parent_ids: string[];\n        data: unknown;\n    };\n};\nexport type LangGraphEventStream<TStateType = unknown, TUpdateType = TStateType, TCustomType = unknown, TInterruptType = unknown, TNodeReturnType = unknown> = ValuesStreamEvent<TStateType, TInterruptType> | UpdatesStreamEvent<TUpdateType, TNodeReturnType> | CustomStreamEvent<TCustomType> | DebugStreamEvent | MessagesTupleStreamEvent | EventsStreamEvent | TasksStreamEvent<TStateType, TUpdateType> | CheckpointsStreamEvent<TStateType> | SubgraphErrorStreamEvent | MetadataStreamEvent;\nexport {};\n"],"mappings":";;;KACKC,cAAcC;KACdC,oBAAAA;EADAF,IAAAA,EAAAA,MAAQ,EAAA;EACRE,CAAAA,GAAAA,EAAAA,MAAAA,CAAAA,EAAAA,OAAAA;AAAoB,CAAA;KAIpBC,aAAAA,GAAgBC,MAAH,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,GAA+BA,MAA/B,CAAA,MAAA,EAAA,OAAA,CAAA;UACRC,WADWD,CAAAA,aACcD,aADdC,CAAAA,CAAAA;;UAGTE;EAFFD;EAAW,IAAA,EAAA,MAAA,EAAA;;YAETC,EAIIC,UAJJD;;UAMEE,EAAAA,kBAAAA;;YAIkBD,EAFhBP,QAEgBO,CAAAA,MAAAA,CAAAA;;mBAEfE,EAFMT,QAENS,CAFeF,UAEfE,CAAAA;;SAANC,MAAMD;AAAD;UAENA,UAAAA,CAAU;MAITT,MAAAA;MACWW,EAAAA,MAAAA;QAAND,CAAAA,EAAAA,OAAAA;OACSH,EAFdP,QAEcO,CAAAA,MAAAA,CAAAA;YAATP,EADAU,KACAV,CADMW,SACNX,CAAAA;YACIK,EADJL,QACIK,CADKE,UACLF,CAAAA;OAATL,EAAAA,QAAAA,CAASK,WAATL,CAAAA;;AAAQ,KAEdY,MAAAA,GAAM;EAAA;;;;EA0BNJ,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA;EAAkB;;;;;EAObD;;;cAImBH,CAAAA,EAAAA;IAATJ;;AAAQ;IAevBc,SAAU,CAAA,EAlCKd,QAkCL,CAAA,MAAA,CAAA;IAAA;;;IAMiBe,aAAAA,CAAAA,EApCRf,QAoCQe,CAAAA,MAAAA,CAAAA;IACtBA,CAAAA,GAAAA,EAAAA,MAAAA,CAAAA,EAAAA,OAAAA;;AAAM,CAAA;KAjCXP,kBAAAA,GAAqBR,QAsCJ,CAAA;QAGIiB,CAAAA,EAAAA,OAAAA,GAAAA,MAAAA,GAAAA,QAAAA,GAAAA,CAAAA,MAAAA,GAAAA,CAAAA,CAAAA,CAAAA,CAAAA,CAAAA;MAAgBC,CAAAA,EAAAA,MAAAA;QAAYA,CAAAA,EAtCzCd,MAsCyCc,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,GAAAA,IAAAA;SAC9BD,CAAAA,EAtCVb,MAsCUa,CAAAA,MAAAA,EAAAA,MAAAA,CAAAA;MAJ2BH,EAAAA,MAAAA,CAAAA,EAAAA,OAAAA;;AAAU,UA/BnDP,UAAAA,CAyCLY;EAAwB,SAAA,EAAA,MAAA;eAKTpB,EAAAA,MAAkBqB;eAAoBlB,EA3CvCF,QA2CuCE,CAAAA,MAAAA,CAAAA;gBAL1BY,EArCZd,QAqCYc,CArCHV,MAqCGU,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,CAAAA;;AAAU;AAUlB;AAWkB;UArDhCH,SAkEa,CAAA,SAAA,OAAA,CAAA,CAAA;;;;KAIea,EAAAA,MAAAA;;;;OAG9BpB,CAAAA,EAjEIS,MAiEJT;;KA/DHU;EAoEAa,EAAAA,CAAAA,EAAAA,MAAAA;EAAiB,KAAA,EAAA,MAAA;MAGZ1B,EAAAA,OAAAA;;OAlEDc;EAoEJa,KAAAA,EAnEMb,MAmENa,CAAAA,OAAAA,CAAAA,GAAsB,GAnEKb,MAmEL,CAAA,OAAA,CAAA,IAAA,MAAA,EAAA;EAAA,IAAA,EAlEjBA,MAkEiB,CAAA,MAAA,CAAA;;;;AAOH;KApEnBC,iBAwEsB,CAAA,SAAA,EAAA,aAAA,CAAA,GAxEwBF,UAwExB,CAAA;KAMPH,EAAAA,MAAAA;OACKe,EAAAA,QAAAA;wBA5ECT,gBAAgBC,YAAYA;IA+EjDY,aAAAA,CAAAA,EA9EmBb,aA8EE;EAUrBc,CAAAA;CAAgB,CAAA;;;;KAlFhBZ,wBAAAA,GAA2BL,UAkFiGY,CAAAA;KAAvBG,EAAAA,MAAAA;OAAXf,EAAAA,UAAAA;;;kBA7E3Ef,iBAAAA,CAAkBqB,oBAAoBlB;AA6EgG,CAAA,CAAA;;;;KAxErJmB,mBAAAA,GAgFab;KACHC,EAAAA,MAAAA;OAR0BK,EAAAA,UAAAA;;IAcpCmB,MAAAA,EAAAA,MAAAA;IAQAC,SAAAA,EAAAA,MAAiB;EAaVC,CAAAA;CAAoB;;;;KAjG3Bb,wBAAAA,GAA2BR,UAiG+HE,CAAAA;KAAmEsB,EAAAA,MAAAA;OAAaC,EAAAA,OAAAA;MAAhChB,EAAAA;IAAqEiB,KAAAA,EAAAA,MAAAA;IAAlBb,OAAAA,EAAAA,MAAAA;;;;;;;;KApF7PJ,kBAoF4YS,CAAAA,UAAAA,EAAAA,cAAAA,CAAAA,GApF3VlB,UAoF2VkB,CAAAA;KAAqCV,EAAAA,MAAAA;OAA2BD,EAAAA,SAAAA;QAjFvcG,uBAAuBpB,wCACboB,kBAAkBA,eAAeC;oBAE7BC;MAChBtB,eAAesB;;;;;KAKlBC,uBAAuBb;;;QAGlBb;;KAEL2B;;;;;;gBAMejB;WACLO;;;;KAIVW;;;;;;gBAMelB;qBACKe;;;KAGpBI,qBAAAA;;;;;;gBAMenB;;;;KAIfoB,0CAA0CjB,WAAWc,uBAAuBV,cAAcJ,WAAWe,uBAAuBH,eAAeZ,WAAWgB;KACtJE,oCAAoClB;;;;YAIzBI;;YAEAN;cACEJ;WACHC;;;;;;KAMVwB,gBAAAA,GAAmBnB;;;;;;;;KAQnBoB,iBAAAA;;;;;;;;cAQa9B;;;;;KAKN+B,yDAAyDC,0FAA0FpB,kBAAkBoB,YAAYC,kBAAkBd,mBAAmBe,aAAaC,mBAAmBZ,kBAAkBa,eAAeP,mBAAmBd,2BAA2Be,oBAAoBH,iBAAiBK,YAAYE,eAAeN,uBAAuBI,cAAcd,2BAA2BD"}