@polyv/request-plugin-polyv-business 2.0.0

package/README.md

@@ -0,0 +1,118 @@
+# PolyvBusinessRequestPlugin
+
+用途：保利威业务数据插件，用于在请求中自动插入业务相关的参数。
+
+> PS：该插件仅适用于 <span style="color: red">**api.polyv.net**</span> 下的接口
+
+## 实例化参数
+
+| 参数名 | 用途 | 类型 | 默认值 |
+| - | - | - | - |
+| `usePolyvBusiness` | 是否使用业务数据 | `boolean` | `true` |
+| `getBusinessData` | 获取业务数据的方法 | `function` | - |
+
+## 请求选项
+
+| 参数名 | 用途 | 类型 | 默认值 |
+| - | - | - | - |
+| `usePolyvBusiness` | 是否使用业务数据 | `boolean` | `true` |
+| `businessData` | 业务数据 | `PolyvBusinessData` | - |
+
+## 业务数据类型
+
+`PolyvBusinessData` 类型如下：
+
+| 参数名 | 用途 | 类型 | 默认值 |
+| - | - | - | - |
+| `sourceType` | 来源类型 | `string` | - |
+| `sourceId` | 来源 id | `string` | - |
+| `channelId` | 频道号 | `string` | - |
+| `viewerId` | 用户 id | `string` | - |
+| `unionId` | 用户系统唯一 id | `string` | - |
+
+## 使用方式
+
+```js
+import { PolyvRequest } from '@polyv/request-core';
+import { PolyvBusinessRequestPlugin } from '@polyv/request-plugin-polyv-business';
+
+// 自定义获取业务数据的方法
+const requester = new PolyvRequest({
+  requestPlugins: [
+    new PolyvBusinessRequestPlugin({
+      getBusinessData: async (options) => {
+        // 可以在这里实现自定义的业务数据获取逻辑
+        return {
+          sourceType: 'yourSourceType',
+          sourceId: 'yourSourceId',
+          channelId: 'yourChannelId',
+          viewerId: 'yourViewerId',
+          unionId: 'yourUnionId',
+        };
+      },
+    }),
+  ]
+});
+
+// 在某个请求中禁用业务数据
+requester.get('/api/data', {}, {
+  usePolyvBusiness: false,
+});
+
+// 在某个请求中使用特定的业务数据
+requester.get('/api/data', {}, {
+  businessData: {
+    sourceType: 'specificSourceType',
+    sourceId: 'specificSourceId',
+  },
+});
+```
+
+## 插件处理逻辑
+
+1. 插件会在请求中自动插入业务相关的参数，如 `sourceType`、`sourceId`、`channelId`、`viewerId`、`unionId` 等
+2. 插件会根据请求的 URL 判断需要插入哪些参数：
+   - 对于 `/live/v4/watch/common` 接口，插入 `sourceType` 和 `sourceId`
+   - 对于 `/live/v4/watch/viewer` 接口，插入 `sourceType`、`sourceId`、`viewerId` 和 `userId`
+   - 对于其他接口，插入 `channelId` 和 `viewerId`
+3. 如果你使用了 `@polyv/request-plugin-authorize-token` 令牌插件，本插件会根据 URL 判断是否使用 token 和 tokenField：
+   - 对于 `/live/v4/watch/common` 接口，会自动插入 `useToken` 为 false 禁用 token 插入
+   - 对于 `/live/v3` 接口，会将 `tokenField` 设置为 `token`，其他接口设置为 `viewerToken`
+
+```js
+import { PolyvRequest } from '@polyv/request-core';
+import { AuthorizeTokenRequestPlugin } from '@polyv/request-plugin-authorize-token';
+import { PolyvBusinessRequestPlugin } from '@polyv/request-plugin-polyv-business';
+
+const requester = new PolyvRequest({
+  baseUrl: 'https://api.polyv.net',
+  requestPlugins: [
+    new AuthorizeTokenRequestPlugin({
+      getTokenInfo: () => {
+        return {
+          // 只需要传入 token 即可
+          token: 'yourToken',
+        };
+      },
+    }),
+    new PolyvBusinessRequestPlugin({
+      getBusinessData: async (options) => {
+        // 可以在这里实现自定义的业务数据获取逻辑
+        return {
+          channelId: 'yourChannelId',
+          viewerId: 'yourViewerId',
+        };
+      },
+    }),
+  ]
+});
+
+// 不会插入 token
+requester.get('/live/v4/watch/common/xxx/xx/x', {});
+
+// 会插入 token，token 字段为 'token'
+requester.get('/live/v3/xxx/xx/x', {});
+
+// 会插入 token，token 字段为 'viewerToken'
+requester.get('/live/v4/xxx/xx/x', {});
+```

