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

package/types/modules/contract/Modal.d.ts

@@ -0,0 +1,62 @@
+import type {} from '../../typedef';
+export default Modal;
+/**
+ * @class
+ * @description Modal window module
+ */
+declare class Modal {
+	/**
+	 * @description Create a file input tag in the modal window.
+	 * @param {{icons: SunEditor.Deps['icons'], lang: SunEditor.Deps['lang']}} param0 - icons and language object
+	 * @param {{acceptedFormats?: string, allowMultiple?: boolean}} param1 - options
+	 * - acceptedFormats: `"image/*, video/*, audio/*"`, etc.
+	 * - allowMultiple: `true` or `false`
+	 * @returns {string} HTML string
+	 */
+	static CreateFileInput(
+		{
+			icons,
+			lang,
+		}: {
+			icons: SunEditor.Deps['icons'];
+			lang: SunEditor.Deps['lang'];
+		},
+		{
+			acceptedFormats,
+			allowMultiple,
+		}: {
+			acceptedFormats?: string;
+			allowMultiple?: boolean;
+		},
+	): string;
+	/**
+	 * @description A function called when the contents of `input` have changed and you want to adjust the style.
+	 * @param {Element} wrapper - Modal file input wrapper(`.se-flex-input-wrapper`)
+	 * @param {FileList|File[]} files - FileList object
+	 */
+	static OnChangeFile(wrapper: Element, files: FileList | File[]): void;
+	/**
+	 * @description Modal window module
+	 * @param {*} inst The instance object that called the constructor.
+	 * @param {SunEditor.Deps} $ Kernel dependencies
+	 * @param {Element} element Modal element
+	 */
+	constructor(inst: any, $: SunEditor.Deps, element: Element);
+	inst: any;
+	kind: any;
+	form: HTMLElement;
+	isUpdate: boolean;
+	/** @type {HTMLInputElement} */
+	focusElement: HTMLInputElement;
+	/**
+	 * @description Open a modal plugin
+	 * - The plugin's `init` method is called.
+	 */
+	open(): void;
+	/**
+	 * @description Close a modal plugin
+	 * - The plugin's `init` and `modalOff` method is called.
+	 */
+	close(): void;
+	#private;
+}

package/types/modules/contract/index.d.ts

@@ -0,0 +1,7 @@
+import type {} from '../../typedef';
+export { default as Browser } from './Browser.js';
+export { default as ColorPicker } from './ColorPicker.js';
+export { default as Controller } from './Controller.js';
+export { default as Figure } from './Figure.js';
+export { default as HueSlider } from './HueSlider.js';
+export { default as Modal } from './Modal.js';

package/types/modules/manager/ApiManager.d.ts

