schema.ts 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378
  1. import { sql } from 'drizzle-orm'
  2. import { index, integer, primaryKey, real, sqliteTable, text } from 'drizzle-orm/sqlite-core'
  3. import type {
  4. FileAccessPolicy, InteractionRequest, InteractionResponse, McpToolPolicy, PermissionMode, ProfileSnapshot, TeamDebug, TeamFileRef, TeamLimitKey, TeamLimits,
  5. } from '@agent-server/shared'
  6. const now = sql`(strftime('%Y-%m-%dT%H:%M:%fZ','now'))`
  7. const createdAt = () => text('created_at').notNull().default(now)
  8. const updatedAt = () => text('updated_at').notNull().default(now)
  9. export const apiKeys = sqliteTable('api_keys', {
  10. id: text('id').primaryKey(),
  11. name: text('name').notNull(),
  12. keyHash: text('key_hash').notNull().unique(),
  13. keyPrefix: text('key_prefix').notNull(),
  14. enabled: integer('enabled', { mode: 'boolean' }).notNull().default(true),
  15. /** 这个平台可以使用的 Profile(至少一个) */
  16. allowedProfileIds: text('allowed_profile_ids', { mode: 'json' }).$type<string[]>().notNull().default(sql`'[]'`),
  17. /** 平台创建会话时不指定 Profile 则使用它,必须在 allowedProfileIds 中 */
  18. defaultProfileId: text('default_profile_id'),
  19. createdAt: createdAt(),
  20. lastUsedAt: text('last_used_at'),
  21. })
  22. export const profiles = sqliteTable('profiles', {
  23. id: text('id').primaryKey(),
  24. name: text('name').notNull(),
  25. description: text('description').notNull().default(''),
  26. provider: text('provider', { enum: ['claude', 'codex'] }).notNull(),
  27. model: text('model').notNull(),
  28. systemPrompt: text('system_prompt').notNull().default(''),
  29. permissionMode: text('permission_mode').$type<PermissionMode>().notNull().default('ask'),
  30. allowedTools: text('allowed_tools', { mode: 'json' }).$type<string[]>().notNull().default(sql`'[]'`),
  31. disallowedTools: text('disallowed_tools', { mode: 'json' }).$type<string[]>().notNull().default(sql`'[]'`),
  32. skills: text('skills', { mode: 'json' }).$type<string[] | 'all'>().notNull().default(sql`'"all"'`),
  33. fileAccess: text('file_access', { mode: 'json' }).$type<FileAccessPolicy>().notNull(),
  34. knowledgeRootIds: text('knowledge_root_ids', { mode: 'json' }).$type<string[]>().notNull().default(sql`'[]'`),
  35. mcpServerIds: text('mcp_server_ids', { mode: 'json' }).$type<string[]>().notNull().default(sql`'[]'`),
  36. isDefault: integer('is_default', { mode: 'boolean' }).notNull().default(false),
  37. /** 内置 Profile(通用助手、组长)不可删除 */
  38. builtin: integer('builtin', { mode: 'boolean' }).notNull().default(false),
  39. /** 内置 Profile 的种类:空为通用助手,lead 为组长(docs/design/13-bot-teams.md §17) */
  40. builtinKey: text('builtin_key').$type<'lead'>(),
  41. version: integer('version').notNull().default(1),
  42. createdAt: createdAt(),
  43. updatedAt: updatedAt(),
  44. })
  45. export const knowledgeRoots = sqliteTable('knowledge_roots', {
  46. id: text('id').primaryKey(),
  47. name: text('name').notNull(),
  48. path: text('path').notNull(),
  49. description: text('description').notNull().default(''),
  50. access: text('access', { enum: ['read', 'write'] }).notNull().default('read'),
  51. enabled: integer('enabled', { mode: 'boolean' }).notNull().default(true),
  52. createdAt: createdAt(),
  53. updatedAt: updatedAt(),
  54. })
  55. export const sessions = sqliteTable('sessions', {
  56. id: text('id').primaryKey(),
  57. /** 调用来源:API Key id,或后台的 'admin' */
  58. source: text('source').notNull(),
  59. profileId: text('profile_id'),
  60. provider: text('provider', { enum: ['claude', 'codex'] }).notNull(),
  61. model: text('model').notNull(),
  62. /** 为空表示跟随 Profile;只有后台管理员可以为单个会话覆盖 */
  63. permissionMode: text('permission_mode').$type<PermissionMode>(),
  64. systemPromptAppend: text('system_prompt_append').notNull().default(''),
  65. providerSessionId: text('provider_session_id'),
  66. workspaceDir: text('workspace_dir').notNull(),
  67. title: text('title').notNull().default(''),
  68. lastSeq: integer('last_seq').notNull().default(0),
  69. archived: integer('archived', { mode: 'boolean' }).notNull().default(false),
  70. createdAt: createdAt(),
  71. updatedAt: updatedAt(),
  72. }, t => [index('sessions_source_idx').on(t.source, t.updatedAt)])
  73. export const runs = sqliteTable('runs', {
  74. id: text('id').primaryKey(),
  75. sessionId: text('session_id').notNull(),
  76. status: text('status', { enum: ['queued', 'running', 'waiting_input', 'completed', 'failed', 'interrupted'] }).notNull(),
  77. startedAt: text('started_at'),
  78. endedAt: text('ended_at'),
  79. inputTokens: integer('input_tokens'),
  80. outputTokens: integer('output_tokens'),
  81. cacheReadTokens: integer('cache_read_tokens'),
  82. cacheWriteTokens: integer('cache_write_tokens'),
  83. costUsd: real('cost_usd'),
  84. error: text('error'),
  85. createdAt: createdAt(),
  86. }, t => [index('runs_session_idx').on(t.sessionId)])
  87. export const events = sqliteTable('events', {
  88. sessionId: text('session_id').notNull(),
  89. seq: integer('seq').notNull(),
  90. runId: text('run_id'),
  91. type: text('type').notNull(),
  92. payload: text('payload', { mode: 'json' }).notNull(),
  93. ts: text('ts').notNull(),
  94. }, t => [primaryKey({ columns: [t.sessionId, t.seq] })])
  95. export const interactions = sqliteTable('interactions', {
  96. id: text('id').primaryKey(),
  97. sessionId: text('session_id').notNull(),
  98. runId: text('run_id').notNull(),
  99. kind: text('kind', { enum: ['approval', 'question'] }).notNull(),
  100. request: text('request', { mode: 'json' }).$type<InteractionRequest>().notNull(),
  101. response: text('response', { mode: 'json' }).$type<InteractionResponse>(),
  102. status: text('status', { enum: ['pending', 'allowed', 'denied', 'answered', 'timeout', 'cancelled'] }).notNull(),
  103. createdAt: createdAt(),
  104. resolvedAt: text('resolved_at'),
  105. expiresAt: text('expires_at').notNull(),
  106. }, t => [index('interactions_session_idx').on(t.sessionId, t.status)])
  107. export const files = sqliteTable('files', {
  108. id: text('id').primaryKey(),
  109. sessionId: text('session_id').notNull(),
  110. relPath: text('rel_path').notNull(),
  111. origin: text('origin', { enum: ['upload', 'agent'] }).notNull(),
  112. mime: text('mime').notNull(),
  113. size: integer('size').notNull(),
  114. mtimeMs: real('mtime_ms').notNull(),
  115. createdAt: createdAt(),
  116. updatedAt: updatedAt(),
  117. }, t => [index('files_session_path_idx').on(t.sessionId, t.relPath)])
  118. export const settings = sqliteTable('settings', {
  119. key: text('key').primaryKey(),
  120. value: text('value', { mode: 'json' }).notNull(),
  121. updatedAt: updatedAt(),
  122. })
  123. export const auditLogs = sqliteTable('audit_logs', {
  124. id: integer('id').primaryKey({ autoIncrement: true }),
  125. ts: text('ts').notNull().default(now),
  126. actor: text('actor').notNull(),
  127. sessionId: text('session_id'),
  128. kind: text('kind', { enum: ['command', 'file_access_denied', 'network_denied', 'approval', 'admin', 'gateway_call'] }).notNull(),
  129. summary: text('summary').notNull(),
  130. detail: text('detail', { mode: 'json' }),
  131. }, t => [index('audit_ts_idx').on(t.ts)])
  132. export const adminSessions = sqliteTable('admin_sessions', {
  133. id: text('id').primaryKey(),
  134. createdAt: createdAt(),
  135. expiresAt: text('expires_at').notNull(),
  136. })
  137. /** 按天汇总的用量(Run 结束时累加;删除会话不影响历史用量)。日期为服务器本地日期 */
  138. export const usageDaily = sqliteTable('usage_daily', {
  139. date: text('date').notNull(),
  140. /** API Key id,或后台的 'admin' */
  141. source: text('source').notNull(),
  142. provider: text('provider').notNull(),
  143. model: text('model').notNull(),
  144. runs: integer('runs').notNull().default(0),
  145. failed: integer('failed').notNull().default(0),
  146. interrupted: integer('interrupted').notNull().default(0),
  147. inputTokens: integer('input_tokens').notNull().default(0),
  148. outputTokens: integer('output_tokens').notNull().default(0),
  149. cacheReadTokens: integer('cache_read_tokens').notNull().default(0),
  150. cacheWriteTokens: integer('cache_write_tokens').notNull().default(0),
  151. costUsd: real('cost_usd').notNull().default(0),
  152. durationMs: integer('duration_ms').notNull().default(0),
  153. }, t => [primaryKey({ columns: [t.date, t.source, t.provider, t.model] })])
  154. /** Profile 的历史版本:每次内容变化保存一份快照(不含"是否默认"),可以查看和恢复 */
  155. export const profileVersions = sqliteTable('profile_versions', {
  156. profileId: text('profile_id').notNull(),
  157. version: integer('version').notNull(),
  158. snapshot: text('snapshot', { mode: 'json' }).$type<ProfileSnapshot>().notNull(),
  159. createdAt: createdAt(),
  160. }, t => [primaryKey({ columns: [t.profileId, t.version] })])
  161. /** 第三方 MCP 服务(经 MCP Gateway 转接,ADR-0021)。headers / env 中含密钥,只在服务端使用 */
  162. export const mcpServers = sqliteTable('mcp_servers', {
  163. id: text('id').primaryKey(),
  164. name: text('name').notNull().unique(),
  165. title: text('title').notNull(),
  166. description: text('description').notNull().default(''),
  167. transport: text('transport', { enum: ['http', 'stdio'] }).notNull(),
  168. enabled: integer('enabled', { mode: 'boolean' }).notNull().default(true),
  169. url: text('url').notNull().default(''),
  170. headers: text('headers', { mode: 'json' }).$type<Record<string, string>>().notNull().default(sql`'{}'`),
  171. command: text('command').notNull().default(''),
  172. args: text('args', { mode: 'json' }).$type<string[]>().notNull().default(sql`'[]'`),
  173. env: text('env', { mode: 'json' }).$type<Record<string, string>>().notNull().default(sql`'{}'`),
  174. allowNetwork: integer('allow_network', { mode: 'boolean' }).notNull().default(false),
  175. readPaths: text('read_paths', { mode: 'json' }).$type<string[]>().notNull().default(sql`'[]'`),
  176. writePaths: text('write_paths', { mode: 'json' }).$type<string[]>().notNull().default(sql`'[]'`),
  177. /** 工具策略(工具名 → auto / ask / off);没有设置的工具按默认:只读工具 auto,其余 ask */
  178. toolPolicies: text('tool_policies', { mode: 'json' }).$type<Record<string, McpToolPolicy>>().notNull().default(sql`'{}'`),
  179. /** 最近一次列出的工具(引擎列工具时直接使用,不必每次启动服务) */
  180. toolsCache: text('tools_cache', { mode: 'json' }).$type<McpCachedTool[]>().notNull().default(sql`'[]'`),
  181. toolsUpdatedAt: text('tools_updated_at'),
  182. createdAt: createdAt(),
  183. updatedAt: updatedAt(),
  184. })
  185. export interface McpCachedTool {
  186. name: string
  187. description: string
  188. inputSchema: Record<string, unknown>
  189. readOnly: boolean
  190. }
  191. /** 文件清单:相对路径 → 内容摘要与大小(内容存放在按 sha256 寻址的文件库中) */
  192. export type FileMap = Record<string, { sha: string; size: number }>
  193. /** 自定义技能(docs/design/12-custom-skills.md)。运行时只读 custom-skills/skills/<name> 下的生效版本 */
  194. export const customSkills = sqliteTable('custom_skills', {
  195. id: text('id').primaryKey(),
  196. name: text('name').notNull().unique(),
  197. description: text('description').notNull().default(''),
  198. origin: text('origin', { enum: ['authored', 'imported'] }).notNull(),
  199. sourceId: text('source_id'),
  200. enabled: integer('enabled', { mode: 'boolean' }).notNull().default(true),
  201. includeInAll: integer('include_in_all', { mode: 'boolean' }).notNull().default(false),
  202. publishedVersion: integer('published_version'),
  203. latestVersion: integer('latest_version').notNull().default(0),
  204. /** 编辑中的文件(尚未保存为版本的改动) */
  205. workingFiles: text('working_files', { mode: 'json' }).$type<FileMap>().notNull().default(sql`'{}'`),
  206. createdAt: createdAt(),
  207. updatedAt: updatedAt(),
  208. })
  209. export const customSkillVersions = sqliteTable('custom_skill_versions', {
  210. skillId: text('skill_id').notNull(),
  211. version: integer('version').notNull(),
  212. reason: text('reason', { enum: ['create', 'edit', 'import', 'sync', 'restore'] }).notNull(),
  213. files: text('files', { mode: 'json' }).$type<FileMap>().notNull(),
  214. changed: text('changed', { mode: 'json' }).$type<{ added: string[]; modified: string[]; removed: string[] }>().notNull(),
  215. createdAt: createdAt(),
  216. }, t => [primaryKey({ columns: [t.skillId, t.version] })])
  217. /** 技能源:服务器目录或上传的 zip(解压在数据目录中) */
  218. export const skillSources = sqliteTable('skill_sources', {
  219. id: text('id').primaryKey(),
  220. name: text('name').notNull(),
  221. description: text('description').notNull().default(''),
  222. kind: text('kind', { enum: ['directory', 'upload'] }).notNull(),
  223. path: text('path').notNull(),
  224. syncMode: text('sync_mode', { enum: ['manual', 'auto'] }).notNull().default('manual'),
  225. intervalMin: integer('interval_min').notNull().default(10),
  226. lastSyncAt: text('last_sync_at'),
  227. lastSyncDigest: text('last_sync_digest'),
  228. status: text('status', { enum: ['never', 'ok', 'error'] }).notNull().default('never'),
  229. lastError: text('last_error'),
  230. createdAt: createdAt(),
  231. updatedAt: updatedAt(),
  232. })
  233. /** 机器人(docs/design/13-bot-teams.md):身份 + 关联的 Profile */
  234. export const bots = sqliteTable('bots', {
  235. id: text('id').primaryKey(),
  236. name: text('name').notNull().unique(),
  237. avatar: text('avatar').notNull().default('🤖'),
  238. kind: text('kind', { enum: ['lead', 'worker'] }).notNull(),
  239. description: text('description').notNull().default(''),
  240. profileId: text('profile_id').notNull(),
  241. enabled: integer('enabled', { mode: 'boolean' }).notNull().default(true),
  242. createdAt: createdAt(),
  243. updatedAt: updatedAt(),
  244. })
  245. /** Bot API 的密钥(ADR-0024),与 api_keys 互不通用 */
  246. export const botApiKeys = sqliteTable('bot_api_keys', {
  247. id: text('id').primaryKey(),
  248. name: text('name').notNull(),
  249. keyHash: text('key_hash').notNull().unique(),
  250. keyPrefix: text('key_prefix').notNull(),
  251. enabled: integer('enabled', { mode: 'boolean' }).notNull().default(true),
  252. allowedBotIds: text('allowed_bot_ids', { mode: 'json' }).$type<string[]>().notNull().default(sql`'[]'`),
  253. createdAt: createdAt(),
  254. lastUsedAt: text('last_used_at'),
  255. })
  256. export const teams = sqliteTable('teams', {
  257. id: text('id').primaryKey(),
  258. /** Bot Key id,或后台的 'admin' */
  259. source: text('source').notNull(),
  260. title: text('title').notNull().default(''),
  261. human: text('human', { mode: 'json' }).$type<{ id: string; name: string }>().notNull(),
  262. status: text('status', { enum: ['active', 'paused', 'closed'] }).notNull().default('active'),
  263. /** 共享目录:组内所有机器人会话的工作目录 */
  264. workspaceDir: text('workspace_dir').notNull(),
  265. /** 限额:创建时以系统设置为准,可以调低 */
  266. limits: text('limits', { mode: 'json' }).$type<Partial<TeamLimits>>(),
  267. /** 调试设置(仅 admin 的工作组) */
  268. debug: text('debug', { mode: 'json' }).$type<TeamDebug>().notNull().default(sql`'{"stepMode":false,"stubBotIds":[]}'`),
  269. lastSeq: integer('last_seq').notNull().default(0),
  270. /** 由回归用例重放创建时的用例 id */
  271. caseId: text('case_id'),
  272. createdAt: createdAt(),
  273. updatedAt: updatedAt(),
  274. }, t => [index('teams_source_idx').on(t.source, t.updatedAt), index('teams_case_idx').on(t.caseId)])
  275. export const teamBots = sqliteTable('team_bots', {
  276. teamId: text('team_id').notNull(),
  277. botId: text('bot_id').notNull(),
  278. role: text('role', { enum: ['lead', 'worker'] }).notNull(),
  279. joinedAt: text('joined_at').notNull().default(now),
  280. }, t => [primaryKey({ columns: [t.teamId, t.botId] }), index('team_bots_bot_idx').on(t.botId)])
  281. /** 每个"机器人 × 工作组"一个引擎会话;离开工作组后保留,再加入时续接 */
  282. export const teamBotSessions = sqliteTable('team_bot_sessions', {
  283. teamId: text('team_id').notNull(),
  284. botId: text('bot_id').notNull(),
  285. sessionId: text('session_id').notNull().unique(),
  286. /** 已交给这个机器人的工作组事件 seq */
  287. lastReadSeq: integer('last_read_seq').notNull().default(0),
  288. }, t => [primaryKey({ columns: [t.teamId, t.botId] })])
  289. export const teamEvents = sqliteTable('team_events', {
  290. teamId: text('team_id').notNull(),
  291. seq: integer('seq').notNull(),
  292. type: text('type').notNull(),
  293. payload: text('payload', { mode: 'json' }).notNull(),
  294. ts: text('ts').notNull(),
  295. }, t => [primaryKey({ columns: [t.teamId, t.seq] })])
  296. /** 任务:成员交给组长的一项复杂工作,同一工作组内依次执行 */
  297. export const jobs = sqliteTable('jobs', {
  298. id: text('id').primaryKey(),
  299. teamId: text('team_id').notNull(),
  300. no: integer('no').notNull(),
  301. title: text('title').notNull(),
  302. plan: text('plan').notNull().default(''),
  303. status: text('status', { enum: ['running', 'blocked', 'completed', 'failed', 'cancelled'] }).notNull().default('running'),
  304. summary: text('summary'),
  305. files: text('files', { mode: 'json' }).$type<TeamFileRef[]>().notNull().default(sql`'[]'`),
  306. blockedBy: text('blocked_by').$type<TeamLimitKey>(),
  307. /** 本任务生效的限额(继续后加倍) */
  308. limits: text('limits', { mode: 'json' }).$type<Record<TeamLimitKey, number | null>>().notNull(),
  309. leadRuns: integer('lead_runs').notNull().default(0),
  310. /** 本任务产生的全部 Run(组长与子任务),用于统计成本 */
  311. runIds: text('run_ids', { mode: 'json' }).$type<string[]>().notNull().default(sql`'[]'`),
  312. createdAt: createdAt(),
  313. endedAt: text('ended_at'),
  314. }, t => [index('jobs_team_idx').on(t.teamId, t.no)])
  315. /** 子任务:组长分派给某个组员的单项工作 */
  316. export const tasks = sqliteTable('tasks', {
  317. id: text('id').primaryKey(),
  318. jobId: text('job_id').notNull(),
  319. teamId: text('team_id').notNull(),
  320. no: integer('no').notNull(),
  321. botId: text('bot_id').notNull(),
  322. title: text('title').notNull(),
  323. instructions: text('instructions').notNull(),
  324. dependsOn: text('depends_on', { mode: 'json' }).$type<number[]>().notNull().default(sql`'[]'`),
  325. status: text('status', { enum: ['waiting', 'queued', 'running', 'stub', 'completed', 'failed', 'cancelled'] }).notNull(),
  326. result: text('result'),
  327. files: text('files', { mode: 'json' }).$type<TeamFileRef[]>().notNull().default(sql`'[]'`),
  328. runId: text('run_id'),
  329. sessionId: text('session_id'),
  330. createdAt: createdAt(),
  331. startedAt: text('started_at'),
  332. endedAt: text('ended_at'),
  333. }, t => [index('tasks_team_idx').on(t.teamId, t.no), index('tasks_job_idx').on(t.jobId)])
  334. /** 回归用例(docs/design/13-bot-teams.md §12.2):成员组成 + 第一条命令,批量重放后人工比对结果 */
  335. export const teamCases = sqliteTable('team_cases', {
  336. id: text('id').primaryKey(),
  337. name: text('name').notNull(),
  338. leadBotId: text('lead_bot_id'),
  339. workerBotIds: text('worker_bot_ids', { mode: 'json' }).$type<string[]>().notNull().default(sql`'[]'`),
  340. stubBotIds: text('stub_bot_ids', { mode: 'json' }).$type<string[]>().notNull().default(sql`'[]'`),
  341. limits: text('limits', { mode: 'json' }).$type<Partial<TeamLimits>>(),
  342. humanName: text('human_name').notNull(),
  343. text: text('text').notNull(),
  344. mentions: text('mentions', { mode: 'json' }).$type<string[]>().notNull().default(sql`'[]'`),
  345. /** 第一条命令的附件,复制到 <dataDir>/data/team-cases/<id>/ 下 */
  346. files: text('files', { mode: 'json' }).$type<{ name: string; size: number }[]>().notNull().default(sql`'[]'`),
  347. createdAt: createdAt(),
  348. updatedAt: updatedAt(),
  349. })