@pega/custom-dx-components 23.1.10 → 23.1.12

package/src/tasks/create/templates/Constellation/Field/DateTime/date.js.mustache

@@ -1,331 +0,0 @@
-/* eslint-disable no-undef */
-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);
-
-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)
-  };
-};

package/src/tasks/create/templates/Constellation/Field/DateTime/demo.stories.jsx.mustache

@@ -1,73 +0,0 @@
-import { withKnobs } from '@storybook/addon-knobs';
-import { configProps, stateProps } from './mock.stories';
-import {{COMPONENT_CLASS_NAME}} from './index.jsx';
-
-export default {
-  title: '{{COMPONENT_CLASS_NAME}}',
-  decorators: [withKnobs],
-  component: {{COMPONENT_CLASS_NAME}}
-};
-
-if (!window.PCore) {
-  window.PCore = {};
-}
-
-window.PCore.getEnvironmentInfo = () => {
-  return {
-    getTimeZone: () => {
-      return '';
-    }
-  };
-};
-
-export const base{{COMPONENT_CLASS_NAME}} = () => {
-  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,
-    withSeconds: configProps.withSeconds,
-    nextYearRange: configProps.nextYearRange,
-    previousYearRange: configProps.previousYearRange,
-    showWeekNumber: configProps.showWeekNumber,
-    testId: configProps.testId,
-    additionalProps: configProps.additionalProps,
-    displayMode: configProps.displayMode,
-    variant: configProps.variant,
-    hasSuggestions: configProps.hasSuggestions,
-    disabled: configProps.disabled,
-    readOnly: configProps.readOnly,
-    required: configProps.required
-  };
-
-  return (
-    <>
-      <{{COMPONENT_CLASS_NAME}} {...props} />
-    </>
-  );
-};

package/src/tasks/create/templates/Constellation/Field/DateTime/index.jsx.mustache

