@pega/custom-dx-components 8.8.20 → 23.1.11

package/src/tasks/create/templates/Constellation/Field/Picklist-Autocomplete/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/Picklist-Autocomplete/utils.ts.mustache

@@ -0,0 +1,218 @@
+import { useEffect, useRef } from 'react';
+import equal from 'fast-deep-equal';
+import get from 'lodash.get';
+
+import { getFieldNameFromEmbeddedFieldName } from './embed-utils.js';
+
+import { buildColumnForDisplayValue, setValuesToPropertyList } from './index';
+
+export function usePaginate() {
+  const paginatationProperties = useRef({
+    startIndex: 0,
+    endIndex: 50,
+    matchPosition: '',
+    totalRecords: []
+  });
+
+  useEffect(() => {
+    // clean up on unmount
+    return () => {
+      // @ts-ignore
+      paginatationProperties.current = null;
+    };
+  }, []);
+
+  const getInitialPaginatedRecords = (totalRecords: any, matchPosition: string) => {
+    const initialPaginatedRecords = totalRecords.slice(0, 50);
+    paginatationProperties.current.startIndex = 0;
+    paginatationProperties.current.endIndex = 50;
+    paginatationProperties.current.matchPosition = matchPosition;
+    paginatationProperties.current.totalRecords = totalRecords;
+    return initialPaginatedRecords;
+  };
+
+  const positionMatches = (text: string, searchText: string) => {
+    switch (paginatationProperties.current.matchPosition) {
+      case 'start':
+        return text.toLowerCase().startsWith(searchText.toLowerCase());
+      case 'contains':
+        return text.toLowerCase().includes(searchText.toLowerCase());
+      default:
+        return false;
+    }
+  };
+
+  const fetchData = (searchText: string, onScroll: boolean, columns = []) => {
+    let progressivePaginatedRecords;
+    paginatationProperties.current.startIndex += 50;
+    paginatationProperties.current.endIndex += 50;
+
+    if (searchText === '' || searchText === undefined || searchText === null) {
+      // paginate on entire resultset
+      progressivePaginatedRecords = paginatationProperties.current.totalRecords.slice(
+        paginatationProperties.current.startIndex,
+        paginatationProperties.current.endIndex
+      );
+    } else if (onScroll) {
+      // paginate on filtered resultset
+      // @ts-ignore
+      progressivePaginatedRecords = paginatationProperties.current.filteredRecords.slice(
+        paginatationProperties.current.startIndex,
+        paginatationProperties.current.endIndex
+      );
+    } else {
+      // @ts-ignore
+      const searchInSecondaryItem = columns.some(e => e.secondary && e.useForSearch);
+      // Filter the items and paginate on filtered resultset
+      const filteredRecords = paginatationProperties.current.totalRecords.filter(
+        filteritem =>
+          // @ts-ignore
+          (filteritem.primary && positionMatches(filteritem.primary, searchText)) ||
+          (searchInSecondaryItem &&
+            // @ts-ignore
+            filteritem.secondary &&
+            // @ts-ignore
+            filteritem.secondary.length > 0 &&
+            // @ts-ignore
+            filteritem.secondary.find(item => positionMatches(item, searchText)))
+      );
+      progressivePaginatedRecords = filteredRecords.slice(
+        paginatationProperties.current.startIndex,
+        paginatationProperties.current.endIndex
+      );
+      // @ts-ignore
+      paginatationProperties.current.filteredRecords = filteredRecords;
+    }
+    return progressivePaginatedRecords;
+  };
+
+  const resetIndexes = () => {
+    paginatationProperties.current.startIndex = -50;
+    paginatationProperties.current.endIndex = 0;
+  };
+
+  const hasMoreResults = (searchText: string) => {
+    if (searchText === '' || searchText === undefined || searchText === null) {
+      return (
+        paginatationProperties.current.startIndex + 50 <
+        paginatationProperties.current.totalRecords.length
+      );
+    }
+    return (
+      // @ts-ignore
+      paginatationProperties.current.startIndex + 50 <
+      // @ts-ignore
+      paginatationProperties.current.filteredRecords.length
+    );
+  };
+
+  return {
+    getInitialPaginatedRecords,
+    fetchData,
+    resetIndexes,
+    hasMoreResults
+  };
+}
+
+export function useDeepMemo(memoFn: any, key: any) {
+  const ref = useRef();
+  // @ts-ignore
+  if (!ref.current || !equal(key, ref.current.key)) {
+    // @ts-ignore
+    ref.current = { key, value: memoFn() };
+  }
+  // @ts-ignore
+  return ref.current.value;
+}
+
+export function useIsMount() {
+  const isMountRef = useRef(true);
+  useEffect(() => {
+    isMountRef.current = false;
+  }, []);
+  return isMountRef.current;
+}
+
+const transformSearchedItem = (
+  displayResponseData: any,
+  displayFieldMeta: any,
+  columnsWithSetProperty: any,
+  dataApiObj: any
+) => {
+  // @ts-ignore
+  return displayResponseData.map(entry => {
+    const secondaryArr: Array<any> = [];
+    const secondaryFieldValues: Array<any> = [];
+    // @ts-ignore
+    displayFieldMeta.current.secondary.forEach(col => {
+      if (!displayFieldMeta.hidden?.includes(col)) secondaryArr.push(entry[col]);
+      if (columnsWithSetProperty.includes(col)) {
+        if (dataApiObj.isQueryable) {
+          secondaryFieldValues.push(entry[col]);
+        } else {
+          secondaryFieldValues.push(get(entry, getFieldNameFromEmbeddedFieldName(col)));
+        }
+      }
+    });
+    return {
+      id: entry[displayFieldMeta.current.key],
+      primary: entry[displayFieldMeta.current.primary],
+      secondary: secondaryArr,
+      secondaryFieldValues
+    };
+  });
+};
+
+// @ts-ignore
+export const updatePropertiesForNewRecord = (
+  dataConfig: any,
+  contextName: any,
+  dataApiObj: any,
+  setDataApiObj: any,
+  displayFieldMeta: any,
+  c11nEnv: any,
+  columns: Array<any>,
+  actions: any,
+  newCaseId: string
+) => {
+  PCore.getDataApi()
+    .init(dataConfig, contextName)
+    .then(dataObj => {
+      setDataApiObj(dataObj);
+      buildColumnForDisplayValue(dataObj);
+      // SET matchPosition to EQUALS to return exact matching record
+      dataObj.matchPosition = 'equals';
+      dataObj
+        .fetchData(newCaseId)
+        // @ts-ignore
+        .then(displayResponse => {
+          let columnsWithSetProperty = [];
+          if (dataApiObj.columns) {
+            columnsWithSetProperty = dataApiObj.columns
+              // @ts-ignore
+              .filter(col => col.setProperty && col.setProperty !== 'Associated property')
+              // @ts-ignore
+              .map(col => col.value);
+          }
+          const displayResponseData = displayResponse.data || [];
+
+          const searchedItem = transformSearchedItem(
+            displayResponseData,
+            displayFieldMeta,
+            columnsWithSetProperty,
+            dataApiObj
+          );
+          setValuesToPropertyList(
+            searchedItem[0],
+            c11nEnv.getStateProps().value,
+            searchedItem[0],
+            columns,
+            actions
+          );
+        })
+        .finally(() => {
+          // RESET matchPosition
+          dataObj.matchPosition = dataConfig.matchPosition;
+        });
+    });
+};

