@pega/dx-component-builder-sdk 0.23.13 → 0.23.14

package/src/tasks/create/templates/SDK-React/widget/PAGE-CASE/index.tsx.mustache

@@ -13,13 +13,13 @@ import { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
 
 interface {{COMPONENT_CLASS_NAME}}Props extends PConnProps {
   // If any, enter additional props that only exist on this component
-    label: string;
-    createDateTime: string;
-    createLabel: string;
-    createOperator: { userName: string; userId: string };
-    updateDateTime: string;
-    updateLabel: string;
-    updateOperator: { userName: string; userId: string };
+  label: string;
+  createDateTime: string;
+  createLabel: string;
+  createOperator: { userName: string; userId: string };
+  updateDateTime: string;
+  updateLabel: string;
+  updateOperator: { userName: string; userId: string };
 }
 
 const useStyles = makeStyles(theme => ({
@@ -38,7 +38,6 @@ const useStyles = makeStyles(theme => ({
 // Page Case Widget example
 
 // props passed in combination of props from property panel (config.json) and run time props from Constellation
-// any default values in config.pros should be set in defaultProps at bottom of this file
 export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
   // const componentName = "Operator";
   const classes = useStyles();
@@ -192,37 +191,38 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
   // End of popover-related
 
   return (
-  <Styled{{COMPONENT_CLASS_NAME}}Wrapper><>
-{{! pick new delimiters for mustache }}
-{{=<% %>=}}
-      <TextField
-        defaultValue={caseOpName}
-        label={caseOpLabel}
-        onClick={showOperatorDetails}
-        InputProps={{
-          readOnly: true,
-          disableUnderline: true,
-          inputProps: { style: { cursor: 'pointer' } }
-        }}
-      />
-      <br />
-      {Utils.generateDateTime(caseTime, 'DateTime-Since')}
-<%={{ }}=%>     {{! revert delimiters for mustache }}
-      <Popover
-        id={popoverId}
-        open={popoverOpen}
-        anchorEl={popoverAnchorEl}
-        onClose={handlePopoverClose}
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+      <>
         {{! pick new delimiters for mustache }}
         {{=<% %>=}}
-        anchorOrigin={{ vertical: 'bottom', horizontal: 'center' }}
-        transformOrigin={{ vertical: 'top', horizontal: 'center' }}
-        PaperProps={{ style: { maxWidth: '45ch' } }}
+        <TextField
+          defaultValue={caseOpName}
+          label={caseOpLabel}
+          onClick={showOperatorDetails}
+          InputProps={{
+            readOnly: true,
+            disableUnderline: true,
+            inputProps: { style: { cursor: 'pointer' } }
+          }}
+        />
+        <br />
+        {Utils.generateDateTime(caseTime, 'DateTime-Since')}
         <%={{ }}=%>     {{! revert delimiters for mustache }}
-      >
-        {getPopoverGrid()}
-      </Popover>
-    </>
+        <Popover
+          id={popoverId}
+          open={popoverOpen}
+          anchorEl={popoverAnchorEl}
+          onClose={handlePopoverClose}
+          {{! pick new delimiters for mustache }}
+          {{=<% %>=}}
+          anchorOrigin={{ vertical: 'bottom', horizontal: 'center' }}
+          transformOrigin={{ vertical: 'top', horizontal: 'center' }}
+          PaperProps={{ style: { maxWidth: '45ch' } }}
+          <%={{ }}=%>     {{! revert delimiters for mustache }}
+        >
+          {getPopoverGrid()}
+        </Popover>
+      </>
     </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
   );
-}
+}

package/src/tasks/validator/index.js

@@ -5,22 +5,19 @@ import chalk from 'chalk';
 import inquirer from 'inquirer';
 import Ajv from 'ajv';
 
-import {
-  COMPONENT_SCHEMA,
-  CATEGORY_CUSTOM,
-  CATEGORY_OVERRIDE } from '../../constants.js';
-
+import { COMPONENT_SCHEMA, CATEGORY_CUSTOM, CATEGORY_OVERRIDE } from '../../constants.js';
 import {
   getComponentDirectoryPath,
   getComponents,
   getOOTBComponents,
   removeComponentPrefix,
-  getFramework, 
-  getLocalComponentKeyFromConfig} from '../../util.js';
+  getFramework,
+  getLocalComponentKeyFromConfig
+} from '../../util.js';
 
 const ajv = new Ajv({ allErrors: true });
 
-const combinationTypes = ['PAGE', 'CASE'];
+// const combinationTypes = ['PAGE', 'CASE'];
 
 const allowedSubtypes = [
   ...new Set([
@@ -30,13 +27,25 @@ const allowedSubtypes = [
   ])
 ];
 
+const allowedOverrideTypes = [
+  ...new Set([...COMPONENT_SCHEMA.type.map(({ value }) => value)]),
+  'Group'
+];
+
 // additional subtypes are manually added below
 const allowedOverrideSubtypes = [
   ...new Set([
     ...COMPONENT_SCHEMA.subtype.field.map(({ value }) => value),
     ...COMPONENT_SCHEMA.subtype.template.map(({ value }) => value),
     ...COMPONENT_SCHEMA.subtype.widget.map(({ value }) => value)
-  ]), "ACTION", "DATA_CAPTURE", "SUMMARY", "CASEVIEW", "DATAVIEW", "LIST", "TAB"
+  ]),
+  'ACTION',
+  'DATA_CAPTURE',
+  'SUMMARY',
+  'CASEVIEW',
+  'DATAVIEW',
+  'LIST',
+  'TAB'
 ];
 
 const schema = {
@@ -93,16 +102,16 @@ const schema = {
                     {
                       type: 'object',
                       properties: {
-                        key: { type: 'string'},
+                        key: { type: 'string' },
                         name: { type: 'string' },
                         label: { type: 'string' },
                         format: { type: 'string' }
                       },
-                      required: ['key','name', 'label', 'format']
+                      required: ['key', 'name', 'label', 'format']
                     }
                   ]
                 }
-              },
+              }
             },
             required: ['format']
           },
