@cosyte/synth 0.1.4 → 0.1.5

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.1.5
+
+### Patch Changes
+
+- 3d13238: The exported example-code pools and the fatal-code registry are now frozen all the way down. `EXAMPLE_ASTM_TESTS` (`@cosyte/synth/astm`), `EXAMPLE_DRUGS` (`@cosyte/synth/ncpdp`) and the X12 pools `PROFESSIONAL_PROCEDURES`, `INSTITUTIONAL_PROCEDURES`, `DENTAL_PROCEDURES`, `REVENUE_CODES` and `DIAGNOSES` (`@cosyte/synth/x12`) froze the array but left each entry writable, so a JavaScript caller could rewrite an entry and change what every later call with the same seed generated. `SYNTH_FATAL_CODES` was not frozen at all, so a caller could change the code a later `SynthError` carried. Each entry and the registry are now frozen, as the other pools already were, and a write to one throws in strict mode.
+
+  No generated value, export, warning code or seed mapping changes.
+
+- cbae766: Doc comments only. `luhnMod10` is exported from `@cosyte/synth`, so it is public: its doc comment no longer marks it internal, and it now carries an example like any other export. The comment on the fatal-code module that ships in the type declarations now says in plain words how a parser handles bad input.
+
+  No generated value, export, warning code or seed mapping changes.
+
 ## 0.1.4
 
 ### Patch Changes

package/README.md

@@ -62,8 +62,9 @@ Node.js 22 or later, tested on 22, 24, and 26.
 `@cosyte/hl7`, `@cosyte/fhir`, `@cosyte/ccda`, `@cosyte/x12`, `@cosyte/ncpdp`, `@cosyte/astm`, and
 `@cosyte/deid` are **optional peer dependencies**, each needed only for its subpath (`@cosyte/synth/hl7`,
 `@cosyte/synth/fhir`, `@cosyte/synth/ccda`, `@cosyte/synth/x12`, `@cosyte/synth/ncpdp`,
-`@cosyte/synth/astm`, and `@cosyte/synth/deid`: the last needs `@cosyte/deid` **plus** the parsers for
-the formats it pairs): install only the packages whose fixtures you generate. The package core has
+`@cosyte/synth/astm`, and `@cosyte/synth/deid`: the last loads `@cosyte/deid` **plus** the five
+parsers it pairs, `@cosyte/hl7`, `@cosyte/fhir`, `@cosyte/ccda`, `@cosyte/x12`, and `@cosyte/ncpdp`,
+as soon as it is imported): install only the packages whose fixtures you generate. The package core has
 **zero third-party runtime dependencies**.
 
 ## Usage
