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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/dx-component-builder-sdk",
-  "version": "25.1.10",
+  "version": "25.1.12",
   "description": "Utility for building custom UI components",
   "bin": "./bin/index.js",
   "scripts": {

package/src/tasks/create/templates/SDK-Angular/field/Boolean/boolean.component.ts.mustache

@@ -1,12 +1,10 @@
-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';
@@ -36,29 +34,12 @@ interface {{COMPONENT_CLASS_NAME}}Props extends Omit<PConnFieldProps, 'value'> {
   styleUrls: ['./{{COMPONENT_CLASS_NAME_KEBAB}}.component.scss'],
   imports: [CommonModule, ReactiveFormsModule, MatCheckboxModule, MatFormFieldModule, MatOptionModule, forwardRef(() => ComponentMapperComponent)]
 })
-export class {{COMPONENT_CLASS_NAME}}Component implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
-
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
+export class {{COMPONENT_CLASS_NAME}}Component extends FieldBase implements OnInit, OnDestroy {
   configProps$: {{COMPONENT_CLASS_NAME}}Props;
 
-  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;
 
@@ -70,85 +51,32 @@ export class {{COMPONENT_CLASS_NAME}}Component implements OnInit, OnDestroy {
   selectedvalues: any;
   referenceList: string;
   listOfCheckboxes: any[] = [];
-  actionsApi: object;
-  propName: string;
   variant?: 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);
+  // Override ngOnInit method
+  override ngOnInit(): void {
+    super.ngOnInit();
 
-    // Then, continue on with other initialization
-
-    // call updateSelf when initializing
-    // this.updateSelf();
-    this.checkAndUpdate();
-
-    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 {{COMPONENT_CLASS_NAME}}Props;
 
-    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;
 
     // multi case
     this.selectionMode = this.configProps$.selectionMode;
@@ -157,6 +85,7 @@ export class {{COMPONENT_CLASS_NAME}}Component 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;
@@ -174,53 +103,10 @@ export class {{COMPONENT_CLASS_NAME}}Component 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;
-
-      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;
     }
   }
 
@@ -258,21 +144,4 @@ export class {{COMPONENT_CLASS_NAME}}Component 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/src/tasks/create/templates/SDK-Angular/field/Date/date.component.html.mustache

@@ -13,7 +13,7 @@
           #dateInput
           [attr.data-test-id]="testId"
           [matDatepicker]="pegadate"
-          [placeholder]="dateFormatInfo.dateFormatStringLC"
+          [placeholder]="theDateFormat.dateFormatStringLC"
           type="text"
           [value]="value$"
           [required]="bRequired$"

package/src/tasks/create/templates/SDK-Angular/field/Date/date.component.ts.mustache

@@ -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 {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
   // If any, enter additional props that only exist on Date here
@@ -55,153 +53,32 @@ class MyFormat {
   ],
   providers: [{ provide: MAT_DATE_FORMATS, useClass: MyFormat }]
 })
-export class {{COMPONENT_CLASS_NAME}}Component implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
-
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
+export class {{COMPONENT_CLASS_NAME}}Component extends FieldBase implements OnInit, OnDestroy {
   configProps$: {{COMPONENT_CLASS_NAME}}Props;
 
-  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 {{COMPONENT_CLASS_NAME}}Props;
 
-    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) {
@@ -217,18 +94,20 @@ export class {{COMPONENT_CLASS_NAME}}Component 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 '';
   }
 }