ReMOAT SDK API Reference

export interface RemoatConfig {
  /** Workspace API Key (Required) */
  apiKey: string;
  /** UI presentation mode: 'floating' pill widget, 'hidden' (no UI), or 'custom' */
  mode?: 'floating' | 'hidden' | 'custom';
  /** Selectors for DOM elements whose inputs/text should be masked or blocked */
  redactSelectors?: string[];
  /** Redact sensitive HTTP request/response headers (Authorization, Cookie, etc.). Defaults to true. */
  redactHeaders?: boolean;
  /** Environment tag: 'production' | 'staging' | 'development' */
  environment?: 'production' | 'staging' | 'development' | string;
  /** 1-Click pairing auto-discovery (Default: true) */
  autoPair?: boolean;
  /** Auto start connection on load (Default: true) */
  autoConnect?: boolean;
  /** Show floating QA overlay widget (Default: true unless mode is hidden/custom) */
  showOverlay?: boolean;
  /** Mask sensitive password & payment inputs (Default: true) */
  maskInput?: boolean;
  /** Permit interactive remote mouse & click control (Default: true) */
  allowControl?: boolean;
  /** Live rrweb DOM mutation recording (Default: true) */
  captureDom?: boolean;
  /** Console logs & bidirectional REPL evaluation (Default: true) */
  captureConsole?: boolean;
  /** Network fetch / XHR telemetry streaming (Default: true) */
  captureNetwork?: boolean;
  /** LocalStorage & cookie inspector (Default: true) */
  captureStorage?: boolean;
  /** Persist 6-digit pairing PIN across refreshes (Default: true) */
  persistPin?: boolean;
  /** Active screen sharing glowing border indicator (Default: false) */
  remoteViewingGlow?: boolean;
  /** Custom backend signaling URL override */
  apiUrl?: string;
}

import ReMOAT from '@remoat.dev/sdk';

// Initialize ReMOAT in your root client entry
ReMOAT.init({
  apiKey: process.env.NEXT_PUBLIC_REMOAT_KEY,
  mode: 'floating', // 'floating' pill, 'hidden', or 'custom'
  redactSelectors: ['.credit-card-input', '[data-sensitive="true"]'],
  redactHeaders: true,
});

// Start a session and retrieve the 6-digit PIN
const pin = await ReMOAT.startSession();
console.log('Pairing PIN:', pin);

// Check if currently connected to a remote developer
const isConnected = ReMOAT.isConnected();

// Stop active session and close WebRTC peer connection
ReMOAT.endSession();

// Listen to session lifecycle events
ReMOAT.on('connected', (session) => {
  console.log('Session established with ID:', session.id);
});

ReMOAT.on('disconnected', () => {
  console.log('Remote debugging ended.');
});