@pega/custom-dx-components 0.23.20 → 0.23.21

package/src/tasks/create/templates/Constellation/Field/Text-Phone/PConnProps.d.ts.mustache

@@ -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/src/tasks/create/templates/Constellation/Field/Text-Phone/demo.stories.jsx.mustache

@@ -1,10 +1,10 @@
-/* eslint-disable import/no-relative-packages */
+
 /* eslint-disable storybook/prefer-pascal-case */
 /* eslint-disable react/jsx-no-useless-fragment */
 import { withKnobs } from '@storybook/addon-knobs';
 
 import {{COMPONENT_CLASS_NAME}} from './index.jsx';
-import { stateProps, configProps } from './mock.stories';
+import { stateProps, configProps } from './mock';
 
 export default {
   title: '{{COMPONENT_CLASS_NAME}}',
@@ -12,7 +12,7 @@ export default {
   component: {{COMPONENT_CLASS_NAME}}
 };
 
-export const base{{COMPONENT_CLASS_NAME}} = () => {
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
 
   const props = {
     value: configProps.value,

package/src/tasks/create/templates/Constellation/Field/Text-Phone/event-utils.ts.mustache

@@ -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/src/tasks/create/templates/Constellation/Field/Text-Phone/{index.jsx.mustache → index.tsx.mustache}

@@ -1,4 +1,3 @@
-/* eslint-disable import/no-relative-packages */
 import { useState, useEffect, useRef } from 'react';
 import {
   PhoneInput as CosmosPhone,
@@ -9,6 +8,7 @@ import {
   EmailDisplay, URLDisplay
 } from '@pega/cosmos-react-core';
 import PropTypes from 'prop-types';
+import type { PConnFieldProps } from './PConnProps';
 
 // includes in bundle
 import handleEvent from "./event-utils";
@@ -16,7 +16,25 @@ import { suggestionsHandler } from './suggestions-handler';
 
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
 
-export const formatExists = (formatterVal) => {
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  displayAsStatus?: boolean;
+  isTableFormatter?: boolean;
+  hasSuggestions?: boolean;
+  variant?: any;
+  formatter: string;
+  datasource: Array<any>;
+  showCountryCode: boolean;
+}
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
+
+export const formatExists = (formatterVal: string) => {
     const formatterValues = [
       "TextInput",
       "WorkStatus",
@@ -34,7 +52,7 @@ export const formatExists = (formatterVal) => {
   };
 
 
-export const textFormatter = (formatter,value) => {
+export const textFormatter = (formatter: string, value: any) => {
   let displayComponent = null;
   switch(formatter){
     case "TextInput" : {
@@ -64,7 +82,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 {{COMPONENT_CLASS_NAME}} = props => {
+export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
   const {
     getPConnect,
     value,
@@ -85,11 +103,14 @@ const {{COMPONENT_CLASS_NAME}} = 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 hasValueChange = useRef(false);
 
- let callingCodesList = [];
+  let callingCodesList: Array<any>  = [];
+  // @ts-ignore
   if (datasource?.source?.length > 0) {
+    // @ts-ignore
     datasource.source.forEach((element) => {
       callingCodesList.push(element.value);
     });
@@ -116,15 +137,15 @@ const {{COMPONENT_CLASS_NAME}} = props => {
     } else if (!hasSuggestions && status !== 'success') {
       setStatus(validatemessage !== '' ? 'error' : undefined);
     }
-  }, [validatemessage, hasSuggestions]);
+  }, [validatemessage, hasSuggestions, status]);
 
   // funtion to exclude country code from phone number
-  function getPhoneNumberAlone(phoneNumber) {
+  function getPhoneNumberAlone(phoneNumber: string) {
     const phoneNumberParts = getPhoneNumberParts(phoneNumber, callingCodesList);
     return phoneNumberParts && phoneNumberParts[1];
   }
 
-  function handleChangeBlur(enteredValue, eventType) {
+  function handleChangeBlur(enteredValue: string, eventType: any) {
     if (!getPhoneNumberAlone(enteredValue)) {
       enteredValue = '';
     }
@@ -177,7 +198,7 @@ const {{COMPONENT_CLASS_NAME}} = props => {
     );
   }
 
-  const onResolveSuggestionHandler = (accepted) => {
+  const onResolveSuggestionHandler = (accepted: boolean) => {
     suggestionsHandler(accepted, pConn, setStatus);
   };
 
@@ -197,21 +218,23 @@ const {{COMPONENT_CLASS_NAME}} = props => {
       readOnly={readOnly}
       required={required}
       data-testid={testId}
-      onChange={(enteredValue) => {
+      onChange={(enteredValue: any) => {
         if (hasSuggestions) {
-          setStatus(undefined);
+          setStatus('');
         }
         setInputValue(enteredValue);
         if (value !== enteredValue) {
+          // @ts-ignore
           handleEvent(actions, 'change', propName, enteredValue);
         }
         hasValueChange.current = true;
       }}
-      onBlur={(enteredValue) => {
+      onBlur={(enteredValue: any) => {
         if (!value || hasValueChange.current) {
+          // @ts-ignore
           handleChangeBlur(enteredValue, 'blur');
           if (hasSuggestions) {
-            pConn.ignoreSuggestion();
+            pConn.ignoreSuggestion('');
           }
           hasValueChange.current = false;
         }
@@ -263,5 +286,3 @@ const {{COMPONENT_CLASS_NAME}} = props => {
   isTableFormatter: PropTypes.bool,
   hasSuggestions: PropTypes.bool
 };
-
-export default {{COMPONENT_CLASS_NAME}};

package/src/tasks/create/templates/Constellation/Field/Text-Phone/styles.ts.mustache

@@ -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/src/tasks/create/templates/Constellation/Field/Text-Phone/suggestions-handler.ts.mustache

@@ -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/src/tasks/create/templates/Constellation/Field/Text-URL/PConnProps.d.ts.mustache

@@ -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/src/tasks/create/templates/Constellation/Field/Text-URL/demo.stories.jsx.mustache

@@ -1,10 +1,10 @@
-/* eslint-disable import/no-relative-packages */
+
 /* eslint-disable storybook/prefer-pascal-case */
 /* eslint-disable react/jsx-no-useless-fragment */
 import { withKnobs } from '@storybook/addon-knobs';
 
 import {{COMPONENT_CLASS_NAME}} from './index.jsx';
-import { stateProps, configProps } from './mock.stories';
+import { stateProps, configProps } from './mock';
 
 export default {
   title: '{{COMPONENT_CLASS_NAME}}',
@@ -12,7 +12,7 @@ export default {
   component: {{COMPONENT_CLASS_NAME}}
 };
 
-export const base{{COMPONENT_CLASS_NAME}} = () => {
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
 
   const props = {
     value: configProps.value,

package/src/tasks/create/templates/Constellation/Field/Text-URL/event-utils.ts.mustache

@@ -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/src/tasks/create/templates/Constellation/Field/Text-URL/{index.jsx.mustache → index.tsx.mustache}

@@ -1,7 +1,7 @@
-/* eslint-disable import/no-relative-packages */
 import { useState, useEffect, useRef} from "react";
 import { Input, FieldValueList, Text } from "@pega/cosmos-react-core";
 import PropTypes from "prop-types";
+import type { PConnFieldProps } from './PConnProps';
 
 // includes in bundle
 import {formatExists,textFormatter, urlFormatter} from "./text-url.jsx";
@@ -10,12 +10,38 @@ import { suggestionsHandler } from './suggestions-handler';
 
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
 
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  displayAsStatus?: boolean;
+  displayAs: string;
+  isTableFormatter?: boolean;
+  hasSuggestions?: boolean;
+  variant?: any;
+  formatter: string;
+  datasource: Array<any>;
+  widthSel: string;
+  customWidth: number;
+  altText: string;
+  altTextOfImage: string;
+  propaltTextOfImage: string;
+  urlLabel: string;
+  propUrlLabel: string;
+  urlLabelSelection: string;
+  tableDisplayAs: 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 {{COMPONENT_CLASS_NAME}} = props => {
+export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
   const {
     getPConnect,
     value,
@@ -44,7 +70,8 @@ const {{COMPONENT_CLASS_NAME}} = 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 hasValueChange = useRef(false);
 
 
@@ -67,7 +94,7 @@ const {{COMPONENT_CLASS_NAME}} = props => {
     } else if (!hasSuggestions && status !== 'success') {
       setStatus(validatemessage !== '' ? 'error' : undefined);
     }
-  }, [validatemessage, hasSuggestions]);
+  }, [validatemessage, hasSuggestions, status]);
 
   let displayComp = null;
   if (displayMode) {
@@ -127,7 +154,7 @@ const {{COMPONENT_CLASS_NAME}} = props => {
     );
   }
 
-  const onResolveSuggestionHandler = (accepted) => {
+  const onResolveSuggestionHandler = (accepted: boolean) => {
     suggestionsHandler(accepted, pConn, setStatus);
   };
 
@@ -146,25 +173,28 @@ const {{COMPONENT_CLASS_NAME}} = props => {
       readOnly={readOnly}
       required={required}
       data-testid={testId}
-      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;
         }
       }}
+      // @ts-ignore
       onFocus={actions.onFocus}
       onResolveSuggestion={onResolveSuggestionHandler}
     />
@@ -229,5 +259,3 @@ const {{COMPONENT_CLASS_NAME}} = props => {
   tableDisplayAs: PropTypes.string,
   hasSuggestions: PropTypes.bool
 };
-
-export default {{COMPONENT_CLASS_NAME}};

package/src/tasks/create/templates/Constellation/Field/Text-URL/styles.ts.mustache

@@ -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/src/tasks/create/templates/Constellation/Field/Text-URL/suggestions-handler.ts.mustache

@@ -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/src/tasks/create/templates/Constellation/Field/Text-URL/text-url.jsx.mustache

@@ -1,4 +1,5 @@
-/* eslint-disable import/no-relative-packages */
+
+/* eslint-disable react/jsx-fragments */
 import { useState, useRef, React} from "react";
 import { EmailDisplay, PhoneDisplay, URLDisplay, Image, Button, Lightbox } from '@pega/cosmos-react-core';
 

package/src/tasks/create/templates/Constellation/Field/TimeOfDay/PConnProps.d.ts.mustache

@@ -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/src/tasks/create/templates/Constellation/Field/{TimeofDay → TimeOfDay}/demo.stories.jsx.mustache

@@ -1,8 +1,8 @@
-/* eslint-disable import/no-relative-packages */
+
 /* eslint-disable storybook/prefer-pascal-case */
 /* eslint-disable react/jsx-no-useless-fragment */
 import { withKnobs } from '@storybook/addon-knobs';
-import { configProps, stateProps } from './mock.stories';
+import { configProps, stateProps } from './mock';
 import {{COMPONENT_CLASS_NAME}} from './index.jsx';
 
 export default {
@@ -11,7 +11,7 @@ export default {
   component: {{COMPONENT_CLASS_NAME}}
 };
 
-export const base{{COMPONENT_CLASS_NAME}} = () => {
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
   const props = {
     getPConnect: () => {
       return {