Versioning and compatibility
How the four packages are versioned, what the protocol version means, and what is supported.
One version for all four packages
@baseera/core, @baseera/react, @baseera/node and @baseera/ui share one version. They are released together, so @baseera/react and @baseera/ui always depend on a @baseera/core that matches. Install all of them at the same version.
{
"dependencies": {
"@baseera/react": "0.1.0",
"@baseera/ui": "0.1.0",
"@baseera/node": "0.1.0"
}
}The first public release is 0.1.0. It is pending: the packages are not on npm yet, and every package is at 0.0.0 in the repository. Until it ships, install from the repository workspace.
Semver
The packages follow semantic versioning, with one caveat that applies to every 0.x release: a minor version can include a breaking change while the major version is 0. Pin an exact version, or a tilde range, until 1.0, and read the changelog before you upgrade.
| Change | Version bump after 1.0 |
|---|---|
| A bug fix | Patch |
| A new export, prop or option that does not break existing code | Minor |
| A removed or changed export, prop or behavior | Major |
Every change that affects a published package carries a changeset, and the changelog lists it.
Protocol version
The SDK and the runtime talk over a versioned wire protocol. The current version is v0, exported as PROTOCOL_VERSION from @baseera/core, @baseera/react and @baseera/node.
import { PROTOCOL_VERSION } from "@baseera/core";
PROTOCOL_VERSION; // "v0"Every path starts with the version, for example /v0/sessions. A breaking change to the protocol ships as /v1 next to /v0, so an older SDK keeps working against a runtime that serves both. Inside a version, the protocol only adds things: a client skips stream events it does not know, so new event types can be added without breaking older SDKs. Write your own event handling the same way, with a default that ignores what it does not know.
The full protocol is in the API reference.
Supported environments
| Environment | Supported |
|---|---|
| React | 18 and 19 |
| Next.js | App Router |
| Vite | Any version that serves a React app |
| Node (server) | 20 or later for @baseera/node and @baseera/core |
| Browsers | Any with fetch, ReadableStream and Web Crypto where used |
| Edge runtimes and workers | @baseera/core, which needs only fetch |
| TypeScript | 5.x. Types ship with each package. |
| Zod | 4, a peer dependency of @baseera/react |
Upgrading
Read the changelog
Look for breaking changes between your version and the new one.
Upgrade all four together
Bump every @baseera/* package you use to the same version.
Type-check and test
Run your type check. A removed export or a changed prop shows up as a type error.