Client

import { Client } from '@miradorlabs/web-sdk';

import { Client } from '@miradorlabs/nodejs-sdk';

new Client(apiKey: string, options?: ClientOptions)

new Client(apiKey?: string, options?: ClientOptions)

interface ClientOptions {
  apiUrl?: string;              // Gateway URL (default: ingest-gateway-dev.mirador.org:443)
  keepAliveIntervalMs?: number; // Keep-alive ping interval in milliseconds (default: 10000)
}

const client = new Client('your-api-key');

const client = new Client('your-api-key', {
  apiUrl: 'https://custom-gateway.example.com:443'
});

const client = new Client('your-api-key', {
  keepAliveIntervalMs: 15000  // Ping every 15 seconds
});

trace(options?: TraceOptions): Trace

trace(options?: TraceOptions): Trace

const trace = client.trace({ name: 'UserAction' });

const trace = client.trace({
  name: 'CriticalOperation',
  includeUserMeta: true,
  maxRetries: 5,
  retryBackoff: 2000
});

const trace = client.trace({ name: 'UserAction' });

const trace = client.trace({ name: 'UserAction', captureStackTrace: false });

// client.ts
import { Client } from '@miradorlabs/web-sdk';

export const mirador = new Client(process.env.MIRADOR_API_KEY);

// component.ts
import { mirador } from './client';

function handleAction() {
  const trace = mirador.trace({ name: 'ComponentAction' });
  // ...
}

// client.ts
import { Client } from '@miradorlabs/nodejs-sdk';

export const mirador = new Client(process.env.MIRADOR_API_KEY);

// handler.ts
import { mirador } from './client';

async function handleAction() {
  const trace = mirador.trace({ name: 'ComponentAction' });
  await trace.create();
  // ...
}

const client = new Client('api-key');

// User flow trace
const userTrace = client.trace({ name: 'UserSession' });

// Background operation trace
const bgTrace = client.trace({ name: 'BackgroundSync' });

// Both traces operate independently
userTrace.addEvent('user_clicked');
bgTrace.addEvent('sync_started');

const client = new Client('api-key');

// User flow trace
const userTrace = client.trace({ name: 'UserSession' });
await userTrace.create();

// Background operation trace
const bgTrace = client.trace({ name: 'BackgroundSync' });
await bgTrace.create();

// Both traces operate independently
userTrace.addEvent('user_clicked');
bgTrace.addEvent('sync_started');

const client = new Client(
  process.env.MIRADOR_API_KEY
);