@cosyte/synth 0.0.7 → 0.0.8

package/dist/hl7/index.d.cts

@@ -1,15 +1,15 @@
 import { Hl7Message, RawField } from '@cosyte/hl7';
-import { S as SyntheticName, a as SyntheticIdentifier, b as SyntheticAddress, R as Rng, C as Corpus } from '../providers-OLz3zAc-.cjs';
-import { Q as QuirkDescriptor, S as SynthProfile, a as QuirkArtifact, b as QuirkRoundTripResult } from '../quirk-DYMDojVw.cjs';
+import { S as SyntheticName, a as SyntheticIdentifier, b as SyntheticAddress, R as Rng, C as Corpus } from '../providers-B9uVinAe.cjs';
+import { Q as QuirkDescriptor, S as SynthProfile, a as QuirkArtifact, b as QuirkRoundTripResult } from '../quirk-IaHp4z7N.cjs';
 
 /**
  * Spec-clean HL7 v2 `ADT` generation, built **through `@cosyte/hl7`'s `buildMessage`** so MSH
- * delimiters, segment layout, and escaping are the parser's own conservative emit — spec-clean *by
+ * delimiters, segment layout, and escaping are the parser's own conservative emit: spec-clean *by
  * construction*. Every PHI-bearing field (name, DOB, SSN, MRN,
  * address, phone) is drawn from the synthetic-safety providers (`../safe`), so no value can be real.
  *
  * `ADT^A01/A04/A08` all require the `PID` (patient) + `PV1` (visit) groups the parser's structure net
- * checks for — so a generated message round-trips through `@cosyte/hl7` with **zero warnings**.
+ * checks for, so a generated message round-trips through `@cosyte/hl7` with **zero warnings**.
  *
  * @module
  */
