remix-validated-form 2.0.1-beta.1 → 3.0.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.
Files changed (40) hide show
  1. package/.turbo/turbo-build.log +9 -0
  2. package/.turbo/turbo-dev.log +0 -0
  3. package/.turbo/turbo-test.log +10 -35
  4. package/README.md +20 -8
  5. package/browser/ValidatedForm.d.ts +13 -1
  6. package/browser/ValidatedForm.js +72 -19
  7. package/browser/index.d.ts +0 -2
  8. package/browser/index.js +0 -2
  9. package/browser/internal/submissionCallbacks.d.ts +1 -0
  10. package/browser/internal/submissionCallbacks.js +13 -0
  11. package/browser/validation/createValidator.js +12 -1
  12. package/browser/validation/types.d.ts +3 -0
  13. package/browser/validation/validation.test.js +5 -0
  14. package/build/ValidatedForm.d.ts +13 -1
  15. package/build/ValidatedForm.js +71 -18
  16. package/build/index.d.ts +0 -2
  17. package/build/index.js +0 -2
  18. package/build/internal/submissionCallbacks.d.ts +1 -0
  19. package/build/internal/submissionCallbacks.js +17 -0
  20. package/build/validation/createValidator.js +12 -1
  21. package/build/validation/types.d.ts +3 -0
  22. package/package.json +4 -9
  23. package/src/ValidatedForm.tsx +96 -18
  24. package/src/index.ts +0 -2
  25. package/src/internal/submissionCallbacks.ts +15 -0
  26. package/src/validation/createValidator.ts +12 -2
  27. package/src/validation/types.ts +2 -0
  28. package/build/test-data/testFormData.d.ts +0 -15
  29. package/build/test-data/testFormData.js +0 -50
  30. package/build/validation/validation.test.d.ts +0 -1
  31. package/build/validation/validation.test.js +0 -290
  32. package/build/validation/withYup.d.ts +0 -6
  33. package/build/validation/withYup.js +0 -44
  34. package/build/validation/withZod.d.ts +0 -6
  35. package/build/validation/withZod.js +0 -57
  36. package/jest.config.js +0 -10
  37. package/src/test-data/testFormData.ts +0 -55
  38. package/src/validation/validation.test.ts +0 -317
  39. package/src/validation/withYup.ts +0 -43
  40. package/src/validation/withZod.ts +0 -51
@@ -0,0 +1,9 @@
1
+ $ npm run build:browser && npm run build:main
2
+
3
+ > remix-validated-form@2.1.1 build:browser
4
+ > tsc --module ESNext --outDir ./browser
5
+
6
+
7
+ > remix-validated-form@2.1.1 build:main
8
+ > tsc --module CommonJS --outDir ./build
9
+
File without changes
@@ -1,36 +1,11 @@
1
1
  $ jest src
2
-  PASS  src/validation/validation.test.ts
3
- Validation
4
- Adapter for yup
5
- validate
6
- ✓ should return the data when valid (2 ms)
7
- ✓ should return field errors when invalid (2 ms)
8
- ✓ should unflatten data when validating
9
- ✓ should accept FormData directly and return errors
10
- ✓ should accept FormData directly and return valid data (1 ms)
11
- validateField
12
- ✓ should not return an error if field is valid
13
- ✓ should not return an error if a nested field is valid (1 ms)
14
- ✓ should return an error if field is invalid
15
- ✓ should return an error if a nested field is invalid
16
- Adapter for zod
17
- validate
18
- ✓ should return the data when valid (2 ms)
19
- ✓ should return field errors when invalid
20
- ✓ should unflatten data when validating (1 ms)
21
- ✓ should accept FormData directly and return errors
22
- ✓ should accept FormData directly and return valid data
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)
26
- ✓ should return an error if field is invalid
27
- ✓ should return an error if a nested field is invalid
28
- withZod
29
- ✓ returns coherent errors for complex schemas (1 ms)
30
- ✓ returns errors for fields that are unions
31
-
32
- Test Suites: 1 passed, 1 total
33
- Tests: 20 passed, 20 total
34
- Snapshots: 0 total
35
- Time: 1.526 s, estimated 2 s
36
- Ran all test suites matching /src/i.
2
+ No tests found, exiting with code 1
3
+ Run with `--passWithNoTests` to exit with code 0
4
+ In /Users/aaronpettengill/dev/remix-validated-form/packages/remix-validated-form
5
+ 68 files checked.
6
+ testMatch: **/__tests__/**/*.[jt]s?(x), **/?(*.)+(spec|test).[tj]s?(x) - 2 matches
7
+ testPathIgnorePatterns: /node_modules/ - 68 matches
8
+ testRegex: - 0 matches
9
+ Pattern: src - 0 matches
10
+ info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
11
+ error Command failed with exit code 1.
package/README.md CHANGED
@@ -18,22 +18,34 @@ To run `sample-app`:
18
18
 
