@pega/custom-dx-components 26.1.10 → 26.1.11-alpha-0.2

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

@@ -1,181 +0,0 @@
-// @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/library/components/createAll/Constellation/Pega_DXIL_MySearchbox/utils.ts

@@ -1,221 +0,0 @@
-import { useEffect, useRef } from 'react';
-import equal from 'fast-deep-equal';
-import get from 'lodash.get';
-
-import { getFieldNameFromEmbeddedFieldName } from './embed-utils';
-
-import { buildColumnForDisplayValue, setValuesToPropertyList } from './index';
-
-export function usePaginate() {
-  const paginatationProperties = useRef({
-    startIndex: 0,
-    endIndex: 50,
-    matchPosition: '',
-    totalRecords: []
-  });
-
-  useEffect(() => {
-    // clean up on unmount
-    return () => {
-      // @ts-ignore
-      paginatationProperties.current = null;
-    };
-  }, []);
-
-  const getInitialPaginatedRecords = (totalRecords: any, matchPosition: string) => {
-    const initialPaginatedRecords = totalRecords.slice(0, 50);
-    paginatationProperties.current.startIndex = 0;
-    paginatationProperties.current.endIndex = 50;
-    paginatationProperties.current.matchPosition = matchPosition;
-    paginatationProperties.current.totalRecords = totalRecords;
-    return initialPaginatedRecords;
-  };
-
-  const positionMatches = (text: string, searchText: string) => {
-    switch (paginatationProperties.current.matchPosition) {
-      case 'start':
-        return text.toLowerCase().startsWith(searchText.toLowerCase());
-      case 'contains':
-        return text.toLowerCase().includes(searchText.toLowerCase());
-      default:
-        return false;
-    }
-  };
-
-  const fetchData = (searchText: string, onScroll: boolean, columns = []) => {
-    let progressivePaginatedRecords;
-    paginatationProperties.current.startIndex += 50;
-    paginatationProperties.current.endIndex += 50;
-
-    if (searchText === '' || searchText === undefined || searchText === null) {
-      // paginate on entire resultset
-      progressivePaginatedRecords = paginatationProperties.current.totalRecords.slice(
-        paginatationProperties.current.startIndex,
-        paginatationProperties.current.endIndex
-      );
-    } else if (onScroll) {
-      // paginate on filtered resultset
-      // @ts-ignore
-      progressivePaginatedRecords = paginatationProperties.current.filteredRecords.slice(
-        paginatationProperties.current.startIndex,
-        paginatationProperties.current.endIndex
-      );
-    } else {
-      // @ts-ignore
-      const searchInSecondaryItem = columns.some(e => e.secondary && e.useForSearch);
-      // Filter the items and paginate on filtered resultset
-      const filteredRecords = paginatationProperties.current.totalRecords.filter(
-        filteritem =>
-          // @ts-ignore
-          (filteritem.primary && positionMatches(filteritem.primary, searchText)) ||
-          (searchInSecondaryItem &&
-            // @ts-ignore
-            filteritem.secondary &&
-            // @ts-ignore
-            filteritem.secondary.length > 0 &&
-            // @ts-ignore
-            filteritem.secondary.find(item => positionMatches(item, searchText)))
-      );
-      progressivePaginatedRecords = filteredRecords.slice(
-        paginatationProperties.current.startIndex,
-        paginatationProperties.current.endIndex
-      );
-      // @ts-ignore
-      paginatationProperties.current.filteredRecords = filteredRecords;
-    }
-    return progressivePaginatedRecords;
-  };
-
-  const resetIndexes = () => {
-    paginatationProperties.current.startIndex = -50;
-    paginatationProperties.current.endIndex = 0;
-  };
-
-  const hasMoreResults = (searchText: string) => {
-    if (searchText === '' || searchText === undefined || searchText === null) {
-      return (
-        paginatationProperties.current.startIndex + 50 <
-        paginatationProperties.current.totalRecords.length
-      );
-    }
-    return (
-      // @ts-ignore
-      paginatationProperties.current.startIndex + 50 <
-      // @ts-ignore
-      paginatationProperties.current.filteredRecords.length
-    );
-  };
-
-  return {
-    getInitialPaginatedRecords,
-    fetchData,
-    resetIndexes,
-    hasMoreResults
-  };
-}
-
-export function useDeepMemo(memoFn: any, key: any) {
-  const ref = useRef();
-  // @ts-ignore
-  if (!ref.current || !equal(key, ref.current.key)) {
-    // @ts-ignore
-    ref.current = { key, value: memoFn() };
-  }
-  // @ts-ignore
-  return ref.current.value;
-}
-
-export function useIsMount() {
-  const isMountRef = useRef(true);
-  useEffect(() => {
-    isMountRef.current = false;
-  }, []);
-  return isMountRef.current;
-}
-
-const transformSearchedItem = (
-  displayResponseData: any,
-  displayFieldMeta: any,
-  columnsWithSetProperty: any,
-  dataApiObj: any
-) => {
-  // @ts-ignore
-  return displayResponseData.map(entry => {
-    const secondaryArr: Array<any> = [];
-    const secondaryFieldValues: Array<any> = [];
-    // @ts-ignore
-    displayFieldMeta.current.secondary.forEach(col => {
-      if (!displayFieldMeta.hidden?.includes(col)) secondaryArr.push(entry[col]);
-      if (columnsWithSetProperty.includes(col)) {
-        if (dataApiObj.isQueryable) {
-          secondaryFieldValues.push(entry[col]);
-        } else {
-          secondaryFieldValues.push(get(entry, getFieldNameFromEmbeddedFieldName(col)));
-        }
-      }
-    });
-    return {
-      id: entry[displayFieldMeta.current.key],
-      primary: entry[displayFieldMeta.current.primary],
-      secondary: secondaryArr,
-      secondaryFieldValues
-    };
-  });
-};
-
-// @ts-ignore
-export const updatePropertiesForNewRecord = (
-  dataConfig: any,
-  contextName: any,
-  dataApiObj: any,
-  setDataApiObj: any,
-  displayFieldMeta: any,
-  c11nEnv: any,
-  columns: Array<any>,
-  actions: any,
-  newCaseId: string
-) => {
-  PCore.getDataApi()
-    .init(dataConfig, contextName)
-    .then(dataObj => {
-      setDataApiObj(dataObj);
-      buildColumnForDisplayValue(dataObj);
-      // SET matchPosition to EQUALS to return exact matching record
-      // @ts-ignore
-      dataObj.matchPosition = 'equals';
-      // @ts-ignore
-      dataObj
-        .fetchData(newCaseId)
-        // @ts-ignore
-        .then((displayResponse: any) => {
-          let columnsWithSetProperty = [];
-          if (dataApiObj.columns) {
-            columnsWithSetProperty = dataApiObj.columns
-              // @ts-ignore
-              .filter(col => col.setProperty && col.setProperty !== 'Associated property')
-              // @ts-ignore
-              .map(col => col.value);
-          }
-          const displayResponseData = displayResponse.data || [];
-
-          const searchedItem = transformSearchedItem(
-            displayResponseData,
-            displayFieldMeta,
-            columnsWithSetProperty,
-            dataApiObj
-          );
-          setValuesToPropertyList(
-            searchedItem[0],
-            c11nEnv.getStateProps().value,
-            searchedItem[0],
-            columns,
-            actions
-          );
-        })
-        .finally(() => {
-          // RESET matchPosition
-          // @ts-ignore
-          dataObj.matchPosition = dataConfig.matchPosition;
-        });
-    });
-};

