@pega/custom-dx-components 2.0.8 → 2.0.10

package/src/tasks/create/templates/Constellation/Widget/PAGE/index.jsx.mustache

@@ -0,0 +1,48 @@
+import PropTypes from 'prop-types';
+import { AppAnnouncement as PegaAppAnnouncement } from '@pega/cosmos-react-work';
+
+import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
+
+
+// Duplicated runtime code from Constellation Design System Component
+
+// props passed in combination of props from property panel (config.json) and run time props from Constellation
+// any default values in config.pros should be set in defaultProps at bottom of this file
+export default function {{COMPONENT_CLASS_NAME}}(props) {
+
+  const { header, description, datasource, whatsnewlink, image } = props;
+  let details = [];
+  if (datasource && datasource.source) {
+    details = datasource.source.map((item) => {
+      return item.name;
+    });
+  }
+  return (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    <PegaAppAnnouncement
+      heading={header}
+      description={description}
+      details={details}
+      whatsNewLink={whatsnewlink}
+      image={image.replace(/ /g, '+')}
+    />
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  );
+
+}
+
+{{COMPONENT_CLASS_NAME}}.defaultProps = {
+  header: PropTypes.string,
+  description: PropTypes.string,
+  datasource: PropTypes.instanceOf(Object),
+  whatsnewlink: PropTypes.string,
+  image: PropTypes.string
+};
+
+{{COMPONENT_CLASS_NAME}}.propTypes = {
+  header: '',
+  description: '',
+  image: '',
+  datasource: [],
+  whatsnewlink: ''
+};

package/src/tasks/create/templates/Constellation/Widget/PAGE/styles.js.mustache

