edfcore 0.6.253 → 0.6.254

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

package/dist/diagnostics/summary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../../src/diagnostics/summary.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAEjF;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,yFAAyF;IACzF,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,CAAC;IACxC,uEAAuE;IACvE,QAAQ,CAAC,MAAM,EAAE,SAAS,YAAY,EAAE,CAAC;CAC1C;AA+BD;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,SAAS,aAAa,EAAE,GAAG,oBAAoB,CA+ChG"}
+{"version":3,"file":"summary.d.ts","sourceRoot":"","sources":["../../src/diagnostics/summary.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAEjF;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,yFAAyF;IACzF,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,CAAC;IACxC,uEAAuE;IACvE,QAAQ,CAAC,MAAM,EAAE,SAAS,YAAY,EAAE,CAAC;CAC1C;AA+BD;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,SAAS,aAAa,EAAE,GAAG,oBAAoB,CA0EhG"}

package/dist/diagnostics/summary.js

@@ -59,6 +59,31 @@ export function summarizeDiagnostics(diagnostics) {
     // no mention of the three places a caller gets a list (fixed in 0.6.107).
     // Cast in the test, not on the value: `Array.isArray` over a `readonly T[]` narrows the whole
     // parameter to `any[]` and the element type is lost for the rest of the function.
+    /*
+     * A FORGOTTEN AWAIT, ahead of it, because "not an array" is true of a pending Promise and the
+     * advice below names three fields the caller does not have yet.
+     *
+     * `formatDiagnostics` names the keyword one directory over — it reads its subject out of
+     * `describeValue`, whose own note lists the five async calls whose resolved values other guards
+     * take and says a message about "an object" is "true of the thing they meant to pass too". This
+     * function is that note's twin and was left out of it: it takes the same array, `format.ts`
+     * says so in its own `Next:` clause, and a reader who follows that clause from there arrives
+     * here with the same Promise.
+     *
+     * The keyword is half of it, the way it is for `resolveTimeWindow` and `buildTimeline` (0.6.253):
+     * none of these calls resolves to a diagnostics array. Each resolves to the header, the report,
+     * the chunk or the recording that CARRIES one, so the fix is a field as well as a keyword.
+     *
+     * A property read and said in words, for the two reasons this module already gives: nothing here
+     * awaits or subscribes to anything, and the check below is "described in words rather than by
+     * type" so that any layer can summarise without taking on a dependency.
+     */
+    if (typeof diagnostics?.then === 'function') {
+        throw new RangeError('summarizeDiagnostics(): the diagnostics are a pending Promise, so there is nothing to ' +
+            'summarise yet — and no call in this package resolves to a diagnostics array, so the ' +
+            'keyword is half of the fix. Next: pass (await readHeader(source)).diagnostics, or the ' +
+            'diagnostics on the recording, chunk or report you already have.');
+    }
     if (!Array.isArray(diagnostics)) {
         throw new RangeError('summarizeDiagnostics(): the diagnostics are not an array, so there is nothing to ' +
             'summarise. Next: pass header.diagnostics, or the diagnostics on the chunk or the ' +

package/dist/diagnostics/summary.js.map

@@ -1 +1 @@
-{"version":3,"file":"summary.js","sourceRoot":"","sources":["../../src/diagnostics/summary.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AA+BH,qEAAqE;AACrE,MAAM,aAAa,GAAgC,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;AAErF;;;;;;;;;;;;;;;GAeG;AACH,SAAS,gBAAgB,CAAC,UAAyB,EAAE,KAAa;IAChE,IAAI,OAAQ,UAAuD,EAAE,OAAO,KAAK,QAAQ;QAAE,OAAO;IAClG,MAAM,IAAI,UAAU,CAClB,wCAAwC,KAAK,sCAAsC;QACjF,4FAA4F;QAC5F,4FAA4F;QAC5F,6EAA6E,CAChF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,oBAAoB,CAAC,WAAqC;IACxE,2FAA2F;IAC3F,8FAA8F;IAC9F,mGAAmG;IACnG,0EAA0E;IAC1E,8FAA8F;IAC9F,kFAAkF;IAClF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAsB,CAAC,EAAE,CAAC;QAC3C,MAAM,IAAI,UAAU,CAClB,mFAAmF;YACjF,mFAAmF;YACnF,kBAAkB,CACrB,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,KAA8B,CAAC;IAEnC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAmC,CAAC;IAC1D,KAAK,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC;QACxD,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QACpC,IAAI,UAAU,CAAC,QAAQ,KAAK,OAAO;YAAE,MAAM,IAAI,CAAC,CAAC;aAC5C,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS;YAAE,QAAQ,IAAI,CAAC,CAAC;;YACrD,KAAK,IAAI,CAAC,CAAC;QAEhB,IAAI,KAAK,KAAK,SAAS,IAAI,aAAa,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YACrF,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC;QAC9B,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC7C,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE;YAC1B,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,qFAAqF;YACrF,QAAQ,EAAE,QAAQ,EAAE,QAAQ,IAAI,UAAU,CAAC,QAAQ;YACnD,KAAK,EAAE,CAAC,QAAQ,EAAE,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC;SAClC,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,KAAK,EAAE,WAAW,CAAC,MAAM;QACzB,MAAM;QACN,QAAQ;QACR,KAAK;QACL,KAAK;QACL,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;KAC9E,CAAC;AACJ,CAAC"}
+{"version":3,"file":"summary.js","sourceRoot":"","sources":["../../src/diagnostics/summary.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AA+BH,qEAAqE;AACrE,MAAM,aAAa,GAAgC,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;AAErF;;;;;;;;;;;;;;;GAeG;AACH,SAAS,gBAAgB,CAAC,UAAyB,EAAE,KAAa;IAChE,IAAI,OAAQ,UAAuD,EAAE,OAAO,KAAK,QAAQ;QAAE,OAAO;IAClG,MAAM,IAAI,UAAU,CAClB,wCAAwC,KAAK,sCAAsC;QACjF,4FAA4F;QAC5F,4FAA4F;QAC5F,6EAA6E,CAChF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,oBAAoB,CAAC,WAAqC;IACxE,2FAA2F;IAC3F,8FAA8F;IAC9F,mGAAmG;IACnG,0EAA0E;IAC1E,8FAA8F;IAC9F,kFAAkF;IAClF;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,OAAQ,WAAqD,EAAE,IAAI,KAAK,UAAU,EAAE,CAAC;QACvF,MAAM,IAAI,UAAU,CAClB,wFAAwF;YACtF,sFAAsF;YACtF,wFAAwF;YACxF,iEAAiE,CACpE,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAsB,CAAC,EAAE,CAAC;QAC3C,MAAM,IAAI,UAAU,CAClB,mFAAmF;YACjF,mFAAmF;YACnF,kBAAkB,CACrB,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,KAA8B,CAAC;IAEnC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAmC,CAAC;IAC1D,KAAK,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC;QACxD,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QACpC,IAAI,UAAU,CAAC,QAAQ,KAAK,OAAO;YAAE,MAAM,IAAI,CAAC,CAAC;aAC5C,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS;YAAE,QAAQ,IAAI,CAAC,CAAC;;YACrD,KAAK,IAAI,CAAC,CAAC;QAEhB,IAAI,KAAK,KAAK,SAAS,IAAI,aAAa,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YACrF,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC;QAC9B,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC7C,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE;YAC1B,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,qFAAqF;YACrF,QAAQ,EAAE,QAAQ,EAAE,QAAQ,IAAI,UAAU,CAAC,QAAQ;YACnD,KAAK,EAAE,CAAC,QAAQ,EAAE,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC;SAClC,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,KAAK,EAAE,WAAW,CAAC,MAAM;QACzB,MAAM;QACN,QAAQ;QACR,KAAK;QACL,KAAK;QACL,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;KAC9E,CAAC;AACJ,CAAC"}

package/docs/CHANGELOG.md

@@ -6,6 +6,22 @@ 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.6.254
+
+- **Fixed** `summarizeDiagnostics` telling a pending Promise only that "the diagnostics are not an
+  array" — true of a Promise, and of a header, a report, a chunk, a recording, a string and a number.
+  It and `formatDiagnostics` are the two calls that take a diagnostics array, `format.ts` sends
+  readers across in its own `Next:` clause, and one of the two named the keyword.
+- The keyword is half of the fix, as it is for `resolveTimeWindow` in 0.6.253: no call in this
+  package resolves to a diagnostics array. `readHeader` resolves to the header carrying one,
+  `validateRecording` to the report, `readWindow` to the chunks — so the message names a field too.
+- `one-keyword-short.test.ts` recorded the old wording as a consequence of this module importing "one
+  type module and nothing else", which is what lets any layer summarise without taking on a
+  dependency. That constraint is about the import and not about the sentence: the new branch is a
+  property read written out in words and adds no import, so both hold.
+- The existing refusal is unchanged for the values it was written for, and an empty array is still a
+  summary of nothing.
+
 ## 0.6.253
 
 - **Fixed** `resolveTimeWindow` telling a pending `buildTimeline(source, header)` that it "has no

package/package.json

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

package/src/diagnostics/summary.ts

@@ -92,6 +92,33 @@ export function summarizeDiagnostics(diagnostics: readonly EdfDiagnostic[]): Edf
   // no mention of the three places a caller gets a list (fixed in 0.6.107).
   // Cast in the test, not on the value: `Array.isArray` over a `readonly T[]` narrows the whole
   // parameter to `any[]` and the element type is lost for the rest of the function.
+  /*
+   * A FORGOTTEN AWAIT, ahead of it, because "not an array" is true of a pending Promise and the
+   * advice below names three fields the caller does not have yet.
+   *
+   * `formatDiagnostics` names the keyword one directory over — it reads its subject out of
+   * `describeValue`, whose own note lists the five async calls whose resolved values other guards
+   * take and says a message about "an object" is "true of the thing they meant to pass too". This
+   * function is that note's twin and was left out of it: it takes the same array, `format.ts`
+   * says so in its own `Next:` clause, and a reader who follows that clause from there arrives
+   * here with the same Promise.
+   *
+   * The keyword is half of it, the way it is for `resolveTimeWindow` and `buildTimeline` (0.6.253):
+   * none of these calls resolves to a diagnostics array. Each resolves to the header, the report,
+   * the chunk or the recording that CARRIES one, so the fix is a field as well as a keyword.
+   *
+   * A property read and said in words, for the two reasons this module already gives: nothing here
+   * awaits or subscribes to anything, and the check below is "described in words rather than by
+   * type" so that any layer can summarise without taking on a dependency.
+   */
+  if (typeof (diagnostics as { then?: unknown } | null | undefined)?.then === 'function') {
+    throw new RangeError(
+      'summarizeDiagnostics(): the diagnostics are a pending Promise, so there is nothing to ' +
+        'summarise yet — and no call in this package resolves to a diagnostics array, so the ' +
+        'keyword is half of the fix. Next: pass (await readHeader(source)).diagnostics, or the ' +
+        'diagnostics on the recording, chunk or report you already have.',
+    );
+  }
   if (!Array.isArray(diagnostics as unknown)) {
     throw new RangeError(
       'summarizeDiagnostics(): the diagnostics are not an array, so there is nothing to ' +