@pega/custom-dx-components 0.23.21 → 0.23.22

package/src/tasks/create/templates/Launchpad/Widget/PAGE-CASE/Operator.tsx.mustache

@@ -0,0 +1,304 @@
+/* eslint-disable react/jsx-fragments */
+import { useState, useEffect, Fragment } from 'react';
+import {
+  Link,
+  Button,
+  Popover,
+  useOuterEvent,
+  useElement,
+  Progress,
+  FormField,
+  useTheme
+} from '@pega/cosmos-react-core';
+import { Glimpse } from '@pega/cosmos-react-work';
+import { EmailDisplay } from '@pega/cosmos-react-core';
+import PropTypes from 'prop-types';
+
+import type { PConnFieldProps } from './PConnProps';
+
+import Avatar from './Avatar';
+
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}OperatorProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  name: string;
+  id: string;
+  label: string;
+  metaObj: any;
+  externalUser: any;
+}
+
+export default function Operator(props: {{COMPONENT_CLASS_NAME}}OperatorProps) {
+  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 delimiters for mustache }}
+  {{=<% %>=}}
+
+  const OperatorPreview = () => {
+    let localizedVal = PCore.getLocaleUtils().getLocaleValue;
+    let localeCategory = 'Operator';
+    setpopoverContent(
+      // @ts-ignore
+      <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(
+        // @ts-ignore
+        <Glimpse
+          visual={
+            // @ts-ignore
+            <Avatar
+              metaObj={{
+                name: externalUser.name
+              }}
+            />
+          }
+          primary={externalUser.name}
+          secondary={[externalUser.position]}
+          fields={fields}
+        />
+      );
+    } else {
+      localizedVal = PCore.getLocaleUtils().getLocaleValue;
+      localeCategory = 'Operator';
+      return PCore.getUserApi()
+        .getOperatorDetails(id, true)
+        .then(res => {
+          if (res.data?.data && res.data.data[0].BusinessID && res.data.data[0].Name) {
+            const fields = [];
+            if (res.data.data[0].Name)
+              fields.push({
+                id: 'Name',
+                name: localizedVal('Name', localeCategory),
+                value: res.data.data[0].Name
+              });
+            if (res.data.data[0].BusinessID)
+              fields.push({
+                id: 'Email',
+                name: localizedVal('Email address', localeCategory),
+                value: <EmailDisplay value={res.data.data[0].BusinessID} />
+              });
+            return (
+              // @ts-ignore
+              <Glimpse
+                heading={{
+                  primary: res.data.data[0].Name,
+                  secondary: res.data.data[0].BusinessID,
+                  visual: (
+                    // @ts-ignore
+                    <Avatar
+                      metaObj={{
+                        image: '',
+                        name: res.data.data[0].Name
+                      }}
+                    />
+                  )
+                }}
+                fields={fields}
+                // @ts-ignore
+                target={popoverTarget}
+                onDismiss={() => setPopoverTarget(null)}
+              />
+            );
+          }
+        });
+      /*
+      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(
+              // @ts-ignore
+              <Glimpse
+                visual={
+                  // @ts-ignore
+                  <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);
+            // @ts-ignore
+            setpopoverContent(<Flex container={{ pad: 1 }}>{localizedVal('Operator not found', localeCategory)}</Flex>);
+          }
+        })
+        .catch(() => {
+          setIsLoading(false);
+          setpopoverContent(
+            // @ts-ignore
+            <Flex container={{ pad: 1 }}>{localizedVal('Error loading the operator profile', localeCategory)}</Flex>
+          );
+        });
+      */
+    }
+  };
+
+  <%={{ }}=%>     {{! revert delimiters for mustache }}
+
+  const clickAction = (e: any) => {
+    setPopoverTarget(e.currentTarget);
+    setIsOpen(!isOpen);
+    if (popoverTarget === null) {
+      OperatorPreview();
+    }
+  };
+
+  const hidePopover = () => {
+    if (isOpen) {
+      setIsOpen(false);
+    }
+  };
+
+  // @ts-ignore
+  useOuterEvent('mousedown', [popoverEl, popoverTarget], hidePopover); // Call the method on clicking outside these elements
+  const hideOnEscape = (e: any) => {
+    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 {...props}></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
+};

