@pega/dx-component-builder-sdk 0.23.10 → 0.23.11

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyDate/index.tsx

@@ -0,0 +1,303 @@
+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 type { PConnFieldProps } from './PConnProps';
+
+import StyledPegaDxilMyDateWrapper from './styles';
+
+// includes in bundle
+import {
+  datetimedisplayformatter,
+  formatExists,
+  getFullYear,
+  getMaxDate,
+  getMinDate,
+  datetimeFireChangeBlurEvents,
+  getDateFormat
+} from "./date.js";
+import { suggestionsHandler } from './suggestions-handler';
+import type { DateTimeFormat, DateTimeVariant } from '@pega/cosmos-react-core/lib/components/DateTime/DateTime.types.js';
+
+// interface for props
+interface PegaDxilMyDateProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  displayAsStatus?: boolean;
+  isTableFormatter?: boolean;
+  hasSuggestions?: boolean;
+  variant?: any;
+  formatter?: string;
+  withSeconds: boolean;
+  nextYearRange: string;
+  previousYearRange: string;
+  showWeekNumber: boolean;
+  showAsFormattedText: boolean;
+}
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
+
+interface ConfigProps {
+  formatter?: string;
+}
+
+interface ActionsProps {
+  onFocus: any;
+}
+
+// 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
+export default function PegaDxilMyDate (props: PegaDxilMyDateProps)  {
+  const {
+    getPConnect,
+    value,
+    validatemessage,
+    label,
+    hideLabel,
+    helperText,
+    nextYearRange,
+    previousYearRange,
+    showWeekNumber,
+    testId,
+    showAsFormattedText,
+    additionalProps,
+    displayMode,
+    variant,
+    hasSuggestions
+   } = props;
+
+  let {formatter} = 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;
+  [readOnly, required, disabled] = [readOnly, required, disabled].map(
+    (prop) => prop === true || (typeof prop === "string" && prop === "true")
+  );
+
+  const [status, setStatus] = useState(hasSuggestions ? 'pending' : '');
+
+  // cast status
+  let myStatus: 'success' | 'warning' | 'error' | 'pending';
+  // eslint-disable-next-line prefer-const
+  myStatus = status as 'success' | 'warning' | 'error' | 'pending';
+
+  useEffect(() => {
+    if (validatemessage !== '') {
+      setStatus('error');
+    }
+    if (hasSuggestions) {
+      setStatus('pending');
+    } else if (!hasSuggestions && myStatus !== 'success') {
+      // @ts-ignore
+      setStatus(validatemessage !== '' ? 'error' : undefined);
+    }
+  }, [validatemessage, hasSuggestions, myStatus]);
+
+  // calculate min and max range of calendar
+  // @ts-ignore
+  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: 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("");
+    }
+  }
+
+  function handleChange(onChangeValue: any) {
+    const { valueAsISOString: date } = onChangeValue;
+    const trimmedDate = date ? date.substring(0, date.indexOf('T')) : date;
+    if (hasSuggestions && value !== trimmedDate) {
+      setStatus("");
+    }
+    pConn.clearErrorMessages({
+      category: "",
+      property: propName,
+      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;
+        }
+     }
+
+
+    if (formatter !== "" && formatExists(formatter)){
+        const {variantVal,formatVal} = datetimedisplayformatter(formatter);
+        variantValue = variantVal;
+        formatValue = formatVal;
+    }
+    const displayComp = (
+      <DateTimeDisplay
+        variant={variantValue as DateTimeVariant}
+        format={formatValue as DateTimeFormat}
+        value={value}
+      />
+    );
+    switch(displayMode){
+      case 'DISPLAY_ONLY': {
+        return ( <StyledPegaDxilMyDateWrapper> displayComp </StyledPegaDxilMyDateWrapper>);
+      }
+      case "LABELS_LEFT" : {
+        return (
+          <StyledPegaDxilMyDateWrapper>
+          <FieldValueList
+            variant={hideLabel ? "stacked" : variant}
+            data-testid={testId}
+            fields={[{ id: '1', name: hideLabel ? "" :label, value: displayComp }]}
+          />
+          </StyledPegaDxilMyDateWrapper>
+
+        );
+      }
+      case "STACKED_LARGE_VAL" : {
+        return (
+          <StyledPegaDxilMyDateWrapper>
+          <FieldValueList
+            variant='stacked'
+            data-testid={testId}
+            fields={[{ id: '2', name: hideLabel ? "" :label, value: <Text variant='h1' as='span'>{displayComp}</Text> }]}
+          />
+          </StyledPegaDxilMyDateWrapper>
+
+        );
+      }
+      // no default
+    }
+  }
+
+
+  let dateComponent;
+
+  if (readOnly && showAsFormattedText) {
+    const environmentInfo = PCore.getEnvironmentInfo();
+    const locale = environmentInfo && environmentInfo.getLocale();
+    const textAdditionalProps = {
+      format: getDateFormat(locale as string, {}),
+      fieldType: 'Date'
+    };
+    dateComponent = (
+      <StyledPegaDxilMyDateWrapper>
+        <FormattedText
+          formatType='date'
+          value={value}
+          label={label}
+          hideLabel={hideLabel}
+          testId={testId}
+          additionalProps={textAdditionalProps}
+          // @ts-ignore
+          customFormat={getDateFormat(locale)}
+        />
+      </StyledPegaDxilMyDateWrapper>
+    );
+  } else {
+
+    dateComponent = (
+      <StyledPegaDxilMyDateWrapper>
+      <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}
+      />
+      </StyledPegaDxilMyDateWrapper>
+    );
+  }
+  return dateComponent;
+}
+
+
+
+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
+};

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyDate/mock.ts

