@heybox/hb-sdk 0.9.1-alpha.4 → 0.9.1-alpha.6

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

@@ -1,269 +0,0 @@
-import type { MiniProgramRequester } from '../../core/client';
-import type { ExecuteProtocolInput } from '@heybox/hb-sdk-protocol';
-export { DEVICE_EXECUTE_PROTOCOL_METHOD, DEVICE_SET_CLIPBOARD_METHOD, DEVICE_VIBRATE_METHOD, } from '../../protocol/capabilities';
-export type { ExecuteProtocolInput, ExecuteProtocolObject, ExecuteProtocolResult } from '@heybox/hb-sdk-protocol';
-/**
- * 震动强度。
- *
- * @remarks
- * `light`、`medium`、`heavy` 由 Host 映射到平台可用的反馈等级；具体时长和马达
- * 强度由宿主决定，小程序不应据此推断精确的毫秒数。
- */
-export type MiniProgramVibrateIntensity = 'light' | 'medium' | 'heavy';
-/**
- * `device.vibrate` 入参。
- *
- * @remarks
- * 只接受 `intensity` 与 `delay`；额外字段会以 `INVALID_PARAMS` 拒绝。两项都省略时等价于
- * `{ intensity: 'light', delay: 0 }`。
- */
-export interface VibratePayload {
-    /**
-     * 语义震动强度，默认 `light`。
-     *
-     * @remarks
-     * 只接受精确的小写值 `light`、`medium` 或 `heavy`。Host 会把语义等级映射到当前平台、
-     * 硬件与系统设置可用的反馈，实际马达强度、时长和触感不构成跨平台保证。
-     */
-    intensity?: MiniProgramVibrateIntensity;
-    /**
-     * Host 调度震动前的延迟毫秒数，默认 `0`。
-     *
-     * @remarks
-     * 必须是 `0` 至 `5000`（含边界）的有限整数；负数、小数、`NaN`、`Infinity` 和超过
-     * `5000` 的值会以 `INVALID_PARAMS` 拒绝。该值不是震动持续时长，SDK 也不会先在 iframe
-     * 中等待再发请求，而是把经校验的延迟交给 Host 调度。
-     */
-    delay?: number;
-}
-/**
- * `device.vibrate` 的空结果。
- *
- * @remarks
- * `void` 只表示 Host 已接受并完成本次调用，不表示用户一定感知到震动，也不表示延迟期或
- * 物理反馈已经结束。静音/触觉设置、硬件能力与系统策略仍可能改变或抑制实际反馈。
- */
-export type VibrateResult = void;
-/**
- * `device.setClipboard` 入参。
- *
- * @remarks
- * 只接受 `text` 字段；额外字段会以 `INVALID_PARAMS` 拒绝。该对象不能指定剪贴板格式、
- * 追加模式或目标设备，调用会整段替换当前 Host 的系统文本剪贴板。
- */
-export interface SetClipboardPayload {
-    /**
-     * 要写入系统剪贴板的文本。
-     *
-     * @remarks
-     * 必须是字符串，且按 JavaScript `trim()` 检查后至少包含一个非空白字符；空字符串和
-     * 纯空格、换行或制表符文本会以 `INVALID_PARAMS` 拒绝。`trim()` 只用于校验，Runtime
-     * 不会实际裁剪、编码或 Unicode 归一化，开头与结尾的空白会原样传给 Host。
-     *
-     * 长度上限为 `10000` 个 JavaScript UTF-16 code units（即 `text.length`），不是 UTF-8
-     * 字节数、Unicode code points 或用户感知字符数；例如多数 emoji 会占用两个 code units。
-     * 恰好 `10000` 个 code units 可通过 Runtime 校验，Host 或操作系统仍可能拒绝写入。
-     */
-    text: string;
-}
-/** `device.setClipboard` 无稳定返回值。 */
-export type SetClipboardResult = void;
-export type { MiniProgramDeviceMethod } from '../../protocol/capabilities';
-/** 外部小程序可调用的 device 模块。 */
-export interface MiniProgramDeviceModule {
-    /**
-     * 请求 Host 调度一次触觉震动反馈。
-     *
-     * @param options - 可选的语义强度与 Host 调度延迟；省略、JavaScript `null` 或传空对象时使用
-     * `intensity: 'light'`、`delay: 0`。
-     * @returns Host 接受并完成本次调用后 resolve `undefined`；不会等待 `delay` 倒计时或
-     * 物理反馈结束，也不会返回实际强度、时长或是否被系统抑制。
-     * @throws {@link HbMiniProgramSDKError} `INVALID_PARAMS`：除兼容 `null` 外的 `options` 不是对象、包含未知字段、
-     * `intensity` 不是 `light` / `medium` / `heavy`，或 `delay` 不是 `0` 至 `5000` 的整数。
-     * @throws {@link HbMiniProgramSDKError} `METHOD_FORBIDDEN`：当前 Host 未开放震动能力；新 PC
-     * Host 的 Windows / macOS 桌面环境属于此分支。Host 无法支持请求形状时可返回
-     * `REQUEST_UNSUPPORTED`。其他握手、bridge 超时与 Host 调用失败会保留对应错误码。
-     *
-     * @remarks
-     * 该 API 无需在 `package.json#heybox.permissions` 中声明权限，也不要求平台批准、用户
-     * 授权或可信用户手势。Runtime 不对连续调用增加频率限制或合并策略；每次合法调用都会
-     * 交给 Host，但 Host 或操作系统仍可能节流、合并或忽略反馈。
-     *
-     * 移动 Host 会将 `light`、`medium`、`heavy` 映射到平台可用的反馈等级，并将 `delay`
-     * 交给平台调度。等级不是精确马达参数，`delay` 也不是计时器；不要用 Promise 完成时点、
-     * 震动强度或触感推进业务状态、安全确认或无障碍信息。
-     *
-     * 震动只提供触觉反馈，不会显示文案、Toast、Loading 或错误提示。需要可见反馈时应独立
-     * 调用 {@link https://docs.xiaoheihe.cn/hb_sdk/reference/sdk/ui/showToast | ui.showToast}；
-     * 桌面环境可在震动返回 `METHOD_FORBIDDEN` 时降级为 Toast，但两次调用拥有独立的 Promise
-     * 与失败结果。
-     *
-     * @example
-     * ```ts
-     * import hbSDK, { HbMiniProgramSDKError } from '@heybox/hb-sdk'
-     *
-     * try {
-     *   await hbSDK.device.vibrate({ intensity: 'medium', delay: 120 })
-     * } catch (error) {
-     *   // 桌面 Host 没有触觉反馈时，改用可见反馈。
-     *   if (error instanceof HbMiniProgramSDKError && error.code === 'METHOD_FORBIDDEN') {
-     *     await hbSDK.ui.showToast({ message: '操作完成', status: 'success' })
-     *   } else {
-     *     throw error
-     *   }
-     * }
-     * ```
-     *
-     * @see {@link https://docs.xiaoheihe.cn/hb_sdk/reference/sdk/ui/showToast | ui.showToast}
-     * @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
-     *
-     * @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>;
-    /**
-     * 将调用方提供的纯文本写入 Host 的系统剪贴板。
-     *
-     * @param options - 剪贴板写入参数；`options.text` 必须符合
-     * {@link SetClipboardPayload.text} 的非空白与 UTF-16 长度约束。
-     * @returns Host 确认系统剪贴板写入完成后 resolve `undefined`；不会返回或回读剪贴板内容。
-     * @throws {@link HbMiniProgramSDKError} `INVALID_PARAMS`：`options` 不是对象、包含 `text`
-     * 以外的字段，或 `text` 不是字符串、全为空白、超过 `10000` 个 UTF-16 code units。
-     * @throws {@link HbMiniProgramSDKError} `PERMISSION_NOT_DECLARED` / `PERMISSION_DENIED`：当前
-     * 版本未声明或未启用 `clipboard` 权限。
-     * @throws {@link HbMiniProgramSDKError} `METHOD_FORBIDDEN` / `METHOD_NOT_FOUND`：当前 Host
-     * 未开放或尚不认识该能力；Host 不支持本次写入形状时可返回 `REQUEST_UNSUPPORTED`。
-     * 其他握手、bridge 超时和 Host / 系统剪贴板失败会保留对应错误码。
-     *
-     * @remarks
-     * 该 API 需要在 `package.json#heybox.permissions` 声明并启用 `clipboard`，不需要平台
-     * 批准、用户授权或可信用户手势。它通过 Host 原语写入系统剪贴板，不调用浏览器
-     * `navigator.clipboard`，因此浏览器 Clipboard API 的权限与手势规则不适用；调用方仍应
-     * 在明确的用户操作后写入，避免意外覆盖用户剪贴板。
-     *
-     * Runtime 仅用 `trim()` 判断文本是否全为空白，然后把原始字符串完整交给 Host；前后
-     * 空格、换行和制表符都会保留。成功只表示 Host 已完成纯文本写入，不会追加内容、复制
-     * 富文本或图片、打开分享面板，也不会自动显示“复制成功”提示。
-     *
-     * 复制任意业务文本或已有 URL 时使用本方法。要生成并复制当前小程序的标准分享链接，
-     * 使用 {@link https://docs.xiaoheihe.cn/hb_sdk/reference/sdk/share/copyLink | share.copyLink}：
-     * 它要求 `share` 而不是 `clipboard` 权限、同样不要求可信用户手势，并在 Host 写入后返回
-     * 生成的完整链接。
-     *
-     * @example
-     * ```ts
-     * import hbSDK from '@heybox/hb-sdk'
-     *
-     * await hbSDK.device.setClipboard({
-     *   // 前后空格会保留；该调用不会自动显示成功提示。
-     *   text: '  房间码: HB-2048  ',
-     * })
-     * showCopiedToast()
-     * ```
-     *
-     * @see {@link https://docs.xiaoheihe.cn/hb_sdk/reference/sdk/share/copyLink | share.copyLink}
-     * @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
-     *
-     * @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>;
-    /**
-     * 执行一条任意小黑盒客户端协议。
-     *
-     * **暂不对外开放。** `device.executeProtocol()` 与 `appProtocol` 权限当前仅为预留能力，
-     * 不提供开发者申请入口；请勿在对外发布的小程序中依赖此 API。本地临时授权不代表对外开放。
-     *
-     * @param protocol - 完整协议字符串（如 `heybox://<encodeURIComponent(JSON)>`）或包含
-     * `protocol_type` 的 JSON 协议对象。
-     * @returns 协议投递成功后 resolve `undefined`。成功只表示已交给 Host 投递，不表示协议业务
-     * 动作已经完成；协议自身的业务返回值与回调不会转发给调用方。
-     * @throws {@link HbMiniProgramSDKError} `INVALID_PARAMS`：输入既不是非空字符串，也不是带非空
-     * 字符串 `protocol_type` 的 JSON 可序列化对象（含函数、`symbol`、`BigInt`、非有限数字或循环
-     * 引用时会失败），此时不会产生任何投递。
-     * @throws {@link HbMiniProgramSDKError} `PERMISSION_NOT_DECLARED` / `PERMISSION_DENIED`：当前
-     * 版本未声明 `appProtocol`，或该权限未启用/未获平台批准；不会产生协议副作用。
-     * @throws {@link HbMiniProgramSDKError} `METHOD_FORBIDDEN` / `METHOD_NOT_FOUND`：当前 Host 未
-     * 开放或尚不认识通用协议执行能力；旧 PC Host 属于此分支。Host 明确拒绝的协议也可能映射为
-     * 不支持错误。
-     * @throws {@link HbMiniProgramSDKError} 其它握手、bridge 超时、Runtime 销毁与 Host 投递失败会保留
-     * 对应错误码。底层明确投递失败时一定 reject，不会把失败当作成功。
-     *
-     * @remarks
-     * **最高危险等级。** 该 API 与 `appProtocol` 权限均为当前最高危险等级 `high`：平台批准后，
-     * 该入口可以执行任意小黑盒协议，并**绕过**其他 SDK 能力权限及其专用授权流程（例如网络类协议
-     * 不再要求 `network`，读取用户资料不再要求 `userInfo`）。`appProtocol` 只作用于
-     * `device.executeProtocol()`，不会让其它 SDK 方法免除自身权限。底层协议工具、客户端与操作
-     * 系统原本的支持范围、可信手势与执行规则继续生效；未获批准或未声明的调用不会产生任何副作用。
-     *
-     * SDK 不维护协议类型白名单，也不把对象重组为
-     * {@link https://docs.xiaoheihe.cn/hb_sdk/reference/sdk/navigation/openAppPage | navigation.openAppPage}
-     * 的目标联合；字符串与对象都交给各端已有协议实现处理，因此各端实际支持的协议范围由已有工具
-     * 决定，移动端与 PC 不保证逐条一致。本方法不自动重试，避免副作用协议被重复执行。
-     *
-     * 本地调试时可在 `hb-sdk dev` 中声明 `appProtocol`，经 Host 确认后获得当前 Dev Session 的临时
-     * 授权；临时授权不代表平台批准，`remote deploy` 与生产构建仍按线上批准执行。
-     *
-     * @example
-     * ```ts
-     * import hbSDK from '@heybox/hb-sdk'
-     *
-     * // 自行构造协议对象。
-     * await hbSDK.device.executeProtocol({
-     *   protocol_type: 'openRouterPath',
-     *   path: '/game/detail',
-     *   params: { app_id: '570' },
-     * })
-     *
-     * // 后端下发的完整协议字符串也可直接传入。
-     * const protocol = { protocol_type: 'openRouterPath', path: '/game/detail', params: { app_id: '570' } }
-     * await hbSDK.device.executeProtocol(`heybox://${encodeURIComponent(JSON.stringify(protocol))}`)
-     * ```
-     *
-     * @see {@link https://docs.xiaoheihe.cn/hb_sdk/guide/permissions | 权限声明}
-     * @see {@link https://docs.xiaoheihe.cn/hb_sdk/reference/sdk/navigation/openAppPage | navigation.openAppPage}
-     *
-     * @since 0.9.1-alpha.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
-     */
-    executeProtocol(protocol: ExecuteProtocolInput): Promise<void>;
-}
-/** 触发宿主震动反馈。 */
-export declare function vibrate(requester: MiniProgramRequester, options?: VibratePayload): Promise<void>;
-/** 写入系统文本剪贴板。 */
-export declare function setClipboard(requester: MiniProgramRequester, options: SetClipboardPayload): Promise<void>;
-/**
- * 执行任意小黑盒客户端协议。
- *
- * 形态校验由 Runtime 在 Host 投递前完成；本函数只负责把输入原样交给 bridge。
- */
-export declare function executeProtocol(requester: MiniProgramRequester, protocol: ExecuteProtocolInput): Promise<void>;
-/** 创建设备能力模块。 */
-export declare function createDeviceModule(requester: MiniProgramRequester): MiniProgramDeviceModule;

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

