@hydranium/core 1.0.0-next.30 → 1.0.0-next.301

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 (770) hide show
  1. package/README.md +72 -82
  2. package/lib/browser/host-heads-in-worker.d.ts +58 -0
  3. package/lib/browser/host-heads-in-worker.d.ts.map +1 -0
  4. package/lib/browser/host-heads-in-worker.js +113 -0
  5. package/lib/browser/host-heads-in-worker.js.map +1 -0
  6. package/lib/browser/index.d.ts +12 -0
  7. package/lib/browser/index.d.ts.map +1 -0
  8. package/lib/browser/index.js +17 -0
  9. package/lib/browser/index.js.map +1 -0
  10. package/lib/browser/indexeddb-file-system-store.d.ts +82 -0
  11. package/lib/browser/indexeddb-file-system-store.d.ts.map +1 -0
  12. package/lib/browser/indexeddb-file-system-store.js +181 -0
  13. package/lib/browser/indexeddb-file-system-store.js.map +1 -0
  14. package/lib/browser/start-language-server-in-worker.d.ts +29 -0
  15. package/lib/browser/start-language-server-in-worker.d.ts.map +1 -0
  16. package/lib/browser/start-language-server-in-worker.js +35 -0
  17. package/lib/browser/start-language-server-in-worker.js.map +1 -0
  18. package/lib/documents/ast-document-manager.d.ts +256 -124
  19. package/lib/documents/ast-document-manager.d.ts.map +1 -1
  20. package/lib/documents/ast-document-manager.js +293 -132
  21. package/lib/documents/ast-document-manager.js.map +1 -1
  22. package/lib/documents/client-ids.d.ts +5 -19
  23. package/lib/documents/client-ids.d.ts.map +1 -1
  24. package/lib/documents/client-ids.js +5 -19
  25. package/lib/documents/client-ids.js.map +1 -1
  26. package/lib/documents/client-session-errors.d.ts +15 -0
  27. package/lib/documents/client-session-errors.d.ts.map +1 -0
  28. package/lib/documents/client-session-errors.js +15 -0
  29. package/lib/documents/client-session-errors.js.map +1 -0
  30. package/lib/documents/client-session-registry.d.ts +146 -0
  31. package/lib/documents/client-session-registry.d.ts.map +1 -0
  32. package/lib/documents/client-session-registry.js +207 -0
  33. package/lib/documents/client-session-registry.js.map +1 -0
  34. package/lib/documents/dirty-state-tracker.d.ts +101 -0
  35. package/lib/documents/dirty-state-tracker.d.ts.map +1 -0
  36. package/lib/documents/dirty-state-tracker.js +85 -0
  37. package/lib/documents/dirty-state-tracker.js.map +1 -0
  38. package/lib/documents/document-release-handler.d.ts +204 -0
  39. package/lib/documents/document-release-handler.d.ts.map +1 -0
  40. package/lib/documents/document-release-handler.js +317 -0
  41. package/lib/documents/document-release-handler.js.map +1 -0
  42. package/lib/documents/document-release-scheduler.d.ts +67 -0
  43. package/lib/documents/document-release-scheduler.d.ts.map +1 -0
  44. package/lib/documents/document-release-scheduler.js +80 -0
  45. package/lib/documents/document-release-scheduler.js.map +1 -0
  46. package/lib/documents/file-system-task-queue.d.ts +52 -0
  47. package/lib/documents/file-system-task-queue.d.ts.map +1 -0
  48. package/lib/documents/file-system-task-queue.js +37 -0
  49. package/lib/documents/file-system-task-queue.js.map +1 -0
  50. package/lib/documents/hydranium-text-documents.d.ts +419 -282
  51. package/lib/documents/hydranium-text-documents.d.ts.map +1 -1
  52. package/lib/documents/hydranium-text-documents.js +856 -483
  53. package/lib/documents/hydranium-text-documents.js.map +1 -1
  54. package/lib/documents/index.d.ts +10 -2
  55. package/lib/documents/index.d.ts.map +1 -1
  56. package/lib/documents/index.js +10 -2
  57. package/lib/documents/index.js.map +1 -1
  58. package/lib/documents/language-client-shadow.d.ts +218 -0
  59. package/lib/documents/language-client-shadow.d.ts.map +1 -0
  60. package/lib/documents/language-client-shadow.js +284 -0
  61. package/lib/documents/language-client-shadow.js.map +1 -0
  62. package/lib/documents/model-ledger.d.ts +47 -0
  63. package/lib/documents/model-ledger.d.ts.map +1 -0
  64. package/lib/documents/model-ledger.js +30 -0
  65. package/lib/documents/model-ledger.js.map +1 -0
  66. package/lib/documents/text-ledger.d.ts +64 -0
  67. package/lib/documents/text-ledger.d.ts.map +1 -0
  68. package/lib/documents/text-ledger.js +63 -0
  69. package/lib/documents/text-ledger.js.map +1 -0
  70. package/lib/documents/version-sync-service.d.ts +138 -0
  71. package/lib/documents/version-sync-service.d.ts.map +1 -0
  72. package/lib/documents/version-sync-service.js +173 -0
  73. package/lib/documents/version-sync-service.js.map +1 -0
  74. package/lib/index.d.ts +5 -0
  75. package/lib/index.d.ts.map +1 -1
  76. package/lib/index.js +8 -0
  77. package/lib/index.js.map +1 -1
  78. package/lib/langium/ast-extension/ast-extension-service.d.ts +42 -31
  79. package/lib/langium/ast-extension/ast-extension-service.d.ts.map +1 -1
  80. package/lib/langium/ast-extension/ast-extension-service.js +45 -19
  81. package/lib/langium/ast-extension/ast-extension-service.js.map +1 -1
  82. package/lib/langium/ast-extension/ast-node-builder.d.ts +32 -9
  83. package/lib/langium/ast-extension/ast-node-builder.d.ts.map +1 -1
  84. package/lib/langium/ast-extension/ast-node-builder.js +60 -22
  85. package/lib/langium/ast-extension/ast-node-builder.js.map +1 -1
  86. package/lib/langium/bootstrap.d.ts +49 -36
  87. package/lib/langium/bootstrap.d.ts.map +1 -1
  88. package/lib/langium/bootstrap.js +91 -45
  89. package/lib/langium/bootstrap.js.map +1 -1
  90. package/lib/langium/build-phase-pass/build-phase-pass-service.d.ts +9 -9
  91. package/lib/langium/build-phase-pass/build-phase-pass-service.d.ts.map +1 -1
  92. package/lib/langium/build-phase-pass/build-phase-pass-service.js +25 -16
  93. package/lib/langium/build-phase-pass/build-phase-pass-service.js.map +1 -1
  94. package/lib/langium/build-phase-pass/build-phase-pass.d.ts +20 -8
  95. package/lib/langium/build-phase-pass/build-phase-pass.d.ts.map +1 -1
  96. package/lib/langium/build-phase-pass/build-phase-pass.js +20 -0
  97. package/lib/langium/build-phase-pass/build-phase-pass.js.map +1 -1
  98. package/lib/langium/composite-ast-reflection.d.ts +46 -0
  99. package/lib/langium/composite-ast-reflection.d.ts.map +1 -0
  100. package/lib/langium/composite-ast-reflection.js +97 -0
  101. package/lib/langium/composite-ast-reflection.js.map +1 -0
  102. package/lib/langium/config/configuration-provider.d.ts +81 -0
  103. package/lib/langium/config/configuration-provider.d.ts.map +1 -0
  104. package/lib/langium/config/configuration-provider.js +112 -0
  105. package/lib/langium/config/configuration-provider.js.map +1 -0
  106. package/lib/langium/config/index.d.ts +1 -0
  107. package/lib/langium/config/index.d.ts.map +1 -1
  108. package/lib/langium/config/index.js +1 -0
  109. package/lib/langium/config/index.js.map +1 -1
  110. package/lib/langium/config/settings.js.map +1 -1
  111. package/lib/langium/diagnostics/hydranium-langium-profiler.d.ts +9 -20
  112. package/lib/langium/diagnostics/hydranium-langium-profiler.d.ts.map +1 -1
  113. package/lib/langium/diagnostics/hydranium-langium-profiler.js +15 -24
  114. package/lib/langium/diagnostics/hydranium-langium-profiler.js.map +1 -1
  115. package/lib/langium/diagnostics/log-preamble.js +1 -1
  116. package/lib/langium/diagnostics/log-preamble.js.map +1 -1
  117. package/lib/langium/diagnostics/logger.d.ts +19 -4
  118. package/lib/langium/diagnostics/logger.d.ts.map +1 -1
  119. package/lib/langium/diagnostics/logger.js +36 -11
  120. package/lib/langium/diagnostics/logger.js.map +1 -1
  121. package/lib/langium/diagnostics/lsp-logger.d.ts +17 -0
  122. package/lib/langium/diagnostics/lsp-logger.d.ts.map +1 -1
  123. package/lib/langium/diagnostics/lsp-logger.js +58 -17
  124. package/lib/langium/diagnostics/lsp-logger.js.map +1 -1
  125. package/lib/langium/diagnostics/server-tracer.d.ts.map +1 -1
  126. package/lib/langium/diagnostics/server-tracer.js.map +1 -1
  127. package/lib/langium/document-builder/build-pipeline-integration.d.ts +21 -1
  128. package/lib/langium/document-builder/build-pipeline-integration.d.ts.map +1 -1
  129. package/lib/langium/document-builder/build-pipeline-integration.js +28 -30
  130. package/lib/langium/document-builder/build-pipeline-integration.js.map +1 -1
  131. package/lib/langium/document-builder/build-session.d.ts +6 -5
  132. package/lib/langium/document-builder/build-session.d.ts.map +1 -1
  133. package/lib/langium/document-builder/build-session.js +5 -5
  134. package/lib/langium/document-builder/build-session.js.map +1 -1
  135. package/lib/langium/document-builder/document-builder.d.ts +309 -35
  136. package/lib/langium/document-builder/document-builder.d.ts.map +1 -1
  137. package/lib/langium/document-builder/document-builder.js +511 -75
  138. package/lib/langium/document-builder/document-builder.js.map +1 -1
  139. package/lib/langium/documentation/comment-provider.d.ts.map +1 -1
  140. package/lib/langium/documentation/comment-provider.js.map +1 -1
  141. package/lib/langium/integration-services.d.ts +40 -24
  142. package/lib/langium/integration-services.d.ts.map +1 -1
  143. package/lib/langium/integration-services.js +7 -4
  144. package/lib/langium/integration-services.js.map +1 -1
  145. package/lib/langium/integrity/integrity-rule.d.ts +16 -8
  146. package/lib/langium/integrity/integrity-rule.d.ts.map +1 -1
  147. package/lib/langium/integrity/integrity-rule.js.map +1 -1
  148. package/lib/langium/integrity/integrity-service.d.ts +83 -27
  149. package/lib/langium/integrity/integrity-service.d.ts.map +1 -1
  150. package/lib/langium/integrity/integrity-service.js +273 -63
  151. package/lib/langium/integrity/integrity-service.js.map +1 -1
  152. package/lib/langium/keys/containment.d.ts +64 -0
  153. package/lib/langium/keys/containment.d.ts.map +1 -0
  154. package/lib/langium/keys/containment.js +53 -0
  155. package/lib/langium/keys/containment.js.map +1 -0
  156. package/lib/langium/keys/index.d.ts +1 -0
  157. package/lib/langium/keys/index.d.ts.map +1 -1
  158. package/lib/langium/keys/index.js +1 -0
  159. package/lib/langium/keys/index.js.map +1 -1
  160. package/lib/langium/keys/name-based-key-provider.d.ts +4 -0
  161. package/lib/langium/keys/name-based-key-provider.d.ts.map +1 -1
  162. package/lib/langium/keys/name-based-key-provider.js +4 -0
  163. package/lib/langium/keys/name-based-key-provider.js.map +1 -1
  164. package/lib/langium/keys/positional-key-provider.d.ts.map +1 -1
  165. package/lib/langium/keys/positional-key-provider.js.map +1 -1
  166. package/lib/langium/labeling/label-provider.d.ts.map +1 -1
  167. package/lib/langium/labeling/label-provider.js.map +1 -1
  168. package/lib/langium/language-module.d.ts +30 -5
  169. package/lib/langium/language-module.d.ts.map +1 -1
  170. package/lib/langium/language-module.js +18 -4
  171. package/lib/langium/language-module.js.map +1 -1
  172. package/lib/langium/model-service/client-session.d.ts +374 -0
  173. package/lib/langium/model-service/client-session.d.ts.map +1 -0
  174. package/lib/langium/model-service/client-session.js +446 -0
  175. package/lib/langium/model-service/client-session.js.map +1 -0
  176. package/lib/langium/model-service/index.d.ts +2 -0
  177. package/lib/langium/model-service/index.d.ts.map +1 -1
  178. package/lib/langium/model-service/index.js +2 -0
  179. package/lib/langium/model-service/index.js.map +1 -1
  180. package/lib/langium/model-service/model-events.d.ts +66 -0
  181. package/lib/langium/model-service/model-events.d.ts.map +1 -0
  182. package/lib/langium/model-service/model-events.js +10 -0
  183. package/lib/langium/model-service/model-events.js.map +1 -0
  184. package/lib/langium/model-service/model-service.d.ts +480 -289
  185. package/lib/langium/model-service/model-service.d.ts.map +1 -1
  186. package/lib/langium/model-service/model-service.js +597 -456
  187. package/lib/langium/model-service/model-service.js.map +1 -1
  188. package/lib/langium/module.d.ts +158 -37
  189. package/lib/langium/module.d.ts.map +1 -1
  190. package/lib/langium/module.js +52 -36
  191. package/lib/langium/module.js.map +1 -1
  192. package/lib/langium/naming/name-provider.d.ts +42 -7
  193. package/lib/langium/naming/name-provider.d.ts.map +1 -1
  194. package/lib/langium/naming/name-provider.js +10 -4
  195. package/lib/langium/naming/name-provider.js.map +1 -1
  196. package/lib/langium/naming/name-separator-validation.d.ts +23 -1
  197. package/lib/langium/naming/name-separator-validation.d.ts.map +1 -1
  198. package/lib/langium/naming/name-separator-validation.js +22 -0
  199. package/lib/langium/naming/name-separator-validation.js.map +1 -1
  200. package/lib/langium/project/abstract-project-manager.d.ts.map +1 -1
  201. package/lib/langium/project/abstract-project-manager.js +13 -6
  202. package/lib/langium/project/abstract-project-manager.js.map +1 -1
  203. package/lib/langium/project/project-change-event.d.ts +2 -2
  204. package/lib/langium/project/single-project-manager.d.ts.map +1 -1
  205. package/lib/langium/project/single-project-manager.js.map +1 -1
  206. package/lib/langium/residency/cst-residency-service.d.ts +35 -12
  207. package/lib/langium/residency/cst-residency-service.d.ts.map +1 -1
  208. package/lib/langium/residency/cst-residency-service.js +24 -58
  209. package/lib/langium/residency/cst-residency-service.js.map +1 -1
  210. package/lib/langium/scope/ast-node-description-provider.d.ts.map +1 -1
  211. package/lib/langium/scope/ast-node-description-provider.js.map +1 -1
  212. package/lib/langium/scope/fallback-scope.d.ts +27 -0
  213. package/lib/langium/scope/fallback-scope.d.ts.map +1 -0
  214. package/lib/langium/scope/fallback-scope.js +35 -0
  215. package/lib/langium/scope/fallback-scope.js.map +1 -0
  216. package/lib/langium/scope/hydranium-scope-computation.d.ts +21 -18
  217. package/lib/langium/scope/hydranium-scope-computation.d.ts.map +1 -1
  218. package/lib/langium/scope/hydranium-scope-computation.js +38 -39
  219. package/lib/langium/scope/hydranium-scope-computation.js.map +1 -1
  220. package/lib/langium/scope/hydranium-scope-provider.d.ts +39 -17
  221. package/lib/langium/scope/hydranium-scope-provider.d.ts.map +1 -1
  222. package/lib/langium/scope/hydranium-scope-provider.js +52 -26
  223. package/lib/langium/scope/hydranium-scope-provider.js.map +1 -1
  224. package/lib/langium/scope/index.d.ts +1 -0
  225. package/lib/langium/scope/index.d.ts.map +1 -1
  226. package/lib/langium/scope/index.js +1 -0
  227. package/lib/langium/scope/index.js.map +1 -1
  228. package/lib/langium/scope/reference-builder.d.ts.map +1 -1
  229. package/lib/langium/scope/reference-builder.js.map +1 -1
  230. package/lib/langium/scope/reference-candidate-provider.d.ts +6 -5
  231. package/lib/langium/scope/reference-candidate-provider.d.ts.map +1 -1
  232. package/lib/langium/scope/reference-candidate-provider.js +3 -2
  233. package/lib/langium/scope/reference-candidate-provider.js.map +1 -1
  234. package/lib/langium/scope/scope-extension-service.d.ts +41 -37
  235. package/lib/langium/scope/scope-extension-service.d.ts.map +1 -1
  236. package/lib/langium/scope/scope-extension-service.js +57 -29
  237. package/lib/langium/scope/scope-extension-service.js.map +1 -1
  238. package/lib/langium/scope/scoped-ast-node-description.d.ts +1 -3
  239. package/lib/langium/scope/scoped-ast-node-description.d.ts.map +1 -1
  240. package/lib/langium/scope/scoped-ast-node-description.js +1 -3
  241. package/lib/langium/scope/scoped-ast-node-description.js.map +1 -1
  242. package/lib/langium/serialization/abstract-serializer.d.ts +38 -27
  243. package/lib/langium/serialization/abstract-serializer.d.ts.map +1 -1
  244. package/lib/langium/serialization/abstract-serializer.js +54 -30
  245. package/lib/langium/serialization/abstract-serializer.js.map +1 -1
  246. package/lib/langium/serialization/json-serializer.d.ts +8 -1
  247. package/lib/langium/serialization/json-serializer.d.ts.map +1 -1
  248. package/lib/langium/serialization/json-serializer.js +13 -3
  249. package/lib/langium/serialization/json-serializer.js.map +1 -1
  250. package/lib/langium/serialization/serializer.d.ts +1 -1
  251. package/lib/langium/serialization/yaml-serializer.d.ts +4 -0
  252. package/lib/langium/serialization/yaml-serializer.d.ts.map +1 -1
  253. package/lib/langium/serialization/yaml-serializer.js +4 -0
  254. package/lib/langium/serialization/yaml-serializer.js.map +1 -1
  255. package/lib/langium/service-registry.d.ts +29 -1
  256. package/lib/langium/service-registry.d.ts.map +1 -1
  257. package/lib/langium/service-registry.js +37 -0
  258. package/lib/langium/service-registry.js.map +1 -1
  259. package/lib/langium/shared-services.d.ts +23 -6
  260. package/lib/langium/shared-services.d.ts.map +1 -1
  261. package/lib/langium/shared-services.js.map +1 -1
  262. package/lib/langium/single-langium-copy.d.ts +22 -0
  263. package/lib/langium/single-langium-copy.d.ts.map +1 -0
  264. package/lib/langium/single-langium-copy.js +36 -0
  265. package/lib/langium/single-langium-copy.js.map +1 -0
  266. package/lib/langium/transfer/transfer-encoder.d.ts +84 -35
  267. package/lib/langium/transfer/transfer-encoder.d.ts.map +1 -1
  268. package/lib/langium/transfer/transfer-encoder.js +34 -23
  269. package/lib/langium/transfer/transfer-encoder.js.map +1 -1
  270. package/lib/langium/trivia/comment-preserver.d.ts +423 -0
  271. package/lib/langium/trivia/comment-preserver.d.ts.map +1 -0
  272. package/lib/langium/trivia/comment-preserver.js +906 -0
  273. package/lib/langium/trivia/comment-preserver.js.map +1 -0
  274. package/lib/langium/trivia/document-ending-preserver.d.ts +51 -0
  275. package/lib/langium/trivia/document-ending-preserver.d.ts.map +1 -0
  276. package/lib/langium/trivia/document-ending-preserver.js +62 -0
  277. package/lib/langium/trivia/document-ending-preserver.js.map +1 -0
  278. package/lib/langium/trivia/index.d.ts +14 -0
  279. package/lib/langium/trivia/index.d.ts.map +1 -0
  280. package/lib/langium/trivia/index.js +14 -0
  281. package/lib/langium/trivia/index.js.map +1 -0
  282. package/lib/langium/trivia/trivia-contribution.d.ts +37 -0
  283. package/lib/langium/trivia/trivia-contribution.d.ts.map +1 -0
  284. package/lib/langium/trivia/trivia-contribution.js +10 -0
  285. package/lib/langium/trivia/trivia-contribution.js.map +1 -0
  286. package/lib/langium/trivia/trivia-preserver.d.ts +52 -0
  287. package/lib/langium/trivia/trivia-preserver.d.ts.map +1 -0
  288. package/lib/langium/trivia/trivia-preserver.js +10 -0
  289. package/lib/langium/trivia/trivia-preserver.js.map +1 -0
  290. package/lib/langium/trivia/trivia-service.d.ts +70 -0
  291. package/lib/langium/trivia/trivia-service.d.ts.map +1 -0
  292. package/lib/langium/trivia/trivia-service.js +56 -0
  293. package/lib/langium/trivia/trivia-service.js.map +1 -0
  294. package/lib/langium/update-rewrite/normalize-empty-strings.d.ts.map +1 -1
  295. package/lib/langium/update-rewrite/update-rewrite-service.d.ts +1 -1
  296. package/lib/langium/update-rewrite/update-rewrite-service.d.ts.map +1 -1
  297. package/lib/langium/update-rewrite/update-rewrite-service.js.map +1 -1
  298. package/lib/langium/update-rewrite/update-rewrite.d.ts +1 -1
  299. package/lib/langium/validation/document-validator.d.ts +280 -9
  300. package/lib/langium/validation/document-validator.d.ts.map +1 -1
  301. package/lib/langium/validation/document-validator.js +453 -8
  302. package/lib/langium/validation/document-validator.js.map +1 -1
  303. package/lib/langium/validation/validation-contribution-collector.d.ts +9 -1
  304. package/lib/langium/validation/validation-contribution-collector.d.ts.map +1 -1
  305. package/lib/langium/validation/validation-contribution-collector.js +1 -1
  306. package/lib/langium/validation/validation-contribution-collector.js.map +1 -1
  307. package/lib/langium/workspace/document-uri-policy.d.ts +24 -15
  308. package/lib/langium/workspace/document-uri-policy.d.ts.map +1 -1
  309. package/lib/langium/workspace/document-uri-policy.js +22 -13
  310. package/lib/langium/workspace/document-uri-policy.js.map +1 -1
  311. package/lib/langium/workspace/file-not-found.d.ts +23 -0
  312. package/lib/langium/workspace/file-not-found.d.ts.map +1 -0
  313. package/lib/langium/workspace/file-not-found.js +31 -0
  314. package/lib/langium/workspace/file-not-found.js.map +1 -0
  315. package/lib/langium/workspace/file-system-provider.d.ts +165 -8
  316. package/lib/langium/workspace/file-system-provider.d.ts.map +1 -1
  317. package/lib/langium/workspace/file-system-provider.js +111 -13
  318. package/lib/langium/workspace/file-system-provider.js.map +1 -1
  319. package/lib/langium/workspace/hydranium-langium-document-factory.d.ts +31 -1
  320. package/lib/langium/workspace/hydranium-langium-document-factory.d.ts.map +1 -1
  321. package/lib/langium/workspace/hydranium-langium-document-factory.js +54 -0
  322. package/lib/langium/workspace/hydranium-langium-document-factory.js.map +1 -1
  323. package/lib/langium/workspace/hydranium-workspace-lock.d.ts +43 -1
  324. package/lib/langium/workspace/hydranium-workspace-lock.d.ts.map +1 -1
  325. package/lib/langium/workspace/hydranium-workspace-lock.js +58 -1
  326. package/lib/langium/workspace/hydranium-workspace-lock.js.map +1 -1
  327. package/lib/langium/workspace/hydranium-workspace-manager.d.ts +124 -22
  328. package/lib/langium/workspace/hydranium-workspace-manager.d.ts.map +1 -1
  329. package/lib/langium/workspace/hydranium-workspace-manager.js +212 -31
  330. package/lib/langium/workspace/hydranium-workspace-manager.js.map +1 -1
  331. package/lib/langium/workspace/in-memory-file-system-provider.d.ts +26 -9
  332. package/lib/langium/workspace/in-memory-file-system-provider.d.ts.map +1 -1
  333. package/lib/langium/workspace/in-memory-file-system-provider.js +45 -22
  334. package/lib/langium/workspace/in-memory-file-system-provider.js.map +1 -1
  335. package/lib/langium/workspace/index-manager.d.ts.map +1 -1
  336. package/lib/langium/workspace/index-manager.js.map +1 -1
  337. package/lib/langium/workspace/index.d.ts +1 -0
  338. package/lib/langium/workspace/index.d.ts.map +1 -1
  339. package/lib/langium/workspace/index.js +1 -0
  340. package/lib/langium/workspace/index.js.map +1 -1
  341. package/lib/langium/workspace/initialize-workspace.d.ts +31 -2
  342. package/lib/langium/workspace/initialize-workspace.d.ts.map +1 -1
  343. package/lib/langium/workspace/initialize-workspace.js +13 -5
  344. package/lib/langium/workspace/initialize-workspace.js.map +1 -1
  345. package/lib/langium/workspace/langium-documents.d.ts +7 -0
  346. package/lib/langium/workspace/langium-documents.d.ts.map +1 -1
  347. package/lib/langium/workspace/langium-documents.js +18 -1
  348. package/lib/langium/workspace/langium-documents.js.map +1 -1
  349. package/lib/langium/workspace/persistent-file-system-provider.d.ts +15 -9
  350. package/lib/langium/workspace/persistent-file-system-provider.d.ts.map +1 -1
  351. package/lib/langium/workspace/persistent-file-system-provider.js +25 -13
  352. package/lib/langium/workspace/persistent-file-system-provider.js.map +1 -1
  353. package/lib/langium/workspace/self-save-registry.d.ts +84 -0
  354. package/lib/langium/workspace/self-save-registry.d.ts.map +1 -0
  355. package/lib/{documents → langium/workspace}/self-save-registry.js +33 -22
  356. package/lib/langium/workspace/self-save-registry.js.map +1 -0
  357. package/lib/langium/workspace/virtual-document.d.ts +55 -21
  358. package/lib/langium/workspace/virtual-document.d.ts.map +1 -1
  359. package/lib/langium/workspace/virtual-document.js +87 -24
  360. package/lib/langium/workspace/virtual-document.js.map +1 -1
  361. package/lib/langium/workspace/write-lock-scope.d.ts +22 -10
  362. package/lib/langium/workspace/write-lock-scope.d.ts.map +1 -1
  363. package/lib/langium/workspace/write-lock-scope.js +15 -5
  364. package/lib/langium/workspace/write-lock-scope.js.map +1 -1
  365. package/lib/launcher/integrated-server.d.ts +3 -1
  366. package/lib/launcher/integrated-server.d.ts.map +1 -1
  367. package/lib/locale/index.d.ts +10 -0
  368. package/lib/locale/index.d.ts.map +1 -0
  369. package/lib/locale/index.js +10 -0
  370. package/lib/locale/index.js.map +1 -0
  371. package/lib/locale/server-locale.d.ts +73 -0
  372. package/lib/locale/server-locale.d.ts.map +1 -0
  373. package/lib/locale/server-locale.js +61 -0
  374. package/lib/locale/server-locale.js.map +1 -0
  375. package/lib/lsp/completion/hydranium-completion-provider.d.ts +44 -2
  376. package/lib/lsp/completion/hydranium-completion-provider.d.ts.map +1 -1
  377. package/lib/lsp/completion/hydranium-completion-provider.js +68 -0
  378. package/lib/lsp/completion/hydranium-completion-provider.js.map +1 -1
  379. package/lib/lsp/connection-features.d.ts +23 -0
  380. package/lib/lsp/connection-features.d.ts.map +1 -0
  381. package/lib/lsp/connection-features.js +60 -0
  382. package/lib/lsp/connection-features.js.map +1 -0
  383. package/lib/lsp/diagnostics-connection.d.ts +27 -0
  384. package/lib/lsp/diagnostics-connection.d.ts.map +1 -0
  385. package/lib/lsp/diagnostics-connection.js +53 -0
  386. package/lib/lsp/diagnostics-connection.js.map +1 -0
  387. package/lib/lsp/hydranium-document-update-handler.d.ts +126 -82
  388. package/lib/lsp/hydranium-document-update-handler.d.ts.map +1 -1
  389. package/lib/lsp/hydranium-document-update-handler.js +235 -102
  390. package/lib/lsp/hydranium-document-update-handler.js.map +1 -1
  391. package/lib/lsp/index.d.ts +3 -1
  392. package/lib/lsp/index.d.ts.map +1 -1
  393. package/lib/lsp/index.js +3 -1
  394. package/lib/lsp/index.js.map +1 -1
  395. package/lib/lsp/lsp-latency.d.ts +39 -0
  396. package/lib/lsp/lsp-latency.d.ts.map +1 -0
  397. package/lib/lsp/lsp-latency.js +58 -0
  398. package/lib/lsp/lsp-latency.js.map +1 -0
  399. package/lib/lsp/semantic-token-provider.d.ts +34 -1
  400. package/lib/lsp/semantic-token-provider.d.ts.map +1 -1
  401. package/lib/lsp/semantic-token-provider.js +55 -8
  402. package/lib/lsp/semantic-token-provider.js.map +1 -1
  403. package/lib/lsp/shared-module.d.ts +4 -8
  404. package/lib/lsp/shared-module.d.ts.map +1 -1
  405. package/lib/lsp/shared-module.js.map +1 -1
  406. package/lib/lsp/start-language-server.d.ts +8 -7
  407. package/lib/lsp/start-language-server.d.ts.map +1 -1
  408. package/lib/lsp/start-language-server.js +13 -7
  409. package/lib/lsp/start-language-server.js.map +1 -1
  410. package/lib/messages/carriers.d.ts +18 -12
  411. package/lib/messages/carriers.d.ts.map +1 -1
  412. package/lib/messages/carriers.js +22 -13
  413. package/lib/messages/carriers.js.map +1 -1
  414. package/lib/messages/index.d.ts +4 -1
  415. package/lib/messages/index.d.ts.map +1 -1
  416. package/lib/messages/index.js +4 -1
  417. package/lib/messages/index.js.map +1 -1
  418. package/lib/messages/renderer.d.ts +142 -0
  419. package/lib/messages/renderer.d.ts.map +1 -0
  420. package/lib/messages/renderer.js +165 -0
  421. package/lib/messages/renderer.js.map +1 -0
  422. package/lib/node/event-loop-monitor.d.ts.map +1 -1
  423. package/lib/node/event-loop-monitor.js +2 -1
  424. package/lib/node/event-loop-monitor.js.map +1 -1
  425. package/lib/node/heap-ceiling.d.ts +61 -0
  426. package/lib/node/heap-ceiling.d.ts.map +1 -0
  427. package/lib/node/heap-ceiling.js +72 -0
  428. package/lib/node/heap-ceiling.js.map +1 -0
  429. package/lib/node/index.d.ts +1 -1
  430. package/lib/node/index.d.ts.map +1 -1
  431. package/lib/node/index.js +5 -1
  432. package/lib/node/index.js.map +1 -1
  433. package/lib/node/latency-from-env.d.ts +1 -1
  434. package/lib/node/latency-from-env.js +1 -1
  435. package/lib/node/lint-grammar.js.map +1 -1
  436. package/lib/node/log-preamble-node.d.ts +5 -3
  437. package/lib/node/log-preamble-node.d.ts.map +1 -1
  438. package/lib/node/log-preamble-node.js +13 -10
  439. package/lib/node/log-preamble-node.js.map +1 -1
  440. package/lib/node/measure-memory.d.ts.map +1 -1
  441. package/lib/node/measure-memory.js +5 -4
  442. package/lib/node/measure-memory.js.map +1 -1
  443. package/lib/node/memory-monitor.d.ts +2 -2
  444. package/lib/node/memory-monitor.d.ts.map +1 -1
  445. package/lib/node/memory-monitor.js +9 -10
  446. package/lib/node/memory-monitor.js.map +1 -1
  447. package/lib/node/node-file-system-provider.d.ts +67 -9
  448. package/lib/node/node-file-system-provider.d.ts.map +1 -1
  449. package/lib/node/node-file-system-provider.js +198 -53
  450. package/lib/node/node-file-system-provider.js.map +1 -1
  451. package/lib/node/profile-capture.d.ts +12 -4
  452. package/lib/node/profile-capture.d.ts.map +1 -1
  453. package/lib/node/profile-capture.js +8 -6
  454. package/lib/node/profile-capture.js.map +1 -1
  455. package/lib/node/profile-digest.js.map +1 -1
  456. package/lib/node/profiling-run.d.ts +13 -3
  457. package/lib/node/profiling-run.d.ts.map +1 -1
  458. package/lib/node/profiling-run.js +17 -8
  459. package/lib/node/profiling-run.js.map +1 -1
  460. package/lib/node/rename-over-open-readers.d.ts +61 -0
  461. package/lib/node/rename-over-open-readers.d.ts.map +1 -0
  462. package/lib/node/rename-over-open-readers.js +80 -0
  463. package/lib/node/rename-over-open-readers.js.map +1 -0
  464. package/lib/node/server-diagnostics.js +1 -1
  465. package/lib/node/server-diagnostics.js.map +1 -1
  466. package/lib/node/server-state-snapshot.js +4 -4
  467. package/lib/node/server-state-snapshot.js.map +1 -1
  468. package/lib/node/socket-launcher.d.ts +20 -4
  469. package/lib/node/socket-launcher.d.ts.map +1 -1
  470. package/lib/node/socket-launcher.js +8 -7
  471. package/lib/node/socket-launcher.js.map +1 -1
  472. package/lib/node/startup-cpu-profile.d.ts +29 -0
  473. package/lib/node/startup-cpu-profile.d.ts.map +1 -0
  474. package/lib/node/startup-cpu-profile.js +91 -0
  475. package/lib/node/startup-cpu-profile.js.map +1 -0
  476. package/lib/node/stdio-launcher.d.ts +10 -10
  477. package/lib/node/stdio-launcher.d.ts.map +1 -1
  478. package/lib/node/stdio-launcher.js +17 -9
  479. package/lib/node/stdio-launcher.js.map +1 -1
  480. package/lib/testing/document-uri-policy-conformance.js +1 -1
  481. package/lib/testing/document-uri-policy-conformance.js.map +1 -1
  482. package/lib/testing/fake-description.js.map +1 -1
  483. package/lib/testing/fake-document.d.ts +16 -4
  484. package/lib/testing/fake-document.d.ts.map +1 -1
  485. package/lib/testing/fake-document.js +18 -3
  486. package/lib/testing/fake-document.js.map +1 -1
  487. package/lib/testing/index.d.ts +1 -1
  488. package/lib/testing/index.d.ts.map +1 -1
  489. package/lib/testing/index.js +2 -1
  490. package/lib/testing/index.js.map +1 -1
  491. package/lib/testing/langium-test-helpers.d.ts.map +1 -1
  492. package/lib/testing/langium-test-helpers.js +1 -0
  493. package/lib/testing/langium-test-helpers.js.map +1 -1
  494. package/lib/testing/make-noop-language-services.js.map +1 -1
  495. package/lib/testing/make-noop-shared-services.d.ts +14 -0
  496. package/lib/testing/make-noop-shared-services.d.ts.map +1 -1
  497. package/lib/testing/make-noop-shared-services.js +28 -2
  498. package/lib/testing/make-noop-shared-services.js.map +1 -1
  499. package/lib/testing/make-test-services.d.ts +72 -14
  500. package/lib/testing/make-test-services.d.ts.map +1 -1
  501. package/lib/testing/make-test-services.js +42 -10
  502. package/lib/testing/make-test-services.js.map +1 -1
  503. package/lib/testing/make-test-tracer.d.ts +12 -0
  504. package/lib/testing/make-test-tracer.d.ts.map +1 -1
  505. package/lib/testing/make-test-tracer.js +13 -0
  506. package/lib/testing/make-test-tracer.js.map +1 -1
  507. package/lib/testing/node/applied-edit-capture.d.ts +29 -0
  508. package/lib/testing/node/applied-edit-capture.d.ts.map +1 -0
  509. package/lib/testing/node/applied-edit-capture.js +117 -0
  510. package/lib/testing/node/applied-edit-capture.js.map +1 -0
  511. package/lib/testing/node/golden-corpus.js.map +1 -1
  512. package/lib/testing/node/index.d.ts +1 -0
  513. package/lib/testing/node/index.d.ts.map +1 -1
  514. package/lib/testing/node/index.js +1 -0
  515. package/lib/testing/node/index.js.map +1 -1
  516. package/lib/testing/node/lsp-harness.d.ts.map +1 -1
  517. package/lib/testing/node/lsp-harness.js +2 -0
  518. package/lib/testing/node/lsp-harness.js.map +1 -1
  519. package/lib/testing/node/lsp-server-connection.d.ts +21 -6
  520. package/lib/testing/node/lsp-server-connection.d.ts.map +1 -1
  521. package/lib/testing/node/lsp-server-connection.js +49 -106
  522. package/lib/testing/node/lsp-server-connection.js.map +1 -1
  523. package/lib/testing/node/scratch-workspace.d.ts.map +1 -1
  524. package/lib/testing/node/scratch-workspace.js +10 -5
  525. package/lib/testing/node/scratch-workspace.js.map +1 -1
  526. package/lib/testing/node/spawned-server.d.ts +30 -1
  527. package/lib/testing/node/spawned-server.d.ts.map +1 -1
  528. package/lib/testing/node/spawned-server.js +39 -2
  529. package/lib/testing/node/spawned-server.js.map +1 -1
  530. package/lib/testing/node/unhandled-rejections.d.ts +20 -0
  531. package/lib/testing/node/unhandled-rejections.d.ts.map +1 -0
  532. package/lib/testing/node/unhandled-rejections.js +32 -0
  533. package/lib/testing/node/unhandled-rejections.js.map +1 -0
  534. package/lib/testing/playwright/browser-capture-bridge.js.map +1 -1
  535. package/lib/testing/playwright/e2e-profiling.js.map +1 -1
  536. package/lib/testing/playwright/flaky-network-proxy.d.ts +76 -0
  537. package/lib/testing/playwright/flaky-network-proxy.d.ts.map +1 -0
  538. package/lib/testing/playwright/flaky-network-proxy.js +164 -0
  539. package/lib/testing/playwright/flaky-network-proxy.js.map +1 -0
  540. package/lib/testing/playwright/index.d.ts +1 -0
  541. package/lib/testing/playwright/index.d.ts.map +1 -1
  542. package/lib/testing/playwright/index.js +1 -0
  543. package/lib/testing/playwright/index.js.map +1 -1
  544. package/lib/testing/playwright/server-log-capture.d.ts +46 -16
  545. package/lib/testing/playwright/server-log-capture.d.ts.map +1 -1
  546. package/lib/testing/playwright/server-log-capture.js +111 -40
  547. package/lib/testing/playwright/server-log-capture.js.map +1 -1
  548. package/lib/testing/playwright/server-log-fixture.d.ts +16 -0
  549. package/lib/testing/playwright/server-log-fixture.d.ts.map +1 -1
  550. package/lib/testing/playwright/server-log-fixture.js +25 -6
  551. package/lib/testing/playwright/server-log-fixture.js.map +1 -1
  552. package/lib/testing/playwright/server-log-region.d.ts +15 -0
  553. package/lib/testing/playwright/server-log-region.d.ts.map +1 -0
  554. package/lib/testing/playwright/server-log-region.js +30 -0
  555. package/lib/testing/playwright/server-log-region.js.map +1 -0
  556. package/lib/testing/playwright/server-log-rename-reporter.d.ts.map +1 -1
  557. package/lib/testing/playwright/server-log-rename-reporter.js +4 -3
  558. package/lib/testing/playwright/server-log-rename-reporter.js.map +1 -1
  559. package/lib/testing/run-update-pipeline.d.ts +8 -5
  560. package/lib/testing/run-update-pipeline.d.ts.map +1 -1
  561. package/lib/testing/run-update-pipeline.js.map +1 -1
  562. package/lib/testing/stub-ast-document-manager.d.ts +11 -52
  563. package/lib/testing/stub-ast-document-manager.d.ts.map +1 -1
  564. package/lib/testing/stub-ast-document-manager.js +31 -62
  565. package/lib/testing/stub-ast-document-manager.js.map +1 -1
  566. package/lib/testing/stub-document-builder.d.ts +33 -11
  567. package/lib/testing/stub-document-builder.d.ts.map +1 -1
  568. package/lib/testing/stub-document-builder.js +103 -5
  569. package/lib/testing/stub-document-builder.js.map +1 -1
  570. package/lib/testing/stub-hydranium-text-documents.d.ts +33 -10
  571. package/lib/testing/stub-hydranium-text-documents.d.ts.map +1 -1
  572. package/lib/testing/stub-hydranium-text-documents.js +132 -16
  573. package/lib/testing/stub-hydranium-text-documents.js.map +1 -1
  574. package/lib/testing/stub-index-manager.js.map +1 -1
  575. package/lib/testing/stub-langium-documents.d.ts +3 -2
  576. package/lib/testing/stub-langium-documents.d.ts.map +1 -1
  577. package/lib/testing/stub-langium-documents.js.map +1 -1
  578. package/lib/testing/stub-model-service.d.ts +9 -8
  579. package/lib/testing/stub-model-service.d.ts.map +1 -1
  580. package/lib/testing/stub-model-service.js +6 -6
  581. package/lib/testing/stub-model-service.js.map +1 -1
  582. package/lib/testing/stub-project-manager.js.map +1 -1
  583. package/lib/testing/stub-self-save-registry.d.ts +1 -1
  584. package/lib/testing/stub-self-save-registry.d.ts.map +1 -1
  585. package/lib/testing/stub-service-registry.d.ts +1 -1
  586. package/lib/testing/stub-service-registry.js.map +1 -1
  587. package/lib/testing/stub-writable-file-system.d.ts +1 -1
  588. package/lib/testing/stub-writable-file-system.d.ts.map +1 -1
  589. package/lib/testing/stub-writable-file-system.js +2 -1
  590. package/lib/testing/stub-writable-file-system.js.map +1 -1
  591. package/lib/util/connection-liveness.d.ts +19 -6
  592. package/lib/util/connection-liveness.d.ts.map +1 -1
  593. package/lib/util/connection-liveness.js +61 -15
  594. package/lib/util/connection-liveness.js.map +1 -1
  595. package/lib/util/environment.d.ts.map +1 -1
  596. package/lib/util/environment.js.map +1 -1
  597. package/lib/util/registry.d.ts.map +1 -1
  598. package/package.json +38 -57
  599. package/src/browser/host-heads-in-worker.ts +142 -0
  600. package/src/browser/index.ts +17 -0
  601. package/src/browser/indexeddb-file-system-store.ts +192 -0
  602. package/src/browser/start-language-server-in-worker.ts +51 -0
  603. package/src/documents/ast-document-manager.ts +467 -233
  604. package/src/documents/client-ids.ts +5 -22
  605. package/src/documents/client-session-errors.ts +24 -0
  606. package/src/documents/client-session-registry.ts +262 -0
  607. package/src/documents/dirty-state-tracker.ts +167 -0
  608. package/src/documents/document-release-handler.ts +404 -0
  609. package/src/documents/document-release-scheduler.ts +121 -0
  610. package/src/documents/file-system-task-queue.ts +74 -0
  611. package/src/documents/hydranium-text-documents.ts +976 -595
  612. package/src/documents/index.ts +10 -2
  613. package/src/documents/language-client-shadow.ts +452 -0
  614. package/src/documents/model-ledger.ts +66 -0
  615. package/src/documents/text-ledger.ts +112 -0
  616. package/src/documents/version-sync-service.ts +275 -0
  617. package/src/index.ts +8 -0
  618. package/src/langium/ast-extension/ast-extension-service.ts +77 -41
  619. package/src/langium/ast-extension/ast-node-builder.ts +66 -22
  620. package/src/langium/bootstrap.ts +95 -52
  621. package/src/langium/build-phase-pass/build-phase-pass-service.ts +29 -19
  622. package/src/langium/build-phase-pass/build-phase-pass.ts +37 -8
  623. package/src/langium/composite-ast-reflection.ts +112 -0
  624. package/src/langium/config/configuration-provider.ts +119 -0
  625. package/src/langium/config/index.ts +1 -0
  626. package/src/langium/diagnostics/hydranium-langium-profiler.ts +15 -39
  627. package/src/langium/diagnostics/log-preamble.ts +1 -1
  628. package/src/langium/diagnostics/logger.ts +38 -11
  629. package/src/langium/diagnostics/lsp-logger.ts +61 -16
  630. package/src/langium/document-builder/build-pipeline-integration.ts +46 -32
  631. package/src/langium/document-builder/build-session.ts +4 -3
  632. package/src/langium/document-builder/document-builder.ts +616 -73
  633. package/src/langium/integration-services.ts +59 -28
  634. package/src/langium/integrity/integrity-rule.ts +16 -8
  635. package/src/langium/integrity/integrity-service.ts +296 -69
  636. package/src/langium/keys/containment.ts +87 -0
  637. package/src/langium/keys/index.ts +1 -0
  638. package/src/langium/keys/name-based-key-provider.ts +4 -0
  639. package/src/langium/language-module.ts +49 -8
  640. package/src/langium/model-service/client-session.ts +704 -0
  641. package/src/langium/model-service/index.ts +2 -0
  642. package/src/langium/model-service/model-events.ts +80 -0
  643. package/src/langium/model-service/model-service.ts +908 -485
  644. package/src/langium/module.ts +212 -67
  645. package/src/langium/naming/name-provider.ts +44 -8
  646. package/src/langium/naming/name-separator-validation.ts +25 -3
  647. package/src/langium/project/abstract-project-manager.ts +13 -5
  648. package/src/langium/project/project-change-event.ts +2 -2
  649. package/src/langium/residency/cst-residency-service.ts +51 -17
  650. package/src/langium/scope/fallback-scope.ts +38 -0
  651. package/src/langium/scope/hydranium-scope-computation.ts +45 -44
  652. package/src/langium/scope/hydranium-scope-provider.ts +64 -27
  653. package/src/langium/scope/index.ts +1 -0
  654. package/src/langium/scope/reference-candidate-provider.ts +6 -5
  655. package/src/langium/scope/scope-extension-service.ts +74 -59
  656. package/src/langium/scope/scoped-ast-node-description.ts +1 -3
  657. package/src/langium/serialization/abstract-serializer.ts +57 -41
  658. package/src/langium/serialization/json-serializer.ts +14 -3
  659. package/src/langium/serialization/serializer.ts +1 -1
  660. package/src/langium/serialization/yaml-serializer.ts +4 -0
  661. package/src/langium/service-registry.ts +41 -2
  662. package/src/langium/shared-services.ts +26 -6
  663. package/src/langium/single-langium-copy.ts +42 -0
  664. package/src/langium/transfer/transfer-encoder.ts +102 -45
  665. package/src/langium/trivia/comment-preserver.ts +1100 -0
  666. package/src/langium/trivia/document-ending-preserver.ts +71 -0
  667. package/src/langium/trivia/index.ts +14 -0
  668. package/src/langium/trivia/trivia-contribution.ts +39 -0
  669. package/src/langium/trivia/trivia-preserver.ts +56 -0
  670. package/src/langium/trivia/trivia-service.ts +99 -0
  671. package/src/langium/update-rewrite/update-rewrite-service.ts +1 -1
  672. package/src/langium/update-rewrite/update-rewrite.ts +1 -1
  673. package/src/langium/validation/document-validator.ts +528 -13
  674. package/src/langium/validation/validation-contribution-collector.ts +10 -1
  675. package/src/langium/workspace/document-uri-policy.ts +32 -18
  676. package/src/langium/workspace/file-not-found.ts +35 -0
  677. package/src/langium/workspace/file-system-provider.ts +253 -16
  678. package/src/langium/workspace/hydranium-langium-document-factory.ts +83 -0
  679. package/src/langium/workspace/hydranium-workspace-lock.ts +86 -2
  680. package/src/langium/workspace/hydranium-workspace-manager.ts +241 -35
  681. package/src/langium/workspace/in-memory-file-system-provider.ts +54 -23
  682. package/src/langium/workspace/index.ts +1 -0
  683. package/src/langium/workspace/initialize-workspace.ts +43 -5
  684. package/src/langium/workspace/langium-documents.ts +19 -1
  685. package/src/langium/workspace/persistent-file-system-provider.ts +26 -14
  686. package/src/langium/workspace/self-save-registry.ts +118 -0
  687. package/src/langium/workspace/virtual-document.ts +106 -25
  688. package/src/langium/workspace/write-lock-scope.ts +27 -12
  689. package/src/launcher/integrated-server.ts +3 -1
  690. package/src/locale/index.ts +10 -0
  691. package/src/locale/server-locale.ts +86 -0
  692. package/src/lsp/completion/hydranium-completion-provider.ts +82 -2
  693. package/src/lsp/connection-features.ts +67 -0
  694. package/src/lsp/diagnostics-connection.ts +56 -0
  695. package/src/lsp/hydranium-document-update-handler.ts +285 -111
  696. package/src/lsp/index.ts +3 -1
  697. package/src/lsp/lsp-latency.ts +62 -0
  698. package/src/lsp/semantic-token-provider.ts +74 -7
  699. package/src/lsp/shared-module.ts +4 -8
  700. package/src/lsp/start-language-server.ts +13 -7
  701. package/src/messages/carriers.ts +23 -15
  702. package/src/messages/index.ts +13 -1
  703. package/src/messages/renderer.ts +212 -0
  704. package/src/node/event-loop-monitor.ts +2 -1
  705. package/src/node/heap-ceiling.ts +108 -0
  706. package/src/node/index.ts +5 -1
  707. package/src/node/latency-from-env.ts +1 -1
  708. package/src/node/log-preamble-node.ts +20 -10
  709. package/src/node/measure-memory.ts +5 -4
  710. package/src/node/memory-monitor.ts +10 -10
  711. package/src/node/node-file-system-provider.ts +214 -57
  712. package/src/node/profile-capture.ts +16 -15
  713. package/src/node/profiling-run.ts +30 -8
  714. package/src/node/rename-over-open-readers.ts +94 -0
  715. package/src/node/server-diagnostics.ts +1 -1
  716. package/src/node/server-state-snapshot.ts +5 -5
  717. package/src/node/socket-launcher.ts +27 -11
  718. package/src/node/startup-cpu-profile.ts +94 -0
  719. package/src/node/stdio-launcher.ts +22 -14
  720. package/src/testing/document-uri-policy-conformance.ts +1 -1
  721. package/src/testing/fake-document.ts +24 -5
  722. package/src/testing/index.ts +2 -1
  723. package/src/testing/langium-test-helpers.ts +1 -0
  724. package/src/testing/make-noop-shared-services.ts +50 -2
  725. package/src/testing/make-test-services.ts +125 -31
  726. package/src/testing/make-test-tracer.ts +26 -0
  727. package/src/testing/node/applied-edit-capture.ts +141 -0
  728. package/src/testing/node/index.ts +1 -0
  729. package/src/testing/node/lsp-harness.ts +2 -0
  730. package/src/testing/node/lsp-server-connection.ts +83 -119
  731. package/src/testing/node/scratch-workspace.ts +10 -5
  732. package/src/testing/node/spawned-server.ts +57 -3
  733. package/src/testing/node/unhandled-rejections.ts +31 -0
  734. package/src/testing/parse-semantic-root.ts +1 -1
  735. package/src/testing/playwright/flaky-network-proxy.ts +240 -0
  736. package/src/testing/playwright/index.ts +1 -0
  737. package/src/testing/playwright/server-log-capture.ts +137 -47
  738. package/src/testing/playwright/server-log-fixture.ts +46 -6
  739. package/src/testing/playwright/server-log-region.ts +32 -0
  740. package/src/testing/playwright/server-log-rename-reporter.ts +4 -3
  741. package/src/testing/run-update-pipeline.ts +8 -5
  742. package/src/testing/stub-ast-document-manager.ts +47 -128
  743. package/src/testing/stub-document-builder.ts +133 -18
  744. package/src/testing/stub-hydranium-text-documents.ts +184 -27
  745. package/src/testing/stub-langium-documents.ts +3 -2
  746. package/src/testing/stub-model-service.ts +11 -10
  747. package/src/testing/stub-self-save-registry.ts +1 -1
  748. package/src/testing/stub-service-registry.ts +1 -1
  749. package/src/testing/stub-writable-file-system.ts +3 -2
  750. package/src/util/connection-liveness.ts +67 -15
  751. package/src/util/environment.ts +9 -1
  752. package/lib/documents/language-client-text-shadow.d.ts +0 -101
  753. package/lib/documents/language-client-text-shadow.d.ts.map +0 -1
  754. package/lib/documents/language-client-text-shadow.js +0 -156
  755. package/lib/documents/language-client-text-shadow.js.map +0 -1
  756. package/lib/documents/self-save-registry.d.ts +0 -55
  757. package/lib/documents/self-save-registry.d.ts.map +0 -1
  758. package/lib/documents/self-save-registry.js.map +0 -1
  759. package/lib/lsp/instrument-connection.d.ts +0 -36
  760. package/lib/lsp/instrument-connection.d.ts.map +0 -1
  761. package/lib/lsp/instrument-connection.js +0 -62
  762. package/lib/lsp/instrument-connection.js.map +0 -1
  763. package/lib/node/process-memory.d.ts +0 -66
  764. package/lib/node/process-memory.d.ts.map +0 -1
  765. package/lib/node/process-memory.js +0 -252
  766. package/lib/node/process-memory.js.map +0 -1
  767. package/src/documents/language-client-text-shadow.ts +0 -175
  768. package/src/documents/self-save-registry.ts +0 -81
  769. package/src/lsp/instrument-connection.ts +0 -66
  770. package/src/node/process-memory.ts +0 -299
