@globalpayments/vega 2.91.0 → 2.93.0

package/dist/types/components/vega-rich-text-editor/extensions/find-replace/vega-rich-text-find-replace-panel/slimmers/renderers/find-replace-panel-renderer.d.ts

@@ -0,0 +1,28 @@
+import { VegaSlimmer } from '../../../../../../../vega-slimmer/vega-slimmer-core';
+import type { VegaRichTextFindReplacePanel } from '../../vega-rich-text-find-replace-panel';
+export declare type FindReplacePanelAction = {
+  action: string;
+  data?: unknown;
+};
+/**
+ * Renderer slimmer for the Find & Replace panel.
+ * Renders a search input, a "current/total" counter, and prev/next/close icon buttons.
+ */
+export declare class FindReplacePanelRenderer extends VegaSlimmer {
+  changeEventEmitter: VegaRichTextFindReplacePanel['changeEventEmitter'];
+  clickEventEmitter: VegaRichTextFindReplacePanel['clickEventEmitter'];
+  currentIndex: VegaRichTextFindReplacePanel['currentIndex'];
+  total: VegaRichTextFindReplacePanel['total'];
+  matchCase: VegaRichTextFindReplacePanel['matchCase'];
+  wholeWords: VegaRichTextFindReplacePanel['wholeWords'];
+  render(): HTMLElement;
+  private renderHeader;
+  private renderNavButton;
+  private renderSearchOptionToggle;
+  private renderFindButton;
+  private renderActionButtons;
+  private onKeywordChange;
+  private onReplacementChange;
+  private onToggleSearchOption;
+  private emitAction;
+}

package/dist/types/components/vega-rich-text-editor/extensions/find-replace/vega-rich-text-find-replace-panel/vega-rich-text-find-replace-panel.d.ts

@@ -0,0 +1,56 @@
+import { EventEmitter } from '../../../../../stencil-public-runtime';
+import { GlobalSlimmers } from '../../../../../vega-slimmer/vega-slimmer-core';
+import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../../../helpers/slimmers/component-usage-runtime-metrics';
+import { EventEmitSlimmerBase } from '../../../../../helpers/event-manager/slimmers/event-emit-slimmer';
+import { FindReplacePanelRenderer } from './slimmers/renderers/find-replace-panel-renderer';
+/**
+ * Internal panel component for the Find & Replace extension.
+ * Renders a search input, match counter, and prev/next/close buttons.
+ *
+ * - Emits `vegaChange` (payload: { type, value }) when find/replace inputs change.
+ * - Emits `vegaClick` (payload: `{ action: string; data?: unknown }`) when a button is clicked.
+ * - Exposes `updateResult(currentIndex, total)` for the toolbar renderer to push match counts back.
+ *
+ * @vegaVersion 2.92.0
+ */
+export declare class VegaRichTextFindReplacePanel {
+  protected readonly globalSlimmers: GlobalSlimmers;
+  protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaRichTextFindReplacePanelElement>;
+  protected changeEventEmitter: EventEmitSlimmerBase;
+  protected clickEventEmitter: EventEmitSlimmerBase;
+  protected readonly renderer: FindReplacePanelRenderer;
+  host: HTMLVegaRichTextFindReplacePanelElement;
+  currentIndex: number;
+  total: number;
+  matchCase: boolean;
+  wholeWords: boolean;
+  /**
+   * Emitted when a panel input value changes.
+   * Payload includes the input type (`keyword` or `replace`) and value.
+   *
+   * @vegaVersion 2.92.0
+   */
+  vegaChange: EventEmitter<{
+    type: 'keyword' | 'replace';
+    value: string;
+  }>;
+  /**
+   * Emitted when a panel action button is clicked.
+   * Payload includes the action key and optional data.
+   *
+   * @vegaVersion 2.92.0
+   */
+  vegaClick: EventEmitter<{
+    action: string;
+    data?: unknown;
+  }>;
+  /**
+   * Updates the displayed match counter. Called by the toolbar renderer after each search or navigation.
+   *
+   * @param {number} currentIndex - 1-based index of the active match (0 when there are no matches).
+   * @param {number} total - Total number of matches.
+   * @vegaVersion 2.92.0
+   */
+  updateResult(currentIndex: number, total: number): Promise<void>;
+  render(): VegaRichTextFindReplacePanel;
+}

