@pega/custom-dx-components 23.1.13 → 24.1.11

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

@@ -0,0 +1,215 @@
+import { useEffect, useState } from 'react';
+import {
+  Icon,
+  Button,
+  withConfiguration,
+  registerIcon,
+  Table,
+  Label,
+  Link,
+  URLDisplay
+} from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
+
+// IMPORTANT
+// To use Icons, need to individually import the icon file form @pega/cosmos-react-core (see path below)
+// Icons filename is kabab case (file-name), where as the icon you import is camel case (fileName)
+// Icons need to be registered (camel case), and then used (kabab case)
+import * as listNumber from '@pega/cosmos-react-core/lib/components/Icon/icons/list-number.icon';
+import * as arrowRight from '@pega/cosmos-react-core/lib/components/Icon/icons/arrow-right.icon';
+import * as globe from '@pega/cosmos-react-core/lib/components/Icon/icons/globe.icon';
+
+import StyledPegaDxilMyIconButtonUrlWrapper from './styles';
+
+// interface for props
+interface PegaDxilMyIconButtonUrlProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  countryCode: string;
+}
+
+export const textFormatter = (value: string) => {
+  const displayComponent = (
+    <URLDisplay target='_blank' value={value} displayText={value} variant='link' />
+  );
+
+  return displayComponent;
+};
+
+// *************
+// This component is meant to be an example of usage (Icon, Button, Link, etc.) and NOT meant to be
+// used "as is"
+//
+// In this example, Icon is shown on its own and inside a Button
+// Though an Icon can have an "onClick" event is it recommended if you want to click on it,
+// to put it in a Button (shown below), so you can have a tooltip and hover style or put it
+// in a Link (shown below) as a URL.
+//
+// For the button, the click will get a list of states for a given country and display in a
+// table below.  The table display will toggle with the click of the button icon. Example shows
+// how to handle click, retrieve data from PCore and display it.
+//
+// Globe icon is an icon placed in a Link element. The Link element to use an icon internally.  (NOTE: In general
+// the Link element shows the open icon to the left of the link text, but here we are using
+// another icon, so with "icon" specified in the Link element, the open icon doesn't show)
+// Link elements do not handle bad urls well, so we have a simple validator to prevent the Link element
+// from getting most bad urls.
+//
+// NOTE: because icons have to be imported and registered, you can NOT put the icon name
+// inside the config.json and let the user pick it, if it is not already part of your
+// import and registration (can't be done on the fly)
+// **************
+
+// 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
+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);
+
+
+   // setting up columns for the work list table
+  const columns = [
+    { renderer: 'stateName', label: PConnect.getLocalizedValue('State name', '', '') },
+    { renderer: 'stateCode', label: PConnect.getLocalizedValue('State code', '', '') }
+  ];
+
+  // toggle showing table and getting table data
+  function showHideTable() {
+    setShowTable(prevShowTable => !prevShowTable);
+  }
+
+  // check if url is valid (simple)
+  function validateUrl(href: string) {
+    return /^(?:(?:(?:https?|ftp):)?\/\/)(?:\S+(?::\S*)?@)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)(?:\.(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)*(?:\.(?:[a-z\u00a1-\uffff]{2,})))(?::\d{2,5})?(?:[/?#]\S*)?$/i.test(
+      href
+    );
+  }
+
+  // Testing to see if value entered is valid url, if not can't use it.
+  // Reason for this code is that you can NOT pass to Link component
+  // a bad url, or it will error out.
+  // For example: Since the value is the property field,
+  // it could be entered from another component and thus as it is
+  // entered (typed in), it won't be valid until it is all entered.
+  // NOTE: can't have a blank value for the url as the Link element will error out
+  // in App studio preview
+  useEffect(() => {
+    if (validateUrl(value)) {
+      setValidUrl(value);
+    } else {
+      setValidUrl('about:blank');
+    }
+  }, [value]);
+
+  // going to get data for worklist to put into a table
+  // data comes from calling a PCore function to get
+  // get data from a data page and a PConnect function
+  // to get getContextName
+  useEffect(() => {
+    const params = { pyCountry: countryCode };
+
+    // only retrieve table data if table is shown
+    if (showTable) {
+      PCore.getDataPageUtils()
+        .getDataAsync(dataViewName, context, params, null, null)
+        // @ts-ignore
+        .then((response: any) => {
+          setIsLoading(false);
+          // table requires an index or will get setExtraStackFrame error
+          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);
+        });
+    }
+  }, [context, countryCode, showTable]);
+
+  // when DISPLAY_ONLY, in this example we will just show the URL.
+  if (displayMode === 'DISPLAY_ONLY') {
+    const displayComp = textFormatter(validUrl);
+    return (
+      <StyledPegaDxilMyIconButtonUrlWrapper> {displayComp} </StyledPegaDxilMyIconButtonUrlWrapper>
+    );
+  }
+
+  return (
+    <StyledPegaDxilMyIconButtonUrlWrapper>
+    <div style={{ display: 'flex' }} data-testid={testId}>
+      <Icon
+        style={{ height: '1.5rem', width: '1.5rem' }}
+        // icon name is kabab case
+        name='arrow-right'
+        role='img'
+        aria-label='arrow right'
+      />
+      <Label style={{ margin: '0.1rem' }}>
+        {' '}
+        {PConnect.getLocalizedValue('State list for', '', '')}{' '}
+        {PConnect.getLocalizedValue(`${countryCode}`, '', '')}{' '}
+      </Label>
+      <Button
+        icon
+        label={PConnect.getLocalizedValue('Click to show/hide state list', '', '')}
+        variant='link'
+        compact={false}
+        onClick={showHideTable}
+      >
+        <Icon
+          style={{ height: '1.5rem', width: '1.5rem' }}
+          // icon name is kabab case
+          name='list-number'
+          role='img'
+          aria-label='numbered list'
+        />
+      </Button>
+      <Link href={validUrl} variant='link' label={validUrl} icon>
+        <Icon
+          style={{ height: '1.5rem', width: '1.5rem' }}
+          // icon name is kabab case
+          name='globe'
+          role='img'
+          aria-label='open link'
+        />
+      </Link>
+    </div>
+      {showTable && (
+        <Table
+          title={PConnect.getLocalizedValue('State list', '', '')}
+          columns={columns}
+          data={statelist}
+          loading={isLoading}
+          loadingMessage={PConnect.getLocalizedValue('Loading state list', '', '')}
+        />
+      )}
+    </StyledPegaDxilMyIconButtonUrlWrapper>
+  );
+}
+
+
+export default withConfiguration(PegaDxilMyIconButtonUrl);

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

