@globalpayments/vega 2.24.0 → 2.24.2

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

@@ -16,6 +16,9 @@ import { VegaFontClassesController } from './slimmers/controllers/vega-font-clas
 import { VegaFontRenderer } from './slimmers/renderers/vega-font-renderer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaFontRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/vega-font/runtime-metrics-payload-definition';
+/**
+ * @version 1.46.0
+ */
 export class VegaFont {
   constructor() {
     this.globalSlimmers = {};
@@ -28,20 +31,28 @@ export class VegaFont {
     this.currentBreakpoint = getCurrentBreakpoint();
     /**
      * Specifies the typography token used for styling the text within this component. A typography token includes values for font size and line height.
+     *
+     * @version 1.46.0
      */
     this.variant = 'font-field-label';
     /**
      * Specifies the font color represented by a valid text color token.
+     *
+     * @version 1.46.0
      */
     this.color = 'text-primary';
     /**
      * Specifies the capability to enable or disable the font's
      *      responsiveness from native code.
+     *
+     * @version 1.46.0
      */
     this.disableResponsive = false;
     /**
      * Indicates the rendering of an additional node with a
      *     value that is an HTML tag name. It can be set as `ResponsiveType`.
+     *
+     * @version 1.46.0
      */
     this.as = '';
   }
@@ -88,7 +99,10 @@ export class VegaFont {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.46.0"
+          }],
         "text": "Specifies the typography token used for styling the text within this component. A typography token includes values for font size and line height."
       },
       "attribute": "variant",
@@ -111,7 +125,10 @@ export class VegaFont {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.46.0"
+          }],
         "text": "Specifies the font color represented by a valid text color token."
       },
       "attribute": "color",
@@ -129,7 +146,10 @@ export class VegaFont {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.46.0"
+          }],
         "text": "Specifies the capability to enable or disable the font's\n     responsiveness from native code."
       },
       "attribute": "disable-responsive",
@@ -156,7 +176,10 @@ export class VegaFont {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.9.0"
+          }],
         "text": "Specifies the horizontal alignment of the vega-font content.\n\nThis property determines how the text is aligned\n  \twithin its container, and it is effective only when\n  \tthe vega-font is styled as a block-level element."
       },
       "attribute": "text-align",
@@ -182,7 +205,10 @@ export class VegaFont {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.46.0"
+          }],
         "text": "Indicates the rendering of an additional node with a\n    value that is an HTML tag name. It can be set as `ResponsiveType`."
       },
       "attribute": "as",

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

@@ -21,6 +21,9 @@ import { ChildNodesNotifyObserverSlimmer, } from '../../helpers/event-manager/sl
 import domNodeSubjectFactory from '../../helpers/change-manager/subject/dom-node-subject/dom-node-subject-factory';
 import { VegaInternalValid } from '../../helpers/event-manager/event-id/vega-internal-event-id';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.3.0
