@pega/custom-dx-components 23.1.10 → 23.1.12

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDecimal/mock.ts

@@ -0,0 +1,30 @@
+
+// @ts-nocheck
+export const configProps = {
+  value: '',
+  label: 'Decimal Sample',
+  showGroupSeparators: true,
+  placeholder: 'Decimal Placeholder',
+  helperText: 'Decimal Helper Text',
+  testId: 'decimal-12345678',
+  hasSuggestions: false,
+  displayMode: '',
+  hideLabel: false,
+  readOnly: false,
+  required: false,
+  disabled: false,
+  status: '',
+  validatemessage: ''
+};
+
+export const stateProps = {
+  value: '.DecimalSample',
+  hasSuggestions: false
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Decimal',
+  displayAs: 'pxNumber',
+  label: 'Decimal sample'
+};

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDecimal/styles.ts

@@ -0,0 +1,8 @@
+// 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/Constellation/Pega_DXIL_MyDecimal/suggestions-handler.ts

@@ -0,0 +1,9 @@
+export const suggestionsHandler = (accepted: boolean, pConn: any, setStatus: any) => {
+  if (accepted) {
+    pConn.acceptSuggestion();
+    setStatus('success');
+  } else {
+    pConn.ignoreSuggestion();
+    setStatus(undefined);
+  }
+};

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDetails/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/Constellation/Pega_DXIL_MyDetails/StatusWork.tsx

@@ -0,0 +1,28 @@
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import React from 'react';
+import { Status } from "@pega/cosmos-react-core";
+
+export default function StatusWorkRenderer({ value }: any) {
+  let variant: "pending" | "success" | "info" | "warn" | "urgent" = "info";
+
+  const warnStrings = ["fail", "cancel", "reject", "revoke", "stopped", "warn"];
+  const infoStrings = ["open", "hold", "info", "new"];
+  const successStrings = ["resolved", "completed", "success"];
+  const pendingStrings = ["pending"];
+
+  if (new RegExp(warnStrings.join("|"), "i").test(value)) {
+    variant = "warn";
+  } else if (new RegExp(infoStrings.join("|"), "i").test(value)) {
+    variant = "info";
+  } else if (new RegExp(successStrings.join("|"), "i").test(value)) {
+    variant = "success";
+  } else if (new RegExp(pendingStrings.join("|"), "i").test(value)) {
+    variant = "pending";
+  }
+
+  return (
+    <Status type="rectangle" variant={variant}>
+      {value}
+    </Status>
+  );
+}

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDetails/demo.stories.tsx

