@pega/custom-dx-components 23.1.11 → 23.1.13

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDate/index.tsx

@@ -1,7 +1,6 @@
 import { useEffect, useState } from 'react';
-import { DateInput, FieldValueList, DateTimeDisplay, Text,  } from '@pega/cosmos-react-core';
-import PropTypes from 'prop-types';
-import FormattedText from "./FormattedText.jsx";
+import { DateInput, FieldValueList, DateTimeDisplay, Text, withConfiguration } from '@pega/cosmos-react-core';
+import FormattedText from "./FormattedText";
 
 import type { PConnFieldProps } from './PConnProps';
 
@@ -16,7 +15,7 @@ import {
   getMinDate,
   datetimeFireChangeBlurEvents,
   getDateFormat
-} from "./date.js";
+} from "./date";
 import { suggestionsHandler } from './suggestions-handler';
 import type { DateTimeFormat, DateTimeVariant } from '@pega/cosmos-react-core/lib/components/DateTime/DateTime.types.js';
 
@@ -42,7 +41,7 @@ interface StateProps {
 }
 
 interface ConfigProps {
-  formatter?: string;
+  formatter?: string | undefined;
 }
 
 interface ActionsProps {
@@ -53,33 +52,33 @@ interface ActionsProps {
 
 // 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 default function PegaDxilMyDate (props: PegaDxilMyDateProps)  {
+function PegaDxilMyDate (props: PegaDxilMyDateProps)  {
   const {
     getPConnect,
     value,
     validatemessage,
     label,
-    hideLabel,
-    helperText,
+    hideLabel = false,
+    helperText = '',
     nextYearRange,
     previousYearRange,
-    showWeekNumber,
+    showWeekNumber = false,
     testId,
-    showAsFormattedText,
-    additionalProps,
+    showAsFormattedText = false,
+    additionalProps = {},
     displayMode,
-    variant,
-    hasSuggestions
+    variant = 'inline',
+    hasSuggestions = false
    } = props;
 
-  let {formatter} = props;
+  let {formatter = 'defaultDate' } = props;
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
   const actionsProps = pConn.getActionsApi() as unknown as ActionsProps;
   const stateProps = pConn.getStateProps() as StateProps;
   const propName: string = stateProps.value;
 
- let { readOnly, required, disabled } = props;
+ let { readOnly = false, required = false, disabled = false } = props;
   [readOnly, required, disabled] = [readOnly, required, disabled].map(
     (prop) => prop === true || (typeof prop === "string" && prop === "true")
   );
@@ -156,13 +155,14 @@ export default function PegaDxilMyDate (props: PegaDxilMyDateProps)  {
         const runtimeformatter = configProps?.formatter;
 
         if (formatter !== runtimeformatter) {
-          formatter = runtimeformatter;
+          formatter = runtimeformatter!;
         }
      }
 
 
     if (formatter !== "" && formatExists(formatter)){
-        const {variantVal,formatVal} = datetimedisplayformatter(formatter);
+        // @ts-ignore
+        const {variantVal, formatVal} = datetimedisplayformatter(formatter);
         variantValue = variantVal;
         formatValue = formatVal;
     }
@@ -175,7 +175,7 @@ export default function PegaDxilMyDate (props: PegaDxilMyDateProps)  {
     );
     switch(displayMode){
       case 'DISPLAY_ONLY': {
-        return ( <StyledPegaDxilMyDateWrapper> displayComp </StyledPegaDxilMyDateWrapper>);
+        return ( <StyledPegaDxilMyDateWrapper> {displayComp} </StyledPegaDxilMyDateWrapper>);
       }
       case "LABELS_LEFT" : {
         return (
@@ -259,45 +259,4 @@ export default function PegaDxilMyDate (props: PegaDxilMyDateProps)  {
 }
 
 
-
-PegaDxilMyDate.defaultProps = {
-  value: undefined,
-  validatemessage: "",
-  helperText: "",
-  hideLabel: false,
-  disabled: false,
-  readOnly: false,
-  required: false,
-  showWeekNumber: false,
-  nextYearRange: "",
-  previousYearRange: "",
-  testId: "",
-  showAsFormattedText: false,
-  additionalProps: {},
-  displayMode: null,
-  variant: "inline",
-  formatter: "defaultDate",
-  hasSuggestions: false
-};
-
-PegaDxilMyDate.propTypes = {
-  value: PropTypes.string,
-  label: PropTypes.string.isRequired,
-  hideLabel: PropTypes.bool,
-  getPConnect: PropTypes.func.isRequired,
-  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]),
-  showWeekNumber: PropTypes.bool,
-  nextYearRange: PropTypes.string,
-  previousYearRange: PropTypes.string,
-  testId: PropTypes.string,
-  showAsFormattedText: PropTypes.bool,
-  additionalProps: PropTypes.objectOf(PropTypes.any),
-  displayMode: PropTypes.string,
-  variant: PropTypes.string,
-  formatter: PropTypes.string,
-  hasSuggestions: PropTypes.bool
-};
+export default withConfiguration(PegaDxilMyDate);

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDate/mock.ts

@@ -16,7 +16,8 @@ export const configProps = {
   hasSuggestions: false,
   readOnly: false,
   required: false,
-  disabled: false
+  disabled: false,
+  status: ''
 };
 
 export const stateProps = {

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDate/styles.ts

@@ -1,15 +1,8 @@
-
-// 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;
-//  `;
-// });
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 0px 0;
+  `;
+});

package/tests/assets/components/createAll/{Launchpad/Pega_DXIL_MyDateTime/date-time.js → Constellation/Pega_DXIL_MyDateTime/date-time.ts}

@@ -13,8 +13,8 @@ const types = ["fromNow", "customFormat"];
 
 // value should be in ISO 8601 format.
 function DateFormatter(
-  value,
-  { type = types[1], format = "DD/MM/YYYY", tzone, fieldType } = {}
+  value : any,
+  { type = types[1], format = "DD/MM/YYYY", tzone = null, fieldType = '' } = {}
 ) {
   if (!value) return value;
   switch (type) {
@@ -28,7 +28,7 @@ function DateFormatter(
   }
 }
 // value should be in hh:mm:ss format (00:00:00 - 23:59:59).
-function TimeFormatter(value, options) {
+function TimeFormatter(value: any, options: any) {
   if (!value) return value;
   const { locale = "en-US" } = options;
   const timeOnlyRegex = /^(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)$/;
@@ -46,7 +46,7 @@ function TimeFormatter(value, options) {
   return DateFormatter(value, options);
 }
 
-export const DateTimeShortFormatter = (value, options) => {
+export const DateTimeShortFormatter = (value: any, options: any) => {
   return DateFormatter(value, {
     ...options,
     type: "customFormat",
@@ -55,17 +55,17 @@ export const DateTimeShortFormatter = (value, options) => {
 }
 
 export default {
-  "DateTime-Long": (value, options) =>
+  "DateTime-Long": (value: any, options: any) =>
     DateFormatter(value, { ...options, type: "customFormat", format: "LLL" }),
   "DateTime-Short": DateTimeShortFormatter,
-  "DateTime-Since": (value) => DateFormatter(value, { type: "fromNow" }),
-  "Time-Only": (value, options) =>
+  "DateTime-Since": (value: any) => DateFormatter(value, { type: "fromNow" }),
+  "Time-Only": (value: any, options: any) =>
     TimeFormatter(value, {
       ...options,
       type: "customFormat",
       format: "hh:mm:ss A"
     }),
-  convertToTimezone: (value, options) => {
+  convertToTimezone: (value: any, options: any) => {
     return value && options && options.timezone
       ? DateFormatter(value, {
           ...options,
@@ -74,16 +74,16 @@ export default {
         })
       : value;
   },
-  convertFromTimezone: (value, tzone) =>
+  convertFromTimezone: (value: any, tzone: any) =>
   value && tzone
   ? dayjs.tz(value, tzone).utc().format("YYYY-MM-DDTHH:mm:ss[Z]")
   : value,
-  Date: (value, options) =>
+  Date: (value: any, options: any) =>
     DateFormatter(value, { type: "customFormat", ...options }),
   "Date-Default": DateTimeShortFormatter,
-  "Date-Time-Default": (value, options) =>
+  "Date-Time-Default": (value: any, options: any) =>
     DateFormatter(value, { ...options, type: "customFormat", format: "lll" }),
-  "Time-Default": (value, options) =>
+  "Time-Default": (value: any, options: any) =>
   TimeFormatter(value, {
     ...options,
     type: "customFormat",

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

@@ -0,0 +1,288 @@
+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);
+
+/**
+ * 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: string) => {
+  const momObj = dayjs(text);
+  if (momObj.isValid()) return momObj;
+  const timeStamp = text;
+  const isDateTime = timeStamp.includes("GMT");
+  const year = parseInt(timeStamp.substring(0, 4), 10);
+  const month = parseInt(timeStamp.substring(4, 2), 10) - 1;
+  const day = parseInt(timeStamp.substring(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.substring(9, 2), 10);
+    const minutes = parseInt(timeStamp.substring(11, 2), 10);
+    const seconds = parseInt(timeStamp.substring(13, 2), 10);
+    const ms = parseInt(timeStamp.substring(16, 3), 10);
+    mom.setUTCHours(hours);
+    mom.setUTCMinutes(minutes);
+    mom.setUTCSeconds(seconds);
+    mom.setUTCMilliseconds(ms);
+  }
+
+  // @ts-ignore
+  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: string) => {
+  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: string) =>
+  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: number, currentYear: number, yearFromValue: number) => {
+  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: number, currentYear: number, yearFromValue: number) => {
+  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: number) =>
+  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: string, withSeconds: boolean) => {
+  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: string, withSeconds: boolean) => {
+  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: string | undefined,
+  actualValue: string,
+  formattedValue: string,
+  actions: any,
+  propName: string,
+  pConn: any
+) => {
+
+  // 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: string, options: any) => {
+  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: string) => {
+  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: boolean, 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: boolean, is12h = false) => {
+  return {
+    year: "numeric",
+    month: "numeric",
+    day: "numeric",
+    ...getTimeOptions(withSeconds, is12h)
+  };
+};

package/{src/tasks/create/templates/Constellation/Field/DateTime/date.js.mustache → tests/assets/components/createAll/Constellation/Pega_DXIL_MyDateTime/date.ts}

@@ -1,3 +1,4 @@
+// @ts-nocheck
 import dayjs from 'dayjs';
 import relativeTime from 'dayjs/plugin/relativeTime.js';
 import localizedFormat from 'dayjs/plugin/localizedFormat.js';

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

@@ -1,16 +1,19 @@
-
 /* eslint-disable react/jsx-no-useless-fragment */
 // @ts-nocheck
-import { withKnobs } from '@storybook/addon-knobs';
+import type { Meta, StoryObj } from '@storybook/react';
 import { configProps, stateProps } from './mock';
 import PegaDxilMyDateTime from './index';
 
-export default {
+const meta: Meta<typeof PegaDxilMyDateTime> = {
   title: 'PegaDxilMyDateTime',
-  decorators: [withKnobs],
-  component: PegaDxilMyDateTime
+  component: PegaDxilMyDateTime,
+  excludeStories: /.*Data$/
 };
 
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyDateTime>;
+
+
 if (!window.PCore) {
   window.PCore = {};
 }
@@ -26,7 +29,7 @@ window.PCore.getEnvironmentInfo = () => {
   };
 };
 
-export const BasePegaDxilMyDateTime = () => {
+export const BasePegaDxilMyDateTime: Story = args => {
   const props = {
     getPConnect: () => {
       return {
@@ -73,7 +76,22 @@ export const BasePegaDxilMyDateTime = () => {
 
   return (
     <>
-      <PegaDxilMyDateTime {...props} />
+      <PegaDxilMyDateTime {...props} {...args} />
     </>
   );
 };
+
+BasePegaDxilMyDateTime.args = {
+  label: configProps.label,
+  helperText: configProps.helperText,
+  withSeconds: configProps.withSeconds,
+  showWeekNumber: configProps.showWeekNumber,
+  testId: configProps.testId,
+  readOnly: configProps.readOnly,
+  disabled: configProps.disabled,
+  required: configProps.required,
+  status: configProps.status,
+  hideLabel: configProps.hideLabel,
+  displayMode: configProps.displayMode,
+  validatemessage: configProps.validatemessage
+};