edfcore 0.5.59 → 0.5.61

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.5.59";
112
+ export declare const VERSION = "0.5.61";
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.5.59';
82
+ export const VERSION = '0.5.61';
83
83
  //# sourceMappingURL=constants.js.map
package/docs/CHANGELOG.md CHANGED
@@ -6,6 +6,46 @@ 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.5.61
10
+
11
+ - **Fixed** a sentence both `api-errors.md` and `diagnostics.md` end their cross-realm advice with,
12
+ and which is wrong for one of the three cases it names. "A string property survives all three"
13
+ covers `instanceof` failing across a worker, an iframe and a second copy of edfcore in one
14
+ dependency tree — and `edfErrorKind` survives the second copy, because that object is passed by
15
+ reference and only its constructor identity differs.
16
+ - A worker is not passed by reference. Everything leaving one goes through `postMessage`, which is
17
+ a structured clone, and the algorithm keeps an `Error`'s `name`, `message`, `stack` and `cause`
18
+ and drops every own property. `edfErrorKind`, `code`, `field`, `byteOffset` and `diagnostic` all
19
+ arrive `undefined`, and `isEdfError` returns false — so the page's advice fails in exactly the
20
+ case a reader followed it for. `what-crosses-a-worker.test.ts` executed that in 0.5.60.
21
+ - Both pages now separate the two ways a value crosses, and name what a worker has to do instead:
22
+ send the discriminator beside the error, because a string clones and the error does not.
23
+
24
+ ## 0.5.60
25
+
26
+ - **Added** the boundary six documentation pages talk about and nothing executed: `postMessage`.
27
+ `api-errors.md`, `diagnostics.md`, `concepts.md`, `api-reading.md`, `api-primitives.md` and
28
+ `data-sources.md` each tell a reader that a value crossing a worker or an iframe fails
29
+ `instanceof` and that `edfErrorKind` is what to branch on instead.
30
+ `cross-realm-errors.test.ts` executes the case those pages name — two copies of the module in one
31
+ dependency tree — where the object is passed by REFERENCE and only its constructor identity
32
+ differs. Nothing is passed by reference out of a worker: it goes through the structured clone
33
+ algorithm, which is a different question with different answers.
34
+ - `what-crosses-a-worker.test.ts` clones every value a worker would hand back, over all ten
35
+ `AWKWARD` shapes and a gapped file — 109 checks. Every DATA result survives and compares equal,
36
+ `Int32Array` samples and `bigint` ticks included, and the sweep asserts it is carrying both so a
37
+ pass is not a JSON round trip in disguise.
38
+ - Three things do not survive, and each is pinned with the workaround beside it. The record index
39
+ is refused outright, because `locate` is a function — `index.segments` and `index.gaps` cross
40
+ fine, and those are what a viewer wants. So is the recording, because a `ByteSource` has a
41
+ `read`; the header crosses instead. And `Object.freeze` is dropped, so the guarantee
42
+ `every-array-is-frozen.test.ts` pins is a within-realm one.
43
+ - An `EdfError` does not cross as an edfcore error at all. The algorithm keeps `name`, `message`,
44
+ `stack` and `cause` and drops every own property, so `code`, `field`, `byteOffset`, `diagnostic`
45
+ — and `edfErrorKind` itself — are gone, and `isEdfError` returns false on the far side. The
46
+ string beats `instanceof` for a second copy in the tree; across a `postMessage` neither works,
47
+ and a sender has to post the discriminator rather than the error.
48
+
9
49
  ## 0.5.59
10
50
 
11
51
  - **Added** the round trip a streaming pipeline actually performs: stream a window in pieces, merge
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edfcore",
3
- "version": "0.5.59",
3
+ "version": "0.5.61",
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.5.59';
96
+ export const VERSION = '0.5.61';