@strapi/plugin-users-permissions 0.0.0-next.ddc227cf71596473e8e744b0f90388b054d07e45 → 0.0.0-next.de77e236e318525454da54a1a2617d86742e6e6c

package/admin/src/{hooks → pages/Roles/hooks}/usePlugins.js

@@ -3,8 +3,7 @@ import { useEffect } from 'react';
 import { useNotification, useFetchClient, useAPIErrorHandler } from '@strapi/helper-plugin';
 import { useQueries } from 'react-query';
 
-import pluginId from '../pluginId';
-import { cleanPermissions, getTrad } from '../utils';
+import { cleanPermissions, getTrad } from '../../../utils';
 
 export const usePlugins = () => {
   const toggleNotification = useNotification();
@@ -21,19 +20,23 @@ export const usePlugins = () => {
     { data: routes, isLoading: isLoadingRoutes, error: routesError, refetch: refetchRoutes },
   ] = useQueries([
     {
-      queryKey: [pluginId, 'permissions'],
+      queryKey: ['users-permissions', 'permissions'],
       async queryFn() {
-        const res = await get(`/${pluginId}/permissions`);
+        const {
+          data: { permissions },
+        } = await get(`/users-permissions/permissions`);
 
-        return res.data.permissions;
+        return permissions;
       },
     },
     {
-      queryKey: [pluginId, 'routes'],
+      queryKey: ['users-permissions', 'routes'],
       async queryFn() {
-        const res = await get(`/${pluginId}/routes`);
+        const {
+          data: { routes },
+        } = await get(`/users-permissions/routes`);
 
-        return res.data.routes;
+        return routes;
       },
     },
   ]);
@@ -63,8 +66,12 @@ export const usePlugins = () => {
   const isLoading = isLoadingPermissions || isLoadingRoutes;
 
   return {
+    // TODO: these return values need to be memoized, otherwise
+    // they will create infinite rendering loops when used as
+    // effect dependencies
     permissions: permissions ? cleanPermissions(permissions) : {},
     routes: routes ?? {},
+
     getData: refetchQueries,
     isLoading,
   };

package/admin/src/pages/Roles/{index.js → index.jsx}

@@ -4,23 +4,26 @@ import { AnErrorOccurred, CheckPagePermissions } from '@strapi/helper-plugin';
 import { Route, Switch } from 'react-router-dom';
 
 import { PERMISSIONS } from '../../constants';
-import pluginId from '../../pluginId';
 
-import ProtectedRolesCreatePage from './ProtectedCreatePage';
-import ProtectedRolesEditPage from './ProtectedEditPage';
-import ProtectedRolesListPage from './ProtectedListPage';
+import { ProtectedRolesCreatePage } from './pages/CreatePage';
+import { ProtectedRolesEditPage } from './pages/EditPage';
+import { ProtectedRolesListPage } from './pages/ListPage';
 
 const Roles = () => {
   return (
     <CheckPagePermissions permissions={PERMISSIONS.accessRoles}>
       <Switch>
         <Route
-          path={`/settings/${pluginId}/roles/new`}
+          path="/settings/users-permissions/roles/new"
           component={ProtectedRolesCreatePage}
           exact
         />
-        <Route path={`/settings/${pluginId}/roles/:id`} component={ProtectedRolesEditPage} exact />
-        <Route path={`/settings/${pluginId}/roles`} component={ProtectedRolesListPage} exact />
+        <Route
+          path="/settings/users-permissions/roles/:id"
+          component={ProtectedRolesEditPage}
+          exact
+        />
+        <Route path="/settings/users-permissions/roles" component={ProtectedRolesListPage} exact />
         <Route path="" component={AnErrorOccurred} />
       </Switch>
     </CheckPagePermissions>

package/admin/src/pages/Roles/pages/CreatePage.jsx

@@ -0,0 +1,199 @@
+import * as React from 'react';
+
+import {
+  Button,
+  ContentLayout,
+  Flex,
+  Grid,
+  GridItem,
+  HeaderLayout,
+  Main,
+  Textarea,
+  TextInput,
+  Typography,
+} from '@strapi/design-system';
+import {
+  CheckPagePermissions,
+  Form,
+  SettingsPageTitle,
+  useFetchClient,
+  useNotification,
+  useOverlayBlocker,
+  useTracking,
+} from '@strapi/helper-plugin';
+import { Check } from '@strapi/icons';
+import { Formik } from 'formik';
+import { useIntl } from 'react-intl';
+import { useMutation } from 'react-query';
+import { useHistory } from 'react-router-dom';
+
+import UsersPermissions from '../../../components/UsersPermissions';
+import { PERMISSIONS } from '../../../constants';
+import getTrad from '../../../utils/getTrad';
+import { createRoleSchema } from '../constants';
+import { usePlugins } from '../hooks/usePlugins';
+
+export const CreatePage = () => {
+  const { formatMessage } = useIntl();
+  const toggleNotification = useNotification();
+  const { goBack } = useHistory();
+  const { lockApp, unlockApp } = useOverlayBlocker();
+  const { isLoading: isLoadingPlugins, permissions, routes } = usePlugins();
+  const { trackUsage } = useTracking();
+  const permissionsRef = React.useRef();
+  const { post } = useFetchClient();
+  const mutation = useMutation((body) => post(`/users-permissions/roles`, body), {
+    onError() {
+      toggleNotification({
+        type: 'warning',
+        message: {
+          id: 'notification.error',
+          defaultMessage: 'An error occurred',
+        },
+      });
+    },
+
+    onSuccess() {
+      trackUsage('didCreateRole');
+
+      toggleNotification({
+        type: 'success',
+        message: {
+          id: getTrad('Settings.roles.created'),
+          defaultMessage: 'Role created',
+        },
+      });
+
+      // Forcing redirecting since we don't have the id in the response
+      goBack();
+    },
+  });
+
+  const handleCreateRoleSubmit = async (data) => {
+    lockApp();
+
+    // TODO: refactor. Child -> parent component communication is evil;
+    // We should either move the provider one level up or move the state
+    // straight into redux.
+    const permissions = permissionsRef.current.getPermissions();
+
+    await mutation.mutate({ ...data, ...permissions, users: [] });
+
+    unlockApp();
+  };
+
+  return (
+    <Main>
+      {/* TODO: This needs to be translated */}
+      <SettingsPageTitle name="Roles" />
+      <Formik
+        enableReinitialize
+        initialValues={{ name: '', description: '' }}
+        onSubmit={handleCreateRoleSubmit}
+        validationSchema={createRoleSchema}
+      >
+        {({ handleSubmit, values, handleChange, errors }) => (
+          <Form noValidate onSubmit={handleSubmit}>
+            <HeaderLayout
+              primaryAction={
+                !isLoadingPlugins && (
+                  <Button type="submit" loading={mutation.isLoading} startIcon={<Check />}>
+                    {formatMessage({
+                      id: 'global.save',
+                      defaultMessage: 'Save',
+                    })}
+                  </Button>
+                )
+              }
+              title={formatMessage({
+                id: 'Settings.roles.create.title',
+                defaultMessage: 'Create a role',
+              })}
+              subtitle={formatMessage({
+                id: 'Settings.roles.create.description',
+                defaultMessage: 'Define the rights given to the role',
+              })}
+            />
+            <ContentLayout>
+              <Flex
+                background="neutral0"
+                direction="column"
+                alignItems="stretch"
+                gap={7}
+                hasRadius
+                paddingTop={6}
+                paddingBottom={6}
+                paddingLeft={7}
+                paddingRight={7}
+                shadow="filterShadow"
+              >
+                <Flex direction="column" alignItems="stretch">
+                  <Typography variant="delta" as="h2">
+                    {formatMessage({
+                      id: getTrad('EditPage.form.roles'),
+                      defaultMessage: 'Role details',
+                    })}
+                  </Typography>
+
+                  <Grid gap={4}>
+                    <GridItem col={6}>
+                      <TextInput
+                        name="name"
+                        value={values.name || ''}
+                        onChange={handleChange}
+                        label={formatMessage({
+                          id: 'global.name',
+                          defaultMessage: 'Name',
+                        })}
+                        error={
+                          errors?.name
+                            ? formatMessage({ id: errors.name, defaultMessage: 'Name is required' })
+                            : false
+                        }
+                        required
+                      />
+                    </GridItem>
+                    <GridItem col={6}>
+                      <Textarea
+                        id="description"
+                        value={values.description || ''}
+                        onChange={handleChange}
+                        label={formatMessage({
+                          id: 'global.description',
+                          defaultMessage: 'Description',
+                        })}
+                        error={
+                          errors?.description
+                            ? formatMessage({
+                                id: errors.description,
+                                defaultMessage: 'Description is required',
+                              })
+                            : false
+                        }
+                        required
+                      />
+                    </GridItem>
+                  </Grid>
+                </Flex>
+
+                {!isLoadingPlugins && (
+                  <UsersPermissions
+                    ref={permissionsRef}
+                    permissions={permissions}
+                    routes={routes}
+                  />
+                )}
+              </Flex>
+            </ContentLayout>
+          </Form>
+        )}
+      </Formik>
+    </Main>
+  );
+};
+
+export const ProtectedRolesCreatePage = () => (
+  <CheckPagePermissions permissions={PERMISSIONS.createRole}>
+    <CreatePage />
+  </CheckPagePermissions>
+);

package/admin/src/pages/Roles/pages/EditPage.jsx

@@ -0,0 +1,220 @@
+import * as React from 'react';
+
+import {
+  ContentLayout,
+  HeaderLayout,
+  Main,
+  Button,
+  Flex,
+  TextInput,
+  Textarea,
+  Typography,
+  GridItem,
+  Grid,
+} from '@strapi/design-system';
+import {
+  CheckPagePermissions,
+  useOverlayBlocker,
+  SettingsPageTitle,
+  LoadingIndicatorPage,
+  Form,
+  useAPIErrorHandler,
+  useFetchClient,
+  useNotification,
+  Link,
+} from '@strapi/helper-plugin';
+import { ArrowLeft, Check } from '@strapi/icons';
+import { Formik } from 'formik';
+import { useIntl } from 'react-intl';
+import { useQuery, useMutation } from 'react-query';
+import { useRouteMatch } from 'react-router-dom';
+
+import UsersPermissions from '../../../components/UsersPermissions';
+import { PERMISSIONS } from '../../../constants';
+import getTrad from '../../../utils/getTrad';
+import { createRoleSchema } from '../constants';
+import { usePlugins } from '../hooks/usePlugins';
+
+export const EditPage = () => {
+  const { formatMessage } = useIntl();
+  const toggleNotification = useNotification();
+  const { lockApp, unlockApp } = useOverlayBlocker();
+  const {
+    params: { id },
+  } = useRouteMatch(`/settings/users-permissions/roles/:id`);
+  const { get } = useFetchClient();
+  const { isLoading: isLoadingPlugins, routes } = usePlugins();
+  const {
+    data: role,
+    isLoading: isLoadingRole,
+    refetch: refetchRole,
+  } = useQuery(['users-permissions', 'role', id], async () => {
+    // TODO: why doesn't this endpoint follow the admin API conventions?
+    const {
+      data: { role },
+    } = await get(`/users-permissions/roles/${id}`);
+
+    return role;
+  });
+
+  const permissionsRef = React.useRef();
+  const { put } = useFetchClient();
+  const { formatAPIError } = useAPIErrorHandler();
+  const mutation = useMutation((body) => put(`/users-permissions/roles/${id}`, body), {
+    onError(error) {
+      toggleNotification({
+        type: 'warning',
+        message: formatAPIError(error),
+      });
+    },
+
+    async onSuccess() {
+      toggleNotification({
+        type: 'success',
+        message: {
+          id: getTrad('Settings.roles.created'),
+          defaultMessage: 'Role edited',
+        },
+      });
+
+      await refetchRole();
+    },
+  });
+
+  const handleEditRoleSubmit = async (data) => {
+    // Set loading state
+    lockApp();
+
+    const permissions = permissionsRef.current.getPermissions();
+
+    await mutation.mutate({ ...data, ...permissions, users: [] });
+
+    unlockApp();
+  };
+
+  if (isLoadingRole) {
+    return <LoadingIndicatorPage />;
+  }
+
+  return (
+    <Main>
+      {/* TODO: this needs to be translated */}
+      <SettingsPageTitle name="Roles" />
+      <Formik
+        enableReinitialize
+        initialValues={{ name: role.name, description: role.description }}
+        onSubmit={handleEditRoleSubmit}
+        validationSchema={createRoleSchema}
+      >
+        {({ handleSubmit, values, handleChange, errors }) => (
+          <Form noValidate onSubmit={handleSubmit}>
+            <HeaderLayout
+              primaryAction={
+                !isLoadingPlugins && (
+                  <Button
+                    disabled={role.code === 'strapi-super-admin'}
+                    type="submit"
+                    loading={mutation.isLoading}
+                    startIcon={<Check />}
+                  >
+                    {formatMessage({
+                      id: 'global.save',
+                      defaultMessage: 'Save',
+                    })}
+                  </Button>
+                )
+              }
+              title={role.name}
+              subtitle={role.description}
+              navigationAction={
+                <Link startIcon={<ArrowLeft />} to="/settings/users-permissions/roles">
+                  {formatMessage({
+                    id: 'global.back',
+                    defaultMessage: 'Back',
+                  })}
+                </Link>
+              }
+            />
+            <ContentLayout>
+              <Flex
+                background="neutral0"
+                direction="column"
+                alignItems="stretch"
+                gap={7}
+                hasRadius
+                paddingTop={6}
+                paddingBottom={6}
+                paddingLeft={7}
+                paddingRight={7}
+                shadow="filterShadow"
+              >
+                <Flex direction="column" alignItems="stretch" gap={4}>
+                  <Typography variant="delta" as="h2">
+                    {formatMessage({
+                      id: getTrad('EditPage.form.roles'),
+                      defaultMessage: 'Role details',
+                    })}
+                  </Typography>
+
+                  <Grid gap={4}>
+                    <GridItem col={6}>
+                      <TextInput
+                        name="name"
+                        value={values.name || ''}
+                        onChange={handleChange}
+                        label={formatMessage({
+                          id: 'global.name',
+                          defaultMessage: 'Name',
+                        })}
+                        error={
+                          errors?.name
+                            ? formatMessage({ id: errors.name, defaultMessage: 'Name is required' })
+                            : false
+                        }
+                        required
+                      />
+                    </GridItem>
+                    <GridItem col={6}>
+                      <Textarea
+                        id="description"
+                        value={values.description || ''}
+                        onChange={handleChange}
+                        label={formatMessage({
+                          id: 'global.description',
+                          defaultMessage: 'Description',
+                        })}
+                        error={
+                          errors?.description
+                            ? formatMessage({
+                                id: errors.description,
+                                defaultMessage: 'Description is required',
+                              })
+                            : false
+                        }
+                        required
+                      />
+                    </GridItem>
+                  </Grid>
+                </Flex>
+
+                {!isLoadingPlugins && (
+                  <UsersPermissions
+                    ref={permissionsRef}
+                    permissions={role.permissions}
+                    routes={routes}
+                  />
+                )}
+              </Flex>
+            </ContentLayout>
+          </Form>
+        )}
+      </Formik>
+    </Main>
+  );
+};
+
+export const ProtectedRolesEditPage = () => (
+  <CheckPagePermissions permissions={PERMISSIONS.updateRole}>
+    <EditPage />
+  </CheckPagePermissions>
+);

package/admin/src/pages/Roles/{ListPage/components/TableBody.js → pages/ListPage/components/TableBody.jsx}

@@ -1,13 +1,39 @@
 import React from 'react';
 
-import { Flex, IconButton, Tbody, Td, Tr, Typography } from '@strapi/design-system';
-import { CheckPermissions, onRowClick, stopPropagation } from '@strapi/helper-plugin';
+import { Flex, IconButton, Link, Tbody, Td, Tr, Typography } from '@strapi/design-system';
+import { CheckPermissions, onRowClick, pxToRem, stopPropagation } from '@strapi/helper-plugin';
 import { Pencil, Trash } from '@strapi/icons';
 import PropTypes from 'prop-types';
 import { useIntl } from 'react-intl';
 import { useHistory } from 'react-router-dom';
+import styled from 'styled-components';
 
-import pluginId from '../../../../pluginId';
+const EditLink = styled(Link)`
+  align-items: center;
+  height: ${pxToRem(32)};
+  display: flex;
+  justify-content: center;
+  padding: ${({ theme }) => `${theme.spaces[2]}}`};
+  width: ${pxToRem(32)};
+
+  svg {
+    height: ${pxToRem(12)};
+    width: ${pxToRem(12)};
+
+    path {
+      fill: ${({ theme }) => theme.colors.neutral500};
+    }
+  }
+
+  &:hover,
+  &:focus {
+    svg {
+      path {
+        fill: ${({ theme }) => theme.colors.neutral800};
+      }
+    }
+  }
+`;
 
 const TableBody = ({ sortedRoles, canDelete, permissions, setRoleToDelete, onDelete }) => {
   const { formatMessage } = useIntl();
@@ -23,7 +49,7 @@ const TableBody = ({ sortedRoles, canDelete, permissions, setRoleToDelete, onDel
   };
 
   const handleClickEdit = (id) => {
-    push(`/settings/${pluginId}/roles/${id}`);
+    push(`/settings/users-permissions/roles/${id}`);
   };
 
   return (
@@ -38,25 +64,29 @@ const TableBody = ({ sortedRoles, canDelete, permissions, setRoleToDelete, onDel
           </Td>
           <Td width="30%">
             <Typography>
-              {`${role.nb_users} ${formatMessage({
-                id: 'global.users',
-                defaultMessage: 'users',
-              }).toLowerCase()}`}
+              {formatMessage(
+                {
+                  id: 'Roles.RoleRow.user-count',
+                  defaultMessage: '{number, plural, =0 {# user} one {# user} other {# users}}',
+                },
+                { number: role.nb_users }
+              )}
             </Typography>
           </Td>
           <Td>
             <Flex justifyContent="end" {...stopPropagation}>
               <CheckPermissions permissions={permissions.updateRole}>
-                <IconButton
-                  onClick={() => handleClickEdit(role.id)}
-                  noBorder
-                  icon={<Pencil />}
-                  label={formatMessage(
+                <EditLink
+                  to={`/settings/users-permissions/roles/${role.id}`}
+                  aria-label={formatMessage(
                     { id: 'app.component.table.edit', defaultMessage: 'Edit {target}' },
                     { target: `${role.name}` }
                   )}
-                />
+                >
+                  <Pencil />
+                </EditLink>
               </CheckPermissions>
+
               {checkCanDeleteRole(role) && (
                 <CheckPermissions permissions={permissions.deleteRole}>
                   <IconButton