@strapi/admin 4.10.1 → 4.10.2

package/ee/admin/pages/SettingsPage/pages/ReviewWorkflows/components/Stages/Stage/Stage.js

@@ -1,4 +1,4 @@
-import React, { useState } from 'react';
+import * as React from 'react';
 import PropTypes from 'prop-types';
 import { useField } from 'formik';
 import { useIntl } from 'react-intl';
@@ -7,84 +7,308 @@ import {
   Accordion,
   AccordionToggle,
   AccordionContent,
+  Box,
+  Field,
+  FieldLabel,
+  FieldError,
+  Flex,
   Grid,
   GridItem,
   IconButton,
   TextInput,
+  VisuallyHidden,
 } from '@strapi/design-system';
-import { useTracking } from '@strapi/helper-plugin';
-import { Trash } from '@strapi/icons';
+import { ReactSelect, useTracking } from '@strapi/helper-plugin';
+import { Drag, Trash } from '@strapi/icons';
 
-import { deleteStage, updateStage } from '../../../actions';
+import { deleteStage, updateStagePosition, updateStage } from '../../../actions';
+import { getAvailableStageColors } from '../../../utils/colors';
+import { OptionColor } from './components/OptionColor';
+import { SingleValueColor } from './components/SingleValueColor';
+import { useDragAndDrop } from '../../../../../../../../../admin/src/content-manager/hooks';
+import { composeRefs } from '../../../../../../../../../admin/src/content-manager/utils';
+import { DRAG_DROP_TYPES } from '../../../constants';
 
