import { msg } from '@lingui/core/macro'; import { FieldMetadataType } from 'twenty-shared/types'; import { RelationOnDeleteAction } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-on-delete-action.interface'; import { RelationType } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-type.interface'; 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 { IndexType } from 'src/engine/metadata-modules/index-metadata/types/indexType.types'; 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 { WorkspaceIsFieldUIReadOnly } from 'src/engine/twenty-orm/decorators/workspace-is-field-ui-readonly.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 { WorkspaceRelation } from 'src/engine/twenty-orm/decorators/workspace-relation.decorator'; import { DASHBOARD_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 { AttachmentWorkspaceEntity } from 'src/modules/attachment/standard-objects/attachment.workspace-entity'; import { FavoriteWorkspaceEntity } from 'src/modules/favorite/standard-objects/favorite.workspace-entity'; import { TimelineActivityWorkspaceEntity } from 'src/modules/timeline/standard-objects/timeline-activity.workspace-entity'; @WorkspaceEntity({ standardId: STANDARD_OBJECT_IDS.dashboard, namePlural: 'dashboards', labelSingular: msg`Dashboard`, labelPlural: msg`Dashboards`, description: msg`A dashboard`, icon: STANDARD_OBJECT_ICONS.dashboard, labelIdentifierStandardId: DASHBOARD_STANDARD_FIELD_IDS.title, }) @WorkspaceGate({ featureFlag: FeatureFlagKey.IS_PAGE_LAYOUT_ENABLED, }) @WorkspaceIsSearchable() export class DashboardWorkspaceEntity extends BaseWorkspaceEntity { @WorkspaceField({ standardId: DASHBOARD_STANDARD_FIELD_IDS.title, type: FieldMetadataType.TEXT, label: msg`Title`, description: msg`Dashboard title`, icon: 'IconNotes', }) title: string; @WorkspaceField({ standardId: DASHBOARD_STANDARD_FIELD_IDS.pageLayoutId, type: FieldMetadataType.UUID, label: msg`Page Layout ID`, description: msg`Dashboard page layout`, icon: 'IconLayout', }) @WorkspaceIsNullable() @WorkspaceIsFieldUIReadOnly() pageLayoutId: string | null; @WorkspaceField({ standardId: DASHBOARD_STANDARD_FIELD_IDS.position, type: FieldMetadataType.POSITION, label: msg`Position`, description: msg`Dashboard record Position`, icon: 'IconHierarchy2', defaultValue: 0, }) @WorkspaceIsSystem() position: number; @WorkspaceField({ standardId: DASHBOARD_STANDARD_FIELD_IDS.createdBy, type: FieldMetadataType.ACTOR, label: msg`Created by`, icon: 'IconCreativeCommonsSa', description: msg`The creator of the record`, }) @WorkspaceIsFieldUIReadOnly() createdBy: ActorMetadata; @WorkspaceRelation({ standardId: DASHBOARD_STANDARD_FIELD_IDS.timelineActivities, type: RelationType.ONE_TO_MANY, label: msg`Timeline Activities`, description: msg`Timeline activities linked to the dashboard`, inverseSideTarget: () => TimelineActivityWorkspaceEntity, onDelete: RelationOnDeleteAction.SET_NULL, }) @WorkspaceIsNullable() @WorkspaceIsSystem() timelineActivities: Relation; @WorkspaceRelation({ standardId: DASHBOARD_STANDARD_FIELD_IDS.favorites, type: RelationType.ONE_TO_MANY, label: msg`Favorites`, description: msg`Favorites linked to the dashboard`, inverseSideTarget: () => FavoriteWorkspaceEntity, onDelete: RelationOnDeleteAction.CASCADE, }) @WorkspaceIsSystem() favorites: Relation; @WorkspaceRelation({ standardId: DASHBOARD_STANDARD_FIELD_IDS.attachments, type: RelationType.ONE_TO_MANY, label: msg`Attachments`, description: msg`Attachments linked to the dashboard`, inverseSideTarget: () => AttachmentWorkspaceEntity, onDelete: RelationOnDeleteAction.CASCADE, }) @WorkspaceIsNullable() @WorkspaceIsSystem() attachments: Relation; @WorkspaceField({ standardId: DASHBOARD_STANDARD_FIELD_IDS.searchVector, type: FieldMetadataType.TS_VECTOR, label: SEARCH_VECTOR_FIELD.label, description: SEARCH_VECTOR_FIELD.description, icon: 'IconUser', generatedType: 'STORED', asExpression: `to_tsvector('english', title)`, }) @WorkspaceIsNullable() @WorkspaceIsSystem() @WorkspaceFieldIndex({ indexType: IndexType.GIN }) searchVector: string; }