@pega/custom-dx-components 0.23.20 → 0.23.21

package/src/tasks/create/templates/Constellation/Field/Picklist-RadioButtons/index.tsx.mustache

@@ -0,0 +1,243 @@
+/* eslint-disable no-nested-ternary */
+import { useMemo } from 'react';
+import PropTypes from 'prop-types';
+import { RadioButton, RadioButtonGroup } from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
+
+// includes in bundle
+import { formatExists, textFormatter } from './textformat-utils.jsx';
+import handleEvent from './event-utils';
+
+import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
+
+
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}Props 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;
+  align: string;
+}
+
+
+// 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
+export function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
+  const {
+    getPConnect,
+    value,
+    label,
+    hideLabel,
+    helperText,
+    datasource,
+    listType,
+    validatemessage,
+    align,
+    testId,
+    additionalProps,
+    displayMode,
+    inline,
+    placeholder,
+    fieldMetadata,
+    isTableFormatter
+  } = 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();
+  // @ts-ignore
+  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, required, disabled } = 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 = [];
+  const isDatapage = listType === 'datapage';
+  // @ts-ignore
+  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 (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    <RadioButtonGroup
+      {...additionalProps}
+      label={label}
+      labelHidden={hideLabel}
+      info={validatemessage || helperText}
+      inline={inline}
+      status={status}
+      data-testid={testId}
+      value={value}
+      required={required}
+      readOnly={readOnly}
+      onChange={(event) => {
+        // @ts-ignore
+        handleEvent(actions, 'changeNblur', propName, event.target.value);
+      }}
+      // @ts-ignore
+      onBlur={(event) => {
+        // @ts-ignore
+        pConn.getValidationApi().validate(event.target.value);
+      }}
+      align={align}
+      disabled={disabled}
+      className='standard'
+      name={fullReference}
+    >
+      {items}
+    </RadioButtonGroup>
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  );
+}
+
+
+{{COMPONENT_CLASS_NAME}}.defaultProps = {
+  value: '',
+  validatemessage: '',
+  helperText: '',
+  hideLabel: false,
+  disabled: false,
+  readOnly: false,
+  required: false,
+  align: 'vertical',
+  testId: '',
+  datasource: [],
+  listType: '',
+  additionalProps: {},
+  fieldMetadata: {},
+  displayMode: null,
+  inline: false,
+  placeholder: null,
+  formatter: '',
+  isTableFormatter: false
+};
+
+{{COMPONENT_CLASS_NAME}}.propTypes = {
+  getPConnect: PropTypes.func.isRequired,
+  value: PropTypes.string,
+  label: PropTypes.string.isRequired,
+  hideLabel: PropTypes.bool,
+  datasource: PropTypes.arrayOf(PropTypes.any),
+  listType: PropTypes.string,
+  validatemessage: PropTypes.string,
+  helperText: PropTypes.string,
+  disabled: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  readOnly: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  required: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  align: PropTypes.string,
+  testId: PropTypes.string,
+  additionalProps: PropTypes.objectOf(PropTypes.any),
+  fieldMetadata: PropTypes.objectOf(PropTypes.any),
+  displayMode: PropTypes.string,
+  inline: PropTypes.bool,
+  placeholder: PropTypes.string,
+  formatter: PropTypes.string,
+  isTableFormatter: PropTypes.bool
+};

package/src/tasks/create/templates/Constellation/Field/Picklist-RadioButtons/styles.ts.mustache

@@ -0,0 +1,15 @@
+
+// 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/src/tasks/create/templates/Constellation/Field/Picklist-RadioButtons/suggestions-handler.ts.mustache

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

package/src/tasks/create/templates/Constellation/Field/Picklist-RadioButtons/textformat-utils.jsx.mustache

