Documentation
¶
Overview ¶
Package schema provides the type registry and frontmatter validation.
Index ¶
- Constants
- type Registry
- func (r *Registry) Aliases(canonical string) []string
- func (r *Registry) FieldNamesForLookup(canonical string) []string
- func (r *Registry) GetTypeDef(typeName string) (vault.TypeDef, bool)
- func (r *Registry) HasType(typeName string) bool
- func (r *Registry) IsAlias(canonical, candidate string) bool
- func (r *Registry) IsFieldAllowed(typeName, field string) bool
- func (r *Registry) IsFieldPresent(fm map[string]interface{}, canonical string) bool
- func (r *Registry) ListTypes() []string
- func (r *Registry) RequiredFields(typeName string) []string
- func (r *Registry) ValidStatus(typeName, status string) bool
- func (r *Registry) ValueShapeError(field string, value interface{}) string
Constants ¶
const CreatedDateFormat = "2006-01-02"
CreatedDateFormat is the canonical format for the `created` field — YYYY-MM-DD date-only UTC. Per manifesto principle 7 (SSOT), every write site for `created` MUST format with this constant:
- internal/template/process.go (init / scaffold default)
- internal/initvault/initvault.go (vault scaffold dates)
- internal/episode/render.go (SessionEnd capture: started_at date)
- internal/mutation/normalize.go (date-field canonicalization)
- internal/fix/fix.go (DefaultCreatedDateResolver: git/mtime/today)
`created` is a humanish "when was this born" stamp. Date-only matches both `git log --format=%as` (author short-date) and the conventional frontmatter date form, so YAML emits unquoted.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Registry ¶
type Registry struct {
// contains filtered or unexported fields
}
Registry holds the type definitions and provides validation methods.
func NewRegistry ¶
NewRegistry creates a Registry from config type definitions with no aliases.
func NewRegistryWithAliases ¶
NewRegistryWithAliases creates a Registry that recognizes per-vault frontmatter field aliases. Aliases let migrating users keep their existing field names (e.g. `last_updated`) while vaultmind validates against canonical names (e.g. `updated`). The map is canonical → list of aliases.
Aliasing is intentionally non-destructive: vaultmind never rewrites frontmatter to normalize field names. The alias and the canonical are equivalent at validation time only.
func (*Registry) Aliases ¶
Aliases returns the registered aliases for a canonical field name, or nil if the canonical name has no aliases.
func (*Registry) FieldNamesForLookup ¶
FieldNamesForLookup returns the canonical name first, followed by any registered aliases. Use this to resolve a field across alternative names when looking it up in stores that key by exact field name (e.g. the frontmatter_kv table) — try names in order, first non-empty wins.
Canonical-first ordering preserves the canonical-precedence contract: when both canonical and alias are present, the canonical value is used.
func (*Registry) GetTypeDef ¶
GetTypeDef returns the type definition for a given type name.
func (*Registry) IsAlias ¶
IsAlias reports whether candidate is registered as an alias for canonical. Returns false when candidate equals canonical — a field is not its own alias.
func (*Registry) IsFieldAllowed ¶
IsFieldAllowed checks if a field name is allowed for a type. Core fields and graph-tier fields are always allowed. Registered aliases for any allowed canonical are also allowed — without this, mutation (`frontmatter set last_updated=...`) would reject the user's existing field name even when the alias was explicitly registered. M1 from the 2026-05-02 review.
func (*Registry) IsFieldPresent ¶
IsFieldPresent reports whether the canonical field OR any of its registered aliases is present in fm with a non-empty value. This is the alias-aware variant of the package-private fmFieldPresent check used by validators — a single point that all required-field checks should call instead of inspecting fm directly.
func (*Registry) RequiredFields ¶
RequiredFields returns the union of fields that mutation must protect from unset: coreFields (id, type — gating classification) and the type's td.Required (the type's user-supplied contract).
NOT used by validators for the missing-required-field rule — validators iterate td.Required only. Used by mutation/validate.go's unset guard.
func (*Registry) ValidStatus ¶
ValidStatus checks if a status value is valid for a type. Types with no defined statuses accept any value.
func (*Registry) ValueShapeError ¶ added in v0.9.12
ValueShapeError says why value does not fit field, or returns "" when it fits. A field the schema does not shape (an extra, or a type-specific field) takes any value. An alias is checked as its canonical field.
Source Files