@heybox/hb-sdk-protocol 0.7.4-alpha.1

package/src/capabilities.ts

@@ -0,0 +1,259 @@
+import type {
+  ClosePayload,
+  CloseResult,
+  DeleteCurrentUserLeaderboardEntryPayload,
+  DeleteCurrentUserLeaderboardEntryResult,
+  GetCurrentUserLeaderboardEntryPayload,
+  GetCurrentUserLeaderboardEntryResult,
+  GetLeaderboardInfoPayload,
+  GetLeaderboardInfoResult,
+  GetLeaderboardListPayload,
+  GetLeaderboardListResult,
+  GetStoragePayload,
+  GetStorageResult,
+  GetSteamGameListPayload,
+  GetSteamGameListResult,
+  GetUserInfoPayload,
+  GetUserInfoResult,
+  GetWindowInfoPayload,
+  GetWindowInfoResult,
+  HideLoadingPayload,
+  HideLoadingResult,
+  LoginPayload,
+  LoginResult,
+  NetworkRequestPayload,
+  NetworkResponsePayload,
+  OpenAppPagePayload,
+  OpenAppPageResult,
+  ReloadPayload,
+  ReloadResult,
+  ScreenshotPayload,
+  ScreenshotResult,
+  SetClipboardPayload,
+  SetClipboardResult,
+  SetNavigationBarStylePayload,
+  SetNavigationBarStyleResult,
+  SetStoragePayload,
+  ShowLoadingPayload,
+  ShowLoadingResult,
+  ShowShareMenuPayload,
+  ShowShareMenuResult,
+  ShowToastPayload,
+  ShowToastResult,
+  SubmitLeaderboardEntryPayload,
+  SubmitLeaderboardEntryResult,
+  VibratePayload,
+  VibrateResult,
+} from './payloads';
+
+export const AUTH_LOGIN_METHOD = 'auth.login' as const;
+export const USER_GET_INFO_METHOD = 'user.getInfo' as const;
+export const USER_REVOKE_AUTHORIZATION_METHOD = 'user.revokeAuthorization' as const;
+export const USER_GET_STEAM_GAME_LIST_METHOD = 'user.getSteamGameList' as const;
+export const SHARE_SHOW_SHARE_MENU_METHOD = 'share.showShareMenu' as const;
+export const SHARE_SCREENSHOT_METHOD = 'share.screenshot' as const;
+export const VIEWPORT_GET_WINDOW_INFO_METHOD = 'viewport.getWindowInfo' as const;
+export const VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD = 'viewport.setNavigationBarStyle' as const;
+export const STORAGE_GET_STORAGE_METHOD = 'storage.getStorage' as const;
+export const STORAGE_SET_STORAGE_METHOD = 'storage.setStorage' as const;
+export const NETWORK_REQUEST_METHOD = 'network.request' as const;
+export const UI_SHOW_TOAST_METHOD = 'ui.showToast' as const;
+export const UI_SHOW_LOADING_METHOD = 'ui.showLoading' as const;
+export const UI_HIDE_LOADING_METHOD = 'ui.hideLoading' as const;
+export const DEVICE_VIBRATE_METHOD = 'device.vibrate' as const;
+export const DEVICE_SET_CLIPBOARD_METHOD = 'device.setClipboard' as const;
+export const NAVIGATION_CLOSE_METHOD = 'navigation.close' as const;
+export const NAVIGATION_RELOAD_METHOD = 'navigation.reload' as const;
+export const NAVIGATION_OPEN_APP_PAGE_METHOD = 'navigation.openAppPage' as const;
+export const CLOUD_LEADERBOARD_SUBMIT_METHOD = 'cloud.leaderboard.submit' as const;
+export const CLOUD_LEADERBOARD_GET_LIST_METHOD = 'cloud.leaderboard.getList' as const;
+export const CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.getCurrentUserEntry' as const;
+export const CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.deleteCurrentUserEntry' as const;
+export const CLOUD_LEADERBOARD_GET_INFO_METHOD = 'cloud.leaderboard.getInfo' as const;
+
+export type MiniProgramAuthMethod = typeof AUTH_LOGIN_METHOD;
+export type MiniProgramUserMethod = typeof USER_GET_INFO_METHOD | typeof USER_REVOKE_AUTHORIZATION_METHOD | typeof USER_GET_STEAM_GAME_LIST_METHOD;
+export type MiniProgramShareMethod = typeof SHARE_SHOW_SHARE_MENU_METHOD | typeof SHARE_SCREENSHOT_METHOD;
+export type MiniProgramViewportMethod = typeof VIEWPORT_GET_WINDOW_INFO_METHOD | typeof VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD;
+export type MiniProgramStorageMethod = typeof STORAGE_GET_STORAGE_METHOD | typeof STORAGE_SET_STORAGE_METHOD;
+export type MiniProgramNetworkMethod = typeof NETWORK_REQUEST_METHOD;
+export type MiniProgramUiMethod = typeof UI_SHOW_TOAST_METHOD | typeof UI_SHOW_LOADING_METHOD | typeof UI_HIDE_LOADING_METHOD;
+export type MiniProgramDeviceMethod = typeof DEVICE_VIBRATE_METHOD | typeof DEVICE_SET_CLIPBOARD_METHOD;
+export type MiniProgramNavigationMethod = typeof NAVIGATION_CLOSE_METHOD | typeof NAVIGATION_RELOAD_METHOD | typeof NAVIGATION_OPEN_APP_PAGE_METHOD;
+export type MiniProgramCloudMethod =
+  | typeof CLOUD_LEADERBOARD_SUBMIT_METHOD
+  | typeof CLOUD_LEADERBOARD_GET_LIST_METHOD
+  | typeof CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD
+  | typeof CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD
+  | typeof CLOUD_LEADERBOARD_GET_INFO_METHOD;
+export type MiniProgramBridgeMethod =
+  | MiniProgramAuthMethod
+  | MiniProgramUserMethod
+  | MiniProgramShareMethod
+  | MiniProgramViewportMethod
+  | MiniProgramStorageMethod
+  | MiniProgramNetworkMethod
+  | MiniProgramUiMethod
+  | MiniProgramDeviceMethod
+  | MiniProgramNavigationMethod
+  | MiniProgramCloudMethod;
+export type MiniProgramCapabilityModule = 'auth' | 'user' | 'share' | 'viewport' | 'storage' | 'network' | 'ui' | 'device' | 'navigation' | 'cloud';
+export type MiniProgramCapabilityRisk = 'low' | 'medium' | 'high';
+
+export interface MiniProgramCapabilityDefinition {
+  method: MiniProgramBridgeMethod;
+  module: MiniProgramCapabilityModule;
+  capability: MiniProgramBridgeMethod;
+  permission: string;
+  risk: MiniProgramCapabilityRisk;
+}
+
+export const MINI_PROGRAM_PROTOCOL_CAPABILITIES = [
+  { method: AUTH_LOGIN_METHOD, module: 'auth', capability: AUTH_LOGIN_METHOD, permission: 'auth.login', risk: 'medium' },
+  { method: USER_GET_INFO_METHOD, module: 'user', capability: USER_GET_INFO_METHOD, permission: 'user.getInfo', risk: 'medium' },
+  {
+    method: USER_REVOKE_AUTHORIZATION_METHOD,
+    module: 'user',
+    capability: USER_REVOKE_AUTHORIZATION_METHOD,
+    permission: 'user.revokeAuthorization',
+    risk: 'high',
+  },
+  {
+    method: USER_GET_STEAM_GAME_LIST_METHOD,
+    module: 'user',
+    capability: USER_GET_STEAM_GAME_LIST_METHOD,
+    permission: 'user.platformAccount.steam',
+    risk: 'high',
+  },
+  { method: SHARE_SHOW_SHARE_MENU_METHOD, module: 'share', capability: SHARE_SHOW_SHARE_MENU_METHOD, permission: 'share.basic', risk: 'low' },
+  { method: SHARE_SCREENSHOT_METHOD, module: 'share', capability: SHARE_SCREENSHOT_METHOD, permission: 'share.screenshot', risk: 'medium' },
+  {
+    method: VIEWPORT_GET_WINDOW_INFO_METHOD,
+    module: 'viewport',
+    capability: VIEWPORT_GET_WINDOW_INFO_METHOD,
+    permission: 'viewport.windowInfo',
+    risk: 'low',
+  },
+  {
+    method: VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD,
+    module: 'viewport',
+    capability: VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD,
+    permission: 'viewport.navigationBarStyle',
+    risk: 'low',
+  },
+  { method: STORAGE_GET_STORAGE_METHOD, module: 'storage', capability: STORAGE_GET_STORAGE_METHOD, permission: 'storage.read', risk: 'low' },
+  { method: STORAGE_SET_STORAGE_METHOD, module: 'storage', capability: STORAGE_SET_STORAGE_METHOD, permission: 'storage.write', risk: 'medium' },
+  { method: NETWORK_REQUEST_METHOD, module: 'network', capability: NETWORK_REQUEST_METHOD, permission: 'network.request', risk: 'high' },
+  { method: UI_SHOW_TOAST_METHOD, module: 'ui', capability: UI_SHOW_TOAST_METHOD, permission: 'ui.toast', risk: 'low' },
+  { method: UI_SHOW_LOADING_METHOD, module: 'ui', capability: UI_SHOW_LOADING_METHOD, permission: 'ui.loading', risk: 'low' },
+  { method: UI_HIDE_LOADING_METHOD, module: 'ui', capability: UI_HIDE_LOADING_METHOD, permission: 'ui.loading', risk: 'low' },
+  { method: DEVICE_VIBRATE_METHOD, module: 'device', capability: DEVICE_VIBRATE_METHOD, permission: 'device.vibrate', risk: 'low' },
+  {
+    method: DEVICE_SET_CLIPBOARD_METHOD,
+    module: 'device',
+    capability: DEVICE_SET_CLIPBOARD_METHOD,
+    permission: 'device.clipboard.write',
+    risk: 'medium',
+  },
+  { method: NAVIGATION_CLOSE_METHOD, module: 'navigation', capability: NAVIGATION_CLOSE_METHOD, permission: 'navigation.close', risk: 'medium' },
+  { method: NAVIGATION_RELOAD_METHOD, module: 'navigation', capability: NAVIGATION_RELOAD_METHOD, permission: 'navigation.reload', risk: 'medium' },
+  {
+    method: NAVIGATION_OPEN_APP_PAGE_METHOD,
+    module: 'navigation',
+    capability: NAVIGATION_OPEN_APP_PAGE_METHOD,
+    permission: 'navigation.openAppPage',
+    risk: 'medium',
+  },
+  {
+    method: CLOUD_LEADERBOARD_SUBMIT_METHOD,
+    module: 'cloud',
+    capability: CLOUD_LEADERBOARD_SUBMIT_METHOD,
+    permission: 'cloud.leaderboard.write',
+    risk: 'medium',
+  },
+  {
+    method: CLOUD_LEADERBOARD_GET_LIST_METHOD,
+    module: 'cloud',
+    capability: CLOUD_LEADERBOARD_GET_LIST_METHOD,
+    permission: 'cloud.leaderboard.read',
+    risk: 'low',
+  },
+  {
+    method: CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD,
+    module: 'cloud',
+    capability: CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD,
+    permission: 'cloud.leaderboard.currentUserEntry.read',
+    risk: 'medium',
+  },
+  {
+    method: CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD,
+    module: 'cloud',
+    capability: CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD,
+    permission: 'cloud.leaderboard.currentUserEntry.delete',
+    risk: 'medium',
+  },
+  {
+    method: CLOUD_LEADERBOARD_GET_INFO_METHOD,
+    module: 'cloud',
+    capability: CLOUD_LEADERBOARD_GET_INFO_METHOD,
+    permission: 'cloud.leaderboard.info.read',
+    risk: 'low',
+  },
+] as const satisfies readonly MiniProgramCapabilityDefinition[];
+
+export interface MiniProgramCapabilityPayloadMap {
+  [AUTH_LOGIN_METHOD]: LoginPayload;
+  [USER_GET_INFO_METHOD]: GetUserInfoPayload;
+  [USER_REVOKE_AUTHORIZATION_METHOD]: void;
+  [USER_GET_STEAM_GAME_LIST_METHOD]: GetSteamGameListPayload;
+  [SHARE_SHOW_SHARE_MENU_METHOD]: ShowShareMenuPayload;
+  [SHARE_SCREENSHOT_METHOD]: ScreenshotPayload;
+  [VIEWPORT_GET_WINDOW_INFO_METHOD]: GetWindowInfoPayload;
+  [VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD]: SetNavigationBarStylePayload;
+  [STORAGE_GET_STORAGE_METHOD]: GetStoragePayload;
+  [STORAGE_SET_STORAGE_METHOD]: SetStoragePayload;
+  [NETWORK_REQUEST_METHOD]: NetworkRequestPayload;
+  [UI_SHOW_TOAST_METHOD]: ShowToastPayload;
+  [UI_SHOW_LOADING_METHOD]: ShowLoadingPayload;
+  [UI_HIDE_LOADING_METHOD]: HideLoadingPayload;
+  [DEVICE_VIBRATE_METHOD]: VibratePayload;
+  [DEVICE_SET_CLIPBOARD_METHOD]: SetClipboardPayload;
+  [NAVIGATION_CLOSE_METHOD]: ClosePayload;
+  [NAVIGATION_RELOAD_METHOD]: ReloadPayload;
+  [NAVIGATION_OPEN_APP_PAGE_METHOD]: OpenAppPagePayload;
+  [CLOUD_LEADERBOARD_SUBMIT_METHOD]: SubmitLeaderboardEntryPayload;
+  [CLOUD_LEADERBOARD_GET_LIST_METHOD]: GetLeaderboardListPayload | undefined;
+  [CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD]: GetCurrentUserLeaderboardEntryPayload | undefined;
+  [CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD]: DeleteCurrentUserLeaderboardEntryPayload | undefined;
+  [CLOUD_LEADERBOARD_GET_INFO_METHOD]: GetLeaderboardInfoPayload | undefined;
+}
+
+export interface MiniProgramCapabilityResultMap {
+  [AUTH_LOGIN_METHOD]: LoginResult;
+  [USER_GET_INFO_METHOD]: GetUserInfoResult;
+  [USER_REVOKE_AUTHORIZATION_METHOD]: void;
+  [USER_GET_STEAM_GAME_LIST_METHOD]: GetSteamGameListResult;
+  [SHARE_SHOW_SHARE_MENU_METHOD]: ShowShareMenuResult;
+  [SHARE_SCREENSHOT_METHOD]: ScreenshotResult;
+  [VIEWPORT_GET_WINDOW_INFO_METHOD]: GetWindowInfoResult;
+  [VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD]: SetNavigationBarStyleResult;
+  [STORAGE_GET_STORAGE_METHOD]: GetStorageResult;
+  [STORAGE_SET_STORAGE_METHOD]: void;
+  [NETWORK_REQUEST_METHOD]: NetworkResponsePayload;
+  [UI_SHOW_TOAST_METHOD]: ShowToastResult;
+  [UI_SHOW_LOADING_METHOD]: ShowLoadingResult;
+  [UI_HIDE_LOADING_METHOD]: HideLoadingResult;
+  [DEVICE_VIBRATE_METHOD]: VibrateResult;
+  [DEVICE_SET_CLIPBOARD_METHOD]: SetClipboardResult;
+  [NAVIGATION_CLOSE_METHOD]: CloseResult;
+  [NAVIGATION_RELOAD_METHOD]: ReloadResult;
+  [NAVIGATION_OPEN_APP_PAGE_METHOD]: OpenAppPageResult;
+  [CLOUD_LEADERBOARD_SUBMIT_METHOD]: SubmitLeaderboardEntryResult;
+  [CLOUD_LEADERBOARD_GET_LIST_METHOD]: GetLeaderboardListResult;
+  [CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD]: GetCurrentUserLeaderboardEntryResult;
+  [CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD]: DeleteCurrentUserLeaderboardEntryResult;
+  [CLOUD_LEADERBOARD_GET_INFO_METHOD]: GetLeaderboardInfoResult;
+}
+
+export type MiniProgramCapabilityPayload<T extends MiniProgramBridgeMethod> = MiniProgramCapabilityPayloadMap[T];
+export type MiniProgramCapabilityResult<T extends MiniProgramBridgeMethod> = MiniProgramCapabilityResultMap[T];

