suneditor 3.0.0-beta.3 → 3.0.0-beta.30

package/types/plugins/modal/link.d.ts

@@ -1,13 +1,6 @@
 export default Link;
-export type LinkPluginOptions = {
-	/**
-	 * - Whether to display the link text.
-	 */
-	textToDisplay?: boolean;
-	/**
-	 * - Whether to display the link title.
-	 */
-	title?: boolean;
+export type ModalAnchorEditorParams_link = import('../../modules/ModalAnchorEditor').ModalAnchorEditorParams;
+export type LinkOptions = {
 	/**
 	 * - The URL endpoint for file uploads.
 	 */
@@ -31,16 +24,21 @@ export type LinkPluginOptions = {
 	 */
 	acceptedFormats?: string;
 };
+export type LinkPluginOptions = Omit<LinkOptions & ModalAnchorEditorParams_link, ''>;
+/**
+ * @typedef {import('../../modules/ModalAnchorEditor').ModalAnchorEditorParams} ModalAnchorEditorParams_link
+ */
 /**
- * @typedef {Object} LinkPluginOptions
- * @property {boolean} [textToDisplay=true] - Whether to display the link text.
- * @property {boolean} [title=true] - Whether to display the link title.
+ * @typedef {Object} LinkOptions
  * @property {string} [uploadUrl] - The URL endpoint for file uploads.
  * @property {Object<string, string>} [uploadHeaders] - Additional headers for file upload requests.
  * @property {number} [uploadSizeLimit] - The total file upload size limit in bytes.
  * @property {number} [uploadSingleSizeLimit] - The single file upload size limit in bytes.
  * @property {string} [acceptedFormats] - Accepted file formats for link uploads.
  */
+/**
+ * @typedef {Omit<LinkOptions & ModalAnchorEditorParams_link, ''>} LinkPluginOptions
+ */
 /**
  * @class
  * @description Link plugin.
@@ -59,24 +57,43 @@ declare class Link extends EditorInjector {
 	constructor(editor: __se__EditorCore, pluginOptions: LinkPluginOptions);
 	title: any;
 	icon: string;
+	target: HTMLAnchorElement;
 	isUpdateState: boolean;
 	pluginOptions: {
 		uploadUrl: string;
 		uploadHeaders: {
 			[x: string]: string;
+		} & {
+			[x: string]: string;
 		};
 		uploadSizeLimit: number;
 		uploadSingleSizeLimit: number;
 		acceptedFormats: string;
 		enableFileUpload: boolean;
 		/**
-		 * - Whether to display the link text.
+		 * - Modal title display.
+		 */
+		title?: boolean;
+		/**
+		 * - Create Text to display input.
 		 */
 		textToDisplay?: boolean;
 		/**
-		 * - Whether to display the link title.
+		 * - Default checked value of the "Open in new window" checkbox.
 		 */
-		title?: boolean;
+		openNewWindow?: boolean;
+		/**
+		 * - If true, disables the automatic prefixing of the host URL to the value of the link.
+		 */
+		noAutoPrefix?: boolean;
+		/**
+		 * - The "rel" attribute list of anchor tag.
+		 */
+		relList?: Array<string>;
+		/**
+		 * - Default "rel" attributes of anchor tag.
+		 */
+		defaultRel?: import('../../modules/ModalAnchorEditor').RELAttr;
 	};
 	anchor: ModalAnchorEditor;
 	modal: Modal;
@@ -86,6 +103,7 @@ declare class Link extends EditorInjector {
 	 * @description Executes the method that is called whenever the cursor position changes.
 	 * @param {?HTMLElement=} element - Node element where the cursor is currently located
 	 * @returns {boolean} - Whether the plugin is active
+	 * - If it returns "undefined", it will no longer be called in this scope.
 	 */
 	active(element?: (HTMLElement | null) | undefined): boolean;
 	/**
@@ -121,6 +139,7 @@ declare class Link extends EditorInjector {
 	 * @description This function is called before the "controller" before it is closed.
 	 */
 	close(): void;
+	#private;
 }
 import EditorInjector from '../../editorInjector';
 import { ModalAnchorEditor } from '../../modules';

package/types/plugins/modal/math.d.ts

@@ -110,7 +110,6 @@ declare class Math_ extends EditorInjector {
 	/** @type {HTMLSelectElement} */
 	fontSizeElement: HTMLSelectElement;
 	isUpdateState: boolean;
-	_element: HTMLElement;
 	/**
 	 * @editorMethod Editor.component
 	 * @description Executes the method that is called when a component of a plugin is selected.
@@ -171,21 +170,6 @@ declare class Math_ extends EditorInjector {
 	 * @param {Node} target Target element
 	 */
 	destroy(target: Node): void;
-	/**
-	 * @private
-	 * @description Renders the given math expression using KaTeX or MathJax.
-	 * @param {string} exp - The math expression to render.
-	 * @returns {string} - The rendered math expression as HTML.
-	 */
-	private _renderer;
-	/**
-	 * @private
-	 * @description Escapes or unescapes backslashes in a given string.
-	 * @param {string} str - The input string.
-	 * @param {boolean} decode - If true, decodes escaped backslashes; otherwise, encodes them.
-	 * @returns {string} - The processed string.
-	 */
-	private _escapeBackslashes;
 	#private;
 }
 import EditorInjector from '../../editorInjector';

package/types/plugins/modal/video.d.ts

@@ -125,6 +125,14 @@ export type VideoPluginOptions = {
 	 * - Figure controls.
 	 */
 	controls?: FigureControls_video;
+	/**
+	 * - Component insertion behavior for selection and cursor placement. [default: options.get('componentInsertBehavior')]
+	 * - `auto`: Move cursor to the next line if possible, otherwise select the component.
+	 * - `select`: Always select the inserted component.
+	 * - `line`: Move cursor to the next line if possible, or create a new line and move there.
+	 * - `none`: Do nothing.
+	 */
+	insertBehavior?: __se__ComponentInsertBehaviorType;
 };
 /**
  * @typedef {import('../../events').VideoInfo} VideoInfo_video
@@ -158,6 +166,11 @@ export type VideoPluginOptions = {
  * @property {Array<RegExp>} [urlPatterns] - Additional URL patterns for video embedding.
  * @property {Array<string>} [extensions] - Additional file extensions to be recognized for video uploads.
  * @property {FigureControls_video} [controls] - Figure controls.
+ * @property {__se__ComponentInsertBehaviorType} [insertBehavior] - Component insertion behavior for selection and cursor placement. [default: options.get('componentInsertBehavior')]
+ * - `auto`: Move cursor to the next line if possible, otherwise select the component.
+ * - `select`: Always select the inserted component.
+ * - `line`: Move cursor to the next line if possible, or create a new line and move there.
+ * - `none`: Do nothing.
  */
 /**
  * @class
@@ -210,6 +223,7 @@ declare class Video extends EditorInjector {
 		};
 		query_youtube: string;
 		query_vimeo: string;
+		insertBehavior: __se__ComponentInsertBehaviorType;
 	};
 	modal: Modal;
 	figure: Figure;
@@ -219,29 +233,11 @@ declare class Video extends EditorInjector {
 	videoUrlFile: HTMLInputElement;
 	focusElement: HTMLInputElement;
 	previewSrc: HTMLElement;
-	_linkValue: string;
-	_align: string;
-	_frameRatio: string;
-	_defaultRatio: string;
-	_defaultSizeX: string;
-	_defaultSizeY: string;
 	sizeUnit: string;
 	proportion: HTMLInputElement;
 	frameRatioOption: HTMLSelectElement;
 	inputX: HTMLInputElement;
 	inputY: HTMLInputElement;
-	_element: any;
-	_cover: HTMLElement;
-	_container: any;
-	_ratio: {
-		w: number;
-		h: number;
-	};
-	_origin_w: string;
-	_origin_h: string;
-	_resizing: boolean;
-	_onlyPercentage: boolean;
-	_nonResizing: boolean;
 	query: {
 		youtube: {
 			pattern: RegExp;
@@ -314,14 +310,6 @@ declare class Video extends EditorInjector {
 	 * @param {HTMLIFrameElement|HTMLVideoElement} target Target component element
 	 */
 	select(target: HTMLIFrameElement | HTMLVideoElement): void;
-	/**
-	 * @private
-	 * @description Prepares the component for selection.
-	 * - Ensures that the controller is properly positioned and initialized.
-	 * - Prevents duplicate event handling if the component is already selected.
-	 * @param {HTMLIFrameElement|HTMLVideoElement} target - The selected element.
-	 */
-	private _ready;
 	/**
 	 * @editorMethod Editor.Component
 	 * @description Method to delete a component of a plugin, called by the "FileManager", "Controller" module.
@@ -379,6 +367,7 @@ declare class Video extends EditorInjector {
 	 * @param {string} align - The alignment to apply to the video element (e.g., 'left', 'center', 'right').
 	 * @param {boolean} isUpdate - Indicates whether this is an update to an existing component (true) or a new creation (false).
 	 * @param {{name: string, size: number}} file - File metadata associated with the video
+	 * @param {boolean} isLast - Indicates whether this is the last file in the batch (used for scroll and insert actions).
 	 */
 	create(
 		oFrame: HTMLIFrameElement | HTMLVideoElement,
@@ -390,7 +379,8 @@ declare class Video extends EditorInjector {
 		file: {
 			name: string;
 			size: number;
-		}
+		},
+		isLast: boolean
 	): void;
 	/**
 	 * @description Creates a new iframe element for video embedding.
@@ -406,19 +396,6 @@ declare class Video extends EditorInjector {
 	 * @returns {HTMLVideoElement} The newly created video element.
 	 */
 	createVideoTag(props?: { [x: string]: string }): HTMLVideoElement;
-	/**
-	 * @private
-	 * @description Sets the size of the video element.
-	 * @param {string|number} w - The width of the video.
-	 * @param {string|number} h - The height of the video.
-	 */
-	private _applySize;
-	/**
-	 * @private
-	 * @description Retrieves video information including size and alignment.
-	 * @returns {*} Video information object.
-	 */
-	private _getInfo;
 	/**
 	 * @description Create an "video" component using the provided files.
 	 * @param {FileList|File[]} fileList File object list
@@ -431,52 +408,6 @@ declare class Video extends EditorInjector {
 	 * @returns {Promise<boolean>} If return false, the file upload will be canceled
 	 */
 	submitURL(url: string): Promise<boolean>;
-	/**
-	 * @private
-	 * @description Updates the video component within the editor.
-	 * @param {HTMLIFrameElement|HTMLVideoElement} oFrame - The video element to update.
-	 */
-	private _update;
-	/**
-	 * @private
-	 * @description Registers the uploaded video in the editor.
-	 * @param {VideoInfo_video} info - Video information object.
-	 * @param {Object<string, *>} response - Server response containing video data.
-	 */
-	private _register;
-	/**
-	 * @private
-	 * @description Uploads a video to the server using an external upload handler.
-	 * @param {VideoInfo_video} info - Video information object.
-	 * @param {FileList} files - The video files to upload.
-	 */
-	private _serverUpload;
-	/**
-	 * @private
-	 * @description Sets attributes for the video tag.
-	 * @param {HTMLVideoElement} element - The video element.
-	 */
-	private _setTagAttrs;
-	/**
-	 * @private
-	 * @description Sets attributes for the iframe tag.
-	 * @param {HTMLIFrameElement} element - The iframe element.
-	 */
-	private _setIframeAttrs;
-	/**
-	 * @private
-	 * @description Selects a ratio option in the ratio dropdown.
-	 * @param {string|number} value - The selected ratio value.
-	 * @returns {boolean} Returns true if a ratio was selected.
-	 */
-	private _setRatioSelect;
-	/**
-	 * @private
-	 * @description Handles video upload errors.
-	 * @param {Object<string, *>} response - The error response object.
-	 * @returns {Promise<void>}
-	 */
-	private _error;
 	#private;
 }
 import EditorInjector from '../../editorInjector';

