@pega/custom-dx-components 23.1.10 → 23.1.12

package/src/tasks/create/templates/Constellation/Field/Decimal-Percentage/index.tsx.mustache

@@ -0,0 +1,271 @@
+import { useState, useEffect, useRef } from 'react';
+import {
+  NumberInput,
+  NumberDisplay,
+  CurrencyDisplay,
+  FieldValueList,
+  Text,
+  withConfiguration
+} from '@pega/cosmos-react-core';
+
+
+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
+  displayAsStatus?: boolean;
+  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;
+}
+
+// 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
+function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
+  const {
+    getPConnect,
+    value,
+    placeholder,
+    validatemessage,
+    label,
+    hideLabel = false,
+    helperText,
+    testId,
+    decimalPrecision,
+    additionalProps = {},
+    displayMode,
+    variant = 'inline',
+    formatter,
+    isTableFormatter = false,
+    hasSuggestions = false
+  } = props;
+  let { showGroupSeparators = false } = props;
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const stateProps = pConn.getStateProps() as StateProps;
+  const propName: string = stateProps.value;
+  const [percentageValue, setPercentageValue] = useState(value?.toString());
+
+  const hasValueChange = useRef(false);
+
+  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' : undefined);
+
+  useEffect(() => {
+    if (validatemessage !== '') {
+      setStatus('error');
+    }
+    if (hasSuggestions) {
+      setStatus('pending');
+    } else if (!hasSuggestions && status !== 'success') {
+      setStatus(validatemessage !== '' ? 'error' : undefined);
+    }
+  }, [validatemessage, hasSuggestions, status]);
+
+  let numberOfDecimals = parseInt(decimalPrecision, 10);
+  if (Number.isNaN(numberOfDecimals)) {
+    // @ts-ignore
+    numberOfDecimals = decimalPrecision === '' ? undefined : 2;
+  }
+
+  useEffect(() => {
+    setPercentageValue(value?.toString());
+  }, [value]);
+
+  if (displayMode === 'LABELS_LEFT' || displayMode === 'DISPLAY_ONLY') {
+    let unit = 'percent';
+    let displayComp:any = null;
+
+    if (isTableFormatter) {
+      switch (formatter) {
+        case 'Integer': {
+          numberOfDecimals = 0;
+          showGroupSeparators = true;
+          unit = '';
+          break;
+        }
+        case 'Decimal': {
+          showGroupSeparators = true;
+          unit = '';
+          break;
+        }
+        case 'Decimal-Auto': {
+          numberOfDecimals = Number.isInteger(percentageValue) ? 0 : 2;
+          showGroupSeparators = true;
+          unit = '';
+          break;
+        }
+        default: {
+          showGroupSeparators = false;
+          break;
+        }
+      }
+    }
+
+    {{! pick new delimiters for mustache }}
+    {{=<% %>=}}
+
+    displayComp = (
+      <NumberDisplay
+        value={percentageValue}
+        formattingOptions={{
+          fractionDigits: numberOfDecimals,
+          groupSeparators: showGroupSeparators
+        }}
+        unit={unit}
+      />
+    );
+    if (isTableFormatter && (formatter === 'Currency' || formatter === 'Currency-Code')) {
+      const { currencyISOCode = 'USD' } = props;
+      let showIsoCode = true;
+      if (formatter === 'Currency') {
+        showIsoCode = false;
+      }
+      displayComp = (
+        <CurrencyDisplay
+          value={percentageValue}
+          currencyISOCode={currencyISOCode}
+          formattingOptions={{
+            groupSeparators: showGroupSeparators,
+            currency: showIsoCode ? 'code' : 'symbol'
+          }}
+        />
+      );
+    }
+
+    <%={{ }}=%>     {{! revert delimiters for mustache }}
+
+    return displayMode === 'DISPLAY_ONLY' ? (
+      <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+      displayComp
+      </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    ) : (
+      <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>
+    );
+  }
+
+  {{! pick new delimiters for mustache }}
+  {{=<% %>=}}
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    const displayComp = (
+      <NumberDisplay
+        value={percentageValue}
+        formattingOptions={{
+          fractionDigits: numberOfDecimals,
+          groupSeparators: showGroupSeparators
+        }}
+        unit='percent'
+      />
+    );
+
+  <%={{ }}=%>     {{! revert delimiters for mustache }}
+
+    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>
+    );
+  }
+
+  const onResolveSuggestionHandler = (accepted: boolean) => {
+    suggestionsHandler(accepted, pConn, setStatus);
+  };
+
+  return (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    <NumberInput
+      {...additionalProps}
+      label={label}
+      labelHidden={hideLabel}
+      info={validatemessage || helperText}
+      value={percentageValue}
+      status={status}
+      placeholder={placeholder}
+      disabled={disabled}
+      readOnly={readOnly}
+      required={required}
+      numberOfDecimals={numberOfDecimals}
+      showGroupSeparators={showGroupSeparators}
+      unit='percent'
+      data-testid={testId}
+      onChange={(enteredValue) => {
+        if (hasSuggestions) {
+          setStatus(undefined);
+        }
+        setPercentageValue(enteredValue);
+        if (value !== enteredValue) {
+          // @ts-ignore
+          handleEvent(actions, 'change', propName, enteredValue);
+          hasValueChange.current = true;
+        }
+      }}
+      onBlur={() => {
+        const parsedValue = percentageValue !== '' ? Number(percentageValue) : '';
+        if (!value || hasValueChange.current) {
+          // @ts-ignore
+          handleEvent(actions, 'blur', propName, parsedValue);
+          if (hasSuggestions) {
+            pConn.ignoreSuggestion("");
+          }
+          hasValueChange.current = false;
+        }
+      }}
+      onResolveSuggestion={onResolveSuggestionHandler}
+    />
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  );
+}
+
+export default withConfiguration({{COMPONENT_CLASS_NAME}});