@@ -0,0 +1,106 @@
+import type {} from '../../typedef';
+export default ApiManager;
+export type ApiManagerParams = {
+	/**
+	 * - HTTP method (GET, POST, PUT, DELETE...)
+	 */
+	method?: string;
+	/**
+	 * - API's URL
+	 */
+	url?: string;
+	/**
+	 * - HTTP headers
+	 */
+	headers?: {
+		[x: string]: string;
+	};
+	/**
+	 * - API data
+	 */
+	data?: any;
+	/**
+	 * - API success callback
+	 */
+	callBack?: (xmlHttp: XMLHttpRequest) => boolean;
+	/**
+	 * - API fail callback
+	 */
+	errorCallBack?: (res: any, xmlHttp: XMLHttpRequest) => string;
+	/**
+	 * - XMLHttpRequest.responseType
+	 */
+	responseType?: XMLHttpRequestResponseType;
+};
+/**
+ * @typedef ApiManagerParams
+ * @property {string} [method] - HTTP method (GET, POST, PUT, DELETE...)
+ * @property {string} [url] - API's URL
+ * @property {Object<string, string>} [headers] - HTTP headers
+ * @property {*} [data] - API data
+ * @property {(xmlHttp: XMLHttpRequest) => boolean} [callBack] - API success callback
+ * @property {(res: *, xmlHttp: XMLHttpRequest) => string} [errorCallBack] - API fail callback
+ * @property {XMLHttpRequestResponseType} [responseType] - XMLHttpRequest.responseType
+ */
+/**
+ * @class
+ * @description API Manager
+ */
+declare class ApiManager {
+	/**
+	 * @constructor
+	 * @param {*} inst The instance object that called the constructor.
+	 * @param {SunEditor.Deps} $ Kernel dependencies
+	 * @param {ApiManagerParams} [params] API options
+	 */
+	constructor(inst: any, $: SunEditor.Deps, params?: ApiManagerParams);
+	/**
+	 * @description Caller instance key name
+	 * @type {string}
+	 */
+	kind: string;
+	method: string;
+	url: string;
+	headers: {
+		[x: string]: string;
+	};
+	data: any;
+	callBack: (xmlHttp: XMLHttpRequest) => boolean;
+	errorCallBack: (res: any, xmlHttp: XMLHttpRequest) => string;
+	responseType: XMLHttpRequestResponseType;
+	/**
+	 * @description Call API
+	 * @param {ApiManagerParams} params
+	 */
+	call({ method, url, headers, data, callBack, errorCallBack, responseType }: ApiManagerParams): void;
+	/**
+	 * @description Call Async API
+	 * @param {Object} params
+	 * @param {string} [params.method] - HTTP method (GET, POST, PUT, DELETE...)
+	 * @param {string} [params.url] - API's URL
+	 * @param {Object<string, string>} [params.headers] - HTTP headers
+	 * @param {*} [params.data] - API data
+	 * @param {XMLHttpRequestResponseType} [params.responseType] - XMLHttpRequest.responseType
+	 * @returns {Promise<XMLHttpRequest>}
+	 */
+	asyncCall({
+		method,
+		url,
+		headers,
+		data,
+		responseType,
+	}: {
+		method?: string;
+		url?: string;
+		headers?: {
+			[x: string]: string;
+		};
+		data?: any;
+		responseType?: XMLHttpRequestResponseType;
+	}): Promise<XMLHttpRequest>;
+	/**
+	 * @description Cancel API (xhr.abort())
+	 */
+	cancel(): void;
+	#private;
+}

package/types/modules/manager/FileManager.d.ts

@@ -0,0 +1,124 @@
+import type {} from '../../typedef';
+export default FileManager;
+export type FileManagerParams = {
+	/**
+	 * The query selector used to find file elements in the editor
+	 */
+	query: string;
+	/**
+	 * Event name for file load (e.g., `'onImageLoad'`)
+	 */
+	loadEventName: string;
+	/**
+	 * Event name for file action (e.g., `'onImageAction'`)
+	 */
+	actionEventName: string;
+};
+/**
+ * @typedef {Object} FileManagerParams
+ * @property {string} query The query selector used to find file elements in the editor
+ * @property {string} loadEventName Event name for file load (e.g., `'onImageLoad'`)
+ * @property {string} actionEventName Event name for file action (e.g., `'onImageAction'`)
+ */
+/**
+ * @class
+ * @description This module manages the file information of the editor.
+ */
+declare class FileManager {
+	/**
+	 * @constructor
+	 * @param {*} inst The instance object that called the constructor.
+	 * @param {SunEditor.Deps} $ Kernel dependencies
+	 * @param {FileManagerParams} params FileManager options
+	 */
+	constructor(inst: any, $: SunEditor.Deps, params: FileManagerParams);
+	kind: any;
+	inst: any;
+	query: string;
+	loadEventName: string;
+	actionEventName: string;
+	infoList: any[];
+	infoIndex: number;
+	uploadFileLength: number;
+	__updateTags: any[];
+	apiManager: ApiManager;
+	/**
+	 * @description Upload the file to the server.
+	 * @param {string} uploadUrl Upload server url
+	 * @param {?Object<string, string>} uploadHeader Request header
+	 * @param {FileList|File[]|{formData: FormData, size: number}} data FormData in body or Files array
+	 * @param {?(xmlHttp: XMLHttpRequest) => boolean} [callBack] Success call back function
+	 * @param {?(res: *, xmlHttp: XMLHttpRequest) => string} [errorCallBack] Error call back function
+	 */
+	upload(
+		uploadUrl: string,
+		uploadHeader: {
+			[x: string]: string;
+		} | null,
+		data:
+			| FileList
+			| File[]
+			| {
+					formData: FormData;
+					size: number;
+			  },
+		callBack?: ((xmlHttp: XMLHttpRequest) => boolean) | null,
+		errorCallBack?: ((res: any, xmlHttp: XMLHttpRequest) => string) | null,
+	): void;
+	/**
+	 * @description Upload the file to the server.
+	 * @param {string} uploadUrl Upload server url
+	 * @param {?Object<string, string>} uploadHeader Request header
+	 * @param {FileList|File[]|{formData: FormData, size: number}} data FormData in body or Files array
+	 * @returns {Promise<XMLHttpRequest>}
+	 */
+	asyncUpload(
+		uploadUrl: string,
+		uploadHeader: {
+			[x: string]: string;
+		} | null,
+		data:
+			| FileList
+			| File[]
+			| {
+					formData: FormData;
+					size: number;
+			  },
+	): Promise<XMLHttpRequest>;
+	/**
+	 * @description Set the file information to the element.
+	 * @param {Node} element File information element
+	 * @param {Object} params
+	 * @param {string} params.name File name
+	 * @param {number} params.size File size
+	 * @returns
+	 */
+	setFileData(
+		element: Node,
+		{
+			name,
+			size,
+		}: {
+			name: string;
+			size: number;
+		},
+	): void;
+	/**
+	 * @description Gets the sum of the sizes of the currently saved files.
+	 * @returns {number} Size
+	 */
+	getSize(): number;
+	/**
+	 * @internal
+	 * @description Checke the file's information and modify the tag that does not fit the format.
+	 * @param {boolean} loaded Whether the editor is loaded
+	 */
+	_checkInfo(loaded: boolean): void;
+	/**
+	 * @internal
+	 * @description Reset info object and `infoList = []`, `infoIndex = 0`
+	 */
+	_resetInfo(): void;
+	#private;
+}
+import ApiManager from './ApiManager';

