react-hook-form 7.17.4 → 7.19.0-next.0
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/CHANGELOG.md +24 -0
- package/README.md +23 -6
- package/dist/controller.d.ts +2 -2
- package/dist/index.cjs.js +1 -1
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +204 -157
- 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/logic/generateWatchOutput.d.ts +2 -0
- package/dist/logic/schemaErrorLookup.d.ts +5 -0
- package/dist/logic/shouldSubscribeByName.d.ts +1 -1
- package/dist/types/controller.d.ts +10 -10
- package/dist/types/fieldArray.d.ts +1 -1
- package/dist/types/form.d.ts +17 -11
- package/dist/types/utils.d.ts +3 -0
- package/dist/useController.d.ts +2 -2
- package/dist/useSubscribe.d.ts +2 -3
- package/dist/utils/createSubject.d.ts +13 -0
- package/package.json +14 -14
- package/dist/utils/subject.d.ts +0 -24
@@ -1,2 +1,2 @@
|
|
1
|
-
declare const _default: <T>(name?: T | undefined, signalName?: string | undefined) => boolean;
|
1
|
+
declare const _default: <T extends string | string[] | undefined>(name?: T | undefined, signalName?: string | undefined) => boolean;
|
2
2
|
export default _default;
|
@@ -1,35 +1,35 @@
|
|
1
1
|
import * as React from 'react';
|
2
2
|
import { RegisterOptions } from './validator';
|
3
|
-
import { Control, FieldError,
|
3
|
+
import { Control, FieldError, FieldPathValue, FieldPathWithValue, FieldValues, IsAny, Noop, RefCallBack, UnpackNestedValue, UseFormStateReturn } from './';
|
4
4
|
export declare type ControllerFieldState = {
|
5
5
|
invalid: boolean;
|
6
6
|
isTouched: boolean;
|
7
7
|
isDirty: boolean;
|
8
8
|
error?: FieldError;
|
9
9
|
};
|
10
|
-
export declare type ControllerRenderProps<TFieldValues extends FieldValues = FieldValues, TName extends
|
10
|
+
export declare type ControllerRenderProps<TFieldValues extends FieldValues = FieldValues, TResult = any, TName extends FieldPathWithValue<TFieldValues, TResult> = FieldPathWithValue<TFieldValues, TResult>> = {
|
11
11
|
onChange: (...event: any[]) => void;
|
12
12
|
onBlur: Noop;
|
13
|
-
value: UnpackNestedValue<FieldPathValue<TFieldValues, TName
|
13
|
+
value: IsAny<TResult> extends true ? UnpackNestedValue<FieldPathValue<TFieldValues, TName>> : UnpackNestedValue<TResult>;
|
14
14
|
name: TName;
|
15
15
|
ref: RefCallBack;
|
16
16
|
};
|
17
|
-
export declare type UseControllerProps<TFieldValues extends FieldValues = FieldValues, TName extends
|
17
|
+
export declare type UseControllerProps<TFieldValues extends FieldValues = FieldValues, TResult = any, TName extends FieldPathWithValue<TFieldValues, TResult> = FieldPathWithValue<TFieldValues, TResult>> = {
|
18
18
|
name: TName;
|
19
19
|
rules?: Omit<RegisterOptions<TFieldValues, TName>, 'valueAsNumber' | 'valueAsDate' | 'setValueAs' | 'disabled'>;
|
20
20
|
shouldUnregister?: boolean;
|
21
|
-
defaultValue?: UnpackNestedValue<FieldPathValue<TFieldValues, TName
|
21
|
+
defaultValue?: IsAny<TResult> extends true ? UnpackNestedValue<FieldPathValue<TFieldValues, TName>> : UnpackNestedValue<TResult>;
|
22
22
|
control?: Control<TFieldValues>;
|
23
23
|
};
|
24
|
-
export declare type UseControllerReturn<TFieldValues extends FieldValues = FieldValues, TName extends
|
25
|
-
field: ControllerRenderProps<TFieldValues, TName>;
|
24
|
+
export declare type UseControllerReturn<TFieldValues extends FieldValues = FieldValues, TResult = any, TName extends FieldPathWithValue<TFieldValues, TResult> = FieldPathWithValue<TFieldValues, TResult>> = {
|
25
|
+
field: ControllerRenderProps<TFieldValues, TResult, TName>;
|
26
26
|
formState: UseFormStateReturn<TFieldValues>;
|
27
27
|
fieldState: ControllerFieldState;
|
28
28
|
};
|
29
|
-
export declare type ControllerProps<TFieldValues extends FieldValues = FieldValues, TName extends
|
29
|
+
export declare type ControllerProps<TFieldValues extends FieldValues = FieldValues, TResult = any, TName extends FieldPathWithValue<TFieldValues, TResult> = FieldPathWithValue<TFieldValues, TResult>> = {
|
30
30
|
render: ({ field, fieldState, formState, }: {
|
31
|
-
field: ControllerRenderProps<TFieldValues, TName>;
|
31
|
+
field: ControllerRenderProps<TFieldValues, TResult, TName>;
|
32
32
|
fieldState: ControllerFieldState;
|
33
33
|
formState: UseFormStateReturn<TFieldValues>;
|
34
34
|
}) => React.ReactElement;
|
35
|
-
} & UseControllerProps<TFieldValues, TName>;
|
35
|
+
} & UseControllerProps<TFieldValues, TResult, TName>;
|
@@ -9,7 +9,7 @@ export declare type UseFieldArrayProps<TFieldValues extends FieldValues = FieldV
|
|
9
9
|
shouldUnregister?: boolean;
|
10
10
|
};
|
11
11
|
export declare type FieldArrayWithId<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>, TKeyName extends string = 'id'> = FieldArray<TFieldValues, TFieldArrayName> & Record<TKeyName, string>;
|
12
|
-
export declare type FieldArray<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = FieldArrayPathValue<TFieldValues, TFieldArrayName> extends ReadonlyArray<infer U> ? U : never;
|
12
|
+
export declare type FieldArray<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = FieldArrayPathValue<TFieldValues, TFieldArrayName> extends ReadonlyArray<infer U> | null | undefined ? U : never;
|
13
13
|
export declare type FieldArrayMethodProps = {
|
14
14
|
shouldFocus?: boolean;
|
15
15
|
focusIndex?: number;
|
package/dist/types/form.d.ts
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
import * as React from 'react';
|
2
|
-
import {
|
2
|
+
import { Subject, Subscription } from '../utils/createSubject';
|
3
3
|
import { ErrorOption, FieldError, FieldErrors } from './errors';
|
4
4
|
import { EventType } from './events';
|
5
5
|
import { FieldArrayWithId } from './fieldArray';
|
@@ -119,23 +119,25 @@ export declare type UseFormUnregister<TFieldValues extends FieldValues> = (name?
|
|
119
119
|
keepError?: boolean;
|
120
120
|
}) => void;
|
121
121
|
export declare type UseFormHandleSubmit<TFieldValues extends FieldValues> = <TSubmitFieldValues extends FieldValues = TFieldValues>(onValid: SubmitHandler<TSubmitFieldValues>, onInvalid?: SubmitErrorHandler<TFieldValues>) => (e?: React.BaseSyntheticEvent) => Promise<void>;
|
122
|
+
export declare type UseFormResetField<TFieldValues extends FieldValues> = <TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(name: TFieldName, options?: Partial<{
|
123
|
+
keepDirty: boolean;
|
124
|
+
keepTouched: boolean;
|
125
|
+
keepError: boolean;
|
126
|
+
defaultValue: any;
|
127
|
+
}>) => void;
|
122
128
|
export declare type UseFormReset<TFieldValues extends FieldValues> = (values?: DefaultValues<TFieldValues>, keepStateOptions?: KeepStateOptions) => void;
|
123
129
|
export declare type WatchInternal<TFieldValues> = (fieldNames?: InternalFieldName | InternalFieldName[], defaultValue?: UnpackNestedValue<DeepPartial<TFieldValues>>, isMounted?: boolean, isGlobal?: boolean) => FieldPathValue<FieldValues, InternalFieldName> | FieldPathValues<FieldValues, InternalFieldName[]>;
|
124
130
|
export declare type GetIsDirty = <TName extends InternalFieldName, TData>(name?: TName, data?: TData) => boolean;
|
125
|
-
export declare type FormStateSubjectRef<TFieldValues> =
|
131
|
+
export declare type FormStateSubjectRef<TFieldValues> = Subject<Partial<FormState<TFieldValues>> & {
|
126
132
|
name?: InternalFieldName;
|
127
133
|
}>;
|
128
134
|
export declare type Subjects<TFieldValues extends FieldValues = FieldValues> = {
|
129
|
-
watch:
|
135
|
+
watch: Subject<{
|
130
136
|
name?: InternalFieldName;
|
131
137
|
type?: EventType;
|
132
138
|
values?: FieldValues;
|
133
139
|
}>;
|
134
|
-
|
135
|
-
name?: InternalFieldName;
|
136
|
-
values?: FieldValues;
|
137
|
-
}>;
|
138
|
-
array: SubjectType<{
|
140
|
+
array: Subject<{
|
139
141
|
name?: InternalFieldName;
|
140
142
|
values?: FieldValues;
|
141
143
|
}>;
|
@@ -162,7 +164,7 @@ export declare type Control<TFieldValues extends FieldValues = FieldValues, TCon
|
|
162
164
|
action: boolean;
|
163
165
|
watch: boolean;
|
164
166
|
};
|
165
|
-
_options: UseFormProps<TFieldValues, TContext>;
|
167
|
+
_options: Pick<UseFormProps<TFieldValues, TContext>, 'shouldUnregister'>;
|
166
168
|
_getDirty: GetIsDirty;
|
167
169
|
_formState: FormState<TFieldValues>;
|
168
170
|
_updateValid: Noop;
|
@@ -171,12 +173,15 @@ export declare type Control<TFieldValues extends FieldValues = FieldValues, TCon
|
|
171
173
|
_proxyFormState: ReadFormState;
|
172
174
|
_defaultValues: Partial<DefaultValues<TFieldValues>>;
|
173
175
|
_getWatch: WatchInternal<TFieldValues>;
|
174
|
-
register: UseFormRegister<TFieldValues>;
|
175
176
|
_updateFieldArray: BatchFieldArrayUpdate;
|
176
177
|
_getFieldArray: <TFieldArrayValues>(name: InternalFieldName) => Partial<TFieldArrayValues>[];
|
178
|
+
_executeSchema: (names: InternalFieldName[]) => Promise<{
|
179
|
+
errors: FieldErrors;
|
180
|
+
}>;
|
181
|
+
register: UseFormRegister<TFieldValues>;
|
177
182
|
unregister: UseFormUnregister<TFieldValues>;
|
178
183
|
};
|
179
|
-
export declare type WatchObserver<TFieldValues> = (value: UnpackNestedValue<TFieldValues
|
184
|
+
export declare type WatchObserver<TFieldValues> = (value: UnpackNestedValue<DeepPartial<TFieldValues>>, info: {
|
180
185
|
name?: FieldPath<TFieldValues>;
|
181
186
|
type?: EventType;
|
182
187
|
value?: unknown;
|
@@ -189,6 +194,7 @@ export declare type UseFormReturn<TFieldValues extends FieldValues = FieldValues
|
|
189
194
|
setValue: UseFormSetValue<TFieldValues>;
|
190
195
|
trigger: UseFormTrigger<TFieldValues>;
|
191
196
|
formState: FormState<TFieldValues>;
|
197
|
+
resetField: UseFormResetField<TFieldValues>;
|
192
198
|
reset: UseFormReset<TFieldValues>;
|
193
199
|
handleSubmit: UseFormHandleSubmit<TFieldValues>;
|
194
200
|
unregister: UseFormUnregister<TFieldValues>;
|
package/dist/types/utils.d.ts
CHANGED
@@ -65,4 +65,7 @@ export declare type UnionLike<T> = [T] extends [Date | FileList | File | NestedV
|
|
65
65
|
} : [T] extends [object] ? PartialBy<{
|
66
66
|
[K in UnionKeys<T>]: UnionLike<UnionValues<T, K>>;
|
67
67
|
}, Exclude<UnionKeys<T>, keyof T> | OptionalKeys<T>> : T;
|
68
|
+
export declare type FieldPathWithValue<TFieldValues extends FieldValues, TResult = unknown, FieldPaths extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
|
69
|
+
[key in FieldPaths]: FieldPathValue<TFieldValues, key> extends TResult ? key : never;
|
70
|
+
}[FieldPaths];
|
68
71
|
export {};
|
package/dist/useController.d.ts
CHANGED
@@ -1,2 +1,2 @@
|
|
1
|
-
import {
|
2
|
-
export declare function useController<TFieldValues extends FieldValues = FieldValues, TName extends
|
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>;
|
package/dist/useSubscribe.d.ts
CHANGED
@@ -1,9 +1,8 @@
|
|
1
|
-
import {
|
1
|
+
import { Subject } from './utils/createSubject';
|
2
2
|
declare type Props<T> = {
|
3
3
|
disabled?: boolean;
|
4
|
-
subject:
|
4
|
+
subject: Subject<T>;
|
5
5
|
callback: (value: T) => void;
|
6
|
-
skipEarlySubscription?: boolean;
|
7
6
|
};
|
8
7
|
export declare function useSubscribe<T>(props: Props<T>): void;
|
9
8
|
export {};
|
@@ -0,0 +1,13 @@
|
|
1
|
+
import { Noop } from '../types';
|
2
|
+
export declare type Observer<T> = {
|
3
|
+
next: (value: T) => void;
|
4
|
+
};
|
5
|
+
export declare type Subscription = {
|
6
|
+
unsubscribe: Noop;
|
7
|
+
};
|
8
|
+
export declare type Subject<T> = {
|
9
|
+
readonly observers: Observer<T>[];
|
10
|
+
subscribe: (value: Observer<T>) => Subscription;
|
11
|
+
unsubscribe: Noop;
|
12
|
+
} & Observer<T>;
|
13
|
+
export default function createSubject<T>(): Subject<T>;
|
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.
|
4
|
+
"version": "7.19.0-next.0",
|
5
5
|
"main": "dist/index.cjs.js",
|
6
6
|
"module": "dist/index.esm.js",
|
7
7
|
"umd:main": "dist/index.umd.js",
|
@@ -65,35 +65,35 @@
|
|
65
65
|
"author": "<bluebill1049@hotmail.com>",
|
66
66
|
"license": "MIT",
|
67
67
|
"devDependencies": {
|
68
|
-
"@rollup/plugin-commonjs": "^21.0.
|
69
|
-
"@rollup/plugin-node-resolve": "^13.0.
|
68
|
+
"@rollup/plugin-commonjs": "^21.0.1",
|
69
|
+
"@rollup/plugin-node-resolve": "^13.0.6",
|
70
70
|
"@testing-library/jest-dom": "^5.14.1",
|
71
71
|
"@testing-library/react": "^12.1.2",
|
72
72
|
"@testing-library/react-hooks": "^7.0.2",
|
73
|
-
"@testing-library/react-native": "^
|
73
|
+
"@testing-library/react-native": "^8.0.0",
|
74
74
|
"@types/jest": "^27.0.2",
|
75
|
-
"@types/react": "^17.0.
|
76
|
-
"@types/react-native": "^0.65.
|
77
|
-
"@typescript-eslint/eslint-plugin": "^5.
|
78
|
-
"@typescript-eslint/parser": "^5.
|
75
|
+
"@types/react": "^17.0.31",
|
76
|
+
"@types/react-native": "^0.65.10",
|
77
|
+
"@typescript-eslint/eslint-plugin": "^5.1.0",
|
78
|
+
"@typescript-eslint/parser": "^5.1.0",
|
79
79
|
"@vitejs/plugin-react-refresh": "^1.3.6",
|
80
|
-
"babel-jest": "^27.
|
80
|
+
"babel-jest": "^27.3.1",
|
81
81
|
"bundlesize": "^0.18.0",
|
82
82
|
"cypress": "8.6.0",
|
83
|
-
"eslint": "^8.0.
|
83
|
+
"eslint": "^8.0.1",
|
84
84
|
"eslint-config-prettier": "^8.3.0",
|
85
85
|
"eslint-plugin-cypress": "^2.12.1",
|
86
86
|
"eslint-plugin-prettier": "^4.0.0",
|
87
87
|
"eslint-plugin-react": "^7.26.1",
|
88
88
|
"eslint-plugin-react-hooks": "^4.2.0",
|
89
89
|
"eslint-plugin-simple-import-sort": "^7.0.0",
|
90
|
-
"husky": "^7.0.
|
91
|
-
"jest": "^27.
|
90
|
+
"husky": "^7.0.4",
|
91
|
+
"jest": "^27.3.1",
|
92
92
|
"lint-staged": "^11.2.3",
|
93
93
|
"prettier": "^2.4.1",
|
94
94
|
"react": "^17.0.1",
|
95
95
|
"react-dom": "^17.0.1",
|
96
|
-
"react-native": "^0.66.
|
96
|
+
"react-native": "^0.66.1",
|
97
97
|
"react-test-renderer": "^17.0.1",
|
98
98
|
"rimraf": "^3.0.2",
|
99
99
|
"rollup": "^2.58.0",
|
@@ -101,7 +101,7 @@
|
|
101
101
|
"rollup-plugin-sourcemaps": "^0.6.2",
|
102
102
|
"rollup-plugin-terser": "^7.0.2",
|
103
103
|
"rollup-plugin-typescript2": "^0.30.0",
|
104
|
-
"ts-jest": "^27.0.
|
104
|
+
"ts-jest": "^27.0.7",
|
105
105
|
"typescript": "^4.4.4"
|
106
106
|
},
|
107
107
|
"resolutions": {
|
package/dist/utils/subject.d.ts
DELETED
@@ -1,24 +0,0 @@
|
|
1
|
-
import { Noop } from '../types';
|
2
|
-
export declare type Observer<T> = {
|
3
|
-
next: (value: T) => void;
|
4
|
-
};
|
5
|
-
export declare type TearDown = Noop;
|
6
|
-
export declare type SubjectType<T> = {
|
7
|
-
next: (value: T) => void;
|
8
|
-
subscribe: (value: Observer<T>) => {
|
9
|
-
unsubscribe: TearDown;
|
10
|
-
};
|
11
|
-
unsubscribe: Noop;
|
12
|
-
};
|
13
|
-
export declare class Subscription {
|
14
|
-
private tearDowns;
|
15
|
-
add(tearDown: TearDown): void;
|
16
|
-
unsubscribe(): void;
|
17
|
-
}
|
18
|
-
export default class Subject<T> {
|
19
|
-
observers: Observer<T>[];
|
20
|
-
constructor();
|
21
|
-
next(value: T): void;
|
22
|
-
subscribe(observer: Observer<T>): Subscription;
|
23
|
-
unsubscribe(): void;
|
24
|
-
}
|