@newbeebox/newbeebox-client-web-sdk 1.0.11 → 1.0.14

package/README.md

@@ -25,6 +25,10 @@ await client.ShowSubscriptionPage();
 // 获取当前用户订阅信息
 let info = await client.GetUserSubscription();
 console.log(info);
+
+// 获取当前登录用户信息
+let user = await client.GetUserInfo();
+console.log(user);
 ```
 
 ### API
@@ -45,6 +49,10 @@ console.log(info);
 
 获取当前用户的订阅信息。
 
+#### `GetUserInfo(): Promise<UserAccountInfo>`
+
+获取当前登录用户的基础信息。用户未登录时抛出错误。
+
 #### `InstallWoWAddon(game_version_id, addon_id, secret_key?): Promise<any>`
 
 安装魔兽世界插件。
@@ -64,6 +72,18 @@ console.log(info);
 | tool_name | string | 完整API路径，如 `/tool/some_api` |
 | data | object | 请求数据（可选） |
 
+### 错误处理
+
+所有接口失败时都会抛出 `Error`，`message` 格式统一为 `<操作>发生错误:<原因>`。
+
+如果用户安装的客户端版本过低、没有所调用的接口，`<原因>` 固定为：
+
+```
+当前客户端不支持该接口，请升级新手盒子客户端
+```
+
+所有接口（含 `Patch`）行为一致，第三方应用可据此提示用户升级客户端。
+
 ---
 
 **订阅信息返回结构**：
@@ -86,3 +106,20 @@ console.log(info);
     "sign": "485d82860578ff..."  // 签名，用于服务端验证
 }
 ```
+
+
+**用户信息返回结构**：
+
+```javascript
+{
+    "id": 10001,               // 用户ID
+    "username": "Kyuu",        // 用户名
+    "avatar": "https://cdn8.newbeebox.com/....",
+    "isVip": true,             // 是否是 VIP
+    "vip": {                   // 非 VIP 时为 null
+        "isYearly": false,     // 是否年费会员
+        "adFree": true,        // 是否免广告
+        "endTime": 1790000000000  // 会员到期时间戳
+    }
+}
+```

package/index.js

@@ -1,11 +1,114 @@
+// 当前 SDK 版本号（发布新版本时请同步 package.json 的 version 字段）
+const SDK_VERSION = "1.0.13";
 // 设置超时时间
 const CLIENT_CHECK_TIMEOUT = 200; // 0.2秒
 // 任务超时时间
 const TASK_REQUEST_TIMEOUT = 1000; // 1秒
 // 客户端可能使用的端口列表
-const LOCAL_PORT_LIST = [35560, 35561, 35562, 35563, 35564, 35565, 35566, 35567, 35568, 35569, 35570, 35571, 35572, 35573, 35574, 35575, 35576, 35577, 35578, 35579];
+// 原始端口列表（兼容已部署的老 SDK，必须保留且优先）
+const LEGACY_PORT_LIST = [
+    35560, 35561, 35562, 35563, 35564, 35565, 35566, 35567, 35568, 35569,
+    35570, 35571, 35572, 35573, 35574, 35575, 35576, 35577, 35578, 35579,
+];
+// 新增端口列表（抗端口被整段占用，分散在多个不相邻区间）
+const EXTRA_PORT_LIST = [
+    1278, 6817, 11456, 14923, 19372, 23814, 28651, 33279, 41537, 46813,
+];
+// 实际使用的候选端口：原始端口优先，其后接新增端口
+const LOCAL_PORT_LIST = [...LEGACY_PORT_LIST, ...EXTRA_PORT_LIST];
 // 服务端地址
 const CLIENT_SERVICE_BASE_URL = "http://127.0.0.1";
