@pega/custom-dx-components 24.1.12 → 24.2.11

package/tests/assets/library/components/createAll/Constellation/Pega_DXIL_MyEmail/index.tsx

@@ -0,0 +1,213 @@
+import { useState, useEffect, useRef } from 'react';
+import { Input, EmailDisplay, FieldValueList, Text, URLDisplay, PhoneDisplay, withConfiguration } from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from '../shared/PConnProps';
+import '../shared/create-nonce';
+
+// includes in bundle
+import { suggestionsHandler } from '../shared/suggestions-handler';
+import handleEvent from "./event-utils";
+
+import StyledPegaDxilMyEmailWrapper from './styles';
+
+// interface for props
+interface PegaDxilMyEmailProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  helperText: string;
+  isTableFormatter?: boolean;
+  hasSuggestions?: boolean;
+  variant?: any;
+  formatter: string;
+}
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
+
+export const formatExists = (formatterVal: string) => {
+    const formatterValues = [
+      "TextInput",
+      "WorkStatus",
+      "RichText",
+      "Email",
+      "Phone",
+      "URL",
+      "Operator"
+    ];
+    let isformatter = false;
+    if (formatterValues.includes(formatterVal)) {
+      isformatter = true;
+    }
+    return isformatter;
+  };
+
+
+export const textFormatter = (formatter: string, value: any) => {
+  let displayComponent: any = null;
+  switch(formatter){
+    case "TextInput" : {
+      displayComponent = value;
+      break;
+    }
+    case "Email" : {
+      displayComponent = (<EmailDisplay value={value} displayText={value} variant="link" />);
+      break;
+    }
+    case "Phone" : {
+      displayComponent = (<PhoneDisplay value={value} variant="link" />);
+      break;
+    }
+    case "URL" : {
+      displayComponent = (<URLDisplay target="_blank" value={value} displayText={value} variant="link" />);
+      break;
+    }
+    // no default
+  }
+  return displayComponent;
+};
+
+
+
+// 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 PegaDxilMyEmail(props: PegaDxilMyEmailProps) {
+ const {
+    getPConnect,
+    value,
+    placeholder,
+    validatemessage,
+    label,
+    hideLabel = false,
+    helperText,
+    testId,
+    displayMode,
+    additionalProps = {},
+    variant = 'inline',
+    isTableFormatter = false,
+    hasSuggestions = false
+  } = props;
+  const { formatter } = props;
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const stateProps = pConn.getStateProps() as StateProps;
+  const propName: string = stateProps.value;
+
+  const hasValueChange = useRef(false);
+
+
+  let { readOnly = false, required = false, disabled = false } = props;
+  [readOnly, required, disabled] = [readOnly, required, disabled].map(
+    (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
+  );
+  const [inputValue, setInputValue] = useState(value);
+  useEffect(() => setInputValue(value), [value]);
+
+  const [status, setStatus] = useState(hasSuggestions ? 'pending' : undefined);
+
+  useEffect(() => {
+    if (validatemessage !== '') {
+      setStatus('error');
+    }
+    if (hasSuggestions) {
+      setStatus('pending');
+    } else if (!hasSuggestions && status !== 'success') {
+      setStatus(validatemessage !== '' ? 'error' : undefined);
+    }
+  }, [validatemessage, hasSuggestions, status]);
+
+  let displayComp: any = null;
+  if (displayMode) {
+    displayComp = <EmailDisplay value={value} displayText={inputValue} variant='link' />;
+  }
+
+  if (displayMode === 'LABELS_LEFT' || displayMode === 'DISPLAY_ONLY') {
+    if (isTableFormatter && formatExists(formatter)) {
+      displayComp = textFormatter(formatter, value);
+    }
+    return displayMode === 'DISPLAY_ONLY' ? (
+      <StyledPegaDxilMyEmailWrapper>
+      {displayComp}
+      </StyledPegaDxilMyEmailWrapper>
+    ) : (
+      <StyledPegaDxilMyEmailWrapper>
+      <FieldValueList
+        variant={hideLabel ? 'stacked' : variant}
+        data-testid={testId}
+        fields={[{ id: '1', name: hideLabel ? '' : label, value: displayComp }]}
+      />
+      </StyledPegaDxilMyEmailWrapper>
+    );
+  }
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    return (
+      <StyledPegaDxilMyEmailWrapper>
+      <FieldValueList
+        variant='stacked'
+        data-testid={testId}
+        fields={[
+          {
+            id: '2',
+            name: hideLabel ? '' : label,
+            value: (
+              <Text variant='h1' as='span'>
+                {displayComp}
+              </Text>
+            )
+          }
+        ]}
+      />
+      </StyledPegaDxilMyEmailWrapper>
+    );
+  }
+
+  const onResolveSuggestionHandler = (accepted: boolean) => {
+    suggestionsHandler(accepted, pConn, setStatus);
+  };
+
+  return (
+    <StyledPegaDxilMyEmailWrapper>
+    <Input
+      {...additionalProps}
+      type='email'
+      label={label}
+      labelHidden={hideLabel}
+      info={validatemessage || helperText}
+      value={inputValue}
+      status={status}
+      placeholder={placeholder}
+      disabled={disabled}
+      readOnly={readOnly}
+      required={required}
+      data-testid={testId}
+      onChange={(event: any) => {
+        if (hasSuggestions) {
+          setStatus(undefined);
+        }
+        setInputValue(event.target.value);
+        if (value !== event.target.value) {
+          handleEvent(actions, 'change', propName, event.target.value);
+          hasValueChange.current = true;
+        }
+      }}
+      onBlur={(event: any) => {
+        if (!value || hasValueChange.current) {
+          handleEvent(actions, 'blur', propName, event.target.value);
+          if (hasSuggestions) {
+            pConn.ignoreSuggestion('');
+          }
+          hasValueChange.current = false;
+        }
+      }}
+      // @ts-ignore
+      onFocus={actions.onFocus}
+      onResolveSuggestion={onResolveSuggestionHandler}
+    />
+    </StyledPegaDxilMyEmailWrapper>
+  );
+}
+
+export default withConfiguration(PegaDxilMyEmail);

