@hydranium/protocol 1.0.0-next.7 → 1.0.0-next.70

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 (104) hide show
  1. package/README.md +35 -1
  2. package/lib/client/data-connection.d.ts +103 -0
  3. package/lib/client/data-connection.d.ts.map +1 -0
  4. package/lib/client/data-connection.js +114 -0
  5. package/lib/client/data-connection.js.map +1 -0
  6. package/lib/client/data-events.d.ts +9 -1
  7. package/lib/client/data-events.d.ts.map +1 -1
  8. package/lib/client/data-events.js +14 -0
  9. package/lib/client/data-events.js.map +1 -1
  10. package/lib/client/data-port.d.ts +16 -21
  11. package/lib/client/data-port.d.ts.map +1 -1
  12. package/lib/client/data-session.d.ts +56 -74
  13. package/lib/client/data-session.d.ts.map +1 -1
  14. package/lib/client/data-session.js +67 -101
  15. package/lib/client/data-session.js.map +1 -1
  16. package/lib/client/index.d.ts +10 -7
  17. package/lib/client/index.d.ts.map +1 -1
  18. package/lib/client/index.js +10 -7
  19. package/lib/client/index.js.map +1 -1
  20. package/lib/client/message-relay.d.ts +8 -2
  21. package/lib/client/message-relay.d.ts.map +1 -1
  22. package/lib/client/message-relay.js +10 -4
  23. package/lib/client/message-relay.js.map +1 -1
  24. package/lib/client/rpc-connection.d.ts +131 -0
  25. package/lib/client/rpc-connection.d.ts.map +1 -0
  26. package/lib/client/rpc-connection.js +171 -0
  27. package/lib/client/rpc-connection.js.map +1 -0
  28. package/lib/client-ids.d.ts +41 -0
  29. package/lib/client-ids.d.ts.map +1 -0
  30. package/lib/client-ids.js +44 -0
  31. package/lib/client-ids.js.map +1 -0
  32. package/lib/data/data-protocol-methods.d.ts +2 -2
  33. package/lib/data/data-protocol-methods.d.ts.map +1 -1
  34. package/lib/data/data-protocol-methods.js +6 -1
  35. package/lib/data/data-protocol-methods.js.map +1 -1
  36. package/lib/data/data-server-protocol.d.ts +21 -1
  37. package/lib/data/data-server-protocol.d.ts.map +1 -1
  38. package/lib/data/events.d.ts +70 -3
  39. package/lib/data/events.d.ts.map +1 -1
  40. package/lib/errors.d.ts +25 -6
  41. package/lib/errors.d.ts.map +1 -1
  42. package/lib/errors.js +32 -12
  43. package/lib/errors.js.map +1 -1
  44. package/lib/index.d.ts +2 -0
  45. package/lib/index.d.ts.map +1 -1
  46. package/lib/index.js +5 -0
  47. package/lib/index.js.map +1 -1
  48. package/lib/messages/index.d.ts +28 -0
  49. package/lib/messages/index.d.ts.map +1 -0
  50. package/lib/messages/index.js +52 -0
  51. package/lib/messages/index.js.map +1 -0
  52. package/lib/messages/primitives.d.ts +141 -0
  53. package/lib/messages/primitives.d.ts.map +1 -0
  54. package/lib/messages/primitives.js +138 -0
  55. package/lib/messages/primitives.js.map +1 -0
  56. package/lib/model-server.d.ts +2 -2
  57. package/lib/model-server.d.ts.map +1 -1
  58. package/lib/rpc/bind-rpc-methods.d.ts +29 -3
  59. package/lib/rpc/bind-rpc-methods.d.ts.map +1 -1
  60. package/lib/rpc/bind-rpc-methods.js +22 -3
  61. package/lib/rpc/bind-rpc-methods.js.map +1 -1
  62. package/lib/rpc/create-rpc-proxy.d.ts +7 -0
  63. package/lib/rpc/create-rpc-proxy.d.ts.map +1 -1
  64. package/lib/rpc/create-rpc-proxy.js +6 -1
  65. package/lib/rpc/create-rpc-proxy.js.map +1 -1
  66. package/lib/testing/catalogue-audit.d.ts +80 -0
  67. package/lib/testing/catalogue-audit.d.ts.map +1 -0
  68. package/lib/testing/catalogue-audit.js +94 -0
  69. package/lib/testing/catalogue-audit.js.map +1 -0
  70. package/lib/testing/data-doubles.d.ts +11 -12
  71. package/lib/testing/data-doubles.d.ts.map +1 -1
  72. package/lib/testing/data-doubles.js +14 -5
  73. package/lib/testing/data-doubles.js.map +1 -1
  74. package/lib/testing/index.d.ts +1 -0
  75. package/lib/testing/index.d.ts.map +1 -1
  76. package/lib/testing/index.js +4 -1
  77. package/lib/testing/index.js.map +1 -1
  78. package/lib/transfer-diagnostic.d.ts +33 -0
  79. package/lib/transfer-diagnostic.d.ts.map +1 -1
  80. package/lib/transfer-diagnostic.js +23 -0
  81. package/lib/transfer-diagnostic.js.map +1 -1
  82. package/package.json +11 -2
  83. package/src/client/data-connection.ts +160 -0
  84. package/src/client/data-events.ts +24 -1
  85. package/src/client/data-port.ts +16 -22
  86. package/src/client/data-session.ts +86 -124
  87. package/src/client/index.ts +10 -7
  88. package/src/client/message-relay.ts +28 -6
  89. package/src/client/rpc-connection.ts +222 -0
  90. package/src/client-ids.ts +45 -0
  91. package/src/data/data-protocol-methods.ts +6 -3
  92. package/src/data/data-server-protocol.ts +29 -1
  93. package/src/data/events.ts +74 -3
  94. package/src/errors.ts +38 -14
  95. package/src/index.ts +5 -0
  96. package/src/messages/index.ts +35 -0
  97. package/src/messages/primitives.ts +215 -0
  98. package/src/model-server.ts +2 -2
  99. package/src/rpc/bind-rpc-methods.ts +49 -4
  100. package/src/rpc/create-rpc-proxy.ts +14 -1
  101. package/src/testing/catalogue-audit.ts +111 -0
  102. package/src/testing/data-doubles.ts +33 -17
  103. package/src/testing/index.ts +4 -1
  104. package/src/transfer-diagnostic.ts +40 -0
