Skip to content

The open alternative to Salesforce, designed for AI.

Validate select option colors (#25805)

Raphaël Bosi96cc438837ef
diff --git a/packages/twenty-docs/developers/extend/apps/data/extending-objects.mdx b/packages/twenty-docs/developers/extend/apps/data/extending-objects.mdx
index 86fb77ece76..8a6b6d1334f 100644
--- a/packages/twenty-docs/developers/extend/apps/data/extending-objects.mdx
+++ b/packages/twenty-docs/developers/extend/apps/data/extending-objects.mdx
@@ -39,6 +39,7 @@ export default defineField({
- When defining fields **inline inside `defineObject()`**, you do **not** need `objectUniversalIdentifier` — it's inherited from the parent object.
- `defineField()` is the only way to add fields to objects you didn't create with `defineObject()`.
+- `SELECT` and `MULTI_SELECT` follow the same [option validation and color rules](/developers/extend/apps/data/objects#select-options) as inline fields. An omitted or null color defaults to `gray`; unsupported colors are rejected.
- File location is up to you. The convention is `src/fields/<name>.field.ts`, but the SDK detects fields anywhere in `src/`.
- `writability` can also be set per field: `MetadataWritability.APPLICATION` restricts writes to your app's own logic functions, `MetadataWritability.SYSTEM` is reserved for platform-managed data. A field's writability can only be stricter than its object's level, and reads are unaffected. See [Objects](/developers/extend/apps/data/objects) for the full semantics.
- `isSearchable: true` can be set on `defineField()` with the same constraints as inline fields (searchable target object, text-compatible field type), so records of the target object become findable through your field's values in full-text search.
diff --git a/packages/twenty-docs/developers/extend/apps/data/objects.mdx b/packages/twenty-docs/developers/extend/apps/data/objects.mdx
index 57c30e05afa..68721b3b073 100644
--- a/packages/twenty-docs/developers/extend/apps/data/objects.mdx
+++ b/packages/twenty-docs/developers/extend/apps/data/objects.mdx
@@ -110,6 +110,14 @@ The full set of `FieldType` values, exported from `twenty-sdk/define`:
Composite types store multiple sub-fields (e.g. `FULL_NAME` = first + last name; `CURRENCY` = `amountMicros` + `currencyCode`). `SELECT` and `MULTI_SELECT` require an `options` array as in the example above.
+### Select options
+
+For `SELECT` and `MULTI_SELECT`, provide a non-empty `options` array of objects. Each option has a `value`, `label`, and `position`. Its `color` is optional and defaults to `gray` when omitted or null.
+
+When provided, `color` must be one of: `red`, `ruby`, `crimson`, `tomato`, `orange`, `amber`, `yellow`, `lime`, `grass`, `green`, `jade`, `mint`, `turquoise`, `cyan`, `sky`, `blue`, `iris`, `violet`, `purple`, `plum`, `pink`, `bronze`, `gold`, `brown`, `gray`.
+
+Both `defineObject()` and `defineField()` return validation errors for unsupported colors or option entries that are null, primitives, or arrays.
+
## Default values
Literal string defaults must be wrapped in single quotes **inside** the string — `defaultValue: "'Draft'"`, not `defaultValue: "Draft"`. That's why the `status` field above uses `` `'${PostCardStatus.DRAFT}'` ``.
diff --git a/packages/twenty-front/src/modules/settings/data-model/fields/forms/select/hooks/useSelectSettingsFormInitialValues.ts b/packages/twenty-front/src/modules/settings/data-model/fields/forms/select/hooks/useSelectSettingsFormInitialValues.ts
index 905d1924b28..fc2bee9d2da 100644
--- a/packages/twenty-front/src/modules/settings/data-model/fields/forms/select/hooks/useSelectSettingsFormInitialValues.ts
+++ b/packages/twenty-front/src/modules/settings/data-model/fields/forms/select/hooks/useSelectSettingsFormInitialValues.ts
@@ -1,11 +1,13 @@
import { t } from '@lingui/core/macro';
import { useMemo } from 'react';
import { useFormContext } from 'react-hook-form';
+import { isNonEmptyArray } from 'twenty-shared/utils';
import { v4 } from 'uuid';
import { useFieldMetadataItemById } from '@/object-metadata/hooks/useFieldMetadataItemById';
import { type FieldMetadataItemOption } from '@/object-metadata/types/FieldMetadataItem';
import { type SettingsDataModelFieldSelectFormValues } from '@/settings/data-model/fields/forms/select/components/SettingsDataModelFieldSelectForm';
+import { normalizeSelectOptions } from '@/settings/data-model/fields/forms/select/utils/normalizeSelectOptions';
import { computeOptionValueFromLabel } from '~/pages/settings/data-model/utils/computeOptionValueFromLabel';
const getDefaultOption = (): FieldMetadataItemOption => {
@@ -33,10 +35,8 @@ export const useSelectSettingsFormInitialValues = ({
null;
const initialOptions = useMemo(
() =>
- fieldMetadataItem?.options?.length
- ? [...fieldMetadataItem.options].sort(
- (optionA, optionB) => optionA.position - optionB.position,
- )
+ isNonEmptyArray(fieldMetadataItem?.options)
+ ? normalizeSelectOptions(fieldMetadataItem.options)
: [getDefaultOption()],
[fieldMetadataItem?.options],
);
diff --git a/packages/twenty-front/src/modules/settings/data-model/fields/forms/select/utils/__tests__/normalizeSelectOptions.test.ts b/packages/twenty-front/src/modules/settings/data-model/fields/forms/select/utils/__tests__/normalizeSelectOptions.test.ts
new file mode 100644
index 00000000000..1525de28c69
--- /dev/null
+++ b/packages/twenty-front/src/modules/settings/data-model/fields/forms/select/utils/__tests__/normalizeSelectOptions.test.ts
@@ -0,0 +1,66 @@
+import { selectOptionsSchema } from '@/object-metadata/validation-schemas/selectOptionsSchema';
+import { normalizeSelectOptions } from '@/settings/data-model/fields/forms/select/utils/normalizeSelectOptions';
+
+describe('normalizeSelectOptions', () => {
+ it.each([
+ { description: 'missing', colorProperties: {} },
+ { description: 'null', colorProperties: { color: null } },
+ { description: 'invalid', colorProperties: { color: 'unsupported-color' } },
+ ])(
+ 'allows editing an option when other options have $description colors',
+ ({ colorProperties }) => {
+ const options = [
+ {
+ id: 'first',
+ label: 'First category',
+ value: 'FIRST_CATEGORY',
+ position: 0,
+ ...colorProperties,
+ },
+ {
+ id: 'second',
+ label: 'Second category',
+ value: 'SECOND_CATEGORY',
+ position: 1,
+ ...colorProperties,
+ },
+ ];
+
+ const normalizedOptions = normalizeSelectOptions(options);
+ const editedOptions = normalizedOptions.map((option, index) =>
+ index === 0
+ ? { ...option, label: 'Updated category', color: 'blue' }
+ : option,
+ );
+
+ expect(normalizedOptions).toEqual(
+ options.map((option) => ({ ...option, color: 'gray' })),
+ );
+ expect(selectOptionsSchema.parse(editedOptions)).toEqual(editedOptions);
+ },
+ );
+
+ it('preserves existing colors and metadata while sorting without changing the input', () => {
+ const firstOption = {
+ id: 'first',
+ label: 'First category',
+ value: 'CUSTOM_FIRST_VALUE',
+ position: 0,
+ color: 'blue',
+ };
+ const secondOption = {
+ id: 'second',
+ label: 'Second category',
+ value: 'SECOND_CATEGORY',
+ position: 1,
+ color: 'green',
+ };
+ const options = [secondOption, firstOption];
+
+ expect(normalizeSelectOptions(options)).toEqual([
+ firstOption,
+ secondOption,
+ ]);
+ expect(options).toEqual([secondOption, firstOption]);
+ });
+});
diff --git a/packages/twenty-front/src/modules/settings/data-model/fields/forms/select/utils/normalizeSelectOptions.ts b/packages/twenty-front/src/modules/settings/data-model/fields/forms/select/utils/normalizeSelectOptions.ts
new file mode 100644
index 00000000000..d93a5a77858
--- /dev/null
+++ b/packages/twenty-front/src/modules/settings/data-model/fields/forms/select/utils/normalizeSelectOptions.ts
@@ -0,0 +1,19 @@
+import { type FieldMetadataItemOption } from '@/object-metadata/types/FieldMetadataItem';
+import { DEFAULT_SELECT_OPTION_COLOR } from 'twenty-shared/constants';
+import { isTagColor } from 'twenty-shared/utils';
+
+type SelectOptionWithOptionalColor = Omit<FieldMetadataItemOption, 'color'> & {
+ color?: string | null;
+};
+
+export const normalizeSelectOptions = (
+ options: readonly SelectOptionWithOptionalColor[],
+): FieldMetadataItemOption[] =>
+ options
+ .map((option) => ({
+ ...option,
+ color: isTagColor(option.color)
+ ? option.color
+ : DEFAULT_SELECT_OPTION_COLOR,
+ }))
+ .sort((optionA, optionB) => optionA.position - optionB.position);
diff --git a/packages/twenty-front/src/modules/ui/theme/utils/__tests__/selectOptionColors.test.ts b/packages/twenty-front/src/modules/ui/theme/utils/__tests__/selectOptionColors.test.ts
new file mode 100644
index 00000000000..2c3d7ef9d92
--- /dev/null
+++ b/packages/twenty-front/src/modules/ui/theme/utils/__tests__/selectOptionColors.test.ts
@@ -0,0 +1,8 @@
+import { TAG_COLORS } from 'twenty-shared/constants';
+import { MAIN_COLOR_NAMES } from 'twenty-ui/theme';
+
+describe('select option theme colors', () => {
+ it('offers the same colors in the picker as the backend accepts', () => {
+ expect(new Set(MAIN_COLOR_NAMES)).toEqual(new Set(TAG_COLORS));
+ });
+});
diff --git a/packages/twenty-sdk/src/sdk/define/fields/__tests__/define-field.spec.ts b/packages/twenty-sdk/src/sdk/define/fields/__tests__/define-field.spec.ts
index 7d0f04b5d3f..ec44db7eda1 100644
--- a/packages/twenty-sdk/src/sdk/define/fields/__tests__/define-field.spec.ts
+++ b/packages/twenty-sdk/src/sdk/define/fields/__tests__/define-field.spec.ts
@@ -74,6 +74,55 @@ describe('defineField', () => {
});
describe('fields validation', () => {
+ describe.each([
+ { type: FieldMetadataType.SELECT },
+ { type: FieldMetadataType.MULTI_SELECT },
+ ] as const)('$type option validation', (fieldType) => {
+ it.each([
+ { description: 'missing', colorProperties: {} },
+ { description: 'null', colorProperties: { color: null } },
+ ])('accepts $description colors', ({ colorProperties }) => {
+ const config: FieldManifest = {
+ objectUniversalIdentifier: validConfig.objectUniversalIdentifier,
+ universalIdentifier: validConfig.universalIdentifier,
+ name: validConfig.name,
+ label: validConfig.label,
+ ...fieldType,
+ options: [
+ {
+ value: 'OPEN',
+ label: 'Open',
+ position: 0,
+ ...colorProperties,
+ },
+ ],
+ };
+
+ expect(defineField(config).success).toBe(true);
+ });
+
+ it.each(['[null]', '["invalid"]', '[42]', '[false]', '[[]]'])(
+ 'returns a validation error for malformed option data %s',
+ (serializedOptions) => {
+ const config: FieldManifest = {
+ objectUniversalIdentifier: validConfig.objectUniversalIdentifier,
+ universalIdentifier: validConfig.universalIdentifier,
+ name: validConfig.name,
+ label: validConfig.label,
+ ...fieldType,
+ options: JSON.parse(serializedOptions),
+ };
+
+ const result = defineField(config);
+
+ expect(result.success).toBe(false);
+ expect(result.errors).toEqual([
+ 'Field "Custom Note" option at index 0 must be an object',
+ ]);
+ },
+ );
+ });
+
it('should return error when field is missing label', () => {
const config = {
objectUniversalIdentifier: '20202020-b374-4779-a561-80086cb2e17f',
@@ -176,6 +225,29 @@ describe('defineField', () => {
);
});
+ it('should return error when a SELECT option has an unsupported color', () => {
+ const config = {
+ objectUniversalIdentifier: '20202020-b374-4779-a561-80086cb2e17f',
+ universalIdentifier: '550e8400-e29b-41d4-a716-446655440001',
+ type: FieldMetadataType.SELECT,
+ name: 'status',
+ label: 'Status',
+ options: [
+ { value: 'OPEN', label: 'Open', color: 'green', position: 0 },
+ { value: 'CLOSED', label: 'Closed', color: 'grey', position: 1 },
+ ],
+ };
+
+ const result = defineField(config as any);
+
+ expect(result.success).toBe(false);
+ expect(result.errors).toEqual([
+ expect.stringContaining(
+ 'Field "Status" option "Closed" has an unsupported color',
+ ),
+ ]);
+ });
+
it('should accept isUnique on a TEXT field', () => {
const config: FieldManifest = {
...validConfig,
diff --git a/packages/twenty-sdk/src/sdk/define/fields/validate-fields.ts b/packages/twenty-sdk/src/sdk/define/fields/validate-fields.ts
index 16a50b6ea04..084156a6b80 100644
--- a/packages/twenty-sdk/src/sdk/define/fields/validate-fields.ts
+++ b/packages/twenty-sdk/src/sdk/define/fields/validate-fields.ts
@@ -3,6 +3,35 @@ import { FieldMetadataType } from 'twenty-shared/types';
import { isNonEmptyString } from '@sniptt/guards';
import { type ObjectFieldManifest } from 'twenty-shared/application';
+import { TAG_COLORS } from 'twenty-shared/constants';
+import {
+ isDefined,
+ isFieldMetadataSelectKind,
+ isPlainObject,
+ isTagColor,
+} from 'twenty-shared/utils';
+
+const getSelectOptionErrors = (field: ObjectFieldManifest): string[] => {
+ if (!isFieldMetadataSelectKind(field.type) || !Array.isArray(field.options)) {
+ return [];
+ }
+
+ return field.options.flatMap((option, index) => {
+ if (!isPlainObject(option)) {
+ return [
+ `Field "${field.label}" option at index ${index} must be an object`,
+ ];
+ }
+
+ if (!isDefined(option.color) || isTagColor(option.color)) {
+ return [];
+ }
+
+ return [
+ `Field "${field.label}" option "${option.label}" has an unsupported color. Supported colors: ${TAG_COLORS.join(', ')}`,
+ ];
+ });
+};
export const validateFields = (
fields: ObjectFieldManifest[] | undefined,
@@ -36,6 +65,8 @@ export const validateFields = (
);
}
+ errors.push(...getSelectOptionErrors(field));
+
if (
field.isUnique === true &&
(field.type === FieldMetadataType.RELATION ||
diff --git a/packages/twenty-sdk/src/sdk/define/objects/__tests__/define-object.spec.ts b/packages/twenty-sdk/src/sdk/define/objects/__tests__/define-object.spec.ts
index 89d04c80f34..3ff24852770 100644
--- a/packages/twenty-sdk/src/sdk/define/objects/__tests__/define-object.spec.ts
+++ b/packages/twenty-sdk/src/sdk/define/objects/__tests__/define-object.spec.ts
@@ -113,6 +113,60 @@ describe('defineObject', () => {
expect(result.config.fields).toEqual([]);
});
+ it('returns a validation error for malformed options in an object field', () => {
+ const config: ObjectManifest = {
+ ...validConfig,
+ fields: [
+ {
+ universalIdentifier: '58a0a314-d7ea-4865-9850-7fb84e72f30b',
+ type: FieldMetadataType.SELECT,
+ name: 'status',
+ label: 'Status',
+ options: JSON.parse('[null]'),
+ },
+ ],
+ };
+
+ const result = defineObject(config);
+
+ expect(result.success).toBe(false);
+ expect(result.errors).toEqual([
+ 'Field "Status" option at index 0 must be an object',
+ ]);
+ });
+
+ describe.each([
+ { type: FieldMetadataType.SELECT },
+ { type: FieldMetadataType.MULTI_SELECT },
+ ] as const)('$type option colors', (fieldType) => {
+ it.each([
+ { description: 'missing', colorProperties: {} },
+ { description: 'null', colorProperties: { color: null } },
+ ])('accepts $description colors', ({ colorProperties }) => {
+ const config: ObjectManifest = {
+ ...validConfig,
+ fields: [
+ {
+ universalIdentifier: '58a0a314-d7ea-4865-9850-7fb84e72f30b',
+ ...fieldType,
+ name: 'status',
+ label: 'Status',
+ options: [
+ {
+ value: 'OPEN',
+ label: 'Open',
+ position: 0,
+ ...colorProperties,
+ },
+ ],
+ },
+ ],
+ };
+
+ expect(defineObject(config).success).toBe(true);
+ });
+ });
+
it('should return error when field is missing label', () => {
const config = {
...validConfig,
diff --git a/packages/twenty-server/src/engine/api/__mocks__/object-metadata-item.mock.ts b/packages/twenty-server/src/engine/api/__mocks__/object-metadata-item.mock.ts
index 21eab2b8c71..3c1f050c6b3 100644
--- a/packages/twenty-server/src/engine/api/__mocks__/object-metadata-item.mock.ts
+++ b/packages/twenty-server/src/engine/api/__mocks__/object-metadata-item.mock.ts
@@ -1,4 +1,5 @@
import {
+ type FieldMetadataComplexOption,
FieldMetadataType,
RelationOnDeleteAction,
FieldActorSource,
@@ -6,7 +7,6 @@ import {
import { RelationType } from 'src/engine/metadata-modules/field-metadata/interfaces/relation-type.interface';
-import { type FieldMetadataComplexOption } from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
import { type FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { type ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { getMockFieldMetadataEntity } from 'src/utils/__test__/get-field-metadata-entity.mock';
diff --git a/packages/twenty-server/src/engine/api/graphql/workspace-schema-builder/graphql-type-generators/enum-types/composite-field-metadata-gql-enum-type.generator.ts b/packages/twenty-server/src/engine/api/graphql/workspace-schema-builder/graphql-type-generators/enum-types/composite-field-metadata-gql-enum-type.generator.ts
index 5a22adc467c..04369a9622c 100644
--- a/packages/twenty-server/src/engine/api/graphql/workspace-schema-builder/graphql-type-generators/enum-types/composite-field-metadata-gql-enum-type.generator.ts
+++ b/packages/twenty-server/src/engine/api/graphql/workspace-schema-builder/graphql-type-generators/enum-types/composite-field-metadata-gql-enum-type.generator.ts
@@ -2,6 +2,8 @@ import { Injectable, Logger } from '@nestjs/common';
import { GraphQLEnumType } from 'graphql';
import {
+ type FieldMetadataComplexOption,
+ type FieldMetadataDefaultOption,
type FieldMetadataType,
type CompositeProperty,
type CompositeType,
@@ -10,10 +12,6 @@ import { pascalCase } from 'twenty-shared/utils';
import { GqlTypesStorage } from 'src/engine/api/graphql/workspace-schema-builder/storages/gql-types.storage';
import { computeCompositeFieldEnumTypeKey } from 'src/engine/api/graphql/workspace-schema-builder/utils/compute-stored-gql-type-key-utils/compute-composite-field-enum-type-key.util';
-import {
- type FieldMetadataComplexOption,
- type FieldMetadataDefaultOption,
-} from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
import { isEnumFieldMetadataType } from 'src/engine/metadata-modules/field-metadata/utils/is-enum-field-metadata-type.util';
@Injectable()
diff --git a/packages/twenty-server/src/engine/api/graphql/workspace-schema-builder/graphql-type-generators/enum-types/enum-field-metadata-gql-enum-type.generator.ts b/packages/twenty-server/src/engine/api/graphql/workspace-schema-builder/graphql-type-generators/enum-types/enum-field-metadata-gql-enum-type.generator.ts
index 09da5a293b8..240cf1edb8a 100644
--- a/packages/twenty-server/src/engine/api/graphql/workspace-schema-builder/graphql-type-generators/enum-types/enum-field-metadata-gql-enum-type.generator.ts
+++ b/packages/twenty-server/src/engine/api/graphql/workspace-schema-builder/graphql-type-generators/enum-types/enum-field-metadata-gql-enum-type.generator.ts
@@ -1,14 +1,14 @@
import { Injectable, Logger } from '@nestjs/common';
import { GraphQLEnumType } from 'graphql';
+import {
+ type FieldMetadataComplexOption,
+ type FieldMetadataDefaultOption,
+} from 'twenty-shared/types';
import { isDefined, pascalCase } from 'twenty-shared/utils';
import { GqlTypesStorage } from 'src/engine/api/graphql/workspace-schema-builder/storages/gql-types.storage';
import { computeEnumFieldGqlTypeKey } from 'src/engine/api/graphql/workspace-schema-builder/utils/compute-stored-gql-type-key-utils/compute-enum-field-gql-type-key.util';
-import {
- type FieldMetadataComplexOption,
- type FieldMetadataDefaultOption,
-} from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
import { isEnumFieldMetadataType } from 'src/engine/metadata-modules/field-metadata/utils/is-enum-field-metadata-type.util';
import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-manifest/converters/__tests__/from-field-manifest-to-universal-flat-field-metadata.util.spec.ts b/packages/twenty-server/src/engine/core-modules/application/application-manifest/converters/__tests__/from-field-manifest-to-universal-flat-field-metadata.util.spec.ts
index 46389978e25..e99d89304ff 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-manifest/converters/__tests__/from-field-manifest-to-universal-flat-field-metadata.util.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-manifest/converters/__tests__/from-field-manifest-to-universal-flat-field-metadata.util.spec.ts
@@ -201,4 +201,53 @@ describe('fromFieldManifestToUniversalFlatFieldMetadata', () => {
expect(result.isLabelSyncedWithName).toBe(true);
});
});
+
+ describe('options', () => {
+ it.each([
+ FieldMetadataType.SELECT,
+ FieldMetadataType.MULTI_SELECT,
+ ] as const)('defaults missing %s option colors to gray', (type) => {
+ const result = fromFieldManifestToUniversalFlatFieldMetadata({
+ fieldManifest: buildFieldManifest({
+ type,
+ options: [
+ { value: 'OPEN', label: 'Open', position: 0 },
+ { value: 'CLOSED', label: 'Closed', color: 'red', position: 1 },
+ ],
+ }),
+ applicationUniversalIdentifier: APP_UID,
+ now: NOW,
+ });
+
+ expect(result.options).toEqual([
+ { value: 'OPEN', label: 'Open', color: 'gray', position: 0 },
+ { value: 'CLOSED', label: 'Closed', color: 'red', position: 1 },
+ ]);
+ });
+
+ it('leaves rating options without colors', () => {
+ const ratingOptions = [{ value: 'RATING_1', label: '1', position: 0 }];
+
+ const result = fromFieldManifestToUniversalFlatFieldMetadata({
+ fieldManifest: buildFieldManifest({
+ type: FieldMetadataType.RATING,
+ options: ratingOptions,
+ }),
+ applicationUniversalIdentifier: APP_UID,
+ now: NOW,
+ });
+
+ expect(result.options).toEqual(ratingOptions);
+ });
+
+ it('keeps options null when the manifest has none', () => {
+ const result = fromFieldManifestToUniversalFlatFieldMetadata({
+ fieldManifest: buildFieldManifest({}),
+ applicationUniversalIdentifier: APP_UID,
+ now: NOW,
+ });
+
+ expect(result.options).toBeNull();
+ });
+ });
});
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-manifest/converters/from-field-manifest-to-universal-flat-field-metadata.util.ts b/packages/twenty-server/src/engine/core-modules/application/application-manifest/converters/from-field-manifest-to-universal-flat-field-metadata.util.ts
index 128f0b187d1..8b8df455ad8 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-manifest/converters/from-field-manifest-to-universal-flat-field-metadata.util.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-manifest/converters/from-field-manifest-to-universal-flat-field-metadata.util.ts
@@ -1,5 +1,5 @@
import { type FieldManifest } from 'twenty-shared/application';
-import { isDefined } from 'twenty-shared/utils';
+import { isDefined, isFieldMetadataSelectKind } from 'twenty-shared/utils';
import {
FieldMetadataType,
MetadataWritability,
@@ -15,6 +15,7 @@ import { generateDefaultValue } from 'src/engine/metadata-modules/field-metadata
import { isAuditLoggableFieldType } from 'src/engine/metadata-modules/field-metadata/utils/is-audit-loggable-field-type.util';
import { isCompositeFieldMetadataType } from 'src/engine/metadata-modules/field-metadata/utils/is-composite-field-metadata-type.util';
import { nullifyEmptyCompositeDefaultValue } from 'src/engine/metadata-modules/flat-field-metadata/utils/nullify-empty-composite-default-value.util';
+import { sanitizeSelectOptionColors } from 'src/engine/metadata-modules/flat-field-metadata/utils/sanitize-select-option-colors.util';
import { isMorphOrRelationFieldMetadataType } from 'src/engine/utils/is-morph-or-relation-field-metadata-type.util';
import { type UniversalFlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-field-metadata.type';
@@ -74,6 +75,18 @@ const resolveManifestFieldIsSearchable = ({
);
};
+const resolveManifestFieldOptions = (
+ fieldManifest: FieldManifest,
+): UniversalFlatFieldMetadata['options'] => {
+ if (!isDefined(fieldManifest.options)) {
+ return null;
+ }
+
+ return isFieldMetadataSelectKind(fieldManifest.type)
+ ? sanitizeSelectOptionColors(fieldManifest.options)
+ : fieldManifest.options;
+};
+
export const fromFieldManifestToUniversalFlatFieldMetadata = ({
fieldManifest,
applicationUniversalIdentifier,
@@ -112,7 +125,7 @@ export const fromFieldManifestToUniversalFlatFieldMetadata = ({
description: fieldManifest.description ?? null,
icon: fieldManifest.icon ?? null,
overrides: null,
- options: fieldManifest.options ?? null,
+ options: resolveManifestFieldOptions(fieldManifest),
defaultValue,
universalSettings: fieldManifest.universalSettings ?? null,
isActive: true,
diff --git a/packages/twenty-server/src/engine/core-modules/open-api/utils/components.utils.ts b/packages/twenty-server/src/engine/core-modules/open-api/utils/components.utils.ts
index 92b4cf7c581..56a1e760c62 100644
--- a/packages/twenty-server/src/engine/core-modules/open-api/utils/components.utils.ts
+++ b/packages/twenty-server/src/engine/core-modules/open-api/utils/components.utils.ts
@@ -1,4 +1,8 @@
import { type OpenAPIV3_1 } from 'openapi-types';
+import {
+ DEFAULT_SELECT_OPTION_COLOR,
+ TAG_COLORS,
+} from 'twenty-shared/constants';
import {
type FieldMetadataDefaultValue,
FieldMetadataType,
@@ -416,7 +420,11 @@ export const computeMetadataSchemaComponents = (
items: {
type: 'object',
properties: {
- color: { type: 'string' },
+ color: {
+ type: 'string',
+ enum: [...TAG_COLORS],
+ default: DEFAULT_SELECT_OPTION_COLOR,
+ },
label: { type: 'string' },
value: {
type: 'string',
diff --git a/packages/twenty-server/src/engine/metadata-modules/field-metadata/dtos/field-metadata.dto.ts b/packages/twenty-server/src/engine/metadata-modules/field-metadata/dtos/field-metadata.dto.ts
index a76bc18f3fc..7ef03c5c787 100644
--- a/packages/twenty-server/src/engine/metadata-modules/field-metadata/dtos/field-metadata.dto.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/field-metadata/dtos/field-metadata.dto.ts
@@ -17,6 +17,7 @@ import {
} from 'class-validator';
import { GraphQLJSON } from 'graphql-type-json';
import {
+ type FieldMetadataDefaultOption,
type FieldMetadataOptions,
type FieldMetadataSettings,
FieldMetadataType,
@@ -28,7 +29,6 @@ import { type AuthoredOverrides } from 'src/engine/metadata-modules/overrides/ty
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
import { IsValidMetadataName } from 'src/engine/decorators/metadata/is-valid-metadata-name.decorator';
import { type FieldMetadataOverrides } from 'src/engine/metadata-modules/field-metadata/types/field-metadata-overrides.type';
-import { type FieldMetadataDefaultOption } from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
import { transformEnumValue } from 'src/engine/utils/transform-enum-value';
registerEnumType(FieldMetadataType, {
diff --git a/packages/twenty-server/src/engine/metadata-modules/field-metadata/dtos/options.input.ts b/packages/twenty-server/src/engine/metadata-modules/field-metadata/dtos/options.input.ts
deleted file mode 100644
index dcede3b4f75..00000000000
--- a/packages/twenty-server/src/engine/metadata-modules/field-metadata/dtos/options.input.ts
+++ /dev/null
@@ -1,52 +0,0 @@
-import { IsNotEmpty, IsNumber, IsOptional, IsString } from 'class-validator';
-import { IsValidGraphQLEnumName } from 'twenty-shared/types';
-
-export type TagColor =
- | 'red'
- | 'ruby'
- | 'crimson'
- | 'tomato'
- | 'orange'
- | 'amber'
- | 'yellow'
- | 'lime'
- | 'grass'
- | 'green'
- | 'jade'
- | 'mint'
- | 'turquoise'
- | 'cyan'
- | 'sky'
- | 'blue'
- | 'iris'
- | 'violet'
- | 'purple'
- | 'plum'
- | 'pink'
- | 'bronze'
- | 'gold'
- | 'brown'
- | 'gray';
-
-export class FieldMetadataDefaultOption {
- @IsOptional()
- @IsString()
- id?: string;
-
- @IsNumber()
- position: number;
-
- @IsNotEmpty()
- @IsString()
- label: string;
-
- @IsNotEmpty()
- @IsValidGraphQLEnumName()
- value: string;
-}
-
-export class FieldMetadataComplexOption extends FieldMetadataDefaultOption {
- @IsNotEmpty()
- @IsString()
- color: TagColor;
-}
diff --git a/packages/twenty-server/src/engine/metadata-modules/field-metadata/tools/field-metadata-tools.factory.ts b/packages/twenty-server/src/engine/metadata-modules/field-metadata/tools/field-metadata-tools.factory.ts
index 45f8e1ac14a..b89ef6d9c88 100644
--- a/packages/twenty-server/src/engine/metadata-modules/field-metadata/tools/field-metadata-tools.factory.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/field-metadata/tools/field-metadata-tools.factory.ts
@@ -1,7 +1,11 @@
import { Injectable } from '@nestjs/common';
import { type ToolSet } from 'ai';
-import { FIELD_TYPE_DEFAULT_ICONS } from 'twenty-shared/constants';
+import {
+ DEFAULT_SELECT_OPTION_COLOR,
+ FIELD_TYPE_DEFAULT_ICONS,
+ TAG_COLORS,
+} from 'twenty-shared/constants';
import { FieldMetadataType, RelationType } from 'twenty-shared/types';
import { z } from 'zod';
@@ -34,6 +38,8 @@ const RELATION_TYPE_DESCRIPTION =
"MANY_TO_ONE: the field points to a single target record; this object owns the foreign key and gets a writable '<fieldName>Id' on its create/update inputs. Use it for 'belongs to one' fields. " +
"ONE_TO_MANY: the field is a read-only collection of target records; records are linked by writing the inverse '<fieldName>Id' on the target object.";
+const SELECT_OPTIONS_DESCRIPTION = `SELECT/MULTI_SELECT options: [{ label, value, position, color }]. color is one of ${TAG_COLORS.join(', ')}; defaults to ${DEFAULT_SELECT_OPTION_COLOR} when omitted.`;
+
const RelationCreationPayloadSchema = z.object({
type: z.nativeEnum(RelationType).describe(RELATION_TYPE_DESCRIPTION),
targetObjectMetadataId: z.string().uuid().describe('Target object ID'),
@@ -89,7 +95,7 @@ const CreateFieldMetadataInputSchema = z.object({
isNullable: z.boolean().optional().describe('Nullable'),
isUnique: z.boolean().optional().describe('Unique constraint'),
defaultValue: z.unknown().optional().describe('Default value'),
- options: z.unknown().optional().describe('SELECT/MULTI_SELECT options'),
+ options: z.unknown().optional().describe(SELECT_OPTIONS_DESCRIPTION),
settings: z.unknown().optional().describe('Field settings'),
isLabelSyncedWithName: z
.boolean()
@@ -114,7 +120,7 @@ const UpdateFieldMetadataInputSchema = z.object({
isNullable: z.boolean().optional().describe('Nullable'),
isUnique: z.boolean().optional().describe('Unique constraint'),
defaultValue: z.unknown().optional().describe('Default value'),
- options: z.unknown().optional().describe('SELECT/MULTI_SELECT options'),
+ options: z.unknown().optional().describe(SELECT_OPTIONS_DESCRIPTION),
settings: z.unknown().optional().describe('Field settings'),
isLabelSyncedWithName: z
.boolean()
diff --git a/packages/twenty-server/src/engine/metadata-modules/field-metadata/types/__tests__/field-metadata-entity.test-type.ts b/packages/twenty-server/src/engine/metadata-modules/field-metadata/types/__tests__/field-metadata-entity.test-type.ts
index 4aac61d93aa..a49f2f58684 100644
--- a/packages/twenty-server/src/engine/metadata-modules/field-metadata/types/__tests__/field-metadata-entity.test-type.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/field-metadata/types/__tests__/field-metadata-entity.test-type.ts
@@ -1,6 +1,8 @@
import { type Expect, type HasAllProperties } from 'twenty-shared/testing';
import {
type AllFieldMetadataSettings,
+ type FieldMetadataComplexOption,
+ type FieldMetadataDefaultOption,
type FieldMetadataDefaultValueForAnyType,
type FieldMetadataDefaultValueMapping,
type FieldMetadataOptionForAnyType,
@@ -11,10 +13,6 @@ import {
import { type Relation as TypeOrmRelation } from 'typeorm';
import { type JsonbProperty } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/jsonb-property.type';
-import {
- type FieldMetadataComplexOption,
- type FieldMetadataDefaultOption,
-} from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
import { type FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
import { type ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
diff --git a/packages/twenty-server/src/engine/metadata-modules/field-metadata/utils/generate-rating-optionts.util.ts b/packages/twenty-server/src/engine/metadata-modules/field-metadata/utils/generate-rating-optionts.util.ts
index 4c3ba695aef..ad8d972f1ac 100644
--- a/packages/twenty-server/src/engine/metadata-modules/field-metadata/utils/generate-rating-optionts.util.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/field-metadata/utils/generate-rating-optionts.util.ts
@@ -1,7 +1,6 @@
+import { type FieldMetadataDefaultOption } from 'twenty-shared/types';
import { v4 as uuidV4 } from 'uuid';
-import { type FieldMetadataDefaultOption } from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
-
const range = {
start: 1,
end: 5,
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/compare-two-flat-field-metadata-enum-options.spec.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/compare-two-flat-field-metadata-enum-options.spec.ts
index ce752ba8ffc..4e10dcf1d61 100644
--- a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/compare-two-flat-field-metadata-enum-options.spec.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/compare-two-flat-field-metadata-enum-options.spec.ts
@@ -2,8 +2,8 @@ import {
type EachTestingContext,
eachTestingContextFilter,
} from 'twenty-shared/testing';
+import { type FieldMetadataDefaultOption } from 'twenty-shared/types';
-import { type FieldMetadataDefaultOption } from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
import {
type CompareToFlatFieldMetadataEnumOptionsArgs,
compareTwoFlatFieldMetadataEnumOptions,
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/sanitize-raw-update-field-input.spec.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/sanitize-raw-update-field-input.spec.ts
new file mode 100644
index 00000000000..a5ec58b87cb
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/sanitize-raw-update-field-input.spec.ts
@@ -0,0 +1,96 @@
+import {
+ type FieldMetadataComplexOption,
+ FieldMetadataType,
+ type TagColor,
+} from 'twenty-shared/types';
+
+import { type UpdateFieldInput } from 'src/engine/metadata-modules/field-metadata/dtos/update-field.input';
+import { getFlatFieldMetadataMock } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/get-flat-field-metadata.mock';
+import { sanitizeRawUpdateFieldInput } from 'src/engine/metadata-modules/flat-field-metadata/utils/sanitize-raw-update-field-input';
+
+const FIELD_ID = 'a1b3c5d7-0000-4000-8000-000000000001';
+const WORKSPACE_CUSTOM_APPLICATION_UNIVERSAL_IDENTIFIER =
+ '20202020-aaaa-4aaa-8aaa-000000000001';
+
+const sanitizeOptionsUpdate = ({
+ type,
+ options,
+}: {
+ type: FieldMetadataType;
+ options: UpdateFieldInput['options'];
+}) =>
+ sanitizeRawUpdateFieldInput({
+ existingFlatFieldMetadata: getFlatFieldMetadataMock({
+ id: FIELD_ID,
+ type,
+ universalIdentifier: 'ab0e6d76-67d8-466f-918a-4b8a8d044131',
+ objectMetadataId: '6450cd8f-c202-498f-8be4-65e1b1c93e32',
+ applicationUniversalIdentifier:
+ WORKSPACE_CUSTOM_APPLICATION_UNIVERSAL_IDENTIFIER,
+ }),
+ rawUpdateFieldInput: { id: FIELD_ID, options } as UpdateFieldInput,
+ isSystemBuild: false,
+ workspaceCustomApplicationUniversalIdentifier:
+ WORKSPACE_CUSTOM_APPLICATION_UNIVERSAL_IDENTIFIER,
+ }).updatedEditableFieldProperties.options;
+
+describe('sanitizeRawUpdateFieldInput', () => {
+ it.each([FieldMetadataType.SELECT, FieldMetadataType.MULTI_SELECT])(
+ 'defaults missing %s option colors and trims provided ones',
+ (type) => {
+ expect(
+ sanitizeOptionsUpdate({
+ type,
+ options: [
+ {
+ id: '2c73ce21-d19f-4b37-935e-48c351e2bb1b',
+ label: 'Open',
+ value: 'OPEN',
+ position: 0,
+ },
+ {
+ id: '5b0b1a8e-5b53-4c3e-9d6a-7c1f3d2a9e10',
+ label: 'Closed',
+ value: 'CLOSED',
+ position: 1,
+ color: ' blue ' as TagColor,
+ },
+ ] as FieldMetadataComplexOption[],
+ }),
+ ).toEqual([
+ {
+ id: '2c73ce21-d19f-4b37-935e-48c351e2bb1b',
+ label: 'Open',
+ value: 'OPEN',
+ position: 0,
+ color: 'gray',
+ },
+ {
+ id: '5b0b1a8e-5b53-4c3e-9d6a-7c1f3d2a9e10',
+ label: 'Closed',
+ value: 'CLOSED',
+ position: 1,
+ color: 'blue',
+ },
+ ]);
+ },
+ );
+
+ it('leaves rating options without colors', () => {
+ const ratingOptions = [
+ {
+ id: '2c73ce21-d19f-4b37-935e-48c351e2bb1b',
+ label: '1',
+ value: 'RATING_1',
+ position: 0,
+ },
+ ];
+
+ expect(
+ sanitizeOptionsUpdate({
+ type: FieldMetadataType.RATING,
+ options: ratingOptions,
+ }),
+ ).toEqual(ratingOptions);
+ });
+});
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/sanitize-select-option-colors.util.spec.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/sanitize-select-option-colors.util.spec.ts
new file mode 100644
index 00000000000..a83bc2c3186
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/sanitize-select-option-colors.util.spec.ts
@@ -0,0 +1,42 @@
+import { sanitizeSelectOptionColors } from 'src/engine/metadata-modules/flat-field-metadata/utils/sanitize-select-option-colors.util';
+
+const OPTION_WITHOUT_COLOR = {
+ id: '2c73ce21-d19f-4b37-935e-48c351e2bb1b',
+ label: 'Car Repairs and Servicing',
+ value: 'CAR_REPAIRS_AND_SERVICING',
+ position: 0,
+};
+
+describe('sanitizeSelectOptionColors', () => {
+ it('defaults a missing color to gray', () => {
+ expect(sanitizeSelectOptionColors([OPTION_WITHOUT_COLOR])).toEqual([
+ { ...OPTION_WITHOUT_COLOR, color: 'gray' },
+ ]);
+ });
+
+ it('defaults a null color to gray', () => {
+ expect(
+ sanitizeSelectOptionColors([{ ...OPTION_WITHOUT_COLOR, color: null }]),
+ ).toEqual([{ ...OPTION_WITHOUT_COLOR, color: 'gray' }]);
+ });
+
+ it('keeps a provided color', () => {
+ expect(
+ sanitizeSelectOptionColors([{ ...OPTION_WITHOUT_COLOR, color: 'blue' }]),
+ ).toEqual([{ ...OPTION_WITHOUT_COLOR, color: 'blue' }]);
+ });
+
+ it('trims a provided color', () => {
+ expect(
+ sanitizeSelectOptionColors([
+ { ...OPTION_WITHOUT_COLOR, color: ' blue ' },
+ ]),
+ ).toEqual([{ ...OPTION_WITHOUT_COLOR, color: 'blue' }]);
+ });
+
+ it('leaves an unsupported color for validation to reject', () => {
+ expect(
+ sanitizeSelectOptionColors([{ ...OPTION_WITHOUT_COLOR, color: 'grey' }]),
+ ).toEqual([{ ...OPTION_WITHOUT_COLOR, color: 'grey' }]);
+ });
+});
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/from-create-field-input-to-flat-field-metadatas-to-create.util.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/from-create-field-input-to-flat-field-metadatas-to-create.util.ts
index 9dd58ee60e8..db9e63cb43c 100644
--- a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/from-create-field-input-to-flat-field-metadatas-to-create.util.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/from-create-field-input-to-flat-field-metadatas-to-create.util.ts
@@ -20,6 +20,7 @@ import { type FieldInputTranspilationResult } from 'src/engine/metadata-modules/
import { fromMorphRelationCreateFieldInputToFlatFieldMetadatas } from 'src/engine/metadata-modules/flat-field-metadata/utils/from-morph-relation-create-field-input-to-flat-field-metadatas.util';
import { fromRelationCreateFieldInputToFlatFieldMetadatas } from 'src/engine/metadata-modules/flat-field-metadata/utils/from-relation-create-field-input-to-flat-field-metadatas.util';
import { getDefaultFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/utils/get-default-flat-field-metadata-from-create-field-input.util';
+import { sanitizeSelectOptionColors } from 'src/engine/metadata-modules/flat-field-metadata/utils/sanitize-select-option-colors.util';
import { type UniversalFlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-field-metadata.type';
import { type UniversalFlatIndexMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-index-metadata.type';
@@ -127,15 +128,19 @@ export const fromCreateFieldInputToFlatFieldMetadatasToCreate = async ({
}
case FieldMetadataType.SELECT:
case FieldMetadataType.MULTI_SELECT: {
- const options = (createFieldInput?.options ?? []).map<
- FieldMetadataOptions<typeof createFieldInput.type>[number]
- >((option) => ({
- id: v4(),
- ...trimAndRemoveDuplicatedWhitespacesFromObjectStringProperties(
- option as FieldMetadataOptions<typeof createFieldInput.type>[number],
- ['label', 'value', 'id', 'color'],
- ),
- }));
+ const options = sanitizeSelectOptionColors(
+ (createFieldInput?.options ?? []).map<
+ FieldMetadataOptions<typeof createFieldInput.type>[number]
+ >((option) => ({
+ id: v4(),
+ ...trimAndRemoveDuplicatedWhitespacesFromObjectStringProperties(
+ option as FieldMetadataOptions<
+ typeof createFieldInput.type
+ >[number],
+ ['label', 'value', 'id'],
+ ),
+ })),
+ );
return {
status: 'success',
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/sanitize-raw-update-field-input.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/sanitize-raw-update-field-input.ts
index 1cddfa0c6d9..c0f8abba3c7 100644
--- a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/sanitize-raw-update-field-input.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/sanitize-raw-update-field-input.ts
@@ -1,6 +1,7 @@
import {
extractAndSanitizeObjectStringFields,
isDefined,
+ isFieldMetadataSelectKind,
} from 'twenty-shared/utils';
import { v4 } from 'uuid';
@@ -17,6 +18,7 @@ import {
import { type FlatFieldMetadataEditableProperties } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata-editable-properties.constant';
import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
import { nullifyEmptyCompositeDefaultValue } from 'src/engine/metadata-modules/flat-field-metadata/utils/nullify-empty-composite-default-value.util';
+import { sanitizeSelectOptionColors } from 'src/engine/metadata-modules/flat-field-metadata/utils/sanitize-select-option-colors.util';
import { belongsToTwentyStandardApp } from 'src/engine/metadata-modules/utils/belongs-to-twenty-standard-app.util';
import { dispatchUpdateToAuthoredOverride } from 'src/engine/metadata-modules/overrides/utils/dispatch-update-to-authored-override.util';
import { findInvalidTranslationOverrideProperties } from 'src/engine/metadata-modules/overrides/utils/find-invalid-translation-override-properties.util';
@@ -77,14 +79,20 @@ export const sanitizeRawUpdateFieldInput = ({
updatedEditableFieldProperties.isSearchable = false;
}
- updatedEditableFieldProperties.options = !isDefined(
- updatedEditableFieldProperties.options,
- )
- ? updatedEditableFieldProperties.options
- : updatedEditableFieldProperties.options.map((option) => ({
+ if (isDefined(updatedEditableFieldProperties.options)) {
+ const optionsWithIds = updatedEditableFieldProperties.options.map(
+ (option) => ({
id: v4(),
...option,
- }));
+ }),
+ );
+
+ updatedEditableFieldProperties.options = isFieldMetadataSelectKind(
+ existingFlatFieldMetadata.type,
+ )
+ ? sanitizeSelectOptionColors(optionsWithIds)
+ : optionsWithIds;
+ }
if (
updatedEditableFieldProperties.defaultValue !== undefined &&
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/sanitize-select-option-colors.util.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/sanitize-select-option-colors.util.ts
new file mode 100644
index 00000000000..2cc264e9445
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/sanitize-select-option-colors.util.ts
@@ -0,0 +1,20 @@
+import { DEFAULT_SELECT_OPTION_COLOR } from 'twenty-shared/constants';
+import { type FieldMetadataComplexOption } from 'twenty-shared/types';
+import { extractAndSanitizeObjectStringFields } from 'twenty-shared/utils';
+
+type SelectOptionWithOptionalColor<TColor extends string> = Omit<
+ FieldMetadataComplexOption,
+ 'color'
+> & { color?: TColor | null };
+
+export const sanitizeSelectOptionColors = <TColor extends string>(
+ options: SelectOptionWithOptionalColor<TColor>[],
+) =>
+ options.map((option) => {
+ const { color } = extractAndSanitizeObjectStringFields(option, ['color']);
+
+ return {
+ ...option,
+ color: color ?? DEFAULT_SELECT_OPTION_COLOR,
+ };
+ });
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/validators/utils/__tests__/validate-enum-flat-field-metadata.util.spec.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/validators/utils/__tests__/validate-enum-flat-field-metadata.util.spec.ts
new file mode 100644
index 00000000000..d11a54d2860
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/validators/utils/__tests__/validate-enum-flat-field-metadata.util.spec.ts
@@ -0,0 +1,146 @@
+import {
+ FieldMetadataType,
+ type EnumFieldMetadataType,
+} from 'twenty-shared/types';
+
+import { FieldMetadataExceptionCode } from 'src/engine/metadata-modules/field-metadata/field-metadata.exception';
+import { createEmptyAllFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/constant/create-empty-all-flat-entity-maps.constant';
+import { getFlatFieldMetadataMock } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/get-flat-field-metadata.mock';
+import { type FlatFieldMetadataTypeValidationArgs } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata-type-validator.type';
+import { validateEnumSelectFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/validators/utils/validate-enum-flat-field-metadata.util';
+import { type WorkspaceMigrationBuilderAdditionalCacheDataMaps } from 'src/engine/workspace-manager/workspace-migration/types/workspace-migration-builder-additional-cache-data-maps.type';
+
+const OPTION_WITHOUT_COLOR = {
+ id: '2c73ce21-d19f-4b37-935e-48c351e2bb1b',
+ label: 'Car Repairs and Servicing',
+ value: 'CAR_REPAIRS_AND_SERVICING',
+ position: 0,
+};
+
+const validateOptionColor = ({
+ type,
+ colorProperties,
+ update,
+}: {
+ type: EnumFieldMetadataType;
+ colorProperties: { color?: unknown };
+ update?: FlatFieldMetadataTypeValidationArgs<EnumFieldMetadataType>['update'];
+}) => {
+ const flatFieldMetadata = getFlatFieldMetadataMock({
+ type,
+ universalIdentifier: 'ab0e6d76-67d8-466f-918a-4b8a8d044131',
+ objectMetadataId: '6450cd8f-c202-498f-8be4-65e1b1c93e32',
+ });
+
+ return validateEnumSelectFlatFieldMetadata({
+ update,
+ flatEntityToValidate: {
+ ...flatFieldMetadata,
+ type,
+ defaultValue: null,
+ morphId: null,
+ relationTargetFieldMetadataUniversalIdentifier: null,
+ relationTargetObjectMetadataUniversalIdentifier: null,
+ universalSettings: null,
+ options: [
+ {
+ ...OPTION_WITHOUT_COLOR,
+ ...colorProperties,
+ },
+ ],
+ },
+ additionalCacheDataMaps: {
+ featureFlagsMap:
+ {} as WorkspaceMigrationBuilderAdditionalCacheDataMaps['featureFlagsMap'],
+ },
+ optimisticFlatEntityMapsAndRelatedFlatEntityMaps:
+ createEmptyAllFlatEntityMaps(),
+ remainingFlatEntityMapsToValidate: { byUniversalIdentifier: {} },
+ workspaceId: flatFieldMetadata.workspaceId,
+ buildOptions: {
+ isSystemBuild: false,
+ applicationUniversalIdentifier:
+ flatFieldMetadata.applicationUniversalIdentifier,
+ },
+ });
+};
+
+describe('validateEnumSelectFlatFieldMetadata', () => {
+ describe.each([
+ FieldMetadataType.SELECT,
+ FieldMetadataType.MULTI_SELECT,
+ ] as const)('%s option colors', (type) => {
+ it.each([
+ { description: 'missing', colorProperties: {} },
+ { description: 'null', colorProperties: { color: null } },
+ ])('allows $description colors', ({ colorProperties }) => {
+ expect(validateOptionColor({ type, colorProperties })).toEqual([]);
+ });
+
+ it('accepts a supported color', () => {
+ expect(
+ validateOptionColor({ type, colorProperties: { color: 'blue' } }),
+ ).toEqual([]);
+ });
+
+ it.each([
+ { description: 'empty', colorProperties: { color: '' } },
+ { description: 'misspelled', colorProperties: { color: 'grey' } },
+ { description: 'non-string', colorProperties: { color: 42 } },
+ ])(
+ 'rejects $description colors and names the option',
+ ({ colorProperties }) => {
+ const errors = validateOptionColor({ type, colorProperties });
+
+ expect(errors).toEqual([
+ expect.objectContaining({
+ code: FieldMetadataExceptionCode.INVALID_FIELD_INPUT,
+ message: expect.stringContaining(
+ `Option "${OPTION_WITHOUT_COLOR.label}" color`,
+ ),
+ value: colorProperties.color,
+ }),
+ ]);
+ },
+ );
+
+ it('rejects an option update that sets an unsupported color', () => {
+ const optionWithUnsupportedColor = {
+ ...OPTION_WITHOUT_COLOR,
+ color: 'grey',
+ };
+
+ const errors = validateOptionColor({
+ type,
+ colorProperties: { color: 'grey' },
+ update: { options: [optionWithUnsupportedColor] },
+ });
+
+ expect(errors).toEqual([
+ expect.objectContaining({
+ code: FieldMetadataExceptionCode.INVALID_FIELD_INPUT,
+ value: 'grey',
+ }),
+ ]);
+ });
+
+ it('allows unrelated updates to fields with an existing unsupported color', () => {
+ expect(
+ validateOptionColor({
+ type,
+ colorProperties: { color: 'grey' },
+ update: { label: 'Updated category' },
+ }),
+ ).toEqual([]);
+ });
+ });
+
+ it('allows rating options without colors', () => {
+ expect(
+ validateOptionColor({
+ type: FieldMetadataType.RATING,
+ colorProperties: {},
+ }),
+ ).toEqual([]);
+ });
+});
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/validators/utils/validate-enum-flat-field-metadata.util.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/validators/utils/validate-enum-flat-field-metadata.util.ts
index 4f991881245..de294443985 100644
--- a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/validators/utils/validate-enum-flat-field-metadata.util.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/validators/utils/validate-enum-flat-field-metadata.util.ts
@@ -4,19 +4,22 @@ import { QUOTED_STRING_REGEX } from 'twenty-shared/constants';
import {
FieldMetadataType,
type EnumFieldMetadataType,
+ type FieldMetadataComplexOption,
+ type FieldMetadataDefaultOption,
type FieldMetadataOptions,
type NonNullableRequired,
} from 'twenty-shared/types';
-import { assertUnreachable, isDefined } from 'twenty-shared/utils';
+import {
+ assertUnreachable,
+ isDefined,
+ isFieldMetadataSelectKind,
+} from 'twenty-shared/utils';
import { z } from 'zod';
-import {
- type FieldMetadataComplexOption,
- type FieldMetadataDefaultOption,
-} from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
import { FieldMetadataExceptionCode } from 'src/engine/metadata-modules/field-metadata/field-metadata.exception';
import { type FlatFieldMetadataTypeValidationArgs } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata-type-validator.type';
import { type FlatFieldMetadataValidationError } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata-validation-error.type';
+import { validateMetadataOptionColor } from 'src/engine/metadata-modules/flat-field-metadata/validators/utils/validate-metadata-option-color.util';
import { IDENTIFIER_MAX_CHAR_LENGTH } from 'twenty-shared/metadata';
import { IDENTIFIER_MIN_CHAR_LENGTH } from 'src/engine/metadata-modules/utils/constants/identifier-min-char-length.constants';
import { type UniversalFlatFieldMetadata } from 'src/engine/workspace-manager/workspace-migration/universal-flat-entity/types/universal-flat-field-metadata.type';
@@ -226,6 +229,18 @@ const validateFieldMetadataInputOptions = (
return [...optionsValidationErrors, ...duplicatedValidationErrors];
};
+const validateSelectOptionColors = (
+ universalFlatFieldMetadata: UniversalFlatFieldMetadata<EnumFieldMetadataType>,
+): FlatFieldMetadataValidationError[] => {
+ if (!isFieldMetadataSelectKind(universalFlatFieldMetadata.type)) {
+ return [];
+ }
+
+ return (universalFlatFieldMetadata.options ?? []).flatMap((option) =>
+ validateMetadataOptionColor(option),
+ );
+};
+
const validateSelectDefaultValue = ({
defaultValue,
options,
@@ -355,11 +370,19 @@ const validateFieldMetadataDefaultValue = ({
export const validateEnumSelectFlatFieldMetadata = ({
flatEntityToValidate: universalFlatFieldMetadataToValidate,
+ update,
}: FlatFieldMetadataTypeValidationArgs<EnumFieldMetadataType>): FlatFieldMetadataValidationError[] => {
const optionsValidationErrors = validateFieldMetadataInputOptions(
universalFlatFieldMetadataToValidate,
);
+ const shouldValidateOptionColors =
+ !isDefined(update) || isDefined(update.options);
+
+ const optionColorValidationErrors = shouldValidateOptionColors
+ ? validateSelectOptionColors(universalFlatFieldMetadataToValidate)
+ : [];
+
const defaultValueValidationErrors = isDefined(
universalFlatFieldMetadataToValidate.defaultValue,
)
@@ -369,5 +392,9 @@ export const validateEnumSelectFlatFieldMetadata = ({
})
: [];
- return [...optionsValidationErrors, ...defaultValueValidationErrors];
+ return [
+ ...optionsValidationErrors,
+ ...optionColorValidationErrors,
+ ...defaultValueValidationErrors,
+ ];
};
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/validators/utils/validate-metadata-option-color.util.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/validators/utils/validate-metadata-option-color.util.ts
new file mode 100644
index 00000000000..812eea57f2c
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/validators/utils/validate-metadata-option-color.util.ts
@@ -0,0 +1,27 @@
+import { msg } from '@lingui/core/macro';
+import { TAG_COLORS } from 'twenty-shared/constants';
+import { isDefined, isTagColor } from 'twenty-shared/utils';
+
+import { FieldMetadataExceptionCode } from 'src/engine/metadata-modules/field-metadata/field-metadata.exception';
+import { type FlatFieldMetadataValidationError } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata-validation-error.type';
+
+export const validateMetadataOptionColor = ({
+ label: optionLabel,
+ color: optionColor,
+}: {
+ label: string;
+ color?: unknown;
+}): FlatFieldMetadataValidationError[] => {
+ if (!isDefined(optionColor) || isTagColor(optionColor)) {
+ return [];
+ }
+
+ return [
+ {
+ code: FieldMetadataExceptionCode.INVALID_FIELD_INPUT,
+ message: `Option "${optionLabel}" color "${optionColor}" is not supported. Supported colors: ${TAG_COLORS.join(', ')}`,
+ userFriendlyMessage: msg`Option "${optionLabel}" has an unsupported color`,
+ value: optionColor,
+ },
+ ];
+};
diff --git a/packages/twenty-server/src/engine/utils/transform-enum-value.ts b/packages/twenty-server/src/engine/utils/transform-enum-value.ts
index 74bd674e573..fdd49eb5fac 100644
--- a/packages/twenty-server/src/engine/utils/transform-enum-value.ts
+++ b/packages/twenty-server/src/engine/utils/transform-enum-value.ts
@@ -1,4 +1,4 @@
-import { type FieldMetadataDefaultOption } from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
+import { type FieldMetadataDefaultOption } from 'twenty-shared/types';
export function transformEnumValue(options?: FieldMetadataDefaultOption[]) {
return options?.map((option) => {
diff --git a/packages/twenty-server/test/integration/graphql/suites/inputs-validation/utils/get-field-metadata-creation-inputs.util.ts b/packages/twenty-server/test/integration/graphql/suites/inputs-validation/utils/get-field-metadata-creation-inputs.util.ts
index 76d74c7b617..991b38ebaf5 100644
--- a/packages/twenty-server/test/integration/graphql/suites/inputs-validation/utils/get-field-metadata-creation-inputs.util.ts
+++ b/packages/twenty-server/test/integration/graphql/suites/inputs-validation/utils/get-field-metadata-creation-inputs.util.ts
@@ -3,6 +3,7 @@ import {
type FieldMetadataTypesToTestForFilterInputValidation,
} from 'test/integration/graphql/suites/inputs-validation/types/field-metadata-type-to-test';
import {
+ type FieldMetadataComplexOption,
type FieldMetadataSettingsMapping,
FieldMetadataType,
RelationType,
@@ -10,8 +11,6 @@ import {
type RelationCreationPayload,
} from 'twenty-shared/types';
-import { type FieldMetadataComplexOption } from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
-
type FieldMetadataCreationInput = {
name: string;
label: string;
diff --git a/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/common/create-enum-field-metadata-test-cases.ts b/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/common/create-enum-field-metadata-test-cases.ts
index b07f2594d02..d4bbb8a1fee 100644
--- a/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/common/create-enum-field-metadata-test-cases.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/common/create-enum-field-metadata-test-cases.ts
@@ -2,8 +2,8 @@ import { MUTLI_SELECT_OPERATION_AGNOSTIC_TEST_CASES } from 'test/integration/met
import { SELECT_OPERATION_AGNOSTIC_TEST_CASES } from 'test/integration/metadata/suites/field-metadata/enum/common/select-operation-agnostic-test-cases';
import { type FieldMetadataEnumSuccessfulAndFailingTestCases } from 'test/integration/metadata/suites/field-metadata/enum/types/fieldMetadataEnumSuccessfulAndFailingTestCases';
import { type UpdateCreateFieldMetadataSelectTestCase } from 'test/integration/metadata/suites/field-metadata/enum/types/update-create-field-metadata-enum-test-case';
+import { type FieldMetadataComplexOption } from 'twenty-shared/types';
-import { type FieldMetadataComplexOption } from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
import { type EnumFieldMetadataUnionType } from 'src/engine/metadata-modules/field-metadata/utils/is-enum-field-metadata-type.util';
const fieldMetadataTypeAgnosticCreateFailingTestCases: UpdateCreateFieldMetadataSelectTestCase[] =
diff --git a/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/common/select-and-multi-select-operation-agnostic-tests-cases.ts b/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/common/select-and-multi-select-operation-agnostic-tests-cases.ts
index f55818800fa..c013d85b293 100644
--- a/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/common/select-and-multi-select-operation-agnostic-tests-cases.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/common/select-and-multi-select-operation-agnostic-tests-cases.ts
@@ -1,10 +1,12 @@
import { BASIC_FAILING_STRING_EDGE_CASE_INPUTS } from 'test/constants/basic-failing-string-edge-case-inputs.constant';
import { type FieldMetadataEnumSuccessfulAndFailingTestCases } from 'test/integration/metadata/suites/field-metadata/enum/types/fieldMetadataEnumSuccessfulAndFailingTestCases';
import { type UpdateCreateFieldMetadataSelectTestCase } from 'test/integration/metadata/suites/field-metadata/enum/types/update-create-field-metadata-enum-test-case';
+import {
+ type FieldMetadataComplexOption,
+ type TagColor,
+} from 'twenty-shared/types';
import { v4 } from 'uuid';
-import { type FieldMetadataComplexOption } from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
-
const stringFields: (keyof FieldMetadataComplexOption)[] = [
'id',
'label',
@@ -318,5 +320,50 @@ export const SELECT_AND_MULTI_SELECT_OPERATION_AGNOSTIC_SUCCESSFUL_AND_FAILING_T
],
},
},
+ {
+ title: 'should default a missing option color to gray',
+ context: {
+ input: {
+ options: [
+ {
+ label: 'Option 1',
+ value: 'OPTION_1',
+ position: 1,
+ },
+ ],
+ },
+ expectedOptions: [
+ {
+ label: 'Option 1',
+ value: 'OPTION_1',
+ color: 'gray',
+ position: 1,
+ },
+ ],
+ },
+ },
+ {
+ title: 'should trim option color',
+ context: {
+ input: {
+ options: [
+ {
+ label: 'Option 1',
+ value: 'OPTION_1',
+ color: ' blue ' as TagColor,
+ position: 1,
+ },
+ ],
+ },
+ expectedOptions: [
+ {
+ label: 'Option 1',
+ value: 'OPTION_1',
+ color: 'blue',
+ position: 1,
+ },
+ ],
+ },
+ },
],
};
diff --git a/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/common/update-enum-field-metadata-test-cases.ts b/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/common/update-enum-field-metadata-test-cases.ts
index 163477edf1d..3829a0e9ee1 100644
--- a/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/common/update-enum-field-metadata-test-cases.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/common/update-enum-field-metadata-test-cases.ts
@@ -1,8 +1,8 @@
import { MUTLI_SELECT_OPERATION_AGNOSTIC_TEST_CASES } from 'test/integration/metadata/suites/field-metadata/enum/common/multi-select-operation-agnostic-test-cases';
import { SELECT_OPERATION_AGNOSTIC_TEST_CASES } from 'test/integration/metadata/suites/field-metadata/enum/common/select-operation-agnostic-test-cases';
import { type FieldMetadataEnumSuccessfulAndFailingTestCases } from 'test/integration/metadata/suites/field-metadata/enum/types/fieldMetadataEnumSuccessfulAndFailingTestCases';
+import { type FieldMetadataComplexOption } from 'twenty-shared/types';
-import { type FieldMetadataComplexOption } from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
import { type EnumFieldMetadataUnionType } from 'src/engine/metadata-modules/field-metadata/utils/is-enum-field-metadata-type.util';
export const UPDATE_ENUM_FIELD_METADATA_TEST_CASES: Partial<
diff --git a/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/successful-update-one-enum-field-metadata-v2.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/successful-update-one-enum-field-metadata-v2.integration-spec.ts
index 5b3799eb0a4..be9aac79f82 100644
--- a/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/successful-update-one-enum-field-metadata-v2.integration-spec.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/successful-update-one-enum-field-metadata-v2.integration-spec.ts
@@ -8,13 +8,13 @@ import { createOneObjectMetadata } from 'test/integration/metadata/suites/object
import { deleteOneObjectMetadata } from 'test/integration/metadata/suites/object-metadata/utils/delete-one-object-metadata.util';
import { updateOneObjectMetadata } from 'test/integration/metadata/suites/object-metadata/utils/update-one-object-metadata.util';
import { eachTestingContextFilter } from 'twenty-shared/testing';
-import { FieldMetadataType } from 'twenty-shared/types';
-import { isDefined } from 'twenty-shared/utils';
-
import {
type FieldMetadataComplexOption,
type FieldMetadataDefaultOption,
-} from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
+ FieldMetadataType,
+} from 'twenty-shared/types';
+import { isDefined } from 'twenty-shared/utils';
+
import { fieldMetadataEnumTypes } from 'src/engine/metadata-modules/field-metadata/utils/is-enum-field-metadata-type.util';
describe.each(fieldMetadataEnumTypes)(
diff --git a/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/types/update-create-field-metadata-enum-test-case.ts b/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/types/update-create-field-metadata-enum-test-case.ts
index a9338acef15..527dcbb3366 100644
--- a/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/types/update-create-field-metadata-enum-test-case.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/types/update-create-field-metadata-enum-test-case.ts
@@ -1,7 +1,6 @@
import { type CreateOneFieldFactoryInput } from 'test/integration/metadata/suites/field-metadata/utils/create-one-field-metadata-query-factory.util';
import { type EachTestingContext } from 'twenty-shared/testing';
-
-import { type FieldMetadataComplexOption } from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
+import { type FieldMetadataComplexOption } from 'twenty-shared/types';
export type UpdateCreateFieldMetadataSelectTestCase = EachTestingContext<{
input: Partial<Pick<CreateOneFieldFactoryInput, 'defaultValue'>> &
diff --git a/packages/twenty-server/test/integration/metadata/suites/field-metadata/update-one-field-metadata-view-filters-side-effect-v2.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/field-metadata/update-one-field-metadata-view-filters-side-effect-v2.integration-spec.ts
index 61efafdf52f..e0a82984c89 100644
--- a/packages/twenty-server/test/integration/metadata/suites/field-metadata/update-one-field-metadata-view-filters-side-effect-v2.integration-spec.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/field-metadata/update-one-field-metadata-view-filters-side-effect-v2.integration-spec.ts
@@ -13,6 +13,8 @@ import {
type EachTestingContext,
} from 'twenty-shared/testing';
import {
+ type FieldMetadataComplexOption,
+ type FieldMetadataDefaultOption,
FieldMetadataType,
type EnumFieldMetadataType,
ViewFilterOperand,
@@ -20,10 +22,6 @@ import {
} from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
-import {
- type FieldMetadataComplexOption,
- type FieldMetadataDefaultOption,
-} from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
import { type ViewFilterValue } from 'src/engine/metadata-modules/view-filter/types/view-filter-value.type';
type Option = FieldMetadataDefaultOption | FieldMetadataComplexOption;
diff --git a/packages/twenty-server/test/integration/metadata/suites/field-metadata/update-one-field-metadata-view-groups-side-effect-v2.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/field-metadata/update-one-field-metadata-view-groups-side-effect-v2.integration-spec.ts
index d484f30c4a1..28260c4fa8e 100644
--- a/packages/twenty-server/test/integration/metadata/suites/field-metadata/update-one-field-metadata-view-groups-side-effect-v2.integration-spec.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/field-metadata/update-one-field-metadata-view-groups-side-effect-v2.integration-spec.ts
@@ -7,12 +7,12 @@ import { getMockCreateObjectInput } from 'test/integration/metadata/suites/objec
import { updateOneObjectMetadata } from 'test/integration/metadata/suites/object-metadata/utils/update-one-object-metadata.util';
import { findViewGroups } from 'test/integration/metadata/suites/view-group/utils/find-view-groups.util';
import { createOneView } from 'test/integration/metadata/suites/view/utils/create-one-view.util';
-import { FieldMetadataType, ViewType } from 'twenty-shared/types';
-
import {
type FieldMetadataComplexOption,
type FieldMetadataDefaultOption,
-} from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
+ FieldMetadataType,
+ ViewType,
+} from 'twenty-shared/types';
type Option = FieldMetadataDefaultOption | FieldMetadataComplexOption;
diff --git a/packages/twenty-server/test/integration/metadata/suites/view/update-one-view-view-groups-side-effect-v2.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/view/update-one-view-view-groups-side-effect-v2.integration-spec.ts
index 897f744a8d2..c75c8d1d04b 100644
--- a/packages/twenty-server/test/integration/metadata/suites/view/update-one-view-view-groups-side-effect-v2.integration-spec.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/view/update-one-view-view-groups-side-effect-v2.integration-spec.ts
@@ -8,16 +8,13 @@ import { findViewGroups } from 'test/integration/metadata/suites/view-group/util
import { createOneView } from 'test/integration/metadata/suites/view/utils/create-one-view.util';
import { updateOneView } from 'test/integration/metadata/suites/view/utils/update-one-view.util';
import {
+ type FieldMetadataComplexOption,
+ type FieldMetadataDefaultOption,
FieldMetadataType,
type EnumFieldMetadataType,
ViewType,
} from 'twenty-shared/types';
-import {
- type FieldMetadataComplexOption,
- type FieldMetadataDefaultOption,
-} from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
-
type Option = FieldMetadataDefaultOption | FieldMetadataComplexOption;
const generateOption = (index: number): Option => ({
diff --git a/packages/twenty-shared/src/application/fieldManifestOptionsType.ts b/packages/twenty-shared/src/application/fieldManifestOptionsType.ts
new file mode 100644
index 00000000000..994cc8a5817
--- /dev/null
+++ b/packages/twenty-shared/src/application/fieldManifestOptionsType.ts
@@ -0,0 +1,14 @@
+import {
+ type FieldMetadataComplexOption,
+ type FieldMetadataOptions,
+} from '@/types/FieldMetadataOptions';
+import { type FieldMetadataType } from '@/types/FieldMetadataType';
+import { type TagColor } from '@/types/TagColor';
+
+export type FieldManifestOptions<
+ TFieldMetadataType extends FieldMetadataType = FieldMetadataType,
+> = TFieldMetadataType extends
+ | FieldMetadataType.SELECT
+ | FieldMetadataType.MULTI_SELECT
+ ? (Omit<FieldMetadataComplexOption, 'color'> & { color?: TagColor | null })[]
+ : FieldMetadataOptions<TFieldMetadataType>;
diff --git a/packages/twenty-shared/src/application/fieldManifestType.ts b/packages/twenty-shared/src/application/fieldManifestType.ts
index 53f529e7bb8..cdfbc041743 100644
--- a/packages/twenty-shared/src/application/fieldManifestType.ts
+++ b/packages/twenty-shared/src/application/fieldManifestType.ts
@@ -1,7 +1,7 @@
+import { type FieldManifestOptions } from '@/application/fieldManifestOptionsType';
import { type SyncableEntityOptions } from '@/application/syncableEntityOptionsType';
import {
type FieldMetadataDefaultValue,
- type FieldMetadataOptions,
type FieldMetadataType,
type FieldMetadataUniversalSettings,
type MetadataWritability,
@@ -19,7 +19,7 @@ type BaseRegularFieldManifest<
label: string;
description?: string;
icon?: string;
- options?: FieldMetadataOptions<T>;
+ options?: FieldManifestOptions<T>;
universalSettings?: FieldMetadataUniversalSettings<T>;
isUIEditable?: boolean;
writability?: MetadataWritability;
diff --git a/packages/twenty-shared/src/application/index.ts b/packages/twenty-shared/src/application/index.ts
index f0c7fff8cd6..bc2a8988c29 100644
--- a/packages/twenty-shared/src/application/index.ts
+++ b/packages/twenty-shared/src/application/index.ts
@@ -128,6 +128,7 @@ export type {
JobStatusResult,
} from './enqueueJobType';
export { SyncableEntity } from './enums/syncable-entities.enum';
+export type { FieldManifestOptions } from './fieldManifestOptionsType';
export type {
RegularFieldManifest,
RelationFieldManifest,
diff --git a/packages/twenty-shared/src/constants/DefaultSelectOptionColor.ts b/packages/twenty-shared/src/constants/DefaultSelectOptionColor.ts
new file mode 100644
index 00000000000..0666daa8b52
--- /dev/null
+++ b/packages/twenty-shared/src/constants/DefaultSelectOptionColor.ts
@@ -0,0 +1,3 @@
+import { type TagColor } from '@/types/TagColor';
+
+export const DEFAULT_SELECT_OPTION_COLOR: TagColor = 'gray';
diff --git a/packages/twenty-shared/src/constants/TagColors.ts b/packages/twenty-shared/src/constants/TagColors.ts
new file mode 100644
index 00000000000..d82039fc3d6
--- /dev/null
+++ b/packages/twenty-shared/src/constants/TagColors.ts
@@ -0,0 +1,27 @@
+export const TAG_COLORS = [
+ 'red',
+ 'ruby',
+ 'crimson',
+ 'tomato',
+ 'orange',
+ 'amber',
+ 'yellow',
+ 'lime',
+ 'grass',
+ 'green',
+ 'jade',
+ 'mint',
+ 'turquoise',
+ 'cyan',
+ 'sky',
+ 'blue',
+ 'iris',
+ 'violet',
+ 'purple',
+ 'plum',
+ 'pink',
+ 'bronze',
+ 'gold',
+ 'brown',
+ 'gray',
+] as const;
diff --git a/packages/twenty-shared/src/constants/index.ts b/packages/twenty-shared/src/constants/index.ts
index ee3f65b5c35..2956d236c41 100644
--- a/packages/twenty-shared/src/constants/index.ts
+++ b/packages/twenty-shared/src/constants/index.ts
@@ -19,6 +19,7 @@ export { CURRENCY_CODE_LABELS } from './CurrencyCodeLabels';
export { DATE_TYPE_FORMAT } from './DateTypeFormat';
export { DEFAULT_NUMBER_OF_GROUPS_LIMIT } from './DefaultNumberOfGroupsLimit';
export { DEFAULT_RELATIVE_DATE_FILTER_VALUE } from './DefaultRelativeDateFilterValue';
+export { DEFAULT_SELECT_OPTION_COLOR } from './DefaultSelectOptionColor';
export { DEFAULT_VISIBLE_ADDRESS_SUBFIELDS } from './DefaultVisibleAddressSubfields';
export { DEFAULT_WIDGET_SIZE } from './DefaultWidgetSize';
export { DOCUMENTATION_BASE_URL } from './DocumentationBaseUrl';
@@ -66,6 +67,7 @@ export { RESERVED_SUBDOMAINS } from './ReservedSubdomains';
export { STANDARD_OBJECT_RECORDS_UNDER_OBJECT_RECORDS_PERMISSIONS } from './StandardObjectRecordsUnderObjectRecordsPermissions';
export { SUBDOMAIN_PATTERN } from './SubdomainPattern';
export { SystemPermissionFlag } from './SystemPermissionFlag';
+export { TAG_COLORS } from './TagColors';
export { TWENTY_COMPANIES_BASE_URL } from './TwentyCompaniesBaseUrl';
export { TWENTY_ICONS_BASE_URL } from './TwentyIconsBaseUrl';
export { UI_SCALE_VALUES } from './UiScaleValues';
diff --git a/packages/twenty-shared/src/types/FieldMetadataOptions.ts b/packages/twenty-shared/src/types/FieldMetadataOptions.ts
index 7ea908fd321..2606f0dae0d 100644
--- a/packages/twenty-shared/src/types/FieldMetadataOptions.ts
+++ b/packages/twenty-shared/src/types/FieldMetadataOptions.ts
@@ -1,32 +1,6 @@
import { type FieldMetadataType } from '@/types/FieldMetadataType';
import { type IsExactly } from '@/types/IsExactly';
-
-export type TagColor =
- | 'red'
- | 'ruby'
- | 'crimson'
- | 'tomato'
- | 'orange'
- | 'amber'
- | 'yellow'
- | 'lime'
- | 'grass'
- | 'green'
- | 'jade'
- | 'mint'
- | 'turquoise'
- | 'cyan'
- | 'sky'
- | 'blue'
- | 'iris'
- | 'violet'
- | 'purple'
- | 'plum'
- | 'pink'
- | 'bronze'
- | 'gold'
- | 'brown'
- | 'gray';
+import { type TagColor } from '@/types/TagColor';
export class FieldMetadataDefaultOption {
id?: string;
diff --git a/packages/twenty-shared/src/types/TagColor.ts b/packages/twenty-shared/src/types/TagColor.ts
new file mode 100644
index 00000000000..c093e097b53
--- /dev/null
+++ b/packages/twenty-shared/src/types/TagColor.ts
@@ -0,0 +1,3 @@
+import { type TAG_COLORS } from '@/constants/TagColors';
+
+export type TagColor = (typeof TAG_COLORS)[number];
diff --git a/packages/twenty-shared/src/types/index.ts b/packages/twenty-shared/src/types/index.ts
index 81dec7ac0ae..6e2dbc4e68b 100644
--- a/packages/twenty-shared/src/types/index.ts
+++ b/packages/twenty-shared/src/types/index.ts
@@ -114,7 +114,6 @@ export {
export type { FieldMetadataMultiItemSettings } from './FieldMetadataMultiItemSettings';
export { FieldMetadataSettingsOnClickAction } from './FieldMetadataMultiItemSettings';
export type {
- TagColor,
FieldMetadataOptionForAnyType,
FieldMetadataOptions,
} from './FieldMetadataOptions';
@@ -327,6 +326,7 @@ export type {
StepFilterWithPotentiallyDeprecatedOperand,
} from './StepFilters';
export { StepLogicalOperator } from './StepFilters';
+export type { TagColor } from './TagColor';
export { TwoFactorAuthenticationStrategy } from './TwoFactorAuthenticationStrategy';
export { UpgradeHealthEnum } from './UpgradeHealthEnum';
export { IsValidGraphQLEnumName } from './validators/is-valid-graphql-enum-name.validator';
diff --git a/packages/twenty-shared/src/utils/index.ts b/packages/twenty-shared/src/utils/index.ts
index 085bc3b2b5d..3671233ac62 100644
--- a/packages/twenty-shared/src/utils/index.ts
+++ b/packages/twenty-shared/src/utils/index.ts
@@ -309,6 +309,7 @@ export { isImageIdentifierFieldMetadataType } from './validation/isImageIdentifi
export { isLabelIdentifierFieldMetadataTypes } from './validation/isLabelIdentifierFieldMetadataTypes';
export type { SearchableFieldType } from './validation/isSearchableFieldType';
export { isSearchableFieldType } from './validation/isSearchableFieldType';
+export { isTagColor } from './validation/isTagColor';
export { isValidLocale } from './validation/isValidLocale';
export { isValidTwentySubdomain } from './validation/isValidTwentySubdomain';
export { isValidUuid } from './validation/isValidUuid';
diff --git a/packages/twenty-shared/src/utils/validation/__tests__/isTagColor.test.ts b/packages/twenty-shared/src/utils/validation/__tests__/isTagColor.test.ts
new file mode 100644
index 00000000000..91b04878f2b
--- /dev/null
+++ b/packages/twenty-shared/src/utils/validation/__tests__/isTagColor.test.ts
@@ -0,0 +1,14 @@
+import { isTagColor } from '@/utils';
+
+describe('isTagColor', () => {
+ it.each(['gray', 'blue', 'turquoise'])('accepts %s', (color) => {
+ expect(isTagColor(color)).toBe(true);
+ });
+
+ it.each([undefined, null, '', 'grey', 'Blue', ' blue', 42])(
+ 'rejects %p',
+ (value) => {
+ expect(isTagColor(value)).toBe(false);
+ },
+ );
+});
diff --git a/packages/twenty-shared/src/utils/validation/isTagColor.ts b/packages/twenty-shared/src/utils/validation/isTagColor.ts
new file mode 100644
index 00000000000..9328f3018ac
--- /dev/null
+++ b/packages/twenty-shared/src/utils/validation/isTagColor.ts
@@ -0,0 +1,5 @@
+import { TAG_COLORS } from '@/constants/TagColors';
+import { type TagColor } from '@/types/TagColor';
+
+export const isTagColor = (value: unknown): value is TagColor =>
+ TAG_COLORS.includes(value as TagColor);