@pega/custom-dx-components 0.23.14 → 0.23.15

package/src/tasks/create/templates/Constellation/Field/Text-Phone/index.jsx.mustache

@@ -79,12 +79,15 @@ const {{COMPONENT_CLASS_NAME}} = props => {
     additionalProps,
     variant,
     isTableFormatter,
-    hasSuggestions
+    hasSuggestions,
+    fieldMetadata,
+    enableAdditionalInformation
   } = props;
   const { formatter } = props;
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
   const propName = pConn.getStateProps().value;
+  const fieldDescription = fieldMetadata?.description;
   const hasValueChange = useRef(false);
 
  let callingCodesList = [];
@@ -216,6 +219,14 @@ const {{COMPONENT_CLASS_NAME}} = props => {
         }
       }}
       onResolveSuggestion={onResolveSuggestionHandler}
+      {...(enableAdditionalInformation && fieldDescription
+        ? {
+            additionalInfo: {
+              heading: label,
+              content: fieldDescription
+            }
+          }
+        : {})}
     />
     </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
   );
@@ -238,7 +249,9 @@ const {{COMPONENT_CLASS_NAME}} = props => {
   variant: 'inline',
   formatter: '',
   isTableFormatter: false,
-  hasSuggestions: false
+  hasSuggestions: false,
+  fieldMetadata: {},
+  enableAdditionalInformation: false
 };
 
 {{COMPONENT_CLASS_NAME}}.propTypes = {
@@ -260,7 +273,9 @@ const {{COMPONENT_CLASS_NAME}} = props => {
   variant: PropTypes.string,
   formatter: PropTypes.string,
   isTableFormatter: PropTypes.bool,
-  hasSuggestions: PropTypes.bool
+  hasSuggestions: PropTypes.bool,
+  fieldMetadata: PropTypes.objectOf(PropTypes.any),
+  enableAdditionalInformation: PropTypes.bool
 };
 
 export default {{COMPONENT_CLASS_NAME}};

package/src/tasks/create/templates/Constellation/Field/Text-URL/index.jsx.mustache

@@ -38,12 +38,15 @@ const {{COMPONENT_CLASS_NAME}} = props => {
     propUrlLabel,
     urlLabelSelection,
     tableDisplayAs,
-    hasSuggestions
+    hasSuggestions,
+    fieldMetadata,
+    enableAdditionalInformation
   } = props;
   const { formatter } = props;
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
   const propName = pConn.getStateProps().value;
+  const fieldDescription = fieldMetadata?.description;
   const hasValueChange = useRef(false);
 
 
@@ -166,6 +169,14 @@ const {{COMPONENT_CLASS_NAME}} = props => {
       }}
       onFocus={actions.onFocus}
       onResolveSuggestion={onResolveSuggestionHandler}
+      {...(enableAdditionalInformation && fieldDescription
+        ? {
+            additionalInfo: {
+              heading: label,
+              content: fieldDescription
+            }
+          }
+        : {})}
     />
     </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
   );
