@heybox/hb-sdk-protocol 0.9.1-alpha.1 → 0.9.1-alpha.10
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/README.md +17 -1
- package/dist/card-actions.cjs.js +9 -0
- package/dist/card-actions.esm.js +7 -0
- package/dist/index.cjs.js +6579 -5
- package/dist/index.esm.js +6558 -6
- package/generated/native-host-contract.json +46 -2
- package/generated/permission-catalog.json +49 -2
- package/package.json +17 -6
- package/types/index.d.ts +6390 -9
- package/types/workspace-card-actions.d.ts +7 -0
- package/src/bridge.ts +0 -196
- package/src/capabilities.ts +0 -670
- package/src/constants.ts +0 -36
- package/src/guards.ts +0 -835
- package/src/index.ts +0 -9
- package/src/local-dev-grant.ts +0 -141
- package/src/native-host-contract.generated.ts +0 -60
- package/src/native-host-contract.source.json +0 -479
- package/src/native-host.ts +0 -213
- package/src/payloads.ts +0 -1080
- package/src/permission-catalog.ts +0 -193
- package/src/permissions.ts +0 -216
- package/types/bridge.d.ts +0 -163
- package/types/capabilities.d.ts +0 -596
- package/types/constants.d.ts +0 -33
- package/types/guards.d.ts +0 -660
- package/types/local-dev-grant.d.ts +0 -63
- package/types/native-host-contract.generated.d.ts +0 -18
- package/types/native-host.d.ts +0 -147
- package/types/payloads.d.ts +0 -992
- package/types/permission-catalog.d.ts +0 -117
- package/types/permissions.d.ts +0 -159
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
目录引用的 `relativePath` 允许完整 `.` 表示当前根;普通相对路径及文件引用仍拒绝点段、父目录和绝对路径。
|
|
4
4
|
|
|
5
|
-
小黑盒外部小程序 SDK 与宿主 Runtime
|
|
5
|
+
小黑盒外部小程序 SDK 与宿主 Runtime 共用的中立 wire contract。它只描述跨 iframe 边界传输的数据和校验规则,不执行 bridge、网络、登录、存储或任何平台能力。
|
|
6
6
|
|
|
7
7
|
## 边界
|
|
8
8
|
|
|
@@ -105,3 +105,19 @@ pnpm --filter @heybox/hb-sdk-protocol run build:package
|
|
|
105
105
|
`display_change` 在宿主确认方向或全屏状态发生变化后发送 `{ orientation, fullscreen, source }`,包括开发者调用 `setDisplay()` 和用户点击宿主退出全屏按钮。两个字段独立;退出全屏不改变方向。重复状态、不支持(`supported: false`)、失败、超时、取消及被后续请求替换的设置不发送事件。事件不回放初始状态,新容器默认竖屏、非全屏;它不监听手机旋转传感器,窗口尺寸与安全区仍通过 `viewport_change` 获取。请在调用设置前注册监听,并在页面销毁时取消。
|
|
106
106
|
|
|
107
107
|
`display_change.source` 区分变化来源:`api` 为开发者调用,`user` 为用户点击宿主退出全屏按钮。同目标并发合并时保留首次发起操作的来源;重复状态不额外发事件。旧宿主可能不含 source,不能将缺失来源推断为用户操作。仅用户退出时跳页,应判断 `source === 'user' && !fullscreen`,再按业务需要调用竖屏设置并跳转。
|
|
108
|
+
|
|
109
|
+
## 单文件上传合同
|
|
110
|
+
|
|
111
|
+
`network.upload` 使用 `NetworkUploadPayload`,只跨 iframe 传输 File ref 和可序列化的 raw/multipart 元数据,返回标准 `NetworkResponsePayload`。`UploadProgressPayload` 只统计文件内容字节,不包含 multipart 字段与边界。该方法同时要求 network 与 filesystem;Host 是否具备真实 primitive 由 Runtime 协商。Native Host 新增独立 `network.upload` operation;原有 contract revision 1 的操作不变,旧 Host 仍可协商 Files/Download 并单独关闭上传。
|
|
112
|
+
|
|
113
|
+
## 工作区卡片(未发布)
|
|
114
|
+
|
|
115
|
+
`workspace-cards.ts` 拥有 Definition/State、Controller 输入输出、Manifest receipt、
|
|
116
|
+
稳定错误码与 canonical snapshot 文本。ViewDocument 类型与通用校验来自已发布 Kit/view 的中立制品,小程序 profile 留在本包,不修改 ai-desktop 或复制 PC UI schema。它只校验数据,不运行 Controller,也不签发租约。
|
|
117
|
+
`workspaceCards` 为 high risk / platform-approval 权限;Host 和后端执行链路尚待完成。
|
|
118
|
+
|
|
119
|
+
### 构建依赖与发布边界
|
|
120
|
+
|
|
121
|
+
`@ai-desktop/view-contract` 仅为 devDependency。Rollup 内联中立 schema/profile,声明构建将 PC 类型及
|
|
122
|
+
所需 zod 类型一起封装;公开 JS 和 .d.ts 不引用私有包。发布时 heybox 条件也指向 dist,不分发依赖私有包
|
|
123
|
+
的源码入口。`check:bundled-contract` 在整包构建与 pack 前校验边界,私有合同只需内部制品,不必公开 npm。
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
/** 小程序固定受管动作入口。 */
|
|
4
|
+
const WORKSPACE_CARD_COMMANDS = {
|
|
5
|
+
invoke: 'ai-desktop.heybox-user-miniprogram.workspace-cards.invoke',
|
|
6
|
+
openMiniProgram: 'ai-desktop.heybox-user-miniprogram.workspace-cards.open-mini-program',
|
|
7
|
+
};
|
|
8
|
+
|
|
9
|
+
exports.WORKSPACE_CARD_COMMANDS = WORKSPACE_CARD_COMMANDS;
|