@cosyte/transform 0.0.6 → 0.0.8

package/CHANGELOG.md

@@ -1,16 +1,99 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+## 0.0.8
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-Versions and publishing are managed with [Changesets](https://github.com/changesets/changesets);
-this file is maintained by hand (Changesets handles the version bump and publish only).
+### Patch Changes
 
-## [Unreleased]
+- 9fdde50: No runtime impact: punctuation only, plus a new repository-internal check that keeps it that way.
 
-The first pre-alpha release (`0.0.1`) will ship the initial public API surface. The package begins
-its public history at `0.0.x`, per the cosyte version ladder (`0.0.x` until first alpha).
+  The Cosyte brand voice does not use the em dash (U+2014). This package carried 659 of them across
+  75 of its 98 tracked files, including the README, every documentation page that publishes to the
+  documentation site, and the source doc comments that compile into the shipped type declarations and
+  render in an editor on hover. All 609 that were in scope are rewritten with a period, a colon, a
+  comma or parentheses, chosen by what each sentence meant rather than by one blanket substitution.
+
+  No exported name, type, issue code, fatal code or documented behaviour changed. Two strings changed
+  punctuation and nothing else, and both belong to developer tooling rather than to the published
+  package: the PHI scanner's clean-run line, and one diagnostic from the check that verifies this
+  repository's own contributor instructions.
+
+  Two files still carry the character and each is an exemption with a written reason. The changelog's
+  dated archive below its "Released before this file was generated" heading is a frozen record whose
+  entries are byte identical to the tarballs they shipped in, and rewriting it would destroy the
+  evidence a changelog exists to hold. The vendored third-party tarball under `vendor/` holds the
+  character's bytes by coincidence inside a compressed stream, which no edit can remove.
+
+  The check that enforces the rule lands in the same change as the sweep, on purpose: a check arriving
+  before its sweep turns the build red on arrival, and a sweep arriving before its check lets the
+  character grow back. It reads bytes directly rather than shelling out, refuses to report a clean
+  result whenever it cannot prove it read its subject, and holds its own source to the same rule by
+  assembling every banned spelling at runtime instead of writing one down.
+
+## 0.0.7
+
+### Patch Changes
+
+- a9c522a: No runtime impact: a repository-internal CI check now verifies this repository's own contributor instructions, which are not part of the published package.
+
+  The instructions live in two files, one always read and one read on demand, and until now nothing checked that the second one existed, that the sections it declares had any content, or that the cross-references between the two resolved. A new check refuses all three, refuses a cross-reference pointing at a file or path the repository does not carry, and refuses a relocated section that nothing points at any more.
+
+  It also refuses to report a clean run over a corpus it did not actually open: the files it read are reconciled against the list of files tracked by version control, and an empty or unreadable list is treated as a failure to run rather than as nothing to check.
+
+- 9fd8f24: The npm `description` no longer carries an em dash (`EMDASH-CONFORMANCE`).
+
+  The brand rule bans U+2014 on every cosyte surface, and this string is the most visible one the
+  package has: it is the subtitle on the npm package page and the one line shown in every npm search
+  result. It now reads with a colon, which is what the rule's own remedy list names first.
+
+  The `→` in the same string is U+2192, not an em dash, and it is load-bearing: it names the direction
+  of the transformation. It stays.
+
+  Scoped deliberately to the description alone. The full tree sweep for this repo is a separate unit,
+  still queued, and lands with the CI gate that keeps it swept.
+
+- 9fb82e8: The README lockup now links to cosyte.com (`ASSETS`).
+
+  The `<picture>` block above the H1 is wrapped in an anchor to https://cosyte.com, per the founder
+  requirement of 2026-08-06. Nothing inside the block moved: the `<source>`, the `<img>`, the alt text
+  and both tile URLs are byte-identical.
+
+  What the anchor does was measured on both surfaces by `fhir`, not assumed, because fourteen READMEs
+  carry this shape. On GitHub the anchor works and the colour-scheme switch keeps working, because the
+  `<img>` stays a direct child of `<picture>`, which is the condition the HTML spec puts on `<source>`
+  applying at all. On an npm package page the anchor is lost: npm wraps a README image in its own
+  anchor to the image file, a nested anchor is not representable, so the parser closes ours early and
+  the image ends up linked to the image file rather than to cosyte.com. Shipped anyway by founder
+  decision of 2026-08-07: on npm that is no worse than the unlinked lockup it replaces, and GitHub is
+  where these READMEs are read.
+
+- 7f4d59b: The published changelog no longer describes its own contents as unreleased: a release now writes its own version heading and its own entry into `CHANGELOG.md`.
+
+  `CHANGELOG.md` ships inside the npm tarball, and for the whole of this package's public history it carried no version heading at all. A single `[Unreleased]` heading spanned everything, and the preamble above it said the first pre-alpha release "will ship" the API surface listed below it, in a tarball that had already shipped that surface several versions earlier. Changesets now generates the changelog, so a release writes the version heading and the entry, and there is no hand-maintained section left to go stale.
+
+  The hand-written history is kept verbatim beneath a `Released before this file was generated` divider, with generated release sections above it, newest first. No entry was reworded, re-sorted or removed. What was dropped was scaffolding for the old hand-written workflow: the file's former header, the `[Unreleased]` heading and its link definition, the note beneath that heading promising a first release which had in fact already shipped, and the empty section stubs that existed to receive the next hand-written entry.
+
+## Released before this file was generated
+
+Every release section above this heading is written by
+[Changesets](https://github.com/changesets/changesets) from the changesets in `.changeset/`, newest
+release first. The release writes its own version heading, so nothing above this line is maintained
+by hand: a change is recorded by adding a changeset, and that changeset's summary is the entry a
+reader sees here.
+
+Everything below this heading was maintained by hand. It sat under a single `[Unreleased]` heading
+that no release ever rolled over, so it went on describing already-published code as unreleased,
+inside the published tarball, for the whole of this package's public history. It is left as it was
+written rather than re-sorted into version sections: the file never recorded which release each
+entry went out in, and this is the text that installed copies already carry on disk. No entry was
+reworded, re-sorted or removed. What was dropped was scaffolding for the hand-written workflow that
+no longer runs: the file's former header, the `[Unreleased]` heading and its link definition at the
+foot of the file, the note beneath that heading promising a first release which had in fact already
+shipped, and the empty section stubs that existed to receive the next hand-written entry.
+
+The entries below follow [Keep a Changelog](https://keepachangelog.com/en/1.1.0/); the generated
+sections above use the format Changesets writes, which is a version heading and a list of the
+changes that release consumed. Versions follow the cosyte pre-alpha ladder, `0.0.x` until first
+alpha, rather than [Semantic Versioning](https://semver.org/spec/v2.0.0.html) alone.
 
 ### Fixed
 
@@ -532,10 +615,6 @@ dependency: peer @cosyte/fhir@">=0.0.0" from @cosyte/transform@0.0.4`.
   `parseTransform` / `WARNING_CODES` / `FATAL_CODES` parser stubs and the round-trip property test;
   rewrote `docs-content/`, `README`, and this repo's `CLAUDE.md` for the transformation library.
 
-### Deprecated
-
-### Removed
-
 ### Fixed
 
 - **The README no longer says this package is unpublished.** It is on npm, and the sentence sat a
@@ -544,7 +623,3 @@ dependency: peer @cosyte/fhir@">=0.0.0" from @cosyte/transform@0.0.4`.
   rendered directly beneath npm's own header, which shows the version being served. The replacement
   names no version deliberately. A version written into prose is the part that goes stale, and the
   registry is the only thing that knows which one is current.
-
-### Security
-
-[Unreleased]: https://github.com/cosyte/transform/commits/main

package/README.md

@@ -1,11 +1,13 @@
-<picture>
-  <source media="(prefers-color-scheme: dark)" srcset="https://cosyte.com/tile/cosyte-lockup-tile-on-dark-1200x300.png">
-  <img alt="Cosyte: a plus mark set in two overlapping rounded squares, one solid and one outlined, beside the Cosyte wordmark" src="https://cosyte.com/tile/cosyte-lockup-tile-on-light-1200x300.png">
-</picture>
+<a href="https://cosyte.com">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://cosyte.com/tile/cosyte-lockup-tile-on-dark-1200x300.png">
+    <img alt="Cosyte: a plus mark set in two overlapping rounded squares, one solid and one outlined, beside the Cosyte wordmark" src="https://cosyte.com/tile/cosyte-lockup-tile-on-light-1200x300.png">
+  </picture>
+</a>
 
 # @cosyte/transform
 
-> HL7 v2 → FHIR R4 transformation for Node.js and TypeScript — **IG-grounded, fail-safe, value-free
+> HL7 v2 → FHIR R4 transformation for Node.js and TypeScript: **IG-grounded, fail-safe, value-free
 > diagnostics; never a confident wrong FHIR value**.
 
 `@cosyte/transform` is the healthcare **transformation** layer of the cosyte suite. Unlike the
@@ -16,9 +18,9 @@ grounded on the official **HL7 Version 2 to FHIR** Implementation Guide (`hl7.fh
 > **Status:** pre-alpha (`0.0.x`), published to npm. This release ships the
 > six safety-critical datatype converters and the value-free diagnostic channel, the
 > message-level assembly, HL7 v2 **ADT → FHIR Patient + Encounter**, the **ORU^R01 → FHIR
-> DiagnosticReport + Observation** results graph, the order-entry graph — **ORM_O01 /
-> OML_O21 → ServiceRequest** and **RXO → MedicationRequest** — the thin IG singles —
-> **VXU_V04 → Immunization**, **SIU_S12 → Appointment**, **MDM_T02 → DocumentReference** — all
+> DiagnosticReport + Observation** results graph, the order-entry graph (**ORM_O01 /
+> OML_O21 → ServiceRequest** and **RXO → MedicationRequest**), the thin IG singles
+> (**VXU_V04 → Immunization**, **SIU_S12 → Appointment**, **MDM_T02 → DocumentReference**), all
 > via `toFhir(msg)`, and **terminology value translation** of coded fields: route/site,
 > appointment type, order priority, and substitution are now value-translated through their IG
 > `mappedVia` ConceptMaps via `toFhirCodeableConceptVia`, fail-safe on any code the IG leaves unmapped.
@@ -31,7 +33,7 @@ grounded on the official **HL7 Version 2 to FHIR** Implementation Guide (`hl7.fh
 npm install @cosyte/transform @cosyte/hl7 @cosyte/fhir
 ```
 
-`@cosyte/hl7` and `@cosyte/fhir` are **peer dependencies** — the transform maps between the models
+`@cosyte/hl7` and `@cosyte/fhir` are **peer dependencies**: the transform maps between the models
 they own. Its own third-party runtime dependencies are **zero**.
 
 **That command does not work yet.** This package is published, but `@cosyte/fhir` is not on the
@@ -51,21 +53,21 @@ const { value, issues } = toFhirHumanName({
 // value: a FHIR HumanName node; issues: [] (clean, fully mapped)
 ```
 
-Each converter returns `{ value, issues }` — the FHIR datatype node it could faithfully produce, plus
+Each converter returns `{ value, issues }`: the FHIR datatype node it could faithfully produce, plus
 the value-free diagnostics it raised.
 
 ## The fail-safe rule
 
-Every conversion is grounded on the IG and **refuses to guess**. On any ambiguity —
+Every conversion is grounded on the IG and **refuses to guess**. On any of these ambiguities:
 
 - a v2 timestamp with a time-of-day but **no timezone** (FHIR forbids time without a zone),
 - an assigning authority that can't be **resolved to a system URI** (never synthesized from a bare
-  namespace — that would merge two patients),
+  namespace, which would merge two patients),
 - a code with an **unrecognized or absent coding system**,
 - a unit that isn't valid **UCUM** (magnitudes are never converted),
 
-— the converter produces what it _can_ (often reduced in precision) and raises a **typed, value-free
-`TransformIssue`**: a stable code, the v2 location, and the FHIR path — never a value. Render a list
+the converter produces what it _can_ (often reduced in precision) and raises a **typed, value-free
+`TransformIssue`**: a stable code, the v2 location, and the FHIR path, never a value. Render a list
 of issues as a FHIR `OperationOutcome` with `toOperationOutcome(issues)`.
 
 ## The six datatype converters
@@ -81,8 +83,8 @@ of issues as a FHIR `OperationOutcome` with `toOperationOutcome(issues)`.
 
 ## Assemble a message
 
-`toFhir(msg)` takes a parsed `@cosyte/hl7` **ADT** message and returns a FHIR R4 **message `Bundle`** —
-a `MessageHeader`, then the `Patient` and `Encounter` (and `RelatedPerson`) it describes — plus the
+`toFhir(msg)` takes a parsed `@cosyte/hl7` **ADT** message and returns a FHIR R4 **message `Bundle`**:
+a `MessageHeader`, then the `Patient` and `Encounter` (and `RelatedPerson`) it describes, plus the
 value-free issues, each map grounded firsthand on the IG's segment/table ConceptMaps.
 
 ```ts
@@ -103,19 +105,19 @@ const { bundle, issues } = toFhir(parseHL7(raw), {
 | NK1     | `RelatedPerson` | NK1-2/3/4 → `name`/`relationship`/`address`                              |
 
 The fail-safe rule holds at the message level: an unmapped patient class, a naked timestamp, or an
-unresolvable authority becomes a typed issue — never a fabricated value. A trigger the IG has no
+unresolvable authority becomes a typed issue, never a fabricated value. A trigger the IG has no
 **message** map for is assembled from the segment maps and flagged, never invented; every emitted
 resource is validated against `@cosyte/fhir` before it ships.
 
 The same `toFhir(msg)` handles the other message families: **ORU^R01** → `DiagnosticReport` (OBR) +
-`Observation` (OBX), and the order-entry graph — **ORM_O01 / OML_O21** ORC/OBR →
-`ServiceRequest`, **RXO** (+ RXR route) → `MedicationRequest`, with `ServiceRequest.status`
+`Observation` (OBX), and the order-entry graph, **ORM_O01 / OML_O21** ORC/OBR →
+`ServiceRequest` and **RXO** (+ RXR route) → `MedicationRequest`, with `ServiceRequest.status`
 grounded on the HL70119 → request-status ConceptMap and withheld when it cannot be grounded, and a
 `MedicationRequest` whose IG-ungrounded status is the honest `unknown` rather than a guess. `RXE` has no
 STU1 IG map and is flagged, never assembled.
 
 The thin single-trigger families complete the IG-covered message set: **VXU_V04** RXA (+
-RXR route, ORC) → `Immunization` (status via the IG's three conditioned rows — a delete action →
+RXR route, ORC) → `Immunization` (status via the IG's three conditioned rows: a delete action →
 `entered-in-error`, an unvalued RXA-20 → `completed`, else the HL70322 → event-status ConceptMap, with a
 valued-but-unmapped code withheld), **SIU_S12** SCH/AIS/PID → `Appointment` (status via the
 HL70278 → appointmentstatus ConceptMap, the Patient wired as the required participant, its IG-unsourced
@@ -124,12 +126,12 @@ grounded only for TXA-19 `AV` → `current`, the document body base64-encoded ve
 interpreted). Timezone-naked instants are dropped and flagged, never assigned a fabricated UTC offset.
 
 `toFhirCodeableConceptVia(cwe, map)` applies a license-clean IG value ConceptMap
-(transcribed and verified firsthand against the raw published IG JSON) — **RXR** route/site
+(transcribed and verified firsthand against the raw published IG JSON): **RXR** route/site
 (HL70162/HL70550), **SCH-8** appointment type (HL70277), **RXO-9** substitution (HL70161), and **OBR-5**
-priority (HL70485) — translating the source table code to its FHIR target coding, additively (the raw
+priority (HL70485), translating the source table code to its FHIR target coding, additively (the raw
 coding is preserved alongside the derived one). It is fail-safe by refusal: a code the IG map leaves in
 its `(unmapped)` group is flagged, never coerced to a neighbour. Fields whose IG target is **SNOMED CT**
-(RXR-4 method, SCH-7 reason) stay structural — SNOMED is not bundled (BYO ConceptMap) — and fields the
+(RXR-4 method, SCH-7 reason) stay structural, because SNOMED is not bundled (BYO ConceptMap), and fields the
 IG ships no value map for (TXA-2 document type, RXA-5 vaccine code) are carried as-is, never invented.
 
 ## License

package/dist/index.cjs

@@ -7,16 +7,16 @@ var crypto = require('crypto');
 // src/diagnostics/codes.ts
 var ISSUE_CODES = {
   /** A v2 DTM/TS carried a time-of-day but no timezone offset. FHIR forbids time-without-zone, so
-   * the value was reduced to date precision (or an explicit sender offset applied via options) —
+   * the value was reduced to date precision (or an explicit sender offset applied via options),
    * **never** a guessed UTC. */
   TRANSFORM_TIMESTAMP_NO_TIMEZONE: "TRANSFORM_TIMESTAMP_NO_TIMEZONE",
   /** A v2 DTM/TS could not be parsed into a valid FHIR date/time; no value was emitted. */
   TRANSFORM_TIMESTAMP_INVALID: "TRANSFORM_TIMESTAMP_INVALID",
   /** The assigning authority (HD) could not be resolved to a FHIR `Identifier.system` URI via the
-   * NamingSystem registry. The identifier is emitted with its value and **no** system — a system URI
+   * NamingSystem registry. The identifier is emitted with its value and **no** system: a system URI
    * is **never** synthesized from HD.1 alone. */
   TRANSFORM_IDENTIFIER_SYSTEM_UNRESOLVED: "TRANSFORM_IDENTIFIER_SYSTEM_UNRESOLVED",
-  /** A coded value could not be mapped to a FHIR concept — either it carried no coding-system context
+  /** A coded value could not be mapped to a FHIR concept: either it carried no coding-system context
    * (CWE.3 absent), or it is a table code the IG ConceptMap has **no target** for (e.g. an OBX-11/
    * OBR-25 result status the HL70085/HL70123 map does not carry, or an OBX-8 abnormal flag absent from
    * HL70078). The original code is preserved / the FHIR value left absent; **never** coerced to a
@@ -26,14 +26,14 @@ var ISSUE_CODES = {
    * be emitted. The code is preserved; a URI is **never** invented. */
   TRANSFORM_CODE_SYSTEM_UNRESOLVED: "TRANSFORM_CODE_SYSTEM_UNRESOLVED",
   /** A unit was not a valid UCUM code (or was not declared UCUM). It is preserved verbatim in
-   * `Quantity.unit`; `Quantity.code`/`.system` are left absent — a UCUM code is **never** fabricated
+   * `Quantity.unit`; `Quantity.code`/`.system` are left absent: a UCUM code is **never** fabricated
    * and a magnitude is **never** converted. */
   TRANSFORM_UNIT_NOT_UCUM: "TRANSFORM_UNIT_NOT_UCUM",
-  /** A v2 numeric value (NM) could not be represented as a FHIR `decimal` without altering it — e.g.
+  /** A v2 numeric value (NM) could not be represented as a FHIR `decimal` without altering it, e.g.
    * a leading `+`, a leading zero, or a trailing dot, which FHIR's `decimal` lexical form forbids. No
    * `Quantity` value is emitted rather than a canonicalized (and therefore altered) magnitude. */
   TRANSFORM_QUANTITY_VALUE_INVALID: "TRANSFORM_QUANTITY_VALUE_INVALID",
-  /** A populated source element was not carried to its FHIR target and was dropped — either because
+  /** A populated source element was not carried to its FHIR target and was dropped, either because
    * the IG map defines no target, or because that target's conversion is **not implemented**
    * (e.g. XTN→ContactPoint telecom, PV1 participants). Surfaced here rather than silently discarded,
    * never a fabricated value. */
@@ -46,13 +46,13 @@ var ISSUE_CODES = {
   TRANSFORM_ADDRESS_USE_UNMAPPED: "TRANSFORM_ADDRESS_USE_UNMAPPED",
   /** The message's trigger event has no IG *message* map, so its resource graph was assembled from
    * the reusable IG *segment* maps rather than a message map. The graph is best-effort and flagged
-   * as such — never a fabricated message map. */
+   * as such, never a fabricated message map. */
   TRANSFORM_SEGMENT_ASSEMBLED: "TRANSFORM_SEGMENT_ASSEMBLED",
   /** A produced FHIR resource failed `@cosyte/fhir` R4 structural validation and was **withheld**
-   * from the bundle rather than emitted as a silently-invalid resource — the conservative-emit gate. */
+   * from the bundle rather than emitted as a silently-invalid resource: the conservative-emit gate. */
   TRANSFORM_RESOURCE_INVALID: "TRANSFORM_RESOURCE_INVALID",
   /** A FHIR-required element's value could not be faithfully derived from the source, so it was
-   * emitted with a `data-absent-reason` extension (value `unknown`) rather than fabricated — e.g.
+   * emitted with a `data-absent-reason` extension (value `unknown`) rather than fabricated, e.g.
    * `MessageHeader.source.endpoint` from an MSH-3 application namespace that is not a URL. */
   TRANSFORM_REQUIRED_ELEMENT_UNKNOWN: "TRANSFORM_REQUIRED_ELEMENT_UNKNOWN"
 };
@@ -165,7 +165,7 @@ function renderIssue(i) {
     prop("severity", fhir.primitive(i.severity)),
     prop("code", fhir.primitive(fhirIssueTypeFor(i.code))),
     prop("details", details),
-    // `diagnostics` carries the v2 source location — positional metadata, never a value.
+    // `diagnostics` carries the v2 source location: positional metadata, never a value.
     prop("diagnostics", fhir.primitive(i.v2Location))
   ];
   if (i.fhirPath !== void 0) {
@@ -1609,7 +1609,7 @@ var EMIT_SCHEMAS = Object.freeze([
   },
   {
     // Immunization: status (1..1 code), vaccineCode (1..1 CodeableConcept), patient (1..1 Reference), and
-    // occurrence[x] (1..1) are all required — the assembler only ever emits the occurrenceDateTime form, so
+    // occurrence[x] (1..1) are all required, and the assembler only ever emits the occurrenceDateTime form, so
     // it is required here. An RXA with no groundable status/vaccine/occurrence, or no bundle Patient, is
     // withheld rather than emitted incomplete.
     type: "Immunization",
@@ -1621,7 +1621,7 @@ var EMIT_SCHEMAS = Object.freeze([
     }
   },
   {
-    // Appointment: status (1..1 code) and participant (1..* BackboneElement) are both required — an
+    // Appointment: status (1..1 code) and participant (1..* BackboneElement) are both required, so an
     // Appointment whose SCH-25 status could not be grounded via HL70278, or that has no resolvable Patient
     // participant, is withheld rather than emitted with a guessed status or no participant.
     type: "Appointment",
@@ -1631,7 +1631,7 @@ var EMIT_SCHEMAS = Object.freeze([
     }
   },
   {
-    // DocumentReference: status (1..1 code) and content (1..* BackboneElement) are both required — a
+    // DocumentReference: status (1..1 code) and content (1..* BackboneElement) are both required, so a
     // reference whose TXA-19 is not "AV" (no groundable status), or that carries no document body from its
     // OBX segments, is withheld rather than emitted with a guessed status or referencing nothing.
     type: "DocumentReference",
@@ -2647,7 +2647,7 @@ function toFhir(msg, opts = {}) {
 }
 
 // src/index.ts
-var VERSION = "0.0.6";
+var VERSION = "0.0.8";
 
 exports.ADDRESS_TYPE_MAP = ADDRESS_TYPE_MAP;
 exports.ADDRESS_USE_MAP = ADDRESS_USE_MAP;