@pega/dx-component-builder-sdk 0.1.0

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/config.json.mustache

@@ -0,0 +1,185 @@
+{
+  "name": "{{COMPONENT_KEY}}",
+  "label": "{{COMPONENT_LABEL}}",
+  "description": "{{DESCRIPTION}}",
+  "organization": "{{ORGANIZATION}}",
+  "version": "{{VERSION}}",
+  "library": "{{LIBRARY}}",
+  "allowedApplications": {{{ALLOWEDAPPS}}},
+  "componentKey": "{{COMPONENT_KEY}}",
+  "type": "{{TYPE}}",
+  "subtype": {{{SUB_TYPE}}},
+  "icon": "images/pz-date-time-active.svg",
+  "properties": [
+    {
+      "name": "label",
+      "label": "Field label",
+      "format": "TEXT",
+      "required": true
+    },
+    {
+      "name": "readOnly",
+      "label": "Edit mode",
+      "format": "READONLY"
+    },
+    {
+      "format": "SELECT",
+      "name": "clockFormat",
+      "label": "Clock",
+      "defaultValue": "0",
+      "source": [
+        {
+          "key": "0",
+          "value": "use locale"
+        },
+        {
+          "key": "12",
+          "value": "12 hours"
+        },
+        {
+          "key": "24",
+          "value": "24 hours"
+        }
+      ]
+    },
+    {
+      "name": "withSeconds",
+      "label": "Display seconds",
+      "format": "BOOLEAN"
+    },
+    {
+      "label": "Column settings",
+      "format": "GROUP",
+      "visibility": "@VIEWTYPE == 'MultiRecordDisplayAsTable'",
+      "properties": [
+        {
+          "name": "columnWidth",
+          "label": "Column width",
+          "format": "SELECT",
+          "source": [
+            {
+              "key": "auto",
+              "value": "Auto"
+            },
+            {
+              "key": "custom",
+              "value": "Custom"
+            }
+          ]
+        },
+        {
+          "name": "width",
+          "label": "Width (px)",
+          "format": "NUMBER",
+          "visibility": "$this.columnWidth == 'custom'"
+        }
+      ]
+    },
+    {
+      "label": "Input settings",
+      "format": "GROUP",
+      "visibility": "(!readOnly = true)",
+      "properties": [
+        {
+          "format": "SELECT",
+          "name": "pickerInterval",
+          "label": "Time picker",
+          "defaultValue": "30",
+          "source": [
+            {
+              "key": "5",
+              "value": "5 min"
+            },
+            {
+              "key": "10",
+              "value": "10 min"
+            },
+            {
+              "key": "15",
+              "value": "15 min"
+            },
+            {
+              "key": "20",
+              "value": "20 min"
+            },
+            {
+              "key": "30",
+              "value": "30 min"
+            },
+            {
+              "key": "60",
+              "value": "1 hr"
+            }
+          ]
+        },
+        {
+          "name": "helperText",
+          "label": "Helper text",
+          "format": "TEXT"
+        }
+      ]
+    },
+    {
+      "label": "Read-only settings",
+      "format": "GROUP",
+      "properties": [
+        {
+          "format": "SELECT",
+          "name": "formatter",
+          "label": "Format",
+          "defaultValue": "defaultTime",
+          "source": [
+            {
+              "key": "defaultTime",
+              "value": "Default"
+            },
+            {
+              "key": "Time-Only",
+              "value": "Time only"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "label": "Conditions",
+      "format": "GROUP",
+      "properties": [
+        {
+          "name": "required",
+          "label": "Required",
+          "format": "REQUIRED",
+          "visibility": "(!readOnly = true)"
+        },
+        {
+          "name": "disabled",
+          "label": "Disabled",
+          "format": "DISABLED",
+          "visibility": "(!readOnly = true)"
+        },
+        {
+          "name": "visibility",
+          "label": "Visibility",
+          "format": "VISIBILITY"
+        }
+      ]
+    },
+    {
+      "label": "Advanced",
+      "format": "GROUP",
+      "collapsible": true,
+      "properties": [
+        {
+          "name": "testId",
+          "label": "Test ID",
+          "format": "TEXT",
+          "ignorePattern": "[^-_\\p{N}\\p{L}]",
+          "includeAnnotations": false
+        }
+      ]
+    }
+  ],
+  "defaultConfig": {
+    "label": "@L $this.label"
+  }
+}

package/src/tasks/create/templates/Constellation/Field/TimeofDay/demo.stories.jsx.mustache

@@ -0,0 +1,44 @@
+import { useState } from 'react';
+import { withKnobs, text, boolean } from '@storybook/addon-knobs';
+
+import {{COMPONENT_CLASS_NAME}} from './index.jsx';
+
+export default {
+  title: '{{COMPONENT_CLASS_NAME}}',
+  decorators: [withKnobs],
+  component: {{COMPONENT_CLASS_NAME}}
+};
+
+export const base{{COMPONENT_CLASS_NAME}} = () => {
+  const [value, setValue] = useState('test value');
+
+  const props = {
+    getPConnect: () => {
+      return {
+        getActionsApi: () => {
+          return {
+            updateFieldValue: (propName, value) => {
+              setValue(value);
+            }
+          };
+        },
+        getStateProps: () => {
+          return { value: '.name' };
+        }
+      };
+    },
+    value,
+    placeholder: text('Placeholder', 'Test placeholder'),
+    disabled: boolean('Disabled', false),
+    readOnly: boolean('Disabled', false),
+    required: boolean('Disabled', false),
+    label: text('Label', 'Sample Label'),
+    testId: text('Test id', 'text-12344566')
+  };
+
+  return (
+    <>
+      <{{COMPONENT_CLASS_NAME}} {...props} />
+    </>
+  );
+};

package/src/tasks/create/templates/Constellation/Field/TimeofDay/index.jsx.mustache

@@ -0,0 +1,213 @@
+import { useEffect, useState } from 'react';
+import { TimeInput, FieldValueList, DateTimeDisplay, Text } from '@pega/cosmos-react-core';
+import PropTypes from 'prop-types';
+
+// includes in bundle
+import {
+  parseClockFormat,
+  timeCorrectedToSeconds,
+  datetimeFireChangeBlurEvents
+} from "./time-of-day";
+import { suggestionsHandler } from './suggestions-handler';
+
+import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
+
+
+// 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
+const {{COMPONENT_CLASS_NAME}} = props => {
+  const {
+    getPConnect,
+    value,
+    validatemessage,
+    label,
+    hideLabel,
+    helperText,
+    withSeconds,
+    pickerInterval,
+    testId,
+    additionalProps,
+    displayMode,
+    variant,
+    hasSuggestions
+  } = props;
+  let { formatter } = props;
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = pConn.getStateProps().value;
+
+
+  // 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;
+  [readOnly, required, disabled] = [readOnly, required, disabled].map(
+    (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
+  );
+
+  let { clockFormat } = props;
+  clockFormat = parseClockFormat(clockFormat);
+
+  const [status, setStatus] = useState(hasSuggestions ? 'pending' : undefined);
+
+  useEffect(() => {
+    if (validatemessage !== '') {
+      setStatus('error');
+    }
+    if (hasSuggestions) {
+      setStatus('pending');
+    } else if (!hasSuggestions && status !== 'success') {
+      setStatus(validatemessage !== '' ? 'error' : undefined);
+    }
+  }, [validatemessage, hasSuggestions]);
+
+  const onResolveSuggestionHandler = (accepted) => {
+    suggestionsHandler(accepted, pConn, setStatus);
+  };
+
+  function handleBlur(onBlurValue) {
+    const { valueAsISOString: time, state: errorState } = onBlurValue;
+    const trimmedTime = time ? timeCorrectedToSeconds(time, withSeconds) : time;
+    datetimeFireChangeBlurEvents(errorState, value, trimmedTime, actions, propName, pConn);
+    const isValueChanged = !(value === undefined && trimmedTime === '') && value !== trimmedTime;
+    if (hasSuggestions && isValueChanged) {
+      pConn.ignoreSuggestion();
+    }
+  }
+
+  function handleChange(onChangeValue) {
+    const { valueAsISOString: time } = onChangeValue;
+    const trimmedTime = time ? timeCorrectedToSeconds(time, withSeconds) : time;
+    if (hasSuggestions && value !== trimmedTime) {
+      setStatus(undefined);
+    }
+    pConn.clearErrorMessages({
+      property: propName
+    });
+  }
+
+  if (displayMode === 'LABELS_LEFT' || displayMode === 'STACKED_LARGE_VAL' || displayMode === 'DISPLAY_ONLY') {
+    let variantValue = 'time';
+    let formatValue = withSeconds ? 'long' : 'short';
+    if (pConn && pConn.getConfigProps()) {
+      const runtimeformatter = pConn.getConfigProps()?.formatter;
+      if (formatter !== runtimeformatter) {
+        formatter = runtimeformatter;
+      }
+    }
+    if (formatter === 'Time-Only') {
+      variantValue = 'time';
+      formatValue = 'long';
+    }
+    const displayComp = (
+      <DateTimeDisplay
+        variant={variantValue}
+        format={formatValue}
+        value={value}
+        clockFormat={clockFormat || undefined}
+      />
+    );
+    switch (displayMode) {
+      case 'DISPLAY_ONLY': {
+        return ( <Styled{{COMPONENT_CLASS_NAME}}Wrapper> displayComp </Styled{{COMPONENT_CLASS_NAME}}Wrapper>);
+      }
+      case 'LABELS_LEFT': {
+        return (
+          <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+          <FieldValueList
+            variant={hideLabel ? 'stacked' : variant}
+            data-testid={testId}
+            fields={[{ id: '1', name: hideLabel ? '' : label, value: displayComp }]}
+          />
+          </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+        );
+      }
+      case 'STACKED_LARGE_VAL': {
+        return (
+          <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+          <FieldValueList
+            variant='stacked'
+            data-testid={testId}
+            fields={[
+              {
+                id: '2',
+                name: hideLabel ? '' : label,
+                value: (
+                  <Text variant='h1' as='span'>
+                    {displayComp}
+                  </Text>
+                )
+              }
+            ]}
+          />
+          </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+        );
+      }
+      // no default
+    }
+  }
+
+  return (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    <TimeInput
+      {...additionalProps}
+      label={label}
+      labelHidden={hideLabel}
+      info={validatemessage || helperText}
+      status={status}
+      value={value || undefined}
+      withSeconds={withSeconds}
+      disabled={disabled}
+      readOnly={readOnly}
+      required={required}
+      pickerInterval={pickerInterval}
+      clockFormat={clockFormat || undefined}
+      data-testid={testId}
+      onFocus={actions.onFocus}
+      onChange={handleChange}
+      onBlur={handleBlur}
+      onResolveSuggestion={onResolveSuggestionHandler}
+    />
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  );
+}
+
+{{COMPONENT_CLASS_NAME}}.defaultProps = {
+  value: undefined,
+  withSeconds: false,
+  validatemessage: "",
+  helperText: "",
+  hideLabel: false,
+  disabled: false,
+  readOnly: false,
+  required: false,
+  pickerInterval: "30",
+  clockFormat: 0,
+  testId: null,
+  additionalProps: {},
+  displayMode: null,
+  variant: "inline",
+  formatter:"defaultTime"
+};
+
+{{COMPONENT_CLASS_NAME}}.propTypes = {
+  value: PropTypes.string,
+  label: PropTypes.string.isRequired,
+  hideLabel: PropTypes.bool,
+  withSeconds: 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]),
+  pickerInterval: PropTypes.string,
+  clockFormat: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+  testId: PropTypes.string,
+  additionalProps: PropTypes.objectOf(PropTypes.any),
+  displayMode: PropTypes.string,
+  variant: PropTypes.string,
+  formatter : PropTypes.string
+};
+
+export default {{COMPONENT_CLASS_NAME}};

package/src/tasks/create/templates/Constellation/Field/TimeofDay/styles.js.mustache

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

package/src/tasks/create/templates/Constellation/Field/TimeofDay/suggestions-handler.js

@@ -0,0 +1,10 @@
+/* eslint-disable import/prefer-default-export */
+export const suggestionsHandler = (accepted, pConn, setStatus) => {
+  if (accepted) {
+    pConn.acceptSuggestion();
+    setStatus('success');
+  } else {
+    pConn.ignoreSuggestion();
+    setStatus(undefined);
+  }
+};