@@ -1,238 +0,0 @@
-import type { MiniProgramOperatingSystemName, MiniProgramRuntimeMode } from '@heybox/hb-sdk-protocol';
-/**
- * 小程序环境信息中的运行模式。
- *
- * @remarks
- * `production` 表示已发布版本，`preview` 表示版本预览，`development` 表示本地或
- * Browser Dev Host 调试；旧版 Host 或无法识别的值会归一化为 `unknown`。
- */
-export type { MiniProgramRuntimeMode } from '@heybox/hb-sdk-protocol';
-/**
- * 小程序环境信息中的操作系统名称。
- *
- * @remarks
- * 该值由 Host 提供，不由小程序 iframe 的 User-Agent 推断。无法识别或缺失时为
- * `unknown`。
- */
-export type { MiniProgramOperatingSystemName } from '@heybox/hb-sdk-protocol';
-/**
- * 当前小程序实例的只读环境快照。
- *
- * @remarks
- * 返回对象及其嵌套对象均已冻结。除 `sdk.version` 外，版本字段都是 Host 提供的
- * 不透明字符串，不保证符合 SemVer，也不适合做大小比较。旧版 Host 缺失字段时
- * 使用固定结构，并将字符串字段设为 `null`、枚举字段设为 `unknown`。
- */
-export interface MiniProgramEnvironmentInfo {
-    readonly runtime: {
-        /** 当前小程序实例的运行模式。 */
-        readonly mode: MiniProgramRuntimeMode;
-    };
-    readonly host: {
-        /** 当前小黑盒 App 版本；Host 未提供时为 `null`。 */
-        readonly appVersion: string | null;
-    };
-    readonly miniProgram: {
-        /** 平台确认的 canonical 小程序 ID；Host 未提供时为 `null`。 */
-        readonly id: string | null;
-        /** 当前加载的小程序版本；Host 未提供时为 `null`。 */
-        readonly version: string | null;
-    };
-    readonly operatingSystem: {
-        /** Host 提供的标准操作系统枚举。 */
-        readonly name: MiniProgramOperatingSystemName;
-        /** Host 提供的操作系统版本；Host 未提供时为 `null`。 */
-        readonly version: string | null;
-    };
-    readonly sdk: {
-        /** 当前页面实际运行的 `@heybox/hb-sdk` 版本。 */
-        readonly version: string;
-    };
-}
-/** SDK 内部读取环境快照所需的最小能力。 */
-export interface MiniProgramEnvironmentReader {
-    getEnvironmentInfo(): Promise<MiniProgramEnvironmentInfo>;
-    getEnvironmentInfoSync(): MiniProgramEnvironmentInfo;
-}
-/** 外部小程序可调用的 environment 模块。 */
-export interface MiniProgramEnvironmentModule {
-    /**
-     * 获取当前小程序实例的环境快照，并在必要时自动等待 SDK 握手。
-     *
-     * @returns 握手完成后 resolve 的同一份深度冻结环境快照，包含：
-     *
-     * - `runtime.mode`：`production`、`preview`、`development` 或 `unknown`；
-     * - `host.appVersion`：Host 提供的小黑盒 App 版本，缺失或非法时为 `null`；
-     * - `miniProgram.id`：平台确认的 canonical 小程序 ID，缺失或非法时为 `null`；
-     * - `miniProgram.version`：当前加载的小程序版本，缺失或非法时为 `null`；
-     * - `operatingSystem.name`：Host 提供的标准系统枚举，缺失或非法时为 `unknown`；
-     * - `operatingSystem.version`：Host 提供的系统版本，缺失或非法时为 `null`；
-     * - `sdk.version`：当前页面实际运行的 `@heybox/hb-sdk` 版本。
-     *
-     * @throws {@link HbMiniProgramSDKError} 初始握手进入 `failed` 时拒绝。常见错误码包括
-     * `NOT_IN_IFRAME`、`MISSING_NONCE`、`READY_TIMEOUT`、`HANDSHAKE_FAILED`，以及握手完成前
-     * Runtime 卸载产生的 `RUNTIME_UNAVAILABLE`。本异步 API 在 `connecting` 状态会等待，不会抛出
-     * `ENVIRONMENT_NOT_READY`。
-     *
-     * @remarks
-     * 该方法不接收参数。导入根包时 SDK 已自动启动握手；调用发生在 `connecting` 状态时会等待
-     * 持久握手状态进入 `ready`，随后直接返回握手阶段缓存的快照。并发或重复调用不会重新请求
-     * Host，并会得到引用相同的对象；快照和所有嵌套对象均不可变，也不会随页面生命周期继续更新。
-     *
-     * Host 下发的非空字符串会去除首尾空白。旧版 Host 未下发环境信息，或某个字段类型、枚举值
-     * 非法时，只降级对应字段并保持完整返回结构，不会因此阻断握手。除 `sdk.version` 遵循 npm
-     * SemVer 外，其他版本字段均为不透明字符串，不能用于版本大小判断。
-     *
-     * 该 API 无需在 `package.json#heybox.permissions` 中声明权限，不触发用户授权，也不返回设备唯一
-     * 标识或账号信息。结果只适合界面适配、兼容降级、埋点和诊断；小程序可修改发往服务端的值，
-     * 因而不能将其作为鉴权、权限控制或风控依据。
-     *
-     * Android、iOS、OHOS、Windows 与 macOS 的最低客户端要求见本页兼容性元数据。本地 Browser
-     * Dev Host 中 `runtime.mode` 为 `development`，操作系统名称来自当前设备预设，不从 iframe 的
-     * User-Agent 推断。
-     *
-     * 已经确认握手为 `ready` 且必须同步读取时，可改用
-     * [environment.getInfoSync()](/reference/sdk/environment/getInfoSync)；需要驱动加载或失败界面时，
-     * 使用 [getHandshakeState()](/reference/sdk/lifecycle/getHandshakeState) 或
-     * [onHandshakeStateChange()](/reference/sdk/lifecycle/onHandshakeStateChange)，不要依赖不会重放的
-     * `ready` 生命周期事件。
-     *
-     * @example
-     * ```ts
-     * import hbSDK from '@heybox/hb-sdk'
-     *
-     * const info = await hbSDK.environment.getInfo()
-     *
-     * console.log({
-     *   mode: info.runtime.mode,
-     *   miniProgramId: info.miniProgram.id ?? 'unknown',
-     *   appVersion: info.host.appVersion ?? 'unknown',
-     *   platform: info.operatingSystem.name,
-     *   sdkVersion: info.sdk.version,
-     * })
-     * ```
-     *
-     * @example
-     * ```ts
-     * import hbSDK, { HbMiniProgramSDKError } from '@heybox/hb-sdk'
-     *
-     * try {
-     *   const info = await hbSDK.environment.getInfo()
-     *   applyPlatformLayout(info.operatingSystem.name)
-     * } catch (error) {
-     *   if (error instanceof HbMiniProgramSDKError) {
-     *     showEnvironmentUnavailable(error.code)
-     *   } else {
-     *     throw error
-     *   }
-     * }
-     * ```
-     *
-     * @see [environment.getInfoSync()](/reference/sdk/environment/getInfoSync) 同步读取同一份握手快照。
-     * @see [getHandshakeState()](/reference/sdk/lifecycle/getHandshakeState) 同步检查持久握手状态。
-     * @see [onHandshakeStateChange()](/reference/sdk/lifecycle/onHandshakeStateChange) 订阅当前状态及后续唯一一次迁移。
-     *
-     * @since 0.8.1-alpha.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
-     */
-    getInfo(): Promise<MiniProgramEnvironmentInfo>;
-    /**
-     * 同步读取握手完成后缓存的环境快照。
-     *
-     * @returns 握手阶段缓存的同一份
-     * [MiniProgramEnvironmentInfo](/reference/symbols/root/interfaces/MiniProgramEnvironmentInfo) 深度冻结快照，包含：
-     *
-     * - `runtime.mode`：当前实例的
-     *   [MiniProgramRuntimeMode](/reference/symbols/root/types/MiniProgramRuntimeMode)；
-     * - `host.appVersion`：Host 提供的小黑盒 App 版本，缺失或非法时为 `null`；
-     * - `miniProgram.id`：平台确认的 canonical 小程序 ID，缺失或非法时为 `null`；
-     * - `miniProgram.version`：当前加载的小程序版本，缺失或非法时为 `null`；
-     * - `operatingSystem.name`：Host 提供的
-     *   [MiniProgramOperatingSystemName](/reference/symbols/root/types/MiniProgramOperatingSystemName)；
-     * - `operatingSystem.version`：Host 提供的系统版本，缺失或非法时为 `null`；
-     * - `sdk.version`：当前页面实际运行的 `@heybox/hb-sdk` 版本。
-     *
-     * @throws [HbMiniProgramSDKError](/reference/symbols/root/classes/HbMiniProgramSDKError)
-     * 当前握手状态为 `connecting` 时同步抛出
-     * `ENVIRONMENT_NOT_READY`。这也包括 Host 已返回握手响应、但 SDK 尚未收到 `ready` 事件的短暂阶段。
-     * @throws [HbMiniProgramSDKError](/reference/symbols/root/classes/HbMiniProgramSDKError)
-     * 当前握手状态为 `failed` 时原样重抛
-     * `state.error`；其错误码可能是 `NOT_IN_IFRAME`、`MISSING_NONCE`、`READY_TIMEOUT`、
-     * `HANDSHAKE_FAILED`、`RUNTIME_UNAVAILABLE` 或 `SDK_DESTROYED` 等握手错误，而不是
-     * `ENVIRONMENT_NOT_READY`。
-     *
-     * @remarks
-     * 该方法不接收参数、不等待握手，也不会向 Host 发起新请求。它严格按当前持久握手状态同步返回
-     * 或抛错：`connecting` 抛出 `ENVIRONMENT_NOT_READY`，`failed` 重抛原始握手错误，只有 `ready`
-     * 返回快照。一般业务代码应优先使用会自动等待握手的
-     * [environment.getInfo()](/reference/sdk/environment/getInfo)；本方法适用于已经由同步控制流确认
-     * `ready`，且调用方不能引入异步边界的场景。
-     *
-     * SDK 会在发布 `ready` 状态前缓存快照，因此在
-     * [onHandshakeStateChange()](/reference/sdk/lifecycle/onHandshakeStateChange) 的 `ready` 分支中可立即
-     * 调用。也可以先检查 [getHandshakeState()](/reference/sdk/lifecycle/getHandshakeState)，但检查与读取
-     * 应在同一段同步代码中完成。不要依赖不会重放的 `ready` 生命周期事件判断当前状态。
-     *
-     * 首次成功读取、后续同步读取和异步 `getInfo()` 都返回引用相同的对象，不会重新请求、重新创建或
-     * 随页面生命周期更新。返回对象及全部嵌套对象均已冻结；旧版 Host 缺失环境信息时仍返回固定结构，
-     * 字符串字段以 `null`、枚举字段以 `unknown` 表示未知值。除 `sdk.version` 外，版本字段都是不透明
-     * 字符串，不能用于版本大小判断。
-     *
-     * 该 API 无需权限且不触发用户授权。快照适合在同步渲染、界面适配、兼容降级、埋点或诊断中使用；
-     * 它不包含账号信息或设备唯一标识，也不能作为鉴权、权限控制或风控依据。
-     *
-     * @example
-     * ```ts
-     * import {
-     *   environment,
-     *   onHandshakeStateChange,
-     * } from '@heybox/hb-sdk'
-     *
-     * const unsubscribe = onHandshakeStateChange(state => {
-     *   if (state.status === 'connecting') return
-     *
-     *   if (state.status === 'failed') {
-     *     console.error('SDK 握手失败', state.error.code)
-     *     return
-     *   }
-     *
-     *   // ready 发布前快照已经缓存，这里不会抛 ENVIRONMENT_NOT_READY。
-     *   const info = environment.getInfoSync()
-     *   renderForPlatform(info.operatingSystem.name)
-     * })
-     *
-     * window.addEventListener('unload', unsubscribe, { once: true })
-     * ```
-     *
-     * @see [environment.getInfo()](/reference/sdk/environment/getInfo) 自动等待握手后读取同一份快照。
-     * @see [MiniProgramEnvironmentInfo](/reference/symbols/root/interfaces/MiniProgramEnvironmentInfo) 返回字段、空值与枚举语义。
-     * @see [getHandshakeState()](/reference/sdk/lifecycle/getHandshakeState) 同步读取当前持久握手状态。
-     * @see [onHandshakeStateChange()](/reference/sdk/lifecycle/onHandshakeStateChange) 立即接收当前状态并订阅唯一一次迁移。
-     *
-     * @since 0.8.1-alpha.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
-     */
-    getInfoSync(): MiniProgramEnvironmentInfo;
-}
-/** 创建环境信息模块。 */
-export declare function createEnvironmentModule(reader: MiniProgramEnvironmentReader): MiniProgramEnvironmentModule;
-/** 将不可信 wire 值逐字段降级为固定、深度冻结的公开快照。 */
-export declare function normalizeMiniProgramEnvironmentInfo(value: unknown): MiniProgramEnvironmentInfo;

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

