@pega/dx-component-builder-sdk 0.1.0

package/src/tasks/create/templates/Constellation/Field/Text-URL/config.json.mustache

@@ -0,0 +1,237 @@
+{
+  "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-url-active.svg",
+  "properties": [
+    {
+      "name": "label",
+      "label": "Field label",
+      "format": "TEXT",
+      "required": true
+    },
+    {
+      "name": "readOnly",
+      "label": "Edit mode",
+      "format": "READONLY"
+    },
+    {
+      "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": [
+        {
+          "name": "placeholder",
+          "label": "Placeholder",
+          "format": "TEXT"
+        },
+        {
+          "name": "helperText",
+          "label": "Helper text",
+          "format": "TEXT"
+        }
+      ]
+    },
+    {
+      "label": "Read-only settings",
+      "format": "GROUP",
+      "properties": [
+        {
+          "format": "SELECT",
+          "name": "displayAs",
+          "label": "Display As",
+          "defaultValue": "defaultURL",
+          "source": [
+            {
+              "key": "defaultURL",
+              "value": "URL"
+            },
+            {
+              "key": "Image",
+              "value": "Image"
+            },
+            {
+              "key": "labelText",
+              "value": "URL Label"
+            }
+          ]
+        },
+        {
+          "format": "CASCADE",
+          "visibility": "(displayAs = labelText)",
+          "source": {
+            "format": "SELECT",
+            "label": "Display text Selection",
+            "name": "urlLabelSelection",
+            "defaultValue": "constant",
+            "source": [
+              {
+                "key": "constant",
+                "value": "Constant"
+              },
+              {
+                "key": "propertyRef",
+                "value": "Property Reference"
+              }
+            ]
+          },
+          "cascadeElements": [
+            {
+              "key": "urlLabel",
+              "format": "TEXT",
+              "name": "urlLabel",
+              "label": "Display text",
+              "match": "constant"
+            },
+            {
+              "key": "urlLabel",
+              "format": "PROPERTY",
+              "name": "propUrlLabel",
+              "label": "Display text",
+              "match": "propertyRef"
+            }
+          ]
+        },
+        {
+          "format": "GROUP",
+          "visibility": "(displayAs = Image)",
+          "properties": [
+            {
+              "format": "SELECT",
+              "name": "widthSel",
+              "label": "Width",
+              "defaultValue": "defaultWidth",
+              "source": [
+                {
+                  "key": "defaultWidth",
+                  "value": "Default Width"
+                },
+                {
+                  "key": "widthpx",
+                  "value": "Custom Width"
+                }
+              ]
+            },
+            {
+              "name": "customWidth",
+              "label": "Width (px)",
+              "visibility": "(widthSel = widthpx)",
+              "format": "NUMBER"
+            },
+            {
+              "format": "CASCADE",
+              "source": {
+                "format": "SELECT",
+                "label": "Image Alt Text",
+                "name": "altText",
+                "defaultValue": "constant",
+                "source": [
+                  {
+                    "key": "constant",
+                    "value": "Constant"
+                  },
+                  {
+                    "key": "propertyRef",
+                    "value": "Property Reference"
+                  }
+                ]
+              },
+              "cascadeElements": [
+                {
+                  "key": "altTextOfImage",
+                  "format": "TEXT",
+                  "name": "altTextOfImage",
+                  "label": "Alt Text Value",
+                  "defaultValue": "",
+                  "match": "constant"
+                },
+                {
+                  "key": "altTextOfImage",
+                  "format": "PROPERTY",
+                  "name": "propaltTextOfImage",
+                  "label": "Alt Text Value",
+                  "match": "propertyRef"
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "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/Text-URL/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/Text-URL/event-utils.js.mustache

@@ -0,0 +1,18 @@
+const handleEvent = (actions, eventType, propName, value) => {
+  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;

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

@@ -0,0 +1,232 @@
+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';
+
+
+// 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,
+    hideLabel,
+    placeholder,
+    validatemessage,
+    label,
+    helperText,
+    testId,
+    displayMode,
+    additionalProps,
+    variant,
+    isTableFormatter,
+    displayAs,
+    widthSel,
+    customWidth,
+    altText,
+    altTextOfImage,
+    propaltTextOfImage,
+    urlLabel,
+    propUrlLabel,
+    urlLabelSelection,
+    tableDisplayAs,
+    hasSuggestions
+  } = props;
+  const { formatter } = props;
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = pConn.getStateProps().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, required, disabled } = 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]);
+
+  let displayComp = 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
+    ) : (
+      <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>
+    );
+  }
+
+  if (displayMode === '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>
+    );
+  }
+
+  const onResolveSuggestionHandler = (accepted) => {
+    suggestionsHandler(accepted, pConn, setStatus);
+  };
+
+  return (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    <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) => {
+        if (hasSuggestions) {
+          setStatus(undefined);
+        }
+        setInputValue(event.target.value);
+        if (value !== event.target.value) {
+          handleEvent(actions, 'change', propName, event.target.value);
+          hasValueChange.current = true;
+        }
+      }}
+      onBlur={(event) => {
+        if (!value || hasValueChange.current) {
+          handleEvent(actions, 'blur', propName, event.target.value);
+          if (hasSuggestions) {
+            pConn.ignoreSuggestion();
+          }
+          hasValueChange.current = false;
+        }
+      }}
+      onFocus={actions.onFocus}
+      onResolveSuggestion={onResolveSuggestionHandler}
+    />
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  );
+}
+
+{{COMPONENT_CLASS_NAME}}.defaultProps = {
+  value: '',
+  placeholder: '',
+  validatemessage: '',
+  helperText: '',
+  hideLabel: false,
+  disabled: false,
+  readOnly: false,
+  required: false,
+  testId: null,
+  displayMode: null,
+  additionalProps: {},
+  variant: 'inline',
+  formatter: '',
+  isTableFormatter: false,
+  displayAs: 'defaultURL',
+  widthSel: 'defaultWidth',
+  customWidth: null,
+  altText: 'constant',
+  altTextOfImage: '',
+  propaltTextOfImage: '',
+  urlLabel: '',
+  propUrlLabel: '',
+  urlLabelSelection: 'constant',
+  tableDisplayAs: 'link',
+  hasSuggestions: false
+};
+
+{{COMPONENT_CLASS_NAME}}.propTypes = {
+  value: 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,
+  displayMode: PropTypes.string,
+  additionalProps: PropTypes.objectOf(PropTypes.any),
+  variant: PropTypes.string,
+  formatter: PropTypes.string,
+  isTableFormatter: PropTypes.bool,
+  displayAs: PropTypes.string,
+  widthSel: PropTypes.string,
+  customWidth: PropTypes.number,
+  altText: PropTypes.string,
+  altTextOfImage: PropTypes.string,
+  propaltTextOfImage: PropTypes.string,
+  urlLabel: PropTypes.string,
+  propUrlLabel: PropTypes.string,
+  urlLabelSelection: PropTypes.string,
+  tableDisplayAs: PropTypes.string,
+  hasSuggestions: PropTypes.bool
+};
+
+export default {{COMPONENT_CLASS_NAME}};

package/src/tasks/create/templates/Constellation/Field/Text-URL/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/Text-URL/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);
+  }
+};