@globalpayments/vega 2.23.0 → 2.24.2

package/dist/types/components/vega-dropdown/vega-dropdown-group/vega-dropdown-group.d.ts

@@ -1,6 +1,9 @@
 import { GlobalSlimmers } from '../../../vega-slimmer/vega-slimmer-core';
 import { VegaDropdownGroupRenderer } from './slimmers/renderers/vega-dropdown-group-renderer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.47.0
+ */
 export declare class VegaDropdownGroup {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly renderer: VegaDropdownGroupRenderer;
@@ -8,11 +11,15 @@ export declare class VegaDropdownGroup {
   host: HTMLVegaDropdownGroupElement;
   /**
    * Specifies the label for the dropdown group's level.
+   *
+   * @version 1.47.0
    */
   label: string;
   /**
    * Determines whether to include a dividing line at
    *      the bottom of the dropdown group.
+   *
+   * @version 1.47.0
    */
   divide: boolean;
   render(): VegaDropdownGroup;

package/dist/types/components/vega-dropdown/vega-dropdown-item/slimmers/renderers/vega-dropdown-item-renderer.d.ts

@@ -11,6 +11,7 @@ export declare class VegaDropdownItemRenderer extends VegaSlimmer {
   selectType: VegaDropdownItem['selectType'];
   height: VegaDropdownItem['height'];
   itemDisplayRule: VegaDropdownItem['itemDisplayRule'];
+  danger: VegaDropdownItem['danger'];
   vegaDropdownItemClickController: VegaDropdownItem['vegaDropdownItemClickController'];
   render(): HTMLElement;
   private renderSelectIcon;

package/dist/types/components/vega-dropdown/vega-dropdown-item/vega-dropdown-item.d.ts

@@ -7,6 +7,9 @@ import { VegaDropdownItemClickController } from './slimmers/controllers/vega-dro
 import { ChildNodesEventPreventSlimmer } from '../../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { EventEmitSlimmerBase } from '../../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.47.0
+ */
 export declare class VegaDropdownItem {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly renderer: VegaDropdownItemRenderer;
@@ -35,36 +38,57 @@ export declare class VegaDropdownItem {
   itemDisplayRule: 'ellipsis' | 'newline';
   /**
    * Specifies the label for the dropdown item.
+   *
+   * @version 1.47.0
    */
   label: string;
   /**
    * Specifies the key for the dropdown item.
+   *
+   * @version 1.47.0
    */
   itemKey: string;
   /**
    * Specifies the dropdown item's count.
+   *
+   * @version 1.47.0
    */
   count: number;
   /**
    * Specifies the prefix icon for the dropdown item.
+   *
+   * @version 1.47.0
    */
   prefixIcon: string;
   /**
    * Specifies the disabled status of the dropdown item.
+   *
+   * @version 1.47.0
    */
   disabled: boolean;
   /**
    * Specifies the height of the dropdown item.
+   *
+   * @version 1.47.0
    */
   height: number;
+  /**
+   * Specifies whether the dropdown item represents a danger action.
+   * 	  It highlights actions that may have critical consequences
+   * 	     when the select type is set to none.
+   */
+  danger: boolean;
   /**
    * An event emitter notifying the dropdown item has been clicked.
+   *
+   * @version 1.47.0
    */
   vegaClick: EventEmitter<VegaDropdownItemClickEvent>;
   /**
    * An event emitter notifying the dropdown item has been clicked.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   click: EventEmitter<VegaDropdownItemClickEvent>;
   render(): VegaDropdownItem;

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

@@ -21,6 +21,9 @@ import { ChildNodesNotifyObserverSlimmer } from '../../helpers/event-manager/sli
 import { VegaDropdownItemClickEvent } from './vega-dropdown-item/types';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaDropdownScrollableController } from './slimmers/controllers/vega-dropdown-scrollable-controller';
+/**
+ * @version 1.3.0
+ */
 export declare class VegaDropdown {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected readonly renderer: VegaDropdownRenderer;
@@ -62,10 +65,14 @@ export declare class VegaDropdown {
    *    It can be provided as a number or a ResponsiveType.
    *
    * If no size is set, the dropdown will default to fitting the item content width.
+   *
+   * @version 1.3.0
    */
   size: ResponsiveType<SizeType>;
   /**
    * Specifies the trigger mode for the dropdown.
+   *
+   * @version 1.3.0
    */
   trigger: 'hover' | 'click' | 'none';
   /**
@@ -73,11 +80,15 @@ export declare class VegaDropdown {
    *    relative to the target element.
    *
    * By default, the dropdown is displayed on the left-bottom of the target.
+   *
+   * @version 1.3.0
    */
   translocation: ResponsiveType<TranslocationType>;
   /**
    * Sets the source array of items for the dropdown,
    *    where each item must have a `key` and `label` property.
+   *
+   * @version 1.3.0
    */
   source: VegaDropdownSourceItem[];
   watchSource(): void;
@@ -87,6 +98,8 @@ export declare class VegaDropdown {
    *
    * If not specified, the dropdown will be appended to the menu by default.
    *    Adjust this property when facing scrolling positioning problems.
+   *
+   * @version 1.3.0
    */
   positionRelativeTo: string;
   /**
@@ -103,45 +116,63 @@ export declare class VegaDropdown {
    *      When an item with a key found in the `selectedSourceKey` array is selected,
    *      this mode releases the `vegaDropdownClick` event. Unlike the others, however,
    *      Determines the selection mode for multiple item selection.
+   *
+   * @version 1.3.0
    */
   selectType: 'none' | 'single' | 'multiple';
   watchSelectType(): void;
   /**
    * Represents the key corresponding to the selected item in the dropdown menu.
    *    It becomes active only when `selectType` is set to `single` or `multiple`.
+   *
+   * @version 1.3.0
    */
   selectedSourceKey: string | string[];
   watchSelectedSourceKey(): void;
   /**
    * Controls whether the prefix icon occupy a position, even if prefix has no value.
+   *
+   * @version 1.47.0
    */
   prefixIconSlot: boolean;
   watchPrefixIconSlot(): void;
   /**
    * Specifies the maximum height for the dropdown.
+   *
+   * @version 1.3.0
    */
   maxHeight: number;
   /**
    * Controls whether the dropdown list can be searched.
+   *
+   * @version 1.3.0
    */
   searchable: boolean;
   /**
    * Determines whether the dropdown should have the
    *    same width as the target element.
+   *
+   * @version 1.3.0
    */
   matchTargetWidth: boolean;
   /**
    * Specifies the minimum width of the dropdown. It can be provided as
    *    a number or a ResponsiveType.
+   *
+   * @version 1.13.0
    */
   minWidth: ResponsiveType<SizeType>;
   /**
    * Specifies the maximum width of the dropdown. It can be provided as
    *    a number or a ResponsiveType.
+   *
+   * @version 1.13.0
    */
   maxWidth: ResponsiveType<SizeType>;
   /**
    * Specifies the display rule for items in the dropdown.
+   *
+   * @version 1.13.0
    */
   itemDisplayRule: 'ellipsis' | 'newline';
   watchItemDisplayRule(): void;
@@ -151,6 +182,8 @@ export declare class VegaDropdown {
    *
    * If set to `true`, the dropdown will always be positioned at
    *    the bottom of the available space.
+   *
+   * @version 1.3.0
    */
   matchContainerHeight: boolean;
   /**
@@ -158,12 +191,16 @@ export declare class VegaDropdown {
    *
    * Note that the default filter rules are fuzzy matching and case-insensitive.
    *    This parameter only takes effect when `searchable` is set to `true`.
+   *
+   * @version 1.4.0
    */
   caseSensitive: boolean;
   /**
    * Controls whether the dropdown can add a new item when
    *    no proper item is available. It becomes active only when
    *    `searchable` is set to `true`.
+   *
+   * @version 1.16.0
    */
   dynamicOption: boolean;
   /**
@@ -175,30 +212,42 @@ export declare class VegaDropdown {
    *
    * Note that the `dynamicOption` property will not work when
    *    this property is set to `false`.
+   *
+   * @version 1.24.0
    */
   useDefaultFilter: boolean;
   /**
    * Determines whether the dropdown displays a loading status.
+   *
+   * @version 1.24.0
    */
   isLoading: boolean;
   /**
    * Specifies the vertical positioning of the dropdown
    *    within its container or relative to a reference point.
+   *
+   * @version 1.41.0
    */
   placement: ElementAppenderPlacementType;
   /**
    * Determines the horizontal positioning of the dropdown
    *    within its container or relative to a reference point.
+   *
+   * @version 1.41.0
    */
   alignment: ElementAppenderAlignmentType;
   /**
    * Determines whether the dropdown displays a lazy loading status.
+   *
+   * @version 2.3.0
    */
   isLazyLoading: boolean;
   /**
    * An event emitter notifying that a dropdown item has been clicked.
    *
    * The event's `detail` property contains the key of the clicked item.
+   *
+   * @version 1.11.0
    */
   vegaDropdownClick: EventEmitter<string>;
   /**
@@ -206,11 +255,14 @@ export declare class VegaDropdown {
    *
    * The event's `detail` property contains the key of the clicked item.
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   dropdownClick: EventEmitter<string>;
   /**
    * An event emitter notifying that the dropdown has been displayed,
    *    either programmatically or via user interaction.
+   *
+   * @version 1.3.0
    */
   vegaShow: EventEmitter<string>;
   /**
@@ -218,11 +270,14 @@ export declare class VegaDropdown {
    *    either programmatically or via user interaction. The name is not `show` because already has a method `show`.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   dropdownShow: EventEmitter<string>;
   /**
    * Event emitter notifying that the dropdown has been dismissed,
    *    either programmatically or via user interaction.
+   *
+   * @version 1.3.0
    */
   vegaHide: EventEmitter<string>;
   /**
@@ -230,6 +285,7 @@ export declare class VegaDropdown {
    *    either programmatically or via user interaction. The name is not `hide` because already has a method `hide`.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   dropdownHide: EventEmitter<string>;
   /**
@@ -239,6 +295,8 @@ export declare class VegaDropdown {
    * The event's `detail` property contains the new value.
    *
    * The dropdown _does not_ automatically add the new value to the source list.
+   *
+   * @version 1.14.0
    */
   vegaCreate: EventEmitter<string>;
   /**
@@ -250,11 +308,14 @@ export declare class VegaDropdown {
    * The dropdown _does not_ automatically add the new value to the source list.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   create: EventEmitter<string>;
   /**
    * An event emitter notifying the search event in the dropdown,
    *    but only if `useDefaultFilter` is set to `false`.
+   *
+   * @version 1.24.0
    */
   vegaSearch: EventEmitter<string>;
   /**
@@ -262,14 +323,19 @@ export declare class VegaDropdown {
    *    but only if `useDefaultFilter` is set to `false`. The name is not `search` because already has a method `search`.
    *
    * @eventSemantics namespace:native
+   * @version 2.0.0
    */
   dropdownSearch: EventEmitter<string>;
   /**
    * Invoke this method to programmatically display the dropdown menu.
+   *
+   * @version 1.3.0
    */
   show(): Promise<void>;
   /**
    * Invoke this method to programmatically dismiss the dropdown menu.
+   *
+   * @version 1.3.0
    */
   hide(): Promise<void>;
   /**
@@ -277,17 +343,23 @@ export declare class VegaDropdown {
    *    filter the list of items in the dropdown.
    *
    * This method is applicable only when the dropdown is searchable.
+   *
+   * @version 1.11.0
    */
   search(input: string): Promise<void>;
   /**
    * Invoke this method to clear the selected items keys,
    *    removing any current selection.
+   *
+   * @version 1.47.0
    */
   clearSelection(): Promise<void>;
   /**
    * Invoke this method to retrieve the selected items keys,
    *    providing an key or list of the keys representing
    *    the currently selected items.
+   *
+   * @version 1.47.0
    */
   getSelection(): Promise<string[] | string>;
   /**
@@ -296,6 +368,7 @@ export declare class VegaDropdown {
    *    the desired selected items.
    *
    * @param {string[]} keys - Row keys to be set as selected.
+   * @version 1.47.0
    */
   setSelection(keys: string[] | string): Promise<void>;
   render(): VegaDropdown;

package/dist/types/components/vega-field-error/vega-field-error.d.ts

@@ -1,6 +1,9 @@
 import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 import { VegaFieldErrorMessageController } from './slimmers/controllers/vega-field-error-message-controller';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+/**
+ * @version 1.45.0
+ */
 export declare class VegaFieldError {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected messageController: VegaFieldErrorMessageController;
@@ -9,6 +12,8 @@ export declare class VegaFieldError {
   /**
    * Specifies the error message when the input field should display an error.
    *    The input field will clear the error status when the message is empty.
+   *
+   * @version 1.45.0
    */
   message: string;
   watchMessage(): void;

package/dist/types/components/vega-field-label/vega-field-label.d.ts

@@ -3,6 +3,9 @@ import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
 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.10.0
+ */
 export declare class VegaFieldLabel {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected clickEventEmitter: EventEmitSlimmerBase;
@@ -15,20 +18,28 @@ export declare class VegaFieldLabel {
    *
    * It provides descriptive text that helps identify the
    *    purpose or content expected in the field.
+   *
+   * @version 1.10.0
    */
   label: string;
   /**
    * Determines whether the input field is required.
    *
    * Specifies whether the field must be filled in to pass form validation.
+   *
+   * @version 1.10.0
    */
   isFieldRequired: boolean;
   /**
    * Specifies whether the field is disabled.
+   *
+   * @version 1.10.0
    */
   disabled: boolean;
   /**
    * An event emitter notifying that the field label has been clicked.
+   *
+   * @version 1.43.0
    */
   vegaClick: EventEmitter;
   componentWillLoad(): void;

package/dist/types/components/vega-file-uploader/slimmers/controllers/vega-file-uploader-value-controller.d.ts

@@ -0,0 +1,21 @@
+import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
+import { VegaFileUploader } from '../../vega-file-uploader';
+import { VegaFileUploaderFile } from '../../types';
+/** manages the value and change events for a file uploader component. */
+export declare class VegaFileUploaderValueController extends VegaSlimmer {
+  protected host: VegaFileUploader['host'];
+  protected value: VegaFileUploader['value'];
+  protected changeEventEmitter: VegaFileUploader['changeEventEmitter'];
+  /**
+   * Emit the change event and notify the value change subject when component value change, reset the value to null if the value is not valid
+   *
+   * @param {VegaFileUploaderFile[]} newValue The new value
+   */
+  valueChangeHandler(newValue: VegaFileUploaderFile[]): void;
+  /**
+   * Set the component value to a new value
+   *
+   * @param {VegaFileUploaderFile[]|null} value The new value
+   */
+  setValue(value: VegaFileUploaderFile[] | null): void;
+}

package/dist/types/components/vega-file-uploader/slimmers/renderers/vega-file-uploader-container-renderer.d.ts

@@ -0,0 +1,76 @@
+import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
+import { VegaFileUploader } from '../../vega-file-uploader';
+export declare class VegaFileUploaderContainerRenderer extends VegaSlimmer {
+  protected variant: VegaFileUploader['variant'];
+  protected accept: VegaFileUploader['accept'];
+  protected disabled: VegaFileUploader['disabled'];
+  protected value: VegaFileUploader['value'];
+  protected selectFileChangeEventEmitter: VegaFileUploader['selectFileChangeEventEmitter'];
+  protected vegaFileUploaderValueController: VegaFileUploader['vegaFileUploaderValueController'];
+  private inputElementRef;
+  private uploaderContainerRef;
+  /**
+   * The function `getUploaderContainerRef` returns a reference to an HTMLDivElement element.
+   * @returns {HTMLDivElement} An HTMLDivElement with the reference to the uploader container.
+   */
+  getUploaderContainerRef(): HTMLDivElement;
+  /**
+   * generating the HTML structure of the file uploader component
+   *
+   * @returns {HTMLElement} uploader component upload area element
+   */
+  render(): HTMLElement;
+  /**
+   * An upload button element
+   *
+   * @returns {HTMLElement} html element
+   */
+  private renderUploadButton;
+  /**
+   * The uploader file drop area element
+   *
+   * @returns {HTMLElement} html element
+   */
+  private renderUploadDropArea;
+  /**
+   * An event handler function that is triggered when the drop area is clicked
+   *
+   * @param {MouseEvent} e click event object
+   */
+  private handleDropAreaClick;
+  /**
+   * Trigger a click event on the native input element.
+   */
+  private triggerFileInputClick;
+  /**
+   * An event handler function that is triggered when the input file is changed
+   *
+   * @param {MouseEvent} e change event object
+   */
+  private inputChangeHandler;
+  /**
+   * an event handler that is triggered when files are dropped onto the file uploader drop area
+   *
+   * @param {DragEvent} e drag event object
+   */
+  private dropHandler;
+  /**
+   * Used to prevent the default behavior of the browser when a drag event occurs, such as preventing the browser from opening the file when it is dropped onto the page.
+   *
+   * @param {DragEvent} e drag event object
+   */
+  private preventDefaultBehavior;
+  /**
+   * emits a custom event with selected files and updates the value if the event is not prevented.
+   *
+   * @param {VegaFileUploaderFile[]} files - The `files` parameter in the `selectFileChangeEventEmitHandler` method is an array of `VegaFileUploaderFile` objects.
+   */
+  private selectFileChangeEventEmitHandler;
+  /**
+   * extracting the files from a file list object. It first initializes an empty array `result` to store the extracted files
+   *
+   * @param {FileList} fileList file list object
+   * @returns {VegaFileUploaderFile[]} the vega file array
+   */
+  private getVegaFilesFromFileList;
+}

package/dist/types/components/vega-file-uploader/slimmers/renderers/vega-file-uploader-file-list-renderer.d.ts

@@ -0,0 +1,38 @@
+import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
+import { VegaFileUploader } from '../../vega-file-uploader';
+/** renders a list of files for a file uploader component. */
+export declare class VegaFileUploaderFileListRenderer extends VegaSlimmer {
+  protected value: VegaFileUploader['value'];
+  protected disabled: VegaFileUploader['disabled'];
+  protected vegaFileUploaderFileStatusRenderer: VegaFileUploader['vegaFileUploaderFileStatusRenderer'];
+  protected removeEventEmitter: VegaFileUploader['removeEventEmitter'];
+  protected vegaFileUploaderValueController: VegaFileUploader['vegaFileUploaderValueController'];
+  protected retryEventEmitter: VegaFileUploader['retryEventEmitter'];
+  protected previewEventEmitter: VegaFileUploader['previewEventEmitter'];
+  /**
+   * The function renders a list of file within a div element based on the value provided.
+   *
+   * @returns {HTMLElement} An HTMLElement containing a div element with class 'file-uploader-file-list' and
+   * 'file-list-hidden' if the value is empty. If the value is not empty, it will map over the value
+   * array and return a div element for each file with the file name displayed.
+   */
+  render(): HTMLElement;
+  /**
+   * Used to trigger an event or action related to remove a specific file in the file uploader component
+   *
+   * @param {VegaFileUploaderFile} file the vega file object
+   */
+  private fileRemoveHandler;
+  /**
+   * Used to trigger an event or action related to retrying the upload of a specific file in the file uploader component
+   *
+   * @param {VegaFileUploaderFile} file the vega file object
+   */
+  private fileReUploadHandler;
+  /**
+   * Used to trigger an event or action related to preview of a specific file in the file uploader component
+   *
+   * @param {VegaFileUploaderFile} file the vega file object
+   */
+  private filePreviewHandler;
+}

package/dist/types/components/vega-file-uploader/slimmers/renderers/vega-file-uploader-file-status-renderer.d.ts

@@ -0,0 +1,6 @@
+import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
+import { VegaFileUploaderFileStatus } from '../../types';
+/** renders file status for a file uploader component. */
+export declare class VegaFileUploaderFileStatusRenderer extends VegaSlimmer {
+  render(status: VegaFileUploaderFileStatus, uploadingPercent: number): HTMLElement;
+}

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

@@ -0,0 +1,18 @@
+import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
+import { VegaFileUploader } from '../../vega-file-uploader';
+/** renders a file uploader component with specified properties. */
+export declare class VegaFileUploaderRenderer extends VegaSlimmer {
+  protected required: VegaFileUploader['required'];
+  protected disabled: VegaFileUploader['disabled'];
+  protected label: VegaFileUploader['label'];
+  protected hint: VegaFileUploader['hint'];
+  protected vegaFileUploaderContainerRenderer: VegaFileUploader['vegaFileUploaderContainerRenderer'];
+  protected vegaFileUploaderFileListRenderer: VegaFileUploader['vegaFileUploaderFileListRenderer'];
+  /**
+   * The render function returns a JSX element that includes a field label, file uploader button, hint, and file list renderer.
+   *
+   * @returns {HTMLElement} An HTMLElement containing a fragment with a vega-field-label component, a
+   * vegaFileUploaderContainerRenderer element, a vega-hint component (if hint is provided), and a vegaFileUploaderFileListRenderer element.
+   */
+  render(): HTMLElement;
+}