Interface: AstmProfileProvenance

Provenance for an AstmProfile - the real, cited public artifact a profile's quirks are grounded in. A quirk is encoded only when a real (de-identified) document or a redistributable reference corpus grounds it; this record is where that grounding is stated, so a reviewer can trace every tolerated deviation back to evidence rather than invention.

Example

import type { AstmProfileProvenance } from "@cosyte/astm";
const prov: AstmProfileProvenance = {
  source: "kxepal/python-astm codec.py",
  reference: "https://github.com/kxepal/python-astm/blob/master/astm/codec.py",
  retrieved: "2026-07-21",
};

Properties

note?

readonly optional note?: string

Optional clarifying note about what in the source grounds the quirks.

---

reference

readonly reference: string

A citation the grounding can be traced to - a URL, DOI, or repo+path.

---

retrieved?

readonly optional retrieved?: string

When the grounding was last verified (ISO date) or the pinned commit SHA.

---

source

readonly source: string

Short human-readable name of the grounding source (corpus, transcript, or spec).