[Feat] Mentions and Subscription APIs

packages/contracts/src/activity-log.model.ts

@@ -1,6 +1,6 @@
 import {
 	ActorTypeEnum,
-	BaseEntityEnum,
+	IBasePerEntityType,
 	IBasePerTenantAndOrganizationEntityModel,
 	ID,
 	JsonData
@@ -10,9 +10,7 @@ import { IUser } from './user.model';
 /**
  * Interface representing an activity log entry.
  */
-export interface IActivityLog extends IBasePerTenantAndOrganizationEntityModel {
-	entity: BaseEntityEnum; // Entity / Table name concerned by activity log
-	entityId: ID; // The ID of the element we are interacting with (a task, an organization, an employee, ...)
+export interface IActivityLog extends IBasePerTenantAndOrganizationEntityModel, IBasePerEntityType {
 	action: ActionTypeEnum;
 	actorType?: ActorTypeEnum;
 	description?: string; // A short sentence describing the action performed. (E.g John Doe created this on 22.09.2024)

packages/contracts/src/base-entity.model.ts

@@ -59,6 +59,12 @@ export interface IBasePerTenantAndOrganizationEntityMutationInput extends Partia
 	organization?: Partial<IOrganization>; // Allow additional fields from IOrganization
 }
 
+// Represents a base structure for generic entities, linking their unique ID with their type.
+export interface IBasePerEntityType {
+	entityId: ID; // Unique ID of the entity
+	entity: BaseEntityEnum; // The type of the entity, defined in BaseEntityEnum enumeration.
+}
+
 // Actor type defines if it's User or system performed some action
 export enum ActorTypeEnum {
 	System = 'System', // System performed the action
@@ -88,5 +94,6 @@ export enum BaseEntityEnum {
 	Task = 'Task',
 	TaskView = 'TaskView',
 	TaskLinkedIssue = 'TaskLinkedIssue',
-	User = 'User'
+	User = 'User',
+	Comment = 'Comment'
 }

packages/contracts/src/comment.model.ts

@@ -1,11 +1,10 @@
-import { ActorTypeEnum, BaseEntityEnum, IBasePerTenantAndOrganizationEntityModel, ID } from './base-entity.model';
+import { ActorTypeEnum, IBasePerEntityType, IBasePerTenantAndOrganizationEntityModel, ID } from './base-entity.model';
 import { IUser } from './user.model';
 import { IEmployee } from './employee.model';
 import { IOrganizationTeam } from './organization-team.model';
+import { IMentionedUserIds } from './mention.model';
 
-export interface IComment extends IBasePerTenantAndOrganizationEntityModel {
-	entity: BaseEntityEnum;
-	entityId: ID; // Indicate the ID of entity record comment related to
+export interface IComment extends IBasePerTenantAndOrganizationEntityModel, IBasePerEntityType {
 	comment: string;
 	creator?: IUser;
 	creatorId?: ID; // The comment's user author ID
@@ -22,15 +21,15 @@ export interface IComment extends IBasePerTenantAndOrganizationEntityModel {
 	replies?: IComment[];
 }
 
-export interface ICommentCreateInput {
+export interface ICommentCreateInput extends IBasePerEntityType, IMentionedUserIds {
 	comment: string;
-	entity: BaseEntityEnum;
-	entityId: ID;
 	parentId?: ID;
 	members?: IEmployee[];
 	teams?: IOrganizationTeam[];
 }
 
-export interface ICommentUpdateInput extends Partial<Omit<IComment, 'entity' | 'entityId' | 'creatorId' | 'creator'>> {}
+export interface ICommentUpdateInput
+	extends IMentionedUserIds,
+		Partial<Omit<IComment, 'entity' | 'entityId' | 'creatorId' | 'creator'>> {}
 
 export interface ICommentFindInput extends Pick<IComment, 'entity' | 'entityId'> {}

packages/contracts/src/favorite.model.ts

@@ -1,9 +1,6 @@
-import { BaseEntityEnum, IBasePerTenantAndOrganizationEntityModel, ID } from './base-entity.model';
+import { IBasePerEntityType, IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
 import { IEmployeeEntityInput } from './employee.model';
 
-export interface IFavorite extends IBasePerTenantAndOrganizationEntityModel, IEmployeeEntityInput {
-	entity: BaseEntityEnum;
-	entityId: ID; // Indicate the ID of entity record marked as favorite
-}
+export interface IFavorite extends IBasePerTenantAndOrganizationEntityModel, IEmployeeEntityInput, IBasePerEntityType {}
 
 export interface IFavoriteCreateInput extends IFavorite {}

packages/contracts/src/index.ts

@@ -115,6 +115,7 @@ export * from './shared-types';
 export * from './skill-entity.model';
 export * from './sms.model';
 export * from './social-account.model';
+export * from './subscription.model';
 export * from './tag.model';
 export * from './task-estimation.model';
 export * from './task-linked-issue.model';
@@ -147,7 +148,8 @@ export {
 	IBaseRelationsEntityModel,
 	ActorTypeEnum,
 	JsonData,
-	BaseEntityEnum
+	BaseEntityEnum,
+	IBasePerEntityType
 } from './base-entity.model';
 
 export * from './proxy.model';

packages/contracts/src/mention.model.ts

@@ -1,13 +1,17 @@
-import { BaseEntityEnum, IBasePerTenantAndOrganizationEntityModel, ID } from './base-entity.model';
+import { BaseEntityEnum, IBasePerEntityType, IBasePerTenantAndOrganizationEntityModel, ID } from './base-entity.model';
 import { IUser } from './user.model';
 
-export interface IMention extends IBasePerTenantAndOrganizationEntityModel {
-	entityId: ID;
-	entity: BaseEntityEnum;
+export interface IMention extends IBasePerTenantAndOrganizationEntityModel, IBasePerEntityType {
 	mentionedUserId: ID;
 	mentionedUser?: IUser;
 	mentionById: ID;
 	mentionBy?: IUser;
+	parentEntityId?: ID; // E.g : If the mention is in a comment, we need this for subscription and notifications purpose (It could be the task ID concerned by comment, then the user will be subscribed to that task instead of to a comment itself)
+	parentEntityType?: BaseEntityEnum;
 }
 
 export interface IMentionCreateInput extends Omit<IMention, 'mentionBy'> {}
+
+export interface IMentionedUserIds {
+	mentionIds?: ID[];
+}

packages/contracts/src/resource-link.model.ts

@@ -1,10 +1,8 @@
 import { IURLMetaData } from './timesheet.model';
-import { BaseEntityEnum, IBasePerTenantAndOrganizationEntityModel, ID } from './base-entity.model';
+import { IBasePerEntityType, IBasePerTenantAndOrganizationEntityModel, ID } from './base-entity.model';
 import { IUser } from './user.model';
 
-export interface IResourceLink extends IBasePerTenantAndOrganizationEntityModel {
-	entity: BaseEntityEnum;
-	entityId: ID;
+export interface IResourceLink extends IBasePerTenantAndOrganizationEntityModel, IBasePerEntityType {
 	title: string;
 	url: string;
 	creator?: IUser;

packages/contracts/src/subscription.model.ts

@@ -0,0 +1,22 @@
+import { IBasePerEntityType, IBasePerTenantAndOrganizationEntityModel, ID } from './base-entity.model';
+import { IUser } from './user.model';
+
+export interface ISubscription extends IBasePerTenantAndOrganizationEntityModel, IBasePerEntityType {
+	subscriptionType: SubscriptionTypeEnum;
+	userId: ID;
+	user?: IUser;
+}
+
+export enum SubscriptionTypeEnum {
+	MANUAL = 'manual',
+	MENTION = 'mention',
+	ASSIGNMENT = 'assignment',
+	COMMENT = 'comment',
+	CREATED_ENTITY = 'created-entity'
+}
+
+export interface ISubscriptionCreateInput
+	extends Omit<ISubscription, 'user' | 'userId'>,
+		Partial<Pick<ISubscription, 'userId'>> {}
+
+export interface ISubscriptionFindInput extends Partial<ISubscription> {}

packages/contracts/src/task.model.ts

@@ -15,6 +15,7 @@ import { ITaskPriority, TaskPriorityEnum } from './task-priority.model';
 import { ITaskSize, TaskSizeEnum } from './task-size.model';
 import { IOrganizationProjectModule } from './organization-project-module.model';
 import { TaskTypeEnum } from './issue-type.model';
+import { IMentionedUserIds } from './mention.model';
 
 export interface ITask
 	extends IBasePerTenantAndOrganizationEntityModel,
@@ -75,7 +76,7 @@ export enum TaskParticipantEnum {
 	TEAMS = 'teams'
 }
 
-export type ITaskCreateInput = ITask;
+export interface ITaskCreateInput extends ITask, IMentionedUserIds {}
 
 export interface ITaskUpdateInput extends ITaskCreateInput {
 	id?: string;

packages/core/src/app.module.ts

@@ -152,6 +152,7 @@ import { ApiCallLogModule } from './api-call-log/api-call-log.module'; // Global
 import { TaskViewModule } from './tasks/views/view.module';
 import { ResourceLinkModule } from './resource-link/resource-link.module';
 import { MentionModule } from './mention/mention.module';
+import { SubscriptionModule } from './subscription/subscription.module';
 
 const { unleashConfig } = environment;
 
@@ -453,7 +454,8 @@ if (environment.THROTTLE_ENABLED) {
 		ApiCallLogModule,
 		TaskViewModule,
 		ResourceLinkModule,
-		MentionModule // Task views Module
+		MentionModule,
+		SubscriptionModule // Task views Module
 	],
 	controllers: [AppController],
 	providers: [

packages/core/src/comment/comment.service.ts

@@ -2,8 +2,9 @@ import { BadRequestException, Injectable, NotFoundException } from '@nestjs/comm
 import { UpdateResult } from 'typeorm';
 import { TenantAwareCrudService } from './../core/crud';
 import { RequestContext } from '../core/context';
-import { IComment, ICommentCreateInput, ICommentUpdateInput, ID } from '@gauzy/contracts';
+import { BaseEntityEnum, IComment, ICommentCreateInput, ICommentUpdateInput, ID } from '@gauzy/contracts';
 import { UserService } from '../user/user.service';
+import { MentionService } from '../mention/mention.service';
 import { Comment } from './comment.entity';
 import { TypeOrmCommentRepository } from './repository/type-orm.comment.repository';
 import { MikroOrmCommentRepository } from './repository/mikro-orm-comment.repository';
@@ -13,7 +14,8 @@ export class CommentService extends TenantAwareCrudService<Comment> {
 	constructor(
 		readonly typeOrmCommentRepository: TypeOrmCommentRepository,
 		readonly mikroOrmCommentRepository: MikroOrmCommentRepository,
-		private readonly userService: UserService
+		private readonly userService: UserService,
+		private readonly mentionService: MentionService
 	) {
 		super(typeOrmCommentRepository, mikroOrmCommentRepository);
 	}
@@ -28,20 +30,37 @@ export class CommentService extends TenantAwareCrudService<Comment> {
 		try {
 			const userId = RequestContext.currentUserId();
 			const tenantId = RequestContext.currentTenantId();
-			const { ...entity } = input;
+			const { mentionIds = [], ...data } = input;
 
 			// Employee existence validation
 			const user = await this.userService.findOneByIdString(userId);
 			if (!user) {
 				throw new NotFoundException('User not found');
 			}
 
-			// return created comment
-			return await super.create({
-				...entity,
+			// create comment
+			const comment = await super.create({
+				...data,
 				tenantId,
 				creatorId: user.id
 			});
+
+			// Apply mentions if needed
+			await Promise.all(
+				mentionIds.map((mentionedUserId) =>
+					this.mentionService.publishMention({
+						entity: BaseEntityEnum.Comment,
+						entityId: comment.id,
+						mentionedUserId,
+						mentionById: user.id,
+						parentEntityId: comment.entityId,
+						parentEntityType: comment.entity
+					})
+				)
+			);
+
+			// Return created Comment
+			return comment;
 		} catch (error) {
 			console.log(error); // Debug Logging
 			throw new BadRequestException('Comment post failed', error);
@@ -50,12 +69,15 @@ export class CommentService extends TenantAwareCrudService<Comment> {
 
 	/**
 	 * @description Update comment - Note
-	 * @param {ICommentUpdateInput} input - Data to update comment
-	 * @returns A promise that resolves to the updated comment OR Update result
+	 * @param id - The comment ID to be updated.
+	 * @param {ICommentUpdateInput} input - Data to update comment.
+	 * @returns A promise that resolves to the updated comment OR Update result.
 	 * @memberof CommentService
 	 */
 	async update(id: ID, input: ICommentUpdateInput): Promise<IComment | UpdateResult> {
 		try {
+			const { mentionIds = [] } = input;
+
 			const userId = RequestContext.currentUserId();
 			const comment = await this.findOneByOptions({
 				where: {
@@ -68,10 +90,21 @@ export class CommentService extends TenantAwareCrudService<Comment> {
 				throw new BadRequestException('Comment not found');
 			}
 
-			return await super.create({
+			const updatedComment = await super.create({
 				...input,
 				id
 			});
+
+			// Synchronize mentions
+			await this.mentionService.updateEntityMentions(
+				BaseEntityEnum.Comment,
+				id,
+				mentionIds,
+				updatedComment.entityId,
+				updatedComment.entity
+			);
+
+			return updatedComment;
 		} catch (error) {
 			console.log(error); // Debug Logging
 			throw new BadRequestException('Comment update failed', error);

packages/core/src/comment/dto/create-comment.dto.ts

@@ -1,11 +1,15 @@
 import { IntersectionType, OmitType } from '@nestjs/swagger';
-import { TenantOrganizationBaseDTO } from './../../core/dto';
 import { ICommentCreateInput } from '@gauzy/contracts';
+import { TenantOrganizationBaseDTO } from './../../core/dto';
+import { MentionedUserIdsDTO } from '../../mention/dto';
 import { Comment } from '../comment.entity';
 
 /**
  * Create Comment data validation request DTO
  */
 export class CreateCommentDTO
-	extends IntersectionType(TenantOrganizationBaseDTO, OmitType(Comment, ['creatorId', 'creator']))
+	extends IntersectionType(
+		TenantOrganizationBaseDTO,
+		IntersectionType(OmitType(Comment, ['creatorId', 'creator']), MentionedUserIdsDTO)
+	)
 	implements ICommentCreateInput {}

packages/core/src/comment/dto/update-comment.dto.ts

@@ -3,7 +3,7 @@ import { ICommentUpdateInput } from '@gauzy/contracts';
 import { CreateCommentDTO } from './create-comment.dto';
 
 /**
- * Create Comment data validation request DTO
+ * Update Comment data validation request DTO
  */
 export class UpdateCommentDTO
 	extends PartialType(OmitType(CreateCommentDTO, ['entity', 'entityId']))

packages/core/src/core/entities/index.ts

@@ -124,6 +124,7 @@ import {
 	Screenshot,
 	Skill,
 	SocialAccount,
+	Subscription,
 	Tag,
 	Task,
 	TaskEstimation,
@@ -275,6 +276,7 @@ export const coreEntities = [
 	Screenshot,
 	Skill,
 	SocialAccount,
+	Subscription,
 	Tag,
 	Task,
 	TaskEstimation,

packages/core/src/core/entities/internal.ts

@@ -126,6 +126,7 @@ export * from '../../resource-link/resource-link.entity';
 export * from '../../role-permission/role-permission.entity';
 export * from '../../role/role.entity';
 export * from '../../skills/skill.entity';
+export * from '../../subscription/subscription.entity';
 export * from '../../tags/tag.entity';
 export * from '../../tasks/daily-plan/daily-plan.entity';
 export * from '../../tasks/estimation/task-estimation.entity';