edfcore 0.4.319 → 0.4.321

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -109,5 +109,5 @@ export declare const SIGNAL_FIELD_BLOCK_OFFSETS: {
109
109
  readonly reserved: 224;
110
110
  };
111
111
  /** Published package version. Kept in sync with package.json by a test. */
112
- export declare const VERSION = "0.4.319";
112
+ export declare const VERSION = "0.4.321";
113
113
  //# sourceMappingURL=constants.d.ts.map
package/dist/constants.js CHANGED
@@ -79,5 +79,5 @@ export const SIGNAL_FIELD_BLOCK_OFFSETS = {
79
79
  reserved: 224,
80
80
  };
81
81
  /** Published package version. Kept in sync with package.json by a test. */
82
- export const VERSION = '0.4.319';
82
+ export const VERSION = '0.4.321';
83
83
  //# sourceMappingURL=constants.js.map
package/docs/CHANGELOG.md CHANGED
@@ -6,6 +6,34 @@ alone does not tell you whether you were affected.
6
6
  edfcore is pre-1.0. Patch releases have carried behaviour changes where the old behaviour was a
7
7
  defect; those are called out below.
8
8
 
9
+ ## 0.4.321
10
+
11
+ - **Added** a guard for the offset rule `edf-format.md` states: offsets stay in plain floats, which
12
+ are exact to 2^53, because a data offset in a multi-gigabyte BDF crosses 2^31 and a bitwise
13
+ operator wraps it negative there without warning. Nothing checked it, and the failure is the
14
+ silent kind — a 22-hour BDF passes 2^31 bytes about nine hours in, so a truncated offset would
15
+ read plausible samples from the wrong place for the whole back half of the recording.
16
+ - Not a ban: `decode/digital.ts` assembles every sample with `|` and `<<` and must, and the same
17
+ page prints those two lines as the definition of the format. The guard is an inventory instead —
18
+ every bitwise operator in `src/` has to sit in one of three modules with a written reason, which
19
+ makes adding a fourth a deliberate act. `record-index.ts` is one of the three, and its entry
20
+ records why `(low + high) >> 1` is safe: the record count comes from an eight-character header
21
+ field, so the index cannot approach 2^30.
22
+ - The demonstration corrects a detail the page leaves implicit. `| 0` and `>>` wrap the offset
23
+ negative at 2^31, but `>>>` is unsigned and returns something plausible until 2^32 — about
24
+ eighteen hours into the same recording — which is the more dangerous of the two behaviours.
25
+
26
+ ## 0.4.320
27
+
28
+ - **Extended** 0.4.319 to the second copy of the harness table. `scripts/golden/README.md` carries
29
+ the complete one — four rows rather than the documentation page's three, because it includes
30
+ `corpus-parity.test.ts`, the only harness whose inputs nobody here chose — and `tests/README.md`
31
+ sends the reader to it for "what each harness claims and how strong that claim is".
32
+ - That copy names each harness by file, which is the stronger form, so a row cannot outlive the
33
+ test it describes. Every named file has to exist, every bit-for-bit row has to belong to a
34
+ harness that compares with `Object.is` and no tolerance, and the MNE bound has to match both the
35
+ constant in the harness and the figure the other table publishes.
36
+
9
37
  ## 0.4.319
10
38
 
11
39
  - **Added** a check that the three cross-implementation harnesses claim on the page exactly what
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edfcore",
3
- "version": "0.4.319",
3
+ "version": "0.4.321",
4
4
  "description": "Modern, typed, zero-dependency reader for EDF, EDF+, BDF and BDF+ biosignal files. Works in browsers and Node with true random access.",
5
5
  "keywords": [
6
6
  "edf",
package/src/constants.ts CHANGED
@@ -93,4 +93,4 @@ export const SIGNAL_FIELD_BLOCK_OFFSETS = {
93
93
  } as const;
94
94
 
95
95
  /** Published package version. Kept in sync with package.json by a test. */
96
- export const VERSION = '0.4.319';
96
+ export const VERSION = '0.4.321';