@globalpayments/vega 2.37.0 → 2.37.2

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/helper/input-event-handler/delete-content-handler.d.ts

@@ -9,10 +9,6 @@ export declare class DeleteContentHandler extends BaseHandler {
    * Handles the deletion of content within a single block in an RTE editor.
    */
   private deleteContentWithSingleBlock;
-  /**
-   * Creates a new paragraph element with a text node and appends it to the current state.
-   */
-  private insertDefaultParagraph;
   /**
    * Deletes the content within multiple nodes selected by the user.
    */
@@ -23,6 +19,10 @@ export declare class DeleteContentHandler extends BaseHandler {
    * @param {RTEBlock} block - The first block instance
    */
   private convertFirstBlockToParagraph;
+  /**
+   * Creates a new paragraph element with a text node and appends it to the current state.
+   */
+  private insertDefaultParagraph;
   /**
    * Returns the end offset of a given node in a Rich Text Editor based on its type and text content.
    *

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/helper/input-event-handler/insert-line-break-handler.d.ts

@@ -33,7 +33,7 @@ export declare class InsertLineBreakHandler extends BaseHandler {
   /**
    * Moves the caret to the next node element in a rich text editor.
    *
-   * @param {RTETextNode} lineBreakNode - Represents a node element in a rich text editor.
+   * @param {RTENode} lineBreakNode - Represents a node element in a rich text editor.
    */
   private switchCaretPositionToSpecifiedNode;
   /**
@@ -43,11 +43,4 @@ export declare class InsertLineBreakHandler extends BaseHandler {
    * @returns {RTENode} The next sibling node of the current line break element, or the current node if next node is not exists.
    */
   private getNextRTENode;
-  /**
-   * Create a null text that will render a br element in a rich text editor.
-   *
-   * @param {RTEBlock} block - Represents a block element in a rich text editor.
-   * @returns {RTETextNode} the new line break node.
-   */
-  private createLineBreakNode;
 }

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/insert-composition-text-controller.d.ts

@@ -0,0 +1,99 @@
+import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
+import { VegaRichTextEditor } from '../../vega-rich-text-editor';
+/** Handles inserting composition text into a VegaRTEContent based on the current selection and input event. User input character will trigger this callback */
+export declare class InsertCompositionTextController extends VegaSlimmer {
+  protected selectionController: VegaRichTextEditor['selectionController'];
+  protected host: VegaRichTextEditor['host'];
+  protected value: VegaRichTextEditor['value'];
+  protected valueController: VegaRichTextEditor['valueController'];
+  protected userInputController: VegaRichTextEditor['userInputController'];
+  protected vegaRichTextEditorRenderer: VegaRichTextEditor['vegaRichTextEditorRenderer'];
+  private editableElementRef;
+  private insertCompositionTextEndFlag;
+  private mutationObserver;
+  private observerOptions;
+  /**
+   * The function `initMutationObserver` initializes a MutationObserver on an editable HTML element if it exists.
+   */
+  initMutationObserver(): void;
+  /**
+   * Disconnects the mutation observer if it exists.
+   */
+  removeObserver(): void;
+  /**
+   * The method is to get the composition text insert end or not.
+   *
+   * @returns {boolean} The false is main that insert composition text process is end.
+   */
+  isComposing(): boolean;
+  /**
+   * The current method is called when the insert text is update by the Pinyin input or the word correction plugin.
+   *
+   * @param {MutationRecord[]} records - The mutation record object array.
+   */
+  updateTextFromDom: (records: MutationRecord[]) => void;
+  /**
+   * Adds event listener to an editable HTML element to handle composition text insert actions.
+   */
+  protected addCompositionTextEventListener(): void;
+  /**
+   * Removes event listener to an editable HTML element to handle composition text insert actions.
+   */
+  protected removeCompositionTextEventListener(): void;
+  /**
+   * re-connect the observer after the props change and component did render
+   */
+  protected reConnectObserver(): void;
+  /**
+   * Processes mutation records related to character data and updates the text content of a rich text node accordingly.
+   *
+   * @param {MutationRecord[]} records - Each `MutationRecord` object represents a single mutation that occurred in the DOM.
+   */
+  private handleObserver;
+  /**
+   * Insert text to a line break node need a special logic if the line break has a next text node.
+   *
+   * @param {RTETextNode} currentNode The current line break node, the text value is \n
+   */
+  private appendLineBreakNode;
+  /**
+   * Updates the text content of a rich text node and handles line breaks.
+   *
+   * @param {RTETextNode} richTextNode - The current rich text node.
+   * @param {string} newValue - The target element textContent
+   * @param {Nullable<string>} oldValue - The target element old textContent
+   * @returns {Nullable<boolean>} The node text is updated or not
+   */
+  private updateCurrentNodeText;
+  /**
+   * An event handler function that is triggered when the composition of text input starts. In this case,
+   *  it sets the `insertCompositionTextEndFlag` property of the `UserInputController` class to `false`.
+   */
+  private handleCompositionStart;
+  /**
+   * An event handler function that is triggered when the composition of text input ends. In this case,
+   *  it sets the `insertCompositionTextEndFlag` property of the `UserInputController` class to `true`.
+   *
+   * @param {CompositionEvent} event The composition event instance
+   */
+  private handleCompositionEnd;
+  /**
+   * The function `getEditableElementRef` returns a reference to the editable HTMLDivElement within a rich text editor.
+   *
+   * @returns {HTMLDivElement|null} A reference to an HTMLDivElement element that is editable.
+   */
+  private getEditableElementRef;
+  /**
+   * Remove the ZERO_WIDTH_SPACE from the text.
+   *
+   * @param {string} text The input text that could include ZERO_WIDTH_SPACE.
+   * @returns {string} The result text.
+   */
+  private removeZeroWidthSpace;
+  /**
+   * Dispatch a insert text event to handle the composition text insert logic.
+   *
+   * @param {string} text - The text need to insert.
+   */
+  private dispatchInsertTextEvent;
+}

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/selection-controller.d.ts

@@ -19,6 +19,7 @@ export declare class SelectionController extends VegaSlimmer {
   host: VegaRichTextEditor['host'];
   protected readonly value: VegaRichTextEditor['value'];
   protected readonly valueController: VegaRichTextEditor['valueController'];
+  protected insertCompositionTextController: VegaRichTextEditor['insertCompositionTextController'];
   private currentRange;
   private updateCaretPositionTaskQueue;
   private handleSelectionWithDebounce;

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/user-input-controller.d.ts

@@ -1,28 +1,19 @@
 import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
 import { VegaRichTextEditor } from '../../vega-rich-text-editor';
-/** Used to monitoring the user input actions by event listener and mutationObserver */
+/** Used to monitoring the user input actions by event listener */
 export declare class UserInputController extends VegaSlimmer {
   protected host: VegaRichTextEditor['host'];
   protected value: VegaRichTextEditor['value'];
   protected valueController: VegaRichTextEditor['valueController'];
   protected vegaRichTextEditorRenderer: VegaRichTextEditor['vegaRichTextEditorRenderer'];
   protected selectionController: VegaRichTextEditor['selectionController'];
+  protected insertCompositionTextController: VegaRichTextEditor['insertCompositionTextController'];
   private editableElementRef;
   private insertTextHandler;
   private insertParagraphHandler;
   private insertLineBreakHandler;
   private deleteContentHandler;
   private insertPasteHandler;
-  private mutationObserver;
-  private observerOptions;
-  /**
-   * The function `initMutationObserver` initializes a MutationObserver on an editable HTML element if it exists.
-   */
-  initMutationObserver(): void;
-  /**
-   * Disconnects the mutation observer if it exists.
-   */
-  removeObserver(): void;
   /**
    * Adds event listener to an editable HTML element to handle user input actions.
    */
@@ -31,10 +22,6 @@ export declare class UserInputController extends VegaSlimmer {
    * Removes event listener for user input actions from an editable HTML div element.
    */
   protected removeActionListener(): void;
-  /**
-   * re-connect the observer after the props change and component did render
-   */
-  protected reConnectObserver(): void;
   /**
    * When a user performs an input action within the editable element, this function is triggered.
    *
@@ -51,12 +38,6 @@ export declare class UserInputController extends VegaSlimmer {
    * Notifies a change manager with the host and value details and logs the current value.
    */
   private notifyComponentFlushValue;
-  /**
-   * Processes mutation records related to character data and updates the text content of a rich text node accordingly.
-   *
-   * @param {MutationRecord[]} records - Each `MutationRecord` object represents a single mutation that occurred in the DOM.
-   */
-  private handleObserver;
   /**
    * Prevents the default behavior of a drag event.
    *

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

@@ -35,6 +35,8 @@ import { InsertImageController } from './slimmers/controllers/insert-image-contr
 import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
 import { FocusController } from './slimmers/controllers/focus-controller';
 import { TextNodeColorController } from './slimmers/controllers/text-node-color-controller';
+import { InsertCompositionTextController } from './slimmers/controllers/insert-composition-text-controller';
+import { DeleteSelectedNodesController } from './slimmers/controllers/delete-selected-nodes-controller';
 /**
  * @vegaVersion 2.34.0
  */
@@ -68,9 +70,11 @@ export declare class VegaRichTextEditor {
   protected readonly richTextContentController: RichTextContentController;
   protected readonly userInputController: UserInputController;
   protected readonly insertImageController: InsertImageController;
+  protected readonly insertCompositionTextController: InsertCompositionTextController;
   protected imageInsertedEventEmitter: EventEmitSlimmerBase;
   protected changeEventPreventSlimmer: ChildNodesEventPreventSlimmer;
   protected readonly textNodeColorController: TextNodeColorController;
+  protected readonly deleteSelectedNodesController: DeleteSelectedNodesController;
   host: HTMLVegaRichTextEditorElement;
   richTextContentEditable: boolean;
   watchRichTextContentEditable(): void;
@@ -128,6 +132,7 @@ export declare class VegaRichTextEditor {
    * Only in exceptional cases should the original data in the VegaRTEContentBlock type be used.
    *
    * @vegaVersion 2.34.0
+   * @defaultValue [{id:'UUID', type:'paragraph', nodes:[{id: 'UUID',type: 'text',text:''}]}]
    */
   value: VegaRTEContent;
   watchValueUpdate(): void;
@@ -162,14 +167,14 @@ export declare class VegaRichTextEditor {
    *
    * @vegaVersion 2.34.0
    */
-  vegaChange: EventEmitter<Array<VegaRTEContentBlock>>;
+  vegaChange: EventEmitter<VegaRTEContent>;
   /**
    * An event emitter notifying a value change.
    *
    * @eventSemantics namespace:native
    * @vegaVersion 2.34.0
    */
-  change: EventEmitter<Array<VegaRTEContentBlock>>;
+  change: EventEmitter<VegaRTEContent>;
   /**
    * An event emitter notifying an image insertion event.
    *

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

@@ -73,6 +73,7 @@ export declare class VegaSignatureCapture {
    *    of the signature capture.
    *
    * @vegaVersion 2.19.0
+   * @defaultValue v-internal-icon signature
    */
   placeholderIcon: string;
   /**

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

@@ -18,6 +18,7 @@ export declare class VegaTableRenderer extends VegaSlimmer {
   translationSlimmer: VegaTable['translationSlimmer'];
   vegaTableChildrenController: VegaTable['vegaTableChildrenController'];
   isTemplateRenderMode: VegaTable['isTemplateRenderMode'];
+  editingRows: VegaTable['editingRows'];
   render(): VegaTable;
   private renderInternalTable;
   private renderEmpty;

package/dist/types/components.d.ts

@@ -48,7 +48,7 @@ import { VegaPageNotificationActionButtonConfig, VegaPageNotificationTypes } fro
 import { DropdownPropsForPagination, VegaPaginationItemType } from "./components/vega-pagination/types";
 import { PieChartOptions } from "./helpers/chart/pie-chart";
 import { VegaRTEContent } from "./components/vega-rich-text-editor/dto/content-state";
-import { VegaRichTextEditorImage, VegaRTEContentBlock, VegaRTEToolbarItem } from "./components/vega-rich-text-editor/interface";
+import { VegaRichTextEditorImage, VegaRTEToolbarItem } from "./components/vega-rich-text-editor/interface";
 import { VegaRichTextImageEditorChangeDetail, VegaRichTextImageEditorSizeType } from "./components/vega-rich-text-editor/vega-rich-text-image-editor/types";
 import { VegaRichTextLinkEditorChangeDetail, VegaRichTextLinkEditorStatus, VegaRTELinkEditorRecord } from "./components/vega-rich-text-editor/vega-rich-text-link-editor/types";
 import { VegaSegmentControlVariant, VegaSegmentProps } from "./components/vega-segment-control/types";
@@ -114,6 +114,7 @@ export namespace Components {
         /**
           * Specifies the content to be displayed in the app footer.  By default, it includes Heartland's official copyright message    with a reference to the current year.
           * @vegaVersion 1.15.0
+          * @defaultValue © {{currentYear}} Heartland Payment Systems, LLC – a Global Payments company. All rights reserved.
          */
         "content": string;
         /**
@@ -134,6 +135,7 @@ export namespace Components {
         /**
           * Specifies the URL or web address that the    Privacy Policy link in the app footer should    navigate to when clicked.
           * @vegaVersion 1.15.0
+          * @defaultValue https://www.heartland.us/privacy-policy
          */
         "privacyPolicyUrl": string;
         /**
@@ -154,6 +156,7 @@ export namespace Components {
         /**
           * Specifies the URL or web address that the Terms of Use link    in the app footer should navigate to when clicked.
           * @vegaVersion 1.15.0
+          * @defaultValue https://www.heartland.us/terms
          */
         "termOfUseUrl": string;
         /**
@@ -607,6 +610,7 @@ export namespace Components {
         /**
           * Specifies the URL associated with the button link.
           * @vegaVersion 1.0.4
+          * @defaultValue javascript:void(0);
          */
         "link": string;
         /**
@@ -1678,6 +1682,7 @@ export namespace Components {
         /**
           * Specifies the allowed file types for upload.
           * @vegaVersion 1.14.0
+          * @defaultValue .jpg,.png,.jpeg
          */
         "accept": string;
         /**
@@ -2047,6 +2052,7 @@ export namespace Components {
         /**
           * Specifies the countries available for selection.  Note: By default, 245 codes are provided, but loading all of them may take time. To improve performance, it is recommended to include only the necessary codes.
           * @vegaVersion 2.18.0
+          * @defaultValue ['US', 'CN', ...]{@link VegaCountryCode }
          */
         "allowedCountryCodes": VegaCountryCode[];
         /**
@@ -2057,6 +2063,7 @@ export namespace Components {
         /**
           * Specifies the default country calling code using the two-letter uppercase country code.
           * @vegaVersion 2.18.0
+          * @defaultValue US
          */
         "countryCode": VegaCountryCode;
         /**
@@ -2108,6 +2115,7 @@ export namespace Components {
           * Specifies the value of the phone number input in [E.164]{@link https ://en.wikipedia.org/wiki/E.164} format.
           * @VegaWarning Note: The input phone number field will always have a value. If no phone number is entered, the default format is `+{default_country_code}`. For example, if the default country code is US, the default value will be `+1`.
           * @vegaVersion 2.18.0
+          * @defaultValue +1
          */
         "value": string;
     }
@@ -2295,11 +2303,13 @@ export namespace Components {
           * Defines the labels and icons associated with the toggle states.
           * @deprecated This property will be removed soon and replaced by prop statusMap
           * @vegaVersion 1.3.0
+          * @defaultValue {unToggledIcon: 'plus-sign', toggledIcon: 'delete-bin', unToggledLabel: 'Add', togglingLabel: 'Added', toggledLabel: 'Remove', unTogglingLabel: 'Removed'}
          */
         "itemToggleStatusMap": ItemToggleStatusMap;
         /**
           * Defines the labels and icons associated with the toggle states.
           * @vegaVersion 2.2.0
+          * @defaultValue {unToggledIcon: 'plus-sign', toggledIcon: 'delete-bin', unToggledLabel: 'Add', togglingLabel: 'Added', toggledLabel: 'Remove', unTogglingLabel: 'Removed'}
          */
         "statusMap": ItemToggleStatusMap;
     }
@@ -2375,7 +2385,8 @@ export namespace Components {
          */
         "icon": string;
         /**
-          * boolean indicating if current link item is selected **
+          * A boolean that indicates whether the current link item is selected.
+          * @VegaWarning Note: Ensure that the `custom-selection-enabled` property is set to `true` before modifying this value, as modifying it without this setting may lead to unexpected behavior.
           * @vegaVersion 1.31.0
          */
         "selected": boolean;
@@ -2853,6 +2864,7 @@ export namespace Components {
         /**
           * Specifies the value of the rich text editor, 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
+          * @defaultValue [{id:'UUID', type:'paragraph', nodes:[{id: 'UUID',type: 'text',text:''}]}]
          */
         "value": VegaRTEContent;
     }
@@ -3249,6 +3261,7 @@ export namespace Components {
         /**
           * Specifies an icon or symbol that appears before the placeholder,    providing visual context or enhancing the aesthetic appearance    of the signature capture.
           * @vegaVersion 2.19.0
+          * @defaultValue v-internal-icon signature
          */
         "placeholderIcon": string;
         /**
@@ -4984,6 +4997,7 @@ declare namespace LocalJSX {
         /**
           * Specifies the content to be displayed in the app footer.  By default, it includes Heartland's official copyright message    with a reference to the current year.
           * @vegaVersion 1.15.0
+          * @defaultValue © {{currentYear}} Heartland Payment Systems, LLC – a Global Payments company. All rights reserved.
          */
         "content"?: string;
         /**
@@ -5004,6 +5018,7 @@ declare namespace LocalJSX {
         /**
           * Specifies the URL or web address that the    Privacy Policy link in the app footer should    navigate to when clicked.
           * @vegaVersion 1.15.0
+          * @defaultValue https://www.heartland.us/privacy-policy
          */
         "privacyPolicyUrl"?: string;
         /**
@@ -5024,6 +5039,7 @@ declare namespace LocalJSX {
         /**
           * Specifies the URL or web address that the Terms of Use link    in the app footer should navigate to when clicked.
           * @vegaVersion 1.15.0
+          * @defaultValue https://www.heartland.us/terms
          */
         "termOfUseUrl"?: string;
         /**
@@ -5565,6 +5581,7 @@ declare namespace LocalJSX {
         /**
           * Specifies the URL associated with the button link.
           * @vegaVersion 1.0.4
+          * @defaultValue javascript:void(0);
          */
         "link"?: string;
         /**
@@ -6879,6 +6896,7 @@ declare namespace LocalJSX {
         /**
           * Specifies the allowed file types for upload.
           * @vegaVersion 1.14.0
+          * @defaultValue .jpg,.png,.jpeg
          */
         "accept"?: string;
         /**
@@ -7354,6 +7372,7 @@ declare namespace LocalJSX {
         /**
           * Specifies the countries available for selection.  Note: By default, 245 codes are provided, but loading all of them may take time. To improve performance, it is recommended to include only the necessary codes.
           * @vegaVersion 2.18.0
+          * @defaultValue ['US', 'CN', ...]{@link VegaCountryCode }
          */
         "allowedCountryCodes"?: VegaCountryCode[];
         /**
@@ -7364,6 +7383,7 @@ declare namespace LocalJSX {
         /**
           * Specifies the default country calling code using the two-letter uppercase country code.
           * @vegaVersion 2.18.0
+          * @defaultValue US
          */
         "countryCode"?: VegaCountryCode;
         /**
@@ -7437,6 +7457,7 @@ declare namespace LocalJSX {
           * Specifies the value of the phone number input in [E.164]{@link https ://en.wikipedia.org/wiki/E.164} format.
           * @VegaWarning Note: The input phone number field will always have a value. If no phone number is entered, the default format is `+{default_country_code}`. For example, if the default country code is US, the default value will be `+1`.
           * @vegaVersion 2.18.0
+          * @defaultValue +1
          */
         "value"?: string;
     }
@@ -7663,6 +7684,7 @@ declare namespace LocalJSX {
           * Defines the labels and icons associated with the toggle states.
           * @deprecated This property will be removed soon and replaced by prop statusMap
           * @vegaVersion 1.3.0
+          * @defaultValue {unToggledIcon: 'plus-sign', toggledIcon: 'delete-bin', unToggledLabel: 'Add', togglingLabel: 'Added', toggledLabel: 'Remove', unTogglingLabel: 'Removed'}
          */
         "itemToggleStatusMap"?: ItemToggleStatusMap;
         /**
@@ -7679,6 +7701,7 @@ declare namespace LocalJSX {
         /**
           * Defines the labels and icons associated with the toggle states.
           * @vegaVersion 2.2.0
+          * @defaultValue {unToggledIcon: 'plus-sign', toggledIcon: 'delete-bin', unToggledLabel: 'Add', togglingLabel: 'Added', toggledLabel: 'Remove', unTogglingLabel: 'Removed'}
          */
         "statusMap"?: ItemToggleStatusMap;
     }
@@ -7782,7 +7805,8 @@ declare namespace LocalJSX {
          */
         "onVegaMenuClick"?: (event: VegaLeftNavLinkCustomEvent<any>) => void;
         /**
-          * boolean indicating if current link item is selected **
+          * A boolean that indicates whether the current link item is selected.
+          * @VegaWarning Note: Ensure that the `custom-selection-enabled` property is set to `true` before modifying this value, as modifying it without this setting may lead to unexpected behavior.
           * @vegaVersion 1.31.0
          */
         "selected"?: boolean;
@@ -8314,7 +8338,7 @@ declare namespace LocalJSX {
           * @eventSemantics namespace:native
           * @vegaVersion 2.34.0
          */
-        "onChange"?: (event: VegaRichTextEditorCustomEvent<Array<VegaRTEContentBlock>>) => void;
+        "onChange"?: (event: VegaRichTextEditorCustomEvent<VegaRTEContent>) => void;
         /**
           * An event emitter notifying an image insertion event.
           * @eventSemantics namespace:native
@@ -8325,7 +8349,7 @@ declare namespace LocalJSX {
           * An event emitter notifying a value change.
           * @vegaVersion 2.34.0
          */
-        "onVegaChange"?: (event: VegaRichTextEditorCustomEvent<Array<VegaRTEContentBlock>>) => void;
+        "onVegaChange"?: (event: VegaRichTextEditorCustomEvent<VegaRTEContent>) => void;
         /**
           * An event emitter notifying an image insertion event.
           * @vegaVersion 2.34.0
@@ -8359,6 +8383,7 @@ declare namespace LocalJSX {
         /**
           * Specifies the value of the rich text editor, 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
+          * @defaultValue [{id:'UUID', type:'paragraph', nodes:[{id: 'UUID',type: 'text',text:''}]}]
          */
         "value"?: VegaRTEContent;
     }
@@ -8859,6 +8884,7 @@ declare namespace LocalJSX {
         /**
           * Specifies an icon or symbol that appears before the placeholder,    providing visual context or enhancing the aesthetic appearance    of the signature capture.
           * @vegaVersion 2.19.0
+          * @defaultValue v-internal-icon signature
          */
         "placeholderIcon"?: string;
         /**

package/dist/types/helpers/event-manager/event-id/vega-internal-event-id.d.ts

@@ -38,3 +38,4 @@ export declare const VegaInternalRichTextImageClick: VegaInternalEventID;
 export declare const VegaInternalRichTextImageDeleteButtonClicked: VegaInternalEventID;
 export declare const VegaInternalComponentDidRender: VegaInternalEventID;
 export declare const VegaInternalPopoverUpdateTarget: VegaInternalEventID;
+export declare const VegaInternalRichTextEditDeleteSelectedNodes: VegaInternalEventID;

package/dist/types/helpers/formatter/string-formatter/custom-formatter-strategy.d.ts

@@ -1,10 +1,10 @@
-import { StringFormatStrategy } from './string-format-strategy';
+import { StringFormatStrategy } from './string-format-strategy.abstract';
 import { Nullable } from '../../../types/general';
 export declare type CustomStringFormatter = (rawValue: string) => string;
 /**
  * Used to format a string using a custom formatter.
  */
-export declare class CustomFormatterStrategy implements StringFormatStrategy {
+export declare class CustomFormatterStrategy extends StringFormatStrategy {
   private readonly formatter;
   private resetCaretPositionFlag;
   /**
@@ -43,5 +43,5 @@ export declare class CustomFormatterStrategy implements StringFormatStrategy {
    *
    * @returns {boolean} true or false
    */
-  shouldTriggerAtInit(): boolean;
+  protected shouldTriggerAtInit(): boolean;
 }

package/dist/types/helpers/formatter/string-formatter/number-mask-strategy.d.ts

@@ -1,5 +1,5 @@
 import { Nullable } from '../../../types/general';
-import { StringFormatStrategy } from './string-format-strategy';
+import { StringFormatStrategy } from './string-format-strategy.abstract';
 export declare type NumberMaskConfig = {
   /**
    * 0 - will only allow integer
@@ -17,7 +17,7 @@ export declare type NumberMaskConfig = {
 /**
  * A class for formatting number with the given mask format
  */
-export declare class NumberMaskStrategy implements StringFormatStrategy {
+export declare class NumberMaskStrategy extends StringFormatStrategy {
   protected readonly maskConfig: NumberMaskConfig;
   protected mask: RegExp;
   /**

package/dist/types/helpers/formatter/string-formatter/string-format-strategy.abstract.d.ts

@@ -0,0 +1,48 @@
+import { Nullable } from '../../../types/general';
+export declare type FormatTrigger = 'blur' | 'input' | 'init';
+export declare type FormatTarget = 'component' | 'native-input';
+export declare type InputStatus = {
+  isBlurred?: boolean;
+  caretPosition?: Nullable<number>;
+};
+/**
+ * String format strategy abstract class
+ */
+export declare abstract class StringFormatStrategy {
+  /**
+   * Check if the {@link format} should be applied
+   *
+   * @param {FormatTrigger} triggeredBy - The trigger of the format
+   * @param {FormatTarget} target - The target of the format
+   * @param {InputStatus} inputStatus - The status of the input
+   * @returns {boolean} - Whether the format should be applied
+   */
+  canFormat(triggeredBy: FormatTrigger, target: FormatTarget, inputStatus?: InputStatus): boolean;
+  /**
+   * Calculates the new caret position in a formatted input string if needed.
+   *
+   * @param {string} input - The input string
+   * @param {number} caretPosition - The current position of caret
+   * @returns {number} The new position of caret
+   */
+  calculateCaretPosition?(input: string, caretPosition: Nullable<number>): Nullable<number>;
+  /**
+   * Determines whether a component value should be overridden based on the mask configuration.
+   *
+   * @returns {boolean} - Whether the component value should be overridden.
+   */
+  protected shouldOverrideComponentValueAfterBlur(): boolean;
+  /**
+   * Determines whether the format should be triggered at init.
+   *
+   * @returns {boolean} - Whether the format should be triggered at init.
+   */
+  protected shouldTriggerAtInit(): boolean;
+  /**
+   * Format the input string
+   *
+   * @param {string} input - The input string
+   * @param {InputStatus} inputStatus - The timing status of the format
+   */
+  abstract format(input: string, inputStatus?: InputStatus): string;
+}

package/dist/types/helpers/formatter/string-formatter/string-mask-strategy.d.ts

@@ -1,5 +1,5 @@
 import { Nullable } from '../../../types/general';
-import { StringFormatStrategy } from './string-format-strategy';
+import { InputStatus, StringFormatStrategy } from './string-format-strategy.abstract';
 export declare type MaskConfig = {
   mask: string;
   slot: string | RegExp;
@@ -13,7 +13,7 @@ export declare type MaskConfig = {
  *
  * @augments StringFormatStrategy
  */
-export declare class StringMaskStrategy implements StringFormatStrategy {
+export declare class StringMaskStrategy extends StringFormatStrategy {
   static PHONE_MASK: StringMaskStrategy;
   static ZIPCODE_MASK: StringMaskStrategy;
   static TAX_ID_MASK: StringMaskStrategy;
@@ -39,13 +39,9 @@ export declare class StringMaskStrategy implements StringFormatStrategy {
    */
   constructor(maskConfig: MaskConfig);
   /**
-   * Given a string, it replaces the mask with the matched input slot value
-   *
-   * @param {string} input - The input string that needs to be formatted.
-   * @param {number} caretPosition - The current position of caret
-   * @returns {string} The formatted string.
+   * @inheritDoc
    */
-  format(input: string, caretPosition?: Nullable<number>): string;
+  format(input: string, inputStatus?: InputStatus): string;
   /**
    * Get the position of
    *
@@ -60,7 +56,7 @@ export declare class StringMaskStrategy implements StringFormatStrategy {
    * @returns {boolean} The result overrideValue controls whether the component value same as the internal input value after the input blur
    * return false if property overrideValue is not exist or set to true, return false if maskConfig is not exist
    */
-  shouldOverrideComponentValueAfterBlur(): boolean;
+  protected shouldOverrideComponentValueAfterBlur(): boolean;
   /**
    * The function shouldTriggerAtInit returns true if the maskConfig is defined and its triggerAtInit
    * property is set to true, otherwise it returns false.
@@ -69,7 +65,7 @@ export declare class StringMaskStrategy implements StringFormatStrategy {
    * (this.maskConfig is truthy and this.maskConfig.triggerAtInit is true), it returns true. Otherwise,
    * it returns false.
    */
-  shouldTriggerAtInit(): boolean;
+  protected shouldTriggerAtInit(): boolean;
   /**
    * Get the length limit by mask
    *

package/dist/types/helpers/formatter/string-formatter/thousand-comma-strategy.d.ts

@@ -1,10 +1,10 @@
-import { StringFormatStrategy } from './string-format-strategy';
+import { StringFormatStrategy } from './string-format-strategy.abstract';
 /**
  * A class for formatting string with the "," as the thousand separator
  *
  * @augments StringFormatStrategy
  */
-export declare class ThousandCommaStrategy implements StringFormatStrategy {
+export declare class ThousandCommaStrategy extends StringFormatStrategy {
   /**
    * If the input is a number, format it as a string
    *