@pega/angular-sdk-overrides 0.23.1

package/lib/field/cancel-alert/cancel-alert.component.ts

@@ -0,0 +1,107 @@
+import { Component, Input, Output, EventEmitter, OnChanges } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { MatButtonModule } from '@angular/material/button';
+import { MatGridListModule } from '@angular/material/grid-list';
+import { ProgressSpinnerService } from '@pega/angular-sdk-components';
+
+@Component({
+  selector: 'app-cancel-alert',
+  templateUrl: './cancel-alert.component.html',
+  styleUrls: ['./cancel-alert.component.scss'],
+  standalone: true,
+  imports: [CommonModule, MatGridListModule, MatButtonModule]
+})
+export class CancelAlertComponent implements OnChanges {
+  @Input() pConn$: typeof PConnect;
+  @Input() bShowAlert$: boolean;
+  @Output() onAlertState$: EventEmitter<boolean> = new EventEmitter<boolean>();
+
+  heading$: string;
+  body1$: string;
+  body2$: string;
+  itemKey: string;
+  localizedVal: Function;
+  localeCategory = 'ModalContainer';
+
+  constructor(private psService: ProgressSpinnerService) {}
+  ngOnChanges() {
+    if (this.bShowAlert$) {
+      this.psService.sendMessage(false);
+
+      const contextName = this.pConn$.getContextName();
+      const caseInfo = this.pConn$.getCaseInfo();
+      const caseName = caseInfo.getName();
+      const ID = caseInfo.getID();
+      this.localizedVal = PCore.getLocaleUtils().getLocaleValue;
+
+      this.itemKey = contextName;
+      this.heading$ = `Delete ${caseName} (${ID})`;
+      this.body1$ = `${this.localizedVal('Are you sure you want to delete ', this.localeCategory) + caseName} (${ID})?`;
+      this.body2$ = this.localizedVal('Alternatively, you can continue working or save your work for later.', this.localeCategory);
+
+      // this.onAlertState$.emit(true);
+    }
+  }
+
+  dismissAlert() {
+    this.bShowAlert$ = false;
+    this.onAlertState$.emit(false);
+  }
+
+  dismissAlertOnly() {
+    this.bShowAlert$ = false;
+    this.onAlertState$.emit(true);
+  }
+
+  sendMessage(sMessage: string) {
+    alert(sMessage);
+  }
+
+  buttonClick(sAction) {
+    const actionsAPI = this.pConn$.getActionsApi();
+    this.localizedVal = PCore.getLocaleUtils().getLocaleValue;
+
+    switch (sAction) {
+      case 'save':
+        this.psService.sendMessage(true);
+        // eslint-disable-next-line no-case-declarations
+        const savePromise = actionsAPI.saveAndClose(this.itemKey);
+        savePromise
+          .then(() => {
+            this.psService.sendMessage(false);
+            this.dismissAlert();
+
+            // @ts-ignore - second parameter “payload” for publish method should be optional
+            PCore.getPubSubUtils().publish(PCore.getConstants().PUB_SUB_EVENTS.CASE_EVENTS.CASE_CREATED);
+          })
+          .catch(() => {
+            this.psService.sendMessage(false);
+            this.sendMessage(this.localizedVal('Save failed', this.localeCategory));
+          });
+        break;
+      case 'continue':
+        this.dismissAlertOnly();
+        break;
+      case 'delete':
+        this.psService.sendMessage(true);
+
+        // eslint-disable-next-line no-case-declarations
+        const deletePromise = actionsAPI.deleteCaseInCreateStage(this.itemKey);
+
+        deletePromise
+          .then(() => {
+            this.psService.sendMessage(false);
+            this.dismissAlert();
+            // @ts-ignore - second parameter “payload” for publish method should be optional
+            PCore.getPubSubUtils().publish(PCore.getConstants().PUB_SUB_EVENTS.EVENT_CANCEL);
+          })
+          .catch(() => {
+            this.psService.sendMessage(false);
+            this.sendMessage(this.localizedVal('Delete failed.', this.localeCategory));
+          });
+        break;
+      default:
+        break;
+    }
+  }
+}