19
19
  ```
20
20
  git clone https://github.com/airjp73/remix-validated-form
21
- cd remix-validated-form
22
- npm i
23
- cd sample-app
24
- npm i
25
- cd ..
26
- npm run sample-app
21
+ cd ./remix-validated-form
22
+ yarn install
23
+ yarn sample-app
27
24
  ```
28
25
 
29
26
  # Getting started
30
27
 
31
28
  ## Install
32
29
 
30
+ ### Base package
31
+
33
32
  ```bash
34
33
  npm install remix-validated-form
35
34
  ```
36
35
 
36
+ ### Validation library adapter
37
+
38
+ There are official adapters available for `zod` and `yup`.
39
+ If you're using a different library,
40
+ see the [Validation library support](#validation-library-support) section below.
41
+
42
+ - @remix-validated-form/with-zod
43
+ - @remix-validated-form/with-yup
44
+
45
+ ```bash
46
+ npm install @remix-validated-form/with-zod
47
+ ```
48
+
37
49
  ## Create an input component
38
50
 
39
51
  In order to display field errors or do field-by-field validation,
@@ -167,10 +179,10 @@ export default function MyForm() {
167
179
 
168
180
  # Validation Library Support
169
181
 
170
- This library currently includes an out-of-the-box adapter for `yup` and `zod`,
182
+ There are official adapters available for `zod` and `yup` ,
171
183
  but you can easily support whatever library you want by creating your own adapter.
172
184
 
173
- And if you create an adapter for a library, feel free to make a PR on this library to add official support 😊
185
+ And if you create an adapter for a library, feel free to make a PR on this repository 😊
174
186
 
175
187
  ## Creating an adapter
176
188
 
@@ -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: [subaction && (_jsx("input", { type: "hidden", value: subaction, name: "subaction" }, void 0)), children] }, void 0) }, void 0));
72
125
  }
@@ -2,7 +2,5 @@ export * from "./hooks";
2
2
  export * from "./server";
3
3
  export * from "./ValidatedForm";
4
4
  export * from "./validation/types";
5
- export * from "./validation/withYup";
6
- export * from "./validation/withZod";
7
5
  export * from "./validation/createValidator";
8
6
  export type { FormContextValue } from "./internal/formContext";
package/browser/index.js CHANGED
@@ -2,6 +2,4 @@ export * from "./hooks";
2
2
  export * from "./server";
3
3
  export * from "./ValidatedForm";
4
4
  export * from "./validation/types";
5
- export * from "./validation/withYup";
6
- export * from "./validation/withZod";
7
5
  export * from "./validation/createValidator";
@@ -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: [subaction && ((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;
package/build/index.d.ts CHANGED
@@ -2,7 +2,5 @@ export * from "./hooks";
2
2
  export * from "./server";
3
3
  export * from "./ValidatedForm";
4
4
  export * from "./validation/types";
5
- export * from "./validation/withYup";
6
- export * from "./validation/withZod";
7
5
  export * from "./validation/createValidator";
8
6
  export type { FormContextValue } from "./internal/formContext";
package/build/index.js CHANGED
@@ -14,6 +14,4 @@ __exportStar(require("./hooks"), exports);
14
14
  __exportStar(require("./server"), exports);
15
15
  __exportStar(require("./ValidatedForm"), exports);
16
16
  __exportStar(require("./validation/types"), exports);
17
- __exportStar(require("./validation/withYup"), exports);
18
- __exportStar(require("./validation/withZod"), exports);
19
17
  __exportStar(require("./validation/createValidator"), exports);
@@ -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
  };
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": "3.0.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",
@@ -14,10 +14,8 @@
14
14
  "build": "npm run build:browser && npm run build:main",
15
15
  "build:browser": "tsc --module ESNext --outDir ./browser",
16
16
  "build:main": "tsc --module CommonJS --outDir ./build",
17
- "test": "jest src",
18
- "test:watch": "jest src --watch",
19
17
  "prepublishOnly": "cp ../../README.md ./README.md && npm run build",
20
- "postpublishOnly": "rm ./README.md"
18
+ "postpublish": "rm ./README.md"
21
19
  },
22
20
  "author": {
23
21
  "name": "Aaron Pettengill",
@@ -31,6 +29,7 @@
31
29
  "react",
32
30
  "form",
33
31
  "yup",
32
+ "zod",
34
33
  "validation"
35
34
  ],
36
35
  "peerDependencies": {
@@ -41,16 +40,12 @@
41
40
  "devDependencies": {
42
41
  "@remix-run/react": "^1.0.6",
43
42
  "@remix-run/server-runtime": "^1.0.6",
44
- "@types/jest": "^27.0.3",
45
43
  "@types/lodash": "^4.14.178",
46
44
  "@types/react": "^17.0.37",
47
45
  "fetch-blob": "^3.1.3",
48
46
  "react": "^17.0.2",
49
- "ts-jest": "^27.1.1",
50
47
  "tsconfig": "*",
51
- "typescript": "^4.5.3",
52
- "yup": "^0.32.11",
53
- "zod": "^3.11.6"
48
+ "typescript": "^4.5.3"
54
49
  },
55
50
  "dependencies": {
56
51
  "lodash": "^4.17.21",