@@ -367,21 +368,24 @@ isSyntheticNpi(safe.npi(rng)); // true, always a deliberately-invalid-Luhn NPI (
 
 The full reference is on [docs.cosyte.com/synth](https://docs.cosyte.com/synth):
 
-- [Installation](https://docs.cosyte.com/synth/installation) and the [quickstart](https://docs.cosyte.com/synth/quickstart).
-- Core concepts: [the archetype](https://docs.cosyte.com/synth/concepts-archetype) and the [limitations](https://docs.cosyte.com/synth/limitations).
-- Guides: [the overview](https://docs.cosyte.com/synth/guides-overview), [FHIR R4 and US Core](https://docs.cosyte.com/synth/guides-fhir),
+- [Installation](https://docs.cosyte.com/synth/installation), the [quickstart](https://docs.cosyte.com/synth/quickstart), and
+  a tutorial: [test your HL7 handling with generated fixtures](https://docs.cosyte.com/synth/test-hl7-handling-with-fixtures).
+- How-to guides: [HL7 v2](https://docs.cosyte.com/synth/guides-hl7), [FHIR R4 and US Core](https://docs.cosyte.com/synth/guides-fhir),
   [C-CDA](https://docs.cosyte.com/synth/guides-ccda), [X12](https://docs.cosyte.com/synth/guides-x12), [NCPDP](https://docs.cosyte.com/synth/guides-ncpdp),
-  [ASTM](https://docs.cosyte.com/synth/guides-astm), [vendor quirks](https://docs.cosyte.com/synth/guides-quirks), and
-  [the `@cosyte/deid` pairing loop](https://docs.cosyte.com/synth/guides-deid).
-- [Troubleshooting](https://docs.cosyte.com/synth/troubleshooting).
+  [ASTM](https://docs.cosyte.com/synth/guides-astm), [vendor quirks](https://docs.cosyte.com/synth/guides-quirks),
+  [the `@cosyte/deid` pairing loop](https://docs.cosyte.com/synth/guides-deid), [synthetic values](https://docs.cosyte.com/synth/draw-synthetic-values),
+  and [pinning a golden fixture](https://docs.cosyte.com/synth/guides-overview).
+- Explanation: [how it works](https://docs.cosyte.com/synth/concepts-archetype) and [what it does and does not do](https://docs.cosyte.com/synth/limitations).
+- Reference: [fatal codes](https://docs.cosyte.com/synth/fatal-codes), the [quirk catalog](https://docs.cosyte.com/synth/quirk-catalog), and the API reference.
+- [Troubleshooting](https://docs.cosyte.com/synth/troubleshooting), [testing and quality](https://docs.cosyte.com/synth/testing-and-quality), and [performance](https://docs.cosyte.com/synth/performance).
 - [`CHANGELOG.md`](https://github.com/cosyte/synth/blob/main/CHANGELOG.md): every release.
 
 ## Support
 
 Questions, bug reports, and requests for a format or a quirk go in
 [GitHub issues](https://github.com/cosyte/synth/issues). Every fixture this package makes is
-synthetic: never attach a real patient's data to an issue. For help with an integration test suite,
-see our [integration services](https://cosyte.com/integration-services).
+synthetic: never attach a real patient's data to an issue. Need an integration built and tested, or
+hosted and run for you? See our [integration services](https://cosyte.com/integration-services).
 
 ## Security
 

package/dist/astm/index.cjs

@@ -32,7 +32,16 @@ function sfc32Next(s) {
 }
 
 // src/codes.ts
-var SYNTH_FATAL_CODES = {
+var SYNTH_FATAL_CODES = Object.freeze({
+  /**
+   * A format was requested that this build cannot generate through a real parser builder/serializer.
+   * Fatal, never a hand-written byte fallback.
+   *
+   * **No code path in this build raises it.** All six formats generate, so it is reserved for a
+   * future format that does not, and is kept because removing a published code is a breaking change.
+   * An unsupported *kind* within a format that does generate is `SYNTH_UNSUPPORTED_KIND`.
+   */
+  SYNTH_UNSUPPORTED_FORMAT: "SYNTH_UNSUPPORTED_FORMAT",
   /**
    * A vendor quirk was requested that the target format's profile system does not support. Fatal,
    * never a silent no-op and never a fabricated quirk.
@@ -49,6 +58,10 @@ var SYNTH_FATAL_CODES = {
    * warning code(s). Fatal, never emit a mislabeled fixture.
    */
   SYNTH_INTENDED_WARNING_MISMATCH: "SYNTH_INTENDED_WARNING_MISMATCH",
+  /** A concept's code-system URI has no OID mapping in the C-CDA example-code table. Fatal. */
+  SYNTH_UNMAPPED_CODE_SYSTEM: "SYNTH_UNMAPPED_CODE_SYSTEM",
+  /** A money value could not be read as an X12 decimal. Fatal: a generator never rounds to a float. */
+  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. */
@@ -61,7 +74,17 @@ var SYNTH_FATAL_CODES = {
    * see `resolveKind`: a selector union is erased at run time, and a selector that falls through
    * either mislabels the fixture or hands the value to a peer builder that quotes it back.
    */
-  SYNTH_UNSUPPORTED_KIND: "SYNTH_UNSUPPORTED_KIND"};
+  SYNTH_UNSUPPORTED_KIND: "SYNTH_UNSUPPORTED_KIND",
+  /**
+   * A requested profile IS published by the adopted implementation guide, and this build does not
+   * generate it. Deliberately distinct from `SYNTH_UNSUPPORTED_KIND`, which says the name is not in
+   * the adopted set at all: "the guide does not publish this" and "we do not generate this yet" are
+   * different answers, and a caller building to a regulatory profile set has to be able to tell them
+   * 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"
+});
 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.",
   SYNTH_UNSUPPORTED_QUIRK: "The requested vendor quirk is not in the target format's quirk registry. Compare the request against that format's exported registry (HL7_QUIRKS, CCDA_QUIRKS, ASTM_QUIRKS).",
@@ -472,88 +495,90 @@ function astmHeaderIdentity(rng) {
 }
 
 // src/astm/example-codes.ts
-var EXAMPLE_ASTM_TESTS = Object.freeze([
-  {
-    localCode: "GLU",
-    loinc: "2345-7",
-    name: "Glucose",
-    units: "mg/dL",
-    referenceRange: "70-110",
-    valueLow: 55,
-    valueHigh: 260,
-    decimals: 0
-  },
-  {
-    localCode: "K",
-    loinc: "2823-3",
-    name: "Potassium",
-    units: "mmol/L",
-    referenceRange: "3.5-5.1",
-    valueLow: 28,
-    valueHigh: 62,
-    decimals: 1
-  },
-  {
-    localCode: "NA",
-    loinc: "2951-2",
-    name: "Sodium",
-    units: "mmol/L",
-    referenceRange: "136-145",
-    valueLow: 125,
-    valueHigh: 155,
-    decimals: 0
-  },
-  {
-    localCode: "CREA",
-    loinc: "2160-0",
-    name: "Creatinine",
-    units: "mg/dL",
-    referenceRange: "0.6-1.3",
-    valueLow: 4,
-    valueHigh: 32,
-    decimals: 1
-  },
-  {
-    localCode: "HGB",
-    loinc: "718-7",
-    name: "Hemoglobin",
-    units: "g/dL",
-    referenceRange: "12.0-17.5",
-    valueLow: 80,
-    valueHigh: 190,
-    decimals: 1
-  },
-  {
-    localCode: "WBC",
-    loinc: "6690-2",
-    name: "Leukocytes",
-    units: "10*3/uL",
-    referenceRange: "4.5-11.0",
-    valueLow: 30,
-    valueHigh: 150,
-    decimals: 1
-  },
-  {
-    localCode: "TSH",
-    loinc: "3016-3",
-    name: "Thyrotropin",
-    units: "mIU/L",
-    referenceRange: "0.40-4.50",
-    valueLow: 2,
-    valueHigh: 90,
-    decimals: 2
-  },
-  {
-    localCode: "ALT",
-    loinc: "1742-6",
-    name: "Alanine aminotransferase",
-    units: "U/L",
-    referenceRange: "7-56",
-    valueLow: 5,
-    valueHigh: 120,
-    decimals: 0
-  }
-]);
+var EXAMPLE_ASTM_TESTS = Object.freeze(
+  [
+    {
+      localCode: "GLU",
+      loinc: "2345-7",
+      name: "Glucose",
+      units: "mg/dL",
+      referenceRange: "70-110",
+      valueLow: 55,
+      valueHigh: 260,
+      decimals: 0
+    },
+    {
+      localCode: "K",
+      loinc: "2823-3",
+      name: "Potassium",
+      units: "mmol/L",
+      referenceRange: "3.5-5.1",
+      valueLow: 28,
+      valueHigh: 62,
+      decimals: 1
+    },
+    {
+      localCode: "NA",
+      loinc: "2951-2",
+      name: "Sodium",
+      units: "mmol/L",
+      referenceRange: "136-145",
+      valueLow: 125,
+      valueHigh: 155,
+      decimals: 0
+    },
+    {
+      localCode: "CREA",
+      loinc: "2160-0",
+      name: "Creatinine",
+      units: "mg/dL",
+      referenceRange: "0.6-1.3",
+      valueLow: 4,
+      valueHigh: 32,
+      decimals: 1
+    },
+    {
+      localCode: "HGB",
+      loinc: "718-7",
+      name: "Hemoglobin",
+      units: "g/dL",
+      referenceRange: "12.0-17.5",
+      valueLow: 80,
+      valueHigh: 190,
+      decimals: 1
+    },
+    {
+      localCode: "WBC",
+      loinc: "6690-2",
+      name: "Leukocytes",
+      units: "10*3/uL",
+      referenceRange: "4.5-11.0",
+      valueLow: 30,
+      valueHigh: 150,
+      decimals: 1
+    },
+    {
+      localCode: "TSH",
+      loinc: "3016-3",
+      name: "Thyrotropin",
+      units: "mIU/L",
+      referenceRange: "0.40-4.50",
+      valueLow: 2,
+      valueHigh: 90,
+      decimals: 2
+    },
+    {
+      localCode: "ALT",
+      loinc: "1742-6",
+      name: "Alanine aminotransferase",
+      units: "U/L",
+      referenceRange: "7-56",
+      valueLow: 5,
+      valueHigh: 120,
+      decimals: 0
+    }
+  ].map((entry) => Object.freeze(entry))
+);
 var ASTM_ABNORMAL_FLAGS = Object.freeze(["N", "L", "H", "A"]);
 var ASTM_RESULT_STATUSES = Object.freeze(["F", "P", "C"]);
 var ASTM_COMMENT_TEXT = Object.freeze([