edfcore 0.5.23 → 0.5.25

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

package/docs/CHANGELOG.md

@@ -6,6 +6,55 @@ 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.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.
+  That page opens with an ASCII timeline of one file and closes with a four-step program over the
+  same file printing six lines. `discontinuous-page.test.ts` covers the objects in between — the
+  `index.segments` and `index.gaps` blocks, and `locate(13.5)`. Both ends of it were prose.
+- The diagram is the page's premise: six one-second records, a ten-second hole after record 2, and a
+  row of byte offsets — 768, 1400, 2032, 2664, 3296, 3928 — which is "they are still stored back to
+  back on disk" written as numbers. A reader takes those to a hex editor. Both rows are now read out
+  of the diagram and checked, and the same offsets appear again in the four-read block under
+  "openEdf never scans", where they are the ranges the open actually issues.
+- Three of the program's six lines come from `console.log` inside loops the page writes itself, so
+  they are composed here by the same expressions and compared against the page's text.
+  `256 samples from 2 s` and `256 samples from 13 s` are the ones worth having: that is
+  `trimToWindow` applied to a window spanning a gap, and the second is the whole point of the page —
+  a reader trusting the nominal grid would expect the second chunk to start at 4 s.
+- `index.locate(5)` goes with them. It returns `undefined` for an instant inside the hole, which is
+  the answer the page prints and the one a caller has to handle: there is no sample there, and no
+  index can invent one. Step 1 is checked to reach its verdict without issuing a read, which is what
+  "no extra I/O" in its own comment claims.
+
 ## 0.5.23
 
 - **Added** the conformance report `validation.md` prints, printed. That page ends with a whole

package/package.json

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