package/src/constants.ts

@@ -0,0 +1,7 @@
+export const MINI_PROGRAM_MESSAGE_NAMESPACE = 'heybox:miniprogram' as const;
+export const MINI_PROGRAM_MESSAGE_VERSION = 2 as const;
+export const MINI_PROGRAM_BRIDGE_NONCE_PARAM = 'hb_mini_bridge_nonce' as const;
+export const SDK_HANDSHAKE_METHOD = 'sdk.handshake' as const;
+export const RUNTIME_LOCATION_PROBE_METHOD = 'runtime.location.probe' as const;
+export const SDK_LOCATION_REPORT_METHOD = 'sdk.location.report' as const;
+export const SDK_CSP_VIOLATION_METHOD = 'sdk.csp.violation' as const;

package/src/guards.ts

@@ -0,0 +1,13 @@
+import { MINI_PROGRAM_MESSAGE_NAMESPACE } from './constants';
+import type { MiniProgramBridgeMessage } from './bridge';
+
+export function isMiniProgramBridgeMessage(value: unknown): value is MiniProgramBridgeMessage {
+  if (!value || typeof value !== 'object') return false;
+  const message = value as Partial<MiniProgramBridgeMessage>;
+  return (
+    message.namespace === MINI_PROGRAM_MESSAGE_NAMESPACE &&
+    (message.version === 1 || message.version === 2) &&
+    typeof message.nonce === 'string' &&
+    typeof message.type === 'string'
+  );
+}

