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

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

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

@@ -1,19 +1,19 @@
-import { Component, OnInit, Input, ChangeDetectorRef, forwardRef, OnDestroy } from '@angular/core';
+import { Component, forwardRef } from '@angular/core';
 import { CommonModule } from '@angular/common';
-import { FormControl, FormGroup, ReactiveFormsModule } from '@angular/forms';
+import { FormControl, ReactiveFormsModule } from '@angular/forms';
 import { MatInputModule } from '@angular/material/input';
 import { MatFormFieldModule } from '@angular/material/form-field';
-import { interval } from 'rxjs';
 import { NgxCurrencyDirective, NgxCurrencyInputMode } from 'ngx-currency';
-import { AngularPConnectData, AngularPConnectService } from '@pega/angular-sdk-components';
-import { Utils } from '@pega/angular-sdk-components';
+
+import { FieldBase } from '@pega/angular-sdk-components';
 import { ComponentMapperComponent } from '@pega/angular-sdk-components';
 import { handleEvent } from '@pega/angular-sdk-components';
 import { getCurrencyCharacters } from '@pega/angular-sdk-components';
-import { PConnFieldProps } from '@pega/angular-sdk-components';
 import { format } from '@pega/angular-sdk-components';
+import { PConnFieldProps } from '@pega/angular-sdk-components';
 
