@hydranium/core 1.0.0-next.16 → 1.0.0-next.168

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (505) hide show
  1. package/README.md +5 -1
  2. package/lib/documents/ast-document-manager.d.ts +190 -29
  3. package/lib/documents/ast-document-manager.d.ts.map +1 -1
  4. package/lib/documents/ast-document-manager.js +235 -38
  5. package/lib/documents/ast-document-manager.js.map +1 -1
  6. package/lib/documents/client-ids.d.ts +5 -19
  7. package/lib/documents/client-ids.d.ts.map +1 -1
  8. package/lib/documents/client-ids.js +5 -19
  9. package/lib/documents/client-ids.js.map +1 -1
  10. package/lib/documents/client-session-errors.d.ts +15 -0
  11. package/lib/documents/client-session-errors.d.ts.map +1 -0
  12. package/lib/documents/client-session-errors.js +15 -0
  13. package/lib/documents/client-session-errors.js.map +1 -0
  14. package/lib/documents/client-session-registry.d.ts +138 -0
  15. package/lib/documents/client-session-registry.d.ts.map +1 -0
  16. package/lib/documents/client-session-registry.js +187 -0
  17. package/lib/documents/client-session-registry.js.map +1 -0
  18. package/lib/documents/file-system-task-queue.d.ts +49 -0
  19. package/lib/documents/file-system-task-queue.d.ts.map +1 -0
  20. package/lib/documents/file-system-task-queue.js +34 -0
  21. package/lib/documents/file-system-task-queue.js.map +1 -0
  22. package/lib/documents/hydranium-text-documents.d.ts +439 -82
  23. package/lib/documents/hydranium-text-documents.d.ts.map +1 -1
  24. package/lib/documents/hydranium-text-documents.js +769 -159
  25. package/lib/documents/hydranium-text-documents.js.map +1 -1
  26. package/lib/documents/index.d.ts +3 -0
  27. package/lib/documents/index.d.ts.map +1 -1
  28. package/lib/documents/index.js +3 -0
  29. package/lib/documents/index.js.map +1 -1
  30. package/lib/documents/language-client-text-shadow.d.ts +41 -9
  31. package/lib/documents/language-client-text-shadow.d.ts.map +1 -1
  32. package/lib/documents/language-client-text-shadow.js +56 -11
  33. package/lib/documents/language-client-text-shadow.js.map +1 -1
  34. package/lib/documents/self-save-registry.d.ts +37 -6
  35. package/lib/documents/self-save-registry.d.ts.map +1 -1
  36. package/lib/documents/self-save-registry.js +28 -15
  37. package/lib/documents/self-save-registry.js.map +1 -1
  38. package/lib/index.d.ts +3 -0
  39. package/lib/index.d.ts.map +1 -1
  40. package/lib/index.js +6 -0
  41. package/lib/index.js.map +1 -1
  42. package/lib/langium/ast-extension/ast-node-builder.d.ts +32 -9
  43. package/lib/langium/ast-extension/ast-node-builder.d.ts.map +1 -1
  44. package/lib/langium/ast-extension/ast-node-builder.js +60 -22
  45. package/lib/langium/ast-extension/ast-node-builder.js.map +1 -1
  46. package/lib/langium/bootstrap.d.ts.map +1 -1
  47. package/lib/langium/bootstrap.js +16 -9
  48. package/lib/langium/bootstrap.js.map +1 -1
  49. package/lib/langium/config/configuration-provider.d.ts +81 -0
  50. package/lib/langium/config/configuration-provider.d.ts.map +1 -0
  51. package/lib/langium/config/configuration-provider.js +112 -0
  52. package/lib/langium/config/configuration-provider.js.map +1 -0
  53. package/lib/langium/config/index.d.ts +1 -0
  54. package/lib/langium/config/index.d.ts.map +1 -1
  55. package/lib/langium/config/index.js +1 -0
  56. package/lib/langium/config/index.js.map +1 -1
  57. package/lib/langium/diagnostics/lsp-logger.d.ts +17 -0
  58. package/lib/langium/diagnostics/lsp-logger.d.ts.map +1 -1
  59. package/lib/langium/diagnostics/lsp-logger.js +40 -6
  60. package/lib/langium/diagnostics/lsp-logger.js.map +1 -1
  61. package/lib/langium/document-builder/build-pipeline-integration.d.ts +21 -1
  62. package/lib/langium/document-builder/build-pipeline-integration.d.ts.map +1 -1
  63. package/lib/langium/document-builder/build-pipeline-integration.js +32 -5
  64. package/lib/langium/document-builder/build-pipeline-integration.js.map +1 -1
  65. package/lib/langium/document-builder/build-session.d.ts +93 -0
  66. package/lib/langium/document-builder/build-session.d.ts.map +1 -0
  67. package/lib/langium/document-builder/build-session.js +72 -0
  68. package/lib/langium/document-builder/build-session.js.map +1 -0
  69. package/lib/langium/document-builder/document-builder.d.ts +365 -19
  70. package/lib/langium/document-builder/document-builder.d.ts.map +1 -1
  71. package/lib/langium/document-builder/document-builder.js +637 -44
  72. package/lib/langium/document-builder/document-builder.js.map +1 -1
  73. package/lib/langium/document-builder/index.d.ts +1 -0
  74. package/lib/langium/document-builder/index.d.ts.map +1 -1
  75. package/lib/langium/document-builder/index.js +1 -0
  76. package/lib/langium/document-builder/index.js.map +1 -1
  77. package/lib/langium/integration-services.d.ts +45 -1
  78. package/lib/langium/integration-services.d.ts.map +1 -1
  79. package/lib/langium/integration-services.js +10 -5
  80. package/lib/langium/integration-services.js.map +1 -1
  81. package/lib/langium/integrity/integrity-rule.d.ts +13 -5
  82. package/lib/langium/integrity/integrity-rule.d.ts.map +1 -1
  83. package/lib/langium/integrity/integrity-rule.js.map +1 -1
  84. package/lib/langium/integrity/integrity-service.d.ts +50 -6
  85. package/lib/langium/integrity/integrity-service.d.ts.map +1 -1
  86. package/lib/langium/integrity/integrity-service.js +193 -17
  87. package/lib/langium/integrity/integrity-service.js.map +1 -1
  88. package/lib/langium/keys/containment.d.ts +64 -0
  89. package/lib/langium/keys/containment.d.ts.map +1 -0
  90. package/lib/langium/keys/containment.js +53 -0
  91. package/lib/langium/keys/containment.js.map +1 -0
  92. package/lib/langium/keys/index.d.ts +1 -0
  93. package/lib/langium/keys/index.d.ts.map +1 -1
  94. package/lib/langium/keys/index.js +1 -0
  95. package/lib/langium/keys/index.js.map +1 -1
  96. package/lib/langium/keys/name-based-key-provider.d.ts +4 -0
  97. package/lib/langium/keys/name-based-key-provider.d.ts.map +1 -1
  98. package/lib/langium/keys/name-based-key-provider.js +4 -0
  99. package/lib/langium/keys/name-based-key-provider.js.map +1 -1
  100. package/lib/langium/language-module.d.ts +27 -2
  101. package/lib/langium/language-module.d.ts.map +1 -1
  102. package/lib/langium/language-module.js +16 -2
  103. package/lib/langium/language-module.js.map +1 -1
  104. package/lib/langium/model-service/client-session.d.ts +307 -0
  105. package/lib/langium/model-service/client-session.d.ts.map +1 -0
  106. package/lib/langium/model-service/client-session.js +395 -0
  107. package/lib/langium/model-service/client-session.js.map +1 -0
  108. package/lib/langium/model-service/index.d.ts +1 -0
  109. package/lib/langium/model-service/index.d.ts.map +1 -1
  110. package/lib/langium/model-service/index.js +1 -0
  111. package/lib/langium/model-service/index.js.map +1 -1
  112. package/lib/langium/model-service/model-service.d.ts +261 -198
  113. package/lib/langium/model-service/model-service.d.ts.map +1 -1
  114. package/lib/langium/model-service/model-service.js +234 -346
  115. package/lib/langium/model-service/model-service.js.map +1 -1
  116. package/lib/langium/module.d.ts +144 -35
  117. package/lib/langium/module.d.ts.map +1 -1
  118. package/lib/langium/module.js +45 -34
  119. package/lib/langium/module.js.map +1 -1
  120. package/lib/langium/naming/name-provider.d.ts +25 -4
  121. package/lib/langium/naming/name-provider.d.ts.map +1 -1
  122. package/lib/langium/naming/name-provider.js +2 -1
  123. package/lib/langium/naming/name-provider.js.map +1 -1
  124. package/lib/langium/naming/name-separator-validation.d.ts +23 -0
  125. package/lib/langium/naming/name-separator-validation.d.ts.map +1 -1
  126. package/lib/langium/naming/name-separator-validation.js +30 -1
  127. package/lib/langium/naming/name-separator-validation.js.map +1 -1
  128. package/lib/langium/project/abstract-project-manager.d.ts.map +1 -1
  129. package/lib/langium/project/abstract-project-manager.js +9 -2
  130. package/lib/langium/project/abstract-project-manager.js.map +1 -1
  131. package/lib/langium/project/project-change-event.d.ts +2 -2
  132. package/lib/langium/residency/cst-residency-service.d.ts +31 -11
  133. package/lib/langium/residency/cst-residency-service.d.ts.map +1 -1
  134. package/lib/langium/residency/cst-residency-service.js +13 -56
  135. package/lib/langium/residency/cst-residency-service.js.map +1 -1
  136. package/lib/langium/scope/hydranium-scope-provider.d.ts +48 -13
  137. package/lib/langium/scope/hydranium-scope-provider.d.ts.map +1 -1
  138. package/lib/langium/scope/hydranium-scope-provider.js +56 -20
  139. package/lib/langium/scope/hydranium-scope-provider.js.map +1 -1
  140. package/lib/langium/serialization/abstract-serializer.d.ts +11 -20
  141. package/lib/langium/serialization/abstract-serializer.d.ts.map +1 -1
  142. package/lib/langium/serialization/abstract-serializer.js +12 -21
  143. package/lib/langium/serialization/abstract-serializer.js.map +1 -1
  144. package/lib/langium/service-registry.d.ts +15 -1
  145. package/lib/langium/service-registry.d.ts.map +1 -1
  146. package/lib/langium/service-registry.js +16 -0
  147. package/lib/langium/service-registry.js.map +1 -1
  148. package/lib/langium/shared-services.d.ts +15 -2
  149. package/lib/langium/shared-services.d.ts.map +1 -1
  150. package/lib/langium/shared-services.js.map +1 -1
  151. package/lib/langium/transfer/transfer-encoder.d.ts +60 -17
  152. package/lib/langium/transfer/transfer-encoder.d.ts.map +1 -1
  153. package/lib/langium/transfer/transfer-encoder.js +38 -16
  154. package/lib/langium/transfer/transfer-encoder.js.map +1 -1
  155. package/lib/langium/trivia/comment-preserver.d.ts +423 -0
  156. package/lib/langium/trivia/comment-preserver.d.ts.map +1 -0
  157. package/lib/langium/trivia/comment-preserver.js +906 -0
  158. package/lib/langium/trivia/comment-preserver.js.map +1 -0
  159. package/lib/langium/trivia/document-ending-preserver.d.ts +43 -0
  160. package/lib/langium/trivia/document-ending-preserver.d.ts.map +1 -0
  161. package/lib/langium/trivia/document-ending-preserver.js +48 -0
  162. package/lib/langium/trivia/document-ending-preserver.js.map +1 -0
  163. package/lib/langium/trivia/index.d.ts +14 -0
  164. package/lib/langium/trivia/index.d.ts.map +1 -0
  165. package/lib/langium/trivia/index.js +14 -0
  166. package/lib/langium/trivia/index.js.map +1 -0
  167. package/lib/langium/trivia/trivia-contribution.d.ts +37 -0
  168. package/lib/langium/trivia/trivia-contribution.d.ts.map +1 -0
  169. package/lib/langium/trivia/trivia-contribution.js +10 -0
  170. package/lib/langium/trivia/trivia-contribution.js.map +1 -0
  171. package/lib/langium/trivia/trivia-preserver.d.ts +50 -0
  172. package/lib/langium/trivia/trivia-preserver.d.ts.map +1 -0
  173. package/lib/langium/trivia/trivia-preserver.js +10 -0
  174. package/lib/langium/trivia/trivia-preserver.js.map +1 -0
  175. package/lib/langium/trivia/trivia-service.d.ts +70 -0
  176. package/lib/langium/trivia/trivia-service.d.ts.map +1 -0
  177. package/lib/langium/trivia/trivia-service.js +56 -0
  178. package/lib/langium/trivia/trivia-service.js.map +1 -0
  179. package/lib/langium/update-rewrite/update-rewrite.d.ts +1 -1
  180. package/lib/langium/validation/document-validator.d.ts +294 -10
  181. package/lib/langium/validation/document-validator.d.ts.map +1 -1
  182. package/lib/langium/validation/document-validator.js +448 -5
  183. package/lib/langium/validation/document-validator.js.map +1 -1
  184. package/lib/langium/workspace/document-uri-policy.d.ts +17 -12
  185. package/lib/langium/workspace/document-uri-policy.d.ts.map +1 -1
  186. package/lib/langium/workspace/document-uri-policy.js +10 -9
  187. package/lib/langium/workspace/document-uri-policy.js.map +1 -1
  188. package/lib/langium/workspace/file-not-found.d.ts +17 -0
  189. package/lib/langium/workspace/file-not-found.d.ts.map +1 -0
  190. package/lib/langium/workspace/file-not-found.js +20 -0
  191. package/lib/langium/workspace/file-not-found.js.map +1 -0
  192. package/lib/langium/workspace/file-system-provider.d.ts +84 -8
  193. package/lib/langium/workspace/file-system-provider.d.ts.map +1 -1
  194. package/lib/langium/workspace/file-system-provider.js +93 -14
  195. package/lib/langium/workspace/file-system-provider.js.map +1 -1
  196. package/lib/langium/workspace/hydranium-langium-document-factory.d.ts +25 -0
  197. package/lib/langium/workspace/hydranium-langium-document-factory.d.ts.map +1 -1
  198. package/lib/langium/workspace/hydranium-langium-document-factory.js +25 -0
  199. package/lib/langium/workspace/hydranium-langium-document-factory.js.map +1 -1
  200. package/lib/langium/workspace/hydranium-workspace-lock.d.ts +13 -0
  201. package/lib/langium/workspace/hydranium-workspace-lock.d.ts.map +1 -1
  202. package/lib/langium/workspace/hydranium-workspace-lock.js +18 -0
  203. package/lib/langium/workspace/hydranium-workspace-lock.js.map +1 -1
  204. package/lib/langium/workspace/hydranium-workspace-manager.d.ts +77 -8
  205. package/lib/langium/workspace/hydranium-workspace-manager.d.ts.map +1 -1
  206. package/lib/langium/workspace/hydranium-workspace-manager.js +115 -9
  207. package/lib/langium/workspace/hydranium-workspace-manager.js.map +1 -1
  208. package/lib/langium/workspace/in-memory-file-system-provider.d.ts +25 -2
  209. package/lib/langium/workspace/in-memory-file-system-provider.d.ts.map +1 -1
  210. package/lib/langium/workspace/in-memory-file-system-provider.js +41 -15
  211. package/lib/langium/workspace/in-memory-file-system-provider.js.map +1 -1
  212. package/lib/langium/workspace/initialize-workspace.d.ts +31 -2
  213. package/lib/langium/workspace/initialize-workspace.d.ts.map +1 -1
  214. package/lib/langium/workspace/initialize-workspace.js +13 -5
  215. package/lib/langium/workspace/initialize-workspace.js.map +1 -1
  216. package/lib/langium/workspace/langium-documents.d.ts +79 -17
  217. package/lib/langium/workspace/langium-documents.d.ts.map +1 -1
  218. package/lib/langium/workspace/langium-documents.js +91 -29
  219. package/lib/langium/workspace/langium-documents.js.map +1 -1
  220. package/lib/langium/workspace/persistent-file-system-provider.d.ts +0 -7
  221. package/lib/langium/workspace/persistent-file-system-provider.d.ts.map +1 -1
  222. package/lib/langium/workspace/persistent-file-system-provider.js +0 -7
  223. package/lib/langium/workspace/persistent-file-system-provider.js.map +1 -1
  224. package/lib/langium/workspace/virtual-document.d.ts +48 -15
  225. package/lib/langium/workspace/virtual-document.d.ts.map +1 -1
  226. package/lib/langium/workspace/virtual-document.js +78 -18
  227. package/lib/langium/workspace/virtual-document.js.map +1 -1
  228. package/lib/langium/workspace/write-lock-scope.d.ts +4 -3
  229. package/lib/langium/workspace/write-lock-scope.d.ts.map +1 -1
  230. package/lib/langium/workspace/write-lock-scope.js +4 -3
  231. package/lib/langium/workspace/write-lock-scope.js.map +1 -1
  232. package/lib/locale/index.d.ts +10 -0
  233. package/lib/locale/index.d.ts.map +1 -0
  234. package/lib/locale/index.js +10 -0
  235. package/lib/locale/index.js.map +1 -0
  236. package/lib/locale/server-locale.d.ts +73 -0
  237. package/lib/locale/server-locale.d.ts.map +1 -0
  238. package/lib/locale/server-locale.js +61 -0
  239. package/lib/locale/server-locale.js.map +1 -0
  240. package/lib/lsp/completion/hydranium-completion-provider.d.ts +44 -2
  241. package/lib/lsp/completion/hydranium-completion-provider.d.ts.map +1 -1
  242. package/lib/lsp/completion/hydranium-completion-provider.js +68 -0
  243. package/lib/lsp/completion/hydranium-completion-provider.js.map +1 -1
  244. package/lib/lsp/connection-features.d.ts +23 -0
  245. package/lib/lsp/connection-features.d.ts.map +1 -0
  246. package/lib/lsp/connection-features.js +60 -0
  247. package/lib/lsp/connection-features.js.map +1 -0
  248. package/lib/lsp/diagnostics-connection.d.ts +27 -0
  249. package/lib/lsp/diagnostics-connection.d.ts.map +1 -0
  250. package/lib/lsp/diagnostics-connection.js +53 -0
  251. package/lib/lsp/diagnostics-connection.js.map +1 -0
  252. package/lib/lsp/hydranium-document-update-handler.d.ts +90 -79
  253. package/lib/lsp/hydranium-document-update-handler.d.ts.map +1 -1
  254. package/lib/lsp/hydranium-document-update-handler.js +152 -99
  255. package/lib/lsp/hydranium-document-update-handler.js.map +1 -1
  256. package/lib/lsp/index.d.ts +3 -1
  257. package/lib/lsp/index.d.ts.map +1 -1
  258. package/lib/lsp/index.js +3 -1
  259. package/lib/lsp/index.js.map +1 -1
  260. package/lib/lsp/lsp-latency.d.ts +39 -0
  261. package/lib/lsp/lsp-latency.d.ts.map +1 -0
  262. package/lib/lsp/lsp-latency.js +58 -0
  263. package/lib/lsp/lsp-latency.js.map +1 -0
  264. package/lib/lsp/semantic-token-provider.d.ts +34 -1
  265. package/lib/lsp/semantic-token-provider.d.ts.map +1 -1
  266. package/lib/lsp/semantic-token-provider.js +55 -8
  267. package/lib/lsp/semantic-token-provider.js.map +1 -1
  268. package/lib/lsp/shared-module.d.ts +4 -8
  269. package/lib/lsp/shared-module.d.ts.map +1 -1
  270. package/lib/lsp/shared-module.js.map +1 -1
  271. package/lib/lsp/start-language-server.d.ts +8 -7
  272. package/lib/lsp/start-language-server.d.ts.map +1 -1
  273. package/lib/lsp/start-language-server.js +13 -7
  274. package/lib/lsp/start-language-server.js.map +1 -1
  275. package/lib/messages/carriers.d.ts +54 -0
  276. package/lib/messages/carriers.d.ts.map +1 -0
  277. package/lib/messages/carriers.js +62 -0
  278. package/lib/messages/carriers.js.map +1 -0
  279. package/lib/messages/index.d.ts +25 -0
  280. package/lib/messages/index.d.ts.map +1 -0
  281. package/lib/messages/index.js +25 -0
  282. package/lib/messages/index.js.map +1 -0
  283. package/lib/messages/renderer.d.ts +142 -0
  284. package/lib/messages/renderer.d.ts.map +1 -0
  285. package/lib/messages/renderer.js +165 -0
  286. package/lib/messages/renderer.js.map +1 -0
  287. package/lib/node/heap-ceiling.d.ts +61 -0
  288. package/lib/node/heap-ceiling.d.ts.map +1 -0
  289. package/lib/node/heap-ceiling.js +72 -0
  290. package/lib/node/heap-ceiling.js.map +1 -0
  291. package/lib/node/index.d.ts +1 -0
  292. package/lib/node/index.d.ts.map +1 -1
  293. package/lib/node/index.js +1 -0
  294. package/lib/node/index.js.map +1 -1
  295. package/lib/node/latency-from-env.d.ts +1 -1
  296. package/lib/node/latency-from-env.js +1 -1
  297. package/lib/node/measure-memory.d.ts.map +1 -1
  298. package/lib/node/measure-memory.js +1 -0
  299. package/lib/node/measure-memory.js.map +1 -1
  300. package/lib/node/node-file-system-provider.d.ts +39 -4
  301. package/lib/node/node-file-system-provider.d.ts.map +1 -1
  302. package/lib/node/node-file-system-provider.js +109 -49
  303. package/lib/node/node-file-system-provider.js.map +1 -1
  304. package/lib/node/profile-capture.d.ts +8 -2
  305. package/lib/node/profile-capture.d.ts.map +1 -1
  306. package/lib/node/profile-capture.js.map +1 -1
  307. package/lib/node/profiling-run.d.ts +2 -2
  308. package/lib/node/profiling-run.js +1 -1
  309. package/lib/node/profiling-run.js.map +1 -1
  310. package/lib/node/rename-over-open-readers.d.ts +52 -0
  311. package/lib/node/rename-over-open-readers.d.ts.map +1 -0
  312. package/lib/node/rename-over-open-readers.js +66 -0
  313. package/lib/node/rename-over-open-readers.js.map +1 -0
  314. package/lib/node/socket-launcher.d.ts +16 -1
  315. package/lib/node/socket-launcher.d.ts.map +1 -1
  316. package/lib/node/socket-launcher.js +4 -3
  317. package/lib/node/socket-launcher.js.map +1 -1
  318. package/lib/node/stdio-launcher.d.ts +1 -1
  319. package/lib/node/stdio-launcher.d.ts.map +1 -1
  320. package/lib/node/stdio-launcher.js +1 -1
  321. package/lib/node/stdio-launcher.js.map +1 -1
  322. package/lib/testing/fake-document.d.ts +16 -4
  323. package/lib/testing/fake-document.d.ts.map +1 -1
  324. package/lib/testing/fake-document.js +18 -3
  325. package/lib/testing/fake-document.js.map +1 -1
  326. package/lib/testing/make-noop-shared-services.d.ts +14 -0
  327. package/lib/testing/make-noop-shared-services.d.ts.map +1 -1
  328. package/lib/testing/make-noop-shared-services.js +28 -2
  329. package/lib/testing/make-noop-shared-services.js.map +1 -1
  330. package/lib/testing/make-test-services.d.ts +62 -14
  331. package/lib/testing/make-test-services.d.ts.map +1 -1
  332. package/lib/testing/make-test-services.js +27 -6
  333. package/lib/testing/make-test-services.js.map +1 -1
  334. package/lib/testing/node/index.d.ts +1 -0
  335. package/lib/testing/node/index.d.ts.map +1 -1
  336. package/lib/testing/node/index.js +1 -0
  337. package/lib/testing/node/index.js.map +1 -1
  338. package/lib/testing/node/lsp-harness.d.ts.map +1 -1
  339. package/lib/testing/node/lsp-harness.js +2 -0
  340. package/lib/testing/node/lsp-harness.js.map +1 -1
  341. package/lib/testing/node/lsp-server-connection.d.ts +11 -3
  342. package/lib/testing/node/lsp-server-connection.d.ts.map +1 -1
  343. package/lib/testing/node/lsp-server-connection.js +42 -9
  344. package/lib/testing/node/lsp-server-connection.js.map +1 -1
  345. package/lib/testing/node/scratch-workspace.d.ts.map +1 -1
  346. package/lib/testing/node/scratch-workspace.js +10 -5
  347. package/lib/testing/node/scratch-workspace.js.map +1 -1
  348. package/lib/testing/node/spawned-server.d.ts +14 -0
  349. package/lib/testing/node/spawned-server.d.ts.map +1 -1
  350. package/lib/testing/node/spawned-server.js +33 -1
  351. package/lib/testing/node/spawned-server.js.map +1 -1
  352. package/lib/testing/node/unhandled-rejections.d.ts +20 -0
  353. package/lib/testing/node/unhandled-rejections.d.ts.map +1 -0
  354. package/lib/testing/node/unhandled-rejections.js +32 -0
  355. package/lib/testing/node/unhandled-rejections.js.map +1 -0
  356. package/lib/testing/playwright/flaky-network-proxy.d.ts +76 -0
  357. package/lib/testing/playwright/flaky-network-proxy.d.ts.map +1 -0
  358. package/lib/testing/playwright/flaky-network-proxy.js +164 -0
  359. package/lib/testing/playwright/flaky-network-proxy.js.map +1 -0
  360. package/lib/testing/playwright/index.d.ts +1 -0
  361. package/lib/testing/playwright/index.d.ts.map +1 -1
  362. package/lib/testing/playwright/index.js +1 -0
  363. package/lib/testing/playwright/index.js.map +1 -1
  364. package/lib/testing/playwright/server-log-capture.d.ts +14 -4
  365. package/lib/testing/playwright/server-log-capture.d.ts.map +1 -1
  366. package/lib/testing/playwright/server-log-capture.js +21 -4
  367. package/lib/testing/playwright/server-log-capture.js.map +1 -1
  368. package/lib/testing/playwright/server-log-rename-reporter.d.ts.map +1 -1
  369. package/lib/testing/playwright/server-log-rename-reporter.js +10 -1
  370. package/lib/testing/playwright/server-log-rename-reporter.js.map +1 -1
  371. package/lib/testing/run-update-pipeline.d.ts +4 -4
  372. package/lib/testing/run-update-pipeline.d.ts.map +1 -1
  373. package/lib/testing/stub-ast-document-manager.d.ts +10 -9
  374. package/lib/testing/stub-ast-document-manager.d.ts.map +1 -1
  375. package/lib/testing/stub-ast-document-manager.js +17 -9
  376. package/lib/testing/stub-ast-document-manager.js.map +1 -1
  377. package/lib/testing/stub-document-builder.d.ts +26 -11
  378. package/lib/testing/stub-document-builder.d.ts.map +1 -1
  379. package/lib/testing/stub-document-builder.js +57 -4
  380. package/lib/testing/stub-document-builder.js.map +1 -1
  381. package/lib/testing/stub-hydranium-text-documents.d.ts +22 -7
  382. package/lib/testing/stub-hydranium-text-documents.d.ts.map +1 -1
  383. package/lib/testing/stub-hydranium-text-documents.js +92 -15
  384. package/lib/testing/stub-hydranium-text-documents.js.map +1 -1
  385. package/lib/testing/stub-langium-documents.d.ts +3 -2
  386. package/lib/testing/stub-langium-documents.d.ts.map +1 -1
  387. package/lib/testing/stub-langium-documents.js.map +1 -1
  388. package/lib/testing/stub-model-service.d.ts +7 -6
  389. package/lib/testing/stub-model-service.d.ts.map +1 -1
  390. package/lib/testing/stub-model-service.js +4 -4
  391. package/lib/testing/stub-model-service.js.map +1 -1
  392. package/lib/util/connection-liveness.d.ts +7 -6
  393. package/lib/util/connection-liveness.d.ts.map +1 -1
  394. package/lib/util/connection-liveness.js +35 -14
  395. package/lib/util/connection-liveness.js.map +1 -1
  396. package/package.json +17 -8
  397. package/src/documents/ast-document-manager.ts +348 -64
  398. package/src/documents/client-ids.ts +5 -22
  399. package/src/documents/client-session-errors.ts +24 -0
  400. package/src/documents/client-session-registry.ts +240 -0
  401. package/src/documents/file-system-task-queue.ts +68 -0
  402. package/src/documents/hydranium-text-documents.ts +959 -201
  403. package/src/documents/index.ts +3 -0
  404. package/src/documents/language-client-text-shadow.ts +59 -11
  405. package/src/documents/self-save-registry.ts +52 -13
  406. package/src/index.ts +6 -0
  407. package/src/langium/ast-extension/ast-node-builder.ts +66 -22
  408. package/src/langium/bootstrap.ts +16 -9
  409. package/src/langium/config/configuration-provider.ts +119 -0
  410. package/src/langium/config/index.ts +1 -0
  411. package/src/langium/diagnostics/lsp-logger.ts +41 -6
  412. package/src/langium/document-builder/build-pipeline-integration.ts +50 -5
  413. package/src/langium/document-builder/build-session.ts +87 -0
  414. package/src/langium/document-builder/document-builder.ts +720 -43
  415. package/src/langium/document-builder/index.ts +1 -0
  416. package/src/langium/integration-services.ts +67 -6
  417. package/src/langium/integrity/integrity-rule.ts +13 -5
  418. package/src/langium/integrity/integrity-service.ts +202 -17
  419. package/src/langium/keys/containment.ts +87 -0
  420. package/src/langium/keys/index.ts +1 -0
  421. package/src/langium/keys/name-based-key-provider.ts +4 -0
  422. package/src/langium/language-module.ts +42 -4
  423. package/src/langium/model-service/client-session.ts +606 -0
  424. package/src/langium/model-service/index.ts +1 -0
  425. package/src/langium/model-service/model-service.ts +395 -351
  426. package/src/langium/module.ts +192 -63
  427. package/src/langium/naming/name-provider.ts +27 -5
  428. package/src/langium/naming/name-separator-validation.ts +34 -5
  429. package/src/langium/project/abstract-project-manager.ts +9 -1
  430. package/src/langium/project/project-change-event.ts +2 -2
  431. package/src/langium/residency/cst-residency-service.ts +36 -14
  432. package/src/langium/scope/hydranium-scope-provider.ts +60 -22
  433. package/src/langium/serialization/abstract-serializer.ts +13 -32
  434. package/src/langium/service-registry.ts +19 -2
  435. package/src/langium/shared-services.ts +19 -2
  436. package/src/langium/transfer/transfer-encoder.ts +85 -24
  437. package/src/langium/trivia/comment-preserver.ts +1100 -0
  438. package/src/langium/trivia/document-ending-preserver.ts +55 -0
  439. package/src/langium/trivia/index.ts +14 -0
  440. package/src/langium/trivia/trivia-contribution.ts +39 -0
  441. package/src/langium/trivia/trivia-preserver.ts +54 -0
  442. package/src/langium/trivia/trivia-service.ts +99 -0
  443. package/src/langium/update-rewrite/update-rewrite.ts +1 -1
  444. package/src/langium/validation/document-validator.ts +537 -11
  445. package/src/langium/workspace/document-uri-policy.ts +17 -12
  446. package/src/langium/workspace/file-not-found.ts +23 -0
  447. package/src/langium/workspace/file-system-provider.ts +153 -16
  448. package/src/langium/workspace/hydranium-langium-document-factory.ts +34 -0
  449. package/src/langium/workspace/hydranium-workspace-lock.ts +21 -0
  450. package/src/langium/workspace/hydranium-workspace-manager.ts +133 -12
  451. package/src/langium/workspace/in-memory-file-system-provider.ts +47 -16
  452. package/src/langium/workspace/initialize-workspace.ts +43 -5
  453. package/src/langium/workspace/langium-documents.ts +113 -33
  454. package/src/langium/workspace/persistent-file-system-provider.ts +0 -7
  455. package/src/langium/workspace/virtual-document.ts +96 -19
  456. package/src/langium/workspace/write-lock-scope.ts +4 -3
  457. package/src/locale/index.ts +10 -0
  458. package/src/locale/server-locale.ts +86 -0
  459. package/src/lsp/completion/hydranium-completion-provider.ts +82 -2
  460. package/src/lsp/connection-features.ts +67 -0
  461. package/src/lsp/diagnostics-connection.ts +56 -0
  462. package/src/lsp/hydranium-document-update-handler.ts +182 -106
  463. package/src/lsp/index.ts +3 -1
  464. package/src/lsp/lsp-latency.ts +62 -0
  465. package/src/lsp/semantic-token-provider.ts +74 -7
  466. package/src/lsp/shared-module.ts +4 -8
  467. package/src/lsp/start-language-server.ts +13 -7
  468. package/src/messages/carriers.ts +78 -0
  469. package/src/messages/index.ts +36 -0
  470. package/src/messages/renderer.ts +212 -0
  471. package/src/node/heap-ceiling.ts +108 -0
  472. package/src/node/index.ts +1 -0
  473. package/src/node/latency-from-env.ts +1 -1
  474. package/src/node/measure-memory.ts +1 -0
  475. package/src/node/node-file-system-provider.ts +122 -51
  476. package/src/node/profile-capture.ts +8 -2
  477. package/src/node/profiling-run.ts +3 -3
  478. package/src/node/rename-over-open-readers.ts +78 -0
  479. package/src/node/socket-launcher.ts +19 -4
  480. package/src/node/stdio-launcher.ts +1 -2
  481. package/src/testing/fake-document.ts +24 -5
  482. package/src/testing/make-noop-shared-services.ts +50 -2
  483. package/src/testing/make-test-services.ts +103 -27
  484. package/src/testing/node/index.ts +1 -0
  485. package/src/testing/node/lsp-harness.ts +2 -0
  486. package/src/testing/node/lsp-server-connection.ts +61 -11
  487. package/src/testing/node/scratch-workspace.ts +10 -5
  488. package/src/testing/node/spawned-server.ts +35 -1
  489. package/src/testing/node/unhandled-rejections.ts +31 -0
  490. package/src/testing/playwright/flaky-network-proxy.ts +240 -0
  491. package/src/testing/playwright/index.ts +1 -0
  492. package/src/testing/playwright/server-log-capture.ts +24 -5
  493. package/src/testing/playwright/server-log-rename-reporter.ts +12 -1
  494. package/src/testing/run-update-pipeline.ts +4 -4
  495. package/src/testing/stub-ast-document-manager.ts +28 -21
  496. package/src/testing/stub-document-builder.ts +83 -17
  497. package/src/testing/stub-hydranium-text-documents.ts +127 -22
  498. package/src/testing/stub-langium-documents.ts +3 -2
  499. package/src/testing/stub-model-service.ts +9 -8
  500. package/src/util/connection-liveness.ts +37 -14
  501. package/lib/lsp/instrument-connection.d.ts +0 -36
  502. package/lib/lsp/instrument-connection.d.ts.map +0 -1
  503. package/lib/lsp/instrument-connection.js +0 -62
  504. package/lib/lsp/instrument-connection.js.map +0 -1
  505. package/src/lsp/instrument-connection.ts +0 -66
