@polyv/request-plugin-polyv-business 2.7.0 → 2.8.0

package/README.md

@@ -6,29 +6,29 @@
 
 ## 实例化参数
 
-| 参数名 | 用途 | 类型 | 默认值 |
-| - | - | - | - |
-| `usePolyvBusiness` | 是否使用业务数据 | `boolean` | `true` |
-| `getBusinessData` | 获取业务数据的方法 | `function` | - |
+| 参数名             | 用途               | 类型       | 默认值 |
+| ------------------ | ------------------ | ---------- | ------ |
+| `usePolyvBusiness` | 是否使用业务数据   | `boolean`  | `true` |
+| `getBusinessData`  | 获取业务数据的方法 | `function` | -      |
 
 ## 请求选项
 
-| 参数名 | 用途 | 类型 | 默认值 |
-| - | - | - | - |
-| `usePolyvBusiness` | 是否使用业务数据 | `boolean` | `true` |
-| `businessData` | 业务数据 | `PolyvBusinessData` | - |
+| 参数名             | 用途             | 类型                | 默认值 |
+| ------------------ | ---------------- | ------------------- | ------ |
+| `usePolyvBusiness` | 是否使用业务数据 | `boolean`           | `true` |
+| `businessData`     | 业务数据         | `PolyvBusinessData` | -      |
 
 ## 业务数据类型
 
 `PolyvBusinessData` 类型如下：
 
-| 参数名 | 用途 | 类型 | 默认值 |
-| - | - | - | - |
-| `sourceType` | 来源类型 | `string` | - |
-| `sourceId` | 来源 id | `string` | - |
-| `channelId` | 频道号 | `string` | - |
-| `viewerId` | 用户 id | `string` | - |
-| `unionId` | 用户系统唯一 id | `string` | - |
+| 参数名       | 用途            | 类型     | 默认值 |
+| ------------ | --------------- | -------- | ------ |
+| `sourceType` | 来源类型        | `string` | -      |
+| `sourceId`   | 来源 id         | `string` | -      |
+| `channelId`  | 频道号          | `string` | -      |
+| `viewerId`   | 用户 id         | `string` | -      |
+| `unionId`    | 用户系统唯一 id | `string` | -      |
 
 ## 使用方式
 
@@ -40,7 +40,7 @@ import { PolyvBusinessRequestPlugin } from '@polyv/request-plugin-polyv-business
 const requester = new PolyvRequest({
   requestPlugins: [
     new PolyvBusinessRequestPlugin({
-      getBusinessData: async (options) => {
+      getBusinessData: async options => {
         // 可以在这里实现自定义的业务数据获取逻辑
         return {
           sourceType: 'yourSourceType',
@@ -51,21 +51,29 @@ const requester = new PolyvRequest({
         };
       },
     }),
-  ]
+  ],
 });
 
 // 在某个请求中禁用业务数据
-requester.get('/api/data', {}, {
-  usePolyvBusiness: false,
-});
+requester.get(
+  '/api/data',
+  {},
+  {
+    usePolyvBusiness: false,
+  },
+);
 
 // 在某个请求中使用特定的业务数据
-requester.get('/api/data', {}, {
-  businessData: {
-    sourceType: 'specificSourceType',
-    sourceId: 'specificSourceId',
+requester.get(
+  '/api/data',
+  {},
+  {
+    businessData: {
+      sourceType: 'specificSourceType',
+      sourceId: 'specificSourceId',
+    },
   },
-});
+);
 ```
 
 ## 保利威域名配置
@@ -111,7 +119,7 @@ const requester = new PolyvRequest({
       },
     }),
     new PolyvBusinessRequestPlugin({
-      getBusinessData: async (options) => {
+      getBusinessData: async options => {
         // 可以在这里实现自定义的业务数据获取逻辑
         return {
           channelId: 'yourChannelId',
@@ -119,7 +127,7 @@ const requester = new PolyvRequest({
         };
       },
     }),
-  ]
+  ],
 });
 
 // 不会插入 token

package/package.json

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

package/polyv-business.d.ts

@@ -1,5 +1,5 @@
-import type { RequestOptions, RequestPlugin, PluginController } from "@polyv/request-core";
-import { PolyvBusinessRequestPluginConfig } from "./types";
+import type { RequestOptions, RequestPlugin, PluginController } from '@polyv/request-core';
+import type { PolyvBusinessRequestPluginConfig } from './types';
 /**
  * 保利威业务数据插件
  */

package/polyv-business.js

@@ -1,5 +1,5 @@
 import { GlobalParamsRequestPlugin } from '@polyv/request-plugin-global-params';
-import { isWatchCommonRequest, isV3Request, isWatchViewerRequest, isChannelRequest } from "./judge";
+import { isWatchCommonRequest, isV3Request, isWatchViewerRequest, isChannelRequest } from './judge';
 /**
  * 保利威业务数据插件
  */
@@ -24,7 +24,8 @@ export class PolyvBusinessRequestPlugin {
                     params.sourceType = businessData.sourceType;
                     params.sourceId = businessData.sourceId;
                 }
-                else if (isWatchViewerRequest(url) && this.__checkBusiness(businessData, ['sourceType', 'sourceId', 'viewerId', 'unionId'])) {
+                else if (isWatchViewerRequest(url) &&
+                    this.__checkBusiness(businessData, ['sourceType', 'sourceId', 'viewerId', 'unionId'])) {
                     params.sourceType = businessData.sourceType;
                     params.sourceId = businessData.sourceId;
                     params.viewerId = businessData.viewerId;
@@ -91,7 +92,7 @@ export class PolyvBusinessRequestPlugin {
     async __getBusinessData(options) {
         let businessData = {};
         if (typeof this.__config.getBusinessData === 'function') {
-            const res = await this.__config.getBusinessData(options) || {};
+            const res = (await this.__config.getBusinessData(options)) || {};
             businessData = { ...businessData, ...res };
         }
         if (options.businessData) {

package/request-options.d.ts

@@ -1,4 +1,4 @@
-import { PolyvBusinessData } from "./types";
+import type { PolyvBusinessData } from './types';
 export interface PolyvBusinessRequestPluginOptions {
     /**
      * 是否使用业务数据

package/types.d.ts

@@ -1,4 +1,4 @@
-import { RequestOptions } from "@polyv/request-core";
+import type { RequestOptions } from '@polyv/request-core';
 export interface PolyvBusinessRequestPluginConfig {
     /**
      * 是否使用业务数据