suneditor 3.0.0-beta.9 → 3.0.0-rc.2

package/types/plugins/input/fontSize.d.ts

@@ -1,45 +1,63 @@
+import type {} from '../../typedef';
 export default FontSize;
+export type FontSizePluginOptions = {
+	/**
+	 * - The unit for the font size.
+	 * - Accepted values include: `'px'`, `'pt'`, `'em'`, `'rem'`, `'vw'`, `'vh'`, `'%'` or `'text'`.
+	 * - If `'text'` is used, a text-based font size list is applied.
+	 */
+	sizeUnit?: string;
+	/**
+	 * - Determines whether the default size label is displayed in the dropdown menu.
+	 */
+	showDefaultSizeLabel?: boolean;
+	/**
+	 * - When `true`, displays increase and decrease buttons for font size adjustments.
+	 */
+	showIncDecControls?: boolean;
+	/**
+	 * - When `true`, disables the direct font size input box.
+	 */
+	disableInput?: boolean;
+	/**
+	 * - Optional object to override or extend the default unit mapping for font sizes.
+	 */
+	unitMap?: {
+		[x: string]: {
+			default: number;
+			inc: number;
+			min: number;
+			max: number;
+			list: Array<number>;
+		};
+	};
+};
+/**
+ * @typedef {Object} FontSizePluginOptions
+ * @property {string} [sizeUnit='px'] - The unit for the font size.
+ * - Accepted values include: `'px'`, `'pt'`, `'em'`, `'rem'`, `'vw'`, `'vh'`, `'%'` or `'text'`.
+ * - If `'text'` is used, a text-based font size list is applied.
+ * @property {boolean} [showDefaultSizeLabel=true] - Determines whether the default size label is displayed in the dropdown menu.
+ * @property {boolean} [showIncDecControls=false] - When `true`, displays increase and decrease buttons for font size adjustments.
+ * @property {boolean} [disableInput=true] - When `true`, disables the direct font size input box.
+ * @property {Object<string, {default: number, inc: number, min: number, max: number, list: Array<number>}>} [unitMap={}] - Optional object to override or extend the default unit mapping for font sizes.
+ */
 /**
  * @class
+ * @implements {PluginCommand}
+ * @implements {PluginDropdown}
  * @description FontSize Plugin
  * - This plugin enables users to modify the font size of selected text within the editor.
  * - It supports various measurement units (e.g., 'px', 'pt', 'em', 'rem', 'vw', 'vh', '%') and
  * - provides multiple interfaces: dropdown menus, direct input, and optional increment/decrement buttons.
  */
