edfcore 0.5.24 → 0.5.26

package/README.md

@@ -77,7 +77,7 @@ for (const event of annotations) {
 }
 ```
 
-> **Status: 0.5.x, early.** edfcore runs 2,700+ tests on generated fixtures, and it's checked
+> **Status: 0.5.x, early.** edfcore runs 4,000+ tests on generated fixtures, and it's checked
 > against public corpora it didn't author: the EDF, EDF+ and 24-bit BDF+ test files from
 > teuniz.net, and PhysioNet's sleep-edfx (a real 22-hour polysomnography recording and its
 > sleep-staging file). Those checks are numeric. Channels labelled `sine 8.5 Hz` decode to

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.24";
+export declare const VERSION = "0.5.26";
 //# 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.24';
+export const VERSION = '0.5.26';
 //# sourceMappingURL=constants.js.map

package/docs/CHANGELOG.md

@@ -6,6 +6,57 @@ 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.26
+
+- **Added** the two sentences that promise nothing changes when you run it again. `validation.md`:
+  "It does not modify the recording, the header or the source. `validateRecording` reads and
+  returns; call it twice and you get the same report." `diagnostics.md`: the formatter output "is
+  deterministic ... so it's safe to snapshot in a test." Both are properties of every read in the
+  package rather than of one call, and neither had a test — nothing in the suite called anything
+  twice and compared, and nothing checked that a read leaves the header it was given alone.
+- They are easy properties to lose and hard to notice losing. A parse that memoises a derived value
+  onto the header it returns, a formatter that sorts its input in place, a scan that fills in
+  `segments` on the index it was handed: each is a reasonable-looking optimisation, each makes the
+  second call disagree with the first, and none fails anything until a caller compares two runs. The
+  failure then looks like a file that changed.
+- So both are swept over the whole shape matrix rather than asserted on one fixture. For each of the
+  eight `AWKWARD` files — a zero record duration, no data signal at all, duplicate labels, a signal
+  with no usable scale — every read and every formatter runs twice and the results are compared; the
+  source's bytes are compared before and after; and the header, timeline and index are compared
+  through a walk that handles the `bigint`s and typed arrays `JSON.stringify` refuses.
+- The stronger form goes with it: a second recording opened over a copy of the same bytes must agree
+  with the first, so the output is a function of the file rather than merely stable per object. And
+  the probed index stays probed — `buildRecordIndex` returns a new one rather than filling in the
+  one it was handed.
+
+## 0.5.25
+
+- **Added** the three option tables on `api-helpers.md` and the defaults they promise. Seven fields
+  across `FormatHeaderOptions`, `FormatAnnotationsOptions` and `FormatReportOptions`, each with a
+  stated default — the part of an option nobody passes and everybody depends on.
+- One of them had never appeared in a test at all. `diagnosticsHint` defaults to `true` and appends
+  "Call formatDiagnostics(header.diagnostics) for the detail" under the counts; `edfcore header`
+  turns it off because it is already printing that detail. Both halves — that it is on by default,
+  and that turning it off removes exactly that line and leaves the counts it sits under — were
+  documented in two places and asserted in none.
+- The page argues about two of them together: "The two defaults point opposite ways on purpose.
+  `includePatientId` withholds until asked, because the cost of forgetting is a person's name in an
+  issue tracker. `diagnosticsHint` prints until told not to, because the cost of forgetting is one
+  redundant line." That is a claim about a pair, so it is asserted as a pair.
+- `FormatReportOptions.maxItems` is checked against the constant in `format-report.ts` rather than
+  against a literal, `header` is shown to be the difference between "signal 0" and the label, and
+  `redactFields` is exercised on a report that really does quote the identification — the default
+  prints "Haagse Harry" in full, and asking replaces it with `[redacted]` while the codes, counts
+  and advice survive.
+- The hypnogram transcript above the tables runs with them, since it is the same formatter at its
+  defaults: `00:00:00.000                Sleep stage W` and
+  `08:30:30.000  00:02:00.000  Sleep stage 1`, compared to the page character for character,
+  including the column the missing duration leaves blank.
+- **Changed** the suite-size figure the README, `installation.md` and `browser-safety.test.ts` state
+  from 2,700+ to 4,000+. `test-count-claims.test.ts` failed this release rather than after it: it
+  compares the written figure against the count the suite actually declares, in the direction that
+  rots, and names which page to raise.
+
 ## 0.5.24
 
 - **Added** "the whole flow" at the end of `discontinuous.md`, run, and the diagram at the top of it.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edfcore",
-  "version": "0.5.24",
+  "version": "0.5.26",
   "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.24';
+export const VERSION = '0.5.26';