@pega/dx-component-builder-sdk 0.24.7 → 0.25.6

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25Email/index.tsx

@@ -0,0 +1,199 @@
+import { useState, useEffect, useRef } from 'react';
+import { Input, EmailDisplay, FieldValueList, Text, URLDisplay, PhoneDisplay, withConfiguration } from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
+import './create-nonce';
+
+// includes in bundle
+import { suggestionsHandler } from './suggestions-handler';
+import handleEvent from './event-utils';
+
+import StyledYourOrgTest25Test25EmailWrapper from './styles';
+
+// interface for props
+interface YourOrgTest25Test25EmailProps 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 YourOrgTest25Test25Email(props: YourOrgTest25Test25EmailProps) {
+  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' ? (
+      <StyledYourOrgTest25Test25EmailWrapper>{displayComp}</StyledYourOrgTest25Test25EmailWrapper>
+    ) : (
+      <StyledYourOrgTest25Test25EmailWrapper>
+        <FieldValueList
+          variant={hideLabel ? 'stacked' : variant}
+          data-testid={testId}
+          fields={[{ id: '1', name: hideLabel ? '' : label, value: displayComp }]}
+        />
+      </StyledYourOrgTest25Test25EmailWrapper>
+    );
+  }
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    return (
+      <StyledYourOrgTest25Test25EmailWrapper>
+        <FieldValueList
+          variant='stacked'
+          data-testid={testId}
+          fields={[
+            {
+              id: '2',
+              name: hideLabel ? '' : label,
+              value: (
+                <Text variant='h1' as='span'>
+                  {displayComp}
+                </Text>
+              )
+            }
+          ]}
+        />
+      </StyledYourOrgTest25Test25EmailWrapper>
+    );
+  }
+
+  const onResolveSuggestionHandler = (accepted: boolean) => {
+    suggestionsHandler(accepted, pConn, setStatus);
+  };
+
+  return (
+    <StyledYourOrgTest25Test25EmailWrapper>
+      <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) {
+            // @ts-ignore
+            handleEvent(actions, 'change', propName, event.target.value);
+            hasValueChange.current = true;
+          }
+        }}
+        onBlur={(event: any) => {
+          if (!value || hasValueChange.current) {
+            // @ts-ignore
+            handleEvent(actions, 'blur', propName, event.target.value);
+            if (hasSuggestions) {
+              pConn.ignoreSuggestion('');
+            }
+            hasValueChange.current = false;
+          }
+        }}
+        // @ts-ignore
+        onFocus={actions.onFocus}
+        onResolveSuggestion={onResolveSuggestionHandler}
+      />
+    </StyledYourOrgTest25Test25EmailWrapper>
+  );
+}
+
+export default withConfiguration(YourOrgTest25Test25Email);

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25Email/mock.ts

@@ -0,0 +1,31 @@
+// @ts-nocheck
+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,
+  variant: '',
+  status: '',
+  validatemessage: ''
+};
+
+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/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25Email/styles.ts

