@pega/custom-dx-components 23.1.11 → 23.1.13

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MySearchbox/demo.stories.tsx

@@ -2,19 +2,22 @@
 /* eslint-disable react/jsx-no-useless-fragment */
 // @ts-nocheck
 import { useState } from 'react';
-import { withKnobs } from '@storybook/addon-knobs';
+import type { Meta, StoryObj } from '@storybook/react';
 
 import { configProps, rawMetadata, fieldMetadata, stateProps } from './mock';
 
 import PegaDxilMySearchbox from './index';
 
-export default {
+const meta: Meta<typeof PegaDxilMySearchbox> = {
   title: 'PegaDxilMySearchbox',
-  decorators: [withKnobs],
-  component: PegaDxilMySearchbox
+  component: PegaDxilMySearchbox,
+  excludeStories: /.*Data$/
 };
 
-export const BasePegaDxilMySearchbox = () => {
+export default meta;
+type Story = StoryObj<typeof PegaDxilMySearchbox>;
+
+export const BasePegaDxilMySearchbox: Story = args => {
 
   const [value, setValue] = useState(configProps.value);
   const datasourceMetadata = fieldMetadata;
@@ -33,7 +36,7 @@ export const BasePegaDxilMySearchbox = () => {
     parameters: {},
     datasourceMetadata,
     fieldMetadata,
-
+    validatemessage: '',
     getPConnect: () => {
       return {
         getConfigProps: () => {
@@ -84,7 +87,22 @@ export const BasePegaDxilMySearchbox = () => {
 
   return (
     <>
-      <PegaDxilMySearchbox {...props} />
+      <PegaDxilMySearchbox {...props} {...args} />
     </>
   );
 };
+
+BasePegaDxilMySearchbox.args = {
+  label: configProps.label,
+  helperText: configProps.helperText,
+  placeholder: configProps.placeholder,
+  isTableFormatter: false,
+  testId: configProps.testId,
+  readOnly: configProps.readOnly,
+  disabled: configProps.disabled,
+  required: configProps.required,
+  status: configProps.status,
+  hideLabel: configProps.hideLabel,
+  displayMode: configProps.displayMode,
+  validatemessage: configProps.validatemessage
+};

package/{src/tasks/create/templates/Constellation/Field/Picklist-Autocomplete/embed-utils.js.mustache → tests/assets/components/createAll/Launchpad/Pega_DXIL_MySearchbox/embed-utils.ts}

@@ -1,4 +1,5 @@
-import { isEmbeddedField, isPageListInPath, PAGE, PAGELIST, buildAggOrCalcId } from './repeat-utils.js';
+// @ts-nocheck
+import { isEmbeddedField, isPageListInPath, PAGE, PAGELIST, buildAggOrCalcId } from './repeat-utils';
 
 export const AT_FILTEREDLIST = '@FILTERED_LIST';
 export const AT_PROPERTY = '@P';

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MySearchbox/index.tsx

@@ -1,8 +1,7 @@
 /* eslint-disable react-hooks/exhaustive-deps */
 /* eslint-disable sonarjs/cognitive-complexity */
-import { useEffect, useRef, useState, memo, useMemo, type MutableRefObject, type SetStateAction } from 'react';
-import { ComboBox, menuHelpers, debounce, throttle, Button, Icon, type MenuGroupProps, type MenuItemProps } from '@pega/cosmos-react-core';
-import PropTypes from 'prop-types';
+import { useEffect, useRef, useState, useMemo, type MutableRefObject, type SetStateAction } from 'react';
+import { ComboBox, menuHelpers, debounce, throttle, Button, Icon, withConfiguration, type MenuGroupProps, type MenuItemProps } from '@pega/cosmos-react-core';
 import get from 'lodash.get';
 import type { PConnFieldProps } from './PConnProps';
 
@@ -10,10 +9,10 @@ import type { PConnFieldProps } from './PConnProps';
 import handleEvent from "./event-utils";
 import { suggestionsHandler } from './suggestions-handler';
 
-import { formatExists, textFormatter } from './textformat-utils.jsx';
-import { flattenParameters } from './picklist-utils.js';
-import { isSelfReferencedProperty, getDescriptorsFieldName } from './repeat-utils.js';
-import { getFieldNameFromEmbeddedFieldName } from './embed-utils.js';
+import { formatExists, textFormatter } from './textformat-utils';
+import { flattenParameters } from './picklist-utils';
+import { isSelfReferencedProperty, getDescriptorsFieldName } from './repeat-utils';
+import { getFieldNameFromEmbeddedFieldName } from './embed-utils';
 
 import { usePaginate, useDeepMemo, useIsMount, updatePropertiesForNewRecord } from './utils';
 
@@ -378,17 +377,17 @@ const DisplayComponent = (props: PegaDxilMySearchboxPropsSubSet) => {
 
 // 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 function PegaDxilMySearchbox(props: PegaDxilMySearchboxProps) {
+function PegaDxilMySearchbox(props: PegaDxilMySearchboxProps) {
   const {
     getPConnect,
     value,
     placeholder,
     validatemessage,
     label,
-    hideLabel,
+    hideLabel = false,
     helperText,
     testId,
-    matchPosition,
+    matchPosition = 'contains',
     maxResultsDisplay,
     cacheLifeSpan,
     displayMode,
@@ -396,17 +395,17 @@ export function PegaDxilMySearchbox(props: PegaDxilMySearchboxProps) {
     createNewRecord,
     datasourceMetadata,
     deferDatasource,
-    additionalProps,
+    additionalProps = {},
     referenceType,
     primaryField,
-    isTableFormatter,
+    isTableFormatter = false,
     descriptors,
     dataRelationshipContext,
-    hasSuggestions,
+    hasSuggestions = false,
     contextClass
   } = props;
   const { formatter } = props;
-  let { listType, datasource, parameters, columns } = props;
+  let { listType, datasource = [], parameters = {}, columns = [] } = props;
 
   // enable searhing based on the key
   const { isSearchableOnKey } = props;
@@ -488,7 +487,7 @@ export function PegaDxilMySearchbox(props: PegaDxilMySearchboxProps) {
   }
 
   // BUG-547602: Temporary type coercion for 8.5 until DXAPIs are enhanced to pass original pxViewMetadata JSON, respecting boolean primitives
-  let { readOnly, required, disabled } = props;
+  let { readOnly = false, required = false, disabled = false } = props;
   [readOnly, required, disabled] = [readOnly, required, disabled].map(
     prop => prop === true || (typeof prop === 'string' && prop === 'true')
   );
@@ -1172,65 +1171,5 @@ export function PegaDxilMySearchbox(props: PegaDxilMySearchboxProps) {
   );
 }
 
-export default memo(PegaDxilMySearchbox);
 
-PegaDxilMySearchbox.defaultProps = {
-  value: '',
-  matchPosition: 'contains',
-  maxResultsDisplay: '',
-  placeholder: '',
-  hideLabel: false,
-  validatemessage: '',
-  helperText: '',
-  disabled: false,
-  readOnly: false,
-  required: false,
-  testId: '',
-  datasource: [],
-  listType: '',
-  parameters: {},
-  columns: [],
-  cacheLifeSpan: '',
-  displayMode: null,
-  onRecordChange: null,
-  datasourceMetadata: null,
-  deferDatasource: false,
-  additionalProps: {},
-  formatter: '',
-  referenceType: null,
-  isTableFormatter: false,
-  primaryField: '',
-  hasSuggestions: false
-};
-
-PegaDxilMySearchbox.propTypes = {
-  value: PropTypes.string,
-  maxResultsDisplay: PropTypes.string,
-  matchPosition: PropTypes.string,
-  placeholder: PropTypes.string,
-  label: PropTypes.string.isRequired,
-  hideLabel: PropTypes.bool,
-  getPConnect: PropTypes.func.isRequired,
-  validatemessage: PropTypes.string,
-  helperText: PropTypes.string,
-  disabled: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
-  readOnly: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
-  required: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
-  testId: PropTypes.string,
-  datasource: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.any), PropTypes.string]),
-  listType: PropTypes.string,
-  parameters: PropTypes.objectOf(PropTypes.any),
-  columns: PropTypes.arrayOf(PropTypes.object),
-  cacheLifeSpan: PropTypes.string,
-  displayMode: PropTypes.string,
-  createNewRecord: PropTypes.func,
-  onRecordChange: PropTypes.func,
-  datasourceMetadata: PropTypes.objectOf(PropTypes.any),
-  deferDatasource: PropTypes.bool,
-  additionalProps: PropTypes.objectOf(PropTypes.any),
-  formatter: PropTypes.string,
-  referenceType: PropTypes.string,
-  primaryField: PropTypes.string,
-  isTableFormatter: PropTypes.bool,
-  hasSuggestions: PropTypes.bool
-};
+export default withConfiguration(PegaDxilMySearchbox);

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MySearchbox/mock.ts

@@ -20,7 +20,14 @@ export const configProps = {
   ],
   helperText: 'Picklist Helper Text',
   testId: 'picklist-12345678',
-  hasSuggestions: false
+  hasSuggestions: false,
+  displayMode: '',
+  hideLabel: false,
+  readOnly: false,
+  required: false,
+  disabled: false,
+  status: '',
+  validatemessage: ''
 };
 
 export const stateProps = {

package/{src/tasks/create/templates/Constellation/Field/Picklist-Autocomplete/picklist-utils.js.mustache → tests/assets/components/createAll/Launchpad/Pega_DXIL_MySearchbox/picklist-utils.ts}

@@ -1,4 +1,5 @@
 // import { object } from 'prop-types';
+// @ts-nocheck
 
 export const flattenParameters = (parameters = {}) => {
   const flatParams = {};

package/{src/tasks/create/templates/Constellation/Field/Picklist-Autocomplete/repeat-constants.js.mustache → tests/assets/components/createAll/Launchpad/Pega_DXIL_MySearchbox/repeat-constants.ts}

@@ -1,7 +1,7 @@
 export const apiRetryConfig = {
   TIMEOUT: {
     numberOfRetries: 1,
-    retryOnCondition: (serverApiResponse) => serverApiResponse?.status === 599,
+    retryOnCondition: (serverApiResponse: any) => serverApiResponse?.status === 599,
     retryWithOptions: { useExtendedTimeout: true }
   }
 };

package/tests/assets/components/createAll/{Constellation/Pega_DXIL_MySearchbox/repeat-utils.js → Launchpad/Pega_DXIL_MySearchbox/repeat-utils.ts}

@@ -1,15 +1,14 @@
 /* eslint-disable sonarjs/no-collapsible-if */
-/* eslint-disable default-param-last */
 /* eslint-disable func-names */
-/* eslint-disable no-undef */
+// @ts-nocheck
 import { splitConditionTree } from '@pega/cosmos-react-condition-builder';
 import cloneDeep from 'lodash/cloneDeep.js';
 
-import DateTimeFormatter from './date.js';
-import Constants from './component-constants.js';
+import DateTimeFormatter from './date';
+import Constants from './component-constants';
 
-import { getEmbeddedFieldName, mergePageListFieldAggregation } from './embed-utils.js';
-import { confirmationModalLabels } from './repeat-constants.js';
+import { getEmbeddedFieldName, mergePageListFieldAggregation } from './embed-utils';
+import { confirmationModalLabels } from './repeat-constants';
 
 export const SIMPLE_TABLE_MANUAL_READONLY = 'SimpleTableManualReadOnly';
 export const PAGE = '!P!';
@@ -65,10 +64,8 @@ export function launchLocalAction(getPConnect, rowContext, action, cb) {
     name: action.name,
     callbacks: {
       submit: (response) => {
-        /* eslint-disable no-console */
         console.log('callback for modal submit');
         console.log(response);
-        /* eslint-enable no-console */
         cb();
       },
       cancel: () => {
@@ -97,18 +94,14 @@ export function launchBulkAction(getPConnect, selectedList, action, caseTypeID,
     bulkContextType,
     callbacks: {
       submit: (response) => {
-        /* eslint-disable no-console */
         console.log(response);
         console.log('callback for modal submit 1');
-        /* eslint-enable no-console */
         if (typeof cb === 'function') {
           cb();
         }
       },
       cancel: () => {
-        /* eslint-disable no-console */
         console.log('callback for modal submit 2');
-        /* eslint-enable no-console */
       }
     },
     showProgress: true,
@@ -278,6 +271,7 @@ export function getDescriptorsFieldName(property, pageClass) {
   return property;
 }
 
+// eslint-disable-next-line @typescript-eslint/default-param-last, sonarjs/cognitive-complexity
 export function preparePatchQueryFields(fields, isDataObject = false, classID = '', getPConnect) {
   const queryFields = [];
   // Descriptors can be configured only for single selectionMode properties

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MySearchbox/styles.ts

@@ -1,15 +1,8 @@
-
-// 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;
-//  `;
-// });
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 0px 0;
+  `;
+});

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MySearchbox/textformat-utils.tsx

@@ -0,0 +1,181 @@
+// @ts-nocheck
+import {
+  EmailDisplay,
+  PhoneDisplay,
+  URLDisplay,
+  Image,
+  Button,
+  Lightbox
+} from '@pega/cosmos-react-core';
+import { useRef, useState } from 'react';
+
+export const formatExists = formatterVal => {
+  const formatterValues = ['TextInput', 'Email', 'Phone'];
+  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 = (
+    <>
+      {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}
+        />
+      )}
+    </>
+  );
+  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;
+    }
+    // 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/components/createAll/Launchpad/Pega_DXIL_MySearchbox/utils.ts

@@ -2,7 +2,7 @@ import { useEffect, useRef } from 'react';
 import equal from 'fast-deep-equal';
 import get from 'lodash.get';
 
-import { getFieldNameFromEmbeddedFieldName } from './embed-utils.js';
+import { getFieldNameFromEmbeddedFieldName } from './embed-utils';
 
 import { buildColumnForDisplayValue, setValuesToPropertyList } from './index';
 

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyText/demo.stories.tsx

@@ -2,19 +2,22 @@
 /* eslint-disable react/jsx-no-useless-fragment */
 // @ts-nocheck
 import { useState } from 'react';
-import { withKnobs } from '@storybook/addon-knobs';
+import type { Meta, StoryObj } from '@storybook/react';
 
 import { stateProps, configProps } from './mock';
 
 import PegaDxilMyText from './index';
 
-export default {
+const meta: Meta<typeof PegaDxilMyText> = {
   title: 'PegaDxilMyText',
-  decorators: [withKnobs],
-  component: PegaDxilMyText
+  component: PegaDxilMyText,
+  excludeStories: /.*Data$/
 };
 
-export const BasePegaDxilMyText = () => {
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyText>;
+
+export const BasePegaDxilMyText: Story = args => {
 
   const [value, setValue] = useState(configProps.value);
 
@@ -48,7 +51,21 @@ export const BasePegaDxilMyText = () => {
 
   return (
     <>
-      <PegaDxilMyText {...props} />
+      <PegaDxilMyText {...props} {...args} />
     </>
   );
 };
+
+BasePegaDxilMyText.args = {
+  label: configProps.label,
+  helperText: configProps.helperText,
+  placeholder: configProps.placeholder,
+  testId: configProps.testId,
+  readOnly: configProps.readOnly,
+  disabled: configProps.disabled,
+  required: configProps.required,
+  status: configProps.status,
+  hideLabel: configProps.hideLabel,
+  displayMode: configProps.displayMode,
+  validatemessage: configProps.validatemessage
+};

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyText/index.tsx

@@ -1,5 +1,4 @@
-import PropTypes from 'prop-types';
-import { Input } from '@pega/cosmos-react-core';
+import { Input, withConfiguration } from '@pega/cosmos-react-core';
 
 import type { PConnFieldProps } from './PConnProps';
 
@@ -21,8 +20,8 @@ interface StateProps {
 
 // 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 PegaDxilMyText(props: PegaDxilMyTextProps) {
-  const { getPConnect, value, placeholder, disabled, readOnly, required, label, hideLabel, testId } = props;
+function PegaDxilMyText(props: PegaDxilMyTextProps) {
+  const { getPConnect, value, placeholder, disabled = false, readOnly = false, required = false, label, hideLabel = false, testId } = props;
 
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
@@ -52,22 +51,5 @@ export default function PegaDxilMyText(props: PegaDxilMyTextProps) {
   );
 };
 
-PegaDxilMyText.defaultProps = {
-  value: '',
-  placeholder: '',
-  disabled: false,
-  readOnly: false,
-  required: false,
-  testId: ''
-};
 
-PegaDxilMyText.propTypes = {
-  label: PropTypes.string,
-  value: PropTypes.string,
-  placeholder: PropTypes.string,
-  getPConnect: PropTypes.func.isRequired,
-  disabled: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
-  readOnly: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
-  required: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
-  testId: PropTypes.string
-};
+export default withConfiguration(PegaDxilMyText);

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyText/mock.ts

@@ -6,7 +6,14 @@ export const configProps = {
   placeholder: 'Text Placeholder',
   helperText: 'Text Helper Text',
   testId: 'Text-12345678',
-  hasSuggestions: false
+  hasSuggestions: false,
+  displayMode: '',
+  hideLabel: false,
+  readOnly: false,
+  required: false,
+  disabled: false,
+  status: '',
+  validatemessage: ''
 };
 
 export const stateProps = {

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyText/styles.ts

@@ -1,15 +1,8 @@
-
-// 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;
-//  `;
-// });
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 0px 0;
+  `;
+});