@cosyte/x12 0.1.1 → 0.1.3

package/CHANGELOG.md

@@ -1,11 +1,37 @@
 # Changelog
 
-All notable changes to `@cosyte/x12` will be documented in this file.
+## 0.1.3
 
-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).
+### Patch Changes
 
-## [Unreleased]
+- 17bdb42: Fixed three doc errors: three type comments gave the 835 remit balance with the PLB amounts added, where the parser and `build835` subtract them, the PLB adjustment type said its reason code held the whole composite, and the README named `parseDocumentDate`, which the package does not export.
+
+  The remit balance now reads BPR-02 equals the sum of the claim payments (CLP-04) minus the sum of the PLB amounts, each in its raw sign, on `X12Decimal`, `X12RemitPaymentHeader`, and `X12RemitProviderAdjustment`. The claim and service-line balances on `X12Decimal` and `X12RemitServiceLine` now match the checks too. `X12RemitProviderAdjustment` now says `reasonCode` is the first component of the PLB reason composite (`WO`) and `subCode` the second (`123456`), as the parser stores them. The README, the cookbook, and the date conversion comments now name `checkCarcValidity` and `checkRarcValidity`, the exported date-aware queries that throw an `X12CodeListError` on a document date they refuse. No code, type, or behavior changes.
+
+- dca2a3b: The README and documentation now use US spelling and serial commas, and write pauses without spaced hyphens.
+
+  The README's Status section names the 0.1 release line instead of an exact version, and the version script keeps that line current when a new minor line opens. The README states the Node.js support as 22 or later and tested on 22 and 24, links the license and trademarks files by absolute URL, and points at the organization's contributing guide and code of conduct. Every documentation page now carries a description, page titles say "and" instead of "&", and the sidebar category reads "Core concepts". No code, type, or behavior changes.
+
+## 0.1.2
+
+### Patch Changes
+
+- Doc comments now write number ranges with "to" instead of an en dash.
+
+## 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 0.1.2
+section was filled in from that release's GitHub release notes when generation was turned on, since
+0.1.2 shipped while this file was still kept by hand and it was never written here.
+
+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. Two
+things were dropped: the preamble above it, which said the file was kept by hand, and an empty
+`[Unreleased]` heading. The `[0.1.0]` section holds every entry written before the first 0.1
+release, the `0.0.x` releases included, which the file never recorded one by one.
 
 ## [0.1.1] - 2026-10-07
 
@@ -1952,7 +1978,7 @@ required control number and this builder never invents one, so nothing is emitte
   composite. Escaping against a guessed delimiter set is a value corruption rather than a safe
   default: `unescapeRelease` preserves `?X` verbatim for any `X` outside the reader's declared set,
   so a value released against the wrong delimiter comes back carrying a stray `?`. The defaults are
-  unchanged and are the cosyte archetype, which this function cannot verify, so state the separators
+  unchanged and are the Cosyte archetype, which this function cannot verify, so state the separators
   if you embed a TA1 in an envelope that declares different ones.
 
   **A non-string element now refuses** with `AckBuildError` and the existing `X12_ACK_INVALID_SPEC`
@@ -3043,7 +3069,7 @@ string, …` - which `esc` cannot, being unary.
 
 - **Em-dash brand gate in CI (`scripts/check-no-emdash.sh`, `pnpm check:no-emdash`,
   `.github/workflows/no-emdash.yml`; `EMDASH-CONFORMANCE`).** The founder directive of 2026-07-24
-  (`knowledgebase/06-brand/voice-and-tone.md`) bans `U+2014` outright across every cosyte surface
+  (`knowledgebase/06-brand/voice-and-tone.md`) bans `U+2014` outright across every Cosyte surface
   and names commit messages explicitly, and the meta-repo's `documentation/conventions.md` has
   described the rule as CI-gated; x12 was one of the repos where it was not. This ports
   `knowledgebase`'s scanner (the text-only variant, correct here because x12 tracks no binaries:
@@ -3138,7 +3164,7 @@ string, …` - which `esc` cannot, being unary.
 ### Added
 
 - **Trademark notice (`TRADEMARKS.md`).** This package names third-party systems to describe what it
-  interoperates with; the notice records that cosyte is not affiliated with, endorsed by, or
+  interoperates with; the notice records that Cosyte is not affiliated with, endorsed by, or
   sponsored by any of them, that every reference is descriptive, and that the built-in profiles are
   authored from public sources only. Added to `files` so it ships inside the published tarball, not
   just on GitHub. Documentation only, no runtime or API change.