+ */
 export class VegaForm {
   constructor() {
     this.globalSlimmers = {};
@@ -70,7 +73,10 @@ export class VegaForm {
      *      it is highly recommended to enable auto-validation for all
      *      form-controlled elements to ensure that the value reflects
      *      the most up-to-date form validation status.
+     *
+     * @version 1.3.0
      */
+    /* eslint-disable-next-line @stencil/strict-mutable */
     this.isValid = null;
     /**
      * Indicates whether the value of any current
@@ -80,6 +86,8 @@ export class VegaForm {
      *      this parameter is set to `true`.
      *   2. When resetting the form, this parameter is set to `false`.
      *   3. When invoking the `setValue` method, this parameter is set to `false`.
+     *
+     * @version 1.3.0
      */
     this.isTouched = false;
     /**
@@ -140,6 +148,7 @@ export class VegaForm {
    *
    * @param {boolean | 'rule'} showError determine whether the validation result should be reflected in UI
    * @return {Promise<FormValidateResult> } validation result
+   * @version 1.3.0
    */
   async valid(showError = true) {
     const result = { isValid: true, invalidFields: [] };
@@ -167,6 +176,7 @@ export class VegaForm {
    *
    * @param {FormControlOption} [option] form control option to skip disabled/invisible components
    * @return {Promise<T>} object with key and field value as key-value pair
+   * @version 1.3.0
    */
   async getValue(option) {
     const result = {};
@@ -188,6 +198,7 @@ export class VegaForm {
    *
    * @param value to prefill into the vega-form
    * @param {FormControlOption} [option] form control option to skip disabled/invisible components
+   * @version 1.3.0
    */
   async setValue(value, option) {
     if (value) {
@@ -216,6 +227,8 @@ export class VegaForm {
    *
    * @param defaultValueMap map of the vega form field name to default value
    * @param {FormControlOption} [option] form control option to skip disabled/invisible components
+   *
+   * @version 1.3.0
    */
   async reset(defaultValueMap = {}, option) {
     await this.navigateVegaFormChildren(async (element, isForm) => {
@@ -427,7 +440,10 @@ export class VegaForm {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Indicates whether the current form-controlled elements are valid.\n\nForm-controlled elements are considered for validation if they\n   have the `data-vega-form` property.\n\nDisabled and invisible elements are excluded from validation.\n\nIf the value is `undefined`, it means there are no\n   form-controlled elements that can be validated.\n\n**Additional Notes:**\n  1. When depending on `isValid` for form validation, it is advised\n     not to modify the following properties of the monitored DOM:\n     - `disabled` property\n     - Element visibility style\n  2. As this property relies heavily on the `VegaValidate` event emitted,\n     it is highly recommended to enable auto-validation for all\n     form-controlled elements to ensure that the value reflects\n     the most up-to-date form validation status."
       },
       "attribute": "is-valid",
@@ -445,7 +461,10 @@ export class VegaForm {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Indicates whether the value of any current\n   form-controlled elements has been changed.\n\n  1. When the value of any form-controlled element is changed,\n     this parameter is set to `true`.\n  2. When resetting the form, this parameter is set to `false`.\n  3. When invoking the `setValue` method, this parameter is set to `false`."
       },
       "attribute": "is-touched",
@@ -460,7 +479,10 @@ export class VegaForm {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.9.1"
+          }],
         "text": "An event emitter notifying the change in the validation result."
       },
       "complexType": {
@@ -478,6 +500,9 @@ export class VegaForm {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the change in the validation result."
       },
@@ -493,7 +518,10 @@ export class VegaForm {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.24.0"
+          }],
         "text": "An event emitter notifying the submission of the form."
       },
       "complexType": {
@@ -511,6 +539,9 @@ export class VegaForm {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the submission of the form."
       },
@@ -526,7 +557,10 @@ export class VegaForm {
       "cancelable": true,
       "composed": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.24.0"
+          }],
         "text": "An event emitter notifying the reset of the form."
       },
       "complexType": {
@@ -544,6 +578,9 @@ export class VegaForm {
         "tags": [{
             "name": "eventSemantics",
             "text": "namespace:native"
+          }, {
+            "name": "version",
+            "text": "2.0.0"
           }],
         "text": "An event emitter notifying the reset of the form."
       },
@@ -589,6 +626,9 @@ export class VegaForm {
           }, {
             "name": "return",
             "text": "validation result"
+          }, {
+            "name": "version",
+            "text": "1.3.0"
           }]
       }
     },
@@ -633,6 +673,9 @@ export class VegaForm {
           }, {
             "name": "return",
             "text": "object with key and field value as key-value pair"
+          }, {
+            "name": "version",
+            "text": "1.3.0"
           }]
       }
     },
@@ -680,6 +723,9 @@ export class VegaForm {
           }, {
             "name": "param",
             "text": "option form control option to skip disabled/invisible components"
+          }, {
+            "name": "version",
+            "text": "1.3.0"
           }]
       }
     },
@@ -724,6 +770,9 @@ export class VegaForm {
           }, {
             "name": "param",
             "text": "option form control option to skip disabled/invisible components"
+          }, {
+            "name": "version",
+            "text": "1.3.0"
           }]
       }
     }

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

@@ -10,6 +10,9 @@ import { sanitizeVegaComponent } from '../../utils/component';
 import { arrayToClassString } from '../../utils/ui';
 import { InjectVegaGlobalSlimmer, InjectVegaSlimmer } from 'vega-slimmer/core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.3.0
