@heartlandone/vega 2.72.0 → 2.74.0-RTE-table-preview

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

@@ -0,0 +1,27 @@
+import { EventEmitter } from '../../../../../stencil-public-runtime';
+import { GlobalSlimmers } from 'vega-slimmer/core';
+import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../../../helpers/slimmers/component-usage-runtime-metrics';
+import { SelectionWidgetRenderer } from './slimmers/renderers/selection-widget-renderer';
+import { SelectionWidgetKeyboardController } from './slimmers/controllers/selection-widget-keyboard-controller';
+/**
+ * A selection widget for rich text table elements.
+ * This is an internal used component.
+ *
+ * @vegaVersion 2.74.0-RTE-table-preview
+ */
+export declare class VegaRichTextTableSelectionWidget {
+  protected readonly globalSlimmers: GlobalSlimmers;
+  protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaRichTextLinkEditorElement>;
+  protected readonly selectionWidgetRenderer: SelectionWidgetRenderer;
+  protected readonly keyboardController: SelectionWidgetKeyboardController;
+  host: HTMLVegaRichTextTableSelectionWidgetElement;
+  isSelected: boolean;
+  watchIsSelected(newValue: boolean): void;
+  /**
+   * An event emitter notifying a delete action on the widget.
+   *
+   * @vegaVersion 2.74.0-RTE-table-preview
+   */
+  vegaRemove: EventEmitter;
+  render(): VegaRichTextTableSelectionWidget;
+}

package/dist/types/components/vega-rich-text-editor/extensions/table/vega-rich-text-table-setting/assets/icon.d.ts

@@ -0,0 +1,2 @@
+import { IconPayload } from '../../../../../../helpers/icon/interface';
+export declare const Icons: Record<string, IconPayload>;

package/dist/types/components/vega-rich-text-editor/extensions/table/vega-rich-text-table-setting/slimmers/renderers/caption-button-slimmer.d.ts

@@ -0,0 +1,11 @@
+import { TableSettingButtonSlimmer } from './table-setting-button-slimmer.abstract';
+/**
+ * Slimmer dedicated to building the caption button.
+ */
+export declare class CaptionButtonSlimmer extends TableSettingButtonSlimmer {
+  constructor();
+  protected isSelected(): boolean;
+  protected isDisabled(): boolean;
+  protected handleClick(): void;
+  protected getTitle(): string;
+}

package/dist/types/components/vega-rich-text-editor/extensions/table/vega-rich-text-table-setting/slimmers/renderers/cell-properties-button-slimmer.d.ts

@@ -0,0 +1,11 @@
+import { TableSettingButtonSlimmer } from './table-setting-button-slimmer.abstract';
+/**
+ * Slimmer dedicated to building the merge cells button.
+ */
+export declare class CellPropertiesButtonSlimmer extends TableSettingButtonSlimmer {
+  constructor();
+  protected renderBtnWrapper(renderBtn: () => HTMLElement): HTMLElement;
+  protected isSelected(): boolean;
+  protected isDisabled(): boolean;
+  protected handleClick(): void;
+}

package/dist/types/components/vega-rich-text-editor/extensions/table/vega-rich-text-table-setting/slimmers/renderers/column-button-slimmer.d.ts

@@ -0,0 +1,28 @@
+import { TableSettingButtonSlimmer } from './table-setting-button-slimmer.abstract';
+import { VegaRichTextTableSetting } from '../../vega-rich-text-table-setting';
+/**
+ * Slimmer dedicated to building the column button.
+ */
+export declare class ColumnButtonSlimmer extends TableSettingButtonSlimmer {
+  isColumnDropdownOpen: VegaRichTextTableSetting['isColumnDropdownOpen'];
+  constructor();
+  protected renderBtnWrapper(renderBtn: () => HTMLElement): HTMLElement;
+  protected isSelected(): boolean;
+  protected isDisabled(): boolean;
+  protected handleClick(): void;
+  /**
+   * Render the action list.
+   *
+   * @returns {HTMLElement} The action list element.
+   */
+  private renderActionList;
+  private handleDropdownItemClick;
+  private handleDropdownVisibilityChange;
+  /**
+   * Determine if all columns are selected based on the selected cell range.
+   *
+   * @param selectedCellRange
+   * @returns {boolean} true if all columns are selected
+   */
+  private allColumnSelected;
+}

package/dist/types/components/vega-rich-text-editor/extensions/table/vega-rich-text-table-setting/slimmers/renderers/row-button-slimmer.d.ts

