@pega/custom-dx-components 0.0.1 → 0.8.1

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

@@ -0,0 +1,256 @@
+/* eslint-disable no-undef */
+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 Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
+
+// includes in bundle
+import {
+  datetimedisplayformatter,
+  formatExists,
+  getFullYear,
+  getMaxDate,
+  getMinDate,
+  datetimeFireChangeBlurEvents,
+  getDateFormat
+} from "./date.js";
+import { suggestionsHandler } from './suggestions-handler';
+
+// 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,
+    nextYearRange,
+    previousYearRange,
+    showWeekNumber,
+    testId,
+    showAsFormattedText,
+    additionalProps,
+    displayMode,
+    variant,
+    hasSuggestions
+   } = props;
+
+  let {formatter} = props;
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = pConn?.getStateProps()?.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' : '');
+
+  useEffect(() => {
+    if (validatemessage !== '') {
+      setStatus('error');
+    }
+    if (hasSuggestions) {
+      setStatus('pending');
+    } else if (!hasSuggestions && status !== 'success') {
+      setStatus(validatemessage !== '' ? 'error' : undefined);
+    }
+  }, [validatemessage, hasSuggestions]);
+
+  // 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: 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) {
+    const { valueAsISOString: date } = onChangeValue;
+    const trimmedDate = date ? date.substring(0, date.indexOf('T')) : date;
+    if (hasSuggestions && value !== trimmedDate) {
+      setStatus(undefined);
+    }
+    pConn.clearErrorMessages({
+      property: propName
+    })
+  }
+
+  if (displayMode === 'LABELS_LEFT' || displayMode === 'STACKED_LARGE_VAL' || displayMode === 'DISPLAY_ONLY') {
+    let variantValue = "date";
+     let formatValue = "long";
+     if(pConn && pConn.getConfigProps()){
+      const runtimeformatter = pConn.getConfigProps()?.formatter;
+      if(formatter !== runtimeformatter){
+        formatter = runtimeformatter;
+      }
+    }
+     if(formatter !== "" && formatExists(formatter)){
+      const {variantVal,formatVal} = datetimedisplayformatter(formatter);
+       variantValue = variantVal;
+       formatValue = formatVal;
+    }
+    const displayComp = (
+      <DateTimeDisplay
+      variant={variantValue}
+      format={formatValue}
+        value={value}
+      />
+    );
+    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
+    }
+  }
+
+
+  let dateComponent;
+
+  if (readOnly && showAsFormattedText) {
+    const environmentInfo = PCore.getEnvironmentInfo();
+    const locale = environmentInfo && environmentInfo.getLocale();
+    const textAdditionalProps = {
+      format: getDateFormat(locale),
+      fieldType: 'Date'
+    };
+    dateComponent = (
+      <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+      <FormattedText
+        formatType='date'
+        value={value}
+        label={label}
+        hideLabel={hideLabel}
+        testId={testId}
+        additionalProps={textAdditionalProps}
+        customFormat={getDateFormat(locale)}
+      />
+      </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={actions.onFocus}
+        onChange={handleChange}
+        onBlur={handleBlur}
+        onResolveSuggestion={onResolveSuggestionHandler}
+      />
+      </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    );
+  }
+  return dateComponent;
+}
+
+
+
+{{COMPONENT_CLASS_NAME}}.defaultProps = {
+  value: undefined,
+  validatemessage: "",
+  helperText: "",
+  hideLabel: false,
+  disabled: false,
+  readOnly: false,
+  required: false,
+  showWeekNumber: false,
+  nextYearRange: "",
+  previousYearRange: "",
+  testId: null,
+  showAsFormattedText: false,
+  additionalProps: {},
+  displayMode: null,
+  variant: "inline",
+  formatter: "defaultDate",
+  hasSuggestions: false
+};
+
+{{COMPONENT_CLASS_NAME}}.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 {{COMPONENT_CLASS_NAME}};

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

@@ -0,0 +1,23 @@
+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/src/tasks/create/templates/Constellation/Field/Date/styles.js.mustache

@@ -0,0 +1,14 @@
+// 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/Date/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/src/tasks/create/templates/Constellation/Field/DateTime/config.json.mustache

