Expand description
Shared durable session contracts for Starweaver.
Structs§
- Acquire
Background Subagent Continuation - Atomic durable continuation admission request.
- Acquire
RunAdmission - Request for atomic one-active-run admission.
- Admit
RunControl - Request to atomically reserve a receipt and its durable control effect.
- Agent
Display Page - Page of sanitized historical display evidence.
- Agent
Replay Query - Display-safe replay query.
- Agent
RunList Query - Compact run list query.
- Agent
RunPage - Page of compact runs.
- Agent
RunView - Prompt-safe compact run projection.
- Agent
Session Control Error - Prompt-safe control error.
- Agent
Session Include - Sections requested by a get-session operation.
- Agent
Session List Query - Compact query for canonical session listing.
- Agent
Session Page - Page of compact sessions.
- Agent
Session Query Error - Prompt-safe query error.
- Agent
Session Scope - Host-derived authority supplied separately from model arguments.
- Agent
Session View - Prompt-safe compact session projection.
- Approval
Decision - Recorded approval decision.
- Approval
Mutation Result - Durable result of an atomic approval decision.
- Approval
Record - Durable approval prompt record.
- Attach
Environment - Atomic attachment creation command. All provider-private resolution has already occurred.
- Background
Subagent Artifact - Durable host-owned oversized result artifact.
- Background
Subagent Artifact Limits - Host policy limits applied atomically to retained result artifacts.
- Background
Subagent Continuation Cause - Typed immutable cause for one result-triggered continuation.
- Background
Subagent Continuation Receipt - Atomic durable continuation admission receipt.
- Background
Subagent Record - Durable service-host projection of one background attempt.
- Background
Subagent Terminal Commit - Atomic terminal evidence and optional oversized-result artifact commit.
- Binary
Ref - Binary resource legacy reference submitted as session input.
- Checkpoint
Ref - Stable reference to a persisted checkpoint.
- Clarification
Answer - Validated answer to one clarification question.
- Clarification
Mutation Result - Durable result of an atomic clarification resolution.
- Clarification
Option - One option in a durable clarification question.
- Clarification
Question - One question parsed from durable
ask_user_questionrequest evidence. - Clarification
Resolution - Durable typed clarification resolution.
- Compact
RunTrace - Compact run projection for tools, CLI, and UI.
- Compact
Session Trace - Compact session projection for lists, CLI inspect, and UI sidebars.
- Continuation
Effect State - Typed host-visible projection for a continuation whose effect outcome cannot be proven.
- Create
Managed Session - Allowlisted create-session command.
- Decide
Approval - Atomic approval-decision command.
- Deferred
Mutation Result - Durable result of an atomic deferred-tool mutation.
- Deferred
Tool Record - Durable deferred tool record.
- Deferred
Tool Request - SDK-facing deferred tool request.
- Deferred
Tool Requests - Collection of deferred tool requests.
- Deferred
Tool Result - SDK-facing deferred tool result.
- Deferred
Tool Results - Collection of deferred tool results.
- Delete
Managed Session - Revision-checked tombstone command. Evidence purge is intentionally absent.
- Detach
Environment - Atomic attachment detachment command.
- Durable
Background Subagent Delivery Claim - Atomic durable delivery claim.
- Durable
Background Subagent Owner Lease - Durable fenced owner lease for one process-local background execution.
- Durable
Background Subagent Result Ref - Bounded terminal result material retained by the durable host.
- Durable
Control Receipt - Durable receipt stored independently from a process-local control handle.
- Durable
Environment Attachment - Safe durable projection of an environment attachment.
- Durable
Environment Mount - Safe durable projection of one mounted resource.
- Durable
Host Event Page - One bounded, eligibility-filtered durable host-event page.
- Durable
Host Event Query - Bounded storage query over one resource scope and an admitted set of event classes.
- Durable
Host Event Record - One materialized durable host-event record.
- Durable
Model Selection - Authority-bound durable model selection.
- Durable
RunControl Intent - Receipt plus durable steering inbox entry or interrupt intent.
- Durable
RunStatus - Durable run status composed from admission state and the shared runtime lifecycle.
- Environment
Attachment Mutation Result - Durable result of an attachment mutation.
- Environment
Attachment Page - Stable bounded attachment page.
- Environment
Attachment Page Key - Stable keyset position for attachment queries.
- Environment
Attachment Page KeyProjection - Serializable form of an attachment page key.
- Environment
Attachment Query - Bounded authority-scoped attachment query.
- Environment
Host Event Context - Stable identity and visibility scope for an environment event projected at commit time.
- Environment
Mount Mutation Result - Durable result of a mount mutation.
- Environment
Mount Query - Bounded stable active-mount query for one run.
- Environment
Mutation Context - Shared authority, idempotency, timestamp, and event evidence for an environment mutation.
- Environment
State Ref - Stable reference to an exported environment provider state.
- Event
Publication Key - Stable deterministic identity for one logical transition’s event publication.
- FileRef
- Provider-scoped legacy file reference submitted as session input.
- Hitl
Resume Claim - Exclusive durable claim acquired before a waiting run may execute a continuation.
- InMemory
Session Store - In-memory session store for deterministic tests and single-process hosts.
- Initialize
Model Selection - Caller-supplied default used only when an authority has no durable selection yet.
- Interaction
Mutation Context - Shared authority, concurrency, idempotency, and publication evidence for an interaction command.
- Interaction
Page - One stable page of approval or deferred-tool records.
- Interaction
Page Key - Stable key identifying one HITL record’s position in updated-time ordering.
- Interaction
Page Query - Bounded keyset query over approval or deferred-tool records.
- Interrupt
Managed Run - Cooperative interruption command.
- Managed
RunTarget - Composite identity of a durable run. A run id is never globally unique.
- Managed
Session Patch - Typed session update patch.
- Managed
Session Target - Composite identity of a durable session.
- Model
Selection Mutation Receipt - Durable result of one model-selection mutation.
- Mount
Environment Resource - Atomic allowlisted-resource mount command.
- Mutation
Receipt - Durable, wire-independent projection of an idempotent mutation receipt.
- Output
Available Projection - Product-neutral durable
output_availableevent projection. - Pending
Host Event Publication - One view-independent host event waiting for durable-log materialization.
- Pending
Stream Publication - One transactionally enqueued stream-publication batch.
- Prepared
Continuation - Side-effect-free continuation package shared by every product host.
- Queued
RunStatus - A queued durable run has not entered an executable runtime lifecycle.
- Related
RunUpdate - Atomic transition applied to an existing run together with a new run evidence commit.
- Resolve
Clarification - Atomic clarification-resolution command.
- Resolve
Deferred Tool - Atomic deferred-tool completion/failure command.
- RunAdmission
Lease - Durable one-active-run lease owned by a host instance.
- RunAdmission
Receipt - Result of admission or an exact retry.
- RunChanged
Projection - Product-neutral durable
run_changedevent projection. - RunChanged
Summary - Product-neutral run summary used by durable
run_changedprojections. - RunControl
Receipt - Accepted steering/interruption result.
- RunEvidence
Commit - Complete product-neutral durable evidence for one run.
- RunRecord
- Durable run record.
- RunStart
Receipt - Accepted non-blocking run result.
- RunTerminal
Error - Product-neutral diagnostic retained with a terminal durable run.
- RunTerminal
Projection - Atomic terminal status, output, and diagnostic projection.
- Select
Model - Atomic model-selection mutation request.
- Session
Continuation Fence - Deletion/continuation hook exposed to async supervisors without coupling both control planes.
- Session
Filter - Query filters for listing sessions.
- Session
Id - Session identifier shared by SDK, CLI, and service layers.
- Session
Mutation Receipt - Session mutation result.
- Session
Page - One stable page of durable sessions.
- Session
Page Key - Stable key identifying one session’s position in the updated-time ordering.
- Session
Page Query - Bounded keyset query over sessions ordered by update time and stable identity descending.
- Session
Record - Durable session record.
- Session
Resume Snapshot - Resume package loaded from a durable session store.
- Session
Search Capabilities - Provider capability advertisement.
- Session
Search Checkpoint - Durable writer acknowledgement/watermark.
- Session
Search Coverage - Coverage and freshness for every returned page, including empty pages.
- Session
Search Cursor Binding - Cursor payload shared by conforming providers. Callers treat its encoded form as opaque.
- Session
Search Cursor Codec - Keyed cursor encoder/validator. Encoded cursors contain no paths or backend row ids.
- Session
Search Document - Redacted document accepted by optional index writers.
- Session
Search Filter - Typed filters for search and metadata browsing.
- Session
Search Highlight - Highlight range using UTF-8 byte offsets into the returned snippet.
- Session
Search Hit - One discovery hit.
- Session
Search Location - Match provenance. Archive scope and source run identity remain distinct.
- Session
Search Mutation - Versioned, idempotent search-index mutation.
- Session
Search Page - One page of discovery results.
- Session
Search Query - A bounded search request.
textis never a regular expression or shell expression. - Session
Search Scope - Host-constructed authorization namespace. It is deliberately separate from user input.
- Session
Search Snippet - Bounded plain-text snippet.
- Session
Search Summary - Minimal canonical session projection.
- Session
Search Time Range - Inclusive lower / exclusive upper timestamp range.
- Session
Search Warning - Safe coverage warning. Messages must not contain backend paths or indexed content.
- Session
Store Executor - Executor adapter that persists runtime checkpoints into a session store.
- Start
Managed Run - Non-blocking run start command.
- Steer
Managed Run - Structured steering command.
- Stream
Cursor Ref - Stable durable reference to a family-aware stream replay position.
- Stream
Publication Targets - External sink families selected for reliable publication.
- Tool
Return Record Input - Tool-return evidence used to derive durable HITL records without depending on model crates.
- Unmount
Environment Resource - Atomic resource unmount command.
- Update
Managed Session - Revision-checked session update.
Enums§
- Agent
Session Control Error Code - Required control error categories.
- Agent
Session Operation - Agent-facing session operation class.
- Agent
Session Query Error Code - Required query error categories.
- Approval
Status - Durable approval status.
- Continuation
Effect Outcome - Durable outcome classification for a continuation effect boundary.
- Continuation
Effect Phase - Durable effect boundary reached by a continuation.
- Continuation
Preparation Error - Stable continuation preparation failures shared by CLI, RPC, and future hosts.
- Continuation
Preparation Mode - Continuation preparation mode selected by the host.
- Deferred
Mutation Outcome - Terminal outcome supplied for a deferred tool.
- Durable
Background Subagent Delivery Release - Durable reason for releasing a matching result-delivery claim.
- Durable
Background Subagent Delivery Status - Orthogonal durable logical-delivery state.
- Durable
Background Subagent Execution Status - Monotonic durable execution state for one background attempt.
- Durable
Background Subagent Retention Status - Durable content-retention state, independent from execution and delivery.
- Durable
Environment Mount Status - Durable mount lifecycle state.
- Durable
Environment Scope - Product-neutral attachment scope.
- Durable
Environment Status - Durable attachment lifecycle state.
- Durable
Host Event Class - Stable product-neutral event classes persisted by the session store.
- Durable
Host Event Scope - Resource scope owned by one durable host event.
- Durable
RunControl Effect - Durable control effect carried by an admitted intent.
- Durable
RunControl Status - Durable lifecycle of one admitted control effect.
- Environment
Mutation Result - Typed payload stored in the shared environment idempotency namespace.
- Execution
Status - Generic execution status for approval, deferred, checkpoint, and archive workflows.
- Hitl
Resume Abort Outcome - Result of atomically aborting a fenced HITL replacement before worker launch.
- Hitl
Resume Claim State - Durable resume-claim phase.
- Input
Conversion Error - Failure converting legacy durable input into canonical model content.
- Input
Part - Serializable run input submitted by SDKs and product hosts.
- RunTerminal
Projection Error - Invalid new terminal run projection.
- Session
Deletion Fence - Explicit session deletion state/fence used by run and continuation admission.
- Session
Search Consistency - Search consistency behavior.
- Session
Search Coverage State - Completeness state for one page.
- Session
Search Error - Required search error categories.
- Session
Search Filter Kind - Filter vocabulary advertised by a provider.
- Session
Search Granularity - Result grouping level.
- Session
Search Index Error - Index-publication errors.
- Session
Search Mutation Operation - Idempotent index operation.
- Session
Search Query Mode - Text interpretation mode.
- Session
Search Sort - Stable ordering requested by the caller.
- Session
Search Source - Searchable projection family.
- Session
Search Visibility - Display visibility classes that a host may permit.
- Session
Search Warning Kind - Safe warning category.
- Session
Status - Current durable session status.
- Session
Store Error - Session store failure.
- Stream
Cursor RefError - Invalid durable stream-cursor update.
- Stream
Publication Target - One independently acknowledged external stream sink.
- Tool
Approval Decision - Tool approval decision supplied by a host or user.
Constants§
- APPROVAL_
DECIDE_ OPERATION - Stable operation identifier for approval decisions.
- ASK_
USER_ QUESTION_ ACTION - Tool name whose approval records represent clarification requests.
- BACKGROUND_
SUBAGENT_ RECORD_ VERSION - Current durable background-subagent record schema.
- CLARIFICATION_
ANSWERS_ METADATA_ KEY - Approval-decision metadata key containing validated clarification answers.
- CLARIFICATION_
RESOLVE_ OPERATION - Stable operation identifier for clarification resolution.
- CLARIFICATION_
RESPONSE_ METADATA_ KEY - Approval-decision metadata key containing an optional aggregate response.
- CONTINUATION_
EFFECT_ METADATA_ KEY - Durable metadata key carrying a typed continuation-effect recovery projection.
- DEFAULT_
BACKGROUND_ RESULT_ RETENTION_ SECS - Default retained-result lifetime used by store-side interruption reconciliation.
- DEFERRED_
COMPLETE_ OPERATION - Stable operation identifier for successful deferred-tool completion.
- DEFERRED_
FAIL_ OPERATION - Stable operation identifier for failed deferred-tool completion.
- ENVIRONMENT_
ATTACH_ OPERATION - Stable operation identifier for attachment creation.
- ENVIRONMENT_
DETACH_ OPERATION - Stable operation identifier for attachment detachment.
- ENVIRONMENT_
MOUNT_ OPERATION - Stable operation identifier for mounting an allowlisted resource.
- ENVIRONMENT_
UNMOUNT_ OPERATION - Stable operation identifier for unmounting a resource.
- LOCAL_
SESSION_ NAMESPACE - Backward-compatible namespace used by single-user local products.
- MAX_
ENVIRONMENT_ MOUNTS_ PER_ RUN - Maximum active mounts retained for one run, matching the host result bound.
- MAX_
ENVIRONMENT_ PAGE_ SIZE - Maximum page size accepted by durable attachment queries, matching the host schema.
- MAX_
HOST_ EVENT_ PAGE_ SIZE - Maximum number of durable host events returned by one storage query.
- MAX_
HOST_ EVENT_ POSITION - Largest backend position shared by memory and
SQLiteimplementations. - MAX_
STABLE_ PAGE_ SIZE - Maximum number of records returned by one stable keyset page.
- MODEL_
SELECTION_ OPERATION - Stable operation identifier recorded for model-selection mutations.
Traits§
- Session
Search Index Writer - Optional mutation target used by local or external indexes.
- Session
Search Provider - Read-only provider for session discovery projections.
- Session
Store - Durable session store contract.
Functions§
- append_
authoritative_ run_ publications - Add authoritative run/output events unless the caller already supplied that class and scope.
- background_
subagent_ input_ digest - Compute a domain-separated SHA-256 digest of canonical durable input parts.
- background_
subagent_ result_ digest - Compute the versioned domain-separated digest for one logical terminal result.
- deterministic_
run_ control_ operation_ id - Derive a deterministic operation id from all authority/idempotency identity components.
- deterministic_
run_ control_ receipt_ id - Derive a deterministic receipt id from the operation identity.
- output_
available_ publication - Build a durable
output_availablepublication when a run has a user-visible preview. - run_
changed_ publication - Build a durable
run_changedpublication from authoritative storage-domain state. - validate_
clarification_ answers - Parse and strictly validate a durable clarification request and caller answers.
Type Aliases§
- RunStatus
- Backward-compatible public name for the durable run status.
- Session
Store Result - Result alias for session store operations.