@pega/dx-component-builder-sdk 0.24.3 → 0.24.6

package/src/tasks/create/templates/SDK-React/field/Decimal-Currency/config.json.mustache

@@ -58,6 +58,34 @@
         }
       ]
     },
+    {
+      "label": "Column settings",
+      "format": "GROUP",
+      "visibility": "@VIEWTYPE == 'MultiRecordDisplayAsTable'",
+      "properties": [
+        {
+          "name": "columnWidth",
+          "label": "Column width",
+          "format": "SELECT",
+          "source": [
+            {
+              "key": "auto",
+              "value": "Auto"
+            },
+            {
+              "key": "custom",
+              "value": "Custom"
+            }
+          ]
+        },
+        {
+          "name": "width",
+          "label": "Width (px)",
+          "format": "NUMBER",
+          "visibility": "$this.columnWidth == 'custom'"
+        }
+      ]
+    },
     {
       "label": "Input settings",
       "format": "GROUP",
@@ -69,6 +97,12 @@
           "format": "BOOLEAN",
           "defaultValue": true
         },
+        {
+          "name": "alwaysShowISOCode",
+          "label": "Show ISO Code",
+          "format": "BOOLEAN",
+          "defaultValue": false
+        },
         {
           "name": "placeholder",
           "label": "Placeholder",
@@ -81,6 +115,138 @@
         }
       ]
     },
