@strapi/plugin-users-permissions 4.10.0-beta.0 → 4.10.0

package/.eslintignore

@@ -0,0 +1,2 @@
+node_modules/
+.eslintrc.js

package/.eslintrc.js

@@ -0,0 +1,14 @@
+module.exports = {
+  root: true,
+  overrides: [
+    {
+      files: ['admin/**/*'],
+      extends: ['custom/front'],
+    },
+    {
+      files: ['**/*'],
+      excludedFiles: ['admin/**/*'],
+      extends: ['custom/back'],
+    },
+  ],
+};

package/admin/src/hooks/useForm/index.js

@@ -1,5 +1,5 @@
 import { useCallback, useEffect, useReducer, useRef } from 'react';
-import { useRBAC, request, useNotification } from '@strapi/helper-plugin';
+import { useRBAC, useFetchClient, useNotification } from '@strapi/helper-plugin';
 import { getRequestURL } from '../../utils';
 import reducer, { initialState } from './reducer';
 
@@ -9,8 +9,7 @@ const useUserForm = (endPoint, permissions) => {
   const toggleNotification = useNotification();
   const isMounted = useRef(true);
 
-  const abortController = new AbortController();
-  const { signal } = abortController;
+  const { get } = useFetchClient();
 
   useEffect(() => {
     const getData = async () => {
@@ -19,7 +18,7 @@ const useUserForm = (endPoint, permissions) => {
           type: 'GET_DATA',
         });
 
-        const data = await request(getRequestURL(endPoint), { method: 'GET', signal });
+        const { data } = await get(getRequestURL(endPoint));
 
         dispatch({
           type: 'GET_DATA_SUCCEEDED',
@@ -45,11 +44,9 @@ const useUserForm = (endPoint, permissions) => {
     }
 
     return () => {
-      abortController.abort();
       isMounted.current = false;
     };
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [isLoadingForPermissions, endPoint]);
+  }, [isLoadingForPermissions, endPoint, get, toggleNotification]);
 
   const dispatchSubmitSucceeded = useCallback((data) => {
     dispatch({

package/admin/src/hooks/useRolesList/index.js

@@ -1,5 +1,5 @@
-import { useEffect, useReducer, useRef } from 'react';
-import { request, useNotification } from '@strapi/helper-plugin';
+import { useCallback, useEffect, useReducer, useRef } from 'react';
+import { useFetchClient, useNotification } from '@strapi/helper-plugin';
 import get from 'lodash/get';
 import init from './init';
 import pluginId from '../../pluginId';
@@ -12,28 +12,17 @@ const useRolesList = (shouldFetchData = true) => {
   const toggleNotification = useNotification();
 
   const isMounted = useRef(true);
-  const abortController = new AbortController();
-  const { signal } = abortController;
+  const fetchClient = useFetchClient();
 
-  useEffect(() => {
-    if (shouldFetchData) {
-      fetchRolesList();
-    }
-
-    return () => {
-      abortController.abort();
-      isMounted.current = false;
-    };
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [shouldFetchData]);
-
-  const fetchRolesList = async () => {
+  const fetchRolesList = useCallback(async () => {
     try {
       dispatch({
         type: 'GET_DATA',
       });
 
-      const { roles } = await request(`/${pluginId}/roles`, { method: 'GET', signal });
+      const {
+        data: { roles },
+      } = await fetchClient.get(`/${pluginId}/roles`);
 
       dispatch({
         type: 'GET_DATA_SUCCEEDED',
@@ -55,7 +44,17 @@ const useRolesList = (shouldFetchData = true) => {
         }
       }
     }
-  };
+  }, [fetchClient, toggleNotification]);
+
+  useEffect(() => {
+    if (shouldFetchData) {
+      fetchRolesList();
+    }
+
+    return () => {
+      isMounted.current = false;
+    };
+  }, [shouldFetchData, fetchRolesList]);
 
   return { roles, isLoading, getData: fetchRolesList };
 };

package/admin/src/pages/Roles/ListPage/index.js

@@ -28,11 +28,12 @@ import {
   useQueryParams,
   EmptyStateLayout,
   ConfirmDialog,
+  useFilter,
+  useCollator,
 } from '@strapi/helper-plugin';
 import { useIntl } from 'react-intl';
 import { useHistory } from 'react-router-dom';
 import { useMutation, useQuery, useQueryClient } from 'react-query';
-import matchSorter from 'match-sorter';
 
 import { fetchData, deleteData } from './utils/api';
 import { getTrad } from '../../../utils';
@@ -42,7 +43,7 @@ import TableBody from './components/TableBody';
 
 const RoleListPage = () => {
   const { trackUsage } = useTracking();
-  const { formatMessage } = useIntl();
+  const { formatMessage, locale } = useIntl();
   const { push } = useHistory();
   const toggleNotification = useNotification();
   const { notifyStatus } = useNotifyAT();
@@ -78,6 +79,17 @@ const RoleListPage = () => {
     enabled: canRead,
   });
 
+  const { includes } = useFilter(locale, {
+    sensitivity: 'base',
+  });
+
+  /**
+   * @type {Intl.Collator}
+   */
+  const formatter = useCollator(locale, {
+    sensitivity: 'base',
+  });
+
   const isLoading = isLoadingForData || isFetching;
 
   const handleNewRoleClick = () => {
@@ -118,7 +130,12 @@ const RoleListPage = () => {
     setIsConfirmButtonLoading(false);
   };
 
-  const sortedRoles = matchSorter(roles || [], _q, { keys: ['name', 'description'] });
+  const sortedRoles = (roles || [])
+    .filter((role) => includes(role.name, _q) || includes(role.description, _q))
+    .sort(
+      (a, b) => formatter.compare(a.name, b.name) || formatter.compare(a.description, b.description)
+    );
+
   const emptyContent = _q && !sortedRoles.length ? 'search' : 'roles';
 
   const colCount = 4;

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

@@ -1,6 +1,6 @@
 import React from 'react';
 import { Switch, Route } from 'react-router-dom';
-import { CheckPagePermissions, NotFound } from '@strapi/helper-plugin';
+import { CheckPagePermissions, AnErrorOccurred } from '@strapi/helper-plugin';
 import pluginId from '../../pluginId';
 import pluginPermissions from '../../permissions';
 import ProtectedRolesListPage from './ProtectedListPage';
@@ -18,7 +18,7 @@ const Roles = () => {
         />
         <Route path={`/settings/${pluginId}/roles/:id`} component={ProtectedRolesEditPage} exact />
         <Route path={`/settings/${pluginId}/roles`} component={ProtectedRolesListPage} exact />
-        <Route path="" component={NotFound} />
+        <Route path="" component={AnErrorOccurred} />
       </Switch>
     </CheckPagePermissions>
   );

package/documentation/content-api.yaml

@@ -12,8 +12,16 @@ tags:
       url: 'https://docs.strapi.io/developer-docs/latest/plugins/users-permissions.html'
 
 paths:
-  '/connect/(.*)':
+  /connect/{provider}:
     get:
+      parameters:
+        - name: provider
+          in: path
+          required: true
+          description: Provider name
+          schema:
+            type: string
+            pattern: '.*'
       tags:
         - Users-Permissions - Auth
       summary: Login with a provider
@@ -148,7 +156,7 @@ paths:
                 type: object
                 properties:
                   ok:
-                    type: enum
+                    type: string
                     enum: [true]
         default:
           description: Error
@@ -273,7 +281,7 @@ paths:
                   email:
                     type: string
                   sent:
-                    type: enum
+                    type: string
                     enum: [true]
         default:
           description: Error
@@ -381,7 +389,7 @@ paths:
                 type: object
                 properties:
                   ok:
-                    type: enum
+                    type: string
                     enum: [true]
         default:
           description: Error
@@ -456,7 +464,7 @@ paths:
                 type: object
                 properties:
                   ok:
-                    type: enum
+                    type: string
                     enum: [true]
         default:
           description: Error
@@ -485,7 +493,7 @@ paths:
                 type: object
                 properties:
                   ok:
-                    type: enum
+                    type: string
                     enum: [true]
         default:
           description: Error
@@ -779,9 +787,11 @@ components:
         type:
           type: string
         createdAt:
-          type: datetime
+          type: string
+          format: date-time
         updatedAt:
-          type: datetime
+          type: string
+          format: date-time
 
     Users-Permissions-User:
       type: object
@@ -805,10 +815,12 @@ components:
           type: boolean
           example: false
         createdAt:
-          type: datetime
+          type: string
+          format: date-time
           example: '2022-06-02T08:32:06.258Z'
         updatedAt:
-          type: datetime
+          type: string
+          format: date-time
           example: '2022-06-02T08:32:06.267Z'
 
     Users-Permissions-UserRegistration:
@@ -839,10 +851,6 @@ components:
                     type: boolean
                   policy:
                     type: string
-
-  parameters:
-  responses:
-  examples:
   requestBodies:
     Users-Permissions-RoleRequest:
       required: true

package/jest.config.front.js

@@ -1,10 +1,5 @@
 'use strict';
 
-const baseConfig = require('../../../jest.base-config.front');
-const pkg = require('./package.json');
-
 module.exports = {
-  ...baseConfig,
-  displayName: (pkg.strapi && pkg.strapi.name) || pkg.name,
-  roots: [__dirname],
+  preset: '../../../jest-preset.front.js',
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/plugin-users-permissions",
-  "version": "4.10.0-beta.0",
+  "version": "4.10.0",
   "description": "Protect your API with a full-authentication process based on JWT",
   "repository": {
     "type": "git",
@@ -20,17 +20,19 @@
     }
   ],
   "scripts": {
-    "test:unit": "jest --verbose",
-    "test:front": "cross-env IS_EE=true jest --config ./jest.config.front.js",
-    "test:front:watch": "cross-env IS_EE=true jest --config ./jest.config.front.js --watchAll",
-    "test:front:ce": "cross-env IS_EE=false jest --config ./jest.config.front.js",
-    "test:front:watch:ce": "cross-env IS_EE=false jest --config ./jest.config.front.js --watchAll"
+    "test:unit": "run -T jest",
+    "test:unit:watch": "run -T jest --watch",
+    "test:front": "run -T cross-env IS_EE=true jest --config ./jest.config.front.js",
+    "test:front:watch": "run -T cross-env IS_EE=true jest --config ./jest.config.front.js --watchAll",
+    "test:front:ce": "run -T cross-env IS_EE=false jest --config ./jest.config.front.js",
+    "test:front:watch:ce": "run -T cross-env IS_EE=false jest --config ./jest.config.front.js --watchAll",
+    "lint": "run -T eslint ."
   },
   "dependencies": {
     "@strapi/design-system": "1.6.6",
-    "@strapi/helper-plugin": "4.10.0-beta.0",
+    "@strapi/helper-plugin": "4.10.0",
     "@strapi/icons": "1.6.6",
-    "@strapi/utils": "4.10.0-beta.0",
+    "@strapi/utils": "4.10.0",
     "bcryptjs": "2.4.3",
     "formik": "2.2.9",
     "grant-koa": "5.4.8",
@@ -40,7 +42,6 @@
     "koa": "^2.13.4",
     "koa2-ratelimit": "^1.1.2",
     "lodash": "4.17.21",
-    "match-sorter": "^4.0.2",
     "prop-types": "^15.7.2",
     "purest": "4.0.2",
     "react-intl": "6.3.2",
@@ -65,8 +66,8 @@
   "peerDependencies": {
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
-    "react-router-dom": "5.3.4",
-    "styled-components": "5.3.3"
+    "react-router-dom": "^5.3.4",
+    "styled-components": "^5.3.3"
   },
   "engines": {
     "node": ">=14.19.1 <=18.x.x",
@@ -79,5 +80,5 @@
     "required": true,
     "kind": "plugin"
   },
-  "gitHead": "1519ef0e56d27b738f24fc88223797651ad47aaf"
+  "gitHead": "9b5519778faaedfb837879f9c6f7e28fdfd6750d"
 }

package/server/controllers/auth.js

@@ -280,6 +280,12 @@ module.exports = {
         'confirmationToken',
         'resetPasswordToken',
         'provider',
+        'id',
+        'createdAt',
+        'updatedAt',
+        'createdBy',
+        'updatedBy',
+        'role',
       ]),
       provider: 'local',
     };

package/server/register.js

@@ -18,6 +18,12 @@ module.exports = ({ strapi }) => {
     const specPath = path.join(__dirname, '../documentation/content-api.yaml');
     const spec = fs.readFileSync(specPath, 'utf8');
 
-    strapi.plugin('documentation').service('documentation').registerDoc(spec);
+    strapi
+      .plugin('documentation')
+      .service('override')
+      .registerOverride(spec, {
+        pluginOrigin: 'users-permissions',
+        excludeFromGeneration: ['users-permissions'],
+      });
   }
 };

package/server/services/providers-registry.js

@@ -176,7 +176,7 @@ const getInitialProviders = ({ purest }) => ({
     const vk = purest({ provider: 'vk' });
 
     return vk
-      .get('users.get')
+      .get('users')
       .auth(accessToken)
       .qs({ id: query.raw.user_id, v: '5.122' })
       .request()

package/server/strategies/users-permissions.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { castArray, map, every, pipe } = require('lodash/fp');
+const { castArray, map, every, pipe, isEmpty } = require('lodash/fp');
 const { ForbiddenError, UnauthorizedError } = require('@strapi/utils').errors;
 
 const { getService } = require('../utils');
@@ -80,6 +80,13 @@ const authenticate = async (ctx) => {
 const verify = async (auth, config) => {
   const { credentials: user, ability } = auth;
 
+  strapi.telemetry.send('didReceiveAPIRequest', {
+    eventProperties: {
+      authenticationMethod: auth?.strategy?.name,
+      isAuthenticated: !isEmpty(user),
+    },
+  });
+
   if (!config.scope) {
     if (!user) {
       // A non authenticated user cannot access routes that do not have a scope