@heybox/hb-sdk 0.4.7 → 0.5.0

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

@@ -25,3 +25,288 @@ export interface MiniProgramUserInfoResult {
     /** 当前用户公开基础资料；未登录时为 `null`。 */
     userInfo: MiniProgramUserInfo | null;
 }
+/** 当前用户作用域的登录态包装。 */
+export type UserScopedResult<T> = {
+    /** 当前访问小程序的用户已登录黑盒账号。 */
+    isLogin: true;
+    /** 当前用户作用域数据。 */
+    data: T;
+} | {
+    /** 当前访问小程序的用户未登录黑盒账号。 */
+    isLogin: false;
+    /** 未登录时固定为 `null`。 */
+    data: null;
+};
+/** 当前用户等级展示信息。 */
+export interface CurrentUserLevelInfo {
+    level?: string;
+    level_name?: string;
+    exp?: string;
+    next_exp?: string;
+    icon?: string;
+}
+/** 当前用户徽章展示信息。 */
+export interface CurrentUserMedal {
+    id?: string;
+    name?: string;
+    desc?: string;
+    icon?: string;
+    image?: string;
+    is_wearing?: boolean;
+}
+/** 当前用户头像装扮信息。 */
+export interface CurrentUserAvatarDecoration {
+    id?: string;
+    name?: string;
+    image?: string;
+    frame_url?: string;
+    is_using?: boolean;
+}
+/** 当前用户头像配置。 */
+export interface CurrentUserAvatarConfig {
+    avatar?: string;
+    frame_url?: string;
+    pendant_url?: string;
+}
+/** 当前用户社区资料摘要。 */
+export interface CurrentUserBbsInfo {
+    uid?: string;
+    nickname?: string;
+    avatar?: string;
+    level?: string;
+}
+/** 当前用户公开/展示详情。 */
+export interface CurrentUserDetail {
+    heybox_id: string;
+    nickname: string;
+    avatar: string;
+    sex?: string;
+    signature?: string;
+    ip_location?: string;
+    friends_count?: string;
+    level_info?: CurrentUserLevelInfo;
+    medals?: CurrentUserMedal[];
+    avatar_decoration?: CurrentUserAvatarDecoration;
+    avatar_config?: CurrentUserAvatarConfig;
+    bbs_info?: CurrentUserBbsInfo;
+}
+/** 当前用户敏感资料/编辑详情。 */
+export interface CurrentUserProfile {
+    heybox_id: string;
+    nickname?: string;
+    avatar?: string;
+    gender?: string;
+    birthday?: string;
+    email?: string;
+    education?: string;
+    career?: string;
+    signature?: string;
+}
+/** 第一版支持的平台账号类型。 */
+export type PlatformAccountType = 'steam' | 'epic' | 'xbox' | 'psn' | 'switch' | 'pc_hardware' | 'mobile';
+/** 平台账号轻量展示统计项。 */
+export interface PlatformStatItem {
+    key?: string;
+    name?: string;
+    desc?: string;
+    value?: string;
+    num?: string;
+    icon?: string;
+    img?: string;
+    color?: string;
+}
+/** 平台账号通用基础资料。 */
+export interface BasePlatformAccountInfo {
+    nickname?: string;
+    avatar?: string;
+    background_url?: string;
+    stats?: PlatformStatItem[];
+}
+/** Steam 平台账号详情。 */
+export interface SteamPlatformAccountInfo extends BasePlatformAccountInfo {
+    steamid: string;
+    short_id?: string;
+    level?: string;
+    city?: string;
+    province?: string;
+    country?: string;
+    country_code?: string;
+    country_flag?: string;
+    avatar_frame?: string;
+    head_image?: string;
+    head_video?: string;
+    update_time?: string;
+    account_year?: string;
+    individuality_signature?: string;
+    level_icon?: string;
+    total_badge_count?: string;
+    total_dlcs_count?: string;
+    total_game_count?: string;
+    total_game_price?: string;
+    total_player_time?: string;
+    friend_code?: string;
+    friend_code_show?: boolean;
+    inventory_open?: boolean;
+    personal_information_open?: boolean;
+    has_history?: boolean;
+}
+/** Steam 游戏库排序方式。 */
+export type SteamGameListSort = 'weeks' | 'all' | 'achieved';
+/** Steam 游戏库请求参数。 */
+export interface GetSteamGameListOptions {
+    /** 指定当前用户绑定的 Steam ID；不传时由宿主使用默认主账号。 */
+    steamId?: string;
+    /** 分页数量，默认 20，最大 100。 */
+    limit?: number;
+    /** 分页偏移量，默认 0。 */
+    offset?: number;
+    /** 排序方式，默认 `weeks`。 */
+    sort?: SteamGameListSort;
+    /** 搜索关键词。 */
+    q?: string;
+    /** 是否包含当前用户隐藏的游戏，默认 `false`。 */
+    includeHidden?: boolean;
+}
+/** `user.getSteamGameList` 请求参数。 */
+export type GetSteamGameListPayload = GetSteamGameListOptions | undefined;
+/** Steam 游戏价格信息。 */
+export interface SteamGamePrice {
+    current?: string;
+    initial?: string;
+    discount?: number;
+    lowestPrice?: number;
+    deadlineDate?: string;
+    deadlineTimestamp?: number;
+}
+/** 当前用户 Steam 游戏库条目。 */
+export interface SteamGameListItem {
+    appid: number;
+    steamAppid: number;
+    name: string;
+    image?: string;
+    icon?: string;
+    background?: string;
+    verticalImage?: string;
+    playtimeForever?: number;
+    playtime2Weeks?: number;
+    playtimePercent?: number;
+    achievedCount?: number;
+    achievementCount?: number;
+    isCleared?: boolean;
+    score?: string;
+    isFree?: boolean;
+    notOwned?: boolean;
+    hidden?: boolean;
+    onlinePlayer?: string;
+    tags?: string[];
+    genres?: string[];
+    price?: SteamGamePrice;
+}
+/** 当前用户 Steam 游戏库分页数据。 */
+export interface SteamGameListData {
+    gameList: SteamGameListItem[];
+    total?: number;
+    hasMore: boolean;
+    nextOffset: number;
+    isMe?: boolean;
+}
+/** `user.getSteamGameList` 返回当前用户 Steam 游戏库。 */
+export type GetSteamGameListResult = {
+    isLogin: false;
+    isBound: false;
+    data: null;
+} | {
+    isLogin: true;
+    isBound: false;
+    data: null;
+} | {
+    isLogin: true;
+    isBound: true;
+    data: SteamGameListData;
+};
+/** Epic 平台账号详情。 */
+export interface EpicPlatformAccountInfo extends BasePlatformAccountInfo {
+    xuid?: string;
+    head_color?: string;
+    desc?: string;
+}
+/** Xbox 平台账号详情。 */
+export interface XboxPlatformAccountInfo extends BasePlatformAccountInfo {
+    xuid?: string;
+    desc?: string;
+}
+/** PSN 平台账号详情。 */
+export interface PsnPlatformAccountInfo extends BasePlatformAccountInfo {
+    name?: string;
+    level?: string;
+    description?: string;
+    is_open?: boolean;
+}
+/** Switch 平台账号详情。 */
+export interface SwitchPlatformAccountInfo extends BasePlatformAccountInfo {
+    heybox_id?: string;
+    friend_code?: string;
+    friends_total?: string;
+    games_total?: string;
+    server_name?: string;
+    type?: string;
+    desc?: string;
+}
+/** PC 硬件账号详情。 */
+export interface PcHardwareAccountInfo {
+    cpu?: string;
+    gpu?: string;
+    board?: string;
+    perf_level?: string;
+}
+/** 移动设备平台账号详情。 */
+export interface MobilePlatformAccountInfo {
+    current_device?: {
+        id?: string;
+        name?: string;
+        desc?: string;
+        model?: string;
+        img_url?: string;
+        update_time?: string;
+        stats?: PlatformStatItem[];
+    };
+}
+/** 平台类型到平台账号详情的映射。 */
+export interface PlatformAccountInfoMap {
+    steam: SteamPlatformAccountInfo;
+    epic: EpicPlatformAccountInfo;
+    xbox: XboxPlatformAccountInfo;
+    psn: PsnPlatformAccountInfo;
+    switch: SwitchPlatformAccountInfo;
+    pc_hardware: PcHardwareAccountInfo;
+    mobile: MobilePlatformAccountInfo;
+}
+/** 单个平台账号详情返回结构。 */
+export type PlatformAccountResult<T extends PlatformAccountType> = {
+    isLogin: true;
+    platform: T;
+    is_bound: true;
+    is_hidden: boolean;
+    account_info: PlatformAccountInfoMap[T];
+} | {
+    isLogin: true;
+    platform: T;
+    is_bound: false;
+    is_hidden: boolean;
+    account_info: null;
+} | {
+    isLogin: false;
+    platform: T;
+    is_bound: false;
+    is_hidden: false;
+    account_info: null;
+};
+/** 平台账号绑定/隐藏状态概览。 */
+export interface PlatformAccountOverview {
+    platforms: Array<{
+        platform: PlatformAccountType;
+        is_bound: boolean;
+        is_hidden: boolean;
+    }>;
+    display_order: PlatformAccountType[];
+}

