basalt / audit-viewer/src / AuditViewer
Class: AuditViewer
Defined in: audit-viewer/src/viewer.ts:79
Read-only lens over the append-only audit trail: tenant-scoped, filterable, paginated queries plus aggregate stats. Wraps Audit; the trail itself stays immutable.
Constructors
Constructor
> new AuditViewer(audit, options?, tenancyActive?): AuditViewer
Defined in: audit-viewer/src/viewer.ts:84
Parameters
audit
options?
AuditViewerOptions = {}
tenancyActive?
() => boolean
Whether the host app is multi-tenant, i.e. whether @basaltkit/tenancy is registered. auditViewerPlugin wires this to the container's 'tenancy:active' metadata marker — a signal, not an import, so this generic package never depends on the opt-in SaaS layer.
Defaults to false: a hand-built viewer behaves single-tenant.
Returns
AuditViewer
Methods
get()
> get(id, tenantId?): Promise<AuditEntry | null>
Defined in: audit-viewer/src/viewer.ts:109
Parameters
id
string
tenantId?
string
Returns
Promise<AuditEntry | null>
page()
> page(query?): Promise<AuditPage>
Defined in: audit-viewer/src/viewer.ts:102
Parameters
query?
ViewerQuery = {}
Returns
Promise<AuditPage>
stats()
> stats(query?): Promise<AuditStats>
Defined in: audit-viewer/src/viewer.ts:114
Parameters
query?
ViewerQuery = {}
Returns
Promise<AuditStats>