@globalpayments/vega 2.24.0 → 2.24.2

package/dist/collection/components/vega-button-link/vega-button-link.js

@@ -12,6 +12,9 @@ import { VegaClick } from '../../helpers/event-manager/event-id/vega-event-id';
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaButtonLinkRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/vega-button-link/runtime-metrics-payload-definition';
+/**
+ * @version 1.0.2
+ */
 export class VegaButtonLink {
   constructor() {
     this.globalSlimmers = {};
@@ -20,10 +23,14 @@ export class VegaButtonLink {
     this.vegaComponentUsageRuntimeMetricsSlimmer = new VegaComponentUsageRuntimeMetricsSlimmer(VegaButtonLinkRuntimeMetricsPayloadDefinition);
     /**
      * Specifies the URL associated with the button link.
+     *
+     * @version 1.0.4
      */
     this.link = VegaButtonLink.defaultLink;
     /**
      * Specifies the size of the button link.
+     *
+     * @version 1.0.2
      */
     this.size = 'default';
     /**
@@ -37,24 +44,35 @@ export 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
      */
     this.iconType = 'icon';
     /**
      * Specifies the placement of the icon in relation to
      *    the button link's label.
+     *
+     * @version 1.3.0
      */
     this.iconAlign = 'left';
     /**
      * Specifies the text displayed on the button link.
+     *
+     * @version 1.0.4
      */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.label = '';
     /**
      * Specifies whether the button link element is disabled.
+     *
+     * @version 1.3.0
      */
     this.disabled = false;
     /**
      * Indicates the danger status of the button link,
      *    typically used for destructive actions.
+     *
+     * @version 1.3.0
      */
     this.danger = false;
     /**
@@ -66,6 +84,8 @@ export 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
      */
     this.eventful = true;
     this.onClick = (e) => {
@@ -157,7 +177,10 @@ export class VegaButtonLink {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.4"
+          }],
         "text": "Specifies the URL associated with the button link."
       },
       "attribute": "link",
@@ -175,7 +198,10 @@ export class VegaButtonLink {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.2"
+          }],
         "text": "Specifies the size of the button link."
       },
       "attribute": "size",
@@ -193,7 +219,10 @@ export class VegaButtonLink {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.4"
+          }],
         "text": "Specifies the icon to be displayed on the button link,\n   which can be selected from a list of predefined icon tokens\n   or specified using a Font Awesome class."
       },
       "attribute": "icon",
@@ -210,7 +239,10 @@ export class VegaButtonLink {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.5"
+          }],
         "text": "Specifies the type of icon used in the button link.\n\nThe following options are available for the `iconType` parameter:\n- `icon`:\n     The icon is rendered as a regular icon without\n     any additional styling or background.\n- `button`:\n     The icon is rendered with a circular background,\n     providing additional emphasis and visual prominence\n     to the icon in the button link."
       },
       "attribute": "icon-type",
@@ -228,7 +260,10 @@ export class VegaButtonLink {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies the placement of the icon in relation to\n   the button link's label."
       },
       "attribute": "icon-align",
@@ -246,7 +281,10 @@ export class VegaButtonLink {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.4"
+          }],
         "text": "Specifies the text displayed on the button link."
       },
       "attribute": "label",
@@ -264,7 +302,10 @@ export class VegaButtonLink {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies whether the button link element is disabled."
       },
       "attribute": "disabled",
@@ -282,7 +323,10 @@ export class VegaButtonLink {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Indicates the danger status of the button link,\n   typically used for destructive actions."
       },
       "attribute": "danger",
@@ -303,6 +347,9 @@ export class VegaButtonLink {
         "tags": [{
             "name": "deprecated",
             "text": "Setting the `link` property internally manages the eventful state of a Button Link."
+          }, {
+            "name": "version",
+            "text": "1.3.0"
           }],
         "text": "Specifies whether the button link will emit a vegaClick event when clicked.\n\n- If set to `true`, the event will be emitted.\n- If set to `false`, the component will function as\n   a regular link to another page or URL,\n   and no events will be emitted."
       },
@@ -318,7 +365,10 @@ export class VegaButtonLink {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.11"
+          }],
         "text": "An event emitter notifying the click event of the button."
       },
       "complexType": {
@@ -336,6 +386,9 @@ export class VegaButtonLink {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the click event of the button."
       },

package/dist/collection/components/vega-calendar/vega-calendar-event/vega-calendar-event.js

@@ -14,6 +14,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 class VegaCalendarEvent {
   constructor() {
     this.globalSlimmer = {};
@@ -66,7 +69,10 @@ export class VegaCalendarEvent {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.14.0"
+          }],
         "text": "Specifies the calendar event."
       }
     }

package/dist/collection/components/vega-calendar/vega-calendar-event-slot/vega-calendar-event-slot.js

@@ -9,6 +9,9 @@ import { sanitizeVegaComponent } from '../../../utils/component';
 import { InjectVegaGlobalSlimmer, InjectVegaSlimmer } from 'vega-slimmer/core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
 import { getCalendarEventSlotName } from '../utils';