package/src/index.ts

@@ -0,0 +1,6 @@
+export * from './bridge';
+export * from './capabilities';
+export * from './constants';
+export * from './guards';
+export * from './payloads';
+export * from './permissions';

package/src/payloads.ts

@@ -0,0 +1,280 @@
+/** 当前用户信息与登录能力支持的完整 scope 目录。 */
+export const USER_INFO_AUTHORIZATION_SCOPES = ['identity', 'profile'] as const;
+
+/** 用户信息授权 scope。 */
+export type UserInfoAuthorizationScope = (typeof USER_INFO_AUTHORIZATION_SCOPES)[number];
+
+/** 登录请求使用与用户信息授权相同的 canonical scope。 */
+export type LoginScope = UserInfoAuthorizationScope;
+export type LoginPayload = { scopes?: LoginScope[] } | undefined;
+export interface LoginResult {
+  code: string;
+  expiresIn: number;
+  scopes: LoginScope[];
+}
+
+/** 用户资料授权状态。 */
+export type UserInfoAuthorizationStatus = 'not_required' | 'not_requested' | 'granted' | 'denied';
+
+type CanonicalUserInfoAuthorization = Record<UserInfoAuthorizationScope, UserInfoAuthorizationStatus>;
+
+/** 当前小程序对 canonical 用户信息 scope 的授权状态。 */
+export interface UserInfoAuthorization extends CanonicalUserInfoAuthorization {}
+
+/**
+ * 已获准向当前小程序披露的用户资料。
+ *
+ * @remarks
+ * 未开通网络权限且当前黑盒 APP 用户已登录时，Runtime 会隐式授予 `identity` 与
+ * `profile`，静默建立或读取隔离身份，并由 `user.getInfo()` 返回该对象。撤销授权后
+ * 旧身份失效，调用方应停止使用并清理本地缓存；再次调用 `user.getInfo()` 会静默建立
+ * 新的隔离身份。
+ */
+export interface AuthorizedUserInfo {
+  /**
+   * 当前黑盒用户在当前小程序内稳定且不可逆的关联标识。
+   *
+   * @remarks
+   * 同一用户在不同小程序中的值不同。它不是黑盒用户 ID、登录凭据或主站私有接口凭据，
+   * 只应作为当前小程序自己的业务关联键使用。示例：
+   * `au_1_x7K9mQ2pL4vN8cR3tY6wB1zD5fH`。调用方必须把完整值视为不透明字符串，
+   * 不应解析格式或依赖固定长度。
+   */
+  app_user_id: string;
+  /** `profile` 已授权时返回昵称与头像；当前 Heybox Runtime 在无网络模式下隐式授予该 scope。 */
+  profile: { nickname: string; avatar: string } | null;
+}
+
+/**
+ * 当前黑盒 APP 登录态、授权状态和已获准披露的用户资料。
+ *
+ * @remarks
+ * 未登录时 `isHeyboxAppLoggedIn` 为 `false`，授权状态和用户资料均为 `null`。
+ * 当前 Heybox Runtime 在无网络模式且已登录时会隐式授予 `identity` 与 `profile`，
+ * 静默建立身份并返回 `userInfo`；Host 在已登录但身份暂不可用时仍可返回 `null`，
+ * 调用方必须进行空值判断。
+ */
+export type MiniProgramUserInfoResult =
+  | { isHeyboxAppLoggedIn: false; authorization: null; userInfo: null }
+  | { isHeyboxAppLoggedIn: true; authorization: UserInfoAuthorization; userInfo: AuthorizedUserInfo | null };
+export type GetUserInfoPayload = void;
+export type GetUserInfoResult = MiniProgramUserInfoResult;
+export type RevokeAuthorizationPayload = void;
+export type RevokeAuthorizationResult = void;
+export type SteamGameListSort = 'weeks' | 'all' | 'achieved';
+interface GetSteamGameListRequest {
+  steamId?: string;
+  limit?: number;
+  offset?: number;
+  sort?: SteamGameListSort;
+  q?: string;
+  includeHidden?: boolean;
+}
+export type GetSteamGameListPayload = GetSteamGameListRequest | undefined;
+export type SteamGamePrice = {
+  current?: string;
+  initial?: string;
+  discount?: number;
+  lowestPrice?: number;
+  deadlineDate?: string;
+  deadlineTimestamp?: number;
+};
+export interface SteamGameListItem {
+  appid: number;
+  steamAppid: number;
+  name: string;
+  image?: string;
+  icon?: string;
+  playtimeForever?: number;
+  playtime2Weeks?: number;
+  tags?: string[];
+  price?: SteamGamePrice;
+}
+export interface SteamGameListData {
+  gameList: SteamGameListItem[];
+  total?: number;
+  hasMore: boolean;
+  nextOffset: number;
+  isMe?: boolean;
+}
+export type GetSteamGameListResult =
+  | { isLogin: false; isBound: false; data: null }
+  | { isLogin: true; isBound: false; data: null }
+  | { isLogin: true; isBound: true; data: SteamGameListData };
+
+export type MiniProgramShareChannel = 'wechatSession' | 'wechatTimeline' | 'qqFriend' | 'qzone' | 'weibo';
+export interface MiniProgramSharePostOptions {
+  topicIds?: (string | number)[];
+  topics?: string[];
+}
+export interface MiniProgramScreenshotRect {
+  left: number;
+  top: number;
+  width: number;
+  height: number;
+}
+export type ShowShareMenuPayload = {
+  title: string;
+  desc: string;
+  url?: string;
+  imageUrl?: string;
+  channel?: MiniProgramShareChannel;
+  post?: MiniProgramSharePostOptions | null;
+};
+export type ShowShareMenuResult = unknown;
+export type ScreenshotPayload =
+  | {
+      rect?: MiniProgramScreenshotRect;
+      delay?: number;
+      saveToAlbum?: boolean;
+      post?: MiniProgramSharePostOptions | null;
+    }
+  | undefined;
+export type ScreenshotResult = unknown;
+
+export interface GetStoragePayload {
+  key: string;
+}
+export interface GetStorageResult<T = unknown> {
+  data: T | undefined;
+}
+export interface SetStoragePayload {
+  key: string;
+  data: unknown;
+}
+
+export interface MiniProgramSafeArea {
+  left: number;
+  right: number;
+  top: number;
+  bottom: number;
+  width: number;
+  height: number;
+}
+export interface MiniProgramWindowInfoResult {
+  pixelRatio: number;
+  screenWidth: number;
+  screenHeight: number;
+  windowWidth: number;
+  windowHeight: number;
+  statusBarHeight: number;
+  safeArea: MiniProgramSafeArea;
+  screenTop: number;
+}
+export type GetWindowInfoPayload = void;
+export type GetWindowInfoResult = MiniProgramWindowInfoResult;
+export type MiniProgramNavigationBarForegroundStyle = 'light' | 'dark';
+export type SetNavigationBarStylePayload = { foregroundStyle: MiniProgramNavigationBarForegroundStyle };
+export type SetNavigationBarStyleResult = void;
+
+export type MiniProgramNetworkHeaders = Record<string, string>;
+export type MiniProgramNetworkParams = Record<string, unknown>;
+export type MiniProgramNetworkRequestMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS';
+export interface NetworkRequestPayload {
+  url: string;
+  method?: MiniProgramNetworkRequestMethod;
+  params?: MiniProgramNetworkParams;
+  data?: unknown;
+  headers?: MiniProgramNetworkHeaders;
+  timeout?: number;
+  withCredentials?: boolean;
+}
+export interface NetworkResponsePayload<T = unknown> {
+  data: T;
+  status: number;
+  statusText?: string;
+  headers: MiniProgramNetworkHeaders;
+}
+
+export type MiniProgramToastStatus = 'success' | 'error';
+export interface ShowToastPayload {
+  message: string;
+  status?: MiniProgramToastStatus;
+}
+export type ShowToastResult = void;
+export interface ShowLoadingPayload {
+  dismissible?: boolean;
+}
+export type ShowLoadingResult = void;
+export type HideLoadingPayload = void;
+export type HideLoadingResult = void;
+export type MiniProgramVibrateIntensity = 'light' | 'medium' | 'heavy';
+export interface VibratePayload {
+  intensity?: MiniProgramVibrateIntensity;
+  delay?: number;
+}
+export type VibrateResult = void;
+export interface SetClipboardPayload {
+  text: string;
+}
+export type SetClipboardResult = void;
+
+export type ClosePayload = void;
+export type CloseResult = void;
+export type ReloadPayload = void;
+export type ReloadResult = void;
+export type MiniProgramAppPageTarget = 'game_detail' | 'user_detail' | 'post_detail';
+export type MiniProgramGameDetailGameType = 'pc' | 'console' | 'mobile';
+export type MiniProgramGameDetailPage = 'game' | 'wiki';
+export type OpenGameDetailAppPagePayload = {
+  target: 'game_detail';
+  appId: string;
+  gameType: MiniProgramGameDetailGameType;
+  page?: MiniProgramGameDetailPage;
+  hSrc?: string;
+  skuId?: string;
+};
+export type OpenUserDetailAppPagePayload = { target: 'user_detail'; userId: string };
+export type OpenPostDetailAppPagePayload = {
+  target: 'post_detail';
+  linkId: string;
+  rootCommentId?: string;
+  commentId?: string;
+};
+export type OpenAppPagePayload = OpenGameDetailAppPagePayload | OpenUserDetailAppPagePayload | OpenPostDetailAppPagePayload;
+export type OpenAppPageResult = void;
+
+export type LeaderboardOrder = 'asc' | 'desc';
+export interface LeaderboardEntry {
+  rank: number;
+  ranked: boolean;
+  appUserId: string;
+  score: number;
+  extra: Record<string, unknown>;
+  createdAt: number;
+  updatedAt: number;
+}
+export interface SubmitLeaderboardEntryPayload {
+  key?: string;
+  score: number;
+  extra?: Record<string, unknown>;
+}
+export type SubmitLeaderboardEntryResult = LeaderboardEntry;
+export interface GetLeaderboardListPayload {
+  key?: string;
+  limit?: number;
+  cursor?: string;
+}
+export interface GetLeaderboardListResult {
+  entries: LeaderboardEntry[];
+  cursor?: string;
+  hasMore: boolean;
+}
+export interface GetCurrentUserLeaderboardEntryPayload {
+  key?: string;
+}
+export type GetCurrentUserLeaderboardEntryResult = LeaderboardEntry | undefined;
+export interface DeleteCurrentUserLeaderboardEntryPayload {
+  key?: string;
+}
+export interface DeleteCurrentUserLeaderboardEntryResult {
+  deleted: boolean;
+}
+export interface GetLeaderboardInfoPayload {
+  key?: string;
+}
+export interface GetLeaderboardInfoResult {
+  key: string;
+  order: LeaderboardOrder;
+  rankLimit: number;
+}

