@hydranium/protocol 1.0.0-next.135 → 1.0.0-next.140
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/lib/client-ids.d.ts +5 -1
- package/lib/client-ids.d.ts.map +1 -1
- package/lib/client-ids.js +5 -1
- package/lib/client-ids.js.map +1 -1
- package/lib/data/events.d.ts +19 -11
- package/lib/data/events.d.ts.map +1 -1
- package/lib/model-server.d.ts +16 -0
- package/lib/model-server.d.ts.map +1 -1
- package/lib/model-server.js.map +1 -1
- package/package.json +1 -1
- package/src/client-ids.ts +5 -1
- package/src/data/events.ts +19 -11
- package/src/model-server.ts +16 -0
package/lib/client-ids.d.ts
CHANGED
|
@@ -23,7 +23,11 @@
|
|
|
23
23
|
*/
|
|
24
24
|
/** Identifier for an LSP-text client (Monaco, VS Code, …). */
|
|
25
25
|
export declare const LANGUAGE_CLIENT_ID = "language-client";
|
|
26
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* The id an event names when no single client is behind it: the source of a
|
|
28
|
+
* `'rebuilt'` event, a document no client authored, or a build with more than
|
|
29
|
+
* one cause.
|
|
30
|
+
*/
|
|
27
31
|
export declare const UNKNOWN_CLIENT_ID = "unknown";
|
|
28
32
|
/**
|
|
29
33
|
* Synthetic author id on the `onDocumentUpdated` broadcast a data-server
|
package/lib/client-ids.d.ts.map
CHANGED
|
@@ -1 +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
|
|
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;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,YAAY,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,oBAAoB,CAAC;AAE3D;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,SAAS,MAAM,EAAuE,CAAC"}
|
package/lib/client-ids.js
CHANGED
|
@@ -26,7 +26,11 @@ exports.FRAMEWORK_CLIENT_IDS = exports.REVERT_ON_CLOSE_CLIENT_ID = exports.UNKNO
|
|
|
26
26
|
*/
|
|
27
27
|
/** Identifier for an LSP-text client (Monaco, VS Code, …). */
|
|
28
28
|
exports.LANGUAGE_CLIENT_ID = 'language-client';
|
|
29
|
-
/**
|
|
29
|
+
/**
|
|
30
|
+
* The id an event names when no single client is behind it: the source of a
|
|
31
|
+
* `'rebuilt'` event, a document no client authored, or a build with more than
|
|
32
|
+
* one cause.
|
|
33
|
+
*/
|
|
30
34
|
exports.UNKNOWN_CLIENT_ID = 'unknown';
|
|
31
35
|
/**
|
|
32
36
|
* Synthetic author id on the `onDocumentUpdated` broadcast a data-server
|
package/lib/client-ids.js.map
CHANGED
|
@@ -1 +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
|
|
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;;;;GAIG;AACU,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"}
|
package/lib/data/events.d.ts
CHANGED
|
@@ -14,21 +14,23 @@ import type { TransferDocument } from '../transfer-document';
|
|
|
14
14
|
* Why an update event fired. Subscribers filter on reason for behaviour
|
|
15
15
|
* decisions (e.g. dirty-flag handling, undo-history grouping, telemetry):
|
|
16
16
|
*
|
|
17
|
-
* - `'changed'` — the
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
* - `'rebuilt'` — the URI was rebuilt as a cascade from another URI's
|
|
25
|
-
* build (dependency graph re-derivation), without itself being passed to
|
|
26
|
-
* `documentBuilder.update`. The complement of `'changed'`.
|
|
17
|
+
* - `'changed'` — the server's first update event for the document's current
|
|
18
|
+
* version: its content changed since the last one. A write whose build a
|
|
19
|
+
* later write cancelled is still `'changed'` in the build that takes over.
|
|
20
|
+
* - `'rebuilt'` — a later event for a version the server already delivered,
|
|
21
|
+
* whether or not any client watched it then: something the document depends
|
|
22
|
+
* on changed, or the document was built again with the same content. The
|
|
23
|
+
* complement of `'changed'`.
|
|
27
24
|
* - `'saved'` — emitted by adopters that synthesise a unified update stream
|
|
28
25
|
* from both `onDocumentUpdated` and `onDocumentSaved`. The framework's own
|
|
29
26
|
* `dispatchPhaseEvent` does NOT emit `'saved'` — saves take the dedicated
|
|
30
27
|
* `DataClientProtocol.onDocumentSaved` channel.
|
|
31
28
|
*
|
|
29
|
+
* The version rule needs a version the server keeps and builds that validate.
|
|
30
|
+
* For a document no client has opened, or when rebuilds do not validate,
|
|
31
|
+
* `'changed'` means the URI was passed to `DocumentBuilder.update` for this
|
|
32
|
+
* build. A document that a validating build skips is `'changed'` every time.
|
|
33
|
+
*
|
|
32
34
|
* Deletion is deliberately NOT a member. An update event carries a built
|
|
33
35
|
* document, which a deleted one has none of, and the phase-driven path that
|
|
34
36
|
* produces these events never runs for a deleted URI — the builder drops the
|
|
@@ -45,7 +47,13 @@ export type TransferDocumentUpdateReason = 'changed' | 'rebuilt' | 'saved';
|
|
|
45
47
|
*/
|
|
46
48
|
export interface TransferDocumentUpdatedEvent<TTransfer extends TransferElement, TDiagnostic extends TransferDiagnostic = TransferDiagnostic> {
|
|
47
49
|
document: TransferDocument<TTransfer, TDiagnostic>;
|
|
48
|
-
/**
|
|
50
|
+
/**
|
|
51
|
+
* The client whose write this event echoes: the author of the version on a
|
|
52
|
+
* `'changed'`, and the unknown-client id on a `'rebuilt'`, which echoes no
|
|
53
|
+
* write. A recipient compares it against its own id to recognise its echo.
|
|
54
|
+
* The rebuild that reverts a document to disk after its last close names
|
|
55
|
+
* the revert-on-close id instead.
|
|
56
|
+
*/
|
|
49
57
|
sourceClientId: string;
|
|
50
58
|
reason: TransferDocumentUpdateReason;
|
|
51
59
|
}
|
package/lib/data/events.d.ts.map
CHANGED
|
@@ -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
|
|
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;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;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;;;;;;OAMG;IACH,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;;;;;;GAMG;AACH,MAAM,WAAW,iCAAiC;IAC/C,mDAAmD;IACnD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CAC1B;AAED,sEAAsE;AACtE,MAAM,MAAM,oCAAoC,GAAG,CAAC,KAAK,EAAE,iCAAiC,KAAK,IAAI,CAAC;AAEtG;;;;;;;;;;;;;;;;;;;;;;;;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/model-server.d.ts
CHANGED
|
@@ -59,9 +59,25 @@ export interface CloseModelArgs extends TransferClientArgs {
|
|
|
59
59
|
}
|
|
60
60
|
export interface TransferUpdatedEvent<TDocument> {
|
|
61
61
|
document: TDocument;
|
|
62
|
+
/**
|
|
63
|
+
* The client whose write this event echoes: the author of the version on a
|
|
64
|
+
* `'changed'`, and the unknown-client id on a `'rebuilt'`, which echoes no
|
|
65
|
+
* write. A recipient compares it against its own id to recognise its echo.
|
|
66
|
+
*/
|
|
62
67
|
sourceClientId: string;
|
|
63
68
|
/** See `TransferDocumentUpdateReason` in `./data/events` for the canonical reason set + semantics. */
|
|
64
69
|
reason: 'changed' | 'rebuilt' | 'saved';
|
|
70
|
+
/**
|
|
71
|
+
* The client whose write caused the build that produced this event, or the
|
|
72
|
+
* unknown-client id when no single client's did. On a `'changed'` it is the
|
|
73
|
+
* version's author. A `'rebuilt'` names the writer of another document, so
|
|
74
|
+
* it is a cause, never an echo: its diagnostics and references are new to
|
|
75
|
+
* that writer too.
|
|
76
|
+
*
|
|
77
|
+
* In-process only: the data head does not send it, and an event built
|
|
78
|
+
* elsewhere may leave it out, which a reader takes as "not known".
|
|
79
|
+
*/
|
|
80
|
+
causedBy?: string;
|
|
65
81
|
}
|
|
66
82
|
export interface TransferSavedEvent<TDocument> {
|
|
67
83
|
/** The document as persisted — the state that reached disk, not the state at request time. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"model-server.d.ts","sourceRoot":"","sources":["../src/model-server.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAM9E,4CAA4C;AAC5C,MAAM,WAAW,kBAAkB;IAChC,oBAAoB;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,+DAA+D;IAC/D,QAAQ,EAAE,MAAM,CAAC;CACnB;AAED,6CAA6C;AAC7C,MAAM,WAAW,aAAc,SAAQ,kBAAkB;IACtD;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yDAAyD;AAEzD,MAAM,WAAW,cAAe,SAAQ,kBAAkB;CAAG;AAM7D,MAAM,WAAW,oBAAoB,CAAC,SAAS;IAC5C,QAAQ,EAAE,SAAS,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,sGAAsG;IACtG,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"model-server.d.ts","sourceRoot":"","sources":["../src/model-server.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qCAAqC,CAAC;AAM9E,4CAA4C;AAC5C,MAAM,WAAW,kBAAkB;IAChC,oBAAoB;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,+DAA+D;IAC/D,QAAQ,EAAE,MAAM,CAAC;CACnB;AAED,6CAA6C;AAC7C,MAAM,WAAW,aAAc,SAAQ,kBAAkB;IACtD;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yDAAyD;AAEzD,MAAM,WAAW,cAAe,SAAQ,kBAAkB;CAAG;AAM7D,MAAM,WAAW,oBAAoB,CAAC,SAAS;IAC5C,QAAQ,EAAE,SAAS,CAAC;IACpB;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,sGAAsG;IACtG,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;IACxC;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB,CAAC,SAAS;IAC1C,8FAA8F;IAC9F,QAAQ,EAAE,SAAS,CAAC;IACpB;;;;;OAKG;IACH,cAAc,EAAE,MAAM,CAAC;CACzB;AAMD;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,eAAe,GAAG,cAAc,GAAG,aAAa,GAAG,eAAe,CAAC;AAE/E,iFAAiF;AACjF,MAAM,WAAW,cAAc;IAC5B,GAAG,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,cAAc,CAE1E;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa;IAC3B;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,aAAa,CAExE;AAED,qGAAqG;AACrG,MAAM,WAAW,eAAe;IAC7B;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,eAAe,CAS5E;AAED;;;GAGG;AACH,yBAAiB,eAAe,CAAC;IAC9B,SAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAEpD;IACD,SAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,aAAa,CAElE;IACD,SAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,eAAe,CAIvF;CACH;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,aAAa;IAC3B;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;OAMG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,aAAa,CASxE;AAED,yBAAiB,aAAa,CAAC;IAC5B;;;;OAIG;IACH,SAAgB,EAAE,CAAC,iBAAiB,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,aAAa,CAEzF;IAED;;;;;OAKG;IACH,SAAgB,KAAK,CAAC,GAAG,KAAK,EAAE,aAAa,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,aAAa,EAAE,CAErF;CACH;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,gBAAgB;IAC9B,sGAAsG;IACtG,MAAM,EAAE,eAAe,CAAC;IACxB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,aAAa,EAAE,CAAC;IAChC;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,gBAAgB,CAQ9E;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACvD,4EAA4E;IAC5E,KAAK,EAAE,MAAM,CAAC;CAChB;AAMD;;;;GAIG;AACH,MAAM,WAAW,oBAAoB,CAAC,cAAc;IACjD,mFAAmF;IACnF,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,CAAC,cAAc,CAAC,CAAC;IAC1D,mFAAmF;IACnF,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC,cAAc,CAAC,CAAC;IACzE,gFAAgF;IAChF,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,kBAAkB,CAAC,cAAc,CAAC,CAAC;CAC3E;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,cAAc;IAC/C;;;;;OAKG;IACH,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC,cAAc,CAAC,CAAC;IAClG,oDAAoD;IACpD,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc,CAAC;CAC7C;AAED,2EAA2E;AAC3E,MAAM,WAAW,0BAA0B;IACxC,KAAK,IAAI,gBAAgB,CAAC;CAC5B;AAED,oGAAoG;AACpG,MAAM,WAAW,0BAA0B;IACxC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,0BAA0B,CAAC;CACnD;AAED,4CAA4C;AAC5C,MAAM,WAAW,0BAA0B;IACxC,KAAK,IAAI,gBAAgB,CAAC;CAC5B;AA8BD,yBAAiB,gBAAgB,CAAC;IAC/B,oEAAoE;IACpE,SAAgB,OAAO,IAAI,oBAAoB,CAAC,0BAA0B,CAAC,CAE1E;CACH;AAED,yBAAiB,gBAAgB,CAAC;IAC/B,6EAA6E;IAC7E,SAAgB,OAAO,IAAI,oBAAoB,CAAC,0BAA0B,CAAC,CAI1E;IAED;;;;;;OAMG;IACH,SAAgB,IAAI,CAAC,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,kBAAkB,GAAG,gBAAgB,CAE/F;CACH;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEtD,6CAA6C;AAC7C,MAAM,WAAW,gBAAgB;IAC9B;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACpB"}
|
package/lib/model-server.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"model-server.js","sourceRoot":"","sources":["../src/model-server.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;
|
|
1
|
+
{"version":3,"file":"model-server.js","sourceRoot":"","sources":["../src/model-server.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AAmIlF,4CAEC;AA4BD,0CAEC;AA6BD,8CASC;AAoED,0CASC;AAyDD,gDAQC;AAzND;;;;GAIG;AACH,SAAgB,gBAAgB,CAAC,MAAe;IAC7C,OAAO,CAAC,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,GAAG,KAAK,QAAQ,CAAC;AACtG,CAAC;AA4BD,SAAgB,eAAe,CAAC,MAAe;IAC5C,OAAO,CAAC,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC;AACxG,CAAC;AA6BD,SAAgB,iBAAiB,CAAC,MAAe;IAC9C,OAAO,CACJ,CAAC,CAAC,MAAM;QACR,OAAO,MAAM,KAAK,QAAQ;QAC1B,KAAK,IAAI,MAAM;QACf,OAAO,MAAM,CAAC,GAAG,KAAK,QAAQ;QAC9B,MAAM,IAAI,MAAM;QAChB,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,CACjC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,IAAiB,eAAe,CAY/B;AAZD,WAAiB,eAAe;IAC7B,SAAgB,QAAQ,CAAC,GAAW;QACjC,OAAO,EAAE,GAAG,EAAE,CAAC;IAClB,CAAC;IAFe,wBAAQ,WAEvB,CAAA;IACD,SAAgB,OAAO,CAAC,IAAY,EAAE,IAAa;QAChD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IACzB,CAAC;IAFe,uBAAO,UAEtB,CAAA;IACD,SAAgB,SAAS,CAAC,GAAW,EAAE,IAAY,EAAE,QAAiB;QACnE,uEAAuE;QACvE,gEAAgE;QAChE,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC3E,CAAC;IAJe,yBAAS,YAIxB,CAAA;AACJ,CAAC,EAZgB,eAAe,+BAAf,eAAe,QAY/B;AA4CD;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,MAAe;IAC5C,OAAO,CACJ,CAAC,CAAC,MAAM;QACR,OAAO,MAAM,KAAK,QAAQ;QAC1B,MAAM,IAAI,MAAM;QAChB,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ;QAC/B,mBAAmB,IAAI,MAAM;QAC7B,OAAO,MAAM,CAAC,iBAAiB,KAAK,QAAQ,CAC9C,CAAC;AACL,CAAC;AAED,IAAiB,aAAa,CAmB7B;AAnBD,WAAiB,aAAa;IAC3B;;;;OAIG;IACH,SAAgB,EAAE,CAAC,iBAAyB,EAAE,IAAY,EAAE,KAAc;QACvE,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAC7C,CAAC;IAFe,gBAAE,KAEjB,CAAA;IAED;;;;;OAKG;IACH,SAAgB,KAAK,CAAC,GAAG,KAA2C;QACjE,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IACzC,CAAC;IAFe,mBAAK,QAEpB,CAAA;AACJ,CAAC,EAnBgB,aAAa,6BAAb,aAAa,QAmB7B;AA8BD;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,MAAe;IAC/C,OAAO,CACJ,CAAC,CAAC,MAAM;QACR,OAAO,MAAM,KAAK,QAAQ;QAC1B,QAAQ,IAAI,MAAM;QAClB,UAAU,IAAI,MAAM;QACpB,OAAQ,MAA2B,CAAC,QAAQ,KAAK,QAAQ,CAC3D,CAAC;AACL,CAAC;AAmED;;;;;;;;;;;GAWG;AACH,SAAS,gBAAgB,CAAiB,UAAyD;IAChG,MAAM,YAAY,GAAG,CAAC,MAAuB,EAAE,KAA+B,EAAsC,EAAE,CAAC,CAAC;QACrH,IAAI,CAAC,iBAAiB,EAAE,IAAI,EAAE,KAAK;YAChC,OAAO,YAAY,CAAC,MAAM,EAAE,CAAC,GAAG,KAAK,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAC/E,CAAC;QACD,QAAQ,CAAC,QAAQ;YACd,OAAO,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;QAChH,CAAC;KACH,CAAC,CAAC;IACH,OAAO;QACJ,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;QAC1C,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;QACzD,SAAS,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;KAC3D,CAAC;AACL,CAAC;AAED,IAAiB,gBAAgB,CAKhC;AALD,WAAiB,gBAAgB;IAC9B,oEAAoE;IACpE,SAAgB,OAAO;QACpB,OAAO,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IAClE,CAAC;IAFe,wBAAO,UAEtB,CAAA;AACJ,CAAC,EALgB,gBAAgB,gCAAhB,gBAAgB,QAKhC;AAED,IAAiB,gBAAgB,CAkBhC;AAlBD,WAAiB,gBAAgB;IAC9B,6EAA6E;IAC7E,SAAgB,OAAO;QACpB,OAAO,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACjC,KAAK,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;SACtE,CAAC,CAAC,CAAC;IACP,CAAC;IAJe,wBAAO,UAItB,CAAA;IAED;;;;;;OAMG;IACH,SAAgB,IAAI,CAAC,OAAyB,EAAE,SAA6B;QAC1E,OAAO,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,CAAC;IACjD,CAAC;IAFe,qBAAI,OAEnB,CAAA;AACJ,CAAC,EAlBgB,gBAAgB,gCAAhB,gBAAgB,QAkBhC"}
|
package/package.json
CHANGED
package/src/client-ids.ts
CHANGED
|
@@ -26,7 +26,11 @@
|
|
|
26
26
|
/** Identifier for an LSP-text client (Monaco, VS Code, …). */
|
|
27
27
|
export const LANGUAGE_CLIENT_ID = 'language-client';
|
|
28
28
|
|
|
29
|
-
/**
|
|
29
|
+
/**
|
|
30
|
+
* The id an event names when no single client is behind it: the source of a
|
|
31
|
+
* `'rebuilt'` event, a document no client authored, or a build with more than
|
|
32
|
+
* one cause.
|
|
33
|
+
*/
|
|
30
34
|
export const UNKNOWN_CLIENT_ID = 'unknown';
|
|
31
35
|
|
|
32
36
|
/**
|
package/src/data/events.ts
CHANGED
|
@@ -16,21 +16,23 @@ import type { TransferDocument } from '../transfer-document';
|
|
|
16
16
|
* Why an update event fired. Subscribers filter on reason for behaviour
|
|
17
17
|
* decisions (e.g. dirty-flag handling, undo-history grouping, telemetry):
|
|
18
18
|
*
|
|
19
|
-
* - `'changed'` — the
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
* - `'rebuilt'` — the URI was rebuilt as a cascade from another URI's
|
|
27
|
-
* build (dependency graph re-derivation), without itself being passed to
|
|
28
|
-
* `documentBuilder.update`. The complement of `'changed'`.
|
|
19
|
+
* - `'changed'` — the server's first update event for the document's current
|
|
20
|
+
* version: its content changed since the last one. A write whose build a
|
|
21
|
+
* later write cancelled is still `'changed'` in the build that takes over.
|
|
22
|
+
* - `'rebuilt'` — a later event for a version the server already delivered,
|
|
23
|
+
* whether or not any client watched it then: something the document depends
|
|
24
|
+
* on changed, or the document was built again with the same content. The
|
|
25
|
+
* complement of `'changed'`.
|
|
29
26
|
* - `'saved'` — emitted by adopters that synthesise a unified update stream
|
|
30
27
|
* from both `onDocumentUpdated` and `onDocumentSaved`. The framework's own
|
|
31
28
|
* `dispatchPhaseEvent` does NOT emit `'saved'` — saves take the dedicated
|
|
32
29
|
* `DataClientProtocol.onDocumentSaved` channel.
|
|
33
30
|
*
|
|
31
|
+
* The version rule needs a version the server keeps and builds that validate.
|
|
32
|
+
* For a document no client has opened, or when rebuilds do not validate,
|
|
33
|
+
* `'changed'` means the URI was passed to `DocumentBuilder.update` for this
|
|
34
|
+
* build. A document that a validating build skips is `'changed'` every time.
|
|
35
|
+
*
|
|
34
36
|
* Deletion is deliberately NOT a member. An update event carries a built
|
|
35
37
|
* document, which a deleted one has none of, and the phase-driven path that
|
|
36
38
|
* produces these events never runs for a deleted URI — the builder drops the
|
|
@@ -51,7 +53,13 @@ export interface TransferDocumentUpdatedEvent<
|
|
|
51
53
|
TDiagnostic extends TransferDiagnostic = TransferDiagnostic
|
|
52
54
|
> {
|
|
53
55
|
document: TransferDocument<TTransfer, TDiagnostic>;
|
|
54
|
-
/**
|
|
56
|
+
/**
|
|
57
|
+
* The client whose write this event echoes: the author of the version on a
|
|
58
|
+
* `'changed'`, and the unknown-client id on a `'rebuilt'`, which echoes no
|
|
59
|
+
* write. A recipient compares it against its own id to recognise its echo.
|
|
60
|
+
* The rebuild that reverts a document to disk after its last close names
|
|
61
|
+
* the revert-on-close id instead.
|
|
62
|
+
*/
|
|
55
63
|
sourceClientId: string;
|
|
56
64
|
reason: TransferDocumentUpdateReason;
|
|
57
65
|
}
|
package/src/model-server.ts
CHANGED
|
@@ -73,9 +73,25 @@ export interface CloseModelArgs extends TransferClientArgs {}
|
|
|
73
73
|
|
|
74
74
|
export interface TransferUpdatedEvent<TDocument> {
|
|
75
75
|
document: TDocument;
|
|
76
|
+
/**
|
|
77
|
+
* The client whose write this event echoes: the author of the version on a
|
|
78
|
+
* `'changed'`, and the unknown-client id on a `'rebuilt'`, which echoes no
|
|
79
|
+
* write. A recipient compares it against its own id to recognise its echo.
|
|
80
|
+
*/
|
|
76
81
|
sourceClientId: string;
|
|
77
82
|
/** See `TransferDocumentUpdateReason` in `./data/events` for the canonical reason set + semantics. */
|
|
78
83
|
reason: 'changed' | 'rebuilt' | 'saved';
|
|
84
|
+
/**
|
|
85
|
+
* The client whose write caused the build that produced this event, or the
|
|
86
|
+
* unknown-client id when no single client's did. On a `'changed'` it is the
|
|
87
|
+
* version's author. A `'rebuilt'` names the writer of another document, so
|
|
88
|
+
* it is a cause, never an echo: its diagnostics and references are new to
|
|
89
|
+
* that writer too.
|
|
90
|
+
*
|
|
91
|
+
* In-process only: the data head does not send it, and an event built
|
|
92
|
+
* elsewhere may leave it out, which a reader takes as "not known".
|
|
93
|
+
*/
|
|
94
|
+
causedBy?: string;
|
|
79
95
|
}
|
|
80
96
|
|
|
81
97
|
export interface TransferSavedEvent<TDocument> {
|