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

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

@@ -1,12 +1,11 @@
-import { Component, OnInit, Input, ChangeDetectorRef, forwardRef, OnDestroy } from '@angular/core';
+import { Component, OnInit, forwardRef, OnDestroy } from '@angular/core';
 import { CommonModule } from '@angular/common';
-import { FormControl, FormGroup, ReactiveFormsModule } from '@angular/forms';
+import { ReactiveFormsModule } from '@angular/forms';
 import { MatCheckboxModule } from '@angular/material/checkbox';
 import { MatFormFieldModule } from '@angular/material/form-field';
 import { MatOptionModule } from '@angular/material/core';
-import { interval } from 'rxjs';
-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 { PConnFieldProps } from '@pega/angular-sdk-components';
 import { deleteInstruction, insertInstruction, updateNewInstructions } from '@pega/angular-sdk-components';
@@ -26,38 +25,22 @@ interface CheckboxProps extends Omit<PConnFieldProps, 'value'> {
   primaryField: string;
   readonlyContextList: any;
   referenceList: string;
+  variant?: string;
+  renderMode: string;
 }
 
 @Component({
   selector: 'app-check-box',
   templateUrl: './check-box.component.html',
   styleUrls: ['./check-box.component.scss'],
-  standalone: true,
   imports: [CommonModule, ReactiveFormsModule, MatCheckboxModule, MatFormFieldModule, MatOptionModule, forwardRef(() => ComponentMapperComponent)]
 })
-export class CheckBoxComponent implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
-
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
+export class CheckBoxComponent extends FieldBase implements OnInit, OnDestroy {
   configProps$: CheckboxProps;
 
-  label$ = '';
-  value$: any = '';
   caption$?: string = '';
-  testId = '';
   showLabel$ = false;
   isChecked$ = false;
-  bRequired$ = false;
-  bReadonly$ = false;
-  bDisabled$ = false;
-  bVisible$ = true;
-  displayMode$?: string = '';
-  controlName$: string;
-  bHasForm$ = true;
-  componentReference = '';
-  helperText: string;
   trueLabel$?: string;
   falseLabel$?: string;
 
@@ -69,84 +52,35 @@ export class CheckBoxComponent implements OnInit, OnDestroy {
   selectedvalues: any;
   referenceList: string;
   listOfCheckboxes: any[] = [];
-  actionsApi: Object;
-  propName: string;
-
-  fieldControl = new FormControl('', null);
-
-  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
+  variant?: string;
 
-    // call updateSelf when initializing
-    // this.updateSelf();
-    this.checkAndUpdate();
+  // Override ngOnInit method
+  override ngOnInit(): void {
+    super.ngOnInit();
 
-    if (this.selectionMode === 'multi' && this.referenceList?.length > 0) {
+    if (this.selectionMode === 'multi' && this.referenceList?.length > 0 && !this.bReadonly$) {
       this.pConn$.setReferenceList(this.selectionList);
       updateNewInstructions(this.pConn$, this.selectionList);
     }
-
-    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);
-
-    // ONLY call updateSelf when the component should update
-    if (bUpdateSelf) {
-      this.updateSelf();
-    }
-  }
-
-  // updateSelf
-  updateSelf(): void {
+  /**
+   * Updates the component when there are changes in the state.
+   */
+  override updateSelf(): void {
     // moved this from ngOnInit() and call this from there instead...
     this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps()) as CheckboxProps;
 
-    this.testId = this.configProps$.testId;
-    this.displayMode$ = this.configProps$.displayMode;
-    this.label$ = this.configProps$.label;
+    // Update component common properties
+    this.updateComponentCommonProperties(this.configProps$);
+
     if (this.label$ != '') {
       this.showLabel$ = true;
     }
-
-    this.actionsApi = this.pConn$.getActionsApi();
-    this.propName = this.pConn$.getStateProps().value;
+    this.variant = this.configProps$.variant;
+    if (this.bReadonly$) {
+      this.fieldControl?.disable();
+    }
 
     // multi case
     this.selectionMode = this.configProps$.selectionMode;
@@ -155,6 +89,7 @@ export class CheckBoxComponent implements OnInit, OnDestroy {
       this.selectionList = this.configProps$.selectionList;
       this.selectedvalues = this.configProps$.readonlyContextList;
       this.primaryField = this.configProps$.primaryField;
+      this.bReadonly$ = this.configProps$.renderMode === 'ReadOnly' || this.displayMode$ === 'DISPLAY_ONLY' || this.configProps$.readOnly;
 
       this.datasource = this.configProps$.datasource;
       this.selectionKey = this.configProps$.selectionKey;
@@ -172,54 +107,10 @@ export class CheckBoxComponent implements OnInit, OnDestroy {
       }
 
       this.caption$ = this.configProps$.caption;
-      this.helperText = this.configProps$.helperText;
       this.trueLabel$ = this.configProps$.trueLabel || 'Yes';
       this.falseLabel$ = this.configProps$.falseLabel || 'No';
 
-      // 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.configProps$.readOnly != null) {
-        this.bReadonly$ = this.utils.getBooleanValue(this.configProps$.readOnly);
-      }
-
-      if (this.bDisabled$ || this.bReadonly$) {
-        this.fieldControl.disable();
-      } else {
-        this.fieldControl.enable();
-      }
-
-      this.componentReference = this.pConn$.getStateProps().value;
-
-      // eslint-disable-next-line sonarjs/no-redundant-boolean
-      if (this.value$ === 'true' || this.value$ == true) {
-        this.isChecked$ = true;
-      } else {
-        this.isChecked$ = false;
-      }
-      // 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();
-        });
-      }
+      this.isChecked$ = this.value$ === 'true' || this.value$ == true;
     }
   }
 
