Skip to main content

Module domain

Module domain 

Source
Expand description

Pure domain model types.

Structs§

AuditEventRecord
Redacted durable audit event.
BusinessAlias
BusinessDefinitionFact
BusinessDomain
BusinessDomainDefinition
Authored business domain definition.
BusinessEvidence
Provenance retained for every accepted authored business fact.
BusinessGlossary
Authored repository business glossary schema v1.
BusinessKnowledgeConflict
BusinessKnowledgeProjection
Storage projection before API metadata and repository scope are attached.
BusinessKnowledgeProjectionInput
Prepared projection input written by the repository index writer.
BusinessKnowledgeQueryRequest
Repository and immutable-ref bound business knowledge request.
BusinessKnowledgeSource
One route-authorized authored glossary loaded from an immutable repository snapshot.
BusinessKnowledgeStatus
Projection freshness and bounded cardinality summary.
BusinessSemantics
Declarative calculation semantics. Formula text is not executable in v1.
BusinessTechnicalMapping
BusinessTechnicalMappingDefinition
Authored edge from one business term to a technical target hint.
BusinessTerm
BusinessTermDefinition
Authored business term and its declared technical mappings.
ClaimRecord
Claim fact extracted from or supported by evidence.
CodeCallRecord
Call relationship extracted from code.
CodeChunkRecord
Versioned retrievable code chunk.
CodeDependencyRecord
Dependency declaration extracted from package manager manifest or lock files.
CodeExtractionMetadata
Tree-sitter query metadata attached to extracted code facts.
CodeFeatureFlagGraph
Feature flag graph grouped by stable configuration source.
CodeFeatureFlagRecord
Feature flag or runtime configuration relationship extracted from code.
CodeFeatureFlagRequest
Feature-flag graph query over an indexed repository scope.
CodeFeatureFlagUsage
One code location where a feature flag is defined, read, or guards code.
CodeFileDiagnostic
File-level diagnostic produced by indexing.
CodeFileFields
Input fields for one parsed repository file.
CodeFileFingerprint
Previously indexed file hash used to skip unchanged incremental parses.
CodeFileRecord
Parser output for one repository file.
CodeFrameworkEdgeRecord
One indexed relationship between framework nodes or an unresolved target hint.
CodeFrameworkNodeRecord
One indexed framework component, declaration, or template construct.
CodeGraphArtifact
Code graph artifact tied to a shared retrieval result.
CodeGraphBatch
Atomic code graph mutation batch.
CodeGraphCodeExcerpt
Compact code excerpt retained inside the context byte budget.
CodeGraphCommitReceipt
Receipt returned after code graph facts commit.
CodeGraphContextBudget
Budget consumed by one codegraph context orchestration.
CodeGraphContextPack
Internal context packing input grouped by structural role.
CodeGraphContextProvenance
Context item provenance used by packed codegraph responses.
CodeGraphContextRequest
Agent-facing one-call code graph context request.
CodeGraphImpactHint
Structural risk hint around a seed symbol or file.
CodeImpactPathGroups
Diff paths split by the effective repository selector.
CodeImpactRequest
Code impact analysis request over a Git diff.
CodeImportRecord
Import relationship extracted from code.
CodeIncrementalSummaryReceipt
Bounded incremental-work metrics retained across post-delta finalization.
CodeIndexBatch
One bounded parse result committed under a checkpointed index session.
CodeIndexCheckpoint
Durable progress checkpoint for a repository indexing session.
CodeIndexProgressSummary
Coarse phase timing and counts reported by repository indexing.
CodeIndexPublicationFence
Attempt-scoped token required to publish code-index state.
CodeIndexRequest
CodeIndexResourceBudget
Resource budget used to partition repository indexing into bounded batches.
CodeIndexSession
Stable metadata for one resumable repository indexing session.
CodeIndexSnapshot
Parsed index changes ready to commit into storage.
CodeIndexSummary
Result of applying a code index snapshot.
CodeIndexTaskQueueStatus
Aggregated durable queue state for background code-index tasks.
CodeIndexTaskRecord
Durable background task for one code repository index request.
CodeMonorepoWorkspace
A detected monorepo workspace that groups multiple packages under a common root.
CodeParseStatusCounts
Parse-status counts surfaced by graph diagnostics.
CodePathTombstone
Rename/delete lineage marker retained after incremental updates.
CodeRange
Inclusive source line range and half-open byte range in a repository file.
CodeReferenceFields
Input fields for a syntax-level reference.
CodeReferenceRecord
Versioned syntax-level reference or dependency edge candidate.
CodeRepositoryCrossEdge
Cross-repository overlay edge derived after member snapshots are indexed.
CodeRepositoryExcludedPath
Path excluded from indexing by preset, ignore file, or request scope.
CodeRepositoryLanguagePreview
Language bucket in a repository scope preview.
CodeRepositoryLargestFile
Large file surfaced before a full repository index starts.
CodeRepositoryLatencySample
Representative query latency captured for an operations report.
CodeRepositoryRegistration
Code repository identity persisted after registration.
CodeRepositoryRemovalSummary
Counts and aliases removed when a registered repository is deleted.
CodeRepositoryReport
Reusable repository operations report.
CodeRepositoryRetentionJobStatus
Observable progress for one durable whole-repository index retention job.
CodeRepositoryScopePreview
Non-mutating preview of the effective repository indexing scope.
CodeRepositorySelector
Repository selector accepted by code index and retrieval APIs.
CodeRepositorySet
Persisted repository-set metadata.
CodeRepositorySetAddMemberRequest
Request to attach one indexed repository snapshot to a repository set.
CodeRepositorySetCreateRequest
Repository-set creation request shared by API adapters.
CodeRepositorySetMember
Persisted repository-set membership pointing at a real repository snapshot.
CodeRepositorySetMemberStatus
Status for one repository-set member snapshot.
CodeRepositorySetOverlayStatus
Overlay freshness and task-independent diagnostics.
CodeRepositorySetQueryHit
Query hit with explicit repository-set provenance.
CodeRepositorySetQueryRequest
Multi-repository query request.
CodeRepositorySetRefreshSummary
Summary returned after rebuilding a repository-set overlay.
CodeRepositorySetRefreshTaskRecord
Durable repository-set overlay refresh task record.
CodeRepositorySetRemoveMemberRequest
Request to remove one repository snapshot from a repository set.
CodeRepositorySetStatus
Aggregated repository-set status.
CodeRepositoryStatus
Repository index status and diagnostics summary.
CodeRepositoryTotals
Aggregated totals for repository indexes separate from graph-evidence code rows.
CodeRetrievalHit
Code retrieval hit with source location, layers, and freshness metadata.
CodeRetrievalRequest
Code repository retrieval request.
CodeRouteRecord
Web framework route mapping extracted from source code.
CodeScopeRetentionSummary
Scope retention result after pruning old repository snapshots.
CodeScopeRetirementJobStatus
Observable progress for one durable, restart-safe scope retirement job.
CodeSymbolGenerationCounts
Generated/handwritten split for symbols in one code index scope.
CodeSymbolRecord
Versioned syntax-level symbol definition.
CodeWorkspaceDetectionConfig
Configuration controlling automated monorepo workspace detection.
CodeWorkspaceMember
A single package member inside a monorepo workspace.
CodeWorkspacePackageMapping
Maps a workspace member’s package name to an indexed repository scope.
CodebaseViewBudget
View derivation budget and truncation metadata.
CodebaseViewCall
Call evidence row with optional resolved target path.
CodebaseViewDeclaredBusinessDomain
Authored domain row merged ahead of inferred route, flag, and path signals.
CodebaseViewDependency
Dependency evidence row from manifests and lockfiles.
CodebaseViewEdge
Graph-derived view edge.
CodebaseViewEvidence
Evidence reference backing a node, edge, or section.
CodebaseViewFile
File evidence row in a codebase view snapshot.
CodebaseViewNode
Graph-derived view node.
CodebaseViewRequest
Request for a graph-derived repository understanding view.
CodebaseViewSection
Narrative section derived from graph facts and evidence.
CodebaseViewSnapshot
Bounded raw graph rows used to derive codebase views.
CodebaseViewSymbol
Symbol evidence row in a codebase view snapshot.
CommitReceipt
Receipt returned after graph facts and mutation log entries commit.
ConfidenceScore
Confidence score in basis points so it remains sortable and exact.
ContextEntity
Entity projection retained with each context item.
ContextGraphFact
Structured relation, claim, or event that supports a retrieval hit.
ContextGraphPath
Direct graph path evidence derived from a structured graph fact.
ContextGraphPathEdge
One edge in a graph path returned through the context pack.
ContextPackItem
Context-pack item tied to a retrieval hit.
DirectoryRelation
Qualified relation target, such as codespec:design.
DomainError
Domain-level validation failure.
EventRecord
Event fact tied to entities and optional valid-time text.
EvidenceExtractionMetadata
Metadata shared by text, image, OCR, caption, table, layout, and embedding evidence.
EvidenceRecord
Evidence accepted by the graph mutation pipeline.
EvidenceSpan
Source byte and line span for evidence-backed facts.
ExtractionDiagnostic
Diagnostic emitted by an extractor without blocking other modalities.
FileContentChunk
Text chunk extracted from an authorized local file.
FileContentEntry
Content read-model record produced by a bounded scan.
FileContentReadModelCursor
Scoped derived cursor state for one file-content read-model input.
FileContentSearchHit
One file-content search hit with provenance and prompt-role isolation.
FileContentSearchRequest
Bounded file-content query.
FileIndexDiagnostics
Aggregated file-index diagnostics.
FileIndexEntry
Indexed file-location record produced by a bounded scan.
FileIndexRoot
Authorized root scanned by the local file indexer.
FileIndexRootStatus
Root-level status surfaced to health and service diagnostics.
FileIndexRootUpdate
Full-root replacement produced by one scan pass.
FileIndexScanSummary
Summary returned after one or more roots are indexed.
FileKnowledgeFactCandidate
Deterministic candidate fact extracted from file content.
FileSearchHit
One file-location search hit.
FileSearchRequest
Bounded file-location query.
FrameworkGraph
Framework graph rows returned from one repository scope.
FrameworkGraphRequest
Bounded framework graph query over one indexed repository scope.
FusionDiagnostics
Diagnostics for reciprocal-rank fusion.
GraphInspection
Aggregated graph status for diagnostics.
GraphMutationBatch
A transactional graph mutation unit.
GraphRelationRecord
Typed relation between graph entities.
GraphVersion
Monotonic graph state version.
GraphVersionRange
Graph-version validity range for facts.
HealthStorageSnapshot
Read-only storage view used by service health without mutating indexes.
IndexCursor
Scoped cursor for a derived index read model.
IndexLag
Per-kind lag included in diagnostics snapshots.
IndexRefreshDiagnostics
Queue, dead-letter, and stale-index diagnostics shared by APIs and storage.
IndexStalenessReason
Structured reason explaining why an index family or scoped cursor is stale.
IndexStatus
Versioned status for a derived index.
IndexedRepositoryDocument
Indexed, snapshot-bound text used to derive portable repository relationships.
KnowledgeEntity
A minimal entity model used by early graph-building code.
KnowledgeMap
Assembled inline map used by domain workflows and API responses.
KnowledgeMapChange
Optional source changes accepted by the update command.
KnowledgeMapHistoryEntry
Version history entry written after CLI mutations.
KnowledgeMapRoute
Ordered source route for a topic.
KnowledgeMapSource
Addressable knowledge source that remains authoritative outside the map.
KnowledgeMapTopic
Human-readable topic bucket used by agents for routing.
LayoutRegion
Page-space rectangle for table and layout evidence.
OntologyIdentity
Immutable ontology identity independent of a display label.
ProposalConflictRecord
Stored conflict associated with a proposal.
ProposalProvenance
Auditable model, prompt, and source lineage for a stored proposal.
ProposalRecord
Stored proposal ready for CLI/Web review.
RankingSignal
Per-retriever ranking signal preserved after fusion.
RepositoryCodeChunkRecord
Searchable code chunk.
RepositoryCodeFileRecord
File-level code index row.
RepositoryCodeRange
Inclusive byte or line range for repository code index rows.
RepositoryCodeReferenceRecord
Reference extracted from tree-sitter syntax and optionally resolved.
RepositoryCodeSymbolRecord
Symbol definition extracted from tree-sitter syntax.
RepositoryGraphEdge
RepositoryGraphNeighborhood
RepositoryGraphNeighborhoodRequest
Validated request for a bounded repository graph neighborhood.
RepositoryGraphNode
RepositoryMapDirectory
Strongly typed directory governance entry persisted in a repository map.
RepositoryMapDirectoryChange
Optional fields accepted by map directory update.
RerankDiagnostics
Diagnostics for post-fusion reranking.
RerankModeError
Invalid rerank backend mode supplied by runtime configuration.
RerankSignal
Final rerank signal applied after hybrid retrieval fusion.
RetrievalBackendStatus
Per-backend status preserved so callers can distinguish fallback from complete hybrid retrieval.
RetrievalBudgetUsed
Budget actually consumed by retrieval context packing.
RetrievalHit
A context item returned by retrieval.
RetrievedContextPack
A compact, auditable context pack for agent and UI adapters.
RouteHandlerRole
Single HTTP endpoint binding attached to a route-handler symbol.
ServiceDefinitionPlan
Service definition rendering without privileged execution.
ServiceLifecycleExecutionReport
Result of executing or dry-running a service lifecycle plan.
ServiceLifecycleStep
One staged service lifecycle action.
ServiceLifecycleStepResult
Execution result for a lifecycle step.
ServiceOperatorStatus
Persisted silent-update operator status.
ServicePackageManifestCheck
Package-manager release-manifest drift check described by the lifecycle plan.
ServicePermissionRequirement
Permission requirement attached to a generated service lifecycle plan.
SoftwareBuildTarget
Build target, script, profile, or generator entry projected from indexed repository evidence.
SoftwareBuildTargetInput
Constructor input for SoftwareBuildTarget.
SoftwareComponent
Projected dependency component from repository manifests and lockfiles.
SoftwareComponentInput
Constructor input for SoftwareComponent.
SoftwareDependencyUsage
Import/include evidence that uses a declared dependency component.
SoftwareDependencyUsageInput
Constructor input for SoftwareDependencyUsage.
SoftwareDesignElement
Design, architecture, module, component, interface, or capability evidence.
SoftwareDesignElementInput
Constructor input for SoftwareDesignElement.
SoftwareFile
Projected repository file node for the software global model.
SoftwareFileInput
Constructor input for SoftwareFile.
SoftwareGlobalProjection
Projected software global facts for one repository scope.
SoftwareGlobalRequest
Repository-scoped software global model query.
SoftwareGlobalStatus
Freshness and count summary for the software global projection.
SoftwareIacResource
Infrastructure, deployment, or service-operation resource projected from indexed IaC evidence.
SoftwareIacResourceInput
Constructor input for SoftwareIacResource.
SoftwareRelationship
Cross-domain relationship between projected software files, topics, components, and usages.
SoftwareRelationshipInput
Constructor input for SoftwareRelationship.
SoftwareSdkUsage
Projected SDK or external API usage from unresolved import/include evidence.
SoftwareSdkUsageInput
Constructor input for SoftwareSdkUsage.
SoftwareTopic
Topic extracted from repository documentation or the repository knowledge map.
SoftwareTopicInput
Constructor input for SoftwareTopic.
SourceScope
Authorized source boundary for evidence and retrieval.
SqliteStorageDiagnostics
SQLite-specific health data included in shared graph diagnostics.
StorageHealth
Storage health surfaced to diagnostics.
TraversalProvenanceTrace
Bounded explanation of the graph traversal and candidate path used for an answer.
TraversalRankingContribution
Per-source ranking contribution retained before final context truncation.
TraversalTraceEdge
Edge reached while building a retrieval context pack.
TraversalTraceEvidence
Evidence candidate reached during retrieval.
TraversalTraceNode
Node reached while building a retrieval context pack.
TraversalTraceRedaction
Authorization and budget redaction summary for a traversal trace.
WorkerStatus
Aggregated status for a worker family.
WorkerTaskRecord
Persistent worker task used by service, CLI, Web, and recovery diagnostics.

