@globalpayments/vega 2.23.0 → 2.24.2

package/dist/collection/components/vega-color-picker/vega-color-picker.js

@@ -17,6 +17,9 @@ import ChangeManager from '../../helpers/change-manager/change-manager';
 import { VegaChange } from '../../helpers/event-manager/event-id/vega-event-id';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaColorPickerRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/vega-color-picker/runtime-metrics-payload-definition';
+/**
+ * @version 1.13.0
+ */
 export class VegaColorPicker {
   constructor() {
     this.globalSlimmers = {};
@@ -38,20 +41,29 @@ export class VegaColorPicker {
     /**
      * Specifies the initial or preset color value of the color picker.
      *    It is represented as a hexadecimal string.
+     *
+     * @version 1.13.0
      */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.value = '';
     /**
      * Displays a supplementary prompt message that assists users
      *    in understanding the expected value for the color picker.
+     *
+     * @version 1.13.0
      */
     this.hint = '';
     /**
      * Specifies whether the color picker element is disabled.
+     *
+     * @version 1.13.0
      */
     this.disabled = false;
     /**
      * Specifies whether a color must be selected for
      *    the color picker to pass form validation.
+     *
+     * @version 1.13.0
      */
     this.required = false;
     /**
@@ -59,26 +71,36 @@ export class VegaColorPicker {
      *
      * It provides descriptive text that helps identify
      *    the purpose or content expected in the color picker.
+     *
+     * @version 1.13.0
      */
     this.label = '';
     /**
      * Specifies the validation status of the color picker component.
+     *
+     * @version 1.13.0
      */
-    /* eslint-disable @stencil/strict-mutable */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.isValid = null;
     /**
      * Determines whether automatic validation should be implemented
      *  for the color picker when a color is selected.
+     *
+     * @version 1.13.0
      */
     this.autoValidation = true;
     /**
      * Specifies custom validation rules for the color picker.
+     *
+     * @version 1.13.0
      */
     this.validationRules = [];
     /**
      * Defines custom color options for the color picker.
      *
      * It should be an array of hexadecimal strings representing different colors.
+     *
+     * @version 1.13.0
      */
     this.colors = [
       '#73E6DC',
@@ -177,7 +199,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Specifies the initial or preset color value of the color picker.\n   It is represented as a hexadecimal string."
       },
       "attribute": "value",
@@ -195,7 +220,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Displays a supplementary prompt message that assists users\n   in understanding the expected value for the color picker."
       },
       "attribute": "hint",
@@ -213,7 +241,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Specifies whether the color picker element is disabled."
       },
       "attribute": "disabled",
@@ -231,7 +262,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Specifies whether a color must be selected for\n   the color picker to pass form validation."
       },
       "attribute": "required",
@@ -249,7 +283,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Specifies the label or title for the color picker.\n\nIt provides descriptive text that helps identify\n   the purpose or content expected in the color picker."
       },
       "attribute": "label",
@@ -267,7 +304,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Specifies the validation status of the color picker component."
       },
       "attribute": "is-valid",
@@ -285,7 +325,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Determines whether automatic validation should be implemented\n for the color picker when a color is selected."
       },
       "attribute": "auto-validation",
@@ -308,7 +351,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Specifies custom validation rules for the color picker."
       },
       "defaultValue": "[]"
@@ -324,7 +370,10 @@ export class VegaColorPicker {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "Defines custom color options for the color picker.\n\nIt should be an array of hexadecimal strings representing different colors."
       },
       "defaultValue": "[\n\t\t'#73E6DC',\n\t\t'#806BFF',\n\t\t'#FFDC83',\n\t\t'#FF9571',\n\t\t'#00BBFF',\n\t\t'#FF82C9',\n\t\t'#259F9F',\n\t\t'#563D82',\n\t]"
