Introducing view field group syncable entity (#17867)

## Context
Introduces a new viewFieldGroup entity that allows grouping view fields
into sections (e.g. "General", "Additional", "Other") within a view.

The page layout fields widget needs a way to organize fields into
sections. Today, views have no concept of field grouping. This PR
introduces the viewFieldGroup entity which sits between a view and its
viewFields, enabling section-based organization.

<img width="401" height="724" alt="Layout - V2 (customize visibility)"
src="https://github.com/user-attachments/assets/6376e2ab-44db-42bf-9d2c-758f56f6b548"
/>

---------

Co-authored-by: Charles Bochet <charles@twenty.com>

packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/__tests__/__snapshots__/all-universal-flat-entity-properties-to-compare-and-stringify.constant.constant.spec.ts.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`ALL_UNIVERSAL_FLAT_ENTITY_PROPERTIES_TO_COMPARE_AND_STRINGIFY should match snapshot 1`] = `
 {
@@ -246,6 +246,16 @@ exports[`ALL_UNIVERSAL_FLAT_ENTITY_PROPERTIES_TO_COMPARE_AND_STRINGIFY should ma
       "size",
       "position",
       "aggregateOperation",
+      "viewFieldGroupUniversalIdentifier",
+      "deletedAt",
+    ],
+    "propertiesToStringify": [],
+  },
+  "viewFieldGroup": {
+    "propertiesToCompare": [
+      "name",
+      "position",
+      "isVisible",
       "deletedAt",
     ],
     "propertiesToStringify": [],

packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/all-entity-properties-configuration-by-metadata-name.constant.ts

@@ -112,6 +112,16 @@ export const ALL_ENTITY_PROPERTIES_CONFIGURATION_BY_METADATA_NAME = {
     size: { toStringify: false, universalProperty: undefined },
     position: { toStringify: false, universalProperty: undefined },
     aggregateOperation: { toStringify: false, universalProperty: undefined },
+    viewFieldGroupId: {
+      toStringify: false,
+      universalProperty: 'viewFieldGroupUniversalIdentifier',
+    },
+    deletedAt: { toStringify: false, universalProperty: undefined },
+  },
+  viewFieldGroup: {
+    name: { toStringify: false, universalProperty: undefined },
+    position: { toStringify: false, universalProperty: undefined },
+    isVisible: { toStringify: false, universalProperty: undefined },
     deletedAt: { toStringify: false, universalProperty: undefined },
   },
   viewGroup: {

packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/all-metadata-entity-by-metadata-name.constant.ts

@@ -18,6 +18,7 @@ import { RowLevelPermissionPredicateGroupEntity } from 'src/engine/metadata-modu
 import { RowLevelPermissionPredicateEntity } from 'src/engine/metadata-modules/row-level-permission-predicate/entities/row-level-permission-predicate.entity';
 import { LogicFunctionEntity } from 'src/engine/metadata-modules/logic-function/logic-function.entity';
 import { SkillEntity } from 'src/engine/metadata-modules/skill/entities/skill.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';
@@ -26,6 +27,7 @@ import { ViewEntity } from 'src/engine/metadata-modules/view/entities/view.entit
 
 export const ALL_METADATA_ENTITY_BY_METADATA_NAME = {
   viewField: ViewFieldEntity,
+  viewFieldGroup: ViewFieldGroupEntity,
   viewFilter: ViewFilterEntity,
   viewGroup: ViewGroupEntity,
   viewFilterGroup: ViewFilterGroupEntity,

packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/all-metadata-relations.constant.ts

@@ -221,6 +221,7 @@ export const ALL_METADATA_RELATIONS = {
         metadataName: 'viewFilterGroup',
       },
       viewGroups: { metadataName: 'viewGroup' },
+      viewFieldGroups: { metadataName: 'viewFieldGroup' },
       // @ts-expect-error TODO migrate viewSort to v2
       viewSorts: null,
     },
@@ -239,11 +240,32 @@ export const ALL_METADATA_RELATIONS = {
         foreignKey: 'viewId',
         isNullable: false,
       },
+      viewFieldGroup: {
+        metadataName: 'viewFieldGroup',
+        flatEntityForeignKeyAggregator: 'viewFieldIds',
+        foreignKey: 'viewFieldGroupId',
+        isNullable: true,
+      },
       workspace: null,
       application: null,
     },
     oneToMany: {},
   },
