@pega/custom-dx-components 2.0.11 → 2.0.13

package/src/tasks/create/templates/Constellation/Template/DETAILS/mock.stories.js.mustache

@@ -0,0 +1,179 @@
+export const pyReviewRaw = {
+  name: 'pyReview',
+  type: 'View',
+  config: {
+    template: 'Details',
+    ruleClass: 'MyCo-MyCompon-Work-MyComponents',
+    showLabel: true,
+    label: '@L Details',
+    localeReference: '@LR MYCO-MYCOMPON-WORK-MYCOMPONENTS!VIEW!PYREVIEW',
+    showHighlightedData: true,
+    highlightedData: [
+      {
+        type: 'TextInput',
+        config: {
+          value: '@P .pyStatusWork',
+          label: '@L Work Status',
+          displayMode: 'STACKED_LARGE_VAL',
+          displayAsStatus: true
+        }
+      },
+      {
+        type: 'TextInput',
+        config: {
+          value: '@P .pyID',
+          label: '@L Case ID',
+          displayMode: 'STACKED_LARGE_VAL'
+        }
+      },
+      {
+        type: 'DateTime',
+        config: {
+          value: '@P .pxCreateDateTime',
+          label: '@L Create date/time',
+          displayMode: 'STACKED_LARGE_VAL'
+        }
+      },
+      {
+        type: 'UserReference',
+        config: {
+          label: '@L Create Operator',
+          value: '@USER .pxCreateOperator',
+          placeholder: 'Select...',
+          displayMode: 'STACKED_LARGE_VAL'
+        }
+      }
+    ],
+    inheritedProps: [
+      {
+        prop: 'label',
+        value: '@L Details'
+      },
+      {
+        prop: 'showLabel',
+        value: true
+      }
+    ]
+  },
+  children: [
+    {
+      name: 'A',
+      type: 'Region',
+      getPConnect: () => {
+        return {
+          getRawMetadata: () => {
+            return pyReviewRaw.children[0];
+          }
+        };
+      },
+      children: [
+        {
+          type: 'DateTime',
+          config: {
+            value: '@P .pySLADeadline',
+            label: '@L SLA Deadline'
+          }
+        },
+        {
+          type: 'DateTime',
+          config: {
+            value: '@P .pySLAGoal',
+            label: '@L SLA Goal'
+          }
+        },
+        {
+          type: 'RadioButtons',
+          config: {
+            value: '@P .pySLAStartTime',
+            label: '@L SLA Start Time',
+            listType: 'associated',
+            datasource: '@ASSOCIATED .pySLAStartTime'
+          }
+        }
+      ]
+    }
+  ],
+  classID: 'MyCo-MyCompon-Work-MyComponents'
+};
+
+export const pyReviewResolved = {
+  readOnly: true,
+  template: 'Details',
+  ruleClass: 'MyCo-MyCompon-Work-MyComponents',
+  showLabel: true,
+  label: 'Details',
+  localeReference: 'MYCO-MYCOMPON-WORK-MYCOMPONENTS!VIEW!PYREVIEW',
+  showHighlightedData: true,
+  highlightedData: [
+    {
+      type: 'TextInput',
+      config: {
+        value: 'New',
+        label: 'Work Status',
+        displayMode: 'STACKED_LARGE_VAL',
+        displayAsStatus: true
+      }
+    },
+    {
+      type: 'TextInput',
+      config: {
+        value: 'M-1002',
+        label: 'Case ID',
+        displayMode: 'STACKED_LARGE_VAL'
+      }
+    },
+    {
+      type: 'DateTime',
+      config: {
+        value: '2022-12-11T20:06:27.232Z',
+        label: 'Create date/time',
+        displayMode: 'STACKED_LARGE_VAL'
+      }
+    },
+    {
+      type: 'UserReference',
+      config: {
+        label: 'Create Operator',
+        value: {
+          userId: 'riddn',
+          userName: 'Niall Riddell'
+        },
+        placeholder: 'Select...',
+        displayMode: 'STACKED_LARGE_VAL'
+      }
+    }
+  ],
+  displayMode: 'LABELS_LEFT'
+};
+
+export const regionChildrenResolved = [
+  {
+    readOnly: true,
+    value: '',
+    label: 'SLA Deadline',
+    displayMode: 'LABELS_LEFT'
+  },
+  {
+    readOnly: true,
+    value: '',
+    label: 'SLA Goal',
+    displayMode: 'LABELS_LEFT'
+  },
+  {
+    readOnly: true,
+    value: '',
+    label: 'SLA Start Time',
+    listType: 'associated',
+    datasource: [
+      {
+        key: 'AssignmentCreation',
+        value: 'The creation time of the Assignment'
+      },
+      {
+        key: 'CurrentTime',
+        value: 'Current Date Time'
+      }
+    ],
+    displayMode: 'LABELS_LEFT'
+  }
+];

