@pega/dx-component-builder-sdk 0.25.6 → 0.25.7

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25TimeOfDay/index.tsx

@@ -1,199 +0,0 @@
-import { useEffect, useState } from 'react';
-import { TimeInput, FieldValueList, DateTimeDisplay, Text, withConfiguration } from '@pega/cosmos-react-core';
-
-import type { PConnFieldProps } from './PConnProps';
-import './create-nonce';
-
-// includes in bundle
-import { parseClockFormat, timeCorrectedToSeconds, datetimeFireChangeBlurEvents } from './time-of-day';
-import { suggestionsHandler } from './suggestions-handler';
-
-import StyledYourOrgTest25Test25TimeOfDayWrapper 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 YourOrgTest25Test25TimeOfDayProps 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 YourOrgTest25Test25TimeOfDay(props: YourOrgTest25Test25TimeOfDayProps) {
-  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 <StyledYourOrgTest25Test25TimeOfDayWrapper> {displayComp} </StyledYourOrgTest25Test25TimeOfDayWrapper>;
-      }
-      case 'LABELS_LEFT': {
-        return (
-          <StyledYourOrgTest25Test25TimeOfDayWrapper>
-            <FieldValueList
-              variant={hideLabel ? 'stacked' : variant}
-              data-testid={testId}
-              fields={[{ id: '1', name: hideLabel ? '' : label, value: displayComp }]}
-            />
-          </StyledYourOrgTest25Test25TimeOfDayWrapper>
-        );
-      }
-      case 'STACKED_LARGE_VAL': {
-        return (
-          <StyledYourOrgTest25Test25TimeOfDayWrapper>
-            <FieldValueList
-              variant='stacked'
-              data-testid={testId}
-              fields={[
-                {
-                  id: '2',
-                  name: hideLabel ? '' : label,
-                  value: (
-                    <Text variant='h1' as='span'>
-                      {displayComp}
-                    </Text>
-                  )
-                }
-              ]}
-            />
-          </StyledYourOrgTest25Test25TimeOfDayWrapper>
-        );
-      }
-      // no default
-    }
-  }
-
-  return (
-    <StyledYourOrgTest25Test25TimeOfDayWrapper>
-      <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}
-      />
-    </StyledYourOrgTest25Test25TimeOfDayWrapper>
-  );
-}
-
-export default withConfiguration(YourOrgTest25Test25TimeOfDay);

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25TimeOfDay/mock.ts

@@ -1,22 +0,0 @@
-// @ts-nocheck
-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/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25TimeOfDay/styles.ts

@@ -1,8 +0,0 @@
-// 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/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25TimeOfDay/suggestions-handler.ts

@@ -1,9 +0,0 @@
-export const suggestionsHandler = (accepted: boolean, pConn: any, setStatus: any) => {
-  if (accepted) {
-    pConn.acceptSuggestion();
-    setStatus('success');
-  } else {
-    pConn.ignoreSuggestion();
-    setStatus(undefined);
-  }
-};

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25TimeOfDay/time-of-day.ts

@@ -1,280 +0,0 @@
-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)
-  };
-};

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25URL/PConnProps.d.ts

@@ -1,45 +0,0 @@
-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/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25URL/create-nonce.ts

@@ -1,5 +0,0 @@
-// @ts-ignore
-if (window?.__webpack_nonce__) {
-  // @ts-ignore
-  __webpack_nonce__ = window.__webpack_nonce__;
-}

package/tests/assets/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25URL/demo.stories.tsx

@@ -1,71 +0,0 @@
-/* eslint-disable react/jsx-no-useless-fragment */
-import type { Meta, StoryObj } from '@storybook/react';
-
-import YourOrgTest25Test25Url from './index';
-import { stateProps, configProps } from './mock';
-
-const meta: Meta<typeof YourOrgTest25Test25Url> = {
-  title: 'YourOrgTest25Test25Url',
-  component: YourOrgTest25Test25Url,
-  excludeStories: /.*Data$/
-};
-
-export default meta;
-type Story = StoryObj<typeof YourOrgTest25Test25Url>;
-
-export const BaseYourOrgTest25Test25Url: Story = args => {
-  const props = {
-    value: configProps.value,
-    hasSuggestions: configProps.hasSuggestions,
-    getPConnect: () => {
-      return {
-        getStateProps: () => {
-          return stateProps;
-        },
-        getActionsApi: () => {
-          return {
-            updateFieldValue: () => {
-              /* nothing */
-            },
-            triggerFieldChange: () => {
-              /* nothing */
-            }
-          };
-        },
-        ignoreSuggestion: () => {
-          /* nothing */
-        },
-        acceptSuggestion: () => {
-          /* nothing */
-        },
-        setInheritedProps: () => {
-          /* nothing */
-        },
-        resolveConfigProps: () => {
-          /* nothing */
-        }
-      };
-    }
-  };
-
-  return (
-    <>
-      <YourOrgTest25Test25Url {...props} {...args} />
-    </>
-  );
-};
-
-BaseYourOrgTest25Test25Url.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/sdk-r/components/createAll/custom-constellation/field/YourOrg_test25_test25URL/event-utils.ts

@@ -1,18 +0,0 @@
-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;