@globalpayments/vega 2.24.0 → 2.25.0

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

@@ -16,6 +16,9 @@ import { VegaInputSelectLazyLoadController } from './slimmers/controllers/vega-i
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaInputSelectSourceController } from './slimmers/controllers/vega-input-select-source-controller';
 import { VegaInputSelectItemsSlotController } from './slimmers/controllers/vega-input-select-items-slot-controler';
+/**
+ * @version 1.0.7
+ */
 export declare class VegaInputSelect {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly sourceController: VegaInputSelectSourceController;
@@ -40,10 +43,14 @@ export declare class VegaInputSelect {
    *
    * It provides descriptive text that helps identify the purpose or
    *    content expected in the input select field.
+   *
+   * @version 1.3.0
    */
   label: string;
   /**
    * Determines whether the input select field is required.
+   *
+   * @version 1.0.7
    */
   required: boolean;
   /**
@@ -51,15 +58,21 @@ export declare class VegaInputSelect {
    *    select field when multiple items are selected.
    *    The default format for the selected label is
    *    `${number of selected items} Selected`.
+   *
+   * @version 1.35.0
    */
   selectedLabel: SelectedLabelType;
   /**
    * Controls the selection capabilities of the associated dropdown menu.
+   *
+   * @version 1.35.0
    */
   selectType: SelectType;
   /**
    * Specifies the dataset used to populate the options
    *    available in the select input dropdown menu.
+   *
+   * @version 1.0.7
    */
   source: SelectSourceItem[];
   watchSource(): void;
@@ -70,12 +83,16 @@ export declare class VegaInputSelect {
    * The ID should be unique within the source collection to
    *    correctly associate the chosen option with its
    *    corresponding data entry.
+   *
+   * @version 1.0.7
    */
   value: SelectValueType<SelectType>;
   watchValue(newValue: SelectValueType<SelectType>, oldValue: SelectValueType<SelectType>): void;
   /**
    * Indicates the current validation status of the user's selection
    *    from the dropdown menu.
+   *
+   * @version 1.3.0
    */
   isValid: boolean | null;
   /**
@@ -83,21 +100,29 @@ export declare class VegaInputSelect {
    *    validation checks on the user's selection in real-time,
    *    ensuring that the input adheres to predefined criteria before
    *    submission or proceeding further.
+   *
+   * @version 1.0.11
    */
   autoValidation: boolean;
   /**
    * Allows setting custom criteria or constraints that
    *    the user's selection in the dropdown menu must
    *    comply with.
+   *
+   * @version 1.0.11
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
   /**
    * Specifies a prefix icon for visual context or aesthetic enhancement.
+   *
+   * @version 1.3.0
    */
   prefixIcon: string;
   /**
    * Specifies whether the input select field is disabled.
+   *
+   * @version 1.3.0
    */
   disabled: boolean;
   /**
@@ -105,11 +130,15 @@ export declare class VegaInputSelect {
    *    example inside the input select field.
    *
    * It indicates the expected format or pattern of the input.
+   *
+   * @version 1.0.7
    */
   placeholder: string;
   /**
    * Provides a supplementary prompt message that assists users in
    *    understanding the expected value for the input select field.
+   *
+   * @version 1.3.0
    */
   hint: string;
   /**
@@ -117,10 +146,14 @@ export declare class VegaInputSelect {
    *    in the input select element.
    *
    * You can specify custom properties and their corresponding values as needed.
+   *
+   * @version 1.3.0
    */
   vegaDropdownProps: VegaDropdownPropsForSelect;
   /**
    * Defines the size of the input select field.
+   *
+   * @version 1.18.0
    */
   size: ResponsiveType<VegaInputSelectSize>;
   /**
@@ -128,40 +161,54 @@ export declare class VegaInputSelect {
    *
    *  When the dropdown reaches the bottom, this function is triggered and
    *      receives the current end index as a parameter.
+   *
+   * @version 2.3.0
    */
   sourceLazyLoadCallback: VegaInputSelectSourceLazyLoadCallback;
   /**
    * An event emitter notifying the change of the select value.
+   *
+   * @version 1.0.11
    */
   vegaChange: EventEmitter<SelectValueType<SelectType>>;
   /**
    * An event emitter notifying the change of the select value.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter<SelectValueType<SelectType>>;
   /**
    * An event emitter notifying the search of the dropdown.
+   *
+   * @version 1.50.0
    */
   vegaSearch: EventEmitter<string>;
   /**
    * An event emitter notifying the search of the dropdown.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   search: EventEmitter<string>;
   componentWillLoad(): void;
   /**
    * Invoke this method to close the select dropdown and clear
    *    the dropdown element reference.
+   *
+   * @version 1.0.7
    */
   doClose(): Promise<void>;
   /**
    * Invoke this method to open the select dropdown.
+   *
+   * @version 1.0.7
    */
   doOpen(): Promise<void>;
   /**
    * Invoke this method to change the ID of the select source item.
+   *
+   * @version 1.0.7
    */
   doChange(value: SelectValueType<SelectType>): Promise<void>;
   render(): VegaInputSelect;

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

@@ -4,6 +4,9 @@ import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event
 import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { DeprecatedPropertySlimmerBase } from '../../helpers/slimmers/deprecated-property-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.0.5
+ */
 export declare class VegaItemToggle {
   private static defaultStatusMap;
   protected readonly globalSlimmers: GlobalSlimmers;
@@ -15,24 +18,33 @@ export declare class VegaItemToggle {
   /**
    * Defines the labels and icons associated with the toggle states.
    * @deprecated This property will be removed soon and replaced by prop statusMap
+   *
+   * @version 1.3.0
    */
   itemToggleStatusMap: ItemToggleStatusMap;
   /**
    * Defines the labels and icons associated with the toggle states.
+   *
+   * @version 2.2.0
    */
   statusMap: ItemToggleStatusMap;
   /**
    * Determines whether the item is toggled on.
+   *
+   * @version 1.3.0
    */
   isToggled: boolean;
   onToggledPropsChange(): void;
   /**
    * An event emitter notifying an item toggle event.
+   *
+   * @version 1.3.0
    */
   vegaToggleStatus: EventEmitter<boolean>;
   /**
    * An event emitter notifying an item toggle event.
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   toggleStatus: EventEmitter<boolean>;
   componentWillLoad(): void;

package/dist/types/components/vega-loader-wrapper/vega-loader-wrapper.d.ts

@@ -1,5 +1,8 @@
 import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 2.0.0
+ */
 export declare class VegaLoaderWrapper {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaLoaderWrapperElement>;

package/dist/types/components/vega-loading-indicator/vega-loading-indicator.d.ts

@@ -4,6 +4,9 @@ import { VegaLoadingIndicatorSize } from './types';
 import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { PageResizeObserverSlimmer } from '../../helpers/slimmers/page-resize-observer-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.16.0
+ */
 export declare class VegaLoadingIndicator {
   protected readonly globalSlimmers: GlobalSlimmers;
   /**
@@ -16,36 +19,50 @@ export declare class VegaLoadingIndicator {
   currentBreakpoint: BreakpointsTokenType;
   /**
    * Specifies the shape of the loading indicator.
+   *
+   * @version 1.16.0
    */
   shape: 'circle' | 'bar';
   /**
    * Specifies the size of the loading indicator.
    *    It is provided as a ResponsiveType.
+   *
+   * @version 1.16.0
    */
   size: ResponsiveType<VegaLoadingIndicatorSize>;
   /**
    * Specifies the mode of the loading indicator.
    *
    * When the mode is set to `determinate`, there will be no animation.
+   *
+   * @version 1.16.0
    */
   mode: 'indeterminate' | 'determinate';
   /**
    * Specifies the completion percentage when
    *    the mode is set to `determinate`.
+   *
+   * @version 1.16.0
    */
   percent: number;
   /**
    * Provides a descriptive text or message that indicates
    *    the status or progress of the process.
+   *
+   * @version 1.16.0
    */
   label: string;
   /**
    * Provides a supplementary prompt message that assists users in
    *    understanding the ongoing loading process.
+   *
+   * @version 1.16.0
    */
   hint: string;
   /**
    * Indicates the current status or state of the loading process.
+   *
+   * @version 1.16.0
    */
   status: 'default' | 'success' | 'error';
   render(): VegaLoadingIndicator;

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

@@ -10,6 +10,9 @@ import { ComponentGlobalStyleSlimmer } from '../../helpers/slimmers/component-gl
 import { DeprecatedPropertySlimmerBase } from '../../helpers/slimmers/deprecated-property-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaNestedModalController } from './slimmers/controllers/vega-nested-modal-controller';
+/**
+ * @version 1.0.6
+ */
 export declare class VegaModal {
   private static openedModalStack;
   private static readonly backdropColorMap;
@@ -48,6 +51,8 @@ export declare class VegaModal {
    * _Note_:
    *    When changing this value, a page refresh is required
    *    for the changes to take effect.
+   *
+   * @version 1.0.6
    */
   backdrop: VegaModalBackdrop;
   /**
@@ -59,6 +64,8 @@ export declare class VegaModal {
    * It is important to note that there are different maximum widths
    *    for modal windows based on the viewport size. If the specified size exceeds
    *    the maximum width, the maximum modal width will be used instead.
+   *
+   * @version 1.0.6
    */
   size: ResponsiveType<SizeType>;
   /**
@@ -69,47 +76,65 @@ export declare class VegaModal {
   watchSize(): void;
   /**
    * Determines whether the modal is initially open.
+   *
+   * @version 1.0.6
    */
   open: boolean;
   watchOpen(): void;
   /**
    * Specifies whether the modal uses an animated transition
    *    when it appears.
+   *
+   * @version 1.0.11
    */
   animation: boolean;
   /**
    * Represents the title displayed within the modal.
+   *
+   * @version 1.3.0
    */
   modalTitle: string;
   /**
    * Specifies the background color of the modal's backdrop.
+   *
+   * @version 1.3.0
    */
   backdropColor: VegaModalBackdropColor;
   /**
    * Determines whether the modal is vertically centered
    *    on the screen.
    * @deprecated This property will be removed soon and replaced by prop isVerticallyCentered
+   *
+   * @version 1.3.0
    */
   isVerticallyCenter: boolean;
   /**
    * Determines whether the modal is vertically centered
    *    on the screen.
+   *
+   * @version 2.2.0
    */
   isVerticallyCentered: boolean;
   /**
    * Determines whether the modal displays a close button to
    *    allow hiding or closing of the modal.
+   *
+   * @version 1.3.0
    */
   showCloseButton: boolean;
   /**
    * Specifies the amount of space or padding within the modal.
    *
    * It can be set as a ResponsiveType or any size value.
+   *
+   * @version 1.0.10
    */
   padding: ResponsiveType<PaddingType>;
   /**
    * Defines the maximum height of the content within
    *    the modal element.
+   *
+   * @version 1.4.0
    */
   contentMaxHeight: ResponsiveType<number>;
   /**
@@ -119,26 +144,34 @@ export declare class VegaModal {
    * If the callback function returns `true`, the modal will be closed.
    *
    * If the callback function returns `false` or does not return any value, the modal will remain open.
+   *
+   * @version 1.22.0
    */
   handleClose: (() => boolean) | undefined;
   /**
    * An event emitter notifying the modal close event.
+   *
+   * @version 1.0.10
    */
   vegaClose: EventEmitter;
   /**
    * An event emitter notifying the modal close event.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   close: EventEmitter;
   /**
    * An event emitter notifying the modal open event.
+   *
+   * @version 1.0.10
    */
   vegaOpen: EventEmitter;
   /**
    * An event emitter notifying the modal open event. The event name is not `open` because already has a property `open`
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   modalOpen: EventEmitter;
   disconnectedCallback(): void;
@@ -160,6 +193,8 @@ export declare class VegaModal {
   listenDataDismiss(e: MouseEvent): void;
   /**
    * Invoke this method to show or hide the modal.
+   *
+   * @version 1.0.6
    */
   modal(option: 'show' | 'hide'): Promise<void>;
   render(): VegaModal;

package/dist/types/components/vega-nav/vega-left-nav/vega-left-nav.d.ts

@@ -11,6 +11,9 @@ import { EventEmitSlimmerBase } from '../../../helpers/event-manager/slimmers/ev
 import { ComponentGlobalStyleSlimmer } from '../../../helpers/slimmers/component-global-style-slimmer';
 import { VegaLeftNavAutoCollapseController } from './slimmers/controllers/vega-left-nav-auto-collapse-controller';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.31.0
+ */
 export declare class VegaLeftNav {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly headerRenderer: VegaLeftNavHeaderRenderer;
@@ -28,6 +31,8 @@ export declare class VegaLeftNav {
   watchOpenState(): void;
   /**
    * Determines whether the left navigation is expanded or collapsed.
+   *
+   * @version 1.39.2
    */
   open: boolean;
   watchOpen(): void;
@@ -35,16 +40,22 @@ export declare class VegaLeftNav {
    * Specifies the configuration options for the header within the left-nav.
    *
    * You can use this property to define a custom title and subtitle.
+   *
+   * @version 1.31.0
    */
   headerConfig: LeftNavHeaderConfig;
   /**
    * Specifies source data used to generate the links and
    *    groups structure in the left-nav.
+   *
+   * @version 1.31.0
    */
   source: LeftNavSourceItem[];
   /**
    * Provides additional information or context in the form of
    *    a footnote in the left-nav footer.
+   *
+   * @version 1.31.0
    */
   footnote: string;
   /**
@@ -57,23 +68,32 @@ export declare class VegaLeftNav {
    *    property is set to `false` within the `vega-left-nav` component. Additionally, enclose all content
    *    within an element possessing the class `vega-left-nav-content` immediately following the
    *    `vega-left-nav` component.
+   *
+   * @version 1.33.0
    */
   showAsOverlay: boolean;
   watchShowAsOverlay(): void;
-  /** Determines whether the left navigation automatically collapses when the left navigation link is clicked in overlay mode. */
+  /** Determines whether the left navigation automatically collapses when the left navigation link is clicked in overlay mode. *
+   * @version 2.7.0
+   */
   autoCollapseOnOverlay: boolean;
   /**
    * An event emitter notifying that the left-nav's open state has changed.
+   *
+   * @version 1.31.0
    */
   vegaStateUpdate: EventEmitter<string>;
   /**
    * An event emitter notifying that the left-nav's open state has changed.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   stateUpdate: EventEmitter<string>;
   /**
    * Invoke this method to toggle the left-nav's open state.
+   *
+   * @version 1.31.0
    */
   toggle(): Promise<void>;
   render(): VegaLeftNav;

package/dist/types/components/vega-nav/vega-left-nav-group/vega-left-nav-group.d.ts

@@ -4,6 +4,9 @@ import { VegaLeftNavGroupRenderer } from './slimmers/renderers/vega-left-nav-gro
 import { VegaLeftNavGroupController } from './slimmers/controllers/vega-left-nav-group-controller';
 import { EventEmitSlimmerBase } from '../../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.31.0
+ */
 export declare class VegaLeftNavGroup {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly renderer: VegaLeftNavGroupRenderer;
@@ -11,16 +14,23 @@ export declare class VegaLeftNavGroup {
   protected groupClickEventEmitter: EventEmitSlimmerBase;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaLeftNavGroupElement>;
   host: HTMLVegaLeftNavGroupElement;
-  /** icon attached to the left nav group items **/
+  /** icon attached to the left nav group items **
+   * @version 1.31.0
+   */
   icon: string;
-  /** label attached to the left nav group items **/
+  /** label attached to the left nav group items **
+   * @version 1.31.0
+   */
   label: string;
-  /** event emitter used for notifying consumers the click event */
+  /** event emitter used for notifying consumers the click event *
+   * @version 1.41.0
+   */
   vegaGroupClick: EventEmitter<string>;
   /**
    * An event emitter used for notifying consumers the click event
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   groupClick: EventEmitter<string>;
   render(): VegaLeftNavGroup;

package/dist/types/components/vega-nav/vega-left-nav-link/vega-left-nav-link.d.ts

@@ -6,6 +6,9 @@ import { LeftNavCounterBadgeConfig } from '../interface';
 import { EventEmitSlimmerBase } from '../../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { DeprecatedPropertySlimmerBase } from '../../../helpers/slimmers/deprecated-property-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.31.0
+ */
 export declare class VegaLeftNavLink {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly renderer: VegaLeftNavLinkRenderer;
@@ -14,22 +17,34 @@ export declare class VegaLeftNavLink {
   protected readonly deprecatedPropertySlimmer: DeprecatedPropertySlimmerBase<number>;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaLeftNavLinkElement>;
   host: HTMLVegaLeftNavLinkElement;
-  /** icon attached to the left nav link items **/
+  /** icon attached to the left nav link items **
+   * @version 1.31.0
+   */
   icon: string;
-  /** boolean indicating if current link item is selected **/
+  /** boolean indicating if current link item is selected **
+   * @version 1.31.0
+   */
   selected: boolean;
-  /** url attached to the left nav link item **/
+  /** url attached to the left nav link item **
+   *
+   * @version 1.31.0
+   */
   url: string;
   /** config the counter badge for left nav link items
    *
    * @deprecatedAttribute [counter] The 'counter' attribute is deprecated and will be removed soon. Please use 'count' instead.
+   *
+   * @version 1.31.0
    */
   counterBadge: LeftNavCounterBadgeConfig;
-  /** An event emitter notifying the link click event. */
+  /** An event emitter notifying the link click event. *
+   * @version 1.31.0
+   */
   vegaMenuClick: EventEmitter;
   /** An event emitter notifying the link click event.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   menuClick: EventEmitter;
   render(): VegaLeftNavLink;

package/dist/types/components/vega-nav/vega-left-nav-section/vega-left-nav-section.d.ts

@@ -4,22 +4,30 @@ import { VegaLeftNavSectionRenderer } from './slimmers/renderers/vega-left-nav-s
 import { LeftNavSectionHeaderConfig } from '../interface';
 import { EventEmitSlimmerBase } from '../../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.31.0
+ */
 export declare class VegaLeftNavSection {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly renderer: VegaLeftNavSectionRenderer;
   protected actionClickEventEmitter: EventEmitSlimmerBase;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaLeftNavSectionElement>;
   host: HTMLVegaLeftNavSectionElement;
-  /** sectionHeader attached to the left nav section **/
+  /** sectionHeader attached to the left nav section **
+   * @version 1.31.0
+   */
   sectionHeader: LeftNavSectionHeaderConfig;
   /**
    * An event emitter notifying the action click event when the action link is not configured.
+   *
+   * @version 2.11.0
    */
   vegaActionClick: EventEmitter<string>;
   /**
    * An event emitter notifying the action click event when the action link is not configured.
    *
    * @eventSemantics namespace:native
+   * @version 2.11.0
    */
   actionClick: EventEmitter;
   render(): VegaLeftNavSection;

package/dist/types/components/vega-nav/vega-nav-card/vega-nav-card.d.ts

@@ -4,6 +4,9 @@ import { VegaNavListRenderer } from '../slimmers/renderers/vega-nav-list-rendere
 import { MaxHeightType, ResponsiveType } from '../../../types/ui.type';
 import { VegaNavCardMaxHeightController } from './slimmers/controllers/vega-nav-card-max-height-controller';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.42.0
+ */
 export declare class VegaNavCard {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly listRenderer: VegaNavListRenderer;
@@ -14,6 +17,8 @@ export declare class VegaNavCard {
   /**
    * Specifies the source data used to populate the list within
    *    the `vega-nav-card` component.
+   *
+   * @version 1.42.0
    */
   source: LeftNavSourceItem[];
   /**
@@ -26,6 +31,8 @@ export declare class VegaNavCard {
    *    For example, '100vh' sets the height to 100% of the viewport height,
    *    and 'calc(100vh - 20px)' allows for more complex calculations to
    *    determine the height.
+   *
+   * @version 1.44.0
    */
   maxHeight: ResponsiveType<MaxHeightType>;
   watchMaxHeight(): void;

package/dist/types/components/vega-page-notification/vega-page-notification-list/vega-page-notification-list.d.ts

@@ -1,5 +1,8 @@
 import { GlobalSlimmers } from '../../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 2.0.0
+ */
 export declare class VegaPageNotificationList {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaPageNotificationListElement>;