react-hook-form 7.17.1 → 7.17.2
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 +12 -0
- package/dist/index.cjs.js +1 -1
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +45 -35
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +1 -1
- package/dist/index.umd.js.map +1 -1
- package/dist/types/controller.d.ts +6 -8
- package/dist/types/fields.d.ts +2 -2
- package/dist/types/form.d.ts +4 -4
- package/dist/types/utils.d.ts +18 -10
- package/dist/useSubscribe.d.ts +3 -2
- package/dist/utils/Subject.d.ts +3 -2
- package/package.json +1 -1
@@ -1,16 +1,15 @@
|
|
1
1
|
import * as React from 'react';
|
2
2
|
import { RegisterOptions } from './validator';
|
3
|
-
import { Control,
|
4
|
-
declare type
|
5
|
-
export declare type ControllerFieldState<TFieldValues extends FieldValues = FieldValues, TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
|
3
|
+
import { Control, FieldError, FieldPath, FieldPathValue, FieldValues, Noop, RefCallBack, UnpackNestedValue, UseFormStateReturn } from './';
|
4
|
+
export declare type ControllerFieldState = {
|
6
5
|
invalid: boolean;
|
7
6
|
isTouched: boolean;
|
8
7
|
isDirty: boolean;
|
9
|
-
error?:
|
8
|
+
error?: FieldError;
|
10
9
|
};
|
11
10
|
export declare type ControllerRenderProps<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
|
12
11
|
onChange: (...event: any[]) => void;
|
13
|
-
onBlur:
|
12
|
+
onBlur: Noop;
|
14
13
|
value: UnpackNestedValue<FieldPathValue<TFieldValues, TName>>;
|
15
14
|
name: TName;
|
16
15
|
ref: RefCallBack;
|
@@ -25,13 +24,12 @@ export declare type UseControllerProps<TFieldValues extends FieldValues = FieldV
|
|
25
24
|
export declare type UseControllerReturn<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
|
26
25
|
field: ControllerRenderProps<TFieldValues, TName>;
|
27
26
|
formState: UseFormStateReturn<TFieldValues>;
|
28
|
-
fieldState: ControllerFieldState
|
27
|
+
fieldState: ControllerFieldState;
|
29
28
|
};
|
30
29
|
export declare type ControllerProps<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
|
31
30
|
render: ({ field, fieldState, formState, }: {
|
32
31
|
field: ControllerRenderProps<TFieldValues, TName>;
|
33
|
-
fieldState: ControllerFieldState
|
32
|
+
fieldState: ControllerFieldState;
|
34
33
|
formState: UseFormStateReturn<TFieldValues>;
|
35
34
|
}) => React.ReactElement;
|
36
35
|
} & UseControllerProps<TFieldValues, TName>;
|
37
|
-
export {};
|
package/dist/types/fields.d.ts
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
import { IsFlatObject } from './utils';
|
1
|
+
import { IsFlatObject, Noop } from './utils';
|
2
2
|
import { RegisterOptions } from './validator';
|
3
3
|
export declare type InternalFieldName = string;
|
4
4
|
export declare type FieldName<TFieldValues extends FieldValues> = IsFlatObject<TFieldValues> extends true ? Extract<keyof TFieldValues, string> : string;
|
@@ -10,7 +10,7 @@ export declare type CustomElement<TFieldValues extends FieldValues> = {
|
|
10
10
|
checked?: boolean;
|
11
11
|
options?: HTMLOptionsCollection;
|
12
12
|
files?: FileList | null;
|
13
|
-
focus?:
|
13
|
+
focus?: Noop;
|
14
14
|
};
|
15
15
|
export declare type FieldValue<TFieldValues extends FieldValues> = TFieldValues[InternalFieldName];
|
16
16
|
export declare type FieldValues = Record<string, any>;
|
package/dist/types/form.d.ts
CHANGED
@@ -5,13 +5,13 @@ import { EventType } from './events';
|
|
5
5
|
import { FieldArrayWithId } from './fieldArray';
|
6
6
|
import { FieldRefs, FieldValue, FieldValues, InternalFieldName } from './fields';
|
7
7
|
import { Resolver } from './resolvers';
|
8
|
-
import { DeepMap, DeepPartial, FieldArrayPath, FieldPath, FieldPathValue, FieldPathValues, UnionLike } from './utils';
|
8
|
+
import { DeepMap, DeepPartial, FieldArrayPath, FieldPath, FieldPathValue, FieldPathValues, Noop, UnionLike } from './utils';
|
9
9
|
import { RegisterOptions } from './validator';
|
10
10
|
declare const $NestedValue: unique symbol;
|
11
11
|
export declare type NestedValue<TValue extends object = object> = {
|
12
12
|
[$NestedValue]: never;
|
13
13
|
} & TValue;
|
14
|
-
export declare type UnpackNestedValue<T> = T extends NestedValue<infer U> ? U : T extends
|
14
|
+
export declare type UnpackNestedValue<T> = T extends NestedValue<infer U> ? U : T extends Date | FileList | File ? T : T extends object ? {
|
15
15
|
[K in keyof T]: UnpackNestedValue<T[K]>;
|
16
16
|
} : T;
|
17
17
|
export declare type DefaultValues<TFieldValues> = UnpackNestedValue<DeepPartial<TFieldValues>>;
|
@@ -155,7 +155,7 @@ export declare type BatchFieldArrayUpdate = <T extends Function, TFieldValues, T
|
|
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
157
|
_subjects: Subjects<TFieldValues>;
|
158
|
-
_removeUnmounted:
|
158
|
+
_removeUnmounted: Noop;
|
159
159
|
_names: Names;
|
160
160
|
_stateFlags: {
|
161
161
|
mount: boolean;
|
@@ -165,7 +165,7 @@ export declare type Control<TFieldValues extends FieldValues = FieldValues, TCon
|
|
165
165
|
_options: UseFormProps<TFieldValues, TContext>;
|
166
166
|
_getDirty: GetIsDirty;
|
167
167
|
_formState: FormState<TFieldValues>;
|
168
|
-
_updateValid:
|
168
|
+
_updateValid: Noop;
|
169
169
|
_fields: FieldRefs;
|
170
170
|
_formValues: FieldValues;
|
171
171
|
_proxyFormState: ReadFormState;
|
package/dist/types/utils.d.ts
CHANGED
@@ -1,5 +1,15 @@
|
|
1
1
|
import { FieldValues } from './fields';
|
2
2
|
import { NestedValue } from './form';
|
3
|
+
export declare type Noop = () => void;
|
4
|
+
interface File extends Blob {
|
5
|
+
readonly lastModified: number;
|
6
|
+
readonly name: string;
|
7
|
+
}
|
8
|
+
interface FileList {
|
9
|
+
readonly length: number;
|
10
|
+
item(index: number): File | null;
|
11
|
+
[index: number]: File;
|
12
|
+
}
|
3
13
|
export declare type Primitive = null | undefined | string | number | boolean | symbol | bigint;
|
4
14
|
export declare type EmptyObject = {
|
5
15
|
[K in string | number]: never;
|
@@ -8,27 +18,25 @@ export declare type NonUndefined<T> = T extends undefined ? never : T;
|
|
8
18
|
export declare type LiteralUnion<T extends U, U extends Primitive> = T | (U & {
|
9
19
|
_?: never;
|
10
20
|
});
|
11
|
-
export declare type
|
12
|
-
|
13
|
-
[K in keyof T]?: DeepPartialImpl<T[K]>;
|
21
|
+
export declare type DeepPartial<T> = T extends Date | FileList | File | NestedValue ? T : {
|
22
|
+
[K in keyof T]?: DeepPartial<T[K]>;
|
14
23
|
};
|
15
24
|
export declare type IsAny<T> = boolean extends (T extends never ? true : false) ? true : false;
|
16
|
-
export declare type
|
17
|
-
|
18
|
-
|
19
|
-
};
|
25
|
+
export declare type DeepMap<T, TValue> = IsAny<T> extends true ? any : T extends Date | FileList | File | NestedValue ? TValue : T extends object ? {
|
26
|
+
[K in keyof T]: DeepMap<NonUndefined<T[K]>, TValue>;
|
27
|
+
} : TValue;
|
20
28
|
export declare type IsFlatObject<T extends object> = Extract<Exclude<T[keyof T], NestedValue | Date | FileList>, any[] | object> extends never ? true : false;
|
21
29
|
declare type IsTuple<T extends ReadonlyArray<any>> = number extends T['length'] ? false : true;
|
22
30
|
declare type TupleKey<T extends ReadonlyArray<any>> = Exclude<keyof T, keyof any[]>;
|
23
31
|
declare type ArrayKey = number;
|
24
|
-
declare type PathImpl<K extends string | number, V> = V extends
|
32
|
+
declare type PathImpl<K extends string | number, V> = V extends Primitive ? `${K}` : `${K}` | `${K}.${Path<V>}`;
|
25
33
|
export declare type Path<T> = T extends ReadonlyArray<infer V> ? IsTuple<T> extends true ? {
|
26
34
|
[K in TupleKey<T>]-?: PathImpl<K & string, T[K]>;
|
27
35
|
}[TupleKey<T>] : PathImpl<ArrayKey, V> : {
|
28
36
|
[K in keyof T]-?: PathImpl<K & string, T[K]>;
|
29
37
|
}[keyof T];
|
30
38
|
export declare type FieldPath<TFieldValues extends FieldValues> = Path<TFieldValues>;
|
31
|
-
declare type ArrayPathImpl<K extends string | number, V> =
|
39
|
+
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>}`;
|
32
40
|
export declare type ArrayPath<T> = T extends ReadonlyArray<infer V> ? IsTuple<T> extends true ? {
|
33
41
|
[K in TupleKey<T>]-?: ArrayPathImpl<K & string, T[K]>;
|
34
42
|
}[TupleKey<T>] : ArrayPathImpl<ArrayKey, V> : {
|
@@ -49,7 +57,7 @@ declare type OptionalKeys<T> = T extends any ? {
|
|
49
57
|
declare type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
50
58
|
export declare type UnionLike<T> = [T] extends [Date | FileList | File | NestedValue] ? T : [T] extends [ReadonlyArray<any>] ? {
|
51
59
|
[K in keyof T]: UnionLike<T[K]>;
|
52
|
-
} : [T] extends [
|
60
|
+
} : [T] extends [object] ? PartialBy<{
|
53
61
|
[K in UnionKeys<T>]: UnionLike<UnionValues<T, K>>;
|
54
62
|
}, Exclude<UnionKeys<T>, keyof T> | OptionalKeys<T>> : T;
|
55
63
|
export {};
|
package/dist/useSubscribe.d.ts
CHANGED
@@ -1,8 +1,9 @@
|
|
1
1
|
import { SubjectType } from './utils/Subject';
|
2
2
|
declare type Props<T> = {
|
3
3
|
disabled?: boolean;
|
4
|
-
subject
|
4
|
+
subject: SubjectType<T>;
|
5
5
|
callback: (value: T) => void;
|
6
|
+
skipEarlySubscription?: boolean;
|
6
7
|
};
|
7
|
-
export declare function useSubscribe<T>(
|
8
|
+
export declare function useSubscribe<T>(props: Props<T>): void;
|
8
9
|
export {};
|
package/dist/utils/Subject.d.ts
CHANGED
@@ -1,13 +1,14 @@
|
|
1
|
+
import { Noop } from '../types';
|
1
2
|
export declare type Observer<T> = {
|
2
3
|
next: (value: T) => void;
|
3
4
|
};
|
4
|
-
export declare type TearDown =
|
5
|
+
export declare type TearDown = Noop;
|
5
6
|
export declare type SubjectType<T> = {
|
6
7
|
next: (value: T) => void;
|
7
8
|
subscribe: (value: Observer<T>) => {
|
8
9
|
unsubscribe: TearDown;
|
9
10
|
};
|
10
|
-
unsubscribe:
|
11
|
+
unsubscribe: Noop;
|
11
12
|
};
|
12
13
|
export declare class Subscription {
|
13
14
|
private tearDowns;
|
package/package.json
CHANGED