@heybox/hb-sdk 0.7.4 → 0.8.0-alpha

package/types/core/errors.d.ts

@@ -18,9 +18,9 @@ export declare class HbMiniProgramSDKError extends Error {
 /**
  * 创建 SDK 标准错误。
  *
- * @param code 稳定错误码。
- * @param message 面向开发者的错误说明。
- * @param data 可选调试数据。
+ * @param code - 稳定错误码。
+ * @param message - 面向开发者的错误说明。
+ * @param data - 可选调试数据。
  * @returns 标准化 `HbMiniProgramSDKError` 实例。
  *
  * @remarks
@@ -34,7 +34,7 @@ export declare function createSDKError(code: string, message: string, data?: unk
  * 仅在请求已经成功走完 bridge / runtime / 宿主调用链、但最终 HTTP 状态不满足
  * `validateStatus` 时抛出。它不表示握手失败或 bridge 级错误。
  *
- * @typeParam T 标准化响应数据的类型。
+ * @typeParam T - 标准化响应数据的类型。
  */
 export declare class HbMiniProgramNetworkError<T = unknown> extends Error {
     /** HTTP 状态码。 */
@@ -48,7 +48,7 @@ export declare class HbMiniProgramNetworkError<T = unknown> extends Error {
     /** 完整标准化响应。 */
     response: MiniProgramNetworkResponse<T>;
     /**
-     * @param response 已完成请求的标准化网络响应。
+     * @param response - 已完成请求的标准化网络响应。
      */
     constructor(response: MiniProgramNetworkResponse<T>);
 }

package/types/core/sdk.d.ts

@@ -53,16 +53,16 @@ export declare class MiniProgramSDK {
     /**
      * 注册小程序生命周期或业务事件。
      *
-     * @param eventName 要监听的事件名。
-     * @param handler 事件处理函数。
+     * @param eventName - 要监听的事件名。
+     * @param handler - 事件处理函数。
      * @returns 事件解绑函数。
      */
     on<T extends MiniProgramEventName>(eventName: T, handler: MiniProgramEventHandler<T>): () => void;
     /**
      * 移除小程序生命周期或业务事件。
      *
-     * @param eventName 要移除的事件名。
-     * @param handler 对应的事件处理函数。
+     * @param eventName - 要移除的事件名。
+     * @param handler - 对应的事件处理函数。
      */
     off<T extends MiniProgramEventName>(eventName: T, handler: MiniProgramEventHandler<T>): void;
     /**
@@ -77,7 +77,7 @@ export declare class MiniProgramSDK {
 /**
  * 创建独立 SDK 实例。
  *
- * @param options SDK 运行配置，例如超时时间、nonce 或测试环境注入的 window。
+ * @param options - SDK 运行配置，例如超时时间、nonce 或测试环境注入的 window。
  * @returns 可独立管理生命周期的 `MiniProgramSDK` 实例。
  *
  * @remarks

package/types/core/singleton.d.ts

@@ -10,24 +10,74 @@ import type { MiniProgramDeviceModule } from '../modules/device';
 import type { MiniProgramNavigationModule } from '../modules/navigation';
 import type { MiniProgramEventHandler, MiniProgramEventName } from '../protocol/types';
 import type { MiniProgramSDKHandshakeState, MiniProgramSDKHandshakeStateHandler } from './handshake-state';
-/** 获取默认 SDK 实例的当前握手状态。 */
+/**
+ * 获取默认 SDK 实例的当前握手状态。
+ *
+ * @since 0.7.0-alpha.9
+ * @hbPlatform android
+ * @hbPlatform ios
+ * @hbPlatform ohos
+ * @hbPlatform windows
+ * @hbPlatform macos
+ * @hbClient android none
+ * @hbClient ios none
+ * @hbClient ohos none
+ * @hbClient windows none
+ * @hbClient macos none
+ */
 export declare function getHandshakeState(): MiniProgramSDKHandshakeState;
-/** 订阅默认 SDK 实例的握手状态，并立即接收当前状态。 */
+/**
+ * 订阅默认 SDK 实例的握手状态，并立即接收当前状态。
+ *
+ * @since 0.7.0-alpha.9
+ * @hbPlatform android
+ * @hbPlatform ios
+ * @hbPlatform ohos
+ * @hbPlatform windows
+ * @hbPlatform macos
+ * @hbClient android none
+ * @hbClient ios none
+ * @hbClient ohos none
+ * @hbClient windows none
+ * @hbClient macos none
+ */
 export declare function onHandshakeStateChange(handler: MiniProgramSDKHandshakeStateHandler): () => void;
 /**
  * 注册默认 SDK 实例的事件监听。
  *
- * @param eventName 要监听的事件名。
- * @param handler 事件处理函数。
+ * @param eventName - 要监听的事件名。
+ * @param handler - 事件处理函数。
  * @returns 事件解绑函数。
+ * @since 0.2.0-alpha.0
+ * @hbPlatform android
+ * @hbPlatform ios
+ * @hbPlatform ohos
+ * @hbPlatform windows
+ * @hbPlatform macos
+ * @hbClient android none
+ * @hbClient ios none
+ * @hbClient ohos none
+ * @hbClient windows none
+ * @hbClient macos none
  */
 export declare function on<T extends MiniProgramEventName>(eventName: T, handler: MiniProgramEventHandler<T>): () => void;
 /**
  * 移除默认 SDK 实例的事件监听。
  *
- * @param eventName 要移除的事件名。
- * @param handler 对应的事件处理函数。
+ * @param eventName - 要移除的事件名。
+ * @param handler - 对应的事件处理函数。
  * @returns 无返回值。
+ * @since 0.2.0-alpha.0
+ * @hbPlatform android
+ * @hbPlatform ios
+ * @hbPlatform ohos
+ * @hbPlatform windows
+ * @hbPlatform macos
+ * @hbClient android none
+ * @hbClient ios none
+ * @hbClient ohos none
+ * @hbClient windows none
+ * @hbClient macos none
  */
 export declare function off<T extends MiniProgramEventName>(eventName: T, handler: MiniProgramEventHandler<T>): void;
 /** 默认 SDK 实例的授权模块。 */

package/types/miniapp-manifest/schema.d.ts

@@ -1,8 +1,11 @@
 export declare const MINIAPP_TEMPLATE_VERSION = "0.0.0";
+export declare const MINIAPP_PLATFORM_VALUES: readonly ["android", "ios", "ohos", "windows", "macos", "linux"];
+export type MiniappPlatform = (typeof MINIAPP_PLATFORM_VALUES)[number];
 export interface MiniappManifest {
     [key: string]: unknown;
     sdkVersion: string;
     version: string;
+    platforms: readonly MiniappPlatform[];
 }
 export interface ParseMiniappManifestResult {
     manifest: MiniappManifest;
@@ -16,5 +19,7 @@ export declare function parseMiniappManifestJson(raw: string, sourceLabel?: stri
 export declare function validateMiniappManifestForDeploy(manifest: MiniappManifest): {
     version: string;
     sdkVersion: string;
+    platforms: readonly ("android" | "ios" | "ohos" | "windows" | "macos" | "linux")[];
 };
+export declare function validateMiniappPlatforms(platforms: unknown, sourceLabel?: string): readonly MiniappPlatform[];
 export declare function validateSdkVersion(version: unknown, sourceLabel?: string): string;

package/types/miniapp-publish/index.d.ts

@@ -71,7 +71,7 @@ export interface MiniappUploadSessionFile {
 /**
  * 校验构建产物路径和大小，并按路径 UTF-8 字节序排序。
  *
- * @param files 待处理的构建产物文件。
+ * @param files - 待处理的构建产物文件。
  * @returns 保留输入附加字段的有序文件列表。
  * @throws 路径不规范、路径重复或文件大小非法时抛出错误。
  */
@@ -81,8 +81,8 @@ export declare function prepareMiniappArtifactFiles<T extends MiniappArtifactFil
 /**
  * 按服务端 session key 前缀校验最终上传路径的 UTF-8 字节长度。
  *
- * @param files 待上传的构建产物文件。
- * @param options 小程序和长度限制配置。
+ * @param files - 待上传的构建产物文件。
+ * @param options - 小程序和长度限制配置。
  * @returns 第一个超长路径的错误提示；全部合法时返回 `undefined`。
  */
 export declare function validateMiniappUploadPathLengths(files: readonly Pick<MiniappArtifactFile, 'relativePath'>[], options: {
@@ -92,7 +92,7 @@ export declare function validateMiniappUploadPathLengths(files: readonly Pick<Mi
 /**
  * 创建 v1 整包签名头。
  *
- * @param fileCount 参与签名的文件数量。
+ * @param fileCount - 参与签名的文件数量。
  * @returns 包含协议标识和文件数量的字节数组。
  * @throws 文件数量超出协议范围时抛出错误。
  */
@@ -100,7 +100,7 @@ export declare function createMiniappArtifactSignatureHeader(fileCount: number):
 /**
  * 创建单个文件的 v1 framing header。
  *
- * @param file 已规范化或待校验的构建产物文件。
+ * @param file - 已规范化或待校验的构建产物文件。
  * @returns 包含路径长度、路径和文件大小的字节数组。
  * @throws 文件路径或大小非法时抛出错误。
  */
@@ -108,9 +108,9 @@ export declare function createMiniappArtifactFileHeader(file: MiniappArtifactFil
 /**
  * 校验服务端 session 文件映射，并计算仍需上传的文件。
  *
- * @param localFiles 本地构建产物文件。
- * @param serverFiles 服务端签发的文件映射。
- * @param uploadedKeys 服务端已确认上传成功的 key。
+ * @param localFiles - 本地构建产物文件。
+ * @param serverFiles - 服务端签发的文件映射。
+ * @param uploadedKeys - 服务端已确认上传成功的 key。
  * @returns 完整映射、待上传文件和已确认 key。
  * @throws 服务端映射与本地产物不一致时抛出错误。
  */

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

@@ -16,7 +16,21 @@ export interface LoginResult {
 export type { MiniProgramAuthMethod } from '../../protocol/capabilities';
 /** 外部小程序可调用的授权模块。 */
 export interface MiniProgramAuthModule {
-    /** 获取短期授权码；不会向小程序暴露 token、cookie 或黑盒用户资料。 */
+    /**
+     * 获取短期授权码；不会向小程序暴露 token、cookie 或黑盒用户资料。
+     *
+     * @since 0.2.0-alpha.0
+     * @hbPlatform android
+     * @hbPlatform ios
+     * @hbPlatform ohos
+     * @hbPlatform windows
+     * @hbPlatform macos
+     * @hbClient android none
+     * @hbClient ios none
+     * @hbClient ohos none
+     * @hbClient windows none
+     * @hbClient macos none
+     */
     login(options?: LoginOptions): Promise<LoginResult>;
 }
 /** 获取短期授权码。 */

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

@@ -81,15 +81,85 @@ export interface GetLeaderboardInfoResult {
 }
 /** 外部小程序可调用的云端排行榜模块。 */
 export interface MiniProgramCloudLeaderboardModule {
-    /** 提交当前用户分数。 */
+    /**
+     * 提交当前用户分数。
+     *
+     * @since 0.5.11
+     * @hbPlatform android
+     * @hbPlatform ios
+     * @hbPlatform ohos
+     * @hbPlatform windows
+     * @hbPlatform macos
+     * @hbClient android none
+     * @hbClient ios none
+     * @hbClient ohos none
+     * @hbClient windows none
+     * @hbClient macos none
+     */
     submit(options: SubmitLeaderboardEntryPayload): Promise<SubmitLeaderboardEntryResult>;
-    /** 读取排行榜列表。 */
+    /**
+     * 读取排行榜列表。
+     *
+     * @since 0.5.11
+     * @hbPlatform android
+     * @hbPlatform ios
+     * @hbPlatform ohos
+     * @hbPlatform windows
+     * @hbPlatform macos
+     * @hbClient android none
+     * @hbClient ios none
+     * @hbClient ohos none
+     * @hbClient windows none
+     * @hbClient macos none
+     */
     getList(options?: GetLeaderboardListPayload): Promise<GetLeaderboardListResult>;
-    /** 读取当前用户记录。 */
+    /**
+     * 读取当前用户记录。
+     *
+     * @since 0.5.11
+     * @hbPlatform android
+     * @hbPlatform ios
+     * @hbPlatform ohos
+     * @hbPlatform windows
+     * @hbPlatform macos
+     * @hbClient android none
+     * @hbClient ios none
+     * @hbClient ohos none
+     * @hbClient windows none
+     * @hbClient macos none
+     */
     getCurrentUserEntry(options?: GetCurrentUserLeaderboardEntryPayload): Promise<GetCurrentUserLeaderboardEntryResult>;
-    /** 删除当前用户记录。 */
+    /**
+     * 删除当前用户记录。
+     *
+     * @since 0.5.11
+     * @hbPlatform android
+     * @hbPlatform ios
+     * @hbPlatform ohos
+     * @hbPlatform windows
+     * @hbPlatform macos
+     * @hbClient android none
+     * @hbClient ios none
+     * @hbClient ohos none
+     * @hbClient windows none
+     * @hbClient macos none
+     */
     deleteCurrentUserEntry(options?: DeleteCurrentUserLeaderboardEntryPayload): Promise<DeleteCurrentUserLeaderboardEntryResult>;
-    /** 读取排行榜基础信息。 */
+    /**
+     * 读取排行榜基础信息。
+     *
+     * @since 0.5.11
+     * @hbPlatform android
+     * @hbPlatform ios
+     * @hbPlatform ohos
+     * @hbPlatform windows
+     * @hbPlatform macos
+     * @hbClient android none
+     * @hbClient ios none
+     * @hbClient ohos none
+     * @hbClient windows none
+     * @hbClient macos none
+     */
     getInfo(options?: GetLeaderboardInfoPayload): Promise<GetLeaderboardInfoResult>;
 }
 /** 外部小程序可调用的云端能力模块。 */

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

@@ -1,5 +1,5 @@
 import type { MiniProgramRequester } from '../../core/client';
-export { DEVICE_SET_CLIPBOARD_METHOD, DEVICE_VIBRATE_METHOD, } from '../../protocol/capabilities';
+export { DEVICE_SET_CLIPBOARD_METHOD, DEVICE_VIBRATE_METHOD } from '../../protocol/capabilities';
 /** 震动强度。 */
 export type MiniProgramVibrateIntensity = 'light' | 'medium' | 'heavy';
 /** `device.vibrate` 入参。 */
@@ -21,9 +21,37 @@ export type SetClipboardResult = void;
 export type { MiniProgramDeviceMethod } from '../../protocol/capabilities';
 /** 外部小程序可调用的 device 模块。 */
 export interface MiniProgramDeviceModule {
-    /** 触发宿主震动反馈。 */
+    /**
+     * 触发宿主震动反馈。
+     *
+     * @since 0.4.4
+     * @hbPlatform android
+     * @hbPlatform ios
+     * @hbPlatform ohos
+     * @hbPlatform windows
+     * @hbPlatform macos
+     * @hbClient android none
+     * @hbClient ios none
+     * @hbClient ohos none
+     * @hbClient windows none
+     * @hbClient macos none
+     */
     vibrate(options?: VibratePayload): Promise<void>;
-    /** 写入系统文本剪贴板。 */
+    /**
+     * 写入系统文本剪贴板。
+     *
+     * @since 0.4.4
+     * @hbPlatform android
+     * @hbPlatform ios
+     * @hbPlatform ohos
+     * @hbPlatform windows
+     * @hbPlatform macos
+     * @hbClient android none
+     * @hbClient ios none
+     * @hbClient ohos none
+     * @hbClient windows none
+     * @hbClient macos none
+     */
     setClipboard(options: SetClipboardPayload): Promise<void>;
 }
 /** 触发宿主震动反馈。 */

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

@@ -1,6 +1,6 @@
 import type { MiniProgramRequester } from '../../core/client';
 import { type OpenAppPageOptions } from './app-pages';
-export { NAVIGATION_CLOSE_METHOD, NAVIGATION_OPEN_APP_PAGE_METHOD, NAVIGATION_RELOAD_METHOD, } from '../../protocol/capabilities';
+export { NAVIGATION_CLOSE_METHOD, NAVIGATION_OPEN_APP_PAGE_METHOD, NAVIGATION_RELOAD_METHOD } from '../../protocol/capabilities';
 export type { MiniProgramAppPageTarget, MiniProgramGameDetailGameType, MiniProgramGameDetailPage, OpenAppPageOptions, OpenAppPagePayload, OpenAppPageResult, OpenGameDetailAppPagePayload, OpenGameDetailAppPageOptions, OpenPostDetailAppPagePayload, OpenPostDetailAppPageOptions, OpenUserDetailAppPagePayload, OpenUserDetailAppPageOptions, } from './app-pages';
 /** `navigation.close` 不需要入参。 */
 export type ClosePayload = void;
@@ -13,11 +13,53 @@ export type ReloadResult = void;
 export type { MiniProgramNavigationMethod } from '../../protocol/capabilities';
 /** 外部小程序可调用的 navigation 模块。 */
 export interface MiniProgramNavigationModule {
-    /** 请求宿主关闭当前小程序容器。 */
+    /**
+     * 请求宿主关闭当前小程序容器。
+     *
+     * @since 0.4.4
+     * @hbPlatform android
+     * @hbPlatform ios
+     * @hbPlatform ohos
+     * @hbPlatform windows
+     * @hbPlatform macos
+     * @hbClient android none
+     * @hbClient ios none
+     * @hbClient ohos none
+     * @hbClient windows none
+     * @hbClient macos none
+     */
     close(): Promise<void>;
-    /** 请求宿主重载当前小程序容器。 */
+    /**
+     * 请求宿主重载当前小程序容器。
+     *
+     * @since 0.4.4
+     * @hbPlatform android
+     * @hbPlatform ios
+     * @hbPlatform ohos
+     * @hbPlatform windows
+     * @hbPlatform macos
+     * @hbClient android none
+     * @hbClient ios none
+     * @hbClient ohos none
+     * @hbClient windows none
+     * @hbClient macos none
+     */
     reload(): Promise<void>;
-    /** 请求宿主打开受 SDK 白名单约束的黑盒 App 页面。 */
+    /**
+     * 请求宿主打开受 SDK 白名单约束的黑盒 App 页面。
+     *
+     * @since 0.5.2
+     * @hbPlatform android
+     * @hbPlatform ios
+     * @hbPlatform ohos
+     * @hbPlatform windows
+     * @hbPlatform macos
+     * @hbClient android none
+     * @hbClient ios none
+     * @hbClient ohos none
+     * @hbClient windows none
+     * @hbClient macos none
+     */
     openAppPage(options: OpenAppPageOptions): Promise<void>;
 }
 /** 请求宿主关闭当前小程序容器。 */

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

@@ -11,7 +11,7 @@ export type MiniProgramNetworkRequestMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' |
 /**
  * SDK 侧可配置的状态校验函数。
  *
- * @param status 标准化后的 HTTP 状态码。
+ * @param status - 标准化后的 HTTP 状态码。
  * @returns 返回 `true` 时表示本次响应应视为成功。
  *
  * @remarks
@@ -60,7 +60,7 @@ export interface NetworkRequestPayload {
 /**
  * bridge / runtime 返回的标准化 HTTP 响应。
  *
- * @typeParam T 标准化响应数据的类型。
+ * @typeParam T - 标准化响应数据的类型。
  */
 export interface NetworkResponsePayload<T = unknown> {
     data: T;
@@ -71,7 +71,7 @@ export interface NetworkResponsePayload<T = unknown> {
 /**
  * SDK 对外暴露的网络响应。
  *
- * @typeParam T 标准化响应数据的类型。
+ * @typeParam T - 标准化响应数据的类型。
  */
 export interface MiniProgramNetworkResponse<T = unknown> extends NetworkResponsePayload<T> {
     /** 发起请求时的 SDK 公共配置快照。 */
@@ -83,21 +83,32 @@ export interface MiniProgramNetworkModule {
     /**
      * 发起网络请求。
      *
-     * @param config 面向业务层的网络请求配置。
+     * @param config - 面向业务层的网络请求配置。
      * @returns 标准化网络响应；HTTP 2xx 默认返回 resolve。
-     * @throws {HbMiniProgramNetworkError} 当请求已完成但 HTTP 状态不满足 `validateStatus` 时抛出。
-     * @throws {HbMiniProgramSDKError} 当 bridge、运行时或宿主能力调用失败时抛出。
+     * @throws 当请求已完成但 HTTP 状态不满足 `validateStatus` 时抛出 `HbMiniProgramNetworkError`。
+     * @throws 当 bridge、运行时或宿主能力调用失败时抛出 `HbMiniProgramSDKError`。
+     * @since 0.2.0-alpha.0
+     * @hbPlatform android
+     * @hbPlatform ios
+     * @hbPlatform ohos
+     * @hbPlatform windows
+     * @hbPlatform macos
+     * @hbClient android none
+     * @hbClient ios none
+     * @hbClient ohos none
+     * @hbClient windows none
+     * @hbClient macos none
      */
     request<T = unknown>(config: MiniProgramNetworkRequestConfig): Promise<MiniProgramNetworkResponse<T>>;
 }
 /**
  * 发起网络请求并返回标准化响应。
  *
- * @param requester 底层 bridge 请求能力。
- * @param config 面向业务层的网络请求配置。
+ * @param requester - 底层 bridge 请求能力。
+ * @param config - 面向业务层的网络请求配置。
  * @returns 标准化网络响应。HTTP 2xx 默认返回 resolve。
- * @throws {HbMiniProgramNetworkError} 当请求已完成但 HTTP 状态不满足 `validateStatus` 时抛出。
- * @throws {HbMiniProgramSDKError} 当 bridge、运行时或宿主能力调用失败时抛出。
+ * @throws {@link HbMiniProgramNetworkError} 当请求已完成但 HTTP 状态不满足 `validateStatus` 时抛出。
+ * @throws {@link HbMiniProgramSDKError} 当 bridge、运行时或宿主能力调用失败时抛出。
  *
  * @remarks
  * `validateStatus` 仅在 SDK 侧执行，不会跨 bridge 传输函数值。
@@ -115,7 +126,7 @@ export declare function request<T = unknown>(requester: MiniProgramRequester, co
 /**
  * 创建 network 模块。
  *
- * @param requester 底层 bridge 请求能力。
+ * @param requester - 底层 bridge 请求能力。
  * @returns 面向业务层的网络模块对象。
  */
 export declare function createNetworkModule(requester: MiniProgramRequester): MiniProgramNetworkModule;

package/types/modules/share/copy-link.d.ts

@@ -8,9 +8,9 @@ export type CopyLinkResult = string;
 /**
  * 复制当前小程序的通用分享链接。
  *
- * @param requester 底层 bridge 请求能力。
- * @param options 分享扩展数据；不传时复制默认首页链接。
+ * @param requester - 底层 bridge 请求能力。
+ * @param options - 分享扩展数据；不传时复制默认首页链接。
  * @returns 已写入系统剪贴板的完整分享链接。
- * @throws {HbMiniProgramSDKError} 当参数、bridge、父容器或剪贴板能力调用失败时抛出。
+ * @throws {@link HbMiniProgramSDKError} 当参数、bridge、父容器或剪贴板能力调用失败时抛出。
  */
 export declare function copyLink(requester: MiniProgramRequester, options?: MiniProgramCopyLinkOptions): Promise<CopyLinkResult>;

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

@@ -10,19 +10,75 @@ export * from './types';
 export type { MiniProgramShareMethod } from '../../protocol/capabilities';
 /** 外部小程序可调用的分享模块。 */
 export interface MiniProgramShareModule {
-    /** 复制当前小程序的通用分享链接，并返回该链接。 */
+    /**
+     * 复制当前小程序的通用分享链接，并返回该链接。
+     *
+     * @since 0.7.4-alpha.5
+     * @hbPlatform android
+     * @hbPlatform ios
+     * @hbPlatform ohos
+     * @hbPlatform windows
+     * @hbPlatform macos
+     * @hbClient android none
+     * @hbClient ios none
+     * @hbClient ohos none
+     * @hbClient windows none
+     * @hbClient macos none
+     */
     copyLink(options?: MiniProgramCopyLinkOptions): Promise<CopyLinkResult>;
-    /** 同步获取小程序启动时携带的分享扩展数据；没有有效数据时返回 `undefined`。 */
+    /**
+     * 同步获取小程序启动时携带的分享扩展数据；没有有效数据时返回 `undefined`。
+     *
+     * @since 0.7.4-alpha.5
+     * @hbPlatform android
+     * @hbPlatform ios
+     * @hbPlatform ohos
+     * @hbPlatform windows
+     * @hbPlatform macos
+     * @hbClient android none
+     * @hbClient ios none
+     * @hbClient ohos none
+     * @hbClient windows none
+     * @hbClient macos none
+     */
     getExtra(): MiniProgramShareExtraValue | undefined;
-    /** 展示基础分享面板。 */
+    /**
+     * 展示基础分享面板。
+     *
+     * @since 0.2.0-alpha.0
+     * @hbPlatform android
+     * @hbPlatform ios
+     * @hbPlatform ohos
+     * @hbPlatform windows
+     * @hbPlatform macos
+     * @hbClient android none
+     * @hbClient ios none
+     * @hbClient ohos none
+     * @hbClient windows none
+     * @hbClient macos none
+     */
     showShareMenu(options: ShowShareMenuPayload): Promise<ShowShareMenuResult>;
-    /** 截图并唤起分享。 */
+    /**
+     * 截图并唤起分享。
+     *
+     * @since 0.2.0-alpha.0
+     * @hbPlatform android
+     * @hbPlatform ios
+     * @hbPlatform ohos
+     * @hbPlatform windows
+     * @hbPlatform macos
+     * @hbClient android none
+     * @hbClient ios none
+     * @hbClient ohos none
+     * @hbClient windows none
+     * @hbClient macos none
+     */
     screenshot(options?: MiniProgramScreenshotOptions): Promise<ScreenshotResult>;
 }
 /**
  * 创建分享模块。
  *
- * @param requester 底层 bridge 请求能力。
+ * @param requester - 底层 bridge 请求能力。
  * @returns 面向业务层的分享模块对象。
  */
 export declare function createShareModule(requester: MiniProgramRequester, launchHref?: string): MiniProgramShareModule;

package/types/modules/share/screenshot.d.ts

@@ -8,9 +8,9 @@ export type ScreenshotResult = unknown;
 /**
  * 截图并唤起分享。
  *
- * @param requester 底层 bridge 请求能力。
- * @param options 截图区域、延迟与保存相册等配置。
+ * @param requester - 底层 bridge 请求能力。
+ * @param options - 截图区域、延迟与保存相册等配置。
  * @returns 由宿主客户端协议决定的结果。
- * @throws {HbMiniProgramSDKError} 当 bridge、父容器或宿主能力调用失败时抛出。
+ * @throws {@link HbMiniProgramSDKError} 当 bridge、父容器或宿主能力调用失败时抛出。
  */
 export declare function screenshot(requester: MiniProgramRequester, options?: MiniProgramScreenshotOptions): Promise<ScreenshotResult>;

package/types/modules/share/show-share-menu.d.ts

@@ -8,9 +8,9 @@ export type ShowShareMenuResult = unknown;
 /**
  * 展示基础分享面板。
  *
- * @param requester 底层 bridge 请求能力。
- * @param options 基础分享参数。
+ * @param requester - 底层 bridge 请求能力。
+ * @param options - 基础分享参数。
  * @returns 由宿主客户端协议决定的结果。
- * @throws {HbMiniProgramSDKError} 当 bridge、父容器或宿主能力调用失败时抛出。
+ * @throws {@link HbMiniProgramSDKError} 当 bridge、父容器或宿主能力调用失败时抛出。
  */
 export declare function showShareMenu(requester: MiniProgramRequester, options: ShowShareMenuPayload): Promise<ShowShareMenuResult>;