@pega/dx-component-builder-sdk 23.1.14 → 24.1.10

package/tests/assets/sdk-r/components/createAll/custom-constellation/template/Pega_DXIL_MyForm/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/sdk-r/components/createAll/custom-constellation/template/Pega_DXIL_MyPage/GetNextWork.tsx

@@ -18,6 +18,7 @@ export default function GetNextWork(props: PegaDxilMyPageWorkProps) {
   const toasterCtx = useToaster();
 
   const localizedVal = PCore.getLocaleUtils().getLocaleValue;
+  const localeCategory = 'Case';
 
   const getNextWork = () => {
 
@@ -30,7 +31,7 @@ export default function GetNextWork(props: PegaDxilMyPageWorkProps) {
         console.log(err);
         if (err[0].status === 404) {
           toasterCtx.push({
-            content: localizedVal('No task currently available')
+            content: localizedVal('No task currently available', localeCategory)
           });
         }
       });

package/tests/assets/sdk-r/components/createAll/custom-constellation/template/Pega_DXIL_MyPage/demo.stories.tsx

@@ -2,20 +2,23 @@
 /* eslint-disable react/jsx-no-useless-fragment */
 /* eslint-disable react/no-unstable-nested-components */
 // @ts-nocheck
-import { withKnobs } from '@storybook/addon-knobs';
+import type { Meta, StoryObj } from '@storybook/react';
 
 import { AppAnnouncement as PegaAppAnnouncement } from '@pega/cosmos-react-work';
 
 import PegaDxilMyPage from './index';
 import { pyHome1Resolved, pyHome1Raw } from './mock';
 
-export default {
+const meta: Meta<typeof PegaDxilMyPage> = {
   title: 'PegaDxilMyPage',
-  decorators: [withKnobs],
-  component: PegaDxilMyPage
+  component: PegaDxilMyPage,
+  excludeStories: /.*Data$/,
 };
 
-export const BasePegaDxilMyPage = () => {
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyPage>;
+
+export const BasePegaDxilMyPage: Story = args => {
   if (!window.PCore) {
     window.PCore = {};
   }
@@ -32,9 +35,7 @@ export const BasePegaDxilMyPage = () => {
 
   const props = {
     useConfigurableLayout: false,
-    enableGetNextWork: pyHome1Raw.config.enableGetNextWork,
     icon: pyHome1Raw.config.icon,
-    title: 'Page Template',
 
     getPConnect: () => {
       return {
@@ -100,7 +101,12 @@ export const BasePegaDxilMyPage = () => {
 
   return (
     <>
-      <PegaDxilMyPage {...props}>{regionAChildren}</PegaDxilMyPage>
+      <PegaDxilMyPage {...props} {...args}>{regionAChildren}</PegaDxilMyPage>
     </>
   );
 };
+
+BasePegaDxilMyPage.args = {
+  title: 'Page Template',
+  enableGetNextWork: pyHome1Raw.config.enableGetNextWork,
+};

package/tests/assets/sdk-r/components/createAll/custom-constellation/template/Pega_DXIL_MyPage/index.tsx

@@ -1,6 +1,5 @@
 import { useMemo, Children } from 'react';
-import PropTypes from 'prop-types';
-import { OneColumnPage as OneColumn } from '@pega/cosmos-react-core';
+import { OneColumnPage as OneColumn, withConfiguration } from '@pega/cosmos-react-core';
 import { ConfigurableLayout } from '@pega/cosmos-react-work'
 // import { registerIcon } from '@pega/cosmos-react-core';
 import type { PConnFieldProps } from './PConnProps';
@@ -35,11 +34,11 @@ interface PegaDxilMyPageProps 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 PegaDxilMyPage(props: PegaDxilMyPageProps) {
+function PegaDxilMyPage(props: PegaDxilMyPageProps) {
 
   // add back in icon when working
-  // const { children, title, icon, useConfigurableLayout, getPConnect, enableGetNextWork } = props;
-  const { children, title, useConfigurableLayout, getPConnect, enableGetNextWork } = props;
+  // const { children, title, icon, useConfigurableLayout = false, getPConnect, enableGetNextWork } = props;
+  const { children = [], title, useConfigurableLayout, getPConnect, enableGetNextWork } = props;
   const childArray = useMemo(() => {
     return Children.toArray(children);
   }, [children]);
@@ -70,14 +69,4 @@ export default function PegaDxilMyPage(props: PegaDxilMyPageProps) {
 
 }
 
-PegaDxilMyPage.defaultProps = {
-  /* icon: '', */
-  useConfigurableLayout: false
-};
-
-PegaDxilMyPage.propTypes = {
-  children: PropTypes.arrayOf(PropTypes.node).isRequired,
-  title: PropTypes.string.isRequired,
-  /* icon: PropTypes.string, */
-  useConfigurableLayout: PropTypes.bool
-};
+export default withConfiguration(PegaDxilMyPage);

package/tests/assets/sdk-r/components/createAll/custom-constellation/template/Pega_DXIL_MyPage/localizations.json

@@ -1,4 +1,6 @@
 {
-  "Get next work" : "Get next work",
-  "No task currently available" : "No task currently available"
+  "fields" : {
+    "Get next work" : "Get next work",
+    "No task currently available" : "No task currently available"
+  }
 }

package/tests/assets/sdk-r/components/createAll/custom-constellation/template/Pega_DXIL_MyPage/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/{src/tasks/create/templates/Constellation/template/PAGE/utils.js.mustache → tests/assets/sdk-r/components/createAll/custom-constellation/template/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/sdk-r/components/createAll/custom-constellation/template/Pega_DXIL_MyTwoColumnDetails/Avatar.tsx

@@ -0,0 +1,78 @@
+/* eslint-disable react-hooks/rules-of-hooks */
+import  React from 'react';
+import { useEffect, useState } from 'react';
+import { Avatar as CosmosAvatar, withConfiguration } from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
+
+
+// interface for props
+interface PegaDxilMyTwoColumnDetailsAvatarProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  metaObj: any;
+  showStatus: boolean;
+
+}
+
+function Avatar(props: PegaDxilMyTwoColumnDetailsAvatarProps) {
+  const { metaObj, showStatus = false } = props;
+  const [imageBlobUrl, setImageBlobUrl] = useState(null);
+  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)
+  if (!metaObj) {
+    userName = PCore.getEnvironmentInfo().getOperatorName();
+    userIdentifier = PCore.getEnvironmentInfo().getOperatorIdentifier();
+  } else {
+    userName = metaObj.name;
+    userIdentifier = metaObj.ID;
+  }
+  if (!userName && userIdentifier) {
+    userName = userIdentifier;
+  }
+
+  useEffect(() => {
+    const imageKey = !metaObj ? PCore.getEnvironmentInfo().getOperatorImageInsKey() : metaObj.image;
+    if (imageKey) {
+      PCore.getAssetLoader()
+        .getSvcImage(imageKey)
+        .then((blob) => window.URL.createObjectURL(blob))
+        .then((imagePath) => setImageBlobUrl(imagePath as React.SetStateAction<any>));
+    }
+  }, [metaObj]);
+
+  if (showStatus) {
+    const currentState = PCore.getMessagingServiceManager().getUserPresence().getUserState(userIdentifier);
+    const [userState, setUserState]: any  = useState(currentState === 'online' ? 'active' : 'inactive');
+
+    // @ts-ignore
+    const handleUserStateChange = ({ state }) => {
+      setUserState(state === 'online' ? 'active' : 'inactive');
+    };
+
+    useEffect(() => {
+      const subId = PCore.getMessagingServiceManager()
+        .getUserPresence()
+        // @ts-ignore
+        .subscribe(userIdentifier, handleUserStateChange);
+
+      return function cleanup() {
+        PCore.getMessagingServiceManager().getUserPresence().unsubscribe(userIdentifier, subId);
+      };
+    }, [userIdentifier, handleUserStateChange]);
+    // @ts-ignore
+    return <CosmosAvatar name={userName} imageSrc={imageBlobUrl as React.SetStateAction<any>} status={userState} />;
+  }
+
+  // Do not render when userName does not exists
+  // TODO : In CNR case, pxRequestor is not available, please remove this condition once it populates
+  if (!userName) {
+    return null;
+  }
+
+  return <CosmosAvatar name={userName} imageSrc={imageBlobUrl as React.SetStateAction<any>} />;
+}
+
+
+export default withConfiguration(Avatar);

package/tests/assets/sdk-r/components/createAll/custom-constellation/template/Pega_DXIL_MyTwoColumnDetails/DetailsRender.tsx

@@ -0,0 +1,52 @@
+import { Fragment, ReactElement } from 'react';
+import { FieldValueList } from '@pega/cosmos-react-core';
+
+interface DetailsRenderProps {
+  children?: never;
+  child: NonNullable<ReactElement>;
+}
+
+const DetailsRender = (props: DetailsRenderProps) => {
+  const { child } = props;
+
+  const kids = child.props.getPConnect().getChildren();
+
+  const displayCompArr: ReactElement[] = [];
+
+  Object.values(kids).forEach((value: any, i :number) => {
+    const { type } = value.getPConnect().getRawMetadata();
+    const { hideLabel, variant, testId, label } = value
+      .getPConnect()
+      .resolveConfigProps(value.getPConnect().getConfigProps());
+
+    let displayComp;
+    const key = JSON.stringify(value.getPConnect());
+    const key1 = key.concat(`-${i}`);
+
+    if (type === 'reference') {
+      const refElement = value.getPConnect().getComponent();
+
+      displayCompArr.push(refElement);
+    } else {
+      const element = value.getPConnect().getComponent();
+      const displayEl = <Fragment key={key}>{element}</Fragment>;
+
+      displayComp = (
+        <Fragment key={key1}>
+          <FieldValueList
+            style={{ columnGap: '0'}}
+            variant={hideLabel ? 'stacked' : variant}
+            data-testid={testId}
+            fields={[{ id: '1', name: hideLabel ? '' : label, value: displayEl }]}
+          />
+        </Fragment>
+      );
+
+      displayCompArr.push(displayComp);
+    }
+  });
+
+  return <>{displayCompArr}</>;
+};
+
+export default DetailsRender;

package/tests/assets/sdk-r/components/createAll/custom-constellation/template/Pega_DXIL_MyTwoColumnDetails/HighlightRender.tsx

@@ -0,0 +1,46 @@
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import React from 'react';
+import { FieldValueList, Text } from '@pega/cosmos-react-core';
+import type { PConnProps } from './PConnProps';
+
+interface HighlightRenderProps extends PConnProps {
+  field?: any;
+}
+
+const HighlightRender = (props: HighlightRenderProps) => {
+  const { getPConnect, field } = props;
+
+  field.config.displayMode = 'DISPLAY_ONLY';
+
+  // Mark as status display when using pyStatusWork
+  if (field.config?.value === '@P .pyStatusWork') {
+    field.type = 'TextInput';
+    field.config.displayAsStatus = true;
+  }
+
+  const configProps: any = getPConnect().resolveConfigProps(field.config);
+
+  // @ts-ignore
+  const reactField = getPConnect().createComponent(field);
+
+  return (
+    <FieldValueList
+      style={{ width: 'auto' }}
+      variant='stacked'
+      data-testid={field.testId}
+      fields={[
+        {
+          id: '2',
+          name: configProps.hideLabel ? '' : configProps.label,
+          value: (
+            <Text variant='h1' as='span'>
+              {reactField}
+            </Text>
+          )
+        }
+      ]}
+    />
+  );
+};
+
+export default HighlightRender;