@globalpayments/vega 2.23.0 → 2.24.2

package/dist/collection/components/vega-app-footer/vega-app-footer.js

@@ -9,6 +9,9 @@ import { HEARTLAND_PRIVACY_URL, HEARTLAND_TOS_URL, HEARTLAND_GOOGLE_PRIVACY_POLI
 import { sanitizeVegaComponent } from '../../utils/component';
 import { InjectVegaGlobalSlimmer, InjectVegaSlimmer } from 'vega-slimmer/core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.3.0
+ */
 export class VegaAppFooter {
   constructor() {
     this.globalSlimmers = {};
@@ -20,60 +23,82 @@ export class VegaAppFooter {
      *
      * By default, it includes Heartland's official copyright message
      *    with a reference to the current year.
+     *
+     * @version 1.15.0
      */
     this.content = `© ${new Date().getFullYear()} Heartland Payment Systems, LLC – a Global Payments company. All rights reserved.`;
     /**
      * Specifies the label or text to be displayed
      *    for the Terms of Use link in the app footer.
+     *
+     * @version 1.15.0
      */
     this.termOfUseLabel = 'Terms of Use';
     /**
      * Specifies the URL or web address that the Terms of Use link
      *    in the app footer should navigate to when clicked.
+     *
+     * @version 1.15.0
      */
     this.termOfUseUrl = HEARTLAND_TOS_URL;
     /**
      * Specifies the target window or browsing context in which
      *    the Terms of Use URL should be opened
      *    when the user clicks on the link.
+     *
+     * @version 1.27.3
      */
     this.termOfUseUrlTarget = '_self';
     /**
      * Specifies the label or text to be displayed
      *    for the Privacy Policy link in the app footer.
+     *
+     * @version 1.15.0
      */
     this.privacyPolicyLabel = 'Privacy Policy';
     /**
      * Specifies the URL or web address that the
      *    Privacy Policy link in the app footer should
      *    navigate to when clicked.
+     *
+     * @version 1.15.0
      */
     this.privacyPolicyUrl = HEARTLAND_PRIVACY_URL;
     /**
      * Specifies the target window or browsing context
      *    in which the Privacy Policy URL should be opened
      *    when the user clicks on the link.
+     *
+     * @version 1.27.3
      */
     this.privacyPolicyUrlTarget = '_self';
     /**
      * Specifies whether to hide the default Term of Use
      *    and Privacy Policy links.
+     *
+     * @version 1.35.1
      */
     this.hideDefaultLinks = false;
     /**
      * Specifies additional links that can be included
      *    in the app footer.
+     *
+     * @version 1.15.0
      */
     this.additionalLinks = [];
     /**
      * Specifies whether the app footer should display
      *    a predetermined disclaimer message and link
      *    to indicate that the site uses Google reCAPTCHA.
+     *
+     * @version 1.3.0
      */
     this.showDisclaimer = false;
     /**
      * Specifies the target window or tab when the user clicks
      *    on the Disclaimer link in the app footer.
+     *
+     * @version 1.27.3
      */
     this.disclaimerUrlTarget = '_self';
   }
@@ -146,7 +171,10 @@ export class VegaAppFooter {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.15.0"
+          }],
         "text": "Specifies the content to be displayed in the app footer.\n\nBy default, it includes Heartland's official copyright message\n   with a reference to the current year."
       },
       "attribute": "content",
@@ -164,7 +192,10 @@ export class VegaAppFooter {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.15.0"
+          }],
         "text": "Specifies the label or text to be displayed\n   for the Terms of Use link in the app footer."
       },
       "attribute": "term-of-use-label",
@@ -182,7 +213,10 @@ export class VegaAppFooter {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.15.0"
+          }],
         "text": "Specifies the URL or web address that the Terms of Use link\n   in the app footer should navigate to when clicked."
       },
       "attribute": "term-of-use-url",
@@ -205,7 +239,10 @@ export class VegaAppFooter {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.27.3"
+          }],
         "text": "Specifies the target window or browsing context in which\n   the Terms of Use URL should be opened\n   when the user clicks on the link."
       },
       "attribute": "term-of-use-url-target",
@@ -223,7 +260,10 @@ export class VegaAppFooter {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.15.0"
+          }],
         "text": "Specifies the label or text to be displayed\n   for the Privacy Policy link in the app footer."
       },
       "attribute": "privacy-policy-label",
@@ -241,7 +281,10 @@ export class VegaAppFooter {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.15.0"
+          }],
         "text": "Specifies the URL or web address that the\n   Privacy Policy link in the app footer should\n   navigate to when clicked."
       },
       "attribute": "privacy-policy-url",
@@ -264,7 +307,10 @@ export class VegaAppFooter {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.27.3"
+          }],
         "text": "Specifies the target window or browsing context\n   in which the Privacy Policy URL should be opened\n   when the user clicks on the link."
       },
       "attribute": "privacy-policy-url-target",
@@ -282,7 +328,10 @@ export class VegaAppFooter {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.35.1"
+          }],
         "text": "Specifies whether to hide the default Term of Use\n   and Privacy Policy links."
       },
       "attribute": "hide-default-links",