+  viewFieldGroup: {
+    manyToOne: {
+      view: {
+        metadataName: 'view',
+        flatEntityForeignKeyAggregator: 'viewFieldGroupIds',
+        foreignKey: 'viewId',
+        isNullable: false,
+      },
+      workspace: null,
+      application: null,
+    },
+    oneToMany: {
+      viewFields: { metadataName: 'viewField' },
+    },
+  },
   viewFilter: {
     manyToOne: {
       fieldMetadata: {

packages/twenty-server/src/engine/metadata-modules/flat-entity/constant/all-metadata-required-metadata-for-validation.constant.ts

@@ -27,6 +27,10 @@ export const ALL_METADATA_REQUIRED_METADATA_FOR_VALIDATION = {
     view: true,
     fieldMetadata: true,
     objectMetadata: true,
+    viewFieldGroup: true,
+  },
+  viewFieldGroup: {
+    view: true,
   },
   index: {
     objectMetadata: true,

packages/twenty-server/src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.module.ts

@@ -12,6 +12,7 @@ import { WorkspaceFlatPageLayoutWidgetMapCacheService } from 'src/engine/metadat
 import { WorkspaceFlatPageLayoutMapCacheService } from 'src/engine/metadata-modules/flat-page-layout/services/workspace-flat-page-layout-map-cache.service';
 import { WorkspaceFlatRowLevelPermissionPredicateGroupMapCacheService } from 'src/engine/metadata-modules/flat-row-level-permission-predicate/services/workspace-flat-row-level-permission-predicate-group-map-cache.service';
 import { WorkspaceFlatRowLevelPermissionPredicateMapCacheService } from 'src/engine/metadata-modules/flat-row-level-permission-predicate/services/workspace-flat-row-level-permission-predicate-map-cache.service';
+import { WorkspaceFlatViewFieldGroupMapCacheService } from 'src/engine/metadata-modules/flat-view-field-group/services/workspace-flat-view-field-group-map-cache.service';
 import { WorkspaceFlatViewFieldMapCacheService } from 'src/engine/metadata-modules/flat-view-field/services/workspace-flat-view-field-map-cache.service';
 import { WorkspaceFlatViewFilterGroupMapCacheService } from 'src/engine/metadata-modules/flat-view-filter-group/services/workspace-flat-view-filter-group-map-cache.service';
 import { WorkspaceFlatViewFilterMapCacheService } from 'src/engine/metadata-modules/flat-view-filter/services/workspace-flat-view-filter-map-cache.service';
@@ -26,6 +27,7 @@ import { PageLayoutEntity } from 'src/engine/metadata-modules/page-layout/entiti
 import { RoleEntity } from 'src/engine/metadata-modules/role/role.entity';
 import { RowLevelPermissionPredicateGroupEntity } from 'src/engine/metadata-modules/row-level-permission-predicate/entities/row-level-permission-predicate-group.entity';
 import { RowLevelPermissionPredicateEntity } from 'src/engine/metadata-modules/row-level-permission-predicate/entities/row-level-permission-predicate.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';
@@ -39,6 +41,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
     TypeOrmModule.forFeature([
       ViewEntity,
       ViewFieldEntity,
+      ViewFieldGroupEntity,
       ViewFilterEntity,
       ViewFilterGroupEntity,
       ViewGroupEntity,
@@ -60,6 +63,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
     WorkspaceFlatObjectMetadataMapCacheService,
     WorkspaceFlatViewMapCacheService,
     WorkspaceFlatViewFieldMapCacheService,
+    WorkspaceFlatViewFieldGroupMapCacheService,
     WorkspaceFlatViewFilterMapCacheService,
     WorkspaceFlatViewFilterGroupMapCacheService,
     WorkspaceFlatIndexMapCacheService,
@@ -76,6 +80,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
     WorkspaceFlatObjectMetadataMapCacheService,
     WorkspaceFlatViewMapCacheService,
     WorkspaceFlatViewFieldMapCacheService,
+    WorkspaceFlatViewFieldGroupMapCacheService,
     WorkspaceFlatViewFilterMapCacheService,
     WorkspaceFlatViewFilterGroupMapCacheService,
     WorkspaceFlatIndexMapCacheService,

packages/twenty-server/src/engine/metadata-modules/flat-entity/types/all-flat-entity-types-by-metadata-name.ts

@@ -23,6 +23,8 @@ import { type FlatRoleTarget } from 'src/engine/metadata-modules/flat-role-targe
 import { type FlatRole } from 'src/engine/metadata-modules/flat-role/types/flat-role.type';
 import { type FlatSkillMaps } from 'src/engine/metadata-modules/flat-skill/types/flat-skill-maps.type';
 import { type FlatSkill } from 'src/engine/metadata-modules/flat-skill/types/flat-skill.type';
+import { type FlatViewFieldGroupMaps } from 'src/engine/metadata-modules/flat-view-field-group/types/flat-view-field-group-maps.type';
+import { type FlatViewFieldGroup } from 'src/engine/metadata-modules/flat-view-field-group/types/flat-view-field-group.type';
 import { type FlatViewFieldMaps } from 'src/engine/metadata-modules/flat-view-field/types/flat-view-field-maps.type';
 import { type FlatViewField } from 'src/engine/metadata-modules/flat-view-field/types/flat-view-field.type';
 import { type FlatViewFilterGroupMaps } from 'src/engine/metadata-modules/flat-view-filter-group/types/flat-view-filter-group-maps.type';
@@ -57,6 +59,7 @@ import { type UniversalFlatRoleTarget } from 'src/engine/workspace-manager/works
 import { type UniversalFlatRowLevelPermissionPredicate } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-row-level-permission-predicate.type';
 import { type UniversalFlatRowLevelPermissionPredicateGroup } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-row-level-permission-predicate-group.type';
 import { type UniversalFlatSkill } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-skill.type';
+import { type UniversalFlatViewFieldGroup } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-view-field-group.type';
 import { type UniversalFlatViewField } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-view-field.type';
 import { type UniversalFlatViewFilterGroup } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-view-filter-group.type';
 import { type UniversalFlatViewFilter } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-view-filter.type';
@@ -199,6 +202,14 @@ import {
   type UniversalDeleteViewFieldAction,
   type UniversalUpdateViewFieldAction,
 } from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/builders/view-field/types/workspace-migration-view-field-action.type';
+import {
+  type FlatCreateViewFieldGroupAction,
+  type FlatDeleteViewFieldGroupAction,
+  type FlatUpdateViewFieldGroupAction,
+  type UniversalCreateViewFieldGroupAction,
+  type UniversalDeleteViewFieldGroupAction,
+  type UniversalUpdateViewFieldGroupAction,
+} from 'src/engine/workspace-manager/workspace-migration/workspace-migration-builder/builders/view-field-group/types/workspace-migration-view-field-group-action.type';
 import {
   type FlatCreateViewFilterGroupAction,
   type FlatDeleteViewFilterGroupAction,
@@ -308,6 +319,22 @@ export type AllFlatEntityTypesByMetadataName = {
     universalFlatEntity: UniversalFlatViewField;
     entity: MetadataEntity<'viewField'>;
   };
+  viewFieldGroup: {
+    flatEntityMaps: FlatViewFieldGroupMaps;
+    universalActions: {
+      create: UniversalCreateViewFieldGroupAction;
+      update: UniversalUpdateViewFieldGroupAction;
+      delete: UniversalDeleteViewFieldGroupAction;
+    };
+    flatActions: {
+      create: FlatCreateViewFieldGroupAction;
+      update: FlatUpdateViewFieldGroupAction;
+      delete: FlatDeleteViewFieldGroupAction;
+    };
+    flatEntity: FlatViewFieldGroup;
+    universalFlatEntity: UniversalFlatViewFieldGroup;
+    entity: MetadataEntity<'viewFieldGroup'>;
+  };
   viewGroup: {
     flatEntityMaps: FlatViewGroupMaps;
     universalActions: {

packages/twenty-server/src/engine/metadata-modules/flat-entity/utils/__tests__/__snapshots__/get-metadata-related-metadata-names.util.spec.ts.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`getMetadataRelatedMetadataNames should return related metadata names for agent 1`] = `[]`;
 
@@ -108,6 +108,7 @@ exports[`getMetadataRelatedMetadataNames should return related metadata names fo
   "viewFilter",
   "viewFilterGroup",
   "viewGroup",
+  "viewFieldGroup",
 ]
 `;
 
@@ -115,6 +116,14 @@ exports[`getMetadataRelatedMetadataNames should return related metadata names fo
 [
   "fieldMetadata",
   "view",
+  "viewFieldGroup",
+]
+`;
+
+exports[`getMetadataRelatedMetadataNames should return related metadata names for viewFieldGroup 1`] = `
+[
+  "view",
+  "viewField",
 ]
 `;
 

packages/twenty-server/src/engine/metadata-modules/flat-entity/utils/__tests__/__snapshots__/sort-metadata-names-children-first.util.spec.ts.snap

@@ -4,10 +4,10 @@ exports[`sortMetadataNamesChildrenFirst should return metadata names sorted with
 [
   "rowLevelPermissionPredicate",
   "navigationMenuItem",
+  "viewField",
   "viewFilter",
   "commandMenuItem",
   "pageLayoutWidget",
-  "viewField",
   "index",
   "pageLayout",
   "roleTarget",
@@ -18,9 +18,10 @@ exports[`sortMetadataNamesChildrenFirst should return metadata names sorted with
   "logicFunction",
   "pageLayoutTab",
   "skill",
-  "view",
+  "viewFieldGroup",
   "viewFilterGroup",
   "webhook",
+  "view",
   "fieldMetadata",
   "role",
   "objectMetadata",