@globalpayments/vega 2.24.0 → 2.25.0

package/dist/types/components/vega-input/vega-input.d.ts

@@ -8,6 +8,10 @@ import { VegaInputCopyPasteController } from './slimmers/controllers/vega-input-
 import { VegaInputPrefixSlotRenderer } from './slimmers/renderers/vega-input-prefix-slot-renderer';
 import { VegaInputMaskConfigController } from './slimmers/controllers/vega-input-mask-config-controller';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+import { LabelSuffixButtonProps } from '../vega-field-label/types';
+/**
+ * @version 1.0.5
+ */
 export declare class VegaInput {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly formFieldController: FormFieldControllerSlimmer<string>;
@@ -17,6 +21,7 @@ export declare class VegaInput {
   protected changeEventEmitter: EventEmitSlimmerBase;
   protected focusEventEmitter: EventEmitSlimmerBase;
   protected blurEventEmitter: EventEmitSlimmerBase;
+  protected labelButtonClickEventEmitter: EventEmitSlimmerBase;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaInputElement>;
   private inputRef;
   private inputContainerRef;
@@ -26,8 +31,19 @@ export declare class VegaInput {
    *
    * It provides descriptive text that helps identify the
    *    purpose or content expected in the input field.
+   *
+   * @version 1.0.5
    */
   label: string;
+  /**
+   * Specifies the properties for the suffix button associated with the input.
+   *
+   * It provides essential information and functionality
+   *  related to the suffix button's role and behavior.
+   *
+   * @version 2.25.0
+   */
+  labelSuffixButtonProps: LabelSuffixButtonProps;
   /**
    * Represents a pre-set or default value for the input field.
    *
@@ -37,6 +53,8 @@ export declare class VegaInput {
    *
    * If the value is too long, it may be truncated with
    *    an ellipsis for visual presentation.
+   *
+   * @version 1.0.5
    */
   value: string;
   /**
@@ -55,6 +73,8 @@ export declare class VegaInput {
    * Specifies when the vegaChange event is triggered.
    *     It controls whether the event is dispatched
    *     after typing in the input or after a change event.
+   *
+   * @version 2.24.0
    */
   valueUpdateTrigger: InputValueUpdateTriggeredBy;
   /**
@@ -62,23 +82,31 @@ export declare class VegaInput {
    *
    * It specifies the intended format or purpose of the
    *    data to be entered by the user.
+   *
+   * @version 1.0.9
    */
   type: 'text' | 'email' | 'password' | 'number' | 'hidden';
   /**
    * Defines the specific name of the input field.
    *
+   *
+   * @version 1.0.5
    */
   name: string;
   /**
    * Controls the autofill behavior and specifies whether the
    *    input should receive automated suggestions or
    *    previously entered values.
+   *
+   * @version 1.0.5
    */
   autocomplete: 'on' | 'off';
   /**
    * Specifies an icon or symbol that appears before the input field,
    *    providing visual context or enhancing the aesthetic appearance
    *    of the input.
+   *
+   * @version 1.0.5
    */
   prefixIcon: string;
   /**
@@ -88,50 +116,71 @@ export declare class VegaInput {
    *    standard email formatting rules.
    *
    * @deprecated Please use `type='email'` instead.
+   * @version 1.0.5
    */
   email: boolean;
   /**
    * Determines whether the input field is required.
+   *
+   * @version 1.0.5
    */
   required: boolean;
   /**
    * Sets the minimum allowable numeric value for the input value.
+   *
+   * @version 1.0.5
    */
   min: number;
   /**
    * Sets the maximum allowable numeric value for the input value.
+   *
+   * @version 1.0.5
    */
   max: number;
   /**
    * Sets the minimum length requirement for the input value.
+   *
+   * @version 1.0.5
    */
   minLength: number;
   /**
    * Sets the maximum length requirement for the input value.
+   *
+   * @version 1.0.5
    */
   maxLength: number;
   /**
    * Determines whether the clear icon should be displayed or hidden.
+   *
+   * @version 1.3.0
    */
   showClearIcon: boolean;
   /**
    * Indicates whether the current value in the field is considered valid or
    *    invalid based on the defined validation rules.
+   *
+   * @version 1.3.0
    */
   isValid: boolean;
   /**
    * Determines whether the input field should undergo automatic validation
    *    during the user's input.
+   *
+   * @version 1.0.10
    */
   autoValidation: boolean;
   /**
    * Defines custom validation rules for the input field.
+   *
+   * @version 1.0.10
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
   /**
    * Defines the size of the input field,
    *    specifying its width or length.
+   *
+   * @version 1.3.0
    */
   size: 'default' | 'small';
   /**
@@ -139,15 +188,21 @@ export declare class VegaInput {
    *    or example inside the input field.
    *
    * It indicates the expected format or pattern of the input.
+   *
+   * @version 1.3.0
    */
   placeholder: string;
   /**
    * Determines whether the input field is disabled.
+   *
+   * @version 1.3.0
    */
   disabled: boolean;
   /**
    * Provides a supplementary prompt message that assists users in
    *    understanding the expected value for the input field.
+   *
+   * @version 1.3.0
    */
   hint: string;
   /**
@@ -155,10 +210,14 @@ export declare class VegaInput {
    *
    * It provides a way to define a specific format or pattern for the input value,
    *    restricting and guiding the user's input accordingly.
+   *
+   * @version 1.3.0
    */
   maskConfig: MaskConfigType | MaskConfigType[];
   /**
    * Controls whether copying or pasting is enabled for the input.
+   *
+   * @version 2.1.0
    */
   disableCopyPaste: boolean;
   /**
@@ -170,40 +229,66 @@ export declare class VegaInput {
   watchMaskChange(): void;
   /**
    * An event emitter notifying a value change.
+   *
+   * @version 1.0.10
    */
   vegaChange: EventEmitter<string>;
   /**
    * An event emitter notifying a value change.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter<string>;
   /**
    * An event emitter notifying the blur of the inner input element.
+   *
+   * @version 1.3.0
    */
   vegaBlur: EventEmitter<undefined>;
   /**
    * An event emitter notifying the blur of the inner input element.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   blur: EventEmitter<undefined>;
   /**
    * An event emitter notifying the focus of the inner input element.
+   *
+   * @version 1.12.0
    */
   vegaFocus: EventEmitter<undefined>;
   /**
    * An event emitter notifying the focus of the inner input element.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   focus: EventEmitter<undefined>;
+  /**
+   * An event emitter notifying that the suffix button associated with the field label has been clicked.
+   *
+   * @version 2.25.0
+   */
+  vegaLabelButtonClick: EventEmitter;
+  /**
+   * An event emitter notifying that the suffix button associated with the field label has been clicked.
+   *
+   * @eventSemantics namespace:native
+   * @version 2.25.0
+   */
+  labelButtonClick: EventEmitter;
   /**
    * Invoke this method to focus the current input.
+   *
+   * @version 1.12.0
    */
   doFocus(): Promise<void>;
   /**
    * Invoke this method to blur the current input.
+   *
+   * @version 1.12.0
    */
   doBlur(): Promise<void>;
   render(): VegaInput;
@@ -230,4 +315,5 @@ export declare class VegaInput {
    * @see{module:vega-input-on-value-change}
    */
   private inputChangeHandler;
+  private handleLabelButtonClick;
 }

package/dist/types/components/vega-input-credit-card/vega-input-credit-card.d.ts

@@ -5,6 +5,9 @@ import { FormFieldControllerSlimmer } from '../../helpers/slimmers/form-field-co
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.26.0
+ */
 export declare class VegaInputCreditCard {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly formFieldController: FormFieldControllerSlimmer<string>;
@@ -19,23 +22,33 @@ export declare class VegaInputCreditCard {
   /**
    * Specifies whether a card number must be entered for
    *    this component to pass form validation.
+   *
+   * @version 1.26.0
    */
   required: boolean;
   /**
    * Determines whether the credit card input field is disabled.
+   *
+   * @version 1.26.0
    */
   disabled: boolean;
   /**
    * Defines the label or title for the credit card input field.
+   *
+   * @version 1.26.0
    */
   label: string;
   /**
    * Provides a supplementary prompt message that assists users in
    *    understanding the expected value for the input field.
+   *
+   * @version 1.26.0
    */
   hint: string;
   /**
    * Specifies the size of the credit card input field.
+   *
+   * @version 1.26.0
    */
   size: 'default' | 'small';
   /**
@@ -43,6 +56,8 @@ export declare class VegaInputCreditCard {
    *    example inside the credit card input field.
    *
    * It indicates the expected format or pattern of the credit card input.
+   *
+   * @version 1.26.0
    */
   placeholder: string;
   /**
@@ -52,21 +67,29 @@ export declare class VegaInputCreditCard {
    * When set to `true`, the credit card number is partially masked,
    *    with the first three fields displayed as "x" and
    *    the last field remaining visible during blur and upon initial loading.
+   *
+   * @version 1.26.0
    */
   hideCardNumberOnBlur: boolean;
   /**
    * Determines whether the user's input in the credit card field should
    *    be automatically validated.
+   *
+   * @version 1.26.0
    */
   autoValidation: boolean;
   /**
    * Specifies custom validation rules for the credit card input field.
+   *
+   * @version 1.26.0
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
   /**
    * Indicates whether the current value in the field is considered valid
    *    based on the defined validation rules.
+   *
+   * @version 1.26.0
    */
   isValid: boolean;
   /**
@@ -75,34 +98,45 @@ export declare class VegaInputCreditCard {
    * It allows you to initialize the field with a specific value,
    *    which is displayed to the user when the
    *    input is initially rendered.
+   *
+   * @version 1.26.0
    */
   value: string;
   watchValue(value: string): void;
   /**
    * An event emitter notifying a value change.
+   *
+   * @version 1.26.0
    */
   vegaChange: EventEmitter<string>;
   /**
    * A native change event emitter notifying a value change.
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter<string>;
   /**
    * An event emitter notifying the blur event of the credit card element.
+   *
+   * @version 1.26.0
    */
   vegaBlur: EventEmitter<undefined>;
   /**
    * An event emitter notifying the blur event of the credit card element.
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   blur: EventEmitter<undefined>;
   /**
    * An event emitter notifying the focus of the credit card element.
+   *
+   * @version 1.26.0
    */
   vegaFocus: EventEmitter<undefined>;
   /**
    * An event emitter notifying the focus of the credit card element.
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   focus: EventEmitter<undefined>;
   componentDidLoad(): void;

package/dist/types/components/vega-input-phone-number/vega-input-phone-number.d.ts

@@ -11,6 +11,9 @@ import { CountrySelectController } from './slimmers/controllers/country-select-c
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { VegaCountryCode, VegaCountryType } from './types';
+/**
+ * @version 2.18.0
+ */
 export declare class VegaInputPhoneNumber {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaInputRangeElement>;
@@ -30,22 +33,32 @@ export declare class VegaInputPhoneNumber {
    *
    * It provides descriptive text that helps identify the
    *    purpose or content expected in the input field.
+   *
+   * @version 2.18.0
    */
   label: string;
   /**
    * Specifies the size of the phone number input field.
+   *
+   * @version 2.18.0
    */
   size: 'default' | 'small';
   /**
    * Determines whether the phone number input field is required.
+   *
+   * @version 2.18.0
    */
   required: boolean;
   /**
    * Determines whether the phone number input field is disabled.
+   *
+   * @version 2.18.0
    */
   disabled: boolean;
   /**
    * Specifies the default country calling code using the two-letter uppercase country code.
+   *
+   * @version 2.18.0
    */
   countryCode: VegaCountryCode;
   watchCountryCode(newCountryCode: VegaCountryCode, oldCountryCode: VegaCountryCode): void;
@@ -53,56 +66,76 @@ export declare class VegaInputPhoneNumber {
    * Specifies the countries available for selection.
    *
    * Note: By default, 245 codes are provided, but loading all of them may take time. To improve performance, it is recommended to include only the necessary codes.
+   *
+   * @version 2.18.0
    */
   allowedCountryCodes: VegaCountryCode[];
   /**
    * Specifies the value of the phone number input in [E.164]{@link https://en.wikipedia.org/wiki/E.164} format.
+   *
+   * @version 2.18.0
    */
   value: string;
   watchValue(value: string): void;
   /**
    * Specifies custom validation rules for the phone number input field.
+   *
+   * @version 2.18.0
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
   /**
    * Indicates whether the current value in the field is considered valid
    *    based on the defined validation rules.
+   *
+   * @version 2.18.0
    */
   isValid: boolean;
   /**
    * Determines whether the phone number input field should undergo automatic validation
    *    during the user's input.
+   *
+   * @version 2.18.0
    */
   autoValidation: boolean;
   /**
    * Specifies a placeholder string that displays as a temporary hint
    *    or example inside the input field.
+   *
+   * @version 2.18.0
    */
   placeholder: string;
   /**
    * Provides a supplementary prompt message that assists users in
    *    understanding the expected value for the input field.
+   *
+   * @version 2.18.0
    */
   hint: string;
   /**
    * An event emitter notifying a value change.
+   *
+   * @version 2.18.0
    */
   vegaChange: EventEmitter<string>;
   /**
    * An event emitter notifying a value change.
    *
    * @eventSemantics namespace:native
+   * @version 2.18.0
    */
   change: EventEmitter<string>;
   /**
    * An event emitter notifying a country change.
+   *
+   * @version 2.18.0
    */
   vegaCountryChange: EventEmitter<VegaCountryType>;
   /**
    * An event emitter notifying a country change.
    *
    * @eventSemantics namespace:native
+   * @version 2.18.0
    */
   countryChange: EventEmitter<VegaCountryType>;
   render(): VegaInputPhoneNumber;

package/dist/types/components/vega-input-range/vega-input-range.d.ts

@@ -10,6 +10,9 @@ import { VegaInputRangeInputRenderer } from './slimmers/renderers/vega-input-ran
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { VegaInputRangeClearIconRenderer } from './slimmers/renderers/vega-input-range-clear-icon-renderer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 2.2.0
+ */
 export declare class VegaInputRange {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected formFieldController: FormFieldControllerSlimmer<InputRangeValueType>;
@@ -26,6 +29,8 @@ export declare class VegaInputRange {
    *
    * It provides descriptive text that helps identify the
    *    purpose or content expected in the input field.
+   *
+   * @version 2.2.0
    */
   label: string;
   /**
@@ -37,6 +42,8 @@ export declare class VegaInputRange {
    *
    * If the value is too long, it may be truncated with
    *    an ellipsis for visual presentation.
+   *
+   * @version 2.2.0
    */
   value: InputRangeValueType;
   /**
@@ -58,42 +65,60 @@ export declare class VegaInputRange {
    * Specifies an icon or symbol that appears before the input range,
    *    providing visual context or enhancing the aesthetic appearance
    *    of the input.
+   *
+   * @version 2.2.0
    */
   prefixIcon: string;
   /**
    * Determines whether the clear icon should be displayed.
+   *
+   * @version 2.2.0
    */
   showClearIcon: boolean;
   /**
    * Sets the minimum allowable numeric value for the input value.
+   *
+   * @version 2.2.0
    */
   min: number;
   /**
    * Sets the maximum allowable numeric value for the input value.
+   *
+   * @version 2.2.0
    */
   max: number;
   /**
    * Determines whether the input range is required.
+   *
+   * @version 2.2.0
    */
   required: boolean;
   /**
    * Indicates whether the current value in the field is considered valid
    *    based on the defined validation rules.
+   *
+   * @version 2.2.0
    */
   isValid: boolean;
   /**
    * Determines whether the input field should undergo automatic validation
    *    during the user's input.
+   *
+   * @version 2.2.0
    */
   autoValidation: boolean;
   /**
    * Defines custom validation rules for the input field.
+   *
+   * @version 2.2.0
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
   /**
    * Defines the size of the input range,
    *    specifying its width or length.
+   *
+   * @version 2.2.0
    */
   size: 'default' | 'small';
   /**
@@ -101,30 +126,41 @@ export declare class VegaInputRange {
    *    or example inside the input field.
    *
    * It indicates the expected format or pattern of the input.
+   *
+   * @version 2.2.0
    */
   placeholder: [string, string];
   /**
    * Determines whether the input range is disabled.
+   *
+   * @version 2.2.0
    */
   disabled: boolean;
   /**
    * Provides a supplementary prompt message that assists users in
    *    understanding the expected value for the input field.
+   *
+   * @version 2.2.0
    */
   hint: string;
   /**
    * Determines the arrangement and appearance of
    *    the label and input areas.
+   *
+   * @version 2.2.0
    */
   stack: InputRangeStackType;
   /**
    * An event emitter notifying a value change.
+   *
+   * @version 2.2.0
    */
   vegaChange: EventEmitter<[number, number]>;
   /**
    * An event emitter notifying a value change.
    *
    * @eventSemantics namespace:native
+   * @version 2.2.0
    */
   change: EventEmitter<[number, number]>;
   render(): VegaInputRange;