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

package/types/plugins/browser/audioGallery.d.ts

@@ -0,0 +1,55 @@
+export default AudioGallery;
+export type BrowserFile_audioGallery = import('../../modules/Browser').BrowserFile;
+/**
+ * @typedef {import('../../modules/Browser').BrowserFile} BrowserFile_audioGallery
+ */
+/**
+ * @class
+ * @extends EditorInjector
+ * @description Audio gallery plugin
+ */
+declare class AudioGallery extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+	 * @constructor
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {Object} pluginOptions
+	 * @param {Array<*>=} pluginOptions.data - direct data without server calls
+	 * @param {string} pluginOptions.url - server request url
+	 * @param {Object<string, string>=} pluginOptions.headers - server request headers
+	 * @param {string|((item: BrowserFile_audioGallery) => string)} pluginOptions.thumbnail - default thumbnail
+	 */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			data?: Array<any> | undefined;
+			url: string;
+			headers?:
+				| {
+						[x: string]: string;
+				  }
+				| undefined;
+			thumbnail: string | ((item: BrowserFile_audioGallery) => string);
+		}
+	);
+	title: any;
+	icon: string;
+	onSelectfunction: (targe: Node) => any;
+	browser: Browser;
+	/**
+	 * @editorMethod Modules.Browser
+	 * @description Executes the method that is called when a "Browser" module's is opened.
+	 * @param {?(targe: Node) => *=} onSelectfunction method to be executed after selecting an item in the gallery
+	 */
+	open(onSelectfunction?: (((targe: Node) => any) | null) | undefined): void;
+	/**
+	 * @editorMethod Modules.Browser
+	 * @description Executes the method that is called when a "Browser" module's is closed.
+	 */
+	close(): void;
+	#private;
+}
+import EditorInjector from '../../editorInjector';
+import { Browser } from '../../modules';

package/types/plugins/browser/fileBrowser.d.ts

@@ -0,0 +1,64 @@
+export default FileBrowser;
+export type BrowserFile_fileBrowser = import('../../modules/Browser').BrowserFile;
+/**
+ * @typedef {import('../../modules/Browser').BrowserFile} BrowserFile_fileBrowser
+ */
+/**
+ * @class
+ * @extends EditorInjector
+ * @description File browser plugin. Can contain any media type.
+ */
+declare class FileBrowser extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+	 * @constructor
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {Object} pluginOptions
+	 * @param {Object<string, *>|Array<*>=} pluginOptions.data - direct data without server calls
+	 * @param {string} pluginOptions.url - server request url
+	 * @param {Object<string, string>=} pluginOptions.headers - server request headers
+	 * @param {string|((item: BrowserFile_fileBrowser) => string)} pluginOptions.thumbnail - default thumbnail
+	 * @param {Array<string>} pluginOptions.props - additional tag names
+	 */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			data?:
+				| (
+						| {
+								[x: string]: any;
+						  }
+						| Array<any>
+				  )
+				| undefined;
+			url: string;
+			headers?:
+				| {
+						[x: string]: string;
+				  }
+				| undefined;
+			thumbnail: string | ((item: BrowserFile_fileBrowser) => string);
+			props: Array<string>;
+		}
+	);
+	title: any;
+	icon: string;
+	onSelectfunction: (targe: Node) => any;
+	browser: Browser;
+	/**
+	 * @editorMethod Modules.Browser
+	 * @description Executes the method that is called when a "Browser" module's is opened.
+	 * @param {?(targe: Node) => *=} onSelectfunction method to be executed after selecting an item in the gallery
+	 */
+	open(onSelectfunction?: (((targe: Node) => any) | null) | undefined): void;
+	/**
+	 * @editorMethod Modules.Browser
+	 * @description Executes the method that is called when a "Browser" module's is closed.
+	 */
+	close(): void;
+	#private;
+}
+import EditorInjector from '../../editorInjector';
+import { Browser } from '../../modules';

package/types/plugins/browser/fileGallery.d.ts