@@ -3792,7 +3818,7 @@ EV/SS`), and HL-04 has-child flag from the nested input tree, so an
     helper). The `X12ClaimNote` JSDoc explicitly flags NTE-02 as
     PHI-bearing (provider-supplied free text). Every Phase 5 fixture
     is synthetic (test names `TEST PATIENT` / `SUB LAST` / `PATIENT
-CHILD`; sequential member IDs `MEMBER001`–`MEMBER011` etc.; NPI-
+CHILD`; sequential member IDs `MEMBER001` to `MEMBER011` etc.; NPI-
     shaped sequential numbers; obvious test addresses) and matches
     the established 835 fixture conventions.
   - **Known limitations after this phase** (deliberate v1 scope; none
@@ -3980,7 +4006,7 @@ refresh:code-lists` arrives in Phase 10); no per-payer profile
 
 - **Phase 3: 999 + TA1 acknowledgments (TR3 005010X231A1).** Two
   pure-function ack surfaces ship side-by-side; neither auto-sends, opens
-  a socket, or touches the filesystem. The cosyte ack archetype: the
+  a socket, or touches the filesystem. The Cosyte ack archetype: the
   library MECHANICALLY builds the disposition it is told and REFUSES to
   fabricate an Accept against a non-empty error list. Mirrors hl7's
   upcoming `buildAck` boundary and mllp's commit-contract pattern.
@@ -4001,7 +4027,7 @@ refresh:code-lists` arrives in Phase 10); no per-payer profile
     a TA1 inside an open functional group is still flagged as unexpected
     (non-spec). `parseTA1(interchange)` returns the typed `X12AckTA1`
     for the first captured TA1 (or `undefined`). `buildTA1(spec)` emits
-    a fixed-position 5-element `Ta1Segment` (`TA101`–`TA105`). Caller
+    a fixed-position 5-element `Ta1Segment` (`TA101` to `TA105`). Caller
     wraps it in their preferred envelope. Both standalone TA1-only
     interchanges (ISA → TA1 → IEA, no GS) and embedded TA1s round-trip.
   - **Safety guards (refused via `AckBuildError`):** `build999` refuses
@@ -4020,7 +4046,7 @@ refresh:code-lists` arrives in Phase 10); no per-payer profile
     `IK3_SYNTAX_ERROR_CODES` (code list 716, 13 codes),
     `IK4_SYNTAX_ERROR_CODES` (code list 723, 18 codes),
     `TA1_ACK_CODES` (code list I13: `A`/`E`/`R`),
-    `TA1_NOTE_CODES` (code list I18: `000`–`028`). String-literal
+    `TA1_NOTE_CODES` (code list I18: `000` to `028`). String-literal
     unions are exported for exhaustive narrowing. The helper
     `isAcceptDisposition(code)` returns true for `A`/`E`/`P` and false
     for the four reject codes.
@@ -4165,7 +4191,7 @@ safety` test blocks assert no SSN / ISO-date / long-digit-run
 
 ### Changed
 
-- Migrated onto the shared cosyte engineering standard (Phase E). The toolchain
+- Migrated onto the shared Cosyte engineering standard (Phase E). The toolchain
   is now inherited from the published `@cosyte/*` config packages instead of
   per-repo copies: `tsup.config.ts` uses `cosyteTsup`, `vitest.config.ts` uses
   `cosyteVitest`, and `eslint.config.js` is the three-line `cosyte` wrapper.

package/KNOWN-LIMITATIONS.md

@@ -672,7 +672,7 @@ model.
     nothing else - `buildTA1` still emits no terminator. Escaping against a guessed set is a value
     corruption rather than a safe default: `unescapeRelease` preserves `?X` verbatim for any `X`
     outside the declared set, so a value released against the wrong delimiter comes back carrying a
-    stray `?`. **The defaults are the cosyte archetype and this function cannot verify them** - if
+    stray `?`. **The defaults are the Cosyte archetype and this function cannot verify them** - if
     you embed a TA1 in an envelope that declares different separators, state them.
   - **A non-string element now REFUSES** with `AckBuildError` / `X12_ACK_INVALID_SPEC`, and that is a
     prerequisite rather than a bonus. Releasing a value means routing it through the escape helper,
