@heybox/hb-sdk 0.7.5-alpha.0 → 0.8.0-alpha.2

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/files/index.d.ts

@@ -0,0 +1,5 @@
+import type { MiniProgramRequester } from '../../core/client';
+import type { FilesModule } from './types';
+export type { CreateOptions, DirectoryHandle, FileHandle, FileMode, FileStat, FileSystem, FileSystemEntity, FilesModule, ListOptions, PathRoot, PickDirectoryOptions, PickFilesOptions, RemoveOptions, SaveFileOptions, } from './types';
+/** 创建当前 SDK session 的 files 模块。 */
+export declare function createFilesModule(requester: MiniProgramRequester): FilesModule;

package/types/modules/files/registry.d.ts

@@ -0,0 +1,35 @@
+import type { MiniProgramRequester } from '../../core/client';
+import type { MiniProgramDirectoryDescriptor, MiniProgramDirectoryRef, MiniProgramFileDescriptor, MiniProgramFileMode, MiniProgramFileRef, MiniProgramFileSystemEntityDescriptor } from '@heybox/hb-sdk-protocol';
+import type { DirectoryHandle, FileHandle, FileSystem, FileSystemEntity } from './types';
+interface FileHandleState {
+    ref: MiniProgramFileRef;
+    mode: MiniProgramFileMode;
+}
+interface DirectoryHandleState {
+    ref: MiniProgramDirectoryRef;
+    mode: MiniProgramFileMode;
+}
+/** 校验并返回平台无关的 `/` 分隔逻辑相对路径。 */
+export declare function normalizeRelativePath(value: unknown): string;
+export declare class MiniProgramFileHandleRegistry {
+    private readonly requester;
+    private readonly fileStates;
+    private readonly directoryStates;
+    private readonly pathRootStates;
+    private sandboxRoot?;
+    constructor(requester: MiniProgramRequester);
+    getSandbox(): FileSystem;
+    createFile(descriptor: MiniProgramFileDescriptor): FileHandle;
+    createDirectFile(descriptor: MiniProgramFileDescriptor): FileHandle;
+    createDirectory(descriptor: MiniProgramDirectoryDescriptor): DirectoryHandle;
+    createDirectDirectory(descriptor: MiniProgramDirectoryDescriptor): DirectoryHandle;
+    createEntity(descriptor: MiniProgramFileSystemEntityDescriptor): FileSystemEntity;
+    requireFile(handle: unknown): FileHandleState;
+    requireDirectory(handle: unknown): DirectoryHandleState;
+    private definePathRootMethods;
+    private assertFileDescriptor;
+    private assertDirectoryDescriptor;
+}
+export declare function getFileHandleRegistry(requester: MiniProgramRequester): MiniProgramFileHandleRegistry;
+export declare function isMiniProgramFileSystemValue(value: unknown): value is FileSystem | FileSystemEntity;
+export {};

package/types/modules/files/types.d.ts

