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

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

@@ -1,64 +1,56 @@
+import type {} from '../../typedef';
 export default FileBrowser;
-export type BrowserFile_fileBrowser = import('../../modules/Browser').BrowserFile;
+export type FileBrowserPluginOptions = {
+	/**
+	 * - Direct data without server calls
+	 */
+	data?:
+		| {
+				[x: string]: any;
+		  }
+		| Array<any>;
+	/**
+	 * - Server request URL
+	 */
+	url?: string;
+	/**
+	 * - Server request headers
+	 */
+	headers?: {
+		[x: string]: string;
+	};
+	/**
+	 * - Default thumbnail
+	 */
+	thumbnail?: string | ((item: SunEditor.Module.Browser.File) => string);
+	/**
+	 * - Additional tag names
+	 */
+	props?: Array<string>;
+};
 /**
- * @typedef {import('../../modules/Browser').BrowserFile} BrowserFile_fileBrowser
+ * @typedef {Object} FileBrowserPluginOptions
+ * @property {Object<string, *>|Array<*>} [data] - Direct data without server calls
+ * @property {string} [url] - Server request URL
+ * @property {Object<string, string>} [headers] - Server request headers
+ * @property {string|((item: SunEditor.Module.Browser.File) => string)} [thumbnail] - Default thumbnail
+ * @property {Array<string>} [props] - Additional tag names
  */
 /**
  * @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;
+declare class FileBrowser extends PluginBrowser {
 	/**
 	 * @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
+	 * @param {SunEditor.Kernel} editor - The core kernel
+	 * @param {FileBrowserPluginOptions} pluginOptions
 	 */
-	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>;
-		}
-	);
+	constructor(editor: SunEditor.Kernel, pluginOptions: FileBrowserPluginOptions);
 	title: any;
