@pega/custom-dx-components 23.1.10 → 23.1.11

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

@@ -0,0 +1,298 @@
+import { useEffect, useState } from 'react';
+import { DateTimeInput, FieldValueList, DateTimeDisplay, Text } from "@pega/cosmos-react-core";
+import PropTypes from "prop-types";
+import type { PConnFieldProps } from './PConnProps';
+
+// 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';
+import type { DateTimeFormat, DateTimeVariant } from '@pega/cosmos-react-core/lib/components/DateTime/DateTime.types';
+import type { ClockFormat } from '@pega/cosmos-react-core/lib/components/DateTime/Input/utils';
+
+
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}Props 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;
+  pickerInterval: string;
+  clockFormat: number;
+}
+
+// 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 {{COMPONENT_CLASS_NAME}} (props: {{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 actionsProps = pConn.getActionsApi() as unknown as ActionsProps;
+  const stateProps = pConn.getStateProps() as StateProps;
+  const propName: string = stateProps.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' : undefined);
+
+  // 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') {
+      setStatus(validatemessage !== '' ? 'error' : undefined);
+    }
+  }, [validatemessage, hasSuggestions, myStatus]);
+
+  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: boolean) => {
+    suggestionsHandler(accepted, pConn, setStatus);
+  };
+
+  function handleBlur(onBlurValue: any) {
+    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: any) {
+    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({
+      category: "",
+      property: propName,
+      context: ""
+    });
+  }
+
+  if (displayMode === 'LABELS_LEFT' || displayMode === 'STACKED_LARGE_VAL' || displayMode === 'DISPLAY_ONLY') {
+    let variantValue = 'datetime' as DateTimeVariant;
+    let formatValue = withSeconds ? 'long' : 'short' as DateTimeFormat;
+
+    const configProps = pConn.getConfigProps() as ConfigProps;
+
+    const runtimeformatter = configProps?.formatter;
+
+    if (formatter !== runtimeformatter) {
+      formatter = runtimeformatter;
+    }
+    if (formatExists(formatter)) {
+      const { variantVal, formatVal } = datetimedisplayformatter(formatter);
+      variantValue = variantVal as DateTimeVariant;
+      formatValue = withSeconds && formatter === 'Time-Only' ? 'long' : formatVal as DateTimeFormat;
+    }
+    const displayComp = (
+      <DateTimeDisplay
+        variant={variantValue}
+        format={formatValue}
+        value={
+          formatter === 'DateTime-Since' ? value : DateTimeFormatter.convertToTimezone(value, { timezone }) || undefined
+        }
+        clockFormat={clockFormat as 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={actionsProps.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
+};

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

@@ -0,0 +1,25 @@
+
+// @ts-nocheck
+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.ts.mustache

@@ -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/src/tasks/create/templates/Constellation/Field/DateTime/suggestions-handler.ts

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

package/src/tasks/create/templates/Constellation/Field/Decimal/PConnProps.d.ts.mustache

@@ -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/src/tasks/create/templates/Constellation/Field/Decimal/demo.stories.tsx.mustache

@@ -0,0 +1,52 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import { withKnobs } from '@storybook/addon-knobs';
+
+import { configProps, fieldMetadata, stateProps } from './mock';
+
+import {{COMPONENT_CLASS_NAME}} from './index';
+
+export default {
+  title: '{{COMPONENT_CLASS_NAME}}',
+  decorators: [withKnobs],
+  component: {{COMPONENT_CLASS_NAME}}
+};
+
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
+
+  const props = {
+    value: configProps.value,
+    placeholder: configProps.placeholder,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    showGroupSeparators: configProps.showGroupSeparators,
+    hasSuggestions: configProps.hasSuggestions,
+    testId: configProps.testId,
+    fieldMetadata,
+
+    getPConnect: () => {
+      return {
+        getStateProps: () => {
+          return stateProps;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {/* nothing */},
+            triggerFieldChange: () => {/* nothing */}
+          };
+        },
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        setInheritedProps: () => {/* nothing */},
+        resolveConfigProps: () => {/* nothing */}
+      };
+    }
+  };
+
+  return (
+    <>
+      <{{COMPONENT_CLASS_NAME}} {...props} />
+    </>
+  );
+};

package/src/tasks/create/templates/Constellation/Field/Decimal/event-utils.ts.mustache

@@ -0,0 +1,18 @@
+const handleEvent = (actions: any, eventType: string, propName: string, value: string) => {
+  switch (eventType) {
+    case 'change':
+      actions.updateFieldValue(propName, value);
+      break;
+    case 'blur':
+      actions.triggerFieldChange(propName, value);
+      break;
+    case 'changeNblur':
+      actions.updateFieldValue(propName, value);
+      actions.triggerFieldChange(propName, value);
+      break;
+    default:
+      break;
+  }
+};
+
+export default handleEvent;