edfcore 0.5.0 → 0.5.2

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.0";
+export declare const VERSION = "0.5.2";
 //# 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.0';
+export const VERSION = '0.5.2';
 //# 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.5.2
+
+- **Added** the map of how far `strict` reaches on a read, which has three cells rather than the
+  two a reader assumes. `openEdf` probes exactly two records for their timekeeping onsets, so a
+  malformed TAL in record 0 or the last record throws under `strict` and one in a middle record
+  does not — the file opens, and every sample reads back either way.
+- The middle cell is not a defect. A probed index has read two records, so `strict` can only reject
+  what it saw; rejecting a file for a defect nobody looked for would be a claim the probe cannot
+  make, and `validateRecording` is the call that reads every record. It is written down because
+  "strict rejects a file with any defect" is what a reader assumes, and it is wrong in a way no
+  error message will correct.
+- The reason a read is never strict is checked as the structural fact it is rather than as
+  carefulness: `ReadOptions` declares no `strict` member, so a read cannot be asked for it even by
+  a caller who wants it. `recording.ts` says exactly that at the call site — "not because the flag
+  was lost" — and a member added later would compile, be ignored, and leave `api-reading.md`
+  describing an option that exists.
+- In all three cells the samples come back and `TAL_MALFORMED` lands on `chunk.diagnostics` naming
+  the record it was found in. That is what the read path exists to protect: a malformed TAL in the
+  annotations channel is not a reason to return no EEG.
+
+## 0.5.1
+
+- **Added** the `out` contract as one check over every primitive that takes one.
+  `api-primitives.md` writes it once and refers back to it — "`out` behaves exactly as in
+  `decodeDigital`: reused when long enough, narrowed with `subarray` when longer, a plain
+  `RangeError` when shorter" — and `envelope.ts` restates it in its own words. Each of the four was
+  tested on its own; that the four agree was not.
+- `out` exists for the render loop, where a viewer redraws on every pan and zoom, so the caller
+  holds the buffer across frames and reads it after the call. Each rule fails silently without
+  that: a function that allocated its own array would work perfectly and leave a caller reading
+  last frame's numbers; one that returned the whole buffer instead of a narrowed view would append
+  stale values from the previous, longer frame; one that filled a short array part-way would draw a
+  frame half from this window and half from the last. All three are checked by identity of the
+  underlying buffer rather than by contents.
+- The refusal is asserted to be a plain `RangeError` with `isEdfError` false, on all four. A
+  wrong-sized array the caller allocated is a bug in the calling code, not a problem with the file,
+  and that is the kind of distinction a later refactor tidies into the error hierarchy one function
+  at a time.
+- The four are enumerated from `src/` rather than listed, so a fifth primitive that takes an `out`
+  fails this file until it joins it.
+
 ## 0.5.0
 
 The public API is unchanged: nothing was added, removed or renamed, and no arithmetic moved. This

package/package.json

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