@pega/react-sdk-overrides 0.23.26 → 8.8.21

package/lib/template/CaseView/CaseView.tsx

@@ -1,23 +1,34 @@
 /* eslint-disable react/jsx-boolean-value */
 
-import React, { useState, useEffect, useContext } from "react";
-import PropTypes from "prop-types";
+import React, { useState, useEffect, useContext } from 'react';
 import { Utils } from '@pega/react-sdk-components/lib/components/helpers/utils';
-import { Card, CardHeader, Avatar, Typography, Divider } from "@material-ui/core";
+import { Card, CardHeader, Avatar, Typography, Divider } from '@material-ui/core';
 import { makeStyles } from '@material-ui/core/styles';
 import Box from '@material-ui/core/Box';
 import Button from '@material-ui/core/Button';
 import Grid from '@material-ui/core/Grid';
 
-import StoreContext from "@pega/react-sdk-components/lib/bridge/Context/StoreContext";
-import CaseViewActionsMenu from "@pega/react-sdk-components/lib/components/template/CaseViewActionsMenu";
-import VerticalTabs from '@pega/react-sdk-components/lib/components/infra/VerticalTabs/VerticalTabs';
-import DeferLoad from '@pega/react-sdk-components/lib/components/infra/DeferLoad';
+import StoreContext from '@pega/react-sdk-components/lib/bridge/Context/StoreContext';
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
 
