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

package/tests/assets/sdk-a/components/createAll/custom-sdk/field/pega-dxil-my-percentage/pega-dxil-my-percentage.component.ts

@@ -1,19 +1,18 @@
-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 PegaDxilMyPercentageProps extends PConnFieldProps {
+interface PegaDxilMyPercentageProps extends Omit<PConnFieldProps, 'value'> {
+  value?: number;
   showGroupSeparators?: string;
   decimalPrecision?: number;
   currencyISOCode?: string;
@@ -24,158 +23,56 @@ interface PegaDxilMyPercentageProps extends PConnFieldProps {
   selector: 'app-pega-dxil-my-percentage',
   templateUrl: './pega-dxil-my-percentage.component.html',
   styleUrls: ['./pega-dxil-my-percentage.component.scss'],
-  standalone: true,
   imports: [CommonModule, ReactiveFormsModule, MatFormFieldModule, MatInputModule, NgxCurrencyDirective, forwardRef(() => ComponentMapperComponent)]
 })
-export class PegaDxilMyPercentageComponent implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
-
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
+export class PegaDxilMyPercentageComponent extends FieldBase {
   configProps$: PegaDxilMyPercentageProps;
+  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);
-
-    // Then, continue on with other initialization
-    // call updateSelf when initializing
-    // this.updateSelf();
-    this.checkAndUpdate();
+  /**
+   * 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 PegaDxilMyPercentageProps;
 
-    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;
-    }
-  }
+    // Update component common properties
+    this.updateComponentCommonProperties(this.configProps$);
 
-  ngOnDestroy(): void {
-    if (this.formGroup$) {
-      this.formGroup$.removeControl(this.controlName$);
+    // Set component specific properties
+    const { value } = this.configProps$;
+    if (value) {
+      this.value$ = value;
+      this.fieldControl.setValue(value);
     }
 
-    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 PegaDxilMyPercentageProps;
-    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 +108,4 @@ export class PegaDxilMyPercentageComponent 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/createAll/custom-sdk/field/pega-dxil-my-phone/config.json

@@ -5,7 +5,6 @@
   "organization": "Pega",
   "version": "0.0.1",
   "library": "DXIL",
-  "allowedApplications": [],
   "componentKey": "Pega_DXIL_MyPhone",
   "type": "Field",
   "subtype": "Text-Phone",

package/tests/assets/sdk-a/components/createAll/custom-sdk/field/pega-dxil-my-phone/pega-dxil-my-phone.component.html

@@ -4,19 +4,20 @@
 <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
+      <mat-form-field class="psdk-full-width" subscriptSizing="dynamic" [hintLabel]="helperText" floatLabel="always">
+        <mat-tel-input
           [attr.data-test-id]="testId"
           [formControl]="fieldControl"
-          [preferredCountries]="['us']"
+          [preferredCountries]="preferredCountries"
           [enablePlaceholder]="true"
           [enableSearch]="true"
+          [placeholder]="placeholder"
           [required]="bRequired$"
           [disabled]="bDisabled$ || bReadonly$"
           (change)="fieldOnChange()"
           (blur)="fieldOnBlur()"
         >
-        </ngx-mat-intl-tel-input>
+        </mat-tel-input>
         <mat-label>{{ label$ }}</mat-label>
         <mat-error *ngIf="fieldControl.invalid">{{ getErrorMessage() }}</mat-error>
       </mat-form-field>

package/tests/assets/sdk-a/components/createAll/custom-sdk/field/pega-dxil-my-phone/pega-dxil-my-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;

package/tests/assets/sdk-a/components/createAll/custom-sdk/field/pega-dxil-my-phone/pega-dxil-my-phone.component.ts

@@ -1,13 +1,13 @@
-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 { ReactiveFormsModule } from '@angular/forms';
 import { MatFormFieldModule } from '@angular/material/form-field';
-import { interval } from 'rxjs';
-import { NgxMatIntlTelInputComponent } from 'ngx-mat-intl-tel-input';
-import { Utils } from '@pega/angular-sdk-components';
-import { AngularPConnectData, AngularPConnectService } from '@pega/angular-sdk-components';
-import { handleEvent } from '@pega/angular-sdk-components';
+import { MatTelInput } from 'mat-tel-input';
+import { parsePhoneNumberFromString } from 'libphonenumber-js';
+
+import { FieldBase } from '@pega/angular-sdk-components';
 import { ComponentMapperComponent } from '@pega/angular-sdk-components';
+import { handleEvent } from '@pega/angular-sdk-components';
 import { PConnFieldProps } from '@pega/angular-sdk-components';
 
 interface PegaDxilMyPhoneProps extends PConnFieldProps {
@@ -18,140 +18,29 @@ interface PegaDxilMyPhoneProps extends PConnFieldProps {
   selector: 'app-pega-dxil-my-phone',
   templateUrl: './pega-dxil-my-phone.component.html',
   styleUrls: ['./pega-dxil-my-phone.component.scss'],
-  standalone: true,
-  imports: [CommonModule, ReactiveFormsModule, MatFormFieldModule, NgxMatIntlTelInputComponent, forwardRef(() => ComponentMapperComponent)]
+  imports: [CommonModule, ReactiveFormsModule, MatFormFieldModule, MatTelInput, forwardRef(() => ComponentMapperComponent)]
 })
-export class PegaDxilMyPhoneComponent implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
-
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
+export class PegaDxilMyPhoneComponent extends FieldBase {
   configProps$: PegaDxilMyPhoneProps;
 
-  label$ = '';
-  value$: string;
-  bRequired$ = false;
-  bReadonly$ = false;
-  bDisabled$ = false;
-  bVisible$ = true;
-  displayMode$?: string = '';
-  controlName$: string;
-  bHasForm$ = true;
-  testId: string;
-  helperText: string;
-
-  fieldControl = new FormControl('', null);
-
-  actionsApi: Object;
-  propName: 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);
-
-    // Then, continue on with other initialization
-
-    // call updateSelf when initializing
-    // this.updateSelf();
-    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.bReadonly$ = true;
-      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();
-  }
-
-  checkAndUpdate() {
-    // Should always check the bridge to see if the component should
-    // update itself (re-render)
-    const bUpdateSelf = this.angularPConnect.shouldComponentUpdate(this);
+  preferredCountries: string[] = ['us'];
 
-    // 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...
+  /**
+   * Updates the component when there are changes in the state.
+   */
+  override updateSelf(): void {
+    // Resolve config properties
     this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps()) as PegaDxilMyPhoneProps;
 
-    this.label$ = this.configProps$.label;
-    this.displayMode$ = this.configProps$.displayMode;
-    this.testId = this.configProps$.testId;
-    if (this.configProps$.value != undefined) {
-      this.value$ = this.configProps$.value;
-      this.fieldControl.setValue(this.value$);
-    }
-    this.helperText = this.configProps$.helperText;
-
-    this.actionsApi = this.pConn$.getActionsApi();
-    this.propName = this.pConn$.getStateProps().value;
-
-    // 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);
-    }
-
-    // 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();
+    // Update component common properties
+    this.updateComponentCommonProperties(this.configProps$);
 