@@ -0,0 +1,256 @@
+{
+  "name": "{{COMPONENT_KEY}}",
+  "label": "{{COMPONENT_LABEL}}",
+  "description": "{{DESCRIPTION}}",
+  "organization": "{{ORGANIZATION}}",
+  "version": "{{VERSION}}",
+  "library": "{{LIBRARY}}",
+  "allowedApplications": {{{ALLOWEDAPPS}}},
+  "componentKey": "{{COMPONENT_KEY}}",
+  "type": "{{TYPE}}",
+  "subtype": {{{SUB_TYPE}}},
+  "icon": "images/pz-text-input-active.svg",
+  "properties": [
+    {
+      "name": "label",
+      "label": "Field label",
+      "format": "TEXT",
+      "required": true
+    },
+    {
+      "name": "readOnly",
+      "label": "Edit mode",
+      "format": "READONLY"
+    },
+    {
+      "format": "SELECT",
+      "name": "clockFormat",
+      "label": "Clock",
+      "defaultValue": "0",
+      "source": [
+        {
+          "key": "0",
+          "value": "use locale"
+        },
+        {
+          "key": "12",
+          "value": "12 hours"
+        },
+        {
+          "key": "24",
+          "value": "24 hours"
+        }
+      ]
+    },
+    {
+      "name": "withSeconds",
+      "label": "Display seconds",
+      "format": "BOOLEAN"
+    },
+    {
+      "label": "Column settings",
+      "format": "GROUP",
+      "visibility": "@VIEWTYPE == 'MultiRecordDisplayAsTable'",
+      "properties": [
+        {
+          "name": "columnWidth",
+          "label": "Column width",
+          "format": "SELECT",
+          "source": [
+            {
+              "key": "auto",
+              "value": "Auto"
+            },
+            {
+              "key": "custom",
+              "value": "Custom"
+            }
+          ]
+        },
+        {
+          "name": "width",
+          "label": "Width (px)",
+          "format": "NUMBER",
+          "visibility": "$this.columnWidth == 'custom'"
+        }
+      ]
+    },
+    {
+      "label": "Input settings",
+      "format": "GROUP",
+      "visibility": "(!readOnly = true)",
+      "properties": [
+        {
+          "format": "LABEL",
+          "label": "Year range",
+          "variant": "secondary"
+        },
+        {
+          "format": "INLINE",
+          "elements": [
+            {
+              "key": "next",
+              "format": "LABEL",
+              "label": "Next",
+              "variant": "secondary"
+            },
+            {
+              "key": "nextYears",
+              "format": "NUMBER",
+              "label": "",
+              "name": "nextYearRange",
+              "min": 0
+            },
+            {
+              "key": "year",
+              "format": "LABEL",
+              "label": "years",
+              "variant": "secondary"
+            }
+          ]
+        },
+        {
+          "format": "INLINE",
+          "elements": [
+            {
+              "key": "previous",
+              "format": "LABEL",
+              "label": "Previous",
+              "variant": "secondary"
+            },
+            {
+              "key": "previousYears",
+              "format": "NUMBER",
+              "label": "",
+              "name": "previousYearRange",
+              "min": 0
+            },
+            {
+              "key": "year",
+              "format": "LABEL",
+              "label": "years",
+              "variant": "secondary"
+            }
+          ]
+        },
+        {
+          "name": "showWeekNumber",
+          "label": "Display week numbers on calendar",
+          "format": "BOOLEAN"
+        },
+        {
+          "format": "SELECT",
+          "name": "pickerInterval",
+          "label": "Time picker",
+          "defaultValue": "30",
+          "source": [
+            {
+              "key": "5",
+              "value": "5 min"
+            },
+            {
+              "key": "10",
+              "value": "10 min"
+            },
+            {
+              "key": "15",
+              "value": "15 min"
+            },
+            {
+              "key": "20",
+              "value": "20 min"
+            },
+            {
+              "key": "30",
+              "value": "30 min"
+            },
+            {
+              "key": "60",
+              "value": "1 hr"
+            }
+          ]
+        },
+        {
+          "name": "helperText",
+          "label": "Helper text",
+          "format": "TEXT"
+        }
+      ]
+    },
+    {
+      "label": "Read-only settings",
+      "format": "GROUP",
+      "properties": [
+        {
+          "name": "showAsFormattedText",
+          "label": "Show as formatted text",
+          "format": "BOOLEAN"
+        },
+        {
+          "format": "SELECT",
+          "name": "formatter",
+          "label": "Format",
+          "defaultValue": "defaultDateTime",
+          "source": [
+            {
+              "key": "defaultDateTime",
+              "value": "Default"
+            },
+            {
+              "key": "DateTime-Short",
+              "value": "Date"
+            },
+            {
+              "key": "DateTime-Since",
+              "value": "Since"
+            },
+            {
+              "key": "Time-Only",
+              "value": "Time only"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "label": "Conditions",
+      "format": "GROUP",
+      "properties": [
+        {
+          "name": "required",
+          "label": "Required",
+          "format": "REQUIRED",
+          "visibility": "(!readOnly = true)"
+        },
+        {
+          "name": "disabled",
+          "label": "Disabled",
+          "format": "DISABLED",
+          "visibility": "(!readOnly = true)"
+        },
+        {
+          "name": "visibility",
+          "label": "Visibility",
+          "format": "VISIBILITY"
+        }
+      ]
+    },
+    {
+      "label": "Advanced",
+      "format": "GROUP",
+      "collapsible": true,
+      "properties": [
+        {
+          "name": "testId",
+          "label": "Test ID",
+          "format": "TEXT",
+          "ignorePattern": "[^-_\\p{N}\\p{L}]",
+          "includeAnnotations": false
+        }
+      ]
+    }
+  ],
+  "defaultConfig": {
+    "label": "@L $this.label"
+  }
+}

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

@@ -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"
+  })
+};