Migrate page layout widget to v2 of the API (#16323)

2025-12-05 14:04:06 +01:00
parent 56e66315cd
commit 077be7644c
159 changed files with 1760 additions and 308 deletions
@@ -0,0 +1,97 @@
+import {
+  Body,
+  Controller,
+  Delete,
+  Get,
+  Param,
+  Patch,
+  Post,
+  Query,
+  UseFilters,
+  UseGuards,
+} from '@nestjs/common';
+
+import { isDefined } from 'twenty-shared/utils';
+
+import { CreatePageLayoutTabInput } from 'src/engine/metadata-modules/page-layout/dtos/inputs/create-page-layout-tab.input';
+import { UpdatePageLayoutTabInput } from 'src/engine/metadata-modules/page-layout/dtos/inputs/update-page-layout-tab.input';
+import { type PageLayoutTabDTO } from 'src/engine/metadata-modules/page-layout/dtos/page-layout-tab.dto';
+import {
+  generatePageLayoutTabExceptionMessage,
+  PageLayoutTabException,
+  PageLayoutTabExceptionCode,
+  PageLayoutTabExceptionMessageKey,
+} from 'src/engine/metadata-modules/page-layout/exceptions/page-layout-tab.exception';
+import { PageLayoutTabRestApiExceptionFilter } from 'src/engine/metadata-modules/page-layout/filters/page-layout-tab-rest-api-exception.filter';
+import { PageLayoutTabService } from 'src/engine/metadata-modules/page-layout/services/page-layout-tab.service';
+import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
+import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
+import { NoPermissionGuard } from 'src/engine/guards/no-permission.guard';
+import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.guard';
+import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
+import { PermissionFlagType } from 'src/engine/metadata-modules/permissions/constants/permission-flag-type.constants';
+
+@Controller('rest/metadata/pageLayoutTabs')
+@UseGuards(WorkspaceAuthGuard)
+@UseFilters(PageLayoutTabRestApiExceptionFilter)
+export class PageLayoutTabController {
+  constructor(private readonly pageLayoutTabService: PageLayoutTabService) {}
+
+  @Get()
+  @UseGuards(NoPermissionGuard)
+  async findMany(
+    @AuthWorkspace() workspace: WorkspaceEntity,
+    @Query('pageLayoutId') pageLayoutId: string,
+  ): Promise<PageLayoutTabDTO[]> {
+    if (!isDefined(pageLayoutId)) {
+      throw new PageLayoutTabException(
+        generatePageLayoutTabExceptionMessage(
+          PageLayoutTabExceptionMessageKey.PAGE_LAYOUT_ID_REQUIRED,
+        ),
+        PageLayoutTabExceptionCode.INVALID_PAGE_LAYOUT_TAB_DATA,
+      );
+    }
+
+    return this.pageLayoutTabService.findByPageLayoutId(
+      workspace.id,
+      pageLayoutId,
+    );
+  }
+
+  @Get(':id')
+  @UseGuards(NoPermissionGuard)
+  async findOne(
+    @Param('id') id: string,
+    @AuthWorkspace() workspace: WorkspaceEntity,
+  ): Promise<PageLayoutTabDTO | null> {
+    return this.pageLayoutTabService.findByIdOrThrow(id, workspace.id);
+  }
+
+  @Post()
+  @UseGuards(SettingsPermissionGuard(PermissionFlagType.LAYOUTS))
+  async create(
+    @Body() input: CreatePageLayoutTabInput,
+    @AuthWorkspace() workspace: WorkspaceEntity,
+  ): Promise<PageLayoutTabDTO> {
+    return this.pageLayoutTabService.create(input, workspace.id);
+  }
+
+  @Patch(':id')
+  @UseGuards(SettingsPermissionGuard(PermissionFlagType.LAYOUTS))
+  async update(
+    @Param('id') id: string,
+    @Body() input: UpdatePageLayoutTabInput,
+    @AuthWorkspace() workspace: WorkspaceEntity,
+  ): Promise<PageLayoutTabDTO> {
+    return this.pageLayoutTabService.update(id, workspace.id, input);
+  }
+
+  @Delete(':id')
+  @UseGuards(SettingsPermissionGuard(PermissionFlagType.LAYOUTS))
+  async delete(
+    @Param('id') id: string,
+    @AuthWorkspace() workspace: WorkspaceEntity,
+  ): Promise<PageLayoutTabDTO> {
+    return this.pageLayoutTabService.delete(id, workspace.id);
+  }
+}
@@ -0,0 +1,99 @@
+import {
+  Body,
+  Controller,
+  Delete,
+  Get,
+  Param,
+  Patch,
+  Post,
+  Query,
+  UseFilters,
+  UseGuards,
+} from '@nestjs/common';
+
+import { isDefined } from 'class-validator';
+
+import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
+import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
+import { NoPermissionGuard } from 'src/engine/guards/no-permission.guard';
+import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.guard';
+import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
+import { CreatePageLayoutWidgetInput } from 'src/engine/metadata-modules/page-layout/dtos/inputs/create-page-layout-widget.input';
+import { UpdatePageLayoutWidgetInput } from 'src/engine/metadata-modules/page-layout/dtos/inputs/update-page-layout-widget.input';
+import { type PageLayoutWidgetDTO } from 'src/engine/metadata-modules/page-layout/dtos/page-layout-widget.dto';
+import {
+  generatePageLayoutWidgetExceptionMessage,
+  PageLayoutWidgetException,
+  PageLayoutWidgetExceptionCode,
+  PageLayoutWidgetExceptionMessageKey,
+} from 'src/engine/metadata-modules/page-layout/exceptions/page-layout-widget.exception';
+import { PageLayoutWidgetRestApiExceptionFilter } from 'src/engine/metadata-modules/page-layout/filters/page-layout-widget-rest-api-exception.filter';
+import { PageLayoutWidgetService } from 'src/engine/metadata-modules/page-layout/services/page-layout-widget.service';
+import { PermissionFlagType } from 'src/engine/metadata-modules/permissions/constants/permission-flag-type.constants';
+
+@Controller('rest/metadata/pageLayoutWidgets')
+@UseGuards(WorkspaceAuthGuard)
+@UseFilters(PageLayoutWidgetRestApiExceptionFilter)
+export class PageLayoutWidgetController {
+  constructor(
+    private readonly pageLayoutWidgetService: PageLayoutWidgetService,
+  ) {}
+
+  @Get()
+  @UseGuards(NoPermissionGuard)
+  async findMany(
+    @AuthWorkspace() workspace: WorkspaceEntity,
+    @Query('pageLayoutTabId') pageLayoutTabId: string,
+  ): Promise<PageLayoutWidgetDTO[]> {
+    if (!isDefined(pageLayoutTabId)) {
+      throw new PageLayoutWidgetException(
+        generatePageLayoutWidgetExceptionMessage(
+          PageLayoutWidgetExceptionMessageKey.PAGE_LAYOUT_TAB_ID_REQUIRED,
+        ),
+        PageLayoutWidgetExceptionCode.INVALID_PAGE_LAYOUT_WIDGET_DATA,
+      );
+    }
+
+    return this.pageLayoutWidgetService.findByPageLayoutTabId(
+      workspace.id,
+      pageLayoutTabId,
+    );
+  }
+
+  @Get(':id')
+  @UseGuards(NoPermissionGuard)
+  async findOne(
+    @Param('id') id: string,
+    @AuthWorkspace() workspace: WorkspaceEntity,
+  ): Promise<PageLayoutWidgetDTO | null> {
+    return this.pageLayoutWidgetService.findByIdOrThrow(id, workspace.id);
+  }
+
+  @Post()
+  @UseGuards(SettingsPermissionGuard(PermissionFlagType.LAYOUTS))
+  async create(
+    @Body() input: CreatePageLayoutWidgetInput,
+    @AuthWorkspace() workspace: WorkspaceEntity,
+  ): Promise<PageLayoutWidgetDTO> {
+    return this.pageLayoutWidgetService.create(input, workspace.id);
+  }
+
+  @Patch(':id')
+  @UseGuards(SettingsPermissionGuard(PermissionFlagType.LAYOUTS))
+  async update(
+    @Param('id') id: string,
+    @Body() input: UpdatePageLayoutWidgetInput,
+    @AuthWorkspace() workspace: WorkspaceEntity,
+  ): Promise<PageLayoutWidgetDTO> {
+    return this.pageLayoutWidgetService.update(id, workspace.id, input);
+  }
+
+  @Delete(':id')
+  @UseGuards(SettingsPermissionGuard(PermissionFlagType.LAYOUTS))
+  async delete(
+    @Param('id') id: string,
+    @AuthWorkspace() workspace: WorkspaceEntity,
+  ): Promise<PageLayoutWidgetDTO> {
+    return this.pageLayoutWidgetService.delete(id, workspace.id);
+  }
+}
@@ -0,0 +1,98 @@
+import {
+  Body,
+  Controller,
+  Delete,
+  Get,
+  Param,
+  Patch,
+  Post,
+  Query,
+  UseFilters,
+  UseGuards,
+} from '@nestjs/common';
+
+import { isDefined } from 'twenty-shared/utils';
+
+import { CreatePageLayoutInput } from 'src/engine/metadata-modules/page-layout/dtos/inputs/create-page-layout.input';
+import { UpdatePageLayoutInput } from 'src/engine/metadata-modules/page-layout/dtos/inputs/update-page-layout.input';
+import { type PageLayoutDTO } from 'src/engine/metadata-modules/page-layout/dtos/page-layout.dto';
+import { PageLayoutEntity } from 'src/engine/metadata-modules/page-layout/entities/page-layout.entity';
+import { PageLayoutRestApiExceptionFilter } from 'src/engine/metadata-modules/page-layout/filters/page-layout-rest-api-exception.filter';
+import { PageLayoutService } from 'src/engine/metadata-modules/page-layout/services/page-layout.service';
+import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
+import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
+import { NoPermissionGuard } from 'src/engine/guards/no-permission.guard';
+import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.guard';
+import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
+import { PermissionFlagType } from 'src/engine/metadata-modules/permissions/constants/permission-flag-type.constants';
+
+@Controller('rest/metadata/pageLayouts')
+@UseGuards(WorkspaceAuthGuard)
+@UseFilters(PageLayoutRestApiExceptionFilter)
+export class PageLayoutController {
+  constructor(private readonly pageLayoutService: PageLayoutService) {}
+
+  @Get()
+  @UseGuards(NoPermissionGuard)
+  async findMany(
+    @AuthWorkspace() workspace: WorkspaceEntity,
+    @Query('objectMetadataId') objectMetadataId?: string,
+  ): Promise<PageLayoutDTO[]> {
+    if (isDefined(objectMetadataId)) {
+      return this.pageLayoutService.findByObjectMetadataId(
+        workspace.id,
+        objectMetadataId,
+      );
+    }
+
+    return this.pageLayoutService.findByWorkspaceId(workspace.id);
+  }
+
+  @Get(':id')
+  @UseGuards(NoPermissionGuard)
+  async findOne(
+    @Param('id') id: string,
+    @AuthWorkspace() workspace: WorkspaceEntity,
+  ): Promise<PageLayoutDTO | null> {
+    return this.pageLayoutService.findByIdOrThrow(id, workspace.id);
+  }
+
+  @Post()
+  @UseGuards(SettingsPermissionGuard(PermissionFlagType.LAYOUTS))
+  async create(
+    @Body() input: CreatePageLayoutInput,
+    @AuthWorkspace() workspace: WorkspaceEntity,
+  ): Promise<PageLayoutDTO> {
+    return this.pageLayoutService.create(input, workspace.id);
+  }
+
+  @Patch(':id')
+  @UseGuards(SettingsPermissionGuard(PermissionFlagType.LAYOUTS))
+  async update(
+    @Param('id') id: string,
+    @Body() input: UpdatePageLayoutInput,
+    @AuthWorkspace() workspace: WorkspaceEntity,
+  ): Promise<PageLayoutDTO> {
+    const updatedPageLayout = await this.pageLayoutService.update(
+      id,
+      workspace.id,
+      input,
+    );
+
+    return updatedPageLayout;
+  }
+
+  @Delete(':id')
+  @UseGuards(SettingsPermissionGuard(PermissionFlagType.LAYOUTS))
+  async delete(
+    @Param('id') id: string,
+    @AuthWorkspace() workspace: WorkspaceEntity,
+  ): Promise<PageLayoutEntity> {
+    const deletedPageLayout = await this.pageLayoutService.delete(
+      id,
+      workspace.id,
+    );
+
+    return deletedPageLayout;
+  }
+}