package/src/tasks/create/templates/Launchpad/Widget/PAGE-CASE/PConnProps.d.ts.mustache

@@ -0,0 +1,46 @@
+import  {PConnect } from '@pega/pcore-pconnect-typedefs';
+
+// PConnProps.d.ts
+// This gives us a place to have each component (which is most DX Components) that is
+//  expected to have a getPConnect extend its props (from BaseProps)
+//  such that every component will be expected to have a getPConnect() function
+//  that returns a PConnect object. (new/better way of doing .propTypes).
+//  This PConnProps can be extended to include other props that we know are in every component
+export interface PConnProps {
+  // getPConnect should exist for every C11n component. (add @ts-ignore in special cases where it isn't)
+  getPConnect: () => typeof PConnect;
+
+  // Allow any/all other key/value pairs in the BaseProps for now
+  //  TODO: refine which other props are always expected for various component
+  //    types and consider further interface "subclassing". For example, we may
+  //    want to create a "BasePropsForm" that gives guidance on required, readonly, etc.
+  //    and any other props that every Form component expects.
+  //    For example, see the PConnFieldProps below.
+  // NOTE: if you uncomment the line below, the PConnProps type will allow
+  //  otherwise undefined types to appear. This can be helpful for debugging
+  //  or when adding new components whose types aren't yet known.
+  // [key: string]: any;
+}
+
+
+// PConnFieldProps extends PConnProps to bring in the common properties that are
+// associated with most field components (ex: Dropdown, TextInput, etc.) in the
+//  components/field directory
+export interface PConnFieldProps extends PConnProps {
+  label: string,
+  required: boolean,
+  disabled: boolean,
+  value: any,
+  validatemessage: string,
+  status?: string,
+  onChange?: any,
+  onBlur?: any,
+  readOnly: boolean,
+  testId: string,
+  helperText: string,
+  displayMode?: string,
+  hideLabel: boolean,
+  placeholder?: string,
+  fieldMetadata?: any,
+  additionalProps?: any
+}

package/src/tasks/create/templates/Launchpad/Widget/PAGE-CASE/demo.stories.tsx.mustache

@@ -0,0 +1,76 @@
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import { withKnobs } from '@storybook/addon-knobs';
+
+import {{COMPONENT_CLASS_NAME}} from './index.jsx';
+
+import { configProps, operatorDetails } from './mock';
+
+export default {
+  title: '{{COMPONENT_CLASS_NAME}}',
+  decorators: [withKnobs],
+  component: {{COMPONENT_CLASS_NAME}}
+};
+
+if (!window.PCore) {
+  window.PCore = {};
+}
+
+window.PCore.getLocaleUtils = () => {
+  return {
+    getLocaleValue: value => {
+      return value;
+    }
+  };
+};
+
+window.PCore.getUserApi = () => {
+  return {
+    getOperatorDetails: () => {
+      return new Promise(resolve => {
+        resolve(operatorDetails);
+      });
+    }
+  };
+};
+
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
+
+  const props = {
+    label: configProps.label,
+    createLabel: configProps.createLabel,
+    updateLabel: configProps.updateLabel,
+    createOperator: configProps.createOperator,
+    updateOperator: configProps.updateOperator,
+    createDateTime: configProps.createDateTime,
+    updateDateTime: configProps.updateDateTime,
+    hideLabel: configProps.hideLabel,
+
+    getPConnect: () => {
+      return {
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {/* nothing */},
+            triggerFieldChange: () => {/* nothing */}
+          };
+        },
+        getCaseSummary: () => {
+          return {
+            user: configProps.updateOperator.userId,
+            dateTimeValue: configProps.updateDateTime
+          }
+        },
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        setInheritedProps: () => {/* nothing */},
+        resolveConfigProps: () => {/* nothing */}
+      };
+    }
+};
+
+return (
+    <>
+      <{{COMPONENT_CLASS_NAME}} {...props} />
+    </>
+  );
+};

