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 { FeatureFlagKey } from 'src/engine/core-modules/feature-flag/enums/feature-flag-key.enum'; 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 { RichTextV2Metadata } from 'src/engine/metadata-modules/field-metadata/composite-types/rich-text-v2.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 { 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 { WorkspaceGate } from 'src/engine/twenty-orm/decorators/workspace-gate.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 { WorkspaceRelation } from 'src/engine/twenty-orm/decorators/workspace-relation.decorator'; import { NOTE_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 { TimelineActivityWorkspaceEntity } from 'src/modules/timeline/standard-objects/timeline-activity.workspace-entity'; const TITLE_FIELD_NAME = 'title'; export const SEARCH_FIELDS_FOR_NOTES: FieldTypeAndNameMetadata[] = [ { name: TITLE_FIELD_NAME, type: FieldMetadataType.TEXT }, ]; @WorkspaceEntity({ standardId: STANDARD_OBJECT_IDS.note, namePlural: 'notes', labelSingular: msg`Note`, labelPlural: msg`Notes`, description: msg`A note`, icon: STANDARD_OBJECT_ICONS.note, shortcut: 'N', labelIdentifierStandardId: NOTE_STANDARD_FIELD_IDS.title, }) export class NoteWorkspaceEntity extends BaseWorkspaceEntity { @WorkspaceField({ standardId: NOTE_STANDARD_FIELD_IDS.position, type: FieldMetadataType.POSITION, label: msg`Position`, description: msg`Note record position`, icon: 'IconHierarchy2', defaultValue: 0, }) @WorkspaceIsSystem() position: number; @WorkspaceField({ standardId: NOTE_STANDARD_FIELD_IDS.title, type: FieldMetadataType.TEXT, label: msg`Title`, description: msg`Note title`, icon: 'IconNotes', }) title: string; @WorkspaceField({ standardId: NOTE_STANDARD_FIELD_IDS.body, type: FieldMetadataType.RICH_TEXT, label: msg`Body`, description: msg`Note body`, icon: 'IconFilePencil', }) @WorkspaceIsNullable() body: string | null; @WorkspaceField({ standardId: NOTE_STANDARD_FIELD_IDS.bodyV2, type: FieldMetadataType.RICH_TEXT_V2, label: msg`Body`, description: msg`Note body`, icon: 'IconFilePencil', }) @WorkspaceIsNullable() @WorkspaceGate({ featureFlag: FeatureFlagKey.IsRichTextV2Enabled, }) bodyV2: RichTextV2Metadata | null; @WorkspaceField({ standardId: NOTE_STANDARD_FIELD_IDS.createdBy, type: FieldMetadataType.ACTOR, label: msg`Created by`, icon: 'IconCreativeCommonsSa', description: msg`The creator of the record`, }) createdBy: ActorMetadata; @WorkspaceRelation({ standardId: NOTE_STANDARD_FIELD_IDS.noteTargets, label: msg`Relations`, description: msg`Note targets`, icon: 'IconArrowUpRight', type: RelationMetadataType.ONE_TO_MANY, inverseSideTarget: () => NoteTargetWorkspaceEntity, onDelete: RelationOnDeleteAction.SET_NULL, }) @WorkspaceIsNullable() noteTargets: Relation; @WorkspaceRelation({ standardId: NOTE_STANDARD_FIELD_IDS.attachments, label: msg`Attachments`, description: msg`Note attachments`, icon: 'IconFileImport', type: RelationMetadataType.ONE_TO_MANY, inverseSideTarget: () => AttachmentWorkspaceEntity, onDelete: RelationOnDeleteAction.SET_NULL, }) @WorkspaceIsNullable() attachments: Relation; @WorkspaceRelation({ standardId: NOTE_STANDARD_FIELD_IDS.timelineActivities, type: RelationMetadataType.ONE_TO_MANY, label: msg`Timeline Activities`, description: msg`Timeline Activities linked to the note.`, icon: 'IconTimelineEvent', inverseSideTarget: () => TimelineActivityWorkspaceEntity, onDelete: RelationOnDeleteAction.SET_NULL, }) @WorkspaceIsNullable() timelineActivities: Relation; @WorkspaceRelation({ standardId: NOTE_STANDARD_FIELD_IDS.favorites, type: RelationMetadataType.ONE_TO_MANY, label: msg`Favorites`, description: msg`Favorites linked to the note`, icon: 'IconHeart', inverseSideTarget: () => FavoriteWorkspaceEntity, onDelete: RelationOnDeleteAction.CASCADE, }) @WorkspaceIsSystem() favorites: Relation; @WorkspaceField({ standardId: NOTE_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_NOTES, ), }) @WorkspaceIsNullable() @WorkspaceIsSystem() @WorkspaceFieldIndex({ indexType: IndexType.GIN }) searchVector: any; }