+ */
 export class VegaGrid {
   constructor() {
     this.globalSlimmers = {};
@@ -31,6 +34,8 @@ export class VegaGrid {
      *    for various breakpoints. The keys in the map should represent the breakpoints,
      *    such as `default` or `L`, and the values can be integers or strings following the
      *    same patterns mentioned above.
+     *
+     * @version 1.3.0
      */
     this.column = 1;
     /**
@@ -50,6 +55,8 @@ export class VegaGrid {
      *    for various breakpoints. The keys in the map should represent the breakpoints,
      *    such as `default` or `L`, and the values can be integers or strings following the
      *    same patterns mentioned above.
+     *
+     * @version 1.3.0
      */
     this.row = 1;
   }
@@ -91,7 +98,10 @@ export class VegaGrid {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Determines the configuration of the grid columns.\n   It can be provided as an integer, string, or a responsive map\n   using key-value pairs.\n\nIf provided as an integer from 1 to 12, each column will have the same width.\n   The CSS for this configuration is `grid-template-columns: repeat(number, minmax(0, 1fr))`.\n\nIf provided as a string in the format of n-auto\n   (e.g., `1-auto`, `2-auto`, ..., `12-auto`),\n   each column will have auto width. The CSS for this configuration is\n   `grid-template-columns: repeat(number, auto)`.\n\nAlternatively, you can use a responsive map to define different column configurations\n   for various breakpoints. The keys in the map should represent the breakpoints,\n   such as `default` or `L`, and the values can be integers or strings following the\n   same patterns mentioned above."
       },
       "attribute": "column",
@@ -118,7 +128,10 @@ export class VegaGrid {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Determines the configuration of the grid rows.\n   It can be provided as an integer, string, or a responsive map\n   using key-value pairs.\n\nIf provided as an integer from 1 to 6, each row will have the same height.\n   The CSS for this configuration is `grid-template-rows: repeat(number, minmax(0, 1fr))`.\n\nIf provided as a string in the format of n-auto\n   (e.g., `1-auto`, `2-auto`, ..., `6-auto`),\n   each row will have auto height. The CSS for this configuration is\n   `grid-template-rows: repeat(number, auto)`.\n\nAlternatively, you can use a responsive map to define different row configurations\n   for various breakpoints. The keys in the map should represent the breakpoints,\n   such as `default` or `L`, and the values can be integers or strings following the\n   same patterns mentioned above."
       },
       "attribute": "row",
@@ -145,7 +158,10 @@ export class VegaGrid {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Determines the spacing between grid cells.\n\nIt can be provided as a spacing value, such as `size-16` or `size-24`.\n\nAlternatively, you can use a responsive map to define different gap values for\n   various breakpoints. The keys in the map should represent the breakpoints,\n   such as `default` or `L`, and the values should be spacing values."
       },
       "attribute": "gap",

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

@@ -10,6 +10,7 @@ import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/
 import { sanitizeVegaComponent } from '../../utils/component';
 /**
  * @VegaInternalComponent
+ * @version 2.20.1
  */
 /**
  * This is an internal used component and shouldn't be used by client,

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

@@ -14,6 +14,9 @@ import { VegaIconManager } from '../../helpers/icon/icon-manager';
 import { InjectVegaGlobalSlimmer, InjectVegaSlimmer } from 'vega-slimmer/core';
 import { LogUtility } from '../../utils/log';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.0.4
+ */
 export class VegaIcon {
   constructor() {
     this.globalSlimmers = {};
@@ -22,6 +25,8 @@ export class VegaIcon {
      * Specifies the width and height of the icon.
      *    For Third Party Icons (e.g., Font Awesome),
      *    it sets the icon's font-size.
+     *
+     * @version 1.0.4
      */
     this.size = 'size-16';
     /**
@@ -210,7 +215,10 @@ export class VegaIcon {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.4"
+          }],
         "text": "Specifies the required icon design token for the icon."
       },
       "attribute": "icon",
@@ -232,7 +240,10 @@ export class VegaIcon {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.4"
+          }],
         "text": "Specifies the width and height of the icon.\n   For Third Party Icons (e.g., Font Awesome),\n   it sets the icon's font-size."
       },
       "attribute": "size",
@@ -255,7 +266,10 @@ export class VegaIcon {
       "required": false,
       "optional": true,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.26.0"
+          }],
         "text": "Specifies the color of the icon.\n\nIf the color prop is `undefined`, it defaults to `currentColor`."
       },
       "attribute": "color",