@pega/custom-dx-components 0.23.9 → 0.23.11

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyCurrency/config.json

@@ -0,0 +1,291 @@
+{
+  "name": "Pega_DXIL_MyCurrency",
+  "label": "My Currency",
+  "description": "My Currency",
+  "organization": "Pega",
+  "version": "0.0.1",
+  "library": "DXIL",
+  "allowedApplications": [],
+  "componentKey": "Pega_DXIL_MyCurrency",
+  "type": "Field",
+  "subtype": "Decimal-Currency",
+  "icon": "images/pz-currency-active.svg",
+  "properties": [
+    {
+      "name": "label",
+      "label": "Label value",
+      "format": "TEXT",
+      "required": true
+    },
+    {
+      "name": "readOnly",
+      "label": "Edit mode",
+      "format": "READONLY"
+    },
+    {
+      "format": "CASCADE",
+      "source": {
+        "format": "SELECT",
+        "label": "ISO Code Selection",
+        "name": "isoCodeSelection",
+        "defaultValue": "constant",
+        "source": [
+          {
+            "key": "constant",
+            "value": "Constant"
+          },
+          {
+            "key": "propertyRef",
+            "value": "Property Reference"
+          }
+        ]
+      },
+      "cascadeElements": [
+        {
+          "key": "currencyISOCode",
+          "format": "TEXT",
+          "name": "currencyISOCode",
+          "label": "Currency ISO Code",
+          "defaultValue": "USD",
+          "match": "constant"
+        },
+        {
+          "key": "currencyISOCode",
+          "format": "PROPERTY",
+          "name": "currencyISOCode",
+          "label": "Currency ISO Code",
+          "match": "propertyRef"
+        }
+      ]
+    },
+    {
+      "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": [
+        {
+          "name": "allowDecimals",
+          "label": "Allow Decimals",
+          "format": "BOOLEAN",
+          "defaultValue": true
+        },
+        {
+          "name": "alwaysShowISOCode",
+          "label": "Show ISO Code",
+          "format": "BOOLEAN",
+          "defaultValue": false
+        },
+        {
+          "name": "placeholder",
+          "label": "Placeholder",
+          "format": "TEXT"
+        },
+        {
+          "name": "helperText",
+          "label": "Helper text",
+          "format": "TEXT"
+        }
+      ]
+    },
+    {
+      "label": "Read-only settings",
+      "format": "GROUP",
+      "properties": [
+        {
+          "format": "SELECT",
+          "name": "formatter",
+          "label": "Format",
+          "defaultValue": "defaultCurrency",
+          "source": [
+            {
+              "key": "defaultCurrency",
+              "value": "Default"
+            },
+            {
+              "key": "Integer",
+              "value": "Integer"
+            },
+            {
+              "key": "Decimal",
+              "value": "Decimal"
+            },
+            {
+              "key": "Percentage",
+              "value": "Percentage"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "format": "SELECT",
+      "name": "currencyDisplay",
+      "label": "Currency display",
+      "visibility": "(!formatter = Integer)&&(!formatter = Decimal)&&(!formatter = Percentage)",
+      "defaultValue": "symbol",
+      "source": [
+        {
+          "key": "symbol",
+          "value": "Auto"
+        },
+        {
+          "key": "code",
+          "value": "Code"
+        },
+        {
+          "key": "name",
+          "value": "Name"
+        }
+      ]
+    },
+    {
+      "format": "SELECT",
+      "name": "negative",
+      "label": "Negative number display",
+      "defaultValue": "minus-sign",
+      "visibility": "(!formatter = Integer)&&(!formatter = Decimal)&&(!formatter = Percentage)",
+      "source": [
+        {
+          "key": "minus-sign",
+          "value": "Standard"
+        },
+        {
+          "key": "parentheses",
+          "value": "Accounting"
+        }
+      ]
+    },
+    {
+      "format": "SELECT",
+      "name": "notation",
+      "label": "Notation",
+      "visibility": "(!negative = parentheses)&&(!formatter = Percentage)",
+      "defaultValue": "standard",
+      "source": [
+        {
+          "key": "standard",
+          "value": "Standard"
+        },
+        {
+          "key": "compact",
+          "value": "Compact"
+        }
+      ]
+    },
+    {
+      "format": "NUMBER",
+      "name": "decimalPrecision",
+      "label": "Decimal places",
+      "visibility": "(formatter = Decimal)||(formatter = Percentage)",
+      "min": 0,
+      "max": 20
+    },
+    {
+      "format": "SELECT",
+      "name": "currencyDecimalPrecision",
+      "label": "Decimal places shown",
+      "visibility": "(!formatter = Integer)&&(!formatter = Decimal)&&(!formatter = Percentage)",
+      "defaultValue": "auto",
+      "source": [
+        {
+          "key": "auto",
+          "value": "Auto"
+        },
+        {
+          "key": "0",
+          "value": "None"
+        },
+        {
+          "key": "1",
+          "value": "1"
+        },
+        {
+          "key": "2",
+          "value": "2"
+        },
+        {
+          "key": "3",
+          "value": "3"
+        },
+        {
+          "key": "4",
+          "value": "4"
+        }
+      ]
+    },
+    {
+      "name": "showGroupSeparators",
+      "label": "Show thousands separator",
+      "format": "BOOLEAN",
+      "visibility": "(formatter = Decimal)||(formatter = Integer)"
+    },
+    {
+      "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/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyCurrency/demo.stories.jsx

@@ -0,0 +1,53 @@
+import { withKnobs } from '@storybook/addon-knobs';
+
+import { configProps, fieldMetadata, stateProps } from './mock.stories.js';
+
+import PegaDxilMyCurrency from './index.jsx';
+
+export default {
+  title: 'PegaDxilMyCurrency',
+  decorators: [withKnobs],
+  component: PegaDxilMyCurrency
+};
+
+export const basePegaDxilMyCurrency = () => {
+
+  const props = {
+    value: Number(configProps.value),
+    placeholder: configProps.placeholder,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    showGroupSeparators: configProps.showGroupSeparators,
+    allowDecimals: configProps.allowDecimals,
+    currencyISOCode: configProps.currencyISOCode,
+    alwaysShowISOCode: configProps.alwaysShowISOCode,
+    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 */},
+        clearErrorMessages: () => {/* nothing */}
+      };
+    }
+  };
+
+  return (
+    <>
+      <PegaDxilMyCurrency {...props} />
+    </>
+  );
+};

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyCurrency/event-utils.js

@@ -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;

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyCurrency/index.jsx

@@ -0,0 +1,296 @@
+import { useState, useEffect } from 'react';
+import {
+  CurrencyInput as CosmosCurrency,
+  CurrencyDisplay,
+  NumberDisplay,
+  FieldValueList,
+  Text,
+  useAfterInitialEffect
+} from '@pega/cosmos-react-core';
+import PropTypes from 'prop-types';
+
+// includes in bundle
+import handleEvent from './event-utils';
+import { suggestionsHandler } from './suggestions-handler';
+
+import StyledPegaDxilMyCurrencyWrapper from './styles';
+
+const formatValue = (value) => {
+  if (!value && value !== 0) return '';
+  const [integer, decimal = ''] = value.toString().split('.');
+  return `${integer}.${decimal.padEnd(3, '0')}`;
+};
+
+
+// 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 PegaDxilMyCurrency = 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);
+
+
+    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}
+        />
+      );
+    }
+
+
+    switch (displayMode) {
+      case 'DISPLAY_ONLY': {
+        return (<StyledPegaDxilMyCurrencyWrapper> displayComp </StyledPegaDxilMyCurrencyWrapper>) ;
+      }
+      case 'LABELS_LEFT': {
+        return (
+          <StyledPegaDxilMyCurrencyWrapper>
+          <FieldValueList
+            variant={hideLabel ? 'stacked' : variant}
+            data-testid={testId}
+            fields={[{ id: '1', name: hideLabel ? '' : label, value: displayComp }]}
+          />
+          </StyledPegaDxilMyCurrencyWrapper>
+        );
+      }
+      case 'STACKED_LARGE_VAL': {
+        return (
+          <StyledPegaDxilMyCurrencyWrapper>
+          <FieldValueList
+            variant='stacked'
+            data-testid={testId}
+            fields={[
+              {
+                id: '2',
+                name: hideLabel ? '' : label,
+                value: (
+                  <Text variant='h1' as='span'>
+                    {displayComp}
+                  </Text>
+                )
+              }
+            ]}
+          />
+          </StyledPegaDxilMyCurrencyWrapper>
+        );
+      }
+      // no default
+    }
+  }
+
+  const onResolveSuggestionHandler = (accepted) => {
+    suggestionsHandler(accepted, pConn, setStatus);
+  };
+
+  return (
+    <StyledPegaDxilMyCurrencyWrapper>
+    <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}
+    />
+    </StyledPegaDxilMyCurrencyWrapper>
+  );
+}
+
+PegaDxilMyCurrency.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
+};
+
+PegaDxilMyCurrency.propTypes = {
+  value: PropTypes.number,
+  placeholder: PropTypes.string,
+  label: PropTypes.string.isRequired,
+  decimalPrecision: PropTypes.number,
+  allowDecimals: PropTypes.bool,
+  currencyISOCode: PropTypes.string,
+  isoCodeSelection: 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 PegaDxilMyCurrency;

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyCurrency/mock.stories.js

@@ -0,0 +1,23 @@
+export const configProps = {
+  value: '',
+  label: 'Currency Sample',
+  currencyISOCode: 'USD',
+  allowDecimals: true,
+  alwaysShowISOCode: true,
+  placeholder: 'Currency Placeholder',
+  helperText: 'Currency Helper Text',
+  testId: 'currency-12345678',
+  hasSuggestions: false
+};
+
+export const stateProps = {
+  value: '.CurrencySample',
+  hasSuggestions: false
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Decimal',
+  displayAs: 'pxCurrency',
+  label: 'Currency sample'
+};

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyCurrency/styles.js

@@ -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/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyCurrency/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);
+  }
+};