@@ -196,7 +207,9 @@ const {{COMPONENT_CLASS_NAME}} = props => {
   propUrlLabel: '',
   urlLabelSelection: 'constant',
   tableDisplayAs: 'link',
-  hasSuggestions: false
+  hasSuggestions: false,
+  fieldMetadata: {},
+  enableAdditionalInformation: false
 };
 
 {{COMPONENT_CLASS_NAME}}.propTypes = {
@@ -226,7 +239,9 @@ const {{COMPONENT_CLASS_NAME}} = props => {
   propUrlLabel: PropTypes.string,
   urlLabelSelection: PropTypes.string,
   tableDisplayAs: PropTypes.string,
-  hasSuggestions: PropTypes.bool
+  hasSuggestions: PropTypes.bool,
+  fieldMetadata: PropTypes.objectOf(PropTypes.any),
+  enableAdditionalInformation: PropTypes.bool
 };
 
 export default {{COMPONENT_CLASS_NAME}};

package/src/tasks/create/templates/Constellation/Field/TimeofDay/index.jsx.mustache

@@ -31,13 +31,15 @@ const {{COMPONENT_CLASS_NAME}} = props => {
     additionalProps,
     displayMode,
     variant,
-    hasSuggestions
+    hasSuggestions,
+    fieldMetadata,
+    enableAdditionalInformation
   } = props;
   let { formatter } = props;
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
   const propName = pConn.getStateProps().value;
-
+  const fieldDescription = fieldMetadata?.description;
 
   // BUG-547602: Temporary type coercion for 8.5 until DXAPIs are enhanced to pass original pxViewMetadata JSON, respecting boolean primitives
   let { readOnly, required, disabled } = props;
@@ -167,6 +169,14 @@ const {{COMPONENT_CLASS_NAME}} = props => {
       onChange={handleChange}
       onBlur={handleBlur}
       onResolveSuggestion={onResolveSuggestionHandler}
+      {...(enableAdditionalInformation && fieldDescription
+        ? {
+            additionalInfo: {
+              heading: label,
+              content: fieldDescription
+            }
+          }
+        : {})}
     />
     </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
   );
@@ -187,7 +197,10 @@ const {{COMPONENT_CLASS_NAME}} = props => {
   additionalProps: {},
   displayMode: null,
   variant: "inline",
-  formatter:"defaultTime"
+  formatter:"defaultTime",
+  hasSuggestions: false,
+  fieldMetadata: {},
+  enableAdditionalInformation: false
 };
 
 {{COMPONENT_CLASS_NAME}}.propTypes = {
@@ -207,7 +220,10 @@ const {{COMPONENT_CLASS_NAME}} = props => {
   additionalProps: PropTypes.objectOf(PropTypes.any),
   displayMode: PropTypes.string,
   variant: PropTypes.string,
-  formatter : PropTypes.string
+  formatter : PropTypes.string,
+  hasSuggestions: PropTypes.bool,
+  fieldMetadata: PropTypes.objectOf(PropTypes.any),
+  enableAdditionalInformation: PropTypes.bool
 };
 
 export default {{COMPONENT_CLASS_NAME}};

package/src/tasks/init/index.js

@@ -99,7 +99,7 @@ export default async (options) => {
 
     const targetDirectory = options.targetDirectory || process.cwd();
     options.targetDirectory = path.join(targetDirectory, projectName);
-    // options.componentDirectory = path.join(options.targetDirectory, 'node_modules/@pega/custom-dx-components');
+    options.componentDirectory = path.join(options.targetDirectory, 'node_modules/@pega/custom-dx-components');
   });
 
   const installDependenciesText = `Installing dependencies. This will take a couple of minutes.`;
@@ -123,10 +123,10 @@ export default async (options) => {
         title: installDependenciesText,
         task: () => execPromise('npm i --force --production=false', { cwd: options.targetDirectory })
       },
-      // {
-      //   title: 'Installing tasks dependencies',
-      //   task: () => execPromise('npm i --force --production=false', { cwd: options.componentDirectory })
-      // },
+      {
+        title: 'Installing tasks dependencies',
+        task: () => execPromise('npm i --force --production=false', { cwd: options.componentDirectory })
+      },
       {
         title: 'Installing quick run',
         task: () => execPromise('npm i -g npm-quick-run', { cwd: options.targetDirectory })

package/src/tasks/init/template/jest.config.cjs

@@ -0,0 +1,21 @@
+module.exports = {
+  verbose: true,
+  moduleFileExtensions: ['js', 'jsx', 'ts', 'tsx'],
+  transform: {
+    '^.+\\.[t|j]sx?$': 'babel-jest'
+  },
+  collectCoverage: true,
+  testPathIgnorePatterns: [],
+  transformIgnorePatterns: [],
+  modulePathIgnorePatterns: [],
+  coveragePathIgnorePatterns: [],
+  collectCoverageFrom: ['./node_modules/@pega/custom-dx-components/src/*.js'],
+  coverageThreshold: {
+    global: {
+      statements: 79,
+      branches: 74,
+      functions: 81,
+      lines: 80
+    }
+  }
+};

package/src/tasks/init/template/package.json.mustache

@@ -66,7 +66,7 @@
   },
   "devDependencies": {
     "@pega/configs": "^0.5.3",
-    "@pega/custom-dx-components": "^0.23.14",
+    "@pega/custom-dx-components": "^0.23.15",
     "@pega/eslint-config": "^0.3.2",
     "@storybook/addon-actions": "^6.5.12",
     "@storybook/addon-essentials": "^6.5.12",

package/tests/assets/components/create/Pega_DXIL_MyTestText/index.jsx

@@ -1,5 +1,5 @@
 import PropTypes from 'prop-types';
-import { Input, Label } from '@pega/cosmos-react-core';
+import { Input } from '@pega/cosmos-react-core';
 
 import StyledPegaDxilMyTestTextWrapper from './styles';
 
@@ -9,7 +9,7 @@ import StyledPegaDxilMyTestTextWrapper from './styles';
 // 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 PegaDxilMyTestText = props => {
-  const { getPConnect, value, placeholder, disabled, readOnly, required, label, testId } = props;
+  const { getPConnect, value, placeholder, disabled, readOnly, required, label, hideLabel, testId } = props;
 
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
@@ -22,10 +22,11 @@ const PegaDxilMyTestText = props => {
 
   return (
     <StyledPegaDxilMyTestTextWrapper>
-      <Label>{label}</Label>
       <Input
         type='text'
         value={value}
+        label={label}
+        labelHidden={hideLabel}
         placeholder={placeholder}
         disabled={disabled}
         readOnly={readOnly}
@@ -43,7 +44,7 @@ PegaDxilMyTestText.defaultProps = {
   disabled: false,
   readOnly: false,
   required: false,
-  testId: null
+  testId: ''
 };
 
 PegaDxilMyTestText.propTypes = {

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyBoolean/index.jsx

@@ -29,12 +29,21 @@ const PegaDxilMyBoolean = props => {
     displayMode,
     variant,
     trueLabel,
-    falseLabel
+    falseLabel,
+    fieldMetadata
   } = props;
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
   const propName = pConn.getStateProps().value;
 
+  const fieldAdditionalInfo = fieldMetadata?.additionalInformation;
+  const additionalInfo = fieldAdditionalInfo
+    ? {
+        heading: caption,
+        content: fieldAdditionalInfo
+      }
+    : undefined;
+
   let { readOnly, required, disabled } = props;
   [readOnly, required, disabled] = [readOnly, required, disabled].map(
     (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
@@ -62,10 +71,11 @@ const PegaDxilMyBoolean = props => {
         pConn.getValidationApi().validate(event.target.checked);
       }}
       data-testid={testId}
+      additionalInfo={additionalInfo}
     />
   );
 
-  const parentTestId = testId ? `${testId}-parent` : testId;
+  const parentTestId = testId === '' ? `${testId}-parent` : testId;
 
   let displayComponent;
   if (displayMode) {
@@ -138,13 +148,14 @@ PegaDxilMyBoolean.defaultProps = {
   disabled: false,
   readOnly: false,
   required: false,
-  testId: null,
+  testId: '',
   additionalProps: {},
   displayMode: null,
   variant: 'inline',
   displayValue: 'Yes/No',
   trueLabel: '',
-  falseLabel: ''
+  falseLabel: '',
+  fieldMetadata: {}
 };
 
 PegaDxilMyBoolean.propTypes = {
@@ -164,7 +175,8 @@ PegaDxilMyBoolean.propTypes = {
   variant: PropTypes.string,
   displayValue: PropTypes.string,
   trueLabel: PropTypes.string,
-  falseLabel: PropTypes.string
+  falseLabel: PropTypes.string,
+  fieldMetadata: PropTypes.objectOf(PropTypes.any)
 };
 
 export default PegaDxilMyBoolean;

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

@@ -46,13 +46,23 @@ const PegaDxilMyCurrency = props => {
     negative,
     notation,
     isTableFormatter,
-    hasSuggestions
+    hasSuggestions,
+    fieldMetadata,
+    enableAdditionalInformation
   } = props;
   let { currencyDisplay } = props;
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
   const propName = pConn.getStateProps().value;
   const [currencyValue, setCurrencyValue] = useState(() => formatValue(value));
+  const fieldDescription = fieldMetadata?.description;
+  const additionalInfo =
+    enableAdditionalInformation && fieldDescription
+      ? {
+          heading: label,
+          content: fieldDescription
+        }
+      : undefined;
 
   let { readOnly, required, disabled } = props;
 
@@ -211,6 +221,7 @@ const PegaDxilMyCurrency = props => {
       readOnly={readOnly}
       required={required}
       data-testid={testId}
+      additionalInfo={additionalInfo}
       onChange={(enteredValue) => {
         if (hasSuggestions) {
           setStatus(undefined);
@@ -248,7 +259,7 @@ PegaDxilMyCurrency.defaultProps = {
   allowDecimals: true,
   currencyISOCode: 'USD',
   isoCodeSelection: 'constant',
-  testId: null,
+  testId: '',
   displayMode: null,
   additionalProps: {},
   variant: 'inline',
@@ -260,7 +271,9 @@ PegaDxilMyCurrency.defaultProps = {
   currencyDecimalPrecision: 'auto',
   isTableFormatter: false,
   alwaysShowISOCode: false,
-  hasSuggestions: false
+  hasSuggestions: false,
+  fieldMetadata: {},
+  enableAdditionalInformation: false
 };
 
 PegaDxilMyCurrency.propTypes = {
@@ -290,7 +303,9 @@ PegaDxilMyCurrency.propTypes = {
   currencyDecimalPrecision: PropTypes.string,
   isTableFormatter: PropTypes.bool,
   alwaysShowISOCode: PropTypes.bool,
-  hasSuggestions: PropTypes.bool
+  hasSuggestions: PropTypes.bool,
+  fieldMetadata: PropTypes.objectOf(PropTypes.any),
+  enableAdditionalInformation: PropTypes.bool
 };
 
 export default PegaDxilMyCurrency;

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDate/config.json

@@ -117,6 +117,11 @@
           "name": "helperText",
           "label": "Helper text",
           "format": "TEXT"
+        },
+        {
+          "name": "enableAdditionalInformation",
+          "label": "Enable additional information on field",
+          "format": "BOOLEAN"
         }
       ]
     },
@@ -141,7 +146,11 @@
             },
             {
               "key": "DateTime-Long",
-              "value": "Date Time"
+              "value": "Date (Long)"
+            },
+            {
+              "key": "DateTime-Short",
+              "value": "Date (Short)"
             },
             {
               "key": "DateTime-Since",

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDate/index.jsx

@@ -38,7 +38,9 @@ const PegaDxilMyDate = props => {
     additionalProps,
     displayMode,
     variant,
-    hasSuggestions
+    hasSuggestions,
+    fieldMetadata,
+    enableAdditionalInformation
    } = props;
 
   let {formatter} = props;
@@ -182,6 +184,15 @@ const PegaDxilMyDate = props => {
       </StyledPegaDxilMyDateWrapper>
     );
   } else {
+    const fieldDescription = fieldMetadata?.description;
+    const additionalInfo =
+      enableAdditionalInformation && fieldDescription
+        ? {
+            heading: label,
+            content: fieldDescription
+          }
+        : undefined;
+
     dateComponent = (
       <StyledPegaDxilMyDateWrapper>
       <DateInput
@@ -189,6 +200,7 @@ const PegaDxilMyDate = props => {
         label={label}
         labelHidden={hideLabel}
         info={validatemessage || helperText}
+        additionalInfo={additionalInfo}
         status={status}
         value={value || undefined}
         disabled={disabled}
@@ -222,13 +234,15 @@ PegaDxilMyDate.defaultProps = {
   showWeekNumber: false,
   nextYearRange: "",
   previousYearRange: "",
-  testId: null,
+  testId: "",
   showAsFormattedText: false,
   additionalProps: {},
   displayMode: null,
   variant: "inline",
   formatter: "defaultDate",
-  hasSuggestions: false
+  hasSuggestions: false,
+  fieldMetadata: {},
+  enableAdditionalInformation: false
 };
 
 PegaDxilMyDate.propTypes = {
@@ -250,7 +264,9 @@ PegaDxilMyDate.propTypes = {
   displayMode: PropTypes.string,
   variant: PropTypes.string,
   formatter: PropTypes.string,
-  hasSuggestions: PropTypes.bool
+  hasSuggestions: PropTypes.bool,
+  fieldMetadata: PropTypes.objectOf(PropTypes.any),
+  enableAdditionalInformation: PropTypes.bool
 };
 
 export default PegaDxilMyDate;

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDateTime/index.jsx

@@ -40,12 +40,22 @@ const PegaDxilMyDateTime = props => {
     additionalProps,
     displayMode,
     variant,
-    hasSuggestions
+    hasSuggestions,
+    fieldMetadata,
+    enableAdditionalInformation
   } = props;
   let { formatter } = props;
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
   const propName = pConn.getStateProps().value;
+  const fieldDescription = fieldMetadata?.description;
+  const additionalInfo =
+    enableAdditionalInformation && fieldDescription
+      ? {
+          heading: label,
+          content: fieldDescription
+        }
+      : undefined;
 
   const environmentInfo = PCore.getEnvironmentInfo();
   const timezone = environmentInfo && environmentInfo.getTimeZone();
@@ -181,6 +191,7 @@ const PegaDxilMyDateTime = props => {
       label={label}
       labelHidden={hideLabel}
       info={validatemessage || helperText}
+      additionalInfo={additionalInfo}
       status={status}
       value={DateTimeFormatter.convertToTimezone(value, { timezone }) || undefined}
       withSeconds={withSeconds}
@@ -218,12 +229,14 @@ PegaDxilMyDateTime.defaultProps = {
   showWeekNumber: false,
   nextYearRange: "",
   previousYearRange: "",
-  testId: null,
+  testId: "",
   additionalProps: {},
   displayMode: null,
   variant: "inline",
   Format: "defaultDateTime",
-  hasSuggestions: false
+  hasSuggestions: false,
+  fieldMetadata: {},
+  enableAdditionalInformation: false
 };
 
 PegaDxilMyDateTime.propTypes = {
@@ -248,7 +261,9 @@ PegaDxilMyDateTime.propTypes = {
   variant: PropTypes.string,
   formatter: PropTypes.string,
   Format: PropTypes.string,
-  hasSuggestions: PropTypes.bool
+  hasSuggestions: PropTypes.bool,
+  fieldMetadata: PropTypes.objectOf(PropTypes.any),
+  enableAdditionalInformation: PropTypes.bool
 };
 
 export default PegaDxilMyDateTime;

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDecimal/index.jsx

@@ -30,7 +30,9 @@ const PegaDxilMyDecimal = props => {
     notation,
     currencyISOCode,
     isTableFormatter,
-    hasSuggestions
+    hasSuggestions,
+    fieldMetadata,
+    enableAdditionalInformation
   } = props;
   let { showGroupSeparators } = props;
   let { currencyDisplay } = props;
@@ -38,6 +40,14 @@ const PegaDxilMyDecimal = props => {
   const actions = pConn.getActionsApi();
   const propName = pConn.getStateProps().value;
   const [decimalValue, setDecimalValue] = useState(value?.toString());
+  const fieldDescription = fieldMetadata?.description;
+  const additionalInfo =
+    enableAdditionalInformation && fieldDescription
+      ? {
+          heading: label,
+          content: fieldDescription
+        }
+      : undefined;
   const hasValueChange = useRef(false);
 
   let { readOnly, required, disabled } = props;
@@ -187,6 +197,7 @@ const PegaDxilMyDecimal = props => {
       numberOfDecimals={numberOfDecimals}
       showGroupSeparators={showGroupSeparators}
       data-testid={testId}
+      additionalInfo={additionalInfo}
       onChange={(enteredValue) => {
         if (hasSuggestions) {
           setStatus(undefined);
@@ -222,7 +233,7 @@ PegaDxilMyDecimal.defaultProps = {
   disabled: false,
   readOnly: false,
   required: false,
-  testId: null,
+  testId: "",
   decimalPrecision: '',
   showGroupSeparators: false,
   displayMode: null,
@@ -236,7 +247,9 @@ PegaDxilMyDecimal.defaultProps = {
   currencyDisplay: 'symbol',
   currencyDecimalPrecision: 'auto',
   isTableFormatter: false,
-  hasSuggestions: false
+  hasSuggestions: false,
+  fieldMetadata: {},
+  enableAdditionalInformation: false
 };
 
 PegaDxilMyDecimal.propTypes = {
@@ -264,7 +277,9 @@ PegaDxilMyDecimal.propTypes = {
   currencyDisplay: PropTypes.string,
   currencyDecimalPrecision: PropTypes.string,
   isTableFormatter: PropTypes.bool,
-  hasSuggestions: PropTypes.bool
+  hasSuggestions: PropTypes.bool,
+  fieldMetadata: PropTypes.objectOf(PropTypes.any),
+  enableAdditionalInformation: PropTypes.bool
 };
 
 export default PegaDxilMyDecimal;

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyEmail/index.jsx

@@ -70,12 +70,23 @@ const PegaDxilMyEmail = props => {
     additionalProps,
     variant,
     isTableFormatter,
-    hasSuggestions
+    hasSuggestions,
+    fieldMetadata,
+    enableAdditionalInformation
   } = props;
   const { formatter } = props;
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
   const propName = pConn.getStateProps().value;
+  const fieldDescription = fieldMetadata?.description;
+  const additionalInfo =
+    enableAdditionalInformation && fieldDescription
+      ? {
+          heading: label,
+          content: fieldDescription
+        }
+      : undefined;
+
   const hasValueChange = useRef(false);
 
 
@@ -157,6 +168,7 @@ const PegaDxilMyEmail = props => {
       label={label}
       labelHidden={hideLabel}
       info={validatemessage || helperText}
+      additionalInfo={additionalInfo}
       value={inputValue}
       status={status}
       placeholder={placeholder}
@@ -199,13 +211,15 @@ PegaDxilMyEmail.defaultProps = {
   disabled: false,
   readOnly: false,
   required: false,
-  testId: null,
+  testId: '',
   displayMode: null,
   additionalProps: {},
   variant: 'inline',
   formatter: '',
   isTableFormatter: false,
-  hasSuggestions: false
+  hasSuggestions: false,
+  fieldMetadata: {},
+  enableAdditionalInformation: false
 };
 
 PegaDxilMyEmail.propTypes = {
@@ -225,7 +239,9 @@ PegaDxilMyEmail.propTypes = {
   variant: PropTypes.string,
   formatter: PropTypes.string,
   isTableFormatter: PropTypes.bool,
-  hasSuggestions: PropTypes.bool
+  hasSuggestions: PropTypes.bool,
+  fieldMetadata: PropTypes.objectOf(PropTypes.any),
+  enableAdditionalInformation: PropTypes.bool
 };
 
 export default PegaDxilMyEmail;