remix-validated-form 4.1.7 → 4.2.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.
@@ -1,9 +1,9 @@
1
1
  $ npm run build:browser && npm run build:main
2
2
 
3
- > remix-validated-form@4.1.4 build:browser
3
+ > remix-validated-form@4.1.9 build:browser
4
4
  > tsc --module ESNext --outDir ./browser
5
5
 
6
6
 
7
- > remix-validated-form@4.1.4 build:main
7
+ > remix-validated-form@4.1.9 build:main
8
8
  > tsc --module CommonJS --outDir ./build
9
9
 
package/README.md CHANGED
@@ -71,9 +71,7 @@ export const MyInput = ({ name, label }: MyInputProps) => {
71
71
  <div>
72
72
  <label htmlFor={name}>{label}</label>
73
73
  <input {...getInputProps({ id: name })} />
74
- {error && (
75
- <span className="my-error-class">{error}</span>
76
- )}
74
+ {error && <span className="my-error-class">{error}</span>}
77
75
  </div>
78
76
  );
79
77
  };
@@ -92,14 +90,17 @@ export const MySubmitButton = () => {
92
90
  const disabled = isSubmitting || !isValid;
93
91
 
94
92
  return (
95
- <button type="submit" disabled={disabled} className={disabled ? "disabled-btn" : "btn"}>
93
+ <button
94
+ type="submit"
95
+ disabled={disabled}
96
+ className={disabled ? "disabled-btn" : "btn"}
97
+ >
96
98
  {isSubmitting ? "Submitting..." : "Submit"}
97
99
  </button>
98
100
  );
99
101
  };
