@globalpayments/vega 2.24.0 → 2.25.0

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

@@ -1,6 +1,9 @@
 import { VegaPageNotificationActionButtonConfig, VegaPageNotificationTypes } from './types';
 import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.17.0
+ */
 export declare class VegaPageNotification {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaPageNotificationElement>;
@@ -11,6 +14,8 @@ export declare class VegaPageNotification {
    *
    * It provides users with a concise and informative message
    *    that communicates the purpose or nature of the notification.
+   *
+   * @version 1.17.0
    */
   notificationTitle: string;
   /**
@@ -19,12 +24,16 @@ export declare class VegaPageNotification {
    * It provides a detailed message or information that
    *    further explains the purpose or context of
    *    the notification.
+   *
+   * @version 1.17.0
    */
   message: string;
   /**
    * Specifies the type of page notification,
    *    indicating the visual style or category of
    *    the notification.
+   *
+   * @version 1.17.0
    */
   type: VegaPageNotificationTypes;
   /**
@@ -33,11 +42,15 @@ export declare class VegaPageNotification {
    *
    * If the duration is set to `0`, the notification will not
    *    close automatically.
+   *
+   * @version 1.17.0
    */
   duration: number;
   /**
    * Specifies whether to display the close button for
    *    the page notification.
+   *
+   * @version 1.17.0
    */
   showCloseButton: boolean;
   /**
@@ -47,11 +60,15 @@ export declare class VegaPageNotification {
    * The action buttons provide interactive options for users to
    *    perform specific actions or operations related to
    *    the notification.
+   *
+   * @version 1.17.0
    */
   actionButtons: VegaPageNotificationActionButtonConfig[];
   componentDidLoad(): void;
   /**
    * Invoke this method to close the page notification.
+   *
+   * @version 1.17.0
    */
   close(): Promise<void>;
   render(): VegaPageNotification;

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

@@ -4,6 +4,9 @@ import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimm
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.3.0
+ */
 export declare class VegaPagination {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected childEventPrevent: ChildNodesEventPreventSlimmer;
@@ -21,16 +24,22 @@ export declare class VegaPagination {
   /**
    * Specifies the current page number for
    *    the pagination component.
+   *
+   * @version 1.3.0
    */
   current: number;
   watchCurrent(): void;
   /**
    * Specifies the total number of data items for the pagination component.
+   *
+   * @version 1.3.0
    */
   total: number;
   /**
    * Specifies the number of data items to be displayed per page in
    *    the pagination component.
+   *
+   * @version 1.3.0
    */
   pageSize: number;
   watchPageSize(): void;
@@ -40,26 +49,35 @@ export declare class VegaPagination {
    *
    * It refers to additional elements or components that can be added to
    *    enhance the functionality or appearance of each pagination item.
+   *
+   * @version 1.25.0
    */
   extensions: VegaPaginationItemType[][];
   /**
    * Specifies the options available for the page size selector
    *    in the pagination component.
+   *
+   * @version 1.25.0
    */
   pageSizeSelectorOptions: number[];
   /**
    * An event emitter notifying the current page change.
+   *
+   * @version 1.3.0
    */
   vegaChange: EventEmitter<number>;
   /**
    * An event emitter notifying the current page change.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter<number>;
   /**
    * An event emitter notifying a change in the number of
    *    data items displayed per page.
+   *
+   * @version 1.25.0
    */
   vegaPageSizeChange: EventEmitter<number>;
   /**
@@ -67,6 +85,7 @@ export declare class VegaPagination {
    *    data items displayed per page.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   pageSizeChange: EventEmitter<number>;
   componentWillLoad(): void;

package/dist/types/components/vega-popover/vega-popover-content-box/vega-popover-content-box.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.0.0
+ */
 export declare class VegaPopoverContentBox {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaPopoverContentBoxElement>;
   host: HTMLVegaPopoverContentBoxElement;
   /**
    * Controls whether the arrow is display.
+   *
+   * @version 2.8.0
    */
   showArrow: boolean;
   render(): VegaPopoverContentBox;

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

@@ -5,6 +5,9 @@ import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event
 import { VegaPopoverAppenderRenderer } from './slimmers/renderers/vega-popover-appender-renderer';
 import { VegaPopoverAppenderController } from './slimmers/controllers/vega-popover-appender-controller';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.19.0
+ */
 export declare class VegaPopover {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected appenderRenderer: VegaPopoverAppenderRenderer;
@@ -24,6 +27,8 @@ export declare class VegaPopover {
    * Specifies the size of the popover component.
    *
    * It is provided as a number or ResponsiveType.
+   *
+   * @version 1.19.0
    */
   size: ResponsiveType<SizeType>;
   /**
@@ -33,11 +38,15 @@ export declare class VegaPopover {
    * If there is insufficient space to display the popover in the
    *    default position, it will automatically adjust its placement
    *    based on the following order: `top`, `left`, `bottom`, `right`.
+   *
+   * @version 1.19.0
    */
   placement: PlacementType;
   /**
    * Controls how the popover aligns horizontally and vertically,
    *    ensuring it is displayed in the desired position.
+   *
+   * @version 1.19.0
    */
   alignment: PositionAlignmentType;
   watchToRefreshPopover(): void;
@@ -50,43 +59,59 @@ export declare class VegaPopover {
    *    with the positioning of the popover, especially when scrolling occurs,
    *    you can modify this property to specify a different element
    *    as the container for the popover.
+   *
+   * @version 1.19.0
    */
   positionRelativeTo: string;
   /**
    * Specifies the trigger mode for the popover.
+   *
+   * @version 2.1.0
    */
   trigger: 'hover' | 'click';
   /**
    * Controls whether the arrow is display.
+   *
+   * @version 2.8.0
    */
   showArrow: boolean;
   /**
    * An event emitter notifying the popover show event.
+   *
+   * @version 1.22.0
    */
   vegaPopoverShow: EventEmitter<string>;
   /**
    * An event emitter notifying the popover show event.
    * @eventSemantics namespace:native
    *
+   * @version 2.0.0
    */
   popoverShow: EventEmitter<string>;
   /**
    * An event emitter notifying the popover hide event.
+   *
+   * @version 1.22.0
    */
   vegaPopoverHide: EventEmitter<string>;
   /**
    * An event emitter notifying the popover hide event.
    * @eventSemantics namespace:native
    *
+   * @version 2.0.0
    */
   popoverHide: EventEmitter<string>;
   componentDidRender(): void;
   /**
    * Invoke this method to show the popover.
+   *
+   * @version 1.22.0
    */
   show(): Promise<void>;
   /**
    * Invoke this method to close the popover.
+   *
+   * @version 1.22.0
    */
   hide(): Promise<void>;
   render(): VegaPopover;

package/dist/types/components/vega-progress-tracker/vega-progress-tracker.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 { DeprecatedPropertySlimmerBase } from '../../helpers/slimmers/deprecated-property-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.0.7
+ */
 export declare class VegaProgressTracker {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected currentStepUpdateEventEmitter: EventEmitSlimmerBase;
@@ -14,6 +17,8 @@ export declare class VegaProgressTracker {
    * Indicates the current step or stage in a
    *    sequential process or workflow,
    *    starting from 0.
+   *
+   * @version 1.0.7
    */
   current: number;
   /**
@@ -28,6 +33,8 @@ export declare class VegaProgressTracker {
    *    In the horizontal direction, the tracker is divided into
    *    panes with navigable arrows. In the vertical direction,
    *    it is displayed as a single pane.
+   *
+   * @version 1.0.7
    */
   direction: 'vertical' | 'horizontal';
   /**
@@ -36,6 +43,8 @@ export declare class VegaProgressTracker {
    *
    * Each subtitle corresponds to a step in the
    *    progression of the workflow or process.
+   *
+   * @version 1.3.0
    */
   steps: string[];
   watchSteps(): void;
@@ -47,45 +56,62 @@ export declare class VegaProgressTracker {
    *    has been successfully completed in the
    *    workflow or process.
    * @deprecated This property will be removed soon and replaced by prop completedSteps
+   *
+   * @version 1.5.0
    */
   completedStepArray: string[];
   /**
    * Specifies an array of titles representing completed steps in the progress tracker,
    *    indicating successful completion within the workflow or process.
+   *
+   * @version 2.2.0
    */
   completedSteps: string[];
   /**
    * Enables the ability to click on the steps in
    *    the Progress Tracker component.
+   *
+   * @version 1.5.0
    */
   canClickStep: boolean;
   /**
    * An event emitter notifying that the current step has changed.
+   *
+   * @version 1.5.0
    */
   vegaCurrentStepUpdate: EventEmitter<string>;
   /**
    * An event emitter notifying that the current step has changed.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   currentStepUpdate: EventEmitter<string>;
   componentDidLoad(): void;
   /**
    * Invoke this method to change the tracker's current step
    *    to the next step, if available.
+   *
+   * @version 1.5.0
    */
   nextStep(): Promise<void>;
   /**
    * Invoke this method to change the tracker's current step
    *    to the previous step, if available.
+   *
+   * @version 1.5.0
    */
   prevStep(): Promise<void>;
   /**
    * Invoke this method to set the current step of the tracker.
+   *
+   * @version 1.0.7
    */
   setCurrent(step: number): Promise<void>;
   /**
    * Invoke this method to retrieve the tracker's current step.
+   *
+   * @version 1.3.0
    */
   getCurrent(): Promise<number>;
   render(): VegaProgressTracker;

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

@@ -11,6 +11,9 @@ import { FormFieldValidationRule } from '../../../helpers/validator/rules/form-f
 import { VegaFlexProps } from '../../../types/ui.type';
 import { MutationObserverSlimmer } from '../../../helpers/slimmers/mutation-observer/mutation-observer-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.0.7
+ */
 export declare class VegaRadioGroup {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly formFieldController: FormFieldControllerSlimmer<string>;
@@ -27,57 +30,79 @@ export declare class VegaRadioGroup {
   host: HTMLVegaRadioGroupElement;
   /**
    * Specifies the label or title of the radio group.
+   *
+   * @version 1.3.0
    */
   label: string;
   /**
    * Represents the value associated with the radio button.
+   *
+   * @version 1.0.7
    */
   value: string;
   watchValue(newValue: string): Promise<void>;
   /**
    * Specifies the name attribute for each radio button
    *    in the radio group.
+   *
+   * @version 1.3.0
    */
   name: string;
   watchName(): void;
   /**
    * Specifies all the properties of the `vega-flex` component
    *    in the radio group.
+   *
+   * @version 1.3.0
    */
   vegaFlexProp: VegaFlexProps;
   watchVegaFlexProp(): void;
   /**
    * Specifies whether the radio button within the radio 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 radio group.
+   *
+   * @version 1.3.0
    */
   hint: string;
   /**
    * Sets the validation status for the radio group.
+   *
+   * @version 1.3.0
    */
   isValid: boolean;
   /**
    * Determines whether the radio group is disabled.
+   *
+   * @version 1.8.0
    */
   disabled: boolean;
   watchDisabled(): Promise<void>;
   /**
    * Determines whether automatic validation should be implemented for
    *    the radio group upon selection.
+   *
+   * @version 2.6.0
    */
   autoValidation: boolean;
   /**
    * Defines custom validation rules for the radio group.
+   *
+   * @version 2.6.0
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
   /**
    * An event emitter notifying the change of the
    *    checked radio button in the radio group.
+   *
+   * @version 1.0.10
    */
   vegaChange: EventEmitter<string>;
   /**
@@ -85,6 +110,7 @@ export declare class VegaRadioGroup {
    *    checked radio button in the radio group.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter<string>;
   componentWillLoad(): void;

package/dist/types/components/vega-radio/vega-radio.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 { VegaRadioShowErrorController } from './slimmers/controllers/vega-radio-show-error-controller';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.0.7
+ */
 export declare class VegaRadio {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected changeEventEmitter: EventEmitSlimmerBase;
@@ -25,20 +28,28 @@ export declare class VegaRadio {
   /**
    * Represents the value associated with the radio button
    *    that is currently selected or checked.
+   *
+   * @version 1.0.7
    */
   value: string;
   /**
    * Assigns a common name to the input element of the radio button,
    *    to differentiate it from other buttons in a radio group.
+   *
+   * @version 1.3.0
    */
   name: string;
   /**
    * Determines if the radio button is selected or checked.
+   *
+   * @version 1.0.7
    */
   checked: boolean;
   watchCheckedChange(): void;
   /**
    * Determines if the radio button is disabled.
+   *
+   * @version 1.3.0
    */
   disabled: boolean;
   /**
@@ -46,31 +57,41 @@ export declare class VegaRadio {
    *
    * The size should be selected based on the context and
    *    design requirements of the specific form.
+   *
+   * @version 1.9.2
    */
   size: 'default' | 'small';
   /**
    * An event emitter notifying the focus event of the radio input.
+   *
+   * @version 1.0.7
    */
   vegaFocus: EventEmitter;
   /**
    * An event emitter notifying the focus event of the radio input.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   focus: EventEmitter;
   /**
    * An event emitter notifying the blur event of the radio input.
+   *
+   * @version 1.0.7
    */
   vegaBlur: EventEmitter;
   /**
    * An event emitter notifying the blur event of the radio input.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   blur: EventEmitter;
   /**
    * An event emitter notifying the change in the check status
    *    of the radio input.
+   *
+   * @version 1.0.10
    */
   vegaChange: EventEmitter<boolean>;
   /**
@@ -78,6 +99,7 @@ export declare class VegaRadio {
    *    of the radio input.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter<boolean>;
   connectedCallback(): void;

package/dist/types/components/vega-section-title/vega-section-title.d.ts

@@ -2,6 +2,9 @@ import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { VegaSectionTitleRenderer } from './slimmers/renderers/vega-section-title-renderer';
 import { IconAlignType } from '../../types/ui.type';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 2.1.0
+ */
 export declare class VegaSectionTitle {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly renderer: VegaSectionTitleRenderer;
@@ -10,20 +13,28 @@ export declare class VegaSectionTitle {
   /**
    * Specifies the text content of the title displayed
    *    within the section title.
+   *
+   * @version 2.1.0
    */
   titleText: string;
   /**
    * Specifies the text content of the description displayed
    *    within the section title.
+   *
+   * @version 2.1.0
    */
   description: string;
   /**
    * Specifies the icon displayed within the section title.
+   *
+   * @version 2.1.0
    */
   icon: string;
   /**
    * Specifies the alignment of the icon relative to
    *    the title within the section title.
+   *
+   * @version 2.1.0
    */
   iconAlign: IconAlignType;
   render(): VegaSectionTitle;

package/dist/types/components/vega-segment-control/vega-segment-control.d.ts

@@ -8,6 +8,9 @@ import { PageResizeObserverSlimmer } from '../../helpers/slimmers/page-resize-ob
 import { VegaSegmentOverflowController } from './slimmers/controllers/vega-segment-overflow-controller';
 import { VegaSegmentRenderer } from './slimmers/renderers/vega-segment-renderer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 2.3.0
+ */
 export declare class VegaSegmentControl {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly segmentControlRenderer: VegaSegmentControlRenderer;
@@ -23,6 +26,8 @@ export declare class VegaSegmentControl {
   /**
    * Specifies whether the segment control spans the
    *    full width of its parent element.
+   *
+   * @version 2.3.0
    */
   block: boolean;
   /** The below method is e2e-test covered in
@@ -32,18 +37,24 @@ export declare class VegaSegmentControl {
   watchBlock(): void;
   /**
    * Specifies the size of the segment control.
+   *
+   * @version 2.3.0
    */
   size: 'medium' | 'small';
   watchSize(): void;
   /**
    * Specifies the options available within the segment control.
    *    Please note that we advise against having more than four segments in a segment control.
+   *
+   * @version 2.3.0
    */
   segments: VegaSegmentProps[];
   watchSegments(): void;
   /**
    * Specifies the key of the currently selected segment
    *    within the segment control.
+   *
+   * @version 2.3.0
    */
   selected: string;
   watchSelected(): void;
@@ -57,17 +68,22 @@ export declare class VegaSegmentControl {
    *      The segment control is rendered with text only regardless of the configuration of icon.
    * - `icon-only`:
    *      The segment control is rendered with icon only, text will be showed as the icon's tooltip if configured.
+   *
+   * @version 2.3.0
    */
   variant: VegaSegmentControlVariant;
   /**
    * An event emitter notifying changes
    *    in the selected segment.
+   *
+   * @version 2.3.0
    */
   vegaChange: EventEmitter<string>;
   /**
    * A native event emitter notifying changes
    *    in the selected segment.
    * @eventSemantics namespace:native
+   * @version 2.3.0
    */
   change: EventEmitter<string>;
   componentWillLoad(): void;