@pega/custom-dx-components 24.1.11 → 24.2.10

package/tests/assets/library/components/createAll/Constellation/Pega_DXIL_MyRadiobuttons/index.tsx

@@ -0,0 +1,192 @@
+/* eslint-disable no-nested-ternary */
+import { useMemo } from 'react';
+import { RadioButton, RadioButtonGroup, withConfiguration } from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from '../shared/PConnProps';
+import '../shared/create-nonce';
+
+// includes in bundle
+import { formatExists, textFormatter } from './textformat-utils';
+import handleEvent from './event-utils';
+
+import StyledPegaDxilMyRadiobuttonsWrapper from './styles';
+
+
+// interface for props
+interface PegaDxilMyRadiobuttonsProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  isTableFormatter?: boolean;
+  hasSuggestions?: boolean;
+  formatter: string;
+  listType: string;
+  datasource: Array<any>;
+  inline: boolean;
+}
+
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
+
+const getFullReference = (pConn: any, configProperty: string) => {
+  const pageReference = pConn.getPageReference();
+  return pageReference ? `${pageReference}.${configProperty}` : configProperty;
+};
+
+const getDisplayValue = (dataSource: any, value: any, isDatapage: boolean) => {
+  if (value !== 0 && (!value || (typeof value === 'string' && !value.trim().length))) {
+    return <span aria-hidden='true'>&ndash;&ndash;</span>;
+  }
+
+  const matchedEntry =
+    dataSource &&
+    dataSource.filter((entry: any) => {
+      return entry.key === value;
+    })[0];
+  return matchedEntry ? (isDatapage ? matchedEntry.text : matchedEntry.value) : value;
+};
+
+
+// Duplicated runtime code from Constellation Design System Component
+
+// 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
+function PegaDxilMyRadiobuttons(props: PegaDxilMyRadiobuttonsProps) {
+  const {
+    getPConnect,
+    value,
+    label,
+    hideLabel = false,
+    helperText,
+    datasource = [],
+    listType,
+    validatemessage,
+    testId,
+    additionalProps = {},
+    displayMode,
+    inline = false,
+    placeholder,
+    fieldMetadata = {},
+    isTableFormatter = false
+  } = props;
+  const pConn = getPConnect();
+  const { formatter } = props;
+  const actions = pConn.getActionsApi();
+  const stateProps = pConn.getStateProps() as StateProps;
+  const propName: string = stateProps.value;
+  const configProps = pConn.getConfigProps();
+  const className = pConn.getCaseInfo().getClassName();
+  const { getLocaleRuleNameFromKeys, getLocalizedValue } = pConn;
+
+  // @ts-ignore
+  let configProperty = pConn.getRawMetadata()?.config?.value || '';
+  configProperty = configProperty.startsWith('@P') ? configProperty.substring(3) : configProperty;
+  configProperty = configProperty.startsWith('.') ? configProperty.substring(1) : configProperty;
+  const fullReference = getFullReference(pConn, configProperty);
+
+  // BUG-547602: Temporary type coercion for 8.5 until DXAPIs are enhanced to pass original pxViewMetadata JSON, respecting boolean primitives
+  let { readOnly = false, required = false, disabled = false } = props;
+  [readOnly, required, disabled] = [readOnly, required, disabled].map(
+    (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
+  );
+
+  let status = '';
+  if (validatemessage !== '') {
+    status = 'error';
+  }
+  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;
+
+  const items: Array<any> = [];
+  const isDatapage = listType === 'datapage';
+  const listSource = isDatapage ? configProps.listOutput : datasource;
+  let autoFocusProp = additionalProps?.autoFocus
+    ? {
+        autoFocus: true
+      }
+    : {};
+  if (placeholder) {
+    items.push(
+      <RadioButton
+        {...autoFocusProp}
+        defaultChecked={value === ''}
+        id={`${fullReference}.EMPTY`}
+        value=''
+        key={`${fullReference}.EMPTY`}
+        label={placeholder}
+        name={fullReference}
+      />
+    );
+  }
+  (listSource || []).forEach((item: any) => {
+    if (additionalProps?.autoFocus && value === item.key) {
+      autoFocusProp = {
+        autoFocus: true
+      };
+    }
+    items.push(
+      <RadioButton
+        {...autoFocusProp}
+        checked={`${value}` === `${item.key}`}
+        id={`${fullReference}.${item.key}`}
+        value={item.key}
+        key={`${fullReference}.${item.key}`}
+        label={getLocalizedValue(
+          isDatapage ? item.text : item.value,
+          localePath,
+          getLocaleRuleNameFromKeys(localeClass, localeContext, localeName)
+        )}
+        name={fullReference}
+      />
+    );
+    autoFocusProp = {};
+  });
+
+  const displayComponent = useMemo(() => {
+    const displayValue = getDisplayValue(listSource, value, isDatapage);
+
+    return isTableFormatter && formatExists(formatter) ? textFormatter(formatter, displayValue) : displayValue;
+  }, [listSource, value, isDatapage, isTableFormatter, formatter]);
+
+  if (displayMode === 'DISPLAY_ONLY') {
+    return displayComponent;
+  }
+
+  return (
+    <StyledPegaDxilMyRadiobuttonsWrapper>
+    <RadioButtonGroup
+      {...additionalProps}
+      label={label}
+      labelHidden={hideLabel}
+      info={validatemessage || helperText}
+      inline={inline}
+      status={status}
+      data-testid={testId}
+      value={value}
+      required={required}
+      readOnly={readOnly}
+      onChange={(event) => {
+        handleEvent(actions, 'changeNblur', propName, event.target.value);
+      }}
+      onBlur={(event: any) => {
+        pConn.getValidationApi().validate(event.target.value);
+      }}
+      disabled={disabled}
+      className='standard'
+      name={fullReference}
+    >
+      {items}
+    </RadioButtonGroup>
+    </StyledPegaDxilMyRadiobuttonsWrapper>
+  );
+}
+
+export default withConfiguration(PegaDxilMyRadiobuttons);

package/tests/assets/library/components/createAll/Constellation/Pega_DXIL_MyRadiobuttons/mock.ts

@@ -0,0 +1,75 @@
+export const configProps = {
+  value: '',
+  label: 'Picklist 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 Helper Text',
+  testId: 'picklist-12345678',
+  hasSuggestions: false,
+  displayMode: '',
+  inline: false,
+  hideLabel: false,
+  readOnly: false,
+  required: false,
+  disabled: false,
+  status: '',
+  validatemessage: ''
+};
+
+export const stateProps = {
+  value: '.PicklistSample',
+  placeholder: 'Select...',
+  datasource: '.PicklistSample',
+  hasSuggestions: false
+};
+
+export const rawMetadata = {
+  type: 'Dropdown',
+  config: {
+    value: '@P .PicklistSample',
+    label: '@L Picklist Sample',
+    placeholder: '@L Select...',
+    listType: 'associated',
+    datasource: '@ASSOCIATED .PicklistSample',
+    helperText: '@L Picklist Helper Text',
+    testId: 'picklist-12345678'
+  }
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Text',
+  displayAs: 'pxDropdown',
+  label: 'Picklist sample',
+  datasource: {
+    tableType: 'PromptList',
+    records: [
+      {
+        key: 'Option 1',
+        value: 'Option 1'
+      },
+      {
+        key: 'Option 2',
+        value: 'Option 2'
+      },
+      {
+        key: 'Option 3',
+        value: 'Option 3'
+      }
+    ]
+  }
+};

package/tests/assets/library/components/createAll/Constellation/Pega_DXIL_MySearchbox/config.json

@@ -0,0 +1,118 @@
+{
+  "name": "Pega_DXIL_MySearchbox",
+  "label": "My Search box",
+  "description": "My Search box",
+  "organization": "Pega",
+  "version": "0.0.1-dev",
+  "library": "DXIL",
+  "allowedApplications": [],
+  "componentKey": "Pega_DXIL_MySearchbox",
+  "type": "Field",
+  "subtype": "Picklist",
+  "icon": "images/pz-dropdown-active.svg",
+  "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,
+    "detailFVLItem": true,
+    "isFormWidth" : false,
+    "isContainerWidth" : false
+  }
+}

