@pega/custom-dx-components 0.23.21 → 0.23.23

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyCurrency/demo.stories.tsx

@@ -0,0 +1,56 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import { withKnobs } from '@storybook/addon-knobs';
+
+import { configProps, fieldMetadata, stateProps } from './mock';
+
+import PegaDxilMyCurrency from './index';
+
+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/Constellation/Pega_DXIL_MyCurrency/{event-utils.js → event-utils.ts}

@@ -1,12 +1,12 @@
-const handleEvent = (actions, eventType, propName, value) => {
+const handleEvent = (actions: any, eventType: string, propName: string, value: string) => {
   switch (eventType) {
-    case "change":
+    case 'change':
       actions.updateFieldValue(propName, value);
       break;
-    case "blur":
+    case 'blur':
       actions.triggerFieldChange(propName, value);
       break;
-    case "changeNblur":
+    case 'changeNblur':
       actions.updateFieldValue(propName, value);
       actions.triggerFieldChange(propName, value);
       break;

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyCurrency/{index.jsx → index.tsx}

@@ -10,13 +10,42 @@ import {
 } 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';
 
 import StyledPegaDxilMyCurrencyWrapper from './styles';
 
-const formatValue = (value) => {
+// interface for props
+interface PegaDxilMyCurrencyProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  displayAsStatus?: boolean;
+  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;
+}
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
+
+const formatValue = (value: any) => {
   if (!value && value !== 0) return '';
   const [integer, decimal = ''] = value.toString().split('.');
   return `${integer}.${decimal.padEnd(3, '0')}`;
@@ -27,7 +56,7 @@ const formatValue = (value) => {
 
 // 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 => {
+export default function PegaDxilMyCurrency(props: PegaDxilMyCurrencyProps) {
   const {
     getPConnect,
     value,
@@ -52,7 +81,8 @@ const PegaDxilMyCurrency = 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 [currencyValue, setCurrencyValue] = useState(() => formatValue(value));
 
   let { readOnly, required, disabled } = props;
@@ -79,11 +109,16 @@ const PegaDxilMyCurrency = props => {
   }, [value]);
 
   const { decimalPrecision, currencyDecimalPrecision } = props;
-  let noOfDecimals = parseInt(decimalPrecision, 10);
-  if (Number.isNaN(noOfDecimals)) noOfDecimals = undefined;
-  let noOfFractionDigits = currencyDecimalPrecision === 'auto' ? undefined : parseInt(currencyDecimalPrecision, 10);
+  let noOfDecimals: number = parseInt(decimalPrecision, 10);
+  if (Number.isNaN(noOfDecimals)) noOfDecimals = 0;
+  let noOfFractionDigits =
+    currencyDecimalPrecision === 'auto' ? undefined : parseInt(currencyDecimalPrecision, 10);
 
-  if (displayMode === 'LABELS_LEFT' || displayMode === 'STACKED_LARGE_VAL' || displayMode === 'DISPLAY_ONLY') {
+  if (
+    displayMode === 'LABELS_LEFT' ||
+    displayMode === 'STACKED_LARGE_VAL' ||
+    displayMode === 'DISPLAY_ONLY'
+  ) {
     let displayComp;
     let { showGroupSeparators } = props;
     if (displayMode === 'LABELS_LEFT' && isTableFormatter) {
@@ -191,7 +226,7 @@ const PegaDxilMyCurrency = props => {
     }
   }
 
-  const onResolveSuggestionHandler = (accepted) => {
+  const onResolveSuggestionHandler = (accepted: boolean) => {
     suggestionsHandler(accepted, pConn, setStatus);
   };
 
@@ -218,15 +253,18 @@ const PegaDxilMyCurrency = props => {
         }
         setCurrencyValue(enteredValue);
         pConn.clearErrorMessages({
-          property: propName
+            category: '',
+            property: propName,
+            context: ''
         });
       }}
       onBlur={(enteredValue) => {
         const parsedValue = enteredValue !== '' ? Number(enteredValue) : enteredValue;
         if (!readOnly && (!value || value !== parsedValue)) {
+           // @ts-ignore
           handleEvent(actions, 'changeNblur', propName, parsedValue);
           if (hasSuggestions) {
-            pConn.ignoreSuggestion();
+            pConn.ignoreSuggestion('');
           }
         }
       }}
@@ -293,5 +331,3 @@ PegaDxilMyCurrency.propTypes = {
   alwaysShowISOCode: PropTypes.bool,
   hasSuggestions: PropTypes.bool
 };
-
-export default PegaDxilMyCurrency;

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyCurrency/{mock.js → mock.ts}

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

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyCurrency/{suggestions-handler.js → suggestions-handler.ts}

@@ -1,4 +1,4 @@
-export const suggestionsHandler = (accepted, pConn, setStatus) => {
+export const suggestionsHandler = (accepted: boolean, pConn: any, setStatus: any) => {
   if (accepted) {
     pConn.acceptSuggestion();
     setStatus('success');

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDate/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/tests/assets/components/createAll/{Launchpad/Pega_DXIL_MyDate/demo.stories.jsx → Constellation/Pega_DXIL_MyDate/demo.stories.tsx}

@@ -1,8 +1,9 @@
+
 /* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
 import { withKnobs } from '@storybook/addon-knobs';
-
 import { configProps, stateProps } from './mock';
-import PegaDxilMyDate from './index.jsx';
+import PegaDxilMyDate from './index';
 
 export default {
   title: 'PegaDxilMyDate',
@@ -16,6 +17,9 @@ if (!window.PCore) {
 
 window.PCore.getEnvironmentInfo = () => {
   return {
+    getTimeZone: () => {
+      return '';
+    },
     getLocale: () => {
       return 'en-GB';
     }
@@ -28,19 +32,13 @@ export const BasePegaDxilMyDate = () => {
       return {
         getActionsApi: () => {
           return {
-            updateFieldValue: () => {
-              /* nothing */
-            },
-            triggerFieldChange: () => {
-              /* nothing */
-            }
+            updateFieldValue: () => {/* nothing */},
+            triggerFieldChange: () => {/* nothing */}
           };
         },
         getValidationApi: () => {
           return {
-            validate: () => {
-              /* nothing */
-            }
+            validate: () => {/* nothing */}
           };
         },
         getStateProps: () => {
@@ -49,15 +47,9 @@ export const BasePegaDxilMyDate = () => {
         getConfigProps: () => {
           return configProps;
         },
-        ignoreSuggestion: () => {
-          /* nothing */
-        },
-        acceptSuggestion: () => {
-          /* nothing */
-        },
-        clearErrorMessages: () => {
-          /* nothing */
-        }
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        clearErrorMessages: () => {/* nothing */}
       };
     },
     value: configProps.value,

package/tests/assets/components/createAll/{Launchpad/Pega_DXIL_MyDate/index.jsx → Constellation/Pega_DXIL_MyDate/index.tsx}

@@ -3,6 +3,8 @@ import { DateInput, FieldValueList, DateTimeDisplay, Text,  } from '@pega/cosmos
 import PropTypes from 'prop-types';
 import FormattedText from "./FormattedText.jsx";
 
+import type { PConnFieldProps } from './PConnProps';
+
 import StyledPegaDxilMyDateWrapper from './styles';
 
 // includes in bundle
@@ -16,12 +18,42 @@ import {
   getDateFormat
 } from "./date.js";
 import { suggestionsHandler } from './suggestions-handler';
+import type { DateTimeFormat, DateTimeVariant } from '@pega/cosmos-react-core/lib/components/DateTime/DateTime.types.js';
+
+// interface for props
+interface PegaDxilMyDateProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  displayAsStatus?: boolean;
+  isTableFormatter?: boolean;
+  hasSuggestions?: boolean;
+  variant?: any;
+  formatter?: string;
+  withSeconds: boolean;
+  nextYearRange: string;
+  previousYearRange: string;
+  showWeekNumber: boolean;
+  showAsFormattedText: boolean;
+}
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
+
+interface ConfigProps {
+  formatter?: string;
+}
+
+interface ActionsProps {
+  onFocus: any;
+}
 
 // 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 PegaDxilMyDate = props => {
+export default function PegaDxilMyDate (props: PegaDxilMyDateProps)  {
   const {
     getPConnect,
     value,
@@ -43,7 +75,9 @@ const PegaDxilMyDate = props => {
   let {formatter} = props;
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
-  const propName = pConn?.getStateProps()?.value;
+  const actionsProps = pConn.getActionsApi() as unknown as ActionsProps;
+  const stateProps = pConn.getStateProps() as StateProps;
+  const propName: string = stateProps.value;
 
  let { readOnly, required, disabled } = props;
   [readOnly, required, disabled] = [readOnly, required, disabled].map(
@@ -52,19 +86,26 @@ const PegaDxilMyDate = props => {
 
   const [status, setStatus] = useState(hasSuggestions ? 'pending' : '');
 
+  // cast status
+  let myStatus: 'success' | 'warning' | 'error' | 'pending';
+  myStatus = status as 'success' | 'warning' | 'error' | 'pending';
+
   useEffect(() => {
     if (validatemessage !== '') {
       setStatus('error');
     }
     if (hasSuggestions) {
       setStatus('pending');
-    } else if (!hasSuggestions && status !== 'success') {
+    } else if (!hasSuggestions && myStatus !== 'success') {
+      // @ts-ignore
       setStatus(validatemessage !== '' ? 'error' : undefined);
     }
-  }, [validatemessage, hasSuggestions, status]);
+  }, [validatemessage, hasSuggestions, myStatus]);
 
   // calculate min and max range of calendar
+  // @ts-ignore
   const currentYear = getFullYear();
+
   const yearFromValue = getFullYear(value);
   const maxDate = getMaxDate(
     parseInt(nextYearRange, 10),
@@ -77,51 +118,57 @@ const PegaDxilMyDate = props => {
     yearFromValue
   );
 
-  const onResolveSuggestionHandler = (accepted) => {
+  const onResolveSuggestionHandler = (accepted: boolean) => {
     suggestionsHandler(accepted, pConn, setStatus);
   };
 
 
 
-  function handleBlur(onBlurValue) {
+  function handleBlur(onBlurValue: any) {
     const { valueAsISOString: date, state: errorState } = onBlurValue;
     const trimmedDate = date ? date.substring(0, date.indexOf('T')) : date;
     datetimeFireChangeBlurEvents(errorState, value, trimmedDate, actions, propName, pConn);
     const isValueChanged = !(value === undefined && trimmedDate === '') && value !== trimmedDate;
     if (hasSuggestions && isValueChanged) {
-      pConn.ignoreSuggestion();
+      pConn.ignoreSuggestion("");
     }
   }
 
-  function handleChange(onChangeValue) {
+  function handleChange(onChangeValue: any) {
     const { valueAsISOString: date } = onChangeValue;
     const trimmedDate = date ? date.substring(0, date.indexOf('T')) : date;
     if (hasSuggestions && value !== trimmedDate) {
-      setStatus(undefined);
+      setStatus("");
     }
     pConn.clearErrorMessages({
-      property: propName
+      category: "",
+      property: propName,
+      context: ""
     })
   }
 
   if (displayMode === 'LABELS_LEFT' || displayMode === 'STACKED_LARGE_VAL' || displayMode === 'DISPLAY_ONLY') {
-    let variantValue = "date";
+     let variantValue = "date";
      let formatValue = "long";
-     if(pConn && pConn.getConfigProps()){
-      const runtimeformatter = pConn.getConfigProps()?.formatter;
-      if(formatter !== runtimeformatter){
-        formatter = runtimeformatter;
-      }
-    }
-     if(formatter !== "" && formatExists(formatter)){
-      const {variantVal,formatVal} = datetimedisplayformatter(formatter);
-       variantValue = variantVal;
-       formatValue = formatVal;
+     if (pConn && pConn.getConfigProps()){
+        const configProps = pConn.getConfigProps() as ConfigProps;
+        const runtimeformatter = configProps?.formatter;
+
+        if (formatter !== runtimeformatter) {
+          formatter = runtimeformatter;
+        }
+     }
+
+
+    if (formatter !== "" && formatExists(formatter)){
+        const {variantVal,formatVal} = datetimedisplayformatter(formatter);
+        variantValue = variantVal;
+        formatValue = formatVal;
     }
     const displayComp = (
       <DateTimeDisplay
-      variant={variantValue}
-      format={formatValue}
+        variant={variantValue as DateTimeVariant}
+        format={formatValue as DateTimeFormat}
         value={value}
       />
     );
@@ -164,20 +211,21 @@ const PegaDxilMyDate = props => {
     const environmentInfo = PCore.getEnvironmentInfo();
     const locale = environmentInfo && environmentInfo.getLocale();
     const textAdditionalProps = {
-      format: getDateFormat(locale),
+      format: getDateFormat(locale as string, {}),
       fieldType: 'Date'
     };
     dateComponent = (
       <StyledPegaDxilMyDateWrapper>
-      <FormattedText
-        formatType='date'
-        value={value}
-        label={label}
-        hideLabel={hideLabel}
-        testId={testId}
-        additionalProps={textAdditionalProps}
-        customFormat={getDateFormat(locale)}
-      />
+        <FormattedText
+          formatType='date'
+          value={value}
+          label={label}
+          hideLabel={hideLabel}
+          testId={testId}
+          additionalProps={textAdditionalProps}
+          // @ts-ignore
+          customFormat={getDateFormat(locale)}
+        />
       </StyledPegaDxilMyDateWrapper>
     );
   } else {
@@ -198,7 +246,7 @@ const PegaDxilMyDate = props => {
         min={minDate}
         max={maxDate}
         data-testid={testId}
-        onFocus={actions.onFocus}
+        onFocus={actionsProps.onFocus}
         onChange={handleChange}
         onBlur={handleBlur}
         onResolveSuggestion={onResolveSuggestionHandler}
@@ -252,5 +300,3 @@ PegaDxilMyDate.propTypes = {
   formatter: PropTypes.string,
   hasSuggestions: PropTypes.bool
 };
-
-export default PegaDxilMyDate;

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDate/{mock.js → mock.ts}

@@ -1,5 +1,4 @@
-/* eslint-disable storybook/default-exports */
-/* eslint-disable storybook/prefer-pascal-case */
+
 export const configProps = {
   value: '2023-01-31T12:23:00.000Z',
   validatemessage: '',

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDate/{suggestions-handler.js → suggestions-handler.ts}

@@ -1,4 +1,4 @@
-export const suggestionsHandler = (accepted, pConn, setStatus) => {
+export const suggestionsHandler = (accepted: boolean, pConn: any, setStatus: any) => {
   if (accepted) {
     pConn.acceptSuggestion();
     setStatus('success');

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDateTime/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/tests/assets/components/createAll/{Launchpad/Pega_DXIL_MyDateTime/demo.stories.jsx → Constellation/Pega_DXIL_MyDateTime/demo.stories.tsx}

@@ -1,8 +1,9 @@
+
 /* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
 import { withKnobs } from '@storybook/addon-knobs';
-
 import { configProps, stateProps } from './mock';
-import PegaDxilMyDateTime from './index.jsx';
+import PegaDxilMyDateTime from './index';
 
 export default {
   title: 'PegaDxilMyDateTime',
@@ -18,6 +19,9 @@ window.PCore.getEnvironmentInfo = () => {
   return {
     getTimeZone: () => {
       return '';
+    },
+    getLocale: () => {
+      return 'en-GB';
     }
   };
 };
@@ -28,19 +32,13 @@ export const BasePegaDxilMyDateTime = () => {
       return {
         getActionsApi: () => {
           return {
-            updateFieldValue: () => {
-              /* nothing */
-            },
-            triggerFieldChange: () => {
-              /* nothing */
-            }
+            updateFieldValue: () => {/* nothing */},
+            triggerFieldChange: () => {/* nothing */}
           };
         },
         getValidationApi: () => {
           return {
-            validate: () => {
-              /* nothing */
-            }
+            validate: () => {/* nothing */}
           };
         },
         getStateProps: () => {
@@ -49,15 +47,9 @@ export const BasePegaDxilMyDateTime = () => {
         getConfigProps: () => {
           return configProps;
         },
-        ignoreSuggestion: () => {
-          /* nothing */
-        },
-        acceptSuggestion: () => {
-          /* nothing */
-        },
-        clearErrorMessages: () => {
-          /* nothing */
-        }
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        clearErrorMessages: () => {/* nothing */}
       };
     },
     value: configProps.value,