@pega/custom-dx-components 0.24.17 → 0.25.1

package/tests/assets/original/components/createAll/Launchpad/Pega_DXIL_MyForm/mock.ts

@@ -0,0 +1,139 @@
+
+// @ts-nocheck
+export const pyReviewRaw = {
+  name: 'CollectInformation',
+  type: 'View',
+  config: {
+    template: 'DefaultForm',
+    ruleClass: 'OM5W9U-SampleApp-Work-Test',
+    localeReference: '@LR OM5W9U-SAMPLEAPP-WORK-TEST!VIEW!COLLECTINFORMATION',
+    context: '@P .pyViewContext'
+  },
+  children: [
+    {
+      name: 'Fields',
+      type: 'Region',
+      children: [
+        {
+          type: 'TextInput',
+          config: {
+            value: '@P .FirstName',
+            label: '@L First Name',
+            key: 'FirstName'
+          }
+        },
+        {
+          type: 'TextInput',
+          config: {
+            value: '@P .MiddleName',
+            label: '@L Middle Name',
+            key: 'MiddleName'
+          }
+        },
+        {
+          type: 'TextInput',
+          config: {
+            value: '@P .LastName',
+            label: '@L Last Name',
+            key: 'LastName'
+          }
+        },
+        {
+          type: 'Email',
+          config: {
+            value: '@P .Email',
+            label: '@L Email',
+            key: 'Email'
+          }
+        },
+        {
+          type: 'Phone',
+          config: {
+            value: '@P .PhoneNumber',
+            label: '@L Phone Number',
+            datasource: {
+              source: '@DATASOURCE D_pyCountryCallingCodeList.pxResults',
+              fields: {
+                value: '@P .pyCallingCode'
+              }
+            },
+            key: 'PhoneNumber'
+          }
+        },
+        {
+          type: 'Date',
+          config: {
+            value: '@P .ServiceDate',
+            label: '@L Service Date',
+            key: 'ServiceDate'
+          }
+        }
+      ]
+    }
+  ],
+  classID: 'OM5W9U-SampleApp-Work-Test'
+};
+
+export const regionChildrenResolved = [
+  {
+    readOnly: undefined,
+    value: 'John',
+    label: 'First Name',
+    hasSuggestions: false,
+    key: 'firstName'
+  },
+  {
+    readOnly: undefined,
+    value: '',
+    label: 'Middle Name',
+    hasSuggestions: false,
+    key: 'middleName'
+  },
+  {
+    readOnly: undefined,
+    value: 'Doe',
+    label: 'Last Name',
+    hasSuggestions: false,
+    key: 'lastName'
+  },
+  {
+    readOnly: undefined,
+    value: 'John@doe.com',
+    label: 'Email',
+    hasSuggestions: false,
+    key: 'email'
+  },
+  {
+    readOnly: undefined,
+    value: '+16397975093',
+    label: 'Phone Number',
+    datasource: {
+      fields: {
+        value: undefined
+      },
+      source: [
+        {
+          value: '+1'
+        },
+        {
+          value: '+91'
+        },
+        {
+          value: '+48'
+        },
+        {
+          value: '+44'
+        }
+      ]
+    },
+    hasSuggestions: false,
+    key: 'phoneNumber'
+  },
+  {
+    readOnly: undefined,
+    value: '2023-01-25',
+    label: 'Service Date',
+    hasSuggestions: false,
+    key: 'serviceDate'
+  }
+];

package/tests/assets/original/components/createAll/Launchpad/Pega_DXIL_MyForm/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/original/components/createAll/Launchpad/Pega_DXIL_MyIconButtonURL/config.json

@@ -0,0 +1,35 @@
+{
+  "name": "Pega_DXIL_MyIconButtonURL",
+  "label": "My Icon Button URL",
+  "description": "My Icon Button URL",
+  "organization": "Pega",
+  "version": "0.0.1",
+  "library": "DXIL",
+  "allowedApplications": [],
+  "componentKey": "Pega_DXIL_MyIconButtonURL",
+  "type": "Field",
+  "subtype": "Text-URL",
+  "icon": "images/pz-url-active.svg",
+  "properties": [
+    {
+      "label": "Advanced",
+      "format": "GROUP",
+      "collapsible": true,
+      "properties": [
+        {
+          "name": "testId",
+          "label": "Test ID",
+          "format": "TEXT",
+          "ignorePattern": "[^-_\\p{N}\\p{L}]",
+          "includeAnnotations": false
+        }
+      ]
+    }
+  ],
+  "defaultConfig": {
+    "label": "@L $this.label",
+    "detailFVLItem": true,
+    "isFormWidth" : false,
+    "isContainerWidth" : false
+  }
+}

package/tests/assets/original/components/createAll/Launchpad/Pega_DXIL_MyIconButtonURL/demo.stories.tsx

