@heybox/hb-sdk 0.7.2-alpha.0 → 0.7.3-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/README.md +10 -10
- package/dist/cli-chunks/{build-DbQt0LIs.cjs → build-CIZIWLmV.cjs} +2 -2
- package/dist/cli-chunks/{context-Cmrhge3Y.cjs → context-DdKKaf1o.cjs} +1 -1
- package/dist/cli-chunks/{create-5ZLxb2p_.cjs → create-C5CW72BF.cjs} +1 -1
- package/dist/cli-chunks/{dev-CWSJ0YIw.cjs → dev-CH2yODBH.cjs} +5 -5
- package/dist/cli-chunks/{doctor-CpFYiqK9.cjs → doctor-SHwm6xSx.cjs} +1 -1
- package/dist/cli-chunks/{index-DomfJMuO.cjs → index-DIwi_FPa.cjs} +1 -1
- package/dist/cli-chunks/{index-BV8DdyEP.cjs → index-DiGjTruv.cjs} +14 -14
- package/dist/cli-chunks/{login-DhD2o29N.cjs → login-BrtCvOEN.cjs} +2 -2
- package/dist/cli-chunks/{project-vite-8IkVMyPu.cjs → project-vite-BoMy-fAP.cjs} +1 -1
- package/dist/cli-chunks/{remote-BZ6rfyuZ.cjs → remote-BDj3TcU7.cjs} +4 -4
- package/dist/cli-chunks/{session-DnqyIY87.cjs → session-DyEpQQ67.cjs} +1 -1
- package/dist/cli.cjs +1 -1
- package/dist/devtools/mock-host/main.js +78 -60
- package/dist/index.cjs.js +3 -11
- package/dist/index.esm.js +3 -11
- package/dist/protocol.cjs.js +0 -10
- package/dist/protocol.esm.js +1 -10
- package/dist/vite.cjs.js +1 -1
- package/dist/vite.esm.js +1 -1
- package/package.json +2 -2
- package/skill/SKILL.md +4 -4
- package/skill/references/api-protocol.md +2 -5
- package/skill/references/api-root.md +9 -18
- package/skill/references/cli.md +2 -2
- package/skill/references/examples.md +5 -11
- package/skill/references/recipes.md +16 -33
- package/skill/references/safety-boundaries.md +2 -2
- package/skill/scripts/sync-references.mjs +6 -12
- package/skill/scripts/validate-skill.mjs +7 -1
- package/skill/skill.json +4 -4
- package/types/index.d.ts +1 -1
- package/types/modules/user/get-info.d.ts +2 -2
- package/types/modules/user/index.d.ts +1 -5
- package/types/modules/user/types.d.ts +5 -3
- package/types/protocol/capabilities.d.ts +2 -12
- package/types/protocol.d.ts +2 -2
- package/types/modules/user/get-local-identity.d.ts +0 -9
|
@@ -1,10 +1,8 @@
|
|
|
1
1
|
import type { MiniProgramRequester } from '../../core/client';
|
|
2
2
|
import { USER_GET_INFO_METHOD, type GetUserInfoResult } from './get-info';
|
|
3
|
-
import { USER_GET_LOCAL_IDENTITY_METHOD, type GetLocalIdentityResult } from './get-local-identity';
|
|
4
3
|
import { USER_REVOKE_AUTHORIZATION_METHOD, type RevokeAuthorizationResult } from './revoke-authorization';
|
|
5
4
|
import { USER_GET_STEAM_GAME_LIST_METHOD, type GetSteamGameListOptions, type GetSteamGameListResult } from './steam-game-list';
|
|
6
5
|
export * from './get-info';
|
|
7
|
-
export * from './get-local-identity';
|
|
8
6
|
export * from './revoke-authorization';
|
|
9
7
|
export * from './steam-game-list';
|
|
10
8
|
export * from './types';
|
|
@@ -12,12 +10,10 @@ export * from './types';
|
|
|
12
10
|
export interface MiniProgramUserModule {
|
|
13
11
|
/** 获取当前黑盒 APP 登录态、授权状态和已获准披露的资料。 */
|
|
14
12
|
getInfo(): Promise<GetUserInfoResult>;
|
|
15
|
-
/** 获取当前用户在本小程序内稳定且隔离的身份。 */
|
|
16
|
-
getLocalIdentity(): Promise<GetLocalIdentityResult>;
|
|
17
13
|
/** 撤销当前用户授予本小程序的授权;必须由可信用户操作触发。 */
|
|
18
14
|
revokeAuthorization(): Promise<RevokeAuthorizationResult>;
|
|
19
15
|
/** 获取当前用户的 Steam 游戏库。 */
|
|
20
16
|
getSteamGameList(options?: GetSteamGameListOptions): Promise<GetSteamGameListResult>;
|
|
21
17
|
}
|
|
22
18
|
export declare function createUserModule(requester: MiniProgramRequester): MiniProgramUserModule;
|
|
23
|
-
export { USER_GET_INFO_METHOD,
|
|
19
|
+
export { USER_GET_INFO_METHOD, USER_GET_STEAM_GAME_LIST_METHOD, USER_REVOKE_AUTHORIZATION_METHOD, };
|
|
@@ -9,8 +9,9 @@ export interface UserInfoAuthorization {
|
|
|
9
9
|
* 已获准向当前小程序披露的用户资料。
|
|
10
10
|
*
|
|
11
11
|
* @remarks
|
|
12
|
-
*
|
|
13
|
-
*
|
|
12
|
+
* 未开通网络权限且当前黑盒 APP 用户已登录时,Runtime 会静默建立或读取隔离身份,
|
|
13
|
+
* `user.getInfo()` 随即返回该对象。撤销授权后旧身份失效,调用方应停止使用并清理
|
|
14
|
+
* 本地缓存;再次调用 `user.getInfo()` 会静默建立新的隔离身份。
|
|
14
15
|
*/
|
|
15
16
|
export interface AuthorizedUserInfo {
|
|
16
17
|
/**
|
|
@@ -34,7 +35,8 @@ export interface AuthorizedUserInfo {
|
|
|
34
35
|
*
|
|
35
36
|
* @remarks
|
|
36
37
|
* 未登录时 `isHeyboxAppLoggedIn` 为 `false`,授权状态和用户资料均为 `null`。
|
|
37
|
-
*
|
|
38
|
+
* 当前 Heybox Runtime 在无网络模式且已登录时会静默建立身份并返回 `userInfo`;
|
|
39
|
+
* Host 在已登录但身份暂不可用时仍可返回 `null`,调用方必须进行空值判断。
|
|
38
40
|
*/
|
|
39
41
|
export type MiniProgramUserInfoResult = {
|
|
40
42
|
isHeyboxAppLoggedIn: false;
|
|
@@ -6,7 +6,7 @@ import type { NetworkRequestPayload, NetworkResponsePayload } from '../modules/n
|
|
|
6
6
|
import type { ScreenshotPayload, ScreenshotResult, ShowShareMenuPayload, ShowShareMenuResult } from '../modules/share';
|
|
7
7
|
import type { GetStoragePayload, GetStorageResult, SetStoragePayload } from '../modules/storage';
|
|
8
8
|
import type { HideLoadingPayload, HideLoadingResult, ShowLoadingPayload, ShowLoadingResult, ShowToastPayload, ShowToastResult } from '../modules/ui';
|
|
9
|
-
import type {
|
|
9
|
+
import type { GetUserInfoPayload, GetUserInfoResult, RevokeAuthorizationPayload, RevokeAuthorizationResult, GetSteamGameListPayload, GetSteamGameListResult } from '../modules/user';
|
|
10
10
|
import type { GetWindowInfoPayload, GetWindowInfoResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult } from '../modules/viewport';
|
|
11
11
|
/**
|
|
12
12
|
* 登录授权能力方法名。
|
|
@@ -17,8 +17,6 @@ import type { GetWindowInfoPayload, GetWindowInfoResult, SetNavigationBarStylePa
|
|
|
17
17
|
export declare const AUTH_LOGIN_METHOD: "auth.login";
|
|
18
18
|
/** 读取当前登录态、授权状态和已获准披露资料的 bridge method 标识。 */
|
|
19
19
|
export declare const USER_GET_INFO_METHOD: "user.getInfo";
|
|
20
|
-
/** 读取当前用户小程序隔离身份的 bridge method 标识。 */
|
|
21
|
-
export declare const USER_GET_LOCAL_IDENTITY_METHOD: "user.getLocalIdentity";
|
|
22
20
|
/** 撤销当前用户授予本小程序授权的 bridge method 标识。 */
|
|
23
21
|
export declare const USER_REVOKE_AUTHORIZATION_METHOD: "user.revokeAuthorization";
|
|
24
22
|
/** 读取当前已登录用户 Steam 游戏库的 bridge method 标识。 */
|
|
@@ -101,7 +99,7 @@ export declare const CLOUD_LEADERBOARD_GET_INFO_METHOD: "cloud.leaderboard.getIn
|
|
|
101
99
|
/** 授权模块开放的方法名。 */
|
|
102
100
|
export type MiniProgramAuthMethod = typeof AUTH_LOGIN_METHOD;
|
|
103
101
|
/** 用户模块开放的方法名。 */
|
|
104
|
-
export type MiniProgramUserMethod = typeof USER_GET_INFO_METHOD | typeof
|
|
102
|
+
export type MiniProgramUserMethod = typeof USER_GET_INFO_METHOD | typeof USER_REVOKE_AUTHORIZATION_METHOD | typeof USER_GET_STEAM_GAME_LIST_METHOD;
|
|
105
103
|
/** 分享模块开放的方法名。 */
|
|
106
104
|
export type MiniProgramShareMethod = typeof SHARE_SHOW_SHARE_MENU_METHOD | typeof SHARE_SCREENSHOT_METHOD;
|
|
107
105
|
/** Viewport 模块开放的方法名。 */
|
|
@@ -161,12 +159,6 @@ export declare const MINI_PROGRAM_PROTOCOL_CAPABILITIES: readonly [{
|
|
|
161
159
|
readonly capability: "user.getInfo";
|
|
162
160
|
readonly permission: "user.getInfo";
|
|
163
161
|
readonly risk: "medium";
|
|
164
|
-
}, {
|
|
165
|
-
readonly method: "user.getLocalIdentity";
|
|
166
|
-
readonly module: "user";
|
|
167
|
-
readonly capability: "user.getLocalIdentity";
|
|
168
|
-
readonly permission: "user.getLocalIdentity";
|
|
169
|
-
readonly risk: "medium";
|
|
170
162
|
}, {
|
|
171
163
|
readonly method: "user.revokeAuthorization";
|
|
172
164
|
readonly module: "user";
|
|
@@ -304,7 +296,6 @@ export declare const MINI_PROGRAM_PROTOCOL_CAPABILITIES: readonly [{
|
|
|
304
296
|
export interface MiniProgramCapabilityPayloadMap {
|
|
305
297
|
[AUTH_LOGIN_METHOD]: LoginPayload;
|
|
306
298
|
[USER_GET_INFO_METHOD]: GetUserInfoPayload;
|
|
307
|
-
[USER_GET_LOCAL_IDENTITY_METHOD]: GetLocalIdentityPayload;
|
|
308
299
|
[USER_REVOKE_AUTHORIZATION_METHOD]: RevokeAuthorizationPayload;
|
|
309
300
|
[USER_GET_STEAM_GAME_LIST_METHOD]: GetSteamGameListPayload;
|
|
310
301
|
[SHARE_SHOW_SHARE_MENU_METHOD]: ShowShareMenuPayload;
|
|
@@ -332,7 +323,6 @@ export interface MiniProgramCapabilityPayloadMap {
|
|
|
332
323
|
export interface MiniProgramCapabilityResultMap {
|
|
333
324
|
[AUTH_LOGIN_METHOD]: LoginResult;
|
|
334
325
|
[USER_GET_INFO_METHOD]: GetUserInfoResult;
|
|
335
|
-
[USER_GET_LOCAL_IDENTITY_METHOD]: GetLocalIdentityResult;
|
|
336
326
|
[USER_REVOKE_AUTHORIZATION_METHOD]: RevokeAuthorizationResult;
|
|
337
327
|
[USER_GET_STEAM_GAME_LIST_METHOD]: GetSteamGameListResult;
|
|
338
328
|
[SHARE_SHOW_SHARE_MENU_METHOD]: ShowShareMenuResult;
|
package/types/protocol.d.ts
CHANGED
|
@@ -5,11 +5,11 @@ export { isManagedMiniProgramRuntimePermissionKey, parseMiniProgramRuntimePermis
|
|
|
5
5
|
export { isOfficialMiniProgramNetworkUrl, isProtectedMiniProgramNetworkPath, MINI_PROGRAM_NETWORK_PROTECTED_PATHS, normalizeMiniProgramNetworkPathname, } from './protocol/network-policy';
|
|
6
6
|
export type { MiniProgramRuntimePermissionEntry, MiniProgramRuntimePermissionStatus, MiniProgramRuntimePermissionsSnapshot, ParsedMiniProgramRuntimePermissions, } from './protocol/runtime-permissions';
|
|
7
7
|
export type { MiniProgramBridgeError, MiniProgramBridgeMessage, MiniProgramBridgeMessageType, MiniProgramEventHandler, MiniProgramEventName, MiniProgramEventPayloadMap, RuntimeLocationProbePayload, SDKCSPBlockedResourceType, SDKCSPViolationPayload, SDKHandshakePayload, SDKLocationReportPayload, SDKLocationReportTrigger, } from './protocol/types';
|
|
8
|
-
export { AUTH_LOGIN_METHOD, CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_INFO_METHOD, CLOUD_LEADERBOARD_GET_LIST_METHOD, CLOUD_LEADERBOARD_SUBMIT_METHOD, DEVICE_SET_CLIPBOARD_METHOD, DEVICE_VIBRATE_METHOD, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NAVIGATION_CLOSE_METHOD, NAVIGATION_OPEN_APP_PAGE_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,
|
|
8
|
+
export { AUTH_LOGIN_METHOD, CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_INFO_METHOD, CLOUD_LEADERBOARD_GET_LIST_METHOD, CLOUD_LEADERBOARD_SUBMIT_METHOD, DEVICE_SET_CLIPBOARD_METHOD, DEVICE_VIBRATE_METHOD, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NAVIGATION_CLOSE_METHOD, NAVIGATION_OPEN_APP_PAGE_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_REVOKE_AUTHORIZATION_METHOD, USER_GET_STEAM_GAME_LIST_METHOD, USER_GET_INFO_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD, } from './protocol/capabilities';
|
|
9
9
|
export type { MiniProgramDeviceMethod, MiniProgramAuthMethod, MiniProgramBridgeMethod, MiniProgramCapabilityDefinition, MiniProgramCapabilityModule, MiniProgramCapabilityPayload, MiniProgramCapabilityPayloadMap, MiniProgramCapabilityResult, MiniProgramCapabilityResultMap, MiniProgramCapabilityRisk, MiniProgramCloudMethod, MiniProgramNavigationMethod, MiniProgramNetworkMethod, MiniProgramShareMethod, MiniProgramStorageMethod, MiniProgramUiMethod, MiniProgramUserMethod, MiniProgramViewportMethod, } from './protocol/capabilities';
|
|
10
10
|
export type { LoginOptions, LoginPayload, LoginResult, LoginScope } from './modules/auth';
|
|
11
11
|
export type { DeleteCurrentUserLeaderboardEntryPayload, DeleteCurrentUserLeaderboardEntryResult, GetCurrentUserLeaderboardEntryPayload, GetCurrentUserLeaderboardEntryResult, GetLeaderboardInfoPayload, GetLeaderboardInfoResult, GetLeaderboardListPayload, GetLeaderboardListResult, LeaderboardEntry, LeaderboardOrder, SubmitLeaderboardEntryPayload, SubmitLeaderboardEntryResult, } from './modules/cloud';
|
|
12
|
-
export type { AuthorizedUserInfo,
|
|
12
|
+
export type { AuthorizedUserInfo, GetUserInfoPayload, GetUserInfoResult, RevokeAuthorizationPayload, RevokeAuthorizationResult, GetSteamGameListOptions, GetSteamGameListPayload, GetSteamGameListResult, MiniProgramUserInfoResult, UserInfoAuthorization, UserInfoAuthorizationStatus, SteamGameListData, SteamGameListItem, SteamGamePrice, SteamGameListSort, } from './modules/user';
|
|
13
13
|
export type { ScreenshotPayload, ScreenshotResult } from './modules/share/screenshot';
|
|
14
14
|
export type { ShowShareMenuPayload, ShowShareMenuResult } from './modules/share/show-share-menu';
|
|
15
15
|
export type { MiniProgramScreenshotOptions, MiniProgramScreenshotRect, MiniProgramShareChannel, MiniProgramSharePostOptions, MiniProgramShowShareMenuOptions, } from './modules/share';
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import type { MiniProgramRequester } from '../../core/client';
|
|
2
|
-
export { USER_GET_LOCAL_IDENTITY_METHOD } from '../../protocol/capabilities';
|
|
3
|
-
/** `user.getLocalIdentity` 不需要入参。 */
|
|
4
|
-
export type GetLocalIdentityPayload = void;
|
|
5
|
-
/** 当前用户在本小程序内稳定且隔离的身份。 */
|
|
6
|
-
export interface GetLocalIdentityResult {
|
|
7
|
-
appUserId: string;
|
|
8
|
-
}
|
|
9
|
-
export declare function getLocalIdentity(requester: MiniProgramRequester): Promise<GetLocalIdentityResult>;
|