@hydranium/protocol 1.0.0-next.13 → 1.0.0-next.132

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 (172) hide show
  1. package/README.md +35 -1
  2. package/lib/client/data-connection.d.ts +145 -0
  3. package/lib/client/data-connection.d.ts.map +1 -0
  4. package/lib/client/data-connection.js +205 -0
  5. package/lib/client/data-connection.js.map +1 -0
  6. package/lib/client/data-events.d.ts +13 -1
  7. package/lib/client/data-events.d.ts.map +1 -1
  8. package/lib/client/data-events.js +21 -0
  9. package/lib/client/data-events.js.map +1 -1
  10. package/lib/client/data-port.d.ts +17 -22
  11. package/lib/client/data-port.d.ts.map +1 -1
  12. package/lib/client/data-session.d.ts +301 -80
  13. package/lib/client/data-session.d.ts.map +1 -1
  14. package/lib/client/data-session.js +425 -107
  15. package/lib/client/data-session.js.map +1 -1
  16. package/lib/client/index.d.ts +13 -8
  17. package/lib/client/index.d.ts.map +1 -1
  18. package/lib/client/index.js +13 -8
  19. package/lib/client/index.js.map +1 -1
  20. package/lib/client/message-relay.d.ts +9 -3
  21. package/lib/client/message-relay.d.ts.map +1 -1
  22. package/lib/client/message-relay.js +11 -5
  23. package/lib/client/message-relay.js.map +1 -1
  24. package/lib/client/post-message-transport.d.ts +64 -3
  25. package/lib/client/post-message-transport.d.ts.map +1 -1
  26. package/lib/client/post-message-transport.js +175 -1
  27. package/lib/client/post-message-transport.js.map +1 -1
  28. package/lib/client/rpc-connection.d.ts +149 -0
  29. package/lib/client/rpc-connection.d.ts.map +1 -0
  30. package/lib/client/rpc-connection.js +179 -0
  31. package/lib/client/rpc-connection.js.map +1 -0
  32. package/lib/client-ids.d.ts +41 -0
  33. package/lib/client-ids.d.ts.map +1 -0
  34. package/lib/client-ids.js +44 -0
  35. package/lib/client-ids.js.map +1 -0
  36. package/lib/clock.d.ts +38 -0
  37. package/lib/clock.d.ts.map +1 -1
  38. package/lib/clock.js +36 -1
  39. package/lib/clock.js.map +1 -1
  40. package/lib/data/data-protocol-methods.d.ts +4 -4
  41. package/lib/data/data-protocol-methods.d.ts.map +1 -1
  42. package/lib/data/data-protocol-methods.js +11 -1
  43. package/lib/data/data-protocol-methods.js.map +1 -1
  44. package/lib/data/data-server-protocol.d.ts +110 -31
  45. package/lib/data/data-server-protocol.d.ts.map +1 -1
  46. package/lib/data/events.d.ts +84 -3
  47. package/lib/data/events.d.ts.map +1 -1
  48. package/lib/data/requests.d.ts +67 -11
  49. package/lib/data/requests.d.ts.map +1 -1
  50. package/lib/errors.d.ts +102 -12
  51. package/lib/errors.d.ts.map +1 -1
  52. package/lib/errors.js +136 -18
  53. package/lib/errors.js.map +1 -1
  54. package/lib/glsp-save-model-actions.d.ts +50 -0
  55. package/lib/glsp-save-model-actions.d.ts.map +1 -0
  56. package/lib/glsp-save-model-actions.js +28 -0
  57. package/lib/glsp-save-model-actions.js.map +1 -0
  58. package/lib/index.d.ts +3 -0
  59. package/lib/index.d.ts.map +1 -1
  60. package/lib/index.js +6 -0
  61. package/lib/index.js.map +1 -1
  62. package/lib/latency-collector.d.ts +8 -4
  63. package/lib/latency-collector.d.ts.map +1 -1
  64. package/lib/latency-collector.js.map +1 -1
  65. package/lib/messages/index.d.ts +29 -0
  66. package/lib/messages/index.d.ts.map +1 -0
  67. package/lib/messages/index.js +56 -0
  68. package/lib/messages/index.js.map +1 -0
  69. package/lib/messages/primitives.d.ts +188 -0
  70. package/lib/messages/primitives.d.ts.map +1 -0
  71. package/lib/messages/primitives.js +161 -0
  72. package/lib/messages/primitives.js.map +1 -0
  73. package/lib/model-server.d.ts +44 -13
  74. package/lib/model-server.d.ts.map +1 -1
  75. package/lib/model-server.js +4 -2
  76. package/lib/model-server.js.map +1 -1
  77. package/lib/model-service/based-on.d.ts +57 -0
  78. package/lib/model-service/based-on.d.ts.map +1 -0
  79. package/lib/model-service/based-on.js +37 -0
  80. package/lib/model-service/based-on.js.map +1 -0
  81. package/lib/model-service/index.d.ts +1 -1
  82. package/lib/model-service/index.d.ts.map +1 -1
  83. package/lib/model-service/index.js +4 -5
  84. package/lib/model-service/index.js.map +1 -1
  85. package/lib/patch-merge.d.ts +28 -27
  86. package/lib/patch-merge.d.ts.map +1 -1
  87. package/lib/patch-merge.js +66 -22
  88. package/lib/patch-merge.js.map +1 -1
  89. package/lib/profile-session.d.ts +8 -4
  90. package/lib/profile-session.d.ts.map +1 -1
  91. package/lib/profile-session.js.map +1 -1
  92. package/lib/rpc/bind-rpc-methods.d.ts +29 -3
  93. package/lib/rpc/bind-rpc-methods.d.ts.map +1 -1
  94. package/lib/rpc/bind-rpc-methods.js +22 -3
  95. package/lib/rpc/bind-rpc-methods.js.map +1 -1
  96. package/lib/rpc/create-rpc-proxy.d.ts +7 -0
  97. package/lib/rpc/create-rpc-proxy.d.ts.map +1 -1
  98. package/lib/rpc/create-rpc-proxy.js +6 -1
  99. package/lib/rpc/create-rpc-proxy.js.map +1 -1
  100. package/lib/testing/catalogue-audit.d.ts +80 -0
  101. package/lib/testing/catalogue-audit.d.ts.map +1 -0
  102. package/lib/testing/catalogue-audit.js +94 -0
  103. package/lib/testing/catalogue-audit.js.map +1 -0
  104. package/lib/testing/data-doubles.d.ts +13 -12
  105. package/lib/testing/data-doubles.d.ts.map +1 -1
  106. package/lib/testing/data-doubles.js +19 -5
  107. package/lib/testing/data-doubles.js.map +1 -1
  108. package/lib/testing/fake-clock.d.ts +9 -1
  109. package/lib/testing/fake-clock.d.ts.map +1 -1
  110. package/lib/testing/fake-clock.js +54 -45
  111. package/lib/testing/fake-clock.js.map +1 -1
  112. package/lib/testing/index.d.ts +1 -0
  113. package/lib/testing/index.d.ts.map +1 -1
  114. package/lib/testing/index.js +4 -1
  115. package/lib/testing/index.js.map +1 -1
  116. package/lib/testing/node/index.d.ts +1 -0
  117. package/lib/testing/node/index.d.ts.map +1 -1
  118. package/lib/testing/node/index.js +2 -2
  119. package/lib/testing/node/index.js.map +1 -1
  120. package/lib/testing/node/message-port-pair.d.ts +25 -0
  121. package/lib/testing/node/message-port-pair.d.ts.map +1 -0
  122. package/lib/testing/node/message-port-pair.js +26 -0
  123. package/lib/testing/node/message-port-pair.js.map +1 -0
  124. package/lib/transfer-diagnostic.d.ts +33 -0
  125. package/lib/transfer-diagnostic.d.ts.map +1 -1
  126. package/lib/transfer-diagnostic.js +23 -0
  127. package/lib/transfer-diagnostic.js.map +1 -1
  128. package/lib/transfer-document.d.ts +22 -5
  129. package/lib/transfer-document.d.ts.map +1 -1
  130. package/lib/transfer-document.js +14 -1
  131. package/lib/transfer-document.js.map +1 -1
  132. package/package.json +11 -2
  133. package/src/client/data-connection.ts +282 -0
  134. package/src/client/data-events.ts +33 -1
  135. package/src/client/data-port.ts +17 -23
  136. package/src/client/data-session.ts +549 -126
  137. package/src/client/index.ts +13 -8
  138. package/src/client/message-relay.ts +29 -7
  139. package/src/client/post-message-transport.ts +219 -4
  140. package/src/client/rpc-connection.ts +244 -0
  141. package/src/client-ids.ts +45 -0
  142. package/src/clock.ts +56 -0
  143. package/src/data/data-protocol-methods.ts +11 -3
  144. package/src/data/data-server-protocol.ts +131 -31
  145. package/src/data/events.ts +90 -3
  146. package/src/data/requests.ts +71 -11
  147. package/src/errors.ts +154 -20
  148. package/src/glsp-save-model-actions.ts +59 -0
  149. package/src/index.ts +6 -0
  150. package/src/latency-collector.ts +8 -3
  151. package/src/messages/index.ts +36 -0
  152. package/src/messages/primitives.ts +271 -0
  153. package/src/model-server.ts +47 -18
  154. package/src/model-service/based-on.ts +63 -0
  155. package/src/model-service/index.ts +4 -5
  156. package/src/patch-merge.ts +90 -37
  157. package/src/profile-session.ts +9 -4
  158. package/src/rpc/bind-rpc-methods.ts +49 -4
  159. package/src/rpc/create-rpc-proxy.ts +14 -1
  160. package/src/testing/catalogue-audit.ts +111 -0
  161. package/src/testing/data-doubles.ts +42 -17
  162. package/src/testing/fake-clock.ts +62 -47
  163. package/src/testing/index.ts +4 -1
  164. package/src/testing/node/index.ts +2 -2
  165. package/src/testing/node/message-port-pair.ts +40 -0
  166. package/src/transfer-diagnostic.ts +40 -0
  167. package/src/transfer-document.ts +29 -6
  168. package/lib/model-service/args.d.ts +0 -64
  169. package/lib/model-service/args.d.ts.map +0 -1
  170. package/lib/model-service/args.js +0 -11
  171. package/lib/model-service/args.js.map +0 -1
  172. package/src/model-service/args.ts +0 -67