package/types/modules/manager/index.d.ts

@@ -0,0 +1,3 @@
+import type {} from '../../typedef';
+export { default as ApiManager } from './ApiManager.js';
+export { default as FileManager } from './FileManager.js';

package/types/modules/ui/ModalAnchorEditor.d.ts

@@ -0,0 +1,152 @@
+import type {} from '../../typedef';
+export default ModalAnchorEditor;
+export type ModalAnchorEditorParams = {
+	/**
+	 * - Modal title display.
+	 */
+	title?: boolean;
+	/**
+	 * - Create Text to display input.
+	 */
+	textToDisplay?: boolean;
+	/**
+	 * - Default checked value of the "Open in new window" checkbox.
+	 */
+	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?: {
+		default?: string;
+		check_new_window?: string;
+		check_bookmark?: string;
+	};
+	/**
+	 * - File upload URL.
+	 */
+	uploadUrl?: string;
+	/**
+	 * - File upload headers.
+	 */
+	uploadHeaders?: {
+		[x: string]: string;
+	};
+	/**
+	 * - File upload size limit.
+	 */
+	uploadSizeLimit?: number;
+	/**
+	 * - File upload single size limit.
+	 */
+	uploadSingleSizeLimit?: number;
+	/**
+	 * - File upload accepted formats.
+	 */
+	acceptedFormats?: string;
+	/**
+	 * - If `true`, enables file upload.
+	 */
+	enableFileUpload?: boolean;
+};
+/**
+ * @typedef {Object} ModalAnchorEditorParams
+ * @property {boolean} [title=false] - Modal title display.
+ * @property {boolean} [textToDisplay=''] - Create Text to display input.
+ * @property {boolean} [openNewWindow=false] - Default checked value of the "Open in new window" checkbox.
+ * @property {boolean} [noAutoPrefix=false] - If `true`, disables the automatic prefixing of the host URL to the value of the link.
+ * @property {Array<string>} [relList=[]] - The `rel` attribute list of anchor tag.
+ * @property {{default?: string, check_new_window?: string, check_bookmark?: string}} [defaultRel={}] - Default `rel` attributes of anchor tag.
+ * @property {string} [uploadUrl] - File upload URL.
+ * @property {Object<string, string>} [uploadHeaders] - File upload headers.
+ * @property {number} [uploadSizeLimit] - File upload size limit.
+ * @property {number} [uploadSingleSizeLimit] - File upload single size limit.
+ * @property {string} [acceptedFormats] - File upload accepted formats.
+ * @property {boolean} [enableFileUpload] - If `true`, enables file upload.
+ */
+/**
+ * @class
+ * @description Modal form Anchor tag editor
+ * - Use it by inserting it into Modal in a plugin that uses Modal.
+ */
+declare class ModalAnchorEditor {
+	/**
+	 * @constructor
+	 * @param {SunEditor.Deps} $ Kernel dependencies
+	 * @param {HTMLElement} modalForm Modal <form>
+	 * @param {ModalAnchorEditorParams} params ModalAnchorEditor options
+	 */
+	constructor($: SunEditor.Deps, modalForm: HTMLElement, params: ModalAnchorEditorParams);
+	openNewWindow: boolean;
+	relList: string[];
+	defaultRel: {
+		default?: string;
+		check_new_window?: string;
+		check_bookmark?: string;
+	};
+	noAutoPrefix: boolean;
+	uploadUrl: string;
+	uploadHeaders: {
+		[x: string]: string;
+	};
+	uploadSizeLimit: number;
+	uploadSingleSizeLimit: number;
+	input: HTMLElement;
+	fileManager: FileManager;
+	host: string;
+	/** @type {HTMLInputElement} */
+	urlInput: HTMLInputElement;
+	/** @type {HTMLInputElement} */
+	displayInput: HTMLInputElement;
+	/** @type {HTMLInputElement} */
+	titleInput: HTMLInputElement;
+	/** @type {HTMLInputElement} */
+	newWindowCheck: HTMLInputElement;
+	/** @type {HTMLInputElement} */
+	downloadCheck: HTMLInputElement;
+	/** @type {HTMLElement} */
+	download: HTMLElement;
+	/** @type {HTMLElement} */
+	preview: HTMLElement;
+	/** @type {HTMLElement} */
+	bookmark: HTMLElement;
+	/** @type {HTMLButtonElement} */
+	bookmarkButton: HTMLButtonElement;
+	currentRel: any[];
+	currentTarget: HTMLAnchorElement;
+	linkValue: string;
+	/** @type {HTMLButtonElement} */
+	relButton: HTMLButtonElement;
+	/** @type {HTMLElement} */
+	relPreview: HTMLElement;
+	/**
+	 * @description Initialize.
+	 * - Sets the current anchor element to be edited.
+	 * @param {Node} element Modal target element
+	 */
+	set(element: Node): void;
+	/**
+	 * @description Opens the anchor editor modal and populates it with data.
+	 * @param {boolean} isUpdate - Indicates whether an existing anchor is being updated (`true`) or a new one is being created (`false`).
+	 */
+	on(isUpdate: boolean): void;
+	/**
+	 * @description Creates an anchor (`<a>`) element with the specified attributes.
+	 * @param {boolean} notText - If `true`, the anchor will not contain text content.
+	 * @returns {HTMLElement|null} - The newly created anchor element, or `null` if the URL is empty.
+	 */
+	create(notText: boolean): HTMLElement | null;
+	/**
+	 * @description Resets the ModalAnchorEditor to its initial state.
+	 */
+	init(): void;
+	#private;
+}
+import FileManager from '../manager/FileManager';

