react-hook-form 8.0.0-alpha.0 → 8.0.0-alpha.1

package/dist/logic/createFormControl.d.ts

@@ -1,3 +1,3 @@
 import { FieldValues, UseFormProps, UseFormReturn } from '../types';
-export declare function createFormControl<TFieldValues extends FieldValues = FieldValues, TContext extends object = object>(props?: UseFormProps<TFieldValues, TContext>): Omit<UseFormReturn<TFieldValues, TContext>, 'formState'>;
+export declare function createFormControl<TFieldValues extends FieldValues = FieldValues, TContext = any>(props?: UseFormProps<TFieldValues, TContext>): Omit<UseFormReturn<TFieldValues, TContext>, 'formState'>;
 //# sourceMappingURL=createFormControl.d.ts.map

package/dist/logic/createFormControl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createFormControl.d.ts","sourceRoot":"","sources":["../../src/logic/createFormControl.ts"],"names":[],"mappings":"AACA,OAAO,EAYL,WAAW,EAeX,YAAY,EAIZ,aAAa,EASd,MAAM,UAAU,CAAC;AAiDlB,wBAAgB,iBAAiB,CAC/B,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,QAAQ,SAAS,MAAM,GAAG,MAAM,EAEhC,KAAK,GAAE,YAAY,CAAC,YAAY,EAAE,QAAQ,CAAM,GAC/C,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,WAAW,CAAC,CAyoC1D"}
+{"version":3,"file":"createFormControl.d.ts","sourceRoot":"","sources":["../../src/logic/createFormControl.ts"],"names":[],"mappings":"AACA,OAAO,EAYL,WAAW,EAcX,YAAY,EAIZ,aAAa,EASd,MAAM,UAAU,CAAC;AAiDlB,wBAAgB,iBAAiB,CAC/B,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,QAAQ,GAAG,GAAG,EAEd,KAAK,GAAE,YAAY,CAAC,YAAY,EAAE,QAAQ,CAAM,GAC/C,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,WAAW,CAAC,CA0nC1D"}

