@paragrav/rhf-utils 0.1.0 → 0.60.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 (213) hide show
  1. package/README.md +260 -121
  2. package/dist/dts/Register.d.ts +16 -0
  3. package/dist/dts/_exports/config.d.ts +2 -0
  4. package/dist/dts/_exports/errors.d.ts +3 -0
  5. package/dist/dts/_exports/form.d.ts +7 -0
  6. package/dist/dts/_exports/index.d.ts +14 -0
  7. package/dist/dts/_exports/relay.d.ts +8 -0
  8. package/dist/dts/_exports/submit.d.ts +4 -0
  9. package/dist/dts/_exports/trpc.d.ts +2 -0
  10. package/dist/dts/_exports/types.d.ts +6 -0
  11. package/dist/dts/_exports/zod.d.ts +6 -0
  12. package/dist/dts/client/config/RhfUtilsClientConfigType.d.ts +63 -0
  13. package/dist/dts/client/config/context/RhfUtilsClientConfigContext.d.ts +3 -0
  14. package/dist/dts/client/config/context/RhfUtilsClientConfigProvider.d.ts +7 -0
  15. package/dist/dts/client/config/context/useRhfUtilsClientConfig.d.ts +1 -0
  16. package/dist/{types → dts}/devtool/LazyDevTool.d.ts +3 -4
  17. package/dist/dts/devtool/LazyDevToolViaProviders.d.ts +1 -0
  18. package/dist/{types → dts}/errors/flat/FlatFieldErrorsList.d.ts +2 -2
  19. package/dist/{types → dts}/errors/flat/context/FlatFieldErrorsContextProvider.d.ts +3 -3
  20. package/dist/{types → dts}/errors/flat/context/useFlatFieldErrorsContext.d.ts +1 -2
  21. package/dist/dts/errors/flat/context/useFlatFieldErrorsContextHasOnlyOrphans.d.ts +6 -0
  22. package/dist/{types → dts}/errors/flat/context/useFlatFieldErrorsContextOutput.d.ts +1 -2
  23. package/dist/dts/errors/flat/filterFlatFieldErrors.d.ts +7 -0
  24. package/dist/{types → dts}/errors/flat/flattenFieldErrors.d.ts +1 -2
  25. package/dist/{types → dts}/errors/flat/getFlatFieldErrors.d.ts +2 -1
  26. package/dist/dts/errors/getRefdFromFlatFieldErrors.d.ts +1 -0
  27. package/dist/{types → dts}/errors/isFieldErrorRefd.d.ts +1 -2
  28. package/dist/dts/errors/isFlatFieldErrorEntryRefd.d.ts +5 -0
  29. package/dist/{types → dts}/errors/message/FormErrorMessage.d.ts +2 -2
  30. package/dist/{types → dts}/errors/message/RhfUtilsFieldErrorMessage.d.ts +2 -2
  31. package/dist/{types → dts}/errors/nonfield/RhfUtilsNonFieldErrorMarker.d.ts +2 -2
  32. package/dist/dts/errors/nonfield/RhfUtilsNonFieldErrorMarkerHtmlAttribute.d.ts +4 -0
  33. package/dist/{types → dts}/errors/nonfield/isNonFieldError.d.ts +1 -2
  34. package/dist/dts/errors/nonfield/isNonFieldErrorMarkerInDOM.d.ts +5 -0
  35. package/dist/dts/errors/orphan/getIsOrphanFormErrorWithParentElement.d.ts +5 -0
  36. package/dist/dts/errors/orphan/getOrphansFromFlatFieldErrors.d.ts +2 -0
  37. package/dist/dts/errors/orphan/isOrphanFormError.d.ts +2 -0
  38. package/dist/dts/errors/output/consoleErrors.d.ts +5 -0
  39. package/dist/dts/errors/root/RootErrorsListFromFlatFieldErrorsContext.d.ts +1 -0
  40. package/dist/dts/errors/root/getRootsFromFlatFieldErrors.d.ts +1 -0
  41. package/dist/{types → dts}/errors/root/isFlatFieldErrorEntryPathRoot.d.ts +1 -2
  42. package/dist/{types → dts}/errors/root/isFormErrorPathRoot.d.ts +1 -2
  43. package/dist/{types → dts}/errors/trpc/makeOnSubmitTrpcClientErrorHandler.d.ts +2 -3
  44. package/dist/dts/errors/trpc/trpcClientErrorMessageSchema.d.ts +19 -0
  45. package/dist/dts/errors/trpc/trpcClientErrorToFormSubmitFieldErrorsSchemaTransformer.d.ts +23 -0
  46. package/dist/dts/form/RHF_UseFormReturnWithoutProxiesType.d.ts +15 -0
  47. package/dist/dts/form/RhfUtilsFormComponentPropsType.d.ts +17 -0
  48. package/dist/dts/form/RhfUtilsFormStateWithUtilsType.d.ts +7 -0
  49. package/dist/dts/form/UseRhfUtilsFormChildrenPropsType.d.ts +25 -0
  50. package/dist/dts/form/_Controller.d.ts +4 -0
  51. package/dist/dts/form/context/utils/RhfUtilsContextPropsType.d.ts +11 -0
  52. package/dist/dts/form/context/utils/RhfUtilsContextProvider.d.ts +9 -0
  53. package/dist/dts/form/context/utils/useRhfUtilsContext.d.ts +5 -0
  54. package/dist/dts/form/context/utils/useRhfUtilsContextRequestSubmit.d.ts +4 -0
  55. package/dist/dts/form/defaults/UseRhfUtilsFormGlobalDefaults.d.ts +24 -0
  56. package/dist/dts/form/defaults/UseRhfUtilsFormInstanceDefaults.d.ts +18 -0
  57. package/dist/dts/form/defaults/UseRhfUtilsFormResolvedDefaultsType.d.ts +12 -0
  58. package/dist/dts/form/defaults/form/UseRhfUtilsFormInstanceFormProps.d.ts +6 -0
  59. package/dist/dts/form/defaults/form/getRhfUtilsFormResolvedFormProps.d.ts +2 -0
  60. package/dist/dts/form/defaults/form/useRhfUtilsFormResolvedFormProps.d.ts +293 -0
  61. package/dist/{types/form/RhfUtilsFormOptions.d.ts → dts/form/options/RhfUtilsFormOptionsType.d.ts} +6 -7
  62. package/dist/dts/form/options/getRhfUtilsFormResolvedOptions.d.ts +2 -0
  63. package/dist/dts/form/options/useRhfUtilsFormResolvedOptions.d.ts +8 -0
  64. package/dist/dts/form/providers/RhfUtilsFormProviders.d.ts +6 -0
  65. package/dist/dts/form/providers/RhfUtilsFormProvidersPropsType.d.ts +15 -0
  66. package/dist/dts/form/rhf/UseFormPropsType.d.ts +4 -0
  67. package/dist/dts/form/rhf/getRhfUtilsFormResolvedRhfProps.d.ts +4 -0
  68. package/dist/dts/form/rhf/useRhfFormWithResolvedProps.d.ts +5 -0
  69. package/dist/dts/form/state/relay/FormStateRelayContextProvider.d.ts +4 -0
  70. package/dist/dts/form/state/relay/FormStateRelayedAggregatedType.d.ts +10 -0
  71. package/dist/dts/form/state/relay/FormStateRelayedItemType.d.ts +11 -0
  72. package/dist/dts/form/state/relay/FormStateRelayedOptionsType.d.ts +20 -0
  73. package/dist/dts/form/state/relay/FormStateRelayedType.d.ts +3 -0
  74. package/dist/dts/form/state/relay/pull/hooks.d.ts +31 -0
  75. package/dist/dts/form/state/relay/push/FormStateRelayPusher.d.ts +4 -0
  76. package/dist/dts/form/state/relay/push/useFormStateRelayPusher.d.ts +3 -0
  77. package/dist/dts/form/state/relay/useFormStateRelayContext.d.ts +20 -0
  78. package/dist/dts/form/state/relay/utils.d.ts +4 -0
  79. package/dist/dts/form/utils/getSubmitterButtonData.d.ts +6 -0
  80. package/dist/{types → dts}/form/utils/useFormRequestSubmit.d.ts +1 -2
  81. package/dist/dts/form/utils/useHandleCancelWithCheckIfCanBe.d.ts +4 -0
  82. package/dist/dts/form/utils/useHandleCancelWithCheckIfCanBeViaProviders.d.ts +2 -0
  83. package/dist/{types → dts}/form/utils/useShouldFormBlockNavigation.d.ts +1 -2
  84. package/dist/dts/form/with-handlers-and-children/RhfUtilsForm.d.ts +3 -0
  85. package/dist/dts/form/with-handlers-and-children/RhfUtilsFormProps.d.ts +46 -0
  86. package/dist/dts/form/with-handlers-and-children/_ChildrenViaProviders.d.ts +3 -0
  87. package/dist/dts/form/with-handlers-and-children/_FormWithSubmitHandler.d.ts +4 -0
  88. package/dist/dts/form/with-handlers-and-children/_useHandleSubmit.d.ts +11 -0
  89. package/dist/dts/form/with-providers/RhfUtilsFormWithProviders.d.ts +8 -0
  90. package/dist/dts/form/with-providers/RhfUtilsFormWithProvidersProps.d.ts +4 -0
  91. package/dist/dts/resolvers/ObjectSchema.d.ts +7 -0
  92. package/dist/dts/resolvers/zod/RhfUtilsUseZodFormChildrenFCType.d.ts +7 -0
  93. package/dist/dts/resolvers/zod/RhfUtilsUseZodFormChildrenPropsType.d.ts +4 -0
  94. package/dist/dts/resolvers/zod/ZodTypeSafeFieldValuesType.d.ts +5 -0
  95. package/dist/dts/resolvers/zod/consts.d.ts +4 -0
  96. package/dist/dts/resolvers/zod/form/RhfUtilsZodForm.d.ts +7 -0
  97. package/dist/dts/resolvers/zod/getZodResolver.d.ts +4 -0
  98. package/dist/dts/resolvers/zod/providers/RhfUtilsZodFormProviders.d.ts +8 -0
  99. package/dist/dts/resolvers/zod/with-providers/RhfUtilsZodFormWithProviders.d.ts +10 -0
  100. package/dist/dts/submit/UseRhfUtilsFormOnSubmitContextType.d.ts +23 -0
  101. package/dist/dts/submit/error/FormSubmitError.d.ts +6 -0
  102. package/dist/{types → dts}/submit/error/FormSubmitFieldErrors.d.ts +1 -1
  103. package/dist/dts/submit/error/setCtxErrorsByFormSubmitFieldErrors.d.ts +8 -0
  104. package/dist/dts/submit/last-error/LastSubmitErrorContextProvider.d.ts +4 -0
  105. package/dist/dts/submit/last-error/LastSubmitErrorContextType.d.ts +8 -0
  106. package/dist/dts/submit/last-error/useLastSubmitError.d.ts +4 -0
  107. package/dist/dts/submit/last-error/useLastSubmitErrorContext.d.ts +3 -0
  108. package/dist/dts/submit/last-error/useLastSubmitErrorContextWith.d.ts +2 -0
  109. package/dist/{types → dts}/submit/useFormOnSubmitSuccessfulAndReset.d.ts +1 -2
  110. package/dist/dts/submit/useFormOnSubmitted.d.ts +4 -0
  111. package/dist/{types → dts}/submit/useResetFormOnSubmitted.d.ts +1 -2
  112. package/dist/dts/submit/useRhfUtilsFormOnSubmitContext.d.ts +3 -0
  113. package/dist/dts/submit/useSubmitFormOnChange.d.ts +15 -0
  114. package/dist/dts/submit/useSubmitFormOnEvent.d.ts +9 -0
  115. package/dist/dts/submit/useSubmitFormOnWatch.d.ts +14 -0
  116. package/dist/dts/utils/PassthroughChildren.d.ts +7 -0
  117. package/dist/{types → dts}/utils/createContext.d.ts +1 -2
  118. package/dist/dts/utils/fixedForwardRef.d.ts +5 -0
  119. package/dist/dts/utils/isEmptyObject.d.ts +1 -0
  120. package/dist/dts/utils/types.d.ts +3 -0
  121. package/dist/{types → dts}/utils/useImperativeForwardedRef.d.ts +1 -2
  122. package/dist/dts/utils/useIsFirstRender.d.ts +7 -0
  123. package/dist/dts/utils/useRefIfValueWasTrue.d.ts +2 -0
  124. package/dist/dts/utils/useToggle.d.ts +2 -0
  125. package/dist/dts/vite-env.d.ts +1 -0
  126. package/dist/esm/getFlatFieldErrors.mjs +55 -0
  127. package/dist/esm/index.mjs +503 -390
  128. package/dist/esm/relay.mjs +222 -0
  129. package/dist/esm/trpc.mjs +8 -9
  130. package/package.json +91 -72
  131. package/LICENSE.md +0 -21
  132. package/dist/esm/createContext.mjs +0 -16
  133. package/dist/esm/group.mjs +0 -74
  134. package/dist/esm/useFlatFieldErrorsContext.mjs +0 -10
  135. package/dist/esm/utils.mjs +0 -20
  136. package/dist/types/_exports/group.d.ts +0 -9
  137. package/dist/types/_exports/index.d.ts +0 -15
  138. package/dist/types/_exports/trpc.d.ts +0 -2
  139. package/dist/types/_exports/utils.d.ts +0 -1
  140. package/dist/types/client/config/RhfUtilsClientConfig.d.ts +0 -70
  141. package/dist/types/client/config/useRhfUtilsClientConfigContext.d.ts +0 -4
  142. package/dist/types/client/context.d.ts +0 -2
  143. package/dist/types/client/index.d.ts +0 -24
  144. package/dist/types/client/utils.d.ts +0 -12
  145. package/dist/types/client/zod/RhfUtilsUseFormChildrenZodFC.d.ts +0 -12
  146. package/dist/types/client/zod/RhfUtilsUseFormChildrenZodProps.d.ts +0 -4
  147. package/dist/types/client/zod/ZodTypeFieldValues.d.ts +0 -3
  148. package/dist/types/client/zod/consts.d.ts +0 -4
  149. package/dist/types/client/zod/context/RhfUtilsClientForZodContextProvider.d.ts +0 -7
  150. package/dist/types/client/zod/context/RhfUtilsZodForm.d.ts +0 -8
  151. package/dist/types/client/zod/context/useRhfUtilsClientForZodContext.d.ts +0 -5
  152. package/dist/types/client/zod/context/useRhfUtilsZodForm.d.ts +0 -7
  153. package/dist/types/client/zod/createRhfUtilsClientForZod.d.ts +0 -3
  154. package/dist/types/errors/flat/context/useFlatFieldErrorsContextHasOnlyOrphans.d.ts +0 -7
  155. package/dist/types/errors/flat/filterFlatFieldErrors.d.ts +0 -8
  156. package/dist/types/errors/getRefdFromFlatFieldErrors.d.ts +0 -2
  157. package/dist/types/errors/isFlatFieldErrorEntryRefd.d.ts +0 -6
  158. package/dist/types/errors/nonfield/RhfUtilsNonFieldErrorMarkerHtmlAttribute.d.ts +0 -5
  159. package/dist/types/errors/nonfield/isNonFieldErrorMarkerInDOM.d.ts +0 -6
  160. package/dist/types/errors/orphan/getIsOrphanFormErrorWithParentElement.d.ts +0 -6
  161. package/dist/types/errors/orphan/getOrphansFromFlatFieldErrors.d.ts +0 -3
  162. package/dist/types/errors/orphan/isOrphanFormError.d.ts +0 -3
  163. package/dist/types/errors/output/consoleErrors.d.ts +0 -6
  164. package/dist/types/errors/root/RootErrorsListFromFlatFieldErrorsContext.d.ts +0 -2
  165. package/dist/types/errors/root/getRootsFromFlatFieldErrors.d.ts +0 -2
  166. package/dist/types/errors/trpc/trpcClientErrorMessageSchema.d.ts +0 -23
  167. package/dist/types/errors/trpc/trpcClientErrorToFormSubmitFieldErrorsSchemaTransformer.d.ts +0 -27
  168. package/dist/types/form/Form.d.ts +0 -10
  169. package/dist/types/form/FormWithProviders.d.ts +0 -12
  170. package/dist/types/form/RhfUtilsFormProviders.d.ts +0 -11
  171. package/dist/types/form/UseRhfUtilsFormChildrenProps.d.ts +0 -23
  172. package/dist/types/form/UseRhfUtilsFormOnSubmitContext.d.ts +0 -28
  173. package/dist/types/form/UseRhfUtilsFormProps.d.ts +0 -22
  174. package/dist/types/form/UseRhfUtilsFormReturn.d.ts +0 -19
  175. package/dist/types/form/_Controller.d.ts +0 -5
  176. package/dist/types/form/context/group/FormGroupContextProvider.d.ts +0 -4
  177. package/dist/types/form/context/group/index.d.ts +0 -14
  178. package/dist/types/form/context/group/useFormGroupChildIsMountedTracker.d.ts +0 -5
  179. package/dist/types/form/context/group/useFormGroupChildIsSubmittingTracker.d.ts +0 -5
  180. package/dist/types/form/context/group/useFormGroupChildTracker.d.ts +0 -6
  181. package/dist/types/form/context/group/useFormGroupIsAnyBusy.d.ts +0 -2
  182. package/dist/types/form/context/group/useFormGroupIsChildBusy.d.ts +0 -2
  183. package/dist/types/form/context/group/useFormGroupIsParentBusy.d.ts +0 -2
  184. package/dist/types/form/context/group/useFormGroupParentTracker.d.ts +0 -7
  185. package/dist/types/form/context/group/useFormOrParentIsBusy.d.ts +0 -2
  186. package/dist/types/form/context/utils/RhfUtilsContextProvider.d.ts +0 -8
  187. package/dist/types/form/context/utils/useRhfUtilsContext.d.ts +0 -13
  188. package/dist/types/form/context/utils/useRhfUtilsContextRequestSubmit.d.ts +0 -5
  189. package/dist/types/form/useFormIsBusy.d.ts +0 -2
  190. package/dist/types/form/useRhfUtilsForm.d.ts +0 -15
  191. package/dist/types/form/utils/getSubmitterButtonData.d.ts +0 -7
  192. package/dist/types/register.d.ts +0 -7
  193. package/dist/types/submit/error/FormSubmitError.d.ts +0 -6
  194. package/dist/types/submit/error/setCtxErrorsByFormSubmitFieldErrors.d.ts +0 -9
  195. package/dist/types/submit/useFormOnSubmitted.d.ts +0 -5
  196. package/dist/types/submit/useSubmitFormOnChange.d.ts +0 -8
  197. package/dist/types/utils/PassthroughChildren.d.ts +0 -7
  198. package/dist/types/utils/fixedForwardRef.d.ts +0 -6
  199. package/dist/types/utils/isEmptyObject.d.ts +0 -2
  200. package/dist/types/utils/types.d.ts +0 -1
  201. package/dist/types/utils/useRefIfValueWasTrue.d.ts +0 -2
  202. package/dist/types/utils/useThrowAsyncError.d.ts +0 -5
  203. package/dist/types/utils/useToggle.d.ts +0 -3
  204. /package/dist/{types → dts}/errors/flat/context/FlatFieldErrorsOutputConfig.d.ts +0 -0
  205. /package/dist/{types → dts}/errors/flat/types.d.ts +0 -0
  206. /package/dist/{types → dts}/errors/nonfield/RhfUtilsNonFieldErrorMarker.spec.d.ts +0 -0
  207. /package/dist/{types → dts}/errors/nonfield/RhfUtilsNonFieldErrorMarker.utils.d.ts +0 -0
  208. /package/dist/{types → dts}/errors/output/types.d.ts +0 -0
  209. /package/dist/{types → dts}/errors/root/consts.d.ts +0 -0
  210. /package/dist/{types/form/SafeFieldValues.d.ts → dts/form/rhf/SafeFieldValuesType.d.ts} +0 -0
  211. /package/dist/{types → dts}/main.d.ts +0 -0
  212. /package/dist/{types → dts}/utils/timeoutAsync.d.ts +0 -0
  213. /package/dist/{types → dts}/utils/useDebouncedOnChangeValue.d.ts +0 -0