package/types/plugins/popup/anchor.d.ts

@@ -17,8 +17,6 @@ declare class Anchor extends EditorInjector {
 	title: any;
 	icon: string;
 	bookmarkIcon: HTMLElement;
-	_element: HTMLElement;
-	_range: Range;
 	displayId: Element;
 	controllerSelect: Controller;
 	inputEl: HTMLInputElement;
@@ -45,12 +43,7 @@ declare class Anchor extends EditorInjector {
 	 * @param {HTMLButtonElement} target Target button element
 	 */
 	controllerAction(target: HTMLButtonElement): void;
-	/**
-	 * @private
-	 * @description Initializes state variables.
-	 * - called when the popup is closed
-	 */
-	private _init;
+	#private;
 }
 import EditorInjector from '../../editorInjector';
 import { Controller } from '../../modules';

package/types/suneditor.d.ts

@@ -2,50 +2,101 @@ declare namespace _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 {SunEditorOptions} init_options - Initialization options
+	 * @returns {{create: (targets: Element|Object<string, {target: Element, options: SunEditorFrameOptions}>, options: SunEditorOptions) => Editor}}}
 	 */
-	function init(init_options: EditorInitOptions_suneditor): {
+	function init(init_options: SunEditorOptions): {
 		create: (
 			targets:
 				| Element
 				| {
 						[x: string]: {
 							target: Element;
-							options: EditorFrameOptions_suneditor;
+							options: SunEditorFrameOptions;
 						};
 				  },
-			options: EditorInitOptions_suneditor
+			options: SunEditorOptions
 		) => Editor;
 	};
 	/**
 	 * Creates a new instance of the SunEditor
-	 * @param {Element|Object<string, {target: Element, options: EditorFrameOptions_suneditor}>} target - Target element or multi-root object
-	 * @param {EditorInitOptions_suneditor} options - Initialization options
-	 * @param {EditorInitOptions_suneditor} [_init_options] - Optional preset initialization options
+	 * @param {Element|string|Object<string, {target: Element, options: SunEditorFrameOptions}>} 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 {SunEditorOptions} options - Initialization options
+	 * @param {SunEditorOptions} [_init_options] - Optional preset initialization options
 	 * @returns {Editor} - Instance of the SunEditor
 	 * @throws {Error} If the target element is not provided or is invalid
 	 */
 	function create(
 		target:
 			| Element
+			| string
 			| {
 					[x: string]: {
 						target: Element;
-						options: EditorFrameOptions_suneditor;
+						options: SunEditorFrameOptions;
 					};
 			  },
-		options: EditorInitOptions_suneditor,
-		_init_options?: EditorInitOptions_suneditor
+		options: SunEditorOptions,
+		_init_options?: SunEditorOptions
 	): Editor;
 }
 export default _default;