package/lib/field/check-box/check-box.component.html

@@ -0,0 +1,41 @@
+<div *ngIf="displayMode$; else noDisplayMode">
+  <component-mapper *ngIf="bVisible$ !== false" name="FieldValueList" [props]="{ label$, value$, displayMode$ }"></component-mapper>
+</div>
+<ng-template #noDisplayMode>
+  <div *ngIf="!bReadonly$ && bHasForm$; else noEdit">
+    <div [formGroup]="formGroup$" *ngIf="bVisible$">
+      <div class="mat-form-field-infix" *ngIf="showLabel$">
+        <span>
+          <label class="mat-form-field-label psdk-label-readonly">{{ label$ }}</label>
+        </span>
+        <mat-checkbox
+          [labelPosition]="'after'"
+          [checked]="isChecked$"
+          [disabled]="bDisabled$"
+          [attr.data-test-id]="testId"
+          [formControl]="fieldControl"
+          (change)="fieldOnChange($event)"
+          (blur)="fieldOnBlur($event)"
+          >{{ caption$ }}</mat-checkbox
+        >
+      </div>
+      <div class="mat-form-field-infix" *ngIf="!bReadonly$ && !showLabel$">
+        <mat-checkbox
+          [labelPosition]="'after'"
+          [checked]="isChecked$"
+          [disabled]="bDisabled$"
+          [attr.data-test-id]="testId"
+          [formControl]="fieldControl"
+          (change)="fieldOnChange($event)"
+          (blur)="fieldOnBlur($event)"
+          >{{ caption$ }}</mat-checkbox
+        >
+      </div>
+      <mat-hint *ngIf="helperText">{{ helperText }}</mat-hint>
+      <mat-error *ngIf="fieldControl.invalid">{{ getErrorMessage() }}</mat-error>
+    </div>
+  </div>
+</ng-template>
+<ng-template #noEdit>
+  <component-mapper *ngIf="bVisible$ !== false" name="Text" [props]="{ pConn$, formatAs$: 'text' }"></component-mapper>
+</ng-template>

package/lib/field/check-box/check-box.component.scss

@@ -0,0 +1,24 @@
+.psdk-full-width {
+  min-width: 9.375rem;
+  width: 100%;
+  text-align: left;
+}
+
+.psdk-label-readonly {
+  top: 0rem;
+  margin-top: 0.625rem;
+  font-size: 0.875rem;
+  display: block;
+  transform: translateY(-1.28125em) scale(0.75) perspective(100px) translateZ(0.001px);
+  -ms-transform: translateY(-1.28125em) scale(0.75);
+  width: 133.33333%;
+}
+
+.psdk-data-readonly {
+  padding-top: 0.625rem;
+  width: 100%;
+}
+
+::ng-deep .mat-mdc-form-field-infix {
+  width: auto;
+}

package/lib/field/check-box/check-box.component.spec.ts

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

package/lib/field/check-box/check-box.component.ts

