@varlet/axle 0.2.18 → 0.3.1

package/README.md

@@ -250,14 +250,14 @@ Each built-in interceptor supports `include` `exclude` `axiosInterceptorOptions
 
 #### include & exclude
 
-It is used to request filtering to determine what request should apply the interceptor and support specifying the `method` or `glob` syntax. The usage method is as follows.
+It is used to request filtering to determine what request should apply the interceptor and support specifying the `method`、 `glob` syntax or `status` code. The usage method is as follows.
 
 ```ts
 axle.useResponseInterceptor(
   responseRetryInterceptor({ 
     count: 3,
-    include: ['method:put', 'method:post'],
-    exclude: ['/system/**', '/user/addUser']
+    include: ['method:put', 'method:post', 'status:500'],
+    exclude: ['/system/**', '/user/addUser', 'status:400']
   }),
 )
 ```
@@ -266,12 +266,13 @@ axle.useResponseInterceptor(
 
 | Name | Description |
 | --- | --- |
-| [requestHeadersInterceptor](https://github.com/varletjs/axle/packages/axle/blob/main/src/interceptors/examples/requestHeadersInterceptor.md) | Used to customize the request header |
-| [requestMockInterceptor](https://github.com/varletjs/axle/packages/axle/blob/main/src/interceptors/examples/requestMockInterceptor.md) | Used to mock data |
-| [responseRetryInterceptor](https://github.com/varletjs/axle/packages/axle/blob/main/src/interceptors/examples/responseRetryInterceptor.md) | Used to realize the request abnormal retry |
-| [responseStatusInterceptor](https://github.com/varletjs/axle/packages/axle/blob/main/src/interceptors/examples/responseStatusInterceptor.md) | Used to intercept status code |
-| [responseBlobInterceptor](https://github.com/varletjs/axle/packages/axle/blob/main/src/interceptors/examples/responseBlobInterceptor.md) | Used to intercept blob type |
-| [responseTimeoutInterceptor](https://github.com/varletjs/axle/packages/axle/blob/main/src/interceptors/examples/responseTimeoutInterceptor.md) | Used to abnormal timeout |
+| [requestHeadersInterceptor](https://github.com/varletjs/axle/blob/packages/axle/main/src/interceptors/examples/requestHeadersInterceptor.md) | Used to customize the request header |
+| [requestMockInterceptor](https://github.com/varletjs/axle/blob/packages/axle/main/src/interceptors/examples/requestMockInterceptor.md) | Used to mock data |
+| [requestMd5Interceptor](https://github.com/varletjs/axle/blob/packages/axle/main/src/interceptors/examples/requestMd5Interceptor.md) | Used for md encryption of parameters and headers |
+| [responseRetryInterceptor](https://github.com/varletjs/axle/blob/packages/axle/main/src/interceptors/examples/responseRetryInterceptor.md) | Used to realize the request abnormal retry |
+| [responseStatusInterceptor](https://github.com/varletjs/axle/blob/packages/axle/main/src/interceptors/examples/responseStatusInterceptor.md) | Used to intercept status code |
+| [responseBlobInterceptor](https://github.com/varletjs/axle/blob/packages/axle/main/src/interceptors/examples/responseBlobInterceptor.md) | Used to intercept blob type |
+| [responseTimeoutInterceptor](https://github.com/varletjs/axle/blob/packages/axle/main/src/interceptors/examples/responseTimeoutInterceptor.md) | Used to abnormal timeout |
 
 ## Vue Composition API
 

package/README.zh-CN.md

@@ -250,14 +250,14 @@ axle.useResponseInterceptor(responseRetryInterceptor({ count: 3 }))
 
 #### include & exclude
 
-用于请求过滤，以确定什么请求应该应用该拦截器，支持指定 method 或是 glob 语法，使用方式如下。
+用于请求过滤，以确定什么请求应该应用该拦截器，支持指定 `method`、 `glob` 或者 `status`，使用方式如下。
 
 ```ts
 axle.useResponseInterceptor(
   responseRetryInterceptor({ 
     count: 3,
-    include: ['method:put', 'method:post'],
-    exclude: ['/system/**', '/user/addUser']
+    include: ['method:put', 'method:post', 'status:500'],
+    exclude: ['/system/**', '/user/addUser', 'status:400']
   }),
 )
 ```
@@ -266,12 +266,13 @@ axle.useResponseInterceptor(
 
 | 名称 | 描述 |
 | --- | --- |
-| [requestHeadersInterceptor](https://github.com/varletjs/axle/packages/axle/blob/main/src/interceptors/examples/requestHeadersInterceptor.md) | 用于自定义请求头 |
-| [requestMockInterceptor](https://github.com/varletjs/axle/packages/axle/blob/main/src/interceptors/examples/requestMockInterceptor.md) | 用于模拟数据 |
-| [responseRetryInterceptor](https://github.com/varletjs/axle/packages/axle/blob/main/src/interceptors/examples/responseRetryInterceptor.md) | 用于实现请求异常重试 |
-| [responseStatusInterceptor](https://github.com/varletjs/axle/packages/axle/blob/main/src/interceptors/examples/responseStatusInterceptor.md) | 用于拦截状态码 |
-| [responseBlobInterceptor](https://github.com/varletjs/axle/packages/axle/blob/main/src/interceptors/examples/responseBlobInterceptor.md) | 用于拦截 blob 类型 |
-| [responseTimeoutInterceptor](https://github.com/varletjs/axle/packages/axle/blob/main/src/interceptors/examples/responseTimeoutInterceptor.md) | 用于归一化超时异常 |
+| [requestHeadersInterceptor](https://github.com/varletjs/axle/blob/packages/axle/main/src/interceptors/examples/requestHeadersInterceptor.md) | 用于自定义请求头 |
+| [requestMockInterceptor](https://github.com/varletjs/axle/blob/packages/axle/main/src/interceptors/examples/requestMockInterceptor.md) | 用于模拟数据 |
+| [requestMd5Interceptor](https://github.com/varletjs/axle/blob/packages/axle/main/src/interceptors/examples/requestMd5Interceptor.md) | 用于对请求参数进行 md5 处理  |
+| [responseRetryInterceptor](https://github.com/varletjs/axle/blob/packages/axle/main/src/interceptors/examples/responseRetryInterceptor.md) | 用于实现请求异常重试 |
+| [responseStatusInterceptor](https://github.com/varletjs/axle/blob/packages/axle/main/src/interceptors/examples/responseStatusInterceptor.md) | 用于拦截状态码 |
+| [responseBlobInterceptor](https://github.com/varletjs/axle/blob/packages/axle/main/src/interceptors/examples/responseBlobInterceptor.md) | 用于拦截 blob 类型 |
+| [responseTimeoutInterceptor](https://github.com/varletjs/axle/blob/packages/axle/main/src/interceptors/examples/responseTimeoutInterceptor.md) | 用于归一化超时异常 |
 
 ## Vue 组合式 API
 

package/es/index.d.ts

@@ -2,8 +2,8 @@ import { R as RequestInterceptor, a as ResponseInterceptor } from './instance-8e
 export { e as AxleInstance, A as AxleRequestConfig, b as FetchMethod, F as FetchRunner, I as Interceptor, c as ModifyMethod, M as ModifyRunner, d as RunnerMethod, i as createAxle, f as createFetchRunner, g as createModifyRunner, h as download } from './instance-8e68a761.js';
 import { AxiosInterceptorOptions, AxiosRequestConfig, AxiosResponse } from 'axios';
 
-declare function matchPattern(pattern: string, method: string, url: string): boolean;
-declare function createMatcher(include?: string[], exclude?: string[]): (method: string, url: string) => boolean;
+declare function matchPattern(pattern: string, method: string, url: string, status?: number | null | undefined): boolean;
+declare function createMatcher(include?: string[], exclude?: string[]): (method: string, url: string, status?: number | null | undefined) => boolean;
 
 interface RequestHeadersInterceptorOptions {
     headers?: Record<string, string> | (() => Record<string, string>);
@@ -13,7 +13,8 @@ interface RequestHeadersInterceptorOptions {
 }
 declare function requestHeadersInterceptor(options?: RequestHeadersInterceptorOptions): RequestInterceptor;
 
-type RequestMockInterceptorMappingValue = {
+type RequestMockInterceptorMapping = {
+    url: string;
     handler: (config: AxiosRequestConfig) => {
         data: any;
         status?: number;
@@ -23,7 +24,7 @@ type RequestMockInterceptorMappingValue = {
     delay?: number;
 };
 interface RequestMockInterceptorOptions {
-    mapping?: Record<string, RequestMockInterceptorMappingValue>;
+    mappings?: RequestMockInterceptorMapping[];
     include?: string[];
     exclude?: string[];
     axiosInterceptorOptions?: AxiosInterceptorOptions;
@@ -63,16 +64,17 @@ interface ResponseStatusInterceptorOptions {
 }
 declare function responseStatusInterceptor(options: ResponseStatusInterceptorOptions): ResponseInterceptor;
 
-type RequestMd5InterceptorMappingValue = {
+type RequestMd5InterceptorMapping = {
+    url: string;
     path: string[];
     method?: string;
 };
 interface RequestMd5InterceptorOptions {
-    mapping?: Record<string, RequestMd5InterceptorMappingValue>;
+    mappings?: RequestMd5InterceptorMapping[];
     include?: string[];
     exclude?: string[];
     axiosInterceptorOptions?: AxiosInterceptorOptions;
 }
 declare function requestMd5Interceptor(options?: RequestMd5InterceptorOptions): RequestInterceptor;
 
-export { RequestHeadersInterceptorOptions, RequestInterceptor, RequestMd5InterceptorMappingValue, RequestMd5InterceptorOptions, RequestMockInterceptorMappingValue, RequestMockInterceptorOptions, ResponseBlobInterceptorOptions, ResponseInterceptor, ResponseRetryInterceptorOptions, ResponseStatusInterceptorOptions, ResponseTimeoutInterceptorOptions, createMatcher, matchPattern, requestHeadersInterceptor, requestMd5Interceptor, requestMockInterceptor, responseBlobInterceptor, responseRetryInterceptor, responseStatusInterceptor, responseTimeoutInterceptor };
+export { RequestHeadersInterceptorOptions, RequestInterceptor, RequestMd5InterceptorMapping, RequestMd5InterceptorOptions, RequestMockInterceptorMapping, RequestMockInterceptorOptions, ResponseBlobInterceptorOptions, ResponseInterceptor, ResponseRetryInterceptorOptions, ResponseStatusInterceptorOptions, ResponseTimeoutInterceptorOptions, createMatcher, matchPattern, requestHeadersInterceptor, requestMd5Interceptor, requestMockInterceptor, responseBlobInterceptor, responseRetryInterceptor, responseStatusInterceptor, responseTimeoutInterceptor };

package/es/index.js

@@ -133,22 +133,25 @@ function createAxle(config = {}) {
 
 // src/matcher.ts
 import { minimatch } from "minimatch";
-function matchPattern(pattern, method, url) {
+function matchPattern(pattern, method, url, status) {
+  if (pattern.startsWith("status:")) {
+    return pattern.replace("status:", "").trim() === String(status);
+  }
   return pattern.startsWith("method:") ? pattern.replace("method:", "").trim() === method : minimatch(url != null ? url : "", pattern);
 }
 function createMatcher(include, exclude) {
-  function matcher(method, url) {
+  function matcher(method, url, status) {
     if (!include && !exclude) {
       return true;
     }
-    const isExclude = (exclude != null ? exclude : []).some((pattern) => matchPattern(pattern, method, url));
+    const isExclude = (exclude != null ? exclude : []).some((pattern) => matchPattern(pattern, method, url, status));
     if (isExclude) {
       return false;
     }
     if (!include) {
       return true;
     }
-    const isInclude = (include != null ? include : []).some((pattern) => matchPattern(pattern, method, url));
+    const isInclude = (include != null ? include : []).some((pattern) => matchPattern(pattern, method, url, status));
     return isInclude;
   }
   return matcher;
@@ -200,23 +203,22 @@ function requestMockInterceptor(options = {}) {
       if (!matcher((_a = config.method) != null ? _a : "", (_b = config.url) != null ? _b : "")) {
         return config;
       }
-      const findMappingRecord = () => {
+      const findMapping = () => {
         var _a2;
-        return Object.entries((_a2 = options.mapping) != null ? _a2 : {}).find(
-          ([key, value]) => {
-            var _a3, _b2;
-            return minimatch2((_a3 = config.url) != null ? _a3 : "", key) && config.method === ((_b2 = value.method) != null ? _b2 : "get");
-          }
-        );
+        return ((_a2 = options.mappings) != null ? _a2 : []).find((mapping2) => {
+          var _a3;
+          const isMatchUrl = minimatch2((_a3 = config.url) != null ? _a3 : "", mapping2.url);
+          const isMatchMethod = mapping2.method != null ? config.method === mapping2.method : true;
+          return isMatchUrl && isMatchMethod;
+        });
       };
-      const mappingRecord = findMappingRecord();
-      if (!mappingRecord) {
+      const mapping = findMapping();
+      if (!mapping) {
         return config;
       }
-      const [, mappingValue] = mappingRecord;
       config.adapter = () => {
         var _a2, _b2;
-        const partialResponse = mappingValue.handler(config);
+        const partialResponse = mapping.handler(config);
         const response = __spreadProps(__spreadValues({}, partialResponse), {
           headers: config.headers,
           config,
@@ -226,7 +228,7 @@ function requestMockInterceptor(options = {}) {
           statusText: (_b2 = partialResponse.statusText) != null ? _b2 : "OK"
         });
         return new Promise((resolve, reject) => {
-          settle(response, resolve, reject, mappingValue.delay);
+          settle(response, resolve, reject, mapping.delay);
         });
       };
       return config;
@@ -242,7 +244,7 @@ function responseBlobInterceptor(options = {}) {
     onFulfilled(response) {
       var _a, _b, _c, _d;
       const matcher = createMatcher(options.include, options.exclude);
-      if (!matcher((_a = response.config.method) != null ? _a : "", (_b = response.config.url) != null ? _b : "")) {
+      if (!matcher((_a = response.config.method) != null ? _a : "", (_b = response.config.url) != null ? _b : "", response.status)) {
         return response;
       }
       if (response.request.responseType === "blob") {
@@ -260,13 +262,13 @@ function responseTimeoutInterceptor(options = {}) {
   return {
     onFulfilled: (response) => response,
     onRejected(error) {
-      var _a, _b, _c;
+      var _a, _b, _c, _d;
       const matcher = createMatcher(options.include, options.exclude);
-      if (!matcher((_a = error.config.method) != null ? _a : "", (_b = error.config.url) != null ? _b : "")) {
+      if (!matcher((_a = error.config.method) != null ? _a : "", (_b = error.config.url) != null ? _b : "", (_c = error == null ? void 0 : error.response) == null ? void 0 : _c.status)) {
         return Promise.reject(error);
       }
       if (error.code === "ECONNABORTED" && error.message.includes("timeout") || error.code === "ETIMEDOUT") {
-        error.code = (_c = options == null ? void 0 : options.normalizeErrorCode) != null ? _c : "TIMEOUT";
+        error.code = (_d = options == null ? void 0 : options.normalizeErrorCode) != null ? _d : "TIMEOUT";
       }
       return Promise.reject(error);
     },
@@ -280,9 +282,9 @@ function responseRetryInterceptor(options) {
   return {
     onFulfilled: (response) => response,
     async onRejected(error) {
-      var _a, _b;
+      var _a, _b, _c;
       const matcher = createMatcher(options.include, options.exclude);
-      if (!matcher((_a = error.config.method) != null ? _a : "", (_b = error.config.url) != null ? _b : "") || isCancel(error)) {
+      if (!matcher((_a = error.config.method) != null ? _a : "", (_b = error.config.url) != null ? _b : "", (_c = error == null ? void 0 : error.response) == null ? void 0 : _c.status) || isCancel(error)) {
         return Promise.reject(error);
       }
       const { count = 1 } = options;
@@ -310,7 +312,7 @@ function responseStatusInterceptor(options) {
     onFulfilled: (response) => {
       var _a, _b, _c;
       const matcher = createMatcher(options.include, options.exclude);
-      if (!matcher((_a = response.config.method) != null ? _a : "", (_b = response.config.url) != null ? _b : "")) {
+      if (!matcher((_a = response.config.method) != null ? _a : "", (_b = response.config.url) != null ? _b : "", response.status)) {
         return response;
       }
       const handler = ((_c = options.validStatusHandler) != null ? _c : {})[response.status];
@@ -321,12 +323,12 @@ function responseStatusInterceptor(options) {
       return handlerResponse != null ? handlerResponse : response;
     },
     onRejected: (error) => {
-      var _a, _b, _c;
+      var _a, _b, _c, _d;
       const matcher = createMatcher(options.include, options.exclude);
-      if (!matcher((_a = error.config.method) != null ? _a : "", (_b = error.config.url) != null ? _b : "")) {
+      if (!matcher((_a = error.config.method) != null ? _a : "", (_b = error.config.url) != null ? _b : "", (_c = error == null ? void 0 : error.response) == null ? void 0 : _c.status)) {
         return Promise.reject(error);
       }
-      const handler = ((_c = options.invalidStatusHandler) != null ? _c : {})[error.response.status];
+      const handler = ((_d = options.invalidStatusHandler) != null ? _d : {})[error.response.status];
       if (!handler) {
         return Promise.reject(error);
       }
@@ -343,15 +345,15 @@ import { minimatch as minimatch3 } from "minimatch";
 import { set, get } from "lodash-es";
 import { MD5 } from "crypto-js";
 import { isString } from "@varlet/shared";
-function withCtxMd5(ctx, mappingValue) {
-  mappingValue.path.forEach((path) => {
+function withCtxMd5(ctx, mapping) {
+  mapping.path.forEach((path) => {
     const targetValue = get(ctx, path);
     if (targetValue != null) {
       set(ctx, path, MD5(String(targetValue)).toString());
     }
   });
 }
-function withMd5(config, mappingValue) {
+function withMd5(config, mapping) {
   const { data = {}, params = {}, headers = {} } = config;
   const ctx = {
     data: isFormData(data) ? data : JSON.parse(JSON.stringify(data)),
@@ -360,14 +362,14 @@ function withMd5(config, mappingValue) {
   };
   if (isString(ctx.data) && ctx.data.length > 0 && ctx.headers["Content-Type"] === "application/x-www-form-urlencoded") {
     ctx.data = qs2.parse(ctx.data);
-    withCtxMd5(ctx, mappingValue);
+    withCtxMd5(ctx, mapping);
     ctx.data = qs2.stringify(ctx.data);
   } else if (isFormData(ctx.data)) {
     ctx.data = formDataToObject(ctx.data);
-    withCtxMd5(ctx, mappingValue);
+    withCtxMd5(ctx, mapping);
     ctx.data = objectToFormData(ctx.data);
   } else {
-    withCtxMd5(ctx, mappingValue);
+    withCtxMd5(ctx, mapping);
   }
   return __spreadValues(__spreadValues({}, config), ctx);
 }
@@ -379,21 +381,20 @@ function requestMd5Interceptor(options = {}) {
       if (!matcher((_a = config.method) != null ? _a : "", (_b = config.url) != null ? _b : "")) {
         return config;
       }
-      const findMappingRecord = () => {
+      const findMapping = () => {
         var _a2;
-        return Object.entries((_a2 = options.mapping) != null ? _a2 : {}).find(
-          ([key, value]) => {
-            var _a3, _b2;
-            return minimatch3((_a3 = config.url) != null ? _a3 : "", key) && config.method === ((_b2 = value.method) != null ? _b2 : "get");
-          }
-        );
+        return ((_a2 = options.mappings) != null ? _a2 : []).find((mapping2) => {
+          var _a3;
+          const isMatchUrl = minimatch3((_a3 = config.url) != null ? _a3 : "", mapping2.url);
+          const isMatchMethod = mapping2.method != null ? config.method === mapping2.method : true;
+          return isMatchUrl && isMatchMethod;
+        });
       };
-      const mappingRecord = findMappingRecord();
-      if (!mappingRecord) {
+      const mapping = findMapping();
+      if (!mapping) {
         return config;
       }
-      const [, mappingValue] = mappingRecord;
-      return withMd5(config, mappingValue);
+      return withMd5(config, mapping);
     },
     onRejected: (error) => Promise.reject(error),
     options: options.axiosInterceptorOptions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@varlet/axle",
-  "version": "0.2.18",
+  "version": "0.3.1",
   "description": "Progressive request tool based on axios",
   "type": "module",
   "main": "es/index.js",