+/**
+ * @version 2.19.0
+ */
 export class VegaCalendarEventSlot {
   constructor() {
     this.globalSlimmer = {};
@@ -38,7 +41,10 @@ export class VegaCalendarEventSlot {
       "required": true,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.19.0"
+          }],
         "text": "Specifies the event key."
       },
       "attribute": "event-key",

package/dist/collection/components/vega-calendar/vega-calendar.js

@@ -29,6 +29,9 @@ import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/
 import { VegaCalendarFullDayEventLayoutRenderer } from './slimmers/common/renderers/vega-calendar-full-day-event-layout-renderer';
 import { createSubStateNotifySlimmer } from '../../helpers/slimmers/sub-state/sub-state-notify-slimmer';
 import { VegaCalendarFullDayEventMoreButtonRenderer } from './slimmers/day-view/renderers/full-day-event/vega-calendar-full-day-event-more-button-renderer';
+/**
+ * @version 2.14.0
+ */
 export class VegaCalendar {
   constructor() {
     this.globalSlimmer = {};
@@ -62,15 +65,21 @@ export class VegaCalendar {
     this.calendarEvents = [];
     /**
      * Specifies the current view mode of the calendar.
+     *
+     * @version 2.14.0
      */
-    /* eslint-disable @stencil/strict-mutable */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.viewMode = 'month';
     /**
      * Specifies the time format of the calendar.
+     *
+     * @version 2.14.0
      */
     this.timeFormat = '24-hour';
     /**
      * Controls the visibility of the calendar's event color bar.
+     *
+     * @version 2.21.0
      */
     this.showEventColorBar = true;
   }
@@ -143,7 +152,10 @@ export class VegaCalendar {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.14.0"
+          }],
         "text": "Specifies the current view mode of the calendar."
       },
       "attribute": "view-mode",
@@ -166,7 +178,10 @@ export class VegaCalendar {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.14.0"
+          }],
         "text": "Specifies the events of the calendar."
       }
     },
@@ -186,7 +201,10 @@ export class VegaCalendar {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.14.0"
+          }],
         "text": "Specifies the time format of the calendar."
       },
       "attribute": "time-format",
@@ -209,7 +227,10 @@ export class VegaCalendar {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.20.0"
+          }],
         "text": "Defines the configuration options for the more action button's dropdown menu."
       }
     },
@@ -224,7 +245,10 @@ export class VegaCalendar {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.21.0"
+          }],
         "text": "Controls the visibility of the calendar's event color bar."
       },
       "attribute": "show-event-color-bar",
@@ -245,7 +269,10 @@ export class VegaCalendar {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.14.0"
+          }],
         "text": "An event emitter notifying the component view content change after a switch panel click."
       },
       "complexType": {
@@ -268,6 +295,9 @@ export class VegaCalendar {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.14.0"
           }],
         "text": "An event emitter notifying the component view content change after a switch panel click."
       },
@@ -288,7 +318,10 @@ export class VegaCalendar {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.14.0"
+          }],
         "text": "An event emitter notifying that a component event item is clicked."
       },
       "complexType": {
@@ -311,6 +344,9 @@ export class VegaCalendar {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.14.0"
           }],
         "text": "An event emitter notifying that a component event item is clicked."
       },
@@ -331,7 +367,10 @@ export class VegaCalendar {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.17.0"
+          }],
         "text": "An event emitter notifying that a calendar date item has been double-clicked."
       },
       "complexType": {
@@ -354,6 +393,9 @@ export class VegaCalendar {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.17.0"
           }],
         "text": "An event emitter notifying that a calendar date item has been double-clicked."
       },
@@ -374,7 +416,10 @@ export class VegaCalendar {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.20.0"
+          }],
         "text": "An event emitter notifying that a calendar more action menu item has been clicked."
       },
       "complexType": {
@@ -392,6 +437,9 @@ export class VegaCalendar {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.20.0"
           }],
         "text": "An event emitter notifying that a calendar more action menu item has been clicked."
       },

package/dist/collection/components/vega-card/vega-card.js

@@ -13,6 +13,9 @@ import { arrayToClassString } from '../../utils/ui';
 import { InjectVegaGlobalSlimmer, InjectVegaSlimmer } from 'vega-slimmer/core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaCardRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/vega-card/runtime-metrics-payload-definition';
