liaise 5.0.1 → 5.0.3

package/CHANGELOG.md

@@ -5,6 +5,64 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [5.0.3] — 2026-10-04
+
+A documentation release. Nothing in the package's behaviour changes. See
+[MIGRATION.md](./MIGRATION.md#upgrading-to-503).
+
+### Documentation
+
+- **The README is reorganised around what you need first.** It now runs from the
+  problem, to a quick start, a guide, tested recipes and a comparison, and ends with
+  a complete reference. Every recipe in it runs as a test in CI, and
+  `npm run docs:check` fails if the README copy drifts from that test.
+- **`src/types.ts` comments corrected.** More than ten stale or wrong comments,
+  including the claim that a raw string param is never shared, and a comparison of
+  timeouts with axios, XHR and got that the project cannot support, which is removed.
+
+### Fixed
+
+- **The `share` option's type documentation no longer lists signal-replacing
+  middleware as a known limitation.** It was fixed in 3.0.0 (the shared signal is
+  re-merged when a middleware replaces `ctx.request.signal`), and an existing test
+  pins it.
+
+### Added (repository only, not in the package)
+
+- `compare/`, a rerunnable comparison of fetch, axios, ky, ofetch and liaise. The
+  README's comparison section is generated from it.
+- `npm run docs:check`, which fails when a README recipe drifts from its test or an
+  in-page link has no heading.
+- Tests for behaviour the README states: a throwing middleware gives
+  `kind: 'middleware'` with `status: 0`; a caller's cancel still ends the call as
+  `'abort'` when a middleware replaces `ctx.request.signal`, without aborting the
+  request itself; a header added by middleware is not part of the `share` key;
+  and the defaults of `retryMiddleware` (`max` 3, `baseDelay` 250,
+  `maxDelay` 30000) and `cacheMiddleware` (`ttl` 5 minutes, `maxSize` 50).
+
+## [5.0.2] — 2026-10-04
+
+### Fixed
+
+- **A path parameter with no usable value is refused instead of sent.** A token
+  was filled with `String(value)` unchecked, so `getUser({ id: undefined })` on
+  `/users/:id` fetched `/users/undefined`, and `null`, `''`, an object or an array
+  built `/users/null`, `/users/`, `/users/%5Bobject%20Object%5D` or `/users/1%2C2`.
+  The usual cause is a component rendering before the id has loaded. Such a call
+  now returns an error Result (`kind: 'network'`, a `TypeError` naming each bad
+  param, e.g. `Path parameter "id" is undefined in path "/users/:id", so the call
+  was not sent.`) and nothing reaches the server. Accepted values are non-empty
+  strings, finite numbers, bigints and booleans; a `Date` is refused with a hint
+  to convert it first (`toISOString()` or `getTime()`), as in a query string.
+  `NaN` and `Infinity` are refused too. See
+  [MIGRATION.md](./MIGRATION.md#upgrading-to-502).
+
+### Changed
+
+- The README's size figures are re-measured with `npm run size`: about 5.8 kB
+  gzipped for a REST-only import, 6.9 kB for the core entry, 8.0 kB with all
+  middleware (the new check and its error messages add about 0.2 kB).
+
 ## [5.0.1] — 2026-10-03
 
 A bug-fix release from an audit of 5.0.0. Nothing in the API changes; a few calls
@@ -1008,6 +1066,8 @@ Initial release of the rewritten client. Reconstructed from the release commit
   `ArrayBuffer` and strings
 - Response parsing as `json`, `text`, `blob`, `arrayBuffer` or `formData`
 
+[5.0.3]: https://github.com/iremlopsum/liaise/compare/v5.0.2...v5.0.3
+[5.0.2]: https://github.com/iremlopsum/liaise/compare/v5.0.1...v5.0.2
 [5.0.1]: https://github.com/iremlopsum/liaise/compare/v5.0.0...v5.0.1
 [5.0.0]: https://github.com/iremlopsum/liaise/compare/v4.4.3...v5.0.0
 [4.4.3]: https://github.com/iremlopsum/liaise/compare/v4.4.2...v4.4.3

package/MIGRATION.md

@@ -7,6 +7,22 @@ For the full record of what changed in each release, see [CHANGELOG.md](./CHANGE
 
 ---
 
+## Upgrading to 5.0.3
+
+No action needed. Documentation only, plus corrected type comments in `src/types.ts`.
+
+---
+
+## Upgrading to 5.0.2
+
+No code changes needed. A call whose path parameter is `undefined`, `null`, an
+empty string, an object, an array, a `Date`, a function, a symbol, `NaN` or `Infinity` now returns an
+error Result instead of being sent to a URL like `/users/undefined`. Those calls
+were already hitting the wrong URL; now they say so. If you relied on a literal
+`null` or `undefined` segment, pass the string (`'null'`) explicitly.
+
+---
+
 ## Upgrading to 5.0.1
 
 No code changes for most callers. Six things you may observe.