@@ -18,7 +18,7 @@ import { Q as QuirkDescriptor, S as SynthProfile, a as QuirkArtifact, b as Quirk
 type AdtTrigger = "A01" | "A04" | "A08";
 /** Options for {@link generateAdt}. */
 interface GenerateAdtOptions {
-    /** The seed — the same seed yields a byte-identical message. Defaults to `0`. */
+    /** The seed: the same seed yields a byte-identical message. Defaults to `0`. */
     readonly seed?: number;
     /** The ADT trigger event. Defaults to `"A01"`. */
     readonly trigger?: AdtTrigger;
@@ -54,7 +54,7 @@ declare function generateAdt(options?: GenerateAdtOptions): Hl7Message;
 
 /** Options for {@link generateOru}. */
 interface GenerateOruOptions {
-    /** The seed — the same seed yields a byte-identical message. Defaults to `0`. */
+    /** The seed: the same seed yields a byte-identical message. Defaults to `0`. */
     readonly seed?: number;
 }
 /**
@@ -87,13 +87,13 @@ declare function generateOru(options?: GenerateOruOptions): Hl7Message;
 
 /** Options for {@link generateOrm}. */
 interface GenerateOrmOptions {
-    /** The seed — the same seed yields a byte-identical message. Defaults to `0`. */
+    /** The seed: the same seed yields a byte-identical message. Defaults to `0`. */
     readonly seed?: number;
 }
 /**
  * Generate a spec-clean `ORM^O01` {@link Hl7Message} through `@cosyte/hl7`. Deterministic in `seed`.
  *
- * Layout: MSH, `PID` (synthetic identity), `ORC` (common order — control `NW`, new order), and a
+ * Layout: MSH, `PID` (synthetic identity), `ORC` (common order, control `NW`, new order), and a
  * matching `OBR` (order detail). The `ORC` satisfies the parser's `ORM^O01` structure net, so the
  * message re-parses with **zero warnings** (proven by {@link ./round-trip}).
  *
@@ -119,13 +119,13 @@ declare function generateOrm(options?: GenerateOrmOptions): Hl7Message;
 
 /** Options for {@link generateSiu}. */
 interface GenerateSiuOptions {
-    /** The seed — the same seed yields a byte-identical message. Defaults to `0`. */
+    /** The seed: the same seed yields a byte-identical message. Defaults to `0`. */
     readonly seed?: number;
 }
 /**
  * Generate a spec-clean `SIU^S12` {@link Hl7Message} through `@cosyte/hl7`. Deterministic in `seed`.
  *
- * Layout: MSH, `SCH` (schedule activity — the required group), `PID` (synthetic identity), `RGS`
+ * Layout: MSH, `SCH` (schedule activity, the required group), `PID` (synthetic identity), `RGS`
  * (resource group), `AIL` (location resource). The `SCH` satisfies the parser's `SIU^S12` structure
  * net, so the message re-parses with **zero warnings** (proven by {@link ./round-trip}).
  *
@@ -152,13 +152,13 @@ declare function generateSiu(options?: GenerateSiuOptions): Hl7Message;
 
 /** Options for {@link generateVxu}. */
 interface GenerateVxuOptions {
-    /** The seed — the same seed yields a byte-identical message. Defaults to `0`. */
+    /** The seed: the same seed yields a byte-identical message. Defaults to `0`. */
     readonly seed?: number;
 }
 /**
  * Generate a spec-clean `VXU^V04` {@link Hl7Message} through `@cosyte/hl7`. Deterministic in `seed`.
  *
- * Layout: MSH, `PID` (synthetic identity — the required group), `ORC` (common order), `RXA` (vaccine
+ * Layout: MSH, `PID` (synthetic identity, the required group), `ORC` (common order), `RXA` (vaccine
  * administration, CVX example code), `RXR` (route). The `PID` satisfies the parser's `VXU^V04`
  * structure net, so the message re-parses with **zero warnings** (proven by {@link ./round-trip}).
  *
@@ -174,9 +174,9 @@ interface GenerateVxuOptions {
 declare function generateVxu(options?: GenerateVxuOptions): Hl7Message;
 
 /**
- * The **round-trip-through-the-parser harness** — the headline gate for the synthetic-fixture
- * generator. A generated artifact is "spec-clean" only if `@cosyte/hl7` — not
- * `@cosyte/synth`'s own opinion — reads it back cleanly. This harness feeds a generated message
+ * The **round-trip-through-the-parser harness**: the headline gate for the synthetic-fixture
+ * generator. A generated artifact is "spec-clean" only if `@cosyte/hl7`, not
+ * `@cosyte/synth`'s own opinion, reads it back cleanly. This harness feeds a generated message
  * straight back into the parser and reports what the parser found, so a false "spec-clean" claim
  * cannot hide.
  *
@@ -213,7 +213,7 @@ declare function roundTrip(message: Hl7Message): RoundTripResult;
  * Thin helpers that build `@cosyte/hl7` `RawField` objects with **components** for `addSegment`.
  *
  * Why this exists: `Hl7Message.addSegment` accepts a field as either a plain string or a structured
- * `RawField`. A plain string is emitted **verbatim** — a literal `^` in it is escaped to `\S\`, not
+ * `RawField`. A plain string is emitted **verbatim**: a literal `^` in it is escaped to `\S\`, not
  * treated as a component separator (the parser re-escapes on serialize, by design). To place true
  * components (a name's family/given, a CX's id/authority/type) we must hand `addSegment` a `RawField`
  * with explicit `components`, so the parser's own conservative serializer lays out the separators.
@@ -237,11 +237,11 @@ declare function roundTrip(message: Hl7Message): RoundTripResult;
 declare function componentsField(components: readonly string[]): RawField;
 
 /**
- * Shared HL7 v2 building blocks for every message family `@cosyte/synth` generates — the MSH scaffold,
+ * Shared HL7 v2 building blocks for every message family `@cosyte/synth` generates: the MSH scaffold,
  * the seeded timestamp, and the patient-identity bundle + its `PID` segment. Factored out so `ADT`,
  * `ORU`, `ORM`, `SIU`, and `VXU` all mint identity from the **same** synthetic-safety providers in the
  * **same** draw order, and all emit through `@cosyte/hl7`'s conservative serializer. Nothing here draws a
- * value that is not sourced from `../safe` — the synthetic-by-construction
+ * value that is not sourced from `../safe`: the synthetic-by-construction
  * invariant holds by construction for every family.
  *
  * @module
@@ -262,7 +262,7 @@ declare function componentsField(components: readonly string[]): RawField;
 declare function seededTimestamp(rng: Rng): string;
 /** The MSH scaffold shared by every generated message: the built message plus its seeded MSH values. */
 interface MessageScaffold {
-    /** The `Hl7Message` with a complete MSH — chain `.addSegment(...)` to append the payload. */
+    /** The `Hl7Message` with a complete MSH: chain `.addSegment(...)` to append the payload. */
     readonly message: Hl7Message;
     /** The seeded `YYYYMMDDHHMMSS` message timestamp (MSH-7), reused for event/observation times. */
     readonly timestamp: string;
@@ -272,7 +272,7 @@ interface MessageScaffold {
 /**
  * Build the MSH scaffold for a message of the given `MSH-9` type through `@cosyte/hl7`'s `buildMessage`,
  * so the delimiters, control id, and header layout are the parser's own conservative emit. Draws the
- * timestamp then the control id from `rng` (a fixed order — the reproducibility contract).
+ * timestamp then the control id from `rng` (a fixed order: the reproducibility contract).
  *
  * @param rng - The seeded generator.
  * @param type - The `MSH-9` message type, e.g. `"ORU^R01"`.
@@ -284,7 +284,7 @@ interface MessageScaffold {
  * ```
  */
 declare function mshScaffold(rng: Rng, type: string): MessageScaffold;
-/** A complete synthetic patient identity — every field drawn from `../safe`. */
+/** A complete synthetic patient identity: every field drawn from `../safe`. */
 interface PatientIdentity {
     /** Name from the shipped fake-name pool. */
     readonly person: SyntheticName;
@@ -302,8 +302,8 @@ interface PatientIdentity {
     readonly ssnDigits: string;
 }
 /**
- * Mint a complete synthetic {@link PatientIdentity}. Every value comes from a synthetic-safety provider
- * — no code path here can return a real or plausibly-real identifier. The draw order is
+ * Mint a complete synthetic {@link PatientIdentity}. Every value comes from a synthetic-safety provider,
+ * so no code path here can return a real or plausibly-real identifier. The draw order is
  * fixed (name → MRN → DOB → sex → address → phone → SSN) so the same seed yields the same identity.
  *
  * @param rng - The seeded generator.
@@ -316,7 +316,7 @@ interface PatientIdentity {
  */
 declare function patientIdentity(rng: Rng): PatientIdentity;
 /**
- * Lay out a fully-populated `PID` segment from a {@link PatientIdentity} as `addSegment` fields — the
+ * Lay out a fully-populated `PID` segment from a {@link PatientIdentity} as `addSegment` fields: the
  * PHI-dense segment shared by every family. Components go through {@link componentsField} so the parser
  * lays out the `^` separators (building *through* the parser).
  *
@@ -332,12 +332,12 @@ declare function pidSegment(id: PatientIdentity): readonly (string | RawField)[]
 /**
  * A tiny, curated, **license-clean** pool of example codes used to fill coded fields in generated HL7
  * messages (`OBR`/`OBX` observations, `ORC`/`OBR` orders, `RXA` vaccines). These are **public code
- * facts** — the spec examples' own values — not copyrighted terminology tables: `@cosyte/synth` bundles
+ * facts** (the spec examples' own values), not copyrighted terminology tables: `@cosyte/synth` bundles
  * **no** SNOMED/CPT/LOINC/RxNorm content. The pool exists only so a generated message is *structurally*
  * realistic; a consumer who
  * needs their own codes supplies them.
  *
- * Nothing here is PHI — codes and their display text are not identifiers. The synthetic-safety
+ * Nothing here is PHI: codes and their display text are not identifiers. The synthetic-safety
  * invariant governs identity fields (name/DOB/SSN/MRN/phone/address), which come from `../safe`.
  *
  * @module
@@ -372,20 +372,20 @@ declare const EXAMPLE_VACCINES: readonly ExampleCode[];
 /**
  * HL7 v2 **vendor-quirk generation**. A quirk deviates the
  * *structure* of an otherwise spec-clean message so it round-trips through `@cosyte/hl7` to **exactly**
- * one intended, stable warning code — the tolerance a `defineProfile` profile encodes. The deviation is
+ * one intended, stable warning code: the tolerance a `defineProfile` profile encodes. The deviation is
  * applied **post-serialize**.
  *
  * Two publicly-groundable quirks ship (cited-public, never a private vendor corpus):
  *
  * - **`unknown-zsegment`** → `UNKNOWN_SEGMENT`. HL7 v2.x §2.5 permits site-defined `Z`-segments; a
  *   receiver with no profile flags them. `@cosyte/hl7`'s public imaging/PACS profiles (`visage`,
- *   `philips`, `va` — each grounded in a downloadable vendor/federal interface spec) declare `ZDS`, so a
+ *   `philips`, `va`: each grounded in a downloadable vendor/federal interface spec) declare `ZDS`, so a
  *   `defineProfile` that claims the segment **suppresses** the warning.
- * - **`unknown-escape`** → `UNKNOWN_ESCAPE_SEQUENCE`. HL7 v2.x §2.7 escaping — a locally-defined
+ * - **`unknown-escape`** → `UNKNOWN_ESCAPE_SEQUENCE`. HL7 v2.x §2.7 escaping: a locally-defined
  *   `\Z..\` escape is preserved verbatim and flagged. HL7 v2 has no re-badge mechanism, so this is a
  *   `"bare"` quirk (no built-in profile downgrades it).
  *
- * A quirk **never** introduces a real-looking value — it changes the message *shape*, never the
+ * A quirk **never** introduces a real-looking value: it changes the message *shape*, never the
  * *provenance* of the data, so the synthetic-safety gate still runs and stays zero.
  *
  * @module
@@ -396,13 +396,13 @@ type Hl7QuirkName = "unknown-zsegment" | "unknown-escape";
 /** The HL7 v2 message families a quirk can be injected into (the spec-clean base). */
 type Hl7QuirkKind = "ADT^A01" | "ADT^A04" | "ADT^A08" | "ORU^R01" | "ORM^O01" | "SIU^S12" | "VXU^V04";
 /**
- * The HL7 v2 quirk registry — each recipe bound to the exact `@cosyte/hl7` warning code it targets and
+ * The HL7 v2 quirk registry: each recipe bound to the exact `@cosyte/hl7` warning code it targets and
  * its public grounding.
  */
 declare const HL7_QUIRKS: Readonly<Record<Hl7QuirkName, QuirkDescriptor>>;
 /** Options for {@link generateHl7Quirk}. */
 interface GenerateHl7QuirkOptions {
-    /** The seed — the same seed + quirk yields a byte-identical message. Defaults to `0`. */
+    /** The seed: the same seed + quirk yields a byte-identical message. Defaults to `0`. */
     readonly seed?: number;
     /** The quirk to inject. Required. */
     readonly quirk: Hl7QuirkName;
@@ -414,20 +414,20 @@ interface GenerateHl7QuirkOptions {
  * requested vendor deviation injected post-serialize. Deterministic in `seed` + `quirk` + `kind`.
  *
  * @param options - Seed, quirk, and base kind. See {@link GenerateHl7QuirkOptions}.
- * @returns The {@link QuirkArtifact} — its `content` round-trips to `intendedWarnings` exactly.
+ * @returns The {@link QuirkArtifact}: its `content` round-trips to `intendedWarnings` exactly.
  * @throws SynthError `SYNTH_UNSUPPORTED_QUIRK` if `quirk` is not a supported HL7 quirk.
  * @example
  * ```ts
  * import { generateHl7Quirk, hl7QuirkRoundTrip } from "@cosyte/synth/hl7";
  * const artifact = generateHl7Quirk({ seed: 1, quirk: "unknown-zsegment" });
- * hl7QuirkRoundTrip(artifact).intendedWarningHeld; // true — exactly UNKNOWN_SEGMENT
+ * hl7QuirkRoundTrip(artifact).intendedWarningHeld; // true, exactly UNKNOWN_SEGMENT
  * ```
  */
 declare function generateHl7Quirk(options: GenerateHl7QuirkOptions): QuirkArtifact;
 /**
  * Round-trip an HL7 v2 quirk artifact through `@cosyte/hl7` and report the intended-warning verdict: a bare
- * parse must produce **exactly** the intended code(s), and — when a built-in public
- * profile tolerates the quirk — the profiled parse must suppress it.
+ * parse must produce **exactly** the intended code(s), and, when a built-in public
+ * profile tolerates the quirk, the profiled parse must suppress it.
  *
  * @param artifact - The quirk artifact (from {@link generateHl7Quirk}).
  * @returns The {@link QuirkRoundTripResult}.
@@ -435,7 +435,7 @@ declare function generateHl7Quirk(options: GenerateHl7QuirkOptions): QuirkArtifa
  * ```ts
  * import { generateHl7Quirk, hl7QuirkRoundTrip } from "@cosyte/synth/hl7";
  * const rt = hl7QuirkRoundTrip(generateHl7Quirk({ seed: 1, quirk: "unknown-zsegment" }));
- * rt.withProfile?.tolerated; // true — the `visage` profile suppresses UNKNOWN_SEGMENT
+ * rt.withProfile?.tolerated; // true, the `visage` profile suppresses UNKNOWN_SEGMENT
  * ```
  */
 declare function hl7QuirkRoundTrip(artifact: QuirkArtifact): QuirkRoundTripResult;
@@ -454,8 +454,8 @@ interface Hl7QuirkCorpusOptions {
 }
 /**
  * Build a reproducible {@link Corpus} of HL7 v2 quirk artifacts. Each artifact's `warnings` record the
- * parser's verdict — the intended code(s) for its quirk (not empty: a quirk corpus is deliberately
- * off-spec) — and the manifest lists the applied quirk names.
+ * parser's verdict: the intended code(s) for its quirk (not empty: a quirk corpus is deliberately
+ * off-spec), and the manifest lists the applied quirk names.
  *
  * @param options - Seed, count, and the quirk selection. See {@link Hl7QuirkCorpusOptions}.
  * @returns A deep-frozen {@link Corpus}.
@@ -468,7 +468,7 @@ interface Hl7QuirkCorpusOptions {
  */
 declare function hl7QuirkCorpus(options: Hl7QuirkCorpusOptions): Corpus;
 /**
- * A ready-made {@link SynthProfile} that requests every built-in HL7 quirk — a convenience for wiring
+ * A ready-made {@link SynthProfile} that requests every built-in HL7 quirk: a convenience for wiring
  * `defineSynthProfile`'s quirk list to the parser's real tolerance.
  *
  * @example
@@ -480,20 +480,20 @@ declare function hl7QuirkCorpus(options: Hl7QuirkCorpusOptions): Corpus;
 declare const hl7QuirkProfile: SynthProfile;
 
 /**
- * `@cosyte/synth/hl7` — the HL7 v2 generation surface, exposed as its own subpath so importing the
+ * `@cosyte/synth/hl7`: the HL7 v2 generation surface, exposed as its own subpath so importing the
  * package root does **not** pull `@cosyte/hl7`. This is the **lazy, per-format** boundary: a consumer
  * who only needs HL7 fixtures imports `@cosyte/synth/hl7`; one who needs only the core primitives
  * never loads a parser.
- * `@cosyte/hl7` is an **optional peer dependency** — present only for this subpath.
+ * `@cosyte/hl7` is an **optional peer dependency**, present only for this subpath.
  *
  * The HL7 v2 message set is complete: `ADT` (A01/A04/A08), `ORU^R01`, `ORM^O01`, `SIU^S12`, and
- * `VXU^V04` — each built through `@cosyte/hl7`'s `buildMessage` and round-tripping with zero warnings.
+ * `VXU^V04`, each built through `@cosyte/hl7`'s `buildMessage` and round-tripping with zero warnings.
  *
  * @module
  */
 
 /**
- * Every HL7 v2 message kind this subpath generates — the `MSH-9` label used as the corpus `kind`. `ADT`
+ * Every HL7 v2 message kind this subpath generates: the `MSH-9` label used as the corpus `kind`. `ADT`
  * carries its trigger; the other families have a single generated trigger each.
  */
 type Hl7MessageKind = "ADT^A01" | "ADT^A04" | "ADT^A08" | "ORU^R01" | "ORM^O01" | "SIU^S12" | "VXU^V04";
@@ -540,7 +540,7 @@ interface Hl7CorpusOptions {
  * ```ts
  * import { hl7Corpus } from "@cosyte/synth/hl7";
  * const corpus = hl7Corpus({ seed: 42, count: 7 });
- * corpus.artifacts.every((a) => a.warnings.length === 0); // true — spec-clean
+ * corpus.artifacts.every((a) => a.warnings.length === 0); // true, spec-clean
  * ```
  */
 declare function hl7Corpus(options: Hl7CorpusOptions): Corpus;

package/dist/hl7/index.d.ts

@@ -1,15 +1,15 @@
 import { Hl7Message, RawField } from '@cosyte/hl7';
-import { S as SyntheticName, a as SyntheticIdentifier, b as SyntheticAddress, R as Rng, C as Corpus } from '../providers-OLz3zAc-.js';
-import { Q as QuirkDescriptor, S as SynthProfile, a as QuirkArtifact, b as QuirkRoundTripResult } from '../quirk-C9t9CkPS.js';
+import { S as SyntheticName, a as SyntheticIdentifier, b as SyntheticAddress, R as Rng, C as Corpus } from '../providers-B9uVinAe.js';
+import { Q as QuirkDescriptor, S as SynthProfile, a as QuirkArtifact, b as QuirkRoundTripResult } from '../quirk-HZdznAkM.js';
 
 /**
  * Spec-clean HL7 v2 `ADT` generation, built **through `@cosyte/hl7`'s `buildMessage`** so MSH
- * delimiters, segment layout, and escaping are the parser's own conservative emit — spec-clean *by
+ * delimiters, segment layout, and escaping are the parser's own conservative emit: spec-clean *by
  * construction*. Every PHI-bearing field (name, DOB, SSN, MRN,
  * address, phone) is drawn from the synthetic-safety providers (`../safe`), so no value can be real.
  *
  * `ADT^A01/A04/A08` all require the `PID` (patient) + `PV1` (visit) groups the parser's structure net
- * checks for — so a generated message round-trips through `@cosyte/hl7` with **zero warnings**.
+ * checks for, so a generated message round-trips through `@cosyte/hl7` with **zero warnings**.
  *
  * @module
  */
@@ -18,7 +18,7 @@ import { Q as QuirkDescriptor, S as SynthProfile, a as QuirkArtifact, b as Quirk
 type AdtTrigger = "A01" | "A04" | "A08";
 /** Options for {@link generateAdt}. */
 interface GenerateAdtOptions {
-    /** The seed — the same seed yields a byte-identical message. Defaults to `0`. */
+    /** The seed: the same seed yields a byte-identical message. Defaults to `0`. */
     readonly seed?: number;
     /** The ADT trigger event. Defaults to `"A01"`. */
     readonly trigger?: AdtTrigger;
@@ -54,7 +54,7 @@ declare function generateAdt(options?: GenerateAdtOptions): Hl7Message;
 
 /** Options for {@link generateOru}. */
 interface GenerateOruOptions {
-    /** The seed — the same seed yields a byte-identical message. Defaults to `0`. */
+    /** The seed: the same seed yields a byte-identical message. Defaults to `0`. */
     readonly seed?: number;
 }
 /**
@@ -87,13 +87,13 @@ declare function generateOru(options?: GenerateOruOptions): Hl7Message;
 
 /** Options for {@link generateOrm}. */
 interface GenerateOrmOptions {
-    /** The seed — the same seed yields a byte-identical message. Defaults to `0`. */
+    /** The seed: the same seed yields a byte-identical message. Defaults to `0`. */
     readonly seed?: number;
 }
 /**
  * Generate a spec-clean `ORM^O01` {@link Hl7Message} through `@cosyte/hl7`. Deterministic in `seed`.
  *
- * Layout: MSH, `PID` (synthetic identity), `ORC` (common order — control `NW`, new order), and a
+ * Layout: MSH, `PID` (synthetic identity), `ORC` (common order, control `NW`, new order), and a
  * matching `OBR` (order detail). The `ORC` satisfies the parser's `ORM^O01` structure net, so the
  * message re-parses with **zero warnings** (proven by {@link ./round-trip}).
  *
@@ -119,13 +119,13 @@ declare function generateOrm(options?: GenerateOrmOptions): Hl7Message;
 
 /** Options for {@link generateSiu}. */
 interface GenerateSiuOptions {
-    /** The seed — the same seed yields a byte-identical message. Defaults to `0`. */
+    /** The seed: the same seed yields a byte-identical message. Defaults to `0`. */
     readonly seed?: number;
 }
 /**
  * Generate a spec-clean `SIU^S12` {@link Hl7Message} through `@cosyte/hl7`. Deterministic in `seed`.
  *
- * Layout: MSH, `SCH` (schedule activity — the required group), `PID` (synthetic identity), `RGS`
+ * Layout: MSH, `SCH` (schedule activity, the required group), `PID` (synthetic identity), `RGS`
  * (resource group), `AIL` (location resource). The `SCH` satisfies the parser's `SIU^S12` structure
  * net, so the message re-parses with **zero warnings** (proven by {@link ./round-trip}).
  *
@@ -152,13 +152,13 @@ declare function generateSiu(options?: GenerateSiuOptions): Hl7Message;
 
 /** Options for {@link generateVxu}. */
 interface GenerateVxuOptions {
-    /** The seed — the same seed yields a byte-identical message. Defaults to `0`. */
+    /** The seed: the same seed yields a byte-identical message. Defaults to `0`. */
     readonly seed?: number;
 }
 /**
  * Generate a spec-clean `VXU^V04` {@link Hl7Message} through `@cosyte/hl7`. Deterministic in `seed`.
  *
- * Layout: MSH, `PID` (synthetic identity — the required group), `ORC` (common order), `RXA` (vaccine
+ * Layout: MSH, `PID` (synthetic identity, the required group), `ORC` (common order), `RXA` (vaccine
  * administration, CVX example code), `RXR` (route). The `PID` satisfies the parser's `VXU^V04`
  * structure net, so the message re-parses with **zero warnings** (proven by {@link ./round-trip}).
  *
@@ -174,9 +174,9 @@ interface GenerateVxuOptions {
 declare function generateVxu(options?: GenerateVxuOptions): Hl7Message;
 
 /**
- * The **round-trip-through-the-parser harness** — the headline gate for the synthetic-fixture
- * generator. A generated artifact is "spec-clean" only if `@cosyte/hl7` — not
- * `@cosyte/synth`'s own opinion — reads it back cleanly. This harness feeds a generated message
+ * The **round-trip-through-the-parser harness**: the headline gate for the synthetic-fixture
+ * generator. A generated artifact is "spec-clean" only if `@cosyte/hl7`, not
+ * `@cosyte/synth`'s own opinion, reads it back cleanly. This harness feeds a generated message
  * straight back into the parser and reports what the parser found, so a false "spec-clean" claim
  * cannot hide.
  *
@@ -213,7 +213,7 @@ declare function roundTrip(message: Hl7Message): RoundTripResult;
  * Thin helpers that build `@cosyte/hl7` `RawField` objects with **components** for `addSegment`.
  *
  * Why this exists: `Hl7Message.addSegment` accepts a field as either a plain string or a structured
- * `RawField`. A plain string is emitted **verbatim** — a literal `^` in it is escaped to `\S\`, not
+ * `RawField`. A plain string is emitted **verbatim**: a literal `^` in it is escaped to `\S\`, not
  * treated as a component separator (the parser re-escapes on serialize, by design). To place true
  * components (a name's family/given, a CX's id/authority/type) we must hand `addSegment` a `RawField`
  * with explicit `components`, so the parser's own conservative serializer lays out the separators.
@@ -237,11 +237,11 @@ declare function roundTrip(message: Hl7Message): RoundTripResult;
 declare function componentsField(components: readonly string[]): RawField;
 
 /**
- * Shared HL7 v2 building blocks for every message family `@cosyte/synth` generates — the MSH scaffold,
+ * Shared HL7 v2 building blocks for every message family `@cosyte/synth` generates: the MSH scaffold,
  * the seeded timestamp, and the patient-identity bundle + its `PID` segment. Factored out so `ADT`,
  * `ORU`, `ORM`, `SIU`, and `VXU` all mint identity from the **same** synthetic-safety providers in the
  * **same** draw order, and all emit through `@cosyte/hl7`'s conservative serializer. Nothing here draws a
- * value that is not sourced from `../safe` — the synthetic-by-construction
+ * value that is not sourced from `../safe`: the synthetic-by-construction
  * invariant holds by construction for every family.
  *
  * @module
@@ -262,7 +262,7 @@ declare function componentsField(components: readonly string[]): RawField;
 declare function seededTimestamp(rng: Rng): string;
 /** The MSH scaffold shared by every generated message: the built message plus its seeded MSH values. */
 interface MessageScaffold {
-    /** The `Hl7Message` with a complete MSH — chain `.addSegment(...)` to append the payload. */
+    /** The `Hl7Message` with a complete MSH: chain `.addSegment(...)` to append the payload. */
     readonly message: Hl7Message;
     /** The seeded `YYYYMMDDHHMMSS` message timestamp (MSH-7), reused for event/observation times. */
     readonly timestamp: string;
@@ -272,7 +272,7 @@ interface MessageScaffold {
 /**
  * Build the MSH scaffold for a message of the given `MSH-9` type through `@cosyte/hl7`'s `buildMessage`,
  * so the delimiters, control id, and header layout are the parser's own conservative emit. Draws the
- * timestamp then the control id from `rng` (a fixed order — the reproducibility contract).
+ * timestamp then the control id from `rng` (a fixed order: the reproducibility contract).
  *
  * @param rng - The seeded generator.
  * @param type - The `MSH-9` message type, e.g. `"ORU^R01"`.
@@ -284,7 +284,7 @@ interface MessageScaffold {
  * ```
  */
 declare function mshScaffold(rng: Rng, type: string): MessageScaffold;
-/** A complete synthetic patient identity — every field drawn from `../safe`. */
+/** A complete synthetic patient identity: every field drawn from `../safe`. */
 interface PatientIdentity {
     /** Name from the shipped fake-name pool. */
     readonly person: SyntheticName;
@@ -302,8 +302,8 @@ interface PatientIdentity {
     readonly ssnDigits: string;
 }
 /**
- * Mint a complete synthetic {@link PatientIdentity}. Every value comes from a synthetic-safety provider
- * — no code path here can return a real or plausibly-real identifier. The draw order is
+ * Mint a complete synthetic {@link PatientIdentity}. Every value comes from a synthetic-safety provider,
+ * so no code path here can return a real or plausibly-real identifier. The draw order is
  * fixed (name → MRN → DOB → sex → address → phone → SSN) so the same seed yields the same identity.
  *
  * @param rng - The seeded generator.
@@ -316,7 +316,7 @@ interface PatientIdentity {
  */
 declare function patientIdentity(rng: Rng): PatientIdentity;
 /**
- * Lay out a fully-populated `PID` segment from a {@link PatientIdentity} as `addSegment` fields — the
+ * Lay out a fully-populated `PID` segment from a {@link PatientIdentity} as `addSegment` fields: the
  * PHI-dense segment shared by every family. Components go through {@link componentsField} so the parser
  * lays out the `^` separators (building *through* the parser).
  *
@@ -332,12 +332,12 @@ declare function pidSegment(id: PatientIdentity): readonly (string | RawField)[]
 /**
  * A tiny, curated, **license-clean** pool of example codes used to fill coded fields in generated HL7
  * messages (`OBR`/`OBX` observations, `ORC`/`OBR` orders, `RXA` vaccines). These are **public code
- * facts** — the spec examples' own values — not copyrighted terminology tables: `@cosyte/synth` bundles
+ * facts** (the spec examples' own values), not copyrighted terminology tables: `@cosyte/synth` bundles
  * **no** SNOMED/CPT/LOINC/RxNorm content. The pool exists only so a generated message is *structurally*
  * realistic; a consumer who
  * needs their own codes supplies them.
  *
- * Nothing here is PHI — codes and their display text are not identifiers. The synthetic-safety
+ * Nothing here is PHI: codes and their display text are not identifiers. The synthetic-safety
  * invariant governs identity fields (name/DOB/SSN/MRN/phone/address), which come from `../safe`.
  *
  * @module
@@ -372,20 +372,20 @@ declare const EXAMPLE_VACCINES: readonly ExampleCode[];
 /**
  * HL7 v2 **vendor-quirk generation**. A quirk deviates the
  * *structure* of an otherwise spec-clean message so it round-trips through `@cosyte/hl7` to **exactly**
- * one intended, stable warning code — the tolerance a `defineProfile` profile encodes. The deviation is
+ * one intended, stable warning code: the tolerance a `defineProfile` profile encodes. The deviation is
  * applied **post-serialize**.
  *
  * Two publicly-groundable quirks ship (cited-public, never a private vendor corpus):
  *
  * - **`unknown-zsegment`** → `UNKNOWN_SEGMENT`. HL7 v2.x §2.5 permits site-defined `Z`-segments; a
  *   receiver with no profile flags them. `@cosyte/hl7`'s public imaging/PACS profiles (`visage`,
- *   `philips`, `va` — each grounded in a downloadable vendor/federal interface spec) declare `ZDS`, so a
+ *   `philips`, `va`: each grounded in a downloadable vendor/federal interface spec) declare `ZDS`, so a
  *   `defineProfile` that claims the segment **suppresses** the warning.
- * - **`unknown-escape`** → `UNKNOWN_ESCAPE_SEQUENCE`. HL7 v2.x §2.7 escaping — a locally-defined
+ * - **`unknown-escape`** → `UNKNOWN_ESCAPE_SEQUENCE`. HL7 v2.x §2.7 escaping: a locally-defined
  *   `\Z..\` escape is preserved verbatim and flagged. HL7 v2 has no re-badge mechanism, so this is a
  *   `"bare"` quirk (no built-in profile downgrades it).
  *
- * A quirk **never** introduces a real-looking value — it changes the message *shape*, never the
+ * A quirk **never** introduces a real-looking value: it changes the message *shape*, never the
  * *provenance* of the data, so the synthetic-safety gate still runs and stays zero.
  *
  * @module
@@ -396,13 +396,13 @@ type Hl7QuirkName = "unknown-zsegment" | "unknown-escape";
 /** The HL7 v2 message families a quirk can be injected into (the spec-clean base). */
 type Hl7QuirkKind = "ADT^A01" | "ADT^A04" | "ADT^A08" | "ORU^R01" | "ORM^O01" | "SIU^S12" | "VXU^V04";
 /**
- * The HL7 v2 quirk registry — each recipe bound to the exact `@cosyte/hl7` warning code it targets and
+ * The HL7 v2 quirk registry: each recipe bound to the exact `@cosyte/hl7` warning code it targets and
  * its public grounding.
  */
 declare const HL7_QUIRKS: Readonly<Record<Hl7QuirkName, QuirkDescriptor>>;
 /** Options for {@link generateHl7Quirk}. */
 interface GenerateHl7QuirkOptions {
-    /** The seed — the same seed + quirk yields a byte-identical message. Defaults to `0`. */
+    /** The seed: the same seed + quirk yields a byte-identical message. Defaults to `0`. */
     readonly seed?: number;
     /** The quirk to inject. Required. */
     readonly quirk: Hl7QuirkName;
@@ -414,20 +414,20 @@ interface GenerateHl7QuirkOptions {
  * requested vendor deviation injected post-serialize. Deterministic in `seed` + `quirk` + `kind`.
  *
  * @param options - Seed, quirk, and base kind. See {@link GenerateHl7QuirkOptions}.
- * @returns The {@link QuirkArtifact} — its `content` round-trips to `intendedWarnings` exactly.
+ * @returns The {@link QuirkArtifact}: its `content` round-trips to `intendedWarnings` exactly.
  * @throws SynthError `SYNTH_UNSUPPORTED_QUIRK` if `quirk` is not a supported HL7 quirk.
  * @example
  * ```ts
  * import { generateHl7Quirk, hl7QuirkRoundTrip } from "@cosyte/synth/hl7";
  * const artifact = generateHl7Quirk({ seed: 1, quirk: "unknown-zsegment" });
- * hl7QuirkRoundTrip(artifact).intendedWarningHeld; // true — exactly UNKNOWN_SEGMENT
+ * hl7QuirkRoundTrip(artifact).intendedWarningHeld; // true, exactly UNKNOWN_SEGMENT
  * ```
  */
 declare function generateHl7Quirk(options: GenerateHl7QuirkOptions): QuirkArtifact;
 /**
  * Round-trip an HL7 v2 quirk artifact through `@cosyte/hl7` and report the intended-warning verdict: a bare
- * parse must produce **exactly** the intended code(s), and — when a built-in public
- * profile tolerates the quirk — the profiled parse must suppress it.
+ * parse must produce **exactly** the intended code(s), and, when a built-in public
+ * profile tolerates the quirk, the profiled parse must suppress it.
  *
  * @param artifact - The quirk artifact (from {@link generateHl7Quirk}).
  * @returns The {@link QuirkRoundTripResult}.
@@ -435,7 +435,7 @@ declare function generateHl7Quirk(options: GenerateHl7QuirkOptions): QuirkArtifa
  * ```ts
  * import { generateHl7Quirk, hl7QuirkRoundTrip } from "@cosyte/synth/hl7";
  * const rt = hl7QuirkRoundTrip(generateHl7Quirk({ seed: 1, quirk: "unknown-zsegment" }));
- * rt.withProfile?.tolerated; // true — the `visage` profile suppresses UNKNOWN_SEGMENT
+ * rt.withProfile?.tolerated; // true, the `visage` profile suppresses UNKNOWN_SEGMENT
  * ```
  */
 declare function hl7QuirkRoundTrip(artifact: QuirkArtifact): QuirkRoundTripResult;
@@ -454,8 +454,8 @@ interface Hl7QuirkCorpusOptions {
 }
 /**
  * Build a reproducible {@link Corpus} of HL7 v2 quirk artifacts. Each artifact's `warnings` record the
- * parser's verdict — the intended code(s) for its quirk (not empty: a quirk corpus is deliberately
- * off-spec) — and the manifest lists the applied quirk names.
+ * parser's verdict: the intended code(s) for its quirk (not empty: a quirk corpus is deliberately
+ * off-spec), and the manifest lists the applied quirk names.
  *
  * @param options - Seed, count, and the quirk selection. See {@link Hl7QuirkCorpusOptions}.
  * @returns A deep-frozen {@link Corpus}.
@@ -468,7 +468,7 @@ interface Hl7QuirkCorpusOptions {
  */
 declare function hl7QuirkCorpus(options: Hl7QuirkCorpusOptions): Corpus;
 /**
- * A ready-made {@link SynthProfile} that requests every built-in HL7 quirk — a convenience for wiring
+ * A ready-made {@link SynthProfile} that requests every built-in HL7 quirk: a convenience for wiring
  * `defineSynthProfile`'s quirk list to the parser's real tolerance.
  *
  * @example
@@ -480,20 +480,20 @@ declare function hl7QuirkCorpus(options: Hl7QuirkCorpusOptions): Corpus;
 declare const hl7QuirkProfile: SynthProfile;
 
 /**
- * `@cosyte/synth/hl7` — the HL7 v2 generation surface, exposed as its own subpath so importing the
+ * `@cosyte/synth/hl7`: the HL7 v2 generation surface, exposed as its own subpath so importing the
  * package root does **not** pull `@cosyte/hl7`. This is the **lazy, per-format** boundary: a consumer
  * who only needs HL7 fixtures imports `@cosyte/synth/hl7`; one who needs only the core primitives
  * never loads a parser.
- * `@cosyte/hl7` is an **optional peer dependency** — present only for this subpath.
+ * `@cosyte/hl7` is an **optional peer dependency**, present only for this subpath.
  *
  * The HL7 v2 message set is complete: `ADT` (A01/A04/A08), `ORU^R01`, `ORM^O01`, `SIU^S12`, and
- * `VXU^V04` — each built through `@cosyte/hl7`'s `buildMessage` and round-tripping with zero warnings.
+ * `VXU^V04`, each built through `@cosyte/hl7`'s `buildMessage` and round-tripping with zero warnings.
  *
  * @module
  */
 
 /**
- * Every HL7 v2 message kind this subpath generates — the `MSH-9` label used as the corpus `kind`. `ADT`
+ * Every HL7 v2 message kind this subpath generates: the `MSH-9` label used as the corpus `kind`. `ADT`
  * carries its trigger; the other families have a single generated trigger each.
  */
 type Hl7MessageKind = "ADT^A01" | "ADT^A04" | "ADT^A08" | "ORU^R01" | "ORM^O01" | "SIU^S12" | "VXU^V04";
@@ -540,7 +540,7 @@ interface Hl7CorpusOptions {
  * ```ts
  * import { hl7Corpus } from "@cosyte/synth/hl7";
  * const corpus = hl7Corpus({ seed: 42, count: 7 });
- * corpus.artifacts.every((a) => a.warnings.length === 0); // true — spec-clean
+ * corpus.artifacts.every((a) => a.warnings.length === 0); // true, spec-clean
  * ```
  */
 declare function hl7Corpus(options: Hl7CorpusOptions): Corpus;