@heybox/hb-sdk 0.4.3 → 0.4.4

package/types/protocol/capabilities.d.ts

@@ -1,7 +1,10 @@
 import type { LoginPayload, LoginResult } from '../modules/auth';
+import type { SetClipboardPayload, SetClipboardResult, VibratePayload, VibrateResult } from '../modules/device';
+import type { ClosePayload, CloseResult, 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 } from '../modules/user';
 import type { GetWindowInfoPayload, GetWindowInfoResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult } from '../modules/viewport';
 /**
@@ -67,6 +70,20 @@ export declare const STORAGE_SET_STORAGE_METHOD: "storage.setStorage";
  * 供 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";
 /** 授权模块开放的方法名。 */
 export type MiniProgramAuthMethod = typeof AUTH_LOGIN_METHOD;
 /** 用户模块开放的方法名。 */
@@ -79,10 +96,16 @@ export type MiniProgramViewportMethod = typeof VIEWPORT_GET_WINDOW_INFO_METHOD |
 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;
 /** 父容器开放给小程序调用的 bridge method。 */
-export type MiniProgramBridgeMethod = MiniProgramAuthMethod | MiniProgramUserMethod | MiniProgramShareMethod | MiniProgramViewportMethod | MiniProgramStorageMethod | MiniProgramNetworkMethod;
+export type MiniProgramBridgeMethod = MiniProgramAuthMethod | MiniProgramUserMethod | MiniProgramShareMethod | MiniProgramViewportMethod | MiniProgramStorageMethod | MiniProgramNetworkMethod | MiniProgramUiMethod | MiniProgramDeviceMethod | MiniProgramNavigationMethod;
 /** 小程序开放能力所属模块。 */
-export type MiniProgramCapabilityModule = 'auth' | 'user' | 'share' | 'viewport' | 'storage' | 'network';
+export type MiniProgramCapabilityModule = 'auth' | 'user' | 'share' | 'viewport' | 'storage' | 'network' | 'ui' | 'device' | 'navigation';
 /** 小程序开放能力风险级别，用于权限、审计和灰度策略。 */
 export type MiniProgramCapabilityRisk = 'low' | 'medium' | 'high';
 /**
@@ -164,6 +187,48 @@ export declare const MINI_PROGRAM_PROTOCOL_CAPABILITIES: readonly [{
     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";
 }];
 /** bridge method 到请求 payload 的映射。 */
 export interface MiniProgramCapabilityPayloadMap {
@@ -176,6 +241,13 @@ export interface MiniProgramCapabilityPayloadMap {
     [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;
 }
 /** bridge method 到标准化响应 payload 的映射。 */
 export interface MiniProgramCapabilityResultMap {
@@ -188,6 +260,13 @@ export interface MiniProgramCapabilityResultMap {
     [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;
 }
 /** 指定 bridge method 的请求 payload。 */
 export type MiniProgramCapabilityPayload<T extends MiniProgramBridgeMethod> = MiniProgramCapabilityPayloadMap[T];

package/types/protocol.d.ts

@@ -1,8 +1,8 @@
 export { MINI_PROGRAM_BRIDGE_NONCE_PARAM, MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_MESSAGE_VERSION, SDK_HANDSHAKE_METHOD, } from './protocol/constants';
 export { isMiniProgramBridgeMessage } from './protocol/guards';
 export type { MiniProgramBridgeError, MiniProgramBridgeMessage, MiniProgramBridgeMessageType, MiniProgramEventHandler, MiniProgramEventName, MiniProgramEventPayloadMap, } from './protocol/types';
-export { AUTH_LOGIN_METHOD, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NETWORK_REQUEST_METHOD, SHARE_SCREENSHOT_METHOD, SHARE_SHOW_SHARE_MENU_METHOD, STORAGE_GET_STORAGE_METHOD, STORAGE_SET_STORAGE_METHOD, USER_GET_INFO_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD, } from './protocol/capabilities';
-export type { MiniProgramAuthMethod, MiniProgramBridgeMethod, MiniProgramCapabilityDefinition, MiniProgramCapabilityModule, MiniProgramCapabilityPayload, MiniProgramCapabilityPayloadMap, MiniProgramCapabilityResult, MiniProgramCapabilityResultMap, MiniProgramCapabilityRisk, MiniProgramNetworkMethod, MiniProgramShareMethod, MiniProgramStorageMethod, MiniProgramUserMethod, MiniProgramViewportMethod, } from './protocol/capabilities';
+export { AUTH_LOGIN_METHOD, DEVICE_SET_CLIPBOARD_METHOD, DEVICE_VIBRATE_METHOD, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NAVIGATION_CLOSE_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, 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, MiniProgramNavigationMethod, MiniProgramNetworkMethod, MiniProgramShareMethod, MiniProgramStorageMethod, MiniProgramUiMethod, MiniProgramUserMethod, MiniProgramViewportMethod, } from './protocol/capabilities';
 export type { LoginPayload, LoginResult } from './modules/auth';
 export type { GetUserInfoPayload, GetUserInfoResult, MiniProgramUserInfo, MiniProgramUserInfoResult, } from './modules/user';
 export type { ScreenshotPayload, ScreenshotResult } from './modules/share/screenshot';
@@ -11,3 +11,6 @@ export type { MiniProgramScreenshotOptions, MiniProgramScreenshotRect, MiniProgr
 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, ReloadPayload, ReloadResult, } from './modules/navigation';