@pega/custom-dx-components 2.0.17 → 2.0.19

package/src/tasks/create/templates/Constellation/Field/Text-URL/index.jsx.mustache

@@ -1,185 +1,14 @@
-import { useState, useEffect, useRef, React} from "react";
-import { Input, FieldValueList, Text, EmailDisplay, PhoneDisplay, URLDisplay, Button, Lightbox, Image } from "@pega/cosmos-react-core";
+import { useState, useEffect, useRef} from "react";
+import { Input, FieldValueList, Text } from "@pega/cosmos-react-core";
 import PropTypes from "prop-types";
 
 // includes in bundle
+import {formatExists,textFormatter, urlFormatter, suggestionHandler} from "./text-url";
 import handleEvent from "./event-utils";
 import { suggestionsHandler } from './suggestions-handler';
 
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
 
-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 = (
-    <React.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}
-        />
-      )}
-    </React.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;
-};
-
-
 
 // Duplicated runtime code from Constellation Design System Component
 

package/src/tasks/create/templates/Constellation/Field/Text-URL/text-url.js.mustache

@@ -0,0 +1,172 @@
+import {EmailDisplay, PhoneDisplay, URLDisplay } 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 = (
+    <React.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}
+        />
+      )}
+    </React.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/src/tasks/create/templates/Constellation/Field/TimeofDay/demo.stories.jsx.mustache

@@ -1,4 +1,4 @@
-import { withKnobs, text, boolean } from '@storybook/addon-knobs';
+import { withKnobs } from '@storybook/addon-knobs';
 import { configProps, stateProps } from './mock.stories';
 import {{COMPONENT_CLASS_NAME}} from './index.jsx';
 
