@pega/custom-dx-components 23.1.10 → 23.1.12

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyRadioButtons/textformat-utils.tsx

@@ -0,0 +1,162 @@
+// @ts-nocheck
+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/tests/assets/components/createAll/Constellation/Pega_DXIL_MySearchbox/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/tests/assets/components/createAll/Constellation/Pega_DXIL_MySearchbox/component-constants.ts

@@ -0,0 +1,5 @@
+export default {
+  PROPERTY_REFERENCE: 'propertyRef',
+  WORK_BASKET: 'workbasket',
+  WORK_QUEUE: 'workqueue'
+};

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

@@ -0,0 +1,115 @@
+{
+  "name": "Pega_DXIL_MySearchbox",
+  "label": "My Search box",
+  "description": "My Search box",
+  "organization": "Pega",
+  "version": "0.0.1",
+  "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
+  }
+}

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MySearchbox/date.ts

@@ -0,0 +1,163 @@
+// @ts-nocheck
+import dayjs from 'dayjs';
+import relativeTime from 'dayjs/plugin/relativeTime.js';
+import localizedFormat from 'dayjs/plugin/localizedFormat.js';
+import utc from 'dayjs/plugin/utc.js';
+import tzone from 'dayjs/plugin/timezone.js';
+import { formatDateTime, parseToDate } from '@pega/cosmos-react-core';
+
+import formatConstants from './format-constants';
+
+dayjs.extend(relativeTime);
+dayjs.extend(localizedFormat);
+dayjs.extend(utc);
+dayjs.extend(tzone);
+
+export const COSMOS_FORMAT_CONSTANTS = {
+  SHORT: 'short',
+  LONG: 'long'
+};
+
+export const COSMOS_VARIANT_CONSTANTS = {
+  DATE_TIME: 'datetime',
+  DATE: 'date',
+  RELATIVE: 'relative',
+  TIME: 'time'
+};
+
+export const DATE_TYPES = {
+  DATE: 'date',
+  DATE_TIME: 'datetime',
+  TIME: 'time'
+};
+
+const constellationToCosmosFormatterMap = new Map([
+  [
+    DATE_TYPES.DATE,
+    new Map([
+      [
+        formatConstants.DateTimeLong,
+        { format: COSMOS_FORMAT_CONSTANTS.LONG, variant: COSMOS_VARIANT_CONSTANTS.DATE_TIME }
+      ],
+      [
+        formatConstants.DateTimeShort,
+        { format: COSMOS_FORMAT_CONSTANTS.SHORT, variant: COSMOS_VARIANT_CONSTANTS.DATE }
+      ],
+      [
+        formatConstants.DateTimeSince,
+        { format: COSMOS_FORMAT_CONSTANTS.SHORT, variant: COSMOS_VARIANT_CONSTANTS.RELATIVE }
+      ],
+      [formatConstants.DateDefault, { format: COSMOS_FORMAT_CONSTANTS.LONG, variant: COSMOS_VARIANT_CONSTANTS.DATE }]
+    ])
+  ],
+  [
+    DATE_TYPES.TIME,
+    new Map([
+      [formatConstants.TimeDefault, { format: COSMOS_FORMAT_CONSTANTS.SHORT, variant: COSMOS_VARIANT_CONSTANTS.TIME }],
+      [formatConstants.TimeOnly, { format: COSMOS_FORMAT_CONSTANTS.LONG, variant: COSMOS_VARIANT_CONSTANTS.TIME }]
+    ])
+  ],
+  [
+    DATE_TYPES.DATE_TIME,
+    new Map([
+      [
+        formatConstants.DateTimeDefault,
+        { format: COSMOS_FORMAT_CONSTANTS.SHORT, variant: COSMOS_VARIANT_CONSTANTS.DATE_TIME }
+      ],
+      [
+        formatConstants.DateTimeShort,
+        { format: COSMOS_FORMAT_CONSTANTS.SHORT, variant: COSMOS_VARIANT_CONSTANTS.DATE }
+      ],
+      [
+        formatConstants.DateTimeSince,
+        { format: COSMOS_FORMAT_CONSTANTS.SHORT, variant: COSMOS_VARIANT_CONSTANTS.RELATIVE }
+      ],
+      [
+        formatConstants.DateTimeLong,
+        { format: COSMOS_FORMAT_CONSTANTS.LONG, variant: COSMOS_VARIANT_CONSTANTS.DATE_TIME }
+      ],
+      [formatConstants.TimeOnly, { format: COSMOS_FORMAT_CONSTANTS.SHORT, variant: COSMOS_VARIANT_CONSTANTS.TIME }]
+    ])
+  ]
+]);
+const types = ['fromNow', 'customFormat'];
+
+// value should be in ISO 8601 format.
+function DateFormatter(
+  value,
+  // eslint-disable-next-line no-shadow, @typescript-eslint/no-shadow
+  { type = types[1], format = 'DD/MM/YYYY', timezone, fieldType } = {}) {
+  if (!value) return value;
+  switch (type) {
+    case types[1]:
+      if (timezone && !(fieldType === 'Date' || fieldType === 'Date only'))
+        return dayjs(value).tz(timezone).format(format); // Date only value should be formatted without timezone
+      return dayjs(value).format(format);
+    case types[0]:
+      return dayjs(value).from(dayjs());
+    default:
+      return value;
+  }
+}
+// value should be in hh:mm:ss format (00:00:00 - 23:59:59).
+// function TimeFormatter(value, options) {
+//   if (!value) return value;
+//   const { locale = 'en-US' } = options;
+//   const timeOnlyRegex = /^(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)$/;
+//   if (value.length === 8 && timeOnlyRegex.test(value)) {
+//     const { timeOptions = {} } = options;
+//     const tempDate = new Date();
+//     const hours = parseInt(value.substr(0, 2), 10);
+//     const minutes = parseInt(value.substr(3, 2), 10);
+//     const seconds = parseInt(value.substr(6, 2), 10);
+//     tempDate.setHours(hours);
+//     tempDate.setMinutes(minutes);
+//     tempDate.setSeconds(seconds);
+//     return tempDate.toLocaleTimeString(locale, timeOptions);
+//   }
+//   return DateFormatter(value, options);
+// }
+
+// function DateTimeShortFormatter(value, options) {
+//   return DateFormatter(value, {
+//     ...options,
+//     type: 'customFormat',
+//     format: 'MMM DD, YYYY'
+//   });
+// }
+
+export function format(value, options) {
+  if (!value) return null;
+  const { type, locale, timezone, formatter, translate } = options;
+  // eslint-disable-next-line no-shadow, @typescript-eslint/no-shadow
+  const { format, variant } = constellationToCosmosFormatterMap.get(type).get(formatter);
+  return formatDateTime(parseToDate(value), {
+    t: translate,
+    locale,
+    format,
+    variant,
+    timeZone: type === DATE_TYPES.DATE_TIME ? timezone : 'UTC'
+  });
+}
+
+export default {
+  'DateTime-Long': (value, options) => format(value, { ...options, formatter: 'DateTime-Long' }),
+  'DateTime-Short': (value, options) => format(value, { ...options, formatter: 'DateTime-Short' }),
+  'DateTime-Since': (value, options) => format(value, { ...options, formatter: 'DateTime-Since' }),
+  'Time-Only': (value, options) => format(value, { ...options, formatter: 'Time-Only' }),
+  convertToTimezone: (value, options) => {
+    return value && options && options.timezone
+      ? DateFormatter(value, {
+          ...options,
+          type: 'customFormat',
+          format: 'YYYY-MM-DDTHH:mm:ss'
+        })
+      : value;
+  },
+  convertFromTimezone: (value, timezone) =>
+    value && timezone ? dayjs.tz(value, timezone).utc().format('YYYY-MM-DDTHH:mm:ss[Z]') : value,
+  Date: (value, options) => DateFormatter(value, { type: 'customFormat', ...options }),
+  'Date-Default': (value, options) => format(value, { ...options, formatter: 'Date-Default' }),
+  'Date-Time-Default': (value, options) => format(value, { ...options, formatter: 'Date-Time-Default' }),
+  'Time-Default': (value, options) => format(value, { ...options, formatter: 'Time-Default' })
+};

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

@@ -0,0 +1,108 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+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 => {
+
+  const [value, setValue] = useState(configProps.value);
+  const datasourceMetadata = fieldMetadata;
+
+  const props = {
+    value,
+    placeholder: configProps.placeholder,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    datasource: configProps.datasource,
+    testId: configProps.testId,
+    hasSuggestions: configProps.hasSuggestions,
+    columns: [],
+    isTableFormatter: false,
+    listType: 'associated',
+    parameters: {},
+    datasourceMetadata,
+    fieldMetadata,
+    validatemessage: '',
+    getPConnect: () => {
+      return {
+        getConfigProps: () => {
+          return configProps;
+        },
+        getStateProps: () => {
+          return stateProps;
+        },
+        getContextName: () => {
+          return 'app/primary_1';
+        },
+        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 (
+    <>
+      <PegaDxilMySearchbox {...props} {...args} />
+    </>
+  );
+};
+
+BasePegaDxilMySearchbox.args = {
+  label: configProps.label,
+  helperText: configProps.helperText,
+  placeholder: configProps.placeholder,
+  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
+};