suneditor 3.0.0-beta.26 → 3.0.0-beta.28

package/src/suneditor.js

@@ -1,47 +1,22 @@
 import Editor from './core/editor';
 
-import editorInjector from './editorInjector';
 import plugins from './plugins';
-import langs from './langs';
 import modules from './modules';
 import helper from './helper';
+import langs from './langs';
 
 /**
  * @module SunEditorExports
  */
+export { plugins, modules, helper, langs };
 
 /**
- * @typedef {import('./core/config/options').EditorFrameOptions} EditorFrameOptions_suneditor
- */
-
-/**
- * @typedef {import('./core/config/options').EditorInitOptions} EditorInitOptions_suneditor
- */
-
-/**
- * Editor Injector module, Inject "editor" and basic frequently used objects by calling it with "call(this, editor)".
- */
-export { editorInjector };
-
-/**
- * Available editor plugins
- */
-export { plugins };
-
-/**
- * Editor modules
- */
-export { modules };
-
-/**
- * Language packs for the editor
+ * @typedef {import('./core/config/options').EditorFrameOptions} SunEditorFrameOptionsType
  */
-export { langs };
 
 /**
- * Helper functions for the editor
+ * @typedef {import('./core/config/options').EditorInitOptions} SunEditorOptionsType
  */
