@pega/dx-component-builder-sdk 0.23.10 → 0.23.12

package/tests/assets/sdk-r/components/createAll/override-sdk/field/DateTime/DateTime.tsx

@@ -0,0 +1,103 @@
+import { KeyboardDateTimePicker } from '@material-ui/pickers';
+
+import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-utils';
+import { format } from '@pega/react-sdk-components/lib/components/helpers/formatters';
+import { dateFormatInfoDefault, getDateFormatInfo } from '@pega/react-sdk-components/lib/components/helpers/date-format-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 DateTimeProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on DateTime here
+}
+
+export default function DateTime(props: DateTimeProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const TextInput = getComponentFromMap('TextInput');
+  const FieldValueList = getComponentFromMap('FieldValueList');
+
+  const {
+    getPConnect,
+    label,
+    required,
+    disabled,
+    value = '',
+    validatemessage,
+    status,
+    onChange,
+    readOnly,
+    testId,
+    helperText,
+    displayMode,
+    hideLabel
+  } = props;
+
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = (pConn.getStateProps() as any).value;
+  const helperTextToDisplay = validatemessage || helperText;
+
+  // Start with default dateFormatInfo
+  const dateFormatInfo = dateFormatInfoDefault;
+  // and then update, as needed, based on locale, etc.
+  const theDateFormat = getDateFormatInfo();
+  dateFormatInfo.dateFormatString = theDateFormat.dateFormatString;
+  dateFormatInfo.dateFormatStringLC = theDateFormat.dateFormatStringLC;
+  dateFormatInfo.dateFormatMask = theDateFormat.dateFormatMask;
+
+  if (displayMode === 'LABELS_LEFT') {
+    const formattedDateTime = format(props.value, 'datetime', {
+      format: `${dateFormatInfo.dateFormatString} hh:mm a`
+    });
+    return <FieldValueList name={hideLabel ? '' : label} value={formattedDateTime} />;
+  }
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    const formattedDateTime = format(props.value, 'datetime', {
+      format: `${dateFormatInfo.dateFormatString} hh:mm a`
+    });
+    return <FieldValueList name={hideLabel ? '' : label} value={formattedDateTime} variant='stacked' />;
+  }
+
+  if (readOnly) {
+    const formattedDateTime = format(props.value, 'datetime');
+    return <TextInput {...props} value={formattedDateTime} />;
+  }
+
+  const handleChange = date => {
+    const changeValue = date && date.isValid() ? date.toISOString() : null;
+    onChange({ value: changeValue });
+  };
+
+  const handleAccept = date => {
+    const changeValue = date && date.isValid() ? date.toISOString() : null;
+    handleEvent(actions, 'changeNblur', propName, changeValue);
+  };
+
+  //
+  // TODO: Keyboard doesn't work in the minute field, it updates one digit then jump to am/pm field
+  //       try an older version of the lib or use DateTimePicker
+  //
+
+  return (
+    <KeyboardDateTimePicker
+      variant='inline'
+      inputVariant='outlined'
+      fullWidth
+      autoOk
+      required={required}
+      disabled={disabled}
+      placeholder={`${dateFormatInfo.dateFormatStringLC} hh:mm a`}
+      format={`${dateFormatInfo.dateFormatString} hh:mm a`}
+      mask={`${dateFormatInfo.dateFormatMask} __:__ _m`}
+      minutesStep={5}
+      error={status === 'error'}
+      helperText={helperTextToDisplay}
+      size='small'
+      label={label}
+      value={value || null}
+      onChange={handleChange}
+      onAccept={handleAccept}
+      data-test-id={testId}
+    />
+  );
+}

package/tests/assets/sdk-r/components/createAll/override-sdk/field/DateTime/config-ext.json

@@ -0,0 +1,9 @@
+{
+    "componentKey": "DateTime",
+    "name": "DateTime",
+    "label": "Date & time",
+    "description": "Date & time",
+    "type": "Field",
+    "subtype": "DateTime",
+    "properties": []
+}

package/tests/assets/sdk-r/components/createAll/override-sdk/field/DateTime/index.tsx

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

package/tests/assets/sdk-r/components/createAll/override-sdk/field/Decimal/Decimal.tsx

