@pega/custom-dx-components 0.23.10 → 0.23.12

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPhone/index.jsx

@@ -0,0 +1,266 @@
+import { useState, useEffect, useRef } from 'react';
+import {
+  PhoneInput as CosmosPhone,
+  getPhoneNumberParts,
+  PhoneDisplay,
+  FieldValueList,
+  Text,
+  EmailDisplay, URLDisplay
+} from '@pega/cosmos-react-core';
+import PropTypes from 'prop-types';
+
+// includes in bundle
+import handleEvent from "./event-utils";
+import { suggestionsHandler } from './suggestions-handler';
+
+import StyledPegaDxilMyPhoneWrapper from './styles';
+
+export const formatExists = (formatterVal) => {
+    const formatterValues = [
+      "TextInput",
+      "WorkStatus",
+      "RichText",
+      "Email",
+      "Phone",
+      "URL",
+      "Operator"
+    ];
+    let isformatter = false;
+    if (formatterValues.includes(formatterVal)) {
+      isformatter = true;
+    }
+    return isformatter;
+  };
+
+
+export const textFormatter = (formatter,value) => {
+  let displayComponent = 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;
+};
+
+
+
+// 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
+const PegaDxilMyPhone = props => {
+  const {
+    getPConnect,
+    value,
+    showCountryCode,
+    placeholder,
+    validatemessage,
+    label,
+    hideLabel,
+    helperText,
+    datasource,
+    testId,
+    displayMode,
+    additionalProps,
+    variant,
+    isTableFormatter,
+    hasSuggestions
+  } = props;
+  const { formatter } = props;
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = pConn.getStateProps().value;
+  const hasValueChange = useRef(false);
+
+ let callingCodesList = [];
+  if (datasource?.source?.length > 0) {
+    datasource.source.forEach((element) => {
+      callingCodesList.push(element.value);
+    });
+  } else {
+    callingCodesList = ['+1']; // if no datasource is present we default to show only US country code
+  }
+
+  // BUG-547602: Temporary type coercion for 8.5 until DXAPIs are enhanced to pass original pxViewMetadata JSON, respecting boolean primitives
+  let { readOnly, required, disabled } = props;
+  [readOnly, required, disabled] = [readOnly, required, disabled].map(
+    (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
+  );
+
+  const [inputValue, setInputValue] = useState(value);
+  useEffect(() => setInputValue(value), [value]);
+
+  const [status, setStatus] = useState(hasSuggestions ? 'pending' : undefined);
+  useEffect(() => {
+    if (validatemessage !== '') {
+      setStatus('error');
+    }
+    if (hasSuggestions) {
+      setStatus('pending');
+    } else if (!hasSuggestions && status !== 'success') {
+      setStatus(validatemessage !== '' ? 'error' : undefined);
+    }
+  }, [validatemessage, hasSuggestions]);
+
+  // funtion to exclude country code from phone number
+  function getPhoneNumberAlone(phoneNumber) {
+    const phoneNumberParts = getPhoneNumberParts(phoneNumber, callingCodesList);
+    return phoneNumberParts && phoneNumberParts[1];
+  }
+
+  function handleChangeBlur(enteredValue, eventType) {
+    if (!getPhoneNumberAlone(enteredValue)) {
+      enteredValue = '';
+    }
+    handleEvent(actions, eventType, propName, enteredValue);
+  }
+
+  let displayComp = null;
+  if (displayMode) {
+    displayComp = <PhoneDisplay value={value} variant='link' />;
+  }
+
+  if (displayMode === 'LABELS_LEFT' || displayMode === 'DISPLAY_ONLY') {
+    if (isTableFormatter && formatExists(formatter)) {
+      displayComp = textFormatter(formatter, value);
+    }
+    return displayMode === 'DISPLAY_ONLY' ? (
+      <StyledPegaDxilMyPhoneWrapper>
+      displayComp
+      </StyledPegaDxilMyPhoneWrapper>
+    ) : (
+      <StyledPegaDxilMyPhoneWrapper>
+      <FieldValueList
+        variant={hideLabel ? 'stacked' : variant}
+        data-testid={testId}
+        fields={[{ id: '1', name: hideLabel ? '' : label, value: displayComp }]}
+      />
+      </StyledPegaDxilMyPhoneWrapper>
+    );
+  }
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    return (
+      <StyledPegaDxilMyPhoneWrapper>
+      <FieldValueList
+        variant='stacked'
+        data-testid={testId}
+        fields={[
+          {
+            id: '2',
+            name: hideLabel ? '' : label,
+            value: (
+              <Text variant='h1' as='span'>
+                {displayComp}
+              </Text>
+            )
+          }
+        ]}
+      />
+      </StyledPegaDxilMyPhoneWrapper>
+    );
+  }
+
+  const onResolveSuggestionHandler = (accepted) => {
+    suggestionsHandler(accepted, pConn, setStatus);
+  };
+
+  return (
+    <StyledPegaDxilMyPhoneWrapper>
+    <CosmosPhone
+      {...additionalProps}
+      label={label}
+      info={validatemessage || helperText}
+      value={inputValue}
+      labelHidden={hideLabel}
+      status={status}
+      showCountryCode={showCountryCode}
+      callingCodesList={callingCodesList}
+      placeholder={placeholder}
+      disabled={disabled}
+      readOnly={readOnly}
+      required={required}
+      data-testid={testId}
+      onChange={(enteredValue) => {
+        if (hasSuggestions) {
+          setStatus(undefined);
+        }
+        setInputValue(enteredValue);
+        if (value !== enteredValue) {
+          handleEvent(actions, 'change', propName, enteredValue);
+        }
+        hasValueChange.current = true;
+      }}
+      onBlur={(enteredValue) => {
+        if (!value || hasValueChange.current) {
+          handleChangeBlur(enteredValue, 'blur');
+          if (hasSuggestions) {
+            pConn.ignoreSuggestion();
+          }
+          hasValueChange.current = false;
+        }
+      }}
+      onResolveSuggestion={onResolveSuggestionHandler}
+    />
+    </StyledPegaDxilMyPhoneWrapper>
+  );
+}
+
+PegaDxilMyPhone.defaultProps = {
+  value: '',
+  placeholder: '',
+  validatemessage: '',
+  helperText: '',
+  datasource: undefined,
+  hideLabel: false,
+  disabled: false,
+  readOnly: false,
+  required: false,
+  showCountryCode: true,
+  testId: null,
+  displayMode: null,
+  additionalProps: {},
+  variant: 'inline',
+  formatter: '',
+  isTableFormatter: false,
+  hasSuggestions: false
+};
+
+PegaDxilMyPhone.propTypes = {
+  value: PropTypes.string,
+  placeholder: PropTypes.string,
+  datasource: PropTypes.objectOf(PropTypes.any),
+  label: PropTypes.string.isRequired,
+  hideLabel: PropTypes.bool,
+  getPConnect: PropTypes.func.isRequired,
+  validatemessage: PropTypes.string,
+  helperText: PropTypes.string,
+  showCountryCode: PropTypes.bool,
+  disabled: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  readOnly: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  required: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  testId: PropTypes.string,
+  displayMode: PropTypes.string,
+  additionalProps: PropTypes.objectOf(PropTypes.any),
+  variant: PropTypes.string,
+  formatter: PropTypes.string,
+  isTableFormatter: PropTypes.bool,
+  hasSuggestions: PropTypes.bool
+};
+
+export default PegaDxilMyPhone;

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPhone/mock.stories.js

