@pega/custom-dx-components 0.23.21 → 0.23.23

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

@@ -2,27 +2,47 @@
 import { useMemo } from 'react';
 import PropTypes from 'prop-types';
 import { RadioButton, RadioButtonGroup } from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
 
 // includes in bundle
 import { formatExists, textFormatter } from './textformat-utils.jsx';
-import handleEvent from './event-utils.js';
+import handleEvent from './event-utils';
 
 import StyledPegaDxilMyRadioButtonsWrapper from './styles';
 
 
-const getFullReference = (pConn, configProperty) => {
+// interface for props
+interface PegaDxilMyRadioButtonsProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  isTableFormatter?: boolean;
+  hasSuggestions?: boolean;
+  formatter: string;
+  listType: string;
+  datasource: Array<any>;
+  inline: boolean;
+  align: string;
+}
+
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
+
+const getFullReference = (pConn: any, configProperty: string) => {
   const pageReference = pConn.getPageReference();
   return pageReference ? `${pageReference}.${configProperty}` : configProperty;
 };
 
-const getDisplayValue = (dataSource, value, isDatapage) => {
+const getDisplayValue = (dataSource: any, value: any, isDatapage: boolean) => {
   if (value !== 0 && (!value || (typeof value === 'string' && !value.trim().length))) {
     return <span aria-hidden='true'>&ndash;&ndash;</span>;
   }
 
   const matchedEntry =
     dataSource &&
-    dataSource.filter((entry) => {
+    dataSource.filter((entry: any) => {
       return entry.key === value;
     })[0];
   return matchedEntry ? (isDatapage ? matchedEntry.text : matchedEntry.value) : value;
@@ -33,7 +53,7 @@ const getDisplayValue = (dataSource, value, isDatapage) => {
 
 // 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 PegaDxilMyRadioButtons = props => {
+export default function PegaDxilMyRadioButtons(props: PegaDxilMyRadioButtonsProps) {
   const {
     getPConnect,
     value,
@@ -55,11 +75,14 @@ const PegaDxilMyRadioButtons = props => {
   const pConn = getPConnect();
   const { formatter } = props;
   const actions = pConn.getActionsApi();
-  const propName = pConn.getStateProps().value;
+  const stateProps = pConn.getStateProps() as StateProps;
+  const propName: string = stateProps.value;
   const configProps = pConn.getConfigProps();
   const className = pConn.getCaseInfo().getClassName();
+  // @ts-ignore
   const { getLocaleRuleNameFromKeys, getLocalizedValue } = pConn;
 
+  // @ts-ignore
   let configProperty = pConn.getRawMetadata()?.config?.value || '';
   configProperty = configProperty.startsWith('@P') ? configProperty.substring(3) : configProperty;
   configProperty = configProperty.startsWith('.') ? configProperty.substring(1) : configProperty;
@@ -87,6 +110,7 @@ const PegaDxilMyRadioButtons = props => {
 
   const items = [];
   const isDatapage = listType === 'datapage';
+  // @ts-ignore
   const listSource = isDatapage ? configProps.listOutput : datasource;
   let autoFocusProp = additionalProps?.autoFocus
     ? {
@@ -106,7 +130,7 @@ const PegaDxilMyRadioButtons = props => {
       />
     );
   }
-  (listSource || []).forEach((item) => {
+  (listSource || []).forEach((item: any) => {
     if (additionalProps?.autoFocus && value === item.key) {
       autoFocusProp = {
         autoFocus: true
@@ -154,9 +178,12 @@ const PegaDxilMyRadioButtons = props => {
       required={required}
       readOnly={readOnly}
       onChange={(event) => {
+        // @ts-ignore
         handleEvent(actions, 'changeNblur', propName, event.target.value);
       }}
+      // @ts-ignore
       onBlur={(event) => {
+        // @ts-ignore
         pConn.getValidationApi().validate(event.target.value);
       }}
       align={align}
@@ -214,5 +241,3 @@ PegaDxilMyRadioButtons.propTypes = {
   formatter: PropTypes.string,
   isTableFormatter: PropTypes.bool
 };
-
-export default PegaDxilMyRadioButtons;

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyRadioButtons/mock.ts

@@ -0,0 +1,69 @@
+
+// @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/Launchpad/Pega_DXIL_MyRadioButtons/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/Launchpad/Pega_DXIL_MyText/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_MyText/demo.stories.jsx → Launchpad/Pega_DXIL_MyText/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 { stateProps, configProps } from './mock';
-import PegaDxilMyText from './index.jsx';
+
+import PegaDxilMyText from './index';
 
 export default {
   title: 'PegaDxilMyText',
@@ -12,6 +15,7 @@ export default {
 };
 
 export const BasePegaDxilMyText = () => {
+
   const [value, setValue] = useState(configProps.value);
 
   const props = {
@@ -31,23 +35,13 @@ export const BasePegaDxilMyText = () => {
             updateFieldValue: (propName, theValue) => {
               setValue(theValue);
             },
-            triggerFieldChange: () => {
-              /* nothing */
-            }
+            triggerFieldChange: () => {/* 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_MyText/index.jsx → Launchpad/Pega_DXIL_MyText/index.tsx}

@@ -1,21 +1,35 @@
 import PropTypes from 'prop-types';
 import { Input } from '@pega/cosmos-react-core';
 
+import type { PConnFieldProps } from './PConnProps';
+
 import StyledPegaDxilMyTextWrapper from './styles';
 
+// interface for props
+interface PegaDxilMyTextProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+
+}
+
+// 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 PegaDxilMyText = props => {
+export default function PegaDxilMyText(props: PegaDxilMyTextProps) {
   const { getPConnect, value, placeholder, disabled, readOnly, required, label, hideLabel, testId } = 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 handleOnChange = event => {
+  const handleOnChange = (event: any) => {
     const { value: updatedValue } = event.target;
     actions.updateFieldValue(propName, updatedValue);
   };
@@ -57,5 +71,3 @@ PegaDxilMyText.propTypes = {
   required: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
   testId: PropTypes.string
 };
-
-export default PegaDxilMyText;

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyText/{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: 'Text Sample',

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyTextInput/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_MyTextInput/StatusWork.jsx → Launchpad/Pega_DXIL_MyTextInput/StatusWork.tsx}

@@ -1,7 +1,9 @@
 import { Status } from '@pega/cosmos-react-core';
 
-export default function StatusWorkRenderer({ value }) {
-  let variant = 'info';
+export default function StatusWorkRenderer({ value } : any) {
+  // need to cast variant
+  let variant : 'success' | 'urgent' | 'warn' | 'pending' | 'info';
+  variant = 'info';
 
   const warnStrings = ['fail', 'cancel', 'reject', 'revoke', 'stopped', 'warn'];
   const infoStrings = ['open', 'hold', 'info', 'new'];
@@ -18,8 +20,10 @@ export default function StatusWorkRenderer({ value }) {
     variant = 'pending';
   }
 
+
+
   return (
-    <Status type='rectangle' variant={variant}>
+    <Status type='rectangle' variant={variant} >
       {value}
     </Status>
   );

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyTextInput/demo.stories.tsx

@@ -0,0 +1,51 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import { withKnobs } from '@storybook/addon-knobs';
+
+import PegaDxilMyTextInput from './index';
+
+import { stateProps, fieldMetadata, configProps } from './mock';
+
+export default {
+  title: 'PegaDxilMyTextInput',
+  decorators: [withKnobs],
+  component: PegaDxilMyTextInput
+};
+
+export const BasePegaDxilMyTextInput = () => {
+
+  const props = {
+    value: configProps.value,
+    placeholder: configProps.placeholder,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    testId: configProps.testId,
+    hasSuggestions: configProps.hasSuggestions,
+    fieldMetadata,
+
+    getPConnect: () => {
+      return {
+        getStateProps: () => {
+          return stateProps;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {/* nothing */},
+            triggerFieldChange: () => {/* nothing */}
+          };
+        },
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        setInheritedProps: () => {/* nothing */},
+        resolveConfigProps: () => {/* nothing */}
+      };
+    }
+  };
+
+  return (
+    <>
+      <PegaDxilMyTextInput {...props} />
+    </>
+  );
+};

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyTextInput/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_MyTextInput/{index.jsx → index.tsx}

@@ -1,16 +1,32 @@
 import { useEffect, useState, useRef } from 'react';
 import { Input, FieldValueList, Text, EmailDisplay, PhoneDisplay, URLDisplay } from '@pega/cosmos-react-core';
 import PropTypes from 'prop-types';
+import type { PConnFieldProps } from './PConnProps';
 
 // include in bundle
 import handleEvent from "./event-utils";
-import StatusWorkRenderer from "./StatusWork.jsx";
+import StatusWorkRenderer from "./StatusWork";
 import { suggestionsHandler } from './suggestions-handler';
 
 import StyledPegaDxilMyTextInputWrapper from './styles';
 
+// interface for props
+interface PegaDxilMyTextInputProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  displayAsStatus?: boolean;
+  isTableFormatter?: boolean;
+  hasSuggestions?: boolean;
+  variant?: any;
+  formatter: string;
+}
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
 
-export const formatExists = (formatterVal) => {
+export const formatExists = (formatterVal: string) => {
     const formatterValues = [
       "TextInput",
       "WorkStatus",
@@ -28,7 +44,7 @@ export const formatExists = (formatterVal) => {
   };
 
 
-export const textFormatter = (formatter,value) => {
+export const textFormatter = (formatter: string, value: string) => {
   let displayComponent = null;
   switch(formatter){
     case "TextInput" : {
@@ -58,7 +74,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 PegaDxilMyTextInput = props => {
+export default function PegaDxilMyTextInput(props: PegaDxilMyTextInputProps) {
  const {
     getPConnect,
     placeholder,
@@ -78,7 +94,8 @@ const PegaDxilMyTextInput = 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 maxLength = fieldMetadata?.maxLength;
   const hasValueChange = useRef(false);
 
@@ -89,6 +106,11 @@ const PegaDxilMyTextInput = props => {
 
   const [inputValue, setInputValue] = useState(value);
   const [status, setStatus] = useState(hasSuggestions ? 'pending' : undefined);
+
+   // cast status
+  let myStatus: 'success' | 'warning' | 'error' | 'pending';
+  myStatus = status as 'success' | 'warning' | 'error' | 'pending';
+
   useEffect(() => setInputValue(value), [value]);
 
   useEffect(() => {
@@ -97,12 +119,12 @@ const PegaDxilMyTextInput = props => {
     }
     if (hasSuggestions) {
       setStatus('pending');
-    } else if (!hasSuggestions && status !== 'success') {
+    } else if (!hasSuggestions && myStatus !== 'success') {
       setStatus(validatemessage !== '' ? 'error' : undefined);
     }
-  }, [validatemessage, hasSuggestions, status]);
+  }, [validatemessage, hasSuggestions, myStatus]);
 
-  const onResolveSuggestionHandler = (accepted) => {
+  const onResolveSuggestionHandler = (accepted: boolean) => {
     suggestionsHandler(accepted, pConn, setStatus);
   };
   // Override the value to render as status work when prop passed to display as status
@@ -153,6 +175,27 @@ const PegaDxilMyTextInput = props => {
     );
   }
 
+  const handleChange = (event: any) => {
+    if (hasSuggestions) {
+      setStatus(undefined);
+    }
+    setInputValue(event.target.value);
+    if (value !== event.target.value) {
+      handleEvent(actions, 'change', propName, event.target.value);
+      hasValueChange.current = true;
+    }
+  };
+
+  const handleBlur = (event: any) => {
+    if ((!value || hasValueChange.current) && !readOnly) {
+      handleEvent(actions, 'blur', propName, event.target.value);
+      if (hasSuggestions) {
+        pConn.ignoreSuggestion('');
+      }
+      hasValueChange.current = false;
+    }
+  };
+
   return (
     <StyledPegaDxilMyTextInputWrapper>
     <Input
@@ -163,31 +206,14 @@ const PegaDxilMyTextInput = props => {
       info={validatemessage || helperText}
       data-testid={testId}
       value={inputValue}
-      status={status}
+      status={myStatus}
       placeholder={placeholder}
       disabled={disabled}
       readOnly={readOnly}
       required={required}
       maxLength={maxLength}
-      onChange={(event) => {
-        if (hasSuggestions) {
-          setStatus(undefined);
-        }
-        setInputValue(event.target.value);
-        if (value !== event.target.value) {
-          handleEvent(actions, 'change', propName, event.target.value);
-          hasValueChange.current = true;
-        }
-      }}
-      onBlur={(event) => {
-        if ((!value || hasValueChange.current) && !readOnly) {
-          handleEvent(actions, 'blur', propName, event.target.value);
-          if (hasSuggestions) {
-            pConn.ignoreSuggestion();
-          }
-          hasValueChange.current = false;
-        }
-      }}
+      onChange={!readOnly ? handleChange : undefined}
+      onBlur={!readOnly ? handleBlur : undefined}
       onResolveSuggestion={onResolveSuggestionHandler}
     />
     </StyledPegaDxilMyTextInputWrapper>
@@ -235,5 +261,3 @@ PegaDxilMyTextInput.propTypes = {
   isTableFormatter: PropTypes.bool,
   hasSuggestions: PropTypes.bool
 };
-
-export default PegaDxilMyTextInput;

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyTextInput/{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: 'TextInput Sample',

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyTextInput/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);
+  }
+};