gen-doc-graphs.ts 72 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610
  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 { projectCordisCatalog } from '@deepseek-ai/dsh-typert-generator'
  11. import { CORDIS_CATALOG_POLICY } from './gen-cordis-catalog.ts'
  12. import type { EventEntry, ServiceEntry } from '@deepseek-ai/dsh-typert-generator'
  13. import {
  14. collectPackageGraph,
  15. escapeMermaidLabel as escLabel,
  16. graphNodeId as nodeId,
  17. type PackageGraphNode,
  18. } from './package-graph.ts'
  19. import { TypeScriptProject } from './ts-project.ts'
  20. const root = resolve(import.meta.dirname, '..')
  21. type Pkg = PackageGraphNode
  22. interface GraphDoc {
  23. rel: string
  24. content: string
  25. }
  26. interface ServiceRole {
  27. key: string
  28. pkg: string
  29. title: string
  30. mode: 'core' | 'seam' | 'bundle'
  31. implementations?: string[]
  32. consumers?: string[]
  33. companions?: string[]
  34. note: string
  35. }
  36. interface ExamplePlugin {
  37. id: string
  38. name: string
  39. }
  40. interface EventRelation {
  41. dispatchers: Map<string, Set<string>>
  42. listeners: Set<string>
  43. }
  44. /** One scanned package source file and its owning package short name. */
  45. export interface PackageSource {
  46. /** Repository-relative path. */
  47. rel: string
  48. /** Package short name from the `packages/<group>/<pkg>/src` path. */
  49. pkg: string
  50. /** The bound program source file. */
  51. sourceFile: ts.SourceFile
  52. }
  53. type EventReceiverKind = 'context' | 'agent-dispatch' | 'events-service'
  54. const GROUP_ORDER = [
  55. 'util',
  56. 'attachment',
  57. 'llm',
  58. 'core',
  59. 'typert',
  60. 'goal',
  61. 'experimental',
  62. 'process',
  63. 'bash',
  64. 'pty',
  65. 'sandbox',
  66. 'ssh',
  67. 'fs',
  68. 'skill',
  69. 'compact',
  70. 'subagent',
  71. 'tasks',
  72. 'workflow',
  73. 'web',
  74. 'webhook',
  75. 'spill',
  76. 'todo',
  77. 'plan',
  78. 'cordis',
  79. 'hooks',
  80. 'session-persistence',
  81. 'session-query',
  82. 'session-title',
  83. 'telemetry',
  84. 'storage',
  85. 'workspace',
  86. 'support',
  87. 'acp',
  88. 'ui',
  89. ]
  90. const SERVICE_ROLES: ServiceRole[] = [
  91. {
  92. key: 'hmr',
  93. pkg: 'hmr',
  94. title: 'Serialized module and configuration reloads',
  95. mode: 'core',
  96. consumers: ['app-boot'],
  97. note: 'Owns module and exact configuration watchers; application mutations share its queue and automatic reloads await the application file lock.',
  98. },
  99. {
  100. key: 'pluginManager',
  101. pkg: 'plugin-manager',
  102. title: 'Current-profile plugin and bundle management',
  103. mode: 'core',
  104. consumers: ['plugin-manager', 'ui-settings-plugin-inventory'],
  105. note: 'Shares profile package operations with the CLI and reports persisted and running state to Web and agent callers.',
  106. },
  107. {
  108. key: 'profileContext',
  109. pkg: 'app-boot',
  110. title: 'Launcher-owned profile data',
  111. mode: 'core',
  112. consumers: ['plugin-manager'],
  113. note: 'The dsh launcher supplies data-only profile locations and composition inputs; reload scheduling belongs to dsh-hmr.',
  114. },
  115. {
  116. key: 'mcpResources',
  117. pkg: 'mcp-resources',
  118. title: 'Scoped MCP resource access',
  119. mode: 'seam',
  120. implementations: ['mcp-client'],
  121. consumers: ['mcp-resources'],
  122. note: 'Connection-owned providers serve shared resource tools in the calling agent scope.',
  123. },
  124. {
  125. key: 'browserUse',
  126. pkg: 'browser-use',
  127. title: 'Browser-use provider registration',
  128. mode: 'seam',
  129. implementations: ['experimental-browser-use-playwright-mcp', 'experimental-browser-use-chrome-devtools-mcp', 'experimental-browser-use-stagehand-native'],
  130. consumers: ['experimental-browser-use-playwright-mcp', 'experimental-browser-use-chrome-devtools-mcp', 'experimental-browser-use-stagehand-native'],
  131. note: 'One provider-owned name per service instance. Providers own their tools and browser resources per live Session; the shared service has no browser operation API.',
  132. },
  133. {
  134. key: 'computerUse',
  135. pkg: 'computer-use',
  136. title: 'Computer-use provider registration',
  137. mode: 'seam',
  138. implementations: ['experimental-computer-use-cua-driver-mcp', 'experimental-computer-use-cua-driver-native'],
  139. consumers: ['experimental-computer-use-cua-driver-mcp', 'experimental-computer-use-cua-driver-native'],
  140. note: 'One provider-owned name per service instance. Each provider also owns its model tools; the service has no common action API, runtime selection, or Session workflow lock.',
  141. },
  142. {
  143. key: 'attachments',
  144. pkg: 'attachment',
  145. title: 'Durable binary attachment storage',
  146. mode: 'seam',
  147. implementations: ['attachment-local'],
  148. consumers: ['api-session-controller', 'tool-fs', 'llm-pi-ai', 'llm-deepseek'],
  149. note: 'The host commits accepted images before session events; provider adapters resolve authorized durable references into provider-native content.',
  150. },
  151. {
  152. key: 'fileUploads',
  153. pkg: 'client-file-upload',
  154. title: 'Agent-scoped staged file uploads',
  155. mode: 'core',
  156. consumers: ['api-session-controller'],
  157. note: 'Owns streaming intake, durable storage, and staged receipt lifetime; the Session controller binds receipts to accepted submissions.',
  158. },
  159. {
  160. key: 'llm',
  161. pkg: 'llm',
  162. title: 'LLM adapter registry',
  163. mode: 'seam',
  164. implementations: ['llm-deepseek', 'llm-pi-ai', 'llm-replay'],
  165. consumers: ['agent-loop', 'compaction-basic'],
  166. note: 'Adapters register provider implementations; the loop and compaction call the provider-neutral stream service.',
  167. },
  168. {
  169. key: 'deepseekLlmApiExtensions',
  170. pkg: 'deepseek-llm-api-extensions',
  171. title: 'Official DeepSeek request extensions',
  172. mode: 'seam',
  173. implementations: ['session-log-deepseek', 'plugin-package-inventory-deepseek'],
  174. consumers: ['llm-deepseek'],
  175. note: 'Plugins prepare independent top-level fields; the official adapter merges them and commits their delivery state after HTTP acceptance.',
  176. },
  177. {
  178. key: 'tokenMeter',
  179. pkg: 'token-meter',
  180. title: 'Replay token measurement',
  181. mode: 'core',
  182. consumers: ['compaction-basic'],
  183. note: 'Owns isolated per-session replay folds; pressure consumers share immutable revisioned measurements.',
  184. },
  185. {
  186. key: 'toolResultPruner',
  187. pkg: 'compaction-tool-result-pruner',
  188. title: 'Model-free tool-result pruning',
  189. mode: 'core',
  190. consumers: ['compaction-basic'],
  191. note: 'Rewrites oversized current tool results through replayable single-node surface replacements before summary compaction.',
  192. },
  193. {
  194. key: 'sessions',
  195. pkg: 'session',
  196. title: 'In-memory session store',
  197. mode: 'core',
  198. consumers: ['agent-loop', 'agent', 'session-persistence', 'session-query', 'session-query-sqlite', 'subagent-in-process-driver', 'invariants', 'message-feedback'],
  199. note: 'Owns append-only Session instances and emits the durable session event feed.',
  200. },
  201. {
  202. key: 'sessionController',
  203. pkg: 'api-session-controller',
  204. title: 'Host Session Remote controller',
  205. mode: 'core',
  206. note: 'Owns Session commands, cold reads, durable-event following, live control state, model catalogs, workspace opening, and Agent activation policy.',
  207. },
  208. {
  209. key: 'sessionFileReferences',
  210. pkg: 'api-session-controller',
  211. title: 'Session-addressed file-reference Remote adapter',
  212. mode: 'core',
  213. note: 'Delegates file-reference discovery through the Session Controller\'s established Agent lookup policy.',
  214. },
  215. {
  216. key: 'sessionSkillCatalog',
  217. pkg: 'api-session-controller',
  218. title: 'Session-addressed skill Remote adapter',
  219. mode: 'core',
  220. note: 'Lists the Session composition\'s user-invocable skills without activating a cold Agent.',
  221. },
  222. {
  223. key: 'credentialsController',
  224. pkg: 'api-settings-controller',
  225. title: 'Host credential-surface Remote controller',
  226. mode: 'core',
  227. note: 'Projects the credential-reference seam onto the generated Remote namespace: batch fan-out, view projection, and refusal mapping live here, not on the seam Definition.',
  228. },
  229. {
  230. key: 'settingsController',
  231. pkg: 'api-settings-controller',
  232. title: 'Host settings-surface Remote controller',
  233. mode: 'core',
  234. note: 'Projects the user-settings seam onto the generated Remote namespace: the read is always redacted and every refusal is classified here, not on the seam Definition.',
  235. },
  236. {
  237. key: 'workspaceFiles',
  238. pkg: 'api-workspace-files',
  239. title: 'Host workspace file Remote service',
  240. mode: 'core',
  241. note: 'Serves stat, paged text, byte windows, directory listings, and the change feed for files inside a Session\'s workspace root, confined by lstat, containment, and a stat re-check.',
  242. },
  243. {
  244. key: 'terminalController',
  245. pkg: 'api-terminal-controller',
  246. title: 'Session interactive terminal Remote controller',
  247. mode: 'core',
  248. note: 'Owns user terminal processes, default shell resolution and bounded screen recovery through the subprocess provider and typed Remote transport.',
  249. },
  250. {
  251. key: 'workspaceController',
  252. pkg: 'api-workspace-controller',
  253. title: 'Host Workspace Remote controller',
  254. mode: 'core',
  255. note: 'Owns Workspace commands and reconnect-safe Workspace state delivery through the generated Remote namespace.',
  256. },
  257. {
  258. key: 'directoryPickerController',
  259. pkg: 'api-workspace-controller',
  260. title: 'Host directory-picking Remote controller',
  261. mode: 'core',
  262. note: 'Carries the picking seam onto the wire: capability gating, cancellation, and the seam-coded failures a browser directory flow discriminates on.',
  263. },
  264. {
  265. key: 'invariants',
  266. pkg: 'invariants',
  267. title: 'Package-owned invariant registry',
  268. mode: 'core',
  269. consumers: ['session', 'agent', 'scope', 'agent-loop'],
  270. note: 'Companion subpaths register owner-local checks; the service owns selection, uniqueness, child fibers, and package-attributed failures.',
  271. },
  272. {
  273. key: 'typert',
  274. pkg: 'typert-registry',
  275. title: 'Runtime type registry',
  276. mode: 'core',
  277. consumers: ['typert-loader', 'api-gateway'],
  278. note: 'Plugins register live zod contributions directly or through dsh-typert-loader; the API gateway consumes invocation descriptors and providers, while other runtime consumers query schemas and reflection metadata at their own edges.',
  279. },
  280. {
  281. key: 'typertGateway',
  282. pkg: 'api-gateway',
  283. title: 'Typert Host invocation gateway',
  284. mode: 'core',
  285. note: 'Associates generated Remote descriptors with live Cordis services, resolves registered identities, and exposes unary calls through the shared Connection RPC carrier.',
  286. },
  287. {
  288. key: 'sessionPersistence',
  289. pkg: 'session-persistence',
  290. title: 'Durable session persistence seam',
  291. mode: 'seam',
  292. implementations: ['session-persistence-jsonl'],
  293. consumers: ['agent-loop', 'tool-bash', 'hooks-claude-code', 'hooks-codex', 'session-query', 'session-query-sqlite', 'message-feedback'],
  294. note: 'The JSONL backend persists the SessionEvent vocabulary as one artifact per Session.',
  295. },
  296. {
  297. key: 'settings',
  298. pkg: 'settings',
  299. title: 'User-settings seam',
  300. mode: 'seam',
  301. implementations: ['settings-file'],
  302. consumers: ['api-settings-controller', 'llm-deepseek', 'llm-pi-ai'],
  303. note: 'Plugins register namespace schemas and resolve layered values; providers store the raw document. The LLM adapters register their entry config as the composition base under the user section; the settings controller serves redacted layered descriptors and writes the user layer.',
  304. },
  305. {
  306. key: 'subagentModelSelection',
  307. pkg: 'tool-subagent',
  308. title: 'Subagent model-selection preference',
  309. mode: 'core',
  310. consumers: ['tool-subagent'],
  311. note: 'Owns the default-off settings namespace that Agent-scoped delegation tools sample when composing a new top-level Session.',
  312. },
  313. {
  314. key: 'credentials',
  315. pkg: 'credentials',
  316. title: 'Credential seam',
  317. mode: 'seam',
  318. implementations: ['credentials-local'],
  319. consumers: ['api-settings-controller', 'llm-deepseek', 'llm-pi-ai'],
  320. note: 'Configuration carries references to secrets; providers own the values. Consumers resolve per operation, so a rotated credential reaches the very next request; the settings controller exposes value-free views and write-only storage.',
  321. },
  322. {
  323. key: 'authorization',
  324. pkg: 'authorization',
  325. title: 'Authorization flow registry',
  326. mode: 'seam',
  327. implementations: [],
  328. consumers: ['llm-pi-ai'],
  329. note: 'Flows are registered by the plugin that knows how to obtain one credential and keyed by the record they write; the seam owns the conversation and the one-attempt-per-key lifecycle, never the protocol.',
  330. },
  331. {
  332. key: 'sessionTelemetry',
  333. pkg: 'session-telemetry',
  334. title: 'Session telemetry seam',
  335. mode: 'seam',
  336. implementations: ['session-telemetry-otel'],
  337. consumers: [],
  338. note: 'The seam captures, redacts, and hands session records to one backend; nothing else consumes the service — its output leaves the process.',
  339. },
  340. {
  341. key: 'storage',
  342. pkg: 'storage',
  343. title: 'Non-session storage hub',
  344. mode: 'seam',
  345. implementations: ['storage-json', 'storage-sqlite'],
  346. consumers: ['storage-domain'],
  347. note: 'Backends register side by side under names; data forms (domain first) mount on the hub and translate typed operations into opaque KV-unit primitives.',
  348. },
  349. {
  350. key: 'storageDomain',
  351. pkg: 'storage-domain',
  352. title: 'Domain data facility',
  353. mode: 'core',
  354. consumers: ['workspace'],
  355. note: 'Waits for every configured backend, then publishes the domain form as one lifecycle-bound service for typed durable state.',
  356. },
  357. {
  358. key: 'messageFeedback',
  359. pkg: 'message-feedback',
  360. title: 'Lifecycle-bound message feedback',
  361. mode: 'core',
  362. note: 'Owns per-assistant-message feedback in the canonical Session log, target validation, per-item compare-and-set, and the Host unary Remote contract. Feedback stays outside model history; log export follows the consumer policy.',
  363. },
  364. {
  365. key: 'sessionFeedback',
  366. pkg: 'command-feedback',
  367. title: 'Session-level feedback recorder',
  368. mode: 'core',
  369. note: 'Records one Session-level remark with its category as a log-only feedback/record event on a live Session through the Host unary Remote contract; the /feedback command shares the same producer.',
  370. },
  371. {
  372. key: 'workspaceRegistry',
  373. pkg: 'workspace',
  374. title: 'Workspace entity registry',
  375. mode: 'core',
  376. consumers: ['api-workspace-controller', 'api-session-controller'],
  377. note: 'Owns WorkspaceId-branded records over the domain facility; stable sessionIds accounts drive Host RPC and GUI projections.',
  378. },
  379. {
  380. key: 'sessionQuery',
  381. pkg: 'session-query',
  382. title: 'Session reads, traces, filters, and search',
  383. mode: 'seam',
  384. implementations: ['session-query-sqlite'],
  385. consumers: ['session-reference', 'tool-session-query'],
  386. note: 'The interface supplies exact reads, filters, and traces; its concrete backend adds full-text reconciliation, ranking, snippets, and cursor generations, while the model consumer owns workspace authority and cursor-free rendering.',
  387. },
  388. {
  389. key: 'fileReferences',
  390. pkg: 'file-reference',
  391. title: 'File reference discovery',
  392. mode: 'seam',
  393. implementations: ['file-reference-local'],
  394. consumers: ['api-session-controller'],
  395. note: 'The interface returns path-only completion candidates within an Agent cwd; providers own namespace access and ranking without reading file contents.',
  396. },
  397. {
  398. key: 'sessionReferenceResolver',
  399. pkg: 'session-reference',
  400. title: 'Cross-session snapshot preparation',
  401. mode: 'core',
  402. note: 'Projects bounded current-surface conversation snapshots into durable untrusted message context; host adapters own mention syntax.',
  403. },
  404. {
  405. key: 'sessionTitle',
  406. pkg: 'session-title',
  407. title: 'Log-backed session titles',
  408. mode: 'seam',
  409. implementations: ['session-title-first-prompt-llm', 'session-title-all-prompts-llm'],
  410. note: 'Owns the deterministic fallback, latest-title fold, and sole optional asynchronous provider registration.',
  411. },
  412. {
  413. key: 'systemPrompt',
  414. pkg: 'system-prompt',
  415. title: 'System prompt assembly registry',
  416. mode: 'core',
  417. consumers: ['agent-loop', 'tools', 'tool-fs', 'tool-terminal', 'tool-web'],
  418. note: 'Collects prompt sections and model-facing tool schemas for each step.',
  419. },
  420. {
  421. key: 'tools',
  422. pkg: 'tools',
  423. title: 'Tool registry and guarded execution pipeline',
  424. mode: 'core',
  425. consumers: ['agent-loop', 'tool-ask-user', 'tool-bash', 'tool-cordis', 'tool-fs', 'tool-terminal', 'tool-skill', 'tool-subagent', 'tool-todo', 'tool-web'],
  426. note: 'Registers capabilities, owns PTC mode transport, and routes calls through pre-policy, monotonic guards, around dispatch, post-policy, and final-result observation.',
  427. },
  428. {
  429. key: 'userQuestions',
  430. pkg: 'user-questions',
  431. title: 'Human question/answer seam',
  432. mode: 'seam',
  433. consumers: ['tool-ask-user'],
  434. note: 'UI front ends provide the active human-answer provider; tool-ask-user pauses a tool call on the provider-neutral ask() promise.',
  435. },
  436. {
  437. key: 'planMode',
  438. pkg: 'plan-mode',
  439. title: 'Plan collaboration state',
  440. mode: 'core',
  441. 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.',
  442. },
  443. {
  444. key: 'agentPresets',
  445. pkg: 'agent-presets',
  446. title: 'Per-session agent composition',
  447. mode: 'core',
  448. note: 'Discovers preset directories over trusted and user-authored roots and mounts one preset cordis.yml under an agent scope during creation, rejecting a row that never activates or that publishes into the root service realm.',
  449. },
  450. {
  451. key: 'commands',
  452. pkg: 'commands',
  453. title: 'Human command registry',
  454. mode: 'core',
  455. note: 'Plugins register direct human commands without sending invocations to the model.',
  456. },
  457. {
  458. key: 'sessionProjections',
  459. pkg: 'session-projection',
  460. title: 'Session projection units',
  461. mode: 'core',
  462. consumers: ['api-session-controller', 'tool-todo', 'session-title'],
  463. note: 'Domains register state-driven fold units; the eager drive keeps per-session watermark states and the Session controller serves baselines and pushes changed values.',
  464. },
  465. {
  466. key: 'sessionProjectionCache',
  467. pkg: 'session-projection-cache',
  468. title: 'Persisted projection cache',
  469. mode: 'core',
  470. consumers: ['api-session-controller', 'session-query', 'session-reference', 'subagent'],
  471. note: 'Durably checkpoints projection unit states per session (throttled + turn/end/detach mandatory points) and serves the cold-read ladder: cache row + persistence tail replay, so listings never load full logs.',
  472. },
  473. {
  474. key: 'skills',
  475. pkg: 'skill',
  476. title: 'Skill provider registry',
  477. mode: 'seam',
  478. implementations: ['skill-badge', 'skill-filesystem'],
  479. consumers: ['tool-skill'],
  480. note: 'Merges provider skill catalogs; tool-skill renders the session-prefix catalog and loads complete skill bodies.',
  481. },
  482. {
  483. key: 'agents',
  484. pkg: 'agent',
  485. title: 'Agent service',
  486. mode: 'core',
  487. consumers: ['agent-loop', 'acp', 'subagent-in-process-driver'],
  488. note: 'Owns live Agent handles, the create/resume factory seam, and process-local initiator propagation.',
  489. },
  490. {
  491. key: 'agentDefaultModel',
  492. pkg: 'agent-default-model',
  493. title: 'Default Agent model selection',
  494. mode: 'core',
  495. consumers: ['api-session-controller', 'headless'],
  496. note: 'Layers the default ModelSelection through settings so direct and Host-backed Agent entry points share one state owner.',
  497. },
  498. {
  499. key: 'agentLoop',
  500. pkg: 'agent-loop',
  501. title: 'Concrete loop driver',
  502. mode: 'bundle',
  503. consumers: ['base', 'sdk-minimal'],
  504. note: 'The one concrete loop plugin; extension packages depend on dsh-agent events and services, not on this package.',
  505. },
  506. {
  507. key: 'goals',
  508. pkg: 'goal',
  509. title: 'Same-session goal domain',
  510. mode: 'core',
  511. note: 'Folds revisioned objective state from the session log and keeps live continuation activation process-local.',
  512. },
  513. {
  514. key: 'ssh',
  515. pkg: 'ssh',
  516. title: 'POSIX SSH connection owner',
  517. mode: 'core',
  518. consumers: ['fs-ssh', 'subprocess-ssh', 'sandbox-ssh'],
  519. note: 'Owns one authenticated OpenSSH connection, installed helper identity, independent program streams and disconnect cleanup for the paired remote providers.',
  520. },
  521. {
  522. key: 'subprocess',
  523. pkg: 'subprocess',
  524. title: 'Subprocess seam',
  525. mode: 'seam',
  526. implementations: ['subprocess-local', 'subprocess-ssh'],
  527. consumers: ['bash-local', 'bash-sandbox', 'terminal-bash', 'lsp-stdio', 'subagent-acp', 'subagent-codex', 'subagent-claude-code'],
  528. note: 'The bash executors, the PTY shell backend, the LSP host, and the out-of-process ACP, Codex, and Claude Code subagent backends spawn through ctx.subprocess; the service owns process coordinates, tree/session lifetime, stdio dispositions, terminal mechanics, and kill escalation.',
  529. },
  530. {
  531. key: 'shell',
  532. pkg: 'shell',
  533. title: 'Bash executor seam',
  534. mode: 'seam',
  535. implementations: ['bash-local', 'bash-sandbox', 'pwsh-local'],
  536. consumers: ['tool-bash', 'tool-pwsh', 'hooks-claude-code', 'hooks-codex'],
  537. note: 'The model-facing shell tools and hook bridges consume this seam; sandboxed, remote, or PowerShell executors replace bash-local without touching them.',
  538. },
  539. {
  540. key: 'shellEnv',
  541. pkg: 'shell-env',
  542. title: 'Managed bash environment registry',
  543. mode: 'core',
  544. consumers: ['tool-bash', 'tool-pwsh'],
  545. note: 'Plugins declare effect-scoped DSH_* facts; each shell tool collects one trusted snapshot per execution and its executor rebuilds the namespace.',
  546. },
  547. {
  548. key: 'terminals',
  549. pkg: 'terminal',
  550. title: 'Persistent PTY session registry',
  551. mode: 'seam',
  552. implementations: ['terminal-bash'],
  553. consumers: ['tool-terminal'],
  554. note: 'The registry owns exact-Agent session identity and cleanup; backends own terminal mechanics, while tool-terminal exposes the owner-scoped model tools.',
  555. },
  556. {
  557. key: 'sandbox',
  558. pkg: 'sandbox',
  559. title: 'Process-sandbox seam',
  560. mode: 'seam',
  561. implementations: ['sandbox-local', 'sandbox-ssh'],
  562. consumers: ['bash-sandbox', 'terminal-bash'],
  563. 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.',
  564. },
  565. {
  566. key: 'sandboxPolicy',
  567. pkg: 'sandbox-policy',
  568. title: 'Sandbox policy home',
  569. mode: 'core',
  570. implementations: [],
  571. consumers: ['bash-sandbox', 'fs-sandbox', 'terminal-bash'],
  572. 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.',
  573. },
  574. {
  575. key: 'approval',
  576. pkg: 'user-approval',
  577. title: 'Approval seam',
  578. mode: 'seam',
  579. implementations: [],
  580. consumers: ['tools', 'tool-bash', 'acp'],
  581. 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`.',
  582. },
  583. {
  584. key: 'permissionPresets',
  585. pkg: 'permission-presets',
  586. title: 'Permission presets',
  587. mode: 'core',
  588. implementations: [],
  589. 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.',
  590. },
  591. {
  592. key: 'ptcRuntime',
  593. pkg: 'ptc-runtime',
  594. title: 'PTC execution seam',
  595. mode: 'seam',
  596. implementations: ['ptc-runtime-node', 'experimental-ptc-runtime-python'],
  597. consumers: ['tools', 'workflow-ptc'],
  598. note: 'Runs programs against host-provided async bindings; tools owns PTC presentation and workflow-ptc owns workflow orchestration.',
  599. },
  600. {
  601. key: 'fs',
  602. pkg: 'fs',
  603. title: 'Filesystem provider seam',
  604. mode: 'seam',
  605. implementations: ['fs-local', 'fs-sandbox', 'fs-ssh'],
  606. consumers: ['tool-fs'],
  607. companions: ['fs-observation-policy'],
  608. note: 'tool-fs executes read/write/edit through ctx.fs; fs-sandbox fences mutations by the shared sandbox mode; fs-observation-policy contributes observed-state checks through the fs/* event gate.',
  609. },
  610. {
  611. key: 'compaction',
  612. pkg: 'compaction',
  613. title: 'Compaction seam',
  614. mode: 'seam',
  615. implementations: ['compaction-basic'],
  616. consumers: ['compaction-basic'],
  617. note: 'The basic backend consumes post-step pressure and request-error recovery events; there is no model-facing compact tool.',
  618. },
  619. {
  620. key: 'subagents',
  621. pkg: 'subagent',
  622. title: 'Subagent provider and continuation service',
  623. mode: 'seam',
  624. implementations: ['subagent-spawn-in-process', 'subagent-fork-in-process', 'subagent-acp', 'subagent-codex', 'subagent-claude-code', 'subagent-dsh-sdk'],
  625. consumers: ['tool-subagent', 'tool-subagent-control', 'tool-ralph'],
  626. note: 'Providers implement transports; the service also owns optional Activation-based continuation orchestration, tool-subagent selects one-shot or continuable delegation, tool-subagent-control delivers follow-ups, and tool-ralph requires one fresh structured-output route.',
  627. },
  628. {
  629. key: 'agentTeams',
  630. pkg: 'experimental-agent-team',
  631. title: 'Agent Teams coordination domain',
  632. mode: 'core',
  633. consumers: ['experimental-tool-agent-team', 'experimental-client-ui-agent-team'],
  634. note: 'Owns the implicit-root roster, durable peer mailbox, shared task DAG, continuable-child lifecycle, and generated Team Remote methods; tool-agent-team contributes model controls and client-ui-agent-team mounts the browser contribution.',
  635. },
  636. {
  637. key: 'inspector',
  638. pkg: 'inspector',
  639. title: 'Cross-realm runtime inspection',
  640. mode: 'core',
  641. note: 'Owns the Worker-hosted CDP target and the transport-independent Host and Client observation and Cordis-tree query API.',
  642. },
  643. {
  644. key: 'jobs',
  645. pkg: 'jobs',
  646. title: 'Background job registry',
  647. mode: 'seam',
  648. implementations: ['jobs-local'],
  649. consumers: ['tool-bash', 'tool-terminal', 'tool-subagent', 'tool-jobs'],
  650. note: 'Producers (background bash, PTY sends, and subagent delegations) register running work; tool-jobs is the model-facing controller that reads, lists, and kills it; jobs-local is the process-local registry.',
  651. },
  652. {
  653. key: 'web',
  654. pkg: 'web',
  655. title: 'Web access provider registry',
  656. mode: 'seam',
  657. implementations: ['web-search-exa', 'web-search-perplexity', 'web-search-deepseek', 'web-fetch-http'],
  658. consumers: ['tool-web'],
  659. note: 'Search and fetch providers register into one ctx.web seam; tool-web owns the stable model-facing names.',
  660. },
  661. {
  662. key: 'spillStore',
  663. pkg: 'spill',
  664. title: 'Spill storage seam',
  665. mode: 'seam',
  666. implementations: ['spill-local'],
  667. consumers: ['spill-policy'],
  668. 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.',
  669. },
  670. {
  671. key: 'directoryPicker',
  672. pkg: 'host-directory-picker',
  673. title: 'Workspace-directory picking seam',
  674. mode: 'seam',
  675. implementations: ['host-directory-picker-native', 'host-directory-picker-browse'],
  676. consumers: ['api-workspace-controller'],
  677. note: 'Discriminated interaction capability: the native backend opens one OS chooser on the host display, the browse backend serves listing/creation primitives for the in-app browser; dual-face backends fill ui-workspace directory-flow slots from their browser halves (no wire advertisement).',
  678. },
  679. {
  680. key: 'webServer',
  681. pkg: 'host-webserver',
  682. title: 'HTTP route registration',
  683. mode: 'core',
  684. consumers: ['client-connection', 'client-modules', 'client-hmr'],
  685. note: 'Plain node:http carrier: named-route registry, index transform taps, and the static dist fallback; web-transport plugins register their own routes.',
  686. },
  687. {
  688. key: 'clientModules',
  689. pkg: 'client-modules',
  690. title: 'Client plugin graph host',
  691. mode: 'core',
  692. consumers: ['client-hmr'],
  693. note: 'Composes the __DSH_BOOT__ entry graph from an incremental dsh.client scan, serves plugin bundles, and notifies rebuilt/graph-changed subscribers.',
  694. },
  695. {
  696. key: 'workflowEngine',
  697. pkg: 'workflow',
  698. title: 'Workflow script engine',
  699. mode: 'seam',
  700. implementations: ['workflow-ptc'],
  701. consumers: ['tool-workflow', 'tool-ralph'],
  702. note: 'One engine per context, as in bash, with no named-provider registry; the general workflow and fixed Ralph consumers start runs whose agent() calls fan out through ctx.subagents.',
  703. },
  704. {
  705. key: 'webhookRuntime',
  706. pkg: 'webhook',
  707. title: 'Webhook rule runtime',
  708. mode: 'core',
  709. consumers: ['webhook-github'],
  710. note: 'Provider adapters dispatch authenticated deliveries; trusted plugins register independent process-local rules, and the runtime turns non-null results into ordinary Workspace-backed Sessions without delivery or completion state.',
  711. },
  712. {
  713. key: 'lsp',
  714. pkg: 'lsp',
  715. title: 'Language-server navigation seam',
  716. mode: 'seam',
  717. implementations: ['lsp-stdio'],
  718. consumers: ['tool-lsp'],
  719. note: 'Provider registration and selection plus normalized query execution over exactly four operations; the seam offers no protocol escape hatch, so a backend translates into the normalized request and result.',
  720. },
  721. {
  722. key: 'dynamicCordisRunner',
  723. pkg: 'cordis-host-runner',
  724. title: 'Dynamic Cordis package host runner',
  725. mode: 'core',
  726. consumers: ['tool-cordis'],
  727. note: 'Owns the in-memory definition registry, the vm sandbox for host halves, and the request-run round trip; browser pages reach the same service over the wire through its remote namespace.',
  728. },
  729. {
  730. key: 'cordisInspect',
  731. pkg: 'cordis-host-runner',
  732. title: 'Dynamic Cordis inspect registry',
  733. mode: 'core',
  734. consumers: ['tool-cordis'],
  735. note: 'Registers host inspect providers, mirrors the client provider manifest, and routes client queries through the dynamic Cordis transport.',
  736. },
  737. ]
  738. function generatedHeader(title: string): string[] {
  739. return [
  740. '<!-- Generated by scripts/gen-doc-graphs.ts - do not edit by hand.',
  741. ' Run `pnpm run gen-doc-graphs` to regenerate. -->',
  742. '',
  743. `# ${title}`,
  744. '',
  745. ]
  746. }
  747. function maintenanceFooter(source: string): string[] {
  748. return [`Maintenance mode: ${source}.`, '']
  749. }
  750. function graphIndexLink(rel: string): string {
  751. return relative('docs', rel).replaceAll('\\', '/')
  752. }
  753. function linkFromDoc(docRel: string, targetRel: string): string {
  754. return relative(dirname(docRel), targetRel).replaceAll('\\', '/')
  755. }
  756. function mermaidCode(value: string): string {
  757. return `<code>${value.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;')}</code>`
  758. }
  759. function repoLink(path: string, label: string, up = '..'): string {
  760. return `[${label}](${up}/${path})`
  761. }
  762. function sourceLink(source: string, up = '..'): string {
  763. return repoLink(source.split(':')[0] ?? source, `\`${source}\``, up)
  764. }
  765. function pkgLink(pkg: Pkg | undefined, fallback: string, up = '..'): string {
  766. return pkg ? repoLink(pkg.rel, `\`${pkg.short}\``, up) : `\`${fallback}\``
  767. }
  768. function pkgList(names: string[] | undefined, pkgsByShort: Map<string, Pkg>): string {
  769. if (!names || names.length === 0) return '-'
  770. return names.map(name => pkgLink(pkgsByShort.get(name), name)).join(', ')
  771. }
  772. function tableCell(value: string): string {
  773. return value.replace(/\|/g, '\\|').replace(/\n/g, '<br>')
  774. }
  775. function assertServiceRolesComplete(services: readonly ServiceEntry[]): void {
  776. const discovered = new Set(services.map(service => service.key))
  777. const classified = new Set(SERVICE_ROLES.map(role => role.key))
  778. const missing = [...discovered].filter(key => !classified.has(key)).sort()
  779. const stale = [...classified].filter(key => !discovered.has(key)).sort()
  780. if (missing.length || stale.length) {
  781. throw new Error([
  782. missing.length ? `missing service role classification: ${missing.join(', ')}` : '',
  783. stale.length ? `stale service role classification: ${stale.join(', ')}` : '',
  784. ].filter(Boolean).join('; '))
  785. }
  786. }
  787. function renderCapabilitySeams(pkgs: Pkg[], services: readonly ServiceEntry[]): string {
  788. assertServiceRolesComplete(services)
  789. const pkgsByShort = new Map(pkgs.map(pkg => [pkg.short, pkg]))
  790. 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'
  791. const nodes = new Map<string, string>()
  792. const edges = new Set<string>()
  793. const companionEdges = new Set<string>()
  794. const addNode = (id: string, label: string): void => {
  795. if (!nodes.has(id)) nodes.set(id, ` ${id}["${escLabel(label)}"]`)
  796. }
  797. const addEdge = (from: string, to: string): void => { edges.add(` ${from} --> ${to}`) }
  798. const lines = generatedHeader('Capability Seams And Core Services')
  799. lines.push(
  800. '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.',
  801. '',
  802. '```mermaid',
  803. 'flowchart LR',
  804. )
  805. for (const role of SERVICE_ROLES) {
  806. const svc = nodeId('svc', role.key)
  807. const owner = nodeId('pkg', role.pkg)
  808. addNode(owner, role.pkg)
  809. addNode(svc, `ctx.${role.key}<br/>${role.title}`)
  810. addEdge(owner, svc)
  811. for (const impl of role.implementations ?? []) {
  812. addNode(nodeId('pkg', impl), impl)
  813. addEdge(nodeId('pkg', impl), svc)
  814. }
  815. for (const consumer of role.consumers ?? []) {
  816. addNode(nodeId('pkg', consumer), consumer)
  817. addEdge(svc, nodeId('pkg', consumer))
  818. }
  819. for (const companion of role.companions ?? []) {
  820. addNode(nodeId('pkg', companion), companion)
  821. companionEdges.add(` ${svc} -. event gate .-> ${nodeId('pkg', companion)}`)
  822. }
  823. }
  824. lines.push(...nodes.values(), ...[...edges].sort(), ...[...companionEdges].sort())
  825. lines.push('```', '', '| ctx key | Role | Owner | Implementations | Direct consumers | Companion plugins | Note |', '| --- | --- | --- | --- | --- | --- | --- |')
  826. for (const role of SERVICE_ROLES) {
  827. 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)} |`)
  828. }
  829. lines.push('', ...maintenanceFooter(maintenance))
  830. return lines.join('\n')
  831. }
  832. function parseExampleCordis(rel: string): ExamplePlugin[] {
  833. const text = readFileSync(resolve(root, rel), 'utf8')
  834. const plugins: ExamplePlugin[] = []
  835. let current: { id: string; name?: string } | null = null
  836. const flush = (): void => {
  837. if (current?.name) plugins.push({ id: current.id, name: current.name })
  838. }
  839. for (const line of text.split('\n')) {
  840. // Top-level rows (`- id:`) and bundle-patch insert rows (` - id:`).
  841. const id = /^\s*-\s+id:\s+(.+?)\s*$/.exec(line)
  842. if (id?.[1] !== undefined) {
  843. flush()
  844. current = { id: stripYamlScalar(id[1]) }
  845. continue
  846. }
  847. const name = /^\s+name:\s+(.+?)\s*$/.exec(line)
  848. if (name?.[1] !== undefined && current) current.name = stripYamlScalar(name[1])
  849. }
  850. flush()
  851. return plugins
  852. }
  853. function stripYamlScalar(value: string): string {
  854. return value.trim().replace(/^['"]|['"]$/g, '')
  855. }
  856. const APP_EXAMPLES = [
  857. {
  858. id: 'dsh_base',
  859. rel: 'apps/cli/composition.md',
  860. title: 'DSH Base Composition',
  861. label: 'packages/bundle/base/cordis.patch.yml',
  862. config: 'packages/bundle/base/cordis.patch.yml',
  863. summary: 'The dsh-base bundle patch shared by the web, headless, sdk, and acp profiles; their mode bundles and user layers patch over it, while sdk-minimal owns a separate standalone tree.',
  864. },
  865. ]
  866. type AppExample = typeof APP_EXAMPLES[number]
  867. function renderAppComposition(example: AppExample): string {
  868. const plugins = parseExampleCordis(example.config)
  869. const maintenance = 'hybrid: the patch row list is parsed from its `cordis.yml`; app package expansion is curated from package source'
  870. const lines = generatedHeader(example.title)
  871. lines.push(
  872. example.summary,
  873. '',
  874. '```mermaid',
  875. 'flowchart LR',
  876. ` cfg["${escLabel(example.label)}<br/>cordis.yml"]`,
  877. )
  878. for (const plugin of plugins) {
  879. const pluginNode = nodeId(`plugin_${example.id}`, plugin.id)
  880. lines.push(` ${pluginNode}["${escLabel(plugin.id)}<br/>${escLabel(plugin.name)}"]`)
  881. lines.push(` cfg --> ${pluginNode}`)
  882. }
  883. lines.push(
  884. '```',
  885. '',
  886. '| Plugin id | Package / module |',
  887. '| --- | --- |',
  888. ...plugins.map(plugin => `| \`${plugin.id}\` | \`${plugin.name}\` |`),
  889. '',
  890. `Source config: [\`${example.config}\`](${linkFromDoc(example.rel, example.config)}).`,
  891. )
  892. lines.push('', ...maintenanceFooter(maintenance))
  893. return lines.join('\n')
  894. }
  895. type CallSiteIndex = Map<ts.SignatureDeclaration | ts.JSDocSignature, ts.CallExpression[]>
  896. /**
  897. * The only method names visitSource classifies; receiver typing runs on these
  898. * alone. Obligation: every method name matched by a branch inside visitSource
  899. * must appear here — the prefilter drops non-members before any branch runs,
  900. * so a branch for an unlisted name is silently dead.
  901. */
  902. const EVENT_API_METHODS = new Set(['on', 'once', 'emit', 'parallel', 'serial', 'waterfall', 'dispatch'])
  903. /**
  904. * Collect event dispatch/listener relations from real cross-file receiver types.
  905. *
  906. * TODO: the program is seeded from the host aggregate alone (ts-project.ts
  907. * documents why: one program cannot hold both faces' Context merges), so a
  908. * Client package enters only when a host file imports it. Client-face
  909. * listeners on client-face events are therefore under-reported —
  910. * `connection/reset` omits `ui-skill`/`ui-agent-preset`. Closing it needs a
  911. * second Client program whose relations merge into these, not a wider seed.
  912. */
  913. export class EventRelationCollector {
  914. private readonly relations = new Map<string, EventRelation>()
  915. private readonly fileCallSites = new Map<ts.SourceFile, CallSiteIndex>()
  916. private readonly localCalleeProofs = new Map<ts.FunctionDeclaration, boolean>()
  917. private globalCallSites: CallSiteIndex | null = null
  918. private readonly contextType: ts.Type
  919. private readonly agentDispatchType: ts.Type
  920. private readonly eventsServiceType: ts.Type
  921. private readonly packageSourceFiles: ReadonlySet<ts.SourceFile>
  922. constructor(
  923. private readonly project: TypeScriptProject,
  924. private readonly sources: readonly PackageSource[],
  925. ) {
  926. this.contextType = this.declaredType('vendor/cordis/src/context.ts', 'Context')
  927. this.agentDispatchType = this.declaredType('packages/core/agent/src/dispatch.ts', 'AgentEventDispatch')
  928. this.eventsServiceType = this.declaredType('vendor/cordis/src/events.ts', 'EventsService')
  929. this.packageSourceFiles = new Set(sources.map(source => source.sourceFile))
  930. }
  931. /** Return all event relations discovered from the Program. */
  932. collect(): Map<string, EventRelation> {
  933. for (const source of this.sources) this.visitSource(source)
  934. return this.relations
  935. }
  936. /** Resolve one named class/interface declaration to its merged instance type. */
  937. private declaredType(relativePath: string, name: string): ts.Type {
  938. const sourceFile = this.project.sourceFile(relativePath)
  939. const declaration = sourceFile.statements.find((statement): statement is ts.ClassDeclaration | ts.InterfaceDeclaration => {
  940. return (ts.isClassDeclaration(statement) || ts.isInterfaceDeclaration(statement)) && statement.name?.text === name
  941. })
  942. const symbol = declaration?.name && this.project.checker.getSymbolAtLocation(declaration.name)
  943. if (!symbol) throw new Error(`cannot resolve TypeScript type ${name} from ${relativePath}`)
  944. return this.project.checker.getDeclaredTypeOfSymbol(symbol)
  945. }
  946. /** Index resolved function calls in the given files for narrow argument-flow recovery. */
  947. private buildCallSiteIndex(files: Iterable<ts.SourceFile>): CallSiteIndex {
  948. const index: CallSiteIndex = new Map()
  949. const visit = (node: ts.Node): void => {
  950. if (ts.isCallExpression(node)) {
  951. const declaration = this.project.checker.getResolvedSignature(node)?.declaration
  952. if (declaration) {
  953. const calls = index.get(declaration) ?? []
  954. calls.push(node)
  955. index.set(declaration, calls)
  956. }
  957. }
  958. ts.forEachChild(node, visit)
  959. }
  960. for (const file of files) visit(file)
  961. return index
  962. }
  963. /**
  964. * Return every indexed call resolving to one local helper declaration.
  965. * Fast path: when every same-file reference to the non-exported helper is
  966. * provably a direct callee, module scoping confines all of its calls to that
  967. * file, so only that file is indexed. Any other reference form may alias
  968. * the function value outward, so the original full package-source index
  969. * decides instead.
  970. */
  971. private callSitesFor(owner: ts.FunctionDeclaration): ts.CallExpression[] {
  972. if (!this.globalCallSites && !this.provenLocalCallee(owner)) {
  973. this.globalCallSites = this.buildCallSiteIndex(this.packageSourceFiles)
  974. }
  975. if (this.globalCallSites) return this.globalCallSites.get(owner) ?? []
  976. const file = owner.getSourceFile()
  977. let index = this.fileCallSites.get(file)
  978. if (!index) {
  979. index = this.buildCallSiteIndex([file])
  980. this.fileCallSites.set(file, index)
  981. }
  982. return index.get(owner) ?? []
  983. }
  984. /**
  985. * Prove every same-file reference to one helper is a direct callee. The
  986. * proof owns its premises: an exported helper or a helper in a global
  987. * script file (no import/export means program-wide scope, callable from
  988. * another file with no same-file reference at all) fails immediately.
  989. * Alias escapes (re-export statements, default exports, value reads)
  990. * resolve back to the owner symbol at a non-callee position and fail the
  991. * proof, as does anything the scan cannot positively classify.
  992. */
  993. private provenLocalCallee(owner: ts.FunctionDeclaration): boolean {
  994. const cached = this.localCalleeProofs.get(owner)
  995. if (cached !== undefined) return cached
  996. if (hasExportModifier(owner) || !ts.isExternalModule(owner.getSourceFile())) {
  997. this.localCalleeProofs.set(owner, false)
  998. return false
  999. }
  1000. const name = owner.name
  1001. const ownerSymbol = name && this.project.checker.getSymbolAtLocation(name)
  1002. let proven = !!ownerSymbol
  1003. const refersToOwner = (identifier: ts.Identifier): boolean => {
  1004. // Shorthand properties resolve to the property symbol; ask for the value side.
  1005. const local = ts.isShorthandPropertyAssignment(identifier.parent)
  1006. ? this.project.checker.getShorthandAssignmentValueSymbol(identifier.parent)
  1007. : this.project.checker.getSymbolAtLocation(identifier)
  1008. if (!local) return false
  1009. const symbol = local.flags & ts.SymbolFlags.Alias
  1010. ? this.project.checker.getAliasedSymbol(local)
  1011. : local
  1012. return symbol === ownerSymbol
  1013. }
  1014. const visit = (node: ts.Node): void => {
  1015. if (!proven) return
  1016. if (ts.isIdentifier(node) && node !== name && node.text === name?.text
  1017. && !isDirectCallee(node) && refersToOwner(node)) {
  1018. proven = false
  1019. return
  1020. }
  1021. ts.forEachChild(node, visit)
  1022. }
  1023. visit(owner.getSourceFile())
  1024. this.localCalleeProofs.set(owner, proven)
  1025. return proven
  1026. }
  1027. /** Walk one package source file and classify event API calls by receiver type. */
  1028. private visitSource(source: PackageSource): void {
  1029. const visit = (node: ts.Node): void => {
  1030. if (ts.isCallExpression(node)) {
  1031. if (this.isAgentEventEmitter(node.expression)) {
  1032. const event = node.arguments[2]
  1033. if (event) {
  1034. for (const name of this.finiteStringValues(event) ?? []) {
  1035. this.addDispatcher(name, source.pkg, 'emitAgentEvent')
  1036. }
  1037. }
  1038. } else if (ts.isPropertyAccessExpression(node.expression) && EVENT_API_METHODS.has(node.expression.name.text)) {
  1039. const receiverKind = this.receiverKind(node.expression.expression)
  1040. const method = node.expression.name.text
  1041. if (receiverKind === 'events-service' && method === 'dispatch') {
  1042. const argumentList = node.arguments[1]
  1043. if (argumentList) {
  1044. for (const event of this.eventNamesFromArgumentList(argumentList, new Set())) {
  1045. this.addDispatcher(event, source.pkg, 'events.dispatch')
  1046. }
  1047. }
  1048. } else if (receiverKind === 'context' || receiverKind === 'agent-dispatch') {
  1049. const eventNames = this.eventNamesFromCall(node, receiverKind)
  1050. if (method === 'on' || method === 'once') {
  1051. for (const event of eventNames) this.ensure(event).listeners.add(source.pkg)
  1052. } else if (method === 'emit' || method === 'parallel' || method === 'serial' || method === 'waterfall') {
  1053. for (const event of eventNames) this.addDispatcher(event, source.pkg, method)
  1054. }
  1055. }
  1056. }
  1057. }
  1058. ts.forEachChild(node, visit)
  1059. }
  1060. visit(source.sourceFile)
  1061. }
  1062. /** Match the exported contained-notification helper by declaration identity. */
  1063. private isAgentEventEmitter(expression: ts.Expression): boolean {
  1064. if (!ts.isIdentifier(expression)) return false
  1065. const local = this.project.checker.getSymbolAtLocation(expression)
  1066. if (!local) return false
  1067. const symbol = local.flags & ts.SymbolFlags.Alias
  1068. ? this.project.checker.getAliasedSymbol(local)
  1069. : local
  1070. const declarations = symbol.declarations ?? []
  1071. return declarations.some((declaration) => {
  1072. return ts.isFunctionDeclaration(declaration)
  1073. && declaration.name?.text === 'emitAgentEvent'
  1074. && this.project.relativePath(declaration.getSourceFile()) === 'packages/core/agent/src/dispatch.ts'
  1075. })
  1076. }
  1077. /** Classify a receiver using assignability to the repository's actual event API types. */
  1078. private receiverKind(receiver: ts.Expression): EventReceiverKind | undefined {
  1079. const type = this.project.checker.getTypeAtLocation(receiver)
  1080. if (type.flags & (ts.TypeFlags.Any | ts.TypeFlags.Unknown | ts.TypeFlags.Never)) return undefined
  1081. if (this.project.checker.isTypeAssignableTo(type, this.eventsServiceType)) return 'events-service'
  1082. if (this.project.checker.isTypeAssignableTo(type, this.contextType)) return 'context'
  1083. if (this.project.checker.isTypeAssignableTo(type, this.agentDispatchType)) return 'agent-dispatch'
  1084. return undefined
  1085. }
  1086. /** Resolve the event-name argument for Context and fused agent dispatch calls. */
  1087. private eventNamesFromCall(call: ts.CallExpression, receiverKind: Exclude<EventReceiverKind, 'events-service'>): Set<string> {
  1088. const candidates = receiverKind === 'context' ? call.arguments.slice(0, 2) : call.arguments.slice(0, 1)
  1089. for (const candidate of candidates) {
  1090. const values = this.finiteStringValues(candidate)
  1091. if (values) return values
  1092. }
  1093. return new Set()
  1094. }
  1095. /** Recover the event slot from the argument array handed to EventsService.dispatch(). */
  1096. private eventNamesFromArgumentList(expression: ts.Expression, seen: Set<ts.Node>): Set<string> {
  1097. const current = unwrapExpression(expression)
  1098. if (seen.has(current)) return new Set()
  1099. seen.add(current)
  1100. if (ts.isArrayLiteralExpression(current)) {
  1101. for (const element of current.elements.slice(0, 2)) {
  1102. if (ts.isOmittedExpression(element) || ts.isSpreadElement(element)) continue
  1103. const values = this.finiteStringValues(element)
  1104. if (values) return values
  1105. }
  1106. return new Set()
  1107. }
  1108. if (ts.isConditionalExpression(current)) {
  1109. return unionSets(
  1110. this.eventNamesFromArgumentList(current.whenTrue, new Set(seen)),
  1111. this.eventNamesFromArgumentList(current.whenFalse, new Set(seen)),
  1112. )
  1113. }
  1114. if (!ts.isIdentifier(current)) return new Set()
  1115. const symbol = this.project.checker.getSymbolAtLocation(current)
  1116. if (!symbol) return new Set()
  1117. const events = new Set<string>()
  1118. for (const declaration of symbol.declarations ?? []) {
  1119. if (ts.isVariableDeclaration(declaration) && declaration.initializer && isConstDeclaration(declaration)) {
  1120. addAll(events, this.eventNamesFromArgumentList(declaration.initializer, new Set(seen)))
  1121. } else if (ts.isParameter(declaration)) {
  1122. addAll(events, this.eventNamesFromParameter(declaration, seen))
  1123. }
  1124. }
  1125. return events
  1126. }
  1127. /** Follow a non-exported local helper parameter back to every resolved call site. */
  1128. private eventNamesFromParameter(parameter: ts.ParameterDeclaration, seen: Set<ts.Node>): Set<string> {
  1129. const owner = parameter.parent
  1130. if (!ts.isFunctionDeclaration(owner) || hasExportModifier(owner)) return new Set()
  1131. const index = owner.parameters.indexOf(parameter)
  1132. if (index < 0) return new Set()
  1133. const events = new Set<string>()
  1134. for (const call of this.callSitesFor(owner)) {
  1135. const argument = call.arguments[index]
  1136. if (argument) addAll(events, this.eventNamesFromArgumentList(argument, new Set(seen)))
  1137. }
  1138. return events
  1139. }
  1140. /** Return a finite string-literal value set, rejecting widened and generic strings. */
  1141. private finiteStringValues(expression: ts.Expression): Set<string> | undefined {
  1142. const current = unwrapExpression(expression)
  1143. if (ts.isStringLiteralLike(current)) return new Set([current.text])
  1144. if (this.isForwardedAgentEventParameter(current)) return undefined
  1145. return finiteStringTypeValues(this.project.checker.getTypeAtLocation(current))
  1146. }
  1147. /** Reject the contextual parameter inside the AgentEventDispatch forwarding object. */
  1148. private isForwardedAgentEventParameter(expression: ts.Expression): boolean {
  1149. if (!ts.isIdentifier(expression)) return false
  1150. const declarations = this.project.checker.getSymbolAtLocation(expression)?.declarations ?? []
  1151. return declarations.some((declaration) => {
  1152. if (!ts.isParameter(declaration)) return false
  1153. const method = declaration.parent
  1154. if (!ts.isMethodDeclaration(method) || !ts.isObjectLiteralExpression(method.parent)) return false
  1155. const contextualType = this.project.checker.getContextualType(method.parent)
  1156. return contextualType !== undefined
  1157. && this.project.checker.isTypeAssignableTo(contextualType, this.agentDispatchType)
  1158. })
  1159. }
  1160. /** Get or create one relation row. */
  1161. private ensure(event: string): EventRelation {
  1162. const existing = this.relations.get(event)
  1163. if (existing) return existing
  1164. const relation = { dispatchers: new Map<string, Set<string>>(), listeners: new Set<string>() }
  1165. this.relations.set(event, relation)
  1166. return relation
  1167. }
  1168. /** Add one dispatcher method without duplicating package/method labels. */
  1169. private addDispatcher(event: string, pkg: string, method: string): void {
  1170. const relation = this.ensure(event)
  1171. const methods = relation.dispatchers.get(pkg) ?? new Set<string>()
  1172. methods.add(method)
  1173. relation.dispatchers.set(pkg, methods)
  1174. }
  1175. }
  1176. /** Return whether an identifier is the callee of a call, seen through value-preserving wrappers. */
  1177. function isDirectCallee(identifier: ts.Identifier): boolean {
  1178. let current: ts.Node = identifier
  1179. while (
  1180. ts.isParenthesizedExpression(current.parent)
  1181. || ts.isAsExpression(current.parent)
  1182. || ts.isTypeAssertionExpression(current.parent)
  1183. || ts.isNonNullExpression(current.parent)
  1184. || ts.isSatisfiesExpression(current.parent)
  1185. ) {
  1186. current = current.parent
  1187. }
  1188. return ts.isCallExpression(current.parent) && current.parent.expression === current
  1189. }
  1190. /** Peel syntax-only wrappers that do not change an expression's runtime value. */
  1191. function unwrapExpression(expression: ts.Expression): ts.Expression {
  1192. let current = expression
  1193. while (
  1194. ts.isParenthesizedExpression(current)
  1195. || ts.isAsExpression(current)
  1196. || ts.isTypeAssertionExpression(current)
  1197. || ts.isNonNullExpression(current)
  1198. || ts.isSatisfiesExpression(current)
  1199. ) {
  1200. current = current.expression
  1201. }
  1202. return current
  1203. }
  1204. /** Return every value only when a type is a closed string-literal union. */
  1205. function finiteStringTypeValues(type: ts.Type): Set<string> | undefined {
  1206. if (type.flags & ts.TypeFlags.StringLiteral) {
  1207. return new Set([(type as ts.StringLiteralType).value])
  1208. }
  1209. if (type.flags & ts.TypeFlags.Never) return new Set()
  1210. if (!type.isUnion()) return undefined
  1211. const values = new Set<string>()
  1212. for (const member of type.types) {
  1213. const memberValues = finiteStringTypeValues(member)
  1214. if (!memberValues) return undefined
  1215. addAll(values, memberValues)
  1216. }
  1217. return values
  1218. }
  1219. /** Return whether a variable declaration belongs to a const declaration list. */
  1220. function isConstDeclaration(declaration: ts.VariableDeclaration): boolean {
  1221. return (declaration.parent.flags & ts.NodeFlags.Const) !== 0
  1222. }
  1223. /** Return whether a declaration is visible to callers outside its source module. */
  1224. function hasExportModifier(node: ts.Node): boolean {
  1225. return ts.canHaveModifiers(node) && (ts.getModifiers(node)?.some((modifier) => {
  1226. return modifier.kind === ts.SyntaxKind.ExportKeyword || modifier.kind === ts.SyntaxKind.DefaultKeyword
  1227. }) ?? false)
  1228. }
  1229. /** Add every member of source to target. */
  1230. function addAll<T>(target: Set<T>, source: ReadonlySet<T>): void {
  1231. for (const value of source) target.add(value)
  1232. }
  1233. /** Return the union of two sets without mutating either input. */
  1234. function unionSets<T>(left: ReadonlySet<T>, right: ReadonlySet<T>): Set<T> {
  1235. const out = new Set(left)
  1236. addAll(out, right)
  1237. return out
  1238. }
  1239. /**
  1240. * Select the package source files of one project in deterministic order.
  1241. * @param project - the loaded repository TypeScript project.
  1242. * @returns `packages/<group>/<pkg>/src` files tagged with their package name.
  1243. */
  1244. export function collectPackageSources(project: TypeScriptProject): PackageSource[] {
  1245. return project.sourceFiles().flatMap((sourceFile): PackageSource[] => {
  1246. const rel = project.relativePath(sourceFile)
  1247. const match = /^packages\/[^/]+\/([^/]+)\/src\/.+\.ts$/.exec(rel)
  1248. return match?.[1] ? [{ rel, pkg: match[1], sourceFile }] : []
  1249. }).sort((left, right) => left.rel.localeCompare(right.rel))
  1250. }
  1251. function collectEventRelations(): Map<string, EventRelation> {
  1252. const project = new TypeScriptProject(root)
  1253. return new EventRelationCollector(project, collectPackageSources(project)).collect()
  1254. }
  1255. function relationPackages(map: Map<string, Set<string>>, pkgsByShort: Map<string, Pkg>): string {
  1256. if (map.size === 0) return '-'
  1257. return [...map.entries()]
  1258. .sort(([a], [b]) => a.localeCompare(b))
  1259. .map(([pkg, methods]) => `${pkgLink(pkgsByShort.get(pkg), pkg)} (${[...methods].sort().map(m => `\`${m}\``).join(', ')})`)
  1260. .join(', ')
  1261. }
  1262. function listenerPackages(listeners: Set<string>, pkgsByShort: Map<string, Pkg>): string {
  1263. if (listeners.size === 0) return '-'
  1264. return [...listeners].sort().map(pkg => pkgLink(pkgsByShort.get(pkg), pkg)).join(', ')
  1265. }
  1266. function renderEventRelations(pkgs: Pkg[], events: readonly EventEntry[]): string {
  1267. const relations = collectEventRelations()
  1268. const pkgsByShort = new Map(pkgs.map(pkg => [pkg.short, pkg]))
  1269. const maintenance = 'generated: Cordis event declarations and producer/listener edges are resolved from the repository TypeScript Program'
  1270. const lines = generatedHeader('Event Producer And Consumer Matrix')
  1271. lines.push(
  1272. 'This matrix shows which packages dispatch each harness-owned event and which packages listen to it. Events are many-to-many, so the dense relation data is presented as a table rather than one large graph. Receiver and event-name types also cover contained dispatch sites that deliberately bypass `ctx.emit`, such as subagent lifecycle containment.',
  1273. '',
  1274. '| Event | Mode | Declared in | Dispatchers | Listeners |',
  1275. '| --- | --- | --- | --- | --- |',
  1276. )
  1277. for (const event of [...events].sort((a, b) => a.name.localeCompare(b.name))) {
  1278. const relation = relations.get(event.name) ?? { dispatchers: new Map<string, Set<string>>(), listeners: new Set<string>() }
  1279. lines.push(`| \`${event.name}\` | \`${event.mode}\` | ${sourceLink(event.source)} | ${relationPackages(relation.dispatchers, pkgsByShort)} | ${listenerPackages(relation.listeners, pkgsByShort)} |`)
  1280. }
  1281. // Every declared event needs a dispatcher: zero means dead vocabulary or an
  1282. // unrecognized semantic dispatch form. Listener-free extension points remain
  1283. // valid. Client-declared events are exempt: the relation scan seeds the HOST
  1284. // aggregate program only (host+client cannot share one program — the cordis
  1285. // Context merges collide), so client dispatch sites are structurally
  1286. // invisible here; their rows stay in the table for the declarations' sake.
  1287. const undispatched = [...events]
  1288. .filter(event => !event.source.startsWith('packages/client/'))
  1289. .filter(event => (relations.get(event.name)?.dispatchers.size ?? 0) === 0)
  1290. .map(event => event.name)
  1291. .sort()
  1292. if (undispatched.length > 0) {
  1293. throw new Error(
  1294. `event-producer-consumer matrix: no dispatcher found for declared event${undispatched.length > 1 ? 's' : ''} `
  1295. + `${undispatched.map(name => `"${name}"`).join(', ')} — dead vocabulary, or a dispatch form the semantic scan misses `
  1296. + '(teach scripts/gen-doc-graphs.ts that form)',
  1297. )
  1298. }
  1299. const declared = new Set(events.map(event => event.name))
  1300. const extra = [...relations.keys()].filter(event => !declared.has(event)).sort()
  1301. if (extra.length > 0) {
  1302. lines.push('', '## Non-harness or undeclared event strings seen in package source', '', '| Event string | Dispatchers | Listeners |', '| --- | --- | --- |')
  1303. for (const event of extra) {
  1304. const relation = relations.get(event)
  1305. if (!relation) continue
  1306. lines.push(`| \`${event}\` | ${relationPackages(relation.dispatchers, pkgsByShort)} | ${listenerPackages(relation.listeners, pkgsByShort)} |`)
  1307. }
  1308. }
  1309. lines.push('', ...maintenanceFooter(maintenance))
  1310. return lines.join('\n')
  1311. }
  1312. function renderLifecycle(): string {
  1313. const maintenance = 'curated Mermaid sequence; exact event signatures live in the generated Cordis catalog'
  1314. return [
  1315. ...generatedHeader('Agent Turn And Step Lifecycle'),
  1316. 'This sequence is the visual companion to [architecture.md](architecture.md#turn-flow). It keeps durable replay facts on `session/event` and live control/status on `agent/*`.',
  1317. '',
  1318. '```mermaid',
  1319. 'sequenceDiagram',
  1320. ' participant User',
  1321. ' participant Agent',
  1322. ' participant Driver',
  1323. ' participant Hooks as hook listeners',
  1324. ' participant Prompt as ctx.systemPrompt',
  1325. ' participant LLM as ctx.llm',
  1326. ' participant Tools as ctx.tools',
  1327. ' participant Session',
  1328. ' participant SDK as UI or SDK listener',
  1329. ' User->>Agent: followup(content)',
  1330. ` Agent-->>SDK: ${mermaidCode('agent/inbox/spliced')}`,
  1331. ` Agent-->>SDK: ${mermaidCode('agent/inbox/inserted')} { message }`,
  1332. ' Agent->>Driver: queued work wakes driver',
  1333. ` Driver-->>SDK: ${mermaidCode('agent/status')} running`,
  1334. ` Driver->>Session: ${mermaidCode('turn/start')}`,
  1335. ' Note over Agent,Driver: claim pending next-step input plus one queued prompt',
  1336. ` Driver-->>SDK: ${mermaidCode('agent/inbox/spliced')} pure deletion`,
  1337. ` Driver-->>SDK: ${mermaidCode('agent/inbox/claimed')} { message, turn } per message`,
  1338. ` Driver->>Prompt: ${mermaidCode('system-prompt/assemble')} waterfall`,
  1339. ` Driver->>Hooks: ${mermaidCode('agent/pre-step')} waterfall`,
  1340. ' Hooks-->>Driver: authoritative reject or enter(messages)',
  1341. ' alt proposed step rejected, first batch empty, or pre-step failed',
  1342. ' Driver-->>Driver: claimed batch stays removed, the open turn spends no step',
  1343. ' else enter proposed step',
  1344. ` Driver->>Session: ${mermaidCode('step/start')}`,
  1345. ` Driver->>Hooks: ${mermaidCode('agent/request')} waterfall`,
  1346. ' Driver->>LLM: prepareCall(config, signal)',
  1347. ' Note over Driver,LLM: cancellation during either async phase commits neither system nor users',
  1348. ' Note over Driver,Session: synchronous admission using the prepared call capability',
  1349. ` Driver->>Session: ${mermaidCode('system/message')} ordered per-node reconciliation`,
  1350. ` Driver->>Session: ${mermaidCode('user/message')} per entered message`,
  1351. ` Driver->>Session: ${mermaidCode('request/header')} and ${mermaidCode('request/context')} as needed`,
  1352. ' Driver->>Driver: derive and freeze request from the log',
  1353. ` Driver->>LLM: bound prepared call through ${mermaidCode('llm/stream')} waterfall`,
  1354. ' LLM-->>Driver: StreamChunk*',
  1355. ` Driver-->>SDK: ${mermaidCode('agent/assistant-stream')} chunk*`,
  1356. ' alt final adapter or terminal in-band request failure',
  1357. ` Driver->>Session: ${mermaidCode('assistant/attempt')}`,
  1358. ` Driver-->>SDK: ${mermaidCode('agent/assistant-stream')} committed end`,
  1359. ` Driver->>Hooks: ${mermaidCode('agent/request-error')} waterfall`,
  1360. ' Hooks-->>Driver: return retry action or preserve the original error',
  1361. ' Note over Driver,LLM: retry in the open step: prepare and reconcile the same rendered assembly without repeating pre-step or users',
  1362. ' else model request succeeded',
  1363. ` Driver->>Session: ${mermaidCode('assistant/message')}`,
  1364. ` Driver-->>SDK: ${mermaidCode('agent/assistant-stream')} committed end`,
  1365. ' Driver->>Tools: classify pending call by executionMode',
  1366. ' loop barriers and bounded rolling pool, reclassify before start',
  1367. ' opt call starts',
  1368. ` Driver->>Session: ${mermaidCode('tool/call')}`,
  1369. ' Driver->>Tools: ordered pre, concurrent execute',
  1370. ' Tools-->>Session: tool-owned events when applicable',
  1371. ' end',
  1372. ' opt next model-order result ready',
  1373. ' Driver->>Tools: ordered post',
  1374. ` Driver->>Session: ${mermaidCode('tool/result')}`,
  1375. ' end',
  1376. ' end',
  1377. ` Driver->>Session: ${mermaidCode('step/end')}`,
  1378. ' opt natural stop and next-step inbox empty',
  1379. ` Driver->>Hooks: ${mermaidCode('agent/turn-stopping')} serial terminal checkpoint`,
  1380. ' end',
  1381. ' opt next-step input is pending',
  1382. ' Driver-->>Driver: claim pending next-step input',
  1383. ` Driver-->>SDK: ${mermaidCode('agent/inbox/claimed')} { message, turn } per message`,
  1384. ` Driver->>Hooks: ${mermaidCode('agent/pre-step')} waterfall`,
  1385. ' Hooks-->>Driver: authoritative reject or enter(messages)',
  1386. ' end',
  1387. ' end',
  1388. ' end',
  1389. ` Driver->>Session: ${mermaidCode('turn/end')}`,
  1390. ` Driver-->>SDK: ${mermaidCode('agent/status')} idle`,
  1391. '```',
  1392. '',
  1393. 'The `assistant/message` event records every successful provider call, including content-less and `max-tokens` finishes, and embeds the exact compact timed stream. Empty content stays out of derived history. A failed, retried, cancelled, or stream-error attempt that reaches settlement without a surface message records its stream as `assistant/attempt`. Live `agent/assistant-stream` chunk frames are transient; replay reads either durable settlement, and a hard process loss before settlement leaves no durable attempt stream.',
  1394. '',
  1395. '`dsh-compaction-basic` uses `agent/pre-step` for pressure before request derivation and `agent/request-error` only for canonical context overflow. Once either trigger qualifies, optional tool-result pruning runs before summary selection. Recovery runs within the open step and retries only when pruning or summarization advances the surface replacement generation; otherwise the original request error remains authoritative. Each retry prepares its call and reconciles the retained rendered assembly before request derivation, without repeating assembly, pre-step, or user admission.',
  1396. '',
  1397. 'The returned `agent/pre-step` decision is authoritative; listeners wrapping `next()` preserve downstream messages and `startsRequestSeries` unless replacement is intentional. Steering and injected context pass through the same waterfall after a later claim operation takes their next-step batch.',
  1398. '',
  1399. 'SDK users that need replayable transcript data should consume `session/event`; `agent/*` is the live coordination API for queue/status, prompt interception, request construction, steering, continuation, and errors.',
  1400. '',
  1401. ...maintenanceFooter(maintenance),
  1402. ].join('\n')
  1403. }
  1404. function renderToolPipeline(): string {
  1405. const maintenance = 'curated Mermaid flow; exact tool schemas and event signatures live in generated catalogs'
  1406. return [
  1407. ...generatedHeader('Tool Execution Pipeline'),
  1408. 'This graph shows where policy, hooks, sandboxing, filesystem guards, result rewriting, final-outcome observation, and UI rendering run without changing the loop. The `tools/pre-execute` waterfall runs first, monotonic guards run next, and the `tools/execute` and `tools/post-execute` waterfalls follow; the three waterfalls may transform a call. Definition-owned `finalizeContent` and `tools/result` run afterward.',
  1409. '',
  1410. '```mermaid',
  1411. 'flowchart TD',
  1412. ' model["Assistant message contains tool-call block"]',
  1413. ` toolCall["Session event: ${mermaidCode('tool/call')}<br/>logged before execution"]`,
  1414. ' presentCall["UI pending card<br/>presentCall(args)"]',
  1415. ` pre["${mermaidCode('tools/pre-execute')} waterfall<br/>hooks, permission, sandbox"]`,
  1416. ' guards["Registered monotonic guards<br/>deny or abstain; identity protected"]',
  1417. ' denied["denied or approval refused<br/>tool body skipped"]',
  1418. ` approval["${mermaidCode('ctx.approval')} one-shot prompt<br/>absent or unanswerable: deny"]`,
  1419. ` around["${mermaidCode('tools/execute')} waterfall<br/>timeout, retry, metrics (around dispatch)"]`,
  1420. ' toolBody["Registered tool execute() body"]',
  1421. ` fsGate["${mermaidCode('fs/write-intent')} or ${mermaidCode('fs/edit-intent')}<br/>tool-fs mutations only"]`,
  1422. ` owned["Tool-owned session events<br/>${mermaidCode('todo/write')}, ${mermaidCode('fs/observed')}, ${mermaidCode('hook/invoked')}, ${mermaidCode('hook/result')}, ${mermaidCode('tool/ptc-dispatch')}"]`,
  1423. ` post["${mermaidCode('tools/post-execute')} waterfall<br/>accept, block, replace, add context"]`,
  1424. ' normalized["Registry outer normalization<br/>pipeline/result snapshot throws become isError"]',
  1425. ' finalize["ToolDefinition.finalizeContent<br/>last content-only invariant"]',
  1426. ` final["${mermaidCode('tools/result')} synchronous notification<br/>frozen authoritative outcome"]`,
  1427. ' context["Active-batch additionalContexts FIFO<br/>injected user/message after recorded tool results"]',
  1428. ` toolResult["Session event: ${mermaidCode('tool/result')}<br/>single model-facing outcome"]`,
  1429. ' allResults["Tool batch settled<br/>recorded tool/result events complete"]',
  1430. ' presentResult["UI completed card<br/>presentResult(args, result)"]',
  1431. ' model --> toolCall',
  1432. ' toolCall --> presentCall',
  1433. ' toolCall --> pre',
  1434. ' pre -->|allow| guards',
  1435. ' guards -->|allow| around',
  1436. ' guards -->|deny| denied',
  1437. ' guards -.->|throw| normalized',
  1438. ' around --> toolBody',
  1439. ' pre -->|deny| denied',
  1440. ' pre -->|ask| approval',
  1441. ' approval -->|allowed-once| guards',
  1442. ' approval -->|rejected, cancelled, unavailable| denied',
  1443. ' approval -.->|throw| normalized',
  1444. ' denied --> post',
  1445. ' pre -.->|throw| normalized',
  1446. ' toolBody --> fsGate',
  1447. ' fsGate --> toolBody',
  1448. ' toolBody --> owned',
  1449. ' toolBody --> around',
  1450. ' around --> post',
  1451. ' around -.->|wrapper throws| normalized',
  1452. ' post -.->|throw| normalized',
  1453. ' post --> finalize',
  1454. ' normalized --> finalize',
  1455. ' finalize --> final',
  1456. ' final --> toolResult',
  1457. ' toolResult --> presentResult',
  1458. ' toolResult --> allResults',
  1459. ' allResults --> context',
  1460. '```',
  1461. '',
  1462. '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`. The registry losslessly snapshots the candidate result and normalizes a snapshot failure before the visible definition\'s snapshotted `finalizeContent` callback enforces its synchronous content-only invariant. `tools/result` then observes the immutable, lossless-JSON outcome. This lets hooks span tool families without coupling the tools to one policy service. PTC mode sends both the reserved `run_code` transport and its serialized sub-calls through the pipeline; sub-calls carry the parent token, log `tool/ptc-dispatch`, return denials as binding rejections, and omit `additionalContexts` to preserve call/result adjacency.',
  1463. '',
  1464. ...maintenanceFooter(maintenance),
  1465. ].join('\n')
  1466. }
  1467. function renderDocs(): GraphDoc[] {
  1468. const pkgs = collectPackageGraph(root, GROUP_ORDER, 'gen-doc-graphs')
  1469. const { model } = projectCordisCatalog(root, CORDIS_CATALOG_POLICY)
  1470. const docs: GraphDoc[] = [
  1471. { rel: 'docs/capability-seams.md', content: renderCapabilitySeams(pkgs, model.services) },
  1472. ...APP_EXAMPLES.map(example => ({ rel: example.rel, content: renderAppComposition(example) })),
  1473. { rel: 'docs/event-producer-consumer.md', content: renderEventRelations(pkgs, model.events) },
  1474. { rel: 'docs/agent-lifecycle.md', content: renderLifecycle() },
  1475. { rel: 'docs/tool-execution-pipeline.md', content: renderToolPipeline() },
  1476. ]
  1477. docs.unshift({ rel: 'docs/graph-atlas.md', content: renderIndex(docs) })
  1478. return docs
  1479. }
  1480. function renderIndex(docs: GraphDoc[]): string {
  1481. const labels: Record<string, string> = {
  1482. 'docs/capability-seams.md': 'capability seams and core services',
  1483. 'apps/cli/composition.md': 'dsh shared base composition',
  1484. 'docs/event-producer-consumer.md': 'event producer/consumer matrix',
  1485. 'docs/agent-lifecycle.md': 'agent turn and step lifecycle',
  1486. 'docs/tool-execution-pipeline.md': 'tool execution pipeline',
  1487. }
  1488. const modes: Record<string, string> = {
  1489. 'docs/capability-seams.md': 'hybrid generated',
  1490. 'apps/cli/composition.md': 'hybrid generated',
  1491. 'docs/event-producer-consumer.md': 'hybrid generated',
  1492. 'docs/agent-lifecycle.md': 'curated',
  1493. 'docs/tool-execution-pipeline.md': 'curated',
  1494. }
  1495. const rows = [
  1496. '| [module dependency graph](module-graph.md) | `generated` |',
  1497. '| [tool schema catalog and package map](tool-catalog.md) | `generated` |',
  1498. ...docs.map((doc) => {
  1499. const link = graphIndexLink(doc.rel)
  1500. return `| [${labels[doc.rel] ?? link}](${link}) | \`${modes[doc.rel] ?? 'generated'}\` |`
  1501. }),
  1502. ]
  1503. const maintenance = 'mixed: each linked page declares generated, hybrid, or curated mode'
  1504. return [
  1505. ...generatedHeader('Documentation Graph Index'),
  1506. 'These diagrams show relationships that the generated catalogs do not. Use them to find package relationships, capability seams, event flow, model-facing tools, app composition, and runtime lifecycle paths. Exact signatures and type definitions still live in the [subsystem pages](subsystems/core.md) (types + the generated Cordis API regions) and [tool-catalog.md](tool-catalog.md).',
  1507. '',
  1508. 'The process decision behind this index is recorded in [the documentation graph Agent Note](../.agents/notes/archived/process/2026-07-03-documentation-graph-atlas.md).',
  1509. '',
  1510. '| Graph | Mode |',
  1511. '| --- | --- |',
  1512. ...rows,
  1513. '',
  1514. 'Regenerate with `pnpm run gen-doc-graphs`; verify freshness with `pnpm run verify-doc-graphs`.',
  1515. '',
  1516. ...maintenanceFooter(maintenance),
  1517. ].join('\n')
  1518. }
  1519. function main(): void {
  1520. const docs = renderDocs()
  1521. if (process.argv.includes('--check')) {
  1522. const stale: string[] = []
  1523. for (const doc of docs) {
  1524. const abs = resolve(root, doc.rel)
  1525. const committed = existsSync(abs) ? readFileSync(abs, 'utf8') : null
  1526. if (committed !== doc.content) stale.push(doc.rel)
  1527. }
  1528. if (stale.length === 0) {
  1529. console.log(`gen-doc-graphs: ${docs.length} graph doc(s) are up to date.`)
  1530. return
  1531. }
  1532. console.error(`gen-doc-graphs: stale graph doc(s): ${stale.join(', ')}. Run \`pnpm run gen-doc-graphs\` and commit the result.`)
  1533. process.exit(1)
  1534. }
  1535. for (const doc of docs) {
  1536. mkdirSync(dirname(resolve(root, doc.rel)), { recursive: true })
  1537. writeFileSync(resolve(root, doc.rel), doc.content)
  1538. }
  1539. console.log(`gen-doc-graphs: wrote ${docs.length} graph doc(s).`)
  1540. }
  1541. if (process.argv[1] && import.meta.filename === resolve(process.argv[1])) {
  1542. main()
  1543. }