@cosyte/synth 0.1.8 → 0.1.10

package/dist/astm/index.d.cts

@@ -134,8 +134,8 @@ declare function astmFramedRoundTrip(bytes: Uint8Array): AstmRoundTripResult;
 
 /**
  * Synthetic identity for ASTM (E1394 / CLSI LIS02) messages: every value `synth` puts into a `P`
- * (patient) record, an `O` (order) accession, or the `H` header is minted here, and **only** from the
- * synthetic-safety providers. ASTM's PHI-dense locus is the **`P` record**: it carries the
+ * (patient) record, an `O` (order) accession, or the `H` header's sender is minted here, and
+ * **only** from the synthetic-safety providers. ASTM's PHI-dense locus is the **`P` record**: it carries the
  * patient **name** (`Last^First^Middle`), **birthdate**, **sex**, and the **practice-assigned** and
  * **laboratory-assigned** patient IDs, which must stay
  * **distinct** (the parser keeps them distinct; a generator that let one default from the other would
@@ -169,11 +169,17 @@ interface AstmOrder {
     /** Priority code, emitted verbatim (`R` routine, `S` stat). */
     readonly priority: "R" | "S";
 }
-/** A synthetic ASTM header identity: the sender and analyzer strings for the `H` record. */
+/**
+ * A synthetic ASTM header identity: the sender name the `H` record carries in `H.5`, and an analyzer
+ * string that no generator writes into a message.
+ */
 interface AstmHeaderIdentity {
-    /** The sending system id (clearly synthetic). */
+    /** The sending system's name, written to `H.5` (clearly synthetic). */
     readonly sender: string;
-    /** The analyzer / instrument string (clearly synthetic). */
+    /**
+     * An analyzer / instrument string (clearly synthetic). Drawn so a seed keeps its draw order; the
+     * generators leave it out of the message.
+     */
     readonly analyzer: string;
 }
 /**
@@ -205,7 +211,8 @@ declare function astmPatient(rng: Rng): AstmPatient;
  */
 declare function astmOrder(rng: Rng): AstmOrder;
 /**
- * Mint a synthetic header identity for the `H` record: a clearly-synthetic sender and analyzer.
+ * Mint a synthetic header identity: a clearly-synthetic sender for the `H` record's `H.5`, and an
+ * analyzer string, drawn after it, that the generators leave out of the message.
  *
  * @param rng - The seeded generator.
  * @returns A synthetic {@link AstmHeaderIdentity}.
@@ -346,9 +353,15 @@ interface AstmQuirkCorpusOptions {
     readonly seed: number;
     /** How many quirk artifacts to generate. Defaults to the number of quirks. */
     readonly count?: number;
-    /** The quirk names to cycle through. Defaults to every ASTM quirk. Validated; unsupported ⇒ fatal. */
+    /**
+     * The quirk names to cycle through. Defaults to every ASTM quirk. Validated; unsupported ⇒ fatal.
+     * An empty list, or a `profile` whose `quirks` is an empty list, throws `SYNTH_EMPTY_POOL`.
+     */
     readonly quirks?: readonly AstmQuirkName[];
-    /** A {@link SynthProfile} whose `quirks` drive the corpus (validated). Takes precedence over `quirks`. */
+    /**
+     * A {@link SynthProfile} whose `quirks` drive the corpus (validated). Its `quirks`, when set, take
+     * precedence over `quirks`; a profile that leaves `quirks` out leaves the selection to `quirks`.
+     */
     readonly profile?: SynthProfile;
 }
 /**
@@ -397,7 +410,7 @@ interface AstmCorpusOptions {
     readonly seed: number;
     /** How many messages to generate. Defaults to the length of the mix. */
     readonly count?: number;
-    /** The message kinds to cycle through. Defaults to one of each. */
+    /** The message kinds to cycle through. Defaults to one of each. An empty list throws `SYNTH_EMPTY_POOL`. */
     readonly mix?: readonly AstmCorpusKind[];
     /**
      * Whether each artifact is read back through its parser and the parser's findings recorded as its

package/dist/astm/index.d.ts

@@ -134,8 +134,8 @@ declare function astmFramedRoundTrip(bytes: Uint8Array): AstmRoundTripResult;
 
 /**
  * Synthetic identity for ASTM (E1394 / CLSI LIS02) messages: every value `synth` puts into a `P`
- * (patient) record, an `O` (order) accession, or the `H` header is minted here, and **only** from the
- * synthetic-safety providers. ASTM's PHI-dense locus is the **`P` record**: it carries the
+ * (patient) record, an `O` (order) accession, or the `H` header's sender is minted here, and
+ * **only** from the synthetic-safety providers. ASTM's PHI-dense locus is the **`P` record**: it carries the
  * patient **name** (`Last^First^Middle`), **birthdate**, **sex**, and the **practice-assigned** and
  * **laboratory-assigned** patient IDs, which must stay
  * **distinct** (the parser keeps them distinct; a generator that let one default from the other would
@@ -169,11 +169,17 @@ interface AstmOrder {
     /** Priority code, emitted verbatim (`R` routine, `S` stat). */
     readonly priority: "R" | "S";
 }
