import { msg } from '@lingui/core/macro'; import { FieldMetadataType } from 'twenty-shared'; 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 } from 'src/engine/metadata-modules/field-metadata/composite-types/actor.composite-type'; import { AddressMetadata } from 'src/engine/metadata-modules/field-metadata/composite-types/address.composite-type'; import { CurrencyMetadata } from 'src/engine/metadata-modules/field-metadata/composite-types/currency.composite-type'; import { LinksMetadata } from 'src/engine/metadata-modules/field-metadata/composite-types/links.composite-type'; 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 { WorkspaceDuplicateCriteria } from 'src/engine/twenty-orm/decorators/workspace-duplicate-criteria.decorator'; 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 { WorkspaceIsSearchable } from 'src/engine/twenty-orm/decorators/workspace-is-searchable.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 { COMPANY_STANDARD_FIELD_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-field-ids'; import { STANDARD_OBJECT_ICONS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-icons'; import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids'; import { FieldTypeAndNameMetadata, getTsVectorColumnExpressionFromFields, } from 'src/engine/workspace-manager/workspace-sync-metadata/utils/get-ts-vector-column-expression.util'; import { AttachmentWorkspaceEntity } from 'src/modules/attachment/standard-objects/attachment.workspace-entity'; import { FavoriteWorkspaceEntity } from 'src/modules/favorite/standard-objects/favorite.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 { PersonWorkspaceEntity } from 'src/modules/person/standard-objects/person.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'; import { WorkspaceMemberWorkspaceEntity } from 'src/modules/workspace-member/standard-objects/workspace-member.workspace-entity'; const NAME_FIELD_NAME = 'name'; const DOMAIN_NAME_FIELD_NAME = 'domainName'; export const SEARCH_FIELDS_FOR_COMPANY: FieldTypeAndNameMetadata[] = [ { name: NAME_FIELD_NAME, type: FieldMetadataType.TEXT }, { name: DOMAIN_NAME_FIELD_NAME, type: FieldMetadataType.LINKS }, ]; @WorkspaceEntity({ standardId: STANDARD_OBJECT_IDS.company, namePlural: 'companies', labelSingular: msg`Company`, labelPlural: msg`Companies`, description: msg`A company`, icon: STANDARD_OBJECT_ICONS.company, shortcut: 'C', labelIdentifierStandardId: COMPANY_STANDARD_FIELD_IDS.name, }) @WorkspaceDuplicateCriteria([['name'], ['domainNamePrimaryLinkUrl']]) @WorkspaceIsSearchable() export class CompanyWorkspaceEntity extends BaseWorkspaceEntity { @WorkspaceField({ standardId: COMPANY_STANDARD_FIELD_IDS.name, type: FieldMetadataType.TEXT, label: msg`Name`, description: msg`The company name`, icon: 'IconBuildingSkyscraper', }) name: string; @WorkspaceField({ standardId: COMPANY_STANDARD_FIELD_IDS.domainName, type: FieldMetadataType.LINKS, label: msg`Domain Name`, description: msg`The company website URL. We use this url to fetch the company icon`, icon: 'IconLink', }) @WorkspaceIsUnique() domainName: LinksMetadata; @WorkspaceField({ standardId: COMPANY_STANDARD_FIELD_IDS.employees, type: FieldMetadataType.NUMBER, label: msg`Employees`, description: msg`Number of employees in the company`, icon: 'IconUsers', }) @WorkspaceIsNullable() employees: number | null; @WorkspaceField({ standardId: COMPANY_STANDARD_FIELD_IDS.linkedinLink, type: FieldMetadataType.LINKS, label: msg`Linkedin`, description: msg`The company Linkedin account`, icon: 'IconBrandLinkedin', }) @WorkspaceIsNullable() linkedinLink: LinksMetadata | null; @WorkspaceField({ standardId: COMPANY_STANDARD_FIELD_IDS.xLink, type: FieldMetadataType.LINKS, label: msg`X`, description: msg`The company Twitter/X account`, icon: 'IconBrandX', }) @WorkspaceIsNullable() xLink: LinksMetadata | null; @WorkspaceField({ standardId: COMPANY_STANDARD_FIELD_IDS.annualRecurringRevenue, type: FieldMetadataType.CURRENCY, label: msg`ARR`, description: msg`Annual Recurring Revenue: The actual or estimated annual revenue of the company`, icon: 'IconMoneybag', }) @WorkspaceIsNullable() annualRecurringRevenue: CurrencyMetadata | null; @WorkspaceField({ standardId: COMPANY_STANDARD_FIELD_IDS.address, type: FieldMetadataType.ADDRESS, label: msg`Address`, description: msg`Address of the company`, icon: 'IconMap', }) @WorkspaceIsNullable() address: AddressMetadata; @WorkspaceField({ standardId: COMPANY_STANDARD_FIELD_IDS.idealCustomerProfile, type: FieldMetadataType.BOOLEAN, label: msg`ICP`, description: msg`Ideal Customer Profile: Indicates whether the company is the most suitable and valuable customer for you`, icon: 'IconTarget', defaultValue: false, }) idealCustomerProfile: boolean; @WorkspaceField({ standardId: COMPANY_STANDARD_FIELD_IDS.position, type: FieldMetadataType.POSITION, label: msg`Position`, description: msg`Company record position`, icon: 'IconHierarchy2', defaultValue: 0, }) @WorkspaceIsSystem() position: number; @WorkspaceField({ standardId: COMPANY_STANDARD_FIELD_IDS.createdBy, type: FieldMetadataType.ACTOR, label: msg`Created by`, icon: 'IconCreativeCommonsSa', description: msg`The creator of the record`, }) createdBy: ActorMetadata; // Relations @WorkspaceRelation({ standardId: COMPANY_STANDARD_FIELD_IDS.people, type: RelationMetadataType.ONE_TO_MANY, label: msg`People`, description: msg`People linked to the company.`, icon: 'IconUsers', inverseSideTarget: () => PersonWorkspaceEntity, onDelete: RelationOnDeleteAction.SET_NULL, }) @WorkspaceIsNullable() people: Relation; @WorkspaceRelation({ standardId: COMPANY_STANDARD_FIELD_IDS.accountOwner, type: RelationMetadataType.MANY_TO_ONE, label: msg`Account Owner`, description: msg`Your team member responsible for managing the company account`, icon: 'IconUserCircle', inverseSideTarget: () => WorkspaceMemberWorkspaceEntity, inverseSideFieldKey: 'accountOwnerForCompanies', onDelete: RelationOnDeleteAction.SET_NULL, }) @WorkspaceIsNullable() accountOwner: Relation | null; @WorkspaceJoinColumn('accountOwner') accountOwnerId: string | null; @WorkspaceRelation({ standardId: COMPANY_STANDARD_FIELD_IDS.taskTargets, type: RelationMetadataType.ONE_TO_MANY, label: msg`Tasks`, description: msg`Tasks tied to the company`, icon: 'IconCheckbox', inverseSideTarget: () => TaskTargetWorkspaceEntity, onDelete: RelationOnDeleteAction.CASCADE, }) taskTargets: Relation; @WorkspaceRelation({ standardId: COMPANY_STANDARD_FIELD_IDS.noteTargets, type: RelationMetadataType.ONE_TO_MANY, label: msg`Notes`, description: msg`Notes tied to the company`, icon: 'IconNotes', inverseSideTarget: () => NoteTargetWorkspaceEntity, onDelete: RelationOnDeleteAction.CASCADE, }) noteTargets: Relation; @WorkspaceRelation({ standardId: COMPANY_STANDARD_FIELD_IDS.opportunities, type: RelationMetadataType.ONE_TO_MANY, label: msg`Opportunities`, description: msg`Opportunities linked to the company.`, icon: 'IconTargetArrow', inverseSideTarget: () => OpportunityWorkspaceEntity, onDelete: RelationOnDeleteAction.SET_NULL, }) @WorkspaceIsNullable() opportunities: Relation; @WorkspaceRelation({ standardId: COMPANY_STANDARD_FIELD_IDS.favorites, type: RelationMetadataType.ONE_TO_MANY, label: msg`Favorites`, description: msg`Favorites linked to the company`, icon: 'IconHeart', inverseSideTarget: () => FavoriteWorkspaceEntity, onDelete: RelationOnDeleteAction.CASCADE, }) @WorkspaceIsNullable() @WorkspaceIsSystem() favorites: Relation; @WorkspaceRelation({ standardId: COMPANY_STANDARD_FIELD_IDS.attachments, type: RelationMetadataType.ONE_TO_MANY, label: msg`Attachments`, description: msg`Attachments linked to the company`, icon: 'IconFileImport', inverseSideTarget: () => AttachmentWorkspaceEntity, onDelete: RelationOnDeleteAction.CASCADE, }) @WorkspaceIsNullable() attachments: Relation; @WorkspaceRelation({ standardId: COMPANY_STANDARD_FIELD_IDS.timelineActivities, type: RelationMetadataType.ONE_TO_MANY, label: msg`Timeline Activities`, description: msg`Timeline Activities linked to the company`, icon: 'IconIconTimelineEvent', inverseSideTarget: () => TimelineActivityWorkspaceEntity, onDelete: RelationOnDeleteAction.CASCADE, }) @WorkspaceIsNullable() @WorkspaceIsSystem() timelineActivities: Relation; @WorkspaceField({ standardId: COMPANY_STANDARD_FIELD_IDS.address_deprecated, type: FieldMetadataType.TEXT, label: msg`Address (deprecated) `, description: msg`Address of the company - deprecated in favor of new address field`, icon: 'IconMap', }) @WorkspaceIsDeprecated() @WorkspaceIsNullable() addressOld: string; @WorkspaceField({ standardId: COMPANY_STANDARD_FIELD_IDS.searchVector, type: FieldMetadataType.TS_VECTOR, label: SEARCH_VECTOR_FIELD.label, description: SEARCH_VECTOR_FIELD.description, icon: 'IconUser', generatedType: 'STORED', asExpression: getTsVectorColumnExpressionFromFields( SEARCH_FIELDS_FOR_COMPANY, ), }) @WorkspaceIsNullable() @WorkspaceIsSystem() @WorkspaceFieldIndex({ indexType: IndexType.GIN }) searchVector: any; }