twenty/packages/twenty-server/src/engine/metadata-modules/utils/validate-field-name-availability.utils.ts

import { compositeTypeDefinitions } from 'src/engine/metadata-modules/field-metadata/composite-types';
import { computeCompositeColumnName } from 'src/engine/metadata-modules/field-metadata/utils/compute-column-name.util';
import { isCompositeFieldMetadataType } from 'src/engine/metadata-modules/field-metadata/utils/is-composite-field-metadata-type.util';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { NameNotAvailableException } from 'src/engine/metadata-modules/utils/exceptions/name-not-available.exception';

const getReservedCompositeFieldNames = (
  objectMetadata: ObjectMetadataEntity,
) => {
  const reservedCompositeFieldsNames: string[] = [];

  for (const field of objectMetadata.fields) {
    if (isCompositeFieldMetadataType(field.type)) {
      const base = field.name;
      const compositeType = compositeTypeDefinitions.get(field.type);

      compositeType?.properties.map((property) =>
        reservedCompositeFieldsNames.push(
          computeCompositeColumnName(base, property),
        ),
      );
    }
  }

  return reservedCompositeFieldsNames;
};

export const validateFieldNameAvailabilityOrThrow = (
  name: string,
  objectMetadata: ObjectMetadataEntity,
) => {
  const reservedCompositeFieldsNames =
    getReservedCompositeFieldNames(objectMetadata);

  if (objectMetadata.fields.some((field) => field.name === name)) {
    throw new NameNotAvailableException(name);
  }

  if (reservedCompositeFieldsNames.includes(name)) {
    throw new NameNotAvailableException(name);
  }
};