@zola_do/audit 0.2.8 → 0.2.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -25
- package/dist/audit.dto.d.ts +1 -1
- package/dist/audit.module.js +6 -1
- package/dist/audit.module.js.map +1 -1
- package/dist/audit.subscriber.d.ts +2 -2
- package/dist/audit.subscriber.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -49,8 +49,8 @@ APPLICATION_NAME=my-app
|
|
|
49
49
|
### 2. Register Module
|
|
50
50
|
|
|
51
51
|
```typescript
|
|
52
|
-
import { Module } from
|
|
53
|
-
import { AuditModule } from
|
|
52
|
+
import { Module } from '@nestjs/common';
|
|
53
|
+
import { AuditModule } from '@zola_do/audit';
|
|
54
54
|
|
|
55
55
|
@Module({
|
|
56
56
|
imports: [AuditModule],
|
|
@@ -61,10 +61,10 @@ export class AppModule {}
|
|
|
61
61
|
### 3. Mark Routes for Audit
|
|
62
62
|
|
|
63
63
|
```typescript
|
|
64
|
-
import { Controller, Post, Body } from
|
|
65
|
-
import { AuditRmqEvent } from
|
|
64
|
+
import { Controller, Post, Body } from '@nestjs/common';
|
|
65
|
+
import { AuditRmqEvent } from '@zola_do/audit';
|
|
66
66
|
|
|
67
|
-
@Controller(
|
|
67
|
+
@Controller('orders')
|
|
68
68
|
export class OrdersController {
|
|
69
69
|
@Post()
|
|
70
70
|
@AuditRmqEvent()
|
|
@@ -113,7 +113,7 @@ export class OrdersController {
|
|
|
113
113
|
Marks a controller method for audit logging:
|
|
114
114
|
|
|
115
115
|
```typescript
|
|
116
|
-
@Controller(
|
|
116
|
+
@Controller('orders')
|
|
117
117
|
export class OrdersController {
|
|
118
118
|
@Post()
|
|
119
119
|
@AuditRmqEvent()
|
|
@@ -121,9 +121,9 @@ export class OrdersController {
|
|
|
121
121
|
// Logs: { userId, organization, method, path, body, timestamp }
|
|
122
122
|
}
|
|
123
123
|
|
|
124
|
-
@Put(
|
|
125
|
-
@AuditRmqEvent({ action:
|
|
126
|
-
updateOrder(@Param(
|
|
124
|
+
@Put(':id')
|
|
125
|
+
@AuditRmqEvent({ action: 'UPDATE_ORDER' })
|
|
126
|
+
updateOrder(@Param('id') id: string, @Body() dto: UpdateOrderDto) {
|
|
127
127
|
// Logs with custom action name
|
|
128
128
|
}
|
|
129
129
|
}
|
|
@@ -136,13 +136,13 @@ Excludes specific routes from audit logging:
|
|
|
136
136
|
```typescript
|
|
137
137
|
@Controller()
|
|
138
138
|
export class HealthController {
|
|
139
|
-
@Get(
|
|
139
|
+
@Get('health')
|
|
140
140
|
@IgnoreLogger()
|
|
141
141
|
healthCheck() {
|
|
142
|
-
return { status:
|
|
142
|
+
return { status: 'ok' };
|
|
143
143
|
}
|
|
144
144
|
|
|
145
|
-
@Get(
|
|
145
|
+
@Get('metrics')
|
|
146
146
|
@IgnoreLogger()
|
|
147
147
|
metrics() {
|
|
148
148
|
return { requests: 1000 };
|
|
@@ -155,9 +155,9 @@ export class HealthController {
|
|
|
155
155
|
The `AuditSubscriber` automatically tracks entity changes:
|
|
156
156
|
|
|
157
157
|
```typescript
|
|
158
|
-
import { Module } from
|
|
159
|
-
import { TypeOrmModule } from
|
|
160
|
-
import { AuditSubscriber } from
|
|
158
|
+
import { Module } from '@nestjs/common';
|
|
159
|
+
import { TypeOrmModule } from '@nestjs/typeorm';
|
|
160
|
+
import { AuditSubscriber } from '@zola_do/audit';
|
|
161
161
|
|
|
162
162
|
@Module({
|
|
163
163
|
imports: [
|
|
@@ -200,7 +200,7 @@ interface AuditLog {
|
|
|
200
200
|
### RabbitMQ Config
|
|
201
201
|
|
|
202
202
|
```typescript
|
|
203
|
-
import { auditLoggerConfig } from
|
|
203
|
+
import { auditLoggerConfig } from '@zola_do/audit';
|
|
204
204
|
|
|
205
205
|
// Uses RMQ_URL from environment
|
|
206
206
|
export const rmqConfig = auditLoggerConfig;
|
|
@@ -209,15 +209,15 @@ export const rmqConfig = auditLoggerConfig;
|
|
|
209
209
|
### Manual Audit Publishing
|
|
210
210
|
|
|
211
211
|
```typescript
|
|
212
|
-
import { Injectable } from
|
|
213
|
-
import { ClientProxy } from
|
|
214
|
-
import { Inject } from
|
|
215
|
-
import { AUDIT_RMQ_EVENT } from
|
|
212
|
+
import { Injectable } from '@nestjs/common';
|
|
213
|
+
import { ClientProxy } from '@nestjs/microservices';
|
|
214
|
+
import { Inject } from '@nestjs/common';
|
|
215
|
+
import { AUDIT_RMQ_EVENT } from '@zola_do/audit';
|
|
216
216
|
|
|
217
217
|
@Injectable()
|
|
218
218
|
export class OrderService {
|
|
219
219
|
constructor(
|
|
220
|
-
@Inject(
|
|
220
|
+
@Inject('AUDIT_CLIENT') private readonly auditClient: ClientProxy,
|
|
221
221
|
) {}
|
|
222
222
|
|
|
223
223
|
async createOrder(dto: CreateOrderDto, user: any) {
|
|
@@ -227,8 +227,8 @@ export class OrderService {
|
|
|
227
227
|
this.auditClient.emit(AUDIT_RMQ_EVENT, {
|
|
228
228
|
userId: user.id,
|
|
229
229
|
organizationId: user.organizationId,
|
|
230
|
-
action:
|
|
231
|
-
entity:
|
|
230
|
+
action: 'ORDER_CREATED',
|
|
231
|
+
entity: 'Order',
|
|
232
232
|
entityId: order.id,
|
|
233
233
|
newValues: order,
|
|
234
234
|
timestamp: new Date(),
|
|
@@ -335,7 +335,7 @@ import {
|
|
|
335
335
|
AuditLoggerInterceptor,
|
|
336
336
|
AuditSubscriber,
|
|
337
337
|
auditLoggerConfig,
|
|
338
|
-
} from
|
|
338
|
+
} from '@zola_do/audit';
|
|
339
339
|
```
|
|
340
340
|
|
|
341
341
|
## Best Practices
|
|
@@ -364,7 +364,7 @@ export class HealthController {
|
|
|
364
364
|
@Get()
|
|
365
365
|
@IgnoreLogger() // Don't audit health checks
|
|
366
366
|
health() {
|
|
367
|
-
return { status:
|
|
367
|
+
return { status: 'ok' };
|
|
368
368
|
}
|
|
369
369
|
}
|
|
370
370
|
```
|
package/dist/audit.dto.d.ts
CHANGED
package/dist/audit.module.js
CHANGED
|
@@ -51,7 +51,12 @@ function createAuditModuleConfig(options = {}) {
|
|
|
51
51
|
providers.push({
|
|
52
52
|
provide: core_1.APP_INTERCEPTOR,
|
|
53
53
|
useFactory: (reflector, connection, rmsRMQClient, extraSinks) => new audit_logger_interceptor_1.AuditLoggerInterceptor(reflector, connection, rmsRMQClient, extraSinks),
|
|
54
|
-
inject: [
|
|
54
|
+
inject: [
|
|
55
|
+
core_1.Reflector,
|
|
56
|
+
typeorm_1.DataSource,
|
|
57
|
+
audit_logger_enum_1.AuditLoggerRMQClient,
|
|
58
|
+
audit_constants_1.AUDIT_EXTRA_SINKS,
|
|
59
|
+
],
|
|
55
60
|
});
|
|
56
61
|
}
|
|
57
62
|
catch (error) {
|
package/dist/audit.module.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"audit.module.js","sourceRoot":"","sources":["../src/audit.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,yDAAqD;AACrD,yEAAoE;AACpE,2CAAuD;AACvD,uCAA0D;AAC1D,yDAAmE;AACnE,qCAAqC;AACrC,+DAA0D;AAC1D,uDAAsD;AACtD,2DAA2D;AAM3D,SAAS,kBAAkB;IACzB,IAAI,CAAC;QACH,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAKD,SAAS,wBAAwB;IAC/B,IAAI,CAAC;QACH,OAAO,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,SAAS,uBAAuB,
|
|
1
|
+
{"version":3,"file":"audit.module.js","sourceRoot":"","sources":["../src/audit.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,yDAAqD;AACrD,yEAAoE;AACpE,2CAAuD;AACvD,uCAA0D;AAC1D,yDAAmE;AACnE,qCAAqC;AACrC,+DAA0D;AAC1D,uDAAsD;AACtD,2DAA2D;AAM3D,SAAS,kBAAkB;IACzB,IAAI,CAAC;QACH,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAKD,SAAS,wBAAwB;IAC/B,IAAI,CAAC;QACH,OAAO,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,SAAS,uBAAuB,CAAC,UAAkC,EAAE;;IAInE,MAAM,OAAO,GAAU,EAAE,CAAC;IAC1B,MAAM,SAAS,GAAU,CAAC,kCAAe,CAAC,CAAC;IAE3C,MAAM,UAAU,GAAG,kBAAkB,EAAE,CAAC;IACxC,MAAM,gBAAgB,GAAG,wBAAwB,EAAE,CAAC;IAEpD,IAAI,UAAU,IAAI,gBAAgB,EAAE,CAAC;QACnC,IAAI,CAAC;YACH,OAAO,CAAC,IAAI,CAAC,6BAAa,CAAC,QAAQ,CAAC,CAAC,uCAAiB,CAAC,CAAC,CAAC,CAAC;YAC1D,SAAS,CAAC,IAAI,CAAC;gBACb,OAAO,EAAE,mCAAiB;gBAC1B,QAAQ,EAAE,MAAA,OAAO,CAAC,UAAU,mCAAI,EAAE;aACnC,CAAC,CAAC;YACH,SAAS,CAAC,IAAI,CAAC;gBACb,OAAO,EAAE,sBAAe;gBACxB,UAAU,EAAE,CACV,SAAoB,EACpB,UAAsB,EACtB,YAAyB,EACzB,UAAiB,EACjB,EAAE,CACF,IAAI,iDAAsB,CACxB,SAAS,EACT,UAAU,EACV,YAAY,EACZ,UAAU,CACX;gBACH,MAAM,EAAE;oBACN,gBAAS;oBACT,oBAAU;oBACV,wCAAoB;oBACpB,mCAAiB;iBAClB;aACF,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,EAAE,CAAC;gBAC1C,OAAO,CAAC,IAAI,CACV,mFAAmF,CACpF,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;SAAM,CAAC;QACN,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,EAAE,CAAC;YAC1C,IAAI,CAAC,UAAU,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACrC,OAAO,CAAC,IAAI,CACV,gGAAgG,CACjG,CAAC;YACJ,CAAC;iBAAM,IAAI,CAAC,UAAU,EAAE,CAAC;gBACvB,OAAO,CAAC,IAAI,CACV,4EAA4E,CAC7E,CAAC;YACJ,CAAC;iBAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBAC7B,OAAO,CAAC,IAAI,CACV,0FAA0F,CAC3F,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AAChC,CAAC;AAED,MAAM,YAAY,GAAG,uBAAuB,EAAE,CAAC;AAOxC,IAAM,WAAW,mBAAjB,MAAM,WAAW;IACtB,MAAM,CAAC,OAAO,CAAC,UAAkC,EAAE;QACjD,MAAM,MAAM,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;QAChD,OAAO;YACL,MAAM,EAAE,aAAW;YACnB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,OAAO,EAAE,MAAM,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,UAAkC,EAAE;QACtD,OAAO,aAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAA;AAdY,kCAAW;sBAAX,WAAW;IALvB,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,YAAY,CAAC,OAAO;QAC7B,SAAS,EAAE,YAAY,CAAC,SAAS;QACjC,OAAO,EAAE,YAAY,CAAC,SAAS;KAChC,CAAC;GACW,WAAW,CAcvB"}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { ClientProxy } from '@nestjs/microservices';
|
|
2
2
|
import { DataSource, EntitySubscriberInterface, InsertEvent } from 'typeorm';
|
|
3
|
-
import { AfterQueryEvent } from 'typeorm/subscriber/event/QueryEvent';
|
|
3
|
+
import type { AfterQueryEvent } from 'typeorm/subscriber/event/QueryEvent';
|
|
4
4
|
export declare class AuditSubscriber implements EntitySubscriberInterface {
|
|
5
5
|
private readonly dataSource;
|
|
6
6
|
private readonly rmsRMQClient;
|
|
7
7
|
constructor(dataSource: DataSource, rmsRMQClient: ClientProxy);
|
|
8
8
|
afterInsert(event: InsertEvent<any>): Promise<any> | void;
|
|
9
|
-
afterQuery(event: AfterQueryEvent
|
|
9
|
+
afterQuery(event: AfterQueryEvent): Promise<any> | void;
|
|
10
10
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"audit.subscriber.js","sourceRoot":"","sources":["../src/audit.subscriber.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAwC;AACxC,yDAAoD;AACpD,qCAKiB;AAGjB,2DAK6B;AAGtB,IAAM,eAAe,GAArB,MAAM,eAAe;IAC1B,YACmB,UAAsB,EAEtB,YAAyB;QAFzB,eAAU,GAAV,UAAU,CAAY;QAEtB,iBAAY,GAAZ,YAAY,CAAa;QAE1C,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,WAAW,CAAC,KAAuB;QACjC,MAAM,OAAO,GAAmB;YAC9B,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;YAC7B,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,SAAS;YACpC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE;YACzB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YACvC,KAAK,EAAE,QAAQ;YACf,SAAS,EAAE,IAAI,IAAI,EAAE;SACtB,CAAC;QACF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,mCAAe,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED,UAAU,CAAC,
|
|
1
|
+
{"version":3,"file":"audit.subscriber.js","sourceRoot":"","sources":["../src/audit.subscriber.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAwC;AACxC,yDAAoD;AACpD,qCAKiB;AAGjB,2DAK6B;AAGtB,IAAM,eAAe,GAArB,MAAM,eAAe;IAC1B,YACmB,UAAsB,EAEtB,YAAyB;QAFzB,eAAU,GAAV,UAAU,CAAY;QAEtB,iBAAY,GAAZ,YAAY,CAAa;QAE1C,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,WAAW,CAAC,KAAuB;QACjC,MAAM,OAAO,GAAmB;YAC9B,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;YAC7B,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,SAAS;YACpC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE;YACzB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YACvC,KAAK,EAAE,QAAQ;YACf,SAAS,EAAE,IAAI,IAAI,EAAE;SACtB,CAAC;QACF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,mCAAe,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED,UAAU,CAAC,KAAsB;QAC/B,IACE,CAAC,KAAK,CAAC,OAAO;YACd,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,EACvE,CAAC;YACD,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAiB;YAC5B,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YACvC,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;SAC9B,CAAC;QAEF,IAAI,CAAC,YAAY,CAAC,IAAI,CACpB,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,kCAAc,CAAC,CAAC,CAAC,gCAAY,EAChE,OAAO,CACR,CAAC;IACJ,CAAC;CACF,CAAA;AA3CY,0CAAe;0BAAf,eAAe;IAD3B,IAAA,yBAAe,GAAE;IAIb,WAAA,IAAA,eAAM,EAAC,wCAAoB,CAAC,CAAA;qCADA,oBAAU;QAER,2BAAW;GAJjC,eAAe,CA2C3B"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zola_do/audit",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.9",
|
|
4
4
|
"description": "RabbitMQ-based audit logging for NestJS",
|
|
5
5
|
"author": "zolaDO",
|
|
6
6
|
"license": "ISC",
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
"amqplib": "^0.10.0",
|
|
38
38
|
"reflect-metadata": "^0.1.0 || ^0.2.0",
|
|
39
39
|
"rxjs": "^7.0.0 || ^8.0.0",
|
|
40
|
-
"typeorm": "^0.3.0"
|
|
40
|
+
"typeorm": "^0.3.0 || ^1.0.0"
|
|
41
41
|
},
|
|
42
42
|
"peerDependenciesMeta": {
|
|
43
43
|
"@nestjs/microservices": {
|