@pega/dx-component-builder-sdk 0.23.9 → 0.23.11

package/tests/assets/sdk-r/components/create/override-sdk/field/Percentage/Percentage.tsx

@@ -0,0 +1,92 @@
+import { TextField } from '@material-ui/core';
+import { makeStyles } from '@material-ui/core/styles';
+
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
+import { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+
+// Inspired by https://stackoverflow.com/questions/50823182/material-ui-remove-up-down-arrow-dials-from-textview
+const useStyles = makeStyles((/* theme */) => ({
+  input: {
+    '& input[type=number]': {
+      '-moz-appearance': 'textfield'
+    },
+    '& input[type=number]::-webkit-outer-spin-button': {
+      '-webkit-appearance': 'none',
+      margin: 0
+    },
+    '& input[type=number]::-webkit-inner-spin-button': {
+      '-webkit-appearance': 'none',
+      margin: 0
+    }
+  }
+}));
+
+interface PercentageProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on Percentage here
+}
+
+export default function Percentage(props: PercentageProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const TextInput = getComponentFromMap('TextInput');
+  const FieldValueList = getComponentFromMap('FieldValueList');
+
+  const classes = useStyles();
+
+  const {
+    label,
+    required,
+    disabled,
+    value = '',
+    validatemessage,
+    status,
+    onChange,
+    onBlur,
+    readOnly,
+    testId,
+    helperText,
+    displayMode,
+    hideLabel,
+    placeholder
+  } = props;
+  const helperTextToDisplay = validatemessage || helperText;
+
+  // console.log(`Percentage: label: ${label} 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' />;
+  }
+
+  if (readOnly) {
+    return <TextInput {...props} />;
+  }
+
+  let testProp = {};
+
+  testProp = {
+    'data-test-id': testId
+  };
+
+  return (
+    <TextField
+      className={classes.input}
+      fullWidth
+      variant={readOnly ? 'standard' : 'outlined'}
+      helperText={helperTextToDisplay}
+      placeholder={placeholder ?? ''}
+      size='small'
+      required={required}
+      disabled={disabled}
+      onChange={onChange}
+      onBlur={!readOnly ? onBlur : undefined}
+      error={status === 'error'}
+      label={label}
+      value={value}
+      type='number'
+      inputProps={{ ...testProp }}
+    />
+  );
+}

package/tests/assets/sdk-r/components/create/override-sdk/field/Percentage/config-ext.json

@@ -0,0 +1,9 @@
+{
+    "componentKey": "Percentage",
+    "name": "Percentage",
+    "label": "Percentage",
+    "description": "Percentage",
+    "type": "Field",
+    "subtype": "Decimal-Percentage",
+    "properties": []
+}

package/tests/assets/sdk-r/components/create/override-sdk/field/Percentage/index.tsx

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

package/tests/assets/sdk-r/components/create/override-sdk/field/Phone/Phone.tsx

@@ -0,0 +1,101 @@
+import MuiPhoneNumber from 'material-ui-phone-number';
+
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
+import { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+
+interface PhoneProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on Phone here
+}
+
+export default function Phone(props: PhoneProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const FieldValueList = getComponentFromMap('FieldValueList');
+
+  const {
+    label,
+    required,
+    disabled,
+    value = '',
+    validatemessage,
+    status,
+    onChange,
+    onBlur,
+    readOnly,
+    testId,
+    helperText,
+    displayMode,
+    hideLabel,
+    placeholder
+  } = props;
+  const helperTextToDisplay = validatemessage || helperText;
+
+  let testProp = {};
+
+  testProp = {
+    'data-test-id': testId
+  };
+
+  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' />;
+  }
+
+  if (readOnly) {
+    const disableDropdown = true;
+    return (
+      <div>
+        <MuiPhoneNumber
+          fullWidth
+          helperText={helperTextToDisplay}
+          placeholder={placeholder ?? ''}
+          size='small'
+          required={required}
+          disabled={disabled}
+          onChange={onChange}
+          error={status === 'error'}
+          label={label}
+          value={value}
+          InputProps={{
+            readOnly: true,
+            inputProps: { ...testProp }
+          }}
+          disableDropdown={disableDropdown}
+        />
+      </div>
+    );
+  }
+
+  const handleChange = inputVal => {
+    let phoneValue = inputVal && inputVal.replace(/\D+/g, '');
+    phoneValue = `+${phoneValue}`;
+    onChange({ value: phoneValue });
+  };
+
+  const handleBlur = event => {
+    const phoneValue = event?.target?.value;
+    event.target.value = `+${phoneValue && phoneValue.replace(/\D+/g, '')}`;
+    onBlur(event);
+  };
+
+  return (
+    <MuiPhoneNumber
+      fullWidth
+      variant='outlined'
+      helperText={helperTextToDisplay}
+      placeholder={placeholder ?? ''}
+      size='small'
+      defaultCountry='us'
+      required={required}
+      disabled={disabled}
+      onChange={handleChange}
+      onBlur={!readOnly ? handleBlur : undefined}
+      error={status === 'error'}
+      label={label}
+      value={value}
+      InputProps={{ ...testProp }}
+    />
+  );
+}