package/types/protocol/capabilities.d.ts

@@ -5,7 +5,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 { HideLoadingPayload, HideLoadingResult, ShowLoadingPayload, ShowLoadingResult, ShowToastPayload, ShowToastResult } from '../modules/ui';
-import type { GetUserInfoPayload, GetUserInfoResult } from '../modules/user';
+import type { GetCurrentUserDetailPayload, GetCurrentUserDetailResult, GetCurrentUserProfilePayload, GetCurrentUserProfileResult, GetPlatformAccountInfoPayload, GetPlatformAccountInfoResult, GetPlatformAccountOverviewPayload, GetPlatformAccountOverviewResult, GetSteamGameListPayload, GetSteamGameListResult, GetUserInfoPayload, GetUserInfoResult } from '../modules/user';
 import type { GetWindowInfoPayload, GetWindowInfoResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult } from '../modules/viewport';
 /**
  * 登录授权能力方法名。
@@ -21,6 +21,16 @@ export declare const AUTH_LOGIN_METHOD: "auth.login";
  * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
  */
 export declare const USER_GET_INFO_METHOD: "user.getInfo";
+/** 当前用户展示详情能力方法名。 */
+export declare const USER_GET_CURRENT_USER_DETAIL_METHOD: "user.getCurrentUserDetail";
+/** 当前用户敏感资料详情能力方法名。 */
+export declare const USER_GET_CURRENT_USER_PROFILE_METHOD: "user.getCurrentUserProfile";
+/** 当前用户平台账号概览能力方法名。 */
+export declare const USER_GET_PLATFORM_ACCOUNT_OVERVIEW_METHOD: "user.getPlatformAccountOverview";
+/** 当前用户指定平台账号详情能力方法名。 */
+export declare const USER_GET_PLATFORM_ACCOUNT_INFO_METHOD: "user.getPlatformAccountInfo";
+/** 当前用户 Steam 游戏库能力方法名。 */
+export declare const USER_GET_STEAM_GAME_LIST_METHOD: "user.getSteamGameList";
 /**
  * 展示分享面板能力方法名。
  *
@@ -87,7 +97,7 @@ export declare const NAVIGATION_RELOAD_METHOD: "navigation.reload";
 /** 授权模块开放的方法名。 */
 export type MiniProgramAuthMethod = typeof AUTH_LOGIN_METHOD;
 /** 用户模块开放的方法名。 */