package/tests/assets/library/components/createAll/Constellation/Pega_DXIL_MyText/config.json

@@ -1,58 +0,0 @@
-{
-  "name": "Pega_DXIL_MyText",
-  "label": "My Text",
-  "description": "My Text",
-  "organization": "Pega",
-  "version": "0.0.1",
-  "library": "DXIL",
-  "componentKey": "Pega_DXIL_MyText",
-  "type": "Field",
-  "subtype": "Text",
-  "subtypeLabel": "Text",
-  "properties": [
-    {
-      "name": "label",
-      "label": "Label value",
-      "format": "TEXT"
-    },
-    {
-      "name": "placeholder",
-      "label": "Placeholder",
-      "format": "TEXT"
-    },
-    {
-      "name": "visibility",
-      "label": "Visible",
-      "format": "VISIBILITY"
-    },
-    {
-      "name": "disabled",
-      "label": "Disabled",
-      "format": "DISABLED"
-    },
-    {
-      "name": "required",
-      "label": "Required",
-      "format": "REQUIRED"
-    },
-    {
-      "label": "Advanced",
-      "format": "GROUP",
-      "collapsible": true,
-      "properties": [
-        {
-          "name": "testId",
-          "label": "Test ID",
-          "format": "TEXT",
-          "ignorePattern": "[^-_\\p{N}\\p{L}]",
-          "includeAnnotations": false
-        }
-      ]
-    }
-  ],
-  "defaultConfig": {
-    "detailFVLItem": true,
-    "isFormWidth" : false,
-    "isContainerWidth" : false
-  }
-}

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

