edfcore 0.5.34 → 0.5.36

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

package/docs/CHANGELOG.md

@@ -6,6 +6,57 @@ 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.36
+
+- **Added** the `ByteSource` `data-sources.md` tells you to write, written and read through. "Writing
+  your own ByteSource" is the section that makes the interface a promise rather than an
+  implementation detail — "the whole job is: know the length, return exactly the bytes asked for, and
+  reject otherwise" — and it prints a complete forty-line adapter over a range-returning object
+  store, with four rules under it "in order of how badly they bite". None of it was run.
+  `source-contract.test.ts` covers the contract from edfcore's side, with sources written for the
+  test; the adapter a reader would copy had nothing.
+- It is now transcribed and used: a recording is opened over it, a window is read, and the samples
+  are compared against the same file through `byteSource`. The store streams in irregular pieces —
+  7, 1, 4096, 3 — which is the whole reason the adapter has a loop, and a test that returned each
+  range in one go would never reach it. That is asserted too: no single piece the store hands back
+  is a whole read.
+- Each of the four rules is then broken on purpose, in an adapter of its own. A short return is
+  caught by the adapter, which can name the key and the range, and by edfcore anyway for a source
+  that does not check. A padded one is the dangerous case: on a plain EDF every sample of every
+  record comes back as a legal zero with no diagnostic at all, and only the annotation region of an
+  EDF+ notices, with `TIMEKEEPING_TAL_MISSING`. A reused buffer is shown corrupting an array a
+  caller had already been handed, which the page's own per-read allocation does not.
+- The fourth is the page's Warning, and it is the one worth having under test: "edfcore itself does
+  not poll the signal between reads. A custom `ByteSource` that ignores `options.signal` makes
+  cancellation a complete no-op, including for a long `validateRecording` sweep that issues hundreds
+  of reads." A whole-file sweep and a chunked index traversal both run to completion over an
+  already-aborted signal, serving twenty reads after the abort. A stated limitation nobody checks is
+  indistinguishable from a bug.
+
+## 0.5.35
+
+- **Added** the resolution of every name a `Next:` clause points at. `next-clause.test.ts` proves
+  every thrown message and every diagnostic has one; 0.5.34 follows the eight whose advice is a
+  concrete instruction. This is the mechanical half between them: of the 166 clauses in `src/`, most
+  name something — a function to call instead, an option to raise, a field to read — and a name that
+  no longer exists is how this rots. Nothing renames a public export without noticing, but a message
+  is a string, so a clause mentioning one is not a reference and no compiler follows it.
+- Three kinds of name, each checked against the thing it would have to be true of. A bare
+  `something()` must be exported from one of the three entry points, or be a method on a value
+  edfcore hands back — `locate` on the index and `read` on a source are the two clauses that name a
+  method rather than an export, and both are resolved on the real object. An `options.something`
+  must be a field some options type declares; the two misdiagnoses `options.ts` records were both of
+  that shape, a message naming a lever the caller does not hold. A `header.something`,
+  `signal.something` or `index.something` must exist on a recording opened from a fixture, checked
+  with `in` rather than against a type: a field that is declared and never populated would satisfy a
+  type check and still leave the reader looking for something that is not there.
+- The extraction is narrow about what counts as advice, and says so. Comments are stripped first, so
+  a helper mentioned in a note beside a message is not mistaken for a name the message uses.
+  `${...}` interpolations are stripped too — `Next: ${adapterFor(source)}` names no function to the
+  reader, since the function is how the sentence was built rather than what it says. And the capture
+  crosses the `'…' + '…'` seams a long clause is written in, because stopping at the first would
+  read half of every one of them, and the half that names the field is usually the second.
+
 ## 0.5.34
 
 - **Added** the `Next:` clause, followed. Every message edfcore throws ends with one, and

package/package.json

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