@pega/custom-dx-components 0.23.20 → 0.23.21

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

@@ -1,4 +1,4 @@
-/* eslint-disable import/no-relative-packages */
+
 /* eslint-disable react-hooks/rules-of-hooks */
 /* eslint-disable storybook/prefer-pascal-case */
 /* eslint-disable react/jsx-no-useless-fragment */
@@ -8,7 +8,7 @@ import { withKnobs } from '@storybook/addon-knobs';
 import {{COMPONENT_CLASS_NAME}} from './index.jsx';
 import { DateInput, Input, FieldValueList, Text } from '@pega/cosmos-react-core';
 import { PhoneInput as CosmosPhone } from '@pega/cosmos-react-core';
-import { pyReviewRaw, regionChildrenResolved } from './mock.stories';
+import { pyReviewRaw, regionChildrenResolved } from './mock';
 
 export default {
   title: '{{COMPONENT_CLASS_NAME}}',
@@ -43,7 +43,7 @@ const renderField = resolvedProps => {
 {{! pick new delimiters for mustache }}
 {{=<% %>=}}
 
-  if (label === 'Service Date')
+  if (label === 'Service Date') {
     val = (
       <DateInput
         value={inputValue}
@@ -54,10 +54,11 @@ const renderField = resolvedProps => {
           const trimmedDate = date ? date.substring(0, date.indexOf('T')) : date;
           setInputValue(trimmedDate);
         }}
-      ></DateInput>
+      />
     );
+  }
 
-  if (label === 'Email')
+  if (label === 'Email') {
     val = (
       <Input
         type='email'
@@ -66,11 +67,11 @@ const renderField = resolvedProps => {
         key={key}
         onChange={e => {
           setInputValue(e.target.value);
-        }}
-      ></Input>
+        }} />
     );
+  }
 