@@ -0,0 +1,7 @@
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 8px 0;
+  `;
+});

package/src/tasks/create/templates/Constellation/Widget/PAGE-CASE/Avatar.js.mustache

@@ -0,0 +1,73 @@
+import { useEffect, useState } from 'react';
+import PropTypes from 'prop-types';
+import { Avatar as CosmosAvatar } from '@pega/cosmos-react-core';
+
+function Avatar(props) {
+  const { metaObj, showStatus } = props;
+  const [imageBlobUrl, setImageBlobUrl] = useState(null);
+  let userName;
+  let userIdentifier;
+
+  // TODO Below if conditions can be removed once we have apis to get worklist/mywork info
+  // This is non CaseView case (Dashboard, MyWork etc)
+  if (!metaObj) {
+    userName = PCore.getEnvironmentInfo().getOperatorName();
+    userIdentifier = PCore.getEnvironmentInfo().getOperatorIdentifier();
+  } else {
+    userName = metaObj.name;
+    userIdentifier = metaObj.ID;
+  }
+  if (!userName && userIdentifier) {
+    userName = userIdentifier;
+  }
+
+  useEffect(() => {
+    const imageKey = !metaObj ? PCore.getEnvironmentInfo().getOperatorImageInsKey() : metaObj.image;
+    if (imageKey) {
+      PCore.getAssetLoader()
+        .getSvcImage(imageKey)
+        .then((blob) => window.URL.createObjectURL(blob))
+        .then((imagePath) => setImageBlobUrl(imagePath));
+    }
+  }, []);
+
+  if (showStatus) {
+    const currentState = PCore.getMessagingServiceManager().getUserPresence().getUserState(userIdentifier);
+    const [userState, setUserState] = useState(currentState === 'online' ? 'active' : 'inactive');
+
+    const handleUserStateChange = ({ state }) => {
+      setUserState(state === 'online' ? 'active' : 'inactive');
+    };
+
+    useEffect(() => {
+      const subId = PCore.getMessagingServiceManager()
+        .getUserPresence()
+        .subscribe(userIdentifier, handleUserStateChange);
+
+      return function cleanup() {
+        PCore.getMessagingServiceManager().getUserPresence().unsubscribe(userIdentifier, subId);
+      };
+    }, []);
+    return <CosmosAvatar name={userName} imageSrc={imageBlobUrl} status={userState} />;
+  }
+
+  // Do not render when userName does not exists
+  // TODO : In CNR case, pxRequestor is not available, please remove this condition once it populates
+  if (!userName) {
+    return null;
+  }
+
+  return <CosmosAvatar name={userName} imageSrc={imageBlobUrl} />;
+}
+
+Avatar.propTypes = {
+  metaObj: PropTypes.objectOf(PropTypes.any),
+  showStatus: PropTypes.bool
+};
+
+Avatar.defaultProps = {
+  metaObj: null,
+  showStatus: false
+};
+
+export default Avatar;

package/src/tasks/create/templates/Constellation/Widget/PAGE-CASE/OneColumnPage.svg

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="100px" height="70px" viewBox="0 0 100 70" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>1 col </title>
+    <defs>
+        <rect id="path-1" x="0" y="0" width="100" height="70"></rect>
+    </defs>
+    <g id="Concepts" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="Templates" transform="translate(-98.000000, -108.000000)">
+            <g id="Change-template" transform="translate(42.000000, 36.000000)">
+                <g id="1-col-" transform="translate(56.000000, 72.000000)">
+                    <mask id="mask-2" fill="white">
+                        <use xlink:href="#path-1"></use>
+                    </mask>
+                    <rect stroke="#A5A8BC" stroke-width="0.5" x="0.25" y="0.25" width="99.5" height="69.5"></rect>
+                    <g id="white" mask="url(#mask-2)" fill="#FFFFFF">
+                        <g transform="translate(3.000000, 3.000000)" id="Rectangle">
+                            <rect x="0" y="0" width="94" height="66.5"></rect>
+                        </g>
+                    </g>
+                    <g id="gray" mask="url(#mask-2)" fill="#8084A7">
+                        <g transform="translate(6.000000, 6.000000)" id="Rectangle">
+                            <rect x="0" y="-2.84217094e-14" width="88" height="77.8"></rect>
+                        </g>
+                    </g>
+                    <g id="labels" mask="url(#mask-2)" font-family="OpenSans-Semibold, Open Sans" font-size="11" font-weight="500">
+                        <g transform="translate(44.000000, 17.000000)" id="A">
+                            <text>
+                                <tspan x="0.75" y="12" fill="#FFFFFF">A</tspan>
+                            </text>
+                        </g>
+                    </g>
+                </g>
+            </g>
+        </g>
+    </g>
+</svg>

package/src/tasks/create/templates/Constellation/Widget/PAGE-CASE/Operator.js.mustache

@@ -0,0 +1,239 @@
+import { useState, useEffect, Fragment } from 'react';
+import {
+  Link,
+  Button,
+  Popover,
+  Flex,
+  useOuterEvent,
+  useElement,
+  Progress,
+  FormField,
+  useTheme
+} from '@pega/cosmos-react-core';
+import { Glimpse } from '@pega/cosmos-react-work';
+import PropTypes from 'prop-types';
+
+import Avatar from './Avatar';
+
+const Operator = (props) => {
+  const { id, name, label, testId, helperText, externalUser, metaObj } = props;
+  const [isOpen, setIsOpen] = useState(false);
+  const [isLoading, setIsLoading] = useState(true);
+  const [popoverTarget, setPopoverTarget] = useState(null);
+  const [popoverEl, setPopoverEl] = useElement(null);
+  const [popoverContent, setpopoverContent] = useState(null);
+  const theme = useTheme();
+
+  /* If the id has changed, we need to reset the popover */
+  useEffect(() => {
+    setPopoverTarget(null);
+  }, [id]);
+
+
+  {{! pick new delimiteres for mustache }}
+  {{=<% %>=}}
+
+  const OperatorPreview = () => {
+    const localizedVal = PCore.getLocaleUtils().getLocaleValue;
+    const localeCategory = 'Operator';
+    setpopoverContent(
+      <Progress variant='ring' message={localizedVal('Loading operator...', localeCategory)} placement='local' />
+    );
+    if (externalUser && externalUser.classID !== 'Data-Party-Operator') {
+      const fields = [
+        {
+          id: 'pyFirstName',
+          name: localizedVal('Name', localeCategory),
+          value: externalUser.name
+        },
+        {
+          id: 'pyEmail1',
+          name: localizedVal('Email', localeCategory),
+          value:
+            externalUser.email !== '' ? <Link href={`mailto:${externalUser.email}`}>{externalUser.email}</Link> : ''
+        },
+        {
+          id: 'pyPhoneNumber',
+          name: localizedVal('Phone', localeCategory),
+          value: externalUser.phone !== '' ? <Link href={`tel:${externalUser.phone}`}>{externalUser.phone}</Link> : ''
+        }
+      ];
+      setIsLoading(false);
+      setpopoverContent(
+        <Glimpse
+          visual={
+            <Avatar
+              metaObj={{
+                name: externalUser.name
+              }}
+            />
+          }
+          primary={externalUser.name}
+          secondary={[externalUser.position]}
+          fields={fields}
+        />
+      );
+    } else {
+      const { getOperatorDetails } = PCore.getUserApi();
+      getOperatorDetails(id)
+        .then((res) => {
+          if (res.data && res.data.pyOperatorInfo && res.data.pyOperatorInfo.pyUserName) {
+            const fields = [
+              {
+                id: 'pyOrganization',
+                name: localizedVal('Organization', localeCategory),
+                value: res.data.pyOperatorInfo.pyOrganization
+              },
+              {
+                id: 'pyTelephone',
+                name: localizedVal('Telephone', localeCategory),
+                value:
+                  res.data.pyOperatorInfo.pyTelephone !== '' ? (
+                    <Link href={`tel:${res.data.pyOperatorInfo.pyTelephone}`}>
+                      {res.data.pyOperatorInfo.pyTelephone}
+                    </Link>
+                  ) : (
+                    ''
+                  )
+              },
+              {
+                id: 'pyEmailAddress',
+                name: localizedVal('Email address', localeCategory),
+                value:
+                  res.data.pyOperatorInfo.pyEmailAddress !== '' ? (
+                    <Link href={`mailto:${res.data.pyOperatorInfo.pyEmailAddress}`}>
+                      {res.data.pyOperatorInfo.pyEmailAddress}
+                    </Link>
+                  ) : (
+                    ''
+                  )
+              },
+              {
+                id: 'ReportToUserName',
+                name: localizedVal('Reports to', localeCategory),
+                value: res.data.pyOperatorInfo.pyReportToUserName
+              }
+            ];
+            setIsLoading(false);
+            setpopoverContent(
+              <Glimpse
+                visual={
+                  <Avatar
+                    metaObj={{
+                      image: res.data.pyOperatorInfo.pyImageInsKey || '',
+                      name: res.data.pyOperatorInfo.pyUserName
+                    }}
+                  />
+                }
+                primary={res.data.pyOperatorInfo.pyUserName}
+                secondary={[res.data.pyOperatorInfo.pyPosition]}
+                fields={fields}
+              />
+            );
+          } else {
+            setIsLoading(false);
+            setpopoverContent(<Flex container={{ pad: 1 }}>{localizedVal('Operator not found', localeCategory)}</Flex>);
+          }
+        })
+        .catch(() => {
+          setIsLoading(false);
+          setpopoverContent(
+            <Flex container={{ pad: 1 }}>{localizedVal('Error loading the operator profile', localeCategory)}</Flex>
+          );
+        });
+    }
+  };
+
+  <%={{ }}=%>     {{! revert delimiteres for mustache }}
+
+  const clickAction = (e) => {
+    setPopoverTarget(e.currentTarget);
+    setIsOpen(!isOpen);
+    if (popoverTarget === null) {
+      OperatorPreview();
+    }
+  };
+
+  const hidePopover = () => {
+    if (isOpen) {
+      setIsOpen(false);
+    }
+  };
+  useOuterEvent('mousedown', [popoverEl, popoverTarget], hidePopover); // Call the method on clicking outside these elements
+  const hideOnEscape = (e) => {
+    if (e.key === 'Escape') hidePopover(); // Call the method when Escape key is pressed
+  };
+
+  const comp = (
+    <Fragment>
+      {metaObj ? (
+        <Button
+          variant='text'
+          aria-haspopup
+          aria-expanded={isOpen}
+          onClick={clickAction}
+          onKeyDown={hideOnEscape}
+          data-test-id={testId}
+          style={label !== null ? { width: 'max-content', height: theme.components.input.height } : undefined}
+        >
+          <Avatar metaObj={metaObj}></Avatar>
+        </Button>
+      ) : (
+        <Button
+          variant='link'
+          aria-haspopup
+          aria-expanded={isOpen}
+          onClick={clickAction}
+          onKeyDown={hideOnEscape}
+          data-test-id={testId}
+          style={label !== null ? { width: 'max-content', height: theme.components.input.height } : undefined}
+        >
+          {name}
+        </Button>
+      )}
+
+      {isOpen && (
+        <Popover
+          ref={setPopoverEl}
+          groupId='operator'
+          target={popoverTarget}
+          placement='bottom-start'
+          style={isLoading ? { position: 'relative', width: '10rem', minHeight: '4rem' } : undefined}
+          strategy='fixed'
+        >
+          {popoverContent}
+        </Popover>
+      )}
+    </Fragment>
+  );
+
+  if (label !== null) {
+    return (
+      <FormField label={label} info={helperText}>
+        {comp}
+      </FormField>
+    );
+  }
+
+  return comp;
+};
+
+Operator.propTypes = {
+  name: PropTypes.string,
+  id: PropTypes.string,
+  label: PropTypes.string,
+  testId: PropTypes.string,
+  helperText: PropTypes.string,
+  metaObj: PropTypes.object
+};
+
+Operator.defaultProps = {
+  name: '',
+  id: '',
+  label: null,
+  testId: null,
+  helperText: null,
+  metaObj: null
+};
+
+export default Operator;

package/src/tasks/create/templates/Constellation/Widget/PAGE-CASE/config.json.mustache

@@ -0,0 +1,66 @@
+{
+  "name": "{{COMPONENT_KEY}}",
+  "label": "{{COMPONENT_LABEL}}",
+  "description": "{{DESCRIPTION}}",
+  "organization": "{{ORGANIZATION}}",
+  "version": "{{VERSION}}",
+  "library": "{{LIBRARY}}",
+  "allowedApplications": {{{ALLOWEDAPPS}}},
+  "componentKey": "{{COMPONENT_KEY}}",
+  "type": "{{TYPE}}",
+  "subtype": {{{SUB_TYPE}}},
+  "icon": "OneColumnPage.svg",
+   "properties": [
+    {
+      "name": "title",
+      "label": "Label value",
+      "format": "TEXT"
+    },
+    {
+      "format": "SELECT",
+      "label": "Usage",
+      "name": "label",
+      "defaultValue": "Create operator",
+      "localize": true,
+      "source": [
+        {
+          "key": "Create operator",
+          "value": "Create operator"
+        },
+        {
+          "key": "Update operator",
+          "value": "Update operator"
+        },
+        {
+          "key": "Resolve operator",
+          "value": "Resolve operator"
+        }
+      ]
+    },
+
+    {
+      "label": "Conditions",
+      "format": "GROUP",
+      "properties": [
+        {
+          "name": "visibility",
+          "label": "Visibility",
+          "format": "VISIBILITY"
+        }
+      ]
+    }
+  ],
+  "defaultConfig": {
+    "label": "Create operator",
+    "title": "Create operator",
+    "createLabel": "@L Created",
+    "updateLabel": "@L Updated",
+    "createOperator": "@USER .pxCreateOperator",
+    "updateOperator": "@USER .pxUpdateOperator",
+    "createDateTime": "@P .pxCreateDateTime",
+    "updateDateTime": "@P .pxUpdateDateTime",
+    "resolveLabel": "@L Resolved",
+    "resolveOperator": "@USER .pyResolvedUserID",
+    "resolveDateTime": "@P .pyResolvedTimestamp"
+  }
+}

package/src/tasks/create/templates/Constellation/Widget/PAGE-CASE/index.jsx.mustache

@@ -0,0 +1,110 @@
+import { Fragment, memo } from 'react';
+import { DateTimeDisplay, Card, CardHeader, CardContent, Flex } from '@pega/cosmos-react-core';
+import PropTypes from 'prop-types';
+
+// includes in bundle
+import Operator from './Operator';
+
+import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
+
+
+// Duplicated runtime code from Constellation Design System Component
+
+// props passed in combination of props from property panel (config.json) and run time props from Constellation
+// 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,
+    title,
+    label,
+    createLabel,
+    updateLabel,
+    createOperator,
+    updateOperator,
+    createDateTime,
+    updateDateTime,
+    resolveLabel,
+    resolveOperator,
+    resolveDateTime,
+    hideLabel,
+    defVal
+  } = props;
+
+
+  const [_label, user, dateTimeValue] =
+    label === 'Create operator'
+      ? [createLabel, createOperator, createDateTime]
+      : label === 'Update operator'
+      ? [updateLabel, updateOperator, updateDateTime]
+      : [resolveLabel, resolveOperator, resolveDateTime];
+
+
+
+  return user.userId && user.userName ? (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+      <Card>
+      <CardHeader>{title}</CardHeader>
+      <CardContent>
+{{! pick new delimiteres for mustache }} {{=<% %>=}}
+      <Flex container={{ direction: 'row'}}>
+      <Operator label={hideLabel ? null : _label} name={user.userName} id={user.userId} getPConnect={getPConnect} />
+
+<%={{ }}=%>     {{! revert delimiteres for mustache }}
+      {dateTimeValue && (
+        <Fragment>
+          {' '}
+          <DateTimeDisplay value={dateTimeValue} variant='relative' />
+        </Fragment>
+      )}
+      </Flex>
+      </CardContent>
+      </Card>
+
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  ) : (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    defVal
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  );
+
+
+
+}
+
+{{COMPONENT_CLASS_NAME}}.defaultProps = {
+  "label": "Create operator",
+  "title": "Create operator",
+  createLabel: null,
+  updateLabel: null,
+  createOperator: null,
+  updateOperator: null,
+  createDateTime: null,
+  updateDateTime: null,
+  resolveLabel: null,
+  resolveOperator: null,
+  resolveDateTime: null,
+  hideLabel: false,
+  defVal: '––'
+};
+
+{{COMPONENT_CLASS_NAME}}.propTypes = {
+  getPConnect: PropTypes.func.isRequired,
+  label: PropTypes.string,
+  createLabel: PropTypes.string,
+  updateLabel: PropTypes.string,
+  resolveLabel: PropTypes.string,
+  createOperator: PropTypes.objectOf(PropTypes.any),
+  updateOperator: PropTypes.objectOf(PropTypes.any),
+  resolveOperator: PropTypes.objectOf(PropTypes.any),
+  createDateTime: PropTypes.string,
+  updateDateTime: PropTypes.string,
+  resolveDateTime: PropTypes.string,
+  hideLabel: PropTypes.bool
+};
+
+// as objects are there in props, shallow comparision fails & re-rendering of comp happens even with
+// same key value pairs in obj. hence using custom comparison function on when to re-render
+//const comparisonFn = (prevProps, nextProps) => {
+//  return prevProps.updateDateTime === nextProps.updateDateTime;
+//};

package/src/tasks/create/templates/Constellation/Widget/PAGE-CASE/styles.js.mustache

@@ -0,0 +1,7 @@
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 8px 0;
+  `;
+});

package/src/tasks/init/template/package.json.mustache

@@ -36,18 +36,23 @@
   "sideEffects": false,
   "dependencies": {
     "@pega/cosmos-react-core": "^3.0.0-rc.4",
+    "@pega/cosmos-react-work": "3.0.0-rc.4",
     "@storybook/addon-knobs": "^6.3.1",
+    "dayjs": "^1.11.5",
+    "jest": "^29.3.1",
     "polished": "^4.2.2",
     "prop-types": "^15.8.1",
     "react": "^17.0.2",
     "react-autosuggest": "^10.1.0",
     "react-dom": "^17.0.2",
+    "react-is": "^18.2.0",
     "react-player": "^2.10.1",
+    "react-redux": "^7.2.6",
     "styled-components": "^5.3.5"
   },
   "devDependencies": {
     "@pega/configs": "^0.3.4",
-    "@pega/custom-dx-components": "^2.0.8",
+    "@pega/custom-dx-components": "^2.0.10",
     "@storybook/addon-actions": "^6.5.12",
     "@storybook/addon-essentials": "^6.5.12",
     "@storybook/addon-links": "^6.5.12",