@@ -0,0 +1,100 @@
+import { useState, useEffect } from 'react';
+import CurrencyTextField from '@unicef/material-ui-currency-textfield';
+
+import { getCurrencyCharacters, getCurrencyOptions } from '@pega/react-sdk-components/lib/components/field/Currency/currency-utils';
+import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-utils';
+import { format } from '@pega/react-sdk-components/lib/components/helpers/formatters';
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
+import { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+
+// Using control from: https://github.com/unicef/material-ui-currency-textfield
+
+interface DecimalProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on Decimal here
+  currencyISOCode?: string;
+  decimalPrecision?: number;
+  showGroupSeparators?: string;
+}
+
+export default function Decimal(props: DecimalProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const FieldValueList = getComponentFromMap('FieldValueList');
+
+  const {
+    getPConnect,
+    label,
+    required,
+    disabled,
+    value = '',
+    validatemessage,
+    status,
+    /* onChange, onBlur, */
+    readOnly,
+    helperText,
+    displayMode,
+    hideLabel,
+    currencyISOCode = 'USD',
+    decimalPrecision = 2,
+    showGroupSeparators = true,
+    testId,
+    placeholder
+  } = props;
+
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = (pConn.getStateProps() as any).value;
+  const helperTextToDisplay = validatemessage || helperText;
+
+  const [theCurrDec, setCurrDec] = useState('.');
+  const [theCurrSep, setCurrSep] = useState(',');
+
+  useEffect(() => {
+    const theSymbols = getCurrencyCharacters(currencyISOCode);
+    setCurrDec(theSymbols.theDecimalIndicator);
+    setCurrSep(theSymbols.theDigitGroupSeparator);
+  }, [currencyISOCode]);
+
+  const theCurrencyOptions = getCurrencyOptions(currencyISOCode);
+  const formattedValue = format(value, pConn.getComponentName().toLowerCase(), theCurrencyOptions);
+
+  if (displayMode === 'LABELS_LEFT') {
+    return <FieldValueList name={hideLabel ? '' : label} value={formattedValue} />;
+  }
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    return <FieldValueList name={hideLabel ? '' : label} value={formattedValue} variant='stacked' />;
+  }
+
+  const testProp = {
+    'data-test-id': testId
+  };
+
+  function decimalOnBlur(event, inValue) {
+    handleEvent(actions, 'changeNblur', propName, inValue !== '' ? Number(inValue) : inValue);
+  }
+
+  return (
+    <CurrencyTextField
+      fullWidth
+      variant={readOnly ? 'standard' : 'outlined'}
+      helperText={helperTextToDisplay}
+      placeholder={placeholder ?? ''}
+      size='small'
+      required={required}
+      disabled={disabled}
+      error={status === 'error'}
+      label={label}
+      value={value}
+      readOnly={!!readOnly}
+      type='text'
+      outputFormat='number'
+      textAlign='left'
+      InputProps={{ inputProps: { ...testProp } }}
+      currencySymbol=''
+      decimalCharacter={theCurrDec}
+      digitGroupSeparator={showGroupSeparators ? theCurrSep : ''}
+      decimalPlaces={decimalPrecision}
+      onBlur={!readOnly ? decimalOnBlur : undefined}
+    />
+  );
+}

package/tests/assets/sdk-r/components/createAll/override-sdk/field/Decimal/config-ext.json

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

package/tests/assets/sdk-r/components/createAll/override-sdk/field/Decimal/index.tsx

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

package/tests/assets/sdk-r/components/createAll/override-sdk/field/Dropdown/Dropdown.tsx

