@pega/dx-component-builder-sdk 25.1.12 → 25.1.13

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

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

@@ -0,0 +1,237 @@
+import { CommonModule } from '@angular/common';
+import { Component, Input, OnInit, forwardRef, OnDestroy } from '@angular/core';
+import { FormGroup } from '@angular/forms';
+import { ComponentMetadataConfig } from '@pega/pcore-pconnect-typedefs/interpreter/types';
+import { AngularPConnectData, AngularPConnectService } from '@pega/angular-sdk-components';
+import { ComponentMapperComponent } from '@pega/angular-sdk-components';
+import { generateColumns, getDataRelationshipContextFromKey } from '@pega/angular-sdk-components';
+import { PConnFieldProps } from '@pega/angular-sdk-components';
+
+interface ObjectReferenceProps extends PConnFieldProps {
+  showPromotedFilters: boolean;
+  inline: boolean;
+  parameters: object;
+  mode: string;
+  targetObjectType: any;
+  allowAndPersistChangesInReviewMode: boolean;
+}
+
+@Component({
+  selector: 'app-object-reference',
+  imports: [CommonModule, forwardRef(() => ComponentMapperComponent)],
+  templateUrl: './object-reference.component.html',
+  styleUrl: './object-reference.component.scss'
+})
+export class ObjectReferenceComponent implements OnInit, OnDestroy {
+  @Input() pConn$: typeof PConnect;
+  @Input() formGroup$: FormGroup;
+
+  angularPConnectData: AngularPConnectData = {};
+  configProps: ObjectReferenceProps;
+  value: { [key: string]: any };
+  readOnly: boolean;
+  isForm: boolean;
+  type: string;
+  isDisplayModeEnabled: boolean;
+  canBeChangedInReviewMode: boolean;
+  newComponentName: string;
+  newPconn: typeof PConnect;
+  rawViewMetadata: ComponentMetadataConfig | undefined;
+
+  constructor(private angularPConnect: AngularPConnectService) {}
+
+  ngOnInit() {
+    this.angularPConnectData = this.angularPConnect.registerAndSubscribeComponent(this, this.onStateChange);
+    this.checkAndUpdate();
+  }
+
+  onStateChange() {
+    this.checkAndUpdate();
+  }
+
+  ngOnDestroy() {
+    if (this.angularPConnectData.unsubscribeFn) {
+      this.angularPConnectData.unsubscribeFn();
+    }
+  }
+
+  checkAndUpdate() {
+    const shouldUpdate = this.angularPConnect.shouldComponentUpdate(this);
+    if (shouldUpdate) {
+      this.updateSelf();
+    }
+  }
+
+  updateSelf() {
+    this.configProps = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps()) as ObjectReferenceProps;
+    const {
+      displayMode,
+      allowAndPersistChangesInReviewMode: editableInReview = false,
+      targetObjectType,
+      mode,
+      parameters,
+      hideLabel,
+      inline,
+      showPromotedFilters
+    } = this.configProps;
+
+    const referenceType: string = targetObjectType === 'case' ? 'Case' : 'Data';
+    this.rawViewMetadata = this.pConn$.getRawMetadata();
+    const refFieldMetadata = this.pConn$.getFieldMetadata(this.rawViewMetadata?.config?.value?.split('.', 2)[1] ?? '');
+    const propsToUse = { ...this.pConn$.getInheritedProps(), ...this.configProps };
+
+    this.isDisplayModeEnabled = displayMode === 'DISPLAY_ONLY';
+    this.type = this.getComponentType();
+    this.canBeChangedInReviewMode = editableInReview && ['Autocomplete', 'Dropdown'].includes(this.type);
+
+    if (this.type === 'SemanticLink' && !this.canBeChangedInReviewMode) {
+      const config: any = {
+        ...this.rawViewMetadata?.config,
+        primaryField: (this.rawViewMetadata?.config as any).displayField,
+        caseClass: (this.rawViewMetadata?.config as any).targetObjectClass,
+        text: (this.rawViewMetadata?.config as any).displayField,
+        caseID: (this.rawViewMetadata?.config as any).value,
+        contextPage: `@P .${(this.rawViewMetadata?.config as any).displayField ? getDataRelationshipContextFromKey((this.rawViewMetadata?.config as any).displayField) : null}`,
+        resourceParams: { workID: (this.rawViewMetadata?.config as any).value },
+        resourcePayload: { caseClassName: (this.rawViewMetadata?.config as any).targetObjectClass }
+      };
+      this.createSemanticLinkPConnect(config, displayMode ?? '', referenceType, hideLabel);
+      return;
+    }
+
+    if (this.type !== 'SemanticLink' && !this.isDisplayModeEnabled) {
+      const config: any = { ...this.rawViewMetadata?.config };
+      generateColumns(config, this.pConn$, referenceType);
+      config.deferDatasource = true;
+      config.listType = 'datapage';
+      if (['Dropdown', 'AutoComplete'].includes(this.type) && !config.placeholder) {
+        config.placeholder = '@L Select...';
+      }
+      config.showPromotedFilters = showPromotedFilters;
+      if (!this.canBeChangedInReviewMode) {
+        config.displayMode = displayMode;
+      }
+      config.parameters = parameters;
+
+      this.createOtherComponentPConnect(config, propsToUse, mode, refFieldMetadata, referenceType, hideLabel, inline);
+    }
+  }
+
+  onRecordChange(value) {
+    const caseKey = this.pConn$.getCaseInfo().getKey() ?? '';
+    const refreshOptions = { autoDetectRefresh: true, propertyName: '' };
+    refreshOptions.propertyName = this.rawViewMetadata?.config?.value ?? '';
+
+    if (!this.canBeChangedInReviewMode || !this.pConn$.getValue('__currentPageTabViewName')) {
+      const pgRef = this.pConn$.getPageReference().replace('caseInfo.content', '') ?? '';
+      const viewName = this.rawViewMetadata?.name;
+      if (viewName && viewName.length > 0) {
+        getPConnect().getActionsApi().refreshCaseView(caseKey, viewName, pgRef, refreshOptions);
+      }
+    }
+
+    const propValue = value;
+    const propName =
+      this.rawViewMetadata?.type === 'SimpleTableSelect' && this.configProps.mode === 'multi'
+        ? PCore.getAnnotationUtils().getPropertyName(this.rawViewMetadata?.config?.selectionList ?? '')
+        : PCore.getAnnotationUtils().getPropertyName(this.rawViewMetadata?.config?.value ?? '');
+
+    if (propValue && this.canBeChangedInReviewMode && this.isDisplayModeEnabled) {
+      PCore.getCaseUtils()
+        .getCaseEditLock(caseKey, '')
+        .then(caseResponse => {
+          const pageTokens = this.pConn$.getPageReference().replace('caseInfo.content', '').split('.');
+          let curr = {};
+          const commitData = curr;
+
+          pageTokens?.forEach(el => {
+            if (el !== '') {
+              curr[el] = {};
+              curr = curr[el];
+            }
+          });
+
+          // expecting format like {Customer: {pyID:"C-100"}}
+          const propArr = propName.split('.');
+          propArr.forEach((element, idx) => {
+            if (idx + 1 === propArr.length) {
+              curr[element] = propValue;
+            } else {
+              curr[element] = {};
+              curr = curr[element];
+            }
+          });
+
+          PCore.getCaseUtils()
+            .updateCaseEditFieldsData(caseKey, { [caseKey]: commitData }, caseResponse.headers.etag, this.pConn$?.getContextName() ?? '')
+            .then(response => {
+              PCore.getContainerUtils().updateParentLastUpdateTime(this.pConn$.getContextName() ?? '', response.data.data.caseInfo.lastUpdateTime);
+              PCore.getContainerUtils().updateRelatedContextEtag(this.pConn$.getContextName() ?? '', response.headers.etag);
+            });
+        });
+    }
+  }
+
+  private getComponentType(): string {
+    // componentType is not defined in ComponentMetadataConfig type so using any
+    return (this.rawViewMetadata?.config as any)?.componentType;
+  }
+
+  private createSemanticLinkPConnect(config: any, displayMode: string, referenceType: string, hideLabel: boolean) {
+    const semanticLinkConfig = {
+      ...config,
+      displayMode,
+      referenceType,
+      hideLabel,
+      dataRelationshipContext: config.displayField ? getDataRelationshipContextFromKey(config.displayField) : null
+    };
+
+    const component = this.pConn$.createComponent({ type: 'SemanticLink', config: semanticLinkConfig }, '', 0, {});
+    this.newPconn = component?.getPConnect();
+  }
+
+  private createOtherComponentPConnect(
+    config: any,
+    propsToUse: any,
+    mode: string,
+    refFieldMetadata: any,
+    referenceType: string,
+    hideLabel: boolean,
+    inline: boolean
+  ) {
+    const fieldMetaData = {
+      datasourceMetadata: {
+        datasource: {
+          parameters: config.parameters ?? {},
+          propertyForDisplayText: config.datasource?.fields?.text?.substring(3) ?? config.datasource?.fields?.text,
+          propertyForValue: config.datasource?.fields?.value?.substring(3) ?? config.datasource?.fields?.value,
+          name: config.referenceList ?? ''
+        }
+      }
+    };
+
+    const componentConfig = {
+      ...config,
+      descriptors: mode === 'single' ? refFieldMetadata?.descriptors : null,
+      datasourceMetadata: fieldMetaData.datasourceMetadata,
+      required: propsToUse.required,
+      visibility: propsToUse.visibility,
+      disabled: propsToUse.disabled,
+      label: propsToUse.label,
+      readOnly: false,
+      ...(mode === 'single' && { referenceType }),
+      contextClass: config.targetObjectClass,
+      primaryField: config.displayField,
+      dataRelationshipContext: config.displayField ? getDataRelationshipContextFromKey(config.displayField) : null,
+      hideLabel,
+      inline
+    };
+
+    const component = this.pConn$.createComponent({ type: this.type, config: componentConfig }, '', 0, {});
+    this.newComponentName = component?.getPConnect().getComponentName();
+    this.newPconn = component?.getPConnect();
+    if (this.rawViewMetadata?.config) {
+      this.rawViewMetadata.config = { ...config };
+    }
+  }
+}