package/tests/assets/library/components/createAll/Constellation/Pega_DXIL_MyEmail/mock.ts

@@ -0,0 +1,31 @@
+
+export const configProps = {
+  value: '',
+  label: 'Email Sample',
+  placeholder: 'Email Placeholder',
+  helperText: 'Email Helper Text',
+  testId: 'email-12345678',
+  hasSuggestions: false,
+  displayMode: '',
+  hideLabel: false,
+  readOnly: false,
+  required: false,
+  disabled: false,
+  status: '',
+  validatemessage: '',
+  variant: ''
+};
+
+export const stateProps = {
+  value: '.EmailSample',
+  hasSuggestions: false
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Text',
+  maxLength: 256,
+  displayAs: 'pxEmail',
+  label: 'Email sample',
+  validateAs: 'ValidEmailAddress'
+};

package/tests/assets/library/components/createAll/Constellation/Pega_DXIL_MyForm/DetailsRender.tsx

@@ -0,0 +1,59 @@
+import { Fragment, type 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/library/components/createAll/Constellation/Pega_DXIL_MyForm/config.json

@@ -0,0 +1,45 @@
+{
+  "name": "Pega_DXIL_MyForm",
+  "label": "My Form",
+  "description": "My Form",
+  "organization": "Pega",
+  "version": "0.0.1-dev",
+  "library": "DXIL",
+  "allowedApplications": [],
+  "componentKey": "Pega_DXIL_MyForm",
+  "type": "Template",
+  "subtype": "FORM",
+  "icon": "DefaultForm.svg",
+    "properties": [
+    {
+      "format": "SELECT",
+      "name": "NumCols",
+      "label": "Number of columns",
+      "defaultValue": "1",
+      "source": [
+        { "key": "1", "value": "One" },
+        { "key": "2", "value": "Two" },
+        { "key": "3", "value": "Three" }
+      ]
+    },
+    {
+      "format": "SELECT",
+      "name": "templateOverrideMode",
+      "label": "Template for embedded views",
+      "defaultValue": "USE_TEMPLATE",
+      "source": [
+        { "key": "USE_TEMPLATE", "value": "Use template" },
+        { "key": "IGNORE_TEMPLATE", "value": "Ignore template" }
+      ]
+    },
+    {
+      "format": "INSTRUCTIONS"
+    },
+    {
+      "name": "Fields",
+      "label": "Fields",
+      "format": "CONTENTPICKER",
+      "allowCreatingGroup": true
+    }
+  ]
+}

package/tests/assets/library/components/createAll/Constellation/Pega_DXIL_MyForm/demo.stories.tsx

@@ -0,0 +1,252 @@
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import { useState } from 'react';
+import type { Meta, StoryObj } from '@storybook/react';
+
+import PegaDxilMyForm from './index';
+import { DateInput, Input, FieldValueList, Text, EmptyState } from '@pega/cosmos-react-core';
+import { PhoneInput as CosmosPhone } from '@pega/cosmos-react-core';
+import { pyReviewRaw, regionChildrenResolved } from './mock';
+
+const meta: Meta<typeof PegaDxilMyForm> = {
+  title: 'PegaDxilMyForm',
+  component: PegaDxilMyForm,
+  excludeStories: /.*Data$/,
+  parameters: {
+    type: 'Form'
+  }
+};
+
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyForm>;
+
+const renderField = resolvedProps => {
+  const { displayMode, value = '', label = '', key, readOnly } = 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={dateValue => {
+          const { valueAsISOString: date } = dateValue;
+          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}
+        style={{ fontSize: '14px' }}
+        key={key}
+        onChange={phoneVal => {
+          setPhoneValue(phoneVal);
+        }}
+      />
+    );
+  }
+
+
+  if (variant === 'inline') {
+    val = value || (
+      <span
+        aria-hidden='true'
+        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>
+    );
+  }
+
+  if (readOnly) {
+    return (
+      <EmptyState
+        key={Math.random()}
+        getPConnect={() => {
+          return {
+            getChildren: () => {
+              return [
+                {
+                  getPConnect: () => {
+                    return {
+                      getRawMetadata: () => {
+                        return {};
+                      },
+                      resolveConfigProps: props => {
+                        return props;
+                      },
+                      getConfigProps: () => {
+                        return {
+                          value: '',
+                          label: label,
+                          displayMode: 'LABELS_LEFT'
+                        };
+                      },
+                      getComponent: () => {
+                        return val;
+                      }
+                    };
+                  }
+                }
+              ];
+            }
+          };
+        }}
+      ></EmptyState>
+    );
+  }
+  return (
+    <FieldValueList
+      variant={variant}
+      fields={[{ name: label, value: val }]}
+      key={key}
+    />
+  );
+};
+
+export const BasePegaDxilMyForm: Story = args => {
+  const { readOnly } = args;
+
+  const props = {
+    readOnly: readOnly,
+    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],
+                displayMode: readOnly ? 'LABELS_LEFT' : '',
+                readOnly
+              });
+            case '@P .MiddleName':
+              return renderField({
+                ...regionChildrenResolved[1],
+                displayMode: readOnly ? 'LABELS_LEFT' : '',
+                readOnly
+              });
+            case '@P .LastName':
+              return renderField({
+                ...regionChildrenResolved[2],
+                displayMode: readOnly ? 'LABELS_LEFT' : '',
+                readOnly
+              });
+            case '@P .Email':
+              return renderField({
+                ...regionChildrenResolved[3],
+                displayMode: readOnly ? 'LABELS_LEFT' : '',
+                readOnly
+              });
+            case '@P .PhoneNumber':
+              return renderField({
+                ...regionChildrenResolved[4],
+                displayMode: readOnly ? 'LABELS_LEFT' : '',
+                readOnly
+              });
+            case '@P .ServiceDate':
+              return renderField({
+                ...regionChildrenResolved[5],
+                displayMode: readOnly ? 'LABELS_LEFT' : '',
+                readOnly
+              });
+          }
+        }
+      };
+    }
+  };
+
+  const regionAChildren = pyReviewRaw.children[0].children.map(child => {
+    return props.getPConnect().createComponent(child);
+  });
+
+  return (
+    <>
+      <PegaDxilMyForm {...props} {...args}>{regionAChildren}</PegaDxilMyForm>
+    </>
+  );
+};
+
+BasePegaDxilMyForm.args = {
+  readOnly: false,
+  showLabel: true,
+  label: 'Form template',
+  NumCols: 1,
+};

