@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.
- package/README.md +260 -121
- package/dist/dts/Register.d.ts +16 -0
- package/dist/dts/_exports/config.d.ts +2 -0
- package/dist/dts/_exports/errors.d.ts +3 -0
- package/dist/dts/_exports/form.d.ts +7 -0
- package/dist/dts/_exports/index.d.ts +14 -0
- package/dist/dts/_exports/relay.d.ts +8 -0
- package/dist/dts/_exports/submit.d.ts +4 -0
- package/dist/dts/_exports/trpc.d.ts +2 -0
- package/dist/dts/_exports/types.d.ts +6 -0
- package/dist/dts/_exports/zod.d.ts +6 -0
- package/dist/dts/client/config/RhfUtilsClientConfigType.d.ts +63 -0
- package/dist/dts/client/config/context/RhfUtilsClientConfigContext.d.ts +3 -0
- package/dist/dts/client/config/context/RhfUtilsClientConfigProvider.d.ts +7 -0
- package/dist/dts/client/config/context/useRhfUtilsClientConfig.d.ts +1 -0
- package/dist/{types → dts}/devtool/LazyDevTool.d.ts +3 -4
- package/dist/dts/devtool/LazyDevToolViaProviders.d.ts +1 -0
- package/dist/{types → dts}/errors/flat/FlatFieldErrorsList.d.ts +2 -2
- package/dist/{types → dts}/errors/flat/context/FlatFieldErrorsContextProvider.d.ts +3 -3
- package/dist/{types → dts}/errors/flat/context/useFlatFieldErrorsContext.d.ts +1 -2
- package/dist/dts/errors/flat/context/useFlatFieldErrorsContextHasOnlyOrphans.d.ts +6 -0
- package/dist/{types → dts}/errors/flat/context/useFlatFieldErrorsContextOutput.d.ts +1 -2
- package/dist/dts/errors/flat/filterFlatFieldErrors.d.ts +7 -0
- package/dist/{types → dts}/errors/flat/flattenFieldErrors.d.ts +1 -2
- package/dist/{types → dts}/errors/flat/getFlatFieldErrors.d.ts +2 -1
- package/dist/dts/errors/getRefdFromFlatFieldErrors.d.ts +1 -0
- package/dist/{types → dts}/errors/isFieldErrorRefd.d.ts +1 -2
- package/dist/dts/errors/isFlatFieldErrorEntryRefd.d.ts +5 -0
- package/dist/{types → dts}/errors/message/FormErrorMessage.d.ts +2 -2
- package/dist/{types → dts}/errors/message/RhfUtilsFieldErrorMessage.d.ts +2 -2
- package/dist/{types → dts}/errors/nonfield/RhfUtilsNonFieldErrorMarker.d.ts +2 -2
- package/dist/dts/errors/nonfield/RhfUtilsNonFieldErrorMarkerHtmlAttribute.d.ts +4 -0
- package/dist/{types → dts}/errors/nonfield/isNonFieldError.d.ts +1 -2
- package/dist/dts/errors/nonfield/isNonFieldErrorMarkerInDOM.d.ts +5 -0
- package/dist/dts/errors/orphan/getIsOrphanFormErrorWithParentElement.d.ts +5 -0
- package/dist/dts/errors/orphan/getOrphansFromFlatFieldErrors.d.ts +2 -0
- package/dist/dts/errors/orphan/isOrphanFormError.d.ts +2 -0
- package/dist/dts/errors/output/consoleErrors.d.ts +5 -0
- package/dist/dts/errors/root/RootErrorsListFromFlatFieldErrorsContext.d.ts +1 -0
- package/dist/dts/errors/root/getRootsFromFlatFieldErrors.d.ts +1 -0
- package/dist/{types → dts}/errors/root/isFlatFieldErrorEntryPathRoot.d.ts +1 -2
- package/dist/{types → dts}/errors/root/isFormErrorPathRoot.d.ts +1 -2
- package/dist/{types → dts}/errors/trpc/makeOnSubmitTrpcClientErrorHandler.d.ts +2 -3
- package/dist/dts/errors/trpc/trpcClientErrorMessageSchema.d.ts +19 -0
- package/dist/dts/errors/trpc/trpcClientErrorToFormSubmitFieldErrorsSchemaTransformer.d.ts +23 -0
- package/dist/dts/form/RHF_UseFormReturnWithoutProxiesType.d.ts +15 -0
- package/dist/dts/form/RhfUtilsFormComponentPropsType.d.ts +17 -0
- package/dist/dts/form/RhfUtilsFormStateWithUtilsType.d.ts +7 -0
- package/dist/dts/form/UseRhfUtilsFormChildrenPropsType.d.ts +25 -0
- package/dist/dts/form/_Controller.d.ts +4 -0
- package/dist/dts/form/context/utils/RhfUtilsContextPropsType.d.ts +11 -0
- package/dist/dts/form/context/utils/RhfUtilsContextProvider.d.ts +9 -0
- package/dist/dts/form/context/utils/useRhfUtilsContext.d.ts +5 -0
- package/dist/dts/form/context/utils/useRhfUtilsContextRequestSubmit.d.ts +4 -0
- package/dist/dts/form/defaults/UseRhfUtilsFormGlobalDefaults.d.ts +24 -0
- package/dist/dts/form/defaults/UseRhfUtilsFormInstanceDefaults.d.ts +18 -0
- package/dist/dts/form/defaults/UseRhfUtilsFormResolvedDefaultsType.d.ts +12 -0
- package/dist/dts/form/defaults/form/UseRhfUtilsFormInstanceFormProps.d.ts +6 -0
- package/dist/dts/form/defaults/form/getRhfUtilsFormResolvedFormProps.d.ts +2 -0
- package/dist/dts/form/defaults/form/useRhfUtilsFormResolvedFormProps.d.ts +293 -0
- package/dist/{types/form/RhfUtilsFormOptions.d.ts → dts/form/options/RhfUtilsFormOptionsType.d.ts} +6 -7
- package/dist/dts/form/options/getRhfUtilsFormResolvedOptions.d.ts +2 -0
- package/dist/dts/form/options/useRhfUtilsFormResolvedOptions.d.ts +8 -0
- package/dist/dts/form/providers/RhfUtilsFormProviders.d.ts +6 -0
- package/dist/dts/form/providers/RhfUtilsFormProvidersPropsType.d.ts +15 -0
- package/dist/dts/form/rhf/UseFormPropsType.d.ts +4 -0
- package/dist/dts/form/rhf/getRhfUtilsFormResolvedRhfProps.d.ts +4 -0
- package/dist/dts/form/rhf/useRhfFormWithResolvedProps.d.ts +5 -0
- package/dist/dts/form/state/relay/FormStateRelayContextProvider.d.ts +4 -0
- package/dist/dts/form/state/relay/FormStateRelayedAggregatedType.d.ts +10 -0
- package/dist/dts/form/state/relay/FormStateRelayedItemType.d.ts +11 -0
- package/dist/dts/form/state/relay/FormStateRelayedOptionsType.d.ts +20 -0
- package/dist/dts/form/state/relay/FormStateRelayedType.d.ts +3 -0
- package/dist/dts/form/state/relay/pull/hooks.d.ts +31 -0
- package/dist/dts/form/state/relay/push/FormStateRelayPusher.d.ts +4 -0
- package/dist/dts/form/state/relay/push/useFormStateRelayPusher.d.ts +3 -0
- package/dist/dts/form/state/relay/useFormStateRelayContext.d.ts +20 -0
- package/dist/dts/form/state/relay/utils.d.ts +4 -0
- package/dist/dts/form/utils/getSubmitterButtonData.d.ts +6 -0
- package/dist/{types → dts}/form/utils/useFormRequestSubmit.d.ts +1 -2
- package/dist/dts/form/utils/useHandleCancelWithCheckIfCanBe.d.ts +4 -0
- package/dist/dts/form/utils/useHandleCancelWithCheckIfCanBeViaProviders.d.ts +2 -0
- package/dist/{types → dts}/form/utils/useShouldFormBlockNavigation.d.ts +1 -2
- package/dist/dts/form/with-handlers-and-children/RhfUtilsForm.d.ts +3 -0
- package/dist/dts/form/with-handlers-and-children/RhfUtilsFormProps.d.ts +46 -0
- package/dist/dts/form/with-handlers-and-children/_ChildrenViaProviders.d.ts +3 -0
- package/dist/dts/form/with-handlers-and-children/_FormWithSubmitHandler.d.ts +4 -0
- package/dist/dts/form/with-handlers-and-children/_useHandleSubmit.d.ts +11 -0
- package/dist/dts/form/with-providers/RhfUtilsFormWithProviders.d.ts +8 -0
- package/dist/dts/form/with-providers/RhfUtilsFormWithProvidersProps.d.ts +4 -0
- package/dist/dts/resolvers/ObjectSchema.d.ts +7 -0
- package/dist/dts/resolvers/zod/RhfUtilsUseZodFormChildrenFCType.d.ts +7 -0
- package/dist/dts/resolvers/zod/RhfUtilsUseZodFormChildrenPropsType.d.ts +4 -0
- package/dist/dts/resolvers/zod/ZodTypeSafeFieldValuesType.d.ts +5 -0
- package/dist/dts/resolvers/zod/consts.d.ts +4 -0
- package/dist/dts/resolvers/zod/form/RhfUtilsZodForm.d.ts +7 -0
- package/dist/dts/resolvers/zod/getZodResolver.d.ts +4 -0
- package/dist/dts/resolvers/zod/providers/RhfUtilsZodFormProviders.d.ts +8 -0
- package/dist/dts/resolvers/zod/with-providers/RhfUtilsZodFormWithProviders.d.ts +10 -0
- package/dist/dts/submit/UseRhfUtilsFormOnSubmitContextType.d.ts +23 -0
- package/dist/dts/submit/error/FormSubmitError.d.ts +6 -0
- package/dist/{types → dts}/submit/error/FormSubmitFieldErrors.d.ts +1 -1
- package/dist/dts/submit/error/setCtxErrorsByFormSubmitFieldErrors.d.ts +8 -0
- package/dist/dts/submit/last-error/LastSubmitErrorContextProvider.d.ts +4 -0
- package/dist/dts/submit/last-error/LastSubmitErrorContextType.d.ts +8 -0
- package/dist/dts/submit/last-error/useLastSubmitError.d.ts +4 -0
- package/dist/dts/submit/last-error/useLastSubmitErrorContext.d.ts +3 -0
- package/dist/dts/submit/last-error/useLastSubmitErrorContextWith.d.ts +2 -0
- package/dist/{types → dts}/submit/useFormOnSubmitSuccessfulAndReset.d.ts +1 -2
- package/dist/dts/submit/useFormOnSubmitted.d.ts +4 -0
- package/dist/{types → dts}/submit/useResetFormOnSubmitted.d.ts +1 -2
- package/dist/dts/submit/useRhfUtilsFormOnSubmitContext.d.ts +3 -0
- package/dist/dts/submit/useSubmitFormOnChange.d.ts +15 -0
- package/dist/dts/submit/useSubmitFormOnEvent.d.ts +9 -0
- package/dist/dts/submit/useSubmitFormOnWatch.d.ts +14 -0
- package/dist/dts/utils/PassthroughChildren.d.ts +7 -0
- package/dist/{types → dts}/utils/createContext.d.ts +1 -2
- package/dist/dts/utils/fixedForwardRef.d.ts +5 -0
- package/dist/dts/utils/isEmptyObject.d.ts +1 -0
- package/dist/dts/utils/types.d.ts +3 -0
- package/dist/{types → dts}/utils/useImperativeForwardedRef.d.ts +1 -2
- package/dist/dts/utils/useIsFirstRender.d.ts +7 -0
- package/dist/dts/utils/useRefIfValueWasTrue.d.ts +2 -0
- package/dist/dts/utils/useToggle.d.ts +2 -0
- package/dist/dts/vite-env.d.ts +1 -0
- package/dist/esm/getFlatFieldErrors.mjs +55 -0
- package/dist/esm/index.mjs +503 -390
- package/dist/esm/relay.mjs +222 -0
- package/dist/esm/trpc.mjs +8 -9
- package/package.json +91 -72
- package/LICENSE.md +0 -21
- package/dist/esm/createContext.mjs +0 -16
- package/dist/esm/group.mjs +0 -74
- package/dist/esm/useFlatFieldErrorsContext.mjs +0 -10
- package/dist/esm/utils.mjs +0 -20
- package/dist/types/_exports/group.d.ts +0 -9
- package/dist/types/_exports/index.d.ts +0 -15
- package/dist/types/_exports/trpc.d.ts +0 -2
- package/dist/types/_exports/utils.d.ts +0 -1
- package/dist/types/client/config/RhfUtilsClientConfig.d.ts +0 -70
- package/dist/types/client/config/useRhfUtilsClientConfigContext.d.ts +0 -4
- package/dist/types/client/context.d.ts +0 -2
- package/dist/types/client/index.d.ts +0 -24
- package/dist/types/client/utils.d.ts +0 -12
- package/dist/types/client/zod/RhfUtilsUseFormChildrenZodFC.d.ts +0 -12
- package/dist/types/client/zod/RhfUtilsUseFormChildrenZodProps.d.ts +0 -4
- package/dist/types/client/zod/ZodTypeFieldValues.d.ts +0 -3
- package/dist/types/client/zod/consts.d.ts +0 -4
- package/dist/types/client/zod/context/RhfUtilsClientForZodContextProvider.d.ts +0 -7
- package/dist/types/client/zod/context/RhfUtilsZodForm.d.ts +0 -8
- package/dist/types/client/zod/context/useRhfUtilsClientForZodContext.d.ts +0 -5
- package/dist/types/client/zod/context/useRhfUtilsZodForm.d.ts +0 -7
- package/dist/types/client/zod/createRhfUtilsClientForZod.d.ts +0 -3
- package/dist/types/errors/flat/context/useFlatFieldErrorsContextHasOnlyOrphans.d.ts +0 -7
- package/dist/types/errors/flat/filterFlatFieldErrors.d.ts +0 -8
- package/dist/types/errors/getRefdFromFlatFieldErrors.d.ts +0 -2
- package/dist/types/errors/isFlatFieldErrorEntryRefd.d.ts +0 -6
- package/dist/types/errors/nonfield/RhfUtilsNonFieldErrorMarkerHtmlAttribute.d.ts +0 -5
- package/dist/types/errors/nonfield/isNonFieldErrorMarkerInDOM.d.ts +0 -6
- package/dist/types/errors/orphan/getIsOrphanFormErrorWithParentElement.d.ts +0 -6
- package/dist/types/errors/orphan/getOrphansFromFlatFieldErrors.d.ts +0 -3
- package/dist/types/errors/orphan/isOrphanFormError.d.ts +0 -3
- package/dist/types/errors/output/consoleErrors.d.ts +0 -6
- package/dist/types/errors/root/RootErrorsListFromFlatFieldErrorsContext.d.ts +0 -2
- package/dist/types/errors/root/getRootsFromFlatFieldErrors.d.ts +0 -2
- package/dist/types/errors/trpc/trpcClientErrorMessageSchema.d.ts +0 -23
- package/dist/types/errors/trpc/trpcClientErrorToFormSubmitFieldErrorsSchemaTransformer.d.ts +0 -27
- package/dist/types/form/Form.d.ts +0 -10
- package/dist/types/form/FormWithProviders.d.ts +0 -12
- package/dist/types/form/RhfUtilsFormProviders.d.ts +0 -11
- package/dist/types/form/UseRhfUtilsFormChildrenProps.d.ts +0 -23
- package/dist/types/form/UseRhfUtilsFormOnSubmitContext.d.ts +0 -28
- package/dist/types/form/UseRhfUtilsFormProps.d.ts +0 -22
- package/dist/types/form/UseRhfUtilsFormReturn.d.ts +0 -19
- package/dist/types/form/_Controller.d.ts +0 -5
- package/dist/types/form/context/group/FormGroupContextProvider.d.ts +0 -4
- package/dist/types/form/context/group/index.d.ts +0 -14
- package/dist/types/form/context/group/useFormGroupChildIsMountedTracker.d.ts +0 -5
- package/dist/types/form/context/group/useFormGroupChildIsSubmittingTracker.d.ts +0 -5
- package/dist/types/form/context/group/useFormGroupChildTracker.d.ts +0 -6
- package/dist/types/form/context/group/useFormGroupIsAnyBusy.d.ts +0 -2
- package/dist/types/form/context/group/useFormGroupIsChildBusy.d.ts +0 -2
- package/dist/types/form/context/group/useFormGroupIsParentBusy.d.ts +0 -2
- package/dist/types/form/context/group/useFormGroupParentTracker.d.ts +0 -7
- package/dist/types/form/context/group/useFormOrParentIsBusy.d.ts +0 -2
- package/dist/types/form/context/utils/RhfUtilsContextProvider.d.ts +0 -8
- package/dist/types/form/context/utils/useRhfUtilsContext.d.ts +0 -13
- package/dist/types/form/context/utils/useRhfUtilsContextRequestSubmit.d.ts +0 -5
- package/dist/types/form/useFormIsBusy.d.ts +0 -2
- package/dist/types/form/useRhfUtilsForm.d.ts +0 -15
- package/dist/types/form/utils/getSubmitterButtonData.d.ts +0 -7
- package/dist/types/register.d.ts +0 -7
- package/dist/types/submit/error/FormSubmitError.d.ts +0 -6
- package/dist/types/submit/error/setCtxErrorsByFormSubmitFieldErrors.d.ts +0 -9
- package/dist/types/submit/useFormOnSubmitted.d.ts +0 -5
- package/dist/types/submit/useSubmitFormOnChange.d.ts +0 -8
- package/dist/types/utils/PassthroughChildren.d.ts +0 -7
- package/dist/types/utils/fixedForwardRef.d.ts +0 -6
- package/dist/types/utils/isEmptyObject.d.ts +0 -2
- package/dist/types/utils/types.d.ts +0 -1
- package/dist/types/utils/useRefIfValueWasTrue.d.ts +0 -2
- package/dist/types/utils/useThrowAsyncError.d.ts +0 -5
- package/dist/types/utils/useToggle.d.ts +0 -3
- /package/dist/{types → dts}/errors/flat/context/FlatFieldErrorsOutputConfig.d.ts +0 -0
- /package/dist/{types → dts}/errors/flat/types.d.ts +0 -0
- /package/dist/{types → dts}/errors/nonfield/RhfUtilsNonFieldErrorMarker.spec.d.ts +0 -0
- /package/dist/{types → dts}/errors/nonfield/RhfUtilsNonFieldErrorMarker.utils.d.ts +0 -0
- /package/dist/{types → dts}/errors/output/types.d.ts +0 -0
- /package/dist/{types → dts}/errors/root/consts.d.ts +0 -0
- /package/dist/{types/form/SafeFieldValues.d.ts → dts/form/rhf/SafeFieldValuesType.d.ts} +0 -0
- /package/dist/{types → dts}/main.d.ts +0 -0
- /package/dist/{types → dts}/utils/timeoutAsync.d.ts +0 -0
- /package/dist/{types → dts}/utils/useDebouncedOnChangeValue.d.ts +0 -0
|
@@ -1,70 +0,0 @@
|
|
|
1
|
-
import { UseFormProps } from 'react-hook-form';
|
|
2
|
-
import { FlatFieldErrorsOutputConfig } from '../../errors/flat/context/FlatFieldErrorsOutputConfig';
|
|
3
|
-
import { RhfUtilsFormOptions } from '../../form/RhfUtilsFormOptions';
|
|
4
|
-
import { UseRhfUtilsFormChildrenProps } from '../../form/UseRhfUtilsFormChildrenProps';
|
|
5
|
-
import { FormSubmitFieldErrors } from '../../submit/error/FormSubmitFieldErrors';
|
|
6
|
-
/**
|
|
7
|
-
* Client configuration object.
|
|
8
|
-
*
|
|
9
|
-
* Options under `defaults` can be overridden at form level.
|
|
10
|
-
*/
|
|
11
|
-
export type RhfUtilsClientConfig = {
|
|
12
|
-
/**
|
|
13
|
-
* Default options for all forms. (Are overridden by form-specific options.)
|
|
14
|
-
*/
|
|
15
|
-
defaults?: {
|
|
16
|
-
/**
|
|
17
|
-
* Default RHF `useForm` settings.
|
|
18
|
-
*
|
|
19
|
-
* (Exposes only non-local props.)
|
|
20
|
-
*/
|
|
21
|
-
rhf?: Pick<UseFormProps, 'mode' | 'reValidateMode' | 'resetOptions' | 'context' | 'shouldFocusError' | 'shouldUnregister' | 'shouldUseNativeValidation' | 'progressive' | 'criteriaMode' | 'delayError'>;
|
|
22
|
-
/**
|
|
23
|
-
* Global settings and defaults.
|
|
24
|
-
*
|
|
25
|
-
* (Extend this type via `Register` type to inject custom options/functionality via `Children` component.)
|
|
26
|
-
*/
|
|
27
|
-
utils?: RhfUtilsFormOptions;
|
|
28
|
-
/**
|
|
29
|
-
* Default props for form element.
|
|
30
|
-
*/
|
|
31
|
-
form?: Omit<React.PropsWithoutRef<JSX.IntrinsicElements['form']>, 'onSubmit'>;
|
|
32
|
-
};
|
|
33
|
-
/**
|
|
34
|
-
* Supply your own `<form>` component.
|
|
35
|
-
*
|
|
36
|
-
* By default, a primitive `<form>` element is used.
|
|
37
|
-
*/
|
|
38
|
-
FormComponent?: React.FC<React.PropsWithChildren<React.HTMLAttributes<HTMLFormElement>>>;
|
|
39
|
-
/**
|
|
40
|
-
* Wrap all form bodies with your own hooks, components, etc.
|
|
41
|
-
*
|
|
42
|
-
* (NOTE: not schema-typed as not possible at this level)
|
|
43
|
-
*
|
|
44
|
-
* Use cases:
|
|
45
|
-
* - custom hooks/behaviors based on `options`
|
|
46
|
-
* - shared header, footer
|
|
47
|
-
*/
|
|
48
|
-
FormChildrenWrapper?: (props: RhfUtilsFormChildrenWrapperProps) => React.ReactNode;
|
|
49
|
-
/**
|
|
50
|
-
* Global submit error handler when/if submit handler throws an error other than {@link FormSubmitError}.
|
|
51
|
-
*
|
|
52
|
-
* Example use case:
|
|
53
|
-
* - transform API errors to {@link FormSubmitFieldErrors}.
|
|
54
|
-
*
|
|
55
|
-
* @returns
|
|
56
|
-
* - if {@link FormSubmitFieldErrors}: merge into context errors.
|
|
57
|
-
* - if `undefined`: do nothing.
|
|
58
|
-
*/
|
|
59
|
-
onSubmitErrorUnknown?: (error: unknown) => FormSubmitFieldErrors | undefined;
|
|
60
|
-
fieldErrors?: {
|
|
61
|
-
/**
|
|
62
|
-
* Configure how/if errors should be outputted.
|
|
63
|
-
*/
|
|
64
|
-
output?: FlatFieldErrorsOutputConfig;
|
|
65
|
-
};
|
|
66
|
-
};
|
|
67
|
-
/**
|
|
68
|
-
* Non-schema-typed version of `UseRhfUtilsFormChildrenProps` for global config.
|
|
69
|
-
*/
|
|
70
|
-
export type RhfUtilsFormChildrenWrapperProps = React.PropsWithChildren<Pick<UseRhfUtilsFormChildrenProps, 'formId' | 'formRef' | 'context' | 'utils' | 'Controller' | 'FormSubmitError'>>;
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import { RhfUtilsClientConfig } from './RhfUtilsClientConfig';
|
|
2
|
-
declare const _RhfUtilsClientConfigContextProvider: import('react').Provider<RhfUtilsClientConfig | undefined>, useRhfUtilsClientConfigMaybeContext: () => RhfUtilsClientConfig | undefined;
|
|
3
|
-
export default useRhfUtilsClientConfigMaybeContext;
|
|
4
|
-
export { _RhfUtilsClientConfigContextProvider };
|
|
@@ -1,2 +0,0 @@
|
|
|
1
|
-
import { CreateRhfUtilsClient, ObjectSchema } from '.';
|
|
2
|
-
export type RhfUtilsClientContext<TObjectSchema extends ObjectSchema<TObjectSchemaInputKey, TObjectSchemaOutputKey>, TObjectSchemaInputKey extends string, TObjectSchemaOutputKey extends string> = CreateRhfUtilsClient<TObjectSchema, TObjectSchemaInputKey, TObjectSchemaOutputKey>;
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
import { default as React } from 'react';
|
|
2
|
-
import { Resolver } from 'react-hook-form';
|
|
3
|
-
import { RhfUtilsClientConfig } from './config/RhfUtilsClientConfig';
|
|
4
|
-
import { SafeFieldValues } from '../form/SafeFieldValues';
|
|
5
|
-
import { UseRhfUtilsFormProps } from '../form/UseRhfUtilsFormProps';
|
|
6
|
-
import { UseRhfUtilsFormReturn } from '../form/UseRhfUtilsFormReturn';
|
|
7
|
-
/**
|
|
8
|
-
* Generic object schema type.
|
|
9
|
-
*/
|
|
10
|
-
export type ObjectSchema<TInputKey extends string, TOutputKey extends string> = Record<TInputKey, SafeFieldValues> & Record<TOutputKey, SafeFieldValues>;
|
|
11
|
-
export type CreateRhfUtilsClient<TObjectSchema extends ObjectSchema<TObjectSchemaInputKey, TObjectSchemaOutputKey>, TObjectSchemaInputKey extends string, TObjectSchemaOutputKey extends string> = {
|
|
12
|
-
useForm: <TSchema extends TObjectSchema, TSchemaInput extends SafeFieldValues = TSchema[TObjectSchemaInputKey], TSchemaOutput extends SafeFieldValues = TSchema[TObjectSchemaOutputKey]>(schema: TSchema, form: UseRhfUtilsFormProps<TSchemaInput, TSchemaOutput>) => UseRhfUtilsFormReturn<TSchemaInput, TSchemaOutput> & {
|
|
13
|
-
FormWithProviders: React.FC<React.PropsWithChildren>;
|
|
14
|
-
};
|
|
15
|
-
FormWithProviders: <TSchema extends TObjectSchema, TSchemaInput extends SafeFieldValues = TSchema[TObjectSchemaInputKey], TSchemaOutput extends SafeFieldValues = TSchema[TObjectSchemaOutputKey]>(props: React.PropsWithChildren<{
|
|
16
|
-
schema: TSchema;
|
|
17
|
-
} & UseRhfUtilsFormProps<TSchemaInput, TSchemaOutput>>) => JSX.Element;
|
|
18
|
-
};
|
|
19
|
-
/**
|
|
20
|
-
* ...
|
|
21
|
-
*
|
|
22
|
-
* (We need to use generics to generate types for schema resolver.)
|
|
23
|
-
*/
|
|
24
|
-
export declare const createRhfUtilsClient: <TObjectSchema extends ObjectSchema<TObjectSchemaInputKey, TObjectSchemaOutputKey>, TObjectSchemaInputKey extends string, TObjectSchemaOutputKey extends string>(resolver: (schema: TObjectSchema) => Resolver<SafeFieldValues, unknown>) => (config: RhfUtilsClientConfig) => CreateRhfUtilsClient<TObjectSchema, TObjectSchemaInputKey, TObjectSchemaOutputKey>;
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import { RhfUtilsFormOptions } from '../form/RhfUtilsFormOptions';
|
|
2
|
-
import { SafeFieldValues } from '../form/SafeFieldValues';
|
|
3
|
-
import { UseRhfUtilsFormProps } from '../form/UseRhfUtilsFormProps';
|
|
4
|
-
import { RhfUtilsClientConfig } from './config/RhfUtilsClientConfig';
|
|
5
|
-
/**
|
|
6
|
-
* Merge {@link RhfUtilsClientConfig.defaults} with array of {@link UseRhfUtilsFormProps}'s overrides.
|
|
7
|
-
*/
|
|
8
|
-
export declare const mergeRhfUtilsClientConfigDefaultsWithUseRhfUtilsFormProps: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>(defaults: RhfUtilsClientConfig["defaults"], ...props: Pick<UseRhfUtilsFormProps<TFieldValues, TTransformedValues>, "rhf" | "utils" | "form">[]) => {
|
|
9
|
-
rhf?: Pick<import('react-hook-form').UseFormProps, "mode" | "reValidateMode" | "resetOptions" | "context" | "shouldFocusError" | "shouldUnregister" | "shouldUseNativeValidation" | "progressive" | "criteriaMode" | "delayError">;
|
|
10
|
-
utils?: RhfUtilsFormOptions;
|
|
11
|
-
form?: Omit<React.PropsWithoutRef<JSX.IntrinsicElements["form"]>, "onSubmit">;
|
|
12
|
-
} | undefined;
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import { default as React } from 'react';
|
|
2
|
-
import { RhfUtilsUseFormChildrenZodProps } from './RhfUtilsUseFormChildrenZodProps';
|
|
3
|
-
import { ZodTypeFieldValues } from './ZodTypeFieldValues';
|
|
4
|
-
/**
|
|
5
|
-
* {@link React.FC} for {@link RhfUtilsUseFormChildrenZodProps}.
|
|
6
|
-
*
|
|
7
|
-
* @example
|
|
8
|
-
* ```tsx
|
|
9
|
-
* const Children: RhfUtilsUseFormChildrenZodFC<typeof schema> = () => {};
|
|
10
|
-
* ```
|
|
11
|
-
*/
|
|
12
|
-
export type RhfUtilsUseFormChildrenZodFC<TSchema extends ZodTypeFieldValues, TChildrenProps> = React.FC<RhfUtilsUseFormChildrenZodProps<TSchema, TChildrenProps>>;
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import { UseRhfUtilsFormChildrenProps } from '../../form/UseRhfUtilsFormChildrenProps';
|
|
2
|
-
import { zodTypeInput, zodTypeOutput } from './consts';
|
|
3
|
-
import { ZodTypeFieldValues } from './ZodTypeFieldValues';
|
|
4
|
-
export type RhfUtilsUseFormChildrenZodProps<TSchema extends ZodTypeFieldValues, TChildrenProps = undefined> = UseRhfUtilsFormChildrenProps<TSchema[typeof zodTypeInput], TSchema[typeof zodTypeOutput], TChildrenProps>;
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { default as React } from 'react';
|
|
2
|
-
import { RhfUtilsClientConfig } from '../../config/RhfUtilsClientConfig';
|
|
3
|
-
type Props = React.PropsWithChildren<{
|
|
4
|
-
config?: RhfUtilsClientConfig;
|
|
5
|
-
}>;
|
|
6
|
-
declare const RhfUtilsClientForZodContextProvider: React.FC<Props>;
|
|
7
|
-
export default RhfUtilsClientForZodContextProvider;
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import { UseRhfUtilsFormProps } from '../../../form/UseRhfUtilsFormProps';
|
|
2
|
-
import { zodTypeInput, zodTypeOutput } from '../consts';
|
|
3
|
-
import { ZodTypeFieldValues } from '../ZodTypeFieldValues';
|
|
4
|
-
type Props<TSchema extends ZodTypeFieldValues> = {
|
|
5
|
-
schema: TSchema;
|
|
6
|
-
} & UseRhfUtilsFormProps<TSchema[typeof zodTypeInput], TSchema[typeof zodTypeOutput]>;
|
|
7
|
-
declare function RhfUtilsZodForm<TSchema extends ZodTypeFieldValues>({ schema, ...props }: Props<TSchema>): import("react/jsx-runtime").JSX.Element;
|
|
8
|
-
export default RhfUtilsZodForm;
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import { default as createRhfUtilsClientForZod } from '../createRhfUtilsClientForZod';
|
|
2
|
-
export type RhfUtilsClientForZodContext = ReturnType<typeof createRhfUtilsClientForZod>;
|
|
3
|
-
declare const _RhfUtilsClientForZodContextProvider: import('react').Provider<import('../..').CreateRhfUtilsClient<import('../ZodTypeFieldValues').ZodTypeFieldValues, "_input", "_output"> | undefined>, useRhfUtilsClientForZodContext: () => import('../..').CreateRhfUtilsClient<import('../ZodTypeFieldValues').ZodTypeFieldValues, "_input", "_output">;
|
|
4
|
-
export default useRhfUtilsClientForZodContext;
|
|
5
|
-
export { _RhfUtilsClientForZodContextProvider };
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { UseRhfUtilsFormProps } from '../../../form/UseRhfUtilsFormProps';
|
|
2
|
-
import { zodTypeInput, zodTypeOutput } from '../consts';
|
|
3
|
-
import { ZodTypeFieldValues } from '../ZodTypeFieldValues';
|
|
4
|
-
declare const useRhfUtilsZodForm: <TSchema extends ZodTypeFieldValues>(schema: TSchema, form: UseRhfUtilsFormProps<TSchema[typeof zodTypeInput], TSchema[typeof zodTypeOutput]>) => import('../../../form/UseRhfUtilsFormReturn').UseRhfUtilsFormReturn<TSchema["_input"], TSchema["_output"]> & {
|
|
5
|
-
FormWithProviders: React.FC<React.PropsWithChildren>;
|
|
6
|
-
};
|
|
7
|
-
export default useRhfUtilsZodForm;
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
import { ZodTypeFieldValues } from './ZodTypeFieldValues';
|
|
2
|
-
declare const createRhfUtilsClientForZod: (config: import('../config/RhfUtilsClientConfig').RhfUtilsClientConfig) => import('..').CreateRhfUtilsClient<ZodTypeFieldValues, "_input", "_output">;
|
|
3
|
-
export default createRhfUtilsClientForZod;
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import { FlatFieldErrorEntry, FlatFieldErrors } from './types';
|
|
2
|
-
/**
|
|
3
|
-
* Filter {@link FlatFieldErrors} by a predicate.
|
|
4
|
-
*
|
|
5
|
-
* (Encapsulates to and from Object entries.)
|
|
6
|
-
*/
|
|
7
|
-
declare const makeFlatFieldErrorsFilter: (predicate: (entry: FlatFieldErrorEntry, index: number) => boolean) => (errors: FlatFieldErrors) => FlatFieldErrors;
|
|
8
|
-
export default makeFlatFieldErrorsFilter;
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Determine if a non-field error marker is in the DOM.
|
|
3
|
-
* Note: this will also look for nested markers to accommodate field arrays
|
|
4
|
-
*/
|
|
5
|
-
declare const isNonFieldErrorMarkerInDOM: (path: string, parentElement: Pick<HTMLElement, "querySelector">) => boolean;
|
|
6
|
-
export default isNonFieldErrorMarkerInDOM;
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import { FlatFieldErrorEntry } from '../flat/types';
|
|
2
|
-
/**
|
|
3
|
-
* Util wrapper for {@link isOrphanFormError} for usage with {@link FlatFieldErrorEntry}.
|
|
4
|
-
*/
|
|
5
|
-
declare const getIsFlatFieldErrorEntryOrphanByParentElement: (parentElement: Pick<HTMLElement, "querySelector">) => ([path, error]: FlatFieldErrorEntry) => boolean;
|
|
6
|
-
export default getIsFlatFieldErrorEntryOrphanByParentElement;
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import { SafeFieldValues } from '../../form/SafeFieldValues';
|
|
2
|
-
/**
|
|
3
|
-
* Output form values and errors to console.
|
|
4
|
-
*/
|
|
5
|
-
declare const consoleErrors: (message: string, values: SafeFieldValues, errors: Record<string, unknown>, type?: "debug" | "error") => void;
|
|
6
|
-
export default consoleErrors;
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
import { z } from 'zod';
|
|
2
|
-
/**
|
|
3
|
-
* Schema for {@link TRPCClientError} message.
|
|
4
|
-
*
|
|
5
|
-
* (Sent from backend as JSON string.)
|
|
6
|
-
*/
|
|
7
|
-
declare const trpcClientErrorMessageSchema: z.ZodObject<{
|
|
8
|
-
validation: z.ZodString;
|
|
9
|
-
code: z.ZodString;
|
|
10
|
-
message: z.ZodString;
|
|
11
|
-
path: z.ZodArray<z.ZodString, "many">;
|
|
12
|
-
}, "strip", z.ZodTypeAny, {
|
|
13
|
-
message: string;
|
|
14
|
-
code: string;
|
|
15
|
-
path: string[];
|
|
16
|
-
validation: string;
|
|
17
|
-
}, {
|
|
18
|
-
message: string;
|
|
19
|
-
code: string;
|
|
20
|
-
path: string[];
|
|
21
|
-
validation: string;
|
|
22
|
-
}>;
|
|
23
|
-
export default trpcClientErrorMessageSchema;
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
import { TRPCClientErrorLike } from '@trpc/client';
|
|
2
|
-
import { AnyTRPCRouter } from '@trpc/server';
|
|
3
|
-
import { z } from 'zod';
|
|
4
|
-
import { FormSubmitFieldErrors } from '../../submit/error/FormSubmitFieldErrors';
|
|
5
|
-
/**
|
|
6
|
-
* Schema that transforms {@link TRPCClientError} to RHF {@link FormSubmitFieldErrors}.
|
|
7
|
-
*/
|
|
8
|
-
declare const trpcClientErrorToFormSubmitFieldErrorsSchemaTransformer: z.ZodEffects<z.ZodEffects<z.ZodPipeline<z.ZodEffects<z.ZodEffects<z.ZodType<TRPCClientErrorLike<AnyTRPCRouter>, z.ZodTypeDef, TRPCClientErrorLike<AnyTRPCRouter>>, string, TRPCClientErrorLike<AnyTRPCRouter>>, unknown, TRPCClientErrorLike<AnyTRPCRouter>>, z.ZodArray<z.ZodObject<{
|
|
9
|
-
validation: z.ZodString;
|
|
10
|
-
code: z.ZodString;
|
|
11
|
-
message: z.ZodString;
|
|
12
|
-
path: z.ZodArray<z.ZodString, "many">;
|
|
13
|
-
}, "strip", z.ZodTypeAny, {
|
|
14
|
-
message: string;
|
|
15
|
-
code: string;
|
|
16
|
-
path: string[];
|
|
17
|
-
validation: string;
|
|
18
|
-
}, {
|
|
19
|
-
message: string;
|
|
20
|
-
code: string;
|
|
21
|
-
path: string[];
|
|
22
|
-
validation: string;
|
|
23
|
-
}>, "many">>, (readonly [string, {
|
|
24
|
-
type: string;
|
|
25
|
-
message: string;
|
|
26
|
-
}])[], TRPCClientErrorLike<AnyTRPCRouter>>, FormSubmitFieldErrors, TRPCClientErrorLike<AnyTRPCRouter>>;
|
|
27
|
-
export default trpcClientErrorToFormSubmitFieldErrorsSchemaTransformer;
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { default as React } from 'react';
|
|
2
|
-
import { SafeFieldValues } from './SafeFieldValues';
|
|
3
|
-
import { UseRhfUtilsFormProps } from './UseRhfUtilsFormProps';
|
|
4
|
-
export type FormChildrenSlots = 'top' | 'bottom';
|
|
5
|
-
export type FormProps<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = {
|
|
6
|
-
formId: string;
|
|
7
|
-
formRef: React.RefObject<HTMLFormElement>;
|
|
8
|
-
} & Pick<UseRhfUtilsFormProps<TFieldValues, TTransformedValues>, 'onSubmit' | 'onSubmitError' | 'onSubmitInvalid' | 'Children' | 'form' | 'utils'>;
|
|
9
|
-
declare function _Form<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>({ formId, formRef, onSubmit, onSubmitError, onSubmitInvalid, Children, form, utils, }: FormProps<TFieldValues, TTransformedValues>): import("react/jsx-runtime").JSX.Element;
|
|
10
|
-
export default _Form;
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import { SafeFieldValues } from './SafeFieldValues';
|
|
2
|
-
import { UseRhfUtilsFormProps } from './UseRhfUtilsFormProps';
|
|
3
|
-
type Props<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = React.PropsWithChildren<UseRhfUtilsFormProps<TFieldValues, TTransformedValues>>;
|
|
4
|
-
/**
|
|
5
|
-
* Form providers (with utils) with immediate descendent {@link Form}.
|
|
6
|
-
* (Syntactic sugar for {@link useRhfUtilsForm}. Use this for most applications.)
|
|
7
|
-
*
|
|
8
|
-
* Use {@link useRhfUtilsForm} if you need to specific nesting hierarchy.
|
|
9
|
-
* (e.g., wrapping `<tr>` with provider and nesting `<form>` within `<td>` to appease HTML rules.)
|
|
10
|
-
*/
|
|
11
|
-
declare function FormWithProviders<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>(props: Props<TFieldValues, TTransformedValues>): import("react/jsx-runtime").JSX.Element;
|
|
12
|
-
export default FormWithProviders;
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { UseFormReturn } from 'react-hook-form';
|
|
2
|
-
import { RhfUtilsFormOptions } from './RhfUtilsFormOptions';
|
|
3
|
-
import { SafeFieldValues } from './SafeFieldValues';
|
|
4
|
-
export type RhfUtilsFormProvidersProps<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = React.PropsWithChildren<{
|
|
5
|
-
formId: string;
|
|
6
|
-
formRef: React.RefObject<HTMLFormElement>;
|
|
7
|
-
rhfForm: UseFormReturn<TFieldValues, unknown, TTransformedValues>;
|
|
8
|
-
utils?: RhfUtilsFormOptions;
|
|
9
|
-
}>;
|
|
10
|
-
declare function RhfUtilsFormProviders<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>({ formId, formRef, rhfForm, utils, children, }: RhfUtilsFormProvidersProps<TFieldValues, TTransformedValues>): import("react/jsx-runtime").JSX.Element;
|
|
11
|
-
export default RhfUtilsFormProviders;
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
import { default as React } from 'react';
|
|
2
|
-
import { UseFormReturn } from 'react-hook-form';
|
|
3
|
-
import { FormSubmitError } from '../submit/error/FormSubmitError';
|
|
4
|
-
import { default as _Controller } from './_Controller';
|
|
5
|
-
import { RhfUtilsFormOptions } from './RhfUtilsFormOptions';
|
|
6
|
-
import { SafeFieldValues } from './SafeFieldValues';
|
|
7
|
-
/**
|
|
8
|
-
* Component props for `Children`.
|
|
9
|
-
*
|
|
10
|
-
* Consider keeping shape in line with `UseRhfUtilsFormOnSubmitProps` and `UseRhfUtilsFormReturn`.
|
|
11
|
-
*/
|
|
12
|
-
export type UseRhfUtilsFormChildrenProps<TFieldValues extends SafeFieldValues = SafeFieldValues, TTransformedValues extends SafeFieldValues = SafeFieldValues, TProps = undefined> = {
|
|
13
|
-
formId: string;
|
|
14
|
-
formRef: React.RefObject<HTMLFormElement>;
|
|
15
|
-
context: UseFormReturn<TFieldValues, unknown, TTransformedValues>;
|
|
16
|
-
utils?: RhfUtilsFormOptions;
|
|
17
|
-
Controller: typeof _Controller<TFieldValues>;
|
|
18
|
-
FormSubmitError: typeof FormSubmitError<TFieldValues>;
|
|
19
|
-
} & (TProps extends undefined ? {
|
|
20
|
-
props?: undefined;
|
|
21
|
-
} : {
|
|
22
|
-
props: TProps;
|
|
23
|
-
});
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
import { default as React } from 'react';
|
|
2
|
-
import { UseFormReturn } from 'react-hook-form';
|
|
3
|
-
import { FormSubmitError } from '../submit/error/FormSubmitError';
|
|
4
|
-
import { FormSubmitFieldErrors } from '../submit/error/FormSubmitFieldErrors';
|
|
5
|
-
import { RhfUtilsFormOptions } from './RhfUtilsFormOptions';
|
|
6
|
-
import { SafeFieldValues } from './SafeFieldValues';
|
|
7
|
-
/**
|
|
8
|
-
* Props for onSubmit other than `data` and `event`.
|
|
9
|
-
*
|
|
10
|
-
* Consider keeping shape in line with `UseRhfUtilsFormChildrenProps` and `UseRhfUtilsFormReturn`.
|
|
11
|
-
*/
|
|
12
|
-
export type UseRhfUtilsFormOnSubmitContext<TFieldValues extends SafeFieldValues = SafeFieldValues, TTransformedValues extends SafeFieldValues = SafeFieldValues> = {
|
|
13
|
-
formId: string;
|
|
14
|
-
formRef: React.RefObject<HTMLFormElement>;
|
|
15
|
-
context: UseFormReturn<TFieldValues, unknown, TTransformedValues>;
|
|
16
|
-
utils?: RhfUtilsFormOptions;
|
|
17
|
-
FormSubmitError: typeof FormSubmitError<TFieldValues>;
|
|
18
|
-
};
|
|
19
|
-
/**
|
|
20
|
-
* Props for onSubmitError other than `error` and `event`.
|
|
21
|
-
*/
|
|
22
|
-
export type UseRhfUtilsFormOnSubmitErrorContext<TFieldValues extends SafeFieldValues = SafeFieldValues, TTransformedValues extends SafeFieldValues = SafeFieldValues> = {
|
|
23
|
-
formId: string;
|
|
24
|
-
formRef: React.RefObject<HTMLFormElement>;
|
|
25
|
-
context: UseFormReturn<TFieldValues, unknown, TTransformedValues>;
|
|
26
|
-
utils?: RhfUtilsFormOptions;
|
|
27
|
-
errors?: FormSubmitFieldErrors;
|
|
28
|
-
};
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
import { default as React } from 'react';
|
|
2
|
-
import { SubmitErrorHandler, UseFormProps } from 'react-hook-form';
|
|
3
|
-
import { MaybePromise } from '../utils/types';
|
|
4
|
-
import { RhfUtilsFormOptions } from './RhfUtilsFormOptions';
|
|
5
|
-
import { SafeFieldValues } from './SafeFieldValues';
|
|
6
|
-
import { UseRhfUtilsFormChildrenProps } from './UseRhfUtilsFormChildrenProps';
|
|
7
|
-
import { UseRhfUtilsFormOnSubmitContext, UseRhfUtilsFormOnSubmitErrorContext } from './UseRhfUtilsFormOnSubmitContext';
|
|
8
|
-
export type UseRhfUtilsFormProps<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = {
|
|
9
|
-
defaultValues?: UseFormProps<TFieldValues>['defaultValues'];
|
|
10
|
-
onSubmit?: (values: TTransformedValues, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => MaybePromise<unknown>;
|
|
11
|
-
/** Submit error handler. (Only for errors not of instance `FormError`, which are handled internally.) */
|
|
12
|
-
onSubmitError?: (error: unknown, context: UseRhfUtilsFormOnSubmitErrorContext<TFieldValues, TTransformedValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => void;
|
|
13
|
-
/** Submit handler when form is invalid. */
|
|
14
|
-
onSubmitInvalid?: SubmitErrorHandler<TFieldValues>;
|
|
15
|
-
Children: React.FC<UseRhfUtilsFormChildrenProps<TFieldValues, TTransformedValues>>;
|
|
16
|
-
/** {@link RhfUseFormProps} props for RHF's {@link useForm}. */
|
|
17
|
-
rhf?: Omit<UseFormProps<TFieldValues>, 'defaultValues'>;
|
|
18
|
-
/** {@link RhfUtilsFormOptions} to enabled utils functionality. */
|
|
19
|
-
utils?: RhfUtilsFormOptions;
|
|
20
|
-
/** {@link FormProps} props for Form. */
|
|
21
|
-
form?: Omit<React.PropsWithoutRef<JSX.IntrinsicElements['form']>, 'onSubmit'>;
|
|
22
|
-
};
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
import { default as React } from 'react';
|
|
2
|
-
import { UseFormReturn } from 'react-hook-form';
|
|
3
|
-
import { FormSubmitError } from '../submit/error/FormSubmitError';
|
|
4
|
-
import { FormProps } from './Form';
|
|
5
|
-
import { RhfUtilsFormProvidersProps } from './RhfUtilsFormProviders';
|
|
6
|
-
import { SafeFieldValues } from './SafeFieldValues';
|
|
7
|
-
/**
|
|
8
|
-
* Return type for `useRhfUtilsForm`.
|
|
9
|
-
*
|
|
10
|
-
* Consider keeping shape in line with `UseRhfUtilsFormChildrenProps` and `UseRhfUtilsFormOnSubmitProps`.
|
|
11
|
-
*/
|
|
12
|
-
export type UseRhfUtilsFormReturn<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = {
|
|
13
|
-
id: string;
|
|
14
|
-
ref: React.RefObject<HTMLFormElement>;
|
|
15
|
-
context: UseFormReturn<TFieldValues, unknown, TTransformedValues>;
|
|
16
|
-
providerProps: RhfUtilsFormProvidersProps<TFieldValues, TTransformedValues>;
|
|
17
|
-
formProps: FormProps<TFieldValues, TTransformedValues>;
|
|
18
|
-
FormSubmitError: typeof FormSubmitError<TFieldValues>;
|
|
19
|
-
};
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import { ControllerProps, FieldPath } from 'react-hook-form';
|
|
2
|
-
import { SafeFieldValues } from './SafeFieldValues';
|
|
3
|
-
export type _ControllerProps<TFieldValues extends SafeFieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = Omit<ControllerProps<TFieldValues, TName>, 'control'>;
|
|
4
|
-
declare function _Controller<TFieldValues extends SafeFieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(props: _ControllerProps<TFieldValues, TName>): import("react/jsx-runtime").JSX.Element;
|
|
5
|
-
export default _Controller;
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
export type FormGroupContext = {
|
|
2
|
-
/** Dependent forms. */
|
|
3
|
-
children: {
|
|
4
|
-
busyIds: string[];
|
|
5
|
-
busyCount: number;
|
|
6
|
-
setBusyId: (id: string, isBusy: boolean) => void;
|
|
7
|
-
};
|
|
8
|
-
/** Main form. */
|
|
9
|
-
parent: {
|
|
10
|
-
isBusy: boolean;
|
|
11
|
-
setIsBusy: (isBusy: boolean) => void;
|
|
12
|
-
};
|
|
13
|
-
};
|
|
14
|
-
export declare const _FormGroupContextProvider: import('react').Provider<FormGroupContext | undefined>, _useFormGroupContext: () => FormGroupContext, _useFormGroupContextMaybe: () => FormGroupContext | undefined;
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import { RhfUtilsFormOptions } from '../../RhfUtilsFormOptions';
|
|
2
|
-
type Props = React.PropsWithChildren<{
|
|
3
|
-
formId: string;
|
|
4
|
-
formRef: React.RefObject<HTMLFormElement>;
|
|
5
|
-
options?: RhfUtilsFormOptions;
|
|
6
|
-
}>;
|
|
7
|
-
declare const RhfUtilsContextProvider: React.FC<Props>;
|
|
8
|
-
export default RhfUtilsContextProvider;
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import { RhfUtilsFormOptions } from '../../RhfUtilsFormOptions';
|
|
2
|
-
export type RhfUtilsContext = {
|
|
3
|
-
formId: string;
|
|
4
|
-
formRef: React.RefObject<HTMLFormElement>;
|
|
5
|
-
options: RhfUtilsFormOptions | undefined;
|
|
6
|
-
};
|
|
7
|
-
declare const _RhfUtilsContextProvider: import('react').Provider<RhfUtilsContext | undefined>;
|
|
8
|
-
/**
|
|
9
|
-
* Use utils from the current form context.
|
|
10
|
-
*/
|
|
11
|
-
declare const useRhfUtilsContext: () => RhfUtilsContext;
|
|
12
|
-
export default useRhfUtilsContext;
|
|
13
|
-
export { _RhfUtilsContextProvider };
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import { SafeFieldValues } from './SafeFieldValues';
|
|
2
|
-
import { UseRhfUtilsFormProps } from './UseRhfUtilsFormProps';
|
|
3
|
-
import { UseRhfUtilsFormReturn } from './UseRhfUtilsFormReturn';
|
|
4
|
-
/**
|
|
5
|
-
* Core Rhf Form hook. Use `Form` in `index.ts` for most cases.
|
|
6
|
-
* Use this if you need to separate form components.
|
|
7
|
-
* e.g., a form for table row due to `form` being considered invalid HTML around `tr` tags.
|
|
8
|
-
* With this hook, you can wrap the `tr` tag with `form.Provider` and use `form.Form` inside
|
|
9
|
-
* one of the cells. Other components can be outside form while referring to form by its id via `form` attribute.
|
|
10
|
-
* see https://caniuse.com/?search=form%20attribute
|
|
11
|
-
* @returns Form provider and form.
|
|
12
|
-
*/
|
|
13
|
-
declare const useRhfUtilsForm: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>({ defaultValues, onSubmit, onSubmitError, onSubmitInvalid, Children, rhf, form, utils, }: UseRhfUtilsFormProps<TFieldValues, TTransformedValues>) => UseRhfUtilsFormReturn<TFieldValues, TTransformedValues>;
|
|
14
|
-
export default useRhfUtilsForm;
|
|
15
|
-
export type UseRhfUtilsForm<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = typeof useRhfUtilsForm<TFieldValues, TTransformedValues>;
|
|
@@ -1,7 +0,0 @@
|
|
|
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
|
-
declare const getSubmitterButtonData: (event: React.BaseSyntheticEvent) => [name: string, value: string] | undefined;
|
|
7
|
-
export default getSubmitterButtonData;
|