gen-doc-graphs.ts 49 KB

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