@cosyte/mllp 0.0.3 → 0.0.4

package/CHANGELOG.md

@@ -110,6 +110,26 @@ begins its public history at `0.0.x`, per the cosyte version ladder (`0.0.x` unt
   `InMemoryTransport.pair()`; the receive example's fictional `respond`/`buildAck` → the real
   `createServer({ onMessage })`). Bumps the `@cosyte/vitest-config` devDependency to `^0.0.2` for the
   `/snippets` export. Docs and tests only: no runtime or public-API change.
+- **README header swapped from the per-package banner to the shared Cosyte lockup.** Both sides of
+  this swap happened inside one unreleased window, so no published version carries the banner and
+  the release notes for this version describe only the lockup. It is recorded here, where build
+  history belongs, rather than dropped. The banner
+  (`cosyte-banner-mllp-1200x300.png`) baked the package name and its one line summary into the
+  artwork, and the `# @cosyte/mllp` H1 and the blockquote directly beneath it repeat both, so the
+  same two strings appeared three times in the first four lines of the page. The header is now a
+  `<picture>` carrying the theme-aware Cosyte lockup tile (`cosyte-lockup-tile-on-dark-1200x300.png`
+  and its `-on-light` counterpart), which reads "Cosyte" rather than the package name, so the
+  duplication goes and the heading stays untouched. The `<picture>` element was deliberately avoided
+  when the banner landed, on the grounds that npm sanitizer behaviour was unverified; that has since
+  been verified rather than assumed. On GitHub in dark mode `currentSrc` resolves to the on-dark tile
+  with parent element `PICTURE`, and on npm the `<img>` is hoisted out of the `<picture>` by GitHub's
+  anchor wrapper so the light fallback renders, which is the correct cut there because npmjs.com has
+  no dark mode. The block was copied programmatically out of `hl7`'s README rather than retyped, and
+  both URLs were fetched live (`200 image/png`) rather than trusted from the stored
+  `published-urls.json` declaration, since a typo in either is a 404 on a public package page. The
+  alt text now describes the artwork rather than the package, because a screen reader on the npm page
+  should hear what the image is and the package summary is already the next line. Docs only: no
+  runtime or public-API change.
 - **`docs-content/installation.md` publish-status note corrected (README-ORG-SWEEP).** The Status
   callout said the package was "not yet published to npm" and that the install command was "the shape
   it will take at first publish": stale now that `@cosyte/mllp` is published on npm at `0.0.1` and

package/README.md

@@ -1,3 +1,8 @@
+<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>
+
 # @cosyte/mllp
 
 > Send and receive HL7 v2 over a production-grade MLLP connection in a few lines, with framing, ACK correlation, auto-reconnect, and backpressure handled for you.
@@ -23,8 +28,15 @@ pnpm add @cosyte/mllp
 ```ts
 import { createStarterServer } from "@cosyte/mllp";
 
-// Echoes every received frame straight back as the ACK.
-const server = await createStarterServer({ port: 2575, onMessage: (buf) => buf });
+// Auto-ACK is on by default: the server awaits your handler (the durable-commit
+// step) before it answers, so a positive ACK can never precede the commit.
+// A throw answers a negative ACK instead.
+const server = await createStarterServer({
+  port: 2575,
+  onMessage: async (payload) => {
+    await db.commit(payload);
+  },
+});
 ```
 
 ```ts
@@ -48,7 +60,7 @@ const server = createServer({ tls: { cert: certPem, key: keyPem } });
 await server.listen(2575, "127.0.0.1");
 
 // Server: mutual TLS (ATNA ITI-19)
-const server = createServer({
+const mutualTlsServer = createServer({
   tls: { cert: certPem, key: keyPem, ca: clientCaPem, clientAuth: "MUST" },
 });
 ```
@@ -58,7 +70,7 @@ const server = createServer({
 const client = createClient({ host: "mllp.example.com", port: 2575, tls: { ca: caPem } });
 
 // Client: mutual TLS
-const client = createClient({
+const mutualTlsClient = createClient({
   host: "mllp.example.com",
   port: 2575,
   tls: { ca: caPem, cert: clientCertPem, key: clientKeyPem },
@@ -84,7 +96,11 @@ const server = createServer({
 });
 ```
 
-Handler resolves ⇒ `AA`. Handler throws ⇒ `AE` (or `AR` via `MllpAckError`). **A positive ACK cannot
+Handler resolves ⇒ `AA`, **unless the inbound could not carry a correlatable positive ACK** (no
+readable `MSH`, an empty `MSH-10`, a batch or concatenated payload, or trailing bytes the framer
+discarded). In that case the commit still happened, but the ACK is downgraded to `AE` and a `nack`
+event names the reason, because a positive ACK the sender cannot match is one it will resend.
+Handler throws ⇒ `AE` (or `AR` via `MllpAckError`). **A positive ACK cannot
 precede a successful commit.** `autoAck: 'AA'` *without* a handler is documented as a
 transport-accept: "received and framed", not "processed".
 

package/dist/index.cjs

@@ -3412,7 +3412,7 @@ async function createStarterClient(opts) {
 }
 
 // src/index.ts
-var VERSION = "0.0.3";
+var VERSION = "0.0.4";
 
 exports.Connection = Connection;
 exports.FrameReader = FrameReader;