@@ -0,0 +1,161 @@
+import { EmailDisplay, PhoneDisplay, URLDisplay, Image, Button, Lightbox } from '@pega/cosmos-react-core';
+import { useRef, useState } from 'react';
+
+export const formatExists = (formatterVal) => {
+  const formatterValues = ['TextInput', 'Email', 'Phone'];
+  let isformatter = false;
+  if (formatterValues.includes(formatterVal)) {
+    isformatter = true;
+  }
+  return isformatter;
+};
+
+const urlLabelVal = (urlLabelSelection, btnVal, urlLabel, propUrlLabel) => {
+  if ((urlLabel !== '' || propUrlLabel !== '') && btnVal !== null) {
+    switch (urlLabelSelection) {
+      case 'constant': {
+        btnVal = urlLabel;
+        break;
+      }
+      case 'propertyRef': {
+        btnVal = propUrlLabel;
+        break;
+      }
+      // no default
+    }
+  }
+  return btnVal;
+};
+
+const isImage = (url) => /\.(jpg|jpeg|png|webp|avif|gif|svg)$/.test(url);
+
+const TableImage = (imageProps) => {
+  const { value, altText, altTextOfImage, propaltTextOfImage, urlLabelSelection, urlLabel, propUrlLabel } = imageProps;
+  const demoButtonRef = useRef(null);
+  let imageDisplayComp = null;
+  const [images, setImages] = useState(null);
+  const imgDescription = {
+    id: 'url',
+    name: urlLabelSelection === 'constant' ? urlLabel : propUrlLabel,
+    description: altText === 'constant' ? altTextOfImage : propaltTextOfImage,
+    src: value
+  };
+  const onClick = () => {
+    setImages([imgDescription]);
+  };
+  const onItemDownload = async (id) => {
+    const a = document.createElement('a');
+    a.href = await fetch(images[0].src)
+      .then((response) => {
+        return response.blob();
+      })
+      .then((blob) => {
+        return URL.createObjectURL(blob);
+      });
+    a.download = images?.find((image) => image.id === id)?.name ?? id;
+    document.body.appendChild(a);
+    a.click();
+    document.body.removeChild(a);
+  };
+  let btnVal = value;
+  btnVal = urlLabelVal(urlLabelSelection, btnVal, urlLabel, propUrlLabel);
+  imageDisplayComp = (
+    <>
+      {btnVal !== null && (
+        <Button ref={demoButtonRef} variant='link' compact={false} onClick={onClick} autoFocus>
+          {btnVal}
+        </Button>
+      )}
+      {images && (
+        <Lightbox
+          items={images}
+          cycle={false}
+          onAfterClose={() => {
+            setImages(null);
+            demoButtonRef.current?.focus();
+          }}
+          onItemDownload={isImage(images[0].src) ? onItemDownload : undefined}
+        />
+      )}
+    </>
+  );
+  return imageDisplayComp;
+};
+
+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;
+    }
+    // no default
+  }
+  return displayComponent;
+};
+
+/**
+ * Returns a URL display component based on the options
+ * @function urlFormatter
+ * @param {string} value value
+ * @param {object} options options for formatting
+ * { displayAs,tableDisplayAs,isTableFormatter,altText,altTextOfImage,propaltTextOfImage,urlLabelSelection, urlLabel,propUrlLabel, widthSel, customWidth}
+ */
+export const urlFormatter = (value, options) => {
+  const {
+    displayAs,
+    tableDisplayAs,
+    isTableFormatter,
+    altText,
+    altTextOfImage,
+    propaltTextOfImage,
+    urlLabelSelection,
+    urlLabel,
+    propUrlLabel,
+    widthSel,
+    customWidth
+  } = options;
+
+  let urlFormatComp = null;
+  if (
+    (displayAs === 'labelText' || (isTableFormatter && tableDisplayAs === 'link')) &&
+    (urlLabel !== '' || propUrlLabel !== '')
+  ) {
+    urlFormatComp = (
+      <URLDisplay
+        target='_blank'
+        value={value}
+        displayText={urlLabelSelection === 'constant' ? urlLabel : propUrlLabel}
+        variant='link'
+      />
+    );
+  } else if ((displayAs === 'Image' || tableDisplayAs === 'Image') && !!value) {
+    if (isTableFormatter) {
+      urlFormatComp = TableImage({
+        value,
+        altText,
+        altTextOfImage,
+        propaltTextOfImage,
+        urlLabelSelection,
+        urlLabel,
+        propUrlLabel
+      });
+    } else {
+      const width = widthSel === 'widthpx' ? customWidth : null;
+      urlFormatComp = (
+        <Image src={value} width={width} alt={altText === 'constant' ? altTextOfImage : propaltTextOfImage} />
+      );
+    }
+  } else {
+    urlFormatComp = <URLDisplay target='_blank' value={value} displayText={value} variant='link' />;
+  }
+  return urlFormatComp;
+};

