@pega/custom-dx-components 0.23.19 → 0.23.21

package/src/tasks/create/templates/Constellation/Field/Integer/demo.stories.jsx.mustache

@@ -1,6 +1,9 @@
+
+/* eslint-disable storybook/prefer-pascal-case */
+/* eslint-disable react/jsx-no-useless-fragment */
 import { withKnobs } from '@storybook/addon-knobs';
 
-import { stateProps, configProps, fieldMetadata } from './mock.stories';
+import { stateProps, configProps, fieldMetadata } from './mock';
 
 import {{COMPONENT_CLASS_NAME}} from './index.jsx';
 
@@ -10,7 +13,7 @@ export default {
   component: {{COMPONENT_CLASS_NAME}}
 };
 
-export const base{{COMPONENT_CLASS_NAME}} = () => {
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
 
   const props = {
     value: configProps.value,

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;

package/src/tasks/create/templates/Constellation/Field/Integer/{index.jsx.mustache → index.tsx.mustache}

@@ -2,6 +2,8 @@ import { useState, useEffect, useRef } from 'react';
 import { NumberInput, NumberDisplay, Slider, FieldValueList, CurrencyDisplay, Text } from '@pega/cosmos-react-core';
 import PropTypes from 'prop-types';
 
+import type { PConnFieldProps } from './PConnProps';
+
 // includes in bundle
 import handleEvent from "./event-utils";
 import { suggestionsHandler } from './suggestions-handler';
@@ -9,11 +11,44 @@ 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
+  displayAs?: string;
+  defaultValue: number;
+  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;
+  showInput: boolean;
+  min: number;
+  max: number;
+  step: number;
+  showTicks: boolean;
+}
+
+// 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
-const {{COMPONENT_CLASS_NAME}} = props => {
+export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
   const {
     getPConnect,
     value,
@@ -43,7 +78,8 @@ const {{COMPONENT_CLASS_NAME}} = props => {
   let { currencyDisplay } = props;
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
-  const propName = pConn.getStateProps().value;
+  const stateProps = pConn.getStateProps() as StateProps;
+  const propName: string = stateProps.value;
   const [integerValue, setIntegerValue] = useState(value?.toString());
   const sliderDefaultValue = !defaultValue && defaultValue !== 0 ? max : defaultValue;
 
@@ -63,9 +99,10 @@ const {{COMPONENT_CLASS_NAME}} = props => {
     if (hasSuggestions) {
       setStatus('pending');
     } else if (!hasSuggestions && status !== 'success') {
+      // @ts-ignore
       setStatus(validatemessage !== '' ? 'error' : undefined);
     }
-  }, [validatemessage, hasSuggestions]);
+  }, [validatemessage, hasSuggestions, status]);
 
   useEffect(() => {
     setIntegerValue(value?.toString());
@@ -73,17 +110,20 @@ const {{COMPONENT_CLASS_NAME}} = props => {
 
   useEffect(() => {
     if (displayAs === 'slider' && value === '') {
+      // @ts-ignore
       handleEvent(actions, 'change', propName, sliderDefaultValue);
     }
-  }, []);
+  }, [actions, displayAs, propName, sliderDefaultValue, value]);
 
   const { decimalPrecision, currencyDecimalPrecision, currencyISOCode } = props;
   let noOfDecimals = parseInt(decimalPrecision, 10);
+  // @ts-ignore
   if (Number.isNaN(noOfDecimals)) noOfDecimals = undefined;
   let noOfFractionDigits = currencyDecimalPrecision === 'auto' ? undefined : parseInt(currencyDecimalPrecision, 10);
   let unit;
   let unitPlacement;
 
+  // @ts-ignore
   if (['LABELS_LEFT', 'STACKED_LARGE_VAL', 'DISPLAY_ONLY'].includes(displayMode)) {
     switch (formatter) {
       case 'Decimal': {
@@ -184,23 +224,25 @@ const {{COMPONENT_CLASS_NAME}} = props => {
     }
   }
 
-  function onChangeHandler(enteredValue) {
+  function onChangeHandler(enteredValue: any) {
     if (hasSuggestions) {
-      setStatus(undefined);
+      setStatus('');
     }
     setIntegerValue(enteredValue);
     // const parsedValue = integerValue !== '' ? Number(integerValue) : '';
     if (value !== (enteredValue !== '' ? Number(enteredValue) : '')) {
+      // @ts-ignore
       handleEvent(actions, 'change', propName, enteredValue !== '' ? Number(enteredValue) : '');
       hasValueChange.current = true;
     }
     // In case of stepper variation there is no blur event as component is never focussed unless forced. Need to update redux on change.
     if (displayAs === 'stepper') {
+      // @ts-ignore
       handleEvent(actions, 'changeNblur', propName, enteredValue !== '' ? Number(enteredValue) : '');
     }
   }
 
-  const onResolveSuggestionHandler = (accepted) => {
+  const onResolveSuggestionHandler = (accepted: boolean) => {
     suggestionsHandler(accepted, pConn, setStatus);
   };
 
@@ -227,6 +269,7 @@ const {{COMPONENT_CLASS_NAME}} = props => {
       ticks={showTicks && { [min]: `${min}`, [max]: `${max}` }}
       onChange={(selectedValue) => {
         onChangeHandler(selectedValue.toString());
+        // @ts-ignore
         handleEvent(actions, 'changeNblur', propName, selectedValue);
       }}
     />
@@ -253,9 +296,10 @@ const {{COMPONENT_CLASS_NAME}} = props => {
       }}
       onBlur={() => {
         if (!readOnly && (hasValueChange.current || !value)) {
+          // @ts-ignore
           handleEvent(actions, 'blur', propName, integerValue !== '' ? Number(integerValue) : '');
           if (hasSuggestions) {
-            pConn.ignoreSuggestion();
+            pConn.ignoreSuggestion('');
           }
           hasValueChange.current = false;
         }
@@ -333,5 +377,3 @@ const {{COMPONENT_CLASS_NAME}} = props => {
   isTableFormatter: PropTypes.bool,
   hasSuggestions: PropTypes.bool
 };
-
-export default {{COMPONENT_CLASS_NAME}};

package/{tests/assets/components/createAll/Constellation/Pega_DXIL_MyInteger/mock.stories.js → src/tasks/create/templates/Constellation/Field/Integer/mock.js.mustache}

@@ -1,3 +1,5 @@
+/* eslint-disable storybook/default-exports */
+/* eslint-disable storybook/prefer-pascal-case */
 export const configProps = {
   value: '',
   label: 'Integer Sample',

package/src/tasks/create/templates/Constellation/Field/Integer/styles.ts.mustache

@@ -0,0 +1,15 @@
+
+// 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/src/tasks/create/templates/Constellation/Field/Integer/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/Picklist/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/Picklist/demo.stories.jsx.mustache

@@ -1,7 +1,10 @@
+
+/* eslint-disable storybook/prefer-pascal-case */
+/* eslint-disable react/jsx-no-useless-fragment */
 import { useState } from 'react';
 import { withKnobs } from '@storybook/addon-knobs';
 
-import { configProps, rawMetadata, fieldMetadata, stateProps } from './mock.stories.js';
+import { configProps, rawMetadata, fieldMetadata, stateProps } from './mock.js';
 
 import {{COMPONENT_CLASS_NAME}} from './index.jsx';
 
@@ -11,7 +14,7 @@ export default {
   component: {{COMPONENT_CLASS_NAME}}
 };
 
-export const base{{COMPONENT_CLASS_NAME}} = () => {
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
   // eslint-disable-next-line react-hooks/rules-of-hooks
   const [value, setValue] = useState(configProps.value);
 

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

package/src/tasks/create/templates/Constellation/Field/Picklist/{index.jsx.mustache → index.tsx.mustache}

@@ -1,7 +1,10 @@
+/* eslint-disable react-hooks/exhaustive-deps */
 import { useState, useEffect, useRef } from 'react';
 import { Select, Option, FieldValueList, Text } from '@pega/cosmos-react-core';
 import PropTypes from 'prop-types';
 
+import type { PConnFieldProps } from './PConnProps';
+
 // includes in bundle
 import handleEvent from "./event-utils";
 import { suggestionsHandler } from './suggestions-handler';
@@ -9,7 +12,35 @@ import { suggestionsHandler } from './suggestions-handler';
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
 import {EmailDisplay, PhoneDisplay, URLDisplay } from "@pega/cosmos-react-core";
 
-export const formatExists = (formatterVal) => {
+
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  defaultValue: number;
+  isTableFormatter?: boolean;
+  hasSuggestions?: boolean;
+  variant?: any;
+  formatter: string;
+  decimalPrecision: string;
+  allowDecimals: boolean;
+  currencyISOCode: string;
+  alwaysShowISOCode: boolean;
+  isoCodeSelection: string;
+  additionalProps: any;
+  datasource:Array<any>;
+  listType: string;
+  fieldMetadata: any;
+  onRecordChange: Function;
+}
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
+
+
+export const formatExists = (formatterVal: string) => {
     const formatterValues = [
       "TextInput",
       "WorkStatus",
@@ -27,7 +58,7 @@ export const formatExists = (formatterVal) => {
   };
 
 
-export const textFormatter = (formatter,value) => {
+export const textFormatter = (formatter: string,value: any) => {
   let displayComponent = null;
   switch(formatter){
     case "TextInput" : {
@@ -52,14 +83,14 @@ export const textFormatter = (formatter,value) => {
 };
 
 
-export const setDefaultValue = (dropdownOptions, pConnect, propName) => {
+export const setDefaultValue = (dropdownOptions: Array<any>, pConnect: any, propName: string) => {
   // calculate the default option and set it to dropdown
   const option = (dropdownOptions && dropdownOptions[0]) || {};
   const defaultValue = option.key ? option.props.value : '';
   pConnect.setValue(propName, defaultValue, defaultValue);
 };
 
-const pushPlaceholderOption = (placeholder, listSourceItems, items, pConnect) => {
+const pushPlaceholderOption = (placeholder: string, listSourceItems: Array<any>, items: Array<any>, pConnect: any) => {
   // If we have a placeholder, push that option in the list of items
   if (placeholder) {
     items.push(
@@ -69,6 +100,7 @@ const pushPlaceholderOption = (placeholder, listSourceItems, items, pConnect) =>
     );
   } else if (!listSourceItems) {
     // If we don't have a placeholder and our list source is empty, push a blank row option in the list of items
+    // @ts-ignore
     items.push(<Option key='' value='' />);
   }
 };
@@ -78,7 +110,7 @@ const pushPlaceholderOption = (placeholder, listSourceItems, items, pConnect) =>
 
 // 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 => {
+export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
   const {
     getPConnect,
     value,
@@ -101,7 +133,8 @@ const {{COMPONENT_CLASS_NAME}} = props => {
   const { formatter } = props;
   const pConnect = getPConnect();
   const actions = pConnect.getActionsApi();
-  const propName = pConnect.getStateProps().value;
+  const stateProps = pConnect.getStateProps() as StateProps;
+  const propName: string = stateProps.value;
   const className = pConnect.getCaseInfo().getClassName();
   const refName = propName?.slice(propName.lastIndexOf('.') + 1);
 
@@ -133,11 +166,13 @@ const {{COMPONENT_CLASS_NAME}} = props => {
   const localePath = localeContext === 'datapage' ? displayName : '';
 
   const configProps = pConnect.getConfigProps();
-  const items = [];
+  const items: Array<any> = [];
   const isDatapage = listType === 'datapage';
+  // @ts-ignore
   let listSourceItems = isDatapage ? configProps.listOutput : datasource;
 
   if (isDatapage && typeof datasource === 'object' && !Array.isArray(listSourceItems)) {
+    // @ts-ignore
     listSourceItems = datasource.source ? datasource.source : [];
   }
 
@@ -150,13 +185,14 @@ const {{COMPONENT_CLASS_NAME}} = props => {
     } else if (!hasSuggestions && status !== 'success') {
       setStatus(validatemessage !== '' ? 'error' : undefined);
     }
-  }, [validatemessage, hasSuggestions]);
+  }, [validatemessage, hasSuggestions, status]);
 
-  pushPlaceholderOption(placeholder, listSourceItems, items, pConnect);
+  pushPlaceholderOption(placeholder as string, listSourceItems, items, pConnect);
 
   // Loop through all of our list source items that make up the values of the dropdown
 
   let selectedLabel = '';
+  // @ts-ignore
   (listSourceItems || []).forEach((item) => {
     selectedLabel =
       value !== undefined &&
@@ -172,11 +208,13 @@ const {{COMPONENT_CLASS_NAME}} = props => {
           ? pConnect.getLocalizedValue(
               item.text,
               localePath,
+              // @ts-ignore
               pConnect.getLocaleRuleNameFromKeys(localeClass, localeContext, localeName)
             )
           : pConnect.getLocalizedValue(
               item.value,
               localePath,
+              // @ts-ignore
               pConnect.getLocaleRuleNameFromKeys(localeClass, localeContext, localeName)
             )}
       </Option>
@@ -205,7 +243,7 @@ const {{COMPONENT_CLASS_NAME}} = props => {
     if (!isDisplayModeEnabled && ((!placeholder && !value) || (!isMount && value && !selectedLabel))) {
       setDefaultValue(items, pConnect, propName);
     }
-  }, [firstOptionKey, firstOptionValue, placeholder, selectedLabel, value, propName]);
+  }, [firstOptionKey, firstOptionValue, placeholder, selectedLabel, value, propName, isDisplayModeEnabled, isMount, pConnect]);
 
   if (displayMode === 'LABELS_LEFT' || displayMode === 'DISPLAY_ONLY') {
     let displayComp = selectedLabel;
@@ -258,7 +296,7 @@ const {{COMPONENT_CLASS_NAME}} = props => {
     );
   }
 
-  const onResolveSuggestionHandler = (accepted) => {
+  const onResolveSuggestionHandler = (accepted: boolean) => {
     suggestionsHandler(accepted, pConnect, setStatus);
   };
 
@@ -272,22 +310,26 @@ const {{COMPONENT_CLASS_NAME}} = props => {
       info={validatemessage || helperText}
       status={status}
       data-testid={testId}
+      // @ts-ignore
       key={getPConnect().getRawMetadata().config.value}
       value={value}
       disabled={disabled}
       required={required}
       readOnly={readOnly}
       onChange={(event) => {
+        // @ts-ignore
         handleEvent(actions, 'changeNblur', propName, event.target.value);
         if (hasSuggestions) {
-          pConnect.ignoreSuggestion();
+          pConnect.ignoreSuggestion('');
           setStatus(undefined);
         }
         if (onRecordChange) {
           onRecordChange(event);
         }
       }}
+      // @ts-ignore
       onBlur={(event) => {
+        // @ts-ignore
         pConnect.getValidationApi().validate(event.target.value);
       }}
       onResolveSuggestion={onResolveSuggestionHandler}
@@ -348,5 +390,3 @@ const {{COMPONENT_CLASS_NAME}} = props => {
   isTableFormatter: PropTypes.bool,
   hasSuggestions: PropTypes.bool
 };
-
-export default {{COMPONENT_CLASS_NAME}};

package/{tests/assets/components/createAll/Constellation/Pega_DXIL_MyPicklist/mock.stories.js → src/tasks/create/templates/Constellation/Field/Picklist/mock.js.mustache}

@@ -1,3 +1,5 @@
+/* eslint-disable storybook/default-exports */
+/* eslint-disable storybook/prefer-pascal-case */
 export const configProps = {
   value: '',
   label: 'Picklist Sample',

package/src/tasks/create/templates/Constellation/Field/Picklist/styles.ts.mustache

@@ -0,0 +1,15 @@
+
+// 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/src/tasks/create/templates/Constellation/Field/Picklist/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/Picklist-Autocomplete/PConnProps.d.ts

@@ -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/Picklist-Autocomplete/component-constants.js

@@ -0,0 +1,5 @@
+export default {
+  PROPERTY_REFERENCE: 'propertyRef',
+  WORK_BASKET: 'workbasket',
+  WORK_QUEUE: 'workqueue'
+};