@dp-bohrium/widget-sdk 0.6.0 → 0.7.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/AGENTS.md +6 -3
- package/CHANGELOG.md +21 -0
- package/README.md +7 -16
- package/assets/schemas/widget-runtime-contracts.schema.json +7 -3
- package/assets/toolchain.json +13 -9
- package/dist/cli.mjs +155 -114
- package/dist/contracts.d.ts +1 -1
- package/dist/contracts.js +2 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +17 -11
- package/dist/manifest.d.ts +1 -1
- package/dist/protocol/generated-host-runtime-config.d.ts +551 -0
- package/dist/protocol/generated-manifest.d.ts +192 -0
- package/dist/protocol/generated-plugin-manifest.d.ts +176 -0
- package/dist/protocol/generated-runtime-contracts.d.ts +1224 -0
- package/dist/protocol/index.d.ts +43 -0
- package/dist/protocol/plugin-manifest.d.ts +30 -0
- package/dist/protocol/widget-events.d.ts +13 -0
- package/dist/runtime/bootstrap.d.ts +1 -1
- package/dist/runtime/client.d.ts +1 -1
- package/dist/runtime/event-validation.d.ts +1 -1
- package/dist/runtime/events.d.ts +1 -1
- package/dist/runtime/files.d.ts +1 -1
- package/dist/runtime/index.d.ts +1 -1
- package/dist/runtime/index.js +1 -1
- package/dist/runtime/mock-host.d.ts +1 -1
- package/dist/runtime/network.d.ts +1 -1
- package/dist/runtime/protocol-endpoint.d.ts +1 -1
- package/dist/runtime/service.d.ts +2 -2
- package/dist/runtime/transport.d.ts +1 -1
- package/dist/{runtime-D7KxTtdu.js → runtime-DZA7Gqzl.js} +1 -1
- package/dist/widget-events-BT0QxR-H.js +65 -0
- package/dist/widget.d.ts +2 -2
- package/llms.txt +2 -3
- package/package.json +4 -6
- package/schemas/widget-runtime-contracts.schema.json +7 -3
package/AGENTS.md
CHANGED
|
@@ -16,8 +16,8 @@ pnpm dlx @dp-bohrium/widget-sdk create my-widget --template panel
|
|
|
16
16
|
3. 在测试中使用 `@dp-bohrium/widget-sdk/testing` 的 `MockWidgetHost`;生产 Bundle 使用
|
|
17
17
|
根入口,不把 testing 入口打进产物。
|
|
18
18
|
4. 常用作者类型从根入口获取;完整协议用 `/contracts`,编辑器 Schema 用 `/schemas/*.json`。
|
|
19
|
-
SDK
|
|
20
|
-
|
|
19
|
+
SDK 与开发工具负责核对内置协议资产与摘要,生成的作者工程不需要重复安装 Contracts 或 CLI。
|
|
20
|
+
升级旧作者工程时,在新目录准备迁移候选并重新构建,不复用不匹配的执行器。
|
|
21
21
|
5. 低层协议客户端从 `@dp-bohrium/widget-sdk/runtime` 导入。根入口的 `WidgetRenderContext`
|
|
22
22
|
表示渲染回调的 phase/signal,协议同名类型从 `/contracts` 导入。
|
|
23
23
|
|
|
@@ -35,5 +35,8 @@ pnpm dlx @dp-bohrium/widget-sdk create my-widget --template panel
|
|
|
35
35
|
|
|
36
36
|
SDK 不授予权限、不上传或发布 Bundle、不决定 iframe/CSP 策略,也不保证脱离 Host 可以运行。
|
|
37
37
|
`ok=true` 只表示当前调用被 Runtime/Host 接受;真实授权、渲染和生产绑定由 Host 与平台负责。
|
|
38
|
-
|
|
38
|
+
工程依赖使用精确 SemVer;升级 SDK 时让开发工具核对配套协议和生成 Bundle 的 digest。
|
|
39
39
|
SDK 的 Node 命令与浏览器 Runtime 使用独立构建入口;不要从根入口或 `/runtime` 导入 CLI 模块。
|
|
40
|
+
|
|
41
|
+
当前执行器采用 integration v3、toolchain v3、工程锁 v2 和 receipt v2。SDK 自包含协议与声明,
|
|
42
|
+
`protocol` 记录固定协议字段版本及 Schema 内容摘要;旧锁或 receipt 必须显式迁移或重新构建。
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# `@dp-bohrium/widget-sdk` 变更记录
|
|
2
2
|
|
|
3
|
+
## 0.7.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- af5aee4: 破坏性变更:取消 `files.read` 的累计字节额度,让文件预览和 Panel 可以持续读取已授权文件。
|
|
8
|
+
`resourceBudget.files.readBytesPerRun` 与读取 grant 的 `bytesPerRun` 改为已废弃的可选历史字段;
|
|
9
|
+
新宿主不再下发或执行这两项额度。单次大小、调用频率、并发、授权以及写入、下载和状态预算不变。
|
|
10
|
+
|
|
11
|
+
消费者须先升级协议与宿主校验器,再省略旧字段;仍要求历史字段的旧宿主不能消费新配置。
|
|
12
|
+
- 破坏性变更:SDK 自包含协议类型、Schema、测试语料和 `bohr-widget` 命令,Widget 工程只需安装 SDK。
|
|
13
|
+
Host 或控制面可使用 SDK 的协议子入口,也可独立安装同版 `@dp-bohrium/widget-contracts@0.7.0`。
|
|
14
|
+
|
|
15
|
+
integration/toolchain 升为 v3,工程锁和构建回执(receipt)升为 v2。旧工程须保留原源码,
|
|
16
|
+
在新目录按当前模板迁移并重新构建;旧格式的锁和回执不能直接复用。
|
|
17
|
+
|
|
18
|
+
### Patch Changes
|
|
19
|
+
|
|
20
|
+
- 86773d8: 修复开发 Host 面板投影使用 `snapshot.id` 而被正式 Host 拒绝的问题,统一输出既有契约要求的
|
|
21
|
+
`snapshot.panelType`,并同步开发会话类型声明。Manifest 的 `contribution.id` 和
|
|
22
|
+
RenderRequest 的 `content.id` 保持原义。
|
|
23
|
+
|
|
3
24
|
## 0.6.0
|
|
4
25
|
|
|
5
26
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# @dp-bohrium/widget-sdk
|
|
2
2
|
|
|
3
|
-
Agent 使用入口:先读 [`llms.txt`](./llms.txt) 获取文档索引,再读 [`AGENTS.md`](./AGENTS.md)
|
|
4
|
-
获取安装、运行时调用和错误恢复规则。
|
|
5
|
-
|
|
6
3
|
Widget 开发者 SDK,也是创建、构建、校验、开发和打包 Widget 的统一安装入口。普通作者只实现
|
|
7
4
|
`activate(context)` 和可选的 `deactivate()`;SDK 自带的 `bohr-widget` 会生成 Widget Host 入口,
|
|
8
5
|
负责向 Host 宣告 Bundle、接收转移过来的 `MessagePort`,并暴露共享的
|
|
9
6
|
生命周期与能力协议。作者无需直接处理 `window.postMessage`,也无需手动启动插件。
|
|
10
7
|
|
|
8
|
+
使用 Agent 开发时,先读 [`llms.txt`](./llms.txt) 获取文档索引,再读 [`AGENTS.md`](./AGENTS.md)
|
|
9
|
+
了解安装、运行时调用和错误恢复规则。
|
|
10
|
+
|
|
11
11
|
激活事件目录、`context.events` 与低层 `topic` 的边界以本包的 `AGENTS.md`、本 README
|
|
12
12
|
和本包公开的类型与 Schema 为准;协议实现保持同一份事实源。
|
|
13
13
|
|
|
@@ -22,8 +22,7 @@ Widget 开发者 SDK,也是创建、构建、校验、开发和打包 Widget
|
|
|
22
22
|
|
|
23
23
|
## 安装
|
|
24
24
|
|
|
25
|
-
|
|
26
|
-
不再要求使用者单独选择版本。
|
|
25
|
+
安装 SDK 即可获得 Widget API、协议类型、JSON Schema、测试工具和 `bohr-widget` 命令。
|
|
27
26
|
|
|
28
27
|
```bash
|
|
29
28
|
npm install @dp-bohrium/widget-sdk
|
|
@@ -41,17 +40,10 @@ pnpm exec bohr-widget build .
|
|
|
41
40
|
pnpm exec bohr-widget check .
|
|
42
41
|
```
|
|
43
42
|
|
|
44
|
-
`@dp-bohrium/widget-cli` 的现有直接安装方式暂按现行发布治理保留,只作为过渡分发、
|
|
45
|
-
历史审计和废弃诊断。作者工程统一只直接安装 SDK;两包提供同名 `bohr-widget`,同时安装时
|
|
46
|
-
不保证保留旧 CLI 身份。旧工程须移除 CLI、重新安装,并由 SDK `build` 重建 receipt 后再打包,
|
|
47
|
-
见[单 SDK 迁移步骤](https://dev.dp.tech/bohrium-widget-sdk/reference/versioning)。SDK 不回选旧执行器,
|
|
48
|
-
receipt 校验保持严格。
|
|
49
|
-
|
|
50
43
|
常用作者类型从本包根入口导入;完整协议从 `@dp-bohrium/widget-sdk/contracts` 导入,
|
|
51
|
-
编辑器 Schema 使用 `@dp-bohrium/widget-sdk/schemas/*.json
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
本轮统一入口切换发布 R1 前移除,见[迁移计划](https://dev.dp.tech/bohrium-widget-sdk/reference/versioning)。
|
|
44
|
+
编辑器 Schema 使用 `@dp-bohrium/widget-sdk/schemas/*.json`,协议测试语料使用
|
|
45
|
+
`@dp-bohrium/widget-sdk/conformance/*`。升级已有工程时,参照
|
|
46
|
+
[版本兼容](https://dev.dp.tech/bohrium-widget-sdk/reference/versioning)。
|
|
55
47
|
|
|
56
48
|
在自己的 `package.json` 里钉死精确 SemVer,不要用 `^` 或裸 `latest`。SDK 运行时会从已安装
|
|
57
49
|
包自身读取版本,插件源码和 Manifest 不需要再次填写 SDK 版本。
|
|
@@ -361,7 +353,6 @@ import { MockWidgetHost } from "@dp-bohrium/widget-sdk/testing";
|
|
|
361
353
|
本地等待,已发出的服务端读取可能完成,但结果被忽略。
|
|
362
354
|
- Host 发来畸形 Bridge 信封或载荷时,transport 报结构化 `MESSAGE_INVALID` 并关闭
|
|
363
355
|
连接,不会让 Widget 悬等。
|
|
364
|
-
- contracts 维护 Schema 与类型的内部唯一事实源;使用者从 SDK 的 `/contracts` 与 `/schemas/*` 公开出口读取。
|
|
365
356
|
|
|
366
357
|
## 许可证
|
|
367
358
|
|
|
@@ -821,7 +821,6 @@
|
|
|
821
821
|
"additionalProperties": false,
|
|
822
822
|
"required": [
|
|
823
823
|
"bytesPerRequest",
|
|
824
|
-
"bytesPerRun",
|
|
825
824
|
"callsPerMinute"
|
|
826
825
|
],
|
|
827
826
|
"properties": {
|
|
@@ -830,6 +829,8 @@
|
|
|
830
829
|
"minimum": 1
|
|
831
830
|
},
|
|
832
831
|
"bytesPerRun": {
|
|
832
|
+
"description": "历史读取累计额度字段,仅为兼容旧配置保留;当前 files.read 不累计或执行此额度,新宿主不再下发。",
|
|
833
|
+
"deprecated": true,
|
|
833
834
|
"type": "integer",
|
|
834
835
|
"minimum": 1
|
|
835
836
|
},
|
|
@@ -1998,13 +1999,16 @@
|
|
|
1998
1999
|
"additionalProperties": false,
|
|
1999
2000
|
"required": [
|
|
2000
2001
|
"readBytesPerRequest",
|
|
2001
|
-
"readBytesPerRun",
|
|
2002
2002
|
"callsPerMinute",
|
|
2003
2003
|
"listPageSize"
|
|
2004
2004
|
],
|
|
2005
2005
|
"properties": {
|
|
2006
2006
|
"readBytesPerRequest": { "type": "integer", "minimum": 1 },
|
|
2007
|
-
"readBytesPerRun": {
|
|
2007
|
+
"readBytesPerRun": {
|
|
2008
|
+
"description": "历史读取累计额度字段,仅为兼容旧配置保留;当前 files.read 不累计或执行此额度,新宿主不再下发。",
|
|
2009
|
+
"deprecated": true,
|
|
2010
|
+
"type": "integer", "minimum": 1
|
|
2011
|
+
},
|
|
2008
2012
|
"callsPerMinute": { "type": "integer", "minimum": 1 },
|
|
2009
2013
|
"listPageSize": { "type": "integer", "minimum": 1 },
|
|
2010
2014
|
"writeBytesPerRequest": {
|
package/assets/toolchain.json
CHANGED
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
{
|
|
2
|
-
"formatVersion":
|
|
2
|
+
"formatVersion": 3,
|
|
3
3
|
"packageName": "@dp-bohrium/widget-sdk",
|
|
4
|
-
"cli": "0.
|
|
4
|
+
"cli": "0.7.0",
|
|
5
5
|
"profile": {
|
|
6
|
-
"id": "widget-sdk-0.
|
|
7
|
-
"sdk": "0.
|
|
8
|
-
|
|
6
|
+
"id": "widget-sdk-0.7.0",
|
|
7
|
+
"sdk": "0.7.0"
|
|
8
|
+
},
|
|
9
|
+
"protocol": {
|
|
10
|
+
"schemaVersion": 1,
|
|
11
|
+
"hostApiVersion": 1,
|
|
12
|
+
"digest": "sha256:ee3023e337559bbf83c096365fe1eb49ce6809a880a5e5d65e2a2f6fd53a7ddb"
|
|
9
13
|
},
|
|
10
14
|
"hostAcceptance": "unknown",
|
|
11
15
|
"documentation": {
|
|
@@ -16,9 +20,9 @@
|
|
|
16
20
|
"llms": "https://dev.dp.tech/bohrium-widget-sdk/llms.txt"
|
|
17
21
|
},
|
|
18
22
|
"digests": {
|
|
19
|
-
"compiler": "sha256:
|
|
20
|
-
"validators": "sha256:
|
|
21
|
-
"schemas": "sha256:
|
|
22
|
-
"templates": "sha256:
|
|
23
|
+
"compiler": "sha256:6b6ac1585a3f2bc0f8b2717b2475584a502a9026045b840337547528b7a063b0",
|
|
24
|
+
"validators": "sha256:8712fb004d9decf1eeae56c1e7057092a8abc0eeae1093c29546bb56e3261922",
|
|
25
|
+
"schemas": "sha256:ee3023e337559bbf83c096365fe1eb49ce6809a880a5e5d65e2a2f6fd53a7ddb",
|
|
26
|
+
"templates": "sha256:60f555788f33fb38d707525f571d13b6fa78875be7d2d87cb864db6926a52ccb"
|
|
23
27
|
}
|
|
24
28
|
}
|