Skip to main content

Module object

Module object 

Source
Expand description

Core object primitives extracted from the monolith.

Structs§

Action
An action records an operation between states.
ActionId
Unique identifier for an action (derived from content).
Agent
AI agent identity that performed changes on behalf of a principal.
Annotation
A stable logical annotation with revision history.
AnnotationRevision
A single revision of a logical annotation.
Attribution
Attribution for a change (who did it).
Blob
A blob stores raw file contents.
BranchCreatedV1
Branch creation operation body.
ChangeId
A stable change identifier (16 bytes / 128 bits).
ConflictSide
ConflictSymbol
ContentHash
A BLAKE3 content hash (32 bytes / 256 bits).
ContextBlob
A collection of logical annotations for a single target.
CursorMovedV1
Cursor movement operation body.
Discussion
DiscussionTurn
DiscussionsBlob
FileChange
A single file change with path and kind.
FileChangeSet
A collection of file changes with convenience accessors.
FileProvenance
LineSpan
MarkerName
Name of a heddle marker (tag-like construct).
NativeToolCallRefV1
Native harness tool-call identity.
OperationId
Origin
OriginSet
Principal
Human identity accountable for changes.
ProducerId
Identifies the producer that fired this signal. The version lets budgeting and signal-health surfaces age out signals from old producer versions without re-running computation — important when we tune a producer’s heuristics and want to compare apples to apples.
Redaction
A redaction declaration on a single blob in a single state.
RedactionsBlob
On-disk blob containing all redactions for a single blob hash. One file per redacted blob, encoded with rmp-serde — matches the ReviewSignaturesBlob pattern.
ReviewSignature
ReviewSignaturesBlob
RiskSignal
RiskSignalBlob
Top-level encoded blob. Stored under a [ContentHash] referenced from [State::risk_signals]. A blob with format_version > FORMAT_VERSION is rejected; older versions are read with the missing-field defaults.
Scope
Checkout/lane scope identifier for scoped operations.
Session
SessionSegment
SignalAnchor
Where in the change a signal fires. Symbol-level is preferred — symbols are durable across renames; line ranges are computed at fire time and drift as code is reformatted.
State
A state is an immutable snapshot with rich metadata.
StateSignature
Signature information for a state.
StateVisibility
A visibility-tier declaration on a single state.
StateVisibilityBlob
On-disk blob containing all visibility records for a single state. One file per state, encoded with rmp-serde — mirrors the RedactionsBlob sidecar pattern.
StructuredConflict
SymbolAnchor
Durable symbol-level anchor: a file path plus a symbol name. No line range — line numbers move under reformatting; symbols do not.
ThreadName
Name of a heddle thread (branch-like construct).
TimelineBranchId
TimelineOperationEnvelope
A v1 timeline operation envelope.
TimelineOperationId
Content-addressed identifier for a timeline operation envelope.
TimelineStepId
TimelineToolPayloadMetadata
Scrubbed metadata for native tool payloads.
ToolCallFinishedV1
Tool-call finish operation body.
ToolCallStartedV1
Tool-call start operation body.
Tree
TreeEntry
Verification
Verification information for a state.

Enums§

AnnotationKind
The canonical annotation taxonomy the product surfaces.
AnnotationScope
What part of a file an annotation targets.
AnnotationStatus
ChangeIdParseError
Error parsing a ChangeId.
ChangeImportance
How important is this change for review.
ConflictError
ConflictResolution
ContextError
ContextTarget
A typed target for context entries.
DiffKind
Kind of file change.
DiscussionError
DiscussionResolution
EntryType
FileMode
ModificationKind
What kind of modification was made to a file.
Operation
Type of operation performed.
OperationIdParseError
ProvenanceError
RedactionError
Errors produced while encoding/decoding redactions.
ReviewKind
Reviewer roles. New variants append at the tail; the wire format stays backwards compatible because serde emits the snake-case discriminant.
ReviewScope
Reviewer signed off on the whole change, or on a specific list of symbols.
ReviewSignatureError
RiskSignalError
RiskSignalKind
Why a signal fired. Variants are wire-stable; new variants are appended.
SemanticChange
A semantic change description.
SignatureStatus
Signature verification result.
StateVisibilityError
Errors produced while encoding/decoding/validating state visibility.
Status
Lifecycle status of a state.
TimelineBranchReason
Why a timeline branch was created.
TimelineCodecError
Timeline operation codec error.
TimelineCursorMoveReason
Why the timeline cursor moved.
TimelineLabel
Safety labels attached to timeline operations.
TimelineOperationBodyV1
V1 timeline operation body variants.
TimelineOperationIdParseError
Error parsing a timeline operation id.
TimelineOperationKind
Explicit timeline operation kind stored in every operation envelope.
TimelineToolCallStatus
Tool-call terminal status.
TreeError
VisibilityTier
Content-side visibility tier. Shared by annotations, discussions, and states so the per-commit visibility tiers and annotation/discussion visibility draw from one vocabulary rather than parallel enums.

Constants§

MAX_REASON_LEN
Maximum length of RiskSignal::reason, in bytes.
REDACTION_SIGNING_PAYLOAD_VERSION_TAG
Stable byte prefix the signing payload begins with. Bumping this versions the payload format itself; old signatures with the old prefix continue to verify exactly as they did when written.
STATE_VISIBILITY_SIGNING_PAYLOAD_VERSION_TAG
Stable byte prefix the signing payload begins with. Bumping this versions the payload format itself; old signatures with the old prefix continue to verify exactly as they did when written.
TIMELINE_OPERATION_SCHEMA_VERSION
Current timeline operation schema version.

Functions§

diff_trees
Collect all file changes between two trees.
diff_trees_visit
Diff two trees with internal iteration, invoking visitor for each FileChange in traversal order.
generate_session_id
parse_commit_extension_headers
Parse the extension headers from a raw git commit object’s content bytes (the bytes git cat-file commit <sha> prints — i.e. gix’s Commit::data), in their exact on-the-wire order, ready to store in State::extra_headers.
signing_payload
Build the deterministic byte payload that a ReviewSignature is computed over. Re-implementing this in another language (TypeScript, Python) must produce byte-identical output for verification to round-trip.
validate_tree_entry_name

Type Aliases§

DiscussionId
Stable opaque identifier for a discussion. Generated server-side at open time. We use a String rather than ChangeId to leave room for whatever id scheme the discussion service ends up choosing (likely a UUID).