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

package/tests/assets/sdk-r/components/createAll/custom-sdk/field/Pega_DXIL_MyRadiobuttons/index.tsx

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

package/tests/assets/sdk-r/components/createAll/custom-sdk/field/Pega_DXIL_MyRadiobuttons/mock.ts

@@ -0,0 +1,51 @@
+export const configProps = {
+  value: '',
+  label: 'Picklist-RadioButtons Sample',
+  placeholder: 'Select...',
+  listType: 'associated',
+  datasource: [
+    {
+      key: 'Option 1',
+      value: 'Option 1'
+    },
+    {
+      key: 'Option 2',
+      value: 'Option 2'
+    },
+    {
+      key: 'Option 3',
+      value: 'Option 3'
+    }
+  ],
+  helperText: 'Picklist-RadioButtons Helper Text',
+  testId: 'Picklist-RadioButtons-12345678',
+  hasSuggestions: false,
+  required: false,
+  disabled: false,
+  readOnly: false,
+  status: '',
+  hideLabel: false,
+  displayMode: '',
+  validatemessage: ''
+};
+
+export const rawMetadata = {
+  type: 'Dropdown',
+  config: {
+    value: '@P .PicklistRadioButtonsSample',
+    label: '@L PicklistRadioButtons Sample',
+    placeholder: '@L Select...',
+    listType: 'associated',
+    datasource: '@ASSOCIATED .PicklistSample',
+    helperText: '@L PicklistRadioButtons Helper Text',
+    testId: 'picklist-RadioButtons-12345678'
+  }
+};
+
+
+export const stateProps = {
+  value: '.PicklistRadioButtonsSample',
+  placeholder: 'Select...',
+  datasource: '.PicklistRadioButtonsSample',
+  hasSuggestions: false
+};

package/tests/assets/sdk-r/components/createAll/custom-sdk/field/Pega_DXIL_MyRadiobuttons/styles.js

