@pega/custom-dx-components 0.23.20 → 0.23.21

package/src/tasks/create/templates/Constellation/Field/{TimeofDay/index.jsx.mustache → TimeOfDay/index.tsx.mustache}

@@ -1,24 +1,51 @@
-/* eslint-disable import/no-relative-packages */
 import { useEffect, useState } from 'react';
 import { TimeInput, FieldValueList, DateTimeDisplay, Text } from '@pega/cosmos-react-core';
 import PropTypes from 'prop-types';
+import type { PConnFieldProps } from './PConnProps';
+
 
 // includes in bundle
 import {
   parseClockFormat,
+
   timeCorrectedToSeconds,
   datetimeFireChangeBlurEvents
 } from "./time-of-day";
 import { suggestionsHandler } from './suggestions-handler';
 
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
+import type { DateTimeFormat, DateTimeVariant } from '@pega/cosmos-react-core/lib/components/DateTime/DateTime.types';
+import type { ClockFormat } from '@pega/cosmos-react-core/lib/components/DateTime/Input/utils';
+
+// 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;
+  withSeconds: boolean;
+  pickerInterval: string;
+  clockFormat: number | string;
+}
+
+// interface for StateProps object
+interface StateProps {
+  value: string;
+  hasSuggestions: boolean;
+}
+
+interface ConfigProps {
+  formatter?: 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
-const {{COMPONENT_CLASS_NAME}} = props => {
+export default function {{COMPONENT_CLASS_NAME}} (props: {{COMPONENT_CLASS_NAME}}Props)  {
   const {
     getPConnect,
     value,
@@ -37,7 +64,8 @@ const {{COMPONENT_CLASS_NAME}} = props => {
   let { formatter } = props;
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
-  const propName = pConn.getStateProps().value;
+  const stateProps = pConn.getStateProps() as StateProps;
+  const propName: string = stateProps.value;
 
   // BUG-547602: Temporary type coercion for 8.5 until DXAPIs are enhanced to pass original pxViewMetadata JSON, respecting boolean primitives
   let { readOnly, required, disabled } = props;
@@ -59,30 +87,32 @@ const {{COMPONENT_CLASS_NAME}} = props => {
     } else if (!hasSuggestions && status !== 'success') {
       setStatus(validatemessage !== '' ? 'error' : undefined);
     }
-  }, [validatemessage, hasSuggestions]);
+  }, [validatemessage, hasSuggestions, status]);
 
-  const onResolveSuggestionHandler = (accepted) => {
+  const onResolveSuggestionHandler = (accepted: boolean) => {
     suggestionsHandler(accepted, pConn, setStatus);
   };
 
-  function handleBlur(onBlurValue) {
+  function handleBlur(onBlurValue: any) {
     const { valueAsISOString: time, state: errorState } = onBlurValue;
     const trimmedTime = time ? timeCorrectedToSeconds(time, withSeconds) : time;
     datetimeFireChangeBlurEvents(errorState, value, trimmedTime, actions, propName, pConn);
     const isValueChanged = !(value === undefined && trimmedTime === '') && value !== trimmedTime;
     if (hasSuggestions && isValueChanged) {
-      pConn.ignoreSuggestion();
+      pConn.ignoreSuggestion('');
     }
   }
 
-  function handleChange(onChangeValue) {
+  function handleChange(onChangeValue: any) {
     const { valueAsISOString: time } = onChangeValue;
     const trimmedTime = time ? timeCorrectedToSeconds(time, withSeconds) : time;
     if (hasSuggestions && value !== trimmedTime) {
-      setStatus(undefined);
+      setStatus('');
     }
     pConn.clearErrorMessages({
-      property: propName
+      category: "",
+      property: propName,
+      context: ""
     });
   }
 
@@ -90,7 +120,8 @@ const {{COMPONENT_CLASS_NAME}} = props => {
     let variantValue = 'time';
     let formatValue = withSeconds ? 'long' : 'short';
     if (pConn && pConn.getConfigProps()) {
-      const runtimeformatter = pConn.getConfigProps()?.formatter;
+      const configProps = pConn.getConfigProps() as ConfigProps;
+      const runtimeformatter = configProps?.formatter;
       if (formatter !== runtimeformatter) {
         formatter = runtimeformatter;
       }
@@ -101,10 +132,10 @@ const {{COMPONENT_CLASS_NAME}} = props => {
     }
     const displayComp = (
       <DateTimeDisplay
-        variant={variantValue}
-        format={formatValue}
+        variant={variantValue as DateTimeVariant}
+        format={formatValue as DateTimeFormat}
         value={value}
-        clockFormat={clockFormat || undefined}
+        clockFormat={clockFormat as ClockFormat || undefined}
       />
     );
     switch (displayMode) {
@@ -163,6 +194,7 @@ const {{COMPONENT_CLASS_NAME}} = props => {
       pickerInterval={pickerInterval}
       clockFormat={clockFormat || undefined}
       data-testid={testId}
+       // @ts-ignore
       onFocus={actions.onFocus}
       onChange={handleChange}
       onBlur={handleBlur}
@@ -211,5 +243,3 @@ const {{COMPONENT_CLASS_NAME}} = props => {
   formatter : PropTypes.string,
   hasSuggestions: PropTypes.bool
 };
-
-export default {{COMPONENT_CLASS_NAME}};

package/src/tasks/create/templates/Constellation/Field/TimeOfDay/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/TimeOfDay/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/{TimeofDay → TimeOfDay}/time-of-day.js.mustache

@@ -1,5 +1,3 @@
-/* eslint-disable import/no-relative-packages */
-/* eslint-disable no-undef */
 import dayjs from "dayjs";
 import relativeTime from 'dayjs/plugin/relativeTime.js';
 import localizedFormat from 'dayjs/plugin/localizedFormat.js';

package/src/tasks/create/templates/Constellation/Template/DETAILS/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/Template/{DETAILS-region/StatusWork.jsx.mustache → DETAILS/StatusWork.tsx.mustache}

@@ -1,8 +1,7 @@
-/* eslint-disable import/no-relative-packages */
 import { Status } from "@pega/cosmos-react-core";
 
-export default function StatusWorkRenderer({ value }) {
-  let variant = "info";
+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"];

package/src/tasks/create/templates/Constellation/Template/DETAILS/demo.stories.jsx.mustache

@@ -1,9 +1,9 @@
-/* eslint-disable import/no-relative-packages */
+
 /* eslint-disable storybook/prefer-pascal-case */
 /* eslint-disable react/jsx-no-useless-fragment */
 import { Text, FieldValueList, Button, DateTimeDisplay, useTheme } from '@pega/cosmos-react-core';
 import PegaDxilMyDetails from './index';
-import { pyReviewRaw, pyReviewResolved, regionChildrenResolved } from './mock.stories';
+import { pyReviewRaw, pyReviewResolved, regionChildrenResolved } from './mock';
 import StatusWorkRenderer from './StatusWork.jsx';
 
 export default {
@@ -77,7 +77,7 @@ const renderField = resolvedProps => {
   return <FieldValueList variant={variant} fields={[{ name: label, value: val }]} key={key} />;
 };
 
-export const basePegaDxilMyDetails = () => {
+export const BasePegaDxilMyDetails = () => {
   const props = {
     template: 'MyCo_MyComponents_NewDetailsTemplate',
     showHighlightedData: true,
@@ -98,7 +98,6 @@ export const basePegaDxilMyDetails = () => {
           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);

package/src/tasks/create/templates/Constellation/Template/{DETAILS-region/index.jsx.mustache → DETAILS/index.tsx.mustache}

@@ -1,18 +1,28 @@
-/* eslint-disable import/no-relative-packages */
 import { Fragment } from 'react';
 import { Grid, Flex, FieldGroup } from '@pega/cosmos-react-core';
 import PropTypes from 'prop-types';
 
+import type { PConnFieldProps } from './PConnProps';
+
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
 
 // includes in bundle
 import { getAllFields } from './utils';
 
+
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}Props 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
-export default function {{COMPONENT_CLASS_NAME}}(props) {
+export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
 
   const { getPConnect, children, label, showLabel, showHighlightedData  } = props;
   const propsToUse = { label, showLabel, ...getPConnect().getInheritedProps() };
@@ -20,18 +30,25 @@ export default function {{COMPONENT_CLASS_NAME}}(props) {
   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';
 
@@ -40,7 +57,7 @@ export default function {{COMPONENT_CLASS_NAME}}(props) {
         field.type = 'TextInput';
         field.config.displayAsStatus = true;
       }
-
+      // @ts-ignore
       return getPConnect().createComponent(field);
     });
   }
@@ -53,13 +70,13 @@ export default function {{COMPONENT_CLASS_NAME}}(props) {
       {showHighlightedData && highlightedDataArr.length > 0 && (
         <Grid container={gridHighlightContainer}
           data-testid={`highlighted-column-count-${numRegions}`}>
-          {highlightedDataArr.map((child, i) => (
+          {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, i) => (
+       {children.map((child: any, i: number) => (
         <Flex container={{ direction: 'column'}} key={`r-${i + 1}`}>
         {child}
         </Flex>

package/src/tasks/create/templates/Constellation/Template/DETAILS/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/Template/DETAILS/utils.js.mustache

@@ -1,4 +1,3 @@
-/* eslint-disable no-undef */
 
 /**
  * Given the PConnect object of a Template component, retrieve the children
@@ -137,9 +136,9 @@ 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 */
+
     console.error('@PARAGRAPH annotation was not processed. Hiding custom instructions.');
-    /* eslint-enable no-console */    return undefined;
+    return undefined;
   }
 
   // Custom instructions from the view

package/src/tasks/create/templates/Constellation/Template/DETAILS-region/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-Input/StatusWork.jsx → Template/DETAILS-region/StatusWork.tsx.mustache}

@@ -1,8 +1,7 @@
-/* eslint-disable import/no-relative-packages */
 import { Status } from "@pega/cosmos-react-core";
 
-export default function StatusWorkRenderer({ value }) {
-  let variant = "info";
+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"];

package/src/tasks/create/templates/Constellation/Template/DETAILS-region/demo.stories.jsx.mustache

@@ -1,8 +1,8 @@
-/* eslint-disable import/no-relative-packages */
+
 /* eslint-disable storybook/prefer-pascal-case */
 import { Text, FieldValueList, Button, DateTimeDisplay, useTheme } from '@pega/cosmos-react-core';
 import {{COMPONENT_CLASS_NAME}} from './index';
-import { pyReviewRaw, pyReviewResolved, regionChildrenResolved } from './mock.stories';
+import { pyReviewRaw, pyReviewResolved, regionChildrenResolved } from './mock';
 import StatusWorkRenderer from './StatusWork.jsx';
 
 export default {
@@ -76,7 +76,7 @@ const renderField = resolvedProps => {
   return <FieldValueList variant={variant} fields={[{ name: label, value: val }]} key={key} />;
 };
 
-export const base{{COMPONENT_CLASS_NAME}} = () => {
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
   const props = {
     template: 'MyCo_MyComponents_NewDetailsTemplate',
     showHighlightedData: true,
@@ -97,7 +97,6 @@ export const base{{COMPONENT_CLASS_NAME}} = () => {
           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);

package/src/tasks/create/templates/Constellation/Template/{DETAILS/index.jsx.mustache → DETAILS-region/index.tsx.mustache}

@@ -1,18 +1,27 @@
-/* eslint-disable import/no-relative-packages */
 import { Fragment } from 'react';
 import { Grid, Flex, FieldGroup } from '@pega/cosmos-react-core';
 import PropTypes from 'prop-types';
 
+import type { PConnFieldProps } from './PConnProps';
+
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
 
 // includes in bundle
 import { getAllFields } from './utils';
 
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}Props 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
-export default function {{COMPONENT_CLASS_NAME}}(props) {
+export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
 
   const { getPConnect, children, label, showLabel, showHighlightedData  } = props;
   const propsToUse = { label, showLabel, ...getPConnect().getInheritedProps() };
@@ -20,18 +29,25 @@ export default function {{COMPONENT_CLASS_NAME}}(props) {
   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';
 
@@ -40,7 +56,7 @@ export default function {{COMPONENT_CLASS_NAME}}(props) {
         field.type = 'TextInput';
         field.config.displayAsStatus = true;
       }
-
+      // @ts-ignore
       return getPConnect().createComponent(field);
     });
   }
@@ -53,13 +69,13 @@ export default function {{COMPONENT_CLASS_NAME}}(props) {
       {showHighlightedData && highlightedDataArr.length > 0 && (
         <Grid container={gridHighlightContainer}
           data-testid={`highlighted-column-count-${numRegions}`}>
-          {highlightedDataArr.map((child, i) => (
+          {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, i) => (
+       {children.map((child: any, i: number) => (
         <Flex container={{ direction: 'column'}} key={`r-${i + 1}`}>
         {child}
         </Flex>

package/src/tasks/create/templates/Constellation/Template/DETAILS-region/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/Template/DETAILS-region/utils.js.mustache

@@ -1,5 +1,3 @@
-/* eslint-disable no-undef */
-
 
 
 /**
@@ -139,9 +137,7 @@ 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 */
     console.error('@PARAGRAPH annotation was not processed. Hiding custom instructions.');
-     /* eslint-enable no-console */
     return undefined;
   }
 

package/src/tasks/create/templates/Constellation/Template/FORM/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
+}