react-hook-form 7.17.0 → 7.17.1

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.
@@ -1,38 +1,37 @@
1
1
  import * as React from 'react';
2
- import { FieldErrors } from '..';
3
2
  import { RegisterOptions } from './validator';
4
- import { Control, FieldError, FieldPathValue, FieldPathWithValue, FieldValues, IsAny, NestedValue, Primitive, RefCallBack, UnpackNestedValue, UseFormStateReturn } from './';
5
- declare type ControllerFieldError<TFieldValues extends FieldValues = FieldValues, TResult = any, TName extends FieldPathWithValue<TFieldValues, TResult> = FieldPathWithValue<TFieldValues, TResult>, FieldValuesAtPath = IsAny<TResult> extends true ? FieldPathValue<TFieldValues, TName> : TResult> = FieldValuesAtPath extends NestedValue | Primitive ? FieldError : FieldErrors<FieldValuesAtPath>;
6
- export declare type ControllerFieldState<TFieldValues extends FieldValues = FieldValues, TResult = any, TName extends FieldPathWithValue<TFieldValues, TResult> = FieldPathWithValue<TFieldValues, TResult>> = {
3
+ import { Control, DeepMapImpl, DeepPartialImpl, FieldError, FieldPath, FieldPathValue, FieldValues, RefCallBack, UnionLike, UnpackNestedValue, UseFormStateReturn } from './';
4
+ declare type ControllerFieldError<T> = DeepMapImpl<DeepPartialImpl<UnionLike<T>>, FieldError>;
5
+ export declare type ControllerFieldState<TFieldValues extends FieldValues = FieldValues, TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
7
6
  invalid: boolean;
8
7
  isTouched: boolean;
9
8
  isDirty: boolean;
10
- error?: ControllerFieldError<TFieldValues, TResult, TName>;
9
+ error?: ControllerFieldError<FieldPathValue<TFieldValues, TFieldName>>;
11
10
  };
12
- export declare type ControllerRenderProps<TFieldValues extends FieldValues = FieldValues, TResult = any, TName extends FieldPathWithValue<TFieldValues, TResult> = FieldPathWithValue<TFieldValues, TResult>> = {
11
+ export declare type ControllerRenderProps<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
13
12
  onChange: (...event: any[]) => void;
14
13
  onBlur: () => void;
15
- value: IsAny<TResult> extends true ? UnpackNestedValue<FieldPathValue<TFieldValues, TName>> : UnpackNestedValue<TResult>;
14
+ value: UnpackNestedValue<FieldPathValue<TFieldValues, TName>>;
16
15
  name: TName;
17
16
  ref: RefCallBack;
18
17
  };
19
- export declare type UseControllerProps<TFieldValues extends FieldValues = FieldValues, TResult = any, TName extends FieldPathWithValue<TFieldValues, TResult> = FieldPathWithValue<TFieldValues, TResult>> = {
18
+ export declare type UseControllerProps<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
20
19
  name: TName;
21
20
  rules?: Omit<RegisterOptions<TFieldValues, TName>, 'valueAsNumber' | 'valueAsDate' | 'setValueAs' | 'disabled'>;
22
21
  shouldUnregister?: boolean;
23
- defaultValue?: IsAny<TResult> extends true ? UnpackNestedValue<FieldPathValue<TFieldValues, TName>> : UnpackNestedValue<TResult>;
22
+ defaultValue?: UnpackNestedValue<FieldPathValue<TFieldValues, TName>>;
24
23
  control?: Control<TFieldValues>;
25
24
  };
26
- export declare type UseControllerReturn<TFieldValues extends FieldValues = FieldValues, TResult = any, TName extends FieldPathWithValue<TFieldValues, TResult> = FieldPathWithValue<TFieldValues, TResult>> = {
27
- field: ControllerRenderProps<TFieldValues, TResult, TName>;
25
+ export declare type UseControllerReturn<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
26
+ field: ControllerRenderProps<TFieldValues, TName>;
28
27
  formState: UseFormStateReturn<TFieldValues>;
29
- fieldState: ControllerFieldState<TFieldValues, TResult, TName>;
28
+ fieldState: ControllerFieldState<TFieldValues, TName>;
30
29
  };
