Create PageLayoutWidgetEntity (#14106)

Closes https://github.com/twentyhq/core-team-issues/issues/1391

packages/twenty-server/src/engine/core-modules/page-layout/entities/page-layout-tab.entity.ts

@@ -6,11 +6,13 @@ import {
   Index,
   JoinColumn,
   ManyToOne,
+  OneToMany,
   PrimaryGeneratedColumn,
   Relation,
   UpdateDateColumn,
 } from 'typeorm';
 
+import { PageLayoutWidgetEntity } from 'src/engine/core-modules/page-layout/entities/page-layout-widget.entity';
 import { PageLayoutEntity } from 'src/engine/core-modules/page-layout/entities/page-layout.entity';
 
 @Entity({ name: 'pageLayoutTab', schema: 'core' })
@@ -34,6 +36,11 @@ export class PageLayoutTabEntity implements Required<PageLayoutTabEntity> {
   @JoinColumn({ name: 'pageLayoutId' })
   pageLayout: Relation<PageLayoutEntity>;
 
+  @OneToMany(() => PageLayoutWidgetEntity, (widget) => widget.pageLayoutTab, {
+    cascade: true,
+  })
+  widgets: Relation<PageLayoutWidgetEntity[]>;
+
   @CreateDateColumn({ type: 'timestamptz' })
   createdAt: Date;
 

packages/twenty-server/src/engine/core-modules/page-layout/entities/page-layout-widget.entity.ts

@@ -0,0 +1,71 @@
+import {
+  Column,
+  CreateDateColumn,
+  DeleteDateColumn,
+  Entity,
+  Index,
+  JoinColumn,
+  ManyToOne,
+  PrimaryGeneratedColumn,
+  Relation,
+  UpdateDateColumn,
+} from 'typeorm';
+
+import { PageLayoutTabEntity } from 'src/engine/core-modules/page-layout/entities/page-layout-tab.entity';
+import { WidgetType } from 'src/engine/core-modules/page-layout/enums/widget-type.enum';
+import { GridPosition } from 'src/engine/core-modules/page-layout/types/grid-position.type';
+import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
+
+@Entity({ name: 'pageLayoutWidget', schema: 'core' })
+@Index('IDX_PAGE_LAYOUT_WIDGET_PAGE_LAYOUT_TAB_ID', ['pageLayoutTabId'])
+export class PageLayoutWidgetEntity
+  implements Required<PageLayoutWidgetEntity>
+{
+  @PrimaryGeneratedColumn('uuid')
+  id: string;
+
+  @Column({ nullable: false, type: 'uuid' })
+  pageLayoutTabId: string;
+
+  @ManyToOne(() => PageLayoutTabEntity, {
+    onDelete: 'CASCADE',
+  })
+  @JoinColumn({ name: 'pageLayoutTabId' })
+  pageLayoutTab: Relation<PageLayoutTabEntity>;
+
+  @Column({ nullable: false })
+  title: string;
+
+  @Column({
+    type: 'enum',
+    enum: Object.values(WidgetType),
+    nullable: false,
+    default: WidgetType.VIEW,
+  })
+  type: WidgetType;
+
+  @Column({ nullable: true, type: 'uuid' })
+  objectMetadataId: string | null;
+
+  @ManyToOne(() => ObjectMetadataEntity, {
+    onDelete: 'CASCADE',
+    nullable: true,
+  })
+  @JoinColumn({ name: 'objectMetadataId' })
+  objectMetadata: Relation<ObjectMetadataEntity> | null;
+
+  @Column({ type: 'jsonb', nullable: false })
+  gridPosition: GridPosition;
+
+  @Column({ type: 'jsonb', nullable: true })
+  configuration: Record<string, unknown> | null;
+
+  @CreateDateColumn({ type: 'timestamptz' })
+  createdAt: Date;
+
+  @UpdateDateColumn({ type: 'timestamptz' })
+  updatedAt: Date;
+
+  @DeleteDateColumn({ type: 'timestamptz' })
+  deletedAt: Date | null;
+}

packages/twenty-server/src/engine/core-modules/page-layout/enums/widget-type.enum.ts

@@ -0,0 +1,6 @@
+export enum WidgetType {
+  VIEW = 'VIEW',
+  IFRAME = 'IFRAME',
+  FIELDS = 'FIELDS',
+  GRAPH = 'GRAPH',
+}

packages/twenty-server/src/engine/core-modules/page-layout/page-layout.module.ts

@@ -2,11 +2,15 @@ import { Module } from '@nestjs/common';
 import { TypeOrmModule } from '@nestjs/typeorm';
 
 import { PageLayoutTabEntity } from 'src/engine/core-modules/page-layout/entities/page-layout-tab.entity';
+import { PageLayoutWidgetEntity } from 'src/engine/core-modules/page-layout/entities/page-layout-widget.entity';
 import { PageLayoutEntity } from 'src/engine/core-modules/page-layout/entities/page-layout.entity';
 
 @Module({
   imports: [
-    TypeOrmModule.forFeature([PageLayoutEntity, PageLayoutTabEntity], 'core'),
+    TypeOrmModule.forFeature(
+      [PageLayoutEntity, PageLayoutTabEntity, PageLayoutWidgetEntity],
+      'core',
+    ),
   ],
   exports: [],
 })

packages/twenty-server/src/engine/core-modules/page-layout/types/grid-position.type.ts

@@ -0,0 +1,6 @@
+export type GridPosition = {
+  row: number;
+  column: number;
+  rowSpan: number;
+  columnSpan: number;
+};