refactor: use react-hook-form in Settings Data Model Object pages (#4271)

Related issue: #3836

packages/twenty-front/src/pages/settings/data-model/SettingsNewObject.tsx

@@ -1,47 +1,60 @@
-import { useState } from 'react';
+import { FormProvider, useForm } from 'react-hook-form';
 import { useNavigate } from 'react-router-dom';
+import { zodResolver } from '@hookform/resolvers/zod';
+import { z } from 'zod';
 
 import { useCreateOneObjectMetadataItem } from '@/object-metadata/hooks/useCreateOneObjectMetadataItem';
 import { getObjectSlug } from '@/object-metadata/utils/getObjectSlug';
 import { SaveAndCancelButtons } from '@/settings/components/SaveAndCancelButtons/SaveAndCancelButtons';
 import { SettingsHeaderContainer } from '@/settings/components/SettingsHeaderContainer';
 import { SettingsPageContainer } from '@/settings/components/SettingsPageContainer';
-import { SettingsObjectFormSection } from '@/settings/data-model/components/SettingsObjectFormSection';
+import {
+  SettingsDataModelObjectAboutForm,
+  settingsDataModelObjectAboutFormSchema,
+} from '@/settings/data-model/objects/forms/components/SettingsDataModelObjectAboutForm';
 import { settingsCreateObjectInputSchema } from '@/settings/data-model/validation-schemas/settingsCreateObjectInputSchema';
 import { getSettingsPagePath } from '@/settings/utils/getSettingsPagePath';
 import { SettingsPath } from '@/types/SettingsPath';
 import { IconSettings } from '@/ui/display/icon';
+import { H2Title } from '@/ui/display/typography/components/H2Title';
 import { useSnackBar } from '@/ui/feedback/snack-bar-manager/hooks/useSnackBar';
 import { SubMenuTopBarContainer } from '@/ui/layout/page/SubMenuTopBarContainer';
+import { Section } from '@/ui/layout/section/components/Section';
 import { Breadcrumb } from '@/ui/navigation/bread-crumb/components/Breadcrumb';
 
+const newObjectFormSchema = settingsDataModelObjectAboutFormSchema;
+
+type SettingsDataModelNewObjectFormValues = z.infer<typeof newObjectFormSchema>;
+
 export const SettingsNewObject = () => {
   const navigate = useNavigate();
   const { enqueueSnackBar } = useSnackBar();
 
   const { createOneObjectMetadataItem } = useCreateOneObjectMetadataItem();
 
-  const [formValues, setFormValues] = useState<{
-    description?: string;
-    icon: string;
-    labelPlural: string;
-    labelSingular: string;
-  }>({ icon: 'IconListNumbers', labelPlural: '', labelSingular: '' });
+  const settingsObjectsPagePath = getSettingsPagePath(SettingsPath.Objects);
 
-  const canSave = !!formValues.labelPlural && !!formValues.labelSingular;
+  const formConfig = useForm<SettingsDataModelNewObjectFormValues>({
+    mode: 'onTouched',
+    resolver: zodResolver(newObjectFormSchema),
+  });
+
+  const canSave = formConfig.formState.isValid;
 
   const handleSave = async () => {
+    const formValues = formConfig.getValues();
+
     try {
-      const createdObject = await createOneObjectMetadataItem(
+      const { data: response } = await createOneObjectMetadataItem(
         settingsCreateObjectInputSchema.parse(formValues),
       );
 
       navigate(
-        createdObject.data?.createOneObject.isActive
-          ? `/settings/objects/${getObjectSlug(
-              createdObject.data.createOneObject,
+        response
+          ? `${settingsObjectsPagePath}/${getObjectSlug(
+              response.createOneObject,
             )}`
-          : '/settings/objects',
+          : settingsObjectsPagePath,
       );
     } catch (error) {
       enqueueSnackBar((error as Error).message, {
@@ -51,37 +64,35 @@ export const SettingsNewObject = () => {
   };
 
   return (
-    <SubMenuTopBarContainer Icon={IconSettings} title="Settings">
-      <SettingsPageContainer>
-        <SettingsHeaderContainer>
-          <Breadcrumb
-            links={[
-              {
-                children: 'Objects',
-                href: getSettingsPagePath(SettingsPath.Objects),
-              },
-              { children: 'New' },
-            ]}
-          />
-          <SaveAndCancelButtons
-            isSaveDisabled={!canSave}
-            onCancel={() => navigate(getSettingsPagePath(SettingsPath.Objects))}
-            onSave={handleSave}
-          />
-        </SettingsHeaderContainer>
-        <SettingsObjectFormSection
-          icon={formValues.icon}
-          singularName={formValues.labelSingular}
-          pluralName={formValues.labelPlural}
-          description={formValues.description}
-          onChange={(formValues) => {
-            setFormValues((previousValues) => ({
-              ...previousValues,
-              ...formValues,
-            }));
-          }}
-        />
-      </SettingsPageContainer>
-    </SubMenuTopBarContainer>
+    // eslint-disable-next-line react/jsx-props-no-spreading
+    <FormProvider {...formConfig}>
+      <SubMenuTopBarContainer Icon={IconSettings} title="Settings">
+        <SettingsPageContainer>
+          <SettingsHeaderContainer>
+            <Breadcrumb
+              links={[
+                {
+                  children: 'Objects',
+                  href: settingsObjectsPagePath,
+                },
+                { children: 'New' },
+              ]}
+            />
+            <SaveAndCancelButtons
+              isSaveDisabled={!canSave}
+              onCancel={() => navigate(settingsObjectsPagePath)}
+              onSave={handleSave}
+            />
+          </SettingsHeaderContainer>
+          <Section>
+            <H2Title
+              title="About"
+              description="Name in both singular (e.g., 'Invoice') and plural (e.g., 'Invoices') forms."
+            />
+            <SettingsDataModelObjectAboutForm />
+          </Section>
+        </SettingsPageContainer>
+      </SubMenuTopBarContainer>
+    </FormProvider>
   );
 };

packages/twenty-front/src/pages/settings/data-model/SettingsObjectEdit.tsx

@@ -1,5 +1,9 @@
-import { useEffect, useState } from 'react';
+import { useEffect } from 'react';
+import { FormProvider, useForm } from 'react-hook-form';
 import { useNavigate, useParams } from 'react-router-dom';
+import { zodResolver } from '@hookform/resolvers/zod';
+import pick from 'lodash.pick';
+import { z } from 'zod';
 
 import { useObjectMetadataItemForSettings } from '@/object-metadata/hooks/useObjectMetadataItemForSettings';
 import { useUpdateOneObjectMetadataItem } from '@/object-metadata/hooks/useUpdateOneObjectMetadataItem';
@@ -7,7 +11,10 @@ import { getObjectSlug } from '@/object-metadata/utils/getObjectSlug';
 import { SaveAndCancelButtons } from '@/settings/components/SaveAndCancelButtons/SaveAndCancelButtons';
 import { SettingsHeaderContainer } from '@/settings/components/SettingsHeaderContainer';
 import { SettingsPageContainer } from '@/settings/components/SettingsPageContainer';
-import { SettingsObjectFormSection } from '@/settings/data-model/components/SettingsObjectFormSection';
+import {
+  SettingsDataModelObjectAboutForm,
+  settingsDataModelObjectAboutFormSchema,
+} from '@/settings/data-model/objects/forms/components/SettingsDataModelObjectAboutForm';
 import { SettingsDataModelObjectSettingsFormCard } from '@/settings/data-model/objects/forms/components/SettingsDataModelObjectSettingsFormCard';
 import { settingsUpdateObjectInputSchema } from '@/settings/data-model/validation-schemas/settingsUpdateObjectInputSchema';
 import { getSettingsPagePath } from '@/settings/utils/getSettingsPagePath';
@@ -21,6 +28,12 @@ import { SubMenuTopBarContainer } from '@/ui/layout/page/SubMenuTopBarContainer'
 import { Section } from '@/ui/layout/section/components/Section';
 import { Breadcrumb } from '@/ui/navigation/bread-crumb/components/Breadcrumb';
 
+const objectEditFormSchema = settingsDataModelObjectAboutFormSchema;
+
+type SettingsDataModelObjectEditFormValues = z.infer<
+  typeof objectEditFormSchema
+>;
+
 export const SettingsObjectEdit = () => {
   const navigate = useNavigate();
   const { enqueueSnackBar } = useSnackBar();
@@ -33,57 +46,37 @@ export const SettingsObjectEdit = () => {
   const activeObjectMetadataItem =
     findActiveObjectMetadataItemBySlug(objectSlug);
 
-  const [formValues, setFormValues] = useState<
-    Partial<{
-      icon: string;
-      labelSingular: string;
-      labelPlural: string;
-      description: string;
-    }>
-  >({});
+  const settingsObjectsPagePath = getSettingsPagePath(SettingsPath.Objects);
+
+  const formConfig = useForm<SettingsDataModelObjectEditFormValues>({
+    mode: 'onTouched',
+    resolver: zodResolver(objectEditFormSchema),
+  });
 
   useEffect(() => {
-    if (!activeObjectMetadataItem) {
-      navigate(AppPath.NotFound);
-      return;
-    }
-
-    if (!Object.keys(formValues).length) {
-      setFormValues({
-        icon: activeObjectMetadataItem.icon ?? undefined,
-        labelSingular: activeObjectMetadataItem.labelSingular,
-        labelPlural: activeObjectMetadataItem.labelPlural,
-        description: activeObjectMetadataItem.description ?? undefined,
-      });
-    }
-  }, [activeObjectMetadataItem, formValues, navigate]);
+    if (!activeObjectMetadataItem) navigate(AppPath.NotFound);
+  }, [activeObjectMetadataItem, navigate]);
 
   if (!activeObjectMetadataItem) return null;
 
-  const areRequiredFieldsFilled =
-    !!formValues.labelSingular && !!formValues.labelPlural;
-
-  const hasChanges =
-    formValues.description !== activeObjectMetadataItem.description ||
-    formValues.icon !== activeObjectMetadataItem.icon ||
-    formValues.labelPlural !== activeObjectMetadataItem.labelPlural ||
-    formValues.labelSingular !== activeObjectMetadataItem.labelSingular;
-
-  const canSave = areRequiredFieldsFilled && hasChanges;
+  const { isDirty, isValid } = formConfig.formState;
+  const canSave = isDirty && isValid;
 
   const handleSave = async () => {
-    const editedObjectMetadataItem = {
-      ...activeObjectMetadataItem,
-      ...formValues,
-    };
+    const formValues = formConfig.getValues();
+    const dirtyFieldKeys = Object.keys(
+      formConfig.formState.dirtyFields,
+    ) as (keyof SettingsDataModelObjectEditFormValues)[];
 
     try {
       await updateOneObjectMetadataItem({
         idToUpdate: activeObjectMetadataItem.id,
-        updatePayload: settingsUpdateObjectInputSchema.parse(formValues),
+        updatePayload: settingsUpdateObjectInputSchema.parse(
+          pick(formValues, dirtyFieldKeys),
+        ),
       });
 
-      navigate(`/settings/objects/${getObjectSlug(editedObjectMetadataItem)}`);
+      navigate(`${settingsObjectsPagePath}/${getObjectSlug(formValues)}`);
     } catch (error) {
       enqueueSnackBar((error as Error).message, {
         variant: 'error',
@@ -96,63 +89,68 @@ export const SettingsObjectEdit = () => {
       idToUpdate: activeObjectMetadataItem.id,
       updatePayload: { isActive: false },
     });
-    navigate(getSettingsPagePath(SettingsPath.Objects));
+    navigate(settingsObjectsPagePath);
   };
 
   return (
-    <SubMenuTopBarContainer Icon={IconSettings} title="Settings">
-      <SettingsPageContainer>
-        <SettingsHeaderContainer>
-          <Breadcrumb
-            links={[
-              { children: 'Objects', href: '/settings/objects' },
-              {
-                children: activeObjectMetadataItem.labelPlural,
-                href: `/settings/objects/${objectSlug}`,
-              },
-              { children: 'Edit' },
-            ]}
-          />
-          {activeObjectMetadataItem.isCustom && (
-            <SaveAndCancelButtons
-              isSaveDisabled={!canSave}
-              onCancel={() => navigate(`/settings/objects/${objectSlug}`)}
-              onSave={handleSave}
+    // eslint-disable-next-line react/jsx-props-no-spreading
+    <FormProvider {...formConfig}>
+      <SubMenuTopBarContainer Icon={IconSettings} title="Settings">
+        <SettingsPageContainer>
+          <SettingsHeaderContainer>
+            <Breadcrumb
+              links={[
+                {
+                  children: 'Objects',
+                  href: settingsObjectsPagePath,
+                },
+                {
+                  children: activeObjectMetadataItem.labelPlural,
+                  href: `${settingsObjectsPagePath}/${objectSlug}`,
+                },
+                { children: 'Edit' },
+              ]}
             />
-          )}
-        </SettingsHeaderContainer>
-        <SettingsObjectFormSection
-          disabled={!activeObjectMetadataItem.isCustom}
-          icon={formValues.icon}
-          singularName={formValues.labelSingular}
-          pluralName={formValues.labelPlural}
-          description={formValues.description}
-          onChange={(values) =>
-            setFormValues((previousFormValues) => ({
-              ...previousFormValues,
-              ...values,
-            }))
-          }
-        />
-        <Section>
-          <H2Title
-            title="Settings"
-            description="Choose the fields that will identify your records"
-          />
-          <SettingsDataModelObjectSettingsFormCard
-            objectMetadataItem={activeObjectMetadataItem}
-          />
-        </Section>
-        <Section>
-          <H2Title title="Danger zone" description="Disable object" />
-          <Button
-            Icon={IconArchive}
-            title="Disable"
-            size="small"
-            onClick={handleDisable}
-          />
-        </Section>
-      </SettingsPageContainer>
-    </SubMenuTopBarContainer>
+            {activeObjectMetadataItem.isCustom && (
+              <SaveAndCancelButtons
+                isSaveDisabled={!canSave}
+                onCancel={() =>
+                  navigate(`${settingsObjectsPagePath}/${objectSlug}`)
+                }
+                onSave={handleSave}
+              />
+            )}
+          </SettingsHeaderContainer>
+          <Section>
+            <H2Title
+              title="About"
+              description="Name in both singular (e.g., 'Invoice') and plural (e.g., 'Invoices') forms."
+            />
+            <SettingsDataModelObjectAboutForm
+              disabled={!activeObjectMetadataItem.isCustom}
+              objectMetadataItem={activeObjectMetadataItem}
+            />
+          </Section>
+          <Section>
+            <H2Title
+              title="Settings"
+              description="Choose the fields that will identify your records"
+            />
+            <SettingsDataModelObjectSettingsFormCard
+              objectMetadataItem={activeObjectMetadataItem}
+            />
+          </Section>
+          <Section>
+            <H2Title title="Danger zone" description="Disable object" />
+            <Button
+              Icon={IconArchive}
+              title="Disable"
+              size="small"
+              onClick={handleDisable}
+            />
+          </Section>
+        </SettingsPageContainer>
+      </SubMenuTopBarContainer>
+    </FormProvider>
   );
 };