-export type EditorFrameOptions_suneditor = import('./core/section/constructor').EditorFrameOptions;
-export type EditorInitOptions_suneditor = import('./core/section/constructor').EditorInitOptions;
-import EditorInjector from './editorInjector';
-import Plugins from './plugins';
-import Modules from './modules';
-import Langs from './langs';
-import Helper from './helper';
+/**
+ * Editor initialization options.
+ * Used when creating a new editor instance via `SunEditor.create()`.
+ */
+export type SunEditorOptions = __se__EditorOptions;
+/**
+ * Frame-specific options for multi-root editors.
+ * Each frame can have its own width, height, placeholder, and other frame-level settings.
+ */
+export type SunEditorFrameOptions = __se__EditorFrameOptions;
+/**
+ * Type definition for the SunEditor instance.
+ * This is the return type of `SunEditor.create()`.
+ */
+export type SunEditorCore = __se__EditorCore;
+/**
+ * Information about a component (image, video, table, etc.) in the editor.
+ * Contains properties like target element, plugin name, options, and container references.
+ */
+export type SunEditorComponentInfo = __se__ComponentInfo;
+/**
+ * Parameters passed to plugin mouse event handlers.
+ * Includes the frame context and the mouse event object.
+ */
+export type SunEditorPluginMouseEvent = __se__PluginMouseEventInfo;
+/**
+ * Parameters passed to plugin keyboard event handlers.
+ * Includes the frame context, keyboard event, current range, and line element.
+ */
+export type SunEditorPluginKeyEvent = __se__PluginKeyEventInfo;
+/**
+ * Parameters passed when a toolbar input value changes.
+ * Includes the target input element, event object, and the new value.
+ */
+export type SunEditorPluginToolbarInputChange = __se__PluginToolbarInputChangeEventInfo;
+/**
+ * Information passed to shortcut handlers.
+ * Includes range, line element, shortcut info, event object, and key code.
+ */
+export type SunEditorPluginShortcut = __se__PluginShortcutInfo;
+/**
+ * Parameters passed to plugin paste event handlers.
+ * Includes frame context, clipboard event, cleaned HTML data, and parsed document.
+ */
+export type SunEditorPluginPaste = __se__PluginPasteParams;
+/**
+ * Parameters passed when copying a component.
+ * Includes the clipboard event, cloned container, and component info.
+ */
+export type SunEditorPluginCopyComponent = __se__PluginCopyComponentParams;
 import Editor from './core/editor';
