@depup/react-hook-form 7.72.0-depup.0

package/dist/types/fieldArray.d.ts

@@ -0,0 +1,195 @@
+import type { FieldValues } from './fields';
+import type { Control } from './form';
+import type { FieldArrayPath, FieldArrayPathValue } from './path';
+import type { RegisterOptions, Validate } from './validator';
+export type UseFieldArrayProps<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>, TKeyName extends string = 'id', TTransformedValues = TFieldValues> = {
+    name: TFieldArrayName;
+    keyName?: TKeyName;
+    control?: Control<TFieldValues, any, TTransformedValues>;
+    rules?: {
+        validate?: Validate<FieldArray<TFieldValues, TFieldArrayName>[], TFieldValues> | Record<string, Validate<FieldArray<TFieldValues, TFieldArrayName>[], TFieldValues>>;
+    } & Pick<RegisterOptions<TFieldValues>, 'maxLength' | 'minLength' | 'required'>;
+    shouldUnregister?: boolean;
+};
+/**
+ * `useFieldArray` returned `fields` with unique id
+ */
+export type FieldArrayWithId<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>, TKeyName extends string = 'id'> = FieldArray<TFieldValues, TFieldArrayName> & Record<TKeyName, string>;
+export type FieldArray<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = FieldArrayPathValue<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 type FieldArrayMethodProps = {
+    shouldFocus?: boolean;
+    focusIndex?: number;
+    focusName?: string;
+};
+/**
+ * Swap field array by supplying from and to index
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/docs/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 type UseFieldArraySwap = (indexA: number, indexB: number) => void;
+/**
+ * Move field array by supplying from and to index
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/docs/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 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/docs/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 type UseFieldArrayPrepend<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (value: FieldArray<TFieldValues, TFieldArrayName> | 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/docs/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param value - append items or items.
+ * @param options - focus options
+ *
+ * @example
+ * ```tsx
+ * <button type="button" onClick={() => append({ name: "data" })}>Append</button>
+ * <button type="button" onClick={() => append({ name: "data" }, { shouldFocus: false })}>Append</button>
+ * <button
+ *   type="button"
+ *   onClick={() => append([{ name: "data" }, { name: "data" }])}
+ * >
+ *   Append
+ * </button>
+ * ```
+ */
+export type UseFieldArrayAppend<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (value: FieldArray<TFieldValues, TFieldArrayName> | FieldArray<TFieldValues, TFieldArrayName>[], options?: FieldArrayMethodProps) => void;
+/**
+ * Remove field/fields at particular position.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/docs/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 type UseFieldArrayRemove = (index?: number | number[]) => void;
+/**
+ * Insert field/fields at particular position and focus.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/docs/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 type UseFieldArrayInsert<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (index: number, value: FieldArray<TFieldValues, TFieldArrayName> | FieldArray<TFieldValues, TFieldArrayName>[], options?: FieldArrayMethodProps) => void;
+/**
+ * Update field/fields at particular position.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/docs/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>
+ * ```
+ */
+export type UseFieldArrayUpdate<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (index: number, value: FieldArray<TFieldValues, TFieldArrayName>) => void;
+/**
+ * Replace the entire field array values.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/docs/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param value - the entire field values.
+ *
+ * @example
+ * ```tsx
+ * <button
+ *   type="button"
+ *   onClick={() => replace([{ name: "data" }, { name: "data" }])}
+ * >
+ *   Replace
+ * </button>
+ * ```
+ */
+export type UseFieldArrayReplace<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (value: FieldArray<TFieldValues, TFieldArrayName> | FieldArray<TFieldValues, TFieldArrayName>[]) => void;
+export type UseFieldArrayReturn<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>, TKeyName extends string = 'id'> = {
+    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, TKeyName>[];
+};
+//# sourceMappingURL=fieldArray.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fieldArray.d.ts","sourceRoot":"","sources":["../../src/types/fieldArray.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,KAAK,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAClE,OAAO,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE7D,MAAM,MAAM,kBAAkB,CAC5B,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAClD,cAAc,CAAC,YAAY,CAAC,EAC9B,QAAQ,SAAS,MAAM,GAAG,IAAI,EAC9B,kBAAkB,GAAG,YAAY,IAC/B;IACF,IAAI,EAAE,eAAe,CAAC;IACtB,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC,YAAY,EAAE,GAAG,EAAE,kBAAkB,CAAC,CAAC;IACzD,KAAK,CAAC,EAAE;QACN,QAAQ,CAAC,EACL,QAAQ,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,EAAE,YAAY,CAAC,GACnE,MAAM,CACJ,MAAM,EACN,QAAQ,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,EAAE,YAAY,CAAC,CACpE,CAAC;KACP,GAAG,IAAI,CACN,eAAe,CAAC,YAAY,CAAC,EAC7B,WAAW,GAAG,WAAW,GAAG,UAAU,CACvC,CAAC;IACF,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAC1B,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAClD,cAAc,CAAC,YAAY,CAAC,EAC9B,QAAQ,SAAS,MAAM,GAAG,IAAI,IAC5B,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AAEzE,MAAM,MAAM,UAAU,CACpB,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAClD,cAAc,CAAC,YAAY,CAAC,IAE9B,mBAAmB,CAAC,YAAY,EAAE,eAAe,CAAC,SAC9C,aAAa,CAAC,MAAM,CAAC,CAAC,GACtB,IAAI,GACJ,SAAS,GACT,CAAC,GACD,KAAK,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,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,MAAM,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;AAEzE;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;AAEzE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,oBAAoB,CAC9B,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAClD,cAAc,CAAC,YAAY,CAAC,IAC5B,CACF,KAAK,EACD,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,GACzC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,EAC/C,OAAO,CAAC,EAAE,qBAAqB,KAC5B,IAAI,CAAC;AAEV;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,mBAAmB,CAC7B,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAClD,cAAc,CAAC,YAAY,CAAC,IAC5B,CACF,KAAK,EACD,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,GACzC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,EAC/C,OAAO,CAAC,EAAE,qBAAqB,KAC5B,IAAI,CAAC;AAEV;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,IAAI,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,mBAAmB,CAC7B,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAClD,cAAc,CAAC,YAAY,CAAC,IAC5B,CACF,KAAK,EAAE,MAAM,EACb,KAAK,EACD,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,GACzC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,EAC/C,OAAO,CAAC,EAAE,qBAAqB,KAC5B,IAAI,CAAC;AAEV;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,mBAAmB,CAC7B,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAClD,cAAc,CAAC,YAAY,CAAC,IAC5B,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,KAAK,IAAI,CAAC;AAE9E;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,oBAAoB,CAC9B,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAClD,cAAc,CAAC,YAAY,CAAC,IAC5B,CACF,KAAK,EACD,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,GACzC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,KAC5C,IAAI,CAAC;AAEV,MAAM,MAAM,mBAAmB,CAC7B,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAClD,cAAc,CAAC,YAAY,CAAC,EAC9B,QAAQ,SAAS,MAAM,GAAG,IAAI,IAC5B;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,EAAE,QAAQ,CAAC,EAAE,CAAC;CACrE,CAAC"}

