edfcore 0.4.516 → 0.4.518

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

package/docs/CHANGELOG.md

@@ -6,6 +6,45 @@ 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.518
+
+- **Added** the other convention `api-types.md` states in bold: "Anything checkable against the
+  file is exposed twice", as the parsed value and as the raw bytes it came from, padding intact.
+  It is a convention rather than a nicety because of the sentence after it — a header field that
+  disagrees with what edfcore made of it is what you need when a file misbehaves — so the raw side
+  is the evidence a bug report is written from, and evidence that is not the file's own bytes is
+  worse than none.
+- `type-tables.test.ts` checks the raw interfaces list every field, and individual tests quote a
+  raw value here and there. Nothing checked the convention: that each of the ten fixed fields and
+  the ten per-signal fields, on every signal, is exactly the bytes the layout puts at that offset,
+  decoded the way the header is decoded and not trimmed on the way out.
+- The per-signal half is where a mistake would be invisible. The block is field-major, so one
+  signal's ten fields are ten different places in the header, each `256 + ns * before + i * width`,
+  and reading one from a neighbour's slot yields a plausible string rather than an error. The
+  fixture gives all three signals different values for every field and leaves padding in each, so a
+  shifted index and a trimming reader both fail — both were tried, and both do.
+
+## 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.

package/package.json

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