@@ -0,0 +1,21 @@
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    /* Your existing style */
+    margin: 0px 0;
+
+    /* 👇 Here are all the visual changes added */
+
+    /* 1. This adds a thick red border and a light yellow background */
+    & .MuiOutlinedInput-root {
+      border: 3px solid red;
+      background-color: #ffffe0; /* light yellow */
+    }
+
+    /* 2. This targets the icon (MailOutlineIcon) and makes it blue */
+    & .MuiSvgIcon-root {
+      color: blue;
+    }
+  `;
+});

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25Email/suggestions-handler.ts

@@ -0,0 +1,9 @@
+export const suggestionsHandler = (accepted: boolean, pConn: any, setStatus: any) => {
+  if (accepted) {
+    pConn.acceptSuggestion();
+    setStatus('success');
+  } else {
+    pConn.ignoreSuggestion();
+    setStatus(undefined);
+  }
+};

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25IconButtonURL/PConnProps.d.ts

@@ -0,0 +1,45 @@
+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/field/YourOrg_test25_test25IconButtonURL/create-nonce.ts

@@ -0,0 +1,5 @@
+// @ts-ignore
+if (window?.__webpack_nonce__) {
+  // @ts-ignore
+  __webpack_nonce__ = window.__webpack_nonce__;
+}

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25IconButtonURL/demo.stories.tsx

@@ -0,0 +1,92 @@
+/* eslint-disable react/jsx-no-useless-fragment */
+import type { Meta, StoryObj } from '@storybook/react';
+
+import YourOrgTest25Test25IconButtonUrl from './index';
+import { configProps } from './mock';
+
+const meta: Meta<typeof YourOrgTest25Test25IconButtonUrl> = {
+  title: 'YourOrgTest25Test25IconButtonUrl',
+  component: YourOrgTest25Test25IconButtonUrl,
+  excludeStories: /.*Data$/
+};
+
+export default meta;
+type Story = StoryObj<typeof YourOrgTest25Test25IconButtonUrl>;
+
+const statelistData = {
+  data: [
+    {
+      pyLabel: 'Massachusetts',
+      pyStateCode: 'MA'
+    },
+    {
+      pyLabel: 'Rhode Island',
+      pyStateCode: 'RI'
+    },
+    {
+      pyLabel: 'Connecticut',
+      pyStateCode: 'CT'
+    }
+  ]
+};
+
+window.PCore.getDataPageUtils = (): any => {
+  return {
+    getDataAsync: () => {
+      return new Promise(resolve => {
+        resolve(statelistData);
+      });
+    }
+  };
+};
+
+export const BaseYourOrgTest25Test25IconButtonUrl: Story = args => {
+  const props = {
+    countryCode: configProps.countryCode,
+    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 (
+    <>
+      <YourOrgTest25Test25IconButtonUrl {...props} {...args} />
+    </>
+  );
+};
+
+BaseYourOrgTest25Test25IconButtonUrl.args = {
+  countryCode: configProps.countryCode
+};

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25IconButtonURL/index.tsx

@@ -0,0 +1,181 @@
+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 StyledYourOrgTest25Test25IconButtonUrlWrapper from './styles';
+
+// interface for props
+interface YourOrgTest25Test25IconButtonUrlProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  countryCode: string;
+}
+
+export const textFormatter = (value: string) => {
+  return <URLDisplay target='_blank' value={value} displayText={value} variant='link' />;
+};
+
+// *************
+// 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 YourOrgTest25Test25IconButtonUrl(props: YourOrgTest25Test25IconButtonUrlProps) {
+  const { value, displayMode, countryCode = 'USA', getPConnect, testId } = props;
+  const [statelist, setStatelist] = useState([]);
+  const [showTable, setShowTable] = useState(false);
+  const [validUrl, setValidUrl] = useState('about:blank');
+  const PConnect = getPConnect();
+
+  // 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 dataViewName = 'D_pyStateList';
+    const context = PConnect.getContextName();
+    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) => {
+          // 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
+              };
+            })
+          );
+        })
+        .catch((error: any) => {
+          console.log(error);
+        });
+    }
+  }, [PConnect, countryCode, showTable]);
+
+  // when DISPLAY_ONLY, in this example we will just show the URL.
+  if (displayMode === 'DISPLAY_ONLY') {
+    const displayComp = textFormatter(validUrl);
+    return <StyledYourOrgTest25Test25IconButtonUrlWrapper> {displayComp} </StyledYourOrgTest25Test25IconButtonUrlWrapper>;
+  }
+
+  return (
+    <StyledYourOrgTest25Test25IconButtonUrlWrapper>
+      <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} />}
+    </StyledYourOrgTest25Test25IconButtonUrlWrapper>
+  );
+}
+
+export default withConfiguration(YourOrgTest25Test25IconButtonUrl);

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25IconButtonURL/mock.ts

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

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25IconButtonURL/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/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25Integer/PConnProps.d.ts

@@ -0,0 +1,45 @@
+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/field/YourOrg_test25_test25Integer/create-nonce.ts

@@ -0,0 +1,5 @@
+// @ts-ignore
+if (window?.__webpack_nonce__) {
+  // @ts-ignore
+  __webpack_nonce__ = window.__webpack_nonce__;
+}