@globalpayments/vega 2.24.0 → 2.25.0

package/dist/types/components/vega-table/vega-table-body/vega-table-body.d.ts

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

package/dist/types/components/vega-table/vega-table-cell/vega-table-cell.d.ts

@@ -5,6 +5,9 @@ import { BreakpointsTokenType } from '../../../types/design-token.type';
 import { PageResizeObserverSlimmer } from '../../../helpers/slimmers/page-resize-observer-slimmer';
 import { GlobalSlimmers } from '../../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.44.0
+ */
 export declare class VegaTableCell {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly vegaTableCellStateController: VegaTableCellStateController;
@@ -18,11 +21,15 @@ export declare class VegaTableCell {
   density?: ResponsiveType<VegaTableDensityType>;
   /**
    * Determines the alignment of text within the cell.
+   *
+   * @version 1.44.0
    */
   textAlign?: 'left' | 'right' | 'center';
   /**
    * Defines the screen width at which the column becomes hidden.
    *    If not set, the column remains visible at all times.
+   *
+   * @version 1.44.0
    */
   breakpoint?: VegaTableColumnBreakpoint;
   /**
@@ -30,10 +37,14 @@ export declare class VegaTableCell {
    * `ellipsis`: Replaces overflowed text with ellipsis.
    * `scroll`: Enables cell scrolling; scroll bars are displayed only when the content overflows,
    *     remaining hidden by default.
+   *
+   * @version 1.44.0
    */
   overflow?: 'ellipsis' | 'scroll';
   /**
    * Specifies the width of the cell.
+   *
+   * @version 1.44.0
    */
   width?: string;
   render(): VegaTableCell;

package/dist/types/components/vega-table/vega-table-expand-row/vega-table-expand-row.d.ts

@@ -7,6 +7,9 @@ import { BreakpointsTokenType } from '../../../types/design-token.type';
 import { VegaTableExpandRowColSpanController } from './slimmers/controllers/vega-table-expand-row-col-span-controller';
 import { PageResizeObserverSlimmer } from '../../../helpers/slimmers/page-resize-observer-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.44.0
+ */
 export declare class VegaTableExpandRow {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly vegaTableExpandRowRenderer: VegaTableExpandRowRenderer;
@@ -38,6 +41,8 @@ export declare class VegaTableExpandRow {
   colSpan: number;
   /**
    * Defines a unique key for the expandable row within the table.
+   *
+   * @version 1.44.0
    */
   rowKey: string;
   render(): VegaTableExpandRow;

package/dist/types/components/vega-table/vega-table-head/vega-table-head.d.ts

@@ -2,6 +2,9 @@ import { VegaTableHeadStateController } from './slimmers/controllers/vega-table-
 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 1.44.0
+ */
 export declare class VegaTableHead {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly vegaTableHeadStateController: VegaTableHeadStateController;

package/dist/types/components/vega-table/vega-table-head-cell/vega-table-head-cell.d.ts

@@ -7,6 +7,9 @@ import { VegaTableHeadCellStateController } from './slimmers/controllers/vega-ta
 import { BreakpointsTokenType } from '../../../types/design-token.type';
 import { PageResizeObserverSlimmer } from '../../../helpers/slimmers/page-resize-observer-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.44.0
+ */
 export declare class VegaTableHeadCell {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected clickEventEmitter: EventEmitSlimmerBase;
@@ -22,32 +25,45 @@ export declare class VegaTableHeadCell {
   /**
    * Defines the screen width at which the column becomes hidden.
    *    If not set, the column remains visible at all times.
+   *
+   * @version 1.44.0
    */
   breakpoint?: VegaTableColumnBreakpoint;
   /**
    * Defines the column's sorting configuration.
+   *
+   * @version 1.44.0
    */
   sorter?: VegaTableSorterConfig;
   /**
    * Defines the column's sorting order.
+   *
+   * @version 2.8.0
    */
   sortOrder?: VegaTableSortOrderType;
   /**
    * Determines the alignment of text within the head cell.
+   *
+   * @version 1.44.0
    */
   textAlign?: 'left' | 'right' | 'center';
   /**
    * Specifies the width of the head cell.
+   *
+   * @version 1.44.0
    */
   width?: string;
   /**
    * An event emitter notifying that the head cell has been clicked.
+   *
+   * @version 1.44.0
    */
   vegaClick: EventEmitter<VegaTableHeadCellClickEvent>;
   /**
    * An event emitter notifying that the head cell has been clicked.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   click: EventEmitter<VegaTableHeadCellClickEvent>;
   render(): VegaTableHeadCell;

package/dist/types/components/vega-table/vega-table-head-row/vega-table-head-row.d.ts

@@ -9,6 +9,9 @@ import { VegaTableDensityType } from '../interface';
 import { BreakpointsTokenType } from '../../../types/design-token.type';
 import { PageResizeObserverSlimmer } from '../../../helpers/slimmers/page-resize-observer-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.44.0
+ */
 export declare class VegaTableHeadRow {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly vegaTableHeadRowStateController: VegaTableHeadRowStateController;
@@ -53,10 +56,14 @@ export declare class VegaTableHeadRow {
   isTemplateRenderMode: boolean;
   /**
    * Indicates whether the checkbox is disabled.
+   *
+   * @version 1.44.0
    */
   selectAllDisabled?: boolean;
   /**
    * Determines whether to hide the select all checkbox.
+   *
+   * @version 1.44.0
    */
   hideSelectAll?: boolean;
   render(): VegaTableHeadRow;

package/dist/types/components/vega-table/vega-table-row/vega-table-row.d.ts

@@ -13,6 +13,9 @@ import { ResponsiveType } from '../../../types/ui.type';
 import { BreakpointsTokenType } from '../../../types/design-token.type';
 import { PageResizeObserverSlimmer } from '../../../helpers/slimmers/page-resize-observer-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.44.0
+ */
 export declare class VegaTableRow {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly vegaTableRowRenderer: VegaTableRowRenderer;
@@ -67,26 +70,34 @@ export declare class VegaTableRow {
   density?: ResponsiveType<VegaTableDensityType>;
   /**
    * Defines a unique key for the row.
+   *
+   * @version 1.44.0
    */
   rowKey: string;
   /**
    * An event emitter notifying that the row has been clicked.
+   *
+   * @version 1.44.0
    */
   vegaClick: EventEmitter<VegaTableRowClickEvent>;
   /**
    * An event emitter notifying that the row has been clicked.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   click: EventEmitter<VegaTableRowClickEvent>;
   /**
    * An event emitter notifying that the expand icon has been clicked.
+   *
+   * @version 2.20.0
    */
   vegaExpand: EventEmitter<VegaTableRowExpandEvent>;
   /**
    * An event emitter notifying that the expand icon has been clicked.
    *
    * @eventSemantics namespace:native
+   * @version 2.20.0
    */
   expand: EventEmitter<VegaTableRowExpandEvent>;
   render(): VegaTableRow;

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

@@ -27,6 +27,9 @@ import { ImmutableMap } from '../../helpers/immutable/immutable-map';
 import { VegaTableRenderModeController } from './slimmers/controllers/vega-table-render-mode-controller';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaTableSorter } from './slimmers/controllers/vega-table-sorter';
+/**
+ * @version 1.3.0
+ */
 export declare class VegaTable {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly vegaTableRenderModeController: VegaTableRenderModeController;
@@ -99,12 +102,16 @@ export declare class VegaTable {
   watchTemplateRenderMode(): void;
   /**
    * Defines the columns of the table.
+   *
+   * @version 1.3.0
    */
   columns: VegaTableColumnConfig[];
   watchColumns(): void;
   /**
    * Contains the data records to be rendered and
    *    displayed within the table.
+   *
+   * @version 1.3.0
    */
   dataSource: VegaTableDataSourceItem[];
   watchDataSource(): void;
@@ -114,6 +121,8 @@ export declare class VegaTable {
    *
    * It allows users to select one or more rows in
    *    the table for further actions or processing.
+   *
+   * @version 1.3.0
    */
   rowSelection: VegaTableRowSelectionConfig;
   watchRowSelection(): void;
@@ -123,6 +132,8 @@ export declare class VegaTable {
    */
   /**
    * Indicates whether the row is expandable.
+   *
+   * @version 1.3.0
    */
   rowExpandable: boolean;
   watchRowExpandable(): void;
@@ -130,58 +141,80 @@ export declare class VegaTable {
    * Specifies whether rows in the table can be clicked.
    *    If enabled, a `vegaRowClick` event will be
    *    dispatched when a row is clicked.
+   *
+   * @version 1.3.0
    */
   rowClickable: boolean;
   watchRowClickable(): void;
   /**
    * Specifies whether dividers should be displayed
    *    between rows in the table.
+   *
+   * @version 1.3.0
    */
   rowDivider: boolean;
   watchRowDivider(): void;
   /**
    * Specifies whether dividers should be displayed
    *    between columns in the table.
+   *
+   * @version 1.3.0
    */
   columnDivider: boolean;
   watchColumnDivider(): void;
   /**
    * Specifies whether alternate colors should be applied
    *    to the rows of the table.
+   *
+   * @version 1.3.0
    */
   striped: boolean;
   watchStriped(): void;
   /**
    * Specifies the negative space within the table's cells.
+   *
+   * @version 1.3.0
    */
   density: ResponsiveType<VegaTableDensityType>;
   watchDensity(): void;
   /**
    * Controls the amount of horizontal padding applied to the table.
+   *
+   * @version 1.3.0
    */
   paddingX: [string, string];
   watchPaddingX(): void;
   /**
    * Specifies whether the table header should be displayed.
+   *
+   * @version 1.3.0
    */
   showHeader: boolean;
   /**
    * Specifies the pagination configuration.
+   *
+   * @version 1.5.0
    */
   pagination: VegaTablePagination;
   watchPagination(): void;
   /**
    * Provides a customized message or description that is
    *    shown when the table's data source is empty.
+   *
+   * @version 1.7.0
    */
   emptyDescription: string;
   /**
    * Defines a unique key for each row in the table.
+   *
+   * @version 1.9.2
    */
   rowKey: string;
   /**
    * Customizes the behavior and appearance of the
    *    scrollable container that wraps the table.
+   *
+   * @version 1.29.0
    */
   scrollConfig?: VegaTableScrollConfig;
   watchScrollConfig(): void;
@@ -189,21 +222,28 @@ export declare class VegaTable {
    * Defines the column sorting options
    * Has optional property type: single | multiple
    * If not specified, it defaults to multiple column sorting
+   *
+   * @version 2.22.0
    */
   sortConfig?: VegaTableSortConfig;
   /**
    * An event emitter notifying changes in the table data.
+   *
+   * @version 1.3.0
    */
   vegaChange: EventEmitter<VegaTableChangePropType>;
   /**
    * An event emitter notifying changes in the table data.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter<VegaTableChangePropType>;
   /**
    * An event emitter notifying the click event of a row
    *    in the table.
+   *
+   * @version 1.3.0
    */
   vegaRowClick: EventEmitter<VegaTableRowClickPropType>;
   /**
@@ -211,11 +251,14 @@ export declare class VegaTable {
    *    in the table.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   rowClick: EventEmitter<VegaTableRowClickPropType>;
   /**
    * An event emitter notifying the expanded event of a row
    *    in the table.
+   *
+   * @version 2.24.0
    */
   vegaRowExpand: EventEmitter<VegaTableRowExpandEventDetail>;
   /**
@@ -223,21 +266,27 @@ export declare class VegaTable {
    *    in the table.
    *
    * @eventSemantics namespace:native
+   * @version 2.24.0
    */
   rowExpand: EventEmitter<VegaTableRowExpandEventDetail>;
   /**
    * An event emitter notifying when the row selection changes.
+   *
+   * @version 1.18.0
    */
   vegaSelectChange: EventEmitter<VegaTableRowSelectProp>;
   /**
    * An event emitter notifying when the selection state of all rows changes.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   selectChange: EventEmitter<VegaTableRowSelectProp>;
   /**
    * An event emitter notifying changes in the selection of checkboxes,
    *    particularly the "Select All" checkbox in the table header.
+   *
+   * @version 1.18.0
    */
   vegaSelectAllChange: EventEmitter<VegaTableSelectAllProp>;
   /**
@@ -245,26 +294,33 @@ export declare class VegaTable {
    *    particularly the "Select All" checkbox in the table header.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   selectAllChange: EventEmitter<VegaTableSelectAllProp>;
   /**
    * An event emitter notifying before the selected change when select/deselect one row
+   *
+   * @version 2.23.0
    */
   vegaRowSelect: EventEmitter<VegaTableRowSelectEventDetail>;
   /**
    * An event emitter notifying before the selected change when select/deselect one row
    *
    * @eventSemantics namespace:native
+   * @version 2.23.0
    */
   rowSelect: EventEmitter<VegaTableRowSelectEventDetail>;
   /**
    * An event emitter notifying before the selected change when select/deselect all rows
+   *
+   * @version 2.23.0
    */
   vegaRowSelectAll: EventEmitter<VegaTableRowSelectAllEventDetail>;
   /**
    * An event emitter notifying before the selected change when select/deselect all rows
    *
    * @eventSemantics namespace:native
+   * @version 2.23.0
    */
   rowSelectAll: EventEmitter<VegaTableRowSelectAllEventDetail>;
   /**
@@ -272,16 +328,20 @@ export declare class VegaTable {
    *    revealing additional content.
    *
    * @param rowKey
+   * @version 1.3.0
    */
   openExpandRow(rowKey: string): Promise<void>;
   /**
    * Invoke this method to close the expanded row with the specified `rowKey`.
    *
    * @param rowKey
+   * @version 1.3.0
    */
   closeExpandRow(rowKey: string): Promise<void>;
   /**
    * Invoke this method to close all expanded rows.
+   *
+   * @version 1.3.0
    */
   closeAllExpandRow(): Promise<void>;
   /**
@@ -290,17 +350,22 @@ export declare class VegaTable {
    *    collapsed and collapsing it if it is currently expanded.
    *
    * @param rowKey
+   * @version 1.3.0
    */
   toggleExpandRow(rowKey: string): Promise<void>;
   /**
    * Invoke this method to clear the selected row keys,
    *    removing any current selection.
+   *
+   * @version 1.3.0
    */
   clearSelection(): Promise<void>;
   /**
    * Invoke this method to retrieve the selected row keys,
    *    provided an array or list of the keys representing
    *    the currently selected rows.
+   *
+   * @version 1.3.0
    */
   getSelection(): Promise<string[]>;
   /**
@@ -309,6 +374,7 @@ export declare class VegaTable {
    *    the desired selected rows.
    *
    * @param {string[]} keys - Row keys to be set as selected.
+   * @version 1.3.0
    */
   setSelection(keys: string[]): Promise<void>;
   /**
@@ -316,6 +382,8 @@ export declare class VegaTable {
    *    with the specified `rowKey`.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   startRowEditMode(rowKey: string): Promise<void>;
   /**
@@ -323,6 +391,8 @@ export declare class VegaTable {
    *    with the specified `rowKey`.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   stopRowEditMode(rowKey: string): Promise<void>;
   /**
@@ -331,6 +401,8 @@ export declare class VegaTable {
    *    in the editing state.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   stopAllRowEditMode(): Promise<void>;
   /**
@@ -341,6 +413,8 @@ export declare class VegaTable {
    * @param rowKey The row's unique key.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   getRowData(rowKey: string): Promise<VegaTableDataSourceItem>;
   /**
@@ -349,6 +423,8 @@ export declare class VegaTable {
    *    associated with each row.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   getRowsData(): Promise<VegaTableDataSourceItem[]>;
   /**
@@ -361,6 +437,8 @@ export declare class VegaTable {
    * @param optional rowKey
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   getFormRef(rowKey?: string): Promise<HTMLVegaFormElement>;
   /**
@@ -370,6 +448,8 @@ export declare class VegaTable {
    * @returns {Promise<string>} the rowKey of the new row
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   addNewRow(record?: VegaTableDataSourceItem): Promise<string>;
   /**
@@ -380,6 +460,8 @@ export declare class VegaTable {
    * This action will not affect the editing mode of other rows.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   saveEditRow(rowKey: string): Promise<void>;
   /**
@@ -388,6 +470,8 @@ export declare class VegaTable {
    *    all rows in the table.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   saveAllEditRows(): Promise<void>;
   /**
@@ -395,6 +479,8 @@ export declare class VegaTable {
    *    in the editing mode in the table.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   getEditingRowsKey(): Promise<string[]>;
   /**
@@ -404,6 +490,8 @@ export declare class VegaTable {
    * @param rowKey The rowKey of the row to remove.
    *
    * @VegaWarning Note: This method only works with editable tables.
+   *
+   * @version 1.19.0
    */
   removeRow(rowKey: string): Promise<void>;
   render(): VegaTable;

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

@@ -2,6 +2,9 @@ import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { VegaTextTooltipProps } from './types';
 import { VegaTextTooltipRenderer } from './slimmers/renderers/vega-text-tooltip-renderer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.9.1
+ */
 export declare class VegaText {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly tooltipRenderer: VegaTextTooltipRenderer;
@@ -10,10 +13,14 @@ export declare class VegaText {
   /**
    * Specifies the behavior of text when it exceeds the
    *    available space within its container.
+   *
+   * @version 1.18.0
    */
   overflow: 'ellipsis' | 'newline';
   /**
    * Specifies the properties of the vega-tooltip in vega-text.
+   *
+   * @version 2.0.0
    */
   tooltip: VegaTextTooltipProps;
   /**