@pega/dx-component-builder-sdk 0.23.10 → 0.23.11

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

@@ -0,0 +1,182 @@
+
+
+// @ts-nocheck
+import { useState } from 'react';
+import { withKnobs } from '@storybook/addon-knobs';
+
+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 {
+  title: 'PegaDxilMyTwoColumnForm',
+  decorators: [withKnobs],
+  component: PegaDxilMyTwoColumnForm
+};
+
+const renderField = resolvedProps => {
+  const { displayMode, value = '', label = '', key } = resolvedProps;
+
+  // eslint-disable-next-line react-hooks/rules-of-hooks
+  const [inputValue, setInputValue] = useState(value);
+  // eslint-disable-next-line react-hooks/rules-of-hooks
+  const [phoneValue, setPhoneValue] = useState('+16397975093');
+
+
+  const variant = displayMode === 'LABELS_LEFT' ? 'inline' : 'stacked';
+
+  let val =
+    value !== '' ? (
+      <Text
+        variant='h1'
+        as='span'
+        key={key}
+        onChange={e => {
+          setInputValue(e.target.value);
+        }}
+      >
+        {inputValue}
+      </Text>
+    ) : (
+      ''
+    );
+
+
+  if (label === 'Service Date')
+    val = (
+      <DateInput
+        value={inputValue}
+        style={{ fontSize: '14px' }}
+        key={key}
+        onChange={dateVal => {
+          const { valueAsISOString: date } = dateVal;
+          const trimmedDate = date ? date.substring(0, date.indexOf('T')) : date;
+          setInputValue(trimmedDate);
+        }}
+      />
+    );
+
+  if (label === 'Email')
+    val = (
+      <Input
+        type='email'
+        value={inputValue}
+        style={{ fontSize: '14px' }}
+        key={key}
+        onChange={e => {
+          setInputValue(e.target.value);
+        }}
+      />
+    );
+
+  if (label === 'First Name' || label === 'Last Name' || label === 'Middle Name')
+    val = (
+      <Input
+        value={inputValue}
+        style={{ fontSize: '14px' }}
+        key={key}
+        onChange={e => {
+          setInputValue(e.target.value);
+        }}
+      />
+    );
+
+  if (label === 'Phone Number')
+    val = (
+      <CosmosPhone
+        value={phoneValue}
+        showCountryCode
+        style={{ fontSize: '14px' }}
+        key={key}
+        onChange={phoneVal => {
+          setPhoneValue(phoneVal);
+        }}
+      />
+    );
+
+
+  if (variant === 'inline') {
+    val = value || (
+      <span
+        aria-hidden='true'
+        key={key}
+        onChange={e => {
+          setInputValue(e.target.value);
+        }}
+      >
+        &ndash;&ndash;
+      </span>
+    );
+  } else {
+    val = (
+      <Text
+        variant='h1'
+        as='span'
+        key={key}
+        onChange={e => {
+          setInputValue(e.target.value);
+        }}
+      >
+        {val}
+      </Text>
+    );
+  }
+  return (
+    <FieldValueList
+      variant={variant}
+      fields={[{ name: label, value: val }]}
+      key={key}
+      onChange={() => {
+        /* nothing */
+      }}
+    />
+  );
+};
+
+export const BasePegaDxilMyTwoColumnForm = () => {
+  const props = {
+    template: 'DefaultForm',
+    getPConnect: () => {
+      return {
+        getChildren: () => {
+          return pyReviewRaw.children;
+        },
+        getInheritedProps: () => {
+          return pyReviewRaw.config.inheritedProps;
+        },
+        createComponent: config => {
+          // eslint-disable-next-line default-case
+          switch (config.config.value) {
+            case '@P .FirstName':
+              return renderField(regionChildrenResolved[0]);
+            case '@P .MiddleName':
+              return renderField(regionChildrenResolved[1]);
+            case '@P .LastName':
+              return renderField(regionChildrenResolved[2]);
+            case '@P .Email':
+              return renderField(regionChildrenResolved[3]);
+            case '@P .PhoneNumber':
+              return renderField(regionChildrenResolved[4]);
+            case '@P .ServiceDate':
+              return renderField(regionChildrenResolved[5]);
+          }
+        }
+      };
+    }
+  };
+
+  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 (
+    <PegaDxilMyTwoColumnForm {...props}>
+      {regionAChildren}
+      {regionBChildren}
+    </PegaDxilMyTwoColumnForm>
+  );
+};

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

