@globalpayments/vega 2.33.0 → 2.34.1

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

@@ -0,0 +1,186 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
+import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+import { VegaRichTextEditorRenderer } from './slimmers/renderers/vega-rich-text-editor-renderer';
+import { VegaRTEContentBlock, VegaRichTextEditorImage } from './interface';
+import { ToolbarRenderer } from './slimmers/renderers/toolbar-renderer';
+import { BoldToolbarButtonSlimmer } from './slimmers/renderers/tools/bold-toolbar-button-slimmer';
+import { ItalicToolbarButtonSlimmer } from './slimmers/renderers/tools/italic-toolbar-button-slimmer';
+import { UnderlineToolbarButtonSlimmer } from './slimmers/renderers/tools/underline-toolbar-button-slimmer';
+import { TextStylesToolbarButtonSlimmer } from './slimmers/renderers/tools/text-styles-toolbar-button-slimmer';
+import { VegaRTEToolbarItem } from './interface';
+import { ClearStyleToolbarButtonSlimmer } from './slimmers/renderers/tools/clear-style-toolbar-button-slimmer';
+import { CodeToolbarButtonSlimmer } from './slimmers/renderers/tools/code-toolbar-button-slimmer';
+import { StrikethroughToolbarButtonSlimmer } from './slimmers/renderers/tools/strikethrough-toolbar-button-slimmer';
+import { LinkToolbarButtonSlimmer } from './slimmers/renderers/tools/link-toolbar-button-slimmer';
+import { MoreIndentToolbarButtonSlimmer } from './slimmers/renderers/tools/more-indent-toolbar-button-slimmer';
+import { LessIndentToolbarButtonSlimmer } from './slimmers/renderers/tools/less-indent-toolbar-button-slimmer';
+import { ImageToolbarButtonSlimmer } from './slimmers/renderers/tools/image-toolbar-button-slimmer';
+import { FormFieldControllerSlimmer } from '../../helpers/slimmers/form-field-controller-slimmer';
+import { FormFieldValidationRule } from '../../helpers/validator/rules/form-field-validation-rule';
+import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
+import { TextColorToolbarButtonSlimmer } from './slimmers/renderers/tools/text-color-toolbar-button-slimmer';
+import { SubStateNotifySlimmerBase } from '../../helpers/slimmers/sub-state/sub-state-notify-slimmer-base';
+import { BulletsNumbersToolbarButtonSlimmer } from './slimmers/renderers/tools/bullets-numbers/bullets-numbers-toolbar-button-slimmer';
+import { HorizontalAlignmentToolbarButtonSlimmer } from './slimmers/renderers/tools/horizontal-alignment/horizontal-alignment-toolbar-button-slimmer';
+import { SelectionController } from './slimmers/controllers/selection-controller';
+import { ValueController } from './slimmers/controllers/value-controller';
+import { RTEBlock } from './dto/blocks/block.abstract';
+import { RTENode } from './dto/nodes/node.abstract';
+import { VegaRTEContent } from './dto/content-state';
+import { DarkModeStateControllerSlimmer } from '../../helpers/slimmers/dark-mode-state-controller-slimmer';
+import { RichTextContentController } from './slimmers/controllers/rich-text-content-controller';
+import { UserInputController } from './slimmers/controllers/user-input-controller';
+import { InsertImageController } from './slimmers/controllers/insert-image-controller';
+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';
+/**
+ * @vegaVersion 2.34.0
+ */
+export declare class VegaRichTextEditor {
+  protected readonly globalSlimmers: GlobalSlimmers;
+  protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaRichTextEditorElement>;
+  protected formFieldController: FormFieldControllerSlimmer<VegaRTEContentBlock[]>;
+  protected changeEventEmitter: EventEmitSlimmerBase;
+  protected readonly vegaRichTextEditorRenderer: VegaRichTextEditorRenderer;
+  protected readonly valueController: ValueController;
+  protected readonly selectionController: SelectionController;
+  protected readonly focusController: FocusController;
+  protected readonly darkModeStateControllerSlimmer: DarkModeStateControllerSlimmer;
+  protected readonly toolbarRenderer: ToolbarRenderer;
+  protected readonly clearStyleToolbarButtonSlimmer: ClearStyleToolbarButtonSlimmer;
+  protected readonly boldToolbarButtonSlimmer: BoldToolbarButtonSlimmer;
+  protected readonly italicToolbarButtonSlimmer: ItalicToolbarButtonSlimmer;
+  protected readonly underlineToolbarButtonSlimmer: UnderlineToolbarButtonSlimmer;
+  protected readonly textColorToolbarButtonSlimmer: TextColorToolbarButtonSlimmer;
+  protected readonly textStylesToolbarButtonSlimmer: TextStylesToolbarButtonSlimmer;
+  protected readonly codeToolbarButtonSlimmer: CodeToolbarButtonSlimmer;
+  protected readonly strikethroughToolbarButtonSlimmer: StrikethroughToolbarButtonSlimmer;
+  protected readonly imageToolbarButtonSlimmer: ImageToolbarButtonSlimmer;
+  protected readonly linkToolbarButtonSlimmer: LinkToolbarButtonSlimmer;
+  protected readonly moreIndentToolbarButtonSlimmer: MoreIndentToolbarButtonSlimmer;
+  protected readonly lessIndentToolbarButtonSlimmer: LessIndentToolbarButtonSlimmer;
+  protected readonly bulletsNumbersToolbarButtonSlimmer: BulletsNumbersToolbarButtonSlimmer;
+  protected readonly horizontalAlignmentToolbarButtonSlimmer: HorizontalAlignmentToolbarButtonSlimmer;
+  protected readonly placeholderNotifySlimmer: SubStateNotifySlimmerBase;
+  protected readonly disabledNotifySlimmer: SubStateNotifySlimmerBase;
+  protected readonly richTextContentController: RichTextContentController;
+  protected readonly userInputController: UserInputController;
+  protected readonly insertImageController: InsertImageController;
+  protected imageInsertedEventEmitter: EventEmitSlimmerBase;
+  protected changeEventPreventSlimmer: ChildNodesEventPreventSlimmer;
+  protected readonly textNodeColorController: TextNodeColorController;
+  host: HTMLVegaRichTextEditorElement;
+  richTextContentEditable: boolean;
+  watchRichTextContentEditable(): void;
+  selectionMap: Map<RTEBlock, RTENode[]>;
+  isInDarkMode: boolean;
+  /**
+   * Specifies the label for the rich text editor.
+   *
+   * It provides descriptive text that helps identify the
+   *    purpose or content expected in the rich text editor.
+   *
+   * @vegaVersion 2.34.0
+   */
+  label: string;
+  /**
+   * Determines whether the rich text editor field is required.
+   *
+   * @vegaVersion 2.34.0
+   */
+  required: boolean;
+  /**
+   * Specifies a placeholder string that displays as a
+   *    temporary hint or example within the rich text editor.
+   *
+   * It indicates the expected format or pattern of
+   *    the input within the rich text editor.
+   *
+   * @vegaVersion 2.34.0
+   */
+  placeholder: string;
+  watchPlaceholder(): void;
+  /**
+   * Specifies whether the rich text editor is disabled.
+   *
+   * @vegaVersion 2.34.0
+   */
+  disabled: boolean;
+  watchDisabled(): void;
+  /**
+   * Provides a supplementary prompt message that assists users in
+   *    understanding the expected value within the rich text editor.
+   *
+   * @vegaVersion 2.34.0
+   */
+  hint: string;
+  /**
+   * Specifies editable section rows for the rich text editor
+   *
+   * @vegaVersion 2.34.0
+   */
+  rows: number;
+  /**
+   * Specifies the value of the rich text editor
+   *
+   * @vegaVersion 2.34.0
+   */
+  value: VegaRTEContent;
+  watchValueUpdate(): void;
+  /**
+   * Specifies the built-in toolbar items available in the rich-text editor.
+   *
+   * @vegaVersion 2.34.0
+   */
+  toolbarItems: VegaRTEToolbarItem[][];
+  /**
+   * Specifies the validation status of the rich text editor component.
+   *
+   * @vegaVersion 2.34.0
+   */
+  isValid: boolean | null;
+  /**
+   * Determines whether automatic validation should be implemented for
+   * the rich text editor.
+   *
+   * @vegaVersion 2.34.0
+   */
+  autoValidation: boolean;
+  /**
+   * Defines custom validation rules for the rich text editor.
+   *
+   * @vegaVersion 2.34.0
+   */
+  validationRules: FormFieldValidationRule<unknown>[];
+  watchValidationRules(): void;
+  /**
+   * An event emitter notifying a value change.
+   *
+   * @vegaVersion 2.34.0
+   */
+  vegaChange: EventEmitter<Array<VegaRTEContentBlock>>;
+  /**
+   * An event emitter notifying a value change.
+   *
+   * @eventSemantics namespace:native
+   * @vegaVersion 2.34.0
+   */
+  change: EventEmitter<Array<VegaRTEContentBlock>>;
+  /**
+   * An event emitter notifying an image insertion event.
+   *
+   * @vegaVersion 2.34.0
+   */
+  vegaImageInserted: EventEmitter<VegaRichTextEditorImage>;
+  /**
+   * An event emitter notifying an image insertion event.
+   *
+   * @eventSemantics namespace:native
+   * @vegaVersion 2.34.0
+   */
+  imageInserted: EventEmitter<VegaRichTextEditorImage>;
+  componentWillLoad(): void;
+  render(): VegaRichTextEditor;
+}

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

