@heybox/hb-sdk 0.7.3 → 0.7.4-alpha.1

package/dist/index.cjs.js

@@ -93,7 +93,7 @@ function describeHostNetworkFailure(response) {
  *
  * @remarks
  * 放在 `core` 而非 `modules/network`：无错误类型依赖，供 SDK 错误文案、
- * modules observability、devtools Mock Host / proxy 共用，并满足 boundary
+ * modules observability、devtools Browser Dev Host / proxy 共用，并满足 boundary
  *（devtools 不得直接 import runtime capability modules）。
  */
 const DATA_PREVIEW_MAX_CHARS = 500;
@@ -564,21 +564,52 @@ function restoreMethod(history, name, patchedValue, original) {
     }
 }
 
-/** 小程序沙盒通信命名空间，父容器与 iframe 内 SDK 必须保持一致。 */
+const AUTH_LOGIN_METHOD = 'auth.login';
+const USER_GET_INFO_METHOD = 'user.getInfo';
+const USER_REVOKE_AUTHORIZATION_METHOD = 'user.revokeAuthorization';
+const USER_GET_STEAM_GAME_LIST_METHOD = 'user.getSteamGameList';
+const SHARE_SHOW_SHARE_MENU_METHOD = 'share.showShareMenu';
+const SHARE_SCREENSHOT_METHOD = 'share.screenshot';
+const VIEWPORT_GET_WINDOW_INFO_METHOD = 'viewport.getWindowInfo';
+const VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD = 'viewport.setNavigationBarStyle';
+const STORAGE_GET_STORAGE_METHOD = 'storage.getStorage';
+const STORAGE_SET_STORAGE_METHOD = 'storage.setStorage';
+const NETWORK_REQUEST_METHOD = 'network.request';
+const UI_SHOW_TOAST_METHOD = 'ui.showToast';
+const UI_SHOW_LOADING_METHOD = 'ui.showLoading';
+const UI_HIDE_LOADING_METHOD = 'ui.hideLoading';
+const DEVICE_VIBRATE_METHOD = 'device.vibrate';
+const DEVICE_SET_CLIPBOARD_METHOD = 'device.setClipboard';
+const NAVIGATION_CLOSE_METHOD = 'navigation.close';
+const NAVIGATION_RELOAD_METHOD = 'navigation.reload';
+const NAVIGATION_OPEN_APP_PAGE_METHOD = 'navigation.openAppPage';
+const CLOUD_LEADERBOARD_SUBMIT_METHOD = 'cloud.leaderboard.submit';
+const CLOUD_LEADERBOARD_GET_LIST_METHOD = 'cloud.leaderboard.getList';
+const CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.getCurrentUserEntry';
+const CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.deleteCurrentUserEntry';
+const CLOUD_LEADERBOARD_GET_INFO_METHOD = 'cloud.leaderboard.getInfo';
+
 const MINI_PROGRAM_MESSAGE_NAMESPACE = 'heybox:miniprogram';
-/** 小程序沙盒通信协议版本。 */
 const MINI_PROGRAM_MESSAGE_VERSION = 2;
-/** 父容器注入到小程序 URL 上的通信 nonce 参数名。 */
 const MINI_PROGRAM_BRIDGE_NONCE_PARAM = 'hb_mini_bridge_nonce';
-/** SDK 初始化时发给父容器的握手方法名。 */
 const SDK_HANDSHAKE_METHOD = 'sdk.handshake';
-/** Runtime 主动探测 SDK 当前文档地址的内部方法名。 */
 const RUNTIME_LOCATION_PROBE_METHOD = 'runtime.location.probe';
-/** SDK 向 Runtime 报告当前文档地址的内部方法名。 */
 const SDK_LOCATION_REPORT_METHOD = 'sdk.location.report';
-/** SDK 向 Runtime 报告 CSP 违规的内部方法名。 */
 const SDK_CSP_VIOLATION_METHOD = 'sdk.csp.violation';
 
