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

package/src/tasks/create/templates/SDK-Angular/field/Picklist-Autocomplete/picklist-autocomplete.component.ts.mustache

@@ -1,19 +1,23 @@
-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, MatAutocompleteSelectedEvent } from '@angular/material/autocomplete';
+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';
 import { PConnFieldProps } from '@pega/angular-sdk-components';
 
+interface IOption {
+  key: string;
+  value: string;
+}
 interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
   // If any, enter additional props that only exist on AutoComplete here
   deferDatasource?: boolean;
@@ -30,7 +34,6 @@ interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
   selector: 'app-{{COMPONENT_CLASS_NAME_KEBAB}}',
   templateUrl: './{{COMPONENT_CLASS_NAME_KEBAB}}.component.html',
   styleUrls: ['./{{COMPONENT_CLASS_NAME_KEBAB}}.component.scss'],
-  standalone: true,
   imports: [
     CommonModule,
     ReactiveFormsModule,
@@ -39,81 +42,38 @@ interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
     MatAutocompleteModule,
     MatOptionModule,
     forwardRef(() => ComponentMapperComponent)
-  ]
-  })
-export class {{COMPONENT_CLASS_NAME}}Component implements OnInit, OnDestroy {
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
+  ],
+  providers: [DatapageService]
+})
+export class {{COMPONENT_CLASS_NAME}}Component extends FieldBase implements OnInit {
+  protected dataPageService = inject(DatapageService);
+
+  @Output() onRecordChange: EventEmitter<any> = new EventEmitter();
 
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
   configProps$: {{COMPONENT_CLASS_NAME}}Props;
 
-  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 = '';
 
-  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(''),
-      map(value => this._filter(value || ''))
+      map(value => this._filter((value as string) || ''))
     );
   }
 
