omnist-j 0.1.0-alpha API
Packages
Package
Description
The normative Schema Algebra: operations that reason about and transform an
OSD
Schema itself, rather than the documents it
describes — normalize, prune, extract, lint,
compatible_with, equivalent, is_empty, and structural
inference from sample documents (omnist-spec §6).The
omnist command-line interface: parses arguments and dispatches to
every subcommand (format, validate, convert,
schema normalize/prune/extract/lint/compatible-with/equivalent/is-empty,
infer) documented in docs/02-cli-reference.md, wiring the codec,
schema, and validation packages together into the tool end users run.Reading and writing the
Document model as the
non-OML wire formats — JSON, YAML, TOML, and XML (omnist-spec §7.3) — including
the lossy-adjustment reporting (WriteReport) that
records when a format's constraints force a value to be adjusted on write.The omnist-spec conformance test harness: runs Track 1 (CLI fixtures) and
Track 2 (JSON vectors) from the vendored spec fixtures against this
implementation's CLI, verifying it matches the spec's documented behavior
(omnist-spec §8.5).
Omnist document data model core package.
The lexer and parser for OML, Omnist's canonical text format (omnist-spec §4)
— the format every other codec's input is normalized through and every
omnist format output is written in.OSD (Omnist Schema Definition) modeling and I/O: the
Schema
type model — records, fields, scalar kinds — plus the lexer, parser, and writer
that read and write schemas in their canonical text form (omnist-spec §5).Validating and materializing documents against an OSD schema: checking a
Document conforms to a Schema
and reporting diagnostics when it doesn't (omnist-spec §3.6), and the
materialization pass that produces a schema-conformant document from one
that's structurally compatible but not yet exact (§6.3, §8.2).