@refinedev/core 4.14.0 → 4.14.3
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 +18 -0
- package/dist/components/containers/refine/index.d.ts +23 -23
- package/dist/esm/index.js +5 -5
- package/dist/esm/index.js.map +1 -1
- package/dist/hooks/data/useDelete.d.ts.map +1 -1
- package/dist/hooks/data/useDeleteMany.d.ts.map +1 -1
- package/dist/hooks/data/useUpdate.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/components/containers/refine/index.tsx +23 -23
- package/src/hooks/data/useDelete.ts +5 -0
- package/src/hooks/data/useDeleteMany.ts +5 -0
- package/src/hooks/data/useUpdate.ts +5 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@refinedev/core",
|
|
3
|
-
"version": "4.14.
|
|
3
|
+
"version": "4.14.3",
|
|
4
4
|
"description": "refine is a React-based framework for building internal tools, rapidly. It ships with Ant Design System, an enterprise-level UI toolkit.",
|
|
5
5
|
"private": false,
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -51,129 +51,129 @@ export interface RefineProps {
|
|
|
51
51
|
/**
|
|
52
52
|
* `resources` is the predefined interaction points for a refine app. A resource represents an entity in an endpoint in the API.
|
|
53
53
|
* While this is not a required property, it is used in resource detection and creation of routes for the app.
|
|
54
|
-
* @type [`ResourceProps[]`](/docs/api-reference/core/components/refine-config/#resources)
|
|
54
|
+
* @type [`ResourceProps[]`](https://refine.dev/docs/api-reference/core/components/refine-config/#resources)
|
|
55
55
|
*/
|
|
56
56
|
resources?: ResourceProps[];
|
|
57
57
|
/**
|
|
58
58
|
* **refine** needs some router functions to create resource pages, handle navigation, etc. This provider allows you to use the router library you want
|
|
59
|
-
* @type [`IRouterProvider`](/docs/api-reference/core/providers/router-provider/)
|
|
59
|
+
* @type [`IRouterProvider`](https://refine.dev/docs/api-reference/core/providers/router-provider/)
|
|
60
60
|
* @deprecated This property is deprecated and was the legacy way of routing. Please use `routerProvider` with new router bindings instead.
|
|
61
61
|
*/
|
|
62
62
|
legacyRouterProvider?: IRouterProvider;
|
|
63
63
|
/**
|
|
64
64
|
* Router bindings for **refine**. A simple interface for **refine** to interact with your router in a flexible way.
|
|
65
|
-
* @type [`RouterBindings`](/docs/api-reference/core/bindings/router/)
|
|
65
|
+
* @type [`RouterBindings`](https://refine.dev/docs/api-reference/core/bindings/router/)
|
|
66
66
|
*/
|
|
67
67
|
routerProvider?: RouterBindings;
|
|
68
68
|
/**
|
|
69
69
|
* A `dataProvider` is the place where a refine app communicates with an API. Data providers also act as adapters for refine, making it possible for it to consume different API's and data services.
|
|
70
|
-
* @type [`IDataContextProvider` | `IDataMultipleContextProvider`](/docs/api-reference/core/providers/data-provider/)
|
|
70
|
+
* @type [`IDataContextProvider` | `IDataMultipleContextProvider`](https://refine.dev/docs/api-reference/core/providers/data-provider/)
|
|
71
71
|
*/
|
|
72
72
|
dataProvider: IDataContextProvider | IDataMultipleContextProvider;
|
|
73
73
|
/**
|
|
74
74
|
* `authProvider` handles authentication logic like login, logout flow and checking user credentials. It is an object with methods that refine uses when necessary.
|
|
75
|
-
* @type [`AuthBindings`](/docs/api-reference/core/providers/auth-provider/)
|
|
75
|
+
* @type [`AuthBindings`](https://refine.dev/docs/api-reference/core/providers/auth-provider/)
|
|
76
76
|
*/
|
|
77
77
|
authProvider?: AuthBindings;
|
|
78
78
|
/**
|
|
79
79
|
* `legacyAuthProvider` handles authentication logic like login, logout flow and checking user credentials. It is an object with methods that refine uses when necessary.
|
|
80
|
-
* @type [`AuthProvider`](/docs/api-reference/core/providers/auth-provider/)
|
|
80
|
+
* @type [`AuthProvider`](https://refine.dev/docs/api-reference/core/providers/auth-provider/)
|
|
81
81
|
* @deprecated `legacyAuthProvider` is deprecated with refine@4, use `authProvider` instead.
|
|
82
82
|
*/
|
|
83
83
|
legacyAuthProvider?: LegacyAuthProvider;
|
|
84
84
|
/**
|
|
85
85
|
* **refine** lets you add Realtime support to your app via `liveProvider`. It can be used to update and show data in Realtime throughout your app.
|
|
86
|
-
* @type [`ILiveContext`](/docs/api-reference/core/providers/live-provider/)
|
|
86
|
+
* @type [`ILiveContext`](https://refine.dev/docs/api-reference/core/providers/live-provider/)
|
|
87
87
|
*/
|
|
88
88
|
liveProvider?: ILiveContext;
|
|
89
89
|
/**
|
|
90
90
|
* `notificationProvider` handles notification logics. It is an object with methods that refine uses when necessary.
|
|
91
|
-
* @type [`NotificationProvider` | `(() => NotificationProvider)`](/docs/api-reference/core/providers/notification-provider/)
|
|
91
|
+
* @type [`NotificationProvider` | `(() => NotificationProvider)`](https://refine.dev/docs/api-reference/core/providers/notification-provider/)
|
|
92
92
|
*/
|
|
93
93
|
notificationProvider?: NotificationProvider | (() => NotificationProvider);
|
|
94
94
|
/**
|
|
95
95
|
* `accessControlProvider` is the entry point for implementing access control for refine apps.
|
|
96
|
-
* @type [`AccessControlProvider`](/docs/api-reference/core/providers/accessControl-provider/)
|
|
96
|
+
* @type [`AccessControlProvider`](https://refine.dev/docs/api-reference/core/providers/accessControl-provider/)
|
|
97
97
|
*/
|
|
98
98
|
accessControlProvider?: AccessControlProvider;
|
|
99
99
|
/**
|
|
100
100
|
* **refine** allows you to track changes in your data and keep track of who made the changes.
|
|
101
|
-
* @type [`AuditLogProvider`](/docs/api-reference/core/providers/audit-log-provider#overview)
|
|
101
|
+
* @type [`AuditLogProvider`](https://refine.dev/docs/api-reference/core/providers/audit-log-provider#overview)
|
|
102
102
|
*/
|
|
103
103
|
auditLogProvider?: AuditLogProvider;
|
|
104
104
|
/**
|
|
105
105
|
* `i18nProvider` property lets you add i18n support to your app. Making you able to use any i18n framework.
|
|
106
|
-
* @type [`i18nProvider`](/docs/api-reference/core/providers/i18n-provider/)
|
|
106
|
+
* @type [`i18nProvider`](https://refine.dev/docs/api-reference/core/providers/i18n-provider/)
|
|
107
107
|
*/
|
|
108
108
|
i18nProvider?: I18nProvider;
|
|
109
109
|
/**
|
|
110
110
|
* A custom error component.
|
|
111
|
-
* @type [`ReactNode`](/docs/api-reference/core/components/refine-config/#catchall)
|
|
111
|
+
* @type [`ReactNode`](https://refine.dev/docs/api-reference/core/components/refine-config/#catchall)
|
|
112
112
|
* @deprecated Please use the `catchAll` element in your routes instead.
|
|
113
113
|
*/
|
|
114
114
|
catchAll?: React.ReactNode;
|
|
115
115
|
/**
|
|
116
116
|
* Custom login component can be passed to the `LoginPage` property.
|
|
117
|
-
* @type [`React.FC`](/docs/api-reference/core/components/refine-config/#loginpage)
|
|
117
|
+
* @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#loginpage)
|
|
118
118
|
* @deprecated Please use the `LoginPage` component in your routes instead.
|
|
119
119
|
*/
|
|
120
120
|
LoginPage?: React.FC;
|
|
121
121
|
/**
|
|
122
122
|
* A custom dashboard page can be passed to the `DashboardPage` prop which is accessible on root route.
|
|
123
|
-
* @type [`React.FC<DashboardPageProps>`](/docs/api-reference/core/components/refine-config/#dashboardpage)
|
|
123
|
+
* @type [`React.FC<DashboardPageProps>`](https://refine.dev/docs/api-reference/core/components/refine-config/#dashboardpage)
|
|
124
124
|
* @deprecated Please use the `DashboardPage` component in your routes instead.
|
|
125
125
|
*/
|
|
126
126
|
DashboardPage?: React.FC<DashboardPageProps>;
|
|
127
127
|
/**
|
|
128
128
|
* Custom ready page component can be set by passing to `ReadyPage` property.
|
|
129
|
-
* @type [`React.FC`](/docs/api-reference/core/components/refine-config/#readypage)
|
|
129
|
+
* @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#readypage)
|
|
130
130
|
* @deprecated This component is only used with the legacy router and will be removed in the future.
|
|
131
131
|
*/
|
|
132
132
|
ReadyPage?: React.FC;
|
|
133
133
|
/**
|
|
134
134
|
* Default layout can be customized by passing the `Layout` property.
|
|
135
|
-
* @type [`React.FC<LayoutProps>`](/docs/api-reference/core/components/refine-config/#layout)
|
|
135
|
+
* @type [`React.FC<LayoutProps>`](https://refine.dev/docs/api-reference/core/components/refine-config/#layout)
|
|
136
136
|
* @deprecated Please use the `Layout` component as a children instead of a prop.
|
|
137
137
|
*/
|
|
138
138
|
Layout?: React.FC<LayoutProps>;
|
|
139
139
|
/**
|
|
140
140
|
* The default sidebar can be customized by using refine hooks and passing custom components to `Sider` property.
|
|
141
|
-
* @type [`React.FC`](/docs/api-reference/core/components/refine-config/#sider)
|
|
141
|
+
* @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#sider)
|
|
142
142
|
* @deprecated Please pass the `Sider` component to your `Layout` component.
|
|
143
143
|
*/
|
|
144
144
|
Sider?: React.FC;
|
|
145
145
|
/**
|
|
146
146
|
* The default app header can be customized by passing the `Header` property.
|
|
147
|
-
* @type [`React.FC`](/docs/api-reference/core/components/refine-config/#header)
|
|
147
|
+
* @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#header)
|
|
148
148
|
* @deprecated Please pass the `Header` component to your `Layout` component.
|
|
149
149
|
*/
|
|
150
150
|
Header?: React.FC;
|
|
151
151
|
/**
|
|
152
152
|
*The default app footer can be customized by passing the `Footer` property.
|
|
153
|
-
* @type [`React.FC`](/docs/api-reference/core/components/refine-config/#footer)
|
|
153
|
+
* @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#footer)
|
|
154
154
|
* @deprecated Please pass the `Footer` component to your `Layout` component.
|
|
155
155
|
*/
|
|
156
156
|
Footer?: React.FC;
|
|
157
157
|
/**
|
|
158
158
|
* The component wanted to be placed out of app layout structure can be set by passing to `OffLayoutArea` prop.
|
|
159
|
-
* @type [`React.FC`](/docs/api-reference/core/components/refine-config/#offlayoutarea)
|
|
159
|
+
* @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#offlayoutarea)
|
|
160
160
|
* @deprecated Please use your `OffLayoutArea` component as a children instead of a prop.
|
|
161
161
|
*/
|
|
162
162
|
OffLayoutArea?: React.FC;
|
|
163
163
|
/**
|
|
164
164
|
* TThe app title can be set by passing the `Title` property.
|
|
165
|
-
* @type [`React.FC<TitleProps>`](/docs/api-reference/core/components/refine-config/#title)
|
|
165
|
+
* @type [`React.FC<TitleProps>`](https://refine.dev/docs/api-reference/core/components/refine-config/#title)
|
|
166
166
|
* @deprecated Please pass the `Title` component to your `Layout` component.
|
|
167
167
|
*/
|
|
168
168
|
Title?: React.FC<TitleProps>;
|
|
169
169
|
/**
|
|
170
170
|
* Callback to handle all live events.
|
|
171
|
-
* @type [`(event: LiveEvent) => void`](/docs/api-reference/core/providers/live-provider/#onliveevent)
|
|
171
|
+
* @type [`(event: LiveEvent) => void`](https://refine.dev/docs/api-reference/core/providers/live-provider/#onliveevent)
|
|
172
172
|
*/
|
|
173
173
|
onLiveEvent?: LiveModeProps["onLiveEvent"];
|
|
174
174
|
/**
|
|
175
175
|
* `options` is used to configure the app.
|
|
176
|
-
* @type [`IRefineOptions`](/docs/api-reference/core/components/refine-config/#options
|
|
176
|
+
* @type [`IRefineOptions`](https://refine.dev/docs/api-reference/core/components/refine-config/#options)
|
|
177
177
|
* */
|
|
178
178
|
options?: IRefineOptions;
|
|
179
179
|
}
|
|
@@ -217,10 +217,15 @@ export const useDelete = <
|
|
|
217
217
|
resource,
|
|
218
218
|
mutationMode,
|
|
219
219
|
dataProviderName,
|
|
220
|
+
meta,
|
|
221
|
+
metaData,
|
|
220
222
|
}) => {
|
|
223
|
+
const preferredMeta = pickNotDeprecated(meta, metaData);
|
|
221
224
|
const queryKey = queryKeys(
|
|
222
225
|
resource,
|
|
223
226
|
pickDataProvider(resource, dataProviderName, resources),
|
|
227
|
+
preferredMeta,
|
|
228
|
+
preferredMeta,
|
|
224
229
|
);
|
|
225
230
|
|
|
226
231
|
const mutationModePropOrContext =
|
|
@@ -223,10 +223,15 @@ export const useDeleteMany = <
|
|
|
223
223
|
resource,
|
|
224
224
|
mutationMode,
|
|
225
225
|
dataProviderName,
|
|
226
|
+
meta,
|
|
227
|
+
metaData,
|
|
226
228
|
}) => {
|
|
229
|
+
const preferredMeta = pickNotDeprecated(meta, metaData);
|
|
227
230
|
const queryKey = queryKeys(
|
|
228
231
|
resource,
|
|
229
232
|
pickDataProvider(resource, dataProviderName, resources),
|
|
233
|
+
preferredMeta,
|
|
234
|
+
preferredMeta,
|
|
230
235
|
);
|
|
231
236
|
|
|
232
237
|
const mutationModePropOrContext =
|
|
@@ -248,10 +248,15 @@ export const useUpdate = <
|
|
|
248
248
|
mutationMode,
|
|
249
249
|
values,
|
|
250
250
|
dataProviderName,
|
|
251
|
+
meta,
|
|
252
|
+
metaData,
|
|
251
253
|
}) => {
|
|
254
|
+
const preferredMeta = pickNotDeprecated(meta, metaData);
|
|
252
255
|
const queryKey = queryKeys(
|
|
253
256
|
resource,
|
|
254
257
|
pickDataProvider(resource, dataProviderName, resources),
|
|
258
|
+
preferredMeta,
|
|
259
|
+
preferredMeta,
|
|
255
260
|
);
|
|
256
261
|
|
|
257
262
|
const previousQueries: PreviousQuery<TData>[] =
|