+
+// 端口缓存的 key
+const PORT_CACHE_KEY = "nbb_client_port";
+// 内存兜底缓存：用于没有 localStorage 的环境（Electron 主进程 / Node / 受限 webview）
+let _memPortCache = null;
+
+// 读取缓存端口：优先 localStorage，不可用时回退内存缓存（兼容浏览器/Electron/Tauri/Node）
+function readPortCache() {
+    try {
+        if (typeof localStorage !== "undefined" && localStorage) {
+            const v = localStorage.getItem(PORT_CACHE_KEY);
+            if (v) return Number(v) || null;
+        }
+    } catch (e) { /* localStorage 不可用，忽略，走内存缓存 */ }
+    return _memPortCache;
+}
+
+// 写入缓存端口：内存 + localStorage(若可用)
+function writePortCache(port) {
+    _memPortCache = port;
+    try {
+        if (typeof localStorage !== "undefined" && localStorage) {
+            localStorage.setItem(PORT_CACHE_KEY, String(port));
+        }
+    } catch (e) { /* 忽略 */ }
+}
+
+// 清除缓存端口
+function clearPortCache() {
+    _memPortCache = null;
+    try {
+        if (typeof localStorage !== "undefined" && localStorage) {
+            localStorage.removeItem(PORT_CACHE_KEY);
+        }
+    } catch (e) { /* 忽略 */ }
+}
+
+// 探测单个端口的 /ping：成功 resolve(port)，失败 reject
+function pingPort(port) {
+    return new Promise((resolve, reject) => {
+        const controller = new AbortController();
+        const timeoutId = setTimeout(() => controller.abort(), CLIENT_CHECK_TIMEOUT);
+        fetch(CLIENT_SERVICE_BASE_URL + ":" + port + "/ping", {
+            method: "GET",
+            signal: controller.signal,
+        })
+            .then((response) => response.json())
+            .then((data) => {
+                clearTimeout(timeoutId);
+                if (data && data.code === 1) resolve(port);
+                else reject(new Error("not newbee client"));
+            })
+            .catch((e) => {
+                clearTimeout(timeoutId);
+                reject(e);
+            });
+    });
+}
+
+// 并行探测多个端口，返回第一个成功的端口
+// 不依赖 Promise.any（ES2021），自己实现以兼容老版本 webview
+function probeFirstPort(ports) {
+    return new Promise((resolve, reject) => {
+        let pending = ports.length;
+        if (pending === 0) {
+            reject(new Error("no candidate ports"));
+            return;
+        }
+        let settled = false;
+        ports.forEach((port) => {
+            pingPort(port)
+                .then((p) => {
+                    if (!settled) {
+                        settled = true;
+                        resolve(p);
+                    }
+                })
+                .catch(() => {
+                    pending--;
+                    if (pending === 0 && !settled) {
+                        reject(new Error("all ports failed"));
+                    }
+                });
+        });
+    });
+}
+
+// 客户端接口不存在（老版本客户端没有对应路由）时，SDK 统一合成的错误响应
+const CODE_NOT_SUPPORTED = -404;
+const MSG_NOT_SUPPORTED = "当前客户端不支持该接口，请升级新手盒子客户端";
+
 export class NewBeeClient {
     app_id = "";
 
@@ -20,48 +123,72 @@ export class NewBeeClient {
         }
     }
 
