@pega/custom-dx-components 0.242.36 → 0.242.38

package/tests/assets/library/components/createAll/Launchpad/Pega_DXIL_MyPicklist/index.tsx

@@ -1,338 +0,0 @@
-/* eslint-disable react-hooks/exhaustive-deps */
-import { useState, useEffect, useRef, type Key } from 'react';
-import { Select, Option, FieldValueList, Text, withConfiguration } from '@pega/cosmos-react-core';
-
-import type { PConnFieldProps } from './PConnProps';
-
-// includes in bundle
-import handleEvent from "./event-utils";
-import { suggestionsHandler } from './suggestions-handler';
-
-import StyledPegaDxilMyPicklistWrapper from './styles';
-import {EmailDisplay, PhoneDisplay, URLDisplay } from "@pega/cosmos-react-core";
-
-
-// interface for props
-interface PegaDxilMyPicklistProps extends PConnFieldProps {
-  // If any, enter additional props that only exist on TextInput here
-  defaultValue: number;
-  isTableFormatter?: boolean;
-  hasSuggestions?: boolean;
-  variant?: any;
-  formatter: string;
-  decimalPrecision: string;
-  allowDecimals: boolean;
-  currencyISOCode: string;
-  alwaysShowISOCode: boolean;
-  isoCodeSelection: string;
-  additionalProps: any;
-  datasource:any;
-  listType: string;
-  fieldMetadata: any;
-  onRecordChange: Function;
-}
-
-// interface for StateProps object
-interface StateProps {
-  value: string;
-  hasSuggestions: boolean;
-}
-
-
-export const formatExists = (formatterVal: string) => {
-    const formatterValues = [
-      "TextInput",
-      "WorkStatus",
-      "RichText",
-      "Email",
-      "Phone",
-      "URL",
-      "Operator"
-    ];
-    let isformatter = false;
-    if (formatterValues.includes(formatterVal)) {
-      isformatter = true;
-    }
-    return isformatter;
-  };
-
-
-export const textFormatter = (formatter: string,value: any) => {
-  let displayComponent: any = null;
-  switch(formatter){
-    case "TextInput" : {
-      displayComponent = value;
-      break;
-    }
-    case "Email" : {
-      displayComponent = (<EmailDisplay value={value} displayText={value} variant="link" />);
-      break;
-    }
-    case "Phone" : {
-      displayComponent = (<PhoneDisplay value={value} variant="link" />);
-      break;
-    }
-    case "URL" : {
-      displayComponent = (<URLDisplay target="_blank" value={value} displayText={value} variant="link" />);
-      break;
-    }
-    // no default
-  }
-  return displayComponent;
-};
-
-
-export const setDefaultValue = (dropdownOptions: Array<any>, pConnect: any, propName: string) => {
-  // calculate the default option and set it to dropdown
-  const option = (dropdownOptions && dropdownOptions[0]) || {};
-  const defaultValue = option.key ? option.props.value : '';
-  pConnect.setValue(propName, defaultValue, defaultValue);
-};
-
-const pushPlaceholderOption = (placeholder: string, listSourceItems: Array<any>, items: Array<any>, pConnect: any) => {
-  // If we have a placeholder, push that option in the list of items
-  if (placeholder) {
-    items.push(
-      <Option key={placeholder} value=''>
-        {pConnect.getLocalizedValue(placeholder)}
-      </Option>
-    );
-  } else if (!listSourceItems) {
-    // If we don't have a placeholder and our list source is empty, push a blank row option in the list of items
-    // @ts-ignore
-    items.push(<Option key='' 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 PegaDxilMyPicklist(props: PegaDxilMyPicklistProps) {
-  const {
-    getPConnect,
-    value,
-    label,
-    hideLabel = false,
-    placeholder,
-    datasource = {},
-    listType,
-    validatemessage,
-    testId,
-    helperText,
-    additionalProps = {},
-    displayMode,
-    onRecordChange,
-    variant = 'inline',
-    fieldMetadata = {},
-    isTableFormatter = false,
-    hasSuggestions = false
-  } = props;
-  const { formatter } = props;
-  const pConnect = getPConnect();
-  const actions = pConnect.getActionsApi();
-  const stateProps = pConnect.getStateProps() as StateProps;
-  const propName: string = stateProps.value;
-  const className = pConnect.getCaseInfo().getClassName();
-  const refName = propName?.slice(propName.lastIndexOf('.') + 1);
-
-  let { readOnly = false, required = false, disabled = false } = props;
-  [readOnly, required, disabled] = [readOnly, required, disabled].map(
-    (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
-  );
-
-  const [status, setStatus] = useState(hasSuggestions ? 'pending' : undefined);
-
-  const useIsMount = () => {
-    const isMountRef = useRef(true);
-    useEffect(() => {
-      isMountRef.current = false;
-    }, []);
-    return isMountRef.current;
-  };
-
-  const isMount = useIsMount();
-
-  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 : '';
-
-  const configProps = pConnect.getConfigProps();
-  const items: Array<any> = [];
-  const isDatapage = listType === 'datapage';
-  let listSourceItems = isDatapage ? configProps.listOutput : datasource;
-
-  if (isDatapage && typeof datasource === 'object' && !Array.isArray(listSourceItems)) {
-    listSourceItems = datasource.source ? datasource.source : [];
-  }
-
-  useEffect(() => {
-    if (validatemessage !== '') {
-      setStatus('error');
-    }
-    if (hasSuggestions) {
-      setStatus('pending');
-    } else if (!hasSuggestions && status !== 'success') {
-      setStatus(validatemessage !== '' ? 'error' : undefined);
-    }
-  }, [validatemessage, hasSuggestions, status]);
-
-  pushPlaceholderOption(placeholder as string, listSourceItems, items, pConnect);
-
-  // Loop through all of our list source items that make up the values of the dropdown
-
-  let selectedLabel = '';
-  (listSourceItems || []).forEach(
-    (item: { key: Key | null | undefined; text: string; value: string }) => {
-    selectedLabel =
-      value !== undefined &&
-      value !== null &&
-      item.key !== undefined &&
-      item.key !== null &&
-      value.toString() === item.key.toString()
-        ? item.text || item.value
-        : selectedLabel;
-    items.push(
-      // @ts-ignore
-      <Option key={item.key} value={item.key}>
-        {isDatapage
-          ? pConnect.getLocalizedValue(
-              item.text,
-              localePath,
-              pConnect.getLocaleRuleNameFromKeys(localeClass, localeContext, localeName)
-            )
-          : pConnect.getLocalizedValue(
-              item.value,
-              localePath,
-              pConnect.getLocaleRuleNameFromKeys(localeClass, localeContext, localeName)
-            )}
-      </Option>
-    );
-  });
-
-  const isDisplayModeEnabled =
-    displayMode === 'LABELS_LEFT' || displayMode === 'STACKED_LARGE_VAL' || displayMode === 'DISPLAY_ONLY';
-  let firstOptionKey = '';
-  let firstOptionValue = '';
-  if (!placeholder && listSourceItems?.length > 0) {
-    // First option isn't going to change as long as placeholder is present. Incase placeholder is not there
-    // check for new option
-    firstOptionKey = listSourceItems[0].key;
-    firstOptionValue = listSourceItems[0].text || listSourceItems[0].value;
-  }
-  useEffect(() => {
-    // placeholder - placeholder option configured to be shown with dropdown, empty string if not configured
-    // value - value of the dropdown if set to something prior (either by pre-activity or default value etc.), empty string if nothing is set
-    // selectedLabel - is value(the one above) if it is one of the option in the dropdown datasource, empty string if not
-    // below code does this -
-    // set dropdown value to first option if placeholder is NOT present and ((value is empty) or (value is not empty and selectedLabel is empty))
-    // set dropdown value to empty if placeholder is present and value is not empty and selectedLabel is empty
-    // Broken down first option(key, value) to be as dependency instead of entire items array which creates new reference on every render
-    // First option is kept as dependency as setDefaultValue sets only first value from options
-    if (!isDisplayModeEnabled && ((!placeholder && !value) || (!isMount && value && !selectedLabel))) {
-      setDefaultValue(items, pConnect, propName);
-    }
-  }, [firstOptionKey, firstOptionValue, placeholder, selectedLabel, value, propName, isDisplayModeEnabled, isMount, pConnect]);
-
-  if (displayMode === 'LABELS_LEFT' || displayMode === 'DISPLAY_ONLY') {
-    let displayComp = selectedLabel;
-    if (isTableFormatter && formatExists(formatter)) {
-      displayComp = textFormatter(formatter, selectedLabel);
-    }
-    if (selectedLabel === '') {
-      displayComp = value || <span aria-hidden='true'>&ndash;&ndash;</span>;
-    }
-
-    return displayMode === 'DISPLAY_ONLY' ? (
-      <StyledPegaDxilMyPicklistWrapper>
-      {displayComp}
-      </StyledPegaDxilMyPicklistWrapper>
-    ) : (
-      <StyledPegaDxilMyPicklistWrapper>
-      <FieldValueList
-        variant={hideLabel ? 'stacked' : variant}
-        data-testid={testId}
-        fields={[
-          {
-            id: '1',
-            name: hideLabel ? '' : label,
-            value: displayComp
-          }
-        ]}
-      />
-      </StyledPegaDxilMyPicklistWrapper>
-    );
-  }
-
-  if (displayMode === 'STACKED_LARGE_VAL') {
-    selectedLabel = selectedLabel === '' ? value : selectedLabel;
-    const isValDefined = typeof selectedLabel !== 'undefined' && selectedLabel !== '';
-    const val = isValDefined ? (
-      <Text variant='h1' as='span'>
-        {selectedLabel}
-      </Text>
-    ) : (
-      ''
-    );
-    return (
-      <StyledPegaDxilMyPicklistWrapper>
-      <FieldValueList
-        variant='stacked'
-        data-testid={testId}
-        fields={[{ id: '2', name: hideLabel ? '' : label, value: val }]}
-      />
-      </StyledPegaDxilMyPicklistWrapper>
-    );
-  }
-
-  const onResolveSuggestionHandler = (accepted: boolean) => {
-    suggestionsHandler(accepted, pConnect, setStatus);
-  };
-
-
-  return (
-    <StyledPegaDxilMyPicklistWrapper>
-    <Select
-      {...additionalProps}
-      label={label}
-      labelHidden={hideLabel}
-      info={validatemessage || helperText}
-      status={status}
-      data-testid={testId}
-      // @ts-ignore
-      key={getPConnect().getRawMetadata().config.value}
-      value={value}
-      disabled={disabled}
-      required={required}
-      readOnly={readOnly}
-      onChange={(event) => {
-        handleEvent(actions, 'changeNblur', propName, event.target.value);
-        if (hasSuggestions) {
-          pConnect.ignoreSuggestion('');
-          setStatus(undefined);
-        }
-        if (onRecordChange) {
-          onRecordChange(event);
-        }
-      }}
-      onBlur={(event: any) => {
-        pConnect.getValidationApi().validate(event.target.value);
-      }}
-      onResolveSuggestion={onResolveSuggestionHandler}
-    >
-      {items}
-    </Select>
-    </StyledPegaDxilMyPicklistWrapper>
-  );
-}
-
-
-
-export default withConfiguration(PegaDxilMyPicklist);

package/tests/assets/library/components/createAll/Launchpad/Pega_DXIL_MyPicklist/mock.ts

@@ -1,76 +0,0 @@
-// @ts-nocheck
-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: '',
-  variant: '',
-  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/Launchpad/Pega_DXIL_MyPicklist/styles.ts

@@ -1,8 +0,0 @@
-// individual style, comment out above, and uncomment here and add styles
-import styled, { css } from 'styled-components';
-
-export default styled.div(() => {
-  return css`
-    margin: 0px 0;
-  `;
-});

package/tests/assets/library/components/createAll/Launchpad/Pega_DXIL_MyPicklist/suggestions-handler.ts

@@ -1,9 +0,0 @@
-export const suggestionsHandler = (accepted: boolean, pConn: any, setStatus: any) => {
-  if (accepted) {
-    pConn.acceptSuggestion();
-    setStatus('success');
-  } else {
-    pConn.ignoreSuggestion();
-    setStatus(undefined);
-  }
-};

package/tests/assets/library/components/createAll/Launchpad/Pega_DXIL_MyRadiobuttons/PConnProps.d.ts

@@ -1,46 +0,0 @@
-import  {PConnect } from '@pega/pcore-pconnect-typedefs';
-
-// PConnProps.d.ts
-// This gives us a place to have each component (which is most DX Components) that is
-//  expected to have a getPConnect extend its props (from BaseProps)
-//  such that every component will be expected to have a getPConnect() function
-//  that returns a PConnect object. (new/better way of doing .propTypes).
-//  This PConnProps can be extended to include other props that we know are in every component
-export interface PConnProps {
-  // getPConnect should exist for every C11n component. (add @ts-ignore in special cases where it isn't)
-  getPConnect: () => typeof PConnect;
-
-  // Allow any/all other key/value pairs in the BaseProps for now
-  //  TODO: refine which other props are always expected for various component
-  //    types and consider further interface "subclassing". For example, we may
-  //    want to create a "BasePropsForm" that gives guidance on required, readonly, etc.
-  //    and any other props that every Form component expects.
-  //    For example, see the PConnFieldProps below.
-  // NOTE: if you uncomment the line below, the PConnProps type will allow
-  //  otherwise undefined types to appear. This can be helpful for debugging
-  //  or when adding new components whose types aren't yet known.
-  // [key: string]: any;
-}
-
-
-// PConnFieldProps extends PConnProps to bring in the common properties that are
-// associated with most field components (ex: Dropdown, TextInput, etc.) in the
-//  components/field directory
-export interface PConnFieldProps extends PConnProps {
-  label: string,
-  required: boolean,
-  disabled: boolean,
-  value: any,
-  validatemessage: string,
-  status?: string,
-  onChange?: any,
-  onBlur?: any,
-  readOnly: boolean,
-  testId: string,
-  helperText: string,
-  displayMode?: string,
-  hideLabel: boolean,
-  placeholder?: string,
-  fieldMetadata?: any,
-  additionalProps?: any
-}

package/tests/assets/library/components/createAll/Launchpad/Pega_DXIL_MyRadiobuttons/config.json

@@ -1,113 +0,0 @@
-{
-  "name": "Pega_DXIL_MyRadiobuttons",
-  "label": "My Radio buttons",
-  "description": "My Radio buttons",
-  "organization": "Pega",
-  "version": "0.0.1",
-  "library": "DXIL",
-  "allowedApplications": [],
-  "componentKey": "Pega_DXIL_MyRadiobuttons",
-  "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"
-    },
-    {
-      "name": "inline",
-      "label": "Horizontal display",
-      "format": "BOOLEAN"
-    },
-    {
-      "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": "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",
-    "listType": "associated",
-    "datasource": "@ASSOCIATED .$this.name"
-  }
-}

package/tests/assets/library/components/createAll/Launchpad/Pega_DXIL_MyRadiobuttons/demo.stories.tsx

@@ -1,95 +0,0 @@
-/* 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 PegaDxilMyRadiobuttons from './index';
-
-const meta: Meta<typeof PegaDxilMyRadiobuttons> = {
-  title: 'PegaDxilMyRadiobuttons',
-  component: PegaDxilMyRadiobuttons,
-  excludeStories: /.*Data$/
-};
-
-export default meta;
-type Story = StoryObj<typeof PegaDxilMyRadiobuttons>;
-
-export const BasePegaDxilMyRadiobuttons: Story = (args: any) => {
-
-  const [value, setValue] = useState(configProps.value);
-
-  const props = {
-    value,
-    hasSuggestions: configProps.hasSuggestions,
-    fieldMetadata,
-    getPConnect: () => {
-      return {
-        getConfigProps: () => {
-          return configProps;
-        },
-        getStateProps: () => {
-          return stateProps;
-        },
-        getPageReference: () => {
-          return 'caseInfo.content';
-        },
-        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 (
-    <>
-      <PegaDxilMyRadiobuttons {...props} {...args} />
-    </>
-  );
-};
-
-BasePegaDxilMyRadiobuttons.args = {
-  datasource: configProps.datasource,
-  label: configProps.label,
-  helperText: configProps.helperText,
-  placeholder: configProps.placeholder,
-  inline: configProps.inline,
-  testId: configProps.testId,
-  readOnly: configProps.readOnly,
-  disabled: configProps.disabled,
-  required: configProps.required,
-  status: configProps.status,
-  hideLabel: configProps.hideLabel,
-  displayMode: configProps.displayMode,
-  validatemessage: configProps.validatemessage
-};