@@ -14,8 +14,13 @@ export const base{{COMPONENT_CLASS_NAME}} = () => {
       return {
         getActionsApi: () => {
           return {
-            updateFieldValue: () => {},
-            triggerFieldChange: () => {}
+            updateFieldValue: () => {/* nothing */},
+            triggerFieldChange: () => {/* nothing */}
+          };
+        },
+        getValidationApi: () => {
+          return {
+            validate: () => {/* nothing */}
           };
         },
         getStateProps: () => {
@@ -24,8 +29,8 @@ export const base{{COMPONENT_CLASS_NAME}} = () => {
         getConfigProps: () => {
           return configProps;
         },
-        ignoreSuggestion: () => {},
-        clearErrorMessages: () => {}
+        ignoreSuggestion: () => {/* nothing */},
+        clearErrorMessages: () => {/* nothing */}
       };
     },
     value: configProps.value,

package/src/tasks/create/templates/Constellation/Template/DETAILS/demo.stories.jsx.mustache

@@ -8,69 +8,20 @@ export default {
   component: {{COMPONENT_CLASS_NAME}}
 };
 
-const Template = args => {
-  const regionAChildren = pyReviewRaw.children[0].children.map(child => {
-    return Primary.args.getPConnect().createComponent(child);
-  });
-
-  return <{{COMPONENT_CLASS_NAME}} {...args}>{regionAChildren}</{{COMPONENT_CLASS_NAME}}>;
-};
-
-export const Primary = Template.bind({});
-
-Primary.args = {
-  template: 'MyCo_MyComponents_NewDetailsTemplate',
-  showHighlightedData: true,
-  label: 'Test Details',
-  showLabel: true,
-  getPConnect: () => {
-    return {
-      getChildren: () => {
-        return pyReviewRaw.children;
-      },
-      getRawMetadata: () => {
-        return pyReviewRaw;
-      },
-      getInheritedProps: () => {
-        return pyReviewRaw.config.inheritedProps;
-      },
-      createComponent: config => {
-        switch (config.config.value) {
-          case '@P .pyStatusWork':
-            return renderField(pyReviewResolved.highlightedData[0].config);
-          case '@P .pyID':
-            return renderField(pyReviewResolved.highlightedData[1].config);
-          case '@P .pxCreateDateTime':
-            return renderField(pyReviewResolved.highlightedData[2].config);
-          case '@USER .pxCreateOperator':
-            return renderField(pyReviewResolved.highlightedData[3].config);
-          case '@P .pySLADeadline':
-            return renderField(regionChildrenResolved[0]);
-          case '@P .pySLAGoal':
-            return renderField(regionChildrenResolved[1]);
-          case '@P .pySLAStartTime':
-            return renderField(regionChildrenResolved[2]);
-        }
-      },
-      setInheritedProp: () => {},
-      resolveConfigProps: () => {}
-    };
-  }
-};
-
 const renderField = resolvedProps => {
   const {
     displayAsStatus = false,
     displayMode,
     value = '',
     label = '',
+    // eslint-disable-next-line react-hooks/rules-of-hooks
     theme = useTheme()
   } = resolvedProps;
 
   const variant = displayMode === 'LABELS_LEFT' ? 'inline' : 'stacked';
 
   let val =
-    value != '' ? (
+    value !== '' ? (
       <Text variant='h1' as='span'>
         {value}
       </Text>
@@ -108,3 +59,60 @@ const renderField = resolvedProps => {
   }
   return <FieldValueList variant={variant} fields={[{ name: label, value: val }]} />;
 };
+
+export const base{{COMPONENT_CLASS_NAME}} = () => {
+  const props = {
+    template: 'MyCo_MyComponents_NewDetailsTemplate',
+    showHighlightedData: true,
+    label: 'Test Details',
+    showLabel: true,
+    getPConnect: () => {
+      return {
+        getChildren: () => {
+          return pyReviewRaw.children;
+        },
+        getRawMetadata: () => {
+          return pyReviewRaw;
+        },
+        getInheritedProps: () => {
+          return pyReviewRaw.config.inheritedProps;
+        },
+        createComponent: config => {
+          // eslint-disable-next-line default-case
+          switch (config.config.value) {
+            case '@P .pyStatusWork':
+              return renderField(pyReviewResolved.highlightedData[0].config);
+            case '@P .pyID':
+              return renderField(pyReviewResolved.highlightedData[1].config);
+            case '@P .pxCreateDateTime':
+              return renderField(pyReviewResolved.highlightedData[2].config);
+            case '@USER .pxCreateOperator':
+              return renderField(pyReviewResolved.highlightedData[3].config);
+            case '@P .pySLADeadline':
+              return renderField(regionChildrenResolved[0]);
+            case '@P .pySLAGoal':
+              return renderField(regionChildrenResolved[1]);
+            case '@P .pySLAStartTime':
+              return renderField(regionChildrenResolved[2]);
+          }
+        },
+        setInheritedProp: () => {
+          /* nothing */
+        },
+        resolveConfigProps: () => {
+          /* nothing */
+        }
+      };
+    }
+  };
+
+  const regionAChildren = pyReviewRaw.children[0].children.map(child => {
+    return props.getPConnect().createComponent(child);
+  });
+
+  return (
+    <>
+      <{{COMPONENT_CLASS_NAME}} {...props}>{regionAChildren}</{{COMPONENT_CLASS_NAME}}>
+    </>
+  );
+};

package/src/tasks/create/templates/Constellation/Template/DETAILS-region/demo.stories.jsx.mustache

@@ -8,77 +8,20 @@ export default {
   component: {{COMPONENT_CLASS_NAME}}
 };
 
-const Template = args => {
-  const regionAChildren = pyReviewRaw.children[0].children.map(child => {
-    return Primary.args.getPConnect().createComponent(child);
-  });
-  const regionBChildren = pyReviewRaw.children[1].children.map(child => {
-    return Primary.args.getPConnect().createComponent(child);
-  });
-
-  return (
-    <{{COMPONENT_CLASS_NAME}} {...args}>
-      {regionAChildren}
-      {regionBChildren}
-    </{{COMPONENT_CLASS_NAME}}>
-  );
-};
-
-export const Primary = Template.bind({});
-
-Primary.args = {
-  template: 'MyCo_MyComponents_NewDetailsTemplate',
-  showHighlightedData: true,
-  label: 'Test Details',
-  showLabel: true,
-  getPConnect: () => {
-    return {
-      getChildren: () => {
-        return pyReviewRaw.children;
-      },
-      getRawMetadata: () => {
-        return pyReviewRaw;
-      },
-      getInheritedProps: () => {
-        return pyReviewRaw.config.inheritedProps;
-      },
-      createComponent: config => {
-        switch (config.config.value) {
-          case '@P .pyStatusWork':
-            return renderField(pyReviewResolved.highlightedData[0].config);
-          case '@P .pyID':
-            return renderField(pyReviewResolved.highlightedData[1].config);
-          case '@P .pxCreateDateTime':
-            return renderField(pyReviewResolved.highlightedData[2].config);
-          case '@USER .pxCreateOperator':
-            return renderField(pyReviewResolved.highlightedData[3].config);
-          case '@P .pySLADeadline':
-            return renderField(regionChildrenResolved[0]);
-          case '@P .pySLAGoal':
-            return renderField(regionChildrenResolved[1]);
-          case '@P .pySLAStartTime':
-            return renderField(regionChildrenResolved[2]);
-        }
-      },
-      setInheritedProp: () => {},
-      resolveConfigProps: () => {}
-    };
-  }
-};
-
 const renderField = resolvedProps => {
   const {
     displayAsStatus = false,
     displayMode,
     value = '',
     label = '',
+    // eslint-disable-next-line react-hooks/rules-of-hooks
     theme = useTheme()
   } = resolvedProps;
 
   const variant = displayMode === 'LABELS_LEFT' ? 'inline' : 'stacked';
 
   let val =
-    value != '' ? (
+    value !== '' ? (
       <Text variant='h1' as='span'>
         {value}
       </Text>
@@ -116,3 +59,65 @@ const renderField = resolvedProps => {
   }
   return <FieldValueList variant={variant} fields={[{ name: label, value: val }]} />;
 };
+
+
+export const base{{COMPONENT_CLASS_NAME}} = () => {
+  const props = {
+    template: 'MyCo_MyComponents_NewDetailsTemplate',
+    showHighlightedData: true,
+    label: 'Test Details',
+    showLabel: true,
+    getPConnect: () => {
+      return {
+        getChildren: () => {
+          return pyReviewRaw.children;
+        },
+        getRawMetadata: () => {
+          return pyReviewRaw;
+        },
+        getInheritedProps: () => {
+          return pyReviewRaw.config.inheritedProps;
+        },
+        createComponent: config => {
+          // eslint-disable-next-line default-case
+          switch (config.config.value) {
+            case '@P .pyStatusWork':
+              return renderField(pyReviewResolved.highlightedData[0].config);
+            case '@P .pyID':
+              return renderField(pyReviewResolved.highlightedData[1].config);
+            case '@P .pxCreateDateTime':
+              return renderField(pyReviewResolved.highlightedData[2].config);
+            case '@USER .pxCreateOperator':
+              return renderField(pyReviewResolved.highlightedData[3].config);
+            case '@P .pySLADeadline':
+              return renderField(regionChildrenResolved[0]);
+            case '@P .pySLAGoal':
+              return renderField(regionChildrenResolved[1]);
+            case '@P .pySLAStartTime':
+              return renderField(regionChildrenResolved[2]);
+          }
+        },
+        setInheritedProp: () => {
+          /* nothing */
+        },
+        resolveConfigProps: () => {
+          /* nothing */
+        }
+      };
+    }
+  };
+
+  const regionAChildren = pyReviewRaw.children[0].children.map(child => {
+    return props.getPConnect().createComponent(child);
+  });
+  const regionBChildren = pyReviewRaw.children[1].children.map(child => {
+    return props.getPConnect().createComponent(child);
+  });
+
+  return (
+    <{{COMPONENT_CLASS_NAME}} {...props}>
+      {regionAChildren}
+      {regionBChildren}
+    </{{COMPONENT_CLASS_NAME}}>
+  );
+};