@plone/volto 17.0.0-alpha.3 → 17.0.0-alpha.30

package/src/middleware/blacklistRoutes.js

@@ -1,31 +1,34 @@
 import config from '@plone/volto/registry';
 import { matchPath } from 'react-router';
 
-const blacklistRoutes = ({ dispatch, getState }) => (next) => (action) => {
-  if (typeof action === 'function') {
-    return next(action);
-  }
+const blacklistRoutes =
+  ({ dispatch, getState }) =>
+  (next) =>
+  (action) => {
+    if (typeof action === 'function') {
+      return next(action);
+    }
 
-  switch (action.type) {
-    case '@@router/LOCATION_CHANGE':
-      const { pathname } = action.payload.location;
-      const { externalRoutes = [] } = config.settings;
+    switch (action.type) {
+      case '@@router/LOCATION_CHANGE':
+        const { pathname } = action.payload.location;
+        const { externalRoutes = [] } = config.settings;
 
-      const route = externalRoutes.find((route) =>
-        matchPath(pathname, route.match),
-      );
+        const route = externalRoutes.find((route) =>
+          matchPath(pathname, route.match),
+        );
 
-      if (!route) {
+        if (!route) {
+          return next(action);
+        } else {
+          window.location.replace(
+            route.url ? route.url(action.payload) : pathname,
+          );
+        }
+        break;
+      default:
         return next(action);
-      } else {
-        window.location.replace(
-          route.url ? route.url(action.payload) : pathname,
-        );
-      }
-      break;
-    default:
-      return next(action);
-  }
-};
+    }
+  };
 
 export default blacklistRoutes;

package/src/middleware/index.js

@@ -4,8 +4,8 @@
  * @example import { api } from 'middleware';
  */
 
