edfcore 0.2.46 → 0.2.47

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.
package/CHANGELOG.md CHANGED
@@ -6,7 +6,18 @@ 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.2.45
9
+ ## 0.2.47
10
+
11
+ - **Fixed** this changelog. Every heading from `0.2.36` down to `0.2.45` named a version one lower
12
+ than the release that actually shipped it: `0.2.36` was consumed by a release run that failed its
13
+ typecheck after bumping the version, and I kept writing the next entry against the number I
14
+ expected rather than the tag that got cut. So the `cachedSource` fix was labelled `0.2.36` and
15
+ shipped in `0.2.37`, and everything after it was off by one — including the MNE claim in the
16
+ README, which named `0.2.43` for work that is in `0.2.44`. Verified against the tags rather than
17
+ reasoned about: `git show <tag>:CHANGELOG.md` for each. `0.2.36` is now listed as never released,
18
+ the way `0.2.29` already was.
19
+
20
+ ## 0.2.46
10
21
 
11
22
  - **Added** `scripts/golden/README.md`: how to regenerate every parity fixture, and — more usefully
12
23
  — what each of the three harnesses actually claims and how strong that claim is. Bit-for-bit for
@@ -18,7 +29,7 @@ defect; those are called out below.
18
29
  - **Documented** the same table on the physical-values page, so a reader who never opens the
19
30
  repository sees which claims are load-bearing and which are approximate.
20
31
 
21
- ## 0.2.44
32
+ ## 0.2.45
22
33
 
23
34
  - **Added** annotation parity against pyEDFlib — the other axis, and the one edfcore has got wrong
24
35
  most. The scaling harness checks arithmetic; this checks WHICH AXIS an onset is on. Six releases
@@ -33,7 +44,7 @@ defect; those are called out below.
33
44
  recorded from that would have made the parity test compare an incomplete set and pass while doing
34
45
  it.
35
46
 
36
- ## 0.2.43
47
+ ## 0.2.44
37
48
 
38
49
  - **Added** parity against MNE — a second, independent reader. pyEDFlib and edfcore both descend
39
50
  from EDFlib's arithmetic, so agreement between them shows edfcore copied it correctly rather than
@@ -49,7 +60,7 @@ defect; those are called out below.
49
60
  other. Channels MNE does not rescale — it leaves `degC` alone — are excluded rather than pushed
50
61
  through a factor that would make the comparison an artefact of the test.
51
62
 
52
- ## 0.2.42
63
+ ## 0.2.43
53
64
 
54
65
  - **Added** three cases to the pyEDFlib parity harness, chosen for where the two scaling
55
66
  expressions diverge most or where a mistake would be least visible:
@@ -61,7 +72,7 @@ defect; those are called out below.
61
72
  set.
62
73
  - **a full 16-bit range** mapped to one millivolt — the finest.
63
74
 
64
- ## 0.2.41
75
+ ## 0.2.42
65
76
 
66
77
  - **Added** a `samplesPerRecord` column to `edfcore signals`, and **fixed** the documentation,
67
78
  which claimed the command emitted it when it emitted `kind` instead. That left the authoritative
@@ -72,7 +83,7 @@ defect; those are called out below.
72
83
  five columns by position moved. The full six-column list is now pinned by a test, not only
73
84
  described.
74
85
 
75
- ## 0.2.40
86
+ ## 0.2.41
76
87
 
77
88
  - **Added** the types `edfcore/validate`'s own signatures mention to that subpath's exports:
78
89
  `EdfHeader`, `EdfDiagnostic`, `EdfDiagnosticCode`, `EdfSeverity`, `EdfSignal`, `EdfRecordIndex`
@@ -83,7 +94,7 @@ defect; those are called out below.
83
94
  of anything they passed or got back. A type-only test now pins the set, so it fails at
84
95
  `npm run typecheck` rather than in a consumer's project.
85
96
 
86
- ## 0.2.39
97
+ ## 0.2.40
87
98
 
88
99
  - **Added** tests pinning which date defect produces which diagnostic. `DATE_IMPLAUSIBLE` is
89
100
  documented as covering two conditions with only the second reachable, and that was prose about an
@@ -94,7 +105,7 @@ defect; those are called out below.
94
105
  dead. The branch itself is kept, with the reason written next to it — a missing guard is harder
95
106
  to notice than an idle one.
96
107
 
97
- ## 0.2.38
108
+ ## 0.2.39
98
109
 
99
110
  - **Fixed** `onsetSecondsFromFirstRecord` and `onsetTicksFromFirstRecord` disagreeing about the
