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

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

@@ -1,14 +1,14 @@
-import { Component, OnInit, Input, ChangeDetectorRef, forwardRef, OnDestroy } from '@angular/core';
+import { Component, EventEmitter, OnInit, Output, forwardRef, inject } from '@angular/core';
 import { CommonModule } from '@angular/common';
-import { FormControl, FormGroup, ReactiveFormsModule } from '@angular/forms';
+import { ReactiveFormsModule } from '@angular/forms';
 import { MatOptionModule } from '@angular/material/core';
 import { MatAutocompleteModule } from '@angular/material/autocomplete';
 import { MatInputModule } from '@angular/material/input';
 import { MatFormFieldModule } from '@angular/material/form-field';
-import { interval, Observable } from 'rxjs';
+import { Observable } from 'rxjs';
 import { map, startWith } from 'rxjs/operators';
-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 { DatapageService } from '@pega/angular-sdk-components';
 import { handleEvent } from '@pega/angular-sdk-components';
@@ -34,7 +34,6 @@ interface PegaDxilMySearchboxProps extends PConnFieldProps {
   selector: 'app-pega-dxil-my-searchbox',
   templateUrl: './pega-dxil-my-searchbox.component.html',
   styleUrls: ['./pega-dxil-my-searchbox.component.scss'],
-  standalone: true,
   imports: [
     CommonModule,
     ReactiveFormsModule,
@@ -43,68 +42,26 @@ interface PegaDxilMySearchboxProps extends PConnFieldProps {
     MatAutocompleteModule,
     MatOptionModule,
     forwardRef(() => ComponentMapperComponent)
-  ]
+  ],
+  providers: [DatapageService]
 })
-export class PegaDxilMySearchboxComponent implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
+export class PegaDxilMySearchboxComponent extends FieldBase implements OnInit {
+  protected dataPageService = inject(DatapageService);
+
+  @Output() onRecordChange: EventEmitter<any> = new EventEmitter();
 
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
   configProps$: PegaDxilMySearchboxProps;
 
-  label$ = '';
-  value$ = '';
-  bRequired$ = false;
-  bReadonly$ = false;
-  bDisabled$ = false;
-  bVisible$ = true;
-  displayMode$?: string = '';
-  controlName$: string;
-  bHasForm$ = true;
   options$: any[];
-  componentReference = '';
-  testId: string;
   listType: string;
   columns = [];
-  helperText: string;
-  placeholder: string;
-
-  fieldControl = new FormControl('', null);
   parameters: {};
-  hideLabel: boolean;
   filteredOptions: Observable<any[]>;
   filterValue = '';
-  actionsApi: Object;
-  propName: string;
-
-  constructor(
-    private angularPConnect: AngularPConnectService,
-    private cdRef: ChangeDetectorRef,
-    private utils: Utils,
-    private dataPageService: DatapageService
-  ) {}
-
-  async ngOnInit(): Promise<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();
-    await 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;
-    }
+  // Override ngOnInit method
+  override async ngOnInit(): Promise<void> {
+    super.ngOnInit();
 
     this.filteredOptions = this.fieldControl.valueChanges.pipe(
       startWith(''),
@@ -119,54 +76,32 @@ export class PegaDxilMySearchboxComponent implements OnInit, OnDestroy {
     this.fieldControl.setValue(this.value$);
   }
 
-  ngOnDestroy(): void {
-    if (this.formGroup$) {
-      this.formGroup$.removeControl(this.controlName$);
-    }
-
-    if (this.angularPConnectData.unsubscribeFn) {
-      this.angularPConnectData.unsubscribeFn();
-    }
-  }
-
   private _filter(value: string): string[] {
     const filterVal = (value || this.filterValue).toLowerCase();
     return this.options$?.filter(option => option.value?.toLowerCase().includes(filterVal));
   }
 
-  // Callback passed when subscribing to store change
-  async onStateChange() {
-    await this.checkAndUpdate();
-  }
-
-  async 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) {
-      await this.updateSelf();
-    }
-  }
+  /**
+   * Updates the component when there are changes in the state.
+   */
+  override async updateSelf(): Promise<void> {
+    // Resolve configuration properties
+    this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps()) as PegaDxilMySearchboxProps;
 
