@pega/custom-dx-components 23.1.11 → 24.1.10

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyEmail/index.tsx

@@ -1,6 +1,5 @@
 import { useState, useEffect, useRef } from 'react';
-import { Input, EmailDisplay, FieldValueList, Text, URLDisplay, PhoneDisplay } from '@pega/cosmos-react-core';
-import PropTypes from 'prop-types';
+import { Input, EmailDisplay, FieldValueList, Text, URLDisplay, PhoneDisplay, withConfiguration } from '@pega/cosmos-react-core';
 import type { PConnFieldProps } from './PConnProps';
 
 // includes in bundle
@@ -73,21 +72,21 @@ export const textFormatter = (formatter: string, value: any) => {
 
 // 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) {
+function PegaDxilMyEmail(props: PegaDxilMyEmailProps) {
  const {
     getPConnect,
     value,
     placeholder,
     validatemessage,
     label,
-    hideLabel,
+    hideLabel = false,
     helperText,
     testId,
     displayMode,
-    additionalProps,
-    variant,
-    isTableFormatter,
-    hasSuggestions
+    additionalProps = {},
+    variant = 'inline',
+    isTableFormatter = false,
+    hasSuggestions = false
   } = props;
   const { formatter } = props;
   const pConn = getPConnect();
@@ -98,7 +97,7 @@ export default function PegaDxilMyEmail(props: PegaDxilMyEmailProps) {
   const hasValueChange = useRef(false);
 
 
-  let { readOnly, required, disabled } = props;
+  let { readOnly = false, required = false, disabled = false } = props;
   [readOnly, required, disabled] = [readOnly, required, disabled].map(
     (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
   );
@@ -129,7 +128,7 @@ export default function PegaDxilMyEmail(props: PegaDxilMyEmailProps) {
     }
     return displayMode === 'DISPLAY_ONLY' ? (
       <StyledPegaDxilMyEmailWrapper>
-      displayComp
+      {displayComp}
       </StyledPegaDxilMyEmailWrapper>
     ) : (
       <StyledPegaDxilMyEmailWrapper>
@@ -212,40 +211,4 @@ export default function PegaDxilMyEmail(props: PegaDxilMyEmailProps) {
   );
 }
 
-PegaDxilMyEmail.defaultProps = {
-  value: '',
-  placeholder: '',
-  validatemessage: '',
-  helperText: '',
-  hideLabel: false,
-  disabled: false,
-  readOnly: false,
-  required: false,
-  testId: '',
-  displayMode: null,
-  additionalProps: {},
-  variant: 'inline',
-  formatter: '',
-  isTableFormatter: false,
-  hasSuggestions: false
-};
-
-PegaDxilMyEmail.propTypes = {
-  value: PropTypes.string,
-  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,
-  displayMode: PropTypes.string,
-  additionalProps: PropTypes.objectOf(PropTypes.any),
-  variant: PropTypes.string,
-  formatter: PropTypes.string,
-  isTableFormatter: PropTypes.bool,
-  hasSuggestions: PropTypes.bool
-};
+export default withConfiguration(PegaDxilMyEmail);

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyEmail/mock.ts

@@ -6,7 +6,14 @@ export const configProps = {
   placeholder: 'Email Placeholder',
   helperText: 'Email Helper Text',
   testId: 'email-12345678',
-  hasSuggestions: false
+  hasSuggestions: false,
+  displayMode: '',
+  hideLabel: false,
+  readOnly: false,
+  required: false,
+  disabled: false,
+  status: '',
+  validatemessage: ''
 };
 
 export const stateProps = {

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyEmail/styles.ts

@@ -1,15 +1,8 @@
-
-// 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;
-//  `;
-// });
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 0px 0;
+  `;
+});

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyForm/DetailsRender.tsx

@@ -0,0 +1,59 @@
+import { Fragment, ReactElement } from 'react';
+import { FieldValueList } from '@pega/cosmos-react-core';
+
+interface DetailsRenderProps {
+  children?: never;
+  child: NonNullable<ReactElement>;
+}
+
+const DetailsRender = (props: DetailsRenderProps) => {
+  const { child } = props;
+
+  const kids = child.props.getPConnect().getChildren();
+
+  const displayCompArr: ReactElement[] = [];
+
+  Object.values(kids).forEach((value: any) => {
+    const { type } = value.getPConnect().getRawMetadata();
+    const { hideLabel, variant, testId, label } = value
+      .getPConnect()
+      .resolveConfigProps(value.getPConnect().getConfigProps());
+
+    let displayComp;
+    const key = JSON.stringify(value.getPConnect());
+
+    if (type === 'reference') {
+      const refElement = value.getPConnect().getComponent();
+
+      displayCompArr.push(refElement);
+    } else {
+      const element = value.getPConnect().getComponent();
+      const displayEl = <Fragment key={key}>{element}</Fragment>;
+
+      const fvlStyle = {
+        myColGap: {
+          columnGap: '0',
+          marginLineStart: 0
+        }
+      };
+
+      // const myEl = <div>boo</div>;
+      displayComp = (
+        <Fragment key={key}>
+          <FieldValueList
+            style={fvlStyle.myColGap}
+            variant={hideLabel ? 'stacked' : variant}
+            data-testid={testId}
+            fields={[{ id: '1', name: hideLabel ? '' : label, value: displayEl }]}
+          />
+        </Fragment>
+      );
+
+      displayCompArr.push(displayComp);
+    }
+  });
+
+  return <>{displayCompArr}</>;
+};
+
+export default DetailsRender;

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyForm/demo.stories.tsx

@@ -2,19 +2,25 @@
 /* eslint-disable react/jsx-no-useless-fragment */
 // @ts-nocheck
 import { useState } from 'react';
-import { withKnobs } from '@storybook/addon-knobs';
+import type { Meta, StoryObj } from '@storybook/react';
 
 import PegaDxilMyForm from './index';
 import { DateInput, Input, FieldValueList, Text } from '@pega/cosmos-react-core';
 import { PhoneInput as CosmosPhone } from '@pega/cosmos-react-core';
 import { pyReviewRaw, regionChildrenResolved } from './mock';
 
-export default {
+const meta: Meta<typeof PegaDxilMyForm> = {
   title: 'PegaDxilMyForm',
-  decorators: [withKnobs],
-  component: PegaDxilMyForm
+  component: PegaDxilMyForm,
+  excludeStories: /.*Data$/,
+  parameters: {
+    type: 'Form'
+  }
 };
 
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyForm>;
+
 const renderField = resolvedProps => {
   const { displayMode, value = '', label = '', key } = resolvedProps;
 
@@ -131,10 +137,8 @@ const renderField = resolvedProps => {
   );
 };
 
-export const BasePegaDxilMyForm = () => {
+export const BasePegaDxilMyForm: Story = args => {
   const props = {
-    NumCols: 1,
-    template: 'DefaultForm',
     getPConnect: () => {
       return {
         getChildren: () => {
@@ -170,7 +174,13 @@ export const BasePegaDxilMyForm = () => {
 
   return (
     <>
-      <PegaDxilMyForm {...props}>{regionAChildren}</PegaDxilMyForm>
+      <PegaDxilMyForm {...props} {...args}>{regionAChildren}</PegaDxilMyForm>
     </>
   );
 };
+
+BasePegaDxilMyForm.args = {
+  showLabel: true,
+  label: 'Form template',
+  NumCols: 1,
+};

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyForm/index.tsx

@@ -1,7 +1,8 @@
-import { Grid, FieldGroup } from '@pega/cosmos-react-core';
-import PropTypes from 'prop-types';
+import { Grid, Flex, FieldGroup, withConfiguration } from '@pega/cosmos-react-core';
+
 
 import type { PConnFieldProps } from './PConnProps';
+import DetailsRender from './DetailsRender';
 
 import StyledPegaDxilMyFormWrapper from './styles';
 
@@ -13,19 +14,41 @@ interface PegaDxilMyFormProps extends PConnFieldProps {
   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
-export default function PegaDxilMyForm(props: PegaDxilMyFormProps) {
+function PegaDxilMyForm(props: PegaDxilMyFormProps) {
 
-  const { children, NumCols, label, showLabel, getPConnect } = props;
+  const { children = [], NumCols = '1', label, showLabel, getPConnect, readOnly, displayMode } = props;
   const propsToUse = { label, showLabel, ...getPConnect().getInheritedProps() };
 
   const nCols = parseInt(NumCols, 10);
 
-  // console.log(`Rendering ${getPConnect()?.getComponentName()} with ${template} with ${children?.length} Region(s)`);
 
+  if (readOnly && readOnly === true && displayMode && displayMode === 'DISPLAY_ONLY') {
+    const numRegions = '1';
+    const gridRepeat = 'repeat('.concat(numRegions).concat(', 1fr)');
+    const gridContainer = { colGap: 0, 'margin-line-start': 0 };
+    // @ts-ignore
+    gridContainer.cols = gridRepeat;
+
+    return (
+      <StyledPegaDxilMyFormWrapper>
+        <FieldGroup name={propsToUse.showLabel ? propsToUse.label : ''}>
+          <Grid container={gridContainer} data-testid={`column-count-${numRegions}`}>
+            {children.map((child: any, i: number) => (
+              <Flex
+                // @ts-ignore
+                container={{ direction: 'column', alignItems: 'normal', colGap: 1, rowGap: 1.5 }}
+                key={`r-${i + 1}`}
+              >
+                <DetailsRender child={child} />
+              </Flex>
+            ))}
+          </Grid>
+        </FieldGroup>
+      </StyledPegaDxilMyFormWrapper>
+    );
+  }
   return (
     <StyledPegaDxilMyFormWrapper>
     <FieldGroup name={propsToUse.showLabel ? propsToUse.label : ''}>
@@ -42,12 +65,4 @@ export default function PegaDxilMyForm(props: PegaDxilMyFormProps) {
 
 }
 
-PegaDxilMyForm.defaultProps = {
-  NumCols: 1,
-  children: []
-};
-
-PegaDxilMyForm.propTypes = {
-  NumCols: PropTypes.number,
-  children: PropTypes.arrayOf(PropTypes.node),
-};
+export default withConfiguration(PegaDxilMyForm);

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyForm/styles.ts

@@ -1,15 +1,8 @@
-
-// 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;
-//  `;
-// });
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 0px 0;
+  `;
+});

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyIconButtonURL/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_MyIconButtonURL/config.json

@@ -0,0 +1,32 @@
+{
+  "name": "Pega_DXIL_MyIconButtonURL",
+  "label": "My Icon Button URL",
+  "description": "My Icon Button URL",
+  "organization": "Pega",
+  "version": "0.0.1",
+  "library": "DXIL",
+  "allowedApplications": [],
+  "componentKey": "Pega_DXIL_MyIconButtonURL",
+  "type": "Field",
+  "subtype": "Text-URL",
+  "icon": "images/pz-url-active.svg",
+  "properties": [
+    {
+      "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/createAll/Launchpad/Pega_DXIL_MyIconButtonURL/demo.stories.tsx

@@ -0,0 +1,103 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import type { Meta, StoryObj } from '@storybook/react';
+
+import PegaDxilMyIconButtonUrl from './index';
+import { stateProps, configProps } from './mock';
+
+const meta: Meta<typeof PegaDxilMyIconButtonUrl> = {
+  title: 'PegaDxilMyIconButtonUrl',
+  component: PegaDxilMyIconButtonUrl,
+  excludeStories: /.*Data$/
+};
+
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyIconButtonUrl>;
+
+if (!window.PCore) {
+  window.PCore = {};
+}
+
+const countrylistData = {
+  data: [
+    {
+      Name: 'United States of America',
+      ShortName: 'USA'
+    },
+    {
+      Name: 'Canada',
+      ShortName: 'CAN'
+    },
+    {
+      Name: 'Mexico',
+      ShortName: 'MEX'
+    }
+  ]
+};
+
+window.PCore.getDataPageUtils = () => {
+  return {
+    getData: () => {
+      return new Promise(resolve => {
+        resolve(countrylistData);
+      });
+    },
+    getDataAsync: () => {
+      return new Promise(resolve => {
+        resolve(countrylistData);
+      });
+    }
+  };
+};
+
+export const BasePegaDxilMyIconButtonUrl: Story = args => {
+
+  const props = {
+    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 (
+    <>
+      <PegaDxilMyIconButtonUrl {...props} {...args} />
+    </>
+  );
+};
+
+BasePegaDxilMyIconButtonUrl.args = {
+
+};