package/src/tasks/create/templates/Launchpad/Widget/PAGE-CASE/index.tsx.mustache

@@ -0,0 +1,91 @@
+
+/* eslint-disable react/jsx-fragments */
+import { Fragment } from 'react';
+import { DateTimeDisplay, Card, CardHeader, CardContent, Flex } from '@pega/cosmos-react-core';
+import PropTypes from 'prop-types';
+import type { PConnFieldProps } from './PConnProps';
+
+// includes in bundle
+import Operator from './Operator';
+
+import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
+
+
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  title: string;
+  createLabel: string;
+  updateLabel: string;
+}
+
+// Created for Launchpad
+
+// 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: {{COMPONENT_CLASS_NAME}}Props) {
+
+  const {
+    getPConnect,
+    title,
+    label,
+    createLabel,
+    updateLabel
+  } = props;
+
+
+  const { createTime, createdBy, lastUpdateTime, lastUpdatedBy } = getPConnect().getCaseSummary();
+
+  const [_label, user, dateTimeValue] =
+    label === 'Create operator'
+      ? [createLabel, createdBy, createTime]
+      : [updateLabel, lastUpdatedBy, lastUpdateTime];
+
+
+
+  return (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+      <Card>
+      <CardHeader>{title}</CardHeader>
+      <CardContent>
+{{! pick new delimiters for mustache }} {{=<% %>=}}
+      <Flex container={{ direction: 'row'}}>
+      <Operator label={_label} name={user} id={user} getPConnect={getPConnect} value={undefined} validatemessage='' hideLabel={false} readOnly={false} required={false} disabled={false} externalUser={undefined} />
+<%={{ }}=%>     {{! revert delimiters for mustache }}
+      {dateTimeValue && (
+        <Fragment>
+          {' '}
+          <DateTimeDisplay value={dateTimeValue} variant='relative' />
+        </Fragment>
+      )}
+      </Flex>
+      </CardContent>
+      </Card>
+
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  );
+
+
+
+}
+
+{{COMPONENT_CLASS_NAME}}.defaultProps = {
+  "label": "Create operator",
+  "title": "Create operator",
+  createLabel: null,
+  updateLabel: null
+};
+
+{{COMPONENT_CLASS_NAME}}.propTypes = {
+  getPConnect: PropTypes.func.isRequired,
+  label: PropTypes.string,
+  title: PropTypes.string,
+  createLabel: PropTypes.string,
+  updateLabel: PropTypes.string
+};
+
+// 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/Launchpad/Widget/PAGE-CASE/mock.ts.mustache

@@ -0,0 +1,52 @@
+// @ts-nocheck
+export const configProps = {
+  label: 'Create operator',
+  createLabel: 'Created',
+  updateLabel: 'Updated',
+  updateDateTime: '2023-01-16T14:53:33.280Z',
+  createDateTime: '2023-01-16T14:53:33.198Z',
+  updateOperator: {
+    userId: 'admin@mediaco',
+    userName: 'admin'
+  },
+  createOperator: {
+    userId: 'admin@mediaco',
+    userName: 'admin'
+  },
+  hideLabel: true,
+  key: '_532zx1dah',
+  displayMode: 'LABELS_LEFT'
+};
+
+export const operatorDetails = {
+  data: {
+    pzLoadTime: 'January 18, 2023 10:33:19 AM EST',
+    pzPageNameHash: '_pa1519192551088960pz',
+    pyOperatorInfo: {
+      pyUserName: 'french DigV2',
+      pyPosition: '',
+      pyImageInsKey: '',
+      pySkills: [
+        {
+          pySkillName: '',
+          pzIndexOwnerKey: 'DATA-ADMIN-OPERATOR-ID FRENCHTEST.DIGV2',
+          pySkillRating: 0
+        }
+      ],
+      pyReportToUserName: '',
+      pyReportTo: '',
+      pyOrganization: 'DXIL',
+      pyTitle: '',
+      pyLabel: 'frenchTest.DigV2',
+      pyEmailAddress: 'User@DigV2',
+      pyTelephone: ''
+    }
+  },
+  status: 200,
+  statusText: '',
+  headers: {
+    'content-length': '435',
+    'content-type': 'application/json;charset=UTF-8'
+  },
+  request: {}
+};

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