package/index.d.ts

@@ -0,0 +1,4 @@
+export * from './judge';
+export * from './polyv-business';
+export * from './types';
+export * from './request-options';

package/index.js

@@ -0,0 +1,4 @@
+export * from './judge';
+export * from './polyv-business';
+export * from './types';
+export * from './request-options';

package/judge.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 是否共用接口
+ *
+ * 判断地址：/live/v4/watch/common
+ *
+ * 插入参数：sourceId、sourceType
+ */
+export declare function isCommonRequest(url: string): boolean;
+/**
+ * 是否观众接口
+ *
+ * 判断地址：/live/v4/watch/viewer
+ *
+ * 插入参数：sourceId、sourceType、viewerId、userId
+ */
+export declare function isViewerRequest(url: string): boolean;
+/**
+ * 是否 v3 接口，/live/v3 开头的接口，使用 'token' 入参
+ *
+ * 判断地址：/live/v3
+ */
+export declare function isV3Request(url: string): boolean;

package/judge.js

@@ -0,0 +1,28 @@
+/**
+ * 是否共用接口
+ *
+ * 判断地址：/live/v4/watch/common
+ *
+ * 插入参数：sourceId、sourceType
+ */
+export function isCommonRequest(url) {
+    return url.indexOf('/live/v4/watch/common') !== -1;
+}
+/**
+ * 是否观众接口
+ *
+ * 判断地址：/live/v4/watch/viewer
+ *
+ * 插入参数：sourceId、sourceType、viewerId、userId
+ */
+export function isViewerRequest(url) {
+    return url.indexOf('/live/v4/watch/viewer') !== -1;
+}
+/**
+ * 是否 v3 接口，/live/v3 开头的接口，使用 'token' 入参
+ *
+ * 判断地址：/live/v3
+ */
+export function isV3Request(url) {
+    return url.indexOf('/live/v3') !== -1;
+}

package/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@polyv/request-plugin-polyv-business",
+  "version": "2.0.0",
+  "main": "./index.js",
+  "dependencies": {
+    "@polyv/request-core": "2.0.0",
+    "@polyv/request-plugin-authorize-token": "2.0.0",
+    "@polyv/request-plugin-global-params": "2.0.0"
+  },
+  "types": "./index.d.ts"
+}

package/polyv-business.d.ts

@@ -0,0 +1,23 @@
+import type { RequestOptions, RequestPlugin, PluginController } from "@polyv/request-core";
+import { PolyvBusinessRequestPluginConfig } from "./types";
+/**
+ * 保利威业务数据插件
+ */
+export declare class PolyvBusinessRequestPlugin implements RequestPlugin {
+    private __usePolyvBusiness;
+    private __config;
+    constructor(config: PolyvBusinessRequestPluginConfig);
+    installPlugin(pluginController: PluginController): void;
+    usePlugin(options: RequestOptions): boolean;
+    interceptIncludeParams(options: RequestOptions): void;
+    /**
+     * 检查业务数据是否存在
+     * @param businessData 业务数据
+     * @param fields 字段
+     */
+    private __checkBusiness;
+    /**
+     * 获取业务数据
+     */
+    private __getBusinessData;
+}

package/polyv-business.js

