@pega/dx-component-builder-sdk 0.1.47 → 0.1.49

package/src/tasks/create/templates/SDK-Angular/field/Date/date.component.ts.mustache

@@ -0,0 +1,209 @@
+import { Component, OnInit, Input, ChangeDetectorRef } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { FormControl, FormGroup, ReactiveFormsModule } from '@angular/forms';
+import { MatDatepickerModule } from '@angular/material/datepicker';
+import { MatNativeDateModule } from '@angular/material/core';
+import { MatInputModule } from '@angular/material/input';
+import { MatFormFieldModule } from '@angular/material/form-field';
+import { interval } from 'rxjs';
+import { AngularPConnectService } from '@pega/angular-sdk-library';
+import { Utils } from '@pega/angular-sdk-library';
+import { TextComponent } from '@pega/angular-sdk-library';
+import { FieldValueListComponent } from '@pega/angular-sdk-library';
+
+declare const window: any;
+
+@Component({
+  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,
+    MatFormFieldModule,
+    MatInputModule,
+    MatDatepickerModule,
+    MatNativeDateModule,
+    TextComponent,
+    FieldValueListComponent
+  ]
+})
+export class  {{COMPONENT_CLASS_NAME}}Component implements OnInit {
+  @Input() pConn$: any;
+  @Input() formGroup$: FormGroup;
+
+  // Used with AngularPConnect
+  angularPConnectData: any = {};
+  configProps$: Object;
+  label$: string = '';
+  value$: any;
+  bRequired$: boolean = false;
+  bReadonly$: boolean = false;
+  bDisabled$: boolean = false;
+  bVisible$: boolean = true;
+  displayMode$: string = '';
+  controlName$: string;
+  bHasForm$: boolean = true;
+  componentReference: string = '';
+  testId: 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$ != null) {
+      // 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$ != null) {
+      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());
+
+    if (this.configProps$['value'] != undefined) {
+      let sDateValue: any = '';
+      sDateValue = this.configProps$['value'];
+
+      if (sDateValue != '') {
+        if (typeof sDateValue == 'object') {
+          sDateValue = sDateValue.toISOString();
+        } else if (sDateValue.indexOf('/') < 0) {
+          // if we have the "pega" format, then for display, convert to standard format (US)
+          // sDateValue = this.formatDate(sDateValue);
+          sDateValue = this.utils.generateDate(sDateValue, 'Date-Long-Custom-YYYY');
+        }
+        this.value$ = new Date(sDateValue);
+      }
+    }
+    this.testId = this.configProps$['testId'];
+    this.label$ = this.configProps$['label'];
+    this.displayMode$ = this.configProps$['displayMode'];
+
+    // 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 != '') {
+      let timer = interval(100).subscribe(() => {
+        this.fieldControl.setErrors({ message: true });
+        this.fieldControl.markAsTouched();
+
+        timer.unsubscribe();
+      });
+    }
+  }
+
+  fieldOnDateChange(event: any, sValue: string) {
+    // this comes from the date pop up
+    if (typeof event.value == 'object') {
+      // convert date to pega "date" format
+      event.value = event.value.toISOString();
+    }
+    this.angularPConnectData.actions.onChange(this, { value: event.value });
+  }
+
+  fieldOnClick(event: any) {}
+
+  fieldOnBlur(event: any) {
+    // PConnect wants to use eventHandler for onBlur
+    if (typeof event.value == 'object') {
+      event.value = event.value.toISOString();
+      // convert date to pega "date" format
+      event.value = event.value.toISOString();
+    }
+    this.angularPConnectData.actions.onBlur(this, { value: event.value });
+  }
+
+  hasErrors() {
+    return this.fieldControl.status === 'INVALID';
+  }
+
+  getErrorMessage() {
+    let errMessage: string = '';
+    // 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;
+    } else if (this.fieldControl.hasError('required')) {
+      errMessage = 'You must enter a value';
+    } else if (this.fieldControl.errors) {
+      errMessage = `${this.fieldControl.errors.matDatepickerParse.text} is not a valid date value`;
+    }
+    return errMessage;
+  }
+}

package/src/tasks/create/templates/SDK-Angular/field/DateTime/config.json.mustache