@@ -9,20 +9,16 @@
9
9
 
10
10
  import {
11
11
  type CanonicalUri,
12
- type CloseModelArgs,
13
- ConflictError,
14
- Logger,
12
+ defineMessage,
15
13
  type MaybeObservableValue,
16
14
  type MaybePromise,
17
15
  ObservableValue,
18
- type TransferDiagnostic,
16
+ TIMED_OUT,
19
17
  type TransferElement,
20
- type OpenModelArgs,
21
- type Tracer,
22
- type TransferSaveArgs,
23
- type TransferUpdateArgs
18
+ type Tracer
24
19
  } from '@hydranium/protocol';
25
20
  import { type AstNode, DocumentState, type LangiumDocument, UriUtils, type URI } from '@hydranium/langium';
21
+ import { type AstDiagnostic } from '../validation/document-validator.js';
26
22
  import { type DocumentUriPolicy } from '../workspace/document-uri-policy.js';
27
23
  import { ReentrantWriteLockError, isInsideWriteLock } from '../workspace/write-lock-scope.js';
28
24
  import { type CancellationToken, type Disposable } from 'vscode-languageserver';
@@ -32,19 +28,29 @@ import { type LogNameOptions } from '../diagnostics/logger.js';
32
28
  import { IntegrityService } from '../integrity/integrity-service.js';
