Skip to content

0.3.1 - #24

Merged
jackmisner merged 1 commit into
mainfrom
release/0.3.1
Aug 20, 2026
Merged

0.3.1#24
jackmisner merged 1 commit into
mainfrom
release/0.3.1

Conversation

@jackmisner

Copy link
Copy Markdown
Owner

Documentation-only release. The published code is byte-identical to 0.3.0 — no behaviour, API or dependency changes. If you are on 0.3.0 there is nothing to gain by upgrading beyond correct docs on the npm page.

Why this exists

0.3.0's npm tarball shipped with a README that predated the final round of changes. The code was correct; the docs were behind. This release republishes the same code with the corrected README.

What the README now says that it didn't

  • The Node requirement. engines.node moved from >=16.0.0 to >=20.0.0 in 0.3.0, but the README's platform section covered browsers only — a conspicuous gap now that the package ships a /server entry point. Installation now states the requirement, and is explicit that CI exercises Node 22/24/26 so nothing below 22 is actually verified.
  • The types added in 0.3.0. The TypeScript Types list omitted CaptureReport, UtmRejection, UtmRejectionReason, the sanitizer and PII-filter report types, and both server types. It reads as an inventory of exports, so an incomplete one misleads.
  • captureUtmParametersWithReport in the API Reference. It had a prose section but no signature entry where readers look for one. Added, along with onMaxLength, valuePattern and lowercaseValues in the captureUtmParameters options example — those were documented further down but missing from the first example anyone reads.
  • The three entry points, listed at install time rather than left to discovery.

Test Plan

  • npm test — 635 passing
  • npm run type-check / lint / format:check — clean
  • npm run build — succeeds
  • No source, config or dependency changes relative to 0.3.0 — git diff v0.3.0..v0.3.1 -- src/ package.json is empty apart from the version field

@jackmisner
jackmisner merged commit 54c54d7 into main Aug 20, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant