edfcore 0.5.38 → 0.5.40

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

package/docs/CHANGELOG.md

@@ -6,6 +6,52 @@ 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.40
+
+- **Added** the resolution of every index and byte offset edfcore publishes. The API is full of
+  numbers that are addresses rather than measurements: `signalIndex` names a row of
+  `header.signals`, `recordIndex` a record, `firstSampleIndex` a position on a signal's own grid,
+  and `byteOffset`/`byteLength` a range a reader is expected to take to a hex editor. A measurement
+  that is wrong is wrong; an address that is wrong sends someone to look at the wrong bytes.
+- They were checked one at a time where they are produced and nowhere as a class. Every object every
+  entry point returns is now walked over the eight `AWKWARD` shapes and a file with a gap — 1,500
+  numbers across 51 field names — and each is resolved against the file it came from. A
+  `signalIndex` must name a signal whose own `index` is that number; a `recordIndex` a record the
+  file has; `firstSampleIndex + sampleCount` must land inside the signal's `sampleCount`.
+- The strongest check re-decodes. A chunk's `byteOffset` and `byteLength` are used to slice the
+  fixture and decode it again, and the samples that come back must be the samples the chunk carries.
+  A range check would pass on an offset that is inside the file and points at the wrong record.
+- **Found while writing it:** that re-decode was vacuous on every shared fixture. `writer.ts`
+  defaults its sample generator to `(_record, index) => index % 100` — the same ramp in every record
+  — which is right for a fixture about a header and makes a byte-offset check unable to fail: a
+  chunk reporting the offset of the wrong record decodes to identical samples. The resolution now
+  runs against a file whose every record is distinguishable, asserts that it is before relying on
+  it, and shows that shifting the offset by one record changes what comes back.
+
+## 0.5.39
+
+- **Added** the rule that every array edfcore hands back is frozen. `src/` calls `Object.freeze`
+  forty-three times, in seventeen modules, and the suite asserted `Object.isFrozen` twice. That is a
+  policy held by convention across every module that returns a list, checked at two of its sites —
+  and a policy with one hole is not one, because the hole is exactly where a caller's `push` lands.
+- The reason is sharing. `header.diagnostics` is the same array on every reference to that header,
+  `readWindow` hands one array of chunks to whoever asked, and `findSignals` returns a view of
+  `header.signals`. A caller who sorts one in place, or appends to it, changes what the next reader
+  sees — and the next reader is often the same program, later, through a different function. There
+  is no copy-on-read anywhere in this package, and freezing is what makes that safe.
+- It is now checked as a rule: every object every entry point returns is walked to a depth of nine,
+  over the eight `AWKWARD` shapes and a file with a gap, and every plain `Array` found anywhere in
+  the graph must be frozen. 240 of them — roughly six times the number of `Object.freeze` calls,
+  because one call freezes an array that reaches many results.
+- Two things are deliberately not frozen, and both are asserted so the rule reads as a rule rather
+  than as "everything is frozen". The containing objects are not: a chunk, a segment, a report are
+  values the caller owns, and freezing them would break the `{ ...recording, index }` spread
+  `discontinuous.md` tells every reader to write. Neither are the typed arrays:
+  `chunk.signals[0].digital` is the data, and `toPhysical(signal, digital, out)` writes into a
+  buffer the caller supplied.
+- What the freezing buys is asserted too — a `push` and an in-place `reverse` on a shared list both
+  throw, and the list another reference is holding is unchanged.
+
 ## 0.5.38
 
 - **Added** a sweep over every `…Ticks` edfcore publishes against the `…Seconds` beside it. The

package/package.json

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