Skip to main content
Introducing packages.sweber.dev
Documentation menuMigrating to 1.0

Migrating to 1.0

What changed between 0.x releases and what to check when you move to 1.0.

There are no breaking changes between 0.1.0 and 1.0.0. Version 1.0.0 has the same code as 0.9.0; it adds the stability promise. Every release added to the API, and the stored decision format (schema 1) has not changed, so visitors keep their choice when you upgrade. Three behavior details are worth knowing.

SinceDetailWhat to check
0.2.0With the built-in cookie storage, a decision now syncs across open tabs (syncTabs, default on).If you create managers dynamically, call manager.destroy() when you drop one. Set syncTabs: false to turn it off.
0.3.0The stylesheet lives in @permitojs/core/styles.css.@permitojs/react/styles.css still works. No change needed.
0.5.0es, nl, pl and pt are built in.A site that used these language codes with its own translations keeps its texts, because overrides win. Without overrides the built-in texts apply now instead of English.

Moving to 1.0

1.0.0 freezes the API listed as stable on the API status page. The runtime exports of every entry point are pinned by a test, so a change cannot slip in unnoticed. To upgrade:

  • Upgrade Permito Pro first if you use it (0.8.0 or later accepts Permito 1.x), then @permitojs/core and @permitojs/react.
  • Pin both to the same version. They are released together.
  • Run your own accessibility check against your theme and texts, see Accessibility.

After 1.0

Breaking changes only come with a new major version, with a migration note here. A deprecated API stays for at least one minor release and is marked @deprecated in the types.

Permito Pro

Permito Pro 0.8.0 and later accept Permito 0.1 up to, but not including, 2.0 as a peer. Older Pro versions stop at 1.0.0: upgrade Pro first, then Permito.