@@ -9,42 +9,74 @@
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
+ randomUuid,
17
+ TIMED_OUT,
19
18
  type TransferElement,
20
- type OpenModelArgs,
19
+ type TextVersion,
21
20
  type Tracer,
22
- type TransferSaveArgs,
23
- type TransferUpdateArgs
21
+ UNRECORDED_VERSION,
22
+ describeErrorWithStack
24
23
  } from '@hydranium/protocol';
25
- import { type AstNode, DocumentState, type LangiumDocument, UriUtils, type URI } from '@hydranium/langium';
24
+ import {
25
+ type AstNode,
26
+ DocumentState,
27
+ type LangiumDocument,
28
+ OperationCancelled,
29
+ isOperationCancelled,
30
+ UriUtils,
31
+ type URI
32
+ } from '@hydranium/langium';
33
+ import { type AstDiagnostic } from '../validation/document-validator.js';
26
34
  import { type DocumentUriPolicy } from '../workspace/document-uri-policy.js';
27
- import { ReentrantWriteLockError, isInsideWriteLock } from '../workspace/write-lock-scope.js';
28
- import { type CancellationToken, type Disposable } from 'vscode-languageserver';
29
- import { AstDocument, type AstDocumentSavedEvent, type AstDocumentUpdatedEvent } from '../../documents/ast-document-manager.js';
30
- import { isConnectionGoneError } from '../../util/connection-liveness.js';
35
+ import { ReentrantWriteLockError, isInsideWriteLock, isWriteLockScopeInstalled } from '../workspace/write-lock-scope.js';
36
+ import { type ApplyWorkspaceEditResult, CancellationToken, Disposable } from 'vscode-languageserver';
37
+ import { AstDocument } from '../../documents/ast-document-manager.js';
38
+ import { isClientGoneError } from '../../util/connection-liveness.js';
31
39
  import { type LogNameOptions } from '../diagnostics/logger.js';