package/src/tasks/create/templates/Constellation/Field/Text/PConnProps.d.ts

@@ -0,0 +1,46 @@
+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/src/tasks/create/templates/Constellation/Field/Text/demo.stories.jsx.mustache

@@ -1,10 +1,10 @@
-/* eslint-disable import/no-relative-packages */
+
 /* eslint-disable storybook/prefer-pascal-case */
 /* eslint-disable react/jsx-no-useless-fragment */
 import { useState } from 'react';
 import { withKnobs } from '@storybook/addon-knobs';
 
-import { stateProps, configProps } from './mock.stories';
+import { stateProps, configProps } from './mock';
 
 import {{COMPONENT_CLASS_NAME}} from './index.jsx';
 
@@ -14,7 +14,7 @@ export default {
   component: {{COMPONENT_CLASS_NAME}}
 };
 
-export const base{{COMPONENT_CLASS_NAME}} = () => {
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
   // eslint-disable-next-line react-hooks/rules-of-hooks
   const [value, setValue] = useState(configProps.value);
 

package/src/tasks/create/templates/Constellation/Field/Text/{index.jsx.mustache → index.tsx.mustache}

@@ -1,22 +1,35 @@
-/* eslint-disable import/no-relative-packages */
 import PropTypes from 'prop-types';
 import { Input } from '@pega/cosmos-react-core';
 
+import type { PConnFieldProps } from './PConnProps';
+
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
 
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+
+}
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
 
 // 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 {{COMPONENT_CLASS_NAME}} = props => {
+export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
   const { getPConnect, value, placeholder, disabled, readOnly, required, label, hideLabel, testId } = props;
 
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
-  const propName = pConn?.getStateProps()?.value;
+  const stateProps = pConn.getStateProps() as StateProps;
+  let propName: string = stateProps.value;
 
-  const handleOnChange = event => {
+  const handleOnChange = (event: any) => {
     const { value: updatedValue } = event.target;
     actions.updateFieldValue(propName, updatedValue);
   };
@@ -58,5 +71,3 @@ const {{COMPONENT_CLASS_NAME}} = props => {
   required: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
   testId: PropTypes.string
 };
-
-export default {{COMPONENT_CLASS_NAME}};

package/src/tasks/create/templates/Constellation/Field/Text/styles.ts.mustache

@@ -0,0 +1,15 @@
+
+// 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/src/tasks/create/templates/Constellation/Field/Text-Email/PConnProps.d.ts

@@ -0,0 +1,46 @@
+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/src/tasks/create/templates/Constellation/Field/Text-Email/demo.stories.jsx.mustache

@@ -1,11 +1,11 @@
-/* eslint-disable import/no-relative-packages */
+
 /* eslint-disable storybook/prefer-pascal-case */
 /* eslint-disable react/jsx-no-useless-fragment */
 import { withKnobs } from '@storybook/addon-knobs';
 
 import {{COMPONENT_CLASS_NAME}} from './index.jsx';
 
-import { stateProps, configProps, fieldMetadata } from './mock.stories';
+import { stateProps, configProps, fieldMetadata } from './mock';
 
 export default {
   title: '{{COMPONENT_CLASS_NAME}}',
@@ -13,7 +13,7 @@ export default {
   component: {{COMPONENT_CLASS_NAME}}
 };
 
-export const base{{COMPONENT_CLASS_NAME}} = () => {
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
 
   const props = {
     value: configProps.value,

package/src/tasks/create/templates/Constellation/Field/Text-Email/event-utils.ts.mustache

@@ -0,0 +1,18 @@
+const handleEvent = (actions: any, eventType: string, propName: string, value: string) => {
+  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;