@@ -0,0 +1,233 @@
+import { useEffect, useState } from 'react';
+import { TextField } from '@material-ui/core';
+import MenuItem from '@material-ui/core/MenuItem';
+import isDeepEqual from 'fast-deep-equal/react';
+import Utils from '@pega/react-sdk-components/lib/components/helpers/utils';
+import { getDataPage } from '@pega/react-sdk-components/lib/components/helpers/data_page';
+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 IOption {
+  key: string;
+  value: string;
+}
+
+const flattenParameters = (params = {}) => {
+  const flatParams = {};
+  Object.keys(params).forEach(key => {
+    const { name, value: theVal } = params[key];
+    flatParams[name] = theVal;
+  });
+
+  return flatParams;
+};
+
+const preProcessColumns = columnList => {
+  return columnList.map(col => {
+    const tempColObj = { ...col };
+    tempColObj.value = col.value && col.value.startsWith('.') ? col.value.substring(1) : col.value;
+    return tempColObj;
+  });
+};
+
+const getDisplayFieldsMetaData = columnList => {
+  const displayColumns = columnList.filter(col => col.display === 'true');
+  const metaDataObj: any = { key: '', primary: '', secondary: [] };
+  const keyCol = columnList.filter(col => col.key === 'true');
+  metaDataObj.key = keyCol.length > 0 ? keyCol[0].value : 'auto';
+  for (let index = 0; index < displayColumns.length; index += 1) {
+    if (displayColumns[index].primary === 'true') {
+      metaDataObj.primary = displayColumns[index].value;
+    } else {
+      metaDataObj.secondary.push(displayColumns[index].value);
+    }
+  }
+  return metaDataObj;
+};
+
+interface DropdownProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on Dropdown here
+  datasource?: any[];
+  onRecordChange?: any;
+  fieldMetadata?: any;
+  listType: string;
+  deferDatasource?: boolean;
+  datasourceMetadata?: any;
+  parameters?: any;
+  columns: any[];
+}
+
+export default function Dropdown(props: DropdownProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const FieldValueList = getComponentFromMap('FieldValueList');
+
+  const {
+    getPConnect,
+    label,
+    required,
+    disabled,
+    value = '',
+    validatemessage,
+    status,
+    readOnly,
+    testId,
+    helperText,
+    displayMode,
+    deferDatasource,
+    datasourceMetadata,
+    hideLabel,
+    onRecordChange,
+    fieldMetadata
+  } = props;
+  let { placeholder = '' } = props;
+  const context = getPConnect().getContextName();
+  let { listType, parameters, datasource = [], columns = [] } = props;
+  placeholder = placeholder || 'Select...';
+  const [options, setOptions] = useState<IOption[]>([]);
+  const [theDatasource, setDatasource] = useState<any[] | null>(null);
+  const helperTextToDisplay = validatemessage || helperText;
+
+  const thePConn = getPConnect();
+  const actionsApi = thePConn.getActionsApi();
+  const propName = (thePConn.getStateProps() as any).value;
+  const className = thePConn.getCaseInfo().getClassName();
+  const refName = propName?.slice(propName.lastIndexOf('.') + 1);
+
+  if (!isDeepEqual(datasource, theDatasource)) {
+    // inbound datasource is different, so update theDatasource (to trigger useEffect)
+    setDatasource(datasource);
+  }
+
+  // convert associated to datapage listtype and transform props
+  // Process deferDatasource when datapage name is present. WHhen tableType is promptList / localList
+  if (deferDatasource && datasourceMetadata?.datasource?.name) {
+    listType = 'datapage';
+    datasource = datasourceMetadata.datasource.name;
+    const { parameters: dataSourceParameters, propertyForDisplayText, propertyForValue } = datasourceMetadata.datasource;
+    parameters = flattenParameters(dataSourceParameters);
+    const displayProp = propertyForDisplayText.startsWith('@P') ? propertyForDisplayText.substring(3) : propertyForDisplayText;
+    const valueProp = propertyForValue.startsWith('@P') ? propertyForValue.substring(3) : propertyForValue;
+    columns = [
+      {
+        key: 'true',
+        setProperty: 'Associated property',
+        value: valueProp
+      },
+      {
+        display: 'true',
+        primary: 'true',
+        useForSearch: true,
+        value: displayProp
+      }
+    ];
+  }
+  columns = preProcessColumns(columns);
+
+  useEffect(() => {
+    if (theDatasource) {
+      const list = Utils.getOptionList(props, getPConnect().getDataObject('')); // 1st arg empty string until typedef marked correctly
+      const optionsList = [...list];
+      optionsList.unshift({
+        key: placeholder,
+        value: thePConn.getLocalizedValue(placeholder, '', '')
+      }); // 2nd and 3rd args empty string until typedef marked correctly
+      setOptions(optionsList);
+    }
+  }, [theDatasource]);
+
+  useEffect(() => {
+    if (!displayMode && listType !== 'associated' && typeof datasource === 'string') {
+      getDataPage(datasource, parameters, context).then((results: any) => {
+        const optionsData: any[] = [];
+        const displayColumn = getDisplayFieldsMetaData(columns);
+        results?.forEach(element => {
+          const val = element[displayColumn.primary]?.toString();
+          const obj = {
+            key: element[displayColumn.key] || element.pyGUID,
+            value: val
+          };
+          optionsData.push(obj);
+        });
+        setOptions(optionsData);
+      });
+    }
+  }, []);
+
+  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 : refName;
+  const localePath = localeContext === 'datapage' ? displayName : localeName;
+
+  let readOnlyProp = {};
+
+  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'
+      />
+    );
+  }
+
+  if (readOnly) {
+    readOnlyProp = { readOnly: true };
+  }
+
+  let testProp = {};
+
+  testProp = {
+    'data-test-id': testId
+  };
+
+  const handleChange = evt => {
+    const selectedValue = evt.target.value === placeholder ? '' : evt.target.value;
+    handleEvent(actionsApi, 'changeNblur', propName, selectedValue);
+    if (onRecordChange) {
+      onRecordChange(evt);
+    }
+  };
+
+  // Material UI shows a warning if the component is rendered before options are set.
+  //  So, hold off on rendering anything until options are available...
+  return options.length === 0 ? null : (
+    <TextField
+      fullWidth
+      variant={readOnly ? 'standard' : 'outlined'}
+      helperText={helperTextToDisplay}
+      placeholder={thePConn.getLocalizedValue(placeholder, '', '')} // 2nd and 3rd args empty string until typedef marked correctly
+      size='small'
+      required={required}
+      disabled={disabled}
+      onChange={!readOnly ? handleChange : undefined}
+      error={status === 'error'}
+      label={label}
+      value={value === '' && !readOnly ? placeholder : value}
+      select
+      InputProps={{ ...readOnlyProp, ...testProp }}
+    >
+      {options.map((option: any) => (
+        <MenuItem key={option.key} value={option.key}>
+          {/* @ts-ignore - Property 'getLocaleRuleNameFromKeys' is private and only accessible within class 'C11nEnv'  */}
+          {thePConn.getLocalizedValue(option.value, localePath, thePConn.getLocaleRuleNameFromKeys(localeClass, localeContext, localeName))}
+        </MenuItem>
+      ))}
+    </TextField>
+  );
+}

