gkm-audit

gkm-audit

Docs: https://geekmidas.github.io/toolbox/packages/audit.html

Activation

• Files importing @geekmidas/audit
• Files using DefaultAuditor, KyselyAuditStorage, AuditableAction
• Files calling .audit(), .flush(), or defining audit action schemas
• Transactional audit writes alongside domain operations

Key patterns

import { DefaultAuditor, KyselyAuditStorage } from '@geekmidas/audit';
import type { AuditableAction } from '@geekmidas/audit';

type AppAuditAction =
  | AuditableAction<'user.created', { userId: string; email: string }>
  | AuditableAction<'order.placed', { orderId: string; total: number }>;

const storage = new KyselyAuditStorage({ db, tableName: 'audit_logs' });
const auditor = new DefaultAuditor<AppAuditAction>({
  actor: { id: 'user-123', type: 'user' },
  storage,
});

auditor.audit('user.created', { userId: '789', email: '[email protected]' });
await auditor.flush();

• Compile-time validation of audit action names and payload shapes
• Transactional support — audit writes are atomic with domain changes
• KyselyAuditStorage is the default persistence adapter; pluggable for other ORMs
• Actor tracking: { id, type, metadata } injected per audit call
• Batch flush() for high-throughput scenarios

Integration points

• @geekmidas/db — KyselyAuditStorage depends on Kysely DB instance
• @geekmidas/logger — audit events can be streamed to structured logs
• @geekmidas/constructs — emit audit events from endpoint handlers