@pega/dx-component-builder-sdk 25.1.16 → 25.1.17

package/src/tasks/create/templates/Constellation/field/Date/index.tsx.mustache

@@ -1,6 +1,6 @@
 import { useEffect, useState } from 'react';
 import { DateInput, FieldValueList, DateTimeDisplay, Text, withConfiguration } from '@pega/cosmos-react-core';
-import FormattedText from "./FormattedText";
+import FormattedText from './FormattedText';
 
 import type { PConnFieldProps } from './PConnProps';
 import './create-nonce';
@@ -8,15 +8,7 @@ import './create-nonce';
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
 
 // includes in bundle
-import {
-  datetimedisplayformatter,
-  formatExists,
-  getFullYear,
-  getMaxDate,
-  getMinDate,
-  datetimeFireChangeBlurEvents,
-  getDateFormat
-} from "./date";
+import { datetimedisplayformatter, formatExists, getFullYear, getMaxDate, getMinDate, datetimeFireChangeBlurEvents, getDateFormat } from './date';
 import { suggestionsHandler } from './suggestions-handler';
 import type { DateTimeFormat, DateTimeVariant } from '@pega/cosmos-react-core/lib/components/DateTime/DateTime.types.js';
 
@@ -53,7 +45,7 @@ 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
-function {{COMPONENT_CLASS_NAME}} (props: {{COMPONENT_CLASS_NAME}}Props)  {
+function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
   const {
     getPConnect,
     value,
@@ -70,19 +62,17 @@ function {{COMPONENT_CLASS_NAME}} (props: {{COMPONENT_CLASS_NAME}}Props)  {
     displayMode,
     variant = 'inline',
     hasSuggestions = false
-   } = props;
+  } = props;
 
-  let {formatter = 'defaultDate' } = 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 = false, required = false, disabled = false } = props;
-  [readOnly, required, disabled] = [readOnly, required, disabled].map(
-    (prop) => prop === true || (typeof prop === "string" && prop === "true")
-  );
+  let { readOnly = false, required = false, disabled = false } = props;
+  [readOnly, required, disabled] = [readOnly, required, disabled].map(prop => prop === true || (typeof prop === 'string' && prop === 'true'));
 
   const [status, setStatus] = useState(hasSuggestions ? 'pending' : '');
 
