@pega/custom-dx-components 0.23.21 → 0.23.23

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

@@ -1,9 +1,13 @@
+
 /* eslint-disable react/jsx-no-useless-fragment */
+/* eslint-disable react/no-unstable-nested-components */
+// @ts-nocheck
 import { withKnobs } from '@storybook/addon-knobs';
+
 import { AppAnnouncement as PegaAppAnnouncement } from '@pega/cosmos-react-work';
 
-import PegaDxilMyPage from './index.jsx';
-import { pyHome1Resolved, pyHome1Raw } from './mock.js';
+import PegaDxilMyPage from './index';
+import { pyHome1Resolved, pyHome1Raw } from './mock';
 
 export default {
   title: 'PegaDxilMyPage',
@@ -44,12 +48,8 @@ export const BasePegaDxilMyPage = () => {
                 resolve({});
               });
             },
-            updateFieldValue: () => {
-              /* nothing */
-            },
-            triggerFieldChange: () => {
-              /* nothing */
-            }
+            updateFieldValue: () => {/* nothing */},
+            triggerFieldChange: () => {/* nothing */}
           };
         },
         getChildren: () => {
@@ -86,18 +86,10 @@ export const BasePegaDxilMyPage = () => {
             );
           }
         },
-        ignoreSuggestion: () => {
-          /* nothing */
-        },
-        acceptSuggestion: () => {
-          /* nothing */
-        },
-        setInheritedProps: () => {
-          /* nothing */
-        },
-        resolveConfigProps: () => {
-          /* nothing */
-        }
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        setInheritedProps: () => {/* nothing */},
+        resolveConfigProps: () => {/* nothing */}
       };
     }
   };

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

@@ -3,13 +3,16 @@ import PropTypes from 'prop-types';
 import { OneColumnPage as OneColumn } from '@pega/cosmos-react-core';
 import { ConfigurableLayout } from '@pega/cosmos-react-work'
 // import { registerIcon } from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
+
+
 
 // temp
 // import * as headlineIcon from '@pega/cosmos-react-core/lib/components/Icon/icons/headline.icon';
 
 import StyledPegaDxilMyPageWrapper from './styles';
 
-import GetNextWork from './GetNextWork.jsx';
+import GetNextWork from './GetNextWork';
 import { getLayoutDataFromRegion } from './utils';
 
 // temp
@@ -19,13 +22,20 @@ import { getLayoutDataFromRegion } from './utils';
 // have to manually get icon, so can't determine a runtime for now
 // so "headline" icon is hardcoded.
 
