@pega/react-sdk-overrides 0.23.25 → 8.8.20

package/lib/field/RichText/RichText.tsx

@@ -0,0 +1,93 @@
+import React, { useRef } from 'react';
+import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-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';
+
+interface RichTextProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextArea here
+  additionalProps?: object;
+}
+
+export default function RichText(props: RichTextProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const FieldValueList = getComponentFromMap('FieldValueList');
+  const RichTextEditor = getComponentFromMap('RichTextEditor');
+
+  const { getPConnect, value, placeholder, validatemessage, label, hideLabel, helperText, testId, displayMode, additionalProps } = props;
+  const pConn = getPConnect();
+  const editorRef: any = useRef(null);
+
+  let { readOnly, required, disabled } = props;
+  [readOnly, required, disabled] = [readOnly, required, disabled].map((prop) => prop === true || (typeof prop === 'string' && prop === 'true'));
+
+  const helperTextToDisplay = validatemessage || helperText;
+
+  if (displayMode === 'LABELS_LEFT') {
+    return <FieldValueList name={hideLabel ? '' : label} value={value} />;
+  }
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    return <FieldValueList name={hideLabel ? '' : label} value={value} variant="stacked" />;
+  }
+
+  let richTextComponent;
+
+  if (readOnly) {
+    // Rich Text read-only component
+    richTextComponent = (
+      <RichTextEditor
+        {...additionalProps}
+        label={label}
+        labelHidden={hideLabel}
+        defaultValue={value}
+        testId={testId}
+        info={helperTextToDisplay}
+        ref={editorRef}
+        readOnly
+      />
+    );
+  } else {
+    // Rich Text editable component
+    const actionsApi = pConn.getActionsApi();
+    let status = '';
+    if (validatemessage !== '') {
+      status = 'error';
+    }
+    const handleChange = () => {
+      if (status === 'error') {
+        const property = pConn.getStateProps().value;
+        pConn.clearErrorMessages({
+          property
+        });
+      }
+    };
+
+    const handleBlur = () => {
+      if (editorRef.current) {
+        const editorValue = editorRef.current.getContent({ format: 'html' });
+        const property = pConn.getStateProps().value;
+        handleEvent(actionsApi, 'changeNblur', property, editorValue);
+      }
+    };
+
+    richTextComponent = (
+      <RichTextEditor
+        {...additionalProps}
+        label={label}
+        labelHidden={hideLabel}
+        info={helperTextToDisplay}
+        defaultValue={value}
+        placeholder={placeholder}
+        disabled={disabled}
+        required={required}
+        testId={testId}
+        ref={editorRef}
+        error={status === 'error'}
+        onBlur={handleBlur}
+        onChange={handleChange}
+      />
+    );
+  }
+
+  return richTextComponent;
+}

package/lib/field/RichText/index.tsx

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

package/lib/field/ScalarList/ScalarList.tsx

