From bbeaeb58bcb31ddc5584707c7494195f2e5d8148 Mon Sep 17 00:00:00 2001 From: Noah Schatz Date: Wed, 7 Oct 2026 23:55:30 +0000 Subject: [PATCH 1/2] Write Cosyte with a capital C in the parser archetype prose Five prose lines named the brand in lowercase: the README's archetype heading, its table-of-contents entry and paragraph, docs-content/intro.md and docs-content/spec-notes-tolerance.md. The README anchor #the-cosyte-parser-archetype is unchanged, since GitHub lowercases it. The operator, in their own words: "Uppercased C on Cosyte everywhere. Fix any location that has it as lowercase" The launch-ready name search now gives its cli-subcommand exclusion a word boundary, so prose such as "cosyte parser" no longer passes as the cli binary. Identifiers are unchanged: the @cosyte scope, cosyte/ paths, heading anchors and URLs. Claude-Session: https://claude.ai/code/session_011dC8vE9axM3hqC8rNEX3W9 --- README.md | 6 +++--- docs-content/intro.md | 2 +- docs-content/spec-notes-tolerance.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b0bdd7e..9f461d2 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ C-CDA parser, serializer, and builder for Node.js and TypeScript, lenient on par - [Edit a document](#edit-a-document) - [Code systems & provenance](#code-systems--provenance) - [Known limitations](#known-limitations) -- [The cosyte parser archetype](#the-cosyte-parser-archetype) +- [The Cosyte parser archetype](#the-cosyte-parser-archetype) - [Contributing](#contributing) - [License](#license) @@ -1400,9 +1400,9 @@ wired for `` emission, and neither is the section-rebuild path `edi (`ccdaProfiles.smartScorecard`, `ccdaProfiles.legacyR11`), each grounded in a cited public source; named per-vendor profiles await a real vendor-attributed grounding document. -## The cosyte parser archetype +## The Cosyte parser archetype -`@cosyte/ccda` is a near-zero-dependency TypeScript toolkit that follows the cosyte parser archetype: a +`@cosyte/ccda` is a near-zero-dependency TypeScript toolkit that follows the Cosyte parser archetype: a lenient parser that turns real-world, vendor-quirky input into **warnings** rather than failures (Postel's Law). It mirrors the API shape of the reference parser, [`@cosyte/hl7`](https://github.com/cosyte/hl7). Its single runtime dependency is diff --git a/docs-content/intro.md b/docs-content/intro.md index 590689f..f16bea6 100644 --- a/docs-content/intro.md +++ b/docs-content/intro.md @@ -8,7 +8,7 @@ sidebar_position: 1 # @cosyte/ccda Parse real-world, vendor-quirky C-CDA and pull fields out in one line, without reading the spec. -`@cosyte/ccda` is a near-zero-dependency TypeScript toolkit following the cosyte parser archetype: a +`@cosyte/ccda` is a near-zero-dependency TypeScript toolkit following the Cosyte parser archetype: a lenient parser (quirks become **warnings**, not failures: Postel's Law), an immutable model, and a spec-clean, round-trip serializer. It mirrors the API shape of the reference parser, `@cosyte/hl7`. Its single runtime dependency is the W3C-DOM substrate `@xmldom/xmldom` (exact-pinned), diff --git a/docs-content/spec-notes-tolerance.md b/docs-content/spec-notes-tolerance.md index d840366..a6eead0 100644 --- a/docs-content/spec-notes-tolerance.md +++ b/docs-content/spec-notes-tolerance.md @@ -7,7 +7,7 @@ sidebar_position: 5 # Tolerance tiers & the warning-code model -`@cosyte/ccda` follows the cosyte parser archetype's **tiered tolerance** model. Real-world C-CDA is +`@cosyte/ccda` follows the Cosyte parser archetype's **tiered tolerance** model. Real-world C-CDA is vendor-quirky; the parser is liberal on input (Postel's Law) so a deviation becomes a **warning you triage**, not an exception that halts your pipeline, while a genuinely unrecoverable or hostile document is a hard failure. From 8c1276a477dcbe9e1a0fb392b81b1e74774f5805 Mon Sep 17 00:00:00 2001 From: Noah Schatz Date: Wed, 7 Oct 2026 23:55:31 +0000 Subject: [PATCH 2/2] Bring the docs status blocks current for 0.1 docs-content/intro.md, installation.md and troubleshooting.md still said the package was "pre-alpha on the Cosyte 0.0.x version ladder". It is on npm at 0.1.0 (npm view @cosyte/ccda version), and npm install @cosyte/ccda installs in a fresh directory. Each block now states 0.1 and the policy the README states: the exported names, options, return shapes and warning codes are the surface we keep stable, and below 1.0 a breaking change bumps the minor version and is called out in the changelog with its migration. Claude-Session: https://claude.ai/code/session_011dC8vE9axM3hqC8rNEX3W9 --- docs-content/installation.md | 6 +++--- docs-content/intro.md | 8 ++++---- docs-content/troubleshooting.md | 8 ++++---- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs-content/installation.md b/docs-content/installation.md index 284c1dc..7c139ce 100644 --- a/docs-content/installation.md +++ b/docs-content/installation.md @@ -12,9 +12,9 @@ per-condition type declarations, so it works from either module system without c has a **single** exact-pinned runtime dependency: the W3C-DOM substrate `@xmldom/xmldom` (C-CDA is XML, so a DOM is unavoidable). -> **Status:** **published on npm** and **public**, still pre-alpha on the Cosyte `0.0.x` -> version ladder (`0.0.x` until first alpha). This page names no version number: run -> `npm view @cosyte/ccda version` for the current one. The install command below is live. +> **Status:** `0.1`, **published on npm** and **public**. Below 1.0 a breaking change bumps the +> minor version and is called out in the changelog with its migration. Run +> `npm view @cosyte/ccda version` for the current version. The install command below is live. ## Prerequisites diff --git a/docs-content/intro.md b/docs-content/intro.md index f16bea6..24b1a65 100644 --- a/docs-content/intro.md +++ b/docs-content/intro.md @@ -14,10 +14,10 @@ spec-clean, round-trip serializer. It mirrors the API shape of the reference par Its single runtime dependency is the W3C-DOM substrate `@xmldom/xmldom` (exact-pinned), configured XXE-safe. -> **Status:** **published on npm** and **public**, still pre-alpha on the Cosyte `0.0.x` -> version ladder (`0.0.x` until first alpha). This page names no version number: run -> `npm view @cosyte/ccda version` for the current one, which is the only answer that cannot go -> stale between releases. The parser ships +> **Status:** `0.1`, **published on npm** and **public**. The exported names, options, return +> shapes and warning codes are the surface we keep stable, and below 1.0 a breaking change bumps +> the minor version and is called out in the changelog with its migration. Run +> `npm view @cosyte/ccda version` for the current version. The parser ships > document recognition (all 12 US Realm types), the US Realm header + patient demographics, section > framing, the reconciliation triad (Problems / Medications / Allergies), the discrete-data families > (Results / Vital Signs / Immunizations) with a computable UCUM unit check, Procedures / Encounters / diff --git a/docs-content/troubleshooting.md b/docs-content/troubleshooting.md index 5ae46c2..c95dd1c 100644 --- a/docs-content/troubleshooting.md +++ b/docs-content/troubleshooting.md @@ -579,10 +579,10 @@ bug. Where a boundary is genuinely open, this page says so instead of resolving - **C-CDA R2.1, US Realm.** Other CDA templates and realms are out of the current scope. - **A parser + serializer, not a transport or a validator suite.** No MLLP/XDS delivery, no Schematron conformance report: this reads and re-emits documents. -- **Pre-alpha on the `0.0.x` ladder.** `@cosyte/ccda` is **published on npm** and **public**, but - still pre-alpha: on the `0.0.x`-until-first-alpha ladder, the API can still change. Run - `npm view @cosyte/ccda version` for the published version; no page here names it, because a - version written into prose is stale by the next release. +- **Below 1.0.** `@cosyte/ccda` is at `0.1`, **published on npm** and **public**. Its exported + names, options, return shapes and warning codes are the surface we keep stable, and below 1.0 a + breaking change bumps the minor version and is called out in the changelog with its migration. + Run `npm view @cosyte/ccda version` for the published version. For the exact fields each accessor decodes, see [Core Concepts](./spec-notes-clinical); for every export and its signature, see the API reference, which is generated from the source rather than