@polyv/request-plugin-aes-decrypt 2.7.0 → 2.8.0

package/README.md

@@ -4,45 +4,42 @@
 
 ## 实例化参数
 
-| 参数名 | 用途 | 类型 | 默认值 |
-| - | - | - | - |
-| `decryptKeys` | 解密密钥信息 | `AESKeyInfo` | - |
-| `decryptPosition` | 解密位置 | `AESDecryptPosition` | `AESDecryptPosition.ResponseData` |
-| `getDecryptInfo` | 获取解密信息的方法 | `function` | - |
+| 参数名            | 用途               | 类型                 | 默认值                            |
+| ----------------- | ------------------ | -------------------- | --------------------------------- |
+| `decryptKeys`     | 解密密钥信息       | `AESKeyInfo`         | -                                 |
+| `decryptPosition` | 解密位置           | `AESDecryptPosition` | `AESDecryptPosition.ResponseData` |
+| `getDecryptInfo`  | 获取解密信息的方法 | `function`           | -                                 |
 
 ## 请求选项
 
-| 参数名 | 用途 | 类型 | 默认值 |
-| - | - | - | - |
-| `useAESDecrypt` | 是否使用 AES 解密 | `boolean` | `false` |
-| `aesDecryptInfo` | AES 解密信息 | `AESDecryptInfo` | - |
+| 参数名           | 用途              | 类型             | 默认值  |
+| ---------------- | ----------------- | ---------------- | ------- |
+| `useAESDecrypt`  | 是否使用 AES 解密 | `boolean`        | `false` |
+| `aesDecryptInfo` | AES 解密信息      | `AESDecryptInfo` | -       |
 
 ## 解密密钥信息类型
 
 `AESKeyInfo` 类型如下：
 
-| 参数名 | 用途 | 类型 | 默认值 |
-| - | - | - | - |
-| `sign` | 解密签名（密钥） | `string` | - |
-| `iv` | 解密偏移量 | `string` | - |
+| 参数名 | 用途             | 类型     | 默认值 |
+| ------ | ---------------- | -------- | ------ |
+| `sign` | 解密签名（密钥） | `string` | -      |
+| `iv`   | 解密偏移量       | `string` | -      |
 
 ## 解密位置枚举
 
 `AESDecryptPosition` 枚举如下：
 
-| 枚举值 | 描述 |
-| - | - |
-| `AESDecryptPosition.WholeResponse` | 解密整个响应数据 |
-| `AESDecryptPosition.ResponseData` | 仅解密响应中的 data 字段 |
+| 枚举值                             | 描述                     |
+| ---------------------------------- | ------------------------ |
+| `AESDecryptPosition.WholeResponse` | 解密整个响应数据         |
+| `AESDecryptPosition.ResponseData`  | 仅解密响应中的 data 字段 |
 
 ## 使用方式
 
 ```js
 import { PolyvRequest } from '@polyv/request-core';
-import { 
-  AESDecryptRequestPlugin, 
-  AESDecryptPosition
-} from '@polyv/request-plugin-aes-decrypt';
+import { AESDecryptRequestPlugin, AESDecryptPosition } from '@polyv/request-plugin-aes-decrypt';
 
 // 基础用法：使用固定的解密密钥
 const requester = new PolyvRequest({
@@ -53,7 +50,7 @@ const requester = new PolyvRequest({
         iv: 'yourDecryptIV',
       },
     }),
-  ]
+  ],
 });
 
 // 配置解密位置
@@ -66,14 +63,14 @@ const requester = new PolyvRequest({
       },
       decryptPosition: AESDecryptPosition.WholeResponse,
     }),
-  ]
+  ],
 });
 
 // 使用 getDecryptInfo 方法动态获取解密信息
 const requester = new PolyvRequest({
   requestPlugins: [
     new AESDecryptRequestPlugin({
-      getDecryptInfo: async (options) => {
+      getDecryptInfo: async options => {
         // 可以根据 options 中的信息动态获取解密密钥
         return {
           decryptKeys: {
@@ -84,25 +81,33 @@ const requester = new PolyvRequest({
         };
       },
     }),
-  ]
+  ],
 });
 
 // 在某个请求中启用 AES 解密
-requester.get('/api/data', {}, {
-  useAESDecrypt: true,
-});
+requester.get(
+  '/api/data',
+  {},
+  {
+    useAESDecrypt: true,
+  },
+);
 
 // 在某个请求中使用特定的解密信息
-requester.get('/api/data', {}, {
-  useAESDecrypt: true,
-  aesDecryptInfo: {
-    decryptKeys: {
-      sign: 'specificKey',
-      iv: 'specificIV',
+requester.get(
+  '/api/data',
+  {},
+  {
+    useAESDecrypt: true,
+    aesDecryptInfo: {
+      decryptKeys: {
+        sign: 'specificKey',
+        iv: 'specificIV',
+      },
+      decryptPosition: AESDecryptPosition.WholeResponse,
     },
-    decryptPosition: AESDecryptPosition.WholeResponse,
   },
-});
+);
 ```
 
 ## 解密处理逻辑
