@heartlandone/vega 2.75.0 → 2.76.0

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/html-cleaner/html-content-cleaner-processor.interface.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Interface for HTML content cleaning processors.
+ * Each processor implements a specific step in the HTML cleaning chain.
+ */
+export interface HTMLContentCleanerProcessor {
+  /**
+   * Process the HTML string and apply the cleaning logic.
+   *
+   * @param {string} html - The HTML string to process.
+   * @returns {string} The processed HTML string.
+   */
+  process(html: string): string;
+}

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/html-cleaner/html-content-cleaner.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Main HTML content cleaner that orchestrates multiple cleaning processors.
+ *
+ * This class implements a chain of responsibility pattern where each processor
+ * handles a specific aspect of HTML cleaning. The processors are applied in sequence
+ * and the entire chain is repeated until no more changes occur.
+ *
+ * Processors (in order):
+ * 1. RemoveWhitespaceBetweenTagsProcessor - Removes whitespace between non-matching tags
+ * 2. RemoveWhitespaceAfterOpeningTagProcessor - Removes \n and \t after opening tags
+ * 3. RemoveWhitespaceBeforeClosingTagProcessor - Removes \n and \t before closing tags
+ */
+export declare class HTMLContentCleaner {
+  private processors;
+  /**
+   * Cleans HTML by applying all processors in the chain repeatedly until no changes occur.
+   *
+   * The cleaning process:
+   * 1. Applies each processor in sequence
+   * 2. Compares the result with the input
+   * 3. If changes were made, repeats the process
+   * 4. Returns the final cleaned HTML
+   *
+   * Examples of transformations:
+   * - `<p>\n\t <span>test</span>\n\t </p>` → `<p><span>test</span></p>`
+   * - `<p>\n\tHello</p>` → `<p>Hello</p>`
+   * - `<p>Hello\n\t</p>` → `<p>Hello</p>`
+   * - `<span> </span>` → `<span> </span>` (preserved - matching tags)
+   * - `<p>Hello  World</p>` → `<p>Hello  World</p>` (preserved - regular spaces)
+   *
+   * @param {string} html - The HTML string to clean.
+   * @returns {string} The cleaned HTML string.
+   */
+  clean(html: string): string;
+}

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/html-cleaner/index.d.ts

@@ -0,0 +1,4 @@
+export { HTMLContentCleaner } from './html-content-cleaner';
+export { RemoveWhitespaceBetweenTagsProcessor } from './processors/remove-whitespace-between-tags-processor';
+export { RemoveWhitespaceAfterOpeningTagProcessor } from './processors/remove-whitespace-after-opening-tag-processor';
+export { RemoveWhitespaceBeforeClosingTagProcessor } from './processors/remove-whitespace-before-closing-tag-processor';

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/html-cleaner/processors/remove-whitespace-after-opening-tag-processor.d.ts

@@ -0,0 +1,19 @@
+import { HTMLContentCleanerProcessor } from '../html-content-cleaner-processor.interface';
+/**
+ * Removes `\n` and `\t` characters after opening tags (before text content).
+ *
+ * Transforms patterns like `>[\n\t]+(text)` to `>(text)`.
+ *
+ * Examples:
+ * - `<p>\n\tHello` → `<p>Hello`
+ * - `<div>\n\n\tWorld` → `<div>World`
+ */
+export declare class RemoveWhitespaceAfterOpeningTagProcessor implements HTMLContentCleanerProcessor {
+  /**
+   * Process the HTML string to remove `\n` and `\t` after opening tags.
+   *
+   * @param {string} html - The HTML string to process.
+   * @returns {string} The processed HTML string.
+   */
+  process(html: string): string;
+}

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/html-cleaner/processors/remove-whitespace-before-closing-tag-processor.d.ts

@@ -0,0 +1,19 @@
+import { HTMLContentCleanerProcessor } from '../html-content-cleaner-processor.interface';
+/**
+ * Removes `\n` and `\t` characters before closing tags (after text content).
+ *
+ * Transforms patterns like `(text)[\n\t]+<` to `(text)<`.
+ *
+ * Examples:
+ * - `World\n\t</p>` → `World</p>`
+ * - `Hello\n</div>` → `Hello</div>`
+ */
+export declare class RemoveWhitespaceBeforeClosingTagProcessor implements HTMLContentCleanerProcessor {
+  /**
+   * Process the HTML string to remove `\n` and `\t` before closing tags.
+   *
+   * @param {string} html - The HTML string to process.
+   * @returns {string} The processed HTML string.
+   */
+  process(html: string): string;
+}

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/html-cleaner/processors/remove-whitespace-between-tags-processor.d.ts

