remix-validated-form 1.1.1-beta.0 → 2.0.0-beta.3

package/build/validation/validation.test.js

@@ -22,6 +22,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const yup = __importStar(require("yup"));
 const zod_1 = require("zod");
 const __1 = require("..");
+const flatten_1 = require("../internal/flatten");
+const testFormData_1 = require("../test-data/testFormData");
 const withZod_1 = require("./withZod");
 const validationTestCases = [
     {
@@ -98,9 +100,75 @@ describe("Validation", () => {
                         "address.country": anyString,
                         "address.streetAddress": anyString,
                         "pets[0].name": anyString,
+                        _submittedData: obj,
                     },
                 });
             });
+            it("should unflatten data when validating", () => {
+                const data = {
+                    firstName: "John",
+                    lastName: "Doe",
+                    age: 30,
+                    "address.streetAddress": "123 Main St",
+                    "address.city": "Anytown",
+                    "address.country": "USA",
+                    "pets[0].animal": "dog",
+                    "pets[0].name": "Fido",
+                };
+                expect(validator.validate(data)).toEqual({
+                    data: {
+                        firstName: "John",
+                        lastName: "Doe",
+                        age: 30,
+                        address: {
+                            streetAddress: "123 Main St",
+                            city: "Anytown",
+                            country: "USA",
+                        },
+                        pets: [{ animal: "dog", name: "Fido" }],
+                    },
+                    error: undefined,
+                });
+            });
+            it("should accept FormData directly and return errors", () => {
+                const formData = new testFormData_1.TestFormData();
+                formData.set("firstName", "John");
+                formData.set("lastName", "Doe");
+                formData.set("address.streetAddress", "123 Main St");
+                formData.set("address.country", "USA");
+                formData.set("pets[0].animal", "dog");
+                expect(validator.validate(formData)).toEqual({
+                    data: undefined,
+                    error: {
+                        "address.city": anyString,
+                        "pets[0].name": anyString,
+                        _submittedData: (0, flatten_1.objectFromPathEntries)([...formData.entries()]),
+                    },
+                });
+            });
+            it("should accept FormData directly and return valid data", () => {
+                const formData = new testFormData_1.TestFormData();
+                formData.set("firstName", "John");
+                formData.set("lastName", "Doe");
+                formData.set("address.streetAddress", "123 Main St");
+                formData.set("address.country", "USA");
+                formData.set("address.city", "Anytown");
+                formData.set("pets[0].animal", "dog");
+                formData.set("pets[0].name", "Fido");
+                expect(validator.validate(formData)).toEqual({
+                    data: {
+                        firstName: "John",
+                        lastName: "Doe",
+                        address: {
+                            streetAddress: "123 Main St",
+                            country: "USA",
+                            city: "Anytown",
+                        },
+                        pets: [{ animal: "dog", name: "Fido" }],
+                    },
+                    error: undefined,
+                });
+            });
         });
         describe("validateField", () => {
             it("should not return an error if field is valid", () => {
@@ -195,6 +263,7 @@ describe("withZod", () => {
                 type: anyString,
                 bar: anyString,
                 foo: anyString,
+                _submittedData: obj,
             },
         });
     });
@@ -213,6 +282,7 @@ describe("withZod", () => {
             error: {
                 field1: anyString,
                 field2: anyString,
+                _submittedData: obj,
             },
         });
         expect(validator.validateField(obj, "field1")).toEqual({

package/build/validation/withYup.d.ts

@@ -1,3 +1,6 @@
 import type { AnyObjectSchema, InferType } from "yup";
 import { Validator } from "./types";
+/**
+ * Create a `Validator` using a `yup` schema.
+ */
 export declare const withYup: <Schema extends AnyObjectSchema>(validationSchema: Schema) => Validator<InferType<Schema>>;

package/build/validation/withYup.js

@@ -11,6 +11,9 @@ const validationErrorToFieldErrors = (error) => {
     });
     return fieldErrors;
 };
+/**
+ * Create a `Validator` using a `yup` schema.
+ */
 const withYup = (validationSchema) => {
     return (0, createValidator_1.createValidator)({
         validate: (data) => {

package/build/validation/withZod.d.ts

@@ -1,3 +1,6 @@
 import type { z } from "zod";
 import { Validator } from "..";
+/**
+ * Create a validator using a `zod` schema.
+ */
 export declare function withZod<T>(zodSchema: z.Schema<T>): Validator<T>;

package/build/validation/withZod.js

@@ -23,6 +23,9 @@ function pathToString(array) {
         return string + (isNaN(Number(item)) ? prefix + item : "[" + item + "]");
     }, "");
 }
+/**
+ * Create a validator using a `zod` schema.
+ */
 function withZod(zodSchema) {
     return (0, createValidator_1.createValidator)({
         validate: (value) => {

package/jest.config.js

@@ -1,5 +1,10 @@
 /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
 module.exports = {
+  globals: {
+    "ts-jest": {
+      tsconfig: "tsconfig.json",
+    },
+  },
   preset: "ts-jest",
   testEnvironment: "node",
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remix-validated-form",
-  "version": "1.1.1-beta.0",
+  "version": "2.0.0-beta.3",
   "description": "Form component and utils for easy form validation in remix",
   "browser": "./browser/index.js",
   "main": "./build/index.js",
@@ -10,18 +10,14 @@
   },
   "sideEffects": false,
   "scripts": {
-    "build": "npm run build:browser && npm run build:main && npm run build:tests",
-    "build:browser": "tsc --project tsconfig.json --module ESNext --outDir ./browser",
-    "build:main": "tsc --project tsconfig.json --module CommonJS --outDir ./build",
-    "build:tests": "tsc --project tsconfig.json --module CommonJS --outDir ./test-app/remix-validated-form",
-    "build:sample": "tsc --project tsconfig.json --module CommonJS --outDir ./sample-app/remix-validated-form",
-    "sample-app": "npm run build:sample && cd sample-app && npm run dev",
+    "dev": "tsc --module ESNext --outDir ./browser --watch",
+    "build": "npm run build:browser && npm run build:main",
+    "build:browser": "tsc --module ESNext --outDir ./browser",
+    "build:main": "tsc --module CommonJS --outDir ./build",
     "test": "jest src",
     "test:watch": "jest src --watch",
-    "lint": "eslint .",
-    "prettier": "prettier . --write",
-    "prepare": "husky install",
-    "prepublishOnly": "npm run build:browser && npm run build:main"
+    "prepublishOnly": "cp ../../README.md ./README.md && npm run build",
+    "postpublish": "rm ./README.md"
   },
   "author": {
     "name": "Aaron Pettengill",
@@ -48,25 +44,10 @@
     "@types/jest": "^27.0.3",
     "@types/lodash": "^4.14.178",
     "@types/react": "^17.0.37",
-    "@typescript-eslint/eslint-plugin": "^5.6.0",
-    "@typescript-eslint/parser": "^5.6.0",
-    "babel-eslint": "^10.1.0",
-    "eslint": "^7.32.0",
-    "eslint-config-react-app": "^6.0.0",
-    "eslint-plugin-cypress": "^2.12.1",
-    "eslint-plugin-flowtype": "^8.0.3",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-jsx-a11y": "^6.5.1",
-    "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-react": "^7.27.1",
-    "eslint-plugin-react-hooks": "^4.3.0",
     "fetch-blob": "^3.1.3",
-    "husky": "^7.0.4",
-    "jest": "^27.4.4",
-    "lint-staged": "^12.1.2",
-    "prettier": "^2.5.1",
     "react": "^17.0.2",
     "ts-jest": "^27.1.1",
+    "tsconfig": "*",
     "typescript": "^4.5.3",
     "yup": "^0.32.11",
     "zod": "^3.11.6"
@@ -74,11 +55,5 @@
   "dependencies": {
     "lodash": "^4.17.21",
     "tiny-invariant": "^1.2.0"
-  },
-  "lint-staged": {
-    "**/*.{ts,tsx,js,jsx}": [
-      "prettier --write",
-      "eslint --cache --fix"
-    ]
   }
 }

package/src/ValidatedForm.tsx

@@ -0,0 +1,227 @@
+import {
+  Form as RemixForm,
+  useActionData,
+  useFetcher,
+  useFormAction,
+  useTransition,
+} from "@remix-run/react";
+import React, {
+  ComponentProps,
+  useEffect,
+  useMemo,
+  useRef,
+  useState,
+} from "react";
+import invariant from "tiny-invariant";
+import { FormContext, FormContextValue } from "./internal/formContext";
+import { useSubmitComplete } from "./internal/submissionCallbacks";
+import { omit, mergeRefs } from "./internal/util";
+import {
+  FieldErrors,
+  Validator,
+  FieldErrorsWithData,
+} from "./validation/types";
+
+export type FormProps<DataType> = {
+  /**
+   * A `Validator` object that describes how to validate the form.
+   */
+  validator: Validator<DataType>;
+  /**
+   * A submit callback that gets called when the form is submitted
+   * after all validations have been run.
+   */
+  onSubmit?: (data: DataType, event: React.FormEvent<HTMLFormElement>) => void;
+  /**
+   * Allows you to provide a `fetcher` from remix's `useFetcher` hook.
+   * The form will use the fetcher for loading states, action data, etc
+   * instead of the default form action.
+   */
+  fetcher?: ReturnType<typeof useFetcher>;
+  /**
+   * Accepts an object of default values for the form
+   * that will automatically be propagated to the form fields via `useField`.
+   */
+  defaultValues?: Partial<DataType>;
+  /**
+   * A ref to the form element.
+   */
+  formRef?: React.RefObject<HTMLFormElement>;
+  /**
+   * An optional sub-action to use for the form.
+   * 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;
+  /**
+   * 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,
+   * and don't redirect in-between submissions.
+   */
+  resetAfterSubmit?: boolean;
+} & Omit<ComponentProps<typeof RemixForm>, "onSubmit">;
+
+function useFieldErrorsFromBackend(
+  fetcher?: ReturnType<typeof useFetcher>,
+  subaction?: string
+): FieldErrorsWithData | null {
+  const actionData = useActionData<any>();
+  if (fetcher) return (fetcher.data as any)?.fieldErrors;
+  if (!actionData) return null;
+  if (actionData.fieldErrors) {
+    const submittedData = actionData.fieldErrors?._submittedData;
+    const subactionsMatch = subaction
+      ? subaction === submittedData?.subaction
+      : !submittedData?.subaction;
+    return subactionsMatch ? actionData.fieldErrors : null;
+  }
+  return null;
+}
+
+function useFieldErrors(
+  fieldErrorsFromBackend?: any
+): [FieldErrors, React.Dispatch<React.SetStateAction<FieldErrors>>] {
+  const [fieldErrors, setFieldErrors] = useState<FieldErrors>(
+    fieldErrorsFromBackend ?? {}
+  );
+  useEffect(() => {
+    if (fieldErrorsFromBackend) setFieldErrors(fieldErrorsFromBackend);
+  }, [fieldErrorsFromBackend]);
+
+  return [fieldErrors, setFieldErrors];
+}
+
+const useIsSubmitting = (
+  action?: string,
+  subaction?: string,
+  fetcher?: ReturnType<typeof useFetcher>
+) => {
+  const actionForCurrentPage = useFormAction();
+  const pendingFormSubmit = useTransition().submission;
+
+  if (fetcher) return fetcher.state === "submitting";
+  if (!pendingFormSubmit) return false;
+
+  const { formData, action: pendingAction } = pendingFormSubmit;
+  const pendingSubAction = formData.get("subaction");
+  const expectedAction = action ?? actionForCurrentPage;
+  if (subaction)
+    return expectedAction === pendingAction && subaction === pendingSubAction;
+  return expectedAction === pendingAction && !pendingSubAction;
+};
+
+const getDataFromForm = (el: HTMLFormElement) => new FormData(el);
+
+/**
+ * The purpose for this logic is to handle validation errors when javascript is disabled.
+ * Normally (without js), when a form is submitted and the action returns the validation errors,
+ * the form will be reset. The errors will be displayed on the correct fields,
+ * but all the values in the form will be gone. This is not good UX.
+ *
+ * To get around this, we return the submitted form data from the server,
+ * and use those to populate the form via `defaultValues`.
+ * This results in a more seamless UX akin to what you would see when js is enabled.
+ *
+ * One potential downside is that resetting the form will reset the form
+ * to the _new_ default values that were returned from the server with the validation errors.
+ * However, this case is less of a problem than the janky UX caused by losing the form values.
+ * It will only ever be a problem if the form includes a `<button type="reset" />`
+ * and only if JS is disabled.
+ */
+function useDefaultValues<DataType>(
+  fieldErrors?: FieldErrorsWithData | null,
+  defaultValues?: Partial<DataType>
+) {
+  const defaultsFromValidationError = fieldErrors?._submittedData;
+  return defaultsFromValidationError ?? defaultValues;
+}
+
+/**
+ * The primary form component of `remix-validated-form`.
+ */
+export function ValidatedForm<DataType>({
+  validator,
+  onSubmit,
+  children,
+  fetcher,
+  action,
+  defaultValues,
+  formRef: formRefProp,
+  onReset,
+  subaction,
+  resetAfterSubmit,
+  ...rest
+}: FormProps<DataType>) {
+  const fieldErrorsFromBackend = useFieldErrorsFromBackend(fetcher, subaction);
+  const [fieldErrors, setFieldErrors] = useFieldErrors(fieldErrorsFromBackend);
+  const isSubmitting = useIsSubmitting(action, subaction, fetcher);
+  const defaultsToUse = useDefaultValues(fieldErrorsFromBackend, defaultValues);
+  const formRef = useRef<HTMLFormElement>(null);
+  useSubmitComplete(isSubmitting, () => {
+    if (!fieldErrorsFromBackend && resetAfterSubmit) {
+      formRef.current?.reset();
+    }
+  });
+
+  const contextValue = useMemo<FormContextValue>(
+    () => ({
+      fieldErrors,
+      action,
+      defaultValues: defaultsToUse,
+      isSubmitting: isSubmitting ?? false,
+      clearError: (fieldName) => {
+        setFieldErrors((prev) => omit(prev, fieldName));
+      },
+      validateField: (fieldName) => {
+        invariant(formRef.current, "Cannot find reference to form");
+        const { error } = validator.validateField(
+          getDataFromForm(formRef.current),
+          fieldName as any
+        );
+        if (error) {
+          setFieldErrors((prev) => ({
+            ...prev,
+            [fieldName]: error,
+          }));
+        }
+      },
+    }),
+    [
+      fieldErrors,
+      action,
+      defaultsToUse,
+      isSubmitting,
+      setFieldErrors,
+      validator,
+    ]
+  );
+
+  const Form = fetcher?.Form ?? RemixForm;
+
+  return (
+    <Form
+      ref={mergeRefs([formRef, formRefProp])}
+      {...rest}
+      action={action}
+      onSubmit={(event) => {
+        const result = validator.validate(getDataFromForm(event.currentTarget));
+        if (result.error) {
+          event.preventDefault();
+          setFieldErrors(result.error);
+        } else {
+          onSubmit?.(result.data, event);
+        }
+      }}
+      onReset={(event) => {
+        onReset?.(event);
+        if (event.defaultPrevented) return;
+        setFieldErrors({});
+      }}
+    >
+      <FormContext.Provider value={contextValue}>
+        <input type="hidden" value={subaction} name="subaction" />
+        {children}
+      </FormContext.Provider>
+    </Form>
+  );
+}

package/src/hooks.ts

@@ -0,0 +1,60 @@
+import get from "lodash/get";
+import toPath from "lodash/toPath";
+import { useContext, useMemo } from "react";
+import { FormContext } from "./internal/formContext";
+
+export type FieldProps = {
+  /**
+   * The validation error message if there is one.
+   */
+  error?: string;
+  /**
+   * Clears the error message.
+   */
+  clearError: () => void;
+  /**
+   * Validates the field.
+   */
+  validate: () => void;
+  /**
+   * The default value of the field, if there is one.
+   */
+  defaultValue?: any;
+};
+
+/**
+ * Provides the data and helpers necessary to set up a field.
+ */
+export const useField = (name: string): FieldProps => {
+  const { fieldErrors, clearError, validateField, defaultValues } =
+    useContext(FormContext);
+
+  const field = useMemo<FieldProps>(
+    () => ({
+      error: fieldErrors[name],
+      clearError: () => {
+        clearError(name);
+      },
+      validate: () => validateField(name),
+      defaultValue: defaultValues
+        ? get(defaultValues, toPath(name), undefined)
+        : undefined,
+    }),
+    [clearError, defaultValues, fieldErrors, name, validateField]
+  );
+
+  return field;
+};
+
+/**
+ * Provides access to the entire form context.
+ * This is not usually necessary, but can be useful for advanced use cases.
+ */
+export const useFormContext = () => useContext(FormContext);
+
+/**
+ * Returns whether or not the parent form is currently being submitted.
+ * This is different from remix's `useTransition().submission` in that it
+ * is aware of what form it's in and when _that_ form is being submitted.
+ */
+export const useIsSubmitting = () => useFormContext().isSubmitting;

package/src/index.ts

@@ -0,0 +1,8 @@
+export * from "./hooks";
+export * from "./server";
+export * from "./ValidatedForm";
+export * from "./validation/types";
+export * from "./validation/withYup";
+export * from "./validation/withZod";
+export * from "./validation/createValidator";
+export type { FormContextValue } from "./internal/formContext";

package/src/internal/flatten.ts

@@ -0,0 +1,48 @@
+// `flatten` is taken from https://github.com/richie5um/FlattenJS. Decided to implement them here instead of using that package because this is a core functionality of the library and this will add more flexibility in case we need to change the implementation.
+import assign from "lodash/assign";
+import isArray from "lodash/isArray";
+import isObject from "lodash/isObject";
+import keys from "lodash/keys";
+import mapKeys from "lodash/mapKeys";
+import set from "lodash/set";
+import transform from "lodash/transform";
+import { GenericObject } from "..";
+
+export const objectFromPathEntries = (entries: [string, any][]) =>
+  entries.reduce((acc, [key, value]) => set(acc, key, value), {});
+
+/** Flatten an object so there are no nested objects or arrays */
+export function flatten(obj: GenericObject, preserveEmpty = false) {
+  return transform(
+    obj,
+    function (result: GenericObject, value, key) {
+      if (isObject(value)) {
+        let flatMap = mapKeys(
+          flatten(value, preserveEmpty),
+          function (_mvalue, mkey) {
+            if (isArray(value)) {
+              let index = mkey.indexOf(".");
+              if (-1 !== index) {
+                return `${key}[${mkey.slice(0, index)}]${mkey.slice(index)}`;
+              }
+              return `${key}[${mkey}]`;
+            }
+            return `${key}.${mkey}`;
+          }
+        );
+
+        assign(result, flatMap);
+
+        // Preverve Empty arrays and objects
+        if (preserveEmpty && keys(flatMap).length === 0) {
+          result[key] = value;
+        }
+      } else {
+        result[key] = value;
+      }
+
+      return result;
+    },
+    {}
+  );
+}

package/src/internal/formContext.ts

@@ -0,0 +1,36 @@
+import { createContext } from "react";
+import { FieldErrors } from "../validation/types";
+
+export type FormContextValue = {
+  /**
+   * All the errors in all the fields in the form.
+   */
+  fieldErrors: FieldErrors;
+  /**
+   * Clear the errors of the specified fields.
+   */
+  clearError: (...names: string[]) => void;
+  /**
+   * Validate the specified field.
+   */
+  validateField: (fieldName: string) => void;
+  /**
+   * The `action` prop of the form.
+   */
+  action?: string;
+  /**
+   * Whether or not the form is submitting.
+   */
+  isSubmitting: boolean;
+  /**
+   * The default values of the form.
+   */
+  defaultValues?: { [fieldName: string]: any };
+};
+
+export const FormContext = createContext<FormContextValue>({
+  fieldErrors: {},
+  clearError: () => {},
+  validateField: () => {},
+  isSubmitting: false,
+});

package/src/internal/submissionCallbacks.ts

@@ -0,0 +1,15 @@
+import { useEffect, useRef } from "react";
+
+export function useSubmitComplete(isSubmitting: boolean, callback: () => void) {
+  const isPending = useRef(false);
+  useEffect(() => {
+    if (isSubmitting) {
+      isPending.current = true;
+    }
+
+    if (!isSubmitting && isPending.current) {
+      isPending.current = false;
+      callback();
+    }
+  });
+}

package/src/internal/util.ts

@@ -0,0 +1,23 @@
+import type React from "react";
+
+export const omit = (obj: any, ...keys: string[]) => {
+  const result = { ...obj };
+  for (const key of keys) {
+    delete result[key];
+  }
+  return result;
+};
+
+export const mergeRefs = <T = any>(
+  refs: Array<React.MutableRefObject<T> | React.LegacyRef<T> | undefined>
+): React.RefCallback<T> => {
+  return (value: T) => {
+    refs.filter(Boolean).forEach((ref) => {
+      if (typeof ref === "function") {
+        ref(value);
+      } else if (ref != null) {
+        (ref as React.MutableRefObject<T | null>).current = value;
+      }
+    });
+  };
+};

package/src/server.ts

@@ -0,0 +1,10 @@
+import { json } from "@remix-run/server-runtime";
+import { FieldErrors } from "./validation/types";
+
+/**
+ * Takes the errors from a `Validator` and returns a `Response`.
+ * The `ValidatedForm` on the frontend will automatically display the errors
+ * if this is returned from the action.
+ */
+export const validationError = (errors: FieldErrors) =>
+  json({ fieldErrors: errors }, { status: 422 });