-	icon: string;
-	onSelectfunction: (targe: Node) => any;
+	onSelectfunction: (target: 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';
+import { PluginBrowser } from '../../interfaces';
+import { Browser } from '../../modules/contract';

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

@@ -1,55 +1,47 @@
+import type {} from '../../typedef';
 export default FileGallery;
-export type BrowserFile_fileGallery = import('../../modules/Browser').BrowserFile;
+export type FileGalleryPluginOptions = {
+	/**
+	 * - Direct data without server calls
+	 */
+	data?: Array<SunEditor.Module.Browser.File>;
+	/**
+	 * - Server request URL
+	 */
+	url?: string;
+	/**
+	 * - Server request headers
+	 */
+	headers?: {
+		[x: string]: string;
+	};
+	/**
+	 * - Default thumbnail
+	 */
+	thumbnail?: string | ((item: SunEditor.Module.Browser.File) => string);
+};
 /**
- * @typedef {import('../../modules/Browser').BrowserFile} BrowserFile_fileGallery
+ * @typedef {Object} FileGalleryPluginOptions
+ * @property {Array<SunEditor.Module.Browser.File>} [data] - Direct data without server calls
+ * @property {string} [url] - Server request URL
+ * @property {Object<string, string>} [headers] - Server request headers
+ * @property {string|((item: SunEditor.Module.Browser.File) => string)} [thumbnail] - Default thumbnail
  */
 /**
  * @class
- * @extends EditorInjector
  * @description File gallery plugin
  */
-declare class FileGallery extends EditorInjector {
-	static key: string;
-	static type: string;
-	static className: string;
+declare class FileGallery extends PluginBrowser {
 	/**
 	 * @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
+	 * @param {SunEditor.Kernel} editor - The core kernel
+	 * @param {FileGalleryPluginOptions} pluginOptions
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			data?: Array<any> | undefined;
-			url: string;
-			headers?:
-				| {
-						[x: string]: string;
-				  }
-				| undefined;
-			thumbnail: string | ((item: BrowserFile_fileGallery) => string);
-		}
-	);
+	constructor(editor: SunEditor.Kernel, pluginOptions: FileGalleryPluginOptions);
 	title: any;
-	icon: string;
-	onSelectfunction: (targe: Node) => any;
+	onSelectfunction: (target: 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';
+import { PluginBrowser } from '../../interfaces';
+import { Browser } from '../../modules/contract';

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

@@ -1,51 +1,44 @@
+import type {} from '../../typedef';
 export default ImageGallery;
+export type ImageGalleryPluginOptions = {
+	/**
+	 * - Direct data without server calls
+	 */
+	data?: Array<any>;
+	/**
+	 * - Server request URL
+	 */
+	url?: string;
+	/**
+	 * - Server request headers
+	 */
+	headers?: {
+		[x: string]: string;
+	};
+};
+/**
+ * @typedef ImageGalleryPluginOptions
+ * @property {Array<*>} [data] - Direct data without server calls
+ * @property {string} [url] - Server request URL
+ * @property {Object<string, string>} [headers] - Server request headers
+ */
 /**
  * @class
- * @extends EditorInjector
  * @description Image gallery plugin
  */
-declare class ImageGallery extends EditorInjector {
-	static key: string;
-	static type: string;
-	static className: string;
+declare class ImageGallery extends PluginBrowser {
 	/**
 	 * @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 {SunEditor.Kernel} editor - The core kernel
+	 * @param {ImageGalleryPluginOptions} pluginOptions
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			data?: Array<any> | undefined;
-			url?: string | undefined;
-			headers?:
-				| {
-						[x: string]: string;
-				  }
-				| undefined;
-		}
-	);
+	constructor(editor: SunEditor.Kernel, pluginOptions: ImageGalleryPluginOptions);
 	title: any;
-	icon: string;
-	onSelectfunction: (targe: Node) => any;
+	onSelectfunction: (target: 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';
+import { PluginBrowser } from '../../interfaces';
+import { Browser } from '../../modules/contract';

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

@@ -1,57 +1,49 @@
+import type {} from '../../typedef';
 export default VideoGallery;
-export type BrowserFile_videoGallery = import('../../modules/Browser').BrowserFile;
+export type VideoGalleryPluginOptions = {
+	/**
+	 * - Direct data without server calls
+	 */
+	data?: Array<SunEditor.Module.Browser.File>;
+	/**
+	 * - Server request URL
+	 */
+	url?: string;
+	/**
+	 * - Server request headers
+	 */
+	headers?: {
+		[x: string]: string;
+	};
+	/**
+	 * - Default thumbnail
+	 */
+	thumbnail?: string | ((item: SunEditor.Module.Browser.File) => string);
+};
 /**
- * @typedef {import('../../modules/Browser').BrowserFile} BrowserFile_videoGallery
+ * @typedef {Object} VideoGalleryPluginOptions
+ * @property {Array<SunEditor.Module.Browser.File>} [data] - Direct data without server calls
+ * @property {string} [url] - Server request URL
+ * @property {Object<string, string>} [headers] - Server request headers
+ * @property {string|((item: SunEditor.Module.Browser.File) => string)} [thumbnail] - Default thumbnail
  */
 /**
  * @class
- * @extends EditorInjector
  * @description Video gallery plugin
  */
-declare class VideoGallery extends EditorInjector {
-	static key: string;
-	static type: string;
-	static className: string;
+declare class VideoGallery extends PluginBrowser {
 	/**
 	 * @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
+	 * @param {SunEditor.Kernel} editor - The core kernel
+	 * @param {VideoGalleryPluginOptions} pluginOptions
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			data?: Array<any> | undefined;
-			url?: string | undefined;
-			headers?:
-				| {
-						[x: string]: string;
-				  }
-				| undefined;
-			thumbnail: string | ((item: BrowserFile_videoGallery) => string);
-		}
-	);
+	constructor(editor: SunEditor.Kernel, pluginOptions: VideoGalleryPluginOptions);
 	title: any;
-	icon: string;
-	onSelectfunction: (targe: Node) => any;
+	onSelectfunction: (target: 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';
+import { PluginBrowser } from '../../interfaces';
+import { Browser } from '../../modules/contract';

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

@@ -1,29 +1,12 @@
+import type {} from '../../typedef';
 export default Blockquote;
 /**
  * @class
  * @description Blockquote plugin
  */
-declare class Blockquote extends EditorInjector {
-	static key: string;
-	static type: string;
-	static className: string;
+declare class Blockquote extends PluginCommand {
 	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
-	 * - 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.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;
+	active(element: HTMLElement | null, target: HTMLElement | null): boolean | void;
 }
-import EditorInjector from '../../editorInjector';
+import { PluginCommand } from '../../interfaces';

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

@@ -1,46 +1,36 @@
+import type {} from '../../typedef';
 export default ExportPDF;
+export type ExportPDFPluginOptions = {
+	/**
+	 * - Server request URL for PDF generation
+	 */
+	apiUrl: string;
+	/**
+	 * - Name of the generated PDF file
+	 */
+	fileName?: string;
+};
+/**
+ * @typedef ExportPDFPluginOptions
+ * @property {string} apiUrl - Server request URL for PDF generation
+ * @property {string} [fileName="suneditor-pdf"] - Name of the generated PDF file
+ */
 /**
  * @class
  * @description Export PDF plugin
  */
-declare class ExportPDF extends EditorInjector {
-	static key: string;
-	static type: string;
-	static className: string;
+declare class ExportPDF extends PluginCommand {
 	/**
 	 * @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
+	 * @param {SunEditor.Kernel} editor - The core kernel
+	 * @param {ExportPDFPluginOptions} pluginOptions - plugin options
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			apiUrl: string;
-			fileName: string;
-		}
-	);
+	constructor(editor: SunEditor.Kernel, pluginOptions: ExportPDFPluginOptions);
 	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;
+	#private;
 }
-import EditorInjector from '../../editorInjector';
-import { ApiManager } from '../../modules';
+import { PluginCommand } from '../../interfaces';
+import { ApiManager } from '../../modules/manager';