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

package/tests/assets/sdk-a/components/create/override-sdk/field/integer/integer.component.ts

@@ -1,14 +1,13 @@
-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 { 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 { handleEvent } from '@pega/angular-sdk-components';
+import { PConnFieldProps } from '@pega/angular-sdk-components';
 
 interface IntegerProps extends PConnFieldProps {
   // If any, enter additional props that only exist on Integer here
@@ -18,146 +17,26 @@ interface IntegerProps extends PConnFieldProps {
   selector: 'app-integer',
   templateUrl: './integer.component.html',
   styleUrls: ['./integer.component.scss'],
-  standalone: true,
   imports: [CommonModule, ReactiveFormsModule, MatFormFieldModule, MatInputModule, forwardRef(() => ComponentMapperComponent)]
 })
-export class IntegerComponent implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
-
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
+export class IntegerComponent extends FieldBase {
   configProps$: IntegerProps;
+  override fieldControl = new FormControl<number | null>(null, null);
 
-  label$ = '';
-  value$: number;
-  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);
-  actionsApi: Object;
-  propName: string;
-
-  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
-
-    // 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 {
-    // 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 IntegerProps;
-    this.testId = this.configProps$.testId;
-    this.label$ = this.configProps$.label;
-    this.displayMode$ = this.configProps$.displayMode;
-    let nValue: any = this.configProps$.value;
-    if (nValue) {
-      if (typeof nValue === 'string') {
-        nValue = parseInt(nValue, 10);
-      }
-      this.value$ = nValue;
-    }
-    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();
-    });
-
-    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();
+    // Update component common properties
+    this.updateComponentCommonProperties(this.configProps$);
 
-        timer.unsubscribe();
-      });
+    // Extract and normalize the value property
+    const { value } = this.configProps$;
+    if (value) {
+      this.value$ = typeof value === 'string' ? parseInt(value, 10) : value;
     }
   }
 
@@ -181,23 +60,4 @@ export class IntegerComponent implements OnInit, OnDestroy {
       handleEvent(this.actionsApi, 'changeNblur', this.propName, value);
     }
   }