-export { helper };
 
 /**
  * SunEditor Factory Object
@@ -51,8 +26,8 @@ export default {
 	/**
 	 * Returns the create function with preset options.
 	 * If the options overlap, the options of the 'create' function take precedence.
-	 * @param {EditorInitOptions_suneditor} init_options - Initialization options
-	 * @returns {{create: (targets: Element|Object<string, {target: Element, options: EditorFrameOptions_suneditor}>, options: EditorInitOptions_suneditor) => Editor}}}
+	 * @param {SunEditorOptionsType} init_options - Initialization options
+	 * @returns {{create: (targets: Element|Object<string, {target: Element, options: SunEditorFrameOptionsType}>, options: SunEditorOptionsType) => Editor}}}
 	 */
 	init(init_options) {
 		return {
@@ -62,12 +37,12 @@ export default {
 
 	/**
 	 * Creates a new instance of the SunEditor
-	 * @param {Element|string|Object<string, {target: Element, options: EditorFrameOptions_suneditor}>} target
+	 * @param {Element|string|Object<string, {target: Element, options: SunEditorFrameOptionsType}>} target
 	 * - Element: The direct DOM element to initialize the editor on.
 	 * - string: A CSS selector string. The corresponding element is selected using `document.querySelector`.
 	 * - Object: For multi-root setup. Each key maps to a config with `{target, options}`.
-	 * @param {EditorInitOptions_suneditor} options - Initialization options
-	 * @param {EditorInitOptions_suneditor} [_init_options] - Optional preset initialization options
+	 * @param {SunEditorOptionsType} options - Initialization options
+	 * @param {SunEditorOptionsType} [_init_options] - Optional preset initialization options
 	 * @returns {Editor} - Instance of the SunEditor
 	 * @throws {Error} If the target element is not provided or is invalid
 	 */

package/src/typedef.js

@@ -14,9 +14,6 @@
 
 /**
  * @typedef {import('./editorInjector').default} __se__EditorInjector
- */
-
-/**
  * @typedef {import('./editorInjector/_core').default} __se__CoreInjector
  */
 
@@ -45,7 +42,7 @@
  * @property {number} currentViewportHeight Current visual viewport height size
  * @property {number} initViewportHeight Height of the initial visual viewport height size
  * @property {boolean} onSelected Boolean value of whether component is selected
- * @property {number} rootKey Current root key
+ * @property {*} rootKey Current root key
  * @property {Range} _range Current range object
  * @property {boolean} _onMousedown Mouse down event status
  */
@@ -124,16 +121,15 @@
  * @property {__se__ComponentInfo} info Component information
  */
 
-// --------------------------------------------------------- [Context] ---------------------------------------------------------------------------------------------------
+// --------------------------------------------------------- [Options] ---------------------------------------------------------------------------------------------------
 /**
- * @typedef {Map<keyof import('./core/config/options').AllFrameOptions, *>} __se__FrameOptions
+ * @typedef {import('./core/config/options').FrameOptionsMap} __se__FrameOptions
+ * @typedef {import('./core/config/options').BaseOptionsMap} __se__BaseOptions
  */
 
+// --------------------------------------------------------- [Context] ---------------------------------------------------------------------------------------------------
 /**
  * @typedef {import('./core/config/frameContext').FrameContextUtil} __se__FrameContext
- */
-
-/**
  * @typedef {Map<keyof import('./core/config/context').ContextUtil, *>} __se__Context
  */
 
@@ -141,3 +137,13 @@
 /**
  * @typedef {import('./core/class/offset').OffsetGlobalInfo} __se__Class_OffsetGlobalInfo
  */
+
+// --------------------------------------------------------- [event.reducer/action] ------------------------------------------------------------------------------------------
+/**
+ * @typedef {import('./core/event/reducers/keydown.reducer').KeydownReducerCtx} __se__EventKeydownCtx
+ */
+
+/**
+ * @typedef {import('./core/event/actions').Action[]} __se__EventActions
+ * @typedef {import('./core/event/ports').EventReducerPorts} __se__EventPorts
+ */

package/types/core/class/format.d.ts

@@ -1,25 +1,12 @@
 export default Format;
 export type FormatThis = Omit<Format & Partial<__se__EditorInjector>, 'format'>;
-export type NodeStyleContainerType = {
-	ancestor?: (Node | null) | undefined;
-	offset?: (number | null) | undefined;
-	container?: (Node | null) | undefined;
-	endContainer?: (Node | null) | undefined;
-};
 /**
  * @typedef {Omit<Format & Partial<__se__EditorInjector>, 'format'>} FormatThis
  */
-/**
- * @typedef {Object} NodeStyleContainerType
- * @property {?Node=} ancestor
- * @property {?number=} offset
- * @property {?Node=} container
- * @property {?Node=} endContainer
- */
 /**
  * @constructor
  * @this {FormatThis}
- * @description Classes related to editor formats such as line creation, line retrieval from selected range, etc.
+ * @description Classes related to editor formats such as "line" and "block".
  * @param {__se__EditorCore} editor - The root editor instance
  */
 declare function Format(this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>, editor: __se__EditorCore): void;
@@ -27,22 +14,13 @@ declare class Format {
 	/**
 	 * @typedef {Omit<Format & Partial<__se__EditorInjector>, 'format'>} FormatThis
 	 */
-	/**
-	 * @typedef {Object} NodeStyleContainerType
-	 * @property {?Node=} ancestor
-	 * @property {?number=} offset
-	 * @property {?Node=} container
-	 * @property {?Node=} endContainer
-	 */
 	/**
 	 * @constructor
 	 * @this {FormatThis}
-	 * @description Classes related to editor formats such as line creation, line retrieval from selected range, etc.
+	 * @description Classes related to editor formats such as "line" and "block".
 	 * @param {__se__EditorCore} editor - The root editor instance
 	 */
 	constructor(editor: __se__EditorCore);
-	_listCamel: any;
-	_listKebab: any;
 	_formatLineCheck: any;
 	_formatBrLineCheck: any;
 	_formatBlockCheck: any;
@@ -143,42 +121,6 @@ declare class Format {
 		eo: number;
 		removeArray: Array<Node> | null;
 	};
-	/**
-	 * @this {FormatThis}
-	 * @description Append all selected "line" element to the list and insert.
-	 * @param {string} type List type. (ol | ul):[listStyleType]
-	 * @param {Array<Node>} selectedCells "line" elements or list cells.
-	 * @param {boolean} nested If true, indenting existing list cells.
-	 */
-	applyList(
-		this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>,
-		type: string,
-		selectedCells: Array<Node>,
-		nested: boolean
-	): {
-		sc: Node;
-		so: number;
-		ec: Node;
-		eo: number;
-	};
-	/**
-	 * @this {FormatThis}
-	 * @description "selectedCells" array are detached from the list element.
-	 * - The return value is applied when the first and last lines of "selectedFormats" are "LI" respectively.
-	 * @param {Array<Node>} selectedCells Array of ["line", li] elements(LI, P...) to remove.
-	 * @param {boolean} shouldDelete If true, It does not just remove the list, it deletes the content.
-	 * @returns {{sc: Node, ec: Node}} Node information after deletion
-	 * - sc: Start container node
-	 * - ec: End container node
-	 */
-	removeList(
-		this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>,
-		selectedCells: Array<Node>,
-		shouldDelete: boolean
-	): {
-		sc: Node;
-		ec: Node;
-	};
 	/**
 	 * @this {FormatThis}
 	 * @description Indent more the selected lines.
@@ -191,50 +133,6 @@ declare class Format {
 	 * - margin size - "status.indentSize"px
 	 */
 	outdent(this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>): void;
-	/**
-	 * @this {FormatThis}
-	 * @description Adds, updates, or deletes style nodes from selected text (a, span, strong, etc.).
-	 * @param {?Node} styleNode The element to be added to the selection. If null, only existing nodes are modified or removed.
-	 * @param {Object} [options] Options
-	 * @param {Array<string>} [options.stylesToModify=null] Array of style or class names to check and modify.
-	 *        (e.g., ['font-size'], ['.className'], ['font-family', 'color', '.className'])
-	 * @param {Array<string>} [options.nodesToRemove=null] Array of node names to remove.
-	 *        If empty array or null when styleNode is null, all formats are removed.
-	 *        (e.g., ['span'], ['strong', 'em'])
-	 * @param {boolean} [options.strictRemove=false] If true, only removes nodes from nodesToRemove if all styles and classes are removed.
-	 * @returns {HTMLElement} The element that was added to or modified in the selection.
-	 *
-	 * @details
-	 * 1. If styleNode is provided, a node with the same tags and attributes is added to the selected text.
-	 * 2. If the same tag already exists, only its attributes are updated.
-	 * 3. If styleNode is null, existing nodes are updated or removed without adding new ones.
-	 * 4. Styles matching those in stylesToModify are removed. (Use CSS attribute names, e.g., "background-color")
-	 * 5. Classes matching those in stylesToModify (prefixed with ".") are removed.
-	 * 6. stylesToModify is used to avoid duplicate property values from styleNode.
-	 * 7. Nodes with all styles and classes removed are deleted if they match styleNode, are in nodesToRemove, or if styleNode is null.
-	 * 8. Tags matching names in nodesToRemove are deleted regardless of their style and class.
-	 * 9. If strictRemove is true, nodes in nodesToRemove are only removed if all their styles and classes are removed.
-	 * 10. The function won't modify nodes if the parent has the same class and style values.
-	 * - However, if nodesToRemove has values, it will work and separate text nodes even if there's no node to replace.
-	 */
-	applyInlineElement(
-		this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>,
-		styleNode: Node | null,
-		{
-			stylesToModify,
-			nodesToRemove,
-			strictRemove
-		}?: {
-			stylesToModify?: Array<string>;
-			nodesToRemove?: Array<string>;
-			strictRemove?: boolean;
-		}
-	): HTMLElement;
-	/**
-	 * @this {FormatThis}
-	 * @description Remove format of the currently selected text.
-	 */
-	removeInlineElement(this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>): void;
 	/**
 	 * @this {FormatThis}
 	 * @description Check if the container and offset values are the edges of the "line"
@@ -342,14 +240,6 @@ declare class Format {
 	 * @returns {boolean}
 	 */
 	_nonFormat(this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>, element: Node): boolean;
-	/**
-	 * @private
-	 * @this {FormatThis}
-	 * @description Nodes that must remain undetached when changing text nodes (A, Label, Code, Span:font-size)
-	 * @param {Node|string} element Element to check
-	 * @returns {boolean}
-	 */
-	_isNonSplitNode(this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>, element: Node | string): boolean;
 	/**
 	 * @private
 	 * @this {FormatThis}
@@ -358,14 +248,6 @@ declare class Format {
 	 * @returns {boolean}
 	 */
 	_notTextNode(this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>, element: Node | string): boolean;
-	/**
-	 * @private
-	 * @this {FormatThis}
-	 * @description Nodes that need to be added without modification when changing text nodes
-	 * @param {Node} element Element to check
-	 * @returns {boolean}
-	 */
-	_isIgnoreNodeChange(this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>, element: Node): boolean;
 	/**
 	 * @private
 	 * @this {FormatThis}
@@ -381,238 +263,6 @@ declare class Format {
 		startOffset: number;
 		endOffset: number;
 	};
-	/**
-	 * @private
-	 * @this {FormatThis}
-	 * @description Attaches a nested list structure by merging adjacent lists if applicable.
-	 * - Ensures that the nested list is placed correctly in the document structure.
-	 * @param {Element} originList The original list element where the nested list is inserted.
-	 * @param {Element} innerList The nested list element.
-	 * @param {Element} prev The previous sibling element.
-	 * @param {Element} next The next sibling element.
-	 * @param {{s: Array<number> | null, e: Array<number> | null, sl: Node | null, el: Node | null}} nodePath Object storing the start and end node paths.
-	 * - s : Start node path.
-	 * - e : End node path.
-	 * - sl : Start node's parent element.
-	 * - el : End node's parent element.
-	 * @returns {Node} The attached inner list.
-	 */
-	_attachNested(
-		this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>,
-		originList: Element,
-		innerList: Element,
-		prev: Element,
-		next: Element,
-		nodePath: {
-			s: Array<number> | null;
-			e: Array<number> | null;
-			sl: Node | null;
-			el: Node | null;
-		}
-	): Node;
-	/**
-	 * @private
-	 * @this {FormatThis}
-	 * @description Detaches a nested list structure by extracting list items from their parent list.
-	 * - Ensures proper restructuring of the list elements.
-	 * @param {Array<HTMLElement>} cells The list items to be detached.
-	 * @returns {{cc: Node, sc: Node, ec: Node}} An object containing reference nodes for repositioning.
-	 * - cc : The parent node of the first list item.
-	 * - sc : The first list item.
-	 * - ec : The last list item.
-	 */
-	_detachNested(
-		this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>,
-		cells: Array<HTMLElement>
-	): {
-		cc: Node;
-		sc: Node;
-		ec: Node;
-	};
-	/**
-	 * @private
-	 * @this {FormatThis}
-	 * @description Nest list cells or cancel nested cells.
-	 * @param {Array<HTMLElement>} selectedCells List cells.
-	 * @param {boolean} nested Nested or cancel nested.
-	 */
-	_applyNestedList(
-		this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>,
-		selectedCells: Array<HTMLElement>,
-		nested: boolean
-	): {
-		sc: Node;
-		so: number;
-		ec: Node;
-		eo: number;
-	};
-	/**
-	 * @private
-	 * @this {FormatThis}
-	 * @description Detach Nested all nested lists under the "baseNode".
-	 * - Returns a list with nested removed.
-	 * @param {HTMLElement} baseNode Element on which to base.
-	 * @param {boolean} all If true, it also detach all nested lists of a returned list.
-	 * @returns {Node} Result element
-	 */
-	_removeNestedList(this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>, baseNode: HTMLElement, all: boolean): Node;
-	/**
-	 * @private
-	 * @this {FormatThis}
-	 * @description wraps text nodes of line selected text.
-	 * @param {Node} element The node of the line that contains the selected text node.
-	 * @param {Node} newInnerNode The dom that will wrap the selected text area
-	 * @param {(current: Node) => Node|null} validation Check if the node should be stripped.
-	 * @param {Node} startCon The startContainer property of the selection object.
-	 * @param {number} startOff The startOffset property of the selection object.
-	 * @param {Node} endCon The endContainer property of the selection object.
-	 * @param {number} endOff The endOffset property of the selection object.
-	 * @param {boolean} isRemoveFormat Is the remove all formats command?
-	 * @param {boolean} isRemoveNode "newInnerNode" is remove node?
-	 * @param {boolean} collapsed range.collapsed
-	 * @returns {{ancestor: *, startContainer: *, startOffset: *, endContainer: *, endOffset: *}}
-	 */
-	_setNode_oneLine(
-		this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>,
-		element: Node,
-		newInnerNode: Node,
-		validation: (current: Node) => Node | null,
-		startCon: Node,
-		startOff: number,
-		endCon: Node,
-		endOff: number,
-		isRemoveFormat: boolean,
-		isRemoveNode: boolean,
-		collapsed: boolean,
-		_removeCheck: any,
-		_getMaintainedNode: any,
-		_isMaintainedNode: any
-	): {
-		ancestor: any;
-		startContainer: any;
-		startOffset: any;
-		endContainer: any;
-		endOffset: any;
-	};
-	/**
-	 * @private
-	 * @this {FormatThis}
-	 * @description wraps first line selected text.
-	 * @param {Node} element The node of the line that contains the selected text node.
-	 * @param {Node} newInnerNode The dom that will wrap the selected text area
-	 * @param {(current: Node) => Node|null} validation Check if the node should be stripped.
-	 * @param {Node} startCon The startContainer property of the selection object.
-	 * @param {number} startOff The startOffset property of the selection object.
-	 * @param {boolean} isRemoveFormat Is the remove all formats command?
-	 * @param {boolean} isRemoveNode "newInnerNode" is remove node?
-	 * @returns {NodeStyleContainerType} { ancestor, container, offset, endContainer }
-	 */
-	_setNode_startLine(
-		this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>,
-		element: Node,
-		newInnerNode: Node,
-		validation: (current: Node) => Node | null,
-		startCon: Node,
-		startOff: number,
-		isRemoveFormat: boolean,
-		isRemoveNode: boolean,
-		_removeCheck: any,
-		_getMaintainedNode: any,
-		_isMaintainedNode: any,
-		_endContainer: any
-	): NodeStyleContainerType;
-	/**
-	 * @private
-	 * @this {FormatThis}
-	 * @description wraps mid lines selected text.
-	 * @param {HTMLElement} element The node of the line that contains the selected text node.
-	 * @param {Node} newInnerNode The dom that will wrap the selected text area
-	 * @param {(current: Node) => Node|null} validation Check if the node should be stripped.
-	 * @param {boolean} isRemoveFormat Is the remove all formats command?
-	 * @param {boolean} isRemoveNode "newInnerNode" is remove node?
-	 * @param {Node} _endContainer Offset node of last line already modified (end.container)
-	 * @returns {NodeStyleContainerType} { ancestor, endContainer: "If end container is renewed, returned renewed node" }
-	 */
-	_setNode_middleLine(
-		this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>,
-		element: HTMLElement,
-		newInnerNode: Node,
-		validation: (current: Node) => Node | null,
-		isRemoveFormat: boolean,
-		isRemoveNode: boolean,
-		_removeCheck: any,
-		_endContainer: Node
-	): NodeStyleContainerType;
-	/**
-	 * @private
-	 * @this {FormatThis}
-	 * @description wraps last line selected text.
-	 * @param {Node} element The node of the line that contains the selected text node.
-	 * @param {Node} newInnerNode The dom that will wrap the selected text area
-	 * @param {(current: Node) => Node|null} validation Check if the node should be stripped.
-	 * @param {Node} endCon The endContainer property of the selection object.
-	 * @param {number} endOff The endOffset property of the selection object.
-	 * @param {boolean} isRemoveFormat Is the remove all formats command?
-	 * @param {boolean} isRemoveNode "newInnerNode" is remove node?
-	 * @returns {NodeStyleContainerType} { ancestor, container, offset }
-	 */
-	_setNode_endLine(
-		this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>,
-		element: Node,
-		newInnerNode: Node,
-		validation: (current: Node) => Node | null,
-		endCon: Node,
-		endOff: number,
-		isRemoveFormat: boolean,
-		isRemoveNode: boolean,
-		_removeCheck: any,
-		_getMaintainedNode: any,
-		_isMaintainedNode: any
-	): NodeStyleContainerType;
-	/**
-	 * @private
-	 * @this {FormatThis}
-	 * @description Node with font-size style
-	 * @param {Node} element Element to check
-	 * @returns {boolean}
-	 */
-	_sn_isSizeNode(this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>, element: Node): boolean;
-	/**
-	 * @private
-	 * @this {FormatThis}
-	 * @description Return the parent maintained tag. (bind and use a util object)
-	 * @param {boolean} _isRemove is remove anchor
-	 * @param {boolean} _isSizeNode is size span node
-	 * @param {Node} element Element
-	 * @returns {Node|null}
-	 */
-	_sn_getMaintainedNode(this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>, _isRemove: boolean, _isSizeNode: boolean, element: Node): Node | null;
-	/**
-	 * @private
-	 * @this {FormatThis}
-	 * @description Check if element is a tag that should be persisted. (bind and use a util object)
-	 * @param {boolean} _isRemove is remove anchor
-	 * @param {boolean} _isSizeNode is size span node
-	 * @param {Node} element Element
-	 * @returns {boolean}
-	 */
-	_sn_isMaintainedNode(this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>, _isRemove: boolean, _isSizeNode: boolean, element: Node): boolean;
-	/**
-	 * @private
-	 * @this {FormatThis}
-	 * @description If certain styles are applied to all child nodes of the list cell, the style of the list cell is also changed. (bold, color, size)
-	 * @param {Node} el List cell element. <li>
-	 * @param {?Node} child Variable for recursive call. ("null" on the first call)
-	 */
-	_sn_setCommonListStyle(this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>, el: Node, child: Node | null): void;
-	/**
-	 * @private
-	 * @this {FormatThis}
-	 * @description Watch the applied text nodes and adjust the common styles of the list.
-	 * @param {Node} el "LI" element
-	 * @param {Array|null} styleArray Refer style array
-	 */
-	_sn_resetCommonListCell(this: Omit<Format & Partial<import('../../editorInjector').default>, 'format'>, el: Node, styleArray: any[] | null): boolean;
 	/**
 	 * @private
 	 * @this {FormatThis}

package/types/core/class/html.d.ts

@@ -264,10 +264,10 @@ declare class HTML {
 	/**
 	 * @this {HTMLThis}
 	 * @description Call "clipboard.write" to copy the contents and display a success/failure toast message.
-	 * @param {Element|Text|string} content Content to be copied to the clipboard
+	 * @param {Node|Element|Text|string} content Content to be copied to the clipboard
 	 * @returns {Promise<boolean>} Success or failure
 	 */
-	copy(this: Omit<HTML & Partial<import('../../editorInjector').default>, 'html'>, content: Element | Text | string): Promise<boolean>;
+	copy(this: Omit<HTML & Partial<import('../../editorInjector').default>, 'html'>, content: Node | Element | Text | string): Promise<boolean>;
 	/**
 	 * @this {HTMLThis}
 	 * @description Sets the content of the iframe's head tag and body tag when using the "iframe" or "iframe_fullPage" option.