@@ -0,0 +1,111 @@
1
+ /********************************************************************************
2
+ * Copyright (c) 2026 CrossBreeze, EclipseSource and others.
3
+ *
4
+ * This program and the accompanying materials are made available under the
5
+ * terms of the MIT License which is available in the project root.
6
+ *
7
+ * SPDX-License-Identifier: MIT
8
+ ********************************************************************************/
9
+
10
+ import { collectMessages } from '../messages/primitives';
11
+
12
+ /**
13
+ * Audit a translation catalogue against the codes that actually exist.
14
+ *
15
+ * **The one failure mode a catalogue has, and the only one nothing else
16
+ * catches.** A key naming no declared code falls back to the English — which is
17
+ * byte-identical to a deliberate omission, so a typo is invisible at runtime and
18
+ * indistinguishable from the partial-catalogue behaviour every adopter relies
19
+ * on. Nothing on the render path can tell them apart, `theia nls-extract`
20
+ * reports what the SOURCE declares rather than whether a catalogue matches it,
21
+ * and the framework's own gates see only the framework's own files.
22
+ *
23
+ * Shipped as test support rather than as a runtime check on purpose: an
24
+ * orphaned key is an authoring mistake, and failing a server boot over one would
25
+ * take a running product down for a cosmetic defect.
26
+ */
27
+
28
+ /**
29
+ * Flatten a nested catalogue into the `/`-joined keys a message code is spelled
30
+ * with, dropping `_`-prefixed keys as notes to a human reader.
31
+ *
32
+ * Nesting is a HOST convention, not the framework's: Theia flattens a nested
33
+ * catalogue by joining keys with `/`, which is the separator a code already
34
+ * uses, so an adopter on that host writes the file nested and one handed
35
+ * straight to a `DefaultMessageRenderer` writes it flat. Both end up here.
36
+ *
37
+ * `_`-prefixed keys are dropped by PREFIX rather than by matching one literal
38
+ * name, so a second note added to a file cannot silently become a catalogue
39
+ * entry. A code is three `/`-separated segments, so no real entry can begin
40
+ * with `_`.
41
+ */
42
+ export function flattenCatalogue(catalogue: Record<string, unknown>, prefix = ''): Record<string, string> {
43
+ const flat: Record<string, string> = {};
44
+ for (const [key, value] of Object.entries(catalogue)) {
45
+ if (key.startsWith('_')) {
46
+ continue;
47
+ }
48
+ const joined = prefix ? `${prefix}/${key}` : key;
49
+ if (typeof value === 'string') {
50
+ flat[joined] = value;
51
+ } else if (typeof value === 'object' && value !== null) {
52
+ Object.assign(flat, flattenCatalogue(value as Record<string, unknown>, joined));
53
+ }
54
+ }
55
+ return flat;
56
+ }
57
+
58
+ /** Options for {@link findUndeclaredCodes}. */
59
+ export interface CatalogueAuditOptions {
60
+ /**
61
+ * Key prefixes to skip, for entries whose codes are NOT declared through a
62
+ * `defineMessage` barrel.
63
+ *
64
+ * The real case is a host's own mechanism: Theia's `nls.localize` takes its
65
+ * key as an inline literal at the call site, so those keys exist only in
66
+ * source text and no barrel can enumerate them. Keep this as narrow as the
67
+ * host layer actually is — exempting a namespace is exempting every typo in
68
+ * it, which is what this function exists to find.
69
+ */
70
+ readonly exemptPrefixes?: readonly string[];
71
+ }
72
+
73
+ /**
74
+ * Every catalogue key that names no code any of `barrels` declares.
75
+ *
76
+ * Barrels are taken as opaque objects and read with {@link collectMessages},
77
+ * which is what lets a caller pass a `import * as messages` namespace directly:
78
+ * a barrel's value type is a union of its declarations AND its functions, and
79
+ * filtering that union will not narrow to a `MessageDefinition`.
80
+ *
81
+ * Returns the offending keys rather than a boolean, so a failing assertion names
82
+ * WHICH key is wrong — a count says only that something is.
83
+ */
84
+ export function findUndeclaredCodes(
85
+ catalogueKeys: readonly string[],
86
+ barrels: readonly object[],
87
+ options: CatalogueAuditOptions = {}
88
+ ): string[] {
89
+ const declared = new Set(barrels.flatMap(barrel => collectMessages(barrel).map(message => message.code)));
90
+ const exempt = options.exemptPrefixes ?? [];
91
+ return catalogueKeys.filter(key => !exempt.some(prefix => key.startsWith(prefix)) && !declared.has(key));
92
+ }
93
+
94
+ /**
95
+ * Keys present in more than one catalogue — the shape a split catalogue rots
96
+ * into.
97
+ *
98
+ * Exactly one side renders a given message, so two catalogues holding one code
99
+ * are two authorities over one sentence and they diverge on the first reword.
100
+ * Nothing at runtime notices: both sides render, and whichever ran last wins on
101
+ * its own surface.
102
+ *
103
+ * Takes the key sets rather than a boolean answer for the same reason as
104
+ * {@link findUndeclaredCodes}, and reports NOTHING when a set is empty — an
105
+ * empty catalogue shares no key with anything, so a caller must assert
106
+ * non-emptiness separately or a failed read passes this vacuously.
107
+ */
108
+ export function findSharedCodes(first: readonly string[], second: readonly string[]): string[] {
109
+ const other = new Set(second);
110
+ return first.filter(key => other.has(key));
111
+ }
@@ -34,7 +34,15 @@
34
34
  import { Emitter, type MessageConnection } from 'vscode-jsonrpc';
