refactor: merge FieldType and FieldMetadataType

twentyhq · Mar 25, 2024 · dac5253 · dac5253
1 parent 9e70f5b
commit dac5253
Show file tree

Hide file tree

Showing 27 changed files with 72 additions and 107 deletions.
diff --git a/packages/twenty-front/src/modules/object-metadata/hooks/useCreateOneFieldMetadataItem.ts b/packages/twenty-front/src/modules/object-metadata/hooks/useCreateOneFieldMetadataItem.ts
@@ -1,25 +1,17 @@
 import { ApolloClient, useMutation } from '@apollo/client';
 import { getOperationName } from '@apollo/client/utilities';
 
-import { FieldType } from '@/object-record/record-field/types/FieldType';
 import {
+  CreateFieldInput,
   CreateOneFieldMetadataItemMutation,
   CreateOneFieldMetadataItemMutationVariables,
-  FieldMetadataType,
 } from '~/generated-metadata/graphql';
 
 import { CREATE_ONE_FIELD_METADATA_ITEM } from '../graphql/mutations';
 import { FIND_MANY_OBJECT_METADATA_ITEMS } from '../graphql/queries';
 
 import { useApolloMetadataClient } from './useApolloMetadataClient';
 
-type CreateOneFieldMetadataItemArgs = Omit<
-  CreateOneFieldMetadataItemMutationVariables['input']['field'],
-  'type'
-> & {
-  type: FieldType;
-};
-
 export const useCreateOneFieldMetadataItem = () => {
   const apolloMetadataClient = useApolloMetadataClient();
 
@@ -30,16 +22,11 @@ export const useCreateOneFieldMetadataItem = () => {
     client: apolloMetadataClient ?? ({} as ApolloClient<any>),
   });
 
