kharradp-audit-sdk
v1.0.0
Published
HTTP client SDK for product audit microservices (Emploin, Votermood). Posts to /api/audit/ingest. Not the Nest audit sink itself. For Kafka domain events use @kharradp/audit-nestjs.
Readme
kharradp-audit-sdk
HTTP client for product Audit microservices (Emploin, Votermood, …).
- Each product deploys its own
apps/audit+ Mongo (+ optional Kafka sink). - This package is the shared client only (not the Nest service).
- Point
baseUrl/AUDIT_BASE_URLat that product’s audit host.
For Kafka domain producers use @kharradp/audit-core + @kharradp/audit-nestjs.
Install
npm install kharradp-audit-sdkQuick start
import { AuditClient } from 'kharradp-audit-sdk';
const audit = AuditClient.fromEnv(); // AUDIT_BASE_URL, AUDIT_API_KEY, AUDIT_PRODUCT
audit.record({
action: 'UPDATE',
actionName: 'job.status_change',
actor: { type: 'USER', id: 'u1', displayName: 'Ada' },
target: { type: 'JOB', id: 'j1' },
outcome: 'SUCCESS',
});Nest
import { AuditSdkModule } from 'kharradp-audit-sdk/nest';
AuditSdkModule.forRoot({
baseUrl: process.env.AUDIT_BASE_URL!,
product: 'EMPLOIN',
apiKey: process.env.AUDIT_API_KEY,
});Endpoints used
| Method | Path | Purpose |
|--------|------|---------|
| POST | /api/audit/ingest | Write event |
| GET | /api/audit | Search |
| GET | /api/audit/timeline | Per-target timeline |
