@cosyte/astm 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -1,13 +1,180 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+## 0.1.2
 
-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]
+- 93c5774: The README follows our shared layout, with Support and Security sections and the Node.js versions CI tests (22, 24, and 26), and at a fifth of its former length it fits well inside npm's README limit. Its API tour and its coverage and compatibility notes moved, unchanged, to two pages on docs.cosyte.com/astm: "The API, layer by layer" and "Coverage and compatibility". No code, API, or behavior changes.
+
+## 0.1.1
+
+### Patch Changes
+
+- Published through npm trusted publishing, with provenance.
+
+## 0.1.0
+
+### Minor Changes
+
+- **One date conversion surface across the @cosyte parsers.** `toObject`, `toISO` and `toDate` read a
+  parsed ASTM date the same way the sibling parsers do. `toObject` returns only the components the
+  value stated, and `toISO` appends no offset, because ASTM states none. `toDate` returns a `Date` only
+  when you pass `assumeOffsetMinutes`: an analyzer's timestamp is local to the analyzer.
+- **A LIVD catalog records where it came from.** `defineLivdCatalog` takes an optional second argument
+  (publisher, publication version, LOINC version, LOINC copyright), and every annotation carries the
+  catalog's LOINC version, so a mapping can be reproduced. A catalog with no LOINC version still
+  builds and raises one `ASTM_LIVD_CATALOG_NO_LOINC_VERSION` warning.
+- **Reported units can choose between candidate LOINCs.** A LIVD entry can carry
+  `representativeUnit`, `vendorSpecimenDescription` and `vendorResultDescription`. When one vendor
+  code maps to several LOINCs, the candidate whose unit exactly equals the reported unit is answered
+  `mapped`. The comparison is verbatim and case sensitive, not UCUM, and every unit-selected answer
+  says so. No match, or more than one, is still `ambiguous`.
+- **Flags and statuses name the vocabulary they were graded against.** An abnormal flag carries the
+  code system and version it was compared with, and `HU` and `LU` are now recognized. A result status
+  says that no citable published source binds its letters, rather than implying one.
+- **One deliberate break from 0.0.x**, in the LIVD mapping and in what `primaryCode()` returns:
+  a populated first component of the Universal Test ID is no longer reported as a LOINC, and
+  `primaryCode()` returns the vendor local code and nothing else. The hand-written entries below and
+  the [0.1.0 release notes](https://github.com/cosyte/astm/releases/tag/v0.1.0) give the migration.
+
+## 0.0.22
+
+### Patch Changes
+
+- Gate the two-file contract between `CLAUDE.md` and the agent notes.
+- Read the bytes git carries in the PHI sweep, as a union with the working-tree walk.
+
+## 0.0.21
+
+### Patch Changes
+
+- Correct two false claims the contested-alignment codes rested on, both on consumer surfaces.
+- Close the three measurement holes the contested-alignment claim corrections left behind.
+
+## 0.0.20
+
+### Patch Changes
+
+- Read a stream embedded as a source string literal in the PHI commit-gate, and refuse a sweep that did not observe its corpus.
+
+## 0.0.19
+
+### Patch Changes
+
+- Report a contested escape alignment whose tail this reader cannot read, not only one it cannot consume.
+- The README lockup now links to cosyte.com.
+- Report components a competing escape alignment moved one slot along.
+- Development tooling only: the repository's own pre-commit PHI scanner no longer lets a caller's git configuration decide which staged entries it looks at.
+
+## 0.0.18
+
+### Patch Changes
+
+- Report a field a competing escape alignment read short.
+
+## 0.0.17
+
+### Patch Changes
+
+- Report a competing escape alignment that shifted a result's units and status into slots the sender did not write them in.
+
+## 0.0.15
+
+### Patch Changes
+
+- Stop a delimiter set that names one of the escape mnemonics from altering the values it emits, and state what a header's delimiter-declaration surplus costs on emit.
+
+## 0.0.14
+
+### Patch Changes
+
+- Refuse a `startFrameNumber` that cannot be written as a frame number, which used to go out as whatever byte the arithmetic truncated to and could cost a framed stream every one of its records.
+
+## 0.0.13
+
+### Patch Changes
+
+- Refuse to emit a record whose own type letter the delimiter set would escape away, which used to produce a stream that read back as different records and, in its silent branch, fabricated a final lab result out of patient identifiers.
+
+## 0.0.11
+
+### Patch Changes
+
+- A symbolic link under a scan root read clean on both of the PHI scanner's enumerating routes, so a link pointing at a file full of real identifiers passed the gate twice over.
+- Make the package's own publish gate fail when a build would ship without its type declarations.
+
+## 0.0.10
+
+### Patch Changes
+
+- Stop the frame encoder from silently writing a different character than the one it was given.
+
+## 0.0.9
+
+### Patch Changes
+
+- Report a record whose fields did not separate, instead of reading it back with no value, no units and no status, and stop calling a message a result set when a record's type letter is unreadable.
+- Stop one unescaped `&` in a value from swallowing every following field.
+
+## 0.0.8
+
+### Patch Changes
+
+- Remove `ASTM_RECORD_UNKNOWN_TYPE` from the profile safety gate's tolerable allow-list.
+
+## 0.0.7
+
+### Patch Changes
+
+- The alt text on the README's Cosyte mark now says how its two overlapping rounded squares differ, one solid and one outlined.
+
+## 0.0.6
+
+### Patch Changes
+
+- The Cosyte mark now opens the README, and follows the reader's color scheme.
+
+## 0.0.5
+
+### Patch Changes
+
+Internal tooling and CI only. No change to the published package surface.
+
+## 0.0.4
+
+### Patch Changes
+
+- Correct the API documentation shipped in the type declarations, and stop it going stale.
+- Stop pairing one patient's results with another's, and add `messages()` to read a stream as the sequence of messages it actually is.
+- Read the delimiters from every header, not just the first, so a stream carrying more than one message no longer silently loses fields.
+- Emit one delimiter set for the whole stream, so a round-trip no longer silently loses fields.
+- Close the two emit-side gaps where a stream went out that could not be read back.
+
+## 0.0.3
+
+### Patch Changes
+
+- Documentation: the page describing what the library does and does not do moves from an "About" category into **Troubleshooting**, matching the section order every other `@cosyte/*` package uses.
+- The status note on the README, the overview page and the install page no longer names a version number, because a release made that number wrong every time.
+
+## 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, and a change is recorded by adding a changeset rather than by editing this file. The
+sections for 0.0.3 to 0.1.1 were filled in from the GitHub release notes when generation was turned
+on, because those releases shipped while this file was kept by hand and its last version heading was
+0.0.2. Each repeats the "What changed" list from that release's notes, and 0.1.0 adds one line on
+its deliberate break.
+
+Everything below this heading was maintained by hand, in the
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format, and is left as it was written. The
+entries from the start down to `[0.0.2]` sat under an `[Unreleased]` heading that no release rolled
+over, so they record what 0.0.3 to 0.1.1 changed, written as the work landed rather than sorted by
+release. Three things were dropped: the preamble above them (it said the file was kept by hand), the
+`[Unreleased]` heading itself, and its link definition at the foot of the file. No entry was
+reworded.
 
 **What 0.1 means for you.** This release is the first whose public API we treat as settled: the
 exported names, options, return shapes and warning codes are the surface we keep stable. What it
@@ -53,6 +220,9 @@ exists for.
 
 ### Changed
 
+- **Published through npm trusted publishing, with provenance.** The code, API and behavior are
+  unchanged from 0.1.0. Only the README and some doc comments differ: a few doc comments now write
+  number ranges with "to".
 - **Every published release now carries a machine-readable dependency inventory as a downloadable
   asset.** No published value, type, warning code or emitted byte moves: this entry is release
   infrastructure only, and nothing under `src/` is touched. The inventory is a CycloneDX document
@@ -387,7 +557,7 @@ exists for.
   adding a workflow that would have to be made a required context separately. It asserts that every
   pointer resolves, that no section a pointer reaches is empty, that the record stays reachable from
   the always-read file, and that the always-read file still links the record by path. It asserts
-  **no** ecosystem-wide contract: several cosyte repos carry no such record at all, and a gate
+  **no** ecosystem-wide contract: several Cosyte repos carry no such record at all, and a gate
   phrased as though every repo did would be an overclaim.
   - **The matcher was re-derived against this tree rather than ported, and that was the whole job.**
     Both sibling spellings score **zero** here: the path-qualified form used by `ccda` and `mllp`,
@@ -1430,7 +1600,7 @@ exists for.
   **The refusal removes no capability.** `composeAstmFrames` already accepted `Uint8Array`, so a
   consumer who knows their instrument's code page encodes with their own encoder and passes bytes,
   which are written through untouched. A stream whose every character is Latin-1 is byte-identical
-  to before, the full `0x00`–`0xFF` range included. The **record** layer is deliberately unchanged:
+  to before, the full `0x00` to `0xFF` range included. The **record** layer is deliberately unchanged:
   `serializeAstmRecords` returns a `string`, which is not yet bytes, so the caller keeps the choice.
 
   **Stated no wider than it was measured.** This closes the string-to-bytes step only. It is not a
@@ -1907,7 +2077,7 @@ phase 8` passes while `Phase 8` reds). An arm keyed on a following digit was wri
   acceptance under a tolerating profile) is _measured_, on the tree before and after the change.
 
 - **The em dash (U+2014) is gone from every tracked file, and a CI gate keeps it out**
-  (`EMDASH-CONFORMANCE`). The brand rule bans the character outright across every cosyte surface
+  (`EMDASH-CONFORMANCE`). The brand rule bans the character outright across every Cosyte surface
   and names commit messages explicitly; this package was the last one it had not reached, and the
   only one where it did not arrive on a clean tree. **1,129 occurrences across 108 of the 142
   tracked files** were rewritten with a comma, a colon, or a period. The sweep and the gate are one
@@ -2371,7 +2541,7 @@ phase 8` passes while `Phase 8` reds). An arm keyed on a following digit was wri
 
 ## [0.0.1] - 2026-07-22
 
