@pega/custom-dx-components 0.242.17 → 0.242.19

package/tests/assets/original/components/createAll/Launchpad/Pega_DXIL_MyTextInput/styles.ts

@@ -0,0 +1,8 @@
+// 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/tests/assets/original/components/createAll/Launchpad/Pega_DXIL_MyTextInput/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/original/components/createAll/Launchpad/Pega_DXIL_MyTimeOfDay/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/original/components/createAll/Launchpad/Pega_DXIL_MyTimeOfDay/config.json

@@ -0,0 +1,185 @@
+{
+  "name": "Pega_DXIL_MyTimeOfDay",
+  "label": "My TimeOfDay",
+  "description": "My TimeOfDay",
+  "organization": "Pega",
+  "version": "0.0.1",
+  "library": "DXIL",
+  "allowedApplications": [],
+  "componentKey": "Pega_DXIL_MyTimeOfDay",
+  "type": "Field",
+  "subtype": "TimeOfDay",
+  "icon": "images/pz-date-time-active.svg",
+  "properties": [
+    {
+      "name": "label",
+      "label": "Field label",
+      "format": "TEXT",
+      "required": true
+    },
+    {
+      "name": "readOnly",
+      "label": "Edit mode",
+      "format": "READONLY"
+    },
+    {
+      "format": "SELECT",
+      "name": "clockFormat",
+      "label": "Clock",
+      "defaultValue": "0",
+      "source": [
+        {
+          "key": "0",
+          "value": "use locale"
+        },
+        {
+          "key": "12",
+          "value": "12 hours"
+        },
+        {
+          "key": "24",
+          "value": "24 hours"
+        }
+      ]
+    },
+    {
+      "name": "withSeconds",
+      "label": "Display seconds",
+      "format": "BOOLEAN"
+    },
+    {
+      "label": "Column settings",
+      "format": "GROUP",
+      "visibility": "@VIEWTYPE == 'MultiRecordDisplayAsTable'",
+      "properties": [
+        {
+          "name": "columnWidth",
+          "label": "Column width",
+          "format": "SELECT",
+          "source": [
+            {
+              "key": "auto",
+              "value": "Auto"
+            },
+            {
+              "key": "custom",
+              "value": "Custom"
+            }
+          ]
+        },
+        {
+          "name": "width",
+          "label": "Width (px)",
+          "format": "NUMBER",
+          "visibility": "$this.columnWidth == 'custom'"
+        }
+      ]
+    },
+    {
+      "label": "Input settings",
+      "format": "GROUP",
+      "visibility": "(!readOnly = true)",
+      "properties": [
+        {
+          "format": "SELECT",
+          "name": "pickerInterval",
+          "label": "Time picker",
+          "defaultValue": "30",
+          "source": [
+            {
+              "key": "5",
+              "value": "5 min"
+            },
+            {
+              "key": "10",
+              "value": "10 min"
+            },
+            {
+              "key": "15",
+              "value": "15 min"
+            },
+            {
+              "key": "20",
+              "value": "20 min"
+            },
+            {
+              "key": "30",
+              "value": "30 min"
+            },
+            {
+              "key": "60",
+              "value": "1 hr"
+            }
+          ]
+        },
+        {
+          "name": "helperText",
+          "label": "Helper text",
+          "format": "TEXT"
+        }
+      ]
+    },
+    {
+      "label": "Read-only settings",
+      "format": "GROUP",
+      "properties": [
+        {
+          "format": "SELECT",
+          "name": "formatter",
+          "label": "Format",
+          "defaultValue": "defaultTime",
+          "source": [
+            {
+              "key": "defaultTime",
+              "value": "Default"
+            },
+            {
+              "key": "Time-Only",
+              "value": "Time only"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "label": "Conditions",
+      "format": "GROUP",
+      "properties": [
+        {
+          "name": "required",
+          "label": "Required",
+          "format": "REQUIRED",
+          "visibility": "(!readOnly = true)"
+        },
+        {
+          "name": "disabled",
+          "label": "Disabled",
+          "format": "DISABLED",
+          "visibility": "(!readOnly = true)"
+        },
+        {
+          "name": "visibility",
+          "label": "Visibility",
+          "format": "VISIBILITY"
+        }
+      ]
+    },
+    {
+      "label": "Advanced",
+      "format": "GROUP",
+      "collapsible": true,
+      "properties": [
+        {
+          "name": "testId",
+          "label": "Test ID",
+          "format": "TEXT",
+          "ignorePattern": "[^-_\\p{N}\\p{L}]",
+          "includeAnnotations": false
+        }
+      ]
+    }
+  ],
+  "defaultConfig": {
+    "label": "@L $this.label"
+  }
+}

package/tests/assets/original/components/createAll/Launchpad/Pega_DXIL_MyTimeOfDay/demo.stories.tsx

@@ -0,0 +1,65 @@
+/* eslint-disable react/jsx-no-useless-fragment */
+import type { Meta, StoryObj } from '@storybook/react';
+import { configProps, stateProps } from './mock';
+import PegaDxilMyTimeOfDay from './index';
+
+const meta: Meta<typeof PegaDxilMyTimeOfDay> = {
+  title: 'PegaDxilMyTimeOfDay',
+  component: PegaDxilMyTimeOfDay,
+  excludeStories: /.*Data$/
+};
+
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyTimeOfDay>;
+
+export const BasePegaDxilMyTimeOfDay: Story = (args: any) => {
+  const props = {
+    value: configProps.value,
+    additionalProps: configProps.additionalProps,
+    hasSuggestions: configProps.hasSuggestions,
+    getPConnect: () => {
+      return {
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {/* nothing */},
+            triggerFieldChange: () => {/* nothing */}
+          };
+        },
+        getValidationApi: () => {
+          return {
+            validate: () => {/* nothing */}
+          };
+        },
+        getStateProps: () => {
+          return stateProps;
+        },
+        getConfigProps: () => {
+          return configProps;
+        },
+        ignoreSuggestion: () => {/* nothing */},
+        clearErrorMessages: () => {/* nothing */}
+      };
+    }
+  };
+
+  return (
+    <>
+      <PegaDxilMyTimeOfDay {...props} {...args} />
+    </>
+  );
+};
+
+BasePegaDxilMyTimeOfDay.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/tests/assets/original/components/createAll/Launchpad/Pega_DXIL_MyTimeOfDay/index.tsx

@@ -0,0 +1,209 @@
+import { useEffect, useState } from 'react';
+import { TimeInput, FieldValueList, DateTimeDisplay, Text, withConfiguration } from '@pega/cosmos-react-core';
+
+import type { PConnFieldProps } from './PConnProps';
+
+
+// includes in bundle
+import {
+  parseClockFormat,
+
+  timeCorrectedToSeconds,
+  datetimeFireChangeBlurEvents
+} from "./time-of-day";
+import { suggestionsHandler } from './suggestions-handler';
+
+import StyledPegaDxilMyTimeOfDayWrapper 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 PegaDxilMyTimeOfDayProps 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
+function PegaDxilMyTimeOfDay (props: PegaDxilMyTimeOfDayProps)  {
+  const {
+    getPConnect,
+    value,
+    validatemessage,
+    label,
+    hideLabel = false,
+    helperText,
+    withSeconds = false,
+    pickerInterval = '30',
+    testId,
+    additionalProps = {},
+    displayMode,
+    variant = 'inline',
+    hasSuggestions = false
+  } = 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 = false, required = false, disabled = false } = props;
+  [readOnly, required, disabled] = [readOnly, required, disabled].map(
+    (prop) => prop === true || (typeof prop === 'string' && prop === 'true')
+  );
+
+  let { clockFormat = 0 } = props;
+  clockFormat = parseClockFormat(clockFormat);
+
+  const [status, setStatus] = useState(hasSuggestions ? 'pending' : undefined);
+
+  useEffect(() => {
+    if (validatemessage !== '') {
+      setStatus('error');
+    }
+    if (hasSuggestions) {
+      setStatus('pending');
+    } else if (!hasSuggestions && status !== 'success') {
+      setStatus(validatemessage !== '' ? 'error' : undefined);
+    }
+  }, [validatemessage, hasSuggestions, status]);
+
+  const onResolveSuggestionHandler = (accepted: boolean) => {
+    suggestionsHandler(accepted, pConn, setStatus);
+  };
+
+  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('');
+    }
+  }
+
+  function handleChange(onChangeValue: any) {
+    const { valueAsISOString: time } = onChangeValue;
+    const trimmedTime = time ? timeCorrectedToSeconds(time, withSeconds) : time;
+    if (hasSuggestions && value !== trimmedTime) {
+      setStatus('');
+    }
+    pConn.clearErrorMessages({
+      category: "",
+      property: propName,
+      context: ""
+    });
+  }
+
+  if (displayMode === 'LABELS_LEFT' || displayMode === 'STACKED_LARGE_VAL' || displayMode === 'DISPLAY_ONLY') {
+    let variantValue = 'time';
+    let formatValue = withSeconds ? 'long' : 'short';
+    if (pConn && pConn.getConfigProps()) {
+      const configProps = pConn.getConfigProps() as ConfigProps;
+      const runtimeformatter = configProps?.formatter;
+      if (formatter !== runtimeformatter) {
+        formatter = runtimeformatter!;
+      }
+    }
+    if (formatter === 'Time-Only') {
+      variantValue = 'time';
+      formatValue = 'long';
+    }
+    const displayComp = (
+      <DateTimeDisplay
+        variant={variantValue as DateTimeVariant}
+        format={formatValue as DateTimeFormat}
+        value={value}
+        clockFormat={clockFormat as ClockFormat || undefined}
+      />
+    );
+    switch (displayMode) {
+      case 'DISPLAY_ONLY': {
+        return ( <StyledPegaDxilMyTimeOfDayWrapper> {displayComp} </StyledPegaDxilMyTimeOfDayWrapper>);
+      }
+      case 'LABELS_LEFT': {
+        return (
+          <StyledPegaDxilMyTimeOfDayWrapper>
+          <FieldValueList
+            variant={hideLabel ? 'stacked' : variant}
+            data-testid={testId}
+            fields={[{ id: '1', name: hideLabel ? '' : label, value: displayComp }]}
+          />
+          </StyledPegaDxilMyTimeOfDayWrapper>
+        );
+      }
+      case 'STACKED_LARGE_VAL': {
+        return (
+          <StyledPegaDxilMyTimeOfDayWrapper>
+          <FieldValueList
+            variant='stacked'
+            data-testid={testId}
+            fields={[
+              {
+                id: '2',
+                name: hideLabel ? '' : label,
+                value: (
+                  <Text variant='h1' as='span'>
+                    {displayComp}
+                  </Text>
+                )
+              }
+            ]}
+          />
+          </StyledPegaDxilMyTimeOfDayWrapper>
+        );
+      }
+      // no default
+    }
+  }
+
+  return (
+    <StyledPegaDxilMyTimeOfDayWrapper>
+    <TimeInput
+      {...additionalProps}
+      label={label}
+      labelHidden={hideLabel}
+      info={validatemessage || helperText}
+      status={status}
+      value={value || undefined}
+      withSeconds={withSeconds}
+      disabled={disabled}
+      readOnly={readOnly}
+      required={required}
+      pickerInterval={pickerInterval}
+      clockFormat={clockFormat || undefined}
+      data-testid={testId}
+       // @ts-ignore
+      onFocus={actions.onFocus}
+      onChange={handleChange}
+      onBlur={handleBlur}
+      onResolveSuggestion={onResolveSuggestionHandler}
+    />
+    </StyledPegaDxilMyTimeOfDayWrapper>
+  );
+}
+
+
+
+export default withConfiguration(PegaDxilMyTimeOfDay);

package/tests/assets/original/components/createAll/Launchpad/Pega_DXIL_MyTimeOfDay/mock.ts

@@ -0,0 +1,21 @@
+export const configProps = {
+  value: '13:30',
+  validatemessage: '',
+  label: 'TimeOfDay Label',
+  hideLabel: false,
+  helperText: 'TimeOfDay helper text',
+  withSeconds: false,
+  testId: '12345678',
+  additionalProps: {},
+  displayMode: '',
+  variant: '',
+  hasSuggestions: false,
+  readOnly: false,
+  required: false,
+  disabled: false,
+  status: ''
+};
+
+export const stateProps = {
+  value: '.TimeOfDayLabel'
+};

package/tests/assets/original/components/createAll/Launchpad/Pega_DXIL_MyTimeOfDay/styles.ts

@@ -0,0 +1,8 @@
+// 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/tests/assets/original/components/createAll/Launchpad/Pega_DXIL_MyTimeOfDay/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);
+  }
+};