remix-validated-form 2.0.1-beta.1 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,9 @@
1
+ $ npm run build:browser && npm run build:main
2
+
3
+ > remix-validated-form@2.0.0-beta.2 build:browser
4
+ > tsc --module ESNext --outDir ./browser
5
+
6
+
7
+ > remix-validated-form@2.0.0-beta.2 build:main
8
+ > tsc --module CommonJS --outDir ./build
9
+
File without changes
@@ -4,25 +4,25 @@
4
4
  Adapter for yup
5
5
  validate
6
6
  ✓ should return the data when valid (2 ms)
7
- ✓ should return field errors when invalid (2 ms)
7
+ ✓ should return field errors when invalid (1 ms)
8
8
  ✓ should unflatten data when validating
9
- ✓ should accept FormData directly and return errors
9
+ ✓ should accept FormData directly and return errors (1 ms)
10
10
  ✓ should accept FormData directly and return valid data (1 ms)
11
11
  validateField
12
12
  ✓ should not return an error if field is valid
13
13
  ✓ should not return an error if a nested field is valid (1 ms)
14
- ✓ should return an error if field is invalid
14
+ ✓ should return an error if field is invalid (2 ms)
15
15
  ✓ should return an error if a nested field is invalid
16
16
  Adapter for zod
17
17
  validate
18
- ✓ should return the data when valid (2 ms)
18
+ ✓ should return the data when valid (1 ms)
19
19
  ✓ should return field errors when invalid
20
20
  ✓ should unflatten data when validating (1 ms)
21
21
  ✓ should accept FormData directly and return errors
22
22
  ✓ should accept FormData directly and return valid data
23
23
  validateField
24
- ✓ should not return an error if field is valid
25
- ✓ should not return an error if a nested field is valid (1 ms)
24
+ ✓ should not return an error if field is valid (1 ms)
25
+ ✓ should not return an error if a nested field is valid
26
26
  ✓ should return an error if field is invalid
27
27
  ✓ should return an error if a nested field is invalid
28
28
  withZod
@@ -32,5 +32,5 @@
32
32
  Test Suites: 1 passed, 1 total
33
33
  Tests: 20 passed, 20 total
34
34
  Snapshots: 0 total
35
- Time: 1.526 s, estimated 2 s
35
+ Time: 1.1 s, estimated 2 s
36
36
  Ran all test suites matching /src/i.
@@ -26,8 +26,20 @@ export declare type FormProps<DataType> = {
26
26
  * A ref to the form element.
27
27
  */
28
28
  formRef?: React.RefObject<HTMLFormElement>;
29
+ /**
30
+ * An optional sub-action to use for the form.
31
+ * Setting a value here will cause the form to be submitted with an extra `subaction` value.
32
+ * This can be useful when there are multiple forms on the screen handled by the same action.
33
+ */
34
+ subaction?: string;
35
+ /**
36
+ * Reset the form to the default values after the form has been successfully submitted.
37
+ * This is useful if you want to submit the same form multiple times,
38
+ * and don't redirect in-between submissions.
39
+ */
40
+ resetAfterSubmit?: boolean;
29
41
  } & Omit<ComponentProps<typeof RemixForm>, "onSubmit">;
30
42
  /**
31
43
  * The primary form component of `remix-validated-form`.
32
44
  */
33
- export declare function ValidatedForm<DataType>({ validator, onSubmit, children, fetcher, action, defaultValues, formRef: formRefProp, ...rest }: FormProps<DataType>): JSX.Element;
45
+ export declare function ValidatedForm<DataType>({ validator, onSubmit, children, fetcher, action, defaultValues, formRef: formRefProp, onReset, subaction, resetAfterSubmit, ...rest }: FormProps<DataType>): JSX.Element;
@@ -1,41 +1,89 @@
1
- import { jsx as _jsx } from "react/jsx-runtime";
1
+ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
2
2
  import { Form as RemixForm, useActionData, useFormAction, useTransition, } from "@remix-run/react";
3
3
  import { useEffect, useMemo, useRef, useState, } from "react";
4
4
  import invariant from "tiny-invariant";
5
5
  import { FormContext } from "./internal/formContext";
6
+ import { useSubmitComplete } from "./internal/submissionCallbacks";
6
7
  import { omit, mergeRefs } from "./internal/util";
