From dad6b557894dfd66541abc73528b2e8681d3be63 Mon Sep 17 00:00:00 2001 From: yassinedorbozgithub Date: Tue, 17 Jun 2025 15:10:36 +0100 Subject: [PATCH 1/4] fix(api): add JSDoc --- api/src/nlp/services/nlp.service.ts | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/api/src/nlp/services/nlp.service.ts b/api/src/nlp/services/nlp.service.ts index 3fa85947..e1e56949 100644 --- a/api/src/nlp/services/nlp.service.ts +++ b/api/src/nlp/services/nlp.service.ts @@ -105,12 +105,18 @@ export class NlpService { } /** - * Handles the event triggered when an NLP entity is deleted. Synchronizes the deletion with the external NLP provider. + * Before deleting a `nlpEntity`, this method deletes the related `nlpValue` and `nlpSampleEntity`. Synchronizes the deletion with the external NLP provider * - * @param entity - The NLP entity to be deleted. + * @param _query - The Mongoose query object used for deletion. + * @param criteria - The filter criteria for finding the nlpEntities to be deleted. + * + * @returns {Promise} A promise that resolves once the event is emitted. */ @OnEvent('hook:nlpEntity:preDelete') - async handleEntityDelete(_query: unknown, criteria: TFilterQuery) { + async handleEntityDelete( + _query: unknown, + criteria: TFilterQuery, + ): Promise { if (criteria._id) { await this.nlpValueService.deleteMany({ entity: criteria._id }); await this.nlpSampleEntityService.deleteMany({ entity: criteria._id }); @@ -181,12 +187,18 @@ export class NlpService { } /** - * Handles the event triggered when an NLP value is deleted. Synchronizes the deletion with the external NLP provider. + * Before deleting a `nlpValue`, this method deletes the related `nlpSampleEntity`. Synchronizes the deletion with the external NLP provider * - * @param value - The NLP value to be deleted. + * @param _query - The Mongoose query object used for deletion. + * @param criteria - The filter criteria for finding the nlpValues to be deleted. + * + * @returns {Promise} A promise that resolves once the event is emitted. */ @OnEvent('hook:nlpValue:preDelete') - async handleValueDelete(_query: unknown, criteria: TFilterQuery) { + async handleValueDelete( + _query: unknown, + criteria: TFilterQuery, + ): Promise { if (criteria._id) { await this.nlpSampleEntityService.deleteMany({ value: criteria._id, From 3ae6b5bc290a2522113a6fb4612f253f1d4d1d75 Mon Sep 17 00:00:00 2001 From: yassinedorbozgithub Date: Tue, 17 Jun 2025 15:10:54 +0100 Subject: [PATCH 2/4] fix(api): rename props --- api/src/nlp/repositories/nlp-entity.repository.spec.ts | 4 ++-- api/src/nlp/repositories/nlp-value.repository.spec.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/api/src/nlp/repositories/nlp-entity.repository.spec.ts b/api/src/nlp/repositories/nlp-entity.repository.spec.ts index d20ac8d6..7bf5905a 100644 --- a/api/src/nlp/repositories/nlp-entity.repository.spec.ts +++ b/api/src/nlp/repositories/nlp-entity.repository.spec.ts @@ -118,8 +118,8 @@ describe('NlpEntityRepository', () => { it('should delete a nlp entity', async () => { nlpValueRepository.eventEmitter.once( 'hook:nlpEntity:preDelete', - async (...args) => { - await nlpService.handleEntityDelete(args[0], args[1]); + async (...[query, criteria]) => { + await nlpService.handleEntityDelete(query, criteria); }, ); const intentNlpEntity = await nlpEntityRepository.findOne({ diff --git a/api/src/nlp/repositories/nlp-value.repository.spec.ts b/api/src/nlp/repositories/nlp-value.repository.spec.ts index 504d11c4..4a54be9e 100644 --- a/api/src/nlp/repositories/nlp-value.repository.spec.ts +++ b/api/src/nlp/repositories/nlp-value.repository.spec.ts @@ -167,8 +167,8 @@ describe('NlpValueRepository', () => { it('should delete a nlp Value', async () => { nlpValueRepository.eventEmitter.once( 'hook:nlpValue:preDelete', - async (...args) => { - await nlpService.handleValueDelete(args[0], args[1]); + async (...[query, criteria]) => { + await nlpService.handleValueDelete(query, criteria); }, ); const result = await nlpValueRepository.deleteOne(nlpValues[1].id); From 7f25a40cf7115a4be6f4852683e01d28750faed0 Mon Sep 17 00:00:00 2001 From: yassinedorbozgithub Date: Tue, 17 Jun 2025 16:11:24 +0100 Subject: [PATCH 3/4] fix(api): remove unnecessary JSDoc --- api/src/nlp/services/nlp.service.ts | 4 ---- 1 file changed, 4 deletions(-) diff --git a/api/src/nlp/services/nlp.service.ts b/api/src/nlp/services/nlp.service.ts index e1e56949..7ffff307 100644 --- a/api/src/nlp/services/nlp.service.ts +++ b/api/src/nlp/services/nlp.service.ts @@ -109,8 +109,6 @@ export class NlpService { * * @param _query - The Mongoose query object used for deletion. * @param criteria - The filter criteria for finding the nlpEntities to be deleted. - * - * @returns {Promise} A promise that resolves once the event is emitted. */ @OnEvent('hook:nlpEntity:preDelete') async handleEntityDelete( @@ -191,8 +189,6 @@ export class NlpService { * * @param _query - The Mongoose query object used for deletion. * @param criteria - The filter criteria for finding the nlpValues to be deleted. - * - * @returns {Promise} A promise that resolves once the event is emitted. */ @OnEvent('hook:nlpValue:preDelete') async handleValueDelete( From 0576b60af248d70a46375880b30aedd426d38cb6 Mon Sep 17 00:00:00 2001 From: yassinedorbozgithub Date: Tue, 17 Jun 2025 16:12:21 +0100 Subject: [PATCH 4/4] fix(api): remove unnecessary JSDoc --- api/src/chat/services/block.service.ts | 2 -- api/src/chat/services/subscriber.service.ts | 2 -- 2 files changed, 4 deletions(-) diff --git a/api/src/chat/services/block.service.ts b/api/src/chat/services/block.service.ts index 4483951b..d61333d2 100644 --- a/api/src/chat/services/block.service.ts +++ b/api/src/chat/services/block.service.ts @@ -793,8 +793,6 @@ export class BlockService extends BaseService< * * @param _query - The Mongoose query object used for deletion. * @param criteria - The filter criteria for finding the labels to be deleted. - * - * @returns {Promise} A promise that resolves once the event is emitted. */ @OnEvent('hook:label:preDelete') async handleLabelPreDelete( diff --git a/api/src/chat/services/subscriber.service.ts b/api/src/chat/services/subscriber.service.ts index 883c7dab..9d8457b0 100644 --- a/api/src/chat/services/subscriber.service.ts +++ b/api/src/chat/services/subscriber.service.ts @@ -265,8 +265,6 @@ export class SubscriberService extends BaseService< * * @param _query - The Mongoose query object used for deletion. * @param criteria - The filter criteria for finding the labels to be deleted. - * - * @returns {Promise} A promise that resolves once the event is emitted. */ @OnEvent('hook:label:preDelete') async handleLabelDelete(