remix-validated-form 4.1.1 → 4.1.4

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 (55) hide show
  1. package/.turbo/turbo-build.log +2 -2
  2. package/browser/ValidatedForm.js +9 -4
  3. package/browser/internal/hooks-valtio.d.ts +18 -0
  4. package/browser/internal/hooks-valtio.js +110 -0
  5. package/browser/internal/hooks-zustand.d.ts +16 -0
  6. package/browser/internal/hooks-zustand.js +100 -0
  7. package/browser/internal/hydratable.d.ts +14 -0
  8. package/browser/internal/hydratable.js +14 -0
  9. package/browser/internal/immerMiddleware.d.ts +6 -0
  10. package/browser/internal/immerMiddleware.js +7 -0
  11. package/browser/internal/logic/getCheckboxChecked.js +1 -1
  12. package/browser/internal/logic/setInputValueInForm.d.ts +1 -0
  13. package/browser/internal/logic/setInputValueInForm.js +120 -0
  14. package/browser/internal/setFieldValue.d.ts +20 -0
  15. package/browser/internal/setFieldValue.js +83 -0
  16. package/browser/internal/setFormValues.d.ts +2 -0
  17. package/browser/internal/setFormValues.js +26 -0
  18. package/browser/internal/state/atomUtils.d.ts +38 -0
  19. package/browser/internal/state/atomUtils.js +5 -0
  20. package/browser/internal/state/controlledFields.d.ts +66 -0
  21. package/browser/internal/state/controlledFields.js +93 -0
  22. package/browser/internal/state/setFieldValue.d.ts +0 -0
  23. package/browser/internal/state/setFieldValue.js +1 -0
  24. package/browser/internal/state-valtio.d.ts +62 -0
  25. package/browser/internal/state-valtio.js +69 -0
  26. package/browser/internal/state-zustand.d.ts +47 -0
  27. package/browser/internal/state-zustand.js +85 -0
  28. package/browser/internal/util.js +1 -1
  29. package/build/ValidatedForm.js +9 -4
  30. package/build/internal/hooks-valtio.d.ts +18 -0
  31. package/build/internal/hooks-valtio.js +128 -0
  32. package/build/internal/hooks-zustand.d.ts +16 -0
  33. package/build/internal/hooks-zustand.js +117 -0
  34. package/build/internal/hydratable.d.ts +14 -0
  35. package/build/internal/hydratable.js +17 -0
  36. package/build/internal/immerMiddleware.d.ts +6 -0
  37. package/build/internal/immerMiddleware.js +14 -0
  38. package/build/internal/logic/getCheckboxChecked.js +1 -1
  39. package/build/internal/logic/setFieldValue.js +3 -3
  40. package/build/internal/logic/setInputValueInForm.d.ts +1 -0
  41. package/build/internal/logic/setInputValueInForm.js +127 -0
  42. package/build/internal/setFormValues.d.ts +2 -0
  43. package/build/internal/setFormValues.js +33 -0
  44. package/build/internal/state/atomUtils.d.ts +38 -0
  45. package/build/internal/state/atomUtils.js +13 -0
  46. package/build/internal/state/controlledFields.d.ts +66 -0
  47. package/build/internal/state/controlledFields.js +95 -0
  48. package/build/internal/state-valtio.d.ts +62 -0
  49. package/build/internal/state-valtio.js +83 -0
  50. package/build/internal/state-zustand.d.ts +47 -0
  51. package/build/internal/state-zustand.js +91 -0
  52. package/build/internal/util.js +5 -2
  53. package/package.json +5 -5
  54. package/src/ValidatedForm.tsx +10 -4
  55. package/src/internal/util.ts +1 -1