@@ -0,0 +1,64 @@
+/* eslint-disable react/no-array-index-key */
+import React from 'react';
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
+import type { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+
+// ScalarListProps can't extend PConnFieldProps because its 'value' has a different type
+interface ScalarListProps extends PConnProps {
+  // If any, enter additional props that only exist on this component
+  displayInModal: boolean;
+  hideLabel: boolean;
+  value: Array<any>;
+  componentType: string;
+  label: string;
+  displayMode: string;
+}
+
+function CommaSeparatedList(props) {
+  const { items } = props;
+
+  return (
+    <ul style={{ padding: '0', margin: '0' }}>
+      {items.map((value, index) => {
+        return <span key={index}>{value}</span>;
+      })}
+    </ul>
+  );
+}
+
+export default function ScalarList(props: ScalarListProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const FieldValueList = getComponentFromMap('FieldValueList');
+  const { label, getPConnect, componentType, value: scalarValues, displayMode, hideLabel, ...restProps } = props;
+
+  const items = scalarValues?.map((scalarValue) => {
+    return getPConnect().createComponent(
+      {
+        type: componentType,
+        config: {
+          value: scalarValue,
+          displayMode: 'LABELS_LEFT',
+          label,
+          ...restProps,
+          readOnly: 'true'
+        }
+      },
+      null,
+      null,
+      {}
+    ); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional;
+  });
+
+  if (['LABELS_LEFT', 'STACKED_LARGE_VAL', 'DISPLAY_ONLY'].includes(displayMode)) {
+    const displayComp = (
+      <div>
+        <CommaSeparatedList items={items} />
+      </div>
+    );
+    return displayComp;
+  }
+
+  const displayComp = <CommaSeparatedList items={items} />;
+
+  return <FieldValueList name={hideLabel ? '' : label} value={displayComp} variant="stacked" />;
+}

package/lib/field/ScalarList/config-ext.json

@@ -0,0 +1,8 @@
+{
+  "label": "ScalarList",
+  "componentKey": "ScalarList",
+  "name": "ScalarList",
+  "type": "Field",
+  "properties": [
+  ]
+}

package/lib/field/ScalarList/index.tsx

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

package/lib/field/SemanticLink/SemanticLink.tsx

@@ -1,9 +1,9 @@
-import React from "react";
-import PropTypes from "prop-types";
+import React from 'react';
 import Typography from '@material-ui/core/Typography';
 import Grid from '@material-ui/core/Grid';
 import { makeStyles } from '@material-ui/core/styles';
-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';
 
 /* although this is called the SemanticLink component, we are not yet displaying as a
 SemanticLink in SDK and only showing the value as a read only text field. */
@@ -17,7 +17,7 @@ const useStyles = makeStyles((theme) => ({
     marginRight: theme.spacing(1),
     marginLeft: theme.spacing(1),
     marginTop: theme.spacing(1),
-    marginBottom: theme.spacing(1),
+    marginBottom: theme.spacing(1)
   },
   fieldMargin: {
     paddingRight: theme.spacing(1),
@@ -27,7 +27,7 @@ const useStyles = makeStyles((theme) => ({
     marginRight: theme.spacing(1),
     marginLeft: theme.spacing(1),
     marginTop: theme.spacing(1),
-    marginBottom: theme.spacing(1),
+    marginBottom: theme.spacing(1)
   },
   fieldLabel: {
     fontWeight: 400,
@@ -39,37 +39,38 @@ const useStyles = makeStyles((theme) => ({
   }
 }));
 
-export default function SemanticLink(props) {
-  const {
-    text,
-    displayMode,
-    label,
-    hideLabel
-  } = props;
-  const classes = useStyles();
+interface SemanticLinkProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on SemanticLink here
+  // from previous PropTypes
+  text: string;
+}
 
+export default function SemanticLink(props: SemanticLinkProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const FieldValueList = getComponentFromMap('FieldValueList');
 
-  if (displayMode === "LABELS_LEFT" || (!displayMode && label !== undefined)) {
-    const value = text ||  "---";
+  const { text, displayMode, label, hideLabel } = props;
+  const classes = useStyles();
+
+  if (displayMode === 'LABELS_LEFT' || (!displayMode && label !== undefined)) {
+    const value = text || '---';
     return (
-      <Grid container spacing={1} style={{padding: "4px 0px"}}  id="semantic-link-grid">
+      <Grid container spacing={1} style={{ padding: '4px 0px' }} id="semantic-link-grid">
         <Grid item xs={6}>
-          <Typography variant="body2" component="span" className={`${classes.fieldLabel} ${classes.fieldMargin}`}>{label}</Typography>
+          <Typography variant="body2" component="span" className={`${classes.fieldLabel} ${classes.fieldMargin}`}>
+            {label}
+          </Typography>
         </Grid>
         <Grid item xs={6}>
-          <Typography variant="body2" component="span" className={classes.fieldValue}>{value}</Typography>
+          <Typography variant="body2" component="span" className={classes.fieldValue}>
+            {value}
+          </Typography>
         </Grid>
       </Grid>
     );
   }
 
   if (displayMode === 'STACKED_LARGE_VAL') {
-    return <FieldValueList name={hideLabel ? '' : label} value={text} variant='stacked' />;
+    return <FieldValueList name={hideLabel ? '' : label} value={text} variant="stacked" />;
   }
 }
-
-SemanticLink.propTypes = {
-  text: PropTypes.string.isRequired,
-  displayMode: PropTypes.string,
-  label: PropTypes.string,
-};

package/lib/field/SemanticLink/utils.ts

@@ -1,4 +1,5 @@
-declare const PCore;
+// Remove this and use "real" PCore type once .d.ts is fixed (currently shows 2 errors)
+declare const PCore: any;
 
 function getDataReferenceInfo(pConnect, dataRelationshipContext) {
   if (!pConnect) {

package/lib/field/TextArea/TextArea.tsx

@@ -1,8 +1,17 @@
 import React from 'react';
 import { TextField } from '@material-ui/core';
-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 TextAreaProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextArea here
+  fieldMetadata?: any;
+}
+
+export default function TextArea(props: TextAreaProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const FieldValueList = getComponentFromMap('FieldValueList');
 
-export default function TextArea(props) {
   const {
     label,
     required,
@@ -30,7 +39,7 @@ export default function TextArea(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 (readOnly) {
@@ -53,8 +62,8 @@ export default function TextArea(props) {
       fullWidth
       variant={readOnly ? 'standard' : 'outlined'}
       helperText={helperTextToDisplay}
-      placeholder=''
-      size='small'
+      placeholder=""
+      size="small"
       required={required}
       disabled={disabled}
       onChange={onChange}

package/lib/field/TextContent/TextContent.tsx

@@ -1,7 +1,16 @@
 import React from 'react';
 import { Typography } from '@material-ui/core';
+import type { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
 
-export default function TextContent(props) {
+interface TextContentProps extends PConnProps {
+  // If any, enter additional props that only exist on TextContent here
+  content: string,
+  displayAs: 'Paragraph' | 'Heading 1' | 'Heading 2' | 'Heading 3' | 'Heading 4'
+}
+
+
+
+export default function TextContent(props: TextContentProps) {
   type ExpectedDisplayAs = 'Paragraph' | 'Heading 1' | 'Heading 2' | 'Heading 3' | 'Heading 4';
   type ExpectedVariants = 'body1' | 'h1' | 'h2' | 'h3' | 'h4';
 

package/lib/field/TextInput/TextInput.tsx

@@ -1,17 +1,27 @@
-import React from 'react';
+import React, { useState, useEffect } from 'react';
 import { TextField } from '@material-ui/core';
-import FieldValueList from '@pega/react-sdk-components/lib/components/designSystemExtension/FieldValueList';
+import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-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';
+
+interface TextInputProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  fieldMetadata?: any;
+}
+
+export default function TextInput(props: TextInputProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const FieldValueList = getComponentFromMap('FieldValueList');
 
-export default function TextInput(props) {
   const {
+    getPConnect,
     label,
     required,
     disabled,
     value = '',
     validatemessage,
     status,
-    onChange,
-    onBlur,
+    /* onChange, onBlur */
     readOnly,
     testId,
     fieldMetadata,
@@ -19,18 +29,28 @@ export default function TextInput(props) {
     displayMode,
     hideLabel
   } = props;
+
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = pConn.getStateProps().value;
+
   const helperTextToDisplay = validatemessage || helperText;
 
+  const [inputValue, setInputValue] = useState('');
   const maxLength = fieldMetadata?.maxLength;
 
   let readOnlyProp = {}; // Note: empty if NOT ReadOnly
 
+  useEffect(() => {
+    setInputValue(value);
+  }, [value]);
+
   if (displayMode === 'LABELS_LEFT') {
     return <FieldValueList name={hideLabel ? '' : label} value={value} />;
   }
 
   if (displayMode === 'STACKED_LARGE_VAL') {
-    return <FieldValueList name={hideLabel ? '' : label} value={value} variant='stacked' />;
+    return <FieldValueList name={hideLabel ? '' : label} value={value} variant="stacked" />;
   }
 
   if (readOnly) {
@@ -43,20 +63,29 @@ export default function TextInput(props) {
     'data-test-id': testId
   };
 
+  function handleChange(event) {
+    // update internal value
+    setInputValue(event?.target?.value);
+  }
+
+  function handleBlur() {
+    handleEvent(actions, 'changeNblur', propName, inputValue);
+  }
+
   return (
     <TextField
       fullWidth
       variant={readOnly ? 'standard' : 'outlined'}
       helperText={helperTextToDisplay}
-      placeholder=''
-      size='small'
+      placeholder=""
+      size="small"
       required={required}
       disabled={disabled}
-      onChange={onChange}
-      onBlur={!readOnly ? onBlur : undefined}
+      onChange={handleChange}
+      onBlur={!readOnly ? handleBlur : undefined}
       error={status === 'error'}
       label={label}
-      value={value}
+      value={inputValue}
       InputProps={{ ...readOnlyProp, inputProps: { maxLength, ...testProp } }}
     />
   );

package/lib/field/Time/Time.tsx

@@ -1,24 +1,20 @@
 import React from 'react';
 import { KeyboardTimePicker } from '@material-ui/pickers';
-import TextInput from '@pega/react-sdk-components/lib/components/field/TextInput';
-import dayjs from 'dayjs';
 import AccessTimeIcon from '@material-ui/icons/AccessTime';
-import FieldValueList from '@pega/react-sdk-components/lib/components/designSystemExtension/FieldValueList';
+import dayjs from 'dayjs';
+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 TimeProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on Time here
+}
 
-export default function Time(props) {
-  const {
-    label,
-    required,
-    disabled,
-    value,
-    validatemessage,
-    status,
-    onChange,
-    readOnly,
-    helperText,
-    displayMode,
-    hideLabel
-  } = props;
+export default function Time(props: TimeProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const FieldValueList = getComponentFromMap('FieldValueList');
+  const TextInput = getComponentFromMap('TextInput');
+
+  const { label, required, disabled, value = '', validatemessage, status, onChange, readOnly, helperText, displayMode, hideLabel, testId } = props;
   const helperTextToDisplay = validatemessage || helperText;
 
   if (displayMode === 'LABELS_LEFT') {
@@ -26,21 +22,27 @@ export default function Time(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 (readOnly) {
     return <TextInput {...props} />;
   }
 
-  const handleChange = date => {
+  let testProp = {};
+
+  testProp = {
+    'data-test-id': testId
+  };
+
+  const handleChange = (date) => {
     const theValue = date && date.isValid() ? date.format('HH:mm') : null;
     onChange({ value: theValue });
   };
 
   let timeValue: any = null;
   if (value) {
-    const timeArray = value.split(':').map(itm => Number(itm));
+    const timeArray = value.split(':').map((itm) => Number(itm));
     timeValue = dayjs().hour(timeArray[0]).minute(timeArray[1]);
   }
 
@@ -51,9 +53,9 @@ export default function Time(props) {
 
   return (
     <KeyboardTimePicker
-      variant='inline'
-      inputVariant='outlined'
-      placeholder='hh:mm am'
+      variant="inline"
+      inputVariant="outlined"
+      placeholder="hh:mm am"
       keyboardIcon={<AccessTimeIcon />}
       fullWidth
       required={required}
@@ -61,13 +63,14 @@ export default function Time(props) {
       error={status === 'error'}
       helperText={helperTextToDisplay}
       minutesStep={5}
-      size='small'
+      size="small"
       label={label}
       autoOk
-      mask='__:__ _m'
-      format='hh:mm a'
+      mask="__:__ _m"
+      format="hh:mm a"
       value={timeValue}
       onChange={handleChange}
+      InputProps={{ inputProps: { ...testProp } }}
     />
   );
 }

package/lib/field/URL/URL.tsx

@@ -1,12 +1,20 @@
 import React from 'react';
 import { TextField } from '@material-ui/core';
-import TextInput from '@pega/react-sdk-components/lib/components/field/TextInput';
-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 URLComponentProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on URLComponent here
+}
 
 // NOTE: that we had to change the name from URL to URLComponent
 //  Otherwise, we were getting all kinds of weird errors when we
 //  referred to URL as a component.
-export default function URLComponent(props) {
+export default function URLComponent(props: URLComponentProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const FieldValueList = getComponentFromMap('FieldValueList');
+  const TextInput = getComponentFromMap('TextInput');
+
   const {
     label,
     required,
@@ -17,6 +25,7 @@ export default function URLComponent(props) {
     onChange,
     onBlur,
     readOnly,
+    testId,
     helperText,
     displayMode,
     hideLabel
@@ -28,21 +37,27 @@ export default function URLComponent(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 (readOnly) {
     return <TextInput {...props} />;
   }
 
+  let testProp = {};
+
+  testProp = {
+    'data-test-id': testId
+  };
+
   return (
     <TextField
-      type='url'
+      type="url"
       fullWidth
-      variant='outlined'
+      variant="outlined"
       helperText={helperTextToDisplay}
-      placeholder=''
-      size='small'
+      placeholder=""
+      size="small"
       required={required}
       disabled={disabled}
       onChange={onChange}
@@ -50,6 +65,7 @@ export default function URLComponent(props) {
       error={status === 'error'}
       label={label}
       value={value}
+      InputProps={{ inputProps: { ...testProp } }}
     />
   );
 }