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

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

@@ -0,0 +1,200 @@
+import { useState, useEffect, useRef } from 'react';
+import { Input, FieldValueList, Text, withConfiguration } from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
+import './create-nonce';
+
+// includes in bundle
+import { formatExists, textFormatter, urlFormatter } from './text-url';
+import handleEvent from './event-utils';
+import { suggestionsHandler } from './suggestions-handler';
+
+import StyledYourOrgTest25Test25UrlWrapper from './styles';
+
+// interface for props
+interface YourOrgTest25Test25UrlProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  displayAsStatus?: boolean;
+  displayAs: string;
+  isTableFormatter?: boolean;
+  hasSuggestions?: boolean;
+  variant?: any;
+  formatter: string;
+  datasource: Array<any>;
+  widthSel: string;
+  customWidth: number;
+  altText: string;
+  altTextOfImage: string;
+  propaltTextOfImage: string;
+  urlLabel: string;
+  propUrlLabel: string;
+  urlLabelSelection: string;
+  tableDisplayAs: string;
+}
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
+
+// 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 YourOrgTest25Test25Url(props: YourOrgTest25Test25UrlProps) {
+  const {
+    getPConnect,
+    value,
+    hideLabel = false,
+    placeholder,
+    validatemessage,
+    label,
+    helperText,
+    testId,
+    displayMode,
+    additionalProps = {},
+    variant = 'inline',
+    isTableFormatter = false,
+    displayAs = 'defaultURL',
+    widthSel = 'defaultWidth',
+    customWidth,
+    altText = 'constant',
+    altTextOfImage,
+    propaltTextOfImage,
+    urlLabel,
+    propUrlLabel,
+    urlLabelSelection = 'constant',
+    tableDisplayAs = 'link',
+    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);
+
+  // BUG-547602: Temporary type coercion for 8.5 until DXAPIs are enhanced to pass original pxViewMetadata JSON, respecting boolean primitives
+  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);
+  const [status, setStatus] = useState(hasSuggestions ? 'pending' : undefined);
+  useEffect(() => setInputValue(value), [value]);
+
+  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 = urlFormatter(value, {
+      displayAs,
+      tableDisplayAs,
+      isTableFormatter,
+      altText,
+      altTextOfImage,
+      propaltTextOfImage,
+      urlLabelSelection,
+      urlLabel,
+      propUrlLabel,
+      widthSel,
+      customWidth
+    });
+  }
+
+  if (displayMode === 'LABELS_LEFT' || displayMode === 'DISPLAY_ONLY') {
+    if (isTableFormatter && formatter !== 'URL' && formatExists(formatter)) {
+      displayComp = textFormatter(formatter, value);
+    }
+    return displayMode === 'DISPLAY_ONLY' ? (
+      displayComp
+    ) : (
+      <StyledYourOrgTest25Test25UrlWrapper>
+        <FieldValueList
+          variant={hideLabel ? 'stacked' : variant}
+          data-testid={testId}
+          fields={[{ id: '1', name: hideLabel ? '' : label, value: displayComp }]}
+        />
+      </StyledYourOrgTest25Test25UrlWrapper>
+    );
+  }
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    return (
+      <StyledYourOrgTest25Test25UrlWrapper>
+        <FieldValueList
+          variant='stacked'
+          data-testid={testId}
+          fields={[
+            {
+              id: '2',
+              name: hideLabel ? '' : label,
+              value: (
+                <Text variant='h1' as='span'>
+                  {displayComp}
+                </Text>
+              )
+            }
+          ]}
+        />
+      </StyledYourOrgTest25Test25UrlWrapper>
+    );
+  }
+
+  const onResolveSuggestionHandler = (accepted: boolean) => {
+    suggestionsHandler(accepted, pConn, setStatus);
+  };
+
+  return (
+    <StyledYourOrgTest25Test25UrlWrapper>
+      <Input
+        {...additionalProps}
+        type='url'
+        label={label}
+        labelHidden={hideLabel}
+        info={validatemessage || helperText}
+        status={status}
+        value={inputValue}
+        placeholder={placeholder}
+        disabled={disabled}
+        readOnly={readOnly}
+        required={required}
+        data-testid={testId}
+        onChange={(event: any) => {
+          if (hasSuggestions) {
+            setStatus('');
+          }
+          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}
+      />
+    </StyledYourOrgTest25Test25UrlWrapper>
+  );
+}
+
+export default withConfiguration(YourOrgTest25Test25Url);

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