@@ -0,0 +1,20 @@
+import { VegaSlimmer } from '../../../../../vega-slimmer/vega-slimmer-core';
+import { VegaRichTextImageEditor } from '../../vega-rich-text-image-editor';
+export declare class VegaRichTextImageEditorRenderer extends VegaSlimmer {
+  protected currentPage: VegaRichTextImageEditor['currentPage'];
+  protected selected: VegaRichTextImageEditor['selected'];
+  protected host: VegaRichTextImageEditor['host'];
+  protected alt: VegaRichTextImageEditor['alt'];
+  protected size: VegaRichTextImageEditor['size'];
+  protected changeEventEmitter: VegaRichTextImageEditor['changeEventEmitter'];
+  private formRef;
+  private popoverRef;
+  private parentContainerRef;
+  render(): HTMLElement;
+  protected findParentContainerRef(): void;
+  private renderImageEditor;
+  private renderAltTextEditor;
+  private notifyImageSelected;
+  private notifyImageDeleteButtonClicked;
+  private handleKeyDown;
+}

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

@@ -0,0 +1,15 @@
+export type VegaRichTextImageEditorSizeType = 'sm' | 'md' | 'lg';
+
+export type VegaRTEImageEditorRecord = {
+	size: VegaRichTextImageEditorSizeType;
+	alt: string;
+};
+
+export type VegaRichTextImageEditorChangeDetail =
+	| {
+			action: 'edit';
+			payload: VegaRTEImageEditorRecord;
+	  }
+	| {
+			action: 'delete';
+	  };

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

