Skip to content

refactor: base component for field components added #332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tumms2021389 merged 4 commits into from
Nov 3, 2025
Merged

refactor: base component for field components added #332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
20325cf
refactor: base component for field components added
tumms2021389 Oct 7, 2025
e14574e
Corrected playwrights
tumms2021389 Oct 9, 2025
3a976d5
fix: linting error
tumms2021389 Nov 3, 2025
4f49ec1
constellationjs 25.1.0 package installed
tumms2021389 Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
"@angular/platform-browser-dynamic": "^19.2.14",
"@angular/router": "^19.2.14",
"@danielmoncada/angular-datetime-picker": "^19.0.0",
"@pega/auth": "~0.2.31",
"@pega/auth": "~0.2.34",
"@tinymce/tinymce-angular": "^8.0.1",
"core-js": "^3.39.0",
"dayjs": "^1.11.13",
Expand All @@ -94,7 +94,7 @@
"@angular/compiler-cli": "^19.2.14",
"@angular/language-service": "^19.2.14",
"@pega/configs": "^0.16.3",
"@pega/constellationjs": "^0.25.1",
"@pega/constellationjs": "~25.1.0",
"@pega/pcore-pconnect-typedefs": "~4.1.0",
"@playwright/test": "^1.54.2",
"@types/jasmine": "~5.1.4",
Expand Down
187 changes: 26 additions & 161 deletions ...angular-sdk-components/src/lib/_components/field/auto-complete/auto-complete.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import { Component, OnInit, Input, ChangeDetectorRef, forwardRef, OnDestroy, Output, EventEmitter } 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 '../../../_bridge/angular-pconnect';
import { Utils } from '../../../_helpers/utils';

import { FieldBase } from '../field.base';
import { ComponentMapperComponent } from '../../../_bridge/component-mapper/component-mapper.component';
import { DatapageService } from '../../../_services/datapage.service';
import { handleEvent } from '../../../_helpers/event-util';
Expand Down Expand Up @@ -44,67 +44,23 @@ interface AutoCompleteProps extends PConnFieldProps {
forwardRef(() => ComponentMapperComponent)
]
})
export class AutoCompleteComponent implements OnInit, OnDestroy {
@Input() pConn$: typeof PConnect;
@Input() formGroup$: FormGroup;
export class AutoCompleteComponent extends FieldBase implements OnInit {
protected dataPageService = inject(DatapageService);

@Output() onRecordChange: EventEmitter<any> = new EventEmitter();

// Used with AngularPConnect
angularPConnectData: AngularPConnectData = {};
configProps$: AutoCompleteProps;

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(''),
Expand All @@ -119,89 +75,40 @@ export class AutoCompleteComponent 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 AutoCompleteProps;

// 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 AutoCompleteProps;
// 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();

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);
Expand All @@ -211,27 +118,6 @@ export class AutoCompleteComponent 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() {
Expand Down Expand Up @@ -313,10 +199,6 @@ export class AutoCompleteComponent 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);
Expand All @@ -337,21 +219,4 @@ export class AutoCompleteComponent implements OnInit, OnDestroy {
this.onRecordChange.emit(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;
}
}
Loading