35
35
  import type { DataPort } from '../client/data-port';
36
36
  import type { DataClientProtocol } from '../data/data-server-protocol';
37
- import type { ProjectsChangedEvent, TransferDocumentSavedEvent, TransferDocumentUpdatedEvent } from '../data/events';
37
+ import type {
38
+ ProjectsChangedEvent,
39
+ TransferDocumentDeletedEvent,
40
+ TransferDocumentDirtyChangedEvent,
41
+ TransferDocumentSavedEvent,
42
+ TransferDocumentsBuiltEvent,
43
+ TransferDocumentUpdatedEvent
44
+ } from '../data/events';
45
+ import type { ResolvedMessage } from '../messages/primitives';
38
46
  import type { Project } from '../project';
39
47
  import type { TransferDiagnostic } from '../transfer-diagnostic';
40
48
  import type { TransferElement } from '../transfer-element';
@@ -51,13 +59,6 @@ export interface FakeDataPortOptions {
51
59
  * which the consumer surfaces through {@link FakeDataPort.reported}.
52
60
  */
53
61
  connect(): MessageConnection | Promise<MessageConnection>;
54
- /**
55
- * Stable client identity. Defaults to `'fake-data-port'`, which avoids the
56
- * three sentinels the framework reserves (`'language-client'`, `'unknown'`,
57
- * `'revert-on-close'`); override it when a test needs two distinguishable
58
- * clients on one server.
59
- */
60
- clientId?: string;
61
62
  }
