@pega/custom-dx-components 23.1.10 → 23.1.11

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

@@ -0,0 +1,379 @@
+import { useState, useEffect, useRef } from 'react';
+import { NumberInput, NumberDisplay, Slider, FieldValueList, CurrencyDisplay, Text } from '@pega/cosmos-react-core';
+import PropTypes from 'prop-types';
+
+import type { PConnFieldProps } from './PConnProps';
+
+// includes in bundle
+import handleEvent from "./event-utils";
+import { suggestionsHandler } from './suggestions-handler';
+
+import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
+
+
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  displayAs?: string;
+  defaultValue: number;
+  isTableFormatter?: boolean;
+  hasSuggestions?: boolean;
+  variant?: any;
+  formatter: string;
+  decimalPrecision: string;
+  allowDecimals: boolean;
+  currencyISOCode: string;
+  alwaysShowISOCode: boolean;
+  isoCodeSelection: string;
+  additionalProps: any;
+  showGroupSeparators: boolean;
+  currencyDisplay: 'symbol' | 'code' | 'name' | undefined;
+  negative: 'minus-sign' | 'parentheses' | undefined;
+  notation: 'standard' | 'compact' | undefined;
+  currencyDecimalPrecision: string;
+  showInput: boolean;
+  min: number;
+  max: number;
+  step: number;
+  showTicks: boolean;
+}
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
+
+// 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,
+    defaultValue,
+    placeholder,
+    validatemessage,
+    label,
+    hideLabel,
+    helperText,
+    testId,
+    displayMode,
+    displayAs,
+    showInput,
+    min,
+    max,
+    step,
+    showTicks,
+    additionalProps,
+    variant,
+    formatter,
+    negative,
+    notation,
+    isTableFormatter,
+    hasSuggestions
+  } = props;
+  let { showGroupSeparators } = props;
+  let { currencyDisplay } = props;
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const stateProps = pConn.getStateProps() as StateProps;
+  const propName: string = stateProps.value;
+  const [integerValue, setIntegerValue] = useState(value?.toString());
+  const sliderDefaultValue = !defaultValue && defaultValue !== 0 ? max : defaultValue;
+
+  const hasValueChange = useRef(false);
+
+
+  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') {
+      // @ts-ignore
+      setStatus(validatemessage !== '' ? 'error' : undefined);
+    }
+  }, [validatemessage, hasSuggestions, status]);
+
+  useEffect(() => {
+    setIntegerValue(value?.toString());
+  }, [value]);
+
+  useEffect(() => {
+    if (displayAs === 'slider' && value === '') {
+      // @ts-ignore
+      handleEvent(actions, 'change', propName, sliderDefaultValue);
+    }
+  }, [actions, displayAs, propName, sliderDefaultValue, value]);
+
+  const { decimalPrecision, currencyDecimalPrecision, currencyISOCode } = props;
+  let noOfDecimals = parseInt(decimalPrecision, 10);
+  // @ts-ignore
+  if (Number.isNaN(noOfDecimals)) noOfDecimals = undefined;
+  let noOfFractionDigits = currencyDecimalPrecision === 'auto' ? undefined : parseInt(currencyDecimalPrecision, 10);
+  let unit;
+  let unitPlacement;
+
+  // @ts-ignore
+  if (['LABELS_LEFT', 'STACKED_LARGE_VAL', 'DISPLAY_ONLY'].includes(displayMode)) {
+    switch (formatter) {
+      case 'Decimal': {
+        break;
+      }
+      case 'Percentage': {
+        showGroupSeparators = false;
+        unit = '%';
+        unitPlacement = 'after';
+        break;
+      }
+      case 'Decimal-Auto': {
+        noOfDecimals = Number.isInteger(integerValue) ? 0 : 2;
+        break;
+      }
+      default: {
+        noOfDecimals = 0;
+        break;
+      }
+    }
+
+    if (isTableFormatter && displayMode === 'LABELS_LEFT') {
+      showGroupSeparators = true;
+      noOfFractionDigits = undefined;
+      if (formatter === 'Currency-Code') {
+        currencyDisplay = 'code';
+      }
+    }
+
+    {{! pick new delimiters for mustache }}
+    {{=<% %>=}}
+
+    const displayComp =
+      formatter === 'Currency' || formatter === 'Currency-Code' ? (
+        <CurrencyDisplay
+          value={integerValue}
+          currencyISOCode={currencyISOCode}
+          formattingOptions={{
+            groupSeparators: showGroupSeparators,
+            fractionDigits: noOfFractionDigits,
+            currency: currencyDisplay,
+            negative,
+            notation: negative === 'parentheses' ? 'standard' : notation
+          }}
+        />
+      ) : (
+        <NumberDisplay
+          value={integerValue}
+          formattingOptions={{
+            fractionDigits: noOfDecimals,
+            groupSeparators: showGroupSeparators,
+            notation
+          }}
+          unit={unit}
+          unitPlacement={unitPlacement}
+        />
+      );
+
+    <%={{ }}=%>     {{! revert delimiters for mustache }}
+
+    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
+    }
+  }
+
+  function onChangeHandler(enteredValue: any) {
+    if (hasSuggestions) {
+      setStatus('');
+    }
+    setIntegerValue(enteredValue);
+    // const parsedValue = integerValue !== '' ? Number(integerValue) : '';
+    if (value !== (enteredValue !== '' ? Number(enteredValue) : '')) {
+      // @ts-ignore
+      handleEvent(actions, 'change', propName, enteredValue !== '' ? Number(enteredValue) : '');
+      hasValueChange.current = true;
+    }
+    // In case of stepper variation there is no blur event as component is never focussed unless forced. Need to update redux on change.
+    if (displayAs === 'stepper') {
+      // @ts-ignore
+      handleEvent(actions, 'changeNblur', propName, enteredValue !== '' ? Number(enteredValue) : '');
+    }
+  }
+
+  const onResolveSuggestionHandler = (accepted: boolean) => {
+    suggestionsHandler(accepted, pConn, setStatus);
+  };
+
+  return displayAs === 'slider' ? (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    <Slider
+      {...additionalProps}
+      label={label}
+      labelHidden={hideLabel}
+      info={validatemessage || helperText}
+      value={!integerValue ? sliderDefaultValue : Number(integerValue)}
+      status={status}
+      placeholder={placeholder}
+      disabled={disabled}
+      readOnly={readOnly}
+      required={required}
+      data-testid={testId}
+      showProgress
+      preview={!showInput}
+      showInput={showInput}
+      min={min}
+      max={max}
+      step={step}
+      ticks={showTicks && { [min]: `${min}`, [max]: `${max}` }}
+      onChange={(selectedValue) => {
+        onChangeHandler(selectedValue.toString());
+        // @ts-ignore
+        handleEvent(actions, 'changeNblur', propName, selectedValue);
+      }}
+    />
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  ) : (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    <NumberInput
+      {...additionalProps}
+      label={label}
+      labelHidden={hideLabel}
+      info={validatemessage || helperText}
+      value={integerValue}
+      status={status}
+      placeholder={displayAs === 'input' ? placeholder : ''}
+      disabled={disabled}
+      readOnly={readOnly}
+      required={required}
+      data-testid={testId}
+      numberOfDecimals={0}
+      showGroupSeparators={showGroupSeparators}
+      variant={displayAs === 'stepper' ? displayAs : ''}
+      onChange={(enteredValue) => {
+        onChangeHandler(enteredValue);
+      }}
+      onBlur={() => {
+        if (!readOnly && (hasValueChange.current || !value)) {
+          // @ts-ignore
+          handleEvent(actions, 'blur', propName, integerValue !== '' ? Number(integerValue) : '');
+          if (hasSuggestions) {
+            pConn.ignoreSuggestion('');
+          }
+          hasValueChange.current = false;
+        }
+      }}
+      onResolveSuggestion={onResolveSuggestionHandler}
+    />
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  );
+}
+
+{{COMPONENT_CLASS_NAME}}.defaultProps = {
+  value: '',
+  defaultValue: null,
+  placeholder: '',
+  validatemessage: '',
+  helperText: '',
+  hideLabel: false,
+  disabled: false,
+  readOnly: false,
+  required: false,
+  testId: '',
+  showGroupSeparators: false,
+  displayMode: null,
+  displayAs: 'input',
+  showInput: true,
+  min: 0,
+  max: 100,
+  step: 1,
+  showTicks: true,
+  additionalProps: {},
+  variant: 'inline',
+  decimalPrecision: null,
+  currencyISOCode: 'USD',
+  isoCodeSelection: 'constant',
+  formatter: 'defaultInteger',
+  negative: 'minus-sign',
+  notation: 'standard',
+  currencyDisplay: 'symbol',
+  currencyDecimalPrecision: 'auto',
+  isTableFormatter: false,
+  hasSuggestions: false
+};
+
+{{COMPONENT_CLASS_NAME}}.propTypes = {
+  value: PropTypes.string,
+  defaultValue: PropTypes.number,
+  placeholder: 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]),
+  testId: PropTypes.string,
+  showGroupSeparators: PropTypes.bool,
+  displayMode: PropTypes.string,
+  displayAs: PropTypes.string,
+  showInput: PropTypes.bool,
+  min: PropTypes.number,
+  max: PropTypes.number,
+  step: PropTypes.number,
+  showTicks: PropTypes.bool,
+  additionalProps: PropTypes.objectOf(PropTypes.any),
+  variant: PropTypes.string,
+  decimalPrecision: PropTypes.number,
+  currencyISOCode: PropTypes.string,
+  isoCodeSelection: PropTypes.string,
+  formatter: PropTypes.string,
+  negative: PropTypes.string,
+  notation: PropTypes.string,
+  currencyDisplay: PropTypes.string,
+  currencyDecimalPrecision: PropTypes.string,
+  isTableFormatter: PropTypes.bool,
+  hasSuggestions: PropTypes.bool
+};

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

