refactor: validate objectMetadataItem with Zod on creation and update… (#4270)

* refactor: validate objectMetadataItem with Zod on creation and update & remove logic from useObjectMetadataItemForSettings

* refactor: review

packages/twenty-front/src/modules/object-metadata/validation-schemas/__tests__/objectMetadataItemSchema.test.ts

@@ -0,0 +1,48 @@
+import { SafeParseSuccess } from 'zod';
+
+import { ObjectMetadataItem } from '@/object-metadata/types/ObjectMetadataItem';
+import { mockedCompanyObjectMetadataItem } from '@/object-record/record-field/__mocks__/fieldDefinitions';
+
+import { objectMetadataItemSchema } from '../objectMetadataItemSchema';
+
+describe('objectMetadataItemSchema', () => {
+  it('validates a valid object metadata item', () => {
+    // Given
+    const validObjectMetadataItem = mockedCompanyObjectMetadataItem;
+
+    // When
+    const result = objectMetadataItemSchema.safeParse(validObjectMetadataItem);
+
+    // Then
+    expect(result.success).toBe(true);
+    expect((result as SafeParseSuccess<ObjectMetadataItem>).data).toEqual(
+      validObjectMetadataItem,
+    );
+  });
+
+  it('fails for an invalid object metadata item', () => {
+    // Given
+    const invalidObjectMetadataItem = {
+      createdAt: 'invalid date',
+      dataSourceId: 'invalid uuid',
+      fields: 'not an array',
+      icon: 'invalid icon',
+      isActive: 'not a boolean',
+      isCustom: 'not a boolean',
+      isSystem: 'not a boolean',
+      labelPlural: 123,
+      labelSingular: 123,
+      namePlural: 'notCamelCase',
+      nameSingular: 'notCamelCase',
+      updatedAt: 'invalid date',
+    };
+
+    // When
+    const result = objectMetadataItemSchema.safeParse(
+      invalidObjectMetadataItem,
+    );
+
+    // Then
+    expect(result.success).toBe(false);
+  });
+});

packages/twenty-front/src/modules/object-metadata/validation-schemas/fieldMetadataItemSchema.ts

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+
+import { FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';
+
+// TODO: implement fieldMetadataItemSchema
+export const fieldMetadataItemSchema: z.ZodType<FieldMetadataItem> = z.any();

packages/twenty-front/src/modules/object-metadata/validation-schemas/objectMetadataItemSchema.ts

@@ -0,0 +1,25 @@
+import { z } from 'zod';
+
+import { ObjectMetadataItem } from '@/object-metadata/types/ObjectMetadataItem';
+import { fieldMetadataItemSchema } from '@/object-metadata/validation-schemas/fieldMetadataItemSchema';
+import { camelCaseStringSchema } from '~/utils/validation-schemas/camelCaseStringSchema';
+
+export const objectMetadataItemSchema = z.object({
+  __typename: z.literal('object').optional(),
+  createdAt: z.string().datetime(),
+  dataSourceId: z.string().uuid(),
+  description: z.string().trim().nullable().optional(),
+  fields: z.array(fieldMetadataItemSchema),
+  icon: z.string().startsWith('Icon').trim(),
+  id: z.string().uuid(),
+  imageIdentifierFieldMetadataId: z.string().uuid().nullable(),
+  isActive: z.boolean(),
+  isCustom: z.boolean(),
+  isSystem: z.boolean(),
+  labelIdentifierFieldMetadataId: z.string().uuid().nullable(),
+  labelPlural: z.string().trim().min(1),
+  labelSingular: z.string().trim().min(1),
+  namePlural: camelCaseStringSchema,
+  nameSingular: camelCaseStringSchema,
+  updatedAt: z.string().datetime(),
+}) satisfies z.ZodType<ObjectMetadataItem>;