package/src/permissions.ts

@@ -0,0 +1,56 @@
+const MANAGED_RUNTIME_PERMISSION_KEYS = new Set(['network.request']);
+
+export function isManagedMiniProgramRuntimePermissionKey(key: string) {
+  return MANAGED_RUNTIME_PERMISSION_KEYS.has(key);
+}
+export type MiniProgramRuntimePermissionStatus = 'enabled' | 'disabled';
+export interface MiniProgramRuntimePermissionEntry {
+  key: string;
+  status: MiniProgramRuntimePermissionStatus;
+  config: Record<string, unknown>;
+}
+export interface MiniProgramRuntimePermissionsSnapshot {
+  schema_version: 1;
+  revision?: number;
+  entries: MiniProgramRuntimePermissionEntry[];
+}
+export interface ParsedMiniProgramRuntimePermissions {
+  valid: boolean;
+  permissions: Record<string, MiniProgramRuntimePermissionEntry>;
+}
+
+export function parseMiniProgramRuntimePermissions(snapshot: unknown): ParsedMiniProgramRuntimePermissions {
+  if (!isRecord(snapshot) || snapshot.schema_version !== 1 || !Array.isArray(snapshot.entries)) {
+    return { valid: false, permissions: {} };
+  }
+  if (snapshot.revision !== undefined && (typeof snapshot.revision !== 'number' || !Number.isInteger(snapshot.revision) || snapshot.revision < 0)) {
+    return { valid: false, permissions: {} };
+  }
+
+  const seenKeys = new Set<string>();
+  const permissions: Record<string, MiniProgramRuntimePermissionEntry> = {};
+  for (const rawEntry of snapshot.entries) {
+    if (!isRecord(rawEntry) || typeof rawEntry.key !== 'string' || !rawEntry.key.trim()) {
+      return { valid: false, permissions: {} };
+    }
+    const key = rawEntry.key.trim();
+    if (seenKeys.has(key) || (rawEntry.status !== 'enabled' && rawEntry.status !== 'disabled') || !isRecord(rawEntry.config)) {
+      return { valid: false, permissions: {} };
+    }
+    seenKeys.add(key);
+    if (!isManagedMiniProgramRuntimePermissionKey(key)) continue;
+    if (key === 'network.request' && typeof rawEntry.config.useOfficialDomain !== 'boolean') {
+      return { valid: false, permissions: {} };
+    }
+    permissions[key] = {
+      key,
+      status: rawEntry.status,
+      config: { useOfficialDomain: rawEntry.config.useOfficialDomain },
+    };
+  }
+  return { valid: true, permissions };
+}
+
+function isRecord(value: unknown): value is Record<string, unknown> {
+  return typeof value === 'object' && value !== null && !Array.isArray(value);
+}