@globalpayments/vega 2.24.0 → 2.24.2

package/dist/types/components/vega-file-uploader/vega-file-uploader.d.ts

@@ -0,0 +1,138 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
+import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+import { VegaFileUploaderFile, VegaFileUploaderFiles, VegaFileUploaderType } from './types';
+import { VegaFileUploaderRenderer } from './slimmers/renderers/vega-file-uploader-renderer';
+import { VegaFileUploaderContainerRenderer } from './slimmers/renderers/vega-file-uploader-container-renderer';
+import { VegaFileUploaderFileListRenderer } from './slimmers/renderers/vega-file-uploader-file-list-renderer';
+import { VegaFileUploaderFileStatusRenderer } from './slimmers/renderers/vega-file-uploader-file-status-renderer';
+import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
+import { VegaFileUploaderValueController } from './slimmers/controllers/vega-file-uploader-value-controller';
+import { FormFieldValidationRule } from '../../helpers/validator/rules/form-field-validation-rule';
+import { FormFieldControllerSlimmer } from '../../helpers/slimmers/form-field-controller-slimmer';
+export declare class VegaFileUploader {
+  protected readonly globalSlimmers: GlobalSlimmers;
+  protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaFileUploaderElement>;
+  protected formFieldController: FormFieldControllerSlimmer<VegaFileUploaderFiles>;
+  protected vegaFileUploaderRenderer: VegaFileUploaderRenderer;
+  protected vegaFileUploaderContainerRenderer: VegaFileUploaderContainerRenderer;
+  protected vegaFileUploaderFileListRenderer: VegaFileUploaderFileListRenderer;
+  protected vegaFileUploaderFileStatusRenderer: VegaFileUploaderFileStatusRenderer;
+  protected vegaFileUploaderValueController: VegaFileUploaderValueController;
+  protected changeEventEmitter: EventEmitSlimmerBase;
+  protected selectFileChangeEventEmitter: EventEmitSlimmerBase;
+  protected removeEventEmitter: EventEmitSlimmerBase;
+  protected retryEventEmitter: EventEmitSlimmerBase;
+  protected previewEventEmitter: EventEmitSlimmerBase;
+  host: HTMLVegaFileUploaderElement;
+  /**
+   * Specifies the label or title for the field.
+   *
+   * It provides descriptive text that helps identify the
+   *    purpose or content expected in the field.
+   */
+  label: string;
+  /**
+   * Specifies the uploader type that activates when clicked
+   *    or when a file is dragged, determining how users
+   *    interact with the file uploader.
+   */
+  variant: VegaFileUploaderType;
+  /**
+   * Provides a supplementary prompt message that assists users in
+   *    understanding the expected value for the file uploader field.
+   */
+  hint: string;
+  /**
+   * Specifies the initial file content to display, enabling a preview
+   *    of the uploaded file or a default placeholder.
+   */
+  value: VegaFileUploaderFile[];
+  /**
+   * Watches the value change.
+   *
+   * @param {VegaFileUploaderFile[]} newValue The new value
+   */
+  watchValue(newValue: VegaFileUploaderFile[]): void;
+  /**
+   * Specifies whether the File Uploader field is disabled.
+   */
+  disabled: boolean;
+  /**
+   * Specifies whether uploading a file is mandatory.
+   */
+  required: boolean;
+  /**
+   * Defines custom validation rules for the File Uploader field.
+   */
+  validationRules: FormFieldValidationRule<unknown>[];
+  watchValidationRules(): void;
+  /**
+   * Determines whether the input field should undergo automatic validation
+   *    during the user's input.
+   */
+  autoValidation: boolean;
+  /**
+   * Specifies the validation status of the file uploader component.
+   */
+  isValid: boolean;
+  /**
+   * Specifies the allowed file types for upload.
+   */
+  accept: string;
+  /**
+   * An event emitter notifying a change in the file list.
+   */
+  vegaChange: EventEmitter<VegaFileUploaderFiles>;
+  /**
+   * An event emitter notifying a change in the file list.
+   *
+   * @eventSemantics namespace:native
+   */
+  change: EventEmitter<VegaFileUploaderFiles>;
+  /**
+   * An event emitter notifying a file selection change. By default, the component value
+   *   is updated, but this behavior can be prevented.
+   */
+  vegaSelectedFileChange: EventEmitter<VegaFileUploaderFiles>;
+  /**
+   * An event emitter notifying a file selection change. By default, the component value
+   *   is updated, but this behavior can be prevented.
+   *
+   * @eventSemantics namespace:native
+   */
+  selectedFileChange: EventEmitter<VegaFileUploaderFiles>;
+  /**
+   * An event emitter notifying that a selected file will be removed. By default, the component value
+   *   is updated, but this behavior can be prevented.
+   */
+  vegaRemove: EventEmitter<VegaFileUploaderFile>;
+  /**
+   * An event emitter notifying that a selected file will be removed. By default, the component value
+   *   is updated, but this behavior can be prevented.
+   *
+   * @eventSemantics namespace:native
+   */
+  remove: EventEmitter<VegaFileUploaderFile>;
+  /**
+   * An event emitter notifying that a file will be re-uploaded.
+   */
+  vegaRetry: EventEmitter<VegaFileUploaderFile>;
+  /**
+   * An event emitter notifying that a file will be re-uploaded.
+   *
+   * @eventSemantics namespace:native
+   */
+  retry: EventEmitter<VegaFileUploaderFile>;
+  /**
+   * An event emitter notifying that a file will be opened for preview.
+   */
+  vegaPreview: EventEmitter<VegaFileUploaderFile>;
+  /**
+   * An event emitter notifying that a file will be opened for preview.
+   *
+   * @eventSemantics namespace:native
+   */
+  preview: EventEmitter<VegaFileUploaderFile>;
+  render(): VegaFileUploader;
+}

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