7
- function useFieldErrors(fetcher) {
8
+ function useFieldErrorsFromBackend(fetcher, subaction) {
9
+ var _a, _b;
8
10
  const actionData = useActionData();
9
- const dataToUse = fetcher ? fetcher.data : actionData;
10
- const fieldErrorsFromAction = dataToUse === null || dataToUse === void 0 ? void 0 : dataToUse.fieldErrors;
11
- const [fieldErrors, setFieldErrors] = useState(fieldErrorsFromAction !== null && fieldErrorsFromAction !== void 0 ? fieldErrorsFromAction : {});
11
+ if (fetcher)
12
+ return (_a = fetcher.data) === null || _a === void 0 ? void 0 : _a.fieldErrors;
13
+ if (!actionData)
14
+ return null;
15
+ if (actionData.fieldErrors) {
16
+ const submittedData = (_b = actionData.fieldErrors) === null || _b === void 0 ? void 0 : _b._submittedData;
17
+ const subactionsMatch = subaction
18
+ ? subaction === (submittedData === null || submittedData === void 0 ? void 0 : submittedData.subaction)
19
+ : !(submittedData === null || submittedData === void 0 ? void 0 : submittedData.subaction);
20
+ return subactionsMatch ? actionData.fieldErrors : null;
21
+ }
22
+ return null;
23
+ }
24
+ function useFieldErrors(fieldErrorsFromBackend) {
25
+ const [fieldErrors, setFieldErrors] = useState(fieldErrorsFromBackend !== null && fieldErrorsFromBackend !== void 0 ? fieldErrorsFromBackend : {});
12
26
  useEffect(() => {
13
- if (fieldErrorsFromAction)
14
- setFieldErrors(fieldErrorsFromAction);
15
- }, [fieldErrorsFromAction]);
27
+ if (fieldErrorsFromBackend)
28
+ setFieldErrors(fieldErrorsFromBackend);
29
+ }, [fieldErrorsFromBackend]);
16
30
  return [fieldErrors, setFieldErrors];
17
31
  }
