import { Relation } from 'src/engine/workspace-manager/workspace-sync-metadata/interfaces/relation.interface'; import { SEARCH_VECTOR_FIELD } from 'src/engine/metadata-modules/constants/search-vector-field.constants'; import { ActorMetadata, FieldActorSource, } from 'src/engine/metadata-modules/field-metadata/composite-types/actor.composite-type'; import { EmailsMetadata } from 'src/engine/metadata-modules/field-metadata/composite-types/emails.composite-type'; import { FullNameMetadata } from 'src/engine/metadata-modules/field-metadata/composite-types/full-name.composite-type'; import { LinksMetadata } from 'src/engine/metadata-modules/field-metadata/composite-types/links.composite-type'; import { PhonesMetadata } from 'src/engine/metadata-modules/field-metadata/composite-types/phones.composite-type'; import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity'; import { IndexType } from 'src/engine/metadata-modules/index-metadata/index-metadata.entity'; import { RelationMetadataType, RelationOnDeleteAction, } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity'; import { BaseWorkspaceEntity } from 'src/engine/twenty-orm/base.workspace-entity'; import { WorkspaceEntity } from 'src/engine/twenty-orm/decorators/workspace-entity.decorator'; import { WorkspaceFieldIndex } from 'src/engine/twenty-orm/decorators/workspace-field-index.decorator'; import { WorkspaceField } from 'src/engine/twenty-orm/decorators/workspace-field.decorator'; import { WorkspaceIsDeprecated } from 'src/engine/twenty-orm/decorators/workspace-is-deprecated.decorator'; import { WorkspaceIsNullable } from 'src/engine/twenty-orm/decorators/workspace-is-nullable.decorator'; import { WorkspaceIsSystem } from 'src/engine/twenty-orm/decorators/workspace-is-system.decorator'; import { WorkspaceIsUnique } from 'src/engine/twenty-orm/decorators/workspace-is-unique.decorator'; import { WorkspaceJoinColumn } from 'src/engine/twenty-orm/decorators/workspace-join-column.decorator'; import { WorkspaceRelation } from 'src/engine/twenty-orm/decorators/workspace-relation.decorator'; import { PERSON_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids'; import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids'; import { getTsVectorColumnExpressionFromFields } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/get-ts-vector-column-expression.util'; import { ActivityTargetWorkspaceEntity } from 'src/modules/activity/standard-objects/activity-target.workspace-entity'; import { AttachmentWorkspaceEntity } from 'src/modules/attachment/standard-objects/attachment.workspace-entity'; import { CalendarEventParticipantWorkspaceEntity } from 'src/modules/calendar/common/standard-objects/calendar-event-participant.workspace-entity'; import { CompanyWorkspaceEntity } from 'src/modules/company/standard-objects/company.workspace-entity'; import { FavoriteWorkspaceEntity } from 'src/modules/favorite/standard-objects/favorite.workspace-entity'; import { MessageParticipantWorkspaceEntity } from 'src/modules/messaging/common/standard-objects/message-participant.workspace-entity'; import { NoteTargetWorkspaceEntity } from 'src/modules/note/standard-objects/note-target.workspace-entity'; import { OpportunityWorkspaceEntity } from 'src/modules/opportunity/standard-objects/opportunity.workspace-entity'; import { TaskTargetWorkspaceEntity } from 'src/modules/task/standard-objects/task-target.workspace-entity'; import { TimelineActivityWorkspaceEntity } from 'src/modules/timeline/standard-objects/timeline-activity.workspace-entity'; const NAME_FIELD_NAME = 'name'; const EMAILS_FIELD_NAME = 'emails'; const JOB_TITLE_FIELD_NAME = 'jobTitle'; @WorkspaceEntity({ standardId: STANDARD_OBJECT_IDS.person, namePlural: 'people', labelSingular: 'Person', labelPlural: 'People', description: 'A person', icon: 'IconUser', labelIdentifierStandardId: PERSON_STANDARD_FIELD_IDS.name, imageIdentifierStandardId: PERSON_STANDARD_FIELD_IDS.avatarUrl, }) export class PersonWorkspaceEntity extends BaseWorkspaceEntity { @WorkspaceField({ standardId: PERSON_STANDARD_FIELD_IDS.name, type: FieldMetadataType.FULL_NAME, label: 'Name', description: 'Contact’s name', icon: 'IconUser', }) @WorkspaceIsNullable() [NAME_FIELD_NAME]: FullNameMetadata | null; @WorkspaceField({ standardId: PERSON_STANDARD_FIELD_IDS.emails, type: FieldMetadataType.EMAILS, label: 'Emails', description: 'Contact’s Emails', icon: 'IconMail', }) @WorkspaceIsUnique() [EMAILS_FIELD_NAME]: EmailsMetadata; @WorkspaceField({ standardId: PERSON_STANDARD_FIELD_IDS.linkedinLink, type: FieldMetadataType.LINKS, label: 'Linkedin', description: 'Contact’s Linkedin account', icon: 'IconBrandLinkedin', }) @WorkspaceIsNullable() linkedinLink: LinksMetadata | null; @WorkspaceField({ standardId: PERSON_STANDARD_FIELD_IDS.xLink, type: FieldMetadataType.LINKS, label: 'X', description: 'Contact’s X/Twitter account', icon: 'IconBrandX', }) @WorkspaceIsNullable() xLink: LinksMetadata | null; @WorkspaceField({ standardId: PERSON_STANDARD_FIELD_IDS.jobTitle, type: FieldMetadataType.TEXT, label: 'Job Title', description: 'Contact’s job title', icon: 'IconBriefcase', }) [JOB_TITLE_FIELD_NAME]: string; @WorkspaceField({ standardId: PERSON_STANDARD_FIELD_IDS.phone, type: FieldMetadataType.TEXT, label: 'Phone', description: 'Contact’s phone number', icon: 'IconPhone', }) @WorkspaceIsDeprecated() phone: string; @WorkspaceField({ standardId: PERSON_STANDARD_FIELD_IDS.phones, type: FieldMetadataType.PHONES, label: 'Phones', description: 'Contact’s phone numbers', icon: 'IconPhone', }) phones: PhonesMetadata; @WorkspaceField({ standardId: PERSON_STANDARD_FIELD_IDS.city, type: FieldMetadataType.TEXT, label: 'City', description: 'Contact’s city', icon: 'IconMap', }) city: string; @WorkspaceField({ standardId: PERSON_STANDARD_FIELD_IDS.avatarUrl, type: FieldMetadataType.TEXT, label: 'Avatar', description: 'Contact’s avatar', icon: 'IconFileUpload', }) @WorkspaceIsSystem() avatarUrl: string; @WorkspaceField({ standardId: PERSON_STANDARD_FIELD_IDS.position, type: FieldMetadataType.POSITION, label: 'Position', description: 'Person record Position', icon: 'IconHierarchy2', }) @WorkspaceIsSystem() @WorkspaceIsNullable() position: number; @WorkspaceField({ standardId: PERSON_STANDARD_FIELD_IDS.createdBy, type: FieldMetadataType.ACTOR, label: 'Created by', icon: 'IconCreativeCommonsSa', description: 'The creator of the record', defaultValue: { source: `'${FieldActorSource.MANUAL}'`, name: "''", }, }) createdBy: ActorMetadata; // Relations @WorkspaceRelation({ standardId: PERSON_STANDARD_FIELD_IDS.company, type: RelationMetadataType.MANY_TO_ONE, label: 'Company', description: 'Contact’s company', icon: 'IconBuildingSkyscraper', inverseSideTarget: () => CompanyWorkspaceEntity, inverseSideFieldKey: 'people', }) @WorkspaceIsNullable() company: Relation | null; @WorkspaceJoinColumn('company') companyId: string | null; @WorkspaceRelation({ standardId: PERSON_STANDARD_FIELD_IDS.pointOfContactForOpportunities, type: RelationMetadataType.ONE_TO_MANY, label: 'Linked Opportunities', description: 'List of opportunities for which that person is the point of contact', icon: 'IconTargetArrow', inverseSideTarget: () => OpportunityWorkspaceEntity, inverseSideFieldKey: 'pointOfContact', onDelete: RelationOnDeleteAction.SET_NULL, }) pointOfContactForOpportunities: Relation; @WorkspaceRelation({ standardId: PERSON_STANDARD_FIELD_IDS.activityTargets, type: RelationMetadataType.ONE_TO_MANY, label: 'Activities', description: 'Activities tied to the contact', icon: 'IconCheckbox', inverseSideTarget: () => ActivityTargetWorkspaceEntity, onDelete: RelationOnDeleteAction.CASCADE, }) @WorkspaceIsSystem() activityTargets: Relation; @WorkspaceRelation({ standardId: PERSON_STANDARD_FIELD_IDS.taskTargets, type: RelationMetadataType.ONE_TO_MANY, label: 'Tasks', description: 'Tasks tied to the contact', icon: 'IconCheckbox', inverseSideTarget: () => TaskTargetWorkspaceEntity, onDelete: RelationOnDeleteAction.CASCADE, }) taskTargets: Relation; @WorkspaceRelation({ standardId: PERSON_STANDARD_FIELD_IDS.noteTargets, type: RelationMetadataType.ONE_TO_MANY, label: 'Notes', description: 'Notes tied to the contact', icon: 'IconNotes', inverseSideTarget: () => NoteTargetWorkspaceEntity, onDelete: RelationOnDeleteAction.CASCADE, }) noteTargets: Relation; @WorkspaceRelation({ standardId: PERSON_STANDARD_FIELD_IDS.favorites, type: RelationMetadataType.ONE_TO_MANY, label: 'Favorites', description: 'Favorites linked to the contact', icon: 'IconHeart', inverseSideTarget: () => FavoriteWorkspaceEntity, onDelete: RelationOnDeleteAction.CASCADE, }) @WorkspaceIsSystem() favorites: Relation; @WorkspaceRelation({ standardId: PERSON_STANDARD_FIELD_IDS.attachments, type: RelationMetadataType.ONE_TO_MANY, label: 'Attachments', description: 'Attachments linked to the contact.', icon: 'IconFileImport', inverseSideTarget: () => AttachmentWorkspaceEntity, onDelete: RelationOnDeleteAction.CASCADE, }) attachments: Relation; @WorkspaceRelation({ standardId: PERSON_STANDARD_FIELD_IDS.messageParticipants, type: RelationMetadataType.ONE_TO_MANY, label: 'Message Participants', description: 'Message Participants', icon: 'IconUserCircle', inverseSideTarget: () => MessageParticipantWorkspaceEntity, inverseSideFieldKey: 'person', onDelete: RelationOnDeleteAction.SET_NULL, }) @WorkspaceIsSystem() messageParticipants: Relation; @WorkspaceRelation({ standardId: PERSON_STANDARD_FIELD_IDS.calendarEventParticipants, type: RelationMetadataType.ONE_TO_MANY, label: 'Calendar Event Participants', description: 'Calendar Event Participants', icon: 'IconCalendar', inverseSideTarget: () => CalendarEventParticipantWorkspaceEntity, onDelete: RelationOnDeleteAction.SET_NULL, }) @WorkspaceIsSystem() calendarEventParticipants: Relation< CalendarEventParticipantWorkspaceEntity[] >; @WorkspaceRelation({ standardId: PERSON_STANDARD_FIELD_IDS.timelineActivities, type: RelationMetadataType.ONE_TO_MANY, label: 'Events', description: 'Events linked to the person', icon: 'IconTimelineEvent', inverseSideTarget: () => TimelineActivityWorkspaceEntity, onDelete: RelationOnDeleteAction.CASCADE, }) @WorkspaceIsNullable() @WorkspaceIsSystem() timelineActivities: Relation; @WorkspaceField({ standardId: PERSON_STANDARD_FIELD_IDS.searchVector, type: FieldMetadataType.TS_VECTOR, label: SEARCH_VECTOR_FIELD.label, description: SEARCH_VECTOR_FIELD.description, icon: 'IconUser', generatedType: 'STORED', asExpression: getTsVectorColumnExpressionFromFields([ { name: NAME_FIELD_NAME, type: FieldMetadataType.FULL_NAME }, { name: EMAILS_FIELD_NAME, type: FieldMetadataType.EMAILS }, { name: JOB_TITLE_FIELD_NAME, type: FieldMetadataType.TEXT }, ]), }) @WorkspaceIsNullable() @WorkspaceIsSystem() @WorkspaceFieldIndex({ indexType: IndexType.GIN }) [SEARCH_VECTOR_FIELD.name]: any; }