@pega/dx-component-builder-sdk 0.23.10 → 0.23.11

package/tests/assets/sdk-r/components/create/override-sdk/widget/ToDo/config-ext.json

@@ -0,0 +1,9 @@
+{
+    "componentKey": "Todo",
+    "name": "Todo",
+    "label": "Todo",
+    "description": "My worklist widget",
+    "type": "Widget",
+    "subtype": "PAGE",
+    "properties": []
+}

package/tests/assets/sdk-r/components/create/override-sdk/widget/ToDo/index.tsx

@@ -0,0 +1 @@
+export { default } from './ToDo';

package/tests/assets/sdk-r/components/create/override-sdk/widget/_widget.md

@@ -0,0 +1,6 @@
+# The **override-sdk/widget** directory
+
+The **src/components/override-sdk/widget** directory contains the code for **widget** components for which you want to override the default implementation for use with the **React SDK**.
+
+When you run the **npm run  create** command to override the default implementation of a **widget** component, the generated code that you can use as a
+starting point for your component development will be placed in type-specific and component-specific folders in **src/components/override-sdk/widget**.

package/tests/assets/sdk-r/components/createAll/custom-constellation/_custom-constellation.md

@@ -0,0 +1,5 @@
+# The **components/custom-constellation** directory
+
+The **src/components/custom-constellation** directory contains the code for Constellation-related _associated_ components of custom components that you create and use with the **React SDK**.
+These _associated_ components are used to show the preview of the custom component in App Studio when you are authoring your application and App Studio needs to use the Constellation
+design system version of your custom component.

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyBoolean/Boolean.js

@@ -0,0 +1,38 @@
+function Boolean(value, { allowEmpty = true, tick = "", cross = "" } = {}) {
+  if (
+    (!allowEmpty && !value) ||
+    value === false ||
+    value?.toString()?.toLowerCase() === "false" ||
+    value === 0 ||
+    value === "0"
+  ) {
+    return cross || "";
+  }
+  if (
+    value === true ||
+    value?.toString()?.toLowerCase() === "true" ||
+    value === 1 ||
+    value === "1"
+  ) {
+    return tick || "";
+  }
+  if (
+    allowEmpty &&
+    (value === "null" ||
+      value === "" ||
+      value === null ||
+      typeof value === "undefined")
+  ) {
+    return "––";
+  }
+  return value;
+}
+
+export default {
+  TrueFalse: (value, options) =>
+    Boolean(value, {
+      ...options,
+      tick: "True",
+      cross: "False"
+    })
+};

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyBoolean/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/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyBoolean/boolean-format.ts

@@ -0,0 +1,25 @@
+import Boolean from "./Boolean";
+
+export default {
+  ...Boolean
+};
+
+
+
+export function format(value: any, type: string) {
+  let formattedValue;
+
+  switch (type?.toLowerCase()) {
+
+
+    case "boolean":
+    case "checkbox": {
+      formattedValue = Boolean.TrueFalse(value, { allowEmpty: false });
+      break;
+    }
+
+    default:
+      formattedValue = value;
+  }
+  return formattedValue;
+}

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyBoolean/demo.stories.jsx

@@ -0,0 +1,63 @@
+/* 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/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyBoolean/event-utils.ts

@@ -0,0 +1,18 @@
+const handleEvent = (actions: any, eventType: string, propName: string, value: any) => {
+  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/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyBoolean/index.tsx

@@ -0,0 +1,200 @@
+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;
+  const 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);
+      }}
+      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 = (
+      // @ts-ignore
+      <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/sdk-r/components/createAll/custom-constellation/field/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/sdk-r/components/createAll/custom-constellation/field/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/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyCurrency/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/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyCurrency/demo.stories.tsx

@@ -0,0 +1,56 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import { withKnobs } from '@storybook/addon-knobs';
+
+import { configProps, fieldMetadata, stateProps } from './mock';
+
+import PegaDxilMyCurrency from './index';
+
+export default {
+  title: 'PegaDxilMyCurrency',
+  decorators: [withKnobs],
+  component: PegaDxilMyCurrency
+};
+
+export const BasePegaDxilMyCurrency = () => {
+
+  const props = {
+    value: Number(configProps.value),
+    placeholder: configProps.placeholder,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    showGroupSeparators: configProps.showGroupSeparators,
+    allowDecimals: configProps.allowDecimals,
+    currencyISOCode: configProps.currencyISOCode,
+    alwaysShowISOCode: configProps.alwaysShowISOCode,
+    hasSuggestions: configProps.hasSuggestions,
+    testId: configProps.testId,
+    fieldMetadata,
+
+    getPConnect: () => {
+      return {
+        getStateProps: () => {
+          return stateProps;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {/* nothing */},
+            triggerFieldChange: () => {/* nothing */}
+          };
+        },
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        setInheritedProps: () => {/* nothing */},
+        resolveConfigProps: () => {/* nothing */},
+        clearErrorMessages: () => {/* nothing */}
+      };
+    }
+  };
+
+  return (
+    <>
+      <PegaDxilMyCurrency {...props} />
+    </>
+  );
+};

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/Pega_DXIL_MyCurrency/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;