33
29
  import { labelPhaseListener } from '../document-builder/labeled-phase-listener.js';
34
30
  import { LANGUAGE_CLIENT_ID } from '../../documents/client-ids.js';
31
+ import { type OpenOptions } from '../../documents/client-session-registry.js';
35
32
  import { type ServerSharedServices } from '../module.js';
36
-
37
- /** Max time {@link ModelService.settleSave} waits for the build to settle and the sync chain to drain. */
38
- const SAVE_SETTLE_TIMEOUT_MS = 10_000;
33
+ import { type ClientSession } from './client-session.js';
39
34
 
40
35
  /**
41
- * Marks the {@link SAVE_SETTLE_TIMEOUT_MS} branch of
42
- * {@link ModelService.settleSave}'s race so it stays distinguishable from a
43
- * genuine rejection (a cancelled token, an `applyEdit` reverse-RPC error, a
44
- * build throw). With a plain `Error` the only log line an adopter has blames
45
- * the timeout for every one of them, which points debugging at the wrong layer.
36
+ * The undo-stack entry for a server-authored write pushed to the editor.
37
+ *
38
+ * **A user-facing LABEL, not a log string**, which is easy to miss because it
39
+ * travels as an options field rather than as a message: LSP specifies
40
+ * `ApplyWorkspaceEditParams.label` as "presented in the user interface for
41
+ * example on an undo stack to undo the workspace edit". So a user who edits
42
+ * through a form or drags a diagram node reads this in their editor's undo menu
43
+ * — which is why it is rendered like any other message the server sends rather
44
+ * than left as the English literal it was.
45
+ *
46
+ * Parameterless deliberately. The obvious improvement is to name the document,
47
+ * and it is the wrong one: an undo menu is already grouped under the file, so
48
+ * the URI would be noise in the one place it is redundant.
46
49
  */
