Skip to Content
v1.27.1 · shipped Global XHR capture, Hash-router inventory Read the changelog →
Migration guides@mushi-mushi/* 0.x → 1.0

@mushi-mushi/* upgrades

Hours Low risk

Most packages are already on 1.x. @mushi-mushi/core and @mushi-mushi/web are on 1.23.x; react 1.21.x; vue / svelte / angular / node / capacitor on 1.x. Mobile tracks remain independent (react-native 0.20.x, native iOS/Android 0.4.x). Use each package’s CHANGELOG and npx mushi-mushi upgrade for mechanical bumps.

What stays stable

We expect upgrades within the documented public API to not break:

  • The Mushi.init({ projectId, apiKey }) shape — this is the public contract every customer wires.
  • The Mushi.report({ description, ... }) shape.
  • The <MushiProvider> component in React (and framework equivalents).
  • Wire-format API endpoints (/v1/reports, /v1/admin/*).
  • The MCP server protocol.

Possible churn (check CHANGELOG before bumping):

  • Internal capture types exported via @mushi-mushi/core.
  • Legacy Mushi.captureException shims.
  • 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 bump in package.json.

Migration checklist

Migration checklist
7 required steps
  1. Step 01
    Read the package changelog for every Mushi SDK you use
  2. Step 02
    Pin your current versions before upgrading
  3. Step 03
    Run the upgrade helper
  4. Step 04
    Review the diff
  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 package tracks (workspace snapshot)

PackageCurrent track
@mushi-mushi/core / web1.23.x
@mushi-mushi/react1.21.x
@mushi-mushi/vue / svelte / angular1.0.x
@mushi-mushi/node / capacitor1.1.x
@mushi-mushi/react-native0.20.x
@mushi-mushi/cli0.26.x
@mushi-mushi/mcp0.19.x
iOS / Android native0.4.x

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

Last updated on