@pega/angular-sdk-overrides 0.25.1 → 0.25.2

package/lib/field/multiselect/multiselect.component.ts

@@ -1,6 +1,6 @@
 import { CommonModule } from '@angular/common';
-import { Component, Input, OnDestroy, OnInit } from '@angular/core';
-import { FormControl, FormGroup, ReactiveFormsModule } from '@angular/forms';
+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';
@@ -8,8 +8,8 @@ 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 { AngularPConnectData, AngularPConnectService } from '@pega/angular-sdk-components';
-import { Utils } from '@pega/angular-sdk-components';
+
+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';
@@ -30,39 +30,16 @@ import { handleEvent } from '@pega/angular-sdk-components';
     MatChipsModule
   ]
 })
-export class MultiselectComponent implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
-
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
+export class MultiselectComponent extends FieldBase {
+  configProps$: any;
 
-  label$ = '';
-  value$ = '';
-  bRequired$ = false;
-  bDisabled$ = false;
-  bVisible$ = true;
-  controlName$: string;
-  bHasForm$ = true;
   listType: string;
-  placeholder: string;
-  fieldControl = new FormControl('', null);
   parameters: {};
-  hideLabel: boolean;
-  configProps$: any;
 
   referenceList: any;
   selectionKey: string;
   primaryField: string;
-  initialCaseClass: any;
   showSecondaryInSearchOnly = false;
-  isGroupData = false;
-  referenceType;
-  secondaryFields;
-  groupDataSource = [];
-  matchPosition = 'contains';
-  maxResultsDisplay;
-  groupColumnsConfig = [{}];
   selectionList;
   listActions: any;
   selectedItems: any[] = [];
@@ -71,64 +48,32 @@ export class MultiselectComponent implements OnInit, OnDestroy {
   dataApiObj: any;
   itemsTree: any[] = [];
   trigger: any;
-  actionsApi: Object;
-  propName: string;
-
-  constructor(
-    private angularPConnect: AngularPConnectService,
-    private utils: Utils
-  ) {}
-
-  ngOnInit(): void {
-    // First thing in initialization is registering and subscribing to the AngularPConnect service
-    this.angularPConnectData = this.angularPConnect.registerAndSubscribeComponent(this, this.onStateChange);
-    this.controlName$ = this.angularPConnect.getComponentID(this);
-
-    // Then, continue on with other initialization
-    this.checkAndUpdate();
-
-    if (this.formGroup$) {
-      // add control to formGroup
-      this.formGroup$.addControl(this.controlName$, this.fieldControl);
-      this.fieldControl.setValue(this.value$);
-      this.bHasForm$ = true;
-    } else {
-      this.bHasForm$ = false;
-    }
-  }
-
-  ngOnDestroy(): void {
-    if (this.formGroup$) {
-      this.formGroup$.removeControl(this.controlName$);
-    }
-
-    if (this.angularPConnectData.unsubscribeFn) {
-      this.angularPConnectData.unsubscribeFn();
-    }
-  }
 
-  // Callback passed when subscribing to store change
-  onStateChange() {
-    this.checkAndUpdate();
-  }
+  /**
+   * Updates the component when there are changes in the state.
+   */
+  override updateSelf() {
+    // Resolve configuration properties
+    this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps());
 
-  checkAndUpdate() {
-    // Should always check the bridge to see if the component should
-    // update itself (re-render)
-    const bUpdateSelf = this.angularPConnect.shouldComponentUpdate(this);
+    // Update component common properties
+    this.updateComponentCommonProperties(this.configProps$);
 
-    // ONLY call updateSelf when the component should update
-    if (bUpdateSelf) {
-      this.updateSelf();
-    }
-  }
-
-  // updateSelf
-  updateSelf() {
-    this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps());
+    this.setPropertyValuesFromProps();
 
+    const {
+      groupDataSource = [],
+      parameters = {},
+      listType = '',
+      showSecondaryInSearchOnly = false,
+      isGroupData = false,
+      referenceType,
+      secondaryFields,
+      matchPosition = 'contains',
+      maxResultsDisplay,
+      groupColumnsConfig = [{}]
+    } = this.configProps$;
     let { datasource = [], columns = [{}] } = this.configProps$;
-    this.setPropertyValuesFromProps();
 
     if (this.referenceList.length > 0) {
       datasource = this.referenceList;
@@ -146,8 +91,8 @@ export class MultiselectComponent implements OnInit, OnDestroy {
         }
       ];
       let secondaryColumns: any = [];
-      if (this.secondaryFields) {
-        secondaryColumns = this.secondaryFields.map(secondaryField => ({
+      if (secondaryFields) {
+        secondaryColumns = secondaryFields.map(secondaryField => ({
           value: secondaryField,
           display: 'true',
           secondary: 'true',
@@ -163,7 +108,7 @@ export class MultiselectComponent implements OnInit, OnDestroy {
           }
         ];
       }
-      if (this.referenceType === 'Case') {
+      if (referenceType === 'Case') {
         columns = [...columns, ...secondaryColumns];
       }
     }
@@ -173,54 +118,36 @@ export class MultiselectComponent implements OnInit, OnDestroy {
 
     const dataConfig = {
       dataSource: datasource,
-      groupDataSource: this.groupDataSource,
-      isGroupData: this.isGroupData,
-      showSecondaryInSearchOnly: this.showSecondaryInSearchOnly,
-      parameters: this.parameters,
-      matchPosition: this.matchPosition,
-      listType: this.listType,
-      maxResultsDisplay: this.maxResultsDisplay || '100',
+      groupDataSource,
+      isGroupData,
+      showSecondaryInSearchOnly,
+      parameters,
+      matchPosition,
+      listType,
+      maxResultsDisplay: maxResultsDisplay || '100',
       columns: preProcessColumns(columns),
-      groupColumnsConfig: preProcessColumns(this.groupColumnsConfig),
+      groupColumnsConfig: preProcessColumns(groupColumnsConfig),
       associationFilter: undefined,
       ignoreCase: undefined
     };
 
     const groupsDisplayFieldMeta = this.listType !== 'associated' ? getDisplayFieldsMetaData(dataConfig.groupColumnsConfig) : null;
 
-    this.itemsTreeBaseData = getGroupDataForItemsTree(this.groupDataSource, groupsDisplayFieldMeta, this.showSecondaryInSearchOnly) || [];
+    this.itemsTreeBaseData = getGroupDataForItemsTree(groupDataSource, groupsDisplayFieldMeta, this.showSecondaryInSearchOnly) || [];
 
-    this.itemsTree = this.isGroupData ? getGroupDataForItemsTree(this.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.configProps$.visibility != null) {
-      this.bVisible$ = this.utils.getBooleanValue(this.configProps$.visibility);
-    }
-
-    // disabled
-    if (this.configProps$.disabled != undefined) {
-      this.bDisabled$ = this.utils.getBooleanValue(this.configProps$.disabled);
-    }
-
-    if (this.bDisabled$) {
-      this.fieldControl.disable();
-    } else {
-      this.fieldControl.enable();
-    }
-
-    this.actionsApi = this.pConn$.getActionsApi();
-    this.propName = this.pConn$.getStateProps().value;
-
     if (this.listType !== 'associated') {
       PCore.getDataApi()
         ?.init(dataConfig, contextName)
         .then(async dataObj => {
           this.dataApiObj = dataObj;
-          if (!this.isGroupData) {
+          if (!isGroupData) {
             this.getCaseListBasedOnParams(this.value$ ?? '', '', [...this.selectedItems], [...this.itemsTree]);
           }
         });
@@ -228,23 +155,9 @@ export class MultiselectComponent implements OnInit, OnDestroy {
   }
 
   setPropertyValuesFromProps() {
-    this.label$ = this.configProps$.label;
-    this.placeholder = this.configProps$.placeholder || '';
-    this.listType = this.configProps$.listType ? this.configProps$.listType : '';
-    this.hideLabel = this.configProps$.hideLabel;
-    this.parameters = this.configProps$?.parameters ? this.configProps$?.parameters : {};
     this.referenceList = this.configProps$?.referenceList;
     this.selectionKey = this.configProps$?.selectionKey;
     this.primaryField = this.configProps$?.primaryField;
-    this.initialCaseClass = this.configProps$?.initialCaseClass;
-    this.showSecondaryInSearchOnly = this.configProps$?.showSecondaryInSearchOnly ? this.configProps$?.showSecondaryInSearchOnly : false;
-    this.isGroupData = this.configProps$?.isGroupData ? this.configProps$.isGroupData : false;
-    this.referenceType = this.configProps$?.referenceType;
-    this.secondaryFields = this.configProps$?.secondaryFields;
-    this.groupDataSource = this.configProps$?.groupDataSource ? this.configProps$?.groupDataSource : [];
-    this.matchPosition = this.configProps$?.matchPosition ? this.configProps$?.matchPosition : 'contains';
-    this.maxResultsDisplay = this.configProps$?.maxResultsDisplay;
-    this.groupColumnsConfig = this.configProps$?.groupColumnsConfig ? this.configProps$?.groupColumnsConfig : [{}];
     this.selectionList = this.configProps$?.selectionList;
     this.value$ = this.configProps$?.value;
   }
@@ -266,15 +179,17 @@ export class MultiselectComponent implements OnInit, OnDestroy {
 
         const initalItemsTree = isTriggeredFromSearch || !currentItemsTree ? [...this.itemsTreeBaseData] : [...currentItemsTree];
 
+        const { initialCaseClass, isGroupData, showSecondaryInSearchOnly } = this.configProps$;
+
         doSearch(
           searchText,
           group,
-          this.initialCaseClass,
+          initialCaseClass,
           this.displayFieldMeta,
           this.dataApiObj,
           initalItemsTree,
-          this.isGroupData,
-          this.showSecondaryInSearchOnly,
+          isGroupData,
+          showSecondaryInSearchOnly,
           selectedRows || []
         ).then(res => {
           this.itemsTree = res || [];
@@ -346,21 +261,4 @@ export class MultiselectComponent implements OnInit, OnDestroy {
       deleteInstruction(this.pConn$, this.selectionList, this.selectionKey, data);
     }
   }
-
-  getErrorMessage() {
-    let errMessage = '';
-
-    // look for validation messages for json, pre-defined or just an error pushed from workitem (400)
-    if (this.fieldControl.hasError('message')) {
-      errMessage = this.angularPConnectData.validateMessage ?? '';
-      return errMessage;
-    }
-    if (this.fieldControl.hasError('required')) {
-      errMessage = 'You must enter a value';
-    } else if (this.fieldControl.errors) {
-      errMessage = this.fieldControl.errors.toString();
-    }
-
-    return errMessage;
-  }
 }

package/lib/field/multiselect/utils.ts

@@ -85,6 +85,31 @@ function prepareSearchResults(listObjData, displayFieldMeta) {
   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,
@@ -96,61 +121,44 @@ async function doSearch(
   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;
-      }
+  if (!dataApiObj) {
+    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;
-        }
+  let searchTextForApi = '';
+  let localDataApiObj = dataApiObj;
 
-        dataApiObj.parameters[Object.keys(dataApiObj.parameters)[0]] = JSON.stringify([clickedGroup]);
-      }
-    } else {
-      searchTextForUngroupedData = searchText;
+  if (isGroupData) {
+    const groupResult = handleGroupedDataSearch(dataApiObj, searchText, clickedGroup, initialCaseClass, itemsTree);
+    if (groupResult.shouldReturn) {
+      return groupResult.value;
     }
+    localDataApiObj = groupResult.value;
+  } else {
+    searchTextForApi = searchText;
+  }
 
-    // search API call
-    const response = await dataApiObj.fetchData(searchTextForUngroupedData).catch(() => {
-      return itemsTree;
-    });
+  const response = await localDataApiObj.fetchData(searchTextForApi).catch(() => ({ data: undefined }));
 
-    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));
+  let listObjData = response.data;
+  if (!listObjData) {
+    return itemsTree;
+  }
+
+  if (isGroupData) {
+    if (searchText) {
+      listObjData = prepareSearchResults(listObjData, displayFieldMeta);
+    } else {
+      return putItemsDataInItemsTree(listObjData, displayFieldMeta, itemsTree, showSecondaryInSearchOnly, selected);
     }
-    return newItemsTree;
   }
 
-  return itemsTree;
+  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) {

package/lib/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/lib/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();
+  });
+});