@@ -0,0 +1,102 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+import type { Meta, StoryObj } from '@storybook/react';
+
+import PegaDxilMyIconButtonUrl from './index';
+import { configProps } from './mock';
+
+const meta: Meta<typeof PegaDxilMyIconButtonUrl> = {
+  title: 'PegaDxilMyIconButtonUrl',
+  component: PegaDxilMyIconButtonUrl,
+  excludeStories: /.*Data$/
+};
+
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyIconButtonUrl>;
+
+if (!window.PCore) {
+  window.PCore = {};
+}
+
+const countrylistData = {
+  data: [
+    {
+      Name: 'United States of America',
+      ShortName: 'USA'
+    },
+    {
+      Name: 'Canada',
+      ShortName: 'CAN'
+    },
+    {
+      Name: 'Mexico',
+      ShortName: 'MEX'
+    }
+  ]
+};
+
+window.PCore.getDataPageUtils = () => {
+  return {
+    getData: () => {
+      return new Promise(resolve => {
+        resolve(countrylistData);
+      });
+    },
+    getDataAsync: () => {
+      return new Promise(resolve => {
+        resolve(countrylistData);
+      });
+    }
+  };
+};
+
+export const BasePegaDxilMyIconButtonUrl: Story = (args: any) => {
+
+  const props = {
+    getPConnect: () => {
+      return {
+        getValue: (value: any) => {
+          return value;
+        },
+        getContextName: () => {
+          return 'app/primary_1';
+        },
+        getLocalizedValue: (value: any) => {
+          return value;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {
+              /* nothing */
+            },
+            triggerFieldChange: () => {
+              /* nothing */
+            }
+          };
+        },
+        ignoreSuggestion: () => {
+          /* nothing */
+        },
+        acceptSuggestion: () => {
+          /* nothing */
+        },
+        setInheritedProps: () => {
+          /* nothing */
+        },
+        resolveConfigProps: () => {
+          /* nothing */
+        }
+      };
+    }
+  };
+
+  return (
+    <>
+      <PegaDxilMyIconButtonUrl {...props} {...args} />
+    </>
+  );
+};
+
+BasePegaDxilMyIconButtonUrl.args = {
+
+};

package/tests/assets/original/components/createAll/Launchpad/Pega_DXIL_MyIconButtonURL/index.tsx

@@ -0,0 +1,213 @@
+import { useEffect, useState } from 'react';
+import {
+  Icon,
+  Button,
+  withConfiguration,
+  registerIcon,
+  Table,
+  Label,
+  Link,
+  URLDisplay
+} from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
+import './create-nonce';
+
+// 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
+}
+
+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 countries and display in a table
+//
+// 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, getPConnect, testId } = props;
+  const [countrylist, setCountrylist] = useState([]);
+  const [showTable, setShowTable] = useState(false);
+  const [isLoading, setIsLoading] = useState(true);
+  const [validUrl, setValidUrl] = useState('about:blank');
+  const PConnect = getPConnect();
+  const dataViewName = 'CountryList';
+  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: 'countryName', label: PConnect.getLocalizedValue('Country Name', '', '') },
+    { renderer: 'shortName', label: PConnect.getLocalizedValue('Abbreviation', '', '') }
+  ];
+
+  // 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 = { };
+
+    // only retrieve table data if table is shown
+    if (showTable) {
+      PCore.getDataPageUtils()
+        .getDataAsync(dataViewName, context, params, null, null)
+        .then((response: any) => {
+          setIsLoading(false);
+          // table requires an index or will get setExtraStackFrame error
+          if (response.data !== null) {
+            setCountrylist(
+              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 {
+                  countryName: entry.Name,
+                  shortName: entry.ShortName,
+                  id: index
+                };
+              })
+            );
+          }
+          else {
+            setCountrylist([]);
+            setIsLoading(false);
+          }
+
+        })
+        .catch((error: any) => {
+          setCountrylist([]);
+          setIsLoading(false);
+          console.log(error);
+        });
+    }
+  }, [context, 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('List of countries', '', '')}{' '}
+      </Label>
+      <Button
+        icon
+        label={PConnect.getLocalizedValue('Click to show/hide country 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={countrylist}
+          loading={isLoading}
+          loadingMessage={PConnect.getLocalizedValue('Loading country list', '', '')}
+        />
+      )}
+    </StyledPegaDxilMyIconButtonUrlWrapper>
+  );
+}
+
+
+export default withConfiguration(PegaDxilMyIconButtonUrl);

package/tests/assets/original/components/createAll/Launchpad/Pega_DXIL_MyIconButtonURL/mock.ts

@@ -0,0 +1,4 @@
+
+export const configProps = {
+
+};

package/tests/assets/original/components/createAll/Launchpad/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;
+  `;
+});