@@ -107,30 +97,20 @@ function {{COMPONENT_CLASS_NAME}} (props: {{COMPONENT_CLASS_NAME}}Props)  {
   const currentYear = getFullYear(null);
 
   const yearFromValue = getFullYear(value);
-  const maxDate = getMaxDate(
-    parseInt(nextYearRange, 10),
-    currentYear,
-    yearFromValue
-  );
-  const minDate = getMinDate(
-    parseInt(previousYearRange, 10),
-    currentYear,
-    yearFromValue
-  );
+  const maxDate = getMaxDate(parseInt(nextYearRange, 10), currentYear, yearFromValue);
+  const minDate = getMinDate(parseInt(previousYearRange, 10), currentYear, yearFromValue);
 
   const onResolveSuggestionHandler = (accepted: boolean) => {
     suggestionsHandler(accepted, pConn, setStatus);
   };
 
-
-
   function handleBlur(onBlurValue: any) {
     const { valueAsISOString: date, state: errorState } = onBlurValue;
     const trimmedDate = date ? date.substring(0, date.indexOf('T')) : date;
     datetimeFireChangeBlurEvents(errorState, value, trimmedDate, actions, propName, pConn);
     const isValueChanged = !(value === undefined && trimmedDate === '') && value !== trimmedDate;
     if (hasSuggestions && isValueChanged) {
-      pConn.ignoreSuggestion("");
+      pConn.ignoreSuggestion('');
     }
   }
 
@@ -138,74 +118,74 @@ function {{COMPONENT_CLASS_NAME}} (props: {{COMPONENT_CLASS_NAME}}Props)  {
     const { valueAsISOString: date } = onChangeValue;
     const trimmedDate = date ? date.substring(0, date.indexOf('T')) : date;
     if (hasSuggestions && value !== trimmedDate) {
-      setStatus("");
+      setStatus('');
     }
     pConn.clearErrorMessages({
-      category: "",
+      category: '',
       property: propName,
-      context: ""
-    })
+      context: ''
+    });
   }
 
   if (displayMode === 'LABELS_LEFT' || displayMode === 'STACKED_LARGE_VAL' || displayMode === 'DISPLAY_ONLY') {
-     let variantValue = "date";
-     let formatValue = "long";
-     if (pConn && pConn.getConfigProps()){
-        const configProps = pConn.getConfigProps() as ConfigProps;
-        const runtimeformatter = configProps?.formatter;
-
-        if (formatter !== runtimeformatter) {
-          formatter = runtimeformatter!;
-        }
-     }
-
+    let variantValue = 'date';
+    let formatValue = 'long';
+    if (pConn && pConn.getConfigProps()) {
+      const configProps = pConn.getConfigProps() as ConfigProps;
+      const runtimeformatter = configProps?.formatter;
+
+      if (formatter !== runtimeformatter) {
+        formatter = runtimeformatter!;
+      }
+    }
 
-    if (formatter !== "" && formatExists(formatter)) {
-        // @ts-ignore
-        const {variantVal, formatVal} = datetimedisplayformatter(formatter);
-        variantValue = variantVal;
-        formatValue = formatVal;
+    if (formatter !== '' && formatExists(formatter)) {
+      // @ts-ignore
+      const { variantVal, formatVal } = datetimedisplayformatter(formatter);
+      variantValue = variantVal;
+      formatValue = formatVal;
     }
-    const displayComp = (
-      <DateTimeDisplay
-        variant={variantValue as DateTimeVariant}
-        format={formatValue as DateTimeFormat}
-        value={value}
-      />
-    );
-    switch(displayMode){
+    const displayComp = <DateTimeDisplay variant={variantValue as DateTimeVariant} format={formatValue as DateTimeFormat} value={value} />;
+    switch (displayMode) {
       case 'DISPLAY_ONLY': {
-        return ( <Styled{{COMPONENT_CLASS_NAME}}Wrapper> {displayComp} </Styled{{COMPONENT_CLASS_NAME}}Wrapper>);
+        return <Styled{{COMPONENT_CLASS_NAME}}Wrapper> {displayComp} </Styled{{COMPONENT_CLASS_NAME}}Wrapper>;
       }
-      case "LABELS_LEFT" : {
+      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 }]}
-          />
+            <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" : {
+      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> }]}
-          />
+            <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
     }
   }
 
