@polyv/request-plugin-authorize-token 2.7.0 → 2.8.0

package/README.md

@@ -4,30 +4,30 @@
 
 ## 实例化参数
 
-| 参数名 | 用途 | 类型 | 默认值 |
-| - | - | - | - |
-| `useToken` | 默认使用 token 插件 | `boolean` | `true` |
-| `responseTokenField` | 在响应中返回的令牌字段 | `string` | - |
-| `getTokenInfo` | 获取授权令牌信息 | `function` | - |
-| `responseTokenCallback` | 响应中获取令牌后的回调 | `function` | - |
+| 参数名                  | 用途                   | 类型       | 默认值 |
+| ----------------------- | ---------------------- | ---------- | ------ |
+| `useToken`              | 默认使用 token 插件    | `boolean`  | `true` |
+| `responseTokenField`    | 在响应中返回的令牌字段 | `string`   | -      |
+| `getTokenInfo`          | 获取授权令牌信息       | `function` | -      |
+| `responseTokenCallback` | 响应中获取令牌后的回调 | `function` | -      |
 
 ## 请求选项
 
-| 参数名 | 用途 | 类型 | 默认值 |
-| - | - | - | - |
-| `useToken` | 是否使用 token 授权 | `boolean` | `true` |
-| `tokenInfo` | 令牌信息 | `TokenInfo` | - |
+| 参数名      | 用途                | 类型        | 默认值 |
+| ----------- | ------------------- | ----------- | ------ |
+| `useToken`  | 是否使用 token 授权 | `boolean`   | `true` |
+| `tokenInfo` | 令牌信息            | `TokenInfo` | -      |
 
 ## 令牌信息类型
 
 `TokenInfo` 类型如下：
 
-| 参数名 | 用途 | 类型 | 默认值 |
-| - | - | - | - |
-| `token` | 授权令牌 | `string` | - |
-| `tokenMode` | 令牌方式，仅在 request 中生效 | `TokenMode` | `TokenMode.Params` |
-| `tokenField` | 在请求中插入的令牌字段 | `string` | `'token'` |
-| `includeParams` | 插入的 params | `object` | - |
+| 参数名          | 用途                          | 类型        | 默认值             |
+| --------------- | ----------------------------- | ----------- | ------------------ |
+| `token`         | 授权令牌                      | `string`    | -                  |
+| `tokenMode`     | 令牌方式，仅在 request 中生效 | `TokenMode` | `TokenMode.Params` |
+| `tokenField`    | 在请求中插入的令牌字段        | `string`    | `'token'`          |
+| `includeParams` | 插入的 params                 | `object`    | -                  |
 
 ## 使用方式
 
@@ -43,14 +43,14 @@ const requester = new PolyvRequest({
       tokenMode: TokenMode.Header,
       tokenField: 'xAuthToken',
     }),
-  ]
+  ],
 });
 
 // 方式二（推荐）：支持传入 getTokenInfo 方法获取，返回 TokenInfo 类型，优先级高于直接传入
 const requester = new PolyvRequest({
   requestPlugins: [
     new AuthorizeTokenRequestPlugin({
-      getTokenInfo: async (options) => {
+      getTokenInfo: async options => {
         return {
           token: 'xxxxx',
           tokenMode: TokenMode.Header,
@@ -62,22 +62,30 @@ const requester = new PolyvRequest({
         };
       },
     }),
-  ]
+  ],
 });
 
 // 方式三：调用时传入 tokenInfo
-requester.get('/xxx', {}, {
-  tokenInfo: {
-    token: 'xxxxx',
-    tokenMode: TokenMode.Params,
-    tokenField: 'xAuthToken',
+requester.get(
+  '/xxx',
+  {},
+  {
+    tokenInfo: {
+      token: 'xxxxx',
+      tokenMode: TokenMode.Params,
+      tokenField: 'xAuthToken',
+    },
   },
-});
+);
 
 // 如果你想在某个请求中，不处理令牌操作时
-requester.get('/xxxx', {}, {
-  useToken: false,
-});
+requester.get(
+  '/xxxx',
+  {},
+  {
+    useToken: false,
+  },
+);
 ```
 
 ### TokenMode 区别
@@ -94,11 +102,11 @@ const requester = new PolyvRequest({
   requestPlugins: [
     new AuthorizeTokenRequestPlugin({
       responseTokenField: 'x-auth-token',
-      responseTokenCallback: (data) => {
+      responseTokenCallback: data => {
         console.log('从接口响应中获取到的令牌', data.token);
       },
     }),
-  ]
+  ],
 });
 ```
 

package/authorize-token.d.ts

@@ -1,5 +1,5 @@
 import type { RequestOptions, RequestPlugin, RequestResult } from '@polyv/request-core';
-import { AuthorizeTokenRequestPluginConfig, TokenInfo } from './types';
+import { type AuthorizeTokenRequestPluginConfig, type TokenInfo } from './types';
 /**
  * 授权 token 请求插件
  */

package/authorize-token.js

@@ -26,7 +26,7 @@ export class AuthorizeTokenRequestPlugin {
         if (!token) {
             return options;
         }
-        const { tokenField = DEFAULT_TOKEN_FIELD, tokenMode = DEFAULT_TOKEN_MODE, includeParams = {}, } = tokenInfo;
+        const { tokenField = DEFAULT_TOKEN_FIELD, tokenMode = DEFAULT_TOKEN_MODE, includeParams = {} } = tokenInfo;
         let params = (options.params || {});
         const headers = (options.headers || {});
         // 插入额外的 params
@@ -75,7 +75,7 @@ export class AuthorizeTokenRequestPlugin {
         };
         if (typeof this.__config.getTokenInfo === 'function') {
             // 第二优先：实例化参数的 getToken
-            const res = await this.__config.getTokenInfo(options) || {};
+            const res = (await this.__config.getTokenInfo(options)) || {};
             info = { ...info, ...res };
         }
         if (options.tokenInfo) {

package/package.json

@@ -1,9 +1,11 @@
 {
   "name": "@polyv/request-plugin-authorize-token",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "main": "./index.js",
   "dependencies": {
-    "@polyv/request-core": "2.7.0"
+    "@polyv/request-core": "2.8.0"
   },
-  "types": "./index.d.ts"
+  "types": "./index.d.ts",
+  "type": "module",
+  "miniprogram": "./"
 }

package/request-options.d.ts

@@ -1,4 +1,4 @@
-import { TokenInfo } from './types';
+import type { TokenInfo } from './types';
 export interface AuthorizeTokenRequestOptions {
     /**
      * 是否使用 token 授权

package/types.d.ts

@@ -1,4 +1,4 @@
-import { RequestOptions } from "@polyv/request-core";
+import type { RequestOptions } from '@polyv/request-core';
 export interface AuthorizeTokenRequestPluginConfig extends TokenInfo {
     /**
      * 默认使用 token 插件
@@ -6,7 +6,7 @@ export interface AuthorizeTokenRequestPluginConfig extends TokenInfo {
      */
     useToken?: boolean;
     /**
-     * 在响应中返回的令牌字段
+     * 在响应中返回的令牌字段，传入后，如果响应头中存在令牌则插件内部记录，并在后续的请求中自动带上令牌
      */
     responseTokenField?: string;
     /**