+/**
+ * @version 1.0.4
+ */
 export class VegaCard {
   constructor() {
     this.globalSlimmers = {};
@@ -21,6 +24,8 @@ export class VegaCard {
      * Defines the background color of the card element.
      *    It accepts a string value representing a valid
      *    background color token.
+     *
+     * @version 1.3.0
      */
     this.backgroundColor = 'bg-primary';
     /**
@@ -93,7 +98,10 @@ export class VegaCard {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.4"
+          }],
         "text": "Specifies the padding within the card.\n   It can be set as ResponsiveType or any sizing token."
       },
       "attribute": "padding",
@@ -119,7 +127,10 @@ export class VegaCard {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies the margin for the card.\n   It can be set as ResponsiveType or any sizing token."
       },
       "attribute": "margin",
@@ -136,7 +147,10 @@ export class VegaCard {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.26.0"
+          }],
         "text": "Determines whether the card is rendered with a shadow or a border.\n   By default, cards are rendered without a shadow or border."
       },
       "attribute": "variant",
@@ -158,7 +172,10 @@ export class VegaCard {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Defines the background color of the card element.\n   It accepts a string value representing a valid\n   background color token."
       },
       "attribute": "background-color",

package/dist/collection/components/vega-carousel/vega-carousel.js

@@ -18,6 +18,9 @@ import { VegaPageUpdate } from '../../helpers/event-manager/event-id/vega-event-
 import { createDeprecatedPropertySlimmer, } from '../../helpers/slimmers/deprecated-property-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaCarouselRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/vega-carousel/runtime-metrics-payload-definition';
+/**
+ * @version 1.0.2
+ */
 export class VegaCarousel {
   constructor() {
     this.globalSlimmers = {};
@@ -38,26 +41,36 @@ export 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
      */
     this.perPage = 1;
     /**
      * Specifies the number of items displayed per page in the carousel.
+     *
+     * @version 2.1.0
      */
     this.itemsPerPage = 1;
     /**
      * Specifies whether to show the navigational buttons
      *    at the bottom of the carousel.
+     *
+     * @version 1.0.2
      */
     this.showSlider = true;
     /**
      * 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
      */
     this.spacing = 'size-16';
     /**
      * Indicates whether the carousel can be swiped
      *    to navigate between pages on a mobile device.
+     *
+     * @version 1.18.0
      */
     this.canSwipe = true;
     this.onClickIndicators = async (e) => {
@@ -137,6 +150,8 @@ export class VegaCarousel {
   /**
    * Invoke this method to transition the carousel to the next available page,
    *    if it exists.
+   *
+   * @version 1.0.2
    */
   async nextPage() {
     const nextPage = this.page < this.totalPages ? this.page + 1 : this.page;
@@ -145,6 +160,8 @@ export class VegaCarousel {
   /**
    * Invoke this method to transition the carousel to the previous page,
    *    if it exists.
+   *
+   * @version 1.0.2
    */
   async prevPage() {
     const nextPage = this.page > 1 ? this.page - 1 : this.page;
@@ -155,6 +172,7 @@ export class VegaCarousel {
    *
    * @param nextPage
    * @returns {Promise<void>}
+   * @version 1.0.6
    */
   async goToPage(nextPage) {
     await this.goToPageInternal(nextPage);
@@ -316,6 +334,9 @@ export class VegaCarousel {
         "tags": [{
             "name": "deprecated",
             "text": "This property will be removed soon and replaced by prop itemsPerPage"
+          }, {
+            "name": "version",
+            "text": "1.0.2"
           }],
         "text": "Specifies the number of elements displayed per page in the carousel."
       },
@@ -339,7 +360,10 @@ export class VegaCarousel {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.1.0"
+          }],
         "text": "Specifies the number of items displayed per page in the carousel."
       },
       "attribute": "items-per-page",
@@ -357,7 +381,10 @@ export class VegaCarousel {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.2"
+          }],
         "text": "Specifies whether to show the navigational buttons\n   at the bottom of the carousel."
       },
       "attribute": "show-slider",
@@ -380,7 +407,10 @@ export class VegaCarousel {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.2"
+          }],
         "text": "Controls the amount of space between the elements in the carousel\n   when more than one element is displayed on each page\n   using the `itemsPerPage` property."
       },
       "attribute": "spacing",
@@ -398,7 +428,10 @@ export class VegaCarousel {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.18.0"
+          }],
         "text": "Indicates whether the carousel can be swiped\n   to navigate between pages on a mobile device."
       },
       "attribute": "can-swipe",
@@ -417,7 +450,10 @@ export class VegaCarousel {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "An event emitter notifying the transition of the carousel to another page,\n   whether triggered programmatically or through user interaction."
       },
       "complexType": {
@@ -435,6 +471,9 @@ export class VegaCarousel {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the transition of the carousel to another page,\n   whether triggered programmatically or through user interaction."
       },
@@ -458,7 +497,10 @@ export class VegaCarousel {
       },
       "docs": {
         "text": "Invoke this method to transition the carousel to the next available page,\n   if it exists.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.0.2"
+          }]
       }
     },
     "prevPage": {
@@ -474,7 +516,10 @@ export class VegaCarousel {
       },
       "docs": {
         "text": "Invoke this method to transition the carousel to the previous page,\n   if it exists.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.0.2"
+          }]
       }
     },
     "goToPage": {
@@ -502,6 +547,9 @@ export class VegaCarousel {
           }, {
             "name": "returns",
             "text": undefined
+          }, {
+            "name": "version",
+            "text": "1.0.6"
           }]
       }
     }