-
-  getErrorMessage() {
-    // field control gets error message from here
-
-    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/create/override-sdk/field/location/config-ext.json

@@ -0,0 +1,9 @@
+{
+    "componentKey": "Location",
+    "name": "Location",
+    "label": "Location",
+    "description": "Location",
+    "type": "Field",
+    "subtype": "Location",
+    "properties": []
+}

package/tests/assets/sdk-a/components/create/override-sdk/field/location/location.component.html

@@ -0,0 +1,46 @@
+<div *ngIf="mapReady && bVisible$">
+  <!-- Google suggestions -->
+  <mat-form-field class="psdk-full-width" [hintLabel]="helperText">
+    <mat-label>{{ label$ }}</mat-label>
+    <input
+      matInput
+      type="text"
+      [placeholder]="placeholder"
+      [formControl]="fieldControl"
+      [required]="bRequired$"
+      [matAutocomplete]="auto"
+      [readonly]="bReadonly$"
+      [attr.data-test-id]="testId"
+      (blur)="fieldOnBlur()"
+    />
+    <mat-error *ngIf="fieldControl.invalid">{{ getErrorMessage() }}</mat-error>
+    <button
+      mat-icon-button
+      matSuffix
+      type="button"
+      (click)="locateMe()"
+      [disabled]="isLocating || bDisabled$ || bReadonly$"
+      aria-label="Use my location"
+    >
+      <ng-container *ngIf="!isLocating; else loadingSpinner">
+        <mat-icon>location_on</mat-icon>
+      </ng-container>
+      <ng-template #loadingSpinner>
+        <mat-progress-spinner diameter="24" mode="indeterminate" strokeWidth="3"></mat-progress-spinner>
+      </ng-template>
+    </button>
+
+    <mat-autocomplete #auto="matAutocomplete" (optionSelected)="onOptionSelected($event)">
+      <mat-option *ngFor="let option of filteredOptions" [value]="option">
+        {{ option }}
+      </mat-option>
+    </mat-autocomplete>
+  </mat-form-field>
+  <!-- Google map -->
+  <div *ngIf="showMap" class="map-wrapper">
+    <google-map height="400px" width="100%" [center]="center" [zoom]="13" (mapClick)="onMapClick($event)">
+      <map-marker *ngIf="markerPosition" [position]="markerPosition" [title]="'Selected Location'"></map-marker>
+    </google-map>
+    <div class="map-blocker" *ngIf="bDisabled$ || bReadonly$"></div>
+  </div>
+</div>

package/tests/assets/sdk-a/components/create/override-sdk/field/location/location.component.scss

@@ -0,0 +1,18 @@
+.psdk-full-width {
+  width: 100%;
+}
+
+.map-wrapper {
+  position: relative;
+}
+
+.map-blocker {
+  position: absolute;
+  top: 0;
+  left: 0;
+  width: 100%;
+  height: 100%;
+  background: transparent;
+  z-index: 10;
+  cursor: not-allowed;
+}

package/tests/assets/sdk-a/components/create/override-sdk/field/location/location.component.spec.ts

@@ -0,0 +1,22 @@
+import { ComponentFixture, TestBed } from '@angular/core/testing';
+
+import { LocationComponent } from './location.component';
+
+describe('LocationComponent', () => {
+  let component: LocationComponent;
+  let fixture: ComponentFixture<LocationComponent>;
+
+  beforeEach(async () => {
+    await TestBed.configureTestingModule({
+      imports: [LocationComponent]
+    }).compileComponents();
+
+    fixture = TestBed.createComponent(LocationComponent);
+    component = fixture.componentInstance;
+    fixture.detectChanges();
+  });
+
+  it('should create', () => {
+    expect(component).toBeTruthy();
+  });
+});

package/tests/assets/sdk-a/components/create/override-sdk/field/location/location.component.ts

@@ -0,0 +1,280 @@
+import { Component, inject } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { ReactiveFormsModule } from '@angular/forms';
+import { MatFormFieldModule } from '@angular/material/form-field';
+import { MatInputModule } from '@angular/material/input';
+import { MatAutocompleteModule } from '@angular/material/autocomplete';
+import { MatProgressSpinnerModule } from '@angular/material/progress-spinner';
+import { MatIconModule } from '@angular/material/icon';
+import { MatButtonModule } from '@angular/material/button';
+import { GoogleMapsModule } from '@angular/google-maps';
+import { debounceTime, from, of, switchMap } from 'rxjs';
+
+import { FieldBase } from '@pega/angular-sdk-components';
+import { GoogleMapsLoaderService } from '@pega/angular-sdk-components';
+import { handleEvent } from '@pega/angular-sdk-components';
+
+import { PConnFieldProps } from '@pega/angular-sdk-components';
+
+interface LocationProps extends PConnFieldProps {
+  coordinates: string;
+  showMap: boolean;
+  onlyCoordinates: boolean;
+  showMapReadOnly: boolean;
+}
+
+@Component({
+  selector: 'app-location',
+  imports: [
+    CommonModule,
+    GoogleMapsModule,
+    MatAutocompleteModule,
+    MatButtonModule,
+    MatFormFieldModule,
+    MatIconModule,
+    MatInputModule,
+    MatProgressSpinnerModule,
+    ReactiveFormsModule
+  ],
+  templateUrl: './location.component.html',
+  styleUrl: './location.component.scss'
+})
+export class LocationComponent extends FieldBase {
+  private loader = inject(GoogleMapsLoaderService);
+
+  private autocompleteService!: google.maps.places.AutocompleteService;
+  private geocoder!: google.maps.Geocoder;
+
+  // Dom variables
+  mapReady = false;
+  isLocating = false;
+  showMap = true;
+  filteredOptions: string[] = [];
+  center: google.maps.LatLngLiteral;
+  markerPosition: google.maps.LatLngLiteral | null = null;
+
+  configProps$: LocationProps;
+  onlyCoordinates: boolean;
+  coordinates: string;
+  showMapReadOnly$: boolean;
+  valueProp: string;
+  coordinatesProp: string;
+
+  override async ngOnInit() {
+    super.ngOnInit();
+
+    // Loading map
+    const apiKey = this.pConn$.getGoogleMapsAPIKey();
+    await this.loader.load(apiKey);
+    this.mapReady = true;
+    this.initializeGoogleServices();
+    this.getPlacePredictions();
+  }
+
+  /**
+   * 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 LocationProps;
+
+    // Update component common properties
+    this.updateComponentCommonProperties(this.configProps$);
+
+    this.onlyCoordinates = !!this.configProps$.onlyCoordinates;
+    this.showMapReadOnly$ = !!this.configProps$.showMapReadOnly;
+    this.showMap = this.bReadonly$ ? this.showMapReadOnly$ : !!this.configProps$.showMap;
+
+    if (this.configProps$.coordinates) {
+      const latAndLong: number[] = this.configProps$.coordinates.split(',').map(Number);
+      const latitude = Number(latAndLong[0]);
+      const longitude = Number(latAndLong[1]);
+      this.updateMap(latitude, longitude, this.configProps$.value);
+    }
+
+    this.valueProp = this.pConn$.getStateProps().value;
+    this.coordinatesProp = this.pConn$.getStateProps().coordinates;
+  }
+
+  onOptionSelected(event: any) {
+    const value = event.option.value;
+    if (this.isCoordinateString(value)) {
+      const [lat, lng] = value.split(',').map(Number);
+      this.updateMap(lat, lng, value);
+      this.updateProps();
+    } else {
+      this.geocoder.geocode({ address: value }, (res, status) => {
+        if (status === google.maps.GeocoderStatus.OK && res && res[0]) {
+          const loc = res[0].geometry.location;
+          this.updateMap(loc.lat(), loc.lng(), value);
+          this.updateProps();
+        }
+      });
+    }
+  }
+
+  fieldOnBlur() {
+    this.updateProps();
+  }
+
+  locateMe() {
+    if (!navigator.geolocation) {
+      alert('Geolocation not supported by this browser.');
+      return;
+    }
+
+    this.isLocating = true;
+    this.tryGetLocation(0);
+  }
+
+  onMapClick(event: google.maps.MapMouseEvent) {
+    if (!event.latLng) return;
+
+    const lat = event.latLng.lat();
+    const lng = event.latLng.lng();
+
+    if (this.onlyCoordinates) {
+      this.updateMap(lat, lng);
+      this.updateProps();
+    } else {
+      this.geocoder.geocode({ location: { lat, lng } }, (res, status) => {
+        if (status === google.maps.GeocoderStatus.OK && res && res[0]) {
+          this.updateMap(lat, lng, res[0].formatted_address);
+        } else {
+          this.updateMap(lat, lng);
+        }
+        this.updateProps();
+      });
+    }
+  }
+
+  private tryGetLocation(retryCount: number) {
+    navigator.geolocation.getCurrentPosition(
+      position => {
+        const lat = position.coords.latitude;
+        const lng = position.coords.longitude;
+        if (this.onlyCoordinates) {
+          this.updateMap(lat, lng);
+          this.updateProps();
+          this.isLocating = false;
+        } else {
+          this.geocoder.geocode({ location: { lat, lng } }, (res, status) => {
+            this.isLocating = false;
+            if (status === google.maps.GeocoderStatus.OK && res && res[0]) {
+              this.updateMap(lat, lng, res[0].formatted_address);
+            } else {
+              this.updateMap(lat, lng);
+            }
+            this.updateProps();
+          });
+        }
+      },
+      err => {
+        console.error('Geolocation error', err);
+
+        if (err.code === err.POSITION_UNAVAILABLE && retryCount < 2) {
+          console.warn('Retrying location fetch...');
+          setTimeout(() => this.tryGetLocation(retryCount + 1), 2000);
+        } else {
+          this.isLocating = false;
+
+          switch (err.code) {
+            case err.PERMISSION_DENIED:
+              alert('Location permission denied. Please allow access in your browser settings.');
+              break;
+            case err.POSITION_UNAVAILABLE:
+              alert('Location unavailable. Please check your internet or GPS.');
+              break;
+            case err.TIMEOUT:
+              alert('Timed out while trying to get your location. Try again.');
+              break;
+            default:
+              alert('Could not get your location. Please try again.');
+          }
+        }
+      },
+      {
+        enableHighAccuracy: true,
+        timeout: 10000,
+        maximumAge: 0
+      }
+    );
+  }
+
+  private initializeGoogleServices() {
+    this.autocompleteService = new google.maps.places.AutocompleteService();
+    this.geocoder = new google.maps.Geocoder();
+  }
+
+  private getPlacePredictions() {
+    this.fieldControl.valueChanges
+      .pipe(
+        debounceTime(300),
+        switchMap(value => this.getSuggestions(value || ''))
+      )
+      .subscribe(predictions => {
+        this.filteredOptions = predictions;
+      });
+  }
+
+  private isCoordinateString(value: string): boolean {
+    const regex = /^-?\d+(\.\d+)?\s*,\s*-?\d+(\.\d+)?$/;
+    return regex.test(value.trim());
+  }
+
+  private getSuggestions(input: string) {
+    if (!input.trim()) return of([]);
+
+    if (this.isCoordinateString(input)) {
+      return of([input]);
+    }
+
+    return from(
+      new Promise<string[]>(resolve => {
+        this.autocompleteService.getPlacePredictions({ input }, (preds, status) => {
+          if (status === google.maps.places.PlacesServiceStatus.OK && preds) {
+            if (this.onlyCoordinates) {
+              // only first exact match as coordinates
+              this.geocoder.geocode({ placeId: preds[0].place_id }, (response, geocoderStatus) => {
+                if (geocoderStatus === google.maps.GeocoderStatus.OK && response && response[0]) {
+                  const loc = response[0].geometry.location;
+                  resolve([`${loc.lat()}, ${loc.lng()}`]);
+                } else {
+                  resolve([]);
+                }
+              });
+            } else {
+              resolve(preds.map(p => p.description));
+            }
+          } else {
+            resolve([]);
+          }
+        });
+      })
+    );
+  }
+
+  private updateMap(lat: number, lng: number, value?: string) {
+    this.center = { lat, lng };
+    this.markerPosition = { lat, lng };
+    this.setCoordinates(lat, lng);
+    if (this.onlyCoordinates) {
+      this.setLocationValue(this.coordinates);
+    } else {
+      this.setLocationValue(value || '');
+    }
+  }
+
+  private updateProps() {
+    handleEvent(this.actionsApi, 'change', this.valueProp, this.fieldControl.value);
+    handleEvent(this.actionsApi, 'change', this.coordinatesProp, this.coordinates);
+  }
+
+  private setCoordinates(latitude: number, longitude: number) {
+    this.coordinates = `${latitude}, ${longitude}`;
+  }
+
+  private setLocationValue(value: string) {
+    this.fieldControl.setValue(value, { emitEvent: false });
+  }
+}

package/tests/assets/sdk-a/components/create/override-sdk/field/multiselect/multiselect.component.html

@@ -0,0 +1,33 @@
+<div [formGroup]="formGroup$">
+  <mat-form-field class="psdk-full-width" subscriptSizing="dynamic">
+    <mat-label>{{ label$ }}</mat-label>
+    <mat-chip-grid #chipGrid>
+      <ng-container *ngFor="let select of selectedItems">
+        <mat-chip-row (removed)="removeChip(select)">
+          {{ select.primary }}
+          <button matChipRemove>
+            <mat-icon>cancel</mat-icon>
+          </button>
+        </mat-chip-row>
+      </ng-container>
+    </mat-chip-grid>
+    <input
+      matInput
+      [placeholder]="placeholder"
+      [formControl]="fieldControl"
+      [value]="value$"
+      [required]="bRequired$"
+      [matAutocomplete]="auto"
+      (input)="fieldOnChange($event)"
+      [matChipInputFor]="chipGrid"
+    />
+    <mat-autocomplete #auto="matAutocomplete">
+      <mat-option *ngFor="let item of itemsTree" [value]="item.primary" (click)="optionClicked($event, item)">
+        <mat-checkbox [checked]="item.selected" (click)="optionClicked($event, item)">
+          <span>{{ item.primary }}</span>
+        </mat-checkbox>
+      </mat-option>
+    </mat-autocomplete>
+    <mat-error *ngIf="fieldControl.invalid">{{ getErrorMessage() }}</mat-error>
+  </mat-form-field>
+</div>

package/tests/assets/sdk-a/components/create/override-sdk/field/multiselect/multiselect.component.scss

@@ -0,0 +1,7 @@
+.psdk-full-width {
+  width: 100%;
+}
+
+::ng-deep .mat-mdc-form-field-infix {
+  padding-left: 10px;
+}

package/tests/assets/sdk-a/components/create/override-sdk/field/multiselect/multiselect.component.spec.ts

@@ -0,0 +1,21 @@
+import { ComponentFixture, TestBed } from '@angular/core/testing';
+
+import { MultiselectComponent } from './multiselect.component';
+
+describe('MultiselectComponent', () => {
+  let component: MultiselectComponent;
+  let fixture: ComponentFixture<MultiselectComponent>;
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({
+      declarations: [MultiselectComponent]
+    });
+    fixture = TestBed.createComponent(MultiselectComponent);
+    component = fixture.componentInstance;
+    fixture.detectChanges();
+  });
+
+  it('should create', () => {
+    expect(component).toBeTruthy();
+  });
+});