node-red-contrib-ntrip 0.2.10 → 0.2.11

package/doc/architecture/adr/0007-mocha-test-helper-stack.md

@@ -1,67 +0,0 @@
-# ADR-0007: Mocha + node-red-node-test-helper for the test suite
-
-## Status
-
-Accepted in 0.2.6.
-
-## Context
-
-Up to 0.2.5 the package had no automated tests — three patch releases in two
-weeks shipped regressions that an even minimal suite would have caught.
-Adding tests was overdue. Choices:
-
-- **Mocha** vs **Jest** as the runner. Mocha is the dominant choice for
-  published `node-red-contrib-*` packages; Jest's auto-mocking and snapshotting
-  add nothing this package needs.
-- **`node-red-node-test-helper`** vs **direct invocation of node factories
-  with a hand-rolled `RED` stub**. The helper spins up a real Node-RED runtime
-  in-process, loads a flow, and exposes wired nodes. A hand-rolled stub would
-  let tests run faster but would not exercise the real lifecycle hooks
-  (`registerType`, `createNode`, `node.receive`, `node.send`) — which is
-  exactly where the recent regressions lived.
-- **`chai` v4 vs v5.** v5 is ESM-only. The package is CommonJS and there is
-  no reason to move it; pin v4.
-
-## Decision
-
-- Mocha for the test runner.
-- `node-red-node-test-helper` for the in-process Node-RED runtime.
-- `chai` v4 for the assertion DSL.
-- `node-red` itself as a dev dep (required by the helper from v0.3 onwards).
-
-Tests live under `test/` with one `*.spec.js` per node. Each previously-fixed
-regression has a dedicated test tagged `(regression: …)` so they can be run
-in isolation with `mocha -g regression`.
-
-CI runs `npm test` across the existing matrix (Node 18 / 20 / 22).
-
-## Consequences
-
-**Positive**
-
-- Real Node-RED runtime — tests verify the actual `registerType` + `createNode`
-  + `node.send` path, not a stub.
-- Each spec file is small (~100 LOC) and self-contained.
-- Regression tests are explicit — visible in test names, locked in for the
-  long term.
-- CI gate prevents accidental regressions on every push.
-
-**Negative**
-
-- `node-red` is a ~400-package dev dependency tree, with some known
-  vulnerabilities (all dev-only, not reachable in the published artefact).
-- First test run is slower (~80 ms helper startup) than a unit test on plain
-  functions would be.
-- Spec authors have to learn the `helper.load(...)` + `helper.getNode(...)`
-  +`on('input', …)` pattern — slight learning curve.
-
-**Trade-offs**
-
-- Chose **realism** over **speed and small dep tree**. For four nodes with
-  tight Node-RED integration, integrating the real runtime is worth the
-  weight.
-
-## Related
-
-- Code: [test/](../../../test/) and [.github/workflows/node.js.yml](../../../.github/workflows/node.js.yml)
-- Statistics: [statistics.md](../statistics.md) "Test suite" section

package/doc/architecture/adr/0008-coordinate-gating-sentinel.md

