corpus

type Corpus struct {
	// contains filtered or unexported fields
}

type Document struct {
	// ID is the canonical identity (ADR 0001).
	ID identity.DocumentID
	// FrontMatter holds the document's parsed front matter.
	FrontMatter FrontMatter
	// Root is the synthetic root of the section tree (Level 0). May be nil for
	// a document with no headings.
	Root *Section
	// RawReferences are the outbound link edges extracted from the document,
	// before resolution.
	RawReferences []reference.RawReference
	// ModTime is the file's last-modified time.
	ModTime time.Time
	// FrontMatterPresent reports whether the source began with a frontmatter fence
	// block (`---`/`+++`) at all — independent of whether it parsed. It is pure
	// data set by the parser, used by the OKF conformance mode (ADR 0023) to tell
	// an ABSENT frontmatter block from a present-but-unparseable one. A document
	// whose oversized frontmatter was stripped by the size guard (ADR 0003) is
	// FrontMatterPresent=true, FrontMatterParsed=false.
	FrontMatterPresent bool
	// FrontMatterParsed reports whether a present frontmatter block decoded
	// successfully into FrontMatter. It is false when there was no block at all
	// (FrontMatterPresent=false), when the YAML/TOML failed to decode, or when the
	// oversized-frontmatter guard stripped the block before decoding. Pure data
	// set by the parser (ADR 0023).
	FrontMatterParsed bool
}

type DocumentID = identity.DocumentID

type FrontMatter struct {
	Title       string
	Description string
	Tags        []string
	Aliases     []string
	// Name is an alternate single-name alias for the document (common in note
	// systems). It is indexed into the AliasTable alongside Aliases so a wikilink
	// `[[name]]` resolves to this document (ADR 0001).
	Name    string
	Parent  string
	Related []string
	Status  string
	// Date is kept as a string in the skeleton; typed-date parsing is deferred.
	Date string
	// Extra holds front-matter keys not modeled above, preserved verbatim.
	Extra map[string]any
}

type Section struct {
	// Level is the heading level (1-6); the synthetic root uses 0.
	Level int
	// Text is the rendered heading text.
	Text string
	// Slug is the canonical anchor slug for the heading (ADR 0006).
	Slug string
	// Parent is the enclosing section, or nil for the root. It is a back-pointer
	// set once during single-goroutine construction (see the type note above).
	Parent *Section
	// Children are the directly nested sections, in document order.
	Children []*Section
	// Start and End are the byte offsets of the section's span in the source.
	Start int
	End   int
	// StartLine and EndLine are the 1-based source line span of the section
	// (heading line through the last line it encloses). Used to attribute a
	// reference (which carries a line number) to its containing section when
	// building the graph (ADR 0007). 0 means unset.
	StartLine int
	EndLine   int
}