@pega/custom-dx-components 0.24.13 → 0.24.15

package/src/tasks/create/templates/Launchpad/Widget/PAGE/index.tsx.mustache

@@ -21,7 +21,11 @@ function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
 
   const { header, description, datasource = [], whatsnewlink, image, getPConnect } = props;
   const [worklist, setWorklist] = useState([]);
+  const [isLoading, setIsLoading] = useState(true);
   const PConnect = getPConnect();
+  const dataViewName = 'MyWorkList';
+  const context = PConnect.getContextName();
+
   let details = [];
   // @ts-ignore
   if (datasource && datasource.source) {
@@ -44,33 +48,41 @@ function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
   // get data from a data page and a PConnect function
   // to get getContextName
   useEffect(() => {
-    const dataViewName = 'MyWorkList';
-    const context = PConnect.getContextName();
 
-    PCore.getDataPageUtils()
-      .getDataAsync(dataViewName, context, {}, null, null)
+    PCore.getDataApiUtils()
+      .getData(dataViewName, {}, context)
       // @ts-ignore
       .then((response: any) => {
-        // table requires an index or will get setExtraStackFrame error
-        setWorklist(
-          response.data.map((entry: any, index: number) => {
-            // mapping the data into the column names
-            // MUST have an id/index or will get a setExtraStackFrame error
-            // put a key in the table
-            return {
-              caseType: entry.CaseName,
-              insKey: entry.BusinessID,
-              status: entry.ProcessName,
-              stage: entry.TaskName,
-              id: index
-            };
-          })
-        );
+        setIsLoading(false);
+        if (response.data.data !== null) {
+          // table requires an index or will get setExtraStackFrame error
+          setWorklist(
+            response.data.data.map((entry: any, index: number) => {
+              // mapping the data into the column names
+              // MUST have an id/index or will get a setExtraStackFrame error
+              // put a key in the table
+              return {
+                caseType: entry.CaseName,
+                insKey: entry.BusinessID,
+                status: entry.ProcessName,
+                stage: entry.TaskName,
+                id: index
+              };
+            })
+          );
+        }
+        else {
+          setWorklist([]);
+          setIsLoading(false);
+        }
+
       })
       .catch((error: any) => {
+        setWorklist([]);
+        setIsLoading(false);
         console.log(error);
       });
-  }, [PConnect]);
+  }, [context]);
 
   return (
     <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
@@ -86,6 +98,8 @@ function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
       title={PConnect.getLocalizedValue('Work list', '', '')}
       columns={columns}
       data={worklist}
+      loading={isLoading}
+      loadingMessage={PConnect.getLocalizedValue('Loading Work list', '', '')}
     />
     </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
   );

package/src/tasks/init/template/package.json.mustache