-  // updateSelf
-  async updateSelf(): Promise<void> {
-    // starting very simple...
+    // Update component common properties
+    this.updateComponentCommonProperties(this.configProps$);
 
-    // moved this from ngOnInit() and call this from there instead...
-    this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps()) as PegaDxilMySearchboxProps;
+    // Set component specific properties
+    const { value, listType, parameters } = this.configProps$;
 
-    if (this.configProps$.value != undefined) {
-      const index = this.options$?.findIndex(element => element.key === this.configProps$.value);
-      this.value$ = index > -1 ? this.options$[index].value : this.configProps$.value;
+    if (value != undefined) {
+      const index = this.options$?.findIndex(element => element.key === value);
+      this.value$ = index > -1 ? this.options$[index].value : value;
       this.fieldControl.setValue(this.value$);
     }
 
-    this.setPropertyValuesFromProps();
-
-    this.actionsApi = this.pConn$.getActionsApi();
-    this.propName = this.pConn$.getStateProps().value;
+    this.listType = listType;
+    this.parameters = parameters;
 
     const context = this.pConn$.getContextName();
     const { columns, datasource } = this.generateColumnsAndDataSource();
@@ -174,34 +109,7 @@ export class PegaDxilMySearchboxComponent implements OnInit, OnDestroy {
     if (columns) {
       this.columns = this.preProcessColumns(columns);
     }
-    // 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.componentReference = this.pConn$.getStateProps().value;
     if (this.listType === 'associated') {
       const optionsList = this.utils.getOptionList(this.configProps$, this.pConn$.getDataObject('')); // 1st arg empty string until typedef marked correctly
       this.setOptions(optionsList);
@@ -211,27 +119,6 @@ export class PegaDxilMySearchboxComponent implements OnInit, OnDestroy {
       const results = await this.dataPageService.getDataPageData(datasource, this.parameters, context);
       this.fillOptions(results);
     }
-
-    // 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();
-      });
-    }
-  }
-
-  setPropertyValuesFromProps() {
-    this.testId = this.configProps$.testId;
-    this.label$ = this.configProps$.label;
-    this.placeholder = this.configProps$.placeholder || '';
-    this.displayMode$ = this.configProps$.displayMode;
-    this.listType = this.configProps$.listType;
-    this.hideLabel = this.configProps$.hideLabel;
-    this.helperText = this.configProps$.helperText;
-    this.parameters = this.configProps$?.parameters;
   }
 
   generateColumnsAndDataSource() {
@@ -313,49 +200,24 @@ export class PegaDxilMySearchboxComponent implements OnInit, OnDestroy {
   }
 
   fieldOnChange(event: Event) {
-    // this works - this.pConn$.setValue( this.componentReference, `property: ${this.componentReference}`);
-    // this works - this.pConn$.setValue( this.componentReference, this.fieldControl.value);
-    // PConnect wants to use changeHandler for onChange
-    // this.angularPConnect.changeHandler( this, event);
     const value = (event.target as HTMLInputElement).value;
     this.filterValue = value;
     handleEvent(this.actionsApi, 'change', this.propName, value);
   }
 
   optionChanged(event: any) {
-    const value = event?.option?.value;
-    handleEvent(this.actionsApi, 'change', this.propName, value);
-  }
+    const val = event?.option?.value;
 
-  fieldOnBlur(event: Event) {
     let key = '';
-    const el = event?.target as HTMLInputElement;
-    if (el?.value) {
-      const index = this.options$?.findIndex(element => element.value === el.value);
-      key = index > -1 ? (key = this.options$[index].key) : el.value;
+    if (val) {
+      const index = this.options$?.findIndex(element => element.value === val);
+      key = index > -1 ? (key = this.options$[index].key) : val;
     }
     const value = key;
     handleEvent(this.actionsApi, 'changeNblur', this.propName, value);
-    if (this.configProps$?.onRecordChange) {
-      el.value = value;
-      this.configProps$.onRecordChange(event);
-    }
-  }
-
-  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.onRecordChange) {
+      this.onRecordChange.emit(value);
     }
-    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-text/config.json

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

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

@@ -1,176 +1,60 @@
-import { Component, OnInit, Input, 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 { MatInputModule } from '@angular/material/input';
 import { MatFormFieldModule } from '@angular/material/form-field';
-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 { PConnFieldProps } from '@pega/angular-sdk-components';
 
 interface PegaDxilMyTextProps extends PConnFieldProps {
   // If any, enter additional props that only exist on Text here
+  fieldMetadata?: any;
 }
 
 @Component({
   selector: 'app-pega-dxil-my-text',
   templateUrl: './pega-dxil-my-text.component.html',
   styleUrls: ['./pega-dxil-my-text.component.scss'],
-  standalone: true,
-  imports: [CommonModule, MatInputModule, MatFormFieldModule, ReactiveFormsModule, forwardRef(() => ComponentMapperComponent)]
+  imports: [CommonModule, ReactiveFormsModule, MatFormFieldModule, MatInputModule, forwardRef(() => ComponentMapperComponent)]
 })
-export class PegaDxilMyTextComponent implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
-
-  // For interaction with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
+export class PegaDxilMyTextComponent extends FieldBase {
   configProps$: PegaDxilMyTextProps;
 
-  value$ = '';
-  placeholder: string;
-  bVisible$ = true;
-  bDisabled$ = false;
-  bReadonly$ = false;
-  bRequired$ = false;
-  label$ = '';
-  bHideLabel$ = false;
-  testId = '';
-  helperText: string;
-  displayMode$?: string = '';
-
-  controlName$: string;
-  bHasForm$ = true;
-  componentReference = '';
-
-  fieldControl = new FormControl('', null);
-
-  constructor(
-    private angularPConnect: AngularPConnectService,
-    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);
-
-    // ONLY call updateSelf when the component should update
-    if (bUpdateSelf) {
-      this.updateSelf();
-    }
-  }
-
-  // updateSelf
-  updateSelf(): void {
-    this.componentReference = this.pConn$.getStateProps().value;
-    // moved this from ngOnInit() and call this from there instead...
+  /**
+   * 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 PegaDxilMyTextProps;
 
-    if (this.configProps$.value != undefined) {
-      this.value$ = this.configProps$.value;
-    }
-    this.testId = this.configProps$.testId;
-    this.label$ = this.configProps$.label;
-    this.helperText = this.configProps$.helperText;
-    this.placeholder = this.configProps$.placeholder || '';
-    this.displayMode$ = this.configProps$.displayMode;
-
-    if (this.configProps$.visibility != null) {
-      this.bVisible$ = this.utils.getBooleanValue(this.configProps$.visibility);
-    }
-
-    if (this.configProps$.required != null) {
-      this.bRequired$ = this.utils.getBooleanValue(this.configProps$.required);
-    }
-
-    // disabled
-    if (this.configProps$.disabled != null) {
-      this.bDisabled$ = this.utils.getBooleanValue(this.configProps$.disabled);
-    }
-
-    if (this.bDisabled$) {
-      this.fieldControl.disable();
-    } else {
-      this.fieldControl.enable();
-    }
+    // Update component common properties
+    this.updateComponentCommonProperties(this.configProps$);
 
-    if (this.configProps$.readOnly != null) {
-      this.bReadonly$ = this.utils.getBooleanValue(this.configProps$.readOnly);
-    }
+    // Get and set component specific properties
+    const { value } = this.configProps$;
+    this.value$ = 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();
+  fieldOnChange(event: any) {
+    const oldVal = this.value$ ?? '';
+    const isValueChanged = event.target.value.toString() !== oldVal.toString();
 
-        timer.unsubscribe();
+    if (isValueChanged) {
+      this.pConn$.clearErrorMessages({
+        property: this.propName
       });
     }
   }
 
-  fieldOnChange(event: any) {
-    this.angularPConnectData.actions?.onChange(this, event);
-  }
-
   fieldOnBlur(event: any) {
-    // PConnect wants to use eventHandler for onBlur
-    this.angularPConnectData.actions?.onBlur(this, event);
-  }
-
-  getErrorMessage() {
-    let errMessage = '';
+    const oldVal = this.value$ ?? '';
+    const isValueChanged = event.target.value.toString() !== oldVal.toString();
 
-    // 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 (isValueChanged) {
+      const value = event?.target?.value;
+      handleEvent(this.actionsApi, 'changeNblur', this.propName, value);
     }
-    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-text-input/config.json

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