@pega/dx-component-builder-sdk 8.23.16 → 8.23.17

package/tests/assets/components/SDK-React/createAll/custom-sdk/field/Pega_DXIL_MyDateTime/index.tsx

@@ -0,0 +1,113 @@
+import React from 'react';
+import { KeyboardDateTimePicker, MuiPickersUtilsProvider } from '@material-ui/pickers';
+import DayjsUtils from '@date-io/dayjs';
+import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-utils';
+import { format } from '@pega/react-sdk-components/lib/components/helpers/formatters/';
+import { dateFormatInfoDefault, getDateFormatInfo} from '@pega/react-sdk-components/lib/components/helpers/date-format-utils';
+import type { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
+
+
+import StyledPegaDxilMyDateTimeWrapper from './styles';
+
+interface PegaDxilMyDateTimeProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on this componentName
+}
+
+
+// Duplicated runtime code from React SDK
+
+// 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
+export default function PegaDxilMyDateTime(props: PegaDxilMyDateTimeProps) {
+  const {
+    getPConnect,
+    label,
+    required,
+    disabled,
+    value = '',
+    validatemessage,
+    status,
+    onChange,
+    readOnly,
+    testId,
+    helperText,
+    displayMode,
+    hideLabel
+  } = props;
+
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = pConn.getStateProps()["value"];
+  const helperTextToDisplay = validatemessage || helperText;
+
+  const TextInput = getComponentFromMap("TextInput");
+  const FieldValueList = getComponentFromMap("FieldValueList");
+
+  // Start with default dateFormatInfo
+  const dateFormatInfo = dateFormatInfoDefault;
+  // and then update, as needed, based on locale, etc.
+  const theDateFormat = getDateFormatInfo()
+  dateFormatInfo.dateFormatString = theDateFormat.dateFormatString;
+  dateFormatInfo.dateFormatStringLC = theDateFormat.dateFormatStringLC;
+  dateFormatInfo.dateFormatMask = theDateFormat.dateFormatMask;
+
+
+  if (displayMode === 'LABELS_LEFT') {
+    const formattedDateTime = format(props.value, 'datetime', { format: `${dateFormatInfo.dateFormatString} hh:mm a` });
+    return <FieldValueList name={hideLabel ? '' : label} value={formattedDateTime} />;
+  }
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    const formattedDateTime = format(props.value, 'datetime', { format: `${dateFormatInfo.dateFormatString} hh:mm a` });
+    return <FieldValueList name={hideLabel ? '' : label} value={formattedDateTime} variant='stacked' />;
+  }
+
+  if (readOnly) {
+    const formattedDateTime = format(props.value, 'datetime');
+    return <TextInput {...props} value={formattedDateTime} />;
+  }
+
+  const handleChange = date => {
+    const changeValue = date && date.isValid() ? date.toISOString() : null;
+    onChange({ value: changeValue });
+  };
+
+  const handleAccept = date => {
+    const changeValue = date && date.isValid() ? date.toISOString() : null;
+    handleEvent(actions, 'changeNblur', propName, changeValue);
+  };
+
+  //
+  // TODO: Keyboard doesn't work in the minute field, it updates one digit then jump to am/pm field
+  //       try an older version of the lib or use DateTimePicker
+  //
+
+  return (
+    <StyledPegaDxilMyDateTimeWrapper>
+      <MuiPickersUtilsProvider utils={DayjsUtils}>
+        <KeyboardDateTimePicker
+          variant='inline'
+          inputVariant='outlined'
+          fullWidth
+          autoOk
+          required={required}
+          disabled={disabled}
+          placeholder={`${dateFormatInfo.dateFormatStringLC} hh:mm a`}
+          format={`${dateFormatInfo.dateFormatString} hh:mm a`}
+          mask={`${dateFormatInfo.dateFormatMask} __:__ _m`}
+          minutesStep={5}
+          error={status === 'error'}
+          helperText={helperTextToDisplay}
+          size='small'
+          label={label}
+          value={value || null}
+          onChange={handleChange}
+          onAccept={handleAccept}
+          data-test-id={testId}
+        />
+      </MuiPickersUtilsProvider>
+    </StyledPegaDxilMyDateTimeWrapper>
+  );
+}
+

package/tests/assets/components/SDK-React/createAll/custom-sdk/field/Pega_DXIL_MyDateTime/mock.stories.js

