remix-validated-form 4.6.11 → 5.0.0

package/dist/index.d.ts

@@ -11,18 +11,18 @@ type ValidationBehaviorOptions = {
 type HandledProps = "name" | "defaultValue" | "defaultChecked";
 type Callbacks = "onChange" | "onBlur";
 type MinimalInputProps = {
-    onChange?: (...args: any[]) => void;
-    onBlur?: (...args: any[]) => void;
+    onChange?: ((...args: any[]) => void) | undefined;
+    onBlur?: ((...args: any[]) => void) | undefined;
     defaultValue?: any;
-    defaultChecked?: boolean;
-    name?: string;
-    type?: string;
+    defaultChecked?: boolean | undefined;
+    name?: string | undefined;
+    type?: string | undefined;
 };
 type GetInputProps = <T extends MinimalInputProps>(props?: Omit<T, HandledProps | Callbacks> & Partial<Pick<T, Callbacks>>) => T;
 
 /**
  * Returns whether or not the parent form is currently being submitted.
- * This is different from Remix's `useTransition().submission` in that it
+ * This is different from Remix's `useNavigation()` in that it
  * is aware of what form it's in and when _that_ form is being submitted.
  *
  * @param formId
@@ -87,6 +87,8 @@ declare const useField: (name: string, options?: {
 declare const useControlField: <T>(name: string, formId?: string) => readonly [T, (value: T) => void];
 declare const useUpdateControlledField: (formId?: string) => (field: string, value: unknown) => void;
 
+declare const FORM_DEFAULTS_FIELD: "__rvfInternalFormDefaults";
+
 type FieldErrors = Record<string, string>;
 type TouchedFields = Record<string, boolean>;
 type GenericObject = {
@@ -130,7 +132,10 @@ type ValidateFieldResult = {
  */
 type Validator<DataType> = {
     validate: (unvalidatedData: GenericObject) => Promise<ValidationResult<DataType>>;
-    validateField: (unvalidatedData: GenericObject, field: string) => Promise<ValidateFieldResult>;
+    /**
+     * @deprecated Will be removed in a future version of remix-validated-form
+     */
+    validateField?: (unvalidatedData: GenericObject, field: string) => Promise<ValidateFieldResult>;
 };
 type Valid<DataType> = {
     data: DataType;
@@ -164,9 +169,14 @@ declare function validationError(error: ValidatorError, repopulateFields?: unkno
 type FormDefaults = {
     [formDefaultsKey: `${typeof FORM_DEFAULTS_FIELD}_${string}`]: any;
 };
+type internal_FORM_DEFAULTS_FIELD = typeof FORM_DEFAULTS_FIELD;
 declare const setFormDefaults: <DataType = any>(formId: string, defaultValues: Partial<DataType>) => FormDefaults;
 
-type FormProps<DataType> = {
+type SubactionData<DataType, Subaction extends string | undefined> = DataType & {
+    subaction: Subaction;
+};
+type DefaultValuesForSubaction<DataType, Subaction extends string | undefined> = Subaction extends string ? SubactionData<DataType, Subaction> extends undefined ? DataType : SubactionData<DataType, Subaction> : DataType;
+type FormProps<DataType, Subaction extends string | undefined> = {
     /**
      * A `Validator` object that describes how to validate the form.
      */
@@ -186,7 +196,7 @@ type FormProps<DataType> = {
      * Accepts an object of default values for the form
      * that will automatically be propagated to the form fields via `useField`.
      */
-    defaultValues?: Partial<DataType>;
+    defaultValues?: Partial<DefaultValuesForSubaction<DataType, Subaction>>;
     /**
      * A ref to the form element.
      */
@@ -196,7 +206,7 @@ type FormProps<DataType> = {
      * Setting a value here will cause the form to be submitted with an extra `subaction` value.
      * This can be useful when there are multiple forms on the screen handled by the same action.
      */
-    subaction?: string;
+    subaction?: Subaction;
     /**
      * Reset the form to the default values after the form has been successfully submitted.
      * This is useful if you want to submit the same form multiple times,
@@ -212,7 +222,7 @@ type FormProps<DataType> = {
 /**
  * The primary form component of `remix-validated-form`.
  */
-declare function ValidatedForm<DataType>({ validator, onSubmit, children, fetcher, action, defaultValues: unMemoizedDefaults, formRef: formRefProp, onReset, subaction, resetAfterSubmit, disableFocusOnError, method, replace, id, ...rest }: FormProps<DataType>): JSX.Element;
+declare function ValidatedForm<DataType, Subaction extends string | undefined>({ validator, onSubmit, children, fetcher, action, defaultValues: unMemoizedDefaults, formRef: formRefProp, onReset, subaction, resetAfterSubmit, disableFocusOnError, method, replace, id, preventScrollReset, relative, encType, ...rest }: FormProps<DataType, Subaction>): JSX.Element;
 
 /**
  * Used to create a validator for a form.
@@ -311,6 +321,18 @@ type FieldArrayValidationBehaviorOptions = {
     initial: FieldArrayValidationBehavior;
     whenSubmitted: FieldArrayValidationBehavior;
 };
+type FieldArrayItem<T> = {
+    /**
+     * The default value of the item.
+     * This does not update as the field is changed by the user.
+     */
+    defaultValue: T;
+    /**
+     * A unique key for the item.
+     * Use this as the key prop when rendering the item.
+     */
+    key: string;
+};
 type FieldArrayHelpers<Item = any> = {
     push: (item: Item) => void;
     swap: (indexA: number, indexB: number) => void;
@@ -325,13 +347,13 @@ type UseFieldArrayOptions = {
     formId?: string;
     validationBehavior?: Partial<FieldArrayValidationBehaviorOptions>;
 };
-declare function useFieldArray<Item = any>(name: string, { formId, validationBehavior }?: UseFieldArrayOptions): [itemDefaults: Item[], helpers: FieldArrayHelpers<any>, error: string | undefined];
-type FieldArrayProps = {
+declare function useFieldArray<Item = any>(name: string, { formId, validationBehavior }?: UseFieldArrayOptions): [items: FieldArrayItem<Item>[], helpers: FieldArrayHelpers<any>, error: string | undefined];
+type FieldArrayProps<Item> = {
     name: string;
-    children: (itemDefaults: any[], helpers: FieldArrayHelpers, error: string | undefined) => React.ReactNode;
+    children: (items: FieldArrayItem<Item>[], helpers: FieldArrayHelpers<Item>, error: string | undefined) => React.ReactNode;
     formId?: string;
     validationBehavior?: FieldArrayValidationBehaviorOptions;
 };
-declare const FieldArray: ({ name, children, formId, validationBehavior, }: FieldArrayProps) => JSX.Element;
+declare function FieldArray<Item = any>({ name, children, formId, validationBehavior, }: FieldArrayProps<Item>): JSX.Element;
 
-export { BaseResult, CreateValidatorArg, ErrorResult, FieldArray, FieldArrayHelpers, FieldArrayProps, FieldErrors, FieldProps, FormContextValue, FormDefaults, FormProps, GenericObject, Invalid, SuccessResult, TouchedFields, Valid, ValidateFieldResult, ValidatedForm, ValidationErrorResponseData, ValidationResult, Validator, ValidatorData, ValidatorError, createValidator, setFormDefaults, useControlField, useField, useFieldArray, useFormContext, useIsSubmitting, useIsValid, useUpdateControlledField, validationError };
+export { BaseResult, CreateValidatorArg, ErrorResult, FieldArray, FieldArrayHelpers, FieldArrayProps, FieldErrors, FieldProps, FormContextValue, FormDefaults, FormProps, GenericObject, Invalid, SuccessResult, TouchedFields, Valid, ValidateFieldResult, ValidatedForm, ValidationErrorResponseData, ValidationResult, Validator, ValidatorData, ValidatorError, createValidator, internal_FORM_DEFAULTS_FIELD, setFormDefaults, useControlField, useField, useFieldArray, useFormContext, useIsSubmitting, useIsValid, useUpdateControlledField, validationError };

package/dist/index.esm.js

@@ -85,7 +85,7 @@ var createGetInputProps = ({
 };
 
 // src/internal/hooks.ts
-import { useActionData, useMatches, useTransition } from "@remix-run/react";
+import { useActionData, useMatches, useNavigation } from "@remix-run/react";
 import { useCallback, useContext } from "react";
 
 // ../set-get/src/stringToPathArray.ts
@@ -266,7 +266,9 @@ function sparseSplice(array, start, deleteCount, item) {
   }
   if (arguments.length === 4)
     return array.splice(start, deleteCount, item);
-  return array.splice(start, deleteCount);
+  else if (arguments.length === 3)
+    return array.splice(start, deleteCount);
+  return array.splice(start);
 }
 var move = (array, from2, to) => {
   const [item] = sparseSplice(array, from2, 1);
@@ -275,6 +277,12 @@ var move = (array, from2, to) => {
 var insert = (array, index, value) => {
   sparseSplice(array, index, 0, value);
 };
+var insertEmpty = (array, index) => {
+  const tail = sparseSplice(array, index);
+  tail.forEach((item, i) => {
+    sparseSplice(array, index + i + 1, 0, item);
+  });
+};
 var remove = (array, index) => {
   sparseSplice(array, index, 1);
 };
@@ -404,6 +412,29 @@ if (void 0) {
       expect(array).toEqual([true, void 0, void 0, true]);
     });
   });
+  describe("insertEmpty", () => {
+    it("should insert an empty item at a given index", () => {
+      const array = [1, 2, 3];
+      insertEmpty(array, 1);
+      expect(array).toStrictEqual([1, , 2, 3]);
+      expect(array).not.toStrictEqual([1, void 0, 2, 3]);
+    });
+    it("should work with already sparse arrays", () => {
+      const array = [, , 1, , 2, , 3];
+      insertEmpty(array, 3);
+      expect(array).toStrictEqual([, , 1, , , 2, , 3]);
+      expect(array).not.toStrictEqual([
+        void 0,
+        void 0,
+        1,
+        void 0,
+        void 0,
+        2,
+        void 0,
+        3
+      ]);
+    });
+  });
   describe("remove", () => {
     it("should remove an item at a given index", () => {
       const array = [1, 2, 3];
@@ -585,10 +616,12 @@ var defaultFormState = {
   reset: () => noOp,
   syncFormProps: noOp,
   setFormElement: noOp,
-  validateField: async () => null,
   validate: async () => {
     throw new Error("Validate called before form was initialized.");
   },
+  smartValidate: async () => {
+    throw new Error("Validate called before form was initialized.");
+  },
   submit: async () => {
     throw new Error("Submit called before form was initialized.");
   },
@@ -671,8 +704,8 @@ var createFormState = (set, get2) => ({
       state.formElement = formElement;
     });
   },
-  validateField: async (field) => {
-    var _a, _b, _c;
+  validate: async () => {
+    var _a;
     const formElement = get2().formElement;
     invariant2(
       formElement,
@@ -681,22 +714,14 @@ var createFormState = (set, get2) => ({
     const validator = (_a = get2().formProps) == null ? void 0 : _a.validator;
     invariant2(
       validator,
-      "Cannot validator. This is probably a bug in remix-validated-form."
-    );
-    await ((_c = (_b = get2().controlledFields).awaitValueUpdate) == null ? void 0 : _c.call(_b, field));
-    const { error } = await validator.validateField(
-      new FormData(formElement),
-      field
+      "Cannot find validator. This is probably a bug in remix-validated-form."
     );
-    if (error) {
-      get2().setFieldError(field, error);
-      return error;
-    } else {
-      get2().clearFieldError(field);
-      return null;
-    }
+    const result = await validator.validate(new FormData(formElement));
+    if (result.error)
+      get2().setFieldErrors(result.error.fieldErrors);
+    return result;
   },
-  validate: async () => {
+  smartValidate: async ({ alwaysIncludeErrorsFromFields = [] } = {}) => {
     var _a;
     const formElement = get2().formElement;
     invariant2(
@@ -706,12 +731,75 @@ var createFormState = (set, get2) => ({
     const validator = (_a = get2().formProps) == null ? void 0 : _a.validator;
     invariant2(
       validator,
-      "Cannot validator. This is probably a bug in remix-validated-form."
+      "Cannot find validator. This is probably a bug in remix-validated-form."
     );
-    const result = await validator.validate(new FormData(formElement));
-    if (result.error)
-      get2().setFieldErrors(result.error.fieldErrors);
-    return result;
+    await Promise.all(
+      alwaysIncludeErrorsFromFields.map(
+        (field) => {
+          var _a2, _b;
+          return (_b = (_a2 = get2().controlledFields).awaitValueUpdate) == null ? void 0 : _b.call(_a2, field);
+        }
+      )
+    );
+    const validationResult = await validator.validate(
+      new FormData(formElement)
+    );
+    if (!validationResult.error) {
+      const hadErrors = Object.keys(get2().fieldErrors).length > 0;
+      if (hadErrors)
+        get2().setFieldErrors({});
+      return validationResult;
+    }
+    const {
+      error: { fieldErrors }
+    } = validationResult;
+    const errorFields = /* @__PURE__ */ new Set();
+    const incomingErrors = /* @__PURE__ */ new Set();
+    const prevErrors = /* @__PURE__ */ new Set();
+    Object.keys(fieldErrors).forEach((field) => {
+      errorFields.add(field);
+      incomingErrors.add(field);
+    });
+    Object.keys(get2().fieldErrors).forEach((field) => {
+      errorFields.add(field);
+      prevErrors.add(field);
+    });
+    const fieldsToUpdate = /* @__PURE__ */ new Set();
+    const fieldsToDelete = /* @__PURE__ */ new Set();
+    errorFields.forEach((field) => {
+      if (!incomingErrors.has(field)) {
+        fieldsToDelete.add(field);
+        return;
+      }
+      if (prevErrors.has(field) && incomingErrors.has(field)) {
+        if (fieldErrors[field] !== get2().fieldErrors[field])
+          fieldsToUpdate.add(field);
+        return;
+      }
+      if (alwaysIncludeErrorsFromFields.includes(field)) {
+        fieldsToUpdate.add(field);
+        return;
+      }
+      if (!prevErrors.has(field)) {
+        const fieldTouched = get2().touchedFields[field];
+        const formHasBeenSubmitted = get2().hasBeenSubmitted;
+        if (fieldTouched || formHasBeenSubmitted)
+          fieldsToUpdate.add(field);
+        return;
+      }
+    });
+    if (fieldsToDelete.size === 0 && fieldsToUpdate.size === 0) {
+      return { ...validationResult, error: { fieldErrors: get2().fieldErrors } };
+    }
+    set((state) => {
+      fieldsToDelete.forEach((field) => {
+        delete state.fieldErrors[field];
+      });
+      fieldsToUpdate.forEach((field) => {
+        state.fieldErrors[field] = fieldErrors[field];
+      });
+    });
+    return { ...validationResult, error: { fieldErrors: get2().fieldErrors } };
   },
   submit: () => {
     const formElement = get2().formElement;
@@ -864,12 +952,12 @@ var createFormState = (set, get2) => ({
           mutateAsArray(
             fieldName,
             state.touchedFields,
-            (array) => insert(array, index, false)
+            (array) => insertEmpty(array, index)
           );
           mutateAsArray(
             fieldName,
             state.fieldErrors,
-            (array) => insert(array, index, void 0)
+            (array) => insertEmpty(array, index)
           );
         });
         get2().controlledFields.kickoffValueUpdate(fieldName);
@@ -921,12 +1009,12 @@ var createFormState = (set, get2) => ({
           mutateAsArray(
             fieldName,
             state.touchedFields,
-            (array) => array.unshift(false)
+            (array) => insertEmpty(array, 0)
           );
           mutateAsArray(
             fieldName,
             state.fieldErrors,
-            (array) => array.unshift(void 0)
+            (array) => insertEmpty(array, 0)
           );
         });
       },
@@ -1058,8 +1146,8 @@ var useDefaultValuesForForm = (context) => {
 var useHasActiveFormSubmit = ({
   fetcher
 }) => {
-  const transition = useTransition();
-  const hasActiveSubmission = fetcher ? fetcher.state === "submitting" : !!transition.submission;
+  let navigation = useNavigation();
+  const hasActiveSubmission = fetcher ? fetcher.state === "submitting" : navigation.state === "submitting";
   return hasActiveSubmission;
 };
 var useFieldTouched = (field, { formId }) => {
@@ -1092,7 +1180,7 @@ var useFieldDefaultValue = (name, context) => {
 var useInternalIsSubmitting = (formId) => useFormStore(formId, (state) => state.isSubmitting);
 var useInternalIsValid = (formId) => useFormStore(formId, (state) => state.isValid());
 var useInternalHasBeenSubmitted = (formId) => useFormStore(formId, (state) => state.hasBeenSubmitted);
-var useValidateField = (formId) => useFormStore(formId, (state) => state.validateField);
+var useSmartValidate = (formId) => useFormStore(formId, (state) => state.smartValidate);
 var useValidate = (formId) => useFormStore(formId, (state) => state.validate);
 var noOpReceiver = () => () => {
 };
@@ -1203,7 +1291,7 @@ var useField = (name, options) => {
   const error = useFieldError(name, formContext);
   const clearError = useClearError(formContext);
   const hasBeenSubmitted = useInternalHasBeenSubmitted(formContext.formId);
-  const validateField = useValidateField(formContext.formId);
+  const smartValidate = useSmartValidate(formContext.formId);
   const registerReceiveFocus = useRegisterReceiveFocus(formContext.formId);
   useEffect2(() => {
     if (handleReceiveFocus)
@@ -1213,9 +1301,7 @@ var useField = (name, options) => {
     const helpers = {
       error,
       clearError: () => clearError(name),
-      validate: () => {
-        validateField(name);
-      },
+      validate: () => smartValidate({ alwaysIncludeErrorsFromFields: [name] }),
       defaultValue,
       touched,
       setTouched
@@ -1239,7 +1325,7 @@ var useField = (name, options) => {
     name,
     hasBeenSubmitted,
     options == null ? void 0 : options.validationBehavior,
-    validateField
+    smartValidate
   ]);
   return field;
 };
@@ -1461,6 +1547,9 @@ function ValidatedForm({
   method,
   replace: replace2,
   id,
+  preventScrollReset,
+  relative,
+  encType,
   ...rest
 }) {
   var _a;
@@ -1553,11 +1642,11 @@ function ValidatedForm({
     startSubmit();
     const submitter = nativeEvent.submitter;
     const formMethod = (submitter == null ? void 0 : submitter.formMethod) || method;
-    const formDataToValidate = getDataFromForm(target);
+    const formData = getDataFromForm(target);
     if (submitter == null ? void 0 : submitter.name) {
-      formDataToValidate.append(submitter.name, submitter.value);
+      formData.append(submitter.name, submitter.value);
     }
-    const result = await validator.validate(formDataToValidate);
+    const result = await validator.validate(formData);
     if (result.error) {
       setFieldErrors(result.error.fieldErrors);
       endSubmit();
@@ -1576,13 +1665,18 @@ function ValidatedForm({
         endSubmit();
         return;
       }
+      const opts = {
+        method: formMethod,
+        replace: replace2,
+        preventScrollReset,
+        relative,
+        action,
+        encType
+      };
       if (fetcher)
-        fetcher.submit(submitter || target, { method: formMethod });
+        fetcher.submit(formData, opts);
       else
-        submit(submitter || target, {
-          replace: replace2,
-          method: formMethod
-        });
+        submit(formData, opts);
     }
   };
   return /* @__PURE__ */ jsx(
@@ -1593,7 +1687,10 @@ function ValidatedForm({
       id,
       action,
       method,
+      encType,
       replace: replace2,
+      preventScrollReset,
+      relative,
       onSubmit: (e) => {
         e.preventDefault();
         handleSubmit(
@@ -1711,7 +1808,7 @@ var useFormState = (formId) => {
 var useFormHelpers = (formId) => {
   const formContext = useInternalFormContext(formId, "useFormHelpers");
   const setTouched = useSetTouched(formContext);
-  const validateField = useValidateField(formContext.formId);
+  const validateField = useSmartValidate(formContext.formId);
   const validate = useValidate(formContext.formId);
   const clearError = useClearError(formContext);
   const setFieldErrors = useSetFieldErrors(formContext.formId);
@@ -1721,7 +1818,13 @@ var useFormHelpers = (formId) => {
   return useMemo3(
     () => ({
       setTouched,
-      validateField,
+      validateField: async (fieldName) => {
+        var _a, _b;
+        const res = await validateField({
+          alwaysIncludeErrorsFromFields: [fieldName]
+        });
+        return (_b = (_a = res.error) == null ? void 0 : _a.fieldErrors[fieldName]) != null ? _b : null;
+      },
       clearError,
       validate,
       clearAllErrors: () => setFieldErrors({}),
@@ -1794,7 +1897,8 @@ var useFormContext = (formId) => {
 };
 
 // src/internal/state/fieldArray.tsx
-import { useMemo as useMemo5 } from "react";
+import { nanoid } from "nanoid";
+import { useMemo as useMemo5, useRef as useRef5 } from "react";
 import { useCallback as useCallback6 } from "react";
 import invariant4 from "tiny-invariant";
 import { Fragment as Fragment2, jsx as jsx2 } from "react/jsx-runtime";
@@ -1802,7 +1906,7 @@ var useInternalFieldArray = (context, field, validationBehavior) => {
   const value = useFieldDefaultValue(field, context);
   useRegisterControlledField(context, field);
   const hasBeenSubmitted = useInternalHasBeenSubmitted(context.formId);
-  const validateField = useValidateField(context.formId);
+  const validateField = useSmartValidate(context.formId);
   const error = useFieldError(field, context);
   const resolvedValidationBehavior = {
     initial: "onSubmit",
@@ -1812,7 +1916,7 @@ var useInternalFieldArray = (context, field, validationBehavior) => {
   const behavior = hasBeenSubmitted ? resolvedValidationBehavior.whenSubmitted : resolvedValidationBehavior.initial;
   const maybeValidate = useCallback6(() => {
     if (behavior === "onChange") {
-      validateField(field);
+      validateField({ alwaysIncludeErrorsFromFields: [field] });
     }
   }, [behavior, field, validateField]);
   invariant4(
@@ -1823,56 +1927,78 @@ var useInternalFieldArray = (context, field, validationBehavior) => {
     context.formId,
     (state) => state.controlledFields.array
   );
+  const arrayValue = useMemo5(() => value != null ? value : [], [value]);
+  const keyRef = useRef5([]);
+  if (keyRef.current.length !== arrayValue.length) {
+    keyRef.current = arrayValue.map(() => nanoid());
+  }
   const helpers = useMemo5(
     () => ({
       push: (item) => {
         arr.push(field, item);
+        keyRef.current.push(nanoid());
         maybeValidate();
       },
       swap: (indexA, indexB) => {
         arr.swap(field, indexA, indexB);
+        swap(keyRef.current, indexA, indexB);
         maybeValidate();
       },
       move: (from2, to) => {
         arr.move(field, from2, to);
+        move(keyRef.current, from2, to);
         maybeValidate();
       },
       insert: (index, value2) => {
         arr.insert(field, index, value2);
+        insert(keyRef.current, index, nanoid());
         maybeValidate();
       },
       unshift: (value2) => {
         arr.unshift(field, value2);
+        keyRef.current.unshift(nanoid());
         maybeValidate();
       },
       remove: (index) => {
         arr.remove(field, index);
+        remove(keyRef.current, index);
         maybeValidate();
       },
       pop: () => {
         arr.pop(field);
+        keyRef.current.pop();
         maybeValidate();
       },
       replace: (index, value2) => {
         arr.replace(field, index, value2);
+        keyRef.current[index] = nanoid();
         maybeValidate();
       }
     }),
     [arr, field, maybeValidate]
   );
-  const arrayValue = useMemo5(() => value != null ? value : [], [value]);
-  return [arrayValue, helpers, error];
+  const valueWithKeys = useMemo5(() => {
+    const result = [];
+    arrayValue.forEach((item, index) => {
+      result[index] = {
+        key: keyRef.current[index],
+        defaultValue: item
+      };
+    });
+    return result;
+  }, [arrayValue]);
+  return [valueWithKeys, helpers, error];
 };
 function useFieldArray(name, { formId, validationBehavior } = {}) {
   const context = useInternalFormContext(formId, "FieldArray");
   return useInternalFieldArray(context, name, validationBehavior);
 }
-var FieldArray = ({
+function FieldArray({
   name,
   children,
   formId,
   validationBehavior
-}) => {
+}) {
   const context = useInternalFormContext(formId, "FieldArray");
   const [value, helpers, error] = useInternalFieldArray(
     context,
@@ -1880,7 +2006,7 @@ var FieldArray = ({
     validationBehavior
   );
   return /* @__PURE__ */ jsx2(Fragment2, { children: children(value, helpers, error) });
-};
+}
 export {
   FieldArray,
   ValidatedForm,