@hydranium/protocol 1.0.0-next.22 → 1.0.0-next.221
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.
- package/README.md +39 -3
- package/lib/abstract-logger.d.ts +5 -0
- package/lib/abstract-logger.d.ts.map +1 -1
- package/lib/abstract-logger.js +7 -0
- package/lib/abstract-logger.js.map +1 -1
- package/lib/client/data-connection.d.ts +157 -0
- package/lib/client/data-connection.d.ts.map +1 -0
- package/lib/client/data-connection.js +237 -0
- package/lib/client/data-connection.js.map +1 -0
- package/lib/client/data-events.d.ts +13 -1
- package/lib/client/data-events.d.ts.map +1 -1
- package/lib/client/data-events.js +21 -0
- package/lib/client/data-events.js.map +1 -1
- package/lib/client/data-port.d.ts +24 -22
- package/lib/client/data-port.d.ts.map +1 -1
- package/lib/client/data-session.d.ts +471 -81
- package/lib/client/data-session.d.ts.map +1 -1
- package/lib/client/data-session.js +738 -108
- package/lib/client/data-session.js.map +1 -1
- package/lib/client/index.d.ts +14 -9
- package/lib/client/index.d.ts.map +1 -1
- package/lib/client/index.js +14 -9
- package/lib/client/index.js.map +1 -1
- package/lib/client/message-relay.d.ts +9 -3
- package/lib/client/message-relay.d.ts.map +1 -1
- package/lib/client/message-relay.js +11 -5
- package/lib/client/message-relay.js.map +1 -1
- package/lib/client/post-message-transport.d.ts +64 -3
- package/lib/client/post-message-transport.d.ts.map +1 -1
- package/lib/client/post-message-transport.js +175 -1
- package/lib/client/post-message-transport.js.map +1 -1
- package/lib/client/rpc-connection.d.ts +149 -0
- package/lib/client/rpc-connection.d.ts.map +1 -0
- package/lib/client/rpc-connection.js +202 -0
- package/lib/client/rpc-connection.js.map +1 -0
- package/lib/client-ids.d.ts +45 -0
- package/lib/client-ids.d.ts.map +1 -0
- package/lib/client-ids.js +48 -0
- package/lib/client-ids.js.map +1 -0
- package/lib/clock.d.ts +38 -0
- package/lib/clock.d.ts.map +1 -1
- package/lib/clock.js +36 -1
- package/lib/clock.js.map +1 -1
- package/lib/console-logger.d.ts +23 -0
- package/lib/console-logger.d.ts.map +1 -0
- package/lib/console-logger.js +39 -0
- package/lib/console-logger.js.map +1 -0
- package/lib/data/data-protocol-methods.d.ts +4 -4
- package/lib/data/data-protocol-methods.d.ts.map +1 -1
- package/lib/data/data-protocol-methods.js +12 -1
- package/lib/data/data-protocol-methods.js.map +1 -1
- package/lib/data/data-server-protocol.d.ts +132 -41
- package/lib/data/data-server-protocol.d.ts.map +1 -1
- package/lib/data/events.d.ts +117 -21
- package/lib/data/events.d.ts.map +1 -1
- package/lib/data/requests.d.ts +69 -11
- package/lib/data/requests.d.ts.map +1 -1
- package/lib/debouncer.d.ts.map +1 -1
- package/lib/debouncer.js.map +1 -1
- package/lib/errors.d.ts +187 -29
- package/lib/errors.d.ts.map +1 -1
- package/lib/errors.js +270 -29
- package/lib/errors.js.map +1 -1
- package/lib/glsp-request-model-args.d.ts +16 -0
- package/lib/glsp-request-model-args.d.ts.map +1 -0
- package/lib/glsp-request-model-args.js +19 -0
- package/lib/glsp-request-model-args.js.map +1 -0
- package/lib/glsp-save-model-actions.d.ts +50 -0
- package/lib/glsp-save-model-actions.d.ts.map +1 -0
- package/lib/glsp-save-model-actions.js +28 -0
- package/lib/glsp-save-model-actions.js.map +1 -0
- package/lib/index.d.ts +7 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +10 -0
- package/lib/index.js.map +1 -1
- package/lib/latency-collector.d.ts +8 -4
- package/lib/latency-collector.d.ts.map +1 -1
- package/lib/latency-collector.js.map +1 -1
- package/lib/logger.d.ts +22 -1
- package/lib/logger.d.ts.map +1 -1
- package/lib/logger.js +31 -3
- package/lib/logger.js.map +1 -1
- package/lib/messages/index.d.ts +29 -0
- package/lib/messages/index.d.ts.map +1 -0
- package/lib/messages/index.js +59 -0
- package/lib/messages/index.js.map +1 -0
- package/lib/messages/primitives.d.ts +188 -0
- package/lib/messages/primitives.d.ts.map +1 -0
- package/lib/messages/primitives.js +161 -0
- package/lib/messages/primitives.js.map +1 -0
- package/lib/model-server.d.ts +60 -13
- package/lib/model-server.d.ts.map +1 -1
- package/lib/model-server.js +4 -2
- package/lib/model-server.js.map +1 -1
- package/lib/model-service/base-version.d.ts +64 -0
- package/lib/model-service/base-version.d.ts.map +1 -0
- package/lib/model-service/base-version.js +43 -0
- package/lib/model-service/base-version.js.map +1 -0
- package/lib/model-service/index.d.ts +1 -1
- package/lib/model-service/index.d.ts.map +1 -1
- package/lib/model-service/index.js +4 -5
- package/lib/model-service/index.js.map +1 -1
- package/lib/model-service/reference-candidate.d.ts +5 -3
- package/lib/model-service/reference-candidate.d.ts.map +1 -1
- package/lib/{model-service/args.js → node/index.d.ts} +2 -3
- package/lib/node/index.d.ts.map +1 -0
- package/lib/node/index.js +29 -0
- package/lib/node/index.js.map +1 -0
- package/lib/node/process-memory.d.ts +66 -0
- package/lib/node/process-memory.d.ts.map +1 -0
- package/lib/node/process-memory.js +291 -0
- package/lib/node/process-memory.js.map +1 -0
- package/lib/noop-logger.d.ts.map +1 -1
- package/lib/noop-logger.js.map +1 -1
- package/lib/observable-value.js.map +1 -1
- package/lib/patch-merge.d.ts +35 -32
- package/lib/patch-merge.d.ts.map +1 -1
- package/lib/patch-merge.js +67 -23
- package/lib/patch-merge.js.map +1 -1
- package/lib/profile-session.d.ts +8 -4
- package/lib/profile-session.d.ts.map +1 -1
- package/lib/profile-session.js.map +1 -1
- package/lib/random-uuid.d.ts +14 -0
- package/lib/random-uuid.d.ts.map +1 -0
- package/lib/random-uuid.js +24 -0
- package/lib/random-uuid.js.map +1 -0
- package/lib/reconcile-write.d.ts +65 -0
- package/lib/reconcile-write.d.ts.map +1 -0
- package/lib/reconcile-write.js +67 -0
- package/lib/reconcile-write.js.map +1 -0
- package/lib/rpc/bind-rpc-methods.d.ts +33 -3
- package/lib/rpc/bind-rpc-methods.d.ts.map +1 -1
- package/lib/rpc/bind-rpc-methods.js +32 -3
- package/lib/rpc/bind-rpc-methods.js.map +1 -1
- package/lib/rpc/create-rpc-proxy.d.ts +10 -0
- package/lib/rpc/create-rpc-proxy.d.ts.map +1 -1
- package/lib/rpc/create-rpc-proxy.js +12 -2
- package/lib/rpc/create-rpc-proxy.js.map +1 -1
- package/lib/rpc/index.d.ts +1 -0
- package/lib/rpc/index.d.ts.map +1 -1
- package/lib/rpc/index.js +1 -0
- package/lib/rpc/index.js.map +1 -1
- package/lib/rpc/send-by-method-name.d.ts +76 -0
- package/lib/rpc/send-by-method-name.d.ts.map +1 -0
- package/lib/rpc/send-by-method-name.js +120 -0
- package/lib/rpc/send-by-method-name.js.map +1 -0
- package/lib/rpc/wire-prefix.js.map +1 -1
- package/lib/testing/catalogue-audit.d.ts +80 -0
- package/lib/testing/catalogue-audit.d.ts.map +1 -0
- package/lib/testing/catalogue-audit.js +94 -0
- package/lib/testing/catalogue-audit.js.map +1 -0
- package/lib/testing/data-doubles.d.ts +39 -15
- package/lib/testing/data-doubles.d.ts.map +1 -1
- package/lib/testing/data-doubles.js +57 -10
- package/lib/testing/data-doubles.js.map +1 -1
- package/lib/testing/fake-clock.d.ts +9 -1
- package/lib/testing/fake-clock.d.ts.map +1 -1
- package/lib/testing/fake-clock.js +54 -45
- package/lib/testing/fake-clock.js.map +1 -1
- package/lib/testing/index.d.ts +1 -0
- package/lib/testing/index.d.ts.map +1 -1
- package/lib/testing/index.js +5 -2
- package/lib/testing/index.js.map +1 -1
- package/lib/testing/node/duplex-connection.d.ts.map +1 -1
- package/lib/testing/node/duplex-connection.js +3 -2
- package/lib/testing/node/duplex-connection.js.map +1 -1
- package/lib/testing/node/duplex-stream.js.map +1 -1
- package/lib/testing/node/index.d.ts +1 -0
- package/lib/testing/node/index.d.ts.map +1 -1
- package/lib/testing/node/index.js +2 -2
- package/lib/testing/node/index.js.map +1 -1
- package/lib/testing/node/message-port-pair.d.ts +25 -0
- package/lib/testing/node/message-port-pair.d.ts.map +1 -0
- package/lib/testing/node/message-port-pair.js +26 -0
- package/lib/testing/node/message-port-pair.js.map +1 -0
- package/lib/testing/wait-for.js.map +1 -1
- package/lib/tracer.d.ts.map +1 -1
- package/lib/tracer.js.map +1 -1
- package/lib/transfer-diagnostic.d.ts +33 -0
- package/lib/transfer-diagnostic.d.ts.map +1 -1
- package/lib/transfer-diagnostic.js +23 -0
- package/lib/transfer-diagnostic.js.map +1 -1
- package/lib/transfer-document.d.ts +70 -32
- package/lib/transfer-document.d.ts.map +1 -1
- package/lib/transfer-document.js +17 -9
- package/lib/transfer-document.js.map +1 -1
- package/lib/uri.d.ts.map +1 -1
- package/lib/uri.js.map +1 -1
- package/lib/util.d.ts +8 -0
- package/lib/util.d.ts.map +1 -1
- package/lib/util.js +32 -0
- package/lib/util.js.map +1 -1
- package/package.json +29 -37
- package/src/abstract-logger.ts +8 -0
- package/src/client/data-connection.ts +315 -0
- package/src/client/data-events.ts +33 -1
- package/src/client/data-port.ts +25 -23
- package/src/client/data-session.ts +946 -126
- package/src/client/index.ts +14 -9
- package/src/client/message-relay.ts +29 -7
- package/src/client/post-message-transport.ts +219 -4
- package/src/client/rpc-connection.ts +268 -0
- package/src/client-ids.ts +49 -0
- package/src/clock.ts +56 -0
- package/src/console-logger.ts +39 -0
- package/src/data/data-protocol-methods.ts +13 -4
- package/src/data/data-server-protocol.ts +157 -41
- package/src/data/events.ts +123 -21
- package/src/data/requests.ts +74 -11
- package/src/errors.ts +322 -36
- package/src/glsp-request-model-args.ts +16 -0
- package/src/glsp-save-model-actions.ts +59 -0
- package/src/index.ts +10 -0
- package/src/latency-collector.ts +8 -3
- package/src/logger.ts +28 -2
- package/src/messages/index.ts +36 -0
- package/src/messages/primitives.ts +271 -0
- package/src/model-server.ts +63 -18
- package/src/model-service/base-version.ts +72 -0
- package/src/model-service/index.ts +4 -5
- package/src/model-service/reference-candidate.ts +5 -3
- package/src/node/index.ts +14 -0
- package/src/node/process-memory.ts +299 -0
- package/src/patch-merge.ts +97 -42
- package/src/profile-session.ts +9 -4
- package/src/random-uuid.ts +21 -0
- package/src/reconcile-write.ts +124 -0
- package/src/rpc/README.md +2 -3
- package/src/rpc/bind-rpc-methods.ts +59 -4
- package/src/rpc/create-rpc-proxy.ts +20 -2
- package/src/rpc/index.ts +1 -0
- package/src/rpc/send-by-method-name.ts +140 -0
- package/src/testing/catalogue-audit.ts +111 -0
- package/src/testing/data-doubles.ts +141 -25
- package/src/testing/fake-clock.ts +62 -47
- package/src/testing/index.ts +5 -2
- package/src/testing/node/duplex-connection.ts +3 -2
- package/src/testing/node/index.ts +2 -2
- package/src/testing/node/message-port-pair.ts +40 -0
- package/src/transfer-diagnostic.ts +40 -0
- package/src/transfer-document.ts +87 -34
- package/src/util.ts +33 -0
- package/lib/model-service/args.d.ts +0 -64
- package/lib/model-service/args.d.ts.map +0 -1
- package/lib/model-service/args.js.map +0 -1
- package/src/model-service/args.ts +0 -67
package/README.md
CHANGED
|
@@ -60,15 +60,51 @@ names, a worked example — is in
|
|
|
60
60
|
@hydranium/protocol # transfer documents, references, RPC machinery
|
|
61
61
|
@hydranium/protocol/data # DataServerProtocol / DataClientProtocol
|
|
62
62
|
@hydranium/protocol/client # the host-neutral client tier
|
|
63
|
-
@hydranium/protocol/
|
|
63
|
+
@hydranium/protocol/node # process memory and heap-snapshot helpers
|
|
64
|
+
@hydranium/protocol/testing # test doubles, waiters, catalogue audit
|
|
64
65
|
@hydranium/protocol/testing/node # the Node-only doubles
|
|
65
66
|
```
|
|
66
67
|
|
|
67
68
|
The root barrel re-exports `data` and `client`, so those two subpaths buy a
|
|
68
|
-
narrower surface rather than reach; `testing`
|
|
69
|
-
|
|
69
|
+
narrower surface rather than reach; `node` and `testing` are only reachable by
|
|
70
|
+
their own specifiers, which keeps `node:*` imports out of a browser bundle and
|
|
71
|
+
the doubles out of a production bundle. The RPC
|
|
70
72
|
machinery documents itself in [`src/rpc/README.md`](./src/rpc/README.md).
|
|
71
73
|
|
|
74
|
+
### Auditing a translation catalogue
|
|
75
|
+
|
|
76
|
+
An adopter with i18n has one failure mode nothing else catches: a catalogue key
|
|
77
|
+
naming no declared code falls back to the English, which is byte-identical to
|
|
78
|
+
the deliberately-partial behaviour every adopter relies on. So a typo is
|
|
79
|
+
invisible at runtime, and `theia nls-extract` reports what the source declares
|
|
80
|
+
rather than whether a catalogue matches it.
|
|
81
|
+
|
|
82
|
+
`@hydranium/protocol/testing` ships the audit for it — call it from your own
|
|
83
|
+
test, over your own barrels:
|
|
84
|
+
|
|
85
|
+
<!-- snippet-preamble
|
|
86
|
+
import { flattenCatalogue, findUndeclaredCodes, findSharedCodes } from '@hydranium/protocol/testing';
|
|
87
|
+
import * as protocolMessages from '@hydranium/protocol';
|
|
88
|
+
declare const readFileSync: (path: string, encoding: string) => string;
|
|
89
|
+
declare const expect: (actual: unknown) => { toEqual(expected: unknown): void };
|
|
90
|
+
-->
|
|
91
|
+
|
|
92
|
+
```ts
|
|
93
|
+
const keys = Object.keys(flattenCatalogue(JSON.parse(readFileSync('nls/de.json', 'utf-8'))));
|
|
94
|
+
|
|
95
|
+
// Every key names a code some barrel declares. `exemptPrefixes` is for keys no
|
|
96
|
+
// barrel CAN declare — a host mechanism taking its key as an inline literal.
|
|
97
|
+
expect(findUndeclaredCodes(keys, [protocolMessages])).toEqual([]);
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
`flattenCatalogue` joins nested keys with `/` (the separator a code already
|
|
101
|
+
uses, and what Theia does to a nested catalogue) and drops `_`-prefixed note
|
|
102
|
+
keys, so a flat server-side catalogue and a nested host-side one both go through
|
|
103
|
+
it. `findSharedCodes` covers the other half: exactly one side renders a given
|
|
104
|
+
message, so two catalogues holding one code are two authorities over one
|
|
105
|
+
sentence — assert both key sets non-empty first, since an empty one satisfies
|
|
106
|
+
disjointness while proving nothing.
|
|
107
|
+
|
|
72
108
|
## Status
|
|
73
109
|
|
|
74
110
|
Alpha — pre-v0. The package is being populated incrementally, and its API is
|
package/lib/abstract-logger.d.ts
CHANGED
|
@@ -35,6 +35,11 @@ export declare abstract class AbstractLogger implements Logger {
|
|
|
35
35
|
protected clock(): Clock;
|
|
36
36
|
/** Render the current wall-clock instant as `HH:MM:SS.mmm`, sourced from {@link clock}. */
|
|
37
37
|
protected timestamp(): string;
|
|
38
|
+
/**
|
|
39
|
+
* The `[Label - HH:MM:SS.mmm] [component]` prefix every sink starts a line
|
|
40
|
+
* with. The label is padded to the widest, so timestamps line up across sinks.
|
|
41
|
+
*/
|
|
42
|
+
protected formatLinePrefix(label: string): string;
|
|
38
43
|
error(message?: string, ...args: unknown[]): this;
|
|
39
44
|
warn(message?: string, ...args: unknown[]): this;
|
|
40
45
|
info(message?: string, ...args: unknown[]): this;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"abstract-logger.d.ts","sourceRoot":"","sources":["../src/abstract-logger.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,KAAK,KAAK,EAAe,MAAM,SAAS,CAAC;AAClD,OAAO,EAAwB,KAAK,QAAQ,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,MAAM,UAAU,CAAC;AAK1F;;;;;;;;;;;;GAYG;AACH,8BAAsB,cAAe,YAAW,MAAM;IACvC,SAAS,CAAC,SAAS,CAAC,EAAE,MAAM;
|
|
1
|
+
{"version":3,"file":"abstract-logger.d.ts","sourceRoot":"","sources":["../src/abstract-logger.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,KAAK,KAAK,EAAe,MAAM,SAAS,CAAC;AAClD,OAAO,EAAwB,KAAK,QAAQ,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,MAAM,UAAU,CAAC;AAK1F;;;;;;;;;;;;GAYG;AACH,8BAAsB,cAAe,YAAW,MAAM;IACvC,SAAS,CAAC,SAAS,CAAC,EAAE,MAAM;IAAxC,YAAsB,SAAS,CAAC,EAAE,MAAM,YAAA,EAAI;IAE5C;;;;;;;OAOG;IACH,SAAS,CAAC,KAAK,IAAI,KAAK,CAEvB;IAED,2FAA2F;IAC3F,SAAS,CAAC,SAAS,IAAI,MAAM,CAE5B;IAED;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEhD;IAED,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAGhD;IACD,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAG/C;IACD,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAG/C;IACD,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAGhD;IACD,uFAAuF;IACvF,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAGhD;IACD,4EAA4E;IAC5E,GAAG,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAG9C;IAED,+EAA+E;IAC/E,KAAK,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAKpD;IAED,qDAAqD;IACrD,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAE3B;IAED,uFAAuF;IACvF,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAE3B;IAED,kFAAkF;IAClF,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAE5B;IAED;;;OAGG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAEzB;IAED,yFAAyF;IACzF,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,GAAE,SAAS,OAAO,EAAO,EAAE,KAAK,SAAsB,GAAG,IAAI,CAKlH;IAED,gGAAgG;IAChG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,OAAO,EAAE,GAAG,IAAI,CAAC;IAEzG,qFAAqF;IACrF,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CACrD"}
|
package/lib/abstract-logger.js
CHANGED
|
@@ -46,6 +46,13 @@ class AbstractLogger {
|
|
|
46
46
|
timestamp() {
|
|
47
47
|
return logger_1.Format.timestamp(new Date(this.clock().now()));
|
|
48
48
|
}
|
|
49
|
+
/**
|
|
50
|
+
* The `[Label - HH:MM:SS.mmm] [component]` prefix every sink starts a line
|
|
51
|
+
* with. The label is padded to the widest, so timestamps line up across sinks.
|
|
52
|
+
*/
|
|
53
|
+
formatLinePrefix(label) {
|
|
54
|
+
return `[${label.padEnd(5)} - ${this.timestamp()}]${this.component ? ` [${this.component}]` : ''}`;
|
|
55
|
+
}
|
|
49
56
|
error(message, ...args) {
|
|
50
57
|
this.send('error', message, args);
|
|
51
58
|
return this;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"abstract-logger.js","sourceRoot":"","sources":["../src/abstract-logger.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AAElF,mCAAkD;AAClD,qCAA0F;AAE1F,uHAAuH;AACvH,MAAM,WAAW,GAAG,IAAI,mBAAW,EAAE,CAAC;AAEtC;;;;;;;;;;;;GAYG;AACH,
|
|
1
|
+
{"version":3,"file":"abstract-logger.js","sourceRoot":"","sources":["../src/abstract-logger.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AAElF,mCAAkD;AAClD,qCAA0F;AAE1F,uHAAuH;AACvH,MAAM,WAAW,GAAG,IAAI,mBAAW,EAAE,CAAC;AAEtC;;;;;;;;;;;;GAYG;AACH;IACyB,SAAS;IAA/B,YAAsB,SAAkB;yBAAlB,SAAS;IAAY,CAAC;IAE5C;;;;;;;OAOG;IACO,KAAK;QACZ,OAAO,WAAW,CAAC;IACtB,CAAC;IAED,2FAA2F;IACjF,SAAS;QAChB,OAAO,eAAM,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACO,gBAAgB,CAAC,KAAa;QACrC,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IACtG,CAAC;IAED,KAAK,CAAC,OAAgB,EAAE,GAAG,IAAe;QACvC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACf,CAAC;IACD,IAAI,CAAC,OAAgB,EAAE,GAAG,IAAe;QACtC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IACf,CAAC;IACD,IAAI,CAAC,OAAgB,EAAE,GAAG,IAAe;QACtC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IACf,CAAC;IACD,KAAK,CAAC,OAAgB,EAAE,GAAG,IAAe;QACvC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACf,CAAC;IACD,uFAAuF;IACvF,KAAK,CAAC,OAAgB,EAAE,GAAG,IAAe;QACvC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACf,CAAC;IACD,4EAA4E;IAC5E,GAAG,CAAC,OAAgB,EAAE,GAAG,IAAe;QACrC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC;IACf,CAAC;IAED,+EAA+E;IAC/E,KAAK,CAAC,SAAuB,EAAE,OAAe;QAC3C,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED,qDAAqD;IACrD,GAAG,CAAC,SAAiB;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,uFAAuF;IACvF,GAAG,CAAC,SAAiB;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,OAAO,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACxF,CAAC;IAED,kFAAkF;IAClF,IAAI,CAAC,SAAiB;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,MAAM,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACvF,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,GAAW;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAED,yFAAyF;IAC/E,IAAI,CAAC,KAAe,EAAE,OAAgB,EAAE,IAAI,GAAuB,EAAE,EAAE,KAAK,GAAG,qBAAY,CAAC,KAAK,CAAC;QACzG,IAAI,CAAC,OAAO,IAAI,CAAC,eAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7C,OAAO;QACV,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;CAOH"}
|
|
@@ -0,0 +1,157 @@
|
|
|
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
|
+
import { Emitter, type Event } from 'vscode-jsonrpc';
|
|
10
|
+
import { type DataClientProtocol, type DataServerProtocol, type DiagnosticOf, type ProjectOf, type TransferDocumentDirtyChangedEvent, type TransferDocumentUpdatedEvent } from '../data';
|
|
11
|
+
import type { TransferElement } from '../transfer-element';
|
|
12
|
+
import { DataEvents } from './data-events';
|
|
13
|
+
import type { DataPort } from './data-port';
|
|
14
|
+
import { DataSession, type DataSessionFactory } from './data-session';
|
|
15
|
+
import { RpcConnection, type RpcConnectionLifecycle } from './rpc-connection';
|
|
16
|
+
/** Options for {@link DataConnection}. */
|
|
17
|
+
export interface DataConnectionOptions<TTransfer extends TransferElement = TransferElement, TServer extends DataServerProtocol<TTransfer, DiagnosticOf<TServer>> = DataServerProtocol<TTransfer>> extends RpcConnectionLifecycle {
|
|
18
|
+
/**
|
|
19
|
+
* Wire namespace the server is addressed under. Defaults to the
|
|
20
|
+
* framework's {@link DATA_SERVER_WIRE_PREFIX}, which is what an unmodified
|
|
21
|
+
* `DataServer` binds. Override only alongside the server's own
|
|
22
|
+
* `methodNamespace` option — a mismatch turns every request into
|
|
23
|
+
* "Unhandled method" rather than failing at wire-up.
|
|
24
|
+
*/
|
|
25
|
+
readonly methodNamespace?: string;
|
|
26
|
+
/** Builds the sessions `createSession` hands out. Defaults to a plain {@link DataSession}. */
|
|
27
|
+
readonly sessionFactory?: DataSessionFactory<TTransfer, TServer>;
|
|
28
|
+
}
|
|
29
|
+
/** {@link DataConnectionOptions} for a client that does not speak {@link DataClientProtocol}. */
|
|
30
|
+
export interface DataConnectionOptionsWithMethods<TClient extends object, TTransfer extends TransferElement = TransferElement, TServer extends DataServerProtocol<TTransfer, DiagnosticOf<TServer>> = DataServerProtocol<TTransfer>> extends DataConnectionOptions<TTransfer, TServer> {
|
|
31
|
+
/**
|
|
32
|
+
* Method names of the client to bind as inbound handlers. Declare it
|
|
33
|
+
* `as const satisfies ReadonlyArray<keyof YourClient & string>` so the list
|
|
34
|
+
* cannot drift from the interface.
|
|
35
|
+
*/
|
|
36
|
+
readonly clientMethods: readonly (keyof TClient & string)[];
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Trailing constructor arguments, required only when the client cannot take
|
|
40
|
+
* the framework's default method list.
|
|
41
|
+
*
|
|
42
|
+
* `bindRpcMethods` throws for a name the target does not implement, so a
|
|
43
|
+
* request/response-only client binding the default list fails at wire-up. The
|
|
44
|
+
* conditional turns that into a compile error.
|
|
45
|
+
*/
|
|
46
|
+
export type DataConnectionArgs<TTransfer extends TransferElement, TClient extends object, TServer extends DataServerProtocol<TTransfer, DiagnosticOf<TServer>> = DataServerProtocol<TTransfer>> = TClient extends DataClientProtocol<TTransfer> ? [options?: DataConnectionOptions<TTransfer, TServer> & Partial<DataConnectionOptionsWithMethods<TClient, TTransfer, TServer>>] : [options: DataConnectionOptionsWithMethods<TClient, TTransfer, TServer>];
|
|
47
|
+
/**
|
|
48
|
+
* A {@link RpcConnection} to the data head, carrying as many participants as
|
|
49
|
+
* the host has interested parties.
|
|
50
|
+
*
|
|
51
|
+
* Document operations live on the participants rather than here: they carry a
|
|
52
|
+
* `clientId`, which identifies a participant rather than a wire, and the server
|
|
53
|
+
* keys its opens and watches per `(uri, clientId)`. Two parties sharing one
|
|
54
|
+
* identity cannot tell each other's writes from their own echoes.
|
|
55
|
+
*
|
|
56
|
+
* Generic over the transfer root so this file names no grammar. An adopter
|
|
57
|
+
* binds the concrete root (or the union of them, for a multi-grammar head) at
|
|
58
|
+
* its own edge.
|
|
59
|
+
*/
|
|
60
|
+
export declare class DataConnection<TTransfer extends TransferElement, TServer extends DataServerProtocol<TTransfer, DiagnosticOf<TServer>> = DataServerProtocol<TTransfer>, TClient extends object = DataClientProtocol<TTransfer>> extends RpcConnection<TServer, TClient> {
|
|
61
|
+
protected readonly sessions: Set<DataSession<TTransfer, TServer>>;
|
|
62
|
+
protected readonly sessionFactory: DataSessionFactory<TTransfer, TServer>;
|
|
63
|
+
protected readonly createSessionEmitter: Emitter<DataSession<TTransfer, TServer>>;
|
|
64
|
+
/**
|
|
65
|
+
* Fires with each session {@link createSession} starts, before it returns,
|
|
66
|
+
* so a listener sees every session a caller can. A session started before
|
|
67
|
+
* the listener subscribed is in {@link liveSessions}.
|
|
68
|
+
*/
|
|
69
|
+
readonly onDidCreateSession: Event<DataSession<TTransfer, TServer>>;
|
|
70
|
+
/**
|
|
71
|
+
* Per URI, the `dirty` the client was last told since a session of this
|
|
72
|
+
* connection last opened the URI. A restore tells the client its answer
|
|
73
|
+
* only where it differs, so the client hears changes and nothing else; see
|
|
74
|
+
* {@link DataSessionHost.restoreDirty}.
|
|
75
|
+
*/
|
|
76
|
+
protected readonly dirtyStates: Map<string, boolean>;
|
|
77
|
+
/** Backs each session's {@link DataSessionHost.onDidChangeDirty}. */
|
|
78
|
+
protected readonly dirtyChangedEmitter: Emitter<TransferDocumentDirtyChangedEvent>;
|
|
79
|
+
/** Backs each session's {@link DataSessionHost.onDidUpdateDocument}. */
|
|
80
|
+
protected readonly documentUpdatedEmitter: Emitter<TransferDocumentUpdatedEvent<TTransfer, DiagnosticOf<TServer>>>;
|
|
81
|
+
constructor(port: DataPort, client: TClient, ...rest: DataConnectionArgs<TTransfer, TClient, TServer>);
|
|
82
|
+
/**
|
|
83
|
+
* The sessions of this connection that have not ended, in the order they
|
|
84
|
+
* started. A session is listed until its `onDidDispose` fires, or until
|
|
85
|
+
* {@link dispose} clears the list.
|
|
86
|
+
*/
|
|
87
|
+
get liveSessions(): readonly DataSession<TTransfer, TServer>[];
|
|
88
|
+
/**
|
|
89
|
+
* Start a participant on this connection, registered with the server under a
|
|
90
|
+
* fresh id, `label` plus `#` plus a random UUID, or under `clientId` when
|
|
91
|
+
* given. Pass a `label` naming the participant; without one it is
|
|
92
|
+
* `session`. Synchronous: the registration is sent at once, and the
|
|
93
|
+
* session's calls wait for it. The server refuses an id live anywhere in
|
|
94
|
+
* its process, and every call of that session then rejects with an error
|
|
95
|
+
* `isDuplicateClientIdError` recognises; an id the server reserves beyond
|
|
96
|
+
* {@link FRAMEWORK_CLIENT_IDS}, such as the integrity author, with one
|
|
97
|
+
* `isReservedClientIdError` recognises. Only the code crosses the wire, so
|
|
98
|
+
* test with those guards rather than `instanceof`.
|
|
99
|
+
*
|
|
100
|
+
* Throws a {@link ReservedClientIdError} for an id in
|
|
101
|
+
* {@link FRAMEWORK_CLIENT_IDS} — those are authors the SERVER emits rather
|
|
102
|
+
* than participants, so a session holding one would read the framework's
|
|
103
|
+
* own broadcasts as its own echoes and drop them — and a
|
|
104
|
+
* {@link DuplicateClientIdError} for an id a live session on this
|
|
105
|
+
* connection already holds.
|
|
106
|
+
*/
|
|
107
|
+
createSession(label?: string, clientId?: string): DataSession<TTransfer, TServer>;
|
|
108
|
+
/**
|
|
109
|
+
* The client, with its `onDocumentDirtyChanged` passing through
|
|
110
|
+
* {@link deliverDirty} first, so {@link dirtyStates} holds what the server
|
|
111
|
+
* told it, and every session hears it through {@link dirtyChangedEmitter};
|
|
112
|
+
* and with its `onDocumentUpdated` heard by every session through
|
|
113
|
+
* {@link documentUpdatedEmitter} first. Every other bound method forwards
|
|
114
|
+
* to the client unchanged, and one the client lacks stays absent, so the
|
|
115
|
+
* binding still refuses it.
|
|
116
|
+
*/
|
|
117
|
+
protected localTarget(): TClient;
|
|
118
|
+
/** Record `event` in {@link dirtyStates} and hand it to the client. */
|
|
119
|
+
protected deliverDirty(event: TransferDocumentDirtyChangedEvent): void;
|
|
120
|
+
/**
|
|
121
|
+
* After the transport dropped, reconnect on the next macrotask for the
|
|
122
|
+
* sessions with documents open, so they re-watch and follow their documents
|
|
123
|
+
* again without waiting for a call of their own; a session with nothing
|
|
124
|
+
* open restores on its next call. Nothing is scheduled once this connection
|
|
125
|
+
* is disposed, which drops its generation too.
|
|
126
|
+
*/
|
|
127
|
+
protected dropGeneration(): void;
|
|
128
|
+
/**
|
|
129
|
+
* Sessions are detached rather than disposed: the server ends every session
|
|
130
|
+
* on a connection it sees close, so ending each one first sends requests
|
|
131
|
+
* over a connection this call is about to dispose.
|
|
132
|
+
*/
|
|
133
|
+
dispose(): void;
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* A {@link DataConnection} that brings its own {@link DataEvents}, so a host
|
|
137
|
+
* with several interested parties does not have to supply one.
|
|
138
|
+
*
|
|
139
|
+
* **The client slot holds exactly one object, and that is why this exists.**
|
|
140
|
+
* `createRpcProxy` binds a single `localTarget`, and underneath a method name
|
|
141
|
+
* maps to one handler — a second registration replaces the first silently. So a
|
|
142
|
+
* properties panel and a tree cannot both be the client; one fan-out sits in the
|
|
143
|
+
* slot and both subscribe to it.
|
|
144
|
+
*
|
|
145
|
+
* Use {@link DataConnection} directly instead when the client is yours: an
|
|
146
|
+
* adopter service that implements the protocol plus its own methods, a single
|
|
147
|
+
* consumer that IS the client, or a request/response-only client that binds
|
|
148
|
+
* nothing.
|
|
149
|
+
*/
|
|
150
|
+
export declare class DataConnectionWithEvents<TTransfer extends TransferElement, TServer extends DataServerProtocol<TTransfer, DiagnosticOf<TServer>> = DataServerProtocol<TTransfer>> extends DataConnection<TTransfer, TServer, DataEvents<TTransfer, DiagnosticOf<TServer>, ProjectOf<TServer>>> {
|
|
151
|
+
/** Server pushes, fanned out to as many local listeners as the host has. */
|
|
152
|
+
readonly events: DataEvents<TTransfer, DiagnosticOf<TServer>, ProjectOf<TServer>>;
|
|
153
|
+
constructor(port: DataPort, options?: DataConnectionOptions<TTransfer, TServer>);
|
|
154
|
+
/** Disposes the fan-out it created, which no caller else holds. */
|
|
155
|
+
dispose(): void;
|
|
156
|
+
}
|
|
157
|
+
//# sourceMappingURL=data-connection.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"data-connection.d.ts","sourceRoot":"","sources":["../../src/client/data-connection.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAErD,OAAO,EAGJ,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,iCAAiC,EACtC,KAAK,4BAA4B,EACnC,MAAM,SAAS,CAAC;AAGjB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,KAAK,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAE9E,0CAA0C;AAC1C,MAAM,WAAW,qBAAqB,CACnC,SAAS,SAAS,eAAe,GAAG,eAAe,EACnD,OAAO,SAAS,kBAAkB,CAAC,SAAS,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,kBAAkB,CAAC,SAAS,CAAC,CACrG,SAAQ,sBAAsB;IAC7B;;;;;;OAMG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,8FAA8F;IAC9F,QAAQ,CAAC,cAAc,CAAC,EAAE,kBAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;CACnE;AAED,iGAAiG;AACjG,MAAM,WAAW,gCAAgC,CAC9C,OAAO,SAAS,MAAM,EACtB,SAAS,SAAS,eAAe,GAAG,eAAe,EACnD,OAAO,SAAS,kBAAkB,CAAC,SAAS,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,kBAAkB,CAAC,SAAS,CAAC,CACrG,SAAQ,qBAAqB,CAAC,SAAS,EAAE,OAAO,CAAC;IAChD;;;;OAIG;IACH,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,EAAE,CAAC;CAC9D;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,CAC3B,SAAS,SAAS,eAAe,EACjC,OAAO,SAAS,MAAM,EACtB,OAAO,SAAS,kBAAkB,CAAC,SAAS,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,kBAAkB,CAAC,SAAS,CAAC,IAEpG,OAAO,SAAS,kBAAkB,CAAC,SAAS,CAAC,GACxC,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,gCAAgC,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,GAC9H,CAAC,OAAO,EAAE,gCAAgC,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;AAEjF;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc,CACxB,SAAS,SAAS,eAAe,EACjC,OAAO,SAAS,kBAAkB,CAAC,SAAS,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,kBAAkB,CAAC,SAAS,CAAC,EACpG,OAAO,SAAS,MAAM,GAAG,kBAAkB,CAAC,SAAS,CAAC,CACvD,SAAQ,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC;IACtC,SAAS,CAAC,QAAQ,CAAC,QAAQ,uCAA8C;IACzE,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,kBAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC1E,SAAS,CAAC,QAAQ,CAAC,oBAAoB,2CAAkD;IACzF;;;;OAIG;IACH,QAAQ,CAAC,kBAAkB,EAAE,KAAK,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAmC;IACtG;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,WAAW,uBAA8B;IAC5D,qEAAqE;IACrE,SAAS,CAAC,QAAQ,CAAC,mBAAmB,6CAAoD;IAC1F,wEAAwE;IACxE,SAAS,CAAC,QAAQ,CAAC,sBAAsB,0EAAiF;IAE1H,YAAY,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,kBAAkB,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,EAcpG;IAED;;;;OAIG;IACH,IAAI,YAAY,IAAI,SAAS,WAAW,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,CAE7D;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,KAAK,SAAY,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,SAAS,EAAE,OAAO,CAAC,CAkCnF;IAED;;;;;;;;OAQG;IACH,UAAmB,WAAW,IAAI,OAAO,CA4BxC;IAED,uEAAuE;IACvE,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,iCAAiC,GAAG,IAAI,CAIrE;IAED;;;;;;OAMG;IACH,UAAmB,cAAc,IAAI,IAAI,CAUxC;IAED;;;;OAIG;IACM,OAAO,IAAI,IAAI,CAUvB;CACH;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,wBAAwB,CAClC,SAAS,SAAS,eAAe,EACjC,OAAO,SAAS,kBAAkB,CAAC,SAAS,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,kBAAkB,CAAC,SAAS,CAAC,CACrG,SAAQ,cAAc,CAAC,SAAS,EAAE,OAAO,EAAE,UAAU,CAAC,SAAS,EAAE,YAAY,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3G,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,SAAS,EAAE,YAAY,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IAElF,YAAY,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,qBAAqB,CAAC,SAAS,EAAE,OAAO,CAAC,EAM9E;IAED,mEAAmE;IAC1D,OAAO,IAAI,IAAI,CAGvB;CACH"}
|
|
@@ -0,0 +1,237 @@
|
|
|
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.DataConnectionWithEvents = exports.DataConnection = void 0;
|
|
12
|
+
const vscode_jsonrpc_1 = require("vscode-jsonrpc");
|
|
13
|
+
const client_ids_1 = require("../client-ids");
|
|
14
|
+
const data_1 = require("../data");
|
|
15
|
+
const errors_1 = require("../errors");
|
|
16
|
+
const random_uuid_1 = require("../random-uuid");
|
|
17
|
+
const data_events_1 = require("./data-events");
|
|
18
|
+
const data_session_1 = require("./data-session");
|
|
19
|
+
const rpc_connection_1 = require("./rpc-connection");
|
|
20
|
+
/**
|
|
21
|
+
* A {@link RpcConnection} to the data head, carrying as many participants as
|
|
22
|
+
* the host has interested parties.
|
|
23
|
+
*
|
|
24
|
+
* Document operations live on the participants rather than here: they carry a
|
|
25
|
+
* `clientId`, which identifies a participant rather than a wire, and the server
|
|
26
|
+
* keys its opens and watches per `(uri, clientId)`. Two parties sharing one
|
|
27
|
+
* identity cannot tell each other's writes from their own echoes.
|
|
28
|
+
*
|
|
29
|
+
* Generic over the transfer root so this file names no grammar. An adopter
|
|
30
|
+
* binds the concrete root (or the union of them, for a multi-grammar head) at
|
|
31
|
+
* its own edge.
|
|
32
|
+
*/
|
|
33
|
+
class DataConnection extends rpc_connection_1.RpcConnection {
|
|
34
|
+
sessions = new Set();
|
|
35
|
+
sessionFactory;
|
|
36
|
+
createSessionEmitter = new vscode_jsonrpc_1.Emitter();
|
|
37
|
+
/**
|
|
38
|
+
* Fires with each session {@link createSession} starts, before it returns,
|
|
39
|
+
* so a listener sees every session a caller can. A session started before
|
|
40
|
+
* the listener subscribed is in {@link liveSessions}.
|
|
41
|
+
*/
|
|
42
|
+
onDidCreateSession = this.createSessionEmitter.event;
|
|
43
|
+
/**
|
|
44
|
+
* Per URI, the `dirty` the client was last told since a session of this
|
|
45
|
+
* connection last opened the URI. A restore tells the client its answer
|
|
46
|
+
* only where it differs, so the client hears changes and nothing else; see
|
|
47
|
+
* {@link DataSessionHost.restoreDirty}.
|
|
48
|
+
*/
|
|
49
|
+
dirtyStates = new Map();
|
|
50
|
+
/** Backs each session's {@link DataSessionHost.onDidChangeDirty}. */
|
|
51
|
+
dirtyChangedEmitter = new vscode_jsonrpc_1.Emitter();
|
|
52
|
+
/** Backs each session's {@link DataSessionHost.onDidUpdateDocument}. */
|
|
53
|
+
documentUpdatedEmitter = new vscode_jsonrpc_1.Emitter();
|
|
54
|
+
constructor(port, client, ...rest) {
|
|
55
|
+
const [options = {}] = rest;
|
|
56
|
+
super(port, client, {
|
|
57
|
+
methodNamespace: options.methodNamespace ?? data_1.DATA_SERVER_WIRE_PREFIX,
|
|
58
|
+
// The default is reachable only where `TClient` satisfies
|
|
59
|
+
// `DataClientProtocol`, which the constructor's conditional enforces;
|
|
60
|
+
// the compiler cannot carry that through to the generic parameter.
|
|
61
|
+
clientMethods: options.clientMethods ?? data_1.DATA_CLIENT_PROTOCOL_METHODS,
|
|
62
|
+
lifecycle: options
|
|
63
|
+
});
|
|
64
|
+
this.sessionFactory =
|
|
65
|
+
options.sessionFactory ?? ((clientId, host, label) => new data_session_1.DataSession(clientId, host, label));
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* The sessions of this connection that have not ended, in the order they
|
|
69
|
+
* started. A session is listed until its `onDidDispose` fires, or until
|
|
70
|
+
* {@link dispose} clears the list.
|
|
71
|
+
*/
|
|
72
|
+
get liveSessions() {
|
|
73
|
+
return [...this.sessions];
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Start a participant on this connection, registered with the server under a
|
|
77
|
+
* fresh id, `label` plus `#` plus a random UUID, or under `clientId` when
|
|
78
|
+
* given. Pass a `label` naming the participant; without one it is
|
|
79
|
+
* `session`. Synchronous: the registration is sent at once, and the
|
|
80
|
+
* session's calls wait for it. The server refuses an id live anywhere in
|
|
81
|
+
* its process, and every call of that session then rejects with an error
|
|
82
|
+
* `isDuplicateClientIdError` recognises; an id the server reserves beyond
|
|
83
|
+
* {@link FRAMEWORK_CLIENT_IDS}, such as the integrity author, with one
|
|
84
|
+
* `isReservedClientIdError` recognises. Only the code crosses the wire, so
|
|
85
|
+
* test with those guards rather than `instanceof`.
|
|
86
|
+
*
|
|
87
|
+
* Throws a {@link ReservedClientIdError} for an id in
|
|
88
|
+
* {@link FRAMEWORK_CLIENT_IDS} — those are authors the SERVER emits rather
|
|
89
|
+
* than participants, so a session holding one would read the framework's
|
|
90
|
+
* own broadcasts as its own echoes and drop them — and a
|
|
91
|
+
* {@link DuplicateClientIdError} for an id a live session on this
|
|
92
|
+
* connection already holds.
|
|
93
|
+
*/
|
|
94
|
+
createSession(label = 'session', clientId) {
|
|
95
|
+
this.assertLive();
|
|
96
|
+
const id = clientId ?? `${label}#${(0, random_uuid_1.randomUuid)()}`;
|
|
97
|
+
if (client_ids_1.FRAMEWORK_CLIENT_IDS.includes(id)) {
|
|
98
|
+
throw new errors_1.ReservedClientIdError(id);
|
|
99
|
+
}
|
|
100
|
+
if ([...this.sessions].some(session => session.clientId === id)) {
|
|
101
|
+
throw new errors_1.DuplicateClientIdError(id);
|
|
102
|
+
}
|
|
103
|
+
const session = this.sessionFactory(id, {
|
|
104
|
+
connected: () => this.connected(),
|
|
105
|
+
reportError: (error, reported) => this.reportError(error, reported),
|
|
106
|
+
restoreDirty: event => {
|
|
107
|
+
if (this.dirtyStates.get(event.uri) !== (event.text?.dirty ?? false)) {
|
|
108
|
+
this.deliverDirty(event);
|
|
109
|
+
}
|
|
110
|
+
},
|
|
111
|
+
forgetDirty: uri => this.dirtyStates.delete(uri),
|
|
112
|
+
onDidChangeDirty: this.dirtyChangedEmitter.event,
|
|
113
|
+
onDidUpdateDocument: this.documentUpdatedEmitter.event
|
|
114
|
+
}, label);
|
|
115
|
+
this.sessions.add(session);
|
|
116
|
+
// Subscribed before the session is handed out, so the id is free again
|
|
117
|
+
// on this connection by the time any caller's listener runs.
|
|
118
|
+
session.onDidDispose(() => this.sessions.delete(session));
|
|
119
|
+
// A failure reaches the session's own calls, which wait for the same
|
|
120
|
+
// registration; caught here only so it is not also reported unhandled.
|
|
121
|
+
session.connected().catch(() => undefined);
|
|
122
|
+
this.createSessionEmitter.fire(session);
|
|
123
|
+
return session;
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* The client, with its `onDocumentDirtyChanged` passing through
|
|
127
|
+
* {@link deliverDirty} first, so {@link dirtyStates} holds what the server
|
|
128
|
+
* told it, and every session hears it through {@link dirtyChangedEmitter};
|
|
129
|
+
* and with its `onDocumentUpdated` heard by every session through
|
|
130
|
+
* {@link documentUpdatedEmitter} first. Every other bound method forwards
|
|
131
|
+
* to the client unchanged, and one the client lacks stays absent, so the
|
|
132
|
+
* binding still refuses it.
|
|
133
|
+
*/
|
|
134
|
+
localTarget() {
|
|
135
|
+
const client = this.client;
|
|
136
|
+
const hearsDirty = typeof client.onDocumentDirtyChanged === 'function';
|
|
137
|
+
const hearsUpdates = typeof client.onDocumentUpdated === 'function';
|
|
138
|
+
if (!hearsDirty && !hearsUpdates) {
|
|
139
|
+
return this.client;
|
|
140
|
+
}
|
|
141
|
+
const target = {};
|
|
142
|
+
for (const name of this.clientMethods) {
|
|
143
|
+
const method = client[name];
|
|
144
|
+
if (typeof method === 'function') {
|
|
145
|
+
target[name] = (params) => method.call(client, params);
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
if (hearsDirty) {
|
|
149
|
+
target.onDocumentDirtyChanged = (event) => {
|
|
150
|
+
this.dirtyChangedEmitter.fire(event);
|
|
151
|
+
this.deliverDirty(event);
|
|
152
|
+
};
|
|
153
|
+
}
|
|
154
|
+
if (hearsUpdates) {
|
|
155
|
+
const forward = target.onDocumentUpdated;
|
|
156
|
+
target.onDocumentUpdated = (event) => {
|
|
157
|
+
this.documentUpdatedEmitter.fire(event);
|
|
158
|
+
forward(event);
|
|
159
|
+
};
|
|
160
|
+
}
|
|
161
|
+
return target;
|
|
162
|
+
}
|
|
163
|
+
/** Record `event` in {@link dirtyStates} and hand it to the client. */
|
|
164
|
+
deliverDirty(event) {
|
|
165
|
+
this.dirtyStates.set(event.uri, event.text?.dirty ?? false);
|
|
166
|
+
const client = this.client;
|
|
167
|
+
client.onDocumentDirtyChanged?.(event);
|
|
168
|
+
}
|
|
169
|
+
/**
|
|
170
|
+
* After the transport dropped, reconnect on the next macrotask for the
|
|
171
|
+
* sessions with documents open, so they re-watch and follow their documents
|
|
172
|
+
* again without waiting for a call of their own; a session with nothing
|
|
173
|
+
* open restores on its next call. Nothing is scheduled once this connection
|
|
174
|
+
* is disposed, which drops its generation too.
|
|
175
|
+
*/
|
|
176
|
+
dropGeneration() {
|
|
177
|
+
const dropped = this.generation !== undefined;
|
|
178
|
+
super.dropGeneration();
|
|
179
|
+
if (dropped && !this.disposed) {
|
|
180
|
+
setTimeout(() => {
|
|
181
|
+
if (!this.disposed) {
|
|
182
|
+
this.sessions.forEach(session => session.reconnect());
|
|
183
|
+
}
|
|
184
|
+
}, 0);
|
|
185
|
+
}
|
|
186
|
+
}
|
|
187
|
+
/**
|
|
188
|
+
* Sessions are detached rather than disposed: the server ends every session
|
|
189
|
+
* on a connection it sees close, so ending each one first sends requests
|
|
190
|
+
* over a connection this call is about to dispose.
|
|
191
|
+
*/
|
|
192
|
+
dispose() {
|
|
193
|
+
for (const session of [...this.sessions]) {
|
|
194
|
+
session.detach();
|
|
195
|
+
}
|
|
196
|
+
// For a factory's session whose `detach` does not fire.
|
|
197
|
+
this.sessions.clear();
|
|
198
|
+
this.createSessionEmitter.dispose();
|
|
199
|
+
this.dirtyChangedEmitter.dispose();
|
|
200
|
+
this.documentUpdatedEmitter.dispose();
|
|
201
|
+
super.dispose();
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
exports.DataConnection = DataConnection;
|
|
205
|
+
/**
|
|
206
|
+
* A {@link DataConnection} that brings its own {@link DataEvents}, so a host
|
|
207
|
+
* with several interested parties does not have to supply one.
|
|
208
|
+
*
|
|
209
|
+
* **The client slot holds exactly one object, and that is why this exists.**
|
|
210
|
+
* `createRpcProxy` binds a single `localTarget`, and underneath a method name
|
|
211
|
+
* maps to one handler — a second registration replaces the first silently. So a
|
|
212
|
+
* properties panel and a tree cannot both be the client; one fan-out sits in the
|
|
213
|
+
* slot and both subscribe to it.
|
|
214
|
+
*
|
|
215
|
+
* Use {@link DataConnection} directly instead when the client is yours: an
|
|
216
|
+
* adopter service that implements the protocol plus its own methods, a single
|
|
217
|
+
* consumer that IS the client, or a request/response-only client that binds
|
|
218
|
+
* nothing.
|
|
219
|
+
*/
|
|
220
|
+
class DataConnectionWithEvents extends DataConnection {
|
|
221
|
+
/** Server pushes, fanned out to as many local listeners as the host has. */
|
|
222
|
+
events;
|
|
223
|
+
constructor(port, options) {
|
|
224
|
+
// Built as a local because `this` is unavailable before `super`, then
|
|
225
|
+
// read back onto the field.
|
|
226
|
+
const events = new data_events_1.DataEvents();
|
|
227
|
+
super(port, events, options);
|
|
228
|
+
this.events = events;
|
|
229
|
+
}
|
|
230
|
+
/** Disposes the fan-out it created, which no caller else holds. */
|
|
231
|
+
dispose() {
|
|
232
|
+
super.dispose();
|
|
233
|
+
this.events.dispose();
|
|
234
|
+
}
|
|
235
|
+
}
|
|
236
|
+
exports.DataConnectionWithEvents = DataConnectionWithEvents;
|
|
237
|
+
//# sourceMappingURL=data-connection.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"data-connection.js","sourceRoot":"","sources":["../../src/client/data-connection.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AAElF,mDAAqD;AACrD,8CAAqD;AACrD,kCASiB;AACjB,sCAA0E;AAC1E,gDAA4C;AAE5C,+CAA2C;AAE3C,iDAAsE;AACtE,qDAA8E;AAkD9E;;;;;;;;;;;;GAYG;AACH,oBAIE,SAAQ,8BAA+B;IACnB,QAAQ,GAAG,IAAI,GAAG,EAAmC,CAAC;IACtD,cAAc,CAAyC;IACvD,oBAAoB,GAAG,IAAI,wBAAO,EAAmC,CAAC;IACzF;;;;OAIG;IACM,kBAAkB,GAA2C,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC;IACtG;;;;;OAKG;IACgB,WAAW,GAAG,IAAI,GAAG,EAAmB,CAAC;IAC5D,qEAAqE;IAClD,mBAAmB,GAAG,IAAI,wBAAO,EAAqC,CAAC;IAC1F,wEAAwE;IACrD,sBAAsB,GAAG,IAAI,wBAAO,EAAkE,CAAC;IAE1H,YAAY,IAAc,EAAE,MAAe,EAAE,GAAG,IAAqD;QAClG,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC,GAAG,IAEtB,CAAC;QACF,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE;YACjB,eAAe,EAAE,OAAO,CAAC,eAAe,IAAI,8BAAuB;YACnE,0DAA0D;YAC1D,sEAAsE;YACtE,mEAAmE;YACnE,aAAa,EAAE,OAAO,CAAC,aAAa,IAAK,mCAA+E;YACxH,SAAS,EAAE,OAAO;SACpB,CAAC,CAAC;QACH,IAAI,CAAC,cAAc;YAChB,OAAO,CAAC,cAAc,IAAI,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,0BAAW,CAAqB,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IACxH,CAAC;IAED;;;;OAIG;IACH,IAAI,YAAY;QACb,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,KAAK,GAAG,SAAS,EAAE,QAAiB;QAC/C,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,MAAM,EAAE,GAAG,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAA,wBAAU,GAAE,EAAE,CAAC;QAClD,IAAI,iCAAoB,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,8BAAqB,CAAC,EAAE,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,EAAE,CAAC,EAAE,CAAC;YAC/D,MAAM,IAAI,+BAAsB,CAAC,EAAE,CAAC,CAAC;QACxC,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAChC,EAAE,EACF;YACG,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE;YACjC,WAAW,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC;YACnE,YAAY,EAAE,KAAK,CAAC,EAAE;gBACnB,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,IAAI,KAAK,CAAC,EAAE,CAAC;oBACpE,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;gBAC5B,CAAC;YACJ,CAAC;YACD,WAAW,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC;YAChD,gBAAgB,EAAE,IAAI,CAAC,mBAAmB,CAAC,KAAK;YAChD,mBAAmB,EAAE,IAAI,CAAC,sBAAsB,CAAC,KAAK;SACxD,EACD,KAAK,CACP,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC3B,uEAAuE;QACvE,6DAA6D;QAC7D,OAAO,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1D,qEAAqE;QACrE,uEAAuE;QACvE,OAAO,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxC,OAAO,OAAO,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACgB,WAAW;QAC3B,MAAM,MAAM,GAAG,IAAI,CAAC,MAA4C,CAAC;QACjE,MAAM,UAAU,GAAG,OAAO,MAAM,CAAC,sBAAsB,KAAK,UAAU,CAAC;QACvE,MAAM,YAAY,GAAG,OAAO,MAAM,CAAC,iBAAiB,KAAK,UAAU,CAAC;QACpE,IAAI,CAAC,UAAU,IAAI,CAAC,YAAY,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC,MAAM,CAAC;QACtB,CAAC;QACD,MAAM,MAAM,GAA4B,EAAE,CAAC;QAC3C,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACrC,MAAM,MAAM,GAAY,MAAM,CAAC,IAAI,CAAC,CAAC;YACrC,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;gBAChC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAe,EAAW,EAAE,CAAE,MAAuC,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAC9G,CAAC;QACJ,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACd,MAAM,CAAC,sBAAsB,GAAG,CAAC,KAAwC,EAAQ,EAAE;gBAChF,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACrC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAC5B,CAAC,CAAC;QACL,CAAC;QACD,IAAI,YAAY,EAAE,CAAC;YAChB,MAAM,OAAO,GAAG,MAAM,CAAC,iBAAoG,CAAC;YAC5H,MAAM,CAAC,iBAAiB,GAAG,CAAC,KAAqE,EAAQ,EAAE;gBACxG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACxC,OAAO,CAAC,KAAK,CAAC,CAAC;YAClB,CAAC,CAAC;QACL,CAAC;QACD,OAAO,MAA4B,CAAC;IACvC,CAAC;IAED,uEAAuE;IAC7D,YAAY,CAAC,KAAwC;QAC5D,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,IAAI,KAAK,CAAC,CAAC;QAC5D,MAAM,MAAM,GAAG,IAAI,CAAC,MAA2F,CAAC;QAChH,MAAM,CAAC,sBAAsB,EAAE,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;OAMG;IACgB,cAAc;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC;QAC9C,KAAK,CAAC,cAAc,EAAE,CAAC;QACvB,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC7B,UAAU,CAAC,GAAG,EAAE;gBACb,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAClB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;gBACzD,CAAC;YACJ,CAAC,EAAE,CAAC,CAAC,CAAC;QACT,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACM,OAAO;QACb,KAAK,MAAM,OAAO,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,CAAC;QACD,wDAAwD;QACxD,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtB,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC;QACpC,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC;QACnC,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,CAAC;QACtC,KAAK,CAAC,OAAO,EAAE,CAAC;IACnB,CAAC;CACH;;AAED;;;;;;;;;;;;;;GAcG;AACH,8BAGE,SAAQ,cAAoG;IAC3G,4EAA4E;IACnE,MAAM,CAAmE;IAElF,YAAY,IAAc,EAAE,OAAmD;QAC5E,sEAAsE;QACtE,4BAA4B;QAC5B,MAAM,MAAM,GAAG,IAAI,wBAAU,EAAwD,CAAC;QACtF,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,mEAAmE;IAC1D,OAAO;QACb,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IACzB,CAAC;CACH"}
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
* SPDX-License-Identifier: MIT
|
|
8
8
|
********************************************************************************/
|
|
9
9
|
import { Emitter, type Event } from 'vscode-jsonrpc';
|
|
10
|
-
import type { DataClientProtocol, ProjectsChangedEvent, TransferDocumentSavedEvent, TransferDocumentUpdatedEvent } from '../data';
|
|
10
|
+
import type { DataClientProtocol, ProjectsChangedEvent, TransferDocumentDeletedEvent, TransferDocumentDirtyChangedEvent, TransferDocumentSavedEvent, TransferDocumentsBuiltEvent, TransferDocumentUpdatedEvent } from '../data';
|
|
11
11
|
import type { Project } from '../project';
|
|
12
12
|
import type { TransferDiagnostic } from '../transfer-diagnostic';
|
|
13
13
|
import type { TransferElement } from '../transfer-element';
|
|
@@ -34,15 +34,27 @@ import type { TransferElement } from '../transfer-element';
|
|
|
34
34
|
export declare class DataEvents<TTransfer extends TransferElement, TDiagnostic extends TransferDiagnostic = TransferDiagnostic, TProject extends Project = Project> implements DataClientProtocol<TTransfer, TDiagnostic, TProject> {
|
|
35
35
|
protected readonly documentUpdatedEmitter: Emitter<TransferDocumentUpdatedEvent<TTransfer, TDiagnostic>>;
|
|
36
36
|
protected readonly documentSavedEmitter: Emitter<TransferDocumentSavedEvent<TTransfer, TDiagnostic>>;
|
|
37
|
+
protected readonly documentDirtyChangedEmitter: Emitter<TransferDocumentDirtyChangedEvent>;
|
|
38
|
+
protected readonly documentDeletedEmitter: Emitter<TransferDocumentDeletedEvent>;
|
|
39
|
+
protected readonly documentsBuiltEmitter: Emitter<TransferDocumentsBuiltEvent>;
|
|
37
40
|
protected readonly projectsChangedEmitter: Emitter<ProjectsChangedEvent<TProject>>;
|
|
38
41
|
/** A build-phase event for a watched document. Carries the originating `sourceClientId`. */
|
|
39
42
|
readonly onDidUpdateDocument: Event<TransferDocumentUpdatedEvent<TTransfer, TDiagnostic>>;
|
|
40
43
|
/** A watched document was persisted to disk. */
|
|
41
44
|
readonly onDidSaveDocument: Event<TransferDocumentSavedEvent<TTransfer, TDiagnostic>>;
|
|
45
|
+
/** A watched document's text started or stopped differing from its file. */
|
|
46
|
+
readonly onDidChangeDocumentDirty: Event<TransferDocumentDirtyChangedEvent>;
|
|
47
|
+
/** A document's backing file was removed, watched or not. Any watch survives. */
|
|
48
|
+
readonly onDidDeleteDocument: Event<TransferDocumentDeletedEvent>;
|
|
49
|
+
/** Documents built that nobody watches — re-read anything derived from them. */
|
|
50
|
+
readonly onDidBuildDocuments: Event<TransferDocumentsBuiltEvent>;
|
|
42
51
|
/** The project set changed. */
|
|
43
52
|
readonly onDidChangeProjects: Event<ProjectsChangedEvent<TProject>>;
|
|
44
53
|
onDocumentUpdated(event: TransferDocumentUpdatedEvent<TTransfer, TDiagnostic>): void;
|
|
45
54
|
onDocumentSaved(event: TransferDocumentSavedEvent<TTransfer, TDiagnostic>): void;
|
|
55
|
+
onDocumentDirtyChanged(event: TransferDocumentDirtyChangedEvent): void;
|
|
56
|
+
onDocumentDeleted(event: TransferDocumentDeletedEvent): void;
|
|
57
|
+
onDocumentsBuilt(event: TransferDocumentsBuiltEvent): void;
|
|
46
58
|
onProjectsChanged(event: ProjectsChangedEvent<TProject>): void;
|
|
47
59
|
dispose(): void;
|
|
48
60
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-events.d.ts","sourceRoot":"","sources":["../../src/client/data-events.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"data-events.d.ts","sourceRoot":"","sources":["../../src/client/data-events.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,KAAK,EACT,kBAAkB,EAClB,oBAAoB,EACpB,4BAA4B,EAC5B,iCAAiC,EACjC,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC9B,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE3D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,UAAU,CACpB,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB,EAC3D,QAAQ,SAAS,OAAO,GAAG,OAAO,CACnC,YAAW,kBAAkB,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC;IAC9D,SAAS,CAAC,QAAQ,CAAC,sBAAsB,gEAAuE;IAChH,SAAS,CAAC,QAAQ,CAAC,oBAAoB,8DAAqE;IAC5G,SAAS,CAAC,QAAQ,CAAC,2BAA2B,6CAAoD;IAClG,SAAS,CAAC,QAAQ,CAAC,sBAAsB,wCAA+C;IACxF,SAAS,CAAC,QAAQ,CAAC,qBAAqB,uCAA8C;IACtF,SAAS,CAAC,QAAQ,CAAC,sBAAsB,0CAAiD;IAE1F,4FAA4F;IAC5F,QAAQ,CAAC,mBAAmB,EAAE,KAAK,CAAC,4BAA4B,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAqC;IAC9H,gDAAgD;IAChD,QAAQ,CAAC,iBAAiB,EAAE,KAAK,CAAC,0BAA0B,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAmC;IACxH,4EAA4E;IAC5E,QAAQ,CAAC,wBAAwB,EAAE,KAAK,CAAC,iCAAiC,CAAC,CAA0C;IACrH,iFAAiF;IACjF,QAAQ,CAAC,mBAAmB,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAqC;IACtG,gFAAgF;IAChF,QAAQ,CAAC,mBAAmB,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAoC;IACpG,+BAA+B;IAC/B,QAAQ,CAAC,mBAAmB,EAAE,KAAK,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAqC;IAIxG,iBAAiB,CAAC,KAAK,EAAE,4BAA4B,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG,IAAI,CAEnF;IAED,eAAe,CAAC,KAAK,EAAE,0BAA0B,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG,IAAI,CAE/E;IAED,sBAAsB,CAAC,KAAK,EAAE,iCAAiC,GAAG,IAAI,CAErE;IAED,iBAAiB,CAAC,KAAK,EAAE,4BAA4B,GAAG,IAAI,CAE3D;IAED,gBAAgB,CAAC,KAAK,EAAE,2BAA2B,GAAG,IAAI,CAEzD;IAED,iBAAiB,CAAC,KAAK,EAAE,oBAAoB,CAAC,QAAQ,CAAC,GAAG,IAAI,CAE7D;IAED,OAAO,IAAI,IAAI,CAOd;CACH"}
|
|
@@ -33,11 +33,20 @@ const vscode_jsonrpc_1 = require("vscode-jsonrpc");
|
|
|
33
33
|
class DataEvents {
|
|
34
34
|
documentUpdatedEmitter = new vscode_jsonrpc_1.Emitter();
|
|
35
35
|
documentSavedEmitter = new vscode_jsonrpc_1.Emitter();
|
|
36
|
+
documentDirtyChangedEmitter = new vscode_jsonrpc_1.Emitter();
|
|
37
|
+
documentDeletedEmitter = new vscode_jsonrpc_1.Emitter();
|
|
38
|
+
documentsBuiltEmitter = new vscode_jsonrpc_1.Emitter();
|
|
36
39
|
projectsChangedEmitter = new vscode_jsonrpc_1.Emitter();
|
|
37
40
|
/** A build-phase event for a watched document. Carries the originating `sourceClientId`. */
|
|
38
41
|
onDidUpdateDocument = this.documentUpdatedEmitter.event;
|
|
39
42
|
/** A watched document was persisted to disk. */
|
|
40
43
|
onDidSaveDocument = this.documentSavedEmitter.event;
|
|
44
|
+
/** A watched document's text started or stopped differing from its file. */
|
|
45
|
+
onDidChangeDocumentDirty = this.documentDirtyChangedEmitter.event;
|
|
46
|
+
/** A document's backing file was removed, watched or not. Any watch survives. */
|
|
47
|
+
onDidDeleteDocument = this.documentDeletedEmitter.event;
|
|
48
|
+
/** Documents built that nobody watches — re-read anything derived from them. */
|
|
49
|
+
onDidBuildDocuments = this.documentsBuiltEmitter.event;
|
|
41
50
|
/** The project set changed. */
|
|
42
51
|
onDidChangeProjects = this.projectsChangedEmitter.event;
|
|
43
52
|
// --- DataClientProtocol (wire names) ---
|
|
@@ -47,12 +56,24 @@ class DataEvents {
|
|
|
47
56
|
onDocumentSaved(event) {
|
|
48
57
|
this.documentSavedEmitter.fire(event);
|
|
49
58
|
}
|
|
59
|
+
onDocumentDirtyChanged(event) {
|
|
60
|
+
this.documentDirtyChangedEmitter.fire(event);
|
|
61
|
+
}
|
|
62
|
+
onDocumentDeleted(event) {
|
|
63
|
+
this.documentDeletedEmitter.fire(event);
|
|
64
|
+
}
|
|
65
|
+
onDocumentsBuilt(event) {
|
|
66
|
+
this.documentsBuiltEmitter.fire(event);
|
|
67
|
+
}
|
|
50
68
|
onProjectsChanged(event) {
|
|
51
69
|
this.projectsChangedEmitter.fire(event);
|
|
52
70
|
}
|
|
53
71
|
dispose() {
|
|
54
72
|
this.documentUpdatedEmitter.dispose();
|
|
55
73
|
this.documentSavedEmitter.dispose();
|
|
74
|
+
this.documentDirtyChangedEmitter.dispose();
|
|
75
|
+
this.documentDeletedEmitter.dispose();
|
|
76
|
+
this.documentsBuiltEmitter.dispose();
|
|
56
77
|
this.projectsChangedEmitter.dispose();
|
|
57
78
|
}
|
|
58
79
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-events.js","sourceRoot":"","sources":["../../src/client/data-events.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AAElF,mDAAqD;
|
|
1
|
+
{"version":3,"file":"data-events.js","sourceRoot":"","sources":["../../src/client/data-events.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AAElF,mDAAqD;AAcrD;;;;;;;;;;;;;;;;;;;GAmBG;AACH;IAKsB,sBAAsB,GAAG,IAAI,wBAAO,EAAwD,CAAC;IAC7F,oBAAoB,GAAG,IAAI,wBAAO,EAAsD,CAAC;IACzF,2BAA2B,GAAG,IAAI,wBAAO,EAAqC,CAAC;IAC/E,sBAAsB,GAAG,IAAI,wBAAO,EAAgC,CAAC;IACrE,qBAAqB,GAAG,IAAI,wBAAO,EAA+B,CAAC;IACnE,sBAAsB,GAAG,IAAI,wBAAO,EAAkC,CAAC;IAE1F,4FAA4F;IACnF,mBAAmB,GAAgE,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC;IAC9H,gDAAgD;IACvC,iBAAiB,GAA8D,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC;IACxH,4EAA4E;IACnE,wBAAwB,GAA6C,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC;IACrH,iFAAiF;IACxE,mBAAmB,GAAwC,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC;IACtG,gFAAgF;IACvE,mBAAmB,GAAuC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC;IACpG,+BAA+B;IACtB,mBAAmB,GAA0C,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC;IAExG,0CAA0C;IAE1C,iBAAiB,CAAC,KAA2D;QAC1E,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,eAAe,CAAC,KAAyD;QACtE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,sBAAsB,CAAC,KAAwC;QAC5D,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAED,iBAAiB,CAAC,KAAmC;QAClD,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,gBAAgB,CAAC,KAAkC;QAChD,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;IAED,iBAAiB,CAAC,KAAqC;QACpD,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO;QACJ,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,CAAC;QACtC,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC;QACpC,IAAI,CAAC,2BAA2B,CAAC,OAAO,EAAE,CAAC;QAC3C,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,CAAC;QACtC,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,CAAC;QACrC,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,CAAC;IACzC,CAAC;CACH"}
|