47
- class SaveSettleTimeoutError extends Error {}
50
+ export const MODEL_UPDATE_EDIT = defineMessage('hydranium/core/model-update-edit', 'Update Model');
51
+
52
+ /** Max time {@link DefaultModelService.settleSave} waits for the build to settle and the sync chain to drain. */
53
+ const SAVE_SETTLE_TIMEOUT_MS = 10_000;
48
54
 
49
55
  /**
50
56
  * Constructor options for {@link ModelService}. All fields are optional,
@@ -52,40 +58,17 @@ class SaveSettleTimeoutError extends Error {}
52
58
  */
53
59
  export interface ModelServiceOptions extends LogNameOptions {
54
60
  /**
55
- * When set, {@link ModelService.update} logs a `warn` line if its
56
- * end-to-end wait (serialise + content-change apply + rebuild +
57
- * settled-phase wait) exceeds this many milliseconds. Default
58
- * `undefined` (no warn line ever emitted; the underlying
59
- * `Logger.time` debug timing log is unchanged either way).
60
- *
61
- * Pure observability — does NOT abort the update, does NOT change
62
- * resolution semantics. Adopters wanting a hard timeout that throws
63
- * instead override {@link ModelService.update} on their subclass and
64
- * race the parent call against their own deadline.
65
- *
66
- * Recommended starting threshold: 2-5 seconds for interactive paths
67
- * (form save, diagram edit). Workspaces with very large documents
68
- * or slow validation may legitimately exceed 5s on the cold path —
69
- * tune per workspace.
70
- *
71
- * Accepts a {@link MaybeObservableValue} so the threshold can be a
72
- * fixed constant or bound to a user setting via `Settings.number`
73
- * and retuned live. Leaving it unset disables the warn line entirely
74
- * (and skips the per-update stopwatch).
75
- */
76
- readonly slowUpdateWarnMs?: MaybeObservableValue<number>;
77
- /**
78
- * Serialise the facade's own build under the workspace WRITE lock, the way
79
- * Langium's `DefaultDocumentUpdateHandler` dispatches its build. Default
80
- * `true`.
61
+ * Serialise the facade's own build under the workspace WRITE lock, through
62
+ * `HydraniumDocumentBuilder.scheduleUpdate` as the LSP update handler
63
+ * builds. Default `true`.
81
64
  *
82
65
  * **Why it defaults on.** Unlocked, the facade's build races the LSP bridge's
83
66
  * build of the same URI — both are legitimate (the bridge exists only under a
84
67
  * `Connection`, so the facade stands in for it headless), but nothing
85
68
  * serialises them, so both run a full validation pass and Langium appends the
86
69
  * second onto the first. Every diagnostic is then duplicated, and the
87
- * duplication compounds per rebuild. Serialised, Langium elides the second
88
- * build entirely, so the redundant work goes too.
70
+ * duplication compounds per rebuild. Serialised, the second request shares
71
+ * the first build where it carries both, so the redundant work goes too.
89
72
  *
90
73
  * **What `false` costs.** The facade's build is then unserialised and can run
91
74
  * concurrently with the bridge's build of the same URI, so the affected
@@ -96,17 +79,19 @@ export interface ModelServiceOptions extends LogNameOptions {
96
79
  * option removes is the wasted pass, not just its visible symptom.
97
80
  *
98
81
  * **What `false` buys.** `WorkspaceLock` is not reentrant. A caller that
99
- * reaches `update` / `save` / `rebuild` while already holding the write lock —
100
- * an integrity rule or build-phase pass that writes through this facade —
101
- * deadlocks: acquiring the lock cancels the running holder, and the new
82
+ * reaches a session's `update` / `save` or `rebuild` while already holding
83
+ * the write lock — an integrity rule or build-phase pass that writes
84
+ * back — deadlocks: acquiring the lock cancels the running holder, and the new
102
85
  * acquisition then waits for that holder to release while the holder waits
103
86
  * for this call. On `true` that shape is DETECTED and rejected with
104
87
  * {@link ReentrantWriteLockError} rather than hanging, wherever a host
105
88
  * installs a write-lock scope tracker (`@hydranium/core/node` does at entry
106
89
  * load; see {@link isInsideWriteLock}). Setting `false` is the escape hatch
107
- * for an adopter whose reentrant shape is unavoidable — nothing acquires the
108
- * lock then, so there is nothing to be reentrant about; prefer it over
109
- * unserialised builds only in that case.
90
+ * for an adopter whose reentrant shape is unavoidable: the facade's own
91
+ * build then takes no lock, so it cannot cancel the holder it runs inside.
92
+ * The wait after it can still hang there, because a document no build will
93
+ * carry is re-queued through the lock, and that re-queue waits for the
94
+ * holder to end. Prefer `false` over serialised builds only in that case.
110
95
  *
111
96
  * Accepts a {@link MaybeObservableValue} so it can be bound to a setting and
112
97
  * flipped without a restart.
@@ -115,12 +100,17 @@ export interface ModelServiceOptions extends LogNameOptions {
115
100
  }
116
101
 
117
102
  /**
103
+ * The seam every non-LSP head talks to: the data server, the GLSP head and an
104
+ * adopter's own services reach documents through this slot rather than through
105
+ * the workspace stores.
106
+ *
118
107
  * In-process facade over the framework's document plumbing
119
108
  * (`HydraniumTextDocuments`, `LangiumDocuments`,
120
- * `DocumentBuilder`, `WritableFileSystemProvider`). Owns the
121
- * `open / request / update / save / ready` lifecycle that protocol heads
122
- * (LSP, data-server, GLSP) delegate to so coordinating those primitives
123
- * doesn't have to be re-implemented per-head.
109
+ * `DocumentBuilder`, `WritableFileSystemProvider`). Owns the document
110
+ * lifecycle the data-server and GLSP heads delegate to — client sessions that
111
+ * open, update, save and close documents, the phase reads, and `ready` — so
112
+ * coordinating those primitives doesn't have to be re-implemented per head.
113
+ * Every open and write goes through a session from {@link createSession}.
124
114
  *
125
115
  * "Model" here means the parsed AST — distinct from the wire-shape
126
116
  * `TransferDocument` in `@hydranium/protocol`.
@@ -130,9 +120,9 @@ export interface ModelServiceOptions extends LogNameOptions {
130
120
  * Multiple in-process consumers want the same workspace-level
131
121
  * operations:
132
122
  * - The data-server head turns these into typed RPC methods.
133
- * - The GLSP head uses the same lifecycle for diagram-driven edits;
134
- * GModel operation handlers route through `update` for AST mutation,
135
- * `waitForDocumentState` for indexed-phase waits before reads, etc.
123
+ * - The GLSP head uses the same lifecycle for diagram-driven edits: GModel
124
+ * operation handlers write through the diagram's session and wait on phases
125
+ * before reading.
136
126
  * - Server-internal callers (integrity service, ad-hoc bridges, tests)
137
127
  * want the same operations without the wire serialisation step.
138
128
  *
@@ -145,15 +135,16 @@ export interface ModelServiceOptions extends LogNameOptions {
145
135
  *
146
136
  * **Read-latest supersession**
147
137
  *
148
- * The default `update` and `save` flows use Langium's per-URI
149
- * `DocumentBuilder.waitUntil` to wait for the integrity-settled landmark
150
- * ({@link IntegrityService.SettledState}), then read the post-build state. Concurrent
151
- * in-process callers on the same URI all see the latest post-build
152
- * snapshot — none deadlock waiting for a specific version's settled
153
- * event. Adopters wanting strict version-matched semantics (resolve
154
- * with vN's snapshot specifically, log "vN superseded by vM at vN+1")
155
- * override {@link update} to attach a phase-listener with explicit
156
- * version checks; the framework default doesn't need it for safety.
138
+ * A session's default `update` and `save` use Langium's per-URI
139
+ * `DocumentBuilder.waitUntil` to wait for `Validated` (the integrity-settled
140
+ * landmark {@link IntegrityService.SettledState} when rebuilds do not
141
+ * validate), then read the post-build state. Concurrent in-process callers
142
+ * on the same URI all see the latest post-build snapshot — none deadlock
143
+ * waiting for a specific version's settled event. Adopters wanting strict
144
+ * version-matched semantics (resolve with vN's snapshot specifically, log
145
+ * "vN superseded by vM at vN+1") override
146
+ * `DefaultClientSession.updateDocument` to attach a phase-listener with
147
+ * explicit version checks; the framework default doesn't need it for safety.
157
148
  *
158
149
  * **Returns AST snapshots, not wire envelopes**
159
150
  *
@@ -173,20 +164,112 @@ export interface ModelServiceOptions extends LogNameOptions {
173
164
  * by URI happens here so consumers can subscribe per-document without
174
165
  * implementing the URI gate at each callsite.
175
166
  *
167
+ * **Two families, and the distinction matters more than the names suggest.**
168
+ * `waitFor*` requests no build of its own: a wait on a URI with no document
169
+ * rejects, and one on a document no build will carry is re-queued by the
170
+ * builder's wait. `ensureDocumentState` and the phase shorthands over it
171
+ * *dispatch*: warm documents are awaited, cold ones are built.
172
+ *
173
+ * **Diagnostics are typed `never` below `Validated`.** Validation is the last
174
+ * phase, so at any earlier landmark the array either is not yet computed or
175
+ * still holds the previous build's, and reading it would take stale results
176
+ * for fresh ones. A caller that needs diagnostics asks for {@link validated}.
177
+ *
178
+ * What the `never` buys, exactly: reading a field off an element is a compile
179
+ * error, and nothing can be appended. It does NOT stop a caller assigning an
180
+ * element to a typed variable, because `never` is assignable to everything — so
181
+ * this is a guard against reaching for diagnostics by accident, not a seal
182
+ * against doing it deliberately.
183
+ *
184
+ * The waits resolve at or ABOVE their target, so an already-validated document
185
+ * does carry usable diagnostics and the `never` over-forbids there. That
186
+ * direction is the safe one: the alternative permits stale reads silently. A
187
+ * member taking a phase as a PARAMETER cannot judge statically and so returns
188
+ * `TDiagnostic`, leaving the choice to the caller.
189
+ *
176
190
  * **Generic parameters.**
177
191
  * - `TAst` — the AST root type each consumer expects on the returned
178
192
  * {@link AstDocument}. Constrained to {@link AstNode}.
179
- * - `TDiagnostic` — wire diagnostic shape used by the injected
180
- * `TransferEncoder`. Defaults to {@link TransferDiagnostic}.
181
- * - `TTransfer` — transfer-model root accepted by `update` / `save`
193
+ * - `TDiagnostic` — the AST-layer diagnostic: whatever the build left on
194
+ * `LangiumDocument.diagnostics`, carried through on the returned
195
+ * {@link AstDocument}. Defaults to {@link AstDiagnostic}.
196
+ * **Not the `TransferEncoder`'s parameter of the same name**, which is
197
+ * that encoder's OUTPUT and so names the wire shape. This one names its
198
+ * input, and an adopter binds the two to different types.
199
+ * - `TTransfer` — transfer-model root a session's `update` / `save` accept
182
200
  * args. Constrained to {@link TransferElement}. Defaults to the
183
201
  * structural base.
184
202
  */
185
- export class ModelService<
203
+ export interface ModelService<
204
+ TAst extends AstNode,
205
+ TDiagnostic extends AstDiagnostic = AstDiagnostic,
206
+ TTransfer extends TransferElement = TransferElement
207
+ > {
208
+ /**
209
+ * Resolves once the workspace has been initialised and its first build has
210
+ * completed — the gate every read should wait behind, since a document
211
+ * queried before it may be unbuilt and reach no phase.
212
+ *
213
+ * A property rather than a method, matching `ProjectManager.ready` and
214
+ * Langium's `WorkspaceManager.ready`. An implementation needing a stricter
215
+ * gate supplies a Promise that awaits its own concern as well.
216
+ */
217
+ readonly ready: Promise<void>;
218
+
219
+ // Pure waits — never trigger a build.
220
+ waitForDocumentState(uri: string, state: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
221
+ waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
222
+ waitForBuilderState(state: DocumentState, cancelToken?: CancellationToken): Promise<void>;
223
+
224
+ // Wait if warm, build if cold.
225
+ ensureDocumentState(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
226
+ rebuild(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
227
+ parsed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
228
+ linked(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
229
+ settled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
230
+ indexed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
231
+ validated(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
232
+
233
+ isOpen(uri: string): boolean;
234
+ snapshot(uri: string): AstDocument<TAst, TDiagnostic> | undefined;
235
+ /**
236
+ * The text a session's write of `model` to `uri` applies: a textual model
237
+ * as given, a structured one rewritten and serialised.
238
+ */
239
+ modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string>;
240
+ getDocument(uri: string): LangiumDocument | undefined;
241
+
242
+ onModelUpdated(uri: string, listener: (event: AstDocumentUpdatedEvent<TAst, TDiagnostic>) => void): Disposable;
243
+ onModelSaved(uri: string, listener: (event: AstDocumentSavedEvent<TAst, TDiagnostic>) => void): Disposable;
244
+ onClientClosed(uri: string, clientId: string, listener: () => void): Disposable;
245
+
246
+ /**
247
+ * Start a client session, the only way to open and write documents through
248
+ * this service. Pass a `label` naming the participant; without one it is
249
+ * `session`. The id defaults to `label#` plus a random UUID; a fixed
250
+ * `clientId` is taken as given. Throws `ReservedClientIdError` when the id
251
+ * is reserved by the framework, and `DuplicateClientIdError` when it is
252
+ * held by another live session or has documents open under it as a client
253
+ * that is not a session.
254
+ *
255
+ * `TOpenOptions` types the options the session's `open` takes and its
256
+ * `openOptions` returns. The narrowing is an unchecked cast, and it holds
257
+ * only for the caller that started the session: a holder reached through
258
+ * {@link getSession} sees plain `OpenOptions`.
259
+ */
260
+ createSession<TOpenOptions extends OpenOptions = OpenOptions>(
261
+ label?: string,
262
+ clientId?: string
263
+ ): ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions>;
264
+ /** The live session started under `clientId`, or `undefined` once it has ended or was never started. */
265
+ getSession(clientId: string): ClientSession<TAst, TDiagnostic, TTransfer> | undefined;
266
+ }
267
+
268
+ export class DefaultModelService<
186
269
  TAst extends AstNode,
187
- TDiagnostic = TransferDiagnostic,
270
+ TDiagnostic extends AstDiagnostic = AstDiagnostic,
188
271
  /**
189
- * Structured payload accepted by `update` / `save`. Constrained to
272
+ * Structured payload a session's `update` / `save` accept. Constrained to
190
273
  * {@link TransferElement} — the minimal `{ readonly $type: string }`
191
274
  * shape. Both transfer-model overlay roots (which extend
192
275
  * `TransferElement` explicitly) and AST root types (which have
@@ -195,7 +278,7 @@ export class ModelService<
195
278
  * integrity service) that pass AST roots remain compatible.
196
279
  */
197
280
  TTransfer extends TransferElement = TransferElement
198
- > {
281
+ > implements ModelService<TAst, TDiagnostic, TTransfer> {
199
282
  protected readonly tracer: Tracer;
200
283
  /**
201
284
  * The single document-identity seam (`services.workspace.DocumentUriPolicy`),
@@ -206,12 +289,6 @@ export class ModelService<
206
289
  * (see {@link DocumentUriPolicy}).
207
290
  */
208
291
  protected readonly uriPolicy: DocumentUriPolicy;
209
- /**
210
- * Live slow-update-warn threshold cell, or `undefined` when the option
211
- * was not supplied (warn line + stopwatch disabled). Reads `.value` per
212
- * update so a setting-bound threshold retunes without reconstruction.
213
- */
214
- protected readonly slowUpdateWarn?: ObservableValue<number>;
215
292
  /** See {@link ModelServiceOptions.serializeBuilds}. Defaults to `true`. */
216
293
  protected readonly serializeBuilds: ObservableValue<boolean>;
217
294
 
@@ -224,6 +301,16 @@ export class ModelService<
224
301
  protected readonly syncChains = new Map<string, Promise<void>>();
225
302
  protected readonly pendingSync = new Map<string, string>();
226
303
 
304
+ /** The live sessions this service started, by client id, for {@link getSession}. */
305
+ protected readonly sessions = new Map<string, ClientSession<TAst, TDiagnostic, TTransfer>>();
306
+ /**
307
+ * Drops an ended session from {@link sessions}. Subscribed by the first
308
+ * {@link createSession} rather than at construction, so a services tree with
309
+ * no text store, or one that knows nothing of sessions, still constructs
310
+ * this service.
311
+ */
312
+ protected sessionCloseListener?: Disposable;
313
+
227
314
  /**
228
315
  * Workspace-level readiness gate. Resolves when the framework has
229
316
  * finished its first workspace build cycle and the `ModelService`
@@ -264,7 +351,6 @@ export class ModelService<
264
351
  ) {
265
352
  this.tracer = services.Tracer.for(options.logName ?? 'ModelService').trace('instantiated');
266
353
  this.uriPolicy = services.workspace.DocumentUriPolicy;
267
- this.slowUpdateWarn = options.slowUpdateWarnMs !== undefined ? ObservableValue.from(options.slowUpdateWarnMs) : undefined;
268
354
  this.serializeBuilds = ObservableValue.from(options.serializeBuilds ?? true);
269
355
  // Optional-chain so a harness that binds no WorkspaceManager awaits
270
356
  // `undefined` and resolves immediately; production hosts always have it
@@ -311,8 +397,7 @@ export class ModelService<
311
397
  /**
312
398
  * Wait for the document at `uri` to reach `state`. Pure wait — does
313
399
  * not trigger a build. If `uri` is not yet in the document registry
314
- * the call will hang until something else drives it through the
315
- * pipeline; for the cold-start case use {@link rebuild} instead.
400
+ * the call rejects; for the cold-start case use {@link rebuild} instead.
316
401
  *
317
402
  * Wrapped in a debug-level timing log via {@link Tracer.time} so
318
403
  * slow per-URI waits surface in build telemetry; the URI is
@@ -329,8 +414,12 @@ export class ModelService<
329
414
  * {@link waitForDocumentState} for the common "wait until content is stable"
330
415
  * case (e.g. settling a save). Pure wait — does not trigger a build.
331
416
  */
332
- async waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
333
- return this.waitForDocumentStateCanonical(this.uriPolicy.canonicalUri(uri), IntegrityService.SettledState, cancelToken);
417
+ async waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
418
+ return (await this.waitForDocumentStateCanonical(
419
+ this.uriPolicy.canonicalUri(uri),
420
+ IntegrityService.SettledState,
421
+ cancelToken
422
+ )) as AstDocument<TAst, never>;
334
423
  }
335
424
 
336
425
  /**
@@ -380,31 +469,35 @@ export class ModelService<
380
469
  * Force a fresh build of the document at `uri` and wait for it to
381
470
  * reach `state` (or the integrity-settled landmark
382
471
  * {@link IntegrityService.SettledState} if omitted).
383
- * Always triggers `DocumentBuilder.update([uri], [])` regardless of
384
- * whether the document is already in the registry — call this when
385
- * you want to re-process from scratch.
472
+ * Always builds the document, whether or not it is already in the
473
+ * registry, in a build of its own or in one already scheduled that carries
474
+ * it — call this when you want to re-process from scratch.
386
475
  *
387
- * The facade is responsible for firing `DocumentBuilder.update`
388
- * directly because Langium's `DefaultDocumentUpdateHandler.didChangeContent`
476
+ * The facade is responsible for requesting the build itself because Langium's `DefaultDocumentUpdateHandler.didChangeContent`
389
477
  * (the standard text-document → builder bridge) only runs under an
390
478
  * LSP `Connection`. Running headless the bridge never fires; the
391
479
  * facade stands in for it on its own update path.
392
480
  *
393
481
  * Coexistence with an LSP head running on the same `DocumentBuilder` is
394
- * fine, but not because the builder merges the two: Langium does NOT
395
- * coalesce concurrent builds of the same URI. The LSP head fires `update`
396
- * from the LSP-driven event and the facade fires it from its own RPC-driven
397
- * event — both legitimate — so this method takes the workspace WRITE lock,
398
- * the same one Langium's own text-change bridge builds under, to serialise
399
- * them. Two unserialised builds of one URI each run a full validation pass
400
- * and Langium appends the second set onto the first, duplicating every
482
+ * fine: the LSP head builds from the LSP-driven event and the facade from
483
+ * its own RPC-driven event — both legitimate — and both go through
484
+ * `HydraniumDocumentBuilder.scheduleUpdate`, which serialises them under
485
+ * the workspace WRITE lock and lets the second share the first's build
486
+ * where that build carries it. Langium alone does not coalesce concurrent
487
+ * builds of one URI: two unserialised builds each run a full validation
488
+ * pass and Langium appends the second set onto the first, duplicating every
401
489
  * diagnostic. Opt out via
402
490
  * {@link ModelServiceOptions.serializeBuilds} — see there for the
403
491
  * non-reentrancy hazard that is the reason the opt-out exists.
404
492
  *
405
- * Returns an empty `{ root, diagnostics }` envelope when the document
406
- * cannot be loaded; adopters that want to throw override this method
407
- * on their subclass.
493
+ * An override calls the base before it awaits. Under an LSP connection the
494
+ * store's change event has already asked the update handler to build a
495
+ * session's write; an override whose await outlasts that build makes the
496
+ * base's request start a build of its own, so the write is built and
497
+ * delivered twice.
498
+ *
499
+ * Rejects when the build leaves no document for `uri`, as for a URI with
500
+ * neither a file nor text: the wait after it has nothing to wait on.
408
501
  *
409
502
  * Consumers wanting "give me this doc at state X, building only if
410
503
  * needed" — use the per-state methods ({@link parsed} / {@link linked}
@@ -416,8 +509,8 @@ export class ModelService<
416
509
 
417
510
  /**
418
511
  * Internal build core operating on an already-{@link CanonicalUri canonical}
419
- * URI — the build counterpart to {@link waitForDocumentStateCanonical}. Drives
420
- * `DocumentBuilder.update` then waits via the canonical wait core, so the
512
+ * URI — the build counterpart to {@link waitForDocumentStateCanonical}.
513
+ * Requests the build, then waits via the canonical wait core, so the
421
514
  * identity is resolved once at the public door and neither sink re-runs the
422
515
  * `realpath`. (`DocumentBuilder.update` still resolves each URI internally for
423
516
  * directory flattening — that is the build's own existence-aware resolution,
@@ -429,15 +522,15 @@ export class ModelService<
429
522
  cancelToken?: CancellationToken
430
523
  ): Promise<AstDocument<TAst, TDiagnostic>> {
431
524
  const documentUri = UriUtils.toUri(uri);
432
- // Runs under the workspace WRITE lock, matching Langium's own
433
- // `DefaultDocumentUpdateHandler`, which dispatches its build as
434
- // `workspaceLock.write(token => documentBuilder.update(...))`.
525
+ // Runs under the workspace WRITE lock, through the builder's
526
+ // `scheduleUpdate` like the LSP update handler's build, so the build the
527
+ // store's change event already scheduled for this write carries this
528
+ // request too rather than being cancelled by it.
435
529
  //
436
530
  // Unlocked, this build races the LSP bridge's build of the same URI: both
437
531
  // are legitimate (the bridge only exists under a `Connection`, so the
438
- // facade stands in for it headless), and the coexistence note above relied
439
- // on Langium coalescing them by URI. It does not — nothing serialises the
440
- // two, so both reach `Validated`, and because each computes its missing
532
+ // facade stands in for it headless), and nothing serialises the two, so
533
+ // both reach `Validated`, and because each computes its missing
441
534
  // validation categories before the other has recorded its own, both run a
442
535
  // FULL pass and Langium appends the second onto the first (its append is
443
536
  // meant for category-partitioned passes). The user-visible result is every
@@ -452,21 +545,17 @@ export class ModelService<
452
545
  // writing back through this facade — would cancel its own enclosing
453
546
  // build and then likely stall in the phase wait below. The check is
454
547
  // gated on `serializeBuilds` deliberately, because acquiring the lock IS
455
- // the hazard: with serialisation off there is nothing to be reentrant
456
- // about, which makes the existing opt-out the guard's opt-out too.
548
+ // the hazard: with serialisation off the build takes no lock, which
549
+ // makes the existing opt-out the guard's opt-out too.
457
550
  // Detection needs async-context propagation, so it is inert until a host
458
551
  // installs a tracker (`@hydranium/core/node` does) — see
459
552
  // `isInsideWriteLock`.
460
553
  if (isInsideWriteLock()) {
461
554
  throw new ReentrantWriteLockError(uri);
462
555
  }
463
- // The lock's OWN token, not the caller's: a later `write` cancels the
464
- // running one through that token, so substituting the caller's would
465
- // leave this build deaf to the lock's cancellation protocol. A caller
466
- // token still governs the phase wait below.
467
- await this.services.workspace.WorkspaceLock.write(lockToken =>
468
- this.services.workspace.DocumentBuilder.update([documentUri], [], lockToken)
469
- );
556
+ // The build runs on the lock's own token, which a later write cancels;
557
+ // the caller's token governs only the phase wait below.
558
+ await this.services.workspace.DocumentBuilder.scheduleUpdate([documentUri], []);
470
559
  } else {
471
560
  await this.services.workspace.DocumentBuilder.update([documentUri], [], cancelToken);
472
561
  }
@@ -484,11 +573,19 @@ export class ModelService<
484
573
  *
485
574
  * Phase invariants encoded in the return type:
486
575
  * - `parsed` / `linked` / `settled` / `indexed` return
487
- * `AstDocument<TAst, never>` — diagnostics array is empty by phase
488
- * contract.
576
+ * `AstDocument<TAst, never>` — no diagnostics have been computed at
577
+ * those phases.
489
578
  * - `validated` returns `AstDocument<TAst, TDiagnostic>` — diagnostics
490
579
  * are populated.
491
580
  *
581
+ * **The `never` is enforced, not merely declared.** The wait underneath
582
+ * resolves at or ABOVE the requested state, so a document something else
583
+ * already carried past `Validated` would otherwise come back from
584
+ * `settled()` carrying a full diagnostics array typed `never`; these four
585
+ * strip it. An empty array here therefore means "this read does not report
586
+ * diagnostics", never "this document is clean" — call {@link validated}
587
+ * when the answer has to mean the second.
588
+ *
492
589
  * `settled` is the integrity-overlay name for "all integrity rules
493
590
  * have fired"; it maps to {@link IntegrityService.SettledState} (which
494
591
  * equals `DocumentState.IndexedReferences`), but the dedicated method
@@ -496,19 +593,19 @@ export class ModelService<
496
593
  * ever moves.
497
594
  */
498
595
  async parsed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
499
- return this.ensureDocumentState(uri, DocumentState.Parsed, cancelToken) as Promise<AstDocument<TAst, never>>;
596
+ return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.Parsed, cancelToken));
500
597
  }
501
598
 
502
599
  async linked(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
503
- return this.ensureDocumentState(uri, DocumentState.Linked, cancelToken) as Promise<AstDocument<TAst, never>>;
600
+ return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.Linked, cancelToken));
504
601
  }
505
602
 
506
603
  async settled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
507
- return this.ensureDocumentState(uri, IntegrityService.SettledState, cancelToken) as Promise<AstDocument<TAst, never>>;
604
+ return this.withoutDiagnostics(await this.ensureDocumentState(uri, IntegrityService.SettledState, cancelToken));
508
605
  }
509
606
 
510
607
  async indexed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
511
- return this.ensureDocumentState(uri, DocumentState.IndexedReferences, cancelToken) as Promise<AstDocument<TAst, never>>;
608
+ return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.IndexedReferences, cancelToken));
512
609
  }