18
- const useIsSubmitting = (action, fetcher) => {
32
+ const useIsSubmitting = (action, subaction, fetcher) => {
19
33
  const actionForCurrentPage = useFormAction();
20
34
  const pendingFormSubmit = useTransition().submission;
21
- return fetcher
22
- ? fetcher.state === "submitting"
23
- : pendingFormSubmit &&
24
- pendingFormSubmit.action === (action !== null && action !== void 0 ? action : actionForCurrentPage);
35
+ if (fetcher)
36
+ return fetcher.state === "submitting";
37
+ if (!pendingFormSubmit)
38
+ return false;
39
+ const { formData, action: pendingAction } = pendingFormSubmit;
40
+ const pendingSubAction = formData.get("subaction");
41
+ const expectedAction = action !== null && action !== void 0 ? action : actionForCurrentPage;
42
+ if (subaction)
43
+ return expectedAction === pendingAction && subaction === pendingSubAction;
44
+ return expectedAction === pendingAction && !pendingSubAction;
25
45
  };
26
46
  const getDataFromForm = (el) => new FormData(el);
47
+ /**
48
+ * The purpose for this logic is to handle validation errors when javascript is disabled.
49
+ * Normally (without js), when a form is submitted and the action returns the validation errors,
50
+ * the form will be reset. The errors will be displayed on the correct fields,
51
+ * but all the values in the form will be gone. This is not good UX.
52
+ *
53
+ * To get around this, we return the submitted form data from the server,
54
+ * and use those to populate the form via `defaultValues`.
55
+ * This results in a more seamless UX akin to what you would see when js is enabled.
56
+ *
57
+ * One potential downside is that resetting the form will reset the form
58
+ * to the _new_ default values that were returned from the server with the validation errors.
59
+ * However, this case is less of a problem than the janky UX caused by losing the form values.
60
+ * It will only ever be a problem if the form includes a `<button type="reset" />`
61
+ * and only if JS is disabled.
62
+ */
63
+ function useDefaultValues(fieldErrors, defaultValues) {
64
+ const defaultsFromValidationError = fieldErrors === null || fieldErrors === void 0 ? void 0 : fieldErrors._submittedData;
65
+ return defaultsFromValidationError !== null && defaultsFromValidationError !== void 0 ? defaultsFromValidationError : defaultValues;
66
+ }
27
67
  /**
28
68
  * The primary form component of `remix-validated-form`.
29
69
  */
30
- export function ValidatedForm({ validator, onSubmit, children, fetcher, action, defaultValues, formRef: formRefProp, ...rest }) {
70
+ export function ValidatedForm({ validator, onSubmit, children, fetcher, action, defaultValues, formRef: formRefProp, onReset, subaction, resetAfterSubmit, ...rest }) {
31
71
  var _a;
32
- const [fieldErrors, setFieldErrors] = useFieldErrors(fetcher);
33
- const isSubmitting = useIsSubmitting(action, fetcher);
72
+ const fieldErrorsFromBackend = useFieldErrorsFromBackend(fetcher, subaction);
73
+ const [fieldErrors, setFieldErrors] = useFieldErrors(fieldErrorsFromBackend);
74
+ const isSubmitting = useIsSubmitting(action, subaction, fetcher);
75
+ const defaultsToUse = useDefaultValues(fieldErrorsFromBackend, defaultValues);
34
76
  const formRef = useRef(null);
77
+ useSubmitComplete(isSubmitting, () => {
78
+ var _a;
79
+ if (!fieldErrorsFromBackend && resetAfterSubmit) {
80
+ (_a = formRef.current) === null || _a === void 0 ? void 0 : _a.reset();
81
+ }
82
+ });
35
83
  const contextValue = useMemo(() => ({
36
84
  fieldErrors,
37
85
  action,
38
- defaultValues,
86
+ defaultValues: defaultsToUse,
39
87
  isSubmitting: isSubmitting !== null && isSubmitting !== void 0 ? isSubmitting : false,
40
88
  clearError: (fieldName) => {
41
89
  setFieldErrors((prev) => omit(prev, fieldName));
@@ -53,7 +101,7 @@ export function ValidatedForm({ validator, onSubmit, children, fetcher, action,
53
101
  }), [
54
102
  fieldErrors,
55
103
  action,
56
- defaultValues,
104
+ defaultsToUse,
57
105
  isSubmitting,
58
106
  setFieldErrors,
59
107
  validator,
@@ -68,5 +116,10 @@ export function ValidatedForm({ validator, onSubmit, children, fetcher, action,
68
116
  else {
69
117
  onSubmit === null || onSubmit === void 0 ? void 0 : onSubmit(result.data, event);
70
118
  }
71
- }, children: _jsx(FormContext.Provider, { value: contextValue, children: children }, void 0) }, void 0));
119
+ }, onReset: (event) => {
120
+ onReset === null || onReset === void 0 ? void 0 : onReset(event);
121
+ if (event.defaultPrevented)
122
+ return;
123
+ setFieldErrors({});
124
+ }, children: _jsxs(FormContext.Provider, { value: contextValue, children: [_jsx("input", { type: "hidden", value: subaction, name: "subaction" }, void 0), children] }, void 0) }, void 0));
72
125
  }
@@ -0,0 +1 @@
1
+ export declare function useSubmitComplete(isSubmitting: boolean, callback: () => void): void;
@@ -0,0 +1,13 @@
1
+ import { useEffect, useRef } from "react";
2
+ export function useSubmitComplete(isSubmitting, callback) {
3
+ const isPending = useRef(false);
4
+ useEffect(() => {
5
+ if (isSubmitting) {
6
+ isPending.current = true;
7
+ }
8
+ if (!isSubmitting && isPending.current) {
9
+ isPending.current = false;
10
+ callback();
11
+ }
12
+ });
13
+ }
@@ -13,7 +13,18 @@ const preprocessFormData = (data) => {
13
13
  */
14
14
  export function createValidator(validator) {
15
15
  return {
16
- validate: (value) => validator.validate(preprocessFormData(value)),
16
+ validate: (value) => {
17
+ const data = preprocessFormData(value);
18
+ const result = validator.validate(data);
19
+ if (result.error) {
20
+ // Ideally, we should probably be returning a nested object like
21
+ // { fieldErrors: {}, submittedData: {} }
22
+ // We should do this in the next major version of the library
23
+ // but for now, we can sneak it in with the fieldErrors.
24
+ result.error._submittedData = data;
25
+ }
26
+ return result;
27
+ },
17
28
  validateField: (data, field) => validator.validateField(preprocessFormData(data), field),
18
29
  };
19
30
  }
@@ -1,4 +1,7 @@
1
1
  export declare type FieldErrors = Record<string, string>;
2
+ export declare type FieldErrorsWithData = FieldErrors & {
3
+ _submittedData: any;
4
+ };
2
5
  export declare type GenericObject = {
3
6
  [key: string]: any;
4
7
  };
@@ -1,6 +1,7 @@
1
1
  import * as yup from "yup";
2
2
  import { z } from "zod";
3
3
  import { withYup } from "..";
4
+ import { objectFromPathEntries } from "../internal/flatten";
4
5
  import { TestFormData } from "../test-data/testFormData";
5
6
  import { withZod } from "./withZod";
6
7
  const validationTestCases = [
@@ -78,6 +79,7 @@ describe("Validation", () => {
78
79
  "address.country": anyString,
79
80
  "address.streetAddress": anyString,
80
81
  "pets[0].name": anyString,
82
+ _submittedData: obj,
81
83
  },
82
84
  });
83
85
  });
@@ -119,6 +121,7 @@ describe("Validation", () => {
119
121
  error: {
120
122
  "address.city": anyString,
121
123
  "pets[0].name": anyString,
124
+ _submittedData: objectFromPathEntries([...formData.entries()]),
122
125
  },
123
126
  });
124
127
  });
@@ -239,6 +242,7 @@ describe("withZod", () => {
239
242
  type: anyString,
240
243
  bar: anyString,
241
244
  foo: anyString,
245
+ _submittedData: obj,
242
246
  },
243
247
  });
244
248
  });
@@ -257,6 +261,7 @@ describe("withZod", () => {
257
261
  error: {
258
262
  field1: anyString,
259
263
  field2: anyString,
264
+ _submittedData: obj,
260
265
  },
261
266
  });
