Support Emails and Phones in spreadsheet import

twentyhq · Sep 28, 2024 · 3ca31f9 · 3ca31f9
1 parent 4630680
commit 3ca31f9
Show file tree

Hide file tree

Showing 4 changed files with 91 additions and 5 deletions.
diff --git a/...ront/src/modules/object-record/spreadsheet-import/constants/CompositeFieldImportLabels.ts b/...ront/src/modules/object-record/spreadsheet-import/constants/CompositeFieldImportLabels.ts
@@ -1,8 +1,10 @@
 import {
   FieldAddressValue,
   FieldCurrencyValue,
+  FieldEmailsValue,
   FieldFullNameValue,
   FieldLinksValue,
+  FieldPhonesValue,
 } from '@/object-record/record-field/types/FieldMetadata';
 import { CompositeFieldLabels } from '@/object-record/spreadsheet-import/types/CompositeFieldLabels';
 import { FieldMetadataType } from '~/generated-metadata/graphql';
@@ -30,6 +32,13 @@ export const COMPOSITE_FIELD_IMPORT_LABELS = {
     primaryLinkUrlLabel: 'Link URL',
     primaryLinkLabelLabel: 'Link Label',
   } satisfies Partial<CompositeFieldLabels<FieldLinksValue>>,
+  [FieldMetadataType.Emails]: {
+    primaryEmailLabel: 'Email',
+  } satisfies Partial<CompositeFieldLabels<FieldEmailsValue>>,
+  [FieldMetadataType.Phones]: {
+    primaryPhoneCountryCodeLabel: 'Phone country code',
+    primaryPhoneNumberLabel: 'Phone number',
+  } satisfies Partial<CompositeFieldLabels<FieldPhonesValue>>,
   [FieldMetadataType.Actor]: {
     sourceLabel: 'Source',
   },