513
610
 
514
611
  async validated(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
@@ -557,115 +654,14 @@ export class ModelService<
557
654
  return this.rebuild(uri, target, cancelToken);
558
655
  }
559
656
 
560
- /**
561
- * Apply an update for `uri`. The structured-or-textual `model` payload
562
- * is serialised (via {@link serialize} after {@link rewriteModel} when
563
- * structured), pushed into the multi-client text-document store with
564
- * a fresh version, drives a build to the target phase, and returns
565
- * the post-build AST snapshot.
566
- *
567
- * **Read-latest supersession**: concurrent callers on the same URI
568
- * all see the same post-build state once `waitUntil` resolves; none
569
- * deadlock waiting for a specific version's settled event. The
570
- * framework emits a post-resolution `debug` log line distinguishing
571
- * "vN ready" from "vN ready at vM (superseded)" so callers can
572
- * observe when their write was overtaken by a newer one before
573
- * settling — purely observability, doesn't change resolution
574
- * semantics. Adopters wanting version-matched resolution (resolve
575
- * with vN's specific settled snapshot, intermediate-phase
576
- * observability, slow-warn / hard-timeout behaviour) override this
577
- * method.
578
- */
579
- async update(args: TransferUpdateArgs<TTransfer>, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
580
- const stopwatch = this.slowUpdateWarn !== undefined ? this.services.Clock.stopwatch() : undefined;
581
- // Per-stage self-time breakdown of the update/reconcile chain (serialise →
582
- // open → apply → rebuild), opt-in at debug — the default path skips the
583
- // session and `run` calls the stage directly. `update` is a per-operation
584
- // method (one user save / diagram edit), not a per-node hot loop, so the
585
- // stage closures `run` allocates on the non-debug path are negligible.
586
- // Canonicalize the write URI once at the door and thread the resulting
587
- // CanonicalUri through the chain. The text store keys documents by their
588
- // canonical identity, so any spelling of a file — a canonical
589
- // (server-identity) URI from a GLSP cross-document save derived from
590
- // `findDocument(node).uri`, or the symlink path an editor opened — collapses
591
- // to the one registration; there is no second registration to fork. The
592
- // build step reuses the canonical wait core (`rebuildCanonical`) so the
593
- // identity is not re-resolved downstream.
594
- const uri = this.uriPolicy.canonicalUri(args.uri);
595
- const session = Logger.isLevelEnabled('debug') ? this.tracer.profile(`model-update ${uri}`) : undefined;
596
- const run = async <T>(stage: string, fn: () => MaybePromise<T>): Promise<T> => (session ? session.scope(stage, fn) : fn());
597
- // Open WITH the new text so a cold URI (no open editor, no file on disk) is
598
- // created from the payload rather than read from the filesystem — `update`
599
- // is an upsert. For an already-open document `open` refreshes content (the
600
- // text is ignored on that branch), so existing-document behaviour is
601
- // unchanged. `version` is intentionally NOT forwarded to `open`: a cold
602
- // create stays at its initial version, so a based-on-`version` update of a
603
- // not-yet-existing document still trips the conflict gate below.
604
- const text = await run('serialize', () => this.modelToText(uri, args.model, cancelToken));
605
- await run('open', () => this.open({ uri, clientId: args.clientId, text }));
606
- if (args.baseVersion !== undefined) {
607
- const current = this.services.workspace.TextDocuments.version(uri);
608
- if (current !== args.baseVersion) {
609
- // Distinct from the post-build "superseded" debug line below: this is a
610
- // based-on-stale rejection (the write never applies), not two writes racing.
611
- this.tracer.debug(`Conflict on ${uri}: based-on v${args.baseVersion} stale, server at v${current}`);
612
- throw new ConflictError(uri, args.baseVersion, current);
613
- }
614
- }
615
- const appliedVersion = await run('apply', () => this.services.workspace.AstDocumentManager.update(uri, text, args.clientId));
616
- // Dispatch through the public `rebuild` (which re-canonicalizes the already-
617
- // canonical `uri` once, idempotently) rather than `rebuildCanonical`, so an
618
- // adopter `rebuild` override stays in the update path. The redundant call is
619
- // a single kernel-cached `realpath`; correctness of the override contract
620
- // wins over shaving it.
621
- const doc = await run('rebuild', () => this.rebuild(uri, undefined, cancelToken));
622
- const finalVersion = this.services.workspace.TextDocuments.version(uri);
623
- if (finalVersion > appliedVersion) {
624
- this.tracer.debug(`Update to v${appliedVersion} ready at v${finalVersion} (superseded)`);
625
- } else {
626
- this.tracer.debug(`Update to v${appliedVersion} ready`);
627
- }
628
- if (this.slowUpdateWarn !== undefined && stopwatch) {
629
- const elapsed = Math.round(stopwatch.elapsedMs);
630
- const threshold = this.slowUpdateWarn.value;
631
- if (elapsed >= threshold) {
632
- this.tracer.withUri(uri).warn(`Slow update: ${elapsed}ms ≥ ${threshold}ms (v${appliedVersion}, client=${args.clientId})`);
633
- }
634
- }
635
- // One line per stage (serialise / open / apply / rebuild) + unaccounted — only when profiling.
636
- session?.report('debug');
637
- return doc;
638
- }
639
-
640
- /**
641
- * Persist `uri` to disk. Same content-change + settled-phase flow as
642
- * {@link update}, then writes via the
643
- * `WritableFileSystemProvider` and notifies the multi-client
644
- * text-document store of the save (so any open LSP-side editor sees
645
- * the `onDidSave` event regardless of who originated the persist).
646
- *
647
- * Returns the post-save AST snapshot.
648
- */
649
- async save(args: TransferSaveArgs<TTransfer>, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
650
- // Dispatch through `update` (not its internals) so an adopter `update`
651
- // override — version-matched resolution, etc. — applies to saves too.
652
- const doc = await this.update(args, cancelToken);
653
- // Persist under the same canonical identity `update` operated on. Writing
654
- // the canonical (real) path follows any symlink to the same file, and the
655
- // `onDidSave` keys the one canonical registration.
656
- const uri = this.uriPolicy.canonicalUri(args.uri);
657
- await this.services.workspace.AstDocumentManager.save(uri, args.clientId);
658
- return doc;
659
- }
660
-
661
657
  /**
662
658
  * Wait for the document at `uri` to reach the integrity-settled landmark and
663
659
  * drain any in-flight write-path applyEdit sync chain (see {@link syncChains})
664
660
  * so every language client reflects the latest content before a save returns.
665
661
  * No-op tail for headless adopters — `syncChains` is empty without an LSP
666
662
  * client. Bounded by {@link SAVE_SETTLE_TIMEOUT_MS} so a hung build, or an
667
- * applyEdit reverse-RPC deadlock, can't freeze the caller; on timeout it logs
668
- * a warning and returns rather than throwing.
663
+ * applyEdit reverse-RPC deadlock, can't freeze the caller; on timeout or a
664
+ * failed wait it logs a warning and returns rather than throwing.
669
665
  *
670
666
  * Adopters with a save flow that must converge editor + disk before returning
671
667
  * (e.g. a dual form/code editor that would otherwise show a content-conflict
@@ -674,57 +670,24 @@ export class ModelService<
674
670
  protected async settleSave(uri: string, cancelToken?: CancellationToken): Promise<void> {
675
671
  const canonical = this.uriPolicy.canonicalUri(uri);
676
672
  const key = UriUtils.toUri(canonical).toString();
677
- const timeout = new Promise<void>((_, reject) =>
678
- setTimeout(() => reject(new SaveSettleTimeoutError('settle timeout')), SAVE_SETTLE_TIMEOUT_MS)
679
- );
673
+ // One race over both waits, so the bound is one deadline for the pair;
674
+ // a race per wait would let the save take twice the bound.
675
+ const settled = (async (): Promise<void> => {
676
+ await this.waitForDocumentStateCanonical(canonical, IntegrityService.SettledState, cancelToken);
677
+ await this.syncChains.get(key);
678
+ })();
680
679
  try {
681
- await Promise.race([this.waitForDocumentStateCanonical(canonical, IntegrityService.SettledState, cancelToken), timeout]);
682
- const pending = this.syncChains.get(key);
683
- if (pending) {
684
- await Promise.race([pending, timeout]);
685
- }
686
- } catch (err: unknown) {
687
- if (err instanceof SaveSettleTimeoutError) {
680
+ if ((await this.services.Clock.raceTimer(settled, SAVE_SETTLE_TIMEOUT_MS)) === TIMED_OUT) {
688
681
  this.tracer.withUri(key).warn(`Save settle exceeded ${SAVE_SETTLE_TIMEOUT_MS}ms — returning anyway`);
689
- } else {
690
- const detail = err instanceof Error ? (err.stack ?? err.message) : String(err);
691
- this.tracer.withUri(key).warn(`Save settle failed before the timeout — returning anyway. ${detail}`);
692
682
  }
683
+ } catch (err: unknown) {
684
+ // A failed wait, such as a cancelled token or a document the builder
685
+ // does not hold, gets its own line so it is not blamed on the bound.
686
+ const detail = err instanceof Error ? (err.stack ?? err.message) : String(err);
687
+ this.tracer.withUri(key).warn(`Save settle failed before the timeout — returning anyway. ${detail}`);
693
688
  }
694
689
  }
695
690
 
696
- /**
697
- * Open the document at `args.uri` on behalf of `args.clientId`.
698
- * Multi-client: each (uri, clientId) pair is tracked as one
699
- * registration; the underlying document stays open until the last
700
- * client closes it. If `args.text` is omitted the document content
701
- * is read from the `FileSystemProvider`.
702
- *
703
- * Returns a {@link Disposable} that closes the registration when
704
- * disposed — useful for `using` blocks and shutdown cleanup.
705
- *
706
- * Delegates to the framework-bound
707
- * `services.workspace.AstDocumentManager`. Adopter subclasses with
708
- * extra open-time behaviour (logging, sync-chain bootstrapping)
709
- * override on their `ModelService` subclass and call `super.open`.
710
- *
711
- * The open path does not thread cancellation: `AstDocumentManager.open`
712
- * and the filesystem read behind it take no token, so a cancelled caller
713
- * still completes the open.
714
- */
715
- async open(args: OpenModelArgs): Promise<Disposable> {
716
- return this.services.workspace.AstDocumentManager.open(args);
717
- }
718
-
719
- /**
720
- * Close the document at `args.uri` for `args.clientId`. Counterpart
721
- * to {@link open}; the underlying document stays open until every
722
- * registered client has closed.
723
- */
724
- async close(args: CloseModelArgs): Promise<void> {
725
- return this.services.workspace.AstDocumentManager.close(args);
726
- }
727
-
728
691
  /**
729
692
  * True when the document at `uri` is currently open for at least one
730
693
  * client. Pure read; no side effects.
@@ -733,6 +696,31 @@ export class ModelService<
733
696
  return this.services.workspace.AstDocumentManager.isOpen(uri);
734
697
  }
735
698
 
699
+ /**
700
+ * Snapshot of `uri` as it stands RIGHT NOW — the synchronous sibling of the
701
+ * phase reads, which all wait. `undefined` when no document is registered.
702
+ *
703
+ * **This is what a writer wants, and {@link getDocument} is not.** The
704
+ * envelope's `version` is copied by value at projection time, so it cannot
705
+ * move afterwards; a version read off the live document at write time is
706
+ * whatever the server is at *now*, which is the number an optimistic gate is
707
+ * about to compare it against.
708
+ *
709
+ * Diagnostics only from a document that has reached `Validated`, and an
710
+ * empty array otherwise. Unlike the phase reads this one names no phase, so
711
+ * the state it finds is the only thing that can say whether the array
712
+ * describes the content being handed back or whatever an earlier build left.
713
+ * A caller that needs them unconditionally waits, via {@link validated}.
714
+ */
715
+ snapshot(uri: string): AstDocument<TAst, TDiagnostic> | undefined {
716
+ const document = this.getDocument(uri);
717
+ if (!document) {
718
+ return undefined;
719
+ }
720
+ const envelope = AstDocument.from<TAst, TDiagnostic>(document);
721
+ return document.state >= DocumentState.Validated ? envelope : this.withoutDiagnostics(envelope);
722
+ }
723
+
736
724
  /**
737
725
  * The built {@link LangiumDocument} for `uri`, looked up by canonical identity —
738
726
  * the synchronous, phase-agnostic sibling of {@link ensureDocumentState} /
@@ -741,11 +729,92 @@ export class ModelService<
741
729
  * into `LangiumDocuments` directly: a symlinked / `..` / case-divergent URI
742
730
  * still resolves to the one document the build keys by its real path. Returns
743
731
  * `undefined` if no document is registered for `uri`.
732
+ *
733
+ * **Live, so do not take a based-on version off it.** `textDocument` is the
734
+ * store's own object rather than a copy, so `.version` read here answers for
735
+ * the moment of the READ, not the moment of the earlier content — pass it to
736
+ * a write and the server compares its current version against itself, the
737
+ * gate passes unconditionally, and a concurrent edit is overwritten with
738
+ * nothing logged. Use {@link snapshot} for that, or a phase read.
744
739
  */