package/dist/types/fields.d.ts

@@ -0,0 +1,31 @@
+import type { IsFlatObject, Noop } from './utils';
+import type { RegisterOptions } from './validator';
+export type InternalFieldName = string;
+export type FieldName<TFieldValues extends FieldValues> = IsFlatObject<TFieldValues> extends true ? Extract<keyof TFieldValues, string> : string;
+export type CustomElement<TFieldValues extends FieldValues> = Partial<HTMLElement> & {
+    name: FieldName<TFieldValues>;
+    type?: string;
+    value?: any;
+    disabled?: boolean;
+    checked?: boolean;
+    options?: HTMLOptionsCollection;
+    files?: FileList | null;
+    focus?: Noop;
+};
+export type FieldValue<TFieldValues extends FieldValues> = TFieldValues[InternalFieldName];
+export type FieldValues = Record<string, any>;
+export type NativeFieldValue = string | number | boolean | null | undefined | unknown[];
+export type FieldElement<TFieldValues extends FieldValues = FieldValues> = HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement | CustomElement<TFieldValues>;
+export type Ref = FieldElement;
+export type Field = {
+    _f: {
+        ref: Ref;
+        name: InternalFieldName;
+        refs?: HTMLInputElement[];
+        mount?: boolean;
+    } & RegisterOptions;
+};
+export type FieldRefs = Partial<{
+    [key: InternalFieldName]: Field | FieldRefs;
+}>;
+//# sourceMappingURL=fields.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../src/types/fields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAEvC,MAAM,MAAM,SAAS,CAAC,YAAY,SAAS,WAAW,IACpD,YAAY,CAAC,YAAY,CAAC,SAAS,IAAI,GACnC,OAAO,CAAC,MAAM,YAAY,EAAE,MAAM,CAAC,GACnC,MAAM,CAAC;AAEb,MAAM,MAAM,aAAa,CAAC,YAAY,SAAS,WAAW,IACxD,OAAO,CAAC,WAAW,CAAC,GAAG;IACrB,IAAI,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAChC,KAAK,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IACxB,KAAK,CAAC,EAAE,IAAI,CAAC;CACd,CAAC;AAEJ,MAAM,MAAM,UAAU,CAAC,YAAY,SAAS,WAAW,IACrD,YAAY,CAAC,iBAAiB,CAAC,CAAC;AAElC,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE9C,MAAM,MAAM,gBAAgB,GACxB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,GACT,OAAO,EAAE,CAAC;AAEd,MAAM,MAAM,YAAY,CAAC,YAAY,SAAS,WAAW,GAAG,WAAW,IACnE,gBAAgB,GAChB,iBAAiB,GACjB,mBAAmB,GACnB,aAAa,CAAC,YAAY,CAAC,CAAC;AAEhC,MAAM,MAAM,GAAG,GAAG,YAAY,CAAC;AAE/B,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE;QACF,GAAG,EAAE,GAAG,CAAC;QACT,IAAI,EAAE,iBAAiB,CAAC;QACxB,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC;QAC1B,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB,GAAG,eAAe,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC;IAC9B,CAAC,GAAG,EAAE,iBAAiB,GAAG,KAAK,GAAG,SAAS,CAAC;CAC7C,CAAC,CAAC"}