@globalpayments/vega 2.36.0 → 2.37.1

package/dist/types/components/vega-calendar/slimmers/day-view/renderers/vega-calendar-time-marker-renderer.d.ts

@@ -0,0 +1,69 @@
+import { VegaSlimmer } from '../../../../../vega-slimmer/vega-slimmer-core';
+import { VegaCalendarViewModeType } from '../../../types';
+import { CalendarDate } from '../../../../../helpers/calendar';
+import { VegaCalendar } from '../../../vega-calendar';
+/**
+ * Render a red line that representing the current time
+ */
+export declare class VegaCalendarTimeMarkerRenderer extends VegaSlimmer {
+  protected viewMode: VegaCalendar['viewMode'];
+  protected viewRenderer: VegaCalendar['viewRenderer'];
+  private timeMarkerRef;
+  private timeMarkerPositionTimer;
+  /**
+   * takes an array of `CalendarDate` objects as input and returns an HTML element
+   *
+   * @param {CalendarDate[]} source
+   * @returns {HTMLElement} the html element
+   */
+  render(source: CalendarDate[]): HTMLElement;
+  /**
+   * scroll to current time line block if change view mode to week or day
+   *
+   * @param {VegaCalendarViewModeType} viewMode the view mode
+   */
+  protected updateTimeLine(viewMode: VegaCalendarViewModeType): void;
+  /**
+   * remove setInterval when component destroy
+   */
+  protected clearTimer(): void;
+  /**
+   * Add the time mark position update logic if the component add back to page
+   */
+  protected updateTimeLineIfComponentAddBack(): void;
+  /**
+   * Should display the current time block in the view if the default view mode is not month
+   */
+  protected displayCurrentTimeBlockByDefault(): void;
+  /**
+   * The function `getTimeMarkerPosition` calculates the position of the current time marker as a percentage of the day.
+   *
+   * @returns {string} a string representing the current time marker position as a percentage of the day.
+   */
+  private getTimeMarkerPosition;
+  /**
+   * Update the time marker position with the time
+   *
+   * @param {VegaCalendarViewModeType} viewMode view mode value
+   */
+  private syncTimeMarkerPosition;
+  /**
+   * scroll the time line in to current view
+   *
+   * @param {VegaCalendarViewModeType} viewMode view mode value
+   */
+  private scrollToTargetTimeBlock;
+  /**
+   * Get the center position of the display area.
+   * <div class='calendar-view'>
+   *   <div class='calendar-view-title-container'></div>
+   *   <div class='display-view'>
+   *   <div class='empty-space'></div>
+   * 		<div class='time-marker'></div>
+   *   </div>
+   * </div>
+   *
+   * @returns {number}
+   */
+  private getViewCenterPosition;
+}

package/dist/types/components/vega-calendar/slimmers/day-view/renderers/vega-calendar-view-with-time-renderer.d.ts