@@ -0,0 +1,149 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import type { Meta, StoryObj } from '@storybook/react';
+import { Text, FieldValueList, Button, DateTimeDisplay, useTheme } from '@pega/cosmos-react-core';
+import PegaDxilMyDetails from './index';
+import { pyReviewRaw, pyReviewResolved, regionChildrenResolved } from './mock';
+import StatusWorkRenderer from './StatusWork';
+
+
+const meta: Meta<typeof PegaDxilMyDetails> = {
+  title: 'PegaDxilMyDetails',
+  component: PegaDxilMyDetails,
+  excludeStories: /.*Data$/,
+  parameters: {
+    type: 'Details'
+  }
+};
+
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyDetails>;
+
+const renderField = resolvedProps => {
+  const {
+    displayAsStatus = false,
+    displayMode,
+    value = '',
+    label = '',
+    key,
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    theme = useTheme()
+  } = resolvedProps;
+
+  const variant = displayMode === 'LABELS_LEFT' ? 'inline' : 'stacked';
+
+  let val =
+    value !== '' ? (
+      <Text variant='h1' as='span' key={key}>
+        {value}
+      </Text>
+    ) : (
+      ''
+    );
+
+  if (label === 'Create date/time')
+    val = (
+      <DateTimeDisplay
+        value={value}
+        variant='datetime'
+        format='long'
+        clockFormat={null}
+        key={key}
+      />
+    );
+
+  if (displayAsStatus === true) val = <StatusWorkRenderer value={value} key={key} />;
+
+  if (label === 'Create Operator')
+    val = (
+      <Button
+        key={key}
+        variant='link'
+        style={
+          label !== null
+            ? { width: 'max-content', height: theme.components.input.height }
+            : undefined
+        }
+      >
+        {value.userName}
+      </Button>
+    );
+
+  if (variant === 'inline') {
+    val = value || (
+      <span aria-hidden='true' key={key}>
+        &ndash;&ndash;
+      </span>
+    );
+  } else {
+    val = (
+      <Text variant='h1' as='span' key={key}>
+        {val}
+      </Text>
+    );
+  }
+  return <FieldValueList variant={variant} fields={[{ name: label, value: val }]} key={key} />;
+};
+
+export const BasePegaDxilMyDetails: Story = args => {
+  const props = {
+    template: 'MyCo_MyComponents_NewDetailsTemplate',
+    showHighlightedData: true,
+    label: 'Test Details',
+    showLabel: true,
+    getPConnect: () => {
+      return {
+        getChildren: () => {
+          return pyReviewRaw.children;
+        },
+        getRawMetadata: () => {
+          return pyReviewRaw;
+        },
+        getContextName: () => {
+          return 'app/primary_1';
+        },
+        getInheritedProps: () => {
+          return pyReviewRaw.config.inheritedProps;
+        },
+        createComponent: config => {
+          // eslint-disable-next-line default-case
+          switch (config.config.value) {
+            case '@P .pyStatusWork':
+              return renderField(pyReviewResolved.highlightedData[0].config);
+            case '@P .pyID':
+              return renderField(pyReviewResolved.highlightedData[1].config);
+            case '@P .pxCreateDateTime':
+              return renderField(pyReviewResolved.highlightedData[2].config);
+            case '@USER .pxCreateOperator':
+              return renderField(pyReviewResolved.highlightedData[3].config);
+            case '@P .pySLADeadline':
+              return renderField(regionChildrenResolved[0]);
+            case '@P .pySLAGoal':
+              return renderField(regionChildrenResolved[1]);
+            case '@P .pySLAStartTime':
+              return renderField(regionChildrenResolved[2]);
+          }
+        },
+        setInheritedProp: () => {
+          /* nothing */
+        },
+        resolveConfigProps: () => {
+          /* nothing */
+        }
+      };
+    }
+  };
+
+  const regionAChildren = pyReviewRaw.children[0].children.map(child => {
+    return props.getPConnect().createComponent(child);
+  });
+
+  return (
+    <>
+      <PegaDxilMyDetails {...props} {...args}>{regionAChildren}</PegaDxilMyDetails>
+    </>
+  );
+};
+
+BasePegaDxilMyDetails.args = {};

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDetails/index.tsx