-/** A synthetic ASTM header identity: the sender and analyzer strings for the `H` record. */
+/**
+ * A synthetic ASTM header identity: the sender name the `H` record carries in `H.5`, and an analyzer
+ * string that no generator writes into a message.
+ */
 interface AstmHeaderIdentity {
-    /** The sending system id (clearly synthetic). */
+    /** The sending system's name, written to `H.5` (clearly synthetic). */
     readonly sender: string;
-    /** The analyzer / instrument string (clearly synthetic). */
+    /**
+     * An analyzer / instrument string (clearly synthetic). Drawn so a seed keeps its draw order; the
+     * generators leave it out of the message.
+     */
     readonly analyzer: string;
 }
 /**
@@ -205,7 +211,8 @@ declare function astmPatient(rng: Rng): AstmPatient;
  */
 declare function astmOrder(rng: Rng): AstmOrder;
 /**
- * Mint a synthetic header identity for the `H` record: a clearly-synthetic sender and analyzer.
+ * Mint a synthetic header identity: a clearly-synthetic sender for the `H` record's `H.5`, and an
+ * analyzer string, drawn after it, that the generators leave out of the message.
  *
  * @param rng - The seeded generator.
  * @returns A synthetic {@link AstmHeaderIdentity}.
@@ -346,9 +353,15 @@ interface AstmQuirkCorpusOptions {
     readonly seed: number;
     /** How many quirk artifacts to generate. Defaults to the number of quirks. */
     readonly count?: number;
-    /** The quirk names to cycle through. Defaults to every ASTM quirk. Validated; unsupported ⇒ fatal. */
+    /**
+     * The quirk names to cycle through. Defaults to every ASTM quirk. Validated; unsupported ⇒ fatal.
+     * An empty list, or a `profile` whose `quirks` is an empty list, throws `SYNTH_EMPTY_POOL`.
+     */
     readonly quirks?: readonly AstmQuirkName[];
-    /** A {@link SynthProfile} whose `quirks` drive the corpus (validated). Takes precedence over `quirks`. */
+    /**
+     * A {@link SynthProfile} whose `quirks` drive the corpus (validated). Its `quirks`, when set, take
+     * precedence over `quirks`; a profile that leaves `quirks` out leaves the selection to `quirks`.
+     */
     readonly profile?: SynthProfile;
 }
 /**
@@ -397,7 +410,7 @@ interface AstmCorpusOptions {
     readonly seed: number;
     /** How many messages to generate. Defaults to the length of the mix. */
     readonly count?: number;
-    /** The message kinds to cycle through. Defaults to one of each. */
+    /** The message kinds to cycle through. Defaults to one of each. An empty list throws `SYNTH_EMPTY_POOL`. */
     readonly mix?: readonly AstmCorpusKind[];
     /**
      * Whether each artifact is read back through its parser and the parser's findings recorded as its

package/dist/astm/index.mjs

@@ -70,7 +70,11 @@ var SYNTH_FATAL_CODES = Object.freeze({
   SYNTH_INVALID_DECIMAL: "SYNTH_INVALID_DECIMAL",
   /** An integer range was requested with its maximum below its minimum. Fatal. */
   SYNTH_INVALID_RANGE: "SYNTH_INVALID_RANGE",
-  /** A value was drawn from an empty pool. Fatal, never a fabricated substitute. */
+  /**
+   * A value was drawn from an empty pool. Fatal, never a fabricated substitute. A corpus given an
+   * empty `mix`, `triggers` or `quirks` list (or a profile whose `quirks` is an empty list) raises it
+   * too: there is no kind to cycle through, and an empty list is never read as the default.
+   */
   SYNTH_EMPTY_POOL: "SYNTH_EMPTY_POOL",
   /** A `defineSynthProfile` spec was not usable (a missing or blank `name`). Fatal. */
   SYNTH_INVALID_PROFILE: "SYNTH_INVALID_PROFILE",
