docs: reserve seam for complete capabilities

This commit is contained in:
Turtle
2026-08-09 15:34:32 +08:00
parent 27ac49e687
commit dda02250f5
966 changed files with 2166 additions and 2159 deletions
@@ -1,5 +1,5 @@
/**
* Capture coordinator: the seam's upstream half. Live capture subscribes to
* Capture coordinator for the telemetry capability. Live capture subscribes to
* the session firehose plus the one live-bus relay (`agent/error`). Both
* capture paths apply the fixed chunk projection, build logical records, and
* run each through the
@@ -159,7 +159,7 @@ export class TelemetryCoordinator {
* at or below the start still feed the projection state (first-chunk
* tracking) without being re-handed, so a resumed fiber drops mid-step
* chunk continuations exactly like the fiber that saw the step begin. The
* cost, accepted with the seam's at-most-once stance: a resume no longer
* cost, accepted with the capture contract's at-most-once stance: a resume no longer
* backfills records a previous process failed to deliver.
* @param session - the live session to adopt; a second adoption is a no-op.
*/
@@ -204,7 +204,7 @@ export class TelemetryCoordinator {
/**
* Run the `telemetry/record` waterfall at capture time. The innermost `next`
* passes the record through unchanged — the seam ships no rules; exported
* passes the record through unchanged — this package ships no rules; exported
* data is as clean as the listeners a deployment mounts. Callers run inside
* {@link contain}, so a throwing rule withholds the record instead of
* reaching the loop (fail-closed). On-demand capture invokes this waterfall
@@ -289,7 +289,7 @@ function severityOf(event: SessionEvent): TelemetrySeverity {
case 'turn/end':
return event.data.reason.kind === 'error' ? 'error' : 'info'
default:
// Merge-extensible fall-through (no assertNever): event types this seam
// Merge-extensible fall-through (no assertNever): event types this coordinator
// does not depend on — including plugin-merged ones it never heard of —
// pass through as info; their owners' outcome semantics stay theirs.
return 'info'
@@ -1,7 +1,7 @@
/**
* Telemetry seam for the DeepSeek Harness.
* Telemetry Service Definition for the DeepSeek Harness.
*
* The seam owns the CAPTURE side of session-event reporting — which records
* This package owns the CAPTURE side of session-event reporting — which records
* exist (the chunk projection), what they carry (the logical record), when
* they are captured (adoption, the per-append firehose, lifecycle
* forwarding), live versus on-demand canonical-log capture, and the HMR
@@ -24,7 +24,7 @@ declare module 'cordis' {
interface Events {
/**
* Transform one outbound record before it reaches the backend. This
* waterfall is the seam's redaction extension point. It ships NO rules
* waterfall is the Service Definition's redaction extension point. It ships NO rules
* of its own: the
* innermost `next()` passes the record through unchanged, and with no
* listener mounted records reach the backend as captured, so exported
@@ -55,7 +55,7 @@ declare module 'cordis' {
export type TelemetrySeverity = 'info' | 'warn' | 'error'
/**
* One logical record handed to a backend — the seam's whole outbound
* One logical record handed to a backend — the capture contract's whole outbound
* vocabulary. Ledger records mirror session-log events one-to-one;
* operational records (`channel: 'ops'`) carry the two signals with no log
* home (`agent-error`, `shutdown`) and deliberately omit `event.seq`-style
@@ -143,7 +143,7 @@ export abstract class Telemetry extends Service implements TelemetryBackend {
}
/**
* See {@link TelemetryBackend.emit} — the seam declaration is the contract's one home.
* See {@link TelemetryBackend.emit} — that declaration is the contract's one home.
* @param record - the logical record to report; owned by the backend after the call.
*/
abstract emit(record: TelemetryRecord): void
@@ -15,7 +15,7 @@ export const name = 'session-telemetry-invariant'
export const inject = ['invariants']
/**
* No runtime invariant: the seam's whole output is the backend handoff — a
* No runtime invariant: the package's whole output is the backend handoff — a
* synchronous `emit()` call outside every authoritative event stream — and its
* capture side never appends session events, so no event/data relation exists
* for an independent companion to observe.