package/dist/types/controller.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 import { RegisterOptions } from './validator';
-import { Auto, Control, FieldError, FieldPathValue, FieldValues, Noop, PathString, RefCallBack, UnpackNestedValue, UseFormStateReturn } from './';
+import { Auto, Control, FieldError, FieldPathValue, FieldValues, Noop, PathString, RefCallBack, UseFormStateReturn } from './';
 export declare type ControllerFieldState = {
     invalid: boolean;
     isTouched: boolean;
@@ -10,7 +10,7 @@ export declare type ControllerFieldState = {
 export declare type ControllerRenderProps<TFieldValues extends FieldValues, TName extends PathString> = {
     onChange: (...event: any[]) => void;
     onBlur: Noop;
-    value: UnpackNestedValue<FieldPathValue<TFieldValues, TName>>;
+    value: FieldPathValue<TFieldValues, TName>;
     name: TName;
     ref: RefCallBack;
 };
@@ -18,7 +18,7 @@ export declare type UseControllerProps<TFieldValues extends FieldValues, TName e
     name: Auto.FieldPath<TFieldValues, TName>;
     rules?: Omit<RegisterOptions<TFieldValues, TName>, 'valueAsNumber' | 'valueAsDate' | 'setValueAs' | 'disabled'>;
     shouldUnregister?: boolean;
-    defaultValue?: UnpackNestedValue<FieldPathValue<TFieldValues, TName>>;
+    defaultValue?: FieldPathValue<TFieldValues, TName>;
     control?: Control<TFieldValues>;
 };
 export declare type UseControllerReturn<TFieldValues extends FieldValues, TName extends PathString> = {
@@ -26,6 +26,27 @@ export declare type UseControllerReturn<TFieldValues extends FieldValues, TName
     formState: UseFormStateReturn<TFieldValues>;
     fieldState: ControllerFieldState;
 };
+/**
+ * Render function to provide the control for the field.
+ *
+ * @returns all the event handler, and relevant field and form state.
+ *
+ * @example
+ * ```tsx
+ * const { field, fieldState, formState } = useController();
+ *
+ * <Controller
+ *   render={({ field, formState, fieldState }) => ({
+ *     <input
+ *       onChange={field.onChange}
+ *       onBlur={field.onBlur}
+ *       name={field.name}
+ *       ref={field.ref} // optional for focus management
+ *     />
+ *   })}
+ * />
+ * ```
+ */
 export declare type ControllerProps<TFieldValues extends FieldValues, TName extends PathString> = {
     render: ({ field, fieldState, formState, }: {
         field: ControllerRenderProps<TFieldValues, TName>;

package/dist/types/controller.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../src/types/controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EACL,IAAI,EACJ,OAAO,EACP,UAAU,EACV,cAAc,EACd,WAAW,EACX,IAAI,EACJ,UAAU,EACV,WAAW,EACX,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,IAAI,CAAC;AAEZ,oBAAY,oBAAoB,GAAG;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB,CAAC;AAEF,oBAAY,qBAAqB,CAC/B,YAAY,SAAS,WAAW,EAChC,KAAK,SAAS,UAAU,IACtB;IACF,QAAQ,EAAE,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IACpC,MAAM,EAAE,IAAI,CAAC;IACb,KAAK,EAAE,iBAAiB,CAAC,cAAc,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC;IAC9D,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,WAAW,CAAC;CAClB,CAAC;AAEF,oBAAY,kBAAkB,CAC5B,YAAY,SAAS,WAAW,EAChC,KAAK,SAAS,UAAU,IACtB;IACF,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IAC1C,KAAK,CAAC,EAAE,IAAI,CACV,eAAe,CAAC,YAAY,EAAE,KAAK,CAAC,EACpC,eAAe,GAAG,aAAa,GAAG,YAAY,GAAG,UAAU,CAC5D,CAAC;IACF,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,iBAAiB,CAAC,cAAc,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC;IACtE,OAAO,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;CACjC,CAAC;AAEF,oBAAY,mBAAmB,CAC7B,YAAY,SAAS,WAAW,EAChC,KAAK,SAAS,UAAU,IACtB;IACF,KAAK,EAAE,qBAAqB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IAClD,SAAS,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;IAC5C,UAAU,EAAE,oBAAoB,CAAC;CAClC,CAAC;AAEF,oBAAY,eAAe,CACzB,YAAY,SAAS,WAAW,EAChC,KAAK,SAAS,UAAU,IACtB;IACF,MAAM,EAAE,CAAC,EACP,KAAK,EACL,UAAU,EACV,SAAS,GACV,EAAE;QACD,KAAK,EAAE,qBAAqB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QAClD,UAAU,EAAE,oBAAoB,CAAC;QACjC,SAAS,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;KAC7C,KAAK,KAAK,CAAC,YAAY,CAAC;CAC1B,GAAG,kBAAkB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC"}
+{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../src/types/controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EACL,IAAI,EACJ,OAAO,EACP,UAAU,EACV,cAAc,EACd,WAAW,EACX,IAAI,EACJ,UAAU,EACV,WAAW,EACX,kBAAkB,EACnB,MAAM,IAAI,CAAC;AAEZ,oBAAY,oBAAoB,GAAG;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB,CAAC;AAEF,oBAAY,qBAAqB,CAC/B,YAAY,SAAS,WAAW,EAChC,KAAK,SAAS,UAAU,IACtB;IACF,QAAQ,EAAE,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IACpC,MAAM,EAAE,IAAI,CAAC;IACb,KAAK,EAAE,cAAc,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IAC3C,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,WAAW,CAAC;CAClB,CAAC;AAEF,oBAAY,kBAAkB,CAC5B,YAAY,SAAS,WAAW,EAChC,KAAK,SAAS,UAAU,IACtB;IACF,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IAC1C,KAAK,CAAC,EAAE,IAAI,CACV,eAAe,CAAC,YAAY,EAAE,KAAK,CAAC,EACpC,eAAe,GAAG,aAAa,GAAG,YAAY,GAAG,UAAU,CAC5D,CAAC;IACF,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,cAAc,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IACnD,OAAO,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;CACjC,CAAC;AAEF,oBAAY,mBAAmB,CAC7B,YAAY,SAAS,WAAW,EAChC,KAAK,SAAS,UAAU,IACtB;IACF,KAAK,EAAE,qBAAqB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IAClD,SAAS,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;IAC5C,UAAU,EAAE,oBAAoB,CAAC;CAClC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,oBAAY,eAAe,CACzB,YAAY,SAAS,WAAW,EAChC,KAAK,SAAS,UAAU,IACtB;IACF,MAAM,EAAE,CAAC,EACP,KAAK,EACL,UAAU,EACV,SAAS,GACV,EAAE;QACD,KAAK,EAAE,qBAAqB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QAClD,UAAU,EAAE,oBAAoB,CAAC;QACjC,SAAS,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;KAC7C,KAAK,KAAK,CAAC,YAAY,CAAC;CAC1B,GAAG,kBAAkB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC"}

package/dist/types/errors.d.ts

@@ -1,5 +1,5 @@
 import { FieldValues, InternalFieldName, Ref } from './fields';
-import { DeepMap, DeepPartial, LiteralUnion } from './utils';
+import { LiteralUnion } from './utils';
 import { RegisterOptions, ValidateResult } from './validator';
 export declare type Message = string;
 export declare type MultipleFieldErrors = {
@@ -18,6 +18,12 @@ export declare type ErrorOption = {
     type?: LiteralUnion<keyof RegisterOptions, string>;
     types?: MultipleFieldErrors;
 };
-export declare type FieldErrors<TFieldValues extends FieldValues = FieldValues> = DeepMap<DeepPartial<TFieldValues>, FieldError>;
+declare type Merge<A, B> = {
+    [K in keyof A | keyof B]?: K extends keyof A ? K extends keyof B ? [A[K], B[K]] extends [object, object] ? Merge<A[K], B[K]> : A[K] | B[K] : A[K] : K extends keyof B ? B[K] : never;
+};
+export declare type FieldErrors<T extends FieldValues = FieldValues> = {
+    [K in keyof T]?: T[K] extends object ? Merge<FieldError, FieldErrors<T[K]>> : FieldError;
+};
 export declare type InternalFieldErrors = Partial<Record<InternalFieldName, FieldError>>;
+export {};
 //# sourceMappingURL=errors.d.ts.map

package/dist/types/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/types/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE9D,oBAAY,OAAO,GAAG,MAAM,CAAC;AAE7B,oBAAY,mBAAmB,GAAG;KAC/B,CAAC,IAAI,MAAM,eAAe,CAAC,CAAC,EAAE,cAAc;CAC9C,GAAG;IACF,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAC;CAC/B,CAAC;AAEF,oBAAY,UAAU,GAAG;IACvB,IAAI,EAAE,YAAY,CAAC,MAAM,eAAe,EAAE,MAAM,CAAC,CAAC;IAClD,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,oBAAY,WAAW,GAAG;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,YAAY,CAAC,MAAM,eAAe,EAAE,MAAM,CAAC,CAAC;IACnD,KAAK,CAAC,EAAE,mBAAmB,CAAC;CAC7B,CAAC;AAEF,oBAAY,WAAW,CAAC,YAAY,SAAS,WAAW,GAAG,WAAW,IACpE,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE,UAAU,CAAC,CAAC;AAEjD,oBAAY,mBAAmB,GAAG,OAAO,CACvC,MAAM,CAAC,iBAAiB,EAAE,UAAU,CAAC,CACtC,CAAC"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/types/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE9D,oBAAY,OAAO,GAAG,MAAM,CAAC;AAE7B,oBAAY,mBAAmB,GAAG;KAC/B,CAAC,IAAI,MAAM,eAAe,CAAC,CAAC,EAAE,cAAc;CAC9C,GAAG;IACF,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAC;CAC/B,CAAC;AAEF,oBAAY,UAAU,GAAG;IACvB,IAAI,EAAE,YAAY,CAAC,MAAM,eAAe,EAAE,MAAM,CAAC,CAAC;IAClD,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,oBAAY,WAAW,GAAG;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,YAAY,CAAC,MAAM,eAAe,EAAE,MAAM,CAAC,CAAC;IACnD,KAAK,CAAC,EAAE,mBAAmB,CAAC;CAC7B,CAAC;AAEF,aAAK,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI;KAChB,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,GACxC,CAAC,SAAS,MAAM,CAAC,GACf,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,GACnC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GACjB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GACb,CAAC,CAAC,CAAC,CAAC,GACN,CAAC,SAAS,MAAM,CAAC,GACjB,CAAC,CAAC,CAAC,CAAC,GACJ,KAAK;CACV,CAAC;AAEF,oBAAY,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI;KAC5D,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAChC,KAAK,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACpC,UAAU;CACf,CAAC;AAEF,oBAAY,mBAAmB,GAAG,OAAO,CACvC,MAAM,CAAC,iBAAiB,EAAE,UAAU,CAAC,CACtC,CAAC"}

package/dist/types/fieldArray.d.ts

@@ -6,22 +6,186 @@ export declare type UseFieldArrayProps<TFieldValues extends FieldValues, TFieldA
     control?: Control<TFieldValues>;
     shouldUnregister?: boolean;
 };
+/**
+ * `useFieldArray` returned `fields` with unique id
+ */
 export declare type FieldArrayWithId<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends PathString = never> = FieldArray<TFieldValues, TFieldArrayName> & Record<'id', string>;
 export declare type FieldArray<TFieldValues extends FieldValues, TFieldArrayName extends PathString> = FieldPathValue<TFieldValues, TFieldArrayName> extends ReadonlyArray<infer U> | null | undefined ? U : never;
+/**
+ * `useFieldArray` focus option, ability to toggle focus on and off with `shouldFocus` and setting focus by either field index or name.
+ */
 export declare type FieldArrayMethodProps = {
     shouldFocus?: boolean;
     focusIndex?: number;
     focusName?: string;
 };
+/**
+ * Swap field array by supplying from and to index
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param indexA - from index
+ * @param indexB - to index
+ *
+ * @example
+ * ```tsx
+ * <button type="button" onClick={() => swap(0, 1)}>swap</button>
+ * ```
+ */
+export declare type UseFieldArraySwap = (indexA: number, indexB: number) => void;
+/**
+ * Move field array by supplying from and to index
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param indexA - from index
+ * @param indexB - to index
+ *
+ * @example
+ * ```tsx
+ * <button type="button" onClick={() => move(0, 1)}>swap</button>
+ * ```
+ */
+export declare type UseFieldArrayMove = (indexA: number, indexB: number) => void;
+/**
+ * Prepend field/fields to the start of the fields and optionally focus. The input value will be registered during this action.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param value - prepend items or items
+ * @param options - focus options
+ *
+ * @example
+ * ```tsx
+ * <button type="button" onClick={() => prepend({ name: "data" })}>Prepend</button>
+ * <button type="button" onClick={() => prepend({ name: "data" }, { shouldFocus: false })}>Prepend</button>
+ * <button
+ *   type="button"
+ *   onClick={() => prepend([{ name: "data" }, { name: "data" }])}
+ * >
+ *   Prepend
+ * </button>
+ * ```
+ */
+export declare type UseFieldArrayPrepend<TFieldValues, TFieldArrayName extends PathString> = (value: Partial<FieldArray<TFieldValues, TFieldArrayName>> | Partial<FieldArray<TFieldValues, TFieldArrayName>>[], options?: FieldArrayMethodProps) => void;
+/**
+ * Append field/fields to the end of your fields and focus. The input value will be registered during this action.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param value - append items or items.
+ * @param options - focus options
+ *
+ * @example
+ * ```tsx
+ * <button type="button" onClick={() => prepend({ name: "data" })}>Append</button>
+ * <button type="button" onClick={() => prepend({ name: "data" }, { shouldFocus: false })}>Append</button>
+ * <button
+ *   type="button"
+ *   onClick={() => append([{ name: "data" }, { name: "data" }])}
+ * >
+ *   Append
+ * </button>
+ * ```
+ */
+export declare type UseFieldArrayAppend<TFieldValues, TFieldArrayName extends PathString> = (value: Partial<FieldArray<TFieldValues, TFieldArrayName>> | Partial<FieldArray<TFieldValues, TFieldArrayName>>[], options?: FieldArrayMethodProps) => void;
+/**
+ * Remove field/fields at particular position.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param index - index to remove at, or remove all when no index provided.
+ *
+ * @example
+ * ```tsx
+ * <button type="button" onClick={() => remove(0)}>Remove</button>
+ * <button
+ *   type="button"
+ *   onClick={() => remove()}
+ * >
+ *   Remove all
+ * </button>
+ * ```
+ */
+export declare type UseFieldArrayRemove = (index?: number | number[]) => void;
+/**
+ * Insert field/fields at particular position and focus.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param index - insert position
+ * @param value - insert field or fields
+ * @param options - focus options
+ *
+ * @example
+ * ```tsx
+ * <button type="button" onClick={() => insert(1, { name: "data" })}>Insert</button>
+ * <button type="button" onClick={() => insert(1, { name: "data" }, { shouldFocus: false })}>Insert</button>
+ * <button
+ *   type="button"
+ *   onClick={() => insert(1, [{ name: "data" }, { name: "data" }])}
+ * >
+ *   Insert
+ * </button>
+ * ```
+ */
+export declare type UseFieldArrayInsert<TFieldValues, TFieldArrayName extends PathString> = (index: number, value: Partial<FieldArray<TFieldValues, TFieldArrayName>> | Partial<FieldArray<TFieldValues, TFieldArrayName>>[], options?: FieldArrayMethodProps) => void;
+/**
+ * Update field/fields at particular position.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param index - insert position
+ * @param value - insert field or fields
+ *
+ * @example
+ * ```tsx
+ * <button type="button" onClick={() => update(1, { name: "data" })}>Update</button>
+ * <button
+ *   type="button"
+ *   onClick={() => update(1, [{ name: "data" }, { name: "data" }])}
+ * >
+ *   Update
+ * </button>
+ * ```
+ */
+declare type UseFieldArrayUpdate<TFieldValues, TFieldArrayName extends PathString> = (index: number, value: FieldArray<TFieldValues, TFieldArrayName>) => void;
+/**
+ * 	Replace the entire field array values.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param value - the entire field values.
+ *
+ * @example
+ * ```tsx
+ * <button
+ *   type="button"
+ *   onClick={() => update([{ name: "data" }, { name: "data" }])}
+ * >
+ *   Replace
+ * </button>
+ * ```
+ */
+declare type UseFieldArrayReplace<TFieldValues extends FieldValues, TFieldArrayName extends PathString> = (value: Partial<FieldArray<TFieldValues, TFieldArrayName>> | Partial<FieldArray<TFieldValues, TFieldArrayName>>[]) => void;
 export declare type UseFieldArrayReturn<TFieldValues extends FieldValues, TFieldArrayName extends PathString> = {
-    swap: (indexA: number, indexB: number) => void;
-    move: (indexA: number, indexB: number) => void;
-    prepend: (value: Partial<FieldArray<TFieldValues, TFieldArrayName>> | Partial<FieldArray<TFieldValues, TFieldArrayName>>[], options?: FieldArrayMethodProps) => void;
-    append: (value: Partial<FieldArray<TFieldValues, TFieldArrayName>> | Partial<FieldArray<TFieldValues, TFieldArrayName>>[], options?: FieldArrayMethodProps) => void;
-    remove: (index?: number | number[]) => void;
-    insert: (index: number, value: Partial<FieldArray<TFieldValues, TFieldArrayName>> | Partial<FieldArray<TFieldValues, TFieldArrayName>>[], options?: FieldArrayMethodProps) => void;
-    update: (index: number, value: Partial<FieldArray<TFieldValues, TFieldArrayName>>) => void;
-    replace: (value: Partial<FieldArray<TFieldValues, TFieldArrayName>> | Partial<FieldArray<TFieldValues, TFieldArrayName>>[]) => void;
+    swap: UseFieldArraySwap;
+    move: UseFieldArrayMove;
+    prepend: UseFieldArrayPrepend<TFieldValues, TFieldArrayName>;
+    append: UseFieldArrayAppend<TFieldValues, TFieldArrayName>;
+    remove: UseFieldArrayRemove;
+    insert: UseFieldArrayInsert<TFieldValues, TFieldArrayName>;
+    update: UseFieldArrayUpdate<TFieldValues, TFieldArrayName>;
+    replace: UseFieldArrayReplace<TFieldValues, TFieldArrayName>;
     fields: FieldArrayWithId<TFieldValues, TFieldArrayName>[];
 };
+export {};
 //# sourceMappingURL=fieldArray.d.ts.map

package/dist/types/fieldArray.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fieldArray.d.ts","sourceRoot":"","sources":["../../src/types/fieldArray.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAE1D,oBAAY,kBAAkB,CAC5B,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,UAAU,IAChC;IACF,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;IACzD,OAAO,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IAChC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,oBAAY,gBAAgB,CAC1B,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,eAAe,SAAS,UAAU,GAAG,KAAK,IACxC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAErE,oBAAY,UAAU,CACpB,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,UAAU,IAChC,cAAc,CAAC,YAAY,EAAE,eAAe,CAAC,SAC7C,aAAa,CAAC,MAAM,CAAC,CAAC,GACtB,IAAI,GACJ,SAAS,GACT,CAAC,GACD,KAAK,CAAC;AAEV,oBAAY,qBAAqB,GAAG;IAClC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,oBAAY,mBAAmB,CAC7B,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,UAAU,IAChC;IACF,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/C,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/C,OAAO,EAAE,CACP,KAAK,EACD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,GAClD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,EAAE,EACxD,OAAO,CAAC,EAAE,qBAAqB,KAC5B,IAAI,CAAC;IACV,MAAM,EAAE,CACN,KAAK,EACD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,GAClD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,EAAE,EACxD,OAAO,CAAC,EAAE,qBAAqB,KAC5B,IAAI,CAAC;IACV,MAAM,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,IAAI,CAAC;IAC5C,MAAM,EAAE,CACN,KAAK,EAAE,MAAM,EACb,KAAK,EACD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,GAClD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,EAAE,EACxD,OAAO,CAAC,EAAE,qBAAqB,KAC5B,IAAI,CAAC;IACV,MAAM,EAAE,CACN,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,KACtD,IAAI,CAAC;IACV,OAAO,EAAE,CACP,KAAK,EACD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,GAClD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,EAAE,KACrD,IAAI,CAAC;IACV,MAAM,EAAE,gBAAgB,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,CAAC;CAC3D,CAAC"}
+{"version":3,"file":"fieldArray.d.ts","sourceRoot":"","sources":["../../src/types/fieldArray.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAE1D,oBAAY,kBAAkB,CAC5B,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,UAAU,IAChC;IACF,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;IACzD,OAAO,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IAChC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,oBAAY,gBAAgB,CAC1B,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,eAAe,SAAS,UAAU,GAAG,KAAK,IACxC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAErE,oBAAY,UAAU,CACpB,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,UAAU,IAChC,cAAc,CAAC,YAAY,EAAE,eAAe,CAAC,SAC7C,aAAa,CAAC,MAAM,CAAC,CAAC,GACtB,IAAI,GACJ,SAAS,GACT,CAAC,GACD,KAAK,CAAC;AAEV;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,oBAAY,iBAAiB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;AAEzE;;;;;;;;;;;;;GAaG;AACH,oBAAY,iBAAiB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;AAEzE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,oBAAY,oBAAoB,CAC9B,YAAY,EACZ,eAAe,SAAS,UAAU,IAChC,CACF,KAAK,EACD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,GAClD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,EAAE,EACxD,OAAO,CAAC,EAAE,qBAAqB,KAC5B,IAAI,CAAC;AAEV;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,oBAAY,mBAAmB,CAC7B,YAAY,EACZ,eAAe,SAAS,UAAU,IAChC,CACF,KAAK,EACD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,GAClD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,EAAE,EACxD,OAAO,CAAC,EAAE,qBAAqB,KAC5B,IAAI,CAAC;AAEV;;;;;;;;;;;;;;;;;;GAkBG;AACH,oBAAY,mBAAmB,GAAG,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,IAAI,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,oBAAY,mBAAmB,CAC7B,YAAY,EACZ,eAAe,SAAS,UAAU,IAChC,CACF,KAAK,EAAE,MAAM,EACb,KAAK,EACD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,GAClD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,EAAE,EACxD,OAAO,CAAC,EAAE,qBAAqB,KAC5B,IAAI,CAAC;AAEV;;;;;;;;;;;;;;;;;;;GAmBG;AACH,aAAK,mBAAmB,CAAC,YAAY,EAAE,eAAe,SAAS,UAAU,IAAI,CAC3E,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,KAC7C,IAAI,CAAC;AAEV;;;;;;;;;;;;;;;;;GAiBG;AACH,aAAK,oBAAoB,CACvB,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,UAAU,IAChC,CACF,KAAK,EACD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,GAClD,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,EAAE,KACrD,IAAI,CAAC;AAEV,oBAAY,mBAAmB,CAC7B,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,UAAU,IAChC;IACF,IAAI,EAAE,iBAAiB,CAAC;IACxB,IAAI,EAAE,iBAAiB,CAAC;IACxB,OAAO,EAAE,oBAAoB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;IAC7D,MAAM,EAAE,mBAAmB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;IAC3D,MAAM,EAAE,mBAAmB,CAAC;IAC5B,MAAM,EAAE,mBAAmB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;IAC3D,MAAM,EAAE,mBAAmB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;IAC3D,OAAO,EAAE,oBAAoB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;IAC7D,MAAM,EAAE,gBAAgB,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,CAAC;CAC3D,CAAC"}