@@ -0,0 +1,12 @@
+export const configProps = {
+  "value": "",
+  "label": "Date Time Sample",
+  "helperText": "Date Time Helper Text",
+  "testId": "datetime-12345678",
+  "hasSuggestions": false
+};
+
+export const stateProps = {
+  "value": ".DateTimeSample",
+  "hasSuggestions": false
+};

package/tests/assets/components/SDK-React/createAll/custom-sdk/field/Pega_DXIL_MyDateTime/styles.js

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

package/tests/assets/components/SDK-React/createAll/custom-sdk/field/Pega_DXIL_MyDecimal/config.json

@@ -0,0 +1,94 @@
+{
+  "name": "Pega_DXIL_MyDecimal",
+  "label": "My Decimal",
+  "description": "My Decimal",
+  "organization": "Pega",
+  "version": "0.0.1",
+  "library": "DXIL",
+  "allowedApplications": [],
+  "componentKey": "Pega_DXIL_MyDecimal",
+  "type": "Field",
+  "subtype": "Decimal",
+  "icon": "images/pz-decimal-active.svg",
+  "properties": [
+    {
+      "name": "label",
+      "label": "Field label",
+      "format": "TEXT",
+      "required": true
+    },
+    {
+      "name": "readOnly",
+      "label": "Edit mode",
+      "format": "READONLY"
+    },
+    {
+      "name": "decimalPrecision",
+      "label": "Decimal places",
+      "format": "NUMBER",
+      "min": 0
+    },
+    {
+      "name": "showGroupSeparators",
+      "label": "Show thousands separator",
+      "format": "BOOLEAN"
+    },
+    {
+      "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"
+  }
+}

package/tests/assets/components/SDK-React/createAll/custom-sdk/field/Pega_DXIL_MyDecimal/demo.stories.jsx

@@ -0,0 +1,54 @@
+import { useState } from 'react';
+import { withKnobs } from '@storybook/addon-knobs';
+import { configProps, fieldMetadata } from './mock.stories.js';
+
+import PegaDxilMyDecimal from './index.tsx';
+
+export default {
+  title: 'PegaDxilMyDecimal',
+  decorators: [withKnobs],
+  component: PegaDxilMyDecimal
+};
+
+export const BasePegaDxilMyDecimal = () => {
+  const [value, setValue] = useState(configProps.value);
+
+  const props = {
+    value,
+    placeholder: configProps.placeholder,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    testId: configProps.testId,
+    fieldMetadata,
+    getPConnect: () => {
+      return {
+        getActionsApi: () => {
+          return {
+            updateFieldValue: (propName, theValue) => {
+              setValue(theValue?.toString());
+            },
+            triggerFieldChange: () => {/* nothing */}
+          };
+        },
+        getStateProps: () => {
+          return { value: '.name' };
+        },
+        getComponentName: () => {
+          return 'Decimal';
+        }
+      };
+    },
+    onChange: event => {
+      setValue(event.target.value);
+    },
+    onBlur: () => {
+      return configProps.value;
+    }
+  };
+
+  return (
+    <>
+      <PegaDxilMyDecimal {...props} />
+    </>
+  );
+};

package/tests/assets/components/SDK-React/createAll/custom-sdk/field/Pega_DXIL_MyDecimal/index.tsx

@@ -0,0 +1,125 @@
+import React, { useState, useEffect } from 'react';
+import CurrencyTextField from '@unicef/material-ui-currency-textfield';
+import { getCurrencyCharacters, getCurrencyOptions } from '@pega/react-sdk-components/lib/components/field/Currency/currency-utils.js';
+import handleEvent from '@pega/react-sdk-components/lib/components/helpers/event-utils';
+import { format } from "@pega/react-sdk-components/lib/components/helpers/formatters";
+import type { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
+
+import StyledPegaDxilMyDecimalWrapper from './styles';
+
+interface PegaDxilMyDecimalProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on this componentName
+    currencyISOCode?: string,
+  decimalPrecision?: number,
+  showGroupSeparators?: string
+}
+
+
+// Using control from: https://github.com/unicef/material-ui-currency-textfield
+
+// Duplicated runtime code from React SDK
+
+// 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
+export default function PegaDxilMyDecimal(props: PegaDxilMyDecimalProps) {
+  const {
+    getPConnect,
+    label,
+    required,
+    disabled,
+    value = '',
+    validatemessage,
+    status,
+    /* onChange, onBlur, */
+    readOnly,
+    helperText,
+    displayMode,
+    hideLabel,
+    currencyISOCode = "USD",
+    decimalPrecision = 2,
+    showGroupSeparators = true,
+    testId
+  } = props;
+
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const propName = pConn.getStateProps()["value"];
+  const helperTextToDisplay = validatemessage || helperText;
+
+  const FieldValueList = getComponentFromMap("FieldValueList");
+
+  const [decValue, setDecimalvalue] = useState("");
+  const [theCurrDec, setCurrDec] = useState(".");
+  const [theCurrSep, setCurrSep] = useState(",");
+
+  useEffect(() => {
+    const theSymbols = getCurrencyCharacters(currencyISOCode);
+    setCurrDec(theSymbols.theDecimalIndicator);
+    setCurrSep(theSymbols.theDigitGroupSeparator);
+  }, [currencyISOCode]);
+
+  useEffect(() => {
+    setDecimalvalue(value.toString());
+  }, [value]);
+
+  const theCurrencyOptions = getCurrencyOptions(currencyISOCode);
+  const formattedValue = format(value, pConn.getComponentName().toLowerCase(), theCurrencyOptions);
+
+  if (displayMode === 'LABELS_LEFT') {
+    return <FieldValueList name={hideLabel ? '' : label} value={formattedValue} />;
+  }
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    return <FieldValueList name={hideLabel ? '' : label} value={formattedValue} variant='stacked' />;
+  }
+
+  let readOnlyProp = {}; // Note: empty if NOT ReadOnly
+
+  if (readOnly) {
+    readOnlyProp = { readOnly: true };
+  }
+
+  let testProp = {};
+
+  testProp = {
+    'data-test-id': testId
+  };
+
+  function decimalOnChange(event) {
+    // update internal value
+    setDecimalvalue(event?.target?.value);
+  }
+
+  function decimalOnBlur(event, inValue) {
+    handleEvent(actions, 'changeNblur', propName, inValue !== '' ? Number(inValue) : inValue);
+  }
+
+  return (
+    <StyledPegaDxilMyDecimalWrapper>
+      <CurrencyTextField
+        fullWidth
+        variant={readOnly ? 'standard' : 'outlined'}
+        helperText={helperTextToDisplay}
+        placeholder=''
+        size='small'
+        required={required}
+        disabled={disabled}
+        onChange={decimalOnChange}
+        onBlur={!readOnly ? decimalOnBlur : undefined}
+        error={status === 'error'}
+        label={label}
+        value={decValue}
+        type='text'
+        outputFormat='number'
+        textAlign='left'
+        InputProps={{ ...readOnlyProp, inputProps: { ...testProp, value: decValue } }}
+        currencySymbol=''
+        decimalCharacter={theCurrDec}
+        digitGroupSeparator={showGroupSeparators ? theCurrSep : ''}
+        decimalPlaces={decimalPrecision}
+      />
+    </StyledPegaDxilMyDecimalWrapper>
+  );
+}
+

