@pega/dx-component-builder-sdk 0.23.19 → 0.23.20

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';

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

@@ -0,0 +1,230 @@
+import { useRef } from 'react';
+import equal from 'fast-deep-equal';
+import cloneDeep from 'lodash/cloneDeep';
+import { updateNewInstuctions, insertInstruction, deleteInstruction } from '@pega/react-sdk-components/lib/components/helpers/instructions-utils';
+
+export const setVisibilityForList = (c11nEnv, visibility) => {
+  const { selectionMode, selectionList, renderMode, referenceList } = c11nEnv.getComponentConfig();
+  // usecase:multiselect, fieldgroup, editable table
+  if ((selectionMode === PCore.getConstants().LIST_SELECTION_MODE.MULTI && selectionList) || (renderMode === 'Editable' && referenceList)) {
+    c11nEnv.getListActions().setVisibility(visibility);
+  }
+};
+
+const useDeepMemo = (memoFn, key) => {
+  const ref: any = useRef();
+  if (!ref.current || !equal(key, ref.current.key)) {
+    ref.current = { key, value: memoFn() };
+  }
+  return ref.current.value;
+};
+
+const preProcessColumns = columns => {
+  return columns?.map(col => {
+    const tempColObj = { ...col };
+    tempColObj.value = col.value && col.value.startsWith('.') ? col.value.substring(1) : col.value;
+    if (tempColObj.setProperty) {
+      tempColObj.setProperty = col.setProperty && col.setProperty.startsWith('.') ? col.setProperty.substring(1) : col.setProperty;
+    }
+    return tempColObj;
+  });
+};
+
+const getDisplayFieldsMetaData = columns => {
+  const displayColumns = columns?.filter(col => col.display === 'true');
+  const metaDataObj: any = {
+    key: '',
+    primary: '',
+    secondary: []
+  };
+  const keyCol = columns?.filter(col => col.key === 'true');
+  metaDataObj.key = keyCol?.length > 0 ? keyCol[0].value : 'auto';
+  const itemsRecordsColumn = columns?.filter(col => col.itemsRecordsColumn === 'true');
+  if (itemsRecordsColumn?.length > 0) {
+    metaDataObj.itemsRecordsColumn = itemsRecordsColumn[0].value;
+  }
+  const itemsGroupKeyColumn = columns?.filter(col => col.itemsGroupKeyColumn === 'true');
+  if (itemsGroupKeyColumn?.length > 0) {
+    metaDataObj.itemsGroupKeyColumn = itemsGroupKeyColumn[0].value;
+  }
+  for (let index = 0; index < displayColumns?.length; index += 1) {
+    if (displayColumns[index].secondary === 'true') {
+      metaDataObj.secondary.push(displayColumns[index].value);
+    } else if (displayColumns[index].primary === 'true') {
+      metaDataObj.primary = displayColumns[index].value;
+    }
+  }
+  return metaDataObj;
+};
+
+const createSingleTreeObejct = (entry, displayFieldMeta, showSecondaryData, selected) => {
+  const secondaryArr: any = [];
+  displayFieldMeta.secondary.forEach(col => {
+    secondaryArr.push(entry[col]);
+  });
+  const isSelected = selected.some(item => item.id === entry[displayFieldMeta.key]);
+
+  return {
+    id: entry[displayFieldMeta.key],
+    primary: entry[displayFieldMeta.primary],
+    secondary: showSecondaryData ? secondaryArr : [],
+    selected: isSelected
+  };
+};
+
+const putItemsDataInItemsTree = (listObjData, displayFieldMeta, itemsTree, showSecondaryInSearchOnly, selected) => {
+  let newTreeItems = itemsTree.slice();
+  const showSecondaryData = !showSecondaryInSearchOnly;
+  for (const obj of listObjData) {
+    const items = obj[displayFieldMeta.itemsRecordsColumn].map(entry => createSingleTreeObejct(entry, displayFieldMeta, showSecondaryData, selected));
+
+    newTreeItems = newTreeItems.map(caseObject => {
+      if (caseObject.id === obj[displayFieldMeta.itemsGroupKeyColumn]) {
+        caseObject.items = [...items];
+      }
+      return caseObject;
+    });
+  }
+  return newTreeItems;
+};
+
+const prepareSearchResults = (listObjData, displayFieldMeta) => {
+  const searchResults: any = [];
+  for (const obj of listObjData) {
+    searchResults.push(...obj[displayFieldMeta.itemsRecordsColumn]);
+  }
+  return searchResults;
+};
+
+const doSearch = async (
+  searchText,
+  clickedGroup,
+  initialCaseClass,
+  displayFieldMeta,
+  dataApiObj, // deep clone of the dataApiObj
+  itemsTree,
+  isGroupData,
+  showSecondaryInSearchOnly,
+  selected
+) => {
+  let searchTextForUngroupedData = '';
+  if (dataApiObj) {
+    // creating dataApiObject in grouped data cases
+    if (isGroupData) {
+      dataApiObj = cloneDeep(dataApiObj);
+      dataApiObj.fetchedNQData = false;
+      dataApiObj.cache = {};
+
+      // if we have no search text and no group selected, return the original tree
+      if (searchText === '' && clickedGroup === '') {
+        return itemsTree;
+      }
+
+      // setting the inital search text & search classes in ApiObject
+      dataApiObj.parameters[Object.keys(dataApiObj.parameters)[1]] = searchText;
+      dataApiObj.parameters[Object.keys(dataApiObj.parameters)[0]] = initialCaseClass;
+
+      // if we have a selected group
+      if (clickedGroup) {
+        // check if the data for this group is already present and no search text
+        if (searchText === '') {
+          const containsData = itemsTree.find(item => item.id === clickedGroup);
+          // do not make API call when items of respective group are already fetched
+          if (containsData?.items?.length) return itemsTree;
+        }
+
+        dataApiObj.parameters[Object.keys(dataApiObj.parameters)[0]] = JSON.stringify([clickedGroup]);
+      }
+    } else {
+      searchTextForUngroupedData = searchText;
+    }
+
+    // search API call
+    const response = await dataApiObj.fetchData(searchTextForUngroupedData).catch(() => {
+      return itemsTree;
+    });
+
+    let listObjData = response.data;
+    let newItemsTree = [];
+    if (isGroupData) {
+      if (searchText) {
+        listObjData = prepareSearchResults(listObjData, displayFieldMeta);
+      } else {
+        newItemsTree = putItemsDataInItemsTree(listObjData, displayFieldMeta, itemsTree, showSecondaryInSearchOnly, selected);
+        return newItemsTree;
+      }
+    }
+    const showSecondaryData = showSecondaryInSearchOnly ? !!searchText : true;
+    if (listObjData !== undefined && listObjData.length > 0) {
+      newItemsTree = listObjData.map(entry => createSingleTreeObejct(entry, displayFieldMeta, showSecondaryData, selected));
+    }
+    return newItemsTree;
+  }
+
+  return itemsTree;
+};
+
+const setValuesToPropertyList = (searchText, assocProp, items, columns, actions, updatePropertyInRedux = true) => {
+  const setPropertyList = columns
+    ?.filter(col => col.setProperty)
+    .map(col => {
+      return {
+        source: col.value,
+        target: col.setProperty,
+        key: col.key,
+        primary: col.primary
+      };
+    });
+  const valueToSet: any = [];
+  if (setPropertyList.length > 0) {
+    setPropertyList.forEach(prop => {
+      items.forEach(item => {
+        if (prop.key === 'true' && item) {
+          valueToSet.push(item.id);
+        } else if (prop.primary === 'true' || !item) {
+          valueToSet.push(searchText);
+        }
+      });
+
+      if (updatePropertyInRedux) {
+        // BUG-666851 setting options so that the store values are replaced and not merged
+        const options = {
+          isArrayDeepMerge: false
+        };
+        if (prop.target === 'Associated property') {
+          actions.updateFieldValue(assocProp, valueToSet, options);
+        } else {
+          actions.updateFieldValue(`.${prop.target}`, valueToSet, options);
+        }
+      }
+    });
+  }
+  return valueToSet;
+};
+
+const getGroupDataForItemsTree = (groupDataSource, groupsDisplayFieldMeta, showSecondaryInSearchOnly) => {
+  return groupDataSource?.map(group => {
+    const secondaryArr: any = [];
+    groupsDisplayFieldMeta.secondary.forEach(col => {
+      secondaryArr.push(group[col]);
+    });
+    return {
+      id: group[groupsDisplayFieldMeta.key],
+      primary: group[groupsDisplayFieldMeta.primary],
+      secondary: showSecondaryInSearchOnly ? [] : secondaryArr,
+      items: []
+    };
+  });
+};
+
+export {
+  useDeepMemo,
+  preProcessColumns,
+  getDisplayFieldsMetaData,
+  doSearch,
+  setValuesToPropertyList,
+  getGroupDataForItemsTree,
+  updateNewInstuctions,
+  insertInstruction,
+  deleteInstruction
+};