100
102
  ```
101
103
 
102
-
103
104
  ## Use the form!
104
105
 
105
106
  Now that we have our components, making a form is easy!
@@ -258,5 +259,6 @@ Problem: how do we trigger a toast message on success if the action redirects aw
258
259
  See the [Remix](https://remix.run/docs/en/v1/api/remix#sessionflashkey-value) documentation for more information.
259
260
 
260
261
  ## Why is my cancel button triggering form submission?
262
+
261
263
  Problem: the cancel button has an onClick handler to navigate away from the form route but instead it is submitting the form.
262
264
  A button defaults to `type="submit"` in a form which will submit the form by default. If you want to prevent this you can add `type="reset"` or `type="button"` to the cancel button.
@@ -96,7 +96,7 @@ export const useFieldDefaultValue = (name, context) => {
96
96
  const { defaultValues: state } = useFormAtomValue(formPropsAtom(context.formId));
97
97
  return defaultValues
98
98
  .map((val) => lodashGet(val, name))
99
- .hydrateTo(state[name]);
99
+ .hydrateTo(lodashGet(state, name));
100
100
  };
101
101
  export const useClearError = ({ formId }) => {
102
102
  const updateError = useFormUpdateAtom(setFieldErrorAtom(formId));
@@ -1,6 +1,5 @@
1
1
  import { PrimitiveAtom } from "jotai";
2
2
  import { InternalFormId } from "./atomUtils";
3
- export declare type ValueSerializer = (val: unknown) => string;
4
3
  export declare const controlledFieldsAtom: {
5
4
  (param: InternalFormId): import("jotai").Atom<Record<string, PrimitiveAtom<unknown>>> & {
6
5
  write: (get: {
@@ -59,8 +58,5 @@ export declare const setControlledFieldValueAtom: import("jotai").Atom<null> & {
59
58
  } & {
60
59
  init: null;
61
60
  };
62
- export declare const useAllControlledFields: (formId: InternalFormId) => Record<string, PrimitiveAtom<unknown>>;
63
61
  export declare const useControlledFieldValue: (formId: InternalFormId, field: string) => any;
64
62
  export declare const useControllableValue: (formId: InternalFormId, field: string) => readonly [any, (value: unknown) => Promise<void>];
65
- export declare const useFieldSerializer: (formId: InternalFormId, field: string) => ValueSerializer;
66
- export declare const useRegisterFieldSerializer: (formId: InternalFormId, field: string, serializer?: ValueSerializer | undefined) => void;
@@ -9,13 +9,6 @@ const refCountAtom = fieldAtomFamily(() => atom(0));
9
9
  const fieldValueAtom = fieldAtomFamily(() => atom(undefined));
10
10
  const fieldValueHydratedAtom = fieldAtomFamily(() => atom(false));
11
11
  const pendingValidateAtom = fieldAtomFamily(() => atom(undefined));
12
- const valueSerializerAtom = fieldAtomFamily(() => atom({
13
- serializer: (value) => {
14
- if (value === undefined)
15
- return "";
16
- return JSON.stringify(value);
17
- },
18
- }));
19
12
  const registerAtom = atom(null, (get, set, { formId, field }) => {
20
13
  set(refCountAtom({ formId, field }), (prev) => prev + 1);
21
14
  const newRefCount = get(refCountAtom({ formId, field }));
@@ -44,7 +37,6 @@ export const setControlledFieldValueAtom = atom(null, async (_get, set, { formId
44
37
  await new Promise((resolve) => set(pending, resolve));
45
38
  set(pending, undefined);
46
39
  });
47
- export const useAllControlledFields = (formId) => useFormAtomValue(controlledFieldsAtom(formId));
48
40
  export const useControlledFieldValue = (formId, field) => {
49
41
  const fieldAtom = fieldValueAtom({ formId, field });
50
42
  const [value, setValue] = useFormAtom(fieldAtom);
@@ -83,11 +75,3 @@ export const useControllableValue = (formId, field) => {
83
75
  const value = useControlledFieldValue(formId, field);
84
76
  return [value, setValue];
85
77
  };
86
- export const useFieldSerializer = (formId, field) => useFormAtomValue(valueSerializerAtom({ formId, field })).serializer;
87
- export const useRegisterFieldSerializer = (formId, field, serializer) => {
88
- const setSerializer = useFormUpdateAtom(valueSerializerAtom({ formId, field }));
89
- useEffect(() => {
90
- if (serializer)
91
- setSerializer({ serializer });
92
- }, [serializer, setSerializer]);
93
- };
@@ -14,7 +14,7 @@ import { ValidatorError } from "./validation/types";
14
14
  * if (result.error) return validationError(result.error, result.submittedData);
15
15
  * ```
16
16
  */
17
- export declare function validationError(error: ValidatorError, repopulateFields?: unknown): Response;
17
+ export declare function validationError(error: ValidatorError, repopulateFields?: unknown, init?: ResponseInit): Response;
18
18
  export declare type FormDefaults = {
19
19
  [formDefaultsKey: `${typeof FORM_DEFAULTS_FIELD}_${string}`]: any;
20
20
  };
package/browser/server.js CHANGED
@@ -14,13 +14,13 @@ import { formDefaultValuesKey, } from "./internal/constants";
14
14
  * if (result.error) return validationError(result.error, result.submittedData);
