@globalpayments/vega 2.90.0 → 2.92.0

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

@@ -0,0 +1,73 @@
+import { FindReplaceControllerAbstract, FindReplaceControllerContext } from './find-replace-controller.abstract';
+import type { FindReplaceResult } from './find-replace-controller.abstract';
+import { VegaRTEContent } from '../../../../../../types/components.type';
+/**
+ * Replace controller — adds mutation capabilities on top of the shared
+ * find state.
+ *
+ * Shares state with {@link FindController} via the injected
+ * {@link FindReplaceControllerContext}, so both controllers always operate
+ * on the same search results and highlight overlays.
+ */
+export declare class ReplaceController extends FindReplaceControllerAbstract {
+  /** The replacement string used by replace() and replaceAll(). Updated via setReplacement(). */
+  private replacement;
+  private flushFn;
+  constructor(context: FindReplaceControllerContext);
+  /**
+   * Stores the flush callback used to commit content changes to the editor.
+   * Called by the toolbar renderer after obtaining it from the extension context.
+   *
+   * Calling `flushValue` once — even after mutating multiple nodes — creates a
+   * single entry in the editor's undo stack, so the entire replace/replaceAll
+   * operation is undone as one atomic step.
+   *
+   * @param {(value: VegaRTEContent) => void} fn - The flush function.
+   * @returns {void} No return value.
+   */
+  setFlushValue(fn: (value: VegaRTEContent) => void): void;
+  /**
+   * Stores the replacement text for the next replace() or replaceAll() call.
+   *
+   * @param {string} text - The replacement string.
+   * @returns {void} No return value.
+   */
+  setReplacement(text: string): void;
+  /**
+   * Replaces the current match with the stored replacement text,
+   * advances to the next match, and refreshes highlights.
+   * An empty replacement string deletes the matched text.
+   *
+   * No-op when there is no current match or no host.
+   *
+   * @returns {FindReplaceResult} Updated match position and total.
+   */
+  replace(): FindReplaceResult;
+  /**
+   * Replaces all matches with the stored replacement text in a single operation
+   * (one flushValue call = one Undo step), then re-runs the search.
+   * An empty replacement string deletes all matched text.
+   *
+   * No-op when there are no matches or no host.
+   *
+   * @returns {FindReplaceResult} Updated match position and total.
+   */
+  replaceAll(): FindReplaceResult;
+  /**
+   * Directly mutates the matched nodes in the live content tree.
+   * `position.node` is already a reference into `this.context.hostRef.value`,
+   * so no cloning or path navigation is needed.
+   *
+   * For multi-node (cross-span) matches the first node receives the replacement
+   * text and every subsequent node has its matched slice deleted.
+   *
+   * This method mutates the content tree in place. The caller is
+   * responsible for calling `state.clear()` afterwards to invalidate the
+   * flat-text cache, which uses reference equality and will not detect the
+   * in-place change automatically.
+   *
+   * @param {FindMatch} match - The match to replace.
+   * @returns {void} No return value.
+   */
+  private applyMatchReplacement;
+}

package/dist/types/components/vega-rich-text-editor/extensions/find-replace/slimmer/renderers/find-replace-toolbar-button-renderer.d.ts