+import type { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+
+interface CaseViewProps extends PConnProps {
+  // If any, enter additional props that only exist on this component
+  icon: string,
+  children: Array<any>,
+  subheader: string,
+  header: string,
+  showIconInHeader: boolean,
+  caseInfo: any,
+}
+
+
+// Remove this and use "real" PCore type once .d.ts is fixed (currently shows 2 errors)
+declare const PCore: any;
 
-declare const PCore;
 
-const useStyles = makeStyles((theme) => ({
+const useStyles = makeStyles(theme => ({
   root: {
     paddingRight: theme.spacing(1),
     paddingLeft: theme.spacing(1),
@@ -26,55 +37,77 @@ const useStyles = makeStyles((theme) => ({
     marginRight: theme.spacing(1),
     marginLeft: theme.spacing(1),
     marginTop: theme.spacing(1),
-    marginBottom: theme.spacing(1),
+    marginBottom: theme.spacing(1)
   },
   caseViewHeader: {
     backgroundColor: theme.palette.info.light,
     color: theme.palette.getContrastText(theme.palette.info.light),
-    borderRadius: "inherit",
+    borderRadius: 'inherit'
   },
   caseViewIconBox: {
     backgroundColor: theme.palette.info.dark,
     width: theme.spacing(8),
     height: theme.spacing(8),
-    padding: theme.spacing(1),
+    padding: theme.spacing(1)
   },
   caseViewIconImage: {
     filter: 'invert(100%)'
   }
 }));
 
-export default function CaseView(props) {
+export default function CaseView(props: CaseViewProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const CaseViewActionsMenu = getComponentFromMap("CaseViewActionsMenu");
+  const VerticalTabs = getComponentFromMap("VerticalTabs");
+  const DeferLoad = getComponentFromMap("DeferLoad");
+
   const {
     getPConnect,
-    icon,
+    icon = '',
     header,
     subheader,
-    children,
-    caseInfo: { availableActions = [], availableProcesses = [], hasNewAttachments }
+    children = [],
+    // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
+    showIconInHeader = true,
+    caseInfo: {
+      availableActions = [],
+      availableProcesses = [],
+      hasNewAttachments,
+      caseTypeID = '',
+      caseTypeName = ''
+    }
   } = props;
   const currentCaseID = props.caseInfo.ID;
   let isComponentMounted = true;
 
-  const { displayOnlyFA } = useContext(StoreContext);
+  const { displayOnlyFA } = useContext<any>(StoreContext);
 
   const thePConn = getPConnect();
 
   const classes = useStyles();
 
-  const editAction = availableActions.find((action) => action.ID === 'pyUpdateCaseDetails');
+  const editAction = availableActions.find(action => action.ID === 'pyUpdateCaseDetails');
+
+  const localizedVal = PCore.getLocaleUtils().getLocaleValue;
+  const localeCategory = 'CaseView';
+  const localeKey = `${caseTypeID}!CASE!${caseTypeName}`.toUpperCase();
 
   /**
    *
    * @param inName the metadata <em>name</em> that will cause a region to be returned
    */
-   function getChildRegionByName(inName: string): any {
-
+  function getChildRegionByName(inName: string): any {
     for (const child of children) {
-      const theMetadataType: string = child.props.getPConnect().getRawMetadata()['type'].toLowerCase();
-      const theMetadataName: string = child.props.getPConnect().getRawMetadata()['name'].toLowerCase();
-
-      if ((theMetadataType === "region") && (theMetadataName === inName )) {
+      const theMetadataType: string = child.props
+        .getPConnect()
+        .getRawMetadata()
+        ['type'].toLowerCase();
+      const theMetadataName: string = child.props
+        .getPConnect()
+        .getRawMetadata()
+        ['name'].toLowerCase();
+
+      if (theMetadataType === 'region' && theMetadataName === inName) {
         return child;
       }
     }
@@ -82,14 +115,13 @@ export default function CaseView(props) {
     return null;
   }
 
+  const theSummaryRegion = getChildRegionByName('summary');
+  const theStagesRegion = getChildRegionByName('stages');
+  const theTodoRegion = getChildRegionByName('todo');
+  const theUtilitiesRegion = getChildRegionByName('utilities');
+  const theTabsRegion = getChildRegionByName('tabs');
 
-  const theSummaryRegion = getChildRegionByName("summary");
-  const theStagesRegion = getChildRegionByName("stages");
-  const theTodoRegion = getChildRegionByName("todo");
-  const theUtilitiesRegion = getChildRegionByName("utilities");
-  const theTabsRegion = getChildRegionByName("tabs");
-
-  const svgCase = Utils.getImageSrc(icon, PCore.getAssetLoader().getStaticServerUrl());
+  const svgCase = Utils.getImageSrc(icon, Utils.getSDKStaticConentUrl());
 
   const [activeVertTab, setActiveVertTab] = useState(0);
 
@@ -127,8 +159,6 @@ export default function CaseView(props) {
     });
   }
 
-
-
   function handleVerticalTabClick(eventDetail: any) {
     const theItem = parseInt(eventDetail.additionalData.itemClicked, 10);
 
@@ -138,14 +168,13 @@ export default function CaseView(props) {
     }
   }
 
-
   // Add and Remove event listener for VerticalTabClick only at startup and teardown
   useEffect(() => {
     document.addEventListener('VerticalTabClick', (event: any) => {
       handleVerticalTabClick(event.detail);
     });
 
-    return ():void => {
+    return (): void => {
       // inform that the component is unmounted so other code can
       //  know not to try to call useState setters (to avoid console warnings)
       isComponentMounted = false;
@@ -153,74 +182,103 @@ export default function CaseView(props) {
       document.removeEventListener('VerticalTabClick', (event: any) => {
         handleVerticalTabClick(event.detail);
       });
-    }
-  }, [])
+    };
+  }, []);
 
   useEffect(() => {
     if (hasNewAttachments) {
-      PCore.getPubSubUtils().publish(PCore.getEvents().getCaseEvent().CASE_ATTACHMENTS_UPDATED_FROM_CASEVIEW, true);
+      PCore.getPubSubUtils().publish(
+        PCore.getEvents().getCaseEvent().CASE_ATTACHMENTS_UPDATED_FROM_CASEVIEW,
+        true
+      );
     }
   }, [hasNewAttachments]);
 
   function _editClick() {
-
     const actionsAPI = thePConn.getActionsApi();
     const openLocalAction = actionsAPI.openLocalAction.bind(actionsAPI);
 
-    openLocalAction( editAction.ID, { ...editAction});
+    openLocalAction(editAction.ID, { ...editAction });
   }
 
-
   function getActionButtonsHtml(): any {
-
-    const aBHtml = <Box>
-            {editAction && (<Button onClick={() => {_editClick()}}>Edit</Button>)}
-            <CaseViewActionsMenu getPConnect={getPConnect} availableActions={availableActions} availableProcesses={availableProcesses} />
-        </Box>;
-
+    const aBHtml = (
+      <Box>
+        {editAction && (
+          <Button
+            onClick={() => {
+              _editClick();
+            }}
+          >
+            {localizedVal('Edit', localeCategory)}
+          </Button>
+        )}
+        <CaseViewActionsMenu
+          getPConnect={getPConnect}
+          availableActions={availableActions}
+          availableProcesses={availableProcesses}
+          caseTypeName={caseTypeName}
+          caseTypeID={caseTypeID}
+        />
+      </Box>
+    );
 
     return aBHtml;
-
   }
 
-
   function getContainerContents() {
-
     if (!displayOnlyFA) {
       // show full portal
       return (
         <Grid container>
           <Grid item xs={3}>
-          <div hidden={true} id="current-caseID">{currentCaseID}</div>
-          <Card className={classes.root} >
-            <CardHeader className={classes.caseViewHeader}
-              title={<Typography variant="h6" component="div">{header}</Typography>}
-              subheader={<Typography variant="body1" component="div" id="caseId">{subheader}</Typography>}
-              avatar={
-                <Avatar className={classes.caseViewIconBox} variant="square">
-                  <img src={svgCase} className={classes.caseViewIconImage}/>
-                </Avatar>
-              }
-            />
-            {getActionButtonsHtml()}
-            <Divider />
-            {theSummaryRegion}
-            <Divider />
-            { vertTabInfo.length > 1 && <VerticalTabs tabconfig={vertTabInfo} />}
-          </Card>
-        </Grid>
+            <div hidden={true} id='current-caseID'>
+              {currentCaseID}
+            </div>
+            <Card className={classes.root}>
+              <CardHeader
+                className={classes.caseViewHeader}
+                title={
+                  <Typography variant='h6' component='div'>
+                    {PCore.getLocaleUtils().getLocaleValue(header, '', localeKey)}
+                  </Typography>
+                }
+                subheader={
+                  <Typography variant='body1' component='div' id='caseId'>
+                    {subheader}
+                  </Typography>
+                }
+                avatar={
+                  <Avatar className={classes.caseViewIconBox} variant='square'>
+                    <img src={svgCase} className={classes.caseViewIconImage} />
+                  </Avatar>
+                }
+              />
+              {getActionButtonsHtml()}
+              <Divider />
+              {theSummaryRegion}
+              <Divider />
+              {vertTabInfo.length > 1 && <VerticalTabs tabconfig={vertTabInfo} />}
+            </Card>
+          </Grid>
 
-        <Grid item xs={6}>
-          {theStagesRegion}
-          {theTodoRegion}
-          { deferLoadInfo.length > 0 && <DeferLoad getPConnect={getPConnect} name={deferLoadInfo[activeVertTab].config.name } isTab />}
-        </Grid>
+          <Grid item xs={6}>
+            {theStagesRegion}
+            {theTodoRegion}
+            {deferLoadInfo.length > 0 && (
+              <DeferLoad
+                getPConnect={getPConnect}
+                name={deferLoadInfo[activeVertTab].config.name}
+                isTab
+              />
+            )}
+          </Grid>
 
-        <Grid item xs={3}>
-          {theUtilitiesRegion}
+          <Grid item xs={3}>
+            {theUtilitiesRegion}
+          </Grid>
         </Grid>
-      </Grid>
-      )
+      );
     } else {
       // displayOnlyFA - only show the "todo" region
       return (
@@ -229,30 +287,9 @@ export default function CaseView(props) {
             {theTodoRegion}
           </Grid>
         </Grid>
-      )
+      );
     }
   }
 
-
-  return (
-      getContainerContents()
-  );
+  return getContainerContents();
 }
-
-CaseView.defaultProps = {
-  icon: "",
-  children: [],
-  caseInfo: {},
-  showIconInHeader: true,
-  getPConnect: null
-};
-
-CaseView.propTypes = {
-  icon: PropTypes.string,
-  children: PropTypes.arrayOf(PropTypes.node),
-  subheader: PropTypes.string.isRequired,
-  header: PropTypes.string.isRequired,
-  showIconInHeader: PropTypes.bool,
-  caseInfo: PropTypes.objectOf(PropTypes.any),
-  getPConnect: PropTypes.func
-};

package/lib/template/CaseViewActionsMenu/CaseViewActionsMenu.tsx

@@ -1,13 +1,25 @@
 import React, { useState } from 'react';
-import PropTypes from "prop-types";
 import Button from '@material-ui/core/Button';
 import Menu from '@material-ui/core/Menu';
 import MenuItem from '@material-ui/core/MenuItem';
+import type { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+
+interface CaseViewActionsMenuProps extends PConnProps {
+  // If any, enter additional props that only exist on this component
+  availableActions: Array<any>,
+  availableProcesses: Array<any>,
+  caseTypeID: string,
+  caseTypeName: string
+}
+
 
-export default function CaseViewActionsMenu(props) {
-  const {getPConnect, availableActions, availableProcesses} = props;
+export default function CaseViewActionsMenu(props:CaseViewActionsMenuProps) {
+  const { getPConnect, availableActions, availableProcesses, caseTypeID, caseTypeName } = props;
   const thePConn = getPConnect();
 
+  const localizedVal = PCore.getLocaleUtils().getLocaleValue;
+  const localeCategory = 'CaseView';
+  const localeKey = `${caseTypeID}!CASE!${caseTypeName}`.toUpperCase();
 
   const [anchorEl, setAnchorEl] = useState<null | HTMLElement>(null);
 
@@ -21,35 +33,34 @@ export default function CaseViewActionsMenu(props) {
 
   const arMenuItems: Array<any> = [];
 
-
   function _actionMenuActionsClick(data) {
-
     const actionsAPI = thePConn.getActionsApi();
     const openLocalAction = actionsAPI.openLocalAction.bind(actionsAPI);
 
-    openLocalAction( data.ID, { ...data, containerName: 'modal', type: 'express'});
+    openLocalAction(data.ID, { ...data, containerName: 'modal', type: 'express' });
     // after doing the action, close the menu...
     handleClose();
-
   }
 
-
-  availableActions.forEach( (action) => {
-    arMenuItems.push( <MenuItem key={action.ID} onClick={() => _actionMenuActionsClick(action)}>{action.name}</MenuItem> )
+  availableActions.forEach(action => {
+    arMenuItems.push(
+      <MenuItem key={action.ID} onClick={() => _actionMenuActionsClick(action)}>
+        {localizedVal(action.name, '', localeKey)}
+      </MenuItem>
+    );
   });
 
-  availableProcesses.forEach( (process) => {
-    arMenuItems.push( <MenuItem onClick={handleClose}>{process.name}</MenuItem> )
+  availableProcesses.forEach(process => {
+    arMenuItems.push(<MenuItem onClick={handleClose}>{process.name}</MenuItem>);
   });
 
-
   return (
     <React.Fragment>
-      <Button aria-controls="simple-menu" aria-haspopup="true" onClick={handleClick}>
-        Actions...
+      <Button aria-controls='simple-menu' aria-haspopup='true' onClick={handleClick}>
+        {localizedVal('Actions...', localeCategory)}
       </Button>
       <Menu
-        id="simple-menu"
+        id='simple-menu'
         anchorEl={anchorEl}
         keepMounted
         open={Boolean(anchorEl)}
@@ -60,14 +71,3 @@ export default function CaseViewActionsMenu(props) {
     </React.Fragment>
   );
 }
-
-CaseViewActionsMenu.defaultProps = {
-  availableActions: [],
-  availableProcesses: []
-}
-
-CaseViewActionsMenu.propTypes = {
-  getPConnect: PropTypes.func.isRequired,
-  availableActions: PropTypes.arrayOf(PropTypes.object),
-  availableProcesses: PropTypes.arrayOf(PropTypes.any)
-};

package/lib/template/Confirmation/Confirmation.tsx

@@ -1,17 +1,25 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /* eslint-disable no-unused-vars */
 /* eslint-disable no-nested-ternary */
-import { Fragment, useState } from 'react';
-import PropTypes from 'prop-types';
-import React from 'react';
-import { getToDoAssignments } from '@pega/react-sdk-components/lib/components/infra/Containers/FlowContainer/helpers';
-import ToDo from '@pega/react-sdk-components/lib/components/widget/ToDo';
-import Details from '@pega/react-sdk-components/lib/components/template/Details/Details';
+import React, { useState } from 'react';
 import { Button, Card, makeStyles } from '@material-ui/core';
+import { getToDoAssignments } from '@pega/react-sdk-components/lib/components/infra/Containers/FlowContainer/helpers';
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
+
+import type { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+
+// Confirmation does NOT have getPConnect. So, no need to extend from PConnProps
 
-declare const PCore;
+interface ConfirmationProps extends PConnProps {
+  // If any, enter additional props that only exist on this component
+  children: Array<any>;
+  datasource: { source: any };
+  label: string;
+  showLabel: boolean;
+  showTasks: boolean;
+}
 
-const useStyles = makeStyles(theme => ({
+const useStyles = makeStyles((theme) => ({
   root: {
     paddingRight: theme.spacing(1),
     paddingLeft: theme.spacing(1),
@@ -24,7 +32,11 @@ const useStyles = makeStyles(theme => ({
   }
 }));
 
-export default function Confirmation(props) {
+export default function Confirmation(props: ConfirmationProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const ToDo = getComponentFromMap('Todo'); // NOTE: ConstellationJS Engine uses "Todo" and not "ToDo"!!!
+  const Details = getComponentFromMap('Details');
+
   const classes = useStyles();
   const CONSTS = PCore.getConstants();
   const [showConfirmView, setShowConfirmView] = useState(true);
@@ -32,20 +44,12 @@ export default function Confirmation(props) {
   // Get the inherited props from the parent to determine label settings
   // Not using whatsNext at the moment, need to figure out the use of it
   const whatsNext = datasource?.source;
-  const items = whatsNext.length > 0 ? whatsNext.map(item => item.label) : '';
-  const activeContainerItemID = PCore.getContainerUtils().getActiveContainerItemName(
-    getPConnect().getTarget()
-  );
-  const rootInfo = PCore.getContainerUtils().getContainerItemData(
-    getPConnect().getTarget(),
-    activeContainerItemID
-  );
+  const items = whatsNext.length > 0 ? whatsNext.map((item) => item.label) : '';
+  const activeContainerItemID = PCore.getContainerUtils().getActiveContainerItemName(getPConnect().getTarget());
+  const rootInfo = PCore.getContainerUtils().getContainerItemData(getPConnect().getTarget(), activeContainerItemID);
   const onConfirmViewClose = () => {
     setShowConfirmView(false);
-    PCore.getPubSubUtils().publish(
-      PCore.getConstants().PUB_SUB_EVENTS.CASE_EVENTS.CLOSE_CONFIRM_VIEW,
-      rootInfo
-    );
+    PCore.getPubSubUtils().publish(PCore.getConstants().PUB_SUB_EVENTS.CASE_EVENTS.CLOSE_CONFIRM_VIEW, rootInfo);
   };
   const todoProps = { ...props, renderTodoInConfirm: true };
   const toDoList = getToDoAssignments(getPConnect());
@@ -53,49 +57,22 @@ export default function Confirmation(props) {
   const showDetails = detailProps?.children?.[0]?.props?.getPConnect()?.getChildren()?.length > 0;
   return showConfirmView ? (
     <Card className={classes.root}>
-      <h2 id='confirm-label'>{props.showLabel ? props.label : ''}</h2>
+      <h2 id="confirm-label">{props.showLabel ? props.label : ''}</h2>
       {showDetails ? <Details {...detailProps} /> : undefined}
       {showTasks ? (
         toDoList && toDoList.length > 0 ? (
-          <ToDo
-            {...todoProps}
-            datasource={{ source: toDoList }}
-            getPConnect={getPConnect}
-            type={CONSTS.TODO}
-            headerText='Open Tasks'
-            isConfirm
-          />
+          <ToDo {...todoProps} datasource={{ source: toDoList }} getPConnect={getPConnect} type={CONSTS.TODO} headerText="Open Tasks" isConfirm />
         ) : undefined
       ) : undefined}
       <div style={{ display: 'flex', justifyContent: 'flex-end' }}>
-        <Button variant='contained' color='primary' onClick={onConfirmViewClose}>
+        <Button variant="contained" color="primary" onClick={onConfirmViewClose}>
           Done
         </Button>
       </div>
     </Card>
   ) : toDoList && toDoList.length > 0 ? (
     <Card className={classes.root}>
-      <ToDo
-        {...props}
-        datasource={{ source: toDoList }}
-        getPConnect={getPConnect}
-        type={CONSTS.TODO}
-        headerText='Tasks'
-        isConfirm
-      />
+      <ToDo {...props} datasource={{ source: toDoList }} getPConnect={getPConnect} type={CONSTS.TODO} headerText="Tasks" isConfirm />
     </Card>
   ) : null;
 }
-
-Confirmation.defaultProps = {
-  datasource: undefined,
-  label: '',
-  showLabel: true
-};
-
-Confirmation.propTypes = {
-  getPConnect: PropTypes.func.isRequired,
-  datasource: PropTypes.objectOf(PropTypes.any),
-  label: PropTypes.string,
-  showLabel: PropTypes.bool
-};