@@ -110,4 +115,4 @@ requester.get('/api/data', {}, {
 1. 插件默认不启用，需要在请求选项中设置 `useAESDecrypt: true` 或全局配置启用
 2. 解密信息的优先级为：请求选项中的 `aesDecryptInfo` > `getDecryptInfo` 方法返回的信息 > 初始化时提供的配置
 3. 根据 `decryptPosition` 的设置，可以选择解密整个响应数据或只解密响应中的 data 字段
-4. 解密后，如果解密结果是有效的 JSON 字符串，会自动解析为 JavaScript 对象 
+4. 解密后，如果解密结果是有效的 JSON 字符串，会自动解析为 JavaScript 对象

package/aes-decrypt-plugin.d.ts

@@ -1,5 +1,5 @@
 import type { RequestOptions, RequestPlugin, RequestResult } from '@polyv/request-core';
-import { AESDecryptRequestPluginConfig } from './types';
+import { type AESDecryptRequestPluginConfig } from './types';
 /**
  * aes 解密请求插件
  */

package/aes-decrypt-plugin.js

@@ -45,7 +45,7 @@ export class AESDecryptRequestPlugin {
         };
         if (typeof this.__config.getDecryptInfo === 'function') {
             // 第二优先：实例化参数的 getDecryptInfo
-            const res = await this.__config.getDecryptInfo(options) || {};
+            const res = (await this.__config.getDecryptInfo(options)) || {};
             info = { ...info, ...res };
         }
         if (options.aesDecryptInfo) {

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@polyv/request-plugin-aes-decrypt",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "main": "./index.js",
   "dependencies": {
-    "@polyv/request-core": "2.7.0",
+    "@polyv/request-core": "2.8.0",
     "aes-js": "^3.1.2",
     "crypto-js": "^4.1.1",
     "js-base64": "^3.7.5"
   },
-  "types": "./index.d.ts"
+  "types": "./index.d.ts",
+  "type": "module",
+  "miniprogram": "./"
 }

package/request-options.d.ts

@@ -1,4 +1,4 @@
-import { AESDecryptInfo } from './types';
+import type { AESDecryptInfo } from './types';
 export interface AESDecryptRequestOptions {
     /**
      * 使用 aes 解密 data

package/utils.d.ts

@@ -1,4 +1,4 @@
-import { AESDecryptType, AESKeyInfo } from './types';
+import { AESDecryptType, type AESKeyInfo } from './types';
 /**
  * 解密数据（hex 方式）
  * @param encryptedText 加密内容

package/utils.js

@@ -14,7 +14,7 @@ const str2ab = (str, len) => {
     if (bytesLen >= len) {
         return bytes.slice(0, len);
     }
-    return ([].concat(...(new Array(Math.ceil(len / bytesLen)).fill(bytes)))).slice(0, len);
+    return [].concat(...new Array(Math.ceil(len / bytesLen)).fill(bytes)).slice(0, len);
 };
 /**
  * 解密数据（hex 方式）
@@ -75,7 +75,6 @@ export function decryptTextHex(encryptedText, sign, customIV) {
     if (customIV) {
         iv = str2ab(customIV, 16);
     }
-    // eslint-disable-next-line
     const aesCfb = new aesjs.ModeOfOperation.cbc(key, iv);
     const decryptedBytes = aesCfb.decrypt(encryptedBytes);
     const decryptedText = aesjs.utils.utf8.fromBytes(decryptedBytes);