@@ -0,0 +1,88 @@
+import { Fragment } from 'react';
+import { Grid, Flex, FieldGroup, withConfiguration } from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
+
+import StyledPegaDxilMyDetailsWrapper from './styles';
+
+// includes in bundle
+import { getAllFields } from './utils';
+
+
+// interface for props
+interface PegaDxilMyDetailsProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  showLabel: boolean;
+  showHighlightedData: boolean;
+  children: 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
+function PegaDxilMyDetails(props: PegaDxilMyDetailsProps) {
+
+  const { getPConnect, children, label, showLabel = true, showHighlightedData = false  } = props;
+  const propsToUse = { label, showLabel, ...getPConnect().getInheritedProps() };
+
+  const numRegions = getAllFields(getPConnect)?.length;
+  const gridRepeat = "repeat(".concat(numRegions).concat(", 1fr)");
+  const gridContainer = { "colGap": 1};
+  // @ts-ignore
+  gridContainer.cols = gridRepeat;
+  // @ts-ignore
+  gridContainer.alignItems = 'start';
+
+  const gridHighlightContainer = { "gap": 2};
+  // @ts-ignore
+  gridHighlightContainer.cols = gridRepeat;
+  // @ts-ignore
+  gridHighlightContainer.alignItems = 'start';
+  // @ts-ignore
+  gridHighlightContainer.pad = [0, 0, 2, 0];
+
+  // Set up highlighted data to pass in return if is set to show, need raw metadata to pass to createComponent
+  let highlightedDataArr = [];
+  if (showHighlightedData) {
+    // @ts-ignore
+    const { highlightedData = [] } = getPConnect().getRawMetadata().config;
+    // @ts-ignore
+    highlightedDataArr = highlightedData.map((field) => {
+      field.config.displayMode = 'STACKED_LARGE_VAL';
+
+      // Mark as status display when using pyStatusWork
+      if (field.config.value === '@P .pyStatusWork') {
+        field.type = 'TextInput';
+        field.config.displayAsStatus = true;
+      }
+      // @ts-ignore
+      return getPConnect().createComponent(field);
+    });
+  }
+
+  return (
+    <StyledPegaDxilMyDetailsWrapper>
+    <FieldGroup name={propsToUse.showLabel ? propsToUse.label : ''}>
+      {showHighlightedData && highlightedDataArr.length > 0 && (
+        <Grid container={gridHighlightContainer}
+          data-testid={`highlighted-column-count-${numRegions}`}>
+          {highlightedDataArr.map((child: any, i: number) => (
+            <Fragment key={`hf-${i + 1}`}>{child}</Fragment>
+          ))}
+        </Grid>
+      )}
+      <Grid container={gridContainer} data-testid={`column-count-${numRegions}`} >
+       {children.map((child: any, i: number) => (
+        <Flex container={{ direction: 'column'}} key={`r-${i + 1}`}>
+        {child}
+        </Flex>
+       ))}
+      </Grid>
+    </FieldGroup>
+    </StyledPegaDxilMyDetailsWrapper>
+  );
+
+}
+
+
+export default withConfiguration(PegaDxilMyDetails);

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDetails/mock.ts