@@ -159,13 +168,12 @@ const schema = {
                         }
                       },
                       required: ['format', 'elements']
-                    },
+                    }
                   ]
                 }
               }
-
             },
-            required: ['label', 'format'],
+            required: ['label', 'format']
           }
         ]
       }
@@ -188,7 +196,7 @@ const overrideSchema = {
     version: { type: 'string' },
     library: { type: 'string' },
     allowedApplications: { type: 'array' },
-    type: { type: 'string', enum: COMPONENT_SCHEMA.type.map(({ value }) => value) },
+    type: { type: 'string', enum: allowedOverrideTypes },
     subtype: {
       anyOf: [{ type: 'string' }, { type: 'array' }],
 
@@ -230,16 +238,16 @@ const overrideSchema = {
                     {
                       type: 'object',
                       properties: {
-                        key: { type: 'string'},
+                        key: { type: 'string' },
                         name: { type: 'string' },
                         label: { type: 'string' },
                         format: { type: 'string' }
                       },
-                      required: ['key','name', 'label', 'format']
+                      required: ['key', 'name', 'label', 'format']
                     }
                   ]
                 }
-              },
+              }
             },
             required: ['format']
           },
@@ -296,13 +304,12 @@ const overrideSchema = {
                         }
                       },
                       required: ['format', 'elements']
-                    },
+                    }
                   ]
                 }
               }
-
             },
-            required: ['label', 'format'],
+            required: ['label', 'format']
           }
         ]
       }
