Skip to content

The open alternative to Salesforce, designed for AI.

9.9 KB
Raw Blame
import {
  Body,
  Controller,
  Delete,
  Get,
  Param,
  ParseUUIDPipe,
  Patch,
  Post,
  Put,
  Req,
  UseFilters,
  UseGuards,
  UsePipes,
  ValidationPipe,
} from '@nestjs/common';
import { ApiPath, FeatureFlagKey } from 'twenty-shared/types';

import { type RestCursorPageInfo } from 'src/engine/api/rest/metadata/types/rest-cursor-page-info.type';
import { paginateByIdCursor } from 'src/engine/api/rest/metadata/utils/paginate-by-id-cursor.util';
import { type AuthenticatedRequest } from 'src/engine/api/rest/types/authenticated-request.type';
import { ApplicationRestApiExceptionFilter } from 'src/engine/core-modules/application/application-rest-api-exception.filter';
import { FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
import { JwtAuthGuard } from 'src/engine/guards/jwt-auth.guard';
import { DerivedFieldMetadataIdsService } from 'src/engine/metadata-modules/derived-field-metadata-ids/services/derived-field-metadata-ids.service';
import { type DerivedFieldMetadataIds } from 'src/engine/metadata-modules/derived-field-metadata-ids/types/derived-field-metadata-ids.type';
import { CreateFieldInput } from 'src/engine/metadata-modules/field-metadata/dtos/create-field.input';
import { type FieldMetadataDTO } from 'src/engine/metadata-modules/field-metadata/dtos/field-metadata.dto';
import { UpdateFieldInput } from 'src/engine/metadata-modules/field-metadata/dtos/update-field.input';
import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import {
  FieldMetadataException,
  FieldMetadataExceptionCode,
} from 'src/engine/metadata-modules/field-metadata/field-metadata.exception';
import { FieldMetadataRestApiExceptionFilter } from 'src/engine/metadata-modules/field-metadata/filters/field-metadata-rest-api-exception.filter';
import { FieldMetadataService } from 'src/engine/metadata-modules/field-metadata/services/field-metadata.service';
import { fromFieldMetadataEntityToFieldMetadataDto } from 'src/engine/metadata-modules/field-metadata/utils/from-field-metadata-entity-to-field-metadata-dto.util';
import { ApplicationTranslationCatalogService } from 'src/engine/metadata-modules/application-translation-catalog/services/application-translation-catalog.service';
import { RequestLocale } from 'src/engine/decorators/locale/request-locale.decorator';
import { type APP_LOCALES } from 'twenty-shared/translations';
import {
  toLegacyFieldMetadataCreateResponse,
  toLegacyFieldMetadataDeleteResponse,
  toLegacyFieldMetadataFindOneResponse,
  toLegacyFieldMetadataListResponse,
  toLegacyFieldMetadataUpdateResponse,
} from 'src/engine/metadata-modules/field-metadata/utils/to-legacy-field-metadata-response.util';
import { FlatEntityMapsRestApiExceptionFilter } from 'src/engine/metadata-modules/flat-entity/filters/flat-entity-maps-rest-api-exception.filter';
import { fromFlatFieldMetadataToFieldMetadataDto } from 'src/engine/metadata-modules/flat-field-metadata/utils/from-flat-field-metadata-to-field-metadata-dto.util';
import { PermissionsRestApiExceptionFilter } from 'src/engine/permissions/utils/permissions-rest-api-exception.filter';
import { AuthRestApiExceptionFilter } from 'src/engine/core-modules/auth/filters/auth-rest-api-exception.filter';
import { InjectWorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/inject-workspace-scoped-repository.decorator';
import { WorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/workspace-scoped-repository';
import { FIELD_METADATA_READ_ACCESS_POLICY } from 'src/engine/metadata-modules/field-metadata/constants/field-metadata-read-access-policy.constant';
import { FIELD_METADATA_WRITE_ACCESS_POLICY } from 'src/engine/metadata-modules/field-metadata/constants/field-metadata-write-access-policy.constant';
import { AccessPolicyGuard } from 'src/engine/guards/access-policy.guard';

@Controller(`${ApiPath.Rest}/metadata/fields`)
@UseGuards(JwtAuthGuard)
@UseFilters(
  PermissionsRestApiExceptionFilter,
  FieldMetadataRestApiExceptionFilter,
  ApplicationRestApiExceptionFilter,
  FlatEntityMapsRestApiExceptionFilter,
  AuthRestApiExceptionFilter,
)
@UsePipes(new ValidationPipe())
export class FieldMetadataController {
  constructor(
    @InjectWorkspaceScopedRepository(FieldMetadataEntity)
    private readonly fieldMetadataRepository: WorkspaceScopedRepository<FieldMetadataEntity>,
    private readonly fieldMetadataService: FieldMetadataService,
    private readonly featureFlagService: FeatureFlagService,
    private readonly derivedFieldMetadataIdsService: DerivedFieldMetadataIdsService,
    private readonly applicationTranslationCatalogService: ApplicationTranslationCatalogService,
  ) {}

  // same locale-resolved labels as the GraphQL read path
  private async toPresentedFieldDtos({
    fields,
    derivedFieldMetadataIds,
    locale,
    workspaceId,
  }: {
    fields: FieldMetadataEntity[];
    derivedFieldMetadataIds: DerivedFieldMetadataIds;
    locale: keyof typeof APP_LOCALES | undefined;
    workspaceId: string;
  }): Promise<FieldMetadataDTO[]> {
    const resolvedFields =
      await this.applicationTranslationCatalogService.resolveTranslatablePropertiesForEntities(
        {
          metadataName: 'fieldMetadata',
          entities: fields,
          locale,
          workspaceId,
        },
      );

    return resolvedFields.map((field) =>
      fromFieldMetadataEntityToFieldMetadataDto(field, derivedFieldMetadataIds),
    );
  }

  @Get()
  @UseGuards(AccessPolicyGuard(FIELD_METADATA_READ_ACCESS_POLICY))
  async findMany(
    @Req() request: AuthenticatedRequest,
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
    @RequestLocale() locale: keyof typeof APP_LOCALES | undefined,
  ) {
    const { items, pageInfo, totalCount } = await paginateByIdCursor({
      repository: this.fieldMetadataRepository,
      workspaceId,
      request,
    });

    const derivedFieldMetadataIds =
      await this.derivedFieldMetadataIdsService.getForWorkspace(workspaceId);

    const result: {
      data: FieldMetadataDTO[];
      pageInfo: RestCursorPageInfo;
      totalCount: number;
    } = {
      data: await this.toPresentedFieldDtos({
        fields: items,
        derivedFieldMetadataIds,
        locale,
        workspaceId,
      }),
      pageInfo,
      totalCount,
    };

    return (await this.isNewMetadataFormat(workspaceId))
      ? result
      : toLegacyFieldMetadataListResponse(result);
  }

  @Get(':id')
  @UseGuards(AccessPolicyGuard(FIELD_METADATA_READ_ACCESS_POLICY))
  async findOne(
    @Param('id', new ParseUUIDPipe()) id: string,
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
    @RequestLocale() locale: keyof typeof APP_LOCALES | undefined,
  ) {
    const field = await this.fieldMetadataRepository.findOne(workspaceId, {
      where: { id },
    });

    if (!field) {
      throw new FieldMetadataException(
        'Field metadata not found',
        FieldMetadataExceptionCode.FIELD_METADATA_NOT_FOUND,
      );
    }

    const derivedFieldMetadataIds =
      await this.derivedFieldMetadataIdsService.getForWorkspace(workspaceId);
    const [result] = await this.toPresentedFieldDtos({
      fields: [field],
      derivedFieldMetadataIds,
      locale,
      workspaceId,
    });

    return (await this.isNewMetadataFormat(workspaceId))
      ? result
      : toLegacyFieldMetadataFindOneResponse(result);
  }

  @Post()
  @UseGuards(AccessPolicyGuard(FIELD_METADATA_WRITE_ACCESS_POLICY))
  async createOne(
    @Body() input: CreateFieldInput,
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
  ) {
    const flatField = await this.fieldMetadataService.createOneField({
      createFieldInput: input,
      workspaceId,
    });

    const result = fromFlatFieldMetadataToFieldMetadataDto(flatField);

    return (await this.isNewMetadataFormat(workspaceId))
      ? result
      : toLegacyFieldMetadataCreateResponse(result);
  }

  @Patch(':id')
  @UseGuards(AccessPolicyGuard(FIELD_METADATA_WRITE_ACCESS_POLICY))
  async updateOnePatch(
    @Param('id', new ParseUUIDPipe()) id: string,
    @Body() update: UpdateFieldInput,
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
  ) {
    return this.handleUpdate({ id, update, workspaceId });
  }

  @Put(':id')
  @UseGuards(AccessPolicyGuard(FIELD_METADATA_WRITE_ACCESS_POLICY))
  async updateOnePut(
    @Param('id', new ParseUUIDPipe()) id: string,
    @Body() update: UpdateFieldInput,
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
  ) {
    return this.handleUpdate({ id, update, workspaceId });
  }

  @Delete(':id')
  @UseGuards(AccessPolicyGuard(FIELD_METADATA_WRITE_ACCESS_POLICY))
  async deleteOne(
    @Param('id', new ParseUUIDPipe()) id: string,
    @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
  ) {
    const flatField = await this.fieldMetadataService.deleteOneField({
      deleteOneFieldInput: { id },
      workspaceId,
    });

    const result = fromFlatFieldMetadataToFieldMetadataDto(flatField);

    return (await this.isNewMetadataFormat(workspaceId))
      ? result
      : toLegacyFieldMetadataDeleteResponse(result);
  }

  private async handleUpdate({
    id,
    update,
    workspaceId,
  }: {
    id: string;
    update: UpdateFieldInput;
    workspaceId: string;
  }) {
    const flatField = await this.fieldMetadataService.updateOneField({
      updateFieldInput: { ...update, id },
      workspaceId,
    });

    const result = fromFlatFieldMetadataToFieldMetadataDto(flatField);

    return (await this.isNewMetadataFormat(workspaceId))
      ? result
      : toLegacyFieldMetadataUpdateResponse(result);
  }

  private async isNewMetadataFormat(workspaceId: string): Promise<boolean> {
    return this.featureFlagService.isFeatureEnabled(
      FeatureFlagKey.IS_REST_METADATA_API_NEW_FORMAT_DIRECT,
      workspaceId,
    );
  }
}