@heartlandone/vega 2.49.1 → 2.50.0-RTE-preview

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

@@ -3,14 +3,23 @@ import { JSXBase } from '../../stencil-public-runtime';
 import { RTEImageBlock } from './dto/blocks/image-block';
 import { RTEListItemBlock } from './dto/blocks/list-item-block';
 import { RTEListBlock } from './dto/blocks/list-block';
+import { BlockAnnotation, BlockAnnotationTypeEnum } from './dto/annotations/block-annotation.abstract';
 import { NodeAnnotation, NodeAnnotationTypeEnum } from './dto/annotations/node-annotation.abstract';
 import { InternalAnnotationTypeEnum } from './dto/annotations/annotation.abstract';
+import { CommonAnnotation, CommonAnnotationTypeEnum } from './dto/annotations/common-annotation.abstract';
 import { SelectionRangeAnnotation } from './dto/annotations/selection-range-annotation';
 import { VegaRichTextImageEditorSizeType } from './vega-rich-text-image-editor/types';
+import { RTECodeBlock } from './dto/blocks/code-block';
+import { VegaCodeBlockValue } from '../vega-code-block/types';
+import { LinkGroupAnnotation } from './dto/annotations/link-group-annotation';
 
 export type ToolbarButtonConfig = {
 	icon: string;
 	tooltip: Partial<Pick<HTMLVegaTooltipElement, 'text'>>;
+	/**
+	 * Whether to focus the content when clicked
+	 */
+	autoFocusOnClick?: boolean;
 };
 
 export type AnnotationStyle = JSXBase.HTMLAttributes['style'];
@@ -40,18 +49,28 @@ export type VegaRTETextBlockType =
 
 export type VegaRTEListBlockType = 'bullet-list' | 'number-list';
 
-export type RTEBlockType = VegaRTETextBlockType | VegaRTEListBlockType | 'image';
+export type RTEBlockType = VegaRTETextBlockType | VegaRTEListBlockType | 'image' | 'code-block';
 
-export type RTEContentBlock = RTETextBlock | RTEImageBlock | RTEListBlock | RTEListItemBlock;
+export type RTEContentBlock = RTETextBlock | RTEImageBlock | RTEListBlock | RTEListItemBlock | RTECodeBlock;
 
 export type VegaRTEBlockAnnotations = {
 	textAlign?: VegaRTEBlockAlignment;
 	indent?: number;
+	customAttribute?: Record<string, string>;
+	customClass?: string[];
+	customStyle?: AnnotationStyle;
 };
 
 export type ListType = 'bullet-list' | 'number-list';
 
