@pega/dx-component-builder-sdk 8.23.16 → 8.23.17

package/tests/assets/components/SDK-Angular/createAll/custom-constellation/field/Pega_DXIL_MyCurrency/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/SDK-Angular/createAll/custom-constellation/field/Pega_DXIL_MyDate/DateFormatter.js

@@ -0,0 +1,61 @@
+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 timezone from 'dayjs/plugin/timezone.js';
+
+dayjs.extend(relativeTime);
+dayjs.extend(localizedFormat);
+dayjs.extend(utc);
+dayjs.extend(timezone);
+
+const types = ['fromNow', 'customFormat'];
+
+
+
+// value should be in ISO 8601 format.
+function DateFormatter(
+  value,
+  { type = types[1], format = "DD/MM/YYYY", tzone } = {}
+) {
+  if (!value) return value;
+  switch (type) {
+    case types[1]:
+      if (tzone) return dayjs(value).tz(tzone).format(format);
+      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 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);
+  }
+  return DateFormatter(value, options);
+}
+
+export default {
+  Date: (value, options) => DateFormatter(value, { type: 'customFormat', ...options }),
+  'Date-Time-Default': (value, options) =>
+    DateFormatter(value, { ...options, type: 'customFormat', format: 'lll' }),
+  'Time-Default': (value, options) =>
+    TimeFormatter(value, {
+      ...options,
+      type: 'customFormat',
+      format: 'hh:mm A'
+    })
+};

package/tests/assets/components/SDK-Angular/createAll/custom-constellation/field/Pega_DXIL_MyDate/FormattedText.jsx

@@ -0,0 +1,41 @@
+import { FieldValueList } from '@pega/cosmos-react-core';
+import PropTypes from 'prop-types';
+
+import { format } from './date.js';
+
+export default function FormattedText(props) {
+  const { formatType, label, value, testId, hideLabel, variant, additionalProps } = props;
+
+  let text = value;
+
+  text = format(text, formatType, additionalProps);
+
+  const fields = [
+    {
+      id: label.toLowerCase(),
+      name: hideLabel ? '' : label,
+      value: text
+    }
+  ];
+  return <FieldValueList variant={variant} fields={fields} data-testid={testId} />;
+}
+
+FormattedText.defaultProps = {
+  formatType: 'none',
+  variant: 'stacked',
+  value: undefined,
+  label: '',
+  testId: null,
+  hideLabel: false,
+  additionalProps: {}
+};
+
+FormattedText.propTypes = {
+  formatType: PropTypes.string,
+  variant: PropTypes.oneOf(['inline', 'stacked']),
+  value: PropTypes.oneOfType([PropTypes.string, PropTypes.number, PropTypes.bool]),
+  label: PropTypes.string,
+  testId: PropTypes.string,
+  additionalProps: PropTypes.objectOf(PropTypes.any),
+  hideLabel: PropTypes.bool
+};

package/tests/assets/components/SDK-Angular/createAll/custom-constellation/field/Pega_DXIL_MyDate/date.js

