@globalpayments/vega 2.34.1 → 2.36.0

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

@@ -6,6 +6,7 @@ export declare class VegaDatePickerCalendarRenderer extends VegaSlimmer {
   dropdownConfig: VegaDatePicker['dropdownConfig'];
   allowRepick: VegaDatePicker['allowRepick'];
   format: VegaDatePicker['format'];
+  showYearMonthDropdowns: VegaDatePicker['showYearMonthDropdowns'];
   vegaDatePickerCalendarController: VegaDatePicker['vegaDatePickerCalendarController'];
   vegaDatePickerMobileController: VegaDatePicker['vegaDatePickerMobileController'];
   vegaDatePickerElementAppenderController: VegaDatePicker['vegaDatePickerElementAppenderController'];
@@ -13,7 +14,9 @@ export declare class VegaDatePickerCalendarRenderer extends VegaSlimmer {
   vegaDatePickerValueController: VegaDatePicker['vegaDatePickerValueController'];
   vegaDatePickerSingleInputRenderer: VegaDatePicker['vegaDatePickerSingleInputRenderer'];
   vegaDatePickerRangeInputRenderer: VegaDatePicker['vegaDatePickerRangeInputRenderer'];
+  monthYearDropdownRenderer: VegaDatePicker['monthYearDropdownRenderer'];
   translationSlimmer: VegaDatePicker['translationSlimmer'];
+  timezone: VegaDatePicker['timezone'];
   private datePicker;
   private litepickerRef;
   private calendarContainerRef;
@@ -55,6 +58,10 @@ export declare class VegaDatePickerCalendarRenderer extends VegaSlimmer {
   watchFormat(): void;
   /** Update datePicker settings property of mode is changed */
   watchMode(): void;
+  /**
+   * Update datePicker settings property if showYearMonthDropdowns is changed
+   */
+  watchShowYearMonthDropdowns(): void;
   /**
    * get the reference of datePicker
    *
@@ -88,6 +95,8 @@ export declare class VegaDatePickerCalendarRenderer extends VegaSlimmer {
    */
   private renderPrevAndNextMonthButtons;
   private renderClearButton;
+  private getSystemTimeZone;
+  private resetTodayByTimezone;
   /**
    * The function initializes a Litepicker date picker, customizes its appearance and behavior, and
    * attaches event listeners.

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

@@ -9,10 +9,12 @@ export declare class VegaDatePickerRenderer extends VegaSlimmer {
   readOnly: VegaDatePicker['readOnly'];
   autoValidation: VegaDatePicker['autoValidation'];
   host: VegaDatePicker['host'];
+  showYearMonthDropdowns: VegaDatePicker['showYearMonthDropdowns'];
   vegaDatePickerMobileController: VegaDatePicker['vegaDatePickerMobileController'];
   vegaDatePickerSingleInputRenderer: VegaDatePicker['vegaDatePickerSingleInputRenderer'];
   vegaDatePickerRangeInputRenderer: VegaDatePicker['vegaDatePickerRangeInputRenderer'];
   vegaDatePickerCalendarRenderer: VegaDatePicker['vegaDatePickerCalendarRenderer'];
+  monthYearDropdownRenderer: VegaDatePicker['monthYearDropdownRenderer'];
   private datePickerContainer;
   getDatePickerContainer(): HTMLInputElement;
   renderInputPrefix: () => HTMLElement;

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

@@ -18,6 +18,7 @@ import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
 import { TranslationSlimmer } from '../../helpers/slimmers/translation';
+import { VegaDatePickerMonthYearDropdownRenderer } from './slimmers/renderers/vega-date-picker-calendar-month-year-dropdown-renderer';
 /**
  * @vegaVersion 1.3.0
  */
@@ -41,6 +42,7 @@ export declare class VegaDatePicker {
   protected changeEventEmitter: EventEmitSlimmerBase;
   protected inputEventPrevent: ChildNodesEventPreventSlimmer;
   protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaDatePickerElement>;
+  protected monthYearDropdownRenderer: VegaDatePickerMonthYearDropdownRenderer;
   host: HTMLVegaDatePickerElement;
   /**
    * Specifies the selection mode of the date picker.
@@ -163,6 +165,8 @@ export declare class VegaDatePicker {
    * @vegaVersion 1.3.0
    */
   allowRepick: boolean;
+  /** Update property of allowRepick when it is changed */
+  watchAllowRepick(): void;
   /**
    * Specifies the configuration for the calendar dropdown
    *    associated with the date picker.
@@ -176,8 +180,14 @@ export declare class VegaDatePicker {
    * @vegaVersion 2.33.0
    */
   showClearIcon: boolean;
-  /** Update property of allowRepick when it is changed */
-  watchAllowRepick(): void;
+  /**
+   * Determines whether to show months and years dropdown in date picker
+   * If set to true, date picker calendar will have months and years dropdown
+   *
+   * @vegaVersion 2.36.0
+   */
+  showYearMonthDropdowns: boolean;
+  watchShowYearMonthDropdowns(): void;
   /**
    * Specifies whether the date picker field is disabled.
    *
@@ -185,6 +195,15 @@ export declare class VegaDatePicker {
    */
   disabled: boolean;
   watchDisabled(): void;
+  /**
+   * Specifies the IANA time zone or Etc/GMT±n format.
+   *     It accepts values such as "America/New_York" or "Etc/GMT+12".
+   *     For a complete list of IANA time zones, refer to Time Zone DB(https://timezonedb.com/time-zones).
+   * 	   If not configured, the time zone will default to the system's time zone.
+   *
+   * @vegaVersion 2.35.0
+   */
+  timezone: string;
   /**
    * 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-dropdown/slimmers/controllers/vega-dropdown-appender-controller.d.ts

@@ -22,6 +22,16 @@ export declare class VegaDropdownAppenderController extends ElementAppenderSlimm
   searchRenderer: VegaDropdown['searchRenderer'];
   showEventEmitter: VegaDropdown['showEventEmitter'];
   hideEventEmitter: VegaDropdown['hideEventEmitter'];
+  isScreenPosition: VegaDropdown['isScreenPosition'];
+  private target;
+  /**
+   * Component lifecycle - [componentDidLoad]{@link VegaPopover.connectedCallback}
+   */
+  connectedCallback(): void;
+  /**
+   * Component lifecycle - [componentDidLoad]{@link VegaPopover.disconnectedCallback}
+   */
+  disconnectedCallback(): void;
   /**
    * This constructor initializes a dropdown component with various configuration options.
    */
@@ -40,4 +50,14 @@ export declare class VegaDropdownAppenderController extends ElementAppenderSlimm
    * The function `userHide` hides a dropdown if it is currently being shown.
    */
   userHide(): void;
+  /**
+   * Generate the show configuration for the dropdown.
+   *
+   * @returns {ElementAppenderShowConfig} The show configuration for the dropdown.
+   */
+  private generateShowConfigFactory;
+  /**
+   * Register a remote method to update the target element of the dropdown.
+   */
+  private registerRemoteMethod;
 }

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

@@ -253,6 +253,16 @@ export declare class VegaDropdown {
    * @vegaVersion 2.26.0
    */
   searchTriggerBy: VegaDropdownSearchTriggerByType;
+  /**
+   * Determines whether the dropdown position is calculated relative to the screen.
+   *
+   * @VegaWarning When enabled (set to true), it overrides the positionRelativeTo and matchContainerHeight properties, rendering them ineffective.
+   *
+   * @VegaWarning Currently, when set to true, position calculation may be inaccurate if the dropdown is placed inside a scrollable container within a shadowRoot (e.g., inside a vega-modal with scrollable content).
+   *
+   * @vegaVersion 2.36.0
+   */
+  isScreenPosition: boolean;
   /**
    * An event emitter notifying that a dropdown item has been clicked.
    *

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

@@ -0,0 +1,18 @@
+import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
+import { VegaFileUploader } from '../../vega-file-uploader';
+/**
+ * Controller class for managing the file upload limit in the Vega file uploader component.
+ */
+export declare class VegaFileUploaderFileLimitController extends VegaSlimmer {
+  protected maxCount: VegaFileUploader['maxCount'];
+  /**
+   * Determines if the file uploader is in single mode.
+   *
+   * @returns {boolean} `true` if the maximum file count is 1, otherwise `false`.
+   */
+  isSingleMode(): boolean;
+  /**
+   * Checks if the `maxCount` property is valid. If `maxCount` is less than 1 and not `null`, it will be set to `null`.
+   */
+  protected checkMaxCount(): void;
+}

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

@@ -9,6 +9,8 @@ export declare class VegaFileUploaderContainerRenderer extends VegaSlimmer {
   protected vegaFileUploaderValueController: VegaFileUploader['vegaFileUploaderValueController'];
   protected dropFileFilterController: VegaFileUploader['dropFileFilterController'];
   protected translationSlimmer: VegaFileUploader['translationSlimmer'];
+  protected fileLimitController: VegaFileUploader['fileLimitController'];
+  protected maxCount: VegaFileUploader['maxCount'];
   private inputElementRef;
   private uploaderContainerRef;
   /**
@@ -75,4 +77,17 @@ export declare class VegaFileUploaderContainerRenderer extends VegaSlimmer {
    * @returns {VegaFileUploaderFile[]} the vega file array
    */
   private getVegaFilesFromFileList;
+  /**
+   * Determines if the upload button should be disabled based on the component's state.
+   *
+   * @returns {boolean} True if the upload button should be disabled, otherwise false.
+   */
+  private shouldDisableUploadButton;
+  /**
+   * Filters the selected files to ensure the total number of files does not exceed the maximum count.
+   *
+   * @param {VegaFileUploaderFile[]} selectedFiles - The files selected by the user.
+   * @returns {VegaFileUploaderFile[]} The filtered list of files that do not exceed the maximum count.
+   */
+  private filterExceedLimitFiles;
 }

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

@@ -12,6 +12,7 @@ import { FormFieldValidationRule } from '../../helpers/validator/rules/form-fiel
 import { FormFieldControllerSlimmer } from '../../helpers/slimmers/form-field-controller-slimmer';
 import { VegaFileUploaderDropFileFilterController } from './slimmers/controllers/vega-file-uploader-drop-file-filter-controller';
 import { TranslationSlimmer } from '../../helpers/slimmers/translation';
+import { VegaFileUploaderFileLimitController } from './slimmers/controllers/vega-file-uploader-file-limit-controller';
 /**
  * @vegaVersion 2.25.0
  */
@@ -26,6 +27,7 @@ export declare class VegaFileUploader {
   protected vegaFileUploaderFileStatusRenderer: VegaFileUploaderFileStatusRenderer;
   protected vegaFileUploaderValueController: VegaFileUploaderValueController;
   protected dropFileFilterController: VegaFileUploaderDropFileFilterController;
+  protected fileLimitController: VegaFileUploaderFileLimitController;
   protected changeEventEmitter: EventEmitSlimmerBase;
   protected selectFileChangeEventEmitter: EventEmitSlimmerBase;
   protected removeEventEmitter: EventEmitSlimmerBase;
@@ -75,6 +77,16 @@ export declare class VegaFileUploader {
    * @vegaVersion 2.25.0
    */
   disabled: boolean;
+  /**
+   * Specifies the maximum number of files that can be uploaded using the File Uploader. The value must be a positive integer.
+   *
+   * @vegaVersion 2.36.0
+   */
+  maxCount: number | null;
+  /**
+   * Watches the maxCount change.
+   */
+  watchMaxCount(): void;
   /**
    * Specifies whether uploading a file is mandatory.
    *

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

@@ -6,4 +6,5 @@ export type FormControlOption = {
 export type FormValidateResult = {
 	isValid: boolean;
 	invalidFields: string[];
+	invalidFieldsErrorMessages?: Record<string, string>;
 };

package/dist/types/components/vega-input-phone-number/slimmers/controllers/vega-input-phone-number-value-controller.d.ts

@@ -13,10 +13,15 @@ export declare class VegaInputPhoneNumberValueController extends VegaSlimmer {
   protected countrySelectController: VegaInputPhoneNumber['countrySelectController'];
   protected changeEventEmitter: VegaInputPhoneNumber['changeEventEmitter'];
   protected phoneNumberInputValue: VegaInputPhoneNumber['phoneNumberInputValue'];
+  protected emptyValueEnabled: VegaInputPhoneNumber['emptyValueEnabled'];
   /**
    * componentWillLoad
    */
   componentWillLoad(): void;
+  /**
+   * watch emptyValueEnabled change
+   */
+  watchEmptyValueEnabled(): void;
   /**
    * The `watchValue` function updates a value and emits change events based on certain conditions.
    *
@@ -77,4 +82,18 @@ export declare class VegaInputPhoneNumberValueController extends VegaSlimmer {
    * starting from the length of the calling code prefix for the specified `country`.
    */
   private removeCallingCodePrefix;
+  /**
+   * Set value
+   *
+   * @param {string} inputValue - The value of phone number input.
+   * @param {Function} formatValue - Format value callback
+   */
+  private trySetValue;
+  /**
+   * Should set value of phone number to empty string
+   *
+   * @param {string} inputValue - The value of phone number input
+   * @returns {boolean} -
+   */
+  private shouldSetEmptyValue;
 }

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

@@ -70,6 +70,15 @@ export declare class VegaInputPhoneNumber {
    * @vegaVersion 2.18.0
    */
   allowedCountryCodes: VegaCountryCode[];
+  /**
+   * Specifies whether the phone number input field can be set to an empty value.
+   *   When set to true, the value of phoneNumber is cleared when the input field is empty.
+   *   When set to false, the value of phoneNumber is always composed of the country code and phone number, even if the input field is empty.
+   *
+   * @vegaVersion 2.35.0
+   */
+  emptyValueEnabled: boolean;
+  watchEmptyValueEnabled(): void;
   /**
    * Specifies the value of the phone number input in [E.164]{@link https://en.wikipedia.org/wiki/E.164} format.
    *

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

@@ -19,6 +19,7 @@ export type VegaDropdownPropsForSelect = Partial<
 		| 'useDefaultFilter'
 		| 'size'
 		| 'searchTriggerBy'
+		| 'isScreenPosition'
 	>
 >;
 

package/dist/types/components/vega-pagination/internal/vega-pagination-page-size-selector.d.ts

@@ -1,8 +1,10 @@
 import { FunctionalComponent } from '../../../stencil-public-runtime';
 import { TranslationSlimmer } from '../../../helpers/slimmers/translation';
+import { DropdownPropsForPagination } from '../types';
 interface VegaPaginationEntriesSelectorProps {
   pageSize: number;
   pageSizeSelectorOptions: number[];
+  dropdownProps: DropdownPropsForPagination;
   onChange: (pageSize: number) => void;
   translationSlimmer: TranslationSlimmer<HTMLVegaPaginationElement>;
 }

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

@@ -1 +1,7 @@
+import { VegaComponentInterface } from '../../types/ui.type';
+
 export type VegaPaginationItemType = 'currentPageLabel' | 'pageSizeSelector' | 'pageSelector' | 'goTo';
+
+export type DropdownPropsForPagination = Partial<
+	Pick<VegaComponentInterface<HTMLVegaDropdownElement>, 'isScreenPosition'>
+>;

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

@@ -1,5 +1,5 @@
 import { EventEmitter } from '../../stencil-public-runtime';
-import { VegaPaginationItemType } from './types';
+import { DropdownPropsForPagination, VegaPaginationItemType } from './types';
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
 import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
@@ -63,6 +63,14 @@ export declare class VegaPagination {
    * @vegaVersion 1.25.0
    */
   pageSizeSelectorOptions: number[];
+  /**
+   * Specifies the properties of the vega-dropdown component
+   *    used to configure the dropdown for the
+   *    page size selector in pagination.
+   *
+   * @vegaVersion 2.36.0
+   */
+  dropdownProps: DropdownPropsForPagination;
   /**
    * An event emitter notifying the current page change.
    *

package/dist/types/components/vega-rich-text-content/slimmers/renderers/vega-rich-text-content-renderer.d.ts

@@ -6,7 +6,10 @@ export declare class VegaRichTextContentRenderer extends VegaSlimmer {
   contentEditable: VegaRichTextContent['contentEditable'];
   content: VegaRichTextContent['content'];
   private richTextContentRef;
+  private readonly blockRenderers;
+  componentWillLoad(): void;
   constructor();
+  watchValueUpdate(): void;
   /**
    * Get the rich text content element
    *
@@ -14,7 +17,9 @@ export declare class VegaRichTextContentRenderer extends VegaSlimmer {
    */
   getRichTextContentRef(): Nullable<HTMLDivElement>;
   render(): VegaRichTextContent;
+  private setRTEContent;
   private renderRichTextContent;
   private renderContent;
+  private getBlockRenderer;
   private shouldShowPlaceholder;
 }

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

@@ -29,11 +29,14 @@ export declare class VegaRichTextContent {
    */
   contentEditable: boolean;
   /**
-   * Specifies the text or formatted information displayed by the rich text content.
+   * Specifies the text or formatted information displayed by the rich text content, which can be either VegaRTEContent or VegaRTEContentBlock.
+   * It is recommended to use the VegaRTEContent type.
+   * Only in exceptional cases should the original data in the VegaRTEContentBlock type be used.
    *
    * @vegaVersion 2.34.0
    */
   content: VegaRTEContent;
+  watchValueUpdate(): void;
   /**
    * Invoke this method to focus on rich text content editable div
    *

package/dist/types/components/vega-rich-text-editor/dto/annotations/link-group-annotation.d.ts

@@ -1,6 +1,5 @@
 import { Annotation, InternalAnnotationTypeEnum } from './annotation.abstract';
 import { RTETextNode } from '../nodes/text-node';
-import { RTERenderContext } from '../../interface';
 /**
  * Annotation to represent a link of grouped nodes
  */
@@ -8,9 +7,4 @@ export declare class LinkGroupAnnotation extends Annotation {
   readonly type: InternalAnnotationTypeEnum;
   linkGroups: Map<string, RTETextNode[]>;
   constructor(groupKey: string);
-  renderNodes(nodes: RTETextNode[], { editable }: RTERenderContext): HTMLElement[];
-  private renderLinkEditorWrapper;
-  private renderLink;
-  private isLinkGroup;
-  private groupNodesByLink;
 }

package/dist/types/components/vega-rich-text-editor/dto/blocks/block.abstract.d.ts

@@ -1,4 +1,4 @@
-import { AnnotationStyle, RTEBlockType, RTERenderContext, VegaRTEBlockAnnotations, VegaRTEBlockBase } from '../../interface';
+import { RTEBlockType, VegaRTEBlockAnnotations, VegaRTEBlockBase } from '../../interface';
 import { BlockAnnotation, BlockAnnotationTypeEnum } from '../annotations/block-annotation.abstract';
 import { AnnotationAction } from '../actions/annotation-action.abstract';
 import { Nullable } from '../../../../types/general';
@@ -13,7 +13,7 @@ import { BlockBaseOperator } from '../helper/block-base-operator';
  */
 export declare abstract class RTEBlock extends BlockBaseOperator {
   id: string;
-  protected annotationMap: Map<keyof typeof BlockAnnotationTypeEnum | InternalAnnotationTypeEnum.LINK_GROUP, BlockAnnotation | LinkGroupAnnotation>;
+  annotationMap: Map<keyof typeof BlockAnnotationTypeEnum | InternalAnnotationTypeEnum.LINK_GROUP, BlockAnnotation | LinkGroupAnnotation>;
   abstract type: RTEBlockType;
   abstract parent: VegaRTEContent | RTEBlock;
   protected constructor(id: string);
@@ -49,7 +49,6 @@ export declare abstract class RTEBlock extends BlockBaseOperator {
    * @param {AnnotationAction} action - Annotation action
    */
   apply(action: AnnotationAction | ModifyContentAction): void;
-  abstract render(renderContext?: RTERenderContext): HTMLElement;
   /**
    * Apply action to block
    *
@@ -62,18 +61,6 @@ export declare abstract class RTEBlock extends BlockBaseOperator {
    * @param {AnnotationAction} action - Annotation action
    */
   protected applyAnnotationAction(action: AnnotationAction): void;
-  /**
-   * Get styles from annotations
-   *
-   * @returns {AnnotationStyle} - Annotation style
-   */
-  protected getStyles(): AnnotationStyle;
-  /**
-   * Get classes from annotations
-   *
-   * @returns {AnnotationStyle} - Annotation style
-   */
-  protected getClasses(): string;
   /**
    * Appends a list of RTENode objects to the current node's child nodes and sets the parent block of each node to the current node.
    *

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

@@ -1,4 +1,4 @@
-import { RTEBlockType, VegaRTEImageBlock, RTERenderContext } from '../../interface';
+import { RTEBlockType, VegaRTEImageBlock } from '../../interface';
 import { RTEBlock } from './block.abstract';
 import { RTEImageNode } from '../nodes/image-node';
 import { ModifyContentAction } from '../actions/modify-content-action.abstract';
@@ -11,18 +11,36 @@ export declare class RTEImageBlock extends RTEBlock {
   nodes: RTEImageNode[];
   parent: VegaRTEContent;
   constructor(id: string);
+  /**
+   * Converts a VegaRTEImageBlock object into an RTEImageBlock object by mapping nodes and creating annotations.
+   *
+   * @param {VegaRTEImageBlock} block - The block object to be converted.
+   * @returns {RTEImageBlock} An instance of `RTEImageBlock`
+   */
   static from(block: VegaRTEImageBlock): RTEImageBlock;
+  /**
+   * @inheritDoc
+   */
   toJSON(): VegaRTEImageBlock;
+  /**
+   * @inheritDoc
+   */
   isNotEmpty(): boolean;
+  /**
+   * @inheritDoc
+   */
   getLastNode(): RTEImageNode;
-  render(renderContext?: RTERenderContext): HTMLElement;
   /**
-   * Apply modify action to block
+   * Apply a modify action to block
    *
    * @param {ModifyContentAction} action - Modify action
    */
   protected doModifyActionApply(action: ModifyContentAction): void;
-  private registerRef;
+  /**
+   * Removes a specified child node from a list of nodes and triggers a parent action if the list becomes empty.
+   *
+   * @param {RemoveChildAction} action - Action to be performed when removing a child node from the list of nodes.
+   */
   private removeChildNode;
   /**
    * The image offset should be 0 or 1
@@ -30,14 +48,60 @@ export declare class RTEImageBlock extends RTEBlock {
    *
    * @param {RTEImageNode} imageNode The split point image node
    * @param {number} imageOffset The cursor point 0 | 1
+   * @returns {Nullable<RTEBlock>} The new block after split
    */
   private splitImageNodes;
+  /**
+   * Creates a new RTEImageBlock instance with the provided RTEImageNode instances appended to it.
+   *
+   * @param {RTEImageNode[]} nodes - An array of RTEImageNode objects that will be used to create a new RTEImageBlock instance.
+   * @returns {RTEImageBlock} A new `RTEImageBlock` object with the provided `nodes` appended to it.
+   */
   private cloneWithNodes;
+  /**
+   * Used to split a block of text at a specific position and insert a new paragraph block.
+   *
+   * @param {RTEImageNode} splitNode - The node that needs to be split into separate blocks.
+   * @param {number} startOffsetOfNode - The index or position within the `splitNode` where the block should be broken or split.
+   * @returns {Nullable<RTEBlock>} Returns either a new paragraph block or the new block created after splitting the original block.
+   */
   private breakSingleBlock;
+  /**
+   * Breaks a single block of text at a specified offset and returns the first node of the new paragraph if created.
+   *
+   * @param {RTEImageNode} splitNode - It represents a node in a rich text editor that contains an image.
+   * @param {number} startOffset - The index at which the line break should occur within the `RTEImageNode` block.
+   * @returns {Nullable<RTETextNode>} Returning the first node of the `newParagraph` block if `newParagraph` is not null.
+   */
   private lineBreakSingleBlock;
+  /**
+   * Checks if the caret position is at the start of a specified RTEImageNode.
+   *
+   * @param {RTEImageNode} node - `RTEImageNode` - a node representing an image in a rich text editor.
+   * @param {number} startOffset - The position within the text node where the caret is located.
+   * @returns {boolean} a boolean value, which indicates whether the caret position is at the start of the RTEImageNode.
+   */
   private isCaretPositionAtStart;
+  /**
+   * Checks if the caret position is at the end of a given RTEImageNode.
+   *
+   * @param {RTEImageNode} node - `node` is a RTEImageNode
+   * @param {number} startOffset - The position within the `RTEImageNode` where the caret is located.
+   * @returns {boolean}Returns a boolean value indicating whether the caret position is at the end of the `RTEImageNode`.
+   */
   private isCaretPositionAtEnd;
+  /**
+   * Inserts a new paragraph block with a line break after a selected block of text in a rich text editor.
+   *
+   * @param {RTEBlock[]} selectedBlocks - An array of RTEBlock objects that represent the blocks that have been selected for a specific action in the Rich Text Editor.
+   * @returns {Nullable<RTETextNode>} Returns a Nullable RTETextNode.
+   */
   private lineBreakMultipleBlocks;
+  /**
+   * Deletes content from a block node based on specific conditions.
+   *
+   * @param {DeleteBlockContentAction} action - Delete block content action
+   */
   private deleteNodeContent;
   /**
    * Image will always create new image block

package/dist/types/components/vega-rich-text-editor/dto/blocks/list-block.d.ts

@@ -1,29 +1,71 @@
 import { RTEBlock } from './block.abstract';
-import { RTERenderContext, VegaRTEListBlock, VegaRTEListBlockType } from '../../interface';
+import { VegaRTEListBlock, VegaRTEListBlockType } from '../../interface';
 import { RTEListItemBlock } from './list-item-block';
 import { ModifyContentAction } from '../actions/modify-content-action.abstract';
 import { VegaRTEContent } from '../content-state';
 import { RTETextNode } from '../nodes/text-node';
+/**
+ * List block
+ */
 export declare class RTEListBlock extends RTEBlock {
   type: VegaRTEListBlockType;
   blocks: RTEListItemBlock[];
   parent: RTEListItemBlock | VegaRTEContent;
   constructor(id: string, type: VegaRTEListBlockType);
+  /**
+   * Converts a VegaRTEListBlock object to an RTEListBlock
+   *
+   * @param {VegaRTEListBlock} block - Converts a `VegaRTEListBlock` object into an `RTEListBlock`.
+   * @returns {RTEListBlock} Return an instance of `RTEListBlock`
+   */
   static from(block: VegaRTEListBlock): RTEListBlock;
+  /**
+   * @inheritDoc
+   */
   toJSON(): VegaRTEListBlock;
+  /**
+   * @inheritDoc
+   */
   isNotEmpty(): boolean;
+  /**
+   * @inheritDoc
+   */
   getLastNode(): RTETextNode;
-  render(renderContext?: RTERenderContext): HTMLElement;
   /**
    * Apply a modify action to block
    *
    * @param {ModifyContentAction} action - Modify action
    */
   protected doModifyActionApply(action: ModifyContentAction): void;
+  /**
+   * Converts a RTEListItemBlock to a RTETextBlock representing a paragraph.
+   *
+   * @param {RTEListItemBlock} block - The block that will be covered
+   * @returns {RTETextBlock} Returns a `RTETextBlock`.
+   */
   private toParagraph;
-  private registerRef;
+  /**
+   * Covert block to List
+   *
+   * @param {TransformListAction} action - Modify action
+   */
   private convertToList;
+  /**
+   * Covert block to paragraph
+   *
+   * @param {TransformListAction} action - Modify action
+   */
   private convertToParagraph;
+  /**
+   * Inserts an image block into a rich text editor block based on the parent block type.
+   *
+   * @param {InsertImageToBlockAction} action - Modify action
+   */
   private insertImage;
+  /**
+   * Removes a specified block and handles the removal of nested lists if necessary.
+   *
+   * @param {RTEBlock} blockToBeRemoved - block that will be removed
+   */
   private removeListItemBlock;
 }