-function Stage({ id, name, index, canDelete, isOpen: isOpenDefault = false }) {
+const AVAILABLE_COLORS = getAvailableStageColors();
+
+function StageDropPreview() {
+  return (
+    <Box
+      background="primary100"
+      borderStyle="dashed"
+      borderColor="primary600"
+      borderWidth="1px"
+      display="block"
+      hasRadius
+      padding={6}
+      shadow="tableShadow"
+    />
+  );
+}
+
+export function Stage({
+  id,
+  index,
+  canDelete,
+  canReorder,
+  isOpen: isOpenDefault = false,
+  stagesCount,
+}) {
+  /**
+   *
+   * @param {number} index
+   * @returns {string}
+   */
+  const getItemPos = (index) => `${index + 1} of ${stagesCount}`;
+
+  /**
+   *
+   * @param {number} index
+   * @returns {void}
+   */
+  const handleGrabStage = (index) => {
+    setLiveText(
+      formatMessage(
+        {
+          id: 'dnd.grab-item',
+          defaultMessage: `{item}, grabbed. Current position in list: {position}. Press up and down arrow to change position, Spacebar to drop, Escape to cancel.`,
+        },
+        {
+          item: nameField.value,
+          position: getItemPos(index),
+        }
+      )
+    );
+  };
+
+  /**
+   *
+   * @param {number} index
+   * @returns {void}
+   */
+  const handleDropStage = (index) => {
+    setLiveText(
+      formatMessage(
+        {
+          id: 'dnd.drop-item',
+          defaultMessage: `{item}, dropped. Final position in list: {position}.`,
+        },
+        {
+          item: nameField.value,
+          position: getItemPos(index),
+        }
+      )
+    );
+  };
+
+  /**
+   *
+   * @param {number} index
+   * @returns {void}
+   */
+  const handleCancelDragStage = () => {
+    setLiveText(
+      formatMessage(
+        {
+          id: 'dnd.cancel-item',
+          defaultMessage: '{item}, dropped. Re-order cancelled.',
+        },
+        {
+          item: nameField.value,
+        }
+      )
+    );
+  };
+
+  const handleMoveStage = (newIndex, oldIndex) => {
+    setLiveText(
+      formatMessage(
+        {
+          id: 'dnd.reorder',
+          defaultMessage: '{item}, moved. New position in list: {position}.',
+        },
+        {
+          item: nameField.value,
+          position: getItemPos(newIndex),
+        }
+      )
+    );
+
+    dispatch(updateStagePosition(oldIndex, newIndex));
+  };
+
+  const [liveText, setLiveText] = React.useState(null);
   const { formatMessage } = useIntl();
   const { trackUsage } = useTracking();
-  const [isOpen, setIsOpen] = useState(isOpenDefault);
-  const fieldIdentifier = `stages.${index}.name`;
-  const [field, meta] = useField(fieldIdentifier);
   const dispatch = useDispatch();
+  const [isOpen, setIsOpen] = React.useState(isOpenDefault);
+  const [nameField, nameMeta] = useField(`stages.${index}.name`);
+  const [colorField, colorMeta] = useField(`stages.${index}.color`);
+  const [{ handlerId, isDragging, handleKeyDown }, stageRef, dropRef, dragRef] = useDragAndDrop(
+    canReorder,
+    {
+      index,
+      item: {
+        name: nameField.value,
+      },
+      onGrabItem: handleGrabStage,
+      onDropItem: handleDropStage,
+      onMoveItem: handleMoveStage,
+      onCancel: handleCancelDragStage,
+      type: DRAG_DROP_TYPES.STAGE,
+    }
+  );
+
+  const composedRef = composeRefs(stageRef, dropRef);
+
+  const colorOptions = AVAILABLE_COLORS.map(({ hex, name }) => ({
+    value: hex,
+    label: formatMessage(
+      {
+        id: 'Settings.review-workflows.stage.color.name',
+        defaultMessage: '{name}',
+      },
+      { name }
+    ),
+    color: hex,
+  }));
+  // TODO: the .toUpperCase() conversion can be removed once the hex code is normalized in
+  // the admin API
+  const colorValue = colorOptions.find(({ value }) => value === colorField.value.toUpperCase());
 
   return (
-    <Accordion
-      size="S"
-      variant="primary"
-      onToggle={() => {
-        setIsOpen(!isOpen);
-
-        if (!isOpen) {
-          trackUsage('willEditStage');
-        }
-      }}
-      expanded={isOpen}
-      shadow="tableShadow"
-    >
-      <AccordionToggle
-        title={name}
-        togglePosition="left"
-        action={
-          canDelete ? (
-            <IconButton
-              background="transparent"
-              noBorder
-              onClick={() => dispatch(deleteStage(id))}
-              label={formatMessage({
-                id: 'Settings.review-workflows.stage.delete',
-                defaultMessage: 'Delete stage',
-              })}
-              icon={<Trash />}
-            />
-          ) : null
-        }
-      />
-      <AccordionContent padding={6} background="neutral0" hasRadius>
-        <Grid gap={4}>
-          <GridItem col={6}>
-            <TextInput
-              {...field}
-              id={fieldIdentifier}
-              value={name}
-              label={formatMessage({
-                id: 'Settings.review-workflows.stage.name.label',
-                defaultMessage: 'Stage name',
-              })}
-              error={meta.error ?? false}
-              onChange={(event) => {
-                field.onChange(event);
-                dispatch(updateStage(id, { name: event.target.value }));
-              }}
-            />
-          </GridItem>
-        </Grid>
-      </AccordionContent>
-    </Accordion>
+    <Box ref={composedRef}>
+      {liveText && <VisuallyHidden aria-live="assertive">{liveText}</VisuallyHidden>}
+
+      {isDragging ? (
+        <StageDropPreview />
+      ) : (
+        <Accordion
+          size="S"
+          variant="primary"
+          onToggle={() => {
+            setIsOpen(!isOpen);
+
+            if (!isOpen) {
+              trackUsage('willEditStage');
+            }
+          }}
+          expanded={isOpen}
+          shadow="tableShadow"
+        >
+          <AccordionToggle
+            title={nameField.value}
+            togglePosition="left"
+            action={
+              <>
+                {canDelete && (
+                  <IconButton
+                    background="transparent"
+                    icon={<Trash />}
+                    label={formatMessage({
+                      id: 'Settings.review-workflows.stage.delete',
+                      defaultMessage: 'Delete stage',
+                    })}
+                    noBorder
+                    onClick={() => dispatch(deleteStage(id))}
+                  />
+                )}
+
+                <IconButton
+                  background="transparent"
+                  forwardedAs="div"
+                  role="button"
+                  noBorder
+                  tabIndex={0}
+                  data-handler-id={handlerId}
+                  ref={dragRef}
+                  label={formatMessage({
+                    id: 'Settings.review-workflows.stage.drag',
+                    defaultMessage: 'Drag',
+                  })}
+                  onClick={(e) => e.stopPropagation()}
+                  onKeyDown={handleKeyDown}
+                >
+                  <Drag />
+                </IconButton>
+              </>
+            }
+          />
+          <AccordionContent padding={6} background="neutral0" hasRadius>
+            <Grid gap={4}>
+              <GridItem col={6}>
+                <TextInput
+                  {...nameField}
+                  id={nameField.name}
+                  label={formatMessage({
+                    id: 'Settings.review-workflows.stage.name.label',
+                    defaultMessage: 'Stage name',
+                  })}
+                  error={nameMeta.error ?? false}
+                  onChange={(event) => {
+                    nameField.onChange(event);
+                    dispatch(updateStage(id, { name: event.target.value }));
+                  }}
+                  required
+                />
+              </GridItem>
+
+              <GridItem col={6}>
+                <Field
+                  error={colorMeta?.error ?? false}
+                  name={colorField.name}
+                  id={colorField.name}
+                  required
+                >
+                  <Flex direction="column" gap={1} alignItems="stretch">
+                    <FieldLabel>
+                      {formatMessage({
+                        id: 'content-manager.reviewWorkflows.stage.color',
+                        defaultMessage: 'Color',
+                      })}
+                    </FieldLabel>
+
+                    <ReactSelect
+                      components={{ Option: OptionColor, SingleValue: SingleValueColor }}
+                      error={colorMeta?.error}
+                      inputId={colorField.name}
+                      name={colorField.name}
+                      options={colorOptions}
+                      onChange={({ value }) => {
+                        colorField.onChange({ target: { value } });
+                        dispatch(updateStage(id, { color: value }));
+                      }}
+                      // If no color was found in all the valid theme colors it means a user
+                      // has set a custom value e.g. through the content API. In that case we
+                      // display the custom color and a "Custom" label.
+                      value={
+                        colorValue ?? {
+                          value: colorField.value,
+                          label: formatMessage({
+                            id: 'Settings.review-workflows.stage.color.name.custom',
+                            defaultMessage: 'Custom',
+                          }),
+                          color: colorField.value,
+                        }
+                      }
+                    />
+
+                    <FieldError />
+                  </Flex>
+                </Field>
+              </GridItem>
+            </Grid>
+          </AccordionContent>
+        </Accordion>
+      )}
+    </Box>
   );
 }
 
-export { Stage };
-
 Stage.propTypes = PropTypes.shape({
   id: PropTypes.number.isRequired,
-  name: PropTypes.string.isRequired,
+  color: PropTypes.string.isRequired,
   canDelete: PropTypes.bool.isRequired,
+  canReorder: PropTypes.bool.isRequired,
+  stagesCount: PropTypes.number.isRequired,
 }).isRequired;

package/ee/admin/pages/SettingsPage/pages/ReviewWorkflows/components/Stages/Stage/components/OptionColor/OptionColor.js

@@ -0,0 +1,27 @@
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import { components } from 'react-select';
+import { Flex, Typography } from '@strapi/design-system';
+
+export function OptionColor({ children, ...props }) {
+  const { color } = props.data;
+
+  return (
+    <components.Option {...props}>
+      <Flex alignItems="center" gap={2}>
+        <Flex height={2} background={color} hasRadius shrink={0} width={2} />
+
+        <Typography textColor="neutral800" ellipsis>
+          {children}
+        </Typography>
+      </Flex>
+    </components.Option>
+  );
+}
+
+OptionColor.propTypes = {
+  children: PropTypes.node.isRequired,
+  data: PropTypes.shape({
+    color: PropTypes.string,
+  }).isRequired,
+};

package/ee/admin/pages/SettingsPage/pages/ReviewWorkflows/components/Stages/Stage/components/OptionColor/index.js

@@ -0,0 +1 @@
+export * from './OptionColor';

package/ee/admin/pages/SettingsPage/pages/ReviewWorkflows/components/Stages/Stage/components/SingleValueColor/SingleValueColor.js

@@ -0,0 +1,31 @@
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import { components } from 'react-select';
+import { Flex, Typography } from '@strapi/design-system';
+
+export function SingleValueColor({ children, ...props }) {
+  const { color } = props.data;
+
+  return (
+    <components.SingleValue {...props}>
+      <Flex alignItems="center" gap={2}>
+        <Flex height={2} background={color} hasRadius shrink={0} width={2} />
+
+        <Typography textColor="neutral800" ellipsis>
+          {children}
+        </Typography>
+      </Flex>
+    </components.SingleValue>
+  );
+}
+
+SingleValueColor.defaultProps = {
+  children: null,
+};
+
+SingleValueColor.propTypes = {
+  children: PropTypes.node,
+  data: PropTypes.shape({
+    color: PropTypes.string,
+  }).isRequired,
+};

package/ee/admin/pages/SettingsPage/pages/ReviewWorkflows/components/Stages/Stage/components/SingleValueColor/index.js

@@ -0,0 +1 @@
+export * from './SingleValueColor';

package/ee/admin/pages/SettingsPage/pages/ReviewWorkflows/components/Stages/Stages.js

@@ -45,11 +45,12 @@ function Stages({ stages }) {
             return (
               <Box key={`stage-${id}`} as="li">
                 <Stage
-                  {...stage}
                   id={id}
                   index={index}
                   canDelete={stages.length > 1}
                   isOpen={!stage.id}
+                  canReorder={stages.length > 1}
+                  stagesCount={stages.length}
                 />
               </Box>
             );

package/ee/admin/pages/SettingsPage/pages/ReviewWorkflows/constants.js

@@ -1,6 +1,32 @@
+import { lightTheme } from '@strapi/design-system';
+
 export const REDUX_NAMESPACE = 'settings_review-workflows';
 
 export const ACTION_SET_WORKFLOWS = `Settings/Review_Workflows/SET_WORKFLOWS`;
 export const ACTION_DELETE_STAGE = `Settings/Review_Workflows/WORKFLOW_DELETE_STAGE`;
 export const ACTION_ADD_STAGE = `Settings/Review_Workflows/WORKFLOW_ADD_STAGE`;
 export const ACTION_UPDATE_STAGE = `Settings/Review_Workflows/WORKFLOW_UPDATE_STAGE`;
+export const ACTION_UPDATE_STAGE_POSITION = `Settings/Review_Workflows/WORKFLOW_UPDATE_STAGE_POSITION`;
+
+export const STAGE_COLORS = {
+  primary600: 'Blue',
+  primary200: 'Lilac',
+  alternative600: 'Violet',
+  alternative200: 'Lavender',
+  success600: 'Green',
+  success200: 'Pale Green',
+  danger500: 'Cherry',
+  danger200: 'Pink',
+  warning600: 'Orange',
+  warning200: 'Yellow',
+  secondary600: 'Teal',
+  secondary200: 'Baby Blue',
+  neutral400: 'Gray',
+  neutral0: 'White',
+};
+
+export const STAGE_COLOR_DEFAULT = lightTheme.colors.primary600;
+
+export const DRAG_DROP_TYPES = {
+  STAGE: 'stage',
+};

package/ee/admin/pages/SettingsPage/pages/ReviewWorkflows/reducer/index.js

@@ -6,6 +6,8 @@ import {
   ACTION_DELETE_STAGE,
   ACTION_ADD_STAGE,
   ACTION_UPDATE_STAGE,
+  ACTION_UPDATE_STAGE_POSITION,
+  STAGE_COLOR_DEFAULT,
 } from '../constants';
 
 export const initialState = {
@@ -29,8 +31,18 @@ export function reducer(state = initialState, action) {
 
         draft.status = status;
 
-        if (workflows) {
-          const defaultWorkflow = workflows[0];
+        if (workflows?.length > 0) {
+          let defaultWorkflow = workflows[0];
+
+          // A safety net in case a stage does not have a color assigned;
+          // this normallly should not happen
+          defaultWorkflow = {
+            ...defaultWorkflow,
+            stages: defaultWorkflow.stages.map((stage) => ({
+              ...stage,
+              color: stage?.color ?? STAGE_COLOR_DEFAULT,
+            })),
+          };
 
           draft.serverState.workflows = workflows;
           draft.serverState.currentWorkflow = defaultWorkflow;
@@ -69,6 +81,7 @@ export function reducer(state = initialState, action) {
 
         draft.clientState.currentWorkflow.data.stages.push({
           ...payload,
+          color: payload?.color ?? STAGE_COLOR_DEFAULT,
           __temp_key__: newTempKey,
         });
 
@@ -91,6 +104,27 @@ export function reducer(state = initialState, action) {
         break;
       }
 
+      case ACTION_UPDATE_STAGE_POSITION: {
+        const {
+          currentWorkflow: {
+            data: { stages },
+          },
+        } = state.clientState;
+        const { newIndex, oldIndex } = payload;
+
+        if (newIndex >= 0 && newIndex < stages.length) {
+          const stage = stages[oldIndex];
+          let newStages = [...stages];
+
+          newStages.splice(oldIndex, 1);
+          newStages.splice(newIndex, 0, stage);
+
+          draft.clientState.currentWorkflow.data.stages = newStages;
+        }
+
+        break;
+      }
+
       default:
         break;
     }

package/ee/admin/pages/SettingsPage/pages/ReviewWorkflows/utils/colors.js

@@ -0,0 +1,33 @@
+import { lightTheme } from '@strapi/design-system';
+
+import { STAGE_COLORS } from '../constants';
+
+export function getStageColorByHex(hex) {
+  // there are multiple colors with the same hex code in the design tokens. In order to find
+  // the correct one we have to find all matching colors and then check, which ones are usable
+  // for stages.
+  const themeColors = Object.entries(lightTheme.colors).filter(([, value]) => value === hex);
+  const themeColorName = themeColors.reduce((acc, [name]) => {
+    if (STAGE_COLORS?.[name]) {
+      acc = name;
+    }
+
+    return acc;
+  }, null);
+
+  if (!themeColorName) {
+    return null;
+  }
+
+  return {
+    themeColorName,
+    name: STAGE_COLORS[themeColorName],
+  };
+}
+
+export function getAvailableStageColors() {
+  return Object.entries(STAGE_COLORS).map(([themeColorName, name]) => ({
+    hex: lightTheme.colors[themeColorName].toUpperCase(),
+    name,
+  }));
+}

package/ee/admin/pages/SettingsPage/pages/ReviewWorkflows/utils/getWorkflowValidationSchema.js

@@ -19,6 +19,15 @@ export function getWorkflowValidationSchema({ formatMessage }) {
               defaultMessage: 'Name can not be longer than 255 characters',
             })
           ),
+        color: yup
+          .string()
+          .required(
+            formatMessage({
+              id: 'Settings.review-workflows.validation.stage.color',
+              defaultMessage: 'Color is required',
+            })
+          )
+          .matches(/^#(?:[0-9a-fA-F]{3}){1,2}$/i),
       })
     ),
   });

