Stability and versions

Integral 1.0 is a promise: what is documented here keeps working in every 1.x release. You can update within 1.x without changing your code.

What is frozen

• Formats. License keys (int1.…), revocation lists (intr1.…) and activation requests (intq1.…) keep their format. A license signed today verifies in every 1.x release, and a license signed by a later 1.x release verifies in earlier ones as long as it only uses fields they know. A new format would get a new prefix and be read next to the old one.
• Public API. The functions, options and result shapes in the API reference, and the routes, options and store interface of Integral Pro. New options and new fields in results may be added; existing ones are not removed or renamed, and their meaning does not change.
• Failure reasons. The reason values of verifyLicense, bindLicense and the server's results may gain new values. Handle unknown values like an invalid license.
• Database schema. Integral Pro only adds tables and columns, with IF NOT EXISTS. Run sqlSchema again after an update; existing data stays untouched.

What can change in a minor release

New functions, options, routes, events, labels and tables; stricter validation of input that was never valid; fixes. Anything that could break a working setup waits for 2.0 and is announced in the release notes at least one minor release before.

Version numbers

Integral follows semantic versioning: patch for fixes, minor for new features, major for breaking changes. @sweberdev/integral and @sweberdev/integral-react always have the same version. @weber-development/integral-server and -portal have the same version as each other and work with the free packages of the same major version (peerDependencies).

Updating from 0.x

There are no breaking changes between 0.3 and 1.0: licenses, keys and databases keep working. For Integral Pro run sqlSchema once to add the tables of floating licenses, usage and the audit trail (0.4.0). Install the 1.x versions of the free and Pro packages together.