@globalpayments/vega 2.24.0 → 2.24.2

package/dist/types/components/vega-button-group/vega-button-group.d.ts

@@ -6,6 +6,9 @@ import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { VegaButtonGroupClickController } from './slimmers/controllers/vega-button-group-click-controller';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 2.5.0
+ */
 export declare class VegaButtonGroup {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected clickEventEmitter: EventEmitSlimmerBase;
@@ -21,27 +24,36 @@ export declare class VegaButtonGroup {
    * Specifies the visual style and prominence of the button group.
    *
    * It determines how the button group will be presented to the user.
+   *
+   * @version 2.5.0
    */
   variant: VegaButtonGroupVariant;
   watchVariant(): void;
   /**
    * Specifies the size of the button group.
+   *
+   * @version 2.5.0
    */
   size: VegaButtonGroupSize;
   watchSize(): void;
   /**
    * Specifies the placement of the icon in relation to the button's label.
+   *
+   * @version 2.5.0
    */
   iconAlign: VegaButtonGroupIconAlign;
   watchIconAlign(): void;
   /**
    * An event emitter notifying the click event of the button group.
+   *
+   * @version 2.5.0
    */
   vegaClick: EventEmitter<string>;
   /**
    * An event emitter notifying the click event of the button.
    *
    * @eventSemantics namespace:native
+   * @version 2.5.0
    */
   click: EventEmitter<string>;
   render(): VegaButtonGroup;

package/dist/types/components/vega-button-link/vega-button-link.d.ts

@@ -3,6 +3,9 @@ import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.0.2
+ */
 export declare class VegaButtonLink {
   private static readonly defaultLink;
   protected readonly globalSlimmers: GlobalSlimmers;
@@ -12,16 +15,22 @@ export declare class VegaButtonLink {
   host: HTMLVegaButtonLinkElement;
   /**
    * Specifies the URL associated with the button link.
+   *
+   * @version 1.0.4
    */
   link: string;
   /**
    * Specifies the size of the button link.
+   *
+   * @version 1.0.2
    */
   size: 'default' | 'large' | 'small';
   /**
    * Specifies the icon to be displayed on the button link,
    *    which can be selected from a list of predefined icon tokens
    *    or specified using a Font Awesome class.
+   *
+   * @version 1.0.4
    */
   icon: string;
   /**
@@ -35,24 +44,34 @@ export declare class VegaButtonLink {
    *      The icon is rendered with a circular background,
    *      providing additional emphasis and visual prominence
    *      to the icon in the button link.
+   *
+   * @version 1.0.5
    */
   iconType: 'icon' | 'button';
   /**
    * Specifies the placement of the icon in relation to
    *    the button link's label.
+   *
+   * @version 1.3.0
    */
   iconAlign: 'left' | 'right';
   /**
    * Specifies the text displayed on the button link.
+   *
+   * @version 1.0.4
    */
   label: string;
   /**
    * Specifies whether the button link element is disabled.
+   *
+   * @version 1.3.0
    */
   disabled: boolean;
   /**
    * Indicates the danger status of the button link,
    *    typically used for destructive actions.
+   *
+   * @version 1.3.0
    */
   danger: boolean;
   /**
@@ -64,16 +83,21 @@ export declare class VegaButtonLink {
    *    and no events will be emitted.
    *
    * @deprecated Setting the `link` property internally manages the eventful state of a Button Link.
+   *
+   * @version 1.3.0
    */
   eventful: boolean;
   /**
    * An event emitter notifying the click event of the button.
+   *
+   * @version 1.0.11
    */
   vegaClick: EventEmitter;
   /**
    * An event emitter notifying the click event of the button.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   click: EventEmitter;
   componentWillLoad(): void;

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

@@ -8,6 +8,9 @@ import { VegaCalendarEventSubStateController } from './slimmers/controllers/vega
 import { VegaCalendarTitleMaxHeightController } from './slimmers/controllers/vega-calendar-event-title-max-height-controller';
 import { PageResizeObserverSlimmer } from '../../../helpers/slimmers/page-resize-observer-slimmer';
 import { VegaCalendarEventSlotController } from './slimmers/controllers/vega-calendar-event-slot-controller';
+/**
+ * @version 2.14.0
+ */
 export declare class VegaCalendarEvent {
   protected readonly globalSlimmer: GlobalSlimmers;
   protected readonly pageResizeObserverSlimmer: PageResizeObserverSlimmer;
@@ -23,6 +26,8 @@ export declare class VegaCalendarEvent {
   showColorBar: boolean;
   /**
    * Specifies the calendar event.
+   *
+   * @version 2.14.0
    */
   calendarEvent: CalendarEvent;
   render(): VegaCalendarEvent;

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

@@ -1,11 +1,16 @@
 import { GlobalSlimmers } from '../../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 2.19.0
+ */
 export declare class VegaCalendarEventSlot {
   protected readonly globalSlimmer: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaCalendarEventSlotElement>;
   host: HTMLVegaCalendarEventSlotElement;
   /**
    * Specifies the event key.
+   *
+   * @version 2.19.0
    */
   eventKey: string;
   render(): VegaCalendarEventSlot;

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

@@ -25,6 +25,9 @@ import { VegaCalendarFullDayEventLayoutRenderer } from './slimmers/common/render
 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';
+/**
+ * @version 2.14.0
+ */
 export declare class VegaCalendar {
   protected readonly globalSlimmer: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaCalendarElement>;
@@ -66,6 +69,8 @@ export declare class VegaCalendar {
   calendarEvents: CalendarEvent[];
   /**
    * Specifies the current view mode of the calendar.
+   *
+   * @version 2.14.0
    */
   viewMode: VegaCalendarViewModeType;
   /**
@@ -76,6 +81,8 @@ export declare class VegaCalendar {
   watchViewModeChange(newValue: VegaCalendarViewModeType): void;
   /**
    * Specifies the events of the calendar.
+   *
+   * @version 2.14.0
    */
   events: VegaCalendarRawEvent[];
   /**
@@ -86,6 +93,8 @@ export declare class VegaCalendar {
   watchEventsChange(newValue: VegaCalendarRawEvent[]): void;
   /**
    * Specifies the time format of the calendar.
+   *
+   * @version 2.14.0
    */
   timeFormat: TimeFormat;
   /**
@@ -96,10 +105,14 @@ export declare class VegaCalendar {
   watchTimeFormat(newValue: TimeFormat): void;
   /**
    * Defines the configuration options for the more action button's dropdown menu.
+   *
+   * @version 2.20.0
    */
   moreActionDropdownProps: DropdownPropsForCalendar;
   /**
    * Controls the visibility of the calendar's event color bar.
+   *
+   * @version 2.21.0
    */
   showEventColorBar: boolean;
   /**
@@ -110,42 +123,54 @@ export declare class VegaCalendar {
   watchShowEventColorBar(newValue: boolean): void;
   /**
    * An event emitter notifying the component view content change after a switch panel click.
+   *
+   * @version 2.14.0
    */
   vegaChange: EventEmitter<VegaCalendarChangeEventType>;
   /**
    * An event emitter notifying the component view content change after a switch panel click.
    *
    * @eventSemantics namespace:native
+   * @version 2.14.0
    */
   change: EventEmitter<VegaCalendarChangeEventType>;
   /**
    * An event emitter notifying that a component event item is clicked.
+   *
+   * @version 2.14.0
    */
   vegaEventClick: EventEmitter<VegaCalendarEventClickInfo>;
   /**
    * An event emitter notifying that a component event item is clicked.
    *
    * @eventSemantics namespace:native
+   * @version 2.14.0
    */
   eventClick: EventEmitter<VegaCalendarEventClickInfo>;
   /**
    * An event emitter notifying that a calendar date item has been double-clicked.
+   *
+   * @version 2.17.0
    */
   vegaDateDblClick: EventEmitter<VegaCalendarDateClickInfo>;
   /**
    * An event emitter notifying that a calendar date item has been double-clicked.
    *
    * @eventSemantics namespace:native
+   * @version 2.17.0
    */
   dateDblClick: EventEmitter<VegaCalendarDateClickInfo>;
   /**
    * An event emitter notifying that a calendar more action menu item has been clicked.
+   *
+   * @version 2.20.0
    */
   vegaMoreActionClick: EventEmitter<string>;
   /**
    * An event emitter notifying that a calendar more action menu item has been clicked.
    *
    * @eventSemantics namespace:native
+   * @version 2.20.0
    */
   moreActionClick: EventEmitter<string>;
   render(): VegaCalendar;

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

@@ -2,6 +2,9 @@ import { BackgroundColorsTokenType } from '../../types/design-token.type';
 import { PaddingType, ResponsiveType, MarginType } from '../../types/ui.type';
 import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.0.4
+ */
 export declare class VegaCard {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaCardElement>;
@@ -9,22 +12,30 @@ export declare class VegaCard {
   /**
    * Specifies the padding within the card.
    *    It can be set as ResponsiveType or any sizing token.
+   *
+   * @version 1.0.4
    */
   padding: ResponsiveType<PaddingType>;
   /**
    * Specifies the margin for the card.
    *    It can be set as ResponsiveType or any sizing token.
+   *
+   * @version 1.3.0
    */
   margin: ResponsiveType<MarginType>;
   /**
    * Determines whether the card is rendered with a shadow or a border.
    *    By default, cards are rendered without a shadow or border.
+   *
+   * @version 1.26.0
    */
   variant: 'shadow' | 'border';
   /**
    * Defines the background color of the card element.
    *    It accepts a string value representing a valid
    *    background color token.
+   *
+   * @version 1.3.0
    */
   backgroundColor: BackgroundColorsTokenType;
   componentWillLoad(): void;

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

@@ -6,6 +6,9 @@ import { PageResizeObserverSlimmer } from '../../helpers/slimmers/page-resize-ob
 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.0.2
+ */
 export declare class VegaCarousel {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaCarouselElement>;
@@ -29,34 +32,46 @@ export declare class VegaCarousel {
   /**
    * Specifies the number of elements displayed per page in the carousel.
    * @deprecated This property will be removed soon and replaced by prop itemsPerPage
+   *
+   * @version 1.0.2
    */
   perPage: ResponsiveType<number>;
   watchPerPage(): void;
   /**
    * Specifies the number of items displayed per page in the carousel.
+   *
+   * @version 2.1.0
    */
   itemsPerPage: ResponsiveType<number>;
   watchItemsPerPage(): void;
   /**
    * Specifies whether to show the navigational buttons
    *    at the bottom of the carousel.
+   *
+   * @version 1.0.2
    */
   showSlider: boolean;
   /**
    * Controls the amount of space between the elements in the carousel
    *    when more than one element is displayed on each page
    *    using the `itemsPerPage` property.
+   *
+   * @version 1.0.2
    */
   spacing: SpacingTokenType;
   onSpacingPropsChange(): void;
   /**
    * Indicates whether the carousel can be swiped
    *    to navigate between pages on a mobile device.
+   *
+   * @version 1.18.0
    */
   canSwipe: boolean;
   /**
    * An event emitter notifying the transition of the carousel to another page,
    *    whether triggered programmatically or through user interaction.
+   *
+   * @version 1.3.0
    */
   vegaPageUpdate: EventEmitter<number>;
   /**
@@ -64,6 +79,7 @@ export declare class VegaCarousel {
    *    whether triggered programmatically or through user interaction.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   pageUpdate: EventEmitter<number>;
   disconnectedCallback(): Promise<void>;
@@ -71,11 +87,15 @@ export declare class VegaCarousel {
   /**
    * Invoke this method to transition the carousel to the next available page,
    *    if it exists.
+   *
+   * @version 1.0.2
    */
   nextPage(): Promise<void>;
   /**
    * Invoke this method to transition the carousel to the previous page,
    *    if it exists.
+   *
+   * @version 1.0.2
    */
   prevPage(): Promise<void>;
   /**
@@ -83,6 +103,7 @@ export declare class VegaCarousel {
    *
    * @param nextPage
    * @returns {Promise<void>}
+   * @version 1.0.6
    */
   goToPage(nextPage: number): Promise<void>;
   render(): VegaCarousel;

package/dist/types/components/vega-chart/vega-bar-chart/vega-bar-chart.d.ts

@@ -1,6 +1,9 @@
 import { VegaBarChartOptionsType } from './types';
 import { GlobalSlimmers } from '../../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.33.0
+ */
 export declare class VegaBarChart {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaBarChartElement>;
@@ -8,6 +11,8 @@ export declare class VegaBarChart {
   host: HTMLVegaBarChartElement;
   /**
    * Specifies the rendering options for the bar chart.
+   *
+   * @version 1.33.0
    */
   options: VegaBarChartOptionsType;
   watchOptions(options: VegaBarChartOptionsType): void;

package/dist/types/components/vega-chart/vega-line-chart/vega-line-chart.d.ts

@@ -1,6 +1,9 @@
 import { LineChartOptionsType } from '../../../helpers/chart/line-chart';
 import { GlobalSlimmers } from '../../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.32.0
+ */
 export declare class VegaLineChart {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaLineChartElement>;
@@ -9,6 +12,8 @@ export declare class VegaLineChart {
   host: HTMLVegaLineChartElement;
   /**
    * Specifies the rendering options for the line chart.
+   *
+   * @version 1.32.0
    */
   options: LineChartOptionsType;
   watchOptionsHandel(options: LineChartOptionsType): void;
@@ -19,6 +24,8 @@ export declare class VegaLineChart {
    *    If the chart is displayed incorrectly within a modal or tab,
    *    ensure that this method is invoked after the chart is shown
    *    to ensure proper rendering.
+   *
+   * @version 1.32.0
    */
   reRender(): Promise<void>;
   render(): VegaLineChart;

package/dist/types/components/vega-chart/vega-pie-chart/vega-pie-chart.d.ts

@@ -1,6 +1,9 @@
 import { PieChartOptions } from '../../../helpers/chart/pie-chart';
 import { GlobalSlimmers } from '../../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.35.0
+ */
 export declare class VegaPieChart {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaPieChartElement>;
@@ -9,6 +12,8 @@ export declare class VegaPieChart {
   host: HTMLVegaPieChartElement;
   /**
    * Specifies the rendering options for the pie chart.
+   *
+   * @version 1.35.0
    */
   options: PieChartOptions;
   watchOptionsHandel(options: PieChartOptions): void;
@@ -19,6 +24,8 @@ export declare class VegaPieChart {
    *    If the chart is displayed incorrectly within a modal or tab,
    *    ensure that this method is invoked after the chart is shown
    *    to ensure proper rendering.
+   *
+   * @version 1.35.0
    */
   reRender(): Promise<void>;
   render(): VegaPieChart;

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

@@ -7,6 +7,9 @@ import { EventEmitSlimmerBase } from '../../../helpers/event-manager/slimmers/ev
 import { FormFieldValidationRule } from '../../../helpers/validator/rules/form-field-validation-rule';
 import { VegaFlexProps } from '../../../types/ui.type';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.0.7
+ */
 export declare class VegaCheckboxGroup {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly formFieldController: FormFieldControllerSlimmer<string[]>;
@@ -22,22 +25,30 @@ export declare class VegaCheckboxGroup {
    * Specifies the label or title for the checkbox group.
    *    It provides descriptive text that helps identify
    *    the purpose of the checkbox group.
+   *
+   * @version 1.3.0
    */
   label: string;
   /**
    * Stores the selected values of the nested checkboxes
    *    within the checkbox group.
+   *
+   * @version 1.0.7
    */
   value: string[];
   watchValue(): Promise<void>;
   /**
    * Specifies all properties of a `vega-flex` component,
    *    accessible as an object.
+   *
+   * @version 1.3.0
    */
   vegaFlexProp: VegaFlexProps;
   watchVegaFlexProp(): void;
   /**
    * Indicates if the checkbox group is disabled.
+   *
+   * @version 1.3.0
    */
   disabled: boolean;
   watchDisabled(): Promise<void>;
@@ -45,25 +56,35 @@ export declare class VegaCheckboxGroup {
    * Indicates whether at least one checkbox in the
    *    checkbox group must be checked to pass
    *    form validation.
+   *
+   * @version 1.3.0
    */
   required: boolean;
   /**
    * Provides a supplementary prompt message that
    *    assists users in selecting the appropriate
    *    value for the checkbox group.
+   *
+   * @version 1.3.0
    */
   hint: string;
   /** Specifies the validation status of the
    *    checkbox group component.
+   *
+   * @version 1.3.0
    */
   isValid: boolean;
   /**
    * Determines whether automatic validation should be implemented for
    *    the checkbox group upon selection.
+   *
+   * @version 2.6.0
    */
   autoValidation: boolean;
   /**
    * Defines custom validation rules for the checkbox group.
+   *
+   * @version 2.6.0
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
@@ -71,6 +92,8 @@ export declare class VegaCheckboxGroup {
    *    of any nested checkbox within the checkbox group,
    *    whether triggered programmatically or through
    *    user interaction.
+   *
+   * @version 1.0.10
    */
   vegaChange: EventEmitter<string[]>;
   /** An event emitter notifying changes in the value
@@ -79,6 +102,7 @@ export declare class VegaCheckboxGroup {
    *    user interaction.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter<string[]>;
   componentDidLoad(): void;

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

@@ -4,6 +4,9 @@ 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';
+/**
+ * @version 1.0.7
+ */
 export declare class VegaCheckbox {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaCheckboxShowErrorController: VegaCheckboxShowErrorController;
@@ -28,6 +31,8 @@ export declare class VegaCheckbox {
    *
    * Refer to the `value` property for detailed information on
    *    how to use this property during form validation.
+   *
+   * @version 1.10.0
    */
   identifier: string;
   /**
@@ -42,30 +47,42 @@ export declare class VegaCheckbox {
    * If the `identifier` property is not set, the `value` property behaves
    *    as a boolean and returns `true` when the checkbox is checked,
    *    and `false` when it is unchecked.
+   *
+   * @version 1.0.7
    */
   value: string | boolean;
   /**
    * Specifies whether the checkbox should be pre-checked.
    *
    * Use the `value` property to retrieve the current status of the checkbox.
+   *
+   * @version 1.0.7
    */
   checked: boolean;
   watchCheckedChange(): void;
   /**
    * Specifies whether the checkbox element is disabled.
+   *
+   * @version 1.3.0
    */
   disabled: boolean;
   /**
    * Specifies the size of the checkbox.
+   *
+   * @version 1.3.0
    */
   size: 'default' | 'small';
   /**
    * Specifies whether the checkbox must be checked
    *    to pass form validation.
+   *
+   * @version 1.3.0
    */
   required: boolean;
   /**
    * Specifies the validation status of the checkbox component.
+   *
+   * @version 1.10.0
    */
   isValid: boolean;
   /**
@@ -78,6 +95,7 @@ export declare class VegaCheckbox {
    *    whether triggered programmatically or through user interaction.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter<string | boolean>;
   disconnectedCallback(): void;
@@ -87,6 +105,8 @@ export declare class VegaCheckbox {
    * Invoke this method to set the value of the checkbox.
    *
    * It is recommended to use this method instead of directly modifying the `value` property.
+   *
+   * @version 1.16.0
    */
   setValue(value: string | boolean): Promise<void>;
   render(): VegaCheckbox;