+function isMiniProgramBridgeMessage(value) {
+    if (!value || typeof value !== 'object')
+        return false;
+    const message = value;
+    return (message.namespace === MINI_PROGRAM_MESSAGE_NAMESPACE &&
+        (message.version === 1 || message.version === 2) &&
+        typeof message.nonce === 'string' &&
+        typeof message.type === 'string');
+}
+
+/** 当前用户信息与登录能力支持的完整 scope 目录。 */
+const USER_INFO_AUTHORIZATION_SCOPES = ['identity', 'profile'];
+
 /** 获取浏览器全局 window。 */
 function getGlobalWindow() {
     return typeof window === 'undefined' ? undefined : window;
@@ -640,24 +671,7 @@ function createMessageId() {
 /** 构建时替换为当前发布包的实际版本。 */
 const HB_SDK_VERSION = typeof undefined === 'string'
     ? undefined
-    : '0.7.3';
-
-/**
- * 判断未知数据是否符合小程序 bridge 消息信封。
- *
- * @param value 待判断的未知数据。
- * @returns 当数据满足小程序 bridge 消息基础结构时返回 `true`。
- */
-function isMiniProgramBridgeMessage(value) {
-    if (!value || typeof value !== 'object') {
-        return false;
-    }
-    const message = value;
-    return (message.namespace === MINI_PROGRAM_MESSAGE_NAMESPACE &&
-        (message.version === 1 || message.version === 2) &&
-        typeof message.nonce === 'string' &&
-        typeof message.type === 'string');
-}
+    : '0.7.4-alpha.1';
 
 const DEFAULT_TIMEOUT = 10000;
 const HANDSHAKE_RETRY_INTERVAL = 250;
@@ -1010,95 +1024,6 @@ class MiniProgramBridgeClient {
     }
 }
 
-/**
- * 登录授权能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-const AUTH_LOGIN_METHOD = 'auth.login';
-/** 读取当前登录态、授权状态和已获准披露资料的 bridge method 标识。 */
-const USER_GET_INFO_METHOD = 'user.getInfo';
-/** 撤销当前用户授予本小程序授权的 bridge method 标识。 */
-const USER_REVOKE_AUTHORIZATION_METHOD = 'user.revokeAuthorization';
-/** 读取当前已登录用户 Steam 游戏库的 bridge method 标识。 */
-const USER_GET_STEAM_GAME_LIST_METHOD = 'user.getSteamGameList';
-/**
- * 展示分享面板能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-const SHARE_SHOW_SHARE_MENU_METHOD = 'share.showShareMenu';
-/**
- * 截图分享能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-const SHARE_SCREENSHOT_METHOD = 'share.screenshot';
-/**
- * 视口窗口信息能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-const VIEWPORT_GET_WINDOW_INFO_METHOD = 'viewport.getWindowInfo';
-/**
- * 设置导航栏样式能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-const VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD = 'viewport.setNavigationBarStyle';
-/**
- * 读取小程序隔离 storage 能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-const STORAGE_GET_STORAGE_METHOD = 'storage.getStorage';
-/**
- * 写入小程序隔离 storage 能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-const STORAGE_SET_STORAGE_METHOD = 'storage.setStorage';
-/**
- * 发起网络请求能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-const NETWORK_REQUEST_METHOD = 'network.request';
-/** 展示 toast 能力方法名。 */
-const UI_SHOW_TOAST_METHOD = 'ui.showToast';
-/** 展示全局 loading 能力方法名。 */
-const UI_SHOW_LOADING_METHOD = 'ui.showLoading';
-/** 隐藏全局 loading 能力方法名。 */
-const UI_HIDE_LOADING_METHOD = 'ui.hideLoading';
-/** 震动反馈能力方法名。 */
-const DEVICE_VIBRATE_METHOD = 'device.vibrate';
-/** 写入文本剪贴板能力方法名。 */
-const DEVICE_SET_CLIPBOARD_METHOD = 'device.setClipboard';
-/** 关闭当前小程序容器能力方法名。 */
-const NAVIGATION_CLOSE_METHOD = 'navigation.close';
-/** 重载当前小程序容器能力方法名。 */
-const NAVIGATION_RELOAD_METHOD = 'navigation.reload';
-/** 打开黑盒 App 页面能力方法名。 */
-const NAVIGATION_OPEN_APP_PAGE_METHOD = 'navigation.openAppPage';
-/** 提交当前用户排行榜分数能力方法名。 */
-const CLOUD_LEADERBOARD_SUBMIT_METHOD = 'cloud.leaderboard.submit';
-/** 读取排行榜列表能力方法名。 */
-const CLOUD_LEADERBOARD_GET_LIST_METHOD = 'cloud.leaderboard.getList';
-/** 读取当前用户排行榜记录能力方法名。 */
-const CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.getCurrentUserEntry';
-/** 删除当前用户排行榜记录能力方法名。 */
-const CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.deleteCurrentUserEntry';
-/** 读取排行榜基础信息能力方法名。 */
-const CLOUD_LEADERBOARD_GET_INFO_METHOD = 'cloud.leaderboard.getInfo';
-
 /** 获取短期授权码。 */
 function login(requester, options) {
     const payload = options?.scopes === undefined ? undefined : { scopes: options.scopes };
@@ -1473,9 +1398,6 @@ function getSteamGameList(requester, options) {
     return requester.request(USER_GET_STEAM_GAME_LIST_METHOD, options);
 }
 
-/** 当前用户信息能力支持的完整 scope 目录。新增 scope 时必须更新这里。 */
-const USER_INFO_AUTHORIZATION_SCOPES = ['identity', 'profile'];
-
 function createUserModule(requester) {
     return {
         getInfo: () => getInfo(requester),

package/dist/index.esm.js

@@ -89,7 +89,7 @@ function describeHostNetworkFailure(response) {
  *
  * @remarks
  * 放在 `core` 而非 `modules/network`：无错误类型依赖，供 SDK 错误文案、
- * modules observability、devtools Mock Host / proxy 共用，并满足 boundary
+ * modules observability、devtools Browser Dev Host / proxy 共用，并满足 boundary
  *（devtools 不得直接 import runtime capability modules）。
  */
 const DATA_PREVIEW_MAX_CHARS = 500;
@@ -560,21 +560,52 @@ function restoreMethod(history, name, patchedValue, original) {
     }
 }
 
-/** 小程序沙盒通信命名空间，父容器与 iframe 内 SDK 必须保持一致。 */
+const AUTH_LOGIN_METHOD = 'auth.login';
+const USER_GET_INFO_METHOD = 'user.getInfo';
+const USER_REVOKE_AUTHORIZATION_METHOD = 'user.revokeAuthorization';
+const USER_GET_STEAM_GAME_LIST_METHOD = 'user.getSteamGameList';
+const SHARE_SHOW_SHARE_MENU_METHOD = 'share.showShareMenu';
+const SHARE_SCREENSHOT_METHOD = 'share.screenshot';
+const VIEWPORT_GET_WINDOW_INFO_METHOD = 'viewport.getWindowInfo';
+const VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD = 'viewport.setNavigationBarStyle';
+const STORAGE_GET_STORAGE_METHOD = 'storage.getStorage';
+const STORAGE_SET_STORAGE_METHOD = 'storage.setStorage';
+const NETWORK_REQUEST_METHOD = 'network.request';
+const UI_SHOW_TOAST_METHOD = 'ui.showToast';
+const UI_SHOW_LOADING_METHOD = 'ui.showLoading';
+const UI_HIDE_LOADING_METHOD = 'ui.hideLoading';
+const DEVICE_VIBRATE_METHOD = 'device.vibrate';
+const DEVICE_SET_CLIPBOARD_METHOD = 'device.setClipboard';
+const NAVIGATION_CLOSE_METHOD = 'navigation.close';
+const NAVIGATION_RELOAD_METHOD = 'navigation.reload';
+const NAVIGATION_OPEN_APP_PAGE_METHOD = 'navigation.openAppPage';
+const CLOUD_LEADERBOARD_SUBMIT_METHOD = 'cloud.leaderboard.submit';
+const CLOUD_LEADERBOARD_GET_LIST_METHOD = 'cloud.leaderboard.getList';
+const CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.getCurrentUserEntry';
+const CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.deleteCurrentUserEntry';
+const CLOUD_LEADERBOARD_GET_INFO_METHOD = 'cloud.leaderboard.getInfo';
+
 const MINI_PROGRAM_MESSAGE_NAMESPACE = 'heybox:miniprogram';
-/** 小程序沙盒通信协议版本。 */
 const MINI_PROGRAM_MESSAGE_VERSION = 2;
-/** 父容器注入到小程序 URL 上的通信 nonce 参数名。 */
 const MINI_PROGRAM_BRIDGE_NONCE_PARAM = 'hb_mini_bridge_nonce';
-/** SDK 初始化时发给父容器的握手方法名。 */
 const SDK_HANDSHAKE_METHOD = 'sdk.handshake';
-/** Runtime 主动探测 SDK 当前文档地址的内部方法名。 */
 const RUNTIME_LOCATION_PROBE_METHOD = 'runtime.location.probe';
-/** SDK 向 Runtime 报告当前文档地址的内部方法名。 */
 const SDK_LOCATION_REPORT_METHOD = 'sdk.location.report';
-/** SDK 向 Runtime 报告 CSP 违规的内部方法名。 */
 const SDK_CSP_VIOLATION_METHOD = 'sdk.csp.violation';
 
+function isMiniProgramBridgeMessage(value) {
+    if (!value || typeof value !== 'object')
+        return false;
+    const message = value;
+    return (message.namespace === MINI_PROGRAM_MESSAGE_NAMESPACE &&
+        (message.version === 1 || message.version === 2) &&
+        typeof message.nonce === 'string' &&
+        typeof message.type === 'string');
+}
+
+/** 当前用户信息与登录能力支持的完整 scope 目录。 */
+const USER_INFO_AUTHORIZATION_SCOPES = ['identity', 'profile'];
+
 /** 获取浏览器全局 window。 */
 function getGlobalWindow() {
     return typeof window === 'undefined' ? undefined : window;
@@ -636,24 +667,7 @@ function createMessageId() {
 /** 构建时替换为当前发布包的实际版本。 */
 const HB_SDK_VERSION = typeof undefined === 'string'
     ? undefined
-    : '0.7.3';
-
-/**
- * 判断未知数据是否符合小程序 bridge 消息信封。
- *
- * @param value 待判断的未知数据。
- * @returns 当数据满足小程序 bridge 消息基础结构时返回 `true`。
- */
-function isMiniProgramBridgeMessage(value) {
-    if (!value || typeof value !== 'object') {
-        return false;
-    }
-    const message = value;
-    return (message.namespace === MINI_PROGRAM_MESSAGE_NAMESPACE &&
-        (message.version === 1 || message.version === 2) &&
-        typeof message.nonce === 'string' &&
-        typeof message.type === 'string');
-}
+    : '0.7.4-alpha.1';
 
 const DEFAULT_TIMEOUT = 10000;
 const HANDSHAKE_RETRY_INTERVAL = 250;
@@ -1006,95 +1020,6 @@ class MiniProgramBridgeClient {
     }
 }
 
-/**
- * 登录授权能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-const AUTH_LOGIN_METHOD = 'auth.login';
-/** 读取当前登录态、授权状态和已获准披露资料的 bridge method 标识。 */
-const USER_GET_INFO_METHOD = 'user.getInfo';
-/** 撤销当前用户授予本小程序授权的 bridge method 标识。 */
-const USER_REVOKE_AUTHORIZATION_METHOD = 'user.revokeAuthorization';
-/** 读取当前已登录用户 Steam 游戏库的 bridge method 标识。 */
-const USER_GET_STEAM_GAME_LIST_METHOD = 'user.getSteamGameList';
-/**
- * 展示分享面板能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-const SHARE_SHOW_SHARE_MENU_METHOD = 'share.showShareMenu';
-/**
- * 截图分享能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-const SHARE_SCREENSHOT_METHOD = 'share.screenshot';
-/**
- * 视口窗口信息能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-const VIEWPORT_GET_WINDOW_INFO_METHOD = 'viewport.getWindowInfo';
-/**
- * 设置导航栏样式能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-const VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD = 'viewport.setNavigationBarStyle';
-/**
- * 读取小程序隔离 storage 能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-const STORAGE_GET_STORAGE_METHOD = 'storage.getStorage';
-/**
- * 写入小程序隔离 storage 能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-const STORAGE_SET_STORAGE_METHOD = 'storage.setStorage';
-/**
- * 发起网络请求能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-const NETWORK_REQUEST_METHOD = 'network.request';
-/** 展示 toast 能力方法名。 */
-const UI_SHOW_TOAST_METHOD = 'ui.showToast';
-/** 展示全局 loading 能力方法名。 */
-const UI_SHOW_LOADING_METHOD = 'ui.showLoading';
-/** 隐藏全局 loading 能力方法名。 */
-const UI_HIDE_LOADING_METHOD = 'ui.hideLoading';
-/** 震动反馈能力方法名。 */
-const DEVICE_VIBRATE_METHOD = 'device.vibrate';
-/** 写入文本剪贴板能力方法名。 */
-const DEVICE_SET_CLIPBOARD_METHOD = 'device.setClipboard';
-/** 关闭当前小程序容器能力方法名。 */
-const NAVIGATION_CLOSE_METHOD = 'navigation.close';
-/** 重载当前小程序容器能力方法名。 */
-const NAVIGATION_RELOAD_METHOD = 'navigation.reload';
-/** 打开黑盒 App 页面能力方法名。 */
-const NAVIGATION_OPEN_APP_PAGE_METHOD = 'navigation.openAppPage';
-/** 提交当前用户排行榜分数能力方法名。 */
-const CLOUD_LEADERBOARD_SUBMIT_METHOD = 'cloud.leaderboard.submit';
-/** 读取排行榜列表能力方法名。 */
-const CLOUD_LEADERBOARD_GET_LIST_METHOD = 'cloud.leaderboard.getList';
-/** 读取当前用户排行榜记录能力方法名。 */
-const CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.getCurrentUserEntry';
-/** 删除当前用户排行榜记录能力方法名。 */
-const CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.deleteCurrentUserEntry';
-/** 读取排行榜基础信息能力方法名。 */
-const CLOUD_LEADERBOARD_GET_INFO_METHOD = 'cloud.leaderboard.getInfo';
-
 /** 获取短期授权码。 */
 function login(requester, options) {
     const payload = options?.scopes === undefined ? undefined : { scopes: options.scopes };
@@ -1469,9 +1394,6 @@ function getSteamGameList(requester, options) {
     return requester.request(USER_GET_STEAM_GAME_LIST_METHOD, options);
 }
 
-/** 当前用户信息能力支持的完整 scope 目录。新增 scope 时必须更新这里。 */
-const USER_INFO_AUTHORIZATION_SCOPES = ['identity', 'profile'];
-
 function createUserModule(requester) {
     return {
         getInfo: () => getInfo(requester),