@@ -0,0 +1,5 @@
+
+// @ts-nocheck
+export const configProps = {
+  countryCode: 'USA'
+};

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyIconButtonURL/styles.ts

@@ -0,0 +1,8 @@
+// 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;
+  `;
+});

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

@@ -19,14 +19,8 @@ export const BasePegaDxilMyInteger: Story = args => {
 
   const props = {
     value: configProps.value,
-    placeholder: configProps.placeholder,
-    label: configProps.label,
-    helperText: configProps.helperText,
-    showGroupSeparators: configProps.showGroupSeparators,
     hasSuggestions: configProps.hasSuggestions,
-    testId: configProps.testId,
     fieldMetadata,
-    validatemessage: '',
     getPConnect: () => {
       return {
         getStateProps: () => {
@@ -56,6 +50,7 @@ export const BasePegaDxilMyInteger: Story = args => {
 BasePegaDxilMyInteger.args = {
   label: configProps.label,
   helperText: configProps.helperText,
+  placeholder: configProps.placeholder,
   showGroupSeparators: configProps.showGroupSeparators,
   testId: configProps.testId,
   readOnly: configProps.readOnly,
@@ -64,5 +59,6 @@ BasePegaDxilMyInteger.args = {
   status: configProps.status,
   hideLabel: configProps.hideLabel,
   displayMode: configProps.displayMode,
+  variant: configProps.variant,
   validatemessage: configProps.validatemessage
 };

package/tests/assets/components/createAll/Constellation/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/components/createAll/Constellation/Pega_DXIL_MyPage/demo.stories.tsx

@@ -35,9 +35,7 @@ export const BasePegaDxilMyPage: Story = args => {
 
   const props = {
     useConfigurableLayout: false,
-    enableGetNextWork: pyHome1Raw.config.enableGetNextWork,
     icon: pyHome1Raw.config.icon,
-    title: 'Page Template',
 
     getPConnect: () => {
       return {
@@ -108,4 +106,7 @@ export const BasePegaDxilMyPage: Story = args => {
   );
 };
 
-BasePegaDxilMyPage.args = {};
+BasePegaDxilMyPage.args = {
+  title: 'Page Template',
+  enableGetNextWork: pyHome1Raw.config.enableGetNextWork,
+};

package/tests/assets/components/createAll/Constellation/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/components/createAll/Constellation/Pega_DXIL_MyPageCaseWidget/demo.stories.tsx

@@ -41,13 +41,10 @@ export const BasePegaDxilMyPageCaseWidget: Story = args => {
 
   const props = {
     label: configProps.label,
-    createLabel: configProps.createLabel,
-    updateLabel: configProps.updateLabel,
     createOperator: configProps.createOperator,
     updateOperator: configProps.updateOperator,
     createDateTime: configProps.createDateTime,
     updateDateTime: configProps.updateDateTime,
-    hideLabel: configProps.hideLabel,
 
     getPConnect: () => {
       return {
@@ -72,4 +69,8 @@ return (
   );
 };
 
-BasePegaDxilMyPageCaseWidget.args = {};
+BasePegaDxilMyPageCaseWidget.args = {
+  createLabel: configProps.createLabel,
+  updateLabel: configProps.updateLabel,
+  hideLabel: configProps.hideLabel
+};

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

@@ -17,25 +17,103 @@ const meta: Meta<typeof PegaDxilMyPageWidget> = {
 export default meta;
 type Story = StoryObj<typeof PegaDxilMyPageWidget>;
 
+if (!window.PCore) {
+  window.PCore = {};
+}
+
+const worklistData = {
+  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.getDataApiUtils = () => {
+  return {
+    getData: () => {
+      return new Promise(resolve => {
+        resolve(worklistData);
+      });
+    },
+    getDataAsync: () => {
+      return new Promise(resolve => {
+        resolve(worklistData);
+      });
+    }
+  };
+};
+
+
+
 export const BasePegaDxilMyPageWidget: Story = args => {
 
   const props = {
-    label: configProps.label,
-    header: configProps.header,
-    description: configProps.description,
-    image: configProps.image,
-    datasource: configProps.datasource,
-    whatsnewlink: configProps.whatsnewlink
-};
+    ...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} {...args} />
-    </>
-  );
+  return (
+      <>
+        <PegaDxilMyPageWidget {...props} {...args} />
+      </>
+    );
 };
 
 BasePegaDxilMyPageWidget.args = {
   header: configProps.header,
-  description: configProps.description
+  description: configProps.description,
+  whatsnewlink: configProps.whatsnewlink,
+  datasource: configProps.datasource,
 };

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

@@ -1,4 +1,5 @@
-import { withConfiguration } from '@pega/cosmos-react-core';
+import { useEffect, useState } from 'react';
+import { withConfiguration, Table } from '@pega/cosmos-react-core';
 import { AppAnnouncement as PegaAppAnnouncement } from '@pega/cosmos-react-work';
 import type { PConnFieldProps } from './PConnProps';
 
@@ -14,14 +15,17 @@ interface PegaDxilMyPageWidgetProps extends PConnFieldProps {
     image: string;
 }
 
-
-// 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
 function PegaDxilMyPageWidget(props: PegaDxilMyPageWidgetProps) {
 
-  const { header, description, datasource = [], whatsnewlink, image } = props;
+  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) {
@@ -30,6 +34,56 @@ function PegaDxilMyPageWidget(props: PegaDxilMyPageWidgetProps) {
       return item.name;
     });
   }
+
+  // setting up columns for the work list table
+  const columns = [
+    { renderer: 'caseType', label: PConnect.getLocalizedValue('Case type', '', '') },
+    { renderer: 'insKey', label: PConnect.getLocalizedValue('Key', '', '') },
+    { renderer: 'status', label: PConnect.getLocalizedValue('Status', '', '') },
+    { renderer: 'stage', label: PConnect.getLocalizedValue('Stage', '', '') }
+  ];
+
+  // going to get data for worklist to put into a table
+  // data comes from calling a PCore function to get
+  // get data from a data page and a PConnect function
+  // to get getContextName
+  useEffect(() => {
+
+    PCore.getDataApiUtils()
+      .getData(dataViewName, {}, context)
+      // @ts-ignore
+      .then((response: any) => {
+        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);
+      });
+  }, [context]);
+
   return (
     <StyledPegaDxilMyPageWidgetWrapper>
     <PegaAppAnnouncement
@@ -39,6 +93,14 @@ function PegaDxilMyPageWidget(props: PegaDxilMyPageWidgetProps) {
       whatsNewLink={whatsnewlink}
       image={image.replace(/ /g, '+')}
     />
+    <br />
+    <Table
+      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_MyParagraph/demo.stories.tsx

@@ -20,13 +20,8 @@ export const BasePegaDxilMyParagraph: Story = args => {
 
   const props = {
     value: configProps.value,
-    placeholder: configProps.placeholder,
-    label: configProps.label,
-    helperText: configProps.helperText,
-    testId: configProps.testId,
     hasSuggestions: configProps.hasSuggestions,
     fieldMetadata,
-    validatemessage: '',
     getPConnect: () => {
       return {
         getStateProps: () => {
@@ -64,5 +59,6 @@ BasePegaDxilMyParagraph.args = {
   status: configProps.status,
   hideLabel: configProps.hideLabel,
   displayMode: configProps.displayMode,
+  variant: configProps.variant,
   validatemessage: configProps.validatemessage
 };

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

@@ -8,6 +8,7 @@ export const configProps = {
   testId: 'paragraph-12345678',
   hasSuggestions: false,
   displayMode: '',
+  variant: '',
   hideLabel: false,
   readOnly: false,
   required: false,

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

@@ -20,14 +20,8 @@ export const BasePegaDxilMyPercentage: Story = args => {
 
   const props = {
     value: configProps.value,
-    placeholder: configProps.placeholder,
-    label: configProps.label,
-    helperText: configProps.helperText,
-    showGroupSeparators: configProps.showGroupSeparators,
     hasSuggestions: configProps.hasSuggestions,
-    testId: configProps.testId,
     fieldMetadata,
-    validatemessage: '',
     getPConnect: () => {
       return {
         getStateProps: () => {
@@ -57,6 +51,7 @@ export const BasePegaDxilMyPercentage: Story = args => {
 BasePegaDxilMyPercentage.args = {
   label: configProps.label,
   helperText: configProps.helperText,
+  placeholder: configProps.placeholder,
   showGroupSeparators: configProps.showGroupSeparators,
   testId: configProps.testId,
   readOnly: configProps.readOnly,
@@ -65,5 +60,6 @@ BasePegaDxilMyPercentage.args = {
   status: configProps.status,
   hideLabel: configProps.hideLabel,
   displayMode: configProps.displayMode,
+  variant: configProps.variant,
   validatemessage: configProps.validatemessage
 };

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

@@ -8,6 +8,7 @@ export const configProps = {
   testId: 'percentage-12345678',
   hasSuggestions: false,
   displayMode: '',
+  variant: '',
   hideLabel: false,
   readOnly: false,
   required: false,

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

@@ -19,12 +19,7 @@ export const BasePegaDxilMyPhone: Story = args => {
 
   const props = {
     value: configProps.value,
-    placeholder: configProps.placeholder,
-    label: configProps.label,
-    testId: configProps.testId,
     hasSuggestions: configProps.hasSuggestions,
-    datasource: configProps.datasource,
-    validatemessage: '',
     getPConnect: () => {
       return {
         getStateProps: () => {
@@ -52,6 +47,7 @@ export const BasePegaDxilMyPhone: Story = args => {
 };
 
 BasePegaDxilMyPhone.args = {
+  datasource: configProps.datasource,
   label: configProps.label,
   helperText: configProps.helperText,
   placeholder: configProps.placeholder,
@@ -62,5 +58,6 @@ BasePegaDxilMyPhone.args = {
   status: configProps.status,
   hideLabel: configProps.hideLabel,
   displayMode: configProps.displayMode,
+  variant: configProps.variant,
   validatemessage: configProps.validatemessage
 };

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

@@ -26,6 +26,7 @@ export const configProps = {
   testId: 'phone-12345678',
   hasSuggestions: false,
   displayMode: '',
+  variant: '',
   hideLabel: false,
   readOnly: false,
   required: false,