🦘 feat: reset keepFieldsRef options keep fields reference (#12923)

* 🦘 feat: reset keepFieldsRef options keep fields reference

* remove additional logic

* update test

* update api contract

Author: bluebill1049

reports/api-extractor.md.api.md

@@ -409,6 +409,7 @@ export type KeepStateOptions = Partial<{
     keepIsValidating: boolean;
     keepIsValid: boolean;
     keepSubmitCount: boolean;
+    keepFieldsRef: boolean;
 }>;
 
 // @public (undocumented)
@@ -901,7 +902,7 @@ export type WatchObserver<TFieldValues extends FieldValues> = (value: DeepPartia
 
 // Warnings were encountered during analysis:
 //
-// src/types/form.ts:485:3 - (ae-forgotten-export) The symbol "Subscription" needs to be exported by the entry point index.d.ts
+// src/types/form.ts:486:3 - (ae-forgotten-export) The symbol "Subscription" needs to be exported by the entry point index.d.ts
 
 // (No @packageDocumentation comment for this package)
 

src/__tests__/useForm/watch.test.tsx

@@ -521,14 +521,10 @@ describe('watch', () => {
     expect(await screen.findByText('1234')).toBeVisible();
 
     expect(watchedData).toEqual([
+      {},
       {},
       {
         test: '1234',
-        data: '1234',
-      },
-      {
-        test: '1234',
-        data: '1234',
       },
     ]);
   });

src/logic/createFormControl.ts

@@ -129,7 +129,7 @@ export function createFormControl<
     errors: _options.errors || {},
     disabled: _options.disabled || false,
   };
-  const _fields: FieldRefs = {};
+  let _fields: FieldRefs = {};
   let _defaultValues =
     isObject(_options.defaultValues) || isObject(_options.values)
       ? cloneObject(_options.defaultValues || _options.values) || {}
@@ -1355,20 +1355,23 @@ export function createFormControl<
           }
         }
 
-        for (const fieldName of _names.mount) {
-          const value = get(values, fieldName, get(_defaultValues, fieldName));
-
-          if (!isUndefined(value)) {
-            set(values, fieldName, value);
+        if (keepStateOptions.keepFieldsRef) {
+          for (const fieldName of _names.mount) {
             setValue(
               fieldName as FieldPath<TFieldValues>,
               get(values, fieldName),
             );
           }
+        } else {
+          _fields = {};
         }
       }
 
-      _formValues = cloneObject(values) as TFieldValues;
+      _formValues = _options.shouldUnregister
+        ? keepStateOptions.keepDefaultValues
+          ? (cloneObject(_defaultValues) as TFieldValues)
+          : ({} as TFieldValues)
+        : (cloneObject(values) as TFieldValues);
 
       _subjects.array.next({
         values: { ...values },

src/types/form.ts

@@ -177,6 +177,7 @@ export type KeepStateOptions = Partial<{
   keepIsValidating: boolean;
   keepIsValid: boolean;
   keepSubmitCount: boolean;
+  keepFieldsRef: boolean;
 }>;
 
 export type SetFieldValue<TFieldValues extends FieldValues> =

src/useForm.ts

@@ -153,7 +153,10 @@ export function useForm<
 
   React.useEffect(() => {
     if (props.values && !deepEqual(props.values, _values.current)) {
-      control._reset(props.values, control._options.resetOptions);
+      control._reset(props.values, {
+        keepFieldsRef: true,
+        ...control._options.resetOptions,
+      });
       _values.current = props.values;
       updateFormState((state) => ({ ...state }));
     } else {