@polyv/request-core 2.7.1 → 2.8.0

package/README.md

@@ -21,7 +21,7 @@ const requester = new PolyvRequest({
 (async () => {
   // 执行请求
   const data = await requester.get('/getDetail', {
-    channelId: 'xxxx'
+    channelId: 'xxxx',
   });
 
   console.log(data);
@@ -47,11 +47,15 @@ interface ChannelDetail {
 
 (async () => {
   // 执行请求
-  const data = await requester.get<ChannelDetail>('/getDetail', {
-    channelId: 'xxxx'
-  }, {
-    test: true
-  });
+  const data = await requester.get<ChannelDetail>(
+    '/getDetail',
+    {
+      channelId: 'xxxx',
+    },
+    {
+      test: true,
+    },
+  );
 
   console.log(data.channelName);
 })();
@@ -59,14 +63,14 @@ interface ChannelDetail {
 
 ## 实例化参数
 
-| 参数名 | 用途 | 类型 | 默认值 |
-| - | - | - | - |
-| baseUrl | 接口请求地址前缀 | `string \| function` | `''` |
-| requestPlugins | 请求插件 | `RequestPlugin[]` | `[]` |
-| timeout | 超时时间，毫秒 | `number` | `10000` |
-| requestType | 请求方式 | `RequestType` | `'form'` |
-| responseType | 响应格式 | `ResponseType` | `'json'` |
-| withCredentials | 跨域请求时是否提供凭据 | `boolean` | `false` |
+| 参数名          | 用途                   | 类型                 | 默认值   |
+| --------------- | ---------------------- | -------------------- | -------- |
+| baseUrl         | 接口请求地址前缀       | `string \| function` | `''`     |
+| requestPlugins  | 请求插件               | `RequestPlugin[]`    | `[]`     |
+| timeout         | 超时时间，毫秒         | `number`             | `10000`  |
+| requestType     | 请求方式               | `RequestType`        | `'form'` |
+| responseType    | 响应格式               | `ResponseType`       | `'json'` |
+| withCredentials | 跨域请求时是否提供凭据 | `boolean`            | `false`  |
 
 ## 发送请求
 
@@ -79,7 +83,7 @@ interface ChannelDetailResponse {
   data: {
     /** 频道名称 */
     channelName: string;
-  }
+  };
 }
 
 // 接口入参参数
@@ -88,12 +92,9 @@ interface ChannelDetailRequestParams {
   channelId: string;
 }
 
-const res = await requester.get<ChannelDetailResponse, ChannelDetailRequestParams>(
-  '/getDetail',
-  {
-    channelId: 'xxxx'
-  }
-);
+const res = await requester.get<ChannelDetailResponse, ChannelDetailRequestParams>('/getDetail', {
+  channelId: 'xxxx',
+});
 
 console.log('code', res.code);
 console.log('channelName', res.data.channelName);
@@ -116,14 +117,14 @@ const res = await requester.post<Response, RequestData>(
   '/save-name',
   {
     userId: 123,
-    name: '小明'
+    name: '小明',
   },
   {
     // 如果需要额外入参地址参数
     params: {
-      channelId: 'xxx'
-    }
-  }
+      channelId: 'xxx',
+    },
+  },
 );
 
 if (res.code === 200) {
@@ -154,18 +155,18 @@ const requester = new PolyvRequest({
       },
     }),
     new StatusCodeRequestPlugin(),
-  ]
+  ],
 });
 ```
 
 ### 插件概览
 
-| 插件名 | 用途 |
-| - | - |
-| [@polyv/request-plugin-global-params](https://npm-registry.polyv.net/-/web/detail/@polyv/request-plugin-global-params) | 全局 params 入参插件 |
-| [@polyv/request-plugin-authorize-token](https://npm-registry.polyv.net/-/web/detail/@polyv/request-plugin-authorize-token) | 请求令牌插件 |
-| [@polyv/request-plugin-authorize-app-sign](https://npm-registry.polyv.net/-/web/detail/@polyv/request-plugin-authorize-app-sign) | 请求签名插件 |
-| [@polyv/request-plugin-status-code](https://npm-registry.polyv.net/-/web/detail/@polyv/request-plugin-status-code) | 状态码处理插件 |
-| [@polyv/request-plugin-aes-decrypt](https://npm-registry.polyv.net/-/web/detail/@polyv/request-plugin-aes-decrypt) | AES 解密响应内容 |
-| [@polyv/request-plugin-aes](https://npm-registry.polyv.net/-/web/detail/@polyv/request-plugin-aes) | AES 业务请求加密和解密 |
-| [@polyv/request-plugin-sm2](https://npm-registry.polyv.net/-/web/detail/@polyv/request-plugin-sm2) | SM2 业务请求加密和解密 |
+| 插件名                                                                                                                           | 用途                   |
+| -------------------------------------------------------------------------------------------------------------------------------- | ---------------------- |
+| [@polyv/request-plugin-global-params](https://npm-registry.polyv.net/-/web/detail/@polyv/request-plugin-global-params)           | 全局 params 入参插件   |
+| [@polyv/request-plugin-authorize-token](https://npm-registry.polyv.net/-/web/detail/@polyv/request-plugin-authorize-token)       | 请求令牌插件           |
+| [@polyv/request-plugin-authorize-app-sign](https://npm-registry.polyv.net/-/web/detail/@polyv/request-plugin-authorize-app-sign) | 请求签名插件           |
+| [@polyv/request-plugin-status-code](https://npm-registry.polyv.net/-/web/detail/@polyv/request-plugin-status-code)               | 状态码处理插件         |
+| [@polyv/request-plugin-aes-decrypt](https://npm-registry.polyv.net/-/web/detail/@polyv/request-plugin-aes-decrypt)               | AES 解密响应内容       |
+| [@polyv/request-plugin-aes](https://npm-registry.polyv.net/-/web/detail/@polyv/request-plugin-aes)                               | AES 业务请求加密和解密 |
+| [@polyv/request-plugin-sm2](https://npm-registry.polyv.net/-/web/detail/@polyv/request-plugin-sm2)                               | SM2 业务请求加密和解密 |

package/adapter/adapter-wx.d.ts

@@ -0,0 +1,2 @@
+import type { GetAdapterType } from './type';
+export declare const getAdapter: GetAdapterType;

package/adapter/adapter-wx.js

@@ -0,0 +1,8 @@
+import { Request, wxRequestAdapter } from '@polyv/utils-request';
+let xhrRequest;
+export const getAdapter = () => {
+    if (!xhrRequest) {
+        xhrRequest = new Request(wxRequestAdapter);
+    }
+    return xhrRequest;
+};

package/adapter/adapter-xhr.d.ts

@@ -0,0 +1,2 @@
+import type { GetAdapterType } from './type';
+export declare const getAdapter: GetAdapterType;

package/adapter/adapter-xhr.js

@@ -0,0 +1,8 @@
+import { Request, xhrAdapter } from '@polyv/utils-request';
+let xhrRequest;
+export const getAdapter = () => {
+    if (!xhrRequest) {
+        xhrRequest = new Request(xhrAdapter);
+    }
+    return xhrRequest;
+};

package/adapter/get-adapter.d.ts

@@ -0,0 +1,2 @@
+import type { GetAdapterType } from './type';
+export declare const getAdapter: GetAdapterType;

package/adapter/get-adapter.js

@@ -0,0 +1,9 @@
+import { getAdapter as getAdapterXhr } from './adapter-xhr';
+import { getAdapter as getAdapterWx } from './adapter-wx';
+import { isWechatMiniprogramEnv } from '@polyv/utils-env';
+export const getAdapter = () => {
+    if (isWechatMiniprogramEnv()) {
+        return getAdapterWx();
+    }
+    return getAdapterXhr();
+};

package/adapter/type.d.ts

@@ -0,0 +1,2 @@
+import type { Request } from '@polyv/utils-request';
+export type GetAdapterType = () => Request;

package/adapter/type.js

@@ -0,0 +1 @@
+export {};

package/ajax.d.ts

@@ -1,4 +1,4 @@
-import { PolyvRequestConfig, RequestOptions } from './interface';
+import type { PolyvRequestConfig, RequestOptions } from './interface/index';
 /**
  * API 请求封装
  */
@@ -12,7 +12,7 @@ export declare class PolyvRequest<Options extends RequestOptions = RequestOption
     private __responseType;
     private __withCredentials;
     /** 请求器 */
-    private __xhrRequest;
+    private __baseRequest;
     private __pluginCtrl;
     constructor(options?: PolyvRequestConfig<Options>);
     /**
@@ -55,12 +55,6 @@ export declare class PolyvRequest<Options extends RequestOptions = RequestOption
     open<P = object>(url: string, params: P, options?: Options): Promise<void>;
     /** 下载链接 */
     download<P = object>(url: string, params: P, options?: Options): Promise<void>;
-    /**
-     * 解析响应头
-     * @param headerStr 响应头字符串
-     * @returns 响应头对象
-     */
-    private __parseResponseHeaders;
     destroy(): void;
 }
 export default PolyvRequest;

package/ajax.js

@@ -1,11 +1,9 @@
-/* eslint-disable @typescript-eslint/ban-types */
-import { Request, xhrAdapter } from '@polyv/utils-request';
 import { startsWithProtocol } from '@polyv/utils-net';
+import { concat } from '@polyv/utils-querystring';
+import { getAdapter } from './adapter/get-adapter';
+import { DEFAULT_REQUEST_TYPE, DEFAULT_RESPONSE_TYPE } from './config';
 import { PluginController } from './plugins/plugin-controller';
 import { buildFormData, hasFileValue } from './utils';
-import { DEFAULT_REQUEST_TYPE, DEFAULT_RESPONSE_TYPE } from './config';
-import { concat } from '@polyv/utils-querystring';
-let xhrRequest;
 /**
  * API 请求封装
  */
@@ -19,7 +17,7 @@ export class PolyvRequest {
     __responseType;
     __withCredentials;
     /** 请求器 */
-    __xhrRequest;
+    __baseRequest;
     __pluginCtrl;
     constructor(options = {}) {
         const { baseUrl } = options;
@@ -30,10 +28,7 @@ export class PolyvRequest {
         this.__requestType = options.requestType || DEFAULT_REQUEST_TYPE;
         this.__responseType = options.responseType || DEFAULT_RESPONSE_TYPE;
         this.__withCredentials = options.withCredentials ?? false;
-        if (!xhrRequest) {
-            xhrRequest = new Request(xhrAdapter);
-        }
-        this.__xhrRequest = xhrRequest;
+        this.__baseRequest = getAdapter();
         const requestPlugins = (options.requestPlugins || []);
         this.__pluginCtrl = new PluginController(requestPlugins);
     }
@@ -96,10 +91,11 @@ export class PolyvRequest {
         let result;
         try {
             // 调用请求库
-            const justRes = await this.__xhrRequest.send(handleResult.requestUrl, {
+            const justRes = (await this.__baseRequest.send(handleResult.requestUrl, {
                 ..._options,
-            });
-            const headers = this.__parseResponseHeaders(justRes.xhr.getAllResponseHeaders());
+            }));
+            // const headers = this.__parseResponseHeaders(justRes.xhr.getAllResponseHeaders());
+            const headers = justRes.getResponseHeaders();
             // 请求结果
             result = {
                 data: justRes.data,
@@ -137,7 +133,7 @@ export class PolyvRequest {
     async __interceptRequest(options) {
         let newOptions = options;
         // 处理插件中的请求拦截
-        newOptions = await this.__pluginCtrl.interceptPluginRequest(newOptions);
+        newOptions = (await this.__pluginCtrl.interceptPluginRequest(newOptions));
         return newOptions;
     }
     /**
@@ -226,33 +222,6 @@ export class PolyvRequest {
         downloadLink.click();
         document.body.removeChild(downloadLink);
     }
-    /**
-     * 解析响应头
-     * @param headerStr 响应头字符串
-     * @returns 响应头对象
-     */
-    __parseResponseHeaders(headerStr) {
-        const headers = {};
-        // 如果字符串为空，则返回空对象
-        if (!headerStr) {
-            return headers;
-        }
-        // 按行分割头信息
-        const headerPairs = headerStr.trim().split('\r\n');
-        headerPairs.forEach(headerPair => {
-            // 查找第一个冒号的位置
-            const index = headerPair.indexOf(':');
-            // 如果找不到冒号，则跳过此行
-            if (index > 0) {
-                // 提取键（转为小写）和值（去除前后空格）
-                const key = headerPair.substring(0, index).trim().toLowerCase();
-                const value = headerPair.substring(index + 1).trim();
-                // 保存到结果对象
-                headers[key] = value;
-            }
-        });
-        return headers;
-    }
     destroy() {
         this.__isDestroyed = true;
     }

package/axios-interceptor.d.ts

@@ -1,5 +1,5 @@
 import type { AxiosInstance } from 'axios';
-import { PolyvRequestConfig, RequestType } from './interface';
+import type { PolyvRequestConfig, RequestType } from './interface/index';
 export type SetupAxiosInterceptorConfig = Pick<PolyvRequestConfig, 'baseUrl' | 'timeout' | 'requestPlugins'>;
 declare module 'axios' {
     interface AxiosRequestConfig {

package/axios-interceptor.js

@@ -37,7 +37,7 @@ export function setupAxiosInterceptor(axios, config = {}) {
         if (newOptions.requestType && options.method?.toLocaleUpperCase() === 'POST') {
             const reqTypes = {
                 json: 'application/json;charset=UTF-8',
-                form: 'application/x-www-form-urlencoded'
+                form: 'application/x-www-form-urlencoded',
             };
             options.headers.setAccept('*/*');
             options.headers.setContentType(reqTypes[newOptions.requestType]);

package/config.d.ts

@@ -1,3 +1,3 @@
-import { RequestType, ResponseType } from "./interface";
+import type { RequestType, ResponseType } from './interface/index';
 export declare const DEFAULT_REQUEST_TYPE: RequestType;
 export declare const DEFAULT_RESPONSE_TYPE: ResponseType;

package/index.d.ts

@@ -1,7 +1,7 @@
 export * from './ajax';
 export * from './request-error';
-export * from './interface';
+export * from './interface/index';
 export * from './utils';
-export * from './plugins';
+export * from './plugins/index';
 export * from './plugins/plugin-controller';
 export * from './axios-interceptor';

package/index.js

@@ -1,7 +1,7 @@
 export * from './ajax';
 export * from './request-error';
-export * from './interface';
+export * from './interface/index';
 export * from './utils';
-export * from './plugins';
+export * from './plugins/index';
 export * from './plugins/plugin-controller';
 export * from './axios-interceptor';

package/interface/index.d.ts

@@ -1,4 +1,4 @@
-import { RequestPlugin } from '../plugins';
+import type { RequestPlugin } from '../plugins/index';
 export * from './polyv';
 export type BaseUrlFn = () => string;
 export interface PolyvRequestConfig<Options extends RequestOptions = RequestOptions> {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polyv/request-core",
-  "version": "2.7.1",
+  "version": "2.8.0",
   "main": "./index.js",
   "peerDependencies": {
     "axios": ">=1.0.0"
@@ -11,11 +11,12 @@
     }
   },
   "dependencies": {
-    "@polyv/utils-net": "^3.2.0",
-    "@polyv/utils-querystring": "^3.2.0",
-    "@polyv/utils-request": "^3.2.0",
-    "md5": "2.3.0",
-    "sha256": "0.2.0"
+    "@polyv/utils-env": "^3.3.0",
+    "@polyv/utils-net": "^3.3.0",
+    "@polyv/utils-querystring": "^3.3.0",
+    "@polyv/utils-request": "^3.3.0"
   },
-  "types": "./index.d.ts"
+  "types": "./index.d.ts",
+  "type": "module",
+  "miniprogram": "./"
 }

package/plugins/index.d.ts

@@ -1,5 +1,6 @@
-import { RequestOptions, RequestResult } from '../interface';
-import { PluginController } from './plugin-controller';
+import type { RequestOptions, RequestResult } from '../interface/index';
+import type { PluginController } from './plugin-controller';
+export type PluginInterceptReturn = Promise<object | void> | object | void;
 /**
  * 请求插件
  */
@@ -20,25 +21,25 @@ export interface RequestPlugin<Options extends RequestOptions = RequestOptions>
      * @param options 请求选项
      * @returns 请求选项
      */
-    interceptIncludeParams?: (options: Options) => Promise<object | void> | object | void;
+    interceptIncludeParams?: (options: Options) => PluginInterceptReturn;
     /**
      * 请求授权
      * @param options 请求选项
      * @returns 请求选项
      */
-    interceptAuthorizeRequest?: (options: Options) => Promise<Options | void> | Options | void;
+    interceptAuthorizeRequest?: (options: Options) => PluginInterceptReturn;
     /**
      * 请求加密
      * @param options 请求选项
      * @returns 请求选项
      */
-    interceptEncryptRequest?: (options: Options) => Promise<Options | void> | Options | void;
+    interceptEncryptRequest?: (options: Options) => PluginInterceptReturn;
     /**
      * 请求拦截器
      * @param options 请求选项
      * @returns 请求选项
      */
-    interceptRequest?: (options: Options) => Promise<Options | void> | Options | void;
+    interceptRequest?: (options: Options) => PluginInterceptReturn;
     /**
      * 响应解密
      * @param result 请求结果

package/plugins/plugin-controller.d.ts

@@ -1,5 +1,5 @@
-import { RequestOptions, RequestResult } from "../interface";
-import { RequestPlugin } from "./index";
+import type { RequestOptions, RequestResult } from '../interface/index';
+import type { RequestPlugin } from './index';
 export declare class PluginController {
     /** 请求插件 */
     private __requestPlugins;

package/utils.js

@@ -12,10 +12,10 @@ function isBlobLike(value) {
         return true;
     }
     const blobLike = value;
-    return typeof blobLike.size === 'number'
-        && typeof blobLike.type === 'string'
-        && typeof blobLike.slice === 'function'
-        && typeof blobLike.arrayBuffer === 'function';
+    return (typeof blobLike.size === 'number' &&
+        typeof blobLike.type === 'string' &&
+        typeof blobLike.slice === 'function' &&
+        typeof blobLike.arrayBuffer === 'function');
 }
 /**
  * 是否存在 File 值