Skip to Content
v1.36.0 · shipped One-screen report · Looks like your app Read the changelog →
Migration guidesMushi Mushi SDK upgrades (0.x → 1.x)

Mushi Mushi SDK upgrades (0.x → 1.x)

Hours Low risk

Most packages are on 1.x. @mushi-mushi/core 1.33.4, web and react 1.33.3, node 1.3.4, capacitor 1.1.4, vue / svelte / angular 1.0.4 (npm, 2026-10-29). @mushi-mushi/react-native is still 0.x (0.24.4). The native iOS and Android SDKs are 0.4.0 and are not on npm. Read each package’s CHANGELOG, then run npx mushi-mushi upgrade to bump versions.

Breaking changes from 0.x

Taken from the 1.0.0 entries in each package’s CHANGELOG.md, except the React Native endpoint row, which comes from the SDK source (React Native is still 0.x):

PackageWhat changed at 1.0What you do
@mushi-mushi/core, web, reactNo breaking changes from 0.9. 1.0 added identify, setTag / setTags / clearTag, addBreadcrumb and structured captureException.Bump the version.
@mushi-mushi/vueMushiPlugin calls Mushi.init() itself and depends on @mushi-mushi/web.Remove your own Mushi.init(config) call and the separate @mushi-mushi/web install.
@mushi-mushi/svelteinitMushi() calls Mushi.init() itself.Remove your own Mushi.init(config) call.
@mushi-mushi/angularprovideMushi() calls Mushi.init() itself.Remove your own Mushi.init(config) call.
@mushi-mushi/capacitorMushi.configure() is the init call (Mushi.init() is now an alias for it). API keys use the mushi_* format.Check your key starts with mushi_.
@mushi-mushi/nodeStable 1.0 API, no functional changes from 0.x.Bump the version.
@mushi-mushi/react-native (still 0.x)MushiProvider accepts a config object as well as bare props, and reads env vars when neither is set. endpoint is deprecated in favour of apiEndpoint.Rename endpoint to apiEndpoint.

What stays stable

Within 1.x, these are meant not to break:

  • The Mushi.init({ projectId, apiKey }) shape and the instance it returns.
  • Instance methods such as setUser, setMetadata, captureEvent, captureException, open and report({ category }).
  • The <MushiProvider> component in React (and the framework equivalents).
  • Wire-format API endpoints (/v1/reports, /v1/admin/*).
  • The MCP server protocol.

Check the CHANGELOG before bumping for:

  • Internal capture types exported via @mushi-mushi/core.
  • Bundled-CSS export paths and default privacy-redaction lists.

If you build only against the documented public API (everything under /sdks/* in these docs), most upgrades are a single version bump.

Migration checklist

Migration checklist
7 required steps
  1. Step 01
    Read the package changelog for every Mushi Mushi SDK you use
  2. Step 02
    Pin your current versions before upgrading
  3. Step 03
    Bump the packages
  4. Step 04
    Apply the code changes yourself
  5. Step 05
    Rebuild + run your test suite
  6. Step 06
    Smoke-test on a real device / browser
  7. Step 07
    Roll out to production behind a canary

Current versions

From the npm registry on 2026-10-29:

PackageVersion
@mushi-mushi/core1.33.4
@mushi-mushi/web / react1.33.3
@mushi-mushi/vue / svelte / angular1.0.4
@mushi-mushi/node1.3.4
@mushi-mushi/capacitor1.1.4
@mushi-mushi/react-native0.24.4
@mushi-mushi/cli0.35.0
@mushi-mushi/mcp0.30.0
iOS (CocoaPods / SwiftPM) and Android (Gradle)0.4.0, not on npm

See the SDK index version matrix for the live workspace snapshot.

Last updated on