@refinedev/core 5.0.0 → 5.0.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.
Files changed (107) hide show
  1. package/CHANGELOG.md +66 -0
  2. package/dist/contexts/refine/types.d.cts +0 -3
  3. package/dist/contexts/refine/types.d.cts.map +1 -1
  4. package/dist/contexts/refine/types.d.mts +0 -3
  5. package/dist/contexts/refine/types.d.mts.map +0 -3
  6. package/dist/contexts/refine/types.d.ts +0 -3
  7. package/dist/contexts/refine/types.d.ts.map +1 -1
  8. package/dist/contexts/router/types.d.cts +1 -1
  9. package/dist/contexts/router/types.d.cts.map +1 -1
  10. package/dist/contexts/router/types.d.mts +1 -1
  11. package/dist/contexts/router/types.d.mts.map +1 -1
  12. package/dist/contexts/router/types.d.ts +1 -1
  13. package/dist/contexts/router/types.d.ts.map +1 -1
  14. package/dist/definitions/table/index.d.cts +2 -2
  15. package/dist/definitions/table/index.d.mts +2 -2
  16. package/dist/definitions/table/index.d.mts.map +2 -2
  17. package/dist/definitions/table/index.d.ts +2 -2
  18. package/dist/hooks/accessControl/useCan/index.d.cts +1 -1
  19. package/dist/hooks/accessControl/useCan/index.d.mts +1 -1
  20. package/dist/hooks/accessControl/useCan/index.d.mts.map +1 -1
  21. package/dist/hooks/accessControl/useCan/index.d.ts +1 -1
  22. package/dist/hooks/data/useCreate.d.cts +1 -1
  23. package/dist/hooks/data/useCreate.d.mts +1 -1
  24. package/dist/hooks/data/useCreate.d.mts.map +1 -1
  25. package/dist/hooks/data/useCreate.d.ts +1 -1
  26. package/dist/hooks/data/useCreateMany.d.cts +1 -1
  27. package/dist/hooks/data/useCreateMany.d.mts +1 -1
  28. package/dist/hooks/data/useCreateMany.d.mts.map +1 -1
  29. package/dist/hooks/data/useCreateMany.d.ts +1 -1
  30. package/dist/hooks/data/useCustom.d.cts +2 -2
  31. package/dist/hooks/data/useCustom.d.mts +2 -2
  32. package/dist/hooks/data/useCustom.d.mts.map +2 -2
  33. package/dist/hooks/data/useCustom.d.ts +2 -2
  34. package/dist/hooks/data/useCustomMutation.d.cts +1 -1
  35. package/dist/hooks/data/useCustomMutation.d.mts +1 -1
  36. package/dist/hooks/data/useCustomMutation.d.mts.map +1 -1
  37. package/dist/hooks/data/useCustomMutation.d.ts +1 -1
  38. package/dist/hooks/data/useDelete.d.cts +1 -1
  39. package/dist/hooks/data/useDelete.d.mts +1 -1
  40. package/dist/hooks/data/useDelete.d.mts.map +1 -1
  41. package/dist/hooks/data/useDelete.d.ts +1 -1
  42. package/dist/hooks/data/useDeleteMany.d.cts +1 -1
  43. package/dist/hooks/data/useDeleteMany.d.mts +1 -1
  44. package/dist/hooks/data/useDeleteMany.d.mts.map +1 -1
  45. package/dist/hooks/data/useDeleteMany.d.ts +1 -1
  46. package/dist/hooks/data/useInfiniteList.d.cts +1 -1
  47. package/dist/hooks/data/useInfiniteList.d.mts +1 -1
  48. package/dist/hooks/data/useInfiniteList.d.mts.map +1 -1
  49. package/dist/hooks/data/useInfiniteList.d.ts +1 -1
  50. package/dist/hooks/data/useList.d.cts +2 -2
  51. package/dist/hooks/data/useList.d.mts +2 -2
  52. package/dist/hooks/data/useList.d.mts.map +2 -2
  53. package/dist/hooks/data/useList.d.ts +2 -2
  54. package/dist/hooks/data/useMany.d.cts +2 -2
  55. package/dist/hooks/data/useMany.d.mts +2 -2
  56. package/dist/hooks/data/useMany.d.mts.map +2 -2
  57. package/dist/hooks/data/useMany.d.ts +2 -2
  58. package/dist/hooks/data/useOne.d.cts +2 -2
  59. package/dist/hooks/data/useOne.d.mts +2 -2
  60. package/dist/hooks/data/useOne.d.mts.map +2 -2
  61. package/dist/hooks/data/useOne.d.ts +2 -2
  62. package/dist/hooks/data/useUpdate.d.cts +1 -1
  63. package/dist/hooks/data/useUpdate.d.mts +1 -1
  64. package/dist/hooks/data/useUpdate.d.mts.map +1 -1
  65. package/dist/hooks/data/useUpdate.d.ts +1 -1
  66. package/dist/hooks/data/useUpdateMany.d.cts +1 -1
  67. package/dist/hooks/data/useUpdateMany.d.mts +1 -1
  68. package/dist/hooks/data/useUpdateMany.d.mts.map +1 -1
  69. package/dist/hooks/data/useUpdateMany.d.ts +1 -1
  70. package/dist/hooks/form/types.d.cts +3 -3
  71. package/dist/hooks/form/types.d.mts +3 -3
  72. package/dist/hooks/form/types.d.mts.map +3 -3
  73. package/dist/hooks/form/types.d.ts +3 -3
  74. package/dist/hooks/show/types.d.cts +1 -1
  75. package/dist/hooks/show/types.d.mts +1 -1
  76. package/dist/hooks/show/types.d.mts.map +1 -1
  77. package/dist/hooks/show/types.d.ts +1 -1
  78. package/dist/hooks/useTable/index.d.cts +1 -1
  79. package/dist/hooks/useTable/index.d.mts +1 -1
  80. package/dist/hooks/useTable/index.d.mts.map +1 -1
  81. package/dist/hooks/useTable/index.d.ts +1 -1
  82. package/dist/index.cjs +16 -16
  83. package/dist/index.cjs.map +1 -1
  84. package/dist/index.mjs +17 -17
  85. package/dist/index.mjs.map +1 -1
  86. package/package.json +7 -8
  87. package/src/contexts/refine/types.ts +0 -3
  88. package/src/contexts/router/types.ts +1 -1
  89. package/src/definitions/table/__snapshots__/index.spec.ts.snap +4 -4
  90. package/src/definitions/table/index.ts +2 -2
  91. package/src/hooks/accessControl/useCan/index.ts +1 -1
  92. package/src/hooks/data/useCreate.ts +1 -1
  93. package/src/hooks/data/useCreateMany.ts +1 -1
  94. package/src/hooks/data/useCustom.ts +3 -3
  95. package/src/hooks/data/useCustomMutation.ts +1 -1
  96. package/src/hooks/data/useDelete.ts +1 -1
  97. package/src/hooks/data/useDeleteMany.ts +1 -1
  98. package/src/hooks/data/useInfiniteList.ts +2 -2
  99. package/src/hooks/data/useList.ts +3 -3
  100. package/src/hooks/data/useMany.ts +3 -3
  101. package/src/hooks/data/useOne.ts +3 -3
  102. package/src/hooks/data/useUpdate.ts +1 -1
  103. package/src/hooks/data/useUpdateMany.ts +1 -1
  104. package/src/hooks/form/types.ts +3 -3
  105. package/src/hooks/show/types.ts +1 -1
  106. package/src/hooks/useTable/index.ts +4 -4
  107. package/vitest.config.mts +43 -0
