@whitesev/utils 1.4.6 → 1.4.7

package/dist/src/Httpx.d.ts

@@ -1018,12 +1018,6 @@ export declare interface HttpxDetailsConfig extends HttpxDetails {
      * （可选）是否输出请求配置
      */
     logDetails?: boolean;
-    /**
-     * 发送请求前的回调
-     * 如果返回false则阻止本次返回
-     * @param details 当前的请求配置
-     */
-    beforeRequestCallBack?(details: HttpxDetails): boolean | void;
 }
 /**
  * 响应的数据的data
@@ -1115,6 +1109,7 @@ declare class Httpx {
     #private;
     private GM_Api;
     private HttpxRequestHook;
+    private HttpxResponseHook;
     private HttpxRequestDetails;
     private HttpxCallBack;
     private HttpxRequest;
@@ -1126,6 +1121,46 @@ declare class Httpx {
     config(details?: {
         [K in keyof HttpxDetailsConfig]?: HttpxDetailsConfig[K];
     }): void;
+    /**
+     * 拦截器
+     */
+    interceptors: {
+        /**
+         * 请求拦截器
+         */
+        request: {
+            context: Httpx;
+            /**
+             * 添加拦截器
+             * @param fn 设置的请求前回调函数，如果返回配置，则使用返回的配置，如果返回null|undefined，则阻止请求
+             */
+            use(fn: (details: Required<HttpxDetails>) => void): string | undefined;
+            /**
+             * 移除拦截器
+             * @param id 通过use返回的id
+             */
+            eject(id: string): boolean;
+        };
+        /**
+         * 响应拦截器
+         */
+        response: {
+            context: Httpx;
+            /**
+             * 添加拦截器
+             * @param successFn 设置的响应后回调函数，如果返回响应，则使用返回的响应，如果返回null|undefined，则阻止响应
+             * + 2xx 范围内的状态码都会触发该函数
+             * @param errorFn 设置的响应后回调函数，如果返回响应，则使用返回的响应，如果返回null|undefined，则阻止响应
+             * + 超出 2xx 范围的状态码都会触发该函数
+             */
+            use(successFn: () => void, errorFn: () => void): string | undefined;
+            /**
+             * 移除拦截器
+             * @param id 通过use返回的id
+             */
+            eject(id: string): boolean;
+        };
+    };
     /**
      * 修改xmlHttpRequest
      * @param httpRequest 网络请求函数

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@whitesev/utils",
-	"version": "1.4.6",
+	"version": "1.4.7",
 	"description": "一个常用的工具库",
 	"main": "dist/index.cjs.js",
 	"module": "dist/node/index.esm.js",

package/src/Httpx.ts

@@ -1114,12 +1114,6 @@ export declare interface HttpxDetailsConfig extends HttpxDetails {
 	 * （可选）是否输出请求配置
 	 */
 	logDetails?: boolean;