@@ -0,0 +1,7 @@
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 0px 0;
+  `;
+});

package/tests/assets/sdk-r/components/createAll/custom-sdk/field/Pega_DXIL_MySearchbox/config.json

@@ -0,0 +1,115 @@
+{
+  "name": "Pega_DXIL_MySearchbox",
+  "label": "My Search box",
+  "description": "My Search box",
+  "organization": "Pega",
+  "version": "0.0.1",
+  "library": "DXIL",
+  "allowedApplications": [],
+  "componentKey": "Pega_DXIL_MySearchbox",
+  "type": "Field",
+  "subtype": "Picklist",
+  "icon": "",
+  "properties": [
+    {
+      "name": "label",
+      "label": "Field label",
+      "format": "TEXT",
+      "required": true
+    },
+    {
+      "name": "readOnly",
+      "label": "Edit mode",
+      "format": "READONLY"
+    },
+    {
+      "label": "Column settings",
+      "format": "GROUP",
+      "visibility": "@VIEWTYPE == 'MultiRecordDisplayAsTable'",
+      "properties": [
+        {
+          "name": "columnWidth",
+          "label": "Column width",
+          "format": "SELECT",
+          "source": [
+            {
+              "key": "auto",
+              "value": "Auto"
+            },
+            {
+              "key": "custom",
+              "value": "Custom"
+            }
+          ]
+        },
+        {
+          "name": "width",
+          "label": "Width (px)",
+          "format": "NUMBER",
+          "visibility": "$this.columnWidth == 'custom'"
+        }
+      ]
+    },
+    {
+      "label": "Input settings",
+      "format": "GROUP",
+      "visibility": "(!readOnly = true)",
+      "properties": [
+        {
+          "name": "placeholder",
+          "label": "Placeholder",
+          "format": "TEXT"
+        },
+        {
+          "name": "helperText",
+          "label": "Helper text",
+          "format": "TEXT"
+        }
+      ]
+    },
+    {
+      "label": "Conditions",
+      "format": "GROUP",
+      "properties": [
+        {
+          "name": "required",
+          "label": "Required",
+          "format": "REQUIRED",
+          "visibility": "(!readOnly = true)"
+        },
+        {
+          "name": "disabled",
+          "label": "Disabled",
+          "format": "DISABLED",
+          "visibility": "(!readOnly = true)"
+        },
+        {
+          "name": "visibility",
+          "label": "Visibility",
+          "format": "VISIBILITY"
+        }
+      ]
+    },
+    {
+      "label": "Advanced",
+      "format": "GROUP",
+      "collapsible": true,
+      "properties": [
+        {
+          "name": "testId",
+          "label": "Test ID",
+          "format": "TEXT",
+          "ignorePattern": "[^-_\\p{N}\\p{L}]",
+          "includeAnnotations": false
+        }
+      ]
+    }
+  ],
+  "defaultConfig": {
+    "label": "@L $this.label",
+    "placeholder": "@L Select...",
+    "listType": "associated",
+    "datasource": "@ASSOCIATED .$this.name",
+    "deferDatasource": true
+  }
+}

package/tests/assets/sdk-r/components/createAll/custom-sdk/field/Pega_DXIL_MySearchbox/demo.stories.tsx

@@ -0,0 +1,76 @@
+import { useState } from 'react';
+import type { Meta, StoryObj } from '@storybook/react';
+
+import PegaDxilMySearchbox from './index';
+import { configProps, stateProps } from './mock';
+
+const meta: Meta<typeof PegaDxilMySearchbox> = {
+  title: 'PegaDxilMySearchbox',
+  component: PegaDxilMySearchbox,
+  excludeStories: /.*Data$/
+};
+
+export default meta;
+type Story = StoryObj<typeof PegaDxilMySearchbox>;
+
+export const BasePegaDxilMySearchbox: Story = (args) => {
+  const [value, setValue] = useState(configProps.value);
+
+  const props = {
+    value,
+    placeholder: configProps.placeholder,
+    listType: configProps.listType,
+    datasource: configProps.datasource,
+    getPConnect: () => {
+      return {
+        getDataObject: () => {
+          return undefined;
+        },
+        getStateProps: () => {
+          return stateProps;
+        },
+        getContextName: () => {
+          return 'app/primary_1';
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: (propName, val) => {
+              setValue(val);
+            },
+            triggerFieldChange: () => {
+              return undefined;
+            }
+          };
+        },
+        getCaseInfo: () => {
+          return {
+            getClassName: () => {
+              return undefined;
+            }
+          };
+        },
+        getLocalizedValue: val => {
+          return val;
+        },
+        getLocaleRuleNameFromKeys: () => {
+          return undefined;
+        }
+      };
+    }
+  };
+
+  return <PegaDxilMySearchbox {...props} {...args} />;
+};
+
+BasePegaDxilMySearchbox.args = {
+  label: configProps.label,
+  helperText: configProps.helperText,
+  testId: configProps.testId,
+  readOnly: configProps.readOnly,
+  disabled: configProps.disabled,
+  required: configProps.required,
+  status: configProps.status,
+  hideLabel: configProps.hideLabel,
+  displayMode: configProps.displayMode,
+  validatemessage: configProps.validatemessage, 
+}

package/tests/assets/sdk-r/components/createAll/custom-sdk/field/Pega_DXIL_MySearchbox/index.tsx

@@ -0,0 +1,225 @@
+import { useEffect, useState } from 'react';
+import { TextField } from '@material-ui/core';
+import Autocomplete from '@material-ui/lab/Autocomplete';
+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';
+import StyledPegaDxilMySearchboxWrapper from './styles';
+
+interface IOption {
+  key: string;
+  value: string;
+}
+
+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 PegaDxilMySearchboxProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on this componentName
+  displayMode?: string;
+  deferDatasource?: boolean;
+  datasourceMetadata?: any;
+  status?: string;
+  onRecordChange?: any;
+  additionalProps?: object;
+  listType: string;
+  parameters?: any;
+  datasource: any;
+  columns: any[];
+}
+
+// Duplicated runtime code from React SDK
+
+// props passed in combination of props from property panel (config.json) and run time props from Constellation
+// any default values in config.pros should be set in defaultProps at bottom of this file
+export default function PegaDxilMySearchbox(props: PegaDxilMySearchboxProps) {
+  // 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,
+    placeholder,
+    value = '',
+    validatemessage,
+    readOnly,
+    testId,
+    displayMode,
+    deferDatasource,
+    datasourceMetadata,
+    status,
+    helperText,
+    hideLabel,
+    onRecordChange
+  } = props;
+
+  const context = getPConnect().getContextName();
+  let { listType, parameters, datasource = [], columns = [] } = props;
+  const [inputValue, setInputValue] = useState('');
+  const [options, setOptions] = useState<IOption[]>([]);
+  const [theDatasource, setDatasource] = useState(null);
+  let selectedValue: any = '';
+  const helperTextToDisplay = validatemessage || helperText;
+
+  const thePConn = getPConnect();
+  const actionsApi = thePConn.getActionsApi();
+  const propName = (thePConn.getStateProps() as any).value;
+
+  if (!isDeepEqual(datasource, theDatasource)) {
+    // inbound datasource is different, so update theDatasource (to trigger useEffect)
+    setDatasource(datasource);
+  }
+
+  const flattenParameters = (params = {}) => {
+    const flatParams = {};
+    Object.keys(params).forEach(key => {
+      const { name, value: theVal } = params[key];
+      flatParams[name] = theVal;
+    });
+
+    return flatParams;
+  };
+
+  // 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 (listType === 'associated') {
+      setOptions(Utils.getOptionList(props, getPConnect().getDataObject('')));
+    }
+  }, [theDatasource]);
+
+  useEffect(() => {
+    if (!displayMode && listType !== 'associated') {
+      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);
+      });
+    }
+  }, []);
+
+  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 (value) {
+    const index = options?.findIndex(element => element.key === value);
+    if (index > -1) {
+      selectedValue = options[index].value;
+    } else {
+      selectedValue = value;
+    }
+  }
+
+  const handleChange = (event: object, newValue) => {
+    const val = newValue ? newValue.key : '';
+    handleEvent(actionsApi, 'changeNblur', propName, val);
+    if (onRecordChange) {
+      onRecordChange(event);
+    }
+  };
+
+  const handleInputValue = (event, newInputValue) => {
+    setInputValue(newInputValue);
+  };
+
+  if (readOnly) {
+    const theValAsString = options?.find(opt => opt.key === value)?.value;
+    return <TextInput {...props} value={theValAsString} />;
+  }
+  // Need to use both getOptionLabel and getOptionSelected to map our
+  //  key/value structure to what Autocomplete expects
+  return (
+    <StyledPegaDxilMySearchboxWrapper>
+    <Autocomplete
+      options={options}
+      getOptionLabel={(option: IOption) => {
+        return option.value ? option.value : '';
+      }}
+      getOptionSelected={(option: any) => {
+        return option.value ? option.value : '';
+      }}
+      fullWidth
+      onChange={handleChange}
+      value={selectedValue}
+      inputValue={inputValue || selectedValue}
+      onInputChange={handleInputValue}
+      renderInput={params => (
+        <TextField
+          {...params}
+          fullWidth
+          variant='outlined'
+          helperText={helperTextToDisplay}
+          placeholder={placeholder}
+          size='small'
+          required={required}
+          error={status === 'error'}
+          label={label}
+          data-test-id={testId}
+        />
+      )}
+    />
+    </StyledPegaDxilMySearchboxWrapper>
+  );
+}

package/tests/assets/sdk-r/components/createAll/custom-sdk/field/Pega_DXIL_MySearchbox/mock.ts

@@ -0,0 +1,36 @@
+export const configProps = {
+  value: '',
+  label: 'Picklist-Autocomplete Sample',
+  placeholder: 'Select...',
+  listType: 'associated',
+  datasource: [
+    {
+      key: 'Option 1',
+      value: 'Option 1'
+    },
+    {
+      key: 'Option 2',
+      value: 'Option 2'
+    },
+    {
+      key: 'Option 3',
+      value: 'Option 3'
+    }
+  ],
+  helperText: 'Picklist-Autocomplete Helper Text',
+  testId: 'picklist-autocomplete-12345678',
+  required: false,
+  disabled: false,
+  readOnly: false,
+  status: '',
+  hideLabel: false,
+  displayMode: '',
+  validatemessage: ''
+};
+
+export const stateProps = {
+  value: '.PicklistAutocompleteSample',
+  placeholder: 'Select...',
+  datasource: '.PicklistAutocompleteSample',
+  hasSuggestions: false
+};

package/tests/assets/sdk-r/components/createAll/custom-sdk/field/Pega_DXIL_MySearchbox/styles.js

@@ -0,0 +1,7 @@
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 0px 0;
+  `;
+});