@pega/react-sdk-overrides 8.23.11 → 23.1.10

package/lib/designSystemExtension/AlertBanner/AlertBanner.tsx

@@ -1,7 +1,18 @@
 import React from 'react';
-import PropTypes from 'prop-types';
 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',
@@ -9,7 +20,7 @@ const SEVERITY_MAP = {
   info: 'info'
 };
 
-export default function AlertBanner(props) {
+export default function AlertBanner(props:AlertBannerProps) {
   const { id, variant, messages, onDismiss } = props;
   let additionalProps = {};
 
@@ -34,10 +45,3 @@ export default function AlertBanner(props) {
     </div>
   );
 }
-
-AlertBanner.propTypes = {
-  id: PropTypes.string,
-  variant: PropTypes.string,
-  messages: PropTypes.arrayOf(PropTypes.string),
-  onDismiss: PropTypes.any
-};

package/lib/designSystemExtension/Banner/Banner.tsx

@@ -2,7 +2,18 @@ import React from 'react';
 import Grid from '@material-ui/core/Grid';
 import './Banner.css';
 
-export default function Banner(props) {
+// AlertBanner is one of the few components that does NOT have getPConnect.
+//  So, no need to extend PConnProps
+
+interface BannerProps {
+  // If any, enter additional props that only exist on this component
+  a: any,
+  b: any,
+  banner: { variant: any, backgroundColor: any, title: any, message: any, backgroundImage: any, tintImage: any },
+  variant: any
+}
+
+export default function Banner(props:BannerProps) {
   const { a, b, banner, variant} = props;
   const { title, message, backgroundImage } = banner;
   const variantMap = {

package/lib/designSystemExtension/CaseSummaryFields/CaseSummaryFields.tsx

@@ -1,18 +1,29 @@
 import React, { useState, useEffect } from 'react';
-import PropTypes from 'prop-types';
 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';
 
 import { format } from '@pega/react-sdk-components/lib/components/helpers/formatters';
 
-export default function CaseSummaryFields(props) {
+// CaseSummaryFields is one of the few components that does NOT have getPConnect.
+//  So, no need to extend PConnProps
+interface CaseSummaryFieldsProps{
+  // If any, enter additional props that only exist on this component
+  status?: string,
+  showStatus?: boolean,
+  theFields: Array<any> | any | never
+}
+
+
+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([]);
@@ -227,9 +238,3 @@ export default function CaseSummaryFields(props) {
     </React.Fragment>
   );
 }
-
-CaseSummaryFields.propTypes = {
-  status: PropTypes.string,
-  showStatus: PropTypes.bool,
-  theFields: PropTypes.arrayOf(PropTypes.object)
-};

package/lib/designSystemExtension/DetailsFields/DetailsFields.tsx

@@ -1,6 +1,5 @@
 /* eslint-disable react/no-array-index-key */
 import React, { createElement, isValidElement } from 'react';
-import PropTypes from 'prop-types';
 import Grid from '@material-ui/core/Grid';
 import Typography from '@material-ui/core/Typography';
 import { makeStyles } from '@material-ui/core/styles';
@@ -9,6 +8,14 @@ import createPConnectComponent from '@pega/react-sdk-components/lib/bridge/react
 
 import { format } from '@pega/react-sdk-components/lib/components/helpers/formatters';
 
+// DetailsFields is one of the few components that does NOT have getPConnect.
+//  So, no need to extend PConnProps
+interface DetailsFieldsProps{
+  // If any, enter additional props that only exist on this component
+  fields: Array<any>
+}
+
+
 const useStyles = makeStyles(theme => ({
   root: {
     paddingRight: theme.spacing(1),
@@ -31,9 +38,9 @@ const useStyles = makeStyles(theme => ({
   }
 }));
 
-export default function DetailsFields(props) {
+export default function DetailsFields(props: DetailsFieldsProps) {
   // const componentName = "DetailsFields";
-  const { fields } = props;
+  const { fields = [] } = props;
   const classes = useStyles();
   const fieldComponents: Array<any> = [];
 
@@ -138,11 +145,3 @@ export default function DetailsFields(props) {
 
   return <React.Fragment>{getGridItems()}</React.Fragment>;
 }
-
-DetailsFields.defaultProps = {
-  fields: []
-};
-
-DetailsFields.propTypes = {
-  fields: PropTypes.arrayOf(PropTypes.any)
-};

package/lib/designSystemExtension/FieldGroup/FieldGroup.tsx

@@ -2,6 +2,15 @@ import React from 'react';
 import Grid from '@material-ui/core/Grid';
 import { makeStyles } from '@material-ui/core/styles';
 
+// FieldGroupProps is one of the few components that does NOT have getPConnect.
+//  So, no need to extend PConnProps
+interface FieldGroupProps {
+  // If any, enter additional props that only exist on this component
+  children: Array<any> | any,
+  name: string | object,
+}
+
+
 const useStyles = makeStyles(theme => ({
   root: {
     marginRight: theme.spacing(1),
@@ -19,7 +28,7 @@ const useStyles = makeStyles(theme => ({
   }
 }));
 
-const FieldGroup = props => {
+export default function FieldGroup(props: FieldGroupProps) {
   const { children, name } = props;
   const classes = useStyles();
 
@@ -44,5 +53,3 @@ const FieldGroup = props => {
     </React.Fragment>
   );
 };
-
-export default FieldGroup;

package/lib/designSystemExtension/FieldGroupList/FieldGroupList.tsx

@@ -6,7 +6,17 @@ import Link from '@material-ui/core/Link';
 
 import { Utils } from '@pega/react-sdk-components/lib/components/helpers/utils';
 
-const FieldGroupList = props => {
+// FieldGroupList is one of the few components that does NOT have getPConnect.
+//  So, no need to extend PConnProps
+interface FieldGroupListProps {
+  // If any, enter additional props that only exist on this component
+  items: Array<any> | any,
+  onDelete: any,
+  onAdd: any
+}
+
+
+export default function FieldGroupList(props: FieldGroupListProps) {
   let menuIconOverride$ = 'trash';
   if (menuIconOverride$) {
     menuIconOverride$ = Utils.getImageSrc(
@@ -51,5 +61,3 @@ const FieldGroupList = props => {
     </Grid>
   );
 };
-
-export default FieldGroupList;

package/lib/designSystemExtension/FieldValueList/FieldValueList.tsx

@@ -4,6 +4,16 @@ import Grid from '@material-ui/core/Grid';
 import Typography from '@material-ui/core/Typography';
 import { makeStyles } from '@material-ui/core/styles';
 
+// FieldValueList is one of the few components that does NOT have getPConnect.
+//  So, no need to extend PConnProps
+interface FieldValueListProps{
+  // If any, enter additional props that only exist on this component
+  name?: string,
+  value: any,
+  variant?: string
+}
+
+
 const useStyles = makeStyles(theme => ({
   root: {
     marginRight: theme.spacing(1),
@@ -37,7 +47,7 @@ function formatItemValue(value) {
   return formattedVal;
 }
 
-const FieldValueList = props => {
+export default function FieldValueList(props: FieldValueListProps) {
   const { name, value, variant = 'inline' } = props;
   const classes = useStyles();
 
@@ -84,5 +94,3 @@ const FieldValueList = props => {
     </React.Fragment>
   );
 };
-
-export default FieldValueList;

package/lib/designSystemExtension/Operator/Operator.tsx

@@ -1,5 +1,4 @@
 import React, {useState} from "react";
-import PropTypes from "prop-types";
 import TextField from '@material-ui/core/TextField';
 import Popover from '@material-ui/core/Popover';
 import Grid from '@material-ui/core/Grid';
@@ -9,9 +8,21 @@ import { makeStyles } from '@material-ui/core/styles';
 
 import Utils from '@pega/react-sdk-components/lib/components/helpers/utils';
 
-import PCoreType from '@pega/pcore-pconnect-typedefs/types/pcore';
+// Operator is one of the few components that does NOT have getPConnect.
+//  So, no need to extend PConnProps
+interface OperatorProps{
+  // If any, enter additional props that only exist on this component
+  caseOpConfig: {
+    label: string,
+    createDateTime: string,
+    createLabel: string,
+    createOperator: { userName: string, userId: string },
+    updateDateTime: string,
+    updateLabel: string,
+    updateOperator: { userName: string, userId: string }
+  }
+}
 
-declare const PCore: typeof PCoreType;
 
 
 const useStyles = makeStyles((theme) => ({
@@ -25,7 +36,7 @@ const useStyles = makeStyles((theme) => ({
   }
 }));
 
-export default function Operator(props) {
+export default function Operator(props: OperatorProps) {
   // const componentName = "Operator";
   const { caseOpConfig } = props;
   const classes = useStyles();
@@ -34,7 +45,7 @@ export default function Operator(props) {
   let caseOpLabel = "---";
   let caseOpName = "---";
   let caseOpId = "";
-  let caseTime = null;
+  let caseTime = "";
 
   if (fieldLabel === "create operator") {
     caseOpLabel = caseOpConfig.createLabel;
@@ -192,10 +203,3 @@ export default function Operator(props) {
     </React.Fragment>;
 
 }
-
-Operator.defaultProps = {
-}
-
-Operator.propTypes = {
-  caseOpConfig: PropTypes.object.isRequired,
-};

package/lib/designSystemExtension/Pulse/Pulse.tsx

@@ -1,8 +1,15 @@
 import React from "react";
-// import PropTypes from "prop-types";
 import { Card, CardContent, CardHeader, Typography } from "@material-ui/core";
 import { makeStyles } from '@material-ui/core/styles';
 
+// Pulse is one of the few components that does NOT have getPConnect.
+//  So, no need to extend PConnProps
+interface PulseProps {
+  // If any, enter additional props that only exist on this component
+  children?: Array<any>
+}
+
+
 const useStyles = makeStyles((theme) => ({
   root: {
     marginTop: theme.spacing(1),
@@ -12,8 +19,9 @@ const useStyles = makeStyles((theme) => ({
   },
 }));
 
-export default function Pulse(/* props */) {
-  // const { children } = props;
+export default function Pulse(props: PulseProps) {
+  // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
+  const { children } = props;
   const classes = useStyles();
 
   return (
@@ -25,7 +33,3 @@ export default function Pulse(/* props */) {
       </Card>
     );
 }
-
-// Pulse.propTypes = {
-//   children: PropTypes.arrayOf(PropTypes.node).isRequired
-// };

package/lib/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/lib/designSystemExtension/RichTextEditor/index.tsx

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

package/lib/designSystemExtension/WssQuickCreate/WssQuickCreate.tsx

@@ -2,7 +2,16 @@ import React from 'react';
 import { Button } from '@material-ui/core';
 import './WssQuickCreate.css';
 
-export default function WssQuickCreate(props) {
+// WssQuickCreate is one of the few components that does NOT have getPConnect.
+//  So, no need to extend PConnProps
+interface WssQuickCreateProps {
+  // If any, enter additional props that only exist on this component
+  heading: string,
+  actions?: Array<any>
+}
+
+
+export default function WssQuickCreate(props: WssQuickCreateProps) {
   const { heading, actions } = props;
 
   return (

package/lib/field/AutoComplete/AutoComplete.tsx

@@ -1,30 +1,30 @@
 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 {
   key: string;
   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') {
@@ -36,7 +36,25 @@ const getDisplayFieldsMetaData = columnList => {
   return metaDataObj;
 };
 
-export default function AutoComplete(props) {
+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>;
+}
+
+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');
+
   const {
     getPConnect,
     label,
@@ -54,6 +72,7 @@ export default function AutoComplete(props) {
     hideLabel,
     onRecordChange
   } = props;
+
   const context = getPConnect().getContextName();
   let { listType, parameters, datasource = [], columns = [] } = props;
   const [inputValue, setInputValue] = useState('');
@@ -64,7 +83,7 @@ export default function AutoComplete(props) {
 
   const thePConn = getPConnect();
   const actionsApi = thePConn.getActionsApi();
-  const propName = thePConn.getStateProps().value;
+  const propName = thePConn.getStateProps()["value"];
 
   if (!isDeepEqual(datasource, theDatasource)) {
     // inbound datasource is different, so update theDatasource (to trigger useEffect)
@@ -73,7 +92,7 @@ export default function AutoComplete(props) {
 
   const flattenParameters = (params = {}) => {
     const flatParams = {};
-    Object.keys(params).forEach(key => {
+    Object.keys(params).forEach((key) => {
       const { name, value: theVal } = params[key];
       flatParams[name] = theVal;
     });
@@ -111,7 +130,7 @@ export default function AutoComplete(props) {
 
   useEffect(() => {
     if (listType === 'associated') {
-      setOptions(Utils.getOptionList(props, getPConnect().getDataObject()));
+      setOptions(Utils.getOptionList(props, getPConnect().getDataObject('')));
     }
   }, [theDatasource]);
 
@@ -120,7 +139,7 @@ export default function AutoComplete(props) {
       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,
@@ -138,11 +157,11 @@ export default function AutoComplete(props) {
   }
 
   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 {
@@ -163,7 +182,7 @@ export default function AutoComplete(props) {
   };
 
   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
@@ -182,14 +201,14 @@ export default function AutoComplete(props) {
       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/lib/field/CancelAlert/CancelAlert.tsx

@@ -1,14 +1,21 @@
 import React, { useState } from 'react';
 import { Button, Grid, IconButton, Snackbar } from '@material-ui/core';
 import CloseIcon from '@material-ui/icons/Close';
-
+import type { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
 import './CancelAlert.css';
 
 // Remove this and use "real" PCore type once .d.ts is fixed (currently shows 2 errors)
 declare const PCore: any;
 
 
-const CancelAlert = props => {
+interface CancelAlertProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on CancelAlert here
+  pConn: any,
+  updateAlertState: any
+}
+
+
+export default function CancelAlert(props: CancelAlertProps) {
   const { pConn, updateAlertState } = props;
   const [showSnackbar, setShowSnackbar] = useState(false);
   const [snackbarMessage, setSnackbarMessage] = useState('');
@@ -126,5 +133,3 @@ const CancelAlert = props => {
     </>
   );
 };
-
-export default CancelAlert;