15
15
  * ```
16
16
  */
17
- export function validationError(error, repopulateFields) {
17
+ export function validationError(error, repopulateFields, init) {
18
18
  return json({
19
19
  fieldErrors: error.fieldErrors,
20
20
  subaction: error.subaction,
21
21
  repopulateFields,
22
22
  formId: error.formId,
23
- }, { status: 422 });
23
+ }, { status: 422, ...init });
24
24
  }
25
25
  export const setFormDefaults = (formId, defaultValues) => ({
26
26
  [formDefaultValuesKey(formId)]: defaultValues,
@@ -113,7 +113,7 @@ const useFieldDefaultValue = (name, context) => {
113
113
  const { defaultValues: state } = (0, exports.useFormAtomValue)((0, state_1.formPropsAtom)(context.formId));
114
114
  return defaultValues
115
115
  .map((val) => (0, get_1.default)(val, name))
116
- .hydrateTo(state[name]);
116
+ .hydrateTo((0, get_1.default)(state, name));
117
117
  };
118
118
  exports.useFieldDefaultValue = useFieldDefaultValue;
119
119
  const useClearError = ({ formId }) => {
@@ -1,6 +1,5 @@
1
1
  import { PrimitiveAtom } from "jotai";
2
2
  import { InternalFormId } from "./atomUtils";
3
- export declare type ValueSerializer = (val: unknown) => string;
4
3
  export declare const controlledFieldsAtom: {
5
4
  (param: InternalFormId): import("jotai").Atom<Record<string, PrimitiveAtom<unknown>>> & {
6
5
  write: (get: {
@@ -59,8 +58,5 @@ export declare const setControlledFieldValueAtom: import("jotai").Atom<null> & {
59
58
  } & {
60
59
  init: null;
61
60
  };
62
- export declare const useAllControlledFields: (formId: InternalFormId) => Record<string, PrimitiveAtom<unknown>>;
63
61
  export declare const useControlledFieldValue: (formId: InternalFormId, field: string) => any;
64
62
  export declare const useControllableValue: (formId: InternalFormId, field: string) => readonly [any, (value: unknown) => Promise<void>];
65
- export declare const useFieldSerializer: (formId: InternalFormId, field: string) => ValueSerializer;
66
- export declare const useRegisterFieldSerializer: (formId: InternalFormId, field: string, serializer?: ValueSerializer | undefined) => void;
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.useRegisterFieldSerializer = exports.useFieldSerializer = exports.useControllableValue = exports.useControlledFieldValue = exports.useAllControlledFields = exports.setControlledFieldValueAtom = exports.controlledFieldsAtom = void 0;
6
+ exports.useControllableValue = exports.useControlledFieldValue = exports.setControlledFieldValueAtom = exports.controlledFieldsAtom = void 0;
7
7
  const jotai_1 = require("jotai");
8
8
  const omit_1 = __importDefault(require("lodash/omit"));
9
9
  const react_1 = require("react");
@@ -15,13 +15,6 @@ const refCountAtom = (0, atomUtils_1.fieldAtomFamily)(() => (0, jotai_1.atom)(0)
15
15
  const fieldValueAtom = (0, atomUtils_1.fieldAtomFamily)(() => (0, jotai_1.atom)(undefined));
16
16
  const fieldValueHydratedAtom = (0, atomUtils_1.fieldAtomFamily)(() => (0, jotai_1.atom)(false));
17
17
  const pendingValidateAtom = (0, atomUtils_1.fieldAtomFamily)(() => (0, jotai_1.atom)(undefined));
18
- const valueSerializerAtom = (0, atomUtils_1.fieldAtomFamily)(() => (0, jotai_1.atom)({
19
- serializer: (value) => {
20
- if (value === undefined)
21
- return "";
22
- return JSON.stringify(value);
23
- },
24
- }));
25
18
  const registerAtom = (0, jotai_1.atom)(null, (get, set, { formId, field }) => {
26
19
  set(refCountAtom({ formId, field }), (prev) => prev + 1);
27
20
  const newRefCount = get(refCountAtom({ formId, field }));
@@ -50,8 +43,6 @@ exports.setControlledFieldValueAtom = (0, jotai_1.atom)(null, async (_get, set,
50
43
  await new Promise((resolve) => set(pending, resolve));
51
44
  set(pending, undefined);
52
45
  });
53
- const useAllControlledFields = (formId) => (0, hooks_1.useFormAtomValue)((0, exports.controlledFieldsAtom)(formId));
54
- exports.useAllControlledFields = useAllControlledFields;
55
46
  const useControlledFieldValue = (formId, field) => {
56
47
  const fieldAtom = fieldValueAtom({ formId, field });
57
48
  const [value, setValue] = (0, hooks_1.useFormAtom)(fieldAtom);
@@ -92,13 +83,3 @@ const useControllableValue = (formId, field) => {
92
83
  return [value, setValue];
93
84
  };
94
85
  exports.useControllableValue = useControllableValue;
95
- const useFieldSerializer = (formId, field) => (0, hooks_1.useFormAtomValue)(valueSerializerAtom({ formId, field })).serializer;
96
- exports.useFieldSerializer = useFieldSerializer;
97
- const useRegisterFieldSerializer = (formId, field, serializer) => {
98
- const setSerializer = (0, hooks_1.useFormUpdateAtom)(valueSerializerAtom({ formId, field }));
99
- (0, react_1.useEffect)(() => {
100
- if (serializer)
101
- setSerializer({ serializer });
102
- }, [serializer, setSerializer]);
103
- };
104
- exports.useRegisterFieldSerializer = useRegisterFieldSerializer;
package/build/server.d.ts CHANGED
@@ -14,7 +14,7 @@ import { ValidatorError } from "./validation/types";
14
14
  * if (result.error) return validationError(result.error, result.submittedData);
15
15
  * ```
