@newbeebox/newbeebox-client-web-sdk 1.0.2 → 1.0.4

package/README.md

@@ -19,7 +19,27 @@ npm install @newbeebox/newbeebox-client-web-sdk
     await client.Init("newbee_appid");
     
     // 2.功能调用
-    // 示例: 打开应用订阅界面
-    await client.ShowSubscriptionPage()
-
+    // 示例一: 打开应用订阅界面
+    await client.ShowSubscriptionPage();
+    
+    // 示例二: 获取当前用户订阅信息
+    let user_subscribe_info = await client.GetSubscriptionInfo();
+    console.log(user_subscribe_info);
+    // 输出:
+    {
+        "app_id": "nb00002",
+        "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..."
+    }
 ```

package/index.js

@@ -2,9 +2,11 @@
 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];
-export  class NewBeeClient {
+// 服务端地址
+const CLIENT_SERVICE_BASE_URL = "http://127.0.0.1";
+export default class NewBeeClient {
     app_id = "";
 
     newbee_client_port = 0;
@@ -33,7 +35,7 @@ export  class NewBeeClient {
             }, CLIENT_CHECK_TIMEOUT);
 
             try {
-                let response = await fetch("http://127.0.0.1" + (port ? ":" + port : "") + "/ping", {
+                let response = await fetch( CLIENT_SERVICE_BASE_URL + (port ? ":" + port : "") + "/ping", {
                     method: "GET",
                     signal: signal
                 });
@@ -56,6 +58,7 @@ export  class NewBeeClient {
         console.log("客户端开启的端口号:", this.newbee_client_port);
     }
 
+    // 打开应用订阅界面
     async ShowSubscriptionPage() {
         if (!this.newbee_client_port) {
             throw new Error("SDK未初始化或者未检测到新手盒子客户端");
@@ -76,7 +79,7 @@ export  class NewBeeClient {
 
         try {
             // 测试成功就请求客户端授权
-            let response = await fetch("http://127.0.0.1:" + this.newbee_client_port + "/tool/open_subscription_dialog", {
+            let response = await fetch(CLIENT_SERVICE_BASE_URL + ":" + this.newbee_client_port + "/tool/open_subscription_dialog", {
                 method: "POST",
                 signal: signal,
                 headers: {
@@ -102,4 +105,37 @@ export  class NewBeeClient {
 
         return true;
     }
+
+    // 获取当前使用的用户的订阅信息
+    async GetUserSubscription() {
+        if (!this.newbee_client_port) {
+            throw new Error("SDK未初始化或者未检测到新手盒子客户端");
+        }
+
+        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
+                })
+            });
+
+            user_subscribe_response = await response.json();
+
+            console.log("用户订阅信息响应:", user_subscribe_response);
+        } catch (e) {
+            console.log("获取用户订阅错误:", e);
+        }
+
+        if (!user_subscribe_response || user_subscribe_response?.code !== 1 || !user_subscribe_response?.data) {
+            throw new Error("获取用户订阅信息发生错误:" + (user_subscribe_response?.message || "未知错误"));
+        }
+
+        return user_subscribe_response.data
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newbeebox/newbeebox-client-web-sdk",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "NewBeeBox Client SDK for Web",
   "main": "index.js",
   "type": "module",

package/types/index.d.ts

@@ -1,5 +1,93 @@
+/**
+ * NewBeeClient
+ * @class NewBeeClient
+ * @description 新手盒子客户端SDK(Web端)
+ * @author NewBeeTeam
+ * @date 2025年9月23日14:42:24
+ * @version 1.0.0
+ */
 export default class NewBeeClient {
+    /**
+     * 构造函数
+     */
     constructor();
-    Init (app_id:string): Promise<void>;
-    ShowSubscriptionPage (): Promise<boolean>;
+
+    /**
+     * 初始化
+     * @param app_id
+     * @constructor  Init
+     * @return {Promise<void>}
+     */
+    Init(app_id: string): Promise<void>;
+
+    /**
+     * 打开订阅页面
+     * @constructor ShowSubscriptionPage
+     * @return {Promise<boolean>}
+     */
+    ShowSubscriptionPage(): Promise<boolean>;
+
+    /**
+     * 获取用户订阅信息
+     * @constructor GetUserSubscription
+     * @return {Promise<UserSubscribeInfo>}
+     */
+    GetUserSubscription(): Promise<UserSubscribeInfo>;
+}
+
+/**
+ * @enum SUBSCRIBE_MODE
+ * @description 订阅模式
+ * @property {number} 1 作者订阅
+ * @property {number} 2 应用订阅
+ */
+export enum SUBSCRIBE_MODE {
+    /**
+     * 作者订阅
+     */
+    AUTHOR_SUBSCRIBE = 1,
+    /**
+     * 应用订阅
+     */
+    APP_SUBSCRIBE = 2
+}
+
+/**
+ * @interface UserInfo
+ * @description 用户信息
+ * @property {string} open_id - 用户平台ID
+ * @property {string} nickname - 用户昵称
+ * @property {string} avatar - 用户头像
+ */
+export interface UserInfo {
+    open_id:string;
+    nickname:string;
+    avatar:string;
+}
+
+/**
+ * @interface UserSubscribeInfo
+ * @description 用户订阅信息
+ * @property {string} app_id - 应用ID
+ * @property {UserInfo} user - 用户信息
+ * @property {SUBSCRIBE_MODE} subscribe_mode - 订阅模式
+ * @property {number} end_time - 订阅到期时间
+ * @property {number} level - 订阅等级
+ * @property {string} level_label - 订阅等级标签
+ * @property {boolean} is_yearly - 是否是年订阅
+ * @property {number} timestamp - 时间戳
+ * @property {string} nonce - 随机数
+ * @property {string} [sign] - 签名
+ */
+export interface UserSubscribeInfo {
+    app_id: string;
+    user: UserInfo;
+    subscribe_mode: SUBSCRIBE_MODE;
+    end_time: number;
+    level: number;
+    level_label: string;
+    is_yearly: boolean;
+    timestamp: number;
+    nonce: string;
+    sign?: string;
 }