@oxvo/browser

@oxvo/browser is the primary OxvoSessions client SDK for browser replay, frontend observability, and plugin-based instrumentation.

Install

npm i @oxvo/browser

Minimal Setup

import Browser from '@oxvo/browser';

const browser = new Browser({
  siteKey: 'ws_live_01HZX8M4B3',
  endpoint: 'https://api.oxvo.com/ingest',
  networkCapture: { captureBodies: true },
});

await browser.start({
  userID: 'acct_2048',
  metadata: {
    plan: 'growth',
    region: 'me-central',
    release: '2026.04',
  },
});

Common Runtime Calls

browser.identify('acct_2048');
browser.setMetadata('environment', 'production');
browser.track('checkout_started', { step: 'shipping' });

When to Add Plugins

Use first-party plugins when you want framework-aware state traces or support tooling:

• @oxvo/browser-redux
• @oxvo/browser-vuex
• @oxvo/browser-zustand
• @oxvo/browser-graphql
• @oxvo/live-assist

For new network instrumentation work, prefer the built-in networkCapture option before adding legacy fetch or axios wrappers.

Local Verification

bun install
bun run test
bun run build

Documentation

• SDK guide: https://docs.oxvo.com/en/sdk
• Methods reference: https://docs.oxvo.com/en/sdk/methods