@@ -1,254 +0,0 @@
-/* eslint-disable no-undef */
-import { useEffect, useState } from 'react';
-import { DateTimeInput, FieldValueList, DateTimeDisplay, Text } from "@pega/cosmos-react-core";
-import PropTypes from "prop-types";
-
-// includes in bundle
-import DateTimeFormatter from "./date-time";
-import {datetimedisplayformatter,formatExists}   from "./date";
-import {
-  getFullYear,
-  getMaxDate,
-  getMinDate,
-  parseClockFormat,
-  correctDateTimeToSeconds,
-  datetimeFireChangeBlurEvents
-} from "./date-utils";
-import { suggestionsHandler } from './suggestions-handler';
-
-
-import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
-
-// Duplicated runtime code from Constellation Design System Component
-
-// 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
-const {{COMPONENT_CLASS_NAME}} = props => {
-  const {
-    getPConnect,
-    value,
-    validatemessage,
-    label,
-    hideLabel,
-    helperText,
-    withSeconds,
-    nextYearRange,
-    previousYearRange,
-    showWeekNumber,
-    pickerInterval,
-    testId,
-    additionalProps,
-    displayMode,
-    variant,
-    hasSuggestions
-  } = props;
-  let { formatter } = props;
-  const pConn = getPConnect();
-  const actions = pConn.getActionsApi();
-  const propName = pConn.getStateProps().value;
-
-  const environmentInfo = PCore.getEnvironmentInfo();
-  const timezone = environmentInfo && environmentInfo.getTimeZone();
-
-  let { readOnly, required, disabled } = props;
-  [readOnly, required, disabled] = [readOnly, required, disabled].map(
-    (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
-  );
-
-  const [status, setStatus] = useState(hasSuggestions ? 'pending' : '');
-
-  useEffect(() => {
-    if (validatemessage !== '') {
-      setStatus('error');
-    }
-    if (hasSuggestions) {
-      setStatus('pending');
-    } else if (!hasSuggestions && status !== 'success') {
-      setStatus(validatemessage !== '' ? 'error' : undefined);
-    }
-  }, [validatemessage, hasSuggestions]);
-
-  let { clockFormat } = props;
-  clockFormat = parseClockFormat(clockFormat);
-
-  // calculate min and max range of calendar
-  const currentYear = getFullYear();
-  const yearFromValue = getFullYear(value);
-  const maxDate = getMaxDate(parseInt(nextYearRange, 10), currentYear, yearFromValue);
-  const minDate = getMinDate(parseInt(previousYearRange, 10), currentYear, yearFromValue);
-
-  const onResolveSuggestionHandler = (accepted) => {
-    suggestionsHandler(accepted, pConn, setStatus);
-  };
-
-  function handleBlur(onBlurValue) {
-    const { valueAsISOString: datetimeTZ, state: errorState } = onBlurValue;
-    const datetimeGMT = DateTimeFormatter.convertFromTimezone(datetimeTZ, timezone);
-
-    const datetimeGMTCorrectedToSeconds = datetimeGMT
-      ? correctDateTimeToSeconds(datetimeGMT, withSeconds)
-      : datetimeGMT;
-
-    datetimeFireChangeBlurEvents(errorState, value, datetimeGMTCorrectedToSeconds, actions, propName, pConn);
-    const isValueChanged =
-      !(value === undefined && datetimeGMTCorrectedToSeconds === '') && value !== datetimeGMTCorrectedToSeconds;
-    if (hasSuggestions && isValueChanged) {
-      pConn.ignoreSuggestion();
-    }
-  }
-
-  function handleChange(onChangeValue) {
-    const { valueAsISOString: datetimeTZ } = onChangeValue;
-    const datetimeGMT = DateTimeFormatter.convertFromTimezone(datetimeTZ, timezone);
-    const datetimeGMTCorrectedToSeconds = datetimeGMT
-      ? correctDateTimeToSeconds(datetimeGMT, withSeconds)
-      : datetimeGMT;
-    if (hasSuggestions && value !== datetimeGMTCorrectedToSeconds) {
-      setStatus(undefined);
-    }
-    pConn.clearErrorMessages({
-      property: propName
-    });
-  }
-
-  if (displayMode === 'LABELS_LEFT' || displayMode === 'STACKED_LARGE_VAL' || displayMode === 'DISPLAY_ONLY') {
-    let variantValue = 'datetime';
-    let formatValue = withSeconds ? 'long' : 'short';
-    const runtimeformatter = pConn.getConfigProps()?.formatter;
-    if (formatter !== runtimeformatter) {
-      formatter = runtimeformatter;
-    }
-    if (formatExists(formatter)) {
-      const { variantVal, formatVal } = datetimedisplayformatter(formatter);
-      variantValue = variantVal;
-      formatValue = withSeconds && formatter === 'Time-Only' ? 'long' : formatVal;
-    }
-    const displayComp = (
-      <DateTimeDisplay
-        variant={variantValue}
-        format={formatValue}
-        value={
-          formatter === 'DateTime-Since' ? value : DateTimeFormatter.convertToTimezone(value, { timezone }) || undefined
-        }
-        clockFormat={clockFormat || undefined}
-      />
-    );
-    switch (displayMode) {
-      case 'DISPLAY_ONLY': {
-        return ( <Styled{{COMPONENT_CLASS_NAME}}Wrapper> displayComp </Styled{{COMPONENT_CLASS_NAME}}Wrapper>);
-      }
-      case 'LABELS_LEFT': {
-        return (
-          <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
-          <FieldValueList
-            variant={hideLabel ? 'stacked' : variant}
-            data-testid={testId}
-            fields={[{ id: '1', name: hideLabel ? '' : label, value: displayComp }]}
-          />
-          </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
-        );
-      }
-      case 'STACKED_LARGE_VAL': {
-        return (
-          <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
-          <FieldValueList
-            variant='stacked'
-            data-testid={testId}
-            fields={[
-              {
-                id: '2',
-                name: hideLabel ? '' : label,
-                value: (
-                  <Text variant='h1' as='span'>
-                    {displayComp}
-                  </Text>
-                )
-              }
-            ]}
-          />
-          </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
-        );
-      }
-      // no default
-    }
-  }
-
-
-  return (
-    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
-    <DateTimeInput
-      {...additionalProps}
-      label={label}
-      labelHidden={hideLabel}
-      info={validatemessage || helperText}
-      status={status}
-      value={DateTimeFormatter.convertToTimezone(value, { timezone }) || undefined}
-      withSeconds={withSeconds}
-      disabled={disabled}
-      readOnly={readOnly}
-      required={required}
-      pickerInterval={pickerInterval}
-      clockFormat={clockFormat || undefined}
-      showWeekNumber={showWeekNumber}
-      min={minDate}
-      max={maxDate}
-      data-testid={testId}
-      onFocus={actions.onFocus}
-      onChange={handleChange}
-      onBlur={handleBlur}
-      onResolveSuggestion={onResolveSuggestionHandler}
-    />
-    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
-  );
-}
-
-
-
-{{COMPONENT_CLASS_NAME}}.defaultProps = {
-  value: undefined,
-  withSeconds: false,
-  validatemessage: "",
-  helperText: "",
-  hideLabel: false,
-  disabled: false,
-  readOnly: false,
-  required: false,
-  pickerInterval: "30",
-  clockFormat: 0,
-  showWeekNumber: false,
-  nextYearRange: "",
-  previousYearRange: "",
-  testId: "",
-  additionalProps: {},
-  displayMode: null,
-  variant: "inline",
-  Format: "defaultDateTime",
-  hasSuggestions: false
-};
-
-{{COMPONENT_CLASS_NAME}}.propTypes = {
-  value: PropTypes.string,
-  label: PropTypes.string.isRequired,
-  hideLabel: PropTypes.bool,
-  withSeconds: 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]),
-  pickerInterval: PropTypes.string,
-  clockFormat: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
-  showWeekNumber: PropTypes.bool,
-  nextYearRange: PropTypes.string,
-  previousYearRange: PropTypes.string,
-  testId: PropTypes.string,
-  additionalProps: PropTypes.objectOf(PropTypes.any),
-  displayMode: PropTypes.string,
-  variant: PropTypes.string,
-  formatter: PropTypes.string,
-  Format: PropTypes.string,
-  hasSuggestions: PropTypes.bool
-};
-
-export default {{COMPONENT_CLASS_NAME}};

