@drax/crud-back 0.37.5 → 0.38.0

package/dist/controllers/AbstractFastifyController.js

@@ -1,8 +1,9 @@
 import { CommonConfig, DraxConfig, LimitError, NotFoundError, BadRequestError, CommonController } from "@drax/common-back";
 import { join } from "path";
 import QueryFilterRegex from "../regexs/QueryFilterRegex.js";
+import CrudEventEmitter from "../events/CrudEventEmitter.js";
 class AbstractFastifyController extends CommonController {
-    constructor(service, permission) {
+    constructor(service, permission, entityName) {
         super();
         this.baseFileDir = DraxConfig.getOrLoad(CommonConfig.FileDir) || 'files';
         this.baseURL = DraxConfig.getOrLoad(CommonConfig.BaseUrl) ? DraxConfig.get(CommonConfig.BaseUrl).replace(/\/$/, '') : '';
@@ -27,6 +28,8 @@ class AbstractFastifyController extends CommonController {
         this.maximumLimit = 10000;
         this.service = service;
         this.permission = permission;
+        this.entityName = entityName || this.constructor.name.replace('Fastify', '').replace('Controller', '');
+        this.eventEmitter = CrudEventEmitter.getInstance();
         console.log("AbstractFastifyController created. Permissions", this.permission);
     }
     parseFilters(stringFilters) {
@@ -93,12 +96,85 @@ class AbstractFastifyController extends CommonController {
             payload[this.userField] = rbac.userId;
         }
     }
+    extractRequestData(request) {
+        return {
+            user: {
+                id: request.rbac.userId,
+                username: request.rbac.username,
+                role: {
+                    id: request.rbac.roleId,
+                    name: request.rbac.roleName,
+                },
+                tenant: {
+                    id: request.rbac.tenantId,
+                    name: request.rbac.tenantName,
+                },
+                apiKey: {
+                    id: request.rbac.apiKeyId,
+                    name: request.rbac.apiKeyName,
+                }
+            },
+            ip: request.ip,
+            userAgent: request.headers['user-agent'],
+            sessionId: request.rbac.session,
+            requestId: request.id,
+        };
+    }
+    async onCreated(request, item) {
+        const requestData = this.extractRequestData(request);
+        const eventData = {
+            action: 'created',
+            entity: this.entityName,
+            postItem: item,
+            preItem: null,
+            timestamp: new Date(),
+            ...requestData
+        };
+        this.eventEmitter.emitCrudEvent(eventData);
+    }
+    async onUpdated(request, preItem, postItem) {
+        const requestData = this.extractRequestData(request);
+        const eventData = {
+            action: 'updated',
+            entity: this.entityName,
+            postItem: postItem,
+            preItem: preItem,
+            timestamp: new Date(),
+            ...requestData
+        };
+        this.eventEmitter.emitCrudEvent(eventData);
+    }
+    async onDeleted(request, item) {
+        const requestData = this.extractRequestData(request);
+        const eventData = {
+            action: 'deleted',
+            entity: this.entityName,
+            postItem: null,
+            preItem: item,
+            timestamp: new Date(),
+            ...requestData
+        };
+        this.eventEmitter.emitCrudEvent(eventData);
+    }
+    async onExported(request, response) {
+        const requestData = this.extractRequestData(request);
+        const eventData = {
+            action: 'exported',
+            entity: this.entityName,
+            postItem: null,
+            preItem: null,
+            timestamp: new Date(),
+            ...requestData
+        };
+        this.eventEmitter.emitCrudEvent(eventData);
+    }
     async create(request, reply) {
         try {
             request.rbac.assertPermission(this.permission.Create);
             const payload = request.body;
             this.applyUserAndTenantSetters(payload, request.rbac);
             let item = await this.service.create(payload);
+            await this.onCreated(request, item);
             return item;
         }
         catch (e) {
@@ -114,8 +190,8 @@ class AbstractFastifyController extends CommonController {
             }
             const id = request.params.id;
             const payload = request.body;
+            let preItem = await this.service.findById(id);
             if (!request.rbac.hasSomePermission([this.permission.All, this.permission.UpdateAll])) {
-                let preItem = await this.service.findById(id);
                 if (!preItem) {
                     reply.statusCode = 404;
                     reply.send({ error: 'NOT_FOUND' });
@@ -129,6 +205,7 @@ class AbstractFastifyController extends CommonController {
             if (!item) {
                 throw new NotFoundError();
             }
+            await this.onUpdated(request, preItem, item);
             return item;
         }
         catch (e) {
@@ -144,8 +221,8 @@ class AbstractFastifyController extends CommonController {
             }
             const id = request.params.id;
             const payload = request.body;
+            let preItem = await this.service.findById(id);
             if (!request.rbac.hasSomePermission([this.permission.All, this.permission.UpdateAll])) {
-                let preItem = await this.service.findById(id);
                 if (!preItem) {
                     reply.statusCode = 404;
                     reply.send({ error: 'NOT_FOUND' });
@@ -159,6 +236,7 @@ class AbstractFastifyController extends CommonController {
             if (!item) {
                 throw new NotFoundError();
             }
+            await this.onUpdated(request, preItem, item);
             return item;
         }
         catch (e) {
@@ -183,6 +261,7 @@ class AbstractFastifyController extends CommonController {
             }
             this.assertTenant(item, request.rbac);
             await this.service.delete(id);
+            await this.onDeleted(request, item);
             reply.send({
                 id: id,
                 message: 'Item deleted successfully',
@@ -371,12 +450,14 @@ class AbstractFastifyController extends CommonController {
                 filters,
             }, destinationPath);
             const url = `${this.baseURL}/api/file/${exportPath}/${year}/${month}/${result.fileName}`;
-            return {
+            const response = {
                 url: url,
                 rowCount: result.rowCount,
                 time: result.time,
                 fileName: result.fileName,
             };
+            await this.onExported(request, response);
+            return response;
         }
         catch (e) {
             this.handleError(e, reply);

package/dist/events/CrudEventEmitter.js

@@ -0,0 +1,18 @@
+import { EventEmitter } from 'events';
+class CrudEventEmitter extends EventEmitter {
+    constructor() {
+        super();
+        this.setMaxListeners(100); // Aumentar el límite de listeners si es necesario
+    }
+    static getInstance() {
+        if (!CrudEventEmitter.instance) {
+            CrudEventEmitter.instance = new CrudEventEmitter();
+        }
+        return CrudEventEmitter.instance;
+    }
+    emitCrudEvent(eventData) {
+        this.emit('crud:event', eventData);
+    }
+}
+export default CrudEventEmitter;
+export { CrudEventEmitter };

package/dist/index.js

@@ -3,6 +3,7 @@ import AbstractMongoRepository from "./repository/AbstractMongoRepository.js";
 import AbstractSqliteRepository from "./repository/AbstractSqliteRepository.js";
 import AbstractService from "./services/AbstractService.js";
 import AbstractFastifyController from "./controllers/AbstractFastifyController.js";
+import { CrudEventEmitter } from "./events/CrudEventEmitter.js";
 //schemas
 import { IdParamSchema } from "./schemas/IdParamSchema.js";
 import { DeleteBodyResponseSchema } from "./schemas/DeleteBodyResponseSchema.js";
@@ -17,6 +18,8 @@ import { CrudSchemaBuilder } from "./builders/CrudSchemaBuilder.js";
 export { 
 //CRUD
 AbstractMongoRepository, AbstractSqliteRepository, AbstractService, AbstractFastifyController, 
+//EVENTs
+CrudEventEmitter, 
 //Schemas
 IdParamSchema, DeleteBodyResponseSchema, PaginateBodyResponseSchema, PaginateQuerySchema, FindQuerySchema, GroupByQuerySchema, SearchQuerySchema, FindByParamSchema, ErrorBodyResponseSchema, ValidationErrorBodyResponseSchema, ExportBodyResponseSchema, 
 //Builder

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.37.5",
+  "version": "0.38.0",
   "description": "Crud utils across modules",
   "main": "dist/index.js",
   "types": "types/index.d.ts",
@@ -22,10 +22,10 @@
   "author": "Cristian Incarnato & Drax Team",
   "license": "ISC",
   "dependencies": {
-    "@drax/common-back": "^0.37.2",
-    "@drax/common-share": "^0.37.0",
-    "@drax/identity-share": "^0.37.0",
-    "@drax/media-back": "^0.37.5",
+    "@drax/common-back": "^0.38.0",
+    "@drax/common-share": "^0.38.0",
+    "@drax/identity-share": "^0.38.0",
+    "@drax/media-back": "^0.38.0",
     "@graphql-tools/load-files": "^7.0.0",
     "@graphql-tools/merge": "^9.0.4",
     "mongoose": "^8.6.3",
@@ -45,5 +45,5 @@
     "tsc-alias": "^1.8.10",
     "typescript": "^5.6.2"
   },
-  "gitHead": "2fd3d1fa98a875f67691ea4524682985a52cba17"
+  "gitHead": "43c90f3c12165e7527edefbc80dd327a59236dd5"
 }

package/src/controllers/AbstractFastifyController.ts

@@ -9,9 +9,16 @@ import {
 } from "@drax/common-back";
 import {IRbac} from "@drax/identity-share";
 import type {FastifyReply, FastifyRequest} from "fastify";
-import {IDraxExportResult, IDraxPermission, IDraxFieldFilter} from "@drax/crud-share";
+import {
+    IDraxExportResult,
+    IDraxPermission,
+    IDraxFieldFilter,
+    IDraxExportResponse,
+    IDraxCrudEvent
+} from "@drax/crud-share";
 import {join} from "path";
 import QueryFilterRegex from "../regexs/QueryFilterRegex.js";
+import CrudEventEmitter from "../events/CrudEventEmitter.js";
 
 declare module 'fastify' {
     interface FastifyRequest {
@@ -53,6 +60,8 @@ class AbstractFastifyController<T, C, U> extends CommonController {
     protected baseFileDir = DraxConfig.getOrLoad(CommonConfig.FileDir) || 'files';
     protected baseURL = DraxConfig.getOrLoad(CommonConfig.BaseUrl) ? DraxConfig.get(CommonConfig.BaseUrl).replace(/\/$/, '') : ''
 
+    protected entityName: string
+
     protected tenantField: string = 'tenant'
     protected userField: string = 'user'
 
@@ -78,13 +87,19 @@ class AbstractFastifyController<T, C, U> extends CommonController {
     protected defaultLimit: number = 1000
     protected maximumLimit: number = 10000
 
-    constructor(service: AbstractService<T, C, U>, permission: IDraxPermission) {
+    protected eventEmitter: CrudEventEmitter
+
+    constructor(service: AbstractService<T, C, U>, permission: IDraxPermission, entityName?: string) {
         super();
         this.service = service
         this.permission = permission
+        this.entityName = entityName || this.constructor.name.replace('Fastify', '').replace('Controller', '')
+        this.eventEmitter = CrudEventEmitter.getInstance()
         console.log("AbstractFastifyController created. Permissions", this.permission)
     }
 
+
+
     protected parseFilters(stringFilters: string): IDraxFieldFilter[] {
         try {
             if (!stringFilters) {
@@ -165,6 +180,83 @@ class AbstractFastifyController<T, C, U> extends CommonController {
         }
     }
 
+    protected extractRequestData(request: CustomRequest) {
+        return {
+            user:  {
+                id: request.rbac.userId,
+                username: request.rbac.username,
+                role:{
+                    id: request.rbac.roleId,
+                    name: request.rbac.roleName,
+                },
+                tenant: {
+                    id: request.rbac.tenantId,
+                    name: request.rbac.tenantName,
+                },
+                apiKey: {
+                    id: request.rbac.apiKeyId,
+                    name: request.rbac.apiKeyName,
+                }
+            },
+            ip: request.ip,
+            userAgent: request.headers['user-agent'],
+            sessionId: request.rbac.session,
+            requestId: request.id,
+        };
+    }
+
+    async onCreated(request: CustomRequest, item:T){
+        const requestData = this.extractRequestData(request)
+        const eventData : IDraxCrudEvent = {
+            action: 'created',
+            entity: this.entityName,
+            postItem: item,
+            preItem: null,
+            timestamp: new Date(),
+            ...requestData
+        }
+        this.eventEmitter.emitCrudEvent(eventData)
+    }
+
+    async onUpdated(request: CustomRequest, preItem: T, postItem:T){
+        const requestData = this.extractRequestData(request)
+        const eventData : IDraxCrudEvent = {
+            action: 'updated',
+            entity: this.entityName,
+            postItem: postItem,
+            preItem: preItem,
+            timestamp: new Date(),
+            ...requestData
+        }
+        this.eventEmitter.emitCrudEvent(eventData)
+    }
+
+    async onDeleted(request: CustomRequest, item: T) {
+        const requestData = this.extractRequestData(request)
+        const eventData : IDraxCrudEvent = {
+            action: 'deleted',
+            entity: this.entityName,
+            postItem: null,
+            preItem: item,
+            timestamp: new Date(),
+            ...requestData
+        }
+        this.eventEmitter.emitCrudEvent(eventData)
+    }
+
+    async onExported(request: CustomRequest, response: IDraxExportResponse) {
+        const requestData = this.extractRequestData(request)
+        const eventData : IDraxCrudEvent = {
+            action: 'exported',
+            entity: this.entityName,
+            postItem: null,
+            preItem: null,
+            timestamp: new Date(),
+            ...requestData
+        }
+        this.eventEmitter.emitCrudEvent(eventData)
+    }
+
 
     async create(request: CustomRequest, reply: FastifyReply) {
         try {
@@ -172,12 +264,15 @@ class AbstractFastifyController<T, C, U> extends CommonController {
             const payload = request.body
             this.applyUserAndTenantSetters(payload, request.rbac)
             let item = await this.service.create(payload as C)
+            await this.onCreated(request, item)
             return item
         } catch (e) {
             this.handleError(e, reply)
         }
     }
 
+
+
     async update(request: CustomRequest, reply: FastifyReply) {
         try {
             request.rbac.assertPermission(this.permission.Update)
@@ -188,9 +283,9 @@ class AbstractFastifyController<T, C, U> extends CommonController {
             const id = request.params.id
             const payload = request.body
 
-            if (!request.rbac.hasSomePermission([this.permission.All, this.permission.UpdateAll])) {
+            let preItem = await this.service.findById(id)
 
-                let preItem = await this.service.findById(id)
+            if (!request.rbac.hasSomePermission([this.permission.All, this.permission.UpdateAll])) {
 
                 if (!preItem) {
                     reply.statusCode = 404
@@ -210,6 +305,8 @@ class AbstractFastifyController<T, C, U> extends CommonController {
                 throw new NotFoundError()
             }
 
+            await this.onUpdated(request, preItem, item)
+
             return item
         } catch (e) {
             this.handleError(e, reply)
@@ -226,9 +323,9 @@ class AbstractFastifyController<T, C, U> extends CommonController {
             const id = request.params.id
             const payload = request.body
 
-            if (!request.rbac.hasSomePermission([this.permission.All, this.permission.UpdateAll])) {
+            let preItem = await this.service.findById(id)
 
-                let preItem = await this.service.findById(id)
+            if (!request.rbac.hasSomePermission([this.permission.All, this.permission.UpdateAll])) {
 
                 if (!preItem) {
                     reply.statusCode = 404
@@ -246,12 +343,15 @@ class AbstractFastifyController<T, C, U> extends CommonController {
             if (!item) {
                 throw new NotFoundError()
             }
+            await this.onUpdated(request, preItem, item)
             return item
         } catch (e) {
             this.handleError(e, reply)
         }
     }
 
+
+
     async delete(request: CustomRequest, reply: FastifyReply) {
         try {
             request.rbac.assertPermission(this.permission.Delete)
@@ -277,6 +377,9 @@ class AbstractFastifyController<T, C, U> extends CommonController {
 
 
             await this.service.delete(id)
+
+            await this.onDeleted(request, item)
+
             reply.send({
                 id: id,
                 message: 'Item deleted successfully',
@@ -465,6 +568,8 @@ class AbstractFastifyController<T, C, U> extends CommonController {
     }
 
 
+
+
     async export(request: CustomRequest, reply: FastifyReply) {
         try {
             request.rbac.assertPermission(this.permission.View)
@@ -503,14 +608,17 @@ class AbstractFastifyController<T, C, U> extends CommonController {
 
             const url = `${this.baseURL}/api/file/${exportPath}/${year}/${month}/${result.fileName}`
 
-
-            return {
+            const response : IDraxExportResponse = {
                 url: url,
                 rowCount: result.rowCount,
                 time: result.time,
                 fileName: result.fileName,
             }
 
+            await this.onExported(request, response)
+
+            return response
+
         } catch (e) {
             this.handleError(e, reply)
         }

package/src/events/CrudEventEmitter.ts

@@ -0,0 +1,26 @@
+import {EventEmitter} from 'events';
+import {IDraxCrudEvent} from "@drax/crud-share";
+
+
+class CrudEventEmitter extends EventEmitter {
+    private static instance: CrudEventEmitter;
+
+    private constructor() {
+        super();
+        this.setMaxListeners(100); // Aumentar el límite de listeners si es necesario
+    }
+
+    static getInstance(): CrudEventEmitter {
+        if (!CrudEventEmitter.instance) {
+            CrudEventEmitter.instance = new CrudEventEmitter();
+        }
+        return CrudEventEmitter.instance;
+    }
+
+    emitCrudEvent<T>(eventData: IDraxCrudEvent<T>): void {
+        this.emit('crud:event', eventData);
+    }
+}
+
+export default CrudEventEmitter;
+export {CrudEventEmitter};

package/src/index.ts

@@ -4,6 +4,7 @@ import AbstractSqliteRepository from "./repository/AbstractSqliteRepository.js";
 import AbstractService from "./services/AbstractService.js";
 import AbstractFastifyController from "./controllers/AbstractFastifyController.js";
 import type {CustomRequest} from "./controllers/AbstractFastifyController.js";
+import {CrudEventEmitter} from "./events/CrudEventEmitter.js";
 
 //schemas
 import {IdParamSchema} from "./schemas/IdParamSchema.js"
@@ -29,6 +30,9 @@ export {
     AbstractService,
     AbstractFastifyController,
 
+    //EVENTs
+    CrudEventEmitter,
+
 
     //Schemas
     IdParamSchema,