package/tests/assets/components/SDK-React/createAll/custom-sdk/field/Pega_DXIL_MyDecimal/mock.stories.js

@@ -0,0 +1,14 @@
+export const configProps = {
+  value: '',
+  label: 'Decimal Sample',
+  placeholder: 'Decimal Placeholder',
+  helperText: 'Decimal Helper Text',
+  testId: 'decimal-12345678'
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Decimal',
+  displayAs: 'pxNumber',
+  label: 'Decimal sample'
+};

package/tests/assets/components/SDK-React/createAll/custom-sdk/field/Pega_DXIL_MyDecimal/styles.js

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

package/tests/assets/components/SDK-React/createAll/custom-sdk/field/Pega_DXIL_MyEmail/config.json

@@ -0,0 +1,83 @@
+{
+  "name": "Pega_DXIL_MyEmail",
+  "label": "My Email",
+  "description": "My Email",
+  "organization": "Pega",
+  "version": "0.0.1",
+  "library": "DXIL",
+  "allowedApplications": [],
+  "componentKey": "Pega_DXIL_MyEmail",
+  "type": "Field",
+  "subtype": "Text-Email",
+  "icon": "images/pz-email-active.svg",
+ "properties": [
+    {
+      "name": "label",
+      "label": "Field label",
+      "format": "TEXT",
+      "required": true
+    },
+    {
+      "name": "readOnly",
+      "label": "Edit mode",
+      "format": "READONLY"
+    },
+    {
+      "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"
+  }
+}

package/tests/assets/components/SDK-React/createAll/custom-sdk/field/Pega_DXIL_MyEmail/demo.stories.jsx

@@ -0,0 +1,48 @@
+import { useState } from 'react';
+import PegaDxilMyEmail from './index.tsx';
+import { withKnobs } from '@storybook/addon-knobs';
+import { configProps } from './mock.stories';
+
+export default {
+  title: 'PegaDxilMyEmail',
+  decorators: [withKnobs],
+  component: PegaDxilMyEmail
+};
+
+export const BasePegaDxilMyEmail = () => {
+  const [value, setValue] = useState(configProps.value);
+
+  const props = {
+    value,
+    placeholder: configProps.placeholder,
+    label: configProps.label,
+    testId: configProps.testId,
+    hasSuggestions: configProps.hasSuggestions,
+    helperText: configProps.helperText,
+    disabled: configProps.disabled,
+    required: configProps.required,
+    readOnly: configProps.readOnly,
+    displayMode: configProps.displayMode,
+    getPConnect: () => {
+      return {
+        getActionsApi: () => {
+          return {
+            updateFieldValue: (propName, theValue) => {
+              setValue(theValue);
+            }
+          };
+        },
+        getStateProps: () => {
+          return { value: '.name' };
+        }
+      };
+    },
+    onChange: (event) => { setValue(event.target.value); },
+    onBlur: () => { return configProps.value; }
+  };
+  return (
+    <>
+      <PegaDxilMyEmail {...props} />
+    </>
+  );
+};

package/tests/assets/components/SDK-React/createAll/custom-sdk/field/Pega_DXIL_MyEmail/index.tsx

@@ -0,0 +1,88 @@
+
+import React from 'react';
+import { TextField, InputAdornment } from '@material-ui/core';
+import MailOutlineIcon from '@material-ui/icons/MailOutline';
+import type { PConnFieldProps } from '@pega/react-sdk-components/lib/types/PConnProps';
+import { getComponentFromMap } from '@pega/react-sdk-components/lib/bridge/helpers/sdk_component_map';
+
+
+import StyledPegaDxilMyEmailWrapper from './styles';
+
+interface PegaDxilMyEmailProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on this componentName
+}
+
+
+// Duplicated runtime code from React SDK
+
+// 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
+export default function PegaDxilMyEmail(props: PegaDxilMyEmailProps) {
+  const {
+    label,
+    required,
+    disabled,
+    value = '',
+    validatemessage,
+    status,
+    onChange,
+    onBlur,
+    readOnly,
+    testId,
+    helperText,
+    displayMode,
+    hideLabel
+  } = props;
+  const helperTextToDisplay = validatemessage || helperText;
+
+  const TextInput = getComponentFromMap("TextInput");
+  const FieldValueList = getComponentFromMap("FieldValueList");
+
+  if (displayMode === 'LABELS_LEFT') {
+    return <FieldValueList name={hideLabel ? '' : label} value={value} />;
+  }
+
+  if (displayMode === 'STACKED_LARGE_VAL') {
+    return <FieldValueList name={hideLabel ? '' : label} value={value} variant='stacked' />;
+  }
+
+  if (readOnly) {
+    return <TextInput {...props} />;
+  }
+
+  let testProp = {};
+
+  testProp = {
+    'data-test-id': testId
+  };
+
+  return (
+    <StyledPegaDxilMyEmailWrapper>
+     <TextField
+      fullWidth
+      variant='outlined'
+      helperText={helperTextToDisplay}
+      placeholder=''
+      size='small'
+      required={required}
+      disabled={disabled}
+      onChange={onChange}
+      onBlur={!readOnly ? onBlur : undefined}
+      error={status === 'error'}
+      label={label}
+      value={value}
+      type='email'
+      InputProps={{
+        startAdornment: (
+          <InputAdornment position='start'>
+            <MailOutlineIcon />
+          </InputAdornment>
+        ),
+        inputProps: { ...testProp }
+      }}
+    />
+    </StyledPegaDxilMyEmailWrapper>
+  );
+}
+
+

package/tests/assets/components/SDK-React/createAll/custom-sdk/field/Pega_DXIL_MyEmail/mock.stories.js

@@ -0,0 +1,13 @@
+// eslint-disable-next-line import/prefer-default-export
+export const configProps = {
+  value: '',
+  label: 'Email Sample',
+  placeholder: 'Email Placeholder',
+  helperText: 'Email Helper Text',
+  testId: 'email-12345678',
+  hasSuggestions: false,
+  readOnly: false,
+  required: false,
+  disabled: false,
+  displayMode: ''
+};

package/tests/assets/components/SDK-React/createAll/custom-sdk/field/Pega_DXIL_MyEmail/styles.js

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