@@ -0,0 +1,31 @@
+// @ts-nocheck
+export const configProps = {
+  value: '',
+  label: 'URL Sample',
+  placeholder: 'URL Placeholder',
+  helperText: 'URL Helper Text',
+  testId: 'url-12345678',
+  hasSuggestions: false,
+  displayMode: '',
+  variant: '',
+  hideLabel: false,
+  readOnly: false,
+  required: false,
+  disabled: false,
+  status: '',
+  validatemessage: ''
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Text',
+  maxLength: 256,
+  displayAs: 'pxURL',
+  label: 'URL sample',
+  validateAs: 'pxIsValidURL'
+};
+
+export const stateProps = {
+  value: '.URLSample',
+  hasSuggestions: false
+};

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25URL/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_test25URL/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_test25URL/text-url.tsx

@@ -0,0 +1,156 @@
+// @ts-nocheck
+import { useState, useRef, Fragment } from 'react';
+import { EmailDisplay, PhoneDisplay, URLDisplay, Image, Button, Lightbox } from '@pega/cosmos-react-core';
+
+export const formatExists = formatterVal => {
+  const formatterValues = ['TextInput', 'WorkStatus', 'RichText', 'Email', 'Phone', 'URL', 'Operator'];
+  let isformatter = false;
+  if (formatterValues.includes(formatterVal)) {
+    isformatter = true;
+  }
+  return isformatter;
+};
+
+const urlLabelVal = (urlLabelSelection, btnVal, urlLabel, propUrlLabel) => {
+  if ((urlLabel !== '' || propUrlLabel !== '') && btnVal !== null) {
+    switch (urlLabelSelection) {
+      case 'constant': {
+        btnVal = urlLabel;
+        break;
+      }
+      case 'propertyRef': {
+        btnVal = propUrlLabel;
+        break;
+      }
+      // no default
+    }
+  }
+  return btnVal;
+};
+
+const isImage = url => /\.(jpg|jpeg|png|webp|avif|gif|svg)$/.test(url);
+
+const TableImage = imageProps => {
+  const { value, altText, altTextOfImage, propaltTextOfImage, urlLabelSelection, urlLabel, propUrlLabel } = imageProps;
+  const demoButtonRef = useRef(null);
+  let imageDisplayComp = null;
+  const [images, setImages] = useState(null);
+  const imgDescription = {
+    id: 'url',
+    name: urlLabelSelection === 'constant' ? urlLabel : propUrlLabel,
+    description: altText === 'constant' ? altTextOfImage : propaltTextOfImage,
+    src: value
+  };
+  const onClick = () => {
+    setImages([imgDescription]);
+  };
+  const onItemDownload = async id => {
+    const a = document.createElement('a');
+    a.href = await fetch(images[0].src)
+      .then(response => {
+        return response.blob();
+      })
+      .then(blob => {
+        return URL.createObjectURL(blob);
+      });
+    a.download = images?.find(image => image.id === id)?.name ?? id;
+    document.body.appendChild(a);
+    a.click();
+    document.body.removeChild(a);
+  };
+  let btnVal = value;
+  btnVal = urlLabelVal(urlLabelSelection, btnVal, urlLabel, propUrlLabel);
+  imageDisplayComp = (
+    <Fragment>
+      {btnVal !== null && (
+        <Button ref={demoButtonRef} variant='link' compact={false} onClick={onClick} autoFocus>
+          {btnVal}
+        </Button>
+      )}
+      {images && (
+        <Lightbox
+          items={images}
+          cycle={false}
+          onAfterClose={() => {
+            setImages(null);
+            demoButtonRef.current?.focus();
+          }}
+          onItemDownload={isImage(images[0].src) ? onItemDownload : undefined}
+        />
+      )}
+    </Fragment>
+  );
+  return imageDisplayComp;
+};
+
+export const textFormatter = (formatter, value) => {
+  let displayComponent = 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;
+};
+
+/**
+ * Returns a URL display component based on the options
+ * @function urlFormatter
+ * @param {string} value value
+ * @param {object} options options for formatting
+ * { displayAs,tableDisplayAs,isTableFormatter,altText,altTextOfImage,propaltTextOfImage,urlLabelSelection, urlLabel,propUrlLabel, widthSel, customWidth}
+ */
+export const urlFormatter = (value, options) => {
+  const {
+    displayAs,
+    tableDisplayAs,
+    isTableFormatter,
+    altText,
+    altTextOfImage,
+    propaltTextOfImage,
+    urlLabelSelection,
+    urlLabel,
+    propUrlLabel,
+    widthSel,
+    customWidth
+  } = options;
+
+  let urlFormatComp = null;
+  if ((displayAs === 'labelText' || (isTableFormatter && tableDisplayAs === 'link')) && (urlLabel !== '' || propUrlLabel !== '')) {
+    urlFormatComp = (
+      <URLDisplay target='_blank' value={value} displayText={urlLabelSelection === 'constant' ? urlLabel : propUrlLabel} variant='link' />
+    );
+  } else if ((displayAs === 'Image' || tableDisplayAs === 'Image') && !!value) {
+    if (isTableFormatter) {
+      urlFormatComp = TableImage({
+        value,
+        altText,
+        altTextOfImage,
+        propaltTextOfImage,
+        urlLabelSelection,
+        urlLabel,
+        propUrlLabel
+      });
+    } else {
+      const width = widthSel === 'widthpx' ? customWidth : null;
+      urlFormatComp = <Image src={value} width={width} alt={altText === 'constant' ? altTextOfImage : propaltTextOfImage} />;
+    }
+  } else {
+    urlFormatComp = <URLDisplay target='_blank' value={value} displayText={value} variant='link' />;
+  }
+  return urlFormatComp;
+};

