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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,29 +6,29 @@
6
6
 
7
7
  ## 实例化参数
8
8
 
9
- | 参数名 | 用途 | 类型 | 默认值 |
10
- | - | - | - | - |
11
- | `usePolyvBusiness` | 是否使用业务数据 | `boolean` | `true` |
12
- | `getBusinessData` | 获取业务数据的方法 | `function` | - |
9
+ | 参数名 | 用途 | 类型 | 默认值 |
10
+ | ------------------ | ------------------ | ---------- | ------ |
11
+ | `usePolyvBusiness` | 是否使用业务数据 | `boolean` | `true` |
12
+ | `getBusinessData` | 获取业务数据的方法 | `function` | - |
13
13
 
14
14
  ## 请求选项
15
15
 
16
- | 参数名 | 用途 | 类型 | 默认值 |
17
- | - | - | - | - |
18
- | `usePolyvBusiness` | 是否使用业务数据 | `boolean` | `true` |
19
- | `businessData` | 业务数据 | `PolyvBusinessData` | - |
16
+ | 参数名 | 用途 | 类型 | 默认值 |
17
+ | ------------------ | ---------------- | ------------------- | ------ |
18
+ | `usePolyvBusiness` | 是否使用业务数据 | `boolean` | `true` |
19
+ | `businessData` | 业务数据 | `PolyvBusinessData` | - |
20
20
 
21
21
  ## 业务数据类型
22
22
 
23
23
  `PolyvBusinessData` 类型如下:
24
24
 
25
- | 参数名 | 用途 | 类型 | 默认值 |
26
- | - | - | - | - |
27
- | `sourceType` | 来源类型 | `string` | - |
28
- | `sourceId` | 来源 id | `string` | - |
29
- | `channelId` | 频道号 | `string` | - |
30
- | `viewerId` | 用户 id | `string` | - |
31
- | `unionId` | 用户系统唯一 id | `string` | - |
25
+ | 参数名 | 用途 | 类型 | 默认值 |
26
+ | ------------ | --------------- | -------- | ------ |
27
+ | `sourceType` | 来源类型 | `string` | - |
28
+ | `sourceId` | 来源 id | `string` | - |
29
+ | `channelId` | 频道号 | `string` | - |
30
+ | `viewerId` | 用户 id | `string` | - |
31
+ | `unionId` | 用户系统唯一 id | `string` | - |
32
32
 
33
33
  ## 使用方式
34
34
 
