@pega/custom-dx-components 0.23.21 → 0.23.23

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPageWidget/{index.jsx → index.tsx}

@@ -1,18 +1,31 @@
 import PropTypes from 'prop-types';
 import { AppAnnouncement as PegaAppAnnouncement } from '@pega/cosmos-react-work';
+import type { PConnFieldProps } from './PConnProps';
 
 import StyledPegaDxilMyPageWidgetWrapper from './styles';
 
+// interface for props
+interface PegaDxilMyPageWidgetProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+    datasource: Array<any>;
+    header: string;
+    description: string;
+    whatsnewlink: string;
+    image: string;
+}
+
 
 // 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 PegaDxilMyPageWidget(props) {
+export default function PegaDxilMyPageWidget(props: PegaDxilMyPageWidgetProps) {
 
   const { header, description, datasource, whatsnewlink, image } = props;
   let details = [];
+  // @ts-ignore
   if (datasource && datasource.source) {
+    // @ts-ignore
     details = datasource.source.map((item) => {
       return item.name;
     });

package/{src/tasks/create/templates/Constellation/Widget/PAGE/mock.js.mustache → tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPageWidget/mock.ts}

@@ -1,4 +1,5 @@
-/* eslint-disable storybook/story-exports */
+
+// @ts-nocheck
 const configProps = {
   label: 'App announcement',
   header: 'Announcements',

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyParagraph/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_MyParagraph/demo.stories.tsx

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

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyParagraph/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_MyParagraph/{index.jsx → index.tsx}

@@ -1,6 +1,7 @@
 import { useState, useEffect, useRef } from 'react';
 import { TextArea as CosmosTextArea, FieldValueList, ParagraphDisplay, Text, EmailDisplay, PhoneDisplay, URLDisplay } from '@pega/cosmos-react-core';
 import PropTypes from 'prop-types';
+import type { PConnFieldProps } from './PConnProps';
 
 // includes in bundle
 import { suggestionsHandler } from './suggestions-handler';
@@ -8,7 +9,23 @@ import handleEvent from "./event-utils";
 
 import StyledPegaDxilMyParagraphWrapper from './styles';
 
-export const formatExists = (formatterVal) => {
+// interface for props
+interface PegaDxilMyParagraphProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  displayAsStatus?: boolean;
+  isTableFormatter?: boolean;
+  hasSuggestions?: boolean;
+  variant?: any;
+  formatter: string;
+}
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
+
+export const formatExists = (formatterVal: string) => {
     const formatterValues = [
       "TextInput",
       "WorkStatus",
@@ -26,7 +43,7 @@ export const formatExists = (formatterVal) => {
   };
 
 
-export const textFormatter = (formatter,value) => {
+export const textFormatter = (formatter: string, value: any) => {
   let displayComponent = null;
   switch(formatter){
     case "TextInput" : {
@@ -56,7 +73,7 @@ export const textFormatter = (formatter,value) => {
 
 // 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
-const PegaDxilMyParagraph = props => {
+export default function PegaDxilMyParagraph(props: PegaDxilMyParagraphProps) {
   const {
     getPConnect,
     value,
@@ -76,7 +93,8 @@ const PegaDxilMyParagraph = props => {
   const { formatter } = props;
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
-  const propName = pConn.getStateProps().value;
+  const stateProps = pConn.getStateProps() as StateProps;
+  let propName: string = stateProps.value;
   const maxLength = fieldMetadata?.maxLength;
   const hasValueChange = useRef(false);
 
@@ -141,7 +159,7 @@ const PegaDxilMyParagraph = props => {
     );
   }
 
-  const onResolveSuggestionHandler = (accepted) => {
+  const onResolveSuggestionHandler = (accepted: boolean) => {
     suggestionsHandler(accepted, pConn, setStatus);
   };
 
@@ -162,21 +180,23 @@ const PegaDxilMyParagraph = props => {
       maxLength={maxLength}
       displayCharCount={!!maxLength}
       hardStop
-      onChange={(event) => {
+      onChange={(event: any) => {
         if (hasSuggestions) {
-          setStatus(undefined);
+          setStatus('');
         }
         setInputValue(event.target.value);
         if (value !== event.target.value) {
+          // @ts-ignore
           handleEvent(actions, 'change', propName, event.target.value);
           hasValueChange.current = true;
         }
       }}
-      onBlur={(event) => {
+      onBlur={(event: any) => {
         if (!value || hasValueChange.current) {
+          // @ts-ignore
           handleEvent(actions, 'blur', propName, event.target.value);
           if (hasSuggestions) {
-            pConn.ignoreSuggestion();
+            pConn.ignoreSuggestion('');
           }
           hasValueChange.current = false;
         }
@@ -226,5 +246,3 @@ PegaDxilMyParagraph.propTypes = {
   isTableFormatter: PropTypes.bool,
   hasSuggestions: PropTypes.bool
 };
-
-export default PegaDxilMyParagraph;

package/tests/assets/components/createAll/{Constellation/Pega_DXIL_MyParagraph/mock.js → Launchpad/Pega_DXIL_MyParagraph/mock.ts}

@@ -1,5 +1,5 @@
-/* eslint-disable storybook/default-exports */
-/* eslint-disable storybook/prefer-pascal-case */
+
+// @ts-nocheck
 export const configProps = {
   value: '',
   label: 'Paragraph Sample',

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyParagraph/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/Launchpad/Pega_DXIL_MyPercentage/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_MyPercentage/demo.stories.tsx

@@ -0,0 +1,52 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+// @ts-nocheck
+import { withKnobs } from '@storybook/addon-knobs';
+
+import { configProps, stateProps, fieldMetadata } from './mock';
+
+import PegaDxilMyPercentage from './index';
+
+export default {
+  title: 'PegaDxilMyPercentage',
+  decorators: [withKnobs],
+  component: PegaDxilMyPercentage
+};
+
+export const BasePegaDxilMyPercentage = () => {
+
+  const props = {
+    value: configProps.value,
+    placeholder: configProps.placeholder,
+    label: configProps.label,
+    helperText: configProps.helperText,
+    showGroupSeparators: configProps.showGroupSeparators,
+    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 */}
+      };
+    }
+  };
+
+  return (
+    <>
+      <PegaDxilMyPercentage {...props} />
+    </>
+  );
+};

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPercentage/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/{Constellation/Pega_DXIL_MyPercentage/index.jsx → Launchpad/Pega_DXIL_MyPercentage/index.tsx}

@@ -8,18 +8,46 @@ import {
 } from '@pega/cosmos-react-core';
 import PropTypes from 'prop-types';
 
+import type { PConnFieldProps } from './PConnProps';
+
 // includes in bundle
 import handleEvent from './event-utils';
 import { suggestionsHandler } from './suggestions-handler';
 
 import StyledPegaDxilMyPercentageWrapper from './styles';
 
+// interface for props
+interface PegaDxilMyPercentageProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  displayAsStatus?: boolean;
+  isTableFormatter?: boolean;
+  hasSuggestions?: boolean;
+  variant?: any;
+  formatter: string;
+  decimalPrecision: string;
+  allowDecimals: boolean;
+  currencyISOCode: string;
+  alwaysShowISOCode: boolean;
+  isoCodeSelection: string;
+  additionalProps: any;
+  showGroupSeparators: boolean;
+  currencyDisplay: 'symbol' | 'code' | 'name' | undefined;
+  negative: 'minus-sign' | 'parentheses' | undefined;
+  notation: 'standard' | 'compact' | undefined;
+  currencyDecimalPrecision: string;
+}
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
 
 // 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
-const PegaDxilMyPercentage = props => {
+export default function PegaDxilMyPercentage(props: PegaDxilMyPercentageProps) {
   const {
     getPConnect,
     value,
@@ -40,7 +68,8 @@ const PegaDxilMyPercentage = props => {
   let { showGroupSeparators } = props;
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
-  const propName = pConn.getStateProps().value;
+  const stateProps = pConn.getStateProps() as StateProps;
+  const propName: string = stateProps.value;
   const [percentageValue, setPercentageValue] = useState(value?.toString());
 
   const hasValueChange = useRef(false);
@@ -65,6 +94,7 @@ const PegaDxilMyPercentage = props => {
 
   let numberOfDecimals = parseInt(decimalPrecision, 10);
   if (Number.isNaN(numberOfDecimals)) {
+    // @ts-ignore
     numberOfDecimals = decimalPrecision === '' ? undefined : 2;
   }
 
@@ -182,7 +212,7 @@ const PegaDxilMyPercentage = props => {
     );
   }
 
-  const onResolveSuggestionHandler = (accepted) => {
+  const onResolveSuggestionHandler = (accepted: boolean) => {
     suggestionsHandler(accepted, pConn, setStatus);
   };
 
@@ -209,6 +239,7 @@ const PegaDxilMyPercentage = props => {
         }
         setPercentageValue(enteredValue);
         if (value !== enteredValue) {
+          // @ts-ignore
           handleEvent(actions, 'change', propName, enteredValue);
           hasValueChange.current = true;
         }
@@ -216,9 +247,10 @@ const PegaDxilMyPercentage = props => {
       onBlur={() => {
         const parsedValue = percentageValue !== '' ? Number(percentageValue) : '';
         if (!value || hasValueChange.current) {
+          // @ts-ignore
           handleEvent(actions, 'blur', propName, parsedValue);
           if (hasSuggestions) {
-            pConn.ignoreSuggestion();
+            pConn.ignoreSuggestion("");
           }
           hasValueChange.current = false;
         }
@@ -272,5 +304,3 @@ PegaDxilMyPercentage.propTypes = {
   isTableFormatter: PropTypes.bool,
   hasSuggestions: PropTypes.bool
 };
-
-export default PegaDxilMyPercentage;

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPercentage/{mock.js → mock.ts}

@@ -1,5 +1,5 @@
-/* eslint-disable storybook/default-exports */
-/* eslint-disable storybook/prefer-pascal-case */
+
+// @ts-nocheck
 export const configProps = {
   value: '',
   label: 'Percentage Sample',

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPercentage/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/Launchpad/Pega_DXIL_MyPhone/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_MyPhone/demo.stories.tsx

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

package/tests/assets/components/createAll/Launchpad/Pega_DXIL_MyPhone/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;