-interface PercentageProps extends PConnFieldProps {
+interface PercentageProps extends Omit<PConnFieldProps, 'value'> {
+  value?: number;
   showGroupSeparators?: string;
   decimalPrecision?: number;
   currencyISOCode?: string;
@@ -24,158 +24,56 @@ interface PercentageProps extends PConnFieldProps {
   selector: 'app-percentage',
   templateUrl: './percentage.component.html',
   styleUrls: ['./percentage.component.scss'],
-  standalone: true,
   imports: [CommonModule, ReactiveFormsModule, MatFormFieldModule, MatInputModule, NgxCurrencyDirective, forwardRef(() => ComponentMapperComponent)]
 })
-export class PercentageComponent implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
-
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
+export class PercentageComponent extends FieldBase {
   configProps$: PercentageProps;
+  override fieldControl = new FormControl<number | null>(null, null);
 
-  label$ = '';
-  value$: number;
-  bRequired$ = false;
-  bReadonly$ = false;
-  bDisabled$ = false;
-  bVisible$ = true;
-  displayMode$?: string = '';
-  controlName$: string;
-  bHasForm$ = true;
-  componentReference = '';
-  testId: string;
-  helperText: string;
-  placeholder: string;
   decimalSeparator: string;
   thousandSeparator: string;
-  inputMode: any;
+  inputMode: any = NgxCurrencyInputMode.Natural;
   decimalPrecision: number | undefined;
-  fieldControl = new FormControl<number | null>(null, null);
-  actionsApi: Object;
-  propName: string;
   formattedValue: string;
 
-  constructor(
-    private angularPConnect: AngularPConnectService,
-    private cdRef: ChangeDetectorRef,
-    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);
+  /**
+   * Updates the component when there are changes in the state.
+   */
+  override updateSelf(): void {
+    // Resolve configuration properties
+    this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps()) as PercentageProps;
 
-    // Then, continue on with other initialization
-    // call updateSelf when initializing
-    // this.updateSelf();
-    this.checkAndUpdate();
+    // Update component common properties
+    this.updateComponentCommonProperties(this.configProps$);
 
-    if (this.formGroup$) {
-      // add control to formGroup
-      this.formGroup$.addControl(this.controlName$, this.fieldControl);
-      this.fieldControl.setValue(this.value$);
-      this.bHasForm$ = true;
-    } else {
-      this.bReadonly$ = true;
-      this.bHasForm$ = false;
+    // Set component specific properties
+    const { value } = this.configProps$;
+    if (value) {
+      this.value$ = value;
+      this.fieldControl.setValue(value);
     }
-  }
 
-  ngOnDestroy(): void {
-    if (this.formGroup$) {
-      this.formGroup$.removeControl(this.controlName$);
-    }
-
-    if (this.angularPConnectData.unsubscribeFn) {
-      this.angularPConnectData.unsubscribeFn();
-    }
+    // update percentage properties
+    this.updatePercentageProperties(this.configProps$);
   }
 
-  // Callback passed when subscribing to store change
-  onStateChange() {
-    this.checkAndUpdate();
-  }
-
-  checkAndUpdate() {
-    // Should always check the bridge to see if the component should
-    // update itself (re-render)
-    const bUpdateSelf = this.angularPConnect.shouldComponentUpdate(this);
-
-    // ONLY call updateSelf when the component should update
-    if (bUpdateSelf) {
-      this.updateSelf();
-    }
-  }
-
-  // updateSelf
-  updateSelf(): void {
-    // moved this from ngOnInit() and call this from there instead...
-    this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps()) as PercentageProps;
-    this.testId = this.configProps$.testId;
-    this.label$ = this.configProps$.label;
-    this.displayMode$ = this.configProps$.displayMode;
-    this.inputMode = NgxCurrencyInputMode.Natural;
-    const nValue: any = this.configProps$.value;
-    if (nValue) {
-      this.value$ = nValue;
-      this.fieldControl.setValue(nValue);
-    }
-    this.helperText = this.configProps$.helperText;
-    this.placeholder = this.configProps$.placeholder || '';
-    const showGroupSeparators = this.configProps$.showGroupSeparators;
+  /**
+   * Updates the percentage properties
+   *
+   * @param {Object} configProps - Configuration properties.
+   * @param {boolean} configProps.showGroupSeparators - Whether to show group separators.
+   * @param {number} configProps.decimalPrecision - The number of decimal places to display.
+   */
+  updatePercentageProperties(configProps): void {
+    const { showGroupSeparators, decimalPrecision } = configProps;
 
     const theSymbols = getCurrencyCharacters('');
     this.decimalSeparator = theSymbols.theDecimalIndicator;
     this.thousandSeparator = showGroupSeparators ? theSymbols.theDigitGroupSeparator : '';
+    this.decimalPrecision = decimalPrecision ?? 2;
 
-    this.actionsApi = this.pConn$.getActionsApi();
-    this.propName = this.pConn$.getStateProps().value;
-
-    if (this.displayMode$ === 'DISPLAY_ONLY' || this.displayMode$ === 'STACKED_LARGE_VAL') {
-      this.formattedValue = nValue ? format(nValue, 'percentage') : '';
-    }
-
-    // timeout and detectChanges to avoid ExpressionChangedAfterItHasBeenCheckedError
-    setTimeout(() => {
-      if (this.configProps$.required != null) {
-        this.bRequired$ = this.utils.getBooleanValue(this.configProps$.required);
-      }
-      this.cdRef.detectChanges();
-    });
-
-    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();
-    }
-
-    if (this.configProps$.readOnly != null) {
-      this.bReadonly$ = this.utils.getBooleanValue(this.configProps$.readOnly);
-    }
-
-    this.decimalPrecision = this.configProps$?.decimalPrecision ?? 2;
-
-    this.componentReference = this.pConn$.getStateProps().value;
-
-    // trigger display of error message with field control
-    if (this.angularPConnectData.validateMessage != null && this.angularPConnectData.validateMessage != '') {
-      const timer = interval(100).subscribe(() => {
-        this.fieldControl.setErrors({ message: true });
-        this.fieldControl.markAsTouched();
-        timer.unsubscribe();
-      });
+    if (['DISPLAY_ONLY', 'STACKED_LARGE_VAL'].includes(this.displayMode$)) {
+      this.formattedValue = this.value$ ? format(this.value$, 'percentage') : '';
     }
   }
 
@@ -211,20 +109,4 @@ export class PercentageComponent implements OnInit, OnDestroy {
       handleEvent(this.actionsApi, 'changeNblur', this.propName, value);
     }
   }
-
-  getErrorMessage() {
-    // field control gets error message from here
-    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/tests/assets/sdk-a/components/create/override-sdk/field/phone/phone.component.html

@@ -2,25 +2,24 @@
   <component-mapper *ngIf="bVisible$ !== false" name="FieldValueList" [props]="{ label$, value$, displayMode$ }"></component-mapper>
 </div>
 <ng-template #noDisplayMode>
-  <div *ngIf="bHasForm$; else noEdit">
-    <div #f="ngForm" [formGroup]="formGroup$" *ngIf="bVisible$">
-      <mat-form-field class="psdk-full-width" subscriptSizing="dynamic" [hintLabel]="helperText">
-        <ngx-mat-intl-tel-input
-          [attr.data-test-id]="testId"
-          [formControl]="fieldControl"
-          [preferredCountries]="['us']"
-          [enablePlaceholder]="true"
-          [enableSearch]="true"
-          [required]="bRequired$"
-          [disabled]="bDisabled$ || bReadonly$"
-          (change)="fieldOnChange()"
-          (blur)="fieldOnBlur()"
-        >
-        </ngx-mat-intl-tel-input>
-        <mat-label>{{ label$ }}</mat-label>
-        <mat-error *ngIf="fieldControl.invalid">{{ getErrorMessage() }}</mat-error>
-      </mat-form-field>
-    </div>
+  <div *ngIf="bHasForm$ && bVisible$; else noEdit">
+    <mat-form-field class="psdk-full-width" subscriptSizing="dynamic" [hintLabel]="helperText" floatLabel="always">
+      <mat-tel-input
+        [attr.data-test-id]="testId"
+        [formControl]="fieldControl"
+        [preferredCountries]="preferredCountries"
+        [enablePlaceholder]="true"
+        [enableSearch]="true"
+        [placeholder]="placeholder"
+        [required]="bRequired$"
+        [disabled]="bDisabled$ || bReadonly$"
+        (change)="fieldOnChange()"
+        (blur)="fieldOnBlur()"
+      >
+      </mat-tel-input>
+      <mat-label>{{ label$ }}</mat-label>
+      <mat-error *ngIf="fieldControl.invalid">{{ getErrorMessage() }}</mat-error>
+    </mat-form-field>
   </div>
 </ng-template>
 <ng-template #noEdit>

package/tests/assets/sdk-a/components/create/override-sdk/field/phone/phone.component.scss

@@ -24,6 +24,10 @@
   font-size: 0.7rem;
 }
 
+::ng-deep .mat-mdc-menu-panel {
+  max-width: 20rem;
+}
+
 // ::ng-deep .iti {
 //   display: block !important;
 //   margin-bottom: 20px;