@pega/dx-component-builder-sdk 23.1.14 → 23.1.16

package/src/tasks/create/templates/SDK-React/field/Decimal/config.json.mustache

@@ -50,6 +50,161 @@
         }
       ]
     },
+    {
+      "label": "Read-only settings",
+      "format": "GROUP",
+      "properties": [
+        {
+          "format": "SELECT",
+          "name": "formatter",
+          "label": "Format",
+          "defaultValue": "defaultDecimal",
+          "source": [
+            {
+              "key": "defaultDecimal",
+              "value": "Default"
+            },
+            {
+              "key": "Integer",
+              "value": "Integer"
+            },
+            {
+              "key": "Currency",
+              "value": "Currency"
+            },
+            {
+              "key": "Percentage",
+              "value": "Percentage"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "format": "CASCADE",
+      "visibility": "(formatter = Currency)",
+      "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"
+        }
+      ]
+    },
+    {
+      "format": "SELECT",
+      "name": "currencyDisplay",
+      "label": "Currency display",
+      "visibility": "(formatter = Currency)",
+      "defaultValue": "symbol",
+      "source": [
+        {
+          "key": "symbol",
+          "value": "Auto"
+        },
+        {
+          "key": "code",
+          "value": "Code"
+        },
+        {
+          "key": "name",
+          "value": "Name"
+        }
+      ]
+    },
+    {
+      "format": "SELECT",
+      "name": "negative",
+      "label": "Negative number display",
+      "visibility": "(formatter = Currency)",
+      "defaultValue": "minus-sign",
+      "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": "SELECT",
+      "name": "currencyDecimalPrecision",
+      "label": "Decimal places shown",
+      "visibility": "(formatter = Currency)",
+      "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"
+        }
+      ]
+    },
     {
       "label": "Conditions",
       "format": "GROUP",

package/src/tasks/create/templates/SDK-React/field/Decimal/index.tsx.mustache

@@ -14,6 +14,7 @@ interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
   currencyISOCode?: string;
   decimalPrecision?: number;
   showGroupSeparators?: string;
+  formatter?: string;
 }
 
 // Duplicated runtime code from React SDK
@@ -40,7 +41,8 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
     decimalPrecision = 2,
     showGroupSeparators = true,
     testId,
-    placeholder
+    placeholder,
+    formatter
   } = props;
 
   const pConn = getPConnect();
@@ -51,9 +53,16 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
   const theSymbols = getCurrencyCharacters(currencyISOCode);
   const theCurrDec = theSymbols.theDecimalIndicator;
   const theCurrSep = theSymbols.theDigitGroupSeparator;
+  const theCurrSym = theSymbols.theCurrencySymbol;
 
   const theCurrencyOptions = getCurrencyOptions(currencyISOCode);
-  const formattedValue = format(value, pConn.getComponentName().toLowerCase(), theCurrencyOptions);
+
+  let formattedValue = '';
+  if (formatter === 'Currency') {
+    formattedValue = format(value, formatter.toLowerCase(), theCurrencyOptions);
+  } else {
+    formattedValue = format(value, pConn.getComponentName().toLowerCase(), theCurrencyOptions);
+  }
 
   if (displayMode === 'LABELS_LEFT') {
     return <FieldValueList name={hideLabel ? '' : label} value={formattedValue} />;
@@ -92,7 +101,7 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
       {{=<% %>=}}
       InputProps={{ inputProps: { ...testProp } }}
       <%={{ }}=%>     {{! revert delimiters for mustache }}
-      currencySymbol=''
+      currencySymbol={readOnly && formatter === 'Currency' ? theCurrSym : ''}
       decimalCharacter={theCurrDec}
       digitGroupSeparator={showGroupSeparators ? theCurrSep : ''}
       decimalPlaces={decimalPrecision}

package/src/tasks/create/templates/SDK-React/field/Decimal-Currency/index.tsx.mustache

@@ -7,7 +7,9 @@ import { format } from '@pega/react-sdk-components/lib/components/helpers/format
 import { getCurrencyCharacters, getCurrencyOptions } from '@pega/react-sdk-components/lib/components/field/Currency/currency-utils.js';
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
 
-// Using control from: https://github.com/unicef/material-ui-currency-textfield
+/* Using @unicef/material-ui-currency-textfield component here, since it allows formatting decimal values,
+as per the locale.
+*/
 
 interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
   // If any, enter additional props that only exist on this componentName

package/src/tasks/create/templates/SDK-React/field/Decimal-Percentage/index.tsx.mustache

@@ -7,6 +7,10 @@ import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event
 import { format } from '@pega/react-sdk-components/lib/components/helpers/formatters';
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
 
+/* Using @unicef/material-ui-currency-textfield component here, since it allows formatting decimal values,
+as per the locale.
+*/
+
 interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
   // If any, enter additional props that only exist on this componentName
   currencyISOCode: string;

package/src/tasks/create/templates/SDK-React/template/DETAILS/demo.stories.tsx.mustache

@@ -26,6 +26,13 @@ window.PCore = {
       }
     };
   },