-        timer.unsubscribe();
-      });
+    // Extract and normalize the value property
+    const { value } = this.configProps$;
+    if (value) {
+      this.value$ = value;
+      this.fieldControl.setValue(this.value$);
+      this.updatePreferredCountries();
     }
   }
 
@@ -164,26 +53,36 @@ export class PegaDxilMyPhoneComponent implements OnInit, OnDestroy {
     const newVal = this.formGroup$.controls[this.controlName$].value;
     const isValueChanged = newVal?.toString() !== oldVal.toString();
 
-    if (isValueChanged && newVal) {
+    if (isValueChanged) {
       const value = this.formGroup$.controls[this.controlName$].value;
       handleEvent(this.actionsApi, 'changeNblur', this.propName, value);
     }
   }
 
-  getErrorMessage() {
-    let errMessage = '';
+  updatePreferredCountries() {
+    if (this.value$ && typeof this.value$ === 'string') {
+      const phoneNumber = parsePhoneNumberFromString(this.value$);
+      this.preferredCountries =
+        phoneNumber?.country && !this.preferredCountries.includes(phoneNumber?.country.toLowerCase())
+          ? [phoneNumber?.country?.toLowerCase(), ...this.preferredCountries]
+          : this.preferredCountries;
+    }
+  }
 
+  override getErrorMessage() {
     // 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;
+      return this.angularPConnectData.validateMessage ?? '';
     }
+
     if (this.fieldControl.hasError('required')) {
-      errMessage = 'You must enter a value';
-    } else if (this.fieldControl.errors) {
-      errMessage = 'Invalid Phone';
+      return 'You must enter a value';
+    }
+
+    if (this.fieldControl.errors) {
+      return 'Invalid Phone';
     }
 
-    return errMessage;
+    return '';
   }
 }

package/tests/assets/sdk-a/components/createAll/custom-sdk/field/pega-dxil-my-picklist/config.json

@@ -5,7 +5,6 @@
   "organization": "Pega",
   "version": "0.0.1",
   "library": "DXIL",
-  "allowedApplications": [],
   "componentKey": "Pega_DXIL_MyPicklist",
   "type": "Field",
   "subtype": "Picklist",