package/tests/assets/library/components/createAll/Constellation/Pega_DXIL_MyForm/index.tsx

@@ -0,0 +1,69 @@
+import { Grid, Flex, FieldGroup, withConfiguration } from '@pega/cosmos-react-core';
+
+
+import type { PConnFieldProps } from '../shared/PConnProps';
+import '../shared/create-nonce';
+import DetailsRender from './DetailsRender';
+
+import StyledPegaDxilMyFormWrapper from './styles';
+
+// interface for props
+interface PegaDxilMyFormProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  showLabel: boolean;
+  NumCols: string;
+  children: any;
+}
+
+// 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 PegaDxilMyForm(props: PegaDxilMyFormProps) {
+
+  const { children = [], NumCols = '1', label, showLabel, getPConnect, readOnly, displayMode } = props;
+  const propsToUse = { label, showLabel, ...getPConnect().getInheritedProps() };
+
+  const nCols = parseInt(NumCols, 10);
+
+
+  if (readOnly && readOnly === true || displayMode && displayMode === 'DISPLAY_ONLY') {
+    const numRegions = '1';
+    const gridRepeat = 'repeat('.concat(numRegions).concat(', 1fr)');
+    const gridContainer = { colGap: 0, 'margin-line-start': 0 };
+    // @ts-ignore
+    gridContainer.cols = gridRepeat;
+    // @ts-ignore
+    gridContainer.gap = 2;
+
+    return (
+      <StyledPegaDxilMyFormWrapper>
+        <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>
+      </StyledPegaDxilMyFormWrapper>
+    );
+  }
+  return (
+    <StyledPegaDxilMyFormWrapper>
+    <FieldGroup name={propsToUse.showLabel ? propsToUse.label : ''}>
+      <Grid container={{
+            cols: `repeat(${nCols}, minmax(0, 1fr))`,
+            gap: 2
+          }}>
+            {children}
+      </Grid>
+    </FieldGroup>
+    </StyledPegaDxilMyFormWrapper>
+  );
+}
+
+export default withConfiguration(PegaDxilMyForm);