fmode-api.ts 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. import {
  2. Agent,
  3. ArtifactJob,
  4. AuthSession,
  5. ChatThreadRecord,
  6. ChatThreadUpsert,
  7. Deliverable,
  8. DeliverableGroup,
  9. MatrixProvision,
  10. Me,
  11. Task,
  12. UploadTicket,
  13. WorkGroup,
  14. WorkspaceRecord,
  15. WorkspaceUpsert,
  16. } from './models';
  17. /**
  18. * 数据访问抽象接口 —— 应用层与数据源之间的**唯一闸门**
  19. *
  20. * 依据《数据访问层设计.md》§一/§四。硬约束:
  21. * ① 页面/components **禁止** inject(FmodeApi) 或其实现(FR-14 AC-14.2)
  22. * ② 业务服务**禁止**直接 fetch / 直接用 fmode-ng(黄金规则 5)
  23. * ③ 每个数据域**只有一个** owner 服务
  24. *
  25. * 实现:`ParseApi`(真实,走 fmode-ng)/ `MockApi`(演示数据)。
  26. * 切换由 `environment.useMockData` 单开关控制(api.provider.ts)。
  27. *
  28. * ⚠️ `Project` / `EventItem` **不在此接口**:它们是派生投影(由 Agent + Deliverable 组合),
  29. * 由对应服务计算,见《数据访问层设计.md》§四.1。
  30. */
  31. export abstract class FmodeApi {
  32. // ---------- 鉴权 ----------
  33. /** 发送手机验证码(REST R4:`code === 1` 才算成功) */
  34. abstract sendMobileCode(mobile: string): Promise<void>;
  35. /** 验证码登录(REST R5:`code === 200 && data.token` 才算成功) */
  36. abstract loginWithMobile(mobile: string, code: string): Promise<AuthSession>;
  37. /** Token 直登(REST R1:`POST /parse/users/me`) */
  38. abstract loginWithToken(token: string): Promise<AuthSession>;
  39. /** 用已有 token 取回身份 */
  40. abstract fetchMe(token: string): Promise<Me>;
  41. // ---------- 数字生命(实况) ----------
  42. /** 列表查询(云函数 xlosi3m46q,`op:'query'`) */
  43. abstract fetchAgents(): Promise<Agent[]>;
  44. /** 单条查询;`code` 404/403 时返回 null */
  45. abstract fetchAgentStatus(agentId: string): Promise<Agent | null>;
  46. /**
  47. * 重命名容器(**仅公司管理员 / 系统超管**)。
  48. *
  49. * ## 契约(2026-11-04 与后端约定,待实现)
  50. *
  51. * `POST /api/functions`,沿用 `xlosi3m46q` 的写入形态:
  52. * ```
  53. * { id: 'xlosi3m46q', token, params: { op: 'rename', agentId, displayName } }
  54. * → { code: 200, agent?: AgentStatusItem } // 成功
  55. * → { code: 403, msg: '...' } // 无权限
  56. * ```
  57. *
  58. * ## 为什么单独成方法而不是复用 update
  59. *
  60. * 重命名是**跨用户的可见变更**(同公司成员都会看到新名字),
  61. * 与「改自己的偏好」不是一回事 —— 独立方法便于单独做权限校验与审计。
  62. *
  63. * 🔴 服务端未就绪时实现方**必须抛错**,禁止静默改本地(那会制造
  64. * 「我这看着改了、别人看到的还是旧名」的假象)。
  65. */
  66. abstract renameAgent(agentId: string, displayName: string): Promise<Agent | null>;
  67. // ---------- 会话(Matrix) ----------
  68. /** 开通 Matrix 身份(云函数 RP5Ht55NeX);绑定表命中时 `cached: true` */
  69. abstract provisionMatrix(agentId: string): Promise<MatrixProvision>;
  70. /** 校验/刷新凭据(`validate: 1`) */
  71. abstract validateMatrix(agentId: string): Promise<MatrixProvision>;
  72. // ---------- 会话目录(云端持久化) ----------
  73. /**
  74. * 拉取当前用户的会话目录(云函数 `fmodeagent-chatthreads`,`op:'list'`)。
  75. *
  76. * 🔴 云端是会话目录的**唯一真相源**;本地 localStorage 只作渲染缓存。
  77. * 服务端按 sessionToken 强制归属当前用户,本方法不传 user 参数。
  78. */
  79. abstract fetchChatThreads(agentId: string, opts?: { includeDeleted?: boolean }): Promise<ChatThreadRecord[]>;
  80. /** 批量上报会话(新建或补计数/时间;标题仅在为空时写入) */
  81. abstract upsertChatThreads(items: ChatThreadUpsert[]): Promise<void>;
  82. /** 修改标题(置 titleLocked)或归档状态 */
  83. abstract patchChatThread(input: {
  84. threadRoot: string;
  85. title?: string;
  86. archived?: boolean;
  87. /** 归属工作区;`''` = 移回日常对话(2026-11-01 起上云) */
  88. workspaceId?: string;
  89. }): Promise<void>;
  90. /** 软删会话(isDeleted=true;再次收到消息可 revive) */
  91. /** 删除会话索引(云端物理删除 + 留墓碑阻止重建);Matrix 消息不受影响 */
  92. abstract removeChatThread(input: { threadRoot: string; roomId?: string; agentId?: string }): Promise<void>;
  93. // ---------- 工作区(2026-11-01 上云) ----------
  94. /**
  95. * 拉取用户的工作区列表。
  96. *
  97. * 工作区是用户自己整理对话的「文件夹」,此前只存 localStorage ——
  98. * 换设备/清缓存后文件夹全丢,会话归属还在但无处安放。
  99. */
  100. abstract fetchWorkspaces(): Promise<WorkspaceRecord[]>;
  101. /** 新建 / 更新工作区(按 id 幂等) */
  102. abstract upsertWorkspaces(items: WorkspaceUpsert[]): Promise<void>;
  103. /** 删除工作区(软删) */
  104. abstract removeWorkspace(id: string): Promise<void>;
  105. // ---------- 交付成果 ----------
  106. /** 列表(云函数 lfYlgU7SkK,`action:'list'`) */
  107. abstract fetchDeliverables(opts?: { agentId?: string; limit?: number }): Promise<Deliverable[]>;
  108. /** 按项目分组(`action:'byProject'`) */
  109. abstract fetchDeliverablesByProject(limit?: number): Promise<DeliverableGroup[]>;
  110. // ---------- 任务看板(FR-07b) ----------
  111. /**
  112. * 任务列表(按 agentId 过滤)。
  113. * 🔴 云函数接收端**尚未实现**:就绪前实现方须返回**空数组**,**禁止伪造数据**
  114. * (SPEC FR-07b「依赖声明」)。
  115. */
  116. abstract fetchTasks(agentId: string): Promise<Task[]>;
  117. /** 任务详情(含 runs / comments / attachments) */
  118. abstract fetchTaskDetail(taskId: string): Promise<Task | null>;
  119. // ---------- 上传 ----------
  120. /** 取预签名(云函数 AlP56LCKFm);缺 uploadUrl 即抛错,不得静默降级 */
  121. abstract requestUploadUrl(filename: string, mimeType: string, size: number): Promise<UploadTicket>;
  122. /** 预签名直传(前端不经手任何 OBS 密钥) */
  123. abstract uploadFile(
  124. file: File,
  125. onProgress?: (pct: number) => void,
  126. ): Promise<{ key: string; publicUrl: string }>;
  127. // ---------- 成果文件入库(云盘同步) ----------
  128. // ---------- 成果文件搬运队列(容器侧轮询) ----------
  129. /**
  130. * 登记一次搬运:把容器里的 `source` 文件搬到云盘。
  131. *
  132. * 🔴 **只报「传哪个」,不报「传到哪」** —— 上传地址与必需的头由云函数
  133. * 用服务端密钥签好后写进队列,客户端不接触任何密钥
  134. * (2026-10-21 定稿;此前的「App 自签」方案已废弃)。
  135. *
  136. * @param index 附件在成果 `artifacts[]` 中的下标 —— 保证同名附件不互相覆盖
  137. */
  138. abstract enqueueArtifactJob(job: {
  139. deliverableId: string;
  140. agentId: string;
  141. /** 容器内的原始路径 */
  142. source: string;
  143. filename: string;
  144. index: number;
  145. }): Promise<{ id: string }>;
  146. /** 容器领取待办(按 agentId,只取未完成且未过期的) */
  147. abstract fetchArtifactJobs(agentId: string): Promise<ArtifactJob[]>;
  148. /** 容器回执:上传成功(带公网地址)/ 失败(带原因) */
  149. abstract ackArtifactJob(input: {
  150. id: string;
  151. ok: boolean;
  152. publicUrl?: string;
  153. error?: string;
  154. }): Promise<void>;
  155. // ---------- 工作组(多容器协作) ----------
  156. /** 创建工作组(服务端建房 + 邀请 + 写记录) */
  157. abstract createWorkGroup(input: {
  158. name: string;
  159. goal?: string;
  160. memberAgentIds: string[];
  161. }): Promise<{ id: string; roomId: string }>;
  162. /** 我参与的工作组 */
  163. abstract listWorkGroups(): Promise<WorkGroup[]>;
  164. /** 邀请成员 */
  165. abstract inviteToWorkGroup(groupId: string, agentIds: string[]): Promise<void>;
  166. /** 移出成员 */
  167. abstract removeFromWorkGroup(groupId: string, agentId: string): Promise<void>;
  168. /** 归档(不删房间) */
  169. abstract archiveWorkGroup(groupId: string): Promise<void>;
  170. }