@@ -0,0 +1,60 @@
+import { Grid, Flex, FieldGroup } from '@pega/cosmos-react-core';
+import PropTypes from 'prop-types';
+
+import type { PConnFieldProps } from './PConnProps';
+
+import StyledPegaDxilMyTwoColumnFormWrapper from './styles';
+
+// interface for props
+interface PegaDxilMyTwoColumnFormProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  showLabel: boolean;
+  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) {
+
+
+  const { children, label, showLabel, getPConnect } = props;
+  const propsToUse = { label, showLabel, ...getPConnect().getInheritedProps() };
+
+  const numRegions = children?.length;
+  const gridRepeat = "repeat(".concat(numRegions).concat(", 1fr)");
+  const gridContainer = {"colGap" : 1};
+  // @ts-ignore
+  gridContainer.cols = gridRepeat;
+  // @ts-ignore
+  gridContainer.alignItems = 'start';
+
+  const flexContainer = {direction: 'column'};
+  // @ts-ignore
+  flexContainer.gap = 2;
+
+  return (
+    <StyledPegaDxilMyTwoColumnFormWrapper>
+      <FieldGroup name={propsToUse.showLabel ? propsToUse.label : ''}>
+        <Grid container={gridContainer}>
+        {children.map((child: any, i: number) => (
+          // @ts-ignore
+          <Flex container={flexContainer} key={`r-${i + 1}`}>
+          {child}
+          </Flex>
+        ))}
+        </Grid>
+      </FieldGroup>
+    </StyledPegaDxilMyTwoColumnFormWrapper>
+  );
+
+}
+
+PegaDxilMyTwoColumnForm.defaultProps = {
+  children: []
+};
+
+PegaDxilMyTwoColumnForm.propTypes = {
+  children: PropTypes.arrayOf(PropTypes.node),
+};

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

