@heartlandone/vega 2.75.1 → 2.76.0

package/dist/types/components/vega-app-footer/types.d.ts

@@ -1,8 +1,26 @@
+/**
+ * Link target options when opening a link.
+ */
 export type LinkTargetType = '_blank' | '_self';
 
+/**
+ * Represents a link rendered in the app footer.
+ */
 export type VegaAppFooterLink = {
+	/**
+	 * Optional unique identifier for the link
+	 */
 	id?: string;
+	/**
+	 * Text displayed for the link
+	 */
 	label: string;
+	/**
+	 * Destination URL for the link
+	 */
 	URL: string;
+	/**
+	 * Optional target specifying how the link should open
+	 */
 	target?: LinkTargetType;
 };

package/dist/types/components/vega-app-header-button/types.d.ts

@@ -1,5 +1,12 @@
 import { BackgroundColorsTokenType, TextColorsTokenType } from '../../types/design-token.type';
 
+/**
+ * Configuration options for the dropdown used by the app header button.
+ *
+ * This is a partial subset of the properties available on
+ * `HTMLVegaDropdownElement`, allowing callers to override only the
+ * settings they care about when creating a dropdown.
+ */
 export type VegaAppHeaderButtonDropdownConfig = Partial<
 	Pick<
 		HTMLVegaDropdownElement,
@@ -20,12 +27,36 @@ export type VegaAppHeaderButtonDropdownConfig = Partial<
 	>
 >;
 
+/**
+ * Settings for the avatar displayed in the app header button.
+ *
+ * Allows providing either an image source or an icon, with optional
+ * fallback text and color tokens for cases where the image fails to load.
+ */
 export type VegaAppHeaderAvatarConfig = {
+	/**
+	 * URL of the avatar image.
+	 */
 	src?: string;
+	/**
+	 * Icon name to display when no image is provided.
+	 */
 	icon?: string;
+	/**
+	 * Text to show when the image cannot be loaded.
+	 */
 	fallbackText?: string;
+	/**
+	 * Background color token to use for the fallback avatar.
+	 */
 	fallbackBgColor?: BackgroundColorsTokenType;
+	/**
+	 * Text color token to use for the fallback avatar.
+	 */
 	fallbackTextColor?: TextColorsTokenType;
 };
 
+/**
+ * Allowed size values for the app header button.
+ */
 export type VegaAppHeaderButtonSize = 'default' | 'small';

package/dist/types/components/vega-app-header-button/vega-app-header-button.d.ts

@@ -9,6 +9,7 @@ import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event
 import { VegaMenuArrowIconRenderer } from './slimmers/renderers/vega-menu-arrow-icon-renderer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { VegaAppHeaderButtonDropdownRenderer } from './slimmers/renderers/vega-app-header-button-dropdown-renderer';
+import { AriaAttributesValueMapper } from '../../helpers/slimmers/mutation-observer/aria-attributes-value-mapper';
 /**
  * @vegaVersion 1.11.0
  */
