@pega/dx-component-builder-sdk 0.25.7 → 0.26.2

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

@@ -1,54 +1,44 @@
-import { Component, Input, Output, EventEmitter, OnChanges } from '@angular/core';
+import { Component, Input, Output, EventEmitter, OnChanges, forwardRef } 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';
+import { ComponentMapperComponent } 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]
+  imports: [CommonModule, MatGridListModule, MatButtonModule, forwardRef(() => ComponentMapperComponent)]
 })
 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';
+  discardButton: any;
+  goBackButton: any;
 
   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);
+      this.createCancelAlertButtons();
     }
   }
 
-  dismissAlert() {
+  dismissAlertOnly() {
     this.bShowAlert$ = false;
     this.onAlertState$.emit(false);
   }
 
-  dismissAlertOnly() {
+  dismissAlert() {
     this.bShowAlert$ = false;
     this.onAlertState$.emit(true);
   }
@@ -57,31 +47,28 @@ export class CancelAlertComponent implements OnChanges {
     alert(sMessage);
   }
 
-  buttonClick(sAction) {
+  createCancelAlertButtons() {
+    this.discardButton = {
+      actionID: 'discard',
+      jsAction: 'discard',
+      name: this.pConn$.getLocalizedValue('Discard', '', '')
+    };
+    this.goBackButton = {
+      actionID: 'continue',
+      jsAction: 'continue',
+      name: this.pConn$.getLocalizedValue('Go back', '', '')
+    };
+  }
+
+  buttonClick({ action }) {
     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();
-
-            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;
+    switch (action) {
       case 'continue':
         this.dismissAlertOnly();
         break;
-      case 'delete':
+      case 'discard':
         this.psService.sendMessage(true);
 
         // eslint-disable-next-line no-case-declarations

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

@@ -1,16 +1,20 @@
-<div *ngIf="displayMode$; else noDisplayMode">
-  <component-mapper
-    *ngIf="bVisible$ !== false"
-    name="FieldValueList"
-    [props]="{ label$: caption$, value$: value$ ? trueLabel$ : falseLabel$, displayMode$ }"
-  ></component-mapper>
+<div *ngIf="variant !== 'card'; else cardMode">
+  <div *ngIf="displayMode$; else noDisplayMode">
+    <component-mapper
+      *ngIf="bVisible$ !== false"
+      name="FieldValueList"
+      [props]="{ label$: caption$, value$: value$ ? trueLabel$ : falseLabel$, displayMode$ }"
+    ></component-mapper>
+  </div>
 </div>
 <ng-template #noDisplayMode>
   <div *ngIf="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>
+          <label class="mat-form-field-label psdk-label-readonly" [ngClass]="{ 'label-required': bRequired$ && selectionMode === 'multi' }">{{
+            label$
+          }}</label>
         </span>
       </div>
       <div *ngIf="selectionMode === 'multi'; else single">
@@ -18,7 +22,6 @@
           <mat-checkbox
             [labelPosition]="'after'"
             [checked]="item.selected"
-            [disabled]="bDisabled$ || bReadonly$"
             [required]="bRequired$"
             [attr.data-test-id]="testId + ':' + item.value"
             (change)="handleChangeMultiMode($event, item)"
@@ -37,14 +40,20 @@
           [formControl]="fieldControl"
           (change)="fieldOnChange($event)"
           (blur)="fieldOnBlur($event)"
-          >{{ caption$ }}</mat-checkbox
+          ><span [ngClass]="{ 'label-required': bRequired$ }">{{ caption$ }}</span></mat-checkbox
         >
         <p *ngIf="helperText">{{ helperText }}</p>
       </ng-template>
-      <mat-error *ngIf="fieldControl.invalid">{{ getErrorMessage() }}</mat-error>
+      <mat-error *ngIf="fieldControl.invalid && (fieldControl.touched || fieldControl.dirty)">{{ 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>
+<ng-template #cardMode>
+  <h4>{{ label$ }}</h4>
+  <div>
+    <component-mapper name="SelectableCard" [props]="{ pConn$: pConn$, type: 'checkbox' }" [parent]="this"></component-mapper>
+  </div>
+</ng-template>

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

@@ -11,7 +11,6 @@
   transform: translateY(-1.28125em) scale(0.75) perspective(100px) translateZ(0.001px);
   -ms-transform: translateY(-1.28125em) scale(0.75);
   width: 133.33333%;
-  color: rgba(0, 0, 0, 0.6);
 }
 
 .psdk-data-readonly {
@@ -35,3 +34,9 @@ mat-checkbox {
 .mat-mdc-option {
   margin-left: -16px;
 }
+
+.label-required::after {
+  display: inline;
+  content: ' *';
+  vertical-align: top;
+}

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

@@ -1,12 +1,11 @@
-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';
@@ -26,38 +25,22 @@ interface CheckboxProps extends Omit<PConnFieldProps, 'value'> {
   primaryField: string;
   readonlyContextList: any;
   referenceList: string;
+  variant?: string;
+  renderMode: string;
 }
 
 @Component({
   selector: 'app-check-box',
   templateUrl: './check-box.component.html',
   styleUrls: ['./check-box.component.scss'],
-  standalone: true,
   imports: [CommonModule, ReactiveFormsModule, MatCheckboxModule, MatFormFieldModule, MatOptionModule, forwardRef(() => ComponentMapperComponent)]
 })
-export class CheckBoxComponent implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
-
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
+export class CheckBoxComponent extends FieldBase implements OnInit, OnDestroy {
   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;
   trueLabel$?: string;
   falseLabel$?: string;
 
@@ -69,84 +52,35 @@ export class CheckBoxComponent implements OnInit, OnDestroy {
   selectedvalues: any;
   referenceList: string;
   listOfCheckboxes: any[] = [];
-  actionsApi: Object;
-  propName: 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
+  variant?: string;
 
-    // call updateSelf when initializing
-    // this.updateSelf();
-    this.checkAndUpdate();
+  // Override ngOnInit method
+  override ngOnInit(): void {
+    super.ngOnInit();
 
-    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 CheckboxProps;
 
-    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;
+    if (this.bReadonly$) {
+      this.fieldControl?.disable();
+    }
 
     // multi case
     this.selectionMode = this.configProps$.selectionMode;
@@ -155,6 +89,7 @@ export class CheckBoxComponent 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;
@@ -172,54 +107,10 @@ export class CheckBoxComponent 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;
-
-      // eslint-disable-next-line sonarjs/no-redundant-boolean
-      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;
     }
   }
 
@@ -257,21 +148,4 @@ export class CheckBoxComponent 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;
-  }
 }