edfcore 0.4.515 → 0.4.517

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

package/docs/CHANGELOG.md

@@ -6,6 +6,48 @@ 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.517
+
+- **Added** the convention `api-types.md` states in bold above every table on the page: "A field
+  that may be absent is `T | undefined`, and the key is always there." It is what lets a caller
+  write `header.startTime.resolvedDate === undefined` instead of `'resolvedDate' in
+  header.startTime`, and destructure a result without guarding each name. It was prose.
+- The type half is read out of `src/types.ts`: every optional member must live in an interface the
+  caller constructs — the ten `…Options` and `…Selection` types. An optional member on a result is
+  not a compile error anywhere. It quietly makes one field a name TypeScript will not let you read
+  without a guard.
+- The runtime half is the one a type cannot catch. A result assembled with a conditional spread —
+  `...(date === undefined ? {} : { resolvedDate: date })` — satisfies `T | undefined` and omits the
+  key, so `Object.keys` comes up short, `in` is false, and a JSON round-trip loses a field the
+  table says is always there. Twenty result interfaces are now instantiated and every declared
+  member checked with `Object.hasOwn`; writing that spread into `resolveStartTime` fails the run.
+- The fixture is built to leave fields ABSENT rather than present: an unreadable start date, a
+  signal with a degenerate digital range so it has no scale, annotations with no duration, and a
+  discontinuous file so one segment has a gap before it and one has none. Twenty fields come back
+  `undefined`, and the run asserts that count — on a file where everything happened to be defined
+  the check would pass while testing nothing.
+
+## 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

package/package.json

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