@pega/dx-component-builder-sdk 0.23.6 → 0.23.8

package/tests/assets/components/SDK-React/create/override-sdk/infra/DashboardFilter/DashboardFilter.tsx

@@ -12,20 +12,19 @@ import DatePicker from 'react-datepicker';
 
 import 'react-datepicker/dist/react-datepicker.css';
 
-// import type { PConnProps } from '../../../types/PConnProps';
-
-// Can't use DashboardFilter props until createComponent typedefs properly allow optional args
-// interface DashboardFilterProps extends PConnProps {
-//   // If any, enter additional props that only exist on this component
-//   children?: Array<any>,
-//   name: string,
-//   filterProp: string,
-//   type?: string,
-//   metadata?: any
-// }
+import type { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+
+interface DashboardFilterProps extends PConnProps {
+  // If any, enter additional props that only exist on this component
+  children?: Array<any>,
+  name: string,
+  filterProp: string,
+  type?: string,
+  metadata?: any
+}
 
 
-export default function DashboardFilter(props /* : DashboardFilterProps */) {
+export default function DashboardFilter(props: DashboardFilterProps) {
   const { children = [], name, filterProp, type = '', metadata = null, getPConnect } = props;
   const { current: filterId } = useRef(uuidv4());
 
@@ -109,7 +108,8 @@ export default function DashboardFilter(props /* : DashboardFilterProps */) {
     metadata.config.onRecordChange = e => {
       fireFilterChange(e.id);
     };
-    return getPConnect().createComponent(metadata);
+    return getPConnect().createComponent(metadata,
+      '', '', {}); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional);
   };
 
   const onChange = dates => {

package/tests/assets/components/SDK-React/create/override-sdk/infra/DashboardFilter/filterUtils.tsx

@@ -91,7 +91,8 @@ export const createFilterComponent = (getPConnect, filterMeta, index) => {
       metadata={filterMeta}
       type={filterMeta.type}
     >
-      {getPConnect().createComponent(filterMeta)}
+      {getPConnect().createComponent(filterMeta,
+        '', '', {})}
     </DashboardFilter>
   );
 };

package/tests/assets/components/SDK-React/create/override-sdk/infra/DeferLoad/DeferLoad.tsx

@@ -0,0 +1,172 @@
+import React, { useState, useEffect, createElement } from 'react';
+import { Box, Card, CircularProgress } from '@material-ui/core';
+import { makeStyles } from '@material-ui/core/styles';
+
+import createPConnectComponent from '@pega/react-sdk-components/lib/bridge/react_pconnect';
+
+// import type { PConnProps } from '../../../types/PConnProps';
+
+// Can't use PConnProps until typedefs for showData are fixed
+// interface DeferLoadProps extends PConnProps {
+//   // If any, enter additional props that only exist on this component
+//   name: string,
+//   isChildDeferLoad?: boolean,
+//   isTab: boolean
+// }
+
+
+//
+// WARNING:  It is not expected that this file should be modified.  It is part of infrastructure code that works with
+// Redux and creation/update of Redux containers and PConnect.  Modifying this code could have undesireable results and
+// is totally at your own risk.
+//
+
+const useStyles = makeStyles(theme => ({
+  root: {
+    paddingRight: theme.spacing(1),
+    paddingLeft: theme.spacing(1),
+    paddingTop: theme.spacing(1),
+    paddingBottom: theme.spacing(1),
+    marginRight: theme.spacing(1),
+    marginLeft: theme.spacing(1),
+    marginTop: theme.spacing(1),
+    marginBottom: theme.spacing(1)
+  }
+}));
+
+export default function DeferLoad(props /* : DeferLoadProps */) {
+  const { getPConnect, name, deferLoadId, isTab } = props;
+  const [content, setContent] = useState<any>(null);
+  const [isLoading, setLoading] = useState(true);
+  const [currentLoadedAssignment, setCurrentLoadedAssignment] = useState("");
+
+  const classes = useStyles();
+
+  const pConnect = getPConnect();
+  const constants = PCore.getConstants();
+
+  const theRequestedAssignment = pConnect.getValue( PCore.getConstants().CASE_INFO.ASSIGNMENT_LABEL, '');  // 2nd arg empty string until typedef allows optional
+  if (theRequestedAssignment !== currentLoadedAssignment)  {
+    // console.log(`DeferLoad: currentLoadedAssignment about to change from ${currentLoadedAssignment} to ${theRequestedAssignment}`);
+    setCurrentLoadedAssignment(theRequestedAssignment);
+  }
+
+  const { CASE, PAGE, DATA } = constants.RESOURCE_TYPES;
+  const loadViewCaseID =
+    pConnect.getValue(constants.PZINSKEY, '') || pConnect.getValue(constants.CASE_INFO.CASE_INFO_ID, '');  // 2nd arg empty string until typedef allows optional
+  let containerName;
+  let containerItemData;
+  const targetName = pConnect.getTarget();
+  if (targetName) {
+    containerName = PCore.getContainerUtils().getActiveContainerItemName(targetName);
+
+    containerItemData = PCore.getContainerUtils().getContainerItemData(targetName, containerName);
+  }
+
+  const { resourceType = CASE } = containerItemData || {
+    resourceType: loadViewCaseID ? CASE : PAGE
+  };
+  const isContainerPreview = /preview_[0-9]*/g.test(pConnect.getContextName());
+
+  const getViewOptions = () => ({
+    viewContext: resourceType,
+    pageClass: loadViewCaseID ? '' : pConnect.getDataObject('').pyPortal.classID,  // 2nd arg empty string until typedef allows optional
+    container: isContainerPreview ? 'preview' : null,
+    containerName: isContainerPreview ? 'preview' : null,
+    updateData: isContainerPreview
+  });
+
+  const onResponse = data => {
+    setLoading(false);
+    if (deferLoadId) {
+      PCore.getDeferLoadManager().start(
+        name,
+        getPConnect().getCaseInfo().getKey(),
+        getPConnect().getPageReference().replace('caseInfo.content', ''),
+        getPConnect().getContextName(),
+        deferLoadId
+      );
+    }
+
+    if (data && !(data.type && data.type === 'error')) {
+      const config = {
+        meta: data,
+        options: {
+          context: pConnect.getContextName(),
+          pageReference: pConnect.getPageReference()
+        }
+      };
+      const configObject = PCore.createPConnect(config);
+      configObject.getPConnect().setInheritedProp('displayMode', 'LABELS_LEFT');
+      setContent(createElement(createPConnectComponent(), configObject));
+      if (deferLoadId) {
+        PCore.getDeferLoadManager().stop(deferLoadId, getPConnect().getContextName());
+      }
+    }
+  };
+
+  useEffect(() => {
+    if (resourceType === DATA) {
+      // Rendering defer loaded tabs in data context
+      if (containerName) {
+        const dataContext = PCore.getStoreValue('.dataContext', 'dataInfo', containerName);
+        const dataContextParameters = PCore.getStoreValue(
+          '.dataContextParameters',
+          'dataInfo',
+          containerName
+        );
+
+        getPConnect()
+          .getActionsApi()
+          .showData(name, dataContext, dataContextParameters, {   // Need to wait for typedefs to be fixed for showData
+            skipSemanticUrl: true,
+            isDeferLoaded: true
+          })
+          .then(data => {
+            onResponse(data);
+          });
+      } else {
+        // eslint-disable-next-line no-console
+        console.error('Cannot load the defer loaded view without container information');
+      }
+    } else if (resourceType === PAGE) {
+      // Rendering defer loaded tabs in case/ page context
+      getPConnect()
+        .getActionsApi()
+        .loadView(encodeURI(loadViewCaseID), name, getViewOptions())
+        .then(data => {
+          onResponse(data);
+        });
+    } else {
+      getPConnect()
+        .getActionsApi()
+        .refreshCaseView(encodeURI(loadViewCaseID), name, '')  // 3rd arg empty string until typedef allows optional
+        .then(data => {
+          onResponse(data.root);
+        });
+    }
+  }, [name, getPConnect, currentLoadedAssignment]);
+  /* TODO Cosmos need to handle for now added a wrapper div with pos relative */
+  let deferLoadContent;
+  if (isLoading) {
+    deferLoadContent = (
+      <div style={{ position: 'relative', height: '100px' }}>
+        <Box textAlign='center'>
+          <CircularProgress />
+        </Box>
+      </div>
+    );
+  } else {
+    deferLoadContent = !isTab ? (
+      <div className={classes.root}>
+        <React.Fragment>{content}</React.Fragment>
+      </div>
+    ) : (
+      <Card id='DeferLoad' className={classes.root}>
+        <React.Fragment>{content}</React.Fragment>
+      </Card>
+    );
+  }
+
+  return deferLoadContent;
+}

package/tests/assets/components/SDK-React/create/override-sdk/infra/DeferLoad/index.tsx

@@ -0,0 +1 @@
+export { default } from './DeferLoad';

package/tests/assets/components/SDK-React/create/override-sdk/infra/MultiStep/MultiStep.tsx

@@ -1,9 +1,7 @@
 import React from "react";
-
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
 import './MultiStep.css';
 
-import AssignmentCard from '@pega/react-sdk-components/lib/components/infra/AssignmentCard';
-
 // import { useConstellationContext } from "../../bridge/Context/StoreContext";
 
 import type { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
@@ -23,6 +21,9 @@ interface MultiStepProps extends PConnProps {
 
 
 export default function MultiStep(props: MultiStepProps) {
+    // Get emitted components from map (so we can get any override that may exist)
+    const AssignmentCard = getComponentFromMap("AssignmentCard");
+
     const { getPConnect, children, itemKey = '', actionButtons, onButtonPress} = props;
     const { bIsVertical, arNavigationSteps } = props;
 

package/tests/assets/components/SDK-React/create/override-sdk/infra/NavBar/NavBar.tsx

@@ -49,7 +49,8 @@ interface NavBarProps extends PConnProps {
 
 const iconMap = {
   'pi pi-headline': <HomeOutlinedIcon fontSize='large' />,
-  'pi pi-flag-solid': <FlagOutlinedIcon fontSize='large' />
+  'pi pi-flag-solid': <FlagOutlinedIcon fontSize='large' />,
+  'pi pi-home-solid': <HomeOutlinedIcon fontSize='large' />
 };
 
 const drawerWidth = 300;

package/tests/assets/components/SDK-React/create/override-sdk/infra/VerticalTabs/VerticalTabs.tsx

@@ -2,7 +2,7 @@ import React, { useState, useEffect } from "react";
 import { makeStyles } from '@material-ui/core/styles'
 
 import Tabs from '@material-ui/core/Tabs';
-import LeftAlignVerticalTab from '@pega/react-sdk-components/lib/components/infra/VerticalTabs/LeftAlignVerticalTabs';
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
 
 // VerticalTabs does NOT have getPConnect. So, no need to extend from PConnProps
 interface VerticalTabsProps {
@@ -37,6 +37,9 @@ const createCustomEvent = (eventName: string, additionalData: {[key: string]: st
 
 
 export default function VerticalTabs(props: VerticalTabsProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const LeftAlignVerticalTab = getComponentFromMap("LeftAlignVerticalTabs");
+
   // Get a React warning when we use tabConfig as mixed case. So all lowercase tabconfig
   const { tabconfig = [] } = props;
   const classes = useStyles();

package/tests/assets/components/SDK-React/create/override-sdk/template/AppShell/AppShell.tsx

@@ -4,10 +4,7 @@ import { Utils } from '@pega/react-sdk-components/lib/components/helpers/utils';
 import Avatar from '@material-ui/core/Avatar';
 import { NavContext } from '@pega/react-sdk-components/lib/components/helpers/reactContextHelpers';
 import './AppShell.css';
-
-// AppShell can emit NavBar or WssNavBar
-import NavBar from '@pega/react-sdk-components/lib/components/infra/NavBar';
-import WssNavBar from '@pega/react-sdk-components/lib/components/template/WssNavBar';
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
 
 import type { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
 
@@ -55,6 +52,10 @@ declare const PCore: any;
 
 
 export default function AppShell(props:AppShellProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const NavBar = getComponentFromMap("NavBar");
+  const WssNavBar = getComponentFromMap("WssNavBar");
+
   const {
     pages = [],
     caseTypes = [],
@@ -66,6 +67,7 @@ export default function AppShell(props:AppShellProps) {
     portalLogo,
     navDisplayOptions
   } = props;
+
   const [open, setOpen] = useState(true);
   // eslint-disable-next-line @typescript-eslint/no-unused-vars, no-unused-vars
   const [activeTab, setActiveTab] = useState(!pages ? null : pages[0]?.pyRuleName);

package/tests/assets/components/SDK-React/create/override-sdk/template/BannerPage/BannerPage.tsx

@@ -1,6 +1,6 @@
 import { useMemo, Children } from 'react';
-import Banner from '@pega/react-sdk-components/lib/components/designSystemExtension/Banner';
 import React from 'react';
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
 
 // BannerPage does NOT have getPConnect. So, no need to extend from PConnProps
 
@@ -20,6 +20,9 @@ interface BannerPageProps {
  * BannerPage template.
  */
 export default function BannerPage(props: BannerPageProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const Banner = getComponentFromMap('Banner');
+
   const {
     children,
     layout = 'two-column',

package/tests/assets/components/SDK-React/create/override-sdk/template/CaseSummary/CaseSummary.tsx

@@ -1,6 +1,6 @@
 import React from "react";
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
 
-import CaseSummaryFields from '@pega/react-sdk-components/lib/components/designSystemExtension/CaseSummaryFields';
 import type { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
 
 interface CaseSummaryProps extends PConnProps {
@@ -10,6 +10,9 @@ interface CaseSummaryProps extends PConnProps {
 
 
 export default function CaseSummary(props: CaseSummaryProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const CaseSummaryFields = getComponentFromMap('CaseSummaryFields');
+
   const { getPConnect, children } = props;
   const thePConn = getPConnect();
   const theConfigProps = thePConn.getConfigProps();

package/tests/assets/components/SDK-React/create/override-sdk/template/CaseView/CaseView.tsx

@@ -9,9 +9,7 @@ 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 { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
 
 import type { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
 
@@ -58,12 +56,19 @@ const useStyles = makeStyles(theme => ({
 }));
 
 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,
+    children = [],
+    // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
+    showIconInHeader = true,
     caseInfo: {
       availableActions = [],
       availableProcesses = [],
@@ -288,11 +293,3 @@ export default function CaseView(props: CaseViewProps) {
 
   return getContainerContents();
 }
-
-CaseView.defaultProps = {
-  icon: '',
-  children: [],
-  caseInfo: {},
-  showIconInHeader: true,
-  getPConnect: null
-};

package/tests/assets/components/SDK-React/create/override-sdk/template/Confirmation/Confirmation.tsx

@@ -1,28 +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 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';
 
-// XX does NOT have getPConnect. So, no need to extend from PConnProps
+// Confirmation does NOT have getPConnect. So, no need to extend from PConnProps
 
 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
+  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),
@@ -36,6 +33,10 @@ const useStyles = makeStyles(theme => ({
 }));
 
 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);
@@ -43,20 +44,12 @@ export default function Confirmation(props: ConfirmationProps) {
   // 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());
@@ -64,36 +57,22 @@ export default function Confirmation(props: ConfirmationProps) {
   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;
 }