react-hook-form 7.74.0 → 7.76.0

package/dist/index.esm.mjs

@@ -18,9 +18,15 @@ var getEventValue = (event) => isObject(event) && event.target
         : event.target.value
     : event;
 
-var isNameInFieldArray = (names, name) => name
-    .split('.')
-    .some((part, index, arr) => !isNaN(Number(part)) && names.has(arr.slice(0, index).join('.')));
+var getFieldArrayParentNames = (names, name) => {
+    const parts = name.split('.');
+    const matches = [];
+    let prefix = parts[0];
+    for (let i = 1; i < parts.length; prefix += '.' + parts[i++]) {
+        !isNaN(+parts[i]) && names.has(prefix) && matches.push(prefix);
+    }
+    return matches;
+};
 
 var isPlainObject = (tempObject) => {
     const prototypeCopy = tempObject.constructor && tempObject.constructor.prototype;
@@ -143,9 +149,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 +200,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 +223,7 @@ function useFormState(props) {
                 updateFormState({
                     ...control._formState,
                     ...formState,
+                    defaultValues: control._defaultValues,
                 });
         },
     }), [name, disabled, exact]);
@@ -394,7 +402,8 @@ function useWatch(props) {
 function useController(props) {
     const formControl = useFormControlContext();
     const { name, disabled, control = formControl, shouldUnregister, defaultValue, exact = true, } = props;
-    const isArrayField = isNameInFieldArray(control._names.array, name);
+    const isArrayField = !!getFieldArrayParentNames(control._names.array, name)
+        .length;
     const defaultValueMemo = React.useMemo(() => get(control._formValues, name, get(control._defaultValues, name, defaultValue)), [control, name, defaultValue]);
     const value = useWatch({
         control,
@@ -487,7 +496,7 @@ function useController(props) {
         };
         updateMounted(name, true);
         if (_shouldUnregisterField) {
-            const value = cloneObject(get(control._options.defaultValues, name, _props.current.defaultValue));
+            const value = cloneObject(get(control._defaultValues, name, get(control._options.defaultValues, name, _props.current.defaultValue)));
             set(control._defaultValues, name, value);
             if (isUndefined(get(control._formValues, name))) {
                 set(control._formValues, name, value);
@@ -639,7 +648,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,
@@ -647,6 +656,7 @@ const FormProvider = (props) => {
         setError,
         clearErrors,
         setValue,
+        setValues,
         trigger,
         formState,
         resetField,
@@ -670,6 +680,7 @@ const FormProvider = (props) => {
         setError,
         setFocus,
         setValue,
+        setValues,
         subscribe,
         trigger,
         unregister,
@@ -943,6 +954,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);
@@ -962,7 +996,7 @@ function getDirtyFields(data, formValues, dirtyFieldsFromValues) {
             dirtyFieldsFromValues[key] = !deepEqual(value, formValue);
         }
     }
-    return dirtyFieldsFromValues;
+    return pruneDirtyFields(dirtyFieldsFromValues) || {};
 }
 
 const defaultResult = {
@@ -1034,8 +1068,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) {
@@ -1160,7 +1192,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)));
 };
@@ -1403,24 +1436,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 +1553,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 +1577,7 @@ function createFormControl(props = {}) {
                 shouldSetValues && set(_formState.touchedFields, name, touchedFields);
             }
             if (_proxyFormState.dirtyFields || _proxySubscribeFormState.dirtyFields) {
-                _updateDirtyFields(name);
+                _updateDirtyFields();
             }
             _subjects.state.next({
                 name,
@@ -1570,16 +1604,53 @@ function createFormControl(props = {}) {
             isValid: false,
         });
     };
+    const hasExplicitNullIntermediate = (name) => {
+        const segments = isKey(name) ? [name] : stringToPath(name);
+        let formValues = _formValues;
+        let defaultValues = _defaultValues;
+        for (let i = 0; i < segments.length - 1; i++) {
+            const key = segments[i];
+            formValues = isNullOrUndefined(formValues) ? formValues : formValues[key];
+            defaultValues = isNullOrUndefined(defaultValues)
+                ? defaultValues
+                : defaultValues[key];
+            if (formValues === null && defaultValues !== null) {
+                return true;
+            }
+        }
+        return false;
+    };
     const updateValidAndValue = (name, shouldSkipSetValueAs, value, ref) => {
         const field = get(_fields, name);
         if (field) {
+            if (hasExplicitNullIntermediate(name)) {
+                return;
+            }
+            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) => {
@@ -1597,9 +1668,14 @@ function createFormControl(props = {}) {
                 }
                 const isCurrentFieldPristine = deepEqual(get(_defaultValues, name), fieldValue);
                 isPreviousDirty = !!get(_formState.dirtyFields, name);
-                isCurrentFieldPristine
-                    ? unset(_formState.dirtyFields, name)
-                    : set(_formState.dirtyFields, name, true);
+                if (isCurrentFieldPristine !== _formState.isDirty) {
+                    _formState.dirtyFields = getDirtyFields(_defaultValues, _formValues);
+                }
+                else {
+                    isCurrentFieldPristine
+                        ? unset(_formState.dirtyFields, name)
+                        : set(_formState.dirtyFields, name, true);
+                }
                 output.dirtyFields = _formState.dirtyFields;
                 shouldUpdateField =
                     shouldUpdateField ||
@@ -1666,7 +1742,9 @@ function createFormControl(props = {}) {
             for (const name of names) {
                 const error = get(errors, name);
                 error
-                    ? set(_formState.errors, name, error)
+                    ? _names.array.has(name) && isObject(error)
+                        ? updateFieldArrayRootError(_formState.errors, { [name]: error }, name)
+                        : set(_formState.errors, name, error)
                     : unset(_formState.errors, name);
             }
         }
@@ -1688,8 +1766,8 @@ function createFormControl(props = {}) {
                     const error = result[key];
                     if (error) {
                         setError(`${FORM_ERROR_TYPE}.${key}`, {
-                            message: isString(result.message) ? result.message : '',
-                            type: INPUT_VALIDATION_RULES.validate,
+                            message: isString(error.message) ? error.message : '',
+                            type: error.type || INPUT_VALIDATION_RULES.validate,
                         });
                     }
                 }
@@ -1731,11 +1809,15 @@ function createFormControl(props = {}) {
                 if (_f) {
                     const isFieldArrayRoot = _names.array.has(_f.name);
                     const isPromiseFunction = field._f && hasPromiseValidation(field._f);
-                    if (isPromiseFunction && _proxyFormState.validatingFields) {
+                    const shouldTrackIsValidatingState = _proxyFormState.validatingFields ||
+                        _proxyFormState.isValidating ||
+                        _proxySubscribeFormState.validatingFields ||
+                        _proxySubscribeFormState.isValidating;
+                    if (isPromiseFunction && shouldTrackIsValidatingState) {
                         _updateIsValidating([_f.name], true);
                     }
                     const fieldError = await validateField(field, _names.disabled, _formValues, shouldDisplayAllAssociatedErrors, _options.shouldUseNativeValidation && !onlyCheckValid, isFieldArrayRoot);
-                    if (isPromiseFunction && _proxyFormState.validatingFields) {
+                    if (isPromiseFunction && shouldTrackIsValidatingState) {
                         _updateIsValidating([_f.name]);
                     }
                     if (fieldError[_f.name]) {
@@ -1863,14 +1945,20 @@ function createFormControl(props = {}) {
         const cloneValue = cloneObject(value);
         const previousValue = get(_formValues, name);
         const isValueUnchanged = deepEqual(previousValue, cloneValue);
-        set(_formValues, name, cloneValue);
+        if (!isValueUnchanged) {
+            set(_formValues, name, cloneValue);
+        }
         if (isFieldArray) {
             _subjects.array.next({
                 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,
@@ -1889,19 +1977,18 @@ function createFormControl(props = {}) {
             }
         }
         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);
+            const values = cloneObject(_formValues);
+            if (!isFieldArray) {
+                for (const arrayName of getFieldArrayParentNames(_names.array, name)) {
+                    _subjects.array.next({ name: arrayName, values });
+                }
             }
+            _subjects.state.next({
+                ...(watched && _formState),
+                name: _state.mount || watched ? name : undefined,
+                values,
+            });
         }
     };
     const setValues = (formValues) => {
@@ -1913,6 +2000,9 @@ function createFormControl(props = {}) {
                 ..._formValues,
                 ...updatedFormValues,
             };
+            for (const fieldName of _names.mount) {
+                setValue(fieldName, get(updatedFormValues, fieldName));
+            }
             _subjects.state.next({ ..._formState, values: _formValues });
         }
     };
@@ -2283,13 +2373,15 @@ function createFormControl(props = {}) {
                         field._f.mount = false;
                     }
                     (_options.shouldUnregister || options.shouldUnregister) &&
-                        !(isNameInFieldArray(_names.array, name) && _state.action) &&
+                        !(getFieldArrayParentNames(_names.array, name).length &&
+                            _state.action) &&
                         _names.unMount.add(name);
                 }
             },
         };
     };
     const _focusError = () => _options.shouldFocusError &&
+        !_options.shouldUseNativeValidation &&
         iterateFieldsByAction(_fields, _focusInput, _names.mount);
     const _disableForm = (disabled) => {
         if (isBoolean(disabled)) {
@@ -2910,15 +3002,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 {
@@ -2969,25 +3068,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 = {
@@ -3011,7 +3100,10 @@ function useForm(props = {}) {
     useIsomorphicLayoutEffect(() => {
         const sub = control._subscribe({
             formState: control._proxyFormState,
-            callback: () => updateFormState({ ...control._formState }),
+            callback: () => updateFormState({
+                ...control._formState,
+                defaultValues: control._defaultValues,
+            }),
             reRenderRoot: true,
         });
         updateFormState((data) => ({