-The first pre-alpha release. The package begins its public history at `0.0.x`, per the cosyte version
+The first pre-alpha release. The package begins its public history at `0.0.x`, per the Cosyte version
 ladder (`0.0.x` until first alpha).
 
 ### Added
@@ -2499,7 +2669,7 @@ warnings: readonly AstmFrameWarning[] }`. A frame is `<STX> FN text <ETB|ETX> CS
   - **Modulo-256 checksum** over the bytes after `STX` up to and **including** the `ETB`/`ETX`
     terminator, two hex chars: **verified on decode, emitted uppercase, accepted lowercase** (a real
     vendor quirk). `computeChecksum` / `toChecksumHex` / `parseChecksumHex` exported.
-  - **Frame-number `0`–`7` sequencing** (rolls over `7 → 0 → 1`, starts at `1`) and **multi-frame record
+  - **Frame-number `0` to `7` sequencing** (rolls over `7 → 0 → 1`, starts at `1`) and **multi-frame record
     reassembly**: text is capped at **240 bytes** (the seven control bytes are **not** counted), `ETB`
     is intermediate / `ETX` final. `parseFramedAstm(bytes, opts?)` composes the framing and record layers
     at the edge (decode → reassemble trusted records → `parseAstmRecords`).
@@ -2535,7 +2705,7 @@ defaulted: boolean; warnings }`. A leading `STX`/`ENQ` ⇒ **framed** (serial, a
     by `ltpInitialState()`. Events are the four LTP control signals (`enq`/`ack`/`nak`/`eot`) plus a
     codec-decoded `frame`; actions are `sendAck` / `sendNak` / `sendEot` / `deliverRecord`. It models
     the LIS01-A2 establishment → transfer → termination phases as `neutral ⇄ transfer`, reassembling
-    `ETB…ETX` runs into delivered records and tracking the `0`–`7` frame sequence.
+    `ETB…ETX` runs into delivered records and tracking the `0` to `7` frame sequence.
   - **ACK-failsafe (safety-critical, borrowed from `mllp`).** A frame the codec did not vouch for (a
     **bad checksum**, an **unterminated** frame, or one **out of sequence**) is answered with `NAK`,
     **never** a fabricated positive `ACK`, and its bytes are **never** appended to a record or
@@ -2572,7 +2742,7 @@ EOT` session **reassembles exactly the source records**; a **raw-TCP stream equa
     counters, the `L` terminator) is **computed, not guessed** (a sequence number may be overridden).
   - **Frame encoder.** `composeAstmFrames(records, opts?)` is the exact inverse of `decodeAstmFrames`:
     it wraps reassembled record bytes into `<STX> FN text <ETB|ETX> CS <CR><LF>` frames with the
-    modulo-256 **checksum** and the `0`–`7` **frame number** **computed** (never accepted-as-given or
+    modulo-256 **checksum** and the `0` to `7` **frame number** **computed** (never accepted-as-given or
     faked; emitted uppercase), numbered continuously across the stream (start `1`, roll over `7 → 0`),
     and every record over **240** text bytes **split** `ETB…ETX` (the seven control bytes never counted).
     `serializeFramedAstm(msg | records)` composes both emit layers at the edge: the mirror of
@@ -2709,6 +2879,5 @@ EOT` session **reassembles exactly the source records**; a **raw-TCP stream equa
   interactive contention/timeout/retransmit **timing**) is a thin consumer adapter, and the standard's
   exact numeric timeouts / retry counts are deferred (we model transitions, not timers).
 
-[Unreleased]: https://github.com/cosyte/astm/commits/main
 [0.0.2]: https://github.com/cosyte/astm/releases/tag/v0.0.2
 [0.0.1]: https://github.com/cosyte/astm/releases/tag/v0.0.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 Cosyte
+Copyright (c) 2026 Cosyte LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal