@pega/custom-dx-components 0.23.21 → 0.23.23

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyAutocomplete/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/Launchpad/Pega_DXIL_MyAutocomplete/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_MyAutocomplete/utils.js → Launchpad/Pega_DXIL_MyAutocomplete/utils.ts}

@@ -4,7 +4,7 @@ import get from 'lodash.get';
 
 import { getFieldNameFromEmbeddedFieldName } from './embed-utils.js';
 
-import { buildColumnForDisplayValue, setValuesToPropertyList } from './index.jsx';
+import { buildColumnForDisplayValue, setValuesToPropertyList } from './index';
 
 export function usePaginate() {
   const paginatationProperties = useRef({
@@ -17,11 +17,12 @@ export function usePaginate() {
   useEffect(() => {
     // clean up on unmount
     return () => {
+      // @ts-ignore
       paginatationProperties.current = null;
     };
   }, []);
 
-  const getInitialPaginatedRecords = (totalRecords, matchPosition) => {
+  const getInitialPaginatedRecords = (totalRecords: any, matchPosition: string) => {
     const initialPaginatedRecords = totalRecords.slice(0, 50);
     paginatationProperties.current.startIndex = 0;
     paginatationProperties.current.endIndex = 50;
@@ -30,7 +31,7 @@ export function usePaginate() {
     return initialPaginatedRecords;
   };
 
-  const positionMatches = (text, searchText) => {
+  const positionMatches = (text: string, searchText: string) => {
     switch (paginatationProperties.current.matchPosition) {
       case 'start':
         return text.toLowerCase().startsWith(searchText.toLowerCase());
@@ -41,7 +42,7 @@ export function usePaginate() {
     }
   };
 
-  const fetchData = (searchText, onScroll, columns = []) => {
+  const fetchData = (searchText: string, onScroll: boolean, columns = []) => {
     let progressivePaginatedRecords;
     paginatationProperties.current.startIndex += 50;
     paginatationProperties.current.endIndex += 50;
@@ -54,25 +55,32 @@ export function usePaginate() {
       );
     } else if (onScroll) {
       // paginate on filtered resultset
+      // @ts-ignore
       progressivePaginatedRecords = paginatationProperties.current.filteredRecords.slice(
         paginatationProperties.current.startIndex,
         paginatationProperties.current.endIndex
       );
     } else {
-      const searchInSecondaryItem = columns.some((e) => e.secondary && e.useForSearch);
+      // @ts-ignore
+      const searchInSecondaryItem = columns.some(e => e.secondary && e.useForSearch);
       // Filter the items and paginate on filtered resultset
       const filteredRecords = paginatationProperties.current.totalRecords.filter(
-        (filteritem) =>
+        filteritem =>
+          // @ts-ignore
           (filteritem.primary && positionMatches(filteritem.primary, searchText)) ||
           (searchInSecondaryItem &&
+            // @ts-ignore
             filteritem.secondary &&
+            // @ts-ignore
             filteritem.secondary.length > 0 &&
-            filteritem.secondary.find((item) => positionMatches(item, searchText)))
+            // @ts-ignore
+            filteritem.secondary.find(item => positionMatches(item, searchText)))
       );
       progressivePaginatedRecords = filteredRecords.slice(
         paginatationProperties.current.startIndex,
         paginatationProperties.current.endIndex
       );
+      // @ts-ignore
       paginatationProperties.current.filteredRecords = filteredRecords;
     }
     return progressivePaginatedRecords;
@@ -83,11 +91,19 @@ export function usePaginate() {
     paginatationProperties.current.endIndex = 0;
   };
 
-  const hasMoreResults = (searchText) => {
+  const hasMoreResults = (searchText: string) => {
     if (searchText === '' || searchText === undefined || searchText === null) {
-      return paginatationProperties.current.startIndex + 50 < paginatationProperties.current.totalRecords.length;
+      return (
+        paginatationProperties.current.startIndex + 50 <
+        paginatationProperties.current.totalRecords.length
+      );
     }
-    return paginatationProperties.current.startIndex + 50 < paginatationProperties.current.filteredRecords.length;
+    return (
+      // @ts-ignore
+      paginatationProperties.current.startIndex + 50 <
+      // @ts-ignore
+      paginatationProperties.current.filteredRecords.length
+    );
   };
 
   return {
@@ -98,11 +114,14 @@ export function usePaginate() {
   };
 }
 
-export function useDeepMemo(memoFn, key) {
+export function useDeepMemo(memoFn: any, key: any) {
   const ref = useRef();
+  // @ts-ignore
   if (!ref.current || !equal(key, ref.current.key)) {
+    // @ts-ignore
     ref.current = { key, value: memoFn() };
   }
+  // @ts-ignore
   return ref.current.value;
 }
 
@@ -114,11 +133,18 @@ export function useIsMount() {
   return isMountRef.current;
 }
 
-const transformSearchedItem = (displayResponseData, displayFieldMeta, columnsWithSetProperty, dataApiObj) => {
-  return displayResponseData.map((entry) => {
-    const secondaryArr = [];
-    const secondaryFieldValues = [];
-    displayFieldMeta.current.secondary.forEach((col) => {
+const transformSearchedItem = (
+  displayResponseData: any,
+  displayFieldMeta: any,
+  columnsWithSetProperty: any,
+  dataApiObj: any
+) => {
+  // @ts-ignore
+  return displayResponseData.map(entry => {
+    const secondaryArr: Array<any> = [];
+    const secondaryFieldValues: Array<any> = [];
+    // @ts-ignore
+    displayFieldMeta.current.secondary.forEach(col => {
       if (!displayFieldMeta.hidden?.includes(col)) secondaryArr.push(entry[col]);
       if (columnsWithSetProperty.includes(col)) {
         if (dataApiObj.isQueryable) {
@@ -137,32 +163,36 @@ const transformSearchedItem = (displayResponseData, displayFieldMeta, columnsWit
   });
 };
 
+// @ts-ignore
 export const updatePropertiesForNewRecord = (
-  dataConfig,
-  contextName,
-  dataApiObj,
-  setDataApiObj,
-  displayFieldMeta,
-  c11nEnv,
-  columns,
-  actions,
-  newCaseId
+  dataConfig: any,
+  contextName: any,
+  dataApiObj: any,
+  setDataApiObj: any,
+  displayFieldMeta: any,
+  c11nEnv: any,
+  columns: Array<any>,
+  actions: any,
+  newCaseId: string
 ) => {
   PCore.getDataApi()
     .init(dataConfig, contextName)
-    .then((dataObj) => {
+    .then(dataObj => {
       setDataApiObj(dataObj);
       buildColumnForDisplayValue(dataObj);
       // SET matchPosition to EQUALS to return exact matching record
       dataObj.matchPosition = 'equals';
       dataObj
         .fetchData(newCaseId)
-        .then((displayResponse) => {
+        // @ts-ignore
+        .then(displayResponse => {
           let columnsWithSetProperty = [];
           if (dataApiObj.columns) {
             columnsWithSetProperty = dataApiObj.columns
-              .filter((col) => col.setProperty && col.setProperty !== 'Associated property')
-              .map((col) => col.value);
+              // @ts-ignore
+              .filter(col => col.setProperty && col.setProperty !== 'Associated property')
+              // @ts-ignore
+              .map(col => col.value);
           }
           const displayResponseData = displayResponse.data || [];
 
@@ -172,7 +202,13 @@ export const updatePropertiesForNewRecord = (
             columnsWithSetProperty,
             dataApiObj
           );
-          setValuesToPropertyList(searchedItem[0], c11nEnv.getStateProps().value, searchedItem[0], columns, actions);
+          setValuesToPropertyList(
+            searchedItem[0],
+            c11nEnv.getStateProps().value,
+            searchedItem[0],
+            columns,
+            actions
+          );
         })
         .finally(() => {
           // RESET matchPosition

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyBoolean/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_MyBoolean/{boolean-format.js → boolean-format.ts}

@@ -8,7 +8,7 @@ export default {
 
 
 
-export function format(value, type) {
+export function format(value: any, type: string) {
   let formattedValue;
 
   switch (type?.toLowerCase()) {

package/tests/assets/components/createAll/{Constellation/Pega_DXIL_MyBoolean/demo.stories.jsx → Launchpad/Pega_DXIL_MyBoolean/demo.stories.tsx}

@@ -1,4 +1,6 @@
+
 /* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
 import { useState } from 'react';
 import { withKnobs } from '@storybook/addon-knobs';
 
@@ -13,6 +15,7 @@ export default {
 };
 
 export const BasePegaDxilMyBoolean = () => {
+
   const [value, setValue] = useState(configProps.value);
 
   const props = {
@@ -41,16 +44,12 @@ export const BasePegaDxilMyBoolean = () => {
             updateFieldValue: (propName, theValue) => {
               setValue(theValue);
             },
-            triggerFieldChange: () => {
-              /* nothing */
-            }
+            triggerFieldChange: () => { /* nothing */}
           };
         },
         getValidationApi: () => {
           return {
-            validate: () => {
-              /* nothing */
-            }
+            validate: () => { /* nothing */}
           };
         }
       };

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

@@ -6,15 +6,40 @@ 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 StyledPegaDxilMyBooleanWrapper from './styles';
 
+// interface for props
+interface PegaDxilMyBooleanProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  displayAsStatus?: boolean;
+  isTableFormatter?: boolean;
+  hasSuggestions?: boolean;
+  variant?: any;
+  formatter: string;
+  caption: string;
+  trueLabel: string;
+  falseLabel: string;
+}
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
+
+interface ActionsProps {
+  onClick: 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 PegaDxilMyBoolean = props => {
+export default function PegaDxilMyBoolean(props: PegaDxilMyBooleanProps) {
   const {
     getPConnect,
     value,
@@ -32,14 +57,16 @@ const PegaDxilMyBoolean = props => {
   } = 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;
+  let propName: string = stateProps.value;
 
   let { readOnly, required, disabled } = props;
   [readOnly, required, disabled] = [readOnly, required, disabled].map(
     (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
   );
 
-  let status = "";
+  let status: "error" | "success" | "warning" | "pending" | undefined;
   if (validatemessage !== "") {
     status = "error";
   }
@@ -53,11 +80,12 @@ const PegaDxilMyBoolean = props => {
       disabled={disabled}
       readOnly={readOnly}
       required={required}
-      onClick={actions.onClick}
+      onClick={actionsProps.onClick}
       onChange={(event) => {
-        handleEvent(actions, "changeNblur", propName, event.target.checked);
+        handleEvent(actions, "changeNblur", propName, (event.target.checked).toString());
       }}
-      onBlur={(event) => {
+      onBlur={(event: { target: { checked: any; }; }) => {
+        // @ts-ignore
         pConn.getValidationApi().validate(event.target.checked);
       }}
       data-testid={testId}
@@ -68,6 +96,7 @@ const PegaDxilMyBoolean = props => {
 
   let displayComponent;
   if (displayMode) {
+    // @ts-ignore
     displayComponent = <PegaDxilMyBoolean  value={value} trueLabel={trueLabel} falseLabel={falseLabel} />;
   }
 
@@ -165,5 +194,3 @@ PegaDxilMyBoolean.propTypes = {
   trueLabel: PropTypes.string,
   falseLabel: PropTypes.string
 };
-
-export default PegaDxilMyBoolean;

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyBoolean/{mock.js → mock.ts}

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

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

@@ -1,7 +1,10 @@
+
 /* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
 import { withKnobs } from '@storybook/addon-knobs';
 
 import PegaDxilMyCaseWidget from './index.jsx';
+
 import historyData from './mock';
 
 export default {
@@ -41,6 +44,7 @@ window.PCore.getDataApiUtils = () => {
 };
 
 export const BasePegaDxilMyCaseWidget = () => {
+
   const props = {
     label: 'Case history',
 
@@ -57,31 +61,19 @@ export const BasePegaDxilMyCaseWidget = () => {
         },
         getActionsApi: () => {
           return {
-            updateFieldValue: () => {
-              /* nothing */
-            },
-            triggerFieldChange: () => {
-              /* nothing */
-            }
+            updateFieldValue: () => {/* nothing */},
+            triggerFieldChange: () => {/* nothing */}
           };
         },
-        ignoreSuggestion: () => {
-          /* nothing */
-        },
-        acceptSuggestion: () => {
-          /* nothing */
-        },
-        setInheritedProps: () => {
-          /* nothing */
-        },
-        resolveConfigProps: () => {
-          /* nothing */
-        }
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        setInheritedProps: () => {/* nothing */},
+        resolveConfigProps: () => {/* nothing */}
       };
     }
-  };
+};
 
-  return (
+return (
     <>
       <PegaDxilMyCaseWidget {...props} />
     </>

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

@@ -1,37 +1,46 @@
 import { useState, useEffect } from 'react';
 import PropTypes from 'prop-types';
 import { Table, Text } from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
 
 import StyledPegaDxilMyCaseWidgetWrapper from './styles';
 
+// interface for props
+interface PegaDxilMyCaseWidgetProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+
+}
 
 // Code for Launchpad
 
 // 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
-export default function PegaDxilMyCaseWidget(props) {
+export default function PegaDxilMyCaseWidget(props: PegaDxilMyCaseWidgetProps) {
   const { getPConnect, label } = props;
   const pConn = getPConnect();
   const [history, setHistory] = useState([]);
   const [isLoading, setIsLoading] = useState(true);
-  const caseID = pConn.getValue(PCore.getConstants().CASE_INFO.CASE_INFO_ID);
+  const caseID = pConn.getValue(PCore.getConstants().CASE_INFO.CASE_INFO_ID, '');
   const context = pConn.getContextName();
 
   const columns = [
-    { renderer: 'date', label: pConn.getLocalizedValue('Date') },
-    { renderer: 'description', label: pConn.getLocalizedValue('Description') },
-    { renderer: 'user', label: pConn.getLocalizedValue('Performed by') }
+    { renderer: 'date', label: pConn.getLocalizedValue('Date', '', '') },
+    { renderer: 'description', label: pConn.getLocalizedValue('Description', '', '') },
+    { renderer: 'user', label: pConn.getLocalizedValue('Performed by', '','') }
   ];
 
   useEffect(() => {
+    // @ts-ignore
     const payload = { dataViewParameters: [{ ObjectID: caseID }] };
     PCore.getDataApiUtils()
+      // @ts-ignore
       .getData('ObjectHistory', payload, context)
+      // @ts-ignore
       .then((response) => {
         setIsLoading(false);
         if (response.data.data !== null) {
           setHistory(
-            response.data.data.map((entry, index) => {
+            response.data.data.map((entry: any, index: number) => {
               return {
                 date: new Date(entry.CreateDateTime).toLocaleString(),
                 description: <Text style={{ wordBreak: 'break-word' }}>{entry.MessageText}</Text>,
@@ -52,11 +61,11 @@ export default function PegaDxilMyCaseWidget(props) {
   return (
     <StyledPegaDxilMyCaseWidgetWrapper>
     <Table
-      title={pConn.getLocalizedValue(label)}
+      title={pConn.getLocalizedValue(label, '', '')}
       columns={columns}
       data={history}
       loading={isLoading}
-      loadingMessage={pConn.getLocalizedValue('Loading case history')}
+      loadingMessage={pConn.getLocalizedValue('Loading case history', '', '')}
     />
     </StyledPegaDxilMyCaseWidgetWrapper>
   );

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyCaseWidget/{mock.js → mock.ts}

@@ -1,4 +1,4 @@
-/* eslint-disable storybook/story-exports */
+// @ts-nocheck
 const historyData = {
   data: {
     fetchDateTime: '2023-01-18T12:04:56.517Z',