32
40
  import { IntegrityService } from '../integrity/integrity-service.js';
33
41
  import { labelPhaseListener } from '../document-builder/labeled-phase-listener.js';
34
42
  import { LANGUAGE_CLIENT_ID } from '../../documents/client-ids.js';
43
+ import { type OpenOptions } from '../../documents/client-session-registry.js';
35
44
  import { type ServerSharedServices } from '../module.js';
45
+ import { type ClientSession } from './client-session.js';
46
+ import {
47
+ type ModelDeletedEvent,
48
+ type ModelDirtyChangedEvent,
49
+ type ModelEventFilter,
50
+ type ModelPhaseFilter,
51
+ type ModelReleasedEvent,
52
+ type ModelSavedEvent,
53
+ type ModelsBuiltEvent,
54
+ type ModelUpdatedEvent
55
+ } from './model-events.js';
36
56
 
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;
57
+ /**
58
+ * The undo-stack entry for a server-authored write pushed to the editor.
59
+ *
60
+ * **A user-facing LABEL, not a log string**, which is easy to miss because it
61
+ * travels as an options field rather than as a message: LSP specifies
62
+ * `ApplyWorkspaceEditParams.label` as "presented in the user interface for
63
+ * example on an undo stack to undo the workspace edit". So a user who edits
64
+ * through a form or drags a diagram node reads this in their editor's undo menu
65
+ * — which is why it is rendered like any other message the server sends rather
66
+ * than left as the English literal it was.
67
+ *
68
+ * Parameterless deliberately. The obvious improvement is to name the document,
69
+ * and it is the wrong one: an undo menu is already grouped under the file, so
70
+ * the URI would be noise in the one place it is redundant.
71
+ */
72
+ export const MODEL_UPDATE_EDIT = defineMessage('hydranium/core/model-update-edit', 'Update Model');
39
73
 