@@ -0,0 +1,55 @@
+export default FileGallery;
+export type BrowserFile_fileGallery = import('../../modules/Browser').BrowserFile;
+/**
+ * @typedef {import('../../modules/Browser').BrowserFile} BrowserFile_fileGallery
+ */
+/**
+ * @class
+ * @extends EditorInjector
+ * @description File gallery plugin
+ */
+declare class FileGallery extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+	 * @constructor
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {Object} pluginOptions
+	 * @param {Array<*>=} pluginOptions.data - direct data without server calls
+	 * @param {string} pluginOptions.url - server request url
+	 * @param {Object<string, string>=} pluginOptions.headers - server request headers
+	 * @param {string|((item: BrowserFile_fileGallery) => string)} pluginOptions.thumbnail - default thumbnail
+	 */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			data?: Array<any> | undefined;
+			url: string;
+			headers?:
+				| {
+						[x: string]: string;
+				  }
+				| undefined;
+			thumbnail: string | ((item: BrowserFile_fileGallery) => string);
+		}
+	);
+	title: any;
+	icon: string;
+	onSelectfunction: (targe: Node) => any;
+	browser: Browser;
+	/**
+	 * @editorMethod Modules.Browser
+	 * @description Executes the method that is called when a "Browser" module's is opened.
+	 * @param {?(targe: Node) => *=} onSelectfunction method to be executed after selecting an item in the gallery
+	 */
+	open(onSelectfunction?: (((targe: Node) => any) | null) | undefined): void;
+	/**
+	 * @editorMethod Modules.Browser
+	 * @description Executes the method that is called when a "Browser" module's is closed.
+	 */
+	close(): void;
+	#private;
+}
+import EditorInjector from '../../editorInjector';
+import { Browser } from '../../modules';

package/types/plugins/browser/imageGallery.d.ts

@@ -0,0 +1,51 @@
+export default ImageGallery;
+/**
+ * @class
+ * @extends EditorInjector
+ * @description Image gallery plugin
+ */
+declare class ImageGallery extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+	 * @constructor
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {Object} pluginOptions
+	 * @param {Array<*>=} pluginOptions.data - direct data without server calls
+	 * @param {string=} pluginOptions.url - server request url
+	 * @param {Object<string, string>=} pluginOptions.headers - server request headers
+	 */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			data?: Array<any> | undefined;
+			url?: string | undefined;
+			headers?:
+				| {
+						[x: string]: string;
+				  }
+				| undefined;
+		}
+	);
+	title: any;
+	icon: string;
+	onSelectfunction: (targe: Node) => any;
+	browser: Browser;
+	width: any;
+	height: any;
+	/**
+	 * @editorMethod Modules.Browser
+	 * @description Executes the method that is called when a "Browser" module's is opened.
+	 * @param {?(targe: Node) => *=} onSelectfunction method to be executed after selecting an item in the gallery
+	 */
+	open(onSelectfunction?: (((targe: Node) => any) | null) | undefined): void;
+	/**
+	 * @editorMethod Modules.Browser
+	 * @description Executes the method that is called when a "Browser" module's is closed.
+	 */
+	close(): void;
+	#private;
+}
+import EditorInjector from '../../editorInjector';
+import { Browser } from '../../modules';

package/types/plugins/browser/videoGallery.d.ts

@@ -0,0 +1,57 @@
+export default VideoGallery;
+export type BrowserFile_videoGallery = import('../../modules/Browser').BrowserFile;
+/**
+ * @typedef {import('../../modules/Browser').BrowserFile} BrowserFile_videoGallery
+ */
+/**
+ * @class
+ * @extends EditorInjector
+ * @description Video gallery plugin
+ */
+declare class VideoGallery extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+	 * @constructor
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {Object} pluginOptions
+	 * @param {Array<*>=} pluginOptions.data - direct data without server calls
+	 * @param {string=} pluginOptions.url - server request url
+	 * @param {Object<string, string>=} pluginOptions.headers - server request headers
+	 * @param {string|((item: BrowserFile_videoGallery) => string)} pluginOptions.thumbnail - default thumbnail
+	 */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			data?: Array<any> | undefined;
+			url?: string | undefined;
+			headers?:
+				| {
+						[x: string]: string;
+				  }
+				| undefined;
+			thumbnail: string | ((item: BrowserFile_videoGallery) => string);
+		}
+	);
+	title: any;
+	icon: string;
+	onSelectfunction: (targe: Node) => any;
+	browser: Browser;
+	width: any;
+	height: any;
+	/**
+	 * @editorMethod Modules.Browser
+	 * @description Executes the method that is called when a "Browser" module's is opened.
+	 * @param {?(targe: Node) => *=} onSelectfunction method to be executed after selecting an item in the gallery
+	 */
+	open(onSelectfunction?: (((targe: Node) => any) | null) | undefined): void;
+	/**
+	 * @editorMethod Modules.Browser
+	 * @description Executes the method that is called when a "Browser" module's is closed.
+	 */
+	close(): void;
+	#private;
+}
+import EditorInjector from '../../editorInjector';
+import { Browser } from '../../modules';

package/types/plugins/command/blockquote.d.ts

@@ -0,0 +1,28 @@
+export default Blockquote;
+/**
+ * @class
+ * @description Blockquote plugin
+ */
+declare class Blockquote extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	title: any;
+	icon: string;
+	quoteTag: HTMLElement;
+	/**
+	 * @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
+	 */
+	active(element?: (HTMLElement | null) | undefined, target?: (HTMLElement | null) | undefined): boolean;
+	/**
+	 * @editorMethod Editor.core
+	 * @description Executes the main execution method of the plugin.
+	 * - It is executed by clicking a toolbar "command" button or calling an API.
+	 */
+	action(): void;
+}
+import EditorInjector from '../../editorInjector';

