On this page

Contract lifecycle

Upgrade without losing event meaning

Track the SDK version separately from the stable event envelope and treat new probes and fields as additive input.

Current release: v0.8.1

The current event envelope is schema_version: 1. The typed catalog format is catalog_version: 2 because it includes field types and JSON Schema fragments.

Versioning rules

Package version

Tracks implementation, documentation, probes, fixes, and native behavior.

Event schema version

Changes only when the RawSignalEvent envelope changes incompatibly.

Additive fields

New probe IDs and success-data fields may appear without an event schema bump.

Breaking probe data

An incompatible probe payload should use a new probe ID so old and new meanings cannot collide.

Upgrade checklist

  1. Read release notes and compare the typed probe catalog.
  2. Run native builds for each supported React Native version.
  3. Review new permissions, sensitive fields, default states, and privacy implications.
  4. Update backend allowlists without rejecting unknown additive fields.
  5. Collect in shadow mode and monitor missingness, errors, latency, and distribution drift.
  6. Promote new fields into feature logic only after representative physical-device calibration.

Release history

ReleaseMain changeNotes
0.8.1Honest unreadable-state handling and Required-Reason API cleanupRelease
0.8.0Broader root, Frida, emulator, and iOS reverse-engineering evidenceRelease
0.7.0Hook stack frames and wider integrity artifactsRelease
0.6.0Install provenance and transaction-time observationsRelease
0.5.xHardware, network, app metadata, documentation, and compatibilityAll releases
0.4.0Initial OSS gap signal packageRelease