@strapi/plugin-users-permissions 4.0.0-next.6 → 4.0.0

package/admin/src/index.js

@@ -4,20 +4,12 @@
 // Here's the file: strapi/docs/3.0.0-beta.x/guides/registering-a-field-in-admin.md
 // Also the strapi-generate-plugins/files/admin/src/index.js needs to be updated
 // IF THE DOC IS NOT UPDATED THE PULL REQUEST WILL NOT BE MERGED
-import React from 'react';
-import { CheckPagePermissions, prefixPluginTranslations } from '@strapi/helper-plugin';
+import { prefixPluginTranslations } from '@strapi/helper-plugin';
 import pluginPkg from '../../package.json';
-import pluginLogo from './assets/images/logo.svg';
 import pluginPermissions from './permissions';
 import pluginId from './pluginId';
-import RolesPage from './pages/Roles';
-import ProvidersPage from './pages/Providers';
-import EmailTemplatesPage from './pages/EmailTemplates';
-import AdvancedSettingsPage from './pages/AdvancedSettings';
 import getTrad from './utils/getTrad';
 
-const pluginDescription = pluginPkg.strapi.description || pluginPkg.description;
-const icon = pluginPkg.strapi.icon;
 const name = pluginPkg.strapi.name;
 
 export default {
@@ -39,11 +31,13 @@ export default {
           },
           id: 'roles',
           to: `/settings/${pluginId}/roles`,
-          Component: () => (
-            <CheckPagePermissions permissions={pluginPermissions.accessRoles}>
-              <RolesPage />
-            </CheckPagePermissions>
-          ),
+          Component: async () => {
+            const component = await import(
+              /* webpackChunkName: "users-roles-settings-page" */ './pages/Roles'
+            );
+
+            return component;
+          },
           permissions: pluginPermissions.accessRoles,
         },
         {
@@ -53,11 +47,13 @@ export default {
           },
           id: 'providers',
           to: `/settings/${pluginId}/providers`,
-          Component: () => (
-            <CheckPagePermissions permissions={pluginPermissions.readProviders}>
-              <ProvidersPage />
-            </CheckPagePermissions>
-          ),
+          Component: async () => {
+            const component = await import(
+              /* webpackChunkName: "users-providers-settings-page" */ './pages/Providers'
+            );
+
+            return component;
+          },
           permissions: pluginPermissions.readProviders,
         },
         {
@@ -67,11 +63,13 @@ export default {
           },
           id: 'email-templates',
           to: `/settings/${pluginId}/email-templates`,
-          Component: () => (
-            <CheckPagePermissions permissions={pluginPermissions.readEmailTemplates}>
-              <EmailTemplatesPage />
-            </CheckPagePermissions>
-          ),
+          Component: async () => {
+            const component = await import(
+              /* webpackChunkName: "users-email-settings-page" */ './pages/EmailTemplates'
+            );
+
+            return component;
+          },
           permissions: pluginPermissions.readEmailTemplates,
         },
         {
@@ -81,24 +79,21 @@ export default {
           },
           id: 'advanced-settings',
           to: `/settings/${pluginId}/advanced-settings`,
-          Component: () => (
-            <CheckPagePermissions permissions={pluginPermissions.readAdvancedSettings}>
-              <AdvancedSettingsPage />
-            </CheckPagePermissions>
-          ),
+          Component: async () => {
+            const component = await import(
+              /* webpackChunkName: "users-advanced-settings-page" */ './pages/AdvancedSettings'
+            );
+
+            return component;
+          },
           permissions: pluginPermissions.readAdvancedSettings,
         },
       ]
     );
 
     app.registerPlugin({
-      description: pluginDescription,
-      icon,
       id: pluginId,
-      isReady: true,
-      isRequired: pluginPkg.strapi.required || false,
       name,
-      pluginLogo,
     });
   },
   bootstrap() {},

package/admin/src/pages/AdvancedSettings/index.js

@@ -1,220 +1,237 @@
-import React, { useCallback, useEffect, useMemo, useReducer, useRef, useState } from 'react';
+import React, { useMemo } from 'react';
+import { useQuery, useMutation, useQueryClient } from 'react-query';
 import { useIntl } from 'react-intl';
