@pega/custom-dx-components 0.24.17 → 0.25.1

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

@@ -0,0 +1,63 @@
+
+/* eslint-disable react/jsx-no-useless-fragment */
+import type { Meta, StoryObj } from '@storybook/react';
+
+import PegaDxilMyTextInput from './index';
+
+import { stateProps, fieldMetadata, configProps } from './mock';
+
+const meta: Meta<typeof PegaDxilMyTextInput> = {
+  title: 'PegaDxilMyTextInput',
+  component: PegaDxilMyTextInput,
+  excludeStories: /.*Data$/
+};
+
+export default meta;
+type Story = StoryObj<typeof PegaDxilMyTextInput>;
+
+export const BasePegaDxilMyTextInput: Story = (args: any) => {
+
+  const props = {
+    value: configProps.value,
+    hasSuggestions: configProps.hasSuggestions,
+    fieldMetadata,
+    getPConnect: () => {
+      return {
+        getStateProps: () => {
+          return stateProps;
+        },
+        getActionsApi: () => {
+          return {
+            updateFieldValue: () => {/* nothing */},
+            triggerFieldChange: () => {/* nothing */}
+          };
+        },
+        ignoreSuggestion: () => {/* nothing */},
+        acceptSuggestion: () => {/* nothing */},
+        setInheritedProps: () => {/* nothing */},
+        resolveConfigProps: () => {/* nothing */}
+      };
+    }
+  };
+
+  return (
+    <>
+      <PegaDxilMyTextInput {...props} {...args} />
+    </>
+  );
+};
+
+BasePegaDxilMyTextInput.args = {
+  label: configProps.label,
+  helperText: configProps.helperText,
+  placeholder: configProps.placeholder,
+  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_MyTextInput/event-utils.ts

@@ -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/tests/assets/original/components/createAll/Launchpad/Pega_DXIL_MyTextInput/mock.ts

@@ -0,0 +1,30 @@
+
+export const configProps = {
+  value: '',
+  label: 'TextInput Sample',
+  placeholder: 'TextInput Placeholder',
+  helperText: 'TextInput Helper Text',
+  testId: 'TextInput-12345678',
+  hasSuggestions: false,
+  displayMode: '',
+  variant: '',
+  hideLabel: false,
+  readOnly: false,
+  required: false,
+  disabled: false,
+  status: '',
+  validatemessage: ''
+};
+
+export const stateProps = {
+  value: '.TextInputSample',
+  hasSuggestions: false
+};
+
+export const fieldMetadata = {
+  classID: 'DIXL-MediaCo-Work-NewService',
+  type: 'Text',
+  maxLength: 256,
+  displayAs: 'pxTextInput',
+  label: 'TextInput Sample'
+};

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_MyTimeOfDay/config.json

@@ -0,0 +1,188 @@
+{
+  "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",
+    "detailFVLItem": true,
+    "isFormWidth" : false,
+    "isContainerWidth" : false
+  }
+}

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/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);
+  }
+};

package/tests/assets/original/components/createAll/Launchpad/Pega_DXIL_MyTimeOfDay/time-of-day.ts