@@ -1555,7 +1555,7 @@ N-char spec limit` refusal, one per emitting module, where the branch fires **be
   2. **Whether an `X12Decimal` carries the SCALE you meant.** `fromString("0.3")` and
      `fromString("0.30")` are both accepted and both emit verbatim. That choice is yours.
   3. **The delimiter set `buildTA1` releases against**, per the paragraph above. It defaults to the
-     cosyte archetype and the function cannot verify it; state the separators on `BuildTA1Options`
+     Cosyte archetype and the function cannot verify it; state the separators on `BuildTA1Options`
      if you embed a TA1 in an envelope that declares different ones.
   4. **`build835`'s balance-equation amounts, which refuse UNTYPED.** `build835` runs its balance
      guard before it builds the escape helper, and that guard calls `X12Decimal` methods on your
@@ -1874,10 +1874,10 @@ N-char spec limit` refusal, one per emitting module, where the branch fires **be
     applied and this package applies none.
 - **No transport.** AS2, SFTP, and MLLP-style delivery are out of scope. This is a parser/serializer,
   not a communications stack.
-- **Published, still pre-alpha.** The package is published on npm as `@cosyte/x12` from a public
-  repo, but it stays on the `0.0.x`-until-first-alpha ladder. `npm view @cosyte/x12 version` is the
-  only source of truth for the current version, so this page does not restate one. Treat the API as
-  pre-alpha and pin the exact version until the first alpha.
+- **Below 1.0.** The package is published on npm as `@cosyte/x12` from a public repo, at `0.1`. Its
+  exported readers, builders, types 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.
+  `npm view @cosyte/x12 version` is the only source of truth for the current version.
 - **A 276 hierarchical level whose declared parent does not resolve is left off the returned tree.**
   The 276 reader attaches a level by its own HL-02 and by nothing else, so a pointer naming a level
   that is not present, a pointer naming a level of the wrong kind, and a parent chain that returns

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

package/README.md

@@ -7,11 +7,11 @@
 
 # @cosyte/x12
 