@@ -0,0 +1,192 @@
+
+
+// @ts-nocheck
+export const pyReviewRaw = {
+  name: 'pyReview',
+  type: 'View',
+  config: {
+    template: 'Details',
+    ruleClass: 'MyCo-MyCompon-Work-MyComponents',
+    showLabel: true,
+    label: '@L Details',
+    localeReference: '@LR MYCO-MYCOMPON-WORK-MYCOMPONENTS!VIEW!PYREVIEW',
+    showHighlightedData: true,
+    highlightedData: [
+      {
+        type: 'TextInput',
+        config: {
+          value: '@P .pyStatusWork',
+          label: '@L Work Status',
+          displayMode: 'STACKED_LARGE_VAL',
+          displayAsStatus: true,
+          key: 'pyStatusWork'
+        }
+      },
+      {
+        type: 'TextInput',
+        config: {
+          value: '@P .pyID',
+          label: '@L Case ID',
+          displayMode: 'STACKED_LARGE_VAL',
+          key: 'pyID'
+        }
+      },
+      {
+        type: 'DateTime',
+        config: {
+          value: '@P .pxCreateDateTime',
+          label: '@L Create date/time',
+          displayMode: 'STACKED_LARGE_VAL',
+          key: 'pxCreateDateTime'
+        }
+      },
+      {
+        type: 'UserReference',
+        config: {
+          label: '@L Create Operator',
+          value: '@USER .pxCreateOperator',
+          placeholder: 'Select...',
+          displayMode: 'STACKED_LARGE_VAL',
+          key: 'pxCreateOperator'
+        }
+      }
+    ],
+    inheritedProps: [
+      {
+        prop: 'label',
+        value: '@L Details'
+      },
+      {
+        prop: 'showLabel',
+        value: true
+      }
+    ]
+  },
+  children: [
+    {
+      name: 'A',
+      type: 'Region',
+      getPConnect: () => {
+        return {
+          getRawMetadata: () => {
+            return pyReviewRaw.children[0];
+          }
+        };
+      },
+      children: [
+        {
+          type: 'DateTime',
+          config: {
+            value: '@P .pySLADeadline',
+            label: '@L SLA Deadline'
+          },
+          key: '1'
+        },
+        {
+          type: 'DateTime',
+          config: {
+            value: '@P .pySLAGoal',
+            label: '@L SLA Goal'
+          },
+          key: '2'
+        },
+        {
+          type: 'RadioButtons',
+          config: {
+            value: '@P .pySLAStartTime',
+            label: '@L SLA Start Time',
+            listType: 'associated',
+            datasource: '@ASSOCIATED .pySLAStartTime'
+          },
+          key: '3'
+        }
+      ]
+    }
+  ],
+  classID: 'MyCo-MyCompon-Work-MyComponents'
+};
+
+export const pyReviewResolved = {
+  readOnly: true,
+  template: 'Details',
+  ruleClass: 'MyCo-MyCompon-Work-MyComponents',
+  showLabel: true,
+  label: 'Details',
+  localeReference: 'MYCO-MYCOMPON-WORK-MYCOMPONENTS!VIEW!PYREVIEW',
+  showHighlightedData: true,
+  highlightedData: [
+    {
+      type: 'TextInput',
+      config: {
+        value: 'New',
+        label: 'Work Status',
+        displayMode: 'STACKED_LARGE_VAL',
+        displayAsStatus: true
+      }
+    },
+    {
+      type: 'TextInput',
+      config: {
+        value: 'M-1002',
+        label: 'Case ID',
+        displayMode: 'STACKED_LARGE_VAL'
+      }
+    },
+    {
+      type: 'DateTime',
+      config: {
+        value: '2022-12-11T20:06:27.232Z',
+        label: 'Create date/time',
+        displayMode: 'STACKED_LARGE_VAL'
+      }
+    },
+    {
+      type: 'UserReference',
+      config: {
+        label: 'Create Operator',
+        value: {
+          userId: 'conns',
+          userName: 'Sara Connor'
+        },
+        placeholder: 'Select...',
+        displayMode: 'STACKED_LARGE_VAL'
+      }
+    }
+  ],
+  displayMode: 'LABELS_LEFT'
+};
+
+export const regionChildrenResolved = [
+  {
+    readOnly: true,
+    value: '',
+    label: 'SLA Deadline',
+    displayMode: 'LABELS_LEFT',
+    key: 'SLA Deadline'
+  },
+  {
+    readOnly: true,
+    value: '',
+    label: 'SLA Goal',
+    displayMode: 'LABELS_LEFT',
+    key: 'SLA Goal'
+  },
+  {
+    readOnly: true,
+    value: '',
+    label: 'SLA Start Time',
+    listType: 'associated',
+    datasource: [
+      {
+        key: 'AssignmentCreation',
+        value: 'The creation time of the Assignment'
+      },
+      {
+        key: 'CurrentTime',
+        value: 'Current Date Time'
+      }
+    ],
+    displayMode: 'LABELS_LEFT',
+    key: 'SLA Start Time'
+  }
+];

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyDetails/styles.ts

@@ -0,0 +1,8 @@
+// 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/Constellation/Pega_DXIL_MyDetails/utils.js

@@ -1,5 +1,3 @@
-/* eslint-disable no-undef */
-
 /**
  * Given the PConnect object of a Template component, retrieve the children
  * metadata of all regions.
@@ -137,9 +135,10 @@ export function getInstructions(pConnect, instructions = 'casestep') {
 
   // If the annotation wasn't processed correctly, don't return any instruction text
   if (instructions?.startsWith('@PARAGRAPH')) {
-     /* eslint-disable no-console */
+    /* eslint-disable no-console */
     console.error('@PARAGRAPH annotation was not processed. Hiding custom instructions.');
-    /* eslint-enable no-console */    return undefined;
+    /* eslint-enable no-console */
+    return undefined;
   }
 
   // Custom instructions from the view

package/tests/assets/components/createAll/Constellation/Pega_DXIL_MyEmail/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
+}