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

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

@@ -1,20 +1,19 @@
-import { Component, OnInit, Input, ChangeDetectorRef, forwardRef, OnDestroy } from '@angular/core';
+import { Component, OnInit, forwardRef, OnDestroy, inject } 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 { MatInputModule } from '@angular/material/input';
 import { MatFormFieldModule } from '@angular/material/form-field';
+import { ScrollStrategyOptions } from '@angular/cdk/overlay';
 import { OwlDateTimeModule, OwlNativeDateTimeModule } from '@danielmoncada/angular-datetime-picker';
-import { interval } from 'rxjs';
 import dayjs from 'dayjs';
-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 { handleEvent } from '@pega/angular-sdk-components';
-import { format } from '@pega/angular-sdk-components';
 import { DateFormatters } from '@pega/angular-sdk-components';
+import { PConnFieldProps } from '@pega/angular-sdk-components';
 
 interface PegaDxilMyDateTimeProps extends PConnFieldProps {
   // If any, enter additional props that only exist on DateTime here
@@ -24,7 +23,6 @@ interface PegaDxilMyDateTimeProps extends PConnFieldProps {
   selector: 'app-pega-dxil-my-date-time',
   templateUrl: './pega-dxil-my-date-time.component.html',
   styleUrls: ['./pega-dxil-my-date-time.component.scss'],
-  standalone: true,
   imports: [
     CommonModule,
     ReactiveFormsModule,
@@ -36,162 +34,64 @@ interface PegaDxilMyDateTimeProps extends PConnFieldProps {
     forwardRef(() => ComponentMapperComponent)
   ]
 })
-export class PegaDxilMyDateTimeComponent implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
-
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
+export class PegaDxilMyDateTimeComponent extends FieldBase implements OnInit, OnDestroy {
   configProps$: PegaDxilMyDateTimeProps;
 
-  label$ = '';
-  value$: any;
-  bRequired$ = false;
-  bReadonly$ = false;
-  bDisabled$ = false;
-  bVisible$ = true;
-  displayMode$?: string = '';
-  controlName$: string;
-  bHasForm$ = true;
-  componentReference = '';
-  testId = '';
-  helperText: string;
-
-  fieldControl = new FormControl('', null);
   stepHour = 1;
   stepMinute = 1;
   stepSecond = 1;
   public color = 'primary';
-  // Start with default dateFormatInfo
-  dateFormatInfo = dateFormatInfoDefault;
-  // and then update, as needed, based on locale, etc.
-  theDateFormat = getDateFormatInfo();
-  placeholder: string;
-  actionsApi: Object;
-  propName: string;
   formattedValue$: any;
+  theDateFormat = getDateFormatInfo();
   timezone = PCore.getEnvironmentInfo()?.getTimeZone();
+  override placeholder = `${this.theDateFormat.dateFormatStringLC}, hh:mm A`;
 
-  constructor(
-    private angularPConnect: AngularPConnectService,
-    private cdRef: ChangeDetectorRef,
-    private utils: Utils
-  ) {}
+  private sso = inject(ScrollStrategyOptions);
+  scrollStrategy = this.sso.reposition();
 
-  ngOnInit(): void {
-    this.placeholder = `${this.theDateFormat.dateFormatStringLC}, hh:mm A`;
-    // 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();
+  override ngOnInit(): void {
+    super.ngOnInit();
 
     if (this.formGroup$) {
-      // add control to formGroup
-      this.formGroup$.addControl(this.controlName$, this.fieldControl);
       let dateTimeValue = this.value$ ?? '';
 
       if (this.value$) {
         dateTimeValue = dayjs(DateFormatters?.convertToTimezone(this.value$, { timezone: this.timezone }))?.toISOString();
       }
       this.fieldControl.setValue(dateTimeValue);
-      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);
+  /**
+   * 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 PegaDxilMyDateTimeProps;
 
-    // ONLY call updateSelf when the component should update
-    if (bUpdateSelf) {
-      this.updateSelf();
-    }
-  }
+    // Update component common properties
+    this.updateComponentCommonProperties(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 PegaDxilMyDateTimeProps;
+    // Extract the value property
+    const { value } = this.configProps$;
 
-    this.label$ = this.configProps$.label;
-    this.displayMode$ = this.configProps$.displayMode;
-    this.testId = this.configProps$.testId;
-    this.helperText = this.configProps$.helperText;
-    this.value$ = this.configProps$?.value;
-    let dateTimeValue = this.configProps$?.value ?? '';
+    // Update component properties
+    this.value$ = value;
+    let dateTimeValue = value ?? '';
     if (this.value$) {
       dateTimeValue = dayjs(DateFormatters?.convertToTimezone(this.value$, { timezone: this.timezone }))?.toISOString();
     }
     this.fieldControl.setValue(dateTimeValue);
-    // 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.displayMode$ === 'DISPLAY_ONLY' || this.displayMode$ === 'STACKED_LARGE_VAL') {
-      this.formattedValue$ = format(this.value$, 'datetime', {
-        format: `${this.theDateFormat.dateFormatString} hh:mm A`
-      });
-    }
-
-    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 (['DISPLAY_ONLY', 'STACKED_LARGE_VAL'].includes(this.displayMode$)) {
+      this.formattedValue$ = this.generateDateTime(this.value$);
     }
+  }
 
-    this.componentReference = this.pConn$.getStateProps().value;
-
-    this.actionsApi = this.pConn$.getActionsApi();
-    this.propName = 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();
-      });
-    }
+  generateDateTime(sVal): string {
+    if (!sVal) return '';
+    if (sVal.length === 10) return this.utils.generateDate(sVal, 'Date-Long-Custom-YYYY');
+    return this.utils.generateDateTime(sVal, 'DateTime-Long-YYYY-Custom');
   }
 
   fieldOnDateChange(event: any) {
@@ -204,19 +104,4 @@ export class PegaDxilMyDateTimeComponent implements OnInit, OnDestroy {
     }
     handleEvent(this.actionsApi, 'changeNblur', this.propName, event.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-decimal/config.json

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

package/tests/assets/sdk-a/components/createAll/custom-sdk/field/pega-dxil-my-decimal/pega-dxil-my-decimal.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, FormsModule, ReactiveFormsModule } from '@angular/forms';
+import { FormControl, FormsModule, ReactiveFormsModule } from '@angular/forms';
 import { MatInputModule } from '@angular/material/input';
 import { MatFormFieldModule } from '@angular/material/form-field';
 import { NgxCurrencyDirective, NgxCurrencyInputMode } from 'ngx-currency';
-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 { 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 PegaDxilMyDecimalProps extends PConnFieldProps {
   // If any, enter additional props that only exist on Decimal here
@@ -25,7 +23,6 @@ interface PegaDxilMyDecimalProps extends PConnFieldProps {
   selector: 'app-pega-dxil-my-decimal',
   templateUrl: './pega-dxil-my-decimal.component.html',
   styleUrls: ['./pega-dxil-my-decimal.component.scss'],
-  standalone: true,
   imports: [
     CommonModule,
     ReactiveFormsModule,
@@ -36,176 +33,69 @@ interface PegaDxilMyDecimalProps extends PConnFieldProps {
     forwardRef(() => ComponentMapperComponent)
   ]
 })
-export class PegaDxilMyDecimalComponent implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
-
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
+export class PegaDxilMyDecimalComponent extends FieldBase {
   configProps$: PegaDxilMyDecimalProps;
+  override fieldControl = new FormControl<number | null>(null, null);
 
-  label$ = '';
-  value$: any;
-  bRequired$ = false;
-  bReadonly$ = false;
-  bDisabled$ = false;
-  bVisible$ = true;
-  displayMode$?: string = '';
-  controlName$: string;
-  bHasForm$ = true;
-  componentReference = '';
-  testId: string;
-  helperText: string;
-  placeholder: string;
-
-  fieldControl = new FormControl<number | null>(null, null);
   decimalSeparator: string;
   thousandSeparator: string;
   currencySymbol = '';
   decimalPrecision: number | undefined;
   formatter;
   formattedValue: any;
-  inputMode: any;
+  inputMode: any = NgxCurrencyInputMode.Natural;
   suffix = '';
 
-  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 config properties
+    this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps()) as PegaDxilMyDecimalProps;
 
-    // call updateSelf when initializing
-    // this.updateSelf();
-    this.checkAndUpdate();
+    // Update 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();
-    }
+    // updates decimal properties
+    this.updateDecimalProperties(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 PegaDxilMyDecimalProps;
-    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 showGroupSeparators = this.configProps$.showGroupSeparators;
-    const currencyISOCode = this.configProps$?.currencyISOCode ?? '';
-
+  /**
+   * Updates decimal properties based on the provided configuration.
+   *
+   * @param {Object} configProps - Configuration properties.
+   * @param {string} configProps.currencyISOCode - ISO code of the currency.
+   * @param {string} configProps.formatter - Formatter type (e.g., 'decimal', 'currency').
+   * @param {boolean} configProps.showGroupSeparators - Whether to show group separators.
+   */
+  protected updateDecimalProperties(configProps): void {
+    const { currencyISOCode = '', formatter, showGroupSeparators } = configProps;
+
+    // Extract currency symbols and options
     const theSymbols = getCurrencyCharacters(currencyISOCode);
     this.decimalSeparator = theSymbols.theDecimalIndicator;
     this.thousandSeparator = showGroupSeparators ? theSymbols.theDigitGroupSeparator : '';
 
     const theCurrencyOptions = getCurrencyOptions(currencyISOCode);
-    this.formatter = this.configProps$.formatter;
+    const formatterLower = formatter?.toLowerCase() || 'decimal';
+    this.formattedValue = format(this.value$, formatterLower, theCurrencyOptions);
 
-    if (this.formatter) {
-      this.formattedValue = format(this.value$, this.formatter.toLowerCase(), theCurrencyOptions);
-    } else {
-      this.formattedValue = format(this.value$, 'decimal', 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);
-    }
-
-    if (this.configProps$.readOnly != null) {
-      this.bReadonly$ = this.utils.getBooleanValue(this.configProps$.readOnly);
-    }
-
-    // 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.bReadonly$ && this.formatter === 'Currency') {
+    if (this.bReadonly$ && formatter === 'Currency') {
       this.currencySymbol = theSymbols.theCurrencySymbol;
     }
 
-    if (this.bReadonly$ && this.formatter === 'Percentage') {
+    if (this.bReadonly$ && formatter === 'Percentage') {
       this.suffix = '%';
     }
 
     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();
-      });
-    }
   }
 
   fieldOnBlur(event: any) {
@@ -230,21 +120,4 @@ export class PegaDxilMyDecimalComponent 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-email/config.json

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