Merge pull request #8955 from mmateja/refetch-permissions

Add ability to refetch permissions on demand

Author: slax57

docs/usePermissions.md

@@ -61,6 +61,34 @@ const MyPage = () => {
 }
 ```
 
+## Refreshing permissions
+
+Permissions are loaded when the app loads and then cached. If your application requires permissions to be refreshed, for example after a change modifying user permissions, you can use `refetch` function to trigger reload.
+
+{% raw %}
+```jsx
+const GrantAdminPermissionsButton = () => {
+    const record = useRecordContext();
+    const [ update ] = useUpdate();
+    const { refetch } = usePermissions();
+
+    const handleClick = () => {
+        update(
+            "users",
+            { id: record.id, data: { admin: true }, previousData: record },
+            { onSuccess: refetch },
+        );
+    }
+
+    return (
+        <Button onClick={handleClick}>
+            Make user an admin
+        </Button>
+    )
+}
+```
+{% endraw %}
+
 ## RBAC
 
 [The ra-rbac module](https://marmelab.com/ra-enterprise/modules/ra-rbac)<img class="icon" src="./img/premium.svg" /> provides an alternative implementation of the `usePermissions` hook. It returns an array of permissions, resulting in the merge of the user permissions and the permissions from the user roles.

packages/ra-core/src/auth/usePermissions.ts

@@ -19,7 +19,7 @@ const emptyParams = {};
  *
  * @param {Object} params Any params you want to pass to the authProvider
  *
- * @returns The current auth check state. Destructure as { permissions, error, isLoading }.
+ * @returns The current auth check state. Destructure as { permissions, error, isLoading, refetch }.
  *
  * @example
  *     import { usePermissions } from 'react-admin';
@@ -54,6 +54,7 @@ const usePermissions = <Permissions = any, Error = any>(
             permissions: result.data,
             isLoading: result.isLoading,
             error: result.error,
+            refetch: result.refetch,
         }),
         [result]
     );