Implement page layout override (#18472)

packages/twenty-server/src/engine/metadata-modules/flat-page-layout-tab/constants/flat-page-layout-tab-editable-properties.constant.ts

@@ -3,4 +3,5 @@ import { type MetadataEntityPropertyName } from 'src/engine/metadata-modules/fla
 export const FLAT_PAGE_LAYOUT_TAB_EDITABLE_PROPERTIES = [
   'title',
   'position',
+  'icon',
 ] as const satisfies MetadataEntityPropertyName<'pageLayoutTab'>[];

packages/twenty-server/src/engine/metadata-modules/flat-page-layout-tab/utils/from-create-page-layout-tab-input-to-flat-page-layout-tab-to-create.util.ts

@@ -57,5 +57,6 @@ export const fromCreatePageLayoutTabInputToFlatPageLayoutTabToCreate = ({
     widgetUniversalIdentifiers: [],
     icon: null,
     layoutMode: PageLayoutTabLayoutMode.GRID,
+    overrides: null,
   };
 };

packages/twenty-server/src/engine/metadata-modules/flat-page-layout-tab/utils/from-update-page-layout-tab-input-to-flat-page-layout-tab-to-update-or-throw.util.ts

@@ -13,6 +13,8 @@ import {
   PageLayoutTabException,
   PageLayoutTabExceptionCode,
 } from 'src/engine/metadata-modules/page-layout-tab/exceptions/page-layout-tab.exception';
+import { isCallerOverridingEntity } from 'src/engine/metadata-modules/utils/is-caller-overriding-entity.util';
+import { sanitizeOverridableEntityInput } from 'src/engine/metadata-modules/utils/sanitize-overridable-entity-input.util';
 import { mergeUpdateInExistingRecord } from 'src/utils/merge-update-in-existing-record.util';
 
 export type UpdatePageLayoutTabInputWithId = {
@@ -23,9 +25,13 @@ export type UpdatePageLayoutTabInputWithId = {
 export const fromUpdatePageLayoutTabInputToFlatPageLayoutTabToUpdateOrThrow = ({
   updatePageLayoutTabInput: rawUpdatePageLayoutTabInput,
   flatPageLayoutTabMaps,
+  callerApplicationUniversalIdentifier,
+  workspaceCustomApplicationUniversalIdentifier,
 }: {
   updatePageLayoutTabInput: UpdatePageLayoutTabInputWithId;
   flatPageLayoutTabMaps: FlatPageLayoutTabMaps;
+  callerApplicationUniversalIdentifier: string;
+  workspaceCustomApplicationUniversalIdentifier: string;
 }): FlatPageLayoutTab => {
   const { id: pageLayoutTabToUpdateId } = extractAndSanitizeObjectStringFields(
     rawUpdatePageLayoutTabInput,
@@ -44,14 +50,32 @@ export const fromUpdatePageLayoutTabInputToFlatPageLayoutTabToUpdateOrThrow = ({
     );
   }
 
-  const updatedEditableFieldProperties = extractAndSanitizeObjectStringFields(
+  const editableProperties = extractAndSanitizeObjectStringFields(
     rawUpdatePageLayoutTabInput.update,
     FLAT_PAGE_LAYOUT_TAB_EDITABLE_PROPERTIES,
   );
 
-  return mergeUpdateInExistingRecord({
-    existing: existingFlatPageLayoutTabToUpdate,
-    properties: [...FLAT_PAGE_LAYOUT_TAB_EDITABLE_PROPERTIES],
-    update: updatedEditableFieldProperties,
+  const shouldOverride = isCallerOverridingEntity({
+    callerApplicationUniversalIdentifier,
+    entityApplicationUniversalIdentifier:
+      existingFlatPageLayoutTabToUpdate.applicationUniversalIdentifier,
+    workspaceCustomApplicationUniversalIdentifier,
   });
+
+  const { overrides, updatedEditableProperties } =
+    sanitizeOverridableEntityInput({
+      metadataName: 'pageLayoutTab',
+      existingFlatEntity: existingFlatPageLayoutTabToUpdate,
+      updatedEditableProperties: editableProperties,
+      shouldOverride,
+    });
+
+  return {
+    ...mergeUpdateInExistingRecord({
+      existing: existingFlatPageLayoutTabToUpdate,
+      properties: [...FLAT_PAGE_LAYOUT_TAB_EDITABLE_PROPERTIES],
+      update: updatedEditableProperties,
+    }),
+    overrides,
+  } as FlatPageLayoutTab;
 };

packages/twenty-server/src/engine/metadata-modules/flat-page-layout-tab/utils/transform-page-layout-tab-entity-to-flat-page-layout-tab.util.ts

@@ -53,5 +53,6 @@ export const transformPageLayoutTabEntityToFlatPageLayoutTab = ({
     widgetUniversalIdentifiers: pageLayoutTabEntity.widgets.map(
       (widget) => widget.universalIdentifier,
     ),
+    overrides: pageLayoutTabEntity.overrides ?? null,
   };
 };