Files
Genarrative/server-rs/crates/shared-contracts
suzmii c5df56d855 补齐资源 kind 别名表:ui 归 UI 交互,game-* 归代码,animation 归角色
- TS 侧 GAME_CREATION_APP_LEGACY_ASSET_KINDS 补 5 条别名:ui → ui-design、game-entry/game-script/game-style → code、animation → character-animation、asset → image
- Rust 侧 canonical_game_creation_app_asset_kind 同步补齐同一批别名,两侧必须成对维护
- 按拍板口径不往 GAME_CREATION_APP_CANONICAL_ASSET_KINDS 加新 kind,避免出现 ui 与 ui-design 两个同义 kind
- 保持 art-spritesheet-slice → icon → ui-interaction 不动
- 补注释写明别名表的职责是「线上值 → canonical」而非仅收历史遗留,画板导出等现役写入侧同样要在这里收口
- 新增 assetKindCanonicalMapping.test.ts:解析 Rust 源码交叉钉住两侧 canonical 目录与别名映射逐条一致,并逐条断言已拍板的 kind → canonical → 栏目口径
- 新增 resourceCardPreviewRealManifest.test.ts:按真机 manifest 逐条形状可执行地数出预览分支与栏目分布(raster-image 52 / placeholder 8 / code 1;unclassified 58 / ui-interaction 2 / scene 1)
- 真机取证用例同时钉住「别名只救新登记、不救存量」:57 条 ui 的落盘 category 仍是 unclassified,需读时重派生或一次性回填才能归位
- 修正两条按旧错误栏目断言的既有用例:kind=ui 的上传图归「UI 交互」、animation 视频归「角色与对象」
2026-09-10 21:18:55 +08:00
..

shared-contracts 共享 crate 说明

日期:2026-04-21

1. crate 职责

shared-contracts 是前后端兼容 contract 共享 crate,后续负责:

  1. HTTP 请求与响应 DTO
  2. SSE 事件结构与事件名约定
  3. response envelope、错误结构、兼容头部契约
  4. 各模块对外暴露的共享协议类型

2. 当前阶段说明

当前阶段已完成 Stage1 最小真实落地:

  1. 统一 response envelope / 头部常量
  2. auth/login-options
  3. auth/me
  4. auth/sessions
  5. runtime/settings

当前阶段继续补齐的 Stage2 鉴权 DTO:

  1. auth/entry
  2. auth/refresh
  3. auth/logout
  4. auth/logout-all
  5. auth/phone/send-code
  6. auth/phone/login
  7. auth/wechat/start
  8. auth/wechat/callback
  9. auth/wechat/bind-phone
  10. auth/wechat/miniprogram-login

当前阶段继续补齐的 Stage3 公开请求 DTO:

  1. assets/direct-upload-tickets
  2. assets/read-url
  3. assets/objects/confirm
  4. assets/objects/bind
  5. story-sessions/begin
  6. story-sessions/continue

当前阶段继续补齐的 Stage4 显式成功响应 DTO:

  1. assets/direct-upload-tickets
  2. assets/read-url
  3. assets/objects/confirm
  4. assets/objects/bind
  5. story-sessions/begin
  6. story-sessions/continue

当前阶段新增 Stage6 character visual 兼容 DTO

  1. assets/character-visual/generate
  2. assets/character-visual/jobs/:taskId
  3. assets/character-visual/publish

当前阶段新增 Stage7 character animation 模板与导入兼容 DTO

  1. assets/character-animation/templates
  2. assets/character-animation/import-video

当前阶段新增 Stage8 character workflow cache 第一批兼容 DTO

  1. assets/character-workflow-cache
  2. assets/character-workflow-cache/:characterId

当前阶段新增 Stage9 character animation 主链兼容 DTO

  1. assets/character-animation/generate
  2. assets/character-animation/jobs/:taskId
  3. assets/character-animation/publish

当前阶段新增 Stage5 story session scoped runtime story 写读 DTO

  1. BeginStoryRuntimeSessionRequest
  2. ResolveStoryRuntimeActionRequest
  3. StoryRuntimeProjectionResponse
  4. StoryRuntimeMutationResponse
  5. StoryRuntimeSnapshotPayload 仅用于 story session scoped 写侧持久化边界,不复用旧 /api/runtime/story/* 总入口 contract。

WP-DEL 已删除旧 runtime story HTTP DTORuntimeStoryStateResolveRequestRuntimeStoryBootstrapRequest/ResponseRuntimeStoryActionResponse 和旧 RuntimeStorySnapshotPayloadruntime_story 模块中仍保留的 RuntimeStoryViewModelRuntimeStoryPresentationRuntimeStoryPatch 与 battle presentation 是当前投影/表现构件,不作为旧 HTTP 写入口。

当前仍刻意未做:

  1. SSE 事件结构
  2. 自动代码生成或跨语言 contract 同步
  3. 其他尚未收口模块的 handler 响应体显式 DTO 化

3. 边界约束

  1. shared-contracts 只放协议类型与兼容结构,不承接业务规则、供应商适配或状态写入逻辑。
  2. 各模块 crate 对外暴露的协议优先复用这里的共享定义,避免重复散落。
  3. 前端兼容契约一旦进入本 crate,就必须与任务清单和基线文档同步维护。
  4. assets 模块依赖 platform-oss 的稳定返回类型,默认通过 oss-contracts feature 给 api-server 使用;SpacetimeDB WASM 构建链路必须通过 workspace 依赖关闭默认 feature,避免把 platform-oss / reqwest / wasm-bindgen 带进 spacetime-module