@globalpayments/vega 2.24.2 → 2.25.0

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

@@ -0,0 +1,80 @@
+import { BackgroundColorsTokenType } from '../../types/design-token.type';
+import { CalendarEvent } from '../../helpers/calendar/calendar-event';
+import { DropdownSourceGroup, DropdownSourceItem } from '../vega-dropdown/types';
+
+export type VegaCalendarViewModeType = 'month' | 'week' | 'day';
+
+export type VegaCalendarDateType = {
+	date: number;
+	month: number;
+	year: number;
+};
+
+export type VegaCalendarChangeEventType = {
+	currentPeriod: {
+		year: number;
+		month: number;
+		startDate: VegaCalendarDateType;
+		endDate: VegaCalendarDateType;
+	};
+	viewMode: VegaCalendarViewModeType;
+};
+
+export type VegaCalendarEventRepeatType = 'daily' | 'weekly' | 'monthly' | 'yearly';
+
+export type VegaCalendarEventVariantType = 'primary' | 'secondary' | 'tertiary';
+
+export interface VegaCalendarRawEvent {
+	key: string;
+	title: string;
+	variant?: VegaCalendarEventVariantType;
+	startDate: string | Date;
+	endDate?: string | Date;
+	startTime?: string;
+	endTime?: string;
+	isAllDay?: boolean;
+	color?: string | BackgroundColorsTokenType;
+	disabled?: boolean;
+	repeatOptions?: VegaCalendarEventRepeatOptions;
+}
+
+export type VegaCalendarEventClickInfo = {
+	rawEvent: VegaCalendarRawEvent;
+};
+
+export type VegaCalendarDateClickInfo = VegaCalendarDateType & { hour: number };
+
+export type VegaCalendarEventStyle = {
+	position: 'absolute';
+	left: string;
+	top: string;
+	width: string;
+	height?: string;
+	zIndex?: string;
+	opacity?: string;
+};
+
+export type VegaCalendarFullDayEventView = {
+	event: CalendarEvent;
+	start: number;
+	end: number;
+};
+
+export type VegaCalendarWeekDayType = 'Sun' | 'Mon' | 'Tue' | 'Wed' | 'Thu' | 'Fri' | 'Sat';
+
+export type VegaCalendarEventRepeatOptions = {
+	frequency: VegaCalendarEventRepeatType;
+	interval?: number;
+	count?: number;
+	until?: string | Date;
+	byWeekDay?: VegaCalendarWeekDayType[];
+};
+
+export type DropdownPropsForCalendar = {
+	matchContainerHeight?: boolean;
+	matchTargetWidth?: boolean;
+	maxHeight?: number;
+	positionRelativeTo?: string;
+	trigger?: 'hover' | 'click';
+	source: (DropdownSourceGroup | DropdownSourceItem)[];
+};

package/dist/types/components/vega-chart/vega-bar-chart/types.d.ts

@@ -0,0 +1,4 @@
+import { ChartOptions } from '../../../types/vega-chart';
+import { BarChartDataType } from '../../../helpers/chart/bar-chart';
+
+export type VegaBarChartOptionsType = Partial<Omit<ChartOptions<BarChartDataType>, 'container'>>;

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