-export type VegaRTELink = { href: string; groupKey: string };
+//TODO: href should include to customAttribute.
+export type VegaRTELink = {
+	href: string;
+	groupKey: string;
+	customAttribute?: Record<string, string>;
+	customClass?: string[];
+	customStyle?: AnnotationStyle;
+};
 
 export type VegaRTETextAnnotations = {
 	bold?: boolean;
@@ -60,22 +79,18 @@ export type VegaRTETextAnnotations = {
 	strikethrough?: boolean;
 	textColor?: string;
 	link?: VegaRTELink;
-	code?: never;
+	code?: boolean;
+	customAttribute?: Record<string, string>;
+	customClass?: string[];
+	customStyle?: AnnotationStyle;
 };
 
 export type VegaRTEImageAnnotations = {
 	size?: VegaRichTextImageEditorSizeType;
 	alt?: string;
-};
-
-export type VegaRTECodeAnnotations = {
-	code: boolean;
-	bold?: never;
-	italic?: never;
-	underline?: never;
-	strikethrough?: never;
-	color?: never;
-	link?: never;
+	customAttribute?: Record<string, string>;
+	customClass?: string[];
+	customStyle?: AnnotationStyle;
 };
 
 export type VegaRTEBaseNode = { id: string; type: 'text' | 'image' };
@@ -86,13 +101,7 @@ export type VegaRTEText = {
 	annotations?: VegaRTETextAnnotations;
 };
 
-export type VegaRTECode = {
-	type: 'text';
-	text: string;
-	annotations?: VegaRTECodeAnnotations;
-};
-
-export type VegaRTETextNode = VegaRTEBaseNode & (VegaRTEText | VegaRTECode);
+export type VegaRTETextNode = VegaRTEBaseNode & VegaRTEText;
 
 export type VegaRTEImageNode = {
 	id: string;
@@ -133,11 +142,18 @@ export type VegaRTEListBlock = VegaRTEBlockBase & {
 	blocks: VegaRTEListItemBlock[];
 };
 
+export type VegaRTECodeBlock = VegaRTEBlockBase & {
+	type: 'code-block';
+	content: string;
+	language?: VegaCodeBlockValue['language'];
+};
+
 export type VegaRTEContentBlock =
 	| VegaRTETextBlock
 	| VegaRTEImageBlock
 	| VegaRTEListBlock
-	| VegaRTEListItemBlock;
+	| VegaRTEListItemBlock
+	| VegaRTECodeBlock;
 
 export type VegaRTEToolbarItem =
 	| 'clearStyle'
@@ -159,7 +175,9 @@ export type VegaRTEToolbarItem =
 	| 'leftAlign'
 	| 'centerAlign'
 	| 'rightAlign'
-	| 'justified';
+	| 'justified'
+	| 'codeBlock'
+	| 'sourceEdit';
 
 export type VegaRTEColorSchema = {
 	key: string;
@@ -167,14 +185,35 @@ export type VegaRTEColorSchema = {
 	dark: string;
 };
 
+export type RTEBlockAnnotationMapKey =
+	| keyof typeof BlockAnnotationTypeEnum
+	| InternalAnnotationTypeEnum.LINK_GROUP
+	| keyof typeof CommonAnnotationTypeEnum;
+
+export type RTEBlockAnnotationMapValue = BlockAnnotation | LinkGroupAnnotation | CommonAnnotation;
+
 export type RTENodeAnnotationMapKey =
 	| keyof typeof NodeAnnotationTypeEnum
-	| keyof typeof InternalAnnotationTypeEnum;
+	| keyof typeof InternalAnnotationTypeEnum
+	| keyof typeof CommonAnnotationTypeEnum;
 
-export type RTENodeAnnotationMapValue = NodeAnnotation | SelectionRangeAnnotation;
+export type RTENodeAnnotationMapValue = NodeAnnotation | SelectionRangeAnnotation | CommonAnnotation;
 
 export type VegaRichTextEditorImage = { file: File; sendBackUploadedURLCallback: (url: string) => void };
 
-export type RTERenderContext = { editable?: boolean };
+export type RTERenderContext = {
+	editable?: boolean;
+	/**
+	 * If `true`, render using inline styles for standalone web pages.
+	 * If `false`, use CSS classes for integration within the RTE content view.
+	 */
+	standalone?: boolean;
+};
 
 export type HeadingLevel = 1 | 2 | 3;
+
+export type RTERenderCustomAttributes = {
+	filterAttributes?: string[];
+};
+
+type RTEBlockWithNodes = RTETextBlock | RTEImageBlock | RTECodeBlock;

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/helper/element-to-dto-strategy/block-to-rte-block-strategy.abstract.d.ts

@@ -1,4 +1,4 @@
-import { VegaRTEBlockAnnotations, VegaRTECodeAnnotations, VegaRTETextAnnotations, VegaRTETextNode } from '../../../../interface';
+import { AnnotationStyle, VegaRTEBlockAnnotations, VegaRTETextAnnotations, VegaRTETextNode } from '../../../../interface';
 import { ElementToDTOStrategy } from './element-to-dto-strategy.abstract';
 /** Abstract class for block html element to RTE block dto */
 export declare abstract class BlockToRTEBlockStrategyAbstract extends ElementToDTOStrategy {
@@ -20,10 +20,10 @@ export declare abstract class BlockToRTEBlockStrategyAbstract extends ElementToD
    *   </li>
    *
    * @param {HTMLElement[]} elements - Child elements.
-   * @param {VegaRTETextAnnotations | VegaRTECodeAnnotations} annotations - Parent annotations.
+   * @param {VegaRTETextAnnotations} annotations - Parent annotations.
    * @returns {VegaRTETextNode[]} - Text node DTO.
    */
-  protected generateChildNodes(elements: HTMLElement[], annotations?: VegaRTETextAnnotations | VegaRTECodeAnnotations): VegaRTETextNode[];
+  protected generateChildNodes(elements: HTMLElement[], annotations?: VegaRTETextAnnotations): VegaRTETextNode[];
   /**
    * Generate annotations map for block element.
    *
@@ -31,14 +31,65 @@ export declare abstract class BlockToRTEBlockStrategyAbstract extends ElementToD
    * @returns {VegaRTEBlockAnnotations} - Text block annotations.
    */
   protected generateBlockAnnotations(element: HTMLElement): VegaRTEBlockAnnotations;
+  /**
+   * Obtain the custom attributes of element, excluding 'style' and 'class'.
+   *
+   * @param {HTMLElement} element - current element.
+   * @param {string[]} attributes - the custom attributes of current element.
+   * @returns {Record<string, string>} - Record<string, string>.
+   */
+  protected generateCustomAttrAnnotations(element: HTMLElement, attributes: string[]): Record<string, string>;
+  /**
+   * Obtain and format the style of element.
+   *
+   * @param {HTMLElement} element - current element.
+   * @returns {AnnotationStyle} - Record<string, string>.
+   */
+  protected generateCustomStyleAnnotations(element: HTMLElement): AnnotationStyle;
+  /**
+   * Inherit annotation from block should not include custom annotation.
+   *
+   * @param {HTMLElement} element - current element.
+   * @returns {VegaRTETextAnnotations} - Inherit node annotations.
+   */
+  protected generateBlockInheritAnnotations(element: HTMLElement): VegaRTETextAnnotations;
+  /**
+   * Generate custom attribute, custom class and custom style annotation.
+   *
+   * @param {HTMLElement} element - current element.
+   * @param {VegaRTEBlockAnnotations} annotations - current element.
+   * @returns {VegaRTETextAnnotations} - Inherit node annotations.
+   */
+  protected generateCommonAnnotations(element: HTMLElement, annotations?: VegaRTEBlockAnnotations): VegaRTETextAnnotations;
+  /**
+   * Inherit and generate text node annotations.
+   *
+   * @param {HTMLElement} element - current element.
+   * @param {VegaRTETextAnnotations} parentAnnotations - parent annotations
+   * @returns {VegaRTETextAnnotations} - Inherit node annotations.
+   */
+  private inheritAndGenerateTextNodeAnnotations;
   /**
    * Generate annotations map for text node element.
    *
    * @param {HTMLElement} element - current element.
-   * @param {VegaRTETextAnnotations | VegaRTECodeAnnotations} parentAnnotations - parent annotations
-   * @returns {VegaRTETextAnnotations | VegaRTECodeAnnotations} - Text node annotations.
+   * @returns {VegaRTETextAnnotations} - Text node annotations.
    */
-  protected generateTextNodeAnnotations(element: HTMLElement, parentAnnotations?: VegaRTETextAnnotations | VegaRTECodeAnnotations): VegaRTETextAnnotations | VegaRTECodeAnnotations;
+  private generateTextNodeAnnotations;
+  /**
+   * Filter out custom annotations.
+   *
+   * @param {VegaRTETextAnnotations} annotations - Annotations.
+   * @returns {VegaRTETextAnnotations} - Filtered annotations.
+   */
+  private filterOutCustomAnnotation;
+  /**
+   * Get the custom class
+   *
+   * @param {HTMLElement} element - current element.
+   * @returns {string[]} - the class after .
+   */
+  private getCustomClass;
   /**
    * Check is a invalid text node.
    *
@@ -109,4 +160,11 @@ export declare abstract class BlockToRTEBlockStrategyAbstract extends ElementToD
    * @returns {Nullable<number>} - Indent.
    */
   private getIndent;
+  /**
+   * Get custom attribute of current element, excluding 'style' and 'class'.
+   *
+   * @param {HTMLElement} element - current element.
+   * @returns {string[]} - Text align.
+   */
+  private getCustomAttributeName;
 }

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

@@ -1,6 +1,6 @@
 import { ElementToDTOStrategyOutput } from './element-to-dto-strategy.abstract';
 /** Element to DTO processor */
-export declare class ElementToDtoStrategyProcessor {
+declare class ElementToDtoStrategyProcessor {
   private elementStrategies;
   /**
    * Transform process.
@@ -17,3 +17,5 @@ export declare class ElementToDtoStrategyProcessor {
    */
   private isInvalidElement;
 }
+declare const _default: ElementToDtoStrategyProcessor;
+export default _default;

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/helper/element-to-dto-strategy/element-to-rte-image-block-strategy.abstract.d.ts

@@ -0,0 +1,20 @@
+import { RTEImageBlock } from '../../../../dto/blocks/image-block';
+import { VegaRichTextImageEditorSizeType } from '../../../../vega-rich-text-image-editor/types';
+import { BlockToRTEBlockStrategyAbstract } from './block-to-rte-block-strategy.abstract';
+/** Abstract class for block html element to RTE block dto */
+export declare abstract class ElementToRTEImageBlockStrategyAbstract extends BlockToRTEBlockStrategyAbstract {
+  /**
+   * Determine the image display size based on the width of the current element.
+   *
+   * @param {HTMLElement} element - current element.
+   * @returns {VegaRichTextImageEditorSizeType} -Image size, default 'md'.
+   */
+  protected getImageSize(element: HTMLElement): VegaRichTextImageEditorSizeType;
+  /**
+   * Create a RTE Image block according to the img element.
+   *
+   * @param {HTMLElement} element - current element.
+   * @returns {RTEImageBlock} -RTE Image block.
+   */
+  protected createRTEImageBlock(element: HTMLImageElement): RTEImageBlock;
+}

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/helper/element-to-dto-strategy/img-to-rte-image-block-strategy.d.ts

@@ -1,8 +1,8 @@
 import { RTEContentBlock } from '../../../../interface';
 import { Nullable } from '../../../../../../types/general';
-import { BlockToRTEBlockStrategyAbstract } from './block-to-rte-block-strategy.abstract';
+import { ElementToRTEImageBlockStrategyAbstract } from './element-to-rte-image-block-strategy.abstract';
 /** Transform img element to image block DTO */
-export declare class ImgToRTEImageBlockStrategy extends BlockToRTEBlockStrategyAbstract {
+export declare class ImgToRTEImageBlockStrategy extends ElementToRTEImageBlockStrategyAbstract {
   /**
    * Can be handle.
    *

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/helper/element-to-dto-strategy/inline-block-to-rte-text-block-strategy.d.ts

@@ -29,10 +29,39 @@ export declare class InlineBlockToRTETextBlockStrategy extends BlockToRTEBlockSt
    */
   shouldProceedToElementChildren(): boolean;
   /**
-   * Get node type of element.
+   * Get the node type of element. The element type is determined in the following
+   * order: "data-type" attribute, node name, font size and class name.
    *
    * @param {HTMLElement} element - element.
    * @returns {string} - node type.
    */
   private getElementType;
+  /**
+   * Get the element type by data-type attribute.
+   *
+   * @param {HTMLElement} element - element.
+   * @returns {Nullable<string>} - element type or null if not found.
+   */
+  private getElementTypeByDataType;
+  /**
+   * Get the element type by font size.
+   *
+   * @param {HTMLElement} element - element.
+   * @returns {Nullable<string>} - element type or null if not found.
+   */
+  private getElementTypeByFontSize;
+  /**
+   * Get the element type by node name.
+   *
+   * @param {HTMLElement} element - element.
+   * @returns {Nullable<string>} - element type or null if not found.
+   */
+  private getElementTypeByNodeName;
+  /**
+   * Get the element type by class name.
+   *
+   * @param {HTMLElement} element - element.
+   * @returns {Nullable<string>} - element type or null if not found.
+   */
+  private getElementTypeByClassName;
 }

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/helper/element-to-dto-strategy/jira-code-to-rte-code-block-strategy.d.ts

@@ -0,0 +1,31 @@
+import { Nullable } from '../../../../../../types/general';
+import { BlockToRTEBlockStrategyAbstract } from './block-to-rte-block-strategy.abstract';
+import { RTECodeBlock } from '../../../../dto/blocks/code-block';
+/** Transform other editor code element which has attribute data-language to RTE code block DTO */
+export declare class JiraCodeToRTECodeBlockStrategy extends BlockToRTEBlockStrategyAbstract {
+  /**
+   * Can be handle.
+   *
+   * @param {HTMLElement[]} elementsArray - Current elements.
+   * @param {number} currentIndex - Current element index.
+   * @returns {number} - can be handled element count.
+   */
+  canHandle(elementsArray: HTMLElement[], currentIndex: number): number;
+  /**
+   * Parse to a code block.
+   *
+   * @param {HTMLElement[]} elementsArray - Current elements.
+   * @returns {Nullable<RTECodeBlock>} - Code block.
+   */
+  handle(elementsArray: HTMLElement[]): Nullable<RTECodeBlock>;
+  /**
+   * Append child blocks.
+   */
+  appendChildBlocks(): void;
+  /**
+   * Should continue process to child elements.
+   *
+   * @returns {boolean} - boolean.
+   */
+  shouldProceedToElementChildren(): boolean;
+}

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/helper/element-to-dto-strategy/ol-to-rte-list-block-strategy.d.ts

@@ -1,7 +1,6 @@
 import { RTEListBlock } from '../../../../dto/blocks/list-block';
 import { RTEContentBlock } from '../../../../interface';
 import { Nullable } from '../../../../../../types/general';
-import { RTEListItemBlock } from '../../../../dto/blocks/list-item-block';
 import { BlockToRTEBlockStrategyAbstract } from './block-to-rte-block-strategy.abstract';
 /** Transform ol element to list block DTO */
 export declare class OlToRTEListBlockStrategy extends BlockToRTEBlockStrategyAbstract {
@@ -24,9 +23,9 @@ export declare class OlToRTEListBlockStrategy extends BlockToRTEBlockStrategyAbs
    * Append child list item blocks to current list block.
    *
    * @param {RTEListBlock} currentBlock - Current list block.
-   * @param {RTEListItemBlock[]} childBlocks - Current list item blocks.
+   * @param {RTEContentBlock[]} childBlocks - Current list item blocks.
    */
-  appendChildBlocks(currentBlock: RTEListBlock, childBlocks: RTEListItemBlock[]): void;
+  appendChildBlocks(currentBlock: RTEListBlock, childBlocks: RTEContentBlock[]): void;
   /**
    * Should continue process to child elements.
    *

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/helper/element-to-dto-strategy/span-img-to-rte-image-block-strategy.d.ts

@@ -1,8 +1,8 @@
 import { RTEContentBlock } from '../../../../interface';
 import { Nullable } from '../../../../../../types/general';
-import { BlockToRTEBlockStrategyAbstract } from './block-to-rte-block-strategy.abstract';
+import { ElementToRTEImageBlockStrategyAbstract } from './element-to-rte-image-block-strategy.abstract';
 /** Transform img in span or other inline element to image block DTO */
-export declare class SpanImageToRTEImageBlockStrategy extends BlockToRTEBlockStrategyAbstract {
+export declare class SpanImageToRTEImageBlockStrategy extends ElementToRTEImageBlockStrategyAbstract {
   /**
    * Can be handle.
    *

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/helper/element-to-dto-strategy/ul-to-rte-list-block-strategy.d.ts

@@ -1,7 +1,6 @@
 import { RTEListBlock } from '../../../../dto/blocks/list-block';
 import { RTEContentBlock } from '../../../../interface';
 import { Nullable } from '../../../../../../types/general';
-import { RTEListItemBlock } from '../../../../dto/blocks/list-item-block';
 import { BlockToRTEBlockStrategyAbstract } from './block-to-rte-block-strategy.abstract';
 /** Transform ul element to list block DTO */
 export declare class UlToRTEListBlockStrategy extends BlockToRTEBlockStrategyAbstract {
@@ -24,9 +23,9 @@ export declare class UlToRTEListBlockStrategy extends BlockToRTEBlockStrategyAbs
    * Append child list item blocks to current list block.
    *
    * @param {RTEListBlock} currentBlock - Current list block.
-   * @param {RTEListItemBlock[]} childBlocks - Current list item blocks.
+   * @param {RTEContentBlock[]} childBlocks - Current list item blocks.
    */
-  appendChildBlocks(currentBlock: RTEListBlock, childBlocks: RTEListItemBlock[]): void;
+  appendChildBlocks(currentBlock: RTEListBlock, childBlocks: RTEContentBlock[]): void;
   /**
    * Should continue process to child elements.
    *

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/helper/element-to-dto-strategy/vega-code-block-to-rte-code-block-strategy.d.ts

@@ -0,0 +1,42 @@
+import { Nullable } from '../../../../../../types/general';
+import { JiraCodeToRTECodeBlockStrategy } from './jira-code-to-rte-code-block-strategy';
+import { RTECodeBlock } from '../../../../dto/blocks/code-block';
+/** Transform vega-code-block element to code block DTO */
+export declare class VegaCodeBlockToRTECodeBlockStrategy extends JiraCodeToRTECodeBlockStrategy {
+  /**
+   * Can be handle.
+   *
+   * TODO: Update the browser clipboard data to fix the issue with nested vega-code-block elements.
+   * In safari the html snippet will be like: <vega-code-block><p><span>paragraph</span></p><vega-code-block></vega-code-block></vega-code-block>
+   * The vega-code-block nested inside the vega-code-block, so we need to check the child element.
+   *
+   * @param {HTMLElement[]} elementsArray - Current elements.
+   * @param {number} currentIndex - Current element index.
+   * @returns {number} - can be handled element count.
+   */
+  canHandle(elementsArray: HTMLElement[], currentIndex: number): number;
+  /**
+   * Parse to a code block.
+   *
+   * @param {HTMLElement[]} elementsArray - Current elements.
+   * @returns {Nullable<RTECodeBlock>} - Code block.
+   */
+  handle(elementsArray: HTMLElement[]): Nullable<RTECodeBlock>;
+  /**
+   * Append child blocks.
+   */
+  appendChildBlocks(): void;
+  /**
+   * Should continue process to child elements.
+   *
+   * @returns {boolean} - boolean.
+   */
+  shouldProceedToElementChildren(): boolean;
+  /**
+   * Checks if the given element is a code block container.
+   *
+   * @param {HTMLElement} element - The element to check.
+   * @returns {boolean} - Boolean result.
+   */
+  private isCodeBlockContainer;
+}

package/dist/types/components/vega-rich-text-editor/slimmers/controllers/helper/element-to-dto-strategy/vega-image-to-rte-image-block-strategy.d.ts

@@ -1,8 +1,8 @@
 import { RTEContentBlock } from '../../../../interface';
 import { Nullable } from '../../../../../../types/general';
-import { BlockToRTEBlockStrategyAbstract } from './block-to-rte-block-strategy.abstract';
+import { ElementToRTEImageBlockStrategyAbstract } from './element-to-rte-image-block-strategy.abstract';
 /** Transform vega-rich-text-image-editor element to image block DTO */
-export declare class VegaImageToRTEImageBlockStrategy extends BlockToRTEBlockStrategyAbstract {
+export declare class VegaImageToRTEImageBlockStrategy extends ElementToRTEImageBlockStrategyAbstract {
   /**
    * Can be handle.
    *

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

@@ -3,7 +3,6 @@ import { BaseHandler } from './base-handler';
  * Handle user paste
  */
 export declare class InsertPasteHandler extends BaseHandler {
-  private elementToDTOProcessor;
   /**
    * Update the state value when user paste html elements.
    *
@@ -41,4 +40,11 @@ export declare class InsertPasteHandler extends BaseHandler {
    * @param {RTEBlock} newBlock - Represents a new create block element in a rich text editor.
    */
   private switchCaretPositionToNextElement;
+  /**
+   * Parses the content of a plain text and formats it into HTML.
+   *
+   * @param {string} content - The content of plain text.
+   * @returns {string} - The formatted HTML string.
+   */
+  private parsePlainText;
 }

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

@@ -0,0 +1,45 @@
+import { AutoRunWhenReRenderTaskQueueSlimmer } from '../../../../helpers/slimmers/auto-run-when-re-render-task-queue-slimmer.abstract';
+import { RTECodeBlock } from '../../dto/blocks/code-block';
+import { RTECodeBlockNode } from '../../dto/nodes/code-block-node';
+/**
+ * The rich text internal code block selection controller.
+ */
+export declare class InternalCodeBlockSelectionController extends AutoRunWhenReRenderTaskQueueSlimmer {
+  protected focusNodeOffset: number;
+  private shouldFocusNode;
+  constructor();
+  /**
+   * Update the internal code block selection.
+   *
+   * @param {RTECodeBlockNode} startNode - The internal code block node DTO.
+   * @param {number} startOffset - The content offset.
+   * @param {boolean} immediatelyRun - Whether to invoke the method immediately.
+   */
+  enqueueSelectionRangeFutureState(startNode: RTECodeBlockNode, startOffset: number, immediatelyRun?: boolean): void;
+  /**
+   * Check the code block is actually selected or not. Because the Code block is a shadow dom, so can't detect the content selected state.
+   * We add two placeholder spans at the begin and end position, we could check the placeholder spans selected state to make sure the code block is selected or not.
+   *
+   *
+   * @example
+   * <div>
+   * <span></span>
+   * <vega-code-block></vega-code-block>
+   * <span><span>
+   * </div>
+   * @param {RTECodeBlock} codeBlock - The code block DTO.
+   * @param {Range} range - The range instance.
+   * @returns {boolean} - The boolean result.
+   */
+  isCodeBlockSelected(codeBlock: RTECodeBlock, range: Range): boolean;
+  /**
+   * The method invoke after the component re-render.
+   */
+  protected doTask: () => Promise<void>;
+  /**
+   * Focus the code block component.
+   *
+   * @param {RTECodeBlockNode} node - The code block node DTO.
+   */
+  private focusTheCodeBlock;
+}

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

@@ -1,9 +1,9 @@
-import { VegaSlimmer } from '../../../../vega-slimmer/vega-slimmer-core';
 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 { RTESelectionState } from '../../dto/selection-state';
+import { AutoRunWhenReRenderTaskQueueSlimmer } from '../../../../helpers/slimmers/auto-run-when-re-render-task-queue-slimmer.abstract';
 declare type SelectionStateType = {
   startNode: Node | RTENode;
   endNode: Node | RTENode;
@@ -13,18 +13,19 @@ declare type SelectionStateType = {
 /**
  * The text selection controller
  */
-export declare class SelectionController extends VegaSlimmer {
+export declare class SelectionController extends AutoRunWhenReRenderTaskQueueSlimmer {
   static readonly SELECTION_CHANGE_DEBOUNCE_TIME: number;
   vegaRichTextEditorRenderer: VegaRichTextEditor['vegaRichTextEditorRenderer'];
   selectionMap: VegaRichTextEditor['selectionMap'];
   host: VegaRichTextEditor['host'];
   protected readonly value: VegaRichTextEditor['value'];
   protected readonly disabled: VegaRichTextEditor['disabled'];
+  protected readonly sourceView: VegaRichTextEditor['sourceView'];
   protected readonly valueController: VegaRichTextEditor['valueController'];
   protected insertCompositionTextController: VegaRichTextEditor['insertCompositionTextController'];
   protected readonly historyController: VegaRichTextEditor['historyController'];
+  protected internalCodeBlockSelectionController: VegaRichTextEditor['internalCodeBlockSelectionController'];
   private currentRange;
-  private updateCaretPositionTaskQueue;
   private handleSelectionWithDebounce;
   private pendingRestoreSelectionNodes;
   private selectionRangeChangeObserver;
@@ -41,14 +42,11 @@ export declare class SelectionController extends VegaSlimmer {
    * Component lifecycle - [componentDidLoad]{@link VegaRichTextEditor.componentDidLoad}
    */
   componentDidLoad(): void;
+  constructor();
   /**
    * Watches the internal value of the editor
    */
   watchValueUpdate(): void;
-  /**
-   * Update the caret position after the component re-render
-   */
-  updateCaretPosition(): Promise<void>;
   /**
    * Get the current RTE selection range
    *
@@ -89,6 +87,16 @@ export declare class SelectionController extends VegaSlimmer {
    * @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;
   /**
    * Save the current selection range detail
    */
@@ -97,29 +105,15 @@ export declare class SelectionController extends VegaSlimmer {
    * Restore the selection to the current selected nodes
    */
   private restoreSelection;
-  /**
-   * Get the rich text content selected range
-   *
-   * @returns {Selection} A [Selection](https://developer.mozilla.org/en-US/docs/Web/API/Selection) object
-   */
-  private getSelection;
   /**
    * Get selected rich text
    */
   private handleSelectionChange;
   /**
-   * Clear the selection map
+   * 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`
    */
   private clearSelectionMap;
-  /**
-   * Sets the next selection state with specified start and end nodes, offsets, and a timestamp.
-   *
-   * Example:
-   * Before insert text start offset is 0, the new start offset should update to 1
-   * Before delete text start offset is 1, the new start offset should update to 0
-   *
-   */
-  private createUpdateSelectionRangeTask;
   /**
    * Check if the selection range change is acceptable
    *