edf2csv 0.5.29 → 0.5.31

package/CHANGELOG.md

@@ -3,6 +3,47 @@
 Notable changes to edf2csv. Versions follow [semantic versioning](https://semver.org); while the
 major version is 0, a minor bump may contain breaking changes.
 
+## 0.5.31
+
+### Fixed: the API reference's sample-time recipe disagreed with the tool by half a second
+
+api.md's streaming example computes each record's start as `index * recordDuration`, and the
+caveat under it named EDF+D as the only case needing the record starts from
+`readAnnotations()`. It assumes two things, and EDF+ guarantees neither.
+
+The second is that the first record sits at zero, which a *continuous* file is free not to do.
+`fractional-start.edf` is EDF+C with records at 0.5, 1.5 and 2.5 seconds — contiguous, and
+half a second later than the arithmetic says. The recipe times its first sample at 0.000;
+`convert()` writes 0.500 for that sample. The annotation onsets in the same file keep their
+true values, so an analysis built on the recipe puts every event half a second away from the
+samples it describes.
+
+The tool has recovered that offset since 0.4.9 and `src/convert/timing.ts` describes the
+failure at length; the recipe was the one place still doing it the old way. It now reads
+`readOrigin()` — the cheap version, at most sixteen records rather than the whole annotation
+channel — and a test runs the recipe against `convert()` on that fixture and requires every
+timestamp to match.
+
+## 0.5.30
+
+### Fixed: `npm pack` on a clean checkout produced a package with no code in it
+
+Four files, no `dist/`, no bin, nothing importable — and `npm pack` reported success. Anyone
+packing the repository, or installing it from a git URL, got a package that installs cleanly
+and does nothing.
+
+`prepublishOnly` builds, and runs only for `npm publish`. `npm pack` goes round it, as does a
+git-URL install. Published versions were therefore always fine, which is exactly why this
+could sit there unnoticed: the one path that was covered is the one everybody sees.
+
+A `prepack` script builds now, which is the hook both `npm pack` and `npm publish` run. The
+tarball goes from 4 files to 76; installed into a fresh directory it answers `npx edf2csv
+--version`, exports its 28 names, and converts a recording.
+
+A test holds the shape rather than the tarball, since packing inside the suite would mean
+running a build inside a build: `files` says what ships, `bin`/`exports`/`types` say what has
+to be in it, and `prepack` is what makes the second true when the first is read.
+
 ## 0.5.29
 
 ### Fixed: an annotation channel with no room in it hid the timekeeping in the channel after it

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edf2csv",
-  "version": "0.5.29",
+  "version": "0.5.31",
   "description": "Convert EDF, EDF+ and BDF biosignal recordings (European Data Format) to CSV from the command line. Local, streaming, and never resamples or alters units.",
   "keywords": [
     "edf",
@@ -57,6 +57,7 @@
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "clean": "node -e \"fs.rmSync('dist',{recursive:true,force:true})\"",
+    "prepack": "npm run build",
     "fixtures": "node test/fixtures/generate.mjs",
     "test": "npm run build && npm run fixtures && node --test test/*.test.js",
     "typecheck": "tsc -p tsconfig.json --noEmit",