@@ -0,0 +1,204 @@
+{
+  "name": "{{COMPONENT_KEY}}",
+  "label": "{{COMPONENT_LABEL}}",
+  "description": "{{DESCRIPTION}}",
+  "organization": "{{ORGANIZATION}}",
+  "version": "{{VERSION}}",
+  "library": "{{LIBRARY}}",
+  "allowedApplications": {{{ALLOWEDAPPS}}},
+  "componentKey": "{{COMPONENT_KEY}}",
+  "type": "{{TYPE}}",
+  "subtype": {{{SUB_TYPE}}},
+  "icon": "images/pz-date-time-active.svg",
+  "properties": [
+    {
+      "name": "label",
+      "label": "Field label",
+      "format": "TEXT",
+      "required": true
+    },
+    {
+      "name": "readOnly",
+      "label": "Edit mode",
+      "format": "READONLY"
+    },
+    {
+      "format": "SELECT",
+      "name": "clockFormat",
+      "label": "Clock",
+      "defaultValue": "use locale",
+      "source": [
+        {
+          "key": 0,
+          "value": "use locale"
+        },
+        {
+          "key": 12,
+          "value": "12 hours"
+        },
+        {
+          "key": 24,
+          "value": "24 hours"
+        }
+      ]
+    },
+    {
+      "name": "withSeconds",
+      "label": "Display Seconds",
+      "format": "BOOLEAN"
+    },
+    {
+      "label": "Input settings",
+      "format": "GROUP",
+      "visibility": "(!readOnly = true)",
+      "properties": [
+        {
+          "format": "LABEL",
+          "label": "Year range",
+          "variant": "secondary"
+        },
+        {
+          "format": "INLINE",
+          "elements": [
+            {
+              "key": "next",
+              "format": "LABEL",
+              "label": "Next",
+              "variant": "secondary"
+            },
+            {
+              "key": "nextYears",
+              "format": "NUMBER",
+              "label": "",
+              "name": "nextYearRange",
+              "min": 0
+            },
+            {
+              "key": "year",
+              "format": "LABEL",
+              "label": "years",
+              "variant": "secondary"
+            }
+          ]
+        },
+        {
+          "format": "INLINE",
+          "elements": [
+            {
+              "key": "previous",
+              "format": "LABEL",
+              "label": "Previous",
+              "variant": "secondary"
+            },
+            {
+              "key": "previousYears",
+              "format": "NUMBER",
+              "label": "",
+              "name": "previousYearRange",
+              "min": 0
+            },
+            {
+              "key": "year",
+              "format": "LABEL",
+              "label": "years",
+              "variant": "secondary"
+            }
+          ]
+        },
+        {
+          "name": "showWeekNumber",
+          "label": "Display week numbers on calendar",
+          "format": "BOOLEAN"
+        },
+        {
+          "format": "SELECT",
+          "name": "pickerInterval",
+          "label": "Time picker",
+          "defaultValue": "30",
+          "source": [
+            {
+              "key": "5",
+              "value": "5 min"
+            },
+            {
+              "key": "10",
+              "value": "10 min"
+            },
+            {
+              "key": "15",
+              "value": "15 min"
+            },
+            {
+              "key": "20",
+              "value": "20 min"
+            },
+            {
+              "key": "30",
+              "value": "30 min"
+            },
+            {
+              "key": "60",
+              "value": "1 hr"
+            }
+          ]
+        },
+        {
+          "name": "helperText",
+          "label": "Helper text",
+          "format": "TEXT"
+        }
+      ]
+    },
+    {
+      "label": "Read-only settings",
+      "format": "GROUP",
+      "properties": [
+        {
+          "name": "showAsFormattedText",
+          "label": "Show as formatted text",
+          "format": "BOOLEAN"
+        }
+      ]
+    },
+    {
+      "label": "Conditions",
+      "format": "GROUP",
+      "properties": [
+        {
+          "name": "required",
+          "label": "Required",
+          "format": "REQUIRED",
+          "visibility": "(!readOnly = true)"
+        },
+        {
+          "name": "disabled",
+          "label": "Disabled",
+          "format": "DISABLED",
+          "visibility": "(!readOnly = true)"
+        },
+        {
+          "name": "visibility",
+          "label": "Visibility",
+          "format": "VISIBILITY"
+        }
+      ]
+    },
+    {
+      "label": "Advanced",
+      "format": "GROUP",
+      "collapsible": true,
+      "properties": [
+        {
+          "name": "testId",
+          "label": "Test ID",
+          "format": "TEXT",
+          "ignorePattern": "[^-_\\p{N}\\p{L}]",
+          "includeAnnotations": false
+        }
+      ]
+    }
+  ],
+  "defaultConfig": {
+    "label": "@L $this.label"
+  }
+}

