@pega/custom-dx-components 0.242.17 → 0.242.18

package/tests/assets/library/components/createAll/Launchpad/Pega_DXIL_MyURL/index.tsx

@@ -0,0 +1,203 @@
+import { useState, useEffect, useRef} from "react";
+import { Input, FieldValueList, Text, withConfiguration } from "@pega/cosmos-react-core";
+import type { PConnFieldProps } from './PConnProps';
+
+// includes in bundle
+import {formatExists,textFormatter, urlFormatter} from "./text-url";
+import handleEvent from "./event-utils";
+import { suggestionsHandler } from './suggestions-handler';
+
+import StyledPegaDxilMyUrlWrapper from './styles';
+
+// interface for props
+interface PegaDxilMyUrlProps 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 PegaDxilMyUrl(props: PegaDxilMyUrlProps) {
+  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
+    ) : (
+      <StyledPegaDxilMyUrlWrapper>
+      <FieldValueList
+        variant={hideLabel ? 'stacked' : variant}
+        data-testid={testId}
+        fields={[{ id: '1', name: hideLabel ? '' : label, value: displayComp }]}
+      />
+      </StyledPegaDxilMyUrlWrapper>
+    );
+  }
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    return (
+      <StyledPegaDxilMyUrlWrapper>
+      <FieldValueList
+        variant='stacked'
+        data-testid={testId}
+        fields={[
+          {
+            id: '2',
+            name: hideLabel ? '' : label,
+            value: (
+              <Text variant='h1' as='span'>
+                {displayComp}
+              </Text>
+            )
+          }
+        ]}
+      />
+      </StyledPegaDxilMyUrlWrapper>
+    );
+  }
+
+  const onResolveSuggestionHandler = (accepted: boolean) => {
+    suggestionsHandler(accepted, pConn, setStatus);
+  };
+
+  return (
+    <StyledPegaDxilMyUrlWrapper>
+    <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) {
+          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}
+    />
+    </StyledPegaDxilMyUrlWrapper>
+  );
+}
+
+
+export default withConfiguration(PegaDxilMyUrl);

package/tests/assets/library/components/createAll/Launchpad/Pega_DXIL_MyURL/mock.ts

@@ -0,0 +1,30 @@
+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/library/components/createAll/Launchpad/Pega_DXIL_MyURL/text-url.tsx

@@ -0,0 +1,179 @@
+import { useState, useRef, Fragment} from "react";
+import { EmailDisplay, PhoneDisplay, URLDisplay, Image, Button, Lightbox } from '@pega/cosmos-react-core';
+
+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;
+  };
+
+const urlLabelVal = (urlLabelSelection: string, btnVal: string, urlLabel: string, propUrlLabel: string) => {
+  if ((urlLabel !== '' || propUrlLabel !== '') && btnVal !== null) {
+    switch (urlLabelSelection) {
+      case 'constant': {
+        btnVal = urlLabel;
+        break;
+      }
+      case 'propertyRef': {
+        btnVal = propUrlLabel;
+        break;
+      }
+      // no default
+    }
+  }
+  return btnVal;
+};
+
+const isImage = (url: string) => /\.(jpg|jpeg|png|webp|avif|gif|svg)$/.test(url);
+
+const TableImage = (imageProps: any) => {
+  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 = () => {
+    // @ts-ignore
+    setImages([imgDescription]);
+  };
+  const onItemDownload = async (id: string) => {
+    const a = document.createElement('a');
+    // @ts-ignore
+    a.href = await fetch(images[0].src)
+      .then((response) => {
+        return response.blob();
+      })
+      .then((blob) => {
+        return URL.createObjectURL(blob);
+      });
+
+    // @ts-ignore
+    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);
+            // @ts-ignore
+            demoButtonRef.current?.focus();
+          }}
+          // @ts-ignore
+          onItemDownload={isImage(images[0].src) ? onItemDownload : undefined}
+        />
+      )}
+    </Fragment>
+  );
+  return imageDisplayComp;
+};
+
+export const textFormatter = (formatter: string, value: any) => {
+  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: string, options: any) => {
+  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/original/components/create/Pega_DXIL_MyTestText/demo.stories.tsx

@@ -0,0 +1,67 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+import { useState } from 'react';
+import type { Meta, StoryObj } from '@storybook/react';
+
+import { stateProps, configProps } from './mock';
+
+import PegaDxilMyTestText from './index';
+
+const meta: Meta<typeof PegaDxilMyTestText> = {
+  title: 'PegaDxilMyTestText',
+  component: PegaDxilMyTestText,
+  excludeStories: /.*Data$/
+};
+
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyTestText>;
+
+export const BasePegaDxilMyTestText: 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 (
+    <>
+      <PegaDxilMyTestText {...props} {...args} />
+    </>
+  );
+};
+
+BasePegaDxilMyTestText.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/original/components/create/Pega_DXIL_MyTestText/mock.ts

