Version Handling

These docs describe the current v0.2 SDK API. There is one documented client surface: createSimulatorClient(), resource clients, generated protocol types, runtime validators, and MatchSession.

There is no runtime version negotiation and no multi-version docs set yet. Use the SDK package and simulator server from the same release or repository revision.

Package version

The npm package version lives in packages/ts-sdk/package.json. For v0.2, install @my-swu/simulator-client@0.2.x with the matching simulator server.

pnpm add @my-swu/simulator-client@0.2

Wire schema marker

The package exports schemaVersion from the generated schema bundle. Most apps do not need it. It exists so deployment tooling can check that a built SDK and server were generated from the same wire contract.

import { schemaVersion } from '@my-swu/simulator-client'

console.log(schemaVersion)

After contract changes

Regenerate the SDK after changing public request, response, command, event, or socket payload types:

pnpm sdk:build

Then rebuild docs:

pnpm docs:build