@@ -51,7 +51,7 @@ export type UseDeleteManyProps<TData extends BaseRecord = BaseRecord, TError ext
51
51
  mutationOptions?: Omit<UseMutationOptions<DeleteManyResponse<TData>, TError, DeleteManyParams<TData, TError, TVariables>, DeleteContext<TData>>, "mutationFn" | "onError" | "onSuccess" | "onSettled" | "onMutate">;
52
52
  } & UseLoadingOvertimeOptionsProps;
53
53
  /**
54
- * `useDeleteMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for multiple delete mutations.
54
+ * `useDeleteMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for multiple delete mutations.
55
55
  *
56
56
  * It uses `deleteMany` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
57
57
  *
@@ -51,7 +51,7 @@ export type UseDeleteManyProps<TData extends BaseRecord = BaseRecord, TError ext
51
51
  mutationOptions?: Omit<UseMutationOptions<DeleteManyResponse<TData>, TError, DeleteManyParams<TData, TError, TVariables>, DeleteContext<TData>>, "mutationFn" | "onError" | "onSuccess" | "onSettled" | "onMutate">;
52
52
  } & UseLoadingOvertimeOptionsProps;
53
53
  /**
54
- * `useDeleteMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for multiple delete mutations.
54
+ * `useDeleteMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for multiple delete mutations.
55
55
  *
56
56
  * It uses `deleteMany` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
57
57
  *
@@ -38,7 +38,7 @@ export type UseInfiniteListProps<TQueryFnData, TError, TData> = {
38
38
  */
