suneditor 3.0.0-alpha.2 → 3.0.0-alpha.20

package/src/modules/ApiManager.js

@@ -1,44 +1,60 @@
 import { env } from '../helper';
 
 /**
- *
- * @param {*} inst
- * @param {Object|null=} params
- * @param {string|null=} params.method - HTTP method (GET, POST, PUT, DELETE...)
- * @param {string|null=} params.url - API's URL
- * @param {Object|null=} params.headers - HTTP headers
- * @param {Object|null=} params.data - API data
- * @param {Function|null=} params.callBack - API success callback
- * @param {Function|null=} params.errorCallBack - API fail callback
- * @param {string|null=} params.responseType - XMLHttpRequest.responseType
+ * @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
  */
-const ApiManager = function (inst, params) {
-	this.editor = inst.editor;
-	this.kind = inst.constructor.key || inst.constructor.name;
-
-	// members
-	this._xhr = env.getXMLHttpRequest();
-	// members - option
-	this.method = params?.method;
-	this.url = params?.url;
-	this.headers = params?.headers;
-	this.data = params?.data;
-	this.callBack = params?.callBack;
-	this.errorCallBack = params?.errorCallBack;
-	this.responseType = params?.responseType;
-};
-
-ApiManager.prototype = {
+
+/**
+ * @class
+ * @description API Manager
+ */
+class ApiManager {
+	/**
+	 * @constructor
+	 * @param {*} inst The instance object that called the constructor.
+	 * @param {ApiManagerParams=} params API options
+	 */
+	constructor(inst, params) {
+		/**
+		 * @description Editor instance
+		 * @type {__se__EditorCore}
+		 */
+		this.editor = inst.editor;
+
+		/**
+		 * @description UI class
+		 * @type {__se__EditorCore["ui"]}
+		 */
+		this.ui = this.editor.ui;
+
+		/**
+		 * @description Caller instance key name
+		 * @type {string}
+		 */
+		this.kind = inst.constructor.key || inst.constructor.name;
+
+		// members
+		this._xhr = env.getXMLHttpRequest();
+		// members - option
+		this.method = params?.method;
+		this.url = params?.url;
+		this.headers = params?.headers;
+		this.data = params?.data;
+		this.callBack = params?.callBack;
+		this.errorCallBack = params?.errorCallBack;
+		this.responseType = params?.responseType;
+	}
+
 	/**
 	 * @description Call API
-	 * @param {Object|null=} params
-	 * @param {string|null=} params.method - HTTP method (GET, POST, PUT, DELETE...)
-	 * @param {string|null=} params.url - API's URL
-	 * @param {Object|null=} params.headers - HTTP headers
-	 * @param {Object|null=} params.data - API data
-	 * @param {Function|null=} params.callBack - API success callback
-	 * @param {Function|null=} params.errorCallBack - API fail callback
-	 * @param {string|null=} params.responseType - XMLHttpRequest.responseType
+	 * @param {ApiManagerParams} params
 	 */
 	call({ method, url, headers, data, callBack, errorCallBack, responseType }) {
 		this.cancel();
@@ -62,16 +78,17 @@ ApiManager.prototype = {
 		}
 
 		xhr.send(data);
-	},
+	}
 
 	/**
 	 * @description Call Async API
-	 * @param {Object|null=} params
-	 * @param {string|null=} params.method - HTTP method (GET, POST, PUT, DELETE...)
-	 * @param {string|null=} params.url - API's URL
-	 * @param {Object|null=} params.headers - HTTP headers
-	 * @param {Object|null=} params.data - API data
-	 * @param {string|null=} params.responseType - XMLHttpRequest.responseType
+	 * @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 }) {
 		this.cancel();
@@ -84,6 +101,7 @@ ApiManager.prototype = {
 
 		const xhr = this._xhr;
 		if (responseType) xhr.responseType = responseType;
+
 		return new Promise((resolve, reject) => {
 			xhr.open(method, url, true);
 			if (headers !== null && typeof headers === 'object' && Object.keys(headers).length > 0) {
@@ -96,14 +114,14 @@ ApiManager.prototype = {
 					try {
 						resolve(xhr);
 					} finally {
-						this.editor.hideLoading();
+						this.ui.hideLoading();
 					}
 				} else {
 					try {
 						const res = !xhr.responseText ? xhr : JSON.parse(xhr.responseText);
-						reject(res, xhr);
+						reject(res);
 					} finally {
-						this.editor.hideLoading();
+						this.ui.hideLoading();
 					}
 				}
 			};
@@ -114,27 +132,32 @@ ApiManager.prototype = {
 
 			xhr.send(data);
 		});
-	},
+	}
 
 	/**
 	 * @description Cancel API (xhr.abort())
 	 */
 	cancel() {
 		if (this._xhr) this._xhr.abort();
-	},
+	}
 
 	/**
+	 * @private
 	 * @description Remove unnecessary slashes in API URL.
 	 * @param {string} url url
 	 * @returns
 	 */
 	_normalizeUrl(url) {
 		return url.replace(/([^:])\/+/g, '$1/').replace(/\/(\?|#|$)/, '$1');
-	},
-
-	constructor: ApiManager
-};
+	}
+}
 
+/**
+ * @description API callback
+ * @param {XMLHttpRequest} xmlHttp - XMLHttpRequest
+ * @param {(xmlHttp: XMLHttpRequest) => Promise<void>} callBack - Callback function
+ * @param {(res: *, xmlHttp: XMLHttpRequest) => Promise<string>} errorCallBack - Error callback function
+ */
 async function CallBackApi(xmlHttp, callBack, errorCallBack) {
 	if (xmlHttp.readyState === 4) {
 		if (xmlHttp.status === 200) {
@@ -143,7 +166,7 @@ async function CallBackApi(xmlHttp, callBack, errorCallBack) {
 			} catch (error) {
 				throw Error(`[SUNEDITOR.ApiManager[${this.kind}].upload.callBack.fail] ${error.message}`);
 			} finally {
-				this.editor.hideLoading();
+				this.ui.hideLoading();
 			}
 		} else {
 			// exception
@@ -155,11 +178,11 @@ async function CallBackApi(xmlHttp, callBack, errorCallBack) {
 					message = await errorCallBack(res, xmlHttp);
 				}
 				const err = `[SUNEDITOR.ApiManager[${this.kind}].upload.serverException] status: ${xmlHttp.status}, response: ${message || res.errorMessage || xmlHttp.responseText}`;
-				this.editor.notice.open(err);
+				this.ui.noticeOpen(err);
 			} catch (error) {
 				throw Error(`[SUNEDITOR.ApiManager[${this.kind}].upload.errorCallBack.fail] ${error.message}`);
 			} finally {
-				this.editor.hideLoading();
+				this.ui.hideLoading();
 			}
 		}
 	}