-> Read the money out of an 835, an 837 or a 271 without a TR3 open on your desk.
+> Read the money out of an 835, an 837, or a 271 without a TR3 open on your desk.
 
 [![npm version](https://img.shields.io/npm/v/@cosyte/x12.svg)](https://www.npmjs.com/package/@cosyte/x12)
 [![CI](https://img.shields.io/github/actions/workflow/status/cosyte/x12/ci.yml?branch=main&label=CI)](https://github.com/cosyte/x12/actions/workflows/ci.yml)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/cosyte/x12/blob/main/LICENSE)
 [![Node](https://img.shields.io/badge/node-%3E%3D22-brightgreen.svg)](https://nodejs.org)
 
 Developer-focused ASC X12 healthcare EDI parser, serializer, and builder for Node.js and TypeScript: lenient on parse, spec-clean on emit.
@@ -20,7 +20,7 @@ Developer-focused ASC X12 healthcare EDI parser, serializer, and builder for Nod
 
 Reading an X12 healthcare transaction correctly normally means buying the TR3 implementation guide
 for it and then hand-mapping element positions that no compiler will ever check. This library
-removes that step for the engineer who has one 835 to post, one 271 to answer or one 837 to send,
+removes that step for the engineer who has one 835 to post, one 271 to answer, or one 837 to send,
 and who needs the amounts to be exactly right rather than approximately right. The nearest
 alternatives are a general-purpose EDI translator, which frames segments correctly but knows nothing
 about what CLP-04 means, and a hand-rolled split on the segment terminator, which works until the
@@ -31,12 +31,12 @@ a stable code instead of failing or guessing.
 
 ## Status
 
-**Version 0.1.1**, published on npm from a public repository.
+**The 0.1 line**, published on npm from a public repository.
 
-From `0.1.0` the public API is settled and safe to depend on: the exported readers, builders,
+On the 0.1 line the public API is settled and safe to depend on: the exported readers, builders,
 types and warning codes are the surface we keep stable, and the warning registry only ever gains
 codes. Below 1.0 a breaking change bumps the minor version and is called out in the changelog with
-its migration. On a `0.0.x` version, pin an exact version rather than a range. Typed read and typed
+its migration. On an older 0.0 release, pin an exact version rather than a range. Typed read and typed
 emit both ship for every transaction set
 this package covers: 270, 271, 276, 277 and 277CA, 278 request and response, 820, 834, 835, 837P,
 837I and 837D, 999 and TA1, each with a reader and a matching domain builder, and the two claims
@@ -60,7 +60,8 @@ pnpm add @cosyte/x12
 
 `npm install @cosyte/x12` and `yarn add @cosyte/x12` work the same way.
 
-Node `>=22.0.0` is the engine floor, and there are zero runtime dependencies. The package ships
+Node.js 22 or later, tested on 22 and 24: the engine floor is `>=22.0.0`, and there are zero
+runtime dependencies. The package ships
 dual ESM and CJS builds with type declarations for both conditions, so `import` and `require` each
 resolve to the artifact meant for them.
 
@@ -68,7 +69,7 @@ resolve to the artifact meant for them.
 
 Parse an 835 remittance advice and read the money: the payment total, the claim's
 charge/paid/patient-responsibility split, and the adjustment reason behind the difference. The
-interchange below is synthetic, with a fabricated payer, provider, patient and amounts.
+interchange below is synthetic, with a fabricated payer, provider, patient, and amounts.
 
 ```ts runnable
 import { parseX12, get835 } from "@cosyte/x12";
@@ -159,11 +160,11 @@ copy of the start of the input, so on real traffic it can carry PHI, and it is n
 `err.code` and `err.position` instead, or redact at your call site.
 
 **An attachment refuses to print.** The data of each BDS a 275 carries is read into
-`X12AttachmentData`, whose string, JSON and `util.inspect` forms state its octet count and nothing
+`X12AttachmentData`, whose string, JSON, and `util.inspect` forms state its octet count and nothing
 else; `readOctets()` is the one route to the octets.
 
 **Builder refusals are a weaker surface, deliberately.** A `build*` refusal names the control
-number, count or code you passed in, so that you can see what was refused. The rendered fragment is
+number, count, or code you passed in, so that you can see what was refused. The rendered fragment is
 bounded by an exported constant, but it is bounded rather than redacted. The two attachments
 builders are the exception and name no value at all. Log `err.code`, not `err.message`, from a
 builder.
@@ -179,13 +180,12 @@ Everything ships from one entry point; there are no subpath imports.
   transaction set into a typed one (`get835`, `get837Claims`, `get270Inquiry`, `get271Eligibility`,
   `get276StatusInquiry`, `parse999`, `parseTA1`, and the rest).
 - **Emit.** `serializeX12` and `buildInterchange` are the general path, and every transaction set
-  with a reader also has a domain builder (`build835`, `build837P`, `build271`, and the rest) that
-  layers that guide's own invariants on top.
+  with a reader also has a domain builder (`build835`, `build837P`, `build271`, and the rest).
 - **Errors and warnings.** Parsing is lenient, and only **four** structural failures are ever fatal
   (`X12_NO_ISA_HEADER`, `X12_ISA_TOO_SHORT`, `X12_INVALID_DELIMITERS`, `X12_EMPTY_INPUT`).
   Everything else arrives on `ix.warnings` as a stable code with positional context, so a tolerated
   deviation is visible rather than silent.
-- **Money.** Every monetary, percent and quantity field decodes as `X12Decimal`, which is
+- **Money.** Every monetary, percent, and quantity field decodes as `X12Decimal`, which is
   string-backed with BigInt arithmetic, and this library never **`parseFloat`s** an EDI amount. A
   slot the sender left empty reads `undefined` rather than zero, so "stated zero" and "stated
   nothing" stay different readings.
@@ -202,7 +202,7 @@ Task-oriented recipes are in the [cookbook](./docs-content/cookbook.md), and
 ### Dates and times
 
 Every typed reader surfaces its dates verbatim, as the qualifier the sender used plus the bytes it
-carried. `toObject`, `toISO` and `toDate` are the three ways to read one, and every `@cosyte/*`
+carried. `toObject`, `toISO`, and `toDate` are the three ways to read one, and every `@cosyte/*`
 parser exports the same three names with the same shapes and the same timezone rule.
 
 ```ts
@@ -248,10 +248,10 @@ than the JavaScript `Date` 0 to 11, so `Object.keys()` of the result tells you t
 `DateTime.fromObject` with no renaming. Neither library is a dependency here; this package still has
 zero of those.
 
-`parseDocumentDate`, which reads the document date for the date-aware code-list queries, keeps its
-own contract and still THROWS on input it refuses. That divergence is deliberate: it answers a
-caller who asked a validity question and could not state the day, while these three read a document
-that was already parsed leniently.
+The date-aware code-list queries, `checkCarcValidity` and `checkRarcValidity`, keep their own
+contract and still THROW an `X12CodeListError` on a document date they refuse. That divergence is
+deliberate: they answer a caller who asked a validity question and could not state the day, while
+these three read a document that was already parsed leniently.
 
 #### Using two @cosyte parsers in one file
 
@@ -270,13 +270,13 @@ A namespace import works too: `import * as x12 from "@cosyte/x12"`, then `x12.to
 ## Compatibility
 
 - **005010 HIPAA transaction sets**, with hooks for the errata revisions the industry actually
-  exchanges. Non-healthcare sets such as 850, 856, 810 and 204, plus EDIFACT, AS2 and SFTP
+  exchanges. Non-healthcare sets such as 850, 856, 810, and 204, plus EDIFACT, AS2, and SFTP
   transport, and pre-005010 revisions, are out of scope.
 - **Vendor deviations become warnings, not exceptions.** Built-in profiles record whose
   companion-guide deviation they accommodate; selecting one never changes an otherwise correct
   parse, and profiles are authored through the same public `defineProfile()` API you have.
 - **Round trips are not byte-exact in general.** `serializeX12` reproduces the segments on the model
-  verbatim, including element padding, composites and `?`-release escapes, but
+  verbatim, including element padding, composites, and `?`-release escapes, but
   **`serialize(parse(s)) === s` is not guaranteed in general**. Line breaks between segments are the
   common case: any run of CR or LF between segments is absorbed at parse, so a pretty-printed file
   emits compact. Most of the constructs that break a round trip are silent, so "my file has no line
@@ -285,23 +285,25 @@ A namespace import works too: `import * as x12 from "@cosyte/x12"`, then `x12.to
 
 ## Contributing
 
-Questions, bug reports and trading-partner quirks all belong in
+Questions, bug reports, and trading-partner quirks all belong in
 [GitHub issues](https://github.com/cosyte/x12/issues).
 
-Pull requests are welcome. A contribution must clear `pnpm typecheck`, `pnpm lint` and `pnpm test`,
+Pull requests are welcome. The organization's
+[contributing guide](https://github.com/cosyte/.github/blob/main/CONTRIBUTING.md) and
+[code of conduct](https://github.com/cosyte/.github/blob/main/CODE_OF_CONDUCT.md) apply here. A contribution must clear `pnpm typecheck`, `pnpm lint`, and `pnpm test`,
 hold the per-directory coverage floors, pass the PHI commit gate (`pnpm phi-scan`) and the prose
 gates (`pnpm check:no-emdash`, `pnpm check:no-internal-refs`), and carry a changeset. Every fixture
 must be synthetic: never open a pull request carrying a real patient's data.
 
 ## Trademarks
 
-Availity and Blue Cross Blue Shield are trademarks of their respective owners. cosyte is not
+Availity and Blue Cross Blue Shield are trademarks of their respective owners. Cosyte is not
 affiliated with, endorsed by, or sponsored by any of them. The names identify the trading partners
 whose companion-guide deviations the built-in profiles accommodate. See
-[TRADEMARKS.md](./TRADEMARKS.md).
+[TRADEMARKS.md](https://github.com/cosyte/x12/blob/main/TRADEMARKS.md).
 
 ## License
 
-MIT, copyright Cosyte. See [LICENSE](./LICENSE).
+MIT, Copyright (c) 2026 Cosyte LLC. See [LICENSE](https://github.com/cosyte/x12/blob/main/LICENSE).
 
 Built by [Cosyte](https://cosyte.com).

package/TRADEMARKS.md

@@ -1,6 +1,6 @@
 # Trademarks
 
-`@cosyte/x12` is an independent open-source project. cosyte is **not affiliated with, endorsed by,
+`@cosyte/x12` is an independent open-source project. Cosyte is **not affiliated with, endorsed by,
 or sponsored by** any company named in this repository or its documentation.
 
 ## Why these names appear

package/dist/index.cjs

@@ -15395,7 +15395,7 @@ var profiles = Object.freeze({
 });
 
 // src/index.ts
-var VERSION = "0.1.1";
+var VERSION = "0.1.3";
 
 exports.AAA_CONDITION_LEVELS = AAA_CONDITION_LEVELS;
 exports.AAA_FOLLOW_UP_ACTION_CODES = AAA_FOLLOW_UP_ACTION_CODES;