@@ -88,6 +88,8 @@ export declare class VegaCheckbox {
   /**
    * An event emitter notifying changes in the value of the checkbox,
    *    whether triggered programmatically or through user interaction.
+   *
+   * @version 1.0.10
    */
   vegaChange: EventEmitter<string | boolean>;
   /**

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

@@ -0,0 +1,4 @@
+export type VegaChipVariant = 'filled-background' | 'outlined';
+export type VegaChipSize = 'extra-small' | 'small' | 'default' | 'large';
+export type VegaChipType = 'status' | 'label';
+export type VegaChipIconAlign = 'left' | 'right';

package/dist/types/components/vega-combo-box/types.d.ts

@@ -0,0 +1,9 @@
+import { VegaComponentInterface } from '../../types/ui.type';
+
+export type VegaDropdownPropsForComboBox = Partial<
+	Pick<
+		VegaComponentInterface<HTMLVegaDropdownElement>,
+		'positionRelativeTo' | 'maxHeight' | 'matchContainerHeight' | 'dynamicOption' | 'isLoading'
+	>
+>;
+export type VegaComboBoxSize = 'small' | 'medium';

package/dist/types/components/vega-date-picker/types.d.ts

@@ -0,0 +1,10 @@
+export type DatePickerModeType = 'single' | 'range';
+
+export type DatePickerValueType<T extends DatePickerModeType> = T extends 'single'
+	? string
+	: [string, string];
+
+export type DropdownConfigForDatePicker = {
+	positionRelativeTo?: string;
+	staticHeight?: boolean;
+};

package/dist/types/components/vega-date-picker/vega-date-picker.d.ts

@@ -196,6 +196,7 @@ export declare class VegaDatePicker {
    *    associated with the date picker.
    *
    * @see{module:vega-date-picker-click-call-do-open-close}
+   * @version 1.3.0
    */
   doClose(): Promise<void>;
   /**
@@ -203,6 +204,7 @@ export declare class VegaDatePicker {
    *    associated with the date picker.
    *
    * @see{module:vega-date-picker-click-call-do-open-close}
+   * @version 1.3.0
    */
   doOpen(): Promise<void>;
   render(): VegaDatePicker;

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

@@ -0,0 +1,14 @@
+import { VegaComponentInterface } from '../../types/ui.type';
+
+export type VegaDialogActionButtonProps = Partial<
+	Pick<
+		VegaComponentInterface<HTMLVegaButtonElement>,
+		'variant' | 'size' | 'icon' | 'iconAlign' | 'label' | 'disabled'
+	>
+>;
+
+/**
+ * - The dialog will be closed by default if the callback is undefined.
+ * - Will close the dialog if the callback return true, otherwise not close
+ */
+export type VegaDialogAction = ((e: CustomEvent<void>) => boolean) | undefined;

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

@@ -0,0 +1,21 @@
+export type DropdownSourceItem = {
+	label: string;
+	key: string;
+	count?: number;
+	prefixIcon?: string;
+	disabled?: boolean;
+	danger?: boolean;
+};
+
+export type DropdownSourceGroup = {
+	label: string;
+	key: string;
+	children: DropdownSourceItem[];
+};
+
+export type VegaDropdownItemSelectionObserverPayload = {
+	host: HTMLVegaDropdownItemElement;
+	itemKey: string;
+};
+
+export type VegaDropdownSourceItem = DropdownSourceItem | DropdownSourceGroup;

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

@@ -0,0 +1 @@
+export type VegaDropdownItemClickEvent = { itemKey: string };

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

@@ -76,6 +76,8 @@ export declare class VegaDropdownItem {
    * 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.
+   *
+   * @version 2.25.0
    */
   danger: boolean;
   /**

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

@@ -0,0 +1,4 @@
+export type FieldErrorEventPayload = {
+	host: HTMLVegaFieldErrorElement;
+	message: string;
+};

package/dist/types/components/vega-field-label/slimmers/renderers/vega-field-label-suffix-element-renderer.d.ts

@@ -0,0 +1,27 @@
+import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
+import { VegaFieldLabel } from '../../vega-field-label';
+import { Nullable } from '../../../../types/general';
+/** Render the suffix button in a field label component. */
+export declare class VegaFieldLabelSuffixElementRenderer extends VegaSlimmer {
+  protected suffixButtonProps: VegaFieldLabel['suffixButtonProps'];
+  protected suffixButtonClickEventEmitter: VegaFieldLabel['suffixButtonClickEventEmitter'];
+  /**
+   * Render a suffix button if the property is not empty.
+   *
+   * @returns {HTMLElement | null}
+   */
+  render(): Nullable<HTMLElement>;
+  /**
+   * Render a vega button circle component.
+   *
+   * @param {string} icon the button icon name
+   * @returns {HTMLElement} vega button circle component
+   */
+  private renderSuffixButton;
+  /**
+   * Stop click event propagation and emit an event.
+   *
+   * @param {MouseEvent} e click event object
+   */
+  private handleSuffixButtonClick;
+}

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

@@ -0,0 +1,5 @@
+export type LabelSuffixButtonProps = {
+	icon: string;
+	tooltipText?: string;
+	trigger?: 'hover' | 'click';
+};

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

@@ -1,18 +1,28 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 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';
+import { LabelSuffixButtonProps } from './types';
+import { VegaFieldLabelSuffixElementRenderer } from './slimmers/renderers/vega-field-label-suffix-element-renderer';
 /**
  * @version 1.10.0
  */
 export declare class VegaFieldLabel {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected clickEventEmitter: EventEmitSlimmerBase;
-  protected inputEventPrevent: ChildNodesEventPreventSlimmer;
+  protected suffixButtonClickEventEmitter: EventEmitSlimmerBase;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaFieldLabelElement>;
-  private labelRef;
+  protected suffixElementRenderer: VegaFieldLabelSuffixElementRenderer;
   host: HTMLVegaFieldLabelElement;
+  /**
+   * 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
+   */
+  suffixButtonProps: LabelSuffixButtonProps;
   /**
    * Specifies the label or title for the field.
    *
@@ -42,6 +52,19 @@ export declare class VegaFieldLabel {
    * @version 1.43.0
    */
   vegaClick: EventEmitter;
+  /**
+   * 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;
   componentWillLoad(): void;
   render(): VegaFieldLabel;
   private handleClick;

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

@@ -0,0 +1,15 @@
+export type VegaFileUploaderType = 'uploadArea' | 'uploadButton';
+
+export type VegaFileUploaderFileStatus = 'done' | 'uploading' | 'error';
+
+export type VegaFileUploaderFile = {
+	key: string;
+	name: string;
+	url: string | File;
+	previewable?: boolean;
+	status?: VegaFileUploaderFileStatus;
+	errorMessage?: string;
+	uploadingPercent?: number;
+};
+
+export type VegaFileUploaderFiles = VegaFileUploaderFile[];

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

@@ -10,6 +10,9 @@ import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event
 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';
+/**
+ * @version 2.25.0
+ */
 export declare class VegaFileUploader {
   protected readonly globalSlimmers: GlobalSlimmers;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaFileUploaderElement>;
@@ -30,22 +33,30 @@ export declare class VegaFileUploader {
    *
    * It provides descriptive text that helps identify the
    *    purpose or content expected in the field.
+   *
+   * @version 2.25.0
    */
   label: string;
   /**
    * Specifies the uploader type that activates when clicked
    *    or when a file is dragged, determining how users
    *    interact with the file uploader.
+   *
+   * @version 2.25.0
    */
   variant: VegaFileUploaderType;
   /**
    * Provides a supplementary prompt message that assists users in
    *    understanding the expected value for the file uploader field.
+   *
+   * @version 2.25.0
    */
   hint: string;
   /**
    * Specifies the initial file content to display, enabling a preview
    *    of the uploaded file or a default placeholder.
+   *
+   * @version 2.25.0
    */
   value: VegaFileUploaderFile[];
   /**
@@ -56,43 +67,60 @@ export declare class VegaFileUploader {
   watchValue(newValue: VegaFileUploaderFile[]): void;
   /**
    * Specifies whether the File Uploader field is disabled.
+   *
+   * @version 2.25.0
    */
   disabled: boolean;
   /**
    * Specifies whether uploading a file is mandatory.
+   *
+   * @version 2.25.0
    */
   required: boolean;
   /**
    * Defines custom validation rules for the File Uploader field.
+   *
+   * @version 2.25.0
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
   /**
    * Determines whether the input field should undergo automatic validation
    *    during the user's input.
+   *
+   * @version 2.25.0
    */
   autoValidation: boolean;
   /**
    * Specifies the validation status of the file uploader component.
+   *
+   * @version 2.25.0
    */
   isValid: boolean;
   /**
    * Specifies the allowed file types for upload.
+   *
+   * @version 2.25.0
    */
   accept: string;
   /**
    * An event emitter notifying a change in the file list.
+   *
+   * @version 2.25.0
    */
   vegaChange: EventEmitter<VegaFileUploaderFiles>;
   /**
    * An event emitter notifying a change in the file list.
    *
    * @eventSemantics namespace:native
+   * @version 2.25.0
    */
   change: EventEmitter<VegaFileUploaderFiles>;
   /**
    * An event emitter notifying a file selection change. By default, the component value
    *   is updated, but this behavior can be prevented.
+   *
+   * @version 2.25.0
    */
   vegaSelectedFileChange: EventEmitter<VegaFileUploaderFiles>;
   /**
@@ -100,11 +128,14 @@ export declare class VegaFileUploader {
    *   is updated, but this behavior can be prevented.
    *
    * @eventSemantics namespace:native
+   * @version 2.25.0
    */
   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.
+   *
+   * @version 2.25.0
    */
   vegaRemove: EventEmitter<VegaFileUploaderFile>;
   /**
@@ -112,26 +143,33 @@ export declare class VegaFileUploader {
    *   is updated, but this behavior can be prevented.
    *
    * @eventSemantics namespace:native
+   * @version 2.25.0
    */
   remove: EventEmitter<VegaFileUploaderFile>;
   /**
    * An event emitter notifying that a file will be re-uploaded.
+   *
+   * @version 2.25.0
    */
   vegaRetry: EventEmitter<VegaFileUploaderFile>;
   /**
    * An event emitter notifying that a file will be re-uploaded.
    *
    * @eventSemantics namespace:native
+   * @version 2.25.0
    */
   retry: EventEmitter<VegaFileUploaderFile>;
   /**
    * An event emitter notifying that a file will be opened for preview.
+   *
+   * @version 2.25.0
    */
   vegaPreview: EventEmitter<VegaFileUploaderFile>;
   /**
    * An event emitter notifying that a file will be opened for preview.
    *
    * @eventSemantics namespace:native
+   * @version 2.25.0
    */
   preview: EventEmitter<VegaFileUploaderFile>;
   render(): VegaFileUploader;

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

@@ -0,0 +1,18 @@
+export type VegaFontAs =
+	| 'h1'
+	| 'h2'
+	| 'h3'
+	| 'h4'
+	| 'h5'
+	| 'h6'
+	| 'i'
+	| 'p'
+	| 'span'
+	| 'q'
+	| 's'
+	| 'del'
+	| 'em'
+	| 'cite'
+	| 'b'
+	| 'abbr'
+	| '';

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

@@ -0,0 +1,9 @@
+export type FormControlOption = {
+	skipDisabled?: boolean;
+	skipInvisible?: boolean;
+};
+
+export type FormValidateResult = {
+	isValid: boolean;
+	invalidFields: string[];
+};

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

@@ -0,0 +1,21 @@
+import { IconsTokenType } from '../../types/design-token.type';
+
+export type VegaUploadedFile = {
+	url: string;
+	name?: string;
+};
+
+export type VegaFile = VegaUploadedFile | File;
+
+export type VegaImageUploaderStatus = 'uploading' | 'done';
+
+export type VegaConfirmButtonProp = { text: string };
+
+export type UploaderActionTypes = 'Preview' | 'Delete' | 'Replace';
+
+export type ActionButtonOptions = {
+	icon: IconsTokenType;
+	label: string;
+};
+
+export type VegaFileOptional = VegaFile | null;

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

@@ -0,0 +1,12 @@
+import { MaskConfig } from '../../helpers/formatter/string-formatter/string-mask-strategy';
+import { NumberMaskConfig } from '../../helpers/formatter/string-formatter/number-mask-strategy';
+
+export type MaskConfigType = {
+	type: 'phone' | 'zipcode' | 'taxId' | 'custom' | 'thousand-comma' | 'number' | 'custom-formatter';
+	options?: MaskConfig | NumberMaskConfig;
+	trigger?: 'blur' | 'input';
+	formatter?: (value: string) => string;
+	resetCaretPosition?: boolean;
+};
+
+export type InputValueUpdateTriggeredBy = 'input' | 'change';

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

@@ -8,6 +8,7 @@ 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
  */
@@ -20,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;
@@ -33,6 +35,15 @@ export declare class VegaInput {
    * @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.
    *
@@ -255,6 +266,19 @@ export declare class VegaInput {
    * @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.
    *
@@ -291,4 +315,5 @@ export declare class VegaInput {
    * @see{module:vega-input-on-value-change}
    */
   private inputChangeHandler;
+  private handleLabelButtonClick;
 }

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

@@ -0,0 +1,13 @@
+import { CountryCode } from 'libphonenumber-js';
+
+export type VegaCountryCode = CountryCode;
+
+export type VegaCountryType = {
+	callingCode: string;
+	countryCode: VegaCountryCode;
+	name: string;
+};
+
+export type VegaCountryNameType = {
+	[countryCode in VegaCountryCode]: string;
+};

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

@@ -0,0 +1,5 @@
+export type InputRangeValueType = string[];
+
+export type RangeInputIndexType = 0 | 1;
+
+export type InputRangeStackType = 'vertical' | 'horizontal';

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

@@ -0,0 +1,35 @@
+import { VegaComponentInterface } from '../../types/ui.type';
+
+export type SelectSourceItem = {
+	id: string;
+	displayName: string;
+};
+
+export type SelectedLabelType = (value: string[]) => string;
+
+export type VegaDropdownPropsForSelect = Partial<
+	Pick<
+		VegaComponentInterface<HTMLVegaDropdownElement>,
+		| 'positionRelativeTo'
+		| 'maxHeight'
+		| 'matchContainerHeight'
+		| 'searchable'
+		| 'caseSensitive'
+		| 'matchTargetWidth'
+		| 'useDefaultFilter'
+		| 'size'
+	>
+>;
+
+export type VegaInputSelectSize = 'default' | 'small';
+export type SelectType = 'single' | 'multiple';
+export type SelectValueType<T extends SelectType> = T extends 'single' ? string : string[];
+
+export type VegaInputSourceLazyLoadResponse = {
+	hasMore: boolean;
+	items: SelectSourceItem[];
+};
+
+export type VegaInputSelectSourceLazyLoadCallback = (
+	endIndex: number,
+) => Promise<VegaInputSourceLazyLoadResponse>;

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

@@ -0,0 +1,8 @@
+export type ItemToggleStatusMap = {
+	unToggledIcon?: string;
+	toggledIcon?: string;
+	unToggledLabel?: string;
+	togglingLabel?: string;
+	toggledLabel?: string;
+	unTogglingLabel?: string;
+};

package/dist/types/components/vega-loading-indicator/types.d.ts

@@ -0,0 +1 @@
+export type VegaLoadingIndicatorSize = 'micro' | 'small' | 'default' | 'large';

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

@@ -0,0 +1,2 @@
+export type VegaModalBackdrop = 'static' | 'none' | 'default';
+export type VegaModalBackdropColor = 'semi' | 'none' | 'default';

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

@@ -193,6 +193,8 @@ export declare class VegaModal {
   listenDataDismiss(e: MouseEvent): void;
   /**
    * Invoke this method to show or hide the modal.
+   *
+   * @version 1.0.6
    */
   modal(option: 'show' | 'hide'): Promise<void>;
   render(): VegaModal;

package/dist/types/components/vega-page-notification/types.d.ts

@@ -0,0 +1,10 @@
+export type VegaPageNotificationTypes = 'success' | 'info' | 'warning' | 'error';
+
+export type VegaPageNotificationActionButtonConfig = {
+	label: string;
+	onVegaClick?: (e: CustomEvent) => void;
+};
+
+export type VegaPageNotificationTypeIconMap = {
+	[key in VegaPageNotificationTypes]: string;
+};