remix-validated-form 4.3.1-beta.0 → 4.4.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 (55) hide show
  1. package/.turbo/turbo-build.log +10 -10
  2. package/browser/ValidatedForm.js +16 -30
  3. package/browser/hooks.d.ts +1 -1
  4. package/browser/hooks.js +10 -9
  5. package/browser/internal/hooks.d.ts +20 -9
  6. package/browser/internal/hooks.js +32 -23
  7. package/browser/internal/logic/getRadioChecked.js +1 -1
  8. package/browser/internal/state/cleanup.d.ts +2 -0
  9. package/browser/internal/state/cleanup.js +6 -0
  10. package/browser/internal/state/controlledFieldStore.d.ts +24 -0
  11. package/browser/internal/state/controlledFieldStore.js +57 -0
  12. package/browser/internal/state/controlledFields.d.ts +3 -116
  13. package/browser/internal/state/controlledFields.js +25 -68
  14. package/browser/internal/state/createFormStore.d.ts +40 -0
  15. package/browser/internal/state/createFormStore.js +83 -0
  16. package/browser/internal/state/storeFamily.d.ts +9 -0
  17. package/browser/internal/state/storeFamily.js +18 -0
  18. package/browser/internal/state/storeHooks.d.ts +5 -0
  19. package/browser/internal/state/storeHooks.js +10 -0
  20. package/browser/unreleased/formStateHooks.d.ts +15 -0
  21. package/browser/unreleased/formStateHooks.js +23 -14
  22. package/browser/userFacingFormContext.d.ts +8 -0
  23. package/browser/userFacingFormContext.js +5 -4
  24. package/dist/remix-validated-form.cjs.js +17 -1
  25. package/dist/remix-validated-form.es.js +1033 -1724
  26. package/dist/remix-validated-form.umd.js +17 -1
  27. package/dist/types/hooks.d.ts +1 -1
  28. package/dist/types/internal/hooks.d.ts +20 -9
  29. package/dist/types/internal/state/cleanup.d.ts +2 -0
  30. package/dist/types/internal/state/controlledFieldStore.d.ts +24 -0
  31. package/dist/types/internal/state/controlledFields.d.ts +3 -116
  32. package/dist/types/internal/state/createFormStore.d.ts +40 -0
  33. package/dist/types/internal/state/storeFamily.d.ts +9 -0
  34. package/dist/types/internal/state/storeHooks.d.ts +5 -0
  35. package/dist/types/unreleased/formStateHooks.d.ts +15 -0
  36. package/dist/types/userFacingFormContext.d.ts +8 -0
  37. package/package.json +4 -3
  38. package/src/ValidatedForm.tsx +25 -47
  39. package/src/hooks.ts +15 -18
  40. package/src/internal/hooks.ts +69 -45
  41. package/src/internal/logic/getRadioChecked.ts +1 -1
  42. package/src/internal/state/cleanup.ts +8 -0
  43. package/src/internal/state/controlledFieldStore.ts +91 -0
  44. package/src/internal/state/controlledFields.ts +31 -123
  45. package/src/internal/state/createFormStore.ts +152 -0
  46. package/src/internal/state/storeFamily.ts +24 -0
  47. package/src/internal/state/storeHooks.ts +22 -0
  48. package/src/unreleased/formStateHooks.ts +50 -27
  49. package/src/userFacingFormContext.ts +17 -5
  50. package/dist/types/internal/reset.d.ts +0 -28
  51. package/dist/types/internal/state/atomUtils.d.ts +0 -38
  52. package/dist/types/internal/state.d.ts +0 -343
  53. package/src/internal/reset.ts +0 -26
  54. package/src/internal/state/atomUtils.ts +0 -13
  55. package/src/internal/state.ts +0 -124