39
39
  resource: string;
40
40
  /**
41
- * Tanstack Query's [useInfiniteQuery](https://tanstack.com/query/v4/docs/react/reference/useInfiniteQuery) options
41
+ * Tanstack Query's [useInfiniteQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useInfiniteQuery) options
42
42
  */
43
43
  queryOptions?: Omit<UseInfiniteListQueryOptions<TQueryFnData, TError, TData>, "getNextPageParam"> & {
44
44
  /**
@@ -38,7 +38,7 @@ export type UseInfiniteListProps<TQueryFnData, TError, TData> = {
38
38
  */
39
39
  resource: string;
40
40
  /**
41
- * Tanstack Query's [useInfiniteQuery](https://tanstack.com/query/v4/docs/react/reference/useInfiniteQuery) options
41
+ * Tanstack Query's [useInfiniteQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useInfiniteQuery) options
42
42
  */
43
43
  queryOptions?: Omit<UseInfiniteListQueryOptions<TQueryFnData, TError, TData>, "getNextPageParam"> & {
44
44
  /**
@@ -38,7 +38,7 @@ export type UseInfiniteListProps<TQueryFnData, TError, TData> = {
38
38
  */
39
39
  resource: string;
40
40
  /**
41
- * Tanstack Query's [useInfiniteQuery](https://tanstack.com/query/v4/docs/react/reference/useInfiniteQuery) options
41
+ * Tanstack Query's [useInfiniteQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useInfiniteQuery) options
42
42
  */
43
43
  queryOptions?: Omit<UseInfiniteListQueryOptions<TQueryFnData, TError, TData>, "getNextPageParam"> & {
44
44
  /**
@@ -38,7 +38,7 @@ export type UseInfiniteListProps<TQueryFnData, TError, TData> = {
38
38
  */
39
39
  resource: string;
40
40
  /**
41
- * Tanstack Query's [useInfiniteQuery](https://tanstack.com/query/v4/docs/react/reference/useInfiniteQuery) options
41
+ * Tanstack Query's [useInfiniteQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useInfiniteQuery) options
42
42
  */
43
43
  queryOptions?: Omit<UseInfiniteListQueryOptions<TQueryFnData, TError, TData>, "getNextPageParam"> & {
44
44
  /**
@@ -33,7 +33,7 @@ export type UseListProps<TQueryFnData, TError, TData> = {
33
33
  */
34
34
  resource?: string;
35
35
  /**
36
- * Tanstack Query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
36
+ * Tanstack Query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
37
37
  */
38
38
  queryOptions?: UseListQueryOptions<TQueryFnData, TError, TData>;
39
39
  } & BaseListProps & SuccessErrorNotification<GetListResponse<TData>, TError, Prettify<BaseListProps>> & LiveModeProps & UseLoadingOvertimeOptionsProps;
@@ -45,7 +45,7 @@ export type UseListReturnType<TData, TError> = {
45
45
  };
46
46
  } & UseLoadingOvertimeReturnType;
47
47
  /**
48
- * `useList` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for retrieving items from a `resource` with pagination, sort, and filter configurations.
48
+ * `useList` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for retrieving items from a `resource` with pagination, sort, and filter configurations.
49
49
  *
50
50
  * It uses the `getList` method as the query function from the `dataProvider` which is passed to `<Refine>`.
51
51
  *
@@ -33,7 +33,7 @@ export type UseListProps<TQueryFnData, TError, TData> = {
33
33
  */
34
34
  resource?: string;
35
35
  /**
36
- * Tanstack Query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
36
+ * Tanstack Query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
37
37
  */
38
38
  queryOptions?: UseListQueryOptions<TQueryFnData, TError, TData>;
39
39
  } & BaseListProps & SuccessErrorNotification<GetListResponse<TData>, TError, Prettify<BaseListProps>> & LiveModeProps & UseLoadingOvertimeOptionsProps;
@@ -45,7 +45,7 @@ export type UseListReturnType<TData, TError> = {
45
45
  };
46
46
  } & UseLoadingOvertimeReturnType;
47
47
  /**
48
- * `useList` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for retrieving items from a `resource` with pagination, sort, and filter configurations.
48
+ * `useList` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for retrieving items from a `resource` with pagination, sort, and filter configurations.
49
49
  *
50
50
  * It uses the `getList` method as the query function from the `dataProvider` which is passed to `<Refine>`.
51
51
  *
@@ -33,7 +33,7 @@ export type UseListProps<TQueryFnData, TError, TData> = {
33
33
  */
