edfcore 0.5.29 → 0.5.31

package/dist/constants.d.ts

@@ -109,5 +109,5 @@ export declare const SIGNAL_FIELD_BLOCK_OFFSETS: {
     readonly reserved: 224;
 };
 /** Published package version. Kept in sync with package.json by a test. */
-export declare const VERSION = "0.5.29";
+export declare const VERSION = "0.5.31";
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -79,5 +79,5 @@ export const SIGNAL_FIELD_BLOCK_OFFSETS = {
     reserved: 224,
 };
 /** Published package version. Kept in sync with package.json by a test. */
-export const VERSION = '0.5.29';
+export const VERSION = '0.5.31';
 //# sourceMappingURL=constants.js.map

package/docs/CHANGELOG.md

@@ -6,6 +6,51 @@ alone does not tell you whether you were affected.
 edfcore is pre-1.0. Patch releases have carried behaviour changes where the old behaviour was a
 defect; those are called out below.
 
+## 0.5.31
+
+- **Added** the record-range contract at the five calls that take one. `RecordRange` is the other
+  half of the selection contract 0.5.29 covered, and it reaches three layers — `readRecordBytes` in
+  the I/O layer, `readRecords` and `readAnnotations` in the recording layer, `decodeDigital` and
+  `decodeAnnotations` in the decoders. Unlike the signal selections, they do not share a validator:
+  each asserts the range for itself.
+- That is the reason to check them together. `api-reading.md` documents one behaviour — an
+  `EdfRangeError` when the range is not inside `header.recordCount` — and a caller who tested against
+  `readRecords` has no way to know whether `decodeDigital` agrees. The error also carries `requested`
+  and `available` so a caller can clamp and retry, and those have to hold the same two ranges at
+  every site or the retry computes the wrong one; that is now asserted as one set rather than five
+  times over.
+- Six bad ranges run at all five: a start past the end, a count that runs past it, a negative start,
+  a negative count, a fractional start and a fractional count. The last two are the ones a caller
+  reaches without noticing — a `Math.floor` left off a division, a range built from `seconds * rate`
+  — and they are refused rather than truncated, because a range that silently became
+  `{ start: 0, count: 1 }` would return real samples for a question nobody asked.
+- `count: 0` is accepted at all five, including at the end of the file where a count of one is not,
+  which is the case the page singles out. The two decoders check something else as well — the buffer
+  they were handed against the range they were given — and that second check is exercised rather
+  than worked around, since it is the one that catches a caller pairing a range with the wrong bytes.
+
+## 0.5.30
+
+- **Added** what `diagnostics.md` prints for one header, printed. The page introduces the two ways of
+  looking at a diagnostics array by showing both on the same file: `formatDiagnostics` renders one
+  entry in full, five detail lines and all, and `summarizeDiagnostics` reduces the same four
+  diagnostics to `total 4, errors 1, warnings 1, infos 2`. Neither transcript was run.
+  `diagnostics.test.ts` covers the vocabulary and the sink, `diagnostic-message-lines.test.ts` the
+  line discipline, and `summarize-diagnostics.test.ts` the counting rules — all against fixtures of
+  their own.
+- The rendered block is the one worth comparing whole. It is what a user pastes into an issue, and
+  every part of it is load-bearing differently: the severity and code a reader greps for, the
+  message, the byte offset they take to a hex editor, the raw bytes as written, the expected/actual
+  pair, and the spec clause. The page is the only place the whole shape appears.
+- The paragraph under it makes four smaller claims and each is now checked: no ANSI escapes unless
+  you ask; `color` adds them, and stripping them gives back the uncoloured text exactly, so colour
+  is decoration and not content; `maxItems` caps the blocks and appends `... and N more`, dimmed
+  with SGR 2 when colour is on; and `formatDiagnostics([])` returns the empty string rather than a
+  blank line, which is what lets it concatenate into a larger report.
+- The fixture is built to the page's own numbers rather than to a convenient shape — one error, one
+  warning and two infos is what the summary transcript says, and the two infos come from two
+  different codes because `byCode` is printed beside them.
+
 ## 0.5.29
 
 - **Added** the contract `signalIndices` has to keep at all five reads that take one.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edfcore",
-  "version": "0.5.29",
+  "version": "0.5.31",
   "description": "Modern, typed, zero-dependency reader for EDF, EDF+, BDF and BDF+ biosignal files. Works in browsers and Node with true random access.",
   "keywords": [
     "edf",

package/src/constants.ts

@@ -93,4 +93,4 @@ export const SIGNAL_FIELD_BLOCK_OFFSETS = {
 } as const;
 
 /** Published package version. Kept in sync with package.json by a test. */
-export const VERSION = '0.5.29';
+export const VERSION = '0.5.31';