@@ -69,7 +69,7 @@
   },
   "devDependencies": {
     "@pega/configs": "^0.6.0",
-    "@pega/custom-dx-components": "0.24.13",
+    "@pega/custom-dx-components": "0.24.15",
     "@pega/pcore-pconnect-typedefs": "~3.0.0",
     "@storybook/addon-actions": "^7.6.7",
     "@storybook/addon-essentials": "^7.6.7",

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDetails/demo.stories.tsx

@@ -24,6 +24,7 @@ const Region = props => {
   return <></>;
 };
 
+
 const renderField = resolvedProps => {
   const {
     displayAsStatus = false,

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDetails/mock.ts

@@ -1,5 +1,4 @@
 
-
 // @ts-nocheck
 export const pyReviewRaw = {
   name: 'pyReview',
@@ -17,7 +16,7 @@ export const pyReviewRaw = {
         config: {
           value: '@P .pyStatusWork',
           label: '@L Work Status',
-          hideLabel: false,
+          hideLabel: true,
           displayMode: 'STACKED_LARGE_VAL',
           displayAsStatus: true,
           key: 'pyStatusWork'
@@ -28,7 +27,7 @@ export const pyReviewRaw = {
         config: {
           value: '@P .pyID',
           label: '@L Case ID',
-          hideLabel: false,
+          hideLabel: true,
           displayMode: 'STACKED_LARGE_VAL',
           key: 'pyID'
         }
@@ -38,7 +37,7 @@ export const pyReviewRaw = {
         config: {
           value: '@P .pxCreateDateTime',
           label: '@L Create date/time',
-          hideLabel: false,
+          hideLabel: true,
           displayMode: 'STACKED_LARGE_VAL',
           key: 'pxCreateDateTime'
         }
@@ -47,7 +46,7 @@ export const pyReviewRaw = {
         type: 'UserReference',
         config: {
           label: '@L Create Operator',
-          hideLabel: false,
+          hideLabel: true,
           value: '@USER .pxCreateOperator',
           placeholder: 'Select...',
           displayMode: 'STACKED_LARGE_VAL',
@@ -70,6 +69,7 @@ export const pyReviewRaw = {
     {
       name: 'A',
       type: 'Region',
+      key: 'A',
       getPConnect: () => {
         return {
           getRawMetadata: () => {
@@ -82,17 +82,17 @@ export const pyReviewRaw = {
           type: 'DateTime',
           config: {
             value: '@P .pySLADeadline',
-            label: '@L SLA Deadline'
-          },
-          key: '1'
+            label: '@L SLA Deadline',
+            key: 'pySLADeadline'
+          }
         },
         {
           type: 'DateTime',
           config: {
             value: '@P .pySLAGoal',
-            label: '@L SLA Goal'
-          },
-          key: '2'
+            label: '@L SLA Goal',
+            key: 'pySLAGoal'
+          }
         },
         {
           type: 'RadioButtons',
@@ -100,9 +100,9 @@ export const pyReviewRaw = {
             value: '@P .pySLAStartTime',
             label: '@L SLA Start Time',
             listType: 'associated',
-            datasource: '@ASSOCIATED .pySLAStartTime'
-          },
-          key: '3'
+            datasource: '@ASSOCIATED .pySLAStartTime',
+            key: 'pySLAStartTime'
+          }
         }
       ]
     }
@@ -124,7 +124,6 @@ export const pyReviewResolved = {
       config: {
         value: 'New',
         label: 'Work Status',
-        displayMode: 'STACKED_LARGE_VAL',
         displayAsStatus: true
       }
     },
@@ -132,16 +131,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'
       }
     },
     {
@@ -152,8 +149,7 @@ export const pyReviewResolved = {
           userId: 'conns',
           userName: 'Sara Connor'
         },
-        placeholder: 'Select...',
-        displayMode: 'STACKED_LARGE_VAL'
+        placeholder: 'Select...'
       }
     }
   ],
@@ -163,22 +159,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: [
       {

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyIconButtonURL/demo.stories.tsx

@@ -38,6 +38,11 @@ const statelistData = {
 
 window.PCore.getDataPageUtils = () => {
   return {
+    getData: () => {
+      return new Promise(resolve => {
+        resolve(statelistData);
+      });
+    },
     getDataAsync: () => {
       return new Promise(resolve => {
         resolve(statelistData);

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyIconButtonURL/index.tsx

@@ -65,8 +65,11 @@ function PegaDxilMyIconButtonUrl(props: PegaDxilMyIconButtonUrlProps) {
   const { value, displayMode, countryCode = 'USA', getPConnect, testId } = props;
   const [statelist, setStatelist] = useState([]);
   const [showTable, setShowTable] = useState(false);
+  const [isLoading, setIsLoading] = useState(true);
   const [validUrl, setValidUrl] = useState('about:blank');
   const PConnect = getPConnect();
+  const dataViewName = 'D_pyStateList';
+  const context = PConnect.getContextName();
 
   // IMPORTANT: need to register icons used in camel case
   registerIcon(listNumber, arrowRight, globe);
@@ -111,8 +114,6 @@ function PegaDxilMyIconButtonUrl(props: PegaDxilMyIconButtonUrlProps) {
   // get data from a data page and a PConnect function
   // to get getContextName
   useEffect(() => {
-    const dataViewName = 'D_pyStateList';
-    const context = PConnect.getContextName();
     const params = { pyCountry: countryCode };
 
     // only retrieve table data if table is shown
@@ -121,25 +122,33 @@ function PegaDxilMyIconButtonUrl(props: PegaDxilMyIconButtonUrlProps) {
         .getDataAsync(dataViewName, context, params, null, null)
         // @ts-ignore
         .then((response: any) => {
+          setIsLoading(false);
           // table requires an index or will get setExtraStackFrame error
-          setStatelist(
-            response.data.map((entry: any, index: number) => {
-              // mapping the data into the column names
-              // MUST have an id/index or will get a setExtraStackFrame error
-              // put a key in the table
-              return {
-                stateName: entry.pyLabel,
-                stateCode: entry.pyStateCode,
-                id: index
-              };
-            })
-          );
+          if (response.data !== null) {
+            setStatelist(
+              response.data.map((entry: any, index: number) => {
+                // mapping the data into the column names
+                // MUST have an id/index or will get a setExtraStackFrame error
+                // put a key in the table
+                return {
+                  stateName: entry.pyLabel,
+                  stateCode: entry.pyStateCode,
+                  id: index
+                };
+              })
+            );
+          } else {
+            setStatelist([]);
+            setIsLoading(false);
+          }
         })
         .catch((error: any) => {
+          setStatelist([]);
+          setIsLoading(false);
           console.log(error);
         });
     }
-  }, [PConnect, countryCode, showTable]);
+  }, [context, countryCode, showTable]);
 
   // when DISPLAY_ONLY, in this example we will just show the URL.
   if (displayMode === 'DISPLAY_ONLY') {
@@ -194,6 +203,8 @@ function PegaDxilMyIconButtonUrl(props: PegaDxilMyIconButtonUrlProps) {
           title={PConnect.getLocalizedValue('State list', '', '')}
           columns={columns}
           data={statelist}
+          loading={isLoading}
+          loadingMessage={PConnect.getLocalizedValue('Loading state list', '', '')}
         />
       )}
     </StyledPegaDxilMyIconButtonUrlWrapper>

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

@@ -22,30 +22,37 @@ if (!window.PCore) {
 }
 
 const worklistData = {
-  data: [
-    {
-      pxProcessName: 'Loan',
-      pxRefObjectInsName: ' A-8002',
-      pyAssignmentStatus: 'New',
-      pxTaskLabel: 'Details'
-    },
-    {
-      pxProcessName: 'Loan',
-      pxRefObjectInsName: ' A-7001',
-      pyAssignmentStatus: 'Open',
-      pxTaskLabel: 'Info'
-    },
-    {
-      pxProcessName: 'Loan',
-      pxRefObjectInsName: ' A-9000',
-      pyAssignmentStatus: 'Open',
-      pxTaskLabel: 'Amount'
-    }
-  ]
+  data: {
+    data: [
+      {
+        pxProcessName: 'Loan',
+        pxRefObjectInsName: ' A-8002',
+        pyAssignmentStatus: 'New',
+        pxTaskLabel: 'Details'
+      },
+      {
+        pxProcessName: 'Loan',
+        pxRefObjectInsName: ' A-7001',
+        pyAssignmentStatus: 'Open',
+        pxTaskLabel: 'Info'
+      },
+      {
+        pxProcessName: 'Loan',
+        pxRefObjectInsName: ' A-9000',
+        pyAssignmentStatus: 'Open',
+        pxTaskLabel: 'Amount'
+      }
+    ]
+  }
 };
 
-window.PCore.getDataPageUtils = () => {
+window.PCore.getDataApiUtils = () => {
   return {
+    getData: () => {
+      return new Promise(resolve => {
+        resolve(worklistData);
+      });
+    },
     getDataAsync: () => {
       return new Promise(resolve => {
         resolve(worklistData);
@@ -59,7 +66,7 @@ window.PCore.getDataPageUtils = () => {
 export const BasePegaDxilMyPageWidget: Story = args => {
 
   const props = {
-    image: configProps.image,
+    ...configProps,
     getPConnect: () => {
       return {
         getValue: value => {

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyPageWidget/index.tsx

@@ -21,7 +21,11 @@ function PegaDxilMyPageWidget(props: PegaDxilMyPageWidgetProps) {
 
   const { header, description, datasource = [], whatsnewlink, image, getPConnect } = props;
   const [worklist, setWorklist] = useState([]);
+  const [isLoading, setIsLoading] = useState(true);
   const PConnect = getPConnect();
+  const dataViewName = 'D_pyMyWorkList';
+  const context = PConnect.getContextName();
+
   let details = [];
   // @ts-ignore
   if (datasource && datasource.source) {
@@ -44,33 +48,41 @@ function PegaDxilMyPageWidget(props: PegaDxilMyPageWidgetProps) {
   // get data from a data page and a PConnect function
   // to get getContextName
   useEffect(() => {
-    const dataViewName = 'D_pyMyWorkList';
-    const context = PConnect.getContextName();
 
-    PCore.getDataPageUtils()
-      .getDataAsync(dataViewName, context, {}, null, null)
+    PCore.getDataApiUtils()
+      .getData(dataViewName, {}, context)
       // @ts-ignore
       .then((response: any) => {
-        // table requires an index or will get setExtraStackFrame error
-        setWorklist(
-          response.data.map((entry: any, index: number) => {
-            // mapping the data into the column names
-            // MUST have an id/index or will get a setExtraStackFrame error
-            // put a key in the table
-            return {
-              caseType: entry.pxProcessName,
-              insKey: entry.pxRefObjectInsName,
-              status: entry.pyAssignmentStatus,
-              stage: entry.pxTaskLabel,
-              id: index
-            };
-          })
-        );
+        setIsLoading(false);
+        if (response.data.data !== null) {
+          // table requires an index or will get setExtraStackFrame error
+          setWorklist(
+            response.data.data.map((entry: any, index: number) => {
+              // mapping the data into the column names
+              // MUST have an id/index or will get a setExtraStackFrame error
+              // put a key in the table
+              return {
+                caseType: entry.pxProcessName,
+                insKey: entry.pxRefObjectInsName,
+                status: entry.pyAssignmentStatus,
+                stage: entry.pxTaskLabel,
+                id: index
+              };
+            })
+          );
+        }
+        else {
+          setWorklist([]);
+          setIsLoading(false);
+        }
+
       })
       .catch((error: any) => {
+        setWorklist([]);
+        setIsLoading(false);
         console.log(error);
       });
-  }, [PConnect]);
+  }, [context]);
 
   return (
     <StyledPegaDxilMyPageWidgetWrapper>
@@ -86,6 +98,8 @@ function PegaDxilMyPageWidget(props: PegaDxilMyPageWidgetProps) {
       title={PConnect.getLocalizedValue('Work list', '', '')}
       columns={columns}
       data={worklist}
+      loading={isLoading}
+      loadingMessage={PConnect.getLocalizedValue('Loading Work list', '', '')}
     />
     </StyledPegaDxilMyPageWidgetWrapper>
   );

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyTwoColumnDetails/mock.ts

@@ -16,7 +16,7 @@ export const pyReviewRaw = {
         config: {
           value: '@P .pyStatusWork',
           label: '@L Work Status',
-          hideLabel: false,
+          hideLabel: true,
           displayMode: 'STACKED_LARGE_VAL',
           displayAsStatus: true,
           key: 'pyStatusWork'
@@ -27,7 +27,7 @@ export const pyReviewRaw = {
         config: {
           value: '@P .pyID',
           label: '@L Case ID',
-          hideLabel: false,
+          hideLabel: true,
           displayMode: 'STACKED_LARGE_VAL',
           key: 'pyID'
         }
@@ -37,7 +37,7 @@ export const pyReviewRaw = {
         config: {
           value: '@P .pxCreateDateTime',
           label: '@L Create date/time',
-          hideLabel: false,
+          hideLabel: true,
           displayMode: 'STACKED_LARGE_VAL',
           key: 'pxCreateDateTime'
         }
@@ -46,7 +46,7 @@ export const pyReviewRaw = {
         type: 'UserReference',
         config: {
           label: '@L Create Operator',
-          hideLabel: false,
+          hideLabel: true,
           value: '@USER .pxCreateOperator',
           placeholder: 'Select...',
           displayMode: 'STACKED_LARGE_VAL',
@@ -164,7 +164,6 @@ export const pyReviewResolved = {
       config: {
         value: 'New',
         label: 'Work Status',
-        displayMode: 'STACKED_LARGE_VAL',
         displayAsStatus: true
       }
     },
@@ -172,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'
       }
     },
     {
@@ -192,8 +189,7 @@ export const pyReviewResolved = {
           userId: 'conns',
           userName: 'Sara Connor'
         },
-        placeholder: 'Select...',
-        displayMode: 'STACKED_LARGE_VAL'
+        placeholder: 'Select...'
       }
     }
   ],
@@ -203,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: [
       {

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

@@ -24,6 +24,7 @@ const Region = props => {
   return <></>;
 };
 
+
 const renderField = resolvedProps => {
   const {
     displayAsStatus = false,