@@ -64,7 +64,7 @@
     "styled-components": "^5.3.5"
   },
   "devDependencies": {
-    "@pega/configs": "^0.7.1",
+    "@pega/configs": "^0.6.0",
     "@pega/custom-dx-components": "0.23.21",
     "@pega/pcore-pconnect-typedefs": "2.0.0",
     "@storybook/addon-actions": "^7.6.7",
@@ -80,7 +80,7 @@
     "@types/react-color": "^3.0.11",
     "@types/react-dom": "^17.0.11",
     "@types/styled-components": "^5.1.34",
-    "@typescript-eslint/eslint-plugin": "^6.17.0",
+    "@typescript-eslint/eslint-plugin": "^5.6.0",
     "eslint": "^8.56.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-jest": "^27.6.1",
@@ -93,10 +93,11 @@
     "eslint-plugin-storybook": "^0.6.15",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
+    "jest-junit": "^16.0.0",
     "npm-run-all": "^4.1.5",
     "prettier": "3.1.1",
     "storybook": "^7.6.7",
     "stylelint": "^14.11.0",
-    "typescript": "~5.3.3"
+    "typescript": "~4.9.5"
   }
 }

package/tests/assets/components/create/Pega_DXIL_MyTestText/PConnProps.d.ts

@@ -0,0 +1,46 @@
+import  {PConnect } from '@pega/pcore-pconnect-typedefs';
+
+// PConnProps.d.ts
+// This gives us a place to have each component (which is most DX Components) that is
+//  expected to have a getPConnect extend its props (from BaseProps)
+//  such that every component will be expected to have a getPConnect() function
+//  that returns a PConnect object. (new/better way of doing .propTypes).
+//  This PConnProps can be extended to include other props that we know are in every component
+export interface PConnProps {
+  // getPConnect should exist for every C11n component. (add @ts-ignore in special cases where it isn't)
+  getPConnect: () => typeof PConnect;
+
+  // Allow any/all other key/value pairs in the BaseProps for now
+  //  TODO: refine which other props are always expected for various component
+  //    types and consider further interface "subclassing". For example, we may
+  //    want to create a "BasePropsForm" that gives guidance on required, readonly, etc.
+  //    and any other props that every Form component expects.
+  //    For example, see the PConnFieldProps below.
+  // NOTE: if you uncomment the line below, the PConnProps type will allow
+  //  otherwise undefined types to appear. This can be helpful for debugging
+  //  or when adding new components whose types aren't yet known.
+  // [key: string]: any;
+}
+
+
+// PConnFieldProps extends PConnProps to bring in the common properties that are
+// associated with most field components (ex: Dropdown, TextInput, etc.) in the
+//  components/field directory
+export interface PConnFieldProps extends PConnProps {
+  label: string,
+  required: boolean,
+  disabled: boolean,
+  value: any,
+  validatemessage: string,
+  status?: string,
+  onChange?: any,
+  onBlur?: any,
+  readOnly: boolean,
+  testId: string,
+  helperText: string,
+  displayMode?: string,
+  hideLabel: boolean,
+  placeholder?: string,
+  fieldMetadata?: any,
+  additionalProps?: any
+}