100
111
  same event at the edge of the int64 tick range. The exact field saturated and the float field was
@@ -103,7 +114,7 @@ defect; those are called out below.
103
114
  with the exact field in 0.2.10. Both are now derived from one rebased value, which is what the
104
115
  float field was always documented to be: the lossy view of the exact one.
105
116
 
106
- ## 0.2.37
117
+ ## 0.2.38
107
118
 
108
119
  - **Fixed** `fileHandleSource` and `fileSource` ignoring an abort signal that flipped while a read
109
120
  was in flight. The abort check ran at the top of each loop iteration, and the common case is one
@@ -112,7 +123,7 @@ defect; those are called out below.
112
123
  test saying why; one adapter honouring a signal that another quietly ignores is worse than either
113
124
  rule alone.
114
125
 
115
- ## 0.2.36
126
+ ## 0.2.37
116
127
 
117
128
  - **Fixed** `cachedSource` repopulating itself after `close()`. A read already in flight when close
118
129
  was called still resolves, and its continuation still runs — after `blocks.clear()` — so the
@@ -126,6 +137,12 @@ defect; those are called out below.
126
137
  cache entirely and retains nothing. The path is exactly as safe as calling the wrapped source
127
138
  directly, which is what it does.
128
139
 
140
+ ## 0.2.36
141
+
142
+ Never released. A release run failed its typecheck after bumping the version, which consumed the
143
+ number before a tag was cut — the same way `0.2.29` was lost earlier. The `cachedSource` fix that
144
+ carried this heading while it was being written shipped in `0.2.37`, and is listed there.
145
+
129
146
  ## 0.2.35
130
147
 
131
148
  - **Fixed** `byteSource` building a source over an argument that is not bytes, so the caller's
package/README.md CHANGED
@@ -299,7 +299,7 @@ back with pyEDFlib, and records every sample as its exact IEEE-754 bit pattern;
299
299
  `tests/corpus/golden/` was produced by edfcore. Substituting the numerically better textbook
300
300
  expression fails it on 140 of 256 samples — which is why the EDFlib form is pinned.
301
301
 
302
- **MNE, as of 0.2.43.** edfcore agrees with MNE to within 1e-12 relative — a weaker claim than the
302
+ **MNE, as of 0.2.44.** edfcore agrees with MNE to within 1e-12 relative — a weaker claim than the
303
303
  one above, and deliberately so. MNE returns SI units, so a microvolt channel arrives divided by
304
304
  1e6, and that division is lossy; the residue is MNE's unit conversion rather than a disagreement
305
305
  about the sample. Bit-parity is claimed for pyEDFlib alone. Both readers also agree with the file's
package/dist/cli-run.js CHANGED
@@ -221,7 +221,7 @@ export async function runCli(args, io) {
221
221
  case 'signals': {
222
222
  // Tab-separated and one line per signal: `header` is for reading, this is for piping.
223
223
  //
224
- // `samplesPerRecord` is last and was missing until 0.2.41. It is the AUTHORITATIVE field —
224
+ // `samplesPerRecord` is last and was missing until 0.2.42. It is the AUTHORITATIVE field —
225
225
  // `sampleRateHz` is derived from it and the record duration, and is empty for the legal
226
226
  // zero-duration file — so a listing meant for a script that omitted it forced the reader
227
227
  // back to `json` for the one number they could safely index by. Appended rather than
@@ -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.2.46";
112
+ export declare const VERSION = "0.2.47";
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.2.46';
82
+ export const VERSION = '0.2.47';
83
83
  //# sourceMappingURL=constants.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "edfcore",
3
- "version": "0.2.46",
3
+ "version": "0.2.47",
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/cli-run.ts CHANGED
@@ -263,7 +263,7 @@ export async function runCli(args: Args, io: CliIo): Promise<number> {
263
263
  case 'signals': {
264
264
  // Tab-separated and one line per signal: `header` is for reading, this is for piping.
265
265
  //
266
- // `samplesPerRecord` is last and was missing until 0.2.41. It is the AUTHORITATIVE field —
266
+ // `samplesPerRecord` is last and was missing until 0.2.42. It is the AUTHORITATIVE field —
267
267
  // `sampleRateHz` is derived from it and the record duration, and is empty for the legal
268
268
  // zero-duration file — so a listing meant for a script that omitted it forced the reader
269
269
  // back to `json` for the one number they could safely index by. Appended rather than
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.2.46';
96
+ export const VERSION = '0.2.47';