-
   let dateComponent;
 
   if (readOnly && showAsFormattedText) {
@@ -218,7 +198,7 @@ function {{COMPONENT_CLASS_NAME}} (props: {{COMPONENT_CLASS_NAME}}Props)  {
     dateComponent = (
       <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
         <FormattedText
-          formatType='date'
+          formatType="date"
           value={value}
           label={label}
           hideLabel={hideLabel}
@@ -229,33 +209,31 @@ function {{COMPONENT_CLASS_NAME}} (props: {{COMPONENT_CLASS_NAME}}Props)  {
       </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
     );
   } else {
-
     dateComponent = (
       <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
-      <DateInput
-        {...additionalProps}
-        label={label}
-        labelHidden={hideLabel}
-        info={validatemessage || helperText}
-        status={status}
-        value={value || undefined}
-        disabled={disabled}
-        readOnly={readOnly}
-        required={required}
-        showWeekNumber={showWeekNumber}
-        min={minDate}
-        max={maxDate}
-        data-testid={testId}
-        onFocus={actionsProps.onFocus}
-        onChange={handleChange}
-        onBlur={handleBlur}
-        onResolveSuggestion={onResolveSuggestionHandler}
-      />
+        <DateInput
+          {...additionalProps}
+          label={label}
+          labelHidden={hideLabel}
+          info={validatemessage || helperText}
+          status={status}
+          value={value || undefined}
+          disabled={disabled}
+          readOnly={readOnly}
+          required={required}
+          showWeekNumber={showWeekNumber}
+          min={minDate}
+          max={maxDate}
+          data-testid={testId}
+          onFocus={actionsProps.onFocus}
+          onChange={handleChange}
+          onBlur={handleBlur}
+          onResolveSuggestion={onResolveSuggestionHandler}
+        />
       </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
     );
   }
   return dateComponent;
 }
 
-
 export default withConfiguration({{COMPONENT_CLASS_NAME}});

package/src/tasks/create/templates/Constellation/field/Date/mock.ts.mustache

@@ -1,4 +1,3 @@
-
 export const configProps = {
   value: '2023-01-31T12:23:00.000Z',
   validatemessage: '',

package/src/tasks/create/templates/Constellation/field/DateTime/PConnProps.d.ts.mustache

@@ -1,4 +1,4 @@
-import  {PConnect } from '@pega/pcore-pconnect-typedefs';
+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
@@ -22,25 +22,24 @@ export interface PConnProps {
   // [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
+  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/src/tasks/create/templates/Constellation/field/DateTime/date-time.ts.mustache

@@ -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';
@@ -9,13 +9,10 @@ dayjs.extend(localizedFormat);
 dayjs.extend(utc);
 dayjs.extend(timezone);
 
-const types = ["fromNow", "customFormat"];
+const types = ['fromNow', 'customFormat'];
 
 // value should be in ISO 8601 format.
-function DateFormatter(
-  value : any,
-  { type = types[1], format = "DD/MM/YYYY", tzone = null, fieldType = '' } = {}
-) {
+function DateFormatter(value: any, { type = types[1], format = 'DD/MM/YYYY', tzone = null, fieldType = '' } = {}) {
   if (!value) return value;
   switch (type) {
     case types[1]:
@@ -30,7 +27,7 @@ function DateFormatter(
 // value should be in hh:mm:ss format (00:00:00 - 23:59:59).
 function TimeFormatter(value: any, options: any) {
   if (!value) return value;
-  const { locale = "en-US" } = options;
+  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;
@@ -49,44 +46,38 @@ function TimeFormatter(value: any, options: any) {
 export const DateTimeShortFormatter = (value: any, options: any) => {
   return DateFormatter(value, {
     ...options,
-    type: "customFormat",
-    format: "MMM DD, YYYY"
+    type: 'customFormat',
+    format: 'MMM DD, YYYY'
   });
-}
+};
 
 export default {
-  "DateTime-Long": (value: any, options: any) =>
-    DateFormatter(value, { ...options, type: "customFormat", format: "LLL" }),
-  "DateTime-Short": DateTimeShortFormatter,
-  "DateTime-Since": (value: any) => DateFormatter(value, { type: "fromNow" }),
-  "Time-Only": (value: any, options: any) =>
+  'DateTime-Long': (value: any, options: any) => DateFormatter(value, { ...options, type: 'customFormat', format: 'LLL' }),
+  'DateTime-Short': DateTimeShortFormatter,
+  'DateTime-Since': (value: any) => DateFormatter(value, { type: 'fromNow' }),
+  'Time-Only': (value: any, options: any) =>
     TimeFormatter(value, {
       ...options,
-      type: "customFormat",
-      format: "hh:mm:ss A"
+      type: 'customFormat',
+      format: 'hh:mm:ss A'
     }),
   convertToTimezone: (value: any, options: any) => {
     return value && options && options.timezone
       ? DateFormatter(value, {
           ...options,
-          type: "customFormat",
-          format: "YYYY-MM-DDTHH:mm:ss"
+          type: 'customFormat',
+          format: 'YYYY-MM-DDTHH:mm:ss'
         })
       : value;
   },
-  convertFromTimezone: (value: any, tzone: any) =>
-  value && tzone
-  ? dayjs.tz(value, tzone).utc().format("YYYY-MM-DDTHH:mm:ss[Z]")
-  : value,
-  Date: (value: any, options: any) =>
-    DateFormatter(value, { type: "customFormat", ...options }),
-  "Date-Default": DateTimeShortFormatter,
-  "Date-Time-Default": (value: any, options: any) =>
-    DateFormatter(value, { ...options, type: "customFormat", format: "lll" }),
-  "Time-Default": (value: any, options: any) =>
-  TimeFormatter(value, {
-    ...options,
-    type: "customFormat",
-    format: "hh:mm A"
-  })
+  convertFromTimezone: (value: any, tzone: any) => (value && tzone ? dayjs.tz(value, tzone).utc().format('YYYY-MM-DDTHH:mm:ss[Z]') : value),
+  Date: (value: any, options: any) => DateFormatter(value, { type: 'customFormat', ...options }),
+  'Date-Default': DateTimeShortFormatter,
+  'Date-Time-Default': (value: any, options: any) => DateFormatter(value, { ...options, type: 'customFormat', format: 'lll' }),
+  'Time-Default': (value: any, options: any) =>
+    TimeFormatter(value, {
+      ...options,
+      type: 'customFormat',
+      format: 'hh:mm A'
+    })
 };

package/src/tasks/create/templates/Constellation/field/DateTime/date-utils.ts.mustache

@@ -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';
@@ -20,7 +20,7 @@ export const getDayJSObject = (text: string) => {
   const momObj = dayjs(text);
   if (momObj.isValid()) return momObj;
   const timeStamp = text;
-  const isDateTime = timeStamp.includes("GMT");
+  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);
@@ -47,7 +47,7 @@ export const getDayJSObject = (text: string) => {
 
   // @ts-ignore
   mom = dayjs(
-    mom.toLocaleString("en-US", {
+    mom.toLocaleString('en-US', {
       timeZone: CurrentTz
     })
   );
@@ -62,7 +62,7 @@ export const getDayJSObject = (text: string) => {
  * @returns {object} relative time from now
  */
 export const getRelativeTime = (time: string) => {
-  let relativetime = "";
+  let relativetime = '';
   if (dayjs(time).isUTC()) {
     relativetime = dayjs(time).fromNow();
   } else {
@@ -78,8 +78,7 @@ export const getRelativeTime = (time: string) => {
  * @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();
+export const getFullYear = (value: string) => (value ? new Date(value).getFullYear() : new Date().getFullYear());
 
 /**
  * Return maxDate for the date passed
@@ -128,8 +127,7 @@ export const getMinDate = (previousYears: number, currentYear: number, yearFromV
  *
  * @returns {number} clockFormat
  */
-export const parseClockFormat = (clockFormat: number) =>
-  typeof clockFormat === "string" ? parseInt(clockFormat, 10) : clockFormat;
+export const parseClockFormat = (clockFormat: number) => (typeof clockFormat === 'string' ? parseInt(clockFormat, 10) : clockFormat);
 
 /**
  * Return datetime value string off to seconds
@@ -141,9 +139,9 @@ export const parseClockFormat = (clockFormat: number) =>
  */
 export const correctDateTimeToSeconds = (datetime: string, withSeconds: boolean) => {
   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`;
 };
 
 /**
@@ -156,12 +154,9 @@ export const correctDateTimeToSeconds = (datetime: string, withSeconds: boolean)
  */
 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.indexOf('.'));
   }
-  return `${datetime.substring(
-    datetime.indexOf("T") + 1,
-    datetime.lastIndexOf(":")
-  )}:00`;
+  return `${datetime.substring(datetime.indexOf('T') + 1, datetime.lastIndexOf(':'))}:00`;
 };
 
 /**
@@ -184,14 +179,13 @@ export const datetimeFireChangeBlurEvents = (
   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{
+  else {
     if (formattedValue !== actualValue) {
       actions.updateFieldValue(propName, formattedValue);
     }
@@ -212,27 +206,27 @@ export const getDateFormat = (locale: string, options: any) => {
     .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('');
 };
 
 /**
@@ -244,13 +238,11 @@ export const getDateFormat = (locale: string, options: any) => {
  */
 export const is12HClockFormat = (locale: string) => {
   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);
 };
 
 /**
@@ -263,9 +255,9 @@ export const is12HClockFormat = (locale: string) => {
  */
 export const getTimeOptions = (withSeconds: boolean, is12h = false) => {
   return {
-    hour: "numeric",
-    minute: "numeric",
-    ...(withSeconds && { second: "numeric" }),
+    hour: 'numeric',
+    minute: 'numeric',
+    ...(withSeconds && { second: 'numeric' }),
     hour12: is12h
   };
 };
@@ -280,9 +272,9 @@ export const getTimeOptions = (withSeconds: boolean, is12h = false) => {
  */
 export const getDateTimeOptions = (withSeconds: boolean, is12h = false) => {
   return {
-    year: "numeric",
-    month: "numeric",
-    day: "numeric",
+    year: 'numeric',
+    month: 'numeric',
+    day: 'numeric',
     ...getTimeOptions(withSeconds, is12h)
   };
 };