package/types/plugins/command/exportPDF.d.ts

@@ -0,0 +1,46 @@
+export default ExportPDF;
+/**
+ * @class
+ * @description Export PDF plugin
+ */
+declare class ExportPDF extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+	 * @constructor
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {Object} pluginOptions - plugin options
+	 * @param {string} pluginOptions.apiUrl - server request url
+	 * @param {string} pluginOptions.fileName - file name
+	 */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			apiUrl: string;
+			fileName: string;
+		}
+	);
+	title: any;
+	icon: string;
+	apiUrl: string;
+	fileName: string;
+	apiManager: ApiManager;
+	/**
+	 * @editorMethod Editor.core
+	 * @description Executes the main execution method of the plugin.
+	 * - It is executed by clicking a toolbar "command" button or calling an API.
+	 * @returns {Promise<void>}
+	 */
+	action(): Promise<void>;
+	/**
+	 * @private
+	 * @description Sends the editor content to the server for PDF generation.
+	 * @param {HTMLElement} ww - A temporary container holding the formatted editor content.
+	 * @returns {Promise<void>} Resolves when the PDF file is successfully downloaded.
+	 * @throws {Error} Throws an error if the server response indicates a failure.
+	 */
+	private _createByServer;
+}
+import EditorInjector from '../../editorInjector';
+import { ApiManager } from '../../modules';

package/types/plugins/command/fileUpload.d.ts

@@ -0,0 +1,156 @@
+export default FileUpload;
+/**
+ * @class
+ * @description File upload plugin
+ */
+declare class FileUpload extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	static options: {
+		eventIndex: number;
+	};
+	/**
+	 * @this {FileUpload}
+	 * @param {HTMLElement} node - The node to check.
+	 * @returns {HTMLElement|null} Returns a node if the node is a valid component.
+	 */
+	static component(this: FileUpload, node: HTMLElement): HTMLElement | null;
+	/**
+	 * @constructor
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {Object} pluginOptions - plugin options
+	 * @param {string} pluginOptions.uploadUrl - server request url
+	 * @param {Object<string, string>=} pluginOptions.uploadHeaders - server request headers
+	 * @param {string=} pluginOptions.uploadSizeLimit - upload size limit
+	 * @param {string=} pluginOptions.uploadSingleSizeLimit - upload single size limit
+	 * @param {boolean=} pluginOptions.allowMultiple - allow multiple files
+	 * @param {string=} pluginOptions.acceptedFormats - accepted formats
+	 * @param {string=} pluginOptions.as - Whether to use the 'Box' or 'Link' conversion button
+	 * @param {Array<string>} pluginOptions.controls - Additional controls to be added to the figure
+	 */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			uploadUrl: string;
+			uploadHeaders?:
+				| {
+						[x: string]: string;
+				  }
+				| undefined;
+			uploadSizeLimit?: string | undefined;
+			uploadSingleSizeLimit?: string | undefined;
+			allowMultiple?: boolean | undefined;
+			acceptedFormats?: string | undefined;
+			as?: string | undefined;
+			controls: Array<string>;
+		}
+	);
+	title: any;
+	icon: string;
+	uploadUrl: string;
+	uploadHeaders: {
+		[x: string]: string;
+	};
+	uploadSizeLimit: number;
+	uploadSingleSizeLimit: number;
+	allowMultiple: boolean;
+	acceptedFormats: string;
+	_acceptedCheck: string[];
+	as: string;
+	input: HTMLElement;
+	_element: HTMLElement;
+	figure: Figure;
+	fileManager: FileManager;
+	controller: Controller;
+	editInput: HTMLInputElement;
+	/**
+	 * @editorMethod Editor.core
+	 * @description Executes the main execution method of the plugin.
+	 * - It is executed by clicking a toolbar "command" button or calling an API.
+	 */
+	action(): 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): boolean;
+	/**
+	 * @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.Controller
+	 * @description Executes the method that is called when a target component is edited.
+	 * @param {HTMLElement|Text} target Target element
+	 */
+	edit(target: HTMLElement | Text): 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.Component
+	 * @description Method to delete a component of a plugin, called by the "FileManager", "Controller" module.
+	 * @param {HTMLElement} target Target element
+	 * @returns {Promise<void>}
+	 */
+	destroy(target: HTMLElement): Promise<void>;
+	/**
+	 * @description Create an "file" component using the provided files.
+	 * @param {File[]|FileList} fileList File object list
+	 * @returns {Promise<boolean>} If return false, the file upload will be canceled
+	 */
+	submitFile(fileList: File[] | FileList): Promise<boolean>;
+	/**
+	 * @description Convert format to link or block
+	 * @param {HTMLElement} target Target element
+	 * @param {string} value 'link' or 'block'
+	 */
+	convertFormat(target: HTMLElement, value: string): void;
+	/**
+	 * @description Create file element
+	 * @param {string} url File URL
+	 * @param {File|{name: string, size: number}} file File object
+	 * @param {boolean} isLast Is last file
+	 */
+	create(
+		url: string,
+		file:
+			| File
+			| {
+					name: string;
+					size: number;
+			  },
+		isLast: boolean
+	): void;
+	/**
+	 * @private
+	 * @description Processes the server response after file upload.
+	 * - Registers the uploaded files in the editor.
+	 * @param {Object<string, *>} response - The response object from the server.
+	 */
+	private _register;
+	/**
+	 * @private
+	 * @description Handles file upload errors.
+	 * - Displays an error message if the upload fails.
+	 * @param {Object<string, *>} response - The error response from the server.
+	 * @returns {Promise<void>}
+	 */
+	private _error;
+	#private;
+}
+import EditorInjector from '../../editorInjector';
+import { Figure } from '../../modules';
+import { FileManager } from '../../modules';
+import { Controller } from '../../modules';

