@pega/custom-dx-components 2.0.16 → 2.0.17

package/src/tasks/create/templates/Constellation/Field/Text-URL/index.jsx.mustache

@@ -1,14 +1,185 @@
-import { useState, useEffect, useRef} from "react";
-import { Input, FieldValueList, Text } from "@pega/cosmos-react-core";
+import { useState, useEffect, useRef, React} from "react";
+import { Input, FieldValueList, Text, EmailDisplay, PhoneDisplay, URLDisplay, Button, Lightbox, Image } from "@pega/cosmos-react-core";
 import PropTypes from "prop-types";
 
 // includes in bundle
-import {formatExists,textFormatter, urlFormatter, suggestionHandler} from "./text-url";
 import handleEvent from "./event-utils";
 import { suggestionsHandler } from './suggestions-handler';
 
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
 
+export const formatExists = (formatterVal) => {
+    const formatterValues = [
+      "TextInput",
+      "WorkStatus",
+      "RichText",
+      "Email",
+      "Phone",
+      "URL",
+      "Operator"
+    ];
+    let isformatter = false;
+    if (formatterValues.includes(formatterVal)) {
+      isformatter = true;
+    }
+    return isformatter;
+  };
+
+const urlLabelVal = (urlLabelSelection, btnVal, urlLabel, propUrlLabel) => {
+  if ((urlLabel !== '' || propUrlLabel !== '') && btnVal !== null) {
+    switch (urlLabelSelection) {
+      case 'constant': {
+        btnVal = urlLabel;
+        break;
+      }
+      case 'propertyRef': {
+        btnVal = propUrlLabel;
+        break;
+      }
+      // no default
+    }
+  }
+  return btnVal;
+};
+
+const isImage = (url) => /\.(jpg|jpeg|png|webp|avif|gif|svg)$/.test(url);
+
+const TableImage = (imageProps) => {
+  const { value, altText, altTextOfImage, propaltTextOfImage, urlLabelSelection, urlLabel, propUrlLabel } = imageProps;
+  const demoButtonRef = useRef(null);
+  let imageDisplayComp = null;
+  const [images, setImages] = useState(null);
+  const imgDescription = {
+    id: 'url',
+    name: urlLabelSelection === 'constant' ? urlLabel : propUrlLabel,
+    description: altText === 'constant' ? altTextOfImage : propaltTextOfImage,
+    src: value
+  };
+  const onClick = () => {
+    setImages([imgDescription]);
+  };
+  const onItemDownload = async (id) => {
+    const a = document.createElement('a');
+    a.href = await fetch(images[0].src)
+      .then((response) => {
+        return response.blob();
+      })
+      .then((blob) => {
+        return URL.createObjectURL(blob);
+      });
+    a.download = images?.find((image) => image.id === id)?.name ?? id;
+    document.body.appendChild(a);
+    a.click();
+    document.body.removeChild(a);
+  };
+  let btnVal = value;
+  btnVal = urlLabelVal(urlLabelSelection, btnVal, urlLabel, propUrlLabel);
+  imageDisplayComp = (
+    <React.Fragment>
+      {btnVal !== null && (
+        <Button ref={demoButtonRef} variant='link' compact={false} onClick={onClick} autoFocus>
+          {btnVal}
+        </Button>
+      )}
+      {images && (
+        <Lightbox
+          items={images}
+          cycle={false}
+          onAfterClose={() => {
+            setImages(null);
+            demoButtonRef.current?.focus();
+          }}
+          onItemDownload={isImage(images[0].src) ? onItemDownload : undefined}
+        />
+      )}
+    </React.Fragment>
+  );
+  return imageDisplayComp;
+};
+
+export const textFormatter = (formatter,value) => {
+  let displayComponent = null;
+  switch(formatter){
+    case "TextInput" : {
+      displayComponent = value;
+      break;
+    }
+    case "Email" : {
+      displayComponent = (<EmailDisplay value={value} displayText={value} variant="link" />);
+      break;
+    }
+    case "Phone" : {
+      displayComponent = (<PhoneDisplay value={value} variant="link" />);
+      break;
+    }
+    case "URL" : {
+      displayComponent = (<URLDisplay target="_blank" value={value} displayText={value} variant="link" />);
+      break;
+    }
+    // no default
+  }
+  return displayComponent;
+};
+
+/**
+ * Returns a URL display component based on the options
+ * @function urlFormatter
+ * @param {string} value value
+ * @param {object} options options for formatting
+ * { displayAs,tableDisplayAs,isTableFormatter,altText,altTextOfImage,propaltTextOfImage,urlLabelSelection, urlLabel,propUrlLabel, widthSel, customWidth}
+ */
+export const urlFormatter = (value, options) => {
+  const {
+    displayAs,
+    tableDisplayAs,
+    isTableFormatter,
+    altText,
+    altTextOfImage,
+    propaltTextOfImage,
+    urlLabelSelection,
+    urlLabel,
+    propUrlLabel,
+    widthSel,
+    customWidth
+  } = options;
+
+  let urlFormatComp = null;
+  if (
+    (displayAs === 'labelText' || (isTableFormatter && tableDisplayAs === 'link')) &&
+    (urlLabel !== '' || propUrlLabel !== '')
+  ) {
+    urlFormatComp = (
+      <URLDisplay
+        target='_blank'
+        value={value}
+        displayText={urlLabelSelection === 'constant' ? urlLabel : propUrlLabel}
+        variant='link'
+      />
+    );
+  } else if ((displayAs === 'Image' || tableDisplayAs === 'Image') && !!value) {
+    if (isTableFormatter) {
+      urlFormatComp = TableImage({
+        value,
+        altText,
+        altTextOfImage,
+        propaltTextOfImage,
+        urlLabelSelection,
+        urlLabel,
+        propUrlLabel
+      });
+    } else {
+      const width = widthSel === 'widthpx' ? customWidth : null;
+      urlFormatComp = (
+        <Image src={value} width={width} alt={altText === 'constant' ? altTextOfImage : propaltTextOfImage} />
+      );
+    }
+  } else {
+    urlFormatComp = <URLDisplay target='_blank' value={value} displayText={value} variant='link' />;
+  }
+  return urlFormatComp;
+};
+
+
 
 // Duplicated runtime code from Constellation Design System Component
 

