edfcore 0.4.513 → 0.4.516

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

package/docs/CHANGELOG.md

@@ -6,6 +6,67 @@ 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.4.516
+
+- **Added** the third column of the `EdfHeader` and `EdfSignal` tables on `api-types.md`, executed.
+  `type-tables.test.ts` already checks that both tables list every member of their interface in
+  declaration order, which settles the first column. The third is where the tables do their work:
+  most rows do not describe a field, they derive it — `dataByteLength` is
+  `recordCount * recordByteLength`, `sampleCount` is `samplesPerRecord * header.recordCount`,
+  `recordByteOffset` is an offset "within one data record" rather than within the file, and
+  `sampleRateHz` is `undefined` "exactly when that duration is `0`". None of it had been run.
+- A wrong rule there is worse than a missing one, because these are the sentences a reader uses
+  instead of measuring. Someone who takes `recordByteOffset` for a file offset writes a seek that
+  lands in the header; someone who divides by `sampleRateHz` because the table did not warn them
+  gets `Infinity` on a legal annotations-only recording.
+- Each rule is asserted twice: that the page still states it, quoting the row's own words, and that
+  the library obeys it. The quote is what makes the pair worth anything — a rule reworded on the
+  page fails here instead of drifting away from a test that only knew the behaviour.
+- Reading the rows needs two things the obvious parser gets wrong. `recordByteLength` is a row in
+  BOTH tables and means different things in each, so a row is looked up under its `###` heading;
+  and a type cell writes a union as `number \| undefined`, so cells split on an unescaped pipe or
+  the rest of that row lands in the wrong column.
+
+## 0.4.515
+
+- **Added** the thirteen pairs behind one sentence on `cli.md`: "Each is accepted and ignored by
+  the commands it does not name." It is the only claim on the page about pairs rather than about a
+  command, it is what lets a wrapper pass one fixed flag set to every command instead of branching,
+  and nothing checked it.
+- The two halves rot differently. "Accepted" fails loudly — `parseArgs` refuses an unknown flag, so
+  a flag dropped from the parser exits 2. "Ignored" fails silently, and in the worst direction:
+  `--patient` gates identification, so a flag that started reaching `events`, `signals` or `gaps`
+  would print the identification a caller passed it to withhold. Each pair now runs the command
+  twice and compares the bytes, having first asserted the command printed something — two empty
+  outputs are equal.
+- The last clause is the same test in the same shape: the counted `events` listing is never capped,
+  so `--limit 1` must return it unchanged, while `events --list --limit 1` must not. A cap on a
+  census truncates it into something that reads as complete.
+- Which commands each flag names is read out of the page's own "Flags:" paragraph, not written in
+  the test, so a flag that gains or loses a command in the prose changes what is checked. The
+  paragraph needs splitting at each flag to read: only two of the three carry a parenthesised list,
+  and one pattern across the whole paragraph reads the third one's list as the second one's.
+
+## 0.4.514
+
+- **Added** a check of what is in the six columns `edfcore signals` prints. `cli.md` tabulates them
+  by name and position and ends the sixth row with the instruction the command exists for — "the
+  authoritative count; index by this, never by the rate" — and the only test was that there are six
+  columns and one line per signal, which six columns of anything satisfy.
+- That is the defect the page records against itself. Until 0.2.42 it described a column list the
+  command did not emit: samples per record where the command printed `kind`, and the authoritative
+  field in no column at all. A count of six would not have caught it then either. The order is now
+  read out of the page's table rather than written in the test, so the two cannot drift apart.
+- The fixture gives its two data signals different sample counts and different units, so 4 Hz, 1.5
+  Hz, 8 and 3 are all distinct — no pair of columns can be swapped and still match.
+- The three qualified rows are checked as qualified. `sampleRateHz` is empty on a legal zero record
+  duration, where `undefined`, `0` and `NaN` would each be a number a script divides by. `label`
+  and `physicalDimension` are both called trimmed, and are trimmed by different things: the parser
+  strips EDF padding from both, the command adds `String.trim` to the dimension — which reaches a
+  tab — and passes the label through `printable`, which turns a tab into `.`. Removing either
+  fails now; before this, removing the first put a tab in the dimension and removing the second put
+  a seventh column in the row, handing `cut -f6` a unit where it expected a sample count.
+
 ## 0.4.513
 
 - **Added** a bounds check on the evidence a diagnostic points at: the byte range is inside the

package/package.json

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