suneditor 3.0.5 → 3.0.6

package/types/langs/_Lang.d.ts

@@ -38,6 +38,7 @@ export type _Lang = {
 	caption: string;
 	cellProperties: string;
 	center: string;
+	clear: string;
 	close: string;
 	codeView: string;
 	color: string;

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

@@ -84,6 +84,19 @@ export type BrowserParams = {
 	useSearch?: boolean;
 	/**
 	 * - File server search url. Optional. Can be overridden in browser.
+	 * - Requested as `searchUrl + '?keyword=' + keyword`. The server must return:
+	 * ```js
+	 * {
+	 * "result": [
+	 * {
+	 * "src": "https://example.com/file.jpg",
+	 * "name": "file.jpg",
+	 * "thumbnail": "https://example.com/file_thumb.jpg",
+	 * "tag": ["photo"]
+	 * }
+	 * ]
+	 * }
+	 * ```
 	 */
 	searchUrl?: string;
 	/**
@@ -113,6 +126,10 @@ export type BrowserParams = {
 	 * - Optional. Can be overridden in browser. Default: 4.
 	 */
 	columnSize?: number;
+	/**
+	 * - Initial folder expand depth. `1` expands the first level, `Infinity` expands all. Default: `1`.
+	 */
+	expand?: number;
 	/**
 	 * - Default thumbnail
 	 */
@@ -142,6 +159,19 @@ export type BrowserParams = {
  * @property {(target: Node) => void} selectorHandler - Function that actions when an item is clicked. Required. Can be overridden in browser.
  * @property {boolean} [useSearch] - Whether to use the search function. Optional. Default: `true`.
  * @property {string} [searchUrl] - File server search url. Optional. Can be overridden in browser.
+ * - Requested as `searchUrl + '?keyword=' + keyword`. The server must return:
+ * ```js
+ * {
+ *   "result": [
+ *     {
+ *       "src": "https://example.com/file.jpg",
+ *       "name": "file.jpg",
+ *       "thumbnail": "https://example.com/file_thumb.jpg",
+ *       "tag": ["photo"]
+ *     }
+ *   ]
+ * }
+ * ```
  * @property {Object<string, string>} [searchUrlHeader] - File server search http header. Optional. Can be overridden in browser.
  * @property {string} [listClass] - Class name of list div. Required. Can be overridden in browser.
  * @property {(item: BrowserFile) => string} [drawItemHandler] - Function that returns HTML string for rendering each file item. Required. Can be overridden in browser.
@@ -152,6 +182,7 @@ export type BrowserParams = {
  * @property {Array<*>} [props] - `props` argument to `drawItemHandler` function. Optional. Can be overridden in browser.
  * @property {number} [columnSize] - Number of `div.se-file-item-column` to be created.
  * - Optional. Can be overridden in browser. Default: 4.
+ * @property {number} [expand=1] - Initial folder expand depth. `1` expands the first level, `Infinity` expands all. Default: `1`.
  * @property {((item: BrowserFile) => string)} [thumbnail] - Default thumbnail
  */
 /**
@@ -206,6 +237,7 @@ declare class Browser {
 	drawItemHandler: any;
 	selectorHandler: (target: Node) => void;
 	columnSize: number;
+	expand: number;
 	folderDefaultPath: string;
 	closeArrow: any;
 	openArrow: any;

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

@@ -25,7 +25,10 @@ export type ModalAnchorEditorParams = {
 	 * - 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?: {
@@ -35,6 +38,18 @@ export type ModalAnchorEditorParams = {
 	};
 	/**
 	 * - File upload URL.
+	 * - The server must return:
+	 * ```js
+	 * {
+	 * "result": [
+	 * {
+	 * "url": "https://example.com/file.pdf",
+	 * "name": "file.pdf",
+	 * "size": 1048576
+	 * }
+	 * ]
+	 * }
+	 * ```
 	 */
 	uploadUrl?: string;
 	/**
@@ -70,9 +85,24 @@ export type ModalAnchorEditorParams = {
  * @property {{default?: string, check_new_window?: string, check_bookmark?: string}} [defaultRel={}] - 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' }
+ * }
  * ```
  * @property {string} [uploadUrl] - File upload URL.
+ * - The server must return:
+ * ```js
+ * {
+ *   "result": [
+ *     {
+ *       "url": "https://example.com/file.pdf",
+ *       "name": "file.pdf",
+ *       "size": 1048576
+ *     }
+ *   ]
+ * }
+ * ```
  * @property {Object<string, string>} [uploadHeaders] - File upload headers.
  * @property {number} [uploadSizeLimit] - File upload size limit.
  * @property {number} [uploadSingleSizeLimit] - File upload single size limit.

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

@@ -7,6 +7,19 @@ export type AudioGalleryPluginOptions = {
 	data?: Array<SunEditor.Module.Browser.File>;
 	/**
 	 * - Server request URL
+	 * - The server must return:
+	 * ```js
+	 * {
+	 * "result": [
+	 * {
+	 * "src": "https://example.com/audio.mp3",
+	 * "name": "audio.mp3",
+	 * "thumbnail": "https://example.com/audio_icon.png",
+	 * "tag": ["music"]
+	 * }
+	 * ]
+	 * }
+	 * ```
 	 */
 	url?: string;
 	/**
@@ -24,6 +37,19 @@ export type AudioGalleryPluginOptions = {
  * @typedef {Object} AudioGalleryPluginOptions
  * @property {Array<SunEditor.Module.Browser.File>} [data] - Direct data without server calls
  * @property {string} [url] - Server request URL
+ * - The server must return:
+ * ```js
+ * {
+ *   "result": [
+ *     {
+ *       "src": "https://example.com/audio.mp3",
+ *       "name": "audio.mp3",
+ *       "thumbnail": "https://example.com/audio_icon.png",
+ *       "tag": ["music"]
+ *     }
+ *   ]
+ * }
+ * ```
  * @property {Object<string, string>} [headers] - Server request headers
  * @property {string|((item: SunEditor.Module.Browser.File) => string)} [thumbnail] - Default thumbnail
  */

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

@@ -11,6 +11,26 @@ export type FileBrowserPluginOptions = {
 		| Array<any>;
 	/**
 	 * - Server request URL
+	 * - The server must return a nested folder structure.
+	 * - `_data`: array (inline) or string URL (lazy-loaded on folder click).
+	 * - `"default": true` sets the initially selected folder.
+	 * ```js
+	 * {
+	 * "result": {
+	 * "root": {
+	 * "name": "Root",
+	 * "default": true,
+	 * "_data": [
+	 * { "src": "https://example.com/file1.pdf", "name": "file1.pdf" }
+	 * ],
+	 * "documents": {
+	 * "name": "Documents",
+	 * "_data": "https://api.example.com/files/documents"
+	 * }
+	 * }
+	 * }
+	 * }
+	 * ```
 	 */
 	url?: string;
 	/**
@@ -23,6 +43,10 @@ export type FileBrowserPluginOptions = {
 	 * - Default thumbnail URL or a function that returns a thumbnail URL per item.
 	 */
 	thumbnail?: string | ((item: SunEditor.Module.Browser.File) => string);
+	/**
+	 * - Initial folder expand depth. `1` expands the first level, `Infinity` expands all. Default: `1`.
+	 */
+	expand?: number;
 	/**
 	 * - Additional tag names
 	 * ```js
@@ -35,8 +59,29 @@ export type FileBrowserPluginOptions = {
  * @typedef {Object} FileBrowserPluginOptions
  * @property {Object<string, *>|Array<*>} [data] - Direct data without server calls (bypasses URL fetch).
  * @property {string} [url] - Server request URL
+ * - The server must return a nested folder structure.
+ * - `_data`: array (inline) or string URL (lazy-loaded on folder click).
+ * - `"default": true` sets the initially selected folder.
+ * ```js
+ * {
+ *   "result": {
+ *     "root": {
+ *       "name": "Root",
+ *       "default": true,
+ *       "_data": [
+ *         { "src": "https://example.com/file1.pdf", "name": "file1.pdf" }
+ *       ],
+ *       "documents": {
+ *         "name": "Documents",
+ *         "_data": "https://api.example.com/files/documents"
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
  * @property {Object<string, string>} [headers] - Server request headers
  * @property {string|((item: SunEditor.Module.Browser.File) => string)} [thumbnail] - Default thumbnail URL or a function that returns a thumbnail URL per item.
+ * @property {number} [expand=1] - Initial folder expand depth. `1` expands the first level, `Infinity` expands all. Default: `1`.
  * @property {Array<string>} [props] - Additional tag names
  * ```js
  * { url: '/api/files', headers: { Authorization: 'Bearer token' }, thumbnail: (item) => item.thumbUrl }

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

@@ -7,6 +7,20 @@ export type FileGalleryPluginOptions = {
 	data?: Array<SunEditor.Module.Browser.File>;
 	/**
 	 * - Server request URL
+	 * - The server must return:
+	 * ```js
+	 * {
+	 * "result": [
+	 * {
+	 * "src": "https://example.com/doc.pdf",
+	 * "name": "doc.pdf",
+	 * "thumbnail": "https://example.com/pdf_icon.png",
+	 * "type": "file", // video, image ..[plugin name]
+	 * "tag": ["document"]
+	 * }
+	 * ]
+	 * }
+	 * ```
 	 */
 	url?: string;
 	/**
@@ -24,6 +38,20 @@ export type FileGalleryPluginOptions = {
  * @typedef {Object} FileGalleryPluginOptions
  * @property {Array<SunEditor.Module.Browser.File>} [data] - Direct data without server calls
  * @property {string} [url] - Server request URL
+ * - The server must return:
+ * ```js
+ * {
+ *   "result": [
+ *     {
+ *       "src": "https://example.com/doc.pdf",
+ *       "name": "doc.pdf",
+ *       "thumbnail": "https://example.com/pdf_icon.png",
+ *       "type": "file", // video, image ..[plugin name]
+ *       "tag": ["document"]
+ *     }
+ *   ]
+ * }
+ * ```
  * @property {Object<string, string>} [headers] - Server request headers
  * @property {string|((item: SunEditor.Module.Browser.File) => string)} [thumbnail] - Default thumbnail
  */

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

@@ -7,6 +7,20 @@ export type ImageGalleryPluginOptions = {
 	data?: Array<any>;
 	/**
 	 * - Server request URL
+	 * - The server must return:
+	 * ```js
+	 * {
+	 * "result": [
+	 * {
+	 * "src": "https://example.com/img.jpg",
+	 * "name": "img.jpg",
+	 * "thumbnail": "https://example.com/img_thumb.jpg",
+	 * "alt": "description",
+	 * "tag": ["nature"]
+	 * }
+	 * ]
+	 * }
+	 * ```
 	 */
 	url?: string;
 	/**
@@ -20,6 +34,20 @@ export type ImageGalleryPluginOptions = {
  * @typedef ImageGalleryPluginOptions
  * @property {Array<*>} [data] - Direct data without server calls
  * @property {string} [url] - Server request URL
+ * - The server must return:
+ * ```js
+ * {
+ *   "result": [
+ *     {
+ *       "src": "https://example.com/img.jpg",
+ *       "name": "img.jpg",
+ *       "thumbnail": "https://example.com/img_thumb.jpg",
+ *       "alt": "description",
+ *       "tag": ["nature"]
+ *     }
+ *   ]
+ * }
+ * ```
  * @property {Object<string, string>} [headers] - Server request headers
  */
 /**

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

@@ -7,6 +7,20 @@ export type VideoGalleryPluginOptions = {
 	data?: Array<SunEditor.Module.Browser.File>;
 	/**
 	 * - Server request URL
+	 * - The server must return:
+	 * ```js
+	 * {
+	 * "result": [
+	 * {
+	 * "src": "https://example.com/video.mp4",
+	 * "name": "video.mp4",
+	 * "thumbnail": "https://example.com/video_thumb.jpg",
+	 * "frame": "video",
+	 * "tag": ["tutorial"]
+	 * }
+	 * ]
+	 * }
+	 * ```
 	 */
 	url?: string;
 	/**
@@ -24,6 +38,20 @@ export type VideoGalleryPluginOptions = {
  * @typedef {Object} VideoGalleryPluginOptions
  * @property {Array<SunEditor.Module.Browser.File>} [data] - Direct data without server calls
  * @property {string} [url] - Server request URL
+ * - The server must return:
+ * ```js
+ * {
+ *   "result": [
+ *     {
+ *       "src": "https://example.com/video.mp4",
+ *       "name": "video.mp4",
+ *       "thumbnail": "https://example.com/video_thumb.jpg",
+ *       "frame": "video",
+ *       "tag": ["tutorial"]
+ *     }
+ *   ]
+ * }
+ * ```
  * @property {Object<string, string>} [headers] - Server request headers
  * @property {string|((item: SunEditor.Module.Browser.File) => string)} [thumbnail] - Default thumbnail
  */

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

@@ -3,6 +3,18 @@ export default FileUpload;
 export type FileUploadPluginOptions = {
 	/**
 	 * - Server request URL for file upload
+	 * - The server must return:
+	 * ```js
+	 * {
+	 * "result": [
+	 * {
+	 * "url": "https://example.com/file.pdf",
+	 * "name": "file.pdf",
+	 * "size": 1048576
+	 * }
+	 * ]
+	 * }
+	 * ```
 	 */
 	uploadUrl: string;
 	/**
@@ -51,6 +63,18 @@ export type FileUploadPluginOptions = {
 /**
  * @typedef FileUploadPluginOptions
  * @property {string} uploadUrl - Server request URL for file upload
+ * - The server must return:
+ * ```js
+ * {
+ *   "result": [
+ *     {
+ *       "url": "https://example.com/file.pdf",
+ *       "name": "file.pdf",
+ *       "size": 1048576
+ *     }
+ *   ]
+ * }
+ * ```
  * @property {Object<string, string>} [uploadHeaders] - Server request headers
  * @property {number} [uploadSizeLimit] - Total upload size limit in bytes
  * @property {number} [uploadSingleSizeLimit] - Single file size limit in bytes

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

@@ -53,7 +53,7 @@ export type 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 {number} [delayTime=120] - 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

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

@@ -20,6 +20,18 @@ export type AudioPluginOptions = {
 	createUrlInput?: boolean;
 	/**
 	 * - The URL to which files will be uploaded.
+	 * - The server must return:
+	 * ```js
+	 * {
+	 * "result": [
+	 * {
+	 * "url": "https://example.com/audio.mp3",
+	 * "name": "audio.mp3",
+	 * "size": 3145728
+	 * }
+	 * ]
+	 * }
+	 * ```
 	 */
 	uploadUrl?: string;
 	/**
@@ -71,6 +83,18 @@ export type AudioPluginOptions = {
  * @property {boolean} [createUrlInput] - Whether to create a URL input element.
  * - Defaults to `true`. Always `true` when `createFileInput` is `false`.
  * @property {string} [uploadUrl] - The URL to which files will be uploaded.
+ * - The server must return:
+ * ```js
+ * {
+ *   "result": [
+ *     {
+ *       "url": "https://example.com/audio.mp3",
+ *       "name": "audio.mp3",
+ *       "size": 3145728
+ *     }
+ *   ]
+ * }
+ * ```
  * @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.

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

@@ -23,6 +23,18 @@ export type EmbedPluginOptions = {
 	percentageOnlySize?: boolean;
 	/**
 	 * - The URL for file uploads.
+	 * - The server must return:
+	 * ```js
+	 * {
+	 * "result": [
+	 * {
+	 * "url": "https://example.com/embed.html",
+	 * "name": "embed.html",
+	 * "size": 2048
+	 * }
+	 * ]
+	 * }
+	 * ```
 	 */
 	uploadUrl?: string;
 	/**
@@ -110,6 +122,18 @@ export type EmbedPluginOptions = {
  * @property {string} [defaultHeight] - The default height of the embed element (numeric value or with unit).
  * @property {boolean} [percentageOnlySize=false] - Whether to allow only percentage-based sizing.
  * @property {string} [uploadUrl] - The URL for file uploads.
+ * - The server must return:
+ * ```js
+ * {
+ *   "result": [
+ *     {
+ *       "url": "https://example.com/embed.html",
+ *       "name": "embed.html",
+ *       "size": 2048
+ *     }
+ *   ]
+ * }
+ * ```
  * @property {Object<string, string>} [uploadHeaders] - Headers to include in 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.

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

@@ -32,6 +32,18 @@ export type ImagePluginOptions = {
 	createUrlInput?: boolean;
 	/**
 	 * - The URL endpoint for image file uploads.
+	 * - The server must return:
+	 * ```js
+	 * {
+	 * "result": [
+	 * {
+	 * "url": "https://example.com/image.jpg",
+	 * "name": "image.jpg",
+	 * "size": 123456
+	 * }
+	 * ]
+	 * }
+	 * ```
 	 */
 	uploadUrl?: string;
 	/**
@@ -116,6 +128,18 @@ export type ImageState = {
  * @property {boolean} [createUrlInput] - Whether to create a URL input element for image insertion.
  * - Defaults to `true`. Always `true` when `createFileInput` is `false`.
  * @property {string} [uploadUrl] - The URL endpoint for image file uploads.
+ * - The server must return:
+ * ```js
+ * {
+ *   "result": [
+ *     {
+ *       "url": "https://example.com/image.jpg",
+ *       "name": "image.jpg",
+ *       "size": 123456
+ *     }
+ *   ]
+ * }
+ * ```
  * @property {Object<string, string>} [uploadHeaders] - Additional headers to include in the file upload request.
  * ```js
  * { uploadUrl: '/api/upload/image', uploadHeaders: { Authorization: 'Bearer token' } }

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.