@@ -0,0 +1,59 @@
+import { HTMLContentCleanerProcessor } from '../html-content-cleaner-processor.interface';
+/**
+ * Removes whitespace between tags, except preserves ALL whitespace between matching opening/closing tag pairs.
+ *
+ * This processor scans for patterns of `<tag>(whitespace)<tag>` and:
+ * - If the first tag is an opening tag and the second tag is its matching closing tag (e.g., `<span> </span>`),
+ *   preserves ALL the whitespace between them (including spaces, tabs, newlines)
+ * - Otherwise, removes all the whitespace between the tags
+ *
+ * Examples:
+ * - `</p>\n\t<div>` → `</p><div>` (different tags: closing p, opening div - whitespace removed)
+ * - `<div>\n\t<span>` → `<div><span>` (different tags: opening div, opening span - whitespace removed)
+ * - `<span> </span>` → `<span> </span>` (matching tags: opening span, closing span - space preserved)
+ * - `<span>  </span>` → `<span>  </span>` (matching tags - multiple spaces preserved)
+ * - `<span>\n\t</span>` → `<span>\n\t</span>` (matching tags - \n\t preserved)
+ * - `<code> </code>` → `<code> </code>` (matching tags - space preserved)
+ * - `</div> <p>` → `</div><p>` (different tags: closing div, opening p - whitespace removed)
+ */
+export declare class RemoveWhitespaceBetweenTagsProcessor implements HTMLContentCleanerProcessor {
+  /**
+   * Process the HTML string to remove whitespace between non-matching tags.
+   *
+   * @param {string} html - The HTML string to process.
+   * @returns {string} The processed HTML string.
+   */
+  process(html: string): string;
+  /**
+   * Extracts the tag name from an opening HTML tag.
+   *
+   * Supports standard HTML tags (div, span, h1, etc.) and custom elements with hyphens (my-component).
+   *
+   * Examples:
+   * - `<span>` → `span`
+   * - `<div class="test">` → `div`
+   * - `<my-component id="123">` → `my-component`
+   * - `</span>` → `null` (not an opening tag)
+   *
+   * @param {string} tag - The tag string to extract from (e.g., '<span>', '<div class="test">').
+   * @returns {string | null} The tag name or null if not an opening tag.
+   * @private
+   */
+  private extractOpeningTagName;
+  /**
+   * Extracts the tag name from a closing HTML tag.
+   *
+   * Supports standard HTML tags (div, span, h1, etc.) and custom elements with hyphens (my-component).
+   *
+   * Examples:
+   * - `</span>` → `span`
+   * - `</div>` → `div`
+   * - `</my-component>` → `my-component`
+   * - `<span>` → `null` (not a closing tag)
+   *
+   * @param {string} tag - The tag string to extract from (e.g., '</span>', '</div>').
+   * @returns {string | null} The tag name or null if not a closing tag.
+   * @private
+   */
+  private extractClosingTagName;
+}

package/dist/types/components/vega-rich-text-editor/test/html-cleaner/html-content-cleaner.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/components/vega-rich-text-editor/test/html-cleaner/remove-whitespace-after-opening-tag-processor.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/components/vega-rich-text-editor/test/html-cleaner/remove-whitespace-before-closing-tag-processor.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/components/vega-rich-text-editor/test/html-cleaner/remove-whitespace-between-tags-processor.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/components/vega-rich-text-editor/vega-rich-text-image-editor/types.d.ts

@@ -1,15 +1,39 @@
+/**
+ * Size options for the rich text image editor.
+ */
 export type VegaRichTextImageEditorSizeType = 'sm' | 'md' | 'lg';
 
+/**
+ * Image record used by the image editor.
+ */
 export type VegaRTEImageEditorRecord = {
+	/**
+	 * Selected image size.
+	 */
 	size: VegaRichTextImageEditorSizeType;
+	/**
+	 * Alternative text for the image.
+	 */
 	alt: string;
 };
 