@@ -0,0 +1,117 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.useSetTouched = exports.useClearError = exports.useFieldDefaultValue = exports.useFieldError = exports.useFieldTouched = exports.useHasActiveFormSubmit = exports.useDefaultValuesForForm = exports.useDefaultValuesFromLoader = exports.useFieldErrorsForForm = exports.useErrorResponseForForm = exports.useInternalFormContext = void 0;
7
+ const react_1 = require("@remix-run/react");
8
+ const get_1 = __importDefault(require("lodash/get"));
9
+ const react_2 = require("react");
10
+ const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
11
+ const constants_1 = require("./constants");
12
+ const formContext_1 = require("./formContext");
13
+ const hydratable_1 = require("./hydratable");
14
+ const state_zustand_1 = require("./state-zustand");
15
+ const useInternalFormContext = (formId, hookName) => {
16
+ const formContext = (0, react_2.useContext)(formContext_1.InternalFormContext);
17
+ if (formId)
18
+ return { formId };
19
+ if (formContext)
20
+ return formContext;
21
+ throw new Error(`Unable to determine form for ${hookName}. Please use it inside a form or pass a 'formId'.`);
22
+ };
23
+ exports.useInternalFormContext = useInternalFormContext;
24
+ function useErrorResponseForForm({ fetcher, subaction, formId, }) {
25
+ var _a;
26
+ const actionData = (0, react_1.useActionData)();
27
+ if (fetcher) {
28
+ if ((_a = fetcher.data) === null || _a === void 0 ? void 0 : _a.fieldErrors)
29
+ return fetcher.data;
30
+ return null;
31
+ }
32
+ if (!(actionData === null || actionData === void 0 ? void 0 : actionData.fieldErrors))
33
+ return null;
34
+ // If there's an explicit id, we should ignore data that has the wrong id
35
+ if (typeof formId === "string" && actionData.formId)
36
+ return actionData.formId === formId ? actionData : null;
37
+ if ((!subaction && !actionData.subaction) ||
38
+ actionData.subaction === subaction)
39
+ return actionData;
40
+ return null;
41
+ }
42
+ exports.useErrorResponseForForm = useErrorResponseForForm;
43
+ const useFieldErrorsForForm = (context) => {
44
+ const response = useErrorResponseForForm(context);
45
+ const hydrated = (0, state_zustand_1.useStore)((state) => state.form(context.formId).hydrated);
46
+ return hydratable_1.hydratable.from(response === null || response === void 0 ? void 0 : response.fieldErrors, hydrated);
47
+ };
48
+ exports.useFieldErrorsForForm = useFieldErrorsForForm;
49
+ const useDefaultValuesFromLoader = ({ formId, }) => {
50
+ const matches = (0, react_1.useMatches)();
51
+ if (typeof formId === "string") {
52
+ const dataKey = (0, constants_1.formDefaultValuesKey)(formId);
53
+ // If multiple loaders declare the same default values,
54
+ // we should use the data from the deepest route.
55
+ const match = matches
56
+ .reverse()
57
+ .find((match) => match.data && dataKey in match.data);
58
+ return match === null || match === void 0 ? void 0 : match.data[dataKey];
59
+ }
60
+ return null;
61
+ };
62
+ exports.useDefaultValuesFromLoader = useDefaultValuesFromLoader;
63
+ const useDefaultValuesForForm = (context) => {
64
+ const { formId, defaultValuesProp } = context;
65
+ const hydrated = (0, state_zustand_1.useStore)((state) => state.form(formId).hydrated);
66
+ const errorResponse = useErrorResponseForForm(context);
67
+ const defaultValuesFromLoader = (0, exports.useDefaultValuesFromLoader)(context);
68
+ // Typical flow is:
69
+ // - Default values only available from props or server
70
+ // - Props have a higher priority than server
71
+ // - State gets hydrated with default values
72
+ // - After submit, we may need to use values from the error
73
+ if (hydrated)
74
+ return hydratable_1.hydratable.hydratedData();
75
+ if (errorResponse === null || errorResponse === void 0 ? void 0 : errorResponse.repopulateFields) {
76
+ (0, tiny_invariant_1.default)(typeof errorResponse.repopulateFields === "object", "repopulateFields returned something other than an object");
77
+ return hydratable_1.hydratable.serverData(errorResponse.repopulateFields);
78
+ }
79
+ if (defaultValuesProp)
80
+ return hydratable_1.hydratable.serverData(defaultValuesProp);
81
+ return hydratable_1.hydratable.serverData(defaultValuesFromLoader);
82
+ };
83
+ exports.useDefaultValuesForForm = useDefaultValuesForForm;
84
+ const useHasActiveFormSubmit = ({ fetcher, }) => {
85
+ const transition = (0, react_1.useTransition)();
86
+ const hasActiveSubmission = fetcher
87
+ ? fetcher.state === "submitting"
88
+ : !!transition.submission;
89
+ return hasActiveSubmission;
90
+ };
91
+ exports.useHasActiveFormSubmit = useHasActiveFormSubmit;
92
+ const useFieldTouched = (name, { formId }) => {
93
+ return (0, state_zustand_1.useStore)((state) => state.form(formId).touchedFields[name]);
94
+ };
95
+ exports.useFieldTouched = useFieldTouched;
96
+ const useFieldError = (name, context) => {
97
+ const state = (0, state_zustand_1.useStore)((state) => state.form(context.formId).fieldErrors[name]);
98
+ return (0, exports.useFieldErrorsForForm)(context)
99
+ .map((fieldErrors) => fieldErrors === null || fieldErrors === void 0 ? void 0 : fieldErrors[name])
100
+ .hydrateTo(state);
101
+ };
102
+ exports.useFieldError = useFieldError;
103
+ const useFieldDefaultValue = (name, context) => {
104
+ const state = (0, state_zustand_1.useStore)((state) => state.form(context.formId).defaultValues[name]);
105
+ return (0, exports.useDefaultValuesForForm)(context)
106
+ .map((val) => (0, get_1.default)(val, name))
107
+ .hydrateTo(state);
108
+ };
109
+ exports.useFieldDefaultValue = useFieldDefaultValue;
110
+ const useClearError = (context) => {
111
+ return (0, state_zustand_1.useStore)((state) => state.helpers(context.formId).clearError);
112
+ };
113
+ exports.useClearError = useClearError;
114
+ const useSetTouched = (context) => {
115
+ return (0, state_zustand_1.useStore)((state) => state.helpers(context.formId).setTouched);
116
+ };
117
+ exports.useSetTouched = useSetTouched;
@@ -0,0 +1,14 @@
1
+ /**
2
+ * The purpose of this type is to simplify the logic
3
+ * around data that needs to come from the server initially,
4
+ * but from the internal state after hydration.
5
+ */
6
+ export declare type Hydratable<T> = {
7
+ hydrateTo: (data: T) => T;
8
+ map: <U>(fn: (data: T) => U) => Hydratable<U>;
9
+ };
10
+ export declare const hydratable: {
11
+ serverData: <T>(data: T) => Hydratable<T>;
12
+ hydratedData: <T_1>() => Hydratable<T_1>;
13
+ from: <T_2>(data: T_2, hydrated: boolean) => Hydratable<T_2>;
14
+ };
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.hydratable = void 0;
4
+ const serverData = (data) => ({
5
+ hydrateTo: () => data,
6
+ map: (fn) => serverData(fn(data)),
7
+ });
8
+ const hydratedData = () => ({
9
+ hydrateTo: (hydratedData) => hydratedData,
10
+ map: () => hydratedData(),
11
+ });
12
+ const from = (data, hydrated) => hydrated ? hydratedData() : serverData(data);
13
+ exports.hydratable = {
14
+ serverData,
15
+ hydratedData,
16
+ from,
17
+ };
@@ -0,0 +1,6 @@
1
+ import { Draft } from "immer";
2
+ import { State, StateCreator } from "zustand";
3
+ declare type TImmerConfigFn<T extends State> = (partial: ((draft: Draft<T>) => void) | T, replace?: boolean) => void;
4
+ declare type TImmerConfig<T extends State> = StateCreator<T, TImmerConfigFn<T>>;
5
+ export declare const immer: <T extends object>(config: TImmerConfig<T>) => StateCreator<T, import("zustand").SetState<T>, import("zustand").GetState<T>, import("zustand").StoreApi<T>>;
6
+ export {};
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.immer = void 0;
7
+ const immer_1 = __importDefault(require("immer"));
8
+ const immer = (config) => (set, get, api) => config((partial, replace) => {
9
+ const nextState = typeof partial === "function"
10
+ ? (0, immer_1.default)(partial)
11
+ : partial;
12
+ return set(nextState, replace);
13
+ }, get, api);
14
+ exports.immer = immer;
@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getCheckboxChecked = void 0;
4
4
  const getCheckboxChecked = (checkboxValue = "on", newValue) => {
5
5
  if (Array.isArray(newValue))
6
- return newValue.includes(checkboxValue);
6
+ return newValue.some((val) => val === true || val === checkboxValue);
7
7
  if (typeof newValue === "boolean")
8
8
  return newValue;
9
9
  if (typeof newValue === "string")
@@ -17,17 +17,17 @@ const setElementValue = (element, value, name) => {
17
17
  }
18
18
  if (element instanceof HTMLInputElement && element.type === "checkbox") {
19
19
  const newChecked = (0, getCheckboxChecked_1.getCheckboxChecked)(element.value, value);
20
- (0, tiny_invariant_1.default)(newChecked, `Unable to determine if checkbox should be checked. Provided value was ${value} for checkbox ${name}.`);
20
+ (0, tiny_invariant_1.default)(newChecked !== undefined, `Unable to determine if checkbox should be checked. Provided value was ${value} for checkbox ${name}.`);
21
21
  element.checked = newChecked;
22
22
  return;
23
23
  }
24
24
  if (element instanceof HTMLInputElement && element.type === "radio") {
25
25
  const newChecked = (0, getRadioChecked_1.getRadioChecked)(element.value, value);
26
- (0, tiny_invariant_1.default)(newChecked, `Unable to determine if radio should be checked. Provided value was ${value} for radio ${name}.`);
26
+ (0, tiny_invariant_1.default)(newChecked !== undefined, `Unable to determine if radio should be checked. Provided value was ${value} for radio ${name}.`);
27
27
  element.checked = newChecked;
28
28
  return;
29
29
  }
30
- (0, tiny_invariant_1.default)(typeof value === "string", `Must specify a string to set the value of ${element.constructor.name}`);
30
+ (0, tiny_invariant_1.default)(typeof value === "string", `Invalid value for field "${name}" which is an ${element.constructor.name}. Expected string but received ${typeof value}`);
31
31
  const input = element;
32
32
  input.value = value;
33
33
  };
