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

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>;

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

@@ -8,7 +8,7 @@ export interface GetStoragePayload {
 /**
  * `storage.getStorage` 返回值。
  *
- * @typeParam T 反序列化后的业务数据类型。
+ * @typeParam T - 反序列化后的业务数据类型。
  */
 export interface GetStorageResult<T = unknown> {
     /** key 对应的数据；不存在时为 undefined。 */
@@ -24,33 +24,61 @@ export interface SetStoragePayload {
 export type { MiniProgramStorageMethod } from '../../protocol/capabilities';
 /** 外部小程序可调用的 storage 模块。 */
 export interface MiniProgramStorageModule {
-    /** 获取小程序隔离 storage。 */
+    /**
+     * 获取小程序隔离 storage。
+     *
+     * @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
+     */
     getStorage<T = unknown>(options: GetStoragePayload): Promise<GetStorageResult<T>>;
-    /** 写入小程序隔离 storage。 */
+    /**
+     * 写入小程序隔离 storage。
+     *
+     * @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
+     */
     setStorage(options: SetStoragePayload): Promise<void>;
 }
 /**
  * 获取小程序隔离 storage。
  *
- * @param requester 底层 bridge 请求能力。
- * @param options 读取的 storage key。
+ * @param requester - 底层 bridge 请求能力。
+ * @param options - 读取的 storage key。
  * @returns 对应 key 的标准化读取结果。
- * @throws {HbMiniProgramSDKError} 当 bridge、父容器或宿主能力调用失败时抛出。
+ * @throws {@link HbMiniProgramSDKError} 当 bridge、父容器或宿主能力调用失败时抛出。
  */
 export declare function getStorage<T = unknown>(requester: MiniProgramRequester, options: GetStoragePayload): Promise<GetStorageResult<T>>;
 /**
  * 写入小程序隔离 storage。
  *
- * @param requester 底层 bridge 请求能力。
- * @param options 要写入的 storage key 与数据。
+ * @param requester - 底层 bridge 请求能力。
+ * @param options - 要写入的 storage key 与数据。
  * @returns 当写入完成后 resolve。
- * @throws {HbMiniProgramSDKError} 当 bridge、父容器或宿主能力调用失败时抛出。
+ * @throws {@link HbMiniProgramSDKError} 当 bridge、父容器或宿主能力调用失败时抛出。
  */
 export declare function setStorage(requester: MiniProgramRequester, options: SetStoragePayload): Promise<void>;
 /**
  * 创建 storage 模块。
  *
- * @param requester 底层 bridge 请求能力。
+ * @param requester - 底层 bridge 请求能力。
  * @returns 面向业务层的 storage 模块对象。
  */
 export declare function createStorageModule(requester: MiniProgramRequester): MiniProgramStorageModule;

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

@@ -1,5 +1,5 @@
 import type { MiniProgramRequester } from '../../core/client';
-export { UI_HIDE_LOADING_METHOD, UI_SHOW_LOADING_METHOD, UI_SHOW_TOAST_METHOD, } from '../../protocol/capabilities';
+export { UI_HIDE_LOADING_METHOD, UI_SHOW_LOADING_METHOD, UI_SHOW_TOAST_METHOD } from '../../protocol/capabilities';
 /** Toast 展示状态。 */
 export type MiniProgramToastStatus = 'success' | 'error';
 /** `ui.showToast` 入参。 */
@@ -25,11 +25,53 @@ export type HideLoadingResult = void;
 export type { MiniProgramUiMethod } from '../../protocol/capabilities';
 /** 外部小程序可调用的 UI 模块。 */
 export interface MiniProgramUiModule {
-    /** 展示 toast。 */
+    /**
+     * 展示 toast。
+     *
+     * @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
+     */
     showToast(options: ShowToastPayload): Promise<void>;
-    /** 展示全局 loading。 */
+    /**
+     * 展示全局 loading。
+     *
+     * @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
+     */
     showLoading(options?: ShowLoadingPayload): Promise<void>;
-    /** 隐藏全局 loading。 */
+    /**
+     * 隐藏全局 loading。
+     *
+     * @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
+     */
     hideLoading(): Promise<void>;
 }
 /** 展示 toast。 */

package/types/modules/user/get-info.d.ts

@@ -18,6 +18,6 @@ export type GetUserInfoResult = MiniProgramUserInfoResult;
  * `app_user_id`，并隐式授予 `identity` 与 `profile` 后返回昵称与头像，不展示授权 UI。未登录时返回
  * `{ isHeyboxAppLoggedIn: false, authorization: null, userInfo: null }`。
  *
- * @throws {HbMiniProgramSDKError} 当 SDK 调用失败时抛出。
+ * @throws {@link HbMiniProgramSDKError} 当 SDK 调用失败时抛出。
  */
 export declare function getInfo(requester: MiniProgramRequester): Promise<GetUserInfoResult>;

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

@@ -8,12 +8,54 @@ export * from './steam-game-list';
 export * from './types';
 /** 外部小程序可调用的用户模块。 */
 export interface MiniProgramUserModule {
-    /** 获取当前黑盒 APP 登录态、授权状态和已获准披露的资料。 */
+    /**
+     * 获取当前黑盒 APP 登录态、授权状态和已获准披露的资料。
+     *
+     * @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
+     */
     getInfo(): Promise<GetUserInfoResult>;
-    /** 撤销当前用户授予本小程序的授权；必须由可信用户操作触发。 */
+    /**
+     * 撤销当前用户授予本小程序的授权；必须由可信用户操作触发。
+     *
+     * @since 0.7.0-alpha.1
+     * @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
+     */
     revokeAuthorization(): Promise<RevokeAuthorizationResult>;
-    /** 获取当前用户的 Steam 游戏库。 */
+    /**
+     * 获取当前用户的 Steam 游戏库。
+     *
+     * @since 0.5.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
+     */
     getSteamGameList(options?: GetSteamGameListOptions): Promise<GetSteamGameListResult>;
 }
 export declare function createUserModule(requester: MiniProgramRequester): MiniProgramUserModule;
-export { USER_GET_INFO_METHOD, USER_GET_STEAM_GAME_LIST_METHOD, USER_REVOKE_AUTHORIZATION_METHOD, };
+export { USER_GET_INFO_METHOD, USER_GET_STEAM_GAME_LIST_METHOD, USER_REVOKE_AUTHORIZATION_METHOD };

package/types/modules/user/steam-game-list.d.ts

@@ -64,8 +64,8 @@ export type GetSteamGameListResult = {
 /**
  * 获取当前用户 Steam 游戏库。
  *
- * @param requester 底层 bridge 请求能力。
- * @param options 查询与分页参数。
+ * @param requester - 底层 bridge 请求能力。
+ * @param options - 查询与分页参数。
  * @returns 当前用户 Steam 游戏库；未登录或未绑定 Steam 时返回状态对象。
  */
 export declare function getSteamGameList(requester: MiniProgramRequester, options?: GetSteamGameListOptions): Promise<GetSteamGameListResult>;