-export type MiniProgramUserMethod = typeof USER_GET_INFO_METHOD;
+export type MiniProgramUserMethod = typeof USER_GET_INFO_METHOD | typeof USER_GET_CURRENT_USER_DETAIL_METHOD | typeof USER_GET_CURRENT_USER_PROFILE_METHOD | typeof USER_GET_PLATFORM_ACCOUNT_OVERVIEW_METHOD | typeof USER_GET_PLATFORM_ACCOUNT_INFO_METHOD | typeof USER_GET_STEAM_GAME_LIST_METHOD;
 /** 分享模块开放的方法名。 */
 export type MiniProgramShareMethod = typeof SHARE_SHOW_SHARE_MENU_METHOD | typeof SHARE_SCREENSHOT_METHOD;
 /** Viewport 模块开放的方法名。 */
@@ -145,6 +155,36 @@ export declare const MINI_PROGRAM_PROTOCOL_CAPABILITIES: readonly [{
     readonly capability: "user.getInfo";
     readonly permission: "user.getInfo";
     readonly risk: "medium";
+}, {
+    readonly method: "user.getCurrentUserDetail";
+    readonly module: "user";
+    readonly capability: "user.getCurrentUserDetail";
+    readonly permission: "user.currentUserDetail";
+    readonly risk: "high";
+}, {
+    readonly method: "user.getCurrentUserProfile";
+    readonly module: "user";
+    readonly capability: "user.getCurrentUserProfile";
+    readonly permission: "user.currentUserProfile";
+    readonly risk: "high";
+}, {
+    readonly method: "user.getPlatformAccountOverview";
+    readonly module: "user";
+    readonly capability: "user.getPlatformAccountOverview";
+    readonly permission: "user.platformAccount.overview";
+    readonly risk: "medium";
+}, {
+    readonly method: "user.getPlatformAccountInfo";
+    readonly module: "user";
+    readonly capability: "user.getPlatformAccountInfo";
+    readonly permission: "user.platformAccount.info";
+    readonly risk: "high";
+}, {
+    readonly method: "user.getSteamGameList";
+    readonly module: "user";
+    readonly capability: "user.getSteamGameList";
+    readonly permission: "user.steamGameList";
+    readonly risk: "high";
 }, {
     readonly method: "share.showShareMenu";
     readonly module: "share";
@@ -234,6 +274,11 @@ export declare const MINI_PROGRAM_PROTOCOL_CAPABILITIES: readonly [{
 export interface MiniProgramCapabilityPayloadMap {
     [AUTH_LOGIN_METHOD]: LoginPayload;
     [USER_GET_INFO_METHOD]: GetUserInfoPayload;
+    [USER_GET_CURRENT_USER_DETAIL_METHOD]: GetCurrentUserDetailPayload;
+    [USER_GET_CURRENT_USER_PROFILE_METHOD]: GetCurrentUserProfilePayload;
+    [USER_GET_PLATFORM_ACCOUNT_OVERVIEW_METHOD]: GetPlatformAccountOverviewPayload;
+    [USER_GET_PLATFORM_ACCOUNT_INFO_METHOD]: GetPlatformAccountInfoPayload;
+    [USER_GET_STEAM_GAME_LIST_METHOD]: GetSteamGameListPayload;
     [SHARE_SHOW_SHARE_MENU_METHOD]: ShowShareMenuPayload;
     [SHARE_SCREENSHOT_METHOD]: ScreenshotPayload;
     [VIEWPORT_GET_WINDOW_INFO_METHOD]: GetWindowInfoPayload;
@@ -253,6 +298,11 @@ export interface MiniProgramCapabilityPayloadMap {
 export interface MiniProgramCapabilityResultMap {
     [AUTH_LOGIN_METHOD]: LoginResult;
     [USER_GET_INFO_METHOD]: GetUserInfoResult;
+    [USER_GET_CURRENT_USER_DETAIL_METHOD]: GetCurrentUserDetailResult;
+    [USER_GET_CURRENT_USER_PROFILE_METHOD]: GetCurrentUserProfileResult;
+    [USER_GET_PLATFORM_ACCOUNT_OVERVIEW_METHOD]: GetPlatformAccountOverviewResult;
+    [USER_GET_PLATFORM_ACCOUNT_INFO_METHOD]: GetPlatformAccountInfoResult;
+    [USER_GET_STEAM_GAME_LIST_METHOD]: GetSteamGameListResult;
     [SHARE_SHOW_SHARE_MENU_METHOD]: ShowShareMenuResult;
     [SHARE_SCREENSHOT_METHOD]: ScreenshotResult;
     [VIEWPORT_GET_WINDOW_INFO_METHOD]: GetWindowInfoResult;

package/types/protocol.d.ts

@@ -1,10 +1,10 @@
 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, 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 { 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_CURRENT_USER_DETAIL_METHOD, USER_GET_CURRENT_USER_PROFILE_METHOD, USER_GET_INFO_METHOD, USER_GET_PLATFORM_ACCOUNT_INFO_METHOD, USER_GET_PLATFORM_ACCOUNT_OVERVIEW_METHOD, USER_GET_STEAM_GAME_LIST_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 { GetCurrentUserDetailPayload, GetCurrentUserDetailResult, GetCurrentUserProfilePayload, GetCurrentUserProfileResult, GetPlatformAccountInfoPayload, GetPlatformAccountInfoResult, GetPlatformAccountOverviewPayload, GetPlatformAccountOverviewResult, GetSteamGameListOptions, GetSteamGameListPayload, GetSteamGameListResult, GetUserInfoPayload, GetUserInfoResult, MiniProgramUserInfo, MiniProgramUserInfoResult, SteamGameListData, SteamGameListItem, SteamGameListSort, SteamGamePrice, } from './modules/user';
 export type { ScreenshotPayload, ScreenshotResult } from './modules/share/screenshot';
 export type { ShowShareMenuPayload, ShowShareMenuResult } from './modules/share/show-share-menu';
 export type { MiniProgramScreenshotOptions, MiniProgramScreenshotRect, MiniProgramShareChannel, MiniProgramShowShareMenuOptions, } from './modules/share';