@@ -0,0 +1,439 @@
+/* eslint-disable no-undef */
+import dayjs from 'dayjs';
+import DateFormatter from './DateFormatter.js';
+
+import relativeTime from 'dayjs/plugin/relativeTime.js';
+import localizedFormat from 'dayjs/plugin/localizedFormat.js';
+import utc from 'dayjs/plugin/utc.js';
+import timezone from 'dayjs/plugin/timezone.js';
+
+dayjs.extend(relativeTime);
+dayjs.extend(localizedFormat);
+dayjs.extend(utc);
+dayjs.extend(timezone);
+
+function isIsoDate(str) {
+  if (!/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z/.test(str)) return false;
+  const d = new Date(str);
+  return d.toISOString() === str;
+}
+
+function getDateObject(text) {
+  // TODO - cleanup formatters util functions as DX APIs are returning values per ISO std now.
+  const timeStamp = text.replace(/-/g, '');
+  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);
+
+  const date = new Date();
+
+  date.setDate(day);
+  date.setMonth(month);
+  date.setFullYear(year);
+
+  if (isDateTime) {
+    const hours = parseInt(timeStamp.substr(9, 2), 10);
+    const minutes = parseInt(timeStamp.substr(11, 2), 10);
+    const seconds = parseInt(timeStamp.substr(13, 2), 10);
+    const ms = parseInt(timeStamp.substr(16, 3), 10);
+    date.setHours(hours);
+    date.setMinutes(minutes);
+    date.setSeconds(seconds);
+    date.setMilliseconds(ms);
+  }
+
+  return date;
+}
+
+function parseDateInISO(value) {
+  const isMilliSeconds = new RegExp('^[0-9]+$').exec(value);
+  if (isMilliSeconds) {
+    const date = new Date(parseInt(value, 10));
+    return date.toISOString();
+  }
+
+  if (isIsoDate(value)) {
+    const date = new Date(value);
+    return date.toISOString();
+  }
+
+  return value ? getDateObject(value).toISOString() : value;
+}
+
+export default {
+  ...DateFormatter
+};
+
+export const datetimedisplayformatter = formatter => {
+  const objectvalues = {};
+  switch (formatter) {
+    case 'DateTime-Long': {
+      objectvalues.variantVal = 'datetime';
+      objectvalues.formatVal = 'long';
+      break;
+    }
+    case 'DateTime-Short': {
+      objectvalues.variantVal = 'date';
+      objectvalues.formatVal = 'short';
+      break;
+    }
+    case 'DateTime-Since': {
+      objectvalues.variantVal = 'relative';
+      break;
+    }
+    case 'Time-Only': {
+      objectvalues.variantVal = 'time';
+      objectvalues.formatVal = 'short';
+      break;
+    }
+    // no default
+  }
+  return objectvalues;
+};
+
+export const formatExists = formatterVal => {
+  const formatterValues = ['DateTime-Long', 'DateTime-Short', 'DateTime-Since', 'Time-Only'];
+  let isformatter = false;
+  if (formatterValues.includes(formatterVal)) {
+    isformatter = true;
+  }
+  return isformatter;
+};
+
+/**
+ * Return relative time in fromNow for the given datetime
+ * @description Convert and return the given datetime in dayJSObject
+ *
+ * @param {string} text datetime
+ * @returns {object} datetime as a dayjs object
+ */
+export const getDayJSObject = text => {
+  const momObj = dayjs(text);
+  if (momObj.isValid()) return momObj;
+  const timeStamp = text;
+  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);
+
+  const CurrentTz = PCore.getLocaleUtils().getTimeZoneInUse();
+
+  let mom = new Date();
+
+  mom.setUTCDate(day);
+  mom.setUTCMonth(month);
+  mom.setUTCFullYear(year);
+
+  /* istanbul ignore else */
+  if (isDateTime) {
+    const hours = parseInt(timeStamp.substr(9, 2), 10);
+    const minutes = parseInt(timeStamp.substr(11, 2), 10);
+    const seconds = parseInt(timeStamp.substr(13, 2), 10);
+    const ms = parseInt(timeStamp.substr(16, 3), 10);
+    mom.setUTCHours(hours);
+    mom.setUTCMinutes(minutes);
+    mom.setUTCSeconds(seconds);
+    mom.setUTCMilliseconds(ms);
+  }
+
+  mom = dayjs(
+    mom.toLocaleString('en-US', {
+      timeZone: CurrentTz
+    })
+  );
+
+  return mom;
+};
+
+/**
+ * Return relative time in fromNow for the given datetime
+ *
+ * @param {string} time datetime
+ * @returns {object} relative time from now
+ */
+export const getRelativeTime = time => {
+  let relativetime = '';
+  if (dayjs(time).isUTC()) {
+    relativetime = dayjs(time).fromNow();
+  } else {
+    const dayjstime = getDayJSObject(time);
+    relativetime = dayjs(dayjstime).fromNow();
+  }
+  return relativetime;
+};
+
+/**
+ * Return year for the date passed
+ *
+ * @param {string} value from which Year needs to be taken out
+ * @returns {number} year for the date passed
+ */
+export const getFullYear = value =>
+  value ? new Date(value).getFullYear() : new Date().getFullYear();
+
+/**
+ * Return maxDate for the date passed
+ *
+ * @param {number} nextYears next number of years
+ * @param {number} currentYear current year
+ * @param {number} yearFromValue year set on value in redux
+ *
+ * @returns {string} maxDate calculated based on inputs
+ */
+export const getMaxDate = (nextYears, currentYear, yearFromValue) => {
+  if (Number.isNaN(nextYears)) {
+    nextYears = 20;
+  }
+  let maxYear = currentYear + nextYears;
+  if (yearFromValue > maxYear) {
+    maxYear = yearFromValue;
+  }
+  return `${maxYear}-01-01`;
+};
+
+/**
+ * Return minDate for the date passed
+ *
+ * @param {number} previousYears previous number of years
+ * @param {number} currentYear current year
+ * @param {number} yearFromValue year set on value in redux
+ *
+ * @returns {string} minDate calculated based on inputs
+ */
+export const getMinDate = (previousYears, currentYear, yearFromValue) => {
+  if (Number.isNaN(previousYears)) {
+    previousYears = 100;
+  }
+  let minYear = currentYear - previousYears;
+  if (yearFromValue < minYear) {
+    minYear = yearFromValue;
+  }
+  return `${minYear}-12-31`;
+};
+
+/**
+ * Return clockFormat after parsing
+ *
+ * @param {number | string} clockFormat chosen by user
+ *
+ * @returns {number} clockFormat
+ */
+export const parseClockFormat = clockFormat =>
+  typeof clockFormat === 'string' ? parseInt(clockFormat, 10) : clockFormat;
+
+/**
+ * Return datetime value string off to seconds
+ *
+ * @param {string} datetime in ISO format
+ * @param {boolean} withSeconds to specify if seconds is needed or not
+ *
+ * @returns {string} datetime after stripping of ms and seconds if selected to
+ */
+export const correctDateTimeToSeconds = (datetime, withSeconds) => {
+  if (withSeconds) {
+    return `${datetime.substring(0, datetime.indexOf('Z'))}.000Z`;
+  }
+  return `${datetime.substring(0, datetime.lastIndexOf(':'))}:00.000Z`;
+};
+
+/**
+ * Return time value string off to seconds
+ *
+ * @param {string} datetime in ISO format
+ * @param {boolean} withSeconds to specify if seconds is needed or not
+ *
+ * @returns {string} just time after stripping of ms and seconds if selected to
+ */
+export const timeCorrectedToSeconds = (datetime, withSeconds) => {
+  if (withSeconds) {
+    return datetime.substring(datetime.indexOf('T') + 1, datetime.indexOf('.'));
+  }
+  return `${datetime.substring(datetime.indexOf('T') + 1, datetime.lastIndexOf(':'))}:00`;
+};
+
+/**
+ * This function handles the cosmos blur handler of DateTime components
+ *
+ * @param {string | undefined} errorState for the selected datetime value
+ * @param {string} actualValue present in redux
+ * @param {string} formattedValue retrieved by trimming ISO to just Date/Time, also applying timezone if DateTime
+ * @param {object} actions object which has fire and blur callbacks
+ * @param {string} propName name of the property bound
+ * @param {object} pConn component's PConnect object which is useful to invoke validationApi
+ *
+ * @returns {void}
+ */
+export const datetimeFireChangeBlurEvents = (
+  errorState,
+  actualValue,
+  formattedValue,
+  actions,
+  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 {
+    if (formattedValue !== actualValue) {
+      actions.updateFieldValue(propName, formattedValue);
+    }
+    actions.triggerFieldChange(propName, formattedValue);
+  }
+};
+
+/**
+ * Return Date format for the locale passed
+ *
+ * @param {string} locale locale string
+ * @param {object} options options for format string
+ * @returns {string} dateformat for the locale
+ * Example : getDateFormat("pl-PL") returns "DD.MM.YYYY"
+ */
+export const getDateFormat = (locale, options) => {
+  return new Intl.DateTimeFormat(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':
+          return value;
+        default:
+          return '';
+      }
+    })
+    .join('');
+};
+
+/**
+ * Return boolean for the locale passed to specify if locale uses 12 hour format
+ *
+ * @param {string} locale locale string
+ * @returns {boolean} True or False for the locale
+ * Example : getDateFormat("pl-PL") returns false
+ */
+export const is12HClockFormat = locale => {
+  const meridiem = new Intl.DateTimeFormat(locale, {
+    hour: 'numeric'
+  })
+    .formatToParts()
+    .find(({ type }) => type === 'dayPeriod');
+  return !!(meridiem === null || meridiem === undefined ? undefined : meridiem.value);
+};
+
+/**
+ * Return Option object for Time formatting
+ *
+ * @param {boolean} withSeconds true or false depending on seconds to be included
+ * @param {boolean} is12h 12 hour format
+ * @returns {object} options object time formatting
+ * Example : getTimeOptions(false, true) returns {hour: 'numeric',minute: 'numeric',hour12: true}
+ */
+export const getTimeOptions = (withSeconds, is12h = false) => {
+  return {
+    hour: 'numeric',
+    minute: 'numeric',
+    ...(withSeconds && { second: 'numeric' }),
+    hour12: is12h
+  };
+};
+
+/**
+ * Return Option object for Datetime formatting
+ *
+ * @param {boolean} withSeconds true or false depending on seconds to be included
+ * @param {boolean} is12h 12 hour format
+ * @returns {object} options object datetime formatting
+ * Example : getDateTimeOptions(false, true) returns {year: 'numeric',month: 'numeric',day: 'numeric',hour: 'numeric',minute: 'numeric',hour12: true}
+ */
+export const getDateTimeOptions = (withSeconds, is12h = false) => {
+  return {
+    year: 'numeric',
+    month: 'numeric',
+    day: 'numeric',
+    ...getTimeOptions(withSeconds, is12h)
+  };
+};
+
+export function getCurrentTimezone(tzone) {
+  if (tzone) return tzone;
+  return PCore?.getLocaleUtils?.().getTimeZoneInUse?.();
+}
+
+export function format(value, type, options) {
+  let formattedValue;
+
+  switch (type?.toLowerCase()) {
+    case 'currency': {
+      const defaultOptions = {
+        locale: getLocale(),
+        position: 'before',
+        decPlaces: 2
+      };
+      const params = { ...defaultOptions, ...options };
+      formattedValue = Currency.Currency(value, params);
+      break;
+    }
+
+    case 'decimal': {
+      const defaultOptions = { locale: getLocale(), decPlaces: 2 };
+      const params = { ...defaultOptions, ...options };
+      formattedValue = Currency.Decimal(value, params);
+      break;
+    }
+
+    case 'integer': {
+      const defaultOptions = { locale: getLocale() };
+      const params = { ...defaultOptions, ...options };
+      formattedValue = Currency.Integer(value, params);
+      break;
+    }
+
+    case 'date': {
+      const defaultOptions = {
+        format: 'MMM DD, YYYY',
+        timezone: getCurrentTimezone()
+      };
+      const params = { ...defaultOptions, ...options };
+      formattedValue = DateFormatter.Date(parseDateInISO(value), params);
+      break;
+    }
+
+    case 'datetime': {
+      const defaultOptions = {
+        format: 'MMM DD, YYYY h:mm A',
+        timezone: getCurrentTimezone()
+      };
+      const params = { ...defaultOptions, ...options };
+      formattedValue = DateFormatter.Date(parseDateInISO(value), params);
+      break;
+    }
+
+    case 'boolean':
+    case 'checkbox': {
+      formattedValue = Boolean.TrueFalse(value, { allowEmpty: false });
+      break;
+    }
+
+    default:
+      formattedValue = value;
+  }
+  return formattedValue;
+}

