@heartlandone/vega 2.75.1 → 2.77.0

package/dist/types/components/vega-code-block/slimmers/controllers/prism-code-highlight-parse-controller.d.ts

@@ -1,15 +1,7 @@
 import { CodeNodeType } from '../../types';
-import 'prismjs/components/prism-clike';
-import 'prismjs/components/prism-javascript';
-import 'prismjs/components/prism-markup';
-import 'prismjs/components/prism-c';
-import 'prismjs/components/prism-css';
-import 'prismjs/components/prism-typescript';
-import 'prismjs/components/prism-jsx';
-import 'prismjs/components/prism-tsx';
 import { CodeHighlightParser } from './code-highlight-parser.abstract';
 /**
- * Use the plugin Prism to highlight the code content.
+ * Use the local syntax highlight tokenizer to highlight the code content.
  */
 export declare class PrismCodeHighlightParseController extends CodeHighlightParser {
   /**
@@ -19,7 +11,7 @@ export declare class PrismCodeHighlightParseController extends CodeHighlightPars
    */
   canParse(): boolean;
   /**
-   * Use plugin to parse the string code into an array of nodes with different keywords.
+   * Use tokenizer to parse the string code into an array of nodes with different keywords.
    *
    * @returns {CodeNodeType[]} - The object contains content and highlight type.
    */

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

@@ -1,7 +1,13 @@
+/**
+ * Dropdown configuration options exposed by the combo box component.
+ */
 export type VegaDropdownPropsForComboBox = Partial<
 	Pick<
 		HTMLVegaDropdownElement,
 		'positionRelativeTo' | 'maxHeight' | 'matchContainerHeight' | 'dynamicOption' | 'isLoading'
 	>
 >;
+/**
+ * Supported size variants for the combo box component.
+ */
 export type VegaComboBoxSize = 'small' | 'medium';

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

@@ -1,26 +1,79 @@
+import { Nullable } from '../../types/general';
+
+/**
+ * Modes supported by the date picker component.
+ */
 export type DatePickerModeType = 'single' | 'range';
 
+/**
+ * Value type returned by the date picker depending on mode.
+ */
 export type DatePickerValueType<T extends DatePickerModeType> = T extends 'single'
 	? string
 	: [string, string];
 
+/**
+ * Dropdown configuration options for the date picker.
+ */
 export type DropdownConfigForDatePicker = {
+	/**
+	 * Element selector or reference used for positioning.
+	 */
 	positionRelativeTo?: string;
+	/**
+	 * Whether the dropdown height is fixed.
+	 */
 	staticHeight?: boolean;
 };
 
+/**
+ * Structure representing a month and year.
+ */
 export type DatePickerMonthYearType = {
+	/**
+	 * Month label or number as a string.
+	 */
 	month: string;
+	/**
+	 * Year value as a string.
+	 */
 	year: string;
 };
 
+/**
+ * Single or multiple month/year selections.
+ */
 export type DatePickerMonthYearTypes = DatePickerMonthYearType | DatePickerMonthYearType[];
+/**
+ * Position of month when rendering a calendar (start or end).
+ */
 export type DatePickerCalendarMonthRenderType = 'start' | 'end';
 
+/**
+ * Specifies which date is being repicked in range mode.
+ */
 export type DatePickerCalendarRepickType = 'start' | 'end';
 
+/**
+ * Dropdown props used internally by the date picker calendar.
+ */
 export type VegaDropdownPropsForDatePickerCalendar = Partial<
 	Pick<HTMLVegaDropdownElement, 'isScreenPosition'>
 >;
 
+/**
+ * Size variants for the date picker calendar.
+ */
 export type DatePickerCalendarSizeType = 'small' | 'regular' | 'large';
+
+/**
+ * Indicator function type for calendar dates, returning tooltip properties or null.
+ */
+export type DatePickerCalendarIndicatorTooltipProps = Partial<
+	Pick<HTMLVegaTooltipElement, 'text' | 'size' | 'maxWidth' | 'minWidth' | 'trigger'>
+>;
+
+/**
+ * Function type for providing date indicators in the calendar, returning tooltip properties or null for a given date.
+ */
+export type DatePickerCalendarIndicator = (date: Date) => Nullable<DatePickerCalendarIndicatorTooltipProps>;

package/dist/types/components/vega-date-picker/vega-date-picker-calendar/slimmers/renderers/vega-date-picker-month-item-renderer.d.ts

@@ -14,12 +14,15 @@ export declare class VegaDatePickerMonthItemRenderer extends VegaSlimmer {
   mode: VegaDatePickerCalendar['mode'];
   size: VegaDatePickerCalendar['size'];
   isDateDisabled: VegaDatePickerCalendar['isDateDisabled'];
+  dateIndicator: VegaDatePickerCalendar['dateIndicator'];
   private isMobileDevice;
   private monthViewGenerator;
   render(type: DatePickerCalendarMonthRenderType): HTMLElement;
   private renderCurrentYearMonth;
   private renderWeek;
   private renderDays;
+  private renderItem;
+  private renderDayWithIndicator;
   private renderDay;
   private getCurrentRangeDates;
   private isBeforeMinDate;

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

@@ -3,7 +3,7 @@ import { GlobalSlimmers } from '../../../vega-slimmer/vega-slimmer-core';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaDatePickerCalendarRenderer } from './slimmers/renderers/vega-date-picker-calendar-renderer';
 import { VegaDatePickerCalendarYearMonthSwitcherRenderer } from './slimmers/renderers/vega-date-picker-calendar-year-month-switcher-renderer';
-import { DatePickerCalendarRepickType, DatePickerCalendarSizeType, DatePickerModeType, DatePickerMonthYearTypes, DatePickerValueType, VegaDropdownPropsForDatePickerCalendar } from '../types';
+import { DatePickerCalendarIndicator, DatePickerCalendarRepickType, DatePickerCalendarSizeType, DatePickerModeType, DatePickerMonthYearTypes, DatePickerValueType, VegaDropdownPropsForDatePickerCalendar } from '../types';
 import { TranslationSlimmer } from '../../../helpers/slimmers/translation/translation-slimmer';
 import { CalendarDate, MonthPeriod } from '../../../helpers/calendar';
 import { VegaDatePickerCalendarCurrentPeriodController } from './slimmers/controllers/vega-date-picker-calendar-current-period-controller';
@@ -138,6 +138,14 @@ export declare class VegaDatePickerCalendar {
    * @vegaVersion 2.72.0
    */
   isDateDisabled: DisabledDate;
+  /**
+   * Specifies a function that returns the properties for the date indicator tooltip for a given date in the date picker.
+   *
+   * The function is called for each date cell before rendering.
+   *
+   * @vegaVersion 2.77.0
+   */
+  dateIndicator: DatePickerCalendarIndicator;
   /**
    * An event emitter notifying the change of the value in the date picker,
    *    whether triggered programmatically or through user interaction.

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

@@ -1,8 +1,13 @@
+/**
+ * Properties for action buttons used in dialogs.
+ */
 export type VegaDialogActionButtonProps = Partial<
 	Pick<HTMLVegaButtonElement, 'variant' | 'size' | 'icon' | 'iconAlign' | 'label' | 'disabled' | 'danger'>
 >;
 
 /**
+ * Callback type for dialog actions which may control closing behavior.
+ *
  * - The dialog will be closed by default if the callback is undefined.
  * - Will close the dialog if the callback return true, otherwise not close
  */

package/dist/types/components/vega-divider/interface.d.ts

@@ -1,6 +1,24 @@
+/**
+ * Orientation of the divider element.
+ * Horizontal divides content vertically, vertical divides it horizontally.
+ */
 export declare type VegaDividerDirectionType = 'horizontal' | 'vertical';
+/**
+ * Visual styling variant for the divider.
+ * Primary is more prominent, secondary is more subtle.
+ */
 export declare type VegaDividerVariantType = 'primary' | 'secondary';
+/**
+ * Dimensions configuration for divider size.
+ * Allows separate control of width and height.
+ */
 export declare type VegaDividerSizeType = {
+  /**
+   * Width dimension of the divider.
+   */
   width?: string;
+  /**
+   * Height dimension of the divider.
+   */
   height?: string;
 };

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

@@ -1,3 +1,6 @@
+/**
+ * Configuration for a single dropdown item.
+ */
 export type DropdownSourceItem = {
 	/**
 	 * Descriptive label associated with the item.
@@ -25,6 +28,9 @@ export type DropdownSourceItem = {
 	danger?: boolean;
 };
 
+/**
+ * Configuration for a dropdown item group.
+ */
 export type DropdownSourceGroup = {
 	/**
 	 * Descriptive label associated with the item.
@@ -40,16 +46,40 @@ export type DropdownSourceGroup = {
 	children: DropdownSourceItem[];
 };
 
+/**
+ * Payload delivered to observers monitoring dropdown item selections.
+ */
 export type VegaDropdownItemSelectionObserverPayload = {
+	/**
+	 * Reference to the dropdown item host element.
+	 */
 	host: HTMLVegaDropdownItemElement;
+	/**
+	 * Selected item's key value.
+	 */
 	itemKey: string;
 };
 
+/**
+ * Defines the user interaction that triggers a dropdown search.
+ */
 export type VegaDropdownSearchTriggerByType = 'input' | 'enter';
 
+/**
+ * Source item union used by the dropdown component (single item or group).
+ */
 export type VegaDropdownSourceItem = DropdownSourceItem | DropdownSourceGroup;
 
+/**
+ * Detail object for search-trigger events in the dropdown.
+ */
 export type VegaDropdownSearchTriggerEventDetail = {
+	/**
+	 * The user interaction that triggered the search.
+	 */
 	searchBy: VegaDropdownSearchTriggerByType;
+	/**
+	 * The search input value.
+	 */
 	value: string;
 };

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

@@ -1 +1,9 @@
-export type VegaDropdownItemClickEvent = { itemKey: string };
+/**
+ * Event payload emitted when a dropdown item is clicked.
+ */
+export type VegaDropdownItemClickEvent = {
+	/**
+	 * The key of the clicked dropdown item.
+	 */
+	itemKey: string;
+};

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

@@ -1,5 +1,17 @@
+/**
+ * Event payload emitted by the field error component.
+ */
 export type FieldErrorEventPayload = {
+	/**
+	 * Host element reference.
+	 */
 	host: HTMLVegaFieldErrorElement;
+	/**
+	 * Whether the field is valid.
+	 */
 	isValid: boolean;
+	/**
+	 * Optional error message.
+	 */
 	message?: string;
 };

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

@@ -1,13 +1,29 @@
 /**
  * @deprecated Please use `LabelSuffixButtonConfig` instead
+ * Configuration for the label suffix button (deprecated).
  */
 export type LabelSuffixButtonProps = {
+	/**
+	 * Icon name to display in the suffix button.
+	 */
 	icon: string;
+	/**
+	 * Tooltip text shown when hovering the button.
+	 */
 	tooltipText?: string;
+	/**
+	 * Interaction that will trigger the tooltip.
+	 */
 	trigger?: 'hover' | 'click';
 };
 
+/**
+ * Configuration for the label suffix button.
+ */
 export type LabelSuffixButtonConfig = {
+	/**
+	 * Icon name to display in the suffix button.
+	 */
 	icon: string;
 } & Partial<
 	Pick<

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

@@ -1,7 +1,16 @@
+/**
+ * Visual type of file uploader control.
+ */
 export type VegaFileUploaderType = 'uploadArea' | 'uploadButton';
 
+/**
+ * Status states for a file during upload.
+ */
 export type VegaFileUploaderFileStatus = 'done' | 'uploading' | 'error';
 
+/**
+ * File metadata tracked by the file uploader component.
+ */
 export type VegaFileUploaderFile = {
 	/**
 	 * The unique id of the uploaded file.
@@ -33,4 +42,7 @@ export type VegaFileUploaderFile = {
 	uploadingPercent?: number;
 };
 
+/**
+ * Array of file objects used by the uploader.
+ */
 export type VegaFileUploaderFiles = VegaFileUploaderFile[];

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

@@ -1,3 +1,6 @@
+/**
+ * HTML tag names that the font component may render as.
+ */
 export type VegaFontAs =
 	| 'h1'
 	| 'h2'

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

@@ -1,16 +1,40 @@
 import { Nullable } from '../../types/general';
 
+/**
+ * Options for form validation behavior.
+ */
 export type FormControlOption = {
+	/**
+	 * Whether disabled fields should be skipped.
+	 */
 	skipDisabled?: boolean;
+	/**
+	 * Whether invisible fields should be skipped.
+	 */
 	skipInvisible?: boolean;
 };
 
+/**
+ * Result returned from form validation.
+ */
 export type FormValidateResult = {
+	/**
+	 * Whether the form is valid.
+	 */
 	isValid: boolean;
+	/**
+	 * List of invalid field names.
+	 */
 	invalidFields: string[];
+	/**
+	 * Optional map of field error messages.
+	 */
 	invalidFieldsErrorMessages?: Record<string, string>;
 };
 
+/**
+ * Validation state for a single form field.
+ */
 export type VegaFormFieldValidationState = {
 	/**
 	 * The field name specified in the form field's `data-vega-form` attribute.
@@ -27,15 +51,36 @@ export type VegaFormFieldValidationState = {
 	errorMessage?: Nullable<string>;
 };
 
+/**
+ * Event payload with a form host reference.
+ */
 export type FormEventsPayload = {
+	/**
+	 * Host element reference.
+	 */
 	host: HTMLElement;
 };
 
+/**
+ * Event payload for pending validation updates.
+ */
 export type PendingValidPayload = {
+	/**
+	 * Host element reference.
+	 */
 	host: HTMLElement;
+	/**
+	 * Validation detail value.
+	 */
 	detail: boolean | null;
 };
 
+/**
+ * Payload emitted when a form element is disconnected.
+ */
 export type DisconnectedElementOperationPayload = {
+	/**
+	 * Host element reference.
+	 */
 	host: HTMLElement;
 };

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

@@ -1,5 +1,8 @@
 import { IconsTokenType } from '../../types/design-token.type';
 
+/**
+ * Metadata for a file uploaded through the image uploader.
+ */
 export type VegaUploadedFile = {
 	/**
 	 * The URL of the uploaded file.
@@ -11,17 +14,46 @@ export type VegaUploadedFile = {
 	name?: string;
 };
 
+/**
+ * Union of uploaded metadata and native File objects.
+ */
 export type VegaFile = VegaUploadedFile | File;
 
+/**
+ * Status values for image uploads.
+ */
 export type VegaImageUploaderStatus = 'uploading' | 'done';
 
-export type VegaConfirmButtonProp = { text: string };
+/**
+ * Configuration for a confirm button.
+ */
+export type VegaConfirmButtonProp = {
+	/**
+	 * Button label text.
+	 */
+	text: string;
+};
 
+/**
+ * Supported action types in the image uploader.
+ */
 export type UploaderActionTypes = 'Preview' | 'Delete' | 'Replace';
 
+/**
+ * Configuration for an action button within the uploader.
+ */
 export type ActionButtonOptions = {
+	/**
+	 * Icon token for the button.
+	 */
 	icon: IconsTokenType;
+	/**
+	 * Label text for the button.
+	 */
 	label: string;
 };
 
+/**
+ * Nullable file type used by the uploader.
+ */
 export type VegaFileOptional = VegaFile | null;

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

@@ -2,20 +2,48 @@ import { MaskConfig } from '../../helpers/formatter/string-formatter/string-mask
 import { NumberMaskConfig } from '../../helpers/formatter/string-formatter/number-mask-strategy';
 import { StringFormatStrategy } from '../../helpers/formatter/string-formatter/string-format-strategy.abstract';
 
+/**
+ * Configuration for input masking strategies.
+ */
 export type MaskConfigType = {
+	/**
+	 * Masking strategy identifier.
+	 */
 	type: 'phone' | 'zipcode' | 'taxId' | 'custom' | 'thousand-comma' | 'number' | 'custom-formatter';
+	/**
+	 * Options used by the selected mask strategy.
+	 */
 	options?: MaskConfig | NumberMaskConfig;
+	/**
+	 * Event that triggers the mask update.
+	 */
 	trigger?: 'blur' | 'input';
+	/**
+	 * Optional value formatter callback.
+	 */
 	formatter?: (value: string) => string;
+	/**
+	 * Whether to reset the caret position after formatting.
+	 */
 	resetCaretPosition?: boolean;
+	/**
+	 * Custom strategy factory.
+	 */
 	strategy?: () => StringFormatStrategy;
 };
 
+/**
+ * Source event that triggered an input's value update.
+ */
 export type InputValueUpdateTriggeredBy = 'input' | 'change';
 
+/**
+ * HTML input types supported by the component.
+ */
 export type InputType = 'text' | 'email' | 'password' | 'number' | 'hidden';
 
 /**
+ * Alias for the browser's DataTransfer interface.
  * From: https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer
  */
 export type DataTransferType = DataTransfer;
@@ -80,6 +108,9 @@ export type InputAutocompleteTypes =
 	| 'url'
 	| 'photo';
 
+/**
+ * Dropdown configuration for input suggestions.
+ */
 export type VegaInputSuggestionsDropdownConfig = Partial<
 	Pick<HTMLVegaDropdownElement, 'caseSensitive' | 'itemDisplayRule' | 'isLoading' | 'searchNoResultsText'>
 >;

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

@@ -1,11 +1,26 @@
 import { VegaCountryCode } from '../../types/flag.type';
 
+/**
+ * Country metadata used by the phone number input.
+ */
 export type VegaCountryType = {
+	/**
+	 * Telephone calling code for the country.
+	 */
 	callingCode: string;
+	/**
+	 * Country code identifier.
+	 */
 	countryCode: VegaCountryCode;
+	/**
+	 * Localized display name for the country.
+	 */
 	name: string;
 };
 
+/**
+ * Map of country codes to localized country names.
+ */
 export type VegaCountryNameType = {
 	[countryCode in VegaCountryCode]: string;
 };

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

@@ -1,5 +1,14 @@
+/**
+ * Value type used by the input-range component (array of stringified numbers).
+ */
 export type InputRangeValueType = string[];
 
+/**
+ * Index position for a range input when handling two-thumb sliders.
+ */
 export type RangeInputIndexType = 0 | 1;
 
+/**
+ * Orientation options for stacked input-range elements.
+ */
 export type InputRangeStackType = 'vertical' | 'horizontal';

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

@@ -1,15 +1,39 @@
+/**
+ * Source item used by the select component.
+ */
 export type SelectSourceItem = {
+	/**
+	 * Unique identifier for the item.
+	 */
 	id: string;
+	/**
+	 * Display label for the item.
+	 */
 	displayName: string;
 };
 
+/**
+ * Label formatter for multiple selected values.
+ */
 export type SelectedLabelType = (value: string[]) => string;
 
+/**
+ * Label formatters for single and multiple selection modes.
+ */
 export type SelectedLabelTypeForAllModes = {
+	/**
+	 * Formatter for single selection mode.
+	 */
 	single?: (value: string, selectedItem?: SelectSourceItem) => string;
+	/**
+	 * Formatter for multiple selection mode.
+	 */
 	multiple?: (value: string[], selectedItem?: SelectSourceItem[]) => string;
 };
 
+/**
+ * Dropdown configuration options for input select.
+ */
 export type VegaDropdownPropsForSelect = Partial<
 	Pick<
 		HTMLVegaDropdownElement,
@@ -29,15 +53,36 @@ export type VegaDropdownPropsForSelect = Partial<
 	>
 >;
 
+/**
+ * Size options for the input select component.
+ */
 export type VegaInputSelectSize = 'default' | 'small';
+/**
+ * Selection mode for the input select.
+ */
 export type SelectType = 'single' | 'multiple';
+/**
+ * Value type derived from selection mode.
+ */
 export type SelectValueType<T extends SelectType> = T extends 'single' ? string : string[];
 
+/**
+ * Lazy-load response structure for select data sources.
+ */
 export type VegaInputSourceLazyLoadResponse = {
+	/**
+	 * Whether more items are available to load.
+	 */
 	hasMore: boolean;
+	/**
+	 * Newly loaded items.
+	 */
 	items: SelectSourceItem[];
 };
 
+/**
+ * Callback used to lazily load input select items.
+ */
 export type VegaInputSelectSourceLazyLoadCallback = (
 	endIndex: number,
 ) => Promise<VegaInputSourceLazyLoadResponse>;