34
34
  resource?: string;
35
35
  /**
36
- * Tanstack Query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
36
+ * Tanstack Query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
37
37
  */
38
38
  queryOptions?: UseListQueryOptions<TQueryFnData, TError, TData>;
39
39
  } & BaseListProps & SuccessErrorNotification<GetListResponse<TData>, TError, Prettify<BaseListProps>> & LiveModeProps & UseLoadingOvertimeOptionsProps;
@@ -45,7 +45,7 @@ export type UseListReturnType<TData, TError> = {
45
45
  };
46
46
  } & UseLoadingOvertimeReturnType;
47
47
  /**
48
- * `useList` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for retrieving items from a `resource` with pagination, sort, and filter configurations.
48
+ * `useList` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for retrieving items from a `resource` with pagination, sort, and filter configurations.
49
49
  *
50
50
  * It uses the `getList` method as the query function from the `dataProvider` which is passed to `<Refine>`.
51
51
  *
@@ -33,7 +33,7 @@ export type UseListProps<TQueryFnData, TError, TData> = {
33
33
  */
34
34
  resource?: string;
35
35
  /**
36
- * Tanstack Query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
36
+ * Tanstack Query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
37
37
  */
38
38
  queryOptions?: UseListQueryOptions<TQueryFnData, TError, TData>;
39
39
  } & BaseListProps & SuccessErrorNotification<GetListResponse<TData>, TError, Prettify<BaseListProps>> & LiveModeProps & UseLoadingOvertimeOptionsProps;
@@ -45,7 +45,7 @@ export type UseListReturnType<TData, TError> = {
45
45
  };
46
46
  } & UseLoadingOvertimeReturnType;
47
47
  /**
48
- * `useList` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for retrieving items from a `resource` with pagination, sort, and filter configurations.
48
+ * `useList` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for retrieving items from a `resource` with pagination, sort, and filter configurations.
49
49
  *
50
50
  * It uses the `getList` method as the query function from the `dataProvider` which is passed to `<Refine>`.
51
51
  *
@@ -22,7 +22,7 @@ export type UseManyProps<TQueryFnData, TError, TData> = {
22
22
  */
23
23
  ids: BaseKey[];
24
24
  /**
25
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
25
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
26
26
  */
27
27
  queryOptions?: UseManyQueryOptions<TQueryFnData, TError, TData>;
28
28
  /**
@@ -36,7 +36,7 @@ export type UseManyProps<TQueryFnData, TError, TData> = {
36
36
  dataProviderName?: string;
37
37
  } & SuccessErrorNotification<GetManyResponse<TData>, TError, BaseKey[]> & LiveModeProps & UseLoadingOvertimeOptionsProps;
38
38
  /**
39
- * `useMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for retrieving multiple items from a `resource`.
39
+ * `useMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for retrieving multiple items from a `resource`.
40
40
  *
41
41
  * It uses `getMany` method as query function from the `dataProvider` which is passed to `<Refine>`.
42
42
  *
@@ -22,7 +22,7 @@ export type UseManyProps<TQueryFnData, TError, TData> = {
22
22
  */
23
23
  ids: BaseKey[];
24
24
  /**
25
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
25
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
26
26
  */
27
27
  queryOptions?: UseManyQueryOptions<TQueryFnData, TError, TData>;
28
28
  /**
@@ -36,7 +36,7 @@ export type UseManyProps<TQueryFnData, TError, TData> = {
36
36
  dataProviderName?: string;
37
37
  } & SuccessErrorNotification<GetManyResponse<TData>, TError, BaseKey[]> & LiveModeProps & UseLoadingOvertimeOptionsProps;
38
38
  /**
39
- * `useMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for retrieving multiple items from a `resource`.
39
+ * `useMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for retrieving multiple items from a `resource`.
40
40
  *
41
41
  * It uses `getMany` method as query function from the `dataProvider` which is passed to `<Refine>`.
42
42
  *
@@ -22,7 +22,7 @@ export type UseManyProps<TQueryFnData, TError, TData> = {
22
22
  */
23
23
  ids: BaseKey[];
24
24
  /**
25
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
25
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
26
26
  */
27
27
  queryOptions?: UseManyQueryOptions<TQueryFnData, TError, TData>;
