@pega/sdk 0.0.1

package/templates/react-sdk-reference/src/components/field/SelectableCard/SelectableCard.tsx

@@ -0,0 +1,189 @@
+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;
+
+  const handleCardClick = event => {
+    if (disabled || readOnly) return;
+    // If the click landed on or inside a label/input, native behavior already handles it.
+    if (event.target.closest?.('label, input')) return;
+    // Find the radio/checkbox input inside this card and click it programmatically.
+    const input = event.currentTarget.querySelector('input[type="radio"], input[type="checkbox"]');
+    if (input) input.click();
+  };
+
+  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%', cursor: disabled || readOnly ? 'default' : 'pointer' }}
+              data-testid={testId}
+              onClick={handleCardClick}
+            >
+              <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 || readOnly}
+                          {...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 || readOnly}
+                          {...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/templates/react-sdk-reference/src/components/field/SelectableCard/index.tsx

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

package/templates/react-sdk-reference/src/components/field/SelectableCard/utils.tsx

@@ -0,0 +1,223 @@
+import { Link } from '@mui/material';
+
+import { Utils } from '../../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
+        };
+  });
+}

package/templates/react-sdk-reference/src/components/field/SemanticLink/SemanticLink.tsx

@@ -0,0 +1,208 @@
+import { Link } from '@mui/material';
+import makeStyles from '@mui/styles/makeStyles';
+
+import type { PConnFieldProps } from '@pega/sdk-react';
+
+import semanticUtils from './utils';
+
+// eslint-disable-next-line
+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
+  text: string;
+  resourcePayload: any;
+  resourceParams: any;
+  previewKey: string | null;
+  onClick: (event: any) => void;
+  testId: string;
+  referenceType: string | null;
+  dataRelationshipContext: string | null;
+  contextPage: any;
+}
+
+export default function SemanticLink(props: SemanticLinkProps) {
+  const {
+    text,
+    resourcePayload = {},
+    resourceParams = {},
+    getPConnect,
+    previewKey,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    onClick,
+    testId = '',
+    referenceType,
+    dataRelationshipContext = null,
+    contextPage,
+    ...restProps
+  } = props;
+  const { ACTION_OPENWORKBYHANDLE, ACTION_SHOWDATA }: any = PCore.getSemanticUrlUtils().getActions();
+  const pConnect = getPConnect();
+  const dataResourcePayLoad = resourcePayload?.resourceType === 'DATA' ? resourcePayload : null;
+
+  const {
+    RESOURCE_TYPES: { DATA },
+    WORKCLASS,
+    CASE_INFO: { CASE_INFO_CLASSID }
+  } = PCore.getConstants();
+
+  let linkURL = '';
+  let payload = {};
+  let dataViewName;
+  let linkComponentProps = {
+    href: linkURL
+  };
+  if (text) {
+    (linkComponentProps as any).href = linkURL;
+  }
+  let isData = false;
+  const shouldTreatAsDataReference = !previewKey && resourcePayload.caseClassName;
+  if (contextPage?.classID) {
+    resourcePayload.caseClassName = contextPage.classID;
+  }
+  /* TODO : In case of duplicate search case the classID is Work- need to set it to
+  the current case class ID */
+  if (resourcePayload.caseClassName === WORKCLASS) {
+    resourcePayload.caseClassName = pConnect.getValue(CASE_INFO_CLASSID);
+  }
+
+  function showDataAction() {
+    if (dataResourcePayLoad && dataResourcePayLoad.resourceType === 'DATA') {
+      const { content } = dataResourcePayLoad;
+      const lookUpDataPageInfo = PCore.getDataTypeUtils().getLookUpDataPageInfo(dataResourcePayLoad?.className);
+      const lookUpDataPage = PCore.getDataTypeUtils().getLookUpDataPage(dataResourcePayLoad?.className);
+      if (lookUpDataPageInfo) {
+        const { parameters }: any = lookUpDataPageInfo;
+        payload = Object.keys(parameters).reduce((acc, param) => {
+          const paramValue = parameters[param];
+          return {
+            ...acc,
+            [param]: PCore.getAnnotationUtils().isProperty(paramValue) ? content[PCore.getAnnotationUtils().getPropertyName(paramValue)] : paramValue
+          };
+        }, {});
+      }
+      getPConnect()
+        .getActionsApi()
+        .showData('pyDetails', lookUpDataPage, {
+          ...payload
+        });
+    }
+    if ((referenceType && referenceType.toUpperCase() === DATA) || shouldTreatAsDataReference) {
+      getPConnect()
+        .getActionsApi()
+        .showData('pyDetails', dataViewName, {
+          ...payload
+        });
+    }
+  }
+
+  function openLinkClick(e) {
+    if (!e.metaKey && !e.ctrlKey) {
+      e.preventDefault();
+      if (
+        (dataResourcePayLoad && dataResourcePayLoad.resourceType === 'DATA') ||
+        (referenceType && referenceType.toUpperCase() === DATA) ||
+        shouldTreatAsDataReference
+      ) {
+        showDataAction();
+      } else if (previewKey) {
+        getPConnect().getActionsApi().openWorkByHandle(previewKey, resourcePayload.caseClassName);
+      }
+    }
+  }
+
+  if ((referenceType && referenceType.toUpperCase() === DATA) || shouldTreatAsDataReference) {
+    try {
+      isData = true;
+      // @ts-expect-error
+      const dataRefContext = semanticUtils.getDataReferenceInfo(pConnect, dataRelationshipContext, contextPage);
+      dataViewName = dataRefContext.dataContext;
+      payload = dataRefContext.dataContextParameters as any;
+    } catch (error) {
+      console.log('Error in getting the data reference info', error);
+    }
+  } else if (resourcePayload && resourcePayload.resourceType === 'DATA') {
+    isData = true;
+    dataViewName = PCore.getDataTypeUtils().getLookUpDataPage(resourcePayload.className);
+    const lookUpDataPageInfo = PCore.getDataTypeUtils().getLookUpDataPageInfo(resourcePayload.className);
+    const { content } = resourcePayload;
+    if (lookUpDataPageInfo) {
+      const { parameters }: any = lookUpDataPageInfo;
+      payload = Object.keys(parameters).reduce((acc, param) => {
+        const paramValue = parameters[param];
+        return {
+          ...acc,
+          [param]: PCore.getAnnotationUtils().isProperty(paramValue) ? content[PCore.getAnnotationUtils().getPropertyName(paramValue)] : paramValue
+        };
+      }, {});
+    } else {
+      const keysInfo = PCore.getDataTypeUtils().getDataPageKeys(dataViewName) ?? [];
+      payload = keysInfo.reduce((acc, curr) => {
+        return {
+          ...acc,
+          [curr.keyName]: content[curr.isAlternateKeyStorage ? curr.linkedField : curr.keyName]
+        };
+      }, {});
+    }
+  }
+
+  if (isData && dataViewName && payload) {
+    linkURL = PCore.getSemanticUrlUtils().getResolvedSemanticURL(
+      ACTION_SHOWDATA,
+      { pageName: 'pyDetails', dataViewName },
+      {
+        ...payload
+      }
+    );
+  } else {
+    // BUG-678282 fix to handle scenario when workID was not populated.
+    // Check renderParentLink in Caseview / CasePreview
+    resourceParams.objectID = resourceParams.workID === '' && typeof previewKey === 'string' ? previewKey.split(' ')[1] : resourceParams.workID;
+    if (previewKey) {
+      resourceParams.id = previewKey;
+    }
+    linkURL = PCore.getSemanticUrlUtils().getResolvedSemanticURL(ACTION_OPENWORKBYHANDLE, resourcePayload, resourceParams);
+  }
+
+  if (text) {
+    linkComponentProps = {
+      ...linkComponentProps,
+      href: linkURL
+    };
+  }
+
+  return (
+    <Link component='button' {...linkComponentProps} {...restProps} onClick={openLinkClick} data-testid={testId}>
+      {text || '--'}
+    </Link>
+  );
+}

package/templates/react-sdk-reference/src/components/field/SemanticLink/config-ext.json

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

package/templates/react-sdk-reference/src/components/field/SemanticLink/index.tsx

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

package/templates/react-sdk-reference/src/components/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-expect-error - 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 };