@@ -2,6 +2,9 @@ import { BreakpointsTokenType } from '../../types/design-token.type';
 import { GapType, ResponsiveType, MarginType, FlexDirectionType, FlexAlignItemType, FlexJustifyContentType, FlexWrapType } from '../../types/ui.type';
 import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.0.4
+ */
 export declare class VegaFlex {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaFlexElement>;
@@ -14,6 +17,8 @@ export declare class VegaFlex {
    * Alternatively, it can be set as a responsive map using key-value pairs
    *    to define different gaps for various breakpoints,
    *    where the `default` key is required.
+   *
+   * @version 1.0.4
    */
   gap: ResponsiveType<GapType>;
   /**
@@ -24,6 +29,8 @@ export declare class VegaFlex {
    * Alternatively, it can be set as a responsive map using key-value pairs
    *    to define different margins for various breakpoints.
    *    When using a responsive map, the `default` key is required.
+   *
+   * @version 1.3.0
    */
   margin: ResponsiveType<MarginType>;
   /**
@@ -31,29 +38,40 @@ export declare class VegaFlex {
    *    row-based layout to column-based layout, or vice versa.
    *
    * @deprecated Please use the `direction` property instead.
+   * @version 1.0.4
    */
   breakpoint: BreakpointsTokenType | 'None';
   /**
    * Specifies the flex direction.
+   *
+   * @version 1.3.0
    */
   direction: ResponsiveType<FlexDirectionType>;
   /**
    * Controls the alignment of items within the flex container.
+   *
+   * @version 1.49.0
    */
   alignItems: ResponsiveType<FlexAlignItemType>;
   /**
    * Controls the alignment of content items and the distribution of
    *    space between and around them within the flex container.
+   *
+   * @version 1.3.0
    */
   justifyContent: ResponsiveType<FlexJustifyContentType>;
   /**
    * Determines whether flex items are confined to a single line or can wrap onto multiple lines based on available space.
+   *
+   * @version 2.6.0
    */
   flexWrap: ResponsiveType<FlexWrapType>;
   /**
    * 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
    */
   useNativeFlex: boolean;
   render(): VegaFlex;

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

@@ -8,6 +8,9 @@ import { VegaFontAs } from './types';
 import { VegaFontClassesController } from './slimmers/controllers/vega-font-classes-controller';
 import { VegaFontRenderer } from './slimmers/renderers/vega-font-renderer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.46.0
+ */
 export declare class VegaFont {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly pageResizeSlimmer: PageResizeObserverSlimmer;
@@ -20,15 +23,21 @@ export declare class VegaFont {
   currentBreakpoint: BreakpointsTokenType;
   /**
    * 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
    */
   variant: ResponsiveType<TypographyTokenType>;
   /**
    * Specifies the font color represented by a valid text color token.
+   *
+   * @version 1.46.0
    */
   color: TextColorsTokenType;
   /**
    * Specifies the capability to enable or disable the font's
    *      responsiveness from native code.
+   *
+   * @version 1.46.0
    */
   disableResponsive: boolean;
   /**
@@ -37,11 +46,15 @@ export declare class VegaFont {
    * This property determines how the text is aligned
    *   	within its container, and it is effective only when
    *   	the vega-font is styled as a block-level element.
+   *
+   * @version 2.9.0
    */
   textAlign: ResponsiveType<TextAlignType>;
   /**
    * 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
    */
   as: ResponsiveType<VegaFontAs>;
   watchAsChange(newValue: VegaFontAs): void;

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

@@ -5,6 +5,9 @@ import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { ChildNodesNotifyObserverSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-notify-observer-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.3.0
+ */
 export declare class VegaForm {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected submitEventEmitter: EventEmitSlimmerBase;
@@ -42,6 +45,8 @@ export declare 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
    */
   isValid: boolean | null;
   watchIsValid(): void;
@@ -53,36 +58,47 @@ export declare 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
    */
   isTouched: boolean;
   /**
    * An event emitter notifying the change in the validation result.
+   *
+   * @version 1.9.1
    */
   vegaValidate: EventEmitter<boolean>;
   /**
    * An event emitter notifying the change in the validation result.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   validate: EventEmitter<boolean>;
   /**
    * An event emitter notifying the submission of the form.
+   *
+   * @version 1.24.0
    */
   vegaFormSubmit: EventEmitter<unknown>;
   /**
    * An event emitter notifying the submission of the form.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   formSubmit: EventEmitter<unknown>;
   /**
    * An event emitter notifying the reset of the form.
+   *
+   * @version 1.24.0
    */
   vegaFormReset: EventEmitter;
   /**
    * An event emitter notifying the reset of the form.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   formReset: EventEmitter;
   /**
@@ -100,6 +116,7 @@ export declare 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
    */
   valid(showError?: boolean | 'rule'): Promise<FormValidateResult>;
   /**
@@ -108,6 +125,7 @@ export declare 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
    */
   getValue<T>(option?: FormControlOption): Promise<T>;
   /**
@@ -117,6 +135,7 @@ export declare 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
    */
   setValue<T>(value: T, option?: FormControlOption): Promise<void>;
   /**
@@ -126,6 +145,8 @@ export declare 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
    */
   reset(defaultValueMap?: unknown, option?: FormControlOption): Promise<void>;
   private static getFormFieldValue;

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

@@ -1,6 +1,9 @@
 import { ResponsiveType, GridRowsType, GridColumnsType, GapType } from '../../types/ui.type';
 import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.3.0
+ */
 export declare class VegaGrid {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaGridElement>;
@@ -22,6 +25,8 @@ export declare 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
    */
   column: ResponsiveType<GridColumnsType>;
   /**
@@ -41,6 +46,8 @@ export declare 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
    */
   row: ResponsiveType<GridRowsType>;
   /**
@@ -51,6 +58,8 @@ export declare class VegaGrid {
    * Alternatively, you can use a responsive map to define different gap values for
    *    various breakpoints. The keys in the map should represent the breakpoints,
    *    such as `default` or `L`, and the values should be spacing values.
+   *
+   * @version 1.3.0
    */
   gap: ResponsiveType<GapType>;
   render(): VegaGrid;

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

@@ -2,6 +2,7 @@ import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 /**
  * @VegaInternalComponent
+ * @version 2.20.1
  */
 export declare class VegaHint {
   protected readonly globalSlimmers: GlobalSlimmers;

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

@@ -1,6 +1,9 @@
 import { SpacingTokenType, TextColorsTokenType } from '../../types/design-token.type';
 import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.0.4
+ */
 export declare class VegaIcon {
   private static readonly iconStyleCache;
   protected readonly globalSlimmers: GlobalSlimmers;
@@ -8,6 +11,8 @@ export declare class VegaIcon {
   host: HTMLVegaIconElement;
   /**
    * Specifies the required icon design token for the icon.
+   *
+   * @version 1.0.4
    */
   icon: string;
   /**
@@ -19,12 +24,16 @@ export declare 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
    */
   size: SpacingTokenType;
   /**
    * Specifies the color of the icon.
    *
    * If the color prop is `undefined`, it defaults to `currentColor`.
+   *
+   * @version 1.26.0
    */
   color?: TextColorsTokenType;
   componentWillLoad(): void;

package/dist/types/components/vega-image-uploader/vega-image-uploader.d.ts

@@ -19,6 +19,9 @@ import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimm
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { ResponsiveType, SizeType } from '../../types/ui.type';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.14.0
+ */
 export declare class VegaImageUploader {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaImageUploaderRenderer: VegaImageUploaderRenderer;
@@ -43,49 +46,71 @@ export declare class VegaImageUploader {
    * Determines the visual content that is initially displayed in
    *    the image uploader component, thereby providing a preview of
    *    the uploaded image or a default placeholder.
+   *
+   * @version 1.14.0
    */
   value: VegaFile | null;
   watchValue(): void;
   /**
    * Specifies the allowed file types for upload.
+   *
+   * @version 1.14.0
    */
   accept: string;
   /**
    * Controls the display of the upload status (`uploading`, `done`).
    *    If not set, the status remains invisible.
+   *
+   * @version 1.14.0
    */
   status: VegaImageUploaderStatus | undefined;
   /**
    * Determines whether to show the preview button.
+   *
+   * @version 1.14.0
    */
   showPreviewButton: boolean;
   /**
    * Determines whether to show the remove button.
+   *
+   * @version 1.14.0
    */
   showRemoveButton: boolean;
   /**
    * Determines whether to show the replace button.
+   *
+   * @version 1.39.2
    */
   showReplaceButton: boolean;
   /**
    * Specifies whether the Image Uploader field is disabled.
+   *
+   * @version 1.14.0
    */
   disabled: boolean;
   /**
    * Specifies whether uploading an image is mandatory.
+   *
+   * @version 1.14.0
    */
   required: boolean;
   /**
    * Specifies the validation status.
+   *
+   * @version 1.14.0
    */
   isValid: boolean | null;
   /**
    * Determines whether automatic validation should be
    *    implemented for image uploads.
+   *
+   * @version 1.14.0
    */
   autoValidation: boolean;
   /**
    * Specifies custom validation rules for image uploads.
+   *
+   * @version 1.14.0
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
@@ -93,67 +118,90 @@ export declare class VegaImageUploader {
    * Specifies the label or title for the image uploader.
    *    It provides descriptive text that helps identify
    *    the purpose of the image uploader.
+   *
+   * @version 2.5.0
    */
   label: string;
   /**
    * Provides a supplementary prompt message that assists users in
    *    understanding the expected value for the image uploader field.
+   *
+   * @version 2.9.0
    */
   hint: string;
   /**
    * Specifies the action title for the image uploader.
    *    This property provides descriptive text that identifies
    *    the intended action or function of the image uploader.
+   *
+   * @version 2.9.0
    */
   actionTitle: string;
   /**
    * Specifies the action sub-title for the image uploader.
    *    This property provides descriptive text that identifies
    *    the intended action or function of the image uploader.
+   *
+   * @version 2.9.0
    */
   actionSubTitle: string;
   /**
    * Defines the width of the image uploader field.
+   *
+   * @version 2.9.0
    */
   width: ResponsiveType<SizeType>;
   /**
    * Defines the height of the image uploader field.
+   *
+   * @version 2.9.0
    */
   height: ResponsiveType<SizeType>;
   /**
    * An event emitter notifying a value change.
+   *
+   * @version 1.14.0
    */
   vegaChange: EventEmitter<VegaFileOptional>;
   /**
    * An event emitter notifying a value change.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   change: EventEmitter;
   /**
    * An event emitter notifying the removal of a value.
+   *
+   * @version 1.14.0
    */
   vegaRemove: EventEmitter;
   /**
    * An event emitter notifying the removal of a value.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   remove: EventEmitter;
   /**
    * An event emitter notifying the cancellation of an uploading event.
+   *
+   * @version 1.14.0
    */
   vegaCancel: EventEmitter;
   /**
    * An event emitter notifying the removal of a value.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   cancel: EventEmitter;
   disconnectedCallback(): void;
   /**
    * Invoke this method to retrieve the image preview URL for
    *    the current selection in the `vega-image-uploader` component.
+   *
+   * @version 1.45.0
    */
   getContentURL(file?: VegaFile): Promise<Nullable<string>>;
   render(): VegaImageUploader;