@@ -0,0 +1,288 @@
+import dayjs from "dayjs";
+import relativeTime from 'dayjs/plugin/relativeTime.js';
+import localizedFormat from 'dayjs/plugin/localizedFormat.js';
+import utc from 'dayjs/plugin/utc.js';
+import timezone from 'dayjs/plugin/timezone.js';
+
+dayjs.extend(relativeTime);
+dayjs.extend(localizedFormat);
+dayjs.extend(utc);
+dayjs.extend(timezone);
+
+/**
+ * Return relative time in fromNow for the given datetime
+ * @description Convert and return the given datetime in dayJSObject
+ *
+ * @param {string} text datetime
+ * @returns {object} datetime as a dayjs object
+ */
+export const getDayJSObject = (text: string) => {
+  const momObj = dayjs(text);
+  if (momObj.isValid()) return momObj;
+  const timeStamp = text;
+  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);
+
+  const CurrentTz = PCore.getLocaleUtils().getTimeZoneInUse();
+
+  let mom = new Date();
+
+  mom.setUTCDate(day);
+  mom.setUTCMonth(month);
+  mom.setUTCFullYear(year);
+
+  /* istanbul ignore else */
+  if (isDateTime) {
+    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
+    })
+  );
+
+  return mom;
+};
+
+/**
+ * Return relative time in fromNow for the given datetime
+ *
+ * @param {string} time datetime
+ * @returns {object} relative time from now
+ */
+export const getRelativeTime = (time: string) => {
+  let relativetime = "";
+  if (dayjs(time).isUTC()) {
+    relativetime = dayjs(time).fromNow();
+  } else {
+    const dayjstime = getDayJSObject(time);
+    relativetime = dayjs(dayjstime).fromNow();
+  }
+  return relativetime;
+};
+
+/**
+ * Return year for the date passed
+ *
+ * @param {string} value from which Year needs to be taken out
+ * @returns {number} year for the date passed
+ */
+export const getFullYear = (value: any) =>
+  value ? new Date(value).getFullYear() : new Date().getFullYear();
+
+/**
+ * Return maxDate for the date passed
+ *
+ * @param {number} nextYears next number of years
+ * @param {number} currentYear current year
+ * @param {number} yearFromValue year set on value in redux
+ *
+ * @returns {string} maxDate calculated based on inputs
+ */
+export const getMaxDate = (nextYears: number, currentYear: number, yearFromValue: number) => {
+  if (Number.isNaN(nextYears)) {
+    nextYears = 20;
+  }
+  let maxYear = currentYear + nextYears;
+  if (yearFromValue > maxYear) {
+    maxYear = yearFromValue;
+  }
+  return `${maxYear}-01-01`;
+};
+
+/**
+ * Return minDate for the date passed
+ *
+ * @param {number} previousYears previous number of years
+ * @param {number} currentYear current year
+ * @param {number} yearFromValue year set on value in redux
+ *
+ * @returns {string} minDate calculated based on inputs
+ */
+export const getMinDate = (previousYears: number, currentYear: number, yearFromValue: number) => {
+  if (Number.isNaN(previousYears)) {
+    previousYears = 100;
+  }
+  let minYear = currentYear - previousYears;
+  if (yearFromValue < minYear) {
+    minYear = yearFromValue;
+  }
+  return `${minYear}-12-31`;
+};
+
+/**
+ * Return clockFormat after parsing
+ *
+ * @param {number | string} clockFormat chosen by user
+ *
+ * @returns {number} clockFormat
+ */
+export const parseClockFormat = (clockFormat: number | string) =>
+  typeof clockFormat === "string" ? parseInt(clockFormat, 10) : clockFormat;
+
+/**
+ * Return datetime value string off to seconds
+ *
+ * @param {string} datetime in ISO format
+ * @param {boolean} withSeconds to specify if seconds is needed or not
+ *
+ * @returns {string} datetime after stripping of ms and seconds if selected to
+ */
+export const correctDateTimeToSeconds = (datetime: string, withSeconds: boolean) => {
+  if (withSeconds) {
+    return `${datetime.substring(0, datetime.indexOf("Z"))}.000Z`;
+  }
+  return `${datetime.substring(0, datetime.lastIndexOf(":"))}:00.000Z`;
+};
+
+/**
+ * Return time value string off to seconds
+ *
+ * @param {string} datetime in ISO format
+ * @param {boolean} withSeconds to specify if seconds is needed or not
+ *
+ * @returns {string} just time after stripping of ms and seconds if selected to
+ */
+export const timeCorrectedToSeconds = (datetime: string, withSeconds: boolean) => {
+  if (withSeconds) {
+    return datetime.substring(datetime.indexOf("T") + 1, datetime.indexOf("."));
+  }
+  return `${datetime.substring(
+    datetime.indexOf("T") + 1,
+    datetime.lastIndexOf(":")
+  )}:00`;
+};
+
+/**
+ * This function handles the cosmos blur handler of DateTime components
+ *
+ * @param {string | undefined} errorState for the selected datetime value
+ * @param {string} actualValue present in redux
+ * @param {string} formattedValue retrieved by trimming ISO to just Date/Time, also applying timezone if DateTime
+ * @param {object} actions object which has fire and blur callbacks
+ * @param {string} propName name of the property bound
+ * @param {object} pConn component's PConnect object which is useful to invoke validationApi
+ *
+ * @returns {void}
+ */
+export const datetimeFireChangeBlurEvents = (
+  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
+  // above triggerFieldChange should have validated this
+  if (errorState) {
+    pConn.getValidationApi().validate(errorState);
+  }
+  // BUG-640834 In errorState presist old values avoiding store update & re-render.
+  else{
+    if (formattedValue !== actualValue) {
+      actions.updateFieldValue(propName, formattedValue);
+    }
+    actions.triggerFieldChange(propName, formattedValue);
+  }
+};
+
+/**
+ * Return Date format for the locale passed
+ *
+ * @param {string} locale locale string
+ * @param {object} options options for format string
+ * @returns {string} dateformat for the locale
+ * Example : getDateFormat("pl-PL") returns "DD.MM.YYYY"
+ */
+export const getDateFormat = (locale: string, options: any) => {
+  return new Intl.DateTimeFormat(locale, options)
+    .formatToParts()
+    .map(({ type, value }) => {
+      switch (type) {
+        case "day":
+          return "DD";
+        case "month":
+          return "MM";
+        case "year":
+          return "YYYY";
+        case "hour":
+          return "hh";
+        case "minute":
+          return "mm";
+        case "second":
+          return "ss";
+        case "dayPeriod":
+          return "A";
+        case "literal":
+          return value;
+        default:
+          return "";
+      }
+    })
+    .join("");
+};
+
+/**
+ * Return boolean for the locale passed to specify if locale uses 12 hour format
+ *
+ * @param {string} locale locale string
+ * @returns {boolean} True or False for the locale
+ * Example : getDateFormat("pl-PL") returns false
+ */
+export const is12HClockFormat = (locale: string) => {
+  const meridiem = new Intl.DateTimeFormat(locale, {
+    hour: "numeric"
+  })
+    .formatToParts()
+    .find(({ type }) => type === "dayPeriod");
+  return !!(meridiem === null || meridiem === undefined
+    ? undefined
+    : meridiem.value);
+};
+
+/**
+ * Return Option object for Time formatting
+ *
+ * @param {boolean} withSeconds true or false depending on seconds to be included
+ * @param {boolean} is12h 12 hour format
+ * @returns {object} options object time formatting
+ * Example : getTimeOptions(false, true) returns {hour: 'numeric',minute: 'numeric',hour12: true}
+ */
+export const getTimeOptions = (withSeconds: boolean, is12h = false) => {
+  return {
+    hour: "numeric",
+    minute: "numeric",
+    ...(withSeconds && { second: "numeric" }),
+    hour12: is12h
+  };
+};
+
+/**
+ * Return Option object for Datetime formatting
+ *
+ * @param {boolean} withSeconds true or false depending on seconds to be included
+ * @param {boolean} is12h 12 hour format
+ * @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: boolean, is12h = false) => {
+  return {
+    year: "numeric",
+    month: "numeric",
+    day: "numeric",
+    ...getTimeOptions(withSeconds, is12h)
+  };
+};