react-hook-form 7.73.1 → 7.75.0

package/dist/index.esm.mjs

@@ -143,9 +143,7 @@ HookFormControlContext.displayName = 'HookFormControlContext';
 const useFormControlContext = () => React.useContext(HookFormControlContext);
 
 var getProxyFormState = (formState, control, localProxyFormState, isRoot = true) => {
-    const result = {
-        defaultValues: control._defaultValues,
-    };
+    const result = {};
     for (const key in formState) {
         Object.defineProperty(result, key, {
             get: () => {
@@ -196,7 +194,10 @@ const useIsomorphicLayoutEffect = typeof window !== 'undefined' ? React.useLayou
 function useFormState(props) {
     const formControl = useFormControlContext();
     const { control = formControl, disabled, name, exact } = props || {};
-    const [formState, updateFormState] = React.useState(control._formState);
+    const [formState, updateFormState] = React.useState(() => ({
+        ...control._formState,
+        defaultValues: control._defaultValues,
+    }));
     const _localProxyFormState = React.useRef({
         isDirty: false,
         isLoading: false,
@@ -216,6 +217,7 @@ function useFormState(props) {
                 updateFormState({
                     ...control._formState,
                     ...formState,
+                    defaultValues: control._defaultValues,
                 });
         },
     }), [name, disabled, exact]);
@@ -408,7 +410,6 @@ function useController(props) {
         exact,
     });
     const _props = React.useRef(props);
-    const _previousNameRef = React.useRef(undefined);
     const _registerProps = React.useRef(control.register(name, {
         ...props.rules,
         value,
@@ -474,10 +475,6 @@ function useController(props) {
     }), [name, disabled, formState.disabled, onChange, onBlur, ref, value]);
     React.useEffect(() => {
         const _shouldUnregisterField = control._options.shouldUnregister || shouldUnregister;
-        const previousName = _previousNameRef.current;
-        if (previousName && previousName !== name && !isArrayField) {
-            control.unregister(previousName);
-        }
         control.register(name, {
             ..._props.current.rules,
             ...(isBoolean(_props.current.disabled)
@@ -499,7 +496,6 @@ function useController(props) {
             }
         }
         !isArrayField && control.register(name);
-        _previousNameRef.current = name;
         return () => {
             (isArrayField
                 ? _shouldUnregisterField && !control._state.action
@@ -645,7 +641,7 @@ const useFormContext = () => React.useContext(HookFormContext);
  * ```
  */
 const FormProvider = (props) => {
-    const { children, watch, getValues, getFieldState, setError, clearErrors, setValue, trigger, formState, resetField, reset, handleSubmit, unregister, control, register, setFocus, subscribe, } = props;
+    const { children, watch, getValues, getFieldState, setError, clearErrors, setValue, setValues, trigger, formState, resetField, reset, handleSubmit, unregister, control, register, setFocus, subscribe, } = props;
     const memoizedValue = React.useMemo(() => ({
         watch,
         getValues,
@@ -653,6 +649,7 @@ const FormProvider = (props) => {
         setError,
         clearErrors,
         setValue,
+        setValues,
         trigger,
         formState,
         resetField,
@@ -676,6 +673,7 @@ const FormProvider = (props) => {
         setError,
         setFocus,
         setValue,
+        setValues,
         subscribe,
         trigger,
         unregister,
@@ -883,7 +881,12 @@ function baseGet(object, updatePath) {
     const length = updatePath.slice(0, -1).length;
     let index = 0;
     while (index < length) {
-        object = isUndefined(object) ? index++ : object[updatePath[index++]];
+        if (isNullOrUndefined(object)) {
+            object = undefined;
+            break;
+        }
+        object = object[updatePath[index]];
+        index++;
     }
     return object;
 }
@@ -944,6 +947,29 @@ function markFieldsDirty(data, fields = {}) {
     }
     return fields;
 }
+function pruneDirtyFields(value) {
+    if (value === false) {
+        return undefined;
+    }
+    if (value === true) {
+        return true;
+    }
+    if (Array.isArray(value)) {
+        const result = value.map((value) => pruneDirtyFields(value));
+        return (result.some((value) => value !== undefined) ? result : undefined);
+    }
+    if (isObject(value)) {
+        const result = {};
+        for (const key in value) {
+            const pruned = pruneDirtyFields(value[key]);
+            if (!isUndefined(pruned)) {
+                result[key] = pruned;
+            }
+        }
+        return (Object.keys(result).length ? result : undefined);
+    }
+    return undefined;
+}
 function getDirtyFields(data, formValues, dirtyFieldsFromValues) {
     if (!dirtyFieldsFromValues) {
         dirtyFieldsFromValues = markFieldsDirty(formValues);
@@ -963,7 +989,7 @@ function getDirtyFields(data, formValues, dirtyFieldsFromValues) {
             dirtyFieldsFromValues[key] = !deepEqual(value, formValue);
         }
     }
-    return dirtyFieldsFromValues;
+    return pruneDirtyFields(dirtyFieldsFromValues) || {};
 }
 
 const defaultResult = {
@@ -1035,8 +1061,6 @@ function getFieldValue(_f) {
     return getFieldValueAs(isUndefined(ref.value) ? _f.ref.value : ref.value, _f);
 }
 
-var getNodeParentName = (name) => name.substring(0, name.search(/\.\d+(\.|$)/)) || name;
-
 var getResolverOptions = (fieldsNames, _fields, criteriaMode, shouldUseNativeValidation) => {
     const fields = {};
     for (const name of fieldsNames) {
@@ -1161,7 +1185,8 @@ var shouldRenderFormState = (formStateData, _proxyFormState, updateFormState, is
     updateFormState(formStateData);
     const { name, ...formState } = formStateData;
     return (isEmptyObject(formState) ||
-        Object.keys(formState).length >= Object.keys(_proxyFormState).length ||
+        (isRoot &&
+            Object.keys(formState).length >= Object.keys(_proxyFormState).length) ||
         Object.keys(formState).find((key) => _proxyFormState[key] ===
             (!isRoot || VALIDATION_MODE.all)));
 };
@@ -1241,7 +1266,8 @@ var validateField = async (field, disabledFieldNames, formValues, validateAllFie
         isUndefined(inputValue)) ||
         (isHTMLElement(ref) && ref.value === '') ||
         inputValue === '' ||
-        (Array.isArray(inputValue) && !inputValue.length);
+        (Array.isArray(inputValue) && !inputValue.length) ||
+        (valueAsNumber && typeof inputValue === 'number' && isNaN(inputValue));
     const appendErrorsCurry = appendErrors.bind(null, name, validateAllFieldCriteria, error);
     const getMinMaxMessage = (exceedMax, maxLengthMessage, minLengthMessage, maxType = INPUT_VALIDATION_RULES.maxLength, minType = INPUT_VALIDATION_RULES.minLength) => {
         const message = exceedMax ? maxLengthMessage : minLengthMessage;
@@ -1403,24 +1429,27 @@ const defaultOptions = {
     reValidateMode: VALIDATION_MODE.onChange,
     shouldFocusError: true,
 };
+const DEFAULT_FORM_STATE = {
+    submitCount: 0,
+    isDirty: false,
+    isReady: false,
+    isValidating: false,
+    isSubmitted: false,
+    isSubmitting: false,
+    isSubmitSuccessful: false,
+    isValid: false,
+    touchedFields: {},
+    dirtyFields: {},
+    validatingFields: {},
+};
 function createFormControl(props = {}) {
     let _options = {
         ...defaultOptions,
         ...props,
     };
     let _formState = {
-        submitCount: 0,
-        isDirty: false,
-        isReady: false,
+        ...cloneObject(DEFAULT_FORM_STATE),
         isLoading: isFunction(_options.defaultValues),
-        isValidating: false,
-        isSubmitted: false,
-        isSubmitting: false,
-        isSubmitSuccessful: false,
-        isValid: false,
-        touchedFields: {},
-        dirtyFields: {},
-        validatingFields: {},
         errors: _options.errors || {},
         disabled: _options.disabled || false,
     };
@@ -1517,10 +1546,8 @@ function createFormControl(props = {}) {
             });
         }
     };
-    const _updateDirtyFields = (name) => {
-        const fullDirtyFields = getDirtyFields(_defaultValues, _formValues);
-        const rootName = getNodeParentName(name);
-        set(_formState.dirtyFields, rootName, get(fullDirtyFields, rootName));
+    const _updateDirtyFields = () => {
+        _formState.dirtyFields = getDirtyFields(_defaultValues, _formValues);
     };
     const _setFieldArray = (name, values = [], method, args, shouldSetValues = true, shouldUpdateFieldsAndState = true) => {
         if (args && method && !_options.disabled) {
@@ -1543,7 +1570,7 @@ function createFormControl(props = {}) {
                 shouldSetValues && set(_formState.touchedFields, name, touchedFields);
             }
             if (_proxyFormState.dirtyFields || _proxySubscribeFormState.dirtyFields) {
-                _updateDirtyFields(name);
+                _updateDirtyFields();
             }
             _subjects.state.next({
                 name,
@@ -1573,13 +1600,31 @@ function createFormControl(props = {}) {
     const updateValidAndValue = (name, shouldSkipSetValueAs, value, ref) => {
         const field = get(_fields, name);
         if (field) {
+            const wasUnsetInFormValues = isUndefined(get(_formValues, name));
             const defaultValue = get(_formValues, name, isUndefined(value) ? get(_defaultValues, name) : value);
             isUndefined(defaultValue) ||
                 (ref && ref.defaultChecked) ||
                 shouldSkipSetValueAs
                 ? set(_formValues, name, shouldSkipSetValueAs ? defaultValue : getFieldValue(field._f))
                 : setFieldValue(name, defaultValue);
-            _state.mount && !_state.action && _setValid();
+            if (_state.mount && !_state.action) {
+                _setValid();
+                // Re-registering a field after a prior unregister puts its key back
+                // into _formValues, which can flip isDirty back to false (#13397).
+                // Only run when we are currently dirty, otherwise an initial register
+                // for a field with no defaultValue would flip isDirty to true. Reset
+                // paths repopulate _formValues before re-register, so the key is
+                // present then and this branch is skipped (preserves keepDirty).
+                if (wasUnsetInFormValues &&
+                    _formState.isDirty &&
+                    (_proxyFormState.isDirty || _proxySubscribeFormState.isDirty)) {
+                    const isDirty = _getDirty();
+                    if (!isDirty) {
+                        _formState.isDirty = false;
+                        _subjects.state.next({ ..._formState });
+                    }
+                }
+            }
         }
     };
     const updateTouchAndDirty = (name, fieldValue, isBlurEvent, shouldDirty, shouldRender) => {
@@ -1841,7 +1886,7 @@ function createFormControl(props = {}) {
             updateTouchAndDirty(name, fieldValue, options.shouldTouch, options.shouldDirty, true);
         options.shouldValidate && trigger(name);
     };
-    const setValues = (name, value, options) => {
+    const setFieldValues = (name, value, options) => {
         for (const fieldKey in value) {
             if (!value.hasOwnProperty(fieldKey)) {
                 return;
@@ -1853,7 +1898,7 @@ function createFormControl(props = {}) {
                 isObject(fieldValue) ||
                 (field && !field._f)) &&
                 !isDateObject(fieldValue)
-                ? setValues(fieldName, fieldValue, options)
+                ? setFieldValues(fieldName, fieldValue, options)
                 : setFieldValue(fieldName, fieldValue, options);
         }
     };
@@ -1869,8 +1914,12 @@ function createFormControl(props = {}) {
                 name,
                 values: cloneObject(_formValues),
             });
-            if (options.shouldDirty) {
-                _updateDirtyFields(name);
+            if ((_proxyFormState.isDirty ||
+                _proxyFormState.dirtyFields ||
+                _proxySubscribeFormState.isDirty ||
+                _proxySubscribeFormState.dirtyFields) &&
+                options.shouldDirty) {
+                _updateDirtyFields();
                 _subjects.state.next({
                     name,
                     dirtyFields: _formState.dirtyFields,
@@ -1885,23 +1934,28 @@ function createFormControl(props = {}) {
                 setFieldValue(name, cloneValue, options);
             }
             else {
-                setValues(name, cloneValue, options);
+                setFieldValues(name, cloneValue, options);
             }
         }
         if (!isValueUnchanged) {
-            if (isWatched(name, _names)) {
-                _subjects.state.next({
-                    ..._formState,
-                    name,
-                    values: cloneObject(_formValues),
-                });
-            }
-            else {
-                _subjects.state.next({
-                    name: _state.mount ? name : undefined,
-                    values: cloneObject(_formValues),
-                });
-            }
+            const watched = isWatched(name, _names);
+            _subjects.state.next({
+                ...(watched && _formState),
+                name: _state.mount || watched ? name : undefined,
+                values: cloneObject(_formValues),
+            });
+        }
+    };
+    const setValues = (formValues) => {
+        const updatedFormValues = isFunction(formValues)
+            ? formValues(_formValues)
+            : formValues;
+        if (!deepEqual(_formValues, updatedFormValues)) {
+            _formValues = {
+                ..._formValues,
+                ...updatedFormValues,
+            };
+            _subjects.state.next({ ..._formState, values: _formValues });
         }
     };
     const onChange = async (event) => {
@@ -2601,6 +2655,7 @@ function createFormControl(props = {}) {
         handleSubmit,
         watch,
         setValue,
+        setValues,
         getValues,
         reset,
         resetField,
@@ -2897,15 +2952,22 @@ function useFieldArray(props) {
     React.useEffect(() => {
         !get(control._formValues, name) && control._setFieldArray(name);
         return () => {
+            const shouldKeepFieldArrayValues = !(control._options.shouldUnregister || shouldUnregister);
             const updateMounted = (name, value) => {
                 const field = get(control._fields, name);
                 if (field && field._f) {
                     field._f.mount = value;
                 }
             };
-            control._options.shouldUnregister || shouldUnregister
-                ? control.unregister(name)
-                : updateMounted(name, false);
+            if (_actioned.current && shouldKeepFieldArrayValues) {
+                control._subjects.state.next({
+                    name,
+                    values: cloneObject(control._formValues),
+                });
+            }
+            shouldKeepFieldArrayValues
+                ? updateMounted(name, false)
+                : control.unregister(name);
         };
     }, [name, control, keyName, shouldUnregister]);
     return {
@@ -2956,25 +3018,15 @@ function useFieldArray(props) {
 function useForm(props = {}) {
     const _formControl = React.useRef(undefined);
     const _values = React.useRef(undefined);
-    const [formState, updateFormState] = React.useState({
-        isDirty: false,
-        isValidating: false,
+    const [formState, updateFormState] = React.useState(() => ({
+        ...cloneObject(DEFAULT_FORM_STATE),
         isLoading: isFunction(props.defaultValues),
-        isSubmitted: false,
-        isSubmitting: false,
-        isSubmitSuccessful: false,
-        isValid: false,
-        submitCount: 0,
-        dirtyFields: {},
-        touchedFields: {},
-        validatingFields: {},
         errors: props.errors || {},
         disabled: props.disabled || false,
-        isReady: false,
         defaultValues: isFunction(props.defaultValues)
             ? undefined
             : props.defaultValues,
-    });
+    }));
     if (!_formControl.current) {
         if (props.formControl) {
             _formControl.current = {