40
74
  /**
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.
75
+ * Max time {@link ModelService.settleLanguageClient} waits. A save answers up to
76
+ * this long after its persist, so a client timing out one save's answer must
77
+ * allow it plus the persist.
46
78
  */
47
- class SaveSettleTimeoutError extends Error {}
79
+ const LANGUAGE_CLIENT_SETTLE_TIMEOUT_MS = 10_000;
48
80
 
49
81
  /**
50
82
  * Constructor options for {@link ModelService}. All fields are optional,
@@ -52,75 +84,66 @@ class SaveSettleTimeoutError extends Error {}
52
84
  */
53
85
  export interface ModelServiceOptions extends LogNameOptions {
54
86
  /**
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`.
87
+ * Let the facade's build run without the workspace write lock when its
88
+ * caller already holds it: an integrity rule or build-phase pass that
89
+ * writes back through a session's `update` / `save`, or calls `rebuild`.
90
+ * Default `false`.
81
91
  *
82
- * **Why it defaults on.** Unlocked, the facade's build races the LSP bridge's
83
- * build of the same URI — both are legitimate (the bridge exists only under a
84
- * `Connection`, so the facade stands in for it headless), but nothing
85
- * serialises them, so both run a full validation pass and Langium appends the
86
- * 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.
92
+ * `WorkspaceLock` is not reentrant. Taking it from inside a holder cancels
93
+ * that holder and then waits for it to end, while the holder waits for this
94
+ * call, so neither completes. On `false` that call fails with
95
+ * {@link ReentrantWriteLockError} instead, wherever a host installs a
96
+ * write-lock scope tracker (`@hydranium/core/node` does at entry load); on
97
+ * `true` its build takes no lock. The wait after that build can still hang,
98
+ * because a document no build will carry is re-queued through the lock, and
99
+ * the re-queue waits for the holder to end.
89
100
  *
90
- * **What `false` costs.** The facade's build is then unserialised and can run
91
- * concurrently with the bridge's build of the same URI, so the affected
92
- * documents are validated twice per write — double the validation work.
93
- * Reported diagnostics stay correct even then, because
94
- * `HydraniumDocumentBuilder.dedupeDiagnostics` collapses the byte-identical
95
- * duplicates a repeated pass produces before any listener sees them; what this
96
- * option removes is the wasted pass, not just its visible symptom.
101
+ * A session's delete is refused that way on either value, since its builds
102
+ * always take the lock.
97
103
  *
98
- * **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
102
- * acquisition then waits for that holder to release while the holder waits
103
- * for this call. On `true` that shape is DETECTED and rejected with
104
- * {@link ReentrantWriteLockError} rather than hanging, wherever a host
105
- * installs a write-lock scope tracker (`@hydranium/core/node` does at entry
106
- * 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.
104
+ * Every other facade build takes the lock on either value. Unlocked, it can
105
+ * overlap another build of the same document: both run a full validation
106
+ * pass that Langium appends, and a caller can be handed a version that an
107
+ * integrity repair still running in the other build then moves past. Without
108
+ * a tracker the two cases cannot be told apart (see
109
+ * {@link isWriteLockScopeInstalled}), so `true` builds without the lock every
110
+ * time and accepts both.
110
111
  *
111
112
  * Accepts a {@link MaybeObservableValue} so it can be bound to a setting and
112
113
  * flipped without a restart.
113
114
  */
114
- readonly serializeBuilds?: MaybeObservableValue<boolean>;
115
+ readonly allowReentrantBuilds?: MaybeObservableValue<boolean>;
116
+ }
117
+
118
+ /** One {@link ModelService.onModelUpdated} subscription; `uri` is canonical, absent for every document. */
119
+ export interface ModelUpdateSubscriber<TAst extends AstNode, TDiagnostic extends AstDiagnostic = AstDiagnostic> {
120
+ readonly uri?: CanonicalUri;
121
+ readonly listener: (event: ModelUpdatedEvent<TAst, TDiagnostic>) => void;
122
+ }
123
+
124
+ /** Options for a {@link DefaultModelService} wait on one document. */
125
+ export interface SyncedWaitOptions {
126
+ /**
127
+ * Build a root parsed from text older than the store's at the call, and
128
+ * reject once that build, or one the builder re-queues, is given up. Without
129
+ * it, such a root is left to other builds, and a wait they never end stays
130
+ * pending until its token is cancelled.
131
+ */
132
+ readonly sync?: boolean;
115
133
  }
116
134
 
117
135
  /**
136
+ * The seam every non-LSP head talks to: the data server, the GLSP head and an
137
+ * adopter's own services reach documents through this slot rather than through
138
+ * the workspace stores.
139
+ *
118
140
  * In-process facade over the framework's document plumbing
119
141
  * (`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.
142
+ * `DocumentBuilder`, `WritableFileSystemProvider`). Owns the document
143
+ * lifecycle the data-server and GLSP heads delegate to — client sessions that
144
+ * open, update, save and close documents, the phase reads, and `ready` — so
145
+ * coordinating those primitives doesn't have to be re-implemented per head.
146
+ * Every open and write goes through a session from {@link createSession}.
124
147
  *
125
148
  * "Model" here means the parsed AST — distinct from the wire-shape
126
149
  * `TransferDocument` in `@hydranium/protocol`.
@@ -130,9 +153,9 @@ export interface ModelServiceOptions extends LogNameOptions {
130
153
  * Multiple in-process consumers want the same workspace-level
131
154
  * operations:
132
155
  * - 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.
156
+ * - The GLSP head uses the same lifecycle for diagram-driven edits: GModel
157
+ * operation handlers write through the diagram's session and wait on phases
158
+ * before reading.
136
159
  * - Server-internal callers (integrity service, ad-hoc bridges, tests)
137
160
  * want the same operations without the wire serialisation step.
138
161
  *
@@ -145,15 +168,16 @@ export interface ModelServiceOptions extends LogNameOptions {
145
168
  *
146
169
  * **Read-latest supersession**
147
170
  *
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.
171
+ * A session's default `update` and `save` use Langium's per-URI
172
+ * `DocumentBuilder.waitUntil` to wait for `Validated` (the integrity-settled
173
+ * landmark {@link IntegrityService.SettledState} when rebuilds do not
174
+ * validate), then read the post-build state. Concurrent in-process callers
175
+ * on the same URI all see the latest post-build snapshot — none deadlock
176
+ * waiting for a specific version's settled event. Adopters wanting strict
177
+ * version-matched semantics (resolve with vN's snapshot specifically, log
178
+ * "vN superseded by vM at vN+1") override
179
+ * `DefaultClientSession.updateDocument` to attach a phase-listener with
180
+ * explicit version checks; the framework default doesn't need it for safety.
157
181
  *
158
182
  * **Returns AST snapshots, not wire envelopes**
159
183
  *
@@ -166,27 +190,194 @@ export interface ModelServiceOptions extends LogNameOptions {
166
190
  * the injected `TransferEncoder` — symmetric with the
167
191
  * `getModelDocument` envelope path.
168
192
  *
169
- * **Subscriptions** ({@link onModelUpdated} / {@link onModelSaved} /
170
- * {@link onClientClosed}) are thin pass-throughs over
171
- * `DocumentBuilder.onDocumentPhase` and
172
- * `HydraniumTextDocuments.onDidSave` / `onDidClose`. Filtering
173
- * by URI happens here so consumers can subscribe per-document without
174
- * implementing the URI gate at each callsite.
193
+ * **Subscriptions** (`on*`) are how a head follows documents; it subscribes
194
+ * here rather than to the builder or the text store. Each takes a filter, and
195
+ * one without a `uri` hears every document.
196
+ *
197
+ * **Two families.** `waitFor*` only waits: it rejects for a URI with no
198
+ * document, and for a root behind the store's text it waits for whatever
199
+ * builds it next, so it never ends if nothing does. `ensureDocumentState` and
200
+ * the phase shorthands over it build a missing document, and build a root
201
+ * behind its text, rejecting when that build fails twice. Both re-queue a
202
+ * document the builder's last build left short of the state.
203
+ *
204
+ * Both resolve at the state with a root parsed from text no older than the
205
+ * store's version at the call; inside the write lock, at the state alone, since
206
+ * the build that would sync the document to that version cannot start until
207
+ * it is released.
208
+ *
209
+ * Do not await one inside a build phase listener: a browser host installs no
210
+ * write-lock scope, so the wait cannot tell it is inside a build and waits for
211
+ * one that cannot start. Nor inside a `WorkspaceLock.read`: the lock starts no
212
+ * write, the build included, while a read runs.
213
+ *
214
+ * **Diagnostics are typed `never` below `Validated`.** Validation is the last
215
+ * phase, so at any earlier landmark the array either is not yet computed or
216
+ * still holds the previous build's, and reading it would take stale results
217
+ * for fresh ones. A caller that needs diagnostics asks for {@link validated}.
218
+ *
219
+ * What the `never` buys, exactly: reading a field off an element is a compile
220
+ * error, and nothing can be appended. It does NOT stop a caller assigning an
221
+ * element to a typed variable, because `never` is assignable to everything — so
222
+ * this is a guard against reaching for diagnostics by accident, not a seal
223
+ * against doing it deliberately.
224
+ *
225
+ * The waits resolve at or ABOVE their target, so an already-validated document
226
+ * does carry usable diagnostics and the `never` over-forbids there. That
227
+ * direction is the safe one: the alternative permits stale reads silently. A
228
+ * member taking a phase as a PARAMETER returns `TDiagnostic`, and leaves them
229
+ * absent for a phase below `Validated`.
175
230
  *
176
231
  * **Generic parameters.**
177
232
  * - `TAst` — the AST root type each consumer expects on the returned
178
233
  * {@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`
234
+ * - `TDiagnostic` — the AST-layer diagnostic: whatever the build left on
235
+ * `LangiumDocument.diagnostics`, carried through on the returned
236
+ * {@link AstDocument}. Defaults to {@link AstDiagnostic}.
237
+ * **Not the `TransferEncoder`'s parameter of the same name**, which is
238
+ * that encoder's OUTPUT and so names the wire shape. This one names its
239
+ * input, and an adopter binds the two to different types.
240
+ * - `TTransfer` — transfer-model root a session's `update` / `save` accept
182
241
  * args. Constrained to {@link TransferElement}. Defaults to the
183
242
  * structural base.
184
243
  */