package/src/tasks/create/templates/Constellation/Field/Picklist-RadioButtons/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/Picklist-RadioButtons/config.json.mustache

@@ -0,0 +1,113 @@
+{
+  "name": "{{COMPONENT_KEY}}",
+  "label": "{{COMPONENT_LABEL}}",
+  "description": "{{DESCRIPTION}}",
+  "organization": "{{ORGANIZATION}}",
+  "version": "{{VERSION}}",
+  "library": "{{LIBRARY}}",
+  "allowedApplications": {{{ALLOWEDAPPS}}},
+  "componentKey": "{{COMPONENT_KEY}}",
+  "type": "{{TYPE}}",
+  "subtype": {{{SUB_TYPE}}},
+  "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/src/tasks/create/templates/Constellation/Field/Picklist-RadioButtons/demo.stories.tsx.mustache

@@ -0,0 +1,85 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import { useState } from 'react';
+import { withKnobs } from '@storybook/addon-knobs';
+
+import { configProps, rawMetadata, fieldMetadata, stateProps } from './mock';
+
+import {{COMPONENT_CLASS_NAME}} from './index';
+
+export default {
+  title: '{{COMPONENT_CLASS_NAME}}',
+  decorators: [withKnobs],
+  component: {{COMPONENT_CLASS_NAME}}
+};
+
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
+
+  const [value, setValue] = useState(configProps.value);
+
+  const props = {
+    value,
+    align: 'vertical',
+    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;
+        },
+        getPageReference: () => {
+          return 'caseInfo.content';
+        },
+        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 (
+    <>
+      <{{COMPONENT_CLASS_NAME}} {...props} />
+    </>
+  );
+};

package/src/tasks/create/templates/Constellation/Field/Picklist-RadioButtons/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;