SDK 总览
@atomm-developer/generator-sdk 是生成器的平台能力层。
它负责把平台服务开放给生成器，但它不定义壳层 UI，也不替代 runtime contract。
SDK 负责什么
- 登录鉴权
- 云保存与恢复
- 历史记录
- 积分
- 计费
- 导出下载与打开到 Studio
- 模板辅助能力
SDK 不负责什么
- 生成器业务状态
- runtime 挂载协议
- canvas 渲染
- 参数面板布局
- 顶部导航和壳层 UI
如果你需要官方壳层，请看 Generator Workbench。
如果你需要宿主 / runtime 协议，请看 Runtime Contract。
模块地图
| 模块 | 对象 | 责任 | 需要登录 |
|---|---|---|---|
| Auth | sdk.auth | 登录、退出、状态查询、状态监听 | 否 |
| Cloud | sdk.cloud | 云保存、恢复、删除 | 是 |
| History | sdk.history | 历史记录列表、详情、删除 | 是 |
| Credits | sdk.credits | 积分余额与积分扣减 | 是 |
| Billing | sdk.billing | 统一消费流程 | 是 |
| Export | sdk.export | 下载到本地与打开到 Studio | 否 |
| Template | sdk.template | 模板构建、解析、导入以及 runtime snapshot 转换 | 否 |
| Helper | withBilling | 给业务动作加上计费校验和消费包装 | 是 |
推荐接入顺序
- 先看 安装与引入
- 再看 SDK 初始化
- 根据生成器真实需求引入对应模块
- 决定是否使用 Generator Workbench
- 如果生成器要跑在多个宿主场景中，再实现 Runtime Contract
常见误区
- 把
generator-sdk当成壳层来理解 - 在没明确能力需求之前就一次性接所有模块
- 只接入 SDK 就宣称“标准化完成”