185
- export class ModelService<
244
+ export interface ModelService<
245
+ TAst extends AstNode,
246
+ TDiagnostic extends AstDiagnostic = AstDiagnostic,
247
+ TTransfer extends TransferElement = TransferElement
248
+ > {
249
+ /**
250
+ * Resolves once the workspace has been initialised and its first build has
251
+ * completed — the gate every read should wait behind, since a document
252
+ * queried before it may be unbuilt and reach no phase.
253
+ *
254
+ * A property rather than a method, matching `ProjectManager.ready` and
255
+ * Langium's `WorkspaceManager.ready`. An implementation needing a stricter
256
+ * gate supplies a Promise that awaits its own concern as well.
257
+ */
258
+ readonly ready: Promise<void>;
259
+
260
+ // Wait only; a root behind its text is left to another build.
261
+ waitForDocumentState(uri: string, state: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
262
+ waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
263
+ waitForBuilderState(state: DocumentState, cancelToken?: CancellationToken): Promise<void>;
264
+
265
+ // Build what is missing or behind its text, then wait.
266
+ ensureDocumentState(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
267
+ rebuild(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
268
+ /**
269
+ * Throw where {@link rebuild} would reject as reentrant. A write calls it
270
+ * before applying its text: a text applied and then refused stays applied
271
+ * with no build to follow it.
272
+ */
273
+ assertCanBuild(uri: string): void;
274
+ parsed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
275
+ linked(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
276
+ settled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
277
+ indexed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>>;
278
+ validated(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
279
+
280
+ isOpen(uri: string): boolean;
281
+ /**
282
+ * The version the document at `uri` was opened at, which a client's write
283
+ * or an integrity repair steps past; `undefined` while it is not open.
284
+ */
285
+ openedVersion(uri: string): TextVersion | undefined;
286
+ snapshot(uri: string): AstDocument<TAst, TDiagnostic> | undefined;
287
+ /**
288
+ * The text a session's write of `model` to `uri` applies: a textual model
289
+ * as given, a structured one rewritten and serialised. Also the text to
290
+ * create a document with: for a `uri` with no text the trivia preservers
291
+ * still run, so it gets their defaults, such as
292
+ * `DocumentEndingPreserver.DEFAULT_ENDING`.
293
+ */
294
+ modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string>;
295
+ getDocument(uri: string): LangiumDocument | undefined;
296
+ /**
297
+ * Resolve once the document's build has settled and the language client
298
+ * has answered the push of its text, applied or refused and logged, so a
299
+ * save answering after it does not race that push. Does not wait again for
300
+ * a push an earlier settle timed out on and the client has not answered
301
+ * since. Never rejects: past its bound it warns and resolves, and a failed
302
+ * wait is logged and resolves.
303
+ */
304
+ settleLanguageClient(uri: string, cancelToken?: CancellationToken): Promise<void>;
305
+ /**
306
+ * Whether a push of the document's text into the language client awaits the
307
+ * client's answer. A push a settle already timed out on does not count: that
308
+ * settle has warned about it.
309
+ */
310
+ isLanguageClientPushPending(uri: string): boolean;
311
+
312
+ /**
313
+ * Fires as a document reaches the filter's phase, `Validated` by default.
314
+ * Listeners run inside the build, so one that throws is logged and the
315
+ * others still run.
316
+ */
317
+ onModelUpdated(listener: (event: ModelUpdatedEvent<TAst, TDiagnostic>) => void, filter?: ModelPhaseFilter): Disposable;
318
+ /**
319
+ * Fires once per build that reaches the phase, with every document it
320
+ * carried there. A listener that throws is logged, as for {@link onModelUpdated}.
321
+ */
322
+ onModelsBuilt(listener: (event: ModelsBuiltEvent) => void, filter?: Pick<ModelPhaseFilter, 'phase'>): Disposable;
323
+ /**
324
+ * Fires for every save, whichever client made it, as the store announces
325
+ * it. A document saved before its first build arrives as an empty envelope
326
+ * at `UNRECORDED_VERSION`, whose `root` is `undefined` despite its type.
327
+ */
328
+ onModelSaved(listener: (event: ModelSavedEvent<TAst, TDiagnostic>) => void, filter?: ModelEventFilter): Disposable;
329
+ /**
330
+ * Fires for every document a build removes, with the session whose
331
+ * `delete` removed it, as `AstDocumentManager.attributeDeletion` names it.
332
+ */
333
+ onModelDeleted(listener: (event: ModelDeletedEvent) => void, filter?: ModelEventFilter): Disposable;
334
+ /** Fires when a document's text starts or stops differing from its file. */
335
+ onDirtyChanged(listener: (event: ModelDirtyChangedEvent) => void, filter?: ModelEventFilter): Disposable;
336
+ /**
337
+ * Fires when the store releases a document no client has open any more.
338
+ * What the build keeps for it is up to the
339
+ * `DocumentReleaseHandler` slot; the default reverts it to disk, and that
340
+ * rebuild follows as an {@link onModelUpdated} event, unless a client opens
341
+ * the document first or its file is deleted.
342
+ */
343
+ onModelReleased(listener: (event: ModelReleasedEvent) => void, filter?: ModelEventFilter): Disposable;
344
+ /** Fires when `filter.clientId` closes `filter.uri`, its session ending included. */
345
+ onClientClosed(listener: () => void, filter: { readonly uri: string; readonly clientId: string }): Disposable;
346
+
347
+ /**
348
+ * Start a client session, the only way to open and write documents through
349
+ * this service. Pass a `label` naming the participant; without one it is
350
+ * `session`. The id defaults to `label#` plus a random UUID; a fixed
351
+ * `clientId` is taken as given. Throws `ReservedClientIdError` when the id
352
+ * is reserved by the framework, and `DuplicateClientIdError` when it is
353
+ * held by another live session or has documents open under it as a client
354
+ * that is not a session.
355
+ *
356
+ * A `resumeToken` matching the one the live session under `clientId` was
357
+ * started with ends that session as lost first, so the documents it was
358
+ * last to hold keep their unsaved text for the new one. The token guards
359
+ * against taking over a session by accident, not against a peer: anyone who
360
+ * knows it can end the session.
361
+ *
362
+ * `TOpenOptions` types the options the session's `open` takes and its
363
+ * `openOptions` returns. The narrowing is an unchecked cast, and it holds
364
+ * only for the caller that started the session: a holder reached through
365
+ * {@link getSession} sees plain `OpenOptions`.
366
+ */
367
+ createSession<TOpenOptions extends OpenOptions = OpenOptions>(
368
+ label?: string,
369
+ clientId?: string,
370
+ options?: { readonly resumeToken?: string }
371
+ ): ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions>;
372
+ /** The live session started under `clientId`, or `undefined` once it has ended or was never started. */
373
+ getSession(clientId: string): ClientSession<TAst, TDiagnostic, TTransfer> | undefined;
374
+ }
375
+
376
+ export class DefaultModelService<
186
377
  TAst extends AstNode,
187
- TDiagnostic = TransferDiagnostic,
378
+ TDiagnostic extends AstDiagnostic = AstDiagnostic,
188
379
  /**
189
- * Structured payload accepted by `update` / `save`. Constrained to
380
+ * Structured payload a session's `update` / `save` accept. Constrained to
190
381
  * {@link TransferElement} — the minimal `{ readonly $type: string }`
191
382
  * shape. Both transfer-model overlay roots (which extend
192
383
  * `TransferElement` explicitly) and AST root types (which have
@@ -195,7 +386,7 @@ export class ModelService<
195
386
  * integrity service) that pass AST roots remain compatible.
196
387
  */
197
388
  TTransfer extends TransferElement = TransferElement
198
- > {
389
+ > implements ModelService<TAst, TDiagnostic, TTransfer> {
199
390
  protected readonly tracer: Tracer;
200
391
  /**
201
392
  * The single document-identity seam (`services.workspace.DocumentUriPolicy`),
@@ -206,14 +397,8 @@ export class ModelService<
206
397
  * (see {@link DocumentUriPolicy}).
207
398
  */
208
399
  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
- /** See {@link ModelServiceOptions.serializeBuilds}. Defaults to `true`. */
216
- protected readonly serializeBuilds: ObservableValue<boolean>;
400
+ /** See {@link ModelServiceOptions.allowReentrantBuilds}. Defaults to `false`. */
401
+ protected readonly allowReentrantBuilds: ObservableValue<boolean>;
217
402
 
218
403
  /**
219
404
  * Per-URI applyEdit coalescing: at most one in-flight `applyEditToLanguageClient`
@@ -223,6 +408,30 @@ export class ModelService<
223
408
  */
224
409
  protected readonly syncChains = new Map<string, Promise<void>>();
225
410
  protected readonly pendingSync = new Map<string, string>();
411
+ /**
412
+ * The sync chains a settle timed out on, until the client answers their
413
+ * push. A later settle does not wait on one meanwhile: GLSP runs a diagram's
414
+ * saves one at a time, so each would add the full bound and a queued save
415
+ * outlast its client's timeout.
416
+ */
417
+ protected readonly timedOutSyncChains = new WeakSet<Promise<void>>();
418
+
419
+ /** The live sessions this service started, by client id, for {@link getSession}. */
420
+ protected readonly sessions = new Map<string, ClientSession<TAst, TDiagnostic, TTransfer>>();
421
+ /**
422
+ * Drops an ended session from {@link sessions}. Subscribed by the first
423
+ * {@link createSession} rather than at construction, so a services tree with
424
+ * no text store, or one that knows nothing of sessions, still constructs
425
+ * this service.
426
+ */
427
+ protected sessionCloseListener?: Disposable;
428
+ /** The token each live session was started with, by client id, for a takeover by {@link createSession}. */
429
+ protected readonly resumeTokens = new Map<string, string>();
430
+ /**
431
+ * The {@link onModelUpdated} subscribers, by phase. One builder listener per
432
+ * phase serves them all, kept for the life of the service.
433
+ */
434
+ protected readonly updateSubscribers = new Map<DocumentState, Set<ModelUpdateSubscriber<TAst, TDiagnostic>>>();
226
435
 
227
436
  /**
228
437
  * Workspace-level readiness gate. Resolves when the framework has
@@ -264,30 +473,26 @@ export class ModelService<
264
473
  ) {
265
474
  this.tracer = services.Tracer.for(options.logName ?? 'ModelService').trace('instantiated');
266
475
  this.uriPolicy = services.workspace.DocumentUriPolicy;
267
- this.slowUpdateWarn = options.slowUpdateWarnMs !== undefined ? ObservableValue.from(options.slowUpdateWarnMs) : undefined;
268
- this.serializeBuilds = ObservableValue.from(options.serializeBuilds ?? true);
476
+ this.allowReentrantBuilds = ObservableValue.from(options.allowReentrantBuilds ?? false);
269
477
  // Optional-chain so a harness that binds no WorkspaceManager awaits
270
478
  // `undefined` and resolves immediately; production hosts always have it
271
479
  // bound.
272
480
  // Deliberately NO fallback to Langium's `ready`: it resolves pre-build,
273
481
  // so falling back to it would silently reinstate the very gap this gate
274
482
  // exists to close.
275
- // Captured rather than read off `this` inside the closure, which TS cannot
276
- // prove runs after the field is assigned.
277
- const tracer = this.tracer;
278
483
  this.ready = (async () => {
279
484
  try {
280
485
  await services.workspace.WorkspaceManager?.workspaceInitialized;
281
- } catch (error: unknown) {
486
+ } catch {
282
487
  // NEVER rejects, deliberately. This gate is about TIMING — "the
283
488
  // initial build has finished" — not about whether it succeeded, and
284
- // Langium's `ready` (what it replaced) could not reject at all.
285
- // `workspaceInitialized` can: it rejects on a cancelled initial
286
- // build (routine — any write preempts one) and on a failed one
287
- // (e.g. a disposed connection at teardown). Propagating either would
288
- // fail every `waitForReady` for the rest of the process lifetime,
289
- // a far worse failure than the late gate this exists to fix.
290
- tracer.debug(`Initial workspace build did not complete cleanly: ${error instanceof Error ? error.message : String(error)}`);
489
+ // the workspace manager's `ready` (what it replaced) rejects only on
490
+ // a failed startup. `workspaceInitialized` also rejects on a
491
+ // cancelled initial build (routine — any write preempts one) and on
492
+ // a failed one (e.g. a disposed connection at teardown).
493
+ // Propagating either would fail every `waitForReady` for the rest
494
+ // of the process lifetime, a far worse failure than the late gate
495
+ // this exists to fix. The workspace manager logs the outcome.
291
496
  }
292
497
  })();
293
498
  // One persistent listener mirroring non-LSP-client changes back to the LSP
@@ -309,10 +514,12 @@ export class ModelService<
309
514
  // ============================================================
310
515
 
311
516
  /**
312
- * Wait for the document at `uri` to reach `state`. Pure wait — does
313
- * 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.
517
+ * Wait for the document at `uri` to reach `state` with a root no older than
518
+ * the store's text at the call. Rejects if `uri` is not in the document
519
+ * registry. A root behind its text is not built: the wait lasts until
520
+ * something else builds it, so use {@link ensureDocumentState} where
521
+ * nothing may. Builds that keep failing leave the wait pending, to its
522
+ * cancellation token.
316
523
  *
317
524
  * Wrapped in a debug-level timing log via {@link Tracer.time} so
318
525
  * slow per-URI waits surface in build telemetry; the URI is
@@ -326,11 +533,12 @@ export class ModelService<
326
533
  * Wait for the document at `uri` to reach the integrity-settled landmark
327
534
  * ({@link IntegrityService.SettledState}) — the earliest phase at which the
328
535
  * AST + serialised text are stable post-integrity. Convenience wrapper over
329
- * {@link waitForDocumentState} for the common "wait until content is stable"
330
- * case (e.g. settling a save). Pure wait — does not trigger a build.
536
+ * {@link waitForDocumentState}, and like it builds nothing behind its text.
331
537
  */
332
- async waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
333
- return this.waitForDocumentStateCanonical(this.uriPolicy.canonicalUri(uri), IntegrityService.SettledState, cancelToken);
538
+ async waitForDocumentSettled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
539
+ return this.withoutDiagnostics(
540
+ await this.waitForDocumentStateCanonical(this.uriPolicy.canonicalUri(uri), IntegrityService.SettledState, cancelToken)
541
+ );
334
542
  }
335
543
 
336
544
  /**
@@ -342,21 +550,120 @@ export class ModelService<
342
550
  * the identity once instead of re-running the (filesystem-touching) `realpath`
343
551
  * at every wait. The `CanonicalUri` parameter type enforces that — a raw
344
552
  * `string` cannot be passed without minting through the URI policy.
553
+ *
554
+ * With `options.sync`, a root behind the store's text is built, as in
555
+ * {@link ensureDocumentState}; without it, the root is left to other builds,
556
+ * as in {@link waitForDocumentState}. Below `Validated` the envelope has no
557
+ * diagnostics: see {@link withoutDiagnostics}.
345
558
  */
346
559
  protected async waitForDocumentStateCanonical(
347
560
  uri: CanonicalUri,
348
561
  state: DocumentState,
349
- cancelToken?: CancellationToken
562
+ cancelToken?: CancellationToken,
563
+ options: SyncedWaitOptions = {}
350
564
  ): Promise<AstDocument<TAst, TDiagnostic>> {
351
565
  const documentUri = UriUtils.toUri(uri);
566
+ // Read at call time: a later edit must not extend this wait.
567
+ const textVersion = isInsideWriteLock() ? undefined : this.services.workspace.TextDocuments.textState(uri)?.version;
352
568
  await this.tracer
353
569
  .withUri(uri)
354
570
  .time(
355
571
  `Wait for document state '${DocumentState[state]}'`,
356
- () => this.services.workspace.DocumentBuilder.waitUntil(state, documentUri, cancelToken),
572
+ () => this.waitUntilSynced(documentUri, state, textVersion, cancelToken, options),
357
573
  'debug'
358
574
  );
359
- return this.toAstDocument(documentUri);
575
+ const document = this.toAstDocument(documentUri);
576
+ return state >= DocumentState.Validated ? document : this.withoutDiagnostics(document);
577
+ }
578
+
579
+ /**
580
+ * Wait for `state` with a root parsed from text at `textVersion` or later. A
581
+ * root no factory recorded counts as synced, since no build records it.
582
+ * With `options.sync`, a root still behind is built through
583
+ * `VersionSyncService.syncTo`, and the wait rejects once that build, or one
584
+ * the builder re-queues to reach `state`, is given up. Without it, the wait
585
+ * lasts until another build parses the text, and stays pending when the
586
+ * builder gives up re-queuing the document.
587
+ */
588
+ protected async waitUntilSynced(
589
+ uri: URI,
590
+ state: DocumentState,
591
+ textVersion: TextVersion | undefined,
592
+ cancelToken?: CancellationToken,
593
+ options: SyncedWaitOptions = {}
594
+ ): Promise<void> {
595
+ const builder = this.services.workspace.DocumentBuilder;
596
+ const sync = this.services.workspace.VersionSyncService;
597
+ const waitOptions = { rejectWhenStuck: options.sync === true };
598
+ await builder.waitUntil(state, uri, cancelToken, waitOptions);
599
+ if (textVersion === undefined) {
600
+ return;
601
+ }
602
+ while (!sync.isSyncedTo(uri, textVersion)) {
603
+ const build = options.sync === true ? sync.syncTo(uri, textVersion) : undefined;
604
+ this.tracer
605
+ .withUri(uri.toString())
606
+ .debug(`waiting for ${uri.toString()} to reach ${DocumentState[state]} at v${textVersion} or later`);
607
+ await this.nextParseOrDeletion(uri, cancelToken, build);
608
+ await builder.waitUntil(state, uri, cancelToken, waitOptions);
609
+ }
610
+ }
611
+
612
+ /**
613
+ * Resolves once a parse of `uri` has been recorded or a build has deleted
614
+ * it, rejecting with `OperationCancelled` when `cancelToken` is cancelled
615
+ * first, and with an error when `build`, the build requested for it, is
616
+ * given up. A `Parsed` phase listener cannot serve: a cancel right after the
617
+ * parse skips it, and the resumed build does not parse again.
618
+ */
619
+ protected nextParseOrDeletion(uri: URI, cancelToken: CancellationToken = CancellationToken.None, build?: Promise<void>): Promise<void> {
620
+ const builder = this.services.workspace.DocumentBuilder;
621
+ return new Promise<void>((resolve, reject) => {
622
+ let ended = false;
623
+ let cancelled = false;
624
+ // Handled before any return, so a build given up after the wait ended is not an unhandled rejection.
625
+ build?.catch((error: unknown) => {
626
+ const line = `The build that would sync the root to its text failed. ${describeErrorWithStack(error)}`;
627
+ if (cancelled) {
628
+ // The waiter has gone, so nothing else reports this.
629
+ this.tracer.withUri(uri.toString()).error(line);
630
+ } else if (ended) {
631
+ // A parse or deletion came first: the waiter goes on and reports its own outcome, and the retry warned.
632
+ this.tracer.withUri(uri.toString()).debug(line);
633
+ } else {
634
+ done(() => reject(new Error(`The build that would sync ${uri.toString()} to its text failed`, { cause: error })));
635
+ }
636
+ });
637
+ // A cancelled token's listener runs a macrotask later, after a build
638
+ // that started meanwhile may have parsed.
639
+ if (cancelToken.isCancellationRequested) {
640
+ ended = true;
641
+ cancelled = true;
642
+ reject(OperationCancelled);
643
+ return;
644
+ }
645
+ const done = (settle: () => void): void => {
646
+ ended = true;
647
+ parsed.dispose();
648
+ deleted.dispose();
649
+ cancelling.dispose();
650
+ settle();
651
+ };
652
+ const parsed = this.services.workspace.VersionSyncService.onDidRecordModel(document => {
653
+ if (UriUtils.equals(document.uri, uri)) {
654
+ done(resolve);
655
+ }
656
+ });
657
+ const deleted = builder.onUpdate((_changed, deletedUris) => {
658
+ if (deletedUris.some(deletedUri => UriUtils.equals(deletedUri, uri))) {
659
+ done(resolve);
660
+ }
661
+ });
662
+ const cancelling = cancelToken.onCancellationRequested(() => {
663
+ cancelled = true;
664
+ done(() => reject(OperationCancelled));
665
+ });
666
+ });
360
667
  }
361
668
 
362
669
  /**
@@ -380,31 +687,35 @@ export class ModelService<
380
687
  * Force a fresh build of the document at `uri` and wait for it to
381
688
  * reach `state` (or the integrity-settled landmark
382
689
  * {@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.
690
+ * Always builds the document, whether or not it is already in the
691
+ * registry, in a build of its own or in one already scheduled that carries
692
+ * it — call this when you want to re-process from scratch.
386
693
  *
387
- * The facade is responsible for firing `DocumentBuilder.update`
388
- * directly because Langium's `DefaultDocumentUpdateHandler.didChangeContent`
694
+ * The facade is responsible for requesting the build itself because Langium's `DefaultDocumentUpdateHandler.didChangeContent`
389
695
  * (the standard text-document → builder bridge) only runs under an
390
696
  * LSP `Connection`. Running headless the bridge never fires; the
391
697
  * facade stands in for it on its own update path.
392
698
  *
393
699
  * 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
401
- * diagnostic. Opt out via
402
- * {@link ModelServiceOptions.serializeBuilds} — see there for the
403
- * non-reentrancy hazard that is the reason the opt-out exists.
700
+ * fine: the LSP head builds from the LSP-driven event and the facade from
701
+ * its own RPC-driven event — both legitimate — and both go through
702
+ * `HydraniumDocumentBuilder.scheduleUpdate`, which serialises them under
703
+ * the workspace WRITE lock and lets the second share the first's build
704
+ * where that build carries it. Langium alone does not coalesce concurrent
705
+ * builds of one URI: two unserialised builds each run a full validation
706
+ * pass and Langium appends the second set onto the first, duplicating every
707
+ * diagnostic. A caller that already holds the lock builds without it only
708
+ * under {@link ModelServiceOptions.allowReentrantBuilds} — see there for the
709
+ * non-reentrancy hazard.
404
710
  *
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.
711
+ * An override calls the base before it awaits. Under an LSP connection the
712
+ * store's change event has already asked the update handler to build a
713
+ * session's write; an override whose await outlasts that build makes the
714
+ * base's request start a build of its own, so the write is built and
715
+ * delivered twice.
716
+ *
717
+ * Rejects when the build leaves no document for `uri`, as for a URI with
718
+ * neither a file nor text: the wait after it has nothing to wait on.
408
719
  *
409
720
  * Consumers wanting "give me this doc at state X, building only if
410
721
  * needed" — use the per-state methods ({@link parsed} / {@link linked}
@@ -416,8 +727,8 @@ export class ModelService<
416
727
 
417
728
  /**
418
729
  * 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
730
+ * URI — the build counterpart to {@link waitForDocumentStateCanonical}.
731
+ * Requests the build, then waits via the canonical wait core, so the
421
732
  * identity is resolved once at the public door and neither sink re-runs the
422
733
  * `realpath`. (`DocumentBuilder.update` still resolves each URI internally for
423
734
  * directory flattening — that is the build's own existence-aware resolution,
@@ -429,66 +740,61 @@ export class ModelService<
429
740
  cancelToken?: CancellationToken
430
741
  ): Promise<AstDocument<TAst, TDiagnostic>> {
431
742
  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(...))`.
743
+ // Runs under the workspace WRITE lock, through the builder's
744
+ // `scheduleUpdate` like the LSP update handler's build, so the build the
745
+ // store's change event already scheduled for this write carries this
746
+ // request too rather than being cancelled by it.
435
747
  //
436
748
  // Unlocked, this build races the LSP bridge's build of the same URI: both
437
749
  // 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
750
+ // facade stands in for it headless), and nothing serialises the two, so
751
+ // both reach `Validated`, and because each computes its missing
441
752
  // validation categories before the other has recorded its own, both run a
442
753
  // FULL pass and Langium appends the second onto the first (its append is
443
754
  // meant for category-partitioned passes). The user-visible result is every
444
755
  // diagnostic duplicated, plus double the validation work per write.
445
756
  //
446
- // Opt out via `ModelServiceOptions.serializeBuilds` — see there for
447
- // the non-reentrancy hazard that opt-out exists for.
448
- if (this.serializeBuilds.value) {
449
- // Fail loudly on the one shape the lock cannot survive. `WorkspaceLock`
450
- // is not reentrant: acquiring the write lock cancels the running holder,
451
- // so a caller already inside one — an integrity rule or build-phase pass
452
- // writing back through this facade — would cancel its own enclosing
453
- // build and then likely stall in the phase wait below. The check is
454
- // 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.
457
- // Detection needs async-context propagation, so it is inert until a host
458
- // installs a tracker (`@hydranium/core/node` does) — see
459
- // `isInsideWriteLock`.
460
- if (isInsideWriteLock()) {
461
- throw new ReentrantWriteLockError(uri);
462
- }
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
- );
470
- } else {
757
+ // A caller already inside the lock would cancel its own build and stall in
758
+ // the wait below; `allowReentrantBuilds` builds it unlocked, and without a
759
+ // tracker it cannot be told apart from any other caller.
760
+ if (this.allowReentrantBuilds.value && (isInsideWriteLock() || !isWriteLockScopeInstalled())) {
471
761
  await this.services.workspace.DocumentBuilder.update([documentUri], [], cancelToken);
762
+ } else {
763
+ this.assertCanBuild(uri);
764
+ // The build runs on the lock's own token, which a later write cancels;
765
+ // the caller's token governs only the phase wait below.
766
+ await this.services.workspace.DocumentBuilder.scheduleUpdate([documentUri], []);
767
+ }
768
+ return this.waitForDocumentStateCanonical(uri, state ?? IntegrityService.SettledState, cancelToken, { sync: true });
769
+ }
770
+
771
+ assertCanBuild(uri: string): void {
772
+ if (isInsideWriteLock() && !this.allowReentrantBuilds.value) {
773
+ throw new ReentrantWriteLockError(uri);
472
774
  }
473
- return this.waitForDocumentStateCanonical(uri, state ?? IntegrityService.SettledState, cancelToken);
474
775
  }
475
776
 
476
777
  /**
477
778
  * Per-state typed convenience methods. Each ensures the document at
478
779
  * `uri` reaches the named phase and returns the AST envelope with
479
- * the narrowest accurate diagnostics type for that phase. Smart
480
- * dispatch internally: warm path (URI already in the document
481
- * registry) just waits via {@link waitForDocumentState}; cold path
482
- * triggers a build via {@link rebuild}. Consumers do not need to
483
- * know which path was taken.
780
+ * the narrowest accurate diagnostics type for that phase, building as
781
+ * {@link ensureDocumentState} does.
484
782
  *
485
783
  * Phase invariants encoded in the return type:
486
784
  * - `parsed` / `linked` / `settled` / `indexed` return
487
- * `AstDocument<TAst, never>` — diagnostics array is empty by phase
488
- * contract.
785
+ * `AstDocument<TAst, never>` — no diagnostics have been computed at
786
+ * those phases.
489
787
  * - `validated` returns `AstDocument<TAst, TDiagnostic>` — diagnostics
490
788
  * are populated.
491
789
  *
790
+ * **The `never` is enforced, not merely declared.** The wait underneath
791
+ * resolves at or ABOVE the requested state, so a document something else
792
+ * already carried past `Validated` would otherwise come back from
793
+ * `settled()` carrying a full diagnostics array typed `never`; these four
794
+ * strip it. An empty array here therefore means "this read does not report
795
+ * diagnostics", never "this document is clean" — call {@link validated}
796
+ * when the answer has to mean the second.
797
+ *
492
798
  * `settled` is the integrity-overlay name for "all integrity rules
493
799
  * have fired"; it maps to {@link IntegrityService.SettledState} (which
494
800
  * equals `DocumentState.IndexedReferences`), but the dedicated method
@@ -496,19 +802,19 @@ export class ModelService<
496
802
  * ever moves.
497
803
  */
498
804
  async parsed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
499
- return this.ensureDocumentState(uri, DocumentState.Parsed, cancelToken) as Promise<AstDocument<TAst, never>>;
805
+ return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.Parsed, cancelToken));
500
806
  }
501
807
 
502
808
  async linked(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
503
- return this.ensureDocumentState(uri, DocumentState.Linked, cancelToken) as Promise<AstDocument<TAst, never>>;
809
+ return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.Linked, cancelToken));
504
810
  }
505
811
 
506
812
  async settled(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
507
- return this.ensureDocumentState(uri, IntegrityService.SettledState, cancelToken) as Promise<AstDocument<TAst, never>>;
813
+ return this.withoutDiagnostics(await this.ensureDocumentState(uri, IntegrityService.SettledState, cancelToken));
508
814
  }
509
815
 
510
816
  async indexed(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, never>> {
511
- return this.ensureDocumentState(uri, DocumentState.IndexedReferences, cancelToken) as Promise<AstDocument<TAst, never>>;
817
+ return this.withoutDiagnostics(await this.ensureDocumentState(uri, DocumentState.IndexedReferences, cancelToken));
512
818
  }
513
819
 
514
820
  async validated(uri: string, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
@@ -518,18 +824,13 @@ export class ModelService<
518
824
  /**
519
825
  * Ensure the document at `uri` reaches `state` (or the integrity-settled
520
826
  * landmark {@link IntegrityService.SettledState} if omitted) and return its
521
- * AST envelope. Smart
522
- * dispatch: warm path (URI already in `LangiumDocuments`) just waits
523
- * via {@link waitForDocumentState}; cold path forces a build via
524
- * {@link rebuild}.
525
- *
526
- * Pairs with {@link rebuild} — same default phase, but `rebuild`
527
- * always builds while this skips the build for an already-loaded
528
- * document. Also pairs with {@link waitForDocumentState} — the verb
529
- * difference (`ensure` vs `waitFor`) signals the side-effect
530
- * difference. The per-state convenience methods (`parsed` / `linked`
531
- * / `settled` / `indexed` / `validated`) all delegate here with an
532
- * explicit phase.
827
+ * AST envelope, with a root no older than the store's text at the call.
828
+ * A document not in `LangiumDocuments` is built via {@link rebuild}; a
829
+ * loaded one whose root is behind its text is built through
830
+ * `VersionSyncService.syncTo`. Until `state` is reached, the call rejects
831
+ * once that build, or one the builder re-queues, has failed twice, or the
832
+ * builder stops re-queuing the document. A loaded, current document is only
833
+ * awaited.
533
834
  */
534
835
  async ensureDocumentState(uri: string, state?: DocumentState, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
535
836
  return this.ensureDocumentStateCanonical(this.uriPolicy.canonicalUri(uri), state, cancelToken);
@@ -552,177 +853,71 @@ export class ModelService<
552
853
  ): Promise<AstDocument<TAst, TDiagnostic>> {
553
854
  const target = state ?? IntegrityService.SettledState;
554
855
  if (this.services.workspace.LangiumDocuments.hasDocument(UriUtils.toUri(uri))) {
555
- return this.waitForDocumentStateCanonical(uri, target, cancelToken);
856
+ return this.waitForDocumentStateCanonical(uri, target, cancelToken, { sync: true });
556
857
  }
557
858
  return this.rebuild(uri, target, cancelToken);
558
859
  }
559
860
 
560
861
  /**
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
- /**
662
- * Wait for the document at `uri` to reach the integrity-settled landmark and
862
+ * Wait for the document at `uri` to reach the integrity-settled landmark,
863
+ * building a root behind its text as {@link ensureDocumentState} does, and
663
864
  * drain any in-flight write-path applyEdit sync chain (see {@link syncChains})
664
- * so every language client reflects the latest content before a save returns.
665
- * No-op tail for headless adopters — `syncChains` is empty without an LSP
666
- * 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.
865
+ * so the language client has answered the push of the latest content before
866
+ * this returns; a push it refused twice is logged, not retried. No-op tail
867
+ * for headless adopters — `syncChains` is empty without an LSP client.
868
+ * Bounded at 10 s so a hung build, or an applyEdit reverse-RPC deadlock,
869
+ * can't freeze the caller; it returns rather than throwing, warning on
870
+ * timeout. A failed wait is logged at `error`, at `debug` when cancelled and
871
+ * at `warn` when the document is gone.
669
872
  *
670
- * Adopters with a save flow that must converge editor + disk before returning
671
- * (e.g. a dual form/code editor that would otherwise show a content-conflict
672
- * dialog on rapid save) call this after their `save`.
873
+ * The framework's save handlers call this after their persist; an adopter's
874
+ * own save path that answers a client calls it after its `save` too.
673
875
  */
674
- protected async settleSave(uri: string, cancelToken?: CancellationToken): Promise<void> {
876
+ async settleLanguageClient(uri: string, cancelToken?: CancellationToken): Promise<void> {
675
877
  const canonical = this.uriPolicy.canonicalUri(uri);
676
878
  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
- );
680
- 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]);
879
+ // One race over both waits, so the bound is one deadline for the pair;
880
+ // a race per wait would let the caller wait twice the bound.
881
+ let awaitedChain: Promise<void> | undefined;
882
+ const settled = (async (): Promise<void> => {
883
+ await this.waitForDocumentStateCanonical(canonical, IntegrityService.SettledState, cancelToken, { sync: true });
884
+ const chain = this.syncChains.get(key);
885
+ if (chain && this.timedOutSyncChains.has(chain)) {
886
+ this.tracer.withUri(key).debug('Language client settle not waiting again for a push the client has not answered');
887
+ return;
685
888
  }
686
- } catch (err: unknown) {
687
- if (err instanceof SaveSettleTimeoutError) {
688
- this.tracer.withUri(key).warn(`Save settle exceeded ${SAVE_SETTLE_TIMEOUT_MS}ms — returning anyway`);
889
+ awaitedChain = chain;
890
+ await chain;
891
+ })();
892
+ // The settle ends a failed wait, so it logs it, at one level whether the wait failed inside the bound or after it.
893
+ const reportFailedWait = (error: unknown, when: string): void => {
894
+ const tracer = this.tracer.withUri(key);
895
+ if (isOperationCancelled(error)) {
896
+ tracer.debug(`Language client settle cancelled ${when}`);
897
+ } else if (!this.services.workspace.LangiumDocuments.hasDocument(UriUtils.toUri(canonical))) {
898
+ tracer.warn(`Language client settle failed ${when}; the document is gone. ${describeErrorWithStack(error)}`);
689
899
  } 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}`);
900
+ tracer.error(`Language client settle failed ${when}. ${describeErrorWithStack(error)}`);
901
+ }
902
+ };
903
+ try {
904
+ if ((await this.services.Clock.raceTimer(settled, LANGUAGE_CLIENT_SETTLE_TIMEOUT_MS)) === TIMED_OUT) {
905
+ this.tracer.withUri(key).warn(`Language client settle exceeded ${LANGUAGE_CLIENT_SETTLE_TIMEOUT_MS}ms — returning anyway`);
906
+ if (awaitedChain) {
907
+ this.timedOutSyncChains.add(awaitedChain);
908
+ }
909
+ // The race has settled, so a later failure of the wait, such as a given-up sync build, reaches no one else.
910
+ void settled.catch((error: unknown) => reportFailedWait(error, 'after the timeout'));
692
911
  }
912
+ } catch (err: unknown) {
913
+ // Its own line, so the failure is not blamed on the bound.
914
+ reportFailedWait(err, 'before the timeout — returning anyway');
693
915
  }
694
916
  }
695
917
 
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);
918
+ isLanguageClientPushPending(uri: string): boolean {
919
+ const chain = this.syncChains.get(UriUtils.toUri(this.uriPolicy.canonicalUri(uri)).toString());
920
+ return chain !== undefined && !this.timedOutSyncChains.has(chain);
726
921
  }
727
922
 
728
923
  /**
@@ -733,6 +928,37 @@ export class ModelService<
733
928
  return this.services.workspace.AstDocumentManager.isOpen(uri);
734
929
  }
735
930
 
931
+ openedVersion(uri: string): TextVersion | undefined {
932
+ return this.services.workspace.TextDocuments.openedVersion(uri);
933
+ }
934
+
935
+ /**
936
+ * Snapshot of `uri` as it stands RIGHT NOW — the synchronous sibling of the
937
+ * phase reads, which all wait. `undefined` when no document is registered,
938
+ * or only the builder's placeholder for one its build has not parsed yet:
939
+ * that root is no parse of any text, and its version gates no write.
940
+ *
941
+ * **This is what a writer wants, and {@link getDocument} is not.** The
942
+ * envelope's `version` is copied by value at projection time, so it cannot
943
+ * move afterwards; a version read off the live document at write time is
944
+ * whatever the server is at *now*, which is the number an optimistic gate is
945
+ * about to compare it against.
946
+ *
947
+ * Diagnostics only from a document that has reached `Validated`, and absent
948
+ * otherwise. Unlike the phase reads this one names no phase, so
949
+ * the state it finds is the only thing that can say whether the array
950
+ * describes the content being handed back or whatever an earlier build left.
951
+ * A caller that needs them unconditionally waits, via {@link validated}.
952
+ */
953
+ snapshot(uri: string): AstDocument<TAst, TDiagnostic> | undefined {
954
+ const document = this.getDocument(uri);
955
+ if (!document || this.services.workspace.ModelLedger.isPlaceholder(document.parseResult.value)) {
956
+ return undefined;
957
+ }
958
+ const envelope = this.services.workspace.AstDocumentManager.toAstDocument(document) as AstDocument<TAst, TDiagnostic>;
959
+ return document.state >= DocumentState.Validated ? envelope : this.withoutDiagnostics(envelope);
960
+ }
961
+
736
962
  /**
737
963
  * The built {@link LangiumDocument} for `uri`, looked up by canonical identity —
738
964
  * the synchronous, phase-agnostic sibling of {@link ensureDocumentState} /
@@ -741,11 +967,106 @@ export class ModelService<
741
967
  * into `LangiumDocuments` directly: a symlinked / `..` / case-divergent URI
742
968
  * still resolves to the one document the build keys by its real path. Returns
743
969
  * `undefined` if no document is registered for `uri`.
970
+ *
971
+ * **Live, so do not take a base version off it.** `textDocument` is the
972
+ * store's own object rather than a copy, so `.version` read here answers for
973
+ * the moment of the READ, not the moment of the earlier content — pass it to
974
+ * a write and the server compares its current version against itself, the
975
+ * gate passes unconditionally, and a concurrent edit is overwritten with
976
+ * nothing logged. Use {@link snapshot} for that, or a phase read.
744
977
  */
745
978
  getDocument(uri: string): LangiumDocument | undefined {
746
979
  return this.services.workspace.AstDocumentManager.getDocument(uri);
747
980
  }
748
981
 
982
+ // ============================================================
983
+ // Client sessions
984
+ // ============================================================
985
+
986
+ createSession<TOpenOptions extends OpenOptions = OpenOptions>(
987
+ label?: string,
988
+ clientId?: string,
989
+ options: { readonly resumeToken?: string } = {}
990
+ ): ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions> {
991
+ const sessionLabel = label ?? 'session';
992
+ const id = clientId ?? `${sessionLabel}#${randomUuid()}`;
993
+ const textDocuments = this.services.workspace.TextDocuments;
994
+ if (options.resumeToken !== undefined && this.resumeTokens.get(id) === options.resumeToken) {
995
+ this.sessions.get(id)?.dispose('lost');
996
+ }
997
+ textDocuments.registerSession(id);
998
+ this.sessionCloseListener ??= textDocuments.onDidCloseSession(event => {
999
+ // Also reached when the store ends a session directly; disposing the
1000
+ // handle makes its later calls fail rather than write under an id
1001
+ // this service no longer treats as a session. Forgotten first: a
1002
+ // dispose listener may start a replacement under the same id.
1003
+ const ended = this.sessions.get(event.clientId);
1004
+ this.sessions.delete(event.clientId);
1005
+ this.resumeTokens.delete(event.clientId);
1006
+ ended?.dispose(event.cause);
1007
+ });
1008
+ let session: ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions>;
1009
+ try {
1010
+ // Unchecked: the session keeps whatever options its `open` is handed,
1011
+ // and the factory types it for every grammar, so the narrowed type
1012
+ // holds only for the caller that started it.
1013
+ session = this.services.model.ClientSessionFactory.create(id, sessionLabel) as ClientSession<
1014
+ TAst,
1015
+ TDiagnostic,
1016
+ TTransfer,
1017
+ TOpenOptions
1018
+ >;
1019
+ } catch (err: unknown) {
1020
+ textDocuments.closeSession(id);
1021
+ throw err;
1022
+ }
1023
+ this.sessions.set(id, session);
1024
+ if (options.resumeToken !== undefined) {
1025
+ this.resumeTokens.set(id, options.resumeToken);
1026
+ }
1027
+ return session;
1028
+ }
1029
+
1030
+ getSession(clientId: string): ClientSession<TAst, TDiagnostic, TTransfer> | undefined {
1031
+ return this.sessions.get(clientId);
1032
+ }
1033
+
1034
+ /**
1035
+ * Convert a structured-or-textual `model` payload to its textual form.
1036
+ *
1037
+ * Textual payloads (LSP / pre-serialised callers) pass through untouched.
1038
+ * Structured payloads run the per-language `UpdateRewriteService` chain
1039
+ * (transfer-model transforms; diff-aware rewrites see the previous AST root),
1040
+ * then serialise. The chain is the single transfer-model-transform seam — a
1041
+ * unary normalisation is just a rewrite that ignores `previous`, as
1042
+ * `NormalizeEmptyStringsContribution` does. The chain is empty by
1043
+ * default, so this is a no-op for adopters that register none.
1044
+ *
1045
+ * The serialised text then takes the trivia of the text it replaces, or of
1046
+ * an empty one when `uri` has none, so a created document gets the
1047
+ * preservers' defaults rather than the serializer's bare output.
1048
+ */
1049
+ async modelToText(uri: string, model: TTransfer | string, cancelToken?: CancellationToken): Promise<string> {
1050
+ if (typeof model === 'string') {
1051
+ return model;
1052
+ }
1053
+ const rewritten = await this.rewriteModel(uri, model, cancelToken);
1054
+ const target = UriUtils.toUri(uri);
1055
+ const trivia = this.services.ServiceRegistry?.getServices(target)?.trivia?.TriviaService;
1056
+ // Extracted BEFORE serializing, so it reads the document the write is
1057
+ // about to replace rather than whatever a concurrent build left behind.
1058
+ let document = this.services.workspace.LangiumDocuments.getDocument(target);
1059
+ if (trivia !== undefined && document === undefined) {
1060
+ // With no text, an empty one: every preserver still runs, so a created
1061
+ // document takes the defaults a blank one gets.
1062
+ const source = (await this.textToTakeTriviaFrom(uri, target)) ?? '';
1063
+ document = this.services.workspace.LangiumDocumentFactory.fromString(source, target);
1064
+ }
1065
+ const extracted = trivia !== undefined && document !== undefined ? trivia.extract(document) : undefined;
1066
+ const serialized = await this.serialize(uri, rewritten);
1067
+ return extracted === undefined ? serialized : trivia!.apply(serialized, extracted, target);
1068
+ }
1069
+
749
1070
  // ============================================================
750
1071
  // LSP-client sync (mirror non-LSP-client changes back to Monaco)
751
1072
  // ============================================================
@@ -754,18 +1075,14 @@ export class ModelService<
754
1075
  * Mirror a server-side change of `document` back to the LSP textual language
755
1076
  * client, run per document as it reaches the post-integrity settled phase.
756
1077
  * The single framework caller of
757
- * `HydraniumTextDocuments.applyEditToLanguageClient` and
758
- * `HydraniumTextDocuments.stagePendingContent`.
1078
+ * `HydraniumTextDocuments.applyEditToLanguageClient`.
759
1079
  *
760
- * Routes to one of two mechanisms by language-client registration, because
761
- * an open and a closed document answer different questions:
762
- *
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}).
1080
+ * Only a document open in the language client is mirrored, through
1081
+ * {@link syncOpenDocument}, routed purely by **content**. A document open
1082
+ * only in another client needs nothing: a language client opening it joins
1083
+ * the existing entry and is refreshed from the store. A session writes only
1084
+ * what it has open, so no session edit of a closed document waits here for
1085
+ * the language client's next open.
769
1086
  *