package/types/plugins/command/list_bulleted.d.ts

@@ -0,0 +1,46 @@
+export default List_bulleted;
+/**
+ * @class
+ * @description List bulleted plugin, Several types of lists are provided.
+ */
+declare class List_bulleted extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	title: any;
+	icon: string;
+	afterItem: HTMLElement;
+	listItems: NodeListOf<Element>;
+	/**
+	 * @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
+	 */
+	active(element?: (HTMLElement | null) | undefined, target?: (HTMLElement | null) | undefined): boolean;
+	/**
+	 * @editorMethod Modules.Dropdown
+	 * @description Executes the method that is called when a plugin's dropdown menu is opened.
+	 */
+	on(): 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;
+	/**
+	 * @editorMethod Editor.core
+	 * @description Executes methods called by shortcut keys.
+	 * @param {__se__PluginShortcutInfo} params - Information of the "shortcut" plugin
+	 */
+	shortcut({ range, info }: __se__PluginShortcutInfo): void;
+	/**
+	 * @description Add a bulleted list
+	 * @param {string} [type=""] List type
+	 */
+	submit(type?: string): void;
+}
+import EditorInjector from '../../editorInjector';

package/types/plugins/command/list_numbered.d.ts

@@ -0,0 +1,46 @@
+export default List_numbered;
+/**
+ * @class
+ * @description List numbered plugin, Several types of lists are provided.
+ */
+declare class List_numbered extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	title: any;
+	icon: string;
+	afterItem: HTMLElement;
+	listItems: NodeListOf<Element>;
+	/**
+	 * @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
+	 */
+	active(element?: (HTMLElement | null) | undefined, target?: (HTMLElement | null) | undefined): boolean;
+	/**
+	 * @editorMethod Modules.Dropdown
+	 * @description Executes the method that is called when a plugin's dropdown menu is opened.
+	 */
+	on(): 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;
+	/**
+	 * @editorMethod Editor.core
+	 * @description Executes methods called by shortcut keys.
+	 * @param {__se__PluginShortcutInfo} params - Information of the "shortcut" plugin
+	 */
+	shortcut({ range, info }: __se__PluginShortcutInfo): void;
+	/**
+	 * @description Add a numbered list
+	 * @param {string} [type=""] List type
+	 */
+	submit(type?: string): void;
+}
+import EditorInjector from '../../editorInjector';

package/types/plugins/dropdown/align.d.ts

@@ -0,0 +1,60 @@
+export default Align;
+/**
+ * @class
+ * @description Align plugin
+ */
+declare class Align extends EditorInjector {
+	static key: string;
+	static type: string;
+	static className: string;
+	/**
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 * @param {Object} pluginOptions
+	 * @param {Array.<"right"|"center"|"left"|"justify">} pluginOptions.items - Align items
+	 */
+	constructor(
+		editor: __se__EditorCore,
+		pluginOptions: {
+			items: Array<'right' | 'center' | 'left' | 'justify'>;
+		}
+	);
+	title: any;
+	icon: string;
+	_itemMenu: HTMLUListElement;
+	defaultDir: string;
+	alignIcons: {
+		justify: string;
+		left: string;
+		right: string;
+		center: string;
+	};
+	alignList: NodeListOf<Element>;
+	/**
+	 * @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
+	 */
+	active(element?: (HTMLElement | null) | undefined, target?: (HTMLElement | null) | undefined): boolean;
+	/**
+	 * @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 method called when the rtl, ltr mode changes. ("editor.setDir")
+	 * @param {string} dir Direction ("rtl" or "ltr")
+	 */
+	setDir(dir: string): 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;
+}
+import EditorInjector from '../../editorInjector';