@pega/custom-dx-components 0.23.21 → 0.23.23

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

@@ -8,6 +8,7 @@ import {
   EmailDisplay, URLDisplay
 } from '@pega/cosmos-react-core';
 import PropTypes from 'prop-types';
+import type { PConnFieldProps } from './PConnProps';
 
 // includes in bundle
 import handleEvent from "./event-utils";
@@ -15,7 +16,25 @@ import { suggestionsHandler } from './suggestions-handler';
 
 import StyledPegaDxilMyPhoneWrapper from './styles';
 
-export const formatExists = (formatterVal) => {
+// interface for props
+interface PegaDxilMyPhoneProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  displayAsStatus?: boolean;
+  isTableFormatter?: boolean;
+  hasSuggestions?: boolean;
+  variant?: any;
+  formatter: string;
+  datasource: Array<any>;
+  showCountryCode: boolean;
+}
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
+
+export const formatExists = (formatterVal: string) => {
     const formatterValues = [
       "TextInput",
       "WorkStatus",
@@ -33,7 +52,7 @@ export const formatExists = (formatterVal) => {
   };
 
 
-export const textFormatter = (formatter,value) => {
+export const textFormatter = (formatter: string, value: any) => {
   let displayComponent = null;
   switch(formatter){
     case "TextInput" : {
@@ -63,7 +82,7 @@ export const textFormatter = (formatter,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 PegaDxilMyPhone = props => {
+export default function PegaDxilMyPhone(props: PegaDxilMyPhoneProps) {
   const {
     getPConnect,
     value,
@@ -84,11 +103,14 @@ const PegaDxilMyPhone = props => {
   const { formatter } = props;
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
-  const propName = pConn.getStateProps().value;
+  const stateProps = pConn.getStateProps() as StateProps;
+  let propName: string = stateProps.value;
   const hasValueChange = useRef(false);
 
- let callingCodesList = [];
+  let callingCodesList: Array<any>  = [];
+  // @ts-ignore
   if (datasource?.source?.length > 0) {
+    // @ts-ignore
     datasource.source.forEach((element) => {
       callingCodesList.push(element.value);
     });
@@ -118,12 +140,12 @@ const PegaDxilMyPhone = props => {
   }, [validatemessage, hasSuggestions, status]);
 
   // funtion to exclude country code from phone number
-  function getPhoneNumberAlone(phoneNumber) {
+  function getPhoneNumberAlone(phoneNumber: string) {
     const phoneNumberParts = getPhoneNumberParts(phoneNumber, callingCodesList);
     return phoneNumberParts && phoneNumberParts[1];
   }
 
-  function handleChangeBlur(enteredValue, eventType) {
+  function handleChangeBlur(enteredValue: string, eventType: any) {
     if (!getPhoneNumberAlone(enteredValue)) {
       enteredValue = '';
     }
@@ -176,7 +198,7 @@ const PegaDxilMyPhone = props => {
     );
   }
 
-  const onResolveSuggestionHandler = (accepted) => {
+  const onResolveSuggestionHandler = (accepted: boolean) => {
     suggestionsHandler(accepted, pConn, setStatus);
   };
 
@@ -196,21 +218,23 @@ const PegaDxilMyPhone = props => {
       readOnly={readOnly}
       required={required}
       data-testid={testId}
-      onChange={(enteredValue) => {
+      onChange={(enteredValue: any) => {
         if (hasSuggestions) {
-          setStatus(undefined);
+          setStatus('');
         }
         setInputValue(enteredValue);
         if (value !== enteredValue) {
+          // @ts-ignore
           handleEvent(actions, 'change', propName, enteredValue);
         }
         hasValueChange.current = true;
       }}
-      onBlur={(enteredValue) => {
+      onBlur={(enteredValue: any) => {
         if (!value || hasValueChange.current) {
+          // @ts-ignore
           handleChangeBlur(enteredValue, 'blur');
           if (hasSuggestions) {
-            pConn.ignoreSuggestion();
+            pConn.ignoreSuggestion('');
           }
           hasValueChange.current = false;
         }
@@ -262,5 +286,3 @@ PegaDxilMyPhone.propTypes = {
   isTableFormatter: PropTypes.bool,
   hasSuggestions: PropTypes.bool
 };
-
-export default PegaDxilMyPhone;

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyPhone/{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: 'Phone Sample',

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

@@ -1,9 +1,12 @@
+
 /* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
 import { useState } from 'react';
 import { withKnobs } from '@storybook/addon-knobs';
 
-import { configProps, rawMetadata, fieldMetadata, stateProps } from './mock.js';
-import PegaDxilMyPicklist from './index.jsx';
+import { configProps, rawMetadata, fieldMetadata, stateProps } from './mock';
+
+import PegaDxilMyPicklist from './index';
 
 export default {
   title: 'PegaDxilMyPicklist',
@@ -12,6 +15,7 @@ export default {
 };
 
 export const BasePegaDxilMyPicklist = () => {
+
   const [value, setValue] = useState(configProps.value);
 
   const props = {
@@ -53,30 +57,18 @@ export const BasePegaDxilMyPicklist = () => {
             updateFieldValue: (propName, theValue) => {
               setValue(theValue);
             },
-            triggerFieldChange: () => {
-              /* nothing */
-            }
+            triggerFieldChange: () => {/* nothing */}
           };
         },
         getValidationApi: () => {
           return {
-            validate: () => {
-              /* nothing */
-            }
+            validate: () => {/* nothing */}
           };
         },
-        ignoreSuggestion: () => {
-          /* nothing */
-        },
-        acceptSuggestion: () => {
-          /* nothing */
-        },
-        setInheritedProps: () => {
-          /* nothing */
-        },
-        resolveConfigProps: () => {
-          /* nothing */
-        }
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        setInheritedProps: () => {/* nothing */},
+        resolveConfigProps: () => {/* nothing */}
       };
     }
   };

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyPicklist/event-utils.ts

@@ -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/tests/assets/components/createAll/{Launchpad/Pega_DXIL_MyPicklist/index.jsx → Constellation/Pega_DXIL_MyPicklist/index.tsx}

@@ -1,8 +1,11 @@
 /* eslint-disable react-hooks/exhaustive-deps */
+// @ts-nocheck
 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';
@@ -10,7 +13,35 @@ import { suggestionsHandler } from './suggestions-handler';
 import StyledPegaDxilMyPicklistWrapper from './styles';
 import {EmailDisplay, PhoneDisplay, URLDisplay } from "@pega/cosmos-react-core";
 
-export const formatExists = (formatterVal) => {
+
+// interface for props
+interface PegaDxilMyPicklistProps 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",
@@ -28,7 +59,7 @@ export const formatExists = (formatterVal) => {
   };
 
 
-export const textFormatter = (formatter,value) => {
+export const textFormatter = (formatter: string,value: any) => {
   let displayComponent = null;
   switch(formatter){
     case "TextInput" : {
@@ -53,14 +84,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(
@@ -70,6 +101,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='' />);
   }
 };
@@ -79,7 +111,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 PegaDxilMyPicklist = props => {
+export default function PegaDxilMyPicklist(props: PegaDxilMyPicklistProps) {
   const {
     getPConnect,
     value,
@@ -102,7 +134,8 @@ const PegaDxilMyPicklist = 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);
 
@@ -134,11 +167,13 @@ const PegaDxilMyPicklist = 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 : [];
   }
 
@@ -153,11 +188,12 @@ const PegaDxilMyPicklist = props => {
     }
   }, [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 &&
@@ -173,11 +209,13 @@ const PegaDxilMyPicklist = 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>
@@ -259,7 +297,7 @@ const PegaDxilMyPicklist = props => {
     );
   }
 
-  const onResolveSuggestionHandler = (accepted) => {
+  const onResolveSuggestionHandler = (accepted: boolean) => {
     suggestionsHandler(accepted, pConnect, setStatus);
   };
 
@@ -273,22 +311,26 @@ const PegaDxilMyPicklist = 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}
@@ -349,5 +391,3 @@ PegaDxilMyPicklist.propTypes = {
   isTableFormatter: PropTypes.bool,
   hasSuggestions: PropTypes.bool
 };
-
-export default PegaDxilMyPicklist;

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyPicklist/mock.ts

@@ -0,0 +1,68 @@
+// @ts-nocheck
+export const configProps = {
+  value: '',
+  label: 'Picklist Sample',
+  placeholder: 'Select...',
+  listType: 'associated',
+  datasource: [
+    {
+      key: 'Option 1',
+      value: 'Option 1'
+    },
+    {
+      key: 'Option 2',
+      value: 'Option 2'
+    },
+    {
+      key: 'Option 3',
+      value: 'Option 3'
+    }
+  ],
+  helperText: 'Picklist Helper Text',
+  testId: 'picklist-12345678',
+  hasSuggestions: false
+};
+
+export const stateProps = {
+  value: '.PicklistSample',
+  placeholder: 'Select...',
+  datasource: '.PicklistSample',
+  hasSuggestions: false
+};
+
+export const rawMetadata = {
+  type: 'Dropdown',
+  config: {
+    value: '@P .PicklistSample',
+    label: '@L Picklist Sample',
+    placeholder: '@L Select...',
+    listType: 'associated',
+    datasource: '@ASSOCIATED .PicklistSample',
+    helperText: '@L Picklist Helper Text',
+    testId: 'picklist-12345678'
+  }
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Text',
+  displayAs: 'pxDropdown',
+  label: 'Picklist sample',
+  datasource: {
+    tableType: 'PromptList',
+    records: [
+      {
+        key: 'Option 1',
+        value: 'Option 1'
+      },
+      {
+        key: 'Option 2',
+        value: 'Option 2'
+      },
+      {
+        key: 'Option 3',
+        value: 'Option 3'
+      }
+    ]
+  }
+};

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyPicklist/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/tests/assets/components/createAll/Constellation/Pega_DXIL_MyRadioButtons/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_MyRadioButtons/demo.stories.jsx → Constellation/Pega_DXIL_MyRadioButtons/demo.stories.tsx}

@@ -1,9 +1,12 @@
+
 /* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
 import { useState } from 'react';
 import { withKnobs } from '@storybook/addon-knobs';
 
-import { configProps, rawMetadata, fieldMetadata, stateProps } from './mock.js';
-import PegaDxilMyRadioButtons from './index.jsx';
+import { configProps, rawMetadata, fieldMetadata, stateProps } from './mock';
+
+import PegaDxilMyRadioButtons from './index';
 
 export default {
   title: 'PegaDxilMyRadioButtons',
@@ -12,10 +15,12 @@ export default {
 };
 
 export const BasePegaDxilMyRadioButtons = () => {
+
   const [value, setValue] = useState(configProps.value);
 
   const props = {
     value,
+    align: 'vertical',
     placeholder: configProps.placeholder,
     label: configProps.label,
     helperText: configProps.helperText,
@@ -32,6 +37,9 @@ export const BasePegaDxilMyRadioButtons = () => {
         getStateProps: () => {
           return stateProps;
         },
+        getPageReference: () => {
+          return 'caseInfo.content';
+        },
         getLocalizedValue: val => {
           return val;
         },
@@ -53,30 +61,18 @@ export const BasePegaDxilMyRadioButtons = () => {
             updateFieldValue: (propName, theValue) => {
               setValue(theValue);
             },
-            triggerFieldChange: () => {
-              /* nothing */
-            }
+            triggerFieldChange: () => {/* nothing */}
           };
         },
         getValidationApi: () => {
           return {
-            validate: () => {
-              /* nothing */
-            }
+            validate: () => {/* nothing */}
           };
         },
-        ignoreSuggestion: () => {
-          /* nothing */
-        },
-        acceptSuggestion: () => {
-          /* nothing */
-        },
-        setInheritedProps: () => {
-          /* nothing */
-        },
-        resolveConfigProps: () => {
-          /* nothing */
-        }
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        setInheritedProps: () => {/* nothing */},
+        resolveConfigProps: () => {/* nothing */}
       };
     }
   };

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyRadioButtons/event-utils.ts

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