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

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

@@ -1,17 +1,15 @@
-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 PegaDxilMyCurrencyProps extends PConnFieldProps {
   // If any, enter additional props that only exist on Currency here
@@ -24,176 +22,61 @@ interface PegaDxilMyCurrencyProps extends PConnFieldProps {
   selector: 'app-pega-dxil-my-currency',
   templateUrl: './pega-dxil-my-currency.component.html',
   styleUrls: ['./pega-dxil-my-currency.component.scss'],
-  standalone: true,
   imports: [CommonModule, ReactiveFormsModule, MatFormFieldModule, MatInputModule, NgxCurrencyDirective, forwardRef(() => ComponentMapperComponent)]
 })
-export class PegaDxilMyCurrencyComponent implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
-
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
+export class PegaDxilMyCurrencyComponent extends FieldBase {
   configProps$: PegaDxilMyCurrencyProps;
+  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 PegaDxilMyCurrencyProps;
 
-    // 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();
-    }
+    // update currency properties
+    this.updateCurrencyProperties(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 {
-    // starting very simple...
-
-    // moved this from ngOnInit() and call this from there instead...
-    this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps()) as PegaDxilMyCurrencyProps;
-    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;
-
-    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);
-    }
+    this.decimalPrecision = allowDecimals ? 2 : 0;
 
-    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 +101,4 @@ export class PegaDxilMyCurrencyComponent 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/createAll/custom-sdk/field/pega-dxil-my-date/config.json

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

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

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

@@ -1,20 +1,18 @@
-import { Component, OnInit, Input, ChangeDetectorRef, forwardRef, Inject, 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 { MatDatepickerModule } from '@angular/material/datepicker';
 import { MatNativeDateModule } from '@angular/material/core';
 import { MatInputModule } from '@angular/material/input';
 import { MatFormFieldModule } from '@angular/material/form-field';
 import { MAT_DATE_FORMATS } from '@angular/material/core';
 import { MomentDateModule } from '@angular/material-moment-adapter';
-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 { dateFormatInfoDefault, getDateFormatInfo } from '@pega/angular-sdk-components';
-import { PConnFieldProps } from '@pega/angular-sdk-components';
+import { getDateFormatInfo } from '@pega/angular-sdk-components';
 import { format } from '@pega/angular-sdk-components';
 import { handleEvent } from '@pega/angular-sdk-components';
+import { PConnFieldProps } from '@pega/angular-sdk-components';
 
 interface PegaDxilMyDateProps extends PConnFieldProps {
   // If any, enter additional props that only exist on Date here
@@ -43,7 +41,6 @@ class MyFormat {
   selector: 'app-pega-dxil-my-date',
   templateUrl: './pega-dxil-my-date.component.html',
   styleUrls: ['./pega-dxil-my-date.component.scss'],
-  standalone: true,
   imports: [
     CommonModule,
     ReactiveFormsModule,
@@ -56,153 +53,32 @@ class MyFormat {
   ],
   providers: [{ provide: MAT_DATE_FORMATS, useClass: MyFormat }]
 })
-export class PegaDxilMyDateComponent implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
-
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
+export class PegaDxilMyDateComponent extends FieldBase implements OnInit, OnDestroy {
   configProps$: PegaDxilMyDateProps;
 
-  label$ = '';
-  value$: any;
-  bRequired$ = false;
-  bReadonly$ = false;
-  bDisabled$ = false;
-  bVisible$ = true;
-  displayMode$?: string = '';
-  controlName$: string;
-  bHasForm$ = true;
-  componentReference = '';
-  testId = '';
-  helperText: string;
-  placeholder: string;
-
-  fieldControl = new FormControl('', null);
-
-  // Start with default dateFormatInfo
-  dateFormatInfo = dateFormatInfoDefault;
-  // and then update, as needed, based on locale, etc.
   theDateFormat = getDateFormatInfo();
-  actionsApi: Object;
-  propName: string;
   formattedValue$: any;
 
-  constructor(
-    private angularPConnect: AngularPConnectService,
-    private cdRef: ChangeDetectorRef,
-    private utils: Utils,
-    @Inject(MAT_DATE_FORMATS) private config: MyFormat
-  ) {}
-
-  ngOnInit(): void {
-    this.dateFormatInfo = this.theDateFormat;
-    // 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);
-
-    // ONLY call updateSelf when the component should update
-    if (bUpdateSelf) {
-      this.updateSelf();
-    }
-  }
-
-  // updateSelf
-  updateSelf(): void {
-    // starting very simple...
-    // 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 PegaDxilMyDateProps;
 
-    this.value$ = this.configProps$.value;
-    this.testId = this.configProps$.testId;
-    this.label$ = this.configProps$.label;
-    this.displayMode$ = this.configProps$.displayMode;
-    this.helperText = this.configProps$.helperText;
-    this.placeholder = this.configProps$.placeholder || '';
-
-    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();
-    });
+    // Update component common properties
+    this.updateComponentCommonProperties(this.configProps$);
 
-    if (this.displayMode$ === 'DISPLAY_ONLY' || this.displayMode$ === 'STACKED_LARGE_VAL') {
+    // Extract and normalize the value property
+    const { value } = this.configProps$;
+    this.value$ = value;
+
+    // Format value for display modes
+    if (['DISPLAY_ONLY', 'STACKED_LARGE_VAL'].includes(this.displayMode$)) {
       this.formattedValue$ = format(this.value$, 'date', {
         format: this.theDateFormat.dateFormatString
       });
     }
-
-    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.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();
-      });
-    }
   }
 
   fieldOnDateChange(event: any) {
@@ -218,18 +94,20 @@ export class PegaDxilMyDateComponent implements OnInit, OnDestroy {
     return this.fieldControl.status === 'INVALID';
   }
 
-  getErrorMessage() {
-    let errMessage = '';
+  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 = `${this.fieldControl.errors['matDatepickerParse'].text} is not a valid date value`;
+      return 'You must enter a value';
+    }
+
+    if (this.fieldControl.errors) {
+      return `${this.fieldControl.errors['matDatepickerParse'].text} is not a valid date value`;
     }
-    return errMessage;
+
+    return '';
   }
 }

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

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

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

@@ -17,7 +17,7 @@
           [readonly]="bDisabled$"
         />
         <mat-datepicker-toggle matSuffix [owlDateTimeTrigger]="dtPicker"></mat-datepicker-toggle>
-        <owl-date-time #dtPicker [disabled]="bDisabled$"></owl-date-time>
+        <owl-date-time #dtPicker [disabled]="bDisabled$" [scrollStrategy]="scrollStrategy"></owl-date-time>
         <mat-error *ngIf="fieldControl?.invalid">{{ getErrorMessage() }}</mat-error>
       </mat-form-field>
     </div>