@@ -257,21 +148,4 @@ export class CheckBoxComponent implements OnInit, OnDestroy {
       context: ''
     });
   }
-
-  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/tests/assets/sdk-a/components/create/override-sdk/field/currency/currency.component.ts

@@ -1,17 +1,16 @@
-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, getCurrencyOptions } 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 CurrrencyProps extends PConnFieldProps {
   // If any, enter additional props that only exist on Currency here
@@ -24,176 +23,61 @@ interface CurrrencyProps extends PConnFieldProps {
   selector: 'app-currency',
   templateUrl: './currency.component.html',
   styleUrls: ['./currency.component.scss'],
-  standalone: true,
   imports: [CommonModule, ReactiveFormsModule, MatFormFieldModule, MatInputModule, NgxCurrencyDirective, forwardRef(() => ComponentMapperComponent)]
 })
-export class CurrencyComponent implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
-
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
+export class CurrencyComponent extends FieldBase {
   configProps$: CurrrencyProps;
+  override fieldControl = new FormControl<number | null>(null, { updateOn: 'blur' });
 
-  label$ = '';
-  value$: any;
-  bRequired$ = false;
-  bReadonly$ = false;
-  bDisabled$ = false;
-  bVisible$ = true;
-  displayMode$?: string = '';
-  controlName$: string;
-  bHasForm$ = true;
-  componentReference = '';
-  testId: string;
-  helperText: string;
-  placeholder: string;
-  currencyISOCode = 'USD';
-  currencyOptions: Object = {};
-
-  fieldControl = new FormControl<number | null>(null, { updateOn: 'blur' });
+  currencyOptions: object = {};
   currencySymbol: string;
   thousandSeparator: string;
   decimalSeparator: string;
-  inputMode: any;
   decimalPrecision: number | undefined;
   formattedValue: string;
   formatter;
+  inputMode = NgxCurrencyInputMode.Natural;
 
-  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
+  /**
+   * 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 CurrrencyProps;
 
-    // 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);
+    // Extract and normalize the value property
+    const { value } = this.configProps$;
+    if (value) {
+      this.value$ = typeof value === 'string' ? parseFloat(value) : value;
       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);
 
-    // ONLY call updateSelf when the component should update
-    if (bUpdateSelf) {
-      this.updateSelf();
-    }
+    // update currency properties
+    this.updateCurrencyProperties(this.configProps$);
   }
 
-  // updateSelf
-  updateSelf(): void {
-    // starting very simple...
-
-    // moved this from ngOnInit() and call this from there instead...
-    this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps()) as CurrrencyProps;
-    this.testId = this.configProps$.testId;
-    this.label$ = this.configProps$.label;
-    this.displayMode$ = this.configProps$.displayMode;
-    this.inputMode = NgxCurrencyInputMode.Natural;
-    let nValue: any = this.configProps$.value;
-    if (nValue) {
-      if (typeof nValue === 'string') {
-        nValue = parseFloat(nValue);
-      }
-      this.value$ = nValue;
-      this.fieldControl.setValue(this.value$);
-    }
-    this.helperText = this.configProps$.helperText;
-    this.placeholder = this.configProps$.placeholder || '';
-    const currencyISOCode = this.configProps$?.currencyISOCode ?? '';
+  /**
+   * Updates the currency properties
+   *
+   * @param {Object} configProps - Configuration properties.
+   * @param {boolean} configProps.allowDecimals - Whether to allow decimal values.
+   * @param {string} configProps.currencyISOCode - The ISO code of the currency.
+   * @param {string} configProps.formatter - The formatter type (e.g., 'currency').
+   */
+  protected updateCurrencyProperties(configProps): void {
+    const { allowDecimals, currencyISOCode = 'USD', formatter } = configProps;
 
     const theSymbols = getCurrencyCharacters(currencyISOCode);
     this.currencySymbol = theSymbols.theCurrencySymbol;
     this.thousandSeparator = theSymbols.theDigitGroupSeparator;
     this.decimalSeparator = theSymbols.theDecimalIndicator;
-    this.formatter = this.configProps$.formatter;
+    this.decimalPrecision = allowDecimals ? 2 : 0;
 
-    if (this.displayMode$ === 'DISPLAY_ONLY' || this.displayMode$ === 'STACKED_LARGE_VAL') {
-      const theCurrencyOptions = getCurrencyOptions(currencyISOCode);
-      if (this.formatter) {
-        this.formattedValue = format(this.value$, this.formatter.toLowerCase(), theCurrencyOptions);
-      } else {
-        this.formattedValue = format(this.value$, 'currency', theCurrencyOptions);
-      }
-    }
-
-    // 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);
-    }
-
-    if (this.configProps$.currencyISOCode != null) {
-      this.currencyISOCode = this.configProps$.currencyISOCode;
-    }
-
-    this.decimalPrecision = this.configProps$?.allowDecimals ? 2 : 0;
-
-    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 = format(this.value$, formatter ? formatter.toLowerCase() : 'currency', getCurrencyOptions(currencyISOCode));
     }
   }
 
@@ -218,21 +102,4 @@ export class CurrencyComponent implements OnInit, OnDestroy {
       handleEvent(actionsApi, 'changeNblur', propName, value);
     }
   }
-
-  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/tests/assets/sdk-a/components/create/override-sdk/field/date/date.component.html

@@ -11,7 +11,7 @@
           #dateInput
           [attr.data-test-id]="testId"
           [matDatepicker]="pegadate"
-          [placeholder]="dateFormatInfo.dateFormatStringLC"
+          [placeholder]="theDateFormat.dateFormatStringLC"
           type="text"
           [value]="value$"
           [required]="bRequired$"
@@ -20,7 +20,7 @@
           (dateChange)="fieldOnDateChange($event)"
         />
         <mat-datepicker-toggle matSuffix [for]="pegadate" [disabled]="bDisabled$"></mat-datepicker-toggle>
-        <mat-datepicker #pegadate [startAt]="value$"></mat-datepicker>
+        <mat-datepicker #pegadate [startAt]="value$" xPosition="end"></mat-datepicker>
         <mat-error *ngIf="fieldControl.invalid">{{ getErrorMessage() }}</mat-error>
       </mat-form-field>
     </div>