@@ -0,0 +1,188 @@
+import { Component, OnInit, Input, ChangeDetectorRef, forwardRef, OnDestroy } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { FormControl, FormGroup, ReactiveFormsModule } from '@angular/forms';
+import { MatCheckboxModule } from '@angular/material/checkbox';
+import { MatFormFieldModule } from '@angular/material/form-field';
+import { AngularPConnectData, AngularPConnectService } from '@pega/angular-sdk-components';
+import { Utils } from '@pega/angular-sdk-components';
+import { ComponentMapperComponent } from '@pega/angular-sdk-components';
+import { PConnFieldProps } from '@pega/angular-sdk-components';
+
+interface CheckboxProps extends Omit<PConnFieldProps, 'value'> {
+  // If any, enter additional props that only exist on Checkbox here
+  // Everything from PConnFieldProps except value and change type of value to boolean
+  value: boolean;
+  caption?: string;
+}
+
+@Component({
+  selector: 'app-check-box',
+  templateUrl: './check-box.component.html',
+  styleUrls: ['./check-box.component.scss'],
+  standalone: true,
+  imports: [CommonModule, ReactiveFormsModule, MatCheckboxModule, MatFormFieldModule, forwardRef(() => ComponentMapperComponent)]
+})
+export class CheckBoxComponent implements OnInit, OnDestroy {
+  @Input() pConn$: typeof PConnect;
+  @Input() formGroup$: FormGroup;
+
+  // Used with AngularPConnect
+  angularPConnectData: AngularPConnectData = {};
+  configProps$: CheckboxProps;
+
+  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;
+
+  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);
+
+    // 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...
+    this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps()) as CheckboxProps;
+
+    if (this.configProps$.value != undefined) {
+      this.value$ = this.configProps$.value;
+    }
+    this.testId = this.configProps$.testId;
+    this.label$ = this.configProps$.label;
+    this.displayMode$ = this.configProps$.displayMode;
+
+    this.caption$ = this.configProps$.caption;
+    this.helperText = this.configProps$.helperText;
+
+    // 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() as any).value;
+
+    if (this.label$ != '') {
+      this.showLabel$ = true;
+    }
+
+    // eslint-disable-next-line sonarjs/no-redundant-boolean
+    if (this.value$ === 'true' || this.value$ == true) {
+      this.isChecked$ = true;
+    } else {
+      this.isChecked$ = false;
+    }
+  }
+
+  fieldOnChange(event: any) {
+    event.value = event.checked;
+
+    this.angularPConnectData.actions?.onChange(this, event);
+  }
+
+  fieldOnBlur(event: any) {
+    event.value = event.checked;
+    this.angularPConnectData.actions?.onBlur(this, 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.fieldControl.hasError('required')) {
+      errMessage = 'You must enter a value';
+    } else if (this.fieldControl.errors) {
+      errMessage = this.fieldControl.errors.toString();
+    }
+
+    return errMessage;
+  }
+}

package/lib/field/check-box/config-ext.json

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

package/lib/field/currency/config-ext.json

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

package/lib/field/currency/currency.component.html

@@ -0,0 +1,31 @@
+<div *ngIf="displayMode$; else noDisplayMode">
+  <component-mapper *ngIf="bVisible$ !== false" name="FieldValueList" [props]="{ label$, value$, displayMode$ }"></component-mapper>
+</div>
+<ng-template #noDisplayMode>
+  <div *ngIf="!bReadonly$ && bHasForm$; else noEdit">
+    <div [formGroup]="formGroup$" *ngIf="bVisible$" class="psdk-currency-field">
+      <mat-form-field class="psdk-full-width" subscriptSizing="dynamic" [hintLabel]="helperText">
+        <mat-label>{{ label$ }}</mat-label>
+        <div class="psdk-currency-input">
+          <span>{{ symbol }}</span>
+          <input
+            style="margin-left: 5px"
+            type="float"
+            matInput
+            [placeholder]="placeholder"
+            [value]="value$ | number: '1.2-2'"
+            [required]="bRequired$"
+            [formControl]="fieldControl"
+            [attr.data-test-id]="testId"
+            (change)="fieldOnChange($event)"
+            (blur)="fieldOnBlur($event)"
+          />
+        </div>
+        <mat-error *ngIf="fieldControl.invalid">{{ getErrorMessage() }}</mat-error>
+      </mat-form-field>
+    </div>
+  </div>
+</ng-template>
+<ng-template #noEdit>
+  <component-mapper *ngIf="bVisible$ !== false" name="Text" [props]="{ pConn$, formatAs$: 'text' }"></component-mapper>
+</ng-template>