-  const createOneFieldMetadataItem = async (
-    input: CreateOneFieldMetadataItemArgs,
-  ) => {
+  const createOneFieldMetadataItem = async (input: CreateFieldInput) => {
     return await mutate({
       variables: {
         input: {
-          field: {
-            ...input,
-            type: input.type as FieldMetadataType, // Todo improve typing once we have aligned backend and frontend
-          },
+          field: input,
         },
       },
       awaitRefetchQueries: true,

diff --git a/packages/twenty-front/src/modules/object-metadata/hooks/useFieldMetadataItem.ts b/packages/twenty-front/src/modules/object-metadata/hooks/useFieldMetadataItem.ts
@@ -1,6 +1,5 @@
 import { v4 } from 'uuid';
 
-import { FieldType } from '@/object-record/record-field/types/FieldType';
 import { Field } from '~/generated/graphql';
 import { FieldMetadataType } from '~/generated-metadata/graphql';
 
@@ -29,7 +28,7 @@ export const useFieldMetadataItem = () => {
       ...formatFieldMetadataItemInput(input),
       defaultValue: input.defaultValue,
       objectMetadataId: input.objectMetadataId,
-      type: input.type as FieldType,
+      type: input.type,
     });
 
   const editMetadataField = (

diff --git a/...wenty-front/src/modules/object-metadata/utils/formatFieldMetadataItemAsFieldDefinition.ts b/...wenty-front/src/modules/object-metadata/utils/formatFieldMetadataItemAsFieldDefinition.ts
@@ -3,8 +3,6 @@ import { parseFieldRelationType } from '@/object-metadata/utils/parseFieldRelati
 
 import { FieldMetadataItem } from '../types/FieldMetadataItem';
 
-import { parseFieldType } from './parseFieldType';
-
 export type FieldMetadataItemAsFieldDefinitionProps = {
   field: FieldMetadataItem;
   objectMetadataItem: ObjectMetadataItem;
@@ -31,7 +29,7 @@ export const formatFieldMetadataItemAsFieldDefinition = ({
     label: field.label,
     showLabel,
     labelWidth,
-    type: parseFieldType(field.type),
+    type: field.type,
     metadata: {
       fieldName: field.name,
       placeHolder: field.label,

diff --git a/packages/twenty-front/src/modules/object-metadata/utils/parseFieldType.ts b/packages/twenty-front/src/modules/object-metadata/utils/parseFieldType.ts
diff --git a/packages/twenty-front/src/modules/object-metadata/utils/shouldFieldBeQueried.ts b/packages/twenty-front/src/modules/object-metadata/utils/shouldFieldBeQueried.ts
@@ -1,6 +1,6 @@
 import { isUndefined } from '@sniptt/guards';
 
-import { FieldType } from '@/object-record/record-field/types/FieldType';
+import { FieldMetadataType } from '~/generated-metadata/graphql';
 
 import { FieldMetadataItem } from '../types/FieldMetadataItem';
 
@@ -13,18 +13,20 @@ export const shouldFieldBeQueried = ({
   depth?: number;
   eagerLoadedRelations?: Record<string, boolean>;
 }): any => {
-  const fieldType = field.type as FieldType;
-
   if (!isUndefined(depth) && depth < 0) {
     return false;
   }
 
-  if (!isUndefined(depth) && depth < 1 && fieldType === 'RELATION') {
+  if (
+    !isUndefined(depth) &&
+    depth < 1 &&
+    field.type === FieldMetadataType.Relation
+  ) {
     return false;
   }
 
   if (
-    fieldType === 'RELATION' &&
+    field.type === FieldMetadataType.Relation &&
     !isUndefined(eagerLoadedRelations) &&
     (isUndefined(eagerLoadedRelations[field.name]) ||
       !eagerLoadedRelations[field.name])

diff --git a/packages/twenty-front/src/modules/object-record/record-field/__mocks__/fieldDefinitions.ts b/packages/twenty-front/src/modules/object-record/record-field/__mocks__/fieldDefinitions.ts
@@ -7,6 +7,7 @@ import {
   FieldSelectMetadata,
   FieldTextMetadata,
 } from '@/object-record/record-field/types/FieldMetadata';
+import { FieldMetadataType } from '~/generated-metadata/graphql';
 import {
   mockedCompaniesMetadata,
   mockedCustomMetadata,
@@ -34,7 +35,7 @@ export const textfieldDefinition: FieldDefinition<FieldTextMetadata> = {
   fieldMetadataId,
   label: 'User Name',
   iconName: 'User',
-  type: 'TEXT',
+  type: FieldMetadataType.Text,
   metadata: { placeHolder: 'John Doe', fieldName: 'userName' },
 };
 
@@ -52,7 +53,7 @@ export const selectFieldDefinition: FieldDefinition<FieldSelectMetadata> = {
   fieldMetadataId,
   label: 'Account Owner',
   iconName: 'iconName',
-  type: 'SELECT',
+  type: FieldMetadataType.Select,
   metadata: {
     fieldName: 'accountOwner',
     options: [{ label: 'Elon Musk', color: 'blue', value: 'userId' }],
@@ -63,7 +64,7 @@ export const fullNameFieldDefinition: FieldDefinition<FieldFullNameMetadata> = {
   fieldMetadataId,
   label: 'Display Name',
   iconName: 'profile',
-  type: 'FULL_NAME',
+  type: FieldMetadataType.FullName,
   metadata: {
     fieldName: 'displayName',
     placeHolder: 'Mr Miagi',
@@ -74,7 +75,7 @@ export const linkFieldDefinition: FieldDefinition<FieldLinkMetadata> = {
   fieldMetadataId,
   label: 'LinkedIn URL',
   iconName: 'url',
-  type: 'LINK',
+  type: FieldMetadataType.Link,
   metadata: {
     fieldName: 'linkedInURL',
     placeHolder: 'https://linkedin.com/user',
@@ -93,7 +94,7 @@ export const ratingfieldDefinition: FieldDefinition<FieldRatingMetadata> = {
   fieldMetadataId,
   label: 'Rating',
   iconName: 'iconName',
-  type: 'RATING',
+  type: FieldMetadataType.Rating,
   metadata: {
     fieldName: 'rating',
   },

diff --git a/...ecord/record-field/meta-types/display/components/__stories__/ChipFieldDisplay.stories.tsx b/...ecord/record-field/meta-types/display/components/__stories__/ChipFieldDisplay.stories.tsx
@@ -5,6 +5,7 @@ import { useSetRecoilState } from 'recoil';
 import { FieldContext } from '@/object-record/record-field/contexts/FieldContext';
 import { ChipFieldDisplay } from '@/object-record/record-field/meta-types/display/components/ChipFieldDisplay';
 import { recordStoreFamilyState } from '@/object-record/record-store/states/recordStoreFamilyState';
+import { FieldMetadataType } from '~/generated/graphql';
 import { ComponentDecorator } from '~/testing/decorators/ComponentDecorator';
 import { MemoryRouterDecorator } from '~/testing/decorators/MemoryRouterDecorator';
 
@@ -37,7 +38,7 @@ const meta: Meta = {
           fieldDefinition: {
             fieldMetadataId: 'full name',
             label: 'Henry Cavill',
-            type: 'FULL_NAME',
+            type: FieldMetadataType.FullName,
             iconName: 'IconCalendarEvent',
             metadata: {
               fieldName: 'full name',

diff --git a/...ecord/record-field/meta-types/display/components/__stories__/DateFieldDisplay.stories.tsx b/...ecord/record-field/meta-types/display/components/__stories__/DateFieldDisplay.stories.tsx
@@ -1,6 +1,7 @@
 import { useEffect } from 'react';
 import { Meta, StoryObj } from '@storybook/react';
 
+import { FieldMetadataType } from '~/generated/graphql';
 import { ComponentDecorator } from '~/testing/decorators/ComponentDecorator';
 
 import { FieldContext } from '../../../../contexts/FieldContext';
@@ -30,7 +31,7 @@ const meta: Meta = {
           fieldDefinition: {
             fieldMetadataId: 'date',
             label: 'Date',
-            type: 'DATE_TIME',
+            type: FieldMetadataType.DateTime,
             iconName: 'IconCalendarEvent',
             metadata: {
               fieldName: 'Date',

diff --git a/...cord/record-field/meta-types/display/components/__stories__/EmailFieldDisplay.stories.tsx b/...cord/record-field/meta-types/display/components/__stories__/EmailFieldDisplay.stories.tsx
@@ -3,6 +3,7 @@ import { Meta, StoryObj } from '@storybook/react';
 
 import { FieldContext } from '@/object-record/record-field/contexts/FieldContext';
 import { useEmailField } from '@/object-record/record-field/meta-types/hooks/useEmailField';
+import { FieldMetadataType } from '~/generated/graphql';
 import { ComponentDecorator } from '~/testing/decorators/ComponentDecorator';
 import { MemoryRouterDecorator } from '~/testing/decorators/MemoryRouterDecorator';
 
@@ -30,7 +31,7 @@ const meta: Meta = {
           fieldDefinition: {
             fieldMetadataId: 'email',
             label: 'Email',
-            type: 'EMAIL',
+            type: FieldMetadataType.Email,
             iconName: 'IconLink',
             metadata: {
               fieldName: 'Email',

diff --git a/...ord/record-field/meta-types/display/components/__stories__/NumberFieldDisplay.stories.tsx b/...ord/record-field/meta-types/display/components/__stories__/NumberFieldDisplay.stories.tsx
@@ -1,6 +1,7 @@
 import { useEffect } from 'react';
 import { Meta, StoryObj } from '@storybook/react';
 
+import { FieldMetadataType } from '~/generated/graphql';
 import { ComponentDecorator } from '~/testing/decorators/ComponentDecorator';
 
 import { FieldContext } from '../../../../contexts/FieldContext';
@@ -28,7 +29,7 @@ const meta: Meta = {
           fieldDefinition: {
             fieldMetadataId: 'number',
             label: 'Number',
-            type: 'NUMBER',
+            type: FieldMetadataType.Number,
             iconName: 'Icon123',
             metadata: {
               fieldName: 'Number',

diff --git a/...cord/record-field/meta-types/display/components/__stories__/PhoneFieldDisplay.stories.tsx b/...cord/record-field/meta-types/display/components/__stories__/PhoneFieldDisplay.stories.tsx
@@ -3,6 +3,7 @@ import { Meta, StoryObj } from '@storybook/react';
 
 import { FieldContext } from '@/object-record/record-field/contexts/FieldContext';
 import { usePhoneField } from '@/object-record/record-field/meta-types/hooks/usePhoneField';
+import { FieldMetadataType } from '~/generated/graphql';
 import { ComponentDecorator } from '~/testing/decorators/ComponentDecorator';
 import { MemoryRouterDecorator } from '~/testing/decorators/MemoryRouterDecorator';
 
@@ -30,7 +31,7 @@ const meta: Meta = {
           fieldDefinition: {
             fieldMetadataId: 'phone',
             label: 'Phone',
-            type: 'TEXT',
+            type: FieldMetadataType.Text,
             iconName: 'IconPhone',
             metadata: {
               fieldName: 'phone',

diff --git a/...ecord/record-field/meta-types/display/components/__stories__/TextFieldDisplay.stories.tsx b/...ecord/record-field/meta-types/display/components/__stories__/TextFieldDisplay.stories.tsx
@@ -1,6 +1,7 @@
 import { useEffect } from 'react';
 import { Meta, StoryObj } from '@storybook/react';
 
+import { FieldMetadataType } from '~/generated/graphql';
 import { ComponentDecorator } from '~/testing/decorators/ComponentDecorator';
 
 import { FieldContext } from '../../../../contexts/FieldContext';
@@ -28,7 +29,7 @@ const meta: Meta = {
           fieldDefinition: {
             fieldMetadataId: 'text',
             label: 'Text',
-            type: 'TEXT',
+            type: FieldMetadataType.Text,
             iconName: 'IconLink',
             metadata: {
               fieldName: 'Text',

diff --git a/...record/record-field/meta-types/input/components/__stories__/BooleanFieldInput.stories.tsx b/...record/record-field/meta-types/input/components/__stories__/BooleanFieldInput.stories.tsx
@@ -4,6 +4,7 @@ import { expect, fn, userEvent, within } from '@storybook/test';
 import { useSetRecoilState } from 'recoil';
 
 import { recordStoreFamilyState } from '@/object-record/record-store/states/recordStoreFamilyState';
+import { FieldMetadataType } from '~/generated/graphql';
 
 import { FieldContextProvider } from '../../../__stories__/FieldContextProvider';
 import {
@@ -43,7 +44,7 @@ const BooleanFieldInputWithContext = ({
         fieldMetadataId: 'boolean',
         label: 'Boolean',
         iconName: 'Icon123',
-        type: 'BOOLEAN',
+        type: FieldMetadataType.Boolean,
         metadata: {
           fieldName: 'Boolean',
         },

diff --git a/...ct-record/record-field/meta-types/input/components/__stories__/DateFieldInput.stories.tsx b/...ct-record/record-field/meta-types/input/components/__stories__/DateFieldInput.stories.tsx
@@ -3,6 +3,7 @@ import { Meta, StoryObj } from '@storybook/react';
 import { expect, fn, userEvent, within } from '@storybook/test';
 
 import { useSetHotkeyScope } from '@/ui/utilities/hotkey/hooks/useSetHotkeyScope';
+import { FieldMetadataType } from '~/generated/graphql';
 
 import { FieldContextProvider } from '../../../__stories__/FieldContextProvider';
 import { useDateTimeField } from '../../../hooks/useDateTimeField';
@@ -44,7 +45,7 @@ const DateFieldInputWithContext = ({
         fieldDefinition={{
           fieldMetadataId: 'date',
           label: 'Date',
-          type: 'DATE_TIME',
+          type: FieldMetadataType.DateTime,
           iconName: 'IconCalendarEvent',
           metadata: {
             fieldName: 'Date',

diff --git a/...t-record/record-field/meta-types/input/components/__stories__/EmailFieldInput.stories.tsx b/...t-record/record-field/meta-types/input/components/__stories__/EmailFieldInput.stories.tsx
@@ -3,6 +3,7 @@ import { Decorator, Meta, StoryObj } from '@storybook/react';
 import { expect, fn, userEvent, waitFor, within } from '@storybook/test';
 
 import { useSetHotkeyScope } from '@/ui/utilities/hotkey/hooks/useSetHotkeyScope';
+import { FieldMetadataType } from '~/generated/graphql';
 
 import { FieldContextProvider } from '../../../__stories__/FieldContextProvider';
 import { useEmailField } from '../../../hooks/useEmailField';
@@ -44,7 +45,7 @@ const EmailFieldInputWithContext = ({
         fieldDefinition={{
           fieldMetadataId: 'email',
           label: 'Email',
-          type: 'EMAIL',
+          type: FieldMetadataType.Email,
           iconName: 'IconLink',
           metadata: {
             fieldName: 'email',

diff --git a/...-record/record-field/meta-types/input/components/__stories__/NumberFieldInput.stories.tsx b/...-record/record-field/meta-types/input/components/__stories__/NumberFieldInput.stories.tsx
@@ -3,6 +3,7 @@ import { Decorator, Meta, StoryObj } from '@storybook/react';
 import { expect, fn, userEvent, waitFor, within } from '@storybook/test';
 
 import { useSetHotkeyScope } from '@/ui/utilities/hotkey/hooks/useSetHotkeyScope';
+import { FieldMetadataType } from '~/generated/graphql';
 
 import { FieldContextProvider } from '../../../__stories__/FieldContextProvider';
 import { useNumberField } from '../../../hooks/useNumberField';
@@ -45,7 +46,7 @@ const NumberFieldInputWithContext = ({
           fieldMetadataId: 'number',
           label: 'Number',
           iconName: 'Icon123',
-          type: 'NUMBER',
+          type: FieldMetadataType.Number,
           metadata: {
             fieldName: 'number',
             placeHolder: 'Enter number',

diff --git a/...t-record/record-field/meta-types/input/components/__stories__/PhoneFieldInput.stories.tsx b/...t-record/record-field/meta-types/input/components/__stories__/PhoneFieldInput.stories.tsx
@@ -3,6 +3,7 @@ import { Decorator, Meta, StoryObj } from '@storybook/react';
 import { expect, fn, userEvent, waitFor, within } from '@storybook/test';
 
 import { useSetHotkeyScope } from '@/ui/utilities/hotkey/hooks/useSetHotkeyScope';
+import { FieldMetadataType } from '~/generated/graphql';
 
 import { FieldContextProvider } from '../../../__stories__/FieldContextProvider';
 import { usePhoneField } from '../../../hooks/usePhoneField';
@@ -44,7 +45,7 @@ const PhoneFieldInputWithContext = ({
         fieldDefinition={{
           fieldMetadataId: 'phone',
           label: 'Phone',
-          type: 'TEXT',
+          type: FieldMetadataType.Text,
           iconName: 'IconPhone',
           metadata: {
             fieldName: 'phone',

diff --git a/...ecord/record-field/meta-types/input/components/__stories__/RelationFieldInput.stories.tsx b/...ecord/record-field/meta-types/input/components/__stories__/RelationFieldInput.stories.tsx
@@ -14,6 +14,7 @@ import { currentWorkspaceMemberState } from '@/auth/states/currentWorkspaceMembe
 import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
 import { CoreObjectNameSingular } from '@/object-metadata/types/CoreObjectNameSingular';
 import { useSetHotkeyScope } from '@/ui/utilities/hotkey/hooks/useSetHotkeyScope';
+import { FieldMetadataType } from '~/generated/graphql';
 import { ComponentWithRecoilScopeDecorator } from '~/testing/decorators/ComponentWithRecoilScopeDecorator';
 import { ObjectMetadataItemsDecorator } from '~/testing/decorators/ObjectMetadataItemsDecorator';
 import { SnackBarDecorator } from '~/testing/decorators/SnackBarDecorator';
@@ -65,7 +66,7 @@ const RelationFieldInputWithContext = ({
         fieldDefinition={{
           fieldMetadataId: 'relation',
           label: 'Relation',
-          type: 'RELATION',
+          type: FieldMetadataType.Relation,
           iconName: 'IconLink',
           metadata: {
             fieldName: 'Relation',