262
267
  expect(validator.validateField(obj, "field1")).toEqual({
@@ -26,8 +26,20 @@ export declare type FormProps<DataType> = {
26
26
  * A ref to the form element.
27
27
  */
28
28
  formRef?: React.RefObject<HTMLFormElement>;
29
+ /**
30
+ * An optional sub-action to use for the form.
31
+ * Setting a value here will cause the form to be submitted with an extra `subaction` value.
32
+ * This can be useful when there are multiple forms on the screen handled by the same action.
33
+ */
34
+ subaction?: string;
35
+ /**
36
+ * Reset the form to the default values after the form has been successfully submitted.
37
+ * This is useful if you want to submit the same form multiple times,
38
+ * and don't redirect in-between submissions.
39
+ */
40
+ resetAfterSubmit?: boolean;
29
41
  } & Omit<ComponentProps<typeof RemixForm>, "onSubmit">;
30
42
  /**
31
43
  * The primary form component of `remix-validated-form`.
32
44
  */
33
- export declare function ValidatedForm<DataType>({ validator, onSubmit, children, fetcher, action, defaultValues, formRef: formRefProp, ...rest }: FormProps<DataType>): JSX.Element;
45
+ export declare function ValidatedForm<DataType>({ validator, onSubmit, children, fetcher, action, defaultValues, formRef: formRefProp, onReset, subaction, resetAfterSubmit, ...rest }: FormProps<DataType>): JSX.Element;
@@ -9,39 +9,87 @@ const react_1 = require("@remix-run/react");
9
9
  const react_2 = require("react");
10
10
  const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
11
11
  const formContext_1 = require("./internal/formContext");
12
+ const submissionCallbacks_1 = require("./internal/submissionCallbacks");
12
13
  const util_1 = require("./internal/util");
13
- function useFieldErrors(fetcher) {
14
+ function useFieldErrorsFromBackend(fetcher, subaction) {
15
+ var _a, _b;
14
16
  const actionData = (0, react_1.useActionData)();
15
- const dataToUse = fetcher ? fetcher.data : actionData;
16
- const fieldErrorsFromAction = dataToUse === null || dataToUse === void 0 ? void 0 : dataToUse.fieldErrors;
17
- const [fieldErrors, setFieldErrors] = (0, react_2.useState)(fieldErrorsFromAction !== null && fieldErrorsFromAction !== void 0 ? fieldErrorsFromAction : {});
17
+ if (fetcher)
18
+ return (_a = fetcher.data) === null || _a === void 0 ? void 0 : _a.fieldErrors;
19
+ if (!actionData)
20
+ return null;
21
+ if (actionData.fieldErrors) {
22
+ const submittedData = (_b = actionData.fieldErrors) === null || _b === void 0 ? void 0 : _b._submittedData;
23
+ const subactionsMatch = subaction
24
+ ? subaction === (submittedData === null || submittedData === void 0 ? void 0 : submittedData.subaction)
25
+ : !(submittedData === null || submittedData === void 0 ? void 0 : submittedData.subaction);
26
+ return subactionsMatch ? actionData.fieldErrors : null;
27
+ }
28
+ return null;
29
+ }
30
+ function useFieldErrors(fieldErrorsFromBackend) {
31
+ const [fieldErrors, setFieldErrors] = (0, react_2.useState)(fieldErrorsFromBackend !== null && fieldErrorsFromBackend !== void 0 ? fieldErrorsFromBackend : {});
18
32
  (0, react_2.useEffect)(() => {
19
- if (fieldErrorsFromAction)
20
- setFieldErrors(fieldErrorsFromAction);
21
- }, [fieldErrorsFromAction]);
33
+ if (fieldErrorsFromBackend)
34
+ setFieldErrors(fieldErrorsFromBackend);
35
+ }, [fieldErrorsFromBackend]);
22
36
  return [fieldErrors, setFieldErrors];
23
37
  }
24
- const useIsSubmitting = (action, fetcher) => {
38
+ const useIsSubmitting = (action, subaction, fetcher) => {
25
39
  const actionForCurrentPage = (0, react_1.useFormAction)();
26
40
  const pendingFormSubmit = (0, react_1.useTransition)().submission;
27
- return fetcher
28
- ? fetcher.state === "submitting"
29
- : pendingFormSubmit &&
30
- pendingFormSubmit.action === (action !== null && action !== void 0 ? action : actionForCurrentPage);
41
+ if (fetcher)
42
+ return fetcher.state === "submitting";
43
+ if (!pendingFormSubmit)
44
+ return false;
45
+ const { formData, action: pendingAction } = pendingFormSubmit;
46
+ const pendingSubAction = formData.get("subaction");
47
+ const expectedAction = action !== null && action !== void 0 ? action : actionForCurrentPage;
48
+ if (subaction)
49
+ return expectedAction === pendingAction && subaction === pendingSubAction;
50
+ return expectedAction === pendingAction && !pendingSubAction;
31
51
  };
32
52
  const getDataFromForm = (el) => new FormData(el);
53
+ /**
54
+ * The purpose for this logic is to handle validation errors when javascript is disabled.
55
+ * Normally (without js), when a form is submitted and the action returns the validation errors,
56
+ * the form will be reset. The errors will be displayed on the correct fields,
57
+ * but all the values in the form will be gone. This is not good UX.
58
+ *
59
+ * To get around this, we return the submitted form data from the server,
60
+ * and use those to populate the form via `defaultValues`.
61
+ * This results in a more seamless UX akin to what you would see when js is enabled.
62
+ *
63
+ * One potential downside is that resetting the form will reset the form
64
+ * to the _new_ default values that were returned from the server with the validation errors.
65
+ * However, this case is less of a problem than the janky UX caused by losing the form values.
66
+ * It will only ever be a problem if the form includes a `<button type="reset" />`
67
+ * and only if JS is disabled.
68
+ */
69
+ function useDefaultValues(fieldErrors, defaultValues) {
70
+ const defaultsFromValidationError = fieldErrors === null || fieldErrors === void 0 ? void 0 : fieldErrors._submittedData;
71
+ return defaultsFromValidationError !== null && defaultsFromValidationError !== void 0 ? defaultsFromValidationError : defaultValues;
72
+ }
33
73
  /**
34
74
  * The primary form component of `remix-validated-form`.
35
75
  */
36
- function ValidatedForm({ validator, onSubmit, children, fetcher, action, defaultValues, formRef: formRefProp, ...rest }) {
76
+ function ValidatedForm({ validator, onSubmit, children, fetcher, action, defaultValues, formRef: formRefProp, onReset, subaction, resetAfterSubmit, ...rest }) {
37
77
  var _a;
38
- const [fieldErrors, setFieldErrors] = useFieldErrors(fetcher);
39
- const isSubmitting = useIsSubmitting(action, fetcher);
78
+ const fieldErrorsFromBackend = useFieldErrorsFromBackend(fetcher, subaction);
79
+ const [fieldErrors, setFieldErrors] = useFieldErrors(fieldErrorsFromBackend);
80
+ const isSubmitting = useIsSubmitting(action, subaction, fetcher);
81
+ const defaultsToUse = useDefaultValues(fieldErrorsFromBackend, defaultValues);
40
82
  const formRef = (0, react_2.useRef)(null);
83
+ (0, submissionCallbacks_1.useSubmitComplete)(isSubmitting, () => {
84
+ var _a;
85
+ if (!fieldErrorsFromBackend && resetAfterSubmit) {
86
+ (_a = formRef.current) === null || _a === void 0 ? void 0 : _a.reset();
87
+ }
88
+ });
41
89
  const contextValue = (0, react_2.useMemo)(() => ({
42
90
  fieldErrors,
43
91
  action,
44
- defaultValues,
92
+ defaultValues: defaultsToUse,
45
93
  isSubmitting: isSubmitting !== null && isSubmitting !== void 0 ? isSubmitting : false,
46
94
  clearError: (fieldName) => {
47
95
  setFieldErrors((prev) => (0, util_1.omit)(prev, fieldName));
@@ -59,7 +107,7 @@ function ValidatedForm({ validator, onSubmit, children, fetcher, action, default
59
107
  }), [
60
108
  fieldErrors,
61
109
  action,
62
- defaultValues,
110
+ defaultsToUse,
63
111
  isSubmitting,
64
112
  setFieldErrors,
65
113
  validator,
@@ -74,6 +122,11 @@ function ValidatedForm({ validator, onSubmit, children, fetcher, action, default
74
122
  else {
75
123
  onSubmit === null || onSubmit === void 0 ? void 0 : onSubmit(result.data, event);
76
124
  }
77
- }, children: (0, jsx_runtime_1.jsx)(formContext_1.FormContext.Provider, { value: contextValue, children: children }, void 0) }, void 0));
125
+ }, onReset: (event) => {
126
+ onReset === null || onReset === void 0 ? void 0 : onReset(event);
127
+ if (event.defaultPrevented)
128
+ return;
129
+ setFieldErrors({});
130
+ }, children: (0, jsx_runtime_1.jsxs)(formContext_1.FormContext.Provider, { value: contextValue, children: [(0, jsx_runtime_1.jsx)("input", { type: "hidden", value: subaction, name: "subaction" }, void 0), children] }, void 0) }, void 0));
78
131
  }
79
132
  exports.ValidatedForm = ValidatedForm;
@@ -0,0 +1 @@
1
+ export declare function useSubmitComplete(isSubmitting: boolean, callback: () => void): void;
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.useSubmitComplete = void 0;
4
+ const react_1 = require("react");
5
+ function useSubmitComplete(isSubmitting, callback) {
6
+ const isPending = (0, react_1.useRef)(false);
7
+ (0, react_1.useEffect)(() => {
8
+ if (isSubmitting) {
9
+ isPending.current = true;
10
+ }
11
+ if (!isSubmitting && isPending.current) {
12
+ isPending.current = false;
13
+ callback();
14
+ }
15
+ });
16
+ }
17
+ exports.useSubmitComplete = useSubmitComplete;
@@ -16,7 +16,18 @@ const preprocessFormData = (data) => {
16
16
  */
17
17
  function createValidator(validator) {
18
18
  return {
19
- validate: (value) => validator.validate(preprocessFormData(value)),
19
+ validate: (value) => {
20
+ const data = preprocessFormData(value);
21
+ const result = validator.validate(data);
22
+ if (result.error) {
23
+ // Ideally, we should probably be returning a nested object like
24
+ // { fieldErrors: {}, submittedData: {} }
25
+ // We should do this in the next major version of the library
26
+ // but for now, we can sneak it in with the fieldErrors.
27
+ result.error._submittedData = data;
28
+ }
29
+ return result;
30
+ },
20
31
  validateField: (data, field) => validator.validateField(preprocessFormData(data), field),
21
32
  };
22
33
  }
@@ -1,4 +1,7 @@
1
1
  export declare type FieldErrors = Record<string, string>;
2
+ export declare type FieldErrorsWithData = FieldErrors & {
3
+ _submittedData: any;
4
+ };
2
5
  export declare type GenericObject = {
3
6
  [key: string]: any;
4
7
  };
@@ -22,6 +22,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
22
22
  const yup = __importStar(require("yup"));
23
23
  const zod_1 = require("zod");
24
24
  const __1 = require("..");
25
+ const flatten_1 = require("../internal/flatten");
25
26
  const testFormData_1 = require("../test-data/testFormData");
26
27
  const withZod_1 = require("./withZod");
27
28
  const validationTestCases = [
@@ -99,6 +100,7 @@ describe("Validation", () => {
99
100
  "address.country": anyString,
100
101
  "address.streetAddress": anyString,
101
102
  "pets[0].name": anyString,
103
+ _submittedData: obj,
102
104
  },
103
105
  });
104
106
  });
@@ -140,6 +142,7 @@ describe("Validation", () => {
140
142
  error: {
141
143
  "address.city": anyString,
142
144
  "pets[0].name": anyString,
145
+ _submittedData: (0, flatten_1.objectFromPathEntries)([...formData.entries()]),
143
146
  },
144
147
  });
145
148
  });
