@pega/custom-dx-components 0.23.31 → 0.23.32

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/custom-dx-components",
-  "version": "0.23.31",
+  "version": "0.23.32",
   "description": "Utility for building custom UI components",
   "bin": "./bin/index.js",
   "scripts": {

package/src/tasks/init/template/.eslintrc.json

@@ -25,7 +25,10 @@
     "!.storybook",
     ".storybook/public",
     "**/demo.stories.jsx",
-    "/**/mock.stories.js"
+    "**/mock.stories.js",
+    "**/demo.stories.tsx",
+    "**/mock.stories.ts",
+    "**/*.mdx"
   ],
   "rules": {
     // Prettier recommends running separately from a linter.

package/src/tasks/init/template/package.json.mustache

@@ -69,7 +69,7 @@
   },
   "devDependencies": {
     "@pega/configs": "^0.6.0",
-    "@pega/custom-dx-components": "0.23.31",
+    "@pega/custom-dx-components": "0.23.32",
     "@pega/pcore-pconnect-typedefs": "2.0.0",
     "@storybook/addon-actions": "^7.6.7",
     "@storybook/addon-essentials": "^7.6.7",

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyAutocomplete/embed-utils.js

@@ -1,10 +1,4 @@
-import {
-  isEmbeddedField,
-  isPageListInPath,
-  PAGE,
-  PAGELIST,
-  buildAggOrCalcId
-} from './repeat-utils.js';
+import { isEmbeddedField, isPageListInPath, PAGE, PAGELIST, buildAggOrCalcId } from './repeat-utils.js';
 
 export const AT_FILTEREDLIST = '@FILTERED_LIST';
 export const AT_PROPERTY = '@P';
@@ -58,7 +52,7 @@ export function getEmbeddedFieldName(propertyName, classID) {
  * @param {Array} metaFields  Fields metadata Array. Contains metadata of all the fields.
  */
 export function updateMetaEmbeddedFieldID(metaFields) {
-  return metaFields.forEach(metaField => {
+  return metaFields.forEach((metaField) => {
     if (metaField.fieldID?.startsWith(PAGE) || metaField.fieldID?.startsWith(PAGELIST)) {
       metaField.fieldID = getFieldNameFromEmbeddedFieldName(metaField.fieldID);
     }
@@ -75,7 +69,7 @@ export function updateMetaEmbeddedFieldID(metaFields) {
  */
 export function getConfigEmbeddedFieldsMeta(configFields, classID) {
   const configEmbeddedFieldsMeta = [];
-  configFields.forEach(field => {
+  configFields.forEach((field) => {
     let value = field;
     if (isEmbeddedField(value)) {
       // conversion Page.PageList[].property => Page.PageList.property
@@ -99,8 +93,8 @@ export function getConfigEmbeddedFieldsMeta(configFields, classID) {
  */
 export function mergeConfigEmbeddedFieldsMeta(configEmbeddedFieldsMeta, metaFields) {
   const mergedMetaFields = [...metaFields];
-  configEmbeddedFieldsMeta.forEach(configFieldMeta => {
-    const fieldMeta = metaFields.find(metaField => metaField.fieldID === configFieldMeta.fieldID);
+  configEmbeddedFieldsMeta.forEach((configFieldMeta) => {
+    const fieldMeta = metaFields.find((metaField) => metaField.fieldID === configFieldMeta.fieldID);
     if (!fieldMeta) mergedMetaFields.push(configFieldMeta);
   });
   return mergedMetaFields;
@@ -158,7 +152,7 @@ export function preparePropertyValue(value) {
 // FIXME #EmbeddedPropertyPatch
 // TODO: Remove this utility when we have nested response for queryable pageList and supports scalarList component
 export function updatePageListFieldsConfig(configFields) {
-  return configFields.forEach(item => {
+  return configFields.forEach((item) => {
     if (item.type === 'ScalarList') {
       if (!item.config.originalValue) {
         item.config.originalValue = item.config.value;
@@ -172,7 +166,7 @@ export function updatePageListFieldsConfig(configFields) {
  * Update the renderer type for the properties of type Page.
  */
 export function updatePageFieldsConfig(configFields, parentClassID) {
-  return configFields.forEach(item => {
+  return configFields.forEach((item) => {
     const {
       type,
       config: { value }
@@ -262,7 +256,7 @@ export function preparePropertyMaps(fields, classID, context) {
 export function getPageListFields(fields) {
   const parentPaths = new Set();
   const pageListFields = [];
-  fields.forEach(field => {
+  fields.forEach((field) => {
     const { name } = field;
     if (isPageListProperty(name)) {
       const parentPath = name.substring(0, name.lastIndexOf(':'));
@@ -275,12 +269,7 @@ export function getPageListFields(fields) {
   return pageListFields;
 }
 
-export function mergePageListFieldAggregation(
-  pageListName,
-  select,
-  existingAggregations,
-  existingAggregationsName
-) {
+export function mergePageListFieldAggregation(pageListName, select, existingAggregations, existingAggregationsName) {
   // Build a dummy genericAggregationId to check if any type of aggregation for that pagelist is included in existing aggregations.
   const genericAggregationId = buildAggOrCalcId(pageListName, '');
   if (existingAggregationsName.includes(genericAggregationId)) {
@@ -295,7 +284,7 @@ export function mergePageListFieldsAggregation(fields, select, existingAggregati
   const parentPaths = new Set();
   const existingAggregationsName = Object.keys(existingAggregations).toString();
   const pageListFields = [];
-  fields.forEach(field => {
+  fields.forEach((field) => {
     const { name } = field;
     if (isPageListProperty(name)) {
       const parentPath = name.substring(0, name.lastIndexOf(':'));
@@ -317,5 +306,5 @@ export function mergePageListFieldsAggregation(fields, select, existingAggregati
  * @returns {object | undefined} value of first pageListProperty found
  */
 export function hasPageListProperty(fieldDefs) {
-  return fieldDefs?.find(field => isPageListProperty(field.name));
+  return fieldDefs?.find((field) => isPageListProperty(field.name));
 }

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDateTime/date-utils.js

@@ -1,4 +1,4 @@
-import dayjs from 'dayjs';
+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';
@@ -16,11 +16,11 @@ dayjs.extend(timezone);
  * @param {string} text datetime
  * @returns {object} datetime as a dayjs object
  */
-export const getDayJSObject = text => {
+export const getDayJSObject = (text) => {
   const momObj = dayjs(text);
   if (momObj.isValid()) return momObj;
   const timeStamp = text;
-  const isDateTime = timeStamp.indexOf('GMT') !== -1;
+  const isDateTime = timeStamp.indexOf("GMT") !== -1;
   const year = parseInt(timeStamp.substr(0, 4), 10);
   const month = parseInt(timeStamp.substr(4, 2), 10) - 1;
   const day = parseInt(timeStamp.substr(6, 2), 10);
@@ -46,7 +46,7 @@ export const getDayJSObject = text => {
   }
 
   mom = dayjs(
-    mom.toLocaleString('en-US', {
+    mom.toLocaleString("en-US", {
       timeZone: CurrentTz
     })
   );
@@ -60,8 +60,8 @@ export const getDayJSObject = text => {
  * @param {string} time datetime
  * @returns {object} relative time from now
  */
-export const getRelativeTime = time => {
-  let relativetime = '';
+export const getRelativeTime = (time) => {
+  let relativetime = "";
   if (dayjs(time).isUTC()) {
     relativetime = dayjs(time).fromNow();
   } else {
@@ -77,7 +77,7 @@ export const getRelativeTime = time => {
  * @param {string} value from which Year needs to be taken out
  * @returns {number} year for the date passed
  */
-export const getFullYear = value =>
+export const getFullYear = (value) =>
   value ? new Date(value).getFullYear() : new Date().getFullYear();
 
 /**
@@ -127,8 +127,8 @@ export const getMinDate = (previousYears, currentYear, yearFromValue) => {
  *
  * @returns {number} clockFormat
  */
-export const parseClockFormat = clockFormat =>
-  typeof clockFormat === 'string' ? parseInt(clockFormat, 10) : clockFormat;
+export const parseClockFormat = (clockFormat) =>
+  typeof clockFormat === "string" ? parseInt(clockFormat, 10) : clockFormat;
 
 /**
  * Return datetime value string off to seconds
@@ -140,9 +140,9 @@ export const parseClockFormat = clockFormat =>
  */
 export const correctDateTimeToSeconds = (datetime, withSeconds) => {
   if (withSeconds) {
-    return `${datetime.substring(0, datetime.indexOf('Z'))}.000Z`;
+    return `${datetime.substring(0, datetime.indexOf("Z"))}.000Z`;
   }
-  return `${datetime.substring(0, datetime.lastIndexOf(':'))}:00.000Z`;
+  return `${datetime.substring(0, datetime.lastIndexOf(":"))}:00.000Z`;
 };
 
 /**
@@ -155,9 +155,12 @@ export const correctDateTimeToSeconds = (datetime, withSeconds) => {
  */
 export const timeCorrectedToSeconds = (datetime, withSeconds) => {
   if (withSeconds) {
-    return datetime.substring(datetime.indexOf('T') + 1, datetime.indexOf('.'));
+    return datetime.substring(datetime.indexOf("T") + 1, datetime.indexOf("."));
   }
-  return `${datetime.substring(datetime.indexOf('T') + 1, datetime.lastIndexOf(':'))}:00`;
+  return `${datetime.substring(
+    datetime.indexOf("T") + 1,
+    datetime.lastIndexOf(":")
+  )}:00`;
 };
 
 /**
@@ -180,13 +183,14 @@ export const datetimeFireChangeBlurEvents = (
   propName,
   pConn
 ) => {
+
   // TODO - clean up, we should not rely on timestamp from cosmos to check InComplete validation
   // above triggerFieldChange should have validated this
   if (errorState) {
     pConn.getValidationApi().validate(errorState);
   }
   // BUG-640834 In errorState presist old values avoiding store update & re-render.
-  else {
+  else{
     if (formattedValue !== actualValue) {
       actions.updateFieldValue(propName, formattedValue);
     }
@@ -207,27 +211,27 @@ export const getDateFormat = (locale, options) => {
     .formatToParts()
     .map(({ type, value }) => {
       switch (type) {
-        case 'day':
-          return 'DD';
-        case 'month':
-          return 'MM';
-        case 'year':
-          return 'YYYY';
-        case 'hour':
-          return 'hh';
-        case 'minute':
-          return 'mm';
-        case 'second':
-          return 'ss';
-        case 'dayPeriod':
-          return 'A';
-        case 'literal':
+        case "day":
+          return "DD";
+        case "month":
+          return "MM";
+        case "year":
+          return "YYYY";
+        case "hour":
+          return "hh";
+        case "minute":
+          return "mm";
+        case "second":
+          return "ss";
+        case "dayPeriod":
+          return "A";
+        case "literal":
           return value;
         default:
-          return '';
+          return "";
       }
     })
-    .join('');
+    .join("");
 };
 
 /**
@@ -237,13 +241,15 @@ export const getDateFormat = (locale, options) => {
  * @returns {boolean} True or False for the locale
  * Example : getDateFormat("pl-PL") returns false
  */
-export const is12HClockFormat = locale => {
+export const is12HClockFormat = (locale) => {
   const meridiem = new Intl.DateTimeFormat(locale, {
-    hour: 'numeric'
+    hour: "numeric"
   })
     .formatToParts()
-    .find(({ type }) => type === 'dayPeriod');
-  return !!(meridiem === null || meridiem === undefined ? undefined : meridiem.value);
+    .find(({ type }) => type === "dayPeriod");
+  return !!(meridiem === null || meridiem === undefined
+    ? undefined
+    : meridiem.value);
 };
 
 /**
@@ -256,9 +262,9 @@ export const is12HClockFormat = locale => {
  */
 export const getTimeOptions = (withSeconds, is12h = false) => {
   return {
-    hour: 'numeric',
-    minute: 'numeric',
-    ...(withSeconds && { second: 'numeric' }),
+    hour: "numeric",
+    minute: "numeric",
+    ...(withSeconds && { second: "numeric" }),
     hour12: is12h
   };
 };
@@ -273,9 +279,9 @@ export const getTimeOptions = (withSeconds, is12h = false) => {
  */
 export const getDateTimeOptions = (withSeconds, is12h = false) => {
   return {
-    year: 'numeric',
-    month: 'numeric',
-    day: 'numeric',
+    year: "numeric",
+    month: "numeric",
+    day: "numeric",
     ...getTimeOptions(withSeconds, is12h)
   };
 };

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDateTime/date.js

@@ -9,26 +9,26 @@ dayjs.extend(localizedFormat);
 dayjs.extend(utc);
 dayjs.extend(timezone);
 
-export const datetimedisplayformatter = formatter => {
+export const datetimedisplayformatter = (formatter) => {
   const objectvalues = {};
   switch (formatter) {
-    case 'DateTime-Long': {
-      objectvalues.variantVal = 'datetime';
-      objectvalues.formatVal = 'long';
+    case "DateTime-Long": {
+      objectvalues.variantVal = "datetime";
+      objectvalues.formatVal = "long";
       break;
     }
-    case 'DateTime-Short': {
-      objectvalues.variantVal = 'date';
-      objectvalues.formatVal = 'short';
+    case "DateTime-Short": {
+      objectvalues.variantVal = "date";
+      objectvalues.formatVal = "short";
       break;
     }
-    case 'DateTime-Since': {
-      objectvalues.variantVal = 'relative';
+    case "DateTime-Since": {
+      objectvalues.variantVal = "relative";
       break;
     }
-    case 'Time-Only': {
-      objectvalues.variantVal = 'time';
-      objectvalues.formatVal = 'short';
+    case "Time-Only": {
+      objectvalues.variantVal = "time";
+      objectvalues.formatVal = "short";
       break;
     }
     // no default
@@ -36,8 +36,13 @@ export const datetimedisplayformatter = formatter => {
   return objectvalues;
 };
 
-export const formatExists = formatterVal => {
-  const formatterValues = ['DateTime-Long', 'DateTime-Short', 'DateTime-Since', 'Time-Only'];
+export const formatExists = (formatterVal) => {
+  const formatterValues = [
+    "DateTime-Long",
+    "DateTime-Short",
+    "DateTime-Since",
+    "Time-Only"
+  ];
   let isformatter = false;
   if (formatterValues.includes(formatterVal)) {
     isformatter = true;
@@ -45,6 +50,8 @@ export const formatExists = formatterVal => {
   return isformatter;
 };
 
+
+
 /**
  * Return relative time in fromNow for the given datetime
  * @description Convert and return the given datetime in dayJSObject
@@ -52,11 +59,11 @@ export const formatExists = formatterVal => {
  * @param {string} text datetime
  * @returns {object} datetime as a dayjs object
  */
-export const getDayJSObject = text => {
+export const getDayJSObject = (text) => {
   const momObj = dayjs(text);
   if (momObj.isValid()) return momObj;
   const timeStamp = text;
-  const isDateTime = timeStamp.indexOf('GMT') !== -1;
+  const isDateTime = timeStamp.indexOf("GMT") !== -1;
   const year = parseInt(timeStamp.substr(0, 4), 10);
   const month = parseInt(timeStamp.substr(4, 2), 10) - 1;
   const day = parseInt(timeStamp.substr(6, 2), 10);
@@ -82,7 +89,7 @@ export const getDayJSObject = text => {
   }
 
   mom = dayjs(
-    mom.toLocaleString('en-US', {
+    mom.toLocaleString("en-US", {
       timeZone: CurrentTz
     })
   );
@@ -96,8 +103,8 @@ export const getDayJSObject = text => {
  * @param {string} time datetime
  * @returns {object} relative time from now
  */
-export const getRelativeTime = time => {
-  let relativetime = '';
+export const getRelativeTime = (time) => {
+  let relativetime = "";
   if (dayjs(time).isUTC()) {
     relativetime = dayjs(time).fromNow();
   } else {
@@ -113,7 +120,7 @@ export const getRelativeTime = time => {
  * @param {string} value from which Year needs to be taken out
  * @returns {number} year for the date passed
  */
-export const getFullYear = value =>
+export const getFullYear = (value) =>
   value ? new Date(value).getFullYear() : new Date().getFullYear();
 
 /**
@@ -163,8 +170,8 @@ export const getMinDate = (previousYears, currentYear, yearFromValue) => {
  *
  * @returns {number} clockFormat
  */
-export const parseClockFormat = clockFormat =>
-  typeof clockFormat === 'string' ? parseInt(clockFormat, 10) : clockFormat;
+export const parseClockFormat = (clockFormat) =>
+  typeof clockFormat === "string" ? parseInt(clockFormat, 10) : clockFormat;
 
 /**
  * Return datetime value string off to seconds
@@ -176,9 +183,9 @@ export const parseClockFormat = clockFormat =>
  */
 export const correctDateTimeToSeconds = (datetime, withSeconds) => {
   if (withSeconds) {
-    return `${datetime.substring(0, datetime.indexOf('Z'))}.000Z`;
+    return `${datetime.substring(0, datetime.indexOf("Z"))}.000Z`;
   }
-  return `${datetime.substring(0, datetime.lastIndexOf(':'))}:00.000Z`;
+  return `${datetime.substring(0, datetime.lastIndexOf(":"))}:00.000Z`;
 };
 
 /**
@@ -191,9 +198,12 @@ export const correctDateTimeToSeconds = (datetime, withSeconds) => {
  */
 export const timeCorrectedToSeconds = (datetime, withSeconds) => {
   if (withSeconds) {
-    return datetime.substring(datetime.indexOf('T') + 1, datetime.indexOf('.'));
+    return datetime.substring(datetime.indexOf("T") + 1, datetime.indexOf("."));
   }
-  return `${datetime.substring(datetime.indexOf('T') + 1, datetime.lastIndexOf(':'))}:00`;
+  return `${datetime.substring(
+    datetime.indexOf("T") + 1,
+    datetime.lastIndexOf(":")
+  )}:00`;
 };
 
 /**
@@ -216,13 +226,14 @@ export const datetimeFireChangeBlurEvents = (
   propName,
   pConn
 ) => {
+
   // TODO - clean up, we should not rely on timestamp from cosmos to check InComplete validation
   // above triggerFieldChange should have validated this
   if (errorState) {
     pConn.getValidationApi().validate(errorState);
   }
   // BUG-640834 In errorState presist old values avoiding store update & re-render.
-  else {
+  else{
     if (formattedValue !== actualValue) {
       actions.updateFieldValue(propName, formattedValue);
     }
@@ -243,27 +254,27 @@ export const getDateFormat = (locale, options) => {
     .formatToParts()
     .map(({ type, value }) => {
       switch (type) {
-        case 'day':
-          return 'DD';
-        case 'month':
-          return 'MM';
-        case 'year':
-          return 'YYYY';
-        case 'hour':
-          return 'hh';
-        case 'minute':
-          return 'mm';
-        case 'second':
-          return 'ss';
-        case 'dayPeriod':
-          return 'A';
-        case 'literal':
+        case "day":
+          return "DD";
+        case "month":
+          return "MM";
+        case "year":
+          return "YYYY";
+        case "hour":
+          return "hh";
+        case "minute":
+          return "mm";
+        case "second":
+          return "ss";
+        case "dayPeriod":
+          return "A";
+        case "literal":
           return value;
         default:
-          return '';
+          return "";
       }
     })
-    .join('');
+    .join("");
 };
 
 /**
@@ -273,13 +284,15 @@ export const getDateFormat = (locale, options) => {
  * @returns {boolean} True or False for the locale
  * Example : getDateFormat("pl-PL") returns false
  */
-export const is12HClockFormat = locale => {
+export const is12HClockFormat = (locale) => {
   const meridiem = new Intl.DateTimeFormat(locale, {
-    hour: 'numeric'
+    hour: "numeric"
   })
     .formatToParts()
-    .find(({ type }) => type === 'dayPeriod');
-  return !!(meridiem === null || meridiem === undefined ? undefined : meridiem.value);
+    .find(({ type }) => type === "dayPeriod");
+  return !!(meridiem === null || meridiem === undefined
+    ? undefined
+    : meridiem.value);
 };
 
 /**
@@ -292,9 +305,9 @@ export const is12HClockFormat = locale => {
  */
 export const getTimeOptions = (withSeconds, is12h = false) => {
   return {
-    hour: 'numeric',
-    minute: 'numeric',
-    ...(withSeconds && { second: 'numeric' }),
+    hour: "numeric",
+    minute: "numeric",
+    ...(withSeconds && { second: "numeric" }),
     hour12: is12h
   };
 };
@@ -309,9 +322,9 @@ export const getTimeOptions = (withSeconds, is12h = false) => {
  */
 export const getDateTimeOptions = (withSeconds, is12h = false) => {
   return {
-    year: 'numeric',
-    month: 'numeric',
-    day: 'numeric',
+    year: "numeric",
+    month: "numeric",
+    day: "numeric",
     ...getTimeOptions(withSeconds, is12h)
   };
 };

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyPage/utils.js

@@ -17,15 +17,15 @@ export function getAllFields(pConnect) {
 
   let allFields = [];
 
-  const makeField = f => ({
+  const makeField = (f) => ({
     ...pConnect().resolveConfigProps(f.config),
     type: f.type
   });
 
   const hasRegions = !!metadata.children[0]?.children;
   if (hasRegions) {
-    allFields = metadata.children.map(region =>
-      region.children.map(field => {
+    allFields = metadata.children.map((region) =>
+      region.children.map((field) => {
         // Do not resolve the config props if is status work, instead create component here as status badge and mark as status display
         if (field.config?.value === '@P .pyStatusWork') {
           field.type = 'TextInput';
@@ -110,9 +110,7 @@ export function prepareComponentInCaseSummary(configObject, getPConnect, display
   // createdComponent.props.getPConnect().setInheritedProp("hideLabel", true);
   caseSummaryComponentObject.value = createdComponent;
   if (type === 'reference') {
-    caseSummaryComponentObject.name = createdComponent.props
-      .getPConnect()
-      .getInheritedProps().label;
+    caseSummaryComponentObject.name = createdComponent.props.getPConnect().getInheritedProps().label;
   }
 
   return caseSummaryComponentObject;
@@ -131,12 +129,12 @@ export function getFilteredFields(getPConnect) {
   }
 
   // Filter out fields that are not visible and unsupported types for primary fields (for CaseSummary)
-  primaryFieldsRaw = primaryFieldsRaw.filter(item => {
+  primaryFieldsRaw = primaryFieldsRaw.filter((item) => {
     const resolvedItem = getPConnect().resolveConfigProps(item.config);
     return resolvedItem.visibility !== false && item.type !== 'TextContent';
   });
 
-  secondaryFieldsRaw = secondaryFieldsRaw.filter(item => {
+  secondaryFieldsRaw = secondaryFieldsRaw.filter((item) => {
     const resolvedItem = getPConnect().resolveConfigProps(item.config);
     return resolvedItem.visibility !== false && item.type !== 'TextContent';
   });
@@ -163,9 +161,7 @@ export function getLayoutDataFromRegion(regionData) {
       const itemPConnect = item?.getPConnect();
 
       return {
-        id: itemPConnect?.getComponentName()
-          ? `${itemPConnect.getComponentName()}--${index}`
-          : `item--${index}`,
+        id: itemPConnect?.getComponentName() ? `${itemPConnect.getComponentName()}--${index}` : `item--${index}`,
         content: itemPConnect?.getComponent(),
         layoutConfig: {
           ...defaultLayoutConfig,
@@ -216,8 +212,9 @@ export function getInstructions(pConnect, instructions = 'casestep') {
 
   // If the annotation wasn't processed correctly, don't return any instruction text
   if (instructions?.startsWith('@PARAGRAPH')) {
+    /* eslint-disable no-console */
     console.error('@PARAGRAPH annotation was not processed. Hiding custom instructions.');
-
+    /* eslint-enable no-console */
     return undefined;
   }