@pega/dx-component-builder-sdk 0.25.6 → 0.26.1

package/tests/assets/sdk-a/components/create/override-sdk/field/multiselect/multiselect.component.ts

@@ -0,0 +1,264 @@
+import { CommonModule } from '@angular/common';
+import { Component } from '@angular/core';
+import { ReactiveFormsModule } from '@angular/forms';
+import { MatAutocompleteModule } from '@angular/material/autocomplete';
+import { MatChipsModule } from '@angular/material/chips';
+import { MatCheckboxModule } from '@angular/material/checkbox';
+import { MatOptionModule } from '@angular/material/core';
+import { MatFormFieldModule } from '@angular/material/form-field';
+import { MatInputModule } from '@angular/material/input';
+import { MatIconModule } from '@angular/material/icon';
+
+import { FieldBase } from '@pega/angular-sdk-components';
+import { doSearch, getDisplayFieldsMetaData, getGroupDataForItemsTree, preProcessColumns } from './utils';
+import { deleteInstruction, insertInstruction } from '@pega/angular-sdk-components';
+import { handleEvent } from '@pega/angular-sdk-components';
+
+@Component({
+  selector: 'app-multiselect',
+  templateUrl: './multiselect.component.html',
+  styleUrls: ['./multiselect.component.scss'],
+  imports: [
+    CommonModule,
+    ReactiveFormsModule,
+    MatFormFieldModule,
+    MatInputModule,
+    MatAutocompleteModule,
+    MatOptionModule,
+    MatCheckboxModule,
+    MatIconModule,
+    MatChipsModule
+  ]
+})
+export class MultiselectComponent extends FieldBase {
+  configProps$: any;
+
+  listType: string;
+  parameters: {};
+
+  referenceList: any;
+  selectionKey: string;
+  primaryField: string;
+  showSecondaryInSearchOnly = false;
+  selectionList;
+  listActions: any;
+  selectedItems: any[] = [];
+  itemsTreeBaseData = [];
+  displayFieldMeta: any;
+  dataApiObj: any;
+  itemsTree: any[] = [];
+  trigger: any;
+
+  /**
+   * Updates the component when there are changes in the state.
+   */
+  override updateSelf() {
+    // Resolve configuration properties
+    this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps());
+
+    // Update component common properties
+    this.updateComponentCommonProperties(this.configProps$);
+
+    this.setPropertyValuesFromProps();
+
+    const {
+      groupDataSource = [],
+      parameters = {},
+      listType = '',
+      showSecondaryInSearchOnly = false,
+      isGroupData = false,
+      referenceType,
+      secondaryFields,
+      matchPosition = 'contains',
+      maxResultsDisplay,
+      groupColumnsConfig = [{}]
+    } = this.configProps$;
+    let { datasource = [], columns = [{}] } = this.configProps$;
+
+    if (this.referenceList.length > 0) {
+      datasource = this.referenceList;
+      columns = [
+        {
+          value: this.primaryField,
+          display: 'true',
+          useForSearch: true,
+          primary: 'true'
+        },
+        {
+          value: this.selectionKey,
+          setProperty: this.selectionKey,
+          key: 'true'
+        }
+      ];
+      let secondaryColumns: any = [];
+      if (secondaryFields) {
+        secondaryColumns = secondaryFields.map(secondaryField => ({
+          value: secondaryField,
+          display: 'true',
+          secondary: 'true',
+          useForSearch: 'true'
+        }));
+      } else {
+        secondaryColumns = [
+          {
+            value: this.selectionKey,
+            display: 'true',
+            secondary: 'true',
+            useForSearch: 'true'
+          }
+        ];
+      }
+      if (referenceType === 'Case') {
+        columns = [...columns, ...secondaryColumns];
+      }
+    }
+
+    this.value$ = this.value$ ? this.value$ : '';
+    const contextName = this.pConn$.getContextName();
+
+    const dataConfig = {
+      dataSource: datasource,
+      groupDataSource,
+      isGroupData,
+      showSecondaryInSearchOnly,
+      parameters,
+      matchPosition,
+      listType,
+      maxResultsDisplay: maxResultsDisplay || '100',
+      columns: preProcessColumns(columns),
+      groupColumnsConfig: preProcessColumns(groupColumnsConfig),
+      associationFilter: undefined,
+      ignoreCase: undefined
+    };
+
+    const groupsDisplayFieldMeta = this.listType !== 'associated' ? getDisplayFieldsMetaData(dataConfig.groupColumnsConfig) : null;
+
+    this.itemsTreeBaseData = getGroupDataForItemsTree(groupDataSource, groupsDisplayFieldMeta, this.showSecondaryInSearchOnly) || [];
+
+    this.itemsTree = isGroupData ? getGroupDataForItemsTree(groupDataSource, groupsDisplayFieldMeta, this.showSecondaryInSearchOnly) : [];
+
+    this.displayFieldMeta = this.listType !== 'associated' ? getDisplayFieldsMetaData(dataConfig.columns) : null;
+
+    this.listActions = this.pConn$.getListActions();
+    this.pConn$.setReferenceList(this.selectionList);
+
+    if (this.listType !== 'associated') {
+      PCore.getDataApi()
+        ?.init(dataConfig, contextName)
+        .then(async dataObj => {
+          this.dataApiObj = dataObj;
+          if (!isGroupData) {
+            this.getCaseListBasedOnParams(this.value$ ?? '', '', [...this.selectedItems], [...this.itemsTree]);
+          }
+        });
+    }
+  }
+
+  setPropertyValuesFromProps() {
+    this.referenceList = this.configProps$?.referenceList;
+    this.selectionKey = this.configProps$?.selectionKey;
+    this.primaryField = this.configProps$?.primaryField;
+    this.selectionList = this.configProps$?.selectionList;
+    this.value$ = this.configProps$?.value;
+  }
+
+  // main search function trigger
+  getCaseListBasedOnParams(searchText, group, selectedRows, currentItemsTree, isTriggeredFromSearch = false) {
+    if (this.referenceList && this.referenceList.length > 0) {
+      this.listActions.getSelectedRows(true).then(result => {
+        selectedRows =
+          result.length > 0
+            ? result.map(item => {
+                return {
+                  id: item[this.selectionKey.startsWith('.') ? this.selectionKey.substring(1) : this.selectionKey],
+                  primary: item[this.primaryField.startsWith('.') ? this.primaryField.substring(1) : this.primaryField]
+                };
+              })
+            : [];
+        this.selectedItems = selectedRows;
+
+        const initalItemsTree = isTriggeredFromSearch || !currentItemsTree ? [...this.itemsTreeBaseData] : [...currentItemsTree];
+
+        const { initialCaseClass, isGroupData, showSecondaryInSearchOnly } = this.configProps$;
+
+        doSearch(
+          searchText,
+          group,
+          initialCaseClass,
+          this.displayFieldMeta,
+          this.dataApiObj,
+          initalItemsTree,
+          isGroupData,
+          showSecondaryInSearchOnly,
+          selectedRows || []
+        ).then(res => {
+          this.itemsTree = res || [];
+        });
+      });
+    }
+  }
+
+  fieldOnChange(event: Event) {
+    this.value$ = (event.target as HTMLInputElement).value;
+    this.getCaseListBasedOnParams(this.value$, '', [...this.selectedItems], [...this.itemsTree], true);
+  }
+
+  optionChanged(event: any) {
+    let value = event?.target?.value;
+    value = value?.substring(1);
+    handleEvent(this.actionsApi, 'changeNblur', this.propName, value);
+  }
+
+  optionClicked = (event: Event, data: any): void => {
+    event.stopPropagation();
+    this.toggleSelection(data);
+  };
+
+  toggleSelection = (data: any): void => {
+    data.selected = !data.selected;
+    this.itemsTree.map((ele: any) => {
+      if (ele.id === data.id) {
+        ele.selected = data.selected;
+      }
+      return ele;
+    });
+
+    if (data.selected === true) {
+      this.selectedItems.push(data);
+    } else {
+      const index = this.selectedItems.findIndex(value => value.id === data.id);
+      this.selectedItems.splice(index, 1);
+    }
+
+    this.value$ = '';
+    // if this is a referenceList case
+    if (this.referenceList) this.setSelectedItemsForReferenceList(data);
+
+    this.getCaseListBasedOnParams(this.value$, '', [...this.selectedItems], [...this.itemsTree], true);
+  };
+
+  removeChip = (data: any): void => {
+    if (data) {
+      data = this.itemsTree.filter((ele: any) => {
+        return ele.id === data.id;
+      });
+      this.toggleSelection(data[0]);
+    }
+  };
+
+  setSelectedItemsForReferenceList(data: any) {
+    // Clear error messages if any
+    const propName = this.pConn$.getStateProps().selectionList;
+    this.pConn$.clearErrorMessages({
+      property: propName,
+      category: '',
+      context: ''
+    });
+    const { selected } = data;
+    if (selected) {
+      insertInstruction(this.pConn$, this.selectionList, this.selectionKey, this.primaryField, data);
+    } else {
+      deleteInstruction(this.pConn$, this.selectionList, this.selectionKey, data);
+    }
+  }
+}