package/tests/assets/components/SDK-Angular/createAll/custom-constellation/field/Pega_DXIL_MyDate/demo.stories.jsx

@@ -0,0 +1,73 @@
+import { withKnobs } from '@storybook/addon-knobs';
+import { configProps, stateProps } from './mock.stories';
+import PegaDxilMyDate from './index.jsx';
+
+export default {
+  title: 'PegaDxilMyDate',
+  decorators: [withKnobs],
+  component: PegaDxilMyDate
+};
+
+if (!window.PCore) {
+  window.PCore = {};
+}
+
+window.PCore.getEnvironmentInfo = () => {
+  return {
+    getLocale: () => {
+      return 'en-GB';
+    }
+  };
+};
+
+export const basePegaDxilMyDate = () => {
+  const props = {
+    getPConnect: () => {
+      return {
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {/* nothing */},
+            triggerFieldChange: () => {/* nothing */}
+          };
+        },
+        getValidationApi: () => {
+          return {
+            validate: () => {/* nothing */}
+          };
+        },
+        getStateProps: () => {
+          return stateProps;
+        },
+        getConfigProps: () => {
+          return configProps;
+        },
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        clearErrorMessages: () => {/* nothing */}
+      };
+    },
+    value: configProps.value,
+    validatemessage: configProps.validatemessage,
+    label: configProps.label,
+    hideLabel: configProps.hideLabel,
+    helperText: configProps.helperText,
+    nextYearRange: configProps.nextYearRange,
+    previousYearRange: configProps.previousYearRange,
+    showWeekNumber: configProps.showWeekNumber,
+    testId: configProps.testId,
+    showAsFormattedText: configProps.showAsFormattedText,
+    additionalProps: configProps.additionalProps,
+    displayMode: configProps.displayMode,
+    variant: configProps.variant,
+    hasSuggestions: configProps.hasSuggestions,
+    disabled: configProps.disabled,
+    readOnly: configProps.readOnly,
+    required: configProps.required
+  };
+
+  return (
+    <>
+      <PegaDxilMyDate {...props} />
+    </>
+  );
+};