package/src/tasks/create/templates/Constellation/Template/DETAILS/utils.js.mustache

@@ -1,8 +1,4 @@
-import { createUID } from '@pega/cosmos-react-core';
-
-//import { LazyMap as LazyComponentMap } from '../../components_map';
-
-const LazyComponentMap = {};
+/* eslint-disable no-undef */
 
 /**
  * Given the PConnect object of a Template component, retrieve the children
@@ -43,78 +39,7 @@ export function getAllFields(pConnect) {
   return allFields;
 }
 
-/**
- * A helper function to create an object consisting react component as per the type.
- * This is used by CaseSummary template.
- * @param {object} configObject Object containing meta information for the particular field authored
- * @param {Function} getPConnect PConnect function passed along to other components.
- * @param {string} displayMode displayMode string contains information about the layout of component in review mode.
- */
-export function prepareComponentInCaseSummary(configObject, getPConnect, displayMode) {
-  const { config, children } = configObject;
-  let { type } = configObject;
-  const caseSummaryComponentObject = {};
-  let showAddressLabel = true;
-  if (config && config.value === '@P .pyStatusWork') {
-    config.displayAsStatus = true;
-    type = 'TextInput'; // force the type to be TextInput for status field.
-    // As TextInput is loaded forcefully sometimes, TextInput component might not be available in lazy map.
-    // Load TextInput if it is not available.
-    if (!LazyComponentMap[type]) {
-      PCore.getAssetLoader().getLoader('component-loader')([type]);
-    }
-  }
-
-  caseSummaryComponentObject.name = getPConnect().resolveConfigProps({
-    label: config.label
-  }).label;
-  if (type === 'CaseOperator') {
-    switch (caseSummaryComponentObject.name) {
-      case 'Create operator':
-        caseSummaryComponentObject.name = getPConnect().resolveConfigProps({
-          createLabel: config.createLabel
-        }).createLabel;
-        break;
-      case 'Update operator':
-        caseSummaryComponentObject.name = getPConnect().resolveConfigProps({
-          updateLabel: config.updateLabel
-        }).updateLabel;
-        break;
-      default:
-        caseSummaryComponentObject.name = getPConnect().resolveConfigProps({
-          resolveLabel: config.resolveLabel
-        }).resolveLabel;
-        break;
-    }
-  } else if (type === 'Checkbox') {
-    caseSummaryComponentObject.name = getPConnect().resolveConfigProps({
-      label: config.caption
-    }).label;
-  } else if (type === 'Address') {
-    showAddressLabel = false;
-  }
-  const createdComponent = getPConnect().createComponent({
-    type,
-    children: children ? [...children] : [],
-    showAddressLabel,
-    config: {
-      ...config,
-      hideLabel: true,
-      key: createUID() // Need a unique key on render of the summary so that the component is recreated each time
-    }
-  });
-  createdComponent.props.getPConnect().setInheritedProp('displayMode', displayMode);
-  if (type === 'Address') {
-    createdComponent.props.getPConnect().setInheritedProp('showAddressLabel', showAddressLabel);
-  }
-  // createdComponent.props.getPConnect().setInheritedProp("hideLabel", true);
-  caseSummaryComponentObject.value = createdComponent;
-  if (type === 'reference') {
-    caseSummaryComponentObject.name = createdComponent.props.getPConnect().getInheritedProps().label;
-  }
 
-  return caseSummaryComponentObject;
-}
 
 export function getFilteredFields(getPConnect) {
   let primaryFieldsRaw;
@@ -212,8 +137,9 @@ export function getInstructions(pConnect, instructions = 'casestep') {
 
   // If the annotation wasn't processed correctly, don't return any instruction text
   if (instructions?.startsWith('@PARAGRAPH')) {
+     /* eslint-disable no-console */
     console.error('@PARAGRAPH annotation was not processed. Hiding custom instructions.');
-    return undefined;
+    /* eslint-enable no-console */    return undefined;
   }
 
   // Custom instructions from the view

package/src/tasks/create/templates/Constellation/Template/DETAILS-region/StatusWork.jsx.mustache

@@ -0,0 +1,26 @@
+import { Status } from "@pega/cosmos-react-core";
+
+export default function StatusWorkRenderer({ value }) {
+  let variant = "info";
+
+  const warnStrings = ["fail", "cancel", "reject", "revoke", "stopped", "warn"];
+  const infoStrings = ["open", "hold", "info", "new"];
+  const successStrings = ["resolved", "completed", "success"];
+  const pendingStrings = ["pending"];
+
+  if (new RegExp(warnStrings.join("|"), "i").test(value)) {
+    variant = "warn";
+  } else if (new RegExp(infoStrings.join("|"), "i").test(value)) {
+    variant = "info";
+  } else if (new RegExp(successStrings.join("|"), "i").test(value)) {
+    variant = "success";
+  } else if (new RegExp(pendingStrings.join("|"), "i").test(value)) {
+    variant = "pending";
+  }
+
+  return (
+    <Status type="rectangle" variant={variant}>
+      {value}
+    </Status>
+  );
+}

package/src/tasks/create/templates/Constellation/Template/DETAILS-region/demo.stories.jsx.mustache

@@ -0,0 +1,118 @@
+import { Text, FieldValueList, Button, DateTimeDisplay, useTheme } from '@pega/cosmos-react-core';
+import {{COMPONENT_CLASS_NAME}} from './index';
+import { pyReviewRaw, pyReviewResolved, regionChildrenResolved } from './mock.stories';
+import StatusWorkRenderer from './StatusWork.jsx';
+
+export default {
+  title: '{{COMPONENT_CLASS_NAME}}',
+  component: {{COMPONENT_CLASS_NAME}}
+};
+
+const Template = args => {
+  const regionAChildren = pyReviewRaw.children[0].children.map(child => {
+    return Primary.args.getPConnect().createComponent(child);
+  });
+  const regionBChildren = pyReviewRaw.children[1].children.map(child => {
+    return Primary.args.getPConnect().createComponent(child);
+  });
+
+  return (
+    <{{COMPONENT_CLASS_NAME}} {...args}>
+      {regionAChildren}
+      {regionBChildren}
+    </{{COMPONENT_CLASS_NAME}}>
+  );
+};
+
+export const Primary = Template.bind({});
+
+Primary.args = {
+  template: 'MyCo_MyComponents_NewDetailsTemplate',
+  showHighlightedData: true,
+  label: 'Test Details',
+  showLabel: true,
+  getPConnect: () => {
+    return {
+      getChildren: () => {
+        return pyReviewRaw.children;
+      },
+      getRawMetadata: () => {
+        return pyReviewRaw;
+      },
+      getInheritedProps: () => {
+        return pyReviewRaw.config.inheritedProps;
+      },
+      createComponent: config => {
+        switch (config.config.value) {
+          case '@P .pyStatusWork':
+            return renderField(pyReviewResolved.highlightedData[0].config);
+          case '@P .pyID':
+            return renderField(pyReviewResolved.highlightedData[1].config);
+          case '@P .pxCreateDateTime':
+            return renderField(pyReviewResolved.highlightedData[2].config);
+          case '@USER .pxCreateOperator':
+            return renderField(pyReviewResolved.highlightedData[3].config);
+          case '@P .pySLADeadline':
+            return renderField(regionChildrenResolved[0]);
+          case '@P .pySLAGoal':
+            return renderField(regionChildrenResolved[1]);
+          case '@P .pySLAStartTime':
+            return renderField(regionChildrenResolved[2]);
+        }
+      },
+      setInheritedProp: () => {},
+      resolveConfigProps: () => {}
+    };
+  }
+};
+
+const renderField = resolvedProps => {
+  const {
+    displayAsStatus = false,
+    displayMode,
+    value = '',
+    label = '',
+    theme = useTheme()
+  } = resolvedProps;
+
+  const variant = displayMode === 'LABELS_LEFT' ? 'inline' : 'stacked';
+
+  let val =
+    value != '' ? (
+      <Text variant='h1' as='span'>
+        {value}
+      </Text>
+    ) : (
+      ''
+    );
+
+  if (label === 'Create date/time')
+    val = <DateTimeDisplay value={value} variant='datetime' format='long' clockFormat={null} />;
+
+  if (displayAsStatus === true) val = <StatusWorkRenderer value={value} />;
+
+  if (label === 'Create Operator')
+    val = (
+      <Button
+        variant='link'
+        style={
+          label !== null
+            ? { width: 'max-content', height: theme.components.input.height }
+            : undefined
+        }
+      >
+        {value.userName}
+      </Button>
+    );
+
+  if (variant === 'inline') {
+    val = value || <span aria-hidden='true'>&ndash;&ndash;</span>;
+  } else {
+    val = (
+      <Text variant='h1' as='span'>
+        {val}
+      </Text>
+    );
+  }
+  return <FieldValueList variant={variant} fields={[{ name: label, value: val }]} />;
+};

package/src/tasks/create/templates/Constellation/Template/DETAILS-region/index.jsx.mustache

@@ -1,5 +1,5 @@
-import { useContext, Fragment } from 'react';
-import { Grid , Flex, FieldGroup } from '@pega/cosmos-react-core';
+import { Fragment } from 'react';
+import { Grid, Flex, FieldGroup } from '@pega/cosmos-react-core';
 import PropTypes from 'prop-types';
 
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
@@ -13,13 +13,19 @@ import { getAllFields } from './utils';
 // any default values in config.pros should be set in defaultProps at bottom of this file
 export default function {{COMPONENT_CLASS_NAME}}(props) {
 
-
-  const { getPConnect, children, template, regionsMetadata = [], label, showLabel, showHighlightedData  } = props;
-
+  const { getPConnect, children, label, showLabel, showHighlightedData  } = props;
   const propsToUse = { label, showLabel, ...getPConnect().getInheritedProps() };
 
+  const numRegions = getAllFields(getPConnect)?.length;
+  const gridRepeat = "repeat(".concat(numRegions).concat(", 1fr)");
+  const gridContainer = { "colGap": 1};
+  gridContainer.cols = gridRepeat;
+  gridContainer.alignItems = 'start';
 
-  const numRegions = regionsMetadata.length;
+  const gridHighlightContainer = { "gap": 2};
+  gridHighlightContainer.cols = gridRepeat;
+  gridHighlightContainer.alignItems = 'start';
+  gridHighlightContainer.pad = [0, 0, 2, 0];
 
   // Set up highlighted data to pass in return if is set to show, need raw metadata to pass to createComponent
   let highlightedDataArr = [];
@@ -44,14 +50,14 @@ export default function {{COMPONENT_CLASS_NAME}}(props) {
     {{=<% %>=}}
     <FieldGroup name={propsToUse.showLabel ? propsToUse.label : ''}>
       {showHighlightedData && highlightedDataArr.length > 0 && (
-        <Grid container={{ cols:'repeat(${numRegions}, 1fr)', gap: 2, alignItems: 'start',  pad: [0, 0, 2, 0] }}
+        <Grid container={gridHighlightContainer}
           data-testid={`highlighted-column-count-${numRegions}`}>
           {highlightedDataArr.map((child, i) => (
             <Fragment key={`hf-${i + 1}`}>{child}</Fragment>
           ))}
         </Grid>
       )}
-      <Grid container={{ cols:'repeat(${numRegions}, 1fr)', alignItems: 'start', colGap: 1 }} data-testid={`column-count-${numRegions}`} >
+      <Grid container={gridContainer} data-testid={`column-count-${numRegions}`} >
        {children.map((child, i) => (
         <Flex container={{ direction: 'column'}} key={`r-${i + 1}`}>
         {child}
@@ -71,31 +77,10 @@ export default function {{COMPONENT_CLASS_NAME}}(props) {
   showHighlightedData: false
 };
 
-// Since the fields are not part of the 'config' in Details template metadata, they need to be subscribed with additionalprops
-const mapStateToProps = (_, ownProps) => {
-  const { getPConnect, showLabel, label } = ownProps;
-  const Allfields = getAllFields(getPConnect);
-
-  return {
-    regionsMetadata: Allfields,
-    label,
-    showLabel,
-    getPConnect
-  };
-};
 
 {{COMPONENT_CLASS_NAME}}.propTypes = {
-  regionsMetadata: PropTypes.arrayOf(
-    PropTypes.arrayOf(
-      PropTypes.shape({
-        value: PropTypes.oneOfType([PropTypes.bool, PropTypes.string, PropTypes.number]),
-        label: PropTypes.string
-      })
-    )
-  ).isRequired,
   showLabel: PropTypes.bool,
   label: PropTypes.string,
   getPConnect: PropTypes.func.isRequired,
-  template: PropTypes.string.isRequired,
   showHighlightedData: PropTypes.bool
 };