edfcore 0.5.16 → 0.5.18

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.16";
+export declare const VERSION = "0.5.18";
 //# 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.16';
+export const VERSION = '0.5.18';
 //# sourceMappingURL=constants.js.map

package/docs/CHANGELOG.md

@@ -6,6 +6,52 @@ 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.18
+
+- **Added** the unscalable signal `diagnostics.md` walks through, run from the throw to the read.
+  That page uses one file for three separate arguments and prints values for all three — the
+  `strict` transcript, the callout headed "`errors > 0` does not mean the file failed to read", and
+  the `EdfScalingError` block at the bottom. They are the same signal seen from three angles, and
+  none of the three was run.
+- The `strict` transcript is four fields off a thrown error and a fifth off the diagnostic inside
+  it: `DEGENERATE_DIGITAL_RANGE digitalMinimum 504 1`, then `EDF+ additional specification 5`. The
+  `504` is the sharpest of them — the byte at which signal 1's `digitalMinimum` field starts in a
+  two-signal file, `256 + 2 x 120 + 8`, and the number a reader would take to a hex editor. It is
+  now asserted against that arithmetic as well as against the page. `error-fields.test.ts` checks
+  the fields exist and `spec-references.test.ts` that every diagnostic cites something; neither was
+  pointed at this file.
+- "The error carries the whole `diagnostic` it would otherwise have recorded, so nothing is lost by
+  throwing" is checked by comparing what the strict throw carries against what the non-strict parse
+  of the same bytes collected.
+- The callout is the part worth having pinned. It says `errors > 0` **and** `report.ok === false`
+  are both true of a file that reads perfectly, and tells the reader to gate on the thrown
+  `EdfError` instead — three values agreeing on one file, asserted in prose. All three are now read
+  off that file, alongside the other signal converting to eight finite microvolt values.
+
+## 0.5.17
+
+- **Added** the record onsets that quietly stop being true when a read is narrowed to a secondary
+  annotations signal. EDF+ permits several and reserves timekeeping to the first;
+  `annotations.md` documents the consequence in a sentence that reads like a footnote: "Leaving out
+  the file's first annotations signal means no timekeeping TAL is read at all. Every entry of
+  `result.recordOnsetTicks` then falls back to the nominal grid, and no diagnostic is emitted for
+  it."
+- On an EDF+D file that is the difference between the truth and a fiction. The same page calls
+  `recordOnsetTicks` "the primitive every timeline in edfcore is built from", and
+  `{ signalIndices: [2] }` — a narrowing a caller reaches for to make a read cheaper, or because the
+  events they want are on the second channel — turns it into `recordIndex * recordDuration` for a
+  file whose records are nowhere near that. The fixture has a five-second hole after record 1, so
+  the true onsets are 0, 1, 7, 8 s and the narrowed read returns 0, 1, 2, 3 s.
+- Nothing throws and nothing is logged: `diagnostics` is empty in both readings, the array has the
+  right length and the right type, and the events of the second signal come back byte-identical to
+  the ones a full read returns. Only the onsets are wrong, which is why this is worth a test rather
+  than a sentence. The page's remedy — read them all — is asserted to recover them.
+- The two refusals the same option reaches are checked with it: a plain `RangeError` for a data
+  signal, compared word for word against the transcript the page prints, and
+  `EdfChannelNotFoundError` carrying `selector` and `availableLabels` for an index the file does not
+  have. `isEdfError` tells them apart, which is the distinction the page draws — parsing samples as
+  text is a caller's mistake and never a file's.
+
 ## 0.5.16
 
 - **Added** the last program on `annotations.md`, run. That page ends with the conversion it exists

package/package.json

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