16
16
  */
17
- export declare function validationError(error: ValidatorError, repopulateFields?: unknown): Response;
17
+ export declare function validationError(error: ValidatorError, repopulateFields?: unknown, init?: ResponseInit): Response;
18
18
  export declare type FormDefaults = {
19
19
  [formDefaultsKey: `${typeof FORM_DEFAULTS_FIELD}_${string}`]: any;
20
20
  };
package/build/server.js CHANGED
@@ -17,13 +17,13 @@ const constants_1 = require("./internal/constants");
17
17
  * if (result.error) return validationError(result.error, result.submittedData);
18
18
  * ```
19
19
  */
20
- function validationError(error, repopulateFields) {
20
+ function validationError(error, repopulateFields, init) {
21
21
  return (0, server_runtime_1.json)({
22
22
  fieldErrors: error.fieldErrors,
23
23
  subaction: error.subaction,
24
24
  repopulateFields,
25
25
  formId: error.formId,
26
- }, { status: 422 });
26
+ }, { status: 422, ...init });
27
27
  }
28
28
  exports.validationError = validationError;
29
29
  const setFormDefaults = (formId, defaultValues) => ({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "remix-validated-form",
3
- "version": "4.1.7",
3
+ "version": "4.2.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",
@@ -35,7 +35,7 @@
35
35
  "peerDependencies": {
36
36
  "@remix-run/react": "1.x",
37
37
  "@remix-run/server-runtime": "1.x",
38
- "react": "^17.0.2"
38
+ "react": "^17.0.2 || ^18.0.0"
39
39
  },
40
40
  "devDependencies": {
41
41
  "@remix-run/react": "^1.2.1",
@@ -159,7 +159,7 @@ export const useFieldDefaultValue = (
159
159
  );
160
160
  return defaultValues
161
161
  .map((val) => lodashGet(val, name))
162
- .hydrateTo(state[name]);
162
+ .hydrateTo(lodashGet(state, name));
163
163
  };
164
164
 
165
165
  export const useClearError = ({ formId }: InternalFormContextValue) => {
package/src/server.ts CHANGED
@@ -24,7 +24,8 @@ import {
24
24
  */
25
25
  export function validationError(
26
26
  error: ValidatorError,
27
- repopulateFields?: unknown
27
+ repopulateFields?: unknown,
28
+ init?: ResponseInit
28
29
  ): Response {
29
30
  return json<ValidationErrorResponseData>(
30
31
  {
@@ -33,7 +34,7 @@ export function validationError(
33
34
  repopulateFields,
34
35
  formId: error.formId,
35
36
  },
36
- { status: 422 }
37
+ { status: 422, ...init }
37
38
  );
38
39
  }
39
40