package/src/tasks/create/templates/Constellation/Field/Text-URL/mock.stories.js.mustache

@@ -0,0 +1,22 @@
+export const configProps = {
+  value: '',
+  label: 'URL Sample',
+  placeholder: 'URL Placeholder',
+  helperText: 'URL Helper Text',
+  testId: 'url-12345678',
+  hasSuggestions: false
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Text',
+  maxLength: 256,
+  displayAs: 'pxURL',
+  label: 'URL sample',
+  validateAs: 'pxIsValidURL'
+};
+
+export const stateProps = {
+  value: '.URLSample',
+  hasSuggestions: false
+};

package/src/tasks/create/templates/Constellation/Field/TimeofDay/demo.stories.jsx.mustache

@@ -1,6 +1,5 @@
-import { useState } from 'react';
 import { withKnobs, text, boolean } from '@storybook/addon-knobs';
-
+import { configProps, stateProps } from './mock.stories';
 import {{COMPONENT_CLASS_NAME}} from './index.jsx';
 
 export default {
@@ -10,30 +9,39 @@ export default {
 };
 
 export const base{{COMPONENT_CLASS_NAME}} = () => {
-  const [value, setValue] = useState('test value');
-
   const props = {
     getPConnect: () => {
       return {
         getActionsApi: () => {
           return {
-            updateFieldValue: (propName, value) => {
-              setValue(value);
-            }
+            updateFieldValue: () => {},
+            triggerFieldChange: () => {}
           };
         },
         getStateProps: () => {
-          return { value: '.name' };
-        }
+          return stateProps;
+        },
+        getConfigProps: () => {
+          return configProps;
+        },
+        ignoreSuggestion: () => {},
+        clearErrorMessages: () => {}
       };
     },
-    value,
-    placeholder: text('Placeholder', 'Test placeholder'),
-    disabled: boolean('Disabled', false),
-    readOnly: boolean('Disabled', false),
-    required: boolean('Disabled', false),
-    label: text('Label', 'Sample Label'),
-    testId: text('Test id', 'text-12344566')
+    value: configProps.value,
+    validatemessage: configProps.validatemessage,
+    label: configProps.label,
+    hideLabel: configProps.hideLabel,
+    helperText: configProps.helperText,
+    withSeconds: configProps.withSeconds,
+    testId: configProps.testId,
+    additionalProps: configProps.additionalProps,
+    displayMode: configProps.displayMode,
+    variant: configProps.variant,
+    hasSuggestions: configProps.hasSuggestions,
+    disabled: configProps.disabled,
+    readOnly: configProps.readOnly,
+    required: configProps.required
   };
 
   return (

package/src/tasks/create/templates/Constellation/Field/TimeofDay/mock.stories.js.mustache

@@ -0,0 +1,20 @@
+export const configProps = {
+  value: '13:30',
+  validatemessage: '',
+  label: 'TimeOfDay Label',
+  hideLabel: false,
+  helperText: 'TimeOfDay helper text',
+  withSeconds: false,
+  testId: '12345678',
+  additionalProps: {},
+  displayMode: '',
+  variant: '',
+  hasSuggestions: false,
+  readOnly: false,
+  required: false,
+  disabled: false
+};
+
+export const stateProps = {
+  value: '.TimeOfDayLabel'
+};

package/src/tasks/create/templates/Constellation/Field/TimeofDay/time-of-day.js.mustache

@@ -1,3 +1,4 @@
+/* eslint-disable no-undef */
 import dayjs from "dayjs";
 
 const relativeTime = require("dayjs/plugin/relativeTime");

package/src/tasks/create/templates/Constellation/Template/DETAILS/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/demo.stories.jsx.mustache

@@ -0,0 +1,110 @@
+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);
+  });
+
+  return <{{COMPONENT_CLASS_NAME}} {...args}>{regionAChildren}</{{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/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
 };

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: 'conns',
+          userName: 'Sara Connor'
+        },
+        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'
+  }
+];