@cosyte/astm 0.0.1 → 0.0.3

package/CHANGELOG.md

@@ -9,8 +9,63 @@ this file is maintained by hand (Changesets handles the version bump and publish
 
 ## [Unreleased]
 
-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).
+### Fixed
+
+- **The published documentation sidebar now follows the shared section order.** The shipped
+  `docs-content/sidebars.json` carried a category named "About" holding the "what it does and does not
+  do" page. That label is not one of the sections the documentation site recognises (Overview,
+  Installation, Quickstart, Core Concepts, Guides, API Reference, Troubleshooting), so `docs.cosyte.com`
+  rendered this package with a section no other `@cosyte/*` package has. The page now sits under
+  **Troubleshooting**, beside the troubleshooting guide that already links to it, matching how
+  `@cosyte/mllp` files the same page. The page's own URL is unchanged, so existing links to it still
+  resolve. Both released documentation bundles (`v0.0.1` and `v0.0.2`) carry the old layout and cannot
+  be changed, because a release asset is immutable once published; this correction reaches readers with
+  the next release.
+- **The status note no longer quotes a version number that a release makes wrong.** `README.md`,
+  `docs-content/intro.md` and `docs-content/installation.md` each opened with "published on npm at
+  `0.0.1`" while the package was at `0.0.2`. Nothing bound those sentences to the manifest, so every
+  publish falsified them, and the two documentation pages ship inside the release bundle the
+  documentation site re-fetches forever. They now say the package is published and name the `0.0.x`
+  pre-alpha ladder, and leave the exact version to the registry, where it cannot go stale. The
+  exported `VERSION` constant is unaffected: it is generated from `package.json` at release time and
+  asserted equal to it.
+
+## [0.0.2] - 2026-07-27
+
+### Fixed
+
+- **Publish status corrected across the public surface.** `@cosyte/astm` has been published on npm at
+  `0.0.1` since 2026-07-22 and the repository is public, but `README.md`, `docs-content/intro.md`, and
+  `docs-content/installation.md` each still opened with "pre-alpha (`0.0.x`), not yet published to
+  npm" (and the installation page told readers to consume the package from source instead). Those
+  three status blocks, plus the project guide, now state the real published version. The install
+  instructions no longer describe a package that does not exist.
+- **`VERSION` no longer lies about the release.** The published `0.0.1` exported `VERSION === "0.0.0"`
+  while `package.json` read `0.0.1`, which the documented install smoke test (print `VERSION`) surfaces
+  directly to an installer. The constant is corrected to `0.0.1`, `scripts/sync-version.mjs` now
+  rewrites it from `package.json` inside the release `version` script, and `test/sanity.test.ts`
+  asserts the two agree so a skipped sync fails the build instead of shipping. The declaration is now
+  annotated `: string` (matching `@cosyte/hl7`), so the emitted type is `string` rather than the
+  version literal.
+- Removed `cosyte-astm-0.0.0.tgz`, a 307 KB `pnpm pack` artifact committed to the repository root that
+  carried a stale `0.0.0` `dist/`, and added `*.tgz` to `.gitignore` so pack output cannot be
+  committed again.
+
+### Changed
+
+- The `README.md` status block is replaced by a "What it covers" summary of the record, framing and
+  transport, emit, profile, and terminology layers. Per the public-surface rule, a README describes
+  what the software does, not our internal phase numbering; the ASTM designations `E1381` and `E1394`
+  are reference material and stay. Same removal of internal cross-references a reader cannot follow
+  from `docs-content/limitations.md` and `docs-content/quickstart.md`, leaving the surrounding
+  sentences intact.
+- The released `0.0.1` entries now sit under a dated `## [0.0.1] - 2026-07-22` heading with a link to
+  its tag, instead of sitting under `[Unreleased]` behind a sentence saying `0.0.1` "will ship".
+
+## [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
+ladder (`0.0.x` until first alpha).
 
 ### Added
 
@@ -347,12 +402,6 @@ 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).
 