@@ -89,7 +93,21 @@ var SYNTH_FATAL_CODES = Object.freeze({
    * apart without matching message text. Fatal, and raised **before** anything is generated: a
    * mislabelled artifact is worse than no artifact.
    */
-  SYNTH_PROFILE_NOT_GENERATED: "SYNTH_PROFILE_NOT_GENERATED"
+  SYNTH_PROFILE_NOT_GENERATED: "SYNTH_PROFILE_NOT_GENERATED",
+  /**
+   * The sibling parser a generator builds through is not installed. Raised on the first call that
+   * needs it, by both builds, only when the missing package is the parser itself: a missing
+   * dependency of an installed parser is thrown as Node.js raised it. The error carries the parser's
+   * package name on `peer`, a message from {@link SYNTH_PEER_MESSAGES} that names its install
+   * command, and the error Node.js raised on `cause`.
+   */
+  SYNTH_PEER_NOT_INSTALLED: "SYNTH_PEER_NOT_INSTALLED",
+  /**
+   * An HL7 v2 `ACK` was asked for an inbound message that carries no MSH-10 message control id.
+   * MSA-2 must echo that id, and an acknowledgment that cannot be matched to the message it answers
+   * is not a fixture worth having, so nothing is generated.
+   */
+  SYNTH_ACK_UNCORRELATED: "SYNTH_ACK_UNCORRELATED"
 });
 var SYNTH_FATAL_MESSAGES = Object.freeze({
   SYNTH_UNSUPPORTED_FORMAT: "The requested format is not generable by this build. A generator has no byte fallback: it builds through a parser's own serializer or it refuses.",
@@ -102,18 +120,38 @@ var SYNTH_FATAL_MESSAGES = Object.freeze({
   SYNTH_EMPTY_POOL: "A value was drawn from an empty pool.",
   SYNTH_INVALID_PROFILE: "defineSynthProfile requires a non-empty string name.",
   SYNTH_UNSUPPORTED_KIND: "The requested kind, document type, corpus mix entry, variant or profile is not one this generator supports. The supported set is the exported union for that option.",
-  SYNTH_PROFILE_NOT_GENERATED: "The requested profile is published by the adopted implementation guide, and this build does not generate it. The coverage surface reports, per adopted profile, whether it is generated."
+  SYNTH_PROFILE_NOT_GENERATED: "The requested profile is published by the adopted implementation guide, and this build does not generate it. The coverage surface reports, per adopted profile, whether it is generated.",
+  SYNTH_PEER_NOT_INSTALLED: "A sibling @cosyte parser this generator builds through is not installed. Install it beside @cosyte/synth.",
+  SYNTH_ACK_UNCORRELATED: (
+    // Stryker disable next-line all: a module-level table runs once, at import; the docs test holds it.
+    "The inbound message has no MSH-10 control id for an ACK to echo in MSA-2."
+  )
+});
+var SYNTH_PEER_MESSAGES = Object.freeze({
+  "@cosyte/hl7": "@cosyte/hl7 is not installed, and this generator builds through it. Install it beside @cosyte/synth: npm install @cosyte/hl7",
+  "@cosyte/fhir": "@cosyte/fhir is not installed, and this generator builds through it. Install it beside @cosyte/synth: npm install @cosyte/fhir",
+  "@cosyte/ccda": "@cosyte/ccda is not installed, and this generator builds through it. Install it beside @cosyte/synth: npm install @cosyte/ccda",
+  "@cosyte/x12": "@cosyte/x12 is not installed, and this generator builds through it. Install it beside @cosyte/synth: npm install @cosyte/x12",
+  "@cosyte/ncpdp": "@cosyte/ncpdp is not installed, and this generator builds through it. Install it beside @cosyte/synth: npm install @cosyte/ncpdp",
+  "@cosyte/astm": "@cosyte/astm is not installed, and this generator builds through it. Install it beside @cosyte/synth: npm install @cosyte/astm",
+  "@cosyte/deid": "@cosyte/deid is not installed, and this generator builds through it. Install it beside @cosyte/synth: npm install @cosyte/deid"
 });
 var SynthError = class extends Error {
   /** The stable fatal code. */
   code;
   /**
    * @param code - The stable {@link SynthFatalCode}. The message comes from the frozen registry.
+   * @param options - The error that caused this one, and for a missing parser its package.
    */
-  constructor(code) {
-    super(SYNTH_FATAL_MESSAGES[code]);
+  constructor(code, options = {}) {
+    const peer = code === SYNTH_FATAL_CODES.SYNTH_PEER_NOT_INSTALLED ? options.peer : void 0;
+    super(
+      peer === void 0 ? SYNTH_FATAL_MESSAGES[code] : SYNTH_PEER_MESSAGES[peer],
+      "cause" in options ? { cause: options.cause } : void 0
+    );
     this.name = "SynthError";
     this.code = code;
+    if (peer !== void 0) Object.defineProperty(this, "peer", { value: peer, enumerable: true });
   }
 };
 
@@ -221,7 +259,7 @@ function luhnMod10(digits) {
     if (d < 0 || d > 9) continue;
     if (double) {
       d *= 2;
-      if (d > 9) d -= 9;
+      if (d >= 10) d -= 9;
     }
     sum += d;
     double = !double;
@@ -318,7 +356,7 @@ var SYNTHETIC_CITY_NAMES = Object.freeze([
 ]);
 
 // src/safe/providers.ts
-function ssn(rng, block = "never-issued") {
+function ssn(rng, block) {
   if (block === "advertising") {
     return `987-00-432${String(rng.int(0, 9))}`;
   }
@@ -445,6 +483,63 @@ var US_STATES = Object.freeze([
   "WY"
 ]);
 
+// src/safe/animal-code.ts
+var ANIMAL_CODE_SYSTEM = "99COSYTE";
+function animalCode(value, text) {
+  return Object.freeze({ code: value, text, system: ANIMAL_CODE_SYSTEM });
+}
+function animalSpecies(value, text, breeds) {
+  return Object.freeze({ ...animalCode(value, text), breeds: Object.freeze([...breeds]) });
+}
+
+// src/safe/animal.ts
+var SYNTHETIC_ANIMAL_SPECIES = Object.freeze([
+  animalSpecies("DOG", "Dog", [
+    animalCode("DOG-LAB", "Labrador Retriever"),
+    animalCode("DOG-BGL", "Beagle"),
+    animalCode("DOG-MIX", "Mixed breed dog")
+  ]),
+  animalSpecies("CAT", "Cat", [animalCode("CAT-DSH", "Domestic Shorthair"), animalCode("CAT-SIA", "Siamese")]),
+  animalSpecies("HORSE", "Horse", [animalCode("HRS-QTR", "Quarter Horse"), animalCode("HRS-TB", "Thoroughbred")]),
+  animalSpecies("CATTLE", "Cattle", [animalCode("CTL-HOL", "Holstein"), animalCode("CTL-ANG", "Angus")])
+]);
+var SYNTHETIC_PET_NAMES = Object.freeze([
+  "Fixturepaw",
+  "Mockwhisker",
+  "Stubtail",
+  "Seedpup",
+  "Testbiscuit",
+  "Placepurr",
+  "Synthfur",
+  "Dummymane",
+  "Examplehoof",
+  "Fauxfluff",
+  "Samplesnout",
+  "Voidwag"
+]);
+var MICROCHIP_TEST_PREFIX = "999";
+function petName(rng) {
+  return rng.pick(SYNTHETIC_PET_NAMES);
+}
+function animalBreed(rng) {
+  const picked = rng.pick(SYNTHETIC_ANIMAL_SPECIES);
+  const { breeds, ...bare } = picked;
+  return { species: Object.freeze(bare), breed: rng.pick(breeds) };
+}
+function microchip(rng) {
+  return `${MICROCHIP_TEST_PREFIX}${rng.digits(12)}`;
+}
+function animalBirthDate(rng, onDate) {
+  const year = Number(onDate.slice(0, 4));
+  const month = Number(onDate.slice(4, 6)) - 1;
+  const day = Number(onDate.slice(6, 8));
+  const latest = Date.UTC(year, month, day);
+  const earliest = Date.UTC(year - 20, month, day);
+  const span = Math.round((latest - earliest) / 864e5);
+  const born = new Date(latest - rng.int(0, span) * 864e5);
+  return born.toISOString().slice(0, 10).replace(/-/g, "");
+}
+
 // src/safe/index.ts
 var safe = Object.freeze({
   ssn,
@@ -458,7 +553,11 @@ var safe = Object.freeze({
   address,
   dateYmd,
   npi,
-  dea
+  dea,
+  petName,
+  animalBreed,
+  microchip,
+  animalBirthDate
 });
 
 // src/astm/identity.ts
@@ -597,14 +696,44 @@ function defaultHost() {
   if (typeof import.meta.resolve !== "function") return { require: __require, resolve: void 0 };
   return { require: createRequire(import.meta.url), resolve: (s) => import.meta.resolve(s) };
 }
+function isDenoResolveRefusal(error) {
+  return error instanceof TypeError && !("code" in error) && error.message === "Invalid arguments";
+}
 function isRequireEsmRefusal(error) {
   return error?.code === "ERR_REQUIRE_ESM";
 }
+function peerPackage(specifier) {
+  const name2 = specifier.split("/").slice(0, 2).join("/");
+  return Object.hasOwn(SYNTH_PEER_MESSAGES, name2) ? name2 : void 0;
+}
+function isPeerNotFound(error, specifier, peer) {
+  const { code, message } = error ?? {};
+  if (typeof message !== "string") return false;
+  if (code === "ERR_MODULE_NOT_FOUND") return message.startsWith(`Cannot find package '${peer}'`);
+  if (code === "MODULE_NOT_FOUND") return message.startsWith(`Cannot find module '${specifier}'`);
+  return false;
+}
 function loadPeer(specifier, host) {
+  try {
+    return loadFrom(specifier, host);
+  } catch (error) {
+    const peer = peerPackage(specifier);
+    if (peer === void 0 || !isPeerNotFound(error, specifier, peer)) throw error;
+    throw new SynthError(SYNTH_FATAL_CODES.SYNTH_PEER_NOT_INSTALLED, { peer, cause: error });
+  }
+}
+function loadFrom(specifier, host) {
   if (host.resolve === void 0) return host.require(specifier);
-  const entry = fileURLToPath(host.resolve(specifier));
+  let url;
   try {
-    return host.require(entry);
+    url = host.resolve(specifier);
+  } catch (error) {
+    if (!isDenoResolveRefusal(error)) throw error;
+    return host.require(specifier);
+  }
+  if (!url.startsWith("file:")) return host.require(specifier);
+  try {
+    return host.require(fileURLToPath(url));
   } catch (error) {
     if (!isRequireEsmRefusal(error)) throw error;
     return host.require(specifier);
@@ -727,6 +856,10 @@ function resolveMix(allowed, requested, fallback) {
   if (requested === void 0) return fallback;
   return requested.map((entry) => resolveKind(allowed, entry));
 }
+function requireSelection(selection) {
+  if (selection.length === 0) throw new SynthError(SYNTH_FATAL_CODES.SYNTH_EMPTY_POOL);
+  return selection;
+}
 
 // src/profile.ts
 function defineSynthProfile(spec) {
@@ -737,7 +870,7 @@ function defineSynthProfile(spec) {
     name: spec.name,
     ...spec.givenNames ? { givenNames: Object.freeze([...spec.givenNames]) } : {},
     ...spec.familyNames ? { familyNames: Object.freeze([...spec.familyNames]) } : {},
-    quirks: Object.freeze([...spec.quirks ?? []])
+    ...spec.quirks !== void 0 ? { quirks: Object.freeze([...spec.quirks]) } : {}
   });
 }
 
@@ -779,6 +912,7 @@ function assertIntendedWarnings(intendedWarnings, bareWarnings) {
   }
 }
 function validateProfileQuirks(profile, registry, format) {
+  if (profile.quirks === void 0) return Object.keys(registry);
   for (const name2 of profile.quirks) resolveQuirk(registry, format, name2);
   return profile.quirks;
 }
@@ -887,8 +1021,9 @@ var ALL_ASTM_QUIRKS = Object.freeze(
   Object.keys(ASTM_QUIRKS)
 );
 function astmQuirkCorpus(options) {
-  const quirks = options.profile ? validateProfileQuirks(options.profile, ASTM_QUIRKS, "astm") : options.quirks ?? ALL_ASTM_QUIRKS;
-  const names = quirks.length > 0 ? quirks : ALL_ASTM_QUIRKS;
+  const names = requireSelection(
+    options.profile?.quirks !== void 0 ? validateProfileQuirks(options.profile, ASTM_QUIRKS, "astm") : options.quirks ?? ALL_ASTM_QUIRKS
+  );
   for (const name2 of names) resolveQuirk(ASTM_QUIRKS, "astm", name2);
   const count = options.count ?? names.length;
   const seedStream = createRng(options.seed);
@@ -923,11 +1058,11 @@ function generateKind(kind, seed, verify) {
 }
 function astmCorpus(options) {
   const { seed, verify = true } = options;
-  const mix = resolveMix(ALL_KINDS, options.mix, DEFAULT_MIX);
+  const mix = requireSelection(resolveMix(ALL_KINDS, options.mix, DEFAULT_MIX));
   const count = options.count ?? mix.length;
   const seedStream = createRng(seed);
   const artifacts = Array.from({ length: count }, (_unused, i) => {
-    const kind = mix[i % mix.length] ?? "Result";
+    const kind = mix[i % mix.length];
     const msgSeed = seedStream.nextUint32();
     const rt = generateKind(kind, msgSeed, verify);
     return {