@@ -337,7 +386,10 @@ export class VegaColorPicker {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.13.0"
+          }],
         "text": "An event emitter notifying changes in the value of the color picker,\n   whether triggered programmatically or through user interaction."
       },
       "complexType": {
@@ -355,6 +407,9 @@ export class VegaColorPicker {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying changes in the value of the color picker,\n   whether triggered programmatically or through user interaction."
       },

package/dist/collection/components/vega-combo-box/vega-combo-box.js

@@ -21,6 +21,9 @@ import { FORM_ELEMENT_VALUE_CHANGE } from '../../helpers/change-manager/subject/
 import ChangeManager from '../../helpers/change-manager/change-manager';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaComboBoxRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/vega-combo-box/runtime-metrics-payload-definition';
+/**
+ * @version 1.11.0
+ */
 export class VegaComboBox {
   constructor() {
     this.globalSlimmers = {};
@@ -51,40 +54,57 @@ export class VegaComboBox {
      *
      * It provides descriptive text that helps identify the
      *    purpose or content expected in the combo box.
+     *
+     * @version 1.11.0
      */
     this.label = '';
     /**
      * Specifies whether a value must be entered for the
      *    combo box to pass form validation.
+     *
+     * @version 1.11.0
      */
     this.required = false;
     /**
      * Specifies the source data used to populate the
      *    dropdown menu associated with the combo box.
+     *
+     * @version 1.11.0
      */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.source = [];
     /**
      * 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
      */
     this.value = [];
     /**
      * Specifies the validation status of the combo box component.
+     *
+     * @version 1.11.0
      */
-    /* eslint-disable @stencil/strict-mutable */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.isValid = null;
     /**
      * Determines whether automatic validation should be implemented
      *    when a value is edited in the combo box.
+     *
+     * @version 1.11.0
      */
     this.autoValidation = true;
     /**
      * Specifies custom validation rules for the combo box.
+     *
+     * @version 1.11.0
      */
     this.validationRules = [];
     /**
      * Specifies whether the combo box element is disabled.
+     *
+     * @version 1.11.0
      */
     this.disabled = false;
     /**
@@ -92,21 +112,29 @@ export class VegaComboBox {
      *    or example inside the combo box input field.
      *
      * It indicates the expected format or pattern of the input.
+     *
+     * @version 1.11.0
      */
     this.placeholder = '';
     /**
      * Provides a supplementary prompt message that is displayed
      *    alongside the combo box input field.
+     *
+     * @version 1.11.0
      */
     this.hint = '';
     /**
      * Specifies the size of the combo box.
+     *
+     * @version 1.11.0
      */
     this.size = 'medium';
     /**
      * 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
      */
     this.vegaDropdownProps = {};
     /**
@@ -115,6 +143,8 @@ export class VegaComboBox {
      *
      * Setting this property to `false` enables custom text input handling
      *    by listening for the `vegaSearch` event.
+     *
+     * @version 1.24.0
      */
     this.useDefaultFilter = true;
     this.onItemClick = async () => {
@@ -182,6 +212,8 @@ export class VegaComboBox {
   }
   /**
    * Invoke this method to close the dropdown menu associated with the combo box.
+   *
+   * @version 1.11.0
    */
   async close() {
     if (!this.disabled) {
@@ -190,6 +222,8 @@ export class VegaComboBox {
   }
   /**
    * Invoke this method to open the dropdown menu associated with the combo box.
+   *
+   * @version 1.11.0
    */
   async open() {
     if (!this.disabled) {
@@ -316,7 +350,10 @@ export class VegaComboBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies the label or title for the combo box.\n\nIt provides descriptive text that helps identify the\n   purpose or content expected in the combo box."
       },
       "attribute": "label",
@@ -334,7 +371,10 @@ export class VegaComboBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies whether a value must be entered for the\n   combo box to pass form validation."
       },
       "attribute": "required",
@@ -357,7 +397,10 @@ export class VegaComboBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies the source data used to populate the\n   dropdown menu associated with the combo box."
       },
       "defaultValue": "[]"
@@ -373,7 +416,10 @@ export class VegaComboBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Sets the initial or preset values of the combo box.\n\nIt should be an array of strings representing the selected values."
       },
       "defaultValue": "[]"
@@ -389,7 +435,10 @@ export class VegaComboBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies the validation status of the combo box component."
       },
       "attribute": "is-valid",
@@ -407,7 +456,10 @@ export class VegaComboBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Determines whether automatic validation should be implemented\n   when a value is edited in the combo box."
       },
       "attribute": "auto-validation",
@@ -430,7 +482,10 @@ export class VegaComboBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies custom validation rules for the combo box."
       },
       "defaultValue": "[]"
@@ -446,7 +501,10 @@ export class VegaComboBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies whether the combo box element is disabled."
       },
       "attribute": "disabled",
@@ -464,7 +522,10 @@ export class VegaComboBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Sets a placeholder string that provides a temporary hint\n   or example inside the combo box input field.\n\nIt indicates the expected format or pattern of the input."
       },
       "attribute": "placeholder",
@@ -482,7 +543,10 @@ export class VegaComboBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Provides a supplementary prompt message that is displayed\n   alongside the combo box input field."
       },
       "attribute": "hint",
@@ -505,7 +569,10 @@ export class VegaComboBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies the size of the combo box."
       },
       "attribute": "size",
@@ -528,7 +595,10 @@ export class VegaComboBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "Specifies partial properties of the `vega-dropdown` component\n   that are used to configure the dropdown menu\n   associated with the combo box."
       },
       "defaultValue": "{}"