package/tests/assets/sdk-a/components/create/override-sdk/field/multiselect/utils.ts

@@ -0,0 +1,217 @@
+import cloneDeep from 'lodash.clonedeep';
+
+export function 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);
+  }
+}
+
+function 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;
+  });
+}
+
+function 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;
+}
+
+function 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
+  };
+}
+
+function 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;
+}
+
+function prepareSearchResults(listObjData, displayFieldMeta) {
+  const searchResults: any = [];
+  for (const obj of listObjData) {
+    searchResults.push(...obj[displayFieldMeta.itemsRecordsColumn]);
+  }
+  return searchResults;
+}
+
+function handleGroupedDataSearch(dataApiObj, searchText, clickedGroup, initialCaseClass, itemsTree) {
+  const localDataApiObj = cloneDeep(dataApiObj);
+  localDataApiObj.fetchedNQData = false;
+  localDataApiObj.cache = {};
+
+  if (!searchText && !clickedGroup) {
+    return { shouldReturn: true, value: itemsTree };
+  }
+
+  localDataApiObj.parameters[Object.keys(localDataApiObj.parameters)[1]] = searchText;
+  localDataApiObj.parameters[Object.keys(localDataApiObj.parameters)[0]] = initialCaseClass;
+
+  if (clickedGroup) {
+    if (!searchText) {
+      const containsData = itemsTree.find(item => item.id === clickedGroup);
+      if (containsData?.items?.length) {
+        return { shouldReturn: true, value: itemsTree };
+      }
+    }
+    localDataApiObj.parameters[Object.keys(localDataApiObj.parameters)[0]] = JSON.stringify([clickedGroup]);
+  }
+
+  return { shouldReturn: false, value: localDataApiObj };
+}
+
+async function doSearch(
+  searchText,
+  clickedGroup,
+  initialCaseClass,
+  displayFieldMeta,
+  dataApiObj, // deep clone of the dataApiObj
+  itemsTree,
+  isGroupData,
+  showSecondaryInSearchOnly,
+  selected
+) {
+  if (!dataApiObj) {
+    return itemsTree;
+  }
+
+  let searchTextForApi = '';
+  let localDataApiObj = dataApiObj;
+
+  if (isGroupData) {
+    const groupResult = handleGroupedDataSearch(dataApiObj, searchText, clickedGroup, initialCaseClass, itemsTree);
+    if (groupResult.shouldReturn) {
+      return groupResult.value;
+    }
+    localDataApiObj = groupResult.value;
+  } else {
+    searchTextForApi = searchText;
+  }
+
+  const response = await localDataApiObj.fetchData(searchTextForApi).catch(() => ({ data: undefined }));
+
+  let listObjData = response.data;
+  if (!listObjData) {
+    return itemsTree;
+  }
+
+  if (isGroupData) {
+    if (searchText) {
+      listObjData = prepareSearchResults(listObjData, displayFieldMeta);
+    } else {
+      return putItemsDataInItemsTree(listObjData, displayFieldMeta, itemsTree, showSecondaryInSearchOnly, selected);
+    }
+  }
+
+  if (listObjData.length === 0) {
+    return [];
+  }
+
+  const showSecondaryData = showSecondaryInSearchOnly ? !!searchText : true;
+  return listObjData.map(entry => createSingleTreeObejct(entry, displayFieldMeta, showSecondaryData, selected));
+}
+
+function 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;
+}
+
+function 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 { preProcessColumns, getDisplayFieldsMetaData, doSearch, setValuesToPropertyList, getGroupDataForItemsTree };