Enums§

AuditStatus
Persistent audit status shared by CLI/Web/service/agent surfaces.
BusinessAliasKind
BusinessKnowledgeQueryKind
Requested business projection slice.
BusinessKnowledgeResolution
Term-name resolution state for a business query.
BusinessMappingRelation
BusinessTermStatus
Lifecycle of one authored business term.
CodeGraphArtifactKind
Code artifact category returned through the general GraphRAG context pack.
CodeIndexMode
Code index mode tied to Git snapshots or diffs.
CodeIndexTaskState
Persistent lifecycle for background code repository index tasks.
CodeMonorepoWorkspaceFormat
Recognised monorepo workspace manifest formats.
CodeParseStatus
Parser status for a repository file at a graph version.
CodeQueryKind
Retrieval query kind for code graph and lexical search.
CodeReferenceKind
Reference category extracted from tree-sitter captures.
CodeRepositorySetRefreshTaskState
Durable state for a repository-set overlay refresh task.
CodeResolutionState
Resolution certainty for syntax-level code references.
CodeRetrievalLayer
Retrieval layer that contributed to a code hit.
CodeSymbolKind
Symbol definition category extracted from tree-sitter captures.
CodebaseViewKind
Deterministic repository understanding view kind.
ContextGraphFactKind
Structured graph fact kind referenced from a context item.
DirectoryLoadHint
When an agent should load content described by a directory entry.
DirectoryRelationKind
Supported typed relationship between governed directories.
DirectoryUpdateRule
How authored content in a governed directory is updated.
EvidenceModality
Evidence media unit tracked by multimodal ingestion and retrieval.
ExtractionStatus
Extraction outcome recorded when multimodal workers degrade or fail.
FactStatus
Lifecycle status for graph facts created from evidence or extraction.
FrameworkEdgeKind
Framework graph relationship category.
FrameworkKind
Supported frontend framework families.
FrameworkNodeKind
Framework graph node category.
FreshnessPolicy
Freshness policy for hybrid retrieval.
IndexKind
Derived index families maintained from the graph mutation log.
IndexModality
Source modality covered by a derived index cursor.
IndexState
Operational state of a derived index.
KnowledgeMapSourceKind
Supported source category labels in the YAML contract.
OntologyEntityKind
Typed ontology node identity. Untyped legacy graph entities keep their label-derived ids.
ProposalConflictSeverity
Conflict severity shown before manual approval.
ProposalKind
Proposal fact family stored before user approval.
ProposalState
Proposal approval lifecycle.
RepositoryMapType
Repository navigation map selected by relay-knowledge map --type.
RerankMode
Rerank backend requested for the hybrid retrieval candidate set.
RetrievalBackendState
Availability state for optional retrieval backends.
RetrievalMode
Retrieval path used to satisfy a query.
RetrieverSource
Retrieval source that contributed to a fused context result.
ServiceManagerAction
Service manager action surfaced as a generated, user-executed plan.
ServiceOperatorState
Installed background operator state.
SoftwareGlobalKind
Query kind for repository-scoped software global model facts.
StalenessHint
Per-file staleness hint attached to retrieval hits at query time.
SymbolRole
Role annotation for a symbol beyond its syntactic kind.
TechnicalTargetKind
TraversalTraceNodeKind
Stable node categories exposed in traversal provenance traces.
WorkerBackendState
Runtime availability of an external worker backend.
WorkerKind
External or fallback worker family used by background productization tasks.
WorkerTaskState
Persistent task lifecycle for bounded worker queues.