@@ -0,0 +1,159 @@
+/** File/Directory 访问模式。 */
+export type FileMode = 'read' | 'readwrite';
+export interface PickFilesOptions {
+    mode?: FileMode;
+    accept?: string[];
+    multiple?: boolean;
+}
+export interface PickDirectoryOptions {
+    mode?: FileMode;
+}
+export interface SaveFileOptions {
+    suggestedName: string;
+}
+export interface CreateOptions {
+    recursive?: boolean;
+    exclusive?: boolean;
+}
+export interface RemoveOptions {
+    /** 是否递归删除目录内容，默认 `false`。 */
+    recursive?: boolean;
+}
+export interface ListOptions {
+    limit?: number;
+}
+/** 可同步派生 lazy File/Directory proxy 的逻辑根。 */
+export interface PathRoot {
+    /**
+     * 按规范相对路径派生文件代理。
+     *
+     * @param relativePath - 使用 `/` 分隔的规范相对路径。
+     * @returns 延迟访问对应文件的代理。
+     * @since 0.8.0-alpha.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
+     */
+    file(relativePath: string): FileHandle;
+    /**
+     * 按规范相对路径派生目录代理。
+     *
+     * @param relativePath - 使用 `/` 分隔的规范相对路径。
+     * @returns 延迟访问对应目录的代理。
+     * @since 0.8.0-alpha.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
+     */
+    directory(relativePath: string): DirectoryHandle;
+}
+/** Mini-program 私有 sandbox 的逻辑根。 */
+export interface FileSystem extends PathRoot {
+}
+/** 当前 SDK session 中的文件代理。 */
+export interface FileHandle {
+    readonly kind: 'file';
+    readonly name: string;
+    readonly mode: FileMode;
+    create(options?: CreateOptions): Promise<FileHandle>;
+    /** 删除 sandbox 文件；外部授权文件不允许删除。 */
+    remove(): Promise<void>;
+    exists(): Promise<boolean>;
+    readText(): Promise<string>;
+    writeText(content: string): Promise<void>;
+    readBytes(): Promise<Uint8Array>;
+    writeBytes(content: Uint8Array): Promise<void>;
+    stat(): Promise<FileStat>;
+}
+/** 当前 SDK session 中的目录代理。 */
+export interface DirectoryHandle extends PathRoot {
+    readonly kind: 'directory';
+    readonly name: string;
+    readonly mode: FileMode;
+    create(options?: CreateOptions): Promise<DirectoryHandle>;
+    /** 删除 sandbox 目录；非空目录需要显式设置 `recursive`，外部授权目录不允许删除。 */
+    remove(options?: RemoveOptions): Promise<void>;
+    exists(): Promise<boolean>;
+    list(options?: ListOptions): Promise<FileSystemEntity[]>;
+}
+export type FileSystemEntity = FileHandle | DirectoryHandle;
+export interface FileStat {
+    kind: 'file';
+    size: number;
+    /** Unix epoch milliseconds。 */
+    modifiedAt?: number;
+    /** Unix epoch milliseconds。 */
+    createdAt?: number;
+}
+/** Mini-program 对外文件能力。 */
+export interface FilesModule {
+    readonly sandbox: FileSystem;
+    /**
+     * 让用户选择一个或多个文件并返回当前 session 的授权代理。
+     *
+     * @param options - 访问模式、扩展名筛选与多选设置。
+     * @returns 用户选择的文件代理。
+     * @since 0.8.0-alpha.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
+     */
+    pickFiles(options?: PickFilesOptions): Promise<FileHandle[]>;
+    /**
+     * 让用户选择目录并返回当前 session 的授权代理。
+     *
+     * @param options - 目录访问模式。
+     * @returns 用户选择的目录代理。
+     * @since 0.8.0-alpha.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
+     */
+    pickDirectory(options?: PickDirectoryOptions): Promise<DirectoryHandle>;
+    /**
+     * 让用户选择一个精确的文件保存目标。
+     *
+     * @param options - 建议文件名。
+     * @returns 具备读写权限的目标文件代理。
+     * @since 0.8.0-alpha.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
+     */
+    saveFile(options: SaveFileOptions): Promise<FileHandle>;
+}

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

@@ -1,5 +1,6 @@
-import type { MiniProgramRequester } from '../../core/client';
-export { NETWORK_REQUEST_METHOD } from '../../protocol/capabilities';
+import type { MiniProgramOperationRequester, MiniProgramRequester } from '../../core/client';
+import type { DirectoryHandle, FileHandle } from '../files';
+export { NETWORK_DOWNLOAD_METHOD, NETWORK_REQUEST_METHOD } from '../../protocol/capabilities';
 export { createNetworkRequestFailureLog, formatNetworkRequestFailureMessage, logNetworkRequestFailure, previewNetworkData, sanitizeNetworkHeaders, sanitizeNetworkRequestUrl, } from './observability';
 export { describeHostNetworkFailure, isMultipartContentType, isUnsupportedMultipartNetworkRequest, looksLikeMultipartBody, NETWORK_REQUEST_MULTIPART_UNSUPPORTED_MESSAGE, readNetworkContentType, } from './request-shape';
 /** `network.request` 请求头。 */