package/lib/field/currency/currency.component.scss

@@ -0,0 +1,28 @@
+.psdk-full-width {
+  width: 100%;
+}
+
+.psdk-label-readonly {
+  font-size: 1rem;
+  display: block;
+  transform: translateY(-1.28125em) scale(0.75) perspective(100px) translateZ(0.001px);
+  -ms-transform: translateY(-1.28125em) scale(0.75);
+  width: 133.33333%;
+}
+
+.psdk-data-readonly {
+  padding-top: 0.625rem;
+  width: 100%;
+}
+
+.psdk-currency-input {
+  display: flex;
+}
+
+.psdk-currency-field ::ng-deep .mdc-floating-label {
+  position: initial !important;
+}
+
+::ng-deep .mat-mdc-form-field-infix {
+  width: auto;
+}

package/lib/field/currency/currency.component.spec.ts

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

package/lib/field/currency/currency.component.ts

@@ -0,0 +1,197 @@
+import { Component, OnInit, Input, ChangeDetectorRef, forwardRef, OnDestroy } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { FormControl, FormGroup, 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 { ComponentMapperComponent } from '@pega/angular-sdk-components';
+import { getCurrencyCharacters } from '@pega/angular-sdk-components';
+import { PConnFieldProps } from '@pega/angular-sdk-components';
+
+interface CurrrencyProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on Currency here
+  currencyISOCode?: string;
+}
+
+@Component({
+  selector: 'app-currency',
+  templateUrl: './currency.component.html',
+  styleUrls: ['./currency.component.scss'],
+  standalone: true,
+  imports: [CommonModule, ReactiveFormsModule, MatFormFieldModule, MatInputModule, forwardRef(() => ComponentMapperComponent)]
+})
+export class CurrencyComponent implements OnInit, OnDestroy {
+  @Input() pConn$: typeof PConnect;
+  @Input() formGroup$: FormGroup;
+
+  // Used with AngularPConnect
+  angularPConnectData: AngularPConnectData = {};
+  configProps$: CurrrencyProps;
+
+  label$ = '';
+  value$: number | null;
+  bRequired$ = false;
+  bReadonly$ = false;
+  bDisabled$ = false;
+  bVisible$ = true;
+  displayMode$?: string = '';
+  controlName$: string;
+  bHasForm$ = true;
+  componentReference = '';
+  testId: string;
+  helperText: string;
+  placeholder: string;
+  currencyISOCode = 'USD';
+  currencyOptions: Object = {};
+
+  fieldControl = new FormControl<number | null>(null, { updateOn: 'blur' });
+  symbol: string;
+  thousandsSep: string;
+  decimalSep: 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 {
+    // starting very simple...
+
+    // moved this from ngOnInit() and call this from there instead...
+    this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps()) as CurrrencyProps;
+    this.testId = this.configProps$.testId;
+    this.label$ = this.configProps$.label;
+    this.displayMode$ = this.configProps$.displayMode;
+    const nValue: any = this.configProps$.value;
+    this.value$ = nValue && typeof nValue === 'string' ? parseFloat(nValue) : nValue;
+    this.helperText = this.configProps$.helperText;
+    this.placeholder = this.configProps$.placeholder || '';
+
+    // 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);
+    }
+
+    if (this.configProps$.currencyISOCode != null) {
+      this.currencyISOCode = this.configProps$.currencyISOCode;
+    }
+
+    const theSymbols = getCurrencyCharacters(this.currencyISOCode);
+    this.symbol = theSymbols.theCurrencySymbol;
+    this.thousandsSep = theSymbols.theDigitGroupSeparator;
+    this.decimalSep = theSymbols.theDecimalIndicator;
+
+    this.componentReference = (this.pConn$.getStateProps() as any).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();
+      });
+    }
+  }
+
+  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 = '';
+
+    // 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;
+  }
+}