@@ -0,0 +1,145 @@
+
+// @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: 'A',
+      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'
+          }
+        }
+      ]
+    },
+    {
+      name: 'B',
+      type: 'Region',
+      children: [
+        {
+          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: 'First Name'
+  },
+  {
+    readOnly: undefined,
+    value: '',
+    label: 'Middle Name',
+    hasSuggestions: false,
+    key: 'Middle Name'
+  },
+  {
+    readOnly: undefined,
+    value: 'Doe',
+    label: 'Last Name',
+    hasSuggestions: false,
+    key: 'Last Name'
+  },
+  {
+    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: 'Phone Number'
+  },
+  {
+    readOnly: undefined,
+    value: '2023-01-25',
+    label: 'Service Date',
+    hasSuggestions: false,
+    key: 'Service Date'
+  }
+];

package/tests/assets/sdk-r/components/createAll/custom-constellation/template/Pega_DXIL_MyTwoColumnForm/styles.ts

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

package/tests/assets/sdk-r/components/createAll/custom-constellation/template/_template.md

@@ -0,0 +1,5 @@
+# The **custom-constellation/template** directory
+
+The **src/components/custom-constellation/template** directory contains the code for the Constellation-based associated component for any custom **template** component you have created for use with the **React SDK**.
+
+For each component in the **src/components/custom-constellation/template** directory, there will be a matching component in the **src/components/custom-sdk/template** directory.

package/tests/assets/sdk-r/components/createAll/custom-constellation/widget/Pega_DXIL_MyCaseWidget/OneColumnPage.svg

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="100px" height="70px" viewBox="0 0 100 70" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>1 col </title>
+    <defs>
+        <rect id="path-1" x="0" y="0" width="100" height="70"></rect>
+    </defs>
+    <g id="Concepts" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="Templates" transform="translate(-98.000000, -108.000000)">
+            <g id="Change-template" transform="translate(42.000000, 36.000000)">
+                <g id="1-col-" transform="translate(56.000000, 72.000000)">
+                    <mask id="mask-2" fill="white">
+                        <use xlink:href="#path-1"></use>
+                    </mask>
+                    <rect stroke="#A5A8BC" stroke-width="0.5" x="0.25" y="0.25" width="99.5" height="69.5"></rect>
+                    <g id="white" mask="url(#mask-2)" fill="#FFFFFF">
+                        <g transform="translate(3.000000, 3.000000)" id="Rectangle">
+                            <rect x="0" y="0" width="94" height="66.5"></rect>
+                        </g>
+                    </g>
+                    <g id="gray" mask="url(#mask-2)" fill="#8084A7">
+                        <g transform="translate(6.000000, 6.000000)" id="Rectangle">
+                            <rect x="0" y="-2.84217094e-14" width="88" height="77.8"></rect>
+                        </g>
+                    </g>
+                    <g id="labels" mask="url(#mask-2)" font-family="OpenSans-Semibold, Open Sans" font-size="11" font-weight="500">
+                        <g transform="translate(44.000000, 17.000000)" id="A">
+                            <text>
+                                <tspan x="0.75" y="12" fill="#FFFFFF">A</tspan>
+                            </text>
+                        </g>
+                    </g>
+                </g>
+            </g>
+        </g>
+    </g>
+</svg>

package/tests/assets/sdk-r/components/createAll/custom-constellation/widget/Pega_DXIL_MyCaseWidget/PConnProps.d.ts

@@ -0,0 +1,46 @@
+import  {PConnect } from '@pega/pcore-pconnect-typedefs';
+
+// PConnProps.d.ts
+// This gives us a place to have each component (which is most DX Components) that is
+//  expected to have a getPConnect extend its props (from BaseProps)
+//  such that every component will be expected to have a getPConnect() function
+//  that returns a PConnect object. (new/better way of doing .propTypes).
+//  This PConnProps can be extended to include other props that we know are in every component
+export interface PConnProps {
+  // getPConnect should exist for every C11n component. (add @ts-ignore in special cases where it isn't)
+  getPConnect: () => typeof PConnect;
+
+  // Allow any/all other key/value pairs in the BaseProps for now
+  //  TODO: refine which other props are always expected for various component
+  //    types and consider further interface "subclassing". For example, we may
+  //    want to create a "BasePropsForm" that gives guidance on required, readonly, etc.
+  //    and any other props that every Form component expects.
+  //    For example, see the PConnFieldProps below.
+  // NOTE: if you uncomment the line below, the PConnProps type will allow
+  //  otherwise undefined types to appear. This can be helpful for debugging
+  //  or when adding new components whose types aren't yet known.
+  // [key: string]: any;
+}
+
+
+// PConnFieldProps extends PConnProps to bring in the common properties that are
+// associated with most field components (ex: Dropdown, TextInput, etc.) in the
+//  components/field directory
+export interface PConnFieldProps extends PConnProps {
+  label: string,
+  required: boolean,
+  disabled: boolean,
+  value: any,
+  validatemessage: string,
+  status?: string,
+  onChange?: any,
+  onBlur?: any,
+  readOnly: boolean,
+  testId: string,
+  helperText: string,
+  displayMode?: string,
+  hideLabel: boolean,
+  placeholder?: string,
+  fieldMetadata?: any,
+  additionalProps?: any
+}

package/tests/assets/sdk-r/components/createAll/custom-constellation/widget/Pega_DXIL_MyCaseWidget/demo.stories.tsx

@@ -0,0 +1,81 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import { withKnobs } from '@storybook/addon-knobs';
+
+import PegaDxilMyCaseWidget from './index';
+
+import historyData from './mock';
+
+export default {
+  title: 'PegaDxilMyCaseWidget',
+  decorators: [withKnobs],
+  component: PegaDxilMyCaseWidget
+};
+
+if (!window.PCore) {
+  window.PCore = {};
+}
+
+window.PCore.getConstants = () => {
+  return {
+    CASE_INFO: {
+      CASE_INFO_ID: 'caseInfo.ID'
+    }
+  };
+};
+
+window.PCore.getLocaleUtils = () => {
+  return {
+    getLocaleValue: value => {
+      return value;
+    }
+  };
+};
+
+window.PCore.getDataApiUtils = () => {
+  return {
+    getData: () => {
+      return new Promise(resolve => {
+        resolve(historyData);
+      });
+    }
+  };
+};
+
+export const BasePegaDxilMyCaseWidget = () => {
+
+  const props = {
+    label: 'Case history',
+
+    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 (
+    <>
+      <PegaDxilMyCaseWidget {...props} />
+    </>
+  );
+};

package/tests/assets/sdk-r/components/createAll/custom-constellation/widget/Pega_DXIL_MyCaseWidget/index.tsx

@@ -0,0 +1,83 @@
+import { useState, useEffect } from 'react';
+import PropTypes from 'prop-types';
+import { Table, Text } from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
+
+import StyledPegaDxilMyCaseWidgetWrapper from './styles';
+
+// interface for props
+interface PegaDxilMyCaseWidgetProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+
+}
+
+
+// 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 PegaDxilMyCaseWidget(props: PegaDxilMyCaseWidgetProps) {
+  const { getPConnect, label } = props;
+  const pConn = getPConnect();
+  const [history, setHistory] = useState([]);
+  const [isLoading, setIsLoading] = useState(true);
+  const caseProp: string = PCore.getConstants().CASE_INFO.CASE_INFO_ID;
+  const caseID = pConn.getValue(caseProp, '');
+  const context = pConn.getContextName();
+
+  const columns = [
+    { renderer: 'date', label: pConn.getLocalizedValue('Date', '', '') },
+    { renderer: 'description', label: pConn.getLocalizedValue('Description', '', '') },
+    { renderer: 'user', label: pConn.getLocalizedValue('Performed by', '','') }
+  ];
+
+  useEffect(() => {
+    // @ts-ignore
+    const payload = { dataViewParameters: [{ CaseInstanceKey: caseID }] };
+    PCore.getDataApiUtils()
+      // @ts-ignore
+      .getData('D_pyWorkHistory', payload, context)
+      // @ts-ignore
+      .then((response) => {
+        setIsLoading(false);
+        if (response.data.data !== null) {
+          setHistory(
+            response.data.data.map((entry: any, index: number) => {
+              return {
+                date: new Date(entry.pxTimeCreated).toLocaleString(),
+                description: <Text style={{ wordBreak: 'break-word' }}>{entry.pyMessageKey}</Text>,
+                user: entry.pyPerformer,
+                id: index
+              };
+            })
+          );
+        } else {
+          setHistory([]);
+        }
+      })
+      .catch(() => {
+        setHistory([]);
+        setIsLoading(false);
+      });
+  }, [caseID, context]);
+  return (
+    <StyledPegaDxilMyCaseWidgetWrapper>
+    <Table
+      title={pConn.getLocalizedValue(label, '', '')}
+      columns={columns}
+      data={history}
+      loading={isLoading}
+      loadingMessage={pConn.getLocalizedValue('Loading case history', '', '')}
+    />
+    </StyledPegaDxilMyCaseWidgetWrapper>
+  );
+
+}
+
+PegaDxilMyCaseWidget.defaultProps = {
+
+};
+
+PegaDxilMyCaseWidget.propTypes = {
+  getPConnect: PropTypes.func.isRequired
+};