@qodo/sdk 0.13.4 → 2.0.0-next.0

package/dist/client/connection.d.ts

@@ -0,0 +1,800 @@
+/**
+ * `Connection` — owns the WebSocket, multiplexes inbound envelopes onto
+ * subscriptions, encodes outbound envelopes.
+ *
+ * One `Connection` per `QodoClient.connect()` call. `tasks.start` /
+ * `tasks.continue` register a `TaskSubscription`; `client.receive()` registers
+ * a raw subscription that taps every inbound envelope. The connection routes
+ * inbound envelopes to subscriptions whose `parent_message_id` chain matches.
+ *
+ * **Reconnect + replay.** The Connection survives transport drops:
+ * subscriptions stay alive while the underlying `WSTransport` is replaced via
+ * the same factory. On a fresh transport, every active task subscription's
+ * `task_id` + `lastSeenMessageId` is sent back to the server as a
+ * `task.resubscribe` envelope; the server replays anything after that anchor
+ * from its per-session ring buffer (cap 1000 envelopes per session). No
+ * client-side outbox — durability is server-side. The 1.x `OutboxTurn` /
+ * `Resume` / `ResumeAck` machinery does not exist here.
+ */
+import type { Envelope } from '../qar/envelopes.js';
+import type { MessageId, SessionId, TaskId, ToolCallId } from '../qar/ids.js';
+import type { TaskEvent } from '../qar/taskEvents.js';
+import type { ClientEvent } from '../qar/clientEvents.js';
+import type { SessionState, TaskCancelPayload, TaskContinuePayload, TaskForceResumePayload, TaskResubscribePayload, TaskStartPayload, ToolResponsePayload } from '../qar/payloads.js';
+import type { ClientReconnectOptions } from './options.js';
+import { TraceContextProvider } from '../observability/traceContext.js';
+import type { SpanLifecycle } from '../observability/spans.js';
+import { TransportMetrics } from '../observability/transportMetrics.js';
+import type { WSTransportFactory, WSTransportFactoryArgs } from './transport.js';
+/**
+ * Outbound envelopes the SDK constructs.
+ */
+type OutboundPayload = {
+    readonly kind: 'task.start';
+    readonly payload: TaskStartPayload;
+} | {
+    readonly kind: 'task.continue';
+    readonly payload: TaskContinuePayload;
+} | {
+    readonly kind: 'task.cancel';
+    readonly payload: TaskCancelPayload;
+} | {
+    readonly kind: 'task.resubscribe';
+    readonly payload: TaskResubscribePayload;
+} | {
+    readonly kind: 'task.forceResume';
+    readonly payload: TaskForceResumePayload;
+} | {
+    readonly kind: 'tool.response';
+    readonly payload: ToolResponsePayload;
+};
+/**
+ * A subscription on the inbound stream. The connection calls `consider` for
+ * every inbound envelope; the subscription returns `true` if it absorbed the
+ * envelope (so terminal envelopes don't double-fire elsewhere) and pushes the
+ * envelope to its consumer.
+ *
+ * `task.resubscribe` and tool tunneling plug in via this shape too, so
+ * the routing fabric is shared.
+ */
+export interface InboundSubscription {
+    /**
+     * Called for every inbound envelope. Returns `true` if this subscription
+     * consumed the envelope (used so the connection knows it was routed to at
+     * least one task subscriber). Subscriptions are independent — a `tool.request`
+     * may belong to a task subscription AND surface on the raw `receive()` tap.
+     */
+    consider(env: Envelope): boolean;
+    /**
+     * Push a synthetic SDK-internal `qar.client.*` event onto the consumer's
+     * iterator. Distinct from `consider` because client events are not
+     * envelopes — they have no `message_id` / `session_id` / `payload`.
+     */
+    considerClient(ev: ClientEvent): void;
+    /** Called when the underlying transport fails. Subscription should fail its consumer. */
+    fail(err: Error): void;
+    /** Called when the connection closes cleanly. Subscription should close its consumer. */
+    close(): void;
+}
+/**
+ * Argument shape for the `task.started` resolver. Includes the
+ * idempotent-admission fields when the ack reports an existing session
+ * (`isNew === false`) or a terminal re-dispatch (`previousTaskId` +
+ * `previousState` populated). Old SDK call sites that ignore the new
+ * fields keep working — only callers exposing the full
+ * `TaskAdmissionResult` Promise on `TaskStartIterable` need them.
+ */
+export interface TaskStartedResolverArgs {
+    readonly sessionId: SessionId;
+    readonly taskId: TaskId;
+    /** `true` for fresh admission; `false` for idempotent existing-session return. */
+    readonly isNew: boolean;
+    /** Session state at ack time (present when `isNew === false`). */
+    readonly state?: SessionState;
+    /** Prior task id on terminal re-dispatch (the current `taskId` is the NEW task). */
+    readonly previousTaskId?: TaskId;
+    /** Prior task's terminal state on terminal re-dispatch. */
+    readonly previousState?: SessionState;
+}
+/**
+ * Argument shape for the `task.force_resumed` resolver — the ack envelope
+ * returned by QAR in response to an outbound `task.forceResume`. Carries
+ * the recovered task's id, the post-recovery state (typically
+ * `'auto-paused'` after in-flight tool/HITL cancellation; reports the
+ * actual state on passthrough), and the inherited derived `session_id`.
+ */
+export interface TaskForceResumedResolverArgs {
+    readonly sessionId: SessionId;
+    readonly taskId: TaskId;
+    readonly state: SessionState;
+}
+/**
+ * A single task's inbound stream. Routes by parent-message chain: every
+ * envelope whose `parent_message_id` is in the chain becomes part of the chain
+ * (its `message_id` joins). Terminal envelopes (`task.done`, `error`) close the
+ * iterator.
+ *
+ * On `Connection`-level reconnect, the matching subscription stays alive and
+ * the `Connection` stitches the resubscribe envelope's id into `chain` so the
+ * server's replayed envelopes route back here transparently.
+ */
+export declare class TaskSubscription implements InboundSubscription, AsyncIterable<TaskEvent>, AsyncIterator<TaskEvent> {
+    private readonly rootMessageId;
+    private readonly onEarlyReturn;
+    private readonly onClose;
+    /**
+     * Optional transport-counter store. When provided, `consider` increments
+     * `replay_envelopes_received_total` for every absorbed envelope that
+     * descends from a replay anchor, and `replay_anchor_missing_total` for
+     * every `error { code: 'replay_anchor_missing' }` envelope that routes
+     * here.
+     */
+    private readonly metrics?;
+    private readonly queue;
+    private readonly chain;
+    private taskId;
+    /**
+     * `message_id` of the most recent inbound envelope that matched this
+     * subscription's chain or `task_id`. Anchor for `task.resubscribe` on
+     * reconnect — the server replays everything after this point. Stays
+     * `undefined` until the first inbound envelope arrives. Connection-scoped
+     * envelopes (`flow.pause` / `flow.resume`) don't update it: they're
+     * session-scoped, not task-scoped, so they can't anchor a per-task replay
+     * window.
+     */
+    private lastSeen;
+    /**
+     * Outbound `task.resubscribe` message ids whose direct descendant marks
+     * the start of replay accounting for this subscription. Seeded by
+     * {@link attachOutboundMessageId} (auto-reconnect) and the constructor's
+     * `rootIsReplayAnchor` flag (manual `tasks.resubscribe`). Stays small —
+     * one entry per resubscribe envelope this subscription owns, not one
+     * entry per replay envelope received.
+     */
+    private readonly replayAnchors;
+    /**
+     * Once an envelope absorbed by this subscription has been identified as
+     * a replay descendant (its `parent_message_id` was in `replayAnchors`),
+     * every subsequently-absorbed envelope is also counted as a replay
+     * envelope: QAR's per-session ring buffer replays a contiguous chain
+     * after the anchor, so the post-anchor continuation is logically the
+     * same wire window as the replay itself.
+     *
+     * Sticky boolean rather than a growing chain Set — cheaper memory
+     * profile for long-running subscriptions that survive many reconnects.
+     */
+    private replayCountingActive;
+    /**
+     * @param rootMessageId  message_id of the outbound envelope that started the
+     *                       task (the `task.start` or `task.continue`).
+     * @param knownTaskId    task_id known up front (only for `tasks.continue` /
+     *                       `tasks.cancel` / `tasks.resubscribe` — `tasks.start`
+     *                       doesn't know the id until the first inbound envelope
+     *                       reveals it). Pre-seeding the matcher closes a
+     *                       routing gap where envelopes that carry
+     *                       `payload.task_id` but no chain link to our outbound
+     *                       message would otherwise be missed.
+     * @param onEarlyReturn  called once if the consumer breaks the iterator
+     *                       before terminal — best-effort `task.cancel`. Pass a
+     *                       no-op for resubscribe-style subscriptions where
+     *                       breaking the loop must NOT cancel the underlying
+     *                       task (the consumer is observing, not driving).
+     * @param onClose        called once when the subscription is no longer
+     *                       routable (terminal received OR consumer broke).
+     */
+    /** Span lifecycle for the task this subscription represents. Closed on terminal/fail/early-return. */
+    private readonly span;
+    /**
+     * Resolver for the `task.started` admission ack. Receives both the
+     * inherited `session_id` (server-derived UUID) AND the canonical
+     * `task_id` from the envelope's payload — the two ids are distinct on
+     * the admission-retry path, where a retried `task.start` carries a
+     * fresh `message_id` while the server's canonical task_id stays bound
+     * to the FIRST winning attempt.
+     *
+     * Provided by `TaskClient.subscribeAndSend` for `task.start`
+     * subscriptions only — `task.continue` / `task.cancel` /
+     * `task.resubscribe` already know the session_id + task_id from a
+     * prior admission and don't wire a resolver. `null` once the resolver
+     * has fired (resolved OR rejected) — prevents a second resolution
+     * from a spec-violating duplicate ack.
+     */
+    private taskStartedResolver;
+    /**
+     * Resolver for the `task.force_resumed` ack — fires when the SDK's
+     * outbound `task.forceResume` envelope's response arrives. Wired by
+     * `TaskClient.forceResume`. Mirrors {@link taskStartedResolver} in
+     * shape and lifecycle (null after fire; rejected if the subscription
+     * closes before the ack lands).
+     */
+    private taskForceResumedResolver;
+    constructor(rootMessageId: MessageId, knownTaskId: TaskId | undefined, onEarlyReturn: (taskId: TaskId | undefined) => void, onClose: (sub: TaskSubscription) => void, span?: SpanLifecycle, 
+    /**
+     * Optional transport-counter store. When provided, `consider` increments
+     * `replay_envelopes_received_total` for every absorbed envelope that
+     * descends from a replay anchor, and `replay_anchor_missing_total` for
+     * every `error { code: 'replay_anchor_missing' }` envelope that routes
+     * here.
+     */
+    metrics?: TransportMetrics | undefined, 
+    /**
+     * `true` when `rootMessageId` is itself a `task.resubscribe` envelope —
+     * its descendants count as replay envelopes for
+     * `replay_envelopes_received_total`. Set by the manual
+     * `client.tasks.resubscribe(...)` seam; the `tasks.start` /
+     * `tasks.continue` paths leave it `false` so live envelopes don't
+     * masquerade as replay until an auto-replay anchor is stitched in via
+     * {@link attachOutboundMessageId}.
+     */
+    rootIsReplayAnchor?: boolean, 
+    /**
+     * Optional resolver fired with the server-derived `session_id` when
+     * the `task.started` admission ack arrives on this subscription's
+     * chain. Wired by `task.start` paths so the caller's `TaskStartIterable`
+     * can expose the derived id via its `sessionId` Promise.
+     *
+     * Resolver lifecycle:
+     *   - Resolved on inbound `task.started` whose `parent_message_id`
+     *     matches the outbound `task.start.message_id`.
+     *   - Rejected if the subscription terminates (clean close, transport
+     *     fail, terminal `task.done` / `error`) before any `task.started`
+     *     arrives — keeps the consumer's `await stream.sessionId` from
+     *     hanging forever.
+     */
+    taskStartedResolver?: {
+        readonly resolve: (args: TaskStartedResolverArgs) => void;
+        readonly reject: (err: Error) => void;
+    }, 
+    /**
+     * Optional resolver fired with the recovered task's id +
+     * post-recovery state when an inbound `task.force_resumed` ack
+     * arrives on this subscription's chain. Wired by
+     * `TaskClient.forceResume`. Same lifecycle as
+     * {@link taskStartedResolver}: rejected on close/error before
+     * the ack lands.
+     */
+    taskForceResumedResolver?: {
+        readonly resolve: (args: TaskForceResumedResolverArgs) => void;
+        readonly reject: (err: Error) => void;
+    });
+    /** The `task_id` once we've seen the first envelope that carries it. */
+    get currentTaskId(): TaskId | undefined;
+    /**
+     * Most-recent inbound envelope's `message_id`, or `undefined` if no inbound
+     * matched yet. Public so `Connection.replayActiveTasks` can read it without
+     * pinning to a specific subscription class.
+     */
+    get lastSeenMessageId(): MessageId | undefined;
+    /** Whether this subscription has terminated and stopped accepting envelopes. */
+    get isTerminated(): boolean;
+    /**
+     * Stitch a new outbound `message_id` (typically a `task.resubscribe`) into
+     * this subscription's chain so the server's replies routed via
+     * `parent_message_id` link back here. Idempotent — Set.add no-ops on dups.
+     *
+     * Called by `Connection` after sending a resubscribe on behalf of an
+     * already-live subscription (the auto-replay path on reconnect).
+     */
+    attachOutboundMessageId(messageId: MessageId): void;
+    consider(env: Envelope): boolean;
+    /**
+     * Reject the pending `task.started` resolver, if any. No-op when the
+     * resolver has already fired (resolved earlier on the ack, or rejected
+     * by a prior terminal). Idempotent — every terminal path can call
+     * this without guarding.
+     */
+    private rejectTaskStartedIfPending;
+    /**
+     * Reject the pending `task.force_resumed` resolver, if any. Mirrors
+     * {@link rejectTaskStartedIfPending}: idempotent; called from every
+     * terminal path so `tasks.forceResume()` Promises don't hang on
+     * close / transport failure.
+     */
+    private rejectTaskForceResumedIfPending;
+    /**
+     * End the task span for a `task.done` envelope. `completed` and `canceled`
+     * are both clean terminal states (the consumer asked for the cancel, or the
+     * task ran to completion); `failed` records an error.
+     */
+    private endSpanForDone;
+    considerClient(ev: ClientEvent): void;
+    fail(err: Error): void;
+    close(): void;
+    next(): Promise<IteratorResult<TaskEvent>>;
+    return(): Promise<IteratorResult<TaskEvent>>;
+    throw(err: unknown): Promise<IteratorResult<TaskEvent>>;
+    [Symbol.asyncIterator](): AsyncIterator<TaskEvent>;
+    private matches;
+    /**
+     * Public alias for `matches` — exposed so `Connection.dispatchCancelAcked`
+     * can route a `task.canceling` envelope to the correct subscription
+     * before broadcasting the synthetic `qar.client.cancel_acked` client
+     * event. Same chain + `task_id` matcher used for normal envelope
+     * routing.
+     */
+    matchesEnvelope(env: Envelope): boolean;
+}
+/**
+ * Raw subscription from `client.receive()` — taps every inbound envelope plus
+ * the synthetic `qar.client.*` lifecycle events. The yielded type is
+ * `Envelope | ClientEvent`; consumers narrow on `kind` (the QAR `kind`
+ * discriminator stays disjoint from `qar.client.*`).
+ */
+export declare class RawSubscription implements InboundSubscription, AsyncIterable<Envelope | ClientEvent>, AsyncIterator<Envelope | ClientEvent> {
+    private readonly onClose;
+    private readonly queue;
+    constructor(onClose: (sub: RawSubscription) => void);
+    consider(env: Envelope): boolean;
+    considerClient(ev: ClientEvent): void;
+    fail(err: Error): void;
+    close(): void;
+    next(): Promise<IteratorResult<Envelope | ClientEvent>>;
+    return(): Promise<IteratorResult<Envelope | ClientEvent>>;
+    throw(err: unknown): Promise<IteratorResult<Envelope | ClientEvent>>;
+    [Symbol.asyncIterator](): AsyncIterator<Envelope | ClientEvent>;
+}
+/**
+ * Live connection state. Owns the (replaceable) transport and the set of
+ * subscriptions; routes inbound envelopes to subscriptions via `consider`.
+ *
+ * **No connection-level `sessionId`.** Every `task.start` creates a NEW
+ * server-derived session, so an envelope's `session_id` is the TASK's
+ * session — not a property of the WebSocket. The SDK tracks
+ * `task_id → session_id` and `tool_call_id → session_id` here so that
+ * outbound ongoing envelopes can be stamped with the right session at
+ * encode time without coupling consumer code to per-task session
+ * bookkeeping.
+ */
+export declare class Connection {
+    private readonly factory;
+    private readonly url;
+    private readonly headers;
+    private readonly traceContext;
+    readonly metrics: TransportMetrics;
+    private readonly subscriptions;
+    /**
+     * Map of `task_id → session_id` populated from inbound `task.started`
+     * envelopes. Read by {@link sendEnvelope} when encoding `task.continue`
+     * / `task.cancel` / `task.resubscribe` so each ongoing envelope
+     * carries the same server-derived `session_id` the server bound during
+     * admission — preventing multi-task `session_mismatch` without
+     * exposing per-task session bookkeeping on the public API.
+     *
+     * Lifetime: entries are added when `task.started` lands and PRUNED on
+     * `task.done` (the wire's terminal ack — task is fully finished). Any
+     * later `task.resubscribe` against the same `task_id` would be a
+     * cross-process recovery path that has no in-memory session anyway, so
+     * pruning doesn't regress that scenario. Cleared on transport close.
+     * The auto-reconnect/replay path uses LIVE (non-terminated)
+     * subscriptions and adds the session back via the server's replayed
+     * `task.started`, so it's unaffected.
+     *
+     * **Pre-admission invariant.** A live `TaskSubscription` MAY lack an
+     * entry in this map: between `tasks.start` writing its outbound
+     * `task.start` and the inbound `task.started` ack landing, the
+     * subscription is registered in {@link subscriptions} but the
+     * `session_id` is not yet pinned here. A WS drop during this window
+     * leaves the subscription in an unrecoverable state per the
+     * session-identity contract. {@link replayActiveTasks} pre-checks this
+     * map before attempting `task.resubscribe` and short-circuits to
+     * `sub.fail(QodoColdAddressError)` for un-pinned subs — see that
+     * method's JSDoc for the state-machine narrative.
+     */
+    private readonly taskSessions;
+    /**
+     * Map of `tool_call_id → session_id` populated from inbound `tool.request`
+     * envelopes. Read by {@link sendEnvelope} when encoding `tool.response`,
+     * which carries `responses: ToolResponseItem[]` and inherits the parent
+     * `tool.request`'s session via the first response item's `tool_call_id`.
+     *
+     * Lifetime: entries are added when `tool.request` lands and PRUNED on
+     * EITHER (a) the outbound `tool.response` hits the wire (single-use
+     * — one request, one response), OR (b) the owning task terminates
+     * via `task.done` without the consumer ever responding (manual handler
+     * returned `undefined` to indicate async-respond-later, then the task
+     * timed out / canceled / completed without the response). Without (b)
+     * the map would accumulate orphan `tool_call_id` entries on long-lived
+     * connections. Cleared on transport close.
+     */
+    private readonly toolCallSessions;
+    /**
+     * Reverse index of `session_id → Set<ToolCallId>`. Populated on
+     * inbound `tool.request`
+     * (one entry per call). Used to sweep {@link toolCallSessions} when
+     * the owning task terminates without a `tool.response` ever being
+     * sent for some of its outstanding calls — the manual-handler
+     * respond-later path explicitly allows this, and without the sweep
+     * the per-call map entries would survive forever on long-lived
+     * connections.
+     *
+     * Indexed by `session_id` (not `task_id`) because that's the
+     * dimension `tool.request` envelopes carry on the wire — the SDK
+     * derives the owning session via the envelope's `session_id` field,
+     * not via any task_id field on the payload.
+     */
+    private readonly outstandingToolCallsBySession;
+    /**
+     * Reverse index of outbound `task.continue` message_id →
+     * `{ taskId, sessionId }` for envelopes
+     * that carried a caller-supplied cold-address `sessionId` override.
+     * Populated AFTER the wire write (or queued-drain) succeeds; used to
+     * identify which `taskSessions` entry to prune when the server rejects
+     * the override with `error { code: 'session_mismatch' }`.
+     *
+     * Without this index, a wrong cold-address override would pollute
+     * {@link taskSessions} (because `sendEnvelope`'s post-send write
+     * persists the consumer-supplied value as authoritative) and a
+     * subsequent no-override call for the same task would silently reuse
+     * the already-rejected session instead of raising
+     * {@link QodoColdAddressError}.
+     *
+     * **Generation safety:** the entry stores the sessionId of the
+     * override the offending message carried. Pruning is
+     * conditional: we delete `taskSessions[taskId]` ONLY when the
+     * authoritative entry still matches the rejected sessionId. If a
+     * later send for the same task superseded the override with a fresh
+     * (valid) sessionId, the rejection for the stale message must NOT
+     * blow away the newer authoritative entry. The reverse-map entry for
+     * the offending message_id is deleted unconditionally (it's a per-
+     * message tombstone; the message is finished one way or the other).
+     *
+     * Entries are pruned (a) on inbound `error { code: 'session_mismatch' }`
+     * for a known offending_message_id (with generation check), and (b)
+     * on inbound `task.done` for the matching task_id (terminal sweep).
+     * Cleared on transport-terminal cleanup.
+     */
+    private readonly outboundOverrideRefs;
+    private state;
+    /** App-level backpressure flag. Flipped by inbound `flow.pause` / `flow.resume`. */
+    private paused;
+    /**
+     * FIFO of pre-encoded JSON frames that arrived while paused. Drained in
+     * insertion order on `flow.resume`. Pre-encoding at queue-time keeps the
+     * drain path a thin pass-through to the transport.
+     *
+     * Each entry is tagged with the envelope's `messageId` so the owning
+     * `TaskSubscription` can retract its frame on early termination (abort or
+     * iterator break) — without that link, a queued `task.continue` would
+     * still go to the wire on `flow.resume` after the consumer has already
+     * canceled, producing `cancel → continue` reordering on the server.
+     */
+    private readonly pausedQueue;
+    private readonly pausedQueueMax;
+    /** Reconnect policy. */
+    private readonly reconnectMaxAttempts;
+    private readonly reconnectInitialBackoffMs;
+    private readonly reconnectBackoffMultiplier;
+    /**
+     * Pending backoff sleeps. Each entry pairs the timer handle with the
+     * Promise's resolve callback so `disconnect()` mid-reconnect can both
+     * cancel the timer AND wake the loop up so it observes the new state on
+     * the next iteration — without the resolver, clearing the timer would
+     * leave the await pending forever.
+     */
+    private readonly pendingSleeps;
+    /** The active transport. Mutable — replaced on every successful reconnect. */
+    private transport;
+    /** Bound handler instance reused across every transport (initial + reconnects). */
+    private readonly handlers;
+    private constructor();
+    /**
+     * Construct + open a fresh connection through the factory. The connection
+     * captures the factory + url + headers so it can re-open on transport drops
+     * without the caller threading them through again.
+     */
+    static open(args: {
+        factory: WSTransportFactory;
+        url: string;
+        headers: Readonly<Record<string, string>>;
+        maxPausedQueueSize?: number;
+        reconnect?: ClientReconnectOptions;
+        traceContext: TraceContextProvider;
+        metrics: TransportMetrics;
+    }): Promise<Connection>;
+    /**
+     * Encode and send an outbound envelope. Returns the assigned `message_id` so
+     * the caller can track the parent_message_id chain.
+     *
+     * Optionally accepts a pre-allocated `messageId` so subscriptions can be
+     * registered against a known root before the envelope hits the wire — avoids
+     * a race where an inbound reply could be dispatched before the subscription
+     * is in place.
+     *
+     * If the connection is in `flow.pause` and `out.kind` is throttled
+     * (`task.start` / `task.continue`), the encoded frame is enqueued and drained
+     * once `flow.resume` arrives. The returned `messageId` is still allocated
+     * synchronously so callers can register subscriptions against it before the
+     * envelope hits the wire — same invariant as the unpaused path.
+     *
+     * Throws `QodoBackpressureError` when the queue is at its cap.
+     */
+    sendEnvelope(out: OutboundPayload, opts?: {
+        readonly messageId?: MessageId;
+        readonly parentMessageId?: MessageId;
+        /**
+         * Explicit per-Task `session_id` override. Used by the
+         * `ToolRequestDispatcher` to stamp the auto-emitted `tool.response`
+         * with the session it captured from the inbound `tool.request` envelope
+         * (the source of truth for that response's session). When omitted,
+         * {@link sendEnvelope} resolves the `session_id` from
+         * {@link taskSessions} or {@link toolCallSessions} based on the
+         * envelope's `kind`.
+         */
+        readonly sessionId?: SessionId;
+    }): MessageId;
+    /**
+     * Resolve the per-Task `session_id` for an outbound ongoing envelope.
+     * Caller-supplied `override` wins (the dispatcher path passes the
+     * captured inbound `session_id` directly, and the cold-address
+     * public-API path passes the consumer-supplied option); otherwise look
+     * up by the payload's task_id (`task.continue` / `task.cancel` /
+     * `task.resubscribe`) or by the first response item's tool_call_id
+     * (`tool.response`).
+     *
+     * When neither an override NOR an in-memory entry is available, throw
+     * {@link QodoColdAddressError} synchronously. Throwing locally:
+     *
+     *   - puts the cold-address remediation right in the error message
+     *     (consumer should pass `sessionId` from durable storage),
+     *   - saves a wire round-trip + the misleading `session_mismatch`
+     *     error message ("envelope session_id differs from connection
+     *     session" — true but unactionable),
+     *   - matches the doctrinal correct shape (make it right, not make
+     *     it work).
+     *
+     * The primary cross-task session-leak guard is the lookup itself when
+     * admission HAS completed.
+     */
+    private resolveOutboundSessionId;
+    /**
+     * Retract a queued throttled envelope by its `message_id`. Called by
+     * `TaskSubscription` when it terminates early (abort signal, iterator
+     * break, transport failure) so the consumer's cancel intent doesn't race
+     * with their own queued frame on the next `flow.resume`.
+     *
+     * No-op if the messageId isn't queued (already drained, never queued, or
+     * a different envelope kind that doesn't enter the throttle path).
+     * Returns whether an entry was removed — informational only.
+     */
+    dropQueued(messageId: MessageId): boolean;
+    /** Send a raw envelope verbatim — escape hatch. */
+    sendRawEnvelope(env: Envelope): void;
+    /**
+     * Look up the server-derived `session_id` for a known `task_id`.
+     * Used by span recorders that want to stamp `qar.session_id`
+     * on per-Task spans without coupling caller code to the per-Task lookup
+     * map. Returns `undefined` when no `task.started` ack has arrived for
+     * this `task_id` yet (the start path's span is opened pre-admission and
+     * must tolerate this).
+     */
+    getSessionForTask(taskId: TaskId): SessionId | undefined;
+    /**
+     * Look up the `session_id` of the inbound `tool.request` a given
+     * `tool_call_id` came from. Used by `ToolClient.respond` to stamp
+     * its outbound `tool.response` span with the right session without
+     * threading the value through every call site. Returns `undefined` when
+     * no matching `tool.request` arrived (test-only path, or a malformed
+     * consumer call).
+     */
+    getSessionForToolCall(toolCallId: ToolCallId): SessionId | undefined;
+    /** Register a subscription. Caller is responsible for unregistering on close. */
+    subscribe(sub: InboundSubscription): void;
+    unsubscribe(sub: InboundSubscription): void;
+    /**
+     * Tear down: close transport, fail all subscriptions cleanly. Idempotent.
+     * Called by `QodoClient.disconnect()` and by the `onClose` transport handler
+     * for clean closes. Mid-reconnect calls switch state to `disconnecting` so
+     * the in-flight loop bails on the next tick.
+     */
+    close(): void;
+    /**
+     * Drop any queued envelopes and clear the paused flag. Called on every
+     * tear-down path (clean close, transport error, transport close) — leaving
+     * frames in the queue past disconnect would either leak memory or surface
+     * stale outbound on a future connection that reused this object.
+     *
+     * Does NOT clear the per-Task / per-Tool-call session-id lookup maps —
+     * those must survive the reconnect window so `replayActiveTasks` can
+     * stamp the right `session_id` on each `task.resubscribe` envelope it
+     * emits. Final cleanup of the session maps lives in
+     * {@link clearTerminalState}, invoked from the actual tear-down paths.
+     */
+    private clearBackpressureState;
+    /**
+     * Drop the per-Task and per-Tool-call session-id lookup maps. Called
+     * from terminal cleanup paths (`close`,
+     * `cleanCloseAndCleanup`, `failHardAndCleanup`, `finalizeDisconnect`) so
+     * a future `connect()` reusing the same `Connection` object starts with
+     * an empty session-id table. Distinct from {@link clearBackpressureState}
+     * because the reconnect path MUST keep these populated for replay.
+     */
+    private clearTerminalState;
+    /** Whether the connection accepts outbound sends right now. */
+    get isOpen(): boolean;
+    /**
+     * Whether the connection is mid-reconnect. `isOpen` is false during this
+     * window; outbound sends throw. Tests + observability surfaces read this
+     * to render a "reconnecting" indicator.
+     */
+    get isReconnecting(): boolean;
+    /**
+     * Whether the server has signalled `flow.pause` and we have not yet seen
+     * `flow.resume`. While `true`, throttled outbound kinds are queued.
+     */
+    get isPaused(): boolean;
+    /**
+     * Snapshot of the paused-queue depth. Useful for tests and observability;
+     * not a live counter (no subscription, no event).
+     */
+    get pausedQueueDepth(): number;
+    /** Raw outbound predicate — connected AND transport is in OPEN state. */
+    private canSend;
+    private dispatch;
+    /**
+     * Translate an inbound `task.canceling` envelope into a typed
+     * `ClientCancelAckedEvent` and route it to the subscription whose chain
+     * (or `task_id`) matches. Scoped — not connection-wide — so a consumer
+     * running multiple tasks only sees the ack for the task they're
+     * iterating.
+     *
+     * Skips taps (`RawSubscription` already received the envelope through
+     * `fanout`); fans into `TaskSubscription` (matching by `task_id` /
+     * chain) and observer ports (no-op `considerClient`).
+     */
+    private dispatchCancelAcked;
+    /**
+     * Flush the paused queue in FIFO order. Stops if the transport closes
+     * mid-drain (a `transport.send` after close would throw and lose the
+     * remaining frames silently). Caller is responsible for ensuring `paused`
+     * is `false` before invoking — this method does not reset the flag.
+     *
+     * Drain failure preserves queue state. The earlier shape ("slice +
+     * clear + iterate") dropped every
+     * REMAINING entry (including their `overrideToSave` metadata) when
+     * `transport.send` threw mid-drain. The post-send-success invariant
+     * says the override write is conditional on wire-success; an entry
+     * that
+     * never reaches the wire MUST stay in the queue so the next drain
+     * (after the transport recovers and `flow.resume` arrives again,
+     * or via the reconnect-loop's eventual retry) can replay it with
+     * the same metadata intact.
+     *
+     * New shape: walk by INDEX without clearing the queue first.
+     *   - For each entry, send + commit override. If both succeed,
+     *     mark the index as drained.
+     *   - If `transport.send` throws OR `canSend()` flips mid-drain,
+     *     stop immediately, splice off only the successfully drained
+     *     prefix. Everything from the failing index onward stays in
+     *     `pausedQueue` for the next drain attempt.
+     *
+     * The naive `while (length > 0) shift()` form is O(n²) because each
+     * `shift()` reindexes the whole array; with a user-configurable cap
+     * the blocking time on a large drain shows up in the inbound-message
+     * handler. Index-walk + single splice at the end keeps the drain O(n).
+     */
+    private drainPausedQueue;
+    private fanout;
+    private broadcastClient;
+    /**
+     * Wire-level error from the transport. If the user hasn't disconnected and
+     * we have something worth replaying, kick off the reconnect loop. Otherwise
+     * fail the subscriptions and shut down.
+     *
+     * Re-entrancy: a custom `WSTransport.close()` may synchronously invoke
+     * `handlers.onClose` (the `WSTransport` interface places no async-vs-sync
+     * contract on close-event timing — only that one fires). If we called
+     * `disposeTransportSafely()` while `state` was still `'connected'`, the
+     * synchronous `onClose` would re-enter `transportClosed`, see state still
+     * `'connected'`, and start its own reconnect loop. Then this method would
+     * return and start ANOTHER one. To prevent this, we transition state OUT
+     * of `'connected'` before disposing — any re-entrant `transportClosed` /
+     * `transportFailed` then sees the guard and returns early.
+     */
+    private transportFailed;
+    /**
+     * Transport closed. Clean codes (1000/1001/1005) end the subs cleanly even
+     * if reconnect would otherwise be possible — the server told us to go.
+     * Unexpected codes drop into the same reconnect loop as `transportFailed`.
+     *
+     * Re-entrancy: same guard as `transportFailed` — state transitions before
+     * disposal so a synchronous `onClose` from `transport.close()` can't fire
+     * a second reconnect loop. Clean closes use a separate guard state
+     * (`'disconnecting'` → `'disconnected'`) for the same reason.
+     */
+    private transportClosed;
+    /**
+     * Reconnect is worth attempting only when there's at least one in-flight
+     * task subscription that can be replayed. A connection with no live tasks
+     * and only raw taps gains nothing from a reconnect — the user can call
+     * `connect()` fresh next time they need it.
+     */
+    private shouldAttemptReconnect;
+    /**
+     * Reconnect loop. Backs off exponentially, retries up to `maxAttempts`. On
+     * success: swap the transport, broadcast `qar.client.reconnected`, fire a
+     * `task.resubscribe` per active task. On exhaustion: broadcast
+     * `qar.client.reconnect_failed`, fail every subscription.
+     *
+     * Mid-loop user disconnect is honored — we check `state` after every async
+     * boundary and bail with a clean close.
+     */
+    private runReconnectLoop;
+    /**
+     * For each active task subscription, send a `task.resubscribe` envelope
+     * using its `lastSeenMessageId` as the anchor. The new envelope's id is
+     * stitched into the subscription's chain so the server's replayed
+     * envelopes route back transparently.
+     *
+     * **Active-subscription state machine.** A `TaskSubscription`
+     * registered in `this.subscriptions` can be in one of three states at
+     * any point in a connection's lifetime:
+     *
+     *   1. **pre-admission** — `tasks.start` sent its outbound envelope on
+     *      the wire and the SDK eagerly registered the subscription so
+     *      inbound routing can find it. The server-derived `session_id`
+     *      is NOT yet in {@link taskSessions} because no `task.started`
+     *      ack has been observed. `currentTaskId` IS set (derived from
+     *      `task.start.message_id` per the wire contract `task_id ==
+     *      task.start.message_id`).
+     *   2. **admitted** — the `task.started` ack landed; the canonical
+     *      `task_id` is in `currentTaskId` and the matching `session_id`
+     *      is pinned in {@link taskSessions}. Resubscribe is fully
+     *      addressable.
+     *   3. **terminated** — `task.done`, server-error, transport-fail,
+     *      or consumer-driven close has flipped `isTerminated` true.
+     *      `onClose` has already unsubscribed; subs in this state should
+     *      not be in the iterating snapshot.
+     *
+     * `replayActiveTasks` must handle states (1) and (2) explicitly.
+     * State (1) is **unrecoverable** per the session-identity contract:
+     * without an in-memory `session_id`, the SDK cannot construct a
+     * wire-valid `task.resubscribe` for the server's pre-merge
+     * bind-and-derive ingress (the resubscribe envelope MUST carry the
+     * correct `session_id` field per the QAR wire schema).
+     *
+     * **Implementation note.** The implementation pre-checks the per-Task
+     * session map BEFORE attempting the wire send. A state-(1) sub is
+     * failed with a freshly-constructed `QodoColdAddressError` whose
+     * stack starts cleanly inside `replayActiveTasks` — no wire
+     * round-trip is attempted; the failure is local, typed, and
+     * origin-traceable. An earlier implementation called
+     * {@link sendEnvelope} first and relied on the synchronous throw
+     * from {@link resolveOutboundSessionId} to route the failure into
+     * `sub.fail(err)` — functionally correct but the thrown error
+     * carried a misleading stack (the wire-send frames). The current
+     * pre-check approach surfaces a typed local failure instead.
+     * The consumer-facing API surface is unchanged: state-(1) subs still
+     * surface `QodoColdAddressError` on their iterator. Lost-ack
+     * idempotent retry (re-issuing the original `task.start` on the new
+     * transport with the same idempotency-key) lives at the layer
+     * above; the raw `Connection` ships the typed failure.
+     *
+     * Every `TaskSubscription` carries a known `task_id` from construction:
+     * `tasks.continue` / `tasks.cancel` / `tasks.resubscribe` receive it from
+     * the caller, and `tasks.start` derives it from the outbound
+     * `task.start.message_id`. The `currentTaskId === undefined` case is
+     * therefore unreachable here — we keep an invariant assertion rather
+     * than the prior "in-flight task is unrecoverable" `sub.fail` path.
+     */
+    private replayActiveTasks;
+    private cleanCloseAndCleanup;
+    private failHardAndCleanup;
+    /**
+     * Walk the user-initiated disconnect path from inside the reconnect loop.
+     * The subs are still registered (we deferred their close); end them
+     * cleanly so `for await` consumers see `done: true` rather than an error.
+     */
+    private finalizeDisconnect;
+    private disposeTransportSafely;
+    private clearPendingTimers;
+    /**
+     * Sleep for `ms` milliseconds, cancellable by `clearPendingTimers`. Returns
+     * even if the timer is cleared early — the caller checks `state` after the
+     * await to decide whether to proceed. Cancelling resolves the Promise
+     * rather than rejecting it: cancellation is a flow-control signal, not an
+     * error, and the reconnect loop's post-await state check handles it.
+     */
+    private sleepCancellable;
+}
+export type { WSTransportFactoryArgs };
+//# sourceMappingURL=connection.d.ts.map