28
28
  /**
@@ -36,7 +36,7 @@ export type UseManyProps<TQueryFnData, TError, TData> = {
36
36
  dataProviderName?: string;
37
37
  } & SuccessErrorNotification<GetManyResponse<TData>, TError, BaseKey[]> & LiveModeProps & UseLoadingOvertimeOptionsProps;
38
38
  /**
39
- * `useMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for retrieving multiple items from a `resource`.
39
+ * `useMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for retrieving multiple items from a `resource`.
40
40
  *
41
41
  * It uses `getMany` method as query function from the `dataProvider` which is passed to `<Refine>`.
42
42
  *
@@ -22,7 +22,7 @@ export type UseManyProps<TQueryFnData, TError, TData> = {
22
22
  */
23
23
  ids: BaseKey[];
24
24
  /**
25
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
25
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
26
26
  */
27
27
  queryOptions?: UseManyQueryOptions<TQueryFnData, TError, TData>;
28
28
  /**
@@ -36,7 +36,7 @@ export type UseManyProps<TQueryFnData, TError, TData> = {
36
36
  dataProviderName?: string;
37
37
  } & SuccessErrorNotification<GetManyResponse<TData>, TError, BaseKey[]> & LiveModeProps & UseLoadingOvertimeOptionsProps;
38
38
  /**
39
- * `useMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for retrieving multiple items from a `resource`.
39
+ * `useMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for retrieving multiple items from a `resource`.
40
40
  *
41
41
  * It uses `getMany` method as query function from the `dataProvider` which is passed to `<Refine>`.
42
42
  *
@@ -14,7 +14,7 @@ export type UseOneProps<TQueryFnData, TError, TData> = {
14
14
  */
15
15
  id?: BaseKey;
16
16
  /**
17
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
17
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
18
18
  */