+/**
+ * Change detail payload emitted by the image editor.
+ */
 export type VegaRichTextImageEditorChangeDetail =
 	| {
+			/**
+			 * Action representing an edit.
+			 */
 			action: 'edit';
+			/**
+			 * Image record payload.
+			 */
 			payload: VegaRTEImageEditorRecord;
 	  }
 	| {
+			/**
+			 * Action representing a delete.
+			 */
 			action: 'delete';
 	  };

package/dist/types/components/vega-rich-text-editor/vega-rich-text-link-editor/types.d.ts

@@ -1,15 +1,39 @@
+/**
+ * Status values for the rich text link editor.
+ */
 export type VegaRichTextLinkEditorStatus = 'editOrUnlinkSelection' | 'linkEdit';
 
+/**
+ * Link record used by the link editor.
+ */
 export type VegaRTELinkEditorRecord = {
+	/**
+	 * Link display text.
+	 */
 	text: string;
+	/**
+	 * Link URL value.
+	 */
 	url: string;
 };
 
+/**
+ * Change detail payload emitted by the link editor.
+ */
 export type VegaRichTextLinkEditorChangeDetail =
 	| {
+			/**
+			 * Action representing a link creation or update.
+			 */
 			action: 'link';
+			/**
+			 * Link record payload.
+			 */
 			payload: VegaRTELinkEditorRecord;
 	  }
 	| {
+			/**
+			 * Action representing unlinking.
+			 */
 			action: 'unlink';
 	  };

package/dist/types/components/vega-segment-control/types.d.ts

@@ -1,8 +1,26 @@
+/**
+ * Properties for an individual segment within a segment control.
+ */
 export type VegaSegmentProps = {
+	/**
+	 * Unique key for the segment.
+	 */
 	key: string;
+	/**
+	 * Optional icon name to render.
+	 */
 	icon?: string;
+	/**
+	 * Text label for the segment.
+	 */
 	text?: string;
+	/**
+	 * Whether the segment is disabled.
+	 */
 	disabled?: boolean;
 };
 
+/**
+ * Visual variant options for the segment control component.
+ */
 export type VegaSegmentControlVariant = 'icon-only' | 'text-only' | 'default';

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

@@ -1,4 +1,16 @@
 import { VegaComponentInterface } from '../../types/ui.type';
+/**
+ * Size variants available for selection chips.
+ * Ranges from extra-small to large for different UI contexts.
+ */
 export declare type VegaSelectionChipSize = 'extra-small' | 'small' | 'medium' | 'large';
+/**
+ * Visual variant styles for selection chips.
+ * Can display as a color swatch or text-based chip.
+ */
 export declare type VegaSelectionChipVariant = 'swatch' | 'text';
+/**
+ * Props configuration for tooltip component used with selection chips.
+ * Partial implementation of VegaComponentInterface for HTMLVegaTooltipElement.
+ */
 export declare type VegaSelectionChipTooltipProps = Partial<VegaComponentInterface<HTMLVegaTooltipElement>>;

package/dist/types/components/vega-selection-chip/vega-selection-chip-group/interface.d.ts

@@ -1 +1,5 @@
+/**
+ * Selection mode for selection chip groups.
+ * Radio allows single selection, checkbox allows multiple selections.
+ */
 export declare type VegaSelectionChipGroupSelectType = 'radio' | 'checkbox';

package/dist/types/components/vega-selection-tile/interface.d.ts

@@ -1,4 +1,13 @@
+/**
+ * Payload emitted when selection tile checked state changes.
+ */
 export declare type VegaSelectionTileCheckedPayload = {
+  /**
+   * Whether the tile is currently checked.
+   */
   checked: boolean;
+  /**
+   * Unique identifier value associated with this tile.
+   */
   value: string;
 };

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

@@ -1,24 +1,75 @@
+/**
+ * Top-level item definition for the side navigation.
+ */
 export type SidebarTopLevelItem = {
+	/**
+	 * Destination URL for the item.
+	 */
 	url: string;
+	/**
+	 * Display label for the item.
+	 */
 	name: string;
+	/**
+	 * Optional icon name for the item.
+	 */
 	icon?: string;
+	/**
+	 * Whether the item is currently selected.
+	 */
 	selected?: boolean;
+	/**
+	 * Optional child items.
+	 */
 	children?: SidebarItem[];
 };
 