@@ -0,0 +1,46 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
+import { GlobalSlimmers } from '../../../vega-slimmer/vega-slimmer-core';
+import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+import { VegaRichTextImageEditorRenderer } from './slimmers/renderers/vega-rich-text-image-editor-renderer';
+import { EventEmitSlimmerBase } from '../../../helpers/event-manager/slimmers/event-emit-slimmer';
+import { VegaRichTextImageEditorChangeDetail, VegaRichTextImageEditorSizeType } from './types';
+/**
+ * This is an internal used component and shouldn't be used by clients,
+ *    it doesn't show up in storybook either.
+ *
+ * @vegaVersion 2.34.0
+ */
+export declare class VegaRichTextImageEditor {
+  protected readonly globalSlimmers: GlobalSlimmers;
+  protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaRichTextImageEditorElement>;
+  protected readonly renderer: VegaRichTextImageEditorRenderer;
+  protected changeEventEmitter: EventEmitSlimmerBase;
+  host: HTMLVegaRichTextImageEditorElement;
+  currentPage: number;
+  selected: boolean;
+  /**
+   * Specifies the value of image alt
+   *
+   * @vegaVersion 2.34.0
+   */
+  alt: string;
+  /**
+   * Specifies the size of the image to the container
+   *
+   * @vegaVersion 2.34.0
+   */
+  size: VegaRichTextImageEditorSizeType;
+  /**
+   * An event emitter notifying content change.
+   *
+   * @vegaVersion 2.34.0
+   */
+  vegaChange: EventEmitter<VegaRichTextImageEditorChangeDetail>;
+  /**
+   * An event emitter notifying content change.
+   *
+   * @vegaVersion 2.34.0
+   */
+  change: EventEmitter<VegaRichTextImageEditorChangeDetail>;
+  render(): VegaRichTextImageEditor;
+}

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

