@heybox/hb-sdk 0.3.3 → 0.4.0

package/types/modules/viewport/index.d.ts

@@ -44,15 +44,39 @@ export interface MiniProgramWindowInfoResult {
     screenTop: number;
 }
 export { VIEWPORT_GET_WINDOW_INFO_METHOD } from '../../protocol/capabilities';
+export { VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD } from '../../protocol/capabilities';
 /** `viewport.getWindowInfo` 不需要入参。 */
 export type GetWindowInfoPayload = void;
 /** `viewport.getWindowInfo` 返回当前小程序可用窗口信息。 */
 export type GetWindowInfoResult = MiniProgramWindowInfoResult;
+/**
+ * 导航栏关闭按钮与状态栏图标/文字的前景样式。
+ *
+ * @remarks
+ * `light` 表示白色前景，适合深色背景；`dark` 表示黑色前景，适合浅色背景。
+ */
+export type MiniProgramNavigationBarForegroundStyle = 'light' | 'dark';
+/**
+ * 设置导航栏样式的配置。
+ *
+ * @remarks
+ * 当前仅开放关闭按钮与状态栏图标/文字的前景明暗样式，不设置导航栏背景色。
+ */
+export interface MiniProgramSetNavigationBarStyleOptions {
+    /** 导航栏关闭按钮与状态栏图标/文字的前景样式。 */
+    foregroundStyle: MiniProgramNavigationBarForegroundStyle;
+}
+/** `viewport.setNavigationBarStyle` 的入参。 */
+export type SetNavigationBarStylePayload = MiniProgramSetNavigationBarStyleOptions;
+/** `viewport.setNavigationBarStyle` 无稳定返回值。 */
+export type SetNavigationBarStyleResult = void;
 export type { MiniProgramViewportMethod } from '../../protocol/capabilities';
 /** 外部小程序可调用的 Viewport 模块。 */
 export interface MiniProgramViewportModule {
     /** 获取当前小程序窗口信息。 */
     getWindowInfo(): Promise<GetWindowInfoResult>;
+    /** 设置导航栏关闭按钮与状态栏图标/文字的前景样式。 */
+    setNavigationBarStyle(options: MiniProgramSetNavigationBarStyleOptions): Promise<SetNavigationBarStyleResult>;
 }
 /**
  * 获取当前小程序窗口信息。
@@ -62,6 +86,15 @@ export interface MiniProgramViewportModule {
  * @throws {HbMiniProgramSDKError} 当 bridge、父容器或宿主能力调用失败时抛出。
  */
 export declare function getWindowInfo(requester: MiniProgramRequester): Promise<GetWindowInfoResult>;
+/**
+ * 设置导航栏关闭按钮与状态栏图标/文字的前景样式。
+ *
+ * @param requester 底层 bridge 请求能力。
+ * @param options 导航栏样式配置。
+ * @returns 宿主接受设置后 resolve。
+ * @throws {HbMiniProgramSDKError} 当 bridge、父容器或宿主能力调用失败时抛出。
+ */
+export declare function setNavigationBarStyle(requester: MiniProgramRequester, options: MiniProgramSetNavigationBarStyleOptions): Promise<SetNavigationBarStyleResult>;
 /**
  * 创建 Viewport 模块。
  *

package/types/protocol/capabilities.d.ts

@@ -3,7 +3,7 @@ import type { NetworkRequestPayload, NetworkResponsePayload } from '../modules/n
 import type { ScreenshotPayload, ScreenshotResult, ShowShareMenuPayload, ShowShareMenuResult } from '../modules/share';
 import type { GetStoragePayload, GetStorageResult, SetStoragePayload } from '../modules/storage';
 import type { GetUserInfoPayload, GetUserInfoResult } from '../modules/user';
-import type { GetWindowInfoPayload, GetWindowInfoResult } from '../modules/viewport';
+import type { GetWindowInfoPayload, GetWindowInfoResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult } from '../modules/viewport';
 /**
  * 登录授权能力方法名。
  *
@@ -39,6 +39,13 @@ export declare const SHARE_SCREENSHOT_METHOD: "share.screenshot";
  * 供 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 能力方法名。
  *
@@ -67,7 +74,7 @@ export type MiniProgramUserMethod = typeof USER_GET_INFO_METHOD;
 /** 分享模块开放的方法名。 */
 export type MiniProgramShareMethod = typeof SHARE_SHOW_SHARE_MENU_METHOD | typeof SHARE_SCREENSHOT_METHOD;
 /** Viewport 模块开放的方法名。 */
-export type MiniProgramViewportMethod = typeof VIEWPORT_GET_WINDOW_INFO_METHOD;
+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;
 /** 网络模块开放的方法名。 */
@@ -133,6 +140,12 @@ export declare const MINI_PROGRAM_PROTOCOL_CAPABILITIES: readonly [{
     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";
@@ -159,6 +172,7 @@ export interface MiniProgramCapabilityPayloadMap {
     [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;
@@ -170,6 +184,7 @@ export interface MiniProgramCapabilityResultMap {
     [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;

package/types/protocol.d.ts

@@ -1,7 +1,7 @@
 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, } from './protocol/capabilities';
+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 type { LoginPayload, LoginResult } from './modules/auth';
 export type { GetUserInfoPayload, GetUserInfoResult, MiniProgramUserInfo, MiniProgramUserInfoResult, } from './modules/user';
@@ -9,5 +9,5 @@ export type { ScreenshotPayload, ScreenshotResult } from './modules/share/screen
 export type { ShowShareMenuPayload, ShowShareMenuResult } from './modules/share/show-share-menu';
 export type { MiniProgramScreenshotOptions, MiniProgramScreenshotRect, MiniProgramShareChannel, MiniProgramShowShareMenuOptions, } from './modules/share';
 export type { GetStoragePayload, GetStorageResult, SetStoragePayload, } from './modules/storage';
-export type { GetWindowInfoPayload, GetWindowInfoResult, MiniProgramSafeArea, MiniProgramWindowInfoResult, } from './modules/viewport';
+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';