Askr
Reference

Compatibility and Migration Notes

Use compatibility and migration notes with the current published Askr packages.

  • @askrjs/askr0.0.59

How to use compatibility and migration notes

Align all Askr packages as one tested release set, read declaration and migration changes, then run the real delivery modes before accepting an upgrade.

  1. Import the published @askrjs/askr entrypoint.
  2. Keep compatibility and migration notes configuration next to the component, route, or server composition root that owns it.
  3. Handle pending, unavailable, cancellation, and failure states, then verify the production path.
npm ci
npm ls '@askrjs/*'
npm run typecheck
npm run test
npm run build

Latest-published scope

This site documents the currently published version of each @askrjs package — @askrjs/askr at 0.0.59, @askrjs/ui and @askrjs/themes at 0.0.13, @askrjs/server and @askrjs/auth and @askrjs/node and @askrjs/cli in the 0.0.x range, and so on. Every package is still pre-1.0, so treat minor version bumps as potentially breaking until a package publishes a 1.0.

Clean breaks

Askr's public API favors one vocabulary per concept rather than keeping deprecated aliases around — for example, reactive scope is `defineScope()`/`readScope()` with no legacy `useContext`-style alias shipped alongside it. When a release renames or removes an export, expect it to be gone rather than soft-deprecated, so pin versions deliberately if you can't absorb that immediately.

Package alignment

The @askrjs packages are developed and released together but versioned independently per package.json, so it's possible to end up with mismatched versions if you bump one without the others. When debugging a type or runtime mismatch, check that your installed @askrjs/askr, @askrjs/ui, @askrjs/themes, and @askrjs/server versions were all published around the same time before assuming it's a bug.

Migration checklist

Before upgrading, diff the exports on the relevant API Index pages against what your code currently imports — a missing symbol there means it moved or was removed, not that the docs are stale. Re-run your test suite with @askrjs/askr/testing's route-matching and query-mock helpers after any upgrade, since router and query-state shapes are exactly the kind of thing a minor bump can quietly change.