@@ -0,0 +1,29 @@
+import { VegaSlimmer } from '../../../../../vega-slimmer/vega-slimmer-core';
+import { VegaRichTextLinkEditor } from '../../vega-rich-text-link-editor';
+export declare class VegaRichTextLinkEditorRenderer extends VegaSlimmer {
+  protected host: VegaRichTextLinkEditor['host'];
+  protected status: VegaRichTextLinkEditor['status'];
+  protected record: VegaRichTextLinkEditor['record'];
+  protected changeEventEmitter: VegaRichTextLinkEditor['changeEventEmitter'];
+  protected resetStatusAfterHide: VegaRichTextLinkEditor['resetStatusAfterHide'];
+  protected target: VegaRichTextLinkEditor['target'];
+  private formRef;
+  private popoverRef;
+  private urlInputRef;
+  /**
+   * Component lifecycle - [componentDidLoad]{@link VegaRichTextLinkEditor.componentDidLoad}
+   */
+  componentDidLoad(): void;
+  /**
+   * Component lifecycle - [componentDidRender]{@link VegaRichTextLinkEditor.componentDidRender}
+   */
+  componentDidRender(): void;
+  watchStatusChange(): void;
+  watchTargetChange(): void;
+  getPopoverRef(): HTMLVegaPopoverElement;
+  render(): HTMLElement;
+  private renderLinkUnlinkContent;
+  private renderLinkEditContent;
+  private handleKeyDown;
+  private updatePopoverTarget;
+}

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

@@ -0,0 +1,15 @@
+export type VegaRichTextLinkEditorStatus = 'editOrUnlinkSelection' | 'linkEdit';
+
+export type VegaRTELinkEditorRecord = {
+	text: string;
+	url: string;
+};
+
+export type VegaRichTextLinkEditorChangeDetail =
+	| {
+			action: 'link';
+			payload: VegaRTELinkEditorRecord;
+	  }
+	| {
+			action: 'unlink';
+	  };

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

@@ -0,0 +1,64 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
+import { GlobalSlimmers } from '../../../vega-slimmer/vega-slimmer-core';
+import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+import { VegaRichTextLinkEditorRenderer } from './slimmers/renderers/vega-rich-text-link-editor-renderer';
+import { EventEmitSlimmerBase } from '../../../helpers/event-manager/slimmers/event-emit-slimmer';
+import { VegaRichTextLinkEditorChangeDetail, VegaRichTextLinkEditorStatus, VegaRTELinkEditorRecord } from './types';
+/**
+ * This is an internal used component and shouldn't be used by clients,
+ *    it doesn't show up in storybook either.
+ *
+ * @vegaVersion 2.34.0
+ */
+export declare class VegaRichTextLinkEditor {
+  protected readonly globalSlimmers: GlobalSlimmers;
+  protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaRichTextLinkEditorElement>;
+  protected readonly renderer: VegaRichTextLinkEditorRenderer;
+  protected changeEventEmitter: EventEmitSlimmerBase;
+  host: HTMLVegaRichTextLinkEditorElement;
+  /**
+   * Specifies the status of the link editor
+   *
+   * @vegaVersion 2.34.0
+   */
+  status: VegaRichTextLinkEditorStatus;
+  watchStatusChange(): void;
+  /**
+   * Specifies the hyperlink editor record
+   *
+   * @vegaVersion 2.34.0
+   */
+  record: VegaRTELinkEditorRecord;
+  /**
+   * Specifies whether the status will be reset after hide the popover
+   *
+   * @vegaVersion 2.34.0
+   */
+  resetStatusAfterHide: boolean;
+  /**
+   * Specifies the target element for the popover.
+   *
+   * @vegaVersion 2.34.0
+   */
+  target: HTMLElement;
+  watchTargetChange(): void;
+  /**
+   * An event emitter notifying content change.
+   *
+   * @vegaVersion 2.34.0
+   */
+  vegaChange: EventEmitter<VegaRichTextLinkEditorChangeDetail>;
+  /**
+   * An event emitter notifying content change.
+   *
+   * @vegaVersion 2.34.0
+   */
+  change: EventEmitter<VegaRichTextLinkEditorChangeDetail>;
+  /**
+   * Provide a method to show the link editor popover
+   *
+   * @vegaVersion 2.34.0
+   */
+  show(): Promise<void>;
+  render(): VegaRichTextLinkEditor;
+}