@@ -544,7 +614,10 @@ export class VegaComboBox {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.24.0"
+          }],
         "text": "Determines whether to display the associated dropdown menu and\n   filter its options based on the text entered into the combo box.\n\nSetting this property to `false` enables custom text input handling\n   by listening for the `vegaSearch` event."
       },
       "attribute": "use-default-filter",
@@ -559,7 +632,10 @@ export class VegaComboBox {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }],
         "text": "An event emitter notifying changes in the items of the combo box value,\n   whether triggered programmatically or through user interaction."
       },
       "complexType": {
@@ -577,6 +653,9 @@ export class VegaComboBox {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying changes in the items of the combo box value,\n   whether triggered programmatically or through user interaction."
       },
@@ -592,7 +671,10 @@ export class VegaComboBox {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.14.0"
+          }],
         "text": "An event emitter notifying when the user has chosen to add a new value\n   to the source and value of the combo box.\n\nThe event's `detail` property contains the new value.\n\nThe combo box _does not_ automatically add the new value to its `source` and `value`."
       },
       "complexType": {
@@ -610,6 +692,9 @@ export class VegaComboBox {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying when the user has chosen to add a new value\n   to the source and value of the combo box.\n\nThe event's `detail` property contains the new value.\n\nThe combo box _does not_ automatically add the new value to its `source` and `value`."
       },
@@ -625,7 +710,10 @@ export class VegaComboBox {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.24.0"
+          }],
         "text": "An event emitter notifying the user's search action in the combo box,\n   but only if the `useDefaultFilter` property is set to `false`."
       },
       "complexType": {
@@ -643,6 +731,9 @@ export class VegaComboBox {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the user's search action in the combo box,\n   but only if the `useDefaultFilter` property is set to `false`."
       },
@@ -666,7 +757,10 @@ export class VegaComboBox {
       },
       "docs": {
         "text": "Invoke this method to close the dropdown menu associated with the combo box.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }]
       }
     },
     "open": {
@@ -682,7 +776,10 @@ export class VegaComboBox {
       },
       "docs": {
         "text": "Invoke this method to open the dropdown menu associated with the combo box.",
-        "tags": []
+        "tags": [{
+            "name": "version",
+            "text": "1.11.0"
+          }]
       }
     }
   }; }

package/dist/collection/components/vega-counter-badge/vega-counter-badge.js

@@ -8,6 +8,9 @@ import { Component, Host, h, Element, Prop } from '@stencil/core';
 import { sanitizeVegaComponent } from '../../utils/component';
 import { InjectVegaGlobalSlimmer, InjectVegaSlimmer } from 'vega-slimmer/core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.15.0
+ */
 export class VegaCounterBadge {
   constructor() {
     this.globalSlimmers = {};
@@ -17,6 +20,8 @@ export class VegaCounterBadge {
      *
      * If set to `true`, the count is hidden,
      *    and the badge is rendered as a smaller dot.
+     *
+     * @version 1.15.0
      */
     this.dot = false;
     /**
@@ -25,15 +30,21 @@ export 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
      */
     this.color = 'bg-danger';
     /**
      * Represents the number that will be displayed on the badge.
+     *
+     * @version 1.15.0
      */
     this.count = 0;
     /**
      * Specifies the offset of the badge `[left, top]` from
      *    its default position at the top right corner.
+     *
+     * @version 1.15.0
      */
     this.offset = [0, 0];
   }
@@ -79,7 +90,10 @@ export class VegaCounterBadge {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.15.0"
+          }],
         "text": "Determines whether the badge is displayed without a specific count.\n\nIf set to `true`, the count is hidden,\n   and the badge is rendered as a smaller dot."
       },
       "attribute": "dot",
@@ -97,7 +111,10 @@ export class VegaCounterBadge {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.15.0"
+          }],
         "text": "Specifies the background color token to indicate prominence.\n\n- Use 'bg-danger' to represent critical information that\n   demands the user's attention.\n- Use 'bg-action' to represent a mere count of items."
       },
       "attribute": "color",
@@ -115,7 +132,10 @@ export class VegaCounterBadge {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.15.0"
+          }],
         "text": "Represents the number that will be displayed on the badge."
       },
       "attribute": "count",
@@ -133,7 +153,10 @@ export class VegaCounterBadge {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.15.0"
+          }],
         "text": "Specifies the offset of the badge `[left, top]` from\n   its default position at the top right corner."
       },
       "defaultValue": "[0, 0]"

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

@@ -7,6 +7,9 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 import { Component, Host, h, Element } from '@stencil/core';
 import { InjectVegaGlobalSlimmer, InjectVegaSlimmer } from 'vega-slimmer/core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 2.0.0
+ */
 export class VegaDatePickerCalendar {
   constructor() {
     this.globalSlimmers = {};