745
740
  getDocument(uri: string): LangiumDocument | undefined {
746
741
  return this.services.workspace.AstDocumentManager.getDocument(uri);
747
742
  }
748
743
 
744
+ // ============================================================
745
+ // Client sessions
746
+ // ============================================================
747
+
748
+ createSession<TOpenOptions extends OpenOptions = OpenOptions>(
749
+ label?: string,
750
+ clientId?: string
751
+ ): ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions> {
752
+ const sessionLabel = label ?? 'session';
753
+ const id = clientId ?? `${sessionLabel}#${globalThis.crypto.randomUUID()}`;
754
+ const textDocuments = this.services.workspace.TextDocuments;
755
+ textDocuments.registerSession(id);
756
+ this.sessionCloseListener ??= textDocuments.onDidCloseSession(event => {
757
+ // Also reached when the store ends a session directly; disposing the
758
+ // handle makes its later calls fail rather than write under an id
759
+ // this service no longer treats as a session.
760
+ this.sessions.get(event.clientId)?.dispose();
761
+ this.sessions.delete(event.clientId);
762
+ });
763
+ let session: ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions>;
764
+ try {
765
+ // Unchecked: the session keeps whatever options its `open` is handed,
766
+ // and the factory types it for every grammar, so the narrowed type
767
+ // holds only for the caller that started it.
768
+ session = this.services.model.ClientSessionFactory.create(id, sessionLabel) as ClientSession<
769
+ TAst,
770
+ TDiagnostic,
771
+ TTransfer,
772
+ TOpenOptions
773
+ >;
774
+ } catch (err: unknown) {
775
+ textDocuments.closeSession(id);
776
+ throw err;
777
+ }
778
+ this.sessions.set(id, session);
779
+ return session;
780
+ }
781
+
782
+ getSession(clientId: string): ClientSession<TAst, TDiagnostic, TTransfer> | undefined {
783
+ return this.sessions.get(clientId);
784
+ }
785
+
786
+ /**
787
+ * Convert a structured-or-textual `model` payload to its textual form.
788
+ *
789
+ * Textual payloads (LSP / pre-serialised callers) pass through untouched.
790
+ * Structured payloads run the per-language `UpdateRewriteService` chain
791
+ * (transfer-model transforms; diff-aware rewrites see the previous AST root),
792
+ * then serialise. The chain is the single transfer-model-transform seam — a
793
+ * unary normalisation is just a rewrite that ignores `previous`, as
794
+ * `NormalizeEmptyStringsContribution` does. The chain is empty by
795
+ * default, so this is a no-op for adopters that register none.
796
+ */
797
+ async modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string> {
798
+ if (typeof model === 'string') {
799
+ return model;
800
+ }
801
+ const rewritten = await this.rewriteModel(uri, model, cancelToken);
802
+ const target = UriUtils.toUri(uri);
803
+ const trivia = this.services.ServiceRegistry?.getServices(target)?.trivia?.TriviaService;
804
+ // Extracted BEFORE serializing, so it reads the document the write is
805
+ // about to replace rather than whatever a concurrent build left behind.
806
+ let document = this.services.workspace.LangiumDocuments.getDocument(target);
807
+ if (trivia !== undefined && document === undefined) {
808
+ const source = await this.textToTakeTriviaFrom(uri, target);
809
+ if (source !== undefined) {
810
+ document = this.services.workspace.LangiumDocumentFactory.fromString(source, target);
811
+ }
812
+ }
813
+ const extracted = trivia !== undefined && document !== undefined ? trivia.extract(document) : undefined;
814
+ const serialized = await this.serialize(uri, rewritten);
815
+ return extracted === undefined ? serialized : trivia!.apply(serialized, extracted, target);
816
+ }
817
+
749
818
  // ============================================================
