@cosyte/synth 0.1.8 → 0.1.10

package/dist/index.cjs

@@ -62,7 +62,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",
@@ -81,7 +85,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.",
@@ -94,18 +112,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 });
   }
 };
 
@@ -191,7 +229,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;
@@ -248,9 +286,7 @@ function isItinFormatted(value) {
   return ITIN_GROUP_RANGES.some((range) => group >= range.min && group <= range.max);
 }
 function isSyntheticPhone(value) {
-  const digits = value.replace(/\D/g, "");
-  const tail = digits.slice(-7);
-  return /^555 ?01\d\d$/.test(tail) || /^55501\d\d$/.test(tail);
+  return /55501\d\d$/.test(value.replace(/\D/g, ""));
 }
 function isSyntheticEmail(value) {
   const at = value.lastIndexOf("@");
@@ -329,7 +365,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))}`;
   }
@@ -456,6 +492,66 @@ 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 isSyntheticMicrochip(value) {
+  return new RegExp(`^${MICROCHIP_TEST_PREFIX}\\d{12}$`).test(value);
+}
+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,
@@ -469,7 +565,11 @@ var safe = Object.freeze({
   address,
   dateYmd,
   npi,
-  dea
+  dea,
+  petName,
+  animalBreed,
+  microchip,
+  animalBirthDate
 });
 function makeCorpus(seed, artifacts, quirks = []) {
   const counts = {};
@@ -500,7 +600,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]) } : {}
   });
 }
 
@@ -542,6 +642,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;
 }
@@ -558,25 +659,32 @@ function resolveMix(allowed, requested, fallback) {
 }
 
 // src/index.ts
-var VERSION = "0.1.8";
+var VERSION = "0.1.10";
 
+exports.ANIMAL_CODE_SYSTEM = ANIMAL_CODE_SYSTEM;
 exports.DEA_REGISTRANT_TYPES = DEA_REGISTRANT_TYPES;
 exports.DOC_V6_PREFIX = DOC_V6_PREFIX;
 exports.ITIN_GROUP_RANGES = ITIN_GROUP_RANGES;
+exports.MICROCHIP_TEST_PREFIX = MICROCHIP_TEST_PREFIX;
 exports.NPI_LUHN_PREFIX = NPI_LUHN_PREFIX;
 exports.PROFILE_QUIRK_APPLIED = PROFILE_QUIRK_APPLIED;
 exports.RESERVED_EMAIL_DOMAINS = RESERVED_EMAIL_DOMAINS;
+exports.SYNTHETIC_ANIMAL_SPECIES = SYNTHETIC_ANIMAL_SPECIES;
 exports.SYNTHETIC_ASSIGNING_AUTHORITY = SYNTHETIC_ASSIGNING_AUTHORITY;
 exports.SYNTHETIC_CITY_NAMES = SYNTHETIC_CITY_NAMES;
 exports.SYNTHETIC_FAMILY_NAMES = SYNTHETIC_FAMILY_NAMES;
 exports.SYNTHETIC_GIVEN_NAMES = SYNTHETIC_GIVEN_NAMES;
+exports.SYNTHETIC_PET_NAMES = SYNTHETIC_PET_NAMES;
 exports.SYNTHETIC_STREET_NAMES = SYNTHETIC_STREET_NAMES;
 exports.SYNTH_FATAL_CODES = SYNTH_FATAL_CODES;
 exports.SYNTH_FATAL_MESSAGES = SYNTH_FATAL_MESSAGES;
+exports.SYNTH_PEER_MESSAGES = SYNTH_PEER_MESSAGES;
 exports.SynthError = SynthError;
 exports.TEST_NET_V4_PREFIXES = TEST_NET_V4_PREFIXES;
 exports.VERSION = VERSION;
 exports.address = address;
+exports.animalBirthDate = animalBirthDate;
+exports.animalBreed = animalBreed;
 exports.assertIntendedWarnings = assertIntendedWarnings;
 exports.createRng = createRng;
 exports.dateYmd = dateYmd;
@@ -591,14 +699,17 @@ exports.isItinFormatted = isItinFormatted;
 exports.isSyntheticDea = isSyntheticDea;
 exports.isSyntheticEmail = isSyntheticEmail;
 exports.isSyntheticIp = isSyntheticIp;
+exports.isSyntheticMicrochip = isSyntheticMicrochip;
 exports.isSyntheticNpi = isSyntheticNpi;
 exports.isSyntheticPhone = isSyntheticPhone;
 exports.isSyntheticSsn = isSyntheticSsn;
 exports.luhnMod10 = luhnMod10;
 exports.makeCorpus = makeCorpus;
+exports.microchip = microchip;
 exports.name = name;
 exports.npi = npi;
 exports.npiCheckDigit = npiCheckDigit;
+exports.petName = petName;
 exports.phone = phone;
 exports.profileTolerated = profileTolerated;
 exports.resolveKind = resolveKind;