package/dist/types/components/vega-rich-text-editor/extensions/functions/function-extension.d.ts

@@ -3,6 +3,7 @@ import { VegaRTEExtension } from '../extension.abstract';
  * Function extension class for Vega Rich Text Editor.
  */
 export declare class VegaRTEFunctionExtension extends VegaRTEExtension {
+  static readonly TOOLBAR_BUTTON_KEY: string;
   constructor();
   /** @inheritDoc */
   prepareBeforeLoad(host: HTMLVegaRichTextEditorElement): void;

package/dist/types/components/vega-rich-text-editor/extensions/horizontal-line/horizontal-line-extension.d.ts

@@ -3,6 +3,7 @@ import { VegaRTEExtension } from '../extension.abstract';
  * Extension that adds horizontal line (`<hr>`) support to the Vega Rich Text Editor.
  */
 export declare class VegaRTEHorizontalLineExtension extends VegaRTEExtension {
+  static readonly TOOLBAR_BUTTON_KEY: string;
   private blockRenderer;
   private toolbarButtonRenderer;
   constructor();

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

@@ -0,0 +1,27 @@
+import { VegaRTEExtension } from '../extension.abstract';
+import { VegaRTEImageExtensionConfig } from './type';
+import { RTEExtensionStateStore } from '../rte-extension-state-store';
+/**
+ * Rich Text Editor extension that configures built-in image behavior.
+ */
+export declare class VegaRTEImageExtension extends VegaRTEExtension {
+  private readonly config;
+  /**
+   * Per-host config store. Declare as static readonly to isolate config per editor host.
+   *
+   * @type {RTEExtensionStateStore<VegaRTEImageExtensionConfig>}
+   */
+  static readonly configStore: RTEExtensionStateStore<VegaRTEImageExtensionConfig>;
+  constructor(config?: VegaRTEImageExtensionConfig);
+  /**
+   * Store config per host so both toolbar-image and inline-image editors
+   * can consistently read the extension settings.
+   *
+   * @param {HTMLElement} host - The host rich text editor element.
+   */
+  prepareBeforeLoad(host: HTMLVegaRichTextEditorElement): void;
+  /**
+   * Remove config for the current host when the extension is destroyed.
+   */
+  destroyExtension(): void;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * Configurable options for the image extension.
+ */
+export declare type VegaRTEImageExtensionConfig = {
+  /**
+   * Whether to enable image upload functionality in the rich text editor.
+   */
+  enableImageUpload?: boolean;
+  /**
+   * Whether to enable image insertion via URL in the rich text editor.
+   */
+  enableImageURLInsertion?: boolean;
+};

package/dist/types/components/vega-rich-text-editor/extensions/languages/language-extension.d.ts

@@ -5,6 +5,7 @@ import { VegaRTEExtension } from '../extension.abstract';
  * This extension allows users to switch between different languages and maintain separate content for each language.
  */
 export declare class VegaRTELanguageExtension extends VegaRTEExtension {
+  static readonly TOOLBAR_BUTTON_KEY: string;
   private languageToolbarButtonRenderer;
   private readonly languageList;
   private languageState;

package/dist/types/components/vega-rich-text-editor/extensions/line-height/line-height-extension.d.ts

@@ -6,6 +6,7 @@ import { VegaRTEExtension } from '../extension.abstract';
  */
 export declare class VegaRTELineHeightExtension extends VegaRTEExtension {
   private readonly options;
+  static readonly TOOLBAR_BUTTON_KEY: string;
   private toolbarButtonRenderer;
   constructor(options?: VegaRTELineHeightOption[]);
   /**

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

@@ -0,0 +1,3 @@
+import { IconPayload } from '../../../../../helpers/icon/interface';
+declare const _default: IconPayload;
+export default _default;

package/dist/types/components/vega-rich-text-editor/extensions/paste/paste-chooser-ui.d.ts

@@ -0,0 +1,58 @@
+export declare type PasteMode = 'rich';
+export declare type PasteChooserPosition = {
+  left: number;
+  top: number;
+  placement: ['bottom', 'top'] | ['top', 'bottom'];
+};
+export declare type PasteChooserCallbacks = {
+  onModeSelect: (mode: PasteMode) => void;
+};
+/**
+ * Renders and manages the paste format chooser UI.
+ */
+export declare class RTEPasteChooserUI {
+  private readonly hostRoot;
+  private readonly callbacks;
+  static readonly CHOOSER_ATTR: string;
+  static readonly CHOOSER_RICH_ATTR: string;
+  static readonly CHOOSER_TRIGGER_ATTR: string;
+  private chooserEl;
+  private dropdownEl;
+  private triggerButtonEl;
+  constructor(hostRoot: ShadowRoot, callbacks: PasteChooserCallbacks);
+  /**
+   * Opens the paste-mode chooser at the given position.
+   *
+   * @param {PasteChooserPosition} position Viewport position for the chooser.
+   */
+  open(position: PasteChooserPosition): void;
+  /**
+   * Removes the chooser from the DOM.
+   */
+  destroy(): void;
+  /**
+   * Determines whether the given event path targets the chooser.
+   *
+   * @param {EventTarget[]} eventPath Composed path of an event.
+   * @returns {boolean} `true` when the path includes the chooser.
+   */
+  includesEventPath(eventPath: EventTarget[]): boolean;
+  /**
+   * Builds the dropdown element with the rich text paste option.
+   *
+   * @param {Document} doc Document used to create elements.
+   * @param {['bottom', 'top'] | ['top', 'bottom']} placement Preferred placement order.
+   * @returns {HTMLElement} Configured dropdown element.
+   */
+  private createPasteChooserDropdown;
+  /**
+   * Creates a single dropdown item element for a paste mode.
+   *
+   * @param {Document} doc Document used to create the element.
+   * @param {PasteMode} key Paste mode key for the item.
+   * @param {string} label Display label for the item.
+   * @param {string} dataAttrName Data attribute marker for the item.
+   * @returns {HTMLVegaDropdownItemElement} Configured dropdown item element.
+   */
+  private createDropdownItem;
+}

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

@@ -0,0 +1,6 @@
+/**
+ * Custom DataTransfer MIME type used to tag a synthetic paste with the chosen
+ * paste mode (e.g. 'rich' or 'plain'), so downstream paste handling can decide
+ * whether to preserve the original inline styles.
+ */
+export declare const RTE_PASTE_MODE_DATA_TYPE: string;

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

@@ -0,0 +1,150 @@
+import { VegaRTEExtension } from '../extension.abstract';
+import { RTEExtensionContext } from '../../interface';
+/**
+ * Vega Rich Text Editor paste extension.
+ * Intercepts keyboard paste and allows users to choose paste mode.
+ */
+export declare class VegaRTEPasteExtension extends VegaRTEExtension {
+  private hostEl;
+  private editableEl;
+  private contentHostEl;
+  private chooserUI;
+  private pendingPastePayload;
+  private listenerDocument;
+  private listenerWindow;
+  /** @inheritDoc */
+  initialExtensionAfterLoad(context: RTEExtensionContext): void;
+  /** @inheritDoc */
+  destroyExtension(): void;
+  /**
+   * Handles a native paste event by capturing the clipboard payload and
+   * rendering the paste-mode chooser.
+   *
+   * @param {ClipboardEvent} event Native clipboard paste event.
+   */
+  private readonly handlePasteEvent;
+  /**
+   * Dismisses the chooser when a pointer interaction occurs outside of it.
+   *
+   * @param {Event} event Pointer event captured on the document.
+   */
+  private readonly handleOutsidePointerDown;
+  /**
+   * Dismisses the chooser when the Escape key is pressed.
+   *
+   * @param {KeyboardEvent} event Keyboard event captured on the document.
+   */
+  private readonly handleOutsideKeyDown;
+  /**
+   * Dismisses the chooser when any relevant scroll container scrolls.
+   */
+  private readonly handleOutsideScroll;
+  /**
+   * Attaches the paste listener to the editable element.
+   */
+  private attachPasteListener;
+  /**
+   * Detaches the paste listener from the editable element.
+   */
+  private detachPasteListener;
+  /**
+   * Resolves the content host and editable element from the host shadow tree.
+   *
+   * @returns {EditorElements} Editor elements.
+   */
+  private getEditorElements;
+  /**
+   * Resolves the editable content element from the host shadow tree.
+   *
+   * @returns {HTMLDivElement | null} Editable element or `null` when unavailable.
+   */
+  private getEditableElement;
+  /**
+   * Clones the current selection range so it can be restored after the user
+   * chooses a paste mode.
+   *
+   * @returns {Range | null} Cloned range or `null` when there is no selection.
+   */
+  private cloneCurrentSelectionRange;
+  /**
+   * Renders the paste-mode chooser and wires up dismissal listeners.
+   *
+   * @param {ClipboardEvent} pasteEvent Originating paste event used for positioning.
+   */
+  private renderPasteChooser;
+  /**
+   * Computes the on-screen position for the chooser based on pointer or caret.
+   *
+   * @param {ClipboardEvent} event Originating paste event.
+   * @returns {ChooserPosition} Position in viewport coordinates.
+   */
+  private computeChooserPosition;
+  /**
+   * Resolves the bounding rect of the pending caret position.
+   *
+   * @returns {DOMRect | null} Caret rect or `null` when it cannot be determined.
+   */
+  private getCaretRect;
+  /**
+   * Returns whether the browser could not resolve a meaningful caret rectangle.
+   *
+   * @param {DOMRect} rect Candidate caret rect.
+   * @returns {boolean} Whether the rect is unusable.
+   */
+  private isUnavailableRect;
+  /**
+   * Falls back to the range container or neighbor child node bounds.
+   *
+   * @param {Range} range Caret/selection range.
+   * @returns {DOMRect | null} Best-effort caret anchor rectangle.
+   */
+  private getRangeContainerRect;
+  /**
+   * Returns an element-backed rectangle from a DOM node.
+   *
+   * @param {Node | null} node Candidate node.
+   * @returns {DOMRect | null} Node rectangle when resolvable.
+   */
+  private getNodeRect;
+  /**
+   * Applies the chosen paste mode by dispatching a synthetic paste input event.
+   *
+   * @param {PasteMode} mode Selected paste mode.
+   */
+  private applyPasteMode;
+  /**
+   * Restores SelectionController state from the captured selection so synthetic
+   * beforeinput paste can replace the selected content instead of appending.
+   *
+   * @param {PendingPastePayload} payload Pending paste payload.
+   */
+  private restoreSelectionControllerState;
+  /**
+   * Restores a previously cloned selection range.
+   *
+   * @param {Range | null} range Range to restore.
+   */
+  private restoreSelectionRange;
+  /**
+   * Dispatches a synthetic `beforeinput` paste event into the editor pipeline.
+   *
+   * @param {HTMLDivElement} editableEl Editable content element.
+   * @param {DataTransfer} dataTransfer Clipboard payload for the paste.
+   */
+  private dispatchBeforeInputPaste;
+  /**
+   * Builds a `DataTransfer` payload carrying the paste content and mode marker.
+   *
+   * @param {string} html HTML clipboard content.
+   * @param {string} text Plain text clipboard content.
+   * @param {PasteMode} [mode] Selected paste mode marker.
+   * @returns {DataTransfer} Populated data transfer payload.
+   */
+  private createDataTransfer;
+  /**
+   * Tears down the chooser UI and removes dismissal listeners.
+   *
+   * @param {boolean} [clearPayload] Whether to also clear the pending payload.
+   */
+  private clearPasteChooser;
+}

package/dist/types/components/vega-rich-text-editor/extensions/special-characters/special-characters-extension.d.ts

@@ -6,6 +6,7 @@ import { VegaRTESpecialCharactersConfig } from './types';
  * for insertion into the editor content as plain text.
  */
 export declare class VegaRTESpecialCharactersExtension extends VegaRTEExtension {
+  static readonly TOOLBAR_BUTTON_KEY: string;
   private categories;
   constructor(config?: VegaRTESpecialCharactersConfig);
   /** @inheritDoc */

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

@@ -11,6 +11,7 @@ export declare type RTETableExtensionContext = RTEExtensionContext & {
  * Function extension class for Vega Rich Text Editor.
  */
 export declare class VegaRTETableExtension extends VegaRTEExtension {
+  static readonly TOOLBAR_BUTTON_KEY: string;
   private toolbarButtonRenderer;
   private tableBlockRenderer;
   private tableRowBlockRenderer;

package/dist/types/components/vega-rich-text-editor/extensions/tokens/token-extension.d.ts

@@ -4,6 +4,7 @@ import { VegaRTEExtension } from '../extension.abstract';
  * Vega Rich Text Editor Token Extension
  */
 export declare class VegaRTETokenExtension extends VegaRTEExtension {
+  static readonly TOOLBAR_BUTTON_KEY: string;
   private tokenRenderer;
   private readonly tokenList;
   constructor(tokenList?: (RTEDropdownListItem | RTEDropdownListGroup)[]);

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

@@ -6,3 +6,10 @@ import { AnnotationStyle } from '../interface';
  * @returns {AnnotationStyle} An object representing the custom style annotations.
  */
 export declare function createStyleMapFromElement(element: HTMLElement): AnnotationStyle;
+/**
+ * Escape HTML-sensitive characters so text can be rendered literally in HTML.
+ *
+ * @param {string} text - Raw text content.
+ * @returns {string} Escaped text content.
+ */
+export declare function escapeHtml(text: string): string;

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

@@ -17,10 +17,16 @@ export { VegaRTELanguageExtension } from './extensions/languages/language-extens
 export { VegaRTEFunctionExtension } from './extensions/functions/function-extension';
 export { VegaRTETableExtension } from './extensions/table/table-extension';
 export { VegaRTEHorizontalLineExtension } from './extensions/horizontal-line/horizontal-line-extension';
+export { VegaRTEBlockquoteExtension } from './extensions/blockquote/blockquote-extension';
+export { RTEBlockquoteBlock } from './extensions/blockquote/dto/rte-blockquote-block';
 export { VegaRTESpecialCharactersExtension } from './extensions/special-characters/special-characters-extension';
+export { VegaRTEFindReplaceExtension } from './extensions/find-replace/find-replace-extension';
 export { VegaRTESpecialCharactersEssentials, VegaRTESpecialCharactersLatin, VegaRTESpecialCharactersMathematical, VegaRTESpecialCharactersArrows, VegaRTESpecialCharactersCurrency, VegaRTESpecialCharactersText, } from './extensions/special-characters/constants/default-categories';
 export { VegaRTELineHeightExtension } from './extensions/line-height/line-height-extension';
 export { VegaRTELinkExtension } from './extensions/link/link-extension';
+export { VegaRTEPasteExtension } from './extensions/paste/paste-extension';
+export { VegaRTECopyExtension } from './extensions/copy/copy-extension';
+export { VegaRTECutExtension } from './extensions/cut/cut-extension';
 export { ModifyContentAction, ModifyContentActionType } from './dto/actions/modify-content-action.abstract';
 export { AppendChildrenAction } from './dto/actions/append-child-nodes-action';
 export { RemoveChildrenAction } from './dto/actions/remove-child-action';
@@ -29,6 +35,7 @@ export { InsertChildrenBeforeAction } from './dto/actions/insert-children-before
 export { InsertNodeToNearestRootAction } from './dto/actions/insert-node-to-nearest-root-action';
 export { UpdateCursorPositionAction } from './dto/actions/update-cursor-position-action';
 export { InsertNewParagraphAction } from './dto/actions/insert-new-paragraph-action';
+export { DeleteSelectedContentAction } from './dto/actions/delete-selected-content-action';
 export { CustomAttributeAnnotation } from './dto/annotations/custom-attribute-annotation';
 export { CustomClassAnnotation } from './dto/annotations/custom-class-annotation';
 export { CustomStyleAnnotation } from './dto/annotations/custom-style-annotation';

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

@@ -0,0 +1,60 @@
+import { RTEBlock } from '../../../../dto/blocks/block.abstract';
+import { RTENode } from '../../../../dto/nodes/node.abstract';
+import { Nullable } from '../../../../../../types/general';
+import { BaseHandler } from './base-handler';
+/** The resulting caret position after shifting one step to the right for forward deletion. */
+export interface ForwardDeletePosition {
+  node: RTENode;
+  offset: number;
+}
+/**
+ * Hosts the deletion logic shared by the forward and backward delete handlers. Subclasses implement
+ * the single-block deletion behaviour for their specific direction. User press backspace or delete
+ * will trigger one of those subclasses.
+ */
+export declare abstract class AbstractDeleteContentHandler extends BaseHandler {
+  /**
+   * Delete the selected node(s) from the current state.
+   */
+  handleEvent(): void;
+  /**
+   * Computes the caret position one step to the right, used to translate a forward delete into a backspace.
+   *
+   * @param {Nullable<RTENode>} node - The node the caret is currently in.
+   * @param {number} offset - The current caret offset within the node.
+   * @returns {Nullable<ForwardDeletePosition>} The shifted position, or null when the caret is at the end of the content.
+   */
+  protected getForwardDeletePosition(node: Nullable<RTENode>, offset: number): Nullable<ForwardDeletePosition>;
+  /**
+   * Returns the next node relative to the given node, crossing block boundaries when needed.
+   *
+   * @param {RTENode} node - The current node.
+   * @returns {Nullable<RTENode>} The next node, or null when the given node is the last node of the content.
+   */
+  protected getNextNode(node: RTENode): Nullable<RTENode>;
+  /**
+   * Returns the next block relative to the given block, ascending out of nested list structures when needed.
+   *
+   * @param {RTEBlock} block - The current block.
+   * @returns {Nullable<RTEBlock>} The next block, or null when the given block is the last block of the content.
+   */
+  protected getNextBlock(block: RTEBlock): Nullable<RTEBlock>;
+  /**
+   * Deletes the content within multiple nodes selected by the user.
+   */
+  protected deleteContentWithMultipleNodes(): void;
+  /**
+   * If the first block is not paragraph, convert the block to paragraph after delete all text
+   *
+   * @param {RTEBlock} block - The first block instance
+   */
+  protected convertFirstBlockToParagraph(block: RTEBlock): void;
+  /**
+   * Creates a new paragraph element with a text node and appends it to the current state.
+   */
+  protected insertDefaultParagraph(): void;
+  /**
+   * Handles a single-block deletion of content within an RTE editor for the handler's direction.
+   */
+  protected abstract deleteContentWithSingleBlock(): void;
+}

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

@@ -0,0 +1,8 @@
+import { AbstractDeleteContentHandler } from './abstract-delete-content-handler';
+/** Handles a backspace (leftward) deletion of content within a VegaRTE editor. User press backspace will trigger this method */
+export declare class BackwardDeleteContentHandler extends AbstractDeleteContentHandler {
+  /**
+   * Handles a backspace (leftward) deletion of content within a single block in an RTE editor.
+   */
+  protected deleteContentWithSingleBlock(): void;
+}

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

@@ -0,0 +1,8 @@
+import { AbstractDeleteContentHandler } from './abstract-delete-content-handler';
+/** Handles a delete (rightward) deletion of content within a VegaRTE editor. User press delete will trigger this method */
+export declare class ForwardDeleteContentHandler extends AbstractDeleteContentHandler {
+  /**
+   * Handles a delete (rightward) deletion of content within a single block in an RTE editor.
+   */
+  protected deleteContentWithSingleBlock(): void;
+}