31
- export declare type ControllerProps<TFieldValues extends FieldValues = FieldValues, TResult = any, TName extends FieldPathWithValue<TFieldValues, TResult> = FieldPathWithValue<TFieldValues, TResult>> = {
30
+ export declare type ControllerProps<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
32
31
  render: ({ field, fieldState, formState, }: {
33
- field: ControllerRenderProps<TFieldValues, TResult, TName>;
34
- fieldState: ControllerFieldState<TFieldValues, TResult, TName>;
32
+ field: ControllerRenderProps<TFieldValues, TName>;
33
+ fieldState: ControllerFieldState<TFieldValues, TName>;
35
34
  formState: UseFormStateReturn<TFieldValues>;
36
35
  }) => React.ReactElement;
37
- } & UseControllerProps<TFieldValues, TResult, TName>;
36
+ } & UseControllerProps<TFieldValues, TName>;
38
37
  export {};
@@ -149,22 +149,21 @@ export declare type Names = {
149
149
  focus: InternalFieldName;
150
150
  watchAll: boolean;
151
151
  };
152
- export declare type BatchFieldArrayUpdate = <T extends Function, TFieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>, TKeyName extends string = 'id'>(keyName: TKeyName, name: InternalFieldName, method: T, args: {
152
+ export declare type BatchFieldArrayUpdate = <T extends Function, TFieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>, TKeyName extends string = 'id'>(name: InternalFieldName, method: T, args: {
153
153
  argA?: unknown;
154
154
  argB?: unknown;
155
155
  }, updatedFieldArrayValues?: Partial<FieldArrayWithId<TFieldValues, TFieldArrayName, TKeyName>>[], shouldSetValue?: boolean, shouldSetFields?: boolean) => void;
156
156
  export declare type Control<TFieldValues extends FieldValues = FieldValues, TContext extends object = object> = {
157
- _shouldUnregister?: boolean;
158
157
  _subjects: Subjects<TFieldValues>;
159
- _removeFields: () => void;
158
+ _removeUnmounted: () => void;
160
159
  _names: Names;
161
160
  _stateFlags: {
162
161
  mount: boolean;
163
162
  action: boolean;
164
163
  watch: boolean;
165
164
  };
166
- _updateProps: (props: UseFormProps<TFieldValues, TContext>) => void;
167
- _getIsDirty: GetIsDirty;
165
+ _options: UseFormProps<TFieldValues, TContext>;
166
+ _getDirty: GetIsDirty;
168
167
  _formState: FormState<TFieldValues>;
169
168
  _updateValid: () => void;
170
169
  _fields: FieldRefs;
@@ -174,7 +173,7 @@ export declare type Control<TFieldValues extends FieldValues = FieldValues, TCon
174
173
  _getWatch: WatchInternal<TFieldValues>;
175
174
  register: UseFormRegister<TFieldValues>;
176
175
  _updateFieldArray: BatchFieldArrayUpdate;
177
- _getFieldArrayValue: <TFieldArrayValues>(name: InternalFieldName) => Partial<TFieldArrayValues>[];
176
+ _getFieldArray: <TFieldArrayValues>(name: InternalFieldName) => Partial<TFieldArrayValues>[];
178
177
  unregister: UseFormUnregister<TFieldValues>;
179
178
  };
180
179
  export declare type WatchObserver<TFieldValues> = (value: UnpackNestedValue<TFieldValues>, info: {
@@ -21,14 +21,14 @@ export declare type IsFlatObject<T extends object> = Extract<Exclude<T[keyof T],
21
21
  declare type IsTuple<T extends ReadonlyArray<any>> = number extends T['length'] ? false : true;
22
22
  declare type TupleKey<T extends ReadonlyArray<any>> = Exclude<keyof T, keyof any[]>;
23
23
  declare type ArrayKey = number;
24
- declare type PathImpl<K extends string | number, V> = V extends Primitive ? `${K}` : `${K}` | `${K}.${Path<V>}`;
24
+ declare type PathImpl<K extends string | number, V> = V extends ReadonlyArray<any> | Record<any, unknown> ? `${K}` | `${K}.${Path<V>}` : `${K}`;
25
25
  export declare type Path<T> = T extends ReadonlyArray<infer V> ? IsTuple<T> extends true ? {
26
26
  [K in TupleKey<T>]-?: PathImpl<K & string, T[K]>;
27
27
  }[TupleKey<T>] : PathImpl<ArrayKey, V> : {
28
28
  [K in keyof T]-?: PathImpl<K & string, T[K]>;
29
29
  }[keyof T];
30
30
  export declare type FieldPath<TFieldValues extends FieldValues> = Path<TFieldValues>;
31
- declare type ArrayPathImpl<K extends string | number, V> = V extends Primitive ? never : V extends ReadonlyArray<infer U> ? U extends Primitive ? never : `${K}` | `${K}.${ArrayPath<V>}` : `${K}.${ArrayPath<V>}`;
31
+ declare type ArrayPathImpl<K extends string | number, V> = IsAny<V> extends true ? `${K}` | `${K}.${ArrayPath<V>}` : V extends ReadonlyArray<infer U> ? U extends ReadonlyArray<any> | Record<any, unknown> ? `${K}` | `${K}.${ArrayPath<V>}` : never : V extends Record<any, unknown> ? `${K}.${ArrayPath<V>}` : never;
32
32
  export declare type ArrayPath<T> = T extends ReadonlyArray<infer V> ? IsTuple<T> extends true ? {
33
33
  [K in TupleKey<T>]-?: ArrayPathImpl<K & string, T[K]>;
34
34
  }[TupleKey<T>] : ArrayPathImpl<ArrayKey, V> : {
@@ -52,7 +52,4 @@ export declare type UnionLike<T> = [T] extends [Date | FileList | File | NestedV
52
52
  } : [T] extends [Record<any, unknown>] ? PartialBy<{
53
53
  [K in UnionKeys<T>]: UnionLike<UnionValues<T, K>>;
54
54
  }, Exclude<UnionKeys<T>, keyof T> | OptionalKeys<T>> : T;
55
- export declare type FieldPathWithValue<TFieldValues extends FieldValues, TResult = unknown, FieldPaths extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
56
- [key in FieldPaths]: FieldPathValue<TFieldValues, key> extends TResult ? key : never;
57
- }[FieldPaths];
58
55
  export {};
@@ -1,2 +1,2 @@
1
- import { FieldPathWithValue, FieldValues, UseControllerProps, UseControllerReturn } from './types';
2
- export declare function useController<TFieldValues extends FieldValues = FieldValues, TResult = any, TName extends FieldPathWithValue<TFieldValues, TResult> = FieldPathWithValue<TFieldValues, TResult>>(props: UseControllerProps<TFieldValues, TResult, TName>): UseControllerReturn<TFieldValues, TResult, TName>;
1
+ import { FieldPath, FieldValues, UseControllerProps, UseControllerReturn } from './types';
2
+ export declare function useController<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(props: UseControllerProps<TFieldValues, TName>): UseControllerReturn<TFieldValues, TName>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "react-hook-form",
3
3
  "description": "Performant, flexible and extensible forms library for React Hooks",
4
- "version": "7.17.0",
4
+ "version": "7.17.1",
5
5
  "main": "dist/index.cjs.js",
6
6
  "module": "dist/index.esm.js",
7
7
  "umd:main": "dist/index.umd.js",