-  if (label === 'First Name' || label === 'Last Name' || label === 'Middle Name')
+  if (label === 'First Name' || label === 'Last Name' || label === 'Middle Name') {
     val = (
       <Input
         value={inputValue}
@@ -79,10 +80,11 @@ const renderField = resolvedProps => {
         onChange={e => {
           setInputValue(e.target.value);
         }}
-      ></Input>
+      />
     );
+  }
 
-  if (label === 'Phone Number')
+  if (label === 'Phone Number') {
     val = (
       <CosmosPhone
         value={phoneValue}
@@ -91,8 +93,9 @@ const renderField = resolvedProps => {
         onChange={phoneVal => {
           setPhoneValue(phoneVal);
         }}
-      ></CosmosPhone>
+      />
     );
+  }
 
 <%={{ }}=%>     {{! revert delimiters for mustache }}
 
@@ -130,7 +133,7 @@ const renderField = resolvedProps => {
   );
 };
 
-export const base{{COMPONENT_CLASS_NAME}} = () => {
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
   const props = {
     NumCols: 1,
     template: 'DefaultForm',
@@ -143,7 +146,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 .FirstName':
               return renderField(regionChildrenResolved[0]);

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

@@ -1,16 +1,23 @@
-/* eslint-disable import/no-relative-packages */
 import { Grid, FieldGroup } from '@pega/cosmos-react-core';
 import PropTypes from 'prop-types';
 
+import type { PConnFieldProps } from './PConnProps';
+
 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
+  showLabel: boolean;
+  NumCols: string;
+  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 { children, NumCols, label, showLabel, getPConnect } = props;
   const propsToUse = { label, showLabel, ...getPConnect().getInheritedProps() };
@@ -19,8 +26,6 @@ export default function {{COMPONENT_CLASS_NAME}}(props) {
 
   // console.log(`Rendering ${getPConnect()?.getComponentName()} with ${template} with ${children?.length} Region(s)`);
 
-
-
   return (
     <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
 {{! pick new delimiters for mustache }}
@@ -28,8 +33,7 @@ export default function {{COMPONENT_CLASS_NAME}}(props) {
     <FieldGroup name={propsToUse.showLabel ? propsToUse.label : ''}>
       <Grid container={{
             cols: `repeat(${nCols}, minmax(0, 1fr))`,
-            gap: 2,
-            wrap: `wrap`
+            gap: 2
           }}>
             {children}
       </Grid>

package/src/tasks/create/templates/Constellation/Template/FORM/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/FORM-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/Template/FORM-region/demo.stories.jsx.mustache

@@ -1,4 +1,4 @@
-/* eslint-disable import/no-relative-packages */
+
 /* eslint-disable react-hooks/rules-of-hooks */
 /* eslint-disable storybook/prefer-pascal-case */
 import { useState } from 'react';
@@ -7,7 +7,7 @@ import { withKnobs } from '@storybook/addon-knobs';
 import {{COMPONENT_CLASS_NAME}} from './index.jsx';
 import { DateInput, Input, FieldValueList, Text } from '@pega/cosmos-react-core';
 import { PhoneInput as CosmosPhone } from '@pega/cosmos-react-core';
-import { pyReviewRaw, regionChildrenResolved } from './mock.stories';
+import { pyReviewRaw, regionChildrenResolved } from './mock';
 
 export default {
   title: '{{COMPONENT_CLASS_NAME}}',
@@ -54,7 +54,7 @@ const renderField = resolvedProps => {
           const trimmedDate = date ? date.substring(0, date.indexOf('T')) : date;
           setInputValue(trimmedDate);
         }}
-      ></DateInput>
+      />
     );
 
   if (label === 'Email')
@@ -67,7 +67,7 @@ const renderField = resolvedProps => {
         onChange={e => {
           setInputValue(e.target.value);
         }}
-      ></Input>
+      />
     );
 
   if (label === 'First Name' || label === 'Last Name' || label === 'Middle Name')
@@ -79,7 +79,7 @@ const renderField = resolvedProps => {
         onChange={e => {
           setInputValue(e.target.value);
         }}
-      ></Input>
+      />
     );
 
   if (label === 'Phone Number')
@@ -92,7 +92,7 @@ const renderField = resolvedProps => {
         onChange={phoneVal => {
           setPhoneValue(phoneVal);
         }}
-      ></CosmosPhone>
+      />
     );
 
 <%={{ }}=%>     {{! revert delimiters for mustache }}
@@ -135,7 +135,7 @@ const renderField = resolvedProps => {
   );
 };
 
-export const base{{COMPONENT_CLASS_NAME}} = () => {
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
   const props = {
     template: 'DefaultForm',
     getPConnect: () => {
@@ -147,7 +147,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 .FirstName':
               return renderField(regionChildrenResolved[0]);

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

@@ -1,15 +1,22 @@
-/* eslint-disable import/no-relative-packages */
 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';
 
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  showLabel: 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 { children, label, showLabel, getPConnect } = props;
@@ -18,10 +25,13 @@ export default function {{COMPONENT_CLASS_NAME}}(props) {
   const numRegions = children?.length;
   const gridRepeat = "repeat(".concat(numRegions).concat(", 1fr)");
   const gridContainer = {"colGap" : 1};
+  // @ts-ignore
   gridContainer.cols = gridRepeat;
+  // @ts-ignore
   gridContainer.alignItems = 'start';
 
   const flexContainer = {direction: 'column'};
+  // @ts-ignore
   flexContainer.gap = 2;
 
   return (
@@ -30,7 +40,8 @@ export default function {{COMPONENT_CLASS_NAME}}(props) {
     {{=<% %>=}}
       <FieldGroup name={propsToUse.showLabel ? propsToUse.label : ''}>
         <Grid container={gridContainer}>
-        {children.map((child, i) => (
+        {children.map((child: any, i: number) => (
+          // @ts-ignore
           <Flex container={flexContainer} key={`r-${i + 1}`}>
           {child}
           </Flex>

package/src/tasks/create/templates/Constellation/Template/FORM-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/PAGE/{GetNextWork.jsx.mustache → GetNextWork.tsx.mustache}

@@ -1,8 +1,17 @@
-/* eslint-disable import/no-relative-packages */
-/* eslint-disable no-undef */
+
 import { Button, useToaster } from '@pega/cosmos-react-core';
 
-export default function GetNextWork(props) {
+import type { PConnFieldProps } from './PConnProps';
+
+
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}WorkProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  variant: any;
+
+}
+
+export default function GetNextWork(props: {{COMPONENT_CLASS_NAME}}WorkProps) {
   const { getPConnect, variant } = props;
 
   const toasterCtx = useToaster();
@@ -17,9 +26,7 @@ export default function GetNextWork(props) {
       .getActionsApi()
       .getNextWork()
       .catch((err) => {
-        /* eslint-disable no-console */
         console.log(err);
-        /* eslint-enable no-console */
         if (err[0].status === 404) {
           toasterCtx.push({
             content: localizedVal('No task currently available')
@@ -30,7 +37,7 @@ export default function GetNextWork(props) {
 
   return (
     <Button variant={variant} onClick={getNextWork}>
-      {getPConnect().getLocalizedValue('Get next work')}
+      {getPConnect().getLocalizedValue('Get next work', '', '')}
     </Button>
   );
 }

package/src/tasks/create/templates/Constellation/Template/PAGE/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/PAGE/demo.stories.jsx.mustache

@@ -1,4 +1,4 @@
-/* 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';
@@ -6,7 +6,7 @@ import { withKnobs } from '@storybook/addon-knobs';
 import { AppAnnouncement as PegaAppAnnouncement } from '@pega/cosmos-react-work';
 
 import {{COMPONENT_CLASS_NAME}} from './index.jsx';
-import { pyHome1Resolved, pyHome1Raw } from './mock.stories.js';
+import { pyHome1Resolved, pyHome1Raw } from './mock.js';
 
 export default {
   title: '{{COMPONENT_CLASS_NAME}}',
@@ -14,7 +14,7 @@ export default {
   component: {{COMPONENT_CLASS_NAME}}
 };
 
-export const base{{COMPONENT_CLASS_NAME}} = () => {
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
   if (!window.PCore) {
     window.PCore = {};
   }

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

@@ -1,16 +1,18 @@
-/* eslint-disable import/no-relative-packages */
 import { useMemo, Children } from 'react';
 import PropTypes from 'prop-types';
 import { OneColumnPage as OneColumn } from '@pega/cosmos-react-core';
 import { ConfigurableLayout } from '@pega/cosmos-react-work'
 // import { registerIcon } from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
+
+
 
 // temp
 // import * as headlineIcon from '@pega/cosmos-react-core/lib/components/Icon/icons/headline.icon';
 
 import Styled{{COMPONENT_CLASS_NAME}}Wrapper from './styles';
 
-import GetNextWork from './GetNextWork.jsx';
+import GetNextWork from './GetNextWork';
 import { getLayoutDataFromRegion } from './utils';
 
 // temp
@@ -20,13 +22,20 @@ import { getLayoutDataFromRegion } from './utils';
 // have to manually get icon, so can't determine a runtime for now
 // so "headline" icon is hardcoded.
 
-
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}Props extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  children: any;
+  title: string;
+  useConfigurableLayout: boolean;
+  enableGetNextWork: 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
-export default function {{COMPONENT_CLASS_NAME}}(props) {
+export default function {{COMPONENT_CLASS_NAME}}(props: {{COMPONENT_CLASS_NAME}}Props) {
 
   // add back in icon when working
   // const { children, title, icon, useConfigurableLayout, getPConnect, enableGetNextWork } = props;
@@ -34,9 +43,10 @@ export default function {{COMPONENT_CLASS_NAME}}(props) {
   const childArray = useMemo(() => {
     return Children.toArray(children);
   }, [children]);
+  const child0: any = childArray[0];
   const layoutItemsA = useMemo(() => {
-    return getLayoutDataFromRegion(childArray[0]);
-  }, [childArray[0]]);
+    return getLayoutDataFromRegion(child0);
+  }, [child0]);
 
   // temp
   const tempIcon = "pi pi-headline";
@@ -45,9 +55,11 @@ export default function {{COMPONENT_CLASS_NAME}}(props) {
 
     <Styled{{COMPONENT_CLASS_NAME}}Wrapper>
     <OneColumn
+      // @ts-ignore
       a={useConfigurableLayout ? <ConfigurableLayout items={layoutItemsA} /> : childArray[0]}
       title={title}
       icon={tempIcon?.replace('pi pi-', '')}
+       // @ts-ignore
       actions={enableGetNextWork ? <GetNextWork getPConnect={getPConnect} /> : null}
     />
     </Styled{{COMPONENT_CLASS_NAME}}Wrapper>

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

@@ -1,5 +1,4 @@
-/* eslint-disable import/no-relative-packages */
-/* eslint-disable no-undef */
+
 import { createUID } from '@pega/cosmos-react-core';
 
 // import { LazyMap as LazyComponentMap } from '../../components_map';
@@ -214,9 +213,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/Widget/CASE/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/Widget/CASE/demo.stories.jsx.mustache

@@ -1,11 +1,11 @@
-/* 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 historyData from './mock.stories';
+import historyData from './mock';
 
 export default {
   title: '{{COMPONENT_CLASS_NAME}}',
@@ -43,7 +43,7 @@ window.PCore.getDataApiUtils = () => {
   };
 };
 
-export const base{{COMPONENT_CLASS_NAME}} = () => {
+export const Base{{COMPONENT_CLASS_NAME}} = () => {
 
   const props = {
     label: 'Case history',