@@ -305,7 +354,10 @@ export class VegaAppFooter {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.15.0"
+          }],
         "text": "Specifies additional links that can be included\n   in the app footer."
       },
       "defaultValue": "[]"
@@ -321,7 +373,10 @@ export class VegaAppFooter {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies whether the app footer should display\n   a predetermined disclaimer message and link\n   to indicate that the site uses Google reCAPTCHA."
       },
       "attribute": "show-disclaimer",
@@ -344,7 +399,10 @@ export class VegaAppFooter {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.27.3"
+          }],
         "text": "Specifies the target window or tab when the user clicks\n   on the Disclaimer link in the app footer."
       },
       "attribute": "disclaimer-url-target",

package/dist/collection/components/vega-app-header-button/vega-app-header-button.js

@@ -19,6 +19,9 @@ import { DomNodeSubjectObserverFactory } from '../../helpers/change-manager/subj
 import { VegaClick, VegaDropdownClick, VegaDropdownHide, VegaDropdownShow, } from '../../helpers/event-manager/event-id/vega-event-id';
 import { VegaMenuArrowIconRenderer } from './slimmers/renderers/vega-menu-arrow-icon-renderer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.11.0
+ */
 export class VegaAppHeaderButton {
   constructor() {
     this.globalSlimmers = {};
@@ -45,42 +48,60 @@ export class VegaAppHeaderButton {
     /**
      * Specifies the configuration for the dropdown functionality
      *    of the app header button.
+     *
+     * @version 1.11.0
      */
     this.dropdown = null;
     /**
      * Specifies the size of the app header button.
+     *
+     * @version 1.11.0
      */
     this.size = 'default';
     /**
      * Specifies the label or text content of the app header button.
+     *
+     * @version 1.11.0
      */
     this.label = '';
     /**
      * Determines whether to display the label of the app header button
      *    directly on the button itself or in a tooltip
      *    when the user hovers over the button.
+     *
+     * @version 1.11.0
      */
     this.showLabel = true;
     /**
      * Specifies the configuration for the avatar image or icon
      *    displayed in the app header button.
+     *
+     * @version 1.11.0
      */
     this.avatar = {};
     /**
      * Specifies the position of the avatar in relation to the label
      *    within the app header button.
+     *
+     * @version 1.11.0
      */
     this.avatarPosition = 'left';
     /**
      * Specifies whether to show a border around the app header button.
+     *
+     * @version 1.11.0
      */
     this.showBorder = false;
     /**
      * Specifies whether to display a menu arrow icon in the app header button.
+     *
+     * @version 1.11.0
      */
     this.showMenuArrowIcon = true;
     /**
      * Specifies whether the app header button is displayed in a selected state.
+     *
+     * @version 1.15.0
      */
     this.selected = false;
     this.renderButton = (arrowDownIconVisible, labelVisible) => {
@@ -242,7 +263,10 @@ export class VegaAppHeaderButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies the configuration for the dropdown functionality\n   of the app header button."
       },
       "defaultValue": "null"
@@ -267,7 +291,10 @@ export class VegaAppHeaderButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies the size of the app header button."
       },
       "attribute": "size",
@@ -285,7 +312,10 @@ export class VegaAppHeaderButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies the label or text content of the app header button."
       },
       "attribute": "label",
@@ -303,7 +333,10 @@ export class VegaAppHeaderButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Determines whether to display the label of the app header button\n   directly on the button itself or in a tooltip\n   when the user hovers over the button."
       },
       "attribute": "show-label",
@@ -326,7 +359,10 @@ export class VegaAppHeaderButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies the configuration for the avatar image or icon\n   displayed in the app header button."
       },
       "defaultValue": "{}"
@@ -342,7 +378,10 @@ export class VegaAppHeaderButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies the position of the avatar in relation to the label\n   within the app header button."
       },
       "attribute": "avatar-position",
@@ -360,7 +399,10 @@ export class VegaAppHeaderButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies whether to show a border around the app header button."
       },
       "attribute": "show-border",
@@ -378,7 +420,10 @@ export class VegaAppHeaderButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies whether to display a menu arrow icon in the app header button."
       },
       "attribute": "show-menu-arrow-icon",
@@ -396,7 +441,10 @@ export class VegaAppHeaderButton {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.15.0"
+          }],
         "text": "Specifies whether the app header button is displayed in a selected state."
       },
       "attribute": "selected",
