edfcore 0.2.55 → 0.2.57

package/CHANGELOG.md

@@ -6,6 +6,32 @@ 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.2.57
+
+- **Documented** what the corpus work of 0.2.49-0.2.55 actually established. The README's
+  interop section stopped at sample parity, which was the state at 0.2.48 and has not been the
+  state since — annotation onsets, the zero-record-duration scoring file, the 1985-2084 year rule,
+  faithful decimation over 7,950,000 samples, chunk-independence, the memory bound, streaming
+  equivalence, HTTP random access costing under 64 KB for a window twelve hours into a 48 MB file,
+  and `validate` exiting 0 on a real clinical recording were all verified and none of them were
+  claimed. A reader deciding whether to trust this package should not have to reconstruct that
+  from a changelog.
+- Each row names how it is checked rather than only what it asserts, because "we test that" is the
+  kind of claim this project has spent forty releases learning not to make without saying how.
+
+## 0.2.56
+
+- **Fixed** `tests/README.md`, which said "There are no binary fixtures in this repository" and
+  listed Tier 2 of its own fixture policy as "Not used". Both stopped being true in 0.2.34, when
+  the parity harness committed six small EDF/BDF files and their goldens — about 1.4 MB. I added
+  those without revisiting the policy that forbade them.
+- The policy is now stated as it actually is, with the reason: a parity fixture has to be bytes a
+  DIFFERENT implementation wrote, so regenerating it in memory with this project's own writer
+  would make the comparison circular and prove nothing. The licence rule is unchanged and was
+  never at risk — the committed files are generated locally by pyEDFlib, the downloaded corpus is
+  still gitignored, and only the JSON goldens reference it, by name and hash. None of it ships:
+  the package contains `dist`, `src` and the changelog.
+
 ## 0.2.55
 
 - **Added** CLI coverage against the real corpus. Every existing CLI fixture is a few hundred bytes

package/README.md

@@ -310,7 +310,25 @@ establish.
 chose: a **22-hour clinical polysomnogram** from sleep-edfx, and the teuniz generator files in EDF,
 EDF+ and 24-bit BDF+. Sampled at the start, the middle and the end of every signal — the end window
 being the one that catches record arithmetic drifting with distance, which a sample near record 0
-cannot. Those tests need the corpus and skip without it:
+cannot.
+
+What else those files establish, which synthetic fixtures cannot:
+
+| Claim | Checked how |
+|---|---|
+| Annotation onsets match pyEDFlib | 154 sleep stages from a real scoring file, to the tick |
+| A legally **zero** record duration works | that same file — where `sampleRateHz` is `undefined` and any rate-derived expression yields `NaN` |
+| The 1985–2084 year rule is right | a 1989 recording, against a reader that implements it independently |
+| Decimation keeps every extreme | 7,950,000 samples reduced to 1,000 buckets, compared with an exhaustive reduction |
+| The bucket grid ignores chunk size | 265 chunks versus a handful |
+| Memory is bounded by the chunk | that 22-hour envelope produced under a 512 KiB budget |
+| Streaming equals reading | 42 streamed chunks concatenated and compared sample by sample |
+| **Random access is real** | a 30-second window twelve hours in costs **under 64 KB** over HTTP |
+| `validate` is usable as a CI gate | exits 0 on a real recording from a real sleep lab |
+| The sample scan sees what pyEDFlib sees | whole-signal digital extremes, all five files |
+
+Those tests need the corpus and skip without it. `coverage.test.ts` always runs and says which
+state you are in, because a skipped test and a passing one look identical in a summary line:
 
 ```bash
 npm run corpus:fetch

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

package/package.json

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