package/tests/assets/sdk-r/components/create/override-sdk/template/ListView/ListView.tsx

@@ -209,10 +209,10 @@ export default function ListView(props: ListViewProps) {
   };
 
   function descendingComparator<T>(a: T, b: T, orderedBy: keyof T) {
-    if (b[orderedBy] < a[orderedBy]) {
+    if (!b[orderedBy] || b[orderedBy] < a[orderedBy]) {
       return -1;
     }
-    if (b[orderedBy] > a[orderedBy]) {
+    if (!a[orderedBy] || b[orderedBy] > a[orderedBy]) {
       return 1;
     }
     return 0;
@@ -981,7 +981,7 @@ export default function ListView(props: ListViewProps) {
         break;
 
       default:
-        val = column.format && typeof value === 'number' ? column.format(value) : value;
+        val = column.format && typeof value === 'number' ? column.format(value) : value || '---';
     }
     return val;
   };
@@ -1062,7 +1062,7 @@ export default function ListView(props: ListViewProps) {
                                       {column.format && typeof value === 'number' ? column.format(value) : value}
                                     </Link>
                                   ) : (
-                                    <>{column.format && typeof value === 'number' ? column.format(value) : value}</>
+                                    <>{column.format && typeof value === 'number' ? column.format(value) : value || '---'}</>
                                   )}
                                 </TableCell>
                               );