@@ -1,5 +0,0 @@
-import type { MiniProgramRequester } from '../../core/client';
-import type { FilesModule } from './types';
-export type { CreateOptions, DirectoryHandle, FileHandle, FileMode, FileStat, FileSystem, FileSystemEntity, FilesModule, ListOptions, PathRoot, PickDirectoryOptions, PickFilesOptions, RemoveOptions, SaveFileOptions, } from './types';
-/** 创建当前 SDK session 的 files 模块。 */
-export declare function createFilesModule(requester: MiniProgramRequester): FilesModule;

package/types/modules/files/registry.d.ts

@@ -1,35 +0,0 @@
-import type { MiniProgramRequester } from '../../core/client';
-import type { MiniProgramDirectoryDescriptor, MiniProgramDirectoryRef, MiniProgramFileDescriptor, MiniProgramFileMode, MiniProgramFileRef, MiniProgramFileSystemEntityDescriptor } from '@heybox/hb-sdk-protocol';
-import type { DirectoryHandle, FileHandle, FileSystem, FileSystemEntity } from './types';
-interface FileHandleState {
-    ref: MiniProgramFileRef;
-    mode: MiniProgramFileMode;
-}
-interface DirectoryHandleState {
-    ref: MiniProgramDirectoryRef;
-    mode: MiniProgramFileMode;
-}
-/** 校验并返回平台无关的 `/` 分隔逻辑相对路径。 */
-export declare function normalizeRelativePath(value: unknown): string;
-export declare class MiniProgramFileHandleRegistry {
-    private readonly requester;
-    private readonly fileStates;
-    private readonly directoryStates;
-    private readonly pathRootStates;
-    private sandboxRoot?;
-    constructor(requester: MiniProgramRequester);
-    getSandbox(): FileSystem;
-    createFile(descriptor: MiniProgramFileDescriptor): FileHandle;
-    createDirectFile(descriptor: MiniProgramFileDescriptor): FileHandle;
-    createDirectory(descriptor: MiniProgramDirectoryDescriptor): DirectoryHandle;
-    createDirectDirectory(descriptor: MiniProgramDirectoryDescriptor): DirectoryHandle;
-    createEntity(descriptor: MiniProgramFileSystemEntityDescriptor): FileSystemEntity;
-    requireFile(handle: unknown): FileHandleState;
-    requireDirectory(handle: unknown): DirectoryHandleState;
-    private definePathRootMethods;
-    private assertFileDescriptor;
-    private assertDirectoryDescriptor;
-}
-export declare function getFileHandleRegistry(requester: MiniProgramRequester): MiniProgramFileHandleRegistry;
-export declare function isMiniProgramFileSystemValue(value: unknown): value is FileSystem | FileSystemEntity;
-export {};