@pega/dx-component-builder-sdk 23.1.13 → 23.1.15

package/tests/assets/sdk-r/components/create/override-sdk/field/Checkbox/Checkbox.tsx

@@ -1,26 +1,44 @@
+/* eslint-disable react/no-array-index-key */
 import { useState, useEffect } from 'react';
-import { Checkbox, FormControl, FormControlLabel, FormGroup, FormHelperText } from '@material-ui/core';
+import { Checkbox, FormControl, FormControlLabel, FormGroup, FormHelperText, FormLabel } from '@material-ui/core';
 
 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 { insertInstruction, deleteInstruction, updateNewInstuctions } from '@pega/react-sdk-components/lib/components/helpers/instructions-utils';
 import { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+import { makeStyles } from '@material-ui/core/styles';
 
 interface CheckboxProps extends Omit<PConnFieldProps, 'value'> {
   // If any, enter additional props that only exist on Checkbox here
   value?: boolean;
-  // eslint-disable-next-line react/no-unused-prop-types
   caption?: string;
   trueLabel?: string;
   falseLabel?: string;
+  selectionMode?: string;
+  datasource?: any;
+  selectionKey?: string;
+  selectionList?: any;
+  primaryField: string;
+  readonlyContextList: any;
+  referenceList: string;
 }
 
+const useStyles = makeStyles(() => ({
+  checkbox: {
+    display: 'flex',
+    flexDirection: 'column'
+  }
+}));
+
 export default function CheckboxComponent(props: CheckboxProps) {
   // Get emitted components from map (so we can get any override that may exist)
   const FieldValueList = getComponentFromMap('FieldValueList');
 
   const {
     getPConnect,
-    value = false,
+    label,
+    caption,
+    value,
     readOnly,
     testId,
     required,
@@ -31,22 +49,34 @@ export default function CheckboxComponent(props: CheckboxProps) {
     displayMode,
     hideLabel,
     trueLabel,
-    falseLabel
+    falseLabel,
+    selectionMode,
+    datasource,
+    selectionKey,
+    selectionList,
+    primaryField,
+    referenceList,
+    readonlyContextList: selectedvalues
   } = props;
+  const classes = useStyles();
   const helperTextToDisplay = validatemessage || helperText;
-
   const thePConn = getPConnect();
-  const theConfigProps = thePConn.getConfigProps() as CheckboxProps;
-  const caption = theConfigProps.caption;
   const actionsApi = thePConn.getActionsApi();
   const propName = (thePConn.getStateProps() as any).value;
 
-  const [checked, setChecked] = useState(false);
+  const [checked, setChecked] = useState<any>(false);
   useEffect(() => {
     // This update theSelectedButton which will update the UI to show the selected button correctly
     setChecked(value);
   }, [value]);
 
+  useEffect(() => {
+    if (referenceList?.length > 0) {
+      thePConn.setReferenceList(selectionList);
+      updateNewInstuctions(thePConn, selectionList);
+    }
+  }, [thePConn]);
+
   if (displayMode === 'LABELS_LEFT') {
     return <FieldValueList name={hideLabel ? '' : caption} value={value ? trueLabel : falseLabel} />;
   }
@@ -63,27 +93,77 @@ export default function CheckboxComponent(props: CheckboxProps) {
     thePConn.getValidationApi().validate(event.target.checked);
   };
 
-  let theCheckbox = <Checkbox color='primary' disabled={disabled} />;
-
-  if (readOnly) {
-    // Workaround for lack of InputProps readOnly from https://github.com/mui-org/material-ui/issues/17043
-    //  Also note that we need to turn off the onChange call in the FormControlLabel wrapper, too. See below!
-    theCheckbox = <Checkbox value={value || false} readOnly={readOnly} />;
-  }
+  const handleChangeMultiMode = (event, element) => {
+    if (event.target.checked) {
+      insertInstruction(thePConn, selectionList, selectionKey, primaryField, {
+        id: element.key,
+        primary: element.text ?? element.value
+      });
+    } else {
+      deleteInstruction(thePConn, selectionList, selectionKey, {
+        id: element.key,
+        primary: element.text ?? element.value
+      });
+    }
+    thePConn.clearErrorMessages({
+      property: selectionList,
+      category: '',
+      context: ''
+    });
+  };
 
-  return (
-    <FormControl required={required} error={status === 'error'}>
-      <FormGroup>
+  let theCheckbox;
+  const listOfCheckboxes: any = [];
+  if (selectionMode === 'multi') {
+    const listSourceItems = datasource?.source ?? [];
+    const dataField: any = selectionKey?.split?.('.')[1];
+    listSourceItems.forEach((element, index) => {
+      listOfCheckboxes.push(
         <FormControlLabel
-          control={theCheckbox}
-          checked={checked}
-          onChange={!readOnly ? handleChange : undefined}
-          onBlur={!readOnly ? handleBlur : undefined}
-          label={caption}
+          control={
+            <Checkbox
+              key={index}
+              checked={selectedvalues?.some?.(data => data[dataField] === element.key)}
+              onChange={event => handleChangeMultiMode(event, element)}
+              onBlur={() => {
+                thePConn.getValidationApi().validate(selectedvalues, selectionList);
+              }}
+              data-testid={`${testId}:${element.value}`}
+            />
+          }
+          key={index}
+          label={element.text ?? element.value}
           labelPlacement='end'
           data-test-id={testId}
         />
-      </FormGroup>
+      );
+    });
+    theCheckbox = <div className={classes.checkbox}>{listOfCheckboxes}</div>;
+  } else {
+    theCheckbox = (
+      <FormControlLabel
+        control={
+          <Checkbox
+            color='primary'
+            checked={checked}
+            onChange={!readOnly ? handleChange : undefined}
+            onBlur={!readOnly ? handleBlur : undefined}
+            value={value}
+            disabled={disabled}
+            readOnly={readOnly}
+          />
+        }
+        label={caption}
+        labelPlacement='end'
+        data-test-id={testId}
+      />
+    );
+  }
+
+  return (
+    <FormControl required={required} error={status === 'error'}>
+      {!hideLabel && <FormLabel component='legend'>{label}</FormLabel>}
+      <FormGroup>{theCheckbox}</FormGroup>
       <FormHelperText>{helperTextToDisplay}</FormHelperText>
     </FormControl>
   );

package/tests/assets/sdk-r/components/create/override-sdk/field/Currency/Currency.tsx

@@ -1,14 +1,14 @@
-import { useState, useEffect } from 'react';
 import CurrencyTextField from '@unicef/material-ui-currency-textfield';
 
-import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-utils';
-import { format } from '@pega/react-sdk-components/lib/components/helpers/formatters';
 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 { format } from '@pega/react-sdk-components/lib/components/helpers/formatters';
 import { getCurrencyCharacters, getCurrencyOptions } from './currency-utils';
 
-// Using control from: https://github.com/unicef/material-ui-currency-textfield
+/* Using @unicef/material-ui-currency-textfield component here, since it allows formatting decimal values,
+as per the locale.
+*/
 
 interface CurrrencyProps extends PConnFieldProps {
   // If any, enter additional props that only exist on Currency here
@@ -48,17 +48,11 @@ export default function Currency(props: CurrrencyProps) {
     'data-test-id': testId
   };
 
-  const [theCurrSym, setCurrSym] = useState('$');
-  const [theCurrDec, setCurrDec] = useState('.');
-  const [theCurrSep, setCurrSep] = useState(',');
-
-  useEffect(() => {
-    // currencySymbols looks like this: { theCurrencySymbol: '$', theDecimalIndicator: '.', theSeparator: ',' }
-    const theSymbols = getCurrencyCharacters(currencyISOCode);
-    setCurrSym(theSymbols.theCurrencySymbol);
-    setCurrDec(theSymbols.theDecimalIndicator);
-    setCurrSep(theSymbols.theDigitGroupSeparator);
-  }, [currencyISOCode]);
+  // currencySymbols looks like this: { theCurrencySymbol: '$', theDecimalIndicator: '.', theSeparator: ',' }
+  const theSymbols = getCurrencyCharacters(currencyISOCode);
+  const theCurrSym = theSymbols.theCurrencySymbol;
+  const theCurrDec = theSymbols.theDecimalIndicator;
+  const theCurrSep = theSymbols.theDigitGroupSeparator;
 
   const theCurrencyOptions = getCurrencyOptions(currencyISOCode);
   const formattedValue = format(value, pConn.getComponentName().toLowerCase(), theCurrencyOptions);

package/tests/assets/sdk-r/components/create/override-sdk/field/Decimal/Decimal.tsx

@@ -1,4 +1,3 @@
-import { useState, useEffect } from 'react';
 import CurrencyTextField from '@unicef/material-ui-currency-textfield';
 
 import { getCurrencyCharacters, getCurrencyOptions } from '@pega/react-sdk-components/lib/components/field/Currency/currency-utils';
@@ -7,13 +6,16 @@ import { format } from '@pega/react-sdk-components/lib/components/helpers/format
 import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
 import { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
 
-// Using control from: https://github.com/unicef/material-ui-currency-textfield
+/* Using @unicef/material-ui-currency-textfield component here, since it allows formatting decimal values,
+as per the locale.
+*/
 
 interface DecimalProps extends PConnFieldProps {
   // If any, enter additional props that only exist on Decimal here
   currencyISOCode?: string;
   decimalPrecision?: number;
   showGroupSeparators?: string;
+  formatter?: string;
 }
 
 export default function Decimal(props: DecimalProps) {
@@ -37,7 +39,8 @@ export default function Decimal(props: DecimalProps) {
     decimalPrecision = 2,
     showGroupSeparators = true,
     testId,
-    placeholder
+    placeholder,
+    formatter
   } = props;
 
   const pConn = getPConnect();
@@ -45,17 +48,19 @@ export default function Decimal(props: DecimalProps) {
   const propName = (pConn.getStateProps() as any).value;
   const helperTextToDisplay = validatemessage || helperText;
 
-  const [theCurrDec, setCurrDec] = useState('.');
-  const [theCurrSep, setCurrSep] = useState(',');
-
-  useEffect(() => {
-    const theSymbols = getCurrencyCharacters(currencyISOCode);
-    setCurrDec(theSymbols.theDecimalIndicator);
-    setCurrSep(theSymbols.theDigitGroupSeparator);
-  }, [currencyISOCode]);
+  const theSymbols = getCurrencyCharacters(currencyISOCode);
+  const theCurrDec = theSymbols.theDecimalIndicator;
+  const theCurrSep = theSymbols.theDigitGroupSeparator;
+  const theCurrSym = theSymbols.theCurrencySymbol;
 
   const theCurrencyOptions = getCurrencyOptions(currencyISOCode);
-  const formattedValue = format(value, pConn.getComponentName().toLowerCase(), theCurrencyOptions);
+
+  let formattedValue = '';
+  if (formatter === 'Currency') {
+    formattedValue = format(value, formatter.toLowerCase(), theCurrencyOptions);
+  } else {
+    formattedValue = format(value, pConn.getComponentName().toLowerCase(), theCurrencyOptions);
+  }
 
   if (displayMode === 'LABELS_LEFT') {
     return <FieldValueList name={hideLabel ? '' : label} value={formattedValue} />;
@@ -90,7 +95,7 @@ export default function Decimal(props: DecimalProps) {
       outputFormat='number'
       textAlign='left'
       InputProps={{ inputProps: { ...testProp } }}
-      currencySymbol=''
+      currencySymbol={readOnly && formatter === 'Currency' ? theCurrSym : ''}
       decimalCharacter={theCurrDec}
       digitGroupSeparator={showGroupSeparators ? theCurrSep : ''}
       decimalPlaces={decimalPrecision}

package/tests/assets/sdk-r/components/create/override-sdk/field/Group/Group.tsx

@@ -29,6 +29,8 @@ export default function Group(props: GroupProps) {
     );
   }, [children, type, isReadOnly]);
 
+  if (!children) return null;
+
   return (
     <FieldGroup name={showHeading ? heading : undefined} collapsible={collapsible} instructions={instructions}>
       {content}

package/tests/assets/sdk-r/components/create/override-sdk/field/Multiselect/Multiselect.tsx

@@ -0,0 +1,244 @@
+import { Checkbox, TextField } from '@material-ui/core';
+import Autocomplete from '@material-ui/lab/Autocomplete';
+import CheckBoxOutlineBlankIcon from '@material-ui/icons/CheckBoxOutlineBlank';
+import CheckBoxIcon from '@material-ui/icons/CheckBox';
+import { useEffect, useMemo, useRef, useState } from 'react';
+import { doSearch, getDisplayFieldsMetaData, useDeepMemo, preProcessColumns, getGroupDataForItemsTree } from './utils';
+import { insertInstruction, deleteInstruction } from '@pega/react-sdk-components/lib/components/helpers/instructions-utils';
+import { debounce } from 'throttle-debounce';
+
+const icon = <CheckBoxOutlineBlankIcon fontSize='small' />;
+const checkedIcon = <CheckBoxIcon fontSize='small' />;
+
+export default function Multiselect(props) {
+  const {
+    getPConnect,
+    label,
+    placeholder,
+    referenceList,
+    selectionKey,
+    primaryField,
+    initialCaseClass,
+    showSecondaryInSearchOnly = false,
+    listType = '',
+    isGroupData = false,
+    referenceType,
+    secondaryFields,
+    groupDataSource = [],
+    parameters = {},
+    matchPosition = 'contains',
+    maxResultsDisplay,
+    groupColumnsConfig = [{}],
+    selectionList,
+    value
+  } = props;
+  let { datasource = [], columns = [{}] } = props;
+
+  if (referenceList.length > 0) {
+    datasource = referenceList;
+    columns = [
+      {
+        value: primaryField,
+        display: 'true',
+        useForSearch: true,
+        primary: 'true'
+      },
+      {
+        value: selectionKey,
+        setProperty: selectionKey,
+        key: 'true'
+      }
+    ];
+    let secondaryColumns: any = [];
+    if (secondaryFields) {
+      secondaryColumns = secondaryFields.map(secondaryField => ({
+        value: secondaryField,
+        display: 'true',
+        secondary: 'true',
+        useForSearch: 'true'
+      }));
+    } else {
+      secondaryColumns = [
+        {
+          value: selectionKey,
+          display: 'true',
+          secondary: 'true',
+          useForSearch: 'true'
+        }
+      ];
+    }
+    if (referenceType === 'Case') {
+      columns = [...columns, ...secondaryColumns];
+    }
+  }
+  const [inputValue, setInputValue] = useState(value);
+  const [selectedItems, setSelectedItems] = useState([]);
+
+  const dataConfig = useDeepMemo(() => {
+    return {
+      dataSource: datasource,
+      groupDataSource,
+      isGroupData,
+      showSecondaryInSearchOnly,
+      parameters,
+      matchPosition,
+      listType,
+      maxResultsDisplay: maxResultsDisplay || '100',
+      columns: preProcessColumns(columns),
+      groupColumnsConfig: preProcessColumns(groupColumnsConfig)
+    };
+  }, [
+    datasource,
+    groupDataSource,
+    isGroupData,
+    showSecondaryInSearchOnly,
+    parameters,
+    matchPosition,
+    listType,
+    maxResultsDisplay,
+    columns,
+    groupColumnsConfig
+  ]);
+  const groupsDisplayFieldMeta = useMemo(
+    () => (listType !== 'associated' ? getDisplayFieldsMetaData(dataConfig.groupColumnsConfig) : null),
+    [dataConfig.groupColumnsConfig]
+  );
+
+  const itemsTreeBaseData = getGroupDataForItemsTree(groupDataSource, groupsDisplayFieldMeta, showSecondaryInSearchOnly) || [];
+
+  const [itemsTree, setItemsTree] = useState(
+    isGroupData ? getGroupDataForItemsTree(groupDataSource, groupsDisplayFieldMeta, showSecondaryInSearchOnly) : []
+  );
+
+  const displayFieldMeta = listType !== 'associated' ? getDisplayFieldsMetaData(dataConfig.columns) : null;
+  const getCaseListBasedOnParamsDebounced: any = useRef();
+  const pConn = getPConnect();
+  const contextName = pConn.getContextName();
+  const listActions = pConn.getListActions();
+  const dataApiObj = useRef();
+
+  // main search function trigger
+  const getCaseListBasedOnParams = async (searchText, group, selectedRows, currentItemsTree, isTriggeredFromSearch = false) => {
+    if (referenceList && referenceList.length > 0) {
+      selectedRows = await listActions.getSelectedRows(true);
+
+      selectedRows =
+        selectedRows &&
+        selectedRows.map(item => {
+          return {
+            id: item[selectionKey.startsWith('.') ? selectionKey.substring(1) : selectionKey],
+            primary: item[primaryField.startsWith('.') ? primaryField.substring(1) : primaryField]
+          };
+        });
+      setSelectedItems(selectedRows);
+    }
+
+    // if items tree is null or text search is triggered then always should use fresh data object, we use the original object
+    const initalItemsTree = isTriggeredFromSearch || !currentItemsTree ? [...itemsTreeBaseData] : [...currentItemsTree];
+    const res = await doSearch(
+      searchText,
+      group,
+      initialCaseClass,
+      displayFieldMeta,
+      dataApiObj.current,
+      initalItemsTree,
+      isGroupData,
+      showSecondaryInSearchOnly,
+      selectedRows || []
+    );
+    setItemsTree(res);
+  };
+
+  useEffect(() => {
+    if (referenceList && referenceList.length > 0) {
+      pConn.setReferenceList(selectionList);
+    }
+  }, [pConn]);
+
+  useEffect(() => {
+    getCaseListBasedOnParamsDebounced.current = debounce(500, getCaseListBasedOnParams);
+  }, []);
+
+  useEffect(() => {
+    if (listType !== 'associated') {
+      PCore.getDataApi()
+        ?.init(dataConfig, contextName)
+        .then(dataObj => {
+          dataApiObj.current = dataObj;
+          if (!isGroupData) {
+            getCaseListBasedOnParamsDebounced.current(inputValue ?? '', '', [...selectedItems], [...itemsTree]);
+          }
+        });
+    }
+  }, [dataConfig, listType, dataConfig.columns, inputValue, dataConfig.groupColumnsConfig, showSecondaryInSearchOnly]);
+
+  const onSearchHandler = ev => {
+    const searchText = ev.target.value;
+    setInputValue(searchText);
+    getCaseListBasedOnParamsDebounced.current(searchText, '', [...selectedItems], [...itemsTree], true);
+  };
+
+  const setSelectedItemsForReferenceList = item => {
+    // Clear error messages if any
+    const propName = pConn.getStateProps().selectionList;
+    pConn.clearErrorMessages({
+      property: propName
+    });
+    const { selected } = item;
+    if (selected) {
+      insertInstruction(pConn, selectionList, selectionKey, primaryField, item);
+    } else {
+      deleteInstruction(pConn, selectionList, selectionKey, item);
+    }
+  };
+
+  const handleChange = (event, newSelectedValues) => {
+    let clickedItem;
+    let updatedItems: any = [];
+    if (newSelectedValues && newSelectedValues.length > 0) {
+      updatedItems = newSelectedValues.map(ele => {
+        ele.selected = true;
+        return ele;
+      });
+    }
+    if (newSelectedValues.length > selectedItems.length) {
+      clickedItem = newSelectedValues.filter(item => !selectedItems.some((ele: any) => ele.id === item.id));
+    } else {
+      clickedItem = selectedItems.filter((item: any) => !newSelectedValues.some((ele: any) => ele.id === item.id));
+      clickedItem[0].selected = false;
+    }
+    itemsTree.forEach(ele => {
+      ele.selected = !!updatedItems.find(item => item.id === ele.id);
+    });
+
+    setSelectedItems(updatedItems);
+    setItemsTree(itemsTree);
+
+    setInputValue('');
+
+    // if this is a referenceList case
+    if (referenceList) setSelectedItemsForReferenceList(clickedItem[0]);
+  };
+
+  return (
+    <Autocomplete
+      multiple
+      fullWidth
+      options={itemsTree}
+      disableCloseOnSelect
+      getOptionSelected={(option: any, val: any) => option?.primary === val?.primary}
+      getOptionLabel={(option: any) => option?.primary}
+      onChange={handleChange}
+      value={selectedItems}
+      renderOption={(option: any, { selected }) => (
+        <>
+          <Checkbox icon={icon} checkedIcon={checkedIcon} style={{ marginRight: 8 }} checked={selected} />
+          {option.primary}
+        </>
+      )}
+      renderInput={params => (
+        <TextField {...params} variant='outlined' fullWidth label={label} placeholder={placeholder} size='small' onChange={onSearchHandler} />
+      )}
+    />
+  );
+}

package/tests/assets/sdk-r/components/create/override-sdk/field/Multiselect/index.tsx

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