-export api from '@plone/volto/middleware/api';
-export blacklistRoutes from './blacklistRoutes';
+export { default as api } from '@plone/volto/middleware/api';
+export { default as blacklistRoutes } from './blacklistRoutes';
 export {
   protectLoadStart,
   protectLoadEnd,

package/src/middleware/storeProtectLoadUtils.js

@@ -21,42 +21,43 @@ const RESET_CONTENT = 'RESET_CONTENT';
 // such a reset when navigating between two content routes.
 // ---
 
-export const protectLoadStart = ({ dispatch, getState }) => (next) => (
-  action,
-) => {
-  if (typeof action === 'function') {
-    return next(action);
-  }
-  switch (action.type) {
-    case LOCATION_CHANGE:
-      const { location } = action.payload;
-      const { pathname: path } = location;
-      const currentPath = getState().router.location.pathname;
-      const result = next(action);
-      if (isCmsUi(path)) {
-        // Next path: isCmsUI, Non Content. There is no
-        // loading here, so skip counting altogether.
-        // Will update the delayed location constantly.
-        dispatch({
-          type: PROTECT_SKIPPED,
-          location,
-        });
-      } else {
-        dispatch({
-          type: PROTECT_START,
-          location,
-          // Only reset before the fetch, if we depart from
-          // a not isCmsUi, Content pass. However, reset will
-          // not occur if moving between two content paths,
-          // only the postponed location will be booked.
-          resetBeforeFetch: isCmsUi(currentPath),
-        });
-      }
-      return result;
-    default:
+export const protectLoadStart =
+  ({ dispatch, getState }) =>
+  (next) =>
+  (action) => {
+    if (typeof action === 'function') {
       return next(action);
-  }
-};
+    }
+    switch (action.type) {
+      case LOCATION_CHANGE:
+        const { location } = action.payload;
+        const { pathname: path } = location;
+        const currentPath = getState().router.location.pathname;
+        const result = next(action);
+        if (isCmsUi(path)) {
+          // Next path: isCmsUI, Non Content. There is no
+          // loading here, so skip counting altogether.
+          // Will update the delayed location constantly.
+          dispatch({
+            type: PROTECT_SKIPPED,
+            location,
+          });
+        } else {
+          dispatch({
+            type: PROTECT_START,
+            location,
+            // Only reset before the fetch, if we depart from
+            // a not isCmsUi, Content pass. However, reset will
+            // not occur if moving between two content paths,
+            // only the postponed location will be booked.
+            resetBeforeFetch: isCmsUi(currentPath),
+          });
+        }
+        return result;
+      default:
+        return next(action);
+    }
+  };
 
 // Note that there is a bit of heuristics here. We assume that every action
 // like this is beginning/ending an action. If this logic fails then the counting
@@ -70,34 +71,32 @@ const mapActions = {
   [GET_CONTENT_PENDING]: RESET_CONTENT,
 };
 
-export const protectLoadEnd = ({ dispatch, getState }) => (next) => (
-  action,
-) => {
-  if (typeof action === 'function') {
-    return next(action);
-  }
-  const {
-    isCounting,
-    resetBeforeFetch,
-    requestCount,
-  } = getState().loadProtector;
-  if (resetBeforeFetch) {
-    const type = mapActions[action.type];
-    if (type) {
-      dispatch({ type });
+export const protectLoadEnd =
+  ({ dispatch, getState }) =>
+  (next) =>
+  (action) => {
+    if (typeof action === 'function') {
+      return next(action);
     }
-  }
-  if (isCounting && requestCount === 1 && isResponseAction(action)) {
-    setTimeout(
-      () =>
-        dispatch({
-          type: PROTECT_END,
-        }),
-      0,
-    );
-  }
-  return next(action);
-};
+    const { isCounting, resetBeforeFetch, requestCount } =
+      getState().loadProtector;
+    if (resetBeforeFetch) {
+      const type = mapActions[action.type];
+      if (type) {
+        dispatch({ type });
+      }
+    }
+    if (isCounting && requestCount === 1 && isResponseAction(action)) {
+      setTimeout(
+        () =>
+          dispatch({
+            type: PROTECT_END,
+          }),
+        0,
+      );
+    }
+    return next(action);
+  };
 
 export function loadProtector(state = {}, action = {}) {
   switch (action.type) {

package/src/middleware/storeProtectLoadUtils.test.js

@@ -26,54 +26,58 @@ describe('storeProtectLoadUtils', () => {
       expect(result).toBe('NEXT');
     });
 
-    const testLocationChange = ({ locationMap, resetBeforeFetch }) => () => {
-      const dispatch = jest.fn();
-      const getState = jest.fn(() => ({
-        router: {
-          location: {
-            pathname: '/PATH',
+    const testLocationChange =
+      ({ locationMap, resetBeforeFetch }) =>
+      () => {
+        const dispatch = jest.fn();
+        const getState = jest.fn(() => ({
+          router: {
+            location: {
+              pathname: '/PATH',
+            },
           },
-        },
-      }));
-      const next = jest.fn(() => 'NEXT');
-      const action = {
-        type: '@@router/LOCATION_CHANGE',
-        payload: { location: { pathname: '/NEW-PATH' } },
+        }));
+        const next = jest.fn(() => 'NEXT');
+        const action = {
+          type: '@@router/LOCATION_CHANGE',
+          payload: { location: { pathname: '/NEW-PATH' } },
+        };
+        Url.isCmsUi = jest.fn((path) => locationMap[path]);
+        const result = protectLoadStart({ dispatch, getState })(next)(action);
+        expect(dispatch).toBeCalledWith({
+          type: '@@loadProtector/START',
+          location: { pathname: '/NEW-PATH' },
+          resetBeforeFetch,
+        });
+        expect(next).toBeCalledWith(action);
+        expect(result).toBe('NEXT');
       };
-      Url.isCmsUi = jest.fn((path) => locationMap[path]);
-      const result = protectLoadStart({ dispatch, getState })(next)(action);
-      expect(dispatch).toBeCalledWith({
-        type: '@@loadProtector/START',
-        location: { pathname: '/NEW-PATH' },
-        resetBeforeFetch,
-      });
-      expect(next).toBeCalledWith(action);
-      expect(result).toBe('NEXT');
-    };
 
-    const testLocationSkipped = ({ locationMap }) => () => {
-      const dispatch = jest.fn();
-      const getState = jest.fn(() => ({
-        router: {
-          location: {
-            pathname: '/PATH',
+    const testLocationSkipped =
+      ({ locationMap }) =>
+      () => {
+        const dispatch = jest.fn();
+        const getState = jest.fn(() => ({
+          router: {
+            location: {
+              pathname: '/PATH',
+            },
           },
-        },
-      }));
-      const next = jest.fn(() => 'NEXT');
-      const action = {
-        type: '@@router/LOCATION_CHANGE',
-        payload: { location: { pathname: '/NEW-PATH' } },
+        }));
+        const next = jest.fn(() => 'NEXT');
+        const action = {
+          type: '@@router/LOCATION_CHANGE',
+          payload: { location: { pathname: '/NEW-PATH' } },
+        };
+        Url.isCmsUi = jest.fn((path) => locationMap[path]);
+        const result = protectLoadStart({ dispatch, getState })(next)(action);
+        expect(dispatch).toBeCalledWith({
+          type: '@@loadProtector/SKIPPED',
+          location: { pathname: '/NEW-PATH' },
+        });
+        expect(next).toBeCalledWith(action);
+        expect(result).toBe('NEXT');
       };
-      Url.isCmsUi = jest.fn((path) => locationMap[path]);
-      const result = protectLoadStart({ dispatch, getState })(next)(action);
-      expect(dispatch).toBeCalledWith({
-        type: '@@loadProtector/SKIPPED',
-        location: { pathname: '/NEW-PATH' },
-      });
-      expect(next).toBeCalledWith(action);
-      expect(result).toBe('NEXT');
-    };
 
     describe('location change', () => {
       test(

package/src/reducers/actions/actions.js

@@ -46,7 +46,7 @@ export default function actions(state = initialState, action = {}) {
         'actions',
         getBaseUrl(flattenToAppURL(action.result['@id'])),
       );
-      if (hasExpander) {
+      if (hasExpander && !action.subrequest) {
         return {
           ...state,
           error: null,
@@ -57,11 +57,13 @@ export default function actions(state = initialState, action = {}) {
       }
       return state;
     case `${LIST_ACTIONS}_SUCCESS`:
-      hasExpander = hasApiExpander(
-        'actions',
-        getBaseUrl(flattenToAppURL(action.result['@id'])),
-      );
-      if (!hasExpander) {
+      // Even if the expander is set or not, if the LIST_ACTIONS is
+      // called, we want it to store the data if the actions data is
+      // not set in the expander data (['@components']) but in the "normal"
+      // action result (we look for the object property returned by the endpoint)
+      // Unfortunately, this endpoint returns all the actions in a plain object
+      // with no structure :(
+      if (action.result.object) {
         return {
           ...state,
           error: null,

package/src/reducers/actions/actions.test.js

@@ -207,4 +207,74 @@ describe('Actions reducer - (ACTIONS)GET_CONTENT', () => {
       loading: false,
     });
   });
+
+  it('should handle (ACTIONS)LIST_ACTIONS (standalone with apiExpander enabled)', () => {
+    expect(
+      actions(undefined, {
+        type: `${LIST_ACTIONS}_SUCCESS`,
+        result: {
+          object: [],
+          object_buttons: [],
+          site_actions: [],
+          user: [
+            {
+              icon: '',
+              id: 'preferences',
+              title: 'Preferences',
+            },
+            {
+              icon: '',
+              id: 'dashboard',
+              title: 'Dashboard',
+            },
+            {
+              icon: '',
+              id: 'plone_setup',
+              title: 'Site Setup',
+            },
+            {
+              icon: '',
+              id: 'logout',
+              title: 'Log out',
+            },
+          ],
+          document_actions: [],
+          portal_tabs: [],
+        },
+      }),
+    ).toEqual({
+      error: null,
+      actions: {
+        object: [],
+        object_buttons: [],
+        site_actions: [],
+        user: [
+          {
+            icon: '',
+            id: 'preferences',
+            title: 'Preferences',
+          },
+          {
+            icon: '',
+            id: 'dashboard',
+            title: 'Dashboard',
+          },
+          {
+            icon: '',
+            id: 'plone_setup',
+            title: 'Site Setup',
+          },
+          {
+            icon: '',
+            id: 'logout',
+            title: 'Log out',
+          },
+        ],
+        document_actions: [],
+        portal_tabs: [],
+      },
+      loaded: true,
+      loading: false,
+    });
+  });
 });

package/src/reducers/breadcrumbs/breadcrumbs.js

@@ -45,7 +45,7 @@ export default function breadcrumbs(state = initialState, action = {}) {
         'breadcrumbs',
         getBaseUrl(flattenToAppURL(action.result['@id'])),
       );
-      if (hasExpander) {
+      if (hasExpander && !action.subrequest) {
         return {
           ...state,
           error: null,

package/src/reducers/content/content.test.js

@@ -82,7 +82,7 @@ describe('Content reducer', () => {
       }),
     ).toMatchObject({
       subrequests: {
-        '1234': {
+        1234: {
           data: null,
           loaded: false,
           loading: true,
@@ -136,7 +136,7 @@ describe('Content reducer', () => {
       }),
     ).toMatchObject({
       subrequests: {
-        '1234': {
+        1234: {
           data: {
             items: [
               {
@@ -170,7 +170,7 @@ describe('Content reducer', () => {
       }),
     ).toMatchObject({
       subrequests: {
-        '1234': {
+        1234: {
           data: [
             {
               '@id': `${settings.apiPath}/home-page`,
@@ -214,7 +214,7 @@ describe('Content reducer', () => {
       }),
     ).toMatchObject({
       subrequests: {
-        '1234': {
+        1234: {
           data: null,
           loaded: false,
           loading: false,

package/src/reducers/index.js

@@ -25,6 +25,7 @@ import messages from '@plone/volto/reducers/messages/messages';
 import navigation from '@plone/volto/reducers/navigation/navigation';
 import querystring from '@plone/volto/reducers/querystring/querystring';
 import querystringsearch from '@plone/volto/reducers/querystringsearch/querystringsearch';
+import relations from '@plone/volto/reducers/relations/relations';
 import roles from '@plone/volto/reducers/roles/roles';
 import rules from '@plone/volto/reducers/rules/rules';
 import controlpanelrule from '@plone/volto/reducers/controlPanelRule/controlPanelRule';
@@ -49,6 +50,8 @@ import workingCopy from './workingcopy/workingcopy';
 import transactions from './transactions/transactions';
 import upgrade from './upgrade/upgrade';
 import userschema from './userschema/userschema';
+import site from './site/site';
+import navroot from './navroot/navroot';
 
 /**
  * Root reducer.
@@ -80,6 +83,7 @@ const reducers = {
   navigation,
   querystring,
   querystringsearch,
+  relations,
   roles,
   rules,
   controlpanelrule,
@@ -103,6 +107,8 @@ const reducers = {
   workingCopy,
   transactions,
   userschema,
+  site,
+  navroot,
 };
 
 export default reducers;

package/src/reducers/navigation/navigation.js

@@ -60,7 +60,7 @@ export default function navigation(state = initialState, action = {}) {
         'navigation',
         getBaseUrl(flattenToAppURL(action.result['@id'])),
       );
-      if (hasExpander) {
+      if (hasExpander && !action.subrequest) {
         return {
           ...state,
           error: null,
@@ -73,11 +73,11 @@ export default function navigation(state = initialState, action = {}) {
       }
       return state;
     case `${GET_NAVIGATION}_SUCCESS`:
-      hasExpander = hasApiExpander(
-        'navigation',
-        getBaseUrl(flattenToAppURL(action.result['@id'])),
-      );
-      if (!hasExpander) {
+      // Even if the expander is set or not, if the GET_NAVIGATION is
+      // called, we want it to store the data if the actions data is
+      // not set in the expander data (['@components']) but in the "normal"
+      // action result (we look for the object property returned by the endpoint)
+      if (!action.result?.['@components'] && action.result?.items) {
         return {
           ...state,
           error: null,

package/src/reducers/navigation/navigation.test.js

@@ -172,4 +172,34 @@ describe('Navigation reducer (NAVIGATION)GET_CONTENT', () => {
       loading: false,
     });
   });
+
+  it('should handle (NAVIGATION)GET_NAVIGATION_SUCCESS (standalone with apiExpander enabled)', () => {
+    expect(
+      navigation(undefined, {
+        type: `${GET_NAVIGATION}_SUCCESS`,
+        result: {
+          items: [
+            {
+              title: 'Welcome to Plone!',
+              description:
+                'Congratulations! You have successfully installed Plone.',
+              '@id': `${settings.apiPath}/front-page`,
+            },
+          ],
+        },
+      }),
+    ).toEqual({
+      error: null,
+      items: [
+        {
+          title: 'Welcome to Plone!',
+          description:
+            'Congratulations! You have successfully installed Plone.',
+          url: '/front-page',
+        },
+      ],
+      loaded: true,
+      loading: false,
+    });
+  });
 });

package/src/reducers/navroot/navroot.js

@@ -0,0 +1,79 @@
+/**
+ * Navroot reducer.
+ * @module reducers/navroot/navroot
+ */
+import {
+  flattenToAppURL,
+  getBaseUrl,
+  hasApiExpander,
+} from '@plone/volto/helpers';
+
+import { GET_NAVROOT, GET_CONTENT } from '@plone/volto/constants/ActionTypes';
+
+const initialState = {
+  error: null,
+  loaded: false,
+  loading: false,
+  data: {},
+};
+
+/**
+ * navroot reducer.
+ * @function navroot
+ * @param {Object} state Current state.
+ * @param {Object} action Action to be handled.
+ * @returns {Object} New state.
+ */
+export default function navroot(state = initialState, action = {}) {
+  let hasExpander;
+  switch (action.type) {
+    case `${GET_NAVROOT}_PENDING`:
+      return {
+        ...state,
+        error: null,
+        loaded: false,
+        loading: true,
+        data: {},
+      };
+    case `${GET_CONTENT}_SUCCESS`:
+      hasExpander = hasApiExpander(
+        'navroot',
+        getBaseUrl(flattenToAppURL(action.result['@id'])),
+      );
+      if (hasExpander && !action.subrequest) {
+        return {
+          ...state,
+          error: null,
+          data: action.result['@components'].navroot,
+          loaded: true,
+          loading: false,
+        };
+      }
+      return state;
+    case `${GET_NAVROOT}_SUCCESS`:
+      hasExpander = hasApiExpander(
+        'navroot',
+        getBaseUrl(flattenToAppURL(action.result['@id'])),
+      );
+      if (!hasExpander) {
+        return {
+          ...state,
+          error: null,
+          loaded: true,
+          loading: false,
+          data: action.result,
+        };
+      }
+      return state;
+    case `${GET_NAVROOT}_FAIL`:
+      return {
+        ...state,
+        error: action.result,
+        loaded: false,
+        loading: false,
+        data: {},
+      };
+    default:
+      return state;
+  }
+}