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

package/types/protocol/capabilities.d.ts

@@ -1,352 +1,2 @@
-import type { LoginPayload, LoginResult } from '../modules/auth';
-import type { DeleteCurrentUserLeaderboardEntryPayload, DeleteCurrentUserLeaderboardEntryResult, GetCurrentUserLeaderboardEntryPayload, GetCurrentUserLeaderboardEntryResult, GetLeaderboardInfoPayload, GetLeaderboardInfoResult, GetLeaderboardListPayload, GetLeaderboardListResult, SubmitLeaderboardEntryPayload, SubmitLeaderboardEntryResult } from '../modules/cloud';
-import type { SetClipboardPayload, SetClipboardResult, VibratePayload, VibrateResult } from '../modules/device';
-import type { ClosePayload, CloseResult, OpenAppPagePayload, OpenAppPageResult, ReloadPayload, ReloadResult } from '../modules/navigation';
-import type { NetworkRequestPayload, NetworkResponsePayload } from '../modules/network';
-import type { ScreenshotPayload, ScreenshotResult, ShowShareMenuPayload, ShowShareMenuResult } from '../modules/share';
-import type { GetStoragePayload, GetStorageResult, SetStoragePayload } from '../modules/storage';
-import type { HideLoadingPayload, HideLoadingResult, ShowLoadingPayload, ShowLoadingResult, ShowToastPayload, ShowToastResult } from '../modules/ui';
-import type { GetUserInfoPayload, GetUserInfoResult, RevokeAuthorizationPayload, RevokeAuthorizationResult, GetSteamGameListPayload, GetSteamGameListResult } from '../modules/user';
-import type { GetWindowInfoPayload, GetWindowInfoResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult } from '../modules/viewport';
-/**
- * 登录授权能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-export declare const AUTH_LOGIN_METHOD: "auth.login";
-/** 读取当前登录态、授权状态和已获准披露资料的 bridge method 标识。 */
-export declare const USER_GET_INFO_METHOD: "user.getInfo";
-/** 撤销当前用户授予本小程序授权的 bridge method 标识。 */
-export declare const USER_REVOKE_AUTHORIZATION_METHOD: "user.revokeAuthorization";
-/** 读取当前已登录用户 Steam 游戏库的 bridge method 标识。 */
-export declare const USER_GET_STEAM_GAME_LIST_METHOD: "user.getSteamGameList";
-/**
- * 展示分享面板能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-export declare const SHARE_SHOW_SHARE_MENU_METHOD: "share.showShareMenu";
-/**
- * 截图分享能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-export declare const SHARE_SCREENSHOT_METHOD: "share.screenshot";
-/**
- * 视口窗口信息能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-export declare const VIEWPORT_GET_WINDOW_INFO_METHOD: "viewport.getWindowInfo";
-/**
- * 设置导航栏样式能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-export declare const VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD: "viewport.setNavigationBarStyle";
-/**
- * 读取小程序隔离 storage 能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-export declare const STORAGE_GET_STORAGE_METHOD: "storage.getStorage";
-/**
- * 写入小程序隔离 storage 能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-export declare const STORAGE_SET_STORAGE_METHOD: "storage.setStorage";
-/**
- * 发起网络请求能力方法名。
- *
- * @remarks
- * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
- */
-export declare const NETWORK_REQUEST_METHOD: "network.request";
-/** 展示 toast 能力方法名。 */
-export declare const UI_SHOW_TOAST_METHOD: "ui.showToast";
-/** 展示全局 loading 能力方法名。 */
-export declare const UI_SHOW_LOADING_METHOD: "ui.showLoading";
-/** 隐藏全局 loading 能力方法名。 */
-export declare const UI_HIDE_LOADING_METHOD: "ui.hideLoading";
-/** 震动反馈能力方法名。 */
-export declare const DEVICE_VIBRATE_METHOD: "device.vibrate";
-/** 写入文本剪贴板能力方法名。 */
-export declare const DEVICE_SET_CLIPBOARD_METHOD: "device.setClipboard";
-/** 关闭当前小程序容器能力方法名。 */
-export declare const NAVIGATION_CLOSE_METHOD: "navigation.close";
-/** 重载当前小程序容器能力方法名。 */
-export declare const NAVIGATION_RELOAD_METHOD: "navigation.reload";
-/** 打开黑盒 App 页面能力方法名。 */
-export declare const NAVIGATION_OPEN_APP_PAGE_METHOD: "navigation.openAppPage";
-/** 提交当前用户排行榜分数能力方法名。 */
-export declare const CLOUD_LEADERBOARD_SUBMIT_METHOD: "cloud.leaderboard.submit";
-/** 读取排行榜列表能力方法名。 */
-export declare const CLOUD_LEADERBOARD_GET_LIST_METHOD: "cloud.leaderboard.getList";
-/** 读取当前用户排行榜记录能力方法名。 */
-export declare const CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD: "cloud.leaderboard.getCurrentUserEntry";
-/** 删除当前用户排行榜记录能力方法名。 */
-export declare const CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD: "cloud.leaderboard.deleteCurrentUserEntry";
-/** 读取排行榜基础信息能力方法名。 */
-export declare const CLOUD_LEADERBOARD_GET_INFO_METHOD: "cloud.leaderboard.getInfo";
-/** 授权模块开放的方法名。 */
-export type MiniProgramAuthMethod = typeof AUTH_LOGIN_METHOD;
-/** 用户模块开放的方法名。 */
-export type MiniProgramUserMethod = typeof USER_GET_INFO_METHOD | typeof USER_REVOKE_AUTHORIZATION_METHOD | typeof USER_GET_STEAM_GAME_LIST_METHOD;
-/** 分享模块开放的方法名。 */
-export type MiniProgramShareMethod = typeof SHARE_SHOW_SHARE_MENU_METHOD | typeof SHARE_SCREENSHOT_METHOD;
-/** Viewport 模块开放的方法名。 */
-export type MiniProgramViewportMethod = typeof VIEWPORT_GET_WINDOW_INFO_METHOD | typeof VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD;
-/** Storage 模块开放的方法名。 */
-export type MiniProgramStorageMethod = typeof STORAGE_GET_STORAGE_METHOD | typeof STORAGE_SET_STORAGE_METHOD;
-/** 网络模块开放的方法名。 */
-export type MiniProgramNetworkMethod = typeof NETWORK_REQUEST_METHOD;
-/** UI 模块开放的方法名。 */
-export type MiniProgramUiMethod = typeof UI_SHOW_TOAST_METHOD | typeof UI_SHOW_LOADING_METHOD | typeof UI_HIDE_LOADING_METHOD;
-/** Device 模块开放的方法名。 */
-export type MiniProgramDeviceMethod = typeof DEVICE_VIBRATE_METHOD | typeof DEVICE_SET_CLIPBOARD_METHOD;
-/** Navigation 模块开放的方法名。 */
-export type MiniProgramNavigationMethod = typeof NAVIGATION_CLOSE_METHOD | typeof NAVIGATION_RELOAD_METHOD | typeof NAVIGATION_OPEN_APP_PAGE_METHOD;
-/** Cloud 模块开放的方法名。 */
-export type MiniProgramCloudMethod = typeof CLOUD_LEADERBOARD_SUBMIT_METHOD | typeof CLOUD_LEADERBOARD_GET_LIST_METHOD | typeof CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD | typeof CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD | typeof CLOUD_LEADERBOARD_GET_INFO_METHOD;
-/** 父容器开放给小程序调用的 bridge method。 */
-export type MiniProgramBridgeMethod = MiniProgramAuthMethod | MiniProgramUserMethod | MiniProgramShareMethod | MiniProgramViewportMethod | MiniProgramStorageMethod | MiniProgramNetworkMethod | MiniProgramUiMethod | MiniProgramDeviceMethod | MiniProgramNavigationMethod | MiniProgramCloudMethod;
-/** 小程序开放能力所属模块。 */
-export type MiniProgramCapabilityModule = 'auth' | 'user' | 'share' | 'viewport' | 'storage' | 'network' | 'ui' | 'device' | 'navigation' | 'cloud';
-/** 小程序开放能力风险级别，用于权限、审计和灰度策略。 */
-export type MiniProgramCapabilityRisk = 'low' | 'medium' | 'high';
-/**
- * 小程序开放能力定义。
- *
- * @remarks
- * 这是 SDK 与 runtime 共享的能力目录元数据。runtime 可以在此基础上绑定 handler，
- * 但 method、module、capability、permission 与 risk 不应在 runtime 侧重复维护。
- */
-export interface MiniProgramCapabilityDefinition {
-    /** iframe SDK 调用父容器 runtime 时使用的 bridge method。 */
-    method: MiniProgramBridgeMethod;
-    /** 该能力所属的 SDK 模块。 */
-    module: MiniProgramCapabilityModule;
-    /** runtime 实例控制该能力是否开放时使用的开关键。 */
-    capability: MiniProgramBridgeMethod;
-    /** 小程序平台权限快照中校验该能力时使用的权限键。 */
-    permission: string;
-    /** 供策略组合、审计和灰度使用的风险提示。 */
-    risk: MiniProgramCapabilityRisk;
-}
-/**
- * 小程序开放能力目录。
- *
- * @remarks
- * 新增 bridge method 时应先更新这里，再分别补齐 SDK 模块、runtime handler 与测试。
- */
-export declare const MINI_PROGRAM_PROTOCOL_CAPABILITIES: readonly [{
-    readonly method: "auth.login";
-    readonly module: "auth";
-    readonly capability: "auth.login";
-    readonly permission: "auth.login";
-    readonly risk: "medium";
-}, {
-    readonly method: "user.getInfo";
-    readonly module: "user";
-    readonly capability: "user.getInfo";
-    readonly permission: "user.getInfo";
-    readonly risk: "medium";
-}, {
-    readonly method: "user.revokeAuthorization";
-    readonly module: "user";
-    readonly capability: "user.revokeAuthorization";
-    readonly permission: "user.revokeAuthorization";
-    readonly risk: "high";
-}, {
-    readonly method: "user.getSteamGameList";
-    readonly module: "user";
-    readonly capability: "user.getSteamGameList";
-    readonly permission: "user.platformAccount.steam";
-    readonly risk: "high";
-}, {
-    readonly method: "share.showShareMenu";
-    readonly module: "share";
-    readonly capability: "share.showShareMenu";
-    readonly permission: "share.basic";
-    readonly risk: "low";
-}, {
-    readonly method: "share.screenshot";
-    readonly module: "share";
-    readonly capability: "share.screenshot";
-    readonly permission: "share.screenshot";
-    readonly risk: "medium";
-}, {
-    readonly method: "viewport.getWindowInfo";
-    readonly module: "viewport";
-    readonly capability: "viewport.getWindowInfo";
-    readonly permission: "viewport.windowInfo";
-    readonly risk: "low";
-}, {
-    readonly method: "viewport.setNavigationBarStyle";
-    readonly module: "viewport";
-    readonly capability: "viewport.setNavigationBarStyle";
-    readonly permission: "viewport.navigationBarStyle";
-    readonly risk: "low";
-}, {
-    readonly method: "storage.getStorage";
-    readonly module: "storage";
-    readonly capability: "storage.getStorage";
-    readonly permission: "storage.read";
-    readonly risk: "low";
-}, {
-    readonly method: "storage.setStorage";
-    readonly module: "storage";
-    readonly capability: "storage.setStorage";
-    readonly permission: "storage.write";
-    readonly risk: "medium";
-}, {
-    readonly method: "network.request";
-    readonly module: "network";
-    readonly capability: "network.request";
-    readonly permission: "network.request";
-    readonly risk: "high";
-}, {
-    readonly method: "ui.showToast";
-    readonly module: "ui";
-    readonly capability: "ui.showToast";
-    readonly permission: "ui.toast";
-    readonly risk: "low";
-}, {
-    readonly method: "ui.showLoading";
-    readonly module: "ui";
-    readonly capability: "ui.showLoading";
-    readonly permission: "ui.loading";
-    readonly risk: "low";
-}, {
-    readonly method: "ui.hideLoading";
-    readonly module: "ui";
-    readonly capability: "ui.hideLoading";
-    readonly permission: "ui.loading";
-    readonly risk: "low";
-}, {
-    readonly method: "device.vibrate";
-    readonly module: "device";
-    readonly capability: "device.vibrate";
-    readonly permission: "device.vibrate";
-    readonly risk: "low";
-}, {
-    readonly method: "device.setClipboard";
-    readonly module: "device";
-    readonly capability: "device.setClipboard";
-    readonly permission: "device.clipboard.write";
-    readonly risk: "medium";
-}, {
-    readonly method: "navigation.close";
-    readonly module: "navigation";
-    readonly capability: "navigation.close";
-    readonly permission: "navigation.close";
-    readonly risk: "medium";
-}, {
-    readonly method: "navigation.reload";
-    readonly module: "navigation";
-    readonly capability: "navigation.reload";
-    readonly permission: "navigation.reload";
-    readonly risk: "medium";
-}, {
-    readonly method: "navigation.openAppPage";
-    readonly module: "navigation";
-    readonly capability: "navigation.openAppPage";
-    readonly permission: "navigation.openAppPage";
-    readonly risk: "medium";
-}, {
-    readonly method: "cloud.leaderboard.submit";
-    readonly module: "cloud";
-    readonly capability: "cloud.leaderboard.submit";
-    readonly permission: "cloud.leaderboard.write";
-    readonly risk: "medium";
-}, {
-    readonly method: "cloud.leaderboard.getList";
-    readonly module: "cloud";
-    readonly capability: "cloud.leaderboard.getList";
-    readonly permission: "cloud.leaderboard.read";
-    readonly risk: "low";
-}, {
-    readonly method: "cloud.leaderboard.getCurrentUserEntry";
-    readonly module: "cloud";
-    readonly capability: "cloud.leaderboard.getCurrentUserEntry";
-    readonly permission: "cloud.leaderboard.currentUserEntry.read";
-    readonly risk: "medium";
-}, {
-    readonly method: "cloud.leaderboard.deleteCurrentUserEntry";
-    readonly module: "cloud";
-    readonly capability: "cloud.leaderboard.deleteCurrentUserEntry";
-    readonly permission: "cloud.leaderboard.currentUserEntry.delete";
-    readonly risk: "medium";
-}, {
-    readonly method: "cloud.leaderboard.getInfo";
-    readonly module: "cloud";
-    readonly capability: "cloud.leaderboard.getInfo";
-    readonly permission: "cloud.leaderboard.info.read";
-    readonly risk: "low";
-}];
-/** bridge method 到请求 payload 的映射。 */
-export interface MiniProgramCapabilityPayloadMap {
-    [AUTH_LOGIN_METHOD]: LoginPayload;
-    [USER_GET_INFO_METHOD]: GetUserInfoPayload;
-    [USER_REVOKE_AUTHORIZATION_METHOD]: RevokeAuthorizationPayload;
-    [USER_GET_STEAM_GAME_LIST_METHOD]: GetSteamGameListPayload;
-    [SHARE_SHOW_SHARE_MENU_METHOD]: ShowShareMenuPayload;
-    [SHARE_SCREENSHOT_METHOD]: ScreenshotPayload;
-    [VIEWPORT_GET_WINDOW_INFO_METHOD]: GetWindowInfoPayload;
-    [VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD]: SetNavigationBarStylePayload;
-    [STORAGE_GET_STORAGE_METHOD]: GetStoragePayload;
-    [STORAGE_SET_STORAGE_METHOD]: SetStoragePayload;
-    [NETWORK_REQUEST_METHOD]: NetworkRequestPayload;
-    [UI_SHOW_TOAST_METHOD]: ShowToastPayload;
-    [UI_SHOW_LOADING_METHOD]: ShowLoadingPayload;
-    [UI_HIDE_LOADING_METHOD]: HideLoadingPayload;
-    [DEVICE_VIBRATE_METHOD]: VibratePayload;
-    [DEVICE_SET_CLIPBOARD_METHOD]: SetClipboardPayload;
-    [NAVIGATION_CLOSE_METHOD]: ClosePayload;
-    [NAVIGATION_RELOAD_METHOD]: ReloadPayload;
-    [NAVIGATION_OPEN_APP_PAGE_METHOD]: OpenAppPagePayload;
-    [CLOUD_LEADERBOARD_SUBMIT_METHOD]: SubmitLeaderboardEntryPayload;
-    [CLOUD_LEADERBOARD_GET_LIST_METHOD]: GetLeaderboardListPayload | undefined;
-    [CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD]: GetCurrentUserLeaderboardEntryPayload | undefined;
-    [CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD]: DeleteCurrentUserLeaderboardEntryPayload | undefined;
-    [CLOUD_LEADERBOARD_GET_INFO_METHOD]: GetLeaderboardInfoPayload | undefined;
-}
-/** bridge method 到标准化响应 payload 的映射。 */
-export interface MiniProgramCapabilityResultMap {
-    [AUTH_LOGIN_METHOD]: LoginResult;
-    [USER_GET_INFO_METHOD]: GetUserInfoResult;
-    [USER_REVOKE_AUTHORIZATION_METHOD]: RevokeAuthorizationResult;
-    [USER_GET_STEAM_GAME_LIST_METHOD]: GetSteamGameListResult;
-    [SHARE_SHOW_SHARE_MENU_METHOD]: ShowShareMenuResult;
-    [SHARE_SCREENSHOT_METHOD]: ScreenshotResult;
-    [VIEWPORT_GET_WINDOW_INFO_METHOD]: GetWindowInfoResult;
-    [VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD]: SetNavigationBarStyleResult;
-    [STORAGE_GET_STORAGE_METHOD]: GetStorageResult;
-    [STORAGE_SET_STORAGE_METHOD]: void;
-    [NETWORK_REQUEST_METHOD]: NetworkResponsePayload;
-    [UI_SHOW_TOAST_METHOD]: ShowToastResult;
-    [UI_SHOW_LOADING_METHOD]: ShowLoadingResult;
-    [UI_HIDE_LOADING_METHOD]: HideLoadingResult;
-    [DEVICE_VIBRATE_METHOD]: VibrateResult;
-    [DEVICE_SET_CLIPBOARD_METHOD]: SetClipboardResult;
-    [NAVIGATION_CLOSE_METHOD]: CloseResult;
-    [NAVIGATION_RELOAD_METHOD]: ReloadResult;
-    [NAVIGATION_OPEN_APP_PAGE_METHOD]: OpenAppPageResult;
-    [CLOUD_LEADERBOARD_SUBMIT_METHOD]: SubmitLeaderboardEntryResult;
-    [CLOUD_LEADERBOARD_GET_LIST_METHOD]: GetLeaderboardListResult;
-    [CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD]: GetCurrentUserLeaderboardEntryResult;
-    [CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD]: DeleteCurrentUserLeaderboardEntryResult;
-    [CLOUD_LEADERBOARD_GET_INFO_METHOD]: GetLeaderboardInfoResult;
-}
-/** 指定 bridge method 的请求 payload。 */
-export type MiniProgramCapabilityPayload<T extends MiniProgramBridgeMethod> = MiniProgramCapabilityPayloadMap[T];
-/** 指定 bridge method 的标准化响应 payload。 */
-export type MiniProgramCapabilityResult<T extends MiniProgramBridgeMethod> = MiniProgramCapabilityResultMap[T];
+export { AUTH_LOGIN_METHOD, CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_INFO_METHOD, CLOUD_LEADERBOARD_GET_LIST_METHOD, CLOUD_LEADERBOARD_SUBMIT_METHOD, DEVICE_SET_CLIPBOARD_METHOD, DEVICE_VIBRATE_METHOD, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NAVIGATION_CLOSE_METHOD, NAVIGATION_OPEN_APP_PAGE_METHOD, NAVIGATION_RELOAD_METHOD, NETWORK_REQUEST_METHOD, SHARE_SCREENSHOT_METHOD, SHARE_SHOW_SHARE_MENU_METHOD, STORAGE_GET_STORAGE_METHOD, STORAGE_SET_STORAGE_METHOD, UI_HIDE_LOADING_METHOD, UI_SHOW_LOADING_METHOD, UI_SHOW_TOAST_METHOD, USER_GET_INFO_METHOD, USER_GET_STEAM_GAME_LIST_METHOD, USER_REVOKE_AUTHORIZATION_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD, } from '@heybox/hb-sdk-protocol';
+export type { MiniProgramAuthMethod, MiniProgramBridgeMethod, MiniProgramCapabilityDefinition, MiniProgramCapabilityModule, MiniProgramCapabilityPayload, MiniProgramCapabilityPayloadMap, MiniProgramCapabilityResult, MiniProgramCapabilityResultMap, MiniProgramCapabilityRisk, MiniProgramCloudMethod, MiniProgramDeviceMethod, MiniProgramNavigationMethod, MiniProgramNetworkMethod, MiniProgramShareMethod, MiniProgramStorageMethod, MiniProgramUiMethod, MiniProgramUserMethod, MiniProgramViewportMethod, } from '@heybox/hb-sdk-protocol';