package/tests/assets/sdk-r/components/create/override-sdk/field/Phone/index.tsx

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

package/tests/assets/sdk-r/components/create/override-sdk/field/RadioButtons/RadioButtons.tsx

@@ -0,0 +1,116 @@
+import { useState, useEffect } from 'react';
+import { Radio, RadioGroup, FormControl, FormControlLabel, FormLabel, FormHelperText } from '@material-ui/core';
+
+import Utils from '@pega/react-sdk-components/lib/components/helpers/utils';
+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 { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+
+// Can't use RadioButtonProps until getLocaleRuleNameFromKeys is NOT private
+interface RadioButtonsProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on RadioButtons here
+  inline: boolean;
+  fieldMetadata?: any;
+}
+
+export default function RadioButtons(props: RadioButtonsProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const FieldValueList = getComponentFromMap('FieldValueList');
+
+  const {
+    getPConnect,
+    label,
+    value = '',
+    readOnly,
+    validatemessage,
+    helperText,
+    status,
+    required,
+    inline,
+    displayMode,
+    hideLabel,
+    fieldMetadata
+  } = props;
+  const [theSelectedButton, setSelectedButton] = useState(value);
+
+  const thePConn = getPConnect();
+  const theConfigProps = thePConn.getConfigProps();
+  const actionsApi = thePConn.getActionsApi();
+  const propName = (thePConn.getStateProps() as any).value;
+  const helperTextToDisplay = validatemessage || helperText;
+  const className = thePConn.getCaseInfo().getClassName();
+
+  let configProperty = (thePConn.getRawMetadata() as any)?.config?.value || '';
+  configProperty = configProperty.startsWith('@P') ? configProperty.substring(3) : configProperty;
+  configProperty = configProperty.startsWith('.') ? configProperty.substring(1) : configProperty;
+
+  const metaData = Array.isArray(fieldMetadata) ? fieldMetadata.filter(field => field?.classID === className)[0] : fieldMetadata;
+  let displayName = metaData?.datasource?.propertyForDisplayText;
+  displayName = displayName?.slice(displayName.lastIndexOf('.') + 1);
+  const localeContext = metaData?.datasource?.tableType === 'DataPage' ? 'datapage' : 'associated';
+  const localeClass = localeContext === 'datapage' ? '@baseclass' : className;
+  const localeName = localeContext === 'datapage' ? metaData?.datasource?.name : configProperty;
+  const localePath = localeContext === 'datapage' ? displayName : localeName;
+
+  // theOptions will be an array of JSON objects that are literally key/value pairs.
+  //  Ex: [ {key: "Basic", value: "Basic"} ]
+  const theOptions = Utils.getOptionList(theConfigProps, thePConn.getDataObject(''));
+
+  useEffect(() => {
+    // This update theSelectedButton which will update the UI to show the selected button correctly
+    setSelectedButton(value);
+  }, [value]);
+
+  if (displayMode === 'LABELS_LEFT') {
+    return (
+      <FieldValueList
+        name={hideLabel ? '' : label}
+        // @ts-ignore - Property 'getLocaleRuleNameFromKeys' is private and only accessible within class 'C11nEnv'
+        value={thePConn.getLocalizedValue(value, localePath, thePConn.getLocaleRuleNameFromKeys(localeClass, localeContext, localeName))}
+      />
+    );
+  }
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    return (
+      <FieldValueList
+        name={hideLabel ? '' : label}
+        // @ts-ignore - Property 'getLocaleRuleNameFromKeys' is private and only accessible within class 'C11nEnv'
+        value={thePConn.getLocalizedValue(value, localePath, thePConn.getLocaleRuleNameFromKeys(localeClass, localeContext, localeName))}
+        variant='stacked'
+      />
+    );
+  }
+
+  const handleChange = event => {
+    handleEvent(actionsApi, 'changeNblur', propName, event.target.value);
+  };
+
+  const handleBlur = event => {
+    thePConn.getValidationApi().validate(event.target.value, ''); // 2nd arg empty string until typedef marked correctly as optional
+  };
+
+  return (
+    <FormControl error={status === 'error'} required={required}>
+      <FormLabel component='legend'>{label}</FormLabel>
+      <RadioGroup value={theSelectedButton} onChange={handleChange} onBlur={!readOnly ? handleBlur : undefined} row={inline}>
+        {theOptions.map(theOption => {
+          return (
+            <FormControlLabel
+              value={theOption.key}
+              key={theOption.key}
+              label={thePConn.getLocalizedValue(
+                theOption.value,
+                localePath,
+                // @ts-ignore - Property 'getLocaleRuleNameFromKeys' is private and only accessible within class 'C11nEnv'
+                thePConn.getLocaleRuleNameFromKeys(localeClass, localeContext, localeName)
+              )}
+              control={<Radio key={theOption.key} color='primary' disabled={readOnly} />}
+            />
+          );
+        })}
+      </RadioGroup>
+      <FormHelperText>{helperTextToDisplay}</FormHelperText>
+    </FormControl>
+  );
+}