750
819
  // LSP-client sync (mirror non-LSP-client changes back to Monaco)
751
820
  // ============================================================
@@ -754,18 +823,14 @@ export class ModelService<
754
823
  * Mirror a server-side change of `document` back to the LSP textual language
755
824
  * client, run per document as it reaches the post-integrity settled phase.
756
825
  * The single framework caller of
757
- * `HydraniumTextDocuments.applyEditToLanguageClient` and
758
- * `HydraniumTextDocuments.stagePendingContent`.
759
- *
760
- * Routes to one of two mechanisms by language-client registration, because
761
- * an open and a closed document answer different questions:
826
+ * `HydraniumTextDocuments.applyEditToLanguageClient`.
762
827
  *
763
- * - **Open in the language client** → {@link syncOpenDocument}: mirror the
764
- * settled text via a coalesced `applyEditToLanguageClient`, routed purely by
765
- * **content**.
766
- * - **Closed in the language client** → {@link stageClosedDocument}: stage the
767
- * text for the eventual first `didOpen`, gated by **provenance**
768
- * ({@link isNonLanguageClientEdit}).
828
+ * Only a document open in the language client is mirrored, through
829
+ * {@link syncOpenDocument}, routed purely by **content**. A document open
830
+ * only in another client needs nothing: a language client opening it joins
831
+ * the existing entry and is refreshed from the store. A session writes only
832
+ * what it has open, so no session edit of a closed document waits here for
833
+ * the language client's next open.
769
834
  *