@@ -11,7 +12,7 @@ export type MiniProgramNetworkRequestMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' |
 /**
  * SDK 侧可配置的状态校验函数。
  *
- * @param status 标准化后的 HTTP 状态码。
+ * @param status - 标准化后的 HTTP 状态码。
  * @returns 返回 `true` 时表示本次响应应视为成功。
  *
  * @remarks
@@ -42,6 +43,32 @@ export interface MiniProgramNetworkRequestConfig {
     /** SDK 侧状态校验；不会跨 bridge 传输函数值。 */
     validateStatus?: MiniProgramNetworkValidateStatus;
 }
+/** 流式下载的 request-scoped 进度。 */
+export interface DownloadProgress {
+    loaded: number;
+    total?: number;
+    lengthComputable: boolean;
+}
+export interface DownloadBaseOptions {
+    url: string;
+    params?: MiniProgramNetworkParams;
+    headers?: MiniProgramNetworkHeaders;
+    timeout?: number;
+    withCredentials?: boolean;
+    maxBytes?: number;
+    signal?: AbortSignal;
+    onProgress?: (progress: DownloadProgress) => void;
+}
+/** File target 原子替换，Directory target 创建或替换子文件。 */
+export type DownloadOptions = DownloadBaseOptions & ({
+    to: FileHandle;
+    suggestedName?: never;
+    overwrite?: never;
+} | {
+    to: DirectoryHandle;
+    suggestedName?: string;
+    overwrite?: boolean;
+});
 /**
  * bridge / runtime 可消费的网络请求 payload。
  *
@@ -60,7 +87,7 @@ export interface NetworkRequestPayload {
 /**
  * bridge / runtime 返回的标准化 HTTP 响应。
  *
- * @typeParam T 标准化响应数据的类型。
+ * @typeParam T - 标准化响应数据的类型。
  */
 export interface NetworkResponsePayload<T = unknown> {
     data: T;
@@ -71,7 +98,7 @@ export interface NetworkResponsePayload<T = unknown> {
 /**
  * SDK 对外暴露的网络响应。
  *
- * @typeParam T 标准化响应数据的类型。
+ * @typeParam T - 标准化响应数据的类型。
  */
 export interface MiniProgramNetworkResponse<T = unknown> extends NetworkResponsePayload<T> {
     /** 发起请求时的 SDK 公共配置快照。 */
@@ -83,21 +110,50 @@ 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>>;
+    /**
+     * 将 GET 响应流式写入受控 File/Directory target。
+     *
+     * @param options - 下载地址、写入目标、取消信号与进度回调。
+     * @returns 原子提交完成后的目标文件代理。
+     * @since 0.8.0-alpha.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
+     */
+    download(options: DownloadOptions): Promise<FileHandle>;
 }
 /**
  * 发起网络请求并返回标准化响应。
  *
- * @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 传输函数值。
@@ -112,10 +168,12 @@ export interface MiniProgramNetworkModule {
  * ```
  */
 export declare function request<T = unknown>(requester: MiniProgramRequester, config: MiniProgramNetworkRequestConfig): Promise<MiniProgramNetworkResponse<T>>;
+/** 发起不使用 bridge 固定总时长 timer 的流式下载。 */
+export declare function download(requester: MiniProgramOperationRequester, options: DownloadOptions): Promise<FileHandle>;
 /**
  * 创建 network 模块。
  *
- * @param requester 底层 bridge 请求能力。
+ * @param requester - 底层 bridge 请求能力。
  * @returns 面向业务层的网络模块对象。
  */
-export declare function createNetworkModule(requester: MiniProgramRequester): MiniProgramNetworkModule;
+export declare function createNetworkModule(requester: MiniProgramOperationRequester): 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>;