-	/**
-	 * 发送请求前的回调
-	 * 如果返回false则阻止本次返回
-	 * @param details 当前的请求配置
-	 */
-	beforeRequestCallBack?(details: HttpxDetails): boolean | void;
 }
 /**
  * 响应的数据的data
@@ -1208,17 +1202,165 @@ export declare interface HttpxAsyncResult<T = HttpxDetails> {
 	type: HttpxResponseCallBackType;
 }
 
+const GenerateUUID = () => {
+	return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function (c) {
+		var r = (Math.random() * 16) | 0,
+			v = c == "x" ? r : (r & 0x3) | 0x8;
+		return v.toString(16);
+	});
+};
+
 class Httpx {
 	private GM_Api = {
 		xmlHttpRequest: null as any,
 	};
 	private HttpxRequestHook = {
+		/**
+		 * @private
+		 */
+		$config: {
+			configList: <
+				{
+					id: string;
+					fn: Function;
+				}[]
+			>[],
+		},
 		/**
 		 * 发送请求前的回调
 		 * 如果返回false则阻止本次返回
 		 * @param details 当前的请求配置
+		 * @private
+		 */
+		beforeRequestCallBack(details: HttpxDetails) {
+			for (let index = 0; index < this.$config.configList.length; index++) {
+				let item = this.$config.configList[index];
+				if (typeof item.fn === "function") {
+					let result = item.fn(details);
+					if (result == null) {
+						return;
+					}
+				}
+			}
+			return details;
+		},
+		/**
+		 * 添加请求前的回调处理配置
+		 */
+		addBeforeRequestCallBack(fn: Function) {
+			if (typeof fn === "function") {
+				let uuid = GenerateUUID();
+				this.$config.configList.push({
+					id: uuid,
+					fn: fn,
+				});
+				return uuid;
+			} else {
+				console.warn(
+					"HttpxRequestHook.addBeforeRequestCallBack: fn is not a function"
+				);
+			}
+		},
+		/**
+		 * 删除请求前的回调处理配置
+		 * @param id
+		 */
+		deleteBeforeRequestCallBack(id: string) {
+			if (typeof id === "string") {
+				let findIndex = this.$config.configList.findIndex(
+					(item) => item.id === id
+				);
+				if (findIndex !== -1) {
+					this.$config.configList.splice(findIndex, 1);
+					return true;
+				}
+			}
+			return false;
+		},
+		/**
+		 * 清空设置的请求前的回调处理配置
+		 */
+		clearBeforeRequestCallBack() {
+			this.$config.configList = [];
+		},
+	};
+	private HttpxResponseHook = {
+		/**
+		 * @private
+		 */
+		$config: {
+			configList: <
+				{
+					id: string;
+					successFn: Function;
+					errorFn: Function;
+				}[]
+			>[],
+		},
+		/**
+		 * 成功的回调
+		 * @param response
+		 */
+		successResponseCallBack(response: any) {
+			for (let index = 0; index < this.$config.configList.length; index++) {
+				let item = this.$config.configList[index];
+				if (typeof item.successFn === "function") {
+					if (item.successFn(response) == null) {
+						return;
+					}
+				}
+			}
+			return response;
+		},
+		/**
+		 * 失败的回调
+		 * @param response
+		 */
+		errorResponseCallBack(response: any) {
+			for (let index = 0; index < this.$config.configList.length; index++) {
+				let item = this.$config.configList[index];
+				if (typeof item.errorFn === "function") {
+					if (item.errorFn(response) == null) {
+						return;
+					}
+				}
+			}
+			return response;
+		},
+		/**
+		 * 添加请求前的回调处理配置
+		 */
+		addAfterResponseCallBack(successFn: Function, errorFn: Function) {
+			let id = GenerateUUID();
+			this.$config.configList.push({
+				id: id,
+				successFn: successFn,
+				errorFn: errorFn,
+			});
+			return id;
+		},
+		/**
+		 * 删除请求前的回调处理配置
+		 * @param id
+		 */
+		deleteAfterResponseCallBack(id: string) {
+			if (typeof id === "string") {
+				let findIndex = this.$config.configList.findIndex(
+					(item) => item.id === id
+				);
+				if (findIndex !== -1) {
+					this.$config.configList.splice(findIndex, 1);
+					return true;
+				}
+			}
+			return false;
+		},
+		/**
+		 * 清空设置的请求前的回调处理配置
 		 */
-		beforeRequestCallBack(details: HttpxDetails) {},
+		clearAfterResponseCallBack() {
+			this.$config.configList = [];
+		},
 	};
 	private HttpxRequestDetails = {
 		context: this,
@@ -1670,7 +1812,7 @@ class Httpx {
 			) {
 				let hookResult =
 					this.context.HttpxRequestHook.beforeRequestCallBack(details);
-				if (typeof hookResult === "boolean" && !hookResult) {
+				if (hookResult == null) {
 					return;
 				}
 			}
@@ -1860,6 +2002,8 @@ class Httpx {
 				"Httpx未传入GM_xmlhttpRequest函数或传入的GM_xmlhttpRequest不是Function，强制使用window.fetch"
 			);
 		}
+		this.interceptors.request = this as any;
+		this.interceptors.response = this as any;
 		this.GM_Api.xmlHttpRequest = __xmlHttpRequest__;
 	}
 
@@ -1880,6 +2024,61 @@ class Httpx {
 		}
 		this.#defaultDetails = Utils.assign(this.#defaultDetails, details);
 	}
+	/**
+	 * 拦截器
+	 */
+	public interceptors = {
+		/**
+		 * 请求拦截器
+		 */
+		request: {
+			context: null as any as Httpx,
+			/**
+			 * 添加拦截器
+			 * @param fn 设置的请求前回调函数，如果返回配置，则使用返回的配置，如果返回null|undefined，则阻止请求
+			 */
+			use(fn: (details: Required<HttpxDetails>) => void) {
+				return this.context.HttpxRequestHook.addBeforeRequestCallBack(fn);
+			},
+			/**
+			 * 移除拦截器
+			 * @param id 通过use返回的id
+			 */
+			eject(id: string) {
+				return this.context.HttpxRequestHook.deleteBeforeRequestCallBack(id);
+			},
+		},
+		/**
+		 * 响应拦截器
+		 */
+		response: {
+			context: null as any as Httpx,
+			/**
+			 * 添加拦截器
+			 * @param successFn 设置的响应后回调函数，如果返回响应，则使用返回的响应，如果返回null|undefined，则阻止响应
+			 * + 2xx 范围内的状态码都会触发该函数
+			 * @param errorFn 设置的响应后回调函数，如果返回响应，则使用返回的响应，如果返回null|undefined，则阻止响应
+			 * + 超出 2xx 范围的状态码都会触发该函数
+			 */
+			use(successFn: () => void, errorFn: () => void) {
+				if (typeof successFn !== "function" && typeof errorFn !== "function") {
+					console.warn("[Httpx] 请传入拦截器函数");
+					return;
+				}
+				return this.context.HttpxResponseHook.addAfterResponseCallBack(
+					successFn,
+					errorFn
+				);
+			},
+			/**
+			 * 移除拦截器
+			 * @param id 通过use返回的id
+			 */
+			eject(id: string) {
+				return this.context.HttpxResponseHook.deleteAfterResponseCallBack(id);
+			},
+		},
+	};
 	/**
 	 * 修改xmlHttpRequest
 	 * @param httpRequest 网络请求函数