@@ -40,7 +40,7 @@ import { PolyvBusinessRequestPlugin } from '@polyv/request-plugin-polyv-business
40
40
  const requester = new PolyvRequest({
41
41
  requestPlugins: [
42
42
  new PolyvBusinessRequestPlugin({
43
- getBusinessData: async (options) => {
43
+ getBusinessData: async options => {
44
44
  // 可以在这里实现自定义的业务数据获取逻辑
45
45
  return {
46
46
  sourceType: 'yourSourceType',
@@ -51,21 +51,29 @@ const requester = new PolyvRequest({
51
51
  };
52
52
  },
53
53
  }),
54
- ]
54
+ ],
55
55
  });
56
56
 
57
57
  // 在某个请求中禁用业务数据
58
- requester.get('/api/data', {}, {
59
- usePolyvBusiness: false,
60
- });
58
+ requester.get(
59
+ '/api/data',
60
+ {},
61
+ {
62
+ usePolyvBusiness: false,
63
+ },
64
+ );
61
65
 
62
66
  // 在某个请求中使用特定的业务数据
63
- requester.get('/api/data', {}, {
64
- businessData: {
65
- sourceType: 'specificSourceType',
66
- sourceId: 'specificSourceId',
67
+ requester.get(
68
+ '/api/data',
69
+ {},
70
+ {
71
+ businessData: {
72
+ sourceType: 'specificSourceType',
73
+ sourceId: 'specificSourceId',
74
+ },
67
75
  },
68
- });
76
+ );
69
77
  ```
70
78
 
71
79
  ## 保利威域名配置
@@ -111,7 +119,7 @@ const requester = new PolyvRequest({
111
119
  },
112
120
  }),
113
121
  new PolyvBusinessRequestPlugin({
114
- getBusinessData: async (options) => {
122
+ getBusinessData: async options => {
115
123
  // 可以在这里实现自定义的业务数据获取逻辑
116
124
  return {
117
125
  channelId: 'yourChannelId',
@@ -119,7 +127,7 @@ const requester = new PolyvRequest({
119
127
  };
120
128
  },
121
129
  }),
122
- ]
130
+ ],
123
131
  });
124
132
 
125
133
  // 不会插入 token
package/package.json CHANGED
@@ -1,11 +1,13 @@
1
1
  {
2
2
  "name": "@polyv/request-plugin-polyv-business",
3
- "version": "2.7.1",
3
+ "version": "2.8.0",
4
4
  "main": "./index.js",
5
5
  "dependencies": {
6
- "@polyv/request-core": "2.7.1",
7
- "@polyv/request-plugin-authorize-token": "2.7.1",
8
- "@polyv/request-plugin-global-params": "2.7.1"
6
+ "@polyv/request-core": "2.8.0",
7
+ "@polyv/request-plugin-authorize-token": "2.8.0",
8
+ "@polyv/request-plugin-global-params": "2.8.0"
9
9
  },
10
- "types": "./index.d.ts"
10
+ "types": "./index.d.ts",
11
+ "type": "module",
12
+ "miniprogram": "./"
11
13
  }
@@ -1,5 +1,5 @@
1
- import type { RequestOptions, RequestPlugin, PluginController } from "@polyv/request-core";
2
- import { PolyvBusinessRequestPluginConfig } from "./types";
1
+ import type { RequestOptions, RequestPlugin, PluginController } from '@polyv/request-core';
2
+ import type { PolyvBusinessRequestPluginConfig } from './types';
3
3
  /**
4
4
  * 保利威业务数据插件
5
5
  */
package/polyv-business.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import { GlobalParamsRequestPlugin } from '@polyv/request-plugin-global-params';
2
- import { isWatchCommonRequest, isV3Request, isWatchViewerRequest, isChannelRequest } from "./judge";
2
+ import { isWatchCommonRequest, isV3Request, isWatchViewerRequest, isChannelRequest } from './judge';
3
3
  /**
4
4
  * 保利威业务数据插件
5
5
  */
@@ -24,7 +24,8 @@ export class PolyvBusinessRequestPlugin {
24
24
  params.sourceType = businessData.sourceType;
25
25
  params.sourceId = businessData.sourceId;
26
26
  }
27
- else if (isWatchViewerRequest(url) && this.__checkBusiness(businessData, ['sourceType', 'sourceId', 'viewerId', 'unionId'])) {
27
+ else if (isWatchViewerRequest(url) &&
28
+ this.__checkBusiness(businessData, ['sourceType', 'sourceId', 'viewerId', 'unionId'])) {
28
29
  params.sourceType = businessData.sourceType;
29
30
  params.sourceId = businessData.sourceId;
30
31
  params.viewerId = businessData.viewerId;
@@ -91,7 +92,7 @@ export class PolyvBusinessRequestPlugin {
91
92
  async __getBusinessData(options) {
92
93
  let businessData = {};
93
94
  if (typeof this.__config.getBusinessData === 'function') {
94
- const res = await this.__config.getBusinessData(options) || {};
95
+ const res = (await this.__config.getBusinessData(options)) || {};
95
96
  businessData = { ...businessData, ...res };
96
97
  }
97
98
  if (options.businessData) {
@@ -1,4 +1,4 @@
1
- import { PolyvBusinessData } from "./types";
1
+ import type { PolyvBusinessData } from './types';
2
2
  export interface PolyvBusinessRequestPluginOptions {
3
3
  /**
4
4
  * 是否使用业务数据
package/types.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { RequestOptions } from "@polyv/request-core";
1
+ import type { RequestOptions } from '@polyv/request-core';
2
2
  export interface PolyvBusinessRequestPluginConfig {
3
3
  /**
4
4
  * 是否使用业务数据