remix-validated-form 4.6.12 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remix-validated-form",
-  "version": "4.6.12",
+  "version": "5.0.0",
   "description": "Form component and utils for easy form validation in remix",
   "main": "./dist/index.cjs.js",
   "module": "./dist/index.esm.js",
@@ -33,14 +33,14 @@
     "validation"
   ],
   "peerDependencies": {
-    "@remix-run/react": "1.x",
+    "@remix-run/react": ">= 1.15.0",
     "@remix-run/server-runtime": "1.x",
     "react": "^17.0.2 || ^18.0.0"
   },
   "devDependencies": {
-    "@remix-run/node": "^1.9.0",
-    "@remix-run/react": "^1.9.0",
-    "@remix-run/server-runtime": "^1.9.0",
+    "@remix-run/node": "^1.16.1",
+    "@remix-run/react": "^1.16.1",
+    "@remix-run/server-runtime": "^1.16.1",
     "@testing-library/react": "^13.3.0",
     "@types/lodash.get": "^4.4.7",
     "@types/react": "^18.0.9",
@@ -55,6 +55,7 @@
   "dependencies": {
     "immer": "^9.0.12",
     "lodash.get": "^4.4.2",
+    "nanoid": "3.3.6",
     "remeda": "^1.2.0",
     "tiny-invariant": "^1.2.0",
     "zustand": "^4.3.0"

package/src/ValidatedForm.tsx

@@ -3,6 +3,8 @@ import {
   Form as RemixForm,
   FormMethod,
   useSubmit,
+  SubmitOptions,
+  FormEncType,
 } from "@remix-run/react";
 import React, {
   ComponentProps,
@@ -41,7 +43,24 @@ import {
 } from "./internal/util";
 import { FieldErrors, Validator } from "./validation/types";
 
-export type FormProps<DataType> = {
+type SubactionData<
+  DataType,
+  Subaction extends string | undefined
+> = DataType & { subaction: Subaction };
+
+// Not all validation libraries support encoding a literal value in the schema type (e.g. yup).
+// This condition here allows us to provide strictness for users who are using a validation library that does support it,
+// but also allows us to support users who are using a validation library that doesn't support it.
+type DefaultValuesForSubaction<
+  DataType,
+  Subaction extends string | undefined
+> = Subaction extends string // Not all validation libraries support encoding a literal value in the schema type.
+  ? SubactionData<DataType, Subaction> extends undefined
+    ? DataType
+    : SubactionData<DataType, Subaction>
+  : DataType;
+
+export type FormProps<DataType, Subaction extends string | undefined> = {
   /**
    * A `Validator` object that describes how to validate the form.
    */
@@ -64,7 +83,7 @@ export 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.
    */
@@ -74,7 +93,7 @@ export 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,
@@ -202,7 +221,7 @@ type HTMLFormSubmitter = HTMLButtonElement | HTMLInputElement;
 /**
  * The primary form component of `remix-validated-form`.
  */
-export function ValidatedForm<DataType>({
+export function ValidatedForm<DataType, Subaction extends string | undefined>({
   validator,
   onSubmit,
   children,
@@ -217,8 +236,11 @@ export function ValidatedForm<DataType>({
   method,
   replace,
   id,
+  preventScrollReset,
+  relative,
+  encType,
   ...rest
-}: FormProps<DataType>) {
+}: FormProps<DataType, Subaction>) {
   const formId = useFormId(id);
   const providedDefaultValues = useDeepEqualsMemo(unMemoizedDefaults);
   const contextValue = useMemo<InternalFormContextValue>(
@@ -321,12 +343,12 @@ export function ValidatedForm<DataType>({
     startSubmit();
     const submitter = nativeEvent.submitter as HTMLFormSubmitter | null;
     const formMethod = (submitter?.formMethod as FormMethod) || method;
-    const formDataToValidate = getDataFromForm(target);
+    const formData = getDataFromForm(target);
     if (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();
@@ -346,17 +368,22 @@ export function ValidatedForm<DataType>({
         return;
       }
 
+      const opts: SubmitOptions = {
+        method: formMethod,
+        replace,
+        preventScrollReset,
+        relative,
+        action,
+        encType: encType as FormEncType | undefined,
+      };
+
       // We deviate from the Remix code here a bit because of our async submit.
       // In Remix's `FormImpl`, they use `event.currentTarget` to get the form,
       // but we already have the form in `formRef.current` so we can just use that.
       // If we use `event.currentTarget` here, it will break because `currentTarget`
       // will have changed since the start of the submission.
-      if (fetcher) fetcher.submit(submitter || target, { method: formMethod });
-      else
-        submit(submitter || target, {
-          replace,
-          method: formMethod,
-        });
+      if (fetcher) fetcher.submit(formData, opts);
+      else submit(formData, opts);
     }
   };
 
@@ -367,7 +394,10 @@ export function ValidatedForm<DataType>({
       id={id}
       action={action}
       method={method}
+      encType={encType}
       replace={replace}
+      preventScrollReset={preventScrollReset}
+      relative={relative}
       onSubmit={(e) => {
         e.preventDefault();
         handleSubmit(

package/src/hooks.ts

@@ -13,8 +13,8 @@ import {
   useInternalIsSubmitting,
   useInternalIsValid,
   useInternalHasBeenSubmitted,
-  useValidateField,
   useRegisterReceiveFocus,
+  useSmartValidate,
 } from "./internal/hooks";
 import {
   useControllableValue,
@@ -23,7 +23,7 @@ import {
 
 /**
  * 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
@@ -106,7 +106,7 @@ export const useField = (
   const clearError = useClearError(formContext);
 
   const hasBeenSubmitted = useInternalHasBeenSubmitted(formContext.formId);
-  const validateField = useValidateField(formContext.formId);
+  const smartValidate = useSmartValidate(formContext.formId);
   const registerReceiveFocus = useRegisterReceiveFocus(formContext.formId);
 
   useEffect(() => {
@@ -118,9 +118,7 @@ export const useField = (
     const helpers = {
       error,
       clearError: () => clearError(name),
-      validate: () => {
-        validateField(name);
-      },
+      validate: () => smartValidate({ alwaysIncludeErrorsFromFields: [name] }),
       defaultValue,
       touched,
       setTouched,
@@ -144,7 +142,7 @@ export const useField = (
     name,
     hasBeenSubmitted,
     options?.validationBehavior,
-    validateField,
+    smartValidate,
   ]);
 
   return field;

package/src/internal/hooks.ts

@@ -1,4 +1,4 @@
-import { useActionData, useMatches, useTransition } from "@remix-run/react";
+import { useActionData, useMatches, useNavigation } from "@remix-run/react";
 import { useCallback, useContext } from "react";
 import { getPath } from "set-get";
 import invariant from "tiny-invariant";
@@ -107,10 +107,10 @@ export const useDefaultValuesForForm = (
 export const useHasActiveFormSubmit = ({
   fetcher,
 }: InternalFormContextValue): boolean => {
-  const transition = useTransition();
+  let navigation = useNavigation();
   const hasActiveSubmission = fetcher
     ? fetcher.state === "submitting"
-    : !!transition.submission;
+    : navigation.state === "submitting";
   return hasActiveSubmission;
 };
 
@@ -169,8 +169,8 @@ export const useInternalIsValid = (formId: InternalFormId) =>
 export const useInternalHasBeenSubmitted = (formId: InternalFormId) =>
   useFormStore(formId, (state) => state.hasBeenSubmitted);
 
-export const useValidateField = (formId: InternalFormId) =>
-  useFormStore(formId, (state) => state.validateField);
+export const useSmartValidate = (formId: InternalFormId) =>
+  useFormStore(formId, (state) => state.smartValidate);
 
 export const useValidate = (formId: InternalFormId) =>
   useFormStore(formId, (state) => state.validate);

package/src/internal/state/arrayUtil.ts

@@ -20,6 +20,8 @@ export const getArray = (values: any, field: string): unknown[] => {
   return value;
 };
 
+export const sparseCopy = <T>(array: T[]): T[] => array.slice();
+
 export const swap = (array: unknown[], indexA: number, indexB: number) => {
   const itemA = array[indexA];
   const itemB = array[indexB];
@@ -46,7 +48,7 @@ export const swap = (array: unknown[], indexA: number, indexB: number) => {
 function sparseSplice(
   array: unknown[],
   start: number,
-  deleteCount: number,
+  deleteCount?: number,
   item?: unknown
 ) {
   // Inserting an item into an array won't behave as we need it to if the array isn't
@@ -56,8 +58,9 @@ function sparseSplice(
   }
 
   // If we just pass item in, it'll be undefined and splice will delete the item.
-  if (arguments.length === 4) return array.splice(start, deleteCount, item);
-  return array.splice(start, deleteCount);
+  if (arguments.length === 4) return array.splice(start, deleteCount!, item);
+  else if (arguments.length === 3) return array.splice(start, deleteCount);
+  return array.splice(start);
 }
 
 export const move = (array: unknown[], from: number, to: number) => {
@@ -69,6 +72,13 @@ export const insert = (array: unknown[], index: number, value: unknown) => {
   sparseSplice(array, index, 0, value);
 };
 
+export const insertEmpty = (array: unknown[], index: number) => {
+  const tail = sparseSplice(array, index);
+  tail.forEach((item, i) => {
+    sparseSplice(array, index + i + 1, 0, item);
+  });
+};
+
 export const remove = (array: unknown[], index: number) => {
   sparseSplice(array, index, 1);
 };
@@ -240,6 +250,34 @@ if (import.meta.vitest) {
     });
   });
 
+  describe("insertEmpty", () => {
+    it("should insert an empty item at a given index", () => {
+      const array = [1, 2, 3];
+      insertEmpty(array, 1);
+      // eslint-disable-next-line no-sparse-arrays
+      expect(array).toStrictEqual([1, , 2, 3]);
+      expect(array).not.toStrictEqual([1, undefined, 2, 3]);
+    });
+
+    it("should work with already sparse arrays", () => {
+      // eslint-disable-next-line no-sparse-arrays
+      const array = [, , 1, , 2, , 3];
+      insertEmpty(array, 3);
+      // eslint-disable-next-line no-sparse-arrays
+      expect(array).toStrictEqual([, , 1, , , 2, , 3]);
+      expect(array).not.toStrictEqual([
+        undefined,
+        undefined,
+        1,
+        undefined,
+        undefined,
+        2,
+        undefined,
+        3,
+      ]);
+    });
+  });
+
   describe("remove", () => {
     it("should remove an item at a given index", () => {
       const array = [1, 2, 3];

package/src/internal/state/createFormStore.ts

@@ -22,6 +22,10 @@ export type SyncedFormProps = {
   validator: Validator<unknown>;
 };
 
+export type SmartValidateOpts = {
+  alwaysIncludeErrorsFromFields?: string[];
+};
+
 export type FormStoreState = {
   forms: { [formId: InternalFormId]: FormState };
   form: (formId: InternalFormId) => FormState;
@@ -49,8 +53,10 @@ export type FormState = {
   reset: () => void;
   syncFormProps: (props: SyncedFormProps) => void;
   setFormElement: (formElement: HTMLFormElement | null) => void;
-  validateField: (fieldName: string) => Promise<string | null>;
   validate: () => Promise<ValidationResult<unknown>>;
+  smartValidate: (
+    opts?: SmartValidateOpts
+  ) => Promise<ValidationResult<unknown>>;
   resetFormElement: () => void;
   submit: () => void;
   getValues: () => FormData;
@@ -101,12 +107,15 @@ const defaultFormState: FormState = {
   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.");
   },
@@ -210,7 +219,7 @@ const createFormState = (
       state.formElement = formElement as any;
     });
   },
-  validateField: async (field: string) => {
+  validate: async () => {
     const formElement = get().formElement;
     invariant(
       formElement,
@@ -220,26 +229,15 @@ const createFormState = (
     const validator = get().formProps?.validator;
     invariant(
       validator,
-      "Cannot validator. This is probably a bug in remix-validated-form."
+      "Cannot find validator. This is probably a bug in remix-validated-form."
     );
 
-    await get().controlledFields.awaitValueUpdate?.(field);
-
-    const { error } = await validator.validateField(
-      new FormData(formElement),
-      field
-    );
-
-    if (error) {
-      get().setFieldError(field, error);
-      return error;
-    } else {
-      get().clearFieldError(field);
-      return null;
-    }
+    const result = await validator.validate(new FormData(formElement));
+    if (result.error) get().setFieldErrors(result.error.fieldErrors);
+    return result;
   },
 
-  validate: async () => {
+  smartValidate: async ({ alwaysIncludeErrorsFromFields = [] } = {}) => {
     const formElement = get().formElement;
     invariant(
       formElement,
@@ -249,12 +247,91 @@ const createFormState = (
     const validator = get().formProps?.validator;
     invariant(
       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) get().setFieldErrors(result.error.fieldErrors);
-    return result;
+    await Promise.all(
+      alwaysIncludeErrorsFromFields.map((field) =>
+        get().controlledFields.awaitValueUpdate?.(field)
+      )
+    );
+
+    const validationResult = await validator.validate(
+      new FormData(formElement)
+    );
+    if (!validationResult.error) {
+      // Only update the field errors if it hasn't changed
+      const hadErrors = Object.keys(get().fieldErrors).length > 0;
+      if (hadErrors) get().setFieldErrors({});
+      return validationResult;
+    }
+
+    const {
+      error: { fieldErrors },
+    } = validationResult;
+    const errorFields = new Set<string>();
+    const incomingErrors = new Set<string>();
+    const prevErrors = new Set<string>();
+
+    Object.keys(fieldErrors).forEach((field) => {
+      errorFields.add(field);
+      incomingErrors.add(field);
+    });
+
+    Object.keys(get().fieldErrors).forEach((field) => {
+      errorFields.add(field);
+      prevErrors.add(field);
+    });
+
+    const fieldsToUpdate = new Set<string>();
+    const fieldsToDelete = new Set<string>();
+
+    errorFields.forEach((field) => {
+      // If an error has been cleared, remove it.
+      if (!incomingErrors.has(field)) {
+        fieldsToDelete.add(field);
+        return;
+      }
+
+      // If an error has changed, we should update it.
+      if (prevErrors.has(field) && incomingErrors.has(field)) {
+        // Only update if the error has changed to avoid unnecessary rerenders
+        if (fieldErrors[field] !== get().fieldErrors[field])
+          fieldsToUpdate.add(field);
+        return;
+      }
+
+      // If the error is always included, then we should update it.
+      if (alwaysIncludeErrorsFromFields.includes(field)) {
+        fieldsToUpdate.add(field);
+        return;
+      }
+
+      // If the error is new, then only update if the field has been touched
+      // or if the form has been submitted
+      if (!prevErrors.has(field)) {
+        const fieldTouched = get().touchedFields[field];
+        const formHasBeenSubmitted = get().hasBeenSubmitted;
+        if (fieldTouched || formHasBeenSubmitted) fieldsToUpdate.add(field);
+        return;
+      }
+    });
+
+    if (fieldsToDelete.size === 0 && fieldsToUpdate.size === 0) {
+      return { ...validationResult, error: { fieldErrors: get().fieldErrors } };
+    }
+
+    set((state) => {
+      fieldsToDelete.forEach((field) => {
+        delete state.fieldErrors[field];
+      });
+
+      fieldsToUpdate.forEach((field) => {
+        state.fieldErrors[field] = fieldErrors[field];
+      });
+    });
+
+    return { ...validationResult, error: { fieldErrors: get().fieldErrors } };
   },
 
   submit: () => {
@@ -409,10 +486,10 @@ const createFormState = (
           );
           // Even though this is a new item, we need to push around other items.
           arrayUtil.mutateAsArray(fieldName, state.touchedFields, (array) =>
-            arrayUtil.insert(array, index, false)
+            arrayUtil.insertEmpty(array, index)
           );
           arrayUtil.mutateAsArray(fieldName, state.fieldErrors, (array) =>
-            arrayUtil.insert(array, index, undefined)
+            arrayUtil.insertEmpty(array, index)
           );
         });
         get().controlledFields.kickoffValueUpdate(fieldName);
@@ -458,10 +535,10 @@ const createFormState = (
             .getArray(state.currentDefaultValues, fieldName)
             .unshift(value);
           arrayUtil.mutateAsArray(fieldName, state.touchedFields, (array) =>
-            array.unshift(false)
+            arrayUtil.insertEmpty(array, 0)
           );
           arrayUtil.mutateAsArray(fieldName, state.fieldErrors, (array) =>
-            array.unshift(undefined)
+            arrayUtil.insertEmpty(array, 0)
           );
         });
       },

package/src/internal/state/fieldArray.tsx

@@ -1,4 +1,5 @@
-import React, { useMemo } from "react";
+import { nanoid } from "nanoid";
+import React, { useMemo, useRef, useState } from "react";
 import { useCallback } from "react";
 import invariant from "tiny-invariant";
 import { InternalFormContextValue } from "../formContext";
@@ -7,8 +8,9 @@ import {
   useFieldError,
   useInternalFormContext,
   useInternalHasBeenSubmitted,
-  useValidateField,
+  useSmartValidate,
 } from "../hooks";
+import * as arrayUtil from "./arrayUtil";
 import { useRegisterControlledField } from "./controlledFields";
 import { useFormStore } from "./storeHooks";
 
@@ -19,6 +21,19 @@ export type FieldArrayValidationBehaviorOptions = {
   whenSubmitted: FieldArrayValidationBehavior;
 };
 
+export 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;
+};
+
 const useInternalFieldArray = (
   context: InternalFormContextValue,
   field: string,
@@ -27,7 +42,7 @@ const useInternalFieldArray = (
   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: FieldArrayValidationBehaviorOptions = {
@@ -42,7 +57,7 @@ const useInternalFieldArray = (
 
   const maybeValidate = useCallback(() => {
     if (behavior === "onChange") {
-      validateField(field);
+      validateField({ alwaysIncludeErrorsFromFields: [field] });
     }
   }, [behavior, field, validateField]);
 
@@ -56,47 +71,74 @@ const useInternalFieldArray = (
     (state) => state.controlledFields.array
   );
 
+  const arrayValue = useMemo<unknown[]>(() => value ?? [], [value]);
+  const keyRef = useRef<string[]>([]);
+
+  // If the lengths don't match up it means one of two things
+  // 1. The array has been modified outside of this hook
+  // 2. We're initializing the array
+  if (keyRef.current.length !== arrayValue.length) {
+    keyRef.current = arrayValue.map(() => nanoid());
+  }
+
   const helpers = useMemo(
     () => ({
       push: (item: any) => {
         arr.push(field, item);
+        keyRef.current.push(nanoid());
         maybeValidate();
       },
       swap: (indexA: number, indexB: number) => {
         arr.swap(field, indexA, indexB);
+        arrayUtil.swap(keyRef.current, indexA, indexB);
         maybeValidate();
       },
       move: (from: number, to: number) => {
         arr.move(field, from, to);
+        arrayUtil.move(keyRef.current, from, to);
         maybeValidate();
       },
       insert: (index: number, value: any) => {
         arr.insert(field, index, value);
+        arrayUtil.insert(keyRef.current, index, nanoid());
         maybeValidate();
       },
       unshift: (value: any) => {
         arr.unshift(field, value);
+        keyRef.current.unshift(nanoid());
         maybeValidate();
       },
       remove: (index: number) => {
         arr.remove(field, index);
+        arrayUtil.remove(keyRef.current, index);
         maybeValidate();
       },
       pop: () => {
         arr.pop(field);
+        keyRef.current.pop();
         maybeValidate();
       },
       replace: (index: number, value: any) => {
         arr.replace(field, index, value);
+        keyRef.current[index] = nanoid();
         maybeValidate();
       },
     }),
     [arr, field, maybeValidate]
   );
 
-  const arrayValue = useMemo(() => value ?? [], [value]);
-
-  return [arrayValue, helpers, error] as const;
+  const valueWithKeys = useMemo(() => {
+    const result: { defaultValue: any; key: string }[] = [];
+    arrayValue.forEach((item, index) => {
+      result[index] = {
+        key: keyRef.current[index],
+        defaultValue: item,
+      };
+    });
+    return result;
+  }, [arrayValue]);
+
+  return [valueWithKeys, helpers, error] as const;
 };
 
 export type FieldArrayHelpers<Item = any> = {
@@ -122,29 +164,29 @@ export function useFieldArray<Item = any>(
   const context = useInternalFormContext(formId, "FieldArray");
 
   return useInternalFieldArray(context, name, validationBehavior) as [
-    itemDefaults: Item[],
+    items: FieldArrayItem<Item>[],
     helpers: FieldArrayHelpers,
     error: string | undefined
   ];
 }
 
-export type FieldArrayProps = {
+export type FieldArrayProps<Item> = {
   name: string;
   children: (
-    itemDefaults: any[],
-    helpers: FieldArrayHelpers,
+    items: FieldArrayItem<Item>[],
+    helpers: FieldArrayHelpers<Item>,
     error: string | undefined
   ) => React.ReactNode;
   formId?: string;
   validationBehavior?: FieldArrayValidationBehaviorOptions;
 };
 
-export const FieldArray = ({
+export function FieldArray<Item = any>({
   name,
   children,
   formId,
   validationBehavior,
-}: FieldArrayProps) => {
+}: FieldArrayProps<Item>) {
   const context = useInternalFormContext(formId, "FieldArray");
   const [value, helpers, error] = useInternalFieldArray(
     context,
@@ -152,4 +194,4 @@ export const FieldArray = ({
     validationBehavior
   );
   return <>{children(value, helpers, error)}</>;
-};
+}