edfcore 0.5.37 → 0.5.39

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.37";
+export declare const VERSION = "0.5.39";
 //# 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.37';
+export const VERSION = '0.5.39';
 //# 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.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's central arithmetic decision is that time is a `bigint` count of 100 ns ticks and the
+  seconds are derived from it. Twenty field pairs in `types.ts` are written that way — on the
+  header, the timeline, a segment, a gap, a location, a chunk, a chunk signal, an envelope chunk, an
+  envelope signal and an annotation — each produced by different code, and one of them was checked.
+  `timebase.test.ts` asserts "an exact tick counterpart for every second on a chunk", on chunks.
+- The other nine kinds were computed somewhere and never compared, and the failure they would
+  produce is the quiet kind: the two fields sit next to each other in an autocomplete list, a caller
+  picks whichever the surrounding code already uses, and a disagreement shows up as a plot drawn a
+  fraction of a second from where the arithmetic says it is.
+- The pairs are now enumerated out of `types.ts` and every object every entry point returns is
+  walked, over the eight `AWKWARD` shapes plus a file with a gap and a file with an overlap: 270
+  pairs, compared with `Object.is` against `ticksToSeconds`. `toBeCloseTo` would pass on a pair that
+  had drifted by exactly the thing this arithmetic exists to prevent. Every enumerated field is
+  asserted to have been reached, so none is checked in absentia, and the visited set is asserted to
+  include a negative tick count and a hundred non-zero ones.
+- `EdfAnnotation` is the pair that cannot be inferred from the names, and it is why the rule is
+  spelled out: its four onset fields are two axes, `onsetTicks` with `onsetSecondsFromHeaderStart`
+  and `onsetTicksFromFirstRecord` with `onsetSecondsFromFirstRecord`. Crossing them passes on every
+  file with no sub-second start offset, which is most of them — so the last block builds one that
+  has an offset and shows the crossed pairing failing by exactly that offset. That is the trap
+  `annotations.md` warns about, and it is what makes this pairing a rule rather than a coincidence.
+
 ## 0.5.37
 
 - **Added** the safety property for the CLI. `fuzz.test.ts` states it for the library — for any byte

package/package.json

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