@@ -0,0 +1,21 @@
+
+export const configProps = {
+  value: '',
+  label: 'Text Sample',
+  placeholder: 'Text Placeholder',
+  helperText: 'Text Helper Text',
+  testId: 'Text-12345678',
+  hasSuggestions: false,
+  displayMode: '',
+  hideLabel: false,
+  readOnly: false,
+  required: false,
+  disabled: false,
+  status: '',
+  validatemessage: ''
+};
+
+export const stateProps = {
+  value: '.TextSample',
+  hasSuggestions: false
+};

package/tests/assets/original/components/create/Pega_DXIL_MyTestText/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/original/components/create/_components.md

@@ -0,0 +1 @@
+# directory for components #

package/tests/assets/original/components/createAll/Constellation/Pega_DXIL_MyBoolean/Boolean.ts

@@ -0,0 +1,35 @@
+function Boolean(value: any, { allowEmpty = true, tick = '', cross = '' } = {}) {
+  if (
+    (!allowEmpty && !value) ||
+    value === false ||
+    value?.toString()?.toLowerCase() === 'false' ||
+    value === 0 ||
+    value === '0'
+  ) {
+    return cross || '';
+  }
+  if (
+    value === true ||
+    value?.toString()?.toLowerCase() === 'true' ||
+    value === 1 ||
+    value === '1'
+  ) {
+    return tick || '';
+  }
+  if (
+    allowEmpty &&
+    (value === 'null' || value === '' || value === null || typeof value === 'undefined')
+  ) {
+    return '––';
+  }
+  return value;
+}
+
+export default {
+  TrueFalse: (value: any, options: Object) =>
+    Boolean(value, {
+      ...options,
+      tick: 'True',
+      cross: 'False'
+    })
+};

package/tests/assets/original/components/createAll/Constellation/Pega_DXIL_MyBoolean/boolean-format.ts

@@ -0,0 +1,25 @@
+import Boolean from "./Boolean";
+
+export default {
+  ...Boolean
+};
+
+
+
+export function format(value: any, type: string) {
+  let formattedValue;
+
+  switch (type?.toLowerCase()) {
+
+
+    case "boolean":
+    case "checkbox": {
+      formattedValue = Boolean.TrueFalse(value, { allowEmpty: false });
+      break;
+    }
+
+    default:
+      formattedValue = value;
+  }
+  return formattedValue;
+}

package/tests/assets/original/components/createAll/Constellation/Pega_DXIL_MyBoolean/demo.stories.tsx

@@ -0,0 +1,70 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+import { useState } from 'react';
+import type { Meta, StoryObj } from '@storybook/react';
+
+import { configProps, stateProps } from './mock';
+
+import PegaDxilMyBoolean from './index';
+
+const meta: Meta<typeof PegaDxilMyBoolean> = {
+  title: 'PegaDxilMyBoolean',
+  component: PegaDxilMyBoolean,
+  excludeStories: /.*Data$/
+};
+
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyBoolean>;
+
+export const BasePegaDxilMyBoolean: Story = (args: any) => {
+
+  const [value, setValue] = useState(configProps.value);
+
+  const props = {
+    value,
+    additionalProps: configProps.additionalProps,
+    getPConnect: () => {
+      return {
+        getStateProps: () => {
+          return stateProps;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: (propName: string, theValue: any) => {
+              setValue(theValue);
+            },
+            triggerFieldChange: () => { /* nothing */}
+          };
+        },
+        getValidationApi: () => {
+          return {
+            validate: () => { /* nothing */}
+          };
+        }
+      };
+    }
+  };
+
+  return (
+    <>
+      <PegaDxilMyBoolean {...props} {...args} />
+    </>
+  );
+};
+
+BasePegaDxilMyBoolean.args = {
+  label: configProps.label,
+  helperText: configProps.helperText,
+  caption: configProps.caption,
+  testId: configProps.testId,
+  readOnly: configProps.readOnly,
+  disabled: configProps.disabled,
+  required: configProps.required,
+  status: configProps.status,
+  hideLabel: configProps.hideLabel,
+  trueLabel: configProps.trueLabel,
+  falseLabel: configProps.falseLabel,
+  displayMode: configProps.displayMode,
+  variant: configProps.variant,
+  validatemessage: configProps.validatemessage
+};

package/tests/assets/original/components/createAll/Constellation/Pega_DXIL_MyBoolean/event-utils.ts

@@ -0,0 +1,18 @@
+const handleEvent = (actions: any, eventType: string, propName: string, value: any) => {
+  switch (eventType) {
+    case 'change':
+      actions.updateFieldValue(propName, value);
+      break;
+    case 'blur':
+      actions.triggerFieldChange(propName, value);
+      break;
+    case 'changeNblur':
+      actions.updateFieldValue(propName, value);
+      actions.triggerFieldChange(propName, value);
+      break;
+    default:
+      break;
+  }
+};
+
+export default handleEvent;