@@ -0,0 +1,293 @@
1
+ import { UseRhfUtilsFormInstanceFormProps } from './UseRhfUtilsFormInstanceFormProps';
2
+ export declare const useRhfUtilsFormResolvedFormProps: (formProps: UseRhfUtilsFormInstanceFormProps | undefined, id: string, surfaced?: {
3
+ className?: string;
4
+ }) => {
5
+ acceptCharset?: string | undefined | undefined;
6
+ action?: string | ((formData: FormData) => void | Promise<void>) | undefined;
7
+ method?: string | undefined | undefined;
8
+ name?: string | undefined | undefined;
9
+ noValidate?: boolean | undefined | undefined;
10
+ rel?: string | undefined | undefined;
11
+ target?: string | undefined | undefined;
12
+ accessKey?: string | undefined | undefined;
13
+ dir?: string | undefined | undefined;
14
+ draggable?: (boolean | "true" | "false") | undefined;
15
+ hidden?: boolean | undefined | undefined;
16
+ inert?: boolean | undefined | undefined;
17
+ lang?: string | undefined | undefined;
18
+ popover?: "" | "auto" | "manual" | "hint" | undefined | undefined;
19
+ title?: string | undefined | undefined;
20
+ translate?: "yes" | "no" | undefined | undefined;
21
+ className?: string | undefined | undefined;
22
+ part?: string | undefined | undefined;
23
+ prefix?: string | undefined | undefined;
24
+ slot?: string | undefined | undefined;
25
+ role?: import('react').AriaRole | undefined;
26
+ children?: import('react').ReactNode;
27
+ style?: import('react').CSSProperties | undefined;
28
+ contentEditable?: (boolean | "true" | "false") | "inherit" | "plaintext-only" | undefined;
29
+ enterKeyHint?: "enter" | "done" | "go" | "next" | "previous" | "search" | "send" | undefined | undefined;
30
+ inputMode?: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefined | undefined;
31
+ nonce?: string | undefined | undefined;
32
+ tabIndex?: number | undefined | undefined;
33
+ onChange?: import('react').FormEventHandler<HTMLFormElement> | undefined;
34
+ onBlur?: import('react').FocusEventHandler<HTMLFormElement> | undefined;
35
+ key?: import('react').Key | null | undefined;
36
+ autoComplete?: string | undefined | undefined;
37
+ encType?: string | undefined | undefined;
38
+ defaultChecked?: boolean | undefined | undefined;
39
+ defaultValue?: string | number | readonly string[] | undefined;
40
+ suppressContentEditableWarning?: boolean | undefined | undefined;
41
+ suppressHydrationWarning?: boolean | undefined | undefined;
42
+ autoCapitalize?: "off" | "none" | "on" | "sentences" | "words" | "characters" | undefined | (string & {}) | undefined;
43
+ autoFocus?: boolean | undefined | undefined;
44
+ contextMenu?: string | undefined | undefined;
45
+ spellCheck?: (boolean | "true" | "false") | undefined;
46
+ radioGroup?: string | undefined | undefined;
47
+ about?: string | undefined | undefined;
48
+ content?: string | undefined | undefined;
49
+ datatype?: string | undefined | undefined;
50
+ inlist?: any;
51
+ property?: string | undefined | undefined;
52
+ resource?: string | undefined | undefined;
53
+ rev?: string | undefined | undefined;
54
+ typeof?: string | undefined | undefined;
55
+ vocab?: string | undefined | undefined;
56
+ autoCorrect?: string | undefined | undefined;
57
+ autoSave?: string | undefined | undefined;
58
+ color?: string | undefined | undefined;
59
+ itemProp?: string | undefined | undefined;
60
+ itemScope?: boolean | undefined | undefined;
61
+ itemType?: string | undefined | undefined;
62
+ itemID?: string | undefined | undefined;
63
+ itemRef?: string | undefined | undefined;
64
+ results?: number | undefined | undefined;
65
+ security?: string | undefined | undefined;
66
+ unselectable?: "on" | "off" | undefined | undefined;
67
+ popoverTargetAction?: "toggle" | "show" | "hide" | undefined | undefined;
68
+ popoverTarget?: string | undefined | undefined;
69
+ is?: string | undefined | undefined;
70
+ exportparts?: string | undefined | undefined;
71
+ "aria-activedescendant"?: string | undefined | undefined;
72
+ "aria-atomic"?: (boolean | "true" | "false") | undefined;
73
+ "aria-autocomplete"?: "none" | "inline" | "list" | "both" | undefined | undefined;
74
+ "aria-braillelabel"?: string | undefined | undefined;
75
+ "aria-brailleroledescription"?: string | undefined | undefined;
76
+ "aria-busy"?: (boolean | "true" | "false") | undefined;
77
+ "aria-checked"?: boolean | "false" | "mixed" | "true" | undefined | undefined;
78
+ "aria-colcount"?: number | undefined | undefined;
79
+ "aria-colindex"?: number | undefined | undefined;
80
+ "aria-colindextext"?: string | undefined | undefined;
81
+ "aria-colspan"?: number | undefined | undefined;
82
+ "aria-controls"?: string | undefined | undefined;
83
+ "aria-current"?: boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time" | undefined | undefined;
84
+ "aria-describedby"?: string | undefined | undefined;
85
+ "aria-description"?: string | undefined | undefined;
86
+ "aria-details"?: string | undefined | undefined;
87
+ "aria-disabled"?: (boolean | "true" | "false") | undefined;
88
+ "aria-dropeffect"?: "none" | "copy" | "execute" | "link" | "move" | "popup" | undefined | undefined;
89
+ "aria-errormessage"?: string | undefined | undefined;
90
+ "aria-expanded"?: (boolean | "true" | "false") | undefined;
91
+ "aria-flowto"?: string | undefined | undefined;
92
+ "aria-grabbed"?: (boolean | "true" | "false") | undefined;
93
+ "aria-haspopup"?: boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog" | undefined | undefined;
94
+ "aria-hidden"?: (boolean | "true" | "false") | undefined;
95
+ "aria-invalid"?: boolean | "false" | "true" | "grammar" | "spelling" | undefined | undefined;
96
+ "aria-keyshortcuts"?: string | undefined | undefined;
97
+ "aria-label"?: string | undefined | undefined;
98
+ "aria-labelledby"?: string | undefined | undefined;
99
+ "aria-level"?: number | undefined | undefined;
100
+ "aria-live"?: "off" | "assertive" | "polite" | undefined | undefined;
101
+ "aria-modal"?: (boolean | "true" | "false") | undefined;
102
+ "aria-multiline"?: (boolean | "true" | "false") | undefined;
103
+ "aria-multiselectable"?: (boolean | "true" | "false") | undefined;
104
+ "aria-orientation"?: "horizontal" | "vertical" | undefined | undefined;
105
+ "aria-owns"?: string | undefined | undefined;
106
+ "aria-placeholder"?: string | undefined | undefined;
107
+ "aria-posinset"?: number | undefined | undefined;
108
+ "aria-pressed"?: boolean | "false" | "mixed" | "true" | undefined | undefined;
109
+ "aria-readonly"?: (boolean | "true" | "false") | undefined;
110
+ "aria-relevant"?: "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals" | undefined | undefined;
111
+ "aria-required"?: (boolean | "true" | "false") | undefined;
112
+ "aria-roledescription"?: string | undefined | undefined;
113
+ "aria-rowcount"?: number | undefined | undefined;
114
+ "aria-rowindex"?: number | undefined | undefined;
115
+ "aria-rowindextext"?: string | undefined | undefined;
116
+ "aria-rowspan"?: number | undefined | undefined;
117
+ "aria-selected"?: (boolean | "true" | "false") | undefined;
118
+ "aria-setsize"?: number | undefined | undefined;
119
+ "aria-sort"?: "none" | "ascending" | "descending" | "other" | undefined | undefined;
120
+ "aria-valuemax"?: number | undefined | undefined;
121
+ "aria-valuemin"?: number | undefined | undefined;
122
+ "aria-valuenow"?: number | undefined | undefined;
123
+ "aria-valuetext"?: string | undefined | undefined;
124
+ dangerouslySetInnerHTML?: {
125
+ __html: string | TrustedHTML;
126
+ } | undefined | undefined;
127
+ onCopy?: import('react').ClipboardEventHandler<HTMLFormElement> | undefined;
128
+ onCopyCapture?: import('react').ClipboardEventHandler<HTMLFormElement> | undefined;
129
+ onCut?: import('react').ClipboardEventHandler<HTMLFormElement> | undefined;
130
+ onCutCapture?: import('react').ClipboardEventHandler<HTMLFormElement> | undefined;
131
+ onPaste?: import('react').ClipboardEventHandler<HTMLFormElement> | undefined;
132
+ onPasteCapture?: import('react').ClipboardEventHandler<HTMLFormElement> | undefined;
133
+ onCompositionEnd?: import('react').CompositionEventHandler<HTMLFormElement> | undefined;
134
+ onCompositionEndCapture?: import('react').CompositionEventHandler<HTMLFormElement> | undefined;
135
+ onCompositionStart?: import('react').CompositionEventHandler<HTMLFormElement> | undefined;
136
+ onCompositionStartCapture?: import('react').CompositionEventHandler<HTMLFormElement> | undefined;
137
+ onCompositionUpdate?: import('react').CompositionEventHandler<HTMLFormElement> | undefined;
138
+ onCompositionUpdateCapture?: import('react').CompositionEventHandler<HTMLFormElement> | undefined;
139
+ onFocus?: import('react').FocusEventHandler<HTMLFormElement> | undefined;
140
+ onFocusCapture?: import('react').FocusEventHandler<HTMLFormElement> | undefined;
141
+ onBlurCapture?: import('react').FocusEventHandler<HTMLFormElement> | undefined;
142
+ onChangeCapture?: import('react').FormEventHandler<HTMLFormElement> | undefined;
143
+ onBeforeInput?: import('react').InputEventHandler<HTMLFormElement> | undefined;
144
+ onBeforeInputCapture?: import('react').FormEventHandler<HTMLFormElement> | undefined;
145
+ onInput?: import('react').FormEventHandler<HTMLFormElement> | undefined;
146
+ onInputCapture?: import('react').FormEventHandler<HTMLFormElement> | undefined;
147
+ onReset?: import('react').FormEventHandler<HTMLFormElement> | undefined;
148
+ onResetCapture?: import('react').FormEventHandler<HTMLFormElement> | undefined;
149
+ onSubmitCapture?: import('react').FormEventHandler<HTMLFormElement> | undefined;
150
+ onInvalid?: import('react').FormEventHandler<HTMLFormElement> | undefined;
151
+ onInvalidCapture?: import('react').FormEventHandler<HTMLFormElement> | undefined;
152
+ onLoad?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
153
+ onLoadCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
154
+ onError?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
155
+ onErrorCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
156
+ onKeyDown?: import('react').KeyboardEventHandler<HTMLFormElement> | undefined;
157
+ onKeyDownCapture?: import('react').KeyboardEventHandler<HTMLFormElement> | undefined;
158
+ onKeyPress?: import('react').KeyboardEventHandler<HTMLFormElement> | undefined;
159
+ onKeyPressCapture?: import('react').KeyboardEventHandler<HTMLFormElement> | undefined;
160
+ onKeyUp?: import('react').KeyboardEventHandler<HTMLFormElement> | undefined;
161
+ onKeyUpCapture?: import('react').KeyboardEventHandler<HTMLFormElement> | undefined;
162
+ onAbort?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
163
+ onAbortCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
164
+ onCanPlay?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
165
+ onCanPlayCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
166
+ onCanPlayThrough?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
167
+ onCanPlayThroughCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
168
+ onDurationChange?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
169
+ onDurationChangeCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
170
+ onEmptied?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
171
+ onEmptiedCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
172
+ onEncrypted?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
173
+ onEncryptedCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
174
+ onEnded?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
175
+ onEndedCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
176
+ onLoadedData?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
177
+ onLoadedDataCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
178
+ onLoadedMetadata?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
179
+ onLoadedMetadataCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
180
+ onLoadStart?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
181
+ onLoadStartCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
182
+ onPause?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
183
+ onPauseCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
184
+ onPlay?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
185
+ onPlayCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
186
+ onPlaying?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
187
+ onPlayingCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
188
+ onProgress?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
189
+ onProgressCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
190
+ onRateChange?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
191
+ onRateChangeCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
192
+ onSeeked?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
193
+ onSeekedCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
194
+ onSeeking?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
195
+ onSeekingCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
196
+ onStalled?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
197
+ onStalledCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
198
+ onSuspend?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
199
+ onSuspendCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
200
+ onTimeUpdate?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
201
+ onTimeUpdateCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
202
+ onVolumeChange?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
203
+ onVolumeChangeCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
204
+ onWaiting?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
205
+ onWaitingCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
206
+ onAuxClick?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
207
+ onAuxClickCapture?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
208
+ onClick?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
209
+ onClickCapture?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
210
+ onContextMenu?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
211
+ onContextMenuCapture?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
212
+ onDoubleClick?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
213
+ onDoubleClickCapture?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
214
+ onDrag?: import('react').DragEventHandler<HTMLFormElement> | undefined;
215
+ onDragCapture?: import('react').DragEventHandler<HTMLFormElement> | undefined;
216
+ onDragEnd?: import('react').DragEventHandler<HTMLFormElement> | undefined;
217
+ onDragEndCapture?: import('react').DragEventHandler<HTMLFormElement> | undefined;
218
+ onDragEnter?: import('react').DragEventHandler<HTMLFormElement> | undefined;
219
+ onDragEnterCapture?: import('react').DragEventHandler<HTMLFormElement> | undefined;
220
+ onDragExit?: import('react').DragEventHandler<HTMLFormElement> | undefined;
221
+ onDragExitCapture?: import('react').DragEventHandler<HTMLFormElement> | undefined;
222
+ onDragLeave?: import('react').DragEventHandler<HTMLFormElement> | undefined;
223
+ onDragLeaveCapture?: import('react').DragEventHandler<HTMLFormElement> | undefined;
224
+ onDragOver?: import('react').DragEventHandler<HTMLFormElement> | undefined;
225
+ onDragOverCapture?: import('react').DragEventHandler<HTMLFormElement> | undefined;
226
+ onDragStart?: import('react').DragEventHandler<HTMLFormElement> | undefined;
227
+ onDragStartCapture?: import('react').DragEventHandler<HTMLFormElement> | undefined;
228
+ onDrop?: import('react').DragEventHandler<HTMLFormElement> | undefined;
229
+ onDropCapture?: import('react').DragEventHandler<HTMLFormElement> | undefined;
230
+ onMouseDown?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
231
+ onMouseDownCapture?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
232
+ onMouseEnter?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
233
+ onMouseLeave?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
234
+ onMouseMove?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
235
+ onMouseMoveCapture?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
236
+ onMouseOut?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
237
+ onMouseOutCapture?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
238
+ onMouseOver?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
239
+ onMouseOverCapture?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
240
+ onMouseUp?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
241
+ onMouseUpCapture?: import('react').MouseEventHandler<HTMLFormElement> | undefined;
242
+ onSelect?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
243
+ onSelectCapture?: import('react').ReactEventHandler<HTMLFormElement> | undefined;
244
+ onTouchCancel?: import('react').TouchEventHandler<HTMLFormElement> | undefined;
245
+ onTouchCancelCapture?: import('react').TouchEventHandler<HTMLFormElement> | undefined;
246
+ onTouchEnd?: import('react').TouchEventHandler<HTMLFormElement> | undefined;
247
+ onTouchEndCapture?: import('react').TouchEventHandler<HTMLFormElement> | undefined;
248
+ onTouchMove?: import('react').TouchEventHandler<HTMLFormElement> | undefined;
249
+ onTouchMoveCapture?: import('react').TouchEventHandler<HTMLFormElement> | undefined;
250
+ onTouchStart?: import('react').TouchEventHandler<HTMLFormElement> | undefined;
251
+ onTouchStartCapture?: import('react').TouchEventHandler<HTMLFormElement> | undefined;
252
+ onPointerDown?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
253
+ onPointerDownCapture?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
254
+ onPointerMove?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
255
+ onPointerMoveCapture?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
256
+ onPointerUp?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
257
+ onPointerUpCapture?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
258
+ onPointerCancel?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
259
+ onPointerCancelCapture?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
260
+ onPointerEnter?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
261
+ onPointerLeave?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
262
+ onPointerOver?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
263
+ onPointerOverCapture?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
264
+ onPointerOut?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
265
+ onPointerOutCapture?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
266
+ onGotPointerCapture?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
267
+ onGotPointerCaptureCapture?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
268
+ onLostPointerCapture?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
269
+ onLostPointerCaptureCapture?: import('react').PointerEventHandler<HTMLFormElement> | undefined;
270
+ onScroll?: import('react').UIEventHandler<HTMLFormElement> | undefined;
271
+ onScrollCapture?: import('react').UIEventHandler<HTMLFormElement> | undefined;
272
+ onScrollEnd?: import('react').UIEventHandler<HTMLFormElement> | undefined;
273
+ onScrollEndCapture?: import('react').UIEventHandler<HTMLFormElement> | undefined;
274
+ onWheel?: import('react').WheelEventHandler<HTMLFormElement> | undefined;
275
+ onWheelCapture?: import('react').WheelEventHandler<HTMLFormElement> | undefined;
276
+ onAnimationStart?: import('react').AnimationEventHandler<HTMLFormElement> | undefined;
277
+ onAnimationStartCapture?: import('react').AnimationEventHandler<HTMLFormElement> | undefined;
278
+ onAnimationEnd?: import('react').AnimationEventHandler<HTMLFormElement> | undefined;
279
+ onAnimationEndCapture?: import('react').AnimationEventHandler<HTMLFormElement> | undefined;
280
+ onAnimationIteration?: import('react').AnimationEventHandler<HTMLFormElement> | undefined;
281
+ onAnimationIterationCapture?: import('react').AnimationEventHandler<HTMLFormElement> | undefined;
282
+ onToggle?: import('react').ToggleEventHandler<HTMLFormElement> | undefined;
283
+ onBeforeToggle?: import('react').ToggleEventHandler<HTMLFormElement> | undefined;
284
+ onTransitionCancel?: import('react').TransitionEventHandler<HTMLFormElement> | undefined;
285
+ onTransitionCancelCapture?: import('react').TransitionEventHandler<HTMLFormElement> | undefined;
286
+ onTransitionEnd?: import('react').TransitionEventHandler<HTMLFormElement> | undefined;
287
+ onTransitionEndCapture?: import('react').TransitionEventHandler<HTMLFormElement> | undefined;
288
+ onTransitionRun?: import('react').TransitionEventHandler<HTMLFormElement> | undefined;
289
+ onTransitionRunCapture?: import('react').TransitionEventHandler<HTMLFormElement> | undefined;
290
+ onTransitionStart?: import('react').TransitionEventHandler<HTMLFormElement> | undefined;
291
+ onTransitionStartCapture?: import('react').TransitionEventHandler<HTMLFormElement> | undefined;
292
+ id: string;
293
+ };
@@ -1,20 +1,19 @@
1
1
  import { DevtoolUIProps } from '@hookform/devtools/dist/devToolUI';
