Upgrading

@platform/sdk is at 1.0.0, its first release, so there are no version-to-version migrations yet. This page is where they will live.

The general process

When a new version ships:

1. Bump @platform/sdk and re-run npm install.
2. Run your typecheck. Because the SDK is strict TypeScript, a removed or renamed API surfaces as a compile error pointing straight at the call site — the fastest possible upgrade signal.
3. Skim the CHANGELOG.md shipped with the package (node_modules/@platform/sdk/CHANGELOG.md) for entries between your old and new versions, looking for Removed and Changed.

Pin intentionally

Pin @platform/sdk to a caret range within a major (^1.0.0) so you get compatible minors and patches automatically, and treat a major bump as a planned migration. See SDK versioning and pinning.

When a breaking change ships

The wire protocol is backwards-compatible within a major version, so the upgrades that need real work are major bumps. When the first one lands, this page will carry a step-by-step migration — what was removed and what to do instead — keyed to its changelog entry.