package/ee/server/constants/workflows.js

@@ -4,5 +4,6 @@
 module.exports = {
   WORKFLOW_MODEL_UID: 'admin::workflow',
   STAGE_MODEL_UID: 'admin::workflow-stage',
+  STAGE_DEFAULT_COLOR: '#4945FF',
   ENTITY_STAGE_ATTRIBUTE: 'strapi_reviewWorkflows_stage',
 };

package/ee/server/content-types/workflow-stage/index.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const { STAGE_DEFAULT_COLOR } = require('../../constants/workflows');
+
 module.exports = {
   schema: {
     collectionName: 'strapi_workflows_stages',
@@ -24,6 +26,11 @@ module.exports = {
         type: 'string',
         configurable: false,
       },
+      color: {
+        type: 'string',
+        configurable: false,
+        default: STAGE_DEFAULT_COLOR,
+      },
       workflow: {
         type: 'relation',
         target: 'admin::workflow',

package/ee/server/controllers/authentication/middlewares.js

@@ -95,7 +95,7 @@ const redirectWithAuth = (ctx) => {
     params: { provider },
   } = ctx;
   const redirectUrls = utils.getPrefixedRedirectUrls();
-  const domain = strapi.config.get('server.admin.auth.domain');
+  const domain = strapi.config.get('admin.auth.domain');
   const { user } = ctx.state;
 
   const jwt = getService('token').createJwtToken(user);

package/ee/server/migrations/review-workflows-stages-color.js

@@ -0,0 +1,20 @@
+'use strict';
+
+const { STAGE_DEFAULT_COLOR } = require('../constants/workflows');
+
+async function migrateReviewWorkflowStagesColor({ oldContentTypes, contentTypes }) {
+  // Look for CT's color attribute
+  const hadColor = !!oldContentTypes?.['admin::workflow-stage']?.attributes?.color;
+  const hasColor = !!contentTypes['admin::workflow-stage']?.attributes?.color;
+
+  // Add the default stage color if color attribute was added
+  if (!hadColor || hasColor) {
+    await strapi.query('admin::workflow-stage').updateMany({
+      data: {
+        color: STAGE_DEFAULT_COLOR,
+      },
+    });
+  }
+}
+
+module.exports = migrateReviewWorkflowStagesColor;

package/ee/server/register.js

@@ -3,6 +3,7 @@
 const { features } = require('@strapi/strapi/lib/utils/ee');
 const executeCERegister = require('../../server/register');
 const migrateAuditLogsTable = require('./migrations/audit-logs-table');
+const migrateReviewWorkflowStagesColor = require('./migrations/review-workflows-stages-color');
 const createAuditLogsService = require('./services/audit-logs');
 const reviewWorkflowsMiddlewares = require('./middlewares/review-workflows');
 const { getService } = require('./utils');
@@ -17,6 +18,7 @@ module.exports = async ({ strapi }) => {
     await auditLogsService.register();
   }
   if (features.isEnabled('review-workflows')) {
+    strapi.hook('strapi::content-types.afterSync').register(migrateReviewWorkflowStagesColor);
     const reviewWorkflowService = getService('review-workflows');
 
     reviewWorkflowsMiddlewares.contentTypeMiddleware(strapi);