@@ -1,67 +0,0 @@
-
-/* eslint-disable react/jsx-no-useless-fragment */
-import { useState } from 'react';
-import type { Meta, StoryObj } from '@storybook/react';
-
-import { stateProps, configProps } from './mock';
-
-import PegaDxilMyText from './index';
-
-const meta: Meta<typeof PegaDxilMyText> = {
-  title: 'PegaDxilMyText',
-  component: PegaDxilMyText,
-  excludeStories: /.*Data$/
-};
-
-export default meta;
-type Story = StoryObj<typeof PegaDxilMyText>;
-
-export const BasePegaDxilMyText: Story = (args: any) => {
-
-  const [value, setValue] = useState(configProps.value);
-
-  const props = {
-    value,
-    hasSuggestions: configProps.hasSuggestions,
-
-    getPConnect: () => {
-      return {
-        getStateProps: () => {
-          return stateProps;
-        },
-        getActionsApi: () => {
-          return {
-            updateFieldValue: (propName: string, theValue: any) => {
-              setValue(theValue);
-            },
-            triggerFieldChange: () => {/* nothing */}
-          };
-        },
-        ignoreSuggestion: () => {/* nothing */},
-        acceptSuggestion: () => {/* nothing */},
-        setInheritedProps: () => {/* nothing */},
-        resolveConfigProps: () => {/* nothing */}
-      };
-    }
-  };
-
-  return (
-    <>
-      <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/library/components/createAll/Constellation/Pega_DXIL_MyText/demo.test.tsx

@@ -1,19 +0,0 @@
-// import { expect, test } from '@jest/globals';
-import { render, screen } from '@testing-library/react';
-import { composeStories } from '@storybook/react';
-import '@testing-library/jest-dom';
-
-import * as DemoStories from './demo.stories';
-
-const { BasePegaDxilMyText } = composeStories(DemoStories);
-
-test('renders PegaDxilMyText', async () => {
-  render(<BasePegaDxilMyText />);
-  expect(await screen.findByText('Text Sample')).toBeVisible();
-
-
-  const textElement = (screen.getByTestId('Text-12345678:input:control') as HTMLInputElement);
-  expect(textElement.value).toBe('');
-
-  expect(textElement).toHaveAttribute('placeholder', 'Text Placeholder');
-});

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

@@ -1,146 +0,0 @@
-import {
-  Input,
-  FieldValueList,
-  Text,
-  EmailDisplay,
-  PhoneDisplay,
-  URLDisplay,
-  withConfiguration
-} from '@pega/cosmos-react-core';
-
-import type { PConnFieldProps } from '../shared/PConnProps';
-import '../shared/create-nonce';
-
-import StyledPegaDxilMyTextWrapper from './styles';
-
-// interface for props
-interface PegaDxilMyTextProps extends PConnFieldProps {
-  // If any, enter additional props that only exist on TextInput here
-  isTableFormatter?: boolean;
-  formatter: string;
-  variant?: any;
-}
-
-// 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: string) => {
-  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;
-};
-
-// 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 PegaDxilMyText(props: PegaDxilMyTextProps) {
-  const { getPConnect, value, placeholder, disabled = false, displayMode, readOnly = false, required = false, label, hideLabel = false, testId, isTableFormatter = false, variant = 'inline' } = props;
-
-  const pConn = getPConnect();
-  const actions = pConn.getActionsApi();
-  const stateProps = pConn.getStateProps() as StateProps;
-  const propName: string = stateProps.value;
-  const { formatter } = props;
-
-  const handleOnChange = (event: any) => {
-    const { value: updatedValue } = event.target;
-    actions.updateFieldValue(propName, updatedValue);
-  };
-
-  if (displayMode === 'LABELS_LEFT' || displayMode === 'DISPLAY_ONLY') {
-    let displayComp = value || <span aria-hidden='true'>&ndash;&ndash;</span>;
-    if (isTableFormatter && formatExists(formatter)) {
-      displayComp = textFormatter(formatter, value);
-    }
-    return displayMode === 'DISPLAY_ONLY' ? (
-      <StyledPegaDxilMyTextWrapper> {displayComp} </StyledPegaDxilMyTextWrapper>
-    ) : (
-      <StyledPegaDxilMyTextWrapper>
-        <FieldValueList
-          variant={hideLabel ? 'stacked' : variant}
-          data-testid={testId}
-          fields={[{ id: '1', name: hideLabel ? '' : label, value: displayComp }]}
-        />
-      </StyledPegaDxilMyTextWrapper>
-    );
-  }
-
-  if (displayMode === 'STACKED_LARGE_VAL') {
-    const isValDefined = typeof value !== 'undefined' && value !== '';
-    const val = isValDefined ? (
-      <Text variant='h1' as='span'>
-        {value}
-      </Text>
-    ) : (
-      ''
-    );
-    return (
-      <StyledPegaDxilMyTextWrapper>
-        <FieldValueList
-          variant='stacked'
-          data-testid={testId}
-          fields={[{ id: '2', name: hideLabel ? '' : label, value: val }]}
-        />
-      </StyledPegaDxilMyTextWrapper>
-    );
-  }
-
-  return (
-    <StyledPegaDxilMyTextWrapper>
-      <Input
-        type='text'
-        value={value}
-        label={label}
-        labelHidden={hideLabel}
-        placeholder={placeholder}
-        disabled={disabled}
-        readOnly={readOnly}
-        required={required}
-        onChange={handleOnChange}
-        testId={testId}
-      />
-    </StyledPegaDxilMyTextWrapper>
-  );
-};
-
-
-export default withConfiguration(PegaDxilMyText);