@@ -0,0 +1,22 @@
+// @ts-nocheck
+export const configProps = {
+  value: '',
+  label: 'Integer Sample',
+  showGroupSeparators: true,
+  placeholder: 'Integer Placeholder',
+  helperText: 'Integer Helper Text',
+  testId: 'integer-12345678',
+  hasSuggestions: false
+};
+
+export const stateProps = {
+  value: '.IntegerSample',
+  hasSuggestions: false
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Integer',
+  displayAs: 'pxInteger',
+  label: 'Integer sample'
+};

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

@@ -0,0 +1,81 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import { useState } from 'react';
+import { withKnobs } from '@storybook/addon-knobs';
+
+import { configProps, rawMetadata, 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 [value, setValue] = useState(configProps.value);
+
+  const props = {
+    value,
+    placeholder: configProps.placeholder,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    datasource: configProps.datasource,
+    testId: configProps.testId,
+    hasSuggestions: configProps.hasSuggestions,
+    fieldMetadata,
+
+    getPConnect: () => {
+      return {
+        getConfigProps: () => {
+          return configProps;
+        },
+        getStateProps: () => {
+          return stateProps;
+        },
+        getLocalizedValue: val => {
+          return val;
+        },
+        getLocaleRuleNameFromKeys: (localeClass, localeContext, localeName) => {
+          return `${localeClass}!${localeContext}!${localeName}`;
+        },
+        getCaseInfo: () => {
+          return {
+            getClassName: () => {
+              return 'DIXL-MediaCo-Work-NewService';
+            }
+          };
+        },
+        getRawMetadata: () => {
+          return rawMetadata;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: (propName, theValue) => {
+              setValue(theValue);
+            },
+            triggerFieldChange: () => {/* nothing */}
+          };
+        },
+        getValidationApi: () => {
+          return {
+            validate: () => {/* nothing */}
+          };
+        },
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        setInheritedProps: () => {/* nothing */},
+        resolveConfigProps: () => {/* nothing */}
+      };
+    }
+  };
+
+  return (
+    <>
+      <{{COMPONENT_CLASS_NAME}} {...props} />
+    </>
+  );
+};

package/src/tasks/create/templates/Constellation/Field/Picklist/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;