@globalpayments/vega 2.24.0 → 2.25.0

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

@@ -12,6 +12,9 @@ import { arrayToClassString } from '../../utils/ui';
 import { InjectVegaGlobalSlimmer, InjectVegaSlimmer } from 'vega-slimmer/core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaFlexRuntimeMetricsPayloadDefinition } from '../../constants/runtime-metrics-payload-definition/vega-flex/runtime-metrics-payload-definition';
+/**
+ * @version 1.0.4
+ */
 export class VegaFlex {
   constructor() {
     this.globalSlimmers = {};
@@ -21,16 +24,21 @@ export class VegaFlex {
      *    row-based layout to column-based layout, or vice versa.
      *
      * @deprecated Please use the `direction` property instead.
+     * @version 1.0.4
      */
     this.breakpoint = 'S';
     /**
      * Specifies the flex direction.
+     *
+     * @version 1.3.0
      */
     this.direction = 'row';
     /**
      * Specifies whether to use the native flex layout.
      *
      * @deprecated This property will be removed soon and vega-flex will only support native-based flex behaviors.
+     *
+     * @version 1.10.0
      */
     this.useNativeFlex = true;
   }
@@ -67,7 +75,7 @@ export class VegaFlex {
       "mutable": false,
       "complexType": {
         "original": "ResponsiveType<GapType>",
-        "resolved": "\"0\" | \"size-112\" | \"size-12\" | \"size-16\" | \"size-2\" | \"size-20\" | \"size-24\" | \"size-32\" | \"size-4\" | \"size-40\" | \"size-48\" | \"size-64\" | \"size-72\" | \"size-8\" | \"size-80\" | { S?: \"0\" | \"size-4\" | \"size-8\" | \"size-12\" | \"size-16\" | \"size-20\" | \"size-24\" | \"size-32\" | \"size-40\" | \"size-48\" | \"size-64\" | \"size-72\" | \"size-80\" | \"size-112\" | \"size-2\"; M?: \"0\" | \"size-4\" | \"size-8\" | \"size-12\" | \"size-16\" | \"size-20\" | \"size-24\" | \"size-32\" | \"size-40\" | \"size-48\" | \"size-64\" | \"size-72\" | \"size-80\" | \"size-112\" | \"size-2\"; L?: \"0\" | \"size-4\" | \"size-8\" | \"size-12\" | \"size-16\" | \"size-20\" | \"size-24\" | \"size-32\" | \"size-40\" | \"size-48\" | \"size-64\" | \"size-72\" | \"size-80\" | \"size-112\" | \"size-2\"; XL?: \"0\" | \"size-4\" | \"size-8\" | \"size-12\" | \"size-16\" | \"size-20\" | \"size-24\" | \"size-32\" | \"size-40\" | \"size-48\" | \"size-64\" | \"size-72\" | \"size-80\" | \"size-112\" | \"size-2\"; default?: \"0\" | \"size-4\" | \"size-8\" | \"size-12\" | \"size-16\" | \"size-20\" | \"size-24\" | \"size-32\" | \"size-40\" | \"size-48\" | \"size-64\" | \"size-72\" | \"size-80\" | \"size-112\" | \"size-2\"; }",
+        "resolved": "\"0\" | \"size-112\" | \"size-12\" | \"size-16\" | \"size-2\" | \"size-20\" | \"size-24\" | \"size-32\" | \"size-4\" | \"size-40\" | \"size-48\" | \"size-64\" | \"size-72\" | \"size-8\" | \"size-80\" | { S?: GapType; M?: GapType; L?: GapType; XL?: GapType; default?: GapType; } | { x?: \"0\" | \"size-4\" | \"size-8\" | \"size-12\" | \"size-16\" | \"size-20\" | \"size-24\" | \"size-32\" | \"size-40\" | \"size-48\" | \"size-64\" | \"size-72\" | \"size-80\" | \"size-112\" | \"size-2\"; y?: \"0\" | \"size-4\" | \"size-8\" | \"size-12\" | \"size-16\" | \"size-20\" | \"size-24\" | \"size-32\" | \"size-40\" | \"size-48\" | \"size-64\" | \"size-72\" | \"size-80\" | \"size-112\" | \"size-2\"; }",
         "references": {
           "ResponsiveType": {
             "location": "import",
@@ -82,7 +90,10 @@ export class VegaFlex {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.0.4"
+          }],
         "text": "Determines the gap (spacing) within the flex container.\n\nIt can be provided as a spacing value, such as `size-12` or `size-24`.\n\nAlternatively, it can be set as a responsive map using key-value pairs\n   to define different gaps for various breakpoints,\n   where the `default` key is required."
       },
       "attribute": "gap",
@@ -108,7 +119,10 @@ export class VegaFlex {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Determines the margin (spacing) around the flex container.\n\nIt can be provided as a spacing value, such as `size-16` or `size-24`.\n\nAlternatively, it can be set as a responsive map using key-value pairs\n   to define different margins for various breakpoints.\n   When using a responsive map, the `default` key is required."
       },
       "attribute": "margin",
@@ -133,6 +147,9 @@ export class VegaFlex {
         "tags": [{
             "name": "deprecated",
             "text": "Please use the `direction` property instead."
+          }, {
+            "name": "version",
+            "text": "1.0.4"
           }],
         "text": "Determines the breakpoint at which the flex direction transitions from\n   row-based layout to column-based layout, or vice versa."
       },
@@ -160,7 +177,10 @@ export class VegaFlex {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Specifies the flex direction."
       },
       "attribute": "direction",
@@ -187,7 +207,10 @@ export class VegaFlex {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.49.0"
+          }],
         "text": "Controls the alignment of items within the flex container."
       },
       "attribute": "align-items",
@@ -213,7 +236,10 @@ export class VegaFlex {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "1.3.0"
+          }],
         "text": "Controls the alignment of content items and the distribution of\n   space between and around them within the flex container."
       },
       "attribute": "justify-content",
@@ -239,7 +265,10 @@ export class VegaFlex {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
+        "tags": [{
+            "name": "version",
+            "text": "2.6.0"
+          }],
         "text": "Determines whether flex items are confined to a single line or can wrap onto multiple lines based on available space."
       },
       "attribute": "flex-wrap",
@@ -259,6 +288,9 @@ export class VegaFlex {
         "tags": [{
             "name": "deprecated",
             "text": "This property will be removed soon and vega-flex will only support native-based flex behaviors."
+          }, {
+            "name": "version",
+            "text": "1.10.0"
           }],
         "text": "Specifies whether to use the native flex layout."
       },

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"
           }]
       }
     }