softechlog-node

Drop-in user activity logging SDK for Node.js and TypeScript.

Install

npm install softechlog-node

Quick start

// lib/softechlog.ts — initialize once, import everywhere
import { Softechlog } from 'softechlog-node';

export const log = new Softechlog({
  secretKey: process.env.SOFTECHLOG_SECRET_KEY!,
});

Track an event

import { log } from '@/lib/softechlog';

// Fire-and-forget (non-blocking — recommended)
log.track({
  actor: { id: req.user.id, name: req.user.name, email: req.user.email },
  action: 'member.invited',
  target: { type: 'workspace', id: workspace.id, name: workspace.name },
  metadata: { role: 'admin' },
});

// With await (if you need confirmation or the event ID)
const event = await log.track({ ... });
console.log(event?.id); // evt_abc123

Action naming convention

resource.verb

Examples:
  member.invited       member.removed      member.role_changed
  file.uploaded        file.deleted        file.downloaded
  project.created      project.archived    project.deleted
  payment.succeeded    payment.failed
  plan.upgraded        plan.downgraded

Options

| Option | Type | Default | Description | |--------|------|---------|-------------| | secretKey | string | required | Your stl_sk_… secret key | | baseUrl | string | https://api.softechlog.com | Override the API base URL | | timeout | number | 5000 | Request timeout in ms | | silent | boolean | false | Suppress console warnings on errors |

Errors are always swallowed — a logging failure will never crash your app.