package/tests/assets/sdk-r/components/createAll/custom-constellation/template/Pega_DXIL_MyDetails/Avatar.tsx

@@ -22,8 +22,8 @@ function Avatar(props: PegaDxilMyDetailsAvatarProps) {
   // TODO Below if conditions can be removed once we have apis to get worklist/mywork info
   // This is non CaseView case (Dashboard, MyWork etc)
   if (!metaObj) {
-    userName = PCore.getEnvironmentInfo().getOperatorName();
-    userIdentifier = PCore.getEnvironmentInfo().getOperatorIdentifier();
+    userName = PCore.getEnvironmentInfo().getOperatorName() ?? "";
+    userIdentifier = PCore.getEnvironmentInfo().getOperatorIdentifier() ?? "";
   } else {
     userName = metaObj.name;
     userIdentifier = metaObj.ID;
@@ -46,22 +46,20 @@ function Avatar(props: PegaDxilMyDetailsAvatarProps) {
     const currentState = PCore.getMessagingServiceManager().getUserPresence().getUserState(userIdentifier);
     const [userState, setUserState]: any  = useState(currentState === 'online' ? 'active' : 'inactive');
 
-    // @ts-ignore
-    const handleUserStateChange = ({ state }) => {
+    const handleUserStateChange = ({ state }: any) => {
       setUserState(state === 'online' ? 'active' : 'inactive');
     };
 
     useEffect(() => {
       const subId = PCore.getMessagingServiceManager()
         .getUserPresence()
-        // @ts-ignore
-        .subscribe(userIdentifier, handleUserStateChange);
+        .subscribe(userIdentifier, handleUserStateChange, '');
 
       return function cleanup() {
         PCore.getMessagingServiceManager().getUserPresence().unsubscribe(userIdentifier, subId);
       };
     }, [userIdentifier, handleUserStateChange]);
-    // @ts-ignore
+
     return <CosmosAvatar name={userName} imageSrc={imageBlobUrl as React.SetStateAction<any>} status={userState} />;
   }
 

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

@@ -8,6 +8,16 @@ import { pyReviewRaw, pyReviewResolved, regionChildrenResolved, operatorDetails,
 import StatusWorkRenderer from './StatusWork';
 import Operator from './Operator';
 
+window.PCore.getUserApi = (): any => {
+  return {
+    getOperatorDetails: () => {
+      return new Promise(resolve => {
+        resolve(operatorDetails);
+      });
+    }
+  };
+};
+
 const meta: Meta<typeof PegaDxilMyDetails> = {
   title: 'PegaDxilMyDetails',
   component: PegaDxilMyDetails,

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

@@ -1,7 +1,6 @@
 
 /* eslint-disable react/jsx-no-useless-fragment */
 /* eslint-disable react/no-unstable-nested-components */
-// @ts-nocheck
 import type { Meta, StoryObj } from '@storybook/react';
 
 import { AppAnnouncement as PegaAppAnnouncement } from '@pega/cosmos-react-work';
@@ -19,18 +18,6 @@ export default meta;
 type Story = StoryObj<typeof PegaDxilMyPage>;
 
 export const BasePegaDxilMyPage: Story = args => {
-  if (!window.PCore) {
-    window.PCore = {};
-  }
-
-  window.PCore.getLocaleUtils = () => {
-    return {
-      getLocaleValue: val => {
-        return val;
-      }
-    };
-  };
-
   const configProps = pyHome1Resolved.children[0].children[0].config;
 
   const props = {
@@ -86,6 +73,7 @@ export const BasePegaDxilMyPage: Story = args => {
               />
             );
           }
+          return <></>;
         },
         ignoreSuggestion: () => {/* nothing */},
         acceptSuggestion: () => {/* nothing */},

package/tests/assets/sdk-r/components/createAll/custom-constellation/template/Pega_DXIL_MyTwoColumnDetails/Avatar.tsx

@@ -22,8 +22,8 @@ function Avatar(props: PegaDxilMyTwoColumnDetailsAvatarProps) {
   // TODO Below if conditions can be removed once we have apis to get worklist/mywork info
   // This is non CaseView case (Dashboard, MyWork etc)
   if (!metaObj) {
-    userName = PCore.getEnvironmentInfo().getOperatorName();
-    userIdentifier = PCore.getEnvironmentInfo().getOperatorIdentifier();
+    userName = PCore.getEnvironmentInfo().getOperatorName() ?? "";
+    userIdentifier = PCore.getEnvironmentInfo().getOperatorIdentifier() ?? "";
   } else {
     userName = metaObj.name;
     userIdentifier = metaObj.ID;
@@ -46,22 +46,20 @@ function Avatar(props: PegaDxilMyTwoColumnDetailsAvatarProps) {
     const currentState = PCore.getMessagingServiceManager().getUserPresence().getUserState(userIdentifier);
     const [userState, setUserState]: any  = useState(currentState === 'online' ? 'active' : 'inactive');
 
-    // @ts-ignore
-    const handleUserStateChange = ({ state }) => {
+    const handleUserStateChange = ({ state }: any) => {
       setUserState(state === 'online' ? 'active' : 'inactive');
     };
 
     useEffect(() => {
       const subId = PCore.getMessagingServiceManager()
         .getUserPresence()
-        // @ts-ignore
-        .subscribe(userIdentifier, handleUserStateChange);
+        .subscribe(userIdentifier, handleUserStateChange, '');
 
       return function cleanup() {
         PCore.getMessagingServiceManager().getUserPresence().unsubscribe(userIdentifier, subId);
       };
     }, [userIdentifier, handleUserStateChange]);
-    // @ts-ignore
+
     return <CosmosAvatar name={userName} imageSrc={imageBlobUrl as React.SetStateAction<any>} status={userState} />;
   }
 

package/tests/assets/sdk-r/components/createAll/custom-constellation/template/YourOrg_test25_test25Details/Avatar.tsx

@@ -0,0 +1,70 @@
+import React from 'react';
+import { useEffect, useState } from 'react';
+import { Avatar as CosmosAvatar, withConfiguration } from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
+
+// interface for props
+interface YourOrgTest25Test25DetailsAvatarProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  metaObj: any;
+  showStatus: boolean;
+}
+
+function Avatar(props: YourOrgTest25Test25DetailsAvatarProps) {
+  const { metaObj, showStatus = false } = props;
+  const [imageBlobUrl, setImageBlobUrl] = useState(null);
+  let userName: string;
+  let userIdentifier: string;
+
+  // TODO Below if conditions can be removed once we have apis to get worklist/mywork info
+  // This is non CaseView case (Dashboard, MyWork etc)
+  if (!metaObj) {
+    userName = PCore.getEnvironmentInfo().getOperatorName() ?? '';
+    userIdentifier = PCore.getEnvironmentInfo().getOperatorIdentifier() ?? '';
+  } else {
+    userName = metaObj.name;
+    userIdentifier = metaObj.ID;
+  }
+  if (!userName && userIdentifier) {
+    userName = userIdentifier;
+  }
+
+  useEffect(() => {
+    const imageKey = !metaObj ? PCore.getEnvironmentInfo().getOperatorImageInsKey() : metaObj.image;
+    if (imageKey) {
+      PCore.getAssetLoader()
+        .getSvcImage(imageKey)
+        .then(blob => window.URL.createObjectURL(blob))
+        .then(imagePath => setImageBlobUrl(imagePath as React.SetStateAction<any>));
+    }
+  }, [metaObj]);
+
+  if (showStatus) {
+    const currentState = PCore.getMessagingServiceManager().getUserPresence().getUserState(userIdentifier);
+    const [userState, setUserState]: any = useState(currentState === 'online' ? 'active' : 'inactive');
+
+    const handleUserStateChange = ({ state }: any) => {
+      setUserState(state === 'online' ? 'active' : 'inactive');
+    };
+
+    useEffect(() => {
+      const subId = PCore.getMessagingServiceManager().getUserPresence().subscribe(userIdentifier, handleUserStateChange, '');
+
+      return function cleanup() {
+        PCore.getMessagingServiceManager().getUserPresence().unsubscribe(userIdentifier, subId);
+      };
+    }, [userIdentifier, handleUserStateChange]);
+
+    return <CosmosAvatar name={userName} imageSrc={imageBlobUrl as React.SetStateAction<any>} status={userState} />;
+  }
+
+  // Do not render when userName does not exists
+  // TODO : In CNR case, pxRequestor is not available, please remove this condition once it populates
+  if (!userName) {
+    return null;
+  }
+
+  return <CosmosAvatar name={userName} imageSrc={imageBlobUrl as React.SetStateAction<any>} />;
+}
+
+export default withConfiguration(Avatar);

package/tests/assets/sdk-r/components/createAll/custom-constellation/template/YourOrg_test25_test25Details/DetailsRender.tsx

@@ -0,0 +1,50 @@
+import { Fragment, 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, i: number) => {
+    const { type } = value.getPConnect().getRawMetadata();
+    const { hideLabel, variant, testId, label } = value.getPConnect().resolveConfigProps(value.getPConnect().getConfigProps());
+
+    let displayComp;
+    const key = JSON.stringify(value.getPConnect());
+    const key1 = key.concat(`-${i}`);
+
+    if (type === 'reference') {
+      const refElement = value.getPConnect().getComponent();
+
+      displayCompArr.push(refElement);
+    } else {
+      const element = value.getPConnect().getComponent();
+      const displayEl = <Fragment key={key}>{element}</Fragment>;
+
+      displayComp = (
+        <Fragment key={key1}>
+          <FieldValueList
+            style={{ columnGap: '0' }}
+            variant={hideLabel ? 'stacked' : variant}
+            data-testid={testId}
+            fields={[{ id: '1', name: hideLabel ? '' : label, value: displayEl }]}
+          />
+        </Fragment>
+      );
+
+      displayCompArr.push(displayComp);
+    }
+  });
+
+  return <>{displayCompArr}</>;
+};
+
+export default DetailsRender;