@pega/custom-dx-components 2.0.7 → 2.0.9

package/src/tasks/create/templates/Constellation/Field/Decimal-Currency/index.jsx.mustache

@@ -0,0 +1,300 @@
+import { useState, useEffect } from 'react';
+import {
+  CurrencyInput as CosmosCurrency,
+  CurrencyDisplay,
+  NumberDisplay,
+  FieldValueList,
+  Text,
+  useConfiguration,
+  useAfterInitialEffect
+} from '@pega/cosmos-react-core';
+import PropTypes from 'prop-types';
+
+// includes in bundle
+import handleEvent from './event-utils';
+import { suggestionsHandler } from './suggestions-handler';
+
+const formatValue = (value) => {
+  if (!value && value !== 0) return '';
+  const [integer, decimal = ''] = value.toString().split('.');
+  return `${integer}.${decimal.padEnd(3, '0')}`;
+};
+
+
+
+import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
+
+// 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,
+    placeholder,
+    validatemessage,
+    label,
+    hideLabel,
+    helperText,
+    testId,
+    allowDecimals,
+    currencyISOCode,
+    alwaysShowISOCode,
+    displayMode,
+    additionalProps,
+    variant,
+    formatter,
+    negative,
+    notation,
+    isTableFormatter,
+    hasSuggestions
+  } = props;
+  let { currencyDisplay } = props;
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = pConn.getStateProps().value;
+  const [currencyValue, setCurrencyValue] = useState(() => formatValue(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' : undefined);
+
+  useEffect(() => {
+    if (validatemessage !== '') {
+      setStatus('error');
+    }
+    if (hasSuggestions) {
+      setStatus('pending');
+    } else if (!hasSuggestions && status !== 'success') {
+      setStatus(validatemessage !== '' ? 'error' : undefined);
+    }
+  }, [validatemessage, hasSuggestions]);
+
+  useAfterInitialEffect(() => {
+    setCurrencyValue(formatValue(value));
+  }, [value]);
+
+  const { decimalPrecision, currencyDecimalPrecision } = props;
+  let noOfDecimals = parseInt(decimalPrecision, 10);
+  if (Number.isNaN(noOfDecimals)) noOfDecimals = undefined;
+  let noOfFractionDigits = currencyDecimalPrecision === 'auto' ? undefined : parseInt(currencyDecimalPrecision, 10);
+
+  if (displayMode === 'LABELS_LEFT' || displayMode === 'STACKED_LARGE_VAL' || displayMode === 'DISPLAY_ONLY') {
+    let displayComp;
+    let { showGroupSeparators } = props;
+    if (displayMode === 'LABELS_LEFT' && isTableFormatter) {
+      noOfFractionDigits = undefined;
+      showGroupSeparators = true;
+      if (formatter === 'Currency-Code') {
+        currencyDisplay = 'code';
+      }
+    }
+
+    const displayValue = !value && value !== 0 ? undefined : Number(currencyValue);
+
+    {{! pick new delimiteres for mustache }}
+    {{=<% %>=}}
+
+    displayComp = (
+      <CurrencyDisplay
+        value={displayValue}
+        currencyISOCode={currencyISOCode}
+        formattingOptions={{
+          groupSeparators: true,
+          fractionDigits: noOfFractionDigits,
+          currency: currencyDisplay,
+          negative,
+          notation: negative === 'parentheses' ? 'standard' : notation
+        }}
+      />
+    );
+
+
+
+
+    if (['Integer', 'Decimal', 'Percentage', 'Decimal-Auto'].includes(formatter)) {
+      let unit;
+
+      switch (formatter) {
+        case 'Integer': {
+          noOfDecimals = 0;
+          break;
+        }
+        case 'Decimal': {
+          break;
+        }
+        case 'Decimal-Auto': {
+          noOfDecimals = Number.isInteger(currencyValue) ? 0 : 2;
+          break;
+        }
+        case 'Percentage': {
+          showGroupSeparators = false;
+          unit = 'percent';
+          break;
+        }
+        // no default
+      }
+
+      displayComp = (
+        <NumberDisplay
+          value={displayValue}
+          formattingOptions={{
+            fractionDigits: noOfDecimals,
+            groupSeparators: showGroupSeparators,
+            notation
+          }}
+          unit={unit}
+        />
+      );
+    }
+
+    <%={{ }}=%>     {{! revert delimiteres 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
+    }
+  }
+
+  const onResolveSuggestionHandler = (accepted) => {
+    suggestionsHandler(accepted, pConn, setStatus);
+  };
+
+  return (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    <CosmosCurrency
+      {...additionalProps}
+      label={label}
+      labelHidden={hideLabel}
+      info={validatemessage || helperText}
+      value={currencyValue}
+      status={status}
+      showDecimal={allowDecimals}
+      currencyISOCode={currencyISOCode}
+      alwaysShowISOCode={alwaysShowISOCode}
+      placeholder={placeholder}
+      disabled={disabled}
+      readOnly={readOnly}
+      required={required}
+      data-testid={testId}
+      onChange={(enteredValue) => {
+        if (hasSuggestions) {
+          setStatus(undefined);
+        }
+        setCurrencyValue(enteredValue);
+        pConn.clearErrorMessages({
+          property: propName
+        });
+      }}
+      onBlur={(enteredValue) => {
+        const parsedValue = enteredValue !== '' ? Number(enteredValue) : enteredValue;
+        if (!readOnly && (!value || value !== parsedValue)) {
+          handleEvent(actions, 'changeNblur', propName, parsedValue);
+          if (hasSuggestions) {
+            pConn.ignoreSuggestion();
+          }
+        }
+      }}
+      onResolveSuggestion={onResolveSuggestionHandler}
+    />
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  );
+}
+
+{{COMPONENT_CLASS_NAME}}.defaultProps = {
+  value: 0,
+  placeholder: '',
+  validatemessage: '',
+  helperText: '',
+  hideLabel: false,
+  disabled: false,
+  readOnly: false,
+  required: false,
+  decimalPrecision: null,
+  allowDecimals: true,
+  currencyISOCode: 'USD',
+  isoCodeSelection: 'constant',
+  testId: null,
+  displayMode: null,
+  additionalProps: {},
+  variant: 'inline',
+  showGroupSeparators: false,
+  formatter: 'defaultCurrency',
+  currencyDisplay: 'symbol',
+  negative: 'minus-sign',
+  notation: 'standard',
+  currencyDecimalPrecision: 'auto',
+  isTableFormatter: false,
+  alwaysShowISOCode: false,
+  hasSuggestions: false
+};
+
+{{COMPONENT_CLASS_NAME}}.propTypes = {
+  value: PropTypes.number,
+  placeholder: PropTypes.string,
+  label: PropTypes.string.isRequired,
+  decimalPrecision: PropTypes.number,
+  allowDecimals: PropTypes.bool,
+  currencyISOCode: PropTypes.string,
+  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,
+  displayMode: PropTypes.string,
+  additionalProps: PropTypes.objectOf(PropTypes.any),
+  variant: PropTypes.string,
+  showGroupSeparators: PropTypes.bool,
+  formatter: PropTypes.string,
+  currencyDisplay: PropTypes.string,
+  negative: PropTypes.string,
+  notation: PropTypes.string,
+  currencyDecimalPrecision: PropTypes.string,
+  isTableFormatter: PropTypes.bool,
+  alwaysShowISOCode: PropTypes.bool,
+  hasSuggestions: PropTypes.bool
+};
+
+export default {{COMPONENT_CLASS_NAME}};

package/src/tasks/create/templates/Constellation/Field/Decimal-Currency/styles.js.mustache

@@ -0,0 +1,7 @@
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 8px 0;
+  `;
+});

package/src/tasks/create/templates/Constellation/Field/Decimal-Currency/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/Decimal-Percentage/config.json.mustache

@@ -0,0 +1,93 @@
+{
+  "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"
+    },
+    {
+      "name": "decimalPrecision",
+      "label": "Decimal places",
+      "format": "NUMBER",
+      "min": 0
+    },
+    {
+      "name": "showGroupSeparators",
+      "label": "Show thousands separator",
+      "format": "BOOLEAN"
+    },
+    {
+      "label": "Input settings",
+      "format": "GROUP",
+      "visibility": "(!readOnly = true)",
+      "properties": [
+        {
+          "name": "placeholder",
+          "label": "Placeholder",
+          "format": "TEXT"
+        },
+        {
+          "name": "helperText",
+          "label": "Helper text",
+          "format": "TEXT"
+        }
+      ]
+    },
+    {
+      "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}]"
+        }
+      ]
+    }
+  ],
+  "defaultConfig": {
+    "label": "@L $this.label"
+  }
+}

package/src/tasks/create/templates/Constellation/Field/Decimal-Percentage/demo.stories.jsx.mustache

@@ -0,0 +1,44 @@
+import { useState } from 'react';
+import { withKnobs, text, boolean } from '@storybook/addon-knobs';
+
+import {{COMPONENT_CLASS_NAME}} from './index.jsx';
+
+export default {
+  title: '{{COMPONENT_CLASS_NAME}}',
+  decorators: [withKnobs],
+  component: {{COMPONENT_CLASS_NAME}}
+};
+
+export const base{{COMPONENT_CLASS_NAME}} = () => {
+  const [value, setValue] = useState('test value');
+
+  const props = {
+    getPConnect: () => {
+      return {
+        getActionsApi: () => {
+          return {
+            updateFieldValue: (propName, value) => {
+              setValue(value);
+            }
+          };
+        },
+        getStateProps: () => {
+          return { value: '.name' };
+        }
+      };
+    },
+    value,
+    placeholder: text('Placeholder', 'Test placeholder'),
+    disabled: boolean('Disabled', false),
+    readOnly: boolean('Disabled', false),
+    required: boolean('Disabled', false),
+    label: text('Label', 'Sample Label'),
+    testId: text('Test id', 'text-12344566')
+  };
+
+  return (
+    <>
+      <{{COMPONENT_CLASS_NAME}} {...props} />
+    </>
+  );
+};

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

@@ -0,0 +1,18 @@
+const handleEvent = (actions, eventType, propName, value) => {
+  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;