@drax/crud-back 3.4.2 → 3.5.0

package/dist/controllers/AbstractFastifyController.js

@@ -260,6 +260,28 @@ class AbstractFastifyController extends CommonController {
     async postUpdatePartial(request, item) {
         return item;
     }
+    //Sobrescribir este metodo para manipular items a devolver en operaciones de lectura
+    async postRead(request, item) {
+        return item;
+    }
+    isPaginateResult(result) {
+        return typeof result === 'object' && result !== null && 'items' in result && Array.isArray(result.items);
+    }
+    async postReadItem(request, item) {
+        return this.postRead(request, item);
+    }
+    async postReadItems(request, items) {
+        if (Array.isArray(items)) {
+            return Promise.all(items.map(item => this.postRead(request, item)));
+        }
+        return items;
+    }
+    async postReadPaginate(request, pagination) {
+        if (this.isPaginateResult(pagination)) {
+            pagination.items = await Promise.all(pagination.items.map(item => this.postRead(request, item)));
+        }
+        return pagination;
+    }
     async updatePartial(request, reply) {
         try {
             request.rbac.assertPermission(this.permission.Update);
@@ -355,6 +377,7 @@ class AbstractFastifyController extends CommonController {
                 this.assertUser(item, request.rbac);
             }
             this.assertTenant(item, request.rbac);
+            item = await this.postReadItem(request, item);
             return item;
         }
         catch (e) {
@@ -373,6 +396,7 @@ class AbstractFastifyController extends CommonController {
             if (!items || items.length === 0) {
                 throw new NotFoundError();
             }
+            items = await this.postReadItems(request, items);
             return items;
         }
         catch (e) {
@@ -393,6 +417,7 @@ class AbstractFastifyController extends CommonController {
             const filters = this.parseFilters(request.query.filters);
             this.applyUserAndTenantFilters(filters, request.rbac);
             let items = await this.service.find({ search, filters, order, orderBy, limit });
+            items = await this.postReadItems(request, items);
             return items;
         }
         catch (e) {
@@ -407,6 +432,7 @@ class AbstractFastifyController extends CommonController {
             const filters = this.parseFilters(request.query.filters);
             this.applyUserAndTenantFilters(filters, request.rbac);
             let item = await this.service.findOne({ search, filters });
+            item = await this.postReadItem(request, item);
             return item;
         }
         catch (e) {
@@ -426,9 +452,7 @@ class AbstractFastifyController extends CommonController {
             let filters = [];
             this.applyUserAndTenantFilters(filters, request.rbac);
             let items = await this.service.findBy(field, value, limit, filters);
-            // for (let item of items) {
-            //     this.assertUserAndTenant(item, request.rbac)
-            // }
+            items = await this.postReadItems(request, items);
             return items;
         }
         catch (e) {
@@ -447,7 +471,7 @@ class AbstractFastifyController extends CommonController {
             let filters = [];
             this.applyUserAndTenantFilters(filters, request.rbac);
             let item = await this.service.findOneBy(field, value, filters);
-            // this.assertUserAndTenant(item, request.rbac);
+            item = await this.postReadItem(request, item);
             return item;
         }
         catch (e) {
@@ -461,8 +485,9 @@ class AbstractFastifyController extends CommonController {
             const filters = [];
             const limit = this.defaultLimit;
             this.applyUserAndTenantFilters(filters, request.rbac);
-            let item = await this.service.search(search, limit, filters);
-            return item;
+            let items = await this.service.search(search, limit, filters);
+            items = await this.postReadItems(request, items);
+            return items;
         }
         catch (e) {
             this.handleError(e, reply);
@@ -481,8 +506,8 @@ class AbstractFastifyController extends CommonController {
             const search = request.query.search;
             const filters = this.parseFilters(request.query.filters);
             this.applyUserAndTenantFilters(filters, request.rbac);
-            // console.log("paginate filters",filters)
             let paginateResult = await this.service.paginate({ page, limit, orderBy, order, search, filters });
+            paginateResult = await this.postReadPaginate(request, paginateResult);
             return paginateResult;
         }
         catch (e) {

package/dist/repository/AbstractSqliteRepository.js

@@ -220,7 +220,7 @@ class AbstractSqliteRepository {
             total: rCount.count,
             items
         };
-        console.log('Pagination result:', JSON.stringify(pagination, null, 4));
+        // console.log('Pagination result:', JSON.stringify(pagination,null,4))
         return pagination;
     }
     async find({ limit = 5, orderBy = '', order = 'desc', search = '', filters = [] }) {

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "3.4.2",
+  "version": "3.5.0",
   "description": "Crud utils across modules",
   "main": "dist/index.js",
   "types": "types/index.d.ts",
@@ -25,7 +25,7 @@
     "@drax/common-back": "^3.0.0",
     "@drax/common-share": "^3.0.0",
     "@drax/identity-share": "^3.0.0",
-    "@drax/media-back": "^3.4.2",
+    "@drax/media-back": "^3.5.0",
     "@graphql-tools/load-files": "^7.0.0",
     "@graphql-tools/merge": "^9.0.4",
     "mongoose": "^8.23.0",
@@ -47,5 +47,5 @@
     "typescript": "^5.9.3",
     "vitest": "^3.2.4"
   },
-  "gitHead": "678a645d46927a684bd9c5f9c4aa13ff77266e2d"
+  "gitHead": "a79ccbba44732026c3e75980a332062c2d12f35f"
 }

package/src/controllers/AbstractFastifyController.ts

@@ -14,7 +14,8 @@ import {
     IDraxPermission,
     IDraxFieldFilter,
     IDraxExportResponse,
-    IDraxCrudEvent
+    IDraxCrudEvent,
+    IDraxPaginateResult
 } from "@drax/crud-share";
 import {join} from "path";
 import QueryFilterRegex from "../regexs/QueryFilterRegex.js";
@@ -98,7 +99,6 @@ class AbstractFastifyController<T, C, U> extends CommonController {
     }
 
 
-
     protected parseFilters(stringFilters: string): IDraxFieldFilter[] {
         try {
             if (!stringFilters) {
@@ -114,7 +114,7 @@ class AbstractFastifyController<T, C, U> extends CommonController {
             filterArray.forEach((filter) => {
                 const [field, operator, value] = filter.split(";")
 
-                if(field && operator && ( operator === 'empty' || (value !== undefined && value !== '')) ) {
+                if (field && operator && (operator === 'empty' || (value !== undefined && value !== ''))) {
                     filters.push({field, operator, value})
                 }
 
@@ -133,11 +133,11 @@ class AbstractFastifyController<T, C, U> extends CommonController {
 
     protected applyUserFilter(filters: IDraxFieldFilter[], rbac: IRbac) {
 
-        if(rbac.hasSomePermission([this.permission.All, this.permission.ViewAll])) {
+        if (rbac.hasSomePermission([this.permission.All, this.permission.ViewAll])) {
             return
         }
 
-        if(this.userFilter && rbac.userId) {
+        if (this.userFilter && rbac.userId) {
             filters.push({field: this.userField, operator: 'eq', value: rbac.userId})
         }
 
@@ -155,10 +155,10 @@ class AbstractFastifyController<T, C, U> extends CommonController {
         if (this.tenantAssert && rbac.hasTenant) {
 
             //Si esta populado
-            if(item[this.tenantField]?._id){
+            if (item[this.tenantField]?._id) {
                 rbac.assertTenantId(item[this.tenantField]._id.toString())//
-            //Si esta crudo
-            }else if(item[this.tenantField]){
+                //Si esta crudo
+            } else if (item[this.tenantField]) {
                 rbac.assertTenantId(item[this.tenantField].toString())
             }
         }
@@ -167,9 +167,9 @@ class AbstractFastifyController<T, C, U> extends CommonController {
     protected assertUser(item: T, rbac: IRbac) {
 
         if (this.userAssert) {
-            if(item[this.userField]?._id){
+            if (item[this.userField]?._id) {
                 rbac.assertUserId(item[this.userField]._id.toString())
-            }else if(item[this.userField]){
+            } else if (item[this.userField]) {
                 rbac.assertUserId(item[this.userField].toString())
             }
         }
@@ -193,10 +193,10 @@ class AbstractFastifyController<T, C, U> extends CommonController {
 
     protected extractRequestData(request: FastifyRequest) {
         return {
-            user:  {
+            user: {
                 id: request?.rbac?.userId,
                 username: request?.rbac?.username,
-                role:{
+                role: {
                     id: request?.rbac?.roleId,
                     name: request?.rbac?.roleName,
                 },
@@ -217,11 +217,10 @@ class AbstractFastifyController<T, C, U> extends CommonController {
     }
 
 
-
-    async onCreated(request: CustomRequest, item:T){
+    async onCreated(request: CustomRequest, item: T) {
         const requestData = this.extractRequestData(request)
         const detail = `User ${requestData.user.username} created ${this.entityName}.`
-        const eventData : IDraxCrudEvent = {
+        const eventData: IDraxCrudEvent = {
             action: 'created',
             entity: this.entityName,
             postItem: item,
@@ -233,10 +232,10 @@ class AbstractFastifyController<T, C, U> extends CommonController {
         this.eventEmitter.emitCrudEvent(eventData)
     }
 
-    async onUpdated(request: CustomRequest, preItem: T, postItem:T){
+    async onUpdated(request: CustomRequest, preItem: T, postItem: T) {
         const requestData = this.extractRequestData(request)
         const detail = `User ${requestData.user.username} updated ${this.entityName}.`
-        const eventData : IDraxCrudEvent = {
+        const eventData: IDraxCrudEvent = {
             action: 'updated',
             entity: this.entityName,
             postItem: postItem,
@@ -251,7 +250,7 @@ class AbstractFastifyController<T, C, U> extends CommonController {
     async onDeleted(request: CustomRequest, item: T) {
         const requestData = this.extractRequestData(request)
         const detail = `User ${requestData.user.username} deleted ${this.entityName}.`
-        const eventData : IDraxCrudEvent = {
+        const eventData: IDraxCrudEvent = {
             action: 'deleted',
             entity: this.entityName,
             postItem: null,
@@ -266,7 +265,7 @@ class AbstractFastifyController<T, C, U> extends CommonController {
     async onExported(request: CustomRequest, response: IDraxExportResponse) {
         const requestData = this.extractRequestData(request)
         const detail = `User ${requestData.user.username} exported ${this.entityName}.`
-        const eventData : IDraxCrudEvent = {
+        const eventData: IDraxCrudEvent = {
             action: 'exported',
             entity: this.entityName,
             postItem: null,
@@ -278,11 +277,11 @@ class AbstractFastifyController<T, C, U> extends CommonController {
         this.eventEmitter.emitCrudEvent(eventData)
     }
 
-    async preCreate(request: CustomRequest, payload:any){
+    async preCreate(request: CustomRequest, payload: any) {
         return payload
     }
 
-    async postCreate(request: CustomRequest, item:T){
+    async postCreate(request: CustomRequest, item: T) {
         return item
     }
 
@@ -301,11 +300,11 @@ class AbstractFastifyController<T, C, U> extends CommonController {
         }
     }
 
-    async preUpdate(request: CustomRequest, payload:any):Promise<C>{
+    async preUpdate(request: CustomRequest, payload: any): Promise<C> {
         return payload
     }
 
-    async postUpdate(request: CustomRequest, item:T){
+    async postUpdate(request: CustomRequest, item: T) {
         return item
     }
 
@@ -334,12 +333,12 @@ class AbstractFastifyController<T, C, U> extends CommonController {
             this.assertTenant(preItem, request.rbac)
 
             //Definido el tenant en create no debe modificarse en un update
-            if(this.tenantSetter) {
+            if (this.tenantSetter) {
                 delete payload[this.tenantField]
             }
 
             //Definido el user en create no debe modificarse en un update
-            if(this.userSetter){
+            if (this.userSetter) {
                 delete payload[this.userField]
             }
 
@@ -360,14 +359,45 @@ class AbstractFastifyController<T, C, U> extends CommonController {
         }
     }
 
-    async preUpdatePartial(request: CustomRequest, payload:any):Promise<C>{
+    async preUpdatePartial(request: CustomRequest, payload: any): Promise<C> {
         return payload
     }
 
-    async postUpdatePartial(request: CustomRequest, item:T){
+    async postUpdatePartial(request: CustomRequest, item: T) {
+        return item
+    }
+
+    //Sobrescribir este metodo para manipular items a devolver en operaciones de lectura
+    async postRead(request: CustomRequest, item: T) {
         return item
     }
 
+    protected isPaginateResult(result: unknown): result is IDraxPaginateResult<T> {
+        return typeof result === 'object' && result !== null && 'items' in result && Array.isArray(result.items)
+    }
+
+    async postReadItem(request: CustomRequest, item: T): Promise<T> {
+        return this.postRead(request, item)
+    }
+
+    async postReadItems(request: CustomRequest, items: T[]): Promise<T[]> {
+        if (Array.isArray(items)) {
+            return Promise.all(items.map(item => this.postRead(request, item)))
+        }
+        return items
+    }
+
+    async postReadPaginate(
+        request: CustomRequest,
+        pagination: IDraxPaginateResult<T>
+    ): Promise<IDraxPaginateResult<T>> {
+        if (this.isPaginateResult(pagination)) {
+            pagination.items = await Promise.all(pagination.items.map(item => this.postRead(request, item)))
+        }
+        return pagination
+    }
+
+
     async updatePartial(request: CustomRequest, reply: FastifyReply) {
         try {
             request.rbac.assertPermission(this.permission.Update)
@@ -394,12 +424,12 @@ class AbstractFastifyController<T, C, U> extends CommonController {
             this.assertTenant(preItem, request.rbac)
 
             //Definido el tenant en el create no debe modificarse en un update
-            if(this.tenantSetter) {
+            if (this.tenantSetter) {
                 delete payload[this.tenantField]
             }
 
             //Definido el user en el create no debe modificarse en un update
-            if(this.userSetter){
+            if (this.userSetter) {
                 delete payload[this.userField]
             }
 
@@ -419,11 +449,11 @@ class AbstractFastifyController<T, C, U> extends CommonController {
         }
     }
 
-    async preDelete(request: CustomRequest, item:T){
+    async preDelete(request: CustomRequest, item: T) {
         return item
     }
 
-    async postDelete(request: CustomRequest, item:T){
+    async postDelete(request: CustomRequest, item: T) {
         return item
     }
 
@@ -491,6 +521,8 @@ class AbstractFastifyController<T, C, U> extends CommonController {
 
             this.assertTenant(item, request.rbac)
 
+            item = await this.postReadItem(request, item)
+
             return item
         } catch (e) {
             this.handleError(e, reply)
@@ -511,6 +543,8 @@ class AbstractFastifyController<T, C, U> extends CommonController {
                 throw new NotFoundError()
             }
 
+            items = await this.postReadItems(request, items)
+
             return items
         } catch (e) {
             this.handleError(e, reply)
@@ -535,6 +569,7 @@ class AbstractFastifyController<T, C, U> extends CommonController {
 
             let items = await this.service.find({search, filters, order, orderBy, limit})
 
+            items = await this.postReadItems(request, items)
 
             return items
         } catch (e) {
@@ -553,6 +588,7 @@ class AbstractFastifyController<T, C, U> extends CommonController {
 
             let item = await this.service.findOne({search, filters})
 
+            item = await this.postReadItem(request, item)
 
             return item
         } catch (e) {
@@ -577,9 +613,8 @@ class AbstractFastifyController<T, C, U> extends CommonController {
 
             let items = await this.service.findBy(field, value, limit, filters)
 
-            // for (let item of items) {
-            //     this.assertUserAndTenant(item, request.rbac)
-            // }
+
+            items = await this.postReadItems(request, items)
 
             return items
         } catch (e) {
@@ -603,7 +638,8 @@ class AbstractFastifyController<T, C, U> extends CommonController {
 
             let item = await this.service.findOneBy(field, value, filters)
 
-            // this.assertUserAndTenant(item, request.rbac);
+
+            item = await this.postReadItem(request, item)
 
             return item
         } catch (e) {
@@ -621,8 +657,9 @@ class AbstractFastifyController<T, C, U> extends CommonController {
 
             this.applyUserAndTenantFilters(filters, request.rbac);
 
-            let item = await this.service.search(search, limit, filters)
-            return item
+            let items = await this.service.search(search, limit, filters)
+            items = await this.postReadItems(request, items)
+            return items
         } catch (e) {
             this.handleError(e, reply)
         }
@@ -645,9 +682,9 @@ class AbstractFastifyController<T, C, U> extends CommonController {
             const filters: IDraxFieldFilter[] = this.parseFilters(request.query.filters)
             this.applyUserAndTenantFilters(filters, request.rbac);
 
-            // console.log("paginate filters",filters)
 
             let paginateResult = await this.service.paginate({page, limit, orderBy, order, search, filters})
+            paginateResult = await this.postReadPaginate(request, paginateResult)
             return paginateResult
         } catch (e) {
             this.handleError(e, reply)
@@ -655,8 +692,6 @@ class AbstractFastifyController<T, C, U> extends CommonController {
     }
 
 
-
-
     async export(request: CustomRequest, reply: FastifyReply) {
         try {
             request.rbac.assertPermission(this.permission.View)
@@ -695,7 +730,7 @@ class AbstractFastifyController<T, C, U> extends CommonController {
 
             const url = `${this.baseURL}/api/file/${exportPath}/${year}/${month}/${result.fileName}`
 
-            const response : IDraxExportResponse = {
+            const response: IDraxExportResponse = {
                 url: url,
                 rowCount: result.rowCount,
                 time: result.time,

package/src/repository/AbstractSqliteRepository.ts

@@ -317,7 +317,7 @@ class AbstractSqliteRepository<T, C, U> implements IDraxCrud<T, C, U> {
             total: rCount.count,
             items
         }
-        console.log('Pagination result:', JSON.stringify(pagination,null,4))
+        // console.log('Pagination result:', JSON.stringify(pagination,null,4))
         return pagination
     }
 

package/test/controllers/PersonController.test.ts

@@ -1,6 +1,7 @@
-import { describe, it, beforeAll, afterAll, expect } from "vitest"
+import { describe, it, beforeAll, afterAll, afterEach, expect, vi } from "vitest"
 import { PersonFastifyRoutes } from '../people/routes/PersonRoutes'
 import { PersonPermissions } from '../people/permissions/PersonPermissions'
+import { PersonController } from '../people/controllers/PersonController.js'
 
 import type { IPersonBase } from '../people/interfaces/IPerson'
 
@@ -32,6 +33,10 @@ describe("Person Controller Test", function () {
         return
     })
 
+    afterEach(() => {
+        vi.restoreAllMocks()
+    })
+
     // Test users are logged in and get their details
     it("Me Admin Root", async () => {
         const { accessToken } = await testSetup.rootUserLogin()
@@ -105,6 +110,34 @@ describe("Person Controller Test", function () {
         expect(getEntity.fullname).toBe("Test Person")
     })
 
+    it("should run postCreate interceptor after creating a person", async () => {
+        const { accessToken } = await testSetup.rootUserLogin()
+        await testSetup.dropCollection('Person')
+
+        const postCreateSpy = vi
+            .spyOn(PersonController.prototype, 'postCreate')
+            .mockImplementation(async (_request, item) => ({
+                ...item,
+                fullname: `${item.fullname} [postCreate]`
+            }))
+
+        const resp = await testSetup.fastifyInstance.inject({
+            method: 'POST',
+            url: '/api/person',
+            payload: {
+                fullname: "Create Hook",
+                money: 100,
+                address: defaultAddress
+            },
+            headers: { Authorization: `Bearer ${accessToken}` }
+        })
+
+        const person = await resp.json()
+        expect(resp.statusCode).toBe(200)
+        expect(postCreateSpy).toHaveBeenCalledTimes(1)
+        expect(person.fullname).toBe("Create Hook [postCreate]")
+    })
+
     // 2. Create and Update (Full Update - PUT)
     it("should create and update a person and finally find by id", async () => {
         const { accessToken } = await testSetup.rootUserLogin()
@@ -152,6 +185,47 @@ describe("Person Controller Test", function () {
         expect(verifiedEntity.money).toBe(150)
     })
 
+    it("should run postUpdate interceptor after updating a person", async () => {
+        const { accessToken } = await testSetup.rootUserLogin()
+        await testSetup.dropCollection('Person')
+
+        const createResp = await testSetup.fastifyInstance.inject({
+            method: 'POST',
+            url: '/api/person',
+            payload: {
+                fullname: "Update Hook",
+                money: 100,
+                address: defaultAddress
+            },
+            headers: { Authorization: `Bearer ${accessToken}` }
+        })
+
+        const createdEntity = await createResp.json()
+
+        const postUpdateSpy = vi
+            .spyOn(PersonController.prototype, 'postUpdate')
+            .mockImplementation(async (_request, item) => ({
+                ...item,
+                fullname: `${item.fullname} [postUpdate]`
+            }))
+
+        const updateResp = await testSetup.fastifyInstance.inject({
+            method: 'PUT',
+            url: `/api/person/${createdEntity._id}`,
+            payload: {
+                fullname: "Updated Hook",
+                money: 250,
+                address: defaultAddress
+            },
+            headers: { Authorization: `Bearer ${accessToken}` }
+        })
+
+        const updatedEntity = await updateResp.json()
+        expect(updateResp.statusCode).toBe(200)
+        expect(postUpdateSpy).toHaveBeenCalledTimes(1)
+        expect(updatedEntity.fullname).toBe("Updated Hook [postUpdate]")
+    })
+
     // 3. Create and Partial Update (PATCH)
     it("should create and update partial a person and finally find by id", async () => {
         const { accessToken } = await testSetup.rootUserLogin()
@@ -192,6 +266,79 @@ describe("Person Controller Test", function () {
         expect(verifiedEntity.money).toBe(120)
     })
 
+    it("should run postUpdatePartial interceptor after patching a person", async () => {
+        const { accessToken } = await testSetup.rootUserLogin()
+        await testSetup.dropCollection('Person')
+
+        const createResp = await testSetup.fastifyInstance.inject({
+            method: 'POST',
+            url: '/api/person',
+            payload: {
+                fullname: "Patch Hook",
+                money: 120,
+                address: defaultAddress
+            },
+            headers: { Authorization: `Bearer ${accessToken}` }
+        })
+
+        const createdEntity = await createResp.json()
+
+        const postUpdatePartialSpy = vi
+            .spyOn(PersonController.prototype, 'postUpdatePartial')
+            .mockImplementation(async (_request, item) => ({
+                ...item,
+                fullname: `${item.fullname} [postUpdatePartial]`
+            }))
+
+        const patchResp = await testSetup.fastifyInstance.inject({
+            method: 'PATCH',
+            url: `/api/person/${createdEntity._id}`,
+            payload: { fullname: "Patched Hook" },
+            headers: { Authorization: `Bearer ${accessToken}` }
+        })
+
+        const patchedEntity = await patchResp.json()
+        expect(patchResp.statusCode).toBe(200)
+        expect(postUpdatePartialSpy).toHaveBeenCalledTimes(1)
+        expect(patchedEntity.fullname).toBe("Patched Hook [postUpdatePartial]")
+    })
+
+    it("should run postRead interceptor when reading a person", async () => {
+        const { accessToken } = await testSetup.rootUserLogin()
+        await testSetup.dropCollection('Person')
+
+        const createResp = await testSetup.fastifyInstance.inject({
+            method: 'POST',
+            url: '/api/person',
+            payload: {
+                fullname: "Read Hook",
+                money: 80,
+                address: defaultAddress
+            },
+            headers: { Authorization: `Bearer ${accessToken}` }
+        })
+
+        const createdEntity = await createResp.json()
+
+        const postReadSpy = vi
+            .spyOn(PersonController.prototype, 'postRead')
+            .mockImplementation(async (_request, item) => ({
+                ...item,
+                fullname: `${item.fullname} [postRead]`
+            }))
+
+        const getResp = await testSetup.fastifyInstance.inject({
+            method: 'GET',
+            url: `/api/person/${createdEntity._id}`,
+            headers: { Authorization: `Bearer ${accessToken}` }
+        })
+
+        const person = await getResp.json()
+        expect(getResp.statusCode).toBe(200)
+        expect(postReadSpy).toHaveBeenCalledTimes(1)
+        expect(person.fullname).toBe("Read Hook [postRead]")
+    })
+
     // 4. Create and Delete
     it("should create and delete a person", async () => {
         const { accessToken } = await testSetup.rootUserLogin()