package/types/protocol/constants.d.ts

@@ -1,14 +1 @@
-/** 小程序沙盒通信命名空间，父容器与 iframe 内 SDK 必须保持一致。 */
-export declare const MINI_PROGRAM_MESSAGE_NAMESPACE: "heybox:miniprogram";
-/** 小程序沙盒通信协议版本。 */
-export declare const MINI_PROGRAM_MESSAGE_VERSION: 2;
-/** 父容器注入到小程序 URL 上的通信 nonce 参数名。 */
-export declare const MINI_PROGRAM_BRIDGE_NONCE_PARAM: "hb_mini_bridge_nonce";
-/** SDK 初始化时发给父容器的握手方法名。 */
-export declare const SDK_HANDSHAKE_METHOD: "sdk.handshake";
-/** Runtime 主动探测 SDK 当前文档地址的内部方法名。 */
-export declare const RUNTIME_LOCATION_PROBE_METHOD: "runtime.location.probe";
-/** SDK 向 Runtime 报告当前文档地址的内部方法名。 */
-export declare const SDK_LOCATION_REPORT_METHOD: "sdk.location.report";
-/** SDK 向 Runtime 报告 CSP 违规的内部方法名。 */
-export declare const SDK_CSP_VIOLATION_METHOD: "sdk.csp.violation";
+export { MINI_PROGRAM_BRIDGE_NONCE_PARAM, MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_MESSAGE_VERSION, RUNTIME_LOCATION_PROBE_METHOD, SDK_CSP_VIOLATION_METHOD, SDK_HANDSHAKE_METHOD, SDK_LOCATION_REPORT_METHOD, } from '@heybox/hb-sdk-protocol';

