@nestjs-dash/audit-log 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,60 @@
+# @nestjs-dash/audit-log
+
+The audit-log plugin for nestjs-dash — persists a resource-mutation audit trail and provides a built-in, read-only **Activity** resource for browsing it.
+
+## Architecture: a core + plugin split
+
+Audit logging isn't a `panel.plugins([...])` entry you add — it's split between core and this plugin:
+
+- **Core** (`@nestjs-dash/nestjs`) always runs `AdminAuditInterceptor` on every `AdminController` route, regardless of whether this plugin is installed. It decides *what* to audit (every `@AdminAction(...)`-tagged mutating route, skipping `'view'`) and builds the `before`/`after` payload — but does nothing with that payload unless auditing is turned on.
+- **This plugin** supplies the actual persistence (`AuditLogEntity`, a TypeORM table) and the read-only `AdminActivityResource` for browsing it. `AdminModule` dynamically `import()`s this package at bootstrap only when `audit.enabled` is `true` — it's an ordinary `package.json` dependency, but you never import or wire `AdminActivityResource` into `panel.resources` yourself; `AdminModule` registers it for you under the "System" nav group.
+
+## Install
+
+```bash
+pnpm add @nestjs-dash/audit-log
+```
+
+## Usage
+
+```ts
+import { AdminModule } from '@nestjs-dash/nestjs';
+
+AdminModule.forRootAsync({
+  inject: [DataSource],
+  useFactory: (dataSource: DataSource) => ({
+    autoBindTypeOrm: true,
+    dataSource, // required — audit storage is TypeORM-only, and unlike
+    // `autoBindTypeOrm` (which can find a DataSource via Nest DI on its
+    // own), audit logging insists on getting one explicitly.
+    audit: { enabled: true },
+    // ...
+  }),
+});
+```
+
+`AuditLogEntity` must be listed in your `TypeOrmModule.forRootAsync`'s `entities: [...]` array explicitly — TypeORM's `DataSource` only knows about entities passed there at connection time; it won't discover `AuditLogEntity` just because this package gets `import()`-ed at Nest bootstrap.
+
+## Querying the audit trail yourself
+
+`AuditLogEntity` is a normal TypeORM entity — query it directly (e.g. for dashboard widgets) rather than going through `AdminActivityResource`'s adapter:
+
+```ts
+import { AuditLogEntity } from '@nestjs-dash/audit-log';
+
+const eventsToday = await dataSource
+  .getRepository(AuditLogEntity)
+  .count({ where: { createdAt: MoreThanOrEqual(startOfToday) } });
+```
+
+## What gets logged
+
+Every create/update/delete/bulk-action/relation-manager mutation made through the admin UI or the JSON API, with the actor, the resource/record touched, and the full `before`/`after` snapshot.
+
+## Part of nestjs-dash
+
+This package is one piece of [nestjs-dash](https://github.com/nestjs-dash/nestjs-dash), a NestJS-native admin framework. See the `example-audit-log` demo app for a complete walkthrough, including dashboard widgets built on `AuditLogEntity`.
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs-dash/audit-log",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Audit log plugin for NestJS Dash (resource-mutation audit trail + built-in read-only Activity resource)",
   "license": "MIT",
   "files": [
@@ -17,8 +17,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@nestjs-dash/core": "1.0.0",
-    "@nestjs-dash/nestjs": "1.0.0"
+    "@nestjs-dash/core": "1.1.0",
+    "@nestjs-dash/nestjs": "1.1.0"
   },
   "devDependencies": {
     "@nestjs-dash/typescript-config": "0.1.0",