suneditor 3.0.5 → 3.1.0

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

@@ -3,6 +3,18 @@ export default Link;
 export type LinkOptions = {
 	/**
 	 * - The URL endpoint for file uploads.
+	 * - The server must return:
+	 * ```js
+	 * {
+	 * "result": [
+	 * {
+	 * "url": "https://example.com/file.pdf",
+	 * "name": "file.pdf",
+	 * "size": 1048576
+	 * }
+	 * ]
+	 * }
+	 * ```
 	 */
 	uploadUrl?: string;
 	/**
@@ -28,6 +40,18 @@ export type LinkPluginOptions = Omit<LinkOptions & import('../../modules/ui/Moda
 /**
  * @typedef {Object} LinkOptions
  * @property {string} [uploadUrl] - The URL endpoint for file uploads.
+ * - The server must return:
+ * ```js
+ * {
+ *   "result": [
+ *     {
+ *       "url": "https://example.com/file.pdf",
+ *       "name": "file.pdf",
+ *       "size": 1048576
+ *     }
+ *   ]
+ * }
+ * ```
  * @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.
@@ -87,7 +111,10 @@ declare class Link extends PluginModal {
 		 * - Default `rel` values auto-applied by condition.
 		 * `default` is always applied, `check_new_window` when "Open in new window" is checked, `check_bookmark` for bookmark links.
 		 * ```js
-		 * { relList: ['nofollow', 'noreferrer', 'noopener'], defaultRel: { default: 'noopener', check_new_window: 'noreferrer' } }
+		 * {
+		 * relList: ['nofollow', 'noreferrer', 'noopener'],
+		 * defaultRel: { default: 'noopener', check_new_window: 'noreferrer' }
+		 * }
 		 * ```
 		 */
 		defaultRel?: {

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

@@ -32,6 +32,18 @@ export type VideoPluginOptions = {
 	createUrlInput?: boolean;
 	/**
 	 * - The URL endpoint for video file uploads.
+	 * - The server must return:
+	 * ```js
+	 * {
+	 * "result": [
+	 * {
+	 * "url": "https://example.com/video.mp4",
+	 * "name": "video.mp4",
+	 * "size": 5242880
+	 * }
+	 * ]
+	 * }
+	 * ```
 	 */
 	uploadUrl?: string;
 	/**
@@ -155,6 +167,18 @@ export type VideoState = {
  * @property {boolean} [createUrlInput] - Whether to create a URL input element for video embedding.
  * - Defaults to `true`. Always `true` when `createFileInput` is `false`.
  * @property {string} [uploadUrl] - The URL endpoint for video file uploads.
+ * - The server must return:
+ * ```js
+ * {
+ *   "result": [
+ *     {
+ *       "url": "https://example.com/video.mp4",
+ *       "name": "video.mp4",
+ *       "size": 5242880
+ *     }
+ *   ]
+ * }
+ * ```
  * @property {Object<string, string>} [uploadHeaders] - Additional headers to include in the video upload request.
  * @property {number} [uploadSizeLimit] - The total upload size limit for videos in bytes.
  * @property {number} [uploadSingleSizeLimit] - The single file upload size limit for videos in bytes.

package/types/typedef.d.ts

@@ -306,7 +306,7 @@ declare global {
 				| 'fileUpload'
 				| 'list_bulleted'
 				| 'list_numbered'
-				| 'mention'
+				| 'autocomplete'
 				| 'align'
 				| 'font'
 				| 'fontColor'

package/src/plugins/field/mention.js

@@ -1,251 +0,0 @@
-import { PluginField } from '../../interfaces';
-import { Controller } from '../../modules/contract';
-import { ApiManager } from '../../modules/manager';
-import { SelectMenu } from '../../modules/ui';
-import { dom, converter } from '../../helper';
-
-const { debounce } = converter;
-
-/**
- * @typedef {Object} MentionPluginOptions
- * @property {string} [triggerText="@"] - The character that triggers the mention list.
- * @property {number} [limitSize=5] - The number of items to display in the mention list
- * @property {number} [searchStartLength=0] - The number of characters to start searching for the mention list
- * @property {number} [delayTime=200] - The time to wait before displaying the mention list
- * @property {Array<{key: string, name: string, url: string}>} [data] - Static mention data (used instead of API).
- * ```js
- * // data
- * [{ key: 'john', name: 'John Doe', url: '/users/john' }]
- * ```
- * @property {string} [apiUrl] - The URL to call the mention list
- * @property {Object<string, string>} [apiHeaders] - The headers to send with the API call
- * @property {boolean} [useCachingData=true] - Whether to cache the mention list data
- * @property {boolean} [useCachingFieldData=true] - Whether to cache the mention list data in the field
- */
-
-/**
- * @class
- * @description Mention Plugin
- * - A plugin that provides a mention feature using `@` or a custom trigger character.
- * - Displays a mention list when the trigger character is typed.
- * - Supports fetching mention data from an API or a predefined data array.
- * - Uses caching for optimized performance.
- */
-class Mention extends PluginField {
-	static key = 'mention';
-	static className = '';
-
-	#lastAtPos = 0;
-	#anchorOffset = 0;
-	#anchorNode = null;
-
-	/**
-	 * @constructor
-	 * @param {SunEditor.Kernel} kernel - The Kernel instance
-	 * @param {MentionPluginOptions} pluginOptions
-	 */
-	constructor(kernel, pluginOptions) {
-		super(kernel);
-		// plugin basic properties
-		this.title = this.$.lang.mention;
-		this.icon = 'mention';
-
-		// members
-		this.triggerText = pluginOptions.triggerText || '@';
-		this.limitSize = pluginOptions.limitSize || 5;
-		this.searchStartLength = pluginOptions.searchStartLength || 0;
-		this.delayTime = typeof pluginOptions.delayTime === 'number' ? pluginOptions.delayTime : 200;
-		this.directData = pluginOptions.data;
-		this.apiUrl = pluginOptions.apiUrl?.replace(/\s/g, '').replace(/\{limitSize\}/i, String(this.limitSize)) || '';
-		// members - api, caching
-		this.apiManager = new ApiManager(this, this.$, { headers: pluginOptions.apiHeaders });
-		this.cachingData = (pluginOptions.useCachingData ?? true) ? new Map() : null;
-		this.cachingFieldData = (pluginOptions.useCachingFieldData ?? true) ? [] : null;
-
-		// controller
-		const controllerEl = CreateHTML_controller();
-		this.selectMenu = new SelectMenu(this.$, { position: 'right-bottom', dir: 'ltr', closeMethod: () => this.controller.close() });
-		this.controller = new Controller(
-			this,
-			this.$,
-			controllerEl,
-			{
-				position: 'bottom',
-				initMethod: () => {
-					this.apiManager.cancel();
-					this.selectMenu.close();
-				},
-			},
-			null,
-		);
-		this.selectMenu.on(controllerEl.firstElementChild, this.#SelectMention.bind(this));
-
-		// onInput debounce
-		this.onInput = debounce(this.onInput.bind(this), this.delayTime);
-	}
-
-	/**
-	 * @hook Editor.EventManager
-	 * @type {SunEditor.Hook.Event.OnInputAsync}
-	 */
-	async onInput() {
-		if (!this.directData) {
-			this.apiManager.cancel();
-		}
-
-		const sel = this.$.selection.get();
-		if (!sel.rangeCount) {
-			this.selectMenu.close();
-			return;
-		}
-
-		const anchorNode = sel.anchorNode;
-		const anchorOffset = sel.anchorOffset;
-		const textBeforeCursor = anchorNode.textContent.substring(0, anchorOffset);
-		const lastAtPos = textBeforeCursor.lastIndexOf(this.triggerText);
-
-		if (lastAtPos > -1) {
-			const mentionQuery = textBeforeCursor.substring(lastAtPos + 1, anchorOffset);
-			const beforeText = textBeforeCursor[lastAtPos - 1]?.trim();
-			if (!/\s/.test(mentionQuery) && (!beforeText || dom.check.isZeroWidth(beforeText))) {
-				if (mentionQuery.length < this.searchStartLength) return;
-
-				const anchorParent = anchorNode.parentNode;
-				if (dom.check.isAnchor(anchorParent) && !anchorParent.getAttribute('data-se-mention')) {
-					return;
-				}
-
-				try {
-					await this.#createMentionList(mentionQuery, anchorNode);
-					this.#lastAtPos = lastAtPos;
-					this.#anchorNode = anchorNode;
-					this.#anchorOffset = anchorOffset;
-					return;
-				} catch (error) {
-					console.warn('[SUNEDITOR.mention.api.file] ', error);
-				}
-			}
-		}
-
-		this.selectMenu.close();
-	}
-
-	/**
-	 * @description Generates the mention list based on user input.
-	 * - Fetches data from cache, direct data, or an API.
-	 * - Creates and opens the mention dropdown.
-	 * - Caches the fetched data for future use.
-	 * @param {string} value - The mention query text.
-	 * @param {Node} targetNode - The node where the mention is triggered.
-	 * @returns {Promise<boolean>} - Returns `true` if the mention list is displayed, `false` otherwise.
-	 */
-	async #createMentionList(value, targetNode) {
-		const limit = this.limitSize;
-		const lowerValue = value.toLowerCase();
-		let response = null;
-		if (this.cachingData) {
-			response = this.cachingData.get(value);
-		}
-
-		if (!response) {
-			if (this.directData) {
-				response = this.directData.filter((item) => item.key.toLowerCase().startsWith(lowerValue)).slice(0, limit);
-			} else {
-				const xmlHttp = await this.apiManager.asyncCall({ method: 'GET', url: this.#createUrl(value) });
-				response = JSON.parse(xmlHttp.responseText);
-			}
-		}
-
-		if (this.cachingFieldData) {
-			const uniqueKeys = new Set();
-			response = this.cachingFieldData
-				.concat(response)
-				.filter(({ key }) => {
-					if (uniqueKeys.has(key)) return false;
-					uniqueKeys.add(key);
-					return key.toLowerCase().startsWith(lowerValue);
-				})
-				.slice(0, limit);
-		}
-
-		if (!response?.length) {
-			this.selectMenu.close();
-			return false;
-		}
-
-		const list = [];
-		const menus = [];
-		for (let i = 0, len = response.length, v; i < len; i++) {
-			v = response[i];
-			list.push(v);
-			menus.push(`<div class="se-mention-item"><span>${v.key}</span><span>${v.name}</span></div>`);
-		}
-
-		if (list.length === 0) {
-			this.selectMenu.close();
-			return false;
-		} else {
-			// controller open
-			this.controller.open(targetNode, null, { isWWTarget: true, initMethod: null, addOffset: null });
-			// select menu create
-			this.selectMenu.create(list, menus);
-			this.selectMenu.open();
-			this.selectMenu.setItem(0);
-			if (this.cachingData) this.cachingData.set(value, list);
-			return true;
-		}
-	}
-
-	/**
-	 * @description Constructs the API request URL with the mention query.
-	 * @param {string} key - The mention query text.
-	 * @returns {string} - The formatted API request URL.
-	 */
-	#createUrl(key) {
-		return this.apiUrl.replace(/\{key\}/i, key);
-	}
-
-	/**
-	 * @description Inserts a mention link into the editor when a user selects a mention from the list.
-	 * @param {{ key: string, name: string, url: string }} item - The selected mention item.
-	 * @returns {boolean} Returns `false` if insertion fails, otherwise completes execution.
-	 */
-	#SelectMention(item) {
-		if (!item) return false;
-
-		let oA = null;
-		const { key, name, url } = item;
-		const anchorParent = this.#anchorNode.parentNode;
-
-		if (dom.check.isAnchor(anchorParent)) {
-			oA = anchorParent;
-			oA.setAttribute('data-se-mention', key);
-			oA.setAttribute('href', url);
-			oA.setAttribute('title', name);
-			oA.textContent = this.triggerText + key;
-		} else {
-			this.$.selection.setRange(this.#anchorNode, this.#lastAtPos, this.#anchorNode, this.#anchorOffset);
-			oA = dom.utils.createElement('A', { 'data-se-mention': key, href: url, title: name, target: '_blank' }, this.triggerText + key);
-			if (!this.$.html.insertNode(oA, { afterNode: null, skipCharCount: false })) return false;
-		}
-
-		this.selectMenu.close();
-
-		const space = dom.utils.createTextNode('\u00A0');
-		oA.parentNode.insertBefore(space, oA.nextSibling);
-		this.$.selection.setRange(space, 1, space, 1);
-
-		if (this.cachingFieldData && !this.cachingFieldData.some((data) => data.key === item.key)) {
-			this.cachingFieldData.push(item);
-		}
-	}
-}
-
-/**
- * @returns {HTMLElement}
- */
-function CreateHTML_controller() {
-	return dom.utils.createElement('DIV', { class: 'se-controller se-empty-controller' }, '<div></div>');
-}
-
-export default Mention;

package/types/plugins/field/mention.d.ts

@@ -1,104 +0,0 @@
-import type {} from '../../typedef';
-export default Mention;
-export type MentionPluginOptions = {
-	/**
-	 * - The character that triggers the mention list.
-	 */
-	triggerText?: string;
-	/**
-	 * - The number of items to display in the mention list
-	 */
-	limitSize?: number;
-	/**
-	 * - The number of characters to start searching for the mention list
-	 */
-	searchStartLength?: number;
-	/**
-	 * - The time to wait before displaying the mention list
-	 */
-	delayTime?: number;
-	/**
-	 * - Static mention data (used instead of API).
-	 * ```js
-	 * // data
-	 * [{ key: 'john', name: 'John Doe', url: '/users/john' }]
-	 * ```
-	 */
-	data?: Array<{
-		key: string;
-		name: string;
-		url: string;
-	}>;
-	/**
-	 * - The URL to call the mention list
-	 */
-	apiUrl?: string;
-	/**
-	 * - The headers to send with the API call
-	 */
-	apiHeaders?: {
-		[x: string]: string;
-	};
-	/**
-	 * - Whether to cache the mention list data
-	 */
-	useCachingData?: boolean;
-	/**
-	 * - Whether to cache the mention list data in the field
-	 */
-	useCachingFieldData?: boolean;
-};
-/**
- * @typedef {Object} MentionPluginOptions
- * @property {string} [triggerText="@"] - The character that triggers the mention list.
- * @property {number} [limitSize=5] - The number of items to display in the mention list
- * @property {number} [searchStartLength=0] - The number of characters to start searching for the mention list
- * @property {number} [delayTime=200] - The time to wait before displaying the mention list
- * @property {Array<{key: string, name: string, url: string}>} [data] - Static mention data (used instead of API).
- * ```js
- * // data
- * [{ key: 'john', name: 'John Doe', url: '/users/john' }]
- * ```
- * @property {string} [apiUrl] - The URL to call the mention list
- * @property {Object<string, string>} [apiHeaders] - The headers to send with the API call
- * @property {boolean} [useCachingData=true] - Whether to cache the mention list data
- * @property {boolean} [useCachingFieldData=true] - Whether to cache the mention list data in the field
- */
-/**
- * @class
- * @description Mention Plugin
- * - A plugin that provides a mention feature using `@` or a custom trigger character.
- * - Displays a mention list when the trigger character is typed.
- * - Supports fetching mention data from an API or a predefined data array.
- * - Uses caching for optimized performance.
- */
-declare class Mention extends PluginField {
-	/**
-	 * @constructor
-	 * @param {SunEditor.Kernel} kernel - The Kernel instance
-	 * @param {MentionPluginOptions} pluginOptions
-	 */
-	constructor(kernel: SunEditor.Kernel, pluginOptions: MentionPluginOptions);
-	title: any;
-	triggerText: string;
-	limitSize: number;
-	searchStartLength: number;
-	delayTime: number;
-	directData: {
-		key: string;
-		name: string;
-		url: string;
-	}[];
-	apiUrl: string;
-	apiManager: ApiManager;
-	cachingData: Map<any, any>;
-	cachingFieldData: any[];
-	selectMenu: SelectMenu;
-	controller: Controller;
-	onInput(params: SunEditor.HookParams.InputWithData): Promise<void>;
-	#private;
-}
-import { PluginField } from '../../interfaces';
-import { Controller } from '../../modules/contract';
-import { ApiManager } from '../../modules/manager';
-import { SelectMenu } from '../../modules/ui';