@refinedev/core 4.12.0 → 4.13.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 +19 -0
- package/dist/components/gh-banner/index.d.ts +0 -1
- package/dist/components/gh-banner/index.d.ts.map +1 -1
- package/dist/esm/index.js +6 -6
- package/dist/esm/index.js.map +1 -1
- package/dist/hooks/form/useForm.d.ts +18 -16
- package/dist/hooks/form/useForm.d.ts.map +1 -1
- package/dist/iife/index.js +5 -5
- package/dist/iife/index.js.map +1 -1
- package/dist/index.js +5 -5
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/hooks/form/useForm.ts +131 -93
|
@@ -10,7 +10,7 @@ export declare type ActionParams = {
|
|
|
10
10
|
*/
|
|
11
11
|
action?: FormAction;
|
|
12
12
|
};
|
|
13
|
-
declare type ActionFormProps<
|
|
13
|
+
declare type ActionFormProps<TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TVariables = {}, TData extends BaseRecord = TQueryFnData, TResponse extends BaseRecord = TData, TResponseError extends HttpError = TError> = {
|
|
14
14
|
/**
|
|
15
15
|
* Resource name for API data interactions
|
|
16
16
|
* @default Resource name that it reads from route
|
|
@@ -44,11 +44,11 @@ declare type ActionFormProps<TData extends BaseRecord = BaseRecord, TError exten
|
|
|
44
44
|
/**
|
|
45
45
|
* Called when a mutation is successful
|
|
46
46
|
*/
|
|
47
|
-
onMutationSuccess?: (data: CreateResponse<
|
|
47
|
+
onMutationSuccess?: (data: CreateResponse<TResponse> | UpdateResponse<TResponse>, variables: TVariables, context: any) => void;
|
|
48
48
|
/**
|
|
49
49
|
* Called when a mutation encounters an error
|
|
50
50
|
*/
|
|
51
|
-
onMutationError?: (error:
|
|
51
|
+
onMutationError?: (error: TResponseError, variables: TVariables, context: any) => void;
|
|
52
52
|
/**
|
|
53
53
|
* Duration to wait before executing mutations when `mutationMode = "undoable"`
|
|
54
54
|
* @default `5000*`
|
|
@@ -67,27 +67,27 @@ declare type ActionFormProps<TData extends BaseRecord = BaseRecord, TError exten
|
|
|
67
67
|
/**
|
|
68
68
|
* react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options of useOne hook used while in edit mode.
|
|
69
69
|
*/
|
|
70
|
-
queryOptions?: UseQueryOptions<GetOneResponse<
|
|
70
|
+
queryOptions?: UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>;
|
|
71
71
|
/**
|
|
72
72
|
* react-query's [useMutation](https://tanstack.com/query/v4/docs/reference/useMutation) options of useCreate hook used while submitting in create and clone modes.
|
|
73
73
|
*/
|
|
74
|
-
createMutationOptions?: UseCreateProps<
|
|
74
|
+
createMutationOptions?: UseCreateProps<TResponse, TResponseError, TVariables>["mutationOptions"];
|
|
75
75
|
/**
|
|
76
76
|
* react-query's [useMutation](https://tanstack.com/query/v4/docs/reference/useMutation) options of useUpdate hook used while submitting in edit mode.
|
|
77
77
|
*/
|
|
78
|
-
updateMutationOptions?: UseUpdateProps<
|
|
79
|
-
} & SuccessErrorNotification<UpdateResponse<
|
|
78
|
+
updateMutationOptions?: UseUpdateProps<TResponse, TResponseError, TVariables>["mutationOptions"];
|
|
79
|
+
} & SuccessErrorNotification<UpdateResponse<TResponse> | CreateResponse<TResponse>, TResponseError, {
|
|
80
80
|
id: BaseKey;
|
|
81
81
|
values: TVariables;
|
|
82
82
|
} | TVariables> & ActionParams & LiveModeProps;
|
|
83
|
-
export declare type UseFormProps<
|
|
84
|
-
export declare type UseFormReturnType<
|
|
83
|
+
export declare type UseFormProps<TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TVariables = {}, TData extends BaseRecord = TQueryFnData, TResponse extends BaseRecord = TData, TResponseError extends HttpError = TError> = ActionFormProps<TQueryFnData, TError, TVariables, TData, TResponse, TResponseError> & ActionParams & LiveModeProps;
|
|
84
|
+
export declare type UseFormReturnType<TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TVariables = {}, TData extends BaseRecord = TQueryFnData, TResponse extends BaseRecord = TData, TResponseError extends HttpError = TError> = {
|
|
85
85
|
id?: BaseKey;
|
|
86
86
|
setId: Dispatch<SetStateAction<BaseKey | undefined>>;
|
|
87
|
-
queryResult?: QueryObserverResult<GetOneResponse<
|
|
88
|
-
mutationResult: UseUpdateReturnType<
|
|
87
|
+
queryResult?: QueryObserverResult<GetOneResponse<TData>>;
|
|
88
|
+
mutationResult: UseUpdateReturnType<TResponse, TResponseError, TVariables> | UseCreateReturnType<TResponse, TResponseError, TVariables>;
|
|
89
89
|
formLoading: boolean;
|
|
90
|
-
onFinish: (values: TVariables) => Promise<CreateResponse<
|
|
90
|
+
onFinish: (values: TVariables) => Promise<CreateResponse<TResponse> | UpdateResponse<TResponse> | void>;
|
|
91
91
|
redirect: (redirect: RedirectAction, idFromFunction?: BaseKey | undefined, routeParams?: Record<string, string | number>) => void;
|
|
92
92
|
};
|
|
93
93
|
/**
|
|
@@ -95,12 +95,14 @@ export declare type UseFormReturnType<TData extends BaseRecord = BaseRecord, TEr
|
|
|
95
95
|
*
|
|
96
96
|
* @see {@link https://refine.dev/docs/api-references/hooks/form/useForm} for more details.
|
|
97
97
|
*
|
|
98
|
-
* @typeParam
|
|
99
|
-
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-
|
|
98
|
+
* @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
|
99
|
+
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
|
|
100
100
|
* @typeParam TVariables - Values for params. default `{}`
|
|
101
|
-
*
|
|
101
|
+
* @typeParam TData - Result data returned by the `select` function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
|
|
102
|
+
* @typeParam TResponse - Result data returned by the mutation function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TData`
|
|
103
|
+
* @typeParam TResponseError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}. Defaults to `TError`
|
|
102
104
|
*
|
|
103
105
|
*/
|
|
104
|
-
export declare const useForm: <
|
|
106
|
+
export declare const useForm: <TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TVariables = {}, TData extends BaseRecord = TQueryFnData, TResponse extends BaseRecord = TData, TResponseError extends HttpError = TError>({ resource: resourceFromProps, action: actionFromProps, id: idFromProps, onMutationSuccess, onMutationError, redirect: redirectFromProps, successNotification, errorNotification, meta, metaData, mutationMode: mutationModeProp, liveMode, onLiveEvent, liveParams, undoableTimeout, dataProviderName, invalidates, queryOptions, createMutationOptions, updateMutationOptions, }?: UseFormProps<TQueryFnData, TError, TVariables, TData, TResponse, TResponseError>) => UseFormReturnType<TQueryFnData, TError, TVariables, TData, TResponse, TResponseError>;
|
|
105
107
|
export {};
|
|
106
108
|
//# sourceMappingURL=useForm.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useForm.d.ts","sourceRoot":"","sources":["../../../src/hooks/form/useForm.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAgB7E,OAAO,EACH,UAAU,EACV,cAAc,EACd,cAAc,EACd,SAAS,EACT,aAAa,EAEb,cAAc,EACd,wBAAwB,EACxB,cAAc,EACd,YAAY,EACZ,OAAO,EACP,UAAU,EACV,UAAU,EAEV,SAAS,EACZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAEH,cAAc,EACd,mBAAmB,EACtB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAQxE,oBAAY,YAAY,GAAG;IACvB;;;OAGG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;CACvB,CAAC;AAEF,aAAK,eAAe,CAChB,
|
|
1
|
+
{"version":3,"file":"useForm.d.ts","sourceRoot":"","sources":["../../../src/hooks/form/useForm.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAgB7E,OAAO,EACH,UAAU,EACV,cAAc,EACd,cAAc,EACd,SAAS,EACT,aAAa,EAEb,cAAc,EACd,wBAAwB,EACxB,cAAc,EACd,YAAY,EACZ,OAAO,EACP,UAAU,EACV,UAAU,EAEV,SAAS,EACZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAEH,cAAc,EACd,mBAAmB,EACtB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAQxE,oBAAY,YAAY,GAAG;IACvB;;;OAGG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;CACvB,CAAC;AAEF,aAAK,eAAe,CAChB,YAAY,SAAS,UAAU,GAAG,UAAU,EAC5C,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,UAAU,GAAG,EAAE,EACf,KAAK,SAAS,UAAU,GAAG,YAAY,EACvC,SAAS,SAAS,UAAU,GAAG,KAAK,EACpC,cAAc,SAAS,SAAS,GAAG,MAAM,IACzC;IACA;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,EAAE,CAAC,EAAE,OAAO,CAAC;IACb;;;;OAIG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,CAChB,IAAI,EAAE,cAAc,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,EAC3D,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,GAAG,KACX,IAAI,CAAC;IACV;;OAEG;IACH,eAAe,CAAC,EAAE,CACd,KAAK,EAAE,cAAc,EACrB,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,GAAG,KACX,IAAI,CAAC;IACV;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,UAAU,CAAC,CAAC;IACtC;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,CAC1B,cAAc,CAAC,YAAY,CAAC,EAC5B,MAAM,EACN,cAAc,CAAC,KAAK,CAAC,CACxB,CAAC;IACF;;OAEG;IACH,qBAAqB,CAAC,EAAE,cAAc,CAClC,SAAS,EACT,cAAc,EACd,UAAU,CACb,CAAC,iBAAiB,CAAC,CAAC;IACrB;;OAEG;IACH,qBAAqB,CAAC,EAAE,cAAc,CAClC,SAAS,EACT,cAAc,EACd,UAAU,CACb,CAAC,iBAAiB,CAAC,CAAC;CACxB,GAAG,wBAAwB,CACxB,cAAc,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,EACrD,cAAc,EACd;IAAE,EAAE,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,GAAG,UAAU,CACnD,GACG,YAAY,GACZ,aAAa,CAAC;AAElB,oBAAY,YAAY,CACpB,YAAY,SAAS,UAAU,GAAG,UAAU,EAC5C,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,UAAU,GAAG,EAAE,EACf,KAAK,SAAS,UAAU,GAAG,YAAY,EACvC,SAAS,SAAS,UAAU,GAAG,KAAK,EACpC,cAAc,SAAS,SAAS,GAAG,MAAM,IACzC,eAAe,CACf,YAAY,EACZ,MAAM,EACN,UAAU,EACV,KAAK,EACL,SAAS,EACT,cAAc,CACjB,GACG,YAAY,GACZ,aAAa,CAAC;AAElB,oBAAY,iBAAiB,CACzB,YAAY,SAAS,UAAU,GAAG,UAAU,EAC5C,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,UAAU,GAAG,EAAE,EACf,KAAK,SAAS,UAAU,GAAG,YAAY,EACvC,SAAS,SAAS,UAAU,GAAG,KAAK,EACpC,cAAc,SAAS,SAAS,GAAG,MAAM,IACzC;IACA,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,KAAK,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC;IACrD,WAAW,CAAC,EAAE,mBAAmB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACzD,cAAc,EACR,mBAAmB,CAAC,SAAS,EAAE,cAAc,EAAE,UAAU,CAAC,GAC1D,mBAAmB,CAAC,SAAS,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;IACjE,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,CACN,MAAM,EAAE,UAAU,KACjB,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;IAC3E,QAAQ,EAAE,CACN,QAAQ,EAAE,cAAc,EACxB,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,EACpC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,KAC5C,IAAI,CAAC;CACb,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,OAAO,iwBA+XnB,CAAC"}
|