@@ -1,343 +0,0 @@
1
- import { FieldErrors, TouchedFields } from "../validation/types";
2
- import { InternalFormId } from "./state/atomUtils";
3
- export declare const ATOM_SCOPE: unique symbol;
4
- export declare type SyncedFormProps = {
5
- formId?: string;
6
- action?: string;
7
- subaction?: string;
8
- defaultValues: {
9
- [fieldName: string]: any;
10
- };
11
- validateField: (fieldName: string) => Promise<string | null>;
12
- registerReceiveFocus: (fieldName: string, handler: () => void) => () => void;
13
- };
14
- export declare const isHydratedAtom: {
15
- (param: InternalFormId): import("jotai").Atom<boolean> & {
16
- write: (get: {
17
- <Value>(atom: import("jotai").Atom<Value | Promise<Value>>): Value;
18
- <Value_1>(atom: import("jotai").Atom<Promise<Value_1>>): Value_1;
19
- <Value_2>(atom: import("jotai").Atom<Value_2>): Value_2 extends Promise<infer V> ? V : Value_2;
20
- } & {
21
- <Value_3>(atom: import("jotai").Atom<Value_3 | Promise<Value_3>>, options: {
22
- unstable_promise: true;
23
- }): Value_3 | Promise<Value_3>;
24
- <Value_4>(atom: import("jotai").Atom<Promise<Value_4>>, options: {
25
- unstable_promise: true;
26
- }): Value_4 | Promise<Value_4>;
27
- <Value_5>(atom: import("jotai").Atom<Value_5>, options: {
28
- unstable_promise: true;
29
- }): (Value_5 extends Promise<infer V> ? V : Value_5) | Promise<Value_5 extends Promise<infer V> ? V : Value_5>;
30
- }, set: {
31
- <Value_6, Result extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_6, undefined, Result>): Result;
32
- <Value_7, Update, Result_1 extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_7, Update, Result_1>, update: Update): Result_1;
33
- }, update: boolean | ((prev: boolean) => boolean)) => void;
34
- onMount?: (<S extends (update: boolean | ((prev: boolean) => boolean)) => void>(setAtom: S) => void | (() => void)) | undefined;
35
- } & {
36
- init: boolean;
37
- };
38
- remove(param: InternalFormId): void;
39
- setShouldRemove(shouldRemove: ((createdAt: number, param: InternalFormId) => boolean) | null): void;
40
- };
41
- export declare const isSubmittingAtom: {
42
- (param: InternalFormId): import("jotai").Atom<boolean> & {
43
- write: (get: {
44
- <Value>(atom: import("jotai").Atom<Value | Promise<Value>>): Value;
45
- <Value_1>(atom: import("jotai").Atom<Promise<Value_1>>): Value_1;
46
- <Value_2>(atom: import("jotai").Atom<Value_2>): Value_2 extends Promise<infer V> ? V : Value_2;
47
- } & {
48
- <Value_3>(atom: import("jotai").Atom<Value_3 | Promise<Value_3>>, options: {
49
- unstable_promise: true;
50
- }): Value_3 | Promise<Value_3>;
51
- <Value_4>(atom: import("jotai").Atom<Promise<Value_4>>, options: {
52
- unstable_promise: true;
53
- }): Value_4 | Promise<Value_4>;
54
- <Value_5>(atom: import("jotai").Atom<Value_5>, options: {
55
- unstable_promise: true;
56
- }): (Value_5 extends Promise<infer V> ? V : Value_5) | Promise<Value_5 extends Promise<infer V> ? V : Value_5>;
57
- }, set: {
58
- <Value_6, Result extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_6, undefined, Result>): Result;
59
- <Value_7, Update, Result_1 extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_7, Update, Result_1>, update: Update): Result_1;
60
- }, update: boolean | ((prev: boolean) => boolean)) => void;
61
- onMount?: (<S extends (update: boolean | ((prev: boolean) => boolean)) => void>(setAtom: S) => void | (() => void)) | undefined;
62
- } & {
63
- init: boolean;
64
- };
65
- remove(param: InternalFormId): void;
66
- setShouldRemove(shouldRemove: ((createdAt: number, param: InternalFormId) => boolean) | null): void;
67
- };
68
- export declare const hasBeenSubmittedAtom: {
69
- (param: InternalFormId): import("jotai").Atom<boolean> & {
70
- write: (get: {
71
- <Value>(atom: import("jotai").Atom<Value | Promise<Value>>): Value;
72
- <Value_1>(atom: import("jotai").Atom<Promise<Value_1>>): Value_1;
73
- <Value_2>(atom: import("jotai").Atom<Value_2>): Value_2 extends Promise<infer V> ? V : Value_2;
74
- } & {
75
- <Value_3>(atom: import("jotai").Atom<Value_3 | Promise<Value_3>>, options: {
76
- unstable_promise: true;
77
- }): Value_3 | Promise<Value_3>;
78
- <Value_4>(atom: import("jotai").Atom<Promise<Value_4>>, options: {
79
- unstable_promise: true;
80
- }): Value_4 | Promise<Value_4>;
81
- <Value_5>(atom: import("jotai").Atom<Value_5>, options: {
82
- unstable_promise: true;
83
- }): (Value_5 extends Promise<infer V> ? V : Value_5) | Promise<Value_5 extends Promise<infer V> ? V : Value_5>;
84
- }, set: {
85
- <Value_6, Result extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_6, undefined, Result>): Result;
86
- <Value_7, Update, Result_1 extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_7, Update, Result_1>, update: Update): Result_1;
87
- }, update: boolean | ((prev: boolean) => boolean)) => void;
88
- onMount?: (<S extends (update: boolean | ((prev: boolean) => boolean)) => void>(setAtom: S) => void | (() => void)) | undefined;
89
- } & {
90
- init: boolean;
91
- };
92
- remove(param: InternalFormId): void;
93
- setShouldRemove(shouldRemove: ((createdAt: number, param: InternalFormId) => boolean) | null): void;
94
- };
95
- export declare const fieldErrorsAtom: {
96
- (param: InternalFormId): import("jotai").Atom<FieldErrors> & {
97
- write: (get: {
98
- <Value>(atom: import("jotai").Atom<Value | Promise<Value>>): Value;
99
- <Value_1>(atom: import("jotai").Atom<Promise<Value_1>>): Value_1;
100
- <Value_2>(atom: import("jotai").Atom<Value_2>): Value_2 extends Promise<infer V> ? V : Value_2;
101
- } & {
102
- <Value_3>(atom: import("jotai").Atom<Value_3 | Promise<Value_3>>, options: {
103
- unstable_promise: true;
104
- }): Value_3 | Promise<Value_3>;
105
- <Value_4>(atom: import("jotai").Atom<Promise<Value_4>>, options: {
106
- unstable_promise: true;
107
- }): Value_4 | Promise<Value_4>;
108
- <Value_5>(atom: import("jotai").Atom<Value_5>, options: {
109
- unstable_promise: true;
110
- }): (Value_5 extends Promise<infer V> ? V : Value_5) | Promise<Value_5 extends Promise<infer V> ? V : Value_5>;
111
- }, set: {
112
- <Value_6, Result extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_6, undefined, Result>): Result;
113
- <Value_7, Update, Result_1 extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_7, Update, Result_1>, update: Update): Result_1;
114
- }, update: FieldErrors | ((prev: FieldErrors) => FieldErrors)) => void;
115
- onMount?: (<S extends (update: FieldErrors | ((prev: FieldErrors) => FieldErrors)) => void>(setAtom: S) => void | (() => void)) | undefined;
116
- } & {
117
- init: FieldErrors;
118
- };
119
- remove(param: InternalFormId): void;
120
- setShouldRemove(shouldRemove: ((createdAt: number, param: InternalFormId) => boolean) | null): void;
121
- };
122
- export declare const touchedFieldsAtom: {
123
- (param: InternalFormId): import("jotai").Atom<TouchedFields> & {
124
- write: (get: {
125
- <Value>(atom: import("jotai").Atom<Value | Promise<Value>>): Value;
126
- <Value_1>(atom: import("jotai").Atom<Promise<Value_1>>): Value_1;
127
- <Value_2>(atom: import("jotai").Atom<Value_2>): Value_2 extends Promise<infer V> ? V : Value_2;
128
- } & {
129
- <Value_3>(atom: import("jotai").Atom<Value_3 | Promise<Value_3>>, options: {
130
- unstable_promise: true;
131
- }): Value_3 | Promise<Value_3>;
132
- <Value_4>(atom: import("jotai").Atom<Promise<Value_4>>, options: {
133
- unstable_promise: true;
134
- }): Value_4 | Promise<Value_4>;
135
- <Value_5>(atom: import("jotai").Atom<Value_5>, options: {
136
- unstable_promise: true;
137
- }): (Value_5 extends Promise<infer V> ? V : Value_5) | Promise<Value_5 extends Promise<infer V> ? V : Value_5>;
138
- }, set: {
139
- <Value_6, Result extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_6, undefined, Result>): Result;
140
- <Value_7, Update, Result_1 extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_7, Update, Result_1>, update: Update): Result_1;
141
- }, update: TouchedFields | ((prev: TouchedFields) => TouchedFields)) => void;
142
- onMount?: (<S extends (update: TouchedFields | ((prev: TouchedFields) => TouchedFields)) => void>(setAtom: S) => void | (() => void)) | undefined;
143
- } & {
144
- init: TouchedFields;
145
- };
146
- remove(param: InternalFormId): void;
147
- setShouldRemove(shouldRemove: ((createdAt: number, param: InternalFormId) => boolean) | null): void;
148
- };
149
- export declare const formPropsAtom: {
150
- (param: InternalFormId): import("jotai").Atom<SyncedFormProps> & {
151
- write: (get: {
152
- <Value>(atom: import("jotai").Atom<Value | Promise<Value>>): Value;
153
- <Value_1>(atom: import("jotai").Atom<Promise<Value_1>>): Value_1;
154
- <Value_2>(atom: import("jotai").Atom<Value_2>): Value_2 extends Promise<infer V> ? V : Value_2;
155
- } & {
156
- <Value_3>(atom: import("jotai").Atom<Value_3 | Promise<Value_3>>, options: {
157
- unstable_promise: true;
158
- }): Value_3 | Promise<Value_3>;
159
- <Value_4>(atom: import("jotai").Atom<Promise<Value_4>>, options: {
160
- unstable_promise: true;
161
- }): Value_4 | Promise<Value_4>;
162
- <Value_5>(atom: import("jotai").Atom<Value_5>, options: {
163
- unstable_promise: true;
164
- }): (Value_5 extends Promise<infer V> ? V : Value_5) | Promise<Value_5 extends Promise<infer V> ? V : Value_5>;
165
- }, set: {
166
- <Value_6, Result extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_6, undefined, Result>): Result;
167
- <Value_7, Update, Result_1 extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_7, Update, Result_1>, update: Update): Result_1;
168
- }, update: SyncedFormProps | ((prev: SyncedFormProps) => SyncedFormProps)) => void;
169
- onMount?: (<S extends (update: SyncedFormProps | ((prev: SyncedFormProps) => SyncedFormProps)) => void>(setAtom: S) => void | (() => void)) | undefined;
170
- } & {
171
- init: SyncedFormProps;
172
- };
173
- remove(param: InternalFormId): void;
174
- setShouldRemove(shouldRemove: ((createdAt: number, param: InternalFormId) => boolean) | null): void;
175
- };
176
- export declare const formElementAtom: {
177
- (param: InternalFormId): import("jotai").Atom<HTMLFormElement | null> & {
178
- write: (get: {
179
- <Value>(atom: import("jotai").Atom<Value | Promise<Value>>): Value;
180
- <Value_1>(atom: import("jotai").Atom<Promise<Value_1>>): Value_1;
181
- <Value_2>(atom: import("jotai").Atom<Value_2>): Value_2 extends Promise<infer V> ? V : Value_2;
182
- } & {
183
- <Value_3>(atom: import("jotai").Atom<Value_3 | Promise<Value_3>>, options: {
184
- unstable_promise: true;
185
- }): Value_3 | Promise<Value_3>;
186
- <Value_4>(atom: import("jotai").Atom<Promise<Value_4>>, options: {
187
- unstable_promise: true;
188
- }): Value_4 | Promise<Value_4>;
189
- <Value_5>(atom: import("jotai").Atom<Value_5>, options: {
190
- unstable_promise: true;
191
- }): (Value_5 extends Promise<infer V> ? V : Value_5) | Promise<Value_5 extends Promise<infer V> ? V : Value_5>;
192
- }, set: {
193
- <Value_6, Result extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_6, undefined, Result>): Result;
194
- <Value_7, Update, Result_1 extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_7, Update, Result_1>, update: Update): Result_1;
195
- }, update: HTMLFormElement | ((prev: HTMLFormElement | null) => HTMLFormElement | null) | null) => void;
196
- onMount?: (<S extends (update: HTMLFormElement | ((prev: HTMLFormElement | null) => HTMLFormElement | null) | null) => void>(setAtom: S) => void | (() => void)) | undefined;
197
- } & {
198
- init: HTMLFormElement | null;
199
- };
200
- remove(param: InternalFormId): void;
201
- setShouldRemove(shouldRemove: ((createdAt: number, param: InternalFormId) => boolean) | null): void;
202
- };
203
- export declare const cleanupFormState: (formId: InternalFormId) => void;
204
- export declare const isValidAtom: {
205
- (param: InternalFormId): import("jotai").Atom<boolean>;
206
- remove(param: InternalFormId): void;
207
- setShouldRemove(shouldRemove: ((createdAt: number, param: InternalFormId) => boolean) | null): void;
208
- };
209
- export declare const startSubmitAtom: {
210
- (param: InternalFormId): import("jotai").Atom<null> & {
211
- write: (get: {
212
- <Value>(atom: import("jotai").Atom<Value | Promise<Value>>): Value;
213
- <Value_1>(atom: import("jotai").Atom<Promise<Value_1>>): Value_1;
214
- <Value_2>(atom: import("jotai").Atom<Value_2>): Value_2 extends Promise<infer V> ? V : Value_2;
215
- } & {
216
- <Value_3>(atom: import("jotai").Atom<Value_3 | Promise<Value_3>>, options: {
217
- unstable_promise: true;
218
- }): Value_3 | Promise<Value_3>;
219
- <Value_4>(atom: import("jotai").Atom<Promise<Value_4>>, options: {
220
- unstable_promise: true;
221
- }): Value_4 | Promise<Value_4>;
222
- <Value_5>(atom: import("jotai").Atom<Value_5>, options: {
223
- unstable_promise: true;
224
- }): (Value_5 extends Promise<infer V> ? V : Value_5) | Promise<Value_5 extends Promise<infer V> ? V : Value_5>;
225
- }, set: {
226
- <Value_6, Result extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_6, undefined, Result>): Result;
227
- <Value_7, Update, Result_1 extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_7, Update, Result_1>, update: Update): Result_1;
228
- }, update: unknown) => void;
229
- onMount?: (<S extends (update?: unknown) => void>(setAtom: S) => void | (() => void)) | undefined;
230
- } & {
231
- init: null;
232
- };
233
- remove(param: InternalFormId): void;
234
- setShouldRemove(shouldRemove: ((createdAt: number, param: InternalFormId) => boolean) | null): void;
235
- };
236
- export declare const endSubmitAtom: {
237
- (param: InternalFormId): import("jotai").Atom<null> & {
238
- write: (get: {
239
- <Value>(atom: import("jotai").Atom<Value | Promise<Value>>): Value;
240
- <Value_1>(atom: import("jotai").Atom<Promise<Value_1>>): Value_1;
241
- <Value_2>(atom: import("jotai").Atom<Value_2>): Value_2 extends Promise<infer V> ? V : Value_2;
242
- } & {
243
- <Value_3>(atom: import("jotai").Atom<Value_3 | Promise<Value_3>>, options: {
244
- unstable_promise: true;
245
- }): Value_3 | Promise<Value_3>;
246
- <Value_4>(atom: import("jotai").Atom<Promise<Value_4>>, options: {
247
- unstable_promise: true;
248
- }): Value_4 | Promise<Value_4>;
249
- <Value_5>(atom: import("jotai").Atom<Value_5>, options: {
250
- unstable_promise: true;
251
- }): (Value_5 extends Promise<infer V> ? V : Value_5) | Promise<Value_5 extends Promise<infer V> ? V : Value_5>;
252
- }, set: {
253
- <Value_6, Result extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_6, undefined, Result>): Result;
254
- <Value_7, Update, Result_1 extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_7, Update, Result_1>, update: Update): Result_1;
255
- }, update: unknown) => void;
256
- onMount?: (<S extends (update?: unknown) => void>(setAtom: S) => void | (() => void)) | undefined;
257
- } & {
258
- init: null;
259
- };
260
- remove(param: InternalFormId): void;
261
- setShouldRemove(shouldRemove: ((createdAt: number, param: InternalFormId) => boolean) | null): void;
262
- };
263
- export declare const setTouchedAtom: {
264
- (param: InternalFormId): import("jotai").Atom<null> & {
265
- write: (get: {
266
- <Value>(atom: import("jotai").Atom<Value | Promise<Value>>): Value;
267
- <Value_1>(atom: import("jotai").Atom<Promise<Value_1>>): Value_1;
268
- <Value_2>(atom: import("jotai").Atom<Value_2>): Value_2 extends Promise<infer V> ? V : Value_2;
269
- } & {
270
- <Value_3>(atom: import("jotai").Atom<Value_3 | Promise<Value_3>>, options: {
271
- unstable_promise: true;
272
- }): Value_3 | Promise<Value_3>;
273
- <Value_4>(atom: import("jotai").Atom<Promise<Value_4>>, options: {
274
- unstable_promise: true;
275
- }): Value_4 | Promise<Value_4>;
276
- <Value_5>(atom: import("jotai").Atom<Value_5>, options: {
277
- unstable_promise: true;
278
- }): (Value_5 extends Promise<infer V> ? V : Value_5) | Promise<Value_5 extends Promise<infer V> ? V : Value_5>;
279
- }, set: {
280
- <Value_6, Result extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_6, undefined, Result>): Result;
281
- <Value_7, Update, Result_1 extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_7, Update, Result_1>, update: Update): Result_1;
282
- }, update: {
283
- field: string;
284
- touched: boolean;
285
- }) => void;
286
- onMount?: (<S extends (update: {
287
- field: string;
288
- touched: boolean;
289
- }) => void>(setAtom: S) => void | (() => void)) | undefined;
290
- } & {
291
- init: null;
292
- };
293
- remove(param: InternalFormId): void;
294
- setShouldRemove(shouldRemove: ((createdAt: number, param: InternalFormId) => boolean) | null): void;
295
- };
296
- export declare const setFieldErrorAtom: {
297
- (param: InternalFormId): import("jotai").Atom<null> & {
298
- write: (get: {
299
- <Value>(atom: import("jotai").Atom<Value | Promise<Value>>): Value;
300
- <Value_1>(atom: import("jotai").Atom<Promise<Value_1>>): Value_1;
301
- <Value_2>(atom: import("jotai").Atom<Value_2>): Value_2 extends Promise<infer V> ? V : Value_2;
302
- } & {
303
- <Value_3>(atom: import("jotai").Atom<Value_3 | Promise<Value_3>>, options: {
304
- unstable_promise: true;
305
- }): Value_3 | Promise<Value_3>;
306
- <Value_4>(atom: import("jotai").Atom<Promise<Value_4>>, options: {
307
- unstable_promise: true;
308
- }): Value_4 | Promise<Value_4>;
309
- <Value_5>(atom: import("jotai").Atom<Value_5>, options: {
310
- unstable_promise: true;
311
- }): (Value_5 extends Promise<infer V> ? V : Value_5) | Promise<Value_5 extends Promise<infer V> ? V : Value_5>;
312
- }, set: {
313
- <Value_6, Result extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_6, undefined, Result>): Result;
314
- <Value_7, Update, Result_1 extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_7, Update, Result_1>, update: Update): Result_1;
315
- }, update: {
316
- field: string;
317
- error: string | undefined;
318
- }) => void;
319
- onMount?: (<S extends (update: {
320
- field: string;
321
- error: string | undefined;
322
- }) => void>(setAtom: S) => void | (() => void)) | undefined;
323
- } & {
324
- init: null;
325
- };
326
- remove(param: InternalFormId): void;
327
- setShouldRemove(shouldRemove: ((createdAt: number, param: InternalFormId) => boolean) | null): void;
328
- };
329
- export declare const fieldTouchedAtom: {
330
- (param: import("./state/atomUtils").FieldAtomKey): import("jotai").WritableAtom<boolean, boolean, void>;
331
- remove(param: import("./state/atomUtils").FieldAtomKey): void;
332
- setShouldRemove(shouldRemove: ((createdAt: number, param: import("./state/atomUtils").FieldAtomKey) => boolean) | null): void;
333
- };
334
- export declare const fieldErrorAtom: {
335
- (param: import("./state/atomUtils").FieldAtomKey): import("jotai").WritableAtom<string, string | undefined, void>;
336
- remove(param: import("./state/atomUtils").FieldAtomKey): void;
337
- setShouldRemove(shouldRemove: ((createdAt: number, param: import("./state/atomUtils").FieldAtomKey) => boolean) | null): void;
338
- };
339
- export declare const fieldDefaultValueAtom: {
340
- (param: import("./state/atomUtils").FieldAtomKey): import("jotai").Atom<any>;
341
- remove(param: import("./state/atomUtils").FieldAtomKey): void;
342
- setShouldRemove(shouldRemove: ((createdAt: number, param: import("./state/atomUtils").FieldAtomKey) => boolean) | null): void;
343
- };
@@ -1,26 +0,0 @@
1
- import { atom } from "jotai";
2
- import { atomFamily } from "jotai/utils";
3
- import lodashGet from "lodash/get";
4
- import {
5
- fieldErrorsAtom,
6
- formPropsAtom,
7
- hasBeenSubmittedAtom,
8
- touchedFieldsAtom,
9
- } from "./state";
10
- import { InternalFormId } from "./state/atomUtils";
11
- import { controlledFieldsAtom } from "./state/controlledFields";
12
-
13
- export const resetAtom = atomFamily((formId: InternalFormId) =>
14
- atom(null, (get, set) => {
15
- set(fieldErrorsAtom(formId), {});
16
- set(touchedFieldsAtom(formId), {});
17
- set(hasBeenSubmittedAtom(formId), false);
18
-
19
- const { defaultValues } = get(formPropsAtom(formId));
20
-
21
- const controlledFields = get(controlledFieldsAtom(formId));
22
- Object.entries(controlledFields).forEach(([name, atom]) =>
23
- set(atom, lodashGet(defaultValues, name))
24
- );
25
- })
26
- );
@@ -1,13 +0,0 @@
1
- import { Atom, atom } from "jotai";
2
- import { atomFamily } from "jotai/utils";
3
- import isEqual from "lodash/isEqual";
4
-
5
- export type InternalFormId = string | symbol;
6
-
7
- export const formAtomFamily = <T>(data: T) =>
8
- atomFamily((_: InternalFormId) => atom(data));
9
-
10
- export type FieldAtomKey = { formId: InternalFormId; field: string };
11
- export const fieldAtomFamily = <T extends Atom<unknown>>(
12
- func: (key: FieldAtomKey) => T
13
- ) => atomFamily(func, isEqual);
@@ -1,124 +0,0 @@
1
- import { atom } from "jotai";
2
- import { atomFamily, selectAtom } from "jotai/utils";
3
- import omit from "lodash/omit";
4
- import { FieldErrors, TouchedFields } from "../validation/types";
5
- import {
6
- fieldAtomFamily,
7
- formAtomFamily,
8
- InternalFormId,
9
- } from "./state/atomUtils";
10
-
11
- export const ATOM_SCOPE = Symbol("remix-validated-form-scope");
12
-
13
- export type SyncedFormProps = {
14
- formId?: string;
15
- action?: string;
16
- subaction?: string;
17
- defaultValues: { [fieldName: string]: any };
18
- validateField: (fieldName: string) => Promise<string | null>;
19
- registerReceiveFocus: (fieldName: string, handler: () => void) => () => void;
20
- };
21
-
22
- export const isHydratedAtom = formAtomFamily(false);
23
- export const isSubmittingAtom = formAtomFamily(false);
24
- export const hasBeenSubmittedAtom = formAtomFamily(false);
25
- export const fieldErrorsAtom = formAtomFamily<FieldErrors>({});
26
- export const touchedFieldsAtom = formAtomFamily<TouchedFields>({});
27
- export const formPropsAtom = formAtomFamily<SyncedFormProps>({
28
- validateField: () => Promise.resolve(null),
29
- registerReceiveFocus: () => () => {},
30
- defaultValues: {},
31
- });
32
- export const formElementAtom = formAtomFamily<HTMLFormElement | null>(null);
33
-
34
- //// Everything below is derived from the above
35
-
36
- export const cleanupFormState = (formId: InternalFormId) => {
37
- [
38
- isHydratedAtom,
39
- isSubmittingAtom,
40
- hasBeenSubmittedAtom,
41
- fieldErrorsAtom,
42
- touchedFieldsAtom,
43
- formPropsAtom,
44
- ].forEach((formAtom) => formAtom.remove(formId));
45
- };
46
-
47
- export const isValidAtom = atomFamily((formId: InternalFormId) =>
48
- atom((get) => Object.keys(get(fieldErrorsAtom(formId))).length === 0)
49
- );
50
-
51
- export const startSubmitAtom = atomFamily((formId: InternalFormId) =>
52
- atom(null, (_get, set) => {
53
- set(isSubmittingAtom(formId), true);
54
- set(hasBeenSubmittedAtom(formId), true);
55
- })
56
- );
57
-
58
- export const endSubmitAtom = atomFamily((formId: InternalFormId) =>
59
- atom(null, (_get, set) => {
60
- set(isSubmittingAtom(formId), false);
61
- })
62
- );
63
-
64
- export const setTouchedAtom = atomFamily((formId: InternalFormId) =>
65
- atom(
66
- null,
67
- (get, set, { field, touched }: { field: string; touched: boolean }) => {
68
- const prev = get(touchedFieldsAtom(formId));
69
- if (prev[field] !== touched) {
70
- set(touchedFieldsAtom(formId), {
71
- ...prev,
72
- [field]: touched,
73
- });
74
- }
75
- }
76
- )
77
- );
78
-
79
- export const setFieldErrorAtom = atomFamily((formId: InternalFormId) =>
80
- atom(
81
- null,
82
- (
83
- get,
84
- set,
85
- { field, error }: { field: string; error: string | undefined }
86
- ) => {
87
- const prev = get(fieldErrorsAtom(formId));
88
- if (error === undefined && field in prev) {
89
- set(fieldErrorsAtom(formId), omit(prev, field));
90
- }
91
-
92
- if (error !== undefined && prev[field] !== error) {
93
- set(fieldErrorsAtom(formId), {
94
- ...get(fieldErrorsAtom(formId)),
95
- [field]: error,
96
- });
97
- }
98
- }
99
- )
100
- );
101
-
102
- //// Field specific
103
-
104
- export const fieldTouchedAtom = fieldAtomFamily(({ formId, field }) =>
105
- atom(
106
- (get) => get(touchedFieldsAtom(formId))[field],
107
- (_get, set, touched: boolean) => {
108
- set(setTouchedAtom(formId), { field, touched });
109
- }
110
- )
111
- );
112
-
113
- export const fieldErrorAtom = fieldAtomFamily(({ formId, field }) =>
114
- atom(
115
- (get) => get(fieldErrorsAtom(formId))[field],
116
- (_get, set, error: string | undefined) => {
117
- set(setFieldErrorAtom(formId), { field, error });
118
- }
119
- )
120
- );
121
-
122
- export const fieldDefaultValueAtom = fieldAtomFamily(({ formId, field }) =>
123
- selectAtom(formPropsAtom(formId), (state) => state.defaultValues[field])
124
- );