package/types/modules/ui/SelectMenu.d.ts

@@ -0,0 +1,107 @@
+import type {} from '../../typedef';
+export default SelectMenu;
+export type SelectMenuParams = {
+	/**
+	 * Position of the select menu, specified as `"[left|right]-[middle|top|bottom]"` or `"[top|bottom]-[center|left|right]"`
+	 */
+	position: string;
+	/**
+	 * Flag to determine if the checklist is enabled (`true` or `false`)
+	 */
+	checkList?: boolean;
+	/**
+	 * Optional text direction: `"rtl"` for right-to-left, `"ltr"` for left-to-right
+	 */
+	dir?: 'rtl' | 'ltr';
+	/**
+	 * Optional split number for horizontal positioning; defines how many items per row
+	 */
+	splitNum?: number;
+	/**
+	 * Optional method to call when the menu is opened
+	 */
+	openMethod?: () => void;
+	/**
+	 * Optional method to call when the menu is closed
+	 */
+	closeMethod?: () => void;
+};
+/**
+ * @typedef {Object} SelectMenuParams
+ * @property {string} position Position of the select menu, specified as `"[left|right]-[middle|top|bottom]"` or `"[top|bottom]-[center|left|right]"`
+ * @property {boolean} [checkList=false] Flag to determine if the checklist is enabled (`true` or `false`)
+ * @property {"rtl" | "ltr"} [dir="ltr"] Optional text direction: `"rtl"` for right-to-left, `"ltr"` for left-to-right
+ * @property {number} [splitNum=0] Optional split number for horizontal positioning; defines how many items per row
+ * @property {() => void} [openMethod] Optional method to call when the menu is opened
+ * @property {() => void} [closeMethod] Optional method to call when the menu is closed
+ */
+/**
+ * @class
+ * @description Creates a select menu
+ */
+declare class SelectMenu {
+	/**
+	 * @constructor
+	 * @param {SunEditor.Deps} $ Kernel dependencies
+	 * @param {SelectMenuParams} params SelectMenu options
+	 */
+	constructor($: SunEditor.Deps, params: SelectMenuParams);
+	form: HTMLElement;
+	items: any[];
+	/** @type {HTMLLIElement[]} */
+	menus: HTMLLIElement[];
+	menuLen: number;
+	index: number;
+	item: any;
+	isOpen: boolean;
+	checkList: boolean;
+	position: string;
+	subPosition: string;
+	splitNum: number;
+	horizontal: boolean;
+	openMethod: () => void;
+	closeMethod: () => void;
+	/**
+	 * @description Creates the select menu items.
+	 * @param {Array<string>|SunEditor.NodeCollection} items - Command list of selectable items.
+	 * @param {Array<string>|SunEditor.NodeCollection} [menus] - Optional list of menu display elements; defaults to `items`.
+	 */
+	create(items: Array<string> | SunEditor.NodeCollection, menus?: Array<string> | SunEditor.NodeCollection): void;
+	/**
+	 * @description Initializes the select menu and attaches it to a reference element.
+	 * @param {Node} referElement - The element that triggers the select menu.
+	 * @param {(command: string) => void} selectMethod - The function to execute when an item is selected.
+	 * @param {{class?: string, style?: string}} [attr={}] - Additional attributes for the select menu container.
+	 */
+	on(
+		referElement: Node,
+		selectMethod: (command: string) => void,
+		attr?: {
+			class?: string;
+			style?: string;
+		},
+	): void;
+	/**
+	 * @description Select menu open
+	 * @param {?string} [position] `"[left|right]-[middle|top|bottom] | [top|bottom]-[center|left|right]"`
+	 * @param {?string} [onItemQuerySelector] The querySelector string of the menu to be activated
+	 */
+	open(position?: string | null, onItemQuerySelector?: string | null): void;
+	/**
+	 * @description Select menu close
+	 */
+	close(): void;
+	/**
+	 * @description Get the index of the selected item
+	 * @param {number} index Item index
+	 * @returns
+	 */
+	getItem(index: number): any;
+	/**
+	 * @description Set the index of the selected item
+	 * @param {number} index Item index
+	 */
+	setItem(index: number): void;
+	_onItem: Element;
+	#private;
+}