package/tests/assets/sdk-r/components/create/override-sdk/template/SimpleTableManual/SimpleTableManual.tsx

@@ -374,10 +374,10 @@ export default function SimpleTableManual(props: PropsWithChildren<SimpleTableMa
   };
 
   function descendingComparator<T>(a: T, b: T, orderedBy: keyof T) {
-    if (b[orderedBy] < a[orderedBy]) {
+    if (!b[orderedBy] || b[orderedBy] < a[orderedBy]) {
       return -1;
     }
-    if (b[orderedBy] > a[orderedBy]) {
+    if (!a[orderedBy] || b[orderedBy] > a[orderedBy]) {
       return 1;
     }
     return 0;
@@ -588,7 +588,7 @@ export default function SimpleTableManual(props: PropsWithChildren<SimpleTableMa
                           direction={orderBy === displayedColumns[index] ? order : 'asc'}
                           onClick={createSortHandler(displayedColumns[index])}
                         >
-                          {field.label}
+                          {field.label || '---'}
                           {_showFilteredIcon(field.name) && <FilterListIcon className={classes.moreIcon} />}
                           {orderBy === displayedColumns[index] ? (
                             <span className={classes.visuallyHidden}>{order === 'desc' ? 'sorted descending' : 'sorted ascending'}</span>
@@ -671,7 +671,7 @@ export default function SimpleTableManual(props: PropsWithChildren<SimpleTableMa
                             ) : typeof row[colKey] === 'boolean' && row[colKey] ? (
                               'True'
                             ) : (
-                              row[colKey]
+                              row[colKey] || '---'
                             )}
                           </TableCell>
                         );

package/tests/assets/sdk-r/components/createAll/_components.md

@@ -0,0 +1,6 @@
+# The **components** directory
+
+The **src/components** directory contains the code for the components you want to use with the **React SDK**.
+
+When you run the **npm run  create** or **npm run override** commands to create new components, the generated code that
+you can use as a starting point for your component development will be placed in component-specific folders inside **src/components**.

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyBoolean/Boolean.ts

@@ -0,0 +1,35 @@
+function Boolean(value: any, { allowEmpty = true, tick = '', cross = '' } = {}) {
+  if (
+    (!allowEmpty && !value) ||
+    value === false ||
+    value?.toString()?.toLowerCase() === 'false' ||
+    value === 0 ||
+    value === '0'
+  ) {
+    return cross || '';
+  }
+  if (
+    value === true ||
+    value?.toString()?.toLowerCase() === 'true' ||
+    value === 1 ||
+    value === '1'
+  ) {
+    return tick || '';
+  }
+  if (
+    allowEmpty &&
+    (value === 'null' || value === '' || value === null || typeof value === 'undefined')
+  ) {
+    return '––';
+  }
+  return value;
+}
+
+export default {
+  TrueFalse: (value: any, options: Object) =>
+    Boolean(value, {
+      ...options,
+      tick: 'True',
+      cross: 'False'
+    })
+};

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyBoolean/demo.stories.tsx

@@ -1,38 +1,29 @@
+
 /* eslint-disable react/jsx-no-useless-fragment */
 // @ts-nocheck
 import { useState } from 'react';
-import { withKnobs } from '@storybook/addon-knobs';
+import type { Meta, StoryObj } from '@storybook/react';
 
 import { configProps, stateProps } from './mock';
 
 import PegaDxilMyBoolean from './index';
 
-export default {
+const meta: Meta<typeof PegaDxilMyBoolean> = {
   title: 'PegaDxilMyBoolean',
-  decorators: [withKnobs],
-  component: PegaDxilMyBoolean
+  component: PegaDxilMyBoolean,
+  excludeStories: /.*Data$/
 };
 
-export const BasePegaDxilMyBoolean = () => {
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyBoolean>;
+
+export const BasePegaDxilMyBoolean: Story = args => {
 
   const [value, setValue] = useState(configProps.value);
 
   const props = {
     value,
-    label: configProps.label,
-    helperText: configProps.helperText,
-    caption: configProps.caption,
-    validatemessage: configProps.validatemessage,
-    hideLabel: configProps.hideLabel,
-    testId: configProps.testId,
     additionalProps: configProps.additionalProps,
-    displayMode: configProps.displayMode,
-    variant: configProps.variant,
-    trueLabel: configProps.trueLabel,
-    falseLabel: configProps.falseLabel,
-    disabled: configProps.disabled,
-    readOnly: configProps.readOnly,
-    required: configProps.required,
     getPConnect: () => {
       return {
         getStateProps: () => {
@@ -57,7 +48,24 @@ export const BasePegaDxilMyBoolean = () => {
 
   return (
     <>
-      <PegaDxilMyBoolean {...props} />
+      <PegaDxilMyBoolean {...props} {...args} />
     </>
   );
-};
+};
+
+BasePegaDxilMyBoolean.args = {
+  label: configProps.label,
+  helperText: configProps.helperText,
+  caption: configProps.caption,
+  testId: configProps.testId,
+  readOnly: configProps.readOnly,
+  disabled: configProps.disabled,
+  required: configProps.required,
+  status: configProps.status,
+  hideLabel: configProps.hideLabel,
+  trueLabel: configProps.trueLabel,
+  falseLabel: configProps.falseLabel,
+  displayMode: configProps.displayMode,
+  variant: configProps.variant,
+  validatemessage: configProps.validatemessage
+};