@globalpayments/vega 2.24.0 → 2.24.2

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

@@ -7,6 +7,9 @@ import { PageResizeObserverSlimmer } from '../../helpers/slimmers/page-resize-ob
 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.11.0
+ */
 export declare class VegaChip {
   private static readonly iconSizeMap;
   private static readonly closeIconSizeMap;
@@ -29,18 +32,26 @@ export declare class VegaChip {
    *
    * It provides descriptive text that helps identify
    *    the purpose or category of the chip.
+   *
+   * @version 1.11.0
    */
   text: string;
   /**
    * Specifies whether the chip is clickable.
+   *
+   * @version 1.11.0
    */
   clickable: boolean;
   /**
    * Determines the rendering style for the chip.
+   *
+   * @version 1.11.0
    */
   variant: VegaChipVariant;
   /**
    * Specifies the size of the chip.
+   *
+   * @version 1.11.0
    */
   size: ResponsiveType<VegaChipSize>;
   watchSize(): void;
@@ -49,15 +60,21 @@ export declare class VegaChip {
    *
    * This property is only applicable when using the `filled-background` variant,
    *    which is a specific style option for the chip.
+   *
+   * @version 1.11.0
    */
   bgColor: BackgroundColorsTokenType;
   /**
    * Specifies the color of the text displayed within the chip.
+   *
+   * @version 1.11.0
    */
   textColor: TextColorsTokenType;
   /**
    * Specifies the color of the status dot when
    *    the chip's type is set to `status`.
+   *
+   * @version 1.11.0
    */
   statusColor: BackgroundColorsTokenType;
   /**
@@ -73,44 +90,58 @@ export declare class VegaChip {
    *    the chip allows for more flexibility in positioning the icon.
    *    You can choose to have the icon as a prefix or a suffix to the label text.
    *    This type is commonly used when the chip represents a label or category.
+   *
+   * @version 1.11.0
    */
   chipType: VegaChipType;
   /**
    * Controls the visibility of a close button within the chip.
+   *
+   * @version 1.11.0
    */
   showCloseIcon: boolean;
   /**
    * Displays an icon in the chip. This property is applicable only when
    *    the chip's type is set to `label`.
+   *
+   * @version 1.11.0
    */
   icon: string;
   /**
    * Specifies the placement or alignment of the icon within
    *    the chip in relation to the chip's text.
+   *
+   * @version 1.11.0
    */
   iconAlign: VegaChipIconAlign;
   /**
    * An event emitter notifying the click event of the close button of the chip.
    *
    * This event is only dispatched when the `showCloseIcon` property is set to `true`.
+   *
+   * @version 1.11.0
    */
   vegaClose: EventEmitter<void>;
   /**
    * An event emitter notifying the click event of the close button of the chip.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   close: EventEmitter<void>;
   /**
    * An event emitter notifying the click event of the chip.
    *
    * This event is only dispatched when the `clickable` property is set to `true`.
+   *
+   * @version 1.11.0
    */
   vegaClick: EventEmitter<void>;
   /**
    * An event emitter notifying the click event of the chip.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   click: EventEmitter<void>;
   componentWillLoad(): void;

package/dist/types/components/vega-color-picker/vega-color-picker.d.ts

@@ -4,6 +4,9 @@ import { FormFieldControllerSlimmer } from '../../helpers/slimmers/form-field-co
 import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.13.0
+ */
 export declare class VegaColorPicker {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly formFieldController: FormFieldControllerSlimmer<string>;
@@ -15,21 +18,29 @@ export declare class VegaColorPicker {
   /**
    * Specifies the initial or preset color value of the color picker.
    *    It is represented as a hexadecimal string.
+   *
+   * @version 1.13.0
    */
   value: string;
   watchValue(): void;
   /**
    * Displays a supplementary prompt message that assists users
    *    in understanding the expected value for the color picker.
+   *
+   * @version 1.13.0
    */
   hint: string;
   /**
    * Specifies whether the color picker element is disabled.
+   *
+   * @version 1.13.0
    */
   disabled: boolean;
   /**
    * Specifies whether a color must be selected for
    *    the color picker to pass form validation.
+   *
+   * @version 1.13.0
    */
   required: boolean;
   /**
@@ -37,19 +48,27 @@ export declare class VegaColorPicker {
    *
    * It provides descriptive text that helps identify
    *    the purpose or content expected in the color picker.
+   *
+   * @version 1.13.0
    */
   label: string;
   /**
    * Specifies the validation status of the color picker component.
+   *
+   * @version 1.13.0
    */
   isValid: boolean;
   /**
    * Determines whether automatic validation should be implemented
    *  for the color picker when a color is selected.
+   *
+   * @version 1.13.0
    */
   autoValidation: boolean;
   /**
    * Specifies custom validation rules for the color picker.
+   *
+   * @version 1.13.0
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
@@ -57,17 +76,22 @@ export declare class VegaColorPicker {
    * Defines custom color options for the color picker.
    *
    * It should be an array of hexadecimal strings representing different colors.
+   *
+   * @version 1.13.0
    */
   colors: string[];
   /**
    * An event emitter notifying changes in the value of the color picker,
    *    whether triggered programmatically or through user interaction.
+   *
+   * @version 1.13.0
    */
   vegaChange: EventEmitter<string>;
   /**
    * An event emitter notifying changes in the value of the color picker,
    *    whether triggered programmatically or through user interaction.
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter<string>;
   connectedCallback(): void;

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

@@ -7,6 +7,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.11.0
+ */
 export declare class VegaComboBox {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly formFieldController: FormFieldControllerSlimmer<string[]>;
@@ -28,16 +31,22 @@ export declare class VegaComboBox {
    *
    * It provides descriptive text that helps identify the
    *    purpose or content expected in the combo box.
+   *
+   * @version 1.11.0
    */
   label: string;
   /**
    * Specifies whether a value must be entered for the
    *    combo box to pass form validation.
+   *
+   * @version 1.11.0
    */
   required: boolean;
   /**
    * Specifies the source data used to populate the
    *    dropdown menu associated with the combo box.
+   *
+   * @version 1.11.0
    */
   source: DropdownSourceItem[];
   watchSource(): void;
@@ -45,25 +54,35 @@ export declare class VegaComboBox {
    * Sets the initial or preset values of the combo box.
    *
    * It should be an array of strings representing the selected values.
+   *
+   * @version 1.11.0
    */
   value: string[];
   watchValue(): void;
   /**
    * Specifies the validation status of the combo box component.
+   *
+   * @version 1.11.0
    */
   isValid: boolean;
   /**
    * Determines whether automatic validation should be implemented
    *    when a value is edited in the combo box.
+   *
+   * @version 1.11.0
    */
   autoValidation: boolean;
   /**
    * Specifies custom validation rules for the combo box.
+   *
+   * @version 1.11.0
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
   /**
    * Specifies whether the combo box element is disabled.
+   *
+   * @version 1.11.0
    */
   disabled: boolean;
   /**
@@ -71,21 +90,29 @@ export declare class VegaComboBox {
    *    or example inside the combo box input field.
    *
    * It indicates the expected format or pattern of the input.
+   *
+   * @version 1.11.0
    */
   placeholder: string;
   /**
    * Provides a supplementary prompt message that is displayed
    *    alongside the combo box input field.
+   *
+   * @version 1.11.0
    */
   hint: string;
   /**
    * Specifies the size of the combo box.
+   *
+   * @version 1.11.0
    */
   size: VegaComboBoxSize;
   /**
    * Specifies partial properties of the `vega-dropdown` component
    *    that are used to configure the dropdown menu
    *    associated with the combo box.
+   *
+   * @version 1.11.0
    */
   vegaDropdownProps: VegaDropdownPropsForComboBox;
   /**
@@ -94,11 +121,15 @@ export declare class VegaComboBox {
    *
    * Setting this property to `false` enables custom text input handling
    *    by listening for the `vegaSearch` event.
+   *
+   * @version 1.24.0
    */
   useDefaultFilter: boolean;
   /**
    * An event emitter notifying changes in the items of the combo box value,
    *    whether triggered programmatically or through user interaction.
+   *
+   * @version 1.11.0
    */
   vegaChange: EventEmitter<string[]>;
   /**
@@ -106,6 +137,7 @@ export declare class VegaComboBox {
    *    whether triggered programmatically or through user interaction.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter<string[]>;
   /**
@@ -115,6 +147,8 @@ export declare class VegaComboBox {
    * The event's `detail` property contains the new value.
    *
    * The combo box _does not_ automatically add the new value to its `source` and `value`.
+   *
+   * @version 1.14.0
    */
   vegaCreate: EventEmitter<string>;
   /**
@@ -125,25 +159,33 @@ export declare class VegaComboBox {
    *
    * The combo box _does not_ automatically add the new value to its `source` and `value`.
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   create: EventEmitter<string>;
   /**
    * An event emitter notifying the user's search action in the combo box,
    *    but only if the `useDefaultFilter` property is set to `false`.
+   *
+   * @version 1.24.0
    */
   vegaSearch: EventEmitter<string>;
   /**
    * An event emitter notifying the user's search action in the combo box,
    *    but only if the `useDefaultFilter` property is set to `false`.
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   search: EventEmitter<string>;
   /**
    * Invoke this method to close the dropdown menu associated with the combo box.
+   *
+   * @version 1.11.0
    */
   close(): Promise<void>;
   /**
    * Invoke this method to open the dropdown menu associated with the combo box.
+   *
+   * @version 1.11.0
    */
   open(): Promise<void>;
   render(): VegaComboBox;

package/dist/types/components/vega-counter-badge/vega-counter-badge.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.15.0
+ */
 export declare class VegaCounterBadge {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaCounterBadgeElement>;
@@ -9,6 +12,8 @@ export declare class VegaCounterBadge {
    *
    * If set to `true`, the count is hidden,
    *    and the badge is rendered as a smaller dot.
+   *
+   * @version 1.15.0
    */
   dot: boolean;
   /**
@@ -17,15 +22,21 @@ export declare class VegaCounterBadge {
    * - Use 'bg-danger' to represent critical information that
    *    demands the user's attention.
    * - Use 'bg-action' to represent a mere count of items.
+   *
+   * @version 1.15.0
    */
   color: 'bg-danger' | 'bg-action';
   /**
    * Represents the number that will be displayed on the badge.
+   *
+   * @version 1.15.0
    */
   count: number;
   /**
    * Specifies the offset of the badge `[left, top]` from
    *    its default position at the top right corner.
+   *
+   * @version 1.15.0
    */
   offset: number[];
   render(): VegaCounterBadge;

package/dist/types/components/vega-date-picker/vega-date-picker-calendar/vega-date-picker-calendar.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 VegaDatePickerCalendar {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaDatePickerCalendarElement>;

package/dist/types/components/vega-date-picker/vega-date-picker.d.ts

@@ -17,6 +17,9 @@ import { VegaDatePickerKeyboardController } from './slimmers/controllers/vega-da
 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.3.0
+ */
 export declare class VegaDatePicker {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaDatePickerMobileController: VegaDatePickerMobileController;
@@ -42,12 +45,16 @@ export declare class VegaDatePicker {
    *
    *  - Use `single` to allow selecting a single date.
    *  - Use `range` to allow selecting a date range.
+   *
+   * @version 1.3.0
    */
   mode: DatePickerModeType;
   /** Update datePicker settings property of mode is changed */
   watchMode(): void;
   /**
    * Specifies the selected date or date range in the date picker.
+   *
+   * @version 1.3.0
    */
   value: DatePickerValueType<DatePickerModeType>;
   watchValue(newValue: DatePickerValueType<DatePickerModeType>, oldValue: DatePickerValueType<DatePickerModeType>): void;
@@ -56,6 +63,8 @@ export declare class VegaDatePicker {
    *
    * It provides descriptive text that helps identify the
    *    purpose or content expected in the date picker field.
+   *
+   * @version 1.3.0
    */
   label: string;
   /**
@@ -63,19 +72,27 @@ export declare class VegaDatePicker {
    *
    * Specifies whether a date or range must be selected for
    *    the date picker to pass form validation.
+   *
+   * @version 1.3.0
    */
   required: boolean;
   /**
    * Specifies the validation status of the date picker component.
+   *
+   * @version 1.3.0
    */
   isValid: boolean | null;
   /**
    * Determines whether automatic validation should be implemented
    *    when a date or range is selected.
+   *
+   * @version 1.3.0
    */
   autoValidation: boolean;
   /**
    * Specifies the desired date format.
+   *
+   * @version 1.3.0
    */
   format: string;
   /**
@@ -87,20 +104,28 @@ export declare class VegaDatePicker {
   watchFormat(format: string): void;
   /**
    * Specifies the size of the date picker field.
+   *
+   * @version 1.3.0
    */
   size: 'default' | 'small';
   /**
    * Specifies custom validation rules for the date picker field.
+   *
+   * @version 1.3.0
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
   /**
    * Specifies the minimum selectable date in the date picker.
+   *
+   * @version 1.3.0
    */
   minDate: string;
   watchMinDate(value: string): void;
   /**
    * Specifies the maximum selectable date in the date picker.
+   *
+   * @version 1.3.0
    */
   maxDate: string;
   watchMaxDate(value: string): void;
@@ -109,10 +134,14 @@ export declare class VegaDatePicker {
    *    or example inside the date picker field.
    *
    * It indicates the expected format or pattern of the date picker field.
+   *
+   * @version 1.3.0
    */
   placeholder: string | string[];
   /**
    * Specifies whether to display the clear button when the calendar is shown.
+   *
+   * @version 1.3.0
    */
   clearButton: boolean;
   /**
@@ -120,35 +149,46 @@ export declare class VegaDatePicker {
    *
    * If set to `true`, keyboards and touch devices will skip
    *    interacting with this element.
+   *
+   * @version 1.3.0
    */
   readOnly: boolean;
   /**
    * Specifies whether the user is allowed to change either the
    *    start date or end date of an already selected date range
    *    without completely resetting the selected range.
+   *
+   * @version 1.3.0
    */
   allowRepick: boolean;
   /**
    * Specifies the configuration for the calendar dropdown
    *    associated with the date picker.
+   *
+   * @version 1.5.0
    */
   dropdownConfig: DropdownConfigForDatePicker;
   /** Update property of allowRepick when it is changed */
   watchAllowRepick(): void;
   /**
    * Specifies whether the date picker field is disabled.
+   *
+   * @version 1.3.0
    */
   disabled: boolean;
   watchDisabled(): void;
   /**
    * An event emitter notifying the change of the value in the date picker,
    *    whether triggered programmatically or through user interaction.
+   *
+   * @version 1.3.0
    */
   vegaChange: EventEmitter<string | string[]>;
   /**
    * An event emitter notifying the change of the value in the date picker,
    *    whether triggered programmatically or through user interaction.
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter<string | string[]>;
   /**

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

@@ -4,6 +4,9 @@ import { VegaDialogAction, VegaDialogActionButtonProps } 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.24.0
+ */
 export declare class VegaDialog {
   protected readonly globalSlimmers: GlobalSlimmers;
   /**
@@ -20,45 +23,63 @@ export declare class VegaDialog {
   currentBreakpoint: BreakpointsTokenType;
   /**
    * Specifies the title of the dialog.
+   *
+   * @version 1.24.0
    */
   dialogTitle?: string;
   /**
    * Specifies the text content of the dialog.
+   *
+   * @version 1.24.0
    */
   content?: string;
   /**
    * Specifies the type of the dialog.
    *
    * Use the value `danger` when the dialog's primary action is destructive.
+   *
+   * @version 1.24.0
    */
   type?: 'default' | 'danger';
   /**
    * Represents a dictionary that contains the configuration options
    *    for the action button in the dialog.
+   *
+   * @version 1.24.0
    */
   okButton?: VegaDialogActionButtonProps;
   /**
    * Represents the function that will be executed when the
    *    user clicks the action button in the dialog.
+   *
+   * @version 1.24.0
    */
   handleOk?: VegaDialogAction;
   /**
    * Represents a dictionary that contains the configuration options
    *    for the cancel button in the dialog.
+   *
+   * @version 1.24.0
    */
   cancelButton?: VegaDialogActionButtonProps;
   /**
    * Represents the function that will be executed when the user
    *    clicks the cancel button in the dialog.
+   *
+   * @version 1.24.0
    */
   handleCancel?: VegaDialogAction;
   /**
    * Determines whether the cancel button should be displayed.
+   *
+   * @version 1.24.0
    */
   showCancel: boolean;
   /**
    * Represents a dictionary that contains the configuration options
    *    for the modal component used to display the dialog.
+   *
+   * @version 1.24.0
    */
   modalProps: Partial<VegaComponentInterface<HTMLVegaModalElement>>;
   render(): VegaDialog;

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

@@ -5,6 +5,9 @@ import { VegaDividerSizeController } from './slimmers/controllers/vega-divider-s
 import { PageResizeObserverSlimmer } from '../../helpers/slimmers/page-resize-observer-slimmer';
 import { BreakpointsTokenType } from '../../types/design-token.type';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 2.10.0
+ */
 export declare class VegaDivider {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected pageResizeObserverSlimmer: PageResizeObserverSlimmer;
@@ -17,10 +20,14 @@ export declare class VegaDivider {
    *
    * It can be set to either horizontal or vertical,
    *    determining the orientation of the separation.
+   *
+   * @version 2.10.0
    */
   direction: ResponsiveType<VegaDividerDirectionType>;
   /**
    * Determines the rendering style for the divider.
+   *
+   * @version 2.10.0
    */
   variant: VegaDividerVariantType;
   /**
@@ -28,6 +35,8 @@ export declare class VegaDivider {
    *    offering flexibility in adjusting spacing.
    * It can be set as ResponsiveType or any sizing token
    *    for precise control over layout and appearance.
+   *
+   * @version 2.10.0
    */
   margin: ResponsiveType<MarginType>;
   render(): VegaDivider;

package/dist/types/components/vega-dropdown/vega-dropdown-content-box/vega-dropdown-content-box.d.ts

@@ -1,6 +1,9 @@
 import { GlobalSlimmers } from '../../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
 import { ChildNodesEventPreventSlimmer } from '../../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
+/**
+ * @version 2.0.0
+ */
 export declare class VegaDropdownContentBox {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected eventPrevent: ChildNodesEventPreventSlimmer;