@@ -0,0 +1 @@
1
+ export declare const setInputValueInForm: (formElement: HTMLFormElement, name: string, value: unknown[]) => void;
@@ -0,0 +1,127 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.setInputValueInForm = void 0;
7
+ const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
8
+ const getCheckboxChecked_1 = require("./getCheckboxChecked");
9
+ /**
10
+ * Helper class to track the values being set on uncontrolled fields.
11
+ * HTML is super permissive with inputs that all share the same `name`.
12
+ *
13
+ * This class is strict in the sense that, if the user provides an array value,
14
+ * the values inside the array must be in the same order as the elements in the DOM.
15
+ * Doing this allows us to be flexible with what types of form controls the user is using.
16
+ *
17
+ * This is how HTML tracks inputs of the same name as well.
18
+ * `new FormData(formElement).getAll('myField')` will return values in DOM order.
19
+ */
20
+ class Values {
21
+ constructor(values) {
22
+ this.hasSetRadioValue = false;
23
+ this.bool = (value) => {
24
+ if ((0, getCheckboxChecked_1.getCheckboxChecked)(value, this.values[0])) {
25
+ this.values.shift();
26
+ return true;
27
+ }
28
+ return false;
29
+ };
30
+ this.radio = (value) => {
31
+ if (this.hasSetRadioValue)
32
+ return false;
33
+ const result = this.bool(value);
34
+ if (result)
35
+ this.hasSetRadioValue = true;
36
+ return result;
37
+ };
38
+ this.str = () => { var _a; return String((_a = this.values.pop()) !== null && _a !== void 0 ? _a : ""); };
39
+ this.allValues = () => this.values;
40
+ this.warnIfLeftovers = (field) => {
41
+ if (this.values.length > 0) {
42
+ console.warn(`Could not determine how to use the value for the field ${field}. ` +
43
+ `Leftover values were: ${this.values.join(", ")}.`);
44
+ }
45
+ };
46
+ const unknownValues = Array.isArray(values) ? values : [values];
47
+ this.values = unknownValues;
48
+ }
49
+ }
50
+ /**
51
+ * This subclass is order-permissive, meaning the user doesn't have to worry about
52
+ * the order in which the inputs occur in the DOM.
53
+ * This is useful for multiselects and checkbox groups and provides a better DX than
54
+ * the order-strict version.
55
+ */
56
+ class PermissiveValues extends Values {
57
+ constructor() {
58
+ super(...arguments);
59
+ this.remove = (value) => {
60
+ const index = this.values.indexOf(value);
61
+ const deleted = this.values.splice(index, 1);
62
+ return deleted.length > 0;
63
+ };
64
+ this.bool = (value) => {
65
+ if ((0, getCheckboxChecked_1.getCheckboxChecked)(value, this.values)) {
66
+ this.remove(value) || this.remove(true);
67
+ return true;
68
+ }
69
+ return false;
70
+ };
71
+ }
72
+ }
73
+ const isMultiselect = (node) => node instanceof HTMLSelectElement && node.multiple;
74
+ const isCheckbox = (node) => node instanceof HTMLInputElement && node.type === "checkbox";
75
+ const isRadio = (node) => node instanceof HTMLInputElement && node.type === "radio";
76
+ const setElementValue = (element, values, field) => {
77
+ if (isMultiselect(element)) {
78
+ for (const option of element.options) {
79
+ option.selected = values.bool(option.value);
80
+ }
81
+ return;
82
+ }
83
+ if (isCheckbox(element)) {
84
+ element.checked = values.bool(element.value);
85
+ return;
86
+ }
87
+ if (isRadio(element)) {
88
+ element.checked = values.radio(element.value);
89
+ return;
90
+ }
91
+ const input = element;
92
+ (0, tiny_invariant_1.default)(input.type !== "hidden", `Cannot set value on hidden input if it is not a controlled field. Field being updated was ${field}.`);
93
+ input.value = values.str();
94
+ };
95
+ const areElementsTheSameType = (nodes) => {
96
+ const getType = (node) => {
97
+ if (node instanceof HTMLInputElement)
98
+ return node.type;
99
+ if (node instanceof HTMLSelectElement)
100
+ return node.multiple ? "select" : "multiselect";
101
+ return null;
102
+ };
103
+ const firstElementInstance = nodes[0].constructor;
104
+ const firstElementType = getType(nodes[0]);
105
+ return nodes.every((element) => element.constructor === firstElementInstance &&
106
+ getType(element) === firstElementType);
107
+ };
108
+ const setInputValueInForm = (formElement, name, value) => {
109
+ const controlElement = formElement.elements.namedItem(name);
110
+ if (!controlElement)
111
+ return;
112
+ if (controlElement instanceof RadioNodeList) {
113
+ const values = areElementsTheSameType([...controlElement])
114
+ ? new PermissiveValues(value)
115
+ : new Values(value);
116
+ for (const element of controlElement) {
117
+ setElementValue(element, values, name);
118
+ }
119
+ values.warnIfLeftovers(name);
120
+ }
121
+ else {
122
+ const values = new PermissiveValues(value);
123
+ setElementValue(controlElement, values, name);
124
+ values.warnIfLeftovers(name);
125
+ }
126
+ };
127
+ exports.setInputValueInForm = setInputValueInForm;
@@ -0,0 +1,2 @@
1
+ import { InternalFormId } from "./state/atomUtils";
2
+ export declare const useSetFormValues: (formId: InternalFormId) => (arg: Record<string, unknown>) => Promise<void>;
@@ -0,0 +1,33 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.useSetFormValues = void 0;
7
+ const utils_1 = require("jotai/utils");
8
+ const react_1 = require("react");
9
+ const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
10
+ const setInputValueInForm_1 = require("./logic/setInputValueInForm");
11
+ const state_1 = require("./state");
12
+ const controlledFields_1 = require("./state/controlledFields");
13
+ const useSetFormValues = (formId) => (0, utils_1.useAtomCallback)((0, react_1.useCallback)(async (get, set, updatedValues) => {
14
+ const form = get((0, state_1.formElementAtom)(formId));
15
+ (0, tiny_invariant_1.default)(form, "Unable to access form element when setting field value. This is likely a bug in remix-validated-form.");
16
+ const controlledFields = get((0, controlledFields_1.controlledFieldsAtom)(formId));
17
+ const updatePromises = [];
18
+ for (const [field, value] of Object.entries(updatedValues)) {
19
+ const isControlled = !!controlledFields[field];
20
+ if (isControlled) {
21
+ updatePromises.push(set(controlledFields_1.setControlledFieldValueAtom, {
22
+ field,
23
+ formId,
24
+ value,
25
+ }));
26
+ }
27
+ else {
28
+ (0, setInputValueInForm_1.setInputValueInForm)(form, field, Array.isArray(value) ? value : [value]);
29
+ }
30
+ }
31
+ await Promise.all(updatePromises);
32
+ }, [formId]), state_1.ATOM_SCOPE);
33
+ exports.useSetFormValues = useSetFormValues;
@@ -0,0 +1,38 @@
1
+ import { Atom } from "jotai";
2
+ export declare type InternalFormId = string | symbol;
3
+ export declare const formAtomFamily: <T>(data: T) => {
4
+ (param: InternalFormId): Atom<T> & {
5
+ write: (get: {
6
+ <Value>(atom: Atom<Value | Promise<Value>>): Value;
7
+ <Value_1>(atom: Atom<Promise<Value_1>>): Value_1;
8
+ <Value_2>(atom: Atom<Value_2>): Value_2 extends Promise<infer V> ? V : Value_2;
9
+ } & {
10
+ <Value_3>(atom: Atom<Value_3 | Promise<Value_3>>, options: {
11
+ unstable_promise: true;
12
+ }): Value_3 | Promise<Value_3>;
13
+ <Value_4>(atom: Atom<Promise<Value_4>>, options: {
14
+ unstable_promise: true;
15
+ }): Value_4 | Promise<Value_4>;
16
+ <Value_5>(atom: Atom<Value_5>, options: {
17
+ unstable_promise: true;
18
+ }): (Value_5 extends Promise<infer V> ? V : Value_5) | Promise<Value_5 extends Promise<infer V> ? V : Value_5>;
19
+ }, set: {
20
+ <Value_6, Result extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_6, undefined, Result>): Result;
21
+ <Value_7, Update, Result_1 extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_7, Update, Result_1>, update: Update): Result_1;
22
+ }, update: T | ((prev: T) => T)) => void;
23
+ onMount?: (<S extends import("jotai/core/atom").SetAtom<T | ((prev: T) => T), void>>(setAtom: S) => void | (() => void)) | undefined;
24
+ } & {
25
+ init: T;
26
+ };
27
+ remove(param: InternalFormId): void;
28
+ setShouldRemove(shouldRemove: ((createdAt: number, param: InternalFormId) => boolean) | null): void;
29
+ };
30
+ export declare type FieldAtomKey = {
31
+ formId: InternalFormId;
32
+ field: string;
33
+ };
34
+ export declare const fieldAtomFamily: <T extends Atom<unknown>>(func: (key: FieldAtomKey) => T) => {
35
+ (param: FieldAtomKey): T;
36
+ remove(param: FieldAtomKey): void;
37
+ setShouldRemove(shouldRemove: ((createdAt: number, param: FieldAtomKey) => boolean) | null): void;
38
+ };
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.fieldAtomFamily = exports.formAtomFamily = void 0;
7
+ const jotai_1 = require("jotai");
8
+ const utils_1 = require("jotai/utils");
9
+ const isEqual_1 = __importDefault(require("lodash/isEqual"));
10
+ const formAtomFamily = (data) => (0, utils_1.atomFamily)((_) => (0, jotai_1.atom)(data));
11
+ exports.formAtomFamily = formAtomFamily;
12
+ const fieldAtomFamily = (func) => (0, utils_1.atomFamily)(func, isEqual_1.default);
13
+ exports.fieldAtomFamily = fieldAtomFamily;
@@ -0,0 +1,66 @@
1
+ import { PrimitiveAtom } from "jotai";
2
+ import { InternalFormId } from "./atomUtils";
3
+ export declare type ValueSerializer = (val: unknown) => string;
4
+ export declare const controlledFieldsAtom: {
5
+ (param: InternalFormId): import("jotai").Atom<Record<string, PrimitiveAtom<unknown>>> & {
6
+ write: (get: {
7
+ <Value>(atom: import("jotai").Atom<Value | Promise<Value>>): Value;
8
+ <Value_1>(atom: import("jotai").Atom<Promise<Value_1>>): Value_1;
9
+ <Value_2>(atom: import("jotai").Atom<Value_2>): Value_2 extends Promise<infer V> ? V : Value_2;
10
+ } & {
11
+ <Value_3>(atom: import("jotai").Atom<Value_3 | Promise<Value_3>>, options: {
12
+ unstable_promise: true;
13
+ }): Value_3 | Promise<Value_3>;
14
+ <Value_4>(atom: import("jotai").Atom<Promise<Value_4>>, options: {
15
+ unstable_promise: true;
16
+ }): Value_4 | Promise<Value_4>;
17
+ <Value_5>(atom: import("jotai").Atom<Value_5>, options: {
18
+ unstable_promise: true;
19
+ }): (Value_5 extends Promise<infer V> ? V : Value_5) | Promise<Value_5 extends Promise<infer V> ? V : Value_5>;
20
+ }, set: {
21
+ <Value_6, Result extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_6, undefined, Result>): Result;
22
+ <Value_7, Update, Result_1 extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_7, Update, Result_1>, update: Update): Result_1;
23
+ }, update: Record<string, PrimitiveAtom<unknown>> | ((prev: Record<string, PrimitiveAtom<unknown>>) => Record<string, PrimitiveAtom<unknown>>)) => void;
24
+ onMount?: (<S extends (update: Record<string, PrimitiveAtom<unknown>> | ((prev: Record<string, PrimitiveAtom<unknown>>) => Record<string, PrimitiveAtom<unknown>>)) => void>(setAtom: S) => void | (() => void)) | undefined;
25
+ } & {
26
+ init: Record<string, PrimitiveAtom<unknown>>;
27
+ };
28
+ remove(param: InternalFormId): void;
29
+ setShouldRemove(shouldRemove: ((createdAt: number, param: InternalFormId) => boolean) | null): void;
30
+ };
31
+ export declare const setControlledFieldValueAtom: import("jotai").Atom<null> & {
32
+ write: (get: {
33
+ <Value>(atom: import("jotai").Atom<Value | Promise<Value>>): Value;
34
+ <Value_1>(atom: import("jotai").Atom<Promise<Value_1>>): Value_1;
35
+ <Value_2>(atom: import("jotai").Atom<Value_2>): Value_2 extends Promise<infer V> ? V : Value_2;
36
+ } & {
37
+ <Value_3>(atom: import("jotai").Atom<Value_3 | Promise<Value_3>>, options: {
38
+ unstable_promise: true;
39
+ }): Value_3 | Promise<Value_3>;
40
+ <Value_4>(atom: import("jotai").Atom<Promise<Value_4>>, options: {
41
+ unstable_promise: true;
42
+ }): Value_4 | Promise<Value_4>;
43
+ <Value_5>(atom: import("jotai").Atom<Value_5>, options: {
44
+ unstable_promise: true;
45
+ }): (Value_5 extends Promise<infer V> ? V : Value_5) | Promise<Value_5 extends Promise<infer V> ? V : Value_5>;
46
+ }, set: {
47
+ <Value_6, Result extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_6, undefined, Result>): Result;
48
+ <Value_7, Update, Result_1 extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_7, Update, Result_1>, update: Update): Result_1;
49
+ }, update: {
50
+ formId: InternalFormId;
51
+ field: string;
52
+ value: unknown;
53
+ }) => Promise<void>;
54
+ onMount?: (<S extends (update: {
55
+ formId: InternalFormId;
56
+ field: string;
57
+ value: unknown;
58
+ }) => Promise<void>>(setAtom: S) => void | (() => void)) | undefined;
59
+ } & {
60
+ init: null;
61
+ };
62
+ export declare const useAllControlledFields: (formId: InternalFormId) => Record<string, PrimitiveAtom<unknown>>;
63
+ export declare const useControlledFieldValue: (formId: InternalFormId, field: string) => any;
64
+ 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;
@@ -0,0 +1,95 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.useRegisterFieldSerializer = exports.useFieldSerializer = exports.useControllableValue = exports.useControlledFieldValue = exports.useAllControlledFields = exports.setControlledFieldValueAtom = exports.controlledFieldsAtom = void 0;
7
+ const jotai_1 = require("jotai");
8
+ const omit_1 = __importDefault(require("lodash/omit"));
9
+ const react_1 = require("react");
10
+ const hooks_1 = require("../hooks");
11
+ const state_1 = require("../state");
12
+ const atomUtils_1 = require("./atomUtils");
13
+ exports.controlledFieldsAtom = (0, atomUtils_1.formAtomFamily)({});
14
+ const refCountAtom = (0, atomUtils_1.fieldAtomFamily)(() => (0, jotai_1.atom)(0));
15
+ const fieldValueAtom = (0, atomUtils_1.fieldAtomFamily)(() => (0, jotai_1.atom)(undefined));
16
+ const fieldValueHydratedAtom = (0, atomUtils_1.fieldAtomFamily)(() => (0, jotai_1.atom)(false));
17
+ const pendingValidateAtom = (0, atomUtils_1.fieldAtomFamily)(() => (0, jotai_1.atom)(undefined));
18
+ const valueSerializerAtom = (0, atomUtils_1.fieldAtomFamily)(() => (0, jotai_1.atom)({ serializer: JSON.stringify }));
19
+ const registerAtom = (0, jotai_1.atom)(null, (get, set, { formId, field }) => {
20
+ set(refCountAtom({ formId, field }), (prev) => prev + 1);
21
+ const newRefCount = get(refCountAtom({ formId, field }));
22
+ if (newRefCount === 1) {
23
+ set((0, exports.controlledFieldsAtom)(formId), (prev) => ({
24
+ ...prev,
25
+ [field]: fieldValueAtom({ formId, field }),
26
+ }));
27
+ }
28
+ });
29
+ const unregisterAtom = (0, jotai_1.atom)(null, (get, set, { formId, field }) => {
30
+ set(refCountAtom({ formId, field }), (prev) => prev - 1);
31
+ const newRefCount = get(refCountAtom({ formId, field }));
32
+ if (newRefCount === 0) {
33
+ set((0, exports.controlledFieldsAtom)(formId), (prev) => (0, omit_1.default)(prev, field));
34
+ fieldValueAtom.remove({ formId, field });
35
+ pendingValidateAtom.remove({ formId, field });
36
+ }
37
+ });
38
+ exports.setControlledFieldValueAtom = (0, jotai_1.atom)(null, async (_get, set, { formId, field, value, }) => {
39
+ set(fieldValueAtom({ formId, field }), value);
40
+ const pending = pendingValidateAtom({ formId, field });
41
+ await new Promise((resolve) => set(pending, resolve));
42
+ set(pending, undefined);
43
+ });
44
+ const useAllControlledFields = (formId) => (0, hooks_1.useFormAtomValue)((0, exports.controlledFieldsAtom)(formId));
45
+ exports.useAllControlledFields = useAllControlledFields;
46
+ const useControlledFieldValue = (formId, field) => {
47
+ const fieldAtom = fieldValueAtom({ formId, field });
48
+ const [value, setValue] = (0, hooks_1.useFormAtom)(fieldAtom);
49
+ const defaultValue = (0, hooks_1.useFieldDefaultValue)(field, { formId });
50
+ const isHydrated = (0, hooks_1.useFormAtomValue)((0, state_1.isHydratedAtom)(formId));
51
+ const [isFieldHydrated, setIsFieldHydrated] = (0, hooks_1.useFormAtom)(fieldValueHydratedAtom({ formId, field }));
52
+ (0, react_1.useEffect)(() => {
53
+ if (isHydrated && !isFieldHydrated) {
54
+ setValue({ formId, field, value: defaultValue });
55
+ setIsFieldHydrated(true);
56
+ }
57
+ }, [
58
+ defaultValue,
59
+ field,
60
+ formId,
61
+ isFieldHydrated,
62
+ isHydrated,
63
+ setIsFieldHydrated,
64
+ setValue,
65
+ ]);
66
+ return isFieldHydrated ? value : defaultValue;
67
+ };
68
+ exports.useControlledFieldValue = useControlledFieldValue;
69
+ const useControllableValue = (formId, field) => {
70
+ const pending = (0, hooks_1.useFormAtomValue)(pendingValidateAtom({ formId, field }));
71
+ (0, react_1.useEffect)(() => {
72
+ pending === null || pending === void 0 ? void 0 : pending();
73
+ }, [pending]);
74
+ const register = (0, hooks_1.useFormUpdateAtom)(registerAtom);
75
+ const unregister = (0, hooks_1.useFormUpdateAtom)(unregisterAtom);
76
+ (0, react_1.useEffect)(() => {
77
+ register({ formId, field });
78
+ return () => unregister({ formId, field });
79
+ }, [field, formId, register, unregister]);
80
+ const setControlledFieldValue = (0, hooks_1.useFormUpdateAtom)(exports.setControlledFieldValueAtom);
81
+ const setValue = (0, react_1.useCallback)((value) => setControlledFieldValue({ formId, field, value }), [field, formId, setControlledFieldValue]);
82
+ const value = (0, exports.useControlledFieldValue)(formId, field);
83
+ return [value, setValue];
84
+ };
85
+ exports.useControllableValue = useControllableValue;
86
+ const useFieldSerializer = (formId, field) => (0, hooks_1.useFormAtomValue)(valueSerializerAtom({ formId, field })).serializer;
87
+ exports.useFieldSerializer = useFieldSerializer;
88
+ const useRegisterFieldSerializer = (formId, field, serializer) => {
89
+ const setSerializer = (0, hooks_1.useFormUpdateAtom)(valueSerializerAtom({ formId, field }));
90
+ (0, react_1.useEffect)(() => {
91
+ if (serializer)
92
+ setSerializer({ serializer });
93
+ }, [serializer, setSerializer]);
94
+ };
95
+ exports.useRegisterFieldSerializer = useRegisterFieldSerializer;
@@ -0,0 +1,62 @@
1
+ import { FieldErrors, TouchedFields } from "..";
2
+ export declare type InternalFormState = {
3
+ hydrated: boolean;
4
+ fieldErrors: FieldErrors;
5
+ isSubmitting: boolean;
6
+ hasBeenSubmitted: boolean;
7
+ touchedFields: TouchedFields;
8
+ action?: string;
9
+ subaction?: string;
10
+ defaultValues: {
11
+ [fieldName: string]: any;
12
+ };
13
+ validateField: (fieldName: string) => Promise<string | null>;
14
+ registerReceiveFocus: (fieldName: string, handler: () => void) => () => void;
15
+ setFieldValue: (fieldName: string, value: unknown) => void;
16
+ };
17
+ declare type SyncFormArgs = {
18
+ defaultValues?: {
19
+ [fieldName: string]: any;
20
+ };
21
+ action?: string;
22
+ subaction?: string;
23
+ validateField: InternalFormState["validateField"];
24
+ registerReceiveFocus: InternalFormState["registerReceiveFocus"];
25
+ setFieldValueForForm: InternalFormState["setFieldValue"];
26
+ };
27
+ declare type StoreState = {
28
+ forms: {
29
+ [formId: string | symbol]: InternalFormState;
30
+ };
31
+ };
32
+ export declare const state: StoreState;
33
+ export declare const registerFormSlice: (formId: string | symbol, { registerReceiveFocus, setFieldValueForForm, validateField, action, defaultValues, subaction, }: SyncFormArgs) => void;
34
+ export declare const unregisterFormSlice: (formId: string | symbol) => void;
35
+ export declare const useFormData: (formId: string | symbol) => {
36
+ readonly hydrated: boolean;
37
+ readonly fieldErrors: {
38
+ readonly [x: string]: string;
39
+ };
40
+ readonly isSubmitting: boolean;
41
+ readonly hasBeenSubmitted: boolean;
42
+ readonly touchedFields: {
43
+ readonly [x: string]: boolean;
44
+ };
45
+ readonly action?: string | undefined;
46
+ readonly subaction?: string | undefined;
47
+ readonly defaultValues: {
48
+ readonly [x: string]: any;
49
+ };
50
+ readonly validateField: (fieldName: string) => Promise<string | null>;
51
+ readonly registerReceiveFocus: (fieldName: string, handler: () => void) => () => void;
52
+ readonly setFieldValue: (fieldName: string, value: unknown) => void;
53
+ };
54
+ export declare const startSubmit: (formId: string | symbol) => void;
55
+ export declare const endSubmit: (formId: string | symbol) => void;
56
+ export declare const sync: (formId: string | symbol, { defaultValues, action, subaction, registerReceiveFocus, validateField, setFieldValueForForm, }: SyncFormArgs) => void;
57
+ export declare const clearError: (formId: string | symbol, fieldName: string) => void;
58
+ export declare const addError: (formId: string | symbol, fieldName: string, error: string) => void;
59
+ export declare const setTouched: (formId: string | symbol, fieldName: string, touched: boolean) => void;
60
+ export declare const reset: (formId: string | symbol) => void;
61
+ export declare const setFieldErrors: (formId: string | symbol, fieldErrors: FieldErrors) => void;
62
+ export {};