@@ -1,76 +0,0 @@
-# ADR-0008: `(0, 0, 0)` as the "no location" sentinel for GGA emission
-
-## Status
-
-Accepted in 0.2.5.
-
-## Context
-
-Many NTRIP casters require a position fix from the client before they will
-stream corrections — they need to know which network-RTK base station to
-deliver corrections from. The standard way to convey the fix is a periodic
-NMEA `GGA` sentence from the client to the caster. The upstream `ntrip-client`
-package's `xyz` option turns on this behaviour: if `xyz` is set, a `GGA` is
-synthesised from those coordinates and sent every `interval` ms.
-
-In the editor form the user supplies three numeric fields (X / Y / Z) plus an
-interval. There needs to be a way to say "I have no location, do not send
-GGA" — for casters that *don't* require GGA, sending a synthetic one is
-unnecessary noise.
-
-Two options:
-
-1. **A dedicated checkbox / radio** (`Send periodic GGA: yes/no`).
-2. **A sentinel value** — treat `(0, 0, 0)` as "no location".
-
-Pre-0.2.5 the code used `x && y && z` as the gate, which had the wrong
-semantics — *any* zero component (e.g. someone on the equator with X≈6378km,
-Y=0, Z=0) disabled the GGA.
-
-## Decision
-
-Use `(0, 0, 0)` as the sentinel. The check is:
-
-```javascript
-if (Number.isFinite(x) && Number.isFinite(y) && Number.isFinite(z)
-    && !(x === 0 && y === 0 && z === 0)) {
-    options.xyz = [x, y, z];
-}
-```
-
-- All three must be finite — `NaN` (the result of `parseFloat('')` on an
-  empty form) does not enable GGA.
-- The all-zero triple is the only excluded value.
-- Coordinates with one or two zero components are fine — they fall through to
-  the caster.
-
-## Consequences
-
-**Positive**
-
-- One-field-fewer in the editor form.
-- Equator / axis-aligned positions work correctly.
-- Matches the convention used by other NTRIP tooling (rtklib, str2str): if
-  you don't want GGA, you set the coordinates to all zeros.
-
-**Negative**
-
-- Discoverability — a user looking at the form has no in-UI hint that
-  `(0, 0, 0)` is special. The README and the editor help text document this,
-  but a fresh user might not read either.
-- The Earth's center of mass at `(0, 0, 0)` ECEF is technically a *real*
-  position. Not a meaningful place for a GNSS receiver to be, but the sentinel
-  collides with one mathematically valid input.
-
-**Trade-offs**
-
-- Picked **minimum form surface** over **explicit toggle**. If user feedback
-  reports confusion, swap to an explicit checkbox in a future minor release
-  and keep the sentinel for backward compatibility.
-
-## Related
-
-- Code: [ntrip/nodes/ntrip-client-node.js:43-46](../../../ntrip/nodes/ntrip-client-node.js#L43-L46)
-- Editor help text: [ntrip/99-ntrip.html](../../../ntrip/99-ntrip.html) "Optional ECEF coordinate triple" block
-- README: "Notes on usage — NTRIP Client: coordinates"
-- CHANGELOG: 0.2.5 "Coordinate guard changed from `x && y && z` to `not all zero`"

package/doc/architecture/adr/README.md

@@ -1,18 +0,0 @@
-# ADR Index
-
-This folder contains Architecture Decision Records. One file per ADR, numbered
-in the order they were accepted.
-
-| # | Title | Status | Date accepted |
-|---|-------|--------|---------------|
-| [0001](0001-single-registration-file.md) | Single registration file for all nodes | Accepted | original design |
-| [0002](0002-ntrip-uploader-extension.md) | NTRIP uploader as full-replacement extension of the upstream client | Accepted | 0.2.0 |
-| [0003](0003-two-output-decoder-design.md) | Two-output `[ok, error]` convention for decoders / encoder | Accepted | original design (reaffirmed in 0.2.6) |
-| [0004](0004-stateful-handshake-interception.md) | Stateful handshake interception in the NtripClient | Accepted | 0.2.5 |
-| [0005](0005-rtcm-partial-frame-buffer.md) | Carry-over buffer for partial RTCM frames | Accepted | 0.2.5 |
-| [0006](0006-nmea-multi-sentence-split.md) | Multi-sentence splitting in the NMEA decoder | Accepted | 0.2.5 |
-| [0007](0007-mocha-test-helper-stack.md) | Mocha + node-red-node-test-helper for the test suite | Accepted | 0.2.6 |
-| [0008](0008-coordinate-gating-sentinel.md) | `(0, 0, 0)` as the "no location" sentinel for GGA emission | Accepted | 0.2.5 |
-
-See [../architecture-decisions.md](../architecture-decisions.md) for the
-template and the criteria for when to add a new ADR.

package/doc/architecture/architecture-decisions.md

@@ -1,60 +0,0 @@
-# Architecture Decisions
-
-This chapter is the index of Architecture Decision Records (ADRs). Each
-individual ADR is stored as its own markdown file under [adr/](adr/) and
-follows a compact template (Status / Context / Decision / Consequences /
-Related).
-
-## Index
-
-| # | Title | Status |
-|---|-------|--------|
-| [0001](adr/0001-single-registration-file.md) | Single registration file for all nodes | Accepted |
-| [0002](adr/0002-ntrip-uploader-extension.md) | NTRIP uploader as full-replacement extension of the upstream client | Accepted |
-| [0003](adr/0003-two-output-decoder-design.md) | Two-output `[ok, error]` convention for decoders / encoder | Accepted |
-| [0004](adr/0004-stateful-handshake-interception.md) | Stateful handshake interception in the NtripClient | Accepted |
-| [0005](adr/0005-rtcm-partial-frame-buffer.md) | Carry-over buffer for partial RTCM frames | Accepted |
-| [0006](adr/0006-nmea-multi-sentence-split.md) | Multi-sentence splitting in the NMEA decoder | Accepted |
-| [0007](adr/0007-mocha-test-helper-stack.md) | Mocha + node-red-node-test-helper for the test suite | Accepted |
-| [0008](adr/0008-coordinate-gating-sentinel.md) | `(0, 0, 0)` as the "no location" sentinel for GGA emission | Accepted |
-
-## When to add a new ADR
-
-Add one when a decision is non-obvious and would surprise a contributor reading
-the code six months from now. Typical signals:
-
-- The code does something differently from how upstream / community examples
-  do it.
-- The choice was load-bearing — reverting it would break a documented contract.
-- There is a clear trade-off (e.g. simpler code vs. larger memory footprint)
-  that future maintainers should understand before changing direction.
-
-## When *not* to add an ADR
-
-Skip the formality for routine bug fixes, refactors that don't change external
-behaviour, or decisions that are already obvious from idiomatic style. The
-goal is a small, stable archive — not a write-up of every commit.
-
-## Template
-
-```markdown
-# ADR-NNNN: Short imperative title
-
-## Status
-Proposed | Accepted | Superseded by ADR-MMMM | Deprecated
-
-## Context
-What problem are we solving? What constraints / forces are at play?
-
-## Decision
-What we are going to do, in one or two sentences.
-
-## Consequences
-- Positive: …
-- Negative: …
-- Trade-offs: …
-
-## Related
-- Code: [path/to/file.js:LL-LL](../../path/to/file.js#LLL-LLL)
-- ADRs: [[ADR-XXXX](XXXX-title.md)]
-```

package/doc/architecture/behavioural-design.md

@@ -1,226 +0,0 @@
-# Behavioural Design
-
-## Node-RED node lifecycle
-
-Every node in this package follows Node-RED's standard lifecycle:
-
-```
-deploy / restart
-      │
-      ▼
-   constructor(config)              ← create network resources, reset counters
-      │
-      ▼
-   on('input', msg) ──── many ────► (transform / forward / write to socket)
-      │
-      ▼
-   on('close', done)                ← release resources, clear status, done()
-```
-
-The constructor receives a `config` object built from the editor form. The
-input handler is called for every message flowing into the node. The close
-handler runs on flow redeploy or Node-RED shutdown.
-
-## NtripClient — handshake state machine
-
-The `NtripClient` node intercepts the caster's first reply line and uses it to
-set its own status. Prior to v0.2.5 this check ran on **every** inbound TCP
-packet, which both inflated the message counter and risked dropping RTCM bytes
-that shared a TCP segment with the handshake reply. The current design is a
-two-state machine:
-
-```
-              start
-                │
-                ▼
-          ┌──────────────┐  data: "ICY 200 OK\r\n\r\n..."   ┌─────────────┐
-          │ disconnected │ ───────────────────────────────► │  connected  │
-          │              │  data: "ICY 406 ..."             │             │
-          │              │ ──────► error, stay disconnected │             │
-          │              │  data: "SOURCETABLE 200 OK..."   │             │
-          │              │ ──────► error, stay disconnected │             │
-          │              │  data: anything else             │             │
-          │              │ ──────► forward, transition to ─►│             │
-          └──────────────┘                                  └──────┬──────┘
-                ▲                                                  │
-                │              socket close / error                │
-                └──────────────────────────────────────────────────┘
-```
-
-Key behaviours:
-
-- **Transitional bytes are not lost.** When the handshake reply and the first
-  RTCM frame share a TCP segment (common), the node splits at the `\r\n\r\n`
-  header terminator and forwards the trailing RTCM bytes on the output.
-- **Reset on close.** The `connected` flag is set back to `false` when the
-  socket closes, so the next reconnect runs the handshake recognition again.
-- **Counters track Rx and Tx separately.** `messagesReceived` is only bumped
-  for data forwarded after handshake (not control replies). `messagesSent` is
-  bumped per input message written to the caster.
-
-See [ADR-0004](adr/0004-stateful-handshake-interception.md).
-
-## NtripClient — input handling
-
-```
-   msg.payload arrives
-       │
-       ▼
-   payload nullish? ─yes─► drop (no-op)
-       │ no
-       ▼
-   Array.isArray(payload)? ─yes─► client.setXYZ(payload)   # update GGA seed
-       │ no
-       ▼
-   client.write(payload)
-       │
-       ▼
-   node.passthrough? ─yes─► node.send(msg)                 # echo on output
-       │ no
-       ▼
-   updateStatus()
-```
-
-An `Array` payload is interpreted as a coordinate triple `[x, y, z]` and routed
-to the underlying client's `setXYZ` method — used by Sapos and other VRS
-casters that gate the stream on a `GGA` from the client. A non-array payload
-is written verbatim to the caster.
-
-## NtripClient — outbound write error handling
-
-`net.Socket.write` is asynchronous; runtime failures (ECONNRESET, EPIPE) come
-through the socket's `error` event rather than as synchronous throws. The node
-therefore has two error paths:
-
-- **Synchronous** — the try/catch around `client.write` catches misuse
-  (`client` undefined, wrong-shape payload), reports via `node.error` and
-  flashes the status badge red.
-- **Asynchronous** — the socket `error` listener calls `node.error` with the
-  same wording. `AggregateError` instances (e.g. from happy-eyeballs DNS
-  resolution failures) are expanded into one log line per inner error.
-
-## RtcmDecoder — frame reassembly across input events
-
-RTCM 3 frames are variable-length and routinely cross TCP packet boundaries.
-The decoder keeps a `pendingBuffer` on the node instance and reassembles:
-
-```
-   on('input', msg):
-       chunk = msg.payload                            (Buffer or coerced)
-       buffer = concat(pendingBuffer, chunk)
-
-       loop while buffer not empty:
-           try: [message, length] = RtcmTransport.decode(buffer)
-           on throw:
-               if buffer.length > 64KB:
-                   emit error on output 2
-                   buffer = empty
-               break   # keep remainder for next input event
-           if length not positive or > buffer.length:
-               break   # defensive zero-length guard
-           emit decoded message on output 1
-           buffer = buffer.slice(length)
-
-       pendingBuffer = buffer
-       updateStatus()
-```
-
-- **Partial-frame tolerance.** A throw is interpreted as "frame may be incomplete";
-  bytes stay in `pendingBuffer` to be re-tried with the next chunk.
-- **Garbage cap.** If `pendingBuffer` grows past 64 KB without ever decoding a
-  frame, the data is flushed to the error output and the buffer is cleared —
-  prevents runaway memory if the upstream feeds non-RTCM bytes indefinitely.
-- **Forward-progress guarantee.** A non-positive or oversized `length` from the
-  decoder breaks the loop rather than spinning.
-
-See [ADR-0005](adr/0005-rtcm-partial-frame-buffer.md).
-
-## NmeaDecoder — multi-sentence splitting
-
-A single input chunk may carry several `\r\n`-delimited sentences. The decoder
-splits and decodes each independently:
-
-```
-   on('input', msg):
-       rawInput = msg.payload.nmeaMessage ?? msg.payload   (preserved untouched)
-       rawString = Buffer? rawInput.toString('utf8') : rawInput
-
-       for each sentence in rawString.split(/\r?\n/):
-           sentence = sentence.trim()
-           skip if empty
-           try: NmeaTransport.decode(sentence) → emit on output 1
-           on throw: emit on output 2 with
-                input:       rawInput   (Buffer if Buffer was supplied)
-                inputString: rawString  (utf8 form)
-```
-
-- **`input` preservation.** The original payload (`Buffer` if a `Buffer` was
-  supplied) is carried through to the error output unchanged — restored in
-  v0.2.6 after a regression in v0.2.5 forced everything through `toString`
-  before storing.
-
-See [ADR-0006](adr/0006-nmea-multi-sentence-split.md).
-
-## NmeaEncoder — instance passthrough vs construction
-
-The encoder accepts two input shapes:
-
-- A pre-constructed `NmeaMessage*` instance — passed straight to
-  `NmeaTransport.encode` without inspection.
-- A plain field object plus a `messageType` discriminator — fed through a
-  `switch (messageType)` that maps to the right `NmeaMessage*.construct(input)`
-  factory.
-
-```
-   on('input', msg):
-       require payload, payload.nmeaMessage, payload.messageType  (else error output)
-
-       try:
-           messageType = String(payload.messageType).toUpperCase()
-           input = payload.nmeaMessage
-
-           if input instanceof NmeaMessage:
-               nmeaMessage = input
-           else:
-               nmeaMessage = NmeaMessage<Type>.construct(input)
-               unknown messageType → throw (caught and routed to error)
-
-           message = NmeaTransport.encode(nmeaMessage)
-           emit on output 1
-
-       on throw: emit on output 2 (no node.error)
-```
-
-## Two-output error routing
-
-Every decoder/encoder uses the `[ok, error]` two-output convention rather than
-calling `node.error()` for per-message failures. The reason is that high-rate
-streams routinely emit mismatched binary (the README explicitly suggests
-wiring an NMEA decoder onto an RTK2Go stream as a demonstration) — calling
-`node.error` for each failure floods the Node-RED `[error]` log. The error
-output is the channel; wire it to a debug or downstream handler.
-
-See [ADR-0003](adr/0003-two-output-decoder-design.md).
-
-## Status badge convention
-
-All four nodes follow the same rule for the badge under the node in the
-Node-RED editor:
-
-| State | Fill | Shape | Text |
-|-------|------|-------|------|
-| starting | yellow | ring | `connecting...` (NtripClient only) |
-| running | green | ring | counters, e.g. `Rx 123 Tx 4` / `NMEA: 12 Invalid: 0` |
-| connected (NtripClient) | green | ring | `NTRIP server connected.` |
-| handshake error | red | ring | `NTRIP server rejected connection.` or `No mountpoint <name>` |
-| write/decode error | red | ring | error message |
-| closed | (cleared) | — | — |
-
-## Close behaviour
-
-| Node | On `close` |
-|------|------------|
-| NtripClient | `client.removeAllListeners()`, then `client.close()`, clear status. |
-| RtcmDecoder | Discard `pendingBuffer`, clear status. |
-| NmeaDecoder | Clear status. |
-| NmeaEncoder | Clear status. |

package/doc/architecture/errors-and-weaknesses.md

@@ -1,71 +0,0 @@
-# Errors and Weaknesses
-
-This chapter inventories known limitations. Items are grouped by severity and
-labelled by status (Open / Fixed-in-vX.Y.Z / Accepted as design constraint).
-
-## Critical
-
-| ID | Description | Status |
-|----|-------------|--------|
-| C-1 | `NmeaEncoder` instance passthrough was broken (`input.prototype instanceof NmeaMessage` always false) | Fixed in 0.2.4 |
-| C-2 | `NmeaEncoder` catch block referenced an out-of-scope `input`, crashing on every encoder failure | Fixed in 0.2.4 |
-| C-3 | `NtripClient` crashed at construction when `mode` was neither `download` nor `upload` (`client.on('data',…)` on `undefined`) | Fixed in 0.2.5 |
-| C-4 | `RtcmDecoder` dropped any partial frame at TCP packet boundaries (no carry-over) | Fixed in 0.2.5 |
-| C-5 | `NmeaDecoder` only decoded the first sentence of a multi-sentence chunk despite documentation claiming otherwise | Fixed in 0.2.5 |
-| C-6 | `NmeaDecoder` and `RtcmDecoder` called `node.error()` for every decode failure — flooded the Node-RED log when fed mismatched binary (the README's own demo wiring) | Fixed in 0.2.6 |
-| C-7 | `NmeaDecoder` error output stored the `toString`-converted form on `input`, losing the original `Buffer` | Fixed in 0.2.6 |
-
-## High
-
-| ID | Description | Status |
-|----|-------------|--------|
-| H-1 | Always-on handshake check on every data packet — risked dropping RTCM bytes that shared a TCP segment with the `ICY 200 OK` reply | Fixed in 0.2.5 |
-| H-2 | Coordinate guard `x && y && z` silently dropped axis-aligned positions (e.g. equator) | Fixed in 0.2.5 |
-| H-3 | `NmeaEncoder` unknown `messageType` silently emitted `nmeaMessage: undefined` on the success output | Fixed in 0.2.4 |
-| H-4 | `client.write` rejection errors were not visible (async — not caught by the surrounding `try`) | **Open.** Async write failures now surface via the socket `error` listener, but no per-input error feedback. |
-| H-5 | RTCM/NMEA decoder loop had no zero-length-progress guard — theoretical infinite loop | Fixed in 0.2.5 |
-
-## Medium
-
-| ID | Description | Status |
-|----|-------------|--------|
-| M-1 | Password input rendered as `type="text"` in the editor form | Fixed in 0.2.5 |
-| M-2 | CR/LF injection possible via `mountpoint`/`username`/`password` (interpolated into the handshake string) | Fixed in 0.2.5 — rejected at construct time |
-| M-3 | `AggregateError` referenced unconditionally; ReferenceError on Node ≤ 14 | Fixed in 0.2.5 — `typeof` guard, and `engines.node` bumped to ≥ 18 |
-| M-4 | `host` accepted as `""`/`null`; `interval` forwarded as a raw string | Fixed in 0.2.5 |
-| M-5 | Counter `messagesReceived` mixed inbound, outbound, and handshake replies | Fixed in 0.2.5 — split into `Rx`/`Tx` |
-| M-6 | No connection-state event on the `NtripClient` output — downstream flows can only react to the status badge text | **Open.** See [Future Improvements](future-improvements.md). |
-| M-7 | Listener leaks on `client.close()` — accumulated across reconnects | Fixed in 0.2.5 — `removeAllListeners` on close |
-
-## Low
-
-| ID | Description | Status |
-|----|-------------|--------|
-| L-1 | `engines.node: ">=7.6.0"` was inconsistent with code that uses `AggregateError` and the CI matrix (18/20/22) | Fixed in 0.2.5 — bumped to `>=18.0.0` |
-| L-2 | Editor help text was stubs (`<p>.</p>`) for three of four nodes | Fixed in 0.2.6 — full `<dl class="message-properties">` blocks |
-| L-3 | Decoders/encoder kept the original input attached to every output message (memory pressure for high-rate streams) | **Open.** Cost is one Buffer reference per emission. |
-| L-4 | `'socket timeouted'` typo in the upstream socket error message | Fixed in 0.2.5 |
-| L-5 | NMEA case `'Object'` was unreachable because `messageType.toUpperCase()` ran first | Fixed in 0.2.4 |
-
-## Open design-level constraints
-
-These are *accepted* limitations — documented rather than fixed, because the
-fix would be a significant architectural change.
-
-- **NTRIP over plaintext TCP only.** No NTRIPS / TLS support. NTRIP V2 over TLS
-  is a real protocol but the upstream `ntrip-client` package does not implement
-  it, and this contrib does not bring its own transport layer. See
-  [Future Improvements](future-improvements.md).
-- **`_connect()` full replacement** (not delegation) in
-  [ntrip/lib/ntrip-client.js](../../ntrip/lib/ntrip-client.js). Improvements to
-  the upstream client's connection logic (keep-alive, IPv6 handling, TLS
-  upgrade) won't propagate into the uploader path. See
-  [ADR-0002](adr/0002-ntrip-uploader-extension.md).
-- **`credentials` block must be declared in two places** — both the JS
-  `registerType` and the HTML `RED.nodes.registerType`. Drift is detectable
-  only at runtime when persistence silently fails.
-- **No per-node integration tests for `NtripClient`** — the unit test stack
-  covers the three pure transformer nodes only. The client requires a fake TCP
-  server for meaningful testing; see [Future Improvements](future-improvements.md).
-- **Editor HTML help text duplicates much of the runtime documentation** — any
-  schema change to a `payload` shape needs two updates (code + help text).

package/doc/architecture/future-improvements.md

@@ -1,130 +0,0 @@
-# Future Improvements
-
-These are *new capability* items rather than refactors. They would change
-behaviour visible to the user, and most warrant a minor version bump
-(0.3.0+) or a major one if they break the public message shape.
-
-## Protocol / network
-
-### NTRIPS (NTRIP over TLS)
-
-NTRIP V2 may run over TLS (typically port 2102, sometimes 443). The package
-currently relies on plaintext TCP via `net.createConnection`. Adding TLS would
-need:
-
-- A toggle in the editor form (`useTls: boolean`).
-- A separate `tls.connect` path in [ntrip/lib/ntrip-client.js](../../ntrip/lib/ntrip-client.js).
-- Optional CA bundle / SNI / certificate-pinning settings.
-- Documentation that NTRIPS handshake is identical to NTRIP V2 once the TLS
-  tunnel is established.
-
-Breaks no existing flow — pure additive.
-
-### Connection-state event output
-
-Today, downstream Node-RED flows cannot react to `NtripClient` reconnects,
-rejections, or handshake completion except by scraping the status badge text.
-Three implementation options, in order of disruption:
-
-1. Emit a tagged message on the existing output:
-   `{ payload: null, state: 'connected' | 'rejected' | 'reconnecting' }`.
-   Slightly viral — every downstream node must filter `payload != null`.
-2. Add a second output port for state events. Breaks layout of existing flows.
-3. Surface state via Node-RED's runtime event bus (`RED.events.emit`).
-   Non-breaking but requires opt-in from consumers.
-
-### NTRIP source-table fetch / mountpoint picker
-
-The branch `prepared getMountpoints: postponed…` (commit `38a243b`) indicates a
-prior attempt at fetching a caster's source table to populate a dropdown in
-the editor. The hold-up was that credentials are stored server-side and the
-editor JS can't access them. A workable approach: add a small admin endpoint
-(`RED.httpAdmin.get('/ntrip/sourcetable')`) that performs the fetch on the
-server using the stored credentials.
-
-## Test / quality
-
-### NtripClient integration tests
-
-Use `net.createServer` to stand up a fake caster that the test harness fully
-controls. Worth-testing scenarios:
-
-- Each `authmode` writes the correct handshake string.
-- `ICY 200 OK\r\n\r\n<rtcm>` reply: trailing bytes are forwarded.
-- `ICY 406`: error logged, status red, no data forwarded.
-- Mid-stream socket close: `connected` resets so the next handshake reply
-  re-enters the state machine.
-- `msg.payload = [x, y, z]` routes to `setXYZ` (verify via the upstream
-  client's internal GGA emission).
-- CR/LF in credentials: rejected at construct, no socket opened.
-
-### Coverage reporting
-
-Add `c8` (or `nyc`) as a dev dep and a `coverage` npm script. Currently
-Statistics shows "not measured"; a single CI badge changes that. Suggest a
-70 % statement coverage floor as a soft target — high enough to be useful, low
-enough not to require gymnastics on the rare error paths.
-
-### Linting
-
-Adopt `eslint` with `eslint-config-node-red-contribs` or the maintainer's own
-preference. Would have caught most of the regressions from 0.2.4 / 0.2.5
-(unused vars, `let` vs `const`, missing returns).
-
-### TypeScript types (`.d.ts`)
-
-The four nodes have a public message-shape contract (the `payload` schemas
-documented in the help text). Publishing JSDoc-derived `.d.ts` files would let
-TypeScript users in Node-RED's `function` nodes get autocomplete for
-`msg.payload.messageType`, `msg.payload.message.staX`, etc. Lightweight to
-add via `// @ts-check` and JSDoc on the existing JS source.
-
-## Editor UX
-
-### Per-node info-sidebar fixtures
-
-Add small example payloads to the help text so users can copy them straight
-into an `inject` node:
-
-```javascript
-// Example NmeaEncoder input
-msg.payload = { messageType: 'GGA', nmeaMessage: { /* fields */ } };
-```
-
-The HTML stubs added in 0.2.6 are documentation but no example flows are
-linked from the editor — only from the README. A `<a href="…/examples/…">`
-link inside each help block would close that gap.
-
-### Hide credentials when not needed
-
-When `mode === 'download'` and the caster doesn't require auth, the
-Username/Password fields are still shown. A small `oneditprepare` hide rule
-keyed on a "Requires authentication" checkbox would declutter the dialog.
-
-## Codec coverage
-
-### More NMEA sentence types
-
-The current encoder supports 17 sentence types. The `@gnss/nmea` library has
-more (e.g. `VBW`, `VDR`, `WCV`, …). Adding a case is one import + one
-`switch` arm; the test suite already covers the through-path, so each new
-type is ~5 LOC.
-
-### RTCM message-type filter
-
-A `messageTypeFilter: number[]` config (e.g. `[1005, 1077, 1087]`) on the
-decoder would let users drop frame types they don't care about *before* they
-reach downstream nodes. Reduces flow noise and downstream work.
-
-## Distribution / packaging
-
-### Publish `node-red` entries
-
-[package.json](../../package.json) `keywords` includes `"mmea"` (typo — should
-be `"nmea"`). Catalogue search misses are real downloads lost.
-
-### CI: publish on tag
-
-The `.github/workflows/npm-publish.yml` (out of scope here) already exists.
-Worth pairing with semantic-release or a manual tag-driven publish so the
-release cycle is auditable from GitHub.