package/tests/assets/sdk-r/components/create/override-sdk/field/RadioButtons/config-ext.json

@@ -0,0 +1,9 @@
+{
+    "componentKey": "RadioButtons",
+    "name": "RadioButtons",
+    "label": "Radio buttons",
+    "description": "Picklist",
+    "type": "Field",
+    "subtype": "Picklist",
+    "properties": []
+}

package/tests/assets/sdk-r/components/create/override-sdk/field/RadioButtons/index.tsx

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

package/tests/assets/sdk-r/components/create/override-sdk/field/RichText/RichText.tsx

@@ -0,0 +1,96 @@
+import { 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 { 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() as any).value;
+        pConn.clearErrorMessages({
+          property,
+          category: '',
+          context: ''
+        });
+      }
+    };
+
+    const handleBlur = () => {
+      if (editorRef.current) {
+        const editorValue = editorRef.current.getContent({ format: 'html' });
+        const property = (pConn.getStateProps() as any).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/tests/assets/sdk-r/components/create/override-sdk/field/RichText/index.tsx

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

package/tests/assets/sdk-r/components/create/override-sdk/field/ScalarList/ScalarList.tsx

@@ -0,0 +1,63 @@
+/* eslint-disable react/no-array-index-key */
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
+import { 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: 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'
+        }
+      },
+      '',
+      '',
+      {}
+    ); // 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)) {
+    return (
+      <div>
+        <CommaSeparatedList items={items} />
+      </div>
+    );
+  }
+
+  const displayComp = <CommaSeparatedList items={items} />;
+
+  return <FieldValueList name={hideLabel ? '' : label} value={displayComp} variant='stacked' />;
+}

package/tests/assets/sdk-r/components/create/override-sdk/field/ScalarList/config-ext.json

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

package/tests/assets/sdk-r/components/create/override-sdk/field/ScalarList/index.tsx

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

package/tests/assets/sdk-r/components/create/override-sdk/field/SemanticLink/SemanticLink.tsx