@@ -316,8 +323,6 @@ const overrideSchema = {
 const validateSchema = ajv.compile(schema);
 const validateOverrideSchema = ajv.compile(overrideSchema);
 
-
-
 export default async (option, category = CATEGORY_CUSTOM) => {
   let componentToValidate = null;
   const framework = await getFramework();
@@ -341,55 +346,57 @@ export default async (option, category = CATEGORY_CUSTOM) => {
   }
 
   const componentDirectory = await getComponentDirectoryPath(componentToValidate, category);
-  let configFileName = "config.json";
+  let configFileName = 'config.json';
   if (category === CATEGORY_OVERRIDE) {
-    configFileName = "config-ext.json";
+    configFileName = 'config-ext.json';
   }
   const configFile = path.join(componentDirectory, configFileName);
   let configData;
   try {
     configData = fs.readFileSync(path.resolve(configFile), 'utf8');
-  }
-  catch (err) {
+  } catch (err) {
     if (category === CATEGORY_CUSTOM) {
       throw new Error(`Missing config file for: ${componentToValidate}`);
-    }
-    else if (category === CATEGORY_OVERRIDE) {
+    } else if (category === CATEGORY_OVERRIDE) {
       // for now, if now file just end
-      console.log(`${chalk.bold.yellow('Config file not available for: ' + componentToValidate)}`);
+      console.log(`${chalk.bold.yellow(`Config file not available for: ${componentToValidate}`)}`);
       return;
     }
   }
 
-  //const data = JSON.parse(fs.readFileSync(path.resolve(configFile), 'utf8'));
+  // const data = JSON.parse(fs.readFileSync(path.resolve(configFile), 'utf8'));
   const data = JSON.parse(configData);
 
-  // for now a special case for ScalarList, it doesn't have a "subtype", so for now manualy
+  // for now a special case for ScalarList & Group, those doesn't have a "subtype", so for now manualy
   // add one in here, just to pass validation
-  if (data["name"] === "ScalarList") {
-    data["subtype"] = "LIST";
+  if (data.name === 'ScalarList') {
+    data.subtype = 'LIST';
+  }
+  if (data.name === 'Group') {
+    data.subtype = 'DATA_CAPTURE';
   }
 
-  const valid = (category === CATEGORY_OVERRIDE) ? validateOverrideSchema(data) : validateSchema(data);
+  const valid =
+    category === CATEGORY_OVERRIDE ? validateOverrideSchema(data) : validateSchema(data);
 
   if (valid) {
-
     // need to remove path
     const originalComponentToValidate = componentToValidate;
     componentToValidate = removeComponentPrefix(componentToValidate);
 
     // don't check for out the box if override
-    if (category != CATEGORY_OVERRIDE) {
-
+    if (category !== CATEGORY_OVERRIDE) {
       // we are validating the component name, not the actual component
       // so need to get the component name (or key) from config.json
-      switch(framework) {
-        case "SDK-Angular":
+      switch (framework) {
+        case 'SDK-Angular':
           componentToValidate = await getLocalComponentKeyFromConfig(originalComponentToValidate);
           break;
-        case "SDK-React":
+        case 'SDK-React':
+          break;
+        case 'SDK-WebComponents':
           break;
-        case "SDK-WebComponents":
+        default:
           break;
       }
 
@@ -404,15 +411,13 @@ export default async (option, category = CATEGORY_CUSTOM) => {
       }
     }
 
-
     console.log(`${chalk.bold.green(componentToValidate)} schema is valid`);
   } else {
+    // eslint-disable-next-line no-lonely-if
     if (category === CATEGORY_OVERRIDE) {
       throw new Error(`Invalid: ${ajv.errorsText(validateOverrideSchema.errors)}`);
-    }
-    else {
+    } else {
       throw new Error(`Invalid: ${ajv.errorsText(validateSchema.errors)}`);
     }
-
   }
 };

package/tests/assets/sdk-a/components/create/override-sdk/designSystemExtension/rich-text-editor/rich-text-editor.component.html

@@ -0,0 +1,33 @@
+<div [attr.data-test-id]="testId">
+  <label [ngClass]="{ 'label-required': required === true }" class="rich-text-label">{{ label }}</label>
+  <div class="rich-text-editor" *ngIf="!readonly">
+    <editor
+      [formControl]="richText"
+      [attr.disabled]="disabled"
+      [initialValue]="value"
+      [init]="{
+        base_url: '/tinymce',
+        suffix: '.min',
+        menubar: false,
+        placeholder,
+        statusbar: false,
+        min_height: 130,
+        plugins: ['lists', 'advlist', 'autolink', 'image', 'link', 'autoresize'],
+        autoresize_bottom_margin: 0,
+        toolbar: disabled ? false : 'blocks | bold italic strikethrough | bullist numlist outdent indent | link image',
+        toolbar_location: 'bottom',
+        content_style: 'body { font-family:Helvetica, Arial,sans-serif; font-size:14px }',
+        branding: false,
+        paste_data_images: true,
+        file_picker_types: 'image',
+        file_picker_callback: filePickerCallback
+      }"
+      (onBlur)="blur()"
+      (onChange)="change($event)"
+    ></editor>
+    <p *ngIf="richText.invalid" [ngClass]="'text-editor-error'">{{ info }}</p>
+  </div>
+  <div *ngIf="readonly">
+    <div class="readonly-richtext-editor" style="margin: 10px 5px" [innerHTML]="value || '--'"></div>
+  </div>
+</div>

package/tests/assets/sdk-a/components/create/override-sdk/designSystemExtension/rich-text-editor/rich-text-editor.component.scss

@@ -0,0 +1,19 @@
+.rich-text-label {
+  margin: 5px;
+  font-size: 16px;
+}
+
+.rich-text-editor {
+  margin: 10px 0px;
+}
+
+.label-required::after {
+  display: inline;
+  content: ' *';
+  vertical-align: top;
+  color: var(--app-neutral-dark-color);
+}
+
+.text-editor-error {
+  color: var(--app-error-light-color);
+}

package/tests/assets/sdk-a/components/create/override-sdk/designSystemExtension/rich-text-editor/rich-text-editor.component.spec.ts

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

package/tests/assets/sdk-a/components/create/override-sdk/designSystemExtension/rich-text-editor/rich-text-editor.component.ts

@@ -0,0 +1,89 @@
+import { Component, Input, Output, EventEmitter, OnChanges } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { FormControl, ReactiveFormsModule, Validators } from '@angular/forms';
+import { EditorModule, TINYMCE_SCRIPT_SRC } from '@tinymce/tinymce-angular';
+
+declare let tinymce: any;
+
+@Component({
+  selector: 'app-rich-text-editor',
+  templateUrl: './rich-text-editor.component.html',
+  styleUrls: ['./rich-text-editor.component.scss'],
+  standalone: true,
+  imports: [CommonModule, EditorModule, ReactiveFormsModule],
+  providers: [{ provide: TINYMCE_SCRIPT_SRC, useValue: 'tinymce/tinymce.min.js' }]
+})
+export class RichTextEditorComponent implements OnChanges {
+  @Input() placeholder;
+  @Input() disabled;
+  @Input() readonly;
+  @Input() value;
+  @Input() label;
+  @Input() required;
+  @Input() info;
+  @Input() error;
+  @Input() testId;
+
+  @Output() onBlur: EventEmitter<any> = new EventEmitter();
+  @Output() onChange: EventEmitter<any> = new EventEmitter();
+
+  richText = new FormControl();
+
+  ngOnChanges() {
+    if (this.required) {
+      this.richText.addValidators(Validators.required);
+    }
+
+    if (this.disabled) {
+      this.richText.disable();
+    } else {
+      this.richText.enable();
+    }
+
+    if (this.value) {
+      this.richText.setValue(this.value);
+    }
+  }
+
+  filePickerCallback = cb => {
+    const input = document.createElement('input');
+    input.setAttribute('type', 'file');
+    input.setAttribute('accept', 'image/*');
+
+    input.addEventListener('change', (e: any) => {
+      const file = e.target.files[0];
+
+      const reader: any = new FileReader();
+      reader.addEventListener('load', () => {
+        /*
+            Note: Now we need to register the blob in TinyMCEs image blob
+            registry. In the next release this part hopefully won't be
+            necessary, as we are looking to handle it internally.
+        */
+        const blobId = `blobid${new Date().getTime()}`;
+        console.log('editorRef', tinymce.activeEditor);
+        const blobCache = tinymce.activeEditor.editorUpload.blobCache;
+        const base64 = reader.result.split(',')[1];
+        const blobInfo = blobCache.create(blobId, file, base64);
+        blobCache.add(blobInfo);
+
+        /* call the callback and populate the Title field with the file name */
+        cb(blobInfo.blobUri(), { title: file.name });
+      });
+      reader.readAsDataURL(file);
+    });
+
+    input.click();
+  };
+
+  blur() {
+    if (tinymce.activeEditor) {
+      const editorValue = tinymce.activeEditor.getContent({ format: 'html' });
+      this.onBlur.emit(editorValue);
+    }
+  }
+
+  change(event) {
+    this.onChange.emit(event);
+  }
+}

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

@@ -0,0 +1,20 @@
+<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$; else noEdit">
+    <div *ngIf="bVisible$">
+      <component-mapper
+        name="RichTextEditor"
+        [props]="{ placeholder, required: bRequired$, disabled: bDisabled$, label: label$, readonly: false, error, info, testId, value: value$ }"
+        [parent]="this"
+        [outputEvents]="{ onBlur: fieldOnBlur, onChange: fieldOnChange }"
+      ></component-mapper>
+    </div>
+  </div>
+</ng-template>
+<ng-template #noEdit>
+  <div *ngIf="bVisible$ !== false">
+    <component-mapper name="RichTextEditor" [props]="{ label: label$, value: value$, readonly: true, testId }" [parent]="this"></component-mapper>
+  </div>
+</ng-template>

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

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

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

@@ -0,0 +1,131 @@
+import { Component, OnInit, Input, forwardRef, OnDestroy } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { FormGroup, ReactiveFormsModule } from '@angular/forms';
+import { AngularPConnectData, AngularPConnectService } from '@pega/angular-sdk-components';
+import { Utils } from '@pega/angular-sdk-components';
+import { ComponentMapperComponent } from '@pega/angular-sdk-components';
+import { handleEvent } from '@pega/angular-sdk-components';
+import { PConnFieldProps } from '@pega/angular-sdk-components';
+
+interface RichTextProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on RichText here
+}
+
+@Component({
+  selector: 'app-rich-text',
+  templateUrl: './rich-text.component.html',
+  styleUrls: ['./rich-text.component.scss'],
+  standalone: true,
+  imports: [CommonModule, ReactiveFormsModule, forwardRef(() => ComponentMapperComponent)]
+})
+export class RichTextComponent implements OnInit, OnDestroy {
+  @Input() pConn$: typeof PConnect;
+  @Input() formGroup$: FormGroup;
+
+  // Used with AngularPConnect
+  angularPConnectData: AngularPConnectData = {};
+  configProps$: RichTextProps;
+
+  label$ = '';
+  value$ = '';
+  bRequired$ = false;
+  bReadonly$ = false;
+  bDisabled$ = false;
+  bVisible$ = true;
+  displayMode$?: string = '';
+  controlName$: string;
+  testId: string;
+  helperText: string;
+  placeholder: any;
+  info: any;
+  error: boolean;
+  status: any;
+
+  constructor(
+    private angularPConnect: AngularPConnectService,
+    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);
+
+    // call updateSelf when initializing
+    this.checkAndUpdate();
+  }
+
+  ngOnDestroy(): void {
+    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 RichTextProps;
+    const stateProps: any = this.pConn$.getStateProps();
+    this.status = stateProps?.status;
+
+    if (this.configProps$.value != undefined) {
+      this.value$ = this.configProps$.value;
+    }
+
+    this.testId = this.configProps$.testId;
+    this.displayMode$ = this.configProps$.displayMode;
+    this.label$ = this.configProps$.label;
+    this.placeholder = this.configProps$.placeholder;
+    this.info = stateProps?.validatemessage || this.configProps$.helperText;
+    this.error = stateProps?.status === 'error';
+
+    if (this.configProps$.required != null) {
+      this.bRequired$ = this.utils.getBooleanValue(this.configProps$.required);
+    }
+
+    if (this.configProps$.visibility != null) {
+      this.bVisible$ = this.utils.getBooleanValue(this.configProps$.visibility);
+    }
+
+    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);
+    }
+  }
+
+  fieldOnChange() {
+    if (this.status === 'error') {
+      const property = (this.pConn$.getStateProps() as any).value;
+      this.pConn$.clearErrorMessages({
+        property,
+        category: '',
+        context: ''
+      });
+    }
+  }
+
+  fieldOnBlur(editorValue: any) {
+    // PConnect wants to use eventHandler for onBlur
+    const actionsApi = this.pConn$?.getActionsApi();
+    const propName = (this.pConn$?.getStateProps() as any).value;
+    handleEvent(actionsApi, 'changeNblur', propName, editorValue);
+  }
+}