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

package/src/tasks/create/templates/Constellation/template/DETAILS-region/demo.stories.tsx.mustache

@@ -1,14 +1,49 @@
-
-
+/* eslint-disable no-nested-ternary */
+/* eslint-disable react/jsx-no-useless-fragment */
 // @ts-nocheck
-import { Text, FieldValueList, Button, DateTimeDisplay, useTheme } from '@pega/cosmos-react-core';
+import type { Meta, StoryObj } from '@storybook/react';
+import { Text, FieldValueList, DateTimeDisplay, useTheme } from '@pega/cosmos-react-core';
 import {{COMPONENT_CLASS_NAME}} from './index';
-import { pyReviewRaw, pyReviewResolved, regionChildrenResolved } from './mock';
+import { pyReviewRaw, pyReviewResolved, regionChildrenResolved, operatorDetails, configProps } from './mock';
 import StatusWorkRenderer from './StatusWork';
+import Operator from './Operator';
 
-export default {
+const meta: Meta<typeof {{COMPONENT_CLASS_NAME}}> = {
   title: '{{COMPONENT_CLASS_NAME}}',
-  component: {{COMPONENT_CLASS_NAME}}
+  component: {{COMPONENT_CLASS_NAME}},
+  excludeStories: /.*Data$/,
+  parameters: {
+    type: 'Details'
+  }
+};
+
+export default meta;
+type Story = StoryObj<typeof {{COMPONENT_CLASS_NAME}}>;
+
+if (!window.PCore) {
+  window.PCore = {};
+}
+
+window.PCore.getLocaleUtils = () => {
+  return {
+    getLocaleValue: value => {
+      return value;
+    }
+  };
+};
+
+window.PCore.getUserApi = () => {
+  return {
+    getOperatorDetails: () => {
+      return new Promise(resolve => {
+        resolve(operatorDetails);
+      });
+    }
+  };
+};
+
+const Region = () => {
+  return <></>;
 };
 
 const renderField = resolvedProps => {
@@ -18,7 +53,7 @@ const renderField = resolvedProps => {
     value = '',
     label = '',
     key,
-    // eslint-disable-next-line react-hooks/rules-of-hooks
+    // eslint-disable-next-line react-hooks/rules-of-hooks, @typescript-eslint/no-unused-vars
     theme = useTheme()
   } = resolvedProps;
 
@@ -46,19 +81,30 @@ const renderField = resolvedProps => {
 
   if (displayAsStatus === true) val = <StatusWorkRenderer value={value} key={key} />;
 
+  const [_label] =
+    label === 'Create operator'
+      ? [configProps.createLabel, configProps.createOperator, configProps.createDateTime]
+      : label === 'Update operator'
+        ? [configProps.updateLabel, configProps.updateOperator, configProps.updateDateTime]
+        : [configProps.resolveLabel, configProps.resolveOperator, configProps.resolveDateTime];
+
   if (label === 'Create Operator')
     val = (
-      <Button
-        variant='link'
-        style={
-          label !== null
-            ? { width: 'max-content', height: theme.components.input.height }
-            : undefined
-        }
-        key={key}
-      >
-        {value.userName}
-      </Button>
+      <Operator
+        label={configProps.hideLabel ? '' : _label}
+        name={configProps.createOperator.userName}
+        id={configProps.createOperator.userId}
+        value={undefined}
+        validatemessage=''
+        hideLabel={false}
+        readOnly={false}
+        required={false}
+        disabled={false}
+        externalUser={undefined}
+        metaObj={undefined}
+        testId=''
+        helperText=''
+      />
     );
 
   if (variant === 'inline') {
@@ -77,12 +123,8 @@ const renderField = resolvedProps => {
   return <FieldValueList variant={variant} fields={[{ name: label, value: val }]} key={key} />;
 };
 
-export const Base{{COMPONENT_CLASS_NAME}} = () => {
+export const Base{{COMPONENT_CLASS_NAME}}: Story = args => {
   const props = {
-    template: 'MyCo_MyComponents_NewDetailsTemplate',
-    showHighlightedData: true,
-    label: 'Test Details',
-    showLabel: true,
     getPConnect: () => {
       return {
         getChildren: () => {
@@ -119,24 +161,60 @@ export const Base{{COMPONENT_CLASS_NAME}} = () => {
         setInheritedProp: () => {
           /* nothing */
         },
-        resolveConfigProps: () => {
-          /* nothing */
+        resolveConfigProps: config => {
+          return config;
         }
       };
     }
   };
 
-  const regionAChildren = pyReviewRaw.children[0].children.map(child => {
-    return props.getPConnect().createComponent(child);
-  });
-  const regionBChildren = pyReviewRaw.children[1].children.map(child => {
-    return props.getPConnect().createComponent(child);
-  });
 
   return (
-    <{{COMPONENT_CLASS_NAME}} {...props}>
-      {regionAChildren}
-      {regionBChildren}
+    <{{COMPONENT_CLASS_NAME}} {...props} {...args}>
+        <Region
+          {...{
+            getPConnect: () => ({
+              setInheritedProp: () => {},
+              getChildren: () =>
+                pyReviewRaw.children[0].children.map((child, index) => {
+                  return {
+                    getPConnect: () => ({
+                      getRawMetadata: () => pyReviewRaw.children[0].children[index],
+                      getConfigProps: () => {},
+                      resolveConfigProps: () => regionChildrenResolved[index],
+                      getComponent: () =>
+                        props.getPConnect().createComponent(pyReviewRaw.children[0].children[index])
+                    })
+                  };
+                })
+            })
+          }}
+        />
+        <Region
+          {...{
+            getPConnect: () => ({
+              setInheritedProp: () => {},
+              getChildren: () =>
+                pyReviewRaw.children[1].children.map((child, index) => {
+                  return {
+                    getPConnect: () => ({
+                      getRawMetadata: () => pyReviewRaw.children[1].children[index],
+                      getConfigProps: () => {},
+                      resolveConfigProps: () => regionChildrenResolved[index],
+                      getComponent: () =>
+                        props.getPConnect().createComponent(pyReviewRaw.children[1].children[index])
+                    })
+                  };
+                })
+            })
+          }}
+        />
     </{{COMPONENT_CLASS_NAME}}>
   );
 };
+
+Base{{COMPONENT_CLASS_NAME}}.args = {
+  showLabel: true,
+  label: 'Details Region template',
+  showHighlightedData: true
+};

package/src/tasks/create/templates/Constellation/template/DETAILS-region/index.tsx.mustache

@@ -1,10 +1,10 @@
-import { Fragment } from 'react';
-import { Grid, Flex, FieldGroup } from '@pega/cosmos-react-core';
-import PropTypes from 'prop-types';
-
+import { Fragment, Children, ReactElement } from 'react';
+import { Grid, Flex, FieldGroup, withConfiguration, GridContainerProps } from '@pega/cosmos-react-core';
 import type { PConnFieldProps } from './PConnProps';
+import DetailsRender from './DetailsRender';
+import HighlightRender from './HighlightRender';
 
-import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
+import Styled{{COMPONENT_CLASS_NAME}}Wrapper, { StyledDetailsGridContainer, StyledHighlightedFieldsHrLine } from './styles';
 
 // includes in bundle
 import { getAllFields } from './utils';
@@ -14,34 +14,31 @@ interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
   // If any, enter additional props that only exist on TextInput here
   showLabel: boolean;
   showHighlightedData: boolean;
-  children: any;
+  children: ReactElement[];
 }
 
-// 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 {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
+function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
 
-  const { getPConnect, children, label, showLabel, showHighlightedData  } = props;
+  const { getPConnect, label, children, showLabel = true, showHighlightedData = false  } = props;
   const propsToUse = { label, showLabel, ...getPConnect().getInheritedProps() };
 
+  // update children with readonly
+  Children.toArray(children).forEach(child => {
+    // @ts-ignore
+    child.props.getPConnect().setInheritedProp('readOnly', true);
+    // @ts-ignore
+    child.props.getPConnect().setInheritedProp('displayMode', 'DISPLAY_ONLY');
+  });
+
   const numRegions = getAllFields(getPConnect)?.length;
-  const gridRepeat = "repeat(".concat(numRegions).concat(", 1fr)");
-  const gridContainer = { "colGap": 1};
-  // @ts-ignore
+  const gridRepeat = "repeat(".concat(numRegions.toString()).concat(", 1fr)");
+
+  const gridContainer: GridContainerProps = { colGap: 6 };
   gridContainer.cols = gridRepeat;
-  // @ts-ignore
   gridContainer.alignItems = 'start';
 
-  const gridHighlightContainer = { "gap": 2};
-  // @ts-ignore
-  gridHighlightContainer.cols = gridRepeat;
-  // @ts-ignore
-  gridHighlightContainer.alignItems = 'start';
-  // @ts-ignore
-  gridHighlightContainer.pad = [0, 0, 2, 0];
-
   // Set up highlighted data to pass in return if is set to show, need raw metadata to pass to createComponent
   let highlightedDataArr = [];
   if (showHighlightedData) {
@@ -49,55 +46,47 @@ export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}
     const { highlightedData = [] } = getPConnect().getRawMetadata().config;
     // @ts-ignore
     highlightedDataArr = highlightedData.map((field) => {
-      field.config.displayMode = 'STACKED_LARGE_VAL';
-
-      // Mark as status display when using pyStatusWork
-      if (field.config.value === '@P .pyStatusWork') {
-        field.type = 'TextInput';
-        field.config.displayAsStatus = true;
-      }
-      // @ts-ignore
-      return getPConnect().createComponent(field);
+      return <HighlightRender field={field} getPConnect={props.getPConnect} />;
     });
   }
 
   return (
     <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
-    {{! pick new delimiters for mustache }}
-    {{=<% %>=}}
+{{! pick new delimiters for mustache }}
+{{=<% %>=}}
     <FieldGroup name={propsToUse.showLabel ? propsToUse.label : ''}>
       {showHighlightedData && highlightedDataArr.length > 0 && (
-        <Grid container={gridHighlightContainer}
-          data-testid={`highlighted-column-count-${numRegions}`}>
-          {highlightedDataArr.map((child: any, i: number) => (
-            <Fragment key={`hf-${i + 1}`}>{child}</Fragment>
-          ))}
-        </Grid>
+          <>
+            <Flex
+              container={{ direction: 'row', alignItems: 'start', colGap: 10 }}
+              data-testid={`highlighted-column-count-${numRegions}`}
+            >
+              {highlightedDataArr.map((child: any, i: number) => (
+                <Fragment key={`hf-${i + 1}`}>{child}</Fragment>
+              ))}
+            </Flex>
+            <StyledHighlightedFieldsHrLine />
+          </>
       )}
-      <Grid container={gridContainer} data-testid={`column-count-${numRegions}`} >
+      <Grid
+        as={StyledDetailsGridContainer}
+        container={gridContainer}
+        data-testid={`column-count-${numRegions}`} >
        {children.map((child: any, i: number) => (
-        <Flex container={{ direction: 'column'}} key={`r-${i + 1}`}>
-        {child}
+        <Flex
+          // @ts-ignore
+          container={{ direction: 'column', alignItems: 'normal', colGap: 1, rowGap: 1.5 }}
+          key={`r-${i + 1}`}
+        >
+          <DetailsRender child={child} />
         </Flex>
        ))}
       </Grid>
     </FieldGroup>
-    <%={{ }}=%>     {{! revert delimiters for mustache }}
+<%={{ }}=%>     {{! revert delimiters for mustache }}
     </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
   );
 
 }
 
-{{COMPONENT_CLASS_NAME}}.defaultProps = {
-  label: undefined,
-  showLabel: true,
-  showHighlightedData: false
-};
-
-
-{{COMPONENT_CLASS_NAME}}.propTypes = {
-  showLabel: PropTypes.bool,
-  label: PropTypes.string,
-  getPConnect: PropTypes.func.isRequired,
-  showHighlightedData: PropTypes.bool
-};
+export default withConfiguration({{COMPONENT_CLASS_NAME}});

package/src/tasks/create/templates/Constellation/template/DETAILS-region/mock.ts.mustache

@@ -16,6 +16,7 @@ export const pyReviewRaw = {
         config: {
           value: '@P .pyStatusWork',
           label: '@L Work Status',
+          hideLabel: true,
           displayMode: 'STACKED_LARGE_VAL',
           displayAsStatus: true,
           key: 'pyStatusWork'
@@ -26,6 +27,7 @@ export const pyReviewRaw = {
         config: {
           value: '@P .pyID',
           label: '@L Case ID',
+          hideLabel: true,
           displayMode: 'STACKED_LARGE_VAL',
           key: 'pyID'
         }
@@ -35,6 +37,7 @@ export const pyReviewRaw = {
         config: {
           value: '@P .pxCreateDateTime',
           label: '@L Create date/time',
+          hideLabel: true,
           displayMode: 'STACKED_LARGE_VAL',
           key: 'pxCreateDateTime'
         }
@@ -43,6 +46,7 @@ export const pyReviewRaw = {
         type: 'UserReference',
         config: {
           label: '@L Create Operator',
+          hideLabel: true,
           value: '@USER .pxCreateOperator',
           placeholder: 'Select...',
           displayMode: 'STACKED_LARGE_VAL',
@@ -160,7 +164,6 @@ export const pyReviewResolved = {
       config: {
         value: 'New',
         label: 'Work Status',
-        displayMode: 'STACKED_LARGE_VAL',
         displayAsStatus: true
       }
     },
@@ -168,16 +171,14 @@ export const pyReviewResolved = {
       type: 'TextInput',
       config: {
         value: 'M-1002',
-        label: 'Case ID',
-        displayMode: 'STACKED_LARGE_VAL'
+        label: 'Case ID'
       }
     },
     {
       type: 'DateTime',
       config: {
         value: '2022-12-11T20:06:27.232Z',
-        label: 'Create date/time',
-        displayMode: 'STACKED_LARGE_VAL'
+        label: 'Create date/time'
       }
     },
     {
@@ -188,8 +189,7 @@ export const pyReviewResolved = {
           userId: 'conns',
           userName: 'Sara Connor'
         },
-        placeholder: 'Select...',
-        displayMode: 'STACKED_LARGE_VAL'
+        placeholder: 'Select...'
       }
     }
   ],
@@ -199,22 +199,25 @@ export const pyReviewResolved = {
 export const regionChildrenResolved = [
   {
     readOnly: true,
-    value: '',
+    value: 'Deadline',
     label: 'SLA Deadline',
+    hideLabel: true,
     displayMode: 'LABELS_LEFT',
     key: 'SLA Deadline'
   },
   {
     readOnly: true,
-    value: '',
+    value: 'Goal',
     label: 'SLA Goal',
+    hideLabel: true,
     displayMode: 'LABELS_LEFT',
     key: 'SLA Goal'
   },
   {
     readOnly: true,
-    value: '',
+    value: 'Start Time',
     label: 'SLA Start Time',
+    hideLabel: true,
     listType: 'associated',
     datasource: [
       {
@@ -230,3 +233,58 @@ export const regionChildrenResolved = [
     key: 'SLA Start Time'
   }
 ];
+
+export const operatorDetails = {
+  data: {
+    pzLoadTime: 'January 18, 2023 10:33:19 AM EST',
+    pzPageNameHash: '_pa1519192551088960pz',
+    pyOperatorInfo: {
+      pyUserName: 'french DigV2',
+      pyPosition: '',
+      pyImageInsKey: '',
+      pySkills: [
+        {
+          pySkillName: '',
+          pzIndexOwnerKey: 'DATA-ADMIN-OPERATOR-ID FRENCHTEST.DIGV2',
+          pySkillRating: 0
+        }
+      ],
+      pyReportToUserName: '',
+      pyReportTo: '',
+      pyOrganization: 'DXIL',
+      pyTitle: '',
+      pyLabel: 'frenchTest.DigV2',
+      pyEmailAddress: 'User@DigV2',
+      pyTelephone: ''
+    }
+  },
+  status: 200,
+  statusText: '',
+  headers: {
+    'content-length': '435',
+    'content-type': 'application/json;charset=UTF-8'
+  },
+  request: {}
+};
+
+export const configProps = {
+  label: 'Create operator',
+  createLabel: 'Created',
+  updateLabel: 'Updated',
+  updateDateTime: '2023-01-16T14:53:33.280Z',
+  createDateTime: '2023-01-16T14:53:33.198Z',
+  updateOperator: {
+    userId: 'admin@mediaco',
+    userName: 'admin'
+  },
+  createOperator: {
+    userId: 'admin@mediaco',
+    userName: 'admin'
+  },
+  resolveLabel: '',
+  resolveOperator: '',
+  resolveDateTime: '',
+  hideLabel: true,
+  key: '_532zx1dah',
+  displayMode: 'LABELS_LEFT'
+};

package/src/tasks/create/templates/Constellation/template/DETAILS-region/styles.ts.mustache

@@ -1,15 +1,23 @@
+// individual style, comment out above, and uncomment here and add styles
+import styled, { css } from 'styled-components';
 
-// utilizing theming, comment out, if want individual style
-import styled from 'styled-components';
-import { Configuration } from '@pega/cosmos-react-core';
+export default styled.div(() => {
+  return css`
+    margin: 0px 0;
+  `;
+});
 
-export default styled(Configuration)``;
+export const StyledDetailsGridContainer = styled.div(() => {
+  return css`
+    margin-line-start: 1;
+  `;
+});
 
-// 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;
-//  `;
-// });
+export const StyledHighlightedFieldsHrLine = styled.hr(() => {
+  return css`
+    line: {
+      margin: '0.75rem 0';
+      opacity: '50%'
+    }
+  `;
+});

package/src/tasks/create/templates/Constellation/template/DETAILS-region/{utils.js.mustache → utils.ts.mustache}

@@ -3,7 +3,7 @@
  * 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 [];
@@ -11,15 +11,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';
@@ -39,7 +39,7 @@ export function getAllFields(pConnect) {
 
 
 
-export function getFilteredFields(getPConnect) {
+export function getFilteredFields(getPConnect: Function) {
   let primaryFieldsRaw;
   let secondaryFieldsRaw;
   const metadata = getPConnect().getRawMetadata();
@@ -52,12 +52,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';
   });
@@ -70,7 +70,7 @@ export function getFilteredFields(getPConnect) {
  * @param {object[]} regionData template children item.
  * @returns {object[]} ConfigurableLayout content.
  */
-export function getLayoutDataFromRegion(regionData) {
+export function getLayoutDataFromRegion(regionData: any) {
   const defaultLayoutConfig = {
     width: 'full',
     fillAvailable: true,
@@ -80,7 +80,7 @@ export function getLayoutDataFromRegion(regionData) {
   return regionData.props
     ?.getPConnect()
     ?.getChildren()
-    ?.map((item, index) => {
+    ?.map((item: any, index: any) => {
       const itemPConnect = item?.getPConnect();
 
       return {
@@ -98,15 +98,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;
@@ -117,7 +120,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 = 'casestep') {
+  // @ts-ignore
   const caseStepInstructions = pConnect.getValue(PCore.getConstants().CASE_INFO.INSTRUCTIONS);
 
   // Determine if this view is the current assignment/step view
@@ -135,9 +139,7 @@ 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;
   }