@@ -0,0 +1,24 @@
+
+export const configProps = {
+  value: '2023-01-31T12:23:00.000Z',
+  validatemessage: '',
+  label: 'Date Label',
+  hideLabel: false,
+  helperText: 'Date helper text',
+  nextYearRange: '10',
+  previousYearRange: '10',
+  showWeekNumber: true,
+  testId: '12345678',
+  showAsFormattedText: true,
+  additionalProps: {},
+  displayMode: '',
+  variant: '',
+  hasSuggestions: false,
+  readOnly: false,
+  required: false,
+  disabled: false
+};
+
+export const stateProps = {
+  value: '.DateLabel'
+};

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyDate/styles.ts

@@ -0,0 +1,15 @@
+
+// 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/tests/assets/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyDate/suggestions-handler.ts

@@ -0,0 +1,9 @@
+export const suggestionsHandler = (accepted: boolean, pConn: any, setStatus: any) => {
+  if (accepted) {
+    pConn.acceptSuggestion();
+    setStatus('success');
+  } else {
+    pConn.ignoreSuggestion();
+    setStatus(undefined);
+  }
+};

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyDateTime/PConnProps.d.ts

@@ -0,0 +1,46 @@
+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
+//  expected to have a getPConnect extend its props (from BaseProps)
+//  such that every component will be expected to have a getPConnect() function
+//  that returns a PConnect object. (new/better way of doing .propTypes).
+//  This PConnProps can be extended to include other props that we know are in every component
+export interface PConnProps {
+  // getPConnect should exist for every C11n component. (add @ts-ignore in special cases where it isn't)
+  getPConnect: () => typeof PConnect;
+
+  // Allow any/all other key/value pairs in the BaseProps for now
+  //  TODO: refine which other props are always expected for various component
+  //    types and consider further interface "subclassing". For example, we may
+  //    want to create a "BasePropsForm" that gives guidance on required, readonly, etc.
+  //    and any other props that every Form component expects.
+  //    For example, see the PConnFieldProps below.
+  // NOTE: if you uncomment the line below, the PConnProps type will allow
+  //  otherwise undefined types to appear. This can be helpful for debugging
+  //  or when adding new components whose types aren't yet known.
+  // [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
+}

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyDateTime/date-time.js

@@ -0,0 +1,92 @@
+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, fieldType } = {}
+) {
+  if (!value) return value;
+  switch (type) {
+    case types[1]:
+      if (tzone && fieldType !== 'Date') return dayjs(value).tz(tzone).format(format); // Date only value should be formatted without timezone
+      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 { timeOptions = {} } = options;
+    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, timeOptions);
+  }
+  return DateFormatter(value, options);
+}
+
+export const DateTimeShortFormatter = (value, options) => {
+  return DateFormatter(value, {
+    ...options,
+    type: "customFormat",
+    format: "MMM DD, YYYY"
+  });
+}
+
+export default {
+  "DateTime-Long": (value, options) =>
+    DateFormatter(value, { ...options, type: "customFormat", format: "LLL" }),
+  "DateTime-Short": DateTimeShortFormatter,
+  "DateTime-Since": (value) => DateFormatter(value, { type: "fromNow" }),
+  "Time-Only": (value, options) =>
+    TimeFormatter(value, {
+      ...options,
+      type: "customFormat",
+      format: "hh:mm:ss A"
+    }),
+  convertToTimezone: (value, options) => {
+    return value && options && options.timezone
+      ? DateFormatter(value, {
+          ...options,
+          type: "customFormat",
+          format: "YYYY-MM-DDTHH:mm:ss"
+        })
+      : value;
+  },
+  convertFromTimezone: (value, tzone) =>
+  value && tzone
+  ? dayjs.tz(value, tzone).utc().format("YYYY-MM-DDTHH:mm:ss[Z]")
+  : value,
+  Date: (value, options) =>
+    DateFormatter(value, { type: "customFormat", ...options }),
+  "Date-Default": DateTimeShortFormatter,
+  "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"
+  })
+};