-import { Header } from '@buffetjs/custom';
-import { isEqual } from 'lodash';
+import { Formik } from 'formik';
 import {
-  FormBloc,
-  PopUpWarning,
+  CheckPagePermissions,
+  Form,
+  GenericInput,
+  LoadingIndicatorPage,
   SettingsPageTitle,
-  SizedInput,
-  useRBAC,
-  request,
+  useFocusWhenNavigate,
   useNotification,
   useOverlayBlocker,
+  useRBAC,
 } from '@strapi/helper-plugin';
+import { useNotifyAT } from '@strapi/design-system/LiveRegions';
+import { Main } from '@strapi/design-system/Main';
+import { HeaderLayout, ContentLayout } from '@strapi/design-system/Layout';
+import { Button } from '@strapi/design-system/Button';
+import { Box } from '@strapi/design-system/Box';
+import { Stack } from '@strapi/design-system/Stack';
+import { Select, Option } from '@strapi/design-system/Select';
+import { Typography } from '@strapi/design-system/Typography';
+import { Grid, GridItem } from '@strapi/design-system/Grid';
+import Check from '@strapi/icons/Check';
 import pluginPermissions from '../../permissions';
-import { getTrad, getRequestURL } from '../../utils';
-import ListBaselineAlignment from '../../components/ListBaselineAlignment';
-import form from './utils/form';
-import reducer, { initialState } from './reducer';
+import { getTrad } from '../../utils';
+import layout from './utils/layout';
+import schema from './utils/schema';
+import { fetchData, putAdvancedSettings } from './utils/api';
+
+const ProtectedAdvancedSettingsPage = () => (
+  <CheckPagePermissions permissions={pluginPermissions.readAdvancedSettings}>
+    <AdvancedSettingsPage />
+  </CheckPagePermissions>
+);
 
 const AdvancedSettingsPage = () => {
   const { formatMessage } = useIntl();
   const toggleNotification = useNotification();
   const { lockApp, unlockApp } = useOverlayBlocker();
-  const [showModalWarning, setShowModalWarning] = useState(false);
-  const pageTitle = formatMessage({ id: getTrad('HeaderNav.link.advancedSettings') });
-  const formTitle = formatMessage({
-    id: getTrad('Form.title.advancedSettings'),
-    defaultMessage: 'Settings',
-  });
+  const { notifyStatus } = useNotifyAT();
+  const queryClient = useQueryClient();
+  useFocusWhenNavigate();
 
-  const updatePermissions = useMemo(() => {
-    return { update: pluginPermissions.updateAdvancedSettings };
-  }, []);
+  const updatePermissions = useMemo(
+    () => ({ update: pluginPermissions.updateAdvancedSettings }),
+    []
+  );
   const {
     isLoading: isLoadingForPermissions,
     allowedActions: { canUpdate },
   } = useRBAC(updatePermissions);
-  const [
-    { initialData, isConfirmButtonLoading, isLoading, modifiedData, roles },
-    dispatch,
-  ] = useReducer(reducer, initialState);
-  const isMounted = useRef(true);
-  const abortController = new AbortController();
-  const { signal } = abortController;
-
-  useEffect(() => {
-    const getData = async () => {
-      try {
-        dispatch({
-          type: 'GET_DATA',
-        });
-
-        const data = await request(getRequestURL('advanced'), { method: 'GET', signal });
-
-        dispatch({
-          type: 'GET_DATA_SUCCEEDED',
-          data,
-        });
-      } catch (err) {
-        if (isMounted.current) {
-          dispatch({
-            type: 'GET_DATA_ERROR',
-          });
-          console.error(err);
-          toggleNotification({
-            type: 'warning',
-            message: { id: 'notification.error' },
-          });
-        }
-      }
-    };
-
-    if (!isLoadingForPermissions) {
-      getData();
-    }
-
-    return () => {
-      abortController.abort();
-      isMounted.current = false;
-    };
-
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [isLoadingForPermissions]);
-
-  const handleChange = useCallback(({ target }) => {
-    dispatch({
-      type: 'ON_CHANGE',
-      keys: target.name,
-      value: target.value,
-    });
-  }, []);
-
-  const handleSubmit = useCallback(
-    async e => {
-      e.preventDefault();
-
-      try {
-        dispatch({
-          type: 'ON_SUBMIT',
-        });
-
-        lockApp();
-        await request(getRequestURL('advanced'), { method: 'PUT', body: modifiedData });
-
-        dispatch({
-          type: 'ON_SUBMIT_SUCCEEDED',
-        });
-
-        toggleNotification({
-          type: 'success',
-          message: { id: getTrad('notification.success.submit') },
-        });
-      } catch (err) {
-        dispatch({
-          type: 'ON_SUBMIT_ERROR',
-        });
-        console.error(err);
-        toggleNotification({
-          type: 'warning',
-          message: { id: 'notification.error' },
-        });
-      }
+
+  const { status: isLoadingData, data } = useQuery('advanced', () => fetchData(), {
+    onSuccess: () => {
+      notifyStatus(
+        formatMessage({
+          id: getTrad('Form.advancedSettings.data.loaded'),
+          defaultMessage: 'Advanced settings data has been loaded',
+        })
+      );
+    },
+    onError: () => {
+      toggleNotification({
+        type: 'warning',
+        message: { id: getTrad('notification.error'), defaultMessage: 'An error occured' },
+      });
+    },
+  });
+
+  const isLoading = isLoadingForPermissions || isLoadingData !== 'success';
+
+  const submitMutation = useMutation(body => putAdvancedSettings(body), {
+    onSuccess: async () => {
+      await queryClient.invalidateQueries('advanced');
+      toggleNotification({
+        type: 'success',
+        message: { id: getTrad('notification.success.saved'), defaultMessage: 'Saved' },
+      });
 
       unlockApp();
     },
-    [lockApp, modifiedData, toggleNotification, unlockApp]
-  );
+    onError: () => {
+      toggleNotification({
+        type: 'warning',
+        message: { id: getTrad('notification.error'), defaultMessage: 'An error occured' },
+      });
+      unlockApp();
+    },
+    refetchActive: true,
+  });
 
-  const handleConfirmReset = useCallback(() => {
-    dispatch({
-      type: 'ON_RESET',
-    });
-
-    setShowModalWarning(false);
-  }, []);
-
-  const handleToggleModal = useCallback(() => {
-    setShowModalWarning(prev => !prev);
-  }, []);
-
-  const headerActions = useMemo(() => {
-    const isDisabled = isEqual(initialData, modifiedData);
-
-    return [
-      {
-        disabled: isDisabled,
-        onClick: () => {
-          handleToggleModal();
-        },
-        color: 'cancel',
-        label: formatMessage({
-          id: 'app.components.Button.reset',
-        }),
-
-        type: 'button',
-        style: {
-          paddingLeft: 15,
-          paddingRight: 15,
-          fontWeight: 600,
-        },
-      },
-      {
-        disabled: isDisabled,
-        color: 'success',
-        label: formatMessage({
-          id: 'app.components.Button.save',
-        }),
-        isLoading: isConfirmButtonLoading,
-        type: 'submit',
-        style: {
-          minWidth: 150,
-          fontWeight: 600,
-        },
-      },
-    ];
-  }, [initialData, isConfirmButtonLoading, modifiedData, formatMessage, handleToggleModal]);
-
-  const showLoader = isLoadingForPermissions || isLoading;
+  const { isLoading: isSubmittingForm } = submitMutation;
+
+  const handleSubmit = async body => {
+    lockApp();
+
+    const urlConfirmation = body.email_confirmation ? body.email_confirmation_redirection : '';
+
+    await submitMutation.mutateAsync({ ...body, email_confirmation_redirection: urlConfirmation });
+  };
+
+  if (isLoading) {
+    return (
+      <Main aria-busy="true">
+        <SettingsPageTitle
+          name={formatMessage({
+            id: getTrad('HeaderNav.link.advancedSettings'),
+            defaultMessage: 'Advanced Settings',
+          })}
+        />
+        <HeaderLayout
+          title={formatMessage({
+            id: getTrad('HeaderNav.link.advancedSettings'),
+            defaultMessage: 'Advanced Settings',
+          })}
+        />
+        <ContentLayout>
+          <LoadingIndicatorPage />
+        </ContentLayout>
+      </Main>
+    );
+  }
 
   return (
-    <>
-      <SettingsPageTitle name={pageTitle} />
-      <div>
-        <form onSubmit={handleSubmit}>
-          <Header actions={headerActions} title={{ label: pageTitle }} isLoading={showLoader} />
-          <ListBaselineAlignment />
-          <FormBloc title={formTitle} isLoading={showLoader}>
-            {form.map(input => {
-              return (
-                <SizedInput
-                  key={input.name}
-                  {...input}
-                  disabled={!canUpdate}
-                  onChange={handleChange}
-                  options={roles}
-                  value={modifiedData[input.name]}
-                />
-              );
-            })}
-          </FormBloc>
-        </form>
-      </div>
-      <PopUpWarning
-        isOpen={showModalWarning}
-        toggleModal={handleToggleModal}
-        content={{
-          title: getTrad('popUpWarning.title'),
-          message: getTrad('popUpWarning.warning.cancel'),
-          cancel: getTrad('popUpWarning.button.cancel'),
-          confirm: getTrad('popUpWarning.button.confirm'),
-        }}
-        popUpWarningType="danger"
-        onConfirm={handleConfirmReset}
+    <Main aria-busy={isSubmittingForm}>
+      <SettingsPageTitle
+        name={formatMessage({
+          id: getTrad('HeaderNav.link.advancedSettings'),
+          defaultMessage: 'Advanced Settings',
+        })}
       />
-    </>
+      <Formik
+        onSubmit={handleSubmit}
+        initialValues={data.settings}
+        validateOnChange={false}
+        validationSchema={schema}
+        enableReinitialize
+      >
+        {({ errors, values, handleChange, isSubmitting }) => {
+          return (
+            <Form>
+              <HeaderLayout
+                title={formatMessage({
+                  id: getTrad('HeaderNav.link.advancedSettings'),
+                  defaultMessage: 'Advanced Settings',
+                })}
+                primaryAction={
+                  <Button
+                    loading={isSubmitting}
+                    type="submit"
+                    disabled={!canUpdate}
+                    startIcon={<Check />}
+                    size="L"
+                  >
+                    {formatMessage({ id: getTrad('Form.save'), defaultMessage: 'Save' })}
+                  </Button>
+                }
+              />
+              <ContentLayout>
+                <Box
+                  background="neutral0"
+                  hasRadius
+                  shadow="filterShadow"
+                  paddingTop={6}
+                  paddingBottom={6}
+                  paddingLeft={7}
+                  paddingRight={7}
+                >
+                  <Stack size={4}>
+                    <Typography variant="delta" as="h2">
+                      {formatMessage({
+                        id: getTrad('Form.title.advancedSettings'),
+                        defaultMessage: 'Settings',
+                      })}
+                    </Typography>
+                    <Grid gap={6}>
+                      <GridItem col={6} s={12}>
+                        <Select
+                          label={formatMessage({
+                            id: getTrad('EditForm.inputSelect.label.role'),
+                            defaultMessage: 'Default role for authenticated users',
+                          })}
+                          value={values.default_role}
+                          hint={formatMessage({
+                            id: getTrad('EditForm.inputSelect.description.role'),
+                            defaultMessage:
+                              'It will attach the new authenticated user to the selected role.',
+                          })}
+                          onChange={e =>
+                            handleChange({ target: { name: 'default_role', value: e } })}
+                        >
+                          {data.roles.map(role => {
+                            return (
+                              <Option key={role.type} value={role.type}>
+                                {role.name}
+                              </Option>
+                            );
+                          })}
+                        </Select>
+                      </GridItem>
+                      {layout.map(input => {
+                        let value = values[input.name];
+
+                        if (!value) {
+                          value = input.type === 'bool' ? false : '';
+                        }
+
+                        return (
+                          <GridItem key={input.name} {...input.size}>
+                            <GenericInput
+                              {...input}
+                              value={value}
+                              error={errors[input.name]}
+                              disabled={
+                                input.name === 'email_confirmation_redirection' &&
+                                values.email_confirmation === false
+                              }
+                              onChange={handleChange}
+                            />
+                          </GridItem>
+                        );
+                      })}
+                    </Grid>
+                  </Stack>
+                </Box>
+              </ContentLayout>
+            </Form>
+          );
+        }}
+      </Formik>
+    </Main>
   );
 };
 
-export default AdvancedSettingsPage;
+export default ProtectedAdvancedSettingsPage;

package/admin/src/pages/AdvancedSettings/utils/api.js

@@ -0,0 +1,13 @@
+import { axiosInstance, getRequestURL } from '../../../utils';
+
+const fetchData = async () => {
+  const { data } = await axiosInstance.get(getRequestURL('advanced'));
+
+  return data;
+};
+
+const putAdvancedSettings = body => {
+  return axiosInstance.put(getRequestURL('advanced'), body);
+};
+
+export { fetchData, putAdvancedSettings };

package/admin/src/pages/AdvancedSettings/utils/layout.js

@@ -0,0 +1,96 @@
+import { getTrad } from '../../../utils';
+
+const layout = [
+  {
+    intlLabel: {
+      id: getTrad('EditForm.inputToggle.label.email'),
+      defaultMessage: 'One account per email address',
+    },
+    description: {
+      id: getTrad('EditForm.inputToggle.description.email'),
+      defaultMessage:
+        'Disallow the user to create multiple accounts using the same email address with different authentication providers.',
+    },
+    name: 'unique_email',
+    type: 'bool',
+    size: {
+      col: 12,
+      xs: 12,
+    },
+  },
+  {
+    intlLabel: {
+      id: getTrad('EditForm.inputToggle.label.sign-up'),
+      defaultMessage: 'Enable sign-ups',
+    },
+    description: {
+      id: getTrad('EditForm.inputToggle.description.sign-up'),
+      defaultMessage:
+        'When disabled (OFF), the registration process is forbidden. No one can subscribe anymore no matter the used provider.',
+    },
+    name: 'allow_register',
+    type: 'bool',
+    size: {
+      col: 12,
+      xs: 12,
+    },
+  },
+  {
+    intlLabel: {
+      id: getTrad('EditForm.inputToggle.label.email-reset-password'),
+      defaultMessage: 'Reset password page',
+    },
+    description: {
+      id: getTrad('EditForm.inputToggle.description.email-reset-password'),
+      defaultMessage: "URL of your application's reset password page.",
+    },
+    placeholder: {
+      id: getTrad('EditForm.inputToggle.placeholder.email-reset-password'),
+      defaultMessage: 'ex: https://youtfrontend.com/reset-password',
+    },
+    name: 'email_reset_password',
+    type: 'text',
+    size: {
+      col: 6,
+      xs: 12,
+    },
+  },
+  {
+    intlLabel: {
+      id: getTrad('EditForm.inputToggle.label.email-confirmation'),
+      defaultMessage: 'Enable email confirmation',
+    },
+    description: {
+      id: getTrad('EditForm.inputToggle.description.email-confirmation'),
+      defaultMessage: 'When enabled (ON), new registered users receive a confirmation email.',
+    },
+    name: 'email_confirmation',
+    type: 'bool',
+    size: {
+      col: 12,
+      xs: 12,
+    },
+  },
+  {
+    intlLabel: {
+      id: getTrad('EditForm.inputToggle.label.email-confirmation-redirection'),
+      defaultMessage: 'Redirection url',
+    },
+    description: {
+      id: getTrad('EditForm.inputToggle.description.email-confirmation-redirection'),
+      defaultMessage: 'After you confirmed your email, choose where you will be redirected.',
+    },
+    placeholder: {
+      id: getTrad('EditForm.inputToggle.placeholder.email-reset-password'),
+      defaultMessage: 'ex: https://youtfrontend.com/reset-password',
+    },
+    name: 'email_confirmation_redirection',
+    type: 'text',
+    size: {
+      col: 6,
+      xs: 12,
+    },
+  },
+];
+
+export default layout;

package/admin/src/pages/AdvancedSettings/utils/schema.js

@@ -0,0 +1,22 @@
+import * as yup from 'yup';
+import { translatedErrors } from '@strapi/helper-plugin';
+
+const URL_REGEX = new RegExp('(^$)|((https?://.*)(d*)/?(.*))');
+
+const schema = yup.object().shape({
+  email_confirmation_redirection: yup
+    .string(translatedErrors.string)
+    .matches(URL_REGEX, translatedErrors.regex)
+    .nullable()
+    .when('email_confirmation', {
+      is: true,
+      then: yup.string().required(translatedErrors.required),
+      otherwise: yup.string(),
+    }),
+  email_reset_password: yup
+    .string(translatedErrors.string)
+    .matches(URL_REGEX, translatedErrors.regex)
+    .nullable(),
+});
+
+export default schema;