@pega/dx-component-builder-sdk 25.1.16 → 26.1.10

package/src/tasks/create/templates/SDK-React/widget/PAGE/index.tsx.mustache

@@ -4,29 +4,12 @@ import {
   CardHeader,
   Typography,
   CardActions,
-  Button,
-  TableContainer,
-  Table,
-  TableBody,
-  TableHead,
-  TableCell,
-  TableRow
+  Button
 } from '@mui/material';
-import { withStyles, createStyles } from '@mui/styles';
 import makeStyles from '@mui/styles/makeStyles';
 import { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
 
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
-import isDeepEqual from 'fast-deep-equal/react';
-import { Utils } from '@pega/react-sdk-components/lib/components/helpers/utils';
-import { useRef, useEffect, useState } from 'react';
-import { Theme as MuiTheme } from "@mui/material/styles";
-
-declare module "@mui/private-theming" {
-  interface DefaultTheme extends MuiTheme {
-    spacing: (spacing: number) => string;
-  }
-}
 
 interface {{COMPONENT_CLASS_NAME}}Props extends PConnProps {
   // If any, enter additional props that only exist on this component
@@ -45,29 +28,11 @@ const useStyles = makeStyles(myTheme => ({
   }
 }));
 
-const StyledTableCell = withStyles((myTheme) =>
-  createStyles({
-    head: {
-      borderWidth: '1px',
-      borderStyle: 'solid',
-      borderColor: 'silver',
-      backgroundColor: myTheme.palette.text.disabled,
-      color: myTheme.palette.getContrastText(myTheme.palette.text.disabled)
-    },
-    body: {
-      borderWidth: '1px',
-      borderStyle: 'solid',
-      borderColor: 'silver'
-      // fontSize: 14,
-    }
-  })
-)(TableCell);
-
 // Page Widget example is the "App Announcment"
 
 // props passed in combination of props from property panel (config.json) and run time props from Constellation
 export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
-  const { header = '', description = '', datasource = [], whatsnewlink = '', getPConnect } = props;
+  const { header = '', description = '', datasource = [], whatsnewlink = '' } = props;
   let details = [];
   if (datasource && datasource.source) {
     details = datasource.source.map(item => {
@@ -75,136 +40,12 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
     });
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  const [waitingForData, setWaitingForData] = useState<boolean>(true);
-  const thePConn = getPConnect();
-  const caseID = thePConn.getValue(PCore.getConstants().CASE_INFO.CASE_INFO_ID, ''); // 2nd arg empty string until typedef marked correctly
-  const dataViewName = 'D_pyMyWorkList';
-  const context = thePConn.getContextName();
-
-  const rowData: any = useRef([]);
-
   const classes = useStyles();
 
-  const displayedColumns = [
-    {
-      label: thePConn.getLocalizedValue('Case type', '', ''),
-      type: 'TextInput',
-      fieldName: 'pxProcessName'
-    }, // 2nd and 3rd args empty string until typedef marked correctly
-    {
-      label: thePConn.getLocalizedValue('Key', '', ''),
-      type: 'TextInput',
-      fieldName: 'pxRefObjectInsName'
-    }, // 2nd and 3rd args empty string until typedef marked correctly
-    {
-      label: thePConn.getLocalizedValue('Status', '', ''),
-      type: 'TextInput',
-      fieldName: 'pyAssignmentStatus'
-    }, // 2nd and 3rd args empty string until typedef marked correctly
-    {
-      label: thePConn.getLocalizedValue('Stage', '', ''),
-      type: 'TextInput',
-      fieldName: 'pxTaskLabel'
-    } // 2nd and 3rd args empty string until typedef marked correctly
-  ];
-
-  function computeRowData(rows: object[]): void {
-    const theRowData: object[] = [];
-
-    rows?.forEach((row: any, rowIndex: number) => {
-      // Now, for each property in the index of row properties (displayedColumns), add an object
-      //  to a new array of values
-      const rowDisplayValues: any = [];
-
-      displayedColumns.forEach((column: any, rowValIndex) => {
-        const theType = column.type;
-        const theFieldName = column.fieldName;
-        const theValue =
-          theType === 'Date' || theType === 'DateTime' ? Utils.generateDateTime(row[theFieldName], 'DateTime-Short') : row[theFieldName];
-        rowDisplayValues[rowValIndex] = theValue;
-      });
-
-      theRowData[rowIndex] = rowDisplayValues;
-    });
-
-    if (!isDeepEqual(theRowData, rowData.current)) {
-      // Only update rowData.current when it actually changes (to prevent infinite loop)
-      rowData.current = theRowData;
-    }
-  }
-
   const handleClick = () => {
     window.open(whatsnewlink);
   };
 
-  // Get the case history data when component mounted/initialized
-  useEffect(() => {
-    let bCallSetWaitingForData = true;
-
-    const worklistData = PCore.getDataApiUtils().getData(
-      dataViewName,
-      { dataViewParameters: [{ CaseInstanceKey: caseID }] } as any,
-      context
-    ) as Promise<any>;
-
-    worklistData.then((worklistJSON: any) => {
-      const tableDataResults = worklistJSON.data.data;
-
-      // compute the rowData using the tableDataResults
-      computeRowData(tableDataResults);
-
-      // At this point, if we have data ready to render and haven't been asked
-      //  to NOT call setWaitingForData, we can stop progress indicator
-      if (bCallSetWaitingForData) {
-        setWaitingForData(false);
-      }
-    });
-
-    return () => {
-      // Inspired by https://juliangaramendy.dev/blog/use-promise-subscription
-      // The useEffect closure lets us have access to the bCallSetWaitingForData
-      //  variable inside the useEffect and inside the "then" clause of the
-      //  historyData promise
-      //  So, if this cleanup code gets run before the promise .then is called,
-      //  we can avoid calling the useState setter which would otherwise show a warning
-      bCallSetWaitingForData = false;
-    };
-  }, []);
-
-  function getTableHeader() {
-    const theRowKey = 'CaseHistory.TableHeader';
-
-    const theHeaderCells: any[] = displayedColumns.map((headerCol, index) => {
-      const theCellKey = `${theRowKey}.${index}`;
-      return <StyledTableCell key={theCellKey}>{headerCol.label}</StyledTableCell>;
-    });
-
-    return <TableRow key={theRowKey}>{theHeaderCells}</TableRow>;
-  }
-
-  function getTableData() {
-    const theDataRows: any[] = [];
-
-    // Note: using rowData.current since we're using useRef as a mutatable
-    //  value that's only updated when it changes.
-    if (rowData.current.length > 0) {
-      rowData.current.forEach((dataRow: object[], index) => {
-        // using dataRow[0]-dataRow[1] as the array key since it's a unique value
-        const theKey = `CaseHistory-${index}`;
-        theDataRows.push(
-          <TableRow key={theKey}>
-            <StyledTableCell>{dataRow[0] ? (dataRow[0]) : '---' as any}</StyledTableCell>
-            <StyledTableCell>{dataRow[1] ? (dataRow[1]) : '---' as any}</StyledTableCell>
-            <StyledTableCell>{dataRow[2] ? (dataRow[2]) : '---' as any}</StyledTableCell>
-            <StyledTableCell>{dataRow[3] ? (dataRow[3]) : '---' as any}</StyledTableCell>
-          </TableRow>
-        );
-      });
-    }
-    return theDataRows;
-  }
-
   return (
     <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
       <Card title='AppAnnouncement' className={classes.root}>
@@ -228,12 +69,6 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
           </Button>
         </CardActions>
       </Card>
-      <TableContainer>
-        <Table>
-          <TableHead>{getTableHeader()}</TableHead>
-          <TableBody>{getTableData()}</TableBody>
-        </Table>
-      </TableContainer>
     </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
   );
 }

package/src/tasks/create/templates/SDK-React/widget/PAGE-CASE/index.tsx.mustache

@@ -4,7 +4,6 @@ import Popover from '@mui/material/Popover';
 import Grid2 from '@mui/material/Grid2';
 import Typography from '@mui/material/Typography';
 import makeStyles from '@mui/styles/makeStyles';
-import { Theme as MuiTheme } from "@mui/material/styles";
 
 import Utils from '@pega/react-sdk-components/lib/components/helpers/utils';
 
@@ -12,12 +11,6 @@ import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
 
 import { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
 
-declare module "@mui/private-theming" {
-  interface DefaultTheme extends MuiTheme {
-    spacing: (spacing: number) => string;
-  }
-}
-
 interface {{COMPONENT_CLASS_NAME}}Props extends PConnProps {
   // If any, enter additional props that only exist on this component
   label: string;
@@ -28,6 +21,7 @@ interface {{COMPONENT_CLASS_NAME}}Props extends PConnProps {
   updateLabel: string;
   updateOperator: { userName: string; userId: string };
   displayLabel?: any;
+  displayMode?: string;
 }
 
 const useStyles = makeStyles(myTheme => ({
@@ -38,6 +32,13 @@ const useStyles = makeStyles(myTheme => ({
   popover: {
     padding: myTheme.spacing(1),
     margin: myTheme.spacing(1)
+  },
+  fieldLabel: {
+    fontWeight: 400,
+    color: myTheme.palette.text.secondary
+  },
+  fieldValue: {
+    color: myTheme.palette.text.primary
   }
 }));
 
@@ -85,7 +86,8 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
     const localizedVal = PCore.getLocaleUtils().getLocaleValue;
     const localeCategory = 'Operator';
 
-    operatorPreviewPromise.then((res: any) => {
+    operatorPreviewPromise
+      .then((res: any) => {
       const fillerString = '---';
       let fields: any = [];
       if (res.data && res.data.pyOperatorInfo && res.data.pyOperatorInfo.pyUserName) {
@@ -158,7 +160,10 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
       }
       // Whatever the fields are, update the component's popoverFields
       setPopoverFields(fields);
-    });
+      })
+      .catch(e => {
+        console.error(e);
+      });
 
     setPopoverAnchorEl(event.currentTarget);
   }
@@ -184,7 +189,7 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
           return (
             <React.Fragment key={field.id}>
               <Grid2 container size={{ xs: 12 }} spacing={1}>
-                <Grid2 size={{ xs: 12 }}>
+                <Grid2 size={{ xs: 6 }}>
                   <Typography variant='caption'>{field.name}</Typography>
                 </Grid2>
                 <Grid2 size={{ xs: 6 }}>
@@ -201,19 +206,69 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
 
   // End of popover-related
 
+  const { displayMode } = props;
+
+  if (displayMode === 'DISPLAY_ONLY') {
+    return (
+      <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+        <>
+          {{! pick new delimiters for mustache }}
+          {{=<% %>=}}
+          <Grid2 container spacing={4} justifyContent='space-between'>
+            <Grid2 size={{ xs: 4 }}>
+              <Typography variant='body2' component='span' className={classes.fieldLabel}>
+                {caseOpLabel}
+              </Typography>
+            </Grid2>
+            <Grid2 size={{ xs: 8 }}>
+              <div style={{ display: 'flex', flexWrap: 'wrap', gap: '0.5rem', alignItems: 'baseline' }}>
+                <Typography variant='body2' component='span' className={classes.fieldValue} onClick={showOperatorDetails} sx={{ cursor: 'pointer' }}>
+                  {caseOpName}
+                </Typography>
+                <Typography variant='caption' component='span' sx={{ color: 'text.secondary' }}>
+                  {Utils.generateDateTime(caseTime, 'DateTime-Since')}
+                </Typography>
+              </div>
+            </Grid2>
+          </Grid2>
+          <%={{ }}=%>     {{! revert delimiters for mustache }}
+          <Popover
+            id={popoverId}
+            open={popoverOpen}
+            anchorEl={popoverAnchorEl}
+            onClose={handlePopoverClose}
+            {{! pick new delimiters for mustache }}
+            {{=<% %>=}}
+            anchorOrigin={{ vertical: 'bottom', horizontal: 'center' }}
+            transformOrigin={{ vertical: 'top', horizontal: 'center' }}
+            slotProps={{
+              paper: { style: { maxWidth: '45ch' } }
+            }}
+            <%={{ }}=%>     {{! revert delimiters for mustache }}
+          >
+            {getPopoverGrid()}
+          </Popover>
+        </>
+      </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    );
+  }
+
   return (
     <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
       <>
         {{! pick new delimiters for mustache }}
         {{=<% %>=}}
         <TextField
+          variant='standard'
           defaultValue={caseOpName}
           label={caseOpLabel}
           onClick={showOperatorDetails}
-          InputProps={{
-            readOnly: true,
-            disableUnderline: true,
-            inputProps: { style: { cursor: 'pointer' } }
+          slotProps={{
+            input: {
+              readOnly: true,
+              disableUnderline: true,
+              inputProps: { style: { cursor: 'pointer' } }
+            }
           }}
         />
         <br />
@@ -228,7 +283,9 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
           {{=<% %>=}}
           anchorOrigin={{ vertical: 'bottom', horizontal: 'center' }}
           transformOrigin={{ vertical: 'top', horizontal: 'center' }}
-          PaperProps={{ style: { maxWidth: '45ch' } }}
+          slotProps={{
+            paper: { style: { maxWidth: '45ch' } }
+          }}
           <%={{ }}=%>     {{! revert delimiters for mustache }}
         >
           {getPopoverGrid()}

package/tests/assets/sdk-r/components/create/custom-sdk/field/Pega_DXIL_MyTestText/index.tsx

@@ -4,12 +4,20 @@ import { TextField } from '@mui/material';
 import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-utils';
 import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
 import { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+import useStatus from '@pega/react-sdk-components/lib/hooks/useStatus';
+import { getFieldSx } from '@pega/react-sdk-components/lib/components/helpers/field-utils';
 
 import StyledPegaDxilMyTestTextWrapper from './styles';
 
 interface PegaDxilMyTestTextProps extends PConnFieldProps {
   // If any, enter additional props that only exist on this componentName
   fieldMetadata?: any;
+  showFieldMessage?: boolean;
+  messageConfig?: {
+    content?: string;
+    visibility?: boolean;
+  };
+  variant?: string;
 }
 
 // Duplicated runtime code from React SDK
@@ -26,7 +34,6 @@ export default function PegaDxilMyTestText(props: PegaDxilMyTestTextProps) {
     disabled,
     value = '',
     validatemessage,
-    status,
     /* onChange, onBlur */
     readOnly,
     testId,
@@ -34,14 +41,23 @@ export default function PegaDxilMyTestText(props: PegaDxilMyTestTextProps) {
     helperText,
     displayMode,
     hideLabel,
-    placeholder
+    placeholder,
+    showFieldMessage,
+    messageConfig = {}
   } = props;
 
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
   const propName = (pConn.getStateProps() as any).value;
+  const eligibleForFieldWarning = showFieldMessage && messageConfig.visibility && !readOnly;
+  const helperTextToDisplay = validatemessage || (eligibleForFieldWarning ? messageConfig.content : helperText);
 
-  const helperTextToDisplay = validatemessage || helperText;
+  const status = useStatus({
+    showFieldMessage,
+    messageVisibility: messageConfig.visibility,
+    validatemessage,
+    readOnly
+  });
 
   const [inputValue, setInputValue] = useState('');
   const maxLength = fieldMetadata?.maxLength;
@@ -53,22 +69,14 @@ export default function PegaDxilMyTestText(props: PegaDxilMyTestTextProps) {
   }, [value]);
 
   if (displayMode === 'DISPLAY_ONLY') {
-    return <FieldValueList name={hideLabel ? '' : label} value={value} />;
-  }
-
-  if (displayMode === 'STACKED_LARGE_VAL') {
-    return <FieldValueList name={hideLabel ? '' : label} value={value} variant='stacked' />;
+    return <FieldValueList name={hideLabel ? '' : label} value={value} variant={props.variant} />;
   }
 
   if (readOnly) {
     readOnlyProp = { readOnly: true };
   }
 
-  let testProp = {};
-
-  testProp = {
-    'data-test-id': testId
-  };
+  const testProps: any = { 'data-test-id': testId };
 
   function handleChange(event) {
     // update internal value
@@ -94,7 +102,10 @@ export default function PegaDxilMyTestText(props: PegaDxilMyTestTextProps) {
         error={status === 'error'}
         label={label}
         value={inputValue}
-        InputProps={{ ...readOnlyProp, inputProps: { maxLength, ...testProp } }}
+        slotProps={{
+          input: { ...readOnlyProp, inputProps: { maxLength, ...testProps } }
+        }}
+        sx={getFieldSx(status)}
       />
     </StyledPegaDxilMyTestTextWrapper>
   );

package/tests/assets/sdk-r/components/create/override-sdk/designSystemExtension/AlertBanner/AlertBanner.css

@@ -0,0 +1,46 @@
+.alert-banner-title {
+  font-weight: 700;
+  font-size: 1rem;
+  display: flex;
+  align-items: center;
+  gap: 0.25rem;
+}
+
+.alert-banner-badge {
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
+  min-width: 1rem;
+  height: 1rem;
+  padding: 0 0.2rem;
+  border-radius: 999px;
+  font-size: 0.6rem;
+  font-weight: 700;
+  line-height: 1;
+  vertical-align: middle;
+}
+
+.alert-banner-badge--urgent {
+  background: var(--app-error-dark-color);
+  color: #fff;
+}
+
+.alert-banner-badge--warning {
+  background: var(--app-warning-color-dark);
+  color: #fff;
+}
+
+.alert-banner-badge--success {
+  background: var(--stepper-completed-bg-color);
+  color: #fff;
+}
+
+.alert-banner-badge--info {
+  background: var(--link-button-color);
+  color: #fff;
+}
+
+.alert-banner-list {
+  margin: 0;
+  padding-left: 1.25rem;
+}

package/tests/assets/sdk-r/components/create/override-sdk/designSystemExtension/AlertBanner/AlertBanner.tsx

@@ -1,39 +1,56 @@
-import { Alert } from '@mui/material';
+import { Alert, AlertTitle } from '@mui/material';
+import './AlertBanner.css';
 
 // AlertBanner is one of the few components that does NOT have getPConnect.
 //  So, no need to extend PConnProps
 interface AlertBannerProps {
-  // If any, enter additional props that only exist on Date here
   id: string;
   variant: string;
   messages: string[];
   onDismiss?: any;
 }
 
-const SEVERITY_MAP = {
-  urgent: 'error',
-  warning: 'warning',
-  success: 'success',
-  info: 'info'
+const VARIANT_MAP: Record<string, { severity: string; label: string }> = {
+  urgent: { severity: 'error', label: 'Error' },
+  warning: { severity: 'warning', label: 'Warning' },
+  success: { severity: 'success', label: 'Success' },
+  info: { severity: 'info', label: 'Info' }
 };
 
-export default function AlertBanner(props: AlertBannerProps) {
-  const { id, variant, messages, onDismiss } = props;
-  let additionalProps = {};
+function renderMessage(message: string) {
+  const colonIndex = message.indexOf(':');
+  if (colonIndex === -1) return message;
+  return (
+    <>
+      <strong>{message.slice(0, colonIndex + 1)}</strong>
+      {message.slice(colonIndex + 1)}
+    </>
+  );
+}
 
-  if (onDismiss) {
-    additionalProps = {
-      onClose: onDismiss
-    };
-  }
+export default function AlertBanner({ id, variant, messages, onDismiss }: AlertBannerProps) {
+  const { severity, label } = VARIANT_MAP[variant] ?? VARIANT_MAP.info;
+  const isMultiple = messages.length > 1;
 
   return (
     <div id={id}>
-      {messages.map(message => (
-        <Alert key={message} variant='outlined' severity={SEVERITY_MAP[variant]} {...additionalProps}>
-          {message}
-        </Alert>
-      ))}
+      <Alert variant='outlined' severity={severity as any} {...(onDismiss && { onClose: onDismiss })}>
+        {isMultiple && (
+          <AlertTitle className='alert-banner-title'>
+            {label}
+            <span className={`alert-banner-badge alert-banner-badge--${variant}`}>{messages.length}</span>
+          </AlertTitle>
+        )}
+        {isMultiple ? (
+          <ul className='alert-banner-list'>
+            {messages.map(message => (
+              <li key={message}>{renderMessage(message)}</li>
+            ))}
+          </ul>
+        ) : (
+          renderMessage(messages[0])
+        )}
+      </Alert>
     </div>
   );
 }

package/tests/assets/sdk-r/components/create/override-sdk/designSystemExtension/CaseSummaryFields/CaseSummaryFields.css

@@ -14,3 +14,17 @@
   padding: calc(2 * 0.5rem);
   grid-row-gap: calc(2 * 0.5rem);
 }
+
+.psdk-case-summary-fields .label {
+  font-size: 0.8rem;
+  color: #c0c0c0;
+}
+
+.psdk-case-summary-object-ref {
+  text-align: left;
+}
+
+.psdk-case-summary-object-ref-value * {
+  justify-content: flex-start;
+  text-align: left;
+}