dsh-plugin-guide 0.3.41 → 0.4.0

package/references/official-docs/docs/subsystems/session.md

@@ -1,1339 +0,0 @@
-# Sessions
-
-English | [中文](session.zh.md)
-
-The in-memory, event-sourced model of [dsh-session](../../packages/core/session). A `Session` is an **append-only log** of typed `SessionEvent`s — the single source of truth for an agent's whole interaction history. The LLM message history is *derived* from the log, never stored separately; replay is re-derivation from the same events. How the log is made **durable** (the persistence seam, backends, crash recovery) is the sibling concern on [persistence.md](persistence.md).
-
-Source: [`packages/core/session/src/types.ts`](../../packages/core/session/src/types.ts)
-
-## `SessionEventMap` — the event vocabulary
-
-The append-only event types. Merge-extensible: a plugin declares extra event types via declaration merging — e.g. the [compaction seam](compaction.md) adds `compaction/start` / `compaction/summary` / `compaction/end`, and `@deepseek-ai/dsh-hook-protocol` adds log-only `hook/invoked` / `hook/result` records for a hook bridge. Like `compaction/*`, these are NOT `SurfaceEventType`s (no `surfaceOp`). The generated [persistence log event catalog](../persistence-catalog.md) enumerates every member — core and merged — with its payload, surface badge, and declaration site.
-
-```ts type-equiv
-/** A user-role specialization of the shared message representation. */
-interface UserMessage extends MessageBase {
-  readonly role: 'user'
-}
-```
-
-```ts type-equiv
-/**
- * The merge-extensible, append-only source of truth for an agent interaction.
- * Message history is derived from this log. Every event is lossless JSON and
- * sequence numbers stay contiguous. Assistant attempt events embed their exact
- * compact raw streams so persistence stores one durable settlement per attempt.
- */
-interface SessionEventMap {
-  /**
-   * Opens turn `turn` before the loop claims queued input or runs pre-step.
-   * Rejection, empty input, cancellation, or failure may close it with no
-   * step; otherwise the following identified `user/message` event or batch
-   * records the messages entering the step.
-   */
-  'turn/start': { turn: number }
-  /**
-   * Closes turn `turn` with the {@link TurnEndReason} that ended it. A turn
-   * with no entered step has no `step/start` or `step/end`. The loop does not await a
-   * flush at turn boundaries: `dsh-session-checkpoint-policy` owns the
-   * per-request durability checkpoint, and consumers that read storage after
-   * `whenIdle()` flush themselves. Success commits the turn; rejection is
-   * reported live and does not prevent later work.
-   */
-  'turn/end': { turn: number; reason: TurnEndReason }
-  /** Opens step `step` of turn `turn` — one model call plus the tool executions it requested. */
-  'step/start': { turn: number; step: number }
-  /** Closes step `step` of turn `turn`. */
-  'step/end': { turn: number; step: number }
-  /**
-   * A user-role message on the model-visible surface: a direct human prompt
-   * (the queued message claimed for this turn), a synthetic `agent.inject()`
-   * context (file-change notices, subdir AGENTS.md, skill content, cron
-   * notifications, …), or an entered goal continuation round. All three
-   * project their `content` verbatim; `source` tells them apart.
-   */
-  'user/message': UserMessage
-  /** An incremental agent session change admitted at the named turn and step. */
-  'developer/message': {
-    turn: number
-    step: number
-    message: DeveloperMessage
-    /** Earlier request/header defining every tool addition; required exactly when additions are present. */
-    headerSeq?: SessionSeq
-  }
-  /**
-   * The rendered system prompt on the model-visible surface. The loop appends
-   * the first one as surface node 0 before the step's first `user/message`.
-   * A prepared in-history route can append nonempty changes in a continuing
-   * series. An incapable route or new series normalizes text to the first system
-   * node. Normalization empties nonempty later nodes, then rewrites the head if
-   * needed, through logged per-node replacements. An empty rendering always
-   * clears all active system nodes, leaving no older instructions model-visible.
-   * Empty later nodes are dormant and project to no message; an empty head with
-   * no active later node records "no system prompt". Restored nonempty text follows
-   * the same route and series rule; empty nodes never restore older text.
-   */
-  'system/message': { turn: number; step: number; message: SystemMessage }
-  /**
-   * Assembled assistant message for one step (derived history uses this).
-   * Carries the step's `usage` when the adapter reported token accounting, so
-   * the model output and its accounting travel together (there is no separate
-   * usage record). `usage` is absent when the adapter reported none. A turn
-   * cancelled mid-stream finalizes its delivered text/reasoning prefix as this
-   * event with `interrupted: true`; undispatched tool calls are absent. The
-   * marker distinguishes that prefix without re-deriving interruption from turn
-   * boundaries. An aborted turn with no such event streamed no visible content.
-   */
-  'assistant/message': {
-    turn: number
-    step: number
-    message: AssistantMessage
-    /** Exact timed model stream, compacted without joining delta boundaries. */
-    stream: AssistantStreamRecord[]
-    usage?: TokenUsage
-    interrupted?: true
-  }
-  /**
-   * One model attempt that committed no surface message. The embedded stream
-   * preserves a failed, retried, cancelled, or stream-error attempt that
-   * reached settlement without fabricating model-visible history.
-   */
-  'assistant/attempt': { turn: number; step: number; stream: AssistantStreamRecord[] }
-  /**
-   * The model requested one tool invocation: `name` with the raw `arguments`
-   * JSON string exactly as the model produced it (unparsed). `callId` pairs the
-   * call with its `tool/result`.
-   */
-  'tool/call': { turn: number; step: number; callId: ToolCallId; name: string; arguments: string }
-  /**
-   * A completed tool call's model-facing result, optional internal failure
-   * identity and user-facing reason, and optional tool-private `meta`
-   * presentation payload. The reason remains outside the model-facing message.
-   * `meta` is
-   * opaque to the core (the producing tool owns its shape and reads it back in
-   * `presentResult`) but MUST be JSON-serializable: `Session.append`
-   * runtime-validates all event data with `isJsonValue`, so a non-serializable
-   * `meta` is rejected at the source, and the durable log reproduces the
-   * identical card on replay. Absent
-   * unless the tool attaches one (e.g. `dsh-tool-fs` carries its result-time
-   * contextual diff here).
-   */
-  'tool/result': {
-    turn: number
-    step: number
-    message: ToolResultMessage
-    /**
-     * Optional failure identity and raw user-facing reason, outside model content;
-     * allowed only when the message has `isError: true`.
-     */
-    error?: { name: string; code: string; reason?: string }
-    meta?: JsonValue
-  }
-  /**
-   * Full header for the next request, appended inside its step before dispatch.
-   * It is log-only; the latest snapshot reconstructs the request header.
-   */
-  'request/header': {
-    header: EpochHeader
-    reason: RequestHeaderReason
-    /** This request begins a distinct model-message series, independently of the header reason. */
-    startsSeries?: true
-  }
-  /**
-   * Route metadata for the next request, logged only when the route, capacity,
-   * or system prompt update mode changes. It does not participate in request
-   * reconstruction or header equality. Prompt admission uses the bound prepared
-   * call's capability, not this snapshot from an earlier request.
-   */
-  'request/context': RequestContext
-  /**
-   * Separates inherited or restored history from later lifecycle-owned work.
-   * This log-only marker need not be at {@link Session.firstLiveSeq}: a fork
-   * seed can already contain its tagged marker and child-owned synthetic
-   * closers before construction.
-   *
-   * A fresh fork child owns one `{ inherited: true }` marker at its exact
-   * inherited-prefix cut, even when that prefix ends in an ancestor marker.
-   * `buildForkSeed` appends that marker before any synthetic closers; the
-   * `Session` constructor supplies it when given only the inherited prefix.
-   * The last tagged marker is the current Session's cut; untagged markers
-   * keep ordinary restore and replay lifecycle boundaries.
-   *
-   * Only the `Session` constructor and `buildForkSeed` may create this marker.
-   * Session append does not reject other writers, so a plugin appending one
-   * would silently classify every live bracket before it as seed history.
-   *
-   * An owner of a standalone open/close bracket (`compaction/start` …
-   * `compaction/end`) reads it because seed history and live work are otherwise
-   * byte-identical: an unmatched opening marker before this event belongs to
-   * an ended lifecycle, whatever ended it. NOT a liveness signal about other
-   * writers — a concurrently live session holds its own boundary elsewhere,
-   * so tolerating concurrent writers needs a signal beyond the log.
-   */
-  'session/end-seed': { inherited?: true }
-}
-```
-
-`UserMessage` is the identified, frozen user-role value shared by ordinary prompts, injected context, steering, and live inbox events. Event wrappers add only event-local position or outcome facts; the loop adds only driver-owned routing state while an item remains pending.
-
-<a id="the-request-header-event-requestheader"></a>
-
-### The request header event: `request/header`
-
-The request envelope — the `EpochHeader` (call config + markers for adapter-supplied defaults + assembled tool schemas) — is logged session state, so every conversation request is a pure function of the log (the reconstructability Agent Note). The rendered system prompt is not part of the header: it is derived history, the `system/message` event at surface node 0 and any later in-history system node ([decision](../../.agents/notes/implemented/architecture/2026-09-02-system-prompt-as-surface-node.md)), so a prompt change replaces or appends a system node and leaves the header unchanged. A full `request/header` snapshot with reason `'initial'` or `'resume'` records each loop-instance boundary; a changed request appends a snapshot with reason `'change'`; and an unchanged envelope beginning an explicitly declared message series or following a surface replacement appends a snapshot with reason `'series'`. An `'initial'`, `'resume'`, or `'change'` snapshot carries `startsSeries: true` when that request also begins a series; reason `'series'` already records that fact. Ordinary append-only later Turns, further Steps, and retries in the same model-message series inherit the latest snapshot. `foldRequestHeader(events)` reconstructs the header by selecting the latest snapshot. The event is not a `SurfaceEventType`: it produces no LLM message.
-
-```ts type-equiv
-/**
- * Logged request state outside derived history: call config and tools. The
- * system prompt is derived history — surface node 0, a `system/message` event.
- * The latest full `request/header` snapshot reconstructs the header; canonical
- * empty optional fields are absent.
- */
-interface EpochHeader {
-  /** The conversation's call configuration (provider, model, reasoning effort, and sampling scalars). */
-  config: LlmCallConfig
-  /** Effective config fields materialized from the exact adapter rather than proposed by a caller. */
-  adapterDefaults?: LlmCallConfigAdapterDefaults
-  /** Assembled tool schemas; absent for a tool-less request. */
-  tools?: ToolSchema[]
-  /** Retired request text; system prompts belong to system/message events.
-   * @persistenceReserved
-   */
-  system?: never
-}
-```
-
-Current event acceptance requires canonical `request/header.header`: any `system` field is forbidden, and `tools: []` and `adapterDefaults: {}` must be omitted. Whitespace-only system-message content, `config.stop: []`, and nested extensions remain unchanged. Seed, append, and current persistence reads reject noncanonical headers rather than silently normalizing them; [the V3 envelope decision](../../.agents/notes/implemented/architecture/2026-09-06-v3-canonical-session-envelopes.md) owns historical conversion. Legacy v0 logs containing `request/header-delta` or its full-snapshot `fallback` reason are rejected rather than replayed incompletely.
-
-### The route capacity event: `request/context`
-
-The context metadata of the route a request resolved to is separate logged state, appended beside `request/header` inside the same step and only when the provider, model, capacity, or `systemPromptUpdate` mode differs from the previous record. It stays outside `EpochHeader` because that type is the reconstruction contract compared field-wise by `headerEquals`: capacity and the update mode describe a route, not a request input, so folding them in would let a route change register as a request-envelope `change` and would pull adapter metadata into the loop's request reconstruction. Like `request/header`, it is not a `SurfaceEventType` and produces no LLM message. `session.requestContext()` folds the latest record incrementally; the agent loop reads that record's `systemPromptUpdate` when it decides whether a changed system prompt replaces the latest system node or is appended after the cached history ([decision rule](../../packages/core/agent-loop/README.md#understand-the-implementation)). A route whose adapter advertises no capacity is recorded with `contextWindow` absent, so the new record clears an older route's capacity; a route without a declared update mode likewise clears an older route's `systemPromptUpdate`.
-
-```ts type-equiv
-/** Registration-bound metadata for one resolved model route. */
-interface RequestContext {
-  /** Registered provider route the metadata belongs to. */
-  provider: string
-  /** Provider-owned model id the metadata belongs to. */
-  model: string
-  /** Maximum combined request and response context in tokens, when advertised. */
-  contextWindow?: number
-  /** `'in-history'` when the route reads the latest `system` message at any position as the effective system prompt. */
-  systemPromptUpdate?: SystemPromptUpdate
-}
-```
-
-## `SessionEvent<T>` — one log entry
-
-A proper discriminated union over `type` (not independent `type`/`data` unions), so `switch (event.type)` narrows `event.data` without casts. `seq` is the monotonic position in the log (`seq = log.length`); `time` is epoch ms.
-
-```ts type-equiv
-/** Sequence number of one existing event in a Session log. */
-type SessionSeq = BrandedNumber<'SessionSeq'>
-```
-
-```ts type-equiv
-/** A Session log gap, prefix length, or read offset, which may equal the event count. */
-type SessionLogOffset = BrandedNumber<'SessionLogOffset'>
-```
-
-```ts type-equiv
-/** Inclusive Session event watermark, or `-1` before any event exists. */
-type SessionSeqCursor = SessionSeq | -1
-```
-
-```ts type-equiv
-/** One existing Session event position, or explicit absence. */
-type OptionalSessionSeq = SessionSeq | null
-```
-
-`SessionSeq(value)` and `SessionLogOffset(value)` admit only non-negative safe integers and reject negative zero. They add compile-time brands without changing the serialized number; arithmetic returns an ordinary `number` that callers must admit again through the constructor for its intended role.
-
-```ts type-equiv
-/**
- * One immutable entry in the session log.
- *
- * A proper discriminated union over `type` (not independent `type`/`data`
- * unions), so `switch (event.type)` narrows `event.data` without casts.
- *
- * The {@link sourceEventSeqs} and {@link surfaceOp} fields are conditional:
- * they only exist on {@link SurfaceEventType} variants (`system/message`, `user/message`,
- * `assistant/message`, `tool/result`).
- * Non-surface events (boundary markers, attempts, errors) never carry
- * surface metadata — the compiler enforces this at `Session.append()`
- * call sites.
- */
-type SessionEvent<T extends SessionEventType = SessionEventType> = {
-  [K in SessionEventType]: {
-    type: K
-    /** Monotonic sequence number within the session. */
-    seq: SessionSeq
-    /** Unix epoch milliseconds. */
-    time: number
-    data: SessionEventMap[K]
-    /**
-     * Marks an event a reader may safely skip when it does not recognize
-     * `type`. Absent means required: a reader meeting an unrecognized type
-     * without this marker MUST refuse to reconstruct the session instead of
-     * silently dropping the event, because an unrecognized required event may
-     * change how the rest of the log is interpreted. A writer sets `true` only
-     * on purely informational records whose loss cannot affect reconstruction;
-     * defaulting to required means a forgotten marker over-refuses (an
-     * inconvenience) rather than silently resuming a gutted session.
-     */
-    ignorable?: true
-  } & (K extends SurfaceEventType ? SurfaceIntent<K> : {
-    surfaceOp?: never
-    sourceEventSeqs?: never
-  })
-}[T]
-```
-
-`SessionEventType = keyof SessionEventMap`. Because `SessionEventMap` is merge-extensible, switches over `SessionEvent` must NOT use `assertNever` — a plugin-added variant is a valid unknown value; handle the known cases and fall through `default`.
-
-Every surface event requires `surfaceOp`; known log-only events forbid both surface metadata fields. Native unknown or obsolete ignorable envelopes remain opaque. `assistant/message` embeds its provider stream and forbids `sourceEventSeqs`. System, user, and tool surface events may cite a complete non-empty set of unique earlier events when source attribution or replacement coverage requires it. A `tool/result` may carry `data.error` only when its message has `isError: true`; failure identity remains optional for failed results.
-
-## Surface types
-
-The message-producing types (`SurfaceEventType` — `system/message`, `developer/message`, `user/message`, `assistant/message`, `tool/result`) carry surface metadata declaring how they join the ordered derived surface. `system/message` holds the rendered system prompt: the loop appends the first one as surface node 0 and, when the prompt changes, replaces exactly the latest system node or appends a new one on an in-history route; the surface fold rejects any other replacement covering a `system/message` at node 0, while a later system node is ordinary history that a compaction replacement may shadow. See the [session surface Agent Note](../../.agents/notes/implemented/architecture/2026-06-18-session-surface.md).
-
-### `SurfaceEventType` — the message-producing subset of event types
-
-```ts type-equiv
-/**
- * The subset of {@link SessionEventType} values whose events produce LLM
- * messages and are eligible to appear on the ordered surface. Only these
- * event types may carry {@link SurfaceOp}; system, user, and tool events may also cite
- * earlier sources through {@link SessionEvent.sourceEventSeqs}.
- */
-type SurfaceEventType =
-  | 'system/message'
-  | 'developer/message'
-  | 'user/message'
-  | 'assistant/message'
-  | 'tool/result'
-```
-
-### `SurfaceOp` — how an event entered the surface
-
-```ts type-equiv
-/**
- * How a session event entered the ordered surface. Only valid on
- * {@link SurfaceEventType} events.
- *
- * - `'append'`: added to the tail — normal path for user/assistant/tool
- *   messages.
- * - `{ op: 'replace', startSeq, endSeq }`: replaces surface nodes from `startSeq`
- *   (inclusive) through `endSeq` (inclusive) with this node. Both must exist as
- *   surface nodes in the current surface. `startSeq === endSeq` replaces a single
- *   node. The node's {@link SessionEvent.sourceEventSeqs} must include every
- *   shadowed surface node. Used by compaction; any surface-replacing producer
- *   may use it.
- */
-type SurfaceOp =
-  | 'append'
-  | { op: 'replace'; startSeq: SessionSeq; endSeq: SessionSeq }
-```
-
-`'append'` is the normal tail-append path. `replace` contains exactly `op`, `startSeq`, and `endSeq`, with no aliases or extra keys. It shadows the inclusive span between those current surface event sequences and inserts the new event in their place; equal endpoints replace one entry. Endpoints must precede the replacing event, but their relative order is surface order, not numeric sequence order.
-
-### `SurfaceIntent` — the parameter to `session.append()`
-
-```ts type-equiv
-/**
- * Surface placement and cited source-event seqs for {@link Session.append}. Required on
- * message-producing events and forbidden on log-only events.
- */
-type SurfaceIntent<T extends SurfaceEventType = SurfaceEventType> = {
-  surfaceOp: SurfaceOp
-} & (T extends 'assistant/message' ? {
-  /** Assistant messages embed their provider stream instead of citing source events. */
-  sourceEventSeqs?: never
-} : {
-  /** Complete non-empty set of known earlier source-event seqs. */
-  sourceEventSeqs?: SessionSeq[]
-})
-```
-
-Required for `SurfaceEventType` events — every message-producing event must declare how it joins the surface, the sole source of derived model history. A human-facing transcript is the other projection and reads the log's append-origin events instead, because the surface deliberately shadows the ranges a replacement summarizes (`isAppendSurfaceEvent` in [dsh-session](../../packages/core/session/README.md)). Non-surface types reject it at compile time.
-
-`assistant/message` cannot carry `sourceEventSeqs`; its `stream` owns exact provider evidence. Other surface events omit the field when they cite no earlier event and use a complete non-empty list when they do.
-
-<a id="plugin-owned-message-projections"></a>
-### Plugin-owned message projections
-
-Content-changing plugins mark their event declaration with `@messageProjection` and register a pure definition through `ctx.sessions.registerMessageProjection()`. Session validates the complete decision through that definition before commit, applies its immutable message updates, and advances `contentGeneration`. It rejects missing interpreters, including on restore and detached folding; unloading a used definition blocks cached reads. Detached readers pass explicit definitions to `foldSurface(events, projections)` and apply `projectedMessages` through `deriveEventMessage()`. The installed format catalog assembles first-party definitions for offline readers. The [image-offload plugin](compaction.md#image-offload) owns its image-specific event and interpretation.
-
-```ts type-equiv
-/** Readonly history immediately before a message-projection event. */
-interface SessionMessageProjectionContext {
-  /** Current message-producing event sequences in model-visible order. */
-  nodes: readonly SessionSeq[]
-  /** Contiguous event window; entries at or beyond the candidate seq are not committed inputs. */
-  events: readonly SessionEvent[]
-  /** Absolute sequence of the window's first event. */
-  baseSeq: SessionLogOffset
-  /** Previously projected messages keyed by their original event sequences. */
-  messages: ReadonlyMap<SessionSeq, Message>
-}
-```
-
-```ts type-equiv
-/** Pure interpretation of one plugin-owned event that changes existing message content. */
-interface SessionMessageProjection<T extends SessionEventType = SessionEventType> {
-  /** Event interpreted by this definition; declare it with `@messageProjection` in SessionEventMap. */
-  type: T
-  /**
-   * Validate the complete durable decision before returning any updates. Preserve
-   * message identities and publish immutable copies without mutating the input.
-   * @param event - candidate event, not yet applied to the supplied history.
-   * @param context - history preceding this decision.
-   * @returns changed current messages keyed by their original sequences.
-   * @throws when the durable decision cannot be applied to this history.
-   */
-  project(event: SessionEvent<T>, context: SessionMessageProjectionContext): ReadonlyMap<SessionSeq, Message>
-}
-```
-
-### `SessionSurface` — the live readonly surface projection
-
-`Session.surface` returns the session's stable `SessionSurface` view. The same incremental manager validates append candidates before commit and advances this projection from committed events; callers can observe membership and replacement generation but cannot invoke validation.
-
-`SurfaceManager(log, baseSeq?, projections?)` can instead fold a contiguous loaded window whose first event has the absolute sequence `baseSeq`. Every event remains contiguous in that absolute sequence space, and a replacement that crosses the window head fails because its declared range is absent.
-
-```ts type-equiv
-/** Readonly live projection of the message-producing session events. */
-interface SessionSurface {
-  /** Current surface event sequences in model-visible order. */
-  readonly nodes: readonly SessionSeq[]
-  /** Monotonic count of committed positional replacements. */
-  readonly replaceGeneration: number
-  /** Monotonic count of committed replacements and plugin-owned message changes. */
-  readonly contentGeneration: number
-}
-```
-
-### `SurfaceFoldReplacement` and `SurfaceFoldResult` — a complete surface replay
-
-`foldSurface(events, projections)` returns detached current event sequences together with the actual sequences shadowed by each declared replacement range. The live manager uses the same transitions without retaining replacement history. Its `replaceGeneration` increments for each committed replacement so incremental consumers can distinguish pure tail growth from a rewrite.
-
-```ts type-equiv
-/** One replacement operation observed while folding a session surface. */
-interface SurfaceFoldReplacement {
-  /** Seq of the event that replaced the prior surface range. */
-  seq: SessionSeq
-  /** Declared inclusive start seq of the replaced surface range. */
-  start: SessionSeq
-  /** Declared inclusive end seq of the replaced surface range. */
-  end: SessionSeq
-  /** Actual surface entries removed by the operation, in surface order. */
-  shadowedSeqs: SessionSeq[]
-}
-```
-
-```ts type-equiv
-/** Complete result of replaying the surface operations in a session log. */
-interface SurfaceFoldResult {
-  /** Current surface event sequences in model-visible order. */
-  nodes: SessionSeq[]
-  /** Replacement operations in event order. */
-  replacements: SurfaceFoldReplacement[]
-  /** Immutable projected messages, keyed by their original event sequences. */
-  projectedMessages: ReadonlyMap<SessionSeq, Message>
-}
-```
-
-## `Session` public API
-
-The body-stripped declaration keeps the plain class's detached factory, state accessors, append method, and history projections synchronized with source. Store operations remain in the generated [`ctx.sessions` section](#ctxsessions--sessionstore).
-
-```ts public-api
-/**
- * An event-sourced session: an append-only log of {@link SessionEvent}s.
- *
- * Plain class (not a Service) — create live instances via
- * `ctx.sessions.create()` and detached instances via {@link create}.
- * Seeding with an existing event log replays/forks a session.
- * @typert object
- */
-declare class Session {
-  /** The ordered surface over this session's event log. */
-  get surface(): SessionSurface;
-  /**
-   * Detached, deep-frozen creation metadata (format version, cwd, lineage,
-   * and whether fork history exists). Supplied by the store via `ctx.sessions.create()`. When a
-   * `Session` is created without a store-owned header, a minimal header is
-   * synthesized (stamped with the current {@link SESSION_FORMAT_VERSION}) so
-   * `session.header` is always present. Kept out of the event log — it is a
-   * storage concern, not replayable conversation state.
-   */
-  readonly header: SessionHeader;
-  /** Number of leading events inherited from this Session's fork parent. */
-  readonly inheritedEventCount: SessionLogOffset;
-  /** The session identity, derived from its durable header's single copy. */
-  get id(): SessionId;
-  /**
-   * The constructor seed length (0 without one), before any marker appended
-   * during construction. Seed events never publish on `session/event`. A
-   * marker appended before the store attaches occupies this seq without
-   * publishing either; otherwise this seq is available for the next append.
-   *
-   * This in-process offset is not persisted. A fork seed can already contain
-   * the child's inherited marker and synthetic closers, so its child-owned
-   * history starts at {@link inheritedEventCount}, before this offset. A
-   * resumed Session's seed contains its full stored log, while its inherited
-   * count keeps the durable fork cut. Consumers needing complete canonical
-   * history start at seq 0.
-   */
-  readonly firstLiveSeq: SessionLogOffset;
-  /**
-   * First event produced for this object lifecycle. A new fork includes its
-   * child-owned seed marker and closers; a restored Session starts after its
-   * complete stored prefix. This in-process capture offset is not persisted.
-   */
-  readonly firstLifecycleSeq: SessionLogOffset;
-
-  /**
-   * Create a detached session by validating and snapshotting borrowed seed
-   * events and storage metadata.
-   * @param id - session identity.
-   * @param seed - optional borrowed replay or fork events.
-   * @param header - optional borrowed storage metadata.
-   * @param inheritedEventCount - exact fork-inherited prefix length for a seeded header.
-   * @param projections - pure interpreters for plugin-owned message changes.
-   * @returns a detached session.
-   * @throws when a seed event requires a missing message interpreter or fails validation.
-   */
-  static create(
-    id: SessionId,
-    seed?: readonly SessionEvent[],
-    header?: SessionHeader,
-    inheritedEventCount?: SessionLogOffset,
-    projections?: readonly SessionMessageProjection[],
-    ): Session;
-  /**
-   * Restore a detached session by adopting an independently owned or deeply frozen seed.
-   * Runtime-required event fields, event envelopes, sequence continuity, surface
-   * transitions, and header fields are validated without copying or freezing events.
-   * Embedded Assistant streams remain opaque until a stream consumer or storage
-   * verifier reads them.
-   * @param id - restored session identity.
-   * @param seed - independently owned or deeply frozen events.
-   * @param header - independently owned storage metadata.
-   * @param inheritedEventCount - exact fork-inherited prefix length decoded from storage.
-   * @param eventState - aliasing state carried from the operation that produced the seed.
-   * @param projections - pure interpreters for plugin-owned message changes.
-   * @returns a restored detached session.
-   * @throws when a seed event requires a missing message interpreter or fails validation.
-   */
-  static fromRestore(
-    id: SessionId,
-    seed: readonly SessionEvent[],
-    header: SessionHeader,
-    inheritedEventCount: SessionLogOffset,
-    eventState: SessionSeedEventState,
-    projections?: readonly SessionMessageProjection[],
-    ): Session;
-  /**
-   * Return the immutable event stored at one exact sequence number.
-   * @deprecated Existing logic may remain unmigrated for now, but new calls are prohibited.
-   * See the [Agent Note](../../../../.agents/notes/implemented/architecture/2026-09-09-deprecate-synchronous-session-event-reads.md).
-   * @param seq - event sequence number.
-   * @returns the accepted event, or undefined when the log does not contain it.
-   */
-  eventAt(seq: SessionSeq): SessionEvent | undefined;
-  /**
-   * Materialize an immutable snapshot of a half-open event sequence range.
-   * A full current snapshot is reused until the next append; every previously
-   * returned snapshot remains stable after later appends.
-   * @deprecated Existing logic may remain unmigrated for now, but new calls are prohibited.
-   * See the [Agent Note](../../../../.agents/notes/implemented/architecture/2026-09-09-deprecate-synchronous-session-event-reads.md).
-   * @param fromSeq - non-negative inclusive sequence number; defaults to the log start.
-   * @param toSeqExclusive - non-negative exclusive sequence number; defaults to the current end.
-   * @returns a frozen array of the selected deeply frozen events.
-   */
-  snapshotEvents(
-    fromSeq: SessionLogOffset = SessionLogOffset(0),
-    toSeqExclusive: SessionLogOffset = this.seq,
-    ): readonly SessionEvent[];
-  /**
-   * Return this Session's events after its fork-inherited prefix.
-   * @deprecated Existing logic may remain unmigrated for now, but new calls are prohibited.
-   * See the [Agent Note](../../../../.agents/notes/implemented/architecture/2026-09-09-deprecate-synchronous-session-event-reads.md).
-   * @returns a fresh array containing child-owned events in log order.
-   */
-  ownEvents(): readonly SessionEvent[];
-  /**
-   * Whether one existing event position is outside the fork-inherited prefix.
-   * @param seq - event position in this Session.
-   * @returns true when the event belongs to this Session rather than its parent.
-   */
-  isOwnSeq(seq: SessionSeq): boolean;
-  /** The next event's sequence number — always the log length (the `seq = log.length` contiguity contract). */
-  get seq(): SessionLogOffset;
-  /**
-   * Append one typed event to the log and synchronously notify observers via
-   * the store-owned, module-private publication hooks. The hot path never blocks
-   * on I/O — persistence plugins buffer asynchronously. Once the event enters
-   * the log, the append is committed: observer failures are logged and
-   * contained per listener, so they do not change the return value or prevent
-   * later listeners from observing the same accepted event.
-   *
-   * @param type - The event type (key of {@link SessionEventMap}).
-   * @param data - The event payload; must be JSON-serializable.
-   * @param opts - Surface metadata: `surfaceOp` controls how the event enters
-   *   the ordered surface; `sourceEventSeqs` lists the seq numbers of earlier
-   *   events this one derives from. REQUIRED for
-   *   {@link SurfaceEventType} events (every message-producing event must
-   *   declare how it joins the surface, the sole source of derived model
-   *   history) and
-   *   rejected by the compiler for non-surface types like `turn/start` or
-   *   `assistant/attempt`. Assistant messages embed their exact provider
-   *   stream and cannot cite top-level source events.
-   * @returns the logged event — its assigned `seq`/`time` plus the SNAPSHOT of
-   *   `data` that entered the log, so reading `event.data` back sees the logged
-   *   value, never the caller's still-mutable input.
-   * @throws if `data` or surface metadata is not losslessly JSON-serializable
-   *   (BigInt, function, symbol, undefined, negative zero, non-finite number,
-   *   circular reference, sparse array, or an exotic object such as
-   *   Map/Set/Date/class instance), or when the candidate violates the
-   *   request-header empty-field or tool-error consistency rules, or the
-   *   canonical surface contract (marker shape and eligibility, unique
-   *   earlier source-event references, positional replacement validity, and complete
-   *   shadowed-node coverage). One iterative pass reads, validates, and
-   *   copies each nested value once, so a stateful getter cannot supply one value
-   *   to validation and another to storage. The event log is the durable source
-   *   of truth, so a bad event fails at the append site rather than later during
-   *   a backend flush. A synchronous internal dispatch validation failure or an
-   *   append reentered while this acceptance/publication boundary is open also
-   *   rejects before the log changes.
-   */
-  append<T extends SessionEventType>(
-    type: T,
-    data: SessionEventMap[T],
-    ...opts: T extends SurfaceEventType ? [opts: SurfaceIntent<T>] : []
-    ): SessionEvent<T>;
-  /**
-   * The {@link EpochHeader} in force after the log's last header event — the
-   * header the NEXT request will be compared against — or undefined before
-   * the first `request/header` snapshot. The live, incrementally-maintained
-   * form of `foldRequestHeader(session.snapshotEvents())`: each header event is folded
-   * once, when first seen, so a per-step read costs O(new events).
-   * @returns the folded header, or undefined when no header event exists yet.
-   */
-  requestHeader(): EpochHeader | undefined;
-  /**
-   * Return the latest resolved route metadata, or `undefined` before the first
-   * `request/context` event. Each event is folded once.
-   * @returns the latest immutable route metadata.
-   */
-  requestContext(): RequestContext | undefined;
-  /**
-   * Fold unseen committed events into capability-independent tool history.
-   * Initial access reconstructs inherited history; later reads consume only new events.
-   * @returns an immutable snapshot for LLM request projection, including historical addition definitions.
-   */
-  toolHistory(): ToolHistory;
-  /**
-   * Derive the LLM message history by walking the ordered sequences of
-   * message-producing events maintained by `surfaceOp` markers. The
-   * surface is the single source of derived history: every message-producing
-   * append records its `surfaceOp`, so a raw event with no marker (a chunk, a
-   * turn boundary) is correctly absent, and a compaction `replace` deletes the
-   * shadowed nodes from the derivation. The projection rules are
-   * {@link deriveEventMessage}, with logged message projections applied
-   * without changing node membership or message identity.
-   *
-   * CACHED: pure tail growth costs O(new nodes); a replacement or message projection
-   * ({@link SessionSurface.contentGeneration}) rebuilds. The returned array is
-   * a fresh snapshot per call (later appends never grow an array a caller
-   * already holds); the `Message` objects in it are SHARED and **deep-frozen**.
-   * Unchanged content reuses frozen event data; projected blocks are frozen
-   * derived copies. Consumers cannot mutate the log through either form.
-   * @returns a fresh array of the shared, frozen derived history.
-   */
-  deriveMessages(): Message[];
-  /**
-   * Project one event with all committed message projections applied.
-   * The original durable event remains unchanged.
-   * @param event - the event to project.
-   * @returns the derived message, or null when the event produces none.
-   */
-  deriveEventMessage(event: SessionEvent): Message | null;
-}
-```
-
-## Derived history: `deriveMessages()` and `deriveEventMessage()`
-
-`Session.deriveMessages()` projects the event log into the `Message[]` the model sees — cached (each surface node projected once, when first seen; a surface rewrite rebuilds) and frozen (a fresh array per call over shared, deep-frozen messages, so mutating logged history through a projection is unrepresentable). `deriveEventMessage(event)` is the per-node pure function the fold applies — public so external reconstructors project a log prefix with exactly the same rules and cannot disagree with the cache. The projection rules:
-
-- `user/message` → a user message carrying exact `content`; an optional envelope remains log-only display metadata.
-- `assistant/message` → an assistant message with the provider and model that produced it plus optional adapter-private replay state. Its embedded compact stream is replay, usage, and UI evidence rather than a second message. An **empty-content** `assistant/message` is also skipped — a max-tokens step cut off with no content still records an `assistant/message` to hold its stream, usage, provider, and model, but a content-less assistant turn must not enter the provider transcript.
-- `tool/result` → a first-class tool-role message carrying its result content and tool-call identity.
-- `user/message` (injected context, i.e. non-`user` source) → a user-role message carrying its `content` verbatim at its chronological position; its typed source names the producer and carries any producer-specific data.
-
-Everything else (`turn/*`, `step/*`, `assistant/attempt`, plugin-owned `llm/retry`) is structural and does not project into a message. Token accounting expands the embedded stream on each `assistant/message` or `assistant/attempt`, while the message's top-level `usage` remains the committed-message authority when present. A failed model-request attempt therefore retains its provider usage without fabricating an assistant message. Current logical validation rejects request headers and assistant messages that omit provider/model instead of guessing a route; supported historical representations are normalized and validated by their adjacent format edge before a current Session exists.
-
-## Live-session fork API
-
-`ctx.sessions.create(id, { seed, meta })` is the low-level replay/fork primitive. For ordinary live-session forks, `SessionStore` exposes one policy API:
-
-- `fork(source, boundary?, childSessionId?)` accepts a live `Session` object or live `SessionId`, selects source events through the inclusive `SessionSeq` boundary (default: current last event), requires the selected prefix to end outside an open turn, then creates a live child session with deep-cloned seed events, `parentSession`, `isSeeded: true`, the exact `inheritedEventCount`, and inherited `cwd`.
-
-An explicit `boundary` lets callers fork from any stable between-turn position, including a previous `turn/end` or a later standalone log-only event, even if the source has newer events or an open current turn. The API rejects a prefix that ends inside an open turn instead of clipping silently. `dsh-subagent-fork-in-process` keeps its completed-prefix clipping because tool-time delegation usually starts while the parent turn is open; ordinary session branching should make the requested boundary explicit.
-
-## Why a turn ended: `TurnEndReasonMap`
-
-`turn/start` has no trigger field. The entered `user/message` batch records what entered each step, `llm/retry` records request recovery, and idle injection remains pending until a waking delivery reaches a later pre-step. Live turns retain the typed [`AgentCancelCause`](core.md#the-agent-handle) that stopped the driver; persistence uses the additional `{ kind: 'legacy' }` cause only when importing a supported coarse cancellation record that did not store its caller.
-
-```ts type-equiv
-/** Durable cancellation cause, including imports whose original coarse record carried no cause. */
-type TurnEndCancelCause = AgentCancelCause | { readonly kind: 'legacy' }
-```
-
-```ts type-equiv
-/**
- * Why a turn ended. Merge-extensible sum type.
- */
-interface TurnEndReasonMap {
-  completed: { kind: 'completed' }
-  /** A cancellation request interrupted the live turn. */
-  aborted: { kind: 'aborted'; reason: TurnEndCancelCause }
-
-  blocked: { kind: 'blocked' }
-  /**
-   * The turn failed. `error` is always a structured failure: the `LlmError`
-   * facts verbatim, or `{ message: errorChain(error), code: 'UNKNOWN' }`
-   * flattened from any other error.
-   */
-  error: { kind: 'error'; error: LlmFailure }
-  /** At least one step reached its output-token ceiling, even if a plugin continued the turn. */
-  'max-tokens': { kind: 'max-tokens' }
-  /**
-   * A crash-orphaned turn was closed after the fact: agent-loop resume appends
-   * this closer for a stored log whose last turn never ended, and session-query
-   * synthesizes it on cold reads. The loop never emits this marker live, and
-   * the events recorded before the crash remain intact.
-   */
-  interrupted: { kind: 'interrupted' }
-  /**
-   * Fork-seed construction closed a turn that was still open at the fork
-   * boundary in the source session. Only fork seeds carry this marker — the
-   * loop never emits it — and the source events before the boundary remain
-   * intact in the child.
-   */
-  forked: { kind: 'forked' }
-}
-```
-
-`max-tokens` mirrors the model-call `FinishReason` of the same name: any `max-tokens` step in a turn makes the whole turn end `max-tokens` rather than `completed` (the cut-short fact wins over a later continuation), so a consumer can tell a clean stop from a truncated one. Cancellation and errors remain distinct outcomes. The loop emits neither `interrupted` nor `forked` live: crash recovery synthesizes `interrupted` (see [persistence.md](persistence.md)), while fork-seed construction synthesizes `forked`. The map is merge-extensible.
-
-## Execution enclosure and standalone events
-
-A turn encloses one model-loop execution, not the whole session log. AgentLoop records injected `user/message` events only from entering pre-step batches inside a turn; plugin-owned log-only events may still appear between `turn/end` and the next `turn/start`, consuming event seqs without incrementing turn numbers. Persistence admits every contiguous accepted event into a bounded durable batch, while crash repair closes only a genuinely open trailing turn. A producer that needs an immediate durability barrier explicitly awaits `ctx.sessions.flush(session)`.
-
-Merge-extensible event relations belong to the plugin that declares them, so core does not reject an unknown event merely because no turn is open. See [the standalone-event decision](../../.agents/notes/implemented/simplification/2026-07-28-remove-synthetic-log-only-turns.md).
-
-## The end-seed boundary: `session/end-seed`
-
-`buildForkSeed` appends `session/end-seed { inherited: true }` at the exact inherited-prefix cut before adding synthetic fork closers. The `Session` constructor retains that prepared marker or appends one when given only the inherited prefix. A restore retains the tagged marker and appends an ordinary `session/end-seed {}` only when its complete stored seed does not already end in a marker. Both forms are log-only and produce no message; only the constructor and `buildForkSeed` may create them.
-
-For fork lineage, locate the LAST marker whose payload carries `inherited: true`; current-format decoding requires it exactly when `SessionHeader.isSeeded` is true and derives `inheritedEventCount` from its seq. For lifecycle ownership, locate the last `session/end-seed` of either form. Reopening a seed that already ends in any marker does not append another ordinary marker.
-
-It exists because seed history and live work are otherwise byte-identical, which defeats any plugin owning a standalone open/close bracket: an unmatched `compaction/start` reads the same whether the writer crashed mid-compaction or is compacting right now. An opening marker before `session/end-seed` came from the constructor seed and belongs to an ended lifecycle, whatever ended it (a crash, a succeeding process, or a fork out of a still-running parent), so its owner may treat it as dead. That covers only brackets *this* session inherited: a concurrently live session holding an open bracket over the same history has its own boundary elsewhere, so tolerating concurrent writers needs a liveness signal beyond the log. Core writes the boundary and reads nothing from it — a bracket's vocabulary stays with its owning plugin, which is why crash repair closes turn/step/tool boundaries and never `compaction/*`.
-
-Consumers that order Sessions by human activity exclude this boundary: picking a Session up is not work, so ordering by the log tail would float every opened Session to the top.
-
-## Plugin-contributed log-only events
-
-A plugin may declaration-merge extra `SessionEventMap` types. These are **log-only**: NOT `SurfaceEventType`s (they carry no `surfaceOp` and contribute nothing to derived history). Their owner decides whether they belong to an open execution turn or may stand between turns. The generated [persistence log event catalog](../persistence-catalog.md) enumerates every core and plugin-contributed event; the compaction seam's `compaction/*` semantics are discussed on [compaction.md](compaction.md).
-
-When several events in one plugin-owned family assemble into one Web Client Conversation Node, every start, update, result, resource, or interruption event in that family carries or independently derives the same stable business id. This requirement applies to correlated Node families, not to every Session event; it lets the client group each event without guessing from adjacency or scanning history. See the [Conversation subsystem](conversation.md).
-
-The hook bridges' `hook/invoked` / `hook/result` pairs (from `@deepseek-ai/dsh-hook-protocol`) correlate by `handlerId`. `UserPromptSubmit`, `PreToolUse`, `PostToolUse`, and `Stop` fire inside the loop's open turn, so their `hook/*` records are turn-enclosed by construction. `SessionStart` gets no `hook/*` record because it runs before turn 1; its context remains pending in the inbox until a waking delivery opens a turn.
-
-### Plugin records
-
-Experimental packages declare plugin-owned state in `PluginRecordMap`: `appendPluginRecord()` uses each declaration to type its name and payload, and appends an event marked `ignorable: true` in the `plugin:` namespace. `pluginRecordOf()` reads stored records with unknown payloads regardless of current declarations. The [experimental persistence catalog](../experimental-persistence-catalog.md) lists current declarations. The [package README](../../packages/core/session/README.md#write-experimental-plugin-records) owns the caller restriction, retention, and read path.
-
-```ts type-equiv
-/**
- * Event type of an experimental plugin record: `plugin:` followed by
- * slash-separated segments of lowercase letters, digits, `.`, `_`, and `-`,
- * each starting with a letter or digit. A record type is never a
- * {@link SessionEventMap} member.
- */
-type PluginRecordType = `plugin:${string}`
-```
-
-```ts type-equiv
-/**
- * Payloads written by experimental packages, keyed by their `plugin:` record
- * names. Packages augment this map to type writes and enter the current plugin
- * record catalog; these declarations do not enter {@link SessionEventMap} or
- * released persistence schemas. Stored records still require owner validation.
- */
-interface PluginRecordMap {}
-```
-
-```ts type-equiv
-/**
- * One committed experimental plugin record, read from the log by
- * `pluginRecordOf`. The record's owner validates `data` before use, because a
- * restored record carries whatever JSON an earlier build of its owner wrote,
- * or a V3 event that a format migration renamed into the `plugin:` namespace held.
- */
-interface PluginRecord {
-  /** The record type, chosen by the owning plugin. */
-  readonly type: PluginRecordType
-  /** The record's position in the Session log. */
-  readonly seq: SessionSeq
-  /** Unix epoch milliseconds at append. */
-  readonly time: number
-  /** The JSON payload as committed. */
-  readonly data: unknown
-}
-```
-
-## Durability contract
-
-What a persistence backend relies on: the durable log persists every event losslessly, and every Assistant attempt is one `assistant/message` or `assistant/attempt` whose embedded compact stream preserves the original timed chunks. `seq` stays contiguous across these settlements and all interleaved events. A backend may choose its own storage framing for an event batch as long as a handle's `read()` returns the exact appended events; current JSONL writes one row per event (see [persistence.md](persistence.md)). All `event.data` must be JSON-serializable; `Session.append` enforces this at the source (throwing on non-serializable data), so a bad event never enters the log and `session.snapshotEvents()` always equals what a backend can persist. Adding an event type that carries non-serializable data, corrupts core execution nesting, or violates its owner's declared relation is a breaking change to the on-disk format.
-
-The backends that consume this contract are on [persistence.md](persistence.md).
-
-## Remote catalog and workspace opening
-
-`ModelCatalog` is the Host-generation model directory returned by `session/modelCatalog`: it carries the deployment default, routable provider ids, successful provider groups, and isolated provider failures. It is not derived from one Session and remains separate from Session projections.
-
-`SessionOpenWorkspacePathRequest` carries an absolute or workspace-resolved `path`; optional `action: "reveal"` selects file-manager navigation instead of default-application opening. `SessionOpenWorkspacePathValue` confirms that the Host accepted the native handoff. A Session-aware Client resolves relative paths against its current Session cwd when known; the controller hands the path to the opener unchanged and reports invalid requests, cancellation, and opener failures through the Session Remote error vocabulary.
-
-The optional `application` selects a registered file handler without changing the system default; `workspacePathApplications({ path })` returns current handlers, names, icons, and default selection after Host path verification.
-
-<!-- BEGIN GENERATED cordis-surface (gen-cordis-catalog.ts) — do not edit between markers -->
-
-<a id="cordis-surface"></a>
-
-## Cordis API
-
-Generated from source by `scripts/gen-cordis-catalog.ts` (verified fresh by `pnpm run verify-cordis-catalog` in doc-sync; regenerate with `pnpm run gen-cordis-catalog`) — the language sides differ only in locale-specific paired document paths. Signature blocks use a `ts cordis-catalog` fence and keep the original source JSDoc; dispatch modes are defined in the [primer](../cordis-primer.md#dispatch-modes), and the framework-inherited `ctx` API lives in [cordis-api/inherited.md](../cordis-api/inherited.md).
-
-<a id="ctxsessioncontroller--sessioncontroller"></a>
-
-### `ctx.sessionController` — `SessionController`
-
-Host service backing the generated `ctx.remote.session` namespace.
-
-```ts cordis-catalog
-/**
- * Resolve or resume one ordinary Session for another Host API domain.
- * @param sessionId - Session identity whose Agent owns the operation.
- * @returns the live Agent or the stable Session-domain failure.
- */
-resolveAgent(sessionId: SessionId): Promise<ApiSessionAgentResult>
-
-/**
- * Inspect one attached or persisted Session without activating its Agent.
- * @param sessionId - durable Session identity.
- * @param signal - optional caller cancellation for persistence reads.
- * @returns the current attached state or persisted header and event prefix.
- */
-inspect( sessionId: SessionId, signal?: AbortSignal, ): Promise<SessionInspection>
-
-/**
- * Read all visible Session rows without resuming an Agent.
- * @param _request - reserved empty list request.
- * @param signal - cancellation for persistence reads and summary generation.
- * @returns visible Session summaries ordered by activity.
- */
-@Remote('list') async list(_request: SessionListRequest, signal: AbortSignal): Promise<SessionListValue>
-
-/**
- * Search visible Session content without resuming an Agent. A non-owner
- * receives only the hits whose Session `allows()` admits; `hasMore`
- * describes the bounded result before that filtering.
- * @param request - literal message-content query.
- * @param signal - cancellation for list and search reads.
- * @returns authorized bounded Session search results.
- */
-@Remote('search') async search(request: SessionSearchRequest, signal: AbortSignal): Promise<SessionSearchValue>
-
-/**
- * Create one ordinary Session for a new conversation, reusing the named blank Session while it is reusable.
- * @param request - optional blank Session to reuse, location, and Agent preset.
- * @returns the created or reused Session identity and its preset when configured.
- */
-@Remote('create') create(request: SessionCreateRequest): Promise<SessionCreateValue>
-
-/**
- * Select one Session-local model after explicitly resuming the Session; save the default in the background.
- * @param request - Session identity and requested model selection.
- * @returns the normalized selection installed for the Session, without waiting for default persistence.
- */
-@Remote('selectModel') selectModel(request: SessionSelectModelRequest): Promise<SessionSelectModelValue>
-
-/**
- * Select the first available account model after login when no provider API key is configured.
- * @returns after saving the first available model or retaining the existing default.
- */
-@Remote async initializeDefaultModel(): Promise<void>
-
-/**
- * Describe every currently routable model for Host-generation selectors.
- * @returns provider-grouped models, the deployment default, and isolated provider failures.
- */
-@Remote('modelCatalog') modelCatalog(): Promise<ModelCatalog>
-
-/**
- * Report whether this deployment can hand a Session workspace path to a native desktop.
- * @returns true when the matching open operation is available.
- */
-@Remote canOpenWorkspacePath(): boolean
-
-/**
- * Describe the serving desktop for authenticated file-action routes.
- * @returns Host name, configured availability, and platform-specific file-manager behavior.
- */
-workspaceDesktop(): { name: string; available: boolean; fileManager: 'finder' | 'explorer' | 'directory' | null }
-
-/**
- * Verify one path through the composed filesystem and open it on the Host desktop.
- * @param request - path after best-effort Session workspace resolution.
- * @param signal - caller lifetime; abort terminates the native command.
- * @returns confirmation after the native opener accepts the path.
- * @throws RemoteError when the request is invalid, has no verified Host mapping, is cancelled, or the opener fails.
- */
-@Remote('openWorkspacePath') async openWorkspacePath( request: SessionOpenWorkspacePathRequest, signal: AbortSignal, ): Promise<SessionOpenWorkspacePathValue>
-
-/**
- * Query current file handlers on the serving desktop without activating an Agent.
- * @param request - file path in Host filesystem syntax.
- * @param signal - caller lifetime, propagated to filesystem and desktop queries.
- * @returns OS application names, icons, and default selection; empty when desktop opening is unavailable.
- * @throws RemoteError when the path is invalid, the query is cancelled, or native discovery fails.
- */
-@Remote('workspacePathApplications') async workspacePathApplications( request: { readonly path: string }, signal: AbortSignal, ): Promise<readonly SessionWorkspacePathApplication[]>
-
-/**
- * Rename one Session after explicitly resuming it.
- * @param request - Session identity and proposed title.
- * @returns the accepted title and durable event sequence.
- */
-@Remote('rename') rename(request: SessionRenameRequest): Promise<SessionRenameValue>
-
-/**
- * Fork one cold-readable exact event prefix into a new Session. An omitted
- * boundary selects the latest completed-turn prefix; an open cut receives
- * synthetic fork closers.
- * @param request - source Session, optional exact inclusive event boundary, and migration preflight choice.
- * @returns the new Session identity.
- */
-@Remote('fork') async fork(request: SessionForkRequest): Promise<SessionForkValue>
-
-/**
- * Admit one prompt after explicitly resuming its Session.
- * @param request - Session identity, prompt content, source metadata, and delivery mode.
- * @param signal - caller cancellation before prompt admission begins.
- * @returns acknowledgement that the Agent accepted the prompt.
- */
-@Remote('prompt') async prompt(request: SessionPromptRequest, signal: AbortSignal): Promise<SessionPromptValue>
-
-/**
- * Read one image proven reachable from the addressed Session log.
- * @param request - Session and attachment identities used for authorization.
- * @returns the durable attachment reference and base64-encoded bytes.
- */
-@Remote('attachment') attachment(request: SessionAttachmentRequest): Promise<SessionAttachmentValue>
-
-/**
- * Mutate one still-pending queue occurrence, resuming a cold Agent first.
- * @param request - Session, queue item, and requested mutation.
- * @returns acknowledgement that the queue mutation was applied.
- */
-@Remote('updateQueue') updateQueue(request: SessionUpdateQueueRequest): Promise<SessionUpdateQueueValue>
-
-/**
- * Cancel one active Agent turn without dropping its pending inbox.
- * @param request - Session whose active Agent turn is cancelled.
- * @returns acknowledgement that cancellation was requested.
- */
-@Remote('cancel') cancel(request: SessionCancelRequest): SessionCancelValue
-
-/**
- * Read one cold-safe, message-aligned Session history page.
- * @param request - durable address, backward cursor, and page budget.
- * @param signal - cancellation for persistence reads.
- * @returns one chronological page.
- */
-@Remote({ name: 'page', resources: { session: addressedSession } }) page(request: SessionPageRequest, signal: AbortSignal): Promise<SessionPage>
-
-/**
- * Follow one Session log from its opening or resume cursor.
- * @param request - durable address and last committed sequence already held by the caller.
- * @param signal - cancellation owned by the Remote stream carrier.
- * @returns a complete opening snapshot followed by gap-free durable event
- *   frames and optional cursorless assistant-stream frames.
- */
-@Remote({ mode: 'stream', resources: { session: addressedSession } }) follow(request: SessionFollowRequest, signal: AbortSignal): AsyncIterable<SessionFollowFrame>
-
-/**
- * Read exact projections, returning cached hints only when migration is required.
- * @param request - Session whose current values are required.
- * @param signal - cancellation for the Session read.
- * @returns a sequenced baseline, cached hints when migration is deferred, or null when absent.
- */
-@Remote('projections') async projections(request: SessionProjectionsRequest, signal: AbortSignal): Promise<SessionProjectionsValue>
-
-/**
- * Stream a complete live-control baseline followed by replacement frames.
- * @param signal - cancellation owned by the Remote stream carrier.
- * @returns one complete baseline followed by live replacement frames.
- */
-@Remote({ mode: 'stream' }) async *control(signal: AbortSignal): AsyncIterable<SessionControlFrame>
-```
-
-Types: [SessionId](core.md) · [SessionInspection](persistence.md) · [SessionSearchRequest](session-query.md)
-
-Source: [`packages/api/session-controller/src/index.ts`](../../packages/api/session-controller/src/index.ts)
-
-<a id="ctxsessions--sessionstore"></a>
-
-### `ctx.sessions` — `SessionStore`
-
-In-memory session store (`ctx.sessions`).
-
-Persistence is intentionally not implemented here — the agent lifecycle attaches a session-log writer to each published session's write handle; a session published outside that lifecycle persists nothing.
-
-```ts cordis-catalog
-/**
- * Register one event interpreter for live creation, restore, and fork.
- * Disposing the contribution makes sessions that used it refuse further derivation.
- * @param projection - pure definition owned by the event's plugin.
- * @returns the fiber-owned disposer.
- * @throws when another definition already owns this event type.
- */
-registerMessageProjection(projection: SessionMessageProjection): () => Promise<void>
-
-/**
- * Create a session owned by the calling fiber: disposing that fiber stops
- * event notification and removes the session from the store. `options.seed`
- * populates the session with a copy of those events (replay/fork);
- * `options.meta` attaches creation metadata (validated absolute `cwd`, seed
- * and parent lineage, and delegation depth) as the immutable
- * {@link SessionHeader} (the store fills `version`/`id`/`createdAt`).
- *
- * For an agent whose session must be torn down IN ORDER with its loop (so the
- * loop's final events are published before the store attachment ends), do NOT use this
- * — fold the session lifecycle into the agent's own effect via
- * {@link prepare} + {@link enter} + {@link announce} (see
- * `dsh-agent-loop`'s creation transaction).
- *
- * @param id - the session id; omitted, the store mints `session-<n>`.
- * @param options - seed events and/or creation metadata for the header.
- * @returns the live session, already entered and announced.
- * @throws if a session with `id` already exists, metadata is not a plain
- *   lossless-JSON record with valid scalar fields, or `meta.cwd` is a
- *   non-absolute path (storage backends key directories off it).
- */
-create(id?: SessionId, options?: CreateSessionOptions): Session
-
-/**
- * Build a session WITHOUT entering it into the store — validate the id/cwd and
- * construct the {@link Session} (with its immutable {@link SessionHeader}).
- * Pairs with {@link enter} + {@link announce}: a caller that owns a composite
- * `ctx.effect` (the agent factory) folds the session lifecycle into that ONE
- * effect so a fiber unload tears the session + agent down as a single ORDERED
- * chain rather than as racing sibling effects — which would remove the publication hooks
- * before the driver's closing events commit, dropping them.
- *
- * @param id - the session id; omitted, the store mints `session-<n>`.
- * @param options - seed events and/or creation metadata for the header. With
- *   `eventState`, every seed event is either independently owned or any
- *   shared value is deeply frozen; {@link Session.fromRestore} validates and
- *   adopts those values without copying or freezing them.
- * @returns the constructed session, NOT yet in the store.
- * @throws if a session with `id` already exists, metadata is not a plain
- *   lossless-JSON record with valid scalar fields, or `meta.cwd` is a
- *   non-absolute path.
- */
-prepare(id?: SessionId, options?: PrepareSessionOptions): Session
-
-/**
- * Enter a {@link prepare}d session into the store: install the module-private
- * append publication hooks and add it to the store. Returns the DETACH
- * disposer (hooks + store removal). Does NOT emit `session/created` —
- * the caller yields this disposer inside its effect and THEN calls
- * {@link announce}, so a throwing `session/created` listener rolls the attach
- * back instead of leaking it.
- *
- * Re-checks the id for a duplicate: `prepare` and `enter` are public
- * cross-package primitives and a caller may interleave arbitrary work (or
- * another create) between them, so a stale prepared session must NOT overwrite
- * a live store entry of the same id — its detach disposer would later delete
- * the REAL session. The {@link create} convenience and the agent factory call
- * the two back-to-back so they never trip this, but the public API cannot
- * assume that.
- *
- * @param session - a {@link prepare}d session not yet in the store.
- * @returns the detach disposer (publication hooks + store removal). When called from
- *   a synchronous `session/created` listener, removal and disposal wait until
- *   that creation dispatch unwinds.
- * @throws if a session with this id is already in the store.
- */
-enter(session: Session): () => void
-
-/** Emit `session/created` exactly once for an {@link enter}ed session (with
- * the carrier {@link enter} captured). Separate from {@link enter} so the
- * caller can yield the detach disposer first (rollback safety — see
- * {@link enter}).
- * @param session - the entered session to announce to listeners.
- * @throws if the session is not live or its announcement already began,
- *   including a reentrant call from a creation listener. */
-announce(session: Session): void
-
-/**
- * Dispatch the awaited `session/flush` durability checkpoint for `session`,
- * with the carrier captured at {@link enter}. THE flush entry point: the
- * store owns the carrier, so callers (the checkpoint policy's per-request
- * barrier, goal-round-driver's idle checkpoint, teardown drains, and consumers
- * that flush themselves before reading storage) must come through here
- * rather than dispatch a raw `ctx.parallel('session/flush', …)` — one owner
- * and one spelling.
- * @param session - the session whose buffered events must reach durable storage.
- * @returns whether at least one durability listener participated, after every
- *   listener has settled successfully.
- * @throws the first registered listener failure after every listener settles.
- */
-async flush(session: Session): Promise<boolean>
-
-/**
- * Look up a live session.
- * @param id - the session id to look up.
- * @returns the session, or undefined when no live session has that id.
- */
-get(id: SessionId): Session | undefined
-
-/**
- * All live sessions, in creation order.
- * @returns a fresh array; mutating it does not affect the store.
- */
-list(): Session[]
-
-/**
- * Create a live child session from an exact prefix of a live source.
- * `boundary` is an inclusive source event seq; omitted means the source's
- * current last event. An open tail receives synthetic tool results and
- * step/turn closers with the forked cause. Closed steps and turns remain
- * unchanged, including any failed tool calls already missing results.
- * `inheritedEventCount` counts only copied source events, excluding these closers.
- *
- * @param source - Live source session object or id.
- * @param boundary - Inclusive source event seq to fork through; omitted means
- *   the source's current last event, and omitted on an empty source forks an
- *   empty child.
- * @param childSessionId - Optional child session id; omitted delegates to
- *   `SessionStore`'s id policy.
- * @returns The created live child session.
- */
-fork(source: SessionForkSource, boundary?: SessionSeq, childSessionId?: SessionId): Session
-```
-
-Types: [CreateSessionOptions](persistence.md) · [PrepareSessionOptions](persistence.md) · [SessionId](core.md)
-
-Source: [`packages/core/session/src/index.ts`](../../packages/core/session/src/index.ts)
-
-<a id="api-session-events"></a>
-
-### `api-session/*` events
-
-<a id="api-sessionactivity--emit"></a>
-
-#### `api-session/activity` — emit
-
-One user-authored durable message advanced Session list activity.
-
-```ts cordis-catalog
-/**
- * One user-authored durable message advanced Session list activity.
- * @mode emit
- * @param sessionId - addressed Session identity.
- * @param updatedAt - durable message time used for list ordering.
- */
-'api-session/activity'(sessionId: SessionId, updatedAt: number): void
-```
-
-Types: [SessionId](core.md)
-
-Source: [`packages/api/session-controller/src/types.ts`](../../packages/api/session-controller/src/types.ts)
-
-<a id="api-sessionadded--emit"></a>
-
-#### `api-session/added` — emit
-
-A Session became visible or its Agent was created or disposed. Consumers upsert the summary and replace its current running and availability state.
-
-```ts cordis-catalog
-/**
- * A Session became visible or its Agent was created or disposed.
- * Consumers upsert the summary and replace its current running and availability state.
- * @mode emit
- * @param summary - current list row for the Session.
- */
-'api-session/added'(summary: SessionSummary): void
-```
-
-Source: [`packages/api/session-controller/src/types.ts`](../../packages/api/session-controller/src/types.ts)
-
-<a id="api-sessionerror--emit"></a>
-
-#### `api-session/error` — emit
-
-One Agent failed outside a durable turn position.
-
-```ts cordis-catalog
-/**
- * One Agent failed outside a durable turn position.
- * @mode emit
- * @param sessionId - Agent and Session identity.
- * @param message - user-safe failure chain.
- */
-'api-session/error'(sessionId: SessionId, message: string): void
-```
-
-Types: [SessionId](core.md)
-
-Source: [`packages/api/session-controller/src/types.ts`](../../packages/api/session-controller/src/types.ts)
-
-<a id="api-sessionremoved--emit"></a>
-
-#### `api-session/removed` — emit
-
-A Session left the live Host registry.
-
-```ts cordis-catalog
-/**
- * A Session left the live Host registry.
- * @mode emit
- * @param sessionId - removed Session identity.
- */
-'api-session/removed'(sessionId: SessionId): void
-```
-
-Types: [SessionId](core.md)
-
-Source: [`packages/api/session-controller/src/types.ts`](../../packages/api/session-controller/src/types.ts)
-
-<a id="api-sessionstatus--emit"></a>
-
-#### `api-session/status` — emit
-
-One Agent changed running state.
-
-```ts cordis-catalog
-/**
- * One Agent changed running state.
- * @mode emit
- * @param sessionId - Agent and Session identity.
- * @param running - whether the Agent is running.
- */
-'api-session/status'(sessionId: SessionId, running: boolean): void
-```
-
-Types: [SessionId](core.md)
-
-Source: [`packages/api/session-controller/src/types.ts`](../../packages/api/session-controller/src/types.ts)
-
-<a id="session-events"></a>
-
-### `session/*` events
-
-<a id="sessioncreated--emit"></a>
-
-#### `session/created` — emit
-
-Creation announcement during session publication. A synchronous throw vetoes and rolls back with a paired disposal; detach requested during dispatch is deferred. A returned-promise rejection is logged but cannot retroactively veto this synchronous boundary. Scope-filtered dispatch (`@deepseek-ai/dsh-scope`): agent-scoped listeners receive only sessions entered through that agent's context.
-
-```ts cordis-catalog
-/**
- * Creation announcement during session publication. A synchronous throw vetoes and rolls
- * back with a paired disposal; detach requested during dispatch is deferred.
- * A returned-promise rejection is logged but cannot retroactively veto this
- * synchronous boundary.
- * Scope-filtered dispatch (`@deepseek-ai/dsh-scope`): agent-scoped listeners
- * receive only sessions entered through that agent's context.
- * @param session - the session just entered and announced.
- * @mode emit
- */
-'session/created'(this: Scoped<Session>, session: Session): void
-```
-
-Types: [Scoped](scope.md)
-
-Source: [`packages/core/session/src/index.ts`](../../packages/core/session/src/index.ts)
-
-<a id="sessiondisposed--emit"></a>
-
-#### `session/disposed` — emit
-
-Emitted once when an announced session leaves the store, including publication rollback, but never for an entry whose creation announcement did not begin. Listener failures are logged and contained. Scope-filtered dispatch (`@deepseek-ai/dsh-scope`) reuses the owner scope.
-
-```ts cordis-catalog
-/**
- * Emitted once when an announced session leaves the store, including
- * publication rollback, but never for an entry whose creation announcement
- * did not begin. Listener failures are logged and contained.
- * Scope-filtered dispatch (`@deepseek-ai/dsh-scope`) reuses the owner scope.
- * @param session - the session that is no longer live in the store.
- * @mode emit
- */
-'session/disposed'(this: Scoped<Session>, session: Session): void
-```
-
-Types: [Scoped](scope.md)
-
-Source: [`packages/core/session/src/index.ts`](../../packages/core/session/src/index.ts)
-
-<a id="sessionevent--emit"></a>
-
-#### `session/event` — emit
-
-Post-commit, fire-and-forget append feed. The listener snapshot resolves before the log push, but callbacks run after it; observer failures are logged and contained without making the committed append fail. Scope-filtered dispatch (`@deepseek-ai/dsh-scope`): agent-scoped listeners receive only events from sessions entered through that agent's context.
-
-```ts cordis-catalog
-/**
- * Post-commit, fire-and-forget append feed. The listener snapshot resolves
- * before the log push, but callbacks run after it; observer failures are
- * logged and contained without making the committed append fail.
- * Scope-filtered dispatch (`@deepseek-ai/dsh-scope`): agent-scoped listeners
- * receive only events from sessions entered through that agent's context.
- * @param session - the session whose log grew.
- * @param event - the appended event, exactly as recorded.
- * @mode emit
- */
-'session/event'(this: Scoped<Session>, session: Session, event: SessionEvent): void
-```
-
-Types: [Scoped](scope.md)
-
-Source: [`packages/core/session/src/index.ts`](../../packages/core/session/src/index.ts)
-
-<a id="sessionflush--parallel"></a>
-
-#### `session/flush` — parallel
-
-Awaited parallel durability checkpoint: every listener runs and the caller awaits all of them, with no waterfall veto. Scope-filtered dispatch (`@deepseek-ai/dsh-scope`) reuses the session's owner scope.
-
-```ts cordis-catalog
-/**
- * Awaited parallel durability checkpoint: every listener runs and the
- * caller awaits all of them, with no waterfall veto. Scope-filtered dispatch
- * (`@deepseek-ai/dsh-scope`) reuses the session's owner scope.
- * @param session - the session whose buffered events must reach durable storage.
- * @mode parallel
- */
-'session/flush'(this: Scoped<Session>, session: Session): Promise<void> | void
-```
-
-Types: [Scoped](scope.md)
-
-Source: [`packages/core/session/src/index.ts`](../../packages/core/session/src/index.ts)
-<!-- END GENERATED cordis-surface -->