package/src/tasks/create/templates/Constellation/Field/Decimal-Percentage/mock.ts.mustache

@@ -0,0 +1,29 @@
+
+// @ts-nocheck
+export const configProps = {
+  value: '',
+  label: 'Percentage Sample',
+  showGroupSeparators: true,
+  helperText: 'Percentage Helper Text',
+  testId: 'percentage-12345678',
+  hasSuggestions: false,
+  displayMode: '',
+  hideLabel: false,
+  readOnly: false,
+  required: false,
+  disabled: false,
+  status: '',
+  validatemessage: ''
+};
+
+export const stateProps = {
+  value: '.PercentageSample',
+  hasSuggestions: false
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Decimal',
+  displayAs: 'pxPercentage',
+  label: 'Percentage sample'
+};

package/src/tasks/create/templates/Constellation/Field/Decimal-Percentage/styles.ts.mustache

@@ -0,0 +1,8 @@
+// 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/Decimal-Percentage/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/Integer/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/Integer/demo.stories.tsx.mustache

@@ -0,0 +1,68 @@
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import type { Meta, StoryObj } from '@storybook/react';
+
+import { stateProps, configProps, fieldMetadata } from './mock';
+
+import {{COMPONENT_CLASS_NAME}} from './index';
+
+const meta: Meta<typeof {{COMPONENT_CLASS_NAME}}> = {
+  title: '{{COMPONENT_CLASS_NAME}}',
+  component: {{COMPONENT_CLASS_NAME}},
+  excludeStories: /.*Data$/
+};
+
+export default meta;
+type Story = StoryObj<typeof {{COMPONENT_CLASS_NAME}}>;
+
+export const Base{{COMPONENT_CLASS_NAME}}: Story = args => {
+
+  const props = {
+    value: configProps.value,
+    placeholder: configProps.placeholder,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    showGroupSeparators: configProps.showGroupSeparators,
+    hasSuggestions: configProps.hasSuggestions,
+    testId: configProps.testId,
+    fieldMetadata,
+    validatemessage: '',
+    getPConnect: () => {
+      return {
+        getStateProps: () => {
+          return stateProps;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {/* nothing */},
+            triggerFieldChange: () => {/* nothing */}
+          };
+        },
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        setInheritedProps: () => {/* nothing */},
+        resolveConfigProps: () => {/* nothing */}
+      };
+    }
+  };
+
+  return (
+    <>
+      <{{COMPONENT_CLASS_NAME}} {...props} {...args} />
+    </>
+  );
+};
+
+Base{{COMPONENT_CLASS_NAME}}.args = {
+  label: configProps.label,
+  helperText: configProps.helperText,
+  showGroupSeparators: configProps.showGroupSeparators,
+  testId: configProps.testId,
+  readOnly: configProps.readOnly,
+  disabled: configProps.disabled,
+  required: configProps.required,
+  status: configProps.status,
+  hideLabel: configProps.hideLabel,
+  displayMode: configProps.displayMode,
+  validatemessage: configProps.validatemessage
+};

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