@@ -260,6 +263,7 @@ describe("withZod", () => {
260
263
  type: anyString,
261
264
  bar: anyString,
262
265
  foo: anyString,
266
+ _submittedData: obj,
263
267
  },
264
268
  });
265
269
  });
@@ -278,6 +282,7 @@ describe("withZod", () => {
278
282
  error: {
279
283
  field1: anyString,
280
284
  field2: anyString,
285
+ _submittedData: obj,
281
286
  },
282
287
  });
283
288
  expect(validator.validateField(obj, "field1")).toEqual({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "remix-validated-form",
3
- "version": "2.0.1-beta.1",
3
+ "version": "2.1.0",
4
4
  "description": "Form component and utils for easy form validation in remix",
5
5
  "browser": "./browser/index.js",
6
6
  "main": "./build/index.js",
@@ -17,7 +17,7 @@
17
17
  "test": "jest src",
18
18
  "test:watch": "jest src --watch",
19
19
  "prepublishOnly": "cp ../../README.md ./README.md && npm run build",
20
- "postpublishOnly": "rm ./README.md"
20
+ "postpublish": "rm ./README.md"
21
21
  },
22
22
  "author": {
23
23
  "name": "Aaron Pettengill",
@@ -14,8 +14,13 @@ import React, {
14
14
  } from "react";
15
15
  import invariant from "tiny-invariant";
16
16
  import { FormContext, FormContextValue } from "./internal/formContext";
17
+ import { useSubmitComplete } from "./internal/submissionCallbacks";
17
18
  import { omit, mergeRefs } from "./internal/util";
18
- import { FieldErrors, Validator } from "./validation/types";
19
+ import {
20
+ FieldErrors,
21
+ Validator,
22
+ FieldErrorsWithData,
23
+ } from "./validation/types";
19
24
 
20
25
  export type FormProps<DataType> = {
21
26
  /**
@@ -42,39 +47,95 @@ export type FormProps<DataType> = {
42
47
  * A ref to the form element.
43
48
  */
44
49
  formRef?: React.RefObject<HTMLFormElement>;
50
+ /**
51
+ * An optional sub-action to use for the form.
52
+ * Setting a value here will cause the form to be submitted with an extra `subaction` value.
53
+ * This can be useful when there are multiple forms on the screen handled by the same action.
54
+ */
55
+ subaction?: string;
56
+ /**
57
+ * Reset the form to the default values after the form has been successfully submitted.
58
+ * This is useful if you want to submit the same form multiple times,
59
+ * and don't redirect in-between submissions.
60
+ */
61
+ resetAfterSubmit?: boolean;
45
62
  } & Omit<ComponentProps<typeof RemixForm>, "onSubmit">;
46
63
 
47
- function useFieldErrors(
48
- fetcher?: ReturnType<typeof useFetcher>
49
- ): [FieldErrors, React.Dispatch<React.SetStateAction<FieldErrors>>] {
64
+ function useFieldErrorsFromBackend(
65
+ fetcher?: ReturnType<typeof useFetcher>,
66
+ subaction?: string
67
+ ): FieldErrorsWithData | null {
50
68
  const actionData = useActionData<any>();
51
- const dataToUse = fetcher ? fetcher.data : actionData;
52
- const fieldErrorsFromAction = dataToUse?.fieldErrors;
69
+ if (fetcher) return (fetcher.data as any)?.fieldErrors;
70
+ if (!actionData) return null;
71
+ if (actionData.fieldErrors) {
72
+ const submittedData = actionData.fieldErrors?._submittedData;
73
+ const subactionsMatch = subaction
74
+ ? subaction === submittedData?.subaction
75
+ : !submittedData?.subaction;
76
+ return subactionsMatch ? actionData.fieldErrors : null;
77
+ }
78
+ return null;
79
+ }
53
80
 
81
+ function useFieldErrors(
82
+ fieldErrorsFromBackend?: any
83
+ ): [FieldErrors, React.Dispatch<React.SetStateAction<FieldErrors>>] {
54
84
  const [fieldErrors, setFieldErrors] = useState<FieldErrors>(
55
- fieldErrorsFromAction ?? {}
85
+ fieldErrorsFromBackend ?? {}
56
86
  );
57
87
  useEffect(() => {
58
- if (fieldErrorsFromAction) setFieldErrors(fieldErrorsFromAction);
59
- }, [fieldErrorsFromAction]);
88
+ if (fieldErrorsFromBackend) setFieldErrors(fieldErrorsFromBackend);
89
+ }, [fieldErrorsFromBackend]);
60
90
 
61
91
  return [fieldErrors, setFieldErrors];
62
92
  }
63
93
 
64
94
  const useIsSubmitting = (
65
95
  action?: string,
96
+ subaction?: string,
66
97
  fetcher?: ReturnType<typeof useFetcher>
67
98
  ) => {
68
99
  const actionForCurrentPage = useFormAction();
69
100
  const pendingFormSubmit = useTransition().submission;
70
- return fetcher
71
- ? fetcher.state === "submitting"
72
- : pendingFormSubmit &&
73
- pendingFormSubmit.action === (action ?? actionForCurrentPage);
101
+
102
+ if (fetcher) return fetcher.state === "submitting";
103
+ if (!pendingFormSubmit) return false;
104
+
105
+ const { formData, action: pendingAction } = pendingFormSubmit;
106
+ const pendingSubAction = formData.get("subaction");
107
+ const expectedAction = action ?? actionForCurrentPage;
108
+ if (subaction)
109
+ return expectedAction === pendingAction && subaction === pendingSubAction;
110
+ return expectedAction === pendingAction && !pendingSubAction;
74
111
  };
75
112
 
76
113
  const getDataFromForm = (el: HTMLFormElement) => new FormData(el);
77
114
 
115
+ /**
116
+ * The purpose for this logic is to handle validation errors when javascript is disabled.
117
+ * Normally (without js), when a form is submitted and the action returns the validation errors,
118
+ * the form will be reset. The errors will be displayed on the correct fields,
119
+ * but all the values in the form will be gone. This is not good UX.
120
+ *
121
+ * To get around this, we return the submitted form data from the server,
122
+ * and use those to populate the form via `defaultValues`.
123
+ * This results in a more seamless UX akin to what you would see when js is enabled.
124
+ *
125
+ * One potential downside is that resetting the form will reset the form
126
+ * to the _new_ default values that were returned from the server with the validation errors.
127
+ * However, this case is less of a problem than the janky UX caused by losing the form values.
128
+ * It will only ever be a problem if the form includes a `<button type="reset" />`
129
+ * and only if JS is disabled.
130
+ */
131
+ function useDefaultValues<DataType>(
132
+ fieldErrors?: FieldErrorsWithData | null,
133
+ defaultValues?: Partial<DataType>
134
+ ) {
135
+ const defaultsFromValidationError = fieldErrors?._submittedData;
136
+ return defaultsFromValidationError ?? defaultValues;
137
+ }
138
+
78
139
  /**
79
140
  * The primary form component of `remix-validated-form`.
80
141
  */
@@ -86,18 +147,27 @@ export function ValidatedForm<DataType>({
86
147
  action,
87
148
  defaultValues,
88
149
  formRef: formRefProp,
150
+ onReset,
151
+ subaction,
152
+ resetAfterSubmit,
89
153
  ...rest
90
154
  }: FormProps<DataType>) {
91
- const [fieldErrors, setFieldErrors] = useFieldErrors(fetcher);
92
- const isSubmitting = useIsSubmitting(action, fetcher);
93
-
155
+ const fieldErrorsFromBackend = useFieldErrorsFromBackend(fetcher, subaction);
156
+ const [fieldErrors, setFieldErrors] = useFieldErrors(fieldErrorsFromBackend);
157
+ const isSubmitting = useIsSubmitting(action, subaction, fetcher);
158
+ const defaultsToUse = useDefaultValues(fieldErrorsFromBackend, defaultValues);
94
159
  const formRef = useRef<HTMLFormElement>(null);
160
+ useSubmitComplete(isSubmitting, () => {
161
+ if (!fieldErrorsFromBackend && resetAfterSubmit) {
162
+ formRef.current?.reset();
163
+ }
164
+ });
95
165
 
96
166
  const contextValue = useMemo<FormContextValue>(
97
167
  () => ({
98
168
  fieldErrors,
99
169
  action,
100
- defaultValues,
170
+ defaultValues: defaultsToUse,
101
171
  isSubmitting: isSubmitting ?? false,
102
172
  clearError: (fieldName) => {
103
173
  setFieldErrors((prev) => omit(prev, fieldName));
@@ -119,7 +189,7 @@ export function ValidatedForm<DataType>({
119
189
  [
120
190
  fieldErrors,
121
191
  action,
122
- defaultValues,
192
+ defaultsToUse,
123
193
  isSubmitting,
124
194
  setFieldErrors,
125
195
  validator,
@@ -142,8 +212,14 @@ export function ValidatedForm<DataType>({
142
212
  onSubmit?.(result.data, event);
143
213
  }
144
214
  }}
215
+ onReset={(event) => {
216
+ onReset?.(event);
217
+ if (event.defaultPrevented) return;
218
+ setFieldErrors({});
219
+ }}
145
220
  >
146
221
  <FormContext.Provider value={contextValue}>
222
+ <input type="hidden" value={subaction} name="subaction" />
147
223
  {children}
148
224
  </FormContext.Provider>
149
225
  </Form>
@@ -0,0 +1,15 @@
1
+ import { useEffect, useRef } from "react";
2
+
3
+ export function useSubmitComplete(isSubmitting: boolean, callback: () => void) {
4
+ const isPending = useRef(false);
5
+ useEffect(() => {
6
+ if (isSubmitting) {
7
+ isPending.current = true;
8
+ }
9
+
10
+ if (!isSubmitting && isPending.current) {
11
+ isPending.current = false;
12
+ callback();
13
+ }
14
+ });
15
+ }
@@ -16,8 +16,18 @@ const preprocessFormData = (data: GenericObject | FormData): GenericObject => {
16
16
  */
17
17
  export function createValidator<T>(validator: Validator<T>): Validator<T> {
18
18
  return {
19
- validate: (value: GenericObject | FormData) =>
20
- validator.validate(preprocessFormData(value)),
19
+ validate: (value: GenericObject | FormData) => {
20
+ const data = preprocessFormData(value);
21
+ const result = validator.validate(data);
22
+ if (result.error) {
23
+ // Ideally, we should probably be returning a nested object like
24
+ // { fieldErrors: {}, submittedData: {} }
25
+ // We should do this in the next major version of the library
26
+ // but for now, we can sneak it in with the fieldErrors.
27
+ result.error._submittedData = data as any;
28
+ }
29
+ return result;
30
+ },
21
31
  validateField: (data: GenericObject | FormData, field: string) =>
22
32
  validator.validateField(preprocessFormData(data), field),
23
33
  };
@@ -1,5 +1,7 @@
1
1
  export type FieldErrors = Record<string, string>;
2
2
 
3
+ export type FieldErrorsWithData = FieldErrors & { _submittedData: any };
4
+
3
5
  export type GenericObject = { [key: string]: any };
4
6
 
5
7
  /**
@@ -1,6 +1,7 @@
1
1
  import * as yup from "yup";
2
2
  import { z } from "zod";
3
3
  import { Validator, withYup } from "..";
4
+ import { objectFromPathEntries } from "../internal/flatten";
4
5
  import { TestFormData } from "../test-data/testFormData";
5
6
  import { withZod } from "./withZod";
6
7
 
@@ -112,6 +113,7 @@ describe("Validation", () => {
112
113
  "address.country": anyString,
113
114
  "address.streetAddress": anyString,
114
115
  "pets[0].name": anyString,
116
+ _submittedData: obj,
115
117
  },
116
118
  });
117
119
  });
@@ -156,6 +158,7 @@ describe("Validation", () => {
156
158
  error: {
157
159
  "address.city": anyString,
158
160
  "pets[0].name": anyString,
161
+ _submittedData: objectFromPathEntries([...formData.entries()]),
159
162
  },
160
163
  });
161
164
  });
@@ -285,6 +288,7 @@ describe("withZod", () => {
285
288
  type: anyString,
286
289
  bar: anyString,
287
290
  foo: anyString,
291
+ _submittedData: obj,
288
292
  },
289
293
  });
290
294
  });
@@ -305,6 +309,7 @@ describe("withZod", () => {
305
309
  error: {
306
310
  field1: anyString,
307
311
  field2: anyString,
312
+ _submittedData: obj,
308
313
  },
309
314
  });
310
315
  expect(validator.validateField(obj, "field1")).toEqual({