@newbeebox/newbeebox-client-web-sdk 1.0.8 → 1.0.9

package/README.md

@@ -1,45 +1,87 @@
 ## 新手盒子客户端SDK
+
 用于Web类第三方应用调用新手盒子客户端相关功能的开发组件。
 
 ### 安装
+
 ```bash
 npm install @newbeebox/newbeebox-client-web-sdk
 ```
 
 ### 快速上手
-代码示例:
 
 ```javascript
-    // 引用
-    import {NewBeeClient} from "@newbeebox/newbeebox-client-web-sdk"
-    
-    // 1.初始化客户端
-    let client = new NewBeeClient();
-    //  注册应用
-    await client.Init("newbee_appid");
-    
-    // 2.功能调用
-    // 示例一: 打开应用订阅界面
-    await client.ShowSubscriptionPage();
-    
-    // 示例二: 获取当前用户订阅信息
-    let user_subscribe_info = await client.GetSubscriptionInfo();
-    console.log(user_subscribe_info);
-    // 输出:
-    {
-        "app_id": "nb1721e87",
-        "user": {
-            "open_id": "nb0d968311...",
-            "nickname": "Kyuu",
-            "avatar": "https://cdn8.newbeebox.com/...."
-        },
-        "subscribe_mode": 1,
-        "end_time": 0,
-        "level": 0,
-        "level_label": "",
-        "is_yearly": false,
-        "timestamp": 1758613861250,
-        "nonce": 6363921989,
-        "sign": "485d82860578ff..."
-    }
-```
+// 引用
+import { NewBeeClient } from "@newbeebox/newbeebox-client-web-sdk"
+
+// 1.初始化客户端
+let client = new NewBeeClient();
+await client.Init("your_app_id");
+
+// 2.功能调用
+// 打开应用订阅界面
+await client.ShowSubscriptionPage();
+
+// 获取当前用户订阅信息
+let info = await client.GetUserSubscription();
+console.log(info);
+```
+
+### API
+
+#### `Init(app_id: string): Promise<void>`
+
+初始化SDK，扫描本地端口连接新手盒子客户端。
+
+| 参数 | 类型 | 说明 |
+|------|------|------|
+| app_id | string | 应用ID，从后台获取 |
+
+#### `ShowSubscriptionPage(): Promise<boolean>`
+
+打开应用订阅界面。
+
+#### `GetUserSubscription(): Promise<UserSubscribeInfo>`
+
+获取当前用户的订阅信息。
+
+#### `InstallWoWAddon(game_version_id, mod_id): Promise<any>`
+
+安装魔兽世界插件。
+
+| 参数 | 类型 | 说明 |
+|------|------|------|
+| game_version_id | string \| number | 游戏版本ID |
+| mod_id | string \| number | 插件ID |
+
+#### `Patch(tool_name, data?): Promise<any>`
+
+通用请求接口，当SDK未导出指定接口时可使用此方法。
+
+| 参数 | 类型 | 说明 |
+|------|------|------|
+| tool_name | string | 完整API路径，如 `/tool/some_api` |
+| data | object | 请求数据（可选） |
+
+---
+
+**订阅信息返回结构**：
+
+```javascript
+{
+    "app_id": "nb1721e87",
+    "user": {
+        "open_id": "nb0d968311...",
+        "nickname": "Kyuu",
+        "avatar": "https://cdn8.newbeebox.com/...."
+    },
+    "subscribe_mode": 1,   // 1=作者订阅, 2=应用订阅
+    "end_time": 0,         // 到期时间戳
+    "level": 0,            // 订阅等级
+    "level_label": "",     // 等级标签
+    "is_yearly": false,    // 是否年订阅
+    "timestamp": 1758613861250,
+    "nonce": 6363921989,
+    "sign": "485d82860578ff..."  // 签名，用于服务端验证
+}
+```

package/index.js

@@ -13,6 +13,13 @@ export class NewBeeClient {
 
     constructor() {}
 
+    // 检测客户端是否已初始化
+    _ensureInitialized() {
+        if (!this.newbee_client_port) {
+            throw new Error("SDK未初始化或者未检测到新手盒子客户端");
+        }
+    }
+
     async Init(app_id) {
         if (!app_id || typeof app_id !== "string") {
             throw new Error("APPID格式不正确 请前往后台获取");
@@ -63,10 +70,7 @@ export class NewBeeClient {
 
     // 打开应用订阅界面
     async ShowSubscriptionPage() {
-        if (!this.newbee_client_port) {
-            throw new Error("SDK未初始化或者未检测到新手盒子客户端");
-        }
-
+        this._ensureInitialized();
 
         // 创建 AbortController 实例
         const controller = new AbortController();
@@ -111,9 +115,7 @@ export class NewBeeClient {
 
     // 获取当前使用的用户的订阅信息
     async GetUserSubscription() {
-        if (!this.newbee_client_port) {
-            throw new Error("SDK未初始化或者未检测到新手盒子客户端");
-        }
+        this._ensureInitialized();
 
         let user_subscribe_response  = null;
         try {
@@ -141,4 +143,67 @@ export class NewBeeClient {
 
         return user_subscribe_response.data
     }
+
+    // 安装魔兽世界插件
+    async InstallWoWAddon(game_version_id, mod_id) {
+        this._ensureInitialized();
+
+        let install_response = null;
+        try {
+            let response = await fetch(CLIENT_SERVICE_BASE_URL + ":" + this.newbee_client_port + "/tool/wow_install_addon", {
+                method: "POST",
+                headers: {
+                    "Content-Type": 'application/json',
+                },
+                body: JSON.stringify({
+                    app_id: this.app_id,
+                    game_version_id: game_version_id,
+                    mod_id: mod_id
+                })
+            });
+
+            install_response = await response.json();
+
+            console.log("安装插件响应:", install_response);
+        } catch (e) {
+            console.log("安装插件错误:", e);
+        }
+
+        if (!install_response || install_response?.code !== 1) {
+            throw new Error("安装魔兽世界插件发生错误:" + (install_response?.message || "未知错误"));
+        }
+
+        return install_response.data;
+    }
+
+    // 通用请求 当没有导出指定接口时可以使用这个函数补充请求
+    async Patch(tool_name, data) {
+        this._ensureInitialized();
+
+        let patch_response = null;
+        try {
+            let response = await fetch(CLIENT_SERVICE_BASE_URL + ":" + this.newbee_client_port + tool_name, {
+                method: "POST",
+                headers: {
+                    "Content-Type": 'application/json',
+                },
+                body: JSON.stringify({
+                    app_id: this.app_id,
+                    ...data
+                })
+            });
+
+            patch_response = await response.json();
+
+            console.log("Patch响应:", patch_response);
+        } catch (e) {
+            console.log("Patch请求错误:", e);
+        }
+
+        if (!patch_response || patch_response?.code !== 1) {
+            throw new Error("Patch请求发生错误:" + (patch_response?.message || "未知错误"));
+        }
+
+        return patch_response.data;
+    }
 }

package/package.json

@@ -1,29 +1,29 @@
-{
-  "name": "@newbeebox/newbeebox-client-web-sdk",
-  "version": "1.0.8",
-  "description": "NewBeeBox Client SDK for Web",
-  "main": "index.js",
-  "type": "module",
-  "types": "./types/index.d.ts",
-  "files": [
-    "*.js",
-    "types/*.d.ts"
-  ],
-  "scripts": {
-    "release:patch": "npm version patch && npm publish",
-    "release:minor": "npm version minor && npm publish",
-    "release:major": "npm version major && npm publish"
-  },
-  "keywords": [
-    "newbeebox",
-    "wow",
-    "sdk",
-    "client"
-  ],
-  "author": "NewBeeBoxTeam",
-  "license": "ISC",
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/",
-    "access": "public"
-  }
-}
+{
+  "name": "@newbeebox/newbeebox-client-web-sdk",
+  "version": "1.0.9",
+  "description": "NewBeeBox Client SDK for Web",
+  "main": "index.js",
+  "type": "module",
+  "types": "./types/index.d.ts",
+  "files": [
+    "*.js",
+    "types/*.d.ts"
+  ],
+  "scripts": {
+    "release:patch": "npm version patch && npm publish",
+    "release:minor": "npm version minor && npm publish",
+    "release:major": "npm version major && npm publish"
+  },
+  "keywords": [
+    "newbeebox",
+    "wow",
+    "sdk",
+    "client"
+  ],
+  "author": "NewBeeBoxTeam",
+  "license": "ISC",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  }
+}

package/types/index.d.ts

@@ -33,6 +33,22 @@ export class NewBeeClient {
      * @return {Promise<UserSubscribeInfo>}
      */
     GetUserSubscription(): Promise<UserSubscribeInfo>;
+
+    /**
+     * 安装魔兽世界插件
+     * @param game_version_id 游戏版本ID
+     * @param mod_id 插件ID
+     * @return {Promise<any>}
+     */
+    InstallWoWAddon(game_version_id: string | number, mod_id: string | number): Promise<any>;
+
+    /**
+     * 通用请求接口
+     * @param tool_name 完整API路径，如 /tool/some_api
+     * @param data 请求数据
+     * @return {Promise<any>}
+     */
+    Patch(tool_name: string, data?: Record<string, any>): Promise<any>;
 }
 
 /**