Merge branch 'master' into next

Author: djhi

CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 5.12.2
+
+* Fix middlewares might not be applied in `optimistic` and `undoable` modes when they are unregistered before the actual mutation is called ([#11007](https://github.com/marmelab/react-admin/pull/11007)) ([djhi](https://github.com/djhi))
+* Fix `<AutocompleteArrayInput>` does not apply `ChipProps` nor `slotProps.chip` in `renderTags` ([#11003](https://github.com/marmelab/react-admin/pull/11003)) ([djhi](https://github.com/djhi))
+* Fix `<SaveButton>` form dirty status check ([#10997](https://github.com/marmelab/react-admin/pull/10997)) ([djhi](https://github.com/djhi))
+* [Doc] Add missing Enterprise ribbon to some `ra-core-ee` modules ([#11001](https://github.com/marmelab/react-admin/pull/11001)) ([jonathanarnault](https://github.com/jonathanarnault))
+* [Doc] Mention Soft Delete in Buttons documentation ([#11000](https://github.com/marmelab/react-admin/pull/11000)) ([djhi](https://github.com/djhi))
+* [Doc] Add `<FormDataConsumer>` and `useSourceContext` headless documentation ([#10991](https://github.com/marmelab/react-admin/pull/10991)) ([jonathanarnault](https://github.com/jonathanarnault))
+* [Doc] Improve AuthProvider documentation ([#10989](https://github.com/marmelab/react-admin/pull/10989)) ([slax57](https://github.com/slax57))
+* [chore] Bump vite from 6.3.6 to 6.4.1 ([#10999](https://github.com/marmelab/react-admin/pull/10999)) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+## 5.12.1
+
+* Fix `<ColumnsSelector>` reset button is not translatable ([#10984](https://github.com/marmelab/react-admin/pull/10984)) ([yarkovaleksei](https://github.com/yarkovaleksei))
+* [Doc] Update `useRedirect` JSDoc to add absolute URL example ([#10987](https://github.com/marmelab/react-admin/pull/10987)) ([COil](https://github.com/COil))
+* [Doc] Update Soft Delete documentation ([#10986](https://github.com/marmelab/react-admin/pull/10986)) ([djhi](https://github.com/djhi))
+* [Doc] Mention Scheduler in All Features ([#10985](https://github.com/marmelab/react-admin/pull/10985)) ([slax57](https://github.com/slax57))
+* [Doc] Fix Soft Delete documentation links ([#10980](https://github.com/marmelab/react-admin/pull/10980)) ([djhi](https://github.com/djhi))
+* [Doc] Add documentation about ra-relationship core components ([#10979](https://github.com/marmelab/react-admin/pull/10979)) ([jonathanarnault](https://github.com/jonathanarnault))
+* [Doc] Add documentation for headless enterprise features in ra-core documentation ([#10973](https://github.com/marmelab/react-admin/pull/10973)) ([djhi](https://github.com/djhi))
+* [Doc] Add `<ReferenceInputBase>` and `<ReferenceArrayInputBase>` documentation in headless doc site ([#10965](https://github.com/marmelab/react-admin/pull/10965)) ([djhi](https://github.com/djhi))
+* [TypeScript] Fix `useShowController` result type ([#10992](https://github.com/marmelab/react-admin/pull/10992)) ([slax57](https://github.com/slax57))
+* Bump astro from 5.13.7 to 5.14.3 ([#10988](https://github.com/marmelab/react-admin/pull/10988)) ([dependabot[bot]](https://github.com/apps/dependabot))
+
 ## 5.12.0
 
 * Add `error`, `loading`, `empty` and `offline` props to `<ListBase>`, `<WithListContext>`, `<EditBase>`, and `<ShowBase>` to set fallback components for non-success states.  ([#10880](https://github.com/marmelab/react-admin/pull/10880)) ([erwanMarmelab](https://github.com/erwanMarmelab))

docs/AuthProviderWriting.md

@@ -428,7 +428,27 @@ export const authProvider = {
 };
 ```
 
-You can choose when to redirect users to the third-party authentication service, such as directly in the `AuthProvider.checkAuth()` method or when they click a button on a [custom login page](#customizing-the-login-component).
+![Auth0 login flow diagram](./img/authProvider-OAuth-flow.png)
+{% comment %}
+Diagram source:
+```mermaid
+sequenceDiagram
+    autonumber
+    participant U as User
+    participant RA as React Admin<br/>(authProvider)
+    participant A as Auth0 website
+    U->>RA: Access /posts
+    Note over RA: checkAuth()<br/>Auth0Client.isAuthenticated()
+    RA->>A: Auth0Client.loginWithRedirect()
+    Note over A: Login using Auth0 form
+    A->>RA: Redirects to /auth-callback<br/>(with token)
+    Note over RA: handleCallback()<br/>Auth0Client.handleRedirectCallback()
+    RA->>U: Redirects to /posts
+```
+Edited with https://mermaid.live/edit
+{% endcomment %}
+
+**Tip:** You can choose when to redirect users to the third-party authentication service, such as directly in the `AuthProvider.checkAuth()` method or when they click a button on a [custom login page](#customizing-the-login-component).
 
 ## Handling Refresh Tokens
 

docs/Authentication.md

@@ -567,6 +567,149 @@ const MyBreadcrumbCustomHome = () => (
 
 **Tip:** It's a good practice to include a visually hidden placeholder ('Dashboard' in this example) for screen readers when using an icon as label.
 
+## `<Breadcrumb.ListItem>`
+
+A version of the `<Breadcrumb.Item>` dedicated to list views. It accepts all [`<Breadcrumb.Item>` props](#breadcrumbitem).
+
+It is convenient for building custom breadcrumbs.
+
+```tsx
+const MyBreadcrumb = () => (
+    <Breadcrumb>
+        <Breadcrumb.ListItem resource="posts">
+            <Breadcrumb.EditItem resource="posts" />
+            <Breadcrumb.ShowItem resource="posts" />
+            <Breadcrumb.CreateItem resource="posts" />
+        </Breadcrumb.ListItem>
+    </Breadcrumb>
+);
+```
+
+## `<Breadcrumb.CreateItem>`
+
+A version of the `<Breadcrumb.Item>` dedicated to create views. It accepts all [`<Breadcrumb.Item>` props](#breadcrumbitem).
+
+It is convenient for building custom breadcrumbs.
+
+```tsx
+const MyBreadcrumb = () => (
+    <Breadcrumb>
+        <Breadcrumb.ListItem resource="posts">
+            <Breadcrumb.EditItem resource="posts" />
+            <Breadcrumb.ShowItem resource="posts" />
+            <Breadcrumb.CreateItem resource="posts" />
+        </Breadcrumb.ListItem>
+    </Breadcrumb>
+);
+```
+
+## `<Breadcrumb.EditItem>`
+
+A version of the `<Breadcrumb.Item>` dedicated to edit views. It is convenient for building custom breadcrumbs.
+
+It accepts all [`<Breadcrumb.Item>` props](#breadcrumbitem) and an optional `meta` prop that allows you to provide a [`meta`](https://marmelab.com/react-admin/Actions.html#meta-parameter) parameter matching the one set in the `<Edit>` component:
+
+```tsx
+const MyBreadcrumb = () => (
+    <Breadcrumb>
+        <Breadcrumb.ListItem resource="posts">
+            <Breadcrumb.EditItem resource="posts" meta={ { test: true } } />
+            <Breadcrumb.ShowItem resource="posts" />
+            <Breadcrumb.CreateItem resource="posts" />
+        </Breadcrumb.ListItem>
+    </Breadcrumb>
+);
+
+const PostEdit = () => (
+    <Edit queryOptions={ { meta: { test: true } } }>
+        // ...
+    </Edit>
+);
+```
+
+**Tip**: If your `<Edit>` component has a `meta` parameter but manually calls [`useDefineAppLocation`](./useDefineAppLocation.md) and provides it with the record, you don't need to set the `meta` prop on the `<Breadcrumb.EditItem>` as it will read the record from the `AppLocationContext`:
+
+```tsx
+const MyBreadcrumb = () => (
+    <Breadcrumb>
+        <Breadcrumb.ListItem resource="posts">
+            {/* meta are not provided here */}
+            <Breadcrumb.EditItem resource="posts" />
+            <Breadcrumb.ShowItem resource="posts" />
+            <Breadcrumb.CreateItem resource="posts" />
+        </Breadcrumb.ListItem>
+    </Breadcrumb>
+);
+
+const PostEdit = () => (
+    {/* meta are provided here */}
+    <Edit queryOptions={ { meta: { test: true } } }>
+        // ...
+    </Edit>
+);
+
+const PostAppLocation = () => {
+    const record = useRecordContext();
+    // Pass the current record in the app location
+    useDefineAppLocation('posts.edit', { record });
+    return null;
+}
+```
+
+## `<Breadcrumb.ShowItem>`
+
+A version of the `<Breadcrumb.Item>` dedicated to show views. It is convenient for building custom breadcrumbs.
+
+It accepts all [`<Breadcrumb.Item>` props](#breadcrumbitem) and an optional `meta` prop that allows you to provide a [`meta`](https://marmelab.com/react-admin/Actions.html#meta-parameter) parameter matching the one set in the `<Show>` component:
+
+```tsx
+const MyBreadcrumb = () => (
+    <Breadcrumb>
+        <Breadcrumb.ListItem resource="posts">
+            <Breadcrumb.EditItem resource="posts" />
+            <Breadcrumb.ShowItem resource="posts" meta={ { test: true } } />
+            <Breadcrumb.CreateItem resource="posts" />
+        </Breadcrumb.ListItem>
+    </Breadcrumb>
+);
+
+
+const PostShow = () => (
+    <Show queryOptions={ { meta: { test: true } } }>
+        // ...
+    </Show>
+);
+```
+
+**Tip**: If your `<Show>` component has a `meta` parameter but manually calls [`useDefineAppLocation`](./useDefineAppLocation.md) and provides it with the record, you don't need to set the `meta` prop on the `<Breadcrumb.ShowItem>` as it will read the record from the `AppLocationContext`:
+
+```tsx
+const MyBreadcrumb = () => (
+    <Breadcrumb>
+        <Breadcrumb.ListItem resource="posts">
+            <Breadcrumb.EditItem resource="posts" />
+            {/* meta are not provided here */}
+            <Breadcrumb.ShowItem resource="posts" />
+            <Breadcrumb.CreateItem resource="posts" />
+        </Breadcrumb.ListItem>
+    </Breadcrumb>
+);
+
+const PostShow = () => (
+    {/* meta are provided here */}
+    <Show queryOptions={ { meta: { test: true } } }>
+        // ...
+    </Show>
+);
+
+const PostAppLocation = () => {
+    const record = useRecordContext();
+    // Pass the current record in the app location
+    useDefineAppLocation('posts.show', { record });
+    return null;
+}
+```
+
 ## Admins With A Dashboard
 
 If the app has a home page defined via the [`<Admin dashboard>`](./Admin.md#dashboard) prop, the Breadcrumb will automatically detect it and set the root of the Breadcrumb to this page.

docs/Breadcrumb.md

@@ -112,6 +112,20 @@ Alternately, pass a `successMessage` prop:
 <BulkDeleteButton successMessage="Posts deleted successfully" />
 ```
 
+### Access Control
+
+If your `authProvider` implements [Access Control](./Permissions.md#access-control), `<BulkDeleteButton>` will only render if the user has the "delete" access to the related resource.
+
+`<BulkDeleteButton>` will call `authProvider.canAccess()` using the following parameters:
+
+```txt
+{ action: "delete", resource: [current resource] }
+```
+
+### Soft Delete
+
+Should you need to only archive records, the soft delete feature from the [Enterprise Edition add-on](https://react-admin-ee.marmelab.com/documentation/ra-soft-delete) provides the [`<BulkSoftDeleteButton />`](./BulkSoftDeleteButton.md), a drop-in replacement for `<BulkDeleteButton>`.
+
 ## `<BulkExportButton>`
 
 Same as `<ExportButton>`, except it only exports the selected rows instead of the entire list. To be used inside [the `<DataTable bulkActionButtons>` prop](./DataTable.md#bulkactionbuttons).
@@ -1022,6 +1036,10 @@ If your `authProvider` implements [Access Control](./Permissions.md#access-contr
 { action: "delete", resource: [current resource], record: [current record] }
 ```
 
+### Soft Delete
+
+Should you need to only archive records, the soft delete feature from the [Enterprise Edition add-on](https://react-admin-ee.marmelab.com/documentation/ra-soft-delete) provides the [`<SoftDeleteButton />`](./SoftDeleteButton.md), a drop-in replacement for `<DeleteButton>`.
+
 ## `<DeleteWithConfirmButton>`
 
 Delete the current record after a confirm dialog has been accepted. To be used inside a `<Toolbar/>` component.
@@ -1063,15 +1081,15 @@ const MyEdit = () => (
     <Edit>
         <SimpleForm toolbar={<EditToolbar />}>
             ...
-        </SimpleForm>        
-    </Edit>    
+        </SimpleForm>
+    </Edit>
 );
 ```
 {% endraw %}
 
 ## `<EditButton>`
 
-Opens the Edit view of the current record. 
+Opens the Edit view of the current record.
 
 ![Edit button](./img/edit-button.png)
 
@@ -1397,7 +1415,7 @@ By default, react-admin's `<DataTable>` displays a `<SelectAllButton>` in its `b
 import { List, DataTable, BulkActionsToolbar, SelectAllButton, BulkDeleteButton } from 'react-admin';
 
 const PostSelectAllButton = () => (
-    <SelectAllButton 
+    <SelectAllButton
         label="Select all records"
         queryOptions={{ meta: { foo: 'bar' } }}
     />
@@ -1636,11 +1654,11 @@ const PostEditActions = () => (
 
 The mutation mode determines when the side effects (redirection, notifications, etc.) are executed:
 
-- `pessimistic`: The mutation is passed to the dataProvider first. When the dataProvider returns successfully, the mutation is applied locally, and the side effects are executed. 
-- `optimistic`: The mutation is applied locally and the side effects are executed immediately. Then the mutation is passed to the dataProvider. If the dataProvider returns successfully, nothing happens (as the mutation was already applied locally). If the dataProvider returns in error, the page is refreshed and an error notification is shown. 
+- `pessimistic`: The mutation is passed to the dataProvider first. When the dataProvider returns successfully, the mutation is applied locally, and the side effects are executed.
+- `optimistic`: The mutation is applied locally and the side effects are executed immediately. Then the mutation is passed to the dataProvider. If the dataProvider returns successfully, nothing happens (as the mutation was already applied locally). If the dataProvider returns in error, the page is refreshed and an error notification is shown.
 - `undoable` (default): The mutation is applied locally and the side effects are executed immediately. Then a notification is shown with an undo button. If the user clicks on undo, the mutation is never sent to the dataProvider, and the page is refreshed. Otherwise, after a 5 seconds delay, the mutation is passed to the dataProvider. If the dataProvider returns successfully, nothing happens (as the mutation was already applied locally). If the dataProvider returns in error, the page is refreshed and an error notification is shown.
 
-By default, the `<UpdateButton>` uses the `undoable` mutation mode. This is part of the "optimistic rendering" strategy of react-admin ; it makes user interactions more reactive. 
+By default, the `<UpdateButton>` uses the `undoable` mutation mode. This is part of the "optimistic rendering" strategy of react-admin ; it makes user interactions more reactive.
 
 You can change this default by setting the `mutationMode` prop. For instance, to remove the ability to undo the changes, use the `optimistic` mode:
 
@@ -1671,7 +1689,7 @@ const PostEditActions = () => (
 {% endraw %}
 
 
-**Tip**: When using any other mode than `undoable`, the `<UpdateButton>` displays a confirmation dialog before calling the dataProvider. 
+**Tip**: When using any other mode than `undoable`, the `<UpdateButton>` displays a confirmation dialog before calling the dataProvider.
 
 ### `confirmTitle`
 
@@ -1777,7 +1795,7 @@ The default `onSuccess` function is:
 }
 ```
 
-**Tip**: When you use `mutationMode="pessimistic"`, the `onSuccess` function receives the response from the `dataProvider.update()` call, which is the edited record (see [the dataProvider documentation for details](./DataProviderWriting.md#update)). You can use that response in the success side effects: 
+**Tip**: When you use `mutationMode="pessimistic"`, the `onSuccess` function receives the response from the `dataProvider.update()` call, which is the edited record (see [the dataProvider documentation for details](./DataProviderWriting.md#update)). You can use that response in the success side effects:
 
 {% raw %}
 ```jsx