@@ -0,0 +1,36 @@
+import { TableSettingButtonSlimmer } from './table-setting-button-slimmer.abstract';
+/**
+ * Slimmer dedicated to building the row button.
+ */
+export declare class RowButtonSlimmer extends TableSettingButtonSlimmer {
+  constructor();
+  protected renderBtnWrapper(renderBtn: () => HTMLElement): HTMLElement;
+  protected isDisabled(): boolean;
+  protected isSelected(): boolean;
+  protected handleClick(): void;
+  /**
+   * Render the action list.
+   *
+   * @returns {HTMLElement} The action list element.
+   */
+  private renderActionList;
+  private handleDropdownItemClick;
+  /**
+   * Check if all selected rows are header rows.
+   *
+   * @returns {boolean} - true if all selected rows are header rows, false otherwise.
+   */
+  private areSelectedRowsHeaderRows;
+  /**
+   * Check if all rows are selected. Should disable some row operations if true.
+   *
+   * @returns {boolean} - true if all rows are selected, false otherwise.
+   */
+  private areAllRowsSelected;
+  /**
+   * Get all selected rows from selected cells.
+   *
+   * @returns {RTETableRowBlock[]} - Array of selected table row blocks.
+   */
+  private getSelectedRows;
+}

package/dist/types/components/vega-rich-text-editor/extensions/table/vega-rich-text-table-setting/slimmers/renderers/table-properties-button-slimmer.d.ts

@@ -0,0 +1,11 @@
+import { TableSettingButtonSlimmer } from './table-setting-button-slimmer.abstract';
+/**
+ * Slimmer dedicated to building the column button.
+ */
+export declare class TablePropertiesButtonSlimmer extends TableSettingButtonSlimmer {
+  constructor();
+  protected renderBtnWrapper(renderBtn: () => HTMLElement): HTMLElement;
+  protected isSelected(): boolean;
+  protected isDisabled(): boolean;
+  protected handleClick(): void;
+}

package/dist/types/components/vega-rich-text-editor/extensions/table/vega-rich-text-table-setting/slimmers/renderers/table-setting-button-slimmer.abstract.d.ts

@@ -0,0 +1,36 @@
+import { VegaSlimmer } from '../../../../../../../vega-slimmer/vega-slimmer-core';
+import { VegaRichTextTableSetting } from '../../vega-rich-text-table-setting';
+export declare type RTETableSettingButtonProps = {
+  icon: string;
+  title: string;
+  showArrowIcon?: boolean;
+};
+export declare abstract class TableSettingButtonSlimmer extends VegaSlimmer {
+  protected hasCaption: VegaRichTextTableSetting['hasCaption'];
+  protected vegaClick: VegaRichTextTableSetting['vegaClick'];
+  protected selectedCells: VegaRichTextTableSetting['selectedCells'];
+  protected readonly icon: RTETableSettingButtonProps['icon'];
+  private readonly title;
+  private readonly showArrowIcon;
+  protected constructor({ icon, title, showArrowIcon }: RTETableSettingButtonProps);
+  render(): HTMLElement;
+  protected emitClickEvent(setting: Array<string>): void;
+  /**
+   * Prevent the default behavior to keep the cursor position.
+   *
+   * @param {Event} e - The event object.
+   */
+  protected preventDefaultEvent(e: Event): void;
+  /**
+   * The wrapper for the button.
+   *
+   * @returns {HTMLElement} - The button wrapper.
+   */
+  protected renderBtnWrapper?(renderBtn: () => HTMLElement): HTMLElement;
+  protected getTitle(): string;
+  private renderBtn;
+  private getIconColor;
+  protected abstract isSelected(): boolean;
+  protected abstract isDisabled(): boolean;
+  protected abstract handleClick(e?: MouseEvent): void;
+}

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

@@ -0,0 +1,11 @@
+import { VegaSlimmer } from '../../../../../../../vega-slimmer/vega-slimmer-core';
+import { VegaRichTextTableSetting } from '../../vega-rich-text-table-setting';
+export declare class VegaRichTextTableSettingRenderer extends VegaSlimmer {
+  captionButtonSlimmer: VegaRichTextTableSetting['captionButtonSlimmer'];
+  columnButtonSlimmer: VegaRichTextTableSetting['columnButtonSlimmer'];
+  rowButtonSlimmer: VegaRichTextTableSetting['rowButtonSlimmer'];
+  tablePropertiesButtonSlimmer: VegaRichTextTableSetting['tablePropertiesButtonSlimmer'];
+  cellPropertiesButtonSlimmer: VegaRichTextTableSetting['cellPropertiesButtonSlimmer'];
+  render(): HTMLElement;
+  private renderButton;
+}

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