@@ -415,7 +463,10 @@ export class VegaAppHeaderButton {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "An event emitter notifying the click event of an app header button."
       },
       "complexType": {
@@ -433,6 +484,9 @@ export class VegaAppHeaderButton {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the click event of an app header button."
       },
@@ -448,7 +502,10 @@ export class VegaAppHeaderButton {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.23.0"
+          }],
         "text": "An event emitter notifying the click event of a dropdown item\n   in the app header."
       },
       "complexType": {
@@ -466,6 +523,9 @@ export class VegaAppHeaderButton {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the click event of a dropdown item\n   in the app header."
       },

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

@@ -10,6 +10,9 @@ import { InjectVegaGlobalSlimmer, InjectVegaSlimmer, methodPlaceholder, } from '
 import { VegaBackdropVisibleController } from './slimmers/controller/vega-backdrop-visible-controller';
 import { VegaBackdropRenderer } from './slimmers/renerers/vega-backdrop-renderer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 2.0.0
+ */
 export class VegaBackdrop {
   constructor() {
     this.globalSlimmers = {};
@@ -18,10 +21,14 @@ export class VegaBackdrop {
     this.vegaComponentUsageRuntimeMetricsSlimmer = new VegaComponentUsageRuntimeMetricsSlimmer();
     /**
      * Defines the color of the backdrop element.
+     *
+     * @version 2.0.0
      */
     this.color = 'bg-backdrop-modal';
     /**
      * Whether to show or hide the backdrop
+     *
+     * @version 2.0.0
      */
     this.visible = false;
   }
@@ -51,7 +58,10 @@ export class VegaBackdrop {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.0.0"
+          }],
         "text": "Defines the color of the backdrop element."
       },
       "attribute": "color",
@@ -69,7 +79,10 @@ export class VegaBackdrop {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.0.0"
+          }],
         "text": "Whether to show or hide the backdrop"
       },
       "attribute": "visible",
@@ -87,7 +100,10 @@ export class VegaBackdrop {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.0.0"
+          }],
         "text": "The duration of the animation in milliseconds."
       },
       "attribute": "duration",
@@ -101,7 +117,10 @@ export class VegaBackdrop {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.0.0"
+          }],
         "text": "An event emitter notifying the click event of the backdrop."
       },
       "complexType": {

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

@@ -13,6 +13,9 @@ import { VegaBannerActionButtonRenderer } from './slimmers/renderers/vega-banner
 import { createEventEmitSlimmer, } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { VegaActionButtonClick, VegaClose } from '../../helpers/event-manager/event-id/vega-event-id';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.9.1
+ */
 export class VegaBanner {
   constructor() {
     this.globalSlimmers = {};
@@ -24,33 +27,47 @@ export class VegaBanner {
     this.actionButtonClickEventEmitter = createEventEmitSlimmer(VegaBanner, VegaActionButtonClick);
     /**
      * Specifies the type of the banner.
+     *
+     * @version 2.8.0
      */
     this.type = 'info';
     /**
      * Specifies the label or title for the banner.
+     *
+     * @version 2.8.0
      */
     this.bannerTitle = '';
     /**
      * Specifies the content displayed within the banner.
+     *
+     * @version 2.8.0
      */
     this.content = '';
     /**
      * Specifies the action buttons available within the banner.
      *    These buttons enable users to perform specific actions,
      *    enhancing user interaction within the banner.
+     *
+     * @version 2.8.0
      */
     this.actionButtons = null;
     /**
      * Determines whether the close icon is displayed.
+     *
+     * @version 1.13.0
      */
     this.showCloseButton = true;
     /**
      * Determines whether the banner is displayed.
+     *
+     * @version 2.13.0
      */
     this.isOpen = true;
   }
   /**
    * Invoke this method to close the banner.
+   *
+   * @version 2.8.0
    */
   async doClose() {
     this.host.remove();
@@ -84,7 +101,10 @@ export class VegaBanner {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.8.0"
+          }],
         "text": "Specifies the type of the banner."
       },
       "attribute": "type",
@@ -102,7 +122,10 @@ export class VegaBanner {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.8.0"
+          }],
         "text": "Specifies the label or title for the banner."
       },
       "attribute": "banner-title",
@@ -120,7 +143,10 @@ export class VegaBanner {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.8.0"
+          }],
         "text": "Specifies the content displayed within the banner."
       },
       "attribute": "content",
@@ -143,7 +169,10 @@ export class VegaBanner {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.8.0"
+          }],
         "text": "Specifies the action buttons available within the banner.\n   These buttons enable users to perform specific actions,\n   enhancing user interaction within the banner."
       },
       "defaultValue": "null"
@@ -159,7 +188,10 @@ export class VegaBanner {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Determines whether the close icon is displayed."
       },
       "attribute": "show-close-button",
@@ -177,7 +209,10 @@ export class VegaBanner {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.13.0"
+          }],
         "text": "Determines whether the banner is displayed."
       },
       "attribute": "is-open",
@@ -192,7 +227,10 @@ export class VegaBanner {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "An event emitter notifying the banner close event."
       },
       "complexType": {
@@ -210,6 +248,9 @@ export class VegaBanner {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.8.0"
           }],
         "text": "An event emitter notifying the banner close event."
       },
@@ -225,7 +266,10 @@ export class VegaBanner {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.18.0"
+          }],
         "text": "An event emitter notifying the banner action button has been clicked."
       },
       "complexType": {
@@ -248,6 +292,9 @@ export class VegaBanner {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.18.0"
           }],
         "text": "An event emitter notifying the banner action button has been clicked."
       },
@@ -276,7 +323,10 @@ export class VegaBanner {
       },
       "docs": {
         "text": "Invoke this method to close the banner.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "2.8.0"
+          }]
       }
     }
   }; }