diff --git a/...nt/src/modules/object-record/spreadsheet-import/hooks/useBuildAvailableFieldsForImport.ts b/...nt/src/modules/object-record/spreadsheet-import/hooks/useBuildAvailableFieldsForImport.ts
@@ -15,6 +15,7 @@ export const useBuildAvailableFieldsForImport = () => {
   ) => {
     const availableFieldsForImport: AvailableFieldForImport[] = [];
 
+    // Todo: refactor this to avoid this else if syntax with duplicated code
     for (const fieldMetadataItem of fieldMetadataItems) {
       if (fieldMetadataItem.type === FieldMetadataType.FullName) {
         const { firstNameLabel, lastNameLabel } =
@@ -155,6 +156,42 @@ export const useBuildAvailableFieldsForImport = () => {
             fieldMetadataItem.label,
           ),
         });
+      } else if (fieldMetadataItem.type === FieldMetadataType.Emails) {
+        Object.entries(
+          COMPOSITE_FIELD_IMPORT_LABELS[FieldMetadataType.Emails],
+        ).forEach(([_, fieldLabel]) => {
+          availableFieldsForImport.push({
+            icon: getIcon(fieldMetadataItem.icon),
+            label: `${fieldLabel} (${fieldMetadataItem.label})`,
+            key: `${fieldLabel} (${fieldMetadataItem.name})`,
+            fieldType: {
+              type: 'input',
+            },
+            fieldValidationDefinitions:
+              getSpreadSheetFieldValidationDefinitions(
+                fieldMetadataItem.type,
+                `${fieldLabel} (${fieldMetadataItem.label})`,
+              ),
+          });
+        });
+      } else if (fieldMetadataItem.type === FieldMetadataType.Phones) {
+        Object.entries(
+          COMPOSITE_FIELD_IMPORT_LABELS[FieldMetadataType.Phones],
+        ).forEach(([_, fieldLabel]) => {
+          availableFieldsForImport.push({
+            icon: getIcon(fieldMetadataItem.icon),
+            label: `${fieldLabel} (${fieldMetadataItem.label})`,
+            key: `${fieldLabel} (${fieldMetadataItem.name})`,
+            fieldType: {
+              type: 'input',
+            },
+            fieldValidationDefinitions:
+              getSpreadSheetFieldValidationDefinitions(
+                fieldMetadataItem.type,
+                `${fieldLabel} (${fieldMetadataItem.label})`,
+              ),
+          });
+        });
       } else {
         availableFieldsForImport.push({
           icon: getIcon(fieldMetadataItem.icon),

diff --git a/...src/modules/object-record/spreadsheet-import/util/buildRecordFromImportedStructuredRow.ts b/...src/modules/object-record/spreadsheet-import/util/buildRecordFromImportedStructuredRow.ts
@@ -1,7 +1,9 @@
 import { FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';
 import {
   FieldAddressValue,
+  FieldEmailsValue,
   FieldLinksValue,
+  FieldPhonesValue,
 } from '@/object-record/record-field/types/FieldMetadata';
 import { COMPOSITE_FIELD_IMPORT_LABELS } from '@/object-record/spreadsheet-import/constants/CompositeFieldImportLabels';
 import { ImportedStructuredRow } from '@/spreadsheet-import/types';
@@ -31,6 +33,8 @@ export const buildRecordFromImportedStructuredRow = (
     CURRENCY: { amountMicrosLabel, currencyCodeLabel },
     FULL_NAME: { firstNameLabel, lastNameLabel },
     LINKS: { primaryLinkLabelLabel, primaryLinkUrlLabel },
+    EMAILS: { primaryEmailLabel },
+    PHONES: { primaryPhoneNumberLabel, primaryPhoneCountryCodeLabel },
   } = COMPOSITE_FIELD_IMPORT_LABELS;
 
   for (const field of fields) {
@@ -129,14 +133,48 @@ export const buildRecordFromImportedStructuredRow = (
         }
         break;
       }
-      case FieldMetadataType.Link:
-        if (importedFieldValue !== undefined) {
+      case FieldMetadataType.Phones: {
+        if (
+          isDefined(
+            importedStructuredRow[
+              `${primaryPhoneCountryCodeLabel} (${field.name})`
+            ] ||
+              importedStructuredRow[
+                `${primaryPhoneNumberLabel} (${field.name})`
+              ],
+          )
+        ) {
           recordToBuild[field.name] = {
-            label: field.name,
-            url: importedFieldValue || null,
-          };
+            primaryPhoneCountryCode: castToString(
+              importedStructuredRow[
+                `${primaryPhoneCountryCodeLabel} (${field.name})`
+              ],
+            ),
+            primaryPhoneNumber: castToString(
+              importedStructuredRow[
+                `${primaryPhoneNumberLabel} (${field.name})`
+              ],
+            ),
+            additionalPhones: null,
+          } satisfies FieldPhonesValue;
         }
         break;
+      }
+      case FieldMetadataType.Emails: {
+        if (
+          isDefined(
+            importedStructuredRow[`${primaryEmailLabel} (${field.name})`],
+          )
+        ) {
+          recordToBuild[field.name] = {
+            primaryEmail: castToString(
+              importedStructuredRow[`${primaryEmailLabel} (${field.name})`],
+            ),
+            additionalEmails: null,
+          } satisfies FieldEmailsValue;
+        }
+        break;
+      }
       case FieldMetadataType.Relation:
         if (
           isDefined(importedFieldValue) &&

diff --git a/packages/twenty-front/src/modules/object-record/utils/sanitizeRecordInput.ts b/packages/twenty-front/src/modules/object-record/utils/sanitizeRecordInput.ts
@@ -50,6 +50,8 @@ export const sanitizeRecordInput = ({
           return undefined;
         }
 
+        // Todo: we should check that the fieldValue is a valid value
+        // (e.g. a string for a string field, following the right composite structure for composite fields)
         return [fieldName, fieldValue];
       })
       .filter(isDefined),