@@ -0,0 +1,55 @@
+import { EventEmitter } from '../../../../../stencil-public-runtime';
+import { GlobalSlimmers } from 'vega-slimmer/core';
+import { TranslationSlimmer } from '../../../../../helpers/slimmers/translation';
+import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../../../helpers/slimmers/component-usage-runtime-metrics';
+import { VegaRichTextTableSettingRenderer } from './slimmers/renderers/vega-rich-text-table-setting-renderer';
+import { CaptionButtonSlimmer } from './slimmers/renderers/caption-button-slimmer';
+import { ColumnButtonSlimmer } from './slimmers/renderers/column-button-slimmer';
+import { TablePropertiesButtonSlimmer } from './slimmers/renderers/table-properties-button-slimmer';
+import { RowButtonSlimmer } from './slimmers/renderers/row-button-slimmer';
+import { RTETableCellBlock } from '../dto/table-cell-block';
+import { CellPropertiesButtonSlimmer } from './slimmers/renderers/cell-properties-button-slimmer';
+/**
+ * Table setting popover renderer for managing table operations.
+ *
+ * @vegaVersion 2.74.0-RTE-table-preview
+ */
+export declare class VegaRichTextTableSetting {
+  protected readonly globalSlimmers: GlobalSlimmers;
+  protected translationSlimmer: TranslationSlimmer<HTMLVegaRichTextTableSettingElement>;
+  protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaRichTextTableSettingElement>;
+  protected readonly renderer: VegaRichTextTableSettingRenderer;
+  protected readonly captionButtonSlimmer: CaptionButtonSlimmer;
+  protected readonly columnButtonSlimmer: ColumnButtonSlimmer;
+  protected readonly tablePropertiesButtonSlimmer: TablePropertiesButtonSlimmer;
+  protected readonly rowButtonSlimmer: RowButtonSlimmer;
+  protected readonly cellPropertiesButtonSlimmer: CellPropertiesButtonSlimmer;
+  host: HTMLVegaRichTextTableSettingElement;
+  isColumnDropdownOpen: boolean;
+  /**
+   * Indicates whether the current table already has a caption.
+   *
+   * @vegaVersion 2.74.0-RTE-table-preview
+   */
+  hasCaption?: boolean;
+  /**
+   * The selected cells in the table.
+   *
+   * @vegaVersion 2.74.0-RTE-table-preview
+   */
+  selectedCells: RTETableCellBlock[];
+  /**
+   * Specifies the target table element for the table setting.
+   *
+   * @vegaVersion 2.74.0-RTE-table-preview
+   */
+  target: HTMLElement;
+  /**
+   * @vegaVersion 2.74.0-RTE-table-preview
+   */
+  vegaClick: EventEmitter<Array<string>>;
+  connectedCallback(): void;
+  disconnectedCallback(): void;
+  render(): VegaRichTextTableSetting;
+  private registerTableCellSelectionChangeObserver;
+}

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

@@ -16,7 +16,7 @@ import { VNode } from '../../stencil-public-runtime';
 import * as VegaComponents from '../../components';
 import { RTEHtmlBlock } from './dto/blocks/html-block';
 import { InlineHtmlAnnotation } from './dto/annotations/inline-html-annotation';
-import type { RTERange } from './dto/range';
+import { RTERange, RTERangeOptions } from './dto/range';
 import type { RTENode } from './dto/nodes/node.abstract';
 import type { VegaRTEContent } from './dto/content-state';
 