-export { EditorInjector, Plugins, Modules, Langs, Helper };
+import helper from './helper';
+import langs from './langs';
+import modules from './modules';
+import plugins from './plugins';
+export { helper, langs, modules, plugins };

package/types/typedef.d.ts

@@ -4,7 +4,60 @@ declare global {
 	type __se__NodeCollection = Array<Node> | HTMLCollection | NodeList;
 	type __se__EditorCore = import('./core/editor').default;
 	type __se__EditorInjector = import('./editorInjector').default;
-	type __se__CoreInjector = import('./editorInjector/_core').default;
+	type __se__EditorOptions = import('./core/config/options').EditorInitOptions;
+	type __se__EditorFrameOptions = import('./core/config/options').EditorFrameOptions;
+	type __se__FrameContext = import('./core/config/frameContext').FrameContextUtil;
+	type __se__Context = Map<keyof import('./core/config/context').ContextUtil, any>;
+	type __se__EditorStatus = {
+		/**
+		 * Boolean value of whether the editor has focus
+		 */
+		hasFocus: boolean;
+		/**
+		 * Indent size of tab (4)
+		 */
+		tabSize: number;
+		/**
+		 * Indent size (25)px
+		 */
+		indentSize: number;
+		/**
+		 * Indent size of Code view mode (2)
+		 */
+		codeIndentSize: number;
+		/**
+		 * An element array of the current cursor's node structure
+		 */
+		currentNodes: Array<string>;
+		/**
+		 * An element name array of the current cursor's node structure
+		 */
+		currentNodesMap: Array<string>;
+		/**
+		 * Current visual viewport height size
+		 */
+		currentViewportHeight: number;
+		/**
+		 * Height of the initial visual viewport height size
+		 */
+		initViewportHeight: number;
+		/**
+		 * Boolean value of whether component is selected
+		 */
+		onSelected: boolean;
+		/**
+		 * Current root key
+		 */
+		rootKey: any;
+		/**
+		 * Current range object
+		 */
+		_range: Range;
+		/**
+		 * Mouse down event status
+		 */
+		_onMousedown: boolean;
+	};
 	type __se__ComponentInfo = {
 		/**
 		 * - The target element associated with the component.
@@ -49,48 +102,7 @@ declare global {
 		 */
 		isInputType: boolean;
 	};
-	type __se__EditorStatus = {
-		/**
-		 * Boolean value of whether the editor has focus
-		 */
-		hasFocus: boolean;
-		/**
-		 * Indent size of tab (4)
-		 */
-		tabSize: number;
-		/**
-		 * Indent size (25)px
-		 */
-		indentSize: number;
-		/**
-		 * Indent size of Code view mode (2)
-		 */
-		codeIndentSize: number;
-		/**
-		 * An element array of the current cursor's node structure
-		 */
-		currentNodes: Array<string>;
-		/**
-		 * An element name array of the current cursor's node structure
-		 */
-		currentNodesMap: Array<string>;
-		/**
-		 * Boolean value of whether component is selected
-		 */
-		onSelected: boolean;
-		/**
-		 * Current root key
-		 */
-		rootKey: number;
-		/**
-		 * Current range object
-		 */
-		_range: Range;
-		/**
-		 * Mouse down event status
-		 */
-		_onMousedown: boolean;
-	};
+	type __se__ComponentInsertBehaviorType = 'auto' | 'select' | 'line' | 'none';
 	type __se__EventInfo = {
 		/**
 		 * Target element
@@ -226,8 +238,10 @@ declare global {
 		 */
 		info: __se__ComponentInfo;
 	};
-	type __se__FrameOptions = Map<string, any>;
-	type __se__FrameContext = Map<string, any>;
-	type __se__Context = Map<string, any>;
+	type __se__FrameOptions = import('./core/config/options').FrameOptionsMap;
+	type __se__BaseOptions = import('./core/config/options').BaseOptionsMap;
 	type __se__Class_OffsetGlobalInfo = import('./core/class/offset').OffsetGlobalInfo;
+	type __se__EventKeydownCtx = import('./core/event/reducers/keydown.reducer').KeydownReducerCtx;
+	type __se__EventActions = import('./core/event/actions').Action[];
+	type __se__EventPorts = import('./core/event/ports').EventReducerPorts;
 }