+    {
+      "label": "Read-only settings",
+      "format": "GROUP",
+      "properties": [
+        {
+          "format": "SELECT",
+          "name": "formatter",
+          "label": "Format",
+          "defaultValue": "defaultCurrency",
+          "source": [
+            {
+              "key": "defaultCurrency",
+              "value": "Default"
+            },
+            {
+              "key": "Integer",
+              "value": "Integer"
+            },
+            {
+              "key": "Decimal",
+              "value": "Decimal"
+            },
+            {
+              "key": "Percentage",
+              "value": "Percentage"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "format": "SELECT",
+      "name": "currencyDisplay",
+      "label": "Currency display",
+      "visibility": "(!formatter = Integer)&&(!formatter = Decimal)&&(!formatter = Percentage)",
+      "defaultValue": "symbol",
+      "source": [
+        {
+          "key": "symbol",
+          "value": "Auto"
+        },
+        {
+          "key": "code",
+          "value": "Code"
+        },
+        {
+          "key": "name",
+          "value": "Name"
+        }
+      ]
+    },
+    {
+      "format": "SELECT",
+      "name": "negative",
+      "label": "Negative number display",
+      "defaultValue": "minus-sign",
+      "visibility": "(!formatter = Integer)&&(!formatter = Decimal)&&(!formatter = Percentage)",
+      "source": [
+        {
+          "key": "minus-sign",
+          "value": "Standard"
+        },
+        {
+          "key": "parentheses",
+          "value": "Accounting"
+        }
+      ]
+    },
+    {
+      "format": "SELECT",
+      "name": "notation",
+      "label": "Notation",
+      "visibility": "(!negative = parentheses)&&(!formatter = Percentage)",
+      "defaultValue": "standard",
+      "source": [
+        {
+          "key": "standard",
+          "value": "Standard"
+        },
+        {
+          "key": "compact",
+          "value": "Compact"
+        }
+      ]
+    },
+    {
+      "format": "NUMBER",
+      "name": "decimalPrecision",
+      "label": "Decimal places",
+      "visibility": "(formatter = Decimal)||(formatter = Percentage)",
+      "min": 0,
+      "max": 20
+    },
+    {
+      "format": "SELECT",
+      "name": "currencyDecimalPrecision",
+      "label": "Decimal places shown",
+      "visibility": "(!formatter = Integer)&&(!formatter = Decimal)&&(!formatter = Percentage)",
+      "defaultValue": "auto",
+      "source": [
+        {
+          "key": "auto",
+          "value": "Auto"
+        },
+        {
+          "key": "0",
+          "value": "None"
+        },
+        {
+          "key": "1",
+          "value": "1"
+        },
+        {
+          "key": "2",
+          "value": "2"
+        },
+        {
+          "key": "3",
+          "value": "3"
+        },
+        {
+          "key": "4",
+          "value": "4"
+        }
+      ]
+    },
+    {
+      "name": "showGroupSeparators",
+      "label": "Show thousands separator",
+      "format": "BOOLEAN",
+      "visibility": "(formatter = Decimal)||(formatter = Integer)"
+    },
     {
       "label": "Conditions",
       "format": "GROUP",

package/src/tasks/create/templates/SDK-React/field/Text-Phone/index.tsx.mustache

@@ -1,7 +1,9 @@
 import MuiPhoneNumber from 'material-ui-phone-number';
+import { useEffect, useState } from 'react';
 
 import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
 import { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-utils';
 
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
 
@@ -17,6 +19,7 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
   const FieldValueList = getComponentFromMap('FieldValueList');
 
   const {
+    getPConnect,
     label,
     required,
     disabled,
@@ -24,7 +27,6 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
     validatemessage,
     status,
     onChange,
-    onBlur,
     readOnly,
     testId,
     helperText,
@@ -32,6 +34,14 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
     hideLabel,
     placeholder
   } = props;
+
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = (pConn.getStateProps() as any).value;
+
+  const [inputValue, setInputValue] = useState(value);
+  useEffect(() => setInputValue(value), [value]);
+
   const helperTextToDisplay = validatemessage || helperText;
 
   let testProp = {};
@@ -79,15 +89,14 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
   }
 
   const handleChange = inputVal => {
-    let phoneValue = inputVal && inputVal.replace(/\D+/g, '');
-    phoneValue = `+${phoneValue}`;
-    onChange({ value: phoneValue });
+    setInputValue(inputVal);
   };
 
   const handleBlur = event => {
     const phoneValue = event?.target?.value;
-    event.target.value = `+${phoneValue && phoneValue.replace(/\D+/g, '')}`;
-    onBlur(event);
+    let phoneNumber = phoneValue.split(' ').slice(1).join();
+    phoneNumber = phoneNumber ? `+${phoneValue && phoneValue.replace(/\D+/g, '')}` : '';
+    handleEvent(actions, 'changeNblur', propName, phoneNumber);
   };
 
   return (
@@ -105,7 +114,7 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
         onBlur={!readOnly ? handleBlur : undefined}
         error={status === 'error'}
         label={label}
-        value={value}
+        value={inputValue}
         {{! pick new delimiters for mustache }}
         {{=<% %>=}}
         InputProps={{ ...testProp }}

package/src/tasks/create/templates/SDK-React/template/DETAILS/mock.ts.mustache

@@ -190,7 +190,24 @@ export const pyReviewRaw = {
           value: '+16397975093',
           label: 'Phone',
           displayMode: 'LABELS_LEFT',
-          hasSuggestions: false
+          hasSuggestions: false,
+          getPConnect: () => {
+            return {
+              getActionsApi: () => {
+                return {
+                  updateFieldValue: () => {
+                    /* nothing */
+                  },
+                  triggerFieldChange: () => {
+                    /* nothing */
+                  }
+                };
+              },
+              getStateProps: () => {
+                return { value: '' };
+              }
+            };
+          }
         },
         {
           readOnly: undefined,

package/src/tasks/create/templates/SDK-React/template/FORM/demo.stories.tsx.mustache

@@ -182,6 +182,19 @@ export const Base{{COMPONENT_CLASS_NAME}}: Story = args => {
                           return {
                             getComputedVisibility: () => {
                               return true;
+                            },
+                            getActionsApi: () => {
+                              return {
+                                updateFieldValue: () => {
+                                  /* nothing */
+                                },
+                                triggerFieldChange: () => {
+                                  /* nothing */
+                                }
+                              };
+                            },
+                            getStateProps: () => {
+                              return { value: '' };
                             }
                           };
                         }

package/src/tasks/create/templates/SDK-React/widget/CASE/demo.stories.tsx.mustache

@@ -3,26 +3,6 @@ import type { Meta, StoryObj } from '@storybook/react';
 import {{COMPONENT_CLASS_NAME}} from './index';
 import { historyData } from './mock';
 
-window.PCore = {
-  ...window.PCore,
-  getDataApiUtils: (): any => {
-    return {
-      getData: (): any => {
-        return new Promise(resolve => {
-          resolve(historyData);
-        });
-      }
-    };
-  },
-  getConstants: (): any => {
-    return {
-      CASE_INFO: {
-        CASE_INFO_ID: 'caseInfo.ID'
-      }
-    };
-  }
-};
-
 const meta: Meta<typeof {{COMPONENT_CLASS_NAME}}> = {
   title: '{{COMPONENT_CLASS_NAME}}',
   component: {{COMPONENT_CLASS_NAME}},
@@ -33,6 +13,26 @@ export default meta;
 type Story = StoryObj<typeof {{COMPONENT_CLASS_NAME}}>;
 
 export const Base{{COMPONENT_CLASS_NAME}}: Story = args => {
+  window.PCore = {
+    ...window.PCore,
+    getDataApiUtils: (): any => {
+      return {
+        getData: (): any => {
+          return new Promise(resolve => {
+            resolve(historyData);
+          });
+        }
+      };
+    },
+    getConstants: (): any => {
+      return {
+        CASE_INFO: {
+          CASE_INFO_ID: 'caseInfo.ID'
+        }
+      };
+    }
+  };
+
   const props = {
     label: 'Case history',
 

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

@@ -1,7 +1,7 @@
 import type { Meta, StoryObj } from '@storybook/react';
 
 import {{COMPONENT_CLASS_NAME}} from './index';
-import { configProps } from './mock';
+import { configProps, worklistData } from './mock';
 
 const meta: Meta<typeof {{COMPONENT_CLASS_NAME}}> = {
   title: '{{COMPONENT_CLASS_NAME}}',
@@ -13,9 +13,52 @@ export default meta;
 type Story = StoryObj<typeof {{COMPONENT_CLASS_NAME}}>;
 
 export const Base{{COMPONENT_CLASS_NAME}}: Story = args => {
+    window.PCore = {
+    ...window.PCore,
+    getDataApiUtils: (): any => {
+      return {
+        getData: () => {
+          return new Promise(resolve => {
+            resolve(worklistData);
+          });
+        }
+      };
+    },
+    getConstants: (): any => {
+      return {
+        CASE_INFO: {
+          INSTRUCTIONS: 'caseInfo.assignments[0].instructions'
+        }
+      };
+    },
+  };
+
   const props = {
     datasource: configProps.datasource,
-    whatsnewlink: configProps.whatsnewlink
+    whatsnewlink: configProps.whatsnewlink,
+    getPConnect: () => {
+      return {
+        getValue: value => {
+          return value;
+        },
+        getContextName: () => {
+          return 'app/primary_1';
+        },
+        getLocalizedValue: value => {
+          return value;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {
+              /* nothing */
+            },
+            triggerFieldChange: () => {
+              /* nothing */
+            }
+          };
+        }
+      };
+    }
   };
 
   return <{{COMPONENT_CLASS_NAME}} {...props} {...args} />;

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

@@ -1,7 +1,26 @@
-import { Card, CardContent, CardHeader, Typography, CardActions, Button } from '@material-ui/core';
+import { 
+  Card, 
+  CardContent, 
+  CardHeader, 
+  Typography,
+  CardActions, 
+  Button,
+  TableContainer,
+  Table,
+  TableBody,
+  TableHead,
+  withStyles,
+  createStyles,
+  Theme,
+  TableCell,
+  TableRow 
+} from '@material-ui/core';
 import { makeStyles } from '@material-ui/core/styles';
 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';
 
 interface {{COMPONENT_CLASS_NAME}}Props extends PConnProps {
   // If any, enter additional props that only exist on this component
@@ -20,13 +39,29 @@ const useStyles = makeStyles(theme => ({
   }
 }));
 
-// Duplicated runtime code from React SDK
+const StyledTableCell = withStyles((theme: Theme) =>
+  createStyles({
+    head: {
+      borderWidth: '1px',
+      borderStyle: 'solid',
+      borderColor: 'silver',
+      backgroundColor: theme.palette.text.disabled,
+      color: theme.palette.getContrastText(theme.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 = '' } = props;
+  const { header = '', description = '', datasource = [], whatsnewlink = '', getPConnect } = props;
   let details = [];
   if (datasource && datasource.source) {
     details = datasource.source.map(item => {
@@ -34,12 +69,136 @@ 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_pyWorkHistory';
+  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}>
@@ -63,6 +222,12 @@ 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/mock.ts.mustache

@@ -21,3 +21,28 @@ export const configProps = {
     fields: {}
   }
 };
+
+export const worklistData = {
+  data: {
+    data: [
+      {
+        pxProcessName: 'Loan',
+        pxRefObjectInsName: ' A-8002',
+        pyAssignmentStatus: 'New',
+        pxTaskLabel: 'Details'
+      },
+      {
+        pxProcessName: 'Loan',
+        pxRefObjectInsName: ' A-7001',
+        pyAssignmentStatus: 'Open',
+        pxTaskLabel: 'Info'
+      },
+      {
+        pxProcessName: 'Loan',
+        pxRefObjectInsName: ' A-9000',
+        pyAssignmentStatus: 'Open',
+        pxTaskLabel: 'Amount'
+      }
+    ]
+  }
+};