gen-doc-graphs.ts 49 KB

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