package/tests/assets/library/components/createAll/Constellation/Pega_DXIL_MySearchbox/demo.stories.tsx

@@ -0,0 +1,100 @@
+/* eslint-disable react/jsx-no-useless-fragment */
+import { useState } from 'react';
+import type { Meta, StoryObj } from '@storybook/react';
+
+import { configProps, rawMetadata, fieldMetadata, stateProps } from './mock';
+
+import PegaDxilMySearchbox from './index';
+
+const meta: Meta<typeof PegaDxilMySearchbox> = {
+  title: 'PegaDxilMySearchbox',
+  component: PegaDxilMySearchbox,
+  excludeStories: /.*Data$/
+};
+
+export default meta;
+type Story = StoryObj<typeof PegaDxilMySearchbox>;
+
+export const BasePegaDxilMySearchbox: Story = (args: any) => {
+
+  const [value, setValue] = useState(configProps.value);
+  const datasourceMetadata = fieldMetadata;
+
+  const props = {
+    value,
+    hasSuggestions: configProps.hasSuggestions,
+    columns: [],
+    listType: 'associated',
+    datasourceMetadata,
+    fieldMetadata,
+    getPConnect: () => {
+      return {
+        getConfigProps: () => {
+          return configProps;
+        },
+        getStateProps: () => {
+          return stateProps;
+        },
+        getContextName: () => {
+          return 'app/primary_1';
+        },
+        getLocalizedValue: (val: any) => {
+          return val;
+        },
+        getLocaleRuleNameFromKeys: (localeClass: string, localeContext: string, localeName: string) => {
+          return `${localeClass}!${localeContext}!${localeName}`;
+        },
+        getCaseInfo: () => {
+          return {
+            getClassName: () => {
+              return 'DIXL-MediaCo-Work-NewService';
+            }
+          };
+        },
+        getRawMetadata: () => {
+          return rawMetadata;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: (propName: string, theValue: any) => {
+              setValue(theValue);
+            },
+            triggerFieldChange: () => {/* nothing */}
+          };
+        },
+        getValidationApi: () => {
+          return {
+            validate: () => {/* nothing */}
+          };
+        },
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        setInheritedProps: () => {/* nothing */},
+        resolveConfigProps: () => {/* nothing */}
+      };
+    }
+  };
+
+  return (
+    <>
+      <PegaDxilMySearchbox {...props} {...args} />
+    </>
+  );
+};
+
+BasePegaDxilMySearchbox.args = {
+  datasource: configProps.datasource,
+  label: configProps.label,
+  helperText: configProps.helperText,
+  placeholder: configProps.placeholder,
+  parameters: {},
+  isTableFormatter: false,
+  testId: configProps.testId,
+  readOnly: configProps.readOnly,
+  disabled: configProps.disabled,
+  required: configProps.required,
+  status: configProps.status,
+  hideLabel: configProps.hideLabel,
+  displayMode: configProps.displayMode,
+  validatemessage: configProps.validatemessage
+};