-    async Init(app_id) {
-        if (!app_id || typeof app_id !== "string") {
-            throw new Error("APPID格式不正确 请前往后台获取");
-        }
+    // 统一请求客户端：POST JSON 到 path，自动带上 app_id，返回客户端标准响应 {code, data, message}
+    // - 接口不存在（老版本客户端返回 404）：返回统一的错误响应 {code: -404, message: MSG_NOT_SUPPORTED}
+    // - 网络错误 / 超时 / 响应非 JSON：返回 null
+    // 调用方只需判断 code === 1
+    async _post(path, data, timeout) {
+        this._ensureInitialized();
 
-        this.app_id = app_id;
+        const controller = new AbortController();
+        const timeoutId = timeout ? setTimeout(() => controller.abort("请求超时"), timeout) : null;
 
-        for (const port of LOCAL_PORT_LIST) {
-            // 创建 AbortController 实例
-            const controller = new AbortController();
+        try {
+            const response = await fetch(CLIENT_SERVICE_BASE_URL + ":" + this.newbee_client_port + path, {
+                method: "POST",
+                signal: controller.signal,
+                headers: {
+                    "Content-Type": 'application/json',
+                },
+                body: JSON.stringify({
+                    app_id: this.app_id,
+                    ...data
+                })
+            });
 
-            const signal = controller.signal;
+            if (response.status === 404) {
+                console.log("客户端不支持该接口:", path);
+                return { code: CODE_NOT_SUPPORTED, data: null, message: MSG_NOT_SUPPORTED };
+            }
 
-            let check_response;
+            const result = await response.json();
+            console.log(path, "响应:", result);
+            return result;
+        } catch (e) {
+            console.log(path, "请求错误:", e);
+            return null;
+        } finally {
+            if (timeoutId) clearTimeout(timeoutId);
+        }
+    }
 
-            const timeoutId = setTimeout(() => {
-                controller.abort(); // 超时后取消请求
-                console.log("端口:", port, '请求超时');
-            }, CLIENT_CHECK_TIMEOUT);
+    async Init(app_id) {
+        console.log(`[NewBeeBox SDK] version ${SDK_VERSION}`);
 
-            try {
-                let response = await fetch( CLIENT_SERVICE_BASE_URL + (port ? ":" + port : "") + "/ping", {
-                    method: "GET",
-                    signal: signal
-                });
+        if (!app_id || typeof app_id !== "string") {
+            throw new Error("APPID格式不正确 请前往后台获取");
+        }
 
-                check_response = await response.json();
+        this.app_id = app_id;
 
-                clearTimeout(timeoutId);
+        // 1) 先试缓存端口：命中直接用，重连最快且不打扰其他端口
+        const cachedPort = readPortCache();
+        if (cachedPort) {
+            try {
+                this.newbee_client_port = await pingPort(cachedPort);
+                console.log("客户端开启的端口号(缓存命中):", this.newbee_client_port);
+                return;
             } catch (e) {
-                console.error(port, "端口检查失败:", e);
-            }
-
-            console.log("端口检查:", check_response);
-
-            if (check_response && check_response.code === 1) {
-                this.newbee_client_port = port;
-                break;
+                clearPortCache(); // 缓存失效，继续全量探测
             }
         }
 
-        if (!this.newbee_client_port) {
+        // 2) 并行探测全部候选端口，取第一个成功的（老端口段 + 分散端口）
+        try {
+            this.newbee_client_port = await probeFirstPort(LOCAL_PORT_LIST);
+            writePortCache(this.newbee_client_port);
+        } catch (e) {
+            clearPortCache();
             throw new Error("未检测到新手盒子客户端 初始化失败");
         }
 
@@ -70,44 +197,10 @@ export class NewBeeClient {
 
     // 打开应用订阅界面
     async ShowSubscriptionPage() {
-        this._ensureInitialized();
-
-        // 创建 AbortController 实例
-        const controller = new AbortController();
-
-        const signal = controller.signal;
-
-        const timeoutId = setTimeout(() => {
-            controller.abort("请求超时"); // 超时后取消请求
-            console.log('打开订单页面超时');
-        }, TASK_REQUEST_TIMEOUT);
-
-        let show_page_response;
+        const res = await this._post("/tool/open_subscription_dialog", null, TASK_REQUEST_TIMEOUT);
 
-        try {
-            // 测试成功就请求客户端授权
-            let response = await fetch(CLIENT_SERVICE_BASE_URL + ":" + this.newbee_client_port + "/tool/open_subscription_dialog", {
-                method: "POST",
-                signal: signal,
-                headers: {
-                    "Content-Type": 'application/json',
-                },
-                body: JSON.stringify({
-                    app_id: this.app_id
-                })
-            });
-
-            clearTimeout(timeoutId);
-
-            show_page_response = await response.json();
-
-            console.log("开启页面结果:", show_page_response);
-        } catch (e) {
-            console.log("打开订单页面超时", e);
-        }
-
-        if (!show_page_response || show_page_response?.code !== 1) {
-            throw new Error("打开订单页面发生错误:" + (show_page_response?.message || "未知错误"));
+        if (!res || res.code !== 1) {
+            throw new Error("打开订单页面发生错误:" + (res?.message || "未知错误"));
         }
 
         return true;
@@ -115,99 +208,49 @@ export class NewBeeClient {
 
     // 获取当前使用的用户的订阅信息
     async GetUserSubscription() {
-        this._ensureInitialized();
+        const res = await this._post("/tool/subscription_status");
 
-        let user_subscribe_response  = null;
-        try {
-            // 测试成功就请求客户端授权
-            let response = await fetch(CLIENT_SERVICE_BASE_URL + ":" + this.newbee_client_port + "/tool/subscription_status", {
-                method: "POST",
-                headers: {
-                    "Content-Type": 'application/json',
-                },
-                body: JSON.stringify({
-                    app_id: this.app_id
-                })
-            });
+        if (!res || res.code !== 1 || !res.data) {
+            throw new Error("获取用户订阅信息发生错误:" + (res?.message || "未知错误"));
+        }
 
-            user_subscribe_response = await response.json();
+        return res.data;
+    }
 
-            console.log("用户订阅信息响应:", user_subscribe_response);
-        } catch (e) {
-            console.log("获取用户订阅错误:", e);
-        }
+    // 获取当前登录用户的基础信息（未登录时抛错）
+    async GetUserInfo() {
+        const res = await this._post("/user/info");
 
-        if (!user_subscribe_response || user_subscribe_response?.code !== 1 || !user_subscribe_response?.data) {
-            throw new Error("获取用户订阅信息发生错误:" + (user_subscribe_response?.message || "未知错误"));
+        if (!res || res.code !== 1 || !res.data) {
+            throw new Error("获取用户信息发生错误:" + (res?.message || "未知错误"));
         }
 
-        return user_subscribe_response.data
+        return res.data;
     }
 
     // 安装魔兽世界插件
     async InstallWoWAddon(game_version_id, addon_id, secret_key) {
-        this._ensureInitialized();
-
-        let install_response = null;
-        try {
-            const body = {
-                app_id: this.app_id,
-                game_version_id: game_version_id,
-                addon_id: addon_id
-            };
-            if (secret_key) {
-                body.secret_key = secret_key;
-            }
-            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(body)
-            });
-
-            install_response = await response.json();
-
-            console.log("安装插件响应:", install_response);
-        } catch (e) {
-            console.log("安装插件错误:", e);
+        const body = { game_version_id, addon_id };
+        if (secret_key) {
+            body.secret_key = secret_key;
         }
+        const res = await this._post("/tool/wow_install_addon", body);
 
-        if (!install_response || install_response?.code !== 1) {
-            throw new Error("安装魔兽世界插件发生错误:" + (install_response?.message || "未知错误"));
+        if (!res || res.code !== 1) {
+            throw new Error("安装魔兽世界插件发生错误:" + (res?.message || "未知错误"));
         }
 
-        return install_response.data;
+        return res.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);
-        }
+        const res = await this._post(tool_name, data);
 
-        if (!patch_response || patch_response?.code !== 1) {
-            throw new Error("Patch请求发生错误:" + (patch_response?.message || "未知错误"));
+        if (!res || res.code !== 1) {
+            throw new Error("Patch请求发生错误:" + (res?.message || "未知错误"));
         }
 
-        return patch_response.data;
+        return res.data;
     }
-}
+}

package/package.json

@@ -1,29 +1,29 @@
-{
-  "name": "@newbeebox/newbeebox-client-web-sdk",
-  "version": "1.0.11",
-  "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.14",
+  "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

@@ -34,6 +34,14 @@ export class NewBeeClient {
      */
     GetUserSubscription(): Promise<UserSubscribeInfo>;
 
+    /**
+     * 获取当前登录用户信息
+     * @constructor GetUserInfo
+     * @return {Promise<UserAccountInfo>}
+     * @throws 未登录、客户端版本过低时抛出错误
+     */
+    GetUserInfo(): Promise<UserAccountInfo>;
+
     /**
      * 安装魔兽世界插件
      * @param game_version_id 游戏版本ID
@@ -82,6 +90,36 @@ export interface UserInfo {
     avatar:string;
 }
 
+/**
+ * @interface UserVipInfo
+ * @description 用户 VIP 信息
+ * @property {boolean} isYearly - 是否年费会员
+ * @property {boolean} adFree - 是否免广告
+ * @property {number | null} endTime - 会员到期时间戳
+ */
+export interface UserVipInfo {
+    isYearly: boolean;
+    adFree: boolean;
+    endTime: number | null;
+}
+
+/**
+ * @interface UserAccountInfo
+ * @description 当前登录用户信息（GetUserInfo 返回）
+ * @property {number | null} id - 用户ID
+ * @property {string} username - 用户名
+ * @property {string} avatar - 用户头像
+ * @property {boolean} isVip - 是否是 VIP
+ * @property {UserVipInfo | null} vip - VIP 信息，非 VIP 时为 null
+ */
+export interface UserAccountInfo {
+    id: number | null;
+    username: string;
+    avatar: string;
+    isVip: boolean;
+    vip: UserVipInfo | null;
+}
+
 /**
  * @interface UserSubscribeInfo
  * @description 用户订阅信息