gen-doc-graphs.ts 48 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103
  1. /**
  2. * Generate the relationship layer above the module, Cordis, and tool catalogs.
  3. * Enumerable facts come from source; hybrid graphs add manifests for policy the
  4. * source cannot infer, while curated graphs explain flow and ownership.
  5. * `--check` verifies the generated set.
  6. */
  7. import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs'
  8. import { dirname, relative, resolve } from 'node:path'
  9. import ts from 'typescript'
  10. import { collectEvents, collectServices } from './gen-cordis-catalog.ts'
  11. import {
  12. collectPackageGraph,
  13. escapeMermaidLabel as escLabel,
  14. graphNodeId as nodeId,
  15. type PackageGraphNode,
  16. } from './package-graph.ts'
  17. import { TypeScriptProject } from './ts-project.ts'
  18. const root = resolve(import.meta.dirname, '..')
  19. type Pkg = PackageGraphNode
  20. interface GraphDoc {
  21. rel: string
  22. content: string
  23. }
  24. interface ServiceRole {
  25. key: string
  26. pkg: string
  27. title: string
  28. mode: 'core' | 'seam' | 'bundle'
  29. implementations?: string[]
  30. consumers?: string[]
  31. companions?: string[]
  32. note: string
  33. }
  34. interface ExamplePlugin {
  35. id: string
  36. name: string
  37. }
  38. interface EventRelation {
  39. dispatchers: Map<string, Set<string>>
  40. listeners: Set<string>
  41. }
  42. interface PackageSource {
  43. rel: string
  44. pkg: string
  45. sourceFile: ts.SourceFile
  46. }
  47. type EventReceiverKind = 'context' | 'agent-dispatch' | 'events-service'
  48. const GROUP_ORDER = [
  49. 'util',
  50. 'llm',
  51. 'core',
  52. 'goal',
  53. 'bash',
  54. 'sandbox',
  55. 'fs',
  56. 'skill',
  57. 'compact',
  58. 'subagent',
  59. 'tasks',
  60. 'workflow',
  61. 'web',
  62. 'spill',
  63. 'todo',
  64. 'cordis',
  65. 'hooks',
  66. 'session-persistence',
  67. 'session-query',
  68. 'support',
  69. 'ui',
  70. ]
  71. const SERVICE_ROLES: ServiceRole[] = [
  72. {
  73. key: 'llm',
  74. pkg: 'llm',
  75. title: 'LLM adapter registry',
  76. mode: 'seam',
  77. implementations: ['llm-deepseek', 'llm-pi-ai', 'llm-replay'],
  78. consumers: ['agent-loop', 'compact-basic'],
  79. note: 'Adapters register provider implementations; the loop and compaction call the provider-neutral stream service.',
  80. },
  81. {
  82. key: 'tokenMeter',
  83. pkg: 'token-meter',
  84. title: 'Replay token measurement',
  85. mode: 'core',
  86. consumers: ['compact-basic'],
  87. note: 'Owns isolated per-session replay folds; pressure consumers share immutable revisioned measurements.',
  88. },
  89. {
  90. key: 'sessions',
  91. pkg: 'session',
  92. title: 'In-memory session store',
  93. mode: 'core',
  94. consumers: ['agent-loop', 'agent', 'cli-demo', 'session-persistence', 'session-query', 'subagent-inprocess', 'invariants'],
  95. note: 'Owns append-only Session instances and emits the durable session event feed.',
  96. },
  97. {
  98. key: 'sessionPersistence',
  99. pkg: 'session-persistence',
  100. title: 'Durable session persistence seam',
  101. mode: 'seam',
  102. implementations: ['session-persistence-jsonl', 'session-persistence-sqlite'],
  103. consumers: ['agent-loop', 'tool-bash', 'hooks-claude', 'hooks-codex', 'acp', 'session-query'],
  104. note: 'Backends persist the same SessionEvent vocabulary; apps choose a backend at composition time.',
  105. },
  106. {
  107. key: 'sessionQuery',
  108. pkg: 'session-query',
  109. title: 'Exact session-history reads and traces',
  110. mode: 'seam',
  111. note: 'Resolves live and optional persisted logs into one logical corpus for exact reads and relationship traces.',
  112. },
  113. {
  114. key: 'systemPrompt',
  115. pkg: 'system-prompt',
  116. title: 'System prompt assembly registry',
  117. mode: 'core',
  118. consumers: ['agent-loop', 'tools', 'tool-fs', 'tool-web'],
  119. note: 'Collects prompt sections and model-facing tool schemas for each step.',
  120. },
  121. {
  122. key: 'tools',
  123. pkg: 'tools',
  124. title: 'Tool registry and guarded execution pipeline',
  125. mode: 'core',
  126. consumers: ['agent-loop', 'tool-ask-user', 'tool-bash', 'tool-cordis', 'tool-fs', 'tool-skill', 'tool-subagent', 'tool-todo', 'tool-web', 'acp'],
  127. note: 'Registers capabilities, owns Code Mode transport, and routes calls through pre-policy, monotonic guards, around dispatch, post-policy, and final-result observation.',
  128. },
  129. {
  130. key: 'userInteraction',
  131. pkg: 'user-interaction',
  132. title: 'Human question/answer seam',
  133. mode: 'seam',
  134. implementations: ['stdio-demo', 'acp'],
  135. consumers: ['tool-ask-user', 'stdio-demo', 'acp'],
  136. note: 'UI front doors provide the active human-answer provider; tool-ask-user pauses a tool call on the provider-neutral ask() promise.',
  137. },
  138. {
  139. key: 'commands',
  140. pkg: 'commands',
  141. title: 'Human command registry',
  142. mode: 'core',
  143. consumers: ['tui', 'acp'],
  144. note: 'Plugins register direct human commands; TUI and ACP resolve each agent and surface without sending the invocation to the model.',
  145. },
  146. {
  147. key: 'skills',
  148. pkg: 'skill',
  149. title: 'Skill provider registry',
  150. mode: 'seam',
  151. implementations: ['skill-local'],
  152. consumers: ['tool-skill'],
  153. note: 'Merges provider skill catalogs; tool-skill renders the session-prefix catalog and loads complete skill bodies.',
  154. },
  155. {
  156. key: 'agents',
  157. pkg: 'agent',
  158. title: 'Agent service',
  159. mode: 'core',
  160. consumers: ['agent-loop', 'acp', 'cli-demo', 'subagent-inprocess', 'stdio-demo', 'invariants'],
  161. note: 'Owns live Agent handles, the create/resume factory seam, and process-local initiator propagation.',
  162. },
  163. {
  164. key: 'agentLoop',
  165. pkg: 'agent-loop',
  166. title: 'Concrete loop driver',
  167. mode: 'bundle',
  168. consumers: ['agent-spine-demo'],
  169. note: 'The one concrete loop plugin; extension packages depend on dsh-agent events and services, not on this package.',
  170. },
  171. {
  172. key: 'goals',
  173. pkg: 'goal',
  174. title: 'Same-session goal domain',
  175. mode: 'core',
  176. note: 'Folds revisioned objective state from the session log and keeps live continuation activation process-local.',
  177. },
  178. {
  179. key: 'bash',
  180. pkg: 'bash',
  181. title: 'Bash executor seam',
  182. mode: 'seam',
  183. implementations: ['bash-local', 'bash-sandbox'],
  184. consumers: ['tool-bash', 'hooks-claude', 'hooks-codex'],
  185. note: 'The model-facing bash tools and hook bridges consume this seam; sandboxed or remote executors replace bash-local without touching them.',
  186. },
  187. {
  188. key: 'bashEnv',
  189. pkg: 'tool-bash',
  190. title: 'Managed bash environment registry',
  191. mode: 'core',
  192. note: 'Plugins declare effect-scoped DSH_* facts; tool-bash collects one trusted snapshot per execution and the executor rebuilds the namespace.',
  193. },
  194. {
  195. key: 'sandbox',
  196. pkg: 'sandbox',
  197. title: 'Process-sandbox seam',
  198. mode: 'seam',
  199. implementations: ['sandbox-local'],
  200. consumers: ['bash-sandbox'],
  201. note: 'Consumers hand over the exact argv they are about to spawn; same-world backends wrap it under a per-call policy and report enforcement.',
  202. },
  203. {
  204. key: 'approval',
  205. pkg: 'approval',
  206. title: 'Approval seam',
  207. mode: 'seam',
  208. implementations: ['acp'],
  209. consumers: ['tools', 'tool-bash'],
  210. note: 'One-shot permission decisions dispatched over the `approval/request` waterfall; answerers are listeners (the ACP bridge for its own agents), absence fails closed to `unavailable`.',
  211. },
  212. {
  213. key: 'permission',
  214. pkg: 'permission',
  215. title: 'Permission presets',
  216. mode: 'core',
  217. implementations: [],
  218. consumers: ['acp'],
  219. note: 'User-facing preset table (`workspace-write`/`danger-full-access`) bundling the sandbox-mode and approval-policy knobs; a switch writes one `permission/preset` event through to both knob events.',
  220. },
  221. {
  222. key: 'codeRuntime',
  223. pkg: 'code-runtime',
  224. title: 'Code-execution seam',
  225. mode: 'seam',
  226. implementations: ['code-runtime-worker'],
  227. consumers: ['tools'],
  228. note: 'Runs one model-written program against host-provided async bindings; backends differ by substrate and language (the tool registry consumes it for Code Mode).',
  229. },
  230. {
  231. key: 'fs',
  232. pkg: 'fs',
  233. title: 'Filesystem provider seam',
  234. mode: 'seam',
  235. implementations: ['fs-local'],
  236. consumers: ['tool-fs'],
  237. companions: ['fs-policy'],
  238. note: 'tool-fs executes read/write/edit through ctx.fs; fs-policy contributes observed-state checks through the fs/* event gate.',
  239. },
  240. {
  241. key: 'compact',
  242. pkg: 'compact',
  243. title: 'Compaction seam',
  244. mode: 'seam',
  245. implementations: ['compact-basic'],
  246. consumers: ['compact-basic'],
  247. note: 'The basic backend consumes post-step pressure and request-error recovery events; a model-facing compact tool remains deferred.',
  248. },
  249. {
  250. key: 'subagents',
  251. pkg: 'subagent',
  252. title: 'Subagent provider registry',
  253. mode: 'seam',
  254. implementations: ['subagent-spawn', 'subagent-fork', 'subagent-acp'],
  255. consumers: ['tool-subagent'],
  256. note: 'Providers implement transports; tool-subagent exposes one configured provider as a model-facing tool name.',
  257. },
  258. {
  259. key: 'tasks',
  260. pkg: 'tasks',
  261. title: 'Background task registry',
  262. mode: 'core',
  263. consumers: ['tool-bash', 'tool-subagent', 'tool-tasks'],
  264. note: 'Producers (tool-bash background commands, tool-subagent background delegations) register running work; tool-tasks is the model-facing control surface that reads, lists, and kills it.',
  265. },
  266. {
  267. key: 'web',
  268. pkg: 'web',
  269. title: 'Web access provider registry',
  270. mode: 'seam',
  271. implementations: ['web-search-exa', 'web-search-perplexity', 'web-search-deepseek', 'web-fetch-local'],
  272. consumers: ['tool-web'],
  273. note: 'Search and fetch providers register into one ctx.web seam; tool-web owns the stable model-facing names.',
  274. },
  275. {
  276. key: 'spillStore',
  277. pkg: 'spill',
  278. title: 'Spill storage seam',
  279. mode: 'seam',
  280. implementations: ['spill-local'],
  281. consumers: ['spill-policy'],
  282. note: 'The backend saves oversized tool text and returns a model-facing locator plus retrieval hint; spill-policy is the tools/post-execute consumer that decides when to spill.',
  283. },
  284. {
  285. key: 'workflows',
  286. pkg: 'workflow',
  287. title: 'Workflow script engine',
  288. mode: 'seam',
  289. implementations: ['workflow-workerthread'],
  290. consumers: ['tool-workflow'],
  291. note: 'One engine per context (bash shape, no named-provider registry); the worker-thread engine fans agent() calls out through ctx.subagents.',
  292. },
  293. ]
  294. function generatedHeader(title: string): string[] {
  295. return [
  296. '<!-- Generated by scripts/gen-doc-graphs.ts - do not edit by hand.',
  297. ' Run `pnpm run gen-doc-graphs` to regenerate. -->',
  298. '',
  299. `# ${title}`,
  300. '',
  301. ]
  302. }
  303. function maintenanceFooter(source: string): string[] {
  304. return [`Maintenance mode: ${source}.`, '']
  305. }
  306. function graphIndexLink(rel: string): string {
  307. return relative('docs', rel).replaceAll('\\', '/')
  308. }
  309. function linkFromDoc(docRel: string, targetRel: string): string {
  310. return relative(dirname(docRel), targetRel).replaceAll('\\', '/')
  311. }
  312. function mermaidCode(value: string): string {
  313. return `<code>${value.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;')}</code>`
  314. }
  315. function repoLink(path: string, label: string, up = '..'): string {
  316. return `[${label}](${up}/${path})`
  317. }
  318. function sourceLink(source: string, up = '..'): string {
  319. return repoLink(source.split(':')[0] ?? source, `\`${source}\``, up)
  320. }
  321. function pkgLink(pkg: Pkg | undefined, fallback: string, up = '..'): string {
  322. return pkg ? repoLink(pkg.rel, `\`${pkg.short}\``, up) : `\`${fallback}\``
  323. }
  324. function pkgList(names: string[] | undefined, pkgsByShort: Map<string, Pkg>): string {
  325. if (!names || names.length === 0) return '-'
  326. return names.map(name => pkgLink(pkgsByShort.get(name), name)).join(', ')
  327. }
  328. function tableCell(value: string): string {
  329. return value.replace(/\|/g, '\\|').replace(/\n/g, '<br>')
  330. }
  331. function assertServiceRolesComplete(): void {
  332. const discovered = new Set(collectServices().map(service => service.key))
  333. const classified = new Set(SERVICE_ROLES.map(role => role.key))
  334. const missing = [...discovered].filter(key => !classified.has(key)).sort()
  335. const stale = [...classified].filter(key => !discovered.has(key)).sort()
  336. if (missing.length || stale.length) {
  337. throw new Error([
  338. missing.length ? `missing service role classification: ${missing.join(', ')}` : '',
  339. stale.length ? `stale service role classification: ${stale.join(', ')}` : '',
  340. ].filter(Boolean).join('; '))
  341. }
  342. }
  343. function renderCapabilitySeams(pkgs: Pkg[]): string {
  344. assertServiceRolesComplete()
  345. const pkgsByShort = new Map(pkgs.map(pkg => [pkg.short, pkg]))
  346. const maintenance = 'hybrid: services are discovered from Cordis declarations; interface/implementation/consumer roles are classified in `scripts/gen-doc-graphs.ts` with a completeness guard'
  347. const nodes = new Map<string, string>()
  348. const edges = new Set<string>()
  349. const companionEdges = new Set<string>()
  350. const addNode = (id: string, label: string): void => {
  351. if (!nodes.has(id)) nodes.set(id, ` ${id}["${escLabel(label)}"]`)
  352. }
  353. const addEdge = (from: string, to: string): void => { edges.add(` ${from} --> ${to}`) }
  354. const lines = generatedHeader('Capability Seams And Core Services')
  355. lines.push(
  356. 'A service can be a core spine service, a swappable capability seam, or a bundle/composition point. The graph shows the package that owns the service declaration, known implementation packages, and packages that consume the service directly.',
  357. '',
  358. '```mermaid',
  359. 'flowchart LR',
  360. )
  361. for (const role of SERVICE_ROLES) {
  362. const svc = nodeId('svc', role.key)
  363. const owner = nodeId('pkg', role.pkg)
  364. addNode(owner, role.pkg)
  365. addNode(svc, `ctx.${role.key}<br/>${role.title}`)
  366. addEdge(owner, svc)
  367. for (const impl of role.implementations ?? []) {
  368. addNode(nodeId('pkg', impl), impl)
  369. addEdge(nodeId('pkg', impl), svc)
  370. }
  371. for (const consumer of role.consumers ?? []) {
  372. addNode(nodeId('pkg', consumer), consumer)
  373. addEdge(svc, nodeId('pkg', consumer))
  374. }
  375. for (const companion of role.companions ?? []) {
  376. addNode(nodeId('pkg', companion), companion)
  377. companionEdges.add(` ${svc} -. event gate .-> ${nodeId('pkg', companion)}`)
  378. }
  379. }
  380. lines.push(...nodes.values(), ...[...edges].sort(), ...[...companionEdges].sort())
  381. lines.push('```', '', '| ctx key | Role | Owner | Implementations | Direct consumers | Companion plugins | Note |', '| --- | --- | --- | --- | --- | --- | --- |')
  382. for (const role of SERVICE_ROLES) {
  383. lines.push(`| \`ctx.${role.key}\` | \`${role.mode}\` | ${pkgLink(pkgsByShort.get(role.pkg), role.pkg)} | ${pkgList(role.implementations, pkgsByShort)} | ${pkgList(role.consumers, pkgsByShort)} | ${pkgList(role.companions, pkgsByShort)} | ${tableCell(role.note)} |`)
  384. }
  385. lines.push('', ...maintenanceFooter(maintenance))
  386. return lines.join('\n')
  387. }
  388. function parseExampleCordis(rel: string): ExamplePlugin[] {
  389. const text = readFileSync(resolve(root, rel), 'utf8')
  390. const plugins: ExamplePlugin[] = []
  391. let current: { id: string; name?: string } | null = null
  392. const flush = (): void => {
  393. if (current?.name) plugins.push({ id: current.id, name: current.name })
  394. }
  395. for (const line of text.split('\n')) {
  396. const id = /^-\s+id:\s+(.+?)\s*$/.exec(line)
  397. if (id?.[1] !== undefined) {
  398. flush()
  399. current = { id: stripYamlScalar(id[1]) }
  400. continue
  401. }
  402. const name = /^\s+name:\s+(.+?)\s*$/.exec(line)
  403. if (name?.[1] !== undefined && current) current.name = stripYamlScalar(name[1])
  404. }
  405. flush()
  406. return plugins
  407. }
  408. function stripYamlScalar(value: string): string {
  409. return value.trim().replace(/^['"]|['"]$/g, '')
  410. }
  411. const APP_EXAMPLES = [
  412. {
  413. id: 'echo',
  414. rel: 'examples/echo-agent/composition.md',
  415. title: 'Echo Agent App Composition',
  416. label: 'examples/echo-agent',
  417. config: 'examples/echo-agent/cordis.yml',
  418. summary: 'The echo demo swaps in a local mock LLM and teaching echo tool, then loads the stdio app package for the shared spine and terminal front door.',
  419. },
  420. {
  421. id: 'repl',
  422. rel: 'examples/repl-agent/composition.md',
  423. title: 'REPL Agent App Composition',
  424. label: 'examples/repl-agent',
  425. config: 'examples/repl-agent/cordis.yml',
  426. summary: 'The REPL agent demo adds the real DeepSeek adapter, filesystem tools, todo_write, compaction, and both subagent transports on top of the stdio app package.',
  427. },
  428. {
  429. id: 'tui',
  430. rel: 'examples/tui-agent/composition.md',
  431. title: 'TUI Agent App Composition',
  432. label: 'examples/tui-agent',
  433. config: 'examples/tui-agent/cordis.yml',
  434. summary: 'The TUI agent reuses the repl-agent backend and tool composition while fixing the shared terminal app to the full-screen dsh-tui front door.',
  435. },
  436. {
  437. id: 'headless',
  438. rel: 'examples/headless-agent/composition.md',
  439. title: 'Headless Agent App Composition',
  440. label: 'examples/headless-agent',
  441. config: 'examples/headless-agent/cordis.yml',
  442. summary: 'The headless demo combines the real DeepSeek adapter and coding capabilities with the one-shot app package, format-pure stdout, and one fresh persisted top-level session.',
  443. },
  444. {
  445. id: 'cordis',
  446. rel: 'examples/cordis-agent/composition.md',
  447. title: 'Cordis Agent App Composition',
  448. label: 'examples/cordis-agent',
  449. config: 'examples/cordis-agent/cordis.yml',
  450. summary: 'The self-referential demo puts @deepseek-ai/dsh-tool-cordis on the coding spine, letting the agent inspect its own runtime and mount/unmount plugins into it.',
  451. },
  452. {
  453. id: 'acp',
  454. rel: 'examples/acp-agent/composition.md',
  455. title: 'ACP Agent App Composition',
  456. label: 'examples/acp-agent',
  457. config: 'examples/acp-agent/cordis.yml',
  458. summary: 'The ACP demo exposes the same agent spine over JSON-RPC stdio, with no stdout logger and no pre-created agent; clients create sessions through the ACP bridge.',
  459. },
  460. ]
  461. type AppExample = typeof APP_EXAMPLES[number]
  462. function renderAppExpansion(lines: string[], appNode: string, pluginName: string, exampleId: string): void {
  463. const agentCore = nodeId('bundle', 'agent_core')
  464. const jsonl = nodeId('bundle', 'jsonl')
  465. lines.push(` ${appNode} --> ${agentCore}["@deepseek-ai/dsh-agent-spine-demo"]`)
  466. lines.push(` ${appNode} --> ${jsonl}["@deepseek-ai/dsh-session-persistence-jsonl"]`)
  467. if (pluginName === '@deepseek-ai/dsh-stdio-demo') {
  468. const frontDoor = exampleId === 'tui'
  469. ? '@deepseek-ai/dsh-tui<br/>pre-created main agent'
  470. : exampleId === 'repl'
  471. ? '@deepseek-ai/dsh-stdio<br/>pre-created main agent'
  472. : 'dsh-tui (TTY) / dsh-stdio (pipes)<br/>pre-created main agent'
  473. lines.push(` ${appNode} --> ${nodeId('frontdoor', 'stdio')}["${frontDoor}"]`)
  474. } else if (pluginName === '@deepseek-ai/dsh-cli-demo') {
  475. lines.push(` ${appNode} --> ${nodeId('frontdoor', 'cli')}["one-shot driver<br/>format-pure stdout<br/>fresh top-level agent"]`)
  476. } else if (pluginName === '@deepseek-ai/dsh-acp-demo') {
  477. lines.push(` ${appNode} --> ${nodeId('frontdoor', 'acp')}["@deepseek-ai/dsh-acp<br/>JSON-RPC stdio bridge<br/>sessions created by client"]`)
  478. }
  479. lines.push(
  480. ` ${agentCore} --> ${nodeId('spine', 'llm')}["ctx.llm"]`,
  481. ` ${agentCore} --> ${nodeId('spine', 'sessions')}["ctx.sessions"]`,
  482. ` ${agentCore} --> ${nodeId('spine', 'tools')}["ctx.tools + tool-bash"]`,
  483. ` ${agentCore} --> ${nodeId('spine', 'loop')}["ctx.agents + ctx.agentLoop"]`,
  484. )
  485. }
  486. function renderAppComposition(example: AppExample): string {
  487. const plugins = parseExampleCordis(example.config)
  488. const maintenance = 'hybrid: the leaf plugin list is parsed from its `cordis.yml`; app package expansion is curated from package source'
  489. const lines = generatedHeader(example.title)
  490. lines.push(
  491. example.summary,
  492. '',
  493. '```mermaid',
  494. 'flowchart LR',
  495. ` cfg["${escLabel(example.label)}<br/>cordis.yml"]`,
  496. )
  497. for (const plugin of plugins) {
  498. const pluginNode = nodeId(`plugin_${example.id}`, plugin.id)
  499. lines.push(` ${pluginNode}["${escLabel(plugin.id)}<br/>${escLabel(plugin.name)}"]`)
  500. lines.push(` cfg --> ${pluginNode}`)
  501. if (plugin.name === '@deepseek-ai/dsh-stdio-demo' || plugin.name === '@deepseek-ai/dsh-cli-demo' || plugin.name === '@deepseek-ai/dsh-acp-demo') {
  502. renderAppExpansion(lines, pluginNode, plugin.name, example.id)
  503. }
  504. }
  505. lines.push(
  506. '```',
  507. '',
  508. '| Plugin id | Package / module |',
  509. '| --- | --- |',
  510. ...plugins.map(plugin => `| \`${plugin.id}\` | \`${plugin.name}\` |`),
  511. '',
  512. `Source config: [\`${example.config}\`](${linkFromDoc(example.rel, example.config)}).`,
  513. )
  514. lines.push('', ...maintenanceFooter(maintenance))
  515. return lines.join('\n')
  516. }
  517. /** Collect event dispatch/listener relations from real cross-file receiver types. */
  518. class EventRelationCollector {
  519. private readonly relations = new Map<string, EventRelation>()
  520. private readonly callSites = new Map<ts.SignatureDeclaration | ts.JSDocSignature, ts.CallExpression[]>()
  521. private readonly contextType: ts.Type
  522. private readonly agentDispatchType: ts.Type
  523. private readonly eventsServiceType: ts.Type
  524. constructor(
  525. private readonly project: TypeScriptProject,
  526. private readonly sources: readonly PackageSource[],
  527. ) {
  528. this.contextType = this.declaredType('vendor/cordis/src/context.ts', 'Context')
  529. this.agentDispatchType = this.declaredType('packages/core/agent/src/dispatch.ts', 'AgentEventDispatch')
  530. this.eventsServiceType = this.declaredType('vendor/cordis/src/events.ts', 'EventsService')
  531. this.indexCallSites()
  532. }
  533. /** Return all event relations discovered from the Program. */
  534. collect(): Map<string, EventRelation> {
  535. for (const source of this.sources) this.visitSource(source)
  536. return this.relations
  537. }
  538. /** Resolve one named class/interface declaration to its merged instance type. */
  539. private declaredType(relativePath: string, name: string): ts.Type {
  540. const sourceFile = this.project.sourceFile(relativePath)
  541. const declaration = sourceFile.statements.find((statement): statement is ts.ClassDeclaration | ts.InterfaceDeclaration => {
  542. return (ts.isClassDeclaration(statement) || ts.isInterfaceDeclaration(statement)) && statement.name?.text === name
  543. })
  544. const symbol = declaration?.name && this.project.checker.getSymbolAtLocation(declaration.name)
  545. if (!symbol) throw new Error(`cannot resolve TypeScript type ${name} from ${relativePath}`)
  546. return this.project.checker.getDeclaredTypeOfSymbol(symbol)
  547. }
  548. /** Index resolved local function calls for narrow argument-flow recovery. */
  549. private indexCallSites(): void {
  550. const visit = (node: ts.Node): void => {
  551. if (ts.isCallExpression(node)) {
  552. const declaration = this.project.checker.getResolvedSignature(node)?.declaration
  553. if (declaration) {
  554. const calls = this.callSites.get(declaration) ?? []
  555. calls.push(node)
  556. this.callSites.set(declaration, calls)
  557. }
  558. }
  559. ts.forEachChild(node, visit)
  560. }
  561. for (const source of this.sources) visit(source.sourceFile)
  562. }
  563. /** Walk one package source file and classify event API calls by receiver type. */
  564. private visitSource(source: PackageSource): void {
  565. const visit = (node: ts.Node): void => {
  566. if (ts.isCallExpression(node) && ts.isPropertyAccessExpression(node.expression)) {
  567. const receiverKind = this.receiverKind(node.expression.expression)
  568. const method = node.expression.name.text
  569. if (receiverKind === 'events-service' && method === 'dispatch') {
  570. const argumentList = node.arguments[1]
  571. if (argumentList) {
  572. for (const event of this.eventNamesFromArgumentList(argumentList, new Set())) {
  573. this.addDispatcher(event, source.pkg, 'events.dispatch')
  574. }
  575. }
  576. } else if (receiverKind === 'context' || receiverKind === 'agent-dispatch') {
  577. const eventNames = this.eventNamesFromCall(node, receiverKind)
  578. if (method === 'on' || method === 'once') {
  579. for (const event of eventNames) this.ensure(event).listeners.add(source.pkg)
  580. } else if (method === 'emit' || method === 'parallel' || method === 'serial' || method === 'waterfall') {
  581. for (const event of eventNames) this.addDispatcher(event, source.pkg, method)
  582. }
  583. }
  584. }
  585. ts.forEachChild(node, visit)
  586. }
  587. visit(source.sourceFile)
  588. }
  589. /** Classify a receiver using assignability to the repository's actual event API types. */
  590. private receiverKind(receiver: ts.Expression): EventReceiverKind | undefined {
  591. const type = this.project.checker.getTypeAtLocation(receiver)
  592. if (type.flags & (ts.TypeFlags.Any | ts.TypeFlags.Unknown | ts.TypeFlags.Never)) return undefined
  593. if (this.project.checker.isTypeAssignableTo(type, this.eventsServiceType)) return 'events-service'
  594. if (this.project.checker.isTypeAssignableTo(type, this.contextType)) return 'context'
  595. if (this.project.checker.isTypeAssignableTo(type, this.agentDispatchType)) return 'agent-dispatch'
  596. return undefined
  597. }
  598. /** Resolve the event-name argument for Context and fused agent dispatch calls. */
  599. private eventNamesFromCall(call: ts.CallExpression, receiverKind: Exclude<EventReceiverKind, 'events-service'>): Set<string> {
  600. const candidates = receiverKind === 'context' ? call.arguments.slice(0, 2) : call.arguments.slice(0, 1)
  601. for (const candidate of candidates) {
  602. const values = this.finiteStringValues(candidate)
  603. if (values) return values
  604. }
  605. return new Set()
  606. }
  607. /** Recover the event slot from the argument array handed to EventsService.dispatch(). */
  608. private eventNamesFromArgumentList(expression: ts.Expression, seen: Set<ts.Node>): Set<string> {
  609. const current = unwrapExpression(expression)
  610. if (seen.has(current)) return new Set()
  611. seen.add(current)
  612. if (ts.isArrayLiteralExpression(current)) {
  613. for (const element of current.elements.slice(0, 2)) {
  614. if (ts.isOmittedExpression(element) || ts.isSpreadElement(element)) continue
  615. const values = this.finiteStringValues(element)
  616. if (values) return values
  617. }
  618. return new Set()
  619. }
  620. if (ts.isConditionalExpression(current)) {
  621. return unionSets(
  622. this.eventNamesFromArgumentList(current.whenTrue, new Set(seen)),
  623. this.eventNamesFromArgumentList(current.whenFalse, new Set(seen)),
  624. )
  625. }
  626. if (!ts.isIdentifier(current)) return new Set()
  627. const symbol = this.project.checker.getSymbolAtLocation(current)
  628. if (!symbol) return new Set()
  629. const events = new Set<string>()
  630. for (const declaration of symbol.declarations ?? []) {
  631. if (ts.isVariableDeclaration(declaration) && declaration.initializer && isConstDeclaration(declaration)) {
  632. addAll(events, this.eventNamesFromArgumentList(declaration.initializer, new Set(seen)))
  633. } else if (ts.isParameter(declaration)) {
  634. addAll(events, this.eventNamesFromParameter(declaration, seen))
  635. }
  636. }
  637. return events
  638. }
  639. /** Follow a non-exported local helper parameter back to every resolved call site. */
  640. private eventNamesFromParameter(parameter: ts.ParameterDeclaration, seen: Set<ts.Node>): Set<string> {
  641. const owner = parameter.parent
  642. if (!ts.isFunctionDeclaration(owner) || hasExportModifier(owner)) return new Set()
  643. const index = owner.parameters.indexOf(parameter)
  644. if (index < 0) return new Set()
  645. const events = new Set<string>()
  646. for (const call of this.callSites.get(owner) ?? []) {
  647. const argument = call.arguments[index]
  648. if (argument) addAll(events, this.eventNamesFromArgumentList(argument, new Set(seen)))
  649. }
  650. return events
  651. }
  652. /** Return a finite string-literal value set, rejecting widened and generic strings. */
  653. private finiteStringValues(expression: ts.Expression): Set<string> | undefined {
  654. const current = unwrapExpression(expression)
  655. if (ts.isStringLiteralLike(current)) return new Set([current.text])
  656. if (this.isForwardedAgentEventParameter(current)) return undefined
  657. return finiteStringTypeValues(this.project.checker.getTypeAtLocation(current))
  658. }
  659. /** Reject the contextual parameter inside the AgentEventDispatch forwarding object. */
  660. private isForwardedAgentEventParameter(expression: ts.Expression): boolean {
  661. if (!ts.isIdentifier(expression)) return false
  662. const declarations = this.project.checker.getSymbolAtLocation(expression)?.declarations ?? []
  663. return declarations.some((declaration) => {
  664. if (!ts.isParameter(declaration)) return false
  665. const method = declaration.parent
  666. if (!ts.isMethodDeclaration(method) || !ts.isObjectLiteralExpression(method.parent)) return false
  667. const contextualType = this.project.checker.getContextualType(method.parent)
  668. return contextualType !== undefined
  669. && this.project.checker.isTypeAssignableTo(contextualType, this.agentDispatchType)
  670. })
  671. }
  672. /** Get or create one relation row. */
  673. private ensure(event: string): EventRelation {
  674. const existing = this.relations.get(event)
  675. if (existing) return existing
  676. const relation = { dispatchers: new Map<string, Set<string>>(), listeners: new Set<string>() }
  677. this.relations.set(event, relation)
  678. return relation
  679. }
  680. /** Add one dispatcher method without duplicating package/method labels. */
  681. private addDispatcher(event: string, pkg: string, method: string): void {
  682. const relation = this.ensure(event)
  683. const methods = relation.dispatchers.get(pkg) ?? new Set<string>()
  684. methods.add(method)
  685. relation.dispatchers.set(pkg, methods)
  686. }
  687. }
  688. /** Peel syntax-only wrappers that do not change an expression's runtime value. */
  689. function unwrapExpression(expression: ts.Expression): ts.Expression {
  690. let current = expression
  691. while (
  692. ts.isParenthesizedExpression(current)
  693. || ts.isAsExpression(current)
  694. || ts.isTypeAssertionExpression(current)
  695. || ts.isNonNullExpression(current)
  696. || ts.isSatisfiesExpression(current)
  697. ) {
  698. current = current.expression
  699. }
  700. return current
  701. }
  702. /** Return every value only when a type is a closed string-literal union. */
  703. function finiteStringTypeValues(type: ts.Type): Set<string> | undefined {
  704. if (type.flags & ts.TypeFlags.StringLiteral) {
  705. return new Set([(type as ts.StringLiteralType).value])
  706. }
  707. if (type.flags & ts.TypeFlags.Never) return new Set()
  708. if (!type.isUnion()) return undefined
  709. const values = new Set<string>()
  710. for (const member of type.types) {
  711. const memberValues = finiteStringTypeValues(member)
  712. if (!memberValues) return undefined
  713. addAll(values, memberValues)
  714. }
  715. return values
  716. }
  717. /** Return whether a variable declaration belongs to a const declaration list. */
  718. function isConstDeclaration(declaration: ts.VariableDeclaration): boolean {
  719. return (declaration.parent.flags & ts.NodeFlags.Const) !== 0
  720. }
  721. /** Return whether a declaration is visible to callers outside its source module. */
  722. function hasExportModifier(node: ts.Node): boolean {
  723. return ts.canHaveModifiers(node) && (ts.getModifiers(node)?.some((modifier) => {
  724. return modifier.kind === ts.SyntaxKind.ExportKeyword || modifier.kind === ts.SyntaxKind.DefaultKeyword
  725. }) ?? false)
  726. }
  727. /** Add every member of source to target. */
  728. function addAll<T>(target: Set<T>, source: ReadonlySet<T>): void {
  729. for (const value of source) target.add(value)
  730. }
  731. /** Return the union of two sets without mutating either input. */
  732. function unionSets<T>(left: ReadonlySet<T>, right: ReadonlySet<T>): Set<T> {
  733. const out = new Set(left)
  734. addAll(out, right)
  735. return out
  736. }
  737. function collectEventRelations(): Map<string, EventRelation> {
  738. const project = new TypeScriptProject(root)
  739. const sources = project.sourceFiles().flatMap((sourceFile): PackageSource[] => {
  740. const rel = project.relativePath(sourceFile)
  741. const match = /^packages\/[^/]+\/([^/]+)\/src\/.+\.ts$/.exec(rel)
  742. return match?.[1] ? [{ rel, pkg: match[1], sourceFile }] : []
  743. }).sort((left, right) => left.rel.localeCompare(right.rel))
  744. return new EventRelationCollector(project, sources).collect()
  745. }
  746. function relationPackages(map: Map<string, Set<string>>, pkgsByShort: Map<string, Pkg>): string {
  747. if (map.size === 0) return '-'
  748. return [...map.entries()]
  749. .sort(([a], [b]) => a.localeCompare(b))
  750. .map(([pkg, methods]) => `${pkgLink(pkgsByShort.get(pkg), pkg)} (${[...methods].sort().map(m => `\`${m}\``).join(', ')})`)
  751. .join(', ')
  752. }
  753. function listenerPackages(listeners: Set<string>, pkgsByShort: Map<string, Pkg>): string {
  754. if (listeners.size === 0) return '-'
  755. return [...listeners].sort().map(pkg => pkgLink(pkgsByShort.get(pkg), pkg)).join(', ')
  756. }
  757. function renderEventRelations(pkgs: Pkg[]): string {
  758. const events = collectEvents()
  759. const relations = collectEventRelations()
  760. const pkgsByShort = new Map(pkgs.map(pkg => [pkg.short, pkg]))
  761. const maintenance = 'generated: Cordis event declarations and producer/listener edges are resolved from the repository TypeScript Program'
  762. const lines = generatedHeader('Event Producer And Consumer Matrix')
  763. lines.push(
  764. 'This matrix shows which packages dispatch each harness-owned event and which packages listen to it. It is intentionally a table rather than one large graph: events are many-to-many, and dense relation data is easier to review in rows. Receiver and event-name types also cover contained dispatch sites that deliberately bypass `ctx.emit`, such as subagent lifecycle containment.',
  765. '',
  766. '| Event | Mode | Declared in | Dispatchers | Listeners |',
  767. '| --- | --- | --- | --- | --- |',
  768. )
  769. for (const event of [...events].sort((a, b) => a.name.localeCompare(b.name))) {
  770. const relation = relations.get(event.name) ?? { dispatchers: new Map<string, Set<string>>(), listeners: new Set<string>() }
  771. lines.push(`| \`${event.name}\` | \`${event.mode}\` | ${sourceLink(event.source)} | ${relationPackages(relation.dispatchers, pkgsByShort)} | ${listenerPackages(relation.listeners, pkgsByShort)} |`)
  772. }
  773. // Every declared event needs a dispatcher: zero means dead vocabulary or an
  774. // unrecognized semantic dispatch shape. Listener-free extension points remain valid.
  775. const undispatched = [...events]
  776. .filter(event => (relations.get(event.name)?.dispatchers.size ?? 0) === 0)
  777. .map(event => event.name)
  778. .sort()
  779. if (undispatched.length > 0) {
  780. throw new Error(
  781. `event-producer-consumer matrix: no dispatcher found for declared event${undispatched.length > 1 ? 's' : ''} `
  782. + `${undispatched.map(name => `"${name}"`).join(', ')} — dead vocabulary, or a dispatch shape the semantic scan misses `
  783. + '(teach scripts/gen-doc-graphs.ts the shape)',
  784. )
  785. }
  786. const declared = new Set(events.map(event => event.name))
  787. const extra = [...relations.keys()].filter(event => !declared.has(event)).sort()
  788. if (extra.length > 0) {
  789. lines.push('', '## Non-harness or undeclared event strings seen in package source', '', '| Event string | Dispatchers | Listeners |', '| --- | --- | --- |')
  790. for (const event of extra) {
  791. const relation = relations.get(event)
  792. if (!relation) continue
  793. lines.push(`| \`${event}\` | ${relationPackages(relation.dispatchers, pkgsByShort)} | ${listenerPackages(relation.listeners, pkgsByShort)} |`)
  794. }
  795. }
  796. lines.push('', ...maintenanceFooter(maintenance))
  797. return lines.join('\n')
  798. }
  799. function renderLifecycle(): string {
  800. const maintenance = 'curated Mermaid sequence; exact event signatures live in the generated Cordis catalog'
  801. return [
  802. ...generatedHeader('Agent Turn And Step Lifecycle'),
  803. 'This sequence is the visual companion to [architecture.md](architecture.md#loop-lifecycle-session--turn--step). It keeps durable replay facts on `session/event` and live control/status on `agent/*`.',
  804. '',
  805. '```mermaid',
  806. 'sequenceDiagram',
  807. ' participant User',
  808. ' participant Agent',
  809. ' participant Driver',
  810. ' participant Hooks as hook listeners',
  811. ' participant Prompt as ctx.systemPrompt',
  812. ' participant LLM as ctx.llm',
  813. ' participant Tools as ctx.tools',
  814. ' participant Session',
  815. ' participant Persistence',
  816. ' participant SDK as UI or SDK listener',
  817. ' User->>Agent: send(content)',
  818. ` Agent-->>SDK: ${mermaidCode('agent/queued')}`,
  819. ' Agent->>Driver: queued work wakes driver',
  820. ` Driver-->>SDK: ${mermaidCode('agent/status')} running`,
  821. ` Driver->>Session: ${mermaidCode('turn/start')}`,
  822. ` Driver->>Hooks: ${mermaidCode('agent/prompt-submit')} waterfall`,
  823. ' Hooks-->>Driver: allow, block, or add context',
  824. ` Driver->>Session: ${mermaidCode('user/message')} or rejected ${mermaidCode('turn/end')}`,
  825. ` Driver->>Prompt: ${mermaidCode('system-prompt/assemble')} waterfall`,
  826. ` Driver-->>Driver: ${mermaidCode('agent/pre-step')} serial checkpoint`,
  827. ` Driver->>Session: ${mermaidCode('step/start')}`,
  828. ` Driver->>LLM: ${mermaidCode('agent/request')} waterfall, then ${mermaidCode('llm/stream')} waterfall`,
  829. ' LLM-->>Driver: StreamChunk*',
  830. ` Driver->>Session: ${mermaidCode('assistant/chunk')}*`,
  831. ` Session-->>SDK: ${mermaidCode('session/event')} ${mermaidCode('assistant/chunk')}*`,
  832. ' alt final adapter or terminal in-band request failure',
  833. ` Driver->>Session: ${mermaidCode('step/end')}`,
  834. ` Driver->>Hooks: ${mermaidCode('agent/request-error')} waterfall`,
  835. ' Hooks-->>Driver: retry in a new step or preserve the original error',
  836. ' else model request succeeded',
  837. ` Driver->>Hooks: ${mermaidCode('agent/step-result')} waterfall`,
  838. ` Driver->>Session: ${mermaidCode('assistant/message')}`,
  839. ' Driver->>Tools: classify pending call by executionMode',
  840. ' loop barriers and bounded rolling pool, reclassify before start',
  841. ' opt call starts',
  842. ` Driver->>Session: ${mermaidCode('tool/call')}`,
  843. ' Driver->>Tools: ordered pre, concurrent execute',
  844. ' Tools-->>Session: tool-owned events when applicable',
  845. ' end',
  846. ' opt next model-order result ready',
  847. ' Driver->>Tools: ordered post',
  848. ` Driver->>Session: ${mermaidCode('tool/result')}`,
  849. ' end',
  850. ' end',
  851. ' Driver->>Session: post-tool context and steering',
  852. ` Driver->>Hooks: ${mermaidCode('agent/post-step')} serial checkpoint`,
  853. ` Driver->>Session: ${mermaidCode('step/end')}`,
  854. ` Driver->>Hooks: ${mermaidCode('agent/turn-continuation')} waterfall`,
  855. ` Driver->>Hooks: ${mermaidCode('agent/turn-stop')} serial terminal checkpoint`,
  856. ' end',
  857. ` Driver->>Session: ${mermaidCode('turn/end')}`,
  858. ` Driver->>Persistence: ${mermaidCode('session/flush')} parallel checkpoint`,
  859. ` Driver-->>SDK: ${mermaidCode('agent/status')} idle`,
  860. '```',
  861. '',
  862. 'The `assistant/message` edge records every successful provider call, including content-less and `max-tokens` finishes. Empty content stays out of derived history while the durable anchor retains usage and exact chunk provenance, including an explicit empty source set.',
  863. '',
  864. '`dsh-compact-basic` uses `agent/post-step` for pressure after those durable facts and `agent/request-error` only for canonical context overflow. Recovery compacts between the closed failed step and a fresh retry step, and returns retry only when the surface replacement generation advances; otherwise the original request error remains authoritative.',
  865. '',
  866. 'SDK users that need replayable transcript data should consume `session/event`; `agent/*` is the live coordination surface for queue/status, prompt interception, request shaping, steering, continuation, and errors.',
  867. '',
  868. ...maintenanceFooter(maintenance),
  869. ].join('\n')
  870. }
  871. function renderToolPipeline(): string {
  872. const maintenance = 'curated Mermaid flow; exact tool schemas and event signatures live in generated catalogs'
  873. return [
  874. ...generatedHeader('Tool Execution Pipeline'),
  875. 'This graph shows where policy, hooks, sandboxing, filesystem guards, result rewriting, final-outcome observation, and UI rendering fit without changing the loop. The transformable extension points are the `tools/pre-execute`, `tools/execute`, and `tools/post-execute` waterfalls; monotonic guards and `tools/result` are the owner-enforced boundaries around them.',
  876. '',
  877. '```mermaid',
  878. 'flowchart TD',
  879. ' model["Assistant message contains tool-call block"]',
  880. ` toolCall["Session event: ${mermaidCode('tool/call')}<br/>logged before execution"]`,
  881. ' presentCall["UI pending card<br/>presentCall(args)"]',
  882. ` pre["${mermaidCode('tools/pre-execute')} waterfall<br/>hooks, permission, sandbox"]`,
  883. ' guards["Registered monotonic guards<br/>deny or abstain; identity protected"]',
  884. ' denied["denied or approval refused<br/>tool body skipped"]',
  885. ` approval["${mermaidCode('ctx.approval')} one-shot prompt<br/>absent or unanswerable: deny"]`,
  886. ` around["${mermaidCode('tools/execute')} waterfall<br/>timeout, retry, metrics (around dispatch)"]`,
  887. ' toolBody["Registered tool execute() body"]',
  888. ` fsGate["${mermaidCode('fs/write-intent')} or ${mermaidCode('fs/edit-intent')}<br/>tool-fs mutations only"]`,
  889. ` owned["Tool-owned session events<br/>${mermaidCode('todo/write')}, ${mermaidCode('fs/observed')}, ${mermaidCode('hook/invoked')}, ${mermaidCode('hook/result')}, ${mermaidCode('tool/code-dispatch')}"]`,
  890. ` post["${mermaidCode('tools/post-execute')} waterfall<br/>accept, block, replace, add context"]`,
  891. ` final["${mermaidCode('tools/result')} synchronous notification<br/>frozen authoritative outcome"]`,
  892. ' context["Active-batch additionalContexts FIFO<br/>context/message after recorded tool results"]',
  893. ` toolResult["Session event: ${mermaidCode('tool/result')}<br/>single model-facing outcome"]`,
  894. ' allResults["Tool batch settled<br/>recorded tool/result events complete"]',
  895. ' presentResult["UI completed card<br/>presentResult(args, result)"]',
  896. ' model --> toolCall',
  897. ' toolCall --> presentCall',
  898. ' toolCall --> pre',
  899. ' pre -->|allow| guards',
  900. ' guards -->|allow| around',
  901. ' guards -->|deny| denied',
  902. ' around --> toolBody',
  903. ' pre -->|deny| denied',
  904. ' pre -->|ask| approval',
  905. ' approval -->|allowed-once| guards',
  906. ' approval -->|rejected, cancelled, unavailable| denied',
  907. ' denied --> post',
  908. ' toolBody --> fsGate',
  909. ' fsGate --> toolBody',
  910. ' toolBody --> owned',
  911. ' toolBody --> around',
  912. ' around --> post',
  913. ' post --> final',
  914. ' final --> toolResult',
  915. ' toolResult --> presentResult',
  916. ' toolResult --> allResults',
  917. ' allResults --> context',
  918. '```',
  919. '',
  920. 'Filesystem read-before-edit checks stay below `tool-fs` on `fs/*` events. Generic pre/post waterfalls host hooks and approval policy; `ctx.approval` resolves asks before monotonic guards, and owner policy that must not be reordered remains a registered guard. Around-dispatch concerns such as timeouts wrap `tools/execute`, while `tools/result` observes the immutable outcome after transforms, lossless-JSON validation, and outer error normalization. This lets hooks span tool families without coupling the tools to one policy service. Code Mode sends both the reserved `run_code` transport and its serialized sub-calls through the pipeline; sub-calls carry the parent token, log `tool/code-dispatch`, surface denials as binding rejections, and omit `additionalContexts` to preserve call/result adjacency.',
  921. '',
  922. ...maintenanceFooter(maintenance),
  923. ].join('\n')
  924. }
  925. function renderSnapshotReplay(): string {
  926. const maintenance = 'curated Mermaid sequence based on the snapshot test harness'
  927. return [
  928. ...generatedHeader('ACP Snapshot Replay'),
  929. 'This graph explains what a snapshot scenario proves: recorded real-model session logs are replayed keylessly, ACP stdout is normalized and diffed, and scenario workspaces preserve tool side effects that the UI stream alone cannot prove.',
  930. '',
  931. '```mermaid',
  932. 'sequenceDiagram',
  933. ' participant Recorder as Real API recording',
  934. ' participant Fixture as snapshot fixture',
  935. ' participant Workspace',
  936. ' participant Replay as llm-replay adapter',
  937. ' participant ACP as acp-agent subprocess',
  938. ' participant Expected as stdout expected output',
  939. ' Recorder->>Fixture: session.jsonl + workspace inputs',
  940. ' Fixture->>Workspace: seed files and hook configs',
  941. ' Fixture->>Replay: recorded StreamChunk script',
  942. ` Replay->>ACP: deterministic ${mermaidCode('llm/stream')} chunks`,
  943. ' ACP->>Workspace: bash, fs, and hook side effects',
  944. ' ACP->>Expected: normalized sessionUpdate stream',
  945. ' Expected-->>ACP: diff must be empty',
  946. '```',
  947. '',
  948. 'The fs and hook snapshot matrix is valuable because it proves world state, hook decisions, and failed tool-card rendering, not just that replay returns text.',
  949. '',
  950. ...maintenanceFooter(maintenance),
  951. ].join('\n')
  952. }
  953. function renderDocs(): GraphDoc[] {
  954. const pkgs = collectPackageGraph(root, GROUP_ORDER, 'gen-doc-graphs')
  955. const docs: GraphDoc[] = [
  956. { rel: 'docs/capability-seams.md', content: renderCapabilitySeams(pkgs) },
  957. ...APP_EXAMPLES.map(example => ({ rel: example.rel, content: renderAppComposition(example) })),
  958. { rel: 'docs/event-producer-consumer.md', content: renderEventRelations(pkgs) },
  959. { rel: 'docs/agent-lifecycle.md', content: renderLifecycle() },
  960. { rel: 'docs/tool-execution-pipeline.md', content: renderToolPipeline() },
  961. { rel: 'packages/ui/acp/snapshot-replay.md', content: renderSnapshotReplay() },
  962. ]
  963. docs.unshift({ rel: 'docs/graph-atlas.md', content: renderIndex(docs) })
  964. return docs
  965. }
  966. function renderIndex(docs: GraphDoc[]): string {
  967. const labels: Record<string, string> = {
  968. 'docs/capability-seams.md': 'capability seams and core services',
  969. 'examples/echo-agent/composition.md': 'echo-agent app composition',
  970. 'examples/repl-agent/composition.md': 'repl-agent app composition',
  971. 'examples/headless-agent/composition.md': 'headless-agent app composition',
  972. 'examples/tui-agent/composition.md': 'tui-agent app composition',
  973. 'examples/cordis-agent/composition.md': 'cordis-agent app composition',
  974. 'examples/acp-agent/composition.md': 'acp-agent app composition',
  975. 'docs/event-producer-consumer.md': 'event producer/consumer matrix',
  976. 'docs/agent-lifecycle.md': 'agent turn and step lifecycle',
  977. 'docs/tool-execution-pipeline.md': 'tool execution pipeline',
  978. 'packages/ui/acp/snapshot-replay.md': 'ACP snapshot replay',
  979. }
  980. const modes: Record<string, string> = {
  981. 'docs/capability-seams.md': 'hybrid generated',
  982. 'examples/echo-agent/composition.md': 'hybrid generated',
  983. 'examples/repl-agent/composition.md': 'hybrid generated',
  984. 'examples/headless-agent/composition.md': 'hybrid generated',
  985. 'examples/tui-agent/composition.md': 'hybrid generated',
  986. 'examples/cordis-agent/composition.md': 'hybrid generated',
  987. 'examples/acp-agent/composition.md': 'hybrid generated',
  988. 'docs/event-producer-consumer.md': 'hybrid generated',
  989. 'docs/agent-lifecycle.md': 'curated',
  990. 'docs/tool-execution-pipeline.md': 'curated',
  991. 'packages/ui/acp/snapshot-replay.md': 'curated',
  992. }
  993. const rows = [
  994. '| [module dependency graph](module-graph.md) | `generated` |',
  995. '| [tool schema catalog and package map](tool-catalog.md) | `generated` |',
  996. ...docs.map((doc) => {
  997. const link = graphIndexLink(doc.rel)
  998. return `| [${labels[doc.rel] ?? link}](${link}) | \`${modes[doc.rel] ?? 'generated'}\` |`
  999. }),
  1000. ]
  1001. const maintenance = 'mixed: each linked page declares generated, hybrid, or curated mode'
  1002. return [
  1003. ...generatedHeader('Documentation Graph Index'),
  1004. 'These diagrams are the relationship layer above the generated catalogs. Use them to navigate package topology, capability seams, event flow, model-facing tools, app composition, and runtime lifecycle paths. Exact signatures and type shapes still live in the generated [events](cordis-catalog/events.md) / [services](cordis-catalog/services.md) catalogs, [tool-catalog.md](tool-catalog.md), and [core-data-structures/](core-data-structures/core.md).',
  1005. '',
  1006. 'The process decision behind this index is recorded in [the documentation graph Agent Note](../.agents/notes/implemented/process/2026-07-03-documentation-graph-atlas.md).',
  1007. '',
  1008. '| Graph | Mode |',
  1009. '| --- | --- |',
  1010. ...rows,
  1011. '',
  1012. 'Regenerate with `pnpm run gen-doc-graphs`; verify freshness with `pnpm run verify-doc-graphs`.',
  1013. '',
  1014. ...maintenanceFooter(maintenance),
  1015. ].join('\n')
  1016. }
  1017. function main(): void {
  1018. const docs = renderDocs()
  1019. if (process.argv.includes('--check')) {
  1020. const stale: string[] = []
  1021. for (const doc of docs) {
  1022. const abs = resolve(root, doc.rel)
  1023. const committed = existsSync(abs) ? readFileSync(abs, 'utf8') : null
  1024. if (committed !== doc.content) stale.push(doc.rel)
  1025. }
  1026. if (stale.length === 0) {
  1027. console.log(`gen-doc-graphs: ${docs.length} graph doc(s) are up to date.`)
  1028. return
  1029. }
  1030. console.error(`gen-doc-graphs: stale graph doc(s): ${stale.join(', ')}. Run \`pnpm run gen-doc-graphs\` and commit the result.`)
  1031. process.exit(1)
  1032. }
  1033. for (const doc of docs) {
  1034. mkdirSync(dirname(resolve(root, doc.rel)), { recursive: true })
  1035. writeFileSync(resolve(root, doc.rel), doc.content)
  1036. }
  1037. console.log(`gen-doc-graphs: wrote ${docs.length} graph doc(s).`)
  1038. }
  1039. if (process.argv[1] && import.meta.filename === resolve(process.argv[1])) {
  1040. main()
  1041. }