edfcore 0.5.19 → 0.5.21

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

package/docs/CHANGELOG.md

@@ -6,6 +6,49 @@ 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.21
+
+- **Added** the census `reading-signals.md` takes of the derived sample rate. `samplesPerRecord` is
+  authoritative and `sampleRateHz` is "provided for display"; the page argues that with one file —
+  256 samples in a 3-second record is 85.333… Hz, no float holds it, and the error grows with *t* —
+  and then counts how often the two ways of finding a sample disagree: "1,000 of the first 3,001"
+  integer second boundaries, "always by exactly one sample", with the float answer landing one
+  sample early.
+- Nothing computed it. `sample-grid.test.ts` covers the grid functions and `trim-window.test.ts` the
+  window arithmetic, both against exact expectations; neither compares either against
+  `Math.round(t * sampleRateHz)`, which is the expression a reader would otherwise have written and
+  the one the whole section exists to talk them out of.
+- The three printed values are checked first — `85.33333333333333`, `8534` from `trimToWindow`, and
+  `8533` from the float, whose sample really does start at 99.996 s — and then the census is run over
+  all 3,001 boundaries through `trimToWindow` rather than through a reimplementation of it. Each
+  clause of the Note is a separate assertion, because they fail separately: a count that is right
+  with the direction wrong would be a worse page than one with no number at all.
+- The page shows `trimToWindow` twice, and the earlier example is on a 256 Hz file with its own
+  `exact.firstSampleIndex`. Every lookup is scoped to the fence that mentions the derived rate, so
+  the test cannot pass by reading the wrong example.
+
+## 0.5.20
+
+- **Added** the lifetime contract `api-sources.md` states in five words: of `close?()`, "edfcore
+  never calls it for you." A caller who opened a file handle, or a source wrapping a pooled
+  connection, is entitled to decide when it is released — and a library that closed it on their
+  behalf would be releasing a resource they may still be using, with the failure arriving later and
+  somewhere else. Nothing checked it. `cache.test.ts` covers the other direction, that
+  `cachedSource.close()` forwards to the source it wraps, which is the case where a caller did ask.
+- Every reading entry point that takes a source is now driven over a spy that records whether it was
+  closed: `readHeader`, `openEdf`, `inspectEdf`, `readRecordBytes`, `readRecords`, `readWindow`,
+  `readAnnotations`, `buildRecordIndex`, `validateRecording`, `streamRecords`, and one wrapped in
+  `cachedSource`. Each is checked to have actually read, so a passing run is not a source nobody
+  touched.
+- The failure paths are checked too, because a `finally` added for cleanup is exactly how this
+  contract gets broken: a file that is not an EDF at all, a read refused before it is issued, and a
+  read naming records the file does not have.
+- A behavioural sweep only covers the paths it thought to drive, so the `close` call sites are
+  enumerated out of `src/` as well. There are four, in two modules. Three are inside a `close()`
+  implementation of a source edfcore hands back; the fourth is `fileSource` releasing a handle that
+  never reached a caller, which is the exception its own docblock documents. `fileHandleSource` is
+  then checked to close its handle exactly once — when the caller calls it, and not while reading.
+
 ## 0.5.19
 
 - **Added** the table on `diagnostics.md` that says which calls take `strict`. Eleven functions in

package/package.json

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