62
63
 
63
64
  /** A {@link DataPort} that records what passed through it. */
@@ -73,10 +74,11 @@ export interface FakeDataPort extends DataPort {
73
74
  /**
74
75
  * Every {@link DataPort.reportError} call, in order. Read from outside: this
75
76
  * is the only place a transport failure surfaces, so a test for the failure
76
- * path asserts on the `context` string here rather than on a rejection that
77
- * the consumer may legitimately swallow.
77
+ * path asserts here rather than on a rejection the consumer may legitimately
78
+ * swallow. Prefer asserting on `message.code`, which is stable, over
79
+ * `message.text`, which is the English default and may be reworded.
78
80
  */
79
- readonly reported: readonly { readonly error: unknown; readonly context: string }[];
81
+ readonly reported: readonly { readonly error: unknown; readonly message: ResolvedMessage }[];
80
82
  /**
81
83
  * Fire {@link DataPort.onDispose} — the host tearing the transport down, a
82
84
  * language-server restart being the case that forces the event to exist.
@@ -96,10 +98,9 @@ export interface FakeDataPort extends DataPort {
96
98
  */
97
99
  export function makeFakeDataPort(options: FakeDataPortOptions): FakeDataPort {
98
100
  const connections: MessageConnection[] = [];
99
- const reported: { error: unknown; context: string }[] = [];
101
+ const reported: { error: unknown; message: ResolvedMessage }[] = [];
100
102
  const disposeEmitter = new Emitter<void>();
101
103
  return {
102
- clientId: options.clientId ?? 'fake-data-port',
103
104
  connections,
104
105
  reported,
105
106
  onDispose: disposeEmitter.event,
@@ -108,8 +109,8 @@ export function makeFakeDataPort(options: FakeDataPortOptions): FakeDataPort {
108
109
  connections.push(connection);
109
110
  return connection;
110
111
  },
111
- reportError(error: unknown, context: string): void {
112
- reported.push({ error, context });
112
+ reportError(error: unknown, message: ResolvedMessage): void {
113
+ reported.push({ error, message });
113
114
  },
114
115
  fireDispose(): void {
115
116
  disposeEmitter.fire(undefined);
@@ -132,6 +133,12 @@ export interface CapturingDataClient<
132
133
  readonly updates: TransferDocumentUpdatedEvent<TTransfer, TDiagnostic>[];
133
134
  /** Every `onDocumentSaved` event, in arrival order. */
134
135
  readonly saves: TransferDocumentSavedEvent<TTransfer, TDiagnostic>[];
136
+ /** Every `onDocumentDirtyChanged` event, in arrival order. */
137
+ readonly dirtyChanges: TransferDocumentDirtyChangedEvent[];
138
+ /** Every `onDocumentDeleted` event, in arrival order. */
139
+ readonly deletions: TransferDocumentDeletedEvent[];
140
+ /** Every `onDocumentsBuilt` event, in arrival order. */
141
+ readonly builds: TransferDocumentsBuiltEvent[];
135
142
  /** Every `onProjectsChanged` event, in arrival order. */
136
143
  readonly projectsChanges: ProjectsChangedEvent<TProject>[];
137
144
  }
@@ -139,7 +146,7 @@ export interface CapturingDataClient<
139
146
  /**
140
147
  * A {@link DataClientProtocol} that records every notification it receives.
141
148
  *
142
- * Recording ALL THREE channels even when a suite reads one is deliberate: an
149
+ * Recording EVERY channel even when a suite reads one is deliberate: an
143
150
  * event delivered on the wrong channel is a real defect of the data head, and a
144
151
  * double that drops the other two turns it into silence on the one being
145
152
  * watched.
@@ -156,6 +163,9 @@ export function makeCapturingDataClient<
156
163
  >(overrides: Partial<DataClientProtocol<TTransfer, TDiagnostic, TProject>> = {}): CapturingDataClient<TTransfer, TDiagnostic, TProject> {
157
164
  const updates: TransferDocumentUpdatedEvent<TTransfer, TDiagnostic>[] = [];
158
165
  const saves: TransferDocumentSavedEvent<TTransfer, TDiagnostic>[] = [];
166
+ const dirtyChanges: TransferDocumentDirtyChangedEvent[] = [];
167
+ const deletions: TransferDocumentDeletedEvent[] = [];
168
+ const builds: TransferDocumentsBuiltEvent[] = [];
159
169
  const projectsChanges: ProjectsChangedEvent<TProject>[] = [];
160
170
  const client: DataClientProtocol<TTransfer, TDiagnostic, TProject> = {
161
171
  onDocumentUpdated:
@@ -168,11 +178,26 @@ export function makeCapturingDataClient<
168
178
  (event => {
169
179
  saves.push(event);
170
180
  }),
181
+ onDocumentDirtyChanged:
182
+ overrides.onDocumentDirtyChanged ??
183
+ (event => {
184
+ dirtyChanges.push(event);
185
+ }),
186
+ onDocumentDeleted:
187
+ overrides.onDocumentDeleted ??
188
+ (event => {
189
+ deletions.push(event);
190
+ }),
191
+ onDocumentsBuilt:
192
+ overrides.onDocumentsBuilt ??
193
+ (event => {
194
+ builds.push(event);
195
+ }),
171
196
  onProjectsChanged:
172
197
  overrides.onProjectsChanged ??
173
198
  (event => {
174
199
  projectsChanges.push(event);
175
200
  })
176
201
  };
177
- return { client, updates, saves, projectsChanges };
202
+ return { client, updates, saves, dirtyChanges, deletions, builds, projectsChanges };
178
203
  }
@@ -7,7 +7,7 @@
7
7
  * SPDX-License-Identifier: MIT
8
8
  ********************************************************************************/
9
9
 
10
- import { type Clock, type Stopwatch, type Timed } from '../clock';
10
+ import { type Clock, type Stopwatch, SystemClock } from '../clock';
11
11
  import { Disposable } from '../util';
12
12
 
13
13
  /** A {@link Clock} whose time only moves when the test calls {@link FakeClock.advance}. */
@@ -17,9 +17,13 @@ export interface FakeClock extends Clock {
17
17
  * whose deadline falls within the window — in chronological order, each at
18
18
  * its own deadline (so `now()` inside a callback reads the fire instant, not
19
19
  * the advance target). Timers scheduled by a callback fire too if they fall
20
- * within the same window.
20
+ * within the same window. A {@link Clock.raceTimer} over a promise that
21
+ * settles through a chain still pending loses to the timer, so let that
22
+ * chain settle before advancing.
21
23
  */
22
24
  advance(ms: number): void;
25
+ /** How many {@link Clock.setTimer} timers have neither fired nor been disposed. */
26
+ pendingTimers(): number;
23
27
  }
24
28
 
25
29
  interface FakeTimer {
@@ -39,68 +43,79 @@ interface FakeTimer {
39
43
  *
40
44
  * Server-free and DI-free — lives in `@hydranium/protocol/testing` so every
41
45
  * head can bind it without pulling in a server package.
46
+ *
47
+ * The clock is a `SystemClock` with its time replaced, so its methods live on
48
+ * its prototype and a spread of it carries none of them. Replace one by
49
+ * assigning it onto the clock, or layer over the clock with `Object.create`.
42
50
  */
43
51
  export function makeFakeClock(options: { now?: number } = {}): FakeClock {
44
- let current = options.now ?? 0;
45
- const timers: FakeTimer[] = [];
52
+ return new VirtualClock(options.now ?? 0);
53
+ }
54
+
55
+ /**
56
+ * A `SystemClock` whose time, stopwatches and timers read one virtual axis, so
57
+ * the `measure` and `raceTimer` it inherits run on that axis too.
58
+ */
59
+ class VirtualClock extends SystemClock implements FakeClock {
60
+ protected readonly timers: FakeTimer[] = [];
46
61
 
47
- const makeStopwatch = (): Stopwatch => {
48
- const start = current;
49
- let lastLap = current;
62
+ constructor(protected current: number) {
63
+ super();
64
+ }
65
+
66
+ override now(): number {
67
+ return this.current;
68
+ }
69
+
70
+ override setTimer(callback: () => void, ms: number): Disposable {
71
+ const timer: FakeTimer = { at: this.current + ms, callback, disposed: false, fired: false };
72
+ this.timers.push(timer);
73
+ return Disposable.create(() => {
74
+ timer.disposed = true;
75
+ });
76
+ }
77
+
78
+ override stopwatch(): Stopwatch {
79
+ const read = (): number => this.current;
80
+ const start = read();
81
+ let lastLap = start;
50
82
  let stopped: number | undefined;
51
83
  return {
52
84
  get elapsedMs(): number {
53
- return (stopped ?? current) - start;
85
+ return (stopped ?? read()) - start;
54
86
  },
55
87
  lap(): number {
56
- const at = stopped ?? current;
88
+ const at = stopped ?? read();
57
89
  const split = at - lastLap;
58
90
  lastLap = at;
59
91
  return split;
60
92
  },
61
93
  stop(): number {
62
- if (stopped === undefined) {
63
- stopped = current;
64
- }
94
+ stopped ??= read();
65
95
  return stopped - start;
66
96
  }
67
97
  };
68
- };
98
+ }
69
99
 
70
- return {
71
- now: () => current,
72
- setTimer(callback: () => void, ms: number): Disposable {
73
- const timer: FakeTimer = { at: current + ms, callback, disposed: false, fired: false };
74
- timers.push(timer);
75
- return Disposable.create(() => {
76
- timer.disposed = true;
77
- });
78
- },
79
- stopwatch: makeStopwatch,
80
- measure: (<T>(callback: () => T | Promise<T>): Timed<T> | Promise<Timed<T>> => {
81
- const stopwatch = makeStopwatch();
82
- const result = callback();
83
- if (result instanceof Promise) {
84
- return (result as Promise<T>).then(value => ({ result: value, elapsedMs: stopwatch.elapsedMs }));
85
- }
86
- return { result: result as T, elapsedMs: stopwatch.elapsedMs };
87
- }) as Clock['measure'],
88
- advance(ms: number): void {
89
- const target = current + ms;
90
- // Fire due timers one at a time, re-scanning after each so a callback
91
- // that schedules a nearer timer still fires within this window.
92
- for (;;) {
93
- const next = timers
94
- .filter(timer => !timer.disposed && !timer.fired && timer.at <= target)
95
- .sort((left, right) => left.at - right.at)[0];
96
- if (!next) {
97
- break;
98
- }
99
- current = next.at;
100
- next.fired = true;
101
- next.callback();
100
+ pendingTimers(): number {
101
+ return this.timers.filter(timer => !timer.disposed && !timer.fired).length;
102
+ }
103
+
104
+ advance(ms: number): void {
105
+ const target = this.current + ms;
106
+ // Fire due timers one at a time, re-scanning after each so a callback
107
+ // that schedules a nearer timer still fires within this window.
108
+ for (;;) {
109
+ const next = this.timers
110
+ .filter(timer => !timer.disposed && !timer.fired && timer.at <= target)
111
+ .sort((left, right) => left.at - right.at)[0];
112
+ if (!next) {
113
+ break;
102
114
  }
103
- current = target;
115
+ this.current = next.at;
116
+ next.fired = true;
117
+ next.callback();
104
118
  }
105
- };
119
+ this.current = target;
120
+ }
106
121
  }
@@ -10,7 +10,9 @@
10
10
  // Subpath barrel for `@hydranium/protocol/testing` — the BROWSER-NEUTRAL shared
11
11
  // primitives: `makeFakeClock` (deterministic `Clock` double on one virtual time
12
12
  // axis), `waitFor` / `tick`, the client-side data-head doubles
13
- // (`makeFakeDataPort` / `makeCapturingDataClient`), and the `Harness` marker
13
+ // (`makeFakeDataPort` / `makeCapturingDataClient`), the translation-catalogue
14
+ // audit (`flattenCatalogue` / `findUndeclaredCodes` / `findSharedCodes`), and
15
+ // the `Harness` marker
14
16
  // interface every framework harness extends. Kept out of the main barrel so production bundles don't pull
15
17
  // the test scaffolding in by default; adopters opt in by importing from
16
18
  // `@hydranium/protocol/testing`.
@@ -20,6 +22,7 @@
20
22
  // type, so they cannot be made portable and live at `./testing/node` instead.
21
23
  // The same rule the package surface uses — the portable name is the short one.
22
24
 
25
+ export * from './catalogue-audit';
23
26
  export * from './data-doubles';
24
27
  export * from './fake-clock';
25
28
  export * from './harness';
@@ -8,8 +8,7 @@
8
8
  ********************************************************************************/
9
9
 
10
10
  // Subpath barrel for `@hydranium/protocol/testing/node` — the test transports
11
- // that need a Node runtime: a crossed `PassThrough` pair and the in-process
12
- // `MessageConnection` bridge over it.
11
+ // that need a Node runtime.
13
12
  //
14
13
  // Separate from `./testing` because a `PassThrough` is in `DuplexStreamPair`'s
15
14
  // exported type and `StreamMessageReader` comes from `vscode-jsonrpc/node`, so
@@ -20,3 +19,4 @@
20
19
 
21
20
  export * from './duplex-connection';
22
21
  export * from './duplex-stream';
22
+ export * from './message-port-pair';
@@ -0,0 +1,40 @@
1
+ /********************************************************************************
2
+ * Copyright (c) 2026 EclipseSource and others.
3
+ *
4
+ * This program and the accompanying materials are made available under the
5
+ * terms of the MIT License which is available in the project root.
6
+ *
7
+ * SPDX-License-Identifier: MIT
8
+ ********************************************************************************/
9
+
10
+ import { MessageChannel } from 'node:worker_threads';
11
+ import type { TransferredMessagePort } from '../../client/post-message-transport';
12
+
13
+ /**
14
+ * The two ends of a `worker_threads` `MessageChannel`, typed as the transferred
15
+ * browser ports `createMessagePortTransport` takes. Node's port clones and keeps
16
+ * order as a browser's does, which is what lets a headless test stand in for a
17
+ * worker.
18
+ *
19
+ * `dispose` closes both ports. Node reports that as a close and a browser port
20
+ * reports nothing, so a test that asserts on a close does so before teardown.
21
+ */
22
+ export interface MessagePortPair {
23
+ readonly port1: TransferredMessagePort;
24
+ readonly port2: TransferredMessagePort;
25
+ dispose(): void;
26
+ }
27
+
28
+ export function makeMessagePortPair(): MessagePortPair {
29
+ const channel = new MessageChannel();
30
+ return {
31
+ // Node's port satisfies the structural type at runtime; the cast records
32
+ // one platform's port standing in for the other's.
33
+ port1: channel.port1 as unknown as TransferredMessagePort,
34
+ port2: channel.port2 as unknown as TransferredMessagePort,
35
+ dispose(): void {
36
+ channel.port1.close();
37
+ channel.port2.close();
38
+ }
39
+ };
40
+ }
@@ -7,6 +7,8 @@
7
7
  * SPDX-License-Identifier: MIT
8
8
  ********************************************************************************/
9
9
 
10
+ import { type MessageParams, type ResolvedMessage } from './messages/primitives';
11
+
10
12
  /**
11
13
  * Generic, transport-friendly diagnostic shape used by the model-server protocol.
12
14
  *
@@ -56,6 +58,21 @@ export interface TransferDiagnostic {
56
58
  * is not usable as a rule identity on its own.
57
59
  */
58
60
  code?: number | string;
61
+ /**
62
+ * Substitutions for the placeholders in the message this {@link code} names,
63
+ * present only for a diagnostic raised from a framework message declaration.
64
+ *
65
+ * Without them a translated template renders with its `{name}` tokens left
66
+ * standing, because substitution leaves an unmatched token in place rather
67
+ * than raising — so a surface that translates from {@link code} alone is
68
+ * correct for a parameterless sentence and visibly wrong for a parameterised
69
+ * one. This is the field that makes the second case work; the LSP carrier has
70
+ * always moved the params, and no carrier below it did.
71
+ *
72
+ * Prefer {@link TransferDiagnostic.resolved} over reading this: it decides
73
+ * whether an identity is present at all, which a lone `params` cannot.
74
+ */
75
+ params?: MessageParams;
59
76
  }
60
77
 
61
78
  export namespace TransferDiagnostic {
@@ -74,6 +91,29 @@ export namespace TransferDiagnostic {
74
91
  return diagnostic.type === 'parsing-error';
75
92
  }
76
93
 
94
+ /**
95
+ * The diagnostic as a renderable message, for a surface that translates.
96
+ * `undefined` when it carries no framework identity — a syntactic error, an
97
+ * adopter's own check, a linker failure — which is the case a caller must
98
+ * distinguish rather than render.
99
+ *
100
+ * Hand the result to `renderFrameworkMessage` with whatever catalogue the
101
+ * host has loaded. The `text` is the server's English, so a code the
102
+ * catalogue does not carry still yields a complete sentence.
103
+ *
104
+ * `code` alone does not establish an identity: it also holds Langium's
105
+ * internal code and an adopter's own, and either would be looked up against a
106
+ * catalogue that cannot have it. Requiring `params` is what discriminates,
107
+ * and it is why a parameterless framework message still populates the field
108
+ * with an empty object rather than omitting it.
109
+ */
110
+ export function resolved(diagnostic: TransferDiagnostic): ResolvedMessage | undefined {
111
+ if (typeof diagnostic.code !== 'string' || diagnostic.params === undefined) {
112
+ return undefined;
113
+ }
114
+ return { code: diagnostic.code, params: diagnostic.params, text: diagnostic.message };
115
+ }
116
+
77
117
  export function getPath(diagnostic: TransferDiagnostic): string {
78
118
  return diagnostic.property ? `${diagnostic.element}${ELEMENT_PROPERTY_SEPARATOR}${diagnostic.property}` : diagnostic.element;
79
119
  }
@@ -9,6 +9,7 @@
9
9
 
10
10
  import type { TransferDiagnostic } from './transfer-diagnostic';
11
11
  import type { TransferElement } from './transfer-element';
12
+ import { asSnapshotVersion, type SnapshotVersion } from './model-service/based-on';
12
13
 
13
14
  /**
14
15
  * Wire envelope exchanged between the model-server's data-server head and
@@ -27,14 +28,13 @@ export interface TransferDocument<TTransfer extends TransferElement, TDiagnostic
27
28
  uri: string;
28
29
  /**
29
30
  * The document version this snapshot was taken at — sourced from the
30
- * server's text-document version counter. Callers that mutate the
31
- * document subsequently pass this value back as `TransferUpdateArgs.baseVersion`
32
- * (or `TransferSaveArgs.baseVersion`) so the server can detect stale-based
33
- * updates and reject them with `ConflictError`.
31
+ * server's text-document version counter. A caller that mutates the document
32
+ * subsequently sends this straight back as `TransferUpdateDocumentArgs.basedOn`, and
33
+ * the server rejects a stale-based update with `ConflictError`.
34
34
  *
35
35
  * See `@hydranium/protocol#errors` for the conflict-detection contract.
36
36
  */
37
- version: number;
37
+ version: SnapshotVersion;
38
38
  /**
39
39
  * Absent when the document does not exist — the server answers an unknown URI
40
40
  * with a shaped envelope rather than an error, so absence is an ordinary
@@ -43,6 +43,14 @@ export interface TransferDocument<TTransfer extends TransferElement, TDiagnostic
43
43
  */
44
44
  root?: TTransfer;
45
45
  diagnostics: TDiagnostic[];
46
+ /**
47
+ * Whether the server holds text for this document that its file does not,
48
+ * as the server last knew the file: set on every document a data server
49
+ * answers or sends that the server holds, and absent otherwise. A change
50
+ * after this snapshot arrives as `onDocumentDirtyChanged` to a client
51
+ * watching the document.
52
+ */
53
+ dirty?: boolean;
46
54
  }
47
55
 
48
56
  /**
@@ -82,6 +90,21 @@ export namespace TransferDocument {
82
90
  return document;
83
91
  }
84
92
 
93
+ /**
94
+ * The envelope for a document the server does not have — `root` absent, and
95
+ * the version a read of a URI the store never saw reports.
96
+ *
97
+ * Exists so the absent branch is built the same way the present one is: both
98
+ * doors mark the version as coming from a read, and neither asks a caller to
99
+ * do it.
100
+ */
101
+ export function absent<TTransfer extends TransferElement, TDiagnostic = TransferDiagnostic>(
102
+ uri: string,
103
+ diagnostics: TDiagnostic[] = []
104
+ ): TransferDocument<TTransfer, TDiagnostic> {
105
+ return { uri, version: asSnapshotVersion(0), root: undefined, diagnostics };
106
+ }
107
+
85
108
  /**
86
109
  * Construct a {@link TransferDocument} envelope. `diagnostics` defaults
87
110
  * to `[]` so test fixtures, fake protocol implementations, and the
@@ -94,6 +117,6 @@ export namespace TransferDocument {
94
117
  root: TTransfer,
95
118
  diagnostics: TDiagnostic[] = []
96
119
  ): TransferDocument<TTransfer, TDiagnostic> {
97
- return { uri, version, root, diagnostics };
120
+ return { uri, version: asSnapshotVersion(version), root, diagnostics };
98
121
  }
99
122
  }
@@ -1,64 +0,0 @@
1
- /********************************************************************************
2
- * Copyright (c) 2026 CrossBreeze, EclipseSource and others.
3
- *
4
- * This program and the accompanying materials are made available under the
5
- * terms of the MIT License which is available in the project root.
6
- *
7
- * SPDX-License-Identifier: MIT
8
- ********************************************************************************/
9
- /**
10
- * Argument shapes for the in-process `ModelService` facade — the
11
- * canonical home for the lifecycle operation signatures. Implementation
12
- * lives in `@hydranium/core/langium/model-service`; this protocol
13
- * package owns the types so wire-side projections (the data-server
14
- * protocol in `./data`) can structurally extend them rather than
15
- * mirroring them by hand.
16
- *
17
- * `./model-server.ts` re-exports them, so an import from either path
18
- * resolves.
19
- */
20
- /** Identifies a client-document binding. Every facade operation carries these fields. */
21
- export interface TransferClientArgs {
22
- /** Document URI. */
23
- uri: string;
24
- /** Stable identifier for the client invoking the operation. */
25
- clientId: string;
26
- }
27
- /**
28
- * Update a document's content via the in-process facade. `model` may be
29
- * the structured (transfer-model or AST) root or its serialised textual
30
- * form — implementations decide which is faster on their transport.
31
- * Generic over `T` so adopters parameterise the structured shape against
32
- * their grammar's transfer-model overlay; passing a string is always
33
- * allowed.
34
- */
35
- export interface TransferUpdateArgs<T> extends TransferClientArgs {
36
- /** Structured model root or its serialised textual form. */
37
- model: T | string;
38
- /**
39
- * Optional based-on version: the text-document version this update
40
- * was authored against. When set, the server compares against its
41
- * current text-document version for `uri` and throws
42
- * `ConflictError` on mismatch. Omit to opt out of the gate — mirrors
43
- * LSP's `OptionalVersionedTextDocumentIdentifier` posture, intended
44
- * for headless / CLI / batch tooling without a meaningful based-on
45
- * version.
46
- */
47
- baseVersion?: number;
48
- }
49
- /**
50
- * Persist a document to disk via the in-process facade. Same `model`
51
- * shape as {@link TransferUpdateArgs}.
52
- */
53
- export interface TransferSaveArgs<T> extends TransferClientArgs {
54
- /** Structured model root or its serialised textual form. */
55
- model: T | string;
56
- /**
57
- * Optional based-on version — same semantics as
58
- * {@link TransferUpdateArgs.baseVersion}. `save` delegates the gating
59
- * check to its inner `update`, so this field threads through to the
60
- * same `ConflictError` site.
61
- */
62
- baseVersion?: number;
63
- }
64
- //# sourceMappingURL=args.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"args.d.ts","sourceRoot":"","sources":["../../src/model-service/args.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF;;;;;;;;;;GAUG;AAEH,yFAAyF;AACzF,MAAM,WAAW,kBAAkB;IAChC,oBAAoB;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,+DAA+D;IAC/D,QAAQ,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,CAAE,SAAQ,kBAAkB;IAC9D,4DAA4D;IAC5D,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC;IAClB;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,CAAE,SAAQ,kBAAkB;IAC5D,4DAA4D;IAC5D,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC;IAClB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACvB"}