@@ -0,0 +1,37 @@
+export const configProps = {
+  value: '',
+  label: 'Phone Sample',
+  datasource: {
+    source: [
+      {
+        value: '+1'
+      },
+      {
+        value: '+91'
+      },
+      {
+        value: '+48'
+      },
+      {
+        value: '+44'
+      }
+    ],
+    fields: {}
+  },
+  showCountryCode: true,
+  placeholder: 'Phone Placeholder',
+  helperText: 'Phone Helper Text',
+  testId: 'phone-12345678',
+  hasSuggestions: false
+};
+
+export const stateProps = {
+  value: '.PhoneSample',
+  datasource: {
+    source: 'D_pyCountryCallingCodeList.pxResults',
+    fields: {
+      value: '.pyCallingCode'
+    }
+  },
+  hasSuggestions: false
+};

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPhone/styles.js

@@ -0,0 +1,14 @@
+// utilizing theming, comment out, if want individual style
+import styled from 'styled-components';
+import { Configuration } from '@pega/cosmos-react-core';
+
+export default styled(Configuration)``;
+
+// 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/components/createAll/Launchpad/Pega_DXIL_MyPhone/suggestions-handler.js

@@ -0,0 +1,10 @@
+/* eslint-disable import/prefer-default-export */
+export const suggestionsHandler = (accepted, pConn, setStatus) => {
+  if (accepted) {
+    pConn.acceptSuggestion();
+    setStatus('success');
+  } else {
+    pConn.ignoreSuggestion();
+    setStatus(undefined);
+  }
+};

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPicklist/config.json