@@ -0,0 +1,76 @@
+import Typography from '@material-ui/core/Typography';
+import Grid from '@material-ui/core/Grid';
+import { makeStyles } from '@material-ui/core/styles';
+
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
+import { 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. */
+
+const useStyles = makeStyles(theme => ({
+  root: {
+    paddingRight: theme.spacing(1),
+    paddingLeft: theme.spacing(1),
+    paddingTop: theme.spacing(1),
+    paddingBottom: theme.spacing(1),
+    marginRight: theme.spacing(1),
+    marginLeft: theme.spacing(1),
+    marginTop: theme.spacing(1),
+    marginBottom: theme.spacing(1)
+  },
+  fieldMargin: {
+    paddingRight: theme.spacing(1),
+    paddingLeft: theme.spacing(1),
+    paddingTop: theme.spacing(1),
+    paddingBottom: theme.spacing(1),
+    marginRight: theme.spacing(1),
+    marginLeft: theme.spacing(1),
+    marginTop: theme.spacing(1),
+    marginBottom: theme.spacing(1)
+  },
+  fieldLabel: {
+    fontWeight: 400,
+    color: theme.palette.text.secondary
+  },
+  fieldValue: {
+    fontWeight: 400,
+    color: theme.palette.text.primary
+  }
+}));
+
+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');
+
+  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 item xs={6}>
+          <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>
+        </Grid>
+      </Grid>
+    );
+  }
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    return <FieldValueList name={hideLabel ? '' : label} value={text} variant='stacked' />;
+  }
+}

package/tests/assets/sdk-r/components/create/override-sdk/field/SemanticLink/config-ext.json

@@ -0,0 +1,9 @@
+{
+    "label": "SemanticLink",
+    "componentKey": "SemanticLink",
+    "name": "SemanticLink",
+    "description": "SemanticLink",
+    "type": "Field",
+    "subtype": "ACTION",
+    "properties": []
+}

package/tests/assets/sdk-r/components/create/override-sdk/field/SemanticLink/index.tsx

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

package/tests/assets/sdk-r/components/create/override-sdk/field/SemanticLink/utils.ts

@@ -0,0 +1,49 @@
+function getDataReferenceInfo(pConnect, dataRelationshipContext) {
+  if (!pConnect) {
+    throw Error('PConnect parameter is required');
+  }
+
+  let dataContext = '';
+  const payload = {};
+  const pageReference = pConnect.getPageReference();
+  const annotationUtils = PCore.getAnnotationUtils();
+  let fieldMetadata;
+
+  if (pageReference) {
+    /*
+    For page list the page refernce will be something like caseInfo.content.EmployeeRef[1].
+    Need to extract EmployeeRef from caseInfo.content.EmployeeRef[1]
+    */
+    const propertySplit = pageReference.split('.');
+
+    // Regex to match if the property is list type. Eg: EmployeeRef[1]
+    const listPropertyRegex = /([a-z|A-Z]*[[][\d]*)[\]]$/gm;
+    // Regex to match [1] part of the property EmployeeRef[1]
+    const indexRegex = /([[][\d]*[\]])+/gm;
+
+    let contextProperty = dataRelationshipContext !== null ? dataRelationshipContext : propertySplit.pop();
+    const isListProperty = listPropertyRegex.test(contextProperty);
+    contextProperty = isListProperty ? contextProperty.replace(indexRegex, '') : contextProperty;
+    fieldMetadata = pConnect.getFieldMetadata(contextProperty);
+  }
+
+  if (!!fieldMetadata && fieldMetadata.datasource) {
+    const { name, parameters } = fieldMetadata.datasource;
+    dataContext = name;
+    for (const [key, value] of Object.entries(parameters)) {
+      const property =
+        // @ts-ignore - Property 'getLeafPropertyName' is private and only accessible within class 'AnnotationUtils'
+        dataRelationshipContext !== null ? annotationUtils.getPropertyName(value as string) : annotationUtils.getLeafPropertyName(value);
+      payload[key] = pConnect.getValue(`.${property}`);
+    }
+    return { dataContext, dataContextParameters: payload };
+  }
+
+  return {};
+}
+
+function isLinkTextEmpty(text) {
+  return text === '' || text === undefined || text === null;
+}
+
+export default { getDataReferenceInfo, isLinkTextEmpty };