@refinedev/core 4.16.4 → 4.18.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 +78 -0
- package/dist/components/containers/refine/index.d.ts +2 -2
- package/dist/components/pages/auth/index.d.ts +1 -1
- package/dist/components/pages/error/index.d.ts +1 -1
- package/dist/components/pages/login/index.d.ts +1 -1
- package/dist/components/pages/ready/index.d.ts +0 -1
- package/dist/components/pages/ready/index.d.ts.map +1 -1
- package/dist/esm/index.js +6 -6
- package/dist/esm/index.js.map +1 -1
- package/dist/hooks/accessControl/useCan/index.d.ts +1 -1
- package/dist/hooks/auditLog/useLog/index.d.ts +1 -1
- package/dist/hooks/auditLog/useLogList/index.d.ts +1 -1
- package/dist/hooks/data/useCreate.d.ts +3 -3
- package/dist/hooks/data/useCreateMany.d.ts +1 -1
- package/dist/hooks/data/useCustom.d.ts +1 -1
- package/dist/hooks/data/useCustomMutation.d.ts +3 -3
- package/dist/hooks/data/useDelete.d.ts +3 -3
- package/dist/hooks/data/useDeleteMany.d.ts +1 -1
- package/dist/hooks/data/useInfiniteList.d.ts +1 -1
- package/dist/hooks/data/useList.d.ts +1 -1
- package/dist/hooks/data/useMany.d.ts +1 -1
- package/dist/hooks/data/useOne.d.ts +1 -1
- package/dist/hooks/data/useUpdate.d.ts +3 -3
- package/dist/hooks/data/useUpdateMany.d.ts +1 -1
- package/dist/hooks/export/index.d.ts +2 -2
- package/dist/hooks/form/useForm.d.ts +10 -2
- package/dist/hooks/form/useForm.d.ts.map +1 -1
- package/dist/hooks/import/index.d.ts +3 -3
- package/dist/hooks/menu/useMenu.d.ts +1 -1
- package/dist/hooks/navigation/index.d.ts +2 -2
- package/dist/hooks/refine/useSyncWithLocation.d.ts +1 -1
- package/dist/hooks/refine/useTitle.d.ts +1 -1
- package/dist/hooks/refine/useWarnAboutChange/index.d.ts +1 -1
- package/dist/hooks/show/useShow.d.ts +1 -1
- package/dist/hooks/translate/useGetLocale.d.ts +1 -1
- package/dist/hooks/translate/useSetLocale.d.ts +1 -1
- package/dist/hooks/translate/useTranslate.d.ts +1 -1
- package/dist/hooks/useSelect/index.d.ts +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/components/authenticated/index.tsx +1 -1
- package/src/components/containers/refine/index.tsx +2 -2
- package/src/components/pages/auth/index.tsx +1 -1
- package/src/components/pages/error/index.tsx +1 -1
- package/src/components/pages/login/index.tsx +1 -1
- package/src/components/pages/ready/index.tsx +0 -1
- package/src/definitions/helpers/legacy-resource-transform/index.ts +1 -1
- package/src/definitions/helpers/router/__tests__/compose-route.ts +6 -0
- package/src/hooks/accessControl/useCan/index.ts +1 -1
- package/src/hooks/auditLog/useLog/index.ts +1 -1
- package/src/hooks/auditLog/useLogList/index.ts +1 -1
- package/src/hooks/auth/useForgotPassword/index.ts +2 -2
- package/src/hooks/auth/useGetIdentity/index.ts +1 -1
- package/src/hooks/auth/useIsAuthenticated/index.ts +1 -1
- package/src/hooks/auth/useLogin/index.ts +2 -2
- package/src/hooks/auth/useLogout/index.ts +2 -2
- package/src/hooks/auth/useOnError/index.ts +1 -1
- package/src/hooks/auth/usePermissions/index.ts +1 -1
- package/src/hooks/auth/useRegister/index.ts +2 -2
- package/src/hooks/auth/useUpdatePassword/index.ts +2 -2
- package/src/hooks/breadcrumb/index.ts +1 -1
- package/src/hooks/data/useCreate.ts +3 -3
- package/src/hooks/data/useCreateMany.ts +1 -1
- package/src/hooks/data/useCustom.ts +1 -1
- package/src/hooks/data/useCustomMutation.ts +3 -3
- package/src/hooks/data/useDelete.ts +3 -3
- package/src/hooks/data/useDeleteMany.ts +1 -1
- package/src/hooks/data/useInfiniteList.ts +1 -1
- package/src/hooks/data/useList.ts +1 -1
- package/src/hooks/data/useMany.ts +1 -1
- package/src/hooks/data/useOne.ts +1 -1
- package/src/hooks/data/useUpdate.ts +3 -3
- package/src/hooks/data/useUpdateMany.ts +1 -1
- package/src/hooks/export/index.ts +2 -2
- package/src/hooks/form/useForm.ts +20 -10
- package/src/hooks/import/index.tsx +3 -3
- package/src/hooks/menu/useMenu.tsx +1 -1
- package/src/hooks/navigation/index.ts +2 -2
- package/src/hooks/refine/useSyncWithLocation.ts +1 -1
- package/src/hooks/refine/useTitle.tsx +1 -1
- package/src/hooks/refine/useWarnAboutChange/index.ts +1 -1
- package/src/hooks/resource/useResource/index.ts +1 -1
- package/src/hooks/show/useShow.ts +1 -1
- package/src/hooks/translate/useGetLocale.ts +1 -1
- package/src/hooks/translate/useSetLocale.ts +1 -1
- package/src/hooks/translate/useTranslate.ts +1 -1
- package/src/hooks/useSelect/index.ts +1 -1
- package/src/hooks/useTable/index.ts +1 -1
|
@@ -8,7 +8,7 @@ export declare type UseCanProps = CanParams & {
|
|
|
8
8
|
};
|
|
9
9
|
/**
|
|
10
10
|
* `useCan` uses the `can` as the query function for `react-query`'s {@link https://react-query.tanstack.com/guides/queries `useQuery`}. It takes the parameters that `can` takes. It can also be configured with `queryOptions` for `useQuery`. Returns the result of `useQuery`.
|
|
11
|
-
* @see {@link https://refine.dev/docs/core/hooks/accessControl/useCan} for more details.
|
|
11
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/accessControl/useCan} for more details.
|
|
12
12
|
*
|
|
13
13
|
* @typeParam CanParams {@link https://refine.dev/docs/core/interfaceReferences#canparams}
|
|
14
14
|
* @typeParam CanReturnType {@link https://refine.dev/docs/core/interfaceReferences#canreturntype}
|
|
@@ -19,7 +19,7 @@ export declare type UseLogMutationProps<TLogData, TLogRenameData extends LogRena
|
|
|
19
19
|
};
|
|
20
20
|
/**
|
|
21
21
|
* useLog is used to `create` a new and `rename` the existing audit log.
|
|
22
|
-
* @see {@link https://refine.dev/docs/core/hooks/audit-log/useLog} for more details.
|
|
22
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/audit-log/useLog} for more details.
|
|
23
23
|
*/
|
|
24
24
|
export declare const useLog: <TLogData, TLogRenameData extends LogRenameData = LogRenameData>({ logMutationOptions, renameMutationOptions, }?: UseLogMutationProps<TLogData, TLogRenameData>) => UseLogReturnType<TLogData, TLogRenameData>;
|
|
25
25
|
export {};
|
|
@@ -11,7 +11,7 @@ export declare type UseLogProps<TQueryFnData, TError, TData> = {
|
|
|
11
11
|
/**
|
|
12
12
|
* useLogList is used to get and filter audit logs.
|
|
13
13
|
*
|
|
14
|
-
* @see {@link https://refine.dev/docs/core/hooks/audit-log/useLogList} for more details.
|
|
14
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/audit-log/useLogList} for more details.
|
|
15
15
|
*
|
|
16
16
|
* @typeParam TQueryFnData - Result data returned by the query function.
|
|
17
17
|
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
|
|
@@ -36,10 +36,10 @@ export declare type UseCreateProps<TData extends BaseRecord = BaseRecord, TError
|
|
|
36
36
|
*
|
|
37
37
|
* It uses `create` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
|
|
38
38
|
*
|
|
39
|
-
* @see {@link https://refine.dev/docs/api-
|
|
39
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/data/useCreate} for more details.
|
|
40
40
|
*
|
|
41
|
-
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-
|
|
42
|
-
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-
|
|
41
|
+
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
|
42
|
+
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences/#httperror `HttpError`}
|
|
43
43
|
* @typeParam TVariables - Values for mutation function
|
|
44
44
|
*
|
|
45
45
|
*/
|
|
@@ -17,7 +17,7 @@ export declare type UseCreateManyProps<TData extends BaseRecord = BaseRecord, TE
|
|
|
17
17
|
*
|
|
18
18
|
* It uses `createMany` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
|
|
19
19
|
*
|
|
20
|
-
* @see {@link https://refine.dev/docs/core/hooks/data/useCreateMany} for more details.
|
|
20
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/data/useCreateMany} for more details.
|
|
21
21
|
*
|
|
22
22
|
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/core/interfaceReferences#baserecord `BaseRecord`}
|
|
23
23
|
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/core/interfaceReferences#httperror `HttpError`}
|
|
@@ -47,7 +47,7 @@ export declare type UseCustomProps<TQueryFnData, TError, TQuery, TPayload, TData
|
|
|
47
47
|
*
|
|
48
48
|
* It uses the `custom` method from the `dataProvider` which is passed to `<Refine>`.
|
|
49
49
|
*
|
|
50
|
-
* @see {@link https://refine.dev/docs/core/hooks/data/useCustom} for more details.
|
|
50
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/data/useCustom} for more details.
|
|
51
51
|
*
|
|
52
52
|
* @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
|
53
53
|
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
|
|
@@ -28,10 +28,10 @@ export declare type UseCustomMutationProps<TData extends BaseRecord = BaseRecord
|
|
|
28
28
|
*
|
|
29
29
|
* It uses the `custom` method from the `dataProvider` which is passed to `<Refine>`.
|
|
30
30
|
*
|
|
31
|
-
* @see {@link https://refine.dev/docs/api-
|
|
31
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/data/useCustomMutation} for more details.
|
|
32
32
|
*
|
|
33
|
-
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-
|
|
34
|
-
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-
|
|
33
|
+
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
|
34
|
+
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences/#httperror `HttpError`}
|
|
35
35
|
* @typeParam TVariables - Values for mutation function
|
|
36
36
|
*
|
|
37
37
|
*/
|
|
@@ -24,10 +24,10 @@ export declare type UseDeleteProps<TData extends BaseRecord = BaseRecord, TError
|
|
|
24
24
|
*
|
|
25
25
|
* It uses `deleteOne` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
|
|
26
26
|
*
|
|
27
|
-
* @see {@link https://refine.dev/docs/api-
|
|
27
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/data/useDelete} for more details.
|
|
28
28
|
*
|
|
29
|
-
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-
|
|
30
|
-
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-
|
|
29
|
+
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
|
30
|
+
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences/#httperror `HttpError`}
|
|
31
31
|
* @typeParam TVariables - Values for params. default `{}`
|
|
32
32
|
*
|
|
33
33
|
*/
|
|
@@ -24,7 +24,7 @@ export declare type UseDeleteManyProps<TData extends BaseRecord = BaseRecord, TE
|
|
|
24
24
|
*
|
|
25
25
|
* It uses `deleteMany` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
|
|
26
26
|
*
|
|
27
|
-
* @see {@link https://refine.dev/docs/core/hooks/data/useDeleteMany} for more details.
|
|
27
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/data/useDeleteMany} for more details.
|
|
28
28
|
*
|
|
29
29
|
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/core/interfaceReferences#baserecord `BaseRecord`}
|
|
30
30
|
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/core/interfaceReferences#httperror `HttpError`}
|
|
@@ -59,7 +59,7 @@ export declare type UseInfiniteListProps<TQueryFnData, TError, TData> = {
|
|
|
59
59
|
*
|
|
60
60
|
* It uses the `getList` method as the query function from the `dataProvider` which is passed to `<Refine>`.
|
|
61
61
|
*
|
|
62
|
-
* @see {@link https://refine.dev/docs/core/hooks/data/useInfiniteList} for more details.
|
|
62
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/data/useInfiniteList} for more details.
|
|
63
63
|
*
|
|
64
64
|
* @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
|
65
65
|
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
|
|
@@ -59,7 +59,7 @@ export declare type UseListProps<TQueryFnData, TError, TData> = {
|
|
|
59
59
|
*
|
|
60
60
|
* It uses the `getList` method as the query function from the `dataProvider` which is passed to `<Refine>`.
|
|
61
61
|
*
|
|
62
|
-
* @see {@link https://refine.dev/docs/core/hooks/data/useList} for more details.
|
|
62
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/data/useList} for more details.
|
|
63
63
|
*
|
|
64
64
|
* @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
|
65
65
|
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
|
|
@@ -34,7 +34,7 @@ export declare type UseManyProps<TQueryFnData, TError, TData> = {
|
|
|
34
34
|
*
|
|
35
35
|
* It uses `getMany` method as query function from the `dataProvider` which is passed to `<Refine>`.
|
|
36
36
|
*
|
|
37
|
-
* @see {@link https://refine.dev/docs/core/hooks/data/useMany} for more details.
|
|
37
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/data/useMany} for more details.
|
|
38
38
|
*
|
|
39
39
|
* @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
|
40
40
|
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
|
|
@@ -36,7 +36,7 @@ export declare type UseOneProps<TQueryFnData, TError, TData> = {
|
|
|
36
36
|
*
|
|
37
37
|
* It uses `getOne` method as query function from the `dataProvider` which is passed to `<Refine>`.
|
|
38
38
|
*
|
|
39
|
-
* @see {@link https://refine.dev/docs/core/hooks/data/useOne} for more details.
|
|
39
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/data/useOne} for more details.
|
|
40
40
|
*
|
|
41
41
|
* @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
|
42
42
|
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
|
|
@@ -56,10 +56,10 @@ export declare type UseUpdateProps<TData extends BaseRecord = BaseRecord, TError
|
|
|
56
56
|
*
|
|
57
57
|
* It uses `update` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
|
|
58
58
|
*
|
|
59
|
-
* @see {@link https://refine.dev/docs/api-
|
|
59
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/data/useUpdate} for more details.
|
|
60
60
|
*
|
|
61
|
-
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-
|
|
62
|
-
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-
|
|
61
|
+
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
|
62
|
+
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences/#httperror `HttpError`}
|
|
63
63
|
* @typeParam TVariables - Values for mutation function
|
|
64
64
|
*
|
|
65
65
|
*/
|
|
@@ -31,7 +31,7 @@ export declare type UseUpdateManyProps<TData extends BaseRecord = BaseRecord, TE
|
|
|
31
31
|
*
|
|
32
32
|
* It uses `updateMany` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
|
|
33
33
|
*
|
|
34
|
-
* @see {@link https://refine.dev/docs/core/hooks/data/useUpdateMany} for more details.
|
|
34
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/data/useUpdateMany} for more details.
|
|
35
35
|
*
|
|
36
36
|
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/core/interfaceReferences#baserecord `BaseRecord`}
|
|
37
37
|
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/core/interfaceReferences#httperror `HttpError`}
|
|
@@ -64,9 +64,9 @@ declare type UseExportReturnType = {
|
|
|
64
64
|
/**
|
|
65
65
|
* `useExport` hook allows you to make your resources exportable.
|
|
66
66
|
*
|
|
67
|
-
* @see {@link https://refine.dev/docs/core/hooks/import-export/useExport} for more details.
|
|
67
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/import-export/useExport} for more details.
|
|
68
68
|
*
|
|
69
|
-
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-
|
|
69
|
+
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
|
70
70
|
* @typeParam TVariables - Values for params.
|
|
71
71
|
*
|
|
72
72
|
*/
|
|
@@ -36,6 +36,14 @@ declare type ActionFormProps<TQueryFnData extends BaseRecord = BaseRecord, TErro
|
|
|
36
36
|
* @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
|
|
37
37
|
*/
|
|
38
38
|
metaData?: MetaQuery;
|
|
39
|
+
/**
|
|
40
|
+
* Metadata to pass for the `useOne` query
|
|
41
|
+
*/
|
|
42
|
+
queryMeta?: MetaQuery;
|
|
43
|
+
/**
|
|
44
|
+
* Metadata to pass for the mutation (`useCreate` for `create` and `clone` actions, `useUpdate` for `edit` action)
|
|
45
|
+
*/
|
|
46
|
+
mutationMeta?: MetaQuery;
|
|
39
47
|
/**
|
|
40
48
|
* [Determines when mutations are executed](/advanced-tutorials/mutation-mode.md)
|
|
41
49
|
* @default `"pessimistic"*`
|
|
@@ -93,7 +101,7 @@ export declare type UseFormReturnType<TQueryFnData extends BaseRecord = BaseReco
|
|
|
93
101
|
/**
|
|
94
102
|
* `useForm` is used to manage forms. It uses Ant Design {@link https://ant.design/components/form/ Form} data scope management under the hood and returns the required props for managing the form actions.
|
|
95
103
|
*
|
|
96
|
-
* @see {@link https://refine.dev/docs/api-
|
|
104
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/useForm} for more details.
|
|
97
105
|
*
|
|
98
106
|
* @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
|
99
107
|
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
|
|
@@ -103,6 +111,6 @@ export declare type UseFormReturnType<TQueryFnData extends BaseRecord = BaseReco
|
|
|
103
111
|
* @typeParam TResponseError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}. Defaults to `TError`
|
|
104
112
|
*
|
|
105
113
|
*/
|
|
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>;
|
|
114
|
+
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, queryMeta, mutationMeta, 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>;
|
|
107
115
|
export {};
|
|
108
116
|
//# 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,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,
|
|
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;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;;;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,0xBAiYnB,CAAC"}
|
|
@@ -88,11 +88,11 @@ export declare type UseImportReturnType<TData extends BaseRecord = BaseRecord, T
|
|
|
88
88
|
/**
|
|
89
89
|
* `useImport` hook allows you to handle your csv import logic easily.
|
|
90
90
|
*
|
|
91
|
-
* @see {@link https://refine.dev/docs/core/hooks/import-export/useImport} for more details.
|
|
91
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/import-export/useImport} for more details.
|
|
92
92
|
*
|
|
93
93
|
* @typeParam TItem - Interface of parsed csv data
|
|
94
|
-
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-
|
|
95
|
-
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-
|
|
94
|
+
* @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
|
95
|
+
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences/#httperror `HttpError`}
|
|
96
96
|
* @typeParam TVariables - Values for mutation function
|
|
97
97
|
*
|
|
98
98
|
*/
|
|
@@ -21,7 +21,7 @@ export declare type TreeMenuItem = FlatTreeItem & {
|
|
|
21
21
|
* (passed as children to {@link https://refine.dev/docs/core/components/refine-config `<Refine>`}).
|
|
22
22
|
* This hook can also be used to build custom menus, which is also used by default sidebar to show menu items.
|
|
23
23
|
*
|
|
24
|
-
* @see {@link https://refine.dev/docs/core/hooks/ui/useMenu} for more details.
|
|
24
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/ui/useMenu} for more details.
|
|
25
25
|
*/
|
|
26
26
|
export declare const useMenu: ({ meta, hideOnMissingParameter }?: UseMenuProps) => UseMenuReturnType;
|
|
27
27
|
export {};
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import { BaseKey, IResourceItem, MetaDataQuery } from "../../interfaces";
|
|
2
2
|
export declare type HistoryType = "push" | "replace";
|
|
3
3
|
/**
|
|
4
|
-
* `refine` uses {@link https://reactrouter.com/
|
|
4
|
+
* `refine` uses {@link https://reactrouter.com/en/hooks/use-navigate `React Router`} and comes with all redirects out of the box.
|
|
5
5
|
* It allows you to manage your routing operations in refine.
|
|
6
6
|
* Using this hook, you can manage all the routing operations of your application very easily.
|
|
7
7
|
*
|
|
8
8
|
* @internal This is an internal hook of refine. Do not use it directly.
|
|
9
9
|
*
|
|
10
|
-
* @see {@link https://refine.dev/docs/core/hooks/navigation/useNavigation} for more details.
|
|
10
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/navigation/useNavigation} for more details.
|
|
11
11
|
*/
|
|
12
12
|
export declare const useNavigation: () => {
|
|
13
13
|
create: (resource: string | IResourceItem, type?: HistoryType, meta?: MetaDataQuery) => void;
|
|
@@ -6,7 +6,7 @@ declare type UseSyncWithLocationType = () => {
|
|
|
6
6
|
* List query parameter values can be edited manually by typing directly in the URL.
|
|
7
7
|
* To activate this feature `syncWithLocation` needs to be set to `true`.
|
|
8
8
|
*
|
|
9
|
-
* @see {@link https://refine.dev/docs/api-
|
|
9
|
+
* @see {@link https://refine.dev/docs/api-reference/core/components/refine-config/#syncwithlocation} for more details.
|
|
10
10
|
*/
|
|
11
11
|
export declare const useSyncWithLocation: UseSyncWithLocationType;
|
|
12
12
|
export {};
|
|
@@ -4,7 +4,7 @@ import { TitleProps } from "../../interfaces";
|
|
|
4
4
|
* `useTitle` returns a component that calls the `<Title>` passed to the `<Refine>`.
|
|
5
5
|
* In this way, it becomes easier for us to access this component in various parts of the application.
|
|
6
6
|
*
|
|
7
|
-
* @see {@link https://refine.dev/docs/core/hooks/refine/useTitle} for more details.
|
|
7
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/refine/useTitle} for more details.
|
|
8
8
|
*/
|
|
9
9
|
export declare const useTitle: () => React.FC<TitleProps> | undefined;
|
|
10
10
|
//# sourceMappingURL=useTitle.d.ts.map
|
|
@@ -8,7 +8,7 @@ declare type UseWarnAboutChangeType = () => {
|
|
|
8
8
|
* When you have unsaved changes and try to leave the current page, **refine** shows a confirmation modal box.
|
|
9
9
|
* To activate this feature, set the `warnWhenUnsavedChanges` to `true`.
|
|
10
10
|
*
|
|
11
|
-
* @see {@link https://refine.dev/docs/api-
|
|
11
|
+
* @see {@link https://refine.dev/docs/api-reference/core/components/refine-config#warnwhenunsavedchanges} for more details.
|
|
12
12
|
*/
|
|
13
13
|
export declare const useWarnAboutChange: UseWarnAboutChangeType;
|
|
14
14
|
export {};
|
|
@@ -43,7 +43,7 @@ export declare type useShowProps<TQueryFnData extends BaseRecord = BaseRecord, T
|
|
|
43
43
|
* It uses `getOne` method as query function from the dataProvider that is
|
|
44
44
|
* passed to {@link https://refine.dev/docs/api-reference/core/components/refine-config/ `<Refine>`}.
|
|
45
45
|
*
|
|
46
|
-
* @see {@link https://refine.dev/docs/core/hooks/show/useShow} for more details.
|
|
46
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/show/useShow} for more details.
|
|
47
47
|
*
|
|
48
48
|
* @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
|
49
49
|
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
|
|
@@ -3,7 +3,7 @@ export declare type UseGetLocaleType = () => () => string | undefined;
|
|
|
3
3
|
* If you need to know the current locale, refine provides the `useGetLocale` hook.
|
|
4
4
|
* It returns the `getLocale` method from `i18nProvider` under the hood.
|
|
5
5
|
*
|
|
6
|
-
* @see {@link https://refine.dev/docs/core/hooks/translate/useGetLocale} for more details.
|
|
6
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/translate/useGetLocale} for more details.
|
|
7
7
|
*/
|
|
8
8
|
export declare const useGetLocale: UseGetLocaleType;
|
|
9
9
|
//# sourceMappingURL=useGetLocale.d.ts.map
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* If you need to change the locale at runtime, refine provides the `useSetLocale` hook.
|
|
3
3
|
* It returns the changeLocale method from `i18nProvider` under the hood.
|
|
4
4
|
*
|
|
5
|
-
* @see {@link https://refine.dev/docs/core/hooks/translate/useSetLocale} for more details.
|
|
5
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/translate/useSetLocale} for more details.
|
|
6
6
|
*/
|
|
7
7
|
export declare const useSetLocale: () => (lang: string) => Promise<any> | undefined;
|
|
8
8
|
//# sourceMappingURL=useSetLocale.d.ts.map
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* If you need to translate the texts in your own components, refine provides the `useTranslate` hook.
|
|
3
3
|
* It returns the translate method from `i18nProvider` under the hood.
|
|
4
4
|
*
|
|
5
|
-
* @see {@link https://refine.dev/docs/core/hooks/translate/useTranslate} for more details.
|
|
5
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/translate/useTranslate} for more details.
|
|
6
6
|
*/
|
|
7
7
|
export declare const useTranslate: () => {
|
|
8
8
|
(key: string, options?: any, defaultMessage?: string): string;
|
|
@@ -103,7 +103,7 @@ export declare type UseSelectReturnType<TData extends BaseRecord = BaseRecord> =
|
|
|
103
103
|
* It uses `getList` method as query function from the dataProvider that is
|
|
104
104
|
* passed to {@link https://refine.dev/docs/api-reference/core/components/refine-config/ `<Refine>`}.
|
|
105
105
|
*
|
|
106
|
-
* @see {@link https://refine.dev/docs/core/hooks/useSelect} for more details.
|
|
106
|
+
* @see {@link https://refine.dev/docs/api-reference/core/hooks/useSelect} for more details.
|
|
107
107
|
*
|
|
108
108
|
* @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
|
|
109
109
|
* @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
|