@pega/dx-component-builder-sdk 0.23.6 → 0.23.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/dx-component-builder-sdk",
-  "version": "0.23.6",
+  "version": "0.23.7",
   "description": "Utility for building custom UI components",
   "bin": "./bin/index.js",
   "scripts": {

package/src/tasks/create/templates/Constellation/field/Text-Input/index.jsx.mustache

@@ -102,7 +102,7 @@ const {{COMPONENT_CLASS_NAME}} = props => {
     } else if (!hasSuggestions && status !== 'success') {
       setStatus(validatemessage !== '' ? 'error' : undefined);
     }
-  }, [validatemessage, hasSuggestions]);
+  }, [validatemessage, hasSuggestions, status]);
 
   const onResolveSuggestionHandler = (accepted) => {
     suggestionsHandler(accepted, pConn, setStatus);

package/tests/assets/components/SDK-React/create/override-sdk/designSystemExtension/AlertBanner/AlertBanner.tsx

@@ -0,0 +1,47 @@
+import React from 'react';
+import { Alert } from '@material-ui/lab';
+
+
+// AlertBanner is one of the few components that does NOT have getPConnect.
+//  So, no need to extend PConnProps
+interface AlertBannerProps {
+  // If any, enter additional props that only exist on Date here
+  id: string,
+  variant: string,
+  messages: Array<string>,
+  onDismiss?: any
+}
+
+
+const SEVERITY_MAP = {
+  urgent: 'error',
+  warning: 'warning',
+  success: 'success',
+  info: 'info'
+};
+
+export default function AlertBanner(props:AlertBannerProps) {
+  const { id, variant, messages, onDismiss } = props;
+  let additionalProps = {};
+
+  if (onDismiss) {
+    additionalProps = {
+      onClose: onDismiss
+    };
+  }
+
+  return (
+    <div id={id}>
+      {messages.map(message => (
+        <Alert
+          key={message}
+          variant='outlined'
+          severity={SEVERITY_MAP[variant]}
+          {...additionalProps}
+        >
+          {message}
+        </Alert>
+      ))}
+    </div>
+  );
+}

package/tests/assets/components/SDK-React/create/override-sdk/designSystemExtension/AlertBanner/index.tsx

@@ -0,0 +1 @@
+export { default } from './AlertBanner';

package/tests/assets/components/SDK-React/create/override-sdk/designSystemExtension/CaseSummaryFields/CaseSummaryFields.tsx

@@ -1,11 +1,10 @@
 import React, { useState, useEffect } from 'react';
 import isDeepEqual from 'fast-deep-equal/react';
-
 import Grid from '@material-ui/core/Grid';
 import TextField from '@material-ui/core/TextField';
-import Operator from '@pega/react-sdk-components/lib/components/designSystemExtension/Operator';
 import { getDateFormatInfo } from '@pega/react-sdk-components/lib/components/helpers/date-format-utils';
 import { getCurrencyOptions } from '@pega/react-sdk-components/lib/components/field/Currency/currency-utils';
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
 
 import './CaseSummaryFields.css';
 
@@ -21,7 +20,10 @@ interface CaseSummaryFieldsProps{
 }
 
 
-export default function CaseSummaryFields(props:CaseSummaryFieldsProps) {
+export default function CaseSummaryFields(props: CaseSummaryFieldsProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const Operator = getComponentFromMap("Operator");
+
   const { status, showStatus, theFields } = props;
 
   const [theFieldsToRender, setFieldsToRender] = useState([]);

package/tests/assets/components/SDK-React/create/override-sdk/designSystemExtension/FieldValueList/FieldValueList.tsx

@@ -9,7 +9,7 @@ import { makeStyles } from '@material-ui/core/styles';
 interface FieldValueListProps{
   // If any, enter additional props that only exist on this component
   name?: string,
-  value: string,
+  value: any,
   variant?: string
 }
 

package/tests/assets/components/SDK-React/create/override-sdk/designSystemExtension/RichTextEditor/RichTextEditor.tsx

@@ -0,0 +1,121 @@
+import React, { forwardRef } from 'react';
+import { Editor } from '@tinymce/tinymce-react';
+import { FormControl, FormHelperText, InputLabel, makeStyles } from '@material-ui/core';
+import { useAfterInitialEffect, useConsolidatedRef, useUID } from '@pega/react-sdk-components/lib/hooks';
+
+const useStyles = makeStyles((theme) => ({
+  fieldLabel: {
+    position: 'relative',
+    transform: 'translate(0, 0px) scale(1)',
+    marginBottom: '5px',
+    color: theme.palette.text.secondary
+  }
+}));
+
+interface RichTextEditorProps {
+  id?: string;
+  defaultValue: string;
+  label: string;
+  labelHidden: boolean;
+  info: string;
+  testId: string;
+  placeholder: string;
+  disabled: boolean;
+  required: boolean;
+  readOnly: boolean;
+  error: boolean;
+  onBlur: React.EventHandler<any>;
+  onChange: React.EventHandler<any>;
+}
+
+const RichTextEditor = forwardRef(function RichTextEditor(props: RichTextEditorProps, ref) {
+  const classes = useStyles();
+  const uid = useUID();
+  const { id = uid, defaultValue, label, labelHidden, info, testId, placeholder, disabled, required, readOnly, error, onBlur, onChange } = props;
+
+  const editorRef: any = useConsolidatedRef(ref);
+  let richTextComponent: any = null;
+
+  useAfterInitialEffect(() => {
+    editorRef?.current.mode.set(readOnly || disabled ? 'readonly' : 'design');
+  }, [readOnly, disabled]);
+
+  const 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()}`;
+        const blobCache = editorRef.current.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();
+  };
+
+  if (readOnly) {
+    const value = defaultValue || '--';
+    // eslint-disable-next-line react/no-danger
+    richTextComponent = <div key={id} id={id} className="readonly-richtext-editor" dangerouslySetInnerHTML={{ __html: value }} />;
+  } else {
+    richTextComponent = (
+      <Editor
+        tinymceScriptSrc="tinymce/tinymce.min.js"
+        onInit={(_evt, editor) => {
+          editorRef.current = editor;
+        }}
+        id={id}
+        initialValue={defaultValue}
+        disabled={disabled}
+        init={{
+          placeholder,
+          menubar: false,
+          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={onBlur}
+        onEditorChange={onChange}
+      />
+    );
+  }
+
+  return (
+    <FormControl data-test-id={testId} error={error} required={required}>
+      {!labelHidden && (
+        <InputLabel id="demo-simple-select-error-label" className={classes.fieldLabel}>
+          {label}
+        </InputLabel>
+      )}
+      {richTextComponent}
+      {info && <FormHelperText>{info}</FormHelperText>}
+    </FormControl>
+  );
+});
+
+export default RichTextEditor;

package/tests/assets/components/SDK-React/create/override-sdk/designSystemExtension/RichTextEditor/index.tsx

@@ -0,0 +1 @@
+export { default } from './RichTextEditor';

package/tests/assets/components/SDK-React/create/override-sdk/field/AutoComplete/AutoComplete.tsx

@@ -1,12 +1,11 @@
 import React, { useEffect, useState } from 'react';
 import { TextField } from '@material-ui/core';
 import Autocomplete from '@material-ui/lab/Autocomplete';
-import Utils from '@pega/react-sdk-components/lib/components/helpers/utils';
-import TextInput from '@pega/react-sdk-components/lib/components/field/TextInput';
 import isDeepEqual from 'fast-deep-equal/react';
+import Utils from '@pega/react-sdk-components/lib/components/helpers/utils';
 import { getDataPage } from '@pega/react-sdk-components/lib/components/helpers/data_page';
 import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-utils';
-import FieldValueList from '@pega/react-sdk-components/lib/components/designSystemExtension/FieldValueList';
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
 import type { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
 
 interface IOption {
@@ -14,18 +13,18 @@ interface IOption {
   value: string;
 }
 
-const preProcessColumns = columnList => {
-  return columnList.map(col => {
+const preProcessColumns = (columnList) => {
+  return columnList.map((col) => {
     const tempColObj = { ...col };
     tempColObj.value = col.value && col.value.startsWith('.') ? col.value.substring(1) : col.value;
     return tempColObj;
   });
 };
 
-const getDisplayFieldsMetaData = columnList => {
-  const displayColumns = columnList.filter(col => col.display === 'true');
+const getDisplayFieldsMetaData = (columnList) => {
+  const displayColumns = columnList.filter((col) => col.display === 'true');
   const metaDataObj: any = { key: '', primary: '', secondary: [] };
-  const keyCol = columnList.filter(col => col.key === 'true');
+  const keyCol = columnList.filter((col) => col.key === 'true');
   metaDataObj.key = keyCol.length > 0 ? keyCol[0].value : 'auto';
   for (let index = 0; index < displayColumns.length; index += 1) {
     if (displayColumns[index].primary === 'true') {
@@ -39,20 +38,23 @@ const getDisplayFieldsMetaData = columnList => {
 
 interface AutoCompleteProps extends PConnFieldProps {
   // If any, enter additional props that only exist on AutoComplete here'
-  displayMode?: string,
-  deferDatasource?: boolean,
-  datasourceMetadata?: any,
-  status?: string,
-  onRecordChange?: any,
-  additionalProps?: object,
-  listType: string,
-  parameters?: any,
-  datasource: any,
-  columns: Array<any>
+  displayMode?: string;
+  deferDatasource?: boolean;
+  datasourceMetadata?: any;
+  status?: string;
+  onRecordChange?: any;
+  additionalProps?: object;
+  listType: string;
+  parameters?: any;
+  datasource: any;
+  columns: Array<any>;
 }
 
+export default function AutoComplete(props: AutoCompleteProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const TextInput = getComponentFromMap('TextInput');
+  const FieldValueList = getComponentFromMap('FieldValueList');
 
-export default function AutoComplete(props:AutoCompleteProps) {
   const {
     getPConnect,
     label,
@@ -90,7 +92,7 @@ export default function AutoComplete(props:AutoCompleteProps) {
 
   const flattenParameters = (params = {}) => {
     const flatParams = {};
-    Object.keys(params).forEach(key => {
+    Object.keys(params).forEach((key) => {
       const { name, value: theVal } = params[key];
       flatParams[name] = theVal;
     });
@@ -137,7 +139,7 @@ export default function AutoComplete(props:AutoCompleteProps) {
       getDataPage(datasource, parameters, context).then((results: any) => {
         const optionsData: Array<any> = [];
         const displayColumn = getDisplayFieldsMetaData(columns);
-        results?.forEach(element => {
+        results?.forEach((element) => {
           const val = element[displayColumn.primary]?.toString();
           const obj = {
             key: element[displayColumn.key] || element.pyGUID,
@@ -155,11 +157,11 @@ export default function AutoComplete(props:AutoCompleteProps) {
   }
 
   if (displayMode === 'STACKED_LARGE_VAL') {
-    return <FieldValueList name={hideLabel ? '' : label} value={value} variant='stacked' />;
+    return <FieldValueList name={hideLabel ? '' : label} value={value} variant="stacked" />;
   }
 
   if (value) {
-    const index = options?.findIndex(element => element.key === value);
+    const index = options?.findIndex((element) => element.key === value);
     if (index > -1) {
       selectedValue = options[index].value;
     } else {
@@ -180,7 +182,7 @@ export default function AutoComplete(props:AutoCompleteProps) {
   };
 
   if (readOnly) {
-    const theValAsString = options?.find(opt => opt.key === value)?.value;
+    const theValAsString = options?.find((opt) => opt.key === value)?.value;
     return <TextInput {...props} value={theValAsString} />;
   }
   // Need to use both getOptionLabel and getOptionSelected to map our
@@ -199,14 +201,14 @@ export default function AutoComplete(props:AutoCompleteProps) {
       value={selectedValue}
       inputValue={inputValue || selectedValue}
       onInputChange={handleInputValue}
-      renderInput={params => (
+      renderInput={(params) => (
         <TextField
           {...params}
           fullWidth
-          variant='outlined'
+          variant="outlined"
           helperText={helperTextToDisplay}
           placeholder={placeholder}
-          size='small'
+          size="small"
           required={required}
           error={status === 'error'}
           label={label}

package/tests/assets/components/SDK-React/create/override-sdk/field/Checkbox/Checkbox.tsx

@@ -7,7 +7,7 @@ import {
   FormHelperText
 } from '@material-ui/core';
 import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-utils';
-import FieldValueList from '@pega/react-sdk-components/lib/components/designSystemExtension/FieldValueList';
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
 // import type { PConnProps } from '../../../types/PConnProps';
 
 // Checkbox passes in 'value' as a boolean. So can't use the default
@@ -36,8 +36,10 @@ import FieldValueList from '@pega/react-sdk-components/lib/components/designSyst
 //   // eslint-disable-next-line react/no-unused-prop-types
 //   placeholder?: string
 // }
-
 export default function CheckboxComponent(props /* : CheckboxProps */) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const FieldValueList = getComponentFromMap('FieldValueList');
+
   const {
     getPConnect,
     label,
@@ -56,9 +58,9 @@ export default function CheckboxComponent(props /* : CheckboxProps */) {
 
   const thePConn = getPConnect();
   const theConfigProps = thePConn.getConfigProps();
-  const caption = theConfigProps["caption"];
+  const caption = theConfigProps['caption'];
   const actionsApi = thePConn.getActionsApi();
-  const propName = thePConn.getStateProps()["value"];
+  const propName = thePConn.getStateProps()['value'];
 
   const [checked, setChecked] = useState(false);
   useEffect(() => {
@@ -71,7 +73,9 @@ export default function CheckboxComponent(props /* : CheckboxProps */) {
   }
 
   if (displayMode === 'STACKED_LARGE_VAL') {
-    return <FieldValueList name={hideLabel ? '' : label} value={value.toString()} variant='stacked' />;
+    return (
+      <FieldValueList name={hideLabel ? '' : label} value={value.toString()} variant='stacked' />
+    );
   }
 
   const handleChange = event => {
@@ -79,7 +83,7 @@ export default function CheckboxComponent(props /* : CheckboxProps */) {
   };
 
   const handleBlur = event => {
-    thePConn.getValidationApi().validate(event.target.checked, "");   // 2nd arg empty string until typedef marked correctly as optional
+    thePConn.getValidationApi().validate(event.target.checked, ''); // 2nd arg empty string until typedef marked correctly as optional
   };
 
   let theCheckbox = <Checkbox color='primary' disabled={disabled} />;

package/tests/assets/components/SDK-React/create/override-sdk/field/Currency/Currency.tsx

@@ -1,21 +1,22 @@
 import React, { useState, useEffect } from 'react';
-// import { TextField } from "@material-ui/core";
 import CurrencyTextField from '@unicef/material-ui-currency-textfield';
 import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-utils';
-import FieldValueList from '@pega/react-sdk-components/lib/components/designSystemExtension/FieldValueList';
-import { format } from "@pega/react-sdk-components/lib/components/helpers/formatters";
+import { format } from '@pega/react-sdk-components/lib/components/helpers/formatters';
 import { getCurrencyCharacters, getCurrencyOptions } from './currency-utils';
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
 import type { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
 
 // Using control from: https://github.com/unicef/material-ui-currency-textfield
 
 interface CurrrencyProps extends PConnFieldProps {
   // If any, enter additional props that only exist on Currency here
-  currencyISOCode?: string
+  currencyISOCode?: string;
 }
 
+export default function Currency(props: CurrrencyProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const FieldValueList = getComponentFromMap('FieldValueList');
 
-export default function Currency(props:CurrrencyProps) {
   const {
     getPConnect,
     label,
@@ -30,7 +31,7 @@ export default function Currency(props:CurrrencyProps) {
     helperText,
     displayMode,
     hideLabel,
-    currencyISOCode = "USD"
+    currencyISOCode = 'USD'
   } = props;
 
   const pConn = getPConnect();
@@ -53,9 +54,9 @@ export default function Currency(props:CurrrencyProps) {
   };
 
   const [currValue, setCurrValue] = useState('');
-  const [theCurrSym, setCurrSym] = useState("$");
-  const [theCurrDec, setCurrDec] = useState(".");
-  const [theCurrSep, setCurrSep] = useState(",");
+  const [theCurrSym, setCurrSym] = useState('$');
+  const [theCurrDec, setCurrDec] = useState('.');
+  const [theCurrSep, setCurrSep] = useState(',');
 
   useEffect(() => {
     // currencySymbols looks like this: { theCurrencySymbol: '$', theDecimalIndicator: '.', theSeparator: ',' }
@@ -78,7 +79,7 @@ export default function Currency(props:CurrrencyProps) {
   }
 
   if (displayMode === 'STACKED_LARGE_VAL') {
-    return <FieldValueList name={hideLabel ? '' : label} value={formattedValue} variant='stacked' />;
+    return <FieldValueList name={hideLabel ? '' : label} value={formattedValue} variant="stacked" />;
   }
 
   // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
@@ -101,8 +102,8 @@ export default function Currency(props:CurrrencyProps) {
       fullWidth
       variant={readOnly ? 'standard' : 'outlined'}
       helperText={helperTextToDisplay}
-      placeholder=''
-      size='small'
+      placeholder=""
+      size="small"
       required={required}
       disabled={disabled}
       onChange={currOnChange}
@@ -110,9 +111,9 @@ export default function Currency(props:CurrrencyProps) {
       error={status === 'error'}
       label={label}
       value={currValue}
-      type='text'
-      outputFormat='number'
-      textAlign='left'
+      type="text"
+      outputFormat="number"
+      textAlign="left"
       InputProps={{ ...readOnlyProp, inputProps: { ...testProp, value: currValue } }}
       currencySymbol={theCurrSym}
       decimalCharacter={theCurrDec}

package/tests/assets/components/SDK-React/create/override-sdk/field/Date/Date.tsx

@@ -1,14 +1,13 @@
 import React from 'react';
 import { KeyboardDatePicker } from '@material-ui/pickers';
-import TextInput from '@pega/react-sdk-components/lib/components/field/TextInput';
 import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-utils';
-import FieldValueList from '@pega/react-sdk-components/lib/components/designSystemExtension/FieldValueList';
 import { format } from '@pega/react-sdk-components/lib/components/helpers/formatters';
-import { dateFormatInfoDefault, getDateFormatInfo} from '@pega/react-sdk-components/lib/components/helpers/date-format-utils';
+import { dateFormatInfoDefault, getDateFormatInfo } from '@pega/react-sdk-components/lib/components/helpers/date-format-utils';
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
 import type { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
 
 // Will return the date string in YYYY-MM-DD format which we'll be POSTing to the server
-function getFormattedDate(date){
+function getFormattedDate(date) {
   return `${date.$y.toString()}-${(date.$M + 1).toString().padStart(2, '0')}-${date.$D.toString().padStart(2, '0')}`;
 }
 
@@ -16,8 +15,11 @@ interface DateProps extends PConnFieldProps {
   // If any, enter additional props that only exist on Date here
 }
 
+export default function Date(props: DateProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const TextInput = getComponentFromMap('TextInput');
+  const FieldValueList = getComponentFromMap('FieldValueList');
 
-export default function Date(props:DateProps) {
   const {
     getPConnect,
     label,
@@ -43,12 +45,11 @@ export default function Date(props:DateProps) {
   // Start with default dateFormatInfo
   const dateFormatInfo = dateFormatInfoDefault;
   // and then update, as needed, based on locale, etc.
-  const theDateFormat = getDateFormatInfo()
+  const theDateFormat = getDateFormatInfo();
   dateFormatInfo.dateFormatString = theDateFormat.dateFormatString;
   dateFormatInfo.dateFormatStringLC = theDateFormat.dateFormatStringLC;
   dateFormatInfo.dateFormatMask = theDateFormat.dateFormatMask;
 
-
   if (displayMode === 'LABELS_LEFT') {
     const formattedDate = format(props.value, 'date', { format: dateFormatInfo.dateFormatString });
     return <FieldValueList name={hideLabel ? '' : label} value={formattedDate} />;
@@ -56,7 +57,7 @@ export default function Date(props:DateProps) {
 
   if (displayMode === 'STACKED_LARGE_VAL') {
     const formattedDate = format(props.value, 'date', { format: dateFormatInfo.dateFormatString });
-    return <FieldValueList name={hideLabel ? '' : label} value={formattedDate} variant='stacked' />;
+    return <FieldValueList name={hideLabel ? '' : label} value={formattedDate} variant="stacked" />;
   }
 
   if (readOnly) {
@@ -70,14 +71,14 @@ export default function Date(props:DateProps) {
     'data-test-id': testId
   };
 
-  const handleChange = date => {
-    if(date && date.isValid()){
+  const handleChange = (date) => {
+    if (date && date.isValid()) {
       onChange({ value: getFormattedDate(date) });
     }
   };
 
-  const handleAccept = date => {
-    if(date && date.isValid()){
+  const handleAccept = (date) => {
+    if (date && date.isValid()) {
       handleEvent(actions, 'changeNblur', propName, getFormattedDate(date));
     }
   };
@@ -85,8 +86,8 @@ export default function Date(props:DateProps) {
   return (
     <KeyboardDatePicker
       disableToolbar
-      variant='inline'
-      inputVariant='outlined'
+      variant="inline"
+      inputVariant="outlined"
       placeholder={dateFormatInfo.dateFormatStringLC}
       format={dateFormatInfo.dateFormatString}
       mask={dateFormatInfo.dateFormatMask}
@@ -96,7 +97,7 @@ export default function Date(props:DateProps) {
       disabled={disabled}
       error={status === 'error'}
       helperText={helperTextToDisplay}
-      size='small'
+      size="small"
       label={label}
       value={value || null}
       onChange={handleChange}