@@ -0,0 +1,96 @@
+import { GlobalParamsRequestPlugin } from '@polyv/request-plugin-global-params';
+import { isCommonRequest, isV3Request, isViewerRequest } from "./judge";
+/**
+ * 保利威业务数据插件
+ */
+export class PolyvBusinessRequestPlugin {
+    __usePolyvBusiness;
+    __config;
+    constructor(config) {
+        this.__config = config;
+        this.__usePolyvBusiness = config.usePolyvBusiness ?? true;
+    }
+    installPlugin(pluginController) {
+        // 插入全局参数插件
+        const globalParamsPlugin = new GlobalParamsRequestPlugin({
+            globalParams: async (requestOptions) => {
+                const params = {};
+                if (!this.usePlugin(requestOptions)) {
+                    return params;
+                }
+                const url = requestOptions.url || '';
+                const businessData = await this.__getBusinessData(requestOptions);
+                if (isCommonRequest(url) && this.__checkBusiness(businessData, ['sourceType', 'sourceId'])) {
+                    params.sourceType = businessData.sourceType;
+                    params.sourceId = businessData.sourceId;
+                }
+                else if (isViewerRequest(url) && this.__checkBusiness(businessData, ['sourceType', 'sourceId', 'viewerId', 'unionId'])) {
+                    params.sourceType = businessData.sourceType;
+                    params.sourceId = businessData.sourceId;
+                    params.viewerId = businessData.viewerId;
+                    params.userId = businessData.unionId;
+                }
+                else if (this.__checkBusiness(businessData, ['channelId', 'viewerId'])) {
+                    params.channelId = businessData.channelId;
+                    params.viewerId = businessData.viewerId;
+                }
+                return params;
+            },
+        });
+        pluginController.installPlugin(globalParamsPlugin);
+    }
+    usePlugin(options) {
+        const { usePolyvBusiness = this.__usePolyvBusiness } = options;
+        return usePolyvBusiness;
+    }
+    // 在注入阶段处理 token 的参数
+    interceptIncludeParams(options) {
+        const url = options.url || '';
+        options = options;
+        // 公共 api 接口，无需授权参数
+        if (isCommonRequest(url)) {
+            options.useToken = false;
+            return;
+        }
+        if (!options.tokenInfo) {
+            options.tokenInfo = {};
+        }
+        // 如果 tokenField 未设置，则根据 url 设置
+        if (!options.tokenInfo.tokenField) {
+            let tokenField = 'viewerToken';
+            if (isV3Request(url)) {
+                tokenField = 'token';
+            }
+            options.tokenInfo.tokenField = tokenField;
+        }
+    }
+    /**
+     * 检查业务数据是否存在
+     * @param businessData 业务数据
+     * @param fields 字段
+     */
+    __checkBusiness(businessData, fields) {
+        for (let i = 0; i < fields.length; i++) {
+            const field = fields[i];
+            const data = businessData[field];
+            if (!data) {
+                return false;
+            }
+        }
+        return true;
+    }
+    /**
+     * 获取业务数据
+     */
+    async __getBusinessData(options) {
+        let businessData = {};
+        if (typeof this.__config.getBusinessData === 'function') {
+            const res = await this.__config.getBusinessData(options) || {};
+            businessData = { ...businessData, ...res };
+        }
+        if (options.businessData) {
+            businessData = { ...businessData, ...options.businessData };
+        }
+        return businessData;
+    }
+}

package/request-options.d.ts

@@ -0,0 +1,22 @@
+import { PolyvBusinessData } from "./types";
+export interface PolyvBusinessRequestPluginOptions {
+    /**
+     * 是否使用业务数据
+     * @default true
+     * @plugin `PolyvBusinessRequestPlugin`
+     */
+    usePolyvBusiness?: boolean;
+    /**
+     * 业务数据
+     * @plugin `PolyvBusinessRequestPlugin`
+     */
+    businessData?: PolyvBusinessData;
+}
+declare module '@polyv/request-core' {
+    interface RequestCustomOptions extends PolyvBusinessRequestPluginOptions {
+    }
+}
+declare module 'axios' {
+    interface AxiosRequestConfig extends PolyvBusinessRequestPluginOptions {
+    }
+}

package/request-options.js

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

package/types.d.ts

@@ -0,0 +1,35 @@
+import { RequestOptions } from "@polyv/request-core";
+export interface PolyvBusinessRequestPluginConfig {
+    /**
+     * 是否使用业务数据
+     * @default true
+     */
+    usePolyvBusiness?: boolean;
+    /**
+     * 获取业务数据
+     */
+    getBusinessData?: GetBusinessDataFn;
+}
+export type GetBusinessDataFn = (options: RequestOptions) => Promise<PolyvBusinessData | void> | PolyvBusinessData | void;
+export interface PolyvBusinessData {
+    /**
+     * 来源类型
+     */
+    sourceType?: string;
+    /**
+     * 来源 id
+     */
+    sourceId?: string;
+    /**
+     * 频道号
+     */
+    channelId?: string;
+    /**
+     * 用户 id
+     */
+    viewerId?: string;
+    /**
+     * 用户系统唯一 id
+     */
+    unionId?: string;
+}

package/types.js

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