-declare class FontSize extends EditorInjector {
-	static key: string;
-	static type: string;
-	static className: string;
+declare class FontSize extends PluginInput implements PluginCommand, PluginDropdown {
 	/**
 	 * @constructor
-	 * @param {__se__EditorCore} editor - The root editor instance
-	 * @param {Object} pluginOptions - Configuration options for the FontSize plugin.
-	 * @param {string=} [pluginOptions.sizeUnit='px'] - The unit for the font size.
-	 * - Accepted values include: 'px', 'pt', 'em', 'rem', 'vw', 'vh', '%' or 'text'.
-	 * - If 'text' is used, a text-based font size list is applied.
-	 * @param {boolean=} [pluginOptions.showDefaultSizeLabel=true] - Determines whether the default size label is displayed in the dropdown menu.
-	 * @param {boolean=} [pluginOptions.showIncDecControls=false] - When true, displays increase and decrease buttons for font size adjustments.
-	 * @param {boolean=} [pluginOptions.disableInput=true] - When true, disables the direct font size input box.
-	 * @param {Object<string, {default: number, inc: number, min: number, max: number, list: Array<number>}>} [pluginOptions.unitMap={}] - Optional object to override or extend the default unit mapping for font sizes.
+	 * @param {SunEditor.Kernel} editor - The core kernel
+	 * @param {FontSizePluginOptions} pluginOptions - Configuration options for the FontSize plugin.
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			sizeUnit?: string | undefined;
-			showDefaultSizeLabel?: boolean | undefined;
-			showIncDecControls?: boolean | undefined;
-			disableInput?: boolean | undefined;
-			unitMap?: {
-				[x: string]: {
-					default: number;
-					inc: number;
-					min: number;
-					max: number;
-					list: Array<number>;
-				};
-			};
-		}
-	);
+	constructor(editor: SunEditor.Kernel, pluginOptions: FontSizePluginOptions);
 	unitMap: {
 		text: {
 			default: string;
@@ -97,75 +115,18 @@ declare class FontSize extends EditorInjector {
 			list: number[];
 		};
 	};
-	sizeUnit: any;
+	sizeUnit: string;
 	title: any;
 	inner: string | boolean;
-	beforeItem: HTMLElement;
-	afterItem: HTMLElement;
-	replaceButton: HTMLElement;
 	currentSize: string;
 	sizeList: NodeListOf<Element>;
 	hasInputFocus: boolean;
 	isInputActive: boolean;
-	_disableInput: boolean;
-	/**
-	 * @editorMethod Editor.EventManager
-	 * @description Executes the method that is called whenever the cursor position changes.
-	 * @param {?HTMLElement=} element - Node element where the cursor is currently located
-	 * @param {?HTMLElement=} target - The plugin's toolbar button element
-	 * @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, target?: (HTMLElement | null) | undefined): boolean;
-	/**
-	 * @editorMethod Editor.Toolbar
-	 * @description Executes the event function of toolbar's input tag - "keydown".
-	 * @param {Object} params
-	 * @param {HTMLElement} params.target Input element
-	 * @param {KeyboardEvent} params.event Event object
-	 */
-	onInputKeyDown({ target, event }: { target: HTMLElement; event: KeyboardEvent }): void;
-	/**
-	 * @editorMethod Editor.Toolbar
-	 * @description Executes the event function of toolbar's input tag - "change".
-	 * @param {__se__PluginToolbarInputChangeEventInfo} params
-	 */
-	onInputChange({ target, value: changeValue, event }: __se__PluginToolbarInputChangeEventInfo): void;
-	/**
-	 * @editorMethod Modules.Dropdown
-	 * @description Executes the method that is called when a plugin's dropdown menu is opened.
-	 * @param {HTMLElement} target Line element at the current cursor position
-	 */
-	on(target: HTMLElement): void;
-	/**
-	 * @editorMethod Editor.core
-	 * @description Executes the main execution method of the plugin.
-	 * - Called when an item in the "dropdown" menu is clicked.
-	 * @param {HTMLElement} target - The plugin's toolbar button element
-	 */
-	action(target: HTMLElement): void;
-	/**
-	 * @private
-	 * @description Retrieves the default font size of the editor.
-	 * @returns {string} - The computed font size from the editor.
-	 */
-	private _getDefaultSize;
-	/**
-	 * @private
-	 * @description Extracts the font size and unit from the given element or input value.
-	 * @param {string|Element} target - The target input or element.
-	 * @returns {{ unit: string, value: number|string }} - An object containing:
-	 * - `unit` (string): The detected font size unit.
-	 * - `value` (number|string): The numeric font size value or text-based size.
-	 */
-	private _getSize;
-	/**
-	 * @private
-	 * @description Sets the font size in the toolbar input field or button label.
-	 * @param {HTMLElement} target - The target element in the toolbar.
-	 * @param {string|number} value - The font size value.
-	 * @returns {string|number} - The applied font size.
-	 */
-	private _setSize;
+	active(element: HTMLElement | null, target: HTMLElement | null): boolean | void;
+	on(target?: HTMLElement): void;
+	action(target?: HTMLElement): void | Promise<void>;
+	#private;
 }
-import EditorInjector from '../../editorInjector';
+import { PluginCommand } from '../../interfaces';
+import { PluginDropdown } from '../../interfaces';
+import { PluginInput } from '../../interfaces';

package/types/plugins/input/pageNavigator.d.ts

@@ -1,3 +1,4 @@
+import type {} from '../../typedef';
 export default PageNavigator;
 /**
  * @class
@@ -7,22 +8,18 @@ export default PageNavigator;
  * - the total number of pages. When the user changes the value in the input field, the plugin triggers
  * - a page navigation event through the editor's document context.
  */
-declare class PageNavigator extends EditorInjector {
-	static key: string;
-	static type: string;
-	static className: string;
+declare class PageNavigator extends PluginInput {
 	title: any;
 	inner: HTMLInputElement;
-	afterItem: HTMLElement;
 	pageNum: number;
 	totalPages: number;
 	/**
-	 * @editorMethod Editor.documentType
-	 * @description Updates the displayed page number and total pages in the navigator.
+	 * Updates the displayed page number and total pages in the navigator.
 	 * @param {number} pageNum - The current page number to display.
 	 * @param {number} totalPages - The total number of pages in the document.
+	 * @returns {void}
 	 */
 	display(pageNum: number, totalPages: number): void;
 	#private;
 }
-import EditorInjector from '../../editorInjector';
+import { PluginInput } from '../../interfaces';

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

@@ -1,12 +1,12 @@
+import type {} from '../../typedef';
 export default Audio_;
-export type AudioInfo_audio = import('../../events').AudioInfo;
 export type AudioPluginOptions = {
 	/**
-	 * - The default width of the audio tag (e.g., "300px").
+	 * - The default width of the `AUDIO` tag (e.g., `"300px"`).
 	 */
 	defaultWidth?: string;
 	/**
-	 * - The default height of the audio tag (e.g., "150px").
+	 * - The default height of the `AUDIO` tag (e.g., `"150px"`).
 	 */
 	defaultHeight?: string;
 	/**
@@ -14,7 +14,7 @@ export type AudioPluginOptions = {
 	 */
 	createFileInput?: boolean;
 	/**
-	 * - Whether to create a URL input element (default is true if file input is not created).
+	 * - Whether to create a URL input element (default is `true` if file input is not created).
 	 */
 	createUrlInput?: boolean;
 	/**
@@ -40,55 +40,60 @@ export type AudioPluginOptions = {
 	 */
 	allowMultiple?: boolean;
 	/**
-	 * - Accepted file formats (default is "audio/*").
+	 * - Accepted file formats (default is `"audio/*"`).
 	 */
 	acceptedFormats?: string;
 	/**
-	 * - Additional attributes to set on the audio tag.
+	 * - Additional attributes to set on the `AUDIO` tag.
 	 */
 	audioTagAttributes?: {
 		[x: string]: string;
 	};
+	/**
+	 * - 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?: SunEditor.ComponentInsertType;
 };
-/**
- * @typedef {import('../../events').AudioInfo} AudioInfo_audio
- */
 /**
  * @typedef {Object} AudioPluginOptions
- * @property {string} [defaultWidth="300px"] - The default width of the audio tag (e.g., "300px").
- * @property {string} [defaultHeight="150px"] - The default height of the audio tag (e.g., "150px").
+ * @property {string} [defaultWidth="300px"] - The default width of the `AUDIO` tag (e.g., `"300px"`).
+ * @property {string} [defaultHeight="150px"] - The default height of the `AUDIO` tag (e.g., `"150px"`).
  * @property {boolean} [createFileInput] - Whether to create a file input element.
- * @property {boolean} [createUrlInput] - Whether to create a URL input element (default is true if file input is not created).
+ * @property {boolean} [createUrlInput] - Whether to create a URL input element (default is `true` if file input is not created).
  * @property {string} [uploadUrl] - The URL to which files will be uploaded.
  * @property {Object<string, string>} [uploadHeaders] - Headers to include in the file upload request.
  * @property {number} [uploadSizeLimit] - The total upload size limit in bytes.
  * @property {number} [uploadSingleSizeLimit] - The single file size limit in bytes.
  * @property {boolean} [allowMultiple] - Whether to allow multiple file uploads.
- * @property {string} [acceptedFormats="audio/*"] - Accepted file formats (default is "audio/*").
- * @property {Object<string, string>} [audioTagAttributes] - Additional attributes to set on the audio tag.
+ * @property {string} [acceptedFormats="audio/*"] - Accepted file formats (default is `"audio/*"`).
+ * @property {Object<string, string>} [audioTagAttributes] - Additional attributes to set on the `AUDIO` tag.
+ * @property {SunEditor.ComponentInsertType} [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
  * @description Audio modal plugin.
  */
-declare class Audio_ extends EditorInjector {
-	static key: string;
-	static type: string;
-	static className: string;
+declare class Audio_ extends PluginModal {
 	/**
-	 * @this {Audio_}
 	 * @param {HTMLElement} node - The node to check.
 	 * @returns {HTMLElement|null} Returns a node if the node is a valid component.
 	 */
-	static component(this: Audio_, node: HTMLElement): HTMLElement | null;
+	static component(node: HTMLElement): HTMLElement | null;
 	/**
 	 * @constructor
-	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {SunEditor.Kernel} editor - The core kernel
 	 * @param {AudioPluginOptions} pluginOptions
 	 */
-	constructor(editor: __se__EditorCore, pluginOptions: AudioPluginOptions);
+	constructor(editor: SunEditor.Kernel, pluginOptions: AudioPluginOptions);
 	title: any;
-	icon: string;
 	pluginOptions: {
 		defaultWidth: string;
 		defaultHeight: string;
@@ -105,6 +110,7 @@ declare class Audio_ extends EditorInjector {
 		audioTagAttributes: {
 			[x: string]: string;
 		};
+		insertBehavior: SunEditor.ComponentInsertType;
 	};
 	modal: Modal;
 	controller: Controller;
@@ -118,152 +124,53 @@ declare class Audio_ extends EditorInjector {
 	audioUrlFile: HTMLInputElement;
 	/** @type {HTMLElement} */
 	preview: HTMLElement;
-	/** @type {HTMLAudioElement} */
-	_element: HTMLAudioElement;
-	defaultWidth: string;
-	defaultHeight: string;
-	urlValue: string;
-	/**
-	 * @editorMethod Modules.Modal
-	 * @description Executes the method that is called when a "Modal" module's is opened.
-	 */
-	open(): void;
-	/**
-	 * @editorMethod Modules.Modal
-	 * @description Executes the method that is called when a plugin's modal is opened.
-	 * @param {boolean} isUpdate "Indicates whether the modal is for editing an existing component (true) or registering a new one (false)."
-	 */
-	on(isUpdate: boolean): void;
-	/**
-	 * @editorMethod Editor.EventManager
-	 * @description Executes the event function of "paste" or "drop".
-	 * @param {Object} params { frameContext, event, file }
-	 * @param {__se__FrameContext} params.frameContext Frame context
-	 * @param {ClipboardEvent} params.event Event object
-	 * @param {File} params.file File object
-	 * @returns {boolean} - If return false, the file upload will be canceled
-	 */
-	onFilePasteAndDrop({ file }: { frameContext: __se__FrameContext; event: ClipboardEvent; file: File }): boolean;
-	/**
-	 * @editorMethod Modules.Modal
-	 * @description This function is called when a form within a modal window is "submit".
-	 * @returns {Promise<boolean>} Success or failure
-	 */
-	modalAction(): Promise<boolean>;
-	/**
-	 * @editorMethod Modules.Modal
-	 * @description This function is called before the modal window is opened, but before it is closed.
-	 */
-	init(): void;
-	/**
-	 * @editorMethod Modules.Controller
-	 * @description Executes the method that is called when a button is clicked in the "controller".
-	 * @param {HTMLButtonElement} target Target button element
-	 */
-	controllerAction(target: HTMLButtonElement): void;
-	/**
-	 * @editorMethod Editor.core
-	 * @description This method is used to validate and preserve the format of the component within the editor.
-	 * - It ensures that the structure and attributes of the element are maintained and secure.
-	 * - The method checks if the element is already wrapped in a valid container and updates its attributes if necessary.
-	 * - If the element isn't properly contained, a new container is created to retain the format.
-	 * @returns {{query: string, method: (element: HTMLAudioElement) => void}} The format retention object containing the query and method to process the element.
-	 * - query: The selector query to identify the relevant elements (in this case, 'audio').
-	 * - method:The function to execute on the element to validate and preserve its format.
-	 * - The function takes the element as an argument, checks if it is contained correctly, and applies necessary adjustments.
-	 */
 	retainFormat(): {
 		query: string;
-		method: (element: HTMLAudioElement) => void;
+		method: (element: HTMLElement) => void;
 	};
+	onFilePasteAndDrop(params: SunEditor.HookParams.FilePasteDrop): void;
+	modalOn(isUpdate: boolean): void;
+	modalAction(): Promise<boolean>;
+	modalInit(): void;
+	controllerAction(target: HTMLButtonElement): void;
+	componentSelect(target: HTMLElement): void | boolean;
+	componentDestroy(target: HTMLElement): Promise<void>;
 	/**
-	 * @editorMethod Editor.Component
-	 * @description Executes the method that is called when a component of a plugin is selected.
-	 * @param {HTMLElement} target Target component element
-	 */
-	select(target: HTMLElement): 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 {HTMLElement} target - The selected element.
-	 */
-	private _ready;
-	/**
-	 * @editorMethod Editor.Component
-	 * @description Method to delete a component of a plugin, called by the "FileManager", "Controller" module.
-	 * @param {HTMLElement=} target Target element, if null current selected element
-	 * @returns {Promise<void>}
-	 */
-	destroy(target?: HTMLElement | undefined): Promise<void>;
-	/**
-	 * @private
-	 * @description Registers uploaded audio files and creates the corresponding audio elements.
-	 * - Iterates through the uploaded files and inserts them into the editor.
-	 * @param {AudioInfo_audio} info - Upload metadata, including `isUpdate` flag and `element`.
-	 * @param {Object<string, *>} response - Server response containing uploaded file details.
-	 */
-	private _register;
-	/**
-	 * @description Create an "audio" component using the provided files.
+	 * @description Create an `audio` component using the provided files.
 	 * @param {FileList|File[]} fileList File object list
-	 * @returns {Promise<boolean>} If return false, the file upload will be canceled
+	 * @returns {Promise<boolean>} If return `false`, the file upload will be canceled
 	 */
 	submitFile(fileList: FileList | File[]): Promise<boolean>;
 	/**
-	 * @description Create an "audio" component using the provided url.
+	 * @description Create an `audio` component using the provided url.
 	 * @param {string} url File url
 	 * @returns {Promise<boolean>}
 	 */
 	submitURL(url: string): Promise<boolean>;
 	/**
-	 * @private
-	 * @description Creates or updates an audio component within the editor.
+	 * @description Creates or updates an `audio` component within the editor.
 	 * - If `isUpdate` is `true`, updates the existing element's `src`.
-	 * - Otherwise, inserts a new audio component with the given file.
-	 * @param {HTMLAudioElement} element - The target audio element.
+	 * - Otherwise, inserts a new `audio` component with the given file.
+	 * @param {HTMLAudioElement} element - The target `AUDIO` element.
 	 * @param {string} src - The source URL of the audio file.
 	 * @param {{name: string, size: number}} file - The file metadata (name, size).
 	 * @param {boolean} isUpdate - Whether to update an existing element.
-	 */
-	private _createComp;
-	/**
-	 * @private
-	 * @description Creates a new `<audio>` element with default attributes.
-	 * - Applies width, height, and additional attributes from plugin options.
-	 * @returns {HTMLAudioElement} - The newly created `<audio>` element.
-	 */
-	private _createAudioTag;
-	/**
-	 * @private
-	 * @description Sets attributes on an audio element based on plugin options.
-	 * - Adds the `controls` attribute and applies any custom attributes.
-	 * @param {HTMLElement} element - The `<audio>` element to modify.
-	 */
-	private _setTagAttrs;
-	/**
-	 * @private
-	 * @description Uploads audio files to the server.
-	 * - Sends a request to the configured upload URL and processes the response.
-	 * @param {AudioInfo_audio} info - Upload metadata, including `files` and `isUpdate`.
-	 * @param {FileList|File[]} files - The files to be uploaded.
-	 */
-	private _serverUpload;
-	/**
-	 * @private
-	 * @description Handles errors that occur during the audio upload process.
-	 * - Triggers the `onAudioUploadError` event to allow custom handling of errors.
-	 * - Displays an error message in the editor's UI.
-	 * - Logs the error to the console for debugging.
-	 * @param {Object<string, *>} response - The error response object from the server or upload process.
-	 * @returns {Promise<void>}
-	 */
-	private _error;
+	 * @param {boolean} isLast - Indicates whether this is the last file in the batch (used for scroll and insert actions).
+	 */
+	create(
+		element: HTMLAudioElement,
+		src: string,
+		file: {
+			name: string;
+			size: number;
+		},
+		isUpdate: boolean,
+		isLast: boolean,
+	): void;
 	#private;
 }
-import EditorInjector from '../../editorInjector';
-import { Modal } from '../../modules';
-import { Controller } from '../../modules';
-import { FileManager } from '../../modules';
-import { Figure } from '../../modules';
+import { PluginModal } from '../../interfaces';
+import { Modal } from '../../modules/contract';
+import { Controller } from '../../modules/contract';
+import { Figure } from '../../modules/contract';
+import { FileManager } from '../../modules/manager';