Constants§

BUSINESS_GLOSSARY_MAX_BYTES
BUSINESS_GLOSSARY_MAX_DOMAINS
BUSINESS_GLOSSARY_MAX_TERMS
BUSINESS_GLOSSARY_SCHEMA_VERSION
BUSINESS_TERM_MAX_ALIASES
BUSINESS_TERM_MAX_MAPPINGS
CODEGRAPH_CONTEXT_DEFAULT_LIMIT
CODEGRAPH_CONTEXT_DEFAULT_MAX_BYTES
CODEGRAPH_CONTEXT_MAX_BYTES
CODEGRAPH_CONTEXT_MAX_LIMIT
CODEGRAPH_CONTEXT_MIN_BYTES
RECIPROCAL_RANK_FUSION_K
RRF constant used by Phase 1 hybrid retrieval.
REPOSITORY_GRAPH_DEFAULT_EDGE_LIMIT
REPOSITORY_GRAPH_DEFAULT_NODE_LIMIT
REPOSITORY_GRAPH_MAX_DEPTH
REPOSITORY_GRAPH_MAX_EDGE_LIMIT
REPOSITORY_GRAPH_MAX_NODE_LIMIT

Functions§

clean_git_commit_from_snapshot_identity
Returns the clean Git commit carried by a persisted snapshot identity.
code_snapshot_scope_id
Builds the stable source scope id for a Git snapshot partition.
code_snapshot_scope_id_with_workspace_detection
Builds a scope identity that includes workspace-detection semantics when those semantics can add persisted workspace graph facts.
code_snapshot_scope_is_fact_versioned
code_snapshot_scope_matches_identity
Accepts every canonical supported workspace configuration while still rejecting scopes from older code-fact versions or unrelated identities.
code_snapshot_scope_workspace_semantic
Returns the workspace semantic encoded by a valid scope identity. Some(None) is the backward-compatible disabled identity; an enabled configuration, including mask zero, is Some(Some(mask)).
normalize_actor
Normalizes a required actor identifier for lifecycle decisions.
project_okf_neighborhood
Projects OKF v0.2 concepts from indexed Markdown without reading the live worktree.