2
- import { UseResetFormOnSubmittedOptions } from '../submit/useResetFormOnSubmitted';
3
- import { Register } from '../register';
2
+ import { UseResetFormOnSubmittedOptions } from '../../submit/useResetFormOnSubmitted';
3
+ import { UseSubmitFormOnWatchOptions } from '../../submit/useSubmitFormOnWatch';
4
+ import { Register } from '../../Register';
4
5
  /**
5
6
  * Options for enabling utils functionality provided by this library.
6
7
  *
7
- * Can be extended using {@link Register.RhfUtilsFormOptions}.
8
+ * Can be extended via {@link Register}.
8
9
  */
9
10
  export type RhfUtilsFormOptions = {
10
11
  /** Stop propagation of submit event. */
11
12
  stopSubmitPropagation?: boolean;
12
13
  /**
13
- * Request submit via listener on form change.
14
- * - `true` to submit on any change.
15
- * - number to debounce in milliseconds.
14
+ * Request submit when user changes form values.
16
15
  */
17
- submitOnChange?: boolean | number;
16
+ submitOnWatch?: UseSubmitFormOnWatchOptions;
18
17
  /** Reset form values and state (e.g., `isDirty`) after submit -- on success and/or error. */
19
18
  resetOnSubmitted?: UseResetFormOnSubmittedOptions;
20
19
  /**
@@ -0,0 +1,2 @@
1
+ import { RhfUtilsFormOptions } from './RhfUtilsFormOptionsType';
2
+ export declare const getRhfUtilsFormResolvedOptions: (global: RhfUtilsFormOptions | undefined, instance: RhfUtilsFormOptions | undefined) => RhfUtilsFormOptions;
@@ -0,0 +1,8 @@
1
+ import { RhfUtilsClientConfig } from '../../client/config/RhfUtilsClientConfigType';
2
+ import { RhfUtilsFormOptions } from './RhfUtilsFormOptionsType';
3
+ export declare const useRhfUtilsFormResolvedOptions: (config: RhfUtilsClientConfig, options: RhfUtilsFormOptions | undefined) => {
4
+ stopSubmitPropagation?: boolean;
5
+ submitOnWatch?: import('../../submit/useSubmitFormOnWatch').UseSubmitFormOnWatchOptions;
6
+ resetOnSubmitted?: import('../../submit/useResetFormOnSubmitted').UseResetFormOnSubmittedOptions;
7
+ devTool?: boolean | Pick<import('@hookform/devtools/dist/devToolUI').DevtoolUIProps, "placement" | "styles">;
8
+ };
@@ -0,0 +1,6 @@
1
+ import { default as React } from 'react';
2
+ import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
3
+ import { RhfUtilsFormProvidersProps } from './RhfUtilsFormProvidersPropsType';
4
+ type Props<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = React.PropsWithChildren<RhfUtilsFormProvidersProps<TFieldValues, TTransformedValues>>;
5
+ export declare function RhfUtilsFormProviders<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>({ formId, rhf, resolver, defaultValues, options, children, }: Props<TFieldValues, TTransformedValues>): import("react/jsx-runtime").JSX.Element;
6
+ export {};
@@ -0,0 +1,15 @@
1
+ import { Resolver, UseFormProps } from 'react-hook-form';
2
+ import { RhfUtilsFormOptions } from '../options/RhfUtilsFormOptionsType';
3
+ import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
4
+ import { RhfUseFormInstanceProps } from '../rhf/UseFormPropsType';
5
+ /**
6
+ * RhfUtils form providers props.
7
+ */
8
+ export type RhfUtilsFormProvidersProps<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = {
9
+ /** Globally-unique form id. (Used in DOM. Auto-generated if not supplied.) */
10
+ formId?: string;
11
+ resolver?: Resolver<TFieldValues, unknown, TTransformedValues>;
12
+ rhf?: RhfUseFormInstanceProps<TFieldValues, TTransformedValues>;
13
+ defaultValues?: UseFormProps<TFieldValues, unknown, TTransformedValues>['defaultValues'];
14
+ options?: RhfUtilsFormOptions;
15
+ };
@@ -0,0 +1,4 @@
1
+ import { UseFormProps } from 'react-hook-form';
2
+ import { SafeFieldValues } from './SafeFieldValuesType';
3
+ export type RhfUseFormGlobalProps = Pick<UseFormProps, 'mode' | 'reValidateMode' | 'resetOptions' | 'context' | 'shouldFocusError' | 'shouldUnregister' | 'shouldUseNativeValidation' | 'progressive' | 'criteriaMode' | 'delayError'>;
4
+ export type RhfUseFormInstanceProps<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = Omit<UseFormProps<TFieldValues, unknown, TTransformedValues>, 'defaultValues' | 'resolver'>;
@@ -0,0 +1,4 @@
1
+ import { UseRhfUtilsFormResolvedDefaults } from '../defaults/UseRhfUtilsFormResolvedDefaultsType';
2
+ import { SafeFieldValues } from './SafeFieldValuesType';
3
+ import { RhfUseFormGlobalProps, RhfUseFormInstanceProps } from './UseFormPropsType';
4
+ export declare const getRhfUtilsFormResolvedRhfProps: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>(global: RhfUseFormGlobalProps | undefined, instance: RhfUseFormInstanceProps<TFieldValues, TTransformedValues> | undefined) => UseRhfUtilsFormResolvedDefaults<TFieldValues, TTransformedValues>["rhf"];
@@ -0,0 +1,5 @@
1
+ import { Resolver, UseFormProps } from 'react-hook-form';
2
+ import { RhfUtilsClientConfig } from '../../client/config/RhfUtilsClientConfigType';
3
+ import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
4
+ import { RhfUseFormInstanceProps } from '../rhf/UseFormPropsType';
5
+ export declare const useRhfFormWithResolvedProps: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>(props: RhfUseFormInstanceProps<TFieldValues, TTransformedValues> | undefined, config: RhfUtilsClientConfig, defaultValues: UseFormProps<TFieldValues, unknown, TTransformedValues>["defaultValues"], resolver?: Resolver<TFieldValues, unknown, TTransformedValues>) => import('react-hook-form').UseFormReturn<TFieldValues, unknown, TTransformedValues>;
@@ -0,0 +1,4 @@
1
+ import { default as React } from 'react';
2
+ type Props = React.PropsWithChildren;
3
+ export declare const FormStateRelayContextProvider: React.FC<Props>;
4
+ export {};
@@ -0,0 +1,10 @@
1
+ import { Merge } from '../../../utils/types';
2
+ import { FormStateRelayed } from './FormStateRelayedType';
3
+ export type FormStateRelayedAggregated = Merge<Omit<FormStateRelayed, 'defaultValues'>, Record<Extract<keyof FormStateRelayed, 'dirtyFields' | 'touchedFields' | 'validatingFields' | 'errors'>, boolean> & {
4
+ /** Sum of all submit counts. */
5
+ submitCount: number;
6
+ /** Any submitted and not successful? */
7
+ isSubmitUnsuccessful: boolean;
8
+ /** Consider form flagged when mounted. (Corresponds to {@link FormStateRelayedOptions.flaggedState.isMounted}.) */
9
+ isMountedFlagged: boolean;
10
+ }>;
@@ -0,0 +1,11 @@
1
+ import { SafeFieldValues } from '../../rhf/SafeFieldValuesType';
2
+ import { RhfUtilsFormStateWithUtilsType } from '../../RhfUtilsFormStateWithUtilsType';
3
+ import { FormStateRelayedOptions } from './FormStateRelayedOptionsType';
4
+ import { FormStateRelayed } from './FormStateRelayedType';
5
+ export type FormStateRelayedItem<TFieldValues extends SafeFieldValues = SafeFieldValues> = {
6
+ state: FormStateRelayed<TFieldValues>;
7
+ options?: FormStateRelayedOptions;
8
+ };
9
+ export type FormStateRelayedItemWithUtils<TFieldValues extends SafeFieldValues = SafeFieldValues> = RhfUtilsFormStateWithUtilsType<TFieldValues> & {
10
+ options?: FormStateRelayedOptions;
11
+ };
@@ -0,0 +1,20 @@
1
+ export type FormStateRelayedOptions = {
2
+ /**
3
+ * Arbitrary group name(s) for this form.
4
+ *
5
+ * Think of it like class or category names.
6
+ * (e.g., "parent" or "children")
7
+ */
8
+ group?: string | string[];
9
+ /**
10
+ * Denote certain state(s) as flagged.
11
+ */
12
+ flaggedState?: {
13
+ /**
14
+ * Flag when mounted.
15
+ *
16
+ * (e.g., forms that are unmounted by default)
17
+ */
18
+ isMounted?: true;
19
+ };
20
+ };
@@ -0,0 +1,3 @@
1
+ import { FormState } from 'react-hook-form';
2
+ import { SafeFieldValues } from '../../rhf/SafeFieldValuesType';
3
+ export type FormStateRelayed<TFieldValues extends SafeFieldValues = SafeFieldValues> = FormState<TFieldValues>;
@@ -0,0 +1,31 @@
1
+ import { SafeFieldValues } from '../../../rhf/SafeFieldValuesType';
2
+ import { RhfUtilsFormStateWithUtilsType } from '../../../RhfUtilsFormStateWithUtilsType';
3
+ import { FormStateRelayedAggregated } from '../FormStateRelayedAggregatedType';
4
+ import { FormStateRelayedItemWithUtils } from '../FormStateRelayedItemType';
5
+ /**
6
+ * Watch only form -- without worrying about ID.
7
+ *
8
+ * @throws If more than one form is being tracked.
9
+ */
10
+ export declare const useFormStateRelayPullOnlyOrThrow: () => FormStateRelayedItemWithUtils | undefined;
11
+ /**
12
+ * Watch all forms via {@link FormStateRelayedAggregated}.
13
+ */
14
+ export declare const useFormStateRelayPullAny: () => FormStateRelayedAggregated;
15
+ /**
16
+ * Watch single form's state.
17
+ *
18
+ * @param formId Watched form identifier.
19
+ */
20
+ export declare const useFormStateRelayPullById: (formId: string) => FormStateRelayedItemWithUtils | undefined;
21
+ /**
22
+ * Compute single boolean for group's form state to denote whether it's flagged via default algorithm.
23
+ * (i.e., is dirty or submitting or submit unsuccessful or mounted flagged)
24
+ *
25
+ * @param group Group name to watch.
26
+ */
27
+ export declare const useFormStateRelayPullGroup: (group: string) => FormStateRelayedAggregated | undefined;
28
+ /**
29
+ * Use form state with utils either through RHF or relay.
30
+ */
31
+ export declare const useFormStateWithUtilsViaRhfOrRelay: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>() => RhfUtilsFormStateWithUtilsType<TFieldValues> | undefined;
@@ -0,0 +1,4 @@
1
+ import { FormStateRelayPushOptions } from './useFormStateRelayPusher';
2
+ type Props = FormStateRelayPushOptions;
3
+ export declare const FormStateRelayPusher: React.FC<Props>;
4
+ export {};
@@ -0,0 +1,3 @@
1
+ import { FormStateRelayedOptions } from '../FormStateRelayedOptionsType';
2
+ export type FormStateRelayPushOptions = FormStateRelayedOptions;
3
+ export declare const useFormStateRelayPusher: (options?: FormStateRelayPushOptions) => void;
@@ -0,0 +1,20 @@
1
+ import { RhfUtilsContextProps } from '../../context/utils/RhfUtilsContextPropsType';
2
+ import { FormStateRelayedAggregated } from './FormStateRelayedAggregatedType';
3
+ import { FormStateRelayedItemWithUtils } from './FormStateRelayedItemType';
4
+ import { FormStateRelayedOptions } from './FormStateRelayedOptionsType';
5
+ import { FormStateRelayed } from './FormStateRelayedType';
6
+ export type FormStateRelayContext = {
7
+ add: (state: FormStateRelayed, utils: RhfUtilsContextProps, options?: FormStateRelayedOptions) => void;
8
+ update: (id: string, state: FormStateRelayed) => void;
9
+ remove: (id: string) => void;
10
+ /**
11
+ * Get form state by ID.
12
+ *
13
+ * @throws Error if not found.
14
+ */
15
+ get: (id: string) => FormStateRelayedItemWithUtils | undefined;
16
+ getOnly: () => FormStateRelayedItemWithUtils | undefined;
17
+ any: FormStateRelayedAggregated;
18
+ getGroup: (group: string) => FormStateRelayedAggregated | undefined;
19
+ };
20
+ export declare const _FormStateRelayContextProvider: import('react').Provider<FormStateRelayContext | undefined>, useFormStateRelayContext: () => FormStateRelayContext;
@@ -0,0 +1,4 @@
1
+ import { FormStateRelayedAggregated } from './FormStateRelayedAggregatedType';
2
+ import { FormStateRelayedItem } from './FormStateRelayedItemType';
3
+ /** Condense list of form states to singular booleans. */
4
+ export declare const getFormContextRelayReducedFormState: (forms: FormStateRelayedItem[]) => FormStateRelayedAggregated;
@@ -0,0 +1,6 @@
1
+ import { default as React } from 'react';
2
+ /**
3
+ * Get [name, value] tuple of button/input that submitted form.
4
+ * Useful when determining user intent
5
+ */
6
+ export declare const getSubmitterButtonData: (event: React.BaseSyntheticEvent) => [name: string, value: string] | undefined;
@@ -6,5 +6,4 @@ import { default as React } from 'react';
6
6
  *
7
7
  * @link https://developer.mozilla.org/docs/Web/API/HTMLFormElement/requestSubmit
8
8
  */
9
- declare const useFormRequestSubmit: (ref: React.RefObject<HTMLFormElement>) => HTMLFormElement["requestSubmit"];
10
- export default useFormRequestSubmit;
9
+ export declare const useFormRequestSubmit: (ref: React.RefObject<HTMLFormElement | null>) => HTMLFormElement["requestSubmit"];
@@ -0,0 +1,4 @@
1
+ import { RhfUtilsClientConfig } from '../../client/config/RhfUtilsClientConfigType';
2
+ import { UseRhfUtilsFormOnSubmitContext } from '../../submit/UseRhfUtilsFormOnSubmitContextType';
3
+ import { MaybePromise } from '../../utils/types';
4
+ export declare const useHandleCancelWithCheckIfCanBe: (onCancel: undefined | (() => MaybePromise<void>), useCanFormBeCancelled: RhfUtilsClientConfig["useCanFormBeCancelled"], formOnSubmitContext: UseRhfUtilsFormOnSubmitContext) => () => Promise<void>;
@@ -0,0 +1,2 @@
1
+ import { MaybePromise } from '../../utils/types';
2
+ export declare const useHandleCancelWithCheckIfCanBeViaProviders: (onCancel: undefined | (() => MaybePromise<void>)) => () => Promise<void>;
@@ -21,5 +21,4 @@ export type UseShouldFormBlockNavigationOptions = {
21
21
  * Evaluates to `true` when `enabled` and `isDirty` except when `isSubmitting` and `isValid`,
22
22
  * because we don't want to block navigation when the form is submitting and valid.
23
23
  */
24
- declare const useShouldFormBlockNavigation: ({ isDirty, isSubmitting }: FormState<FieldValues>, options?: UseShouldFormBlockNavigationOptions) => boolean;
25
- export default useShouldFormBlockNavigation;
24
+ export declare const useShouldFormBlockNavigation: ({ isDirty, isSubmitting }: FormState<FieldValues>, options?: UseShouldFormBlockNavigationOptions) => boolean;
@@ -0,0 +1,3 @@
1
+ import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
2
+ import { RhfUtilsFormProps, RhfUtilsFormPropsGetApiValues } from './RhfUtilsFormProps';
3
+ export declare const RhfUtilsForm: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TTransformedValues, SafeFieldValues>, TOnSubmitReturnType, TApiValues extends undefined | SafeFieldValues = TGetApiValues extends RhfUtilsFormPropsGetApiValues<TTransformedValues, infer U> ? U : undefined>({ getApiData, onCancel, onSubmitInvalid, onBeforeSubmitInvariants, onBeforeSubmit, onSubmit, onSubmitSuccess, onSubmitError, onSubmitFinally, Children, form, className, }: RhfUtilsFormProps<TFieldValues, TTransformedValues, TGetApiValues, TOnSubmitReturnType, TApiValues>) => import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,46 @@
1
+ import { SubmitErrorHandler } from 'react-hook-form';
2
+ import { MaybePromise } from '../../utils/types';
3
+ import { UseRhfUtilsFormOnSubmitContext, UseRhfUtilsFormOnSubmitErrorContext } from '../../submit/UseRhfUtilsFormOnSubmitContextType';
4
+ import { UseRhfUtilsFormInstanceFormProps } from '../defaults/form/UseRhfUtilsFormInstanceFormProps';
5
+ import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
6
+ import { UseRhfUtilsFormChildrenProps } from '../UseRhfUtilsFormChildrenPropsType';
7
+ export type RhfUtilsFormPropsGetApiValues<TTransformedValues extends SafeFieldValues, TApiValues> = (data: TTransformedValues) => TApiValues;
8
+ export type RhfUtilsFormPropsonBeforeSubmitInvariants<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TApiValues extends undefined | SafeFieldValues> = (data: {
9
+ input: TFieldValues;
10
+ output: TTransformedValues;
11
+ api: TApiValues;
12
+ }, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues, TApiValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => MaybePromise<[keyof TFieldValues | keyof TApiValues, string, unknown][]>;
13
+ export type RhfUtilsFormProps<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TTransformedValues, SafeFieldValues>, TOnSubmitReturnType, TApiValues extends undefined | SafeFieldValues = TGetApiValues extends RhfUtilsFormPropsGetApiValues<TTransformedValues, infer U> ? U : undefined> = {
14
+ getApiData?: TGetApiValues;
15
+ /** Cancellation handler -- channeled through {@link RhfUtilsClientConfig.useCanFormBeCancelled} before propagating to `Children` component. */
16
+ onCancel?: () => MaybePromise<void>;
17
+ /** Submit handler when form is invalid. */
18
+ onSubmitInvalid?: SubmitErrorHandler<TFieldValues>;
19
+ /**
20
+ * List of invariants to run against input/output/api data.
21
+ * For any and all false-y values, a {@link FormSubmitFieldErrors} will be thrown.
22
+ */
23
+ onBeforeSubmitInvariants?: RhfUtilsFormPropsonBeforeSubmitInvariants<TFieldValues, TTransformedValues, TApiValues>;
24
+ onBeforeSubmit?: (data: {
25
+ input: TFieldValues;
26
+ output: TTransformedValues;
27
+ api: TApiValues;
28
+ }, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues, TApiValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => MaybePromise<unknown>;
29
+ onSubmit?: (data: {
30
+ input: TFieldValues;
31
+ output: TTransformedValues;
32
+ api: TApiValues;
33
+ }, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues, TApiValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => MaybePromise<TOnSubmitReturnType>;
34
+ onSubmitSuccess?: (submitResponse: TOnSubmitReturnType, data: {
35
+ input: TFieldValues;
36
+ output: TTransformedValues;
37
+ api: TApiValues;
38
+ }, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues, TApiValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => MaybePromise<unknown>;
39
+ /** Submit error handler. (Only for errors not of instance `FormError`, which are handled internally.) */
40
+ onSubmitError?: (error: unknown, context: UseRhfUtilsFormOnSubmitErrorContext<TFieldValues, TTransformedValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => void;
41
+ onSubmitFinally?: () => MaybePromise<void>;
42
+ Children: React.FC<UseRhfUtilsFormChildrenProps<TFieldValues, TTransformedValues>>;
43
+ form?: UseRhfUtilsFormInstanceFormProps;
44
+ /** Form class attribute. */
45
+ className?: string;
46
+ };
@@ -0,0 +1,3 @@
1
+ import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
2
+ import { RhfUtilsFormProps } from './RhfUtilsFormProps';
3
+ export declare const RhfUtilsFormChildrenViaProviders_Internal: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>({ onCancel, Children, }: Pick<RhfUtilsFormProps<TFieldValues, TTransformedValues, undefined, undefined>, "Children" | "onCancel">) => import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,4 @@
1
+ import { default as React } from 'react';
2
+ import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
3
+ import { RhfUtilsFormProps, RhfUtilsFormPropsGetApiValues } from './RhfUtilsFormProps';
4
+ export declare const RhfUtilsFormWithSubmitHandler_Internal: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TTransformedValues, SafeFieldValues>, TOnSubmitReturnType, TApiValues extends undefined | SafeFieldValues = TGetApiValues extends RhfUtilsFormPropsGetApiValues<TTransformedValues, infer U> ? U : undefined>({ getApiData, onSubmitInvalid, onBeforeSubmitInvariants, onBeforeSubmit, onSubmit, onSubmitSuccess, onSubmitError, onSubmitFinally, form, className, children, }: React.PropsWithChildren<Pick<RhfUtilsFormProps<TFieldValues, TTransformedValues, TGetApiValues, TOnSubmitReturnType, TApiValues>, "getApiData" | "onSubmitInvalid" | "onBeforeSubmitInvariants" | "onBeforeSubmit" | "onSubmit" | "onSubmitSuccess" | "onSubmitError" | "onSubmitFinally" | "form" | "className">>) => import("react/jsx-runtime").JSX.Element;