@pega/react-sdk-overrides 24.2.11 → 25.1.11

package/lib/field/Integer/Integer.tsx

@@ -3,7 +3,7 @@ import { TextField } from '@mui/material';
 
 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';
 
 interface IntegerProps extends PConnFieldProps {
   // If any, enter additional props that only exist on Integer here
@@ -54,11 +54,7 @@ export default function Integer(props: IntegerProps) {
     return <TextInput {...props} />;
   }
 
-  let testProp = {};
-
-  testProp = {
-    'data-test-id': testId
-  };
+  const testProps: any = { 'data-test-id': testId };
 
   function intOnChange(event) {
     // console.log(`Integer intOnChange inValue: ${event.target.value}`);
@@ -96,7 +92,9 @@ export default function Integer(props: IntegerProps) {
       label={label}
       value={inputValue}
       type='text'
-      inputProps={{ inputMode: 'numeric', pattern: '[0-9]*', ...testProp }}
+      slotProps={{
+        htmlInput: { inputMode: 'numeric', pattern: '[0-9]*', ...testProps }
+      }}
     />
   );
 }

package/lib/field/Location/Location.css

@@ -0,0 +1,4 @@
+/* Support for google map autocomplete */
+.pac-container {
+  z-index: 2147483647;
+}

package/lib/field/Location/Location.tsx

@@ -0,0 +1,258 @@
+import { useEffect, useState, useCallback, useRef } from 'react';
+import { Box, TextField, Alert } from '@mui/material';
+import AddLocationAltIcon from '@mui/icons-material/AddLocationAlt';
+import InputAdornment from '@mui/material/InputAdornment';
+import IconButton from '@mui/material/IconButton';
+import { GoogleMap, Marker, useLoadScript } from '@react-google-maps/api';
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
+import type { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-utils';
+
+import './Location.css';
+
+interface LocationProps extends PConnFieldProps {
+  coordinates?: string;
+  onlyCoordinates?: boolean;
+  showMap?: boolean;
+  showMapReadOnly?: boolean;
+}
+
+const mapContainerStyle = {
+  width: '100%',
+  height: '300px',
+  marginTop: '0px'
+};
+
+const defaultCenter = {
+  lat: 18.5204,
+  lng: 73.8567
+};
+
+const disabledMapOptions = {
+  gestureHandling: 'none',
+  keyboardShortcuts: false,
+  disableDefaultUI: true,
+  clickableIcons: false,
+  zoomControl: false,
+  mapTypeControl: false,
+  scaleControl: false,
+  streetViewControl: false,
+  rotateControl: false,
+  fullscreenControl: false
+};
+
+export default function Location(props: LocationProps) {
+  const TextInput = getComponentFromMap('TextInput');
+  const FieldValueList = getComponentFromMap('FieldValueList');
+
+  const {
+    getPConnect,
+    label,
+    required = false,
+    disabled = false,
+    value = '',
+    validatemessage,
+    status,
+    readOnly = false,
+    testId,
+    displayMode,
+    hideLabel = false,
+    placeholder,
+    helperText,
+    coordinates = '',
+    onlyCoordinates = false,
+    showMap,
+    showMapReadOnly
+  } = props;
+
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = (pConn.getStateProps() as any).value;
+  const coordPropName = (pConn.getStateProps() as any).coordinates;
+
+  const [inputValue, setInputValue] = useState<string>(value ?? '');
+  const [mapCenter, setMapCenter] = useState(defaultCenter);
+  const [markerPosition, setMarkerPosition] = useState<google.maps.LatLngLiteral | null>(null);
+
+  const inputRef = useRef<HTMLInputElement | null>(null);
+  const autocompleteRef = useRef<google.maps.places.Autocomplete | null>(null);
+
+  const { isLoaded } = useLoadScript({
+    googleMapsApiKey: pConn.getGoogleMapsAPIKey?.() || '',
+    libraries: ['places', 'geocoding']
+  });
+
+  const hasError = status === 'error' && !!validatemessage && !disabled;
+
+  useEffect(() => {
+    if (onlyCoordinates && coordinates) {
+      setInputValue(coordinates);
+    } else {
+      setInputValue(value ?? '');
+    }
+    if (coordinates) {
+      const [lat, lng] = coordinates.split(',').map(parseFloat);
+
+      if (!isNaN(lat) && !isNaN(lng)) {
+        setMapCenter({ lat, lng });
+        setMarkerPosition({ lat, lng });
+      }
+    }
+  }, [value, coordinates, onlyCoordinates]);
+
+  const handleChange = useCallback(
+    (event: React.ChangeEvent<HTMLInputElement>) => {
+      const newValue = event.target.value ?? '';
+      setInputValue(newValue);
+      handleEvent(actions, 'changeNblur', propName, newValue);
+
+      if (newValue === '' && coordPropName) {
+        actions.updateFieldValue(coordPropName, '');
+        setMarkerPosition(null);
+      }
+    },
+    [actions, propName, coordPropName]
+  );
+
+  const handlePlaceChanged = useCallback(() => {
+    if (autocompleteRef.current) {
+      const place = autocompleteRef.current.getPlace();
+      if (place.geometry?.location) {
+        const lat = place.geometry.location.lat();
+        const lng = place.geometry.location.lng();
+        const address = place.formatted_address || place.name || '';
+        const coordinateString = `${lat}, ${lng}`;
+
+        setMapCenter({ lat, lng });
+        setMarkerPosition({ lat, lng });
+
+        if (onlyCoordinates) {
+          setInputValue(coordinateString);
+          handleEvent(actions, 'changeNblur', propName, coordinateString);
+          if (coordPropName) {
+            actions.updateFieldValue(coordPropName, coordinateString);
+          }
+        } else {
+          setInputValue(address);
+          handleEvent(actions, 'changeNblur', propName, address);
+          if (coordPropName) {
+            actions.updateFieldValue(coordPropName, coordinateString);
+          }
+        }
+      }
+    }
+  }, [actions, propName, coordPropName, onlyCoordinates]);
+
+  useEffect(() => {
+    if (isLoaded && inputRef.current && !autocompleteRef.current) {
+      autocompleteRef.current = new google.maps.places.Autocomplete(inputRef.current);
+      autocompleteRef.current.addListener('place_changed', handlePlaceChanged);
+    }
+  }, [isLoaded, handlePlaceChanged]);
+
+  const handleGetCurrentLocation = useCallback(() => {
+    if (navigator.geolocation) {
+      navigator.geolocation.getCurrentPosition(
+        position => {
+          const lat = position.coords.latitude;
+          const lng = position.coords.longitude;
+          const coordinateString = `${lat}, ${lng}`;
+
+          setMapCenter({ lat, lng });
+          setMarkerPosition({ lat, lng });
+
+          if (onlyCoordinates) {
+            setInputValue(coordinateString);
+            handleEvent(actions, 'changeNblur', propName, coordinateString);
+            if (coordPropName) {
+              actions.updateFieldValue(coordPropName, coordinateString);
+            }
+          } else {
+            const geocoder = new window.google.maps.Geocoder();
+            geocoder.geocode({ location: { lat, lng } }, (results, responseStatus) => {
+              if (responseStatus === 'OK' && results && results[0]) {
+                const address = results[0].formatted_address;
+                setInputValue(address);
+                handleEvent(actions, 'changeNblur', propName, address);
+                if (coordPropName) {
+                  actions.updateFieldValue(coordPropName, coordinateString);
+                }
+              }
+            });
+          }
+        },
+        error => {
+          console.error('Error getting current location: ', error);
+        }
+      );
+    }
+  }, [actions, propName, coordPropName, onlyCoordinates]);
+
+  if (displayMode === 'DISPLAY_ONLY') {
+    return <FieldValueList name={hideLabel ? '' : label} value={value} />;
+  }
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    return <FieldValueList name={hideLabel ? '' : label} value={value} variant='stacked' />;
+  }
+
+  const map = (
+    <div style={{ opacity: disabled ? 0.7 : 1 }}>
+      <Box mt={1} style={{ flex: 1 }}>
+        <GoogleMap mapContainerStyle={mapContainerStyle} center={mapCenter} zoom={14} options={disabled ? disabledMapOptions : undefined}>
+          {markerPosition && <Marker position={markerPosition} />}
+        </GoogleMap>
+      </Box>
+    </div>
+  );
+
+  if (readOnly) {
+    return (
+      <div>
+        <TextInput {...props} />
+        {isLoaded && showMapReadOnly && map}
+      </div>
+    );
+  }
+
+  const testProps: any = { 'data-test-id': testId };
+
+  return (
+    <div>
+      {hasError && (
+        <Alert severity='error' sx={{ mb: 1 }}>
+          {validatemessage}
+        </Alert>
+      )}
+
+      {isLoaded && (
+        <TextField
+          fullWidth
+          label={hideLabel ? '' : label}
+          required={required}
+          disabled={disabled}
+          error={hasError}
+          placeholder={placeholder ?? 'Search location'}
+          helperText={helperText}
+          value={inputValue}
+          onChange={handleChange}
+          inputRef={inputRef}
+          slotProps={{
+            input: {
+              endAdornment: (
+                <InputAdornment position='end'>
+                  <IconButton onClick={handleGetCurrentLocation} disabled={disabled} edge='end'>
+                    <AddLocationAltIcon />
+                  </IconButton>
+                </InputAdornment>
+              ),
+              inputProps: { ...testProps }
+            }
+          }}
+        />
+      )}
+
+      {isLoaded && showMap && map}
+    </div>
+  );
+}

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

@@ -0,0 +1,8 @@
+{
+  "name": "Location",
+  "description": "Location input field with optional coordinates",
+  "type": "Field",
+  "subtype": "Text-Location",
+  "icon": "images/pz-text-input-active.svg",
+  "properties": []
+}

package/lib/field/Location/index.tsx

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

package/lib/field/Multiselect/utils.ts

@@ -1,6 +1,6 @@
 import { useRef } from 'react';
 import equal from 'fast-deep-equal';
-import cloneDeep from 'lodash/cloneDeep';
+import cloneDeep from 'lodash.clonedeep';
 import { updateNewInstuctions, insertInstruction, deleteInstruction } from '@pega/react-sdk-components/lib/components/helpers/instructions-utils';
 
 export const setVisibilityForList = (c11nEnv, visibility) => {

package/lib/field/ObjectReference/ObjectReference.tsx

@@ -0,0 +1,235 @@
+import { useMemo } from 'react';
+
+import Grid2 from '@mui/material/Grid2';
+
+import { SELECTION_MODE, generateColumns, getDataRelationshipContextFromKey } from './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 ObjectReferenceProps extends Omit<PConnFieldProps, 'value'> {
+  // If any, enter additional props that only exist on ObjectReference here
+  getPConnect: any;
+  displayMode;
+  allowAndPersistChangesInReviewMode: any;
+  targetObjectType: any;
+  mode: string;
+  parameters: object;
+  hideLabel: boolean;
+  inline: boolean;
+  showPromotedFilters: boolean;
+  additionalFields: any;
+}
+
+export default function ObjectReference(props: ObjectReferenceProps) {
+  const {
+    getPConnect,
+    displayMode,
+    allowAndPersistChangesInReviewMode: editableInReview = false,
+    targetObjectType,
+    mode = '',
+    parameters,
+    hideLabel = false,
+    inline = false,
+    showPromotedFilters = false,
+    additionalFields
+  } = props;
+
+  const SingleReferenceReadonly = getComponentFromMap('SingleReferenceReadOnly');
+
+  // Configs
+  const pConn = getPConnect();
+  const referenceType = targetObjectType === 'case' ? 'Case' : 'Data';
+  const rawViewMetadata = pConn.getRawMetadata();
+  const refFieldMetadata = pConn.getFieldMetadata(rawViewMetadata?.config?.value?.split('.', 2)[1]);
+
+  // Destructured properties
+  const propsToUse = { ...pConn.getInheritedProps(), ...props };
+
+  // Computed variables
+  const isDisplayModeEnabled = displayMode === 'DISPLAY_ONLY';
+  const canBeChangedInReviewMode = editableInReview && ['Autocomplete', 'Dropdown'].includes(rawViewMetadata.config.componentType);
+
+  // Editable first child on change handler
+  const onRecordChange = event => {
+    const caseKey = pConn.getCaseInfo().getKey();
+    const refreshOptions = { autoDetectRefresh: true, propertyName: '' };
+    refreshOptions.propertyName = rawViewMetadata.config?.value;
+
+    if (!canBeChangedInReviewMode || !pConn.getValue('__currentPageTabViewName')) {
+      const pgRef = pConn.getPageReference().replace('caseInfo.content', '');
+      const viewName = rawViewMetadata.name;
+      if (viewName && viewName.length > 0) {
+        getPConnect().getActionsApi().refreshCaseView(caseKey, viewName, pgRef, refreshOptions);
+      }
+    }
+
+    // AutoComplete sets value on event.id whereas Dropdown sets it on event.target.value if event.id is unset
+    // When value is empty propValue will be undefined here and no value will be set for the reference
+    const propValue = event?.id || event?.target?.value;
+    const propName =
+      rawViewMetadata.type === 'SimpleTableSelect' && mode === SELECTION_MODE.MULTI
+        ? PCore.getAnnotationUtils().getPropertyName(rawViewMetadata.config.selectionList)
+        : PCore.getAnnotationUtils().getPropertyName(rawViewMetadata.config?.value);
+
+    if (propValue && canBeChangedInReviewMode && isDisplayModeEnabled) {
+      PCore.getCaseUtils()
+        .getCaseEditLock(caseKey, '')
+        .then(caseResponse => {
+          const pageTokens = pConn.getPageReference().replace('caseInfo.content', '').split('.');
+          let curr = {};
+          const commitData = curr;
+
+          pageTokens.forEach(el => {
+            if (el !== '') {
+              curr[el] = {};
+              curr = curr[el];
+            }
+          });
+
+          // expecting format like {Customer: {pyID:"C-100"}}
+          const propArr = propName.split('.');
+          propArr.forEach((element, idx) => {
+            if (idx + 1 === propArr.length) {
+              curr[element] = propValue;
+            } else {
+              curr[element] = {};
+              curr = curr[element];
+            }
+          });
+
+          PCore.getCaseUtils()
+            .updateCaseEditFieldsData(caseKey, { [caseKey]: commitData }, caseResponse.headers.etag, pConn.getContextName())
+            .then(response => {
+              PCore.getContainerUtils().updateParentLastUpdateTime(pConn.getContextName(), (response.data as any).data.caseInfo.lastUpdateTime);
+              PCore.getContainerUtils().updateRelatedContextEtag(pConn.getContextName(), response.headers.etag);
+            });
+        });
+    }
+  };
+
+  // Prepare first child
+  const recreatedFirstChild = useMemo(() => {
+    const type = rawViewMetadata.config.componentType;
+
+    /* Read-only variants */
+    if (type === 'SemanticLink' && !canBeChangedInReviewMode) {
+      const config = {
+        ...rawViewMetadata.config,
+        primaryField: rawViewMetadata.config.displayField
+      };
+      config.caseClass = rawViewMetadata.config.targetObjectClass;
+      config.text = config.primaryField;
+      config.caseID = config.value;
+      config.contextPage = `@P .${
+        rawViewMetadata.config?.displayField ? getDataRelationshipContextFromKey(rawViewMetadata.config.displayField) : null
+      }`;
+      config.resourceParams = {
+        workID: config.value
+      };
+      config.resourcePayload = {
+        caseClassName: config.caseClass
+      };
+
+      return getPConnect().createComponent({
+        type: 'SemanticLink',
+        config: {
+          ...config,
+          displayMode,
+          referenceType,
+          hideLabel,
+          dataRelationshipContext: rawViewMetadata.config?.displayField
+            ? getDataRelationshipContextFromKey(rawViewMetadata.config.displayField)
+            : null
+        }
+      });
+    }
+    if (isDisplayModeEnabled && !canBeChangedInReviewMode) {
+      return (
+        <SingleReferenceReadonly
+          config={{
+            ...rawViewMetadata.config,
+            primaryField: rawViewMetadata.config.displayField
+          }}
+          getPConnect={getPConnect}
+          label={propsToUse.label}
+          type={type}
+          displayAs='readonly'
+          displayMode={displayMode}
+          activeViewRuleClass={rawViewMetadata.config.targetObjectClass} // for older views which may not have context class set, fall back to previous behavior
+          referenceType={referenceType}
+          hideLabel={hideLabel}
+          dataRelationshipContext={
+            rawViewMetadata.config?.displayField ? getDataRelationshipContextFromKey(rawViewMetadata.config.displayField) : null
+          }
+          additionalFields={additionalFields}
+        />
+      );
+    }
+
+    // 1) Set datasource
+    generateColumns(rawViewMetadata.config, pConn, referenceType);
+    rawViewMetadata.config.deferDatasource = true;
+    rawViewMetadata.config.listType = 'datapage';
+    if (['Dropdown', 'AutoComplete'].includes(type) && !rawViewMetadata.config.placeholder) {
+      rawViewMetadata.config.placeholder = '@L Select...';
+    }
+
+    // 2) Pass through configs
+    rawViewMetadata.config.showPromotedFilters = showPromotedFilters;
+
+    if (!canBeChangedInReviewMode) {
+      rawViewMetadata.config.displayMode = displayMode;
+    }
+
+    // 3) Define field meta
+    let fieldMetaData: any = null;
+
+    fieldMetaData = {
+      datasourceMetadata: {
+        datasource: {
+          parameters: {}
+        }
+      }
+    };
+    if (rawViewMetadata.config?.parameters) {
+      fieldMetaData.datasourceMetadata.datasource.parameters = parameters;
+    }
+    fieldMetaData.datasourceMetadata.datasource.propertyForDisplayText = rawViewMetadata?.config?.datasource?.fields?.text.startsWith('@P')
+      ? rawViewMetadata?.config?.datasource?.fields?.text?.substring(3)
+      : rawViewMetadata?.config?.datasource?.fields?.text;
+    fieldMetaData.datasourceMetadata.datasource.propertyForValue = rawViewMetadata?.config?.datasource?.fields?.value.startsWith('@P')
+      ? rawViewMetadata?.config?.datasource?.fields?.value?.substring(3)
+      : rawViewMetadata?.config?.datasource?.fields?.value;
+    fieldMetaData.datasourceMetadata.datasource.name = rawViewMetadata.config?.referenceList;
+
+    return getPConnect().createComponent({
+      type,
+      config: {
+        ...rawViewMetadata.config,
+        descriptors: mode === SELECTION_MODE.SINGLE ? refFieldMetadata?.descriptors : null,
+        datasourceMetadata: fieldMetaData?.datasourceMetadata,
+        required: propsToUse.required,
+        visibility: propsToUse.visibility,
+        disabled: propsToUse.disabled,
+        label: propsToUse.label,
+        parameters: rawViewMetadata.config.parameters,
+        readOnly: false,
+        localeReference: rawViewMetadata.config.localeReference,
+        ...(mode === SELECTION_MODE.SINGLE ? { referenceType } : ''),
+        contextClass: rawViewMetadata.config.targetObjectClass,
+        primaryField: rawViewMetadata.config?.displayField,
+        dataRelationshipContext: rawViewMetadata.config?.displayField ? getDataRelationshipContextFromKey(rawViewMetadata.config.displayField) : null,
+        hideLabel,
+        onRecordChange,
+        inline
+      }
+    });
+  }, [rawViewMetadata.config?.datasource?.source, parameters, propsToUse.required, propsToUse.disabled, getPConnect().getPageReference()]);
+
+  // Prepare children to render
+  return (
+    <Grid2 container>
+      <Grid2>{recreatedFirstChild}</Grid2>
+    </Grid2>
+  );
+}

package/lib/field/ObjectReference/index.tsx

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

package/lib/field/ObjectReference/utils.ts

@@ -0,0 +1,111 @@
+import { Utils } from '@pega/react-sdk-components/lib/components/helpers/utils';
+
+export const SELECTION_MODE = { SINGLE: 'single', MULTI: 'multi' };
+
+const getLeafNameFromPropertyName = property => property?.substr(property.lastIndexOf('.'));
+
+const isSelfReferencedProperty = (param, referenceProp) => param === referenceProp?.split('.', 2)[1];
+
+export const AT_FILTEREDLIST = '@FILTERED_LIST';
+export const AT_PROPERTY = '@P';
+export const SQUARE_BRACKET_START = '[';
+export const SQUARE_BRACKET_END = ']';
+
+export const SIMPLE_TABLE_MANUAL_READONLY = 'SimpleTableManualReadOnly';
+export const PAGE = '!P!';
+export const PAGELIST = '!PL!';
+export const PERIOD = '.';
+const AT = '@';
+
+export function updatePageListPropertyValue(value) {
+  value = value.substring(0, value.indexOf(SQUARE_BRACKET_START)) + value.substring(value.indexOf(SQUARE_BRACKET_END) + 1);
+  return value;
+}
+
+export function getPropertyValue(value) {
+  if (value.startsWith(AT)) {
+    value = value.substring(value.indexOf(' ') + 1);
+    if (value.startsWith(PERIOD)) value = value.substring(1);
+  }
+  if (value.includes(SQUARE_BRACKET_START)) {
+    value = updatePageListPropertyValue(value);
+  }
+  return value;
+}
+
+const getCompositeKeys = (c11nEnv, property) => {
+  const { datasource: { parameters = {} } = {} } = c11nEnv.getFieldMetadata(property) || {};
+  return Object.values(parameters).reduce((compositeKeys: any, param) => {
+    if (isSelfReferencedProperty(property, param)) {
+      let propName = getPropertyValue(param);
+      propName = propName.substring(propName.indexOf('.'));
+      compositeKeys.push(propName);
+    }
+    return compositeKeys;
+  }, []);
+};
+
+export const generateColumns = (config, pConn, referenceType) => {
+  const displayField = getLeafNameFromPropertyName(config.displayField);
+  const referenceProp = config.value.split('.', 2)[1];
+  const compositeKeys: any = getCompositeKeys(pConn, referenceProp);
+  let value = getLeafNameFromPropertyName(config.value);
+
+  const columns: any = [];
+  if (displayField) {
+    columns.push({
+      value: displayField,
+      display: 'true',
+      useForSearch: true,
+      primary: 'true'
+    });
+  }
+  if (value && compositeKeys.indexOf(value) !== -1) {
+    columns.push({
+      value,
+      setProperty: 'Associated property',
+      key: 'true'
+    });
+  } else {
+    const actualValue = compositeKeys.length > 0 ? compositeKeys[0] : value;
+    config.value = `@P .${referenceProp}${actualValue}`;
+    value = actualValue;
+    columns.push({
+      value: actualValue,
+      setProperty: 'Associated property',
+      key: 'true'
+    });
+  }
+
+  config.datasource = {
+    fields: {
+      key: getLeafNameFromPropertyName(config.value),
+      text: getLeafNameFromPropertyName(config.displayField),
+      value: getLeafNameFromPropertyName(config.value)
+    }
+  };
+
+  if (referenceType === 'Case') {
+    columns.push({
+      secondary: 'true',
+      display: 'true',
+      value: Utils.getMappedKey('pyID'),
+      useForSearch: true
+    });
+  }
+
+  compositeKeys.forEach(key => {
+    if (value !== key)
+      columns.push({
+        value: key,
+        display: 'false',
+        secondary: 'true',
+        useForSearch: false,
+        setProperty: `.${referenceProp}${key}`
+      });
+  });
+
+  config.columns = columns;
+};
+
+export const getDataRelationshipContextFromKey = key => key.split('.', 2)[1];