suneditor 3.0.4 → 3.0.6

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.