The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
import {
Check,
Column,
CreateDateColumn,
DeleteDateColumn,
Entity,
Index,
JoinColumn,
ManyToOne,
OneToMany,
PrimaryGeneratedColumn,
type Relation,
UpdateDateColumn,
} from 'typeorm';
import { DEFAULT_VIEW_GROUP_LOAD_LIMIT } from 'twenty-shared/constants';
import { type APP_LOCALES } from 'twenty-shared/translations';
import {
AggregateOperations,
type SerializedRelation,
ViewCalendarLayout,
ViewKey,
ViewOpenRecordIn,
ViewType,
ViewVisibility,
} from 'twenty-shared/types';
import { WasIntroducedInUpgrade } from 'src/engine/core-modules/upgrade/decorators/was-introduced-in-upgrade.decorator';
import { WasRemovedInUpgrade } from 'src/engine/core-modules/upgrade/decorators/was-removed-in-upgrade.decorator';
import { UserWorkspaceEntity } from 'src/engine/core-modules/user-workspace/user-workspace.entity';
import { ADD_IS_SYSTEM_SIDE_EFFECT_UPGRADE_COMMAND_NAME } from 'src/database/commands/upgrade-version-command/2-15/is-system-side-effect-upgrade-command-name.constant';
import { ADD_VIEW_KANBAN_COLUMN_WIDTH_UPGRADE_COMMAND_NAME } from 'src/database/commands/upgrade-version-command/2-15/add-view-kanban-column-width-upgrade-command-name.constant';
import { ADD_CALENDAR_END_FIELD_METADATA_ID_TO_VIEW_UPGRADE_COMMAND_NAME } from 'src/database/commands/upgrade-version-command/2-22/add-calendar-end-field-metadata-id-to-view-upgrade-command-name.constant';
import { ADD_VIEW_GROUP_LOAD_LIMIT_UPGRADE_COMMAND_NAME } from 'src/database/commands/upgrade-version-command/2-42/add-view-group-load-limit-upgrade-command-name.constant';
import { DROP_IS_CUSTOM_FROM_AGENT_SKILL_VIEW_INDEX_AND_AGENT_CHAT_CHANNEL_UPGRADE_COMMAND_NAME } from 'src/database/commands/upgrade-version-command/2-54/drop-is-custom-from-agent-skill-view-index-and-agent-chat-channel-upgrade-command-name.constant';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { NavigationMenuItemEntity } from 'src/engine/metadata-modules/navigation-menu-item/entities/navigation-menu-item.entity';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { ViewFieldGroupEntity } from 'src/engine/metadata-modules/view-field-group/entities/view-field-group.entity';
import { ViewFieldEntity } from 'src/engine/metadata-modules/view-field/entities/view-field.entity';
import { ViewFilterGroupEntity } from 'src/engine/metadata-modules/view-filter-group/entities/view-filter-group.entity';
import { ViewFilterEntity } from 'src/engine/metadata-modules/view-filter/entities/view-filter.entity';
import { ViewGroupEntity } from 'src/engine/metadata-modules/view-group/entities/view-group.entity';
import { ViewSortEntity } from 'src/engine/metadata-modules/view-sort/entities/view-sort.entity';
import { OverridableEntity } from 'src/engine/workspace-manager/types/overridable-entity.type';
export type ViewOverrides = {
isActive?: boolean;
name?: string;
type?: ViewType;
icon?: string;
position?: number;
isCompact?: boolean;
openRecordIn?: ViewOpenRecordIn;
kanbanAggregateOperation?: AggregateOperations | null;
kanbanAggregateOperationFieldMetadataId?: SerializedRelation | null;
anyFieldFilterValue?: string | null;
calendarLayout?: ViewCalendarLayout | null;
calendarFieldMetadataId?: SerializedRelation | null;
calendarEndFieldMetadataId?: SerializedRelation | null;
visibility?: ViewVisibility;
mainGroupByFieldMetadataId?: SerializedRelation | null;
shouldHideEmptyGroups?: boolean;
kanbanColumnWidth?: number | null;
groupLoadLimit?: number;
translations?: Partial<
Record<keyof typeof APP_LOCALES, { name?: string | null }>
> | null;
};
// TODO: make this type dynamic to the view type
@Entity({ name: 'view', schema: 'core' })
@Index('IDX_VIEW_APPLICATION_ID', ['applicationId'])
@Index('IDX_VIEW_OBJECT_METADATA_ID_WORKSPACE_ID', [
'objectMetadataId',
'workspaceId',
])
@Index('IDX_VIEW_VISIBILITY', ['visibility'])
@Index('IDX_VIEW_CALENDAR_FIELD_METADATA', ['calendarFieldMetadataId'])
@Index('IDX_VIEW_CALENDAR_END_FIELD_METADATA', ['calendarEndFieldMetadataId'])
@Index('IDX_VIEW_KANBAN_FIELD_METADATA', [
'kanbanAggregateOperationFieldMetadataId',
])
@Index('IDX_VIEW_MAIN_GROUP_BY_FIELD_METADATA', ['mainGroupByFieldMetadataId'])
@Index('IDX_VIEW_CREATED_BY_USER_WORKSPACE', ['createdByUserWorkspaceId'])
@Check(
'CHK_VIEW_CALENDAR_INTEGRITY',
`("type" NOT IN ('CALENDAR', 'CALENDAR_WIDGET') OR ("calendarLayout" IS NOT NULL AND "calendarFieldMetadataId" IS NOT NULL))`,
)
export class ViewEntity
extends OverridableEntity<ViewOverrides>
implements Required<ViewEntity>
{
@PrimaryGeneratedColumn('uuid')
id: string;
@Column({ nullable: false, type: 'text', default: '' })
name: string;
@Column({ nullable: false, type: 'uuid' })
objectMetadataId: string;
@ManyToOne(() => ObjectMetadataEntity, {
onDelete: 'CASCADE',
})
@JoinColumn({ name: 'objectMetadataId' })
objectMetadata: Relation<ObjectMetadataEntity>;
@Column({
type: 'enum',
enum: Object.values(ViewType),
nullable: false,
default: ViewType.TABLE,
})
type: ViewType;
@Column({
type: 'enum',
enum: Object.values(ViewKey),
nullable: true,
default: null,
})
key: ViewKey | null;
@Column({ nullable: false, type: 'text' })
icon: string;
@Column({ nullable: false, type: 'double precision', default: 0 })
position: number;
@Column({ nullable: false, default: false, type: 'boolean' })
isCompact: boolean;
@WasRemovedInUpgrade({
upgradeCommandName:
DROP_IS_CUSTOM_FROM_AGENT_SKILL_VIEW_INDEX_AND_AGENT_CHAT_CHANNEL_UPGRADE_COMMAND_NAME,
})
@Column({ nullable: false, default: false, type: 'boolean' })
isCustom: WasRemovedInUpgrade<boolean>;
// Deprecated: superseded by objectMetadata.openRecordIn and the member preference.
@Column({
type: 'enum',
enum: Object.values(ViewOpenRecordIn),
nullable: false,
default: ViewOpenRecordIn.SIDE_PANEL,
})
openRecordIn: ViewOpenRecordIn;
@Column({
type: 'enum',
enum: Object.values(AggregateOperations),
nullable: true,
default: null,
})
kanbanAggregateOperation: AggregateOperations | null;
@Column({ nullable: true, type: 'uuid' })
kanbanAggregateOperationFieldMetadataId: string | null;
@ManyToOne(
() => FieldMetadataEntity,
(FieldMetadataEntity) => FieldMetadataEntity.kanbanAggregateOperationViews,
{
onDelete: 'CASCADE',
nullable: true,
},
)
@JoinColumn({ name: 'kanbanAggregateOperationFieldMetadataId' })
kanbanAggregateOperationFieldMetadata: Relation<FieldMetadataEntity> | null;
@Column({
type: 'enum',
enum: Object.values(ViewCalendarLayout),
nullable: true,
default: null,
})
calendarLayout: ViewCalendarLayout | null;
@Column({ nullable: true, type: 'uuid' })
calendarFieldMetadataId: string | null;
@ManyToOne(
() => FieldMetadataEntity,
(fieldMetadata) => fieldMetadata.calendarViews,
{
onDelete: 'CASCADE',
nullable: true,
},
)
@JoinColumn({ name: 'calendarFieldMetadataId' })
calendarFieldMetadata: Relation<FieldMetadataEntity> | null;
@WasIntroducedInUpgrade({
upgradeCommandName:
ADD_CALENDAR_END_FIELD_METADATA_ID_TO_VIEW_UPGRADE_COMMAND_NAME,
})
@Column({ nullable: true, type: 'uuid' })
calendarEndFieldMetadataId: string | null;
@ManyToOne(
() => FieldMetadataEntity,
(fieldMetadata) => fieldMetadata.calendarEndViews,
{
onDelete: 'SET NULL',
nullable: true,
},
)
@JoinColumn({ name: 'calendarEndFieldMetadataId' })
calendarEndFieldMetadata: Relation<FieldMetadataEntity> | null;
@Column({ nullable: true, type: 'uuid' })
mainGroupByFieldMetadataId: string | null;
@ManyToOne(
() => FieldMetadataEntity,
(fieldMetadata) => fieldMetadata.mainGroupByFieldMetadataViews,
{
onDelete: 'CASCADE',
nullable: true,
},
)
@JoinColumn({ name: 'mainGroupByFieldMetadataId' })
mainGroupByFieldMetadata: Relation<FieldMetadataEntity> | null;
@Column({ nullable: false, default: false, type: 'boolean' })
shouldHideEmptyGroups: boolean;
@WasIntroducedInUpgrade({
upgradeCommandName: ADD_VIEW_KANBAN_COLUMN_WIDTH_UPGRADE_COMMAND_NAME,
})
@Column({ nullable: true, type: 'int', default: null })
kanbanColumnWidth: number | null;
@WasIntroducedInUpgrade({
upgradeCommandName: ADD_VIEW_GROUP_LOAD_LIMIT_UPGRADE_COMMAND_NAME,
})
@Column({
nullable: false,
type: 'int',
default: DEFAULT_VIEW_GROUP_LOAD_LIMIT,
})
groupLoadLimit: number;
@CreateDateColumn({ type: 'timestamptz' })
createdAt: Date;
@UpdateDateColumn({ type: 'timestamptz' })
updatedAt: Date;
@DeleteDateColumn({ type: 'timestamptz' })
deletedAt: Date | null;
@Column({ nullable: true, type: 'text', default: null })
anyFieldFilterValue: string | null;
@Column({
type: 'enum',
enum: Object.values(ViewVisibility),
nullable: false,
default: ViewVisibility.WORKSPACE,
})
visibility: ViewVisibility;
@WasIntroducedInUpgrade({
upgradeCommandName: ADD_IS_SYSTEM_SIDE_EFFECT_UPGRADE_COMMAND_NAME,
})
@Column({ nullable: false, default: false, type: 'boolean' })
isSystemSideEffect: boolean;
@Column({ nullable: true, type: 'uuid' })
createdByUserWorkspaceId: string | null;
@ManyToOne(() => UserWorkspaceEntity, {
onDelete: 'SET NULL',
})
@JoinColumn({ name: 'createdByUserWorkspaceId' })
createdBy: Relation<UserWorkspaceEntity>;
@OneToMany(() => ViewFieldEntity, (viewField) => viewField.view)
viewFields: Relation<ViewFieldEntity[]>;
@OneToMany(
() => ViewFieldGroupEntity,
(viewFieldGroup) => viewFieldGroup.view,
)
viewFieldGroups: Relation<ViewFieldGroupEntity[]>;
@OneToMany(() => ViewFilterEntity, (viewFilter) => viewFilter.view)
viewFilters: Relation<ViewFilterEntity[]>;
@OneToMany(() => ViewSortEntity, (viewSort) => viewSort.view)
viewSorts: Relation<ViewSortEntity[]>;
@OneToMany(() => ViewGroupEntity, (viewGroup) => viewGroup.view)
viewGroups: Relation<ViewGroupEntity[]>;
@OneToMany(
() => ViewFilterGroupEntity,
(viewFilterGroup) => viewFilterGroup.view,
)
viewFilterGroups: Relation<ViewFilterGroupEntity[]>;
@OneToMany(
() => NavigationMenuItemEntity,
(navigationMenuItem) => navigationMenuItem.view,
)
navigationMenuItems: Relation<NavigationMenuItemEntity[]>;
}
const VIEW_OVERRIDABLE_COLUMNS_UPGRADE_COMMAND_NAME =
'2.12.0_ViewOverridableEntityFastInstanceCommand_1781114009075';
WasIntroducedInUpgrade({
upgradeCommandName: VIEW_OVERRIDABLE_COLUMNS_UPGRADE_COMMAND_NAME,
})(ViewEntity.prototype, 'overrides');
WasIntroducedInUpgrade({
upgradeCommandName: VIEW_OVERRIDABLE_COLUMNS_UPGRADE_COMMAND_NAME,
})(ViewEntity.prototype, 'isActive');