package/types/modules/{_DragHandle.d.ts → ui/_DragHandle.d.ts}

@@ -1,3 +1,4 @@
+import type {} from '../../typedef';
 /**
  * @module _DragHandle
  * @description A module that handles drag and drop events.

package/types/modules/ui/index.d.ts

@@ -0,0 +1,4 @@
+import type {} from '../../typedef';
+export { default as _DragHandle } from './_DragHandle.js';
+export { default as ModalAnchorEditor } from './ModalAnchorEditor.js';
+export { default as SelectMenu } from './SelectMenu.js';

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

@@ -1,55 +1,47 @@
+import type {} from '../../typedef';
 export default AudioGallery;
-export type BrowserFile_audioGallery = import('../../modules/Browser').BrowserFile;
+export type AudioGalleryPluginOptions = {
+	/**
+	 * - 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_audioGallery
+ * @typedef {Object} AudioGalleryPluginOptions
+ * @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 Audio gallery plugin
  */
-declare class AudioGallery extends EditorInjector {
-	static key: string;
-	static type: string;
-	static className: string;
+declare class AudioGallery 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_audioGallery) => string)} pluginOptions.thumbnail - default thumbnail
+	 * @param {SunEditor.Kernel} kernel - The core kernel
+	 * @param {AudioGalleryPluginOptions} pluginOptions
 	 */
-	constructor(
-		editor: __se__EditorCore,
-		pluginOptions: {
-			data?: Array<any> | undefined;
-			url: string;
-			headers?:
-				| {
-						[x: string]: string;
-				  }
-				| undefined;
-			thumbnail: string | ((item: BrowserFile_audioGallery) => string);
-		}
-	);
+	constructor(kernel: SunEditor.Kernel, pluginOptions: AudioGalleryPluginOptions);
 	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';