@@ -0,0 +1,114 @@
+{
+  "name": "Pega_DXIL_MyPicklist",
+  "label": "My Picklist",
+  "description": "My Picklist",
+  "organization": "Pega",
+  "version": "0.0.1",
+  "library": "DXIL",
+  "allowedApplications": [],
+  "componentKey": "Pega_DXIL_MyPicklist",
+  "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"
+  }
+}

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPicklist/demo.stories.jsx

@@ -0,0 +1,78 @@
+import { useState } from 'react';
+import { withKnobs } from '@storybook/addon-knobs';
+
+import { configProps, rawMetadata, fieldMetadata, stateProps } from './mock.stories.js';
+
+import PegaDxilMyPicklist from './index.jsx';
+
+export default {
+  title: 'PegaDxilMyPicklist',
+  decorators: [withKnobs],
+  component: PegaDxilMyPicklist
+};
+
+export const basePegaDxilMyPicklist = () => {
+  // eslint-disable-next-line react-hooks/rules-of-hooks
+  const [value, setValue] = useState(configProps.value);
+
+  const props = {
+    value,
+    placeholder: configProps.placeholder,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    datasource: configProps.datasource,
+    testId: configProps.testId,
+    hasSuggestions: configProps.hasSuggestions,
+    fieldMetadata,
+
+    getPConnect: () => {
+      return {
+        getConfigProps: () => {
+          return configProps;
+        },
+        getStateProps: () => {
+          return stateProps;
+        },
+        getLocalizedValue: val => {
+          return val;
+        },
+        getLocaleRuleNameFromKeys: (localeClass, localeContext, localeName) => {
+          return `${localeClass}!${localeContext}!${localeName}`;
+        },
+        getCaseInfo: () => {
+          return {
+            getClassName: () => {
+              return 'DIXL-MediaCo-Work-NewService';
+            }
+          };
+        },
+        getRawMetadata: () => {
+          return rawMetadata;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: (propName, theValue) => {
+              setValue(theValue);
+            },
+            triggerFieldChange: () => {/* nothing */}
+          };
+        },
+        getValidationApi: () => {
+          return {
+            validate: () => {/* nothing */}
+          };
+        },
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        setInheritedProps: () => {/* nothing */},
+        resolveConfigProps: () => {/* nothing */}
+      };
+    }
+  };
+
+  return (
+    <>
+      <PegaDxilMyPicklist {...props} />
+    </>
+  );
+};

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPicklist/event-utils.js

@@ -0,0 +1,18 @@
+const handleEvent = (actions, eventType, propName, value) => {
+  switch (eventType) {
+    case "change":
+      actions.updateFieldValue(propName, value);
+      break;
+    case "blur":
+      actions.triggerFieldChange(propName, value);
+      break;
+    case "changeNblur":
+      actions.updateFieldValue(propName, value);
+      actions.triggerFieldChange(propName, value);
+      break;
+    default:
+      break;
+  }
+};
+
+export default handleEvent;