Implement page layout override (#18472)

packages/twenty-server/src/engine/metadata-modules/page-layout-tab/dtos/inputs/update-page-layout-tab-with-widgets.input.ts

@@ -5,6 +5,7 @@ import {
   IsArray,
   IsNotEmpty,
   IsNumber,
+  IsOptional,
   IsString,
   IsUUID,
   ValidateNested,
@@ -29,6 +30,11 @@ export class UpdatePageLayoutTabWithWidgetsInput {
   @IsNotEmpty()
   position: number;
 
+  @Field(() => String, { nullable: true })
+  @IsString()
+  @IsOptional()
+  icon?: string | null;
+
   @Field(() => [UpdatePageLayoutWidgetWithIdInput])
   @IsArray()
   @ValidateNested({ each: true })

packages/twenty-server/src/engine/metadata-modules/page-layout-tab/dtos/inputs/update-page-layout-tab.input.ts

@@ -13,4 +13,9 @@ export class UpdatePageLayoutTabInput {
   @IsNumber()
   @IsOptional()
   position?: number;
+
+  @Field(() => String, { nullable: true })
+  @IsString()
+  @IsOptional()
+  icon?: string | null;
 }

packages/twenty-server/src/engine/metadata-modules/page-layout-tab/dtos/page-layout-tab.dto.ts

@@ -1,9 +1,16 @@
-import { Field, Float, ObjectType, registerEnumType } from '@nestjs/graphql';
+import {
+  Field,
+  Float,
+  HideField,
+  ObjectType,
+  registerEnumType,
+} from '@nestjs/graphql';
 
 import { IDField } from '@ptc-org/nestjs-query-graphql';
 import { PageLayoutTabLayoutMode } from 'twenty-shared/types';
 
 import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
+import { type PageLayoutTabOverrides } from 'src/engine/metadata-modules/page-layout-tab/entities/page-layout-tab.entity';
 import { PageLayoutWidgetDTO } from 'src/engine/metadata-modules/page-layout-widget/dtos/page-layout-widget.dto';
 
 registerEnumType(PageLayoutTabLayoutMode, {
@@ -47,4 +54,10 @@ export class PageLayoutTabDTO {
 
   @Field(() => Date, { nullable: true })
   deletedAt?: Date | null;
+
+  @Field(() => Boolean, { nullable: false })
+  isOverridden: boolean;
+
+  @HideField()
+  overrides?: PageLayoutTabOverrides | null;
 }

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

@@ -17,7 +17,13 @@ import {
 
 import { PageLayoutWidgetEntity } from 'src/engine/metadata-modules/page-layout-widget/entities/page-layout-widget.entity';
 import { PageLayoutEntity } from 'src/engine/metadata-modules/page-layout/entities/page-layout.entity';
-import { SyncableEntity } from 'src/engine/workspace-manager/types/syncable-entity.interface';
+import { OverridableEntity } from 'src/engine/workspace-manager/types/overridable-entity';
+
+export type PageLayoutTabOverrides = {
+  title?: string;
+  position?: number;
+  icon?: string | null;
+};
 
 @Entity({ name: 'pageLayoutTab', schema: 'core' })
 @ObjectType('PageLayoutTab')
@@ -27,7 +33,7 @@ import { SyncableEntity } from 'src/engine/workspace-manager/types/syncable-enti
   { where: '"deletedAt" IS NULL' },
 )
 export class PageLayoutTabEntity
-  extends SyncableEntity
+  extends OverridableEntity<PageLayoutTabOverrides>
   implements Required<PageLayoutTabEntity>
 {
   @PrimaryGeneratedColumn('uuid')

packages/twenty-server/src/engine/metadata-modules/page-layout-tab/resolvers/page-layout-tab.resolver.ts

@@ -7,6 +7,7 @@ import {
 import {
   Args,
   Context,
+  Float,
   Mutation,
   Parent,
   Query,
@@ -30,6 +31,7 @@ import { PageLayoutTabDTO } from 'src/engine/metadata-modules/page-layout-tab/dt
 import { PageLayoutTabService } from 'src/engine/metadata-modules/page-layout-tab/services/page-layout-tab.service';
 import { resolvePageLayoutTabTitle } from 'src/engine/metadata-modules/page-layout-tab/utils/resolve-page-layout-tab-title.util';
 import { PageLayoutGraphqlApiExceptionFilter } from 'src/engine/metadata-modules/page-layout/utils/page-layout-graphql-api-exception.filter';
+import { resolveOverridableEntityProperty } from 'src/engine/metadata-modules/utils/resolve-overridable-entity-property.util';
 import { WorkspaceMigrationGraphqlApiExceptionInterceptor } from 'src/engine/workspace-manager/workspace-migration/interceptors/workspace-migration-graphql-api-exception.interceptor';
 
 @MetadataResolver(() => PageLayoutTabDTO)
@@ -48,15 +50,26 @@ export class PageLayoutTabResolver {
     @Parent() tab: PageLayoutTabDTO,
     @Context() context: I18nContext,
   ): Promise<string> {
+    const resolvedTitle = resolveOverridableEntityProperty(tab, 'title');
     const i18n = this.i18nService.getI18nInstance(context.req.locale);
 
     return resolvePageLayoutTabTitle({
-      title: tab.title,
+      title: resolvedTitle,
       applicationId: tab.applicationId,
       i18nInstance: i18n,
     });
   }
 
+  @ResolveField(() => Float)
+  position(@Parent() tab: PageLayoutTabDTO): number {
+    return resolveOverridableEntityProperty(tab, 'position');
+  }
+
+  @ResolveField(() => String, { nullable: true })
+  icon(@Parent() tab: PageLayoutTabDTO): string | null | undefined {
+    return resolveOverridableEntityProperty(tab, 'icon');
+  }
+
   @Query(() => [PageLayoutTabDTO])
   @UseGuards(NoPermissionGuard)
   async getPageLayoutTabs(

packages/twenty-server/src/engine/metadata-modules/page-layout-tab/services/page-layout-tab.service.ts

@@ -233,6 +233,10 @@ export class PageLayoutTabService {
       fromUpdatePageLayoutTabInputToFlatPageLayoutTabToUpdateOrThrow({
         updatePageLayoutTabInput,
         flatPageLayoutTabMaps: existingFlatPageLayoutTabMaps,
+        callerApplicationUniversalIdentifier:
+          workspaceCustomFlatApplication.universalIdentifier,
+        workspaceCustomApplicationUniversalIdentifier:
+          workspaceCustomFlatApplication.universalIdentifier,
       });
 
     const validateAndBuildResult =

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

@@ -1,3 +1,5 @@
+import { isDefined } from 'twenty-shared/utils';
+
 import { type FlatPageLayoutTab } from 'src/engine/metadata-modules/flat-page-layout-tab/types/flat-page-layout-tab.type';
 import { type PageLayoutTabDTO } from 'src/engine/metadata-modules/page-layout-tab/dtos/page-layout-tab.dto';
 
@@ -14,6 +16,8 @@ export const fromFlatPageLayoutTabToPageLayoutTabDto = (
 
   return {
     ...rest,
+    isOverridden:
+      isDefined(rest.overrides) && Object.keys(rest.overrides).length > 0,
     createdAt: new Date(createdAt),
     updatedAt: new Date(updatedAt),
     deletedAt: deletedAt ? new Date(deletedAt) : null,