package/types/protocol/dev-session.d.ts

@@ -1,16 +1,16 @@
 import type { MiniProgramRuntimePermissionsSnapshot } from './runtime-permissions';
 /** Dev Shell 读取局域网 Dev Session endpoint 的 query 参数。 */
 export declare const MINI_PROGRAM_DEV_CONTEXT_QUERY_PARAM = "dev_context_url";
-/** Mock Host 创建和读取 Dev Session 的固定路径。 */
+/** Browser Dev Host 创建和读取 Dev Session 的固定路径。 */
 export declare const MINI_PROGRAM_DEV_CONTEXT_PATH = "/__hb_sdk__/dev-context";
 /** Dev Session 当前使用的 schema 版本。 */
 export declare const MINI_PROGRAM_DEV_SESSION_SCHEMA_VERSION: 1;
-/** Mock Host 创建 Dev Session 时接收的请求。 */
+/** Browser Dev Host 创建 Dev Session 时接收的请求。 */
 export interface MiniProgramDevSessionCreatePayload {
     mini_url_origin: string;
     runtime_permissions: MiniProgramRuntimePermissionsSnapshot;
 }
-/** Mock Host 创建 Dev Session 后返回的短期引用。 */
+/** Browser Dev Host 创建 Dev Session 后返回的短期引用。 */
 export interface MiniProgramDevSessionCreateResult {
     expires_at: number;
     token: string;

package/types/protocol/guards.d.ts

@@ -1,8 +1 @@
-import type { MiniProgramBridgeMessage } from './types';
-/**
- * 判断未知数据是否符合小程序 bridge 消息信封。
- *
- * @param value 待判断的未知数据。
- * @returns 当数据满足小程序 bridge 消息基础结构时返回 `true`。
- */
-export declare function isMiniProgramBridgeMessage(value: unknown): value is MiniProgramBridgeMessage;
+export { isMiniProgramBridgeMessage } from '@heybox/hb-sdk-protocol';

package/types/protocol/runtime-permissions.d.ts

@@ -1,41 +1,2 @@
-/**
- * 判断 permission key 是否由 Runtime 权限快照管理。
- *
- * @param key 待判断的 permission key。
- * @returns 该 key 需要读取 Runtime 权限快照时返回 `true`。
- */
-export declare function isManagedMiniProgramRuntimePermissionKey(key: string): boolean;
-/** Runtime 权限项的启用状态。 */
-export type MiniProgramRuntimePermissionStatus = 'enabled' | 'disabled';
-/** Runtime 权限快照中的单项权限配置。 */
-export interface MiniProgramRuntimePermissionEntry {
-    /** permission key。 */
-    key: string;
-    /** 当前权限状态。 */
-    status: MiniProgramRuntimePermissionStatus;
-    /** 由具体 permission key 定义的配置。 */
-    config: Record<string, unknown>;
-}
-/** 服务端下发的 Runtime schema v1 权限快照。 */
-export interface MiniProgramRuntimePermissionsSnapshot {
-    /** 权限快照 schema 版本，当前固定为 `1`。 */
-    schema_version: 1;
-    /** 可选的非负整数修订号。 */
-    revision?: number;
-    /** 权限配置列表。 */
-    entries: MiniProgramRuntimePermissionEntry[];
-}
-/** Runtime 权限快照的 fail-closed 解析结果。 */
-export interface ParsedMiniProgramRuntimePermissions {
-    /** 整份快照是否通过格式校验。 */
-    valid: boolean;
-    /** 通过校验的受管权限，以 permission key 索引。 */
-    permissions: Record<string, MiniProgramRuntimePermissionEntry>;
-}
-/**
- * 解析服务端权限快照；格式不完整时整份快照失效并 fail closed。
- *
- * @param snapshot 待校验的服务端权限快照。
- * @returns 解析状态和通过校验的受管权限。
- */
-export declare function parseMiniProgramRuntimePermissions(snapshot: unknown): ParsedMiniProgramRuntimePermissions;
+export { isManagedMiniProgramRuntimePermissionKey, parseMiniProgramRuntimePermissions, } from '@heybox/hb-sdk-protocol';
+export type { MiniProgramRuntimePermissionEntry, MiniProgramRuntimePermissionsSnapshot, MiniProgramRuntimePermissionStatus, ParsedMiniProgramRuntimePermissions, } from '@heybox/hb-sdk-protocol';

package/types/protocol/types.d.ts

@@ -1,151 +1,4 @@
-import type { UserInfoAuthorization } from '../modules/user/types';
-import type { MINI_PROGRAM_MESSAGE_NAMESPACE } from './constants';
-/**
- * 小程序沙盒消息类型。
- *
- * @remarks
- * 当前协议区分握手、请求、响应与事件四类消息。
- */
-export type MiniProgramBridgeMessageType = 'handshake' | 'request' | 'response' | 'event';
-/**
- * 首版开放给外部小程序监听的生命周期与业务事件名。
- *
- * @remarks
- * `on/off` 会基于该联合类型约束可监听的事件集合。
- */
-export type MiniProgramEventName = 'launch' | 'ready' | 'show' | 'hide' | 'unload' | 'error' | 'heybox_app_login_change' | 'user_info_authorization_change';
-/**
- * bridge 错误结构。
- *
- * 所有请求失败都会被规范化成该结构，SDK 侧再包装为 `HbMiniProgramSDKError`。
- */
-export interface MiniProgramBridgeError {
-    /** 稳定错误码，便于业务侧分支处理。 */
-    code: string;
-    /** 面向开发者的中文错误说明。 */
-    message: string;
-    /** 可选调试数据，不保证结构稳定。 */
-    data?: unknown;
-}
-/** SDK 初始化握手载荷。 */
-export interface SDKHandshakePayload {
-    /** 当前文档地址。 */
-    href: string;
-    /** 当前浏览器 User-Agent。 */
-    userAgent: string;
-    /** SDK 构建时注入的实际版本。 */
-    sdkVersion: string;
-}
-/** Runtime 发起 URL 探测时的载荷。 */
-export interface RuntimeLocationProbePayload {
-    /** 当前探测的唯一标识。 */
-    probeId: string;
-    /** Runtime 发起探测的时间戳。 */
-    timestamp: number;
-}
-/** SDK 主动或被动报告 URL 的触发来源。 */
-export type SDKLocationReportTrigger = 'probe' | 'history' | 'popstate' | 'hashchange' | 'pageshow' | 'resume';
-/** SDK 向 Runtime 报告当前 URL 的载荷。 */
-export interface SDKLocationReportPayload {
-    /** 响应探测时回传；主动报告时省略。 */
-    probeId?: string;
-    /** 当前文档完整地址，由 Runtime 执行范围校验。 */
-    href: string;
-    /** SDK 构建时注入的实际版本。 */
-    sdkVersion: string;
-    /** 本次报告的触发来源。 */
-    trigger: SDKLocationReportTrigger;
-    /** SDK 生成报告的时间戳。 */
-    timestamp: number;
-}
-/** CSP 阻断资源的归一化类型。 */
-export type SDKCSPBlockedResourceType = 'url' | 'inline' | 'eval' | 'unknown';
-/** SDK 向 Runtime 报告 CSP 违规的脱敏载荷。 */
-export interface SDKCSPViolationPayload {
-    effectiveDirective: string;
-    violatedDirective: string;
-    disposition: string;
-    blockedResourceType: SDKCSPBlockedResourceType;
-    blockedOrigin?: string;
-    redactedPathname?: string;
-    sanitizedPathnameHash?: string;
-    sdkVersion: string;
-    timestamp: number;
-}
-/**
- * SDK 与沙盒之间统一的 postMessage 信封。
- *
- * 当前 iframe sandbox 即使启用了 `allow-same-origin`，协议也不把 origin 当作信任依据，
- * 而是由父容器校验 `event.source === iframe.contentWindow` 与实例 nonce。
- */
-export interface MiniProgramBridgeMessage<TPayload = unknown> {
-    /** 固定命名空间，用于过滤非小程序消息。 */
-    namespace: typeof MINI_PROGRAM_MESSAGE_NAMESPACE;
-    /** 协议版本号。 */
-    version: 1 | 2;
-    /** 当前 iframe 实例的通信随机串。 */
-    nonce: string;
-    /** 消息类型。 */
-    type: MiniProgramBridgeMessageType;
-    /** 请求/响应关联 ID。 */
-    id?: string;
-    /** 请求方法名或事件名。 */
-    method?: string;
-    /** 消息载荷。 */
-    payload?: TPayload;
-    /** 失败响应的错误信息。 */
-    error?: MiniProgramBridgeError;
-}
-/**
- * 小程序事件载荷映射。
- *
- * `on/off` 会基于该映射推导 handler 参数类型。
- */
-export interface MiniProgramEventPayloadMap {
-    /** 小程序首次完成握手并启动。 */
-    launch: {
-        /** 事件时间戳。 */
-        timestamp: number;
-        /** 父容器最终加载到 iframe 的 URL。 */
-        url?: string;
-    };
-    /** SDK 握手成功时派发的不可重放边沿通知，不是持久状态；需要当前状态时使用 `getHandshakeState()` / `onHandshakeStateChange()`。 */
-    ready: {
-        /** 事件时间戳。 */
-        timestamp: number;
-    };
-    /** 小程序页面展示。 */
-    show: {
-        /** 事件时间戳。 */
-        timestamp: number;
-        /** 触发展示的父容器来源。 */
-        source?: string;
-    };
-    /** 小程序页面隐藏。 */
-    hide: {
-        /** 事件时间戳。 */
-        timestamp: number;
-        /** 触发隐藏的父容器来源。 */
-        source?: string;
-    };
-    /** 小程序页面即将卸载。 */
-    unload: {
-        /** 事件时间戳。 */
-        timestamp: number;
-    };
-    /** 父容器或开放能力运行异常。 */
-    error: MiniProgramBridgeError;
-    /** 黑盒 APP 登录状态变化；需要资料时重新调用 `user.getInfo()`。 */
-    heybox_app_login_change: {
-        isHeyboxAppLoggedIn: boolean;
-    };
-    /** 用户资料授权状态变化；事件不携带任何身份或资料。 */
-    user_info_authorization_change: UserInfoAuthorization;
-}
-/**
- * 小程序事件监听函数。
- *
- * @typeParam T 要监听的事件名。
- * @param payload 对应事件的标准化载荷。
- */
+import type { MiniProgramEventName, MiniProgramEventPayloadMap } from '@heybox/hb-sdk-protocol';
+export type { MiniProgramBridgeError, MiniProgramBridgeMessage, MiniProgramBridgeMessageType, MiniProgramEventName, MiniProgramEventPayloadMap, RuntimeLocationProbePayload, SDKCSPBlockedResourceType, SDKCSPViolationPayload, SDKHandshakePayload, SDKLocationReportPayload, SDKLocationReportTrigger, } from '@heybox/hb-sdk-protocol';
+/** 小程序事件监听函数。 */
 export type MiniProgramEventHandler<T extends MiniProgramEventName = MiniProgramEventName> = (payload: MiniProgramEventPayloadMap[T]) => void;

package/types/protocol.d.ts

@@ -1,23 +1,8 @@
-export { MINI_PROGRAM_BRIDGE_NONCE_PARAM, MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_MESSAGE_VERSION, RUNTIME_LOCATION_PROBE_METHOD, SDK_CSP_VIOLATION_METHOD, SDK_HANDSHAKE_METHOD, SDK_LOCATION_REPORT_METHOD, } from './protocol/constants';
-export { isMiniProgramBridgeMessage } from './protocol/guards';
-export { computeTrustedIframeUserGesture, type TrustedIframeUserGestureEnvironment, } from './protocol/trusted-user-gesture';
-export { isManagedMiniProgramRuntimePermissionKey, parseMiniProgramRuntimePermissions } from './protocol/runtime-permissions';
-export { isOfficialMiniProgramNetworkUrl, isProtectedMiniProgramNetworkPath, MINI_PROGRAM_NETWORK_PROTECTED_PATHS, normalizeMiniProgramNetworkPathname, } from './protocol/network-policy';
-export type { MiniProgramRuntimePermissionEntry, MiniProgramRuntimePermissionStatus, MiniProgramRuntimePermissionsSnapshot, ParsedMiniProgramRuntimePermissions, } from './protocol/runtime-permissions';
-export type { MiniProgramBridgeError, MiniProgramBridgeMessage, MiniProgramBridgeMessageType, MiniProgramEventHandler, MiniProgramEventName, MiniProgramEventPayloadMap, RuntimeLocationProbePayload, SDKCSPBlockedResourceType, SDKCSPViolationPayload, SDKHandshakePayload, SDKLocationReportPayload, SDKLocationReportTrigger, } from './protocol/types';
-export { AUTH_LOGIN_METHOD, CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_INFO_METHOD, CLOUD_LEADERBOARD_GET_LIST_METHOD, CLOUD_LEADERBOARD_SUBMIT_METHOD, DEVICE_SET_CLIPBOARD_METHOD, DEVICE_VIBRATE_METHOD, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NAVIGATION_CLOSE_METHOD, NAVIGATION_OPEN_APP_PAGE_METHOD, NAVIGATION_RELOAD_METHOD, NETWORK_REQUEST_METHOD, SHARE_SCREENSHOT_METHOD, SHARE_SHOW_SHARE_MENU_METHOD, STORAGE_GET_STORAGE_METHOD, STORAGE_SET_STORAGE_METHOD, UI_HIDE_LOADING_METHOD, UI_SHOW_LOADING_METHOD, UI_SHOW_TOAST_METHOD, USER_REVOKE_AUTHORIZATION_METHOD, USER_GET_STEAM_GAME_LIST_METHOD, USER_GET_INFO_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD, } from './protocol/capabilities';
-export type { MiniProgramDeviceMethod, MiniProgramAuthMethod, MiniProgramBridgeMethod, MiniProgramCapabilityDefinition, MiniProgramCapabilityModule, MiniProgramCapabilityPayload, MiniProgramCapabilityPayloadMap, MiniProgramCapabilityResult, MiniProgramCapabilityResultMap, MiniProgramCapabilityRisk, MiniProgramCloudMethod, MiniProgramNavigationMethod, MiniProgramNetworkMethod, MiniProgramShareMethod, MiniProgramStorageMethod, MiniProgramUiMethod, MiniProgramUserMethod, MiniProgramViewportMethod, } from './protocol/capabilities';
-export type { LoginOptions, LoginPayload, LoginResult, LoginScope } from './modules/auth';
-export type { DeleteCurrentUserLeaderboardEntryPayload, DeleteCurrentUserLeaderboardEntryResult, GetCurrentUserLeaderboardEntryPayload, GetCurrentUserLeaderboardEntryResult, GetLeaderboardInfoPayload, GetLeaderboardInfoResult, GetLeaderboardListPayload, GetLeaderboardListResult, LeaderboardEntry, LeaderboardOrder, SubmitLeaderboardEntryPayload, SubmitLeaderboardEntryResult, } from './modules/cloud';
-export type { AuthorizedUserInfo, GetUserInfoPayload, GetUserInfoResult, RevokeAuthorizationPayload, RevokeAuthorizationResult, GetSteamGameListOptions, GetSteamGameListPayload, GetSteamGameListResult, MiniProgramUserInfoResult, UserInfoAuthorization, UserInfoAuthorizationStatus, SteamGameListData, SteamGameListItem, SteamGamePrice, SteamGameListSort, } from './modules/user';
-export { USER_INFO_AUTHORIZATION_SCOPES } from './modules/user';
-export type { UserInfoAuthorizationScope } from './modules/user';
-export type { ScreenshotPayload, ScreenshotResult } from './modules/share/screenshot';
-export type { ShowShareMenuPayload, ShowShareMenuResult } from './modules/share/show-share-menu';
-export type { MiniProgramScreenshotOptions, MiniProgramScreenshotRect, MiniProgramShareChannel, MiniProgramSharePostOptions, MiniProgramShowShareMenuOptions, } from './modules/share';
-export type { GetStoragePayload, GetStorageResult, SetStoragePayload } from './modules/storage';
-export type { GetWindowInfoPayload, GetWindowInfoResult, MiniProgramNavigationBarForegroundStyle, MiniProgramSafeArea, MiniProgramSetNavigationBarStyleOptions, MiniProgramWindowInfoResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult, } from './modules/viewport';
-export type { MiniProgramNetworkHeaders, MiniProgramNetworkParams, MiniProgramNetworkRequestConfig, MiniProgramNetworkRequestMethod, MiniProgramNetworkResponse, MiniProgramNetworkValidateStatus, NetworkRequestPayload, NetworkResponsePayload, } from './modules/network';
-export type { HideLoadingPayload, HideLoadingResult, MiniProgramToastStatus, ShowLoadingPayload, ShowLoadingResult, ShowToastPayload, ShowToastResult, } from './modules/ui';
-export type { MiniProgramVibrateIntensity, SetClipboardPayload, SetClipboardResult, VibratePayload, VibrateResult } from './modules/device';
-export type { ClosePayload, CloseResult, OpenAppPagePayload, OpenAppPageResult, OpenGameDetailAppPagePayload, OpenPostDetailAppPagePayload, OpenUserDetailAppPagePayload, ReloadPayload, ReloadResult, } from './modules/navigation';
+export { AUTH_LOGIN_METHOD, CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_INFO_METHOD, CLOUD_LEADERBOARD_GET_LIST_METHOD, CLOUD_LEADERBOARD_SUBMIT_METHOD, DEVICE_SET_CLIPBOARD_METHOD, DEVICE_VIBRATE_METHOD, MINI_PROGRAM_BRIDGE_NONCE_PARAM, MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_MESSAGE_VERSION, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NAVIGATION_CLOSE_METHOD, NAVIGATION_OPEN_APP_PAGE_METHOD, NAVIGATION_RELOAD_METHOD, NETWORK_REQUEST_METHOD, RUNTIME_LOCATION_PROBE_METHOD, SDK_CSP_VIOLATION_METHOD, SDK_HANDSHAKE_METHOD, SDK_LOCATION_REPORT_METHOD, SHARE_SCREENSHOT_METHOD, SHARE_SHOW_SHARE_MENU_METHOD, STORAGE_GET_STORAGE_METHOD, STORAGE_SET_STORAGE_METHOD, UI_HIDE_LOADING_METHOD, UI_SHOW_LOADING_METHOD, UI_SHOW_TOAST_METHOD, USER_INFO_AUTHORIZATION_SCOPES, USER_GET_INFO_METHOD, USER_GET_STEAM_GAME_LIST_METHOD, USER_REVOKE_AUTHORIZATION_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD, isManagedMiniProgramRuntimePermissionKey, isMiniProgramBridgeMessage, parseMiniProgramRuntimePermissions, } from '@heybox/hb-sdk-protocol';
+export type { AuthorizedUserInfo, ClosePayload, CloseResult, DeleteCurrentUserLeaderboardEntryPayload, DeleteCurrentUserLeaderboardEntryResult, GetCurrentUserLeaderboardEntryPayload, GetCurrentUserLeaderboardEntryResult, GetLeaderboardInfoPayload, GetLeaderboardInfoResult, GetLeaderboardListPayload, GetLeaderboardListResult, GetSteamGameListPayload, GetSteamGameListResult, GetStoragePayload, GetStorageResult, GetUserInfoPayload, GetUserInfoResult, GetWindowInfoPayload, GetWindowInfoResult, HideLoadingPayload, HideLoadingResult, LeaderboardEntry, LeaderboardOrder, LoginPayload, LoginResult, LoginScope, MiniProgramAuthMethod, MiniProgramBridgeError, MiniProgramBridgeMessage, MiniProgramBridgeMessageType, MiniProgramBridgeMethod, MiniProgramCapabilityDefinition, MiniProgramCapabilityModule, MiniProgramCapabilityPayload, MiniProgramCapabilityPayloadMap, MiniProgramCapabilityResult, MiniProgramCapabilityResultMap, MiniProgramCapabilityRisk, MiniProgramCloudMethod, MiniProgramDeviceMethod, MiniProgramEventName, MiniProgramEventPayloadMap, MiniProgramNavigationBarForegroundStyle, MiniProgramNavigationMethod, MiniProgramNetworkHeaders, MiniProgramNetworkMethod, MiniProgramNetworkParams, MiniProgramNetworkRequestMethod, MiniProgramRuntimePermissionEntry, MiniProgramRuntimePermissionsSnapshot, MiniProgramRuntimePermissionStatus, MiniProgramSafeArea, MiniProgramScreenshotRect, MiniProgramShareChannel, MiniProgramShareMethod, MiniProgramSharePostOptions, MiniProgramStorageMethod, MiniProgramToastStatus, MiniProgramUiMethod, MiniProgramUserInfoResult, MiniProgramUserMethod, MiniProgramVibrateIntensity, MiniProgramViewportMethod, MiniProgramWindowInfoResult, NetworkRequestPayload, NetworkResponsePayload, OpenAppPagePayload, OpenAppPageResult, OpenGameDetailAppPagePayload, OpenPostDetailAppPagePayload, OpenUserDetailAppPagePayload, ParsedMiniProgramRuntimePermissions, ReloadPayload, ReloadResult, RevokeAuthorizationPayload, RevokeAuthorizationResult, RuntimeLocationProbePayload, ScreenshotPayload, ScreenshotResult, SDKCSPBlockedResourceType, SDKCSPViolationPayload, SDKHandshakePayload, SDKLocationReportPayload, SDKLocationReportTrigger, SetClipboardPayload, SetClipboardResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult, SetStoragePayload, ShowLoadingPayload, ShowLoadingResult, ShowShareMenuPayload, ShowShareMenuResult, ShowToastPayload, ShowToastResult, SteamGameListData, SteamGameListItem, SteamGameListSort, SteamGamePrice, SubmitLeaderboardEntryPayload, SubmitLeaderboardEntryResult, UserInfoAuthorization, UserInfoAuthorizationScope, UserInfoAuthorizationStatus, VibratePayload, VibrateResult, } from '@heybox/hb-sdk-protocol';
+export type { LoginOptions } from './modules/auth';
+export type { GetSteamGameListOptions } from './modules/user';
+export type { MiniProgramEventHandler } from './protocol/types';
+export type { MiniProgramNetworkRequestConfig, MiniProgramNetworkResponse, MiniProgramNetworkValidateStatus, } from './modules/network';
+export type { MiniProgramScreenshotOptions, MiniProgramShowShareMenuOptions } from './modules/share';
+export type { MiniProgramSetNavigationBarStyleOptions } from './modules/viewport';