-
+// interface for props
+interface PegaDxilMyPageProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  children: any;
+  title: string;
+  useConfigurableLayout: boolean;
+  enableGetNextWork: 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
-export default function PegaDxilMyPage(props) {
+export default function PegaDxilMyPage(props: PegaDxilMyPageProps) {
 
   // add back in icon when working
   // const { children, title, icon, useConfigurableLayout, getPConnect, enableGetNextWork } = props;
@@ -33,7 +43,7 @@ export default function PegaDxilMyPage(props) {
   const childArray = useMemo(() => {
     return Children.toArray(children);
   }, [children]);
-  const child0 = childArray[0];
+  const child0: any = childArray[0];
   const layoutItemsA = useMemo(() => {
     return getLayoutDataFromRegion(child0);
   }, [child0]);
@@ -45,9 +55,11 @@ export default function PegaDxilMyPage(props) {
 
     <StyledPegaDxilMyPageWrapper>
     <OneColumn
+      // @ts-ignore
       a={useConfigurableLayout ? <ConfigurableLayout items={layoutItemsA} /> : childArray[0]}
       title={title}
       icon={tempIcon?.replace('pi pi-', '')}
+       // @ts-ignore
       actions={enableGetNextWork ? <GetNextWork getPConnect={getPConnect} /> : null}
     />
     </StyledPegaDxilMyPageWrapper>

package/{src/tasks/create/templates/Constellation/Template/PAGE/mock.js.mustache → tests/assets/components/createAll/Constellation/Pega_DXIL_MyPage/mock.ts}

@@ -1,5 +1,5 @@
-/* eslint-disable storybook/default-exports */
-/* eslint-disable storybook/prefer-pascal-case */
+
+// @ts-nocheck
 export const pyHome1Raw = {
   name: 'pyHome1',
   type: 'View',

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyPageCaseWidget/{Avatar.jsx → Avatar.tsx}

@@ -2,12 +2,22 @@
 import { useEffect, useState } from 'react';
 import PropTypes from 'prop-types';
 import { Avatar as CosmosAvatar } from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
 
-function Avatar(props) {
+
+// interface for props
+interface PegaDxilMyPageCaseWidgetAvatarProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  metaObj: any;
+  showStatus: boolean;
+
+}
+
+function Avatar(props: PegaDxilMyPageCaseWidgetAvatarProps) {
   const { metaObj, showStatus } = props;
   const [imageBlobUrl, setImageBlobUrl] = useState(null);
-  let userName;
-  let userIdentifier;
+  let userName: string;
+  let userIdentifier: string;
 
   // TODO Below if conditions can be removed once we have apis to get worklist/mywork info
   // This is non CaseView case (Dashboard, MyWork etc)
@@ -28,7 +38,7 @@ function Avatar(props) {
       PCore.getAssetLoader()
         .getSvcImage(imageKey)
         .then((blob) => window.URL.createObjectURL(blob))
-        .then((imagePath) => setImageBlobUrl(imagePath));
+        .then((imagePath) => setImageBlobUrl(imagePath as React.SetStateAction<any>));
     }
   }, [metaObj]);
 
@@ -36,6 +46,7 @@ function Avatar(props) {
     const currentState = PCore.getMessagingServiceManager().getUserPresence().getUserState(userIdentifier);
     const [userState, setUserState] = useState(currentState === 'online' ? 'active' : 'inactive');
 
+    // @ts-ignore
     const handleUserStateChange = ({ state }) => {
       setUserState(state === 'online' ? 'active' : 'inactive');
     };
@@ -43,13 +54,15 @@ function Avatar(props) {
     useEffect(() => {
       const subId = PCore.getMessagingServiceManager()
         .getUserPresence()
+        // @ts-ignore
         .subscribe(userIdentifier, handleUserStateChange);
 
       return function cleanup() {
         PCore.getMessagingServiceManager().getUserPresence().unsubscribe(userIdentifier, subId);
       };
     }, [userIdentifier, handleUserStateChange]);
-    return <CosmosAvatar name={userName} imageSrc={imageBlobUrl} status={userState} />;
+    // @ts-ignore
+    return <CosmosAvatar name={userName} imageSrc={imageBlobUrl as React.SetStateAction<any>} status={userState} />;
   }
 
   // Do not render when userName does not exists
@@ -58,7 +71,7 @@ function Avatar(props) {
     return null;
   }
 
-  return <CosmosAvatar name={userName} imageSrc={imageBlobUrl} />;
+  return <CosmosAvatar name={userName} imageSrc={imageBlobUrl as React.SetStateAction<any>} />;
 }
 
 Avatar.propTypes = {

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyPageCaseWidget/{Operator.jsx → Operator.tsx}

@@ -14,9 +14,23 @@ import {
 import { Glimpse } from '@pega/cosmos-react-work';
 import PropTypes from 'prop-types';
 
-import Avatar from './Avatar.jsx';
+import type { PConnFieldProps } from './PConnProps';
 
-const Operator = (props) => {
+import Avatar from './Avatar';
+
+
+// interface for props
+interface PegaDxilMyPageCaseWidgetOperatorProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  name: string;
+  id: string;
+  label: string;
+  metaObj: any;
+  externalUser: any;
+}
+
+
+export default function Operator(props: PegaDxilMyPageCaseWidgetOperatorProps) {
   const { id, name, label, testId, helperText, externalUser, metaObj } = props;
   const [isOpen, setIsOpen] = useState(false);
   const [isLoading, setIsLoading] = useState(true);
@@ -36,6 +50,7 @@ const Operator = (props) => {
     const localizedVal = PCore.getLocaleUtils().getLocaleValue;
     const localeCategory = 'Operator';
     setpopoverContent(
+       // @ts-ignore
       <Progress variant='ring' message={localizedVal('Loading operator...', localeCategory)} placement='local' />
     );
     if (externalUser && externalUser.classID !== 'Data-Party-Operator') {
@@ -59,8 +74,10 @@ const Operator = (props) => {
       ];
       setIsLoading(false);
       setpopoverContent(
+        // @ts-ignore
         <Glimpse
           visual={
+             // @ts-ignore
             <Avatar
               metaObj={{
                 name: externalUser.name
@@ -115,8 +132,10 @@ const Operator = (props) => {
             ];
             setIsLoading(false);
             setpopoverContent(
+               // @ts-ignore
               <Glimpse
                 visual={
+                   // @ts-ignore
                   <Avatar
                     metaObj={{
                       image: res.data.pyOperatorInfo.pyImageInsKey || '',
@@ -131,12 +150,14 @@ const Operator = (props) => {
             );
           } else {
             setIsLoading(false);
+            // @ts-ignore
             setpopoverContent(<Flex container={{ pad: 1 }}>{localizedVal('Operator not found', localeCategory)}</Flex>);
           }
         })
         .catch(() => {
           setIsLoading(false);
           setpopoverContent(
+            // @ts-ignore
             <Flex container={{ pad: 1 }}>{localizedVal('Error loading the operator profile', localeCategory)}</Flex>
           );
         });
@@ -144,7 +165,7 @@ const Operator = (props) => {
   };
 
 
-  const clickAction = (e) => {
+  const clickAction = (e: any) => {
     setPopoverTarget(e.currentTarget);
     setIsOpen(!isOpen);
     if (popoverTarget === null) {
@@ -157,8 +178,11 @@ const Operator = (props) => {
       setIsOpen(false);
     }
   };
+
+  // @ts-ignore
   useOuterEvent('mousedown', [popoverEl, popoverTarget], hidePopover); // Call the method on clicking outside these elements
-  const hideOnEscape = (e) => {
+
+  const hideOnEscape = (e: any) => {
     if (e.key === 'Escape') hidePopover(); // Call the method when Escape key is pressed
   };
 
@@ -174,7 +198,7 @@ const Operator = (props) => {
           data-test-id={testId}
           style={label !== null ? { width: 'max-content', height: theme.components.input.height } : undefined}
         >
-          <Avatar metaObj={metaObj} />
+          <Avatar {...props} />
         </Button>
       ) : (
         <Button
@@ -233,5 +257,3 @@ Operator.defaultProps = {
   helperText: null,
   metaObj: null
 };
-
-export default Operator;

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

@@ -1,8 +1,8 @@
-/* eslint-disable storybook/prefer-pascal-case */
 /* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
 import { withKnobs } from '@storybook/addon-knobs';
 
-import PegaDxilMyPageCaseWidget from './index.jsx';
+import PegaDxilMyPageCaseWidget from './index';
 
 import { configProps, operatorDetails } from './mock';
 
@@ -35,6 +35,7 @@ window.PCore.getUserApi = () => {
 };
 
 export const BasePegaDxilMyPageCaseWidget = () => {
+
   const props = {
     label: configProps.label,
     createLabel: configProps.createLabel,
@@ -49,31 +50,19 @@ export const BasePegaDxilMyPageCaseWidget = () => {
       return {
         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 (
     <>
       <PegaDxilMyPageCaseWidget {...props} />
     </>

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

@@ -4,18 +4,37 @@
 import { Fragment } from 'react';
 import { DateTimeDisplay, Card, CardHeader, CardContent, Flex } from '@pega/cosmos-react-core';
 import PropTypes from 'prop-types';
+import type { PConnFieldProps } from './PConnProps';
 
 // includes in bundle
-import Operator from './Operator.jsx';
+import Operator from './Operator';
 
 import StyledPegaDxilMyPageCaseWidgetWrapper from './styles';
 
 
+// interface for props
+interface PegaDxilMyPageCaseWidgetProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  title: string;
+  createLabel: string;
+  updateLabel: string;
+  resolveLabel: string;
+  createOperator: any;
+  updateOperator: any;
+  resolveOperator: any;
+  createDateTime: string;
+  updateDateTime: string;
+  resolveDateTime: string;
+  hideLabel: 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
-export default function PegaDxilMyPageCaseWidget(props) {
+export default function PegaDxilMyPageCaseWidget(props: PegaDxilMyPageCaseWidgetProps) {
 
   const {
     getPConnect,
@@ -49,7 +68,8 @@ export default function PegaDxilMyPageCaseWidget(props) {
       <CardHeader>{title}</CardHeader>
       <CardContent>
       <Flex container={{ direction: 'row'}}>
-      <Operator label={hideLabel ? null : _label} name={user.userName} id={user.userId} getPConnect={getPConnect} />
+      <Operator label={hideLabel ? undefined : _label} name={user.userName} id={user.userId} getPConnect={getPConnect} value={undefined} validatemessage='' hideLabel={false} readOnly={false} required={false} disabled={false} externalUser={undefined} />
+
 
       {dateTimeValue && (
         <Fragment>

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

@@ -1,5 +1,5 @@
-/* eslint-disable storybook/default-exports */
-/* eslint-disable storybook/prefer-pascal-case */
+
+// @ts-nocheck
 export const configProps = {
   label: 'Create operator',
   createLabel: 'Created',

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

@@ -1,7 +1,11 @@
+
 /* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
 import { withKnobs } from '@storybook/addon-knobs';
 
-import PegaDxilMyPageWidget from './index.jsx';
+import PegaDxilMyPageWidget from './index';
+
+
 import configProps from './mock';
 
 export default {
@@ -11,6 +15,7 @@ export default {
 };
 
 export const BasePegaDxilMyPageWidget = () => {
+
   const props = {
     label: configProps.label,
     header: configProps.header,
@@ -18,9 +23,9 @@ export const BasePegaDxilMyPageWidget = () => {
     image: configProps.image,
     datasource: configProps.datasource,
     whatsnewlink: configProps.whatsnewlink
-  };
+};
 
-  return (
+return (
     <>
       <PegaDxilMyPageWidget {...props} />
     </>

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

@@ -1,18 +1,31 @@
 import PropTypes from 'prop-types';
 import { AppAnnouncement as PegaAppAnnouncement } from '@pega/cosmos-react-work';
+import type { PConnFieldProps } from './PConnProps';
 
 import StyledPegaDxilMyPageWidgetWrapper from './styles';
 
+// interface for props
+interface PegaDxilMyPageWidgetProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+    datasource: Array<any>;
+    header: string;
+    description: string;
+    whatsnewlink: string;
+    image: string;
+}
+
 
 // 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
-export default function PegaDxilMyPageWidget(props) {
+export default function PegaDxilMyPageWidget(props: PegaDxilMyPageWidgetProps) {
 
   const { header, description, datasource, whatsnewlink, image } = props;
   let details = [];
+  // @ts-ignore
   if (datasource && datasource.source) {
+    // @ts-ignore
     details = datasource.source.map((item) => {
       return item.name;
     });

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

@@ -1,4 +1,5 @@
-/* eslint-disable storybook/story-exports */
+
+// @ts-nocheck
 const configProps = {
   label: 'App announcement',
   header: 'Announcements',