evelmo

evelmo

TypeScript SDK for Evelmo audit logging.

Installation

npm install evelmo

Quick Start

import { Evelmo } from 'evelmo';

const evelmo = new Evelmo({
  apiKey: process.env.EVELMO_API_KEY!,
});

await evelmo.log({
  action: 'user.invited',
  actionType: 'C',
  eventName: 'User Invited',
  actor: { id: 'user_123', name: 'John' },
  target: { id: 'user_456', type: 'user' },
});

API

new Evelmo(config)

Create a new Evelmo client.

const evelmo = new Evelmo({
  apiKey: 'vrt_live_...',    // Required
  baseUrl: 'https://...',    // Optional, defaults to https://api.evelmo.com
});

evelmo.log(input)

Create an audit log entry.

await evelmo.log({
  action: 'user.invited',           // Action identifier
  actionType: 'C',                  // C=Create, R=Read, U=Update, D=Delete, A=Action
  eventName: 'User Invited',        // Human-readable event name
  actor: {                          // Who performed the action
    id: 'user_123',
    name: 'John Doe',               // Optional
    email: '[e-mail]',      // Optional
  },
  target: {                         // What was affected
    id: 'user_456',
    type: 'user',
    name: 'Jane Smith',             // Optional
  },
  context: {                        // Optional request context
    ip: '192.168.1.1',
    userAgent: 'Mozilla/5.0...',
    location: 'US',
  },
  metadata: {                       // Optional additional data
    role: 'admin',
    team: 'engineering',
  },
  occurredAt: new Date(),           // Optional, defaults to now
});

License

MIT