@pega/custom-dx-components 23.1.11 → 24.1.10

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

@@ -9,7 +9,7 @@ const LazyComponentMap = {};
  * metadata of all regions.
  * @param {Function} pConnect PConnect of a Template component.
  */
-export function getAllFields(pConnect) {
+export function getAllFields(pConnect: Function) {
   const metadata = pConnect().getRawMetadata();
   if (!metadata.children) {
     return [];
@@ -17,15 +17,15 @@ export function getAllFields(pConnect) {
 
   let allFields = [];
 
-  const makeField = (f) => ({
+  const makeField = (f: any) => ({
     ...pConnect().resolveConfigProps(f.config),
     type: f.type
   });
 
   const hasRegions = !!metadata.children[0]?.children;
   if (hasRegions) {
-    allFields = metadata.children.map((region) =>
-      region.children.map((field) => {
+    allFields = metadata.children.map((region: any) =>
+      region.children.map((field: any) => {
         // Do not resolve the config props if is status work, instead create component here as status badge and mark as status display
         if (field.config?.value === '@P .pyStatusWork') {
           field.type = 'TextInput';
@@ -50,7 +50,7 @@ export function getAllFields(pConnect) {
  * @param {Function} getPConnect PConnect function passed along to other components.
  * @param {string} displayMode displayMode string contains information about the layout of component in review mode.
  */
-export function prepareComponentInCaseSummary(configObject, getPConnect, displayMode) {
+export function prepareComponentInCaseSummary(configObject: any, getPConnect: Function, displayMode: string) {
   const { config, children } = configObject;
   let { type } = configObject;
   const caseSummaryComponentObject = {};
@@ -60,33 +60,40 @@ export function prepareComponentInCaseSummary(configObject, getPConnect, display
     type = 'TextInput'; // force the type to be TextInput for status field.
     // As TextInput is loaded forcefully sometimes, TextInput component might not be available in lazy map.
     // Load TextInput if it is not available.
+    // @ts-ignore
     if (!LazyComponentMap[type]) {
       PCore.getAssetLoader().getLoader('component-loader')([type]);
     }
   }
 
+  // @ts-ignore
   caseSummaryComponentObject.name = getPConnect().resolveConfigProps({
     label: config.label
   }).label;
   if (type === 'CaseOperator') {
+     // @ts-ignore
     switch (caseSummaryComponentObject.name) {
       case 'Create operator':
+         // @ts-ignore
         caseSummaryComponentObject.name = getPConnect().resolveConfigProps({
           createLabel: config.createLabel
         }).createLabel;
         break;
       case 'Update operator':
+         // @ts-ignore
         caseSummaryComponentObject.name = getPConnect().resolveConfigProps({
           updateLabel: config.updateLabel
         }).updateLabel;
         break;
       default:
+         // @ts-ignore
         caseSummaryComponentObject.name = getPConnect().resolveConfigProps({
           resolveLabel: config.resolveLabel
         }).resolveLabel;
         break;
     }
   } else if (type === 'Checkbox') {
+     // @ts-ignore
     caseSummaryComponentObject.name = getPConnect().resolveConfigProps({
       label: config.caption
     }).label;
@@ -108,15 +115,17 @@ export function prepareComponentInCaseSummary(configObject, getPConnect, display
     createdComponent.props.getPConnect().setInheritedProp('showAddressLabel', showAddressLabel);
   }
   // createdComponent.props.getPConnect().setInheritedProp("hideLabel", true);
+   // @ts-ignore
   caseSummaryComponentObject.value = createdComponent;
   if (type === 'reference') {
+     // @ts-ignore
     caseSummaryComponentObject.name = createdComponent.props.getPConnect().getInheritedProps().label;
   }
 
   return caseSummaryComponentObject;
 }
 
-export function getFilteredFields(getPConnect) {
+export function getFilteredFields(getPConnect: Function) {
   let primaryFieldsRaw;
   let secondaryFieldsRaw;
   const metadata = getPConnect().getRawMetadata();
@@ -129,12 +138,12 @@ export function getFilteredFields(getPConnect) {
   }
 
   // Filter out fields that are not visible and unsupported types for primary fields (for CaseSummary)
-  primaryFieldsRaw = primaryFieldsRaw.filter((item) => {
+  primaryFieldsRaw = primaryFieldsRaw.filter((item: any) => {
     const resolvedItem = getPConnect().resolveConfigProps(item.config);
     return resolvedItem.visibility !== false && item.type !== 'TextContent';
   });
 
-  secondaryFieldsRaw = secondaryFieldsRaw.filter((item) => {
+  secondaryFieldsRaw = secondaryFieldsRaw.filter((item: any) => {
     const resolvedItem = getPConnect().resolveConfigProps(item.config);
     return resolvedItem.visibility !== false && item.type !== 'TextContent';
   });
@@ -147,17 +156,18 @@ export function getFilteredFields(getPConnect) {
  * @param {object[]} regionData template children item.
  * @returns {object[]} ConfigurableLayout content.
  */
-export function getLayoutDataFromRegion(regionData) {
+export function getLayoutDataFromRegion(regionData: object[]) {
   const defaultLayoutConfig = {
     width: 'full',
     fillAvailable: true,
     minWidth: [300, 'px']
   };
 
+   // @ts-ignore
   return regionData.props
     ?.getPConnect()
     ?.getChildren()
-    ?.map((item, index) => {
+    ?.map((item: any, index: number) => {
       const itemPConnect = item?.getPConnect();
 
       return {
@@ -175,15 +185,18 @@ export function getLayoutDataFromRegion(regionData) {
  * Determine if the current view is the view of the case step/assignment.
  * @param {Function} pConnect PConnect object for the component
  */
-export function getIsAssignmentView(pConnect) {
+export function getIsAssignmentView(pConnect: Function) {
   // Get caseInfo content from the store which contains the view info about the current assignment/step
   // TODO To be replaced with pConnect.getCaseInfo().getCurrentAssignmentView when it's available
+   // @ts-ignore
   const assignmentViewClass = pConnect.getValue(PCore.getConstants().CASE_INFO.CASE_INFO_CLASSID);
+   // @ts-ignore
   const assignmentViewName = pConnect.getValue(PCore.getConstants().CASE_INFO.ASSIGNMENTACTION_ID);
 
   const assignmentViewId = `${assignmentViewName}!${assignmentViewClass}`;
 
   // Get the info about the current view from pConnect
+   // @ts-ignore
   const currentViewId = `${pConnect.getCurrentView()}!${pConnect.getCurrentClassID()}`;
 
   return assignmentViewId === currentViewId;
@@ -194,7 +207,8 @@ export function getIsAssignmentView(pConnect) {
  * @param {Function} pConnect PConnect object for the component
  * @param {string} [instructions="casestep"] 'casestep', 'none', or the html content of a Rule-UI-Paragraph rule (processed via core's paragraph annotation handler)
  */
-export function getInstructions(pConnect, instructions = 'casestep') {
+export function getInstructions(pConnect: Function, instructions: string = 'casestep') {
+   // @ts-ignore
   const caseStepInstructions = pConnect.getValue(PCore.getConstants().CASE_INFO.INSTRUCTIONS);
 
   // Determine if this view is the current assignment/step view
@@ -212,9 +226,9 @@ export function getInstructions(pConnect, instructions = 'casestep') {
 
   // If the annotation wasn't processed correctly, don't return any instruction text
   if (instructions?.startsWith('@PARAGRAPH')) {
-    /* eslint-disable no-console */
+
     console.error('@PARAGRAPH annotation was not processed. Hiding custom instructions.');
-    /* eslint-enable no-console */
+
     return undefined;
   }
 

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPageCaseWidget/Avatar.tsx

@@ -1,7 +1,6 @@
 /* eslint-disable react-hooks/rules-of-hooks */
 import React from 'react';
 import { useEffect, useState } from 'react';
-import PropTypes from 'prop-types';
 import { Avatar as CosmosAvatar } from '@pega/cosmos-react-core';
 import type { PConnFieldProps } from './PConnProps';
 
@@ -15,7 +14,7 @@ interface PegaDxilMyPageCaseWidgetAvatarProps extends PConnFieldProps {
 }
 
 function Avatar(props: PegaDxilMyPageCaseWidgetAvatarProps) {
-  const { metaObj, showStatus } = props;
+  const { metaObj, showStatus = false } = props;
   const [imageBlobUrl, setImageBlobUrl] = useState(null);
   let userName: string;
   let userIdentifier: string;
@@ -75,14 +74,5 @@ function Avatar(props: PegaDxilMyPageCaseWidgetAvatarProps) {
   return <CosmosAvatar name={userName} imageSrc={imageBlobUrl as React.SetStateAction<any>} />;
 }
 
-Avatar.propTypes = {
-  metaObj: PropTypes.objectOf(PropTypes.any),
-  showStatus: PropTypes.bool
-};
-
-Avatar.defaultProps = {
-  metaObj: null,
-  showStatus: false
-};
 
 export default Avatar;

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPageCaseWidget/Operator.tsx

@@ -12,12 +12,12 @@ import {
 } from '@pega/cosmos-react-core';
 import { Glimpse } from '@pega/cosmos-react-work';
 import { EmailDisplay } from '@pega/cosmos-react-core';
-import PropTypes from 'prop-types';
 
 import type { PConnFieldProps } from './PConnProps';
 
 import Avatar from './Avatar';
 
+
 // interface for props
 interface PegaDxilMyPageCaseWidgetOperatorProps extends PConnFieldProps {
   // If any, enter additional props that only exist on TextInput here
@@ -36,7 +36,7 @@ export default function Operator(props: PegaDxilMyPageCaseWidgetOperatorProps) {
   const [isLoading, setIsLoading] = useState(true);
   const [popoverEl, setPopoverEl] = useElement(null);
   const [popoverContent, setpopoverContent] = useState(null);
-  const theme = useTheme();
+  const theme: any = useTheme();
 
   /* If the id has changed, we need to reset the popover */
   useEffect(() => {
@@ -46,8 +46,8 @@ export default function Operator(props: PegaDxilMyPageCaseWidgetOperatorProps) {
 
 
   const OperatorPreview = () => {
-    let localizedVal = PCore.getLocaleUtils().getLocaleValue;
-    let localeCategory = 'Operator';
+    const localizedVal = PCore.getLocaleUtils().getLocaleValue;
+    const localeCategory = 'Operator';
     setpopoverContent(
       <Progress variant='ring' message={localizedVal('Loading operator...', localeCategory)} placement='local' />
     );
@@ -87,55 +87,54 @@ export default function Operator(props: PegaDxilMyPageCaseWidgetOperatorProps) {
         />
       );
     } else {
-      localizedVal = PCore.getLocaleUtils().getLocaleValue;
-      localeCategory = 'Operator';
       return PCore.getUserApi()
         .getOperatorDetails(id, true)
         .then(res => {
           if (res.data?.data && res.data.data[0].BusinessID && res.data.data[0].Name) {
             const fields = [];
-            if (res.data.data[0].Name)
+            if (res.data.data[0].Name) {
               fields.push({
                 id: 'Name',
                 name: localizedVal('Name', localeCategory),
                 value: res.data.data[0].Name
               });
-            if (res.data.data[0].BusinessID)
+            }
+            if (res.data.data[0].BusinessID) {
               fields.push({
                 id: 'Email',
                 name: localizedVal('Email address', localeCategory),
                 value: <EmailDisplay value={res.data.data[0].BusinessID} />
               });
-
-              setIsLoading(false);
-              setpopoverContent(
-                <Glimpse
-                  heading={{
-                    primary: res.data.data[0].Name,
-                    secondary: res.data.data[0].BusinessID,
-                    visual: (
-                      <Avatar
-                        metaObj={{
-                          image: '',
-                          name: res.data.data[0].Name
-                        }}
-                      />
-                    )
-                  }}
-                  fields={fields}
-                  target={pTarget}
-                  onDismiss={() => {pTarget = null;})}
-                />
-              );
-
+            }
+            const opAvatar = (
+              <Avatar
+                metaObj={{
+                  image: '',
+                  name: res.data.data[0].Name
+                }}
+              />
+            );
+
+            setIsLoading(false);
+            setpopoverContent(
+              <Glimpse
+                heading={{
+                  primary: res.data.data[0].Name,
+                  secondary: res.data.data[0].BusinessID,
+                  visual: opAvatar
+                }}
+                fields={fields}
+                target={pTarget}
+                onDismiss={() => {pTarget = null;}}
+              />
+            );
           }
         });
-
     }
   };
 
 
-  const clickAction = (e: any) =>
+  const clickAction = (e: any) => {
 
     setIsOpen(!isOpen);
     if (pTarget === null) {
@@ -151,6 +150,7 @@ export default function Operator(props: PegaDxilMyPageCaseWidgetOperatorProps) {
   };
 
   useOuterEvent('mousedown', [popoverEl], hidePopover); // Call the method on clicking outside these elements
+
   const hideOnEscape = (e: any) => {
     if (e.key === 'Escape') hidePopover(); // Call the method when Escape key is pressed
   };
@@ -167,7 +167,7 @@ export default function Operator(props: PegaDxilMyPageCaseWidgetOperatorProps) {
           data-test-id={testId}
           style={label !== null ? { width: 'max-content', height: theme.components.input.height } : undefined}
         >
-          <Avatar {...props}></Avatar>
+          <Avatar {...props} />
         </Button>
       ) : (
         <Button
@@ -208,21 +208,3 @@ export default function Operator(props: PegaDxilMyPageCaseWidgetOperatorProps) {
 
   return comp;
 };
-
-Operator.propTypes = {
-  name: PropTypes.string,
-  id: PropTypes.string,
-  label: PropTypes.string,
-  testId: PropTypes.string,
-  helperText: PropTypes.string,
-  metaObj: PropTypes.object
-};
-
-Operator.defaultProps = {
-  name: '',
-  id: '',
-  label: null,
-  testId: null,
-  helperText: null,
-  metaObj: null
-};

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

@@ -1,17 +1,20 @@
 /* eslint-disable react/jsx-no-useless-fragment */
 // @ts-nocheck
-import { withKnobs } from '@storybook/addon-knobs';
+import type { Meta, StoryObj } from '@storybook/react';
 
 import PegaDxilMyPageCaseWidget from './index';
 
 import { configProps, operatorDetails } from './mock';
 
-export default {
+const meta: Meta<typeof PegaDxilMyPageCaseWidget> = {
   title: 'PegaDxilMyPageCaseWidget',
-  decorators: [withKnobs],
-  component: PegaDxilMyPageCaseWidget
+  component: PegaDxilMyPageCaseWidget,
+  excludeStories: /.*Data$/
 };
 
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyPageCaseWidget>;
+
 if (!window.PCore) {
   window.PCore = {};
 }
@@ -34,7 +37,7 @@ window.PCore.getUserApi = () => {
   };
 };
 
-export const BasePegaDxilMyPageCaseWidget = () => {
+export const BasePegaDxilMyPageCaseWidget: Story = args => {
 
   const props = {
     label: configProps.label,
@@ -70,7 +73,9 @@ export const BasePegaDxilMyPageCaseWidget = () => {
 
 return (
     <>
-      <PegaDxilMyPageCaseWidget {...props} />
+      <PegaDxilMyPageCaseWidget {...props} {...args} />
     </>
   );
 };
+
+BasePegaDxilMyPageCaseWidget.args = {};

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPageCaseWidget/index.tsx

@@ -1,6 +1,5 @@
 import { Fragment } from 'react';
-import { DateTimeDisplay, Card, CardHeader, CardContent, Flex } from '@pega/cosmos-react-core';
-import PropTypes from 'prop-types';
+import { DateTimeDisplay, Card, CardHeader, CardContent, Flex, withConfiguration } from '@pega/cosmos-react-core';
 import type { PConnFieldProps } from './PConnProps';
 
 // includes in bundle
@@ -21,12 +20,12 @@ interface PegaDxilMyPageCaseWidgetProps extends PConnFieldProps {
 
 // 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: PegaDxilMyPageCaseWidgetProps) {
+function PegaDxilMyPageCaseWidget(props: PegaDxilMyPageCaseWidgetProps) {
 
   const {
     getPConnect,
-    title,
-    label,
+    title = 'Create operator',
+    label = 'Create operator',
     createLabel,
     updateLabel
   } = props;
@@ -47,7 +46,22 @@ export default function PegaDxilMyPageCaseWidget(props: PegaDxilMyPageCaseWidget
       <CardHeader>{title}</CardHeader>
       <CardContent>
       <Flex container={{ direction: 'row'}}>
-      <Operator label={_label} name={user} id={user} getPConnect={getPConnect} value={undefined} validatemessage='' hideLabel={false} readOnly={false} required={false} disabled={false} externalUser={undefined} />
+           <Operator
+              label={_label}
+              name={user}
+              id={user}
+              getPConnect={getPConnect}
+              value={undefined}
+              validatemessage=''
+              hideLabel={false}
+              readOnly={false}
+              required={false}
+              disabled={false}
+              externalUser={undefined}
+              testId=''
+              helperText=''
+              metaObj={undefined}
+            />     
       {dateTimeValue && (
         <Fragment>
           {' '}
@@ -65,20 +79,8 @@ export default function PegaDxilMyPageCaseWidget(props: PegaDxilMyPageCaseWidget
 
 }
 
-PegaDxilMyPageCaseWidget.defaultProps = {
-  "label": "Create operator",
-  "title": "Create operator",
-  createLabel: null,
-  updateLabel: null
-};
-
-PegaDxilMyPageCaseWidget.propTypes = {
-  getPConnect: PropTypes.func.isRequired,
-  label: PropTypes.string,
-  title: PropTypes.string,
-  createLabel: PropTypes.string,
-  updateLabel: PropTypes.string
-};
+
+export default withConfiguration(PegaDxilMyPageCaseWidget);
 
 // as objects are there in props, shallow comparision fails & re-rendering of comp happens even with
 // same key value pairs in obj. hence using custom comparison function on when to re-render

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPageCaseWidget/styles.ts

@@ -1,15 +1,8 @@
-
-// utilizing theming, comment out, if want individual style
-import styled from 'styled-components';
-import { Configuration } from '@pega/cosmos-react-core';
-
-export default styled(Configuration)``;
-
 // individual style, comment out above, and uncomment here and add styles
-// import styled, { css } from 'styled-components';
-//
-// export default styled.div(() => {
-//  return css`
-//    margin: 0px 0;
-//  `;
-// });
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 0px 0;
+  `;
+});

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

@@ -1,33 +1,120 @@
 
 /* eslint-disable react/jsx-no-useless-fragment */
 // @ts-nocheck
-import { withKnobs } from '@storybook/addon-knobs';
+import type { Meta, StoryObj } from '@storybook/react';
 
 import PegaDxilMyPageWidget from './index';
 
 
 import configProps from './mock';
 
-export default {
+const meta: Meta<typeof PegaDxilMyPageWidget> = {
   title: 'PegaDxilMyPageWidget',
-  decorators: [withKnobs],
-  component: PegaDxilMyPageWidget
+  component: PegaDxilMyPageWidget,
+  excludeStories: /.*Data$/
 };
 
-export const BasePegaDxilMyPageWidget = () => {
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyPageWidget>;
+
+if (!window.PCore) {
+  window.PCore = {};
+}
+
+const worklistData = {
+  data: {
+    data: [
+      {
+        CaseName: 'Loan',
+        BusinessID: ' A-8002',
+        ProcessName: 'New',
+        TaskName: 'Details'
+      },
+      {
+        CaseName: 'Loan',
+        BusinessID: ' A-7001',
+        ProcessName: 'Open',
+        TaskName: 'Info'
+      },
+      {
+        CaseName: 'Loan',
+        BusinessID: ' A-9000',
+        ProcessName: 'Open',
+        TaskName: 'Amount'
+      }
+    ]
+  }
 
-  const props = {
-    label: configProps.label,
-    header: configProps.header,
-    description: configProps.description,
-    image: configProps.image,
-    datasource: configProps.datasource,
-    whatsnewlink: configProps.whatsnewlink
 };
 
-return (
+window.PCore.getDataApiUtils = () => {
+  return {
+    getData: () => {
+      return new Promise(resolve => {
+        resolve(worklistData);
+      });
+    },
+    getDataAsync: () => {
+      return new Promise(resolve => {
+        resolve(worklistData);
+      });
+    }
+  };
+};
+
+
+
+export const BasePegaDxilMyPageWidget: Story = args => {
+
+  const props = {
+    ...configProps,
+    getPConnect: () => {
+      return {
+        getValue: value => {
+          return value;
+        },
+        getContextName: () => {
+          return 'app/primary_1';
+        },
+        getLocalizedValue: value => {
+          return value;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {
+              /* nothing */
+            },
+            triggerFieldChange: () => {
+              /* nothing */
+            }
+          };
+        },
+        ignoreSuggestion: () => {
+          /* nothing */
+        },
+        acceptSuggestion: () => {
+          /* nothing */
+        },
+        setInheritedProps: () => {
+          /* nothing */
+        },
+        resolveConfigProps: () => {
+          /* nothing */
+        }
+      };
+    }
+  };
+
+  return (
     <>
-      <PegaDxilMyPageWidget {...props} />
+      <PegaDxilMyPageWidget {...props} {...args} />
     </>
   );
 };
+
+BasePegaDxilMyPageWidget.args = {
+  header: configProps.header,
+  description: configProps.description,
+  whatsnewlink: configProps.whatsnewlink,
+  datasource: configProps.datasource,
+};