19
19
  queryOptions?: Omit<UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>, "queryKey" | "queryFn"> & {
20
20
  queryKey?: UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>["queryKey"];
@@ -37,7 +37,7 @@ export type UseOneReturnType<TData, TError> = {
37
37
  result: TData | undefined;
38
38
  } & UseLoadingOvertimeReturnType;
39
39
  /**
40
- * `useOne` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for retrieving single items from a `resource`.
40
+ * `useOne` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for retrieving single items from a `resource`.
41
41
  *
42
42
  * It uses `getOne` method as query function from the `dataProvider` which is passed to `<Refine>`.
43
43
  *
@@ -14,7 +14,7 @@ export type UseOneProps<TQueryFnData, TError, TData> = {
14
14
  */
15
15
  id?: BaseKey;
16
16
  /**
17
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
17
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
18
18
  */
19
19
  queryOptions?: Omit<UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>, "queryKey" | "queryFn"> & {
20
20
  queryKey?: UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>["queryKey"];
@@ -37,7 +37,7 @@ export type UseOneReturnType<TData, TError> = {
37
37
  result: TData | undefined;
38
38
  } & UseLoadingOvertimeReturnType;
39
39
  /**
40
- * `useOne` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for retrieving single items from a `resource`.
40
+ * `useOne` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for retrieving single items from a `resource`.
41
41
  *
42
42
  * It uses `getOne` method as query function from the `dataProvider` which is passed to `<Refine>`.
43
43
  *
@@ -14,7 +14,7 @@ export type UseOneProps<TQueryFnData, TError, TData> = {
14
14
  */
15
15
  id?: BaseKey;
16
16
  /**
17
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
17
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
18
18
  */
19
19
  queryOptions?: Omit<UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>, "queryKey" | "queryFn"> & {
20
20
  queryKey?: UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>["queryKey"];
@@ -37,7 +37,7 @@ export type UseOneReturnType<TData, TError> = {
37
37
  result: TData | undefined;
38
38
  } & UseLoadingOvertimeReturnType;
39
39
  /**
40
- * `useOne` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for retrieving single items from a `resource`.
40
+ * `useOne` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for retrieving single items from a `resource`.
41
41
  *
42
42
  * It uses `getOne` method as query function from the `dataProvider` which is passed to `<Refine>`.
43
43
  *
@@ -14,7 +14,7 @@ export type UseOneProps<TQueryFnData, TError, TData> = {
14
14
  */
15
15
  id?: BaseKey;
16
16
  /**
17
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
17
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
18
18
  */
19
19
  queryOptions?: Omit<UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>, "queryKey" | "queryFn"> & {
20
20
  queryKey?: UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>["queryKey"];
@@ -37,7 +37,7 @@ export type UseOneReturnType<TData, TError> = {
37
37
  result: TData | undefined;
38
38
  } & UseLoadingOvertimeReturnType;
39
39
  /**
40
- * `useOne` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for retrieving single items from a `resource`.
40
+ * `useOne` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for retrieving single items from a `resource`.
41
41
  *
42
42
  * It uses `getOne` method as query function from the `dataProvider` which is passed to `<Refine>`.
43
43
  *
@@ -66,7 +66,7 @@ export type UseUpdateProps<TData extends BaseRecord = BaseRecord, TError extends
66
66
  mutationOptions?: Omit<UseMutationOptions<UpdateResponse<TData>, TError, UpdateParams<TData, TError, TVariables>, UpdateContext<TData>>, "mutationFn" | "onMutate">;
67
67
  } & UseLoadingOvertimeOptionsProps & UpdateParams<TData, TError, TVariables>;
68
68
  /**
69
- * `useUpdate` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for update mutations.
69
+ * `useUpdate` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for update mutations.
70
70
  *
71
71
  * It uses `update` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
72
72
  *
@@ -66,7 +66,7 @@ export type UseUpdateProps<TData extends BaseRecord = BaseRecord, TError extends
66
66
  mutationOptions?: Omit<UseMutationOptions<UpdateResponse<TData>, TError, UpdateParams<TData, TError, TVariables>, UpdateContext<TData>>, "mutationFn" | "onMutate">;
67
67
  } & UseLoadingOvertimeOptionsProps & UpdateParams<TData, TError, TVariables>;
68
68
  /**
69
- * `useUpdate` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for update mutations.
69
+ * `useUpdate` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for update mutations.
70
70
  *
71
71
  * It uses `update` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
72
72
  *
@@ -66,7 +66,7 @@ export type UseUpdateProps<TData extends BaseRecord = BaseRecord, TError extends
66
66
  mutationOptions?: Omit<UseMutationOptions<UpdateResponse<TData>, TError, UpdateParams<TData, TError, TVariables>, UpdateContext<TData>>, "mutationFn" | "onMutate">;
67
67
  } & UseLoadingOvertimeOptionsProps & UpdateParams<TData, TError, TVariables>;
68
68
  /**
69
- * `useUpdate` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for update mutations.
69
+ * `useUpdate` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for update mutations.
70
70
  *
71
71
  * It uses `update` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
72
72
  *
@@ -66,7 +66,7 @@ export type UseUpdateProps<TData extends BaseRecord = BaseRecord, TError extends
66
66
  mutationOptions?: Omit<UseMutationOptions<UpdateResponse<TData>, TError, UpdateParams<TData, TError, TVariables>, UpdateContext<TData>>, "mutationFn" | "onMutate">;
67
67
  } & UseLoadingOvertimeOptionsProps & UpdateParams<TData, TError, TVariables>;
68
68
  /**
69
- * `useUpdate` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for update mutations.
69
+ * `useUpdate` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for update mutations.
70
70
  *
71
71
  * It uses `update` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
72
72
  *
@@ -66,7 +66,7 @@ export type UseUpdateManyProps<TData extends BaseRecord = BaseRecord, TError ext
66
66
  mutationOptions?: Omit<UseMutationOptions<UpdateManyResponse<TData>, TError, UpdateManyParams<TData, TError, TVariables>, UpdateContext<TData>>, "mutationFn" | "onMutate">;
67
67
  } & UseLoadingOvertimeOptionsProps & UpdateManyParams<TData, TError, TVariables>;
68
68
  /**
69
- * `useUpdateMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for multiple update mutations.
69
+ * `useUpdateMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for multiple update mutations.
70
70
  *
71
71
  * It uses `updateMany` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
72
72
  *
@@ -66,7 +66,7 @@ export type UseUpdateManyProps<TData extends BaseRecord = BaseRecord, TError ext
66
66
  mutationOptions?: Omit<UseMutationOptions<UpdateManyResponse<TData>, TError, UpdateManyParams<TData, TError, TVariables>, UpdateContext<TData>>, "mutationFn" | "onMutate">;
67
67
  } & UseLoadingOvertimeOptionsProps & UpdateManyParams<TData, TError, TVariables>;
68
68
  /**
69
- * `useUpdateMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for multiple update mutations.
69
+ * `useUpdateMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for multiple update mutations.
70
70
  *
71
71
  * It uses `updateMany` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
72
72
  *
@@ -66,7 +66,7 @@ export type UseUpdateManyProps<TData extends BaseRecord = BaseRecord, TError ext
66
66
  mutationOptions?: Omit<UseMutationOptions<UpdateManyResponse<TData>, TError, UpdateManyParams<TData, TError, TVariables>, UpdateContext<TData>>, "mutationFn" | "onMutate">;
67
67
  } & UseLoadingOvertimeOptionsProps & UpdateManyParams<TData, TError, TVariables>;
68
68
  /**
69
- * `useUpdateMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for multiple update mutations.
69
+ * `useUpdateMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for multiple update mutations.
70
70
  *
71
71
  * It uses `updateMany` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
72
72
  *
@@ -66,7 +66,7 @@ export type UseUpdateManyProps<TData extends BaseRecord = BaseRecord, TError ext
66
66
  mutationOptions?: Omit<UseMutationOptions<UpdateManyResponse<TData>, TError, UpdateManyParams<TData, TError, TVariables>, UpdateContext<TData>>, "mutationFn" | "onMutate">;
67
67
  } & UseLoadingOvertimeOptionsProps & UpdateManyParams<TData, TError, TVariables>;
68
68
  /**
69
- * `useUpdateMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for multiple update mutations.
69
+ * `useUpdateMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for multiple update mutations.
70
70
  *
71
71
  * It uses `updateMany` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
72
72
  *
@@ -89,15 +89,15 @@ type ActionFormProps<TQueryFnData extends BaseRecord = BaseRecord, TError extend
89
89
  */
90
90
  invalidates?: Array<keyof IQueryKeys>;
91
91
  /**
92
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options of useOne hook used while in edit mode.
92
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options of useOne hook used while in edit mode.
93
93
  */
94
94
  queryOptions?: MakeOptional<UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>, "queryFn" | "queryKey">;
95
95
  /**
96
- * react-query's [useMutation](https://tanstack.com/query/v4/docs/reference/useMutation) options of useCreate hook used while submitting in create and clone modes.
96
+ * react-query's [useMutation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) options of useCreate hook used while submitting in create and clone modes.
97
97
  */
98
98
  createMutationOptions?: UseCreateProps<TResponse, TResponseError, TVariables>["mutationOptions"];
99
99
  /**
100
- * react-query's [useMutation](https://tanstack.com/query/v4/docs/reference/useMutation) options of useUpdate hook used while submitting in edit mode.
100
+ * react-query's [useMutation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) options of useUpdate hook used while submitting in edit mode.
101
101
  */
102
102
  updateMutationOptions?: UseUpdateProps<TResponse, TResponseError, TVariables>["mutationOptions"];
103
103
  /**
@@ -89,15 +89,15 @@ type ActionFormProps<TQueryFnData extends BaseRecord = BaseRecord, TError extend
89
89
  */
90
90
  invalidates?: Array<keyof IQueryKeys>;
91
91
  /**
92
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options of useOne hook used while in edit mode.
92
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options of useOne hook used while in edit mode.
93
93
  */
94
94
  queryOptions?: MakeOptional<UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>, "queryFn" | "queryKey">;
95
95
  /**
96
- * react-query's [useMutation](https://tanstack.com/query/v4/docs/reference/useMutation) options of useCreate hook used while submitting in create and clone modes.
96
+ * react-query's [useMutation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) options of useCreate hook used while submitting in create and clone modes.
97
97
  */
98
98
  createMutationOptions?: UseCreateProps<TResponse, TResponseError, TVariables>["mutationOptions"];
99
99
  /**
100
- * react-query's [useMutation](https://tanstack.com/query/v4/docs/reference/useMutation) options of useUpdate hook used while submitting in edit mode.
100
+ * react-query's [useMutation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) options of useUpdate hook used while submitting in edit mode.
101
101
  */
102
102
  updateMutationOptions?: UseUpdateProps<TResponse, TResponseError, TVariables>["mutationOptions"];
103
103
  /**
@@ -89,15 +89,15 @@ type ActionFormProps<TQueryFnData extends BaseRecord = BaseRecord, TError extend
89
89
  */
90
90
  invalidates?: Array<keyof IQueryKeys>;
91
91
  /**
92
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options of useOne hook used while in edit mode.
92
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options of useOne hook used while in edit mode.
93
93
  */
94
94
  queryOptions?: MakeOptional<UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>, "queryFn" | "queryKey">;
95
95
  /**
96
- * react-query's [useMutation](https://tanstack.com/query/v4/docs/reference/useMutation) options of useCreate hook used while submitting in create and clone modes.
96
+ * react-query's [useMutation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) options of useCreate hook used while submitting in create and clone modes.
97
97
  */
98
98
  createMutationOptions?: UseCreateProps<TResponse, TResponseError, TVariables>["mutationOptions"];
99
99
  /**
100
- * react-query's [useMutation](https://tanstack.com/query/v4/docs/reference/useMutation) options of useUpdate hook used while submitting in edit mode.
100
+ * react-query's [useMutation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) options of useUpdate hook used while submitting in edit mode.
101
101
  */
102
102
  updateMutationOptions?: UseUpdateProps<TResponse, TResponseError, TVariables>["mutationOptions"];
103
103
  /**
@@ -89,15 +89,15 @@ type ActionFormProps<TQueryFnData extends BaseRecord = BaseRecord, TError extend
89
89
  */
90
90
  invalidates?: Array<keyof IQueryKeys>;
91
91
  /**
92
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options of useOne hook used while in edit mode.
92
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options of useOne hook used while in edit mode.
93
93
  */
94
94
  queryOptions?: MakeOptional<UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>, "queryFn" | "queryKey">;
95
95
  /**
96
- * react-query's [useMutation](https://tanstack.com/query/v4/docs/reference/useMutation) options of useCreate hook used while submitting in create and clone modes.
96
+ * react-query's [useMutation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) options of useCreate hook used while submitting in create and clone modes.
97
97
  */
98
98
  createMutationOptions?: UseCreateProps<TResponse, TResponseError, TVariables>["mutationOptions"];
99
99
  /**
100
- * react-query's [useMutation](https://tanstack.com/query/v4/docs/reference/useMutation) options of useUpdate hook used while submitting in edit mode.
100
+ * react-query's [useMutation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) options of useUpdate hook used while submitting in edit mode.
101
101
  */
102
102
  updateMutationOptions?: UseUpdateProps<TResponse, TResponseError, TVariables>["mutationOptions"];
103
103
  /**
@@ -23,7 +23,7 @@ export type UseShowProps<TQueryFnData extends BaseRecord = BaseRecord, TError ex
23
23
  */
24
24
  id?: BaseKey;
25
25
  /**
26
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
26
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
27
27
  */
28
28
  queryOptions?: MakeOptional<UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>, "queryKey" | "queryFn">;
29
29
  /**
@@ -23,7 +23,7 @@ export type UseShowProps<TQueryFnData extends BaseRecord = BaseRecord, TError ex
23
23
  */
24
24
  id?: BaseKey;
25
25
  /**
26
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
26
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
27
27
  */
28
28
  queryOptions?: MakeOptional<UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>, "queryKey" | "queryFn">;
29
29
  /**
@@ -23,7 +23,7 @@ export type UseShowProps<TQueryFnData extends BaseRecord = BaseRecord, TError ex
23
23
  */
24
24
  id?: BaseKey;
25
25
  /**
26
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
26
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
27
27
  */
28
28
  queryOptions?: MakeOptional<UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>, "queryKey" | "queryFn">;
29
29
  /**
@@ -23,7 +23,7 @@ export type UseShowProps<TQueryFnData extends BaseRecord = BaseRecord, TError ex
23
23
  */
24
24
  id?: BaseKey;
25
25
  /**
26
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
26
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
27
27
  */
28
28
  queryOptions?: MakeOptional<UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>>, "queryKey" | "queryFn">;
29
29
  /**
@@ -66,7 +66,7 @@ export type useTableProps<TQueryFnData, TError, TData> = {
66
66
  */
67
67
  syncWithLocation?: boolean;
68
68
  /**
69
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
69
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
70
70
  */
71
71
  queryOptions?: MakeOptional<UseQueryOptions<GetListResponse<TQueryFnData>, TError, GetListResponse<TData>>, "queryKey" | "queryFn">;
72
72
  /**
@@ -66,7 +66,7 @@ export type useTableProps<TQueryFnData, TError, TData> = {
66
66
  */
67
67
  syncWithLocation?: boolean;
68
68
  /**
69
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
69
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
70
70
  */
71
71
  queryOptions?: MakeOptional<UseQueryOptions<GetListResponse<TQueryFnData>, TError, GetListResponse<TData>>, "queryKey" | "queryFn">;
72
72
  /**
@@ -66,7 +66,7 @@ export type useTableProps<TQueryFnData, TError, TData> = {
66
66
  */
67
67
  syncWithLocation?: boolean;
68
68
  /**
69
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
69
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
70
70
  */
71
71
  queryOptions?: MakeOptional<UseQueryOptions<GetListResponse<TQueryFnData>, TError, GetListResponse<TData>>, "queryKey" | "queryFn">;
72
72
  /**
@@ -66,7 +66,7 @@ export type useTableProps<TQueryFnData, TError, TData> = {
66
66
  */
67
67
  syncWithLocation?: boolean;
68
68
  /**
69
- * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
69
+ * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
70
70
  */
71
71
  queryOptions?: MakeOptional<UseQueryOptions<GetListResponse<TQueryFnData>, TError, GetListResponse<TData>>, "queryKey" | "queryFn">;
72
72
  /**