-### Deprecated
-
-### Removed
-
-### Fixed
-
-### Security
-
 [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/README.md

@@ -8,39 +8,42 @@ parser that turns real-world, vendor-quirky input into **warnings** rather than
 a serializer that always emits spec-clean output (Postel's Law). It mirrors the API shape of the
 reference parser, [`@cosyte/hl7`](https://github.com/cosyte/hl7).
 
-> **Status:** pre-alpha (`0.0.x`), not yet published to npm. Phase 1 ships the **record** layer
-> (`H`/`P`/`O`/`R`/`L` read, delimiter self-declaration, escape decode); Phase 2 adds **safety-critical
-> result semantics** — HL7 Table 0078 abnormal flags, result status (with correction `C` / cancel `X`),
-> reference-range parsing, and the units-absent discipline; Phase 3 adds **identity depth, comments, and
-> timestamp hardening** — the three distinct patient IDs, mother's maiden name, full order fields, the
-> `C` comment record attached by position (orphans surfaced, never dropped), and partial timestamps
-> preserved and flagged, never zero-filled. Phase 4 adds the **`Q` request-information record + the
-> host-query flow** (a `Q`-bearing message is classified a request, **never** read as a result set) and
-> the **`M`/`S` records surfaced verbatim** (vendor QC/calibration data, never interpreted into clinical
-> fields) — the **record-content layer is now feature-complete**. Phase 5 adds the **E1381/CLSI-LIS01
-> frame codec**: `decodeAstmFrames` decodes a framed byte stream into frames + reassembled record
-> bytes, **verifies the modulo-256 checksum** (a bad frame is surfaced untrusted and never merged),
-> tracks **frame-number sequencing** (a gap is never silently bridged), and **reassembles** the
-> 240-byte-limited multi-frame records; `parseFramedAstm` composes the framing and record layers at the
-> edge. Phase 6 adds the **transport layer**: `detectFraming` auto-detects framed (serial / cobas 4800 /
-> Iguana) vs raw (cobas b121, framing dropped) streams, and `ltpReduce` is a **pure, socket-free**
-> receiver-side `ENQ`/`ACK`/`NAK`/`EOT` state machine whose one rule mirrors `mllp`'s ACK-failsafe — a
-> bad-checksum frame is **NAK**ed, never falsely **ACK**ed. Phase 7 adds the **spec-clean serializers +
-> builders** — `serializeAstmRecords` / `buildAstmMessage` emit canonical `H|\^&` records (embedded
-> delimiters re-escaped, nothing clinical fabricated) and `composeAstmFrames` / `serializeFramedAstm`
-> frame them with **computed** checksums + frame numbers and the 240-byte split, so both layers
-> round-trip by construction. Phase 8 adds the vendor **profile** system — `defineAstmProfile()` builds
-> a provenance-backed profile whose quirk tolerances downgrade _expected_, non-safety-critical
-> deviations to a `PROFILE_QUIRK_APPLIED` warning (values are never altered), guarded by a
-> definition-time safety gate that refuses to tolerate any result value / flag / status / range /
-> units, patient or comment context, message-kind, or frame / LTP integrity warning — a profile can
-> never make a bad checksum "ok" or a cancelled result read "final." Named per-vendor profiles are
-> deferred pending a public vendor-attributed quirk document. Phase 9 adds **LIVD-aware LOINC
-> recognition** — `applyLivd(msg, catalog)` maps an analyzer's local test code to a standard **LOINC**
-> from a **consumer-supplied** IICC LIVD catalog (`defineLivdCatalog`), as an **additive, advisory**
-> annotation that never mutates the raw code/value and **never guesses a LOINC** (an unmapped or
-> ambiguous code surfaces as such). No LOINC / SNOMED / LIVD dictionary is bundled — the package stays a
-> structural recognizer, and the consumer brings their own catalog.
+> **Status:** published on npm, on the pre-alpha `0.0.x` ladder. Both layers are
+> feature-complete, but the public surface can still change within `0.0.x`, before `0.1.0`.
+
+## What it covers
+
+- **Records (E1394 / LIS02-A2).** `H`/`P`/`O`/`R`/`C`/`Q`/`M`/`S`/`L` are read with per-header
+  delimiter self-declaration and escape decode, so an escaped delimiter inside a value reads as one
+  component. Result semantics are modeled and fail-safe: HL7 Table 0078 abnormal flags, result status
+  (a correction `C` or cancel `X` never reads as active-final), reference ranges kept verbatim, and a
+  missing unit flagged rather than defaulted. The practice-, laboratory-, and third patient IDs stay
+  distinct; a `C` comment attaches to its parent by position and an orphan is surfaced, never dropped;
+  a partial timestamp is preserved and flagged, never zero-filled. A `Q`-bearing message is classified
+  as a host query and is never read as a result set, and `M`/`S` vendor QC and calibration records are
+  surfaced verbatim rather than interpreted into clinical fields.
+- **Framing and transport (E1381 / LIS01-A2).** `decodeAstmFrames` turns a framed byte stream into
+  frames plus reassembled record bytes: it verifies the modulo-256 checksum (a bad frame is surfaced
+  untrusted and never merged), tracks frame-number sequencing (a gap is never silently bridged), and
+  reassembles the 240-byte-limited multi-frame records. `detectFraming` routes framed streams (serial,
+  cobas 4800, Iguana) from raw ones (cobas b121, framing dropped), and `ltpReduce` is a pure,
+  socket-free `ENQ`/`ACK`/`NAK`/`EOT` receiver state machine that NAKs a frame the codec did not vouch
+  for rather than fabricating an ACK. `parseFramedAstm` composes both layers at the edge.
+- **Emit.** `serializeAstmRecords` and `buildAstmMessage` emit canonical `H|\^&` records with embedded
+  delimiters re-escaped and nothing clinical fabricated; `composeAstmFrames` and `serializeFramedAstm`
+  frame them with computed checksums, frame numbers, and the 240-byte split. Both layers round-trip by
+  construction.
+- **Vendor profiles.** `defineAstmProfile()` builds a provenance-backed profile whose tolerances
+  downgrade _expected_, non-safety-critical deviations to a `PROFILE_QUIRK_APPLIED` warning without
+  ever altering a value, behind a definition-time safety gate that refuses to tolerate any result
+  value, flag, status, range, or units warning, any patient or comment context, any message-kind
+  ambiguity, and any frame or transport integrity warning. A profile can never make a bad checksum
+  "ok" or a cancelled result read "final." Named per-vendor profiles await a public,
+  vendor-attributed quirk document.
+- **Terminology, bring your own.** `applyLivd(msg, catalog)` maps an analyzer's local test code to a
+  LOINC from a consumer-supplied IICC LIVD catalog as an additive, advisory annotation that never
+  mutates the raw code or value and never guesses a LOINC. No LOINC, SNOMED, or LIVD dictionary is
+  bundled: the package stays a structural recognizer and you bring the catalog.
 
 ## Decode a framed byte stream
 

package/dist/index.cjs

@@ -1972,7 +1972,7 @@ function concatBytes3(chunks) {
 }
 
 // src/index.ts
-var VERSION = "0.0.0";
+var VERSION = "0.0.3";
 
 exports.ALL_ASTM_WARNING_CODES = ALL_ASTM_WARNING_CODES;
 exports.ASTM_ACK = ACK;