package/src/tasks/create/templates/Constellation/Field/DateTime/mock.stories.js.mustache

@@ -1,23 +0,0 @@
-export const configProps = {
-  value: '2023-01-24T16:45:00.000Z',
-  validatemessage: '',
-  label: 'DateTime Label',
-  hideLabel: false,
-  helperText: 'DateTime helper text',
-  withSeconds: false,
-  nextYearRange: '10',
-  previousYearRange: '5',
-  showWeekNumber: false,
-  testId: '12345678',
-  additionalProps: {},
-  displayMode: '',
-  variant: '',
-  hasSuggestions: false,
-  readOnly: false,
-  required: false,
-  disabled: false
-};
-
-export const stateProps = {
-  value: '.DateTimeLabel'
-};

package/src/tasks/create/templates/Constellation/Field/DateTime/styles.js.mustache

@@ -1,14 +0,0 @@
-// 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;
-//  `;
-// });

package/src/tasks/create/templates/Constellation/Field/DateTime/suggestions-handler.js

@@ -1,10 +0,0 @@
-/* eslint-disable import/prefer-default-export */
-export const suggestionsHandler = (accepted, pConn, setStatus) => {
-  if (accepted) {
-    pConn.acceptSuggestion();
-    setStatus('success');
-  } else {
-    pConn.ignoreSuggestion();
-    setStatus(undefined);
-  }
-};