Audit
Description
Audit table pages, model filters and change presenters for Enso UI.
Installation
Install the package:
yarn add @enso-ui/audit
This package is also available through the full enso-ui workspace bundle.
Features
- exports the audit index page used by the system route group
- filters audit rows by event, audited model, audited model id, user and creation date
- loads audited model options from the backend
system.audit.modelssource - renders row-level create/update/delete payloads inside a closeable popover
- supports click-to-filter tags for event, model, audited id and user avatar columns
- integrates audit rows with user avatars and the backend table definition
Usage
import AuditsIndex from '@enso-ui/audit';
API
Index
Default export for the audit table page.
Import: @enso-ui/audit
Audit
Popover change renderer used by the audit table.
Import: @enso-ui/audit/src/bulma/pages/audit/components/Audit.vue
Props:
event: stringaudit event type.changes: objectbackend create/update/delete payload.
Model
Plain attribute renderer used for create/delete payloads.
Import: @enso-ui/audit/src/bulma/pages/audit/components/Model.vue
Updated
Before/after renderer used for update payloads.
Import: @enso-ui/audit/src/bulma/pages/audit/components/Updated.vue
Routes
system/audit
Route group:
system.audit.index
Page:
src/bulma/pages/audit/Index.vue
The model filter expects the companion backend source:
system.audit.modelsGET api/system/audit/models
Companion Backend Package
The backend companion provides the audit table definition, audited model options, change payloads and route group consumed by the page.
Depends On
Contributions
are welcome. Pull requests are great, but issues are good too.
Thank you to all the people who already contributed to Enso!