@@ -0,0 +1,64 @@
+import { VegaRTECreateElementFunction, VegaRTEToolbarRenderContext, VegaRTERenderResult } from '../../../../interface';
+import { VegaRTEToolbarButtonRenderer } from '../../../base-toolbar-button-renderer';
+/**
+ * Toolbar button renderer for the Find & Replace extension.
+ *
+ * Responsible only for UI concerns:
+ * - Renders the toolbar button wrapped in a vega-popover.
+ * - Wires panel events to the {@link FindController} and {@link ReplaceController}.
+ * - Pushes controller results back to the panel display.
+ *
+ * Both controllers share a single {@link FindReplaceControllerContext} so they
+ * operate on the same search state and highlight overlays.
+ */
+export declare class FindReplaceToolbarButtonRenderer extends VegaRTEToolbarButtonRenderer {
+  private readonly sharedContext;
+  private readonly findController;
+  private readonly replaceController;
+  private panelRef;
+  private popoverRef;
+  private isPopoverOpen;
+  private scrollOnNextRefresh;
+  private readonly debouncedRefresh;
+  private readonly panelActionHandlers;
+  /**
+   * @inheritDoc
+   */
+  render(h: VegaRTECreateElementFunction, editorContext: VegaRTEToolbarRenderContext): VegaRTERenderResult;
+  /**
+   * Toggles the popover open/close when the toolbar button is clicked.
+   */
+  protected handleButtonClick(): void;
+  /**
+   * Not used — this button has no dropdown.
+   */
+  protected handleDropdownClick(): void;
+  /**
+   * Synchronizes internal state with the editor context on each render cycle.
+   * Registers the host reference and content-change listener, and hides the
+   * popover if the toolbar item becomes hidden while open.
+   *
+   * @param {VegaRTEToolbarRenderContext} editorContext - The render context.
+   */
+  private syncEditorState;
+  /**
+   * Dispatches panel button actions to the controller.
+   *
+   * @param {FindReplacePanelAction} panelAction - The structured action emitted by the panel.
+   */
+  private handlePanelAction;
+  /**
+   * Pushes result to the panel counter display.
+   *
+   * @param {FindReplaceResult} result - The current/total values.
+   */
+  private updatePanel;
+  /**
+   * Content changed — ask the controller to refresh search results.
+   */
+  private onContentChanged;
+  /**
+   * Closes the panel popover.
+   */
+  private closePanel;
+}

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/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/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/public-api.d.ts

@@ -18,9 +18,12 @@ export { VegaRTEFunctionExtension } from './extensions/functions/function-extens
 export { VegaRTETableExtension } from './extensions/table/table-extension';
 export { VegaRTEHorizontalLineExtension } from './extensions/horizontal-line/horizontal-line-extension';
 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 { 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 +32,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;
+}

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

@@ -104,6 +104,28 @@ export declare class SelectionController extends AutoRunWhenReRenderTaskQueueSli
    * The method invoke after the component re-render.
    */
   protected doTask: () => Promise<void>;
+  /**
+   * Scroll the editor's scrollable viewport so the caret stays visible.
+   * Setting the selection range programmatically does not trigger the browser's
+   * native auto-scroll, so when the cursor is moved (e.g. after inserting a
+   * function block) it can land outside the visible area of a fixed-height
+   * (rows) editor. This keeps the caret within view.
+   *
+   * Note: This method performs getBoundingClientRect() reads and is called during
+   * the re-render task path every time the saved selection is restored.
+   *
+   * @param {Range} range - The range that was applied to the selection.
+   */
+  private scrollCaretIntoView;
+  /**
+   * Get the bounding rect of the caret for the given range.
+   * A collapsed range inside an empty node can return an empty rect, so in that
+   * case fall back to the nearest element's bounding rect.
+   *
+   * @param {Range} range - The range to measure.
+   * @returns {Nullable<DOMRect>} The caret bounding rect, or null if it cannot be resolved.
+   */
+  private getCaretRect;
   /**
    * Save the current selection range detail
    */

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

@@ -12,7 +12,8 @@ export declare class UserInputController extends VegaSlimmer {
   private insertTextHandler;
   private insertParagraphHandler;
   private insertLineBreakHandler;
-  private deleteContentHandler;
+  private forwardDeleteContentHandler;
+  private backwardDeleteContentHandler;
   private insertPasteHandler;
   /**
    * Adds event listener to an editable HTML element to handle user input actions.

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

@@ -163,11 +163,14 @@ export declare class VegaRichTextEditor {
    */
   hint: string;
   /**
-   * Specifies editable section rows for the rich text editor
+   * Specifies editable section rows for the rich text editor.
+   * When not set, the editor uses stretching behavior with a default visual height of 5 rows.
+   * When set, the editor height is fixed and content overflow is scrollable.
+   * The value accepts integers ≥ 2; for optimal display, values below 2 are internally normalized to 5 rows.
    *
    * @vegaVersion 2.34.0
    */
-  rows: number;
+  rows?: number;
   /**
    * Specifies the value of the rich text editor, which can be either VegaRTEContent or VegaRTEContentBlock.
    * It is recommended to use the VegaRTEContent type.