@pega/dx-component-builder-sdk 23.1.14 → 24.1.10

package/src/tasks/create/templates/Constellation/field/TimeOfDay/demo.stories.tsx.mustache

@@ -1,18 +1,23 @@
-
 /* eslint-disable react/jsx-no-useless-fragment */
 // @ts-nocheck
-import { withKnobs } from '@storybook/addon-knobs';
+import type { Meta, StoryObj } from '@storybook/react';
 import { configProps, stateProps } from './mock';
 import {{COMPONENT_CLASS_NAME}} from './index';
 
-export default {
+const meta: Meta<typeof {{COMPONENT_CLASS_NAME}}> = {
   title: '{{COMPONENT_CLASS_NAME}}',
-  decorators: [withKnobs],
-  component: {{COMPONENT_CLASS_NAME}}
+  component: {{COMPONENT_CLASS_NAME}},
+  excludeStories: /.*Data$/
 };
 
-export const Base{{COMPONENT_CLASS_NAME}} = () => {
+export default meta;
+type Story = StoryObj<typeof {{COMPONENT_CLASS_NAME}}>;
+
+export const Base{{COMPONENT_CLASS_NAME}}: Story = args => {
   const props = {
+    value: configProps.value,
+    additionalProps: configProps.additionalProps,
+    hasSuggestions: configProps.hasSuggestions,
     getPConnect: () => {
       return {
         getActionsApi: () => {
@@ -35,26 +40,27 @@ export const Base{{COMPONENT_CLASS_NAME}} = () => {
         ignoreSuggestion: () => {/* nothing */},
         clearErrorMessages: () => {/* nothing */}
       };
-    },
-    value: configProps.value,
-    validatemessage: configProps.validatemessage,
-    label: configProps.label,
-    hideLabel: configProps.hideLabel,
-    helperText: configProps.helperText,
-    withSeconds: configProps.withSeconds,
-    testId: configProps.testId,
-    additionalProps: configProps.additionalProps,
-    displayMode: configProps.displayMode,
-    variant: configProps.variant,
-    hasSuggestions: configProps.hasSuggestions,
-    disabled: configProps.disabled,
-    readOnly: configProps.readOnly,
-    required: configProps.required
+    }
   };
 
   return (
     <>
-      <{{COMPONENT_CLASS_NAME}} {...props} />
+      <{{COMPONENT_CLASS_NAME}} {...props} {...args} />
     </>
   );
 };
+
+Base{{COMPONENT_CLASS_NAME}}.args = {
+  label: configProps.label,
+  helperText: configProps.helperText,
+  withSeconds: configProps.withSeconds,
+  testId: configProps.testId,
+  readOnly: configProps.readOnly,
+  disabled: configProps.disabled,
+  required: configProps.required,
+  status: configProps.status,
+  hideLabel: configProps.hideLabel,
+  displayMode: configProps.displayMode,
+  variant: configProps.variant,
+  validatemessage: configProps.validatemessage
+};

package/src/tasks/create/templates/Constellation/field/TimeOfDay/index.tsx.mustache

@@ -1,6 +1,6 @@
 import { useEffect, useState } from 'react';
-import { TimeInput, FieldValueList, DateTimeDisplay, Text } from '@pega/cosmos-react-core';
-import PropTypes from 'prop-types';
+import { TimeInput, FieldValueList, DateTimeDisplay, Text, withConfiguration } from '@pega/cosmos-react-core';
+
 import type { PConnFieldProps } from './PConnProps';
 
 
@@ -45,35 +45,35 @@ interface ConfigProps {
 
 // 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: {{COMPONENT_CLASS_NAME}}Props)  {
+function {{COMPONENT_CLASS_NAME}} (props: {{COMPONENT_CLASS_NAME}}Props)  {
   const {
     getPConnect,
     value,
     validatemessage,
     label,
-    hideLabel,
+    hideLabel = false,
     helperText,
-    withSeconds,
-    pickerInterval,
+    withSeconds = false,
+    pickerInterval = '30',
     testId,
-    additionalProps,
+    additionalProps = {},
     displayMode,
-    variant,
-    hasSuggestions
+    variant = 'inline',
+    hasSuggestions = false
   } = props;
-  let { formatter } = props;
+  let { formatter = 'defaultTime' } = props;
   const pConn = getPConnect();
   const actions = pConn.getActionsApi();
   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;
+  let { readOnly = false, required = false, disabled = false } = props;
   [readOnly, required, disabled] = [readOnly, required, disabled].map(
     (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
   );
 
-  let { clockFormat } = props;
+  let { clockFormat = 0 } = props;
   clockFormat = parseClockFormat(clockFormat);
 
   const [status, setStatus] = useState(hasSuggestions ? 'pending' : undefined);
@@ -123,7 +123,7 @@ export default function {{COMPONENT_CLASS_NAME}} (props: {{COMPONENT_CLASS_NAME}
       const configProps = pConn.getConfigProps() as ConfigProps;
       const runtimeformatter = configProps?.formatter;
       if (formatter !== runtimeformatter) {
-        formatter = runtimeformatter;
+        formatter = runtimeformatter!;
       }
     }
     if (formatter === 'Time-Only') {
@@ -140,7 +140,7 @@ export default function {{COMPONENT_CLASS_NAME}} (props: {{COMPONENT_CLASS_NAME}
     );
     switch (displayMode) {
       case 'DISPLAY_ONLY': {
-        return ( <Styled{{COMPONENT_CLASS_NAME}}Wrapper> displayComp </Styled{{COMPONENT_CLASS_NAME}}Wrapper>);
+        return ( <Styled{{COMPONENT_CLASS_NAME}}Wrapper> {displayComp} </Styled{{COMPONENT_CLASS_NAME}}Wrapper>);
       }
       case 'LABELS_LEFT': {
         return (
@@ -204,42 +204,6 @@ export default function {{COMPONENT_CLASS_NAME}} (props: {{COMPONENT_CLASS_NAME}
   );
 }
 
-{{COMPONENT_CLASS_NAME}}.defaultProps = {
-  value: undefined,
-  withSeconds: false,
-  validatemessage: "",
-  helperText: "",
-  hideLabel: false,
-  disabled: false,
-  readOnly: false,
-  required: false,
-  pickerInterval: "30",
-  clockFormat: 0,
-  testId: '',
-  additionalProps: {},
-  displayMode: null,
-  variant: "inline",
-  formatter:"defaultTime",
-  hasSuggestions: false
-};
-
-{{COMPONENT_CLASS_NAME}}.propTypes = {
-  value: PropTypes.string,
-  label: PropTypes.string.isRequired,
-  hideLabel: PropTypes.bool,
-  withSeconds: PropTypes.bool,
-  getPConnect: PropTypes.func.isRequired,
-  validatemessage: PropTypes.string,
-  helperText: PropTypes.string,
-  disabled: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
-  readOnly: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
-  required: PropTypes.oneOfType([PropTypes.bool, PropTypes.string]),
-  pickerInterval: PropTypes.string,
-  clockFormat: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
-  testId: PropTypes.string,
-  additionalProps: PropTypes.objectOf(PropTypes.any),
-  displayMode: PropTypes.string,
-  variant: PropTypes.string,
-  formatter : PropTypes.string,
-  hasSuggestions: PropTypes.bool
-};
+
+
+export default withConfiguration({{COMPONENT_CLASS_NAME}});

package/src/tasks/create/templates/Constellation/field/TimeOfDay/mock.ts.mustache

@@ -14,7 +14,8 @@ export const configProps = {
   hasSuggestions: false,
   readOnly: false,
   required: false,
-  disabled: false
+  disabled: false,
+  status: ''
 };
 
 export const stateProps = {

package/src/tasks/create/templates/Constellation/field/TimeOfDay/styles.ts.mustache

@@ -1,15 +1,8 @@
-
-// utilizing theming, comment out, if want individual style
-import styled from 'styled-components';
-import { Configuration } from '@pega/cosmos-react-core';
-
-export default styled(Configuration)``;
-
 // individual style, comment out above, and uncomment here and add styles
-// import styled, { css } from 'styled-components';
-//
-// export default styled.div(() => {
-//  return css`
-//    margin: 0px 0;
-//  `;
-// });
+import styled, { css } from 'styled-components';
+
+export default styled.div(() => {
+  return css`
+    margin: 0px 0;
+  `;
+});

package/src/tasks/create/templates/Constellation/field/{DateTime/date-utils.js.mustache → TimeOfDay/time-of-day.ts.mustache}

@@ -16,11 +16,11 @@ dayjs.extend(timezone);
  * @param {string} text datetime
  * @returns {object} datetime as a dayjs object
  */
-export const getDayJSObject = (text) => {
+export const getDayJSObject = (text: string) => {
   const momObj = dayjs(text);
   if (momObj.isValid()) return momObj;
   const timeStamp = text;
-  const isDateTime = timeStamp.indexOf("GMT") !== -1;
+  const isDateTime = timeStamp.includes("GMT");
   const year = parseInt(timeStamp.substr(0, 4), 10);
   const month = parseInt(timeStamp.substr(4, 2), 10) - 1;
   const day = parseInt(timeStamp.substr(6, 2), 10);
@@ -35,16 +35,17 @@ export const getDayJSObject = (text) => {
 
   /* istanbul ignore else */
   if (isDateTime) {
-    const hours = parseInt(timeStamp.substr(9, 2), 10);
-    const minutes = parseInt(timeStamp.substr(11, 2), 10);
-    const seconds = parseInt(timeStamp.substr(13, 2), 10);
-    const ms = parseInt(timeStamp.substr(16, 3), 10);
+    const hours = parseInt(timeStamp.substring(9, 2), 10);
+    const minutes = parseInt(timeStamp.substring(11, 2), 10);
+    const seconds = parseInt(timeStamp.substring(13, 2), 10);
+    const ms = parseInt(timeStamp.substring(16, 3), 10);
     mom.setUTCHours(hours);
     mom.setUTCMinutes(minutes);
     mom.setUTCSeconds(seconds);
     mom.setUTCMilliseconds(ms);
   }
 
+  // @ts-ignore
   mom = dayjs(
     mom.toLocaleString("en-US", {
       timeZone: CurrentTz
@@ -60,7 +61,7 @@ export const getDayJSObject = (text) => {
  * @param {string} time datetime
  * @returns {object} relative time from now
  */
-export const getRelativeTime = (time) => {
+export const getRelativeTime = (time: string) => {
   let relativetime = "";
   if (dayjs(time).isUTC()) {
     relativetime = dayjs(time).fromNow();
@@ -77,7 +78,7 @@ export const getRelativeTime = (time) => {
  * @param {string} value from which Year needs to be taken out
  * @returns {number} year for the date passed
  */
-export const getFullYear = (value) =>
+export const getFullYear = (value: any) =>
   value ? new Date(value).getFullYear() : new Date().getFullYear();
 
 /**
@@ -89,7 +90,7 @@ export const getFullYear = (value) =>
  *
  * @returns {string} maxDate calculated based on inputs
  */
-export const getMaxDate = (nextYears, currentYear, yearFromValue) => {
+export const getMaxDate = (nextYears: number, currentYear: number, yearFromValue: number) => {
   if (Number.isNaN(nextYears)) {
     nextYears = 20;
   }
@@ -109,7 +110,7 @@ export const getMaxDate = (nextYears, currentYear, yearFromValue) => {
  *
  * @returns {string} minDate calculated based on inputs
  */
-export const getMinDate = (previousYears, currentYear, yearFromValue) => {
+export const getMinDate = (previousYears: number, currentYear: number, yearFromValue: number) => {
   if (Number.isNaN(previousYears)) {
     previousYears = 100;
   }
@@ -127,7 +128,7 @@ export const getMinDate = (previousYears, currentYear, yearFromValue) => {
  *
  * @returns {number} clockFormat
  */
-export const parseClockFormat = (clockFormat) =>
+export const parseClockFormat = (clockFormat: number | string) =>
   typeof clockFormat === "string" ? parseInt(clockFormat, 10) : clockFormat;
 
 /**
@@ -138,7 +139,7 @@ export const parseClockFormat = (clockFormat) =>
  *
  * @returns {string} datetime after stripping of ms and seconds if selected to
  */
-export const correctDateTimeToSeconds = (datetime, withSeconds) => {
+export const correctDateTimeToSeconds = (datetime: string, withSeconds: boolean) => {
   if (withSeconds) {
     return `${datetime.substring(0, datetime.indexOf("Z"))}.000Z`;
   }
@@ -153,7 +154,7 @@ export const correctDateTimeToSeconds = (datetime, withSeconds) => {
  *
  * @returns {string} just time after stripping of ms and seconds if selected to
  */
-export const timeCorrectedToSeconds = (datetime, withSeconds) => {
+export const timeCorrectedToSeconds = (datetime: string, withSeconds: boolean) => {
   if (withSeconds) {
     return datetime.substring(datetime.indexOf("T") + 1, datetime.indexOf("."));
   }
@@ -176,12 +177,12 @@ export const timeCorrectedToSeconds = (datetime, withSeconds) => {
  * @returns {void}
  */
 export const datetimeFireChangeBlurEvents = (
-  errorState,
-  actualValue,
-  formattedValue,
-  actions,
-  propName,
-  pConn
+  errorState: string | undefined,
+  actualValue: string,
+  formattedValue: string,
+  actions: any,
+  propName: string,
+  pConn: any
 ) => {
 
   // TODO - clean up, we should not rely on timestamp from cosmos to check InComplete validation
@@ -206,7 +207,7 @@ export const datetimeFireChangeBlurEvents = (
  * @returns {string} dateformat for the locale
  * Example : getDateFormat("pl-PL") returns "DD.MM.YYYY"
  */
-export const getDateFormat = (locale, options) => {
+export const getDateFormat = (locale: string, options: any) => {
   return new Intl.DateTimeFormat(locale, options)
     .formatToParts()
     .map(({ type, value }) => {
@@ -241,7 +242,7 @@ export const getDateFormat = (locale, options) => {
  * @returns {boolean} True or False for the locale
  * Example : getDateFormat("pl-PL") returns false
  */
-export const is12HClockFormat = (locale) => {
+export const is12HClockFormat = (locale: string) => {
   const meridiem = new Intl.DateTimeFormat(locale, {
     hour: "numeric"
   })
@@ -260,7 +261,7 @@ export const is12HClockFormat = (locale) => {
  * @returns {object} options object time formatting
  * Example : getTimeOptions(false, true) returns {hour: 'numeric',minute: 'numeric',hour12: true}
  */
-export const getTimeOptions = (withSeconds, is12h = false) => {
+export const getTimeOptions = (withSeconds: boolean, is12h = false) => {
   return {
     hour: "numeric",
     minute: "numeric",
@@ -277,7 +278,7 @@ export const getTimeOptions = (withSeconds, is12h = false) => {
  * @returns {object} options object datetime formatting
  * Example : getDateTimeOptions(false, true) returns {year: 'numeric',month: 'numeric',day: 'numeric',hour: 'numeric',minute: 'numeric',hour12: true}
  */
-export const getDateTimeOptions = (withSeconds, is12h = false) => {
+export const getDateTimeOptions = (withSeconds: boolean, is12h = false) => {
   return {
     year: "numeric",
     month: "numeric",

package/src/tasks/create/templates/Constellation/template/DETAILS/Avatar.tsx.mustache

@@ -0,0 +1,78 @@
+/* eslint-disable react-hooks/rules-of-hooks */
+import  React from 'react';
+import { useEffect, useState } from 'react';
+import { Avatar as CosmosAvatar, withConfiguration } from '@pega/cosmos-react-core';
+import type { PConnFieldProps } from './PConnProps';
+
+
+// interface for props
+interface {{COMPONENT_CLASS_NAME}}AvatarProps extends PConnFieldProps {
+  // If any, enter additional props that only exist on TextInput here
+  metaObj: any;
+  showStatus: boolean;
+
+}
+
+function Avatar(props: {{COMPONENT_CLASS_NAME}}AvatarProps) {
+  const { metaObj, showStatus = false } = props;
+  const [imageBlobUrl, setImageBlobUrl] = useState(null);
+  let userName: string;
+  let userIdentifier: string;
+
+  // TODO Below if conditions can be removed once we have apis to get worklist/mywork info
+  // This is non CaseView case (Dashboard, MyWork etc)
+  if (!metaObj) {
+    userName = PCore.getEnvironmentInfo().getOperatorName();
+    userIdentifier = PCore.getEnvironmentInfo().getOperatorIdentifier();
+  } else {
+    userName = metaObj.name;
+    userIdentifier = metaObj.ID;
+  }
+  if (!userName && userIdentifier) {
+    userName = userIdentifier;
+  }
+
+  useEffect(() => {
+    const imageKey = !metaObj ? PCore.getEnvironmentInfo().getOperatorImageInsKey() : metaObj.image;
+    if (imageKey) {
+      PCore.getAssetLoader()
+        .getSvcImage(imageKey)
+        .then((blob) => window.URL.createObjectURL(blob))
+        .then((imagePath) => setImageBlobUrl(imagePath as React.SetStateAction<any>));
+    }
+  }, [metaObj]);
+
+  if (showStatus) {
+    const currentState = PCore.getMessagingServiceManager().getUserPresence().getUserState(userIdentifier);
+    const [userState, setUserState]: any  = useState(currentState === 'online' ? 'active' : 'inactive');
+
+    // @ts-ignore
+    const handleUserStateChange = ({ state }) => {
+      setUserState(state === 'online' ? 'active' : 'inactive');
+    };
+
+    useEffect(() => {
+      const subId = PCore.getMessagingServiceManager()
+        .getUserPresence()
+        // @ts-ignore
+        .subscribe(userIdentifier, handleUserStateChange);
+
+      return function cleanup() {
+        PCore.getMessagingServiceManager().getUserPresence().unsubscribe(userIdentifier, subId);
+      };
+    }, [userIdentifier, handleUserStateChange]);
+    // @ts-ignore
+    return <CosmosAvatar name={userName} imageSrc={imageBlobUrl as React.SetStateAction<any>} status={userState} />;
+  }
+
+  // Do not render when userName does not exists
+  // TODO : In CNR case, pxRequestor is not available, please remove this condition once it populates
+  if (!userName) {
+    return null;
+  }
+
+  return <CosmosAvatar name={userName} imageSrc={imageBlobUrl as React.SetStateAction<any>} />;
+}
+
+
+export default withConfiguration(Avatar);

package/src/tasks/create/templates/Constellation/template/DETAILS/DetailsRender.tsx.mustache

@@ -0,0 +1,55 @@
+import { Fragment, ReactElement } from 'react';
+import { FieldValueList } from '@pega/cosmos-react-core';
+
+interface DetailsRenderProps {
+  children?: never;
+  child: NonNullable<ReactElement>;
+}
+
+const DetailsRender = (props: DetailsRenderProps) => {
+  const { child } = props;
+
+  const kids = child.props.getPConnect().getChildren();
+
+  const displayCompArr: ReactElement[] = [];
+
+  Object.values(kids).forEach((value: any, i :number) => {
+    const { type } = value.getPConnect().getRawMetadata();
+    const { hideLabel, variant, testId, label } = value
+      .getPConnect()
+      .resolveConfigProps(value.getPConnect().getConfigProps());
+
+    let displayComp;
+    const key = JSON.stringify(value.getPConnect());
+    const key1 = key.concat(`-${i}`);
+
+    if (type === 'reference') {
+      const refElement = value.getPConnect().getComponent();
+
+      displayCompArr.push(refElement);
+    } else {
+      const element = value.getPConnect().getComponent();
+      const displayEl = <Fragment key={key}>{element}</Fragment>;
+
+{{! pick new delimiters for mustache }}
+{{=<% %>=}}
+      displayComp = (
+        <Fragment key={key1}>
+          <FieldValueList
+            style={{ columnGap: '0'}}
+            variant={hideLabel ? 'stacked' : variant}
+            data-testid={testId}
+            fields={[{ id: '1', name: hideLabel ? '' : label, value: displayEl }]}
+          />
+        </Fragment>
+      );
+<%={{ }}=%>     {{! revert delimiters for mustache }}
+
+      displayCompArr.push(displayComp);
+    }
+  });
+
+  return <>{displayCompArr}</>;
+};
+
+export default DetailsRender;

package/src/tasks/create/templates/Constellation/template/DETAILS/HighlightRender.tsx.mustache

@@ -0,0 +1,49 @@
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import React from 'react';
+import { FieldValueList, Text } from '@pega/cosmos-react-core';
+import type { PConnProps } from './PConnProps';
+
+interface HighlightRenderProps extends PConnProps {
+  field?: any;
+}
+
+const HighlightRender = (props: HighlightRenderProps) => {
+  const { getPConnect, field } = props;
+
+  field.config.displayMode = 'DISPLAY_ONLY';
+
+  // Mark as status display when using pyStatusWork
+  if (field.config?.value === '@P .pyStatusWork') {
+    field.type = 'TextInput';
+    field.config.displayAsStatus = true;
+  }
+
+  const configProps: any = getPConnect().resolveConfigProps(field.config);
+
+  // @ts-ignore
+  const reactField = getPConnect().createComponent(field);
+
+  return (
+{{! pick new delimiters for mustache }}
+{{=<% %>=}}
+    <FieldValueList
+      style={{ width: 'auto' }}
+      variant='stacked'
+      data-testid={field.testId}
+      fields={[
+        {
+          id: '2',
+          name: configProps.hideLabel ? '' : configProps.label,
+          value: (
+            <Text variant='h1' as='span'>
+              {reactField}
+            </Text>
+          )
+        }
+      ]}
+    />
+<%={{ }}=%>     {{! revert delimiters for mustache }}
+  );
+};
+
+export default HighlightRender;