@@ -31,6 +31,8 @@ export type ToolbarButtonConfig = {
 
 export type AnnotationStyle = Record<string, string>;
 
+export type TableCellStylePropertiesMap = Record<string, RTETablePropertiesType>;
+
 export type VegaRTETextStyleType =
 	| 'title'
 	| 'subtitle'
@@ -274,7 +276,12 @@ export type VegaRTETokenNode = VegaRTETextNode & {
 	token: string;
 };
 
-export type VegaRTERenderResult = VNode;
+export type VegaRTERenderResult = VNode & {
+	/**
+	 * A function that returns a VNode representing the container for child elements.
+	 */
+	childrenContainerGetter?: () => VNode;
+};
 
 export type VegaRTECustomElementAction = {
 	type: 'selected' | 'unSelected' | 'delete' | 'insertText';
@@ -336,6 +343,19 @@ export type RTEExtensionContext = {
 	 * @returns {RTENode[]} - An array of currently selected RTENode objects.
 	 */
 	getSelectedNodes: () => RTENode[];
+	/**
+	 * Set the currently selected nodes in the editor.
+	 *
+	 * @param {RTENode[]} nodes - An array of RTENode objects to set as selected.
+	 * @param {RTERangeOptions} [rangeOptions] - Optional range options to define the selection range.
+	 */
+	setSelectedNodes: (nodes: RTENode[], rangeOptions?: RTERangeOptions) => void;
+	/**
+	 * Get the current selection object.
+	 *
+	 * @returns {Selection} - The current Selection object.
+	 */
+	getSelection: () => Selection;
 	/**
 	 * Flush the editor value to the host. Auto focus the last node if autoFocusLastNode is true.
 	 * Sometimes, the editor will lose focus after change the editor value, so we need to focus the last node again.
@@ -382,3 +402,20 @@ export type RTELanguageExtensionState = {
 	selectedLanguage: string;
 	contentMap: RTELanguageContentMap;
 };
+
+export type RTETablePropertiesType = {
+	width?: string;
+	height?: string;
+	borderStyle?: string;
+	borderColor?: string;
+	borderWidth?: string;
+	textAlign?: 'left' | 'center' | 'right' | 'justify';
+	backgroundColor?: string;
+	verticalAlign?: 'top' | 'middle' | 'bottom';
+	padding?: string;
+};
+
+export type RTETableColorSchema = {
+	dark: string;
+	light: string;
+};

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

@@ -15,6 +15,7 @@ export { VegaRTETokenExtension } from './extensions/tokens/token-extension';
 export { RTELanguageToolbarButtonRenderer } from './extensions/languages/language-toolbar-button-renderer';
 export { VegaRTELanguageExtension } from './extensions/languages/language-extension';
 export { VegaRTEFunctionExtension } from './extensions/functions/function-extension';
+export { VegaRTETableExtension } from './extensions/table/table-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';

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

@@ -15,6 +15,10 @@ export declare class RTEExtensionController extends VegaSlimmer {
    * This method is called when the component is connected and whenever the extensions property changes.
    */
   protected initialExtensionContext(): void;
+  /**
+   * Destroys all registered extensions.
+   */
+  protected destroyExtension(): void;
   /**
    * Update extension context when extensions property changes.
    *

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/helper/element-to-dto-strategy/annotation-handler/html-element-to-annotation-generator.d.ts

@@ -1,3 +1,4 @@
+import { AnnotationGeneratorStrategyAbstract } from './annotation-generator-strategy.abstract';
 import { VegaRTEAnnotations, VegaRTETextAnnotations, VegaRTETransformOptions } from '../../../../../interface';
 import { RTEBlock } from '../../../../../dto/blocks/block.abstract';
 import { RTENode } from '../../../../../dto/nodes/node.abstract';
@@ -9,6 +10,14 @@ export declare type HtmlElementToAnnotationGenerateOptions = {
 /** Html element to annotations generator */
 declare class HtmlElementToAnnotationGenerator {
   private handlers;
+  /**
+   * Register a custom annotation handler.
+   * Custom handlers are added to the beginning of the handlers array,
+   * giving them higher priority than default handlers.
+   *
+   * @param {AnnotationGeneratorStrategyAbstract} handler - The annotation handler to register.
+   */
+  registerHandler(handler: AnnotationGeneratorStrategyAbstract): void;
   /**
    * The function generates annotations for a given target DTO and HTML element based on a set of
    * strategies.

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

@@ -1,7 +1,7 @@
 import { VegaRichTextEditor } from '../../vega-rich-text-editor';
 import { RTEBlock } from '../../dto/blocks/block.abstract';
 import { RTENode } from '../../dto/nodes/node.abstract';
-import { RTERange } from '../../dto/range';
+import { RTERange, RTERangeOptions } from '../../dto/range';
 import { RTESelectionState } from '../../dto/selection-state';
 import { AutoRunWhenReRenderTaskQueueSlimmer } from '../../../../helpers/slimmers/auto-run-when-re-render-task-queue-slimmer.abstract';
 declare type SelectionStateType = {
@@ -59,6 +59,13 @@ export declare class SelectionController extends AutoRunWhenReRenderTaskQueueSli
    * @returns {RTENode[]} Selected rich text nodes
    */
   getSelectedNodes(): RTENode[];
+  /**
+   * Set the selected rich text nodes
+   *
+   * @param {RTENode[]} nodes - The rich text nodes to set as selected
+   * @param {RTERangeOptions} [rangeOptions] - The range options to set the selection range
+   */
+  setSelectedNodes(nodes: RTENode[], rangeOptions?: RTERangeOptions): void;
   /**
    * Get the selected rich text blocks
    *
@@ -87,16 +94,16 @@ export declare class SelectionController extends AutoRunWhenReRenderTaskQueueSli
    * @param {Range} range - The range to set
    */
   setSelectionRange(range: Range): void;
-  /**
-   * The method invoke after the component re-render.
-   */
-  protected doTask: () => Promise<void>;
   /**
    * Get the rich text content selected range
    *
    * @returns {Selection} A [Selection](https://developer.mozilla.org/en-US/docs/Web/API/Selection) object
    */
-  protected getSelection(): Selection;
+  getSelection(): Selection;
+  /**
+   * The method invoke after the component re-render.
+   */
+  protected doTask: () => Promise<void>;
   /**
    * Save the current selection range detail
    */
@@ -109,6 +116,12 @@ export declare class SelectionController extends AutoRunWhenReRenderTaskQueueSli
    * Get selected rich text
    */
   private handleSelectionChange;
+  /**
+   * Add nodes to the selection map
+   *
+   * @param {RTENode[]} nodes - The rich text nodes to add
+   */
+  private addNodesToSelectionMap;
   /**
    * Clear the selection map.
    * The code node don't need clear here, because the code node will manager the selection state itself. `code-node-renderer.tsx#handleSelectionChange`

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

@@ -12,6 +12,7 @@ export declare class ValueController extends VegaSlimmer {
   valueController: VegaRichTextEditor['valueController'];
   historyController: VegaRichTextEditor['historyController'];
   selectionController: VegaRichTextEditor['selectionController'];
+  sourceEditConfig: VegaRichTextEditor['sourceEditConfig'];
   private flushChangeObserver;
   /**
    * Component lifecycle - [connectedCallback]{@link VegaRichTextEditor.connectedCallback}

package/dist/types/components/vega-rich-text-editor/slimmers/renderers/tools/source-edit-toolbar-button-slimmer.d.ts

@@ -6,6 +6,7 @@ export declare class SourceEditToolbarButtonSlimmer extends ToolbarButtonSlimmer
   valueController: VegaRichTextEditor['valueController'];
   vegaRichTextEditorRenderer: VegaRichTextEditor['vegaRichTextEditorRenderer'];
   sourceEditConfig: VegaRichTextEditor['sourceEditConfig'];
+  value: VegaRichTextEditor['value'];
   constructor();
   protected onClick(): Promise<void>;
   protected isSelected(): boolean;

package/dist/types/components/vega-rich-text-editor/test/extensions/table/annotation-handler/annotation-handler-registration.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/components/vega-rich-text-editor/test/extensions/table/annotation-handler/table-annotation-handler.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/components/vega-rich-text-editor/test/extensions/table/annotation-handler/table-cell-annotation-handler.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/components/vega-rich-text-editor/test/extensions/table/annotation-handler/table-head-cell-annotation-handler.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/components/vega-rich-text-editor/test/extensions/table/caption-operation.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

package/dist/types/components/vega-rich-text-editor/test/extensions/table/table-caption-annotations.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/components/vega-rich-text-editor/test/extensions/table/table-cell-annotation.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+import '../../../dto/setup';

package/dist/types/components/vega-rich-text-editor/test/extensions/table/table-element-to-dto-strategies.test.d.ts

@@ -0,0 +1 @@
+import '../../../../../polyfill/test-polyfill/unit/index';

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

@@ -0,0 +1,11 @@
+import { VegaRTETableBlock } from '../../../extensions/table/dto/table-block';
+/**
+ * Generate mock table data for testing purposes.
+ *
+ * @param {{ withHeader?: boolean }} options - Options for generating the table data.
+ * @param {boolean} options.withHeader - Whether to include a table header.
+ * @returns {VegaRTETableBlock} The generated mock table block data.
+ */
+export declare const mockRTETableData: ({ withHeader }?: {
+  withHeader?: boolean;
+}) => VegaRTETableBlock;

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

@@ -5,11 +5,15 @@ import { SpecPage } from '@stencil/core/testing';
  * @param {SpecPage} page - The SpecPage instance.
  * @param {{ textEl: HTMLElement; startOffset: number; endOffset: number }} options - Options for text selection.
  * @param {HTMLElement} options.textEl - The text element to select within.
+ * @param {HTMLElement} [options.endContainer] - The end container element of the selection.
+ * @param {HTMLElement} [options.commonAncestorContainer] - The common ancestor container of the selection.
  * @param {number} options.startOffset - The start offset of the selection.
  * @param {number} options.endOffset - The end offset of the selection.
  */
 export declare const mockTextSelection: (page: SpecPage, options: {
   textEl: HTMLElement;
+  endContainer?: HTMLElement;
+  commonAncestorContainer?: HTMLElement;
   startOffset: number;
   endOffset: number;
 }) => Promise<void>;