@@ -0,0 +1,171 @@
1
+ "use strict";
2
+ /********************************************************************************
3
+ * Copyright (c) 2026 CrossBreeze, EclipseSource and others.
4
+ *
5
+ * This program and the accompanying materials are made available under the
6
+ * terms of the MIT License which is available in the project root.
7
+ *
8
+ * SPDX-License-Identifier: MIT
9
+ ********************************************************************************/
10
+ Object.defineProperty(exports, "__esModule", { value: true });
11
+ exports.RpcConnection = exports.DATA_SERVER_NOT_READY = exports.DATA_SERVER_CONNECT_FAILED = void 0;
12
+ const primitives_1 = require("../messages/primitives");
13
+ const rpc_1 = require("../rpc");
14
+ /**
15
+ * The transport never opened. A complete sentence rather than a fragment: a
16
+ * fragment is nested inside a sentence the framework does not own, so no
17
+ * translator controls the whole and the composition cannot be made to read
18
+ * correctly in every language.
19
+ */
20
+ exports.DATA_SERVER_CONNECT_FAILED = (0, primitives_1.defineMessage)('hydranium/protocol/data-server-connect-failed', 'Could not connect to the data server: {detail}');
21
+ exports.DATA_SERVER_NOT_READY = (0, primitives_1.defineMessage)('hydranium/protocol/data-server-not-ready', 'The data server did not become ready: {detail}');
22
+ /**
23
+ * One JSON-RPC connection to a head, with the three jobs every host adapter
24
+ * would otherwise re-derive above {@link DataPort}:
25
+ *
26
+ * 1. **Build the typed proxy** over the port's connection, with the caller's
27
+ * wire prefix and client-method allowlist.
28
+ * 2. **Own the readiness gate** — `waitForReady` once per connection, shared
29
+ * across concurrent callers. A client can connect before the workspace walk
30
+ * finishes, and an early request is then answered correctly from an empty
31
+ * registry, which reads as a broken project tier rather than as a race.
32
+ * 3. **Own the reconnect policy**, by dropping its generation when the port
33
+ * disposes and building a fresh one on the next request.
34
+ *
35
+ * Bounded only by {@link ReadyServer}, so a head serving a slice of the data
36
+ * protocol — diagnostics alone, or one with methods excluded — is still a
37
+ * legal server here. `DataConnection` narrows the bound because its sessions
38
+ * call the document methods; nothing at this layer does.
39
+ */
40
+ class RpcConnection {
41
+ port;
42
+ client;
43
+ methodNamespace;
44
+ clientMethods;
45
+ lifecycle;
46
+ /** The current generation, or `undefined` before the first request / after a teardown. */
47
+ generation;
48
+ disposed = false;
49
+ portDisposeListener;
50
+ constructor(port, client, options) {
51
+ this.port = port;
52
+ this.client = client;
53
+ this.methodNamespace = options.methodNamespace;
54
+ this.clientMethods = options.clientMethods;
55
+ this.lifecycle = options.lifecycle;
56
+ this.portDisposeListener = this.port.onDispose(() => this.dropGeneration());
57
+ }
58
+ /**
59
+ * The connected, READY server proxy.
60
+ *
61
+ * Returns the proxy rather than `void` on purpose. A reconnect replaces the
62
+ * proxy, so a caller that cached one from an earlier call would go on
63
+ * addressing a dead connection with no error — handing it back per call
64
+ * makes the stale reference unrepresentable.
65
+ *
66
+ * Concurrent callers share one readiness promise, so `waitForReady` is
67
+ * awaited once per generation and not once per caller.
68
+ */
69
+ async connected() {
70
+ this.assertLive();
71
+ const generation = this.currentGeneration();
72
+ if (!generation.ready) {
73
+ generation.ready = this.awaitReady(generation);
74
+ }
75
+ await generation.ready;
76
+ return generation.server;
77
+ }
78
+ /**
79
+ * The current generation's proxy WITHOUT awaiting readiness — calls queue
80
+ * against the connection promise.
81
+ *
82
+ * **Protected, and that is the point.** An early request is answered
83
+ * correctly from a registry the workspace walk has not filled yet, which
84
+ * reads as a broken project tier rather than as a race — so every caller has
85
+ * to interpose the gate, and every caller forgetting to is a silent bug.
86
+ * {@link connected} is the public route and returns this same proxy once the
87
+ * gate has settled, which leaves nothing to forget. The one caller that
88
+ * cannot use it is {@link awaitReady}, whose whole job is running the gate.
89
+ *
90
+ * Read per access, never cached: a reconnect replaces the generation, and a
91
+ * held reference would address the dead one.
92
+ */
93
+ get server() {
94
+ this.assertLive();
95
+ return this.currentGeneration().server;
96
+ }
97
+ /**
98
+ * Surface a failure the way this host does, through the port's sink.
99
+ *
100
+ * Here rather than only on the port so every participant sharing the
101
+ * connection reports through one route without being handed the transport.
102
+ */
103
+ reportError(error, reported) {
104
+ this.port.reportError(error, reported);
105
+ }
106
+ /** Tear down the current connection and stop tracking the port. Idempotent. */
107
+ dispose() {
108
+ if (this.disposed) {
109
+ return;
110
+ }
111
+ this.disposed = true;
112
+ this.portDisposeListener.dispose();
113
+ this.dropGeneration();
114
+ }
115
+ /** The live generation, building one if there is none. */
116
+ currentGeneration() {
117
+ if (this.generation) {
118
+ return this.generation;
119
+ }
120
+ this.lifecycle.onConnecting?.();
121
+ const connection = this.port.connect();
122
+ // Rejection is reported here rather than left to float: an unhandled
123
+ // rejection on a connection promise is the failure mode that reads as
124
+ // "the model is empty" instead of "the transport never opened".
125
+ connection.catch((error) => this.port.reportError(error, (0, primitives_1.resolve)(exports.DATA_SERVER_CONNECT_FAILED, { detail: (0, primitives_1.describeError)(error) })));
126
+ const server = (0, rpc_1.createRpcProxy)(connection, {
127
+ methodNamespace: this.methodNamespace,
128
+ localTarget: this.client,
129
+ localMethods: this.clientMethods
130
+ });
131
+ this.generation = { connection, server };
132
+ return this.generation;
133
+ }
134
+ /** Await the connection and the server's startup gate for one generation. */
135
+ async awaitReady(generation) {
136
+ try {
137
+ await generation.connection;
138
+ await generation.server.waitForReady();
139
+ this.lifecycle.onReady?.();
140
+ }
141
+ catch (error) {
142
+ this.lifecycle.onFailed?.(error);
143
+ // Drop the generation so the next request retries rather than
144
+ // re-awaiting a settled rejection forever.
145
+ if (this.generation === generation) {
146
+ this.generation = undefined;
147
+ }
148
+ this.port.reportError(error, (0, primitives_1.resolve)(exports.DATA_SERVER_NOT_READY, { detail: (0, primitives_1.describeError)(error) }));
149
+ throw error;
150
+ }
151
+ }
152
+ /**
153
+ * Discard the current generation, disposing its connection if it opened.
154
+ * The next {@link connected} builds a fresh one.
155
+ */
156
+ dropGeneration() {
157
+ const generation = this.generation;
158
+ this.generation = undefined;
159
+ if (!generation) {
160
+ return;
161
+ }
162
+ generation.connection.then(connection => connection.dispose()).catch(() => undefined);
163
+ }
164
+ assertLive() {
165
+ if (this.disposed) {
166
+ throw new Error(`${this.constructor.name} is disposed`);
167
+ }
168
+ }
169
+ }
170
+ exports.RpcConnection = RpcConnection;
171
+ //# sourceMappingURL=rpc-connection.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rpc-connection.js","sourceRoot":"","sources":["../../src/client/rpc-connection.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AAGlF,uDAAqG;AACrG,gCAAuD;AAGvD;;;;;GAKG;AACU,QAAA,0BAA0B,GAAG,IAAA,0BAAa,EACpD,+CAA+C,EAC/C,gDAAgD,CAClD,CAAC;AAEW,QAAA,qBAAqB,GAAG,IAAA,0BAAa,EAC/C,0CAA0C,EAC1C,gDAAgD,CAClD,CAAC;AAoCF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,aAAa;IAUD;IACA;IAVH,eAAe,CAAS;IACxB,aAAa,CAAsC;IACnD,SAAS,CAAyB;IACrD,0FAA0F;IAChF,UAAU,CAAuB;IACjC,QAAQ,GAAG,KAAK,CAAC;IACR,mBAAmB,CAAsB;IAE5D,YACsB,IAAc,EACd,MAAe,EAClC,OAA8C;QAF3B,SAAI,GAAJ,IAAI,CAAU;QACd,WAAM,GAAN,MAAM,CAAS;QAGlC,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,SAAS;QACZ,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC5C,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;YACrB,UAAU,CAAC,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAClD,CAAC;QACD,MAAM,UAAU,CAAC,KAAK,CAAC;QACvB,OAAO,UAAU,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAc,MAAM;QACjB,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,MAAM,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,KAAc,EAAE,QAAyB;QAClD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAED,+EAA+E;IAC/E,OAAO;QACJ,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjB,OAAO;QACV,CAAC;QACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;QACnC,IAAI,CAAC,cAAc,EAAE,CAAC;IACzB,CAAC;IAED,0DAA0D;IAChD,iBAAiB;QACxB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,UAAU,CAAC;QAC1B,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,EAAE,CAAC;QAChC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACvC,qEAAqE;QACrE,sEAAsE;QACtE,gEAAgE;QAChE,UAAU,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE,CACjC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,IAAA,oBAAO,EAAC,kCAA0B,EAAE,EAAE,MAAM,EAAE,IAAA,0BAAa,EAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CACrG,CAAC;QACF,MAAM,MAAM,GAAG,IAAA,oBAAc,EAAmB,UAAU,EAAE;YACzD,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,YAAY,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC,UAAU,CAAC;IAC1B,CAAC;IAED,6EAA6E;IACnE,KAAK,CAAC,UAAU,CAAC,UAA+B;QACvD,IAAI,CAAC;YACF,MAAM,UAAU,CAAC,UAAU,CAAC;YAC5B,MAAM,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;YACvC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE,CAAC;QAC9B,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACvB,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC;YACjC,8DAA8D;YAC9D,2CAA2C;YAC3C,IAAI,IAAI,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;gBAClC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;YAC/B,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,IAAA,oBAAO,EAAC,6BAAqB,EAAE,EAAE,MAAM,EAAE,IAAA,0BAAa,EAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;YAC/F,MAAM,KAAK,CAAC;QACf,CAAC;IACJ,CAAC;IAED;;;OAGG;IACO,cAAc;QACrB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACnC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,UAAU,EAAE,CAAC;YACf,OAAO;QACV,CAAC;QACD,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IACzF,CAAC;IAES,UAAU;QACjB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,cAAc,CAAC,CAAC;QAC3D,CAAC;IACJ,CAAC;CACH;AA3ID,sCA2IC"}
@@ -0,0 +1,41 @@
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
+ * Well-known values of the wire's `clientId` / `sourceClientId` field.
11
+ *
12
+ * The framework tracks each document as belonging to one or more "clients" —
13
+ * typically an LSP-text client (Monaco, VS Code, …), a GLSP diagram client,
14
+ * and/or a structured-form client — and keys its holds and watches per
15
+ * `(uri, clientId)`. These three values are not real participants, so a client
16
+ * minting its own id must avoid them.
17
+ *
18
+ * **Here rather than in the server package, because the side that has to
19
+ * RECOGNISE them is the client.** An inbound `onDocumentUpdated` carries
20
+ * `sourceClientId`, and a consumer deciding what to do with it is asking which
21
+ * of these it is — so a frontend would otherwise have to depend on the server
22
+ * tier to name three strings, and in practice retypes the literal instead.
23
+ */
24
+ /** Identifier for an LSP-text client (Monaco, VS Code, …). */
25
+ export declare const LANGUAGE_CLIENT_ID = "language-client";
26
+ /** Fallback identifier when a document's author is unknown (e.g. cold workspace-init load). */
27
+ export declare const UNKNOWN_CLIENT_ID = "unknown";
28
+ /**
29
+ * Synthetic author id on the `onDocumentUpdated` broadcast a data-server
30
+ * emits after the LAST client closed a document and the framework rebuilt it
31
+ * from its disk content (discarding unsaved in-session edits). Not a real
32
+ * client: it lets consumers distinguish the revert broadcast from
33
+ * client-authored updates.
34
+ */
35
+ export declare const REVERT_ON_CLOSE_CLIENT_ID = "revert-on-close";
36
+ /**
37
+ * Every id the framework reserves, for a client checking that the identity it
38
+ * is about to mint collides with none of them.
39
+ */
40
+ export declare const FRAMEWORK_CLIENT_IDS: readonly string[];
41
+ //# sourceMappingURL=client-ids.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client-ids.d.ts","sourceRoot":"","sources":["../src/client-ids.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF;;;;;;;;;;;;;;GAcG;AAEH,8DAA8D;AAC9D,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAEpD,+FAA+F;AAC/F,eAAO,MAAM,iBAAiB,YAAY,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,oBAAoB,CAAC;AAE3D;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,SAAS,MAAM,EAAuE,CAAC"}
@@ -0,0 +1,44 @@
1
+ "use strict";
2
+ /********************************************************************************
3
+ * Copyright (c) 2026 CrossBreeze, EclipseSource and others.
4
+ *
5
+ * This program and the accompanying materials are made available under the
6
+ * terms of the MIT License which is available in the project root.
7
+ *
8
+ * SPDX-License-Identifier: MIT
9
+ ********************************************************************************/
10
+ Object.defineProperty(exports, "__esModule", { value: true });
11
+ exports.FRAMEWORK_CLIENT_IDS = exports.REVERT_ON_CLOSE_CLIENT_ID = exports.UNKNOWN_CLIENT_ID = exports.LANGUAGE_CLIENT_ID = void 0;
12
+ /**
13
+ * Well-known values of the wire's `clientId` / `sourceClientId` field.
14
+ *
15
+ * The framework tracks each document as belonging to one or more "clients" —
16
+ * typically an LSP-text client (Monaco, VS Code, …), a GLSP diagram client,
17
+ * and/or a structured-form client — and keys its holds and watches per
18
+ * `(uri, clientId)`. These three values are not real participants, so a client
19
+ * minting its own id must avoid them.
20
+ *
21
+ * **Here rather than in the server package, because the side that has to
22
+ * RECOGNISE them is the client.** An inbound `onDocumentUpdated` carries
23
+ * `sourceClientId`, and a consumer deciding what to do with it is asking which
24
+ * of these it is — so a frontend would otherwise have to depend on the server
25
+ * tier to name three strings, and in practice retypes the literal instead.
26
+ */
27
+ /** Identifier for an LSP-text client (Monaco, VS Code, …). */
28
+ exports.LANGUAGE_CLIENT_ID = 'language-client';
29
+ /** Fallback identifier when a document's author is unknown (e.g. cold workspace-init load). */
30
+ exports.UNKNOWN_CLIENT_ID = 'unknown';
31
+ /**
32
+ * Synthetic author id on the `onDocumentUpdated` broadcast a data-server
33
+ * emits after the LAST client closed a document and the framework rebuilt it
34
+ * from its disk content (discarding unsaved in-session edits). Not a real
35
+ * client: it lets consumers distinguish the revert broadcast from
36
+ * client-authored updates.
37
+ */
38
+ exports.REVERT_ON_CLOSE_CLIENT_ID = 'revert-on-close';
39
+ /**
40
+ * Every id the framework reserves, for a client checking that the identity it
41
+ * is about to mint collides with none of them.
42
+ */
43
+ exports.FRAMEWORK_CLIENT_IDS = [exports.LANGUAGE_CLIENT_ID, exports.UNKNOWN_CLIENT_ID, exports.REVERT_ON_CLOSE_CLIENT_ID];
44
+ //# sourceMappingURL=client-ids.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client-ids.js","sourceRoot":"","sources":["../src/client-ids.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AAElF;;;;;;;;;;;;;;GAcG;AAEH,8DAA8D;AACjD,QAAA,kBAAkB,GAAG,iBAAiB,CAAC;AAEpD,+FAA+F;AAClF,QAAA,iBAAiB,GAAG,SAAS,CAAC;AAE3C;;;;;;GAMG;AACU,QAAA,yBAAyB,GAAG,iBAAiB,CAAC;AAE3D;;;GAGG;AACU,QAAA,oBAAoB,GAAsB,CAAC,0BAAkB,EAAE,yBAAiB,EAAE,iCAAyB,CAAC,CAAC"}
@@ -25,7 +25,7 @@ export declare const DATA_SERVER_PROTOCOL_METHODS: readonly ["openModelDocument"
25
25
  */
26
26
  export declare const REFERENCE_SERVER_PROTOCOL_METHODS: readonly ["findReferenceCandidates", "resolveReference", "findNextName"];
27
27
  /** Notification-method names on {@link DocumentClientProtocol}. */
28
- export declare const DOCUMENT_CLIENT_PROTOCOL_METHODS: readonly ["onDocumentUpdated", "onDocumentSaved"];
28
+ export declare const DOCUMENT_CLIENT_PROTOCOL_METHODS: readonly ["onDocumentUpdated", "onDocumentSaved", "onDocumentDeleted", "onDocumentsBuilt"];
29
29
  /** Notification-method names on {@link ProjectClientProtocol}. */
30
30
  export declare const PROJECT_CLIENT_PROTOCOL_METHODS: readonly ["onProjectsChanged"];
31
31
  /**
@@ -35,5 +35,5 @@ export declare const PROJECT_CLIENT_PROTOCOL_METHODS: readonly ["onProjectsChang
35
35
  * data head's connection routes `<methodNamespace>onDocumentUpdated` etc. to
36
36
  * the bound client target.
37
37
  */
38
- export declare const DATA_CLIENT_PROTOCOL_METHODS: readonly ["onDocumentUpdated", "onDocumentSaved", "onProjectsChanged"];
38
+ export declare const DATA_CLIENT_PROTOCOL_METHODS: readonly ["onDocumentUpdated", "onDocumentSaved", "onDocumentDeleted", "onDocumentsBuilt", "onProjectsChanged"];
39
39
  //# sourceMappingURL=data-protocol-methods.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"data-protocol-methods.d.ts","sourceRoot":"","sources":["../../src/data/data-protocol-methods.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAalF,8DAA8D;AAC9D,eAAO,MAAM,gCAAgC,oLAS6C,CAAC;AAE3F,6DAA6D;AAC7D,eAAO,MAAM,+BAA+B,8CAE3C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,uNAG6C,CAAC;AAEvF;;;;;GAKG;AACH,eAAO,MAAM,iCAAiC,0EAI6C,CAAC;AAE5F,mEAAmE;AACnE,eAAO,MAAM,gCAAgC,mDAE5C,CAAC;AAEF,kEAAkE;AAClE,eAAO,MAAM,+BAA+B,gCAA+F,CAAC;AAE5I;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B,wEAG6C,CAAC"}
1
+ {"version":3,"file":"data-protocol-methods.d.ts","sourceRoot":"","sources":["../../src/data/data-protocol-methods.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAalF,8DAA8D;AAC9D,eAAO,MAAM,gCAAgC,oLAS6C,CAAC;AAE3F,6DAA6D;AAC7D,eAAO,MAAM,+BAA+B,8CAE3C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,uNAG6C,CAAC;AAEvF;;;;;GAKG;AACH,eAAO,MAAM,iCAAiC,0EAI6C,CAAC;AAE5F,mEAAmE;AACnE,eAAO,MAAM,gCAAgC,4FAK6C,CAAC;AAE3F,kEAAkE;AAClE,eAAO,MAAM,+BAA+B,gCAA+F,CAAC;AAE5I;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B,iHAG6C,CAAC"}
@@ -44,7 +44,12 @@ exports.REFERENCE_SERVER_PROTOCOL_METHODS = [
44
44
  'findNextName'
45
45
  ];
46
46
  /** Notification-method names on {@link DocumentClientProtocol}. */
47
- exports.DOCUMENT_CLIENT_PROTOCOL_METHODS = ['onDocumentUpdated', 'onDocumentSaved'];
47
+ exports.DOCUMENT_CLIENT_PROTOCOL_METHODS = [
48
+ 'onDocumentUpdated',
49
+ 'onDocumentSaved',
50
+ 'onDocumentDeleted',
51
+ 'onDocumentsBuilt'
52
+ ];
48
53
  /** Notification-method names on {@link ProjectClientProtocol}. */
49
54
  exports.PROJECT_CLIENT_PROTOCOL_METHODS = ['onProjectsChanged'];
50
55
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"data-protocol-methods.js","sourceRoot":"","sources":["../../src/data/data-protocol-methods.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AAalF,8DAA8D;AACjD,QAAA,gCAAgC,GAAG;IAC7C,mBAAmB;IACnB,oBAAoB;IACpB,kBAAkB;IAClB,qBAAqB;IACrB,mBAAmB;IACnB,oBAAoB;IACpB,sBAAsB;IACtB,cAAc;CACyE,CAAC;AAE3F,6DAA6D;AAChD,QAAA,+BAA+B,GAAG,CAAC,aAAa,EAAE,kBAAkB,CAEhF,CAAC;AAEF;;;;;GAKG;AACU,QAAA,4BAA4B,GAAG;IACzC,GAAG,wCAAgC;IACnC,GAAG,uCAA+B;CACiD,CAAC;AAEvF;;;;;GAKG;AACU,QAAA,iCAAiC,GAAG;IAC9C,yBAAyB;IACzB,kBAAkB;IAClB,cAAc;CAC0E,CAAC;AAE5F,mEAAmE;AACtD,QAAA,gCAAgC,GAAG,CAAC,mBAAmB,EAAE,iBAAiB,CAEtF,CAAC;AAEF,kEAAkE;AACrD,QAAA,+BAA+B,GAAG,CAAC,mBAAmB,CAAwE,CAAC;AAE5I;;;;;;GAMG;AACU,QAAA,4BAA4B,GAAG;IACzC,GAAG,wCAAgC;IACnC,GAAG,uCAA+B;CACiD,CAAC"}
1
+ {"version":3,"file":"data-protocol-methods.js","sourceRoot":"","sources":["../../src/data/data-protocol-methods.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AAalF,8DAA8D;AACjD,QAAA,gCAAgC,GAAG;IAC7C,mBAAmB;IACnB,oBAAoB;IACpB,kBAAkB;IAClB,qBAAqB;IACrB,mBAAmB;IACnB,oBAAoB;IACpB,sBAAsB;IACtB,cAAc;CACyE,CAAC;AAE3F,6DAA6D;AAChD,QAAA,+BAA+B,GAAG,CAAC,aAAa,EAAE,kBAAkB,CAEhF,CAAC;AAEF;;;;;GAKG;AACU,QAAA,4BAA4B,GAAG;IACzC,GAAG,wCAAgC;IACnC,GAAG,uCAA+B;CACiD,CAAC;AAEvF;;;;;GAKG;AACU,QAAA,iCAAiC,GAAG;IAC9C,yBAAyB;IACzB,kBAAkB;IAClB,cAAc;CAC0E,CAAC;AAE5F,mEAAmE;AACtD,QAAA,gCAAgC,GAAG;IAC7C,mBAAmB;IACnB,iBAAiB;IACjB,mBAAmB;IACnB,kBAAkB;CACqE,CAAC;AAE3F,kEAAkE;AACrD,QAAA,+BAA+B,GAAG,CAAC,mBAAmB,CAAwE,CAAC;AAE5I;;;;;;GAMG;AACU,QAAA,4BAA4B,GAAG;IACzC,GAAG,wCAAgC;IACnC,GAAG,uCAA+B;CACiD,CAAC"}
@@ -12,7 +12,7 @@ import type { Project } from '../project';
12
12
  import type { TransferDocument } from '../transfer-document';
13
13
  import type { CloseModelArgs, FindNextNameArgs, OpenModelArgs, ReferenceContext, ReferenceRequest } from '../model-server';
14
14
  import type { ReferenceCandidate, ReferenceTarget } from '../model-service/reference-candidate';
15
- import type { ProjectsChangedEvent, TransferDocumentSavedEvent, TransferDocumentUpdatedEvent } from './events';
15
+ import type { ProjectsChangedEvent, TransferDocumentDeletedEvent, TransferDocumentSavedEvent, TransferDocumentsBuiltEvent, TransferDocumentUpdatedEvent } from './events';
16
16
  import type { GetModelDocumentArgs, GetProjectForUriArgs, TransferSaveDocumentArgs, WatchModelDocumentArgs, TransferUpdateDocumentArgs } from './requests';
17
17
  /**
18
18
  * Document-scoped slice of the data-server wire contract: the per-document
@@ -235,6 +235,26 @@ export interface DocumentClientProtocol<TTransfer extends TransferElement, TDiag
235
235
  * codepath, not a subscription codepath).
236
236
  */
237
237
  onDocumentSaved(event: TransferDocumentSavedEvent<TTransfer, TDiagnostic>): void;
238
+ /**
239
+ * Delivered when a document's backing file was removed. Separate from
240
+ * {@link onDocumentUpdated} for the same reason as {@link onDocumentSaved},
241
+ * and more strongly: there is no built state to deliver, and the build-phase
242
+ * path cannot report a deletion at all.
243
+ *
244
+ * Ungated, because on a browser host — where the workspace lives behind the
245
+ * head — no other source can observe a file disappearing. Recipients that
246
+ * only care about their own documents filter by URI.
247
+ */
248
+ onDocumentDeleted(event: TransferDocumentDeletedEvent): void;
249
+ /**
250
+ * Delivered once per build, naming the documents that reached the
251
+ * subscription phase and that
252
+ * nobody on this connection watches — chiefly the ones rebuilt as a cascade
253
+ * from a dependency's change, which no filesystem watcher can see because
254
+ * their own files did not change. The complement of
255
+ * {@link onDocumentUpdated}; carries URIs and no documents.
256
+ */
257
+ onDocumentsBuilt(event: TransferDocumentsBuiltEvent): void;
238
258
  }
239
259
  /**
240
260
  * Project-scoped slice of the client surface — the project-registry change
@@ -1 +1 @@
1
- {"version":3,"file":"data-server-protocol.d.ts","sourceRoot":"","sources":["../../src/data/data-server-protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,aAAa,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC3H,OAAO,KAAK,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AAChG,OAAO,KAAK,EAAE,oBAAoB,EAAE,0BAA0B,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAC;AAC/G,OAAO,KAAK,EACT,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,EAC5B,MAAM,YAAY,CAAC;AAEpB;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,sBAAsB,CAAC,SAAS,SAAS,eAAe,EAAE,WAAW,SAAS,kBAAkB,GAAG,kBAAkB;IACnI;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;IAE1F;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;IAEhG;;;;OAIG;IACH,mBAAmB,CAAC,IAAI,EAAE,0BAA0B,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;IAEpH;;;;;OAKG;IACH,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;IAEhH;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhE;;;OAGG;IACH,oBAAoB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElE;;;;;;;;;;OAUG;IACH,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAChC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO;IACtE;;;;OAIG;IACH,WAAW,IAAI,OAAO,CAAC,SAAS,QAAQ,EAAE,CAAC,CAAC;IAE5C;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC;CAC9E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,kBAAkB,CAChC,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB,EAC3D,QAAQ,SAAS,OAAO,GAAG,OAAO,CAElC,SAAQ,sBAAsB,CAAC,SAAS,EAAE,WAAW,CAAC,EAAE,qBAAqB,CAAC,QAAQ,CAAC;CAAG;AAE7F;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,uBAAuB,CAAC,SAAS,SAAS,eAAe;IACvE;;;;OAIG;IACH,uBAAuB,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,gBAAgB,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,CAAC;IAEzF;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACxD;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,sBAAsB,CAAC,SAAS,SAAS,eAAe,EAAE,WAAW,SAAS,kBAAkB,GAAG,kBAAkB;IACnI;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,4BAA4B,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG,IAAI,CAAC;IAErF;;;;;;;;;OASG;IACH,eAAe,CAAC,KAAK,EAAE,0BAA0B,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG,IAAI,CAAC;CACnF;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO;IACtE;;;;;;;;OAQG;IACH,iBAAiB,CAAC,KAAK,EAAE,oBAAoB,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;CACjE;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB,CAChC,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB,EAC3D,QAAQ,SAAS,OAAO,GAAG,OAAO,CAElC,SAAQ,sBAAsB,CAAC,SAAS,EAAE,WAAW,CAAC,EAAE,qBAAqB,CAAC,QAAQ,CAAC;CAAG"}
1
+ {"version":3,"file":"data-server-protocol.d.ts","sourceRoot":"","sources":["../../src/data/data-server-protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,aAAa,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC3H,OAAO,KAAK,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AAChG,OAAO,KAAK,EACT,oBAAoB,EACpB,4BAA4B,EAC5B,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC9B,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EACT,oBAAoB,EACpB,oBAAoB,EACpB,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,EAC5B,MAAM,YAAY,CAAC;AAEpB;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,sBAAsB,CAAC,SAAS,SAAS,eAAe,EAAE,WAAW,SAAS,kBAAkB,GAAG,kBAAkB;IACnI;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;IAE1F;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;IAEhG;;;;OAIG;IACH,mBAAmB,CAAC,IAAI,EAAE,0BAA0B,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;IAEpH;;;;;OAKG;IACH,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;IAEhH;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhE;;;OAGG;IACH,oBAAoB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElE;;;;;;;;;;OAUG;IACH,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAChC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO;IACtE;;;;OAIG;IACH,WAAW,IAAI,OAAO,CAAC,SAAS,QAAQ,EAAE,CAAC,CAAC;IAE5C;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC;CAC9E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,kBAAkB,CAChC,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB,EAC3D,QAAQ,SAAS,OAAO,GAAG,OAAO,CAElC,SAAQ,sBAAsB,CAAC,SAAS,EAAE,WAAW,CAAC,EAAE,qBAAqB,CAAC,QAAQ,CAAC;CAAG;AAE7F;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,uBAAuB,CAAC,SAAS,SAAS,eAAe;IACvE;;;;OAIG;IACH,uBAAuB,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,gBAAgB,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,CAAC;IAEzF;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACxD;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,sBAAsB,CAAC,SAAS,SAAS,eAAe,EAAE,WAAW,SAAS,kBAAkB,GAAG,kBAAkB;IACnI;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,4BAA4B,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG,IAAI,CAAC;IAErF;;;;;;;;;OASG;IACH,eAAe,CAAC,KAAK,EAAE,0BAA0B,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG,IAAI,CAAC;IAEjF;;;;;;;;;OASG;IACH,iBAAiB,CAAC,KAAK,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAE7D;;;;;;;OAOG;IACH,gBAAgB,CAAC,KAAK,EAAE,2BAA2B,GAAG,IAAI,CAAC;CAC7D;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO;IACtE;;;;;;;;OAQG;IACH,iBAAiB,CAAC,KAAK,EAAE,oBAAoB,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;CACjE;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB,CAChC,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB,EAC3D,QAAQ,SAAS,OAAO,GAAG,OAAO,CAElC,SAAQ,sBAAsB,CAAC,SAAS,EAAE,WAAW,CAAC,EAAE,qBAAqB,CAAC,QAAQ,CAAC;CAAG"}
@@ -28,10 +28,14 @@ import type { TransferDocument } from '../transfer-document';
28
28
  * from both `onDocumentUpdated` and `onDocumentSaved`. The framework's own
29
29
  * `dispatchPhaseEvent` does NOT emit `'saved'` — saves take the dedicated
30
30
  * `DataClientProtocol.onDocumentSaved` channel.
31
- * - `'deleted'` — the URI appeared in `DocumentBuilder.onUpdate`'s
32
- * `deleted` list. The backing file was removed.
31
+ *
32
+ * Deletion is deliberately NOT a member. An update event carries a built
33
+ * document, which a deleted one has none of, and the phase-driven path that
34
+ * produces these events never runs for a deleted URI — the builder drops the
35
+ * document before deriving the rebuild set. It travels as
36
+ * {@link TransferDocumentDeletedEvent} on its own channel instead.
33
37
  */
34
- export type TransferDocumentUpdateReason = 'changed' | 'rebuilt' | 'saved' | 'deleted';
38
+ export type TransferDocumentUpdateReason = 'changed' | 'rebuilt' | 'saved';
35
39
  /**
36
40
  * Delivered on the data-server when a document's content (or existence)
37
41
  * changed. Subscribers receive this via `DocumentServerProtocol.watchModelDocument`.
@@ -72,6 +76,69 @@ export interface TransferDocumentSavedEvent<TTransfer extends TransferElement, T
72
76
  }
73
77
  /** Callback shape for `DataClientProtocol.onDocumentSaved`. */
74
78
  export type TransferDocumentSavedListener<TTransfer extends TransferElement, TDiagnostic extends TransferDiagnostic = TransferDiagnostic> = (event: TransferDocumentSavedEvent<TTransfer, TDiagnostic>) => void;
79
+ /**
80
+ * Delivered on the data-server when a document's backing file was removed.
81
+ * Carries no document, and cannot: the state a
82
+ * {@link TransferDocumentUpdatedEvent} would have to carry no longer exists by
83
+ * the time anyone can be told. That is also why deletion is not a `reason` on
84
+ * the update stream — `DocumentBuilder.update` drops the document before
85
+ * deriving the rebuild set, so the phase-driven path that produces update
86
+ * events never runs for it.
87
+ *
88
+ * **Delivered for EVERY document, not only watched ones**, unlike
89
+ * `onDocumentUpdated` and `onDocumentSaved`. The test that decides which
90
+ * channels are gated is whether any OTHER source can observe the fact on the
91
+ * least capable host: a browser-hosted client's workspace lives behind the
92
+ * head, so nothing there can see a file disappear, and gating the notification
93
+ * would leave it blind. (A Theia frontend's filesystem watcher would cover it,
94
+ * which is why this is a host argument and not a structure-versus-content one.)
95
+ * A watcher is told about its own document's deletion here too, the update
96
+ * channel being silent for deletions by construction. Filter on {@link uri} if
97
+ * the receiver only cares about documents it opened.
98
+ *
99
+ * A watch survives the deletion, so a file that comes back resumes delivering
100
+ * `onDocumentUpdated` to the same subscribers with no re-subscription. A
101
+ * client that responds by closing its editor releases the watch through
102
+ * `closeModelDocument` as usual.
103
+ */
104
+ export interface TransferDocumentDeletedEvent {
105
+ /** Canonical URI of the removed document, keyed as the subscription is. */
106
+ readonly uri: string;
107
+ }
108
+ /** Callback shape for `DataClientProtocol.onDocumentDeleted`. */
109
+ export type TransferDocumentDeletedListener = (event: TransferDocumentDeletedEvent) => void;
110
+ /**
111
+ * Delivered on the data-server once per build, naming the documents that reached
112
+ * the configured subscription phase (`DataServerOptions.subscriptionPhase`,
113
+ * `Validated` by default) and that NO client on the connection is watching. Not
114
+ * the integrity-settled landmark, which is a different point and a different
115
+ * word in this framework.
116
+ *
117
+ * The complement of {@link TransferDocumentUpdatedEvent}, which is gated per
118
+ * URI: together the two cover every document a build touched. This one exists
119
+ * for the case no source outside the server can observe — a document rebuilt
120
+ * because something it DEPENDS ON changed. Its own file never changed, so a
121
+ * filesystem watcher cannot see it, and it has no subscriber, so the update
122
+ * channel does not report it. A consumer showing data derived from such a
123
+ * document (a tree label, a decorator) would otherwise hold a stale value with
124
+ * nothing to invalidate it.
125
+ *
126
+ * Carries URIs and no documents: a recipient re-reads what it displays, through
127
+ * `getModelDocument` or its own request. That keeps the bandwidth property the
128
+ * per-URI subscription exists for, without gating the message.
129
+ *
130
+ * Not sent when the set is empty, which is the normal case while editing — the
131
+ * document being edited is watched by its own editor and therefore excluded.
132
+ * Workspace initialisation sends nothing either: it does not build to the
133
+ * subscription phase. The largest message a workspace can produce is therefore
134
+ * a whole-workspace rebuild at that phase, which is one message of URIs.
135
+ */
136
+ export interface TransferDocumentsBuiltEvent {
137
+ /** Canonical URIs, keyed as subscriptions are. Never empty. */
138
+ readonly uris: readonly string[];
139
+ }
140
+ /** Callback shape for `DataClientProtocol.onDocumentsBuilt`. */
141
+ export type TransferDocumentsBuiltListener = (event: TransferDocumentsBuiltEvent) => void;
75
142
  /**
76
143
  * Why a project-change event fired. `added` — the project was newly
77
144
  * registered (descriptor discovered); `updated` — the project's
@@ -1 +1 @@
1
- {"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/data/events.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,4BAA4B,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;AAEvF;;;;;;GAMG;AACH,MAAM,WAAW,4BAA4B,CAC1C,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB;IAE3D,QAAQ,EAAE,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACnD,iEAAiE;IACjE,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,4BAA4B,CAAC;CACvC;AAED,iEAAiE;AACjE,MAAM,MAAM,+BAA+B,CACxC,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB,IAC1D,CAAC,KAAK,EAAE,4BAA4B,CAAC,SAAS,EAAE,WAAW,CAAC,KAAK,IAAI,CAAC;AAE1E;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,0BAA0B,CACxC,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB;IAE3D,QAAQ,EAAE,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACnD;;;;;OAKG;IACH,cAAc,EAAE,MAAM,CAAC;CACzB;AAED,+DAA+D;AAC/D,MAAM,MAAM,6BAA6B,CACtC,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB,IAC1D,CAAC,KAAK,EAAE,0BAA0B,CAAC,SAAS,EAAE,WAAW,CAAC,KAAK,IAAI,CAAC;AAExE;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;AAElE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,oBAAoB,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO;IACrE,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;CACvC;AAED,iEAAiE;AACjE,MAAM,MAAM,uBAAuB,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,KAAK,EAAE,oBAAoB,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC"}
1
+ {"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/data/events.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,4BAA4B,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;AAE3E;;;;;;GAMG;AACH,MAAM,WAAW,4BAA4B,CAC1C,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB;IAE3D,QAAQ,EAAE,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACnD,iEAAiE;IACjE,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,4BAA4B,CAAC;CACvC;AAED,iEAAiE;AACjE,MAAM,MAAM,+BAA+B,CACxC,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB,IAC1D,CAAC,KAAK,EAAE,4BAA4B,CAAC,SAAS,EAAE,WAAW,CAAC,KAAK,IAAI,CAAC;AAE1E;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,0BAA0B,CACxC,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB;IAE3D,QAAQ,EAAE,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACnD;;;;;OAKG;IACH,cAAc,EAAE,MAAM,CAAC;CACzB;AAED,+DAA+D;AAC/D,MAAM,MAAM,6BAA6B,CACtC,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB,IAC1D,CAAC,KAAK,EAAE,0BAA0B,CAAC,SAAS,EAAE,WAAW,CAAC,KAAK,IAAI,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,4BAA4B;IAC1C,2EAA2E;IAC3E,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACvB;AAED,iEAAiE;AACjE,MAAM,MAAM,+BAA+B,GAAG,CAAC,KAAK,EAAE,4BAA4B,KAAK,IAAI,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,2BAA2B;IACzC,+DAA+D;IAC/D,QAAQ,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAED,gEAAgE;AAChE,MAAM,MAAM,8BAA8B,GAAG,CAAC,KAAK,EAAE,2BAA2B,KAAK,IAAI,CAAC;AAE1F;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;AAElE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,oBAAoB,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO;IACrE,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;CACvC;AAED,iEAAiE;AACjE,MAAM,MAAM,uBAAuB,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,KAAK,EAAE,oBAAoB,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC"}
package/lib/errors.d.ts CHANGED
@@ -7,6 +7,16 @@
7
7
  * SPDX-License-Identifier: MIT
8
8
  ********************************************************************************/
9
9
  import { ResponseError } from 'vscode-jsonrpc';
10
+ import { type HydraniumMessageData } from './messages/primitives';
11
+ /**
12
+ * The catalogue declaration behind {@link ConflictError}'s sentence.
13
+ *
14
+ * Its English must keep containing {@link CONFLICT_ERROR_MESSAGE_MARKER}: the
15
+ * marker is tier 3 of {@link isConflictError}'s ladder, and it matches on text.
16
+ * That tier only ever works untranslated, which is why it is the last resort
17
+ * behind the numeric code rather than the primary check.
18
+ */
19
+ export declare const STALE_BASED_UPDATE: import("./messages/primitives").MessageDefinition<"Stale-based update for {uri}: expected v{expectedVersion}, server is at v{actualVersion}">;
10
20
  /**
11
21
  * Application-specific JSON-RPC error code for {@link ConflictError}.
12
22
  * Outside the reserved range (-32768 .. -32000) per JSON-RPC 2.0.
@@ -21,12 +31,12 @@ export declare const CONFLICT_ERROR_CODE = 1001;
21
31
  * Structured payload carried in {@link ConflictError.data}, and the only place
22
32
  * a post-RPC caller can read the version mismatch from.
23
33
  */
24
- export interface ConflictErrorData {
34
+ export interface ConflictErrorData extends HydraniumMessageData {
25
35
  readonly uri: string;
26
36
  /** The based-on version the caller authored against. */
27
- readonly expected: number;
37
+ readonly expectedVersion: number;
28
38
  /** The server's current text-document version at the time of the throw. */
29
- readonly actual: number;
39
+ readonly actualVersion: number;
30
40
  }
31
41
  /**
32
42
  * Thrown by `ModelService.update` / `ModelService.save` when the caller-
@@ -60,10 +70,19 @@ export interface ConflictErrorData {
60
70
  * No auto-retry or auto-merge ships by default.
61
71
  */
62
72
  export declare class ConflictError extends ResponseError<ConflictErrorData> {
63
- constructor(uri: string, expected: number, actual: number);
73
+ constructor(uri: string, expectedVersion: number, actualVersion: number);
64
74
  get uri(): string;
65
- get expected(): number;
66
- get actual(): number;
75
+ /**
76
+ * The based-on version the caller authored against.
77
+ *
78
+ * Must not be renamed to `expected`, nor its sibling to `actual`: a test
79
+ * reporter reads an error carrying both as an assertion failure, and
80
+ * vitest's formatter then ASSIGNS to them, which throws on an accessor and
81
+ * replaces the real failure with a `TypeError`.
82
+ */
83
+ get expectedVersion(): number;
84
+ /** The server's version at the time of the throw. Not `actual` — see {@link expectedVersion}. */
85
+ get actualVersion(): number;
67
86
  }
68
87
  /**
69
88
  * Type guard for {@link ConflictError}. Detection ladder:
@@ -1 +1 @@
1
- {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,OAAO,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC/B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,2EAA2E;IAC3E,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,aAAc,SAAQ,aAAa,CAAC,iBAAiB,CAAC;gBACpD,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAezD,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;CACH;AAOD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAYtE"}
1
+ {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAiB,KAAK,oBAAoB,EAAe,MAAM,uBAAuB,CAAC;AAE9F;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,+IAG9B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,OAAO,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,oBAAoB;IAC5D,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,2EAA2E;IAC3E,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;CACjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,aAAc,SAAQ,aAAa,CAAC,iBAAiB,CAAC;gBACpD,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IAgBvE,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED;;;;;;;OAOG;IACH,IAAI,eAAe,IAAI,MAAM,CAE5B;IAED,iGAAiG;IACjG,IAAI,aAAa,IAAI,MAAM,CAE1B;CACH;AAOD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAYtE"}
package/lib/errors.js CHANGED
@@ -8,9 +8,19 @@
8
8
  * SPDX-License-Identifier: MIT
9
9
  ********************************************************************************/
10
10
  Object.defineProperty(exports, "__esModule", { value: true });
11
- exports.ConflictError = exports.CONFLICT_ERROR_CODE = void 0;
11
+ exports.ConflictError = exports.CONFLICT_ERROR_CODE = exports.STALE_BASED_UPDATE = void 0;
12
12
  exports.isConflictError = isConflictError;
13
13
  const vscode_jsonrpc_1 = require("vscode-jsonrpc");
14
+ const primitives_1 = require("./messages/primitives");
15
+ /**
16
+ * The catalogue declaration behind {@link ConflictError}'s sentence.
17
+ *
18
+ * Its English must keep containing {@link CONFLICT_ERROR_MESSAGE_MARKER}: the
19
+ * marker is tier 3 of {@link isConflictError}'s ladder, and it matches on text.
20
+ * That tier only ever works untranslated, which is why it is the last resort
21
+ * behind the numeric code rather than the primary check.
22
+ */
23
+ exports.STALE_BASED_UPDATE = (0, primitives_1.defineMessage)('hydranium/protocol/stale-based-update', 'Stale-based update for {uri}: expected v{expectedVersion}, server is at v{actualVersion}');
14
24
  /**
15
25
  * Application-specific JSON-RPC error code for {@link ConflictError}.
16
26
  * Outside the reserved range (-32768 .. -32000) per JSON-RPC 2.0.
@@ -53,28 +63,38 @@ exports.CONFLICT_ERROR_CODE = 1001;
53
63
  * No auto-retry or auto-merge ships by default.
54
64
  */
55
65
  class ConflictError extends vscode_jsonrpc_1.ResponseError {
56
- constructor(uri, expected, actual) {
57
- super(exports.CONFLICT_ERROR_CODE, `Stale-based update for ${uri}: expected v${expected}, server is at v${actual}`, {
58
- uri,
59
- expected,
60
- actual
61
- });
66
+ constructor(uri, expectedVersion, actualVersion) {
67
+ const params = { uri, expectedVersion, actualVersion };
68
+ // The identity rides alongside the typed payload rather than replacing
69
+ // it: `isConflictError`'s name check is surface an adopter may bind, so
70
+ // adding the identity widens the payload rather than reshaping it.
71
+ super(exports.CONFLICT_ERROR_CODE, exports.STALE_BASED_UPDATE.format(params), { ...params, ...(0, primitives_1.messageData)(exports.STALE_BASED_UPDATE, params) });
62
72
  this.name = 'ConflictError';
63
73
  // ResponseError's constructor calls `Object.setPrototypeOf(this,
64
74
  // ResponseError.prototype)` to keep its own prototype chain intact across
65
75
  // transpilation targets; that resets us to ResponseError, hiding the
66
76
  // ConflictError-specific getters. Restore the prototype here so
67
- // `err.uri` / `.expected` / `.actual` resolve through this class.
77
+ // `err.uri` / `.expectedVersion` / `.actualVersion` resolve through this
78
+ // class.
68
79
  Object.setPrototypeOf(this, ConflictError.prototype);
69
80
  }
70
81
  get uri() {
71
82
  return this.data.uri;
72
83
  }
73
- get expected() {
74
- return this.data.expected;
84
+ /**
85
+ * The based-on version the caller authored against.
86
+ *
87
+ * Must not be renamed to `expected`, nor its sibling to `actual`: a test
88
+ * reporter reads an error carrying both as an assertion failure, and
89
+ * vitest's formatter then ASSIGNS to them, which throws on an accessor and
90
+ * replaces the real failure with a `TypeError`.
91
+ */
92
+ get expectedVersion() {
93
+ return this.data.expectedVersion;
75
94
  }
76
- get actual() {
77
- return this.data.actual;
95
+ /** The server's version at the time of the throw. Not `actual` — see {@link expectedVersion}. */
96
+ get actualVersion() {
97
+ return this.data.actualVersion;
78
98
  }
79
99
  }
80
100
  exports.ConflictError = ConflictError;
package/lib/errors.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AA2GlF,0CAYC;AArHD,mDAA+C;AAE/C;;;;;;;;GAQG;AACU,QAAA,mBAAmB,GAAG,IAAI,CAAC;AAcxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAa,aAAc,SAAQ,8BAAgC;IAChE,YAAY,GAAW,EAAE,QAAgB,EAAE,MAAc;QACtD,KAAK,CAAC,2BAAmB,EAAE,0BAA0B,GAAG,eAAe,QAAQ,mBAAmB,MAAM,EAAE,EAAE;YACzG,GAAG;YACH,QAAQ;YACR,MAAM;SACR,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,iEAAiE;QACjE,0EAA0E;QAC1E,qEAAqE;QACrE,gEAAgE;QAChE,kEAAkE;QAClE,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,GAAG;QACJ,OAAO,IAAI,CAAC,IAAK,CAAC,GAAG,CAAC;IACzB,CAAC;IAED,IAAI,QAAQ;QACT,OAAO,IAAI,CAAC,IAAK,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED,IAAI,MAAM;QACP,OAAO,IAAI,CAAC,IAAK,CAAC,MAAM,CAAC;IAC5B,CAAC;CACH;AA3BD,sCA2BC;AAED;;mCAEmC;AACnC,MAAM,6BAA6B,GAAG,yBAAyB,CAAC;AAEhE;;;;;;;;;;;;;;GAcG;AACH,SAAgB,eAAe,CAAC,KAAc;IAC3C,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IAChB,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC;IACf,CAAC;IACD,MAAM,IAAI,GAAI,KAAyC,CAAC,IAAI,CAAC;IAC7D,IAAI,IAAI,KAAK,2BAAmB,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACf,CAAC;IACD,OAAO,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,6BAA6B,CAAC,CAAC;AACrG,CAAC"}
1
+ {"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AAmIlF,0CAYC;AA7ID,mDAA+C;AAC/C,sDAA8F;AAE9F;;;;;;;GAOG;AACU,QAAA,kBAAkB,GAAG,IAAA,0BAAa,EAC5C,uCAAuC,EACvC,0FAA0F,CAC5F,CAAC;AAEF;;;;;;;;GAQG;AACU,QAAA,mBAAmB,GAAG,IAAI,CAAC;AAcxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAa,aAAc,SAAQ,8BAAgC;IAChE,YAAY,GAAW,EAAE,eAAuB,EAAE,aAAqB;QACpE,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC;QACvD,uEAAuE;QACvE,wEAAwE;QACxE,mEAAmE;QACnE,KAAK,CAAC,2BAAmB,EAAE,0BAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,MAAM,EAAE,GAAG,IAAA,wBAAW,EAAC,0BAAkB,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QACzH,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,iEAAiE;QACjE,0EAA0E;QAC1E,qEAAqE;QACrE,gEAAgE;QAChE,yEAAyE;QACzE,SAAS;QACT,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,GAAG;QACJ,OAAO,IAAI,CAAC,IAAK,CAAC,GAAG,CAAC;IACzB,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,eAAe;QAChB,OAAO,IAAI,CAAC,IAAK,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,iGAAiG;IACjG,IAAI,aAAa;QACd,OAAO,IAAI,CAAC,IAAK,CAAC,aAAa,CAAC;IACnC,CAAC;CACH;AArCD,sCAqCC;AAED;;mCAEmC;AACnC,MAAM,6BAA6B,GAAG,yBAAyB,CAAC;AAEhE;;;;;;;;;;;;;;GAcG;AACH,SAAgB,eAAe,CAAC,KAAc;IAC3C,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IAChB,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC;IACf,CAAC;IACD,MAAM,IAAI,GAAI,KAAyC,CAAC,IAAI,CAAC;IAC7D,IAAI,IAAI,KAAK,2BAAmB,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACf,CAAC;IACD,OAAO,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,6BAA6B,CAAC,CAAC;AACrG,CAAC"}
package/lib/index.d.ts CHANGED
@@ -8,6 +8,7 @@
8
8
  ********************************************************************************/
9
9
  export * from './abstract-logger';
10
10
  export * from './client';
11
+ export * from './client-ids';
11
12
  export * from './clock';
12
13
  export * from './data';
13
14
  export * from './browser-runtime';
@@ -16,6 +17,7 @@ export * from './errors';
16
17
  export * from './host-diagnostics';
17
18
  export * from './logger';
18
19
  export * from './latency-collector';
20
+ export * from './messages/primitives';
19
21
  export * from './patch-merge';
20
22
  export * from './noop-logger';
21
23
  export * from './observable-value';