@pega/dx-component-builder-sdk 0.1.0

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

@@ -0,0 +1,335 @@
+import { useState, useEffect, useRef } from 'react';
+import { NumberInput, NumberDisplay, Slider, FieldValueList, CurrencyDisplay, Text } from '@pega/cosmos-react-core';
+import PropTypes from 'prop-types';
+
+// includes in bundle
+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,
+    defaultValue,
+    placeholder,
+    validatemessage,
+    label,
+    hideLabel,
+    helperText,
+    testId,
+    displayMode,
+    displayAs,
+    showInput,
+    min,
+    max,
+    step,
+    showTicks,
+    additionalProps,
+    variant,
+    formatter,
+    negative,
+    notation,
+    isTableFormatter,
+    hasSuggestions
+  } = props;
+  let { showGroupSeparators } = props;
+  let { currencyDisplay } = props;
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = pConn.getStateProps().value;
+  const [integerValue, setIntegerValue] = useState(value?.toString());
+  const sliderDefaultValue = !defaultValue && defaultValue !== 0 ? max : defaultValue;
+  const hasValueChange = useRef(false);
+
+
+  let { readOnly, required, disabled } = props;
+  [readOnly, required, disabled] = [readOnly, required, disabled].map(
+    (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
+  );
+
+  const [status, setStatus] = useState(hasSuggestions ? 'pending' : '');
+  useEffect(() => {
+    if (validatemessage !== '') {
+      setStatus('error');
+    }
+    if (hasSuggestions) {
+      setStatus('pending');
+    } else if (!hasSuggestions && status !== 'success') {
+      setStatus(validatemessage !== '' ? 'error' : undefined);
+    }
+  }, [validatemessage, hasSuggestions]);
+
+  useEffect(() => {
+    setIntegerValue(value?.toString());
+  }, [value]);
+
+  useEffect(() => {
+    if (displayAs === 'slider' && value === '') {
+      handleEvent(actions, 'change', propName, sliderDefaultValue);
+    }
+  }, []);
+
+  const { decimalPrecision, currencyDecimalPrecision, currencyISOCode } = props;
+  let noOfDecimals = parseInt(decimalPrecision, 10);
+  if (Number.isNaN(noOfDecimals)) noOfDecimals = undefined;
+  let noOfFractionDigits = currencyDecimalPrecision === 'auto' ? undefined : parseInt(currencyDecimalPrecision, 10);
+  let unit;
+  let unitPlacement;
+
+  if (['LABELS_LEFT', 'STACKED_LARGE_VAL', 'DISPLAY_ONLY'].includes(displayMode)) {
+    switch (formatter) {
+      case 'Decimal': {
+        break;
+      }
+      case 'Percentage': {
+        showGroupSeparators = false;
+        unit = '%';
+        unitPlacement = 'after';
+        break;
+      }
+      case 'Decimal-Auto': {
+        noOfDecimals = Number.isInteger(integerValue) ? 0 : 2;
+        break;
+      }
+      default: {
+        noOfDecimals = 0;
+        break;
+      }
+    }
+
+    if (isTableFormatter && displayMode === 'LABELS_LEFT') {
+      showGroupSeparators = true;
+      noOfFractionDigits = undefined;
+      if (formatter === 'Currency-Code') {
+        currencyDisplay = 'code';
+      }
+    }
+
+    {{! pick new delimiteres for mustache }}
+    {{=<% %>=}}
+
+    const displayComp =
+      formatter === 'Currency' || formatter === 'Currency-Code' ? (
+        <CurrencyDisplay
+          value={integerValue}
+          currencyISOCode={currencyISOCode}
+          formattingOptions={{
+            groupSeparators: showGroupSeparators,
+            fractionDigits: noOfFractionDigits,
+            currency: currencyDisplay,
+            negative,
+            notation: negative === 'parentheses' ? 'standard' : notation
+          }}
+        />
+      ) : (
+        <NumberDisplay
+          value={integerValue}
+          formattingOptions={{
+            fractionDigits: noOfDecimals,
+            groupSeparators: showGroupSeparators,
+            notation
+          }}
+          unit={unit}
+          unitPlacement={unitPlacement}
+        />
+      );
+
+    <%={{ }}=%>     {{! revert delimiteres for mustache }}
+
+    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
+    }
+  }
+
+  function onChangeHandler(enteredValue) {
+    if (hasSuggestions) {
+      setStatus(undefined);
+    }
+    setIntegerValue(enteredValue);
+    // const parsedValue = integerValue !== '' ? Number(integerValue) : '';
+    if (value !== (enteredValue !== '' ? Number(enteredValue) : '')) {
+      handleEvent(actions, 'change', propName, enteredValue !== '' ? Number(enteredValue) : '');
+      hasValueChange.current = true;
+    }
+    // In case of stepper variation there is no blur event as component is never focussed unless forced. Need to update redux on change.
+    if (displayAs === 'stepper') {
+      handleEvent(actions, 'changeNblur', propName, enteredValue !== '' ? Number(enteredValue) : '');
+    }
+  }
+
+  const onResolveSuggestionHandler = (accepted) => {
+    suggestionsHandler(accepted, pConn, setStatus);
+  };
+
+  return displayAs === 'slider' ? (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    <Slider
+      {...additionalProps}
+      label={label}
+      labelHidden={hideLabel}
+      info={validatemessage || helperText}
+      value={!integerValue ? sliderDefaultValue : Number(integerValue)}
+      status={status}
+      placeholder={placeholder}
+      disabled={disabled}
+      readOnly={readOnly}
+      required={required}
+      data-testid={testId}
+      showProgress
+      preview={!showInput}
+      showInput={showInput}
+      min={min}
+      max={max}
+      step={step}
+      ticks={showTicks && { [min]: `${min}`, [max]: `${max}` }}
+      onChange={(selectedValue) => {
+        onChangeHandler(selectedValue.toString());
+        handleEvent(actions, 'changeNblur', propName, selectedValue);
+      }}
+    />
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  ) : (
+    <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+    <NumberInput
+      {...additionalProps}
+      label={label}
+      labelHidden={hideLabel}
+      info={validatemessage || helperText}
+      value={integerValue}
+      status={status}
+      placeholder={displayAs === 'input' ? placeholder : ''}
+      disabled={disabled}
+      readOnly={readOnly}
+      required={required}
+      data-testid={testId}
+      numberOfDecimals={0}
+      showGroupSeparators={showGroupSeparators}
+      variant={displayAs === 'stepper' ? displayAs : ''}
+      onChange={(enteredValue) => {
+        onChangeHandler(enteredValue);
+      }}
+      onBlur={() => {
+        if (!readOnly && (hasValueChange.current || !value)) {
+          handleEvent(actions, 'blur', propName, integerValue !== '' ? Number(integerValue) : '');
+          if (hasSuggestions) {
+            pConn.ignoreSuggestion();
+          }
+          hasValueChange.current = false;
+        }
+      }}
+      onResolveSuggestion={onResolveSuggestionHandler}
+    />
+    </Styled{{COMPONENT_CLASS_NAME}}Wrapper>
+  );
+}
+
+{{COMPONENT_CLASS_NAME}}.defaultProps = {
+  value: '',
+  defaultValue: null,
+  placeholder: '',
+  validatemessage: '',
+  helperText: '',
+  hideLabel: false,
+  disabled: false,
+  readOnly: false,
+  required: false,
+  testId: null,
+  showGroupSeparators: false,
+  displayMode: null,
+  displayAs: 'input',
+  showInput: true,
+  min: 0,
+  max: 100,
+  step: 1,
+  showTicks: true,
+  additionalProps: {},
+  variant: 'inline',
+  decimalPrecision: null,
+  currencyISOCode: 'USD',
+  isoCodeSelection: 'constant',
+  formatter: 'defaultInteger',
+  negative: 'minus-sign',
+  notation: 'standard',
+  currencyDisplay: 'symbol',
+  currencyDecimalPrecision: 'auto',
+  isTableFormatter: false,
+  hasSuggestions: false
+};
+
+{{COMPONENT_CLASS_NAME}}.propTypes = {
+  value: PropTypes.string,
+  defaultValue: PropTypes.number,
+  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,
+  showGroupSeparators: PropTypes.bool,
+  displayMode: PropTypes.string,
+  displayAs: PropTypes.string,
+  showInput: PropTypes.bool,
+  min: PropTypes.number,
+  max: PropTypes.number,
+  step: PropTypes.number,
+  showTicks: PropTypes.bool,
+  additionalProps: PropTypes.objectOf(PropTypes.any),
+  variant: PropTypes.string,
+  decimalPrecision: PropTypes.number,
+  currencyISOCode: PropTypes.string,
+  formatter: PropTypes.string,
+  negative: PropTypes.string,
+  notations: PropTypes.string,
+  currencyDisplay: PropTypes.string,
+  currencyDecimalPrecision: PropTypes.string,
+  isTableFormatter: PropTypes.bool,
+  hasSuggestions: PropTypes.bool
+};
+
+export default {{COMPONENT_CLASS_NAME}};

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

package/src/tasks/create/templates/Constellation/Field/Picklist/config.json.mustache

@@ -0,0 +1,114 @@
+{
+  "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-dropdown-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": "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",
+    "placeholder": "@L Select...",
+    "listType": "associated",
+    "datasource": "@ASSOCIATED .$this.name"
+  }
+}

package/src/tasks/create/templates/Constellation/Field/Picklist/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/Picklist/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;