@heybox/hb-sdk 0.8.2-alpha.2 → 0.8.2-alpha.6

package/skill/references/api-protocol.md

@@ -1,317 +0,0 @@
-# Protocol API reference
-
-> Generated by `node packages/hb-sdk/scripts/skill/sync-references.mjs` from the public hb-sdk source/docs. Do not edit by hand; update sources or this generator instead.
-
-## Sources
-
-- packages/hb-sdk/src/protocol.ts
-- apps/docs/hb-sdk/reference/index.md
-
-## Contents
-
-- [Host/runtime-only warning](#hostruntime-only-warning)
-- [Public protocol entrypoint](#public-protocol-entrypoint)
-- [Generated reference index](#generated-reference-index)
-## Host/runtime-only warning
-
-New parent-container Host, `@heybox/hb-sdk-runtime`, bridge-server, and protocol-contract maintenance must import wire contracts directly from `@heybox/hb-sdk-protocol`. Use `@heybox/hb-sdk/protocol` only for explicitly retained existing compatibility consumers. Iframe mini-program business code must use root SDK APIs and must not construct bridge envelopes, nonce handling, or raw `postMessage` flows.
-
-## Public protocol entrypoint
-
-```ts
-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,
-  DIRECTORY_CREATE_METHOD,
-  DIRECTORY_EXISTS_METHOD,
-  DIRECTORY_LIST_METHOD,
-  DIRECTORY_REMOVE_METHOD,
-  DEVICE_SET_CLIPBOARD_METHOD,
-  DEVICE_VIBRATE_METHOD,
-  FILES_PICK_DIRECTORY_METHOD,
-  FILES_PICK_FILES_METHOD,
-  FILES_SAVE_FILE_METHOD,
-  FILE_CREATE_METHOD,
-  FILE_EXISTS_METHOD,
-  FILE_READ_BYTES_METHOD,
-  FILE_READ_TEXT_METHOD,
-  FILE_REMOVE_METHOD,
-  FILE_STAT_METHOD,
-  FILE_WRITE_BYTES_METHOD,
-  FILE_WRITE_TEXT_METHOD,
-  MINI_PROGRAM_BRIDGE_NONCE_PARAM,
-  MINI_PROGRAM_MESSAGE_NAMESPACE,
-  MINI_PROGRAM_MESSAGE_VERSION,
-  MINI_PROGRAM_OPERATION_PROGRESS_METHOD,
-  MINI_PROGRAM_PROTOCOL_CAPABILITIES,
-  NAVIGATION_CLOSE_METHOD,
-  NAVIGATION_OPEN_APP_PAGE_METHOD,
-  NAVIGATION_RELOAD_METHOD,
-  NETWORK_REQUEST_METHOD,
-  NETWORK_DOWNLOAD_METHOD,
-  SDK_HANDSHAKE_METHOD,
-  SHARE_COPY_LINK_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_INFO_AUTHORIZATION_SCOPES,
-  USER_GET_INFO_METHOD,
-  USER_GET_STEAM_GAME_LIST_METHOD,
-  USER_REVOKE_AUTHORIZATION_METHOD,
-  VIEWPORT_GET_WINDOW_INFO_METHOD,
-  VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD,
-  isManagedMiniProgramRuntimePermissionKey,
-  isMiniProgramByteArray,
-  isMiniProgramBridgeMessage,
-  isMiniProgramDirectoryDescriptor,
-  isMiniProgramDirectoryRef,
-  isMiniProgramDownloadProgressPayload,
-  isMiniProgramFileDescriptor,
-  isMiniProgramFileRef,
-  isMiniProgramFileStat,
-  isMiniProgramFileSystemEntityDescriptor,
-  isMiniProgramPathRootRef,
-  isMiniProgramRelativePath,
-  parseMiniProgramRuntimePermissions,
-} from '@heybox/hb-sdk-protocol';
-
-export type {
-  AuthorizedUserInfo,
-  ClosePayload,
-  CloseResult,
-  CopyLinkPayload,
-  CopyLinkResult,
-  DirectoryCreatePayload,
-  DirectoryCreateResult,
-  DirectoryExistsPayload,
-  DirectoryExistsResult,
-  DirectoryListPayload,
-  DirectoryListResult,
-  DirectoryRemovePayload,
-  DirectoryRemoveResult,
-  DeleteCurrentUserLeaderboardEntryPayload,
-  DeleteCurrentUserLeaderboardEntryResult,
-  GetCurrentUserLeaderboardEntryPayload,
-  GetCurrentUserLeaderboardEntryResult,
-  GetLeaderboardInfoPayload,
-  GetLeaderboardInfoResult,
-  GetLeaderboardListPayload,
-  GetLeaderboardListResult,
-  GetSteamGameListPayload,
-  GetSteamGameListResult,
-  GetStoragePayload,
-  GetStorageResult,
-  GetUserInfoPayload,
-  GetUserInfoResult,
-  GetWindowInfoPayload,
-  GetWindowInfoResult,
-  DownloadProgressPayload,
-  HideLoadingPayload,
-  HideLoadingResult,
-  FileCreatePayload,
-  FileCreateResult,
-  FileExistsPayload,
-  FileExistsResult,
-  FileReadBytesPayload,
-  FileReadBytesResult,
-  FileReadTextPayload,
-  FileReadTextResult,
-  FileRemovePayload,
-  FileRemoveResult,
-  FileStatPayload,
-  FileStatResult,
-  FileWriteBytesPayload,
-  FileWriteBytesResult,
-  FileWriteTextPayload,
-  FileWriteTextResult,
-  LeaderboardEntry,
-  LeaderboardOrder,
-  LoginPayload,
-  LoginResult,
-  LoginScope,
-  MiniProgramAuthMethod,
-  MiniProgramBridgeError,
-  MiniProgramBridgeCancelMessage,
-  MiniProgramBridgeMessage,
-  MiniProgramBridgeMessageType,
-  MiniProgramBridgeProgressMessage,
-  MiniProgramBridgeMethod,
-  MiniProgramCapabilityDefinition,
-  MiniProgramCapabilityModule,
-  MiniProgramCapabilityPayload,
-  MiniProgramCapabilityPayloadMap,
-  MiniProgramCapabilityResult,
-  MiniProgramCapabilityResultMap,
-  MiniProgramCapabilityRisk,
-  MiniProgramCloudMethod,
-  MiniProgramDeviceMethod,
-  MiniProgramDirectoryDescriptor,
-  MiniProgramDirectoryMethod,
-  MiniProgramDirectoryRef,
-  MiniProgramDirectDirectoryRef,
-  MiniProgramDirectFileRef,
-  MiniProgramEventName,
-  MiniProgramEventPayloadMap,
-  MiniProgramFileDescriptor,
-  MiniProgramFileMode,
-  MiniProgramFileMethod,
-  MiniProgramFileRef,
-  MiniProgramFilesMethod,
-  MiniProgramFileStat,
-  MiniProgramFileSystemEntityDescriptor,
-  MiniProgramFileSystemEntityRef,
-  MiniProgramPathRootRef,
-  MiniProgramSandboxRootRef,
-  MiniProgramNavigationBarForegroundStyle,
-  MiniProgramNavigationMethod,
-  MiniProgramNetworkHeaders,
-  MiniProgramNetworkMethod,
-  MiniProgramNetworkParams,
-  MiniProgramNetworkRequestMethod,
-  MiniProgramOperatingSystemName,
-  MiniProgramRuntimePermissionEntry,
-  MiniProgramRuntimeEnvironmentInfo,
-  MiniProgramRuntimeMode,
-  MiniProgramRuntimePermissionsSnapshot,
-  MiniProgramRuntimePermissionStatus,
-  MiniProgramSafeArea,
-  MiniProgramScreenshotRect,
-  MiniProgramShareChannel,
-  MiniProgramShareMethod,
-  MiniProgramSharePostOptions,
-  MiniProgramStorageMethod,
-  MiniProgramToastStatus,
-  MiniProgramUiMethod,
-  MiniProgramUserInfoResult,
-  MiniProgramUserMethod,
-  MiniProgramVibrateIntensity,
-  MiniProgramViewportMethod,
-  MiniProgramWindowInfoResult,
-  NetworkRequestPayload,
-  NetworkResponsePayload,
-  NetworkDownloadPayload,
-  NetworkDownloadResult,
-  OpenAppPagePayload,
-  OpenAppPageResult,
-  OpenGameDetailAppPagePayload,
-  OpenPostDetailAppPagePayload,
-  OpenUserDetailAppPagePayload,
-  PickDirectoryPayload,
-  PickDirectoryResult,
-  PickFilesPayload,
-  PickFilesResult,
-  ParsedMiniProgramRuntimePermissions,
-  ReloadPayload,
-  ReloadResult,
-  RevokeAuthorizationPayload,
-  RevokeAuthorizationResult,
-  ScreenshotPayload,
-  ScreenshotResult,
-  SaveFilePayload,
-  SaveFileResult,
-  SDKHandshakePayload,
-  SDKHandshakeResult,
-  SetClipboardPayload,
-  SetClipboardResult,
-  SetNavigationBarStylePayload,
-  SetNavigationBarStyleResult,
-  SetStoragePayload,
-  ShowLoadingPayload,
-  ShowLoadingResult,
-  ShowShareMenuPayload,
-  ShowShareMenuResult,
-  ShowToastPayload,
-  ShowToastResult,
-  SteamGameListData,
-  SteamGameListItem,
-  SteamGameListSort,
-  SteamGamePrice,
-  SubmitLeaderboardEntryPayload,
-  SubmitLeaderboardEntryResult,
-  UserInfoAuthorization,
-  UserInfoAuthorizationScope,
-  UserInfoAuthorizationStatus,
-  VibratePayload,
-  VibrateResult,
-} from '@heybox/hb-sdk-protocol';
-
-// 这些类型属于 iframe Client facade，不进入共享 wire package；保留在兼容入口避免类型面静默收窄。
-export type { LoginOptions } from './modules/auth';
-export type { GetSteamGameListOptions } from './modules/user';
-export type { MiniProgramEventHandler } from './protocol/types';
-export type {
-  DownloadBaseOptions,
-  DownloadOptions,
-  DownloadProgress,
-  MiniProgramNetworkRequestConfig,
-  MiniProgramNetworkResponse,
-  MiniProgramNetworkValidateStatus,
-} from './modules/network';
-export type {
-  CreateOptions,
-  DirectoryHandle,
-  FileHandle,
-  FileMode,
-  FileStat,
-  FileSystem,
-  FileSystemEntity,
-  FilesModule,
-  ListOptions,
-  PathRoot,
-  PickDirectoryOptions,
-  PickFilesOptions,
-  RemoveOptions,
-  SaveFileOptions,
-} from './modules/files';
-export type { MiniProgramScreenshotOptions, MiniProgramShowShareMenuOptions } from './modules/share';
-export type { MiniProgramSetNavigationBarStyleOptions } from './modules/viewport';
-```
-
-## Generated reference index
-
-
-# Reference
-
-Reference 由 `@heybox/hb-sdk` 的公开导出与源码注释自动生成，不重复 Guide 的接入流程。
-
-| 导出面 | 说明 |
-| --- | --- |
-| [Root API](api-root.md) | `@heybox/hb-sdk` 的默认导出、命名导出与公开能力。 |
-| [Protocol API](#public-protocol-entrypoint) | `@heybox/hb-sdk/protocol` 的协议常量、消息类型与 method 契约。 |
-| [Miniapp Publish API](https://open.xiaoheihe.cn/docs/hb_sdk/reference/miniapp-publish/) | `@heybox/hb-sdk/miniapp-publish` 的构建产物发布前的公开校验工具。 |
-| [Vite API](https://open.xiaoheihe.cn/docs/hb_sdk/reference/vite/) | `@heybox/hb-sdk/vite` 的Vite 工坊小程序插件。 |
-
-## 查询建议
-
-- 想查业务接入路径：先看 [Guide](recipes.md)。
-- 想查导出符号：从上方对应公开入口进入分类页。
-- 想看场景化用法：优先看 Guide / Recipes 页面中的“进一步阅读”。
-
-## 统计
-
-| 导出面 | Classes | Functions | Interfaces | Types | Constants |
-| --- | ---: | ---: | ---: | ---: | ---: |
-| Root API | 2 | 4 | 75 | 73 | 3 |
-| Protocol API | 0 | 13 | 58 | 90 | 47 |
-| Miniapp Publish API | 0 | 7 | 4 | 1 | 2 |
-| Vite API | 0 | 1 | 5 | 1 | 3 |
-
-<!-- Generated by apps/docs/hb-sdk/scripts/generate-api-docs.ts; schemaVersion=5; fingerprint=788999541fe3fc9c655c149a0e615ec89757fe4899c7f9bbb9c8f9550f24bc6d -->
-
-## SDK API
-
-- [兼容性总览](https://docs.xiaoheihe.cn/hb_sdk/reference/compatibility)
-
-## 常用 API
-
-- [`user.getInfo`](https://docs.xiaoheihe.cn/hb_sdk/reference/sdk/user/getInfo)
-- [`auth.login`](https://docs.xiaoheihe.cn/hb_sdk/reference/sdk/auth/login)
-- [`cloud.leaderboard.submit`](https://docs.xiaoheihe.cn/hb_sdk/reference/sdk/cloud/leaderboard/submit)