@@ -26,6 +27,7 @@ export declare class VegaAppHeaderButton {
   protected vegaMenuArrowIconRenderer: VegaMenuArrowIconRenderer;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaAppHeaderButtonElement>;
   protected dropdownRenderer: VegaAppHeaderButtonDropdownRenderer;
+  protected ariaAttributesValueMapper: AriaAttributesValueMapper;
   /**
    * Used to determine whether the avatar image is loaded or not.
    */

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

@@ -1,6 +1,15 @@
+/**
+ * Severity/type of banner to display.
+ */
 export type VegaBannerPropType = 'warning' | 'success' | 'error' | 'info';
 
+/**
+ * Configuration for an action button shown within a banner.
+ */
 export type VegaBannerActionButtonType = {
+	/**
+	 * Button label text.
+	 */
 	label: string;
 	/**
 	 * @deprecated Please use event `vegaActionButtonClick` instead

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

@@ -1,22 +1,68 @@
+/**
+ * CSS width values supporting percentage, pixels, or em units.
+ */
 export declare type CssWidthValuesType = `${number}%` | `${number}px` | `${number}em`;
+/**
+ * Global CSS values applicable to any property.
+ */
 export declare type CssGlobalValuesType = 'inherit' | 'initial' | 'revert' | 'revert-layer' | 'unset';
 /**
+ * CSS content sizing values for flexible sizing.
+ *
  * @deprecated 'fix-content' - please use `fit-content` instead
  */
 export declare type CssContentSizeValuesType = 'max-content' | 'min-content' | 'fix-content' | 'fit-content' | 'content' | 'auto';
+/**
+ * Standard CSS alignment values for flex and grid layouts.
+ */
 export declare type CssAlignmentsType = 'center' | 'start' | 'end' | 'left' | 'right' | 'self-start' | 'self-end' | 'flex-start' | 'flex-end' | 'baseline' | 'first baseline' | 'last baseline' | 'stretch' | 'safe center' | 'unsafe center';
 /**
+ * Flex basis sizing configuration combining width and content sizing values.
+ *
  * @deprecated 'fix-content' - please use `fit-content` instead
  */
 export declare type FlexBasisType = CssWidthValuesType | CssContentSizeValuesType | CssGlobalValuesType;
+/**
+ * Flex grow factor determining how much space a flex item can expand.
+ */
 export declare type FlexGrowType = number | CssGlobalValuesType;
+/**
+ * Flex shrink factor determining how much space a flex item can shrink.
+ */
 export declare type FlexShrinkType = number | CssGlobalValuesType;
+/**
+ * CSS order property for reordering flex or grid items.
+ */
 export declare type OrderType = CssGlobalValuesType | number;
+/**
+ * Alignment of individual flex or grid item relative to container (excludes left/right).
+ */
 export declare type AlignSelfType = Omit<CssAlignmentsType, 'left' | 'right'> | 'auto' | 'normal' | CssGlobalValuesType;
+/**
+ * Justification of individual grid item within its grid area.
+ */
 export declare type JustifySelfType = CssAlignmentsType | 'auto' | 'normal' | 'stretch' | CssGlobalValuesType;
+/**
+ * CSS flex shorthand supporting combined grow, shrink, and basis values.
+ */
 export declare type FlexType = number | CssWidthValuesType | CssGlobalValuesType | `${FlexGrowType} ${FlexShrinkType}` | `${FlexGrowType} ${FlexBasisType}` | `${FlexGrowType} ${FlexShrinkType} ${FlexBasisType}` | 'auto' | 'initial' | 'none' | 'min-content';
+/**
+ * Grid item positioning supporting explicit row/column numbers or span values.
+ */
 export declare type GridDegreeType = number | `span ${number}` | 'auto';
+/**
+ * Global CSS values for grid properties (excludes revert-layer).
+ */
 export declare type CssGridGlobalValuesType = Omit<CssGlobalValuesType, 'revert' | 'revert-layer'>;
+/**
+ * CSS grid-column property supporting single or range positioning.
+ */
 export declare type GridColumnType = GridDegreeType | `${GridDegreeType} / ${GridDegreeType}` | CssGridGlobalValuesType;
+/**
+ * CSS grid-row property supporting single or range positioning.
+ */
 export declare type GridRowType = GridDegreeType | `${GridDegreeType} / ${GridDegreeType}` | CssGridGlobalValuesType;
+/**
+ * CSS grid-area property supporting positioning and spanning across grid cells.
+ */
 export declare type GridAreaType = GridDegreeType | `${GridDegreeType} / ${GridDegreeType}` | `${GridDegreeType} / ${GridDegreeType} / ${GridDegreeType}` | `${GridDegreeType} / ${GridDegreeType} / ${GridDegreeType} / ${GridDegreeType}` | CssGridGlobalValuesType;

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

@@ -1,12 +1,40 @@
+/**
+ * Threshold that determines when breadcrumbs collapse.
+ */
 export type VegaBreadcrumbCollapsedThresholdType = number | 'none';
+
+/**
+ * Configuration for an individual breadcrumb item.
+ */
 export type VegaBreadcrumbItemType = {
+	/**
+	 * Text label displayed for the breadcrumb.
+	 */
 	label: string;
+	/**
+	 * Optional link target for the breadcrumb.
+	 */
 	href?: string;
+	/**
+	 * Optional tooltip text for the breadcrumb.
+	 */
 	tooltip?: string;
 };
 
+/**
+ * Rendering options passed to breadcrumb item renderers.
+ */
 export type VegaBreadcrumbRenderItemOptions = {
+	/**
+	 * Whether the breadcrumb is in compact mode.
+	 */
 	isCompactMode?: boolean;
+	/**
+	 * Whether the item is the last breadcrumb.
+	 */
 	isLastItem?: boolean;
+	/**
+	 * Whether the item is rendered inside the overflow dropdown.
+	 */
 	isInDropdown?: boolean;
 };

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

@@ -1,4 +1,16 @@
+/**
+ * Size options for the button component.
+ */
 export type VegaButtonSize = 'default' | 'small' | 'large';
+/**
+ * Visual variant options for the button component.
+ */
 export type VegaButtonVariant = 'primary' | 'secondary';
+/**
+ * Icon alignment options for button icons.
+ */
 export type VegaButtonIconAlign = 'left' | 'right';
+/**
+ * HTML button `type` attribute values.
+ */
 export type VegaButtonType = 'submit' | 'button' | 'reset';

package/dist/types/components/vega-button-circle/types.d.ts

@@ -1,5 +1,14 @@
+/**
+ * Size options for the circular button component.
+ */
 export type VegaButtonCircleSize = 'default' | 'small' | 'large' | 'extra-small';
 
+/**
+ * Visual variants for the circular button component.
+ */
 export type VegaButtonCircleVariant = 'primary' | 'secondary' | 'icon-only';
 
+/**
+ * Tooltip configuration for the circular button.
+ */
 export type VegaButtonCircleTooltip = Partial<Pick<HTMLVegaTooltipElement, 'disableInteractive'>>;

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

@@ -1,22 +1,70 @@
+/**
+ * Size options for buttons within a button group.
+ */
 export type VegaButtonGroupSize = 'default' | 'small' | 'large';
 
+/**
+ * Visual variant for the entire button group.
+ */
 export type VegaButtonGroupVariant = 'primary' | 'secondary' | 'tertiary';
 
+/**
+ * Alignment of icons within buttons inside the group.
+ */
 export type VegaButtonGroupIconAlign = 'left' | 'right';
 
+/**
+ * Configuration for dropdown menus attached to button groups.
+ */
 export type DropdownPropsForButtonGroup = {
+	/**
+	 * Whether the dropdown should match the height of its container.
+	 */
 	matchContainerHeight?: boolean;
+	/**
+	 * Whether the dropdown should match the width of its trigger element.
+	 */
 	matchTargetWidth?: boolean;
+	/**
+	 * Maximum height of the dropdown in pixels.
+	 */
 	maxHeight?: number;
+	/**
+	 * Element selector or reference to position the dropdown.
+	 */
 	positionRelativeTo?: string;
+	/**
+	 * Interaction that will open the dropdown.
+	 */
 	trigger: 'hover' | 'click' | 'none';
 };
 
+/**
+ * Props used to describe an individual button item in a button group.
+ */
 export type ButtonItemsProps = {
+	/**
+	 * Icon name for the button.
+	 */
 	icon: string;
+	/**
+	 * Label text for the button.
+	 */
 	label: string;
+	/**
+	 * Size of the button.
+	 */
 	size: VegaButtonGroupSize;
+	/**
+	 * Icon alignment within the button.
+	 */
 	iconAlign: VegaButtonGroupIconAlign;
+	/**
+	 * Whether the button is disabled.
+	 */
 	disabled: boolean;
+	/**
+	 * Ref callback for obtaining the element.
+	 */
 	ref: (node: HTMLElement) => void;
 };

package/dist/types/components/vega-button-link/types.d.ts

@@ -1 +1,4 @@
+/**
+ * Allowed target values for link buttons.
+ */
 export type VegaButtonLinkTarget = '_self' | '_blank';

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

@@ -2,99 +2,288 @@ import { BackgroundColorsTokenType } from '../../types/design-token.type';
 import { CalendarEvent } from '../../helpers/calendar/calendar-event';
 import { DropdownSourceGroup, DropdownSourceItem } from '../vega-dropdown/types';
 
+/**
+ * Available view modes for the calendar component.
+ */
 export type VegaCalendarViewModeType = 'month' | 'week' | 'day';
 
+/**
+ * Simple representation of a calendar date.
+ */
 export type VegaCalendarDateType = {
+	/**
+	 * Day of the month.
+	 */
 	date: number;
+	/**
+	 * Month number (0‑indexed?).
+	 */
 	month: number;
+	/**
+	 * Full year number.
+	 */
 	year: number;
 };
 
+/**
+ * Payload for events emitted when the calendar's view period changes.
+ */
 export type VegaCalendarChangeEventType = {
+	/**
+	 * The newly visible period on the calendar.
+	 */
 	currentPeriod: VegaCalendarCurrentPeriodType;
+	/**
+	 * The active calendar view mode.
+	 */
 	viewMode: VegaCalendarViewModeType;
 };
 
+/**
+ * Describes the currently visible period on the calendar.
+ */
 export type VegaCalendarCurrentPeriodType = {
+	/**
+	 * The year of the current period.
+	 */
 	year: number;
+	/**
+	 * The month of the current period.
+	 */
 	month: number;
+	/**
+	 * The first date included in the period.
+	 */
 	startDate: VegaCalendarDateType;
+	/**
+	 * The last date included in the period.
+	 */
 	endDate: VegaCalendarDateType;
 };
 
+/**
+ * Frequency options for repeating calendar events.
+ */
 export type VegaCalendarEventRepeatType = 'daily' | 'weekly' | 'monthly' | 'yearly';
 
+/**
+ * Variant styles that can be applied to calendar events.
+ */
 export type VegaCalendarEventVariantType = 'primary' | 'secondary' | 'tertiary';
 
 export interface VegaCalendarRawEvent {
+	/**
+	 * Unique identifier for the event.
+	 */
 	key: string;
+	/**
+	 * Title displayed for the event.
+	 */
 	title: string;
+	/**
+	 * Visual variant applied to the event.
+	 */
 	variant?: VegaCalendarEventVariantType;
+	/**
+	 * Start date or date-time for the event.
+	 */
 	startDate: string | Date;
+	/**
+	 * Optional end date or date-time for the event.
+	 */
 	endDate?: string | Date;
+	/**
+	 * Optional start time string.
+	 */
 	startTime?: string;
+	/**
+	 * Optional end time string.
+	 */
 	endTime?: string;
+	/**
+	 * Whether the event spans the full day.
+	 */
 	isAllDay?: boolean;
 	/**
 	 * This color also supports {@link BackgroundColorsTokenType} expect string
 	 */
 	color?: string | BackgroundColorsTokenType;
+	/**
+	 * Whether the event is disabled.
+	 */
 	disabled?: boolean;
+	/**
+	 * Repeat configuration for the event.
+	 */
 	repeatOptions?: VegaCalendarEventRepeatOptions;
 }
 
+/**
+ * Information provided when a calendar event is clicked.
+ */
 export type VegaCalendarEventClickInfo = {
+	/**
+	 * The raw event data that was clicked.
+	 */
 	rawEvent: VegaCalendarRawEvent;
 };
 
+/**
+ * Click info when a calendar date cell is clicked, including time.
+ */
 export type VegaCalendarDateClickInfo = VegaCalendarDateType & {
+	/**
+	 * Hour value for the clicked time slot.
+	 */
 	hour: number;
+	/**
+	 * Minimal mouse event information.
+	 */
 	mouseEventInfo: VegaMouseEventInfo;
 };
 
+/**
+ * CSS style object used for positioning calendar event elements.
+ */
 export type VegaCalendarEventStyle = {
+	/**
+	 * CSS position type for the event element.
+	 */
 	position: 'absolute';
+	/**
+	 * Left offset value.
+	 */
 	left: string;
+	/**
+	 * Top offset value.
+	 */
 	top: string;
+	/**
+	 * Width of the event element.
+	 */
 	width: string;
+	/**
+	 * Optional height of the event element.
+	 */
 	height?: string;
+	/**
+	 * Optional z-index value.
+	 */
 	zIndex?: string;
+	/**
+	 * Optional opacity value.
+	 */
 	opacity?: string;
 };
 
+/**
+ * Layout information for rendering a full-day calendar event.
+ */
 export type VegaCalendarFullDayEventView = {
+	/**
+	 * The event associated with the view.
+	 */
 	event: CalendarEvent;
+	/**
+	 * Start index or position within the full-day layout.
+	 */
 	start: number;
+	/**
+	 * End index or position within the full-day layout.
+	 */
 	end: number;
 };
 
+/**
+ * Abbreviated weekday names used by the calendar.
+ */
 export type VegaCalendarWeekDayType = 'Sun' | 'Mon' | 'Tue' | 'Wed' | 'Thu' | 'Fri' | 'Sat';
 
+/**
+ * Detailed repeat configuration for calendar events.
+ */
 export type VegaCalendarEventRepeatOptions = {
+	/**
+	 * Base repeat frequency for the event.
+	 */
 	frequency: VegaCalendarEventRepeatType;
+	/**
+	 * Optional interval multiplier for the frequency.
+	 */
 	interval?: number;
+	/**
+	 * Optional maximum occurrence count.
+	 */
 	count?: number;
+	/**
+	 * Optional end date for repeating.
+	 */
 	until?: string | Date;
+	/**
+	 * Specific weekdays for repeating events.
+	 */
 	byWeekDay?: VegaCalendarWeekDayType[];
 };
 
+/**
+ * Dropdown configuration used by calendar components.
+ */
 export type DropdownPropsForCalendar = {
+	/**
+	 * Whether the dropdown should match container height.
+	 */
 	matchContainerHeight?: boolean;
+	/**
+	 * Whether the dropdown should match the trigger width.
+	 */
 	matchTargetWidth?: boolean;
+	/**
+	 * Maximum dropdown height in pixels.
+	 */
 	maxHeight?: number;
+	/**
+	 * Element selector or reference for positioning.
+	 */
 	positionRelativeTo?: string;
+	/**
+	 * Interaction that opens the dropdown.
+	 */
 	trigger?: 'hover' | 'click';
+	/**
+	 * Dropdown items used as the source.
+	 */
 	source: (DropdownSourceGroup | DropdownSourceItem)[];
 };
 
+/**
+ * Minimal mouse event coordinates used throughout the calendar.
+ */
 export type VegaMouseEventInfo = {
+	/**
+	 * Mouse client X coordinate.
+	 */
 	clientX: number;
+	/**
+	 * Mouse client Y coordinate.
+	 */
 	clientY: number;
 };
 
+/**
+ * Predicate used to disable certain calendar dates.
+ */
 export type DisabledDate = (date: Date) => boolean;
 
+/**
+ * Structure representing hour and minute components of a time.
+ */
 export type CalendarTimeHourMinutes = {
+	/**
+	 * Hour component of the time.
+	 */
 	timeHours: number;
+	/**
+	 * Minute component of the time.
+	 */
 	timeMinutes: number;
 };

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

@@ -1,5 +1,11 @@
+/**
+ * Payload emitted when previewing a calendar event.
+ */
 export type VegaCalendarEventPreviewPayload = {
+	/** The calendar event being previewed */
 	event: CalendarEvent;
+	/** The target date in the calendar view */
 	targetCalendarViewDate: CalendarDate;
+	/** The time format to use for displaying event times */
 	timeFormat: TimeFormat;
 };

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

@@ -1,4 +1,7 @@
 import { ChartOptions } from '../../../types/vega-chart';
 import { BarChartDataType } from '../../../helpers/chart/bar-chart';
 
+/**
+ * Partial chart options supported by the bar chart component.
+ */
 export type VegaBarChartOptionsType = Partial<Omit<ChartOptions<BarChartDataType>, 'container'>>;

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

@@ -1,4 +1,16 @@
+/**
+ * Visual style variants for a chip component.
+ */
 export type VegaChipVariant = 'filled-background' | 'outlined';
+/**
+ * Available size options for the chip component.
+ */
 export type VegaChipSize = 'extra-small' | 'small' | 'default' | 'large';
+/**
+ * Determines whether the chip displays a status indicator or a label.
+ */
 export type VegaChipType = 'status' | 'label';
+/**
+ * Position of the icon inside a chip relative to the text.
+ */
 export type VegaChipIconAlign = 'left' | 'right';

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.
    */