-  ngOnDestroy(): void {
-    if (this.formGroup$) {
-      this.formGroup$.removeControl(this.controlName$);
-    }
-
-    if (this.angularPConnectData.unsubscribeFn) {
-      this.angularPConnectData.unsubscribeFn();
-    }
+  setOptions(options: IOption[]) {
+    this.options$ = options;
+    const index = this.options$?.findIndex(element => element.key === this.configProps$.value);
+    this.value$ = index > -1 ? this.options$[index].value : this.configProps$.value;
+    this.fieldControl.setValue(this.value$);
   }
 
   private _filter(value: string): string[] {
@@ -121,35 +81,27 @@ export class {{COMPONENT_CLASS_NAME}}Component implements OnInit, OnDestroy {
     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 {{COMPONENT_CLASS_NAME}}Props;
 
-  // 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 {{COMPONENT_CLASS_NAME}}Props;
+    // 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.listType = listType;
+    this.parameters = parameters;
 
     const context = this.pConn$.getContextName();
     const { columns, datasource } = this.generateColumnsAndDataSource();
@@ -157,70 +109,23 @@ export class {{COMPONENT_CLASS_NAME}}Component 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() as any).value;
     if (this.listType === 'associated') {
-      this.options$ = this.utils.getOptionList(this.configProps$, this.pConn$.getDataObject('')); // 1st arg empty string until typedef marked correctly
+      const optionsList = this.utils.getOptionList(this.configProps$, this.pConn$.getDataObject('')); // 1st arg empty string until typedef marked correctly
+      this.setOptions(optionsList);
     }
 
     if (!this.displayMode$ && this.listType !== 'associated') {
       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() {
     let datasource = this.configProps$.datasource;
     let columns = this.configProps$.columns;
     // const { deferDatasource, datasourceMetadata } = this.configProps$;
-    const { deferDatasource, datasourceMetadata }: any = this.pConn$.getConfigProps();
+    const { deferDatasource, datasourceMetadata } = this.pConn$.getConfigProps();
     // convert associated to datapage listtype and transform props
     // Process deferDatasource when datapage name is present. WHhen tableType is promptList / localList
     if (deferDatasource && datasourceMetadata?.datasource?.name) {
@@ -258,7 +163,7 @@ export class {{COMPONENT_CLASS_NAME}}Component implements OnInit, OnDestroy {
       };
       optionsData.push(obj);
     });
-    this.options$ = optionsData;
+    this.setOptions(optionsData);
   }
 
   flattenParameters(params = {}) {
@@ -295,51 +200,24 @@ export class {{COMPONENT_CLASS_NAME}}Component 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);
-    this.filterValue = (event.target as HTMLInputElement).value;
-
-    this.angularPConnectData.actions?.onChange(this, event);
+    const value = (event.target as HTMLInputElement).value;
+    this.filterValue = value;
+    handleEvent(this.actionsApi, 'change', this.propName, value);
   }
 
-  optionChanged(event: MatAutocompleteSelectedEvent) {
-    this.angularPConnectData.actions?.onChange(this, event);
-  }
+  optionChanged(event: any) {
+    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;
-    const actionsApi = this.pConn$?.getActionsApi();
-    const propName = (this.pConn$?.getStateProps() as any).value;
-    handleEvent(actionsApi, 'changeNblur', propName, value);
-    if (this.configProps$?.onRecordChange) {
-      el.value = value;
-      this.configProps$.onRecordChange(event);
-    }
-  }
-
-  getErrorMessage() {
-    let errMessage = '';
+    handleEvent(this.actionsApi, 'changeNblur', this.propName, value);
 
-    // 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/src/tasks/create/templates/SDK-Angular/field/Picklist-RadioButtons/config.json.mustache

@@ -5,7 +5,6 @@
   "organization": "{{ORGANIZATION}}",
   "version": "{{VERSION}}",
   "library": "{{LIBRARY}}",
-  "allowedApplications": {{{ALLOWEDAPPS}}},
   "componentKey": "{{COMPONENT_KEY}}",
   "type": "{{TYPE}}",
   "subtype": {{{SUB_TYPE}}},

package/src/tasks/create/templates/SDK-Angular/field/Picklist-RadioButtons/demo.stories.tsx.mustache

@@ -8,48 +8,49 @@ const meta: Meta<{{COMPONENT_CLASS_NAME}}Component> = {
   title: '{{COMPONENT_CLASS_NAME}}',
   component: {{COMPONENT_CLASS_NAME}}Component,
   excludeStories: /.*Data$/,
-  render: (args: {{COMPONENT_CLASS_NAME}}Component) => ({
+  render: (args) => ({
     props: {
       ...args,
       pConn$: {
-      resolveConfigProps: props => props,
-      getConfigProps: () => {
-        return configProps;
-      },
-      getContextName: () => {
-        return 'app/primary_1/workarea_3';
-      },
-      getStateProps: () => {
-        return stateProps;
-      },
-      getDataObject: () => {
-        return;
-      },
-      getActionsApi: () => {
-        return {
-          updateFieldValue: () => {
-            /* nothing */
-          },
-          triggerFieldChange: () => {
-            /* nothing */
-          }
-        };
-      },
-      getCaseInfo: () => {
-        return {
-          getClassName: () => {
-            return 'DIXL-MediaCo-Work-NewService';
-          }
-        };
-      },
-      getLocalizedValue: val => {
-        return val;
-      },
-      getLocaleRuleNameFromKeys: () => {
-        return undefined;
-      }
-    } as any,
-    formGroup$: new FormBuilder().group({})
+        resolveConfigProps: props => props,
+        getConfigProps: () => {
+          return configProps;
+        },
+        getContextName: () => {
+          return 'app/primary_1/workarea_3';
+        },
+        getStateProps: () => {
+          return stateProps;
+        },
+        getDataObject: () => {
+          return;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {
+              /* nothing */
+            },
+            triggerFieldChange: () => {
+              /* nothing */
+            }
+          };
+        },
+        getCaseInfo: () => {
+          return {
+            getClassName: () => {
+              return 'DIXL-MediaCo-Work-NewService';
+            }
+          };
+        },
+        getLocalizedValue: val => {
+          return val;
+        },
+        getLocaleRuleNameFromKeys: () => {
+          return undefined;
+        },
+        clearErrorMessages: ({}) => {}
+      } as any,
+      formGroup$: new FormBuilder().group({})
     }
   })
 };

package/src/tasks/create/templates/SDK-Angular/field/Picklist-RadioButtons/picklist-radio-buttons.component.html.mustache

@@ -1,20 +1,19 @@
-<div *ngIf="displayMode$; else noDisplayMode">
-  <component-mapper
-    *ngIf="bVisible$ !== false"
-    name="FieldValueList"
-    [props]="{ label$, value$: this.localizedValue, displayMode$ }"
-  ></component-mapper>
+<div *ngIf="variant !== 'card'; else cardMode">
+  <div *ngIf="displayMode$; else noDisplayMode">
+    <component-mapper
+      *ngIf="bVisible$ !== false"
+      name="FieldValueList"
+      [props]="{ label$, value$: this.localizedValue, displayMode$ }"
+    ></component-mapper>
+  </div>
 </div>
 {{! pick new delimiters for mustache }}
 {{=<% %>=}}
 <ng-template #noDisplayMode>
   <div [formGroup]="formGroup$" *ngIf="bVisible$">
     <mat-form-field class="psdk-radio-form" subscriptSizing="dynamic" [hintLabel]="helperText">
-      <span class="psdk-label-wrapper-readonly">
-        <label class="psdk-label-readonly">{{ label$ }}</label>
-      </span>
-      <!-- <mat-label>{{label$}}</mat-label> -->
-      <input matInput [placeholder]="placeholder" style="display: none" />
+      <mat-label>{{ label$ }}</mat-label>
+      <input matInput [placeholder]="placeholder" style="display: none" [required]="bRequired$" />
       <mat-radio-group
         [value]="value$"
         [required]="bRequired$"
@@ -26,7 +25,7 @@
         <mat-radio-button
           *ngFor="let opt of options$"
           [checked]="isSelected(opt.key)"
-          [disabled]="bReadonly$"
+          [disabled]="bDisabled$ || bReadonly$"
           [value]="opt.key"
           class="psdk-radio-button"
         >
@@ -37,4 +36,10 @@
     </mat-form-field>
   </div>
 </ng-template>
+<ng-template #cardMode>
+  <h4>{{ label$ }}</h4>
+  <div>
+    <component-mapper name="SelectableCard" [props]="{ pConn$: pConn$, type: 'radio' }" [parent]="this"></component-mapper>
+  </div>
+</ng-template>
 <%={{ }}=%>     {{! revert delimiters for mustache }}

package/src/tasks/create/templates/SDK-Angular/field/Picklist-RadioButtons/picklist-radio-buttons.component.scss.mustache

@@ -15,11 +15,13 @@
 .psdk-radio-horizontal {
   display: flex;
   flex-direction: row;
+  margin-top: 1rem;
 }
 
 .psdk-radio-vertical {
   display: flex;
   flex-direction: column;
+  margin-top: 1rem;
 }
 
 .psdk-radio-button {
@@ -30,8 +32,8 @@
   width: 100%;
 }
 
-.psdk-radio-form ::ng-deep .mat-form-field-underline {
-  background-color: transparent;
+.psdk-radio-form ::ng-deep .mdc-line-ripple {
+  display: none;
 }
 
 .psdk-radio-form ::ng-deep .mat-form-field-label {

package/src/tasks/create/templates/SDK-Angular/field/Picklist-RadioButtons/picklist-radio-buttons.component.spec.ts.mustache

@@ -8,9 +8,8 @@ describe('{{COMPONENT_CLASS_NAME}}Component', () => {
 
   beforeEach(waitForAsync(() => {
     TestBed.configureTestingModule({
-      declarations: [ {{COMPONENT_CLASS_NAME}}Component ]
-    })
-    .compileComponents();
+      declarations: [{{COMPONENT_CLASS_NAME}}Component]
+    }).compileComponents();
   }));
 
   beforeEach(() => {