770
835
  * The decision is **re-derived from the current settled state every time** (it
771
836
  * is not a one-shot enrolment), which is what makes it self-healing: a doc
@@ -775,9 +840,9 @@ export class ModelService<
775
840
  */
776
841
  protected syncToLanguageClient(document: LangiumDocument): void {
777
842
  // `document.textDocument.uri` is the server-identity (canonical) URI off the
778
- // build. Route by language-client registration (a presence question —
779
- // `isOpenInLanguageClient` canonicalizes internally, so a divergent open path
780
- // still resolves to the same record), but key the outbound sync by this
843
+ // build. Route by client registration (presence questions — both
844
+ // predicates canonicalize internally, so a divergent open path still
845
+ // resolves to the same record), but key the outbound sync by this
781
846
  // CANONICAL URI — the same key `settleSave` looks the chain up under —
782
847
  // so a save-settle can drain the in-flight applyEdit. The canonical→client-URI
783
848
  // translation (a symlinked path the client opened, or a dual-open fan-out)
@@ -787,8 +852,6 @@ export class ModelService<
787
852
  // the drain would miss for a divergent open path.
788
853
  if (this.services.workspace.TextDocuments.isOpenInLanguageClient(document.textDocument.uri)) {
789
854
  this.syncOpenDocument(document.textDocument.uri, document.textDocument.getText());
790
- } else {
791
- this.stageClosedDocument(document);
792
855
  }
793
856
  }
794
857
 
@@ -807,46 +870,6 @@ export class ModelService<
807
870
  this.queueSync(uri, text);
808
871
  }
809
872
 
810
- /**
811
- * Stage the settled text of a document closed in the language client so the
812
- * eventual first `didOpen` sees this in-memory text instead of stale disk —
813
- * but only for a {@link isNonLanguageClientEdit genuine non-language-client edit}.
814
- * A document rebuilt by an internal build is skipped, leaving disk authoritative
815
- * on the next open.
816
- */
817
- protected stageClosedDocument(document: LangiumDocument): void {
818
- if (this.isNonLanguageClientEdit(document)) {
819
- this.services.workspace.TextDocuments.stagePendingContent(document.textDocument.uri, document.textDocument.getText());
820
- }
821
- }
822
-
823
- /**
824
- * Whether `document`'s settled state is a genuine edit by a client *other than
825
- * the language client* — a write a form / GLSP / integrity client actually made.
826
- * Excludes two non-edits: the **language client** itself (the LSP/Monaco text
827
- * client — it already holds its own edits, and the staging here exists to feed
828
- * it) and an **internal build** (workspace startup, a cascade relink, a
829
- * `didClose`-reload). This is the gate for {@link stageClosedDocument}: staging
830
- * an internal build would
831
- * (a) pre-stage every file on boot and (b) re-stage discarded content after
832
- * close (e.g. a disposing GLSP session's debounced submit firing after close),
833
- * which then shadows clean disk on the next open.
834
- *
835
- * The signal is "a known client other than the language client authored this
836
- * version **and** the URI was in the last build's changed set
837
- * (`isDirectChange`)". A framework-internal rebuild reports no author
838
- * (`getAuthor` → `undefined`), so it fails `hasKnownAuthor` without comparing
839
- * against a sentinel. This is NOT redundant with content/registration — it
840
- * distinguishes "client edited" from "framework rebuilt", which neither the
841
- * shadow nor `isDirectChange` alone can.
842
- */
843
- protected isNonLanguageClientEdit(document: LangiumDocument): boolean {
844
- const documents = this.services.workspace.AstDocumentManager;
845
- const author = documents.getAuthor(document);
846
- const hasKnownAuthor = !!author && author !== LANGUAGE_CLIENT_ID;
847
- return hasKnownAuthor && documents.isDirectChange(document.textDocument.uri);
848
- }
849
-
850
873
  /**
851
874
  * Enqueue a sync to the language client. The pending slot per URI holds only
852
875
  * the latest text: if a newer settle fires while the current RPC is in
@@ -878,15 +901,28 @@ export class ModelService<
878
901
  this.syncChains.set(uri, chain);
879
902
  }
880
903
 
904
+ /**
905
+ * The undo-stack label for a server-authored write, in the locale the server
906
+ * was handed at init.
907
+ *
908
+ * One method rather than the literal at each `applyEdit`, because the two
909
+ * call sites are the same edit — a push and its full-replace retry — and an
910
+ * undo menu showing two different words for one operation would read as two
911
+ * operations.
912
+ */
913
+ protected editLabel(): string {
914
+ return this.services.MessageRenderer.renderMessage(MODEL_UPDATE_EDIT);
915
+ }
916
+
881
917
  protected async drainSyncQueue(uri: string): Promise<void> {
882
918
  const uriLogger = this.tracer.withUri(uri);
883
919
  while (this.pendingSync.has(uri)) {
884
920
  const text = this.pendingSync.get(uri)!;
885
921
  this.pendingSync.delete(uri);
886
922
  try {
887
- let result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label: 'Update Model' });
923
+ let result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label: this.editLabel() });
888
924
  if (result?.applied === false && !this.pendingSync.has(uri)) {
889
- // The push is addressed at the client's LAST DECLARED VERSION, so a
925
+ // The push is addressed at the client's last known version, so a
890
926
  // rejection normally means the client's buffer moved while the
891
927
  // line-keyed diff was in flight — exactly the case where applying it
892
928
  // would splice the file. Dropping the push there would leave the
@@ -904,8 +940,8 @@ export class ModelService<
904
940
  // `pendingSync` check skips the retry when a newer settle has already
905
941
  // queued — best-effort, since a settle arriving later simply pushes
906
942
  // after this and still wins.
907
- uriLogger.warn(`Language client rejected applyEdit at its declared version — re-pushing a full replace`);
908
- result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label: 'Update Model' });
943
+ uriLogger.debug(`Re-pushing a full replace after the language client refused applyEdit`);
944
+ result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label: this.editLabel() });
909
945
  if (result?.applied === false) {
910
946
  uriLogger.warn(`Language client rejected the full-replace retry too — client content is stale`);
911
947
  }
@@ -935,9 +971,8 @@ export class ModelService<
935
971
  * `HydraniumTextDocuments` — single listener registration shared with
936
972
  * any direct `HydraniumTextDocuments.onUpdate` subscriber, so the same
937
973
  * underlying `DocumentBuilder.onDocumentPhase` listener serves both
938
- * call paths. `sourceClientId` is resolved from the multi-client
939
- * author history; reason discrimination follows the manager's own
940
- * `lastUpdate` snapshot (see `AstDocumentManager.onUpdate`).
974
+ * call paths. The event's reason, source and cause are
975
+ * {@link AstDocumentManager.attributeUpdate}'s.
941
976
  */
942
977
  onModelUpdated(uri: string, listener: (event: AstDocumentUpdatedEvent<TAst, TDiagnostic>) => void): Disposable {
943
978
  return this.services.workspace.AstDocumentManager.onUpdate(uri, listener as never);
@@ -979,13 +1014,13 @@ export class ModelService<
979
1014
  * Adopters whose serializer call shape differs (custom service
980
1015
  * names, generator-driven YAML pretty printers, etc.) override this
981
1016
  * method. Routes through `Serializer.serializeTransfer` because
982
- * `ModelService.update` / `ModelService.save` always receive a
1017
+ * a session's `update` / `save` always receive a
983
1018
  * transfer-model shape (cross-references as plain strings) from
984
1019
  * adopter callers — the AST-shape entry point is `serializeAst`.
985
1020
  *
986
1021
  * Returns {@link MaybePromise} so adopter `Serializer` overrides can be
987
1022
  * async (remote schema lookup, external canonical-value resolution); the
988
- * single caller ({@link modelToText} → {@link update}) is already `async`,
1023
+ * single caller ({@link modelToText}) is already `async`,
989
1024
  * so a naive `await` covers both branches without extra ceremony.
990
1025
  */
991
1026
  protected serialize(uri: string, root: TTransfer): MaybePromise<string> {
@@ -998,22 +1033,12 @@ export class ModelService<
998
1033
  // ============================================================
999
1034
 
1000
1035
  /**
1001
- * Convert a structured-or-textual `model` payload to its textual form.
1002
- *
1003
- * Textual payloads (LSP / pre-serialised callers) pass through untouched.
1004
- * Structured payloads run the per-language `UpdateRewriteService` chain
1005
- * (transfer-model transforms; diff-aware rewrites see the previous AST root),
1006
- * then serialise. The chain is the single transfer-model-transform seam — a
1007
- * unary normalisation is just a rewrite that ignores `previous`, as
1008
- * `NormalizeEmptyStringsContribution` does. The chain is empty by
1009
- * default, so this is a no-op for adopters that register none.
1036
+ * The text a write into a document not yet built should take its trivia
1037
+ * from: the store's, which a write always has, since it writes only a
1038
+ * document its client has open.
1010
1039
  */
1011
- protected async modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string> {
1012
- if (typeof model === 'string') {
1013
- return model;
1014
- }
1015
- const rewritten = await this.rewriteModel(uri, model, cancelToken);
1016
- return this.serialize(uri, rewritten);
1040
+ protected async textToTakeTriviaFrom(uri: string, _target: URI): Promise<string | undefined> {
1041
+ return this.services.workspace.TextDocuments.get(uri)?.getText();
1017
1042
  }
1018
1043
 
1019
1044
  /**
@@ -1048,4 +1073,23 @@ export class ModelService<
1048
1073
  ? AstDocument.from<TAst, TDiagnostic>(document)
1049
1074
  : AstDocument.create<TAst, TDiagnostic>(uri.toString(), 0, undefined as unknown as TAst, []);
1050
1075
  }
1076
+
1077
+ /**
1078
+ * The same envelope with no diagnostics, for a read that names a phase below
1079
+ * `Validated`.
1080
+ *
1081
+ * Langium fills `LangiumDocument.diagnostics` from inside `validateDocument`
1082
+ * and from nowhere else, so below that phase the array holds whatever an
1083
+ * EARLIER build left — a verdict about text the document may no longer have.
1084
+ * The wait underneath resolves at or above the phase asked for, so a document
1085
+ * something else carried past `Validated` would otherwise hand a full array
1086
+ * back from `parsed()`.
1087
+ *
1088
+ * A copy rather than a clear: the envelope is freshly built here, but
1089
+ * {@link toAstDocument} is overridable and an adopter's version may return
1090
+ * one it also keeps.
1091
+ */
1092
+ protected withoutDiagnostics(document: AstDocument<TAst, TDiagnostic>): AstDocument<TAst, never> {
1093
+ return { ...document, diagnostics: [] };
1094
+ }
1051
1095
  }