770
1087
  * The decision is **re-derived from the current settled state every time** (it
771
1088
  * is not a one-shot enrolment), which is what makes it self-healing: a doc
@@ -775,20 +1092,18 @@ export class ModelService<
775
1092
  */
776
1093
  protected syncToLanguageClient(document: LangiumDocument): void {
777
1094
  // `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
781
- // CANONICAL URI — the same key `settleSave` looks the chain up under —
782
- // so a save-settle can drain the in-flight applyEdit. The canonical→client-URI
1095
+ // build. Route by client registration (presence questions — both
1096
+ // predicates canonicalize internally, so a divergent open path still
1097
+ // resolves to the same record), but key the outbound sync by this
1098
+ // CANONICAL URI — the same key `settleLanguageClient` looks the chain up
1099
+ // under — so a settle can drain the in-flight applyEdit. The canonical→client-URI
783
1100
  // translation (a symlinked path the client opened, or a dual-open fan-out)
784
1101
  // happens at the `applyEditToLanguageClient` egress, where the text store maps
785
1102
  // the canonical key to the recorded language-client URI(s); driving the chain
786
- // in client space here would key it under a URI `settleSave` never computes, so
787
- // the drain would miss for a divergent open path.
1103
+ // in client space here would key it under a URI `settleLanguageClient`
1104
+ // never computes, so the drain would miss for a divergent open path.
788
1105
  if (this.services.workspace.TextDocuments.isOpenInLanguageClient(document.textDocument.uri)) {
789
1106
  this.syncOpenDocument(document.textDocument.uri, document.textDocument.getText());
790
- } else {
791
- this.stageClosedDocument(document);
792
1107
  }
793
1108
  }