+  getLocaleUtils: (): any => {
+    return {
+      getLocaleValue: value => {
+        return value;
+      }
+    };
+  },
   getEnvironmentInfo: (): any => {
     return {
       getUseLocale: () => {
@@ -63,6 +70,9 @@ export const Base{{COMPONENT_CLASS_NAME}}: Story = args => {
         },
         resolveConfigProps: () => {
           /* nothing */
+        },
+        createComponent: () => {
+          /* nothing */
         }
       };
     }

package/src/tasks/create/templates/SDK-React/template/DETAILS-region/demo.stories.tsx.mustache

@@ -6,9 +6,20 @@ import operatorDetails, { pyReviewRaw } from './mock';
 window.PCore = {
   ...window.PCore,
   getUserApi: (): any => {
-    return new Promise(resolve => {
-      resolve(operatorDetails);
-    });
+    return {
+      getOperatorDetails: () => {
+        return new Promise(resolve => {
+          resolve(operatorDetails);
+        });
+      }
+    };
+  },
+  getLocaleUtils: (): any => {
+    return {
+      getLocaleValue: value => {
+        return value;
+      }
+    };
   },
   getEnvironmentInfo: (): any => {
     return {
@@ -57,6 +68,9 @@ export const Base{{COMPONENT_CLASS_NAME}}: Story = args => {
         },
         resolveConfigProps: () => {
           /* nothing */
+        },
+        createComponent: () => {
+          /* nothing */
         }
       };
     }

package/src/tasks/index.js

@@ -17,3 +17,4 @@ export { default as upgrade } from './upgrade/index.js';
 export { default as buildComponent } from './build-comp/index.js';
 export { default as buildAllComponents } from './build-all/index.js';
 export { default as scanAndFix } from './scan-and-fix/index.js';
+export { default as buildJestAssets } from './build-jest-assets/index.js';

package/src/tasks/publish/helper.js

@@ -224,7 +224,7 @@ export const publishComponentToServer = async (data, doFetch = true) => {
 
   const configContentObj = JSON.parse(configContent);
 
-  if (configContentObj.type == null || configContentObj.subtype == null) {
+  if (!configContentObj.type) {
     console.log(chalk.bold.yellow(`No config-ext to publish for ${componentKey}`));
     return;
   }

package/src/util.js

@@ -443,6 +443,13 @@ export const getDirectoryFiles = async (directory) => {
   .map(dirent => dirent.name);
 }
 
+export const getListOfDirectories = async (directory) => {
+  return fs
+  .readdirSync(directory, { withFileTypes: true })
+  .filter(dirent => dirent.isDirectory())
+  .map(dirent => dirent.name);
+}
+
 
 export const getComponentsObj = async (showSeparator = false, category = CATEGORY_CUSTOM) => {
   const currentDirectory = process.cwd();

package/tests/assets/sdk-r/components/create/_components.md

@@ -0,0 +1,6 @@
+# The **components** directory
+
+The **src/components** directory contains the code for the components you want to use with the **React SDK**.
+
+When you run the **npm run  create** or **npm run override** commands to create new components, the generated code that
+you can use as a starting point for your component development will be placed in component-specific folders inside **src/components**.

package/tests/assets/sdk-r/components/create/custom-constellation/field/Pega_DXIL_MyTestText/demo.stories.tsx

@@ -2,27 +2,27 @@
 /* eslint-disable react/jsx-no-useless-fragment */
 // @ts-nocheck
 import { useState } from 'react';
-import { withKnobs } from '@storybook/addon-knobs';
+import type { Meta, StoryObj } from '@storybook/react';
 
 import { stateProps, configProps } from './mock';
 
 import PegaDxilMyTestText from './index';
 
-export default {
+const meta: Meta<typeof PegaDxilMyTestText> = {
   title: 'PegaDxilMyTestText',
-  decorators: [withKnobs],
-  component: PegaDxilMyTestText
+  component: PegaDxilMyTestText,
+  excludeStories: /.*Data$/
 };
 
-export const BasePegaDxilMyTestText = () => {
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyTestText>;
+
+export const BasePegaDxilMyTestText: Story = args => {
 
   const [value, setValue] = useState(configProps.value);
 
   const props = {
     value,
-    placeholder: configProps.placeholder,
-    label: configProps.label,
-    testId: configProps.testId,
     hasSuggestions: configProps.hasSuggestions,
 
     getPConnect: () => {
@@ -48,7 +48,21 @@ export const BasePegaDxilMyTestText = () => {
 
   return (
     <>
-      <PegaDxilMyTestText {...props} />
+      <PegaDxilMyTestText {...props} {...args} />
     </>
   );
 };
+
+BasePegaDxilMyTestText.args = {
+  label: configProps.label,
+  helperText: configProps.helperText,
+  placeholder: configProps.placeholder,
+  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/tests/assets/sdk-r/components/create/custom-constellation/field/Pega_DXIL_MyTestText/index.tsx

@@ -1,5 +1,4 @@
-import PropTypes from 'prop-types';
-import { Input } from '@pega/cosmos-react-core';
+import { Input, withConfiguration } from '@pega/cosmos-react-core';
 
 import type { PConnFieldProps } from './PConnProps';
 
@@ -21,8 +20,8 @@ interface StateProps {
 
 // 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 PegaDxilMyTestText(props: PegaDxilMyTestTextProps) {
-  const { getPConnect, value, placeholder, disabled, readOnly, required, label, hideLabel, testId } = props;
+function PegaDxilMyTestText(props: PegaDxilMyTestTextProps) {
+  const { getPConnect, value, placeholder, disabled = false, readOnly = false, required = false, label, hideLabel = false, testId } = props;
 
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
@@ -52,22 +51,5 @@ export default function PegaDxilMyTestText(props: PegaDxilMyTestTextProps) {
   );
 };
 
-PegaDxilMyTestText.defaultProps = {
-  value: '',
-  placeholder: '',
-  disabled: false,
-  readOnly: false,
-  required: false,
-  testId: ''
-};
 
-PegaDxilMyTestText.propTypes = {
-  label: PropTypes.string,
-  value: PropTypes.string,
-  placeholder: PropTypes.string,
-  getPConnect: PropTypes.func.isRequired,
-  disabled: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
-  readOnly: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
-  required: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
-  testId: PropTypes.string
-};
+export default withConfiguration(PegaDxilMyTestText);

package/tests/assets/sdk-r/components/create/custom-constellation/field/Pega_DXIL_MyTestText/mock.ts

@@ -6,7 +6,14 @@ export const configProps = {
   placeholder: 'Text Placeholder',
   helperText: 'Text Helper Text',
   testId: 'Text-12345678',
-  hasSuggestions: false
+  hasSuggestions: false,
+  displayMode: '',
+  hideLabel: false,
+  readOnly: false,
+  required: false,
+  disabled: false,
+  status: '',
+  validatemessage: ''
 };
 
 export const stateProps = {

package/tests/assets/sdk-r/components/create/custom-constellation/field/Pega_DXIL_MyTestText/styles.ts

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

package/tests/assets/sdk-r/components/create/override-sdk/designSystemExtension/CaseSummaryFields/CaseSummaryFields.tsx

@@ -109,9 +109,9 @@ export default function CaseSummaryFields(props: CaseSummaryFieldsProps) {
               label={field.config.label}
               InputProps={{
                 readOnly: true,
+                disableUnderline: true,
                 inputProps: {
-                  style: { cursor: 'pointer' },
-                  disableUnderline: true
+                  style: { cursor: 'pointer' }
                 }
               }}
             />

package/tests/assets/sdk-r/components/create/override-sdk/designSystemExtension/FieldValueList/FieldValueList.tsx

@@ -9,6 +9,7 @@ interface FieldValueListProps {
   name?: string;
   value: any;
   variant?: string;
+  isHtml?: boolean;
 }
 
 const useStyles = makeStyles(theme => ({
@@ -45,7 +46,7 @@ function formatItemValue(value) {
 }
 
 export default function FieldValueList(props: FieldValueListProps) {
-  const { name, value, variant = 'inline' } = props;
+  const { name, value, variant = 'inline', isHtml = false } = props;
   const classes = useStyles();
 
   function getGridItemLabel() {
@@ -63,9 +64,14 @@ export default function FieldValueList(props: FieldValueListProps) {
 
     return (
       <Grid item xs={variant === 'stacked' ? 12 : 6} className={variant === 'stacked' ? classes.noPaddingTop : ''}>
-        <Typography variant={variant === 'stacked' ? 'h6' : 'body2'} component='span' className={classes.fieldValue}>
-          {formattedValue}
-        </Typography>
+        {isHtml ? (
+          // eslint-disable-next-line react/no-danger
+          <div dangerouslySetInnerHTML={{ __html: formattedValue }} />
+        ) : (
+          <Typography variant={variant === 'stacked' ? 'h6' : 'body2'} component='span' className={classes.fieldValue}>
+            {formattedValue}
+          </Typography>
+        )}
       </Grid>
     );
   }