@paragrav/rhf-utils 0.65.0 → 0.67.0

package/dist/tsdown/index.d.ts

@@ -0,0 +1,207 @@
+import { a as UseRhfUtilsFormOnSubmitContext, c as FormSubmitFieldErrors, i as MaybePromise, l as RhfUseFormInstanceProps, n as RhfUtilsFormInjectorProps, o as UseRhfUtilsFormOnSubmitErrorContext, r as _Controller, s as FormSubmitError, t as RhfUtilsClientConfig, u as useFlatFieldErrorsContext } from "./RhfUtilsClientConfigType-CeOJzNAc.js";
+import { a as RhfUtilsFormOptions, i as SafeFieldValues, n as RhfUtilsContextProviderProps, r as LastSubmitState, t as RhfUtilsContext } from "./RhfUtilsContextType-BFmDtONY.js";
+import { t as FormRelayOptions } from "./FormRelayOptions-mBqiP41Z.js";
+import React$1 from "react";
+import { Resolver, SubmitErrorHandler, UseFormProps, UseFormReturn } from "react-hook-form";
+import { z } from "zod";
+import { Register } from "@/Register";
+
+//#region src/client/config/context/RhfUtilsClientConfigProvider.d.ts
+type Props$4 = React$1.PropsWithChildren<{
+  config?: RhfUtilsClientConfig;
+}>;
+declare const RhfUtilsClientConfigProvider: React$1.FC<Props$4>;
+//#endregion
+//#region src/errors/flat/context/useFlatFieldErrorsContextHasOnlyOrphans.d.ts
+/**
+ * Returns `true` if all errors are orphans.
+ *
+ * You may want to treat this case specifically.
+ */
+declare const useFlatFieldErrorsContextHasOnlyOrphans: () => boolean;
+//#endregion
+//#region src/errors/nonfield/RhfUtilsNonFieldErrorMarker.d.ts
+type Props$3 = {
+  /** Flat field name. (e.g., `address.street`) */path: string;
+};
+/**
+ * Empty, hidden marker to indicate a non-field/non-root error is being displayed to user.
+ *
+ * Example use case:
+ * Field array with minimum items.
+ * (When there are no items, the error is not associated with a field and is displayed separately.)
+ */
+declare const RhfUtilsNonFieldErrorMarker: React.FC<Props$3>;
+//#endregion
+//#region src/form/context/utils/useRhfUtilsContext.d.ts
+declare const _RhfUtilsContextProvider: import("react").Provider<RhfUtilsContext | undefined>, useRhfUtilsContext: () => RhfUtilsContextProviderProps & {
+    lastSubmitStateRef: import("react").RefObject<LastSubmitState>;
+  }, useRhfUtilsMaybeContext: () => RhfUtilsContext | undefined;
+//#endregion
+//#region src/form/RHF_UseFormReturnWithoutProxiesType.d.ts
+/**
+ * RHF's {@link UseFormReturn} without proxies -- i.e., `formState`.
+ *
+ * (Proxy values must be invoked or read individually before render.)
+ *
+ * @see https://react-hook-form.com/docs/useform/formstate
+ * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy
+ *
+ * @description
+ *
+ * Hiding them from consumer's callbacks, will force explicit usage before first render.
+ */
+type RHF_UseFormReturnWithoutProxies<TFieldValues extends SafeFieldValues = SafeFieldValues, TTransformedValues extends SafeFieldValues = TFieldValues> = Omit<UseFormReturn<TFieldValues, unknown, TTransformedValues>, 'formState'>;
+//#endregion
+//#region src/form/UseRhfUtilsFormChildrenPropsType.d.ts
+/**
+ * Component props for `Children`.
+ *
+ * (Consider keeping shape in line with `UseRhfUtilsFormOnSubmitProps` and `UseRhfUtilsFormReturn`.)
+ */
+type UseRhfUtilsFormChildrenProps<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TProps = undefined> = RhfUtilsContext & {
+  rhf: UseFormReturn<TFieldValues, unknown, TTransformedValues>;
+  options: RhfUtilsFormOptions;
+  Controller: typeof _Controller<TFieldValues>;
+  FormSubmitError: typeof FormSubmitError<TFieldValues>;
+} & {
+  onCancel?: () => MaybePromise<void>;
+} & // cancel
+(TProps extends undefined ? {
+  props?: undefined;
+} : {
+  props: TProps;
+});
+//#endregion
+//#region src/form/utils/useFormRequestSubmit.d.ts
+/**
+ * Get callback to trigger submit manually on form.
+ *
+ * Note: `submitter` is optional, but is required to be a submit button.
+ *
+ * @link https://developer.mozilla.org/docs/Web/API/HTMLFormElement/requestSubmit
+ */
+declare const useFormRequestSubmit: (ref: React$1.RefObject<HTMLFormElement | null>) => HTMLFormElement["requestSubmit"];
+//#endregion
+//#region src/submit/last-error/useLastSubmitError.d.ts
+declare const useLastSubmitError: () => {
+  error: unknown;
+  event: React.BaseSyntheticEvent;
+} | undefined;
+//#endregion
+//#region src/form/defaults/form/UseRhfUtilsFormInstanceFormProps.d.ts
+type DataAttributes = Record<`data-${string}`, string>;
+type FormAttributes = React$1.PropsWithoutRef<React$1.JSX.IntrinsicElements['form']> & DataAttributes;
+type UseRhfUtilsFormInstanceFormProps = Omit<FormAttributes, 'id' | 'onSubmit'>;
+//#endregion
+//#region src/form/with-handlers-and-children/RhfUtilsFormPropsOnBeforeSubmitInvariants.d.ts
+type RhfUtilsFormPropsOnBeforeSubmitInvariants<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TApiValues extends undefined | SafeFieldValues> = (data: {
+  input: TFieldValues;
+  output: TTransformedValues;
+  api: TApiValues;
+}, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues, TApiValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => MaybePromise<{
+  field: keyof TFieldValues | keyof TApiValues;
+  message: string;
+  validate: boolean | undefined | null;
+}[]>;
+//#endregion
+//#region src/form/with-handlers-and-children/RhfUtilsFormProps.d.ts
+type RhfUtilsFormPropsGetApiValues<TTransformedValues extends SafeFieldValues, TApiValues> = (data: TTransformedValues) => TApiValues;
+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)> = {
+  getApiData?: TGetApiValues; /** Cancellation handler -- channeled through {@link RhfUtilsClientConfig.useCanFormBeCancelled} before propagating to `Children` component. */
+  onCancel?: () => MaybePromise<void>; /** Submit handler when form is invalid. */
+  onSubmitInvalid?: SubmitErrorHandler<TFieldValues>;
+  /**
+   * List of invariants to run against input/output/api data.
+   * For any and all false-y values, a {@link FormSubmitFieldErrors} will be thrown.
+   */
+  onBeforeSubmitInvariants?: RhfUtilsFormPropsOnBeforeSubmitInvariants<TFieldValues, TTransformedValues, TApiValues>;
+  onBeforeSubmit?: (data: {
+    input: TFieldValues;
+    output: TTransformedValues;
+    api: TApiValues;
+  }, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues, TApiValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => MaybePromise<unknown>;
+  onSubmit?: (data: {
+    input: TFieldValues;
+    output: TTransformedValues;
+    api: TApiValues;
+  }, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues, TApiValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => MaybePromise<TOnSubmitReturnType>;
+  onSubmitSuccess?: (submitResponse: TOnSubmitReturnType, data: {
+    input: TFieldValues;
+    output: TTransformedValues;
+    api: TApiValues;
+  }, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues, TApiValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => MaybePromise<unknown>; /** Submit error handler. (Only for errors not of instance `FormError`, which are handled internally.) */
+  onSubmitError?: (error: unknown, context: UseRhfUtilsFormOnSubmitErrorContext<TFieldValues, TTransformedValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => void;
+  onSubmitFinally?: () => MaybePromise<void>;
+  Children: React.FC<UseRhfUtilsFormChildrenProps<TFieldValues, TTransformedValues>>;
+  form?: UseRhfUtilsFormInstanceFormProps; /** Form class attribute. */
+  className?: string;
+};
+//#endregion
+//#region src/resolvers/zod/consts.d.ts
+/** Schema key that returns input type. */
+declare const zodTypeInput: "_input";
+/** Schema keys that returns output type. */
+declare const zodTypeOutput: "_output";
+//#endregion
+//#region src/resolvers/zod/ZodTypeSafeFieldValuesType.d.ts
+type ZodTypeOfSafeFieldValues = z.ZodType<SafeFieldValues, z.ZodObjectDef>;
+type ZodTypeSafeFieldValues = ZodTypeOfSafeFieldValues | z.ZodEffects<ZodTypeOfSafeFieldValues>;
+//#endregion
+//#region src/resolvers/zod/form/RhfUtilsZodForm.d.ts
+type Props$2<TSchema extends ZodTypeSafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TSchema[typeof zodTypeOutput], SafeFieldValues>, TOnSubmitReturnType, TApiValues extends undefined | SafeFieldValues = (TGetApiValues extends RhfUtilsFormPropsGetApiValues<TSchema[typeof zodTypeOutput], infer U> ? U : undefined)> = React.PropsWithChildren<RhfUtilsFormProps<TSchema[typeof zodTypeInput], TSchema[typeof zodTypeOutput], TGetApiValues, TOnSubmitReturnType, TApiValues>>;
+declare const RhfUtilsZodForm: <TSchema extends ZodTypeSafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TSchema[typeof zodTypeOutput], SafeFieldValues>, TOnSubmitReturnType, TApiValues extends undefined | SafeFieldValues = (TGetApiValues extends RhfUtilsFormPropsGetApiValues<TSchema[typeof zodTypeOutput], infer U> ? U : undefined)>(props: Props$2<TSchema, TGetApiValues, TOnSubmitReturnType, TApiValues>) => import("react").JSX.Element;
+//#endregion
+//#region src/form/providers/RhfUtilsFormProvidersPropsType.d.ts
+/**
+ * RhfUtils form providers props.
+ */
+type RhfUtilsFormProvidersProps<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = {
+  /** Globally-unique form id. (Used in DOM. Auto-generated if not supplied.) */formId?: string;
+  resolver?: Resolver<TFieldValues, unknown, TTransformedValues>;
+  rhf?: RhfUseFormInstanceProps<TFieldValues, TTransformedValues>;
+  defaultValues?: UseFormProps<TFieldValues, unknown, TTransformedValues>['defaultValues'];
+  options?: RhfUtilsFormOptions;
+  relay?: FormRelayOptions;
+};
+//#endregion
+//#region src/resolvers/zod/providers/RhfUtilsZodFormProviders.d.ts
+type Props$1<TSchema extends ZodTypeSafeFieldValues> = React.PropsWithChildren<{
+  schema: TSchema;
+} & RhfUtilsFormProvidersProps<TSchema[typeof zodTypeInput], TSchema[typeof zodTypeOutput]>>;
+declare const RhfUtilsZodFormProviders: <TSchema extends ZodTypeSafeFieldValues>({
+  schema,
+  children,
+  ...props
+}: Props$1<TSchema>) => import("react").JSX.Element;
+//#endregion
+//#region src/resolvers/zod/with-providers/RhfUtilsZodFormWithProviders.d.ts
+type Props<TSchema extends ZodTypeSafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TTransformedValues, SafeFieldValues>, TOnSubmitReturnType, TFieldValues extends TSchema[typeof zodTypeInput] = TSchema[typeof zodTypeInput], TTransformedValues extends TSchema[typeof zodTypeOutput] = TSchema[typeof zodTypeOutput], TApiValues extends undefined | SafeFieldValues = (TGetApiValues extends RhfUtilsFormPropsGetApiValues<TTransformedValues, infer U> ? U : undefined)> = React.PropsWithChildren<{
+  schema: TSchema;
+} & Omit<RhfUtilsFormProvidersProps<TFieldValues, TTransformedValues>, 'resolver'> & RhfUtilsFormProps<TFieldValues, TTransformedValues, TGetApiValues, TOnSubmitReturnType, TApiValues>>;
+declare const RhfUtilsZodFormWithProviders: <TSchema extends ZodTypeSafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TTransformedValues, SafeFieldValues>, TOnSubmitReturnType, TFieldValues extends TSchema[typeof zodTypeInput] = TSchema[typeof zodTypeInput], TTransformedValues extends TSchema[typeof zodTypeOutput] = TSchema[typeof zodTypeOutput], TApiValues extends undefined | SafeFieldValues = (TGetApiValues extends RhfUtilsFormPropsGetApiValues<TTransformedValues, infer U> ? U : undefined)>({
+  schema,
+  ...props
+}: Props<TSchema, TGetApiValues, TOnSubmitReturnType, TFieldValues, TTransformedValues, TApiValues>) => import("react").JSX.Element;
+//#endregion
+//#region src/resolvers/zod/RhfUtilsUseZodFormChildrenPropsType.d.ts
+type RhfUtilsUseZodFormChildrenProps<TSchema extends ZodTypeSafeFieldValues, TChildrenProps = undefined> = UseRhfUtilsFormChildrenProps<TSchema[typeof zodTypeInput], TSchema[typeof zodTypeOutput], TChildrenProps>;
+//#endregion
+//#region src/resolvers/zod/RhfUtilsUseZodFormChildrenFCType.d.ts
+/**
+ * {@link React.FC} for {@link RhfUtilsUseZodFormChildrenProps}.
+ */
+type RhfUtilsUseZodFormChildrenFC<TSchema extends ZodTypeSafeFieldValues, TChildrenProps = undefined> = React$1.FC<RhfUtilsUseZodFormChildrenProps<TSchema, TChildrenProps>>;
+//#endregion
+//#region src/_exports/index.d.ts
+/**
+* @license @paragrav/rhf-utils
+*
+* Copyright (c) 2024-present paragrav.dev
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+//#endregion
+export { FormSubmitError, type FormSubmitFieldErrors, type Register, type RhfUtilsClientConfig, RhfUtilsClientConfigProvider, type RhfUtilsFormInjectorProps, type RhfUtilsFormOptions, RhfUtilsNonFieldErrorMarker, type RhfUtilsUseZodFormChildrenFC, type RhfUtilsUseZodFormChildrenProps, RhfUtilsZodForm, RhfUtilsZodFormProviders, RhfUtilsZodFormWithProviders, type SafeFieldValues, type RHF_UseFormReturnWithoutProxies as UseFormReturnWithoutProxies, type UseRhfUtilsFormChildrenProps, type UseRhfUtilsFormOnSubmitContext, type UseRhfUtilsFormOnSubmitErrorContext, type ZodTypeSafeFieldValues, useFlatFieldErrorsContext, useFlatFieldErrorsContextHasOnlyOrphans, useFormRequestSubmit, useLastSubmitError, useRhfUtilsContext };