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

package/tests/assets/sdk-r/components/createAll/custom-constellation/template/Pega_DXIL_MyTwoColumnDetails/mock.ts

@@ -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/tests/assets/sdk-r/components/createAll/custom-constellation/template/Pega_DXIL_MyTwoColumnDetails/styles.ts

@@ -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/tests/assets/sdk-r/components/createAll/custom-constellation/template/Pega_DXIL_MyTwoColumnDetails/{utils.js → utils.ts}

@@ -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;
   }
 

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

@@ -0,0 +1,59 @@
+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) => {
+    const { type } = value.getPConnect().getRawMetadata();
+    const { hideLabel, variant, testId, label } = value
+      .getPConnect()
+      .resolveConfigProps(value.getPConnect().getConfigProps());
+
+    let displayComp;
+    const key = JSON.stringify(value.getPConnect());
+
+    if (type === 'reference') {
+      const refElement = value.getPConnect().getComponent();
+
+      displayCompArr.push(refElement);
+    } else {
+      const element = value.getPConnect().getComponent();
+      const displayEl = <Fragment key={key}>{element}</Fragment>;
+
+      const fvlStyle = {
+        myColGap: {
+          columnGap: '0',
+          marginLineStart: 0
+        }
+      };
+
+      // const myEl = <div>boo</div>;
+      displayComp = (
+        <Fragment key={key}>
+          <FieldValueList
+            style={fvlStyle.myColGap}
+            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_MyTwoColumnForm/demo.stories.tsx

@@ -2,21 +2,27 @@
 
 // @ts-nocheck
 import { useState } from 'react';
-import { withKnobs } from '@storybook/addon-knobs';
+import type { Meta, StoryObj } from '@storybook/react';
 
 import PegaDxilMyTwoColumnForm from './index';
 import { DateInput, Input, FieldValueList, Text } from '@pega/cosmos-react-core';
 import { PhoneInput as CosmosPhone } from '@pega/cosmos-react-core';
 import { pyReviewRaw, regionChildrenResolved } from './mock';
 
-export default {
+const meta: Meta<typeof PegaDxilMyTwoColumnForm> = {
   title: 'PegaDxilMyTwoColumnForm',
-  decorators: [withKnobs],
-  component: PegaDxilMyTwoColumnForm
+  component: PegaDxilMyTwoColumnForm,
+  excludeStories: /.*Data$/,
+  parameters: {
+    type: 'TwoColumnForm'
+  }
 };
 
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyTwoColumnForm>;
+
 const renderField = resolvedProps => {
-  const { displayMode, value = '', label = '', key } = resolvedProps;
+  const { displayMode, value = '', label = '', key, readOnly } = resolvedProps;
 
   // eslint-disable-next-line react-hooks/rules-of-hooks
   const [inputValue, setInputValue] = useState(value);
@@ -122,6 +128,30 @@ const renderField = resolvedProps => {
       </Text>
     );
   }
+  if (readOnly) {
+    return {
+      getPConnect: () => {
+        return {
+          getRawMetadata: () => {
+            return {};
+          },
+          resolveConfigProps: props => {
+            return props;
+          },
+          getConfigProps: () => {
+            return {
+              value: '',
+              label,
+              displayMode: 'LABELS_LEFT'
+            };
+          },
+          getComponent: () => {
+            return val;
+          }
+        };
+      }
+    };
+  }
   return (
     <FieldValueList
       variant={variant}
@@ -134,9 +164,11 @@ const renderField = resolvedProps => {
   );
 };
 
-export const BasePegaDxilMyTwoColumnForm = () => {
+export const BasePegaDxilMyTwoColumnForm: Story = args => {
+  const { readOnly } = args;
+
   const props = {
-    template: 'DefaultForm',
+    readOnly,
     getPConnect: () => {
       return {
         getChildren: () => {
@@ -149,34 +181,92 @@ export const BasePegaDxilMyTwoColumnForm = () => {
           // eslint-disable-next-line default-case
           switch (config.config.value) {
             case '@P .FirstName':
-              return renderField(regionChildrenResolved[0]);
+              return renderField({
+                ...regionChildrenResolved[0],
+                readOnly,
+                displayMode: readOnly ? 'LABELS_LEFT' : ''
+              });
             case '@P .MiddleName':
-              return renderField(regionChildrenResolved[1]);
+              return renderField({
+                ...regionChildrenResolved[1],
+                readOnly,
+                displayMode: readOnly ? 'LABELS_LEFT' : ''
+              });
             case '@P .LastName':
-              return renderField(regionChildrenResolved[2]);
+              return renderField({
+                ...regionChildrenResolved[2],
+                readOnly,
+                displayMode: readOnly ? 'LABELS_LEFT' : ''
+              });
             case '@P .Email':
-              return renderField(regionChildrenResolved[3]);
+              return renderField({
+                ...regionChildrenResolved[3],
+                readOnly,
+                displayMode: readOnly ? 'LABELS_LEFT' : ''
+              });
             case '@P .PhoneNumber':
-              return renderField(regionChildrenResolved[4]);
+              return renderField({
+                ...regionChildrenResolved[4],
+                readOnly,
+                displayMode: readOnly ? 'LABELS_LEFT' : ''
+              });
             case '@P .ServiceDate':
-              return renderField(regionChildrenResolved[5]);
+              return renderField({
+                ...regionChildrenResolved[5],
+                readOnly,
+                displayMode: readOnly ? 'LABELS_LEFT' : ''
+              });
           }
         }
       };
     }
   };
 
-  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);
-  });
+  const regionAChildren = readOnly
+    ? {
+        props: {
+          getPConnect: () => {
+            return {
+              getChildren: () => {
+                return pyReviewRaw.children[0].children.map(child => {
+                  return props.getPConnect().createComponent(child);
+                });
+              }
+            };
+          }
+        }
+      }
+    : pyReviewRaw.children[0].children.map(child => {
+        return props.getPConnect().createComponent(child);
+      });
+
+  const regionBChildren = readOnly
+    ? {
+        props: {
+          getPConnect: () => {
+            return {
+              getChildren: () => {
+                return pyReviewRaw.children[1].children.map(child => {
+                  return props.getPConnect().createComponent(child);
+                });
+              }
+            };
+          }
+        }
+      }
+    : pyReviewRaw.children[1].children.map(child => {
+        return props.getPConnect().createComponent(child);
+      });
 
   return (
-    <PegaDxilMyTwoColumnForm {...props}>
-      {regionAChildren}
-      {regionBChildren}
+    <PegaDxilMyTwoColumnForm {...props} {...args}>
+      {[regionAChildren, regionBChildren]}
     </PegaDxilMyTwoColumnForm>
   );
 };
+
+BasePegaDxilMyTwoColumnForm.args = {
+  readOnly: false,
+  showLabel: true,
+  label: 'Form Region template',
+};

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

@@ -1,7 +1,7 @@
-import { Grid, Flex, FieldGroup } from '@pega/cosmos-react-core';
-import PropTypes from 'prop-types';
+import { Grid, Flex, FieldGroup, withConfiguration } from '@pega/cosmos-react-core';
 
 import type { PConnFieldProps } from './PConnProps';
+import DetailsRender from './DetailsRender';
 
 import StyledPegaDxilMyTwoColumnFormWrapper from './styles';
 
@@ -12,19 +12,17 @@ interface PegaDxilMyTwoColumnFormProps extends PConnFieldProps {
   children: 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
-export default function PegaDxilMyTwoColumnForm(props: PegaDxilMyTwoColumnFormProps) {
+function PegaDxilMyTwoColumnForm(props: PegaDxilMyTwoColumnFormProps) {
 
 
-  const { children, label, showLabel, getPConnect } = props;
+  const { children = [], label, showLabel, getPConnect, readOnly, displayMode  } = props;
   const propsToUse = { label, showLabel, ...getPConnect().getInheritedProps() };
 
   const numRegions = children?.length;
   const gridRepeat = "repeat(".concat(numRegions).concat(", 1fr)");
-  const gridContainer = {"colGap" : 1};
+  const gridContainer = {"colGap" : 6};
   // @ts-ignore
   gridContainer.cols = gridRepeat;
   // @ts-ignore
@@ -34,6 +32,26 @@ export default function PegaDxilMyTwoColumnForm(props: PegaDxilMyTwoColumnFormPr
   // @ts-ignore
   flexContainer.gap = 2;
 
+  if (readOnly && readOnly === true || displayMode && displayMode === 'DISPLAY_ONLY') {
+    return (
+      <StyledPegaDxilMyTwoColumnFormWrapper>
+        <FieldGroup name={propsToUse.showLabel ? propsToUse.label : ''}>
+          <Grid container={gridContainer} data-testid={`column-count-${numRegions}`}>
+            {children.map((child: any, i: number) => (
+              <Flex
+                // @ts-ignore
+                container={{ direction: 'column', alignItems: 'normal', colGap: 1, rowGap: 1.5 }}
+                key={`r-${i + 1}`}
+              >
+                <DetailsRender child={child} />
+              </Flex>
+            ))}
+          </Grid>
+        </FieldGroup>
+      </StyledPegaDxilMyTwoColumnFormWrapper>
+    );
+  }
+
   return (
     <StyledPegaDxilMyTwoColumnFormWrapper>
       <FieldGroup name={propsToUse.showLabel ? propsToUse.label : ''}>
@@ -51,10 +69,5 @@ export default function PegaDxilMyTwoColumnForm(props: PegaDxilMyTwoColumnFormPr
 
 }
 
-PegaDxilMyTwoColumnForm.defaultProps = {
-  children: []
-};
 
-PegaDxilMyTwoColumnForm.propTypes = {
-  children: PropTypes.arrayOf(PropTypes.node),
-};
+export default withConfiguration(PegaDxilMyTwoColumnForm);

package/tests/assets/sdk-r/components/createAll/custom-constellation/template/Pega_DXIL_MyTwoColumnForm/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/widget/Pega_DXIL_MyCaseWidget/demo.stories.tsx

@@ -1,18 +1,21 @@
 
 /* eslint-disable react/jsx-no-useless-fragment */
 // @ts-nocheck
-import { withKnobs } from '@storybook/addon-knobs';
+import type { Meta, StoryObj } from '@storybook/react';
 
 import PegaDxilMyCaseWidget from './index';
 
 import historyData from './mock';
 
-export default {
+const meta: Meta<typeof PegaDxilMyCaseWidget> = {
   title: 'PegaDxilMyCaseWidget',
-  decorators: [withKnobs],
-  component: PegaDxilMyCaseWidget
+  component: PegaDxilMyCaseWidget,
+  excludeStories: /.*Data$/
 };
 
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyCaseWidget>;
+
 if (!window.PCore) {
   window.PCore = {};
 }
@@ -43,10 +46,9 @@ window.PCore.getDataApiUtils = () => {
   };
 };
 
-export const BasePegaDxilMyCaseWidget = () => {
+export const BasePegaDxilMyCaseWidget: Story = args => {
 
   const props = {
-    label: 'Case history',
 
     getPConnect: () => {
       return {
@@ -75,7 +77,11 @@ export const BasePegaDxilMyCaseWidget = () => {
 
 return (
     <>
-      <PegaDxilMyCaseWidget {...props} />
+      <PegaDxilMyCaseWidget {...props} {...args} />
     </>
   );
 };
+
+BasePegaDxilMyCaseWidget.args = {
+  label: 'Case history',
+};