edfcore 0.6.36 → 0.6.38

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

package/docs/CHANGELOG.md

@@ -6,6 +6,47 @@ 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.6.38
+
+- **Documented** the third regime the sample helpers have. `api-helpers.md` described two: on a
+  contiguous file the recording-aware forms agree with the grid functions exactly, and on a
+  discontinuous one they differ by the gaps, with `sampleAt` able to answer `undefined` for an
+  instant in a hole.
+- A file whose records OVERLAP is neither. Two samples start at the same instant there, so
+  `sampleAt(sampleStartSecondsOf(recording, signal, i))` can answer with a sample that is not `i`
+  — on the shape added in 0.6.36 it does for twenty of the first forty-eight indices. No error, no
+  `undefined`: the sample it names does start at the instant asked for, and nothing can choose
+  between two that do. A caller round-tripping an index through an instant gets a different index
+  back, which is the answer the page did not prepare them for.
+- The page now names the regime, says how to detect it (`contiguityOf`, or the timeline's
+  `RECORD_ONSET_SPACING_VIOLATION`), and says to compare instants rather than indices.
+- `an-instant-two-samples-share.test.ts` executes the property in both forms over all seventeen
+  shapes: the weak one that holds everywhere — the sample found starts at the instant asked for —
+  and the strong one that holds on the sixteen whose records do not overlap. The overlapping shape
+  is asserted to be the only place they differ, and to differ on twenty indices rather than on one
+  edge case.
+- No library change: there is no better answer for it to give.
+
+## 0.6.37
+
+- **Fixed** an incomplete sentence on `api-reading.md`. It said the index traversal "is chunked so
+  memory stays bounded whatever the file size: each chunk holds
+  `min(4 MiB, maxMaterializeBytes) / recordByteLength` records, and never fewer than one" — which
+  is true and reads as though a small budget only makes the scan slower. Below one record's worth
+  it does not: one record cannot be read within the budget and there is no smaller count to ask
+  for, so the scan is refused. The page says that now, and says the refusal names the record's size.
+- **Added** `the-page-says-always.test.ts`, which executes the five claims on that page that say
+  "always", "never" or "every" against all seventeen shapes. Each was written when the matrix held
+  eight, and a universal claim is only as checked as the widest file anyone pointed it at — 0.6.36
+  is what happens when one meets a shape it had not: four sweeps turned out to be asserting
+  something narrower than they said. The claims are read off the page, so a rewording fails here.
+- Two are worth naming. `readAnnotations` answers on a file with NO annotations channel, returning
+  one onset per record from the nominal grid — "always" includes the file with nowhere to store an
+  annotation. And on that same file a budget of one byte does not refuse, because the page's next
+  sentence says such a file "is not scanned at all, because its record onsets are arithmetic": the
+  two claims agree, and the test checks that they do rather than exempting one.
+- No library change.
+
 ## 0.6.36
 
 - **Added** a seventeenth shape to the `AWKWARD` matrix: records that overlap in time, where a

package/package.json

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