@langchain/langgraph/dist/stream/transformers/types.d.ts

LangGraph

import { ChatModelStreamHandle, Namespace } from "../types.js";
import { StreamChannel } from "../stream-channel.js";
import { AgentStatus, LifecycleData } from "@langchain/protocol";

//#region src/stream/transformers/types.d.ts
/**
 * The projection shape merged into a run stream by the messages transformer.
 * Exposes a `messages` async iterable that yields one message stream handle
 * per AI message lifecycle observed during the run.
 */
interface MessagesTransformerProjection {
  messages: AsyncIterable<ChatModelStreamHandle>;
}
/**
 * The projection shape merged into a run stream by the values transformer.
 * Exposes the underlying local {@link StreamChannel} so that `StreamMux` can
 * resolve the final output value on close.
 */
interface ValuesTransformerProjection {
  _valuesLog: StreamChannel<Record<string, unknown>>;
}
/**
 * Single lifecycle entry surfaced by the in-process
 * `GraphRunStream.lifecycle` projection. Combines the CDDL
 * {@link LifecycleData} payload with the namespace it applies to so
 * consumers can filter or correlate without dipping into raw
 * `ProtocolEvent`s.
 */
interface LifecycleEntry extends LifecycleData {
  /** Namespace the lifecycle event applies to. */
  readonly namespace: Namespace;
  /** Wall-clock timestamp (milliseconds) of the emission. */
  readonly timestamp: number;
}
/**
 * Configuration knobs for {@link createLifecycleTransformer}.
 */
interface LifecycleTransformerOptions {
  /**
   * Human-readable name for the root graph. Used as `graph_name` for
   * the root lifecycle event.
   *
   * @defaultValue `"root"`
   */
  rootGraphName?: string;
  /**
   * Lifecycle status emitted for the root namespace when
   * {@link LifecycleTransformerOptions.emitRootOnRegister} is `true`.
   *
   * @defaultValue `"running"`
   */
  initialStatus?: AgentStatus;
  /**
   * When `true`, the transformer emits the root `lifecycle.started` (or
   * `.running`) event synchronously from `onRegister` and emits the
   * terminal root event from `finalize`/`fail`. Set to `false` when an
   * outer authority (e.g. `RunProtocolSession`) is responsible for
   * root lifecycle emission; in that case the transformer still tracks
   * root status internally for cascade purposes but does not write to
   * the wire.
   *
   * @defaultValue `true`
   */
  emitRootOnRegister?: boolean;
  /**
   * Resolves a human-readable graph name for a non-root namespace.
   * The default uses the last segment of the namespace, stripping any
   * `:suffix` (e.g. `["tools:abc"]` -> `"tools"`).
   */
  getGraphName?: (ns: Namespace) => string;
  /**
   * Optional async hook consulted by `finalize()` to override the
   * computed terminal status. Returning a status here wins over the
   * pending-interrupt heuristic. Useful for carriers (like the API
   * session) that have authoritative knowledge of thread state.
   */
  getTerminalStatusOverride?: () => Promise<AgentStatus | undefined>;
  /**
   * Converts an unknown failure value to a string for the
   * `lifecycle.failed` `error` field.
   *
   * @defaultValue a default implementation that handles `Error` and
   *   primitives.
   */
  serializeError?: (err: unknown) => string;
}
//#endregion
export { LifecycleEntry, LifecycleTransformerOptions, MessagesTransformerProjection, ValuesTransformerProjection };
//# sourceMappingURL=types.d.ts.map