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/hooks/__mocks__/useCreateOneObjectMetadataItem.ts

@@ -24,6 +24,7 @@ export const query = gql`
 export const variables = {
   input: {
     object: {
+      icon: 'IconPlus',
       labelPlural: 'View Filters',
       labelSingular: 'View Filter',
       nameSingular: 'viewFilter',

packages/twenty-front/src/modules/object-metadata/hooks/__tests__/useCreateOneObjectMetadataItem.test.tsx

@@ -3,14 +3,14 @@ import { MockedProvider } from '@apollo/client/testing';
 import { act, renderHook } from '@testing-library/react';
 import { RecoilRoot } from 'recoil';
 
-import { useCreateOneObjectRecordMetadataItem } from '@/object-metadata/hooks/useCreateOneObjectMetadataItem';
+import { useCreateOneObjectMetadataItem } from '@/object-metadata/hooks/useCreateOneObjectMetadataItem';
 
 import { TestApolloMetadataClientProvider } from '../__mocks__/ApolloMetadataClientProvider';
 import {
   query,
   responseData,
   variables,
-} from '../__mocks__/useCreateOneObjectRecordMetadataItem';
+} from '../__mocks__/useCreateOneObjectMetadataItem';
 
 const mocks = [
   {
@@ -36,21 +36,19 @@ const Wrapper = ({ children }: { children: ReactNode }) => (
   </RecoilRoot>
 );
 
-describe('useCreateOneObjectRecordMetadataItem', () => {
+describe('useCreateOneObjectMetadataItem', () => {
   it('should work as expected', async () => {
-    const { result } = renderHook(
-      () => useCreateOneObjectRecordMetadataItem(),
-      {
-        wrapper: Wrapper,
-      },
-    );
+    const { result } = renderHook(() => useCreateOneObjectMetadataItem(), {
+      wrapper: Wrapper,
+    });
 
     await act(async () => {
       const res = await result.current.createOneObjectMetadataItem({
+        icon: 'IconPlus',
         labelPlural: 'View Filters',
         labelSingular: 'View Filter',
-        nameSingular: 'viewFilter',
         namePlural: 'viewFilters',
+        nameSingular: 'viewFilter',
       });
 
       expect(res.data).toEqual({ createOneObject: responseData });

packages/twenty-front/src/modules/object-metadata/hooks/__tests__/useObjectMetadataItemForSettings.test.tsx

@@ -103,28 +103,4 @@ describe('useObjectMetadataItemForSettings', () => {
       expect(res?.namePlural).toBe('opportunities');
     });
   });
-
-  it('should editObjectMetadataItem', async () => {
-    const { result } = renderHook(
-      () => {
-        const setMetadataItems = useSetRecoilState(objectMetadataItemsState);
-        setMetadataItems(mockObjectMetadataItems);
-
-        return useObjectMetadataItemForSettings();
-      },
-      {
-        wrapper: Wrapper,
-      },
-    );
-
-    await act(async () => {
-      const res = await result.current.editObjectMetadataItem({
-        id: 'idToUpdate',
-        description: 'newDescription',
-        labelPlural: 'labelPlural',
-        labelSingular: 'labelSingular',
-      });
-      expect(res.data).toEqual({ updateOneObject: responseData });
-    });
-  });
 });

packages/twenty-front/src/modules/object-metadata/hooks/useCreateOneObjectMetadataItem.ts

@@ -2,6 +2,7 @@ import { ApolloClient, useMutation } from '@apollo/client';
 import { getOperationName } from '@apollo/client/utilities';
 
 import {
+  CreateObjectInput,
   CreateOneObjectMetadataItemMutation,
   CreateOneObjectMetadataItemMutationVariables,
 } from '~/generated-metadata/graphql';
@@ -11,7 +12,7 @@ import { FIND_MANY_OBJECT_METADATA_ITEMS } from '../graphql/queries';
 
 import { useApolloMetadataClient } from './useApolloMetadataClient';
 
-export const useCreateOneObjectRecordMetadataItem = () => {
+export const useCreateOneObjectMetadataItem = () => {
   const apolloMetadataClient = useApolloMetadataClient();
 
   const [mutate] = useMutation<
@@ -21,16 +22,10 @@ export const useCreateOneObjectRecordMetadataItem = () => {
     client: apolloMetadataClient ?? ({} as ApolloClient<any>),
   });
 
-  const createOneObjectMetadataItem = async (
-    input: CreateOneObjectMetadataItemMutationVariables['input']['object'],
-  ) => {
+  const createOneObjectMetadataItem = async (input: CreateObjectInput) => {
     return await mutate({
       variables: {
-        input: {
-          object: {
-            ...input,
-          },
-        },
+        input: { object: input },
       },
       awaitRefetchQueries: true,
       refetchQueries: [getOperationName(FIND_MANY_OBJECT_METADATA_ITEMS) ?? ''],

packages/twenty-front/src/modules/object-metadata/hooks/useObjectMetadataItemForSettings.ts

@@ -2,14 +2,8 @@ import { useRecoilValue } from 'recoil';
 
 import { objectMetadataItemsState } from '@/object-metadata/states/objectMetadataItemsState';
 
-import { ObjectMetadataItem } from '../types/ObjectMetadataItem';
-import { formatObjectMetadataItemInput } from '../utils/formatObjectMetadataItemInput';
 import { getObjectSlug } from '../utils/getObjectSlug';
 
-import { useCreateOneObjectRecordMetadataItem } from './useCreateOneObjectMetadataItem';
-import { useDeleteOneObjectMetadataItem } from './useDeleteOneObjectMetadataItem';
-import { useUpdateOneObjectMetadataItem } from './useUpdateOneObjectMetadataItem';
-
 export const useObjectMetadataItemForSettings = () => {
   const objectMetadataItems = useRecoilValue(objectMetadataItemsState);
 
@@ -36,65 +30,12 @@ export const useObjectMetadataItemForSettings = () => {
       (objectMetadataItem) => objectMetadataItem.namePlural === namePlural,
     );
 
-  const { createOneObjectMetadataItem } =
-    useCreateOneObjectRecordMetadataItem();
-  const { updateOneObjectMetadataItem } = useUpdateOneObjectMetadataItem();
-  const { deleteOneObjectMetadataItem } = useDeleteOneObjectMetadataItem();
-
-  const createObjectMetadataItem = (
-    input: Pick<
-      ObjectMetadataItem,
-      'labelPlural' | 'labelSingular' | 'icon' | 'description'
-    >,
-  ) => createOneObjectMetadataItem(formatObjectMetadataItemInput(input));
-
-  const editObjectMetadataItem = (
-    input: Pick<
-      ObjectMetadataItem,
-      | 'description'
-      | 'icon'
-      | 'id'
-      | 'labelIdentifierFieldMetadataId'
-      | 'labelPlural'
-      | 'labelSingular'
-    >,
-  ) =>
-    updateOneObjectMetadataItem({
-      idToUpdate: input.id,
-      updatePayload: formatObjectMetadataItemInput(input),
-    });
-
-  const activateObjectMetadataItem = (
-    objectMetadataItem: Pick<ObjectMetadataItem, 'id'>,
-  ) =>
-    updateOneObjectMetadataItem({
-      idToUpdate: objectMetadataItem.id,
-      updatePayload: { isActive: true },
-    });
-
-  const disableObjectMetadataItem = (
-    objectMetadataItem: Pick<ObjectMetadataItem, 'id'>,
-  ) =>
-    updateOneObjectMetadataItem({
-      idToUpdate: objectMetadataItem.id,
-      updatePayload: { isActive: false },
-    });
-
-  const eraseObjectMetadataItem = (
-    objectMetadataItem: Pick<ObjectMetadataItem, 'id'>,
-  ) => deleteOneObjectMetadataItem(objectMetadataItem.id);
-
   return {
-    activateObjectMetadataItem,
     activeObjectMetadataItems,
-    createObjectMetadataItem,
-    inactiveObjectMetadataItems,
-    disableObjectMetadataItem,
-    editObjectMetadataItem,
-    eraseObjectMetadataItem,
     findActiveObjectMetadataItemBySlug,
     findObjectMetadataItemById,
     findObjectMetadataItemByNamePlural,
+    inactiveObjectMetadataItems,
     objectMetadataItems,
   };
 };

packages/twenty-front/src/modules/object-metadata/hooks/useUpdateOneObjectMetadataItem.ts

@@ -2,6 +2,7 @@ import { useMutation } from '@apollo/client';
 import { getOperationName } from '@apollo/client/utilities';
 
 import {
+  UpdateObjectInput,
   UpdateOneObjectMetadataItemMutation,
   UpdateOneObjectMetadataItemMutationVariables,
 } from '~/generated-metadata/graphql';
@@ -27,16 +28,7 @@ export const useUpdateOneObjectMetadataItem = () => {
     updatePayload,
   }: {
     idToUpdate: UpdateOneObjectMetadataItemMutationVariables['idToUpdate'];
-    updatePayload: Pick<
-      UpdateOneObjectMetadataItemMutationVariables['updatePayload'],
-      | 'description'
-      | 'icon'
-      | 'isActive'
-      | 'labelPlural'
-      | 'labelSingular'
-      | 'namePlural'
-      | 'nameSingular'
-    >;
+    updatePayload: UpdateObjectInput;
   }) => {
     return await mutate({
       variables: {