794
1109
 
@@ -807,46 +1122,6 @@ export class ModelService<
807
1122
  this.queueSync(uri, text);
808
1123
  }
809
1124
 
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
1125
  /**
851
1126
  * Enqueue a sync to the language client. The pending slot per URI holds only
852
1127
  * the latest text: if a newer settle fires while the current RPC is in
@@ -878,23 +1153,50 @@ export class ModelService<
878
1153
  this.syncChains.set(uri, chain);
879
1154
  }
880
1155
 
1156
+ /**
1157
+ * The undo-stack label for a server-authored write, in the locale the server
1158
+ * was handed at init.
1159
+ *
1160
+ * One method rather than the literal at each `applyEdit`, because the two
1161
+ * call sites are the same edit — a push and its full-replace retry — and an
1162
+ * undo menu showing two different words for one operation would read as two
1163
+ * operations.
1164
+ */
1165
+ protected editLabel(): string {
1166
+ return this.services.MessageRenderer.renderMessage(MODEL_UPDATE_EDIT);
1167
+ }
1168
+
881
1169
  protected async drainSyncQueue(uri: string): Promise<void> {
882
1170
  const uriLogger = this.tracer.withUri(uri);
883
1171
  while (this.pendingSync.has(uri)) {
884
1172
  const text = this.pendingSync.get(uri)!;
885
1173
  this.pendingSync.delete(uri);
886
1174
  try {
887
- let result = await this.services.workspace.TextDocuments.applyEditToLanguageClient(uri, text, { label: 'Update Model' });
888
- if (result?.applied === false && !this.pendingSync.has(uri)) {
889
- // The push is addressed at the client's LAST DECLARED VERSION, so a
1175
+ const textDocuments = this.services.workspace.TextDocuments;
1176
+ // An answer, or a failure, ends a hang a settle timed out on, so the
1177
+ // chain's later pushes are waited for again.
1178
+ const push = async (): Promise<ApplyWorkspaceEditResult | undefined> => {
1179
+ try {
1180
+ return await textDocuments.applyEditToLanguageClient(uri, text, { label: this.editLabel() });
1181
+ } finally {
1182
+ const chain = this.syncChains.get(uri);
1183
+ if (chain) {
1184
+ this.timedOutSyncChains.delete(chain);
1185
+ }
1186
+ }
1187
+ };
1188
+ let result = await push();
1189
+ if (result?.applied === false && !this.pendingSync.has(uri) && textDocuments.get(uri)?.getText() === text) {
1190
+ // The push is addressed at the client's last known version, so a
890
1191
  // rejection normally means the client's buffer moved while the
891
1192
  // line-keyed diff was in flight — exactly the case where applying it
892
1193
  // would splice the file. Dropping the push there would leave the
893
1194
  // editor showing text the server has already superseded, with no
894
1195
  // later settle guaranteed to correct it (a content-identical echo
895
- // mints no rebuild). The rejection invalidated the shadow, so the
896
- // retry is a full-range replace: position-independent, and therefore
897
- // correct against whatever the client now holds.
1196
+ // mints no rebuild). After a rejection the retry is a full-range
1197
+ // replace: position-independent, and therefore correct against
1198
+ // whatever the client now holds. It sends nothing when the client
1199
+ // was last heard to hold the text already.
898
1200
  //
899
1201
  // Retried INLINE rather than re-enqueued, and exactly once. Inline
900
1202
  // because a re-enqueue would have to out-order any settle that lands
@@ -903,9 +1205,11 @@ export class ModelService<
903
1205
  // the workspace) must cost one extra RPC rather than spin. The
904
1206
  // `pendingSync` check skips the retry when a newer settle has already
905
1207
  // queued — best-effort, since a settle arriving later simply pushes
906
- // 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' });
1208
+ // after this and still wins. It is skipped too once the store holds
1209
+ // other text: the keystroke that made the client refuse replaced it,
1210
+ // and re-pushing would overwrite that keystroke in the editor.
1211
+ uriLogger.debug(`Re-pushing a full replace after the language client refused applyEdit`);
1212
+ result = await push();
909
1213
  if (result?.applied === false) {
910
1214
  uriLogger.warn(`Language client rejected the full-replace retry too — client content is stale`);
911
1215
  }
@@ -916,52 +1220,156 @@ export class ModelService<
916
1220
  // ordinary shutdown. Reporting it at `error` makes routine teardown
917
1221
  // look like it needs investigating. A genuine applyEdit failure
918
1222
  // (client refused, request malformed) still surfaces at `error`.
919
- if (isConnectionGoneError(err)) {
1223
+ if (isClientGoneError(err)) {
920
1224
  uriLogger.debug(`applyEdit to ${LANGUAGE_CLIENT_ID} skipped: client disconnected`);
921
1225
  } else {
922
- uriLogger.error(`applyEdit to ${LANGUAGE_CLIENT_ID} failed: ${err}`);
1226
+ uriLogger.error(`applyEdit to ${LANGUAGE_CLIENT_ID} failed: ${describeErrorWithStack(err)}`);
923
1227
  }
924
1228
  }
925
1229
  }
926
1230
  }
927
1231
 
928
1232
  // ============================================================
929
- // Subscription pass-throughs
1233
+ // Subscriptions
930
1234
  // ============================================================
931
1235
 
932
- /**
933
- * Subscribe to AST-snapshot updates for `uri`. Fires after each
934
- * rebuild that reaches the target phase. Delegates to the
935
- * `HydraniumTextDocuments` — single listener registration shared with
936
- * any direct `HydraniumTextDocuments.onUpdate` subscriber, so the same
937
- * 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`).
941
- */
942
- onModelUpdated(uri: string, listener: (event: AstDocumentUpdatedEvent<TAst, TDiagnostic>) => void): Disposable {
943
- return this.services.workspace.AstDocumentManager.onUpdate(uri, listener as never);
1236
+ onModelUpdated(listener: (event: ModelUpdatedEvent<TAst, TDiagnostic>) => void, filter: ModelPhaseFilter = {}): Disposable {
1237
+ const phase = filter.phase ?? DocumentState.Validated;
1238
+ let subscribers = this.updateSubscribers.get(phase);
1239
+ if (!subscribers) {
1240
+ const created = new Set<ModelUpdateSubscriber<TAst, TDiagnostic>>();
1241
+ this.updateSubscribers.set(phase, created);
1242
+ this.services.workspace.DocumentBuilder.onDocumentPhase(
1243
+ phase,
1244
+ labelPhaseListener(
1245
+ (document, cancelToken) => this.deliverUpdate(phase, created, document, cancelToken),
1246
+ 'ModelService.onModelUpdated'
1247
+ )
1248
+ );
1249
+ subscribers = created;
1250
+ }
1251
+ const subscriber = { uri: this.filterUri(filter), listener };
1252
+ subscribers.add(subscriber);
1253
+ return Disposable.create(() => subscribers.delete(subscriber));
944
1254
  }
945
1255
 
946
- /**
947
- * Subscribe to save events for `uri`. Fires on every persist through
948
- * the multi-client text-document store — including saves originated
949
- * by other heads (LSP editor `Ctrl+S`, the data-server `save`, etc.)
950
- * so subscribers see one consistent stream regardless of who wrote
951
- * the file. Delegates to the manager — single listener registration
952
- * shared with any direct `HydraniumTextDocuments.onSave` subscriber.
953
- */
954
- onModelSaved(uri: string, listener: (event: AstDocumentSavedEvent<TAst, TDiagnostic>) => void): Disposable {
955
- return this.services.workspace.AstDocumentManager.onSave(uri, listener as never);
1256
+ onModelsBuilt(listener: (event: ModelsBuiltEvent) => void, filter: Pick<ModelPhaseFilter, 'phase'> = {}): Disposable {
1257
+ const phase = filter.phase ?? DocumentState.Validated;
1258
+ return this.services.workspace.DocumentBuilder.onBuildPhase(phase, (built, cancelToken) => {
1259
+ if (cancelToken.isCancellationRequested) {
1260
+ return;
1261
+ }
1262
+ try {
1263
+ listener(Object.freeze({ uris: built.map(document => this.uriPolicy.canonicalUri(document.uri.toString())), phase }));
1264
+ } catch (err: unknown) {
1265
+ this.tracer.error(`onModelsBuilt listener threw: ${describeErrorWithStack(err)}`);
1266
+ }
1267
+ });
1268
+ }
1269
+
1270
+ onModelSaved(listener: (event: ModelSavedEvent<TAst, TDiagnostic>) => void, filter: ModelEventFilter = {}): Disposable {
1271
+ const target = this.filterUri(filter);
1272
+ return this.services.workspace.TextDocuments.onDidSave(event => {
1273
+ // LangiumDocuments keys by the canonical form, the saved event by the
1274
+ // client-facing one.
1275
+ const uri = this.uriPolicy.canonicalUri(event.document.uri);
1276
+ if (this.matches(target, uri)) {
1277
+ listener({ document: this.toAstDocument(UriUtils.toUri(uri)), sourceClientId: event.clientId });
1278
+ }
1279
+ });
1280
+ }
1281
+
1282
+ onModelDeleted(listener: (event: ModelDeletedEvent) => void, filter: ModelEventFilter = {}): Disposable {
1283
+ const target = this.filterUri(filter);
1284
+ return this.services.workspace.DocumentBuilder.onUpdate((_changed, deleted) => {
1285
+ for (const deletedUri of deleted) {
1286
+ const uri = this.uriPolicy.canonicalUri(deletedUri.toString());
1287
+ if (this.matches(target, uri)) {
1288
+ listener(Object.freeze({ uri, sourceClientId: this.services.workspace.AstDocumentManager.attributeDeletion(uri) }));
1289
+ }
1290
+ }
1291
+ });
1292
+ }
1293
+
1294
+ onDirtyChanged(listener: (event: ModelDirtyChangedEvent) => void, filter: ModelEventFilter = {}): Disposable {
1295
+ const target = this.filterUri(filter);
1296
+ return this.services.workspace.TextDocuments.onDidChangeDirty(event => {
1297
+ if (this.matches(target, event.uri)) {
1298
+ listener(event);
1299
+ }
1300
+ });
1301
+ }
1302
+
1303
+ onModelReleased(listener: (event: ModelReleasedEvent) => void, filter: ModelEventFilter = {}): Disposable {
1304
+ const target = this.filterUri(filter);
1305
+ return this.services.workspace.TextDocuments.onDidReleaseDocument(event => {
1306
+ if (this.matches(target, event.uri)) {
1307
+ listener(event);
1308
+ }
1309
+ });
1310
+ }
1311
+
1312
+ onClientClosed(listener: () => void, filter: { readonly uri: string; readonly clientId: string }): Disposable {
1313
+ const target = this.uriPolicy.canonicalUri(filter.uri);
1314
+ return this.services.workspace.TextDocuments.onDidClose(event => {
1315
+ if (event.clientId === filter.clientId && this.uriPolicy.canonicalUri(event.document.uri) === target) {
1316
+ listener();
1317
+ }
1318
+ });
1319
+ }
1320
+
1321
+ protected filterUri(filter: ModelEventFilter): CanonicalUri | undefined {
1322
+ return filter.uri === undefined ? undefined : this.uriPolicy.canonicalUri(filter.uri);
1323
+ }
1324
+
1325
+ protected matches(target: CanonicalUri | undefined, uri: CanonicalUri): boolean {
1326
+ return target === undefined || target === uri;
956
1327
  }
957
1328
 
958
1329
  /**
959
- * Subscribe to the `(uri, clientId)` close event. Delegates to the
960
- * manager so the listener registry is shared with any direct
961
- * `HydraniumTextDocuments.onClientClosed` subscriber.
1330
+ * Hand every subscriber of `phase` for `document` one event, built once, so
1331
+ * all of them see the same attribution. Built inside the build's listener
1332
+ * and handed out without an await: after one, another build can have reset
1333
+ * the document.
962
1334
  */
963
- onClientClosed(uri: string, clientId: string, listener: () => void): Disposable {
964
- return this.services.workspace.AstDocumentManager.onClientClosed(uri, clientId, listener);
1335
+ protected deliverUpdate(
1336
+ phase: DocumentState,
1337
+ subscribers: ReadonlySet<ModelUpdateSubscriber<TAst, TDiagnostic>>,
1338
+ document: LangiumDocument,
1339
+ cancelToken: CancellationToken
1340
+ ): void {
1341
+ if (cancelToken.isCancellationRequested || subscribers.size === 0) {
1342
+ return;
1343
+ }
1344
+ const uri = this.uriPolicy.canonicalUri(document.uri.toString());
1345
+ const matching = [...subscribers].filter(subscriber => this.matches(subscriber.uri, uri));
1346
+ if (matching.length === 0) {
1347
+ return;
1348
+ }
1349
+ const manager = this.services.workspace.AstDocumentManager;
1350
+ const envelope = manager.toAstDocument(document) as AstDocument<TAst, TDiagnostic>;
1351
+ const event: ModelUpdatedEvent<TAst, TDiagnostic> = Object.freeze({
1352
+ // Copied: a validation run without a reset, of further categories,
1353
+ // appends to the live array.
1354
+ document:
1355
+ phase >= DocumentState.Validated
1356
+ ? { ...envelope, ...(envelope.diagnostics && { diagnostics: [...envelope.diagnostics] }) }
1357
+ : (this.withoutDiagnostics(envelope) as AstDocument<TAst, TDiagnostic>),
1358
+ ...manager.attributeUpdate(document),
1359
+ phase
1360
+ });
1361
+ for (const { listener } of matching) {
1362
+ // A write queued by an earlier listener cancels this build. Thrown,
1363
+ // so the builder leaves the version undelivered for those skipped.
1364
+ if (cancelToken.isCancellationRequested) {
1365
+ throw OperationCancelled;
1366
+ }
1367
+ try {
1368
+ listener(event);
1369
+ } catch (err: unknown) {
1370
+ this.tracer.with(uri).error(`onModelUpdated listener threw: ${describeErrorWithStack(err)}`);
1371
+ }
1372
+ }
965
1373
  }
966
1374
 
967
1375
  // ============================================================
@@ -979,13 +1387,13 @@ export class ModelService<
979
1387
  * Adopters whose serializer call shape differs (custom service
980
1388
  * names, generator-driven YAML pretty printers, etc.) override this
981
1389
  * method. Routes through `Serializer.serializeTransfer` because
982
- * `ModelService.update` / `ModelService.save` always receive a
1390
+ * a session's `update` / `save` always receive a
983
1391
  * transfer-model shape (cross-references as plain strings) from
984
1392
  * adopter callers — the AST-shape entry point is `serializeAst`.
985
1393
  *
986
1394
  * Returns {@link MaybePromise} so adopter `Serializer` overrides can be
987
1395
  * async (remote schema lookup, external canonical-value resolution); the
988
- * single caller ({@link modelToText} → {@link update}) is already `async`,
1396
+ * single caller ({@link modelToText}) is already `async`,
989
1397
  * so a naive `await` covers both branches without extra ceremony.
990
1398
  */
991
1399
  protected serialize(uri: string, root: TTransfer): MaybePromise<string> {
@@ -998,22 +1406,15 @@ export class ModelService<
998
1406
  // ============================================================
999
1407
 
1000
1408
  /**
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.
1409
+ * The text a write into a document not yet built should take its trivia
1410
+ * from: the store's, which a write always has, since it writes only a
1411
+ * document its client has open. `undefined` when the store holds no text
1412
+ * for `uri`: a document not yet created, or a file on disk that the
1413
+ * workspace has not read and no client has open. The preservers then run
1414
+ * over empty text, as for a created document; no answer skips them.
1010
1415
  */
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);
1416
+ protected async textToTakeTriviaFrom(uri: string, _target: URI): Promise<string | undefined> {
1417
+ return this.services.workspace.TextDocuments.get(uri)?.getText();
1017
1418
  }
1018
1419
 
1019
1420
  /**
@@ -1037,15 +1438,37 @@ export class ModelService<
1037
1438
 
1038
1439
  /**
1039
1440
  * Build an {@link AstDocument} envelope from the current
1040
- * {@link LangiumDocument} state via the shared {@link AstDocument.from}
1041
- * projection. Returns an empty envelope (built via
1441
+ * {@link LangiumDocument} state via `AstDocumentManager.toAstDocument`,
1442
+ * the projection events use too. Returns an empty envelope (built via
1042
1443
  * {@link AstDocument.create}) when the document is absent from the
1043
- * registry — adopters that prefer to throw override on their subclass.
1444
+ * registry — adopters that prefer to throw override on their subclass. Its
1445
+ * version is {@link UNRECORDED_VERSION}, so a write based on it conflicts.
1044
1446
  */
1045
1447
  protected toAstDocument(uri: URI): AstDocument<TAst, TDiagnostic> {
1046
1448
  const document = this.services.workspace.LangiumDocuments.getDocument(uri);
1047
1449
  return document
1048
- ? AstDocument.from<TAst, TDiagnostic>(document)
1049
- : AstDocument.create<TAst, TDiagnostic>(uri.toString(), 0, undefined as unknown as TAst, []);
1450
+ ? (this.services.workspace.AstDocumentManager.toAstDocument(document) as AstDocument<TAst, TDiagnostic>)
1451
+ : AstDocument.create<TAst, TDiagnostic>(uri.toString(), UNRECORDED_VERSION, undefined as unknown as TAst);
1452
+ }
1453
+
1454
+ /**
1455
+ * The same envelope with no diagnostics, for a read that names a phase below
1456
+ * `Validated`. Absent rather than `[]`, which says the document was validated
1457
+ * and found clean.
1458
+ *
1459
+ * Langium fills `LangiumDocument.diagnostics` from inside `validateDocument`
1460
+ * and from nowhere else, so below that phase the array holds whatever an
1461
+ * EARLIER build left — a verdict about text the document may no longer have.
1462
+ * The wait underneath resolves at or above the phase asked for, so a document
1463
+ * something else carried past `Validated` would otherwise hand a full array
1464
+ * back from `parsed()`.
1465
+ *
1466
+ * A copy rather than a clear: the envelope is freshly built here, but
1467
+ * {@link toAstDocument} is overridable and an adopter's version may return
1468
+ * one it also keeps.
1469
+ */
1470
+ protected withoutDiagnostics(document: AstDocument<TAst, TDiagnostic>): AstDocument<TAst, never> {
1471
+ const { diagnostics: _diagnostics, ...rest } = document;
1472
+ return rest;
1050
1473
  }
1051
1474
  }