@globalpayments/vega 2.23.0 → 2.24.2

package/dist/types/components/vega-selection-chip/vega-selection-chip-group/vega-selection-chip-group.d.ts

@@ -10,6 +10,9 @@ import { SubStateNotifySlimmerBase } from '../../../helpers/slimmers/sub-state/s
 import { ChildNodesEventPreventSlimmer } from '../../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { FormFieldControllerSlimmer } from '../../../helpers/slimmers/form-field-controller-slimmer';
 import { EventEmitSlimmerBase } from '../../../helpers/event-manager/slimmers/event-emit-slimmer';
+/**
+ * @version 2.22.0
+ */
 export declare class VegaSelectionChipGroup {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly renderer: VegaSelectionChipGroupRenderer;
@@ -27,22 +30,30 @@ export declare class VegaSelectionChipGroup {
    * Specifies the label or title for the selection chip group.
    *    It provides descriptive text that helps identify
    *    the purpose of the selection chip group.
+   *
+   * @version 2.22.0
    */
   label: string;
   /**
    * Provides a supplementary prompt message that
    *    assists users in selecting the appropriate
    *    value for the selection chip group.
+   *
+   * @version 2.22.0
    */
   hint: string;
   /**
    * Determines the selection method for the chip group.
+   *
+   * @version 2.22.0
    */
   selectType: VegaSelectionChipGroupSelectType;
   watchSelectType(): void;
   /**
    * Stores the selected values of the nested selection chips
    *    within the selection chip group.
+   *
+   * @version 2.22.0
    */
   value: string | string[];
   watchValue(): void;
@@ -50,25 +61,35 @@ export declare class VegaSelectionChipGroup {
    * Indicates whether at least one selection chip in the
    *    selection chip group must be checked to pass
    *    form validation.
+   *
+   * @version 2.22.0
    */
   required: boolean;
   /**
    * Indicates if the selection chip group is disabled.
+   *
+   * @version 2.22.0
    */
   disabled: boolean;
   watchDisabled(): void;
   /**
    * Defines custom validation rules for the selection chip group field.
+   *
+   * @version 2.22.0
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
   /**
    * Sets the validation status for the selection chip group.
+   *
+   * @version 2.22.0
    */
   isValid: boolean;
   /**
    * An event emitter notifying changes in the value of the selection chip group,
    *    whether triggered programmatically or through user interaction.
+   *
+   * @version 2.22.0
    */
   vegaChange: EventEmitter<string>;
   /**
@@ -76,6 +97,7 @@ export declare class VegaSelectionChipGroup {
    *    whether triggered programmatically or through user interaction.
    *
    * @eventSemantics namespace:native
+   * @version 2.22.0
    */
   change: EventEmitter<string>;
   render(): VegaSelectionChipGroup;

package/dist/types/components/vega-selection-chip/vega-selection-chip.d.ts

@@ -11,6 +11,9 @@ import { BackgroundColorsTokenType, BreakpointsTokenType } from '../../types/des
 import { PageResizeObserverSlimmer } from '../../helpers/slimmers/page-resize-observer-slimmer';
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { VegaSelectionChipGroupSelectType } from './vega-selection-chip-group/interface';
+/**
+ * @version 2.22.0
+ */
 export declare class VegaSelectionChip {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly renderer: VegaSelectionChipRenderer;
@@ -31,29 +34,41 @@ export declare class VegaSelectionChip {
    * Specifies the label or title for the selection chip.
    * It provides descriptive text that helps identify
    *    the purpose of the selection chip.
+   *
+   * @version 2.22.0
    */
   label: string;
   /**
    * Specifies the size of the selection chip.
+   *
+   * @version 2.22.0
    */
   size: ResponsiveType<VegaSelectionChipSize>;
   watchSize(): void;
   /**
    * Determines the rendering style for the selection chip.
+   *
+   * @version 2.22.0
    */
   variant: VegaSelectionChipVariant;
   /**
    * Indicates if the selection chip is disabled.
+   *
+   * @version 2.22.0
    */
   disabled: boolean;
   /**
    * Determines if the selection chip is checked.
+   *
+   * @version 2.22.0
    */
   checked: boolean;
   /**
    * Defines the display behavior of the selection chip.
    * This property controls how the chip is presented
    *    in relation to surrounding elements.
+   *
+   * @version 2.22.0
    */
   block: boolean;
   /**
@@ -61,6 +76,8 @@ export declare class VegaSelectionChip {
    *    when it is in a disabled state.
    * This provides additional context or information about the chip's
    *    functionality or reason for being disabled.
+   *
+   * @version 2.22.0
    */
   disabledTooltip: VegaSelectionChipTooltipProps;
   /**
@@ -68,16 +85,21 @@ export declare class VegaSelectionChip {
    * It accepts a string value representing a valid
    *    background color token,
    *    which customizes the chip appearance.
+   *
+   * @version 2.22.0
    */
   swatchColor: BackgroundColorsTokenType;
   /**
    * Stores the value associated with the selection chip
    *    when it is checked or unchecked.
+   * @version 2.22.0
    */
   value: string;
   /**
    * An event emitter notifying changes in the value of the selection chip,
    *    whether triggered programmatically or through user interaction.
+   *
+   * @version 2.22.0
    */
   vegaChange: EventEmitter<string>;
   /**
@@ -85,6 +107,7 @@ export declare class VegaSelectionChip {
    *    whether triggered programmatically or through user interaction.
    *
    * @eventSemantics namespace:native
+   * @version 2.22.0
    */
   change: EventEmitter<string>;
   componentWillRender(): void;

package/dist/types/components/vega-selection-tile/vega-selection-tile-group/vega-selection-tile-group.d.ts

@@ -10,6 +10,9 @@ import { ChildNodesEventPreventSlimmer } from '../../../helpers/event-manager/sl
 import { VegaSelectionTileGroupItemsController } from './slimmers/controllers/vega-selection-tile-group-items-controller';
 import { FormFieldValidationRule } from '../../../helpers/validator/rules/form-field-validation-rule';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 2.7.0
+ */
 export declare class VegaSelectionTileGroup {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly renderer: VegaSelectionTileGroupRenderer;
@@ -28,12 +31,16 @@ export declare class VegaSelectionTileGroup {
    * Specifies the label or title for the selection tile group.
    *    It provides descriptive text that helps identify
    *    the purpose of the selection tile group.
+   *
+   * @version 2.7.0
    */
   label: string;
   /**
    * Provides a supplementary prompt message that
    *    assists users in selecting the appropriate
    *    value for the selection tile group.
+   *
+   * @version 2.7.0
    */
   hint: string;
   /**
@@ -43,43 +50,59 @@ export declare class VegaSelectionTileGroup {
    *      Displays a radio button for selection.
    * - `checkbox`:
    *      Displays a checkbox for selection.
+   *
+   * @version 2.7.0
    */
   selectType: 'radio' | 'checkbox';
   watchSelectType(): void;
   /**
    * Stores the selected values of the nested selection tiles
    *    within the selection tile group.
+   *
+   * @version 2.7.0
    */
   value: string | string[];
   watchValue(): void;
   /**
    * Controls the layout of the nested selection tiles
    *    within the selection tile group.
+   *
+   * @version 2.7.0
    */
   layout: 'vertical' | 'horizontal';
   /**
    * Indicates whether at least one selection tile in the
    *    selection tile group must be checked to pass
    *    form validation.
+   *
+   * @version 2.7.0
    */
   required: boolean;
   /**
    * Indicates if the selection tile group is disabled.
+   *
+   * @version 2.7.0
    */
   disabled: boolean;
   watchDisabled(): void;
   /**
    * Defines custom validation rules for the selection tile group field.
+   *
+   * @version 2.7.0
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
   /**
    * Sets the validation status for the selection tile group.
+   *
+   * @version 2.7.0
    */
   isValid: boolean;
   /**
    * An event emitter notifying changes in the value of the selection tile group,
    *    whether triggered programmatically or through user interaction.
+   *
+   * @version 2.7.0
    */
   vegaChange: EventEmitter<string>;
   /**
@@ -87,6 +110,7 @@ export declare class VegaSelectionTileGroup {
    *    whether triggered programmatically or through user interaction.
    *
    * @eventSemantics namespace:native
+   * @version 2.7.0
    */
   change: EventEmitter<string>;
   render(): VegaSelectionTileGroup;

package/dist/types/components/vega-selection-tile/vega-selection-tile.d.ts

@@ -8,6 +8,9 @@ import { VegaSelectionTileShowErrorController } from './slimmers/controllers/veg
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { ChildNodesNotifyObserverSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-notify-observer-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 2.7.0
+ */
 export declare class VegaSelectionTile {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly renderer: VegaSelectionTileRenderer;
@@ -27,23 +30,33 @@ export declare class VegaSelectionTile {
   /**
    * Specifies the text content of the title displayed
    *    within the selection tile.
+   *
+   * @version 2.7.0
    */
   titleText: string;
   /**
    * Specifies the text content of the note displayed
    *    within the selection tile.
+   *
+   * @version 2.7.0
    */
   note: string;
   /**
    * Specifies the prefix icon displayed within the selection tile.
+   *
+   * @version 2.7.0
    */
   prefixIcon: string;
   /**
    * Determines if the selection tile is disabled.
+   *
+   * @version 2.7.0
    */
   disabled: boolean;
   /**
    * Determines if the selection tile is checked.
+   *
+   * @version 2.7.0
    */
   checked: boolean;
   /**
@@ -53,16 +66,22 @@ export declare class VegaSelectionTile {
    *      Displays a radio button for selection.
    * - `checkbox`:
    *      Displays a checkbox for selection.
+   *
+   * @version 2.7.0
    */
   selectType: 'radio' | 'checkbox';
   /**
    * Determines the value that is associated with the selection-tile
    *    when it is checked or unchecked.
+   *
+   * @version 2.7.0
    */
   value: string;
   /**
    * An event emitter notifying changes in the value of the selection tile,
    *    whether triggered programmatically or through user interaction.
+   *
+   * @version 2.7.0
    */
   vegaChange: EventEmitter<string>;
   /**
@@ -70,6 +89,7 @@ export declare class VegaSelectionTile {
    *    whether triggered programmatically or through user interaction.
    *
    * @eventSemantics namespace:native
+   * @version 2.7.0
    */
   change: EventEmitter<string>;
   render(): VegaSelectionTile;

package/dist/types/components/vega-signature-capture/vega-signature-capture.d.ts

@@ -11,6 +11,9 @@ import { FormFieldValidationRule } from '../../helpers/validator/rules/form-fiel
 import { HeightType, ResponsiveType } from '../../types/ui.type';
 import { PageResizeObserverSlimmer } from '../../helpers/slimmers/page-resize-observer-slimmer';
 import { BreakpointsTokenType } from '../../types/design-token.type';
+/**
+ * @version 2.19.0
+ */
 export declare class VegaSignatureCapture {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaSignatureCaptureElement>;
@@ -28,6 +31,8 @@ export declare class VegaSignatureCapture {
   isDrawing: boolean;
   /**
    * Specifies the mode of the signature capture
+   *
+   * @version 2.19.0
    */
   mode: VegaSignatureCaptureMode;
   /**
@@ -35,14 +40,20 @@ export declare class VegaSignatureCapture {
    *
    * It provides descriptive text that helps identify the
    *    purpose or content expected in the signature capture.
+   *
+   * @version 2.19.0
    */
   label: string;
   /**
    * Determines whether the signature capture field is required.
+   *
+   * @version 2.19.0
    */
   required: boolean;
   /**
    * Determines whether the clear button is displayed.
+   *
+   * @version 2.19.0
    */
   showClearBtn: boolean;
   /**
@@ -50,54 +61,75 @@ export declare class VegaSignatureCapture {
    *    or example inside the signature capture.
    *
    * It indicates the expected format or pattern of the signature capture.
+   *
+   * @version 2.19.0
    */
   placeholder: string;
   /**
    * Specifies an icon or symbol that appears before the placeholder,
    *    providing visual context or enhancing the aesthetic appearance
    *    of the signature capture.
+   *
+   * @version 2.19.0
    */
   placeholderIcon: string;
   /**
    * Specifies whether the signature capture is disabled.
+   *
+   * @version 2.19.0
    */
   disabled: boolean;
   /**
    * Specifies the value of the signature capture
+   *
+   * @version 2.19.0
    */
   value: VegaSignatureValue | null;
   watchValue(newValue: VegaSignatureValue, oldValue: VegaSignatureValue): void;
   /**
    * Indicates whether the current value in the field is considered valid or
    *    invalid based on the defined validation rules.
+   *
+   * @version 2.19.0
    */
   isValid: boolean | null;
   /**
    * Determines whether the signature capture field should undergo automatic validation
    *    during the user's sign.
+   *
+   * @version 2.19.0
    */
   autoValidation: boolean;
   /**
    * Defines custom validation rules for the signature capture field.
+   *
+   * @version 2.19.0
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
   /**
    * Defines the height of the signature capture field.
+   *
+   * @version 2.20.0
    */
   height: ResponsiveType<HeightType>;
   /**
    * An event emitter notifying a value change.
+   *
+   * @version 2.19.0
    */
   vegaChange: EventEmitter<VegaSignatureValue>;
   /**
    * An event emitter notifying a value change.
    *
    * @eventSemantics namespace:native
+   * @version 2.19.0
    */
   change: EventEmitter<VegaSignatureValue>;
   /**
    * Invoke this method to clear the signature
+   *
+   * @version 2.19.0
    */
   clear(): Promise<void>;
   render(): VegaSignatureCapture;

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

@@ -9,6 +9,9 @@ import { VegaSkeletonRendererManager } from './slimmers/renderers/vega-skeleton-
 import { VegaSkeletonEllipseRenderer } from './slimmers/renderers/vega-skeleton-ellipse-renderer';
 import { HeightType, WidthType } from '../../types/ui.type';
 import { VegaSkeletonType } from './interface';
+/**
+ * @version 2.15.0
+ */
 export declare class VegaSkeleton {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaSkeletonElement>;
@@ -22,19 +25,27 @@ export declare class VegaSkeleton {
   host: HTMLVegaSkeletonElement;
   /**
    * Specifies the type of the skeleton.
+   *
+   * @version 2.15.0
    */
   type: VegaSkeletonType;
   /**
    * Specifies the width of the skeleton.
+   *
+   * @version 2.15.0
    */
   width: WidthType;
   /**
    * Specifies the height of the skeleton.
    * - This property is applicable only when {@link type} is set to is `image` or `ellipse`.
+   *
+   * @version 2.15.0
    */
   height: HeightType;
   /**
    * Indicates whether the skeleton displays an animation effect.
+   *
+   * @version 2.15.0
    */
   animated: boolean;
   render(): VegaSkeleton;

package/dist/types/components/vega-slot-container/vega-slot-container.d.ts

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

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

@@ -4,6 +4,9 @@ import { FormFieldControllerSlimmer } from '../../helpers/slimmers/form-field-co
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.0.5
+ */
 export declare class VegaStepper {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly formFieldController: FormFieldControllerSlimmer<number>;
@@ -15,20 +18,28 @@ export declare class VegaStepper {
   host: HTMLVegaStepperElement;
   /**
    * Specifies the unique identifier for the stepper component.
+   *
+   * @version 1.3.0
    */
   stepperId: string;
   /**
    * Defines the upper limit or maximum value that can be
    *    incremented within the stepper component.
+   *
+   * @version 1.0.5
    */
   max: number;
   /**
    * Defines the lower limit or minimum value that can be
    *    decremented within the stepper component.
+   *
+   * @version 1.0.5
    */
   min: number;
   /**
    * Defines the initial or current value of the stepper component.
+   *
+   * @version 1.0.5
    */
   value: number;
   /**
@@ -39,39 +50,54 @@ export declare class VegaStepper {
   /**
    * Provides a descriptive text or string that serves
    *    as the label or title for the stepper component.
+   *
+   * @version 1.0.5
    */
   label: string;
   /**
    * Specifies whether the input field of the
    *    stepper component is disabled. The increment and
    *    decrement buttons are unaffected by this setting.
+   *
+   * @version 1.31.0
    */
   inputDisabled: boolean;
   /**
    * Specifies whether the stepper component is disabled.
+   *
+   * @version 1.3.0
    */
   disabled: boolean;
   /**
    * Specifies the validation status of the stepper component.
+   *
+   * @version 1.3.0
    */
   isValid: boolean;
   /**
    * Determines whether automatic validation should be
    *    implemented for the stepper component.
+   *
+   * @version 1.18.0
    */
   autoValidation: boolean;
   /**
    * Specifies the style variant for the stepper buttons.
+   *
+   * @version 1.19.0
    */
   buttonVariant: 'primary' | 'secondary';
   /**
    * An event emitter notifying changes in the value of the stepper component.
+   *
+   * @version 1.0.8
    */
   vegaChange: EventEmitter<number>;
   /**
    * An event emitter notifying changes in the value of the stepper component.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter<number>;
   render(): VegaStepper;

package/dist/types/components/vega-tab-group/vega-tab-group-panel/vega-tab-group-panel.d.ts

@@ -1,6 +1,9 @@
 import { ChildNodesEventPreventSlimmer } from '../../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { GlobalSlimmers } from '../../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.26.0
+ */
 export declare class VegaTabGroupPanel {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected clickEventPrevent: ChildNodesEventPreventSlimmer;
@@ -8,6 +11,8 @@ export declare class VegaTabGroupPanel {
   host: HTMLVegaTabGroupPanelElement;
   /**
    * Controls the visibility of the tab panel within the tab group.
+   *
+   * @version 1.26.0
    */
   isActive: boolean;
   /**

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

@@ -15,6 +15,9 @@ import { VegaTabGroupSliderStateController } from './slimmers/vega-tab-group/con
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.0.6
+ */
 export declare class VegaTabGroup {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly vegaTabGroupRenderer: VegaTabGroupRenderer;
@@ -53,12 +56,16 @@ export declare class VegaTabGroup {
   /**
    * Defines the data target for the selected tab
    *    within the tab group.
+   *
+   * @version 1.3.0
    */
   selectedTabDataTarget: string;
   watchSelectedTabDataTargetChange(): void;
   /**
    * Defines the spacing between the tabs in
    *    the tab group.
+   *
+   * @version 1.3.0
    */
   gap: SpacingTokenType;
   /**
@@ -69,6 +76,8 @@ export declare class VegaTabGroup {
   /**
    * Specifies whether the tabs in the tab group include
    *    a close button for closing the tab.
+   *
+   * @version 1.3.0
    */
   showCloseButton: boolean;
   /**
@@ -77,6 +86,8 @@ export declare class VegaTabGroup {
    * The `tabItems` property can only be set once during
    *    initialization and cannot be overridden or
    *    modified dynamically.
+   *
+   * @version 1.3.0
    */
   tabItems: TabConfig[];
   /**
@@ -87,21 +98,28 @@ export declare class VegaTabGroup {
    *      the popup will be positioned relative to this element.
    * - If not provided,
    *      the popup will be appended to the body element by default.
+   *
+   * @version 1.3.0
    */
   positionRelativeTo: string;
   /**
    * Specifies the visual style and prominence of the tab group.
+   *
+   * @version 1.39.0
    */
   variant: TabGroupVariant;
   /**
    * An event emitter notifying the click event of a tab
    *    in the tab group.
+   *
+   * @version 1.1.0
    */
   vegaClick: EventEmitter<string>;
   /**
    * An event emitter notifying the click event of a tab
    *    in the tab group.
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   click: EventEmitter<string>;
   /**