@pega/dx-component-builder-sdk 24.2.14 → 25.1.11

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

@@ -2,7 +2,7 @@ import { useEffect, useState } from 'react';
 import { MuiTelInput } from 'mui-tel-input';
 
 import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
-import { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+import type { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
 import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-utils';
 
 interface PhoneProps extends PConnFieldProps {
@@ -69,9 +69,11 @@ export default function Phone(props: PhoneProps) {
           error={status === 'error'}
           label={label}
           value={value}
-          InputProps={{
-            readOnly: true,
-            inputProps: { ...testProp }
+          slotProps={{
+            input: {
+              readOnly: true,
+              ...testProp
+            }
           }}
           disableDropdown={disableDropdown}
         />
@@ -105,7 +107,7 @@ export default function Phone(props: PhoneProps) {
       error={status === 'error'}
       label={label}
       value={inputValue}
-      InputProps={{ ...testProp }}
+      slotProps={{ input: { ...testProp } }}
     />
   );
 }

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

@@ -4,18 +4,26 @@ import { Radio, RadioGroup, FormControl, FormControlLabel, FormLabel, FormHelper
 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';
+import type { 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;
+  variant?: string;
+  hideFieldLabels?: boolean;
+  additionalProps?: any;
+  imagePosition?: string;
+  imageSize?: string;
+  showImageDescription?: boolean;
+  datasource?: 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 SelectableCard = getComponentFromMap('SelectableCard');
 
   const {
     getPConnect,
@@ -29,7 +37,14 @@ export default function RadioButtons(props: RadioButtonsProps) {
     inline,
     displayMode,
     hideLabel,
-    fieldMetadata
+    fieldMetadata,
+    variant,
+    hideFieldLabels,
+    additionalProps,
+    datasource,
+    imagePosition,
+    imageSize,
+    showImageDescription
   } = props;
   const [theSelectedButton, setSelectedButton] = useState(value);
 
@@ -65,7 +80,6 @@ export default function RadioButtons(props: RadioButtonsProps) {
     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))}
       />
     );
@@ -75,7 +89,6 @@ export default function RadioButtons(props: RadioButtonsProps) {
     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'
       />
@@ -90,6 +103,36 @@ export default function RadioButtons(props: RadioButtonsProps) {
     thePConn.getValidationApi().validate(event.target.value, ''); // 2nd arg empty string until typedef marked correctly as optional
   };
 
+  if (variant === 'card') {
+    const stateProps = thePConn.getStateProps();
+    return (
+      <div>
+        <h4 style={{ marginTop: 0, marginBottom: 0 }}>{label}</h4>
+        <div id='selectable-card' style={{ display: 'grid', gridTemplateColumns: 'repeat(auto-fit, minmax(min(200px, 100%), 1fr))', gap: '1rem' }}>
+          <SelectableCard
+            hideFieldLabels={hideFieldLabels}
+            additionalProps={additionalProps}
+            getPConnect={getPConnect}
+            dataSource={datasource}
+            image={{
+              imagePosition,
+              imageSize,
+              showImageDescription,
+              imageField: stateProps.image?.split('.').pop(),
+              imageDescription: stateProps.imageDescription?.split('.').pop()
+            }}
+            onChange={handleChange}
+            recordKey={stateProps.value?.split('.').pop()}
+            cardLabel={stateProps.primaryField?.split('.').pop()}
+            radioBtnValue={value}
+            type='radio'
+            setIsRadioCardSelected={displayMode !== 'DISPLAY_ONLY' ? setSelectedButton : undefined}
+          />
+        </div>
+      </div>
+    );
+  }
+
   return (
     <FormControl variant='standard' error={status === 'error'} required={required}>
       <FormLabel component='legend'>{label}</FormLabel>
@@ -102,7 +145,6 @@ export default function RadioButtons(props: RadioButtonsProps) {
               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} />}

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

@@ -0,0 +1,79 @@
+.tox .tox-toolbar {
+  background-color: var(--app-background-color) !important;
+}
+
+.tox .tox-toolbar__primary {
+  background-color: var(--app-background-color) !important;
+}
+
+.tox .tox-toolbar__button {
+  color: var(--app-text-color) !important;
+}
+
+.tox .tox-toolbar__button--enabled {
+  background: var(--app-primary-color) !important;
+  color: #fff !important;
+}
+
+.tox .tox-dialog {
+  background-color: var(--modal-top-color) !important;
+  color: var(--app-text-color) !important;
+  border: 1px solid var(--modal-border-color) !important;
+  padding: 20px !important;
+  box-shadow: 0 0 10px 3px var(--modal-box-shadow-color) !important;
+}
+
+.tox .tox-dialog__header {
+  background-color: var(--modal-top-color) !important;
+  color: var(--app-text-color) !important;
+  font-weight: 500;
+  border-bottom: 1px solid var(--modal-border-color);
+}
+
+.tox .tox-dialog__footer {
+  background: transparent !important;
+  border-top: 1px solid var(--modal-border-color);
+}
+
+.tox .tox-dialog-wrap__backdrop {
+  background-color: var(--modal-background-color) !important;
+}
+
+.tox .tox-dialog__body input,
+.tox .tox-dialog__body textarea,
+.tox .tox-dialog__body select {
+  background: initial !important;
+  color: var(--app-text-color) !important;
+  border: 1px solid var(--app-neutral-color) !important;
+  border-radius: 4px !important;
+  padding: 6px 10px !important;
+  font-size: 1em !important;
+  font-family: inherit !important;
+}
+
+.tox .tox-dialog__body button {
+  background: transparent;
+  color: #fff !important;
+  border: none !important;
+  border-radius: 4px !important;
+  padding: 8px 16px !important;
+  font-size: 1em !important;
+  cursor: pointer !important;
+}
+
+.tox .tox-dialog__footer .tox-button {
+  background: var(--app-primary-color) !important;
+  color: #fff !important;
+  border: none !important;
+  border-radius: 4px !important;
+  padding: 8px 16px !important;
+  font-size: 1em !important;
+  cursor: pointer !important;
+}
+
+.tox .tox-dialog__footer .tox-button--secondary {
+  background: var(--app-secondary-color) !important;
+  color: var(--secondary-button-text-color) !important;
+  font-size: 0.875rem !important;
+  cursor: pointer !important;
+}

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

@@ -2,7 +2,9 @@ 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';
+import type { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+
+import './RichText.css';
 
 interface RichTextProps extends PConnFieldProps {
   // If any, enter additional props that only exist on TextArea here

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

@@ -1,6 +1,5 @@
-/* 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';
+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 {
@@ -36,16 +35,15 @@ export default function ScalarList(props: ScalarListProps) {
       {
         type: componentType,
         config: {
-          // @ts-ignore - Type '{ readOnly: true; displayInModal: boolean; value: any; displayMode: string; label: string; }' is not assignable to type 'ComponentMetadataConfig'.
           value: scalarValue,
           displayMode: 'DISPLAY_ONLY',
           label,
           ...restProps,
-          // @ts-ignore - Type 'string' is not assignable to type 'boolean | undefined'.
           readOnly: 'true'
         }
       },
       '',
+      // @ts-expect-error
       '',
       {}
     ); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional;

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

@@ -0,0 +1,175 @@
+import { Radio, Checkbox, FormControlLabel, Card, CardContent, Typography } from '@mui/material';
+import { resolveReferenceFields } from './utils';
+
+export default function SelectableCard(props) {
+  const {
+    getPConnect,
+    type,
+    image: { imagePosition, imageSize, showImageDescription, imageField = '', imageDescription = '' },
+    dataSource,
+    recordKey = '',
+    className,
+    cardLabel,
+    hideFieldLabels = false,
+    readOnly,
+    disabled,
+    readOnlyList = [],
+    displayMode,
+    radioBtnValue,
+    onChange,
+    onBlur,
+    onClick,
+    onKeyDown,
+    additionalProps,
+    testId,
+    setIsRadioCardSelected,
+    showNoValue = false
+  } = props;
+
+  const pConn = getPConnect();
+
+  if (showNoValue) return <Typography>No Value</Typography>;
+
+  const cardDataSource = readOnly || displayMode === 'DISPLAY_ONLY' ? readOnlyList || [] : dataSource?.source;
+  const imageDescriptionKey = showImageDescription ? imageDescription : undefined;
+
+  let radioItemSelected = false;
+
+  return (
+    <>
+      {(cardDataSource || []).map(item => {
+        const resolvedFields = resolveReferenceFields(item, hideFieldLabels, recordKey, pConn);
+
+        const commonProps = {
+          id: item[recordKey],
+          key: item[recordKey],
+          fields: resolvedFields,
+          label: item[cardLabel]
+        };
+
+        const image = item[imageField]
+          ? {
+              src: item[imageField],
+              alt: showImageDescription && imageDescriptionKey ? item[imageDescriptionKey] : '',
+              style: { width: imageSize, objectPosition: imagePosition }
+            }
+          : undefined;
+
+        const cardContent = (
+          <Card className={className} style={{ display: 'flex' }} data-testid={testId}>
+            {image && <img src={image.src} alt={image.alt} style={{ width: '100px' }} />}
+            <CardContent>
+              <Typography variant='body1'>{item[cardLabel]}</Typography>
+              {commonProps.fields.map((field, index) => (
+                <Typography key={index} variant='body2'>
+                  {field.value}
+                </Typography>
+              ))}
+            </CardContent>
+          </Card>
+        );
+
+        if (displayMode === 'DISPLAY_ONLY') {
+          return cardContent;
+        }
+
+        const component = (
+          <div key={item[recordKey]} style={{ paddingTop: '15px' }}>
+            <Card className={className} style={{ display: 'flex', flexDirection: 'column', height: '100%' }} data-testid={testId}>
+              <CardContent
+                style={{
+                  ...((imagePosition === 'inline-start' || imagePosition === 'inline-end') && { display: 'flex', height: '100%' }),
+                  ...(imagePosition === 'inline-end' && { flexDirection: 'row-reverse' })
+                }}
+              >
+                <div
+                  style={{
+                    ...((imagePosition === 'inline-start' || imagePosition === 'inline-end') && { width: '40%' })
+                  }}
+                >
+                  {image && (
+                    <img
+                      src={image.src}
+                      alt={image.alt}
+                      style={{
+                        width: '100%',
+                        backgroundColor: 'transparent',
+                        aspectRatio: '16 / 9',
+                        maxHeight: '100%',
+                        height: '100%',
+                        objectFit: 'contain',
+                        maxWidth: '100%'
+                      }}
+                    />
+                  )}
+                </div>
+                <div
+                  style={{
+                    ...((imagePosition === 'inline-start' || imagePosition === 'inline-end') && { width: '60%' })
+                  }}
+                >
+                  {type === 'radio' ? (
+                    <FormControlLabel
+                      control={
+                        <Radio
+                          value={item[recordKey]}
+                          checked={radioBtnValue === item[recordKey]}
+                          onChange={onChange}
+                          onBlur={onBlur}
+                          onClick={onClick}
+                          onKeyDown={onKeyDown}
+                          disabled={disabled}
+                          {...additionalProps}
+                        />
+                      }
+                      label={<Typography variant='body1'>{item[cardLabel]}</Typography>}
+                    />
+                  ) : (
+                    <FormControlLabel
+                      control={
+                        <Checkbox
+                          id={item[recordKey]}
+                          getPConnect={getPConnect}
+                          checked={readOnlyList.some(data => data[recordKey] === item[recordKey])}
+                          onChange={onChange}
+                          onBlur={onBlur}
+                          onClick={onClick}
+                          onKeyDown={onKeyDown}
+                          disabled={disabled}
+                          {...additionalProps}
+                        />
+                      }
+                      label={<Typography variant='body1'>{item[cardLabel]}</Typography>}
+                    />
+                  )}
+
+                  {commonProps.fields.map((field, index) => (
+                    <div
+                      key={index}
+                      style={{
+                        fontSize: '0.875rem',
+                        ...(field.type !== 'TextArea' && { display: 'grid', gridTemplateColumns: '1fr 1fr' }),
+                        margin: '5px'
+                      }}
+                    >
+                      {field.name && <div>{field.name}</div>}
+                      <div>{field?.value?.props.value}</div>
+                    </div>
+                  ))}
+                </div>
+              </CardContent>
+            </Card>
+          </div>
+        );
+
+        if (type === 'radio' && radioBtnValue === item[recordKey]) {
+          radioItemSelected = true;
+        }
+
+        return component;
+      })}
+
+      {type === 'radio' && setIsRadioCardSelected && setIsRadioCardSelected(radioItemSelected)}
+    </>
+  );
+}

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

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

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

@@ -0,0 +1,223 @@
+import { Link } from '@mui/material';
+
+import { Utils } from '@pega/react-sdk-components/lib/components/helpers/utils';
+
+export const resolveReferencedPConnect = pConnect => {
+  if (!pConnect || !pConnect.meta) return undefined;
+  const type = pConnect?._type ?? undefined;
+  const referencedPConnect = type === 'reference' && pConnect.getReferencedViewPConnect().getPConnect();
+  return referencedPConnect || pConnect;
+};
+
+/**
+ * A helper function to create an object consisting react component as per the type.
+ * This is used by CaseSummary template.
+ * @param {object} pConnectMeta Object containing meta information for the particular field authored
+ * @param {Function} getPConnect PConnect function passed along to other components.
+ * @param {string} displayMode displayMode string contains information about the layout of component in review mode.
+ */
+export function prepareComponentInCaseSummary(pConnectMeta: any, getPConnect: Function) {
+  const { config, children } = pConnectMeta;
+
+  const noValueComponent = <div>No Value</div>;
+  const placeholder = '...';
+  const pConnect = getPConnect();
+
+  const caseSummaryComponentObject: any = {};
+
+  let { type } = pConnectMeta;
+  let showAddressLabel = true;
+
+  if (config && config.value === `@P .${Utils.getMappedKey('pyStatusWork')}`) {
+    config.displayAsStatus = true;
+    type = 'TextInput'; // force the type to be TextInput for status field.
+    // As TextInput is loaded forcefully sometimes, TextInput component might not be available in lazy map.
+    // Load TextInput if it is not available.
+    if (!PCore.getComponentsRegistry().getLazyComponent(type)) {
+      PCore.getAssetLoader().getLoader('component-loader')([type]);
+    }
+  }
+
+  caseSummaryComponentObject.name = pConnect.resolveConfigProps({ label: config.label }).label;
+
+  if (config.inheritedProps) {
+    const labelInInheritedProp = config.inheritedProps.find(inheritedProp => inheritedProp.prop === 'label');
+    if (labelInInheritedProp) {
+      labelInInheritedProp.value = pConnect.resolveConfigProps({ label: labelInInheritedProp.value }).label;
+    }
+  }
+
+  switch (type) {
+    case 'CaseOperator': {
+      if (config.label.includes('Create operator')) {
+        caseSummaryComponentObject.name = pConnect.resolveConfigProps({
+          createLabel: config.createLabel
+        }).createLabel;
+      } else if (config.label.includes('Update operator')) {
+        caseSummaryComponentObject.name = pConnect.resolveConfigProps({
+          updateLabel: config.updateLabel
+        }).updateLabel;
+      } else {
+        caseSummaryComponentObject.name = pConnect.resolveConfigProps({
+          resolveLabel: config.resolveLabel
+        }).resolveLabel;
+      }
+
+      break;
+    }
+    case 'Checkbox': {
+      caseSummaryComponentObject.name = pConnect.resolveConfigProps({
+        label: config.caption
+      }).label;
+
+      break;
+    }
+    case 'Pega_UI_PercentageWidget': {
+      const rawValue = pConnect.resolveConfigProps({
+        value: config.value
+      }).value;
+
+      caseSummaryComponentObject.simpleValue = rawValue || rawValue === 0 ? `${rawValue}%` : noValueComponent;
+      break;
+    }
+    case 'Address': {
+      showAddressLabel = false;
+
+      caseSummaryComponentObject.variant = 'stacked';
+      break;
+    }
+    case 'Location':
+    case 'RichText': {
+      const rawValue = pConnect.resolveConfigProps({
+        value: config.value
+      }).value;
+
+      caseSummaryComponentObject.variant = 'stacked';
+      caseSummaryComponentObject.simpleValue = rawValue?.length ? rawValue : noValueComponent;
+      break;
+    }
+    case 'TextArea': {
+      const rawValue = pConnect.resolveConfigProps({
+        value: config.value
+      }).value;
+
+      if (rawValue?.length > 22) {
+        caseSummaryComponentObject.variant = 'stacked';
+      }
+
+      caseSummaryComponentObject.simpleValue = rawValue?.length ? rawValue : noValueComponent;
+      break;
+    }
+    case 'URL': {
+      if (config.displayAs === 'Image') {
+        const rawValue = pConnect.resolveConfigProps({
+          value: config.value
+        }).value;
+
+        caseSummaryComponentObject.variant = 'stacked';
+        caseSummaryComponentObject.simpleValue = rawValue?.length ? <Link href={rawValue}>{rawValue}</Link> : noValueComponent;
+      }
+      break;
+    }
+    case 'reference': {
+      const referencedPConnect = resolveReferencedPConnect(pConnect);
+      const viewType = referencedPConnect?.meta?.config.type;
+      const viewTemplate = referencedPConnect?.meta?.config.template;
+      const isTable = ['multirecordlist'].includes(viewType);
+      const isDataReference = viewTemplate === 'DataReference';
+
+      if (isTable || !isDataReference) {
+        caseSummaryComponentObject.variant = 'stacked';
+        caseSummaryComponentObject.simpleValue = placeholder;
+      }
+      break;
+    }
+    case 'view': {
+      caseSummaryComponentObject.variant = 'stacked';
+      caseSummaryComponentObject.simpleValue = placeholder;
+      break;
+    }
+    default:
+      break;
+  }
+
+  const createdComponent = pConnect.createComponent({
+    type,
+    children: children ? [...children] : [],
+    showAddressLabel,
+    config: {
+      ...config,
+      // Need a unique key for each summary component which helps in creating new component based on visibility
+      // Also a consistent key helps in rerendering summary components instead of remounting
+      key: config
+    }
+  });
+
+  createdComponent.props.getPConnect().setInheritedProp('displayMode', 'DISPLAY_ONLY');
+  createdComponent.props.getPConnect().setInheritedProp('readOnly', true);
+
+  if (type === 'Address') {
+    createdComponent.props.getPConnect().setInheritedProp('showAddressLabel', showAddressLabel);
+  }
+  // Add field label for reference summary item when not Embedded data
+  if (type === 'reference') {
+    const isEmbeddedData = config.context && config.displayAs === 'Form';
+    if (!isEmbeddedData) {
+      caseSummaryComponentObject.name = createdComponent.props.getPConnect().getInheritedProps().label;
+    }
+  }
+
+  caseSummaryComponentObject.value = createdComponent;
+
+  return caseSummaryComponentObject;
+}
+
+export function resolveReferenceFields(
+  item: {
+    [key: string]: unknown;
+  },
+  hideFieldLabels: boolean,
+  recordKey: string,
+  pConnect: typeof PConnect
+) {
+  const presets: {
+    children?: {
+      children?: {
+        config;
+        type;
+      };
+      config?;
+    };
+  } = (pConnect.getRawMetadata()?.config as any).presets ?? [];
+
+  const presetChildren = presets[0]?.children?.[0]?.children ?? [];
+
+  const maxFields = 5;
+  return presetChildren.slice(0, maxFields).map((preset, index) => {
+    const fieldMeta = {
+      meta: {
+        ...preset,
+        config: {
+          ...preset.config,
+          displayMode: 'DISPLAY_ONLY',
+          contextName: pConnect.getContextName()
+        }
+      },
+      useCustomContext: item
+    };
+    const configObj = PCore.createPConnect(fieldMeta);
+    const meta = configObj.getPConnect().getMetadata();
+    const fieldInfo: {
+      name?: string;
+      value?: React.ReactNode;
+    } = meta ? prepareComponentInCaseSummary(meta, configObj.getPConnect) : {};
+    return hideFieldLabels
+      ? { id: `${item[recordKey]} - ${index}`, value: fieldInfo.value }
+      : {
+          id: `${item[recordKey]} - ${index}`,
+          name: fieldInfo.name,
+          value: fieldInfo.value,
+          type: preset.type
+        };
+  });
+}