@@ -4,6 +4,7 @@ import { VegaCalendar } from '../../../vega-calendar';
 export declare class VegaCalendarViewWithTimeRenderer extends VegaSlimmer {
   protected viewMode: VegaCalendar['viewMode'];
   protected timeLineRenderer: VegaCalendar['timeLineRenderer'];
+  protected timeMarkerRenderer: VegaCalendar['timeMarkerRenderer'];
   protected dayViewTimedEventRenderer: VegaCalendar['dayViewTimedEventRenderer'];
   protected dayViewFullDayEventRenderer: VegaCalendar['dayViewFullDayEventRenderer'];
   protected calendarView: VegaCalendar['calendarView'];

package/dist/types/components/vega-calendar/types.d.ts

@@ -35,6 +35,9 @@ export interface VegaCalendarRawEvent {
 	startTime?: string;
 	endTime?: string;
 	isAllDay?: boolean;
+	/**
+	 * This color also supports {@link BackgroundColorsTokenType} expect string
+	 */
 	color?: string | BackgroundColorsTokenType;
 	disabled?: boolean;
 	repeatOptions?: VegaCalendarEventRepeatOptions;

package/dist/types/components/vega-calendar/vega-calendar.d.ts

@@ -26,6 +26,7 @@ import { TimeFormat } from '../../types/general';
 import { SubStateNotifySlimmerBase } from '../../helpers/slimmers/sub-state/sub-state-notify-slimmer-base';
 import { VegaCalendarFullDayEventMoreButtonRenderer } from './slimmers/day-view/renderers/full-day-event/vega-calendar-full-day-event-more-button-renderer';
 import { TranslationSlimmer } from '../../helpers/slimmers/translation';
+import { VegaCalendarTimeMarkerRenderer } from './slimmers/day-view/renderers/vega-calendar-time-marker-renderer';
 /**
  * @vegaVersion 2.14.0
  */
@@ -39,6 +40,7 @@ export declare class VegaCalendar {
   protected monthViewRenderer: VegaCalendarMonthViewRenderer;
   protected viewWithTimeRenderer: VegaCalendarViewWithTimeRenderer;
   protected timeLineRenderer: VegaCalendarTimeLineRenderer;
+  protected timeMarkerRenderer: VegaCalendarTimeMarkerRenderer;
   protected monthEventRenderer: VegaCalendarMonthEventRenderer;
   protected currentPeriodController: VegaCalendarCurrentPeriodController;
   protected calendarViewController: VegaCalendarViewController;

package/dist/types/components/vega-checkbox/vega-checkbox.d.ts

@@ -4,6 +4,7 @@ import { FormFieldControllerSlimmer } from '../../helpers/slimmers/form-field-co
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { VegaCheckboxShowErrorController } from './slimmers/controllers/vega-checkbox-show-error-controller';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 /**
  * @vegaVersion 1.0.7
  */
@@ -12,6 +13,7 @@ export declare class VegaCheckbox {
   protected vegaCheckboxShowErrorController: VegaCheckboxShowErrorController;
   protected readonly formFieldController: FormFieldControllerSlimmer<boolean | string>;
   protected changeEventEmitter: EventEmitSlimmerBase;
+  protected dropdownEventPrevent: ChildNodesEventPreventSlimmer;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaCheckboxElement>;
   private labelElement;
   private inputContainerRef;

package/dist/types/components/vega-combo-box/types.d.ts

@@ -1,8 +1,6 @@
-import { VegaComponentInterface } from '../../types/ui.type';
-
 export type VegaDropdownPropsForComboBox = Partial<
 	Pick<
-		VegaComponentInterface<HTMLVegaDropdownElement>,
+		HTMLVegaDropdownElement,
 		'positionRelativeTo' | 'maxHeight' | 'matchContainerHeight' | 'dynamicOption' | 'isLoading'
 	>
 >;

package/dist/types/components/vega-dialog/types.d.ts

@@ -1,10 +1,5 @@
-import { VegaComponentInterface } from '../../types/ui.type';
-
 export type VegaDialogActionButtonProps = Partial<
-	Pick<
-		VegaComponentInterface<HTMLVegaButtonElement>,
-		'variant' | 'size' | 'icon' | 'iconAlign' | 'label' | 'disabled'
-	>
+	Pick<HTMLVegaButtonElement, 'variant' | 'size' | 'icon' | 'iconAlign' | 'label' | 'disabled'>
 >;
 
 /**

package/dist/types/components/vega-dropdown/slimmers/controllers/vega-dropdown-scrollable-controller.d.ts

@@ -18,6 +18,10 @@ export declare class VegaDropdownScrollableController extends VegaSlimmer {
    * if the dropdown is shown in a certain render mode.
    */
   watchIsDropdownShow(): Promise<void>;
+  /**
+   * Listen scrolling of dropdown content
+   */
+  onScroll: () => void;
   /**
    * The function scrollToSelected asynchronously scrolls to a selected index based on the render mode.
    */

package/dist/types/components/vega-dropdown/slimmers/renderers/vega-dropdown-list-renderer.d.ts

@@ -11,6 +11,7 @@ export declare class VegaDropdownListRenderer extends VegaSlimmer {
   isLazyLoading: VegaDropdown['isLazyLoading'];
   isDropdownShow: VegaDropdown['isDropdownShow'];
   renderModeController: VegaDropdown['renderModeController'];
+  scrollableController: VegaDropdown['scrollableController'];
   translationSlimmer: VegaDropdown['translationSlimmer'];
   private virtualScrollRef;
   private templateContainerRef;

package/dist/types/components/vega-flex/vega-flex.d.ts

@@ -74,6 +74,7 @@ export declare class VegaFlex {
    * Specifies how the box adjusts its size, growth, and alignment within a flex container.
    *
    * @vegaVersion 2.26.0
+   * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/flex
    */
   flex: ResponsiveType<FlexType>;
   /**
@@ -81,18 +82,21 @@ export declare class VegaFlex {
    *    width or height in a flex container.
    *
    * @vegaVersion 2.26.0
+   * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/flex-basis
    */
   flexBasis: ResponsiveType<FlexBasisType>;
   /**
    * Specifies how the box grows to fill available space in a flex container.
    *
    * @vegaVersion 2.26.0
+   * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/flex-grow
    */
   flexGrow: ResponsiveType<FlexGrowType>;
   /**
    * Specifies how much the box shrinks to fit within a flex container.
    *
    * @vegaVersion 2.26.0
+   * @nativeTypeRedirection https://developer.mozilla.org/en-US/docs/Web/CSS/flex-shrink
    */
   flexShrink: ResponsiveType<FlexShrinkType>;
   /**

package/dist/types/components/vega-image-uploader/vega-image-uploader.d.ts

@@ -57,6 +57,7 @@ export declare class VegaImageUploader {
    * Specifies the allowed file types for upload.
    *
    * @vegaVersion 1.14.0
+   * @defaultValue .jpg,.png,.jpeg
    */
   accept: string;
   /**

package/dist/types/components/vega-input/vega-input.d.ts

@@ -230,7 +230,7 @@ export declare class VegaInput {
    * For the ComponentLoadRequired, the test can not be added in e2e at now, we will add it while have better solution,
    * releated issue: https://gitlab.com/heartland1/vega/tiger/-/issues/646
    */
-  watchMaskChange(): void;
+  watchMaskChange(newValue: MaskConfigType | MaskConfigType[], oldValue: MaskConfigType | MaskConfigType[]): void;
   /**
    * Controls whether copying or pasting is enabled for the input.
    *

package/dist/types/components/vega-input-phone-number/vega-input-phone-number.d.ts

@@ -59,6 +59,7 @@ export declare class VegaInputPhoneNumber {
    * Specifies the default country calling code using the two-letter uppercase country code.
    *
    * @vegaVersion 2.18.0
+   * @defaultValue US
    */
   countryCode: VegaCountryCode;
   watchCountryCode(newCountryCode: VegaCountryCode, oldCountryCode: VegaCountryCode): void;
@@ -68,6 +69,7 @@ export declare class VegaInputPhoneNumber {
    * Note: By default, 245 codes are provided, but loading all of them may take time. To improve performance, it is recommended to include only the necessary codes.
    *
    * @vegaVersion 2.18.0
+   * @defaultValue ['US', 'CN', ...]{@link VegaCountryCode}
    */
   allowedCountryCodes: VegaCountryCode[];
   /**
@@ -84,6 +86,7 @@ export declare class VegaInputPhoneNumber {
    *
    * @VegaWarning Note: The input phone number field will always have a value. If no phone number is entered, the default format is `+{default_country_code}`. For example, if the default country code is US, the default value will be `+1`.
    * @vegaVersion 2.18.0
+   * @defaultValue +1
    */
   value: string;
   watchValue(newValue: string, oldValue: string): void;

package/dist/types/components/vega-input-select/types.d.ts

@@ -1,5 +1,3 @@
-import { VegaComponentInterface } from '../../types/ui.type';
-
 export type SelectSourceItem = {
 	id: string;
 	displayName: string;
@@ -9,7 +7,7 @@ export type SelectedLabelType = (value: string[]) => string;
 
 export type VegaDropdownPropsForSelect = Partial<
 	Pick<
-		VegaComponentInterface<HTMLVegaDropdownElement>,
+		HTMLVegaDropdownElement,
 		| 'positionRelativeTo'
 		| 'maxHeight'
 		| 'matchContainerHeight'
@@ -20,6 +18,7 @@ export type VegaDropdownPropsForSelect = Partial<
 		| 'size'
 		| 'searchTriggerBy'
 		| 'isScreenPosition'
+		| 'itemDisplayRule'
 	>
 >;
 

package/dist/types/components/vega-input-select/vega-input-select.d.ts

@@ -148,7 +148,7 @@ export declare class VegaInputSelect {
    */
   hint: string;
   /**
-   * Provides partial properties for the dropdown component used
+   * Provides partial properties for the `vega-dropdown` component used
    *    in the input select element.
    *
    * You can specify custom properties and their corresponding values as needed.

package/dist/types/components/vega-item-toggle/vega-item-toggle.d.ts

@@ -20,12 +20,14 @@ export declare class VegaItemToggle {
    * @deprecated This property will be removed soon and replaced by prop statusMap
    *
    * @vegaVersion 1.3.0
+   * @defaultValue {unToggledIcon: 'plus-sign', toggledIcon: 'delete-bin', unToggledLabel: 'Add', togglingLabel: 'Added', toggledLabel: 'Remove', unTogglingLabel: 'Removed'}
    */
   itemToggleStatusMap: ItemToggleStatusMap;
   /**
    * Defines the labels and icons associated with the toggle states.
    *
    * @vegaVersion 2.2.0
+   * @defaultValue {unToggledIcon: 'plus-sign', toggledIcon: 'delete-bin', unToggledLabel: 'Add', togglingLabel: 'Added', toggledLabel: 'Remove', unTogglingLabel: 'Removed'}
    */
   statusMap: ItemToggleStatusMap;
   /**

package/dist/types/components/vega-modal/slimmers/controllers/vega-modal-backdrop-controller.d.ts

@@ -0,0 +1,26 @@
+import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
+import { VegaModal } from '../../vega-modal';
+/**
+ * Modal backdrop controller
+ */
+export declare class VegaModalBackdropController extends VegaSlimmer {
+  private static readonly backdropColorMap;
+  host: VegaModal['host'];
+  backdrop: VegaModal['backdrop'];
+  backdropColor: VegaModal['backdropColor'];
+  private backdropRef;
+  /**
+   * Get the backdropRef element or null.
+   *
+   * @returns {HTMLElement | null} - The backdropRef.
+   */
+  getBackdropRef(): HTMLElement | null;
+  /**
+   * Set backdrop of modal.
+   */
+  setBackdrop(): void;
+  /**
+   * Removes the backdrop element if it exists.
+   */
+  removeBackdrop(): void;
+}

package/dist/types/components/vega-modal/slimmers/controllers/vega-modal-layout-controller.d.ts

@@ -0,0 +1,38 @@
+import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
+import { VegaModal } from '../../vega-modal';
+import { PageResizeObserverSlimmer } from '../../../../helpers/slimmers/page-resize-observer-slimmer';
+/**
+ * Modal layout controller
+ */
+export declare class VegaModalLayoutController extends VegaSlimmer {
+  host: VegaModal['host'];
+  contentMaxHeight: VegaModal['contentMaxHeight'];
+  size: VegaModal['size'];
+  renderer: VegaModal['renderer'];
+  protected readonly pageResizeObserverSlimmer: PageResizeObserverSlimmer;
+  private isModalWidthSet;
+  /**
+   * Component lifecycle - [connectedCallback]
+   */
+  componentDidLoad(): void;
+  /**
+   * Listen watch size method to be called
+   */
+  watchSize(): void;
+  /**
+   * Set width of modal.
+   *
+   * @param {'initialize' | 'update'} flag - Is trigger by
+   */
+  setModalWidth(flag?: 'initialize' | 'update'): void;
+  /**
+   * Set max height of modal content.
+   */
+  private setContentMaxHeight;
+  /**
+   * Get size of modal.
+   *
+   * @returns {number | string} - Modal size.
+   */
+  private getModalSize;
+}

package/dist/types/components/vega-modal/slimmers/controllers/vega-modal-mobile-controller.d.ts

@@ -0,0 +1,27 @@
+import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
+import { VegaModal } from '../../vega-modal';
+/**
+ * Modal mobile controller
+ */
+export declare class VegaModalMobileController extends VegaSlimmer {
+  host: VegaModal['host'];
+  backdrop: VegaModal['backdrop'];
+  private touchStartY;
+  /**
+   * Component lifecycle - [connectedCallback]
+   */
+  componentDidLoad(): void;
+  /**
+   * There are two situations in modal scrolling:
+   * 1. Scrolls the non-modal content part in vega-modal (e.g. backdrop, modal dialog).
+   * 2. Scrolls the modal content (if scrollable) in vega-modal.
+   * On the mobile side, we need to prevent scrolling in the area outside the modal content.
+   *
+   * TODO: If the modal content is too long, a scroll bar will appear and the body cannot be scrolled,
+   * but on the IOS side, the body content of the scrolling modal will occasionally appear scrolling.
+   * This problem is reproduced on the following websites, and there is no solution yet.
+   * https://v5.bootcss.com/docs/components/modal/
+   * https://mui.com/material-ui/react-dialog/
+   */
+  private disableBackdropTouchMove;
+}

package/dist/types/components/vega-modal/slimmers/controllers/vega-modal-open-state-controller.d.ts

@@ -0,0 +1,65 @@
+import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
+import { VegaModal } from '../../vega-modal';
+/**
+ * Modal open state controller
+ */
+export declare class VegaModalOpenStateController extends VegaSlimmer {
+  host: VegaModal['host'];
+  open: VegaModal['open'];
+  backdrop: VegaModal['backdrop'];
+  handleClose: VegaModal['handleClose'];
+  closeEventEmitter: VegaModal['closeEventEmitter'];
+  openEventEmitter: VegaModal['openEventEmitter'];
+  layoutController: VegaModal['layoutController'];
+  backdropController: VegaModal['backdropController'];
+  openedModalStackController: VegaModal['openedModalStackController'];
+  zIndexController: VegaModal['zIndexController'];
+  /**
+   * Component lifecycle - [componentDidLoad]
+   */
+  componentDidLoad(): void;
+  /**
+   * Toggle modal while open property changed.
+   */
+  watchOpen(): void;
+  /**
+   * Listen the target element clicked has a `data-target='modal'` attribute and open the modal if it does.
+   *
+   * @param {MouseEvent} e - Open modal event.
+   */
+  listenDataTarget(e: MouseEvent): void;
+  /**
+   * Listen the target element clicked has a `data-dismiss='modal'` attribute and closes the modal if it does.
+   *
+   * @param {MouseEvent} e - Close modal event.
+   */
+  listenDataDismiss(e: MouseEvent): void;
+  /**
+   * Listen modal close event and close modal.
+   *
+   * @param {MouseEvent} e - Close modal event.
+   */
+  onModalClose: (e: MouseEvent) => void;
+  /**
+   * Manages the visibility and behavior of a modal by updating various properties
+   * and emitting an event.
+   */
+  private toggle;
+  /**
+   * Toggles the display property of a modal element between 'flex' and
+   * 'none' based on the value of the `open` property.
+   */
+  private setModalVisibility;
+  /**
+   * Emits either an open or close event based on the value of the `open` property.
+   */
+  private emitEvent;
+  /**
+   * In desktop, we should add 'overflow: hidden' to the body to prevent the body scroll.
+   */
+  private updateDocumentRootOverflow;
+  /**
+   * Removes the backdrop element if no modals are currently visible.
+   */
+  private removeBackdropWhileNoModalShow;
+}

package/dist/types/components/vega-modal/slimmers/controllers/vega-modal-opened-modal-stack-controller.d.ts

@@ -0,0 +1,30 @@
+import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
+import { VegaModal } from '../../vega-modal';
+import { Nullable } from '../../../../types/general';
+/**
+ * Opened modal stack controller
+ */
+export declare class VegaModalOpenedModalStackController extends VegaSlimmer {
+  private static openedModalStack;
+  host: VegaModal['host'];
+  /**
+   * Adds the current host element to an array in a modal toggle controller.
+   */
+  push(): void;
+  /**
+   * Removes the current modal from the opened modal stack.
+   */
+  remove(): void;
+  /**
+   * Get visible modal length.
+   *
+   * @returns {number} - Visible modal length.
+   */
+  length(): number;
+  /**
+   * Returns the previous HTMLVegaModalElement from the openedModalStack if it exists.
+   *
+   * @returns {Nullable<HTMLElement>} - The previous HTMLVegaModalElement.
+   */
+  peek(): Nullable<HTMLVegaModalElement>;
+}

package/dist/types/components/vega-modal/slimmers/controllers/vega-modal-scroll-controller.d.ts

@@ -0,0 +1,28 @@
+import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
+import { VegaModal } from '../../vega-modal';
+/**
+ * Modal scroll controller
+ */
+export declare class VegaModalScrollController extends VegaSlimmer {
+  host: VegaModal['host'];
+  contentMaxHeight: VegaModal['contentMaxHeight'];
+  renderer: VegaModal['renderer'];
+  /**
+   * Component lifecycle - [connectedCallback]
+   */
+  componentDidLoad(): void;
+  /**
+   * Is modal content scrollable.
+   *
+   * @returns {boolean} - Is scrollable.
+   */
+  private isContentScrollable;
+  /**
+   * Listen content scroll
+   */
+  private listenContentScroll;
+  /**
+   * Notifies the `ChangeManager` about scrolling in a specific element within a shadow root.
+   */
+  private notifyContentScrolling;
+}

package/dist/types/components/vega-modal/slimmers/controllers/vega-modal-z-index-controller.d.ts

@@ -0,0 +1,15 @@
+import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
+import { VegaModal } from '../../vega-modal';
+/**
+ * Modal z-index controller
+ */
+export declare class VegaModalZIndexController extends VegaSlimmer {
+  host: VegaModal['host'];
+  open: VegaModal['open'];
+  backdropController: VegaModal['backdropController'];
+  openedModalStackController: VegaModal['openedModalStackController'];
+  /**
+   * Manages the z-index of modal elements based on their visibility status.
+   */
+  setModalZIndex(): void;
+}

package/dist/types/components/vega-modal/slimmers/renderers/vega-modal-renderer.d.ts

@@ -0,0 +1,33 @@
+import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
+import { VegaModal } from '../../vega-modal';
+/**
+ * Modal renderer
+ */
+export declare class VegaModalRenderer extends VegaSlimmer {
+  host: VegaModal['host'];
+  animation: VegaModal['animation'];
+  open: VegaModal['open'];
+  padding: VegaModal['padding'];
+  showCloseButton: VegaModal['showCloseButton'];
+  modalTitle: VegaModal['modalTitle'];
+  contentMaxHeight: VegaModal['contentMaxHeight'];
+  handleClose: VegaModal['handleClose'];
+  deprecatedPropertySlimmer: VegaModal['deprecatedPropertySlimmer'];
+  openStateController: VegaModal['openStateController'];
+  private modalContent;
+  private modalFooter;
+  private modalContainer;
+  getModalContentRef(): HTMLElement | null;
+  getModalFooterRef(): HTMLElement | null;
+  getModalContainerRef(): HTMLElement | null;
+  render(): VegaModal;
+  private renderContainer;
+  private renderHeader;
+  private renderContent;
+  private renderFooter;
+  private renderTitle;
+  private renderCloseBtn;
+  private hasModalFooter;
+  private isContentScrollable;
+  private hasModalTitle;
+}