@pega/custom-dx-components 0.23.20 → 0.23.22

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyAutocomplete/Pega_DXIL_MyBoolean/config.json

@@ -0,0 +1,145 @@
+{
+  "name": "Pega_DXIL_MyBoolean",
+  "label": "My Boolean",
+  "description": "My Boolean",
+  "organization": "Pega",
+  "version": "0.0.1",
+  "library": "DXIL",
+  "allowedApplications": [],
+  "componentKey": "Pega_DXIL_MyBoolean",
+  "type": "Field",
+  "subtype": "Boolean",
+  "icon": "images/pz-checkbox-active.svg",
+  "properties": [
+    {
+      "name": "label",
+      "label": "Field label",
+      "format": "TEXT"
+    },
+    {
+      "name": "hideLabel",
+      "label": "Hide Label",
+      "format": "BOOLEAN"
+    },
+    {
+      "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": "caption",
+          "label": "Caption",
+          "format": "TEXT",
+          "useAsAuthoringLabel": true
+        },
+        {
+          "name": "helperText",
+          "label": "Helper text",
+          "format": "TEXT"
+        }
+      ]
+    },
+    {
+      "label": "Read-only settings",
+      "format": "GROUP",
+      "properties": [
+        {
+          "format": "SELECT",
+          "name": "displayValue",
+          "label": "Display Value",
+          "defaultValue": "Yes/No",
+          "localize": true,
+          "splitValues": {
+            "token": "/",
+            "propertyNames": ["trueLabel", "falseLabel"]
+          },
+          "source": [
+            {
+              "key": "Yes/No",
+              "value": "Yes/No"
+            },
+            {
+              "key": "True/False",
+              "value": "True/False"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "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": {
+    "caption": "@L $this.label",
+    "trueLabel": "@L Yes",
+    "falseLabel": "@L No"
+  }
+}

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyAutocomplete/Pega_DXIL_MyBoolean/demo.stories.tsx

@@ -0,0 +1,64 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import { useState } from 'react';
+import { withKnobs } from '@storybook/addon-knobs';
+
+import { configProps, stateProps } from './mock';
+
+import PegaDxilMyBoolean from './index';
+
+export default {
+  title: 'PegaDxilMyBoolean',
+  decorators: [withKnobs],
+  component: PegaDxilMyBoolean
+};
+
+export const BasePegaDxilMyBoolean = () => {
+
+  const [value, setValue] = useState(configProps.value);
+
+  const props = {
+    value,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    caption: configProps.caption,
+    validatemessage: configProps.validatemessage,
+    hideLabel: configProps.hideLabel,
+    testId: configProps.testId,
+    additionalProps: configProps.additionalProps,
+    displayMode: configProps.displayMode,
+    variant: configProps.variant,
+    trueLabel: configProps.trueLabel,
+    falseLabel: configProps.falseLabel,
+    disabled: configProps.disabled,
+    readOnly: configProps.readOnly,
+    required: configProps.required,
+    getPConnect: () => {
+      return {
+        getStateProps: () => {
+          return stateProps;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: (propName, theValue) => {
+              setValue(theValue);
+            },
+            triggerFieldChange: () => { /* nothing */}
+          };
+        },
+        getValidationApi: () => {
+          return {
+            validate: () => { /* nothing */}
+          };
+        }
+      };
+    }
+  };
+
+  return (
+    <>
+      <PegaDxilMyBoolean {...props} />
+    </>
+  );
+};

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyAutocomplete/Pega_DXIL_MyBoolean/event-utils.ts

@@ -0,0 +1,18 @@
+const handleEvent = (actions: any, eventType: string, propName: string, value: string) => {
+  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/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyAutocomplete/Pega_DXIL_MyBoolean/index.tsx

@@ -0,0 +1,196 @@
+import {
+  Checkbox as CosmosCheckbox,
+  CheckboxGroup,
+  FieldValueList,
+  Text
+} from "@pega/cosmos-react-core";
+import PropTypes from "prop-types";
+
+import type { PConnFieldProps } from './PConnProps';
+
+// includes in bundle
+import handleEvent from "./event-utils";
+import StyledPegaDxilMyBooleanWrapper from './styles';
+
+// interface for props
+interface PegaDxilMyBooleanProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  displayAsStatus?: boolean;
+  isTableFormatter?: boolean;
+  hasSuggestions?: boolean;
+  variant?: any;
+  formatter: string;
+  caption: string;
+  trueLabel: string;
+  falseLabel: string;
+}
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
+
+interface ActionsProps {
+  onClick: any;
+}
+
+// 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
+export default function PegaDxilMyBoolean(props: PegaDxilMyBooleanProps) {
+  const {
+    getPConnect,
+    value,
+    label,
+    helperText,
+    caption,
+    validatemessage,
+    hideLabel,
+    testId,
+    additionalProps,
+    displayMode,
+    variant,
+    trueLabel,
+    falseLabel
+  } = props;
+  const pConn = getPConnect();
+  const actions = pConn.getActionsApi();
+  const actionsProps = pConn.getActionsApi() as unknown as ActionsProps;
+  const stateProps = pConn.getStateProps() as StateProps;
+  let propName: string = stateProps.value;
+
+  let { readOnly, required, disabled } = props;
+  [readOnly, required, disabled] = [readOnly, required, disabled].map(
+    (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
+  );
+
+  let status: "error" | "success" | "warning" | "pending" | undefined;
+  if (validatemessage !== "") {
+    status = "error";
+  }
+
+  const aCosmosCheckbox = (
+    <CosmosCheckbox
+      {...additionalProps}
+      className="standard"
+      checked={value}
+      label={caption}
+      disabled={disabled}
+      readOnly={readOnly}
+      required={required}
+      onClick={actionsProps.onClick}
+      onChange={(event) => {
+        handleEvent(actions, "changeNblur", propName, (event.target.checked).toString());
+      }}
+      onBlur={(event: { target: { checked: any; }; }) => {
+        // @ts-ignore
+        pConn.getValidationApi().validate(event.target.checked);
+      }}
+      data-testid={testId}
+    />
+  );
+
+  const parentTestId = testId === '' ? `${testId}-parent` : testId;
+
+  let displayComponent;
+  if (displayMode) {
+    // @ts-ignore
+    displayComponent = <PegaDxilMyBoolean  value={value} trueLabel={trueLabel} falseLabel={falseLabel} />;
+  }
+
+  if (displayMode === 'DISPLAY_ONLY') {
+    return ( <StyledPegaDxilMyBooleanWrapper> displayComponent </StyledPegaDxilMyBooleanWrapper>);
+  }
+
+  if (displayMode === "LABELS_LEFT") {
+    return (
+      <StyledPegaDxilMyBooleanWrapper>
+      <FieldValueList
+        variant={hideLabel ? 'stacked' : variant}
+        data-testid={testId}
+        fields={[{ id: '1', name: hideLabel ? '' : caption, value: displayComponent }]}
+      />
+     </StyledPegaDxilMyBooleanWrapper>
+    );
+  }
+
+  if (displayMode === "STACKED_LARGE_VAL") {
+    return (
+      <StyledPegaDxilMyBooleanWrapper>
+      <FieldValueList
+        variant='stacked'
+        data-testid={testId}
+        fields={[
+          {
+            id: '2',
+            name: hideLabel ? '' : caption,
+            value: (
+              <Text variant='h1' as='span'>
+                {displayComponent}
+              </Text>
+            )
+          }
+        ]}
+      />
+      </StyledPegaDxilMyBooleanWrapper>
+    );
+  }
+
+
+  return (
+    <StyledPegaDxilMyBooleanWrapper>
+    <CheckboxGroup
+      label={label}
+      labelHidden={hideLabel}
+      data-testid={parentTestId}
+      info={validatemessage || helperText}
+      status={status}
+    >
+      {aCosmosCheckbox}
+    </CheckboxGroup>
+    </StyledPegaDxilMyBooleanWrapper>
+  );
+
+
+};
+
+
+PegaDxilMyBoolean.defaultProps = {
+  validatemessage: '',
+  value: false,
+  label: '',
+  hideLabel: false,
+  helperText: '',
+  disabled: false,
+  readOnly: false,
+  required: false,
+  testId: '',
+  additionalProps: {},
+  displayMode: null,
+  variant: 'inline',
+  displayValue: 'Yes/No',
+  trueLabel: '',
+  falseLabel: ''
+};
+
+PegaDxilMyBoolean.propTypes = {
+  getPConnect: PropTypes.func.isRequired,
+  validatemessage: PropTypes.string,
+  label: PropTypes.string,
+  hideLabel: PropTypes.bool,
+  helperText: PropTypes.string,
+  value: PropTypes.bool,
+  caption: PropTypes.string.isRequired,
+  disabled: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  readOnly: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  required: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
+  testId: PropTypes.string,
+  additionalProps: PropTypes.objectOf(PropTypes.any),
+  displayMode: PropTypes.string,
+  variant: PropTypes.string,
+  displayValue: PropTypes.string,
+  trueLabel: PropTypes.string,
+  falseLabel: PropTypes.string
+};

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyAutocomplete/Pega_DXIL_MyBoolean/mock.ts

@@ -0,0 +1,22 @@
+// @ts-nocheck
+export const configProps = {
+  value: true,
+  label: 'Boolean label',
+  helperText: 'Test helper text',
+  caption: 'Boolean caption',
+  validatemessage: '',
+  hideLabel: false,
+  testId: '12345678',
+  additionalProps: {},
+  displayMode: '',
+  variant: '',
+  trueLabel: 'True',
+  falseLabel: 'False',
+  disabled: false,
+  readOnly: false,
+  required: true
+};
+
+export const stateProps = {
+  value: '.Test'
+};

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyAutocomplete/Pega_DXIL_MyBoolean/styles.ts

@@ -0,0 +1,15 @@
+
+// utilizing theming, comment out, if want individual style
+import styled from 'styled-components';
+import { Configuration } from '@pega/cosmos-react-core';
+
+export default styled(Configuration)``;
+
+// individual style, comment out above, and uncomment here and add styles
+// import styled, { css } from 'styled-components';
+//
+// export default styled.div(() => {
+//  return css`
+//    margin: 0px 0;
+//  `;
+// });

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyAutocomplete/Pega_DXIL_MyCaseWidget/OneColumnPage.svg

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="100px" height="70px" viewBox="0 0 100 70" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>1 col </title>
+    <defs>
+        <rect id="path-1" x="0" y="0" width="100" height="70"></rect>
+    </defs>
+    <g id="Concepts" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="Templates" transform="translate(-98.000000, -108.000000)">
+            <g id="Change-template" transform="translate(42.000000, 36.000000)">
+                <g id="1-col-" transform="translate(56.000000, 72.000000)">
+                    <mask id="mask-2" fill="white">
+                        <use xlink:href="#path-1"></use>
+                    </mask>
+                    <rect stroke="#A5A8BC" stroke-width="0.5" x="0.25" y="0.25" width="99.5" height="69.5"></rect>
+                    <g id="white" mask="url(#mask-2)" fill="#FFFFFF">
+                        <g transform="translate(3.000000, 3.000000)" id="Rectangle">
+                            <rect x="0" y="0" width="94" height="66.5"></rect>
+                        </g>
+                    </g>
+                    <g id="gray" mask="url(#mask-2)" fill="#8084A7">
+                        <g transform="translate(6.000000, 6.000000)" id="Rectangle">
+                            <rect x="0" y="-2.84217094e-14" width="88" height="77.8"></rect>
+                        </g>
+                    </g>
+                    <g id="labels" mask="url(#mask-2)" font-family="OpenSans-Semibold, Open Sans" font-size="11" font-weight="500">
+                        <g transform="translate(44.000000, 17.000000)" id="A">
+                            <text>
+                                <tspan x="0.75" y="12" fill="#FFFFFF">A</tspan>
+                            </text>
+                        </g>
+                    </g>
+                </g>
+            </g>
+        </g>
+    </g>
+</svg>

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyAutocomplete/Pega_DXIL_MyCaseWidget/PConnProps.d.ts

@@ -0,0 +1,46 @@
+import  {PConnect } from '@pega/pcore-pconnect-typedefs';
+
+// PConnProps.d.ts
+// This gives us a place to have each component (which is most DX Components) that is
+//  expected to have a getPConnect extend its props (from BaseProps)
+//  such that every component will be expected to have a getPConnect() function
+//  that returns a PConnect object. (new/better way of doing .propTypes).
+//  This PConnProps can be extended to include other props that we know are in every component
+export interface PConnProps {
+  // getPConnect should exist for every C11n component. (add @ts-ignore in special cases where it isn't)
+  getPConnect: () => typeof PConnect;
+
+  // Allow any/all other key/value pairs in the BaseProps for now
+  //  TODO: refine which other props are always expected for various component
+  //    types and consider further interface "subclassing". For example, we may
+  //    want to create a "BasePropsForm" that gives guidance on required, readonly, etc.
+  //    and any other props that every Form component expects.
+  //    For example, see the PConnFieldProps below.
+  // NOTE: if you uncomment the line below, the PConnProps type will allow
+  //  otherwise undefined types to appear. This can be helpful for debugging
+  //  or when adding new components whose types aren't yet known.
+  // [key: string]: any;
+}
+
+
+// PConnFieldProps extends PConnProps to bring in the common properties that are
+// associated with most field components (ex: Dropdown, TextInput, etc.) in the
+//  components/field directory
+export interface PConnFieldProps extends PConnProps {
+  label: string,
+  required: boolean,
+  disabled: boolean,
+  value: any,
+  validatemessage: string,
+  status?: string,
+  onChange?: any,
+  onBlur?: any,
+  readOnly: boolean,
+  testId: string,
+  helperText: string,
+  displayMode?: string,
+  hideLabel: boolean,
+  placeholder?: string,
+  fieldMetadata?: any,
+  additionalProps?: any
+}

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyAutocomplete/Pega_DXIL_MyCaseWidget/config.json

@@ -0,0 +1,23 @@
+{
+  "name": "Pega_DXIL_MyCaseWidget",
+  "label": "My Case Widget",
+  "description": "My Case Widget",
+  "organization": "Pega",
+  "version": "0.0.1",
+  "library": "DXIL",
+  "allowedApplications": [],
+  "componentKey": "Pega_DXIL_MyCaseWidget",
+  "type": "Widget",
+  "subtype": "CASE",
+  "icon": "OneColumnPage.svg",
+  "properties": [
+   {
+      "name": "label",
+      "label": "Label value",
+      "format": "TEXT"
+    }
+  ],
+  "defaultConfig": {
+     "label": "@L My Case Widget"
+  }
+}

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyAutocomplete/Pega_DXIL_MyCaseWidget/demo.stories.tsx

@@ -0,0 +1,81 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import { withKnobs } from '@storybook/addon-knobs';
+
+import PegaDxilMyCaseWidget from './index.jsx';
+
+import historyData from './mock';
+
+export default {
+  title: 'PegaDxilMyCaseWidget',
+  decorators: [withKnobs],
+  component: PegaDxilMyCaseWidget
+};
+
+if (!window.PCore) {
+  window.PCore = {};
+}
+
+window.PCore.getConstants = () => {
+  return {
+    CASE_INFO: {
+      CASE_INFO_ID: 'caseInfo.ID'
+    }
+  };
+};
+
+window.PCore.getLocaleUtils = () => {
+  return {
+    getLocaleValue: value => {
+      return value;
+    }
+  };
+};
+
+window.PCore.getDataApiUtils = () => {
+  return {
+    getData: () => {
+      return new Promise(resolve => {
+        resolve(historyData);
+      });
+    }
+  };
+};
+
+export const BasePegaDxilMyCaseWidget = () => {
+
+  const props = {
+    label: 'Case history',
+
+    getPConnect: () => {
+      return {
+        getValue: value => {
+          return value;
+        },
+        getContextName: () => {
+          return 'app/primary_1';
+        },
+        getLocalizedValue: value => {
+          return value;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {/* nothing */},
+            triggerFieldChange: () => {/* nothing */}
+          };
+        },
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        setInheritedProps: () => {/* nothing */},
+        resolveConfigProps: () => {/* nothing */}
+      };
+    }
+};
+
+return (
+    <>
+      <PegaDxilMyCaseWidget {...props} />
+    </>
+  );
+};