package/src/tasks/create/templates/SDK-Angular/field/DateTime/date-time.component.html.mustache

@@ -0,0 +1,31 @@
+<div *ngIf="displayMode$; else noDisplayMode">
+  <app-field-value-list [label$]="label$" [value$]="value$" [displayMode$]="displayMode$"></app-field-value-list>
+</div>
+{{! pick new delimiters for mustache }}
+{{=<% %>=}}
+<ng-template #noDisplayMode>
+  <div *ngIf="!bReadonly$ && bHasForm$; else noEdit">
+    <div [formGroup]="formGroup$" *ngIf="bVisible$">
+      <mat-form-field class="psdk-full-width">
+        <mat-label>{{ label$ }}</mat-label>
+        <input
+          matInput
+          [attr.data-test-id]="testId"
+          [placeholder]=""
+          type="datetime-local"
+          [value]="value$"
+          [required]="bRequired$"
+          [formControlName]="controlName$"
+          (click)="fieldOnClick($event)"
+          (change)="fieldOnChange($event)"
+          (blur)="fieldOnBlur($event)"
+        />
+        <mat-error *ngIf="fieldControl.invalid">{{ getErrorMessage() }}</mat-error>
+      </mat-form-field>
+    </div>
+  </div>
+</ng-template>
+<%={{ }}=%>     {{! revert delimiters for mustache }}
+<ng-template #noEdit>
+  <app-text [pConn$]="pConn$" [formatAs$]="'date-time'"></app-text>
+</ng-template>

package/src/tasks/create/templates/SDK-Angular/field/DateTime/date-time.component.scss.mustache

@@ -0,0 +1,20 @@
+.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%;
+}
+
+::ng-deep .mat-mdc-form-field-infix {
+  width: auto;
+}

package/src/tasks/create/templates/SDK-Angular/field/DateTime/date-time.component.spec.ts.mustache

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

package/src/tasks/create/templates/SDK-Angular/field/DateTime/date-time.component.ts.mustache

@@ -0,0 +1,177 @@
+import { Component, OnInit, Input, ChangeDetectorRef } 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 { AngularPConnectService } from '@pega/angular-sdk-library';
+import { Utils } from '@pega/angular-sdk-library';
+import { TextComponent } from '@pega/angular-sdk-library';
+import { FieldValueListComponent } from '@pega/angular-sdk-library';
+
+declare const window: any;
+
+@Component({
+  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, MatFormFieldModule, MatInputModule, TextComponent, FieldValueListComponent]
+})
+export class {{COMPONENT_CLASS_NAME}}Component implements OnInit {
+  @Input() pConn$: any;
+  @Input() formGroup$: FormGroup;
+
+  // Used with AngularPConnect
+  angularPConnectData: any = {};
+  configProps$: Object;
+
+  label$: string = '';
+  value$: any;
+  bRequired$: boolean = false;
+  bReadonly$: boolean = false;
+  bDisabled$: boolean = false;
+  bVisible$: boolean = true;
+  displayMode$: string = '';
+  controlName$: string;
+  bHasForm$: boolean = true;
+  componentReference: string = '';
+  testId: 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$ != null) {
+      // 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$ != null) {
+      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());
+
+    this.label$ = this.configProps$['label'];
+    this.displayMode$ = this.configProps$['displayMode'];
+    this.testId = this.configProps$['testId'];
+    if (this.configProps$['value'] != undefined) {
+      const value = this.configProps$['value'];
+      this.value$ = value ? value.replace('Z', '') : 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 != '') {
+      let timer = interval(100).subscribe(() => {
+        this.fieldControl.setErrors({ message: true });
+        this.fieldControl.markAsTouched();
+
+        timer.unsubscribe();
+      });
+    }
+  }
+
+  fieldOnChange(event: any) {
+    if (event.target.value) {
+      event.value = event.target.value;
+    }
+    this.angularPConnectData.actions.onChange(this, event);
+  }
+
+  fieldOnClick(event: any) {}
+
+  fieldOnBlur(event: any) {
+    // PConnect wants to use eventHandler for onBlur
+    if (event.target.value) event.value = event.target.value;
+
+    this.angularPConnectData.actions.onBlur(this, event);
+  }
+
+  getErrorMessage() {
+    let errMessage: string = '';
+    // 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;
+    } else if (this.fieldControl.hasError('required')) {
+      errMessage = 'You must enter a value';
+    } else if (this.fieldControl.errors) {
+      errMessage = this.fieldControl.errors.toString();
+    }
+    return errMessage;
+  }
+}