package/tests/assets/sdk-r/components/createAll/override-sdk/field/Dropdown/config-ext.json

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

package/tests/assets/sdk-r/components/createAll/override-sdk/field/Dropdown/index.tsx

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

package/tests/assets/sdk-r/components/createAll/override-sdk/field/Email/Email.tsx

@@ -0,0 +1,77 @@
+import { InputAdornment, TextField } from '@material-ui/core';
+import MailOutlineIcon from '@material-ui/icons/MailOutline';
+
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
+import { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+
+interface EmailProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on Date here
+}
+
+export default function Email(props: EmailProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const TextInput = getComponentFromMap('TextInput');
+  const FieldValueList = getComponentFromMap('FieldValueList');
+
+  const {
+    label,
+    required,
+    disabled,
+    value = '',
+    validatemessage,
+    status,
+    onChange,
+    onBlur,
+    readOnly,
+    testId,
+    helperText,
+    displayMode,
+    hideLabel,
+    placeholder
+  } = props;
+  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' />;
+  }
+
+  if (readOnly) {
+    return <TextInput {...props} />;
+  }
+
+  let testProp = {};
+
+  testProp = {
+    'data-test-id': testId
+  };
+
+  return (
+    <TextField
+      fullWidth
+      variant='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='email'
+      InputProps={{
+        startAdornment: (
+          <InputAdornment position='start'>
+            <MailOutlineIcon />
+          </InputAdornment>
+        ),
+        inputProps: { ...testProp }
+      }}
+    />
+  );
+}

package/tests/assets/sdk-r/components/createAll/override-sdk/field/Email/config-ext.json

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

package/tests/assets/sdk-r/components/createAll/override-sdk/field/Email/index.tsx

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

package/tests/assets/sdk-r/components/createAll/override-sdk/field/Integer/Integer.tsx

@@ -0,0 +1,88 @@
+import { TextField } from '@material-ui/core';
+
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
+import { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+
+interface IntegerProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on Integer here
+}
+
+export default function Integer(props: IntegerProps) {
+  // Get emitted components from map (so we can get any override that may exist)
+  const TextInput = getComponentFromMap('TextInput');
+  const FieldValueList = getComponentFromMap('FieldValueList');
+
+  const {
+    label,
+    required,
+    disabled,
+    value = '',
+    validatemessage,
+    status,
+    onChange,
+    onBlur,
+    readOnly,
+    testId,
+    helperText,
+    displayMode,
+    hideLabel,
+    placeholder
+  } = props;
+  const helperTextToDisplay = validatemessage || helperText;
+
+  // console.log(`Integer: 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
+  };
+
+  function intOnChange(event) {
+    // console.log(`Integer intOnChange inValue: ${event.target.value}`);
+
+    // Disallow "." and "," (separators) since this is an integer field
+    //  Mimics Pega Integer behavior (where separator characters are "eaten" if they're typed)
+    const disallowedChars = ['.', ','];
+    const theAttemptedValue = event.target.value;
+    const lastChar = theAttemptedValue.slice(-1);
+
+    if (disallowedChars.includes(lastChar)) {
+      event.target.value = theAttemptedValue.slice(0, -1);
+    }
+
+    // Pass through to the Constellation change handler
+    onChange(event);
+  }
+
+  return (
+    <TextField
+      fullWidth
+      variant={readOnly ? 'standard' : 'outlined'}
+      helperText={helperTextToDisplay}
+      placeholder={placeholder ?? ''}
+      size='small'
+      required={required}
+      disabled={disabled}
+      onChange={intOnChange}
+      onBlur={!readOnly ? onBlur : undefined}
+      error={status === 'error'}
+      label={label}
+      value={value}
+      type='text'
+      inputProps={{ inputMode: 'numeric', pattern: '[0-9]*', ...testProp }}
+    />
+  );
+}

package/tests/assets/sdk-r/components/createAll/override-sdk/field/Integer/config-ext.json

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

package/tests/assets/sdk-r/components/createAll/override-sdk/field/Integer/index.tsx

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