package/tests/assets/sdk-a/components/create/override-sdk/field/object-reference/object-reference.component.html

@@ -0,0 +1,17 @@
+<div *ngIf="isDisplayModeEnabled && !canBeChangedInReviewMode; else semanticLinkCheck">
+  <component-mapper name="SingleReferenceReadOnly" [props]="{ pConn$ }"></component-mapper>
+</div>
+<ng-template #semanticLinkCheck>
+  <div *ngIf="type === 'SemanticLink' && !canBeChangedInReviewMode; else loadDynamicComp">
+    <component-mapper name="SemanticLink" [props]="{ pConn$: newPconn }"></component-mapper>
+  </div>
+</ng-template>
+<ng-template #loadDynamicComp>
+  <component-mapper
+    *ngIf="newComponentName"
+    [name]="newComponentName"
+    [props]="{ pConn$: newPconn, formGroup$ }"
+    [parent]="this"
+    [outputEvents]="{ onRecordChange: onRecordChange }"
+  ></component-mapper>
+</ng-template>

package/tests/assets/sdk-a/components/create/override-sdk/field/object-reference/object-reference.component.spec.ts

@@ -0,0 +1,22 @@
+import { ComponentFixture, TestBed } from '@angular/core/testing';
+
+import { ObjectReferenceComponent } from './object-reference.component';
+
+describe('ObjectReferenceComponent', () => {
+  let component: ObjectReferenceComponent;
+  let fixture: ComponentFixture<ObjectReferenceComponent>;
+
+  beforeEach(async () => {
+    await TestBed.configureTestingModule({
+      imports: [ObjectReferenceComponent]
+    }).compileComponents();
+
+    fixture = TestBed.createComponent(ObjectReferenceComponent);
+    component = fixture.componentInstance;
+    fixture.detectChanges();
+  });
+
+  it('should create', () => {
+    expect(component).toBeTruthy();
+  });
+});