+/**
+ * Side navigation item definition without the icon field.
+ */
 export type SidebarItem = Exclude<SidebarTopLevelItem, 'icon'>;
 
+/**
+ * Header configuration for the side navigation.
+ */
 export type SidebarHeaderConfig = {
+	/**
+	 * Header headline text.
+	 */
 	headline?: string;
+	/**
+	 * Logo shown when expanded.
+	 */
 	expandLogo?: string;
+	/**
+	 * Logo shown when collapsed.
+	 */
 	collapseLogo?: string;
 };
 
+/**
+ * Responsive state flags used by the side navigation.
+ */
 export type ResponsiveBehavior = {
+	/**
+	 * Whether the sidebar is visible.
+	 */
 	showSideBar: boolean;
+	/**
+	 * Whether the backdrop is visible.
+	 */
 	showBackdrop: boolean;
+	/**
+	 * Whether the sidebar can be scrolled.
+	 */
 	canBeScrolled: boolean;
+	/**
+	 * Whether clicking a link closes the sidebar.
+	 */
 	showSideBarOnClickLink: boolean;
 };
 
+/**
+ * Default open behavior for the sidebar.
+ */
 export type OpenByDefaultType = 'open' | 'close' | 'disableCollapse';

package/dist/types/components/vega-signature-capture/types.d.ts

@@ -1,5 +1,32 @@
+/**
+ * Mode in which the signature capture operates.
+ */
 export type VegaSignatureCaptureMode = 'written';
 
-export type VegaSignatureMousePosition = { x: number; y: number };
+/**
+ * Coordinates for a mouse position used in signature drawing.
+ */
+export type VegaSignatureMousePosition = {
+	/**
+	 * Horizontal coordinate.
+	 */
+	x: number;
+	/**
+	 * Vertical coordinate.
+	 */
+	y: number;
+};
 
-export type VegaSignatureValue = { type: VegaSignatureCaptureMode; img: string };
+/**
+ * Value produced by the signature capture component.
+ */
+export type VegaSignatureValue = {
+	/**
+	 * Signature capture mode.
+	 */
+	type: VegaSignatureCaptureMode;
+	/**
+	 * Base64 or URL representation of the signature image.
+	 */
+	img: string;
+};

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

@@ -1,5 +1,11 @@
 import { JSXBase } from '../../stencil-public-runtime';
 
+/**
+ * Type alias for the `style` attribute on a host element.
+ */
 export type HostStyleType = JSXBase.HTMLAttributes['style'];
 
+/**
+ * Available skeleton placeholder types to render.
+ */
 export type VegaSkeletonType = 'text' | 'paragraph' | 'full-width-paragraph' | 'ellipse' | 'image' | 'table';

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

@@ -1,18 +1,54 @@
+/**
+ * Configuration object for a tab within a tab group.
+ */
 export type TabConfig = {
+	/**
+	 * Display label for the tab.
+	 */
 	label: string;
+	/**
+	 * Target id or selector for the tab panel.
+	 */
 	dataTarget: string;
+	/**
+	 * Optional icon name shown before the label.
+	 */
 	prefixIcon?: string;
+	/**
+	 * Optional counter badge configuration.
+	 */
 	counterBadge?: VegaTabGroupCounterBadgeProps;
+	/**
+	 * Whether the tab is disabled.
+	 */
 	disabled?: boolean;
 };
 
+/**
+ * Event payload indicating a panel was added or removed from a tab group.
+ */
 export type PanelUpdatePayload = {
+	/**
+	 * Host panel element reference.
+	 */
 	host: HTMLVegaTabGroupPanelElement;
+	/**
+	 * The update action type.
+	 */
 	type: 'ADD' | 'DEL';
 };
 
+/**
+ * Visual variant options for tab groups.
+ */
 export type TabGroupVariant = 'primary' | 'secondary';
 
+/**
+ * Props forwarded to a counter badge used in a tab group.
+ */
 export type VegaTabGroupCounterBadgeProps = Partial<Pick<HTMLVegaCounterBadgeElement, 'color' | 'count'>>;
 
+/**
+ * Overflow handling strategies for tab groups.
+ */
 export type TabGroupOverflowType = 'menu' | 'scroll';