diff --git a/backend-rewrite-tasklist/01_M0_M2_FOUNDATION_AND_AUTH.md b/backend-rewrite-tasklist/01_M0_M2_FOUNDATION_AND_AUTH.md index 403c2418..18fae868 100644 --- a/backend-rewrite-tasklist/01_M0_M2_FOUNDATION_AND_AUTH.md +++ b/backend-rewrite-tasklist/01_M0_M2_FOUNDATION_AND_AUTH.md @@ -75,7 +75,8 @@ 交付物:[../server-rs/packages/module-editor/README.md](../server-rs/packages/module-editor/README.md) - [x] 创建 `packages/module-ai` 交付物:[../server-rs/packages/module-ai/README.md](../server-rs/packages/module-ai/README.md) -- [ ] 创建 `packages/shared-contracts` +- [x] 创建 `packages/shared-contracts` + 交付物:[../server-rs/packages/shared-contracts/README.md](../server-rs/packages/shared-contracts/README.md) - [ ] 创建 `packages/shared-kernel` - [ ] 创建 `packages/platform-auth` - [ ] 创建 `packages/platform-oss` diff --git a/server-rs/README.md b/server-rs/README.md index dfad9038..67e7bc95 100644 --- a/server-rs/README.md +++ b/server-rs/README.md @@ -14,7 +14,7 @@ ## 2. 当前阶段说明 -当前目录已经完成以下十八项初始化: +当前目录已经完成以下十九项初始化: 1. 为新后端预留正式目录并把路径固定到仓库结构中。 2. 创建虚拟 workspace `Cargo.toml`,后续 package 会逐项挂入。 @@ -34,17 +34,17 @@ 16. 创建 `packages/module-assets/` 目录占位,固定资产任务与对象绑定模块 package 落位。 17. 创建 `packages/module-editor/` 目录占位,固定编辑器读写模块 package 落位。 18. 创建 `packages/module-ai/` 目录占位,固定 AI 编排模块 package 落位。 +19. 创建 `packages/shared-contracts/` 目录占位,固定前后端兼容 contract 共享 package 落位。 后续任务会继续在本目录内按顺序补齐: -1. `packages/shared-contracts` -2. `packages/shared-kernel` -3. `packages/platform-auth` -4. `packages/platform-oss` -5. `packages/platform-llm` -6. `packages/spacetime-client` -7. `packages/tests-support` -8. `scripts/*` +1. `packages/shared-kernel` +2. `packages/platform-auth` +3. `packages/platform-oss` +4. `packages/platform-llm` +5. `packages/spacetime-client` +6. `packages/tests-support` +7. `scripts/*` ## 3. 已冻结边界 diff --git a/server-rs/packages/shared-contracts/README.md b/server-rs/packages/shared-contracts/README.md new file mode 100644 index 00000000..9ef43aa5 --- /dev/null +++ b/server-rs/packages/shared-contracts/README.md @@ -0,0 +1,29 @@ +# shared-contracts 共享 package 占位说明 + +日期:`2026-04-20` + +## 1. package 职责 + +`shared-contracts` 是前后端兼容 contract 共享 package,后续负责: + +1. HTTP 请求与响应 DTO +2. SSE 事件结构与事件名约定 +3. response envelope、错误结构、兼容头部契约 +4. 各模块对外暴露的共享协议类型 + +## 2. 当前阶段说明 + +当前提交仅完成目录占位,不提前进入 DTO、事件与兼容结构实现。 + +后续与本 package 直接相关的任务包括: + +1. 对齐现有前端直接依赖的响应头与 envelope +2. 对齐 story、custom world、chat 等 SSE 事件结构 +3. 对齐 auth、runtime、assets 等兼容 DTO +4. 为 breaking change 建立显式变更边界 + +## 3. 边界